actypes.h 42 KB

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