arm: Remove bg0900 board
[platform/kernel/u-boot.git] / include / vsprintf.h
index c30e91f..83d187e 100644 (file)
  *
  * @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
+ * @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);
 
@@ -53,7 +60,7 @@ 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
  * value, otherwise it returns -EINVAL and *res is set to 0.
@@ -68,6 +75,13 @@ unsigned long dectoul(const char *cp, char **endp);
  *
  * echo will append a newline to the tail.
  *
+ * 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
  *