installboot.h revision 1.30 1 /* $NetBSD: installboot.h,v 1.30 2006/02/18 11:01:51 dsl Exp $ */
2
3 /*-
4 * Copyright (c) 2002 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Luke Mewburn of Wasabi Systems.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the NetBSD
21 * Foundation, Inc. and its contributors.
22 * 4. Neither the name of The NetBSD Foundation nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 * POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 #ifndef _INSTALLBOOT_H
40 #define _INSTALLBOOT_H
41
42 #if HAVE_NBTOOL_CONFIG_H
43 #include "nbtool_config.h"
44 #include "../../sys/sys/bootblock.h"
45 #else
46 #include <sys/bootblock.h>
47 #include <sys/endian.h>
48 #endif
49
50 #include <sys/stat.h>
51 #include <stdint.h>
52
53 typedef enum {
54 /* flags from global options */
55 IB_VERBOSE = 1<<0, /* verbose operation */
56 IB_NOWRITE = 1<<1, /* don't write */
57 IB_CLEAR = 1<<2, /* clear boot block */
58 IB_EDIT = 1<<3, /* edit boot parameters */
59
60 /* flags from -o options */
61 IB_ALPHASUM = 1<<8, /* set Alpha checksum */
62 IB_APPEND = 1<<9, /* append stage 1 to EO(regular)F */
63 IB_SUNSUM = 1<<10, /* set Sun checksum */
64 IB_STAGE1START= 1<<11, /* start block for stage 1 provided */
65 IB_STAGE2START= 1<<12, /* start block for stage 2 provided */
66 IB_COMMAND = 1<<13, /* Amiga commandline option */
67 IB_RESETVIDEO = 1<<14, /* i386 reset video */
68 IB_CONSOLE = 1<<15, /* i386 console */
69 IB_CONSPEED = 1<<16, /* i386 console baud rate */
70 IB_TIMEOUT = 1<<17, /* i386 boot timeout */
71 IB_PASSWORD = 1<<18, /* i386 boot password */
72 IB_KEYMAP = 1<<19, /* i386 console keymap */
73 IB_CONSADDR = 1<<20, /* i386 console io address */
74 } ib_flags;
75
76 typedef struct {
77 ib_flags flags; /* flags (see above) */
78 struct ib_mach *machine; /* machine details (see below) */
79 struct ib_fs *fstype; /* file system details (see below) */
80 const char *filesystem; /* name of target file system */
81 int fsfd; /* open fd to filesystem */
82 struct stat fsstat; /* fstat(2) of fsfd */
83 const char *stage1; /* name of stage1 bootstrap */
84 int s1fd; /* open fd to stage1 */
85 struct stat s1stat; /* fstat(2) of s1fd */
86 uint64_t s1start; /* start block of stage1 */
87 const char *stage2; /* name of stage2 bootstrap */
88 uint64_t s2start; /* start block of stage2 */
89 /* parsed -o option=value data */
90 const char *command; /* name of command string */
91 const char *console; /* name of console */
92 int conspeed; /* console baud rate */
93 int consaddr; /* console io address */
94 const char *password; /* boot password */
95 int timeout; /* interactive boot timeout */
96 const char *keymap; /* keyboard translations */
97 } ib_params;
98
99 typedef struct {
100 uint64_t block;
101 uint32_t blocksize;
102 } ib_block;
103
104 struct ib_mach {
105 const char *name;
106 int (*setboot) (ib_params *);
107 int (*clearboot) (ib_params *);
108 int (*editboot) (ib_params *);
109 ib_flags valid_flags;
110 };
111
112 struct ib_fs {
113 /* compile time parameters */
114 const char *name;
115 int (*match) (ib_params *);
116 int (*findstage2) (ib_params *, uint32_t *, ib_block *);
117 /* run time fs specific parameters */
118 uint32_t blocksize;
119 uint32_t needswap;
120 off_t sblockloc; /* location of superblock */
121 };
122
123 typedef enum {
124 BBINFO_BIG_ENDIAN = 0,
125 BBINFO_LITTLE_ENDIAN = 1,
126 } bbinfo_endian;
127
128 struct bbinfo_params {
129 const char *magic; /* magic string to look for */
130 uint32_t offset; /* offset to write start of stage1 */
131 uint32_t blocksize; /* blocksize of stage1 */
132 uint32_t maxsize; /* max size of stage1 */
133 uint32_t headeroffset; /*
134 * header offset (relative to offset)
135 * to read stage1 into
136 */
137 bbinfo_endian endian;
138 };
139
140 extern struct ib_mach *machines[];
141 extern struct ib_fs fstypes[];
142
143 /* installboot.c */
144 uint16_t compute_sunsum(const uint16_t *);
145 int set_sunsum(ib_params *, uint16_t *, uint16_t);
146 int no_setboot(ib_params *);
147 int no_clearboot(ib_params *);
148 int no_editboot(ib_params *);
149
150 /* bbinfo.c */
151 int shared_bbinfo_clearboot(ib_params *, struct bbinfo_params *,
152 int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
153 int shared_bbinfo_setboot(ib_params *, struct bbinfo_params *,
154 int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
155
156 /* fstypes.c */
157 int hardcode_stage2(ib_params *, uint32_t *, ib_block *);
158 int ffs_match(ib_params *);
159 int ffs_findstage2(ib_params *, uint32_t *, ib_block *);
160 int raw_match(ib_params *);
161 int raw_findstage2(ib_params *, uint32_t *, ib_block *);
162
163 /* machines.c */
164 extern struct ib_mach ib_mach_alpha;
165 extern struct ib_mach ib_mach_amd64;
166 extern struct ib_mach ib_mach_amiga;
167 extern struct ib_mach ib_mach_ews4800mips;
168 extern struct ib_mach ib_mach_hp300;
169 extern struct ib_mach ib_mach_hp700;
170 extern struct ib_mach ib_mach_i386;
171 extern struct ib_mach ib_mach_macppc;
172 extern struct ib_mach ib_mach_news68k;
173 extern struct ib_mach ib_mach_newsmips;
174 extern struct ib_mach ib_mach_next68k;
175 extern struct ib_mach ib_mach_pmax;
176 extern struct ib_mach ib_mach_sparc;
177 extern struct ib_mach ib_mach_sparc64;
178 extern struct ib_mach ib_mach_sun2;
179 extern struct ib_mach ib_mach_sun3;
180 extern struct ib_mach ib_mach_vax;
181 extern struct ib_mach ib_mach_x68k;
182
183 #endif /* _INSTALLBOOT_H */
184