xref: /src/usr.bin/mkimg/format.h (revision 971696b22f7acc8c45600bb56b972340e9b912e8)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 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_FORMAT_H_
30 #define	_MKIMG_FORMAT_H_
31 
32 struct mkimg_format {
33 	struct mkimg_format *next;
34 	const char	*name;
35 	const char	*description;
36 	int		(*resize)(lba_t);
37 	int		(*write)(int);
38 };
39 
40 #define	FORMAT_DEFINE(nm)						\
41 static void format_register_##nm(void) __attribute__((constructor));	\
42 static void format_register_##nm(void) { format_register(&nm); }
43 
44 struct mkimg_format *format_iterate(struct mkimg_format *);
45 void	format_register(struct mkimg_format *);
46 int	format_select(const char *);
47 struct mkimg_format *format_selected(void);
48 
49 int	format_resize(lba_t);
50 int	format_write(int);
51 
52 #endif /* _MKIMG_FORMAT_H_ */
53