1 /****************************************************************************** 2 * 3 * Name: acresrc.h - Resource Manager function prototypes 4 * $Revision: 1.56 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118 #ifndef __ACRESRC_H__ 119 #define __ACRESRC_H__ 120 121 /* Need the AML resource descriptor structs */ 122 123 #include "amlresrc.h" 124 125 126 /* 127 * If possible, pack the following structures to byte alignment, since we 128 * don't care about performance for debug output 129 */ 130 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED 131 #pragma pack(1) 132 #endif 133 134 /* 135 * Individual entry for the resource conversion tables 136 */ 137 typedef const struct acpi_rsconvert_info 138 { 139 UINT8 Opcode; 140 UINT8 ResourceOffset; 141 UINT8 AmlOffset; 142 UINT8 Value; 143 144 } ACPI_RSCONVERT_INFO; 145 146 /* Resource conversion opcodes */ 147 148 #define ACPI_RSC_INITGET 0 149 #define ACPI_RSC_INITSET 1 150 #define ACPI_RSC_FLAGINIT 2 151 #define ACPI_RSC_1BITFLAG 3 152 #define ACPI_RSC_2BITFLAG 4 153 #define ACPI_RSC_COUNT 5 154 #define ACPI_RSC_COUNT16 6 155 #define ACPI_RSC_LENGTH 7 156 #define ACPI_RSC_MOVE8 8 157 #define ACPI_RSC_MOVE16 9 158 #define ACPI_RSC_MOVE32 10 159 #define ACPI_RSC_MOVE64 11 160 #define ACPI_RSC_SET8 12 161 #define ACPI_RSC_DATA8 13 162 #define ACPI_RSC_ADDRESS 14 163 #define ACPI_RSC_SOURCE 15 164 #define ACPI_RSC_SOURCEX 16 165 #define ACPI_RSC_BITMASK 17 166 #define ACPI_RSC_BITMASK16 18 167 #define ACPI_RSC_EXIT_NE 19 168 #define ACPI_RSC_EXIT_LE 20 169 170 /* Resource Conversion sub-opcodes */ 171 172 #define ACPI_RSC_COMPARE_AML_LENGTH 0 173 #define ACPI_RSC_COMPARE_VALUE 1 174 175 #define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (ACPI_RSCONVERT_INFO)) 176 177 #define ACPI_RS_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_RESOURCE,f) 178 #define AML_OFFSET(f) (UINT8) ACPI_OFFSET (AML_RESOURCE,f) 179 180 181 typedef const struct acpi_rsdump_info 182 { 183 UINT8 Opcode; 184 UINT8 Offset; 185 char *Name; 186 const char **Pointer; 187 188 } ACPI_RSDUMP_INFO; 189 190 /* Values for the Opcode field above */ 191 192 #define ACPI_RSD_TITLE 0 193 #define ACPI_RSD_LITERAL 1 194 #define ACPI_RSD_STRING 2 195 #define ACPI_RSD_UINT8 3 196 #define ACPI_RSD_UINT16 4 197 #define ACPI_RSD_UINT32 5 198 #define ACPI_RSD_UINT64 6 199 #define ACPI_RSD_1BITFLAG 7 200 #define ACPI_RSD_2BITFLAG 8 201 #define ACPI_RSD_SHORTLIST 9 202 #define ACPI_RSD_LONGLIST 10 203 #define ACPI_RSD_DWORDLIST 11 204 #define ACPI_RSD_ADDRESS 12 205 #define ACPI_RSD_SOURCE 13 206 207 /* restore default alignment */ 208 209 #pragma pack() 210 211 212 /* Resource tables indexed by internal resource type */ 213 214 extern const UINT8 AcpiGbl_AmlResourceSizes[]; 215 extern ACPI_RSCONVERT_INFO *AcpiGbl_SetResourceDispatch[]; 216 217 /* Resource tables indexed by raw AML resource descriptor type */ 218 219 extern const UINT8 AcpiGbl_ResourceStructSizes[]; 220 extern ACPI_RSCONVERT_INFO *AcpiGbl_GetResourceDispatch[]; 221 222 223 typedef struct acpi_vendor_walk_info 224 { 225 ACPI_VENDOR_UUID *Uuid; 226 ACPI_BUFFER *Buffer; 227 ACPI_STATUS Status; 228 229 } ACPI_VENDOR_WALK_INFO; 230 231 232 /* 233 * rscreate 234 */ 235 ACPI_STATUS 236 AcpiRsCreateResourceList ( 237 ACPI_OPERAND_OBJECT *AmlBuffer, 238 ACPI_BUFFER *OutputBuffer); 239 240 ACPI_STATUS 241 AcpiRsCreateAmlResources ( 242 ACPI_RESOURCE *LinkedListBuffer, 243 ACPI_BUFFER *OutputBuffer); 244 245 ACPI_STATUS 246 AcpiRsCreatePciRoutingTable ( 247 ACPI_OPERAND_OBJECT *PackageObject, 248 ACPI_BUFFER *OutputBuffer); 249 250 251 /* 252 * rsutils 253 */ 254 ACPI_STATUS 255 AcpiRsGetPrtMethodData ( 256 ACPI_HANDLE Handle, 257 ACPI_BUFFER *RetBuffer); 258 259 ACPI_STATUS 260 AcpiRsGetCrsMethodData ( 261 ACPI_HANDLE Handle, 262 ACPI_BUFFER *RetBuffer); 263 264 ACPI_STATUS 265 AcpiRsGetPrsMethodData ( 266 ACPI_HANDLE Handle, 267 ACPI_BUFFER *RetBuffer); 268 269 ACPI_STATUS 270 AcpiRsGetMethodData ( 271 ACPI_HANDLE Handle, 272 char *Path, 273 ACPI_BUFFER *RetBuffer); 274 275 ACPI_STATUS 276 AcpiRsSetSrsMethodData ( 277 ACPI_HANDLE Handle, 278 ACPI_BUFFER *RetBuffer); 279 280 281 /* 282 * rscalc 283 */ 284 ACPI_STATUS 285 AcpiRsGetListLength ( 286 UINT8 *AmlBuffer, 287 UINT32 AmlBufferLength, 288 ACPI_SIZE *SizeNeeded); 289 290 ACPI_STATUS 291 AcpiRsGetAmlLength ( 292 ACPI_RESOURCE *LinkedListBuffer, 293 ACPI_SIZE *SizeNeeded); 294 295 ACPI_STATUS 296 AcpiRsGetPciRoutingTableLength ( 297 ACPI_OPERAND_OBJECT *PackageObject, 298 ACPI_SIZE *BufferSizeNeeded); 299 300 ACPI_STATUS 301 AcpiRsConvertAmlToResources ( 302 UINT8 *AmlBuffer, 303 UINT32 AmlBufferLength, 304 UINT8 *OutputBuffer); 305 306 ACPI_STATUS 307 AcpiRsConvertResourcesToAml ( 308 ACPI_RESOURCE *Resource, 309 ACPI_SIZE AmlSizeNeeded, 310 UINT8 *OutputBuffer); 311 312 313 /* 314 * rsaddr 315 */ 316 void 317 AcpiRsSetAddressCommon ( 318 AML_RESOURCE *Aml, 319 ACPI_RESOURCE *Resource); 320 321 BOOLEAN 322 AcpiRsGetAddressCommon ( 323 ACPI_RESOURCE *Resource, 324 AML_RESOURCE *Aml); 325 326 327 /* 328 * rsmisc 329 */ 330 ACPI_STATUS 331 AcpiRsConvertAmlToResource ( 332 ACPI_RESOURCE *Resource, 333 AML_RESOURCE *Aml, 334 ACPI_RSCONVERT_INFO *Info); 335 336 ACPI_STATUS 337 AcpiRsConvertResourceToAml ( 338 ACPI_RESOURCE *Resource, 339 AML_RESOURCE *Aml, 340 ACPI_RSCONVERT_INFO *Info); 341 342 343 /* 344 * rsutils 345 */ 346 void 347 AcpiRsMoveData ( 348 void *Destination, 349 void *Source, 350 UINT16 ItemCount, 351 UINT8 MoveType); 352 353 UINT8 354 AcpiRsDecodeBitmask ( 355 UINT16 Mask, 356 UINT8 *List); 357 358 UINT16 359 AcpiRsEncodeBitmask ( 360 UINT8 *List, 361 UINT8 Count); 362 363 ACPI_RS_LENGTH 364 AcpiRsGetResourceSource ( 365 ACPI_RS_LENGTH ResourceLength, 366 ACPI_RS_LENGTH MinimumLength, 367 ACPI_RESOURCE_SOURCE *ResourceSource, 368 AML_RESOURCE *Aml, 369 char *StringPtr); 370 371 ACPI_RSDESC_SIZE 372 AcpiRsSetResourceSource ( 373 AML_RESOURCE *Aml, 374 ACPI_RS_LENGTH MinimumLength, 375 ACPI_RESOURCE_SOURCE *ResourceSource); 376 377 void 378 AcpiRsSetResourceHeader ( 379 UINT8 DescriptorType, 380 ACPI_RSDESC_SIZE TotalLength, 381 AML_RESOURCE *Aml); 382 383 void 384 AcpiRsSetResourceLength ( 385 ACPI_RSDESC_SIZE TotalLength, 386 AML_RESOURCE *Aml); 387 388 389 /* 390 * rsdump 391 */ 392 void 393 AcpiRsDumpResourceList ( 394 ACPI_RESOURCE *Resource); 395 396 void 397 AcpiRsDumpIrqList ( 398 UINT8 *RouteTable); 399 400 401 /* 402 * Resource conversion tables 403 */ 404 extern ACPI_RSCONVERT_INFO AcpiRsConvertDma[]; 405 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndDpf[]; 406 extern ACPI_RSCONVERT_INFO AcpiRsConvertIo[]; 407 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedIo[]; 408 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndTag[]; 409 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory24[]; 410 extern ACPI_RSCONVERT_INFO AcpiRsConvertGenericReg[]; 411 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory32[]; 412 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedMemory32[]; 413 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress32[]; 414 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress16[]; 415 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtIrq[]; 416 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress64[]; 417 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtAddress64[]; 418 419 /* These resources require separate get/set tables */ 420 421 extern ACPI_RSCONVERT_INFO AcpiRsGetIrq[]; 422 extern ACPI_RSCONVERT_INFO AcpiRsGetStartDpf[]; 423 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorSmall[]; 424 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorLarge[]; 425 426 extern ACPI_RSCONVERT_INFO AcpiRsSetIrq[]; 427 extern ACPI_RSCONVERT_INFO AcpiRsSetStartDpf[]; 428 extern ACPI_RSCONVERT_INFO AcpiRsSetVendor[]; 429 430 431 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) 432 /* 433 * rsinfo 434 */ 435 extern ACPI_RSDUMP_INFO *AcpiGbl_DumpResourceDispatch[]; 436 437 /* 438 * rsdump 439 */ 440 extern ACPI_RSDUMP_INFO AcpiRsDumpIrq[]; 441 extern ACPI_RSDUMP_INFO AcpiRsDumpDma[]; 442 extern ACPI_RSDUMP_INFO AcpiRsDumpStartDpf[]; 443 extern ACPI_RSDUMP_INFO AcpiRsDumpEndDpf[]; 444 extern ACPI_RSDUMP_INFO AcpiRsDumpIo[]; 445 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedIo[]; 446 extern ACPI_RSDUMP_INFO AcpiRsDumpVendor[]; 447 extern ACPI_RSDUMP_INFO AcpiRsDumpEndTag[]; 448 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory24[]; 449 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory32[]; 450 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedMemory32[]; 451 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress16[]; 452 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress32[]; 453 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress64[]; 454 extern ACPI_RSDUMP_INFO AcpiRsDumpExtAddress64[]; 455 extern ACPI_RSDUMP_INFO AcpiRsDumpExtIrq[]; 456 extern ACPI_RSDUMP_INFO AcpiRsDumpGenericReg[]; 457 #endif 458 459 #endif /* __ACRESRC_H__ */ 460