Determine last ext3 LBA to fix wild LBA reads
[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_get_chosen (char *name, void *mem, int len)
158 {
159      return prom_getprop (prom_chosen, name, mem, len);
160 }
161
162 int
163 prom_get_options (char *name, void *mem, int len)
164 {
165      if (prom_options == (void *)-1)
166           return -1;
167      return prom_getprop (prom_options, name, mem, len);
168 }
169
170 int
171 prom_get_devtype (char *device)
172 {
173      phandle    dev;
174      int        result;
175      char       tmp[64];
176
177      /* Find OF device phandle */
178      dev = prom_finddevice(device);
179      if (dev == PROM_INVALID_HANDLE) {
180           return FILE_ERR_BADDEV;
181      }
182
183      /* Check the kind of device */
184      result = prom_getprop(dev, "device_type", tmp, 63);
185      if (result == -1) {
186           prom_printf("can't get <device_type> for device: %s\n", device);
187           return FILE_ERR_BADDEV;
188      }
189      tmp[result] = 0;
190      if (!strcmp(tmp, "block"))
191           return FILE_DEVICE_BLOCK;
192      else if (!strcmp(tmp, "network"))
193           return FILE_DEVICE_NET;
194      else {
195           prom_printf("Unkown device type <%s>\n", tmp);
196           return FILE_ERR_BADDEV;
197      }
198 }
199
200 void
201 prom_init (prom_entry pp)
202 {
203      prom = pp;
204
205      prom_chosen = prom_finddevice ("/chosen");
206      if (prom_chosen == (void *)-1)
207           prom_exit ();
208      prom_options = prom_finddevice ("/options");
209      if (prom_get_chosen ("stdout", &prom_stdout, sizeof(prom_stdout)) <= 0)
210           prom_exit();
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");
217
218   // move cursor to fresh line
219      prom_printf ("\n");
220
221      /* Add a few OF methods (thanks Darwin) */
222 #if DEBUG
223      prom_printf ("Adding OF methods...\n");
224 #endif
225
226      prom_interpret (
227           /* All values in this forth code are in hex */
228           "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"
234           );
235
236      /* Some forth words used by the release method */
237      prom_interpret (
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 )
243                          "else "
244                                  "0 "                                    // ( MEMORY-ihandle 0 )
245                          "then "
246                  "else "
247                          "0 0 "                                          // ( 0 0 )
248                  "then "
249           "else "
250                  "0 0 "                                                  // ( 0 0 )
251           "then\r"
252           "value mmu# "
253           "value mem# "
254           );
255
256      prom_interpret (
257           ": ^mem mem# $CM ; "
258           ": ^mmu mmu# $CM ; "
259           );
260
261      DEBUG_F("OF interface initialized.\n");
262 }
263
264 prom_handle
265 prom_open (char *spec)
266 {
267      return call_prom ("open", 1, 1, spec, strlen(spec));
268 }
269
270 void
271 prom_close (prom_handle file)
272 {
273      call_prom ("close", 1, 0, file);
274 }
275
276 int
277 prom_read (prom_handle file, void *buf, int n)
278 {
279      int result = 0;
280      int retries = 10;
281
282      if (n == 0)
283           return 0;
284      while(--retries) {
285           result = (int)call_prom ("read", 3, 1, file, buf, n);
286           if (result != 0)
287                break;
288           call_prom("interpret", 1, 1, " 10 ms");
289      }
290
291      return result;
292 }
293
294 int
295 prom_write (prom_handle file, void *buf, int n)
296 {
297      return (int)call_prom ("write", 3, 1, file, buf, n);
298 }
299
300 int
301 prom_seek (prom_handle file, int pos)
302 {
303      int status = (int)call_prom ("seek", 3, 1, file, 0, pos);
304      return status == 0 || status == 1;
305 }
306
307 int
308 prom_lseek (prom_handle file, unsigned long long pos)
309 {
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;
313 }
314
315 int
316 prom_loadmethod (prom_handle device, void* addr)
317 {
318      return (int)call_method_1 ("load", device, 1, addr);
319 }
320
321 int
322 prom_getblksize (prom_handle file)
323 {
324      return (int)call_method_1 ("block-size", file, 0);
325 }
326
327 int
328 prom_readblocks (prom_handle dev, int blockNum, int blockCount, void *buffer)
329 {
330 #if READ_BLOCKS_USE_READ
331      int status;
332      unsigned int blksize;
333
334      blksize = prom_getblksize(dev);
335      if (blksize <= 1)
336           blksize = 512;
337      status = prom_seek(dev, blockNum * blksize);
338      if (status != 1) {
339           return 0;
340           prom_printf("Can't seek to 0x%x\n", blockNum * blksize);
341      }
342
343      status = prom_read(dev, buffer, blockCount * blksize);
344 //  prom_printf("prom_readblocks, bl: %d, cnt: %d, status: %d\n",
345 //      blockNum, blockCount, status);
346
347      return status == (blockCount * blksize);
348 #else
349      int result;
350      int retries = 10;
351
352      if (blockCount == 0)
353           return blockCount;
354      while(--retries) {
355           result = call_method_1 ("read-blocks", dev, 3, buffer, blockNum, blockCount);
356           if (result != 0)
357                break;
358           call_prom("interpret", 1, 1, " 10 ms");
359      }
360
361      return result;
362 #endif
363 }
364
365 int
366 prom_getchar ()
367 {
368      char c[4];
369      int a;
370
371      while ((a = (int)call_prom ("read", 3, 1, prom_stdin, c, 4)) == 0)
372           ;
373      if (a == -1)
374           prom_abort ("EOF on console\n");
375      if (a == 3 && c[0] == '\e' && c[1] == '[')
376           return 0x100 | c[2];
377      return c[0];
378 }
379
380 int
381 prom_nbgetchar()
382 {
383      char ch;
384
385      return (int) call_prom("read", 3, 1, prom_stdin, &ch, 1) > 0? ch: -1;
386 }
387
388 void
389 prom_putchar (char c)
390 {
391      if (c == '\n')
392           call_prom ("write", 3, 1, prom_stdout, "\r\n", 2);
393      else
394           call_prom ("write", 3, 1, prom_stdout, &c, 1);
395 }
396
397 void
398 prom_puts (prom_handle file, char *s)
399 {
400      const char *p, *q;
401
402      for (p = s; *p != 0; p = q)
403      {
404           for (q = p; *q != 0 && *q != '\n'; ++q)
405                ;
406           if (q > p)
407                call_prom ("write", 3, 1, file, p, q - p);
408           if (*q != 0)
409           {
410                ++q;
411                call_prom ("write", 3, 1, file, "\r\n", 2);
412           }
413      }
414 }
415
416 void
417 prom_vfprintf (prom_handle file, char *fmt, va_list ap)
418 {
419      static char printf_buf[2048];
420      vsprintf (printf_buf, fmt, ap);
421      prom_puts (file, printf_buf);
422 }
423
424 void
425 prom_vprintf (char *fmt, va_list ap)
426 {
427      static char printf_buf[2048];
428      vsprintf (printf_buf, fmt, ap);
429      prom_puts (prom_stdout, printf_buf);
430 }
431
432 void
433 prom_fprintf (prom_handle file, char *fmt, ...)
434 {
435      va_list ap;
436      va_start (ap, fmt);
437      prom_vfprintf (file, fmt, ap);
438      va_end (ap);
439 }
440
441 void
442 prom_printf (char *fmt, ...)
443 {
444      va_list ap;
445      va_start (ap, fmt);
446      prom_vfprintf (prom_stdout, fmt, ap);
447      va_end (ap);
448 }
449
450 void
451 prom_perror (int error, char *filename)
452 {
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);
477      else
478           prom_printf("%s: Unknown error\n", filename);
479 }
480
481 void
482 prom_readline (char *prompt, char *buf, int len)
483 {
484      int i = 0;
485      int c;
486
487      if (prompt)
488           prom_puts (prom_stdout, prompt);
489
490      while (i < len-1 && (c = prom_getchar ()) != '\r')
491      {
492           if (c >= 0x100)
493                continue;
494           if (c == 8)
495           {
496                if (i > 0)
497                {
498                     prom_puts (prom_stdout, "\b \b");
499                     i--;
500                }
501                else
502                     prom_putchar ('\a');
503           }
504           else if (isprint (c))
505           {
506                prom_putchar (c);
507                buf[i++] = c;
508           }
509           else
510                prom_putchar ('\a');
511      }
512      prom_putchar ('\n');
513      buf[i] = 0;
514 }
515
516 #ifdef CONFIG_SET_COLORMAP
517 int prom_set_color(prom_handle device, int color, int r, int g, int b)
518 {
519      return (int)call_prom( "call-method", 6, 1, "color!", device, color, b, g, r );
520 }
521 #endif /* CONFIG_SET_COLORMAP */
522
523 void
524 prom_exit ()
525 {
526      call_prom ("exit", 0, 0);
527 }
528
529 void
530 prom_abort (char *fmt, ...)
531 {
532      va_list ap;
533      va_start (ap, fmt);
534      prom_vfprintf (prom_stdout, fmt, ap);
535      va_end (ap);
536      prom_exit ();
537 }
538
539 void
540 prom_sleep (int seconds)
541 {
542      int end;
543      end = (prom_getms() + (seconds * 1000));
544      while (prom_getms() <= end);
545 }
546
547 void *
548 prom_claim (void *virt, unsigned int size, unsigned int align)
549 {
550      return call_prom ("claim", 3, 1, virt, size, align);
551 }
552
553 void
554 prom_release(void *virt, unsigned int size)
555 {
556      call_prom ("release", 2, 0, virt, size);
557 #if 0 /* this is bullshit, newworld OF RELEASE method works fine. */
558
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
562       */
563      call_prom ("interpret", 3, 1,
564 #if DEBUG
565                 ".\" ReleaseMem:\" 2dup . . cr "
566 #endif
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
573                 ,size, virt
574           );
575 #endif /* bullshit */
576 }
577
578 void
579 prom_map (void *phys, void *virt, int size)
580 {
581      unsigned long msr = mfmsr();
582
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);
586 }
587
588 void
589 prom_unmap (void *phys, void *virt, int size)
590 {
591      unsigned long msr = mfmsr();
592
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);
596 }
597
598 char *
599 prom_getargs ()
600 {
601      static char args[256];
602      int l;
603
604      l = prom_get_chosen ("bootargs", args, 255);
605      args[l] = '\0';
606      return args;
607 }
608
609 void
610 prom_setargs (char *args)
611 {
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");
615 }
616
617 int prom_interpret (char *forth)
618 {
619      return (int)call_prom("interpret", 1, 1, forth);
620 }
621
622 int
623 prom_getms(void)
624 {
625      return (int) call_prom("milliseconds", 0, 1);
626 }
627
628 void
629 prom_pause(void)
630 {
631      call_prom("enter", 0, 0);
632 }
633
634 /*
635  * Local variables:
636  * c-file-style: "k&r"
637  * c-basic-offset: 5
638  * End:
639  */