iPXE
Macros | Functions
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)
 
int efi_connect (EFI_HANDLE device, EFI_HANDLE driver)
 Connect UEFI driver(s) More...
 
int efi_disconnect (EFI_HANDLE device, EFI_HANDLE driver)
 Disconnect UEFI driver(s) More...
 

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_EPLATFORM
Platform-generated base error.
Definition: errno.h:691
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 37 of file efi_connect.c.

◆ EINFO_EEFI_CONNECT_PROHIBITED

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

Definition at line 40 of file efi_connect.c.

◆ EEFI_CONNECT_PROHIBITED

#define EEFI_CONNECT_PROHIBITED   __einfo_error ( EINFO_EEFI_CONNECT_PROHIBITED )

Definition at line 45 of file efi_connect.c.

◆ EEFI_CONNECT

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

Definition at line 47 of file efi_connect.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ 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 57 of file efi_connect.c.

57  {
59  EFI_HANDLE driverlist[2] = { driver, NULL };
60  EFI_HANDLE *drivers = ( driver ? driverlist : NULL );
61  EFI_STATUS efirc;
62  int rc;
63 
64  /* Attempt connection at external TPL */
65  DBGC ( device, "EFI %s connecting ", efi_handle_name ( device ) );
66  DBGC ( device, "%s driver at %s TPL\n",
67  ( driver ? efi_handle_name ( driver ) : "any" ),
70  efirc = bs->ConnectController ( device, drivers, NULL, TRUE );
71  bs->RaiseTPL ( efi_internal_tpl );
72  if ( efirc != 0 ) {
73  rc = -EEFI_CONNECT ( efirc );
74  DBGC ( device, "EFI %s could not connect: %s\n",
75  efi_handle_name ( device ), strerror ( rc ) );
76  return rc;
77  }
78 
79  return 0;
80 }
EFI_BOOT_SERVICES * BootServices
A pointer to the EFI Boot Services Table.
Definition: UefiSpec.h:2098
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
EFI_RAISE_TPL RaiseTPL
Definition: UefiSpec.h:1939
#define DBGC(...)
Definition: compiler.h:505
EFI_TPL efi_internal_tpl
Internal task priority level.
Definition: efi_init.c:53
A hardware device.
Definition: device.h:76
#define EEFI_CONNECT(efirc)
Definition: efi_connect.c:47
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition: efi_debug.c:652
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
EFI Boot Services Table.
Definition: UefiSpec.h:1930
EFI_CONNECT_CONTROLLER ConnectController
Definition: UefiSpec.h:1993
#define TRUE
Definition: tlan.h:46
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:31
EFI_SYSTEM_TABLE * efi_systab
EFI_RESTORE_TPL RestoreTPL
Definition: UefiSpec.h:1940
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
Definition: efi.h:61
const char * efi_tpl_name(EFI_TPL tpl)
Name EFI TPL.
Definition: efi_debug.c:55
EFI_TPL efi_external_tpl
External task priority level.
Definition: efi_init.c:56

References EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::ConnectController, DBGC, EEFI_CONNECT, efi_external_tpl, efi_handle_name(), efi_internal_tpl, efi_systab, efi_tpl_name(), NULL, EFI_BOOT_SERVICES::RaiseTPL, rc, EFI_BOOT_SERVICES::RestoreTPL, 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 89 of file efi_connect.c.

89  {
91  EFI_STATUS efirc;
92  int rc;
93 
94  /* Attempt disconnection at external TPL */
95  DBGC ( device, "EFI %s disconnecting ", efi_handle_name ( device ) );
96  DBGC ( device, "%s driver at %s TPL\n",
97  ( driver ? efi_handle_name ( driver ) : "any" ),
100  efirc = bs->DisconnectController ( device, driver, NULL );
101  bs->RaiseTPL ( efi_internal_tpl );
102  if ( ( efirc != 0 ) && ( efirc != EFI_NOT_FOUND ) ) {
103  rc = -EEFI ( efirc );
104  DBGC ( device, "EFI %s could not disconnect: %s\n",
105  efi_handle_name ( device ), strerror ( rc ) );
106  return rc;
107  }
108 
109  return 0;
110 }
EFI_BOOT_SERVICES * BootServices
A pointer to the EFI Boot Services Table.
Definition: UefiSpec.h:2098
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define EEFI(efirc)
Convert an EFI status code to an iPXE status code.
Definition: efi.h:174
EFI_RAISE_TPL RaiseTPL
Definition: UefiSpec.h:1939
#define DBGC(...)
Definition: compiler.h:505
EFI_TPL efi_internal_tpl
Internal task priority level.
Definition: efi_init.c:53
A hardware device.
Definition: device.h:76
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition: efi_debug.c:652
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
EFI Boot Services Table.
Definition: UefiSpec.h:1930
#define EFI_NOT_FOUND
Enumeration of EFI_STATUS.
Definition: UefiBaseType.h:128
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:31
EFI_SYSTEM_TABLE * efi_systab
EFI_RESTORE_TPL RestoreTPL
Definition: UefiSpec.h:1940
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
const char * efi_tpl_name(EFI_TPL tpl)
Name EFI TPL.
Definition: efi_debug.c:55
EFI_TPL efi_external_tpl
External task priority level.
Definition: efi_init.c:56
EFI_DISCONNECT_CONTROLLER DisconnectController
Definition: UefiSpec.h:1994

References EFI_SYSTEM_TABLE::BootServices, DBGC, EFI_BOOT_SERVICES::DisconnectController, EEFI, efi_external_tpl, efi_handle_name(), efi_internal_tpl, EFI_NOT_FOUND, efi_systab, efi_tpl_name(), NULL, EFI_BOOT_SERVICES::RaiseTPL, rc, EFI_BOOT_SERVICES::RestoreTPL, and strerror().

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