acresrc.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  1. /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
  2. /******************************************************************************
  3. *
  4. * Name: acresrc.h - Resource Manager function prototypes
  5. *
  6. * Copyright (C) 2000 - 2022, Intel Corp.
  7. *
  8. *****************************************************************************/
  9. #ifndef __ACRESRC_H__
  10. #define __ACRESRC_H__
  11. /* Need the AML resource descriptor structs */
  12. #include "amlresrc.h"
  13. /*
  14. * If possible, pack the following structures to byte alignment, since we
  15. * don't care about performance for debug output. Two cases where we cannot
  16. * pack the structures:
  17. *
  18. * 1) Hardware does not support misaligned memory transfers
  19. * 2) Compiler does not support pointers within packed structures
  20. */
  21. #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
  22. #pragma pack(1)
  23. #endif
  24. /*
  25. * Individual entry for the resource conversion tables
  26. */
  27. typedef const struct acpi_rsconvert_info {
  28. u8 opcode;
  29. u8 resource_offset;
  30. u8 aml_offset;
  31. u8 value;
  32. } acpi_rsconvert_info;
  33. /* Resource conversion opcodes */
  34. typedef enum {
  35. ACPI_RSC_INITGET = 0,
  36. ACPI_RSC_INITSET,
  37. ACPI_RSC_FLAGINIT,
  38. ACPI_RSC_1BITFLAG,
  39. ACPI_RSC_2BITFLAG,
  40. ACPI_RSC_3BITFLAG,
  41. ACPI_RSC_6BITFLAG,
  42. ACPI_RSC_ADDRESS,
  43. ACPI_RSC_BITMASK,
  44. ACPI_RSC_BITMASK16,
  45. ACPI_RSC_COUNT,
  46. ACPI_RSC_COUNT16,
  47. ACPI_RSC_COUNT_GPIO_PIN,
  48. ACPI_RSC_COUNT_GPIO_RES,
  49. ACPI_RSC_COUNT_GPIO_VEN,
  50. ACPI_RSC_COUNT_SERIAL_RES,
  51. ACPI_RSC_COUNT_SERIAL_VEN,
  52. ACPI_RSC_DATA8,
  53. ACPI_RSC_EXIT_EQ,
  54. ACPI_RSC_EXIT_LE,
  55. ACPI_RSC_EXIT_NE,
  56. ACPI_RSC_LENGTH,
  57. ACPI_RSC_MOVE_GPIO_PIN,
  58. ACPI_RSC_MOVE_GPIO_RES,
  59. ACPI_RSC_MOVE_SERIAL_RES,
  60. ACPI_RSC_MOVE_SERIAL_VEN,
  61. ACPI_RSC_MOVE8,
  62. ACPI_RSC_MOVE16,
  63. ACPI_RSC_MOVE32,
  64. ACPI_RSC_MOVE64,
  65. ACPI_RSC_SET8,
  66. ACPI_RSC_SOURCE,
  67. ACPI_RSC_SOURCEX
  68. } ACPI_RSCONVERT_OPCODES;
  69. /* Resource Conversion sub-opcodes */
  70. #define ACPI_RSC_COMPARE_AML_LENGTH 0
  71. #define ACPI_RSC_COMPARE_VALUE 1
  72. #define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (struct acpi_rsconvert_info))
  73. #define ACPI_RS_OFFSET(f) (u8) ACPI_OFFSET (struct acpi_resource,f)
  74. #define AML_OFFSET(f) (u8) ACPI_OFFSET (union aml_resource,f)
  75. /*
  76. * Individual entry for the resource dump tables
  77. */
  78. typedef const struct acpi_rsdump_info {
  79. u8 opcode;
  80. u8 offset;
  81. const char *name;
  82. const char **pointer;
  83. } acpi_rsdump_info;
  84. /* Values for the Opcode field above */
  85. typedef enum {
  86. ACPI_RSD_TITLE = 0,
  87. ACPI_RSD_1BITFLAG,
  88. ACPI_RSD_2BITFLAG,
  89. ACPI_RSD_3BITFLAG,
  90. ACPI_RSD_6BITFLAG,
  91. ACPI_RSD_ADDRESS,
  92. ACPI_RSD_DWORDLIST,
  93. ACPI_RSD_LITERAL,
  94. ACPI_RSD_LONGLIST,
  95. ACPI_RSD_SHORTLIST,
  96. ACPI_RSD_SHORTLISTX,
  97. ACPI_RSD_SOURCE,
  98. ACPI_RSD_STRING,
  99. ACPI_RSD_UINT8,
  100. ACPI_RSD_UINT16,
  101. ACPI_RSD_UINT32,
  102. ACPI_RSD_UINT64,
  103. ACPI_RSD_WORDLIST,
  104. ACPI_RSD_LABEL,
  105. ACPI_RSD_SOURCE_LABEL,
  106. } ACPI_RSDUMP_OPCODES;
  107. /* restore default alignment */
  108. #pragma pack()
  109. /* Resource tables indexed by internal resource type */
  110. extern const u8 acpi_gbl_aml_resource_sizes[];
  111. extern const u8 acpi_gbl_aml_resource_serial_bus_sizes[];
  112. extern struct acpi_rsconvert_info *acpi_gbl_set_resource_dispatch[];
  113. /* Resource tables indexed by raw AML resource descriptor type */
  114. extern const u8 acpi_gbl_resource_struct_sizes[];
  115. extern const u8 acpi_gbl_resource_struct_serial_bus_sizes[];
  116. extern struct acpi_rsconvert_info *acpi_gbl_get_resource_dispatch[];
  117. extern struct acpi_rsconvert_info
  118. *acpi_gbl_convert_resource_serial_bus_dispatch[];
  119. struct acpi_vendor_walk_info {
  120. struct acpi_vendor_uuid *uuid;
  121. struct acpi_buffer *buffer;
  122. acpi_status status;
  123. };
  124. /*
  125. * rscreate
  126. */
  127. acpi_status
  128. acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
  129. struct acpi_buffer *output_buffer);
  130. acpi_status
  131. acpi_rs_create_aml_resources(struct acpi_buffer *resource_list,
  132. struct acpi_buffer *output_buffer);
  133. acpi_status
  134. acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
  135. struct acpi_buffer *output_buffer);
  136. /*
  137. * rsutils
  138. */
  139. acpi_status
  140. acpi_rs_get_prt_method_data(struct acpi_namespace_node *node,
  141. struct acpi_buffer *ret_buffer);
  142. acpi_status
  143. acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
  144. struct acpi_buffer *ret_buffer);
  145. acpi_status
  146. acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
  147. struct acpi_buffer *ret_buffer);
  148. acpi_status
  149. acpi_rs_get_method_data(acpi_handle handle,
  150. const char *path, struct acpi_buffer *ret_buffer);
  151. acpi_status
  152. acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
  153. struct acpi_buffer *ret_buffer);
  154. acpi_status
  155. acpi_rs_get_aei_method_data(struct acpi_namespace_node *node,
  156. struct acpi_buffer *ret_buffer);
  157. /*
  158. * rscalc
  159. */
  160. acpi_status
  161. acpi_rs_get_list_length(u8 *aml_buffer,
  162. u32 aml_buffer_length, acpi_size *size_needed);
  163. acpi_status
  164. acpi_rs_get_aml_length(struct acpi_resource *resource_list,
  165. acpi_size resource_list_size, acpi_size *size_needed);
  166. acpi_status
  167. acpi_rs_get_pci_routing_table_length(union acpi_operand_object *package_object,
  168. acpi_size *buffer_size_needed);
  169. acpi_status
  170. acpi_rs_convert_aml_to_resources(u8 * aml,
  171. u32 length,
  172. u32 offset, u8 resource_index, void **context);
  173. acpi_status
  174. acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
  175. acpi_size aml_size_needed, u8 * output_buffer);
  176. /*
  177. * rsaddr
  178. */
  179. void
  180. acpi_rs_set_address_common(union aml_resource *aml,
  181. struct acpi_resource *resource);
  182. u8
  183. acpi_rs_get_address_common(struct acpi_resource *resource,
  184. union aml_resource *aml);
  185. /*
  186. * rsmisc
  187. */
  188. acpi_status
  189. acpi_rs_convert_aml_to_resource(struct acpi_resource *resource,
  190. union aml_resource *aml,
  191. struct acpi_rsconvert_info *info);
  192. acpi_status
  193. acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
  194. union aml_resource *aml,
  195. struct acpi_rsconvert_info *info);
  196. /*
  197. * rsutils
  198. */
  199. void
  200. acpi_rs_move_data(void *destination,
  201. void *source, u16 item_count, u8 move_type);
  202. u8 acpi_rs_decode_bitmask(u16 mask, u8 * list);
  203. u16 acpi_rs_encode_bitmask(u8 * list, u8 count);
  204. acpi_rs_length
  205. acpi_rs_get_resource_source(acpi_rs_length resource_length,
  206. acpi_rs_length minimum_length,
  207. struct acpi_resource_source *resource_source,
  208. union aml_resource *aml, char *string_ptr);
  209. acpi_rsdesc_size
  210. acpi_rs_set_resource_source(union aml_resource *aml,
  211. acpi_rs_length minimum_length,
  212. struct acpi_resource_source *resource_source);
  213. void
  214. acpi_rs_set_resource_header(u8 descriptor_type,
  215. acpi_rsdesc_size total_length,
  216. union aml_resource *aml);
  217. void
  218. acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
  219. union aml_resource *aml);
  220. /*
  221. * rsdump - Debugger support
  222. */
  223. #ifdef ACPI_DEBUGGER
  224. void acpi_rs_dump_resource_list(struct acpi_resource *resource);
  225. void acpi_rs_dump_irq_list(u8 *route_table);
  226. #endif
  227. /*
  228. * Resource conversion tables
  229. */
  230. extern struct acpi_rsconvert_info acpi_rs_convert_dma[];
  231. extern struct acpi_rsconvert_info acpi_rs_convert_end_dpf[];
  232. extern struct acpi_rsconvert_info acpi_rs_convert_io[];
  233. extern struct acpi_rsconvert_info acpi_rs_convert_fixed_io[];
  234. extern struct acpi_rsconvert_info acpi_rs_convert_end_tag[];
  235. extern struct acpi_rsconvert_info acpi_rs_convert_memory24[];
  236. extern struct acpi_rsconvert_info acpi_rs_convert_generic_reg[];
  237. extern struct acpi_rsconvert_info acpi_rs_convert_memory32[];
  238. extern struct acpi_rsconvert_info acpi_rs_convert_fixed_memory32[];
  239. extern struct acpi_rsconvert_info acpi_rs_convert_address32[];
  240. extern struct acpi_rsconvert_info acpi_rs_convert_address16[];
  241. extern struct acpi_rsconvert_info acpi_rs_convert_ext_irq[];
  242. extern struct acpi_rsconvert_info acpi_rs_convert_address64[];
  243. extern struct acpi_rsconvert_info acpi_rs_convert_ext_address64[];
  244. extern struct acpi_rsconvert_info acpi_rs_convert_gpio[];
  245. extern struct acpi_rsconvert_info acpi_rs_convert_fixed_dma[];
  246. extern struct acpi_rsconvert_info acpi_rs_convert_csi2_serial_bus[];
  247. extern struct acpi_rsconvert_info acpi_rs_convert_i2c_serial_bus[];
  248. extern struct acpi_rsconvert_info acpi_rs_convert_spi_serial_bus[];
  249. extern struct acpi_rsconvert_info acpi_rs_convert_uart_serial_bus[];
  250. extern struct acpi_rsconvert_info acpi_rs_convert_pin_function[];
  251. extern struct acpi_rsconvert_info acpi_rs_convert_pin_config[];
  252. extern struct acpi_rsconvert_info acpi_rs_convert_pin_group[];
  253. extern struct acpi_rsconvert_info acpi_rs_convert_pin_group_function[];
  254. extern struct acpi_rsconvert_info acpi_rs_convert_pin_group_config[];
  255. /* These resources require separate get/set tables */
  256. extern struct acpi_rsconvert_info acpi_rs_get_irq[];
  257. extern struct acpi_rsconvert_info acpi_rs_get_start_dpf[];
  258. extern struct acpi_rsconvert_info acpi_rs_get_vendor_small[];
  259. extern struct acpi_rsconvert_info acpi_rs_get_vendor_large[];
  260. extern struct acpi_rsconvert_info acpi_rs_set_irq[];
  261. extern struct acpi_rsconvert_info acpi_rs_set_start_dpf[];
  262. extern struct acpi_rsconvert_info acpi_rs_set_vendor[];
  263. #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
  264. /*
  265. * rsinfo
  266. */
  267. extern struct acpi_rsdump_info *acpi_gbl_dump_resource_dispatch[];
  268. extern struct acpi_rsdump_info *acpi_gbl_dump_serial_bus_dispatch[];
  269. /*
  270. * rsdumpinfo
  271. */
  272. extern struct acpi_rsdump_info acpi_rs_dump_irq[];
  273. extern struct acpi_rsdump_info acpi_rs_dump_prt[];
  274. extern struct acpi_rsdump_info acpi_rs_dump_dma[];
  275. extern struct acpi_rsdump_info acpi_rs_dump_start_dpf[];
  276. extern struct acpi_rsdump_info acpi_rs_dump_end_dpf[];
  277. extern struct acpi_rsdump_info acpi_rs_dump_io[];
  278. extern struct acpi_rsdump_info acpi_rs_dump_io_flags[];
  279. extern struct acpi_rsdump_info acpi_rs_dump_fixed_io[];
  280. extern struct acpi_rsdump_info acpi_rs_dump_vendor[];
  281. extern struct acpi_rsdump_info acpi_rs_dump_end_tag[];
  282. extern struct acpi_rsdump_info acpi_rs_dump_memory24[];
  283. extern struct acpi_rsdump_info acpi_rs_dump_memory32[];
  284. extern struct acpi_rsdump_info acpi_rs_dump_memory_flags[];
  285. extern struct acpi_rsdump_info acpi_rs_dump_fixed_memory32[];
  286. extern struct acpi_rsdump_info acpi_rs_dump_address16[];
  287. extern struct acpi_rsdump_info acpi_rs_dump_address32[];
  288. extern struct acpi_rsdump_info acpi_rs_dump_address64[];
  289. extern struct acpi_rsdump_info acpi_rs_dump_ext_address64[];
  290. extern struct acpi_rsdump_info acpi_rs_dump_ext_irq[];
  291. extern struct acpi_rsdump_info acpi_rs_dump_generic_reg[];
  292. extern struct acpi_rsdump_info acpi_rs_dump_gpio[];
  293. extern struct acpi_rsdump_info acpi_rs_dump_pin_function[];
  294. extern struct acpi_rsdump_info acpi_rs_dump_fixed_dma[];
  295. extern struct acpi_rsdump_info acpi_rs_dump_common_serial_bus[];
  296. extern struct acpi_rsdump_info acpi_rs_dump_csi2_serial_bus[];
  297. extern struct acpi_rsdump_info acpi_rs_dump_i2c_serial_bus[];
  298. extern struct acpi_rsdump_info acpi_rs_dump_spi_serial_bus[];
  299. extern struct acpi_rsdump_info acpi_rs_dump_uart_serial_bus[];
  300. extern struct acpi_rsdump_info acpi_rs_dump_general_flags[];
  301. extern struct acpi_rsdump_info acpi_rs_dump_pin_config[];
  302. extern struct acpi_rsdump_info acpi_rs_dump_pin_group[];
  303. extern struct acpi_rsdump_info acpi_rs_dump_pin_group_function[];
  304. extern struct acpi_rsdump_info acpi_rs_dump_pin_group_config[];
  305. #endif
  306. #endif /* __ACRESRC_H__ */