1*35786f68SRobert Mustacchi /*******************************************************************************
2*35786f68SRobert Mustacchi *
3*35786f68SRobert Mustacchi * Module Name: utstrsuppt - Support functions for string-to-integer conversion
4*35786f68SRobert Mustacchi *
5*35786f68SRobert Mustacchi ******************************************************************************/
6*35786f68SRobert Mustacchi
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12*35786f68SRobert Mustacchi * All rights reserved.
13*35786f68SRobert Mustacchi *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
119*35786f68SRobert Mustacchi * Redistribution and use in source and binary forms, with or without
120*35786f68SRobert Mustacchi * modification, are permitted provided that the following conditions
121*35786f68SRobert Mustacchi * are met:
122*35786f68SRobert Mustacchi * 1. Redistributions of source code must retain the above copyright
123*35786f68SRobert Mustacchi * notice, this list of conditions, and the following disclaimer,
124*35786f68SRobert Mustacchi * without modification.
125*35786f68SRobert Mustacchi * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126*35786f68SRobert Mustacchi * substantially similar to the "NO WARRANTY" disclaimer below
127*35786f68SRobert Mustacchi * ("Disclaimer") and any redistribution must be conditioned upon
128*35786f68SRobert Mustacchi * including a substantially similar Disclaimer requirement for further
129*35786f68SRobert Mustacchi * binary redistribution.
130*35786f68SRobert Mustacchi * 3. Neither the names of the above-listed copyright holders nor the names
131*35786f68SRobert Mustacchi * of any contributors may be used to endorse or promote products derived
132*35786f68SRobert Mustacchi * from this software without specific prior written permission.
133*35786f68SRobert Mustacchi *
134*35786f68SRobert Mustacchi * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135*35786f68SRobert Mustacchi * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137*35786f68SRobert Mustacchi * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi * Software Foundation.
149*35786f68SRobert Mustacchi *
150*35786f68SRobert Mustacchi *****************************************************************************/
151*35786f68SRobert Mustacchi
152*35786f68SRobert Mustacchi #include "acpi.h"
153*35786f68SRobert Mustacchi #include "accommon.h"
154*35786f68SRobert Mustacchi
155*35786f68SRobert Mustacchi #define _COMPONENT ACPI_UTILITIES
156*35786f68SRobert Mustacchi ACPI_MODULE_NAME ("utstrsuppt")
157*35786f68SRobert Mustacchi
158*35786f68SRobert Mustacchi
159*35786f68SRobert Mustacchi /* Local prototypes */
160*35786f68SRobert Mustacchi
161*35786f68SRobert Mustacchi static ACPI_STATUS
162*35786f68SRobert Mustacchi AcpiUtInsertDigit (
163*35786f68SRobert Mustacchi UINT64 *AccumulatedValue,
164*35786f68SRobert Mustacchi UINT32 Base,
165*35786f68SRobert Mustacchi int AsciiDigit);
166*35786f68SRobert Mustacchi
167*35786f68SRobert Mustacchi static ACPI_STATUS
168*35786f68SRobert Mustacchi AcpiUtStrtoulMultiply64 (
169*35786f68SRobert Mustacchi UINT64 Multiplicand,
170*35786f68SRobert Mustacchi UINT32 Base,
171*35786f68SRobert Mustacchi UINT64 *OutProduct);
172*35786f68SRobert Mustacchi
173*35786f68SRobert Mustacchi static ACPI_STATUS
174*35786f68SRobert Mustacchi AcpiUtStrtoulAdd64 (
175*35786f68SRobert Mustacchi UINT64 Addend1,
176*35786f68SRobert Mustacchi UINT32 Digit,
177*35786f68SRobert Mustacchi UINT64 *OutSum);
178*35786f68SRobert Mustacchi
179*35786f68SRobert Mustacchi
180*35786f68SRobert Mustacchi /*******************************************************************************
181*35786f68SRobert Mustacchi *
182*35786f68SRobert Mustacchi * FUNCTION: AcpiUtConvertOctalString
183*35786f68SRobert Mustacchi *
184*35786f68SRobert Mustacchi * PARAMETERS: String - Null terminated input string
185*35786f68SRobert Mustacchi * ReturnValuePtr - Where the converted value is returned
186*35786f68SRobert Mustacchi *
187*35786f68SRobert Mustacchi * RETURN: Status and 64-bit converted integer
188*35786f68SRobert Mustacchi *
189*35786f68SRobert Mustacchi * DESCRIPTION: Performs a base 8 conversion of the input string to an
190*35786f68SRobert Mustacchi * integer value, either 32 or 64 bits.
191*35786f68SRobert Mustacchi *
192*35786f68SRobert Mustacchi * NOTE: Maximum 64-bit unsigned octal value is 01777777777777777777777
193*35786f68SRobert Mustacchi * Maximum 32-bit unsigned octal value is 037777777777
194*35786f68SRobert Mustacchi *
195*35786f68SRobert Mustacchi ******************************************************************************/
196*35786f68SRobert Mustacchi
197*35786f68SRobert Mustacchi ACPI_STATUS
AcpiUtConvertOctalString(char * String,UINT64 * ReturnValuePtr)198*35786f68SRobert Mustacchi AcpiUtConvertOctalString (
199*35786f68SRobert Mustacchi char *String,
200*35786f68SRobert Mustacchi UINT64 *ReturnValuePtr)
201*35786f68SRobert Mustacchi {
202*35786f68SRobert Mustacchi UINT64 AccumulatedValue = 0;
203*35786f68SRobert Mustacchi ACPI_STATUS Status = AE_OK;
204*35786f68SRobert Mustacchi
205*35786f68SRobert Mustacchi
206*35786f68SRobert Mustacchi /* Convert each ASCII byte in the input string */
207*35786f68SRobert Mustacchi
208*35786f68SRobert Mustacchi while (*String)
209*35786f68SRobert Mustacchi {
210*35786f68SRobert Mustacchi /* Character must be ASCII 0-7, otherwise terminate with no error */
211*35786f68SRobert Mustacchi
212*35786f68SRobert Mustacchi if (!(ACPI_IS_OCTAL_DIGIT (*String)))
213*35786f68SRobert Mustacchi {
214*35786f68SRobert Mustacchi break;
215*35786f68SRobert Mustacchi }
216*35786f68SRobert Mustacchi
217*35786f68SRobert Mustacchi /* Convert and insert this octal digit into the accumulator */
218*35786f68SRobert Mustacchi
219*35786f68SRobert Mustacchi Status = AcpiUtInsertDigit (&AccumulatedValue, 8, *String);
220*35786f68SRobert Mustacchi if (ACPI_FAILURE (Status))
221*35786f68SRobert Mustacchi {
222*35786f68SRobert Mustacchi Status = AE_OCTAL_OVERFLOW;
223*35786f68SRobert Mustacchi break;
224*35786f68SRobert Mustacchi }
225*35786f68SRobert Mustacchi
226*35786f68SRobert Mustacchi String++;
227*35786f68SRobert Mustacchi }
228*35786f68SRobert Mustacchi
229*35786f68SRobert Mustacchi /* Always return the value that has been accumulated */
230*35786f68SRobert Mustacchi
231*35786f68SRobert Mustacchi *ReturnValuePtr = AccumulatedValue;
232*35786f68SRobert Mustacchi return (Status);
233*35786f68SRobert Mustacchi }
234*35786f68SRobert Mustacchi
235*35786f68SRobert Mustacchi
236*35786f68SRobert Mustacchi /*******************************************************************************
237*35786f68SRobert Mustacchi *
238*35786f68SRobert Mustacchi * FUNCTION: AcpiUtConvertDecimalString
239*35786f68SRobert Mustacchi *
240*35786f68SRobert Mustacchi * PARAMETERS: String - Null terminated input string
241*35786f68SRobert Mustacchi * ReturnValuePtr - Where the converted value is returned
242*35786f68SRobert Mustacchi *
243*35786f68SRobert Mustacchi * RETURN: Status and 64-bit converted integer
244*35786f68SRobert Mustacchi *
245*35786f68SRobert Mustacchi * DESCRIPTION: Performs a base 10 conversion of the input string to an
246*35786f68SRobert Mustacchi * integer value, either 32 or 64 bits.
247*35786f68SRobert Mustacchi *
248*35786f68SRobert Mustacchi * NOTE: Maximum 64-bit unsigned decimal value is 18446744073709551615
249*35786f68SRobert Mustacchi * Maximum 32-bit unsigned decimal value is 4294967295
250*35786f68SRobert Mustacchi *
251*35786f68SRobert Mustacchi ******************************************************************************/
252*35786f68SRobert Mustacchi
253*35786f68SRobert Mustacchi ACPI_STATUS
AcpiUtConvertDecimalString(char * String,UINT64 * ReturnValuePtr)254*35786f68SRobert Mustacchi AcpiUtConvertDecimalString (
255*35786f68SRobert Mustacchi char *String,
256*35786f68SRobert Mustacchi UINT64 *ReturnValuePtr)
257*35786f68SRobert Mustacchi {
258*35786f68SRobert Mustacchi UINT64 AccumulatedValue = 0;
259*35786f68SRobert Mustacchi ACPI_STATUS Status = AE_OK;
260*35786f68SRobert Mustacchi
261*35786f68SRobert Mustacchi
262*35786f68SRobert Mustacchi /* Convert each ASCII byte in the input string */
263*35786f68SRobert Mustacchi
264*35786f68SRobert Mustacchi while (*String)
265*35786f68SRobert Mustacchi {
266*35786f68SRobert Mustacchi /* Character must be ASCII 0-9, otherwise terminate with no error */
267*35786f68SRobert Mustacchi
268*35786f68SRobert Mustacchi if (!isdigit (*String))
269*35786f68SRobert Mustacchi {
270*35786f68SRobert Mustacchi break;
271*35786f68SRobert Mustacchi }
272*35786f68SRobert Mustacchi
273*35786f68SRobert Mustacchi /* Convert and insert this decimal digit into the accumulator */
274*35786f68SRobert Mustacchi
275*35786f68SRobert Mustacchi Status = AcpiUtInsertDigit (&AccumulatedValue, 10, *String);
276*35786f68SRobert Mustacchi if (ACPI_FAILURE (Status))
277*35786f68SRobert Mustacchi {
278*35786f68SRobert Mustacchi Status = AE_DECIMAL_OVERFLOW;
279*35786f68SRobert Mustacchi break;
280*35786f68SRobert Mustacchi }
281*35786f68SRobert Mustacchi
282*35786f68SRobert Mustacchi String++;
283*35786f68SRobert Mustacchi }
284*35786f68SRobert Mustacchi
285*35786f68SRobert Mustacchi /* Always return the value that has been accumulated */
286*35786f68SRobert Mustacchi
287*35786f68SRobert Mustacchi *ReturnValuePtr = AccumulatedValue;
288*35786f68SRobert Mustacchi return (Status);
289*35786f68SRobert Mustacchi }
290*35786f68SRobert Mustacchi
291*35786f68SRobert Mustacchi
292*35786f68SRobert Mustacchi /*******************************************************************************
293*35786f68SRobert Mustacchi *
294*35786f68SRobert Mustacchi * FUNCTION: AcpiUtConvertHexString
295*35786f68SRobert Mustacchi *
296*35786f68SRobert Mustacchi * PARAMETERS: String - Null terminated input string
297*35786f68SRobert Mustacchi * ReturnValuePtr - Where the converted value is returned
298*35786f68SRobert Mustacchi *
299*35786f68SRobert Mustacchi * RETURN: Status and 64-bit converted integer
300*35786f68SRobert Mustacchi *
301*35786f68SRobert Mustacchi * DESCRIPTION: Performs a base 16 conversion of the input string to an
302*35786f68SRobert Mustacchi * integer value, either 32 or 64 bits.
303*35786f68SRobert Mustacchi *
304*35786f68SRobert Mustacchi * NOTE: Maximum 64-bit unsigned hex value is 0xFFFFFFFFFFFFFFFF
305*35786f68SRobert Mustacchi * Maximum 32-bit unsigned hex value is 0xFFFFFFFF
306*35786f68SRobert Mustacchi *
307*35786f68SRobert Mustacchi ******************************************************************************/
308*35786f68SRobert Mustacchi
309*35786f68SRobert Mustacchi ACPI_STATUS
AcpiUtConvertHexString(char * String,UINT64 * ReturnValuePtr)310*35786f68SRobert Mustacchi AcpiUtConvertHexString (
311*35786f68SRobert Mustacchi char *String,
312*35786f68SRobert Mustacchi UINT64 *ReturnValuePtr)
313*35786f68SRobert Mustacchi {
314*35786f68SRobert Mustacchi UINT64 AccumulatedValue = 0;
315*35786f68SRobert Mustacchi ACPI_STATUS Status = AE_OK;
316*35786f68SRobert Mustacchi
317*35786f68SRobert Mustacchi
318*35786f68SRobert Mustacchi /* Convert each ASCII byte in the input string */
319*35786f68SRobert Mustacchi
320*35786f68SRobert Mustacchi while (*String)
321*35786f68SRobert Mustacchi {
322*35786f68SRobert Mustacchi /* Must be ASCII A-F, a-f, or 0-9, otherwise terminate with no error */
323*35786f68SRobert Mustacchi
324*35786f68SRobert Mustacchi if (!isxdigit (*String))
325*35786f68SRobert Mustacchi {
326*35786f68SRobert Mustacchi break;
327*35786f68SRobert Mustacchi }
328*35786f68SRobert Mustacchi
329*35786f68SRobert Mustacchi /* Convert and insert this hex digit into the accumulator */
330*35786f68SRobert Mustacchi
331*35786f68SRobert Mustacchi Status = AcpiUtInsertDigit (&AccumulatedValue, 16, *String);
332*35786f68SRobert Mustacchi if (ACPI_FAILURE (Status))
333*35786f68SRobert Mustacchi {
334*35786f68SRobert Mustacchi Status = AE_HEX_OVERFLOW;
335*35786f68SRobert Mustacchi break;
336*35786f68SRobert Mustacchi }
337*35786f68SRobert Mustacchi
338*35786f68SRobert Mustacchi String++;
339*35786f68SRobert Mustacchi }
340*35786f68SRobert Mustacchi
341*35786f68SRobert Mustacchi /* Always return the value that has been accumulated */
342*35786f68SRobert Mustacchi
343*35786f68SRobert Mustacchi *ReturnValuePtr = AccumulatedValue;
344*35786f68SRobert Mustacchi return (Status);
345*35786f68SRobert Mustacchi }
346*35786f68SRobert Mustacchi
347*35786f68SRobert Mustacchi
348*35786f68SRobert Mustacchi /*******************************************************************************
349*35786f68SRobert Mustacchi *
350*35786f68SRobert Mustacchi * FUNCTION: AcpiUtRemoveLeadingZeros
351*35786f68SRobert Mustacchi *
352*35786f68SRobert Mustacchi * PARAMETERS: String - Pointer to input ASCII string
353*35786f68SRobert Mustacchi *
354*35786f68SRobert Mustacchi * RETURN: Next character after any leading zeros. This character may be
355*35786f68SRobert Mustacchi * used by the caller to detect end-of-string.
356*35786f68SRobert Mustacchi *
357*35786f68SRobert Mustacchi * DESCRIPTION: Remove any leading zeros in the input string. Return the
358*35786f68SRobert Mustacchi * next character after the final ASCII zero to enable the caller
359*35786f68SRobert Mustacchi * to check for the end of the string (NULL terminator).
360*35786f68SRobert Mustacchi *
361*35786f68SRobert Mustacchi ******************************************************************************/
362*35786f68SRobert Mustacchi
363*35786f68SRobert Mustacchi char
AcpiUtRemoveLeadingZeros(char ** String)364*35786f68SRobert Mustacchi AcpiUtRemoveLeadingZeros (
365*35786f68SRobert Mustacchi char **String)
366*35786f68SRobert Mustacchi {
367*35786f68SRobert Mustacchi
368*35786f68SRobert Mustacchi while (**String == ACPI_ASCII_ZERO)
369*35786f68SRobert Mustacchi {
370*35786f68SRobert Mustacchi *String += 1;
371*35786f68SRobert Mustacchi }
372*35786f68SRobert Mustacchi
373*35786f68SRobert Mustacchi return (**String);
374*35786f68SRobert Mustacchi }
375*35786f68SRobert Mustacchi
376*35786f68SRobert Mustacchi
377*35786f68SRobert Mustacchi /*******************************************************************************
378*35786f68SRobert Mustacchi *
379*35786f68SRobert Mustacchi * FUNCTION: AcpiUtRemoveWhitespace
380*35786f68SRobert Mustacchi *
381*35786f68SRobert Mustacchi * PARAMETERS: String - Pointer to input ASCII string
382*35786f68SRobert Mustacchi *
383*35786f68SRobert Mustacchi * RETURN: Next character after any whitespace. This character may be
384*35786f68SRobert Mustacchi * used by the caller to detect end-of-string.
385*35786f68SRobert Mustacchi *
386*35786f68SRobert Mustacchi * DESCRIPTION: Remove any leading whitespace in the input string. Return the
387*35786f68SRobert Mustacchi * next character after the final ASCII zero to enable the caller
388*35786f68SRobert Mustacchi * to check for the end of the string (NULL terminator).
389*35786f68SRobert Mustacchi *
390*35786f68SRobert Mustacchi ******************************************************************************/
391*35786f68SRobert Mustacchi
392*35786f68SRobert Mustacchi char
AcpiUtRemoveWhitespace(char ** String)393*35786f68SRobert Mustacchi AcpiUtRemoveWhitespace (
394*35786f68SRobert Mustacchi char **String)
395*35786f68SRobert Mustacchi {
396*35786f68SRobert Mustacchi
397*35786f68SRobert Mustacchi while (isspace ((UINT8) **String))
398*35786f68SRobert Mustacchi {
399*35786f68SRobert Mustacchi *String += 1;
400*35786f68SRobert Mustacchi }
401*35786f68SRobert Mustacchi
402*35786f68SRobert Mustacchi return (**String);
403*35786f68SRobert Mustacchi }
404*35786f68SRobert Mustacchi
405*35786f68SRobert Mustacchi
406*35786f68SRobert Mustacchi /*******************************************************************************
407*35786f68SRobert Mustacchi *
408*35786f68SRobert Mustacchi * FUNCTION: AcpiUtDetectHexPrefix
409*35786f68SRobert Mustacchi *
410*35786f68SRobert Mustacchi * PARAMETERS: String - Pointer to input ASCII string
411*35786f68SRobert Mustacchi *
412*35786f68SRobert Mustacchi * RETURN: TRUE if a "0x" prefix was found at the start of the string
413*35786f68SRobert Mustacchi *
414*35786f68SRobert Mustacchi * DESCRIPTION: Detect and remove a hex "0x" prefix
415*35786f68SRobert Mustacchi *
416*35786f68SRobert Mustacchi ******************************************************************************/
417*35786f68SRobert Mustacchi
418*35786f68SRobert Mustacchi BOOLEAN
AcpiUtDetectHexPrefix(char ** String)419*35786f68SRobert Mustacchi AcpiUtDetectHexPrefix (
420*35786f68SRobert Mustacchi char **String)
421*35786f68SRobert Mustacchi {
422*35786f68SRobert Mustacchi
423*35786f68SRobert Mustacchi if ((**String == ACPI_ASCII_ZERO) &&
424*35786f68SRobert Mustacchi (tolower ((int) *(*String + 1)) == 'x'))
425*35786f68SRobert Mustacchi {
426*35786f68SRobert Mustacchi *String += 2; /* Go past the leading 0x */
427*35786f68SRobert Mustacchi return (TRUE);
428*35786f68SRobert Mustacchi }
429*35786f68SRobert Mustacchi
430*35786f68SRobert Mustacchi return (FALSE); /* Not a hex string */
431*35786f68SRobert Mustacchi }
432*35786f68SRobert Mustacchi
433*35786f68SRobert Mustacchi
434*35786f68SRobert Mustacchi /*******************************************************************************
435*35786f68SRobert Mustacchi *
436*35786f68SRobert Mustacchi * FUNCTION: AcpiUtDetectOctalPrefix
437*35786f68SRobert Mustacchi *
438*35786f68SRobert Mustacchi * PARAMETERS: String - Pointer to input ASCII string
439*35786f68SRobert Mustacchi *
440*35786f68SRobert Mustacchi * RETURN: True if an octal "0" prefix was found at the start of the
441*35786f68SRobert Mustacchi * string
442*35786f68SRobert Mustacchi *
443*35786f68SRobert Mustacchi * DESCRIPTION: Detect and remove an octal prefix (zero)
444*35786f68SRobert Mustacchi *
445*35786f68SRobert Mustacchi ******************************************************************************/
446*35786f68SRobert Mustacchi
447*35786f68SRobert Mustacchi BOOLEAN
AcpiUtDetectOctalPrefix(char ** String)448*35786f68SRobert Mustacchi AcpiUtDetectOctalPrefix (
449*35786f68SRobert Mustacchi char **String)
450*35786f68SRobert Mustacchi {
451*35786f68SRobert Mustacchi
452*35786f68SRobert Mustacchi if (**String == ACPI_ASCII_ZERO)
453*35786f68SRobert Mustacchi {
454*35786f68SRobert Mustacchi *String += 1; /* Go past the leading 0 */
455*35786f68SRobert Mustacchi return (TRUE);
456*35786f68SRobert Mustacchi }
457*35786f68SRobert Mustacchi
458*35786f68SRobert Mustacchi return (FALSE); /* Not an octal string */
459*35786f68SRobert Mustacchi }
460*35786f68SRobert Mustacchi
461*35786f68SRobert Mustacchi
462*35786f68SRobert Mustacchi /*******************************************************************************
463*35786f68SRobert Mustacchi *
464*35786f68SRobert Mustacchi * FUNCTION: AcpiUtInsertDigit
465*35786f68SRobert Mustacchi *
466*35786f68SRobert Mustacchi * PARAMETERS: AccumulatedValue - Current value of the integer value
467*35786f68SRobert Mustacchi * accumulator. The new value is
468*35786f68SRobert Mustacchi * returned here.
469*35786f68SRobert Mustacchi * Base - Radix, either 8/10/16
470*35786f68SRobert Mustacchi * AsciiDigit - ASCII single digit to be inserted
471*35786f68SRobert Mustacchi *
472*35786f68SRobert Mustacchi * RETURN: Status and result of the convert/insert operation. The only
473*35786f68SRobert Mustacchi * possible returned exception code is numeric overflow of
474*35786f68SRobert Mustacchi * either the multiply or add conversion operations.
475*35786f68SRobert Mustacchi *
476*35786f68SRobert Mustacchi * DESCRIPTION: Generic conversion and insertion function for all bases:
477*35786f68SRobert Mustacchi *
478*35786f68SRobert Mustacchi * 1) Multiply the current accumulated/converted value by the
479*35786f68SRobert Mustacchi * base in order to make room for the new character.
480*35786f68SRobert Mustacchi *
481*35786f68SRobert Mustacchi * 2) Convert the new character to binary and add it to the
482*35786f68SRobert Mustacchi * current accumulated value.
483*35786f68SRobert Mustacchi *
484*35786f68SRobert Mustacchi * Note: The only possible exception indicates an integer
485*35786f68SRobert Mustacchi * overflow (AE_NUMERIC_OVERFLOW)
486*35786f68SRobert Mustacchi *
487*35786f68SRobert Mustacchi ******************************************************************************/
488*35786f68SRobert Mustacchi
489*35786f68SRobert Mustacchi static ACPI_STATUS
AcpiUtInsertDigit(UINT64 * AccumulatedValue,UINT32 Base,int AsciiDigit)490*35786f68SRobert Mustacchi AcpiUtInsertDigit (
491*35786f68SRobert Mustacchi UINT64 *AccumulatedValue,
492*35786f68SRobert Mustacchi UINT32 Base,
493*35786f68SRobert Mustacchi int AsciiDigit)
494*35786f68SRobert Mustacchi {
495*35786f68SRobert Mustacchi ACPI_STATUS Status;
496*35786f68SRobert Mustacchi UINT64 Product;
497*35786f68SRobert Mustacchi
498*35786f68SRobert Mustacchi
499*35786f68SRobert Mustacchi /* Make room in the accumulated value for the incoming digit */
500*35786f68SRobert Mustacchi
501*35786f68SRobert Mustacchi Status = AcpiUtStrtoulMultiply64 (*AccumulatedValue, Base, &Product);
502*35786f68SRobert Mustacchi if (ACPI_FAILURE (Status))
503*35786f68SRobert Mustacchi {
504*35786f68SRobert Mustacchi return (Status);
505*35786f68SRobert Mustacchi }
506*35786f68SRobert Mustacchi
507*35786f68SRobert Mustacchi /* Add in the new digit, and store the sum to the accumulated value */
508*35786f68SRobert Mustacchi
509*35786f68SRobert Mustacchi Status = AcpiUtStrtoulAdd64 (Product, AcpiUtAsciiCharToHex (AsciiDigit),
510*35786f68SRobert Mustacchi AccumulatedValue);
511*35786f68SRobert Mustacchi
512*35786f68SRobert Mustacchi return (Status);
513*35786f68SRobert Mustacchi }
514*35786f68SRobert Mustacchi
515*35786f68SRobert Mustacchi
516*35786f68SRobert Mustacchi /*******************************************************************************
517*35786f68SRobert Mustacchi *
518*35786f68SRobert Mustacchi * FUNCTION: AcpiUtStrtoulMultiply64
519*35786f68SRobert Mustacchi *
520*35786f68SRobert Mustacchi * PARAMETERS: Multiplicand - Current accumulated converted integer
521*35786f68SRobert Mustacchi * Base - Base/Radix
522*35786f68SRobert Mustacchi * OutProduct - Where the product is returned
523*35786f68SRobert Mustacchi *
524*35786f68SRobert Mustacchi * RETURN: Status and 64-bit product
525*35786f68SRobert Mustacchi *
526*35786f68SRobert Mustacchi * DESCRIPTION: Multiply two 64-bit values, with checking for 64-bit overflow as
527*35786f68SRobert Mustacchi * well as 32-bit overflow if necessary (if the current global
528*35786f68SRobert Mustacchi * integer width is 32).
529*35786f68SRobert Mustacchi *
530*35786f68SRobert Mustacchi ******************************************************************************/
531*35786f68SRobert Mustacchi
532*35786f68SRobert Mustacchi static ACPI_STATUS
AcpiUtStrtoulMultiply64(UINT64 Multiplicand,UINT32 Base,UINT64 * OutProduct)533*35786f68SRobert Mustacchi AcpiUtStrtoulMultiply64 (
534*35786f68SRobert Mustacchi UINT64 Multiplicand,
535*35786f68SRobert Mustacchi UINT32 Base,
536*35786f68SRobert Mustacchi UINT64 *OutProduct)
537*35786f68SRobert Mustacchi {
538*35786f68SRobert Mustacchi UINT64 Product;
539*35786f68SRobert Mustacchi UINT64 Quotient;
540*35786f68SRobert Mustacchi
541*35786f68SRobert Mustacchi
542*35786f68SRobert Mustacchi /* Exit if either operand is zero */
543*35786f68SRobert Mustacchi
544*35786f68SRobert Mustacchi *OutProduct = 0;
545*35786f68SRobert Mustacchi if (!Multiplicand || !Base)
546*35786f68SRobert Mustacchi {
547*35786f68SRobert Mustacchi return (AE_OK);
548*35786f68SRobert Mustacchi }
549*35786f68SRobert Mustacchi
550*35786f68SRobert Mustacchi /*
551*35786f68SRobert Mustacchi * Check for 64-bit overflow before the actual multiplication.
552*35786f68SRobert Mustacchi *
553*35786f68SRobert Mustacchi * Notes: 64-bit division is often not supported on 32-bit platforms
554*35786f68SRobert Mustacchi * (it requires a library function), Therefore ACPICA has a local
555*35786f68SRobert Mustacchi * 64-bit divide function. Also, Multiplier is currently only used
556*35786f68SRobert Mustacchi * as the radix (8/10/16), to the 64/32 divide will always work.
557*35786f68SRobert Mustacchi */
558*35786f68SRobert Mustacchi AcpiUtShortDivide (ACPI_UINT64_MAX, Base, &Quotient, NULL);
559*35786f68SRobert Mustacchi if (Multiplicand > Quotient)
560*35786f68SRobert Mustacchi {
561*35786f68SRobert Mustacchi return (AE_NUMERIC_OVERFLOW);
562*35786f68SRobert Mustacchi }
563*35786f68SRobert Mustacchi
564*35786f68SRobert Mustacchi Product = Multiplicand * Base;
565*35786f68SRobert Mustacchi
566*35786f68SRobert Mustacchi /* Check for 32-bit overflow if necessary */
567*35786f68SRobert Mustacchi
568*35786f68SRobert Mustacchi if ((AcpiGbl_IntegerBitWidth == 32) && (Product > ACPI_UINT32_MAX))
569*35786f68SRobert Mustacchi {
570*35786f68SRobert Mustacchi return (AE_NUMERIC_OVERFLOW);
571*35786f68SRobert Mustacchi }
572*35786f68SRobert Mustacchi
573*35786f68SRobert Mustacchi *OutProduct = Product;
574*35786f68SRobert Mustacchi return (AE_OK);
575*35786f68SRobert Mustacchi }
576*35786f68SRobert Mustacchi
577*35786f68SRobert Mustacchi
578*35786f68SRobert Mustacchi /*******************************************************************************
579*35786f68SRobert Mustacchi *
580*35786f68SRobert Mustacchi * FUNCTION: AcpiUtStrtoulAdd64
581*35786f68SRobert Mustacchi *
582*35786f68SRobert Mustacchi * PARAMETERS: Addend1 - Current accumulated converted integer
583*35786f68SRobert Mustacchi * Digit - New hex value/char
584*35786f68SRobert Mustacchi * OutSum - Where sum is returned (Accumulator)
585*35786f68SRobert Mustacchi *
586*35786f68SRobert Mustacchi * RETURN: Status and 64-bit sum
587*35786f68SRobert Mustacchi *
588*35786f68SRobert Mustacchi * DESCRIPTION: Add two 64-bit values, with checking for 64-bit overflow as
589*35786f68SRobert Mustacchi * well as 32-bit overflow if necessary (if the current global
590*35786f68SRobert Mustacchi * integer width is 32).
591*35786f68SRobert Mustacchi *
592*35786f68SRobert Mustacchi ******************************************************************************/
593*35786f68SRobert Mustacchi
594*35786f68SRobert Mustacchi static ACPI_STATUS
AcpiUtStrtoulAdd64(UINT64 Addend1,UINT32 Digit,UINT64 * OutSum)595*35786f68SRobert Mustacchi AcpiUtStrtoulAdd64 (
596*35786f68SRobert Mustacchi UINT64 Addend1,
597*35786f68SRobert Mustacchi UINT32 Digit,
598*35786f68SRobert Mustacchi UINT64 *OutSum)
599*35786f68SRobert Mustacchi {
600*35786f68SRobert Mustacchi UINT64 Sum;
601*35786f68SRobert Mustacchi
602*35786f68SRobert Mustacchi
603*35786f68SRobert Mustacchi /* Check for 64-bit overflow before the actual addition */
604*35786f68SRobert Mustacchi
605*35786f68SRobert Mustacchi if ((Addend1 > 0) && (Digit > (ACPI_UINT64_MAX - Addend1)))
606*35786f68SRobert Mustacchi {
607*35786f68SRobert Mustacchi return (AE_NUMERIC_OVERFLOW);
608*35786f68SRobert Mustacchi }
609*35786f68SRobert Mustacchi
610*35786f68SRobert Mustacchi Sum = Addend1 + Digit;
611*35786f68SRobert Mustacchi
612*35786f68SRobert Mustacchi /* Check for 32-bit overflow if necessary */
613*35786f68SRobert Mustacchi
614*35786f68SRobert Mustacchi if ((AcpiGbl_IntegerBitWidth == 32) && (Sum > ACPI_UINT32_MAX))
615*35786f68SRobert Mustacchi {
616*35786f68SRobert Mustacchi return (AE_NUMERIC_OVERFLOW);
617*35786f68SRobert Mustacchi }
618*35786f68SRobert Mustacchi
619*35786f68SRobert Mustacchi *OutSum = Sum;
620*35786f68SRobert Mustacchi return (AE_OK);
621*35786f68SRobert Mustacchi }
622