1 /******************************************************************************
3 * Module Name: utclib - ACPICA implementations of C library functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
49 * This module contains implementations of the standard C library functions
50 * that are required by the ACPICA code at both application level and kernel
53 * The module is an optional feature that can be used if a local/system
54 * C library is not available. Some operating system kernels may not have
55 * an internal C library.
57 * In general, these functions are less efficient than an inline or assembly
58 * code implementation.
60 * These C functions and the associated prototypes are enabled by default
61 * unless the ACPI_USE_SYSTEM_CLIBRARY symbol is defined. This is usually
62 * automatically defined for the ACPICA applications such as iASL and
63 * AcpiExec, so that these user-level applications use the local C library
64 * instead of the functions in this module.
67 /*******************************************************************************
69 * Functions implemented in this module:
86 * FUNCTION: is* functions
88 ******************************************************************************/
90 #define _COMPONENT ACPI_UTILITIES
91 ACPI_MODULE_NAME ("utclib")
94 #ifndef ACPI_USE_SYSTEM_CLIBRARY /* Entire module */
97 /*******************************************************************************
101 * PARAMETERS: Buffer1 - First Buffer
102 * Buffer2 - Second Buffer
103 * Count - Maximum # of bytes to compare
105 * RETURN: Index where Buffers mismatched, or 0 if Buffers matched
107 * DESCRIPTION: Compare two Buffers, with a maximum length
109 ******************************************************************************/
117 char *Buffer1
= (char *) VBuffer1
;
118 char *Buffer2
= (char *) VBuffer2
;
121 for ( ; Count
-- && (*Buffer1
== *Buffer2
); Buffer1
++, Buffer2
++)
125 return ((Count
== ACPI_SIZE_MAX
) ? 0 : ((unsigned char) *Buffer1
-
126 (unsigned char) *Buffer2
));
130 /*******************************************************************************
134 * PARAMETERS: Dest - Target of the copy
135 * Src - Source buffer to copy
136 * Count - Number of bytes to copy
140 * DESCRIPTION: Copy arbitrary bytes of memory
142 ******************************************************************************/
150 char *New
= (char *) Dest
;
151 char *Old
= (char *) Src
;
166 /*******************************************************************************
170 * PARAMETERS: Dest - Buffer to set
171 * Value - Value to set each byte of memory
172 * Count - Number of bytes to set
176 * DESCRIPTION: Initialize a buffer to a known value.
178 ******************************************************************************/
186 char *New
= (char *) Dest
;
200 /*******************************************************************************
204 * PARAMETERS: String - Null terminated string
208 * DESCRIPTION: Returns the length of the input string
210 ******************************************************************************/
220 /* Count the string until a null is encountered */
232 /*******************************************************************************
236 * PARAMETERS: DstString - Target of the copy
237 * SrcString - The source string to copy
241 * DESCRIPTION: Copy a null terminated string
243 ******************************************************************************/
248 const char *SrcString
)
250 char *String
= DstString
;
253 /* Move bytes brute force */
257 *String
= *SrcString
;
270 /*******************************************************************************
274 * PARAMETERS: DstString - Target of the copy
275 * SrcString - The source string to copy
276 * Count - Maximum # of bytes to copy
280 * DESCRIPTION: Copy a null terminated string, with a maximum length
282 ******************************************************************************/
287 const char *SrcString
,
290 char *String
= DstString
;
293 /* Copy the string */
295 for (String
= DstString
;
296 Count
&& (Count
--, (*String
++ = *SrcString
++)); )
299 /* Pad with nulls if necessary */
307 /* Return original pointer */
313 /*******************************************************************************
317 * PARAMETERS: String1 - First string
318 * String2 - Second string
320 * RETURN: Index where strings mismatched, or 0 if strings matched
322 * DESCRIPTION: Compare two null terminated strings
324 ******************************************************************************/
333 for ( ; (*String1
== *String2
); String2
++)
341 return ((unsigned char) *String1
- (unsigned char) *String2
);
345 /*******************************************************************************
349 * PARAMETERS: String - Search string
350 * ch - character to search for
352 * RETURN: Ptr to char or NULL if not found
354 * DESCRIPTION: Search a string for a character
356 ******************************************************************************/
365 for ( ; (*String
); String
++)
367 if ((*String
) == (char) ch
)
369 return ((char *) String
);
377 /*******************************************************************************
381 * PARAMETERS: String1 - First string
382 * String2 - Second string
383 * Count - Maximum # of bytes to compare
385 * RETURN: Index where strings mismatched, or 0 if strings matched
387 * DESCRIPTION: Compare two null terminated strings, with a maximum length
389 ******************************************************************************/
399 for ( ; Count
-- && (*String1
== *String2
); String2
++)
407 return ((Count
== ACPI_SIZE_MAX
) ? 0 : ((unsigned char) *String1
-
408 (unsigned char) *String2
));
412 /*******************************************************************************
416 * PARAMETERS: DstString - Target of the copy
417 * SrcString - The source string to copy
421 * DESCRIPTION: Append a null terminated string to a null terminated string
423 ******************************************************************************/
428 const char *SrcString
)
433 /* Find end of the destination string */
435 for (String
= DstString
; *String
++; )
438 /* Concatenate the string */
440 for (--String
; (*String
++ = *SrcString
++); )
447 /*******************************************************************************
451 * PARAMETERS: DstString - Target of the copy
452 * SrcString - The source string to copy
453 * Count - Maximum # of bytes to copy
457 * DESCRIPTION: Append a null terminated string to a null terminated string,
458 * with a maximum count.
460 ******************************************************************************/
465 const char *SrcString
,
473 /* Find end of the destination string */
475 for (String
= DstString
; *String
++; )
478 /* Concatenate the string */
480 for (--String
; (*String
++ = *SrcString
++) && --Count
; )
483 /* Null terminate if necessary */
495 /*******************************************************************************
499 * PARAMETERS: String1 - Target string
500 * String2 - Substring to search for
502 * RETURN: Where substring match starts, Null if no match found
504 * DESCRIPTION: Checks if String2 occurs in String1. This is not really a
505 * full implementation of strstr, only sufficient for command
508 ******************************************************************************/
518 Length
= strlen (String2
);
524 while (strlen (String1
) >= Length
)
526 if (memcmp (String1
, String2
, Length
) == 0)
537 /*******************************************************************************
541 * PARAMETERS: String - Null terminated string
542 * Terminater - Where a pointer to the terminating byte is
544 * Base - Radix of the string
546 * RETURN: Converted value
548 * DESCRIPTION: Convert a string into a 32-bit unsigned value.
549 * Note: use strtoul64 for 64-bit integers.
551 ******************************************************************************/
559 UINT32 converted
= 0;
562 const char *StringStart
;
563 UINT32 ReturnValue
= 0;
564 ACPI_STATUS Status
= AE_OK
;
568 * Save the value of the pointer to the buffer's first
569 * character, save the current errno value, and then
570 * skip over any white space in the buffer:
572 StringStart
= String
;
573 while (isspace (*String
) || *String
== '\t')
579 * The buffer may contain an optional plus or minus sign.
580 * If it does, then skip over it but remember what is was:
584 sign
= ACPI_SIGN_NEGATIVE
;
587 else if (*String
== '+')
590 sign
= ACPI_SIGN_POSITIVE
;
594 sign
= ACPI_SIGN_POSITIVE
;
598 * If the input parameter Base is zero, then we need to
599 * determine if it is octal, decimal, or hexadecimal:
605 if (tolower (*(++String
)) == 'x')
620 else if (Base
< 2 || Base
> 36)
623 * The specified Base parameter is not in the domain of
630 * For octal and hexadecimal bases, skip over the leading
631 * 0 or 0x, if they are present.
633 if (Base
== 8 && *String
== '0')
640 tolower (*(++String
)) == 'x')
646 * Main loop: convert the string to an unsigned long:
650 if (isdigit (*String
))
652 index
= (UINT32
) ((UINT8
) *String
- '0');
656 index
= (UINT32
) toupper (*String
);
659 index
= index
- 'A' + 10;
673 * Check to see if value is out of range:
676 if (ReturnValue
> ((ACPI_UINT32_MAX
- (UINT32
) index
) /
680 ReturnValue
= 0; /* reset */
685 ReturnValue
+= index
;
694 * If appropriate, update the caller's pointer to the next
695 * unconverted character in the buffer.
699 if (converted
== 0 && ReturnValue
== 0 && String
!= NULL
)
701 *Terminator
= (char *) StringStart
;
705 *Terminator
= (char *) String
;
709 if (Status
== AE_ERROR
)
711 ReturnValue
= ACPI_UINT32_MAX
;
715 * If a minus sign was present, then "the conversion is negated":
717 if (sign
== ACPI_SIGN_NEGATIVE
)
719 ReturnValue
= (ACPI_UINT32_MAX
- ReturnValue
) + 1;
722 return (ReturnValue
);
726 /*******************************************************************************
730 * PARAMETERS: c - Character to convert
732 * RETURN: Converted character as an int
734 * DESCRIPTION: Convert character to uppercase
736 ******************************************************************************/
743 return (islower(c
) ? ((c
)-0x20) : (c
));
747 /*******************************************************************************
751 * PARAMETERS: c - Character to convert
753 * RETURN: Converted character as an int
755 * DESCRIPTION: Convert character to lowercase
757 ******************************************************************************/
764 return (isupper(c
) ? ((c
)+0x20) : (c
));
768 /*******************************************************************************
770 * FUNCTION: is* function array
772 * DESCRIPTION: is* functions use the ctype table below
774 ******************************************************************************/
776 const UINT8 AcpiGbl_Ctypes
[257] = {
777 _ACPI_CN
, /* 0x00 0 NUL */
778 _ACPI_CN
, /* 0x01 1 SOH */
779 _ACPI_CN
, /* 0x02 2 STX */
780 _ACPI_CN
, /* 0x03 3 ETX */
781 _ACPI_CN
, /* 0x04 4 EOT */
782 _ACPI_CN
, /* 0x05 5 ENQ */
783 _ACPI_CN
, /* 0x06 6 ACK */
784 _ACPI_CN
, /* 0x07 7 BEL */
785 _ACPI_CN
, /* 0x08 8 BS */
786 _ACPI_CN
|_ACPI_SP
, /* 0x09 9 TAB */
787 _ACPI_CN
|_ACPI_SP
, /* 0x0A 10 LF */
788 _ACPI_CN
|_ACPI_SP
, /* 0x0B 11 VT */
789 _ACPI_CN
|_ACPI_SP
, /* 0x0C 12 FF */
790 _ACPI_CN
|_ACPI_SP
, /* 0x0D 13 CR */
791 _ACPI_CN
, /* 0x0E 14 SO */
792 _ACPI_CN
, /* 0x0F 15 SI */
793 _ACPI_CN
, /* 0x10 16 DLE */
794 _ACPI_CN
, /* 0x11 17 DC1 */
795 _ACPI_CN
, /* 0x12 18 DC2 */
796 _ACPI_CN
, /* 0x13 19 DC3 */
797 _ACPI_CN
, /* 0x14 20 DC4 */
798 _ACPI_CN
, /* 0x15 21 NAK */
799 _ACPI_CN
, /* 0x16 22 SYN */
800 _ACPI_CN
, /* 0x17 23 ETB */
801 _ACPI_CN
, /* 0x18 24 CAN */
802 _ACPI_CN
, /* 0x19 25 EM */
803 _ACPI_CN
, /* 0x1A 26 SUB */
804 _ACPI_CN
, /* 0x1B 27 ESC */
805 _ACPI_CN
, /* 0x1C 28 FS */
806 _ACPI_CN
, /* 0x1D 29 GS */
807 _ACPI_CN
, /* 0x1E 30 RS */
808 _ACPI_CN
, /* 0x1F 31 US */
809 _ACPI_XS
|_ACPI_SP
, /* 0x20 32 ' ' */
810 _ACPI_PU
, /* 0x21 33 '!' */
811 _ACPI_PU
, /* 0x22 34 '"' */
812 _ACPI_PU
, /* 0x23 35 '#' */
813 _ACPI_PU
, /* 0x24 36 '$' */
814 _ACPI_PU
, /* 0x25 37 '%' */
815 _ACPI_PU
, /* 0x26 38 '&' */
816 _ACPI_PU
, /* 0x27 39 ''' */
817 _ACPI_PU
, /* 0x28 40 '(' */
818 _ACPI_PU
, /* 0x29 41 ')' */
819 _ACPI_PU
, /* 0x2A 42 '*' */
820 _ACPI_PU
, /* 0x2B 43 '+' */
821 _ACPI_PU
, /* 0x2C 44 ',' */
822 _ACPI_PU
, /* 0x2D 45 '-' */
823 _ACPI_PU
, /* 0x2E 46 '.' */
824 _ACPI_PU
, /* 0x2F 47 '/' */
825 _ACPI_XD
|_ACPI_DI
, /* 0x30 48 '0' */
826 _ACPI_XD
|_ACPI_DI
, /* 0x31 49 '1' */
827 _ACPI_XD
|_ACPI_DI
, /* 0x32 50 '2' */
828 _ACPI_XD
|_ACPI_DI
, /* 0x33 51 '3' */
829 _ACPI_XD
|_ACPI_DI
, /* 0x34 52 '4' */
830 _ACPI_XD
|_ACPI_DI
, /* 0x35 53 '5' */
831 _ACPI_XD
|_ACPI_DI
, /* 0x36 54 '6' */
832 _ACPI_XD
|_ACPI_DI
, /* 0x37 55 '7' */
833 _ACPI_XD
|_ACPI_DI
, /* 0x38 56 '8' */
834 _ACPI_XD
|_ACPI_DI
, /* 0x39 57 '9' */
835 _ACPI_PU
, /* 0x3A 58 ':' */
836 _ACPI_PU
, /* 0x3B 59 ';' */
837 _ACPI_PU
, /* 0x3C 60 '<' */
838 _ACPI_PU
, /* 0x3D 61 '=' */
839 _ACPI_PU
, /* 0x3E 62 '>' */
840 _ACPI_PU
, /* 0x3F 63 '?' */
841 _ACPI_PU
, /* 0x40 64 '@' */
842 _ACPI_XD
|_ACPI_UP
, /* 0x41 65 'A' */
843 _ACPI_XD
|_ACPI_UP
, /* 0x42 66 'B' */
844 _ACPI_XD
|_ACPI_UP
, /* 0x43 67 'C' */
845 _ACPI_XD
|_ACPI_UP
, /* 0x44 68 'D' */
846 _ACPI_XD
|_ACPI_UP
, /* 0x45 69 'E' */
847 _ACPI_XD
|_ACPI_UP
, /* 0x46 70 'F' */
848 _ACPI_UP
, /* 0x47 71 'G' */
849 _ACPI_UP
, /* 0x48 72 'H' */
850 _ACPI_UP
, /* 0x49 73 'I' */
851 _ACPI_UP
, /* 0x4A 74 'J' */
852 _ACPI_UP
, /* 0x4B 75 'K' */
853 _ACPI_UP
, /* 0x4C 76 'L' */
854 _ACPI_UP
, /* 0x4D 77 'M' */
855 _ACPI_UP
, /* 0x4E 78 'N' */
856 _ACPI_UP
, /* 0x4F 79 'O' */
857 _ACPI_UP
, /* 0x50 80 'P' */
858 _ACPI_UP
, /* 0x51 81 'Q' */
859 _ACPI_UP
, /* 0x52 82 'R' */
860 _ACPI_UP
, /* 0x53 83 'S' */
861 _ACPI_UP
, /* 0x54 84 'T' */
862 _ACPI_UP
, /* 0x55 85 'U' */
863 _ACPI_UP
, /* 0x56 86 'V' */
864 _ACPI_UP
, /* 0x57 87 'W' */
865 _ACPI_UP
, /* 0x58 88 'X' */
866 _ACPI_UP
, /* 0x59 89 'Y' */
867 _ACPI_UP
, /* 0x5A 90 'Z' */
868 _ACPI_PU
, /* 0x5B 91 '[' */
869 _ACPI_PU
, /* 0x5C 92 '\' */
870 _ACPI_PU
, /* 0x5D 93 ']' */
871 _ACPI_PU
, /* 0x5E 94 '^' */
872 _ACPI_PU
, /* 0x5F 95 '_' */
873 _ACPI_PU
, /* 0x60 96 '`' */
874 _ACPI_XD
|_ACPI_LO
, /* 0x61 97 'a' */
875 _ACPI_XD
|_ACPI_LO
, /* 0x62 98 'b' */
876 _ACPI_XD
|_ACPI_LO
, /* 0x63 99 'c' */
877 _ACPI_XD
|_ACPI_LO
, /* 0x64 100 'd' */
878 _ACPI_XD
|_ACPI_LO
, /* 0x65 101 'e' */
879 _ACPI_XD
|_ACPI_LO
, /* 0x66 102 'f' */
880 _ACPI_LO
, /* 0x67 103 'g' */
881 _ACPI_LO
, /* 0x68 104 'h' */
882 _ACPI_LO
, /* 0x69 105 'i' */
883 _ACPI_LO
, /* 0x6A 106 'j' */
884 _ACPI_LO
, /* 0x6B 107 'k' */
885 _ACPI_LO
, /* 0x6C 108 'l' */
886 _ACPI_LO
, /* 0x6D 109 'm' */
887 _ACPI_LO
, /* 0x6E 110 'n' */
888 _ACPI_LO
, /* 0x6F 111 'o' */
889 _ACPI_LO
, /* 0x70 112 'p' */
890 _ACPI_LO
, /* 0x71 113 'q' */
891 _ACPI_LO
, /* 0x72 114 'r' */
892 _ACPI_LO
, /* 0x73 115 's' */
893 _ACPI_LO
, /* 0x74 116 't' */
894 _ACPI_LO
, /* 0x75 117 'u' */
895 _ACPI_LO
, /* 0x76 118 'v' */
896 _ACPI_LO
, /* 0x77 119 'w' */
897 _ACPI_LO
, /* 0x78 120 'x' */
898 _ACPI_LO
, /* 0x79 121 'y' */
899 _ACPI_LO
, /* 0x7A 122 'z' */
900 _ACPI_PU
, /* 0x7B 123 '{' */
901 _ACPI_PU
, /* 0x7C 124 '|' */
902 _ACPI_PU
, /* 0x7D 125 '}' */
903 _ACPI_PU
, /* 0x7E 126 '~' */
904 _ACPI_CN
, /* 0x7F 127 DEL */
906 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x80 to 0x8F */
907 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x90 to 0x9F */
908 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0xA0 to 0xAF */
909 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0xB0 to 0xBF */
910 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0xC0 to 0xCF */
911 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0xD0 to 0xDF */
912 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0xE0 to 0xEF */
913 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0xF0 to 0xFF */
918 #endif /* ACPI_USE_SYSTEM_CLIBRARY */