acinterp.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. /******************************************************************************
  2. *
  3. * Name: acinterp.h - Interpreter subcomponent prototypes and defines
  4. *
  5. *****************************************************************************/
  6. /*
  7. * Copyright (C) 2000 - 2007, R. Byron Moore
  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 __ACINTERP_H__
  43. #define __ACINTERP_H__
  44. #define ACPI_WALK_OPERANDS (&(walk_state->operands [walk_state->num_operands -1]))
  45. /* Macros for tables used for debug output */
  46. #define ACPI_EXD_OFFSET(f) (u8) ACPI_OFFSET (union acpi_operand_object,f)
  47. #define ACPI_EXD_NSOFFSET(f) (u8) ACPI_OFFSET (struct acpi_namespace_node,f)
  48. #define ACPI_EXD_TABLE_SIZE(name) (sizeof(name) / sizeof (struct acpi_exdump_info))
  49. /*
  50. * If possible, pack the following structures to byte alignment, since we
  51. * don't care about performance for debug output. Two cases where we cannot
  52. * pack the structures:
  53. *
  54. * 1) Hardware does not support misaligned memory transfers
  55. * 2) Compiler does not support pointers within packed structures
  56. */
  57. #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
  58. #pragma pack(1)
  59. #endif
  60. typedef const struct acpi_exdump_info {
  61. u8 opcode;
  62. u8 offset;
  63. char *name;
  64. } acpi_exdump_info;
  65. /* Values for the Opcode field above */
  66. #define ACPI_EXD_INIT 0
  67. #define ACPI_EXD_TYPE 1
  68. #define ACPI_EXD_UINT8 2
  69. #define ACPI_EXD_UINT16 3
  70. #define ACPI_EXD_UINT32 4
  71. #define ACPI_EXD_UINT64 5
  72. #define ACPI_EXD_LITERAL 6
  73. #define ACPI_EXD_POINTER 7
  74. #define ACPI_EXD_ADDRESS 8
  75. #define ACPI_EXD_STRING 9
  76. #define ACPI_EXD_BUFFER 10
  77. #define ACPI_EXD_PACKAGE 11
  78. #define ACPI_EXD_FIELD 12
  79. #define ACPI_EXD_REFERENCE 13
  80. /* restore default alignment */
  81. #pragma pack()
  82. /*
  83. * exconvrt - object conversion
  84. */
  85. acpi_status
  86. acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
  87. union acpi_operand_object **result_desc, u32 flags);
  88. acpi_status
  89. acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
  90. union acpi_operand_object **result_desc);
  91. acpi_status
  92. acpi_ex_convert_to_string(union acpi_operand_object *obj_desc,
  93. union acpi_operand_object **result_desc, u32 type);
  94. /* Types for ->String conversion */
  95. #define ACPI_EXPLICIT_BYTE_COPY 0x00000000
  96. #define ACPI_EXPLICIT_CONVERT_HEX 0x00000001
  97. #define ACPI_IMPLICIT_CONVERT_HEX 0x00000002
  98. #define ACPI_EXPLICIT_CONVERT_DECIMAL 0x00000003
  99. acpi_status
  100. acpi_ex_convert_to_target_type(acpi_object_type destination_type,
  101. union acpi_operand_object *source_desc,
  102. union acpi_operand_object **result_desc,
  103. struct acpi_walk_state *walk_state);
  104. /*
  105. * exfield - ACPI AML (p-code) execution - field manipulation
  106. */
  107. acpi_status
  108. acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
  109. u32 buffer_length, u32 * datum_count);
  110. acpi_status
  111. acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
  112. acpi_integer mask,
  113. acpi_integer field_value,
  114. u32 field_datum_byte_offset);
  115. void
  116. acpi_ex_get_buffer_datum(acpi_integer * datum,
  117. void *buffer,
  118. u32 buffer_length,
  119. u32 byte_granularity, u32 buffer_offset);
  120. void
  121. acpi_ex_set_buffer_datum(acpi_integer merged_datum,
  122. void *buffer,
  123. u32 buffer_length,
  124. u32 byte_granularity, u32 buffer_offset);
  125. acpi_status
  126. acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
  127. union acpi_operand_object *obj_desc,
  128. union acpi_operand_object **ret_buffer_desc);
  129. acpi_status
  130. acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
  131. union acpi_operand_object *obj_desc,
  132. union acpi_operand_object **result_desc);
  133. /*
  134. * exfldio - low level field I/O
  135. */
  136. acpi_status
  137. acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
  138. void *buffer, u32 buffer_length);
  139. acpi_status
  140. acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
  141. void *buffer, u32 buffer_length);
  142. acpi_status
  143. acpi_ex_access_region(union acpi_operand_object *obj_desc,
  144. u32 field_datum_byte_offset,
  145. acpi_integer * value, u32 read_write);
  146. /*
  147. * exmisc - misc support routines
  148. */
  149. acpi_status
  150. acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
  151. union acpi_operand_object **return_desc,
  152. struct acpi_walk_state *walk_state);
  153. acpi_status
  154. acpi_ex_concat_template(union acpi_operand_object *obj_desc,
  155. union acpi_operand_object *obj_desc2,
  156. union acpi_operand_object **actual_return_desc,
  157. struct acpi_walk_state *walk_state);
  158. acpi_status
  159. acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
  160. union acpi_operand_object *obj_desc2,
  161. union acpi_operand_object **actual_return_desc,
  162. struct acpi_walk_state *walk_state);
  163. acpi_status
  164. acpi_ex_do_logical_numeric_op(u16 opcode,
  165. acpi_integer integer0,
  166. acpi_integer integer1, u8 * logical_result);
  167. acpi_status
  168. acpi_ex_do_logical_op(u16 opcode,
  169. union acpi_operand_object *operand0,
  170. union acpi_operand_object *operand1, u8 * logical_result);
  171. acpi_integer
  172. acpi_ex_do_math_op(u16 opcode, acpi_integer operand0, acpi_integer operand1);
  173. acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
  174. acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
  175. acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
  176. acpi_status
  177. acpi_ex_create_region(u8 * aml_start,
  178. u32 aml_length,
  179. u8 region_space, struct acpi_walk_state *walk_state);
  180. acpi_status acpi_ex_create_table_region(struct acpi_walk_state *walk_state);
  181. acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
  182. acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
  183. acpi_status
  184. acpi_ex_create_method(u8 * aml_start,
  185. u32 aml_length, struct acpi_walk_state *walk_state);
  186. /*
  187. * exconfig - dynamic table load/unload
  188. */
  189. acpi_status
  190. acpi_ex_load_op(union acpi_operand_object *obj_desc,
  191. union acpi_operand_object *target,
  192. struct acpi_walk_state *walk_state);
  193. acpi_status
  194. acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
  195. union acpi_operand_object **return_desc);
  196. acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
  197. /*
  198. * exmutex - mutex support
  199. */
  200. acpi_status
  201. acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
  202. union acpi_operand_object *obj_desc,
  203. struct acpi_walk_state *walk_state);
  204. acpi_status
  205. acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
  206. struct acpi_walk_state *walk_state);
  207. void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
  208. void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc,
  209. struct acpi_thread_state *thread);
  210. /*
  211. * exprep - ACPI AML execution - prep utilities
  212. */
  213. acpi_status
  214. acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
  215. u8 field_flags,
  216. u8 field_attribute,
  217. u32 field_bit_position, u32 field_bit_length);
  218. acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
  219. /*
  220. * exsystem - Interface to OS services
  221. */
  222. acpi_status
  223. acpi_ex_system_do_notify_op(union acpi_operand_object *value,
  224. union acpi_operand_object *obj_desc);
  225. acpi_status acpi_ex_system_do_suspend(acpi_integer time);
  226. acpi_status acpi_ex_system_do_stall(u32 time);
  227. acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
  228. acpi_status
  229. acpi_ex_system_wait_event(union acpi_operand_object *time,
  230. union acpi_operand_object *obj_desc);
  231. acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
  232. acpi_status
  233. acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);
  234. acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);
  235. /*
  236. * exoparg1 - ACPI AML execution, 1 operand
  237. */
  238. acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
  239. acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
  240. acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
  241. acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
  242. acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
  243. /*
  244. * exoparg2 - ACPI AML execution, 2 operands
  245. */
  246. acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
  247. acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
  248. acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
  249. acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
  250. /*
  251. * exoparg3 - ACPI AML execution, 3 operands
  252. */
  253. acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
  254. acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
  255. /*
  256. * exoparg6 - ACPI AML execution, 6 operands
  257. */
  258. acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
  259. /*
  260. * exresolv - Object resolution and get value functions
  261. */
  262. acpi_status
  263. acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
  264. struct acpi_walk_state *walk_state);
  265. acpi_status
  266. acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
  267. union acpi_operand_object *operand,
  268. acpi_object_type * return_type,
  269. union acpi_operand_object **return_desc);
  270. /*
  271. * exresnte - resolve namespace node
  272. */
  273. acpi_status
  274. acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
  275. struct acpi_walk_state *walk_state);
  276. /*
  277. * exresop - resolve operand to value
  278. */
  279. acpi_status
  280. acpi_ex_resolve_operands(u16 opcode,
  281. union acpi_operand_object **stack_ptr,
  282. struct acpi_walk_state *walk_state);
  283. /*
  284. * exdump - Interpreter debug output routines
  285. */
  286. void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
  287. void
  288. acpi_ex_dump_operands(union acpi_operand_object **operands,
  289. acpi_interpreter_mode interpreter_mode,
  290. char *ident,
  291. u32 num_levels,
  292. char *note, char *module_name, u32 line_number);
  293. #ifdef ACPI_FUTURE_USAGE
  294. void
  295. acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
  296. void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
  297. #endif /* ACPI_FUTURE_USAGE */
  298. /*
  299. * exnames - AML namestring support
  300. */
  301. acpi_status
  302. acpi_ex_get_name_string(acpi_object_type data_type,
  303. u8 * in_aml_address,
  304. char **out_name_string, u32 * out_name_length);
  305. /*
  306. * exstore - Object store support
  307. */
  308. acpi_status
  309. acpi_ex_store(union acpi_operand_object *val_desc,
  310. union acpi_operand_object *dest_desc,
  311. struct acpi_walk_state *walk_state);
  312. acpi_status
  313. acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
  314. struct acpi_namespace_node *node,
  315. struct acpi_walk_state *walk_state,
  316. u8 implicit_conversion);
  317. #define ACPI_IMPLICIT_CONVERSION TRUE
  318. #define ACPI_NO_IMPLICIT_CONVERSION FALSE
  319. /*
  320. * exstoren - resolve/store object
  321. */
  322. acpi_status
  323. acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
  324. acpi_object_type target_type,
  325. struct acpi_walk_state *walk_state);
  326. acpi_status
  327. acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
  328. union acpi_operand_object *dest_desc,
  329. union acpi_operand_object **new_desc,
  330. struct acpi_walk_state *walk_state);
  331. /*
  332. * exstorob - store object - buffer/string
  333. */
  334. acpi_status
  335. acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
  336. union acpi_operand_object *target_desc);
  337. acpi_status
  338. acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
  339. union acpi_operand_object *target_desc);
  340. /*
  341. * excopy - object copy
  342. */
  343. acpi_status
  344. acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
  345. union acpi_operand_object *target_desc);
  346. acpi_status
  347. acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
  348. union acpi_operand_object *target_desc);
  349. acpi_status
  350. acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
  351. struct acpi_namespace_node *node);
  352. acpi_status
  353. acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
  354. union acpi_operand_object *target_desc);
  355. /*
  356. * exutils - interpreter/scanner utilities
  357. */
  358. acpi_status acpi_ex_enter_interpreter(void);
  359. void acpi_ex_exit_interpreter(void);
  360. void acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
  361. u8 acpi_ex_acquire_global_lock(u32 rule);
  362. void acpi_ex_release_global_lock(u8 locked);
  363. void acpi_ex_eisa_id_to_string(u32 numeric_id, char *out_string);
  364. void acpi_ex_unsigned_integer_to_string(acpi_integer value, char *out_string);
  365. /*
  366. * exregion - default op_region handlers
  367. */
  368. acpi_status
  369. acpi_ex_system_memory_space_handler(u32 function,
  370. acpi_physical_address address,
  371. u32 bit_width,
  372. acpi_integer * value,
  373. void *handler_context,
  374. void *region_context);
  375. acpi_status
  376. acpi_ex_system_io_space_handler(u32 function,
  377. acpi_physical_address address,
  378. u32 bit_width,
  379. acpi_integer * value,
  380. void *handler_context, void *region_context);
  381. acpi_status
  382. acpi_ex_pci_config_space_handler(u32 function,
  383. acpi_physical_address address,
  384. u32 bit_width,
  385. acpi_integer * value,
  386. void *handler_context, void *region_context);
  387. acpi_status
  388. acpi_ex_cmos_space_handler(u32 function,
  389. acpi_physical_address address,
  390. u32 bit_width,
  391. acpi_integer * value,
  392. void *handler_context, void *region_context);
  393. acpi_status
  394. acpi_ex_pci_bar_space_handler(u32 function,
  395. acpi_physical_address address,
  396. u32 bit_width,
  397. acpi_integer * value,
  398. void *handler_context, void *region_context);
  399. acpi_status
  400. acpi_ex_embedded_controller_space_handler(u32 function,
  401. acpi_physical_address address,
  402. u32 bit_width,
  403. acpi_integer * value,
  404. void *handler_context,
  405. void *region_context);
  406. acpi_status
  407. acpi_ex_sm_bus_space_handler(u32 function,
  408. acpi_physical_address address,
  409. u32 bit_width,
  410. acpi_integer * value,
  411. void *handler_context, void *region_context);
  412. acpi_status
  413. acpi_ex_data_table_space_handler(u32 function,
  414. acpi_physical_address address,
  415. u32 bit_width,
  416. acpi_integer * value,
  417. void *handler_context, void *region_context);
  418. #endif /* __INTERP_H__ */