fastboot.h 4.6 KB

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