xref: /aosp_15_r20/external/coreboot/src/vendorcode/cavium/bdk/libdram/dram-util.h (revision b9411a12aaaa7e1e6a6fb7c5e057f44ee179a49c)
1 /***********************license start***********************************
2 * Copyright (c) 2003-2017  Cavium Inc. ([email protected]). All rights
3 * reserved.
4 *
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 *   * Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 *
13 *   * Redistributions in binary form must reproduce the above
14 *     copyright notice, this list of conditions and the following
15 *     disclaimer in the documentation and/or other materials provided
16 *     with the distribution.
17 *
18 *   * Neither the name of Cavium Inc. nor the names of
19 *     its contributors may be used to endorse or promote products
20 *     derived from this software without specific prior written
21 *     permission.
22 *
23 * This Software, including technical data, may be subject to U.S. export
24 * control laws, including the U.S. Export Administration Act and its
25 * associated regulations, and may be subject to export or import
26 * regulations in other countries.
27 *
28 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
29 * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
30 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT
31 * TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
32 * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
33 * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
34 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
35 * PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT,
36 * QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK
37 * ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
38 ***********************license end**************************************/
39 
40 /**
41  * Small utility functions for use by libdram internally. These
42  * are not meant for users's of the libdram API.
43  */
44 
45 /**
46  * Standard min(a,b) macro
47  */
48 #define min(X, Y)				\
49 	({ typeof (X) __x = (X);		\
50 		typeof (Y) __y = (Y);		\
51 		(__x < __y) ? __x : __y; })
52 
53 /**
54  * Standard max(a,b) macro
55  */
56 #define max(X, Y)				\
57 	({ typeof (X) __x = (X); typeof(Y) __y = (Y);	\
58 		(__x > __y) ? __x : __y; })
59 
60 /**
61  * Absolute value of an integer
62  *
63  * @param v
64  *
65  * @return
66  */
_abs(int64_t v)67 static inline int64_t _abs(int64_t v)
68 {
69     return (v < 0) ? -v : v;
70 }
71 
72 /**
73  * Sign of an integer
74  *
75  * @param v
76  *
77  * @return
78  */
_sign(int64_t v)79 static inline int64_t _sign(int64_t v)
80 {
81     return v < 0;
82 }
83 
84 /**
85  * Divide and round results up to the next higher integer.
86  *
87  * @param dividend
88  * @param divisor
89  *
90  * @return
91  */
divide_roundup(uint64_t dividend,uint64_t divisor)92 static inline uint64_t divide_roundup(uint64_t dividend, uint64_t divisor)
93 {
94     return (dividend + divisor - 1) / divisor;
95 }
96 
97