fastboot.h 4.7 KB

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