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