xref: /src/usr.bin/mkimg/scheme.h (revision 971696b22f7acc8c45600bb56b972340e9b912e8)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2013,2014 Juniper Networks, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _MKIMG_SCHEME_H_
30 #define	_MKIMG_SCHEME_H_
31 
32 enum alias {
33 	ALIAS_NONE,		/* Keep first! */
34 	/* start */
35 	ALIAS_EBR,
36 	ALIAS_EFI,
37 	ALIAS_FAT16B,
38 	ALIAS_FAT32,
39 	ALIAS_FAT32LBA,
40 	ALIAS_FREEBSD,
41 	ALIAS_FREEBSD_BOOT,
42 	ALIAS_FREEBSD_NANDFS,
43 	ALIAS_FREEBSD_SWAP,
44 	ALIAS_FREEBSD_UFS,
45 	ALIAS_FREEBSD_VINUM,
46 	ALIAS_FREEBSD_ZFS,
47 	ALIAS_MBR,
48 	ALIAS_NTFS,
49 	ALIAS_PPCBOOT,
50 	/* end */
51 	ALIAS_COUNT		/* Keep last! */
52 };
53 
54 struct mkimg_alias {
55 	u_int		alias;
56 	uintptr_t	type;
57 #define	ALIAS_PTR2TYPE(p)	(uintptr_t)(p)
58 #define	ALIAS_INT2TYPE(i)	(i)
59 #define	ALIAS_TYPE2PTR(p)	(void *)(p)
60 #define	ALIAS_TYPE2INT(i)	(i)
61 };
62 
63 struct mkimg_scheme {
64 	struct mkimg_scheme *next;
65 	const char	*name;
66 	const char	*description;
67 	struct mkimg_alias *aliases;
68 	lba_t		(*metadata)(u_int, lba_t);
69 #define	SCHEME_META_IMG_START		1
70 #define	SCHEME_META_IMG_END		2
71 #define	SCHEME_META_PART_BEFORE		3
72 #define	SCHEME_META_PART_AFTER		4
73 #define	SCHEME_META_PART_ABSOLUTE	5
74 	int		(*write)(lba_t, void *);
75 	u_int		nparts;
76 	u_int		labellen;
77 	u_int		bootcode;
78 	u_int		maxsecsz;
79 };
80 
81 #define	SCHEME_DEFINE(nm)						\
82 static void scheme_register_##nm(void) __attribute__((constructor));	\
83 static void scheme_register_##nm(void) { scheme_register(&nm); }
84 
85 struct mkimg_scheme *scheme_iterate(struct mkimg_scheme *);
86 void	scheme_register(struct mkimg_scheme *);
87 int	scheme_select(const char *);
88 struct mkimg_scheme *scheme_selected(void);
89 
90 int scheme_bootcode(int fd);
91 int scheme_check_part(struct part *);
92 u_int scheme_max_parts(void);
93 u_int scheme_max_secsz(void);
94 lba_t scheme_metadata(u_int, lba_t);
95 int scheme_write(lba_t);
96 
97 #endif /* _MKIMG_SCHEME_H_ */
98