OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [linux/] [linux-2.4/] [include/] [acpi/] [acmacros.h] - Blame information for rev 1765

Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.