fastboot.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2008 - 2009
  4. * Windriver, <www.windriver.com>
  5. * Tom Rix <Tom.Rix@windriver.com>
  6. *
  7. * Copyright 2011 Sebastian Andrzej Siewior <bigeasy@linutronix.de>
  8. *
  9. * Copyright 2014 Linaro, Ltd.
  10. * Rob Herring <robh@kernel.org>
  11. */
  12. #ifndef _FASTBOOT_H_
  13. #define _FASTBOOT_H_
  14. #define FASTBOOT_VERSION "0.4"
  15. /* The 64 defined bytes plus \0 */
  16. #define FASTBOOT_COMMAND_LEN (64 + 1)
  17. #define FASTBOOT_RESPONSE_LEN (64 + 1)
  18. /**
  19. * All known commands to fastboot
  20. */
  21. enum {
  22. FASTBOOT_COMMAND_GETVAR = 0,
  23. FASTBOOT_COMMAND_DOWNLOAD,
  24. #if CONFIG_IS_ENABLED(FASTBOOT_FLASH)
  25. FASTBOOT_COMMAND_FLASH,
  26. FASTBOOT_COMMAND_ERASE,
  27. #endif
  28. FASTBOOT_COMMAND_BOOT,
  29. FASTBOOT_COMMAND_CONTINUE,
  30. FASTBOOT_COMMAND_REBOOT,
  31. FASTBOOT_COMMAND_REBOOT_BOOTLOADER,
  32. FASTBOOT_COMMAND_REBOOT_FASTBOOTD,
  33. FASTBOOT_COMMAND_REBOOT_RECOVERY,
  34. FASTBOOT_COMMAND_SET_ACTIVE,
  35. #if CONFIG_IS_ENABLED(FASTBOOT_CMD_OEM_FORMAT)
  36. FASTBOOT_COMMAND_OEM_FORMAT,
  37. #endif
  38. #if CONFIG_IS_ENABLED(FASTBOOT_CMD_OEM_PARTCONF)
  39. FASTBOOT_COMMAND_OEM_PARTCONF,
  40. #endif
  41. #if CONFIG_IS_ENABLED(FASTBOOT_CMD_OEM_BOOTBUS)
  42. FASTBOOT_COMMAND_OEM_BOOTBUS,
  43. #endif
  44. #if CONFIG_IS_ENABLED(FASTBOOT_UUU_SUPPORT)
  45. FASTBOOT_COMMAND_ACMD,
  46. FASTBOOT_COMMAND_UCMD,
  47. #endif
  48. FASTBOOT_COMMAND_COUNT
  49. };
  50. /**
  51. * Reboot reasons
  52. */
  53. enum fastboot_reboot_reason {
  54. FASTBOOT_REBOOT_REASON_BOOTLOADER,
  55. FASTBOOT_REBOOT_REASON_FASTBOOTD,
  56. FASTBOOT_REBOOT_REASON_RECOVERY,
  57. FASTBOOT_REBOOT_REASONS_COUNT
  58. };
  59. /**
  60. * fastboot_response() - Writes a response of the form "$tag$reason".
  61. *
  62. * @tag: The first part of the response
  63. * @response: Pointer to fastboot response buffer
  64. * @format: printf style format string
  65. */
  66. void fastboot_response(const char *tag, char *response,
  67. const char *format, ...)
  68. __attribute__ ((format (__printf__, 3, 4)));
  69. /**
  70. * fastboot_fail() - Write a FAIL response of the form "FAIL$reason".
  71. *
  72. * @reason: Pointer to returned reason string
  73. * @response: Pointer to fastboot response buffer
  74. */
  75. void fastboot_fail(const char *reason, char *response);
  76. /**
  77. * fastboot_okay() - Write an OKAY response of the form "OKAY$reason".
  78. *
  79. * @reason: Pointer to returned reason string, or NULL to send a bare "OKAY"
  80. * @response: Pointer to fastboot response buffer
  81. */
  82. void fastboot_okay(const char *reason, char *response);
  83. /**
  84. * fastboot_set_reboot_flag() - Set flag to indicate reboot-bootloader
  85. *
  86. * Set flag which indicates that we should reboot into the bootloader
  87. * following the reboot that fastboot executes after this function.
  88. *
  89. * This function should be overridden in your board file with one
  90. * which sets whatever flag your board specific Android bootloader flow
  91. * requires in order to re-enter the bootloader.
  92. */
  93. int fastboot_set_reboot_flag(enum fastboot_reboot_reason reason);
  94. /**
  95. * fastboot_set_progress_callback() - set progress callback
  96. *
  97. * @progress: Pointer to progress callback
  98. *
  99. * Set a callback which is invoked periodically during long running operations
  100. * (flash and erase). This can be used (for example) by the UDP transport to
  101. * send INFO responses to keep the client alive whilst those commands are
  102. * executing.
  103. */
  104. void fastboot_set_progress_callback(void (*progress)(const char *msg));
  105. /*
  106. * fastboot_init() - initialise new fastboot protocol session
  107. *
  108. * @buf_addr: Pointer to download buffer, or NULL for default
  109. * @buf_size: Size of download buffer, or zero for default
  110. */
  111. void fastboot_init(void *buf_addr, u32 buf_size);
  112. /**
  113. * fastboot_boot() - Execute fastboot boot command
  114. *
  115. * If ${fastboot_bootcmd} is set, run that command to execute the boot
  116. * process, if that returns, then exit the fastboot server and return
  117. * control to the caller.
  118. *
  119. * Otherwise execute "bootm <fastboot_buf_addr>", if that fails, reset
  120. * the board.
  121. */
  122. void fastboot_boot(void);
  123. /**
  124. * fastboot_handle_command() - Handle fastboot command
  125. *
  126. * @cmd_string: Pointer to command string
  127. * @response: Pointer to fastboot response buffer
  128. *
  129. * Return: Executed command, or -1 if not recognized
  130. */
  131. int fastboot_handle_command(char *cmd_string, char *response);
  132. /**
  133. * fastboot_data_remaining() - return bytes remaining in current transfer
  134. *
  135. * Return: Number of bytes left in the current download
  136. */
  137. u32 fastboot_data_remaining(void);
  138. /**
  139. * fastboot_data_download() - Copy image data to fastboot_buf_addr.
  140. *
  141. * @fastboot_data: Pointer to received fastboot data
  142. * @fastboot_data_len: Length of received fastboot data
  143. * @response: Pointer to fastboot response buffer
  144. *
  145. * Copies image data from fastboot_data to fastboot_buf_addr. Writes to
  146. * response. fastboot_bytes_received is updated to indicate the number
  147. * of bytes that have been transferred.
  148. */
  149. void fastboot_data_download(const void *fastboot_data,
  150. unsigned int fastboot_data_len, char *response);
  151. /**
  152. * fastboot_data_complete() - Mark current transfer complete
  153. *
  154. * @response: Pointer to fastboot response buffer
  155. *
  156. * Set image_size and ${filesize} to the total size of the downloaded image.
  157. */
  158. void fastboot_data_complete(char *response);
  159. #if CONFIG_IS_ENABLED(FASTBOOT_UUU_SUPPORT)
  160. void fastboot_acmd_complete(void);
  161. #endif
  162. #endif /* _FASTBOOT_H_ */