Subversion Repositories shark

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
434 giacomo 1
/******************************************************************************
2
 *
3
 * Name: acmacros.h - C macros for the entire subsystem.
4
 *
5
 *****************************************************************************/
6
 
7
/*
8
 * Copyright (C) 2000 - 2003, R. Byron Moore
9
 * All rights reserved.
10
 *
11
 * Redistribution and use in source and binary forms, with or without
12
 * modification, are permitted provided that the following conditions
13
 * are met:
14
 * 1. Redistributions of source code must retain the above copyright
15
 *    notice, this list of conditions, and the following disclaimer,
16
 *    without modification.
17
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18
 *    substantially similar to the "NO WARRANTY" disclaimer below
19
 *    ("Disclaimer") and any redistribution must be conditioned upon
20
 *    including a substantially similar Disclaimer requirement for further
21
 *    binary redistribution.
22
 * 3. Neither the names of the above-listed copyright holders nor the names
23
 *    of any contributors may be used to endorse or promote products derived
24
 *    from this software without specific prior written permission.
25
 *
26
 * Alternatively, this software may be distributed under the terms of the
27
 * GNU General Public License ("GPL") version 2 as published by the Free
28
 * Software Foundation.
29
 *
30
 * NO WARRANTY
31
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41
 * POSSIBILITY OF SUCH DAMAGES.
42
 */
43
 
44
#ifndef __ACMACROS_H__
45
#define __ACMACROS_H__
46
 
47
 
48
/*
49
 * Data manipulation macros
50
 */
51
 
52
#define ACPI_LOWORD(l)                  ((u16)(u32)(l))
53
#define ACPI_HIWORD(l)                  ((u16)((((u32)(l)) >> 16) & 0xFFFF))
54
#define ACPI_LOBYTE(l)                  ((u8)(u16)(l))
55
#define ACPI_HIBYTE(l)                  ((u8)((((u16)(l)) >> 8) & 0xFF))
56
 
57
 
58
#if ACPI_MACHINE_WIDTH == 16
59
 
60
/*
61
 * For 16-bit addresses, we have to assume that the upper 32 bits
62
 * are zero.
63
 */
64
#define ACPI_LODWORD(l)                 ((u32)(l))
65
#define ACPI_HIDWORD(l)                 ((u32)(0))
66
 
67
#define ACPI_GET_ADDRESS(a)             ((a).lo)
68
#define ACPI_STORE_ADDRESS(a,b)         {(a).hi=0;(a).lo=(u32)(b);}
69
#define ACPI_VALID_ADDRESS(a)           ((a).hi | (a).lo)
70
 
71
#else
72
#ifdef ACPI_NO_INTEGER64_SUPPORT
73
/*
74
 * acpi_integer is 32-bits, no 64-bit support on this platform
75
 */
76
#define ACPI_LODWORD(l)                 ((u32)(l))
77
#define ACPI_HIDWORD(l)                 ((u32)(0))
78
 
79
#define ACPI_GET_ADDRESS(a)             (a)
80
#define ACPI_STORE_ADDRESS(a,b)         ((a)=(b))
81
#define ACPI_VALID_ADDRESS(a)           (a)
82
 
83
#else
84
 
85
/*
86
 * Full 64-bit address/integer on both 32-bit and 64-bit platforms
87
 */
88
#define ACPI_LODWORD(l)                 ((u32)(u64)(l))
89
#define ACPI_HIDWORD(l)                 ((u32)(((*(struct uint64_struct *)(void *)(&l))).hi))
90
 
91
#define ACPI_GET_ADDRESS(a)             (a)
92
#define ACPI_STORE_ADDRESS(a,b)         ((a)=(acpi_physical_address)(b))
93
#define ACPI_VALID_ADDRESS(a)           (a)
94
#endif
95
#endif
96
 
97
 /*
98
  * Extract a byte of data using a pointer.  Any more than a byte and we
99
  * get into potential aligment issues -- see the STORE macros below
100
  */
101
#define ACPI_GET8(addr)                 (*(u8*)(addr))
102
 
103
/* Pointer arithmetic */
104
 
105
#define ACPI_PTR_ADD(t,a,b)             (t *) (void *)((char *)(a) + (acpi_native_uint)(b))
106
#define ACPI_PTR_DIFF(a,b)              (acpi_native_uint) ((char *)(a) - (char *)(b))
107
 
108
/* Pointer/Integer type conversions */
109
 
