8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / cmd / acpi / acpidump / tbxfroot.c
blobaaa24c470f65b22853220ae4b6af76ce6b7f04fc
1 /******************************************************************************
3 * Module Name: tbxfroot - Find the root ACPI table (RSDT)
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #include "acpi.h"
45 #include "accommon.h"
46 #include "actables.h"
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME ("tbxfroot")
53 /*******************************************************************************
55 * FUNCTION: AcpiTbGetRsdpLength
57 * PARAMETERS: Rsdp - Pointer to RSDP
59 * RETURN: Table length
61 * DESCRIPTION: Get the length of the RSDP
63 ******************************************************************************/
65 UINT32
66 AcpiTbGetRsdpLength (
67 ACPI_TABLE_RSDP *Rsdp)
70 if (!ACPI_VALIDATE_RSDP_SIG (Rsdp->Signature))
72 /* BAD Signature */
74 return (0);
77 /* "Length" field is available if table version >= 2 */
79 if (Rsdp->Revision >= 2)
81 return (Rsdp->Length);
83 else
85 return (ACPI_RSDP_CHECKSUM_LENGTH);
90 /*******************************************************************************
92 * FUNCTION: AcpiTbValidateRsdp
94 * PARAMETERS: Rsdp - Pointer to unvalidated RSDP
96 * RETURN: Status
98 * DESCRIPTION: Validate the RSDP (ptr)
100 ******************************************************************************/
102 ACPI_STATUS
103 AcpiTbValidateRsdp (
104 ACPI_TABLE_RSDP *Rsdp)
108 * The signature and checksum must both be correct
110 * Note: Sometimes there exists more than one RSDP in memory; the valid
111 * RSDP has a valid checksum, all others have an invalid checksum.
113 if (!ACPI_VALIDATE_RSDP_SIG (Rsdp->Signature))
115 /* Nope, BAD Signature */
117 return (AE_BAD_SIGNATURE);
120 /* Check the standard checksum */
122 if (AcpiTbChecksum ((UINT8 *) Rsdp, ACPI_RSDP_CHECKSUM_LENGTH) != 0)
124 return (AE_BAD_CHECKSUM);
127 /* Check extended checksum if table version >= 2 */
129 if ((Rsdp->Revision >= 2) &&
130 (AcpiTbChecksum ((UINT8 *) Rsdp, ACPI_RSDP_XCHECKSUM_LENGTH) != 0))
132 return (AE_BAD_CHECKSUM);
135 return (AE_OK);
139 /*******************************************************************************
141 * FUNCTION: AcpiFindRootPointer
143 * PARAMETERS: TableAddress - Where the table pointer is returned
145 * RETURN: Status, RSDP physical address
147 * DESCRIPTION: Search lower 1Mbyte of memory for the root system descriptor
148 * pointer structure. If it is found, set *RSDP to point to it.
150 * NOTE1: The RSDP must be either in the first 1K of the Extended
151 * BIOS Data Area or between E0000 and FFFFF (From ACPI Spec.)
152 * Only a 32-bit physical address is necessary.
154 * NOTE2: This function is always available, regardless of the
155 * initialization state of the rest of ACPI.
157 ******************************************************************************/
159 ACPI_STATUS
160 AcpiFindRootPointer (
161 ACPI_PHYSICAL_ADDRESS *TableAddress)
163 UINT8 *TablePtr;
164 UINT8 *MemRover;
165 UINT32 PhysicalAddress;
168 ACPI_FUNCTION_TRACE (AcpiFindRootPointer);
171 /* 1a) Get the location of the Extended BIOS Data Area (EBDA) */
173 TablePtr = AcpiOsMapMemory (
174 (ACPI_PHYSICAL_ADDRESS) ACPI_EBDA_PTR_LOCATION,
175 ACPI_EBDA_PTR_LENGTH);
176 if (!TablePtr)
178 ACPI_ERROR ((AE_INFO,
179 "Could not map memory at 0x%8.8X for length %u",
180 ACPI_EBDA_PTR_LOCATION, ACPI_EBDA_PTR_LENGTH));
182 return_ACPI_STATUS (AE_NO_MEMORY);
185 ACPI_MOVE_16_TO_32 (&PhysicalAddress, TablePtr);
187 /* Convert segment part to physical address */
189 PhysicalAddress <<= 4;
190 AcpiOsUnmapMemory (TablePtr, ACPI_EBDA_PTR_LENGTH);
192 /* EBDA present? */
194 if (PhysicalAddress > 0x400)
197 * 1b) Search EBDA paragraphs (EBDA is required to be a
198 * minimum of 1K length)
200 TablePtr = AcpiOsMapMemory (
201 (ACPI_PHYSICAL_ADDRESS) PhysicalAddress,
202 ACPI_EBDA_WINDOW_SIZE);
203 if (!TablePtr)
205 ACPI_ERROR ((AE_INFO,
206 "Could not map memory at 0x%8.8X for length %u",
207 PhysicalAddress, ACPI_EBDA_WINDOW_SIZE));
209 return_ACPI_STATUS (AE_NO_MEMORY);
212 MemRover = AcpiTbScanMemoryForRsdp (
213 TablePtr, ACPI_EBDA_WINDOW_SIZE);
214 AcpiOsUnmapMemory (TablePtr, ACPI_EBDA_WINDOW_SIZE);
216 if (MemRover)
218 /* Return the physical address */
220 PhysicalAddress +=
221 (UINT32) ACPI_PTR_DIFF (MemRover, TablePtr);
223 *TableAddress = (ACPI_PHYSICAL_ADDRESS) PhysicalAddress;
224 return_ACPI_STATUS (AE_OK);
229 * 2) Search upper memory: 16-byte boundaries in E0000h-FFFFFh
231 TablePtr = AcpiOsMapMemory (
232 (ACPI_PHYSICAL_ADDRESS) ACPI_HI_RSDP_WINDOW_BASE,
233 ACPI_HI_RSDP_WINDOW_SIZE);
235 if (!TablePtr)
237 ACPI_ERROR ((AE_INFO,
238 "Could not map memory at 0x%8.8X for length %u",
239 ACPI_HI_RSDP_WINDOW_BASE, ACPI_HI_RSDP_WINDOW_SIZE));
241 return_ACPI_STATUS (AE_NO_MEMORY);
244 MemRover = AcpiTbScanMemoryForRsdp (
245 TablePtr, ACPI_HI_RSDP_WINDOW_SIZE);
246 AcpiOsUnmapMemory (TablePtr, ACPI_HI_RSDP_WINDOW_SIZE);
248 if (MemRover)
250 /* Return the physical address */
252 PhysicalAddress = (UINT32)
253 (ACPI_HI_RSDP_WINDOW_BASE + ACPI_PTR_DIFF (MemRover, TablePtr));
255 *TableAddress = (ACPI_PHYSICAL_ADDRESS) PhysicalAddress;
256 return_ACPI_STATUS (AE_OK);
259 /* A valid RSDP was not found */
261 ACPI_BIOS_ERROR ((AE_INFO, "A valid RSDP was not found"));
262 return_ACPI_STATUS (AE_NOT_FOUND);
265 ACPI_EXPORT_SYMBOL (AcpiFindRootPointer)
268 /*******************************************************************************
270 * FUNCTION: AcpiTbScanMemoryForRsdp
272 * PARAMETERS: StartAddress - Starting pointer for search
273 * Length - Maximum length to search
275 * RETURN: Pointer to the RSDP if found, otherwise NULL.
277 * DESCRIPTION: Search a block of memory for the RSDP signature
279 ******************************************************************************/
281 UINT8 *
282 AcpiTbScanMemoryForRsdp (
283 UINT8 *StartAddress,
284 UINT32 Length)
286 ACPI_STATUS Status;
287 UINT8 *MemRover;
288 UINT8 *EndAddress;
291 ACPI_FUNCTION_TRACE (TbScanMemoryForRsdp);
294 EndAddress = StartAddress + Length;
296 /* Search from given start address for the requested length */
298 for (MemRover = StartAddress; MemRover < EndAddress;
299 MemRover += ACPI_RSDP_SCAN_STEP)
301 /* The RSDP signature and checksum must both be correct */
303 Status = AcpiTbValidateRsdp (
304 ACPI_CAST_PTR (ACPI_TABLE_RSDP, MemRover));
305 if (ACPI_SUCCESS (Status))
307 /* Sig and checksum valid, we have found a real RSDP */
309 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
310 "RSDP located at physical address %p\n", MemRover));
311 return_PTR (MemRover);
314 /* No sig match or bad checksum, keep searching */
317 /* Searched entire block, no RSDP was found */
319 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
320 "Searched entire block from %p, valid RSDP was not found\n",
321 StartAddress));
322 return_PTR (NULL);