X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fvsprintf.h;h=532ef3650bd2cfa023649c6d10d94e9611e93a40;hb=859703251251d9567f29ab10c0a29f98eb0aff5c;hp=b5bc9c1d95fab6c09d6cf637202b10ae57e9f85f;hpb=3c9cc70d7153da442575112d9a2643eecd17d534;p=platform%2Fkernel%2Fu-boot.git diff --git a/include/vsprintf.h b/include/vsprintf.h index b5bc9c1..532ef36 100644 --- a/include/vsprintf.h +++ b/include/vsprintf.h @@ -1,21 +1,68 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ /* * (C) Copyright 2000-2009 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. - * - * SPDX-License-Identifier: GPL-2.0+ */ #ifndef __VSPRINTF_H #define __VSPRINTF_H +#include +#include + +/** + * simple_strtoul - convert a string to an unsigned long + * + * @param cp The string to be converted + * @param endp Updated to point to the first character not converted + * @param base The number base to use (0 for the default) + * Return: value decoded from string (0 if invalid) + * + * Converts a string to an unsigned long. If there are invalid characters at + * the end these are ignored. In the worst case, if all characters are invalid, + * 0 is returned + * + * A hex prefix is supported (e.g. 0x123) regardless of the value of @base. + * If found, the base is set to hex (16). + * + * If @base is 0: + * - an octal '0' prefix (e.g. 0777) sets the base to octal (8). + * - otherwise the base defaults to decimal (10). + */ ulong simple_strtoul(const char *cp, char **endp, unsigned int base); /** + * hex_strtoul - convert a string in hex to an unsigned long + * + * @param cp The string to be converted + * @param endp Updated to point to the first character not converted + * Return: value decoded from string (0 if invalid) + * + * Converts a hex string to an unsigned long. If there are invalid characters at + * the end these are ignored. In the worst case, if all characters are invalid, + * 0 is returned + */ +unsigned long hextoul(const char *cp, char **endp); + +/** + * dec_strtoul - convert a string in decimal to an unsigned long + * + * @param cp The string to be converted + * @param endp Updated to point to the first character not converted + * Return: value decoded from string (0 if invalid) + * + * Converts a decimal string to an unsigned long. If there are invalid + * characters at the end these are ignored. In the worst case, if all characters + * are invalid, 0 is returned + */ +unsigned long dectoul(const char *cp, char **endp); + +/** * strict_strtoul - convert a string to an unsigned long strictly * @param cp The string to be converted - * @param base The number base to use + * @param base The number base to use (0 for the default) * @param res The converted result value - * @return 0 if conversion is successful and *res is set to the converted + * Return: 0 if conversion is successful and *res is set to the converted * value, otherwise it returns -EINVAL and *res is set to 0. * * strict_strtoul converts a string to an unsigned long only if the @@ -28,8 +75,12 @@ ulong simple_strtoul(const char *cp, char **endp, unsigned int base); * * echo will append a newline to the tail. * - * simple_strtoul just ignores the successive invalid characters and - * return the converted value of prefix part of the string. + * A hex prefix is supported (e.g. 0x123) regardless of the value of @base. + * If found, the base is set to hex (16). + * + * If @base is 0: + * - an octal '0' prefix (e.g. 0777) sets the base to octal (8). + * - otherwise the base defaults to decimal (10). * * Copied this function from Linux 2.6.38 commit ID: * 521cb40b0c44418a4fd36dc633f575813d59a43d @@ -39,6 +90,7 @@ int strict_strtoul(const char *cp, unsigned int base, unsigned long *res); unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base); long simple_strtol(const char *cp, char **endp, unsigned int base); +long long simple_strtoll(const char *cp, char **endp, unsigned int base); /** * trailing_strtol() - extract a trailing integer from a string @@ -47,7 +99,7 @@ long simple_strtol(const char *cp, char **endp, unsigned int base); * For example, "abc123" would return 123. * * @str: String to exxamine - * @return training number if found, else -1 + * Return: training number if found, else -1 */ long trailing_strtol(const char *str); @@ -62,7 +114,7 @@ long trailing_strtol(const char *str); * @str: String to exxamine * @end: Pointer to end of string to examine, or NULL to use the * whole string - * @return training number if found, else -1 + * Return: training number if found, else -1 */ long trailing_strtoln(const char *str, const char *end); @@ -70,7 +122,7 @@ long trailing_strtoln(const char *str, const char *end); * panic() - Print a message and reset/hang * * Prints a message on the console(s) and then resets. If CONFIG_PANIC_HANG is - * defined, then it will hang instead of reseting. + * defined, then it will hang instead of resetting. * * @param fmt: printf() format string for message, which should not include * \n, followed by arguments @@ -82,7 +134,7 @@ void panic(const char *fmt, ...) * panic_str() - Print a message and reset/hang * * Prints a message on the console(s) and then resets. If CONFIG_PANIC_HANG is - * defined, then it will hang instead of reseting. + * defined, then it will hang instead of resetting. * * This function can be used instead of panic() when your board does not * already use printf(), * to keep code size small. @@ -110,21 +162,41 @@ int sprintf(char *buf, const char *fmt, ...) * Format a string and place it in a buffer (va_list version) * * @param buf The buffer to place the result into - * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param args Arguments for the format string - * @return the number of characters which have been written into - * the @buf not including the trailing '\0'. If @size is == 0 the function - * returns 0. + * Return: the number of characters which have been written into + * the @buf not including the trailing '\0'. * * If you're not already dealing with a va_list consider using scnprintf(). * * See the vsprintf() documentation for format string extensions over C99. */ int vsprintf(char *buf, const char *fmt, va_list args); -char *simple_itoa(ulong i); -#ifdef CONFIG_SYS_VSNPRINTF +/** + * simple_itoa() - convert an unsigned integer to a string + * + * This returns a static string containing the decimal representation of the + * given value. The returned value may be overwritten by other calls to other + * simple_... functions, so should be used immediately + * + * @val: Value to convert + * Return: string containing the decimal representation of @val + */ +char *simple_itoa(ulong val); + +/** + * simple_xtoa() - convert an unsigned integer to a hex string + * + * This returns a static string containing the hexadecimal representation of the + * given value. The returned value may be overwritten by other calls to other + * simple_... functions, so should be used immediately + * + * @val: Value to convert + * Return: string containing the hexecimal representation of @val + */ +char *simple_xtoa(ulong num); + /** * Format a string and place it in a buffer * @@ -132,7 +204,7 @@ char *simple_itoa(ulong i); * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param ... Arguments for the format string - * @return the number of characters which would be + * Return: the number of characters which would be * generated for the given input, excluding the trailing null, * as per ISO C99. If the return is greater than or equal to * @size, the resulting string is truncated. @@ -165,7 +237,7 @@ int scnprintf(char *buf, size_t size, const char *fmt, ...) * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param args Arguments for the format string - * @return The number characters which would be generated for the given + * Return: The number characters which would be generated for the given * input, excluding the trailing '\0', as per ISO C99. Note that fewer * characters may be written if this number of characters is >= size. * @@ -190,7 +262,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list args); * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param args Arguments for the format string - * @return the number of characters which have been written into + * Return: the number of characters which have been written into * the @buf not including the trailing '\0'. If @size is == 0 the function * returns 0. * @@ -199,17 +271,6 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list args); * See the vsprintf() documentation for format string extensions over C99. */ int vscnprintf(char *buf, size_t size, const char *fmt, va_list args); -#else -/* - * Use macros to silently drop the size parameter. Note that the 'cn' - * versions are the same as the 'n' versions since the functions assume - * there is always enough buffer space when !CONFIG_SYS_VSNPRINTF - */ -#define snprintf(buf, size, fmt, args...) sprintf(buf, fmt, ##args) -#define scnprintf(buf, size, fmt, args...) sprintf(buf, fmt, ##args) -#define vsnprintf(buf, size, fmt, args...) vsprintf(buf, fmt, ##args) -#define vscnprintf(buf, size, fmt, args...) vsprintf(buf, fmt, ##args) -#endif /* CONFIG_SYS_VSNPRINTF */ /** * print_grouped_ull() - print a value with digits grouped by ',' @@ -224,4 +285,42 @@ void print_grouped_ull(unsigned long long int_val, int digits); bool str2off(const char *p, loff_t *num); bool str2long(const char *p, ulong *num); + +/** + * strmhz() - Convert a value to a Hz string + * + * This creates a string indicating the number of MHz of a value. For example, + * 2700000 produces "2.7". + * @buf: Buffer to hold output string, which must be large enough + * @hz: Value to convert + */ +char *strmhz(char *buf, unsigned long hz); + +/** + * str_to_upper() - Convert a string to upper case + * + * This simply uses toupper() on each character of the string. + * + * @in: String to convert (must be large enough to hold the output string) + * @out: Buffer to put converted string + * @len: Number of bytes available in @out (SIZE_MAX for all) + */ +void str_to_upper(const char *in, char *out, size_t len); + +/** + * vsscanf - Unformat a buffer into a list of arguments + * @buf: input buffer + * @fmt: format of buffer + * @args: arguments + */ +int vsscanf(const char *inp, char const *fmt0, va_list ap); + +/** + * sscanf - Unformat a buffer into a list of arguments + * @buf: input buffer + * @fmt: formatting of buffer + * @...: resulting arguments + */ +int sscanf(const char *buf, const char *fmt, ...); + #endif