1 /******************************************************************************
3 * Module Name: exregion - ACPI default OpRegion (address space) handlers
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 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acinterp.h>
157 #define _COMPONENT ACPI_EXECUTER
158 ACPI_MODULE_NAME ("exregion")
161 /*******************************************************************************
163 * FUNCTION: AcpiExSystemMemorySpaceHandler
165 * PARAMETERS: Function - Read or Write operation
166 * Address - Where in the space to read or write
167 * BitWidth - Field width in bits (8, 16, or 32)
168 * Value - Pointer to in or out value
169 * HandlerContext - Pointer to Handler's context
170 * RegionContext - Pointer to context specific to the
175 * DESCRIPTION: Handler for the System Memory address space (Op Region)
177 ******************************************************************************/
180 AcpiExSystemMemorySpaceHandler (
182 ACPI_PHYSICAL_ADDRESS Address,
185 void *HandlerContext,
188 ACPI_STATUS Status = AE_OK;
189 void *LogicalAddrPtr = NULL;
190 ACPI_MEM_SPACE_CONTEXT *MemInfo = RegionContext;
191 ACPI_MEM_MAPPING *Mm = MemInfo->CurMm;
194 ACPI_SIZE PageBoundaryMapLength;
195 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
200 ACPI_FUNCTION_TRACE (ExSystemMemorySpaceHandler);
203 /* Validate and translate the bit width */
229 ACPI_ERROR ((AE_INFO, "Invalid SystemMemory width %u",
231 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
234 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
236 * Hardware does not support non-aligned data transfers, we must verify
239 (void) AcpiUtShortDivide ((UINT64) Address, Length, NULL, &Remainder);
242 return_ACPI_STATUS (AE_AML_ALIGNMENT);
247 * Does the request fit into the cached memory mapping?
248 * Is 1) Address below the current mapping? OR
249 * 2) Address beyond the current mapping?
251 if (!Mm || (Address < Mm->PhysicalAddress) ||
252 ((UINT64) Address + Length > (UINT64) Mm->PhysicalAddress + Mm->Length))
255 * The request cannot be resolved by the current memory mapping.
257 * Look for an existing saved mapping covering the address range
258 * at hand. If found, save it as the current one and carry out
261 for (Mm = MemInfo->FirstMm; Mm; Mm = Mm->NextMm)
263 if (Mm == MemInfo->CurMm)
268 if (Address < Mm->PhysicalAddress)
273 if ((UINT64) Address + Length > (UINT64) Mm->PhysicalAddress + Mm->Length)
282 /* Create a new mappings list entry */
284 Mm = ACPI_ALLOCATE_ZEROED(sizeof(*Mm));
288 "Unable to save memory mapping at 0x%8.8X%8.8X, size %u",
289 ACPI_FORMAT_UINT64(Address), Length));
290 return_ACPI_STATUS(AE_NO_MEMORY);
294 * October 2009: Attempt to map from the requested address to the
295 * end of the region. However, we will never map more than one
296 * page, nor will we cross a page boundary.
298 MapLength = (ACPI_SIZE)
299 ((MemInfo->Address + MemInfo->Length) - Address);
302 * If mapping the entire remaining portion of the region will cross
303 * a page boundary, just map up to the page boundary, do not cross.
304 * On some systems, crossing a page boundary while mapping regions
305 * can cause warnings if the pages have different attributes
306 * due to resource management.
308 * This has the added benefit of constraining a single mapping to
309 * one page, which is similar to the original code that used a 4k
312 PageBoundaryMapLength = (ACPI_SIZE)
313 (ACPI_ROUND_UP (Address, ACPI_DEFAULT_PAGE_SIZE) - Address);
314 if (PageBoundaryMapLength == 0)
316 PageBoundaryMapLength = ACPI_DEFAULT_PAGE_SIZE;
319 if (MapLength > PageBoundaryMapLength)
321 MapLength = PageBoundaryMapLength;
324 /* Create a new mapping starting at the address given */
326 LogicalAddrPtr = AcpiOsMapMemory(Address, MapLength);
329 ACPI_ERROR ((AE_INFO,
330 "Could not map memory at 0x%8.8X%8.8X, size %u",
331 ACPI_FORMAT_UINT64 (Address), (UINT32) MapLength));
333 return_ACPI_STATUS (AE_NO_MEMORY);
336 /* Save the physical address and mapping size */
338 Mm->LogicalAddress = LogicalAddrPtr;
339 Mm->PhysicalAddress = Address;
340 Mm->Length = MapLength;
343 * Add the new entry to the mappigs list and save it as the
346 Mm->NextMm = MemInfo->FirstMm;
347 MemInfo->FirstMm = Mm;
353 * Generate a logical pointer corresponding to the address we want to
356 LogicalAddrPtr = Mm->LogicalAddress +
357 ((UINT64) Address - (UINT64) Mm->PhysicalAddress);
359 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
360 "System-Memory (width %u) R/W %u Address=%8.8X%8.8X\n",
361 BitWidth, Function, ACPI_FORMAT_UINT64 (Address)));
364 * Perform the memory read or write
366 * Note: For machines that do not support non-aligned transfers, the target
367 * address was checked for alignment above. We do not attempt to break the
368 * transfer up into smaller (byte-size) chunks because the AML specifically
369 * asked for a transfer width that the hardware may require.
380 *Value = (UINT64) ACPI_GET8 (LogicalAddrPtr);
385 *Value = (UINT64) ACPI_GET16 (LogicalAddrPtr);
390 *Value = (UINT64) ACPI_GET32 (LogicalAddrPtr);
395 *Value = (UINT64) ACPI_GET64 (LogicalAddrPtr);
400 /* BitWidth was already validated */
412 ACPI_SET8 (LogicalAddrPtr, *Value);
417 ACPI_SET16 (LogicalAddrPtr, *Value);
422 ACPI_SET32 (LogicalAddrPtr, *Value);
427 ACPI_SET64 (LogicalAddrPtr, *Value);
432 /* BitWidth was already validated */
440 Status = AE_BAD_PARAMETER;
444 return_ACPI_STATUS (Status);
448 /*******************************************************************************
450 * FUNCTION: AcpiExSystemIoSpaceHandler
452 * PARAMETERS: Function - Read or Write operation
453 * Address - Where in the space to read or write
454 * BitWidth - Field width in bits (8, 16, or 32)
455 * Value - Pointer to in or out value
456 * HandlerContext - Pointer to Handler's context
457 * RegionContext - Pointer to context specific to the
462 * DESCRIPTION: Handler for the System IO address space (Op Region)
464 ******************************************************************************/
467 AcpiExSystemIoSpaceHandler (
469 ACPI_PHYSICAL_ADDRESS Address,
472 void *HandlerContext,
475 ACPI_STATUS Status = AE_OK;
479 ACPI_FUNCTION_TRACE (ExSystemIoSpaceHandler);
482 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
483 "System-IO (width %u) R/W %u Address=%8.8X%8.8X\n",
484 BitWidth, Function, ACPI_FORMAT_UINT64 (Address)));
486 /* Decode the function parameter */
492 Status = AcpiHwReadPort ((ACPI_IO_ADDRESS) Address,
499 Status = AcpiHwWritePort ((ACPI_IO_ADDRESS) Address,
500 (UINT32) *Value, BitWidth);
505 Status = AE_BAD_PARAMETER;
509 return_ACPI_STATUS (Status);
513 /*******************************************************************************
515 * FUNCTION: AcpiExPciConfigSpaceHandler
517 * PARAMETERS: Function - Read or Write operation
518 * Address - Where in the space to read or write
519 * BitWidth - Field width in bits (8, 16, or 32)
520 * Value - Pointer to in or out value
521 * HandlerContext - Pointer to Handler's context
522 * RegionContext - Pointer to context specific to the
527 * DESCRIPTION: Handler for the PCI Config address space (Op Region)
529 ******************************************************************************/
532 AcpiExPciConfigSpaceHandler (
534 ACPI_PHYSICAL_ADDRESS Address,
537 void *HandlerContext,
540 ACPI_STATUS Status = AE_OK;
545 ACPI_FUNCTION_TRACE (ExPciConfigSpaceHandler);
549 * The arguments to AcpiOs(Read|Write)PciConfiguration are:
551 * PciSegment is the PCI bus segment range 0-31
552 * PciBus is the PCI bus number range 0-255
553 * PciDevice is the PCI device number range 0-31
554 * PciFunction is the PCI device function number
555 * PciRegister is the Config space register range 0-255 bytes
557 * Value - input value for write, output address for read
560 PciId = (ACPI_PCI_ID *) RegionContext;
561 PciRegister = (UINT16) (UINT32) Address;
563 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
564 "Pci-Config %u (%u) Seg(%04x) Bus(%04x) "
565 "Dev(%04x) Func(%04x) Reg(%04x)\n",
566 Function, BitWidth, PciId->Segment, PciId->Bus, PciId->Device,
567 PciId->Function, PciRegister));
574 Status = AcpiOsReadPciConfiguration (
575 PciId, PciRegister, Value, BitWidth);
580 Status = AcpiOsWritePciConfiguration (
581 PciId, PciRegister, *Value, BitWidth);
586 Status = AE_BAD_PARAMETER;
590 return_ACPI_STATUS (Status);
594 /*******************************************************************************
596 * FUNCTION: AcpiExCmosSpaceHandler
598 * PARAMETERS: Function - Read or Write operation
599 * Address - Where in the space to read or write
600 * BitWidth - Field width in bits (8, 16, or 32)
601 * Value - Pointer to in or out value
602 * HandlerContext - Pointer to Handler's context
603 * RegionContext - Pointer to context specific to the
608 * DESCRIPTION: Handler for the CMOS address space (Op Region)
610 ******************************************************************************/
613 AcpiExCmosSpaceHandler (
615 ACPI_PHYSICAL_ADDRESS Address,
618 void *HandlerContext,
621 ACPI_STATUS Status = AE_OK;
624 ACPI_FUNCTION_TRACE (ExCmosSpaceHandler);
627 return_ACPI_STATUS (Status);
631 /*******************************************************************************
633 * FUNCTION: AcpiExPciBarSpaceHandler
635 * PARAMETERS: Function - Read or Write operation
636 * Address - Where in the space to read or write
637 * BitWidth - Field width in bits (8, 16, or 32)
638 * Value - Pointer to in or out value
639 * HandlerContext - Pointer to Handler's context
640 * RegionContext - Pointer to context specific to the
645 * DESCRIPTION: Handler for the PCI BarTarget address space (Op Region)
647 ******************************************************************************/
650 AcpiExPciBarSpaceHandler (
652 ACPI_PHYSICAL_ADDRESS Address,
655 void *HandlerContext,
658 ACPI_STATUS Status = AE_OK;
661 ACPI_FUNCTION_TRACE (ExPciBarSpaceHandler);
664 return_ACPI_STATUS (Status);
668 /*******************************************************************************
670 * FUNCTION: AcpiExDataTableSpaceHandler
672 * PARAMETERS: Function - Read or Write operation
673 * Address - Where in the space to read or write
674 * BitWidth - Field width in bits (8, 16, or 32)
675 * Value - Pointer to in or out value
676 * HandlerContext - Pointer to Handler's context
677 * RegionContext - Pointer to context specific to the
682 * DESCRIPTION: Handler for the Data Table address space (Op Region)
684 ******************************************************************************/
687 AcpiExDataTableSpaceHandler (
689 ACPI_PHYSICAL_ADDRESS Address,
692 void *HandlerContext,
695 ACPI_FUNCTION_TRACE (ExDataTableSpaceHandler);
699 * Perform the memory read or write. The BitWidth was already
706 memcpy (ACPI_CAST_PTR (char, Value), ACPI_PHYSADDR_TO_PTR (Address),
707 ACPI_DIV_8 (BitWidth));
712 memcpy (ACPI_PHYSADDR_TO_PTR (Address), ACPI_CAST_PTR (char, Value),
713 ACPI_DIV_8 (BitWidth));
718 return_ACPI_STATUS (AE_BAD_PARAMETER);
721 return_ACPI_STATUS (AE_OK);