include/acpi/actables.h

   1 /******************************************************************************
   2  *
   3  * Name: actables.h - ACPI table management
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   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
  48 /* Used in acpi_tb_map_acpi_table for size parameter if table header is to be used */
  49
  50 #define SIZE_IN_HEADER          0
  51
  52
  53 /*
  54  * tbconvrt - Table conversion routines
  55  */
  56 acpi_status
  57 acpi_tb_convert_to_xsdt (
  58         struct acpi_table_desc          *table_info);
  59
  60 acpi_status
  61 acpi_tb_convert_table_fadt (
  62         void);
  63
  64 acpi_status
  65 acpi_tb_build_common_facs (
  66         struct acpi_table_desc          *table_info);
  67
  68 u32
  69 acpi_tb_get_table_count (
  70         struct rsdp_descriptor          *RSDP,
  71         struct acpi_table_header        *RSDT);
  72
  73
  74 /*
  75  * tbget - Table "get" routines
  76  */
  77 acpi_status
  78 acpi_tb_get_table (
  79         struct acpi_pointer             *address,
  80         struct acpi_table_desc          *table_info);
  81
  82 acpi_status
  83 acpi_tb_get_table_header (
  84         struct acpi_pointer             *address,
  85         struct acpi_table_header        *return_header);
  86
  87 acpi_status
  88 acpi_tb_get_table_body (
  89         struct acpi_pointer             *address,
  90         struct acpi_table_header        *header,
  91         struct acpi_table_desc          *table_info);
  92
  93 acpi_status
  94 acpi_tb_get_table_ptr (
  95         acpi_table_type                 table_type,
  96         u32                             instance,
  97         struct acpi_table_header        **table_ptr_loc);
  98
  99 acpi_status
 100 acpi_tb_verify_rsdp (
 101         struct acpi_pointer             *address);
 102
 103 void
 104 acpi_tb_get_rsdt_address (
 105         struct acpi_pointer             *out_address);
 106
 107 acpi_status
 108 acpi_tb_validate_rsdt (
 109         struct acpi_table_header        *table_ptr);
 110
 111
 112 /*
 113  * tbgetall - get multiple required tables
 114  */
 115 acpi_status
 116 acpi_tb_get_required_tables (
 117         void);
 118
 119
 120 /*
 121  * tbinstall - Table installation
 122  */
 123 acpi_status
 124 acpi_tb_install_table (
 125         struct acpi_table_desc          *table_info);
 126
 127 acpi_status
 128 acpi_tb_recognize_table (
 129         struct acpi_table_desc          *table_info,
 130         u8                              search_type);
 131
 132 acpi_status
 133 acpi_tb_init_table_descriptor (
 134         acpi_table_type                 table_type,
 135         struct acpi_table_desc          *table_info);
 136
 137
 138 /*
 139  * tbremove - Table removal and deletion
 140  */
 141 void
 142 acpi_tb_delete_all_tables (
 143         void);
 144
 145 void
 146 acpi_tb_delete_tables_by_type (
 147         acpi_table_type                 type);
 148
 149 void
 150 acpi_tb_delete_single_table (
 151         struct acpi_table_desc          *table_desc);
 152
 153 struct acpi_table_desc *
 154 acpi_tb_uninstall_table (
 155         struct acpi_table_desc          *table_desc);
 156
 157
 158 /*
 159  * tbxfroot - RSDP, RSDT utilities
 160  */
 161 acpi_status
 162 acpi_tb_find_table (
 163         char                            *signature,
 164         char                            *oem_id,
 165         char                            *oem_table_id,
 166         struct acpi_table_header        **table_ptr);
 167
 168 acpi_status
 169 acpi_tb_get_table_rsdt (
 170         void);
 171
 172 acpi_status
 173 acpi_tb_validate_rsdp (
 174         struct rsdp_descriptor          *rsdp);
 175
 176
 177 /*
 178  * tbutils - common table utilities
 179  */
 180 acpi_status
 181 acpi_tb_is_table_installed (
 182         struct acpi_table_desc          *new_table_desc);
 183
 184 acpi_status
 185 acpi_tb_verify_table_checksum (
 186         struct acpi_table_header        *table_header);
 187
 188 u8
 189 acpi_tb_generate_checksum (
 190         void                            *buffer,
 191         u32                             length);
 192
 193 acpi_status
 194 acpi_tb_validate_table_header (
 195         struct acpi_table_header        *table_header);
 196
 197 #endif /* __ACTABLES_H__ */