7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Module Name: utstring - Common functions for strings and characters
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * All rights reserved.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Redistribution and use in source and binary forms, with or without
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * modification, are permitted provided that the following conditions
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 1. Redistributions of source code must retain the above copyright
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * notice, this list of conditions, and the following disclaimer,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * without modification.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * substantially similar to the "NO WARRANTY" disclaimer below
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * ("Disclaimer") and any redistribution must be conditioned upon
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * including a substantially similar Disclaimer requirement for further
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * binary redistribution.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 3. Neither the names of the above-listed copyright holders nor the names
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * of any contributors may be used to endorse or promote products derived
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * from this software without specific prior written permission.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Alternatively, this software may be distributed under the terms of the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * GNU General Public License ("GPL") version 2 as published by the Free
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Software Foundation.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * NO WARRANTY
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * POSSIBILITY OF SUCH DAMAGES.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiUtPrintString
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: String - Null terminated ASCII string
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * MaxLength - Maximum output length. Used to constrain the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * length of strings during debug output only.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: None
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek for (i = 0; (i < MaxLength) && String[i]; i++)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Escape sequences */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Check for printable character or hex escape */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* This is a normal character */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* All others will be Hex escapes */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiUtRepairName
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Name - The ACPI name to be repaired
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Repaired version of the name
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * return the new name. NOTE: the Name parameter must reside in
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * read/write memory, cannot be a const.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * An ACPI Name must consist of valid ACPI characters. We will repair the name
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * if necessary because we don't want to abort because of this, but we want
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * all namespace names to be printable. A warning message is appropriate.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * This issue came up because there are in fact machines that exhibit
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * this problem, and we want to be able to enable ACPI support for them,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * even though there are a few bad names.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Special case for the root node. This can happen if we get an
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * error during the execution of module-level code.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Check each character in the name */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek for (i = 0; i < ACPI_NAME_SIZE; i++)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Replace a bad character with something printable, yet technically
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * still invalid. This prevents any collisions with existing "good"
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * names in the namespace.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Report warning only if in strict mode or debug mode */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek#if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: UtConvertBackslashes
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Pathname - File pathname string to be converted
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Modifies the input Pathname
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Convert all backslashes (0x5C) to forward slashes (0x2F) within
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the entire input file pathname string.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/