drivers/acpica/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 - 2009, 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 #define __RSADDR_C__
0117
0118 #include "acpi.h"
0119 #include "accommon.h"
0120 #include "acresrc.h"
0121
0122 #define _COMPONENT          ACPI_RESOURCES
0123         ACPI_MODULE_NAME    ("rsaddr")
0124
0125
0126 /*******************************************************************************
0127  *
0128  * AcpiRsConvertAddress16 - All WORD (16-bit) address resources
0129  *
0130  ******************************************************************************/
0131
0132 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress16[5] =
0133 {
0134     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS16,
0135                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS16),
0136                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress16)},
0137
0138     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS16,
0139                         sizeof (AML_RESOURCE_ADDRESS16),
0140                         0},
0141
0142     /* Resource Type, General Flags, and Type-Specific Flags */
0143
0144     {ACPI_RSC_ADDRESS,  0, 0, 0},
0145
0146     /*
0147      * These fields are contiguous in both the source and destination:
0148      * Address Granularity
0149      * Address Range Minimum
0150      * Address Range Maximum
0151      * Address Translation Offset
0152      * Address Length
0153      */
0154     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.Address16.Granularity),
0155                         AML_OFFSET (Address16.Granularity),
0156                         5},
0157
0158     /* Optional ResourceSource (Index and String) */
0159
0160     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address16.ResourceSource),
0161                         0,
0162                         sizeof (AML_RESOURCE_ADDRESS16)}
0163 };
0164
0165
0166 /*******************************************************************************
0167  *
0168  * AcpiRsConvertAddress32 - All DWORD (32-bit) address resources
0169  *
0170  ******************************************************************************/
0171
0172 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress32[5] =
0173 {
0174     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS32,
0175                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS32),
0176                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress32)},
0177
0178     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS32,
0179                         sizeof (AML_RESOURCE_ADDRESS32),
0180                         0},
0181
0182     /* Resource Type, General Flags, and Type-Specific Flags */
0183
0184     {ACPI_RSC_ADDRESS,  0, 0, 0},
0185
0186     /*
0187      * These fields are contiguous in both the source and destination:
0188      * Address Granularity
0189      * Address Range Minimum
0190      * Address Range Maximum
0191      * Address Translation Offset
0192      * Address Length
0193      */
0194     {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.Address32.Granularity),
0195                         AML_OFFSET (Address32.Granularity),
0196                         5},
0197
0198     /* Optional ResourceSource (Index and String) */
0199
0200     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address32.ResourceSource),
0201                         0,
0202                         sizeof (AML_RESOURCE_ADDRESS32)}
0203 };
0204
0205
0206 /*******************************************************************************
0207  *
0208  * AcpiRsConvertAddress64 - All QWORD (64-bit) address resources
0209  *
0210  ******************************************************************************/
0211
0212 ACPI_RSCONVERT_INFO     AcpiRsConvertAddress64[5] =
0213 {
0214     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_ADDRESS64,
0215                         ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS64),
0216                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress64)},
0217
0218     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_ADDRESS64,
0219                         sizeof (AML_RESOURCE_ADDRESS64),
0220                         0},
0221
0222     /* Resource Type, General Flags, and Type-Specific Flags */
0223
0224     {ACPI_RSC_ADDRESS,  0, 0, 0},
0225
0226     /*
0227      * These fields are contiguous in both the source and destination:
0228      * Address Granularity
0229      * Address Range Minimum
0230      * Address Range Maximum
0231      * Address Translation Offset
0232      * Address Length
0233      */
0234     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.Address64.Granularity),
0235                         AML_OFFSET (Address64.Granularity),
0236                         5},
0237
0238     /* Optional ResourceSource (Index and String) */
0239
0240     {ACPI_RSC_SOURCE,   ACPI_RS_OFFSET (Data.Address64.ResourceSource),
0241                         0,
0242                         sizeof (AML_RESOURCE_ADDRESS64)}
0243 };
0244
0245
0246 /*******************************************************************************
0247  *
0248  * AcpiRsConvertExtAddress64 - All Extended (64-bit) address resources
0249  *
0250  ******************************************************************************/
0251
0252 ACPI_RSCONVERT_INFO     AcpiRsConvertExtAddress64[5] =
0253 {
0254     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64,
0255                         ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_ADDRESS64),
0256                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertExtAddress64)},
0257
0258     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64,
0259                         sizeof (AML_RESOURCE_EXTENDED_ADDRESS64),
0260                         0},
0261
0262     /* Resource Type, General Flags, and Type-Specific Flags */
0263
0264     {ACPI_RSC_ADDRESS,  0, 0, 0},
0265
0266     /* Revision ID */
0267
0268     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.ExtAddress64.RevisionID),
0269                         AML_OFFSET (ExtAddress64.RevisionID),
0270                         1},
0271     /*
0272      * These fields are contiguous in both the source and destination:
0273      * Address Granularity
0274      * Address Range Minimum
0275      * Address Range Maximum
0276      * Address Translation Offset
0277      * Address Length
0278      * Type-Specific Attribute
0279      */
0280     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.ExtAddress64.Granularity),
0281                         AML_OFFSET (ExtAddress64.Granularity),
0282                         6}
0283 };
0284
0285
0286 /*******************************************************************************
0287  *
0288  * AcpiRsConvertGeneralFlags - Flags common to all address descriptors
0289  *
0290  ******************************************************************************/
0291
0292 static ACPI_RSCONVERT_INFO  AcpiRsConvertGeneralFlags[6] =
0293 {
0294     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.Flags),
0295                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertGeneralFlags)},
0296
0297     /* Resource Type (Memory, Io, BusNumber, etc.) */
0298
0299     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Address.ResourceType),
0300                         AML_OFFSET (Address.ResourceType),
0301                         1},
0302
0303     /* General Flags - Consume, Decode, MinFixed, MaxFixed */
0304
0305     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.ProducerConsumer),
0306                         AML_OFFSET (Address.Flags),
0307                         0},
0308
0309     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Decode),
0310                         AML_OFFSET (Address.Flags),
0311                         1},
0312
0313     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MinAddressFixed),
0314                         AML_OFFSET (Address.Flags),
0315                         2},
0316
0317     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MaxAddressFixed),
0318                         AML_OFFSET (Address.Flags),
0319                         3}
0320 };
0321
0322
0323 /*******************************************************************************
0324  *
0325  * AcpiRsConvertMemFlags - Flags common to Memory address descriptors
0326  *
0327  ******************************************************************************/
0328
0329 static ACPI_RSCONVERT_INFO  AcpiRsConvertMemFlags[5] =
0330 {
0331     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags),
0332                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertMemFlags)},
0333
0334     /* Memory-specific flags */
0335
0336     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.WriteProtect),
0337                         AML_OFFSET (Address.SpecificFlags),
0338                         0},
0339
0340     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Caching),
0341                         AML_OFFSET (Address.SpecificFlags),
0342                         1},
0343
0344     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.RangeType),
0345                         AML_OFFSET (Address.SpecificFlags),
0346                         3},
0347
0348     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Translation),
0349                         AML_OFFSET (Address.SpecificFlags),
0350                         5}
0351 };
0352
0353
0354 /*******************************************************************************
0355  *
0356  * AcpiRsConvertIoFlags - Flags common to I/O address descriptors
0357  *
0358  ******************************************************************************/
0359
0360 static ACPI_RSCONVERT_INFO  AcpiRsConvertIoFlags[4] =
0361 {
0362     {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags),
0363                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertIoFlags)},
0364
0365     /* I/O-specific flags */
0366
0367     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.RangeType),
0368                         AML_OFFSET (Address.SpecificFlags),
0369                         0},
0370
0371     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.Translation),
0372                         AML_OFFSET (Address.SpecificFlags),
0373                         4},
0374
0375     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.TranslationType),
0376                         AML_OFFSET (Address.SpecificFlags),
0377                         5}
0378 };
0379
0380
0381 /*******************************************************************************
0382  *
0383  * FUNCTION:    AcpiRsGetAddressCommon
0384  *
0385  * PARAMETERS:  Resource            - Pointer to the internal resource struct
0386  *              Aml                 - Pointer to the AML resource descriptor
0387  *
0388  * RETURN:      TRUE if the ResourceType field is OK, FALSE otherwise
0389  *
0390  * DESCRIPTION: Convert common flag fields from a raw AML resource descriptor
0391  *              to an internal resource descriptor
0392  *
0393  ******************************************************************************/
0394
0395 BOOLEAN
0396 AcpiRsGetAddressCommon (
0397     ACPI_RESOURCE           *Resource,
0398     AML_RESOURCE            *Aml)
0399 {
0400     ACPI_FUNCTION_ENTRY ();
0401
0402
0403     /* Validate the Resource Type */
0404
0405     if ((Aml->Address.ResourceType > 2) && (Aml->Address.ResourceType < 0xC0))
0406     {
0407         return (FALSE);
0408     }
0409
0410     /* Get the Resource Type and General Flags */
0411
0412     (void) AcpiRsConvertAmlToResource (Resource, Aml, AcpiRsConvertGeneralFlags);
0413
0414     /* Get the Type-Specific Flags (Memory and I/O descriptors only) */
0415
0416     if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE)
0417     {
0418         (void) AcpiRsConvertAmlToResource (Resource, Aml, AcpiRsConvertMemFlags);
0419     }
0420     else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE)
0421     {
0422         (void) AcpiRsConvertAmlToResource (Resource, Aml, AcpiRsConvertIoFlags);
0423     }
0424     else
0425     {
0426         /* Generic resource type, just grab the TypeSpecific byte */
0427
0428         Resource->Data.Address.Info.TypeSpecific = Aml->Address.SpecificFlags;
0429     }
0430
0431     return (TRUE);
0432 }
0433
0434
0435 /*******************************************************************************
0436  *
0437  * FUNCTION:    AcpiRsSetAddressCommon
0438  *
0439  * PARAMETERS:  Aml                 - Pointer to the AML resource descriptor
0440  *              Resource            - Pointer to the internal resource struct
0441  *
0442  * RETURN:      None
0443  *
0444  * DESCRIPTION: Convert common flag fields from a resource descriptor to an
0445  *              AML descriptor
0446  *
0447  ******************************************************************************/
0448
0449 void
0450 AcpiRsSetAddressCommon (
0451     AML_RESOURCE            *Aml,
0452     ACPI_RESOURCE           *Resource)
0453 {
0454     ACPI_FUNCTION_ENTRY ();
0455
0456
0457     /* Set the Resource Type and General Flags */
0458
0459     (void) AcpiRsConvertResourceToAml (Resource, Aml, AcpiRsConvertGeneralFlags);
0460
0461     /* Set the Type-Specific Flags (Memory and I/O descriptors only) */
0462
0463     if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE)
0464     {
0465         (void) AcpiRsConvertResourceToAml (Resource, Aml, AcpiRsConvertMemFlags);
0466     }
0467     else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE)
0468     {
0469         (void) AcpiRsConvertResourceToAml (Resource, Aml, AcpiRsConvertIoFlags);
0470     }
0471     else
0472     {
0473         /* Generic resource type, just copy the TypeSpecific byte */
0474
0475         Aml->Address.SpecificFlags = Resource->Data.Address.Info.TypeSpecific;
0476     }
0477 }
0478
0479