1 /******************************************************************************
3 * Module Name: exregion - ACPI default OpRegion (address space) handlers
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 *****************************************************************************/
153 #include "accommon.h"
154 #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;
193 ACPI_SIZE PageBoundaryMapLength;
194 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
199 ACPI_FUNCTION_TRACE (ExSystemMemorySpaceHandler);
202 /* Validate and translate the bit width */
228 ACPI_ERROR ((AE_INFO, "Invalid SystemMemory width %u",
230 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
233 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
235 * Hardware does not support non-aligned data transfers, we must verify
238 (void) AcpiUtShortDivide ((UINT64) Address, Length, NULL, &Remainder);
241 return_ACPI_STATUS (AE_AML_ALIGNMENT);
246 * Does the request fit into the cached memory mapping?
247 * Is 1) Address below the current mapping? OR
248 * 2) Address beyond the current mapping?
250 if ((Address < MemInfo->MappedPhysicalAddress) ||
251 (((UINT64) Address + Length) >
253 MemInfo->MappedPhysicalAddress + MemInfo->MappedLength)))
256 * The request cannot be resolved by the current memory mapping;
257 * Delete the existing mapping and create a new one.
259 if (MemInfo->MappedLength)
261 /* Valid mapping, delete it */
263 AcpiOsUnmapMemory (MemInfo->MappedLogicalAddress,
264 MemInfo->MappedLength);
268 * October 2009: Attempt to map from the requested address to the
269 * end of the region. However, we will never map more than one
270 * page, nor will we cross a page boundary.
272 MapLength = (ACPI_SIZE)
273 ((MemInfo->Address + MemInfo->Length) - Address);
276 * If mapping the entire remaining portion of the region will cross
277 * a page boundary, just map up to the page boundary, do not cross.
278 * On some systems, crossing a page boundary while mapping regions
279 * can cause warnings if the pages have different attributes
280 * due to resource management.
282 * This has the added benefit of constraining a single mapping to
283 * one page, which is similar to the original code that used a 4k
286 PageBoundaryMapLength = (ACPI_SIZE)
287 (ACPI_ROUND_UP (Address, ACPI_DEFAULT_PAGE_SIZE) - Address);
288 if (PageBoundaryMapLength == 0)
290 PageBoundaryMapLength = ACPI_DEFAULT_PAGE_SIZE;
293 if (MapLength > PageBoundaryMapLength)
295 MapLength = PageBoundaryMapLength;
298 /* Create a new mapping starting at the address given */
300 MemInfo->MappedLogicalAddress = AcpiOsMapMemory (Address, MapLength);
301 if (!MemInfo->MappedLogicalAddress)
303 ACPI_ERROR ((AE_INFO,
304 "Could not map memory at 0x%8.8X%8.8X, size %u",
305 ACPI_FORMAT_UINT64 (Address), (UINT32) MapLength));
306 MemInfo->MappedLength = 0;
307 return_ACPI_STATUS (AE_NO_MEMORY);
310 /* Save the physical address and mapping size */
312 MemInfo->MappedPhysicalAddress = Address;
313 MemInfo->MappedLength = MapLength;
317 * Generate a logical pointer corresponding to the address we want to
320 LogicalAddrPtr = MemInfo->MappedLogicalAddress +
321 ((UINT64) Address - (UINT64) MemInfo->MappedPhysicalAddress);
323 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
324 "System-Memory (width %u) R/W %u Address=%8.8X%8.8X\n",
325 BitWidth, Function, ACPI_FORMAT_UINT64 (Address)));
328 * Perform the memory read or write
330 * Note: For machines that do not support non-aligned transfers, the target
331 * address was checked for alignment above. We do not attempt to break the
332 * transfer up into smaller (byte-size) chunks because the AML specifically
333 * asked for a transfer width that the hardware may require.
344 *Value = (UINT64) ACPI_GET8 (LogicalAddrPtr);
349 *Value = (UINT64) ACPI_GET16 (LogicalAddrPtr);
354 *Value = (UINT64) ACPI_GET32 (LogicalAddrPtr);
359 *Value = (UINT64) ACPI_GET64 (LogicalAddrPtr);
364 /* BitWidth was already validated */
376 ACPI_SET8 (LogicalAddrPtr, *Value);
381 ACPI_SET16 (LogicalAddrPtr, *Value);
386 ACPI_SET32 (LogicalAddrPtr, *Value);
391 ACPI_SET64 (LogicalAddrPtr, *Value);
396 /* BitWidth was already validated */
404 Status = AE_BAD_PARAMETER;
408 return_ACPI_STATUS (Status);
412 /*******************************************************************************
414 * FUNCTION: AcpiExSystemIoSpaceHandler
416 * PARAMETERS: Function - Read or Write operation
417 * Address - Where in the space to read or write
418 * BitWidth - Field width in bits (8, 16, or 32)
419 * Value - Pointer to in or out value
420 * HandlerContext - Pointer to Handler's context
421 * RegionContext - Pointer to context specific to the
426 * DESCRIPTION: Handler for the System IO address space (Op Region)
428 ******************************************************************************/
431 AcpiExSystemIoSpaceHandler (
433 ACPI_PHYSICAL_ADDRESS Address,
436 void *HandlerContext,
439 ACPI_STATUS Status = AE_OK;
443 ACPI_FUNCTION_TRACE (ExSystemIoSpaceHandler);
446 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
447 "System-IO (width %u) R/W %u Address=%8.8X%8.8X\n",
448 BitWidth, Function, ACPI_FORMAT_UINT64 (Address)));
450 /* Decode the function parameter */
456 Status = AcpiHwReadPort ((ACPI_IO_ADDRESS) Address,
463 Status = AcpiHwWritePort ((ACPI_IO_ADDRESS) Address,
464 (UINT32) *Value, BitWidth);
469 Status = AE_BAD_PARAMETER;
473 return_ACPI_STATUS (Status);
477 /*******************************************************************************
479 * FUNCTION: AcpiExPciConfigSpaceHandler
481 * PARAMETERS: Function - Read or Write operation
482 * Address - Where in the space to read or write
483 * BitWidth - Field width in bits (8, 16, or 32)
484 * Value - Pointer to in or out value
485 * HandlerContext - Pointer to Handler's context
486 * RegionContext - Pointer to context specific to the
491 * DESCRIPTION: Handler for the PCI Config address space (Op Region)
493 ******************************************************************************/
496 AcpiExPciConfigSpaceHandler (
498 ACPI_PHYSICAL_ADDRESS Address,
501 void *HandlerContext,
504 ACPI_STATUS Status = AE_OK;
509 ACPI_FUNCTION_TRACE (ExPciConfigSpaceHandler);
513 * The arguments to AcpiOs(Read|Write)PciConfiguration are:
515 * PciSegment is the PCI bus segment range 0-31
516 * PciBus is the PCI bus number range 0-255
517 * PciDevice is the PCI device number range 0-31
518 * PciFunction is the PCI device function number
519 * PciRegister is the Config space register range 0-255 bytes
521 * Value - input value for write, output address for read
524 PciId = (ACPI_PCI_ID *) RegionContext;
525 PciRegister = (UINT16) (UINT32) Address;
527 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
528 "Pci-Config %u (%u) Seg(%04x) Bus(%04x) "
529 "Dev(%04x) Func(%04x) Reg(%04x)\n",
530 Function, BitWidth, PciId->Segment, PciId->Bus, PciId->Device,
531 PciId->Function, PciRegister));
538 Status = AcpiOsReadPciConfiguration (
539 PciId, PciRegister, Value, BitWidth);
544 Status = AcpiOsWritePciConfiguration (
545 PciId, PciRegister, *Value, BitWidth);
550 Status = AE_BAD_PARAMETER;
554 return_ACPI_STATUS (Status);
558 /*******************************************************************************
560 * FUNCTION: AcpiExCmosSpaceHandler
562 * PARAMETERS: Function - Read or Write operation
563 * Address - Where in the space to read or write
564 * BitWidth - Field width in bits (8, 16, or 32)
565 * Value - Pointer to in or out value
566 * HandlerContext - Pointer to Handler's context
567 * RegionContext - Pointer to context specific to the
572 * DESCRIPTION: Handler for the CMOS address space (Op Region)
574 ******************************************************************************/
577 AcpiExCmosSpaceHandler (
579 ACPI_PHYSICAL_ADDRESS Address,
582 void *HandlerContext,
585 ACPI_STATUS Status = AE_OK;
588 ACPI_FUNCTION_TRACE (ExCmosSpaceHandler);
591 return_ACPI_STATUS (Status);
595 /*******************************************************************************
597 * FUNCTION: AcpiExPciBarSpaceHandler
599 * PARAMETERS: Function - Read or Write operation
600 * Address - Where in the space to read or write
601 * BitWidth - Field width in bits (8, 16, or 32)
602 * Value - Pointer to in or out value
603 * HandlerContext - Pointer to Handler's context
604 * RegionContext - Pointer to context specific to the
609 * DESCRIPTION: Handler for the PCI BarTarget address space (Op Region)
611 ******************************************************************************/
614 AcpiExPciBarSpaceHandler (
616 ACPI_PHYSICAL_ADDRESS Address,
619 void *HandlerContext,
622 ACPI_STATUS Status = AE_OK;
625 ACPI_FUNCTION_TRACE (ExPciBarSpaceHandler);
628 return_ACPI_STATUS (Status);
632 /*******************************************************************************
634 * FUNCTION: AcpiExDataTableSpaceHandler
636 * PARAMETERS: Function - Read or Write operation
637 * Address - Where in the space to read or write
638 * BitWidth - Field width in bits (8, 16, or 32)
639 * Value - Pointer to in or out value
640 * HandlerContext - Pointer to Handler's context
641 * RegionContext - Pointer to context specific to the
646 * DESCRIPTION: Handler for the Data Table address space (Op Region)
648 ******************************************************************************/
651 AcpiExDataTableSpaceHandler (
653 ACPI_PHYSICAL_ADDRESS Address,
656 void *HandlerContext,
659 ACPI_FUNCTION_TRACE (ExDataTableSpaceHandler);
663 * Perform the memory read or write. The BitWidth was already
670 memcpy (ACPI_CAST_PTR (char, Value), ACPI_PHYSADDR_TO_PTR (Address),
671 ACPI_DIV_8 (BitWidth));
676 memcpy (ACPI_PHYSADDR_TO_PTR (Address), ACPI_CAST_PTR (char, Value),
677 ACPI_DIV_8 (BitWidth));
682 return_ACPI_STATUS (AE_BAD_PARAMETER);
685 return_ACPI_STATUS (AE_OK);