xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utascii.c (revision 385ee03ba83b7a40d315e17b03031b3ca37820c0)
1 /******************************************************************************
2  *
3  * Module Name: utascii - Utility ascii functions
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2016, 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 #include "acpi.h"
117 #include "accommon.h"
118 
119 
120 /*******************************************************************************
121  *
122  * FUNCTION:    AcpiUtValidNameseg
123  *
124  * PARAMETERS:  Name            - The name or table signature to be examined.
125  *                                Four characters, does not have to be a
126  *                                NULL terminated string.
127  *
128  * RETURN:      TRUE if signature is has 4 valid ACPI characters
129  *
130  * DESCRIPTION: Validate an ACPI table signature.
131  *
132  ******************************************************************************/
133 
134 BOOLEAN
135 AcpiUtValidNameseg (
136     char                    *Name)
137 {
138     UINT32                  i;
139 
140 
141     /* Validate each character in the signature */
142 
143     for (i = 0; i < ACPI_NAME_SIZE; i++)
144     {
145         if (!AcpiUtValidNameChar (Name[i], i))
146         {
147             return (FALSE);
148         }
149     }
150 
151     return (TRUE);
152 }
153 
154 
155 /*******************************************************************************
156  *
157  * FUNCTION:    AcpiUtValidNameChar
158  *
159  * PARAMETERS:  Char            - The character to be examined
160  *              Position        - Byte position (0-3)
161  *
162  * RETURN:      TRUE if the character is valid, FALSE otherwise
163  *
164  * DESCRIPTION: Check for a valid ACPI character. Must be one of:
165  *              1) Upper case alpha
166  *              2) numeric
167  *              3) underscore
168  *
169  *              We allow a '!' as the last character because of the ASF! table
170  *
171  ******************************************************************************/
172 
173 BOOLEAN
174 AcpiUtValidNameChar (
175     char                    Character,
176     UINT32                  Position)
177 {
178 
179     if (!((Character >= 'A' && Character <= 'Z') ||
180           (Character >= '0' && Character <= '9') ||
181           (Character == '_')))
182     {
183         /* Allow a '!' in the last position */
184 
185         if (Character == '!' && Position == 3)
186         {
187             return (TRUE);
188         }
189 
190         return (FALSE);
191     }
192 
193     return (TRUE);
194 }
195 
196 
197 /*******************************************************************************
198  *
199  * FUNCTION:    AcpiUtCheckAndRepairAscii
200  *
201  * PARAMETERS:  Name                - Ascii string
202  *              Count               - Number of characters to check
203  *
204  * RETURN:      None
205  *
206  * DESCRIPTION: Ensure that the requested number of characters are printable
207  *              Ascii characters. Sets non-printable and null chars to <space>.
208  *
209  ******************************************************************************/
210 
211 void
212 AcpiUtCheckAndRepairAscii (
213     UINT8                   *Name,
214     char                    *RepairedName,
215     UINT32                  Count)
216 {
217     UINT32                  i;
218 
219 
220     for (i = 0; i < Count; i++)
221     {
222         RepairedName[i] = (char) Name[i];
223 
224         if (!Name[i])
225         {
226             return;
227         }
228         if (!isprint (Name[i]))
229         {
230             RepairedName[i] = ' ';
231         }
232     }
233 }
234