boot_module.h revision 344374 
1/*-
2 * Copyright (c) 2015 Eric McCorkle
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: stable/11/stand/efi/boot1/boot_module.h 344374 2019-02-20 18:46:31Z kevans $
27 */
28
29#ifndef _BOOT_MODULE_H_
30#define _BOOT_MODULE_H_
31
32#include <stdbool.h>
33
34#include <efi.h>
35#include <efilib.h>
36#include <eficonsctl.h>
37
38#ifdef EFI_DEBUG
39#define DPRINTF(fmt, args...) printf(fmt, ##args)
40#define DSTALL(d) BS->Stall(d)
41#else
42#define DPRINTF(fmt, ...) {}
43#define DSTALL(d) {}
44#endif
45
46/* EFI device info */
47typedef struct dev_info
48{
49	EFI_BLOCK_IO *dev;
50	EFI_DEVICE_PATH *devpath;
51	EFI_HANDLE *devhandle;
52	void *devdata;
53	uint64_t partoff;
54	int preferred;
55	struct dev_info *next;
56} dev_info_t;
57
58/*
59 * A boot loader module.
60 *
61 * This is a standard interface for filesystem modules in the EFI system.
62 */
63typedef struct boot_module_t
64{
65	const char *name;
66
67	/* init is the optional initialiser for the module. */
68	void (*init)(void);
69
70	/*
71	 * probe checks to see if the module can handle dev.
72	 *
73	 * Return codes:
74	 * EFI_SUCCESS = The module can handle the device.
75	 * EFI_NOT_FOUND = The module can not handle the device.
76	 * Other = The module encountered an error.
77	 */
78	EFI_STATUS (*probe)(dev_info_t* dev);
79
80	/*
81	 * load should select the best out of a set of devices that probe
82	 * indicated were loadable and load the specified file.
83	 *
84	 * Return codes:
85	 * EFI_SUCCESS = The module can handle the device.
86	 * EFI_NOT_FOUND = The module can not handle the device.
87	 * Other = The module encountered an error.
88	 */
89	EFI_STATUS (*load)(const char *filepath, dev_info_t *devinfo,
90	    void **buf, size_t *bufsize);
91
92	/* status outputs information about the probed devices. */
93	void (*status)(void);
94
95	/* valid devices as found by probe. */
96	dev_info_t *(*devices)(void);
97} boot_module_t;
98
99/* Standard boot modules. */
100#ifdef EFI_UFS_BOOT
101extern const boot_module_t ufs_module;
102#endif
103#ifdef EFI_ZFS_BOOT
104extern const boot_module_t zfs_module;
105#endif
106
107/* Functions available to modules. */
108extern void add_device(dev_info_t **devinfop, dev_info_t *devinfo);
109extern int vsnprintf(char *str, size_t sz, const char *fmt, va_list ap);
110#endif
111