acpica/resources/rsaddr.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: rsaddr - Address resource descriptors (16/32/64)
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acresrc.h"
0155
0156 #define _COMPONENT          ACPI_RESOURCES
0157         ACPI_MODULE_NAME    ("rsaddr")
0158
0159
0160 /*******************************************************************************
0161  *
0162  * AcpiRsConvertAddress16 - All WORD (16-bit) address resources
0163  *
0164  ******************************************************************************/
0165
0166 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress16[5] =
0167 {
0168     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS16,
0169                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS16),
0170                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress16)},
0171
0172     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS16,
0173                         sizeof (AML_RESOURCE_ADDRESS16),
0174                         0},
0175
0176     /* Resource Type, General Flags, and Type-Specific Flags */
0177
0178     {ACPI_RSC_ADDRESS,  0, 0, 0},
0179
0180     /*
0181      * These fields are contiguous in both the source and destination:
0182      * Address Granularity
0183      * Address Range Minimum
0184      * Address Range Maximum
0185      * Address Translation Offset
0186      * Address Length
0187      */
0188     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.Address16.Address.Granularity),
0189                         AML_OFFSET (Address16.Granularity),
0190                         5},
0191
0192     /* Optional ResourceSource (Index and String) */
0193
0194     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address16.ResourceSource),
0195                         0,
0196                         sizeof (AML_RESOURCE_ADDRESS16)}
0197 };
0198
0199
0200 /*******************************************************************************
0201  *
0202  * AcpiRsConvertAddress32 - All DWORD (32-bit) address resources
0203  *
0204  ******************************************************************************/
0205
0206 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress32[5] =
0207 {
0208     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS32,
0209                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS32),
0210                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress32)},
0211
0212     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS32,
0213                         sizeof (AML_RESOURCE_ADDRESS32),
0214                         0},
0215
0216     /* Resource Type, General Flags, and Type-Specific Flags */
0217
0218     {ACPI_RSC_ADDRESS,  0, 0, 0},
0219
0220     /*
0221      * These fields are contiguous in both the source and destination:
0222      * Address Granularity
0223      * Address Range Minimum
0224      * Address Range Maximum
0225      * Address Translation Offset
0226      * Address Length
0227      */
0228     {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.Address32.Address.Granularity),
0229                         AML_OFFSET (Address32.Granularity),
0230                         5},
0231
0232     /* Optional ResourceSource (Index and String) */
0233
0234     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address32.ResourceSource),
0235                         0,
0236                         sizeof (AML_RESOURCE_ADDRESS32)}
0237 };
0238
0239
0240 /*******************************************************************************
0241  *
0242  * AcpiRsConvertAddress64 - All QWORD (64-bit) address resources
0243  *
0244  ******************************************************************************/
0245
0246 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress64[5] =
0247 {
0248     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS64,
0249                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS64),
0250                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress64)},
0251
0252     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS64,
0253                         sizeof (AML_RESOURCE_ADDRESS64),
0254                         0},
0255
0256     /* Resource Type, General Flags, and Type-Specific Flags */
0257
0258     {ACPI_RSC_ADDRESS,  0, 0, 0},
0259
0260     /*
0261      * These fields are contiguous in both the source and destination:
0262      * Address Granularity
0263      * Address Range Minimum
0264      * Address Range Maximum
0265      * Address Translation Offset
0266      * Address Length
0267      */
0268     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.Address64.Address.Granularity),
0269                         AML_OFFSET (Address64.Granularity),
0270                         5},
0271
0272     /* Optional ResourceSource (Index and String) */
0273
0274     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address64.ResourceSource),
0275                         0,
0276                         sizeof (AML_RESOURCE_ADDRESS64)}
0277 };
0278
0279
0280 /*******************************************************************************
0281  *
0282  * AcpiRsConvertExtAddress64 - All Extended (64-bit) address resources
0283  *
0284  ******************************************************************************/
0285
0286 ACPI_RSCONVERT_INFO     AcpiRsConvertExtAddress64[5] =
0287 {
0288     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64,
0289                         ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_ADDRESS64),
0290                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertExtAddress64)},
0291
0292     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64,
0293                         sizeof (AML_RESOURCE_EXTENDED_ADDRESS64),
0294                         0},
0295
0296     /* Resource Type, General Flags, and Type-Specific Flags */
0297
0298     {ACPI_RSC_ADDRESS,  0, 0, 0},
0299
0300     /* Revision ID */
0301
0302     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.ExtAddress64.RevisionID),
0303                         AML_OFFSET (ExtAddress64.RevisionID),
0304                         1},
0305     /*
0306      * These fields are contiguous in both the source and destination:
0307      * Address Granularity
0308      * Address Range Minimum
0309      * Address Range Maximum
0310      * Address Translation Offset
0311      * Address Length
0312      * Type-Specific Attribute
0313      */
0314     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.ExtAddress64.Address.Granularity),
0315                         AML_OFFSET (ExtAddress64.Granularity),
0316                         6}
0317 };
0318
0319
0320 /*******************************************************************************
0321  *
0322  * AcpiRsConvertGeneralFlags - Flags common to all address descriptors
0323  *
0324  ******************************************************************************/
0325
0326 static ACPI_RSCONVERT_INFO  AcpiRsConvertGeneralFlags[6] =
0327 {
0328     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.Flags),
0329                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertGeneralFlags)},
0330
0331     /* Resource Type (Memory, Io, BusNumber, etc.) */
0332
0333     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Address.ResourceType),
0334                         AML_OFFSET (Address.ResourceType),
0335                         1},
0336
0337     /* General Flags - Consume, Decode, MinFixed, MaxFixed */
0338
0339     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.ProducerConsumer),
0340                         AML_OFFSET (Address.Flags),
0341                         0},
0342
0343     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Decode),
0344                         AML_OFFSET (Address.Flags),
0345                         1},
0346
0347     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MinAddressFixed),
0348                         AML_OFFSET (Address.Flags),
0349                         2},
0350
0351     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MaxAddressFixed),
0352                         AML_OFFSET (Address.Flags),
0353                         3}
0354 };
0355
0356
0357 /*******************************************************************************
0358  *
0359  * AcpiRsConvertMemFlags - Flags common to Memory address descriptors
0360  *
0361  ******************************************************************************/
0362
0363 static ACPI_RSCONVERT_INFO  AcpiRsConvertMemFlags[5] =
0364 {
0365     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags),
0366                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertMemFlags)},
0367
0368     /* Memory-specific flags */
0369
0370     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.WriteProtect),
0371                         AML_OFFSET (Address.SpecificFlags),
0372                         0},
0373
0374     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Caching),
0375                         AML_OFFSET (Address.SpecificFlags),
0376                         1},
0377
0378     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.RangeType),
0379                         AML_OFFSET (Address.SpecificFlags),
0380                         3},
0381
0382     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Translation),
0383                         AML_OFFSET (Address.SpecificFlags),
0384                         5}
0385 };
0386
0387
0388 /*******************************************************************************
0389  *
0390  * AcpiRsConvertIoFlags - Flags common to I/O address descriptors
0391  *
0392  ******************************************************************************/
0393
0394 static ACPI_RSCONVERT_INFO  AcpiRsConvertIoFlags[4] =
0395 {
0396     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags),
0397                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertIoFlags)},
0398
0399     /* I/O-specific flags */
0400
0401     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.RangeType),
0402                         AML_OFFSET (Address.SpecificFlags),
0403                         0},
0404
0405     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.Translation),
0406                         AML_OFFSET (Address.SpecificFlags),
0407                         4},
0408
0409     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.TranslationType),
0410                         AML_OFFSET (Address.SpecificFlags),
0411                         5}
0412 };
0413
0414
0415 /*******************************************************************************
0416  *
0417  * FUNCTION:    AcpiRsGetAddressCommon
0418  *
0419  * PARAMETERS:  Resource            - Pointer to the internal resource struct
0420  *              Aml                 - Pointer to the AML resource descriptor
0421  *
0422  * RETURN:      TRUE if the ResourceType field is OK, FALSE otherwise
0423  *
0424  * DESCRIPTION: Convert common flag fields from a raw AML resource descriptor
0425  *              to an internal resource descriptor
0426  *
0427  ******************************************************************************/
0428
0429 BOOLEAN
0430 AcpiRsGetAddressCommon (
0431     ACPI_RESOURCE           *Resource,
0432     AML_RESOURCE            *Aml)
0433 {
0434
0435     /* Avoid undefined behavior: member access within misaligned address */
0436
0437     AML_RESOURCE_ADDRESS Address;
0438     memcpy(&Address, Aml, sizeof(Address));
0439     ACPI_FUNCTION_ENTRY();
0440
0441     /* Validate the Resource Type */
0442
0443     if ((Address.ResourceType > 2) &&
0444         (Address.ResourceType < 0xC0) &&
0445         (Address.ResourceType != 0x0A))
0446     {
0447         return (FALSE);
0448     }
0449
0450     /* Get the Resource Type and General Flags */
0451
0452     (void) AcpiRsConvertAmlToResource (
0453         Resource, Aml, AcpiRsConvertGeneralFlags);
0454
0455     /* Get the Type-Specific Flags (Memory and I/O descriptors only) */
0456
0457     if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE)
0458     {
0459         (void) AcpiRsConvertAmlToResource (
0460             Resource, Aml, AcpiRsConvertMemFlags);
0461     }
0462     else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE)
0463     {
0464         (void) AcpiRsConvertAmlToResource (
0465             Resource, Aml, AcpiRsConvertIoFlags);
0466     }
0467     else
0468     {
0469         /* Generic resource type, just grab the TypeSpecific byte */
0470
0471         Resource->Data.Address.Info.TypeSpecific =
0472             Address.SpecificFlags;
0473     }
0474
0475     return (TRUE);
0476 }
0477
0478
0479 /*******************************************************************************
0480  *
0481  * FUNCTION:    AcpiRsSetAddressCommon
0482  *
0483  * PARAMETERS:  Aml                 - Pointer to the AML resource descriptor
0484  *              Resource            - Pointer to the internal resource struct
0485  *
0486  * RETURN:      None
0487  *
0488  * DESCRIPTION: Convert common flag fields from a resource descriptor to an
0489  *              AML descriptor
0490  *
0491  ******************************************************************************/
0492
0493 void
0494 AcpiRsSetAddressCommon (
0495     AML_RESOURCE            *Aml,
0496     ACPI_RESOURCE           *Resource)
0497 {
0498     ACPI_FUNCTION_ENTRY ();
0499
0500
0501     /* Set the Resource Type and General Flags */
0502
0503     (void) AcpiRsConvertResourceToAml (
0504         Resource, Aml, AcpiRsConvertGeneralFlags);
0505
0506     /* Set the Type-Specific Flags (Memory and I/O descriptors only) */
0507
0508     if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE)
0509     {
0510         (void) AcpiRsConvertResourceToAml (
0511             Resource, Aml, AcpiRsConvertMemFlags);
0512     }
0513     else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE)
0514     {
0515         (void) AcpiRsConvertResourceToAml (
0516             Resource, Aml, AcpiRsConvertIoFlags);
0517     }
0518     else
0519     {
0520         /* Generic resource type, just copy the TypeSpecific byte */
0521
0522         Aml->Address.SpecificFlags =
0523             Resource->Data.Address.Info.TypeSpecific;
0524     }
0525 }