actypes.h 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298
  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. *
  452. * Miscellaneous constants
  453. *
  454. ******************************************************************************/
  455. /*
  456. * Initialization sequence
  457. */
  458. #define ACPI_FULL_INITIALIZATION 0x00
  459. #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
  460. #define ACPI_NO_HARDWARE_INIT 0x02
  461. #define ACPI_NO_EVENT_INIT 0x04
  462. #define ACPI_NO_HANDLER_INIT 0x08
  463. #define ACPI_NO_ACPI_ENABLE 0x10
  464. #define ACPI_NO_DEVICE_INIT 0x20
  465. #define ACPI_NO_OBJECT_INIT 0x40
  466. #define ACPI_NO_FACS_INIT 0x80
  467. /*
  468. * Initialization state
  469. */
  470. #define ACPI_SUBSYSTEM_INITIALIZE 0x01
  471. #define ACPI_INITIALIZED_OK 0x02
  472. /*
  473. * Power state values
  474. */
  475. #define ACPI_STATE_UNKNOWN (u8) 0xFF
  476. #define ACPI_STATE_S0 (u8) 0
  477. #define ACPI_STATE_S1 (u8) 1
  478. #define ACPI_STATE_S2 (u8) 2
  479. #define ACPI_STATE_S3 (u8) 3
  480. #define ACPI_STATE_S4 (u8) 4
  481. #define ACPI_STATE_S5 (u8) 5
  482. #define ACPI_S_STATES_MAX ACPI_STATE_S5
  483. #define ACPI_S_STATE_COUNT 6
  484. #define ACPI_STATE_D0 (u8) 0
  485. #define ACPI_STATE_D1 (u8) 1
  486. #define ACPI_STATE_D2 (u8) 2
  487. #define ACPI_STATE_D3_HOT (u8) 3
  488. #define ACPI_STATE_D3 (u8) 4
  489. #define ACPI_STATE_D3_COLD ACPI_STATE_D3
  490. #define ACPI_D_STATES_MAX ACPI_STATE_D3
  491. #define ACPI_D_STATE_COUNT 5
  492. #define ACPI_STATE_C0 (u8) 0
  493. #define ACPI_STATE_C1 (u8) 1
  494. #define ACPI_STATE_C2 (u8) 2
  495. #define ACPI_STATE_C3 (u8) 3
  496. #define ACPI_C_STATES_MAX ACPI_STATE_C3
  497. #define ACPI_C_STATE_COUNT 4
  498. /*
  499. * Sleep type invalid value
  500. */
  501. #define ACPI_SLEEP_TYPE_MAX 0x7
  502. #define ACPI_SLEEP_TYPE_INVALID 0xFF
  503. /*
  504. * Standard notify values
  505. */
  506. #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
  507. #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
  508. #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
  509. #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
  510. #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
  511. #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
  512. #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
  513. #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
  514. #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
  515. #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
  516. #define ACPI_NOTIFY_RESERVED (u8) 0x0A
  517. #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
  518. #define ACPI_NOTIFY_SHUTDOWN_REQUEST (u8) 0x0C
  519. #define ACPI_NOTIFY_AFFINITY_UPDATE (u8) 0x0D
  520. #define ACPI_NOTIFY_MEMORY_UPDATE (u8) 0x0E
  521. #define ACPI_GENERIC_NOTIFY_MAX 0x0E
  522. #define ACPI_SPECIFIC_NOTIFY_MAX 0x84
  523. /*
  524. * Types associated with ACPI names and objects. The first group of
  525. * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
  526. * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
  527. * only add to the first group if the spec changes.
  528. *
  529. * NOTE: Types must be kept in sync with the global acpi_ns_properties
  530. * and acpi_ns_type_names arrays.
  531. */
  532. typedef u32 acpi_object_type;
  533. #define ACPI_TYPE_ANY 0x00
  534. #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
  535. #define ACPI_TYPE_STRING 0x02
  536. #define ACPI_TYPE_BUFFER 0x03
  537. #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
  538. #define ACPI_TYPE_FIELD_UNIT 0x05
  539. #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
  540. #define ACPI_TYPE_EVENT 0x07
  541. #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
  542. #define ACPI_TYPE_MUTEX 0x09
  543. #define ACPI_TYPE_REGION 0x0A
  544. #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
  545. #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
  546. #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
  547. #define ACPI_TYPE_BUFFER_FIELD 0x0E
  548. #define ACPI_TYPE_DDB_HANDLE 0x0F
  549. #define ACPI_TYPE_DEBUG_OBJECT 0x10
  550. #define ACPI_TYPE_EXTERNAL_MAX 0x10
  551. #define ACPI_NUM_TYPES (ACPI_TYPE_EXTERNAL_MAX + 1)
  552. /*
  553. * These are object types that do not map directly to the ACPI
  554. * object_type() operator. They are used for various internal purposes
  555. * only. If new predefined ACPI_TYPEs are added (via the ACPI
  556. * specification), these internal types must move upwards. (There
  557. * is code that depends on these values being contiguous with the
  558. * external types above.)
  559. */
  560. #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
  561. #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
  562. #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
  563. #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
  564. #define ACPI_TYPE_LOCAL_ALIAS 0x15
  565. #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
  566. #define ACPI_TYPE_LOCAL_NOTIFY 0x17
  567. #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
  568. #define ACPI_TYPE_LOCAL_RESOURCE 0x19
  569. #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
  570. #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
  571. #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
  572. #define ACPI_TOTAL_TYPES (ACPI_TYPE_NS_NODE_MAX + 1)
  573. /*
  574. * These are special object types that never appear in
  575. * a Namespace node, only in an object of union acpi_operand_object
  576. */
  577. #define ACPI_TYPE_LOCAL_EXTRA 0x1C
  578. #define ACPI_TYPE_LOCAL_DATA 0x1D
  579. #define ACPI_TYPE_LOCAL_MAX 0x1D
  580. /* All types above here are invalid */
  581. #define ACPI_TYPE_INVALID 0x1E
  582. #define ACPI_TYPE_NOT_FOUND 0xFF
  583. #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
  584. /*
  585. * All I/O
  586. */
  587. #define ACPI_READ 0
  588. #define ACPI_WRITE 1
  589. #define ACPI_IO_MASK 1
  590. /*
  591. * Event Types: Fixed & General Purpose
  592. */
  593. typedef u32 acpi_event_type;
  594. /*
  595. * Fixed events
  596. */
  597. #define ACPI_EVENT_PMTIMER 0
  598. #define ACPI_EVENT_GLOBAL 1
  599. #define ACPI_EVENT_POWER_BUTTON 2
  600. #define ACPI_EVENT_SLEEP_BUTTON 3
  601. #define ACPI_EVENT_RTC 4
  602. #define ACPI_EVENT_MAX 4
  603. #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
  604. /*
  605. * Event status - Per event
  606. * -------------
  607. * The encoding of acpi_event_status is illustrated below.
  608. * Note that a set bit (1) indicates the property is TRUE
  609. * (e.g. if bit 0 is set then the event is enabled).
  610. * +-------------+-+-+-+-+-+-+
  611. * | Bits 31:6 |5|4|3|2|1|0|
  612. * +-------------+-+-+-+-+-+-+
  613. * | | | | | | |
  614. * | | | | | | +- Enabled?
  615. * | | | | | +--- Enabled for wake?
  616. * | | | | +----- Status bit set?
  617. * | | | +------- Enable bit set?
  618. * | | +--------- Has a handler?
  619. * | +----------- Masked?
  620. * +----------------- <Reserved>
  621. */
  622. typedef u32 acpi_event_status;
  623. #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
  624. #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
  625. #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
  626. #define ACPI_EVENT_FLAG_STATUS_SET (acpi_event_status) 0x04
  627. #define ACPI_EVENT_FLAG_ENABLE_SET (acpi_event_status) 0x08
  628. #define ACPI_EVENT_FLAG_HAS_HANDLER (acpi_event_status) 0x10
  629. #define ACPI_EVENT_FLAG_MASKED (acpi_event_status) 0x20
  630. #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET
  631. /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
  632. #define ACPI_GPE_ENABLE 0
  633. #define ACPI_GPE_DISABLE 1
  634. #define ACPI_GPE_CONDITIONAL_ENABLE 2
  635. /*
  636. * GPE info flags - Per GPE
  637. * +---+-+-+-+---+
  638. * |7:6|5|4|3|2:0|
  639. * +---+-+-+-+---+
  640. * | | | | |
  641. * | | | | +-- Type of dispatch:to method, handler, notify, or none
  642. * | | | +----- Interrupt type: edge or level triggered
  643. * | | +------- Is a Wake GPE
  644. * | +--------- Is GPE masked by the software GPE masking mechanism
  645. * +------------ <Reserved>
  646. */
  647. #define ACPI_GPE_DISPATCH_NONE (u8) 0x00
  648. #define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
  649. #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
  650. #define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
  651. #define ACPI_GPE_DISPATCH_RAW_HANDLER (u8) 0x04
  652. #define ACPI_GPE_DISPATCH_MASK (u8) 0x07
  653. #define ACPI_GPE_DISPATCH_TYPE(flags) ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK))
  654. #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x08
  655. #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
  656. #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x08
  657. #define ACPI_GPE_CAN_WAKE (u8) 0x10
  658. /*
  659. * Flags for GPE and Lock interfaces
  660. */
  661. #define ACPI_NOT_ISR 0x1
  662. #define ACPI_ISR 0x0
  663. /* Notify types */
  664. #define ACPI_SYSTEM_NOTIFY 0x1
  665. #define ACPI_DEVICE_NOTIFY 0x2
  666. #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
  667. #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
  668. #define ACPI_NUM_NOTIFY_TYPES 2
  669. #define ACPI_MAX_SYS_NOTIFY 0x7F
  670. #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
  671. #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
  672. #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
  673. /* Address Space (Operation Region) Types */
  674. typedef u8 acpi_adr_space_type;
  675. #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
  676. #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
  677. #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
  678. #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
  679. #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
  680. #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
  681. #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
  682. #define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
  683. #define ACPI_ADR_SPACE_GPIO (acpi_adr_space_type) 8
  684. #define ACPI_ADR_SPACE_GSBUS (acpi_adr_space_type) 9
  685. #define ACPI_ADR_SPACE_PLATFORM_COMM (acpi_adr_space_type) 10
  686. #define ACPI_NUM_PREDEFINED_REGIONS 11
  687. /*
  688. * Special Address Spaces
  689. *
  690. * Note: A Data Table region is a special type of operation region
  691. * that has its own AML opcode. However, internally, the AML
  692. * interpreter simply creates an operation region with an an address
  693. * space type of ACPI_ADR_SPACE_DATA_TABLE.
  694. */
  695. #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */
  696. #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F
  697. /* Values for _REG connection code */
  698. #define ACPI_REG_DISCONNECT 0
  699. #define ACPI_REG_CONNECT 1
  700. /*
  701. * bit_register IDs
  702. *
  703. * These values are intended to be used by the hardware interfaces
  704. * and are mapped to individual bitfields defined within the ACPI
  705. * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
  706. * for this mapping.
  707. */
  708. /* PM1 Status register */
  709. #define ACPI_BITREG_TIMER_STATUS 0x00
  710. #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
  711. #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
  712. #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
  713. #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
  714. #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
  715. #define ACPI_BITREG_WAKE_STATUS 0x06
  716. #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
  717. /* PM1 Enable register */
  718. #define ACPI_BITREG_TIMER_ENABLE 0x08
  719. #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
  720. #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
  721. #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
  722. #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
  723. #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
  724. /* PM1 Control register */
  725. #define ACPI_BITREG_SCI_ENABLE 0x0E
  726. #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
  727. #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
  728. #define ACPI_BITREG_SLEEP_TYPE 0x11
  729. #define ACPI_BITREG_SLEEP_ENABLE 0x12
  730. /* PM2 Control register */
  731. #define ACPI_BITREG_ARB_DISABLE 0x13
  732. #define ACPI_BITREG_MAX 0x13
  733. #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
  734. /* Status register values. A 1 clears a status bit. 0 = no effect */
  735. #define ACPI_CLEAR_STATUS 1
  736. /* Enable and Control register values */
  737. #define ACPI_ENABLE_EVENT 1
  738. #define ACPI_DISABLE_EVENT 0
  739. /* Sleep function dispatch */
  740. typedef acpi_status (*acpi_sleep_function) (u8 sleep_state);
  741. struct acpi_sleep_functions {
  742. acpi_sleep_function legacy_function;
  743. acpi_sleep_function extended_function;
  744. };
  745. /*
  746. * External ACPI object definition
  747. */
  748. /*
  749. * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
  750. * element or an unresolved named reference.
  751. */
  752. union acpi_object {
  753. acpi_object_type type; /* See definition of acpi_ns_type for values */
  754. struct {
  755. acpi_object_type type; /* ACPI_TYPE_INTEGER */
  756. u64 value; /* The actual number */
  757. } integer;
  758. struct {
  759. acpi_object_type type; /* ACPI_TYPE_STRING */
  760. u32 length; /* # of bytes in string, excluding trailing null */
  761. char *pointer; /* points to the string value */
  762. } string;
  763. struct {
  764. acpi_object_type type; /* ACPI_TYPE_BUFFER */
  765. u32 length; /* # of bytes in buffer */
  766. u8 *pointer; /* points to the buffer */
  767. } buffer;
  768. struct {
  769. acpi_object_type type; /* ACPI_TYPE_PACKAGE */
  770. u32 count; /* # of elements in package */
  771. union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
  772. } package;
  773. struct {
  774. acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
  775. acpi_object_type actual_type; /* Type associated with the Handle */
  776. acpi_handle handle; /* object reference */
  777. } reference;
  778. struct {
  779. acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
  780. u32 proc_id;
  781. acpi_io_address pblk_address;
  782. u32 pblk_length;
  783. } processor;
  784. struct {
  785. acpi_object_type type; /* ACPI_TYPE_POWER */
  786. u32 system_level;
  787. u32 resource_order;
  788. } power_resource;
  789. };
  790. /*
  791. * List of objects, used as a parameter list for control method evaluation
  792. */
  793. struct acpi_object_list {
  794. u32 count;
  795. union acpi_object *pointer;
  796. };
  797. /*
  798. * Miscellaneous common Data Structures used by the interfaces
  799. */
  800. #define ACPI_NO_BUFFER 0
  801. #ifdef ACPI_NO_MEM_ALLOCATIONS
  802. #define ACPI_ALLOCATE_BUFFER (acpi_size) (0)
  803. #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (0)
  804. #else /* ACPI_NO_MEM_ALLOCATIONS */
  805. #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1) /* Let ACPICA allocate buffer */
  806. #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2) /* For internal use only (enables tracking) */
  807. #endif /* ACPI_NO_MEM_ALLOCATIONS */
  808. struct acpi_buffer {
  809. acpi_size length; /* Length in bytes of the buffer */
  810. void *pointer; /* pointer to buffer */
  811. };
  812. /*
  813. * name_type for acpi_get_name
  814. */
  815. #define ACPI_FULL_PATHNAME 0
  816. #define ACPI_SINGLE_NAME 1
  817. #define ACPI_FULL_PATHNAME_NO_TRAILING 2
  818. #define ACPI_NAME_TYPE_MAX 2
  819. /*
  820. * Predefined Namespace items
  821. */
  822. struct acpi_predefined_names {
  823. const char *name;
  824. u8 type;
  825. char *val;
  826. };
  827. /*
  828. * Structure and flags for acpi_get_system_info
  829. */
  830. #define ACPI_SYS_MODE_UNKNOWN 0x0000
  831. #define ACPI_SYS_MODE_ACPI 0x0001
  832. #define ACPI_SYS_MODE_LEGACY 0x0002
  833. #define ACPI_SYS_MODES_MASK 0x0003
  834. /*
  835. * System info returned by acpi_get_system_info()
  836. */
  837. struct acpi_system_info {
  838. u32 acpi_ca_version;
  839. u32 flags;
  840. u32 timer_resolution;
  841. u32 reserved1;
  842. u32 reserved2;
  843. u32 debug_level;
  844. u32 debug_layer;
  845. };
  846. /*
  847. * System statistics returned by acpi_get_statistics()
  848. */
  849. struct acpi_statistics {
  850. u32 sci_count;
  851. u32 gpe_count;
  852. u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS];
  853. u32 method_count;
  854. };
  855. /*
  856. * Types specific to the OS service interfaces
  857. */
  858. typedef u32
  859. (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
  860. typedef void
  861. (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
  862. /*
  863. * Various handlers and callback procedures
  864. */
  865. typedef
  866. u32 (*acpi_sci_handler) (void *context);
  867. typedef
  868. void (*acpi_gbl_event_handler) (u32 event_type,
  869. acpi_handle device,
  870. u32 event_number, void *context);
  871. #define ACPI_EVENT_TYPE_GPE 0
  872. #define ACPI_EVENT_TYPE_FIXED 1
  873. typedef
  874. u32(*acpi_event_handler) (void *context);
  875. typedef
  876. u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
  877. typedef
  878. void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
  879. typedef
  880. void (*acpi_object_handler) (acpi_handle object, void *data);
  881. typedef
  882. acpi_status (*acpi_init_handler) (acpi_handle object, u32 function);
  883. #define ACPI_INIT_DEVICE_INI 1
  884. typedef
  885. acpi_status (*acpi_exception_handler) (acpi_status aml_status,
  886. acpi_name name,
  887. u16 opcode,
  888. u32 aml_offset, void *context);
  889. /* Table Event handler (Load, load_table, etc.) and types */
  890. typedef
  891. acpi_status (*acpi_table_handler) (u32 event, void *table, void *context);
  892. /* Table Event Types */
  893. #define ACPI_TABLE_EVENT_LOAD 0x0
  894. #define ACPI_TABLE_EVENT_UNLOAD 0x1
  895. #define ACPI_TABLE_EVENT_INSTALL 0x2
  896. #define ACPI_TABLE_EVENT_UNINSTALL 0x3
  897. #define ACPI_NUM_TABLE_EVENTS 4
  898. /* Address Spaces (For Operation Regions) */
  899. typedef
  900. acpi_status (*acpi_adr_space_handler) (u32 function,
  901. acpi_physical_address address,
  902. u32 bit_width,
  903. u64 *value,
  904. void *handler_context,
  905. void *region_context);
  906. #define ACPI_DEFAULT_HANDLER NULL
  907. /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
  908. struct acpi_connection_info {
  909. u8 *connection;
  910. u16 length;
  911. u8 access_length;
  912. };
  913. typedef
  914. acpi_status (*acpi_adr_space_setup) (acpi_handle region_handle,
  915. u32 function,
  916. void *handler_context,
  917. void **region_context);
  918. #define ACPI_REGION_ACTIVATE 0
  919. #define ACPI_REGION_DEACTIVATE 1
  920. typedef
  921. acpi_status (*acpi_walk_callback) (acpi_handle object,
  922. u32 nesting_level,
  923. void *context, void **return_value);
  924. typedef
  925. u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
  926. /* Interrupt handler return values */
  927. #define ACPI_INTERRUPT_NOT_HANDLED 0x00
  928. #define ACPI_INTERRUPT_HANDLED 0x01
  929. /* GPE handler return values */
  930. #define ACPI_REENABLE_GPE 0x80
  931. /* Length of 32-bit EISAID values when converted back to a string */
  932. #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
  933. /* Length of UUID (string) values */
  934. #define ACPI_UUID_LENGTH 16
  935. /* Length of 3-byte PCI class code values when converted back to a string */
  936. #define ACPI_PCICLS_STRING_SIZE 7 /* Includes null terminator */
  937. /* Structures used for device/processor HID, UID, CID */
  938. struct acpi_pnp_device_id {
  939. u32 length; /* Length of string + null */
  940. char *string;
  941. };
  942. struct acpi_pnp_device_id_list {
  943. u32 count; /* Number of IDs in Ids array */
  944. u32 list_size; /* Size of list, including ID strings */
  945. struct acpi_pnp_device_id ids[1]; /* ID array */
  946. };
  947. /*
  948. * Structure returned from acpi_get_object_info.
  949. * Optimized for both 32-bit and 64-bit builds.
  950. */
  951. struct acpi_device_info {
  952. u32 info_size; /* Size of info, including ID strings */
  953. u32 name; /* ACPI object Name */
  954. acpi_object_type type; /* ACPI object Type */
  955. u8 param_count; /* If a method, required parameter count */
  956. u16 valid; /* Indicates which optional fields are valid */
  957. u8 flags; /* Miscellaneous info */
  958. u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
  959. u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
  960. u32 current_status; /* _STA value */
  961. u64 address; /* _ADR value */
  962. struct acpi_pnp_device_id hardware_id; /* _HID value */
  963. struct acpi_pnp_device_id unique_id; /* _UID value */
  964. struct acpi_pnp_device_id class_code; /* _CLS value */
  965. struct acpi_pnp_device_id_list compatible_id_list; /* _CID list <must be last> */
  966. };
  967. /* Values for Flags field above (acpi_get_object_info) */
  968. #define ACPI_PCI_ROOT_BRIDGE 0x01
  969. /* Flags for Valid field above (acpi_get_object_info) */
  970. #define ACPI_VALID_STA 0x0001
  971. #define ACPI_VALID_ADR 0x0002
  972. #define ACPI_VALID_HID 0x0004
  973. #define ACPI_VALID_UID 0x0008
  974. #define ACPI_VALID_CID 0x0020
  975. #define ACPI_VALID_CLS 0x0040
  976. #define ACPI_VALID_SXDS 0x0100
  977. #define ACPI_VALID_SXWS 0x0200
  978. /* Flags for _STA method */
  979. #define ACPI_STA_DEVICE_PRESENT 0x01
  980. #define ACPI_STA_DEVICE_ENABLED 0x02
  981. #define ACPI_STA_DEVICE_UI 0x04
  982. #define ACPI_STA_DEVICE_FUNCTIONING 0x08
  983. #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
  984. #define ACPI_STA_BATTERY_PRESENT 0x10
  985. /* Context structs for address space handlers */
  986. struct acpi_pci_id {
  987. u16 segment;
  988. u16 bus;
  989. u16 device;
  990. u16 function;
  991. };
  992. struct acpi_mem_space_context {
  993. u32 length;
  994. acpi_physical_address address;
  995. acpi_physical_address mapped_physical_address;
  996. u8 *mapped_logical_address;
  997. acpi_size mapped_length;
  998. };
  999. /*
  1000. * struct acpi_memory_list is used only if the ACPICA local cache is enabled
  1001. */
  1002. struct acpi_memory_list {
  1003. const char *list_name;
  1004. void *list_head;
  1005. u16 object_size;
  1006. u16 max_depth;
  1007. u16 current_depth;
  1008. #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  1009. /* Statistics for debug memory tracking only */
  1010. u32 total_allocated;
  1011. u32 total_freed;
  1012. u32 max_occupied;
  1013. u32 total_size;
  1014. u32 current_total_size;
  1015. u32 requests;
  1016. u32 hits;
  1017. #endif
  1018. };
  1019. /* Definitions of trace event types */
  1020. typedef enum {
  1021. ACPI_TRACE_AML_METHOD,
  1022. ACPI_TRACE_AML_OPCODE,
  1023. ACPI_TRACE_AML_REGION
  1024. } acpi_trace_event_type;
  1025. /* Definitions of _OSI support */
  1026. #define ACPI_VENDOR_STRINGS 0x01
  1027. #define ACPI_FEATURE_STRINGS 0x02
  1028. #define ACPI_ENABLE_INTERFACES 0x00
  1029. #define ACPI_DISABLE_INTERFACES 0x04
  1030. #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
  1031. #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
  1032. #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
  1033. #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
  1034. #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
  1035. #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
  1036. #define ACPI_OSI_WIN_2000 0x01
  1037. #define ACPI_OSI_WIN_XP 0x02
  1038. #define ACPI_OSI_WIN_XP_SP1 0x03
  1039. #define ACPI_OSI_WINSRV_2003 0x04
  1040. #define ACPI_OSI_WIN_XP_SP2 0x05
  1041. #define ACPI_OSI_WINSRV_2003_SP1 0x06
  1042. #define ACPI_OSI_WIN_VISTA 0x07
  1043. #define ACPI_OSI_WINSRV_2008 0x08
  1044. #define ACPI_OSI_WIN_VISTA_SP1 0x09
  1045. #define ACPI_OSI_WIN_VISTA_SP2 0x0A
  1046. #define ACPI_OSI_WIN_7 0x0B
  1047. #define ACPI_OSI_WIN_8 0x0C
  1048. #define ACPI_OSI_WIN_10 0x0D
  1049. /* Definitions of getopt */
  1050. #define ACPI_OPT_END -1
  1051. #endif /* __ACTYPES_H__ */