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