1 /******************************************************************************* 2 * 3 * Module Name: rsaddr - Address resource descriptors (16/32/64) 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 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. 133 * 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. 145 * 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. 149 * 150 *****************************************************************************/ 151 152 #include <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/acresrc.h> 155 156 #define _COMPONENT ACPI_RESOURCES 157 ACPI_MODULE_NAME ("rsaddr") 158 159 160 /******************************************************************************* 161 * 162 * AcpiRsConvertAddress16 - All WORD (16-bit) address resources 163 * 164 ******************************************************************************/ 165 166 ACPI_RSCONVERT_INFO AcpiRsConvertAddress16[5] = 167 { 168 {ACPI_RSC_INITGET, ACPI_RESOURCE_TYPE_ADDRESS16, 169 ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS16), 170 ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress16)}, 171 172 {ACPI_RSC_INITSET, ACPI_RESOURCE_NAME_ADDRESS16, 173 sizeof (AML_RESOURCE_ADDRESS16), 174 0}, 175 176 /* Resource Type, General Flags, and Type-Specific Flags */ 177 178 {ACPI_RSC_ADDRESS, 0, 0, 0}, 179 180 /* 181 * These fields are contiguous in both the source and destination: 182 * Address Granularity 183 * Address Range Minimum 184 * Address Range Maximum 185 * Address Translation Offset 186 * Address Length 187 */ 188 {ACPI_RSC_MOVE16, ACPI_RS_OFFSET (Data.Address16.Address.Granularity), 189 AML_OFFSET (Address16.Granularity), 190 5}, 191 192 /* Optional ResourceSource (Index and String) */ 193 194 {ACPI_RSC_SOURCE, ACPI_RS_OFFSET (Data.Address16.ResourceSource), 195 0, 196 sizeof (AML_RESOURCE_ADDRESS16)} 197 }; 198 199 200 /******************************************************************************* 201 * 202 * AcpiRsConvertAddress32 - All DWORD (32-bit) address resources 203 * 204 ******************************************************************************/ 205 206 ACPI_RSCONVERT_INFO AcpiRsConvertAddress32[5] = 207 { 208 {ACPI_RSC_INITGET, ACPI_RESOURCE_TYPE_ADDRESS32, 209 ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS32), 210 ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress32)}, 211 212 {ACPI_RSC_INITSET, ACPI_RESOURCE_NAME_ADDRESS32, 213 sizeof (AML_RESOURCE_ADDRESS32), 214 0}, 215 216 /* Resource Type, General Flags, and Type-Specific Flags */ 217 218 {ACPI_RSC_ADDRESS, 0, 0, 0}, 219 220 /* 221 * These fields are contiguous in both the source and destination: 222 * Address Granularity 223 * Address Range Minimum 224 * Address Range Maximum 225 * Address Translation Offset 226 * Address Length 227 */ 228 {ACPI_RSC_MOVE32, ACPI_RS_OFFSET (Data.Address32.Address.Granularity), 229 AML_OFFSET (Address32.Granularity), 230 5}, 231 232 /* Optional ResourceSource (Index and String) */ 233 234 {ACPI_RSC_SOURCE, ACPI_RS_OFFSET (Data.Address32.ResourceSource), 235 0, 236 sizeof (AML_RESOURCE_ADDRESS32)} 237 }; 238 239 240 /******************************************************************************* 241 * 242 * AcpiRsConvertAddress64 - All QWORD (64-bit) address resources 243 * 244 ******************************************************************************/ 245 246 ACPI_RSCONVERT_INFO AcpiRsConvertAddress64[5] = 247 { 248 {ACPI_RSC_INITGET, ACPI_RESOURCE_TYPE_ADDRESS64, 249 ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS64), 250 ACPI_RSC_TABLE_SIZE (AcpiRsConvertAddress64)}, 251 252 {ACPI_RSC_INITSET, ACPI_RESOURCE_NAME_ADDRESS64, 253 sizeof (AML_RESOURCE_ADDRESS64), 254 0}, 255 256 /* Resource Type, General Flags, and Type-Specific Flags */ 257 258 {ACPI_RSC_ADDRESS, 0, 0, 0}, 259 260 /* 261 * These fields are contiguous in both the source and destination: 262 * Address Granularity 263 * Address Range Minimum 264 * Address Range Maximum 265 * Address Translation Offset 266 * Address Length 267 */ 268 {ACPI_RSC_MOVE64, ACPI_RS_OFFSET (Data.Address64.Address.Granularity), 269 AML_OFFSET (Address64.Granularity), 270 5}, 271 272 /* Optional ResourceSource (Index and String) */ 273 274 {ACPI_RSC_SOURCE, ACPI_RS_OFFSET (Data.Address64.ResourceSource), 275 0, 276 sizeof (AML_RESOURCE_ADDRESS64)} 277 }; 278 279 280 /******************************************************************************* 281 * 282 * AcpiRsConvertExtAddress64 - All Extended (64-bit) address resources 283 * 284 ******************************************************************************/ 285 286 ACPI_RSCONVERT_INFO AcpiRsConvertExtAddress64[5] = 287 { 288 {ACPI_RSC_INITGET, ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64, 289 ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_ADDRESS64), 290 ACPI_RSC_TABLE_SIZE (AcpiRsConvertExtAddress64)}, 291 292 {ACPI_RSC_INITSET, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64, 293 sizeof (AML_RESOURCE_EXTENDED_ADDRESS64), 294 0}, 295 296 /* Resource Type, General Flags, and Type-Specific Flags */ 297 298 {ACPI_RSC_ADDRESS, 0, 0, 0}, 299 300 /* Revision ID */ 301 302 {ACPI_RSC_MOVE8, ACPI_RS_OFFSET (Data.ExtAddress64.RevisionID), 303 AML_OFFSET (ExtAddress64.RevisionID), 304 1}, 305 /* 306 * These fields are contiguous in both the source and destination: 307 * Address Granularity 308 * Address Range Minimum 309 * Address Range Maximum 310 * Address Translation Offset 311 * Address Length 312 * Type-Specific Attribute 313 */ 314 {ACPI_RSC_MOVE64, ACPI_RS_OFFSET (Data.ExtAddress64.Address.Granularity), 315 AML_OFFSET (ExtAddress64.Granularity), 316 6} 317 }; 318 319 320 /******************************************************************************* 321 * 322 * AcpiRsConvertGeneralFlags - Flags common to all address descriptors 323 * 324 ******************************************************************************/ 325 326 static ACPI_RSCONVERT_INFO AcpiRsConvertGeneralFlags[6] = 327 { 328 {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.Flags), 329 ACPI_RSC_TABLE_SIZE (AcpiRsConvertGeneralFlags)}, 330 331 /* Resource Type (Memory, Io, BusNumber, etc.) */ 332 333 {ACPI_RSC_MOVE8, ACPI_RS_OFFSET (Data.Address.ResourceType), 334 AML_OFFSET (Address.ResourceType), 335 1}, 336 337 /* General Flags - Consume, Decode, MinFixed, MaxFixed */ 338 339 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.ProducerConsumer), 340 AML_OFFSET (Address.Flags), 341 0}, 342 343 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Decode), 344 AML_OFFSET (Address.Flags), 345 1}, 346 347 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MinAddressFixed), 348 AML_OFFSET (Address.Flags), 349 2}, 350 351 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.MaxAddressFixed), 352 AML_OFFSET (Address.Flags), 353 3} 354 }; 355 356 357 /******************************************************************************* 358 * 359 * AcpiRsConvertMemFlags - Flags common to Memory address descriptors 360 * 361 ******************************************************************************/ 362 363 static ACPI_RSCONVERT_INFO AcpiRsConvertMemFlags[5] = 364 { 365 {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags), 366 ACPI_RSC_TABLE_SIZE (AcpiRsConvertMemFlags)}, 367 368 /* Memory-specific flags */ 369 370 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.WriteProtect), 371 AML_OFFSET (Address.SpecificFlags), 372 0}, 373 374 {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Caching), 375 AML_OFFSET (Address.SpecificFlags), 376 1}, 377 378 {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.RangeType), 379 AML_OFFSET (Address.SpecificFlags), 380 3}, 381 382 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Mem.Translation), 383 AML_OFFSET (Address.SpecificFlags), 384 5} 385 }; 386 387 388 /******************************************************************************* 389 * 390 * AcpiRsConvertIoFlags - Flags common to I/O address descriptors 391 * 392 ******************************************************************************/ 393 394 static ACPI_RSCONVERT_INFO AcpiRsConvertIoFlags[4] = 395 { 396 {ACPI_RSC_FLAGINIT, 0, AML_OFFSET (Address.SpecificFlags), 397 ACPI_RSC_TABLE_SIZE (AcpiRsConvertIoFlags)}, 398 399 /* I/O-specific flags */ 400 401 {ACPI_RSC_2BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.RangeType), 402 AML_OFFSET (Address.SpecificFlags), 403 0}, 404 405 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.Translation), 406 AML_OFFSET (Address.SpecificFlags), 407 4}, 408 409 {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Address.Info.Io.TranslationType), 410 AML_OFFSET (Address.SpecificFlags), 411 5} 412 }; 413 414 415 /******************************************************************************* 416 * 417 * FUNCTION: AcpiRsGetAddressCommon 418 * 419 * PARAMETERS: Resource - Pointer to the internal resource struct 420 * Aml - Pointer to the AML resource descriptor 421 * 422 * RETURN: TRUE if the ResourceType field is OK, FALSE otherwise 423 * 424 * DESCRIPTION: Convert common flag fields from a raw AML resource descriptor 425 * to an internal resource descriptor 426 * 427 ******************************************************************************/ 428 429 BOOLEAN 430 AcpiRsGetAddressCommon ( 431 ACPI_RESOURCE *Resource, 432 AML_RESOURCE *Aml) 433 { 434 ACPI_FUNCTION_ENTRY (); 435 436 437 /* Validate the Resource Type */ 438 439 if ((Aml->Address.ResourceType > 2) && 440 (Aml->Address.ResourceType < 0xC0)) 441 { 442 return (FALSE); 443 } 444 445 /* Get the Resource Type and General Flags */ 446 447 (void) AcpiRsConvertAmlToResource ( 448 Resource, Aml, AcpiRsConvertGeneralFlags); 449 450 /* Get the Type-Specific Flags (Memory and I/O descriptors only) */ 451 452 if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE) 453 { 454 (void) AcpiRsConvertAmlToResource ( 455 Resource, Aml, AcpiRsConvertMemFlags); 456 } 457 else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE) 458 { 459 (void) AcpiRsConvertAmlToResource ( 460 Resource, Aml, AcpiRsConvertIoFlags); 461 } 462 else 463 { 464 /* Generic resource type, just grab the TypeSpecific byte */ 465 466 Resource->Data.Address.Info.TypeSpecific = 467 Aml->Address.SpecificFlags; 468 } 469 470 return (TRUE); 471 } 472 473 474 /******************************************************************************* 475 * 476 * FUNCTION: AcpiRsSetAddressCommon 477 * 478 * PARAMETERS: Aml - Pointer to the AML resource descriptor 479 * Resource - Pointer to the internal resource struct 480 * 481 * RETURN: None 482 * 483 * DESCRIPTION: Convert common flag fields from a resource descriptor to an 484 * AML descriptor 485 * 486 ******************************************************************************/ 487 488 void 489 AcpiRsSetAddressCommon ( 490 AML_RESOURCE *Aml, 491 ACPI_RESOURCE *Resource) 492 { 493 ACPI_FUNCTION_ENTRY (); 494 495 496 /* Set the Resource Type and General Flags */ 497 498 (void) AcpiRsConvertResourceToAml ( 499 Resource, Aml, AcpiRsConvertGeneralFlags); 500 501 /* Set the Type-Specific Flags (Memory and I/O descriptors only) */ 502 503 if (Resource->Data.Address.ResourceType == ACPI_MEMORY_RANGE) 504 { 505 (void) AcpiRsConvertResourceToAml ( 506 Resource, Aml, AcpiRsConvertMemFlags); 507 } 508 else if (Resource->Data.Address.ResourceType == ACPI_IO_RANGE) 509 { 510 (void) AcpiRsConvertResourceToAml ( 511 Resource, Aml, AcpiRsConvertIoFlags); 512 } 513 else 514 { 515 /* Generic resource type, just copy the TypeSpecific byte */ 516 517 Aml->Address.SpecificFlags = 518 Resource->Data.Address.Info.TypeSpecific; 519 } 520 } 521