acobject.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443
  1. /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
  2. /******************************************************************************
  3. *
  4. * Name: acobject.h - Definition of union acpi_operand_object (Internal object only)
  5. *
  6. * Copyright (C) 2000 - 2022, Intel Corp.
  7. *
  8. *****************************************************************************/
  9. #ifndef _ACOBJECT_H
  10. #define _ACOBJECT_H
  11. /* acpisrc:struct_defs -- for acpisrc conversion */
  12. /*
  13. * The union acpi_operand_object is used to pass AML operands from the dispatcher
  14. * to the interpreter, and to keep track of the various handlers such as
  15. * address space handlers and notify handlers. The object is a constant
  16. * size in order to allow it to be cached and reused.
  17. *
  18. * Note: The object is optimized to be aligned and will not work if it is
  19. * byte-packed.
  20. */
  21. #if ACPI_MACHINE_WIDTH == 64
  22. #pragma pack(8)
  23. #else
  24. #pragma pack(4)
  25. #endif
  26. /*******************************************************************************
  27. *
  28. * Common Descriptors
  29. *
  30. ******************************************************************************/
  31. /*
  32. * Common area for all objects.
  33. *
  34. * descriptor_type is used to differentiate between internal descriptors, and
  35. * must be in the same place across all descriptors
  36. *
  37. * Note: The descriptor_type and Type fields must appear in the identical
  38. * position in both the struct acpi_namespace_node and union acpi_operand_object
  39. * structures.
  40. */
  41. #define ACPI_OBJECT_COMMON_HEADER \
  42. union acpi_operand_object *next_object; /* Objects linked to parent NS node */\
  43. u8 descriptor_type; /* To differentiate various internal objs */\
  44. u8 type; /* acpi_object_type */\
  45. u16 reference_count; /* For object deletion management */\
  46. u8 flags;
  47. /*
  48. * Note: There are 3 bytes available here before the
  49. * next natural alignment boundary (for both 32/64 cases)
  50. */
  51. /* Values for Flag byte above */
  52. #define AOPOBJ_AML_CONSTANT 0x01 /* Integer is an AML constant */
  53. #define AOPOBJ_STATIC_POINTER 0x02 /* Data is part of an ACPI table, don't delete */
  54. #define AOPOBJ_DATA_VALID 0x04 /* Object is initialized and data is valid */
  55. #define AOPOBJ_OBJECT_INITIALIZED 0x08 /* Region is initialized */
  56. #define AOPOBJ_REG_CONNECTED 0x10 /* _REG was run */
  57. #define AOPOBJ_SETUP_COMPLETE 0x20 /* Region setup is complete */
  58. #define AOPOBJ_INVALID 0x40 /* Host OS won't allow a Region address */
  59. /******************************************************************************
  60. *
  61. * Basic data types
  62. *
  63. *****************************************************************************/
  64. struct acpi_object_common {
  65. ACPI_OBJECT_COMMON_HEADER};
  66. struct acpi_object_integer {
  67. ACPI_OBJECT_COMMON_HEADER u8 fill[3]; /* Prevent warning on some compilers */
  68. u64 value;
  69. };
  70. /*
  71. * Note: The String and Buffer object must be identical through the
  72. * pointer and length elements. There is code that depends on this.
  73. *
  74. * Fields common to both Strings and Buffers
  75. */
  76. #define ACPI_COMMON_BUFFER_INFO(_type) \
  77. _type *pointer; \
  78. u32 length;
  79. /* Null terminated, ASCII characters only */
  80. struct acpi_object_string {
  81. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(char) /* String in AML stream or allocated string */
  82. };
  83. struct acpi_object_buffer {
  84. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_BUFFER_INFO(u8) /* Buffer in AML stream or allocated buffer */
  85. u32 aml_length;
  86. u8 *aml_start;
  87. struct acpi_namespace_node *node; /* Link back to parent node */
  88. };
  89. struct acpi_object_package {
  90. ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Link back to parent node */
  91. union acpi_operand_object **elements; /* Array of pointers to acpi_objects */
  92. u8 *aml_start;
  93. u32 aml_length;
  94. u32 count; /* # of elements in package */
  95. };
  96. /******************************************************************************
  97. *
  98. * Complex data types
  99. *
  100. *****************************************************************************/
  101. struct acpi_object_event {
  102. ACPI_OBJECT_COMMON_HEADER acpi_semaphore os_semaphore; /* Actual OS synchronization object */
  103. };
  104. struct acpi_object_mutex {
  105. ACPI_OBJECT_COMMON_HEADER u8 sync_level; /* 0-15, specified in Mutex() call */
  106. u16 acquisition_depth; /* Allow multiple Acquires, same thread */
  107. acpi_mutex os_mutex; /* Actual OS synchronization object */
  108. acpi_thread_id thread_id; /* Current owner of the mutex */
  109. struct acpi_thread_state *owner_thread; /* Current owner of the mutex */
  110. union acpi_operand_object *prev; /* Link for list of acquired mutexes */
  111. union acpi_operand_object *next; /* Link for list of acquired mutexes */
  112. struct acpi_namespace_node *node; /* Containing namespace node */
  113. u8 original_sync_level; /* Owner's original sync level (0-15) */
  114. };
  115. struct acpi_object_region {
  116. ACPI_OBJECT_COMMON_HEADER u8 space_id;
  117. struct acpi_namespace_node *node; /* Containing namespace node */
  118. union acpi_operand_object *handler; /* Handler for region access */
  119. union acpi_operand_object *next;
  120. acpi_physical_address address;
  121. u32 length;
  122. void *pointer; /* Only for data table regions */
  123. };
  124. struct acpi_object_method {
  125. ACPI_OBJECT_COMMON_HEADER u8 info_flags;
  126. u8 param_count;
  127. u8 sync_level;
  128. union acpi_operand_object *mutex;
  129. union acpi_operand_object *node;
  130. u8 *aml_start;
  131. union {
  132. acpi_internal_method implementation;
  133. union acpi_operand_object *handler;
  134. } dispatch;
  135. u32 aml_length;
  136. acpi_owner_id owner_id;
  137. u8 thread_count;
  138. };
  139. /* Flags for info_flags field above */
  140. #define ACPI_METHOD_MODULE_LEVEL 0x01 /* Method is actually module-level code */
  141. #define ACPI_METHOD_INTERNAL_ONLY 0x02 /* Method is implemented internally (_OSI) */
  142. #define ACPI_METHOD_SERIALIZED 0x04 /* Method is serialized */
  143. #define ACPI_METHOD_SERIALIZED_PENDING 0x08 /* Method is to be marked serialized */
  144. #define ACPI_METHOD_IGNORE_SYNC_LEVEL 0x10 /* Method was auto-serialized at table load time */
  145. #define ACPI_METHOD_MODIFIED_NAMESPACE 0x20 /* Method modified the namespace */
  146. /******************************************************************************
  147. *
  148. * Objects that can be notified. All share a common notify_info area.
  149. *
  150. *****************************************************************************/
  151. /*
  152. * Common fields for objects that support ASL notifications
  153. */
  154. #define ACPI_COMMON_NOTIFY_INFO \
  155. union acpi_operand_object *notify_list[2]; /* Handlers for system/device notifies */\
  156. union acpi_operand_object *handler; /* Handler for Address space */
  157. /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */
  158. struct acpi_object_notify_common {
  159. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
  160. struct acpi_object_device {
  161. ACPI_OBJECT_COMMON_HEADER
  162. ACPI_COMMON_NOTIFY_INFO struct acpi_gpe_block_info *gpe_block;
  163. };
  164. struct acpi_object_power_resource {
  165. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO u32 system_level;
  166. u32 resource_order;
  167. };
  168. struct acpi_object_processor {
  169. ACPI_OBJECT_COMMON_HEADER
  170. /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */
  171. u8 proc_id;
  172. u8 length;
  173. ACPI_COMMON_NOTIFY_INFO acpi_io_address address;
  174. };
  175. struct acpi_object_thermal_zone {
  176. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_NOTIFY_INFO};
  177. /******************************************************************************
  178. *
  179. * Fields. All share a common header/info field.
  180. *
  181. *****************************************************************************/
  182. /*
  183. * Common bitfield for the field objects
  184. * "Field Datum" -- a datum from the actual field object
  185. * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field
  186. */
  187. #define ACPI_COMMON_FIELD_INFO \
  188. u8 field_flags; /* Access, update, and lock bits */\
  189. u8 attribute; /* From access_as keyword */\
  190. u8 access_byte_width; /* Read/Write size in bytes */\
  191. struct acpi_namespace_node *node; /* Link back to parent node */\
  192. u32 bit_length; /* Length of field in bits */\
  193. u32 base_byte_offset; /* Byte offset within containing object */\
  194. u32 value; /* Value to store into the Bank or Index register */\
  195. u8 start_field_bit_offset;/* Bit offset within first field datum (0-63) */\
  196. u8 access_length; /* For serial regions/fields */
  197. /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */
  198. struct acpi_object_field_common {
  199. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Parent Operation Region object (REGION/BANK fields only) */
  200. };
  201. struct acpi_object_region_field {
  202. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u16 resource_length;
  203. union acpi_operand_object *region_obj; /* Containing op_region object */
  204. u8 *resource_buffer; /* resource_template for serial regions/fields */
  205. u16 pin_number_index; /* Index relative to previous Connection/Template */
  206. u8 *internal_pcc_buffer; /* Internal buffer for fields associated with PCC */
  207. };
  208. struct acpi_object_bank_field {
  209. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO union acpi_operand_object *region_obj; /* Containing op_region object */
  210. union acpi_operand_object *bank_obj; /* bank_select Register object */
  211. };
  212. struct acpi_object_index_field {
  213. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO
  214. /*
  215. * No "RegionObj" pointer needed since the Index and Data registers
  216. * are each field definitions unto themselves.
  217. */
  218. union acpi_operand_object *index_obj; /* Index register */
  219. union acpi_operand_object *data_obj; /* Data register */
  220. };
  221. /* The buffer_field is different in that it is part of a Buffer, not an op_region */
  222. struct acpi_object_buffer_field {
  223. ACPI_OBJECT_COMMON_HEADER ACPI_COMMON_FIELD_INFO u8 is_create_field; /* Special case for objects created by create_field() */
  224. union acpi_operand_object *buffer_obj; /* Containing Buffer object */
  225. };
  226. /******************************************************************************
  227. *
  228. * Objects for handlers
  229. *
  230. *****************************************************************************/
  231. struct acpi_object_notify_handler {
  232. ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *node; /* Parent device */
  233. u32 handler_type; /* Type: Device/System/Both */
  234. acpi_notify_handler handler; /* Handler address */
  235. void *context;
  236. union acpi_operand_object *next[2]; /* Device and System handler lists */
  237. };
  238. struct acpi_object_addr_handler {
  239. ACPI_OBJECT_COMMON_HEADER u8 space_id;
  240. u8 handler_flags;
  241. acpi_adr_space_handler handler;
  242. struct acpi_namespace_node *node; /* Parent device */
  243. void *context;
  244. acpi_mutex context_mutex;
  245. acpi_adr_space_setup setup;
  246. union acpi_operand_object *region_list; /* Regions using this handler */
  247. union acpi_operand_object *next;
  248. };
  249. /* Flags for address handler (handler_flags) */
  250. #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01
  251. /******************************************************************************
  252. *
  253. * Special internal objects
  254. *
  255. *****************************************************************************/
  256. /*
  257. * The Reference object is used for these opcodes:
  258. * Arg[0-6], Local[0-7], index_op, name_op, ref_of_op, load_op, load_table_op, debug_op
  259. * The Reference.Class differentiates these types.
  260. */
  261. struct acpi_object_reference {
  262. ACPI_OBJECT_COMMON_HEADER u8 class; /* Reference Class */
  263. u8 target_type; /* Used for Index Op */
  264. u8 resolved; /* Reference has been resolved to a value */
  265. void *object; /* name_op=>HANDLE to obj, index_op=>union acpi_operand_object */
  266. struct acpi_namespace_node *node; /* ref_of or Namepath */
  267. union acpi_operand_object **where; /* Target of Index */
  268. u8 *index_pointer; /* Used for Buffers and Strings */
  269. u8 *aml; /* Used for deferred resolution of the ref */
  270. u32 value; /* Used for Local/Arg/Index/ddb_handle */
  271. };
  272. /* Values for Reference.Class above */
  273. typedef enum {
  274. ACPI_REFCLASS_LOCAL = 0, /* Method local */
  275. ACPI_REFCLASS_ARG = 1, /* Method argument */
  276. ACPI_REFCLASS_REFOF = 2, /* Result of ref_of() TBD: Split to Ref/Node and Ref/operand_obj? */
  277. ACPI_REFCLASS_INDEX = 3, /* Result of Index() */
  278. ACPI_REFCLASS_TABLE = 4, /* ddb_handle - Load(), load_table() */
  279. ACPI_REFCLASS_NAME = 5, /* Reference to a named object */
  280. ACPI_REFCLASS_DEBUG = 6, /* Debug object */
  281. ACPI_REFCLASS_MAX = 6
  282. } ACPI_REFERENCE_CLASSES;
  283. /*
  284. * Extra object is used as additional storage for types that
  285. * have AML code in their declarations (term_args) that must be
  286. * evaluated at run time.
  287. *
  288. * Currently: Region and field_unit types
  289. */
  290. struct acpi_object_extra {
  291. ACPI_OBJECT_COMMON_HEADER struct acpi_namespace_node *method_REG; /* _REG method for this region (if any) */
  292. struct acpi_namespace_node *scope_node;
  293. void *region_context; /* Region-specific data */
  294. u8 *aml_start;
  295. u32 aml_length;
  296. };
  297. /* Additional data that can be attached to namespace nodes */
  298. struct acpi_object_data {
  299. ACPI_OBJECT_COMMON_HEADER acpi_object_handler handler;
  300. void *pointer;
  301. };
  302. /* Structure used when objects are cached for reuse */
  303. struct acpi_object_cache_list {
  304. ACPI_OBJECT_COMMON_HEADER union acpi_operand_object *next; /* Link for object cache and internal lists */
  305. };
  306. /******************************************************************************
  307. *
  308. * union acpi_operand_object descriptor - a giant union of all of the above
  309. *
  310. *****************************************************************************/
  311. union acpi_operand_object {
  312. struct acpi_object_common common;
  313. struct acpi_object_integer integer;
  314. struct acpi_object_string string;
  315. struct acpi_object_buffer buffer;
  316. struct acpi_object_package package;
  317. struct acpi_object_event event;
  318. struct acpi_object_method method;
  319. struct acpi_object_mutex mutex;
  320. struct acpi_object_region region;
  321. struct acpi_object_notify_common common_notify;
  322. struct acpi_object_device device;
  323. struct acpi_object_power_resource power_resource;
  324. struct acpi_object_processor processor;
  325. struct acpi_object_thermal_zone thermal_zone;
  326. struct acpi_object_field_common common_field;
  327. struct acpi_object_region_field field;
  328. struct acpi_object_buffer_field buffer_field;
  329. struct acpi_object_bank_field bank_field;
  330. struct acpi_object_index_field index_field;
  331. struct acpi_object_notify_handler notify;
  332. struct acpi_object_addr_handler address_space;
  333. struct acpi_object_reference reference;
  334. struct acpi_object_extra extra;
  335. struct acpi_object_data data;
  336. struct acpi_object_cache_list cache;
  337. /*
  338. * Add namespace node to union in order to simplify code that accepts both
  339. * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share
  340. * a common descriptor_type field in order to differentiate them.
  341. */
  342. struct acpi_namespace_node node;
  343. };
  344. /******************************************************************************
  345. *
  346. * union acpi_descriptor - objects that share a common descriptor identifier
  347. *
  348. *****************************************************************************/
  349. /* Object descriptor types */
  350. #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */
  351. #define ACPI_DESC_TYPE_STATE 0x02
  352. #define ACPI_DESC_TYPE_STATE_UPDATE 0x03
  353. #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04
  354. #define ACPI_DESC_TYPE_STATE_CONTROL 0x05
  355. #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06
  356. #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07
  357. #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08
  358. #define ACPI_DESC_TYPE_STATE_RESULT 0x09
  359. #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A
  360. #define ACPI_DESC_TYPE_STATE_THREAD 0x0B
  361. #define ACPI_DESC_TYPE_WALK 0x0C
  362. #define ACPI_DESC_TYPE_PARSER 0x0D
  363. #define ACPI_DESC_TYPE_OPERAND 0x0E
  364. #define ACPI_DESC_TYPE_NAMED 0x0F
  365. #define ACPI_DESC_TYPE_MAX 0x0F
  366. struct acpi_common_descriptor {
  367. void *common_pointer;
  368. u8 descriptor_type; /* To differentiate various internal objs */
  369. };
  370. union acpi_descriptor {
  371. struct acpi_common_descriptor common;
  372. union acpi_operand_object object;
  373. struct acpi_namespace_node node;
  374. union acpi_parse_object op;
  375. };
  376. #pragma pack()
  377. #endif /* _ACOBJECT_H */