initial commit
[freebsd-arm:freebsd-arm.git] / boot / uboot / lib / glue.c
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$");
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. */
44 extern long uboot_address;
45
46 /* crc32 stuff stolen from lib/libdisk/write_ia64_disk.c */
47 static 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
93 static uint32_t
94 crc32(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
109 static int
110 valid_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  */
138 int
139 api_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 + 0x00300000 - 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
170 int
171 ub_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
181 int
182 ub_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
192 void
193 ub_putc(char c)
194 {
195
196         syscall(API_PUTC, NULL, (uint32_t)&c);
197 }
198
199 void
200 ub_puts(const char *s)
201 {
202
203         syscall(API_PUTS, NULL, (uint32_t)s);
204 }
205
206 /****************************************
207  *
208  * system
209  *
210  ****************************************/
211
212 void
213 ub_reset(void)
214 {
215
216         syscall(API_RESET, NULL);
217 }
218
219 static struct mem_region mr[UB_MAX_MR];
220 static struct sys_info si;
221
222 struct sys_info *
223 ub_get_sys_info(void)
224 {
225         int err = 0;
226
227         memset(&si, 0, sizeof(struct sys_info));
228         si.mr = mr;
229         si.mr_no = UB_MAX_MR;
230         memset(&mr, 0, sizeof(mr));
231
232         if (!syscall(API_GET_SYS_INFO, &err, (u_int32_t)&si))
233                 return (NULL);
234
235         return ((err) ? NULL : &si);
236 }
237
238
239 /****************************************
240  *
241  * timing
242  *
243  ****************************************/
244
245 void
246 ub_udelay(unsigned long usec)
247 {
248
249         syscall(API_UDELAY, NULL, &usec);
250 }
251
252 unsigned long
253 ub_get_timer(unsigned long base)
254 {
255         unsigned long cur;
256
257         if (!syscall(API_GET_TIMER, NULL, &cur, &base))
258                 return (0);
259
260         return (cur);
261 }
262
263
264 /****************************************************************************
265  *
266  * devices
267  *
268  * Devices are identified by handles: numbers 0, 1, 2, ..., UB_MAX_DEV-1
269  *
270  ***************************************************************************/
271
272 static struct device_info devices[UB_MAX_DEV];
273
274 struct device_info *
275 ub_dev_get(int i)
276 {
277
278         return ((i < 0 || i >= UB_MAX_DEV) ? NULL : &devices[i]);
279 }
280
281 /*
282  * Enumerates the devices: fills out device_info elements in the devices[]
283  * array.
284  *
285  * returns:             number of devices found
286  */
287 int
288 ub_dev_enum(void)
289 {
290         struct device_info *di;
291         int n = 0;
292
293         memset(&devices, 0, sizeof(struct device_info) * UB_MAX_DEV);
294         di = &devices[0];
295
296         if (!syscall(API_DEV_ENUM, NULL, di))
297                 return (0);
298
299         while (di->cookie != NULL) {
300
301                 if (++n >= UB_MAX_DEV)
302                         break;
303
304                 /* take another device_info */
305                 di++;
306
307                 /* pass on the previous cookie */
308                 di->cookie = devices[n - 1].cookie;
309
310                 if (!syscall(API_DEV_ENUM, NULL, di))
311                         return (0);
312         }
313
314         return (n);
315 }
316
317
318 /*
319  * handle:      0-based id of the device
320  *
321  * returns:     0 when OK, err otherwise
322  */
323 int
324 ub_dev_open(int handle)
325 {
326         struct device_info *di;
327         int err = 0;
328
329         if (handle < 0 || handle >= UB_MAX_DEV)
330                 return (API_EINVAL);
331
332         di = &devices[handle];
333         if (!syscall(API_DEV_OPEN, &err, di))
334                 return (-1);
335
336         return (err);
337 }
338
339 int
340 ub_dev_close(int handle)
341 {
342         struct device_info *di;
343
344         if (handle < 0 || handle >= UB_MAX_DEV)
345                 return (API_EINVAL);
346
347         di = &devices[handle];
348         if (!syscall(API_DEV_CLOSE, NULL, di))
349                 return (-1);
350
351         return (0);
352 }
353
354 /*
355  * Validates device for read/write, it has to:
356  *
357  * - have sane handle
358  * - be opened
359  *
360  * returns:     0/1 accordingly
361  */
362 static int
363 dev_valid(int handle)
364 {
365
366         if (handle < 0 || handle >= UB_MAX_DEV)
367                 return (0);
368
369         if (devices[handle].state != DEV_STA_OPEN)
370                 return (0);
371
372         return (1);
373 }
374
375 static int
376 dev_stor_valid(int handle)
377 {
378
379         if (!dev_valid(handle))
380                 return (0);
381
382         if (!(devices[handle].type & DEV_TYP_STOR))
383                 return (0);
384
385         return (1);
386 }
387
388 int
389 ub_dev_read(int handle, void *buf, lbasize_t len, lbastart_t start,
390     lbasize_t *rlen)
391 {
392         struct device_info *di;
393         lbasize_t act_len;
394         int err = 0;
395
396         if (!dev_stor_valid(handle))
397                 return (API_ENODEV);
398
399         di = &devices[handle];
400         if (!syscall(API_DEV_READ, &err, di, buf, &len, &start, &act_len))
401                 return (API_ESYSC);
402
403         if (!err && rlen)
404                 *rlen = act_len;
405
406         return (err);
407 }
408
409 static int
410 dev_net_valid(int handle)
411 {
412
413         if (!dev_valid(handle))
414                 return (0);
415
416         if (devices[handle].type != DEV_TYP_NET)
417                 return (0);
418
419         return (1);
420 }
421
422 int
423 ub_dev_recv(int handle, void *buf, int len, int *rlen)
424 {
425         struct device_info *di;
426         int err = 0, act_len;
427
428         if (!dev_net_valid(handle))
429                 return (API_ENODEV);
430
431         di = &devices[handle];
432         if (!syscall(API_DEV_READ, &err, di, buf, &len, &act_len))
433                 return (API_ESYSC);
434
435         if (!err)
436                 *rlen = act_len;
437
438         return (err);
439 }
440
441 int
442 ub_dev_send(int handle, void *buf, int len)
443 {
444         struct device_info *di;
445         int err = 0;
446
447         if (!dev_net_valid(handle))
448                 return (API_ENODEV);
449
450         di = &devices[handle];
451         if (!syscall(API_DEV_WRITE, &err, di, buf, &len))
452                 return (API_ESYSC);
453
454         return (err);
455 }
456
457 char *
458 ub_stor_type(int type)
459 {
460
461         if (type & DT_STOR_IDE)
462                 return ("IDE");
463
464         if (type & DT_STOR_SCSI)
465                 return ("SCSI");
466
467         if (type & DT_STOR_USB)
468                 return ("USB");
469
470         if (type & DT_STOR_MMC)
471                 return ("MMC");
472
473         return ("Unknown");
474 }
475
476 char *
477 ub_mem_type(int flags)
478 {
479
480         switch (flags & 0x000F) {
481         case MR_ATTR_FLASH:
482                 return ("FLASH");
483         case MR_ATTR_DRAM:
484                 return ("DRAM");
485         case MR_ATTR_SRAM:
486                 return ("SRAM");
487         default:
488                 return ("Unknown");
489         }
490 }
491
492 void
493 ub_dump_di(int handle)
494 {
495         struct device_info *di = ub_dev_get(handle);
496         int i;
497
498         printf("device info (%d):\n", handle);
499         printf("  cookie\t= 0x%08x\n", (uint32_t)di->cookie);
500         printf("  type\t\t= 0x%08x\n", di->type);
501
502         if (di->type == DEV_TYP_NET) {
503                 printf("  hwaddr\t= ");
504                 for (i = 0; i < 6; i++)
505                         printf("%02x ", di->di_net.hwaddr[i]);
506
507                 printf("\n");
508
509         } else if (di->type & DEV_TYP_STOR) {
510                 printf("  type\t\t= %s\n", ub_stor_type(di->type));
511                 printf("  blk size\t\t= %ld\n", di->di_stor.block_size);
512                 printf("  blk count\t\t= %ld\n", di->di_stor.block_count);
513         }
514 }
515
516 void
517 ub_dump_si(struct sys_info *si)
518 {
519         int i;
520
521         printf("sys info:\n");
522         printf("  clkbus\t= %ld MHz\n", si->clk_bus / 1000 / 1000);
523         printf("  clkcpu\t= %ld MHz\n", si->clk_cpu / 1000 / 1000);
524         printf("  bar\t\t= 0x%08lx\n", si->bar);
525
526         printf("---\n");
527         for (i = 0; i < si->mr_no; i++) {
528                 if (si->mr[i].flags == 0)
529                         break;
530
531                 printf("  start\t= 0x%08lx\n", si->mr[i].start);
532                 printf("  size\t= 0x%08lx\n", si->mr[i].size);
533                 printf("  type\t= %s\n", ub_mem_type(si->mr[i].flags));
534                 printf("---\n");
535         }
536 }
537
538 /****************************************
539  *
540  * env vars
541  *
542  ****************************************/
543
544 char *
545 ub_env_get(const char *name)
546 {
547         char *value;
548
549         if (!syscall(API_ENV_GET, NULL, (uint32_t)name, (uint32_t)&value))
550                 return (NULL);
551
552         return (value);
553 }
554
555 void
556 ub_env_set(const char *name, char *value)
557 {
558
559         syscall(API_ENV_SET, NULL, (uint32_t)name, (uint32_t)value);
560 }
561
562
563 static char env_name[256];
564
565 const char *
566 ub_env_enum(const char *last)
567 {
568         const char *env, *str;
569         int i;
570
571         /*
572          * It's OK to pass only the name piece as last (and not the whole
573          * 'name=val' string), since the API_ENUM_ENV call uses envmatch()
574          * internally, which handles such case
575          */
576         env = NULL;
577         if (syscall(API_ENV_ENUM, NULL, (uint32_t)last, (uint32_t)&env) != 0)
578                 return (NULL);
579
580         if (env == NULL)
581                 /* no more env. variables to enumerate */
582                 return (NULL);
583
584         /* next enumerated env var */
585         memset(env_name, 0, 256);
586         for (i = 0, str = env; *str != '=' && *str != '\0';)
587                 env_name[i++] = *str++;
588
589         env_name[i] = '\0';
590
591         return (env_name);
592 }