xref: /dflybsd-src/sys/dev/drm/include/linux/kernel.h (revision 86a1b83239e48aedeb849a967315a630e6fc57fb)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2014-2016 François Tigeot
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef	_LINUX_KERNEL_H_
30 #define	_LINUX_KERNEL_H_
31 
32 #include <sys/systm.h>
33 #include <sys/param.h>
34 #include <sys/libkern.h>
35 #include <sys/stat.h>
36 
37 #include <linux/bitops.h>
38 #include <linux/compiler.h>
39 #include <linux/log2.h>
40 #include <linux/types.h>
41 #include <linux/printk.h>
42 
43 #define U64_MAX		((u64)~0ULL)
44 
45 #define KERN_CONT       ""
46 #define	KERN_EMERG	"<0>"
47 #define	KERN_ALERT	"<1>"
48 #define	KERN_CRIT	"<2>"
49 #define	KERN_ERR	"<3>"
50 #define	KERN_WARNING	"<4>"
51 #define	KERN_NOTICE	"<5>"
52 #define	KERN_INFO	"<6>"
53 #define	KERN_DEBUG	"<7>"
54 
55 #define BUG()	do				\
56 {						\
57 	panic("BUG in %s at %s:%u",		\
58 		__func__, __FILE__, __LINE__);	\
59 } while (0)
60 
61 #define BUG_ON(condition)	do { if (condition) BUG(); } while(0)
62 
63 #undef	ALIGN
64 #define	ALIGN(x, y)		roundup2((x), (y))
65 #define	DIV_ROUND_UP		howmany
66 #define DIV_ROUND_UP_ULL(X, N)	DIV_ROUND_UP((unsigned long long)(X), (N))
67 
68 #define	printk(X...)		kprintf(X)
69 #define	pr_debug(fmt, ...)	printk(KERN_DEBUG # fmt, ##__VA_ARGS__)
70 #define udelay(t)       	DELAY(t)
71 
72 #ifndef pr_fmt
73 #define pr_fmt(fmt) fmt
74 #endif
75 
76 /*
77  * Print a one-time message (analogous to WARN_ONCE() et al):
78  */
79 #define printk_once(x...) ({                    \
80         static bool __print_once;               \
81                                                 \
82         if (!__print_once) {                    \
83                 __print_once = true;            \
84                 printk(x);                      \
85         }                                       \
86 })
87 
88 
89 
90 #define pr_emerg(fmt, ...) \
91         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
92 #define pr_alert(fmt, ...) \
93         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
94 #define pr_crit(fmt, ...) \
95         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
96 #define pr_err(fmt, ...) \
97         kprintf(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
98 #define pr_warning(fmt, ...) \
99         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
100 #define pr_warn pr_warning
101 #define pr_notice(fmt, ...) \
102         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
103 #define pr_info(fmt, ...) \
104         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
105 #define pr_cont(fmt, ...) \
106         printk(KERN_CONT fmt, ##__VA_ARGS__)
107 
108 /* pr_devel() should produce zero code unless DEBUG is defined */
109 #ifdef DEBUG
110 #define pr_devel(fmt, ...) \
111         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
112 #else
113 #define pr_devel(fmt, ...) \
114         ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
115 #endif
116 
117 #ifndef WARN
118 #define WARN(condition, format...) ({                                   \
119         int __ret_warn_on = !!(condition);                              \
120         if (unlikely(__ret_warn_on))                                    \
121                 pr_warning(format);                                     \
122         unlikely(__ret_warn_on);                                        \
123 })
124 #endif
125 
126 #define WARN_ONCE(condition, format...)	({	\
127 	static bool __warned_once;		\
128 	int __ret = !!(condition);		\
129 						\
130 	if ((condition) && !__warned_once) {	\
131 		WARN(condition, format);	\
132 		__warned_once = true;		\
133 	}					\
134 	unlikely(__ret);			\
135 })
136 
137 #define container_of(ptr, type, member)				\
138 ({								\
139 	__typeof(((type *)0)->member) *_p = (ptr);		\
140 	(type *)((char *)_p - offsetof(type, member));		\
141 })
142 
143 #define	ARRAY_SIZE(x)	(sizeof(x) / sizeof((x)[0]))
144 
145 #define	simple_strtoul	strtoul
146 #define	simple_strtol	strtol
147 
148 #define min(x, y)			((x) < (y) ? (x) : (y))
149 #define max(x, y)			((x) > (y) ? (x) : (y))
150 
151 #define min3(a, b, c)			min(a, min(b,c))
152 #define max3(a, b, c)			max(a, max(b,c))
153 
154 #define min_t(type, _x, _y)		((type)(_x) < (type)(_y) ? (type)(_x) : (type)(_y))
155 #define max_t(type, _x, _y)		((type)(_x) > (type)(_y) ? (type)(_x) : (type)(_y))
156 
157 #define clamp_t(type, _x, min, max)	min_t(type, max_t(type, _x, min), max)
158 #define clamp(x, lo, hi)		min( max(x,lo), hi)
159 
160 /*
161  * This looks more complex than it should be. But we need to
162  * get the type for the ~ right in round_down (it needs to be
163  * as wide as the result!), and we want to evaluate the macro
164  * arguments just once each.
165  */
166 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
167 #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
168 #define round_down(x, y) ((x) & ~__round_mask(x, y))
169 
170 #define	num_possible_cpus()	mp_ncpus
171 
172 typedef struct pm_message {
173         int event;
174 } pm_message_t;
175 
176 /* Swap values of a and b */
177 #define swap(a, b)			\
178 ({					\
179 	typeof(a) _swap_tmp = a;	\
180 	a = b;				\
181 	b = _swap_tmp;			\
182 })
183 
184 #define DIV_ROUND_CLOSEST(x, divisor)	(((x) + ((divisor) /2)) / (divisor))
185 
186 static inline uintmax_t
187 mult_frac(uintmax_t x, uintmax_t multiplier, uintmax_t divisor)
188 {
189 	uintmax_t q = (x / divisor);
190 	uintmax_t r = (x % divisor);
191 
192 	return ((q * multiplier) + ((r * multiplier) / divisor));
193 }
194 
195 static inline int64_t abs64(int64_t x)
196 {
197 	return (x < 0 ? -x : x);
198 }
199 
200 /* simplified version of kvasnrprintf() for drm needs. */
201 char *drm_vasprintf(int flags, const char *format, __va_list ap) __printflike(2, 0);
202 char *drm_asprintf(int flags, const char *format, ...) __printflike(2, 3);
203 
204 #define DIV_ROUND_CLOSEST_ULL(ll, d)	\
205  ({ unsigned long long _tmp = (ll)+(d)/2; do_div(_tmp, d); _tmp; })
206 
207 #endif	/* _LINUX_KERNEL_H_ */
208