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