fastboot: Extract fastboot_okay/fail to fb_common.c

[oweals/u-boot.git] / include / fastboot.h

diff --git a/include/fastboot.h b/include/fastboot.h
index ed52daeb1b8df1c4f14fd9a90f0b451207b81551..6cd44d2ab9240b06c6241abd5ab453804686500f 100644 (file)
--- a/include/fastboot.h
+++ b/include/fastboot.h
@@ -15,7 +15,31 @@
 /* The 64 defined bytes plus \0 */
 #define FASTBOOT_RESPONSE_LEN  (64 + 1)
 
+/**
+ * fastboot_response() - Writes a response of the form "$tag$reason".
+ *
+ * @tag: The first part of the response
+ * @response: Pointer to fastboot response buffer
+ * @format: printf style format string
+ */
+void fastboot_response(const char *tag, char *response,
+                      const char *format, ...)
+       __attribute__ ((format (__printf__, 3, 4)));
+
+/**
+ * fastboot_fail() - Write a FAIL response of the form "FAIL$reason".
+ *
+ * @reason: Pointer to returned reason string
+ * @response: Pointer to fastboot response buffer
+ */
 void fastboot_fail(const char *reason, char *response);
+
+/**
+ * fastboot_okay() - Write an OKAY response of the form "OKAY$reason".
+ *
+ * @reason: Pointer to returned reason string, or NULL to send a bare "OKAY"
+ * @response: Pointer to fastboot response buffer
+ */
 void fastboot_okay(const char *reason, char *response);
 
 #endif /* _FASTBOOT_H_ */