mirror of
https://github.com/AsahiLinux/u-boot
synced 2024-11-16 01:38:22 +00:00
71ec92b67c
Now that this is not in common.h, perhaps it is acceptable to move this documentation into the header file. Signed-off-by: Simon Glass <sjg@chromium.org>
181 lines
6.8 KiB
C
181 lines
6.8 KiB
C
/*
|
|
* (C) Copyright 2000-2009
|
|
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
|
|
*
|
|
* See file CREDITS for list of people who contributed to this
|
|
* project.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License as
|
|
* published by the Free Software Foundation; either version 2 of
|
|
* the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*/
|
|
|
|
#ifndef __VSPRINTF_H
|
|
#define __VSPRINTF_H
|
|
|
|
ulong simple_strtoul(const char *cp, char **endp, unsigned int base);
|
|
|
|
/**
|
|
* 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 res The converted result value
|
|
* @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
|
|
* string is really an unsigned long string, any string containing
|
|
* any invalid char at the tail will be rejected and -EINVAL is returned,
|
|
* only a newline char at the tail is acceptible because people generally
|
|
* change a module parameter in the following way:
|
|
*
|
|
* echo 1024 > /sys/module/e1000/parameters/copybreak
|
|
*
|
|
* 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.
|
|
*
|
|
* Copied this function from Linux 2.6.38 commit ID:
|
|
* 521cb40b0c44418a4fd36dc633f575813d59a43d
|
|
*
|
|
*/
|
|
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);
|
|
void panic(const char *fmt, ...)
|
|
__attribute__ ((format (__printf__, 1, 2), noreturn));
|
|
|
|
/**
|
|
* Format a string and place it in a buffer
|
|
*
|
|
* @param buf The buffer to place the result into
|
|
* @param fmt The format string to use
|
|
* @param ... Arguments for the format string
|
|
*
|
|
* The function returns the number of characters written
|
|
* into @buf.
|
|
*
|
|
* See the vsprintf() documentation for format string extensions over C99.
|
|
*/
|
|
int sprintf(char *buf, const char *fmt, ...)
|
|
__attribute__ ((format (__printf__, 2, 3)));
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* 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
|
|
/**
|
|
* Format a string and place it in a buffer
|
|
*
|
|
* @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 ... Arguments for the format string
|
|
* @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.
|
|
*
|
|
* See the vsprintf() documentation for format string extensions over C99.
|
|
*/
|
|
int snprintf(char *buf, size_t size, const char *fmt, ...)
|
|
__attribute__ ((format (__printf__, 3, 4)));
|
|
|
|
/**
|
|
* Format a string and place it in a buffer
|
|
*
|
|
* @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 ... Arguments for the format string
|
|
*
|
|
* The return value is the number of characters written into @buf not including
|
|
* the trailing '\0'. If @size is == 0 the function returns 0.
|
|
*
|
|
* See the vsprintf() documentation for format string extensions over C99.
|
|
*/
|
|
int scnprintf(char *buf, size_t size, const char *fmt, ...)
|
|
__attribute__ ((format (__printf__, 3, 4)));
|
|
|
|
/**
|
|
* Format a string and place it in a buffer (base function)
|
|
*
|
|
* @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 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.
|
|
*
|
|
* This function follows C99 vsnprintf, but has some extensions:
|
|
* %pS output the name of a text symbol
|
|
* %pF output the name of a function pointer
|
|
* %pR output the address range in a struct resource
|
|
*
|
|
* The function returns the number of characters which would be
|
|
* generated for the given input, excluding the trailing '\0',
|
|
* as per ISO C99.
|
|
*
|
|
* Call this function if you are already dealing with a va_list.
|
|
* You probably want snprintf() instead.
|
|
*/
|
|
int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* If you're not already dealing with a va_list consider using scnprintf().
|
|
*
|
|
* 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 */
|
|
|
|
#endif
|