1 1.1 christos /******************************************************************************* 2 1.1 christos * 3 1.1 christos * Module Name: utstring - Common functions for strings and characters 4 1.1 christos * 5 1.1 christos ******************************************************************************/ 6 1.1 christos 7 1.1.1.16 christos /****************************************************************************** 8 1.1.1.16 christos * 9 1.1.1.16 christos * 1. Copyright Notice 10 1.1.1.16 christos * 11 1.1.1.17 christos * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp. 12 1.1 christos * All rights reserved. 13 1.1 christos * 14 1.1.1.16 christos * 2. License 15 1.1.1.16 christos * 16 1.1.1.16 christos * 2.1. This is your license from Intel Corp. under its intellectual property 17 1.1.1.16 christos * rights. You may have additional license terms from the party that provided 18 1.1.1.16 christos * you this software, covering your right to use that party's intellectual 19 1.1.1.16 christos * property rights. 20 1.1.1.16 christos * 21 1.1.1.16 christos * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 1.1.1.16 christos * copy of the source code appearing in this file ("Covered Code") an 23 1.1.1.16 christos * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 1.1.1.16 christos * base code distributed originally by Intel ("Original Intel Code") to copy, 25 1.1.1.16 christos * make derivatives, distribute, use and display any portion of the Covered 26 1.1.1.16 christos * Code in any form, with the right to sublicense such rights; and 27 1.1.1.16 christos * 28 1.1.1.16 christos * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 1.1.1.16 christos * license (with the right to sublicense), under only those claims of Intel 30 1.1.1.16 christos * patents that are infringed by the Original Intel Code, to make, use, sell, 31 1.1.1.16 christos * offer to sell, and import the Covered Code and derivative works thereof 32 1.1.1.16 christos * solely to the minimum extent necessary to exercise the above copyright 33 1.1.1.16 christos * license, and in no event shall the patent license extend to any additions 34 1.1.1.16 christos * to or modifications of the Original Intel Code. No other license or right 35 1.1.1.16 christos * is granted directly or by implication, estoppel or otherwise; 36 1.1.1.16 christos * 37 1.1.1.16 christos * The above copyright and patent license is granted only if the following 38 1.1.1.16 christos * conditions are met: 39 1.1.1.16 christos * 40 1.1.1.16 christos * 3. Conditions 41 1.1.1.16 christos * 42 1.1.1.16 christos * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 1.1.1.16 christos * Redistribution of source code of any substantial portion of the Covered 44 1.1.1.16 christos * Code or modification with rights to further distribute source must include 45 1.1.1.16 christos * the above Copyright Notice, the above License, this list of Conditions, 46 1.1.1.16 christos * and the following Disclaimer and Export Compliance provision. In addition, 47 1.1.1.16 christos * Licensee must cause all Covered Code to which Licensee contributes to 48 1.1.1.16 christos * contain a file documenting the changes Licensee made to create that Covered 49 1.1.1.16 christos * Code and the date of any change. Licensee must include in that file the 50 1.1.1.16 christos * documentation of any changes made by any predecessor Licensee. Licensee 51 1.1.1.16 christos * must include a prominent statement that the modification is derived, 52 1.1.1.16 christos * directly or indirectly, from Original Intel Code. 53 1.1.1.16 christos * 54 1.1.1.16 christos * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 1.1.1.16 christos * Redistribution of source code of any substantial portion of the Covered 56 1.1.1.16 christos * Code or modification without rights to further distribute source must 57 1.1.1.16 christos * include the following Disclaimer and Export Compliance provision in the 58 1.1.1.16 christos * documentation and/or other materials provided with distribution. In 59 1.1.1.16 christos * addition, Licensee may not authorize further sublicense of source of any 60 1.1.1.16 christos * portion of the Covered Code, and must include terms to the effect that the 61 1.1.1.16 christos * license from Licensee to its licensee is limited to the intellectual 62 1.1.1.16 christos * property embodied in the software Licensee provides to its licensee, and 63 1.1.1.16 christos * not to intellectual property embodied in modifications its licensee may 64 1.1.1.16 christos * make. 65 1.1.1.16 christos * 66 1.1.1.16 christos * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 1.1.1.16 christos * substantial portion of the Covered Code or modification must reproduce the 68 1.1.1.16 christos * above Copyright Notice, and the following Disclaimer and Export Compliance 69 1.1.1.16 christos * provision in the documentation and/or other materials provided with the 70 1.1.1.16 christos * distribution. 71 1.1.1.16 christos * 72 1.1.1.16 christos * 3.4. Intel retains all right, title, and interest in and to the Original 73 1.1.1.16 christos * Intel Code. 74 1.1.1.16 christos * 75 1.1.1.16 christos * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 1.1.1.16 christos * Intel shall be used in advertising or otherwise to promote the sale, use or 77 1.1.1.16 christos * other dealings in products derived from or relating to the Covered Code 78 1.1.1.16 christos * without prior written authorization from Intel. 79 1.1.1.16 christos * 80 1.1.1.16 christos * 4. Disclaimer and Export Compliance 81 1.1.1.16 christos * 82 1.1.1.16 christos * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 1.1.1.16 christos * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 1.1.1.16 christos * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 1.1.1.16 christos * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 1.1.1.16 christos * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 1.1.1.16 christos * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 1.1.1.16 christos * PARTICULAR PURPOSE. 89 1.1.1.16 christos * 90 1.1.1.16 christos * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 1.1.1.16 christos * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 1.1.1.16 christos * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 1.1.1.16 christos * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 1.1.1.16 christos * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 1.1.1.16 christos * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 1.1.1.16 christos * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 1.1.1.16 christos * LIMITED REMEDY. 98 1.1.1.16 christos * 99 1.1.1.16 christos * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 1.1.1.16 christos * software or system incorporating such software without first obtaining any 101 1.1.1.16 christos * required license or other approval from the U. S. Department of Commerce or 102 1.1.1.16 christos * any other agency or department of the United States Government. In the 103 1.1.1.16 christos * event Licensee exports any such software from the United States or 104 1.1.1.16 christos * re-exports any such software from a foreign destination, Licensee shall 105 1.1.1.16 christos * ensure that the distribution and export/re-export of the software is in 106 1.1.1.16 christos * compliance with all laws, regulations, orders, or other restrictions of the 107 1.1.1.16 christos * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 1.1.1.16 christos * any of its subsidiaries will export/re-export any technical data, process, 109 1.1.1.16 christos * software, or service, directly or indirectly, to any country for which the 110 1.1.1.16 christos * United States government or any agency thereof requires an export license, 111 1.1.1.16 christos * other governmental approval, or letter of assurance, without first obtaining 112 1.1.1.16 christos * such license, approval or letter. 113 1.1.1.16 christos * 114 1.1.1.16 christos ***************************************************************************** 115 1.1.1.16 christos * 116 1.1.1.16 christos * Alternatively, you may choose to be licensed under the terms of the 117 1.1.1.16 christos * following license: 118 1.1.1.16 christos * 119 1.1 christos * Redistribution and use in source and binary forms, with or without 120 1.1 christos * modification, are permitted provided that the following conditions 121 1.1 christos * are met: 122 1.1 christos * 1. Redistributions of source code must retain the above copyright 123 1.1 christos * notice, this list of conditions, and the following disclaimer, 124 1.1 christos * without modification. 125 1.1 christos * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 1.1 christos * substantially similar to the "NO WARRANTY" disclaimer below 127 1.1 christos * ("Disclaimer") and any redistribution must be conditioned upon 128 1.1 christos * including a substantially similar Disclaimer requirement for further 129 1.1 christos * binary redistribution. 130 1.1 christos * 3. Neither the names of the above-listed copyright holders nor the names 131 1.1 christos * of any contributors may be used to endorse or promote products derived 132 1.1 christos * from this software without specific prior written permission. 133 1.1 christos * 134 1.1 christos * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 1.1 christos * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 1.1.1.12 christos * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 1.1 christos * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 1.1.1.16 christos * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 1.1.1.16 christos * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 1.1.1.16 christos * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 1.1.1.16 christos * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 1.1.1.16 christos * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 1.1.1.16 christos * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 1.1.1.16 christos * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 1.1.1.16 christos * 146 1.1.1.16 christos * Alternatively, you may choose to be licensed under the terms of the 147 1.1.1.16 christos * GNU General Public License ("GPL") version 2 as published by the Free 148 1.1.1.16 christos * Software Foundation. 149 1.1.1.16 christos * 150 1.1.1.16 christos *****************************************************************************/ 151 1.1 christos 152 1.1 christos #include "acpi.h" 153 1.1 christos #include "accommon.h" 154 1.1 christos #include "acnamesp.h" 155 1.1 christos 156 1.1 christos 157 1.1 christos #define _COMPONENT ACPI_UTILITIES 158 1.1 christos ACPI_MODULE_NAME ("utstring") 159 1.1 christos 160 1.1 christos 161 1.1 christos /******************************************************************************* 162 1.1 christos * 163 1.1 christos * FUNCTION: AcpiUtPrintString 164 1.1 christos * 165 1.1 christos * PARAMETERS: String - Null terminated ASCII string 166 1.1 christos * MaxLength - Maximum output length. Used to constrain the 167 1.1 christos * length of strings during debug output only. 168 1.1 christos * 169 1.1 christos * RETURN: None 170 1.1 christos * 171 1.1 christos * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape 172 1.1 christos * sequences. 173 1.1 christos * 174 1.1 christos ******************************************************************************/ 175 1.1 christos 176 1.1 christos void 177 1.1 christos AcpiUtPrintString ( 178 1.1 christos char *String, 179 1.1 christos UINT16 MaxLength) 180 1.1 christos { 181 1.1 christos UINT32 i; 182 1.1 christos 183 1.1 christos 184 1.1 christos if (!String) 185 1.1 christos { 186 1.1 christos AcpiOsPrintf ("<\"NULL STRING PTR\">"); 187 1.1 christos return; 188 1.1 christos } 189 1.1 christos 190 1.1 christos AcpiOsPrintf ("\""); 191 1.1.1.2 christos for (i = 0; (i < MaxLength) && String[i]; i++) 192 1.1 christos { 193 1.1 christos /* Escape sequences */ 194 1.1 christos 195 1.1 christos switch (String[i]) 196 1.1 christos { 197 1.1 christos case 0x07: 198 1.1 christos 199 1.1 christos AcpiOsPrintf ("\\a"); /* BELL */ 200 1.1 christos break; 201 1.1 christos 202 1.1 christos case 0x08: 203 1.1 christos 204 1.1 christos AcpiOsPrintf ("\\b"); /* BACKSPACE */ 205 1.1 christos break; 206 1.1 christos 207 1.1 christos case 0x0C: 208 1.1 christos 209 1.1 christos AcpiOsPrintf ("\\f"); /* FORMFEED */ 210 1.1 christos break; 211 1.1 christos 212 1.1 christos case 0x0A: 213 1.1 christos 214 1.1 christos AcpiOsPrintf ("\\n"); /* LINEFEED */ 215 1.1 christos break; 216 1.1 christos 217 1.1 christos case 0x0D: 218 1.1 christos 219 1.1 christos AcpiOsPrintf ("\\r"); /* CARRIAGE RETURN*/ 220 1.1 christos break; 221 1.1 christos 222 1.1 christos case 0x09: 223 1.1 christos 224 1.1 christos AcpiOsPrintf ("\\t"); /* HORIZONTAL TAB */ 225 1.1 christos break; 226 1.1 christos 227 1.1 christos case 0x0B: 228 1.1 christos 229 1.1 christos AcpiOsPrintf ("\\v"); /* VERTICAL TAB */ 230 1.1 christos break; 231 1.1 christos 232 1.1 christos case '\'': /* Single Quote */ 233 1.1 christos case '\"': /* Double Quote */ 234 1.1 christos case '\\': /* Backslash */ 235 1.1 christos 236 1.1 christos AcpiOsPrintf ("\\%c", (int) String[i]); 237 1.1 christos break; 238 1.1 christos 239 1.1 christos default: 240 1.1 christos 241 1.1 christos /* Check for printable character or hex escape */ 242 1.1 christos 243 1.1.1.4 christos if (isprint ((int) String[i])) 244 1.1 christos { 245 1.1 christos /* This is a normal character */ 246 1.1 christos 247 1.1 christos AcpiOsPrintf ("%c", (int) String[i]); 248 1.1 christos } 249 1.1 christos else 250 1.1 christos { 251 1.1 christos /* All others will be Hex escapes */ 252 1.1 christos 253 1.1 christos AcpiOsPrintf ("\\x%2.2X", (INT32) String[i]); 254 1.1 christos } 255 1.1 christos break; 256 1.1 christos } 257 1.1 christos } 258 1.1.1.5 christos 259 1.1 christos AcpiOsPrintf ("\""); 260 1.1 christos 261 1.1 christos if (i == MaxLength && String[i]) 262 1.1 christos { 263 1.1 christos AcpiOsPrintf ("..."); 264 1.1 christos } 265 1.1 christos } 266 1.1 christos 267 1.1 christos 268 1.1 christos /******************************************************************************* 269 1.1 christos * 270 1.1 christos * FUNCTION: AcpiUtRepairName 271 1.1 christos * 272 1.1 christos * PARAMETERS: Name - The ACPI name to be repaired 273 1.1 christos * 274 1.1 christos * RETURN: Repaired version of the name 275 1.1 christos * 276 1.1 christos * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and 277 1.1 christos * return the new name. NOTE: the Name parameter must reside in 278 1.1 christos * read/write memory, cannot be a const. 279 1.1 christos * 280 1.1 christos * An ACPI Name must consist of valid ACPI characters. We will repair the name 281 1.1 christos * if necessary because we don't want to abort because of this, but we want 282 1.1 christos * all namespace names to be printable. A warning message is appropriate. 283 1.1 christos * 284 1.1 christos * This issue came up because there are in fact machines that exhibit 285 1.1 christos * this problem, and we want to be able to enable ACPI support for them, 286 1.1 christos * even though there are a few bad names. 287 1.1 christos * 288 1.1 christos ******************************************************************************/ 289 1.1 christos 290 1.1 christos void 291 1.1 christos AcpiUtRepairName ( 292 1.1 christos char *Name) 293 1.1 christos { 294 1.1 christos UINT32 i; 295 1.1 christos BOOLEAN FoundBadChar = FALSE; 296 1.1 christos UINT32 OriginalName; 297 1.1 christos 298 1.1 christos 299 1.1 christos ACPI_FUNCTION_NAME (UtRepairName); 300 1.1 christos 301 1.1 christos 302 1.1.1.5 christos /* 303 1.1.1.5 christos * Special case for the root node. This can happen if we get an 304 1.1.1.5 christos * error during the execution of module-level code. 305 1.1.1.5 christos */ 306 1.1.1.10 christos if (ACPI_COMPARE_NAMESEG (Name, ACPI_ROOT_PATHNAME)) 307 1.1.1.5 christos { 308 1.1.1.5 christos return; 309 1.1.1.5 christos } 310 1.1.1.5 christos 311 1.1.1.14 christos ACPI_COPY_NAMESEG (&OriginalName, &Name[0]); 312 1.1 christos 313 1.1 christos /* Check each character in the name */ 314 1.1 christos 315 1.1.1.10 christos for (i = 0; i < ACPI_NAMESEG_SIZE; i++) 316 1.1 christos { 317 1.1.1.6 christos if (AcpiUtValidNameChar (Name[i], i)) 318 1.1 christos { 319 1.1 christos continue; 320 1.1 christos } 321 1.1 christos 322 1.1 christos /* 323 1.1 christos * Replace a bad character with something printable, yet technically 324 1.1.1.14 christos * "odd". This prevents any collisions with existing "good" 325 1.1 christos * names in the namespace. 326 1.1 christos */ 327 1.1.1.14 christos Name[i] = '_'; 328 1.1 christos FoundBadChar = TRUE; 329 1.1 christos } 330 1.1 christos 331 1.1 christos if (FoundBadChar) 332 1.1 christos { 333 1.1 christos /* Report warning only if in strict mode or debug mode */ 334 1.1 christos 335 1.1 christos if (!AcpiGbl_EnableInterpreterSlack) 336 1.1 christos { 337 1.1 christos ACPI_WARNING ((AE_INFO, 338 1.1.1.14 christos "Invalid character(s) in name (0x%.8X) %p, repaired: [%4.4s]", 339 1.1.1.14 christos OriginalName, Name, &Name[0])); 340 1.1 christos } 341 1.1 christos else 342 1.1 christos { 343 1.1 christos ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 344 1.1 christos "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]", 345 1.1 christos OriginalName, Name)); 346 1.1 christos } 347 1.1 christos } 348 1.1 christos } 349 1.1 christos 350 1.1 christos 351 1.1 christos #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP 352 1.1 christos /******************************************************************************* 353 1.1 christos * 354 1.1 christos * FUNCTION: UtConvertBackslashes 355 1.1 christos * 356 1.1 christos * PARAMETERS: Pathname - File pathname string to be converted 357 1.1 christos * 358 1.1 christos * RETURN: Modifies the input Pathname 359 1.1 christos * 360 1.1 christos * DESCRIPTION: Convert all backslashes (0x5C) to forward slashes (0x2F) within 361 1.1 christos * the entire input file pathname string. 362 1.1 christos * 363 1.1 christos ******************************************************************************/ 364 1.1 christos 365 1.1 christos void 366 1.1 christos UtConvertBackslashes ( 367 1.1 christos char *Pathname) 368 1.1 christos { 369 1.1 christos 370 1.1 christos if (!Pathname) 371 1.1 christos { 372 1.1 christos return; 373 1.1 christos } 374 1.1 christos 375 1.1 christos while (*Pathname) 376 1.1 christos { 377 1.1 christos if (*Pathname == '\\') 378 1.1 christos { 379 1.1 christos *Pathname = '/'; 380 1.1 christos } 381 1.1 christos 382 1.1 christos Pathname++; 383 1.1 christos } 384 1.1 christos } 385 1.1 christos #endif 386