include/prom.h

   1 /*
   2  *  prom.h - Routines for talking to the Open Firmware PROM
   3  *
   4  *  Copyright (C) 2001 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 #ifndef PROM_H
  28 #define PROM_H
  29
  30 #include "stdarg.h"
  31
  32 typedef void *prom_handle;
  33 typedef void *ihandle;
  34 typedef void *phandle;
  35
  36 #define PROM_INVALID_HANDLE     ((prom_handle)-1UL)
  37 #define BOOTDEVSZ               (2048) /* iscsi args can be in excess of 1040 bytes */
  38 #define TOK_ISCSI               "iscsi"
  39
  40 struct prom_args;
  41 typedef int (*prom_entry)(struct prom_args *);
  42
  43 extern void prom_init (prom_entry pe);
  44
  45 extern prom_entry prom;
  46
  47 /* I/O */
  48
  49 extern prom_handle prom_stdin;
  50 extern prom_handle prom_stdout;
  51
  52 prom_handle prom_open (char *spec);
  53 int prom_read (prom_handle file, void *buf, int len);
  54 int prom_write (prom_handle file, void *buf, int len);
  55 int prom_seek (prom_handle file, int pos);
  56 int prom_lseek (prom_handle file, unsigned long long pos);
  57 int prom_readblocks (prom_handle file, int blockNum, int blockCount, void *buffer);
  58 void prom_close (prom_handle file);
  59 int prom_getblksize (prom_handle file);
  60 int prom_loadmethod (prom_handle device, void* addr);
  61
  62 #define K_UP    0x141
  63 #define K_DOWN  0x142
  64 #define K_LEFT  0x144
  65 #define K_RIGHT 0x143
  66
  67 int prom_getchar ();
  68 void prom_putchar (char);
  69 int prom_nbgetchar();
  70
  71 #ifdef __GNUC__
  72 void prom_vprintf (char *fmt, va_list ap) __attribute__ ((format (printf, 1, 0)));
  73 void prom_fprintf (prom_handle dev, char *fmt, ...) __attribute__ ((format (printf, 2, 3)));
  74 void prom_printf (char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
  75 #else
  76 void prom_vprintf (char *fmt, va_list ap);
  77 void prom_fprintf (prom_handle dev, char *fmt, ...);
  78 void prom_printf (char *fmt, ...);
  79 #endif
  80
  81 void prom_perror (int error, char *filename);
  82 void prom_readline (char *prompt, char *line, int len);
  83 int prom_set_color(prom_handle device, int color, int r, int g, int b);
  84
  85 /* memory */
  86
  87 void *prom_claim (void *virt, unsigned int size, unsigned int align);
  88 void prom_release(void *virt, unsigned int size);
  89 void prom_map (void *phys, void *virt, int size);
  90
  91 /* packages and device nodes */
  92
  93 prom_handle prom_finddevice (char *name);
  94 prom_handle prom_findpackage (char *path);
  95 int prom_getprop (prom_handle dev, char *name, void *buf, int len);
  96 int prom_getproplen(prom_handle, const char *);
  97 int prom_get_devtype (char *device);
  98
  99 /* misc */
 100
 101 char *prom_getargs ();
 102 void prom_setargs (char *args);
 103
 104 void prom_exit ();
 105 void prom_abort (char *fmt, ...);
 106 void prom_sleep (int seconds);
 107
 108 int prom_interpret (char *forth);
 109
 110 int prom_get_chosen (char *name, void *mem, int len);
 111 int prom_get_options (char *name, void *mem, int len);
 112
 113 extern int prom_getms(void);
 114 extern void prom_pause(void);
 115
 116 extern void *call_prom (const char *service, int nargs, int nret, ...);
 117 extern void *call_prom_return (const char *service, int nargs, int nret, ...);
 118
 119 #endif