iPXE
efi_connect.c File Reference

EFI driver connection and disconnection. More...

#include <errno.h>
#include <string.h>
#include <ipxe/efi/efi.h>

Go to the source code of this file.

Macros

#define EINFO_EEFI_CONNECT
#define EINFO_EEFI_CONNECT_PROHIBITED
#define EEFI_CONNECT_PROHIBITED    __einfo_error ( EINFO_EEFI_CONNECT_PROHIBITED )
#define EEFI_CONNECT(efirc)

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 FILE_SECBOOT (PERMITTED)
int efi_connect (EFI_HANDLE device, EFI_HANDLE driver)
 Connect UEFI driver(s)
int efi_disconnect (EFI_HANDLE device, EFI_HANDLE driver)
 Disconnect UEFI driver(s)

Detailed Description

EFI driver connection and disconnection.

Definition in file efi_connect.c.

Macro Definition Documentation

◆ EINFO_EEFI_CONNECT

#define EINFO_EEFI_CONNECT
Value:
"Could not connect controllers" )
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition errno.h:181
#define EINFO_EPLATFORM
Platform-generated base error.
Definition errno.h:692

Definition at line 38 of file efi_connect.c.

38#define EINFO_EEFI_CONNECT \
39 __einfo_uniqify ( EINFO_EPLATFORM, 0x01, \
40 "Could not connect controllers" )

◆ EINFO_EEFI_CONNECT_PROHIBITED

#define EINFO_EEFI_CONNECT_PROHIBITED
Value:
"Connecting controllers prohibited by " \
"security policy" )
#define EFI_SECURITY_VIOLATION
Enumeration of EFI_STATUS.
#define EINFO_EEFI_CONNECT
Definition efi_connect.c:38
#define __einfo_platformify(einfo_base, platform, desc)
Declare platform-generated error.
Definition errno.h:194

Definition at line 41 of file efi_connect.c.

41#define EINFO_EEFI_CONNECT_PROHIBITED \
42 __einfo_platformify ( EINFO_EEFI_CONNECT, \
43 EFI_SECURITY_VIOLATION, \
44 "Connecting controllers prohibited by " \
45 "security policy" )

◆ EEFI_CONNECT_PROHIBITED

#define EEFI_CONNECT_PROHIBITED    __einfo_error ( EINFO_EEFI_CONNECT_PROHIBITED )

Definition at line 46 of file efi_connect.c.

46#define EEFI_CONNECT_PROHIBITED \
47 __einfo_error ( EINFO_EEFI_CONNECT_PROHIBITED )

◆ EEFI_CONNECT

#define EEFI_CONNECT ( efirc)
Value:
#define EEFI_CONNECT_PROHIBITED
Definition efi_connect.c:46
#define EPLATFORM(einfo_base, platform,...)
Generate an error based on an external platform error code.
Definition errno.h:249

Definition at line 48 of file efi_connect.c.

48#define EEFI_CONNECT( efirc ) EPLATFORM ( EINFO_EEFI_CONNECT, efirc, \
49 EEFI_CONNECT_PROHIBITED )

Referenced by efi_connect().

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ efi_connect()

int efi_connect ( EFI_HANDLE device,
EFI_HANDLE driver )

Connect UEFI driver(s)

Parameters
deviceEFI device handle
driverEFI driver handle, or NULL
Return values
rcReturn status code

Definition at line 58 of file efi_connect.c.

