fastboot.h 4.4 KB

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