2 * prom.h - Routines for talking to the Open Firmware PROM
4 * Copyright (C) 2001 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 typedef void *prom_handle;
34 typedef void *ihandle;
35 typedef void *phandle;
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 #define TOK_IPV6 "ipv6"
41 #define PROM_CLAIM_MAX_ADDR 0x8000000
42 #define BOOTLASTSZ 1024
43 #define FW_NBR_REBOOTSZ 4
46 typedef int (*prom_entry)(struct prom_args *);
48 extern void prom_init (prom_entry pe);
50 extern prom_entry prom;
54 extern prom_handle prom_stdin;
55 extern prom_handle prom_stdout;
57 prom_handle prom_open (char *spec);
58 int prom_read (prom_handle file, void *buf, int len);
59 int prom_write (prom_handle file, void *buf, int len);
60 int prom_seek (prom_handle file, int pos);
61 int prom_lseek (prom_handle file, unsigned long long pos);
62 int prom_readblocks (prom_handle file, int blockNum, int blockCount, void *buffer);
63 void prom_close (prom_handle file);
64 int prom_getblksize (prom_handle file);
65 int prom_loadmethod (prom_handle device, void* addr);
73 void prom_putchar (char);
77 void prom_vprintf (char *fmt, va_list ap) __attribute__ ((format (printf, 1, 0)));
78 void prom_fprintf (prom_handle dev, char *fmt, ...) __attribute__ ((format (printf, 2, 3)));
79 void prom_printf (char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
81 void prom_vprintf (char *fmt, va_list ap);
82 void prom_fprintf (prom_handle dev, char *fmt, ...);
83 void prom_printf (char *fmt, ...);
86 void prom_perror (int error, char *filename);
87 void prom_readline (char *prompt, char *line, int len);
88 int prom_set_color(prom_handle device, int color, int r, int g, int b);
92 void *prom_claim_chunk(void *virt, unsigned int size, unsigned int align);
93 void *prom_claim (void *virt, unsigned int size, unsigned int align);
94 void prom_release(void *virt, unsigned int size);
95 void prom_map (void *phys, void *virt, int size);
97 /* packages and device nodes */
99 prom_handle prom_finddevice (char *name);
100 prom_handle prom_findpackage (char *path);
101 int prom_getprop (prom_handle dev, char *name, void *buf, int len);
102 int prom_setprop (prom_handle dev, char *name, void *buf, int len);
103 int prom_getproplen(prom_handle, const char *);
104 int prom_get_devtype (char *device);
108 char *prom_getargs ();
109 void prom_setargs (char *args);
112 void prom_abort (char *fmt, ...);
113 void prom_sleep (int seconds);
115 int prom_interpret (char *forth);
117 int prom_get_chosen (char *name, void *mem, int len);
118 int prom_get_options (char *name, void *mem, int len);
119 int prom_set_options (char *name, void *mem, int len);
121 extern int prom_getms(void);
122 extern void prom_pause(void);
124 extern void *call_prom (const char *service, int nargs, int nret, ...);
125 extern void *call_prom_return (const char *service, int nargs, int nret, ...);
130 * "bootp-response" is the property name which is specified in
131 * the recommended practice doc for obp-tftp. However, pmac
132 * provides a "dhcp-response" property and chrp provides a
133 * "bootpreply-packet" property. The latter appears to begin the
134 * bootp packet at offset 0x2a in the property for some reason.
137 struct bootp_property_offset {
138 char *name; /* property name */
139 int offset; /* offset into property where bootp packet occurs */
142 static const struct bootp_property_offset bootp_response_properties[] = {
143 { .name = "bootp-response", .offset = 0 },
144 { .name = "dhcp-response", .offset = 0 },
145 { .name = "bootpreply-packet", .offset = 0x2a },
148 struct bootp_packet {
149 __u8 op, htype, hlen, hops;
152 __u32 ciaddr, yiaddr, siaddr, giaddr;
153 unsigned char chaddr[16];
154 unsigned char sname[64];
155 unsigned char file[128];
156 unsigned char options[]; /* vendor options */
159 struct bootp_packet * prom_get_netinfo (void);
160 char * prom_get_mac (struct bootp_packet * packet);
161 char * prom_get_ip (struct bootp_packet * packet);