Home | History | Annotate | Line # | Download | only in installboot
      1 /*	$NetBSD: installboot.h,v 1.46 2024/05/22 15:42:42 tsutsui 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_MODULES =	1<<21,		/* i386: load modules */
     69 	IB_BOOTCONF = 	1<<22,		/* i386: read boot.conf */
     70 
     71 	IB_BOARD =	1<<23,		/* evb*: board specification */
     72 	IB_DTB=		1<<24,		/* evb*: device tree blob */
     73 
     74 	/* IB_MEDIA is required for some evb*, but not all. */
     75 	IB_MEDIA =	1<<25,		/* evb*: boot media type */
     76 } ib_flags;
     77 
     78 typedef enum {
     79 
     80 	MF_UBOOT =	1<<0,		/* platform (maybe) uses u-boot */
     81 } m_flags;
     82 
     83 typedef struct {
     84 	ib_flags	 flags;		/* flags (see above) */
     85 	struct ib_mach	*machine;	/* machine details (see below) */
     86 	struct ib_fs	*fstype;	/* file system details (see below) */
     87 	const char	*filesystem;	/* name of target file system */
     88 	int		 fsfd;		/*  open fd to filesystem */
     89 	struct stat	 fsstat;	/*  fstat(2) of fsfd */
     90 	const char	*stage1;	/* name of stage1 bootstrap */
     91 	int		 s1fd;		/*  open fd to stage1 */
     92 	struct stat	 s1stat;	/*  fstat(2) of s1fd */
     93 	uint64_t	 s1start;	/*  start block of stage1 */
     94 	const char	*stage2;	/* name of stage2 bootstrap */
     95 	uint64_t	 s2start;	/*  start block of stage2 */
     96 	uint32_t	 sectorsize;	/* sector size of target fs */
     97 	const char	*uboot_paths;	/* u-boot paths */
     98 		/* parsed -o option=value data */
     99 	const char	*command;	/* name of command string */
    100 	const char	*console;	/* name of console */
    101 	int		 conspeed;	/* console baud rate */
    102 	int		 consaddr;	/* console io address */
    103 	const char	*password;	/* boot password */
    104 	int		 timeout;	/* interactive boot timeout */
    105 	const char	*keymap;	/* keyboard translations */
    106 	const char	*board;		/* board specification */
    107 	const char	*dtb;		/* dtb specification */
    108 	const char	*media;		/* boot media type */
    109 
    110 		/* temporary working data */
    111 	void		*mach_data;	/* platform-specific data */
    112 } ib_params;
    113 
    114 typedef struct {
    115 	uint64_t	block;
    116 	uint32_t	blocksize;
    117 } ib_block;
    118 
    119 struct ib_mach {
    120 	const char	*name;
    121 	int		(*setboot)	(ib_params *);
    122 	int		(*clearboot)	(ib_params *);
    123 	int		(*editboot)	(ib_params *);
    124 	void		(*usage)	(ib_params *);
    125 	ib_flags	valid_flags;
    126 	m_flags		mach_flags;
    127 };
    128 
    129 struct ib_fs {
    130 		/* compile time parameters */
    131 	const char	*name;
    132 	int		(*match)	(ib_params *);
    133 	int		(*findstage2)	(ib_params *, uint32_t *, ib_block *);
    134 		/* run time fs specific parameters */
    135 	uint32_t	 blocksize;
    136 	uint32_t	 needswap;
    137 	off_t		sblockloc;	/* location of superblock */
    138 	off_t		offset;		/* file system offset (e.g. RAID) */
    139 };
    140 
    141 typedef enum {
    142 	BBINFO_BIG_ENDIAN =	0,
    143 	BBINFO_LITTLE_ENDIAN =	1,
    144 } bbinfo_endian;
    145 
    146 struct bbinfo_params {
    147 	const char	*magic;		/* magic string to look for */
    148 	uint32_t	offset;		/* offset to write start of stage1 */
    149 	uint32_t	blocksize;	/* blocksize of stage1 */
    150 	uint32_t	maxsize;	/* max size of stage1 */
    151 	uint32_t	headeroffset;	/*
    152 					 * header offset (relative to offset)
    153 					 * to read stage1 into
    154 					 */
    155 	bbinfo_endian	endian;
    156 };
    157 
    158 extern struct ib_mach	* const machines[];
    159 extern struct ib_fs	fstypes[];
    160 
    161 	/* installboot.c */
    162 uint16_t	compute_sunsum(const uint16_t *);
    163 int		set_sunsum(ib_params *, uint16_t *, uint16_t);
    164 int		no_setboot(ib_params *);
    165 int		no_clearboot(ib_params *);
    166 int		no_editboot(ib_params *);
    167 
    168 	/* bbinfo.c */
    169 int		shared_bbinfo_clearboot(ib_params *, struct bbinfo_params *,
    170 		    int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
    171 int		shared_bbinfo_setboot(ib_params *, struct bbinfo_params *,
    172 		    int (*)(ib_params *, struct bbinfo_params *, uint8_t *));
    173 
    174 	/* cd9660.c */
    175 int		cd9660_match(ib_params *);
    176 int		cd9660_findstage2(ib_params *, uint32_t *, ib_block *);
    177 
    178 	/* ext2fs.c */
    179 int		ext2fs_match(ib_params *);
    180 int		ext2fs_findstage2(ib_params *, uint32_t *, ib_block *);
    181 
    182 	/* ffs.c */
    183 int		ffs_match(ib_params *);
    184 int		ffs_findstage2(ib_params *, uint32_t *, ib_block *);
    185 int		raid_match(ib_params *);
    186 
    187 	/* fstypes.c */
    188 int		hardcode_stage2(ib_params *, uint32_t *, ib_block *);
    189 int		raw_match(ib_params *);
    190 int		raw_findstage2(ib_params *, uint32_t *, ib_block *);
    191 
    192 	/* machines.c */
    193 extern struct ib_mach ib_mach_alpha;
    194 extern struct ib_mach ib_mach_amd64;
    195 extern struct ib_mach ib_mach_amiga;
    196 extern struct ib_mach ib_mach_evbarm;
    197 extern struct ib_mach ib_mach_evbmips;
    198 extern struct ib_mach ib_mach_ews4800mips;
    199 extern struct ib_mach ib_mach_hp300;
    200 extern struct ib_mach ib_mach_hppa;
    201 extern struct ib_mach ib_mach_i386;
    202 extern struct ib_mach ib_mach_landisk;
    203 extern struct ib_mach ib_mach_macppc;
    204 extern struct ib_mach ib_mach_news68k;
    205 extern struct ib_mach ib_mach_newsmips;
    206 extern struct ib_mach ib_mach_next68k;
    207 extern struct ib_mach ib_mach_pmax;
    208 extern struct ib_mach ib_mach_sparc;
    209 extern struct ib_mach ib_mach_sparc64;
    210 extern struct ib_mach ib_mach_sun2;
    211 extern struct ib_mach ib_mach_sun3;
    212 extern struct ib_mach ib_mach_vax;
    213 extern struct ib_mach ib_mach_x68k;
    214 
    215 #endif	/* _INSTALLBOOT_H */
    216