iPXE
Data Structures | Macros | Functions
efi_driver.h File Reference

EFI driver interface. More...

#include <ipxe/device.h>
#include <ipxe/tables.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/DevicePath.h>

Go to the source code of this file.

Data Structures

struct  efi_device
 An EFI device. More...
 
struct  efi_driver
 An EFI driver. More...
 

Macros

#define EFI_DRIVERS   __table ( struct efi_driver, "efi_drivers" )
 EFI driver table. More...
 
#define __efi_driver(order)   __table_entry ( EFI_DRIVERS, order )
 Declare an EFI driver. More...
 
#define EFI_DRIVER_EARLY   01
 Early drivers. More...
 
#define EFI_DRIVER_NORMAL   02
 Normal drivers. More...
 
#define EFI_DRIVER_LATE   03
 Late drivers. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
static void efidev_set_drvdata (struct efi_device *efidev, void *priv)
 Set EFI driver-private data. More...
 
static void * efidev_get_drvdata (struct efi_device *efidev)
 Get EFI driver-private data. More...
 
struct efi_deviceefidev_parent (struct device *dev)
 Get parent EFI device. More...
 
int efi_driver_install (void)
 Install EFI driver. More...
 
void efi_driver_uninstall (void)
 Uninstall EFI driver. More...
 
int efi_driver_connect_all (void)
 Connect EFI driver to all possible devices. More...
 
void efi_driver_disconnect_all (void)
 Disconnect EFI driver from all possible devices. More...
 
void efi_driver_reconnect_all (void)
 Reconnect original EFI drivers to all possible devices. More...
 

Detailed Description

EFI driver interface.

Definition in file efi_driver.h.

Macro Definition Documentation

◆ EFI_DRIVERS

#define EFI_DRIVERS   __table ( struct efi_driver, "efi_drivers" )

EFI driver table.

Definition at line 57 of file efi_driver.h.

◆ __efi_driver

#define __efi_driver (   order)    __table_entry ( EFI_DRIVERS, order )

Declare an EFI driver.

Definition at line 60 of file efi_driver.h.

◆ EFI_DRIVER_EARLY

#define EFI_DRIVER_EARLY   01

Early drivers.

Definition at line 62 of file efi_driver.h.

◆ EFI_DRIVER_NORMAL

#define EFI_DRIVER_NORMAL   02

Normal drivers.

Definition at line 63 of file efi_driver.h.

◆ EFI_DRIVER_LATE

#define EFI_DRIVER_LATE   03

Late drivers.

Definition at line 64 of file efi_driver.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ efidev_set_drvdata()

static void efidev_set_drvdata ( struct efi_device efidev,
void *  priv 
)
inlinestatic

Set EFI driver-private data.

Parameters
efidevEFI device
privPrivate data

Definition at line 72 of file efi_driver.h.

73  {
74  efidev->priv = priv;
75 }
void * priv
Driver-private data.
Definition: efi_driver.h:27
static struct tlan_private * priv
Definition: tlan.c:224

References efi_device::priv, and priv.

Referenced by efipci_start(), nii_start(), snpnet_start(), and usbio_start().

◆ efidev_get_drvdata()

static void* efidev_get_drvdata ( struct efi_device efidev)
inlinestatic

Get EFI driver-private data.

Parameters
efidevEFI device
Return values
privPrivate data

Definition at line 83 of file efi_driver.h.

83  {
84  return efidev->priv;
85 }
void * priv
Driver-private data.
Definition: efi_driver.h:27

References efi_device::priv.

Referenced by efipci_stop(), nii_stop(), snpnet_stop(), and usbio_stop().

◆ efidev_parent()

struct efi_device* efidev_parent ( struct device dev)

Get parent EFI device.

Parameters
devGeneric device
Return values
efidevParent EFI device, or NULL

Definition at line 88 of file efi_driver.c.

