blob: 848ad3ac938f802b26c8478be40302a718b284f3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: actables.h - ACPI table management
4 *
5 *****************************************************************************/
6
7/*
Bob Moorec8100dc2016-01-15 08:17:03 +08008 * Copyright (C) 2000 - 2016, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Bob Moore77389e12007-02-02 19:48:20 +030047acpi_status acpi_allocate_root_table(u32 initial_table_count);
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
Bob Moore57987ca2013-07-17 09:48:27 +080050 * tbxfroot - Root pointer utilities
51 */
Lv Zhengf1b69752014-10-10 10:39:32 +080052u32 acpi_tb_get_rsdp_length(struct acpi_table_rsdp *rsdp);
53
Bob Moore38f7c5a2013-08-08 15:29:22 +080054acpi_status acpi_tb_validate_rsdp(struct acpi_table_rsdp *rsdp);
55
Bob Moore57987ca2013-07-17 09:48:27 +080056u8 *acpi_tb_scan_memory_for_rsdp(u8 *start_address, u32 length);
57
58/*
Bob Moorec418ce12014-04-04 12:39:34 +080059 * tbdata - table data structure management
60 */
Lv Zheng76cffa72015-04-13 11:49:30 +080061acpi_status
62acpi_tb_get_next_table_descriptor(u32 *table_index,
63 struct acpi_table_desc **table_desc);
Bob Moorec418ce12014-04-04 12:39:34 +080064
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
Lv Zheng47d68c72014-05-31 08:14:44 +080076acpi_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
Bob Moorec418ce12014-04-04 12:39:34 +080081u8 acpi_tb_is_table_loaded(u32 table_index);
82
83void acpi_tb_set_table_loaded_flag(u32 table_index, u8 is_loaded);
84
85/*
Bob Moore765ec202007-02-02 19:48:20 +030086 * tbfadt - FADT parse/convert/validate
87 */
Lv Zheng62fcce92015-10-14 13:53:57 +080088void acpi_tb_parse_fadt(void);
Bob Moore765ec202007-02-02 19:48:20 +030089
Bob Moore71392842007-02-02 19:48:20 +030090void acpi_tb_create_local_fadt(struct acpi_table_header *table, u32 length);
Bob Mooreea5d8eb2007-02-02 19:48:20 +030091
Bob Moore765ec202007-02-02 19:48:20 +030092/*
Bob Mooref3d2e782007-02-02 19:48:18 +030093 * tbfind - find ACPI table
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040096acpi_tb_find_table(char *signature,
Bob Moore67a119f2008-06-10 13:42:13 +080097 char *oem_id, char *oem_table_id, u32 *table_index);
Robert Moore44f6c012005-04-18 22:49:35 -040098
99/*
Bob Mooref3d2e782007-02-02 19:48:18 +0300100 * tbinstal - Table removal and deletion
Robert Moore44f6c012005-04-18 22:49:35 -0400101 */
Bob Mooref3d2e782007-02-02 19:48:18 +0300102acpi_status acpi_tb_resize_root_table_list(void);
103
Lv Zheng7f9fc992014-04-04 12:38:42 +0800104acpi_status acpi_tb_validate_table(struct acpi_table_desc *table_desc);
Robert Moore0c9938c2005-07-29 15:15:00 -0700105
Lv Zheng7f9fc992014-04-04 12:38:42 +0800106void acpi_tb_invalidate_table(struct acpi_table_desc *table_desc);
107
Lv Zheng86dfc6f32014-04-04 12:38:57 +0800108void acpi_tb_override_table(struct acpi_table_desc *old_table_desc);
Bob Mooref7b004a2012-02-14 18:31:56 +0800109
Robert Moore0c9938c2005-07-29 15:15:00 -0700110acpi_status
Lv Zheng7f9fc992014-04-04 12:38:42 +0800111acpi_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
Bob Mooreed6f1d42014-04-04 12:39:26 +0800120acpi_tb_install_standard_table(acpi_physical_address address,
121 u8 flags,
122 u8 reload, u8 override, u32 *table_index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Lv Zheng7f9fc992014-04-04 12:38:42 +0800124void acpi_tb_uninstall_table(struct acpi_table_desc *table_desc);
Bob Mooref3d2e782007-02-02 19:48:18 +0300125
126void acpi_tb_terminate(void);
127
Bob Moore8a335a232009-03-09 16:31:04 +0800128acpi_status acpi_tb_delete_namespace_by_owner(u32 table_index);
Bob Mooref3d2e782007-02-02 19:48:18 +0300129
Bob Moore67a119f2008-06-10 13:42:13 +0800130acpi_status acpi_tb_allocate_owner_id(u32 table_index);
Bob Mooref3d2e782007-02-02 19:48:18 +0300131
Bob Moore67a119f2008-06-10 13:42:13 +0800132acpi_status acpi_tb_release_owner_id(u32 table_index);
Bob Mooref3d2e782007-02-02 19:48:18 +0300133
Bob Moore67a119f2008-06-10 13:42:13 +0800134acpi_status acpi_tb_get_owner_id(u32 table_index, acpi_owner_id *owner_id);
Bob Mooref3d2e782007-02-02 19:48:18 +0300135
Bob Mooref3d2e782007-02-02 19:48:18 +0300136/*
137 * tbutils - table manager utilities
138 */
Bob Moore009c4cbe2008-11-12 15:34:52 +0800139acpi_status acpi_tb_initialize_facs(void);
140
Bob Mooref3d2e782007-02-02 19:48:18 +0300141void
142acpi_tb_print_table_header(acpi_physical_address address,
143 struct acpi_table_header *header);
144
Bob Moore67a119f2008-06-10 13:42:13 +0800145u8 acpi_tb_checksum(u8 *buffer, u32 length);
Bob Mooref3d2e782007-02-02 19:48:18 +0300146
Bob Moorec5fc42a2007-02-02 19:48:19 +0300147acpi_status
148acpi_tb_verify_checksum(struct acpi_table_header *table, u32 length);
Bob Mooref3d2e782007-02-02 19:48:18 +0300149
Lin Ming729df0f2010-04-01 10:47:56 +0800150void acpi_tb_check_dsdt_header(void);
151
Bob Moore43323cb2010-04-07 11:05:11 +0800152struct acpi_table_header *acpi_tb_copy_dsdt(u32 table_index);
Lin Ming69ec87e2010-04-01 11:14:12 +0800153
Bob Moore765ec202007-02-02 19:48:20 +0300154void
Lv Zheng8ec3f452015-08-25 10:29:01 +0800155acpi_tb_install_table_with_override(struct acpi_table_desc *new_table_desc,
156 u8 override, u32 *table_index);
Lv Zheng86dfc6f32014-04-04 12:38:57 +0800157
158acpi_status
159acpi_tb_install_fixed_table(acpi_physical_address address,
Lv Zheng8ec3f452015-08-25 10:29:01 +0800160 char *signature, u32 *table_index);
Bob Moore765ec202007-02-02 19:48:20 +0300161
Bob Moore97cbb7d2009-02-03 14:41:03 +0800162acpi_status acpi_tb_parse_root_table(acpi_physical_address rsdp_address);
Bob Mooref3d2e782007-02-02 19:48:18 +0300163
Bob Moore9f41fd82015-08-25 10:28:39 +0800164u8 acpi_is_valid_signature(char *signature);
165
Bob Moore93cdafa2015-08-25 10:29:33 +0800166/*
167 * tbxfload
168 */
169acpi_status acpi_tb_load_namespace(void);
170
Len Brown4be44fc2005-08-05 00:44:28 -0400171#endif /* __ACTABLES_H__ */