Sync usage with man page.
[netbsd-mini2440.git] / distrib / cdrom / macppc_installboot / installboot.h
blob51e75f4aae1d4eff42e4db01e5cad806ddf64931
1 /* $NetBSD: installboot.h,v 1.2 2008/04/28 20:22:53 martin Exp $ */
3 /*-
4 * Copyright (c) 2002 The NetBSD Foundation, Inc.
5 * All rights reserved.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Luke Mewburn of Wasabi Systems.
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.
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.
32 #ifndef _INSTALLBOOT_H
33 #define _INSTALLBOOT_H
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
43 #include <sys/stat.h>
44 #include <stdint.h>
46 #ifndef MAXNAMLEN
47 #define MAXNAMLEN 511
48 #endif
50 typedef enum {
51 /* flags from global options */
52 IB_VERBOSE = 1<<0, /* verbose operation */
53 IB_NOWRITE = 1<<1, /* don't write */
54 IB_CLEAR = 1<<2, /* clear boot block */
56 /* flags from -o options */
57 IB_ALPHASUM = 1<<8, /* set Alpha checksum */
58 IB_APPEND = 1<<9, /* append stage 1 to EO(regular)F */
59 IB_SUNSUM = 1<<10, /* set Sun checksum */
60 IB_STAGE1START= 1<<11, /* start block for stage 1 provided */
61 IB_STAGE2START= 1<<12, /* start block for stage 2 provided */
62 IB_COMMAND = 1<<13, /* Amiga commandline option */
63 IB_RESETVIDEO = 1<<14, /* i386 reset video */
64 IB_CONSOLE = 1<<15, /* i386 console */
65 IB_CONSPEED = 1<<16, /* i386 console baud rate */
66 IB_TIMEOUT = 1<<17, /* i386 boot timeout */
67 IB_PASSWORD = 1<<18, /* i386 boot password */
68 IB_KEYMAP = 1<<19, /* i386 console keymap */
69 IB_CONSADDR = 1<<20, /* i386 console io address */
70 } ib_flags;
72 typedef 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 /* parsed -o option=value data */
86 const char *command; /* name of command string */
87 const char *console; /* name of console */
88 int conspeed; /* console baud rate */
89 int consaddr; /* console io address */
90 const char *password; /* boot password */
91 int timeout; /* interactive boot timeout */
92 const char *keymap; /* keyboard translations */
93 } ib_params;
95 typedef struct {
96 uint64_t block;
97 uint32_t blocksize;
98 } ib_block;
100 struct ib_mach {
101 const char *name;
102 int (*setboot) (ib_params *);
103 int (*clearboot) (ib_params *);
104 ib_flags valid_flags;
107 struct ib_fs {
108 /* compile time parameters */
109 const char *name;
110 int (*match) (ib_params *);
111 int (*findstage2) (ib_params *, uint32_t *, ib_block *);
112 /* run time fs specific parameters */
113 uint32_t blocksize;
114 uint32_t needswap;
115 off_t sblockloc; /* location of superblock */
118 typedef enum {
119 BBINFO_BIG_ENDIAN = 0,
120 BBINFO_LITTLE_ENDIAN = 1,
121 } bbinfo_endian;
123 struct bbinfo_params {
124 const char *magic; /* magic string to look for */
125 uint32_t offset; /* offset to write start of stage1 */
126 uint32_t blocksize; /* blocksize of stage1 */
127 uint32_t maxsize; /* max size of stage1 */
128 uint32_t headeroffset; /*
129 * header offset (relative to offset)
130 * to read stage1 into
132 bbinfo_endian endian;
135 int cd9660_match(ib_params *);
136 int cd9660_findstage2(ib_params *, uint32_t *, ib_block *);
138 int isofncmp(const u_char *, size_t, const u_char *, size_t, int);
139 void isofntrans(u_char *, int, u_char *, u_short *, int, int, int, int);
142 #endif /* _INSTALLBOOT_H */