199767f8919635c4928607450d9e0abb932109ceToomas Soome/*-
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Copyright (c) 2015 Eric McCorkle
199767f8919635c4928607450d9e0abb932109ceToomas Soome * All rights reserved.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Redistribution and use in source and binary forms, with or without
199767f8919635c4928607450d9e0abb932109ceToomas Soome * modification, are permitted provided that the following conditions
199767f8919635c4928607450d9e0abb932109ceToomas Soome * are met:
199767f8919635c4928607450d9e0abb932109ceToomas Soome * 1. Redistributions of source code must retain the above copyright
199767f8919635c4928607450d9e0abb932109ceToomas Soome * notice, this list of conditions and the following disclaimer.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * 2. Redistributions in binary form must reproduce the above copyright
199767f8919635c4928607450d9e0abb932109ceToomas Soome * notice, this list of conditions and the following disclaimer in the
199767f8919635c4928607450d9e0abb932109ceToomas Soome * documentation and/or other materials provided with the distribution.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
199767f8919635c4928607450d9e0abb932109ceToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
199767f8919635c4928607450d9e0abb932109ceToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
199767f8919635c4928607450d9e0abb932109ceToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
199767f8919635c4928607450d9e0abb932109ceToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
199767f8919635c4928607450d9e0abb932109ceToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
199767f8919635c4928607450d9e0abb932109ceToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
199767f8919635c4928607450d9e0abb932109ceToomas Soome * SUCH DAMAGE.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * $FreeBSD$
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifndef _BOOT_MODULE_H_
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define _BOOT_MODULE_H_
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <stdbool.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <efi.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <efilib.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <eficonsctl.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifdef EFI_DEBUG
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define DPRINTF(fmt, args...) printf(fmt, ##args)
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define DSTALL(d) bs->Stall(d)
199767f8919635c4928607450d9e0abb932109ceToomas Soome#else
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define DPRINTF(fmt, ...) {}
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define DSTALL(d) {}
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/* EFI device info */
199767f8919635c4928607450d9e0abb932109ceToomas Soometypedef struct dev_info
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome EFI_BLOCK_IO *dev;
199767f8919635c4928607450d9e0abb932109ceToomas Soome EFI_DEVICE_PATH *devpath;
199767f8919635c4928607450d9e0abb932109ceToomas Soome EFI_HANDLE *devhandle;
199767f8919635c4928607450d9e0abb932109ceToomas Soome void *devdata;
199767f8919635c4928607450d9e0abb932109ceToomas Soome BOOLEAN preferred;
199767f8919635c4928607450d9e0abb932109ceToomas Soome struct dev_info *next;
199767f8919635c4928607450d9e0abb932109ceToomas Soome} dev_info_t;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/*
199767f8919635c4928607450d9e0abb932109ceToomas Soome * A boot loader module.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * This is a standard interface for filesystem modules in the EFI system.
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soometypedef struct boot_module_t
199767f8919635c4928607450d9e0abb932109ceToomas Soome{
199767f8919635c4928607450d9e0abb932109ceToomas Soome const char *name;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome /* init is the optional initialiser for the module. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome void (*init)(void);
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome /*
199767f8919635c4928607450d9e0abb932109ceToomas Soome * probe checks to see if the module can handle dev.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Return codes:
199767f8919635c4928607450d9e0abb932109ceToomas Soome * EFI_SUCCESS = The module can handle the device.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * EFI_NOT_FOUND = The module can not handle the device.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Other = The module encountered an error.
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soome EFI_STATUS (*probe)(dev_info_t* dev);
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome /*
199767f8919635c4928607450d9e0abb932109ceToomas Soome * load should select the best out of a set of devices that probe
199767f8919635c4928607450d9e0abb932109ceToomas Soome * indicated were loadable and load the specified file.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Return codes:
199767f8919635c4928607450d9e0abb932109ceToomas Soome * EFI_SUCCESS = The module can handle the device.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * EFI_NOT_FOUND = The module can not handle the device.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Other = The module encountered an error.
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soome EFI_STATUS (*load)(const char *filepath, dev_info_t *devinfo,
199767f8919635c4928607450d9e0abb932109ceToomas Soome void **buf, size_t *bufsize);
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome /* status outputs information about the probed devices. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome void (*status)(void);
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome /* valid devices as found by probe. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome dev_info_t *(*devices)(void);
199767f8919635c4928607450d9e0abb932109ceToomas Soome} boot_module_t;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/* Standard boot modules. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifdef EFI_UFS_BOOT
199767f8919635c4928607450d9e0abb932109ceToomas Soomeextern const boot_module_t ufs_module;
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifdef EFI_ZFS_BOOT
199767f8919635c4928607450d9e0abb932109ceToomas Soomeextern const boot_module_t zfs_module;
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/* Functions available to modules. */
199767f8919635c4928607450d9e0abb932109ceToomas Soomeextern void add_device(dev_info_t **devinfop, dev_info_t *devinfo);
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomeextern EFI_SYSTEM_TABLE *systab;
199767f8919635c4928607450d9e0abb932109ceToomas Soomeextern EFI_BOOT_SERVICES *bs;
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soomeextern int devpath_strlcat(char *buf, size_t size, EFI_DEVICE_PATH *devpath);
199767f8919635c4928607450d9e0abb932109ceToomas Soomeextern char *devpath_str(EFI_DEVICE_PATH *devpath);
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif