| /******************************************************************************* |
| * |
| * Module Name: utstring - Common functions for strings and characters |
| * |
| ******************************************************************************/ |
| |
| /* |
| * Copyright (C) 2000 - 2016, Intel Corp. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions, and the following disclaimer, |
| * without modification. |
| * 2. Redistributions in binary form must reproduce at minimum a disclaimer |
| * substantially similar to the "NO WARRANTY" disclaimer below |
| * ("Disclaimer") and any redistribution must be conditioned upon |
| * including a substantially similar Disclaimer requirement for further |
| * binary redistribution. |
| * 3. Neither the names of the above-listed copyright holders nor the names |
| * of any contributors may be used to endorse or promote products derived |
| * from this software without specific prior written permission. |
| * |
| * Alternatively, this software may be distributed under the terms of the |
| * GNU General Public License ("GPL") version 2 as published by the Free |
| * Software Foundation. |
| * |
| * NO WARRANTY |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGES. |
| */ |
| |
| #include "acpi.h" |
| #include "accommon.h" |
| #include "acnamesp.h" |
| |
| |
| #define _COMPONENT ACPI_UTILITIES |
| ACPI_MODULE_NAME ("utstring") |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtPrintString |
| * |
| * PARAMETERS: String - Null terminated ASCII string |
| * MaxLength - Maximum output length. Used to constrain the |
| * length of strings during debug output only. |
| * |
| * RETURN: None |
| * |
| * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape |
| * sequences. |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtPrintString ( |
| char *String, |
| UINT16 MaxLength) |
| { |
| UINT32 i; |
| |
| |
| if (!String) |
| { |
| AcpiOsPrintf ("<\"NULL STRING PTR\">"); |
| return; |
| } |
| |
| AcpiOsPrintf ("\""); |
| for (i = 0; (i < MaxLength) && String[i]; i++) |
| { |
| /* Escape sequences */ |
| |
| switch (String[i]) |
| { |
| case 0x07: |
| |
| AcpiOsPrintf ("\\a"); /* BELL */ |
| break; |
| |
| case 0x08: |
| |
| AcpiOsPrintf ("\\b"); /* BACKSPACE */ |
| break; |
| |
| case 0x0C: |
| |
| AcpiOsPrintf ("\\f"); /* FORMFEED */ |
| break; |
| |
| case 0x0A: |
| |
| AcpiOsPrintf ("\\n"); /* LINEFEED */ |
| break; |
| |
| case 0x0D: |
| |
| AcpiOsPrintf ("\\r"); /* CARRIAGE RETURN*/ |
| break; |
| |
| case 0x09: |
| |
| AcpiOsPrintf ("\\t"); /* HORIZONTAL TAB */ |
| break; |
| |
| case 0x0B: |
| |
| AcpiOsPrintf ("\\v"); /* VERTICAL TAB */ |
| break; |
| |
| case '\'': /* Single Quote */ |
| case '\"': /* Double Quote */ |
| case '\\': /* Backslash */ |
| |
| AcpiOsPrintf ("\\%c", (int) String[i]); |
| break; |
| |
| default: |
| |
| /* Check for printable character or hex escape */ |
| |
| if (isprint ((int) String[i])) |
| { |
| /* This is a normal character */ |
| |
| AcpiOsPrintf ("%c", (int) String[i]); |
| } |
| else |
| { |
| /* All others will be Hex escapes */ |
| |
| AcpiOsPrintf ("\\x%2.2X", (INT32) String[i]); |
| } |
| break; |
| } |
| } |
| |
| AcpiOsPrintf ("\""); |
| |
| if (i == MaxLength && String[i]) |
| { |
| AcpiOsPrintf ("..."); |
| } |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtValidAcpiChar |
| * |
| * PARAMETERS: Char - The character to be examined |
| * Position - Byte position (0-3) |
| * |
| * RETURN: TRUE if the character is valid, FALSE otherwise |
| * |
| * DESCRIPTION: Check for a valid ACPI character. Must be one of: |
| * 1) Upper case alpha |
| * 2) numeric |
| * 3) underscore |
| * |
| * We allow a '!' as the last character because of the ASF! table |
| * |
| ******************************************************************************/ |
| |
| BOOLEAN |
| AcpiUtValidAcpiChar ( |
| char Character, |
| UINT32 Position) |
| { |
| |
| if (!((Character >= 'A' && Character <= 'Z') || |
| (Character >= '0' && Character <= '9') || |
| (Character == '_'))) |
| { |
| /* Allow a '!' in the last position */ |
| |
| if (Character == '!' && Position == 3) |
| { |
| return (TRUE); |
| } |
| |
| return (FALSE); |
| } |
| |
| return (TRUE); |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtValidAcpiName |
| * |
| * PARAMETERS: Name - The name to be examined. Does not have to |
| * be NULL terminated string. |
| * |
| * RETURN: TRUE if the name is valid, FALSE otherwise |
| * |
| * DESCRIPTION: Check for a valid ACPI name. Each character must be one of: |
| * 1) Upper case alpha |
| * 2) numeric |
| * 3) underscore |
| * |
| ******************************************************************************/ |
| |
| BOOLEAN |
| AcpiUtValidAcpiName ( |
| char *Name) |
| { |
| UINT32 i; |
| |
| |
| ACPI_FUNCTION_ENTRY (); |
| |
| |
| for (i = 0; i < ACPI_NAME_SIZE; i++) |
| { |
| if (!AcpiUtValidAcpiChar (Name[i], i)) |
| { |
| return (FALSE); |
| } |
| } |
| |
| return (TRUE); |
| } |
| |
| |
| /******************************************************************************* |
| * |
| * FUNCTION: AcpiUtRepairName |
| * |
| * PARAMETERS: Name - The ACPI name to be repaired |
| * |
| * RETURN: Repaired version of the name |
| * |
| * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and |
| * return the new name. NOTE: the Name parameter must reside in |
| * read/write memory, cannot be a const. |
| * |
| * An ACPI Name must consist of valid ACPI characters. We will repair the name |
| * if necessary because we don't want to abort because of this, but we want |
| * all namespace names to be printable. A warning message is appropriate. |
| * |
| * This issue came up because there are in fact machines that exhibit |
| * this problem, and we want to be able to enable ACPI support for them, |
| * even though there are a few bad names. |
| * |
| ******************************************************************************/ |
| |
| void |
| AcpiUtRepairName ( |
| char *Name) |
| { |
| UINT32 i; |
| BOOLEAN FoundBadChar = FALSE; |
| UINT32 OriginalName; |
| |
| |
| ACPI_FUNCTION_NAME (UtRepairName); |
| |
| |
| /* |
| * Special case for the root node. This can happen if we get an |
| * error during the execution of module-level code. |
| */ |
| if (ACPI_COMPARE_NAME (Name, "\\___")) |
| { |
| return; |
| } |
| |
| ACPI_MOVE_NAME (&OriginalName, Name); |
| |
| /* Check each character in the name */ |
| |
| for (i = 0; i < ACPI_NAME_SIZE; i++) |
| { |
| if (AcpiUtValidAcpiChar (Name[i], i)) |
| { |
| continue; |
| } |
| |
| /* |
| * Replace a bad character with something printable, yet technically |
| * still invalid. This prevents any collisions with existing "good" |
| * names in the namespace. |
| */ |
| Name[i] = '*'; |
| FoundBadChar = TRUE; |
| } |
| |
| if (FoundBadChar) |
| { |
| /* Report warning only if in strict mode or debug mode */ |
| |
| if (!AcpiGbl_EnableInterpreterSlack) |
| { |
| ACPI_WARNING ((AE_INFO, |
| "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]", |
| OriginalName, Name)); |
| } |
| else |
| { |
| ACPI_DEBUG_PRINT ((ACPI_DB_INFO, |
| "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]", |
| OriginalName, Name)); |
| } |
| } |
| } |
| |
| |
| #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP |
| /******************************************************************************* |
| * |
| * FUNCTION: UtConvertBackslashes |
| * |
| * PARAMETERS: Pathname - File pathname string to be converted |
| * |
| * RETURN: Modifies the input Pathname |
| * |
| * DESCRIPTION: Convert all backslashes (0x5C) to forward slashes (0x2F) within |
| * the entire input file pathname string. |
| * |
| ******************************************************************************/ |
| |
| void |
| UtConvertBackslashes ( |
| char *Pathname) |
| { |
| |
| if (!Pathname) |
| { |
| return; |
| } |
| |
| while (*Pathname) |
| { |
| if (*Pathname == '\\') |
| { |
| *Pathname = '/'; |
| } |
| |
| Pathname++; |
| } |
| } |
| #endif |
