iPXE
Functions
efi_pci.h File Reference

EFI driver interface. More...

#include <ipxe/pci.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/PciIo.h>

Go to the source code of this file.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
static EFIAPI uint64_t LShiftU64 (UINT64 value, UINTN shift)
 
int efipci_open (EFI_HANDLE device, UINT32 attributes, struct pci_device *pci)
 Open EFI PCI device. More...
 
void efipci_close (EFI_HANDLE device)
 Close EFI PCI device. More...
 
int efipci_info (EFI_HANDLE device, struct pci_device *pci)
 Get EFI PCI device information. More...
 

Detailed Description

EFI driver interface.

Definition in file efi_pci.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ LShiftU64()

static EFIAPI uint64_t LShiftU64 ( UINT64  value,
UINTN  shift 
)
inlinestatic

Definition at line 16 of file efi_pci.h.

16  {
17  return ( value << shift );
18 }
pseudo_bit_t value[0x00020]
Definition: arbel.h:13

References value.

◆ efipci_open()

int efipci_open ( EFI_HANDLE  device,
UINT32  attributes,
struct pci_device pci 
)

Open EFI PCI device.

Parameters
deviceEFI device handle
attributesProtocol opening attributes
pciPCI device to fill in
Return values
rcReturn status code

Definition at line 324 of file efi_pci.c.

