actypes.h 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305
  1. /******************************************************************************
  2. *
  3. * Name: actypes.h - Common data types for the entire ACPI subsystem
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2017, Intel Corp.
  8. * All rights reserved.
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions, and the following disclaimer,
  15. * without modification.
  16. * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  17. * substantially similar to the "NO WARRANTY" disclaimer below
  18. * ("Disclaimer") and any redistribution must be conditioned upon
  19. * including a substantially similar Disclaimer requirement for further
  20. * binary redistribution.
  21. * 3. Neither the names of the above-listed copyright holders nor the names
  22. * of any contributors may be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * Alternatively, this software may be distributed under the terms of the
  26. * GNU General Public License ("GPL") version 2 as published by the Free
  27. * Software Foundation.
  28. *
  29. * NO WARRANTY
  30. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  31. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  32. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  33. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  34. * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  38. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  39. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40. * POSSIBILITY OF SUCH DAMAGES.
  41. */
  42. #ifndef __ACTYPES_H__
  43. #define __ACTYPES_H__
  44. /* acpisrc:struct_defs -- for acpisrc conversion */
  45. /*
  46. * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
  47. * header and must be either 32 or 64. 16-bit ACPICA is no longer
  48. * supported, as of 12/2006.
  49. */
  50. #ifndef ACPI_MACHINE_WIDTH
  51. #error ACPI_MACHINE_WIDTH not defined
  52. #endif
  53. /*
  54. * Data type ranges
  55. * Note: These macros are designed to be compiler independent as well as
  56. * working around problems that some 32-bit compilers have with 64-bit
  57. * constants.
  58. */
  59. #define ACPI_UINT8_MAX (u8) (~((u8) 0)) /* 0xFF */
  60. #define ACPI_UINT16_MAX (u16)(~((u16) 0)) /* 0xFFFF */
  61. #define ACPI_UINT32_MAX (u32)(~((u32) 0)) /* 0xFFFFFFFF */
  62. #define ACPI_UINT64_MAX (u64)(~((u64) 0)) /* 0xFFFFFFFFFFFFFFFF */
  63. #define ACPI_ASCII_MAX 0x7F
  64. /*
  65. * Architecture-specific ACPICA Subsystem Data Types
  66. *
  67. * The goal of these types is to provide source code portability across
  68. * 16-bit, 32-bit, and 64-bit targets.
  69. *
  70. * 1) The following types are of fixed size for all targets (16/32/64):
  71. *
  72. * u8 Logical boolean
  73. *
  74. * u8 8-bit (1 byte) unsigned value
  75. * u16 16-bit (2 byte) unsigned value
  76. * u32 32-bit (4 byte) unsigned value
  77. * u64 64-bit (8 byte) unsigned value
  78. *
  79. * s16 16-bit (2 byte) signed value
  80. * s32 32-bit (4 byte) signed value
  81. * s64 64-bit (8 byte) signed value
  82. *
  83. * COMPILER_DEPENDENT_UINT64/s64 - These types are defined in the
  84. * compiler-dependent header(s) and were introduced because there is no
  85. * common 64-bit integer type across the various compilation models, as
  86. * shown in the table below.
  87. *
  88. * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
  89. * char 8 8 8 8 8 8
  90. * short 16 16 16 16 16 16
  91. * _int32 32
  92. * int 32 64 32 32 16 16
  93. * long 64 64 32 32 32 32
  94. * long long 64 64
  95. * pointer 64 64 64 32 32 32
  96. *
  97. * Note: ILP64 and LP32 are currently not supported.
  98. *
  99. *
  100. * 2) These types represent the native word size of the target mode of the
  101. * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
  102. * usually used for memory allocation, efficient loop counters, and array
  103. * indexes. The types are similar to the size_t type in the C library and
  104. * are required because there is no C type that consistently represents the
  105. * native data width. acpi_size is needed because there is no guarantee
  106. * that a kernel-level C library is present.
  107. *
  108. * acpi_size 16/32/64-bit unsigned value
  109. * acpi_native_int 16/32/64-bit signed value
  110. */
  111. /*******************************************************************************
  112. *
  113. * Common types for all compilers, all targets
  114. *
  115. ******************************************************************************/
  116. #ifndef ACPI_USE_SYSTEM_INTTYPES
  117. typedef unsigned char u8;
  118. typedef unsigned short u16;
  119. typedef short s16;
  120. typedef COMPILER_DEPENDENT_UINT64 u64;
  121. typedef COMPILER_DEPENDENT_INT64 s64;
  122. #endif /* ACPI_USE_SYSTEM_INTTYPES */
  123. /*
  124. * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
  125. * across operating systems or even the various UNIX systems. Since ACPICA
  126. * only needs the thread ID as a unique thread identifier, we use a u64
  127. * as the only common data type - it will accommodate any type of pointer or
  128. * any type of integer. It is up to the host-dependent OSL to cast the
  129. * native thread ID type to a u64 (in acpi_os_get_thread_id).
  130. */
  131. #define acpi_thread_id u64
  132. /*******************************************************************************
  133. *
  134. * Types specific to 64-bit targets
  135. *
  136. ******************************************************************************/
  137. #if ACPI_MACHINE_WIDTH == 64
  138. #ifndef ACPI_USE_SYSTEM_INTTYPES
  139. typedef unsigned int u32;
  140. typedef int s32;
  141. #endif /* ACPI_USE_SYSTEM_INTTYPES */
  142. typedef s64 acpi_native_int;
  143. typedef u64 acpi_size;
  144. typedef u64 acpi_io_address;
  145. typedef u64 acpi_physical_address;
  146. #define ACPI_MAX_PTR ACPI_UINT64_MAX
  147. #define ACPI_SIZE_MAX ACPI_UINT64_MAX
  148. #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
  149. /*
  150. * In the case of the Itanium Processor Family (IPF), the hardware does not
  151. * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
  152. * flag to indicate that special precautions must be taken to avoid alignment
  153. * faults. (IA64 or ia64 is currently used by existing compilers to indicate
  154. * IPF.)
  155. *
  156. * Note: EM64T and other X86-64 processors support misaligned transfers,
  157. * so there is no need to define this flag.
  158. */
  159. #if defined (__IA64__) || defined (__ia64__)
  160. #define ACPI_MISALIGNMENT_NOT_SUPPORTED
  161. #endif
  162. /*******************************************************************************
  163. *
  164. * Types specific to 32-bit targets
  165. *
  166. ******************************************************************************/
  167. #elif ACPI_MACHINE_WIDTH == 32
  168. #ifndef ACPI_USE_SYSTEM_INTTYPES
  169. typedef unsigned int u32;
  170. typedef int s32;
  171. #endif /* ACPI_USE_SYSTEM_INTTYPES */
  172. typedef s32 acpi_native_int;
  173. typedef u32 acpi_size;
  174. #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
  175. /*
  176. * OSPMs can define this to shrink the size of the structures for 32-bit
  177. * none PAE environment. ASL compiler may always define this to generate
  178. * 32-bit OSPM compliant tables.
  179. */
  180. typedef u32 acpi_io_address;
  181. typedef u32 acpi_physical_address;
  182. #else /* ACPI_32BIT_PHYSICAL_ADDRESS */
  183. /*
  184. * It is reported that, after some calculations, the physical addresses can
  185. * wrap over the 32-bit boundary on 32-bit PAE environment.
  186. * https://bugzilla.kernel.org/show_bug.cgi?id=87971
  187. */
  188. typedef u64 acpi_io_address;
  189. typedef u64 acpi_physical_address;
  190. #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */
  191. #define ACPI_MAX_PTR ACPI_UINT32_MAX
  192. #define ACPI_SIZE_MAX ACPI_UINT32_MAX
  193. #else
  194. /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
  195. #error unknown ACPI_MACHINE_WIDTH
  196. #endif
  197. /*******************************************************************************
  198. *
  199. * OS-dependent types
  200. *
  201. * If the defaults below are not appropriate for the host system, they can
  202. * be defined in the OS-specific header, and this will take precedence.
  203. *
  204. ******************************************************************************/
  205. /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
  206. #ifndef acpi_cpu_flags
  207. #define acpi_cpu_flags acpi_size
  208. #endif
  209. /* Object returned from acpi_os_create_cache */
  210. #ifndef acpi_cache_t
  211. #ifdef ACPI_USE_LOCAL_CACHE
  212. #define acpi_cache_t struct acpi_memory_list
  213. #else
  214. #define acpi_cache_t void *
  215. #endif
  216. #endif
  217. /*
  218. * Synchronization objects - Mutexes, Semaphores, and spin_locks
  219. */
  220. #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
  221. /*
  222. * These macros are used if the host OS does not support a mutex object.
  223. * Map the OSL Mutex interfaces to binary semaphores.
  224. */
  225. #define acpi_mutex acpi_semaphore
  226. #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
  227. #define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
  228. #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
  229. #define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
  230. #endif
  231. /* Configurable types for synchronization objects */
  232. #ifndef acpi_spinlock
  233. #define acpi_spinlock void *
  234. #endif
  235. #ifndef acpi_semaphore
  236. #define acpi_semaphore void *
  237. #endif
  238. #ifndef acpi_mutex
  239. #define acpi_mutex void *
  240. #endif
  241. /*******************************************************************************
  242. *
  243. * Compiler-dependent types
  244. *
  245. * If the defaults below are not appropriate for the host compiler, they can
  246. * be defined in the compiler-specific header, and this will take precedence.
  247. *
  248. ******************************************************************************/
  249. /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
  250. #ifndef acpi_uintptr_t
  251. #define acpi_uintptr_t void *
  252. #endif
  253. /*
  254. * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
  255. * some compilers can catch printf format string problems
  256. */
  257. #ifndef ACPI_PRINTF_LIKE
  258. #define ACPI_PRINTF_LIKE(c)
  259. #endif
  260. /*
  261. * Some compilers complain about unused variables. Sometimes we don't want
  262. * to use all the variables (for example, _acpi_module_name). This allows us
  263. * to tell the compiler in a per-variable manner that a variable
  264. * is unused
  265. */
  266. #ifndef ACPI_UNUSED_VAR
  267. #define ACPI_UNUSED_VAR
  268. #endif
  269. /*
  270. * All ACPICA external functions that are available to the rest of the
  271. * kernel are tagged with these macros which can be defined as appropriate
  272. * for the host.
  273. *
  274. * Notes:
  275. * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
  276. * interfaces that may need special processing.
  277. * ACPI_EXPORT_SYMBOL is used for all other public external functions.
  278. */
  279. #ifndef ACPI_EXPORT_SYMBOL_INIT
  280. #define ACPI_EXPORT_SYMBOL_INIT(symbol)
  281. #endif
  282. #ifndef ACPI_EXPORT_SYMBOL
  283. #define ACPI_EXPORT_SYMBOL(symbol)
  284. #endif
  285. /*
  286. * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
  287. * utilities only.
  288. */
  289. #ifndef ACPI_DEBUG_INITIALIZE
  290. #define ACPI_DEBUG_INITIALIZE()
  291. #endif
  292. /*******************************************************************************
  293. *
  294. * Configuration
  295. *
  296. ******************************************************************************/
  297. #ifdef ACPI_NO_MEM_ALLOCATIONS
  298. #define ACPI_ALLOCATE(a) NULL
  299. #define ACPI_ALLOCATE_ZEROED(a) NULL
  300. #define ACPI_FREE(a)
  301. #define ACPI_MEM_TRACKING(a)
  302. #else /* ACPI_NO_MEM_ALLOCATIONS */
  303. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  304. /*
  305. * Memory allocation tracking (used by acpi_exec to detect memory leaks)
  306. */
  307. #define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__
  308. #define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
  309. #define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
  310. #define ACPI_FREE(a) acpi_ut_free_and_track (a, ACPI_MEM_PARAMETERS)
  311. #define ACPI_MEM_TRACKING(a) a
  312. #else
  313. /*
  314. * Normal memory allocation directly via the OS services layer
  315. */
  316. #define ACPI_ALLOCATE(a) acpi_os_allocate ((acpi_size) (a))
  317. #define ACPI_ALLOCATE_ZEROED(a) acpi_os_allocate_zeroed ((acpi_size) (a))
  318. #define ACPI_FREE(a) acpi_os_free (a)
  319. #define ACPI_MEM_TRACKING(a)
  320. #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
  321. #endif /* ACPI_NO_MEM_ALLOCATIONS */
  322. /******************************************************************************
  323. *
  324. * ACPI Specification constants (Do not change unless the specification
  325. * changes)
  326. *
  327. *****************************************************************************/
  328. /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
  329. #define ACPI_MAX_GPE_BLOCKS 2
  330. /* Default ACPI register widths */
  331. #define ACPI_GPE_REGISTER_WIDTH 8
  332. #define ACPI_PM1_REGISTER_WIDTH 16
  333. #define ACPI_PM2_REGISTER_WIDTH 8
  334. #define ACPI_PM_TIMER_WIDTH 32
  335. #define ACPI_RESET_REGISTER_WIDTH 8
  336. /* Names within the namespace are 4 bytes long */
  337. #define ACPI_NAME_SIZE 4
  338. #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
  339. #define ACPI_PATH_SEPARATOR '.'
  340. /* Sizes for ACPI table headers */
  341. #define ACPI_OEM_ID_SIZE 6
  342. #define ACPI_OEM_TABLE_ID_SIZE 8
  343. /* ACPI/PNP hardware IDs */
  344. #define PCI_ROOT_HID_STRING "PNP0A03"
  345. #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
  346. /* PM Timer ticks per second (HZ) */
  347. #define ACPI_PM_TIMER_FREQUENCY 3579545
  348. /*******************************************************************************
  349. *
  350. * Independent types
  351. *
  352. ******************************************************************************/
  353. /* Logical defines and NULL */
  354. #ifdef FALSE
  355. #undef FALSE
  356. #endif
  357. #define FALSE (1 == 0)
  358. #ifdef TRUE
  359. #undef TRUE
  360. #endif
  361. #define TRUE (1 == 1)
  362. #ifndef NULL
  363. #define NULL (void *) 0
  364. #endif
  365. /*
  366. * Miscellaneous types
  367. */
  368. typedef u32 acpi_status; /* All ACPI Exceptions */
  369. typedef u32 acpi_name; /* 4-byte ACPI name */
  370. typedef char *acpi_string; /* Null terminated ASCII string */
  371. typedef void *acpi_handle; /* Actually a ptr to a NS Node */
  372. /* Time constants for timer calculations */
  373. #define ACPI_MSEC_PER_SEC 1000L
  374. #define ACPI_USEC_PER_MSEC 1000L
  375. #define ACPI_USEC_PER_SEC 1000000L
  376. #define ACPI_100NSEC_PER_USEC 10L
  377. #define ACPI_100NSEC_PER_MSEC 10000L
  378. #define ACPI_100NSEC_PER_SEC 10000000L
  379. #define ACPI_NSEC_PER_USEC 1000L
  380. #define ACPI_NSEC_PER_MSEC 1000000L
  381. #define ACPI_NSEC_PER_SEC 1000000000L
  382. /* Owner IDs are used to track namespace nodes for selective deletion */
  383. typedef u8 acpi_owner_id;
  384. #define ACPI_OWNER_ID_MAX 0xFF
  385. #define ACPI_INTEGER_BIT_SIZE 64
  386. #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
  387. #define ACPI_MAX64_DECIMAL_DIGITS 20
  388. #define ACPI_MAX32_DECIMAL_DIGITS 10
  389. #define ACPI_MAX16_DECIMAL_DIGITS 5
  390. #define ACPI_MAX8_DECIMAL_DIGITS 3
  391. /*
  392. * Constants with special meanings
  393. */
  394. #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
  395. #define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
  396. #define ACPI_DO_NOT_WAIT 0
  397. /*
  398. * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
  399. * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
  400. * Note that this pertains to the ACPI integer type only, not to other
  401. * integers used in the implementation of the ACPICA subsystem.
  402. *
  403. * 01/2010: This type is obsolete and has been removed from the entire ACPICA
  404. * code base. It remains here for compatibility with device drivers that use
  405. * the type. However, it will be removed in the future.
  406. */
  407. typedef u64 acpi_integer;
  408. #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
  409. /*******************************************************************************
  410. *
  411. * Commonly used macros
  412. *
  413. ******************************************************************************/
  414. /* Data manipulation */
  415. #define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
  416. #define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
  417. #define ACPI_LOWORD(integer) ((u16) (u32)(integer))
  418. #define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
  419. #define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
  420. #define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
  421. #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
  422. #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
  423. #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
  424. #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
  425. /* Size calculation */
  426. #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
  427. /* Pointer manipulation */
  428. #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
  429. #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
  430. #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
  431. #define ACPI_SUB_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) - (acpi_size)(b)))
  432. #define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
  433. /* Pointer/Integer type conversions */
  434. #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
  435. #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
  436. #define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) NULL)
  437. #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
  438. #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
  439. /* Optimizations for 4-character (32-bit) acpi_name manipulation */
  440. #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
  441. #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
  442. #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
  443. #else
  444. #define ACPI_COMPARE_NAME(a,b) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
  445. #define ACPI_MOVE_NAME(dest,src) (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
  446. #endif
  447. /* Support for the special RSDP signature (8 characters) */
  448. #define ACPI_VALIDATE_RSDP_SIG(a) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
  449. #define ACPI_MAKE_RSDP_SIG(dest) (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
  450. /*
  451. * Algorithm to obtain access bit width.
  452. * Can be used with access_width of struct acpi_generic_address and access_size of
  453. * struct acpi_resource_generic_register.
  454. */
  455. #define ACPI_ACCESS_BIT_WIDTH(size) (1 << ((size) + 2))
  456. /*******************************************************************************
  457. *
  458. * Miscellaneous constants
  459. *
  460. ******************************************************************************/
  461. /*
  462. * Initialization sequence
  463. */
  464. #define ACPI_FULL_INITIALIZATION 0x00
  465. #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
  466. #define ACPI_NO_HARDWARE_INIT 0x02
  467. #define ACPI_NO_EVENT_INIT 0x04
  468. #define ACPI_NO_HANDLER_INIT 0x08
  469. #define ACPI_NO_ACPI_ENABLE 0x10
  470. #define ACPI_NO_DEVICE_INIT 0x20
  471. #define ACPI_NO_OBJECT_INIT 0x40
  472. #define ACPI_NO_FACS_INIT 0x80
  473. /*
  474. * Initialization state
  475. */
  476. #define ACPI_SUBSYSTEM_INITIALIZE 0x01
  477. #define ACPI_INITIALIZED_OK 0x02
  478. /*
  479. * Power state values
  480. */
  481. #define ACPI_STATE_UNKNOWN (u8) 0xFF
  482. #define ACPI_STATE_S0 (u8) 0
  483. #define ACPI_STATE_S1 (u8) 1
  484. #define ACPI_STATE_S2 (u8) 2
  485. #define ACPI_STATE_S3 (u8) 3
  486. #define ACPI_STATE_S4 (u8) 4
  487. #define ACPI_STATE_S5 (u8) 5
  488. #define ACPI_S_STATES_MAX ACPI_STATE_S5
  489. #define ACPI_S_STATE_COUNT 6
  490. #define ACPI_STATE_D0 (u8) 0
  491. #define ACPI_STATE_D1 (u8) 1
  492. #define ACPI_STATE_D2 (u8) 2
  493. #define ACPI_STATE_D3_HOT (u8) 3
  494. #define ACPI_STATE_D3 (u8) 4
  495. #define ACPI_STATE_D3_COLD ACPI_STATE_D3
  496. #define ACPI_D_STATES_MAX ACPI_STATE_D3
  497. #define ACPI_D_STATE_COUNT 5
  498. #define ACPI_STATE_C0 (u8) 0
  499. #define ACPI_STATE_C1 (u8) 1
  500. #define ACPI_STATE_C2 (u8) 2
  501. #define ACPI_STATE_C3 (u8) 3
  502. #define ACPI_C_STATES_MAX ACPI_STATE_C3
  503. #define ACPI_C_STATE_COUNT 4
  504. /*
  505. * Sleep type invalid value
  506. */
  507. #define ACPI_SLEEP_TYPE_MAX 0x7
  508. #define ACPI_SLEEP_TYPE_INVALID 0xFF
  509. /*
  510. * Standard notify values
  511. */
  512. #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
  513. #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
  514. #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
  515. #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
  516. #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
  517. #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
  518. #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
  519. #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
  520. #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
  521. #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
  522. #define ACPI_NOTIFY_RESERVED (u8) 0x0A
  523. #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
  524. #define ACPI_NOTIFY_SHUTDOWN_REQUEST (u8) 0x0C
  525. #define ACPI_NOTIFY_AFFINITY_UPDATE (u8) 0x0D
  526. #define ACPI_NOTIFY_MEMORY_UPDATE (u8) 0x0E
  527. #define ACPI_GENERIC_NOTIFY_MAX 0x0E
  528. #define ACPI_SPECIFIC_NOTIFY_MAX 0x84
  529. /*
  530. * Types associated with ACPI names and objects. The first group of
  531. * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
  532. * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
  533. * only add to the first group if the spec changes.
  534. *
  535. * NOTE: Types must be kept in sync with the global acpi_ns_properties
  536. * and acpi_ns_type_names arrays.
  537. */
  538. typedef u32 acpi_object_type;
  539. #define ACPI_TYPE_ANY 0x00
  540. #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
  541. #define ACPI_TYPE_STRING 0x02
  542. #define ACPI_TYPE_BUFFER 0x03
  543. #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
  544. #define ACPI_TYPE_FIELD_UNIT 0x05
  545. #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
  546. #define ACPI_TYPE_EVENT 0x07
  547. #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
  548. #define ACPI_TYPE_MUTEX 0x09
  549. #define ACPI_TYPE_REGION 0x0A
  550. #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
  551. #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
  552. #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
  553. #define ACPI_TYPE_BUFFER_FIELD 0x0E
  554. #define ACPI_TYPE_DDB_HANDLE 0x0F
  555. #define ACPI_TYPE_DEBUG_OBJECT 0x10
  556. #define ACPI_TYPE_EXTERNAL_MAX 0x10
  557. #define ACPI_NUM_TYPES (ACPI_TYPE_EXTERNAL_MAX + 1)
  558. /*
  559. * These are object types that do not map directly to the ACPI
  560. * object_type() operator. They are used for various internal purposes
  561. * only. If new predefined ACPI_TYPEs are added (via the ACPI
  562. * specification), these internal types must move upwards. (There
  563. * is code that depends on these values being contiguous with the
  564. * external types above.)
  565. */
  566. #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
  567. #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
  568. #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
  569. #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
  570. #define ACPI_TYPE_LOCAL_ALIAS 0x15
  571. #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
  572. #define ACPI_TYPE_LOCAL_NOTIFY 0x17
  573. #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
  574. #define ACPI_TYPE_LOCAL_RESOURCE 0x19
  575. #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
  576. #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
  577. #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
  578. #define ACPI_TOTAL_TYPES (ACPI_TYPE_NS_NODE_MAX + 1)
  579. /*
  580. * These are special object types that never appear in
  581. * a Namespace node, only in an object of union acpi_operand_object
  582. */
  583. #define ACPI_TYPE_LOCAL_EXTRA 0x1C
  584. #define ACPI_TYPE_LOCAL_DATA 0x1D
  585. #define ACPI_TYPE_LOCAL_MAX 0x1D
  586. /* All types above here are invalid */
  587. #define ACPI_TYPE_INVALID 0x1E
  588. #define ACPI_TYPE_NOT_FOUND 0xFF
  589. #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
  590. /*
  591. * All I/O
  592. */
  593. #define ACPI_READ 0
  594. #define ACPI_WRITE 1
  595. #define ACPI_IO_MASK 1
  596. /*
  597. * Event Types: Fixed & General Purpose
  598. */
  599. typedef u32 acpi_event_type;
  600. /*
  601. * Fixed events
  602. */
  603. #define ACPI_EVENT_PMTIMER 0
  604. #define ACPI_EVENT_GLOBAL 1
  605. #define ACPI_EVENT_POWER_BUTTON 2
  606. #define ACPI_EVENT_SLEEP_BUTTON 3
  607. #define ACPI_EVENT_RTC 4
  608. #define ACPI_EVENT_MAX 4
  609. #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
  610. /*
  611. * Event status - Per event
  612. * -------------
  613. * The encoding of acpi_event_status is illustrated below.
  614. * Note that a set bit (1) indicates the property is TRUE
  615. * (e.g. if bit 0 is set then the event is enabled).
  616. * +-------------+-+-+-+-+-+-+
  617. * | Bits 31:6 |5|4|3|2|1|0|
  618. * +-------------+-+-+-+-+-+-+
  619. * | | | | | | |
  620. * | | | | | | +- Enabled?
  621. * | | | | | +--- Enabled for wake?
  622. * | | | | +----- Status bit set?
  623. * | | | +------- Enable bit set?
  624. * | | +--------- Has a handler?
  625. * | +----------- Masked?
  626. * +----------------- <Reserved>
  627. */
  628. typedef u32 acpi_event_status;
  629. #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
  630. #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
  631. #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
  632. #define ACPI_EVENT_FLAG_STATUS_SET (acpi_event_status) 0x04
  633. #define ACPI_EVENT_FLAG_ENABLE_SET (acpi_event_status) 0x08
  634. #define ACPI_EVENT_FLAG_HAS_HANDLER (acpi_event_status) 0x10
  635. #define ACPI_EVENT_FLAG_MASKED (acpi_event_status) 0x20
  636. #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET
  637. /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
  638. #define ACPI_GPE_ENABLE 0
  639. #define ACPI_GPE_DISABLE 1
  640. #define ACPI_GPE_CONDITIONAL_ENABLE 2
  641. /*
  642. * GPE info flags - Per GPE
  643. * +---+-+-+-+---+
  644. * |7:6|5|4|3|2:0|
  645. * +---+-+-+-+---+
  646. * | | | | |
  647. * | | | | +-- Type of dispatch:to method, handler, notify, or none
  648. * | | | +----- Interrupt type: edge or level triggered
  649. * | | +------- Is a Wake GPE
  650. * | +--------- Is GPE masked by the software GPE masking mechanism
  651. * +------------ <Reserved>
  652. */
  653. #define ACPI_GPE_DISPATCH_NONE (u8) 0x00
  654. #define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
  655. #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
  656. #define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
  657. #define ACPI_GPE_DISPATCH_RAW_HANDLER (u8) 0x04
  658. #define ACPI_GPE_DISPATCH_MASK (u8) 0x07
  659. #define ACPI_GPE_DISPATCH_TYPE(flags) ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK))
  660. #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x08
  661. #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
  662. #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x08
  663. #define ACPI_GPE_CAN_WAKE (u8) 0x10
  664. /*
  665. * Flags for GPE and Lock interfaces
  666. */
  667. #define ACPI_NOT_ISR 0x1
  668. #define ACPI_ISR 0x0
  669. /* Notify types */
  670. #define ACPI_SYSTEM_NOTIFY 0x1
  671. #define ACPI_DEVICE_NOTIFY 0x2
  672. #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
  673. #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
  674. #define ACPI_NUM_NOTIFY_TYPES 2
  675. #define ACPI_MAX_SYS_NOTIFY 0x7F
  676. #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
  677. #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
  678. #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
  679. /* Address Space (Operation Region) Types */
  680. typedef u8 acpi_adr_space_type;
  681. #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
  682. #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
  683. #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
  684. #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
  685. #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
  686. #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
  687. #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
  688. #define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
  689. #define ACPI_ADR_SPACE_GPIO (acpi_adr_space_type) 8
  690. #define ACPI_ADR_SPACE_GSBUS (acpi_adr_space_type) 9
  691. #define ACPI_ADR_SPACE_PLATFORM_COMM (acpi_adr_space_type) 10
  692. #define ACPI_NUM_PREDEFINED_REGIONS 11
  693. /*
  694. * Special Address Spaces
  695. *
  696. * Note: A Data Table region is a special type of operation region
  697. * that has its own AML opcode. However, internally, the AML
  698. * interpreter simply creates an operation region with an an address
  699. * space type of ACPI_ADR_SPACE_DATA_TABLE.
  700. */
  701. #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */
  702. #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F
  703. /* Values for _REG connection code */
  704. #define ACPI_REG_DISCONNECT 0
  705. #define ACPI_REG_CONNECT 1
  706. /*
  707. * bit_register IDs
  708. *
  709. * These values are intended to be used by the hardware interfaces
  710. * and are mapped to individual bitfields defined within the ACPI
  711. * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
  712. * for this mapping.
  713. */
  714. /* PM1 Status register */
  715. #define ACPI_BITREG_TIMER_STATUS 0x00
  716. #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
  717. #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
  718. #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
  719. #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
  720. #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
  721. #define ACPI_BITREG_WAKE_STATUS 0x06
  722. #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
  723. /* PM1 Enable register */
  724. #define ACPI_BITREG_TIMER_ENABLE 0x08
  725. #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
  726. #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
  727. #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
  728. #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
  729. #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
  730. /* PM1 Control register */
  731. #define ACPI_BITREG_SCI_ENABLE 0x0E
  732. #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
  733. #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
  734. #define ACPI_BITREG_SLEEP_TYPE 0x11
  735. #define ACPI_BITREG_SLEEP_ENABLE 0x12
  736. /* PM2 Control register */
  737. #define ACPI_BITREG_ARB_DISABLE 0x13
  738. #define ACPI_BITREG_MAX 0x13
  739. #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
  740. /* Status register values. A 1 clears a status bit. 0 = no effect */
  741. #define ACPI_CLEAR_STATUS 1
  742. /* Enable and Control register values */
  743. #define ACPI_ENABLE_EVENT 1
  744. #define ACPI_DISABLE_EVENT 0
  745. /* Sleep function dispatch */
  746. typedef acpi_status (*acpi_sleep_function) (u8 sleep_state);
  747. struct acpi_sleep_functions {
  748. acpi_sleep_function legacy_function;
  749. acpi_sleep_function extended_function;
  750. };
  751. /*
  752. * External ACPI object definition
  753. */
  754. /*
  755. * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
  756. * element or an unresolved named reference.
  757. */
  758. union acpi_object {
  759. acpi_object_type type; /* See definition of acpi_ns_type for values */
  760. struct {
  761. acpi_object_type type; /* ACPI_TYPE_INTEGER */
  762. u64 value; /* The actual number */
  763. } integer;
  764. struct {
  765. acpi_object_type type; /* ACPI_TYPE_STRING */
  766. u32 length; /* # of bytes in string, excluding trailing null */
  767. char *pointer; /* points to the string value */
  768. } string;
  769. struct {
  770. acpi_object_type type; /* ACPI_TYPE_BUFFER */
  771. u32 length; /* # of bytes in buffer */
  772. u8 *pointer; /* points to the buffer */
  773. } buffer;
  774. struct {
  775. acpi_object_type type; /* ACPI_TYPE_PACKAGE */
  776. u32 count; /* # of elements in package */
  777. union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
  778. } package;
  779. struct {
  780. acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
  781. acpi_object_type actual_type; /* Type associated with the Handle */
  782. acpi_handle handle; /* object reference */
  783. } reference;
  784. struct {
  785. acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
  786. u32 proc_id;
  787. acpi_io_address pblk_address;
  788. u32 pblk_length;
  789. } processor;
  790. struct {
  791. acpi_object_type type; /* ACPI_TYPE_POWER */
  792. u32 system_level;
  793. u32 resource_order;
  794. } power_resource;
  795. };
  796. /*
  797. * List of objects, used as a parameter list for control method evaluation
  798. */
  799. struct acpi_object_list {
  800. u32 count;
  801. union acpi_object *pointer;
  802. };
  803. /*
  804. * Miscellaneous common Data Structures used by the interfaces
  805. */
  806. #define ACPI_NO_BUFFER 0
  807. #ifdef ACPI_NO_MEM_ALLOCATIONS
  808. #define ACPI_ALLOCATE_BUFFER (acpi_size) (0)
  809. #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (0)
  810. #else /* ACPI_NO_MEM_ALLOCATIONS */
  811. #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1) /* Let ACPICA allocate buffer */
  812. #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2) /* For internal use only (enables tracking) */
  813. #endif /* ACPI_NO_MEM_ALLOCATIONS */
  814. struct acpi_buffer {
  815. acpi_size length; /* Length in bytes of the buffer */
  816. void *pointer; /* pointer to buffer */
  817. };
  818. /*
  819. * name_type for acpi_get_name
  820. */
  821. #define ACPI_FULL_PATHNAME 0
  822. #define ACPI_SINGLE_NAME 1
  823. #define ACPI_FULL_PATHNAME_NO_TRAILING 2
  824. #define ACPI_NAME_TYPE_MAX 2
  825. /*
  826. * Predefined Namespace items
  827. */
  828. struct acpi_predefined_names {
  829. const char *name;
  830. u8 type;
  831. char *val;
  832. };
  833. /*
  834. * Structure and flags for acpi_get_system_info
  835. */
  836. #define ACPI_SYS_MODE_UNKNOWN 0x0000
  837. #define ACPI_SYS_MODE_ACPI 0x0001
  838. #define ACPI_SYS_MODE_LEGACY 0x0002
  839. #define ACPI_SYS_MODES_MASK 0x0003
  840. /*
  841. * System info returned by acpi_get_system_info()
  842. */
  843. struct acpi_system_info {
  844. u32 acpi_ca_version;
  845. u32 flags;
  846. u32 timer_resolution;
  847. u32 reserved1;
  848. u32 reserved2;
  849. u32 debug_level;
  850. u32 debug_layer;
  851. };
  852. /*
  853. * System statistics returned by acpi_get_statistics()
  854. */
  855. struct acpi_statistics {
  856. u32 sci_count;
  857. u32 gpe_count;
  858. u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS];
  859. u32 method_count;
  860. };
  861. /*
  862. * Types specific to the OS service interfaces
  863. */
  864. typedef u32
  865. (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
  866. typedef void
  867. (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
  868. /*
  869. * Various handlers and callback procedures
  870. */
  871. typedef
  872. u32 (*acpi_sci_handler) (void *context);
  873. typedef
  874. void (*acpi_gbl_event_handler) (u32 event_type,
  875. acpi_handle device,
  876. u32 event_number, void *context);
  877. #define ACPI_EVENT_TYPE_GPE 0
  878. #define ACPI_EVENT_TYPE_FIXED 1
  879. typedef
  880. u32(*acpi_event_handler) (void *context);
  881. typedef
  882. u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
  883. typedef
  884. void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
  885. typedef
  886. void (*acpi_object_handler) (acpi_handle object, void *data);
  887. typedef
  888. acpi_status (*acpi_init_handler) (acpi_handle object, u32 function);
  889. #define ACPI_INIT_DEVICE_INI 1
  890. typedef
  891. acpi_status (*acpi_exception_handler) (acpi_status aml_status,
  892. acpi_name name,
  893. u16 opcode,
  894. u32 aml_offset, void *context);
  895. /* Table Event handler (Load, load_table, etc.) and types */
  896. typedef
  897. acpi_status (*acpi_table_handler) (u32 event, void *table, void *context);
  898. /* Table Event Types */
  899. #define ACPI_TABLE_EVENT_LOAD 0x0
  900. #define ACPI_TABLE_EVENT_UNLOAD 0x1
  901. #define ACPI_TABLE_EVENT_INSTALL 0x2
  902. #define ACPI_TABLE_EVENT_UNINSTALL 0x3
  903. #define ACPI_NUM_TABLE_EVENTS 4
  904. /* Address Spaces (For Operation Regions) */
  905. typedef
  906. acpi_status (*acpi_adr_space_handler) (u32 function,
  907. acpi_physical_address address,
  908. u32 bit_width,
  909. u64 *value,
  910. void *handler_context,
  911. void *region_context);
  912. #define ACPI_DEFAULT_HANDLER NULL
  913. /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
  914. struct acpi_connection_info {
  915. u8 *connection;
  916. u16 length;
  917. u8 access_length;
  918. };
  919. typedef
  920. acpi_status (*acpi_adr_space_setup) (acpi_handle region_handle,
  921. u32 function,
  922. void *handler_context,
  923. void **region_context);
  924. #define ACPI_REGION_ACTIVATE 0
  925. #define ACPI_REGION_DEACTIVATE 1
  926. typedef
  927. acpi_status (*acpi_walk_callback) (acpi_handle object,
  928. u32 nesting_level,
  929. void *context, void **return_value);
  930. typedef
  931. u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
  932. /* Interrupt handler return values */
  933. #define ACPI_INTERRUPT_NOT_HANDLED 0x00
  934. #define ACPI_INTERRUPT_HANDLED 0x01
  935. /* GPE handler return values */
  936. #define ACPI_REENABLE_GPE 0x80
  937. /* Length of 32-bit EISAID values when converted back to a string */
  938. #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
  939. /* Length of UUID (string) values */
  940. #define ACPI_UUID_LENGTH 16
  941. /* Length of 3-byte PCI class code values when converted back to a string */
  942. #define ACPI_PCICLS_STRING_SIZE 7 /* Includes null terminator */
  943. /* Structures used for device/processor HID, UID, CID */
  944. struct acpi_pnp_device_id {
  945. u32 length; /* Length of string + null */
  946. char *string;
  947. };
  948. struct acpi_pnp_device_id_list {
  949. u32 count; /* Number of IDs in Ids array */
  950. u32 list_size; /* Size of list, including ID strings */
  951. struct acpi_pnp_device_id ids[1]; /* ID array */
  952. };
  953. /*
  954. * Structure returned from acpi_get_object_info.
  955. * Optimized for both 32-bit and 64-bit builds.
  956. */
  957. struct acpi_device_info {
  958. u32 info_size; /* Size of info, including ID strings */
  959. u32 name; /* ACPI object Name */
  960. acpi_object_type type; /* ACPI object Type */
  961. u8 param_count; /* If a method, required parameter count */
  962. u16 valid; /* Indicates which optional fields are valid */
  963. u8 flags; /* Miscellaneous info */
  964. u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
  965. u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
  966. u32 current_status; /* _STA value */
  967. u64 address; /* _ADR value */
  968. struct acpi_pnp_device_id hardware_id; /* _HID value */
  969. struct acpi_pnp_device_id unique_id; /* _UID value */
  970. struct acpi_pnp_device_id class_code; /* _CLS value */
  971. struct acpi_pnp_device_id_list compatible_id_list; /* _CID list <must be last> */
  972. };
  973. /* Values for Flags field above (acpi_get_object_info) */
  974. #define ACPI_PCI_ROOT_BRIDGE 0x01
  975. /* Flags for Valid field above (acpi_get_object_info) */
  976. #define ACPI_VALID_STA 0x0001
  977. #define ACPI_VALID_ADR 0x0002
  978. #define ACPI_VALID_HID 0x0004
  979. #define ACPI_VALID_UID 0x0008
  980. #define ACPI_VALID_CID 0x0020
  981. #define ACPI_VALID_CLS 0x0040
  982. #define ACPI_VALID_SXDS 0x0100
  983. #define ACPI_VALID_SXWS 0x0200
  984. /* Flags for _STA method */
  985. #define ACPI_STA_DEVICE_PRESENT 0x01
  986. #define ACPI_STA_DEVICE_ENABLED 0x02
  987. #define ACPI_STA_DEVICE_UI 0x04
  988. #define ACPI_STA_DEVICE_FUNCTIONING 0x08
  989. #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
  990. #define ACPI_STA_BATTERY_PRESENT 0x10
  991. /* Context structs for address space handlers */
  992. struct acpi_pci_id {
  993. u16 segment;
  994. u16 bus;
  995. u16 device;
  996. u16 function;
  997. };
  998. struct acpi_mem_space_context {
  999. u32 length;
  1000. acpi_physical_address address;
  1001. acpi_physical_address mapped_physical_address;
  1002. u8 *mapped_logical_address;
  1003. acpi_size mapped_length;
  1004. };
  1005. /*
  1006. * struct acpi_memory_list is used only if the ACPICA local cache is enabled
  1007. */
  1008. struct acpi_memory_list {
  1009. const char *list_name;
  1010. void *list_head;
  1011. u16 object_size;
  1012. u16 max_depth;
  1013. u16 current_depth;
  1014. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  1015. /* Statistics for debug memory tracking only */
  1016. u32 total_allocated;
  1017. u32 total_freed;
  1018. u32 max_occupied;
  1019. u32 total_size;
  1020. u32 current_total_size;
  1021. u32 requests;
  1022. u32 hits;
  1023. #endif
  1024. };
  1025. /* Definitions of trace event types */
  1026. typedef enum {
  1027. ACPI_TRACE_AML_METHOD,
  1028. ACPI_TRACE_AML_OPCODE,
  1029. ACPI_TRACE_AML_REGION
  1030. } acpi_trace_event_type;
  1031. /* Definitions of _OSI support */
  1032. #define ACPI_VENDOR_STRINGS 0x01
  1033. #define ACPI_FEATURE_STRINGS 0x02
  1034. #define ACPI_ENABLE_INTERFACES 0x00
  1035. #define ACPI_DISABLE_INTERFACES 0x04
  1036. #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
  1037. #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
  1038. #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
  1039. #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
  1040. #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
  1041. #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
  1042. #define ACPI_OSI_WIN_2000 0x01
  1043. #define ACPI_OSI_WIN_XP 0x02
  1044. #define ACPI_OSI_WIN_XP_SP1 0x03
  1045. #define ACPI_OSI_WINSRV_2003 0x04
  1046. #define ACPI_OSI_WIN_XP_SP2 0x05
  1047. #define ACPI_OSI_WINSRV_2003_SP1 0x06
  1048. #define ACPI_OSI_WIN_VISTA 0x07
  1049. #define ACPI_OSI_WINSRV_2008 0x08
  1050. #define ACPI_OSI_WIN_VISTA_SP1 0x09
  1051. #define ACPI_OSI_WIN_VISTA_SP2 0x0A
  1052. #define ACPI_OSI_WIN_7 0x0B
  1053. #define ACPI_OSI_WIN_8 0x0C
  1054. #define ACPI_OSI_WIN_10 0x0D
  1055. /* Definitions of getopt */
  1056. #define ACPI_OPT_END -1
  1057. #endif /* __ACTYPES_H__ */