fastboot.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  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. FASTBOOT_COMMAND_COUNT
  39. };
  40. /**
  41. * Reboot reasons
  42. */
  43. enum fastboot_reboot_reason {
  44. FASTBOOT_REBOOT_REASON_BOOTLOADER,
  45. FASTBOOT_REBOOT_REASON_FASTBOOTD,
  46. FASTBOOT_REBOOT_REASON_RECOVERY,
  47. FASTBOOT_REBOOT_REASONS_COUNT
  48. };
  49. /**
  50. * BCB boot commands
  51. */
  52. static const char * const fastboot_boot_cmds[] = {
  53. [FASTBOOT_REBOOT_REASON_BOOTLOADER] = "bootonce-bootloader",
  54. [FASTBOOT_REBOOT_REASON_FASTBOOTD] = "boot-fastboot",
  55. [FASTBOOT_REBOOT_REASON_RECOVERY] = "boot-recovery"
  56. };
  57. /**
  58. * fastboot_response() - Writes a response of the form "$tag$reason".
  59. *
  60. * @tag: The first part of the response
  61. * @response: Pointer to fastboot response buffer
  62. * @format: printf style format string
  63. */
  64. void fastboot_response(const char *tag, char *response,
  65. const char *format, ...)
  66. __attribute__ ((format (__printf__, 3, 4)));
  67. /**
  68. * fastboot_fail() - Write a FAIL response of the form "FAIL$reason".
  69. *
  70. * @reason: Pointer to returned reason string
  71. * @response: Pointer to fastboot response buffer
  72. */
  73. void fastboot_fail(const char *reason, char *response);
  74. /**
  75. * fastboot_okay() - Write an OKAY response of the form "OKAY$reason".
  76. *
  77. * @reason: Pointer to returned reason string, or NULL to send a bare "OKAY"
  78. * @response: Pointer to fastboot response buffer
  79. */
  80. void fastboot_okay(const char *reason, char *response);
  81. /**
  82. * fastboot_set_reboot_flag() - Set flag to indicate reboot-bootloader
  83. *
  84. * Set flag which indicates that we should reboot into the bootloader
  85. * following the reboot that fastboot executes after this function.
  86. *
  87. * This function should be overridden in your board file with one
  88. * which sets whatever flag your board specific Android bootloader flow
  89. * requires in order to re-enter the bootloader.
  90. */
  91. int fastboot_set_reboot_flag(enum fastboot_reboot_reason reason);
  92. /**
  93. * fastboot_set_progress_callback() - set progress callback
  94. *
  95. * @progress: Pointer to progress callback
  96. *
  97. * Set a callback which is invoked periodically during long running operations
  98. * (flash and erase). This can be used (for example) by the UDP transport to
  99. * send INFO responses to keep the client alive whilst those commands are
  100. * executing.
  101. */
  102. void fastboot_set_progress_callback(void (*progress)(const char *msg));
  103. /*
  104. * fastboot_init() - initialise new fastboot protocol session
  105. *
  106. * @buf_addr: Pointer to download buffer, or NULL for default
  107. * @buf_size: Size of download buffer, or zero for default
  108. */
  109. void fastboot_init(void *buf_addr, u32 buf_size);
  110. /**
  111. * fastboot_boot() - Execute fastboot boot command
  112. *
  113. * If ${fastboot_bootcmd} is set, run that command to execute the boot
  114. * process, if that returns, then exit the fastboot server and return
  115. * control to the caller.
  116. *
  117. * Otherwise execute "bootm <fastboot_buf_addr>", if that fails, reset
  118. * the board.
  119. */
  120. void fastboot_boot(void);
  121. /**
  122. * fastboot_handle_command() - Handle fastboot command
  123. *
  124. * @cmd_string: Pointer to command string
  125. * @response: Pointer to fastboot response buffer
  126. *
  127. * Return: Executed command, or -1 if not recognized
  128. */
  129. int fastboot_handle_command(char *cmd_string, char *response);
  130. /**
  131. * fastboot_data_remaining() - return bytes remaining in current transfer
  132. *
  133. * Return: Number of bytes left in the current download
  134. */
  135. u32 fastboot_data_remaining(void);
  136. /**
  137. * fastboot_data_download() - Copy image data to fastboot_buf_addr.
  138. *
  139. * @fastboot_data: Pointer to received fastboot data
  140. * @fastboot_data_len: Length of received fastboot data
  141. * @response: Pointer to fastboot response buffer
  142. *
  143. * Copies image data from fastboot_data to fastboot_buf_addr. Writes to
  144. * response. fastboot_bytes_received is updated to indicate the number
  145. * of bytes that have been transferred.
  146. */
  147. void fastboot_data_download(const void *fastboot_data,
  148. unsigned int fastboot_data_len, char *response);
  149. /**
  150. * fastboot_data_complete() - Mark current transfer complete
  151. *
  152. * @response: Pointer to fastboot response buffer
  153. *
  154. * Set image_size and ${filesize} to the total size of the downloaded image.
  155. */
  156. void fastboot_data_complete(char *response);
  157. #endif /* _FASTBOOT_H_ */