drivers/acpi/components/resources/rsio.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rsio - IO and DMA resource descriptors
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  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
  19  * property rights.
  20  *
  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
  27  *
  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;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  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.
  53  *
  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
  64  * make.
  65  *
  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
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  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.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  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
  88  * PARTICULAR PURPOSE.
  89  *
  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
  97  * LIMITED REMEDY.
  98  *
  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.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acresrc.h"
 119
 120 #define _COMPONENT          ACPI_RESOURCES
 121         ACPI_MODULE_NAME    ("rsio")
 122
 123
 124 /*******************************************************************************
 125  *
 126  * AcpiRsConvertIo
 127  *
 128  ******************************************************************************/
 129
 130 ACPI_RSCONVERT_INFO     AcpiRsConvertIo[5] =
 131 {
 132     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_IO,
 133                         ACPI_RS_SIZE (ACPI_RESOURCE_IO),
 134                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertIo)},
 135
 136     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_IO,
 137                         sizeof (AML_RESOURCE_IO),
 138                         0},
 139
 140     /* Decode flag */
 141
 142     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Io.IoDecode),
 143                         AML_OFFSET (Io.Flags),
 144                         0},
 145     /*
 146      * These fields are contiguous in both the source and destination:
 147      * Address Alignment
 148      * Length
 149      * Minimum Base Address
 150      * Maximum Base Address
 151      */
 152     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Io.Alignment),
 153                         AML_OFFSET (Io.Alignment),
 154                         2},
 155
 156     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.Io.Minimum),
 157                         AML_OFFSET (Io.Minimum),
 158                         2}
 159 };
 160
 161
 162 /*******************************************************************************
 163  *
 164  * AcpiRsConvertFixedIo
 165  *
 166  ******************************************************************************/
 167
 168 ACPI_RSCONVERT_INFO     AcpiRsConvertFixedIo[4] =
 169 {
 170     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_FIXED_IO,
 171                         ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_IO),
 172                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertFixedIo)},
 173
 174     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_FIXED_IO,
 175                         sizeof (AML_RESOURCE_FIXED_IO),
 176                         0},
 177     /*
 178      * These fields are contiguous in both the source and destination:
 179      * Base Address
 180      * Length
 181      */
 182     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.FixedIo.AddressLength),
 183                         AML_OFFSET (FixedIo.AddressLength),
 184                         1},
 185
 186     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.FixedIo.Address),
 187                         AML_OFFSET (FixedIo.Address),
 188                         1}
 189 };
 190
 191
 192 /*******************************************************************************
 193  *
 194  * AcpiRsConvertGenericReg
 195  *
 196  ******************************************************************************/
 197
 198 ACPI_RSCONVERT_INFO     AcpiRsConvertGenericReg[4] =
 199 {
 200     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_GENERIC_REGISTER,
 201                         ACPI_RS_SIZE (ACPI_RESOURCE_GENERIC_REGISTER),
 202                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertGenericReg)},
 203
 204     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_GENERIC_REGISTER,
 205                         sizeof (AML_RESOURCE_GENERIC_REGISTER),
 206                         0},
 207     /*
 208      * These fields are contiguous in both the source and destination:
 209      * Address Space ID
 210      * Register Bit Width
 211      * Register Bit Offset
 212      * Access Size
 213      */
 214     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.GenericReg.SpaceId),
 215                         AML_OFFSET (GenericReg.AddressSpaceId),
 216                         4},
 217
 218     /* Get the Register Address */
 219
 220     {ACPI_RSC_MOVE64,   ACPI_RS_OFFSET (Data.GenericReg.Address),
 221                         AML_OFFSET (GenericReg.Address),
 222                         1}
 223 };
 224
 225
 226 /*******************************************************************************
 227  *
 228  * AcpiRsConvertEndDpf
 229  *
 230  ******************************************************************************/
 231
 232 ACPI_RSCONVERT_INFO   AcpiRsConvertEndDpf[2] =
 233 {
 234     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_END_DEPENDENT,
 235                         ACPI_RS_SIZE_MIN,
 236                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertEndDpf)},
 237
 238     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_END_DEPENDENT,
 239                         sizeof (AML_RESOURCE_END_DEPENDENT),
 240                         0}
 241 };
 242
 243
 244 /*******************************************************************************
 245  *
 246  * AcpiRsConvertEndTag
 247  *
 248  ******************************************************************************/
 249
 250 ACPI_RSCONVERT_INFO   AcpiRsConvertEndTag[2] =
 251 {
 252     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_END_TAG,
 253                         ACPI_RS_SIZE_MIN,
 254                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertEndTag)},
 255
 256     /*
 257      * Note: The checksum field is set to zero, meaning that the resource
 258      * data is treated as if the checksum operation succeeded.
 259      * (ACPI Spec 1.0b Section 6.4.2.8)
 260      */
 261     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_END_TAG,
 262                         sizeof (AML_RESOURCE_END_TAG),
 263                         0}
 264 };
 265
 266
 267 /*******************************************************************************
 268  *
 269  * AcpiRsGetStartDpf
 270  *
 271  ******************************************************************************/
 272
 273 ACPI_RSCONVERT_INFO   AcpiRsGetStartDpf[6] =
 274 {
 275     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_START_DEPENDENT,
 276                         ACPI_RS_SIZE (ACPI_RESOURCE_START_DEPENDENT),
 277                         ACPI_RSC_TABLE_SIZE (AcpiRsGetStartDpf)},
 278
 279     /* Defaults for Compatibility and Performance priorities */
 280
 281     {ACPI_RSC_SET8,     ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
 282                         ACPI_ACCEPTABLE_CONFIGURATION,
 283                         2},
 284
 285     /* Get the descriptor length (0 or 1 for Start Dpf descriptor) */
 286
 287     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.DescriptorLength),
 288                         AML_OFFSET (StartDpf.DescriptorType),
 289                         0},
 290
 291     /* All done if there is no flag byte present in the descriptor */
 292
 293     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_AML_LENGTH, 0, 1},
 294
 295     /* Flag byte is present, get the flags */
 296
 297     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
 298                         AML_OFFSET (StartDpf.Flags),
 299                         0},
 300
 301     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
 302                         AML_OFFSET (StartDpf.Flags),
 303                         2}
 304 };
 305
 306
 307 /*******************************************************************************
 308  *
 309  * AcpiRsSetStartDpf
 310  *
 311  ******************************************************************************/
 312
 313 ACPI_RSCONVERT_INFO   AcpiRsSetStartDpf[10] =
 314 {
 315     /* Start with a default descriptor of length 1 */
 316
 317     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_START_DEPENDENT,
 318                         sizeof (AML_RESOURCE_START_DEPENDENT),
 319                         ACPI_RSC_TABLE_SIZE (AcpiRsSetStartDpf)},
 320
 321     /* Set the default flag values */
 322
 323     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
 324                         AML_OFFSET (StartDpf.Flags),
 325                         0},
 326
 327     {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
 328                         AML_OFFSET (StartDpf.Flags),
 329                         2},
 330     /*
 331      * All done if the output descriptor length is required to be 1
 332      * (i.e., optimization to 0 bytes cannot be attempted)
 333      */
 334     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
 335                         ACPI_RS_OFFSET(Data.StartDpf.DescriptorLength),
 336                         1},
 337
 338     /* Set length to 0 bytes (no flags byte) */
 339
 340     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT_NOPRIO)},
 341
 342     /*
 343      * All done if the output descriptor length is required to be 0.
 344      *
 345      * TBD: Perhaps we should check for error if input flags are not
 346      * compatible with a 0-byte descriptor.
 347      */
 348     {ACPI_RSC_EXIT_EQ,  ACPI_RSC_COMPARE_VALUE,
 349                         ACPI_RS_OFFSET(Data.StartDpf.DescriptorLength),
 350                         0},
 351
 352     /* Reset length to 1 byte (descriptor with flags byte) */
 353
 354     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT)},
 355
 356
 357     /*
 358      * All done if flags byte is necessary -- if either priority value
 359      * is not ACPI_ACCEPTABLE_CONFIGURATION
 360      */
 361     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
 362                         ACPI_RS_OFFSET (Data.StartDpf.CompatibilityPriority),
 363                         ACPI_ACCEPTABLE_CONFIGURATION},
 364
 365     {ACPI_RSC_EXIT_NE,  ACPI_RSC_COMPARE_VALUE,
 366                         ACPI_RS_OFFSET (Data.StartDpf.PerformanceRobustness),
 367                         ACPI_ACCEPTABLE_CONFIGURATION},
 368
 369     /* Flag byte is not necessary */
 370
 371     {ACPI_RSC_LENGTH,   0, 0, sizeof (AML_RESOURCE_START_DEPENDENT_NOPRIO)}
 372 };