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 15 #define FASTBOOT_VERSION "0.4" 16 17 /* The 64 defined bytes plus \0 */ 18 #define FASTBOOT_COMMAND_LEN (64 + 1) 19 #define FASTBOOT_RESPONSE_LEN (64 + 1) 20 21 /** 22 * All known commands to fastboot 23 */ 24 enum { 25 FASTBOOT_COMMAND_GETVAR = 0, 26 FASTBOOT_COMMAND_DOWNLOAD, 27 FASTBOOT_COMMAND_FLASH, 28 FASTBOOT_COMMAND_ERASE, 29 FASTBOOT_COMMAND_BOOT, 30 FASTBOOT_COMMAND_CONTINUE, 31 FASTBOOT_COMMAND_REBOOT, 32 FASTBOOT_COMMAND_REBOOT_BOOTLOADER, 33 FASTBOOT_COMMAND_REBOOT_FASTBOOTD, 34 FASTBOOT_COMMAND_REBOOT_RECOVERY, 35 FASTBOOT_COMMAND_SET_ACTIVE, 36 FASTBOOT_COMMAND_OEM_FORMAT, 37 FASTBOOT_COMMAND_OEM_PARTCONF, 38 FASTBOOT_COMMAND_OEM_BOOTBUS, 39 FASTBOOT_COMMAND_OEM_RUN, 40 FASTBOOT_COMMAND_ACMD, 41 FASTBOOT_COMMAND_UCMD, 42 FASTBOOT_COMMAND_COUNT 43 }; 44 45 /** 46 * Reboot reasons 47 */ 48 enum fastboot_reboot_reason { 49 FASTBOOT_REBOOT_REASON_BOOTLOADER, 50 FASTBOOT_REBOOT_REASON_FASTBOOTD, 51 FASTBOOT_REBOOT_REASON_RECOVERY, 52 FASTBOOT_REBOOT_REASONS_COUNT 53 }; 54 55 /** 56 * fastboot_response() - Writes a response of the form "$tag$reason". 57 * 58 * @tag: The first part of the response 59 * @response: Pointer to fastboot response buffer 60 * @format: printf style format string 61 */ 62 void fastboot_response(const char *tag, char *response, 63 const char *format, ...) 64 __attribute__ ((format (__printf__, 3, 4))); 65 66 /** 67 * fastboot_fail() - Write a FAIL response of the form "FAIL$reason". 68 * 69 * @reason: Pointer to returned reason string 70 * @response: Pointer to fastboot response buffer 71 */ 72 void fastboot_fail(const char *reason, char *response); 73 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 /** 83 * fastboot_set_reboot_flag() - Set flag to indicate reboot-bootloader 84 * 85 * Set flag which indicates that we should reboot into the bootloader 86 * following the reboot that fastboot executes after this function. 87 * 88 * This function should be overridden in your board file with one 89 * which sets whatever flag your board specific Android bootloader flow 90 * requires in order to re-enter the bootloader. 91 */ 92 int fastboot_set_reboot_flag(enum fastboot_reboot_reason reason); 93 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 /* 107 * fastboot_init() - initialise new fastboot protocol session 108 * 109 * @buf_addr: Pointer to download buffer, or NULL for default 110 * @buf_size: Size of download buffer, or zero for default 111 */ 112 void fastboot_init(void *buf_addr, u32 buf_size); 113 114 /** 115 * fastboot_boot() - Execute fastboot boot command 116 * 117 * If ${fastboot_bootcmd} is set, run that command to execute the boot 118 * process, if that returns, then exit the fastboot server and return 119 * control to the caller. 120 * 121 * Otherwise execute "bootm <fastboot_buf_addr>", if that fails, reset 122 * the board. 123 */ 124 void fastboot_boot(void); 125 126 /** 127 * fastboot_handle_boot() - Shared implementation of system reaction to 128 * fastboot commands 129 * 130 * Making desceisions about device boot state (stay in fastboot, reboot 131 * to bootloader, reboot to OS, etc). 132 */ 133 void fastboot_handle_boot(int command, bool success); 134 135 /** 136 * fastboot_handle_command() - Handle fastboot command 137 * 138 * @cmd_string: Pointer to command string 139 * @response: Pointer to fastboot response buffer 140 * 141 * Return: Executed command, or -1 if not recognized 142 */ 143 int fastboot_handle_command(char *cmd_string, char *response); 144 145 /** 146 * fastboot_data_remaining() - return bytes remaining in current transfer 147 * 148 * Return: Number of bytes left in the current download 149 */ 150 u32 fastboot_data_remaining(void); 151 152 /** 153 * fastboot_data_download() - Copy image data to fastboot_buf_addr. 154 * 155 * @fastboot_data: Pointer to received fastboot data 156 * @fastboot_data_len: Length of received fastboot data 157 * @response: Pointer to fastboot response buffer 158 * 159 * Copies image data from fastboot_data to fastboot_buf_addr. Writes to 160 * response. fastboot_bytes_received is updated to indicate the number 161 * of bytes that have been transferred. 162 */ 163 void fastboot_data_download(const void *fastboot_data, 164 unsigned int fastboot_data_len, char *response); 165 166 /** 167 * fastboot_data_complete() - Mark current transfer complete 168 * 169 * @response: Pointer to fastboot response buffer 170 * 171 * Set image_size and ${filesize} to the total size of the downloaded image. 172 */ 173 void fastboot_data_complete(char *response); 174 175 void fastboot_acmd_complete(void); 176 #endif /* _FASTBOOT_H_ */ 177