xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acclib.h (revision 35786f68)
1 /******************************************************************************
2  *
3  * Name: acclib.h -- C library support. Prototypes for the (optional) local
4  *                   implementations of required C library functions.
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights. You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code. No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision. In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change. Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee. Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution. In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government. In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************
116  *
117  * Alternatively, you may choose to be licensed under the terms of the
118  * following license:
119  *
120  * Redistribution and use in source and binary forms, with or without
121  * modification, are permitted provided that the following conditions
122  * are met:
123  * 1. Redistributions of source code must retain the above copyright
124  *    notice, this list of conditions, and the following disclaimer,
125  *    without modification.
126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127  *    substantially similar to the "NO WARRANTY" disclaimer below
128  *    ("Disclaimer") and any redistribution must be conditioned upon
129  *    including a substantially similar Disclaimer requirement for further
130  *    binary redistribution.
131  * 3. Neither the names of the above-listed copyright holders nor the names
132  *    of any contributors may be used to endorse or promote products derived
133  *    from this software without specific prior written permission.
134  *
135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146  *
147  * Alternatively, you may choose to be licensed under the terms of the
148  * GNU General Public License ("GPL") version 2 as published by the Free
149  * Software Foundation.
150  *
151  *****************************************************************************/
152 
153 #ifndef _ACCLIB_H
154 #define _ACCLIB_H
155 
156 
157 /*
158  * Prototypes and macros for local implementations of C library functions
159  */
160 
161 /* is* functions. The AcpiGbl_Ctypes array is defined in utclib.c */
162 
163 extern const UINT8 AcpiGbl_Ctypes[];
164 
165 #define _ACPI_XA     0x00    /* extra alphabetic - not supported */
166 #define _ACPI_XS     0x40    /* extra space */
167 #define _ACPI_BB     0x00    /* BEL, BS, etc. - not supported */
168 #define _ACPI_CN     0x20    /* CR, FF, HT, NL, VT */
169 #define _ACPI_DI     0x04    /* '0'-'9' */
170 #define _ACPI_LO     0x02    /* 'a'-'z' */
171 #define _ACPI_PU     0x10    /* punctuation */
172 #define _ACPI_SP     0x08    /* space, tab, CR, LF, VT, FF */
173 #define _ACPI_UP     0x01    /* 'A'-'Z' */
174 #define _ACPI_XD     0x80    /* '0'-'9', 'A'-'F', 'a'-'f' */
175 
176 #define isdigit(c)  (AcpiGbl_Ctypes[(unsigned char)(c)] & (_ACPI_DI))
177 #define isspace(c)  (AcpiGbl_Ctypes[(unsigned char)(c)] & (_ACPI_SP))
178 #define isxdigit(c) (AcpiGbl_Ctypes[(unsigned char)(c)] & (_ACPI_XD))
179 #define isupper(c)  (AcpiGbl_Ctypes[(unsigned char)(c)] & (_ACPI_UP))
180 #define islower(c)  (AcpiGbl_Ctypes[(unsigned char)(c)] & (_ACPI_LO))
181 #define isprint(c)  (AcpiGbl_Ctypes[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_XS | _ACPI_PU))
182 #define isalpha(c)  (AcpiGbl_Ctypes[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
183 
184 /* Error code */
185 
186 #define EPERM            1 /* Operation not permitted */
187 #define ENOENT           2 /* No such file or directory */
188 #define EINTR            4 /* Interrupted system call */
189 #define EIO              5 /* I/O error */
190 #define EBADF            9 /* Bad file number */
191 #define EAGAIN          11 /* Try again */
192 #define ENOMEM          12 /* Out of memory */
193 #define EACCES          13 /* Permission denied */
194 #define EFAULT          14 /* Bad address */
195 #define EBUSY           16 /* Device or resource busy */
196 #define EEXIST          17 /* File exists */
197 #define ENODEV          19 /* No such device */
198 #define EINVAL          22 /* Invalid argument */
199 #define EPIPE           32 /* Broken pipe */
200 #define ERANGE          34 /* Math result not representable */
201 
202 /* Strings */
203 
204 char *
205 strcat (
206     char                    *DstString,
207     const char              *SrcString);
208 
209 char *
210 strchr (
211     const char              *String,
212     int                     ch);
213 
214 char *
215 strpbrk (
216     const char              *String,
217     const char              *Delimiters);
218 
219 char *
220 strtok (
221     char                    *String,
222     const char              *Delimiters);
223 
224 char *
225 strcpy (
226     char                    *DstString,
227     const char              *SrcString);
228 
229 int
230 strcmp (
231     const char              *String1,
232     const char              *String2);
233 
234 ACPI_SIZE
235 strlen (
236     const char              *String);
237 
238 char *
239 strncat (
240     char                    *DstString,
241     const char              *SrcString,
242     ACPI_SIZE               Count);
243 
244 int
245 strncmp (
246     const char              *String1,
247     const char              *String2,
248     ACPI_SIZE               Count);
249 
250 char *
251 strncpy (
252     char                    *DstString,
253     const char              *SrcString,
254     ACPI_SIZE               Count);
255 
256 char *
257 strstr (
258     char                    *String1,
259     char                    *String2);
260 
261 
262 /* Conversion */
263 
264 UINT32
265 strtoul (
266     const char              *String,
267     char                    **Terminator,
268     UINT32                  Base);
269 
270 
271 /* Memory */
272 
273 int
274 memcmp (
275     void                    *Buffer1,
276     void                    *Buffer2,
277     ACPI_SIZE               Count);
278 
279 void *
280 memcpy (
281     void                    *Dest,
282     const void              *Src,
283     ACPI_SIZE               Count);
284 
285 void *
286 memmove (
287     void                    *Dest,
288     const void              *Src,
289     ACPI_SIZE               Count);
290 
291 void *
292 memset (
293     void                    *Dest,
294     int                     Value,
295     ACPI_SIZE               Count);
296 
297 
298 /* upper/lower case */
299 
300 int
301 tolower (
302     int                     c);
303 
304 int
305 toupper (
306     int                     c);
307 
308 /*
309  * utprint - printf/vprintf output functions
310  */
311 const char *
312 AcpiUtScanNumber (
313     const char              *String,
314     UINT64                  *NumberPtr);
315 
316 const char *
317 AcpiUtPrintNumber (
318     char                    *String,
319     UINT64                  Number);
320 
321 int
322 vsnprintf (
323     char                    *String,
324     ACPI_SIZE               Size,
325     const char              *Format,
326     va_list                 Args);
327 
328 int
329 snprintf (
330     char                    *String,
331     ACPI_SIZE               Size,
332     const char              *Format,
333     ...);
334 
335 int
336 sprintf (
337     char                    *String,
338     const char              *Format,
339     ...);
340 
341 #ifdef ACPI_APPLICATION
342 #define SEEK_SET            0
343 #define SEEK_CUR            1
344 #define SEEK_END            2
345 
346 /*
347  * NOTE: Currently we only need to update errno for file IOs. Other
348  *       Clibrary invocations in ACPICA do not make descisions according to
349  *       the errno.
350  */
351 extern int errno;
352 
353 #ifndef EOF
354 #define EOF                 (-1)
355 #endif
356 
357 #define putchar(c)          fputc(stdout, c)
358 #define getchar(c)          fgetc(stdin)
359 
360 int
361 vprintf (
362     const char              *Format,
363     va_list                 Args);
364 
365 int
366 printf (
367     const char              *Format,
368     ...);
369 
370 int
371 vfprintf (
372     FILE                    *File,
373     const char              *Format,
374     va_list                 Args);
375 
376 int
377 fprintf (
378     FILE                    *File,
379     const char              *Format,
380     ...);
381 
382 FILE *
383 fopen (
384     const char              *Path,
385     const char              *Modes);
386 
387 void
388 fclose (
389     FILE                    *File);
390 
391 int
392 fread (
393     void                    *Buffer,
394     ACPI_SIZE               Size,
395     ACPI_SIZE               Count,
396     FILE                    *File);
397 
398 int
399 fwrite (
400     void                    *Buffer,
401     ACPI_SIZE               Size,
402     ACPI_SIZE               Count,
403     FILE                    *File);
404 
405 int
406 fseek (
407     FILE                    *File,
408     long                    Offset,
409     int                     From);
410 
411 long
412 ftell (
413     FILE                    *File);
414 
415 int
416 fgetc (
417     FILE                    *File);
418 
419 int
420 fputc (
421     FILE                    *File,
422     char                    c);
423 
424 char *
425 fgets (
426     char                    *s,
427     ACPI_SIZE               Size,
428     FILE                    *File);
429 #endif
430 
431 #endif /* _ACCLIB_H */
432