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"
37 #define READ_BLOCKS_USE_READ 1
41 ihandle prom_stdin, prom_stdout;
43 //extern int vsprintf(char *buf, const char *fmt, va_list args);
45 static ihandle prom_mem, prom_mmu;
46 static ihandle prom_chosen, prom_options;
56 call_prom (const char *service, int nargs, int nret, ...)
60 struct prom_args prom_args;
62 prom_args.service = service;
63 prom_args.nargs = nargs;
64 prom_args.nret = nret;
65 va_start (list, nret);
66 for (i = 0; i < nargs; ++i)
67 prom_args.args[i] = va_arg(list, void *);
69 for (i = 0; i < nret; ++i)
70 prom_args.args[i + nargs] = 0;
73 return prom_args.args[nargs];
79 call_prom_return (const char *service, int nargs, int nret, ...)
84 struct prom_args prom_args;
86 prom_args.service = service;
87 prom_args.nargs = nargs;
88 prom_args.nret = nret;
89 va_start (list, nret);
90 for (i = 0; i < nargs; ++i)
91 prom_args.args[i] = va_arg(list, void *);
92 for (i = 0; i < nret; ++i)
93 prom_args.args[i + nargs] = 0;
94 if (prom (&prom_args) != 0)
95 return PROM_INVALID_HANDLE;
97 result = prom_args.args[nargs];
98 for (i=1; i<nret; i++) {
99 void** rp = va_arg(list, void**);
100 *rp = prom_args.args[i+nargs];
109 call_method_1 (char *method, prom_handle h, int nargs, ...)
113 struct prom_args prom_args;
115 prom_args.service = "call-method";
116 prom_args.nargs = nargs+2;
118 prom_args.args[0] = method;
119 prom_args.args[1] = h;
120 va_start (list, nargs);
121 for (i = 0; i < nargs; ++i)
122 prom_args.args[2+i] = va_arg(list, void *);
124 prom_args.args[2+nargs] = 0;
125 prom_args.args[2+nargs+1] = 0;
129 if (prom_args.args[2+nargs] != 0)
131 prom_printf ("method '%s' failed %p\n", method, prom_args.args[2+nargs]);
134 return prom_args.args[2+nargs+1];
139 prom_finddevice (char *name)
141 return call_prom ("finddevice", 1, 1, name);
145 prom_findpackage(char *path)
147 return call_prom ("find-package", 1, 1, path);
151 prom_getprop (prom_handle pack, char *name, void *mem, int len)
153 return (int)call_prom ("getprop", 4, 1, pack, name, mem, len);
157 prom_get_chosen (char *name, void *mem, int len)
159 return prom_getprop (prom_chosen, name, mem, len);
163 prom_get_options (char *name, void *mem, int len)
165 if (prom_options == (void *)-1)
167 return prom_getprop (prom_options, name, mem, len);
171 prom_get_devtype (char *device)
177 /* Find OF device phandle */
178 dev = prom_finddevice(device);
179 if (dev == PROM_INVALID_HANDLE) {
180 return FILE_ERR_BADDEV;
183 /* Check the kind of device */
184 result = prom_getprop(dev, "device_type", tmp, 63);
186 prom_printf("can't get <device_type> for device: %s\n", device);
187 return FILE_ERR_BADDEV;
190 if (!strcmp(tmp, "block"))
191 return FILE_DEVICE_BLOCK;
192 else if (!strcmp(tmp, "network"))
193 return FILE_DEVICE_NET;
195 prom_printf("Unkown device type <%s>\n", tmp);
196 return FILE_ERR_BADDEV;
201 prom_init (prom_entry pp)
205 prom_chosen = prom_finddevice ("/chosen");
206 if (prom_chosen == (void *)-1)
208 prom_options = prom_finddevice ("/options");
209 if (prom_get_chosen ("stdout", &prom_stdout, sizeof(prom_stdout)) <= 0)
211 if (prom_get_chosen ("stdin", &prom_stdin, sizeof(prom_stdin)) <= 0)
212 prom_abort ("\nCan't open stdin");
213 if (prom_get_chosen ("memory", &prom_mem, sizeof(prom_mem)) <= 0)
214 prom_abort ("\nCan't get mem handle");
215 if (prom_get_chosen ("mmu", &prom_mmu, sizeof(prom_mmu)) <= 0)
216 prom_abort ("\nCan't get mmu handle");
218 // move cursor to fresh line
221 /* Add a few OF methods (thanks Darwin) */
223 prom_printf ("Adding OF methods...\n");
227 /* All values in this forth code are in hex */
229 /* Those are a few utilities ripped from Apple */
230 ": D2NIP decode-int nip nip ;\r" // A useful function to save space
231 ": GPP$ get-package-property 0= ;\r" // Another useful function to save space
232 ": ^on0 0= if -1 throw then ;\r" // Bail if result zero
233 ": $CM $call-method ;\r"
236 /* Some forth words used by the release method */
238 " \" /chosen\" find-package if "
239 "dup \" memory\" rot GPP$ if "
240 "D2NIP swap " // ( MEMORY-ihandle "/chosen"-phandle )
241 "\" mmu\" rot GPP$ if "
242 "D2NIP " // ( MEMORY-ihandle MMU-ihandle )
244 "0 " // ( MEMORY-ihandle 0 )
261 DEBUG_F("OF interface initialized.\n");
265 prom_open (char *spec)
267 return call_prom ("open", 1, 1, spec, strlen(spec));
271 prom_close (prom_handle file)
273 call_prom ("close", 1, 0, file);
277 prom_read (prom_handle file, void *buf, int n)
285 result = (int)call_prom ("read", 3, 1, file, buf, n);
288 call_prom("interpret", 1, 1, " 10 ms");
295 prom_write (prom_handle file, void *buf, int n)
297 return (int)call_prom ("write", 3, 1, file, buf, n);
301 prom_seek (prom_handle file, int pos)
303 int status = (int)call_prom ("seek", 3, 1, file, 0, pos);
304 return status == 0 || status == 1;
308 prom_lseek (prom_handle file, unsigned long long pos)
310 int status = (int)call_prom ("seek", 3, 1, file,
311 (unsigned int)(pos >> 32), (unsigned int)(pos & 0xffffffffUL));
312 return status == 0 || status == 1;
316 prom_loadmethod (prom_handle device, void* addr)
318 return (int)call_method_1 ("load", device, 1, addr);
322 prom_getblksize (prom_handle file)
324 return (int)call_method_1 ("block-size", file, 0);
328 prom_readblocks (prom_handle dev, int blockNum, int blockCount, void *buffer)
330 #if READ_BLOCKS_USE_READ
332 unsigned int blksize;
334 blksize = prom_getblksize(dev);
337 status = prom_seek(dev, blockNum * blksize);
340 prom_printf("Can't seek to 0x%x\n", blockNum * blksize);
343 status = prom_read(dev, buffer, blockCount * blksize);
344 // prom_printf("prom_readblocks, bl: %d, cnt: %d, status: %d\n",
345 // blockNum, blockCount, status);
347 return status == (blockCount * blksize);
355 result = call_method_1 ("read-blocks", dev, 3, buffer, blockNum, blockCount);
358 call_prom("interpret", 1, 1, " 10 ms");
371 while ((a = (int)call_prom ("read", 3, 1, prom_stdin, c, 4)) == 0)
374 prom_abort ("EOF on console\n");
375 if (a == 3 && c[0] == '\e' && c[1] == '[')
385 return (int) call_prom("read", 3, 1, prom_stdin, &ch, 1) > 0? ch: -1;
389 prom_putchar (char c)
392 call_prom ("write", 3, 1, prom_stdout, "\r\n", 2);
394 call_prom ("write", 3, 1, prom_stdout, &c, 1);
398 prom_puts (prom_handle file, char *s)
402 for (p = s; *p != 0; p = q)
404 for (q = p; *q != 0 && *q != '\n'; ++q)
407 call_prom ("write", 3, 1, file, p, q - p);
411 call_prom ("write", 3, 1, file, "\r\n", 2);
417 prom_vfprintf (prom_handle file, char *fmt, va_list ap)
419 static char printf_buf[2048];
420 vsprintf (printf_buf, fmt, ap);
421 prom_puts (file, printf_buf);
425 prom_vprintf (char *fmt, va_list ap)
427 static char printf_buf[2048];
428 vsprintf (printf_buf, fmt, ap);
429 prom_puts (prom_stdout, printf_buf);
433 prom_fprintf (prom_handle file, char *fmt, ...)
437 prom_vfprintf (file, fmt, ap);
442 prom_printf (char *fmt, ...)
446 prom_vfprintf (prom_stdout, fmt, ap);
451 prom_perror (int error, char *filename)
453 if (error == FILE_ERR_EOF)
454 prom_printf("%s: Unexpected End Of File\n", filename);
455 else if (error == FILE_ERR_NOTFOUND)
456 prom_printf("%s: No such file or directory\n", filename);
457 else if (error == FILE_CANT_SEEK)
458 prom_printf("%s: Seek error\n", filename);
459 else if (error == FILE_IOERR)
460 prom_printf("%s: Input/output error\n", filename);
461 else if (error == FILE_BAD_PATH)
462 prom_printf("%s: Path too long\n", filename);
463 else if (error == FILE_ERR_BAD_TYPE)
464 prom_printf("%s: Not a regular file\n", filename);
465 else if (error == FILE_ERR_NOTDIR)
466 prom_printf("%s: Not a directory\n", filename);
467 else if (error == FILE_ERR_BAD_FSYS)
468 prom_printf("%s: Unknown or corrupt filesystem\n", filename);
469 else if (error == FILE_ERR_SYMLINK_LOOP)
470 prom_printf("%s: Too many levels of symbolic links\n", filename);
471 else if (error == FILE_ERR_LENGTH)
472 prom_printf("%s: File too large\n", filename);
473 else if (error == FILE_ERR_FSBUSY)
474 prom_printf("%s: Filesystem busy\n", filename);
475 else if (error == FILE_ERR_BADDEV)
476 prom_printf("%s: Unable to open file, Invalid device\n", filename);
478 prom_printf("%s: Unknown error\n", filename);
482 prom_readline (char *prompt, char *buf, int len)
488 prom_puts (prom_stdout, prompt);
490 while (i < len-1 && (c = prom_getchar ()) != '\r')
498 prom_puts (prom_stdout, "\b \b");
504 else if (isprint (c))
516 #ifdef CONFIG_SET_COLORMAP
517 int prom_set_color(prom_handle device, int color, int r, int g, int b)
519 return (int)call_prom( "call-method", 6, 1, "color!", device, color, b, g, r );
521 #endif /* CONFIG_SET_COLORMAP */
526 call_prom ("exit", 0, 0);
530 prom_abort (char *fmt, ...)
534 prom_vfprintf (prom_stdout, fmt, ap);
540 prom_sleep (int seconds)
543 end = (prom_getms() + (seconds * 1000));
544 while (prom_getms() <= end);
548 prom_claim (void *virt, unsigned int size, unsigned int align)
550 return call_prom ("claim", 3, 1, virt, size, align);
554 prom_release(void *virt, unsigned int size)
556 call_prom ("release", 2, 0, virt, size);
557 #if 0 /* this is bullshit, newworld OF RELEASE method works fine. */
559 /* release in not enough, it needs also an unmap call. This bit of forth
560 * code inspired from Darwin's bootloader but could be replaced by direct
561 * calls to the MMU package if needed
563 call_prom ("interpret", 3, 1,
565 ".\" ReleaseMem:\" 2dup . . cr "
567 "over \" translate\" ^mmu " // Find out physical base
568 "^on0 " // Bail if translation failed
569 "drop " // Leaving phys on top of stack
570 "2dup \" unmap\" ^mmu " // Unmap the space first
571 "2dup \" release\" ^mmu " // Then free the virtual pages
572 "\" release\" ^mem " // Then free the physical pages
575 #endif /* bullshit */
579 prom_map (void *phys, void *virt, int size)
581 unsigned long msr = mfmsr();
583 /* Only create a mapping if we're running with relocation enabled. */
584 if ( (msr & MSR_IR) && (msr & MSR_DR) )
585 call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
589 prom_unmap (void *phys, void *virt, int size)
591 unsigned long msr = mfmsr();
593 /* Only unmap if we're running with relocation enabled. */
594 if ( (msr & MSR_IR) && (msr & MSR_DR) )
595 call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
601 static char args[256];
604 l = prom_get_chosen ("bootargs", args, 255);
610 prom_setargs (char *args)
612 int l = strlen (args)+1;
613 if ((int)call_prom ("setprop", 4, 1, prom_chosen, "bootargs", args, l) != l)
614 prom_printf ("can't set args\n");
617 int prom_interpret (char *forth)
619 return (int)call_prom("interpret", 1, 1, forth);
625 return (int) call_prom("milliseconds", 0, 1);
631 call_prom("enter", 0, 0);
636 * c-file-style: "k&r"