glue.c revision 182732 
1/*-
2 * Copyright (c) 2007-2008 Semihalf, Rafal Jaworowski <raj@semihalf.com>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: head/sys/boot/uboot/lib/glue.c 182732 2008-09-03 17:48:41Z raj $");
29
30#include <stand.h>
31#include "api_public.h"
32#include "glue.h"
33
34#define DEBUG
35#undef DEBUG
36
37#ifdef DEBUG
38#define	debugf(fmt, args...) do { printf("%s(): ", __func__); printf(fmt,##args); } while (0)
39#else
40#define	debugf(fmt, args...)
41#endif
42
43/* Some random address used by U-Boot. */
44extern long uboot_address;
45
46/* crc32 stuff stolen from lib/libdisk/write_ia64_disk.c */
47static uint32_t crc32_tab[] = {
48	0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
49	0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
50	0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
51	0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
52	0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
53	0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
54	0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
55	0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
56	0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
57	0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
58	0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
59	0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
60	0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
61	0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
62	0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
63	0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
64	0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
65	0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
66	0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
67	0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
68	0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
69	0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
70	0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
71	0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
72	0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
73	0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
74	0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
75	0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
76	0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
77	0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
78	0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
79	0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
80	0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
81	0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
82	0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
83	0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
84	0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
85	0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
86	0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
87	0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
88	0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
89	0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
90	0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
91};
92
93static uint32_t
94crc32(const void *buf, size_t size)
95{
96	const uint8_t *p;
97	uint32_t crc;
98
99	p = buf;
100	crc = ~0U;
101
102	while (size--)
103		crc = crc32_tab[(crc ^ *p++) & 0xFF] ^ (crc >> 8);
104
105	return (crc ^ ~0U);
106}
107
108
109static int
110valid_sig(struct api_signature *sig)
111{
112	uint32_t checksum;
113	struct api_signature s;
114
115	if (sig == NULL)
116		return (0);
117	/*
118	 * Clear the checksum field (in the local copy) so as to calculate the
119	 * CRC with the same initial contents as at the time when the sig was
120	 * produced
121	 */
122	s = *sig;
123	s.checksum = 0;
124
125	checksum = crc32((void *)&s, sizeof(struct api_signature));
126
127	if (checksum != sig->checksum)
128		return (0);
129
130	return (1);
131}
132
133/*
134 * Searches for the U-Boot API signature
135 *
136 * returns 1/0 depending on found/not found result
137 */
138int
139api_search_sig(struct api_signature **sig)
140{
141	unsigned char *sp, *spend;
142
143	if (sig == NULL)
144		return (0);
145
146	if (uboot_address == 0)
147		uboot_address = 255 * 1024 * 1024;
148
149	sp = (void *)(uboot_address & ~0x000fffff);
150	spend = sp + 0x00100000 - API_SIG_MAGLEN;
151	while (sp < spend) {
152		if (!bcmp(sp, API_SIG_MAGIC, API_SIG_MAGLEN)) {
153			*sig = (struct api_signature *)sp;
154			if (valid_sig(*sig))
155				return (1);
156		}
157		sp += API_SIG_MAGLEN;
158	}
159
160	*sig = NULL;
161	return (0);
162}
163
164/****************************************
165 *
166 * console
167 *
168 ****************************************/
169
170int
171ub_getc(void)
172{
173	int c;
174
175	if (!syscall(API_GETC, NULL, (uint32_t)&c))
176		return (-1);
177
178	return (c);
179}
180
181int
182ub_tstc(void)
183{
184	int t;
185
186	if (!syscall(API_TSTC, NULL, (uint32_t)&t))
187		return (-1);
188
189	return (t);
190}
191
192void
193ub_putc(char c)
194{
195
196	syscall(API_PUTC, NULL, (uint32_t)&c);
197}
198
199void
200ub_puts(const char *s)
201{
202
203	syscall(API_PUTS, NULL, (uint32_t)s);
204}
205
206/****************************************
207 *
208 * system
209 *
210 ****************************************/
211
212void
213ub_reset(void)
214{
215
216	syscall(API_RESET, NULL);
217}
218
219
220#define	MR_MAX 5
221static struct mem_region mr[MR_MAX];
222static struct sys_info si;
223
224struct sys_info *
225ub_get_sys_info(void)
226{
227	int err = 0;
228
229	memset(&si, 0, sizeof(struct sys_info));
230	si.mr = mr;
231	si.mr_no = MR_MAX;
232	memset(&mr, 0, sizeof(mr));
233
234	if (!syscall(API_GET_SYS_INFO, &err, (u_int32_t)&si))
235		return (NULL);
236
237	return ((err) ? NULL : &si);
238}
239
240
241/****************************************
242 *
243 * timing
244 *
245 ****************************************/
246
247void
248ub_udelay(unsigned long usec)
249{
250
251	syscall(API_UDELAY, NULL, &usec);
252}
253
254unsigned long
255ub_get_timer(unsigned long base)
256{
257	unsigned long cur;
258
259	if (!syscall(API_GET_TIMER, NULL, &cur, &base))
260		return (0);
261
262	return (cur);
263}
264
265
266/****************************************************************************
267 *
268 * devices
269 *
270 * Devices are identified by handles: numbers 0, 1, 2, ..., MAX_DEVS-1
271 *
272 ***************************************************************************/
273
274#define	MAX_DEVS 6
275
276static struct device_info devices[MAX_DEVS];
277
278struct device_info *
279ub_dev_get(int i)
280{
281
282	return ((i < 0 || i >= MAX_DEVS) ? NULL : &devices[i]);
283}
284
285/*
286 * Enumerates the devices: fills out device_info elements in the devices[]
287 * array.
288 *
289 * returns:		number of devices found
290 */
291int
292ub_dev_enum(void)
293{
294	struct device_info *di;
295	int n = 0;
296
297	memset(&devices, 0, sizeof(struct device_info) * MAX_DEVS);
298	di = &devices[0];
299
300	if (!syscall(API_DEV_ENUM, NULL, di))
301		return (0);
302
303	while (di->cookie != NULL) {
304
305		if (++n >= MAX_DEVS)
306			break;
307
308		/* take another device_info */
309		di++;
310
311		/* pass on the previous cookie */
312		di->cookie = devices[n - 1].cookie;
313
314		if (!syscall(API_DEV_ENUM, NULL, di))
315			return (0);
316	}
317
318	return (n);
319}
320
321
322/*
323 * handle:	0-based id of the device
324 *
325 * returns:	0 when OK, err otherwise
326 */
327int
328ub_dev_open(int handle)
329{
330	struct device_info *di;
331	int err = 0;
332
333	if (handle < 0 || handle >= MAX_DEVS)
334		return (API_EINVAL);
335
336	di = &devices[handle];
337	if (!syscall(API_DEV_OPEN, &err, di))
338		return (-1);
339
340	return (err);
341}
342
343int
344ub_dev_close(int handle)
345{
346	struct device_info *di;
347
348	if (handle < 0 || handle >= MAX_DEVS)
349		return (API_EINVAL);
350
351	di = &devices[handle];
352	if (!syscall(API_DEV_CLOSE, NULL, di))
353		return (-1);
354
355	return (0);
356}
357
358/*
359 * Validates device for read/write, it has to:
360 *
361 * - have sane handle
362 * - be opened
363 *
364 * returns:	0/1 accordingly
365 */
366static int
367dev_valid(int handle)
368{
369
370	if (handle < 0 || handle >= MAX_DEVS)
371		return (0);
372
373	if (devices[handle].state != DEV_STA_OPEN)
374		return (0);
375
376	return (1);
377}
378
379static int
380dev_stor_valid(int handle)
381{
382
383	if (!dev_valid(handle))
384		return (0);
385
386	if (!(devices[handle].type & DEV_TYP_STOR))
387		return (0);
388
389	return (1);
390}
391
392int
393ub_dev_read(int handle, void *buf, lbasize_t len, lbastart_t start)
394{
395	struct device_info *di;
396	lbasize_t act_len;
397	int err = 0;
398
399	if (!dev_stor_valid(handle))
400		return (API_ENODEV);
401
402	di = &devices[handle];
403	if (!syscall(API_DEV_READ, &err, di, buf, &len, &start, &act_len))
404		return (-1);
405
406	if (err)
407		return (err);
408
409	if (act_len != len)
410		return (API_EIO);
411
412	return (0);
413}
414
415static int
416dev_net_valid(int handle)
417{
418
419	if (!dev_valid(handle))
420		return (0);
421
422	if (devices[handle].type != DEV_TYP_NET)
423		return (0);
424
425	return (1);
426}
427
428int
429ub_dev_recv(int handle, void *buf, int len)
430{
431	struct device_info *di;
432	int err = 0, act_len;
433
434	if (!dev_net_valid(handle))
435		return (API_ENODEV);
436
437	di = &devices[handle];
438	if (!syscall(API_DEV_READ, &err, di, buf, &len, &act_len))
439		return (-1);
440
441	if (err)
442		return (-1);
443
444	return (act_len);
445}
446
447int
448ub_dev_send(int handle, void *buf, int len)
449{
450	struct device_info *di;
451	int err = 0;
452
453	if (!dev_net_valid(handle))
454		return (API_ENODEV);
455
456	di = &devices[handle];
457	if (!syscall(API_DEV_WRITE, &err, di, buf, &len))
458		return (-1);
459
460	return (err);
461}
462
463static char *
464ub_stor_type(int type)
465{
466
467	if (type & DT_STOR_IDE)
468		return ("IDE");
469
470	if (type & DT_STOR_SCSI)
471		return ("SCSI");
472
473	if (type & DT_STOR_USB)
474		return ("USB");
475
476	if (type & DT_STOR_MMC);
477		return ("MMC");
478
479	return ("Unknown");
480}
481
482char *
483ub_mem_type(int flags)
484{
485
486	switch(flags & 0x000F) {
487	case MR_ATTR_FLASH:
488		return ("FLASH");
489	case MR_ATTR_DRAM:
490		return ("DRAM");
491	case MR_ATTR_SRAM:
492		return ("SRAM");
493	default:
494		return ("Unknown");
495	}
496}
497
498void
499ub_dump_di(int handle)
500{
501	struct device_info *di = ub_dev_get(handle);
502	int i;
503
504	printf("device info (%d):\n", handle);
505	printf("  cookie\t= 0x%08x\n", (uint32_t)di->cookie);
506	printf("  type\t\t= 0x%08x\n", di->type);
507
508	if (di->type == DEV_TYP_NET) {
509		printf("  hwaddr\t= ");
510		for (i = 0; i < 6; i++)
511			printf("%02x ", di->di_net.hwaddr[i]);
512
513		printf("\n");
514
515	} else if (di->type & DEV_TYP_STOR) {
516		printf("  type\t\t= %s\n", ub_stor_type(di->type));
517		printf("  blk size\t\t= %ld\n", di->di_stor.block_size);
518		printf("  blk count\t\t= %ld\n", di->di_stor.block_count);
519	}
520}
521
522void
523ub_dump_si(struct sys_info *si)
524{
525	int i;
526
527	printf("sys info:\n");
528	printf("  clkbus\t= %ld MHz\n", si->clk_bus / 1000 / 1000);
529	printf("  clkcpu\t= %ld MHz\n", si->clk_cpu / 1000 / 1000);
530	printf("  bar\t\t= 0x%08lx\n", si->bar);
531
532	printf("---\n");
533	for (i = 0; i < si->mr_no; i++) {
534		if (si->mr[i].flags == 0)
535			break;
536
537		printf("  start\t= 0x%08lx\n", si->mr[i].start);
538		printf("  size\t= 0x%08lx\n", si->mr[i].size);
539		printf("  type\t= %s\n", ub_mem_type(si->mr[i].flags));
540		printf("---\n");
541	}
542}
543
544/****************************************
545 *
546 * env vars
547 *
548 ****************************************/
549
550char *
551ub_env_get(const char *name)
552{
553	char *value;
554
555	if (!syscall(API_ENV_GET, NULL, (uint32_t)name, (uint32_t)&value))
556		return (NULL);
557
558	return (value);
559}
560
561void
562ub_env_set(const char *name, char *value)
563{
564
565	syscall(API_ENV_SET, NULL, (uint32_t)name, (uint32_t)value);
566}
567
568
569static char env_name[256];
570
571const char *
572ub_env_enum(const char *last)
573{
574	const char *env, *str;
575	int i;
576
577	env = NULL;
578
579	/*
580	 * It's OK to pass only the name piece as last (and not the whole
581	 * 'name=val' string), since the API_ENUM_ENV call uses envmatch()
582	 * internally, which handles such case
583	 */
584	if (!syscall(API_ENV_ENUM, NULL, (uint32_t)last, (uint32_t)&env))
585		return (NULL);
586
587	if (!env)
588		/* no more env. variables to enumerate */
589		return (NULL);
590#if 0
591	if (last && strncmp(env, last, strlen(last)) == 0);
592		/* error, trying to enumerate non existing env. variable */
593		return NULL;
594#endif
595
596	/* next enumerated env var */
597	memset(env_name, 0, 256);
598	for (i = 0, str = env; *str != '=' && *str != '\0';)
599		env_name[i++] = *str++;
600
601	env_name[i] = '\0';
602
603	return (env_name);
604}
605