1 /******************************************************************************
3 * Module Name: hwxface - Public ACPICA hardware interfaces
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2020, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #define EXPORT_ACPI_INTERFACES
154 #include <contrib/dev/acpica/include/acpi.h>
155 #include <contrib/dev/acpica/include/accommon.h>
156 #include <contrib/dev/acpica/include/acnamesp.h>
158 #define _COMPONENT ACPI_HARDWARE
159 ACPI_MODULE_NAME ("hwxface")
162 /******************************************************************************
164 * FUNCTION: AcpiReset
170 * DESCRIPTION: Set reset register in memory or IO space. Note: Does not
171 * support reset register in PCI config space, this must be
172 * handled separately.
174 ******************************************************************************/
180 ACPI_GENERIC_ADDRESS *ResetReg;
184 ACPI_FUNCTION_TRACE (AcpiReset);
187 ResetReg = &AcpiGbl_FADT.ResetRegister;
189 /* Check if the reset register is supported */
191 if (!(AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER) ||
194 return_ACPI_STATUS (AE_NOT_EXIST);
197 if (ResetReg->SpaceId == ACPI_ADR_SPACE_SYSTEM_IO)
200 * For I/O space, write directly to the OSL. This bypasses the port
201 * validation mechanism, which may block a valid write to the reset
205 * The ACPI spec requires the reset register width to be 8, so we
206 * hardcode it here and ignore the FADT value. This maintains
207 * compatibility with other ACPI implementations that have allowed
208 * BIOS code with bad register width values to go unnoticed.
210 Status = AcpiOsWritePort ((ACPI_IO_ADDRESS) ResetReg->Address,
211 AcpiGbl_FADT.ResetValue, ACPI_RESET_REGISTER_WIDTH);
215 /* Write the reset value to the reset register */
217 Status = AcpiHwWrite (AcpiGbl_FADT.ResetValue, ResetReg);
220 return_ACPI_STATUS (Status);
223 ACPI_EXPORT_SYMBOL (AcpiReset)
226 /******************************************************************************
230 * PARAMETERS: Value - Where the value is returned
231 * Reg - GAS register structure
235 * DESCRIPTION: Read from either memory or IO space.
237 * LIMITATIONS: <These limitations also apply to AcpiWrite>
238 * BitWidth must be exactly 8, 16, 32, or 64.
239 * SpaceID must be SystemMemory or SystemIO.
240 * BitOffset and AccessWidth are currently ignored, as there has
241 * not been a need to implement these.
243 ******************************************************************************/
248 ACPI_GENERIC_ADDRESS *Reg)
253 ACPI_FUNCTION_NAME (AcpiRead);
256 Status = AcpiHwRead (ReturnValue, Reg);
260 ACPI_EXPORT_SYMBOL (AcpiRead)
263 /******************************************************************************
265 * FUNCTION: AcpiWrite
267 * PARAMETERS: Value - Value to be written
268 * Reg - GAS register structure
272 * DESCRIPTION: Write to either memory or IO space.
274 ******************************************************************************/
279 ACPI_GENERIC_ADDRESS *Reg)
284 ACPI_FUNCTION_NAME (AcpiWrite);
287 Status = AcpiHwWrite (Value, Reg);
291 ACPI_EXPORT_SYMBOL (AcpiWrite)
294 #if (!ACPI_REDUCED_HARDWARE)
295 /*******************************************************************************
297 * FUNCTION: AcpiReadBitRegister
299 * PARAMETERS: RegisterId - ID of ACPI Bit Register to access
300 * ReturnValue - Value that was read from the register,
301 * normalized to bit position zero.
303 * RETURN: Status and the value read from the specified Register. Value
304 * returned is normalized to bit0 (is shifted all the way right)
306 * DESCRIPTION: ACPI BitRegister read function. Does not acquire the HW lock.
308 * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
311 * Note: The hardware lock is not required when reading the ACPI bit registers
312 * since almost all of them are single bit and it does not matter that
313 * the parent hardware register can be split across two physical
314 * registers. The only multi-bit field is SLP_TYP in the PM1 control
315 * register, but this field does not cross an 8-bit boundary (nor does
316 * it make much sense to actually read this field.)
318 ******************************************************************************/
321 AcpiReadBitRegister (
325 ACPI_BIT_REGISTER_INFO *BitRegInfo;
326 UINT32 RegisterValue;
331 ACPI_FUNCTION_TRACE_U32 (AcpiReadBitRegister, RegisterId);
334 /* Get the info structure corresponding to the requested ACPI Register */
336 BitRegInfo = AcpiHwGetBitRegisterInfo (RegisterId);
339 return_ACPI_STATUS (AE_BAD_PARAMETER);
342 /* Read the entire parent register */
344 Status = AcpiHwRegisterRead (BitRegInfo->ParentRegister,
346 if (ACPI_FAILURE (Status))
348 return_ACPI_STATUS (Status);
351 /* Normalize the value that was read, mask off other bits */
353 Value = ((RegisterValue & BitRegInfo->AccessBitMask)
354 >> BitRegInfo->BitPosition);
356 ACPI_DEBUG_PRINT ((ACPI_DB_IO,
357 "BitReg %X, ParentReg %X, Actual %8.8X, ReturnValue %8.8X\n",
358 RegisterId, BitRegInfo->ParentRegister, RegisterValue, Value));
360 *ReturnValue = Value;
361 return_ACPI_STATUS (AE_OK);
364 ACPI_EXPORT_SYMBOL (AcpiReadBitRegister)
367 /*******************************************************************************
369 * FUNCTION: AcpiWriteBitRegister
371 * PARAMETERS: RegisterId - ID of ACPI Bit Register to access
372 * Value - Value to write to the register, in bit
373 * position zero. The bit is automatically
374 * shifted to the correct position.
378 * DESCRIPTION: ACPI Bit Register write function. Acquires the hardware lock
379 * since most operations require a read/modify/write sequence.
381 * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
384 * Note that at this level, the fact that there may be actually two
385 * hardware registers (A and B - and B may not exist) is abstracted.
387 ******************************************************************************/
390 AcpiWriteBitRegister (
394 ACPI_BIT_REGISTER_INFO *BitRegInfo;
395 ACPI_CPU_FLAGS LockFlags;
396 UINT32 RegisterValue;
397 ACPI_STATUS Status = AE_OK;
400 ACPI_FUNCTION_TRACE_U32 (AcpiWriteBitRegister, RegisterId);
403 /* Get the info structure corresponding to the requested ACPI Register */
405 BitRegInfo = AcpiHwGetBitRegisterInfo (RegisterId);
408 return_ACPI_STATUS (AE_BAD_PARAMETER);
411 LockFlags = AcpiOsAcquireLock (AcpiGbl_HardwareLock);
414 * At this point, we know that the parent register is one of the
415 * following: PM1 Status, PM1 Enable, PM1 Control, or PM2 Control
417 if (BitRegInfo->ParentRegister != ACPI_REGISTER_PM1_STATUS)
420 * 1) Case for PM1 Enable, PM1 Control, and PM2 Control
422 * Perform a register read to preserve the bits that we are not
425 Status = AcpiHwRegisterRead (BitRegInfo->ParentRegister,
427 if (ACPI_FAILURE (Status))
433 * Insert the input bit into the value that was just read
434 * and write the register
436 ACPI_REGISTER_INSERT_VALUE (RegisterValue, BitRegInfo->BitPosition,
437 BitRegInfo->AccessBitMask, Value);
439 Status = AcpiHwRegisterWrite (BitRegInfo->ParentRegister,
445 * 2) Case for PM1 Status
447 * The Status register is different from the rest. Clear an event
448 * by writing 1, writing 0 has no effect. So, the only relevant
449 * information is the single bit we're interested in, all others
450 * should be written as 0 so they will be left unchanged.
452 RegisterValue = ACPI_REGISTER_PREPARE_BITS (Value,
453 BitRegInfo->BitPosition, BitRegInfo->AccessBitMask);
455 /* No need to write the register if value is all zeros */
459 Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_STATUS,
464 ACPI_DEBUG_PRINT ((ACPI_DB_IO,
465 "BitReg %X, ParentReg %X, Value %8.8X, Actual %8.8X\n",
466 RegisterId, BitRegInfo->ParentRegister, Value, RegisterValue));
471 AcpiOsReleaseLock (AcpiGbl_HardwareLock, LockFlags);
472 return_ACPI_STATUS (Status);
475 ACPI_EXPORT_SYMBOL (AcpiWriteBitRegister)
477 #endif /* !ACPI_REDUCED_HARDWARE */
480 /*******************************************************************************
482 * FUNCTION: AcpiGetSleepTypeData
484 * PARAMETERS: SleepState - Numeric sleep state
485 * *SleepTypeA - Where SLP_TYPa is returned
486 * *SleepTypeB - Where SLP_TYPb is returned
490 * DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested
491 * sleep state via the appropriate \_Sx object.
493 * The sleep state package returned from the corresponding \_Sx_ object
494 * must contain at least one integer.
497 * Added support for a package that contains two integers. This
498 * goes against the ACPI specification which defines this object as a
499 * package with one encoded DWORD integer. However, existing practice
500 * by many BIOS vendors is to return a package with 2 or more integer
501 * elements, at least one per sleep type (A/B).
504 * Therefore, we must be prepared to accept a package with either a
505 * single integer or multiple integers.
507 * The single integer DWORD format is as follows:
508 * BYTE 0 - Value for the PM1A SLP_TYP register
509 * BYTE 1 - Value for the PM1B SLP_TYP register
510 * BYTE 2-3 - Reserved
512 * The dual integer format is as follows:
513 * Integer 0 - Value for the PM1A SLP_TYP register
514 * Integer 1 - Value for the PM1A SLP_TYP register
516 ******************************************************************************/
519 AcpiGetSleepTypeData (
525 ACPI_EVALUATE_INFO *Info;
526 ACPI_OPERAND_OBJECT **Elements;
529 ACPI_FUNCTION_TRACE (AcpiGetSleepTypeData);
532 /* Validate parameters */
534 if ((SleepState > ACPI_S_STATES_MAX) ||
535 !SleepTypeA || !SleepTypeB)
537 return_ACPI_STATUS (AE_BAD_PARAMETER);
540 /* Allocate the evaluation information block */
542 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
545 return_ACPI_STATUS (AE_NO_MEMORY);
549 * Evaluate the \_Sx namespace object containing the register values
552 Info->RelativePathname = AcpiGbl_SleepStateNames[SleepState];
554 Status = AcpiNsEvaluate (Info);
555 if (ACPI_FAILURE (Status))
557 if (Status == AE_NOT_FOUND)
559 /* The _Sx states are optional, ignore NOT_FOUND */
567 /* Must have a return object */
569 if (!Info->ReturnObject)
571 ACPI_ERROR ((AE_INFO, "No Sleep State object returned from [%s]",
572 Info->RelativePathname));
573 Status = AE_AML_NO_RETURN_VALUE;
577 /* Return object must be of type Package */
579 if (Info->ReturnObject->Common.Type != ACPI_TYPE_PACKAGE)
581 ACPI_ERROR ((AE_INFO, "Sleep State return object is not a Package"));
582 Status = AE_AML_OPERAND_TYPE;
583 goto ReturnValueCleanup;
587 * Any warnings about the package length or the object types have
588 * already been issued by the predefined name module -- there is no
589 * need to repeat them here.
591 Elements = Info->ReturnObject->Package.Elements;
592 switch (Info->ReturnObject->Package.Count)
596 Status = AE_AML_PACKAGE_LIMIT;
601 if (Elements[0]->Common.Type != ACPI_TYPE_INTEGER)
603 Status = AE_AML_OPERAND_TYPE;
607 /* A valid _Sx_ package with one integer */
609 *SleepTypeA = (UINT8) Elements[0]->Integer.Value;
610 *SleepTypeB = (UINT8) (Elements[0]->Integer.Value >> 8);
616 if ((Elements[0]->Common.Type != ACPI_TYPE_INTEGER) ||
617 (Elements[1]->Common.Type != ACPI_TYPE_INTEGER))
619 Status = AE_AML_OPERAND_TYPE;
623 /* A valid _Sx_ package with two integers */
625 *SleepTypeA = (UINT8) Elements[0]->Integer.Value;
626 *SleepTypeB = (UINT8) Elements[1]->Integer.Value;
631 AcpiUtRemoveReference (Info->ReturnObject);
634 if (ACPI_FAILURE (Status))
636 ACPI_EXCEPTION ((AE_INFO, Status,
637 "While evaluating Sleep State [%s]",
638 Info->RelativePathname));
643 return_ACPI_STATUS (Status);
646 ACPI_EXPORT_SYMBOL (AcpiGetSleepTypeData)