freebsd-dev/sys/contrib/dev/acpica/utclib.c

/******************************************************************************
 *
 * Module Name: cmclib - Local implementation of C library functions
 * $Revision: 46 $
 *
 *****************************************************************************/

/******************************************************************************
 *
 * 1. Copyright Notice
 *
 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
 * All rights reserved.
 *
 * 2. License
 *
 * 2.1. This is your license from Intel Corp. under its intellectual property
 * rights.  You may have additional license terms from the party that provided
 * you this software, covering your right to use that party's intellectual
 * property rights.
 *
 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
 * copy of the source code appearing in this file ("Covered Code") an
 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
 * base code distributed originally by Intel ("Original Intel Code") to copy,
 * make derivatives, distribute, use and display any portion of the Covered
 * Code in any form, with the right to sublicense such rights; and
 *
 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
 * license (with the right to sublicense), under only those claims of Intel
 * patents that are infringed by the Original Intel Code, to make, use, sell,
 * offer to sell, and import the Covered Code and derivative works thereof
 * solely to the minimum extent necessary to exercise the above copyright
 * license, and in no event shall the patent license extend to any additions
 * to or modifications of the Original Intel Code.  No other license or right
 * is granted directly or by implication, estoppel or otherwise;
 *
 * The above copyright and patent license is granted only if the following
 * conditions are met:
 *
 * 3. Conditions
 *
 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification with rights to further distribute source must include
 * the above Copyright Notice, the above License, this list of Conditions,
 * and the following Disclaimer and Export Compliance provision.  In addition,
 * Licensee must cause all Covered Code to which Licensee contributes to
 * contain a file documenting the changes Licensee made to create that Covered
 * Code and the date of any change.  Licensee must include in that file the
 * documentation of any changes made by any predecessor Licensee.  Licensee
 * must include a prominent statement that the modification is derived,
 * directly or indirectly, from Original Intel Code.
 *
 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification without rights to further distribute source must
 * include the following Disclaimer and Export Compliance provision in the
 * documentation and/or other materials provided with distribution.  In
 * addition, Licensee may not authorize further sublicense of source of any
 * portion of the Covered Code, and must include terms to the effect that the
 * license from Licensee to its licensee is limited to the intellectual
 * property embodied in the software Licensee provides to its licensee, and
 * not to intellectual property embodied in modifications its licensee may
 * make.
 *
 * 3.3. Redistribution of Executable. Redistribution in executable form of any
 * substantial portion of the Covered Code or modification must reproduce the
 * above Copyright Notice, and the following Disclaimer and Export Compliance
 * provision in the documentation and/or other materials provided with the
 * distribution.
 *
 * 3.4. Intel retains all right, title, and interest in and to the Original
 * Intel Code.
 *
 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
 * Intel shall be used in advertising or otherwise to promote the sale, use or
 * other dealings in products derived from or relating to the Covered Code
 * without prior written authorization from Intel.
 *
 * 4. Disclaimer and Export Compliance
 *
 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
 * PARTICULAR PURPOSE.
 *
 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
 * LIMITED REMEDY.
 *
 * 4.3. Licensee shall not export, either directly or indirectly, any of this
 * software or system incorporating such software without first obtaining any
 * required license or other approval from the U. S. Department of Commerce or
 * any other agency or department of the United States Government.  In the
 * event Licensee exports any such software from the United States or
 * re-exports any such software from a foreign destination, Licensee shall
 * ensure that the distribution and export/re-export of the software is in
 * compliance with all laws, regulations, orders, or other restrictions of the
 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 * any of its subsidiaries will export/re-export any technical data, process,
 * software, or service, directly or indirectly, to any country for which the
 * United States government or any agency thereof requires an export license,
 * other governmental approval, or letter of assurance, without first obtaining
 * such license, approval or letter.
 *
 *****************************************************************************/


#define __CMCLIB_C__

#include "acpi.h"

/*
 * These implementations of standard C Library routines can optionally be
 * used if a C library is not available.  In general, they are less efficient
 * than an inline or assembly implementation
 */

#define _COMPONENT          ACPI_UTILITIES
        ACPI_MODULE_NAME    ("cmclib")


#ifndef ACPI_USE_SYSTEM_CLIBRARY

