acpi/acpica/acresrc.h

0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Name: acresrc.h - Resource Manager function prototypes
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009
0010 #ifndef __ACRESRC_H__
0011 #define __ACRESRC_H__
0012
0013 /* Need the AML resource descriptor structs */
0014
0015 #include "amlresrc.h"
0016
0017 /*
0018  * If possible, pack the following structures to byte alignment, since we
0019  * don't care about performance for debug output. Two cases where we cannot
0020  * pack the structures:
0021  *
0022  * 1) Hardware does not support misaligned memory transfers
0023  * 2) Compiler does not support pointers within packed structures
0024  */
0025 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
0026 #pragma pack(1)
0027 #endif
0028
0029 /*
0030  * Individual entry for the resource conversion tables
0031  */
0032 typedef const struct acpi_rsconvert_info {
0033     u8 opcode;
0034     u8 resource_offset;
0035     u8 aml_offset;
0036     u8 value;
0037
0038 } acpi_rsconvert_info;
0039
0040 /* Resource conversion opcodes */
0041
0042 typedef enum {
0043     ACPI_RSC_INITGET = 0,
0044     ACPI_RSC_INITSET,
0045     ACPI_RSC_FLAGINIT,
0046     ACPI_RSC_1BITFLAG,
0047     ACPI_RSC_2BITFLAG,
0048     ACPI_RSC_3BITFLAG,
0049     ACPI_RSC_6BITFLAG,
0050     ACPI_RSC_ADDRESS,
0051     ACPI_RSC_BITMASK,
0052     ACPI_RSC_BITMASK16,
0053     ACPI_RSC_COUNT,
0054     ACPI_RSC_COUNT16,
0055     ACPI_RSC_COUNT_GPIO_PIN,
0056     ACPI_RSC_COUNT_GPIO_RES,
0057     ACPI_RSC_COUNT_GPIO_VEN,
0058     ACPI_RSC_COUNT_SERIAL_RES,
0059     ACPI_RSC_COUNT_SERIAL_VEN,
0060     ACPI_RSC_DATA8,
0061     ACPI_RSC_EXIT_EQ,
0062     ACPI_RSC_EXIT_LE,
0063     ACPI_RSC_EXIT_NE,
0064     ACPI_RSC_LENGTH,
0065     ACPI_RSC_MOVE_GPIO_PIN,
0066     ACPI_RSC_MOVE_GPIO_RES,
0067     ACPI_RSC_MOVE_SERIAL_RES,
0068     ACPI_RSC_MOVE_SERIAL_VEN,
0069     ACPI_RSC_MOVE8,
0070     ACPI_RSC_MOVE16,
0071     ACPI_RSC_MOVE32,
0072     ACPI_RSC_MOVE64,
0073     ACPI_RSC_SET8,
0074     ACPI_RSC_SOURCE,
0075     ACPI_RSC_SOURCEX
0076 } ACPI_RSCONVERT_OPCODES;
0077
0078 /* Resource Conversion sub-opcodes */
0079
0080 #define ACPI_RSC_COMPARE_AML_LENGTH     0
0081 #define ACPI_RSC_COMPARE_VALUE          1
0082
0083 #define ACPI_RSC_TABLE_SIZE(d)          (sizeof (d) / sizeof (struct acpi_rsconvert_info))
0084
0085 #define ACPI_RS_OFFSET(f)               (u8) ACPI_OFFSET (struct acpi_resource,f)
0086 #define AML_OFFSET(f)                   (u8) ACPI_OFFSET (union aml_resource,f)
0087
0088 /*
0089  * Individual entry for the resource dump tables
0090  */
0091 typedef const struct acpi_rsdump_info {
0092     u8 opcode;
0093     u8 offset;
0094     const char *name;
0095     const char **pointer;
0096
0097 } acpi_rsdump_info;
0098
0099 /* Values for the Opcode field above */
0100
0101 typedef enum {
0102     ACPI_RSD_TITLE = 0,
0103     ACPI_RSD_1BITFLAG,
0104     ACPI_RSD_2BITFLAG,
0105     ACPI_RSD_3BITFLAG,
0106     ACPI_RSD_6BITFLAG,
0107     ACPI_RSD_ADDRESS,
0108     ACPI_RSD_DWORDLIST,
0109     ACPI_RSD_LITERAL,
0110     ACPI_RSD_LONGLIST,
0111     ACPI_RSD_SHORTLIST,
0112     ACPI_RSD_SHORTLISTX,
0113     ACPI_RSD_SOURCE,
0114     ACPI_RSD_STRING,
0115     ACPI_RSD_UINT8,
0116     ACPI_RSD_UINT16,
0117     ACPI_RSD_UINT32,
0118     ACPI_RSD_UINT64,
0119     ACPI_RSD_WORDLIST,
0120     ACPI_RSD_LABEL,
0121     ACPI_RSD_SOURCE_LABEL,
0122
0123 } ACPI_RSDUMP_OPCODES;
0124
0125 /* restore default alignment */
0126
0127 #pragma pack()
0128
0129 /* Resource tables indexed by internal resource type */
0130
0131 extern const u8 acpi_gbl_aml_resource_sizes[];
0132 extern const u8 acpi_gbl_aml_resource_serial_bus_sizes[];
0133 extern struct acpi_rsconvert_info *acpi_gbl_set_resource_dispatch[];
0134
0135 /* Resource tables indexed by raw AML resource descriptor type */
0136
0137 extern const u8 acpi_gbl_resource_struct_sizes[];
0138 extern const u8 acpi_gbl_resource_struct_serial_bus_sizes[];
0139 extern struct acpi_rsconvert_info *acpi_gbl_get_resource_dispatch[];
0140
0141 extern struct acpi_rsconvert_info
0142     *acpi_gbl_convert_resource_serial_bus_dispatch[];
0143
0144 struct acpi_vendor_walk_info {
0145     struct acpi_vendor_uuid *uuid;
0146     struct acpi_buffer *buffer;
0147     acpi_status status;
0148 };
0149
0150 /*
0151  * rscreate
0152  */
0153 acpi_status
0154 acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
0155                  struct acpi_buffer *output_buffer);
0156
0157 acpi_status
0158 acpi_rs_create_aml_resources(struct acpi_buffer *resource_list,
0159                  struct acpi_buffer *output_buffer);
0160
0161 acpi_status
0162 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
0163                  struct acpi_buffer *output_buffer);
0164
0165 /*
0166  * rsutils
0167  */
0168
0169 acpi_status
0170 acpi_rs_get_prt_method_data(struct acpi_namespace_node *node,
0171                 struct acpi_buffer *ret_buffer);
0172
0173 acpi_status
0174 acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
0175                 struct acpi_buffer *ret_buffer);
0176
0177 acpi_status
0178 acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
0179                 struct acpi_buffer *ret_buffer);
0180
0181 acpi_status
0182 acpi_rs_get_method_data(acpi_handle handle,
0183             const char *path, struct acpi_buffer *ret_buffer);
0184
0185 acpi_status
0186 acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
0187                 struct acpi_buffer *ret_buffer);
0188
0189 acpi_status
0190 acpi_rs_get_aei_method_data(struct acpi_namespace_node *node,
0191                 struct acpi_buffer *ret_buffer);
0192
0193 /*
0194  * rscalc
0195  */
0196 acpi_status
0197 acpi_rs_get_list_length(u8 *aml_buffer,
0198             u32 aml_buffer_length, acpi_size *size_needed);
0199
0200 acpi_status
0201 acpi_rs_get_aml_length(struct acpi_resource *resource_list,
0202                acpi_size resource_list_size, acpi_size *size_needed);
0203
0204 acpi_status
0205 acpi_rs_get_pci_routing_table_length(union acpi_operand_object *package_object,
0206                      acpi_size *buffer_size_needed);
0207
0208 acpi_status
0209 acpi_rs_convert_aml_to_resources(u8 * aml,
0210                  u32 length,
0211                  u32 offset, u8 resource_index, void **context);
0212
0213 acpi_status
0214 acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
0215                  acpi_size aml_size_needed, u8 * output_buffer);
0216
0217 /*
0218  * rsaddr
0219  */
0220 void
0221 acpi_rs_set_address_common(union aml_resource *aml,
0222                struct acpi_resource *resource);
0223
0224 u8
0225 acpi_rs_get_address_common(struct acpi_resource *resource,
0226                union aml_resource *aml);
0227
0228 /*
0229  * rsmisc
0230  */
0231 acpi_status
0232 acpi_rs_convert_aml_to_resource(struct acpi_resource *resource,
0233                 union aml_resource *aml,
0234                 struct acpi_rsconvert_info *info);
0235
0236 acpi_status
0237 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
0238                 union aml_resource *aml,
0239                 struct acpi_rsconvert_info *info);
0240
0241 /*
0242  * rsutils
0243  */
0244 void
0245 acpi_rs_move_data(void *destination,
0246           void *source, u16 item_count, u8 move_type);
0247
0248 u8 acpi_rs_decode_bitmask(u16 mask, u8 * list);
0249
0250 u16 acpi_rs_encode_bitmask(u8 * list, u8 count);
0251
0252 acpi_rs_length
0253 acpi_rs_get_resource_source(acpi_rs_length resource_length,
0254                 acpi_rs_length minimum_length,
0255                 struct acpi_resource_source *resource_source,
0256                 union aml_resource *aml, char *string_ptr);
0257
0258 acpi_rsdesc_size
0259 acpi_rs_set_resource_source(union aml_resource *aml,
0260                 acpi_rs_length minimum_length,
0261                 struct acpi_resource_source *resource_source);
0262
0263 void
0264 acpi_rs_set_resource_header(u8 descriptor_type,
0265                 acpi_rsdesc_size total_length,
0266                 union aml_resource *aml);
0267
0268 void
0269 acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
0270                 union aml_resource *aml);
0271
0272 /*
0273  * rsdump - Debugger support
0274  */
0275 #ifdef ACPI_DEBUGGER
0276 void acpi_rs_dump_resource_list(struct acpi_resource *resource);
0277
0278 void acpi_rs_dump_irq_list(u8 *route_table);
0279 #endif
0280
0281 /*
0282  * Resource conversion tables
0283  */
0284 extern struct acpi_rsconvert_info acpi_rs_convert_dma[];
0285 extern struct acpi_rsconvert_info acpi_rs_convert_end_dpf[];
0286 extern struct acpi_rsconvert_info acpi_rs_convert_io[];
0287 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_io[];
0288 extern struct acpi_rsconvert_info acpi_rs_convert_end_tag[];
0289 extern struct acpi_rsconvert_info acpi_rs_convert_memory24[];
0290 extern struct acpi_rsconvert_info acpi_rs_convert_generic_reg[];
0291 extern struct acpi_rsconvert_info acpi_rs_convert_memory32[];
0292 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_memory32[];
0293 extern struct acpi_rsconvert_info acpi_rs_convert_address32[];
0294 extern struct acpi_rsconvert_info acpi_rs_convert_address16[];
0295 extern struct acpi_rsconvert_info acpi_rs_convert_ext_irq[];
0296 extern struct acpi_rsconvert_info acpi_rs_convert_address64[];
0297 extern struct acpi_rsconvert_info acpi_rs_convert_ext_address64[];
0298 extern struct acpi_rsconvert_info acpi_rs_convert_gpio[];
0299 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_dma[];
0300 extern struct acpi_rsconvert_info acpi_rs_convert_csi2_serial_bus[];
0301 extern struct acpi_rsconvert_info acpi_rs_convert_i2c_serial_bus[];
0302 extern struct acpi_rsconvert_info acpi_rs_convert_spi_serial_bus[];
0303 extern struct acpi_rsconvert_info acpi_rs_convert_uart_serial_bus[];
0304 extern struct acpi_rsconvert_info acpi_rs_convert_pin_function[];
0305 extern struct acpi_rsconvert_info acpi_rs_convert_pin_config[];
0306 extern struct acpi_rsconvert_info acpi_rs_convert_pin_group[];
0307 extern struct acpi_rsconvert_info acpi_rs_convert_pin_group_function[];
0308 extern struct acpi_rsconvert_info acpi_rs_convert_pin_group_config[];
0309
0310 /* These resources require separate get/set tables */
0311
0312 extern struct acpi_rsconvert_info acpi_rs_get_irq[];
0313 extern struct acpi_rsconvert_info acpi_rs_get_start_dpf[];
0314 extern struct acpi_rsconvert_info acpi_rs_get_vendor_small[];
0315 extern struct acpi_rsconvert_info acpi_rs_get_vendor_large[];
0316
0317 extern struct acpi_rsconvert_info acpi_rs_set_irq[];
0318 extern struct acpi_rsconvert_info acpi_rs_set_start_dpf[];
0319 extern struct acpi_rsconvert_info acpi_rs_set_vendor[];
0320
0321 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
0322 /*
0323  * rsinfo
0324  */
0325 extern struct acpi_rsdump_info *acpi_gbl_dump_resource_dispatch[];
0326 extern struct acpi_rsdump_info *acpi_gbl_dump_serial_bus_dispatch[];
0327
0328 /*
0329  * rsdumpinfo
0330  */
0331 extern struct acpi_rsdump_info acpi_rs_dump_irq[];
0332 extern struct acpi_rsdump_info acpi_rs_dump_prt[];
0333 extern struct acpi_rsdump_info acpi_rs_dump_dma[];
0334 extern struct acpi_rsdump_info acpi_rs_dump_start_dpf[];
0335 extern struct acpi_rsdump_info acpi_rs_dump_end_dpf[];
0336 extern struct acpi_rsdump_info acpi_rs_dump_io[];
0337 extern struct acpi_rsdump_info acpi_rs_dump_io_flags[];
0338 extern struct acpi_rsdump_info acpi_rs_dump_fixed_io[];
0339 extern struct acpi_rsdump_info acpi_rs_dump_vendor[];
0340 extern struct acpi_rsdump_info acpi_rs_dump_end_tag[];
0341 extern struct acpi_rsdump_info acpi_rs_dump_memory24[];
0342 extern struct acpi_rsdump_info acpi_rs_dump_memory32[];
0343 extern struct acpi_rsdump_info acpi_rs_dump_memory_flags[];
0344 extern struct acpi_rsdump_info acpi_rs_dump_fixed_memory32[];
0345 extern struct acpi_rsdump_info acpi_rs_dump_address16[];
0346 extern struct acpi_rsdump_info acpi_rs_dump_address32[];
0347 extern struct acpi_rsdump_info acpi_rs_dump_address64[];
0348 extern struct acpi_rsdump_info acpi_rs_dump_ext_address64[];
0349 extern struct acpi_rsdump_info acpi_rs_dump_ext_irq[];
0350 extern struct acpi_rsdump_info acpi_rs_dump_generic_reg[];
0351 extern struct acpi_rsdump_info acpi_rs_dump_gpio[];
0352 extern struct acpi_rsdump_info acpi_rs_dump_pin_function[];
0353 extern struct acpi_rsdump_info acpi_rs_dump_fixed_dma[];
0354 extern struct acpi_rsdump_info acpi_rs_dump_common_serial_bus[];
0355 extern struct acpi_rsdump_info acpi_rs_dump_csi2_serial_bus[];
0356 extern struct acpi_rsdump_info acpi_rs_dump_i2c_serial_bus[];
0357 extern struct acpi_rsdump_info acpi_rs_dump_spi_serial_bus[];
0358 extern struct acpi_rsdump_info acpi_rs_dump_uart_serial_bus[];
0359 extern struct acpi_rsdump_info acpi_rs_dump_general_flags[];
0360 extern struct acpi_rsdump_info acpi_rs_dump_pin_config[];
0361 extern struct acpi_rsdump_info acpi_rs_dump_pin_group[];
0362 extern struct acpi_rsdump_info acpi_rs_dump_pin_group_function[];
0363 extern struct acpi_rsdump_info acpi_rs_dump_pin_group_config[];
0364 #endif
0365
0366 #endif              /* __ACRESRC_H__ */