88  {
89  struct device *parent;
90  struct efi_device *efidev;
91 
92  /* Walk upwards until we find a registered EFI device */
93  while ( ( parent = dev->parent ) ) {
94  list_for_each_entry ( efidev, &efi_devices, dev.siblings ) {
95  if ( parent == &efidev->dev )
96  return efidev;
97  }
98  dev = parent;
99  }
100 
101  return NULL;
102 }
struct device * parent
Bus device.
Definition: device.h:85
A hardware device.
Definition: device.h:73
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:420
struct list_head siblings
Devices on the same bus.
Definition: device.h:81
An EFI device.
Definition: efi_driver.h:17
struct device dev
Generic device.
Definition: efi_driver.h:19
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References efi_device::dev, list_for_each_entry, NULL, device::parent, and device::siblings.

Referenced by efi_snp_probe(), and efi_usb_probe().

◆ efi_driver_install()

int efi_driver_install ( void  )

Install EFI driver.

Return values
rcReturn status code

Definition at line 386 of file efi_driver.c.

386  {
388  EFI_STATUS efirc;
389  int rc;
390 
391  /* Calculate driver version number. We use the build
392  * timestamp (in seconds since the Epoch) shifted right by six
393  * bits: this gives us an approximately one-minute resolution
394  * and a scheme which will last until the year 10680.
395  */
397 
398  /* Install protocols on image handle */
401  if ( ( efirc = bs->InstallMultipleProtocolInterfaces (
405  NULL ) ) != 0 ) {
406  rc = -EEFI ( efirc );
407  DBGC ( &efi_driver_binding, "EFIDRV could not install "
408  "protocols: %s\n", strerror ( rc ) );
409  return rc;
410  }
411 
412  return 0;
413 }
EFI_BOOT_SERVICES * BootServices
A pointer to the EFI Boot Services Table.
Definition: UefiSpec.h:2000
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:157
#define DBGC(...)
Definition: compiler.h:505
EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces
Definition: UefiSpec.h:1915
unsigned long build_timestamp
Build timestamp.
Definition: version.c:57
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
EFI Boot Services Table.
Definition: UefiSpec.h:1836
EFI_HANDLE efi_image_handle
Image handle passed to entry point.
Definition: efi_init.c:30
EFI_HANDLE DriverBindingHandle
The handle on which this instance of the EFI_DRIVER_BINDING_PROTOCOL is installed.
EFI_GUID efi_component_name2_protocol_guid
Component name 2 protocol GUID.
Definition: efi_guid.c:124
EFI_HANDLE ImageHandle
The image handle of the UEFI driver that produced this instance of the EFI_DRIVER_BINDING_PROTOCOL.
static EFI_DRIVER_BINDING_PROTOCOL efi_driver_binding
EFI driver binding protocol.
Definition: efi_driver.c:56
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
EFI_SYSTEM_TABLE * efi_systab
static EFI_COMPONENT_NAME2_PROTOCOL efi_wtf
EFI component name protocol.
Definition: efi_driver.c:375
EFI_GUID efi_driver_binding_protocol_guid
Driver binding protocol GUID.
Definition: efi_guid.c:148
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
UINT32 Version
The version number of the UEFI driver that produced the EFI_DRIVER_BINDING_PROTOCOL.

References EFI_SYSTEM_TABLE::BootServices, build_timestamp, DBGC, _EFI_DRIVER_BINDING_PROTOCOL::DriverBindingHandle, EEFI, efi_component_name2_protocol_guid, efi_driver_binding, efi_driver_binding_protocol_guid, efi_image_handle, efi_systab, efi_wtf, _EFI_DRIVER_BINDING_PROTOCOL::ImageHandle, EFI_BOOT_SERVICES::InstallMultipleProtocolInterfaces, NULL, rc, strerror(), and _EFI_DRIVER_BINDING_PROTOCOL::Version.

Referenced by efi_init().

◆ efi_driver_uninstall()

void efi_driver_uninstall ( void  )

Uninstall EFI driver.

Definition at line 419 of file efi_driver.c.

