1/*	$NetBSD: installboot.h,v 1.37 2010/01/14 17:49:32 drochner 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
46typedef 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_MODULES =	1<<21,		/* i386: load modules */
69	IB_BOOTCONF = 	1<<22,		/* i386: read boot.conf */
70} ib_flags;
71
72typedef struct {
73	ib_flags	 flags;		/* flags (see above) */
74	struct ib_mach	*machine;	/* machine details (see below) */
75	struct ib_fs	*fstype;	/* file system details (see below) */
76	const char	*filesystem;	/* name of target file system */
77	int		 fsfd;		/*  open fd to filesystem */
78	struct stat	 fsstat;	/*  fstat(2) of fsfd */
79	const char	*stage1;	/* name of stage1 bootstrap */
80	int		 s1fd;		/*  open fd to stage1 */
81	struct stat	 s1stat;	/*  fstat(2) of s1fd */
82	uint64_t	 s1start;	/*  start block of stage1 */
83	const char	*stage2;	/* name of stage2 bootstrap */
84	uint64_t	 s2start;	/*  start block of stage2 */
85	uint32_t	 sectorsize;	/* sector size of target fs */
86		/* parsed -o option=value data */
87	const char	*command;	/* name of command string */
88	const char	*console;	/* name of console */
89	int		 conspeed;	/* console baud rate */
90	int		 consaddr;	/* console io address */
91	const char	*password;	/* boot password */
92	int		 timeout;	/* interactive boot timeout */
93	const char	*keymap;	/* keyboard translations */
94} ib_params;
95
96typedef struct {
97	uint64_t	block;
98	uint32_t	blocksize;
99} ib_block;
100
101struct ib_mach {
102	const char	*name;
103	int		(*setboot)	(ib_params *);
104	int		(*clearboot)	(ib_params *);
105	int		(*editboot)	(ib_params *);
106	ib_flags	valid_flags;
107};
108
109struct ib_fs {
110		/* compile time parameters */
111	const char	*name;
112	int		(*match)	(ib_params *);
113	int		(*findstage2)	(ib_params *, uint32_t *, ib_block *);
114		/* run time fs specific parameters */
115	uint32_t	 blocksize;
116	uint32_t	 needswap;
117	off_t		sblockloc;	/* location of superblock */
118	off_t		offset;		/* file system offset (e.g. RAID) */
119};
120
121typedef enum {
122	BBINFO_BIG_ENDIAN =	0,
123	BBINFO_LITTLE_ENDIAN =	1,
124} bbinfo_endian;
125
126struct 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
138extern struct ib_mach	* const machines[];
139extern struct ib_fs	fstypes[];
140
141	/* installboot.c */
142uint16_t	compute_sunsum(const uint16_t *);
143int		set_sunsum(ib_params *, uint16_t *, uint16_t);
144int		no_setboot(ib_params *);
145int		no_clearboot(ib_params *);
146int		no_editboot(ib_params *);
147
148	/* bbinfo.c */
149int		shared_bbinfo_clearboot(ib_params *, struct bbinfo_params *,
150		    int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
151int		shared_bbinfo_setboot(ib_params *, struct bbinfo_params *,
152		    int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
153
154	/* fstypes.c */
155int		hardcode_stage2(ib_params *, uint32_t *, ib_block *);
156int		ffs_match(ib_params *);
157int		ffs_findstage2(ib_params *, uint32_t *, ib_block *);
158int		raid_match(ib_params *);
159int		raw_match(ib_params *);
160int		raw_findstage2(ib_params *, uint32_t *, ib_block *);
161int		ext2fs_match(ib_params *);
162int		ext2fs_findstage2(ib_params *, uint32_t *, ib_block *);
163
164	/* machines.c */
165extern struct ib_mach ib_mach_alpha;
166extern struct ib_mach ib_mach_amd64;
167extern struct ib_mach ib_mach_amiga;
168extern struct ib_mach ib_mach_ews4800mips;
169extern struct ib_mach ib_mach_hp300;
170extern struct ib_mach ib_mach_hp700;
171extern struct ib_mach ib_mach_i386;
172extern struct ib_mach ib_mach_landisk;
173extern struct ib_mach ib_mach_macppc;
174extern struct ib_mach ib_mach_news68k;
175extern struct ib_mach ib_mach_newsmips;
176extern struct ib_mach ib_mach_next68k;
177extern struct ib_mach ib_mach_pmax;
178extern struct ib_mach ib_mach_sparc;
179extern struct ib_mach ib_mach_sparc64;
180extern struct ib_mach ib_mach_sun2;
181extern struct ib_mach ib_mach_sun3;
182extern struct ib_mach ib_mach_vax;
183extern struct ib_mach ib_mach_x68k;
184
185#endif	/* _INSTALLBOOT_H */
186