Home | History | Annotate | Line # | Download | only in installboot
installboot.h revision 1.1 
      1 /*	$NetBSD: installboot.h,v 1.1 2024/09/15 03:56:57 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 
     52 				/* flags from -o options */
     53 	IB_ALPHASUM =	1<<8,		/* set Alpha checksum */
     54 	IB_APPEND =	1<<9,		/* append stage 1 to EO(regular)F */
     55 	IB_SUNSUM =	1<<10,		/* set Sun checksum */
     56 	IB_STAGE1START=	1<<11,		/* start block for stage 1 provided */
     57 	IB_STAGE2START=	1<<12,		/* start block for stage 2 provided */
     58 	IB_COMMAND = 	1<<13,		/* Amiga commandline option */
     59 	IB_RESETVIDEO =	1<<14,		/* i386 reset video */
     60 	IB_CONSOLE =	1<<15,		/* i386 console */
     61 	IB_CONSPEED =	1<<16,		/* i386 console baud rate */
     62 	IB_TIMEOUT =	1<<17,		/* i386 boot timeout */
     63 	IB_PASSWORD =	1<<18,		/* i386 boot password */
     64 	IB_KEYMAP = 	1<<19,		/* i386 console keymap */
     65 	IB_CONSADDR = 	1<<20,		/* i386 console io address */
     66 } ib_flags;
     67 
     68 typedef struct {
     69 	ib_flags	 flags;		/* flags (see above) */
     70 	struct ib_mach	*machine;	/* machine details (see below) */
     71 	struct ib_fs	*fstype;	/* file system details (see below) */
     72 	const char	*filesystem;	/* name of target file system */
     73 	int		 fsfd;		/*  open fd to filesystem */
     74 	struct stat	 fsstat;	/*  fstat(2) of fsfd */
     75 	const char	*stage1;	/* name of stage1 bootstrap */
     76 	int		 s1fd;		/*  open fd to stage1 */
     77 	struct stat	 s1stat;	/*  fstat(2) of s1fd */
     78 	uint64_t	 s1start;	/*  start block of stage1 */
     79 	const char	*stage2;	/* name of stage2 bootstrap */
     80 	uint64_t	 s2start;	/*  start block of stage2 */
     81 		/* parsed -o option=value data */
     82 	const char	*command;	/* name of command string */
     83 	const char	*console;	/* name of console */
     84 	int		 conspeed;	/* console baud rate */
     85 	int		 consaddr;	/* console io address */
     86 	const char	*password;	/* boot password */
     87 	int		 timeout;	/* interactive boot timeout */
     88 	const char	*keymap;	/* keyboard translations */
     89 } ib_params;
     90 
     91 typedef struct {
     92 	uint64_t	block;
     93 	uint32_t	blocksize;
     94 } ib_block;
     95 
     96 struct ib_mach {
     97 	const char	*name;
     98 	int		(*setboot)	(ib_params *);
     99 	int		(*clearboot)	(ib_params *);
    100 	ib_flags	valid_flags;
    101 };
    102 
    103 struct ib_fs {
    104 		/* compile time parameters */
    105 	const char	*name;
    106 	int		(*match)	(ib_params *);
    107 	int		(*findstage2)	(ib_params *, uint32_t *, ib_block *);
    108 		/* run time fs specific parameters */
    109 	uint32_t	 blocksize;
    110 	uint32_t	 needswap;
    111 	off_t		sblockloc;	/* location of superblock */
    112 };
    113 
    114 typedef enum {
    115 	BBINFO_BIG_ENDIAN =	0,
    116 	BBINFO_LITTLE_ENDIAN =	1,
    117 } bbinfo_endian;
    118 
    119 struct bbinfo_params {
    120 	const char	*magic;		/* magic string to look for */
    121 	uint32_t	offset;		/* offset to write start of stage1 */
    122 	uint32_t	blocksize;	/* blocksize of stage1 */
    123 	uint32_t	maxsize;	/* max size of stage1 */
    124 	uint32_t	headeroffset;	/*
    125 					 * header offset (relative to offset)
    126 					 * to read stage1 into
    127 					 */
    128 	bbinfo_endian	endian;
    129 };
    130 
    131 int		cd9660_match(ib_params *);
    132 int		cd9660_findstage2(ib_params *, uint32_t *, ib_block *);
    133 
    134 #endif	/* _INSTALLBOOT_H */
    135