Gitiles
Code Review Sign In
192.168.1.100 / T103 / 1f884588077ad3476b9c91cbb0ee9ee0332bbb68 / . / src / kernel / linux / v4.14 / drivers / acpi / acpica / acresrc.h
blob: 438f3098a093a3e39ccc3ec8be87d91d46d2c8fd [file] [log] [blame]
rjw1f884582022-01-06 17:20:42 +0800[diff] [blame^]1/******************************************************************************
2 *
3 * Name: acresrc.h - Resource Manager function prototypes
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2017, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef __ACRESRC_H__
45#define __ACRESRC_H__
46
47/* Need the AML resource descriptor structs */
48
49#include "amlresrc.h"
50
51/*
52 * If possible, pack the following structures to byte alignment, since we
53 * don't care about performance for debug output. Two cases where we cannot
54 * pack the structures:
55 *
56 * 1) Hardware does not support misaligned memory transfers
57 * 2) Compiler does not support pointers within packed structures
58 */
59#if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
60#pragma pack(1)
61#endif
62
63/*
64 * Individual entry for the resource conversion tables
65 */
66typedef const struct acpi_rsconvert_info {
67 u8 opcode;
68 u8 resource_offset;
69 u8 aml_offset;
70 u8 value;
71
72} acpi_rsconvert_info;
73
74/* Resource conversion opcodes */
75
76typedef enum {
77 ACPI_RSC_INITGET = 0,
78 ACPI_RSC_INITSET,
79 ACPI_RSC_FLAGINIT,
80 ACPI_RSC_1BITFLAG,
81 ACPI_RSC_2BITFLAG,
82 ACPI_RSC_3BITFLAG,
83 ACPI_RSC_ADDRESS,
84 ACPI_RSC_BITMASK,
85 ACPI_RSC_BITMASK16,
86 ACPI_RSC_COUNT,
87 ACPI_RSC_COUNT16,
88 ACPI_RSC_COUNT_GPIO_PIN,
89 ACPI_RSC_COUNT_GPIO_RES,
90 ACPI_RSC_COUNT_GPIO_VEN,
91 ACPI_RSC_COUNT_SERIAL_RES,
92 ACPI_RSC_COUNT_SERIAL_VEN,
93 ACPI_RSC_DATA8,
94 ACPI_RSC_EXIT_EQ,
95 ACPI_RSC_EXIT_LE,
96 ACPI_RSC_EXIT_NE,
97 ACPI_RSC_LENGTH,
98 ACPI_RSC_MOVE_GPIO_PIN,
99 ACPI_RSC_MOVE_GPIO_RES,
100 ACPI_RSC_MOVE_SERIAL_RES,
101 ACPI_RSC_MOVE_SERIAL_VEN,
102 ACPI_RSC_MOVE8,
103 ACPI_RSC_MOVE16,
104 ACPI_RSC_MOVE32,
105 ACPI_RSC_MOVE64,
106 ACPI_RSC_SET8,
107 ACPI_RSC_SOURCE,
108 ACPI_RSC_SOURCEX
109} ACPI_RSCONVERT_OPCODES;
110
111/* Resource Conversion sub-opcodes */
112
113#define ACPI_RSC_COMPARE_AML_LENGTH 0
114#define ACPI_RSC_COMPARE_VALUE 1
115
116#define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (struct acpi_rsconvert_info))
117
118#define ACPI_RS_OFFSET(f) (u8) ACPI_OFFSET (struct acpi_resource,f)
119#define AML_OFFSET(f) (u8) ACPI_OFFSET (union aml_resource,f)
120
121/*
122 * Individual entry for the resource dump tables
123 */
124typedef const struct acpi_rsdump_info {
125 u8 opcode;
126 u8 offset;
127 const char *name;
128 const char **pointer;
129
130} acpi_rsdump_info;
131
132/* Values for the Opcode field above */
133
134typedef enum {
135 ACPI_RSD_TITLE = 0,
136 ACPI_RSD_1BITFLAG,
137 ACPI_RSD_2BITFLAG,
138 ACPI_RSD_3BITFLAG,
139 ACPI_RSD_ADDRESS,
140 ACPI_RSD_DWORDLIST,
141 ACPI_RSD_LITERAL,
142 ACPI_RSD_LONGLIST,
143 ACPI_RSD_SHORTLIST,
144 ACPI_RSD_SHORTLISTX,
145 ACPI_RSD_SOURCE,
146 ACPI_RSD_STRING,
147 ACPI_RSD_UINT8,
148 ACPI_RSD_UINT16,
149 ACPI_RSD_UINT32,
150 ACPI_RSD_UINT64,
151 ACPI_RSD_WORDLIST,
152 ACPI_RSD_LABEL,
153 ACPI_RSD_SOURCE_LABEL,
154
155} ACPI_RSDUMP_OPCODES;
156
157/* restore default alignment */
158
159#pragma pack()
160
161/* Resource tables indexed by internal resource type */
162
163extern const u8 acpi_gbl_aml_resource_sizes[];
164extern const u8 acpi_gbl_aml_resource_serial_bus_sizes[];
165extern struct acpi_rsconvert_info *acpi_gbl_set_resource_dispatch[];
166
167/* Resource tables indexed by raw AML resource descriptor type */
168
169extern const u8 acpi_gbl_resource_struct_sizes[];
170extern const u8 acpi_gbl_resource_struct_serial_bus_sizes[];
171extern struct acpi_rsconvert_info *acpi_gbl_get_resource_dispatch[];
172
173extern struct acpi_rsconvert_info
174 *acpi_gbl_convert_resource_serial_bus_dispatch[];
175
176struct acpi_vendor_walk_info {
177 struct acpi_vendor_uuid *uuid;
178 struct acpi_buffer *buffer;
179 acpi_status status;
180};
181
182/*
183 * rscreate
184 */
185acpi_status
186acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
187 struct acpi_buffer *output_buffer);
188
189acpi_status
190acpi_rs_create_aml_resources(struct acpi_buffer *resource_list,
191 struct acpi_buffer *output_buffer);
192
193acpi_status
194acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
195 struct acpi_buffer *output_buffer);
196
197/*
198 * rsutils
199 */
200
201acpi_status
202acpi_rs_get_prt_method_data(struct acpi_namespace_node *node,
203 struct acpi_buffer *ret_buffer);
204
205acpi_status
206acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
207 struct acpi_buffer *ret_buffer);
208
209acpi_status
210acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
211 struct acpi_buffer *ret_buffer);
212
213acpi_status
214acpi_rs_get_method_data(acpi_handle handle,
215 const char *path, struct acpi_buffer *ret_buffer);
216
217acpi_status
218acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
219 struct acpi_buffer *ret_buffer);
220
221acpi_status
222acpi_rs_get_aei_method_data(struct acpi_namespace_node *node,
223 struct acpi_buffer *ret_buffer);
224
225/*
226 * rscalc
227 */
228acpi_status
229acpi_rs_get_list_length(u8 *aml_buffer,
230 u32 aml_buffer_length, acpi_size *size_needed);
231
232acpi_status
233acpi_rs_get_aml_length(struct acpi_resource *resource_list,
234 acpi_size resource_list_size, acpi_size *size_needed);
235
236acpi_status
237acpi_rs_get_pci_routing_table_length(union acpi_operand_object *package_object,
238 acpi_size *buffer_size_needed);
239
240acpi_status
241acpi_rs_convert_aml_to_resources(u8 * aml,
242 u32 length,
243 u32 offset, u8 resource_index, void **context);
244
245acpi_status
246acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
247 acpi_size aml_size_needed, u8 * output_buffer);
248
249/*
250 * rsaddr
251 */
252void
253acpi_rs_set_address_common(union aml_resource *aml,
254 struct acpi_resource *resource);
255
256u8
257acpi_rs_get_address_common(struct acpi_resource *resource,
258 union aml_resource *aml);
259
260/*
261 * rsmisc
262 */
263acpi_status
264acpi_rs_convert_aml_to_resource(struct acpi_resource *resource,
265 union aml_resource *aml,
266 struct acpi_rsconvert_info *info);
267
268acpi_status
269acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
270 union aml_resource *aml,
271 struct acpi_rsconvert_info *info);
272
273/*
274 * rsutils
275 */
276void
277acpi_rs_move_data(void *destination,
278 void *source, u16 item_count, u8 move_type);
279
280u8 acpi_rs_decode_bitmask(u16 mask, u8 * list);
281
282u16 acpi_rs_encode_bitmask(u8 * list, u8 count);
283
284acpi_rs_length
285acpi_rs_get_resource_source(acpi_rs_length resource_length,
286 acpi_rs_length minimum_length,
287 struct acpi_resource_source *resource_source,
288 union aml_resource *aml, char *string_ptr);
289
290acpi_rsdesc_size
291acpi_rs_set_resource_source(union aml_resource *aml,
292 acpi_rs_length minimum_length,
293 struct acpi_resource_source *resource_source);
294
295void
296acpi_rs_set_resource_header(u8 descriptor_type,
297 acpi_rsdesc_size total_length,
298 union aml_resource *aml);
299
300void
301acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
302 union aml_resource *aml);
303
304/*
305 * rsdump - Debugger support
306 */
307#ifdef ACPI_DEBUGGER
308void acpi_rs_dump_resource_list(struct acpi_resource *resource);
309
310void acpi_rs_dump_irq_list(u8 *route_table);
311#endif
312
313/*
314 * Resource conversion tables
315 */
316extern struct acpi_rsconvert_info acpi_rs_convert_dma[];
317extern struct acpi_rsconvert_info acpi_rs_convert_end_dpf[];
318extern struct acpi_rsconvert_info acpi_rs_convert_io[];
319extern struct acpi_rsconvert_info acpi_rs_convert_fixed_io[];
320extern struct acpi_rsconvert_info acpi_rs_convert_end_tag[];
321extern struct acpi_rsconvert_info acpi_rs_convert_memory24[];
322extern struct acpi_rsconvert_info acpi_rs_convert_generic_reg[];
323extern struct acpi_rsconvert_info acpi_rs_convert_memory32[];
324extern struct acpi_rsconvert_info acpi_rs_convert_fixed_memory32[];
325extern struct acpi_rsconvert_info acpi_rs_convert_address32[];
326extern struct acpi_rsconvert_info acpi_rs_convert_address16[];
327extern struct acpi_rsconvert_info acpi_rs_convert_ext_irq[];
328extern struct acpi_rsconvert_info acpi_rs_convert_address64[];
329extern struct acpi_rsconvert_info acpi_rs_convert_ext_address64[];
330extern struct acpi_rsconvert_info acpi_rs_convert_gpio[];
331extern struct acpi_rsconvert_info acpi_rs_convert_fixed_dma[];
332extern struct acpi_rsconvert_info acpi_rs_convert_i2c_serial_bus[];
333extern struct acpi_rsconvert_info acpi_rs_convert_spi_serial_bus[];
334extern struct acpi_rsconvert_info acpi_rs_convert_uart_serial_bus[];
335extern struct acpi_rsconvert_info acpi_rs_convert_pin_function[];
336extern struct acpi_rsconvert_info acpi_rs_convert_pin_config[];
337extern struct acpi_rsconvert_info acpi_rs_convert_pin_group[];
338extern struct acpi_rsconvert_info acpi_rs_convert_pin_group_function[];
339extern struct acpi_rsconvert_info acpi_rs_convert_pin_group_config[];
340
341/* These resources require separate get/set tables */
342
343extern struct acpi_rsconvert_info acpi_rs_get_irq[];
344extern struct acpi_rsconvert_info acpi_rs_get_start_dpf[];
345extern struct acpi_rsconvert_info acpi_rs_get_vendor_small[];
346extern struct acpi_rsconvert_info acpi_rs_get_vendor_large[];
347
348extern struct acpi_rsconvert_info acpi_rs_set_irq[];
349extern struct acpi_rsconvert_info acpi_rs_set_start_dpf[];
350extern struct acpi_rsconvert_info acpi_rs_set_vendor[];
351
352#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
353/*
354 * rsinfo
355 */
356extern struct acpi_rsdump_info *acpi_gbl_dump_resource_dispatch[];
357extern struct acpi_rsdump_info *acpi_gbl_dump_serial_bus_dispatch[];
358
359/*
360 * rsdumpinfo
361 */
362extern struct acpi_rsdump_info acpi_rs_dump_irq[];
363extern struct acpi_rsdump_info acpi_rs_dump_prt[];
364extern struct acpi_rsdump_info acpi_rs_dump_dma[];
365extern struct acpi_rsdump_info acpi_rs_dump_start_dpf[];
366extern struct acpi_rsdump_info acpi_rs_dump_end_dpf[];
367extern struct acpi_rsdump_info acpi_rs_dump_io[];
368extern struct acpi_rsdump_info acpi_rs_dump_io_flags[];
369extern struct acpi_rsdump_info acpi_rs_dump_fixed_io[];
370extern struct acpi_rsdump_info acpi_rs_dump_vendor[];
371extern struct acpi_rsdump_info acpi_rs_dump_end_tag[];
372extern struct acpi_rsdump_info acpi_rs_dump_memory24[];
373extern struct acpi_rsdump_info acpi_rs_dump_memory32[];
374extern struct acpi_rsdump_info acpi_rs_dump_memory_flags[];
375extern struct acpi_rsdump_info acpi_rs_dump_fixed_memory32[];
376extern struct acpi_rsdump_info acpi_rs_dump_address16[];
377extern struct acpi_rsdump_info acpi_rs_dump_address32[];
378extern struct acpi_rsdump_info acpi_rs_dump_address64[];
379extern struct acpi_rsdump_info acpi_rs_dump_ext_address64[];
380extern struct acpi_rsdump_info acpi_rs_dump_ext_irq[];
381extern struct acpi_rsdump_info acpi_rs_dump_generic_reg[];
382extern struct acpi_rsdump_info acpi_rs_dump_gpio[];
383extern struct acpi_rsdump_info acpi_rs_dump_pin_function[];
384extern struct acpi_rsdump_info acpi_rs_dump_fixed_dma[];
385extern struct acpi_rsdump_info acpi_rs_dump_common_serial_bus[];
386extern struct acpi_rsdump_info acpi_rs_dump_i2c_serial_bus[];
387extern struct acpi_rsdump_info acpi_rs_dump_spi_serial_bus[];
388extern struct acpi_rsdump_info acpi_rs_dump_uart_serial_bus[];
389extern struct acpi_rsdump_info acpi_rs_dump_general_flags[];
390extern struct acpi_rsdump_info acpi_rs_dump_pin_config[];
391extern struct acpi_rsdump_info acpi_rs_dump_pin_group[];
392extern struct acpi_rsdump_info acpi_rs_dump_pin_group_function[];
393extern struct acpi_rsdump_info acpi_rs_dump_pin_group_config[];
394#endif
395
396#endif /* __ACRESRC_H__ */