/*******************************************************************************
 *
 * FUNCTION:    strlen
 *
 * PARAMETERS:  String              - Null terminated string
 *
 * RETURN:      Length
 *
 * DESCRIPTION: Returns the length of the input string
 *
 ******************************************************************************/


UINT32
AcpiUtStrlen (
    const NATIVE_CHAR       *String)
{
    UINT32                  Length = 0;


    /* Count the string until a null is encountered */

    while (*String)
    {
        Length++;
        String++;
    }

    return (Length);
}


/*******************************************************************************
 *
 * FUNCTION:    strcpy
 *
 * PARAMETERS:  DstString       - Target of the copy
 *              SrcString       - The source string to copy
 *
 * RETURN:      DstString
 *
 * DESCRIPTION: Copy a null terminated string
 *
 ******************************************************************************/

NATIVE_CHAR *
AcpiUtStrcpy (
    NATIVE_CHAR             *DstString,
    const NATIVE_CHAR       *SrcString)
{
    NATIVE_CHAR             *String = DstString;


    /* Move bytes brute force */

    while (*SrcString)
    {
        *String = *SrcString;

        String++;
        SrcString++;
    }

    /* Null terminate */

    *String = 0;
    return (DstString);
}


/*******************************************************************************
 *
 * FUNCTION:    strncpy
 *
 * PARAMETERS:  DstString       - Target of the copy
 *              SrcString       - The source string to copy
 *              Count           - Maximum # of bytes to copy
 *
 * RETURN:      DstString
 *
 * DESCRIPTION: Copy a null terminated string, with a maximum length
 *
 ******************************************************************************/

NATIVE_CHAR *
AcpiUtStrncpy (
    NATIVE_CHAR             *DstString,
    const NATIVE_CHAR       *SrcString,
    NATIVE_UINT             Count)
{
    NATIVE_CHAR             *String = DstString;


    /* Copy the string */

    for (String = DstString;
        Count && (Count--, (*String++ = *SrcString++)); )
    {;}

    /* Pad with nulls if necessary */

    while (Count--)
    {
        *String = 0;
        String++;
    }

    /* Return original pointer */

    return (DstString);
}


/*******************************************************************************
 *
 * FUNCTION:    strcmp
 *
 * PARAMETERS:  String1         - First string
 *              String2         - Second string
 *
 * RETURN:      Index where strings mismatched, or 0 if strings matched
 *
 * DESCRIPTION: Compare two null terminated strings
 *
 ******************************************************************************/

UINT32
AcpiUtStrcmp (
    const NATIVE_CHAR       *String1,
    const NATIVE_CHAR       *String2)
{


    for ( ; (*String1 == *String2); String2++)
    {
        if (!*String1++)
        {
            return (0);
        }
    }

    return ((unsigned char) *String1 - (unsigned char) *String2);
}


/*******************************************************************************
 *
 * FUNCTION:    strncmp
 *
 * PARAMETERS:  String1         - First string
 *              String2         - Second string
 *              Count           - Maximum # of bytes to compare
 *
 * RETURN:      Index where strings mismatched, or 0 if strings matched
 *
 * DESCRIPTION: Compare two null terminated strings, with a maximum length
 *
 ******************************************************************************/

int
AcpiUtStrncmp (
    const NATIVE_CHAR       *String1,
    const NATIVE_CHAR       *String2,
    NATIVE_UINT             Count)
{


    for ( ; Count-- && (*String1 == *String2); String2++)
    {
        if (!*String1++)
        {
            return (0);
        }
    }

    return ((Count == ACPI_INTEGER_MAX) ? 0 : ((unsigned char) *String1 -
        (unsigned char) *String2));
}


/*******************************************************************************
 *
 * FUNCTION:    Strcat
 *
 * PARAMETERS:  DstString       - Target of the copy
 *              SrcString       - The source string to copy
 *
 * RETURN:      DstString
 *
 * DESCRIPTION: Append a null terminated string to a null terminated string
 *
 ******************************************************************************/

NATIVE_CHAR *
AcpiUtStrcat (
    NATIVE_CHAR             *DstString,
    const NATIVE_CHAR       *SrcString)
{
    NATIVE_CHAR             *String;


    /* Find end of the destination string */

    for (String = DstString; *String++; )
    { ; }

    /* Concatenate the string */

    for (--String; (*String++ = *SrcString++); )
    { ; }

    return (DstString);
}


