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