2 * prom.c - Routines for talking to the Open Firmware PROM
4 * Copyright (C) 2001, 2002 Ethan Benson
6 * Copyright (C) 1999 Benjamin Herrenschmidt
8 * Copyright (C) 1999 Marius Vollmer
10 * Copyright (C) 1996 Paul Mackerras.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 #include "asm/processor.h"
38 #define READ_BLOCKS_USE_READ 1
42 ihandle prom_stdin, prom_stdout;
44 //extern int vsprintf(char *buf, const char *fmt, va_list args);
46 static ihandle prom_mem, prom_mmu;
47 static ihandle prom_chosen, prom_options;
57 call_prom (const char *service, int nargs, int nret, ...)
61 struct prom_args prom_args;
63 prom_args.service = service;
64 prom_args.nargs = nargs;
65 prom_args.nret = nret;
66 va_start (list, nret);
67 for (i = 0; i < nargs; ++i)
68 prom_args.args[i] = va_arg(list, void *);
70 for (i = 0; i < nret; ++i)
71 prom_args.args[i + nargs] = 0;
74 return prom_args.args[nargs];
80 call_prom_return (const char *service, int nargs, int nret, ...)
85 struct prom_args prom_args;
87 prom_args.service = service;
88 prom_args.nargs = nargs;
89 prom_args.nret = nret;
90 va_start (list, nret);
91 for (i = 0; i < nargs; ++i)
92 prom_args.args[i] = va_arg(list, void *);
93 for (i = 0; i < nret; ++i)
94 prom_args.args[i + nargs] = 0;
95 if (prom (&prom_args) != 0)
96 return PROM_INVALID_HANDLE;
98 result = prom_args.args[nargs];
99 for (i=1; i<nret; i++) {
100 void** rp = va_arg(list, void**);
101 *rp = prom_args.args[i+nargs];
110 call_method_1 (char *method, prom_handle h, int nargs, ...)
114 struct prom_args prom_args;
116 prom_args.service = "call-method";
117 prom_args.nargs = nargs+2;
119 prom_args.args[0] = method;
120 prom_args.args[1] = h;
121 va_start (list, nargs);
122 for (i = 0; i < nargs; ++i)
123 prom_args.args[2+i] = va_arg(list, void *);
125 prom_args.args[2+nargs] = 0;
126 prom_args.args[2+nargs+1] = 0;
130 if (prom_args.args[2+nargs] != 0)
132 prom_printf ("method '%s' failed %p\n", method, prom_args.args[2+nargs]);
135 return prom_args.args[2+nargs+1];
140 prom_finddevice (char *name)
142 return call_prom ("finddevice", 1, 1, name);
146 prom_findpackage(char *path)
148 return call_prom ("find-package", 1, 1, path);
152 prom_getprop (prom_handle pack, char *name, void *mem, int len)
154 return (int)call_prom ("getprop", 4, 1, pack, name, mem, len);
158 prom_getproplen(prom_handle pack, const char *name)
160 return (int)call_prom("getproplen", 2, 1, pack, name);
164 prom_setprop (prom_handle pack, char *name, void *mem, int len)
166 return (int)call_prom ("setprop", 4, 1, pack, name, mem, len);
170 prom_get_chosen (char *name, void *mem, int len)
172 return prom_getprop (prom_chosen, name, mem, len);
176 prom_get_options (char *name, void *mem, int len)
178 if (prom_options == (void *)-1)
180 return prom_getprop (prom_options, name, mem, len);
184 prom_set_options (char *name, void *mem, int len)
186 if (prom_options == (void *)-1)
188 return prom_setprop (prom_options, name, mem, len);
192 prom_get_devtype (char *device)
198 if (strstr(device, TOK_ISCSI))
199 device = strcpy(tmp, "/vdevice/gscsi/disk");
201 /* Find OF device phandle */
202 dev = prom_finddevice(device);
203 if (dev == PROM_INVALID_HANDLE) {
204 return FILE_ERR_BADDEV;
207 /* Check the kind of device */
208 result = prom_getprop(dev, "device_type", tmp, 63);
210 prom_printf("can't get <device_type> for device: %s\n", device);
211 return FILE_ERR_BADDEV;
214 if (!strcmp(tmp, "block"))
215 return FILE_DEVICE_BLOCK;
216 else if (!strcmp(tmp, "network"))
217 return FILE_DEVICE_NET;
219 prom_printf("Unkown device type <%s>\n", tmp);
220 return FILE_ERR_BADDEV;
225 prom_init (prom_entry pp)
229 prom_chosen = prom_finddevice ("/chosen");
230 if (prom_chosen == (void *)-1)
232 prom_options = prom_finddevice ("/options");
233 if (prom_get_chosen ("stdout", &prom_stdout, sizeof(prom_stdout)) <= 0)
235 if (prom_get_chosen ("stdin", &prom_stdin, sizeof(prom_stdin)) <= 0)
236 prom_abort ("\nCan't open stdin");
237 if (prom_get_chosen ("memory", &prom_mem, sizeof(prom_mem)) <= 0)
238 prom_abort ("\nCan't get mem handle");
239 if (prom_get_chosen ("mmu", &prom_mmu, sizeof(prom_mmu)) <= 0)
240 prom_abort ("\nCan't get mmu handle");
242 // move cursor to fresh line
245 /* Add a few OF methods (thanks Darwin) */
247 prom_printf ("Adding OF methods...\n");
251 /* All values in this forth code are in hex */
253 /* Those are a few utilities ripped from Apple */
254 ": D2NIP decode-int nip nip ;\r" // A useful function to save space
255 ": GPP$ get-package-property 0= ;\r" // Another useful function to save space
256 ": ^on0 0= if -1 throw then ;\r" // Bail if result zero
257 ": $CM $call-method ;\r"
260 /* Some forth words used by the release method */
262 " \" /chosen\" find-package if "
263 "dup \" memory\" rot GPP$ if "
264 "D2NIP swap " // ( MEMORY-ihandle "/chosen"-phandle )
265 "\" mmu\" rot GPP$ if "
266 "D2NIP " // ( MEMORY-ihandle MMU-ihandle )
268 "0 " // ( MEMORY-ihandle 0 )
285 DEBUG_F("OF interface initialized.\n");
289 prom_open (char *spec)
291 return call_prom ("open", 1, 1, spec, strlen(spec));
295 prom_close (prom_handle file)
297 call_prom ("close", 1, 0, file);
301 prom_read (prom_handle file, void *buf, int n)
309 result = (int)call_prom ("read", 3, 1, file, buf, n);
312 call_prom("interpret", 1, 1, " 10 ms");
319 prom_write (prom_handle file, void *buf, int n)
321 return (int)call_prom ("write", 3, 1, file, buf, n);
325 prom_seek (prom_handle file, int pos)
327 int status = (int)call_prom ("seek", 3, 1, file, 0, pos);
328 return status == 0 || status == 1;
332 prom_lseek (prom_handle file, unsigned long long pos)
334 int status = (int)call_prom ("seek", 3, 1, file,
335 (unsigned int)(pos >> 32), (unsigned int)(pos & 0xffffffffUL));
336 return status == 0 || status == 1;
340 prom_loadmethod (prom_handle device, void* addr)
342 return (int)call_method_1 ("load", device, 1, addr);
346 prom_getblksize (prom_handle file)
348 return (int)call_method_1 ("block-size", file, 0);
352 prom_readblocks (prom_handle dev, int blockNum, int blockCount, void *buffer)
354 #if READ_BLOCKS_USE_READ
356 unsigned int blksize;
358 blksize = prom_getblksize(dev);
361 status = prom_seek(dev, blockNum * blksize);
364 prom_printf("Can't seek to 0x%x\n", blockNum * blksize);
367 status = prom_read(dev, buffer, blockCount * blksize);
368 // prom_printf("prom_readblocks, bl: %d, cnt: %d, status: %d\n",
369 // blockNum, blockCount, status);
371 return status == (blockCount * blksize);
379 result = call_method_1 ("read-blocks", dev, 3, buffer, blockNum, blockCount);
382 call_prom("interpret", 1, 1, " 10 ms");
395 while ((a = (int)call_prom ("read", 3, 1, prom_stdin, c, 4)) == 0)
398 prom_abort ("EOF on console\n");
399 if (a == 3 && c[0] == '\e' && c[1] == '[')
409 return (int) call_prom("read", 3, 1, prom_stdin, &ch, 1) > 0? ch: -1;
413 prom_putchar (char c)
416 call_prom ("write", 3, 1, prom_stdout, "\r\n", 2);
418 call_prom ("write", 3, 1, prom_stdout, &c, 1);
422 prom_puts (prom_handle file, char *s)
426 for (p = s; *p != 0; p = q)
428 for (q = p; *q != 0 && *q != '\n'; ++q)
431 call_prom ("write", 3, 1, file, p, q - p);
435 call_prom ("write", 3, 1, file, "\r\n", 2);
441 prom_vfprintf (prom_handle file, char *fmt, va_list ap)
443 static char printf_buf[2048];
444 vsprintf (printf_buf, fmt, ap);
445 prom_puts (file, printf_buf);
449 prom_vprintf (char *fmt, va_list ap)
451 static char printf_buf[2048];
452 vsprintf (printf_buf, fmt, ap);
453 prom_puts (prom_stdout, printf_buf);
457 prom_fprintf (prom_handle file, char *fmt, ...)
461 prom_vfprintf (file, fmt, ap);
466 prom_printf (char *fmt, ...)
470 prom_vfprintf (prom_stdout, fmt, ap);
475 prom_perror (int error, char *filename)
477 if (error == FILE_ERR_EOF)
478 prom_printf("%s: Unexpected End Of File\n", filename);
479 else if (error == FILE_ERR_NOTFOUND)
480 prom_printf("%s: No such file or directory\n", filename);
481 else if (error == FILE_CANT_SEEK)
482 prom_printf("%s: Seek error\n", filename);
483 else if (error == FILE_IOERR)
484 prom_printf("%s: Input/output error\n", filename);
485 else if (error == FILE_BAD_PATH)
486 prom_printf("%s: Path too long\n", filename);
487 else if (error == FILE_ERR_BAD_TYPE)
488 prom_printf("%s: Not a regular file\n", filename);
489 else if (error == FILE_ERR_NOTDIR)
490 prom_printf("%s: Not a directory\n", filename);
491 else if (error == FILE_ERR_BAD_FSYS)
492 prom_printf("%s: Unknown or corrupt filesystem\n", filename);
493 else if (error == FILE_ERR_SYMLINK_LOOP)
494 prom_printf("%s: Too many levels of symbolic links\n", filename);
495 else if (error == FILE_ERR_LENGTH)
496 prom_printf("%s: File too large\n", filename);
497 else if (error == FILE_ERR_FSBUSY)
498 prom_printf("%s: Filesystem busy\n", filename);
499 else if (error == FILE_ERR_BADDEV)
500 prom_printf("%s: Unable to open file, Invalid device\n", filename);
502 prom_printf("%s: Unknown error\n", filename);
506 prom_readline (char *prompt, char *buf, int len)
512 prom_puts (prom_stdout, prompt);
514 while (i < len-1 && (c = prom_getchar ()) != '\r')
522 prom_puts (prom_stdout, "\b \b");
528 else if (isprint (c))
540 #ifdef CONFIG_SET_COLORMAP
541 int prom_set_color(prom_handle device, int color, int r, int g, int b)
543 return (int)call_prom( "call-method", 6, 1, "color!", device, color, b, g, r );
545 #endif /* CONFIG_SET_COLORMAP */
550 call_prom ("exit", 0, 0);
554 prom_abort (char *fmt, ...)
558 prom_vfprintf (prom_stdout, fmt, ap);
564 prom_sleep (int seconds)
567 end = (prom_getms() + (seconds * 1000));
568 while (prom_getms() <= end);
571 /* if address given is claimed look for other addresses to get the needed
572 * space before giving up
575 prom_claim_chunk(void *virt, unsigned int size, unsigned int align)
578 for(addr=virt; addr <= (void*)PROM_CLAIM_MAX_ADDR;
579 addr+=(0x100000/sizeof(addr))) {
580 found = prom_claim(addr, size, 0);
581 if (found != (void *)-1) {
582 DEBUG_F("claimed %i at 0x%x (0x%x)\n",size,(int)found,(int)virt);
586 prom_printf("Claim error, can't allocate %x at 0x%x\n",size,(int)virt);
591 prom_claim (void *virt, unsigned int size, unsigned int align)
593 return call_prom ("claim", 3, 1, virt, size, align);
597 prom_release(void *virt, unsigned int size)
599 call_prom ("release", 2, 0, virt, size);
600 #if 0 /* this is bullshit, newworld OF RELEASE method works fine. */
602 /* release in not enough, it needs also an unmap call. This bit of forth
603 * code inspired from Darwin's bootloader but could be replaced by direct
604 * calls to the MMU package if needed
606 call_prom ("interpret", 3, 1,
608 ".\" ReleaseMem:\" 2dup . . cr "
610 "over \" translate\" ^mmu " // Find out physical base
611 "^on0 " // Bail if translation failed
612 "drop " // Leaving phys on top of stack
613 "2dup \" unmap\" ^mmu " // Unmap the space first
614 "2dup \" release\" ^mmu " // Then free the virtual pages
615 "\" release\" ^mem " // Then free the physical pages
618 #endif /* bullshit */
622 prom_map (void *phys, void *virt, int size)
624 unsigned long msr = mfmsr();
626 /* Only create a mapping if we're running with relocation enabled. */
627 if ( (msr & MSR_IR) && (msr & MSR_DR) )
628 call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
632 prom_unmap (void *phys, void *virt, int size)
634 unsigned long msr = mfmsr();
636 /* Only unmap if we're running with relocation enabled. */
637 if ( (msr & MSR_IR) && (msr & MSR_DR) )
638 call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
644 static char args[256];
647 l = prom_get_chosen ("bootargs", args, 255);
653 prom_setargs (char *args)
655 int l = strlen (args)+1;
656 if ((int)call_prom ("setprop", 4, 1, prom_chosen, "bootargs", args, l) != l)
657 prom_printf ("can't set args\n");
660 int prom_interpret (char *forth)
662 return (int)call_prom("interpret", 1, 1, forth);
668 return (int) call_prom("milliseconds", 0, 1);
674 call_prom("enter", 0, 0);
679 * returns the packet with all needed info for netboot
681 struct bootp_packet * prom_get_netinfo (void)
683 void *bootp_response = NULL;
685 struct bootp_packet *packet;
686 /* struct bootp_packet contains a VLA, so sizeof won't work.
687 the VLA /must/ be the last field in the structure so use it's
688 offset as a good estimate of the packet size */
689 size_t packet_size = offsetof(struct bootp_packet, options);
690 int i = 0, size, offset = 0;
692 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
694 chosen = prom_finddevice("/chosen");
696 DEBUG_F("chosen=%d\n", chosen);
700 for (i = 0; i < ARRAY_SIZE(bootp_response_properties); i++) {
701 propname = bootp_response_properties[i].name;
702 size = prom_getproplen(chosen, propname);
706 DEBUG_F("using /chosen/%s\n", propname);
707 offset = bootp_response_properties[i].offset;
714 if (packet_size > size - offset) {
715 prom_printf("Malformed %s property?\n", propname);
719 bootp_response = malloc(size);
723 if (prom_getprop(chosen, propname, bootp_response, size) < 0)
726 packet = bootp_response + offset;
732 * returns the mac addr of an net card
734 char * prom_get_mac (struct bootp_packet * packet)
742 /* 3 chars per byte in chaddr + \0 */
743 conf_path = malloc(packet->hlen * 3 + 1);
746 sprintf(conf_path, "%02x", packet->chaddr[0]);
748 for (i = 1; i < packet->hlen; i++) {
750 sprintf(tmp, "-%02x", packet->chaddr[i]);
751 strcat(conf_path, tmp);
759 * returns the ip addr of an net card
761 char * prom_get_ip (struct bootp_packet * packet)
768 /* 8 chars in yiaddr + \0 */
769 conf_path = malloc(9);
772 sprintf(conf_path, "%08x", packet->yiaddr);
779 * c-file-style: "k&r"