Merge branch 'hwmon-for-linus' of git://jdelvare.pck.nerim.net/jdelvare-2.6
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / kernel.h
CommitLineData
1da177e4
LT
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>
f0d1b0b3 16#include <linux/log2.h>
e0deaff4 17#include <linux/typecheck.h>
717115e1 18#include <linux/ratelimit.h>
346e15be 19#include <linux/dynamic_printk.h>
1da177e4
LT
20#include <asm/byteorder.h>
21#include <asm/bug.h>
22
3eb3c740
RZ
23extern const char linux_banner[];
24extern const char linux_proc_banner[];
25
44f564a4
ZY
26#define USHORT_MAX ((u16)(~0U))
27#define SHORT_MAX ((s16)(USHORT_MAX>>1))
28#define SHORT_MIN (-SHORT_MAX - 1)
1da177e4
LT
29#define INT_MAX ((int)(~0U>>1))
30#define INT_MIN (-INT_MAX - 1)
31#define UINT_MAX (~0U)
32#define LONG_MAX ((long)(~0UL>>1))
33#define LONG_MIN (-LONG_MAX - 1)
34#define ULONG_MAX (~0UL)
111ebb6e
OH
35#define LLONG_MAX ((long long)(~0ULL>>1))
36#define LLONG_MIN (-LLONG_MAX - 1)
37#define ULLONG_MAX (~0ULL)
1da177e4
LT
38
39#define STACK_MAGIC 0xdeadbeef
40
2ea58144
LT
41#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
42#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
a83308e6 43#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
f10db627 44#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
2ea58144 45
c5e631cf
RR
46#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
47
4552d5dc 48#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
930631ed 49#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
b4cac1a0 50#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
1da177e4 51
ca31e146
EGM
52#define _RET_IP_ (unsigned long)__builtin_return_address(0)
53#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
54
2da96acd
JA
55#ifdef CONFIG_LBD
56# include <asm/div64.h>
57# define sector_div(a, b) do_div(a, b)
58#else
59# define sector_div(n, b)( \
60{ \
61 int _res; \
62 _res = (n) % (b); \
63 (n) /= (b); \
64 _res; \
65} \
66)
67#endif
68
218e180e
AM
69/**
70 * upper_32_bits - return bits 32-63 of a number
71 * @n: the number we're accessing
72 *
73 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
74 * the "right shift count >= width of type" warning when that quantity is
75 * 32-bits.
76 */
77#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
78
204b885e
JR
79/**
80 * lower_32_bits - return bits 0-31 of a number
81 * @n: the number we're accessing
82 */
83#define lower_32_bits(n) ((u32)(n))
84
1da177e4
LT
85#define KERN_EMERG "<0>" /* system is unusable */
86#define KERN_ALERT "<1>" /* action must be taken immediately */
87#define KERN_CRIT "<2>" /* critical conditions */
88#define KERN_ERR "<3>" /* error conditions */
89#define KERN_WARNING "<4>" /* warning conditions */
90#define KERN_NOTICE "<5>" /* normal but significant condition */
91#define KERN_INFO "<6>" /* informational */
92#define KERN_DEBUG "<7>" /* debug-level messages */
93
47492527
IM
94/*
95 * Annotation for a "continued" line of log printout (only done after a
96 * line that had no enclosing \n). Only to be used by core/arch code
97 * during early bootup (a continued line is not SMP-safe otherwise).
98 */
99#define KERN_CONT ""
100
1da177e4
LT
101extern int console_printk[];
102
103#define console_loglevel (console_printk[0])
104#define default_message_loglevel (console_printk[1])
105#define minimum_console_loglevel (console_printk[2])
106#define default_console_loglevel (console_printk[3])
107
108struct completion;
df2e71fb
AM
109struct pt_regs;
110struct user;
1da177e4 111
070cb065
UKK
112#ifdef CONFIG_PREEMPT_VOLUNTARY
113extern int _cond_resched(void);
114# define might_resched() _cond_resched()
115#else
116# define might_resched() do { } while (0)
117#endif
118
1da177e4
LT
119/**
120 * might_sleep - annotation for functions that can sleep
121 *
122 * this macro will print a stack trace if it is executed in an atomic
123 * context (spinlock, irq-handler, ...).
124 *
125 * This is a useful debugging help to be able to catch problems early and not
e20ec991 126 * be bitten later when the calling function happens to sleep when it is not
1da177e4
LT
127 * supposed to.
128 */
129#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
f8cbd99b
IM
130 void __might_sleep(char *file, int line);
131# define might_sleep() \
132 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
1da177e4 133#else
f8cbd99b 134# define might_sleep() do { might_resched(); } while (0)
1da177e4
LT
135#endif
136
368a5fa1 137#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
f8cbd99b 138
1da177e4
LT
139#define abs(x) ({ \
140 int __x = (x); \
141 (__x < 0) ? -__x : __x; \
142 })
143
e041c683 144extern struct atomic_notifier_head panic_notifier_list;
1da177e4
LT
145extern long (*panic_blink)(long time);
146NORET_TYPE void panic(const char * fmt, ...)
a586df06 147 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
dd287796
AM
148extern void oops_enter(void);
149extern void oops_exit(void);
150extern int oops_may_print(void);
ec701584 151NORET_TYPE void do_exit(long error_code)
1da177e4
LT
152 ATTRIB_NORET;
153NORET_TYPE void complete_and_exit(struct completion *, long)
154 ATTRIB_NORET;
155extern unsigned long simple_strtoul(const char *,char **,unsigned int);
156extern long simple_strtol(const char *,char **,unsigned int);
157extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
158extern long long simple_strtoll(const char *,char **,unsigned int);
06b2a76d
YY
159extern int strict_strtoul(const char *, unsigned int, unsigned long *);
160extern int strict_strtol(const char *, unsigned int, long *);
161extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
162extern int strict_strtoll(const char *, unsigned int, long long *);
1da177e4
LT
163extern int sprintf(char * buf, const char * fmt, ...)
164 __attribute__ ((format (printf, 2, 3)));
165extern int vsprintf(char *buf, const char *, va_list)
166 __attribute__ ((format (printf, 2, 0)));
167extern int snprintf(char * buf, size_t size, const char * fmt, ...)
168 __attribute__ ((format (printf, 3, 4)));
169extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
170 __attribute__ ((format (printf, 3, 0)));
171extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
172 __attribute__ ((format (printf, 3, 4)));
173extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
174 __attribute__ ((format (printf, 3, 0)));
e905914f
JF
175extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
176 __attribute__ ((format (printf, 2, 3)));
11443ec7 177extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
1da177e4
LT
178
179extern int sscanf(const char *, const char *, ...)
180 __attribute__ ((format (scanf, 2, 3)));
181extern int vsscanf(const char *, const char *, va_list)
182 __attribute__ ((format (scanf, 2, 0)));
183
184extern int get_option(char **str, int *pint);
185extern char *get_options(const char *str, int nints, int *ints);
d974ae37 186extern unsigned long long memparse(const char *ptr, char **retptr);
1da177e4 187
5e376613 188extern int core_kernel_text(unsigned long addr);
1da177e4
LT
189extern int __kernel_text_address(unsigned long addr);
190extern int kernel_text_address(unsigned long addr);
04a2e6a5
EB
191struct pid;
192extern struct pid *session_of_pgrp(struct pid *pgrp);
1da177e4 193
d59745ce 194#ifdef CONFIG_PRINTK
1da177e4
LT
195asmlinkage int vprintk(const char *fmt, va_list args)
196 __attribute__ ((format (printf, 1, 0)));
197asmlinkage int printk(const char * fmt, ...)
a586df06 198 __attribute__ ((format (printf, 1, 2))) __cold;
7ef3d2fd 199
717115e1 200extern struct ratelimit_state printk_ratelimit_state;
7ef3d2fd 201extern int printk_ratelimit(void);
7ef3d2fd
JP
202extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
203 unsigned int interval_msec);
d59745ce
MM
204#else
205static inline int vprintk(const char *s, va_list args)
206 __attribute__ ((format (printf, 1, 0)));
207static inline int vprintk(const char *s, va_list args) { return 0; }
208static inline int printk(const char *s, ...)
209 __attribute__ ((format (printf, 1, 2)));
a586df06 210static inline int __cold printk(const char *s, ...) { return 0; }
7ef3d2fd 211static inline int printk_ratelimit(void) { return 0; }
7ef3d2fd
JP
212static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
213 unsigned int interval_msec) \
214 { return false; }
d59745ce 215#endif
1da177e4 216
ced9cd40
IM
217extern int printk_needs_cpu(int cpu);
218extern void printk_tick(void);
219
e17ba73b 220extern void asmlinkage __attribute__((format(printf, 1, 2)))
076f9776
IM
221 early_printk(const char *fmt, ...);
222
1da177e4
LT
223unsigned long int_sqrt(unsigned long);
224
1da177e4
LT
225static inline void console_silent(void)
226{
227 console_loglevel = 0;
228}
229
230static inline void console_verbose(void)
231{
232 if (console_loglevel)
233 console_loglevel = 15;
234}
235
236extern void bust_spinlocks(int yes);
e3e8a75d 237extern void wake_up_klogd(void);
1da177e4 238extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
aa727107 239extern int panic_timeout;
1da177e4 240extern int panic_on_oops;
8da5adda 241extern int panic_on_unrecovered_nmi;
1da177e4 242extern const char *print_tainted(void);
25ddbb18
AK
243extern void add_taint(unsigned flag);
244extern int test_taint(unsigned flag);
245extern unsigned long get_taint(void);
b920de1b 246extern int root_mountflags;
1da177e4
LT
247
248/* Values used for system_state */
249extern enum system_states {
250 SYSTEM_BOOTING,
251 SYSTEM_RUNNING,
252 SYSTEM_HALT,
253 SYSTEM_POWER_OFF,
254 SYSTEM_RESTART,
729b4d4c 255 SYSTEM_SUSPEND_DISK,
1da177e4
LT
256} system_state;
257
25ddbb18
AK
258#define TAINT_PROPRIETARY_MODULE 0
259#define TAINT_FORCED_MODULE 1
260#define TAINT_UNSAFE_SMP 2
261#define TAINT_FORCED_RMMOD 3
262#define TAINT_MACHINE_CHECK 4
263#define TAINT_BAD_PAGE 5
264#define TAINT_USER 6
265#define TAINT_DIE 7
266#define TAINT_OVERRIDDEN_ACPI_TABLE 8
267#define TAINT_WARN 9
1da177e4 268
a586df06 269extern void dump_stack(void) __cold;
1da177e4 270
99eaf3c4
RD
271enum {
272 DUMP_PREFIX_NONE,
273 DUMP_PREFIX_ADDRESS,
274 DUMP_PREFIX_OFFSET
275};
c7909234
RD
276extern void hex_dump_to_buffer(const void *buf, size_t len,
277 int rowsize, int groupsize,
278 char *linebuf, size_t linebuflen, bool ascii);
279extern void print_hex_dump(const char *level, const char *prefix_str,
280 int prefix_type, int rowsize, int groupsize,
6a0ed91e 281 const void *buf, size_t len, bool ascii);
c7909234 282extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
eb9a9a56 283 const void *buf, size_t len);
3fc95772
HH
284
285extern const char hex_asc[];
286#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
287#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
288
289static inline char *pack_hex_byte(char *buf, u8 byte)
290{
291 *buf++ = hex_asc_hi(byte);
292 *buf++ = hex_asc_lo(byte);
293 return buf;
294}
99eaf3c4 295
1f7c8234
EM
296#define pr_emerg(fmt, arg...) \
297 printk(KERN_EMERG fmt, ##arg)
298#define pr_alert(fmt, arg...) \
299 printk(KERN_ALERT fmt, ##arg)
300#define pr_crit(fmt, arg...) \
301 printk(KERN_CRIT fmt, ##arg)
302#define pr_err(fmt, arg...) \
303 printk(KERN_ERR fmt, ##arg)
304#define pr_warning(fmt, arg...) \
305 printk(KERN_WARNING fmt, ##arg)
306#define pr_notice(fmt, arg...) \
307 printk(KERN_NOTICE fmt, ##arg)
308#define pr_info(fmt, arg...) \
309 printk(KERN_INFO fmt, ##arg)
310
1cc6daf2 311/* If you are writing a driver, please use dev_dbg instead */
346e15be
JB
312#if defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
313#define pr_debug(fmt, ...) do { \
314 dynamic_pr_debug(fmt, ##__VA_ARGS__); \
315 } while (0)
316#elif defined(DEBUG)
1f7c8234
EM
317#define pr_debug(fmt, arg...) \
318 printk(KERN_DEBUG fmt, ##arg)
1da177e4 319#else
1429db83
JP
320#define pr_debug(fmt, arg...) \
321 ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
1da177e4
LT
322#endif
323
1da177e4
LT
324/*
325 * Display an IP address in readable format.
326 */
327
328#define NIPQUAD(addr) \
329 ((unsigned char *)&addr)[0], \
330 ((unsigned char *)&addr)[1], \
331 ((unsigned char *)&addr)[2], \
332 ((unsigned char *)&addr)[3]
46b86a2d 333#define NIPQUAD_FMT "%u.%u.%u.%u"
1da177e4
LT
334
335#define NIP6(addr) \
336 ntohs((addr).s6_addr16[0]), \
337 ntohs((addr).s6_addr16[1]), \
338 ntohs((addr).s6_addr16[2]), \
339 ntohs((addr).s6_addr16[3]), \
340 ntohs((addr).s6_addr16[4]), \
341 ntohs((addr).s6_addr16[5]), \
342 ntohs((addr).s6_addr16[6]), \
343 ntohs((addr).s6_addr16[7])
46b86a2d 344#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
9343e79a 345#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
1da177e4
LT
346
347#if defined(__LITTLE_ENDIAN)
348#define HIPQUAD(addr) \
349 ((unsigned char *)&addr)[3], \
350 ((unsigned char *)&addr)[2], \
351 ((unsigned char *)&addr)[1], \
352 ((unsigned char *)&addr)[0]
353#elif defined(__BIG_ENDIAN)
354#define HIPQUAD NIPQUAD
355#else
356#error "Please fix asm/byteorder.h"
357#endif /* __LITTLE_ENDIAN */
358
359/*
bdf4bbaa 360 * min()/max()/clamp() macros that also do
1da177e4
LT
361 * strict type-checking.. See the
362 * "unnecessary" pointer comparison.
363 */
bdf4bbaa
HH
364#define min(x, y) ({ \
365 typeof(x) _min1 = (x); \
366 typeof(y) _min2 = (y); \
367 (void) (&_min1 == &_min2); \
368 _min1 < _min2 ? _min1 : _min2; })
369
370#define max(x, y) ({ \
371 typeof(x) _max1 = (x); \
372 typeof(y) _max2 = (y); \
373 (void) (&_max1 == &_max2); \
374 _max1 > _max2 ? _max1 : _max2; })
375
376/**
377 * clamp - return a value clamped to a given range with strict typechecking
378 * @val: current value
379 * @min: minimum allowable value
380 * @max: maximum allowable value
381 *
382 * This macro does strict typechecking of min/max to make sure they are of the
383 * same type as val. See the unnecessary pointer comparisons.
384 */
385#define clamp(val, min, max) ({ \
386 typeof(val) __val = (val); \
387 typeof(min) __min = (min); \
388 typeof(max) __max = (max); \
389 (void) (&__val == &__min); \
390 (void) (&__val == &__max); \
391 __val = __val < __min ? __min: __val; \
392 __val > __max ? __max: __val; })
1da177e4
LT
393
394/*
395 * ..and if you can't take the strict
396 * types, you can specify one yourself.
397 *
bdf4bbaa
HH
398 * Or not use min/max/clamp at all, of course.
399 */
400#define min_t(type, x, y) ({ \
401 type __min1 = (x); \
402 type __min2 = (y); \
403 __min1 < __min2 ? __min1: __min2; })
404
405#define max_t(type, x, y) ({ \
406 type __max1 = (x); \
407 type __max2 = (y); \
408 __max1 > __max2 ? __max1: __max2; })
409
410/**
411 * clamp_t - return a value clamped to a given range using a given type
412 * @type: the type of variable to use
413 * @val: current value
414 * @min: minimum allowable value
415 * @max: maximum allowable value
416 *
417 * This macro does no typechecking and uses temporary variables of type
418 * 'type' to make all the comparisons.
1da177e4 419 */
bdf4bbaa
HH
420#define clamp_t(type, val, min, max) ({ \
421 type __val = (val); \
422 type __min = (min); \
423 type __max = (max); \
424 __val = __val < __min ? __min: __val; \
425 __val > __max ? __max: __val; })
1da177e4 426
bdf4bbaa
HH
427/**
428 * clamp_val - return a value clamped to a given range using val's type
429 * @val: current value
430 * @min: minimum allowable value
431 * @max: maximum allowable value
432 *
433 * This macro does no typechecking and uses temporary variables of whatever
434 * type the input argument 'val' is. This is useful when val is an unsigned
435 * type and min and max are literals that will otherwise be assigned a signed
436 * integer type.
437 */
438#define clamp_val(val, min, max) ({ \
439 typeof(val) __val = (val); \
440 typeof(val) __min = (min); \
441 typeof(val) __max = (max); \
442 __val = __val < __min ? __min: __val; \
443 __val > __max ? __max: __val; })
1da177e4
LT
444
445/**
446 * container_of - cast a member of a structure out to the containing structure
1da177e4
LT
447 * @ptr: the pointer to the member.
448 * @type: the type of the container struct this is embedded in.
449 * @member: the name of the member within the struct.
450 *
451 */
452#define container_of(ptr, type, member) ({ \
78db2ad6
DW
453 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
454 (type *)( (char *)__mptr - offsetof(type,member) );})
1da177e4 455
d4d23add
KM
456struct sysinfo;
457extern int do_sysinfo(struct sysinfo *info);
458
1da177e4
LT
459#endif /* __KERNEL__ */
460
461#define SI_LOAD_SHIFT 16
462struct sysinfo {
463 long uptime; /* Seconds since boot */
464 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
465 unsigned long totalram; /* Total usable main memory size */
466 unsigned long freeram; /* Available memory size */
467 unsigned long sharedram; /* Amount of shared memory */
468 unsigned long bufferram; /* Memory used by buffers */
469 unsigned long totalswap; /* Total swap space size */
470 unsigned long freeswap; /* swap space still available */
471 unsigned short procs; /* Number of current processes */
472 unsigned short pad; /* explicit padding for m68k */
473 unsigned long totalhigh; /* Total high memory size */
474 unsigned long freehigh; /* Available high memory size */
475 unsigned int mem_unit; /* Memory unit size in bytes */
476 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
477};
478
c0398ee6 479/* Force a compilation error if condition is true */
921717a2 480#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
1da177e4 481
4552d5dc
JB
482/* Force a compilation error if condition is true, but also produce a
483 result (of value 0 and type size_t), so the expression can be used
484 e.g. in a structure initializer (or where-ever else comma expressions
485 aren't permitted). */
486#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
487
1da177e4 488/* Trap pasters of __FUNCTION__ at compile-time */
1da177e4 489#define __FUNCTION__ (__func__)
1da177e4 490
08e0f6a9
CL
491/* This helps us to avoid #ifdef CONFIG_NUMA */
492#ifdef CONFIG_NUMA
493#define NUMA_BUILD 1
494#else
495#define NUMA_BUILD 0
496#endif
497
1da177e4 498#endif