Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
Version: [ 2.6.11.8 ] [ 2.6.25 ] [ 2.6.25.8 ] [ 2.6.31.13 ] Architecture: [ i386 ]
  1 #ifndef _LINUX_KERNEL_H
  2 #define _LINUX_KERNEL_H
  3 
  4 /*
  5  * 'kernel.h' contains some often-used function prototypes etc
  6  */
  7 
  8 #ifdef __KERNEL__
  9 
 10 #include <stdarg.h>
 11 #include <linux/linkage.h>
 12 #include <linux/stddef.h>
 13 #include <linux/types.h>
 14 #include <linux/compiler.h>
 15 #include <linux/bitops.h>
 16 #include <linux/log2.h>
 17 #include <asm/byteorder.h>
 18 #include <asm/bug.h>
 19 
 20 extern const char linux_banner[];
 21 extern const char linux_proc_banner[];
 22 
 23 #define INT_MAX         ((int)(~0U>>1))
 24 #define INT_MIN         (-INT_MAX - 1)
 25 #define UINT_MAX        (~0U)
 26 #define LONG_MAX        ((long)(~0UL>>1))
 27 #define LONG_MIN        (-LONG_MAX - 1)
 28 #define ULONG_MAX       (~0UL)
 29 #define LLONG_MAX       ((long long)(~0ULL>>1))
 30 #define LLONG_MIN       (-LLONG_MAX - 1)
 31 #define ULLONG_MAX      (~0ULL)
 32 
 33 #define STACK_MAGIC     0xdeadbeef
 34 
 35 #define ALIGN(x,a)              __ALIGN_MASK(x,(typeof(x))(a)-1)
 36 #define __ALIGN_MASK(x,mask)    (((x)+(mask))&~(mask))
 37 #define PTR_ALIGN(p, a)         ((typeof(p))ALIGN((unsigned long)(p), (a)))
 38 #define IS_ALIGNED(x, a)                (((x) & ((typeof(x))(a) - 1)) == 0)
 39 
 40 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
 41 
 42 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
 43 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
 44 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
 45 
 46 #ifdef CONFIG_LBD
 47 # include <asm/div64.h>
 48 # define sector_div(a, b) do_div(a, b)
 49 #else
 50 # define sector_div(n, b)( \
 51 { \
 52         int _res; \
 53         _res = (n) % (b); \
 54         (n) /= (b); \
 55         _res; \
 56 } \
 57 )
 58 #endif
 59 
 60 /**
 61  * upper_32_bits - return bits 32-63 of a number
 62  * @n: the number we're accessing
 63  *
 64  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
 65  * the "right shift count >= width of type" warning when that quantity is
 66  * 32-bits.
 67  */
 68 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
 69 
 70 #define KERN_EMERG      "<0>"   /* system is unusable                   */
 71 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
 72 #define KERN_CRIT       "<2>"   /* critical conditions                  */
 73 #define KERN_ERR        "<3>"   /* error conditions                     */
 74 #define KERN_WARNING    "<4>"   /* warning conditions                   */
 75 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
 76 #define KERN_INFO       "<6>"   /* informational                        */
 77 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
 78 
 79 /*
 80  * Annotation for a "continued" line of log printout (only done after a
 81  * line that had no enclosing \n). Only to be used by core/arch code
 82  * during early bootup (a continued line is not SMP-safe otherwise).
 83  */
 84 #define KERN_CONT       ""
 85 
 86 extern int console_printk[];
 87 
 88 #define console_loglevel (console_printk[0])
 89 #define default_message_loglevel (console_printk[1])
 90 #define minimum_console_loglevel (console_printk[2])
 91 #define default_console_loglevel (console_printk[3])
 92 
 93 struct completion;
 94 struct pt_regs;
 95 struct user;
 96 
 97 /**
 98  * might_sleep - annotation for functions that can sleep
 99  *
100  * this macro will print a stack trace if it is executed in an atomic
101  * context (spinlock, irq-handler, ...).
102  *
103  * This is a useful debugging help to be able to catch problems early and not
104  * be bitten later when the calling function happens to sleep when it is not
105  * supposed to.
106  */
107 #ifdef CONFIG_PREEMPT_VOLUNTARY
108 extern int _cond_resched(void);
109 # define might_resched() _cond_resched()
110 #else
111 # define might_resched() do { } while (0)
112 #endif
113 
114 #if defined(CONFIG_DEBUG_SPINLOCK_SLEEP) || defined(CONFIG_DEBUG_PREEMPT)
115   void __might_sleep(char *file, int line);
116 # define might_sleep() \
117         do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
118 #else
119 # define might_sleep() do { might_resched(); } while (0)
120 #endif
121 
122 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
123 
124 #define abs(x) ({                               \
125                 int __x = (x);                  \
126                 (__x < 0) ? -__x : __x;         \
127         })
128 
129 extern struct atomic_notifier_head panic_notifier_list;
130 extern long (*panic_blink)(long time);
131 NORET_TYPE void panic(const char * fmt, ...)
132         __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
133 extern void oops_enter(void);
134 extern void oops_exit(void);
135 extern int oops_may_print(void);
136 NORET_TYPE void do_exit(long error_code)
137         ATTRIB_NORET;
138 NORET_TYPE void complete_and_exit(struct completion *, long)
139         ATTRIB_NORET;
140 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
141 extern long simple_strtol(const char *,char **,unsigned int);
142 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
143 extern long long simple_strtoll(const char *,char **,unsigned int);
144 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
145 extern int strict_strtol(const char *, unsigned int, long *);
146 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
147 extern int strict_strtoll(const char *, unsigned int, long long *);
148 extern int sprintf(char * buf, const char * fmt, ...)
149         __attribute__ ((format (printf, 2, 3)));
150 extern int vsprintf(char *buf, const char *, va_list)
151         __attribute__ ((format (printf, 2, 0)));
152 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
153         __attribute__ ((format (printf, 3, 4)));
154 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
155         __attribute__ ((format (printf, 3, 0)));
156 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
157         __attribute__ ((format (printf, 3, 4)));
158 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
159         __attribute__ ((format (printf, 3, 0)));
160 extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
161         __attribute__ ((format (printf, 2, 3)));
162 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
163 
164 extern int sscanf(const char *, const char *, ...)
165         __attribute__ ((format (scanf, 2, 3)));
166 extern int vsscanf(const char *, const char *, va_list)
167         __attribute__ ((format (scanf, 2, 0)));
168 
169 extern int get_option(char **str, int *pint);
170 extern char *get_options(const char *str, int nints, int *ints);
171 extern unsigned long long memparse(char *ptr, char **retptr);
172 
173 extern int core_kernel_text(unsigned long addr);
174 extern int __kernel_text_address(unsigned long addr);
175 extern int kernel_text_address(unsigned long addr);
176 struct pid;
177 extern struct pid *session_of_pgrp(struct pid *pgrp);
178 
179 #ifdef CONFIG_PRINTK
180 asmlinkage int vprintk(const char *fmt, va_list args)
181         __attribute__ ((format (printf, 1, 0)));
182 asmlinkage int printk(const char * fmt, ...)
183         __attribute__ ((format (printf, 1, 2))) __cold;
184 extern int log_buf_get_len(void);
185 extern int log_buf_read(int idx);
186 extern int log_buf_copy(char *dest, int idx, int len);
187 
188 extern int printk_ratelimit_jiffies;
189 extern int printk_ratelimit_burst;
190 extern int printk_ratelimit(void);
191 extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
192 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
193                                    unsigned int interval_msec);
194 #else
195 static inline int vprintk(const char *s, va_list args)
196         __attribute__ ((format (printf, 1, 0)));
197 static inline int vprintk(const char *s, va_list args) { return 0; }
198 static inline int printk(const char *s, ...)
199         __attribute__ ((format (printf, 1, 2)));
200 static inline int __cold printk(const char *s, ...) { return 0; }
201 static inline int log_buf_get_len(void) { return 0; }
202 static inline int log_buf_read(int idx) { return 0; }
203 static inline int log_buf_copy(char *dest, int idx, int len) { return 0; }
204 static inline int printk_ratelimit(void) { return 0; }
205 static inline int __printk_ratelimit(int ratelimit_jiffies, \
206                                      int ratelimit_burst) { return 0; }
207 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
208                                           unsigned int interval_msec)   \
209                 { return false; }
210 #endif
211 
212 extern void __attribute__((format(printf, 1, 2)))
213         early_printk(const char *fmt, ...);
214 
215 #ifdef CONFIG_PREEMPT_RT
216 extern void zap_rt_locks(void);
217 #else
218 # define zap_rt_locks() do { } while (0)
219 #endif
220 
221 #ifdef CONFIG_PREEMPT_RT
222 extern void zap_rt_locks(void);
223 #else
224 # define zap_rt_locks() do { } while (0)
225 #endif
226 
227 unsigned long int_sqrt(unsigned long);
228 
229 static inline void console_silent(void)
230 {
231         console_loglevel = 0;
232 }
233 
234 static inline void console_verbose(void)
235 {
236         if (console_loglevel)
237                 console_loglevel = 15;
238 }
239 
240 extern void bust_spinlocks(int yes);
241 extern void wake_up_klogd(void);
242 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
243 extern int panic_timeout;
244 extern int panic_on_oops;
245 
246 extern void pause_on_oops_head(void);
247 extern void pause_on_oops_tail(void);
248 
249 extern int panic_on_unrecovered_nmi;
250 extern int tainted;
251 extern const char *print_tainted(void);
252 extern void add_taint(unsigned);
253 extern int root_mountflags;
254 
255 /* Values used for system_state */
256 extern enum system_states {
257         SYSTEM_BOOTING,
258         SYSTEM_BOOTING_SCHEDULER_OK,
259         SYSTEM_RUNNING,
260         SYSTEM_HALT,
261         SYSTEM_POWER_OFF,
262         SYSTEM_RESTART,
263         SYSTEM_SUSPEND_DISK,
264 } system_state;
265 
266 #define TAINT_PROPRIETARY_MODULE        (1<<0)
267 #define TAINT_FORCED_MODULE             (1<<1)
268 #define TAINT_UNSAFE_SMP                (1<<2)
269 #define TAINT_FORCED_RMMOD              (1<<3)
270 #define TAINT_MACHINE_CHECK             (1<<4)
271 #define TAINT_BAD_PAGE                  (1<<5)
272 #define TAINT_USER                      (1<<6)
273 #define TAINT_DIE                       (1<<7)
274 #define TAINT_OVERRIDDEN_ACPI_TABLE     (1<<8)
275 
276 extern void dump_stack(void) __cold;
277 
278 enum {
279         DUMP_PREFIX_NONE,
280         DUMP_PREFIX_ADDRESS,
281         DUMP_PREFIX_OFFSET
282 };
283 extern void hex_dump_to_buffer(const void *buf, size_t len,
284                                 int rowsize, int groupsize,
285                                 char *linebuf, size_t linebuflen, bool ascii);
286 extern void print_hex_dump(const char *level, const char *prefix_str,
287                                 int prefix_type, int rowsize, int groupsize,
288                                 const void *buf, size_t len, bool ascii);
289 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
290                         const void *buf, size_t len);
291 #define hex_asc(x)      "0123456789abcdef"[x]
292 
293 #define pr_emerg(fmt, arg...) \
294         printk(KERN_EMERG fmt, ##arg)
295 #define pr_alert(fmt, arg...) \
296         printk(KERN_ALERT fmt, ##arg)
297 #define pr_crit(fmt, arg...) \
298         printk(KERN_CRIT fmt, ##arg)
299 #define pr_err(fmt, arg...) \
300         printk(KERN_ERR fmt, ##arg)
301 #define pr_warning(fmt, arg...) \
302         printk(KERN_WARNING fmt, ##arg)
303 #define pr_notice(fmt, arg...) \
304         printk(KERN_NOTICE fmt, ##arg)
305 #define pr_info(fmt, arg...) \
306         printk(KERN_INFO fmt, ##arg)
307 
308 #ifdef DEBUG
309 /* If you are writing a driver, please use dev_dbg instead */
310 #define pr_debug(fmt, arg...) \
311         printk(KERN_DEBUG fmt, ##arg)
312 #else
313 static inline int __attribute__ ((format (printf, 1, 2))) pr_debug(const char * fmt, ...)
314 {
315         return 0;
316 }
317 #endif
318 
319 /*
320  *      Display an IP address in readable format.
321  */
322 
323 #define NIPQUAD(addr) \
324         ((unsigned char *)&addr)[0], \
325         ((unsigned char *)&addr)[1], \
326         ((unsigned char *)&addr)[2], \
327         ((unsigned char *)&addr)[3]
328 #define NIPQUAD_FMT "%u.%u.%u.%u"
329 
330 #define NIP6(addr) \
331         ntohs((addr).s6_addr16[0]), \
332         ntohs((addr).s6_addr16[1]), \
333         ntohs((addr).s6_addr16[2]), \
334         ntohs((addr).s6_addr16[3]), \
335         ntohs((addr).s6_addr16[4]), \
336         ntohs((addr).s6_addr16[5]), \
337         ntohs((addr).s6_addr16[6]), \
338         ntohs((addr).s6_addr16[7])
339 #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
340 #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
341 
342 #if defined(__LITTLE_ENDIAN)
343 #define HIPQUAD(addr) \
344         ((unsigned char *)&addr)[3], \
345         ((unsigned char *)&addr)[2], \
346         ((unsigned char *)&addr)[1], \
347         ((unsigned char *)&addr)[0]
348 #elif defined(__BIG_ENDIAN)
349 #define HIPQUAD NIPQUAD
350 #else
351 #error "Please fix asm/byteorder.h"
352 #endif /* __LITTLE_ENDIAN */
353 
354 /*
355  * min()/max() macros that also do
356  * strict type-checking.. See the
357  * "unnecessary" pointer comparison.
358  */
359 #define min(x,y) ({ \
360         typeof(x) _x = (x);     \
361         typeof(y) _y = (y);     \
362         (void) (&_x == &_y);            \
363         _x < _y ? _x : _y; })
364 
365 #define max(x,y) ({ \
366         typeof(x) _x = (x);     \
367         typeof(y) _y = (y);     \
368         (void) (&_x == &_y);            \
369         _x > _y ? _x : _y; })
370 
371 /*
372  * ..and if you can't take the strict
373  * types, you can specify one yourself.
374  *
375  * Or not use min/max at all, of course.
376  */
377 #define min_t(type,x,y) \
378         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
379 #define max_t(type,x,y) \
380         ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
381 
382 
383 /**
384  * container_of - cast a member of a structure out to the containing structure
385  * @ptr:        the pointer to the member.
386  * @type:       the type of the container struct this is embedded in.
387  * @member:     the name of the member within the struct.
388  *
389  */
390 #define container_of(ptr, type, member) ({                      \
391         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
392         (type *)( (char *)__mptr - offsetof(type,member) );})
393 
394 /*
395  * Check at compile time that something is of a particular type.
396  * Always evaluates to 1 so you may use it easily in comparisons.
397  */
398 #define typecheck(type,x) \
399 ({      type __dummy; \
400         typeof(x) __dummy2; \
401         (void)(&__dummy == &__dummy2); \
402         1; \
403 })
404 
405 /*
406  * Check at compile time that 'function' is a certain type, or is a pointer
407  * to that type (needs to use typedef for the function type.)
408  */
409 #define typecheck_fn(type,function) \
410 ({      typeof(type) __tmp = function; \
411         (void)__tmp; \
412 })
413 
414 struct sysinfo;
415 extern int do_sysinfo(struct sysinfo *info);
416 
417 #endif /* __KERNEL__ */
418 
419 #define SI_LOAD_SHIFT   16
420 struct sysinfo {
421         long uptime;                    /* Seconds since boot */
422         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
423         unsigned long totalram;         /* Total usable main memory size */
424         unsigned long freeram;          /* Available memory size */
425         unsigned long sharedram;        /* Amount of shared memory */
426         unsigned long bufferram;        /* Memory used by buffers */
427         unsigned long totalswap;        /* Total swap space size */
428         unsigned long freeswap;         /* swap space still available */
429         unsigned short procs;           /* Number of current processes */
430         unsigned short pad;             /* explicit padding for m68k */
431         unsigned long totalhigh;        /* Total high memory size */
432         unsigned long freehigh;         /* Available high memory size */
433         unsigned int mem_unit;          /* Memory unit size in bytes */
434         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
435 };
436 
437 /* Force a compilation error if condition is true */
438 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
439 
440 /* Force a compilation error if condition is true, but also produce a
441    result (of value 0 and type size_t), so the expression can be used
442    e.g. in a structure initializer (or where-ever else comma expressions
443    aren't permitted). */
444 #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
445 
446 /* Trap pasters of __FUNCTION__ at compile-time */
447 #define __FUNCTION__ (__func__)
448 
449 /* This helps us to avoid #ifdef CONFIG_NUMA */
450 #ifdef CONFIG_NUMA
451 #define NUMA_BUILD 1
452 #else
453 #define NUMA_BUILD 0
454 #endif
455 
456 #endif
457 
  This page was automatically generated by the LXR engine.