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
13 #include <bcb.h>
14 #include <command.h>
15 #include <env.h>
16 #include <fastboot.h>
17 #include <net.h>
18 #include <vsprintf.h>
19
20 /**
21 * fastboot_buf_addr - base address of the fastboot download buffer
22 */
23 void *fastboot_buf_addr;
24
25 /**
26 * fastboot_buf_size - size of the fastboot download buffer
27 */
28 u32 fastboot_buf_size;
29
30 /**
31 * fastboot_progress_callback - callback executed during long operations
32 */
33 void (*fastboot_progress_callback)(const char *msg);
34
35 /**
36 * fastboot_response() - Writes a response of the form "$tag$reason".
37 *
38 * @tag: The first part of the response
39 * @response: Pointer to fastboot response buffer
40 * @format: printf style format string
41 */
fastboot_response(const char * tag,char * response,const char * format,...)42 void fastboot_response(const char *tag, char *response,
43 const char *format, ...)
44 {
45 va_list args;
46
47 strlcpy(response, tag, FASTBOOT_RESPONSE_LEN);
48 if (format) {
49 va_start(args, format);
50 vsnprintf(response + strlen(response),
51 FASTBOOT_RESPONSE_LEN - strlen(response) - 1,
52 format, args);
53 va_end(args);
54 }
55 }
56
57 /**
58 * fastboot_fail() - Write a FAIL response of the form "FAIL$reason".
59 *
60 * @reason: Pointer to returned reason string
61 * @response: Pointer to fastboot response buffer
62 */
fastboot_fail(const char * reason,char * response)63 void fastboot_fail(const char *reason, char *response)
64 {
65 fastboot_response("FAIL", response, "%s", reason);
66 }
67
68 /**
69 * fastboot_okay() - Write an OKAY response of the form "OKAY$reason".
70 *
71 * @reason: Pointer to returned reason string, or NULL to send a bare "OKAY"
72 * @response: Pointer to fastboot response buffer
73 */
fastboot_okay(const char * reason,char * response)74 void fastboot_okay(const char *reason, char *response)
75 {
76 if (reason)
77 fastboot_response("OKAY", response, "%s", reason);
78 else
79 fastboot_response("OKAY", response, NULL);
80 }
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 */
fastboot_set_reboot_flag(enum fastboot_reboot_reason reason)92 int __weak fastboot_set_reboot_flag(enum fastboot_reboot_reason reason)
93 {
94 int ret;
95 static const char * const boot_cmds[] = {
96 [FASTBOOT_REBOOT_REASON_BOOTLOADER] = "bootonce-bootloader",
97 [FASTBOOT_REBOOT_REASON_FASTBOOTD] = "boot-fastboot",
98 [FASTBOOT_REBOOT_REASON_RECOVERY] = "boot-recovery"
99 };
100 const int mmc_dev = config_opt_enabled(CONFIG_FASTBOOT_FLASH_MMC,
101 CONFIG_FASTBOOT_FLASH_MMC_DEV, -1);
102
103 if (!IS_ENABLED(CONFIG_FASTBOOT_FLASH_MMC))
104 return -EINVAL;
105
106 if (reason >= FASTBOOT_REBOOT_REASONS_COUNT)
107 return -EINVAL;
108
109 ret = bcb_find_partition_and_load("mmc", mmc_dev, "misc");
110 if (ret)
111 goto out;
112
113 ret = bcb_set(BCB_FIELD_COMMAND, boot_cmds[reason]);
114 if (ret)
115 goto out;
116
117 ret = bcb_store();
118 out:
119 bcb_reset();
120 return ret;
121 }
122
123 /**
124 * fastboot_get_progress_callback() - Return progress callback
125 *
126 * Return: Pointer to function called during long operations
127 */
fastboot_get_progress_callback(void)128 void (*fastboot_get_progress_callback(void))(const char *)
129 {
130 return fastboot_progress_callback;
131 }
132
133 /**
134 * fastboot_boot() - Execute fastboot boot command
135 *
136 * If ${fastboot_bootcmd} is set, run that command to execute the boot
137 * process, if that returns, then exit the fastboot server and return
138 * control to the caller.
139 *
140 * Otherwise execute "bootm <fastboot_buf_addr>", if that fails, reset
141 * the board.
142 */
fastboot_boot(void)143 void fastboot_boot(void)
144 {
145 char *s;
146
147 s = env_get("fastboot_bootcmd");
148 if (s) {
149 run_command(s, CMD_FLAG_ENV);
150 } else if (IS_ENABLED(CONFIG_CMD_BOOTM)) {
151 static char boot_addr_start[20];
152 static char *const bootm_args[] = {
153 "bootm", boot_addr_start, NULL
154 };
155
156 snprintf(boot_addr_start, sizeof(boot_addr_start) - 1,
157 "0x%p", fastboot_buf_addr);
158 printf("Booting kernel at %s...\n\n\n", boot_addr_start);
159
160 do_bootm(NULL, 0, 2, bootm_args);
161
162 /*
163 * This only happens if image is somehow faulty so we start
164 * over. We deliberately leave this policy to the invocation
165 * of fastbootcmd if that's what's being run
166 */
167 do_reset(NULL, 0, 0, NULL);
168 }
169 }
170
171 /**
172 * fastboot_handle_boot() - Shared implementation of system reaction to
173 * fastboot commands
174 *
175 * Making desceisions about device boot state (stay in fastboot, reboot
176 * to bootloader, reboot to OS, etc).
177 */
fastboot_handle_boot(int command,bool success)178 void fastboot_handle_boot(int command, bool success)
179 {
180 if (!success)
181 return;
182
183 switch (command) {
184 case FASTBOOT_COMMAND_BOOT:
185 fastboot_boot();
186 #if CONFIG_IS_ENABLED(NET)
187 net_set_state(NETLOOP_SUCCESS);
188 #endif
189 break;
190
191 case FASTBOOT_COMMAND_CONTINUE:
192 #if CONFIG_IS_ENABLED(NET)
193 net_set_state(NETLOOP_SUCCESS);
194 #endif
195 break;
196
197 case FASTBOOT_COMMAND_REBOOT:
198 case FASTBOOT_COMMAND_REBOOT_BOOTLOADER:
199 case FASTBOOT_COMMAND_REBOOT_FASTBOOTD:
200 case FASTBOOT_COMMAND_REBOOT_RECOVERY:
201 do_reset(NULL, 0, 0, NULL);
202 break;
203 }
204 }
205
206 /**
207 * fastboot_set_progress_callback() - set progress callback
208 *
209 * @progress: Pointer to progress callback
210 *
211 * Set a callback which is invoked periodically during long running operations
212 * (flash and erase). This can be used (for example) by the UDP transport to
213 * send INFO responses to keep the client alive whilst those commands are
214 * executing.
215 */
fastboot_set_progress_callback(void (* progress)(const char * msg))216 void fastboot_set_progress_callback(void (*progress)(const char *msg))
217 {
218 fastboot_progress_callback = progress;
219 }
220
221 /*
222 * fastboot_init() - initialise new fastboot protocol session
223 *
224 * @buf_addr: Pointer to download buffer, or NULL for default
225 * @buf_size: Size of download buffer, or zero for default
226 */
fastboot_init(void * buf_addr,u32 buf_size)227 void fastboot_init(void *buf_addr, u32 buf_size)
228 {
229 fastboot_buf_addr = buf_addr ? buf_addr :
230 (void *)CONFIG_FASTBOOT_BUF_ADDR;
231 fastboot_buf_size = buf_size ? buf_size : CONFIG_FASTBOOT_BUF_SIZE;
232 fastboot_set_progress_callback(NULL);
233 }
234