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 static ihandle prom_mem, prom_mmu;
45 static ihandle prom_chosen, prom_options;
55 call_prom (const char *service, int nargs, int nret, ...)
59 struct prom_args prom_args;
61 prom_args.service = service;
62 prom_args.nargs = nargs;
63 prom_args.nret = nret;
64 va_start (list, nret);
65 for (i = 0; i < nargs; ++i)
66 prom_args.args[i] = va_arg(list, void *);
68 for (i = 0; i < nret; ++i)
69 prom_args.args[i + nargs] = 0;
72 return prom_args.args[nargs];
78 call_prom_return (const char *service, int nargs, int nret, ...)
83 struct prom_args prom_args;
85 prom_args.service = service;
86 prom_args.nargs = nargs;
87 prom_args.nret = nret;
88 va_start (list, nret);
89 for (i = 0; i < nargs; ++i)
90 prom_args.args[i] = va_arg(list, void *);
91 for (i = 0; i < nret; ++i)
92 prom_args.args[i + nargs] = 0;
93 if (prom (&prom_args) != 0)
94 return PROM_INVALID_HANDLE;
96 result = prom_args.args[nargs];
97 for (i=1; i<nret; i++) {
98 void** rp = va_arg(list, void**);
99 *rp = prom_args.args[i+nargs];
108 call_method_1 (char *method, prom_handle h, int nargs, ...)
112 struct prom_args prom_args;
114 prom_args.service = "call-method";
115 prom_args.nargs = nargs+2;
117 prom_args.args[0] = method;
118 prom_args.args[1] = h;
119 va_start (list, nargs);
120 for (i = 0; i < nargs; ++i)
121 prom_args.args[2+i] = va_arg(list, void *);
123 prom_args.args[2+nargs] = 0;
124 prom_args.args[2+nargs+1] = 0;
128 if (prom_args.args[2+nargs] != 0)
130 prom_printf ("method '%s' failed %p\n", method, prom_args.args[2+nargs]);
133 return prom_args.args[2+nargs+1];
138 prom_finddevice (char *name)
140 return call_prom ("finddevice", 1, 1, name);
144 prom_findpackage(char *path)
146 return call_prom ("find-package", 1, 1, path);
150 prom_getprop (prom_handle pack, char *name, void *mem, int len)
152 return (int)call_prom ("getprop", 4, 1, pack, name, mem, len);
156 prom_getproplen(prom_handle pack, const char *name)
158 return (int)call_prom("getproplen", 2, 1, pack, name);
162 prom_setprop (prom_handle pack, char *name, void *mem, int len)
164 return (int)call_prom ("setprop", 4, 1, pack, name, mem, len);
168 prom_get_chosen (char *name, void *mem, int len)
170 return prom_getprop (prom_chosen, name, mem, len);
174 prom_get_options (char *name, void *mem, int len)
176 if (prom_options == (void *)-1)
178 return prom_getprop (prom_options, name, mem, len);
182 prom_set_options (char *name, void *mem, int len)
184 if (prom_options == (void *)-1)
186 return prom_setprop (prom_options, name, mem, len);
190 prom_get_devtype (char *device)
196 if (strstr(device, TOK_ISCSI))
197 device = strcpy(tmp, "/vdevice/gscsi/disk");
199 /* Find OF device phandle */
200 dev = prom_finddevice(device);
201 if (dev == PROM_INVALID_HANDLE) {
202 return FILE_ERR_BADDEV;
205 /* Check the kind of device */
206 result = prom_getprop(dev, "device_type", tmp, 63);
208 prom_printf("can't get <device_type> for device: %s\n", device);
209 return FILE_ERR_BADDEV;
212 if (!strcmp(tmp, "block"))
213 return FILE_DEVICE_BLOCK;
214 else if (!strcmp(tmp, "network"))
215 return FILE_DEVICE_NET;
217 prom_printf("Unkown device type <%s>\n", tmp);
218 return FILE_ERR_BADDEV;
223 prom_init (prom_entry pp)
227 prom_chosen = prom_finddevice ("/chosen");
228 if (prom_chosen == (void *)-1)
230 prom_options = prom_finddevice ("/options");
231 if (prom_get_chosen ("stdout", &prom_stdout, sizeof(prom_stdout)) <= 0)
233 if (prom_get_chosen ("stdin", &prom_stdin, sizeof(prom_stdin)) <= 0)
234 prom_abort ("\nCan't open stdin");
235 if (prom_get_chosen ("memory", &prom_mem, sizeof(prom_mem)) <= 0)
236 prom_abort ("\nCan't get mem handle");
237 if (prom_get_chosen ("mmu", &prom_mmu, sizeof(prom_mmu)) <= 0)
238 prom_abort ("\nCan't get mmu handle");
240 // move cursor to fresh line
243 /* Add a few OF methods (thanks Darwin) */
245 prom_printf ("Adding OF methods...\n");
249 /* All values in this forth code are in hex */
251 /* Those are a few utilities ripped from Apple */
252 ": D2NIP decode-int nip nip ;\r" // A useful function to save space
253 ": GPP$ get-package-property 0= ;\r" // Another useful function to save space
254 ": ^on0 0= if -1 throw then ;\r" // Bail if result zero
255 ": $CM $call-method ;\r"
258 /* Some forth words used by the release method */
260 " \" /chosen\" find-package if "
261 "dup \" memory\" rot GPP$ if "
262 "D2NIP swap " // ( MEMORY-ihandle "/chosen"-phandle )
263 "\" mmu\" rot GPP$ if "
264 "D2NIP " // ( MEMORY-ihandle MMU-ihandle )
266 "0 " // ( MEMORY-ihandle 0 )
283 DEBUG_F("OF interface initialized.\n");
287 prom_open (char *spec)
289 return call_prom ("open", 1, 1, spec, strlen(spec));
293 prom_close (prom_handle file)
295 call_prom ("close", 1, 0, file);
299 prom_read (prom_handle file, void *buf, int n)
307 result = (int)call_prom ("read", 3, 1, file, buf, n);
310 call_prom("interpret", 1, 1, " 10 ms");
317 prom_write (prom_handle file, void *buf, int n)
319 return (int)call_prom ("write", 3, 1, file, buf, n);
323 prom_seek (prom_handle file, int pos)
325 int status = (int)call_prom ("seek", 3, 1, file, 0, pos);
326 return status == 0 || status == 1;
330 prom_lseek (prom_handle file, unsigned long long pos)
332 int status = (int)call_prom ("seek", 3, 1, file,
333 (unsigned int)(pos >> 32), (unsigned int)(pos & 0xffffffffUL));
334 return status == 0 || status == 1;
338 prom_loadmethod (prom_handle device, void* addr)
340 return (int)call_method_1 ("load", device, 1, addr);
344 prom_getblksize (prom_handle file)
346 return (int)call_method_1 ("block-size", file, 0);
350 prom_readblocks (prom_handle dev, int blockNum, int blockCount, void *buffer)
352 #if READ_BLOCKS_USE_READ
354 unsigned int blksize;
356 blksize = prom_getblksize(dev);
359 status = prom_seek(dev, blockNum * blksize);
362 prom_printf("Can't seek to 0x%x\n", blockNum * blksize);
365 status = prom_read(dev, buffer, blockCount * blksize);
366 // prom_printf("prom_readblocks, bl: %d, cnt: %d, status: %d\n",
367 // blockNum, blockCount, status);
369 return status == (blockCount * blksize);
377 result = call_method_1 ("read-blocks", dev, 3, buffer, blockNum, blockCount);
380 call_prom("interpret", 1, 1, " 10 ms");
393 while ((a = (int)call_prom ("read", 3, 1, prom_stdin, &c, 1)) == 0)
396 prom_abort ("EOF on console\n");
405 return (int) call_prom("read", 3, 1, prom_stdin, &ch, 1) > 0? ch: -1;
409 prom_putchar (char c)
412 call_prom ("write", 3, 1, prom_stdout, "\r\n", 2);
414 call_prom ("write", 3, 1, prom_stdout, &c, 1);
418 prom_puts (prom_handle file, char *s)
422 for (p = s; *p != 0; p = q)
424 for (q = p; *q != 0 && *q != '\n'; ++q)
427 call_prom ("write", 3, 1, file, p, q - p);
431 call_prom ("write", 3, 1, file, "\r\n", 2);
437 prom_vfprintf (prom_handle file, char *fmt, va_list ap)
439 static char printf_buf[2048];
440 vsprintf (printf_buf, fmt, ap);
441 prom_puts (file, printf_buf);
445 prom_vprintf (char *fmt, va_list ap)
447 static char printf_buf[2048];
448 vsprintf (printf_buf, fmt, ap);
449 prom_puts (prom_stdout, printf_buf);
453 prom_fprintf (prom_handle file, char *fmt, ...)
457 prom_vfprintf (file, fmt, ap);
462 prom_printf (char *fmt, ...)
466 prom_vfprintf (prom_stdout, fmt, ap);
471 prom_perror (int error, char *filename)
473 if (error == FILE_ERR_EOF)
474 prom_printf("%s: Unexpected End Of File\n", filename);
475 else if (error == FILE_ERR_NOTFOUND)
476 prom_printf("%s: No such file or directory\n", filename);
477 else if (error == FILE_CANT_SEEK)
478 prom_printf("%s: Seek error\n", filename);
479 else if (error == FILE_IOERR)
480 prom_printf("%s: Input/output error\n", filename);
481 else if (error == FILE_BAD_PATH)
482 prom_printf("%s: Path too long\n", filename);
483 else if (error == FILE_ERR_BAD_TYPE)
484 prom_printf("%s: Not a regular file\n", filename);
485 else if (error == FILE_ERR_NOTDIR)
486 prom_printf("%s: Not a directory\n", filename);
487 else if (error == FILE_ERR_BAD_FSYS)
488 prom_printf("%s: Unknown or corrupt filesystem\n", filename);
489 else if (error == FILE_ERR_SYMLINK_LOOP)
490 prom_printf("%s: Too many levels of symbolic links\n", filename);
491 else if (error == FILE_ERR_LENGTH)
492 prom_printf("%s: File too large\n", filename);
493 else if (error == FILE_ERR_FSBUSY)
494 prom_printf("%s: Filesystem busy\n", filename);
495 else if (error == FILE_ERR_BADDEV)
496 prom_printf("%s: Unable to open file, Invalid device\n", filename);
498 prom_printf("%s: Unknown error\n", filename);
502 prom_readline (char *prompt, char *buf, int len)
508 prom_puts (prom_stdout, prompt);
510 while (i < len-1 && (c = prom_getchar ()) != '\r')
516 prom_puts (prom_stdout, "\b \b");
522 else if (isprint (c))
534 #ifdef CONFIG_SET_COLORMAP
535 int prom_set_color(prom_handle device, int color, int r, int g, int b)
537 return (int)call_prom( "call-method", 6, 1, "color!", device, color, b, g, r );
539 #endif /* CONFIG_SET_COLORMAP */
544 call_prom ("exit", 0, 0);
548 prom_abort (char *fmt, ...)
552 prom_vfprintf (prom_stdout, fmt, ap);
558 prom_sleep (int seconds)
561 end = (prom_getms() + (seconds * 1000));
562 while (prom_getms() <= end);
565 /* if address given is claimed look for other addresses to get the needed
566 * space before giving up
569 prom_claim_chunk(void *virt, unsigned int size, unsigned int align)
572 for(addr=virt; addr <= (void*)PROM_CLAIM_MAX_ADDR;
573 addr+=(0x100000/sizeof(addr))) {
574 found = prom_claim(addr, size, 0);
575 if (found != (void *)-1) {
576 DEBUG_F("claimed %i at 0x%x (0x%x)\n",size,(int)found,(int)virt);
580 prom_printf("Claim error, can't allocate %x at 0x%x\n",size,(int)virt);
585 prom_claim (void *virt, unsigned int size, unsigned int align)
587 return call_prom ("claim", 3, 1, virt, size, align);
591 prom_release(void *virt, unsigned int size)
593 call_prom ("release", 2, 0, virt, size);
597 prom_map (void *phys, void *virt, int size)
599 unsigned long msr = mfmsr();
601 /* Only create a mapping if we're running with relocation enabled. */
602 if ( (msr & MSR_IR) && (msr & MSR_DR) )
603 call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
607 prom_unmap (void *phys, void *virt, int size)
609 unsigned long msr = mfmsr();
611 /* Only unmap if we're running with relocation enabled. */
612 if ( (msr & MSR_IR) && (msr & MSR_DR) )
613 call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
619 static char args[256];
622 l = prom_get_chosen ("bootargs", args, 255);
628 prom_setargs (char *args)
630 int l = strlen (args)+1;
631 if ((int)call_prom ("setprop", 4, 1, prom_chosen, "bootargs", args, l) != l)
632 prom_printf ("can't set args\n");
635 int prom_interpret (char *forth)
637 return (int)call_prom("interpret", 1, 1, forth);
643 return (int) call_prom("milliseconds", 0, 1);
649 call_prom("enter", 0, 0);
654 * returns the packet with all needed info for netboot
656 struct bootp_packet * prom_get_netinfo (void)
658 void *bootp_response = NULL;
660 struct bootp_packet *packet;
661 /* struct bootp_packet contains a VLA, so sizeof won't work.
662 the VLA /must/ be the last field in the structure so use it's
663 offset as a good estimate of the packet size */
664 size_t packet_size = offsetof(struct bootp_packet, options);
665 int i = 0, size, offset = 0;
667 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
669 chosen = prom_finddevice("/chosen");
671 DEBUG_F("chosen=%d\n", chosen);
675 for (i = 0; i < ARRAY_SIZE(bootp_response_properties); i++) {
676 propname = bootp_response_properties[i].name;
677 size = prom_getproplen(chosen, propname);
681 DEBUG_F("using /chosen/%s\n", propname);
682 offset = bootp_response_properties[i].offset;
689 if (packet_size > size - offset) {
690 prom_printf("Malformed %s property?\n", propname);
694 bootp_response = malloc(size);
698 if (prom_getprop(chosen, propname, bootp_response, size) < 0)
701 packet = bootp_response + offset;
707 * returns the mac addr of an net card
709 char * prom_get_mac (struct bootp_packet * packet)
717 /* 3 chars per byte in chaddr + \0 */
718 conf_path = malloc(packet->hlen * 3 + 1);
721 sprintf(conf_path, "%02x", packet->chaddr[0]);
723 for (i = 1; i < packet->hlen; i++) {
725 sprintf(tmp, "-%02x", packet->chaddr[i]);
726 strcat(conf_path, tmp);
734 * returns the ip addr of an net card
736 char * prom_get_ip (struct bootp_packet * packet)
743 /* 8 chars in yiaddr + \0 */
744 conf_path = malloc(9);
747 sprintf(conf_path, "%08x", packet->yiaddr);
754 * c-file-style: "k&r"