xref: /netbsd-src/usr.sbin/installboot/evboards.h (revision 6e45676f26061dc4eed3422875ebb23455a8fe98)
1 /*	$NetBSD: evboards.h,v 1.2 2019/09/19 01:25:29 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 2019 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe.
9  *
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.
18  *
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.
30  */
31 
32 #ifndef installboot_evboards_h_included
33 #define	installboot_evboards_h_included
34 
35 #include <stdio.h>
36 #include <prop/proplib.h>
37 
38 typedef prop_dictionary_t      evb_board;
39 typedef prop_array_t           evb_ubinstall;
40 typedef prop_object_iterator_t evb_ubsteps;
41 typedef prop_dictionary_t      evb_ubstep;
42 
43 bool		evb_db_load(ib_params *);
44 evb_board	evb_db_get_board(ib_params *);
45 void		evb_db_list_boards(ib_params *, FILE *);
46 
47 const char *	evb_board_get_description(ib_params *, evb_board);
48 const char *	evb_board_get_uboot_pkg(ib_params *, evb_board);
49 const char *	evb_board_get_uboot_path(ib_params *, evb_board);
50 evb_ubinstall	evb_board_get_uboot_install(ib_params *, evb_board);
51 prop_array_t	evb_board_copy_uboot_media(ib_params *, evb_board);
52 
53 evb_ubsteps	evb_ubinstall_get_steps(ib_params *, evb_ubinstall);
54 
55 evb_ubstep	evb_ubsteps_next_step(ib_params *, evb_ubsteps);
56 
57 const char *	evb_ubstep_get_file_name(ib_params *, evb_ubstep);
58 uint64_t	evb_ubstep_get_file_offset(ib_params *, evb_ubstep);
59 uint64_t	evb_ubstep_get_file_size(ib_params *, evb_ubstep);
60 uint64_t	evb_ubstep_get_image_offset(ib_params *, evb_ubstep);
61 uint64_t	evb_ubstep_get_input_block_size(ib_params *, evb_ubstep);
62 uint64_t	evb_ubstep_get_input_pad_size(ib_params *, evb_ubstep);
63 uint64_t	evb_ubstep_get_output_size(ib_params *, evb_ubstep);
64 uint64_t	evb_ubstep_get_output_block_size(ib_params *, evb_ubstep);
65 bool		evb_ubstep_preserves_partial_block(ib_params *, evb_ubstep);
66 
67 int		evb_uboot_setboot(ib_params *, evb_board);
68 
69 #endif /* installboot_evboards_h_included */
70