325  {
327  union {
328  EFI_PCI_IO_PROTOCOL *pci_io;
329  void *interface;
330  } pci_io;
331  UINTN pci_segment, pci_bus, pci_dev, pci_fn;
332  unsigned int busdevfn;
333  EFI_STATUS efirc;
334  int rc;
335 
336  /* See if device is a PCI device */
337  if ( ( efirc = bs->OpenProtocol ( device, &efi_pci_io_protocol_guid,
338  &pci_io.interface, efi_image_handle,
339  device, attributes ) ) != 0 ) {
340  rc = -EEFI_PCI ( efirc );
341  DBGCP ( device, "EFIPCI %s cannot open PCI protocols: %s\n",
342  efi_handle_name ( device ), strerror ( rc ) );
343  goto err_open_protocol;
344  }
345 
346  /* Get PCI bus:dev.fn address */
347  if ( ( efirc = pci_io.pci_io->GetLocation ( pci_io.pci_io, &pci_segment,
348  &pci_bus, &pci_dev,
349  &pci_fn ) ) != 0 ) {
350  rc = -EEFI ( efirc );
351  DBGC ( device, "EFIPCI %s could not get PCI location: %s\n",
352  efi_handle_name ( device ), strerror ( rc ) );
353  goto err_get_location;
354  }
355  busdevfn = PCI_BUSDEVFN ( pci_segment, pci_bus, pci_dev, pci_fn );
356  pci_init ( pci, busdevfn );
357  DBGCP ( device, "EFIPCI " PCI_FMT " is %s\n",
358  PCI_ARGS ( pci ), efi_handle_name ( device ) );
359 
360  /* Try to enable I/O cycles, memory cycles, and bus mastering.
361  * Some platforms will 'helpfully' report errors if these bits
362  * can't be enabled (for example, if the card doesn't actually
363  * support I/O cycles). Work around any such platforms by
364  * enabling bits individually and simply ignoring any errors.
365  */
366  pci_io.pci_io->Attributes ( pci_io.pci_io,
369  pci_io.pci_io->Attributes ( pci_io.pci_io,
372  pci_io.pci_io->Attributes ( pci_io.pci_io,
375 
376  /* Populate PCI device */
377  if ( ( rc = pci_read_config ( pci ) ) != 0 ) {
378  DBGC ( device, "EFIPCI " PCI_FMT " cannot read PCI "
379  "configuration: %s\n",
380  PCI_ARGS ( pci ), strerror ( rc ) );
381  goto err_pci_read_config;
382  }
383 
384  return 0;
385 
386  err_pci_read_config:
387  err_get_location:
390  err_open_protocol:
391  return rc;
392 }
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:159
EFI_GUID efi_pci_io_protocol_guid
PCI I/O protocol GUID.
Definition: efi_guid.c:216
#define DBGC(...)
Definition: compiler.h:505
#define PCI_BUSDEVFN(segment, bus, slot, func)
Definition: pci.h:259
EFI_CLOSE_PROTOCOL CloseProtocol
Definition: UefiSpec.h:1906
A hardware device.
Definition: device.h:73
#define EFI_PCI_IO_ATTRIBUTE_MEMORY
Enable the Memory decode bit in the PCI Config Header.
Definition: PciIo.h:66
An object interface.
Definition: interface.h:109
#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER
Enable the DMA bit in the PCI Config Header.
Definition: PciIo.h:67
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition: efi_debug.c:713
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
EFI Boot Services Table.
Definition: UefiSpec.h:1836
#define PCI_FMT
PCI device debug message format.
Definition: pci.h:287
EFI_HANDLE efi_image_handle
Image handle passed to entry point.
Definition: efi_init.c:33
int pci_read_config(struct pci_device *pci)
Read PCI device configuration.
Definition: pci.c:177
UINT64 UINTN
Unsigned value of native width.
Definition: ProcessorBind.h:71
#define EFI_PCI_IO_ATTRIBUTE_IO
Enable the I/O decode bit in the PCI Config Header.
Definition: PciIo.h:65
Enable the attributes specified by the bits that are set in Attributes for this PCI controller.
Definition: PciIo.h:119
#define EEFI_PCI(efirc)
Definition: efi_pci.c:54
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
#define PCI_ARGS(pci)
PCI device debug message arguments.
Definition: pci.h:290
#define DBGCP(...)
Definition: compiler.h:539
EFI_SYSTEM_TABLE * efi_systab
EFI_OPEN_PROTOCOL OpenProtocol
Definition: UefiSpec.h:1905
static void pci_init(struct pci_device *pci, unsigned int busdevfn)
Initialise PCI device.
Definition: pci.h:313
The EFI_PCI_IO_PROTOCOL provides the basic Memory, I/O, PCI configuration, and DMA interfaces used to...
Definition: PciIo.h:525
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::CloseProtocol, DBGC, DBGCP, EEFI, EEFI_PCI, efi_handle_name(), efi_image_handle, EFI_PCI_IO_ATTRIBUTE_BUS_MASTER, EFI_PCI_IO_ATTRIBUTE_IO, EFI_PCI_IO_ATTRIBUTE_MEMORY, efi_pci_io_protocol_guid, efi_systab, EfiPciIoAttributeOperationEnable, NULL, EFI_BOOT_SERVICES::OpenProtocol, PCI_ARGS, PCI_BUSDEVFN, PCI_FMT, pci_init(), pci_read_config(), rc, and strerror().

Referenced by efi_bofm_start(), efipci_info(), and efipci_start().

◆ efipci_close()

void efipci_close ( EFI_HANDLE  device)

Close EFI PCI device.

Parameters
deviceEFI device handle

Definition at line 399 of file efi_pci.c.

399  {
401 
404 }
EFI_BOOT_SERVICES * BootServices
A pointer to the EFI Boot Services Table.
Definition: UefiSpec.h:2000
EFI_GUID efi_pci_io_protocol_guid
PCI I/O protocol GUID.
Definition: efi_guid.c:216
EFI_CLOSE_PROTOCOL CloseProtocol
Definition: UefiSpec.h:1906
A hardware device.
Definition: device.h:73
EFI Boot Services Table.
Definition: UefiSpec.h:1836
EFI_HANDLE efi_image_handle
Image handle passed to entry point.
Definition: efi_init.c:33
EFI_SYSTEM_TABLE * efi_systab

References EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::CloseProtocol, efi_image_handle, efi_pci_io_protocol_guid, and efi_systab.

Referenced by efi_bofm_start(), efipci_info(), efipci_start(), and efipci_stop().

◆ efipci_info()

int efipci_info ( EFI_HANDLE  device,
struct pci_device pci 
)

Get EFI PCI device information.

Parameters
deviceEFI device handle
pciPCI device to fill in
Return values
rcReturn status code

Definition at line 413 of file efi_pci.c.

413  {
414  int rc;
415 
416  /* Open PCI device, if possible */
418  pci ) ) != 0 )
419  return rc;
420 
421  /* Close PCI device */
422  efipci_close ( device );
423 
424  return 0;
425 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
A hardware device.
Definition: device.h:73
int efipci_open(EFI_HANDLE device, UINT32 attributes, struct pci_device *pci)
Open EFI PCI device.
Definition: efi_pci.c:324
#define EFI_OPEN_PROTOCOL_GET_PROTOCOL
Definition: UefiSpec.h:1271
void efipci_close(EFI_HANDLE device)
Close EFI PCI device.
Definition: efi_pci.c:399

References EFI_OPEN_PROTOCOL_GET_PROTOCOL, efipci_close(), efipci_open(), and rc.

Referenced by efi_bofm_supported(), efi_pci_info(), and efipci_supported().