/*******************************************************************************
 *
 * FUNCTION:    strncat
 *
 * PARAMETERS:  DstString       - Target of the copy
 *              SrcString       - The source string to copy
 *              Count           - Maximum # of bytes to copy
 *
 * RETURN:      DstString
 *
 * DESCRIPTION: Append a null terminated string to a null terminated string,
 *              with a maximum count.
 *
 ******************************************************************************/

NATIVE_CHAR *
AcpiUtStrncat (
    NATIVE_CHAR             *DstString,
    const NATIVE_CHAR       *SrcString,
    NATIVE_UINT             Count)
{
    NATIVE_CHAR             *String;


    if (Count)
    {
        /* Find end of the destination string */

        for (String = DstString; *String++; )
        { ; }

        /* Concatenate the string */

        for (--String; (*String++ = *SrcString++) && --Count; )
        { ; }

        /* Null terminate if necessary */

        if (!Count)
        {
            *String = 0;
        }
    }

    return (DstString);
}


/*******************************************************************************
 *
 * FUNCTION:    memcpy
 *
 * PARAMETERS:  Dest        - Target of the copy
 *              Src         - Source buffer to copy
 *              Count       - Number of bytes to copy
 *
 * RETURN:      Dest
 *
 * DESCRIPTION: Copy arbitrary bytes of memory
 *
 ******************************************************************************/

void *
AcpiUtMemcpy (
    void                    *Dest,
    const void              *Src,
    NATIVE_UINT             Count)
{
    NATIVE_CHAR             *New = (NATIVE_CHAR *) Dest;
    NATIVE_CHAR             *Old = (NATIVE_CHAR *) Src;


    while (Count)
    {
        *New = *Old;
        New++;
        Old++;
        Count--;
    }

    return (Dest);
}


/*******************************************************************************
 *
 * FUNCTION:    memset
 *
 * PARAMETERS:  Dest        - Buffer to set
 *              Value       - Value to set each byte of memory
 *              Count       - Number of bytes to set
 *
 * RETURN:      Dest
 *
 * DESCRIPTION: Initialize a buffer to a known value.
 *
 ******************************************************************************/

void *
AcpiUtMemset (
    void                    *Dest,
    NATIVE_UINT             Value,
    NATIVE_UINT             Count)
{
    NATIVE_CHAR             *New = (NATIVE_CHAR *) Dest;


    while (Count)
    {
        *New = (char) Value;
        New++;
        Count--;
    }

    return (Dest);
}


#define NEGATIVE    1
#define POSITIVE    0

