prom functions
[yaboot.git] / 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 "types.h"
31 #include "stdarg.h"
32
33 typedef void *prom_handle;
34 typedef void *ihandle;
35 typedef void *phandle;
36
37 #define PROM_INVALID_HANDLE     ((prom_handle)-1UL)
38 #define BOOTDEVSZ               (2048) /* iscsi args can be in excess of 1040 bytes */
39 #define TOK_ISCSI               "iscsi"
40
41 struct prom_args;
42 typedef int (*prom_entry)(struct prom_args *);
43
44 extern void prom_init (prom_entry pe);
45
46 extern prom_entry prom;
47
48 /* I/O */
49
50 extern prom_handle prom_stdin;
51 extern prom_handle prom_stdout;
52
53 prom_handle prom_open (char *spec);
54 int prom_read (prom_handle file, void *buf, int len);
55 int prom_write (prom_handle file, void *buf, int len);
56 int prom_seek (prom_handle file, int pos);
57 int prom_lseek (prom_handle file, unsigned long long pos);
58 int prom_readblocks (prom_handle file, int blockNum, int blockCount, void *buffer);
59 void prom_close (prom_handle file);
60 int prom_getblksize (prom_handle file);
61 int prom_loadmethod (prom_handle device, void* addr);
62
63 #define K_UP    0x141
64 #define K_DOWN  0x142
65 #define K_LEFT  0x144
66 #define K_RIGHT 0x143
67
68 int prom_getchar ();
69 void prom_putchar (char);
70 int prom_nbgetchar();
71
72 #ifdef __GNUC__
73 void prom_vprintf (char *fmt, va_list ap) __attribute__ ((format (printf, 1, 0)));
74 void prom_fprintf (prom_handle dev, char *fmt, ...) __attribute__ ((format (printf, 2, 3)));
75 void prom_printf (char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
76 #else
77 void prom_vprintf (char *fmt, va_list ap);
78 void prom_fprintf (prom_handle dev, char *fmt, ...);
79 void prom_printf (char *fmt, ...);
80 #endif
81
82 void prom_perror (int error, char *filename);
83 void prom_readline (char *prompt, char *line, int len);
84 int prom_set_color(prom_handle device, int color, int r, int g, int b);
85
86 /* memory */
87
88 void *prom_claim (void *virt, unsigned int size, unsigned int align);
89 void prom_release(void *virt, unsigned int size);
90 void prom_map (void *phys, void *virt, int size);
91
92 /* packages and device nodes */
93
94 prom_handle prom_finddevice (char *name);
95 prom_handle prom_findpackage (char *path);
96 int prom_getprop (prom_handle dev, char *name, void *buf, int len);
97 int prom_setprop (prom_handle dev, char *name, void *buf, int len);
98 int prom_getproplen(prom_handle, const char *);
99 int prom_get_devtype (char *device);
100
101 /* misc */
102
103 char *prom_getargs ();
104 void prom_setargs (char *args);
105
106 void prom_exit ();
107 void prom_abort (char *fmt, ...);
108 void prom_sleep (int seconds);
109
110 int prom_interpret (char *forth);
111
112 int prom_get_chosen (char *name, void *mem, int len);
113 int prom_get_options (char *name, void *mem, int len);
114 int prom_set_options (char *name, void *mem, int len);
115
116 extern int prom_getms(void);
117 extern void prom_pause(void);
118
119 extern void *call_prom (const char *service, int nargs, int nret, ...);
120 extern void *call_prom_return (const char *service, int nargs, int nret, ...);
121
122 /* Netboot stuffs */
123
124 /*
125  * "bootp-response" is the property name which is specified in
126  * the recommended practice doc for obp-tftp. However, pmac
127  * provides a "dhcp-response" property and chrp provides a
128  * "bootpreply-packet" property.  The latter appears to begin the
129  * bootp packet at offset 0x2a in the property for some reason.
130  */
131
132 struct bootp_property_offset {
133      char *name; /* property name */
134      int offset; /* offset into property where bootp packet occurs */
135 };
136
137 static const struct bootp_property_offset bootp_response_properties[] = {
138      { .name = "bootp-response", .offset = 0 },
139      { .name = "dhcp-response", .offset = 0 },
140      { .name = "bootpreply-packet", .offset = 0x2a },
141 };
142
143 struct bootp_packet {
144      __u8 op, htype, hlen, hops;
145      __u32 xid;
146      __u16 secs, flags;
147      __u32 ciaddr, yiaddr, siaddr, giaddr;
148      unsigned char chaddr[16];
149      unsigned char sname[64];
150      unsigned char file[128];
151      /* vendor options go here if we need them */
152 };
153
154 struct bootp_packet * prom_get_netinfo (void);
155 char * prom_get_mac (struct bootp_packet * packet);
156 char * prom_get_ip (struct bootp_packet * packet);
157
158 #endif