]>
git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - drivers/acpi/tables/tbutils.c
1 /******************************************************************************
3 * Module Name: tbutils - Table manipulation utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include <acpi/actables.h>
47 #define _COMPONENT ACPI_TABLES
48 ACPI_MODULE_NAME ( "tbutils" )
50 /* Local prototypes */
51 #ifdef ACPI_OBSOLETE_FUNCTIONS
53 acpi_tb_handle_to_object ( u16 table_id
, struct acpi_table_desc
** table_desc
);
56 /*******************************************************************************
58 * FUNCTION: acpi_tb_is_table_installed
60 * PARAMETERS: new_table_desc - Descriptor for new table being installed
62 * RETURN: Status - AE_ALREADY_EXISTS if the table is already installed
64 * DESCRIPTION: Determine if an ACPI table is already installed
66 * MUTEX: Table data structures should be locked
68 ******************************************************************************/
70 acpi_status
acpi_tb_is_table_installed ( struct acpi_table_desc
* new_table_desc
)
72 struct acpi_table_desc
* table_desc
;
74 ACPI_FUNCTION_TRACE ( "tb_is_table_installed" );
76 /* Get the list descriptor and first table descriptor */
78 table_desc
= acpi_gbl_table_lists
[ new_table_desc
-> type
]. next
;
80 /* Examine all installed tables of this type */
83 /* Compare Revision and oem_table_id */
85 if (( table_desc
-> loaded_into_namespace
) &&
86 ( table_desc
-> pointer
-> revision
==
87 new_table_desc
-> pointer
-> revision
) &&
88 (! ACPI_MEMCMP ( table_desc
-> pointer
-> oem_table_id
,
89 new_table_desc
-> pointer
-> oem_table_id
, 8 ))) {
90 /* This table is already installed */
92 ACPI_DEBUG_PRINT (( ACPI_DB_TABLES
,
93 "Table [%4.4s] already installed: Rev %X oem_table_id [%8.8s] \n " ,
94 new_table_desc
-> pointer
-> signature
,
95 new_table_desc
-> pointer
-> revision
,
96 new_table_desc
-> pointer
->
99 new_table_desc
-> owner_id
= table_desc
-> owner_id
;
100 new_table_desc
-> installed_desc
= table_desc
;
102 return_ACPI_STATUS ( AE_ALREADY_EXISTS
);
105 /* Get next table on the list */
107 table_desc
= table_desc
-> next
;
110 return_ACPI_STATUS ( AE_OK
);
113 /*******************************************************************************
115 * FUNCTION: acpi_tb_validate_table_header
117 * PARAMETERS: table_header - Logical pointer to the table
121 * DESCRIPTION: Check an ACPI table header for validity
123 * NOTE: Table pointers are validated as follows:
124 * 1) Table pointer must point to valid physical memory
125 * 2) Signature must be 4 ASCII chars, even if we don't recognize the
127 * 3) Table must be readable for length specified in the header
128 * 4) Table checksum must be valid (with the exception of the FACS
129 * which has no checksum because it contains variable fields)
131 ******************************************************************************/
134 acpi_tb_validate_table_header ( struct acpi_table_header
* table_header
)
138 ACPI_FUNCTION_NAME ( "tb_validate_table_header" );
140 /* Verify that this is a valid address */
142 if (! acpi_os_readable ( table_header
, sizeof ( struct acpi_table_header
))) {
143 ACPI_DEBUG_PRINT (( ACPI_DB_ERROR
,
144 "Cannot read table header at %p \n " ,
147 return ( AE_BAD_ADDRESS
);
150 /* Ensure that the signature is 4 ASCII characters */
152 ACPI_MOVE_32_TO_32 (& signature
, table_header
-> signature
);
153 if (! acpi_ut_valid_acpi_name ( signature
)) {
154 ACPI_DEBUG_PRINT (( ACPI_DB_ERROR
,
155 "Table signature at %p [%p] has invalid characters \n " ,
156 table_header
, & signature
));
158 ACPI_REPORT_WARNING (( "Invalid table signature found: [%4.4s] \n " ,
159 ( char *)& signature
));
161 ACPI_DUMP_BUFFER ( table_header
,
162 sizeof ( struct acpi_table_header
));
163 return ( AE_BAD_SIGNATURE
);
166 /* Validate the table length */
168 if ( table_header
-> length
< sizeof ( struct acpi_table_header
)) {
169 ACPI_DEBUG_PRINT (( ACPI_DB_ERROR
,
170 "Invalid length in table header %p name %4.4s \n " ,
171 table_header
, ( char *)& signature
));
173 ACPI_REPORT_WARNING (( "Invalid table header length (0x%X) found \n " , ( u32
) table_header
-> length
));
175 ACPI_DUMP_BUFFER ( table_header
,
176 sizeof ( struct acpi_table_header
));
177 return ( AE_BAD_HEADER
);
183 /*******************************************************************************
185 * FUNCTION: acpi_tb_verify_table_checksum
187 * PARAMETERS: *table_header - ACPI table to verify
189 * RETURN: 8 bit checksum of table
191 * DESCRIPTION: Does an 8 bit checksum of table and returns status. A correct
192 * table should have a checksum of 0.
194 ******************************************************************************/
197 acpi_tb_verify_table_checksum ( struct acpi_table_header
* table_header
)
200 acpi_status status
= AE_OK
;
202 ACPI_FUNCTION_TRACE ( "tb_verify_table_checksum" );
204 /* Compute the checksum on the table */
207 acpi_tb_generate_checksum ( table_header
, table_header
-> length
);
209 /* Return the appropriate exception */
212 ACPI_REPORT_WARNING (( "Invalid checksum in table [%4.4s] (%02X, sum %02X is not zero) \n " , table_header
-> signature
, ( u32
) table_header
-> checksum
, ( u32
) checksum
));
214 status
= AE_BAD_CHECKSUM
;
216 return_ACPI_STATUS ( status
);
219 /*******************************************************************************
221 * FUNCTION: acpi_tb_generate_checksum
223 * PARAMETERS: Buffer - Buffer to checksum
224 * Length - Size of the buffer
226 * RETURN: 8 bit checksum of buffer
228 * DESCRIPTION: Computes an 8 bit checksum of the buffer(length) and returns it.
230 ******************************************************************************/
232 u8
acpi_tb_generate_checksum ( void * buffer
, u32 length
)
238 if ( buffer
&& length
) {
239 /* Buffer and Length are valid */
241 limit
= ( u8
*) buffer
+ length
;
243 for ( rover
= buffer
; rover
< limit
; rover
++) {
244 sum
= ( u8
) ( sum
+ * rover
);
250 #ifdef ACPI_OBSOLETE_FUNCTIONS
251 /*******************************************************************************
253 * FUNCTION: acpi_tb_handle_to_object
255 * PARAMETERS: table_id - Id for which the function is searching
256 * table_desc - Pointer to return the matching table
259 * RETURN: Search the tables to find one with a matching table_id and
260 * return a pointer to that table descriptor.
262 ******************************************************************************/
265 acpi_tb_handle_to_object ( u16 table_id
,
266 struct acpi_table_desc
** return_table_desc
)
269 struct acpi_table_desc
* table_desc
;
271 ACPI_FUNCTION_NAME ( "tb_handle_to_object" );
273 for ( i
= 0 ; i
< ACPI_TABLE_MAX
; i
++) {
274 table_desc
= acpi_gbl_table_lists
[ i
]. next
;
276 if ( table_desc
-> table_id
== table_id
) {
277 * return_table_desc
= table_desc
;
281 table_desc
= table_desc
-> next
;
285 ACPI_DEBUG_PRINT (( ACPI_DB_ERROR
, "table_id=%X does not exist \n " ,
287 return ( AE_BAD_PARAMETER
);