xref: /titanic_44/usr/src/uts/intel/io/acpica/utilities/utascii.c (revision cb56572868bfc488bbd3ab847b09db2a25554d44)
1*cb565728SJerry Jelinek /******************************************************************************
2*cb565728SJerry Jelinek  *
3*cb565728SJerry Jelinek  * Module Name: utascii - Utility ascii functions
4*cb565728SJerry Jelinek  *
5*cb565728SJerry Jelinek  *****************************************************************************/
6*cb565728SJerry Jelinek 
7*cb565728SJerry Jelinek /*
8*cb565728SJerry Jelinek  * Copyright (C) 2000 - 2016, Intel Corp.
9*cb565728SJerry Jelinek  * All rights reserved.
10*cb565728SJerry Jelinek  *
11*cb565728SJerry Jelinek  * Redistribution and use in source and binary forms, with or without
12*cb565728SJerry Jelinek  * modification, are permitted provided that the following conditions
13*cb565728SJerry Jelinek  * are met:
14*cb565728SJerry Jelinek  * 1. Redistributions of source code must retain the above copyright
15*cb565728SJerry Jelinek  *    notice, this list of conditions, and the following disclaimer,
16*cb565728SJerry Jelinek  *    without modification.
17*cb565728SJerry Jelinek  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18*cb565728SJerry Jelinek  *    substantially similar to the "NO WARRANTY" disclaimer below
19*cb565728SJerry Jelinek  *    ("Disclaimer") and any redistribution must be conditioned upon
20*cb565728SJerry Jelinek  *    including a substantially similar Disclaimer requirement for further
21*cb565728SJerry Jelinek  *    binary redistribution.
22*cb565728SJerry Jelinek  * 3. Neither the names of the above-listed copyright holders nor the names
23*cb565728SJerry Jelinek  *    of any contributors may be used to endorse or promote products derived
24*cb565728SJerry Jelinek  *    from this software without specific prior written permission.
25*cb565728SJerry Jelinek  *
26*cb565728SJerry Jelinek  * Alternatively, this software may be distributed under the terms of the
27*cb565728SJerry Jelinek  * GNU General Public License ("GPL") version 2 as published by the Free
28*cb565728SJerry Jelinek  * Software Foundation.
29*cb565728SJerry Jelinek  *
30*cb565728SJerry Jelinek  * NO WARRANTY
31*cb565728SJerry Jelinek  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32*cb565728SJerry Jelinek  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33*cb565728SJerry Jelinek  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34*cb565728SJerry Jelinek  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35*cb565728SJerry Jelinek  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36*cb565728SJerry Jelinek  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37*cb565728SJerry Jelinek  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38*cb565728SJerry Jelinek  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39*cb565728SJerry Jelinek  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40*cb565728SJerry Jelinek  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41*cb565728SJerry Jelinek  * POSSIBILITY OF SUCH DAMAGES.
42*cb565728SJerry Jelinek  */
43*cb565728SJerry Jelinek 
44*cb565728SJerry Jelinek #include "acpi.h"
45*cb565728SJerry Jelinek #include "accommon.h"
46*cb565728SJerry Jelinek 
47*cb565728SJerry Jelinek 
48*cb565728SJerry Jelinek /*******************************************************************************
49*cb565728SJerry Jelinek  *
50*cb565728SJerry Jelinek  * FUNCTION:    AcpiUtValidNameseg
51*cb565728SJerry Jelinek  *
52*cb565728SJerry Jelinek  * PARAMETERS:  Name            - The name or table signature to be examined.
53*cb565728SJerry Jelinek  *                                Four characters, does not have to be a
54*cb565728SJerry Jelinek  *                                NULL terminated string.
55*cb565728SJerry Jelinek  *
56*cb565728SJerry Jelinek  * RETURN:      TRUE if signature is has 4 valid ACPI characters
57*cb565728SJerry Jelinek  *
58*cb565728SJerry Jelinek  * DESCRIPTION: Validate an ACPI table signature.
59*cb565728SJerry Jelinek  *
60*cb565728SJerry Jelinek  ******************************************************************************/
61*cb565728SJerry Jelinek 
62*cb565728SJerry Jelinek BOOLEAN
AcpiUtValidNameseg(char * Name)63*cb565728SJerry Jelinek AcpiUtValidNameseg (
64*cb565728SJerry Jelinek     char                    *Name)
65*cb565728SJerry Jelinek {
66*cb565728SJerry Jelinek     UINT32                  i;
67*cb565728SJerry Jelinek 
68*cb565728SJerry Jelinek 
69*cb565728SJerry Jelinek     /* Validate each character in the signature */
70*cb565728SJerry Jelinek 
71*cb565728SJerry Jelinek     for (i = 0; i < ACPI_NAME_SIZE; i++)
72*cb565728SJerry Jelinek     {
73*cb565728SJerry Jelinek         if (!AcpiUtValidNameChar (Name[i], i))
74*cb565728SJerry Jelinek         {
75*cb565728SJerry Jelinek             return (FALSE);
76*cb565728SJerry Jelinek         }
77*cb565728SJerry Jelinek     }
78*cb565728SJerry Jelinek 
79*cb565728SJerry Jelinek     return (TRUE);
80*cb565728SJerry Jelinek }
81*cb565728SJerry Jelinek 
82*cb565728SJerry Jelinek 
83*cb565728SJerry Jelinek /*******************************************************************************
84*cb565728SJerry Jelinek  *
85*cb565728SJerry Jelinek  * FUNCTION:    AcpiUtValidNameChar
86*cb565728SJerry Jelinek  *
87*cb565728SJerry Jelinek  * PARAMETERS:  Char            - The character to be examined
88*cb565728SJerry Jelinek  *              Position        - Byte position (0-3)
89*cb565728SJerry Jelinek  *
90*cb565728SJerry Jelinek  * RETURN:      TRUE if the character is valid, FALSE otherwise
91*cb565728SJerry Jelinek  *
92*cb565728SJerry Jelinek  * DESCRIPTION: Check for a valid ACPI character. Must be one of:
93*cb565728SJerry Jelinek  *              1) Upper case alpha
94*cb565728SJerry Jelinek  *              2) numeric
95*cb565728SJerry Jelinek  *              3) underscore
96*cb565728SJerry Jelinek  *
97*cb565728SJerry Jelinek  *              We allow a '!' as the last character because of the ASF! table
98*cb565728SJerry Jelinek  *
99*cb565728SJerry Jelinek  ******************************************************************************/
100*cb565728SJerry Jelinek 
101*cb565728SJerry Jelinek BOOLEAN
AcpiUtValidNameChar(char Character,UINT32 Position)102*cb565728SJerry Jelinek AcpiUtValidNameChar (
103*cb565728SJerry Jelinek     char                    Character,
104*cb565728SJerry Jelinek     UINT32                  Position)
105*cb565728SJerry Jelinek {
106*cb565728SJerry Jelinek 
107*cb565728SJerry Jelinek     if (!((Character >= 'A' && Character <= 'Z') ||
108*cb565728SJerry Jelinek           (Character >= '0' && Character <= '9') ||
109*cb565728SJerry Jelinek           (Character == '_')))
110*cb565728SJerry Jelinek     {
111*cb565728SJerry Jelinek         /* Allow a '!' in the last position */
112*cb565728SJerry Jelinek 
113*cb565728SJerry Jelinek         if (Character == '!' && Position == 3)
114*cb565728SJerry Jelinek         {
115*cb565728SJerry Jelinek             return (TRUE);
116*cb565728SJerry Jelinek         }
117*cb565728SJerry Jelinek 
118*cb565728SJerry Jelinek         return (FALSE);
119*cb565728SJerry Jelinek     }
120*cb565728SJerry Jelinek 
121*cb565728SJerry Jelinek     return (TRUE);
122*cb565728SJerry Jelinek }
123*cb565728SJerry Jelinek 
124*cb565728SJerry Jelinek 
125*cb565728SJerry Jelinek /*******************************************************************************
126*cb565728SJerry Jelinek  *
127*cb565728SJerry Jelinek  * FUNCTION:    AcpiUtCheckAndRepairAscii
128*cb565728SJerry Jelinek  *
129*cb565728SJerry Jelinek  * PARAMETERS:  Name                - Ascii string
130*cb565728SJerry Jelinek  *              Count               - Number of characters to check
131*cb565728SJerry Jelinek  *
132*cb565728SJerry Jelinek  * RETURN:      None
133*cb565728SJerry Jelinek  *
134*cb565728SJerry Jelinek  * DESCRIPTION: Ensure that the requested number of characters are printable
135*cb565728SJerry Jelinek  *              Ascii characters. Sets non-printable and null chars to <space>.
136*cb565728SJerry Jelinek  *
137*cb565728SJerry Jelinek  ******************************************************************************/
138*cb565728SJerry Jelinek 
139*cb565728SJerry Jelinek void
AcpiUtCheckAndRepairAscii(UINT8 * Name,char * RepairedName,UINT32 Count)140*cb565728SJerry Jelinek AcpiUtCheckAndRepairAscii (
141*cb565728SJerry Jelinek     UINT8                   *Name,
142*cb565728SJerry Jelinek     char                    *RepairedName,
143*cb565728SJerry Jelinek     UINT32                  Count)
144*cb565728SJerry Jelinek {
145*cb565728SJerry Jelinek     UINT32                  i;
146*cb565728SJerry Jelinek 
147*cb565728SJerry Jelinek 
148*cb565728SJerry Jelinek     for (i = 0; i < Count; i++)
149*cb565728SJerry Jelinek     {
150*cb565728SJerry Jelinek         RepairedName[i] = (char) Name[i];
151*cb565728SJerry Jelinek 
152*cb565728SJerry Jelinek         if (!Name[i])
153*cb565728SJerry Jelinek         {
154*cb565728SJerry Jelinek             return;
155*cb565728SJerry Jelinek         }
156*cb565728SJerry Jelinek         if (!isprint (Name[i]))
157*cb565728SJerry Jelinek         {
158*cb565728SJerry Jelinek             RepairedName[i] = ' ';
159*cb565728SJerry Jelinek         }
160*cb565728SJerry Jelinek     }
161*cb565728SJerry Jelinek }
162