110
#define ACPI_TO_POINTER(i)              ACPI_PTR_ADD (void, (void *) NULL,(acpi_native_uint)i)
111
#define ACPI_TO_INTEGER(p)              ACPI_PTR_DIFF (p,(void *) NULL)
112
#define ACPI_OFFSET(d,f)                (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f),(void *) NULL)
113
#define ACPI_FADT_OFFSET(f)             ACPI_OFFSET (FADT_DESCRIPTOR, f)
114
 
115
#define ACPI_CAST_PTR(t, p)             ((t *)(void *)(p))
116
#define ACPI_CAST_INDIRECT_PTR(t, p)    ((t **)(void *)(p))
117
 
118
#if ACPI_MACHINE_WIDTH == 16
119
#define ACPI_STORE_POINTER(d,s)         ACPI_MOVE_32_TO_32(d,s)
120
#define ACPI_PHYSADDR_TO_PTR(i)         (void *)(i)
121
#define ACPI_PTR_TO_PHYSADDR(i)         (u32) (char *)(i)
122
#else
123
#define ACPI_PHYSADDR_TO_PTR(i)         ACPI_TO_POINTER(i)
124
#define ACPI_PTR_TO_PHYSADDR(i)         ACPI_TO_INTEGER(i)
125
#endif
126
 
127
/*
128
 * Macros for moving data around to/from buffers that are possibly unaligned.
129
 * If the hardware supports the transfer of unaligned data, just do the store.
130
 * Otherwise, we have to move one byte at a time.
131
 */
132
 
133
#ifdef ACPI_BIG_ENDIAN
134
/*
135
 * Macros for big-endian machines
136
 */
137
 
138
/* This macro sets a buffer index, starting from the end of the buffer */
139
 
140
#define ACPI_BUFFER_INDEX(buf_len,buf_offset,byte_gran) ((buf_len) - (((buf_offset)+1) * (byte_gran)))
141
 
142
/* These macros reverse the bytes during the move, converting little-endian to big endian */
143
 
144
         /* Big Endian      <==        Little Endian */
145
         /*  Hi...Lo                     Lo...Hi     */
146
/* 16-bit source, 16/32/64 destination */
147
 
148
#define ACPI_MOVE_16_TO_16(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[1];\
149
                          ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[0];}
150
 
