xref: /freebsd/stand/uboot/uboot_disk.c (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1 /*-
2  * Copyright (c) 2008 Semihalf, Rafal Jaworowski
3  * Copyright (c) 2009 Semihalf, Piotr Ziecik
4  * Copyright (c) 2012 Andrey V. Elsukov <ae@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  */
29 
30 /*
31  * Block storage I/O routines for U-Boot
32  */
33 
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 
37 #include <sys/param.h>
38 #include <sys/disk.h>
39 #include <machine/stdarg.h>
40 #include <stand.h>
41 
42 #include "api_public.h"
43 #include "bootstrap.h"
44 #include "disk.h"
45 #include "glue.h"
46 #include "libuboot.h"
47 
48 #define stor_printf(fmt, args...) do {			\
49     printf("%s%d: ", dev->dd.d_dev->dv_name, dev->dd.d_unit);	\
50     printf(fmt, ##args);				\
51 } while (0)
52 
53 #ifdef DEBUG
54 #define debugf(fmt, args...) do { printf("%s(): ", __func__);	\
55     printf(fmt,##args); } while (0)
56 #else
57 #define debugf(fmt, args...)
58 #endif
59 
60 static struct {
61 	int		opened;	/* device is opened */
62 	int		handle;	/* storage device handle */
63 	int		type;	/* storage type */
64 	off_t		blocks;	/* block count */
65 	u_int		bsize;	/* block size */
66 } stor_info[UB_MAX_DEV];
67 
68 #define	SI(dev)		(stor_info[(dev)->dd.d_unit])
69 
70 static int stor_info_no = 0;
71 static int stor_opendev(struct disk_devdesc *);
72 static int stor_readdev(struct disk_devdesc *, daddr_t, size_t, char *);
73 
74 /* devsw I/F */
75 static int stor_init(void);
76 static int stor_strategy(void *, int, daddr_t, size_t, char *, size_t *);
77 static int stor_open(struct open_file *, ...);
78 static int stor_close(struct open_file *);
79 static int stor_ioctl(struct open_file *f, u_long cmd, void *data);
80 static int stor_print(int);
81 static void stor_cleanup(void);
82 
83 struct devsw uboot_storage = {
84 	.dv_name = "disk",
85 	.dv_type = DEVT_DISK,
86 	.dv_init = stor_init,
87 	.dv_strategy = stor_strategy,
88 	.dv_open = stor_open,
89 	.dv_close = stor_close,
90 	.dv_ioctl = stor_ioctl,
91 	.dv_print = stor_print,
92 	.dv_cleanup = stor_cleanup,
93 	.dv_fmtdev = disk_fmtdev,
94 };
95 
96 static int
97 stor_init(void)
98 {
99 	struct device_info *di;
100 	int i;
101 
102 	if (devs_no == 0) {
103 		printf("No U-Boot devices! Really enumerated?\n");
104 		return (-1);
105 	}
106 
107 	for (i = 0; i < devs_no; i++) {
108 		di = ub_dev_get(i);
109 		if ((di != NULL) && (di->type & DEV_TYP_STOR)) {
110 			if (stor_info_no >= UB_MAX_DEV) {
111 				printf("Too many storage devices: %d\n",
112 				    stor_info_no);
113 				return (-1);
114 			}
115 			stor_info[stor_info_no].handle = i;
116 			stor_info[stor_info_no].opened = 0;
117 			stor_info[stor_info_no].type = di->type;
118 			stor_info[stor_info_no].blocks =
119 			    di->di_stor.block_count;
120 			stor_info[stor_info_no].bsize =
121 			    di->di_stor.block_size;
122 			stor_info_no++;
123 		}
124 	}
125 
126 	if (!stor_info_no) {
127 		debugf("No storage devices\n");
128 		return (-1);
129 	}
130 
131 	debugf("storage devices found: %d\n", stor_info_no);
132 	return (0);
133 }
134 
135 static void
136 stor_cleanup(void)
137 {
138 	int i;
139 
140 	for (i = 0; i < stor_info_no; i++)
141 		if (stor_info[i].opened > 0)
142 			ub_dev_close(stor_info[i].handle);
143 }
144 
145 static int
146 stor_strategy(void *devdata, int rw, daddr_t blk, size_t size,
147     char *buf, size_t *rsize)
148 {
149 	struct disk_devdesc *dev = (struct disk_devdesc *)devdata;
150 	daddr_t bcount;
151 	int err;
152 
153 	rw &= F_MASK;
154 	if (rw != F_READ) {
155 		stor_printf("write attempt, operation not supported!\n");
156 		return (EROFS);
157 	}
158 
159 	if (size % SI(dev).bsize) {
160 		stor_printf("size=%zu not multiple of device "
161 		    "block size=%d\n",
162 		    size, SI(dev).bsize);
163 		return (EIO);
164 	}
165 	bcount = size / SI(dev).bsize;
166 	if (rsize)
167 		*rsize = 0;
168 
169 	err = stor_readdev(dev, blk + dev->d_offset, bcount, buf);
170 	if (!err && rsize)
171 		*rsize = size;
172 
173 	return (err);
174 }
175 
176 static int
177 stor_open(struct open_file *f, ...)
178 {
179 	va_list ap;
180 	struct disk_devdesc *dev;
181 
182 	va_start(ap, f);
183 	dev = va_arg(ap, struct disk_devdesc *);
184 	va_end(ap);
185 
186 	return (stor_opendev(dev));
187 }
188 
189 static int
190 stor_opendev(struct disk_devdesc *dev)
191 {
192 	int err;
193 
194 	if (dev->dd.d_unit < 0 || dev->dd.d_unit >= stor_info_no)
195 		return (EIO);
196 
197 	if (SI(dev).opened == 0) {
198 		err = ub_dev_open(SI(dev).handle);
199 		if (err != 0) {
200 			stor_printf("device open failed with error=%d, "
201 			    "handle=%d\n", err, SI(dev).handle);
202 			return (ENXIO);
203 		}
204 		SI(dev).opened++;
205 	}
206 	return (disk_open(dev, SI(dev).blocks * SI(dev).bsize,
207 	    SI(dev).bsize));
208 }
209 
210 static int
211 stor_close(struct open_file *f)
212 {
213 	struct disk_devdesc *dev;
214 
215 	dev = (struct disk_devdesc *)(f->f_devdata);
216 	return (disk_close(dev));
217 }
218 
219 static int
220 stor_readdev(struct disk_devdesc *dev, daddr_t blk, size_t size, char *buf)
221 {
222 	lbasize_t real_size;
223 	int err;
224 
225 	debugf("reading blk=%d size=%d @ 0x%08x\n", (int)blk, size, (uint32_t)buf);
226 
227 	err = ub_dev_read(SI(dev).handle, buf, size, blk, &real_size);
228 	if (err != 0) {
229 		stor_printf("read failed, error=%d\n", err);
230 		return (EIO);
231 	}
232 
233 	if (real_size != size) {
234 		stor_printf("real size != size\n");
235 		err = EIO;
236 	}
237 
238 	return (err);
239 }
240 
241 static int
242 stor_print(int verbose)
243 {
244 	struct disk_devdesc dev;
245 	static char line[80];
246 	int i, ret = 0;
247 
248 	if (stor_info_no == 0)
249 		return (ret);
250 
251 	printf("%s devices:", uboot_storage.dv_name);
252 	if ((ret = pager_output("\n")) != 0)
253 		return (ret);
254 
255 	for (i = 0; i < stor_info_no; i++) {
256 		dev.dd.d_dev = &uboot_storage;
257 		dev.dd.d_unit = i;
258 		dev.d_slice = D_SLICENONE;
259 		dev.d_partition = D_PARTNONE;
260 		snprintf(line, sizeof(line), "\tdisk%d (%s)\n", i,
261 		    ub_stor_type(SI(&dev).type));
262 		if ((ret = pager_output(line)) != 0)
263 			break;
264 		if (stor_opendev(&dev) == 0) {
265 			sprintf(line, "\tdisk%d", i);
266 			ret = disk_print(&dev, line, verbose);
267 			disk_close(&dev);
268 			if (ret != 0)
269 				break;
270 		}
271 	}
272 	return (ret);
273 }
274 
275 static int
276 stor_ioctl(struct open_file *f, u_long cmd, void *data)
277 {
278 	struct disk_devdesc *dev;
279 	int rc;
280 
281 	dev = (struct disk_devdesc *)f->f_devdata;
282 	rc = disk_ioctl(dev, cmd, data);
283 	if (rc != ENOTTY)
284 		return (rc);
285 
286 	switch (cmd) {
287 	case DIOCGSECTORSIZE:
288 		*(u_int *)data = SI(dev).bsize;
289 		break;
290 	case DIOCGMEDIASIZE:
291 		*(uint64_t *)data = SI(dev).bsize * SI(dev).blocks;
292 		break;
293 	default:
294 		return (ENOTTY);
295 	}
296 	return (0);
297 }
298 
299 
300 /*
301  * Return the device unit number for the given type and type-relative unit
302  * number.
303  */
304 int
305 uboot_diskgetunit(int type, int type_unit)
306 {
307 	int local_type_unit;
308 	int i;
309 
310 	local_type_unit = 0;
311 	for (i = 0; i < stor_info_no; i++) {
312 		if ((stor_info[i].type & type) == type) {
313 			if (local_type_unit == type_unit) {
314 				return (i);
315 			}
316 			local_type_unit++;
317 		}
318 	}
319 
320 	return (-1);
321 }
322