actypes.h 42 KB

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