actypes.h 42 KB

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