151
#define ACPI_MOVE_16_TO_32(d,s)         {(*(u32 *)(void *)(d))=0;\
152
                                          ((u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
153
                                          ((u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
154
 
155
#define ACPI_MOVE_16_TO_64(d,s)         {(*(u64 *)(void *)(d))=0;\
156
                                                           ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
157
                                                           ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
158
 
159
/* 32-bit source, 16/32/64 destination */
160
 
161
#define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
162
 
163
#define ACPI_MOVE_32_TO_32(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[3];\
164
                                                                          ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[2];\
165
                                                                          ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[1];\
166
                                                                          ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[0];}
167
 
168
#define ACPI_MOVE_32_TO_64(d,s)         {(*(u64 *)(void *)(d))=0;\
169
                                                                                   ((u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
170
                                                                                   ((u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
171
                                                                                   ((u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
172
                                                                                   ((u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
173
 
174
/* 64-bit source, 16/32/64 destination */
175
 
176
#define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
177
 
178
#define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s)    /* Truncate to 32 */
179
 
180
#define ACPI_MOVE_64_TO_64(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[7];\
181
                                                                                 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[6];\
182
                                                                                 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[5];\
183
                                                                                 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[4];\
184
                                                                                 ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[3];\
185
                                                                                 ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[2];\
186
                                                                                 ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[1];\
187
                                                                                 ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[0];}
188
#else
189
/*
190
 * Macros for little-endian machines
191
 */
192
 
193
/* This macro sets a buffer index, starting from the beginning of the buffer */
194
 
195
#define ACPI_BUFFER_INDEX(buf_len,buf_offset,byte_gran) (buf_offset)
196
 
197
#ifdef ACPI_MISALIGNED_TRANSFERS
198
 
199
/* The hardware supports unaligned transfers, just do the little-endian move */
200
 
201
#if ACPI_MACHINE_WIDTH == 16
202
 
203
/* No 64-bit integers */
204
/* 16-bit source, 16/32/64 destination */
205
 
206
#define ACPI_MOVE_16_TO_16(d,s)         *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
207
#define ACPI_MOVE_16_TO_32(d,s)         *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
208
#define ACPI_MOVE_16_TO_64(d,s)         ACPI_MOVE_16_TO_32(d,s)
209
 
210
/* 32-bit source, 16/32/64 destination */
211
 
212
#define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
213
#define ACPI_MOVE_32_TO_32(d,s)         *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
214
#define ACPI_MOVE_32_TO_64(d,s)         ACPI_MOVE_32_TO_32(d,s)
215
 
216
/* 64-bit source, 16/32/64 destination */
217
 
218
#define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
219
#define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s)    /* Truncate to 32 */
220
#define ACPI_MOVE_64_TO_64(d,s)         ACPI_MOVE_32_TO_32(d,s)
221
 
222
#else
223
/* 16-bit source, 16/32/64 destination */
224
 
225
#define ACPI_MOVE_16_TO_16(d,s)         *(u16 *)(void *)(d) = *(u16 *)(void *)(s)
226
#define ACPI_MOVE_16_TO_32(d,s)         *(u32 *)(void *)(d) = *(u16 *)(void *)(s)
227
#define ACPI_MOVE_16_TO_64(d,s)         *(u64 *)(void *)(d) = *(u16 *)(void *)(s)
228
 
229
/* 32-bit source, 16/32/64 destination */
230
 
231
#define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
232
#define ACPI_MOVE_32_TO_32(d,s)         *(u32 *)(void *)(d) = *(u32 *)(void *)(s)
233
#define ACPI_MOVE_32_TO_64(d,s)         *(u64 *)(void *)(d) = *(u32 *)(void *)(s)
234
 
235
/* 64-bit source, 16/32/64 destination */
236
 
237
#define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
238
#define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s)    /* Truncate to 32 */
239
#define ACPI_MOVE_64_TO_64(d,s)         *(u64 *)(void *)(d) = *(u64 *)(void *)(s)
240
#endif
241
 
242
#else
243
/*
244
 * The hardware does not support unaligned transfers.  We must move the
245
 * data one byte at a time.  These macros work whether the source or
246
 * the destination (or both) is/are unaligned.  (Little-endian move)
247
 */
248
 
249
/* 16-bit source, 16/32/64 destination */
250
 
251
#define ACPI_MOVE_16_TO_16(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
252
                                                                                 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];}
253
 
254
#define ACPI_MOVE_16_TO_32(d,s)         {(*(u32 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);}
255
#define ACPI_MOVE_16_TO_64(d,s)         {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_16_TO_16(d,s);}
256
 
257
/* 32-bit source, 16/32/64 destination */
258
 
259
#define ACPI_MOVE_32_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
260
 
261
#define ACPI_MOVE_32_TO_32(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
262
                                                                                 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
263
                                                                                 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
264
                                                                                 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];}
265
 
266
#define ACPI_MOVE_32_TO_64(d,s)         {(*(u64 *)(void *)(d)) = 0; ACPI_MOVE_32_TO_32(d,s);}
267
 
268
/* 64-bit source, 16/32/64 destination */
269
 
270
#define ACPI_MOVE_64_TO_16(d,s)         ACPI_MOVE_16_TO_16(d,s)    /* Truncate to 16 */
271
#define ACPI_MOVE_64_TO_32(d,s)         ACPI_MOVE_32_TO_32(d,s)    /* Truncate to 32 */
272
#define ACPI_MOVE_64_TO_64(d,s)         {((  u8 *)(void *)(d))[0] = ((u8 *)(void *)(s))[0];\
273
                                                                                 ((  u8 *)(void *)(d))[1] = ((u8 *)(void *)(s))[1];\
274
                                                                                 ((  u8 *)(void *)(d))[2] = ((u8 *)(void *)(s))[2];\
275
                                                                                 ((  u8 *)(void *)(d))[3] = ((u8 *)(void *)(s))[3];\
276
                                                                                 ((  u8 *)(void *)(d))[4] = ((u8 *)(void *)(s))[4];\
277
                                                                                 ((  u8 *)(void *)(d))[5] = ((u8 *)(void *)(s))[5];\
278
                                                                                 ((  u8 *)(void *)(d))[6] = ((u8 *)(void *)(s))[6];\
279
                                                                                 ((  u8 *)(void *)(d))[7] = ((u8 *)(void *)(s))[7];}
280
#endif
281
#endif
282
 
283
/* Macros based on machine integer width */
284
 
285
#if ACPI_MACHINE_WIDTH == 16
286
#define ACPI_MOVE_SIZE_TO_16(d,s)       ACPI_MOVE_16_TO_16(d,s)
287
 
288
#elif ACPI_MACHINE_WIDTH == 32
289
#define ACPI_MOVE_SIZE_TO_16(d,s)       ACPI_MOVE_32_TO_16(d,s)
290
 
291
#elif ACPI_MACHINE_WIDTH == 64
292
#define ACPI_MOVE_SIZE_TO_16(d,s)       ACPI_MOVE_64_TO_16(d,s)
293
 
294
#else
295
#error unknown ACPI_MACHINE_WIDTH
296
#endif
297
 
298
 
299
/*
300
 * Fast power-of-two math macros for non-optimized compilers
301
 */
302
 
303
#define _ACPI_DIV(value,power_of2)      ((u32) ((value) >> (power_of2)))
304
#define _ACPI_MUL(value,power_of2)      ((u32) ((value) << (power_of2)))
305
#define _ACPI_MOD(value,divisor)        ((u32) ((value) & ((divisor) -1)))
306
 
307
#define ACPI_DIV_2(a)                   _ACPI_DIV(a,1)
308
#define ACPI_MUL_2(a)                   _ACPI_MUL(a,1)
309
#define ACPI_MOD_2(a)                   _ACPI_MOD(a,2)
310
 
311
#define ACPI_DIV_4(a)                   _ACPI_DIV(a,2)
312
#define ACPI_MUL_4(a)                   _ACPI_MUL(a,2)
313
#define ACPI_MOD_4(a)                   _ACPI_MOD(a,4)
314
 
315
#define ACPI_DIV_8(a)                   _ACPI_DIV(a,3)
316
#define ACPI_MUL_8(a)                   _ACPI_MUL(a,3)
317
#define ACPI_MOD_8(a)                   _ACPI_MOD(a,8)
318
 
319
#define ACPI_DIV_16(a)                  _ACPI_DIV(a,4)
320
#define ACPI_MUL_16(a)                  _ACPI_MUL(a,4)
321
#define ACPI_MOD_16(a)                  _ACPI_MOD(a,16)
322
 
323
 
324
/*
325
 * Rounding macros (Power of two boundaries only)
326
 */
327
#define ACPI_ROUND_DOWN(value,boundary)      (((acpi_native_uint)(value)) & (~(((acpi_native_uint) boundary)-1)))
328
#define ACPI_ROUND_UP(value,boundary)        ((((acpi_native_uint)(value)) + (((acpi_native_uint) boundary)-1)) & (~(((acpi_native_uint) boundary)-1)))
329
 
330
#define ACPI_ROUND_DOWN_TO_32_BITS(a)        ACPI_ROUND_DOWN(a,4)
331
#define ACPI_ROUND_DOWN_TO_64_BITS(a)        ACPI_ROUND_DOWN(a,8)
332
#define ACPI_ROUND_DOWN_TO_NATIVE_WORD(a)    ACPI_ROUND_DOWN(a,ALIGNED_ADDRESS_BOUNDARY)
333
 
334
#define ACPI_ROUND_UP_to_32_bITS(a)          ACPI_ROUND_UP(a,4)
335
#define ACPI_ROUND_UP_to_64_bITS(a)          ACPI_ROUND_UP(a,8)
336
#define ACPI_ROUND_UP_TO_NATIVE_WORD(a)      ACPI_ROUND_UP(a,ALIGNED_ADDRESS_BOUNDARY)
337
 
338
 
339
#define ACPI_ROUND_BITS_UP_TO_BYTES(a)       ACPI_DIV_8((a) + 7)
340
#define ACPI_ROUND_BITS_DOWN_TO_BYTES(a)     ACPI_DIV_8((a))
341
 
342
#define ACPI_ROUND_UP_TO_1K(a)               (((a) + 1023) >> 10)
343
 
344
/* Generic (non-power-of-two) rounding */
345
 
346
#define ACPI_ROUND_UP_TO(value,boundary)     (((value) + ((boundary)-1)) / (boundary))
347
 
348
/*
349
 * Bitmask creation
350
 * Bit positions start at zero.
351
 * MASK_BITS_ABOVE creates a mask starting AT the position and above
352
 * MASK_BITS_BELOW creates a mask starting one bit BELOW the position
353
 */
354
#define ACPI_MASK_BITS_ABOVE(position)       (~((ACPI_INTEGER_MAX) << ((u32) (position))))
355
#define ACPI_MASK_BITS_BELOW(position)       ((ACPI_INTEGER_MAX) << ((u32) (position)))
356
 
357
#define ACPI_IS_OCTAL_DIGIT(d)               (((char)(d) >= '0') && ((char)(d) <= '7'))
358
 
359
/* Macros for GAS addressing */
360
 
361
#if ACPI_MACHINE_WIDTH != 16
362
 
363
#define ACPI_PCI_DEVICE(a)              (u16) ((ACPI_HIDWORD ((a))) & 0x0000FFFF)
364
#define ACPI_PCI_FUNCTION(a)            (u16) ((ACPI_LODWORD ((a))) >> 16)
365
#define ACPI_PCI_REGISTER(a)            (u16) ((ACPI_LODWORD ((a))) & 0x0000FFFF)
366
 
367
#else
368
 
369
/* No support for GAS and PCI IDs in 16-bit mode  */
370
 
371
#define ACPI_PCI_FUNCTION(a)            (u16) ((a) & 0xFFFF0000)
372
#define ACPI_PCI_DEVICE(a)              (u16) ((a) & 0x0000FFFF)
373
#define ACPI_PCI_REGISTER(a)            (u16) ((a) & 0x0000FFFF)
374
 
375
#endif
376
 
377
 
378
/* Bitfields within ACPI registers */
379
 
380
#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask)      ((val << pos) & mask)
381
#define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val)  reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
382
 
383
/*
384
 * An struct acpi_namespace_node * can appear in some contexts,
385
 * where a pointer to an union acpi_operand_object    can also
386
 * appear.  This macro is used to distinguish them.
387
 *
388
 * The "Descriptor" field is the first field in both structures.
389
 */
390
#define ACPI_GET_DESCRIPTOR_TYPE(d)     (((union acpi_descriptor *)(void *)(d))->descriptor_id)
391
#define ACPI_SET_DESCRIPTOR_TYPE(d,t)   (((union acpi_descriptor *)(void *)(d))->descriptor_id = t)
392
 
393
 
394
/* Macro to test the object type */
395
 
396
#define ACPI_GET_OBJECT_TYPE(d)         (((union acpi_operand_object *)(void *)(d))->common.type)
397
 
398
/* Macro to check the table flags for SINGLE or MULTIPLE tables are allowed */
399
 
400
#define ACPI_IS_SINGLE_TABLE(x)         (((x) & 0x01) == ACPI_TABLE_SINGLE ? 1 : 0)
401
 
402
/*
403
 * Macros for the master AML opcode table
404
 */
405
#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUG_OUTPUT)
406
#define ACPI_OP(name,Pargs,Iargs,obj_type,class,type,flags)    {name,(u32)(Pargs),(u32)(Iargs),(u32)(flags),obj_type,class,type}
407
#else
408
#define ACPI_OP(name,Pargs,Iargs,obj_type,class,type,flags)    {(u32)(Pargs),(u32)(Iargs),(u32)(flags),obj_type,class,type}
409
#endif
410
 
411
#ifdef ACPI_DISASSEMBLER
412
#define ACPI_DISASM_ONLY_MEMBERS(a)     a;
413
#else
414
#define ACPI_DISASM_ONLY_MEMBERS(a)
415
#endif
416
 
417
#define ARG_TYPE_WIDTH                  5
418
#define ARG_1(x)                        ((u32)(x))
419
#define ARG_2(x)                        ((u32)(x) << (1 * ARG_TYPE_WIDTH))
420
#define ARG_3(x)                        ((u32)(x) << (2 * ARG_TYPE_WIDTH))
421
#define ARG_4(x)                        ((u32)(x) << (3 * ARG_TYPE_WIDTH))
422
#define ARG_5(x)                        ((u32)(x) << (4 * ARG_TYPE_WIDTH))
423
#define ARG_6(x)                        ((u32)(x) << (5 * ARG_TYPE_WIDTH))
424
 
425
#define ARGI_LIST1(a)                   (ARG_1(a))
426
#define ARGI_LIST2(a,b)                 (ARG_1(b)|ARG_2(a))
427
#define ARGI_LIST3(a,b,c)               (ARG_1(c)|ARG_2(b)|ARG_3(a))
428
#define ARGI_LIST4(a,b,c,d)             (ARG_1(d)|ARG_2(c)|ARG_3(b)|ARG_4(a))
429
#define ARGI_LIST5(a,b,c,d,e)           (ARG_1(e)|ARG_2(d)|ARG_3(c)|ARG_4(b)|ARG_5(a))
430
#define ARGI_LIST6(a,b,c,d,e,f)         (ARG_1(f)|ARG_2(e)|ARG_3(d)|ARG_4(c)|ARG_5(b)|ARG_6(a))
431
 
432
#define ARGP_LIST1(a)                   (ARG_1(a))
433
#define ARGP_LIST2(a,b)                 (ARG_1(a)|ARG_2(b))
434
#define ARGP_LIST3(a,b,c)               (ARG_1(a)|ARG_2(b)|ARG_3(c))
435
#define ARGP_LIST4(a,b,c,d)             (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d))
436
#define ARGP_LIST5(a,b,c,d,e)           (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e))
437
#define ARGP_LIST6(a,b,c,d,e,f)         (ARG_1(a)|ARG_2(b)|ARG_3(c)|ARG_4(d)|ARG_5(e)|ARG_6(f))
438
 
439
#define GET_CURRENT_ARG_TYPE(list)      (list & ((u32) 0x1F))
440
#define INCREMENT_ARG_LIST(list)        (list >>= ((u32) ARG_TYPE_WIDTH))
441
 
442
 
443
/*
444
 * Reporting macros that are never compiled out
445
 */
446
 
447
#define ACPI_PARAM_LIST(pl)                 pl
448
 
449
/*
450
 * Error reporting.  These versions add callers module and line#.  Since
451
 * _THIS_MODULE gets compiled out when ACPI_DEBUG_OUTPUT isn't defined, only
452
 * use it in debug mode.
453
 */
454
 
455
#ifdef ACPI_DEBUG_OUTPUT
456
 
457
#define ACPI_REPORT_INFO(fp)                {acpi_ut_report_info(_THIS_MODULE,__LINE__,_COMPONENT); \
458
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
459
#define ACPI_REPORT_ERROR(fp)               {acpi_ut_report_error(_THIS_MODULE,__LINE__,_COMPONENT); \
460
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
461
#define ACPI_REPORT_WARNING(fp)             {acpi_ut_report_warning(_THIS_MODULE,__LINE__,_COMPONENT); \
462
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
463
#define ACPI_REPORT_NSERROR(s,e)            acpi_ns_report_error(_THIS_MODULE,__LINE__,_COMPONENT, s, e);
464
 
465
#define ACPI_REPORT_METHOD_ERROR(s,n,p,e)   acpi_ns_report_method_error(_THIS_MODULE,__LINE__,_COMPONENT, s, n, p, e);
466
 
467
#else
468
 
469
#define ACPI_REPORT_INFO(fp)                {acpi_ut_report_info("ACPI",__LINE__,_COMPONENT); \
470
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
471
#define ACPI_REPORT_ERROR(fp)               {acpi_ut_report_error("ACPI",__LINE__,_COMPONENT); \
472
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
473
#define ACPI_REPORT_WARNING(fp)             {acpi_ut_report_warning("ACPI",__LINE__,_COMPONENT); \
474
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
475
#define ACPI_REPORT_NSERROR(s,e)            acpi_ns_report_error("ACPI",__LINE__,_COMPONENT, s, e);
476
 
477
#define ACPI_REPORT_METHOD_ERROR(s,n,p,e)   acpi_ns_report_method_error("ACPI",__LINE__,_COMPONENT, s, n, p, e);
478
 
479
#endif
480
 
481
/* Error reporting.  These versions pass thru the module and line# */
482
 
483
#define _ACPI_REPORT_INFO(a,b,c,fp)         {acpi_ut_report_info(a,b,c); \
484
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
485
#define _ACPI_REPORT_ERROR(a,b,c,fp)        {acpi_ut_report_error(a,b,c); \
486
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
487
#define _ACPI_REPORT_WARNING(a,b,c,fp)      {acpi_ut_report_warning(a,b,c); \
488
                                                                                                acpi_os_printf ACPI_PARAM_LIST(fp);}
489
 
490
/*
491
 * Debug macros that are conditionally compiled
492
 */
493
 
494
#ifdef ACPI_DEBUG_OUTPUT
495
 
496
#define ACPI_MODULE_NAME(name)               static char ACPI_UNUSED_VAR *_THIS_MODULE = name;
497
 
498
/*
499
 * Function entry tracing.
500
 * The first parameter should be the procedure name as a quoted string.  This is declared
501
 * as a local string ("_proc_name) so that it can be also used by the function exit macros below.
502
 */
503
 
504
#define ACPI_FUNCTION_NAME(a)               struct acpi_debug_print_info _dbg; \
505
                                                                                                _dbg.component_id = _COMPONENT; \
506
                                                                                                _dbg.proc_name   = a; \
507
                                                                                                _dbg.module_name = _THIS_MODULE;
508
 
509
#define ACPI_FUNCTION_TRACE(a)              ACPI_FUNCTION_NAME(a) \
510
                                                                                                acpi_ut_trace(__LINE__,&_dbg)
511
#define ACPI_FUNCTION_TRACE_PTR(a,b)        ACPI_FUNCTION_NAME(a) \
512
                                                                                                acpi_ut_trace_ptr(__LINE__,&_dbg,(void *)b)
513
#define ACPI_FUNCTION_TRACE_U32(a,b)        ACPI_FUNCTION_NAME(a) \
514
                                                                                                acpi_ut_trace_u32(__LINE__,&_dbg,(u32)b)
515
#define ACPI_FUNCTION_TRACE_STR(a,b)        ACPI_FUNCTION_NAME(a) \
516
                                                                                                acpi_ut_trace_str(__LINE__,&_dbg,(char *)b)
517
 
518
#define ACPI_FUNCTION_ENTRY()               acpi_ut_track_stack_ptr()
519
 
520
/*
521
 * Function exit tracing.
522
 * WARNING: These macros include a return statement.  This is usually considered
523
 * bad form, but having a separate exit macro is very ugly and difficult to maintain.
524
 * One of the FUNCTION_TRACE macros above must be used in conjunction with these macros
525
 * so that "_proc_name" is defined.
526
 */
527
#ifdef ACPI_USE_DO_WHILE_0
528
#define ACPI_DO_WHILE0(a)               do a while(0)
529
#else
530
#define ACPI_DO_WHILE0(a)               a
531
#endif
532
 
533
#define return_VOID                     ACPI_DO_WHILE0 ({acpi_ut_exit(__LINE__,&_dbg);return;})
534
#define return_ACPI_STATUS(s)           ACPI_DO_WHILE0 ({acpi_ut_status_exit(__LINE__,&_dbg,(s));return((s));})
535
#define return_VALUE(s)                 ACPI_DO_WHILE0 ({acpi_ut_value_exit(__LINE__,&_dbg,(acpi_integer)(s));return((s));})
536
#define return_PTR(s)                   ACPI_DO_WHILE0 ({acpi_ut_ptr_exit(__LINE__,&_dbg,(u8 *)(s));return((s));})
537
 
538
/* Conditional execution */
539
 
540
#define ACPI_DEBUG_EXEC(a)              a
541
#define ACPI_NORMAL_EXEC(a)
542
 
543
#define ACPI_DEBUG_DEFINE(a)            a;
544
#define ACPI_DEBUG_ONLY_MEMBERS(a)      a;
545
#define _VERBOSE_STRUCTURES
546
 
547
 
548
/* Stack and buffer dumping */
549
 
550
#define ACPI_DUMP_STACK_ENTRY(a)        acpi_ex_dump_operand(a)
551
#define ACPI_DUMP_OPERANDS(a,b,c,d,e)   acpi_ex_dump_operands(a,b,c,d,e,_THIS_MODULE,__LINE__)
552
 
553
 
554
#define ACPI_DUMP_ENTRY(a,b)            acpi_ns_dump_entry (a,b)
555
#define ACPI_DUMP_TABLES(a,b)           acpi_ns_dump_tables(a,b)
556
#define ACPI_DUMP_PATHNAME(a,b,c,d)     acpi_ns_dump_pathname(a,b,c,d)
557
#define ACPI_DUMP_RESOURCE_LIST(a)      acpi_rs_dump_resource_list(a)
558
#define ACPI_DUMP_BUFFER(a,b)           acpi_ut_dump_buffer((u8 *)a,b,DB_BYTE_DISPLAY,_COMPONENT)
559
#define ACPI_BREAK_MSG(a)               acpi_os_signal (ACPI_SIGNAL_BREAKPOINT,(a))
560
 
561
 
562
/*
563
 * Generate INT3 on ACPI_ERROR (Debug only!)
564
 */
565
 
566
#define ACPI_ERROR_BREAK
567
#ifdef  ACPI_ERROR_BREAK
568
#define ACPI_BREAK_ON_ERROR(lvl)        if ((lvl)&ACPI_ERROR) \
569
                                                                                        acpi_os_signal(ACPI_SIGNAL_BREAKPOINT,"Fatal error encountered\n")
570
#else
571
#define ACPI_BREAK_ON_ERROR(lvl)
572
#endif
573
 
574
/*
575
 * Master debug print macros
576
 * Print iff:
577
 *    1) Debug print for the current component is enabled
578
 *    2) Debug error level or trace level for the print statement is enabled
579
 */
580
 
581
#define ACPI_DEBUG_PRINT(pl)            acpi_ut_debug_print ACPI_PARAM_LIST(pl)
582
#define ACPI_DEBUG_PRINT_RAW(pl)        acpi_ut_debug_print_raw ACPI_PARAM_LIST(pl)
583
 
584
 
585
#else
586
/*
587
 * This is the non-debug case -- make everything go away,
588
 * leaving no executable debug code!
589
 */
590
 
591
#define ACPI_MODULE_NAME(name)
592
#define _THIS_MODULE ""
593
 
594
#define ACPI_DEBUG_EXEC(a)
595
#define ACPI_NORMAL_EXEC(a)             a;
596
 
597
#define ACPI_DEBUG_DEFINE(a)
598
#define ACPI_DEBUG_ONLY_MEMBERS(a)
599
#define ACPI_FUNCTION_NAME(a)
600
#define ACPI_FUNCTION_TRACE(a)
601
#define ACPI_FUNCTION_TRACE_PTR(a,b)
602
#define ACPI_FUNCTION_TRACE_U32(a,b)
603
#define ACPI_FUNCTION_TRACE_STR(a,b)
604
#define ACPI_FUNCTION_EXIT
605
#define ACPI_FUNCTION_STATUS_EXIT(s)
606
#define ACPI_FUNCTION_VALUE_EXIT(s)
607
#define ACPI_FUNCTION_ENTRY()
608
#define ACPI_DUMP_STACK_ENTRY(a)
609
#define ACPI_DUMP_OPERANDS(a,b,c,d,e)
610
#define ACPI_DUMP_ENTRY(a,b)
611
#define ACPI_DUMP_TABLES(a,b)
612
#define ACPI_DUMP_PATHNAME(a,b,c,d)
613
#define ACPI_DUMP_RESOURCE_LIST(a)
614
#define ACPI_DUMP_BUFFER(a,b)
615
#define ACPI_DEBUG_PRINT(pl)
616
#define ACPI_DEBUG_PRINT_RAW(pl)
617
#define ACPI_BREAK_MSG(a)
618
 
619
#define return_VOID                     return
620
#define return_ACPI_STATUS(s)           return(s)
621
#define return_VALUE(s)                 return(s)
622
#define return_PTR(s)                   return(s)
623
 
624
#endif
625
 
626
/*
627
 * Some code only gets executed when the debugger is built in.
628
 * Note that this is entirely independent of whether the
629
 * DEBUG_PRINT stuff (set by ACPI_DEBUG_OUTPUT) is on, or not.
630
 */
631
#ifdef ACPI_DEBUGGER
632
#define ACPI_DEBUGGER_EXEC(a)           a
633
#else
634
#define ACPI_DEBUGGER_EXEC(a)
635
#endif
636
 
637
 
638
/*
639
 * For 16-bit code, we want to shrink some things even though
640
 * we are using ACPI_DEBUG_OUTPUT to get the debug output
641
 */
642
#if ACPI_MACHINE_WIDTH == 16
643
#undef ACPI_DEBUG_ONLY_MEMBERS
644
#undef _VERBOSE_STRUCTURES
645
#define ACPI_DEBUG_ONLY_MEMBERS(a)
646
#endif
647
 
648
 
649
#ifdef ACPI_DEBUG_OUTPUT
650
/*
651
 * 1) Set name to blanks
652
 * 2) Copy the object name
653
 */
654
#define ACPI_ADD_OBJECT_NAME(a,b)       ACPI_MEMSET (a->common.name, ' ', sizeof (a->common.name));\
655
                                                                                ACPI_STRNCPY (a->common.name, acpi_gbl_ns_type_names[b], sizeof (a->common.name))
656
#else
657
 
658
#define ACPI_ADD_OBJECT_NAME(a,b)
659
#endif
660
 
661
 
662
/*
663
 * Memory allocation tracking (DEBUG ONLY)
664
 */
665
 
666
#ifndef ACPI_DBG_TRACK_ALLOCATIONS
667
 
668
/* Memory allocation */
669
 
670
#define ACPI_MEM_ALLOCATE(a)            acpi_ut_allocate((acpi_size)(a),_COMPONENT,_THIS_MODULE,__LINE__)
671
#define ACPI_MEM_CALLOCATE(a)           acpi_ut_callocate((acpi_size)(a), _COMPONENT,_THIS_MODULE,__LINE__)
672
#define ACPI_MEM_FREE(a)                acpi_os_free(a)
673
#define ACPI_MEM_TRACKING(a)
674
 
675
 
676
#else
677
 
678
/* Memory allocation */
679
 
680
#define ACPI_MEM_ALLOCATE(a)            acpi_ut_allocate_and_track((acpi_size)(a),_COMPONENT,_THIS_MODULE,__LINE__)
681
#define ACPI_MEM_CALLOCATE(a)           acpi_ut_callocate_and_track((acpi_size)(a), _COMPONENT,_THIS_MODULE,__LINE__)
682
#define ACPI_MEM_FREE(a)                acpi_ut_free_and_track(a,_COMPONENT,_THIS_MODULE,__LINE__)
683
#define ACPI_MEM_TRACKING(a)            a
684
 
685
#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
686
 
687
 
688
#define ACPI_GET_STACK_POINTER          _asm {mov eax, ebx}
689
 
690
#endif /* ACMACROS_H */