iPXE
efiprefix.c
Go to the documentation of this file.
1/*
2 * Copyright (C) 2009 Michael Brown <mbrown@fensystems.co.uk>.
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * License, or any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301, USA.
18 */
19
20FILE_LICENCE ( GPL2_OR_LATER );
21FILE_SECBOOT ( PERMITTED );
22
23#include <stdlib.h>
24#include <errno.h>
25#include <ipxe/device.h>
26#include <ipxe/uri.h>
27#include <ipxe/init.h>
28#include <ipxe/efi/efi.h>
29#include <ipxe/efi/efi_driver.h>
30#include <ipxe/efi/efi_snp.h>
35#include <ipxe/efi/efi_path.h>
36#include <ipxe/efi/efi_veto.h>
37
38/**
39 * EFI entry point
40 *
41 * @v image_handle Image handle
42 * @v systab System table
43 * @ret efirc EFI return status code
44 */
46 EFI_SYSTEM_TABLE *systab ) {
47 EFI_STATUS efirc;
48 int rc;
49
50 /* Initialise stack cookie */
51 efi_init_stack_guard ( image_handle );
52
53 /* Initialise EFI environment */
54 if ( ( efirc = efi_init ( image_handle, systab ) ) != 0 )
55 goto err_init;
56
57 /* Claim SNP devices for use by iPXE */
59
60 /* Start watchdog holdoff timer */
62
63 /* Call to main() */
64 if ( ( rc = main() ) != 0 ) {
65 efirc = EFIRC ( rc );
66 goto err_main;
67 }
68
69 err_main:
72 efi_loaded_image->Unload ( image_handle );
74 err_init:
75 return efirc;
76}
77
78/**
79 * Initialise EFI application
80 *
81 */
82static void efi_init_application ( void ) {
83 EFI_HANDLE device = efi_loaded_image->DeviceHandle;
86 struct uri *uri;
87
88 /* Set current working URI from device path, if present */
89 bootpath = efi_current_boot_path();
90 DBGC ( device, "EFI has loaded image device path %s\n",
91 efi_devpath_text ( devpath ) );
92 DBGC ( device, "EFI has boot option device path %s\n",
93 efi_devpath_text ( bootpath ) );
94 uri = efi_path_uri ( devpath );
95 if ( bootpath && ( ! uri ) )
96 uri = efi_path_uri ( bootpath );
97 if ( uri )
98 churi ( uri );
99 uri_put ( uri );
100 free ( bootpath );
101
102 /* Identify autoboot device, if any */
103 efi_set_autoboot_ll_addr ( device, devpath );
104
105 /* Store cached DHCP packet, if any */
106 efi_cachedhcp_record ( device, devpath );
107}
108
109/** EFI application initialisation function */
110struct init_fn efi_init_application_fn __init_fn ( INIT_NORMAL ) = {
111 .name = "efi",
112 .initialise = efi_init_application,
113};
114
115/**
116 * Probe EFI root bus
117 *
118 * @v rootdev EFI root device
119 */
120static int efi_probe ( struct root_device *rootdev __unused ) {
121
122 /* Try loading autoexec script */
124
125 /* Remove any vetoed drivers */
126 efi_veto();
127
128 /* Connect our drivers */
129 return efi_driver_connect_all();
130}
131
132/**
133 * Remove EFI root bus
134 *
135 * @v rootdev EFI root device
136 */
137static void efi_remove ( struct root_device *rootdev __unused ) {
138
139 /* Disconnect our drivers */
141}
142
143/** EFI root device driver */
145 .probe = efi_probe,
146 .remove = efi_remove,
147};
148
149/** EFI root device */
150struct root_device efi_root_device __root_device = {
151 .dev = { .name = "EFI" },
152 .driver = &efi_root_driver,
153};
#define EFIAPI
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
struct arbelprm_rc_send_wqe rc
Definition arbel.h:3
void churi(struct uri *uri)
Change working URI.
Definition cwuri.c:46
Device model.
#define __root_device
Declare a root device.
Definition device.h:136
int efi_set_autoboot_ll_addr(EFI_HANDLE device, EFI_DEVICE_PATH_PROTOCOL *path)
Identify autoboot device.
EFI autoboot device.
int efi_autoexec_load(void)
Load autoexec script.
EFI autoexec script.
int efi_cachedhcp_record(EFI_HANDLE device, EFI_DEVICE_PATH_PROTOCOL *path)
Record cached DHCP packet.
EFI cached DHCP packet.
const char * efi_devpath_text(EFI_DEVICE_PATH_PROTOCOL *path)
Get textual representation of device path.
Definition efi_debug.c:247
void efi_driver_disconnect_all(void)
Disconnect EFI driver from all possible devices.
Definition efi_driver.c:648
void efi_driver_reconnect_all(void)
Reconnect original EFI drivers to all possible devices.
Definition efi_driver.c:659
int efi_driver_connect_all(void)
Connect EFI driver to all possible devices.
Definition efi_driver.c:637
EFI driver interface.
EFI_STATUS efi_init(EFI_HANDLE image_handle, EFI_SYSTEM_TABLE *systab)
Initialise EFI environment.
Definition efi_init.c:155
EFI_DEVICE_PATH_PROTOCOL * efi_loaded_image_path
Device path for the loaded image's device handle.
Definition efi_init.c:42
EFI_LOADED_IMAGE_PROTOCOL * efi_loaded_image
Loaded image protocol for this image.
Definition efi_init.c:39
EFI_DEVICE_PATH_PROTOCOL * efi_current_boot_path(void)
Get EFI device path for current boot option.
Definition efi_path.c:887
struct uri * efi_path_uri(EFI_DEVICE_PATH_PROTOCOL *path)
Parse URI from device path.
Definition efi_path.c:301
EFI device paths.
iPXE EFI SNP interface
static void efi_snp_claim(void)
Claim network devices for use by iPXE.
Definition efi_snp.h:92
static void efi_snp_release(void)
Release network devices for use via SNP.
Definition efi_snp.h:100
void efi_veto(void)
Remove any vetoed drivers.
Definition efi_veto.c:615
EFI driver vetoes.
EFI watchdog holdoff timer.
static void efi_watchdog_start(void)
Start EFI watchdog holdoff timer.
static void efi_watchdog_stop(void)
Stop EFI watchdog holdoff timer.
static struct root_driver efi_root_driver
EFI root device driver.
static void efi_remove(struct root_device *rootdev __unused)
Remove EFI root bus.
static int efi_probe(struct root_device *rootdev __unused)
Probe EFI root bus.
static void efi_remove(struct root_device *rootdev __unused)
Remove EFI root bus.
Definition efiprefix.c:137
static int efi_probe(struct root_device *rootdev __unused)
Probe EFI root bus.
Definition efiprefix.c:120
EFI_STATUS EFIAPI _efi_start(EFI_HANDLE image_handle, EFI_SYSTEM_TABLE *systab)
EFI entry point.
Definition efiprefix.c:45
static void efi_init_application(void)
Initialise EFI application.
Definition efiprefix.c:82
Error codes.
#define __unused
Declare a variable or data structure as unused.
Definition compiler.h:573
#define DBGC(...)
Definition compiler.h:505
#define INIT_NORMAL
Normal initialisation.
Definition init.h:32
#define FILE_LICENCE(_licence)
Declare a particular licence as applying to a file.
Definition compiler.h:896
#define FILE_SECBOOT(_status)
Declare a file's UEFI Secure Boot permission status.
Definition compiler.h:926
EFI API.
#define EFIRC(rc)
Convert an iPXE status code to an EFI status code.
Definition efi.h:167
#define EFI_HANDLE
Definition efi.h:53
static void efi_init_stack_guard(EFI_HANDLE handle)
Initialise stack cookie.
Definition efi.h:387
#define __init_fn(init_order)
Declare an initialisation functon.
Definition init.h:24
__asmcall int main(void)
Main entry point.
Definition main.c:29
static void(* free)(struct refcnt *refcnt))
Definition refcnt.h:55
This protocol can be used on any device handle to obtain generic path/location information concerning...
Definition DevicePath.h:46
EFI System Table.
Definition UefiSpec.h:2044
A hardware device.
Definition device.h:77
An initialisation function.
Definition init.h:15
A root device.
Definition device.h:98
A root device driver.
Definition device.h:111
A Uniform Resource Identifier.
Definition uri.h:65
Uniform Resource Identifiers.
static void uri_put(struct uri *uri)
Decrement URI reference count.
Definition uri.h:206