1 /****************************************************************************** 2 * 3 * Module Name: aslmapenter - Build resource descriptor/device maps 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2023, 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/acapps.h> 155 #include <contrib/dev/acpica/compiler/aslcompiler.h> 156 157 /* This module used for application-level code only */ 158 159 #define _COMPONENT ACPI_COMPILER 160 ACPI_MODULE_NAME ("aslmapenter") 161 162 /* Local prototypes */ 163 164 static ACPI_GPIO_INFO * 165 MpCreateGpioInfo ( 166 UINT16 PinNumber, 167 char *DeviceName); 168 169 static ACPI_SERIAL_INFO * 170 MpCreateSerialInfo ( 171 char *DeviceName, 172 UINT16 Address); 173 174 175 /******************************************************************************* 176 * 177 * FUNCTION: MpSaveGpioInfo 178 * 179 * PARAMETERS: Resource - GPIO resource descriptor 180 * PinCount - From GPIO descriptor 181 * PinList - From GPIO descriptor 182 * DeviceName - The "ResourceSource" name 183 * 184 * RETURN: None 185 * 186 * DESCRIPTION: External Interface. 187 * Save GPIO resource descriptor information. 188 * Creates new GPIO info blocks, one for each pin defined by the 189 * GPIO descriptor. 190 * 191 ******************************************************************************/ 192 193 void 194 MpSaveGpioInfo ( 195 ACPI_PARSE_OBJECT *Op, 196 AML_RESOURCE *Resource, 197 UINT32 PinCount, 198 UINT16 *PinList, 199 char *DeviceName) 200 { 201 ACPI_GPIO_INFO *Info; 202 UINT32 i; 203 204 205 /* Mapfile option enabled? */ 206 207 if (!AslGbl_MapfileFlag) 208 { 209 return; 210 } 211 212 /* Create an info block for each pin defined in the descriptor */ 213 214 for (i = 0; i < PinCount; i++) 215 { 216 Info = MpCreateGpioInfo (PinList[i], DeviceName); 217 218 Info->Op = Op; 219 Info->DeviceName = DeviceName; 220 Info->PinCount = PinCount; 221 Info->PinIndex = i; 222 Info->PinNumber = PinList[i]; 223 Info->Type = Resource->Gpio.ConnectionType; 224 Info->Direction = (UINT8) (Resource->Gpio.IntFlags & 0x0003); /* _IOR, for IO descriptor */ 225 Info->Polarity = (UINT8) ((Resource->Gpio.IntFlags >> 1) & 0x0003); /* _POL, for INT descriptor */ 226 } 227 } 228 229 230 /******************************************************************************* 231 * 232 * FUNCTION: MpSaveSerialInfo 233 * 234 * PARAMETERS: Resource - A Serial resource descriptor 235 * DeviceName - The "ResourceSource" name. 236 * 237 * RETURN: None 238 * 239 * DESCRIPTION: External Interface. 240 * Save serial resource descriptor information. 241 * Creates a new serial info block. 242 * 243 ******************************************************************************/ 244 245 void 246 MpSaveSerialInfo ( 247 ACPI_PARSE_OBJECT *Op, 248 AML_RESOURCE *Resource, 249 char *DeviceName) 250 { 251 ACPI_SERIAL_INFO *Info; 252 UINT16 Address; 253 UINT32 Speed; 254 255 256 /* Mapfile option enabled? */ 257 258 if (!AslGbl_MapfileFlag) 259 { 260 return; 261 } 262 263 if (Resource->DescriptorType != ACPI_RESOURCE_NAME_SERIAL_BUS) 264 { 265 return; 266 } 267 268 /* Extract address and speed from the resource descriptor */ 269 270 switch (Resource->CommonSerialBus.Type) 271 { 272 case AML_RESOURCE_I2C_SERIALBUSTYPE: 273 274 Address = Resource->I2cSerialBus.SlaveAddress; 275 Speed = Resource->I2cSerialBus.ConnectionSpeed; 276 break; 277 278 case AML_RESOURCE_SPI_SERIALBUSTYPE: 279 280 Address = Resource->SpiSerialBus.DeviceSelection; 281 Speed = Resource->SpiSerialBus.ConnectionSpeed; 282 break; 283 284 case AML_RESOURCE_UART_SERIALBUSTYPE: 285 286 Address = 0; 287 Speed = Resource->UartSerialBus.DefaultBaudRate; 288 break; 289 290 default: /* Invalid bus subtype */ 291 return; 292 } 293 294 Info = MpCreateSerialInfo (DeviceName, Address); 295 296 Info->Op = Op; 297 Info->DeviceName = DeviceName; 298 Info->Resource = Resource; 299 Info->Address = Address; 300 Info->Speed = Speed; 301 } 302 303 304 /******************************************************************************* 305 * 306 * FUNCTION: MpCreateGpioInfo 307 * 308 * PARAMETERS: PinNumber - GPIO pin number 309 * DeviceName - The "ResourceSource" name 310 * 311 * RETURN: New GPIO info block. 312 * 313 * DESCRIPTION: Create a new GPIO info block and place it on the global list. 314 * The list is sorted by GPIO device names first, and pin numbers 315 * secondarily. 316 * 317 ******************************************************************************/ 318 319 static ACPI_GPIO_INFO * 320 MpCreateGpioInfo ( 321 UINT16 PinNumber, 322 char *DeviceName) 323 { 324 ACPI_GPIO_INFO *Info; 325 ACPI_GPIO_INFO *NextGpio; 326 ACPI_GPIO_INFO *PrevGpio; 327 char *Buffer; 328 329 330 /* 331 * Allocate a new info block and insert it into the global GPIO list 332 * sorted by both source device name and then the pin number. There is 333 * one block per pin. 334 */ 335 Buffer = UtLocalCacheCalloc (sizeof (ACPI_GPIO_INFO)); 336 Info = ACPI_CAST_PTR (ACPI_GPIO_INFO, Buffer); 337 338 NextGpio = AslGbl_GpioList; 339 PrevGpio = NULL; 340 if (!AslGbl_GpioList) 341 { 342 AslGbl_GpioList = Info; 343 Info->Next = NULL; 344 return (Info); 345 } 346 347 /* Sort on source DeviceName first */ 348 349 while (NextGpio && 350 (strcmp (DeviceName, NextGpio->DeviceName) > 0)) 351 { 352 PrevGpio = NextGpio; 353 NextGpio = NextGpio->Next; 354 } 355 356 /* Now sort on the PinNumber */ 357 358 while (NextGpio && 359 (NextGpio->PinNumber < PinNumber) && 360 !strcmp (DeviceName, NextGpio->DeviceName)) 361 { 362 PrevGpio = NextGpio; 363 NextGpio = NextGpio->Next; 364 } 365 366 /* Finish the list insertion */ 367 368 if (PrevGpio) 369 { 370 PrevGpio->Next = Info; 371 } 372 else 373 { 374 AslGbl_GpioList = Info; 375 } 376 377 Info->Next = NextGpio; 378 return (Info); 379 } 380 381 382 /******************************************************************************* 383 * 384 * FUNCTION: MpCreateSerialInfo 385 * 386 * PARAMETERS: DeviceName - The "ResourceSource" name. 387 * Address - Physical address for the device 388 * 389 * RETURN: New Serial info block. 390 * 391 * DESCRIPTION: Create a new Serial info block and place it on the global list. 392 * The list is sorted by Serial device names first, and addresses 393 * secondarily. 394 * 395 ******************************************************************************/ 396 397 static ACPI_SERIAL_INFO * 398 MpCreateSerialInfo ( 399 char *DeviceName, 400 UINT16 Address) 401 { 402 ACPI_SERIAL_INFO *Info; 403 ACPI_SERIAL_INFO *NextSerial; 404 ACPI_SERIAL_INFO *PrevSerial; 405 char *Buffer; 406 407 408 /* 409 * Allocate a new info block and insert it into the global Serial list 410 * sorted by both source device name and then the address. 411 */ 412 Buffer = UtLocalCacheCalloc (sizeof (ACPI_SERIAL_INFO)); 413 Info = ACPI_CAST_PTR (ACPI_SERIAL_INFO, Buffer); 414 415 NextSerial = AslGbl_SerialList; 416 PrevSerial = NULL; 417 if (!AslGbl_SerialList) 418 { 419 AslGbl_SerialList = Info; 420 Info->Next = NULL; 421 return (Info); 422 } 423 424 /* Sort on source DeviceName */ 425 426 while (NextSerial && 427 (strcmp (DeviceName, NextSerial->DeviceName) > 0)) 428 { 429 PrevSerial = NextSerial; 430 NextSerial = NextSerial->Next; 431 } 432 433 /* Now sort on the Address */ 434 435 while (NextSerial && 436 (NextSerial->Address < Address) && 437 !strcmp (DeviceName, NextSerial->DeviceName)) 438 { 439 PrevSerial = NextSerial; 440 NextSerial = NextSerial->Next; 441 } 442 443 /* Finish the list insertion */ 444 445 if (PrevSerial) 446 { 447 PrevSerial->Next = Info; 448 } 449 else 450 { 451 AslGbl_SerialList = Info; 452 } 453 454 Info->Next = NextSerial; 455 return (Info); 456 } 457