path: root/firmware/include
diff options
authorMichael Sevakis <>2017-09-08 19:28:02 -0400
committerMichael Sevakis <>2017-11-21 05:00:27 -0500
commit5c9688961ef9166cec5225db50d5f73691d8292d (patch)
tree467cc61cceef1fda804f9c715e9994670eb7683f /firmware/include
parent52af55eee8566e23b190b7444e73df0106b1663d (diff)
Implement a much more capable vuprintf()
New support as well as some buggy support fixed. Still no floating point support if ever that would be desired. Support (*): * Flags: '-', '+', ' ', '#', '0' * Width and precision: 'n', '.n', '*' and '.*' * Length modifiers: 'hh', 'h', 'j', 'l', 'll', 't', 'z' * Radix: 'c', 'd', 'i', 'n', 'o', 'p/P', 's', 'u', 'x/X' (*) Provision exists to switch lesser-used stuff on or off or when certain functionality isn't desired (bootloader?). The compulsory radixes are everything but 'o', 'n', 'p/P' and 'x/X' with length modifiers being optional. The default setup is 'l', 'z', 'c', 'd', 'p/P', 's', 'u', 'x/X'. * Move fdprintf() to its own file. It was in a strange place. * Make callers compatible and fix a couple snprintf() bugs while at it. Could smush it down in size but I'm gonna get over the binsize neurosis and just the let optimizer do its thing. Change-Id: Ibdc613a9b6775802c188b29b9dd46c568c94f7c3
Diffstat (limited to 'firmware/include')
-rw-r--r--firmware/include/vuprintf.h (renamed from firmware/include/format.h)34
1 files changed, 21 insertions, 13 deletions
diff --git a/firmware/include/format.h b/firmware/include/vuprintf.h
index 30a072aca8..3876482fb2 100644
--- a/firmware/include/format.h
+++ b/firmware/include/vuprintf.h
@@ -19,19 +19,27 @@
-#ifndef __FORMAT_H__
-#define __FORMAT_H__
+#ifndef __VUPRINTF_H__
+#define __VUPRINTF_H__
-void format(
- /* call 'push()' for each output letter */
- int (*push)(void *userp, unsigned char data),
- void *userp,
- const char *fmt,
- va_list ap);
+#include <stdarg.h>
-/* callback function is called for every output character (byte) with userp and
- * should return 0 when ch is a char other than '\0' that should stop printing */
-void vuprintf(int (*push)(void *userp, unsigned char data),
- void *userp, const char *fmt, va_list ap);
+/* callback function is called for every output character (byte) in the
+ * output with userp
+ *
+ * it must return > 0 to continue (increments counter)
+ * it may return 0 to stop (increments counter)
+ * it may return < 0 to stop (does not increment counter)
+ * a zero in the format string stops (does not increment counter)
+ *
+ * caller is reponsible for stopping formatting in order to keep the return
+ * value from overflowing (assuming they have a reason to care)
+ */
+typedef int (* vuprintf_push_cb)(void *userp, int c);
+ * returns the number of times push() was called and returned >= 0
+ */
+int vuprintf(vuprintf_push_cb push, void *userp, const char *fmt, va_list ap);
-#endif /* __FORMAT_H__ */
+#endif /* __VUPRINTF_H__ */