installboot.h revision 1.15 1 /* $NetBSD: installboot.h,v 1.15 2002/10/03 05:31:25 lukem 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_CONFIG_H
43 #include "config.h"
44 #include "../../sys/sys/bootblock.h"
45 #else
46 #include <sys/bootblock.h>
47 #endif
48
49 #include <sys/stat.h>
50 #include <stdint.h>
51
52 typedef enum {
53 /* flags from global options */
54 IB_VERBOSE = 1<<0, /* verbose operation */
55 IB_NOWRITE = 1<<1, /* don't write */
56 IB_CLEAR = 1<<2, /* clear boot block */
57
58 /* flags from -o options */
59 IB_ALPHASUM = 1<<8, /* set Alpha checksum */
60 IB_APPEND = 1<<9, /* append stage 1 to EO(regular)F */
61 IB_SUNSUM = 1<<10, /* set Sun checksum */
62 IB_STAGE1START= 1<<11, /* start block for stage 1 provided */
63 IB_STAGE2START= 1<<12, /* start block for stage 2 provided */
64 } ib_flags;
65
66 typedef struct {
67 ib_flags flags; /* flags (see above) */
68 struct ib_mach *machine; /* machine details (see below) */
69 struct ib_fs *fstype; /* file system details (see below) */
70 const char *filesystem; /* name of target file system */
71 int fsfd; /* open fd to filesystem */
72 struct stat fsstat; /* fstat(2) of fsfd */
73 const char *stage1; /* name of stage1 bootstrap */
74 int s1fd; /* open fd to stage1 */
75 struct stat s1stat; /* fstat(2) of s1fd */
76 uint32_t s1start; /* start block of stage1 */
77 const char *stage2; /* name of stage2 bootstrap */
78 uint32_t s2start; /* start block of stage2 */
79 } ib_params;
80
81 typedef struct {
82 uint32_t block;
83 uint32_t blocksize;
84 } ib_block;
85
86 struct ib_mach {
87 const char *name;
88 int (*parseopt) (ib_params *, const char *);
89 int (*setboot) (ib_params *);
90 int (*clearboot) (ib_params *);
91 };
92
93 struct ib_fs {
94 /* compile time parameters */
95 const char *name;
96 int (*match) (ib_params *);
97 int (*findstage2) (ib_params *, uint32_t *, ib_block *);
98 /* run time fs specific parameters */
99 uint32_t blocksize;
100 uint32_t needswap;
101 };
102
103 typedef enum {
104 BBINFO_BIG_ENDIAN = 0,
105 BBINFO_LITTLE_ENDIAN = 1,
106 } bbinfo_endian;
107
108 struct bbinfo_params {
109 const char *magic; /* magic string to look for */
110 uint32_t offset; /* offset to write start of stage1 */
111 uint32_t blocksize; /* blocksize of stage1 */
112 uint32_t maxsize; /* max size of stage1 */
113 uint32_t headeroffset; /*
114 * header offset (relative to offset)
115 * to read stage1 into
116 */
117 bbinfo_endian endian;
118 };
119
120 extern struct ib_mach machines[];
121 extern struct ib_fs fstypes[];
122
123 /* installboot.c */
124 int parseoptionflag(ib_params *, const char *, ib_flags);
125 uint16_t compute_sunsum(const uint16_t *);
126 int set_sunsum(ib_params *, uint16_t *, uint16_t);
127 int no_parseopt(ib_params *, const char *);
128 int no_setboot(ib_params *);
129 int no_clearboot(ib_params *);
130
131 /* bbinfo.c */
132 int shared_bbinfo_clearboot(ib_params *, struct bbinfo_params *,
133 int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
134 int shared_bbinfo_setboot(ib_params *, struct bbinfo_params *,
135 int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
136
137 /* fstypes.c */
138 int hardcode_stage2(ib_params *, uint32_t *, ib_block *);
139 int ffs_match(ib_params *);
140 int ffs_findstage2(ib_params *, uint32_t *, ib_block *);
141 int raw_match(ib_params *);
142 int raw_findstage2(ib_params *, uint32_t *, ib_block *);
143
144 /* machines.c */
145 int alpha_parseopt(ib_params *, const char *);
146 int alpha_setboot(ib_params *);
147 int alpha_clearboot(ib_params *);
148 int macppc_setboot(ib_params *);
149 int macppc_clearboot(ib_params *);
150 int news68k_setboot(ib_params *);
151 int news68k_clearboot(ib_params *);
152 int newsmips_setboot(ib_params *);
153 int newsmips_clearboot(ib_params *);
154 int pmax_parseopt(ib_params *, const char *);
155 int pmax_setboot(ib_params *);
156 int pmax_clearboot(ib_params *);
157 int sparc_setboot(ib_params *);
158 int sparc_clearboot(ib_params *);
159 int sparc64_setboot(ib_params *);
160 int sparc64_clearboot(ib_params *);
161 int sun68k_setboot(ib_params *);
162 int sun68k_clearboot(ib_params *);
163 int vax_parseopt(ib_params *, const char *);
164 int vax_setboot(ib_params *);
165 int vax_clearboot(ib_params *);
166 int x68k_setboot(ib_params *);
167 int x68k_clearboot(ib_params *);
168
169 #endif /* _INSTALLBOOT_H */
170