419  {
421 
422  /* Uninstall protocols */
427 }
EFI_BOOT_SERVICES * BootServices
A pointer to the EFI Boot Services Table.
Definition: UefiSpec.h:2000
EFI Boot Services Table.
Definition: UefiSpec.h:1836
EFI_HANDLE efi_image_handle
Image handle passed to entry point.
Definition: efi_init.c:30
EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces
Definition: UefiSpec.h:1916
EFI_GUID efi_component_name2_protocol_guid
Component name 2 protocol GUID.
Definition: efi_guid.c:124
static EFI_DRIVER_BINDING_PROTOCOL efi_driver_binding
EFI driver binding protocol.
Definition: efi_driver.c:56
EFI_SYSTEM_TABLE * efi_systab
static EFI_COMPONENT_NAME2_PROTOCOL efi_wtf
EFI component name protocol.
Definition: efi_driver.c:375
EFI_GUID efi_driver_binding_protocol_guid
Driver binding protocol GUID.
Definition: efi_guid.c:148
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References EFI_SYSTEM_TABLE::BootServices, efi_component_name2_protocol_guid, efi_driver_binding, efi_driver_binding_protocol_guid, efi_image_handle, efi_systab, efi_wtf, NULL, and EFI_BOOT_SERVICES::UninstallMultipleProtocolInterfaces.

Referenced by efi_init(), and efi_unload().

◆ efi_driver_connect_all()

int efi_driver_connect_all ( void  )

Connect EFI driver to all possible devices.

Return values
rcReturn status code

Definition at line 565 of file efi_driver.c.

565  {
566 
567  DBGC ( &efi_driver_binding, "EFIDRV connecting our drivers\n" );
569 }
static int efi_driver_connect(EFI_HANDLE device)
Try to connect EFI driver.
Definition: efi_driver.c:435
#define DBGC(...)
Definition: compiler.h:505
static int efi_driver_handles(int(*method)(EFI_HANDLE handle))
Connect/disconnect EFI driver from all handles.
Definition: efi_driver.c:525
static EFI_DRIVER_BINDING_PROTOCOL efi_driver_binding
EFI driver binding protocol.
Definition: efi_driver.c:56

References DBGC, efi_driver_binding, efi_driver_connect(), and efi_driver_handles().

Referenced by efi_probe().

◆ efi_driver_disconnect_all()

void efi_driver_disconnect_all ( void  )

Disconnect EFI driver from all possible devices.

Return values
rcReturn status code

Definition at line 576 of file efi_driver.c.

576  {
577 
578  DBGC ( &efi_driver_binding, "EFIDRV disconnecting our drivers\n" );
580 }
#define DBGC(...)
Definition: compiler.h:505
static int efi_driver_handles(int(*method)(EFI_HANDLE handle))
Connect/disconnect EFI driver from all handles.
Definition: efi_driver.c:525
static EFI_DRIVER_BINDING_PROTOCOL efi_driver_binding
EFI driver binding protocol.
Definition: efi_driver.c:56
static int efi_driver_disconnect(EFI_HANDLE device)
Try to disconnect EFI driver.
Definition: efi_driver.c:492

References DBGC, efi_driver_binding, efi_driver_disconnect(), and efi_driver_handles().

Referenced by efi_remove(), and efi_unload().

◆ efi_driver_reconnect_all()

void efi_driver_reconnect_all ( void  )

Reconnect original EFI drivers to all possible devices.

Return values
rcReturn status code

Definition at line 587 of file efi_driver.c.

587  {
588 
589  DBGC ( &efi_driver_binding, "EFIDRV reconnecting old drivers\n" );
591 }
#define DBGC(...)
Definition: compiler.h:505
static int efi_driver_reconnect(EFI_HANDLE device)
Reconnect original EFI driver.
Definition: efi_driver.c:510
static int efi_driver_handles(int(*method)(EFI_HANDLE handle))
Connect/disconnect EFI driver from all handles.
Definition: efi_driver.c:525
static EFI_DRIVER_BINDING_PROTOCOL efi_driver_binding
EFI driver binding protocol.
Definition: efi_driver.c:56

References DBGC, efi_driver_binding, efi_driver_handles(), and efi_driver_reconnect().

Referenced by _efi_start().