const UINT8 _acpi_ctype[257] = {
    _ACPI_CN,            /* 0x0      0.     */
    _ACPI_CN,            /* 0x1      1.     */
    _ACPI_CN,            /* 0x2      2.     */
    _ACPI_CN,            /* 0x3      3.     */
    _ACPI_CN,            /* 0x4      4.     */
    _ACPI_CN,            /* 0x5      5.     */
    _ACPI_CN,            /* 0x6      6.     */
    _ACPI_CN,            /* 0x7      7.     */
    _ACPI_CN,            /* 0x8      8.     */
    _ACPI_CN|_ACPI_SP,   /* 0x9      9.     */
    _ACPI_CN|_ACPI_SP,   /* 0xA     10.     */
    _ACPI_CN|_ACPI_SP,   /* 0xB     11.     */
    _ACPI_CN|_ACPI_SP,   /* 0xC     12.     */
    _ACPI_CN|_ACPI_SP,   /* 0xD     13.     */
    _ACPI_CN,            /* 0xE     14.     */
    _ACPI_CN,            /* 0xF     15.     */
    _ACPI_CN,            /* 0x10    16.     */
    _ACPI_CN,            /* 0x11    17.     */
    _ACPI_CN,            /* 0x12    18.     */
    _ACPI_CN,            /* 0x13    19.     */
    _ACPI_CN,            /* 0x14    20.     */
    _ACPI_CN,            /* 0x15    21.     */
    _ACPI_CN,            /* 0x16    22.     */
    _ACPI_CN,            /* 0x17    23.     */
    _ACPI_CN,            /* 0x18    24.     */
    _ACPI_CN,            /* 0x19    25.     */
    _ACPI_CN,            /* 0x1A    26.     */
    _ACPI_CN,            /* 0x1B    27.     */
    _ACPI_CN,            /* 0x1C    28.     */
    _ACPI_CN,            /* 0x1D    29.     */
    _ACPI_CN,            /* 0x1E    30.     */
    _ACPI_CN,            /* 0x1F    31.     */
    _ACPI_XS|_ACPI_SP,   /* 0x20    32. ' ' */
    _ACPI_PU,            /* 0x21    33. '!' */
    _ACPI_PU,            /* 0x22    34. '"' */
    _ACPI_PU,            /* 0x23    35. '#' */
    _ACPI_PU,            /* 0x24    36. '$' */
    _ACPI_PU,            /* 0x25    37. '%' */
    _ACPI_PU,            /* 0x26    38. '&' */
    _ACPI_PU,            /* 0x27    39. ''' */
    _ACPI_PU,            /* 0x28    40. '(' */
    _ACPI_PU,            /* 0x29    41. ')' */
    _ACPI_PU,            /* 0x2A    42. '*' */
    _ACPI_PU,            /* 0x2B    43. '+' */
    _ACPI_PU,            /* 0x2C    44. ',' */
    _ACPI_PU,            /* 0x2D    45. '-' */
    _ACPI_PU,            /* 0x2E    46. '.' */
    _ACPI_PU,            /* 0x2F    47. '/' */
    _ACPI_XD|_ACPI_DI,   /* 0x30    48. '0' */
    _ACPI_XD|_ACPI_DI,   /* 0x31    49. '1' */
    _ACPI_XD|_ACPI_DI,   /* 0x32    50. '2' */
    _ACPI_XD|_ACPI_DI,   /* 0x33    51. '3' */
    _ACPI_XD|_ACPI_DI,   /* 0x34    52. '4' */
    _ACPI_XD|_ACPI_DI,   /* 0x35    53. '5' */
    _ACPI_XD|_ACPI_DI,   /* 0x36    54. '6' */
    _ACPI_XD|_ACPI_DI,   /* 0x37    55. '7' */
    _ACPI_XD|_ACPI_DI,   /* 0x38    56. '8' */
    _ACPI_XD|_ACPI_DI,   /* 0x39    57. '9' */
    _ACPI_PU,            /* 0x3A    58. ':' */
    _ACPI_PU,            /* 0x3B    59. ';' */
    _ACPI_PU,            /* 0x3C    60. '<' */
    _ACPI_PU,            /* 0x3D    61. '=' */
    _ACPI_PU,            /* 0x3E    62. '>' */
    _ACPI_PU,            /* 0x3F    63. '?' */
    _ACPI_PU,            /* 0x40    64. '@' */
    _ACPI_XD|_ACPI_UP,   /* 0x41    65. 'A' */
    _ACPI_XD|_ACPI_UP,   /* 0x42    66. 'B' */
    _ACPI_XD|_ACPI_UP,   /* 0x43    67. 'C' */
    _ACPI_XD|_ACPI_UP,   /* 0x44    68. 'D' */
    _ACPI_XD|_ACPI_UP,   /* 0x45    69. 'E' */
    _ACPI_XD|_ACPI_UP,   /* 0x46    70. 'F' */
    _ACPI_UP,            /* 0x47    71. 'G' */
    _ACPI_UP,            /* 0x48    72. 'H' */
    _ACPI_UP,            /* 0x49    73. 'I' */
    _ACPI_UP,            /* 0x4A    74. 'J' */
    _ACPI_UP,            /* 0x4B    75. 'K' */
    _ACPI_UP,            /* 0x4C    76. 'L' */
    _ACPI_UP,            /* 0x4D    77. 'M' */
    _ACPI_UP,            /* 0x4E    78. 'N' */
    _ACPI_UP,            /* 0x4F    79. 'O' */
    _ACPI_UP,            /* 0x50    80. 'P' */
    _ACPI_UP,            /* 0x51    81. 'Q' */
    _ACPI_UP,            /* 0x52    82. 'R' */
    _ACPI_UP,            /* 0x53    83. 'S' */
    _ACPI_UP,            /* 0x54    84. 'T' */
    _ACPI_UP,            /* 0x55    85. 'U' */
    _ACPI_UP,            /* 0x56    86. 'V' */
    _ACPI_UP,            /* 0x57    87. 'W' */
    _ACPI_UP,            /* 0x58    88. 'X' */
    _ACPI_UP,            /* 0x59    89. 'Y' */
    _ACPI_UP,            /* 0x5A    90. 'Z' */
    _ACPI_PU,            /* 0x5B    91. '[' */
    _ACPI_PU,            /* 0x5C    92. '\' */
    _ACPI_PU,            /* 0x5D    93. ']' */
    _ACPI_PU,            /* 0x5E    94. '^' */
    _ACPI_PU,            /* 0x5F    95. '_' */
    _ACPI_PU,            /* 0x60    96. '`' */
    _ACPI_XD|_ACPI_LO,   /* 0x61    97. 'a' */
    _ACPI_XD|_ACPI_LO,   /* 0x62    98. 'b' */
    _ACPI_XD|_ACPI_LO,   /* 0x63    99. 'c' */
    _ACPI_XD|_ACPI_LO,   /* 0x64   100. 'd' */
    _ACPI_XD|_ACPI_LO,   /* 0x65   101. 'e' */
    _ACPI_XD|_ACPI_LO,   /* 0x66   102. 'f' */
    _ACPI_LO,            /* 0x67   103. 'g' */
    _ACPI_LO,            /* 0x68   104. 'h' */
    _ACPI_LO,            /* 0x69   105. 'i' */
    _ACPI_LO,            /* 0x6A   106. 'j' */
    _ACPI_LO,            /* 0x6B   107. 'k' */
    _ACPI_LO,            /* 0x6C   108. 'l' */
    _ACPI_LO,            /* 0x6D   109. 'm' */
    _ACPI_LO,            /* 0x6E   110. 'n' */
    _ACPI_LO,            /* 0x6F   111. 'o' */
    _ACPI_LO,            /* 0x70   112. 'p' */
    _ACPI_LO,            /* 0x71   113. 'q' */
    _ACPI_LO,            /* 0x72   114. 'r' */
    _ACPI_LO,            /* 0x73   115. 's' */
    _ACPI_LO,            /* 0x74   116. 't' */
    _ACPI_LO,            /* 0x75   117. 'u' */
    _ACPI_LO,            /* 0x76   118. 'v' */
    _ACPI_LO,            /* 0x77   119. 'w' */
    _ACPI_LO,            /* 0x78   120. 'x' */
    _ACPI_LO,            /* 0x79   121. 'y' */
    _ACPI_LO,            /* 0x7A   122. 'z' */
    _ACPI_PU,            /* 0x7B   123. '{' */
    _ACPI_PU,            /* 0x7C   124. '|' */
    _ACPI_PU,            /* 0x7D   125. '}' */
    _ACPI_PU,            /* 0x7E   126. '~' */
    _ACPI_CN,            /* 0x7F   127.     */

    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  /* 0x80 to 0x8F    */
    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  /* 0x90 to 0x9F    */
    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  /* 0xA0 to 0xAF    */
    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  /* 0xB0 to 0xBF    */
    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  /* 0xC0 to 0xCF    */
    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  /* 0xD0 to 0xDF    */
    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  /* 0xE0 to 0xEF    */
    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 /* 0xF0 to 0x100   */
};

