Also document BGE_FAKE_AUTONEG in LINT.
[dragonfly.git] / sys / contrib / dev / acpica / utinit.c
1 /******************************************************************************
2  *
3  * Module Name: utinit - Common ACPI subsystem initialization
4  *              $Revision: 116 $
5  *
6  *****************************************************************************/
7
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/utinit.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
117
118
119 #define __UTINIT_C__
120
121 #include "acpi.h"
122 #include "acnamesp.h"
123 #include "acevents.h"
124
125 #define _COMPONENT          ACPI_UTILITIES
126         ACPI_MODULE_NAME    ("utinit")
127
128
129 /*******************************************************************************
130  *
131  * FUNCTION:    AcpiUtFadtRegisterError
132  *
133  * PARAMETERS:  *RegisterName           - Pointer to string identifying register
134  *              Value                   - Actual register contents value
135  *              AcpiTestSpecSection     - TDS section containing assertion
136  *              AcpiAssertion           - Assertion number being tested
137  *
138  * RETURN:      AE_BAD_VALUE
139  *
140  * DESCRIPTION: Display failure message and link failure to TDS assertion
141  *
142  ******************************************************************************/
143
144 static void
145 AcpiUtFadtRegisterError (
146     char                    *RegisterName,
147     UINT32                  Value,
148     ACPI_SIZE               Offset)
149 {
150
151     ACPI_REPORT_WARNING (
152         ("Invalid FADT value %s=%X at offset %X FADT=%p\n",
153         RegisterName, Value, (UINT32) Offset, AcpiGbl_FADT));
154 }
155
156
157 /******************************************************************************
158  *
159  * FUNCTION:    AcpiUtValidateFadt
160  *
161  * PARAMETERS:  None
162  *
163  * RETURN:      Status
164  *
165  * DESCRIPTION: Validate various ACPI registers in the FADT
166  *
167  ******************************************************************************/
168
169 ACPI_STATUS
170 AcpiUtValidateFadt (
171     void)
172 {
173
174     /*
175      * Verify Fixed ACPI Description Table fields,
176      * but don't abort on any problems, just display error
177      */
178     if (AcpiGbl_FADT->Pm1EvtLen < 4)
179     {
180         AcpiUtFadtRegisterError ("PM1_EVT_LEN",
181                         (UINT32) AcpiGbl_FADT->Pm1EvtLen,
182                         ACPI_FADT_OFFSET (Pm1EvtLen));
183     }
184
185     if (!AcpiGbl_FADT->Pm1CntLen)
186     {
187         AcpiUtFadtRegisterError ("PM1_CNT_LEN", 0,
188                         ACPI_FADT_OFFSET (Pm1CntLen));
189     }
190
191     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm1aEvtBlk.Address))
192     {
193         AcpiUtFadtRegisterError ("X_PM1a_EVT_BLK", 0,
194                         ACPI_FADT_OFFSET (XPm1aEvtBlk.Address));
195     }
196
197     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm1aCntBlk.Address))
198     {
199         AcpiUtFadtRegisterError ("X_PM1a_CNT_BLK", 0,
200                         ACPI_FADT_OFFSET (XPm1aCntBlk.Address));
201     }
202
203     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPmTmrBlk.Address))
204     {
205         AcpiUtFadtRegisterError ("X_PM_TMR_BLK", 0,
206                         ACPI_FADT_OFFSET (XPmTmrBlk.Address));
207     }
208
209     if ((ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm2CntBlk.Address) &&
210         !AcpiGbl_FADT->Pm2CntLen))
211     {
212         AcpiUtFadtRegisterError ("PM2_CNT_LEN",
213                         (UINT32) AcpiGbl_FADT->Pm2CntLen,
214                         ACPI_FADT_OFFSET (Pm2CntLen));
215     }
216
217     if (AcpiGbl_FADT->PmTmLen < 4)
218     {
219         AcpiUtFadtRegisterError ("PM_TM_LEN",
220                         (UINT32) AcpiGbl_FADT->PmTmLen,
221                         ACPI_FADT_OFFSET (PmTmLen));
222     }
223
224     /* Length of GPE blocks must be a multiple of 2 */
225
226     if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe0Blk.Address) &&
227         (AcpiGbl_FADT->Gpe0BlkLen & 1))
228     {
229         AcpiUtFadtRegisterError ("(x)GPE0_BLK_LEN",
230                         (UINT32) AcpiGbl_FADT->Gpe0BlkLen,
231                         ACPI_FADT_OFFSET (Gpe0BlkLen));
232     }
233
234     if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe1Blk.Address) &&
235         (AcpiGbl_FADT->Gpe1BlkLen & 1))
236     {
237         AcpiUtFadtRegisterError ("(x)GPE1_BLK_LEN",
238                         (UINT32) AcpiGbl_FADT->Gpe1BlkLen,
239                         ACPI_FADT_OFFSET (Gpe1BlkLen));
240     }
241
242     return (AE_OK);
243 }
244
245
246 /******************************************************************************
247  *
248  * FUNCTION:    AcpiUtTerminate
249  *
250  * PARAMETERS:  none
251  *
252  * RETURN:      none
253  *
254  * DESCRIPTION: free memory allocated for table storage.
255  *
256  ******************************************************************************/
257
258 void
259 AcpiUtTerminate (void)
260 {
261
262     ACPI_FUNCTION_TRACE ("UtTerminate");
263
264
265     /* Free global tables, etc. */
266
267     /* Nothing to do at this time */
268
269     return_VOID;
270 }
271
272
273 /*******************************************************************************
274  *
275  * FUNCTION:    AcpiUtSubsystemShutdown
276  *
277  * PARAMETERS:  none
278  *
279  * RETURN:      none
280  *
281  * DESCRIPTION: Shutdown the various subsystems.  Don't delete the mutex
282  *              objects here -- because the AML debugger may be still running.
283  *
284  ******************************************************************************/
285
286 void
287 AcpiUtSubsystemShutdown (void)
288 {
289
290     ACPI_FUNCTION_TRACE ("UtSubsystemShutdown");
291
292     /* Just exit if subsystem is already shutdown */
293
294     if (AcpiGbl_Shutdown)
295     {
296         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "ACPI Subsystem is already terminated\n"));
297         return_VOID;
298     }
299
300     /* Subsystem appears active, go ahead and shut it down */
301
302     AcpiGbl_Shutdown = TRUE;
303     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Shutting down ACPI Subsystem...\n"));
304
305     /* Close the AcpiEvent Handling */
306
307     AcpiEvTerminate ();
308
309     /* Close the Namespace */
310
311     AcpiNsTerminate ();
312
313     /* Close the globals */
314
315     AcpiUtTerminate ();
316
317     /* Purge the local caches */
318
319     (void) AcpiPurgeCachedObjects ();
320
321     /* Debug only - display leftover memory allocation, if any */
322
323 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
324     AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
325 #endif
326
327     return_VOID;
328 }
329
330