58 {
59 EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
60 EFI_HANDLE driverlist[2] = { driver, NULL };
61 EFI_HANDLE *drivers = ( driver ? driverlist : NULL );
62 struct efi_dropped_tpl tpl;
63 EFI_STATUS efirc;
64 int rc;
65
66 /* Attempt connection at external TPL */
67 DBGC ( device, "EFI %s connecting ", efi_handle_name ( device ) );
68 DBGC ( device, "%s driver at %s TPL\n",
69 ( driver ? efi_handle_name ( driver ) : "any" ),
71 efi_drop_tpl ( &tpl );
72 efirc = bs->ConnectController ( device, drivers, NULL, TRUE );
73 efi_undrop_tpl ( &tpl );
74 if ( efirc != 0 ) {
75 rc = -EEFI_CONNECT ( efirc );
76 DBGC ( device, "EFI %s could not connect: %s\n",
78 return rc;
79 }
80
81 return 0;
82}
#define NULL
NULL pointer (VOID *)
Definition Base.h:322
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
struct arbelprm_rc_send_wqe rc
Definition arbel.h:3
#define EEFI_CONNECT(efirc)
Definition efi_connect.c:48
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition efi_debug.c:652
const char * efi_tpl_name(EFI_TPL tpl)
Name EFI TPL.
Definition efi_debug.c:55
void efi_undrop_tpl(struct efi_dropped_tpl *tpl)
Restore dropped task priority level.
Definition efi_init.c:430
EFI_TPL efi_external_tpl
External task priority level.
Definition efi_init.c:57
void efi_drop_tpl(struct efi_dropped_tpl *tpl)
Drop task priority level temporarily to external level.
Definition efi_init.c:414
#define DBGC(...)
Definition compiler.h:505
#define EFI_HANDLE
Definition efi.h:53
EFI_SYSTEM_TABLE * efi_systab
char * strerror(int errno)
Retrieve string representation of error number.
Definition strerror.c:79
EFI Boot Services Table.
Definition UefiSpec.h:1931
EFI_CONNECT_CONTROLLER ConnectController
Definition UefiSpec.h:1994
A hardware device.
Definition device.h:77
An EFI dropped task priority level.
Definition efi.h:88
#define TRUE
Definition tlan.h:46

References EFI_BOOT_SERVICES::ConnectController, DBGC, EEFI_CONNECT, efi_drop_tpl(), efi_external_tpl, EFI_HANDLE, efi_handle_name(), efi_systab, efi_tpl_name(), efi_undrop_tpl(), NULL, rc, strerror(), and TRUE.

Referenced by efi_block_connect(), efi_driver_connect(), efi_driver_reconnect(), and efi_usb_probe().

◆ efi_disconnect()

int efi_disconnect ( EFI_HANDLE device,
EFI_HANDLE driver )

Disconnect UEFI driver(s)

Parameters
deviceEFI device handle
driverEFI driver handle, or NULL
Return values
rcReturn status code

Definition at line 91 of file efi_connect.c.

91 {
92 EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
93 struct efi_dropped_tpl tpl;
94 EFI_STATUS efirc;
95 int rc;
96
97 /* Attempt disconnection at external TPL */
98 DBGC ( device, "EFI %s disconnecting ", efi_handle_name ( device ) );
99 DBGC ( device, "%s driver at %s TPL\n",
100 ( driver ? efi_handle_name ( driver ) : "any" ),
102 efi_drop_tpl ( &tpl );
103 efirc = bs->DisconnectController ( device, driver, NULL );
104 efi_undrop_tpl ( &tpl );
105 if ( ( efirc != 0 ) && ( efirc != EFI_NOT_FOUND ) ) {
106 rc = -EEFI ( efirc );
107 DBGC ( device, "EFI %s could not disconnect: %s\n",
109 return rc;
110 }
111
112 return 0;
113}
#define EFI_NOT_FOUND
Enumeration of EFI_STATUS.
#define EEFI(efirc)
Convert an EFI status code to an iPXE status code.
Definition efi.h:181
EFI_DISCONNECT_CONTROLLER DisconnectController
Definition UefiSpec.h:1995

References DBGC, EFI_BOOT_SERVICES::DisconnectController, EEFI, efi_drop_tpl(), efi_external_tpl, EFI_HANDLE, efi_handle_name(), EFI_NOT_FOUND, efi_systab, efi_tpl_name(), efi_undrop_tpl(), NULL, rc, and strerror().

Referenced by efi_driver_disconnect(), efi_driver_exclude(), efi_usb_uninstall(), and efi_veto_disconnect().