#define IS_UPPER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
#define IS_LOWER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
#define IS_DIGIT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
#define IS_SPACE(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
#define IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))


/*******************************************************************************
 *
 * FUNCTION:    AcpiUtToUpper
 *
 * PARAMETERS:
 *
 * RETURN:
 *
 * DESCRIPTION: Convert character to uppercase
 *
 ******************************************************************************/

int
AcpiUtToUpper (
    int                     c)
{

    return (IS_LOWER(c) ? ((c)-0x20) : (c));
}


/*******************************************************************************
 *
 * FUNCTION:    AcpiUtToLower
 *
 * PARAMETERS:
 *
 * RETURN:
 *
 * DESCRIPTION: Convert character to lowercase
 *
 ******************************************************************************/

int
AcpiUtToLower (
    int                     c)
{

    return (IS_UPPER(c) ? ((c)+0x20) : (c));
}


/*******************************************************************************
 *
 * FUNCTION:    strstr
 *
 * PARAMETERS:  String1       -
 *              String2
 *
 * RETURN:
 *
 * DESCRIPTION: Checks if String2 occurs in String1. This is not really a
 *              full implementation of strstr, only sufficient for command
 *              matching
 *
 ******************************************************************************/

NATIVE_CHAR *
AcpiUtStrstr (
    NATIVE_CHAR             *String1,
    NATIVE_CHAR             *String2)
{
    NATIVE_CHAR             *String;


    if (AcpiUtStrlen (String2) > AcpiUtStrlen (String1))
    {
        return (NULL);
    }

    /* Walk entire string, comparing the letters */

    for (String = String1; *String2; )
    {
        if (*String2 != *String)
        {
            return (NULL);
        }

        String2++;
        String++;
    }

    return (String1);
}


/*******************************************************************************
 *
 * FUNCTION:    strtoul
 *
 * PARAMETERS:  String          - Null terminated string
 *              Terminater      - Where a pointer to the terminating byte is returned
 *              Base            - Radix of the string
 *
 * RETURN:      Converted value
 *
 * DESCRIPTION: Convert a string into an unsigned value.
 *
 ******************************************************************************/

UINT32
AcpiUtStrtoul (
    const NATIVE_CHAR       *String,
    NATIVE_CHAR             **Terminator,
    UINT32                  Base)
{
    UINT32                  converted = 0;
    UINT32                  index;
    UINT32                  sign;
    const NATIVE_CHAR       *StringStart;
    UINT32                  ReturnValue = 0;
    ACPI_STATUS             Status = AE_OK;


    /*
     * Save the value of the pointer to the buffer's first
     * character, save the current errno value, and then
     * skip over any white space in the buffer:
     */
    StringStart = String;
    while (IS_SPACE (*String) || *String == '\t')
    {
        ++String;
    }

    /*
     * The buffer may contain an optional plus or minus sign.
     * If it does, then skip over it but remember what is was:
     */
    if (*String == '-')
    {
        sign = NEGATIVE;
        ++String;
    }
    else if (*String == '+')
    {
        ++String;
        sign = POSITIVE;
    }
    else
    {
        sign = POSITIVE;
    }

    /*
     * If the input parameter Base is zero, then we need to
     * determine if it is octal, decimal, or hexadecimal:
     */
    if (Base == 0)
    {
        if (*String == '0')
        {
            if (AcpiUtToLower (*(++String)) == 'x')
            {
                Base = 16;
                ++String;
            }
            else
            {
                Base = 8;
            }
        }
        else
        {
            Base = 10;
        }
    }
    else if (Base < 2 || Base > 36)
    {
        /*
         * The specified Base parameter is not in the domain of
         * this function:
         */
        goto done;
    }

    /*
     * For octal and hexadecimal bases, skip over the leading
     * 0 or 0x, if they are present.
     */
    if (Base == 8 && *String == '0')
    {
        String++;
    }

    if (Base == 16 &&
        *String == '0' &&
        AcpiUtToLower (*(++String)) == 'x')
    {
        String++;
    }


    /*
     * Main loop: convert the string to an unsigned long:
     */
    while (*String)
    {
        if (IS_DIGIT (*String))
        {
            index = (UINT32) ((UINT8) *String - '0');
        }
        else
        {
            index = (UINT32) AcpiUtToUpper (*String);
            if (IS_UPPER (index))
            {
                index = index - 'A' + 10;
            }
            else
            {
                goto done;
            }
        }

        if (index >= Base)
        {
            goto done;
        }

        /*
         * Check to see if value is out of range:
         */

        if (ReturnValue > ((ACPI_UINT32_MAX - (UINT32) index) /
                            (UINT32) Base))
        {
            Status = AE_ERROR;
            ReturnValue = 0L;           /* reset */
        }
        else
        {
            ReturnValue *= Base;
            ReturnValue += index;
            converted = 1;
        }

        ++String;
    }

done:
    /*
     * If appropriate, update the caller's pointer to the next
     * unconverted character in the buffer.
     */
    if (Terminator)
    {
        if (converted == 0 && ReturnValue == 0L && String != NULL)
        {
            *Terminator = (NATIVE_CHAR *) StringStart;
        }
        else
        {
            *Terminator = (NATIVE_CHAR *) String;
        }
    }

    if (Status == AE_ERROR)
    {
        ReturnValue = ACPI_UINT32_MAX;
    }

    /*
     * If a minus sign was present, then "the conversion is negated":
     */
    if (sign == NEGATIVE)
    {
        ReturnValue = (ACPI_UINT32_MAX - ReturnValue) + 1;
    }

    return (ReturnValue);
}

#endif /* ACPI_USE_SYSTEM_CLIBRARY */