1 /******************************************************************************
3 * Module Name: utprint - Formatted printing routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
117 #include "accommon.h"
119 #define _COMPONENT ACPI_UTILITIES
120 ACPI_MODULE_NAME ("utprint")
123 #define ACPI_FORMAT_SIGN 0x01
124 #define ACPI_FORMAT_SIGN_PLUS 0x02
125 #define ACPI_FORMAT_SIGN_PLUS_SPACE 0x04
126 #define ACPI_FORMAT_ZERO 0x08
127 #define ACPI_FORMAT_LEFT 0x10
128 #define ACPI_FORMAT_UPPER 0x20
129 #define ACPI_FORMAT_PREFIX 0x40
132 /* Local prototypes */
135 AcpiUtBoundStringLength (
140 AcpiUtBoundStringOutput (
165 static const char AcpiGbl_LowerHexDigits
[] = "0123456789abcdef";
166 static const char AcpiGbl_UpperHexDigits
[] = "0123456789ABCDEF";
169 /*******************************************************************************
171 * FUNCTION: AcpiUtBoundStringLength
173 * PARAMETERS: String - String with boundary
174 * Count - Boundary of the string
176 * RETURN: Length of the string. Less than or equal to Count.
178 * DESCRIPTION: Calculate the length of a string with boundary.
180 ******************************************************************************/
183 AcpiUtBoundStringLength (
190 while (*String
&& Count
)
201 /*******************************************************************************
203 * FUNCTION: AcpiUtBoundStringOutput
205 * PARAMETERS: String - String with boundary
206 * End - Boundary of the string
207 * c - Character to be output to the string
209 * RETURN: Updated position for next valid character
211 * DESCRIPTION: Output a character into a string with boundary check.
213 ******************************************************************************/
216 AcpiUtBoundStringOutput (
232 /*******************************************************************************
234 * FUNCTION: AcpiUtPutNumber
236 * PARAMETERS: String - Buffer to hold reverse-ordered string
237 * Number - Integer to be converted
238 * Base - Base of the integer
239 * Upper - Whether or not using upper cased digits
241 * RETURN: Updated position for next valid character
243 * DESCRIPTION: Convert an integer into a string, note that, the string holds a
244 * reversed ordered number without the trailing zero.
246 ******************************************************************************/
261 Digits
= Upper
? AcpiGbl_UpperHexDigits
: AcpiGbl_LowerHexDigits
;
271 (void) AcpiUtDivide (Number
, Base
, &Number
, &DigitIndex
);
272 *(Pos
++) = Digits
[DigitIndex
];
276 /* *(Pos++) = '0'; */
281 /*******************************************************************************
283 * FUNCTION: AcpiUtScanNumber
285 * PARAMETERS: String - String buffer
286 * NumberPtr - Where the number is returned
288 * RETURN: Updated position for next valid character
290 * DESCRIPTION: Scan a string for a decimal integer.
292 ******************************************************************************/
302 while (ACPI_IS_DIGIT (*String
))
305 Number
+= *(String
++) - '0';
313 /*******************************************************************************
315 * FUNCTION: AcpiUtPrintNumber
317 * PARAMETERS: String - String buffer
318 * Number - The number to be converted
320 * RETURN: Updated position for next valid character
322 * DESCRIPTION: Print a decimal integer into a string.
324 ******************************************************************************/
331 char AsciiString
[20];
336 Pos1
= AcpiUtPutNumber (AsciiString
, Number
, 10, FALSE
);
339 while (Pos1
!= AsciiString
)
341 *(Pos2
++) = *(--Pos1
);
349 /*******************************************************************************
351 * FUNCTION: AcpiUtFormatNumber
353 * PARAMETERS: String - String buffer with boundary
354 * End - Boundary of the string
355 * Number - The number to be converted
356 * Base - Base of the integer
357 * Width - Field width
358 * Precision - Precision of the integer
359 * Type - Special printing flags
361 * RETURN: Updated position for next valid character
363 * DESCRIPTION: Print an integer into a string with any base and any precision.
365 ******************************************************************************/
383 char ReversedString
[66];
386 /* Parameter validation */
388 if (Base
< 2 || Base
> 16)
393 if (Type
& ACPI_FORMAT_LEFT
)
395 Type
&= ~ACPI_FORMAT_ZERO
;
398 NeedPrefix
= ((Type
& ACPI_FORMAT_PREFIX
) && Base
!= 10) ? TRUE
: FALSE
;
399 Upper
= (Type
& ACPI_FORMAT_UPPER
) ? TRUE
: FALSE
;
400 Zero
= (Type
& ACPI_FORMAT_ZERO
) ? '0' : ' ';
402 /* Calculate size according to sign and prefix */
405 if (Type
& ACPI_FORMAT_SIGN
)
407 if ((INT64
) Number
< 0)
410 Number
= - (INT64
) Number
;
413 else if (Type
& ACPI_FORMAT_SIGN_PLUS
)
418 else if (Type
& ACPI_FORMAT_SIGN_PLUS_SPACE
)
433 /* Generate full string in reverse order */
435 Pos
= AcpiUtPutNumber (ReversedString
, Number
, Base
, Upper
);
436 i
= ACPI_PTR_DIFF (Pos
, ReversedString
);
438 /* Printing 100 using %2d gives "100", not "00" */
447 /* Output the string */
449 if (!(Type
& (ACPI_FORMAT_ZERO
| ACPI_FORMAT_LEFT
)))
453 String
= AcpiUtBoundStringOutput (String
, End
, ' ');
458 String
= AcpiUtBoundStringOutput (String
, End
, Sign
);
462 String
= AcpiUtBoundStringOutput (String
, End
, '0');
465 String
= AcpiUtBoundStringOutput (String
, End
,
469 if (!(Type
& ACPI_FORMAT_LEFT
))
473 String
= AcpiUtBoundStringOutput (String
, End
, Zero
);
477 while (i
<= --Precision
)
479 String
= AcpiUtBoundStringOutput (String
, End
, '0');
483 String
= AcpiUtBoundStringOutput (String
, End
,
488 String
= AcpiUtBoundStringOutput (String
, End
, ' ');
495 /*******************************************************************************
497 * FUNCTION: AcpiUtVsnprintf
499 * PARAMETERS: String - String with boundary
500 * Size - Boundary of the string
501 * Format - Standard printf format
502 * Args - Argument list
504 * RETURN: Number of bytes actually written.
506 * DESCRIPTION: Formatted output to a string using argument list pointer.
508 ******************************************************************************/
520 INT32 Precision
= -1;
535 for (; *Format
; ++Format
)
539 Pos
= AcpiUtBoundStringOutput (Pos
, End
, *Format
);
550 Type
|= ACPI_FORMAT_PREFIX
;
552 else if (*Format
== '0')
554 Type
|= ACPI_FORMAT_ZERO
;
556 else if (*Format
== '+')
558 Type
|= ACPI_FORMAT_SIGN_PLUS
;
560 else if (*Format
== ' ')
562 Type
|= ACPI_FORMAT_SIGN_PLUS_SPACE
;
564 else if (*Format
== '-')
566 Type
|= ACPI_FORMAT_LEFT
;
577 if (ACPI_IS_DIGIT (*Format
))
579 Format
= AcpiUtScanNumber (Format
, &Number
);
580 Width
= (INT32
) Number
;
582 else if (*Format
== '*')
585 Width
= va_arg (Args
, int);
589 Type
|= ACPI_FORMAT_LEFT
;
593 /* Process precision */
599 if (ACPI_IS_DIGIT(*Format
))
601 Format
= AcpiUtScanNumber (Format
, &Number
);
602 Precision
= (INT32
) Number
;
604 else if (*Format
== '*')
607 Precision
= va_arg (Args
, int);
615 /* Process qualifier */
618 if (*Format
== 'h' || *Format
== 'l' || *Format
== 'L')
623 if (Qualifier
== 'l' && *Format
== 'l')
634 Pos
= AcpiUtBoundStringOutput (Pos
, End
, '%');
639 if (!(Type
& ACPI_FORMAT_LEFT
))
643 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
647 c
= (char) va_arg (Args
, int);
648 Pos
= AcpiUtBoundStringOutput (Pos
, End
, c
);
652 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
658 s
= va_arg (Args
, char *);
663 Length
= AcpiUtBoundStringLength (s
, Precision
);
664 if (!(Type
& ACPI_FORMAT_LEFT
))
666 while (Length
< Width
--)
668 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
671 for (i
= 0; i
< Length
; ++i
)
673 Pos
= AcpiUtBoundStringOutput (Pos
, End
, *s
);
676 while (Length
< Width
--)
678 Pos
= AcpiUtBoundStringOutput (Pos
, End
, ' ');
689 Type
|= ACPI_FORMAT_UPPER
;
699 Type
|= ACPI_FORMAT_SIGN
;
709 Width
= 2 * sizeof (void *);
710 Type
|= ACPI_FORMAT_ZERO
;
713 p
= va_arg (Args
, void *);
714 Pos
= AcpiUtFormatNumber (Pos
, End
,
715 ACPI_TO_INTEGER (p
), 16, Width
, Precision
, Type
);
720 Pos
= AcpiUtBoundStringOutput (Pos
, End
, '%');
723 Pos
= AcpiUtBoundStringOutput (Pos
, End
, *Format
);
732 if (Qualifier
== 'L')
734 Number
= va_arg (Args
, UINT64
);
735 if (Type
& ACPI_FORMAT_SIGN
)
737 Number
= (INT64
) Number
;
740 else if (Qualifier
== 'l')
742 Number
= va_arg (Args
, unsigned long);
743 if (Type
& ACPI_FORMAT_SIGN
)
745 Number
= (INT32
) Number
;
748 else if (Qualifier
== 'h')
750 Number
= (UINT16
) va_arg (Args
, int);
751 if (Type
& ACPI_FORMAT_SIGN
)
753 Number
= (INT16
) Number
;
758 Number
= va_arg (Args
, unsigned int);
759 if (Type
& ACPI_FORMAT_SIGN
)
761 Number
= (signed int) Number
;
765 Pos
= AcpiUtFormatNumber (Pos
, End
, Number
, Base
,
766 Width
, Precision
, Type
);
781 return (ACPI_PTR_DIFF (Pos
, String
));
785 /*******************************************************************************
787 * FUNCTION: AcpiUtSnprintf
789 * PARAMETERS: String - String with boundary
790 * Size - Boundary of the string
791 * Format, ... - Standard printf format
793 * RETURN: Number of bytes actually written.
795 * DESCRIPTION: Formatted output to a string.
797 ******************************************************************************/
810 va_start (Args
, Format
);
811 Length
= AcpiUtVsnprintf (String
, Size
, Format
, Args
);
818 #ifdef ACPI_APPLICATION
819 /*******************************************************************************
821 * FUNCTION: AcpiUtFileVprintf
823 * PARAMETERS: File - File descriptor
824 * Format - Standard printf format
825 * Args - Argument list
827 * RETURN: Number of bytes actually written.
829 * DESCRIPTION: Formatted output to a file using argument list pointer.
831 ******************************************************************************/
839 ACPI_CPU_FLAGS Flags
;
843 Flags
= AcpiOsAcquireLock (AcpiGbl_PrintLock
);
844 Length
= AcpiUtVsnprintf (AcpiGbl_PrintBuffer
,
845 sizeof (AcpiGbl_PrintBuffer
), Format
, Args
);
847 (void) AcpiOsWriteFile (File
, AcpiGbl_PrintBuffer
, Length
, 1);
848 AcpiOsReleaseLock (AcpiGbl_PrintLock
, Flags
);
854 /*******************************************************************************
856 * FUNCTION: AcpiUtFilePrintf
858 * PARAMETERS: File - File descriptor
859 * Format, ... - Standard printf format
861 * RETURN: Number of bytes actually written.
863 * DESCRIPTION: Formatted output to a file.
865 ******************************************************************************/
877 va_start (Args
, Format
);
878 Length
= AcpiUtFileVprintf (File
, Format
, Args
);