xref: /openbmc/linux/drivers/acpi/acpica/actables.h (revision 48c926cd)
1 /******************************************************************************
2  *
3  * Name: actables.h - ACPI table management
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 __ACTABLES_H__
45 #define __ACTABLES_H__
46 
47 acpi_status acpi_allocate_root_table(u32 initial_table_count);
48 
49 /*
50  * tbxfroot - Root pointer utilities
51  */
52 u32 acpi_tb_get_rsdp_length(struct acpi_table_rsdp *rsdp);
53 
54 acpi_status acpi_tb_validate_rsdp(struct acpi_table_rsdp *rsdp);
55 
56 u8 *acpi_tb_scan_memory_for_rsdp(u8 *start_address, u32 length);
57 
58 /*
59  * tbdata - table data structure management
60  */
61 acpi_status
62 acpi_tb_get_next_table_descriptor(u32 *table_index,
63 				  struct acpi_table_desc **table_desc);
64 
65 void
66 acpi_tb_init_table_descriptor(struct acpi_table_desc *table_desc,
67 			      acpi_physical_address address,
68 			      u8 flags, struct acpi_table_header *table);
69 
70 acpi_status
71 acpi_tb_acquire_temp_table(struct acpi_table_desc *table_desc,
72 			   acpi_physical_address address, u8 flags);
73 
74 void acpi_tb_release_temp_table(struct acpi_table_desc *table_desc);
75 
76 acpi_status acpi_tb_validate_temp_table(struct acpi_table_desc *table_desc);
77 
78 acpi_status
79 acpi_tb_verify_temp_table(struct acpi_table_desc *table_desc,
80 			  char *signature, u32 *table_index);
81 
82 u8 acpi_tb_is_table_loaded(u32 table_index);
83 
84 void acpi_tb_set_table_loaded_flag(u32 table_index, u8 is_loaded);
85 
86 /*
87  * tbfadt - FADT parse/convert/validate
88  */
89 void acpi_tb_parse_fadt(void);
90 
91 void acpi_tb_create_local_fadt(struct acpi_table_header *table, u32 length);
92 
93 /*
94  * tbfind - find ACPI table
95  */
96 acpi_status
97 acpi_tb_find_table(char *signature,
98 		   char *oem_id, char *oem_table_id, u32 *table_index);
99 
100 /*
101  * tbinstal - Table removal and deletion
102  */
103 acpi_status acpi_tb_resize_root_table_list(void);
104 
105 acpi_status acpi_tb_validate_table(struct acpi_table_desc *table_desc);
106 
107 void acpi_tb_invalidate_table(struct acpi_table_desc *table_desc);
108 
109 void acpi_tb_override_table(struct acpi_table_desc *old_table_desc);
110 
111 acpi_status
112 acpi_tb_acquire_table(struct acpi_table_desc *table_desc,
113 		      struct acpi_table_header **table_ptr,
114 		      u32 *table_length, u8 *table_flags);
115 
116 void
117 acpi_tb_release_table(struct acpi_table_header *table,
118 		      u32 table_length, u8 table_flags);
119 
120 acpi_status
121 acpi_tb_install_standard_table(acpi_physical_address address,
122 			       u8 flags,
123 			       u8 reload, u8 override, u32 *table_index);
124 
125 void acpi_tb_uninstall_table(struct acpi_table_desc *table_desc);
126 
127 acpi_status
128 acpi_tb_load_table(u32 table_index, struct acpi_namespace_node *parent_node);
129 
130 acpi_status
131 acpi_tb_install_and_load_table(acpi_physical_address address,
132 			       u8 flags, u8 override, u32 *table_index);
133 
134 acpi_status acpi_tb_unload_table(u32 table_index);
135 
136 void acpi_tb_notify_table(u32 event, void *table);
137 
138 void acpi_tb_terminate(void);
139 
140 acpi_status acpi_tb_delete_namespace_by_owner(u32 table_index);
141 
142 acpi_status acpi_tb_allocate_owner_id(u32 table_index);
143 
144 acpi_status acpi_tb_release_owner_id(u32 table_index);
145 
146 acpi_status acpi_tb_get_owner_id(u32 table_index, acpi_owner_id *owner_id);
147 
148 /*
149  * tbutils - table manager utilities
150  */
151 acpi_status acpi_tb_initialize_facs(void);
152 
153 void
154 acpi_tb_print_table_header(acpi_physical_address address,
155 			   struct acpi_table_header *header);
156 
157 u8 acpi_tb_checksum(u8 *buffer, u32 length);
158 
159 acpi_status
160 acpi_tb_verify_checksum(struct acpi_table_header *table, u32 length);
161 
162 void acpi_tb_check_dsdt_header(void);
163 
164 struct acpi_table_header *acpi_tb_copy_dsdt(u32 table_index);
165 
166 void
167 acpi_tb_install_table_with_override(struct acpi_table_desc *new_table_desc,
168 				    u8 override, u32 *table_index);
169 
170 acpi_status acpi_tb_parse_root_table(acpi_physical_address rsdp_address);
171 
172 acpi_status
173 acpi_tb_get_table(struct acpi_table_desc *table_desc,
174 		  struct acpi_table_header **out_table);
175 
176 void acpi_tb_put_table(struct acpi_table_desc *table_desc);
177 
178 /*
179  * tbxfload
180  */
181 acpi_status acpi_tb_load_namespace(void);
182 
183 #endif				/* __ACTABLES_H__ */
184