drivers/acpica/rsio.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: rsio - IO and DMA resource descriptors
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 __RSIO_C__
0117
0118 #include "acpi.h"
0119 #include "accommon.h"
0120 #include "acresrc.h"
0121
0122 #define _COMPONENT          ACPI_RESOURCES
0123         ACPI_MODULE_NAME    ("rsio")
0124
0125
0126 /*******************************************************************************
0127  *
0128  * AcpiRsConvertIo
0129  *
0130  ******************************************************************************/
0131
0132 ACPI_RSCONVERT_INFO     AcpiRsConvertIo[5] =
0133 {
0134     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_IO,
0135                         ACPI_RS_SIZE (ACPI_RESOURCE_IO),
0136                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertIo)},
0137
0138     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_IO,
0139                         sizeof (AML_RESOURCE_IO),
0140                         0},
0141
0142     /* Decode flag */
0143
0144     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Io.IoDecode),
0145                         AML_OFFSET (Io.Flags),
0146                         0},
0147     /*
0148      * These fields are contiguous in both the source and destination:
0149      * Address Alignment
0150      * Length
0151      * Minimum Base Address
0152      * Maximum Base Address
0153      */
0154     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Io.Alignment),
0155                         AML_OFFSET (Io.Alignment),
0156                         2},
0157
0158     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.Io.Minimum),
0159                         AML_OFFSET (Io.Minimum),
0160                         2}
0161 };
0162
0163
0164 /*******************************************************************************
0165  *
0166  * AcpiRsConvertFixedIo
0167  *
0168  ******************************************************************************/
0169
0170 ACPI_RSCONVERT_INFO     AcpiRsConvertFixedIo[4] =
0171 {
0172     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_FIXED_IO,
0173                         ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_IO),
0174                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertFixedIo)},
0175
0176     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_FIXED_IO,
0177                         sizeof (AML_RESOURCE_FIXED_IO),
0178                         0},
0179     /*
0180      * These fields are contiguous in both the source and destination:
0181      * Base Address
0182      * Length
0183      */
0184     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.FixedIo.AddressLength),
0185                         AML_OFFSET (FixedIo.AddressLength),
0186                         1},
0187
0188     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.FixedIo.Address),
0189                         AML_OFFSET (FixedIo.Address),
0190                         1}
0191 };
0192
0193
0194 /*******************************************************************************
0195  *
0196  * AcpiRsConvertGenericReg
0197  *
0198  ******************************************************************************/
0199
0200 ACPI_RSCONVERT_INFO     AcpiRsConvertGenericReg[4] =
0201 {
0202     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_GENERIC_REGISTER,
0203                         ACPI_RS_SIZE (ACPI_RESOURCE_GENERIC_REGISTER),
0204                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertGenericReg)},
0205
0206     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_GENERIC_REGISTER,
0207                         sizeof (AML_RESOURCE_GENERIC_REGISTER),
0208                         0},
0209     /*
0210      * These fields are contiguous in both the source and destination:
0211      * Address Space ID
0212      * Register Bit Width
0213      * Register Bit Offset
0214      * Access Size
0215      */
0216     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.GenericReg.SpaceId),
0217                         AML_OFFSET (GenericReg.AddressSpaceId),
0218                         4},
0219
0220     /* Get the Register Address */
0221
0222     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.GenericReg.Address),
0223                         AML_OFFSET (GenericReg.Address),
0224                         1}
0225 };
0226
0227
0228 /*******************************************************************************
0229  *
0230  * AcpiRsConvertEndDpf
0231  *
0232  ******************************************************************************/
0233
0234 ACPI_RSCONVERT_INFO   AcpiRsConvertEndDpf[2] =
0235 {
0236     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_END_DEPENDENT,
0237                         ACPI_RS_SIZE_MIN,
0238                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertEndDpf)},
0239
0240     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_END_DEPENDENT,
0241                         sizeof (AML_RESOURCE_END_DEPENDENT),
0242                         0}
0243 };
0244
0245
0246 /*******************************************************************************
0247  *
0248  * AcpiRsConvertEndTag
0249  *
0250  ******************************************************************************/
0251
0252 ACPI_RSCONVERT_INFO   AcpiRsConvertEndTag[2] =
0253 {
0254     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_END_TAG,
0255                         ACPI_RS_SIZE_MIN,
0256                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertEndTag)},
0257
0258     /*
0259      * Note: The checksum field is set to zero, meaning that the resource
0260      * data is treated as if the checksum operation succeeded.
0261      * (ACPI Spec 1.0b Section 6.4.2.8)
0262      */
0263     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_END_TAG,
0264                         sizeof (AML_RESOURCE_END_TAG),
0265                         0}
0266 };
0267
0268
0269 /*******************************************************************************
0270  *
0271  * AcpiRsGetStartDpf
0272  *
0273  ******************************************************************************/
0274
0275 ACPI_RSCONVERT_INFO   AcpiRsGetStartDpf[6] =
0276 {
0277     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_START_DEPENDENT,
0278                         ACPI_RS_SIZE (ACPI_RESOURCE_START_DEPENDENT),
0279                         ACPI_RSC_TABLE_SIZE (AcpiRsGetStartDpf)},
0280
0281     /* Defaults for Compatibility and Performance priorities */
0282
0283     {ACPI_RSC_SET8,     ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
0284                         ACPI_ACCEPTABLE_CONFIGURATION,
0285                         2},
0286
0287     /* Get the descriptor length (0 or 1 for Start Dpf descriptor) */
0288
0289     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.DescriptorLength),
0290                         AML_OFFSET (StartDpf.DescriptorType),
0291                         0},
0292
0293     /* All done if there is no flag byte present in the descriptor */
0294
0295     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_AML_LENGTH, 0, 1},
0296
0297     /* Flag byte is present, get the flags */
0298
0299     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
0300                         AML_OFFSET (StartDpf.Flags),
0301                         0},
0302
0303     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
0304                         AML_OFFSET (StartDpf.Flags),
0305                         2}
0306 };
0307
0308
0309 /*******************************************************************************
0310  *
0311  * AcpiRsSetStartDpf
0312  *
0313  ******************************************************************************/
0314
0315 ACPI_RSCONVERT_INFO   AcpiRsSetStartDpf[10] =
0316 {
0317     /* Start with a default descriptor of length 1 */
0318
0319     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_START_DEPENDENT,
0320                         sizeof (AML_RESOURCE_START_DEPENDENT),
0321                         ACPI_RSC_TABLE_SIZE (AcpiRsSetStartDpf)},
0322
0323     /* Set the default flag values */
0324
0325     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
0326                         AML_OFFSET (StartDpf.Flags),
0327                         0},
0328
0329     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
0330                         AML_OFFSET (StartDpf.Flags),
0331                         2},
0332     /*
0333      * All done if the output descriptor length is required to be 1
0334      * (i.e., optimization to 0 bytes cannot be attempted)
0335      */
0336     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
0337                         ACPI_RS_OFFSET(Data.StartDpf.DescriptorLength),
0338                         1},
0339
0340     /* Set length to 0 bytes (no flags byte) */
0341
0342     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT_NOPRIO)},
0343
0344     /*
0345      * All done if the output descriptor length is required to be 0.
0346      *
0347      * TBD: Perhaps we should check for error if input flags are not
0348      * compatible with a 0-byte descriptor.
0349      */
0350     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
0351                         ACPI_RS_OFFSET(Data.StartDpf.DescriptorLength),
0352                         0},
0353
0354     /* Reset length to 1 byte (descriptor with flags byte) */
0355
0356     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT)},
0357
0358
0359     /*
0360      * All done if flags byte is necessary -- if either priority value
0361      * is not ACPI_ACCEPTABLE_CONFIGURATION
0362      */
0363     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
0364                         ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
0365                         ACPI_ACCEPTABLE_CONFIGURATION},
0366
0367     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
0368                         ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
0369                         ACPI_ACCEPTABLE_CONFIGURATION},
0370
0371     /* Flag byte is not necessary */
0372
0373     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT_NOPRIO)}
0374 };
0375
0376