19785c905SSimon Glass /* 29785c905SSimon Glass * (C) Copyright 2000-2009 39785c905SSimon Glass * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 49785c905SSimon Glass * 51a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 69785c905SSimon Glass */ 79785c905SSimon Glass 89785c905SSimon Glass #ifndef __VSPRINTF_H 99785c905SSimon Glass #define __VSPRINTF_H 109785c905SSimon Glass 119785c905SSimon Glass ulong simple_strtoul(const char *cp, char **endp, unsigned int base); 1271ec92b6SSimon Glass 1371ec92b6SSimon Glass /** 1471ec92b6SSimon Glass * strict_strtoul - convert a string to an unsigned long strictly 1571ec92b6SSimon Glass * @param cp The string to be converted 1671ec92b6SSimon Glass * @param base The number base to use 1771ec92b6SSimon Glass * @param res The converted result value 1871ec92b6SSimon Glass * @return 0 if conversion is successful and *res is set to the converted 1971ec92b6SSimon Glass * value, otherwise it returns -EINVAL and *res is set to 0. 2071ec92b6SSimon Glass * 2171ec92b6SSimon Glass * strict_strtoul converts a string to an unsigned long only if the 2271ec92b6SSimon Glass * string is really an unsigned long string, any string containing 2371ec92b6SSimon Glass * any invalid char at the tail will be rejected and -EINVAL is returned, 2471ec92b6SSimon Glass * only a newline char at the tail is acceptible because people generally 2571ec92b6SSimon Glass * change a module parameter in the following way: 2671ec92b6SSimon Glass * 2771ec92b6SSimon Glass * echo 1024 > /sys/module/e1000/parameters/copybreak 2871ec92b6SSimon Glass * 2971ec92b6SSimon Glass * echo will append a newline to the tail. 3071ec92b6SSimon Glass * 3171ec92b6SSimon Glass * simple_strtoul just ignores the successive invalid characters and 3271ec92b6SSimon Glass * return the converted value of prefix part of the string. 3371ec92b6SSimon Glass * 3471ec92b6SSimon Glass * Copied this function from Linux 2.6.38 commit ID: 3571ec92b6SSimon Glass * 521cb40b0c44418a4fd36dc633f575813d59a43d 3671ec92b6SSimon Glass * 3771ec92b6SSimon Glass */ 389785c905SSimon Glass int strict_strtoul(const char *cp, unsigned int base, unsigned long *res); 399785c905SSimon Glass unsigned long long simple_strtoull(const char *cp, char **endp, 409785c905SSimon Glass unsigned int base); 419785c905SSimon Glass long simple_strtol(const char *cp, char **endp, unsigned int base); 4266312374SSimon Glass 4366312374SSimon Glass /** 4466312374SSimon Glass * panic() - Print a message and reset/hang 4566312374SSimon Glass * 4666312374SSimon Glass * Prints a message on the console(s) and then resets. If CONFIG_PANIC_HANG is 4766312374SSimon Glass * defined, then it will hang instead of reseting. 4866312374SSimon Glass * 4966312374SSimon Glass * @param fmt: printf() format string for message, which should not include 5066312374SSimon Glass * \n, followed by arguments 5166312374SSimon Glass */ 529785c905SSimon Glass void panic(const char *fmt, ...) 539785c905SSimon Glass __attribute__ ((format (__printf__, 1, 2), noreturn)); 5471ec92b6SSimon Glass 5571ec92b6SSimon Glass /** 5666312374SSimon Glass * panic_str() - Print a message and reset/hang 5766312374SSimon Glass * 5866312374SSimon Glass * Prints a message on the console(s) and then resets. If CONFIG_PANIC_HANG is 5966312374SSimon Glass * defined, then it will hang instead of reseting. 6066312374SSimon Glass * 6166312374SSimon Glass * This function can be used instead of panic() when your board does not 6266312374SSimon Glass * already use printf(), * to keep code size small. 6366312374SSimon Glass * 6466312374SSimon Glass * @param fmt: string to display, which should not include \n 6566312374SSimon Glass */ 6666312374SSimon Glass void panic_str(const char *str) __attribute__ ((noreturn)); 6766312374SSimon Glass 6866312374SSimon Glass /** 6971ec92b6SSimon Glass * Format a string and place it in a buffer 7071ec92b6SSimon Glass * 7171ec92b6SSimon Glass * @param buf The buffer to place the result into 7271ec92b6SSimon Glass * @param fmt The format string to use 7371ec92b6SSimon Glass * @param ... Arguments for the format string 7471ec92b6SSimon Glass * 7571ec92b6SSimon Glass * The function returns the number of characters written 7671ec92b6SSimon Glass * into @buf. 7771ec92b6SSimon Glass * 7871ec92b6SSimon Glass * See the vsprintf() documentation for format string extensions over C99. 7971ec92b6SSimon Glass */ 809785c905SSimon Glass int sprintf(char *buf, const char *fmt, ...) 819785c905SSimon Glass __attribute__ ((format (__printf__, 2, 3))); 8271ec92b6SSimon Glass 8371ec92b6SSimon Glass /** 8471ec92b6SSimon Glass * Format a string and place it in a buffer (va_list version) 8571ec92b6SSimon Glass * 8671ec92b6SSimon Glass * @param buf The buffer to place the result into 8771ec92b6SSimon Glass * @param size The size of the buffer, including the trailing null space 8871ec92b6SSimon Glass * @param fmt The format string to use 8971ec92b6SSimon Glass * @param args Arguments for the format string 9071ec92b6SSimon Glass * @return the number of characters which have been written into 9171ec92b6SSimon Glass * the @buf not including the trailing '\0'. If @size is == 0 the function 9271ec92b6SSimon Glass * returns 0. 9371ec92b6SSimon Glass * 9471ec92b6SSimon Glass * If you're not already dealing with a va_list consider using scnprintf(). 9571ec92b6SSimon Glass * 9671ec92b6SSimon Glass * See the vsprintf() documentation for format string extensions over C99. 9771ec92b6SSimon Glass */ 989785c905SSimon Glass int vsprintf(char *buf, const char *fmt, va_list args); 999785c905SSimon Glass char *simple_itoa(ulong i); 1009785c905SSimon Glass 101046a37bdSSonny Rao #ifdef CONFIG_SYS_VSNPRINTF 10271ec92b6SSimon Glass /** 10371ec92b6SSimon Glass * Format a string and place it in a buffer 10471ec92b6SSimon Glass * 10571ec92b6SSimon Glass * @param buf The buffer to place the result into 10671ec92b6SSimon Glass * @param size The size of the buffer, including the trailing null space 10771ec92b6SSimon Glass * @param fmt The format string to use 10871ec92b6SSimon Glass * @param ... Arguments for the format string 10971ec92b6SSimon Glass * @return the number of characters which would be 11071ec92b6SSimon Glass * generated for the given input, excluding the trailing null, 11171ec92b6SSimon Glass * as per ISO C99. If the return is greater than or equal to 11271ec92b6SSimon Glass * @size, the resulting string is truncated. 11371ec92b6SSimon Glass * 11471ec92b6SSimon Glass * See the vsprintf() documentation for format string extensions over C99. 11571ec92b6SSimon Glass */ 116046a37bdSSonny Rao int snprintf(char *buf, size_t size, const char *fmt, ...) 117046a37bdSSonny Rao __attribute__ ((format (__printf__, 3, 4))); 11871ec92b6SSimon Glass 11971ec92b6SSimon Glass /** 12071ec92b6SSimon Glass * Format a string and place it in a buffer 12171ec92b6SSimon Glass * 12271ec92b6SSimon Glass * @param buf The buffer to place the result into 12371ec92b6SSimon Glass * @param size The size of the buffer, including the trailing null space 12471ec92b6SSimon Glass * @param fmt The format string to use 12571ec92b6SSimon Glass * @param ... Arguments for the format string 12671ec92b6SSimon Glass * 12771ec92b6SSimon Glass * The return value is the number of characters written into @buf not including 12871ec92b6SSimon Glass * the trailing '\0'. If @size is == 0 the function returns 0. 12971ec92b6SSimon Glass * 13071ec92b6SSimon Glass * See the vsprintf() documentation for format string extensions over C99. 13171ec92b6SSimon Glass */ 132046a37bdSSonny Rao int scnprintf(char *buf, size_t size, const char *fmt, ...) 133046a37bdSSonny Rao __attribute__ ((format (__printf__, 3, 4))); 13471ec92b6SSimon Glass 13571ec92b6SSimon Glass /** 13671ec92b6SSimon Glass * Format a string and place it in a buffer (base function) 13771ec92b6SSimon Glass * 13871ec92b6SSimon Glass * @param buf The buffer to place the result into 13971ec92b6SSimon Glass * @param size The size of the buffer, including the trailing null space 14071ec92b6SSimon Glass * @param fmt The format string to use 14171ec92b6SSimon Glass * @param args Arguments for the format string 14271ec92b6SSimon Glass * @return The number characters which would be generated for the given 14371ec92b6SSimon Glass * input, excluding the trailing '\0', as per ISO C99. Note that fewer 14471ec92b6SSimon Glass * characters may be written if this number of characters is >= size. 14571ec92b6SSimon Glass * 14671ec92b6SSimon Glass * This function follows C99 vsnprintf, but has some extensions: 14771ec92b6SSimon Glass * %pS output the name of a text symbol 14871ec92b6SSimon Glass * %pF output the name of a function pointer 14971ec92b6SSimon Glass * %pR output the address range in a struct resource 15071ec92b6SSimon Glass * 15171ec92b6SSimon Glass * The function returns the number of characters which would be 15271ec92b6SSimon Glass * generated for the given input, excluding the trailing '\0', 15371ec92b6SSimon Glass * as per ISO C99. 15471ec92b6SSimon Glass * 15571ec92b6SSimon Glass * Call this function if you are already dealing with a va_list. 15671ec92b6SSimon Glass * You probably want snprintf() instead. 15771ec92b6SSimon Glass */ 158046a37bdSSonny Rao int vsnprintf(char *buf, size_t size, const char *fmt, va_list args); 15971ec92b6SSimon Glass 16071ec92b6SSimon Glass /** 16171ec92b6SSimon Glass * Format a string and place it in a buffer (va_list version) 16271ec92b6SSimon Glass * 16371ec92b6SSimon Glass * @param buf The buffer to place the result into 16471ec92b6SSimon Glass * @param size The size of the buffer, including the trailing null space 16571ec92b6SSimon Glass * @param fmt The format string to use 16671ec92b6SSimon Glass * @param args Arguments for the format string 16771ec92b6SSimon Glass * @return the number of characters which have been written into 16871ec92b6SSimon Glass * the @buf not including the trailing '\0'. If @size is == 0 the function 16971ec92b6SSimon Glass * returns 0. 17071ec92b6SSimon Glass * 17171ec92b6SSimon Glass * If you're not already dealing with a va_list consider using scnprintf(). 17271ec92b6SSimon Glass * 17371ec92b6SSimon Glass * See the vsprintf() documentation for format string extensions over C99. 17471ec92b6SSimon Glass */ 175046a37bdSSonny Rao int vscnprintf(char *buf, size_t size, const char *fmt, va_list args); 176046a37bdSSonny Rao #else 177046a37bdSSonny Rao /* 178046a37bdSSonny Rao * Use macros to silently drop the size parameter. Note that the 'cn' 179046a37bdSSonny Rao * versions are the same as the 'n' versions since the functions assume 180046a37bdSSonny Rao * there is always enough buffer space when !CONFIG_SYS_VSNPRINTF 181046a37bdSSonny Rao */ 182046a37bdSSonny Rao #define snprintf(buf, size, fmt, args...) sprintf(buf, fmt, ##args) 183046a37bdSSonny Rao #define scnprintf(buf, size, fmt, args...) sprintf(buf, fmt, ##args) 184046a37bdSSonny Rao #define vsnprintf(buf, size, fmt, args...) vsprintf(buf, fmt, ##args) 185046a37bdSSonny Rao #define vscnprintf(buf, size, fmt, args...) vsprintf(buf, fmt, ##args) 186046a37bdSSonny Rao #endif /* CONFIG_SYS_VSNPRINTF */ 187046a37bdSSonny Rao 188b8bcaa3aSSimon Glass /** 189b8bcaa3aSSimon Glass * print_grouped_ull() - print a value with digits grouped by ',' 190b8bcaa3aSSimon Glass * 191b8bcaa3aSSimon Glass * This prints a value with grouped digits, like 12,345,678 to make it easier 192b8bcaa3aSSimon Glass * to read. 193b8bcaa3aSSimon Glass * 194b8bcaa3aSSimon Glass * @val: Value to print 195b8bcaa3aSSimon Glass * @digits: Number of digiits to print 196b8bcaa3aSSimon Glass */ 197b8bcaa3aSSimon Glass void print_grouped_ull(unsigned long long int_val, int digits); 198b8bcaa3aSSimon Glass 199*09c32807SHeiko Schocher bool str2off(const char *p, loff_t *num); 200*09c32807SHeiko Schocher bool str2long(const char *p, ulong *num); 2019785c905SSimon Glass #endif 202