d23b8a6a3d552dd91b4827c99dba2c4efb44f3ad
[yaboot.git] / second / prom.c
1 /*
2  *  prom.c - Routines for talking to the Open Firmware PROM
3  *
4  *  Copyright (C) 2001, 2002 Ethan Benson
5  *
6  *  Copyright (C) 1999 Benjamin Herrenschmidt
7  *
8  *  Copyright (C) 1999 Marius Vollmer
9  *
10  *  Copyright (C) 1996 Paul Mackerras.
11  *
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.
16  *
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.
21  *
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.
25  */
26
27 #include "prom.h"
28 #include "stdarg.h"
29 #include "stddef.h"
30 #include "stdlib.h"
31 #include "types.h"
32 #include "ctype.h"
33 #include "asm/processor.h"
34 #include "errors.h"
35 #include "debug.h"
36
37 #define READ_BLOCKS_USE_READ    1
38
39 prom_entry prom;
40
41 ihandle prom_stdin, prom_stdout;
42
43 //extern int vsprintf(char *buf, const char *fmt, va_list args);
44
45 static ihandle prom_mem, prom_mmu;
46 static ihandle prom_chosen, prom_options;
47
48 struct prom_args {
49      const char *service;
50      int nargs;
51      int nret;
52      void *args[10];
53 };
54
55 void *
56 call_prom (const char *service, int nargs, int nret, ...)
57 {
58      va_list list;
59      int i;
60      struct prom_args prom_args;
61
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 *);
68      va_end(list);
69      for (i = 0; i < nret; ++i)
70           prom_args.args[i + nargs] = 0;
71      prom (&prom_args);
72      if (nret > 0)
73           return prom_args.args[nargs];
74      else
75           return 0;
76 }
77
78 void *
79 call_prom_return (const char *service, int nargs, int nret, ...)
80 {
81      va_list list;
82      int i;
83      void* result;
84      struct prom_args prom_args;
85
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;
96      if (nret > 0) {
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];
101           }
102      } else
103           result = 0;
104      va_end(list);
105      return result;
106 }
107
108 static void *
109 call_method_1 (char *method, prom_handle h, int nargs, ...)
110 {
111      va_list list;
112      int i;
113      struct prom_args prom_args;
114
115      prom_args.service = "call-method";
116      prom_args.nargs = nargs+2;
117      prom_args.nret = 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 *);
123      va_end(list);
124      prom_args.args[2+nargs] = 0;
125      prom_args.args[2+nargs+1] = 0;
126
127      prom (&prom_args);
128
129      if (prom_args.args[2+nargs] != 0)
130      {
131           prom_printf ("method '%s' failed %p\n", method, prom_args.args[2+nargs]);
132           return 0;
133      }
134      return prom_args.args[2+nargs+1];
135 }
136
137
138 prom_handle
139 prom_finddevice (char *name)
140 {
141      return call_prom ("finddevice", 1, 1, name);
142 }
143
144 prom_handle
145 prom_findpackage(char *path)
146 {
147      return call_prom ("find-package", 1, 1, path);
148 }
149
150 int
151 prom_getprop (prom_handle pack, char *name, void *mem, int len)
152 {
153      return (int)call_prom ("getprop", 4, 1, pack, name, mem, len);
154 }
155
156 int
157 prom_getproplen(prom_handle pack, const char *name)
158 {
159      return (int)call_prom("getproplen", 2, 1, pack, name);
160 }
161
162 int
163 prom_get_chosen (char *name, void *mem, int len)
164 {
165      return prom_getprop (prom_chosen, name, mem, len);
166 }
167
168 int
169 prom_get_options (char *name, void *mem, int len)
170 {
171      if (prom_options == (void *)-1)
172           return -1;
173      return prom_getprop (prom_options, name, mem, len);
174 }
175
176 int
177 prom_get_devtype (char *device)
178 {
179      phandle    dev;
180      int        result;
181      char       tmp[64];
182
183      if (strstr(device, TOK_ISCSI))
184           device = strcpy(tmp, "/vdevice/gscsi/disk");
185
186      /* Find OF device phandle */
187      dev = prom_finddevice(device);
188      if (dev == PROM_INVALID_HANDLE) {
189           return FILE_ERR_BADDEV;
190      }
191
192      /* Check the kind of device */
193      result = prom_getprop(dev, "device_type", tmp, 63);
194      if (result == -1) {
195           prom_printf("can't get <device_type> for device: %s\n", device);
196           return FILE_ERR_BADDEV;
197      }
198      tmp[result] = 0;
199      if (!strcmp(tmp, "block"))
200           return FILE_DEVICE_BLOCK;
201      else if (!strcmp(tmp, "network"))
202           return FILE_DEVICE_NET;
203      else {
204           prom_printf("Unkown device type <%s>\n", tmp);
205           return FILE_ERR_BADDEV;
206      }
207 }
208
209 void
210 prom_init (prom_entry pp)
211 {
212      prom = pp;
213
214      prom_chosen = prom_finddevice ("/chosen");
215      if (prom_chosen == (void *)-1)
216           prom_exit ();
217      prom_options = prom_finddevice ("/options");
218      if (prom_get_chosen ("stdout", &prom_stdout, sizeof(prom_stdout)) <= 0)
219           prom_exit();
220      if (prom_get_chosen ("stdin", &prom_stdin, sizeof(prom_stdin)) <= 0)
221           prom_abort ("\nCan't open stdin");
222      if (prom_get_chosen ("memory", &prom_mem, sizeof(prom_mem)) <= 0)
223           prom_abort ("\nCan't get mem handle");
224      if (prom_get_chosen ("mmu", &prom_mmu, sizeof(prom_mmu)) <= 0)
225           prom_abort ("\nCan't get mmu handle");
226
227   // move cursor to fresh line
228      prom_printf ("\n");
229
230      /* Add a few OF methods (thanks Darwin) */
231 #if DEBUG
232      prom_printf ("Adding OF methods...\n");
233 #endif
234
235      prom_interpret (
236           /* All values in this forth code are in hex */
237           "hex "
238           /* Those are a few utilities ripped from Apple */
239           ": D2NIP decode-int nip nip ;\r"      // A useful function to save space
240           ": GPP$ get-package-property 0= ;\r"  // Another useful function to save space
241           ": ^on0 0= if -1 throw then ;\r"      // Bail if result zero
242           ": $CM $call-method ;\r"
243           );
244
245      /* Some forth words used by the release method */
246      prom_interpret (
247           " \" /chosen\" find-package if "
248                  "dup \" memory\" rot GPP$ if "
249                          "D2NIP swap "                           // ( MEMORY-ihandle "/chosen"-phandle )
250                          "\" mmu\" rot GPP$ if "
251                                  "D2NIP "                                // ( MEMORY-ihandle MMU-ihandle )
252                          "else "
253                                  "0 "                                    // ( MEMORY-ihandle 0 )
254                          "then "
255                  "else "
256                          "0 0 "                                          // ( 0 0 )
257                  "then "
258           "else "
259                  "0 0 "                                                  // ( 0 0 )
260           "then\r"
261           "value mmu# "
262           "value mem# "
263           );
264
265      prom_interpret (
266           ": ^mem mem# $CM ; "
267           ": ^mmu mmu# $CM ; "
268           );
269
270      DEBUG_F("OF interface initialized.\n");
271 }
272
273 prom_handle
274 prom_open (char *spec)
275 {
276      return call_prom ("open", 1, 1, spec, strlen(spec));
277 }
278
279 void
280 prom_close (prom_handle file)
281 {
282      call_prom ("close", 1, 0, file);
283 }
284
285 int
286 prom_read (prom_handle file, void *buf, int n)
287 {
288      int result = 0;
289      int retries = 10;
290
291      if (n == 0)
292           return 0;
293      while(--retries) {
294           result = (int)call_prom ("read", 3, 1, file, buf, n);
295           if (result != 0)
296                break;
297           call_prom("interpret", 1, 1, " 10 ms");
298      }
299
300      return result;
301 }
302
303 int
304 prom_write (prom_handle file, void *buf, int n)
305 {
306      return (int)call_prom ("write", 3, 1, file, buf, n);
307 }
308
309 int
310 prom_seek (prom_handle file, int pos)
311 {
312      int status = (int)call_prom ("seek", 3, 1, file, 0, pos);
313      return status == 0 || status == 1;
314 }
315
316 int
317 prom_lseek (prom_handle file, unsigned long long pos)
318 {
319      int status = (int)call_prom ("seek", 3, 1, file,
320                                   (unsigned int)(pos >> 32), (unsigned int)(pos & 0xffffffffUL));
321      return status == 0 || status == 1;
322 }
323
324 int
325 prom_loadmethod (prom_handle device, void* addr)
326 {
327      return (int)call_method_1 ("load", device, 1, addr);
328 }
329
330 int
331 prom_getblksize (prom_handle file)
332 {
333      return (int)call_method_1 ("block-size", file, 0);
334 }
335
336 int
337 prom_readblocks (prom_handle dev, int blockNum, int blockCount, void *buffer)
338 {
339 #if READ_BLOCKS_USE_READ
340      int status;
341      unsigned int blksize;
342
343      blksize = prom_getblksize(dev);
344      if (blksize <= 1)
345           blksize = 512;
346      status = prom_seek(dev, blockNum * blksize);
347      if (status != 1) {
348           return 0;
349           prom_printf("Can't seek to 0x%x\n", blockNum * blksize);
350      }
351
352      status = prom_read(dev, buffer, blockCount * blksize);
353 //  prom_printf("prom_readblocks, bl: %d, cnt: %d, status: %d\n",
354 //      blockNum, blockCount, status);
355
356      return status == (blockCount * blksize);
357 #else
358      int result;
359      int retries = 10;
360
361      if (blockCount == 0)
362           return blockCount;
363      while(--retries) {
364           result = call_method_1 ("read-blocks", dev, 3, buffer, blockNum, blockCount);
365           if (result != 0)
366                break;
367           call_prom("interpret", 1, 1, " 10 ms");
368      }
369
370      return result;
371 #endif
372 }
373
374 int
375 prom_getchar ()
376 {
377      char c[4];
378      int a;
379
380      while ((a = (int)call_prom ("read", 3, 1, prom_stdin, c, 4)) == 0)
381           ;
382      if (a == -1)
383           prom_abort ("EOF on console\n");
384      if (a == 3 && c[0] == '\e' && c[1] == '[')
385           return 0x100 | c[2];
386      return c[0];
387 }
388
389 int
390 prom_nbgetchar()
391 {
392      char ch;
393
394      return (int) call_prom("read", 3, 1, prom_stdin, &ch, 1) > 0? ch: -1;
395 }
396
397 void
398 prom_putchar (char c)
399 {
400      if (c == '\n')
401           call_prom ("write", 3, 1, prom_stdout, "\r\n", 2);
402      else
403           call_prom ("write", 3, 1, prom_stdout, &c, 1);
404 }
405
406 void
407 prom_puts (prom_handle file, char *s)
408 {
409      const char *p, *q;
410
411      for (p = s; *p != 0; p = q)
412      {
413           for (q = p; *q != 0 && *q != '\n'; ++q)
414                ;
415           if (q > p)
416                call_prom ("write", 3, 1, file, p, q - p);
417           if (*q != 0)
418           {
419                ++q;
420                call_prom ("write", 3, 1, file, "\r\n", 2);
421           }
422      }
423 }
424
425 void
426 prom_vfprintf (prom_handle file, char *fmt, va_list ap)
427 {
428      static char printf_buf[2048];
429      vsprintf (printf_buf, fmt, ap);
430      prom_puts (file, printf_buf);
431 }
432
433 void
434 prom_vprintf (char *fmt, va_list ap)
435 {
436      static char printf_buf[2048];
437      vsprintf (printf_buf, fmt, ap);
438      prom_puts (prom_stdout, printf_buf);
439 }
440
441 void
442 prom_fprintf (prom_handle file, char *fmt, ...)
443 {
444      va_list ap;
445      va_start (ap, fmt);
446      prom_vfprintf (file, fmt, ap);
447      va_end (ap);
448 }
449
450 void
451 prom_printf (char *fmt, ...)
452 {
453      va_list ap;
454      va_start (ap, fmt);
455      prom_vfprintf (prom_stdout, fmt, ap);
456      va_end (ap);
457 }
458
459 void
460 prom_perror (int error, char *filename)
461 {
462      if (error == FILE_ERR_EOF)
463           prom_printf("%s: Unexpected End Of File\n", filename);
464      else if (error == FILE_ERR_NOTFOUND)
465           prom_printf("%s: No such file or directory\n", filename);
466      else if (error == FILE_CANT_SEEK)
467           prom_printf("%s: Seek error\n", filename);
468      else if (error == FILE_IOERR)
469           prom_printf("%s: Input/output error\n", filename);
470      else if (error == FILE_BAD_PATH)
471           prom_printf("%s: Path too long\n", filename);
472      else if (error == FILE_ERR_BAD_TYPE)
473           prom_printf("%s: Not a regular file\n", filename);
474      else if (error == FILE_ERR_NOTDIR)
475           prom_printf("%s: Not a directory\n", filename);
476      else if (error == FILE_ERR_BAD_FSYS)
477           prom_printf("%s: Unknown or corrupt filesystem\n", filename);
478      else if (error == FILE_ERR_SYMLINK_LOOP)
479           prom_printf("%s: Too many levels of symbolic links\n", filename);
480      else if (error == FILE_ERR_LENGTH)
481           prom_printf("%s: File too large\n", filename);
482      else if (error == FILE_ERR_FSBUSY)
483           prom_printf("%s: Filesystem busy\n", filename);
484      else if (error == FILE_ERR_BADDEV)
485           prom_printf("%s: Unable to open file, Invalid device\n", filename);
486      else
487           prom_printf("%s: Unknown error\n", filename);
488 }
489
490 void
491 prom_readline (char *prompt, char *buf, int len)
492 {
493      int i = 0;
494      int c;
495
496      if (prompt)
497           prom_puts (prom_stdout, prompt);
498
499      while (i < len-1 && (c = prom_getchar ()) != '\r')
500      {
501           if (c >= 0x100)
502                continue;
503           if (c == 8)
504           {
505                if (i > 0)
506                {
507                     prom_puts (prom_stdout, "\b \b");
508                     i--;
509                }
510                else
511                     prom_putchar ('\a');
512           }
513           else if (isprint (c))
514           {
515                prom_putchar (c);
516                buf[i++] = c;
517           }
518           else
519                prom_putchar ('\a');
520      }
521      prom_putchar ('\n');
522      buf[i] = 0;
523 }
524
525 #ifdef CONFIG_SET_COLORMAP
526 int prom_set_color(prom_handle device, int color, int r, int g, int b)
527 {
528      return (int)call_prom( "call-method", 6, 1, "color!", device, color, b, g, r );
529 }
530 #endif /* CONFIG_SET_COLORMAP */
531
532 void
533 prom_exit ()
534 {
535      call_prom ("exit", 0, 0);
536 }
537
538 void
539 prom_abort (char *fmt, ...)
540 {
541      va_list ap;
542      va_start (ap, fmt);
543      prom_vfprintf (prom_stdout, fmt, ap);
544      va_end (ap);
545      prom_exit ();
546 }
547
548 void
549 prom_sleep (int seconds)
550 {
551      int end;
552      end = (prom_getms() + (seconds * 1000));
553      while (prom_getms() <= end);
554 }
555
556 void *
557 prom_claim (void *virt, unsigned int size, unsigned int align)
558 {
559      return call_prom ("claim", 3, 1, virt, size, align);
560 }
561
562 void
563 prom_release(void *virt, unsigned int size)
564 {
565      call_prom ("release", 2, 0, virt, size);
566 #if 0 /* this is bullshit, newworld OF RELEASE method works fine. */
567
568      /* release in not enough, it needs also an unmap call. This bit of forth
569       * code inspired from Darwin's bootloader but could be replaced by direct
570       * calls to the MMU package if needed
571       */
572      call_prom ("interpret", 3, 1,
573 #if DEBUG
574                 ".\" ReleaseMem:\" 2dup . . cr "
575 #endif
576                 "over \" translate\" ^mmu "             // Find out physical base
577                 "^on0 "                                 // Bail if translation failed
578                 "drop "                                 // Leaving phys on top of stack
579                 "2dup \" unmap\" ^mmu "                 // Unmap the space first
580                 "2dup \" release\" ^mmu "               // Then free the virtual pages
581                 "\" release\" ^mem "                    // Then free the physical pages
582                 ,size, virt
583           );
584 #endif /* bullshit */
585 }
586
587 void
588 prom_map (void *phys, void *virt, int size)
589 {
590      unsigned long msr = mfmsr();
591
592      /* Only create a mapping if we're running with relocation enabled. */
593      if ( (msr & MSR_IR) && (msr & MSR_DR) )
594           call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
595 }
596
597 void
598 prom_unmap (void *phys, void *virt, int size)
599 {
600      unsigned long msr = mfmsr();
601
602      /* Only unmap if we're running with relocation enabled. */
603      if ( (msr & MSR_IR) && (msr & MSR_DR) )
604           call_method_1 ("map", prom_mmu, 4, -1, size, virt, phys);
605 }
606
607 char *
608 prom_getargs ()
609 {
610      static char args[256];
611      int l;
612
613      l = prom_get_chosen ("bootargs", args, 255);
614      args[l] = '\0';
615      return args;
616 }
617
618 void
619 prom_setargs (char *args)
620 {
621      int l = strlen (args)+1;
622      if ((int)call_prom ("setprop", 4, 1, prom_chosen, "bootargs", args, l) != l)
623           prom_printf ("can't set args\n");
624 }
625
626 int prom_interpret (char *forth)
627 {
628      return (int)call_prom("interpret", 1, 1, forth);
629 }
630
631 int
632 prom_getms(void)
633 {
634      return (int) call_prom("milliseconds", 0, 1);
635 }
636
637 void
638 prom_pause(void)
639 {
640      call_prom("enter", 0, 0);
641 }
642
643 /*
644  * Local variables:
645  * c-file-style: "k&r"
646  * c-basic-offset: 5
647  * End:
648  */