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