xref: /netbsd-src/usr.sbin/installboot/installboot.h (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: installboot.h,v 1.25 2004/08/15 22:00:12 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 
59 				/* flags from -o options */
60 	IB_ALPHASUM =	1<<8,		/* set Alpha checksum */
61 	IB_APPEND =	1<<9,		/* append stage 1 to EO(regular)F */
62 	IB_SUNSUM =	1<<10,		/* set Sun checksum */
63 	IB_STAGE1START=	1<<11,		/* start block for stage 1 provided */
64 	IB_STAGE2START=	1<<12,		/* start block for stage 2 provided */
65 	IB_COMMAND = 	1<<13,		/* Amiga commandline option */
66 	IB_RESETVIDEO =	1<<14,		/* i386 reset video */
67 	IB_CONSOLE =	1<<15,		/* i386 console */
68 	IB_CONSPEED =	1<<16,		/* i386 console baud rate */
69 	IB_TIMEOUT =	1<<17,		/* i386 boot timeout */
70 	IB_PASSWORD =	1<<18,		/* i386 boot password */
71 	IB_KEYMAP = 	1<<19,		/* i386 console keymap */
72 	IB_CONSADDR = 	1<<20,		/* i386 console io address */
73 } ib_flags;
74 
75 typedef struct {
76 	ib_flags	 flags;		/* flags (see above) */
77 	struct ib_mach	*machine;	/* machine details (see below) */
78 	struct ib_fs	*fstype;	/* file system details (see below) */
79 	const char	*filesystem;	/* name of target file system */
80 	int		 fsfd;		/*  open fd to filesystem */
81 	struct stat	 fsstat;	/*  fstat(2) of fsfd */
82 	const char	*stage1;	/* name of stage1 bootstrap */
83 	int		 s1fd;		/*  open fd to stage1 */
84 	struct stat	 s1stat;	/*  fstat(2) of s1fd */
85 	uint64_t	 s1start;	/*  start block of stage1 */
86 	const char	*stage2;	/* name of stage2 bootstrap */
87 	uint64_t	 s2start;	/*  start block of stage2 */
88 		/* parsed -o option=value data */
89 	const char	*command;	/* name of command string */
90 	const char	*console;	/* name of console */
91 	int		 conspeed;	/* console baud rate */
92 	int		 consaddr;	/* console io address */
93 	const char	*password;	/* boot password */
94 	int		 timeout;	/* interactive boot timeout */
95 	const char	*keymap;	/* keyboard translations */
96 } ib_params;
97 
98 typedef struct {
99 	uint64_t	block;
100 	uint32_t	blocksize;
101 } ib_block;
102 
103 struct ib_mach {
104 	const char	*name;
105 	int		(*setboot)	(ib_params *);
106 	int		(*clearboot)	(ib_params *);
107 	ib_flags	valid_flags;
108 };
109 
110 struct ib_fs {
111 		/* compile time parameters */
112 	const char	*name;
113 	int		(*match)	(ib_params *);
114 	int		(*findstage2)	(ib_params *, uint32_t *, ib_block *);
115 		/* run time fs specific parameters */
116 	uint32_t	 blocksize;
117 	uint32_t	 needswap;
118 	off_t		sblockloc;	/* location of superblock */
119 };
120 
121 typedef enum {
122 	BBINFO_BIG_ENDIAN =	0,
123 	BBINFO_LITTLE_ENDIAN =	1,
124 } bbinfo_endian;
125 
126 struct bbinfo_params {
127 	const char	*magic;		/* magic string to look for */
128 	uint32_t	offset;		/* offset to write start of stage1 */
129 	uint32_t	blocksize;	/* blocksize of stage1 */
130 	uint32_t	maxsize;	/* max size of stage1 */
131 	uint32_t	headeroffset;	/*
132 					 * header offset (relative to offset)
133 					 * to read stage1 into
134 					 */
135 	bbinfo_endian	endian;
136 };
137 
138 extern struct ib_mach	machines[];
139 extern struct ib_fs	fstypes[];
140 
141 	/* installboot.c */
142 uint16_t	compute_sunsum(const uint16_t *);
143 int		set_sunsum(ib_params *, uint16_t *, uint16_t);
144 int		no_setboot(ib_params *);
145 int		no_clearboot(ib_params *);
146 
147 	/* bbinfo.c */
148 int		shared_bbinfo_clearboot(ib_params *, struct bbinfo_params *,
149 		    int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
150 int		shared_bbinfo_setboot(ib_params *, struct bbinfo_params *,
151 		    int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
152 
153 	/* fstypes.c */
154 int		hardcode_stage2(ib_params *, uint32_t *, ib_block *);
155 int		ffs_match(ib_params *);
156 int		ffs_findstage2(ib_params *, uint32_t *, ib_block *);
157 int		raw_match(ib_params *);
158 int		raw_findstage2(ib_params *, uint32_t *, ib_block *);
159 
160 	/* machines.c */
161 int		alpha_setboot(ib_params *);
162 int		alpha_clearboot(ib_params *);
163 int		amiga_setboot(ib_params *);
164 int		hp300_setboot(ib_params *);
165 int		i386_setboot(ib_params *);
166 int		macppc_setboot(ib_params *);
167 int		macppc_clearboot(ib_params *);
168 int		news68k_setboot(ib_params *);
169 int		news68k_clearboot(ib_params *);
170 int		next68k_setboot(ib_params *);
171 int		newsmips_setboot(ib_params *);
172 int		newsmips_clearboot(ib_params *);
173 int		pmax_setboot(ib_params *);
174 int		pmax_clearboot(ib_params *);
175 int		sparc_setboot(ib_params *);
176 int		sparc_clearboot(ib_params *);
177 int		sparc64_setboot(ib_params *);
178 int		sparc64_clearboot(ib_params *);
179 int		sun68k_setboot(ib_params *);
180 int		sun68k_clearboot(ib_params *);
181 int		vax_setboot(ib_params *);
182 int		vax_clearboot(ib_params *);
183 int		x68k_setboot(ib_params *);
184 int		x68k_clearboot(ib_params *);
185 
186 #endif	/* _INSTALLBOOT_H */
187