xref: /titanic_44/usr/src/uts/intel/io/acpica/utilities/utinit.c (revision 5151fb1220e0ceafdc172203863c73da4285c170)
1 /******************************************************************************
2  *
3  * Module Name: utinit - Common ACPI subsystem initialization
4  *              $Revision: 1.131 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights.  You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code.  No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision.  In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change.  Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee.  Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution.  In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government.  In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************/
116 
117 
118 #define __UTINIT_C__
119 
120 #include "acpi.h"
121 #include "acnamesp.h"
122 #include "acevents.h"
123 
124 #define _COMPONENT          ACPI_UTILITIES
125         ACPI_MODULE_NAME    ("utinit")
126 
127 /* Local prototypes */
128 
129 static void
130 AcpiUtFadtRegisterError (
131     char                    *RegisterName,
132     UINT32                  Value,
133     UINT8                   Offset);
134 
135 static void AcpiUtTerminate (
136     void);
137 
138 
139 /*******************************************************************************
140  *
141  * FUNCTION:    AcpiUtFadtRegisterError
142  *
143  * PARAMETERS:  RegisterName            - Pointer to string identifying register
144  *              Value                   - Actual register contents value
145  *              Offset                  - Byte offset in the FADT
146  *
147  * RETURN:      AE_BAD_VALUE
148  *
149  * DESCRIPTION: Display failure message
150  *
151  ******************************************************************************/
152 
153 static void
154 AcpiUtFadtRegisterError (
155     char                    *RegisterName,
156     UINT32                  Value,
157     UINT8                   Offset)
158 {
159 
160     ACPI_WARNING ((AE_INFO,
161         "Invalid FADT value %s=%X at offset %X FADT=%p",
162         RegisterName, Value, Offset, AcpiGbl_FADT));
163 }
164 
165 
166 /******************************************************************************
167  *
168  * FUNCTION:    AcpiUtValidateFadt
169  *
170  * PARAMETERS:  None
171  *
172  * RETURN:      Status
173  *
174  * DESCRIPTION: Validate various ACPI registers in the FADT
175  *
176  ******************************************************************************/
177 
178 ACPI_STATUS
179 AcpiUtValidateFadt (
180     void)
181 {
182 
183     /*
184      * Verify Fixed ACPI Description Table fields,
185      * but don't abort on any problems, just display error
186      */
187     if (AcpiGbl_FADT->Pm1EvtLen < 4)
188     {
189         AcpiUtFadtRegisterError ("PM1_EVT_LEN",
190                         (UINT32) AcpiGbl_FADT->Pm1EvtLen,
191                         ACPI_FADT_OFFSET (Pm1EvtLen));
192     }
193 
194     if (!AcpiGbl_FADT->Pm1CntLen)
195     {
196         AcpiUtFadtRegisterError ("PM1_CNT_LEN", 0,
197                         ACPI_FADT_OFFSET (Pm1CntLen));
198     }
199 
200     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm1aEvtBlk.Address))
201     {
202         AcpiUtFadtRegisterError ("X_PM1a_EVT_BLK", 0,
203                         ACPI_FADT_OFFSET (XPm1aEvtBlk.Address));
204     }
205 
206     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm1aCntBlk.Address))
207     {
208         AcpiUtFadtRegisterError ("X_PM1a_CNT_BLK", 0,
209                         ACPI_FADT_OFFSET (XPm1aCntBlk.Address));
210     }
211 
212     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPmTmrBlk.Address))
213     {
214         AcpiUtFadtRegisterError ("X_PM_TMR_BLK", 0,
215                         ACPI_FADT_OFFSET (XPmTmrBlk.Address));
216     }
217 
218     if ((ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm2CntBlk.Address) &&
219         !AcpiGbl_FADT->Pm2CntLen))
220     {
221         AcpiUtFadtRegisterError ("PM2_CNT_LEN",
222                         (UINT32) AcpiGbl_FADT->Pm2CntLen,
223                         ACPI_FADT_OFFSET (Pm2CntLen));
224     }
225 
226     if (AcpiGbl_FADT->PmTmLen < 4)
227     {
228         AcpiUtFadtRegisterError ("PM_TM_LEN",
229                         (UINT32) AcpiGbl_FADT->PmTmLen,
230                         ACPI_FADT_OFFSET (PmTmLen));
231     }
232 
233     /* Length of GPE blocks must be a multiple of 2 */
234 
235     if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe0Blk.Address) &&
236         (AcpiGbl_FADT->Gpe0BlkLen & 1))
237     {
238         AcpiUtFadtRegisterError ("(x)GPE0_BLK_LEN",
239                         (UINT32) AcpiGbl_FADT->Gpe0BlkLen,
240                         ACPI_FADT_OFFSET (Gpe0BlkLen));
241     }
242 
243     if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe1Blk.Address) &&
244         (AcpiGbl_FADT->Gpe1BlkLen & 1))
245     {
246         AcpiUtFadtRegisterError ("(x)GPE1_BLK_LEN",
247                         (UINT32) AcpiGbl_FADT->Gpe1BlkLen,
248                         ACPI_FADT_OFFSET (Gpe1BlkLen));
249     }
250 
251     return (AE_OK);
252 }
253 
254 
255 /******************************************************************************
256  *
257  * FUNCTION:    AcpiUtTerminate
258  *
259  * PARAMETERS:  none
260  *
261  * RETURN:      none
262  *
263  * DESCRIPTION: Free global memory
264  *
265  ******************************************************************************/
266 
267 static void
268 AcpiUtTerminate (
269     void)
270 {
271     ACPI_GPE_BLOCK_INFO     *GpeBlock;
272     ACPI_GPE_BLOCK_INFO     *NextGpeBlock;
273     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
274     ACPI_GPE_XRUPT_INFO     *NextGpeXruptInfo;
275 
276 
277     ACPI_FUNCTION_TRACE (UtTerminate);
278 
279 
280     /* Free global tables, etc. */
281     /* Free global GPE blocks and related info structures */
282 
283     GpeXruptInfo = AcpiGbl_GpeXruptListHead;
284     while (GpeXruptInfo)
285     {
286         GpeBlock = GpeXruptInfo->GpeBlockListHead;
287         while (GpeBlock)
288         {
289             NextGpeBlock = GpeBlock->Next;
290             ACPI_FREE (GpeBlock->EventInfo);
291             ACPI_FREE (GpeBlock->RegisterInfo);
292             ACPI_FREE (GpeBlock);
293 
294             GpeBlock = NextGpeBlock;
295         }
296         NextGpeXruptInfo = GpeXruptInfo->Next;
297         ACPI_FREE (GpeXruptInfo);
298         GpeXruptInfo = NextGpeXruptInfo;
299     }
300 
301     return_VOID;
302 }
303 
304 
305 /*******************************************************************************
306  *
307  * FUNCTION:    AcpiUtSubsystemShutdown
308  *
309  * PARAMETERS:  none
310  *
311  * RETURN:      none
312  *
313  * DESCRIPTION: Shutdown the various subsystems.  Don't delete the mutex
314  *              objects here -- because the AML debugger may be still running.
315  *
316  ******************************************************************************/
317 
318 void
319 AcpiUtSubsystemShutdown (
320     void)
321 {
322 
323     ACPI_FUNCTION_TRACE (UtSubsystemShutdown);
324 
325     /* Just exit if subsystem is already shutdown */
326 
327     if (AcpiGbl_Shutdown)
328     {
329         ACPI_ERROR ((AE_INFO,
330             "ACPI Subsystem is already terminated"));
331         return_VOID;
332     }
333 
334     /* Subsystem appears active, go ahead and shut it down */
335 
336     AcpiGbl_Shutdown = TRUE;
337     AcpiGbl_StartupFlags = 0;
338     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
339         "Shutting down ACPI Subsystem\n"));
340 
341     /* Close the AcpiEvent Handling */
342 
343     AcpiEvTerminate ();
344 
345     /* Close the Namespace */
346 
347     AcpiNsTerminate ();
348 
349     /* Close the globals */
350 
351     AcpiUtTerminate ();
352 
353     /* Purge the local caches */
354 
355     (void) AcpiUtDeleteCaches ();
356     return_VOID;
357 }
358 
359 
360