xref: /rk3399_rockchip-uboot/cmd/rockusb.c (revision fb735bc0afaa5ca3e43197aacbf2d83b2c314a1d)
1 /*
2  * Copyright 2017 Rockchip Electronics Co., Ltd
3  * Frank Wang <frank.wang@rock-chips.com>
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #include <errno.h>
9 #include <common.h>
10 #include <command.h>
11 #include <console.h>
12 #include <g_dnl.h>
13 #include <part.h>
14 #include <usb.h>
15 #include <usb_mass_storage.h>
16 #include <rockusb.h>
17 
18 static struct rockusb rkusb;
19 static struct rockusb *g_rkusb;
20 
21 static int rkusb_read_sector(struct ums *ums_dev,
22 			     ulong start, lbaint_t blkcnt, void *buf)
23 {
24 	struct blk_desc *block_dev = &ums_dev->block_dev;
25 	lbaint_t blkstart = start + ums_dev->start_sector;
26 	int ret;
27 
28 	if ((blkstart + blkcnt) > RKUSB_READ_LIMIT_ADDR) {
29 		memset(buf, 0xcc, blkcnt * SECTOR_SIZE);
30 		return blkcnt;
31 	} else {
32 		ret = blk_dread(block_dev, blkstart, blkcnt, buf);
33 		if (!ret)
34 			ret = -EIO;
35 		return ret;
36 	}
37 }
38 
39 static int rkusb_write_sector(struct ums *ums_dev,
40 			      ulong start, lbaint_t blkcnt, const void *buf)
41 {
42 	struct blk_desc *block_dev = &ums_dev->block_dev;
43 	lbaint_t blkstart = start + ums_dev->start_sector;
44 	int ret;
45 
46 	if (block_dev->if_type == IF_TYPE_MTD)
47 		block_dev->op_flag |= BLK_MTD_CONT_WRITE;
48 
49 	ret = blk_dwrite(block_dev, blkstart, blkcnt, buf);
50 	if (!ret)
51 		ret = -EIO;
52 
53 	if (block_dev->if_type == IF_TYPE_MTD)
54 		block_dev->op_flag &= ~(BLK_MTD_CONT_WRITE);
55 	return ret;
56 }
57 
58 static int rkusb_erase_sector(struct ums *ums_dev,
59 			      ulong start, lbaint_t blkcnt)
60 {
61 	struct blk_desc *block_dev = &ums_dev->block_dev;
62 	lbaint_t blkstart = start + ums_dev->start_sector;
63 
64 	return blk_derase(block_dev, blkstart, blkcnt);
65 }
66 
67 static void rkusb_fini(void)
68 {
69 	int i;
70 
71 	for (i = 0; i < g_rkusb->ums_cnt; i++)
72 		free((void *)g_rkusb->ums[i].name);
73 	free(g_rkusb->ums);
74 	g_rkusb->ums = NULL;
75 	g_rkusb->ums_cnt = 0;
76 	g_rkusb = NULL;
77 }
78 
79 #define RKUSB_NAME_LEN 16
80 
81 static int rkusb_init(const char *devtype, const char *devnums_part_str)
82 {
83 	char *s, *t, *devnum_part_str, *name;
84 	struct blk_desc *block_dev;
85 	disk_partition_t info;
86 	int partnum, cnt;
87 	int ret = -1;
88 	struct ums *ums_new;
89 
90 	s = strdup(devnums_part_str);
91 	if (!s)
92 		return -1;
93 
94 	t = s;
95 	g_rkusb->ums_cnt = 0;
96 
97 	for (;;) {
98 		devnum_part_str = strsep(&t, ",");
99 		if (!devnum_part_str)
100 			break;
101 
102 		partnum = blk_get_device_part_str(devtype, devnum_part_str,
103 					&block_dev, &info, 1);
104 		if (partnum < 0)
105 			goto cleanup;
106 
107 		/* f_mass_storage.c assumes SECTOR_SIZE sectors */
108 		if (block_dev->blksz != SECTOR_SIZE)
109 			goto cleanup;
110 
111 		ums_new = realloc(g_rkusb->ums, (g_rkusb->ums_cnt + 1) *
112 				  sizeof(*g_rkusb->ums));
113 		if (!ums_new)
114 			goto cleanup;
115 		g_rkusb->ums = ums_new;
116 		cnt = g_rkusb->ums_cnt;
117 
118 		/* Expose all partitions for rockusb command */
119 		g_rkusb->ums[cnt].start_sector = 0;
120 		g_rkusb->ums[cnt].num_sectors = block_dev->lba;
121 
122 		g_rkusb->ums[cnt].read_sector = rkusb_read_sector;
123 		g_rkusb->ums[cnt].write_sector = rkusb_write_sector;
124 		g_rkusb->ums[cnt].erase_sector = rkusb_erase_sector;
125 
126 		name = malloc(RKUSB_NAME_LEN);
127 		if (!name)
128 			goto cleanup;
129 		snprintf(name, RKUSB_NAME_LEN, "rkusb disk %d", cnt);
130 		g_rkusb->ums[cnt].name = name;
131 		g_rkusb->ums[cnt].block_dev = *block_dev;
132 
133 		printf("RKUSB: LUN %d, dev %d, hwpart %d, sector %#x, count %#x\n",
134 		       g_rkusb->ums_cnt,
135 		       g_rkusb->ums[cnt].block_dev.devnum,
136 		       g_rkusb->ums[cnt].block_dev.hwpart,
137 		       g_rkusb->ums[cnt].start_sector,
138 		       g_rkusb->ums[cnt].num_sectors);
139 
140 		g_rkusb->ums_cnt++;
141 	}
142 
143 	if (g_rkusb->ums_cnt)
144 		ret = 0;
145 
146 cleanup:
147 	free(s);
148 	if (ret < 0)
149 		rkusb_fini();
150 
151 	return ret;
152 }
153 
154 void rkusb_force_to_usb2(bool enable)
155 {
156 	g_rkusb->force_usb2 = enable;
157 }
158 
159 bool rkusb_force_usb2_enabled(void)
160 {
161 	return g_rkusb->force_usb2;
162 }
163 
164 void rkusb_switch_to_usb3_enable(bool enable)
165 {
166 	g_rkusb->switch_usb3 = enable;
167 }
168 
169 bool rkusb_switch_usb3_enabled(void)
170 {
171 	return g_rkusb->switch_usb3;
172 }
173 
174 static int do_rkusb(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
175 {
176 	const char *usb_controller;
177 	const char *devtype;
178 	const char *devnum;
179 	unsigned int controller_index;
180 	int rc;
181 	int cable_ready_timeout __maybe_unused;
182 	const char *s;
183 
184 	if (argc != 4)
185 		return CMD_RET_USAGE;
186 
187 re_enumerate:
188 	usb_controller = argv[1];
189 	devtype = argv[2];
190 	devnum	= argv[3];
191 
192 	if (!strcmp(devtype, "mmc") && !strcmp(devnum, "1")) {
193 		pr_err("Forbid to flash mmc 1(sdcard)\n");
194 		return CMD_RET_FAILURE;
195 	} else if ((!strcmp(devtype, "nvme") || !strcmp(devtype, "scsi")) && !strcmp(devnum, "0")) {
196 		/*
197 		 * Add partnum ":0" to active 'allow_whole_dev' partition
198 		 * search mechanism on multi storage, where there maybe not
199 		 * valid partition table.
200 		 */
201 		devnum = "0:0";
202 	}
203 
204 	g_rkusb = &rkusb;
205 	rc = rkusb_init(devtype, devnum);
206 	if (rc < 0)
207 		return CMD_RET_FAILURE;
208 
209 	if (g_rkusb->ums[0].block_dev.if_type == IF_TYPE_MTD &&
210 	    g_rkusb->ums[0].block_dev.devnum == BLK_MTD_NAND) {
211 #ifdef CONFIG_CMD_GO
212 		pr_err("Enter bootrom rockusb...\n");
213 		flushc();
214 		run_command("rbrom", 0);
215 #else
216 		pr_err("rockusb: count not support loader upgrade!\n");
217 #endif
218 	}
219 
220 	controller_index = (unsigned int)(simple_strtoul(
221 				usb_controller,	NULL, 0));
222 	rc = usb_gadget_initialize(controller_index);
223 	if (rc) {
224 		pr_err("Couldn't init USB controller.");
225 		rc = CMD_RET_FAILURE;
226 		goto cleanup_rkusb;
227 	}
228 
229 	rc = fsg_init(g_rkusb->ums, g_rkusb->ums_cnt);
230 	if (rc) {
231 		pr_err("fsg_init failed");
232 		rc = CMD_RET_FAILURE;
233 		goto cleanup_board;
234 	}
235 
236 	if (rkusb_switch_usb3_enabled()) {
237 		/* Maskrom usb3 serialnumber get from upgrade tool */
238 		rkusb_switch_to_usb3_enable(false);
239 	} else {
240 		s = env_get("serial#");
241 		if (s) {
242 			char *sn = (char *)calloc(strlen(s) + 1, sizeof(char));
243 			char *sn_p = sn;
244 
245 			if (!sn)
246 				goto cleanup_board;
247 
248 			memcpy(sn, s, strlen(s));
249 			while (*sn_p) {
250 				if (*sn_p == '\\' || *sn_p == '/')
251 					*sn_p = '_';
252 				sn_p++;
253 			}
254 
255 			g_dnl_set_serialnumber(sn);
256 			free(sn);
257 #if defined(CONFIG_SUPPORT_USBPLUG)
258 		} else {
259 			char sn[9] = "Rockchip";
260 
261 			g_dnl_set_serialnumber(sn);
262 #endif
263 		}
264 	}
265 
266 	rc = g_dnl_register("rkusb_ums_dnl");
267 	if (rc) {
268 		pr_err("g_dnl_register failed");
269 		rc = CMD_RET_FAILURE;
270 		goto cleanup_board;
271 	}
272 
273 	/* Timeout unit: seconds */
274 	cable_ready_timeout = UMS_CABLE_READY_TIMEOUT;
275 
276 	if (!g_dnl_board_usb_cable_connected()) {
277 		puts("Please connect USB cable.\n");
278 
279 		while (!g_dnl_board_usb_cable_connected()) {
280 			if (ctrlc()) {
281 				puts("\rCTRL+C - Operation aborted.\n");
282 				rc = CMD_RET_SUCCESS;
283 				goto cleanup_register;
284 			}
285 			if (!cable_ready_timeout) {
286 				puts("\rUSB cable not detected.\nCommand exit.\n");
287 				rc = CMD_RET_SUCCESS;
288 				goto cleanup_register;
289 			}
290 
291 			printf("\rAuto exit in: %.2d s.", cable_ready_timeout);
292 			mdelay(1000);
293 			cable_ready_timeout--;
294 		}
295 		puts("\r\n");
296 	}
297 
298 	while (1) {
299 		usb_gadget_handle_interrupts(controller_index);
300 
301 		rc = fsg_main_thread(NULL);
302 		if (rc) {
303 			if (rc == -ENODEV && rkusb_usb3_capable() &&
304 			    !rkusb_force_usb2_enabled()) {
305 				printf("wait for usb3 connect timeout\n");
306 				rkusb_force_to_usb2(true);
307 				g_dnl_unregister();
308 				usb_gadget_release(controller_index);
309 				rkusb_fini();
310 				goto re_enumerate;
311 			}
312 
313 			/* Check I/O error */
314 			if (rc == -EIO)
315 				printf("\rCheck USB cable connection\n");
316 
317 			/* Check CTRL+C */
318 			if (rc == -EPIPE)
319 				printf("\rCTRL+C - Operation aborted\n");
320 
321 			rc = CMD_RET_SUCCESS;
322 			goto cleanup_register;
323 		}
324 
325 		if (rkusb_switch_usb3_enabled()) {
326 			printf("rockusb switch to usb3\n");
327 			g_dnl_unregister();
328 			usb_gadget_release(controller_index);
329 			rkusb_fini();
330 			goto re_enumerate;
331 		}
332 	}
333 
334 cleanup_register:
335 	g_dnl_unregister();
336 cleanup_board:
337 	usb_gadget_release(controller_index);
338 cleanup_rkusb:
339 	rkusb_fini();
340 
341 	return rc;
342 }
343 
344 U_BOOT_CMD_ALWAYS(rockusb, 4, 1, do_rkusb,
345 		  "Use the rockusb Protocol",
346 		  "<USB_controller> <devtype> <dev[:part]>  e.g. rockusb 0 mmc 0\n"
347 );
348