[efi] Retain a long-lived reference to the EFI_PCI_IO_PROTOCOL instance

Provide opened EFI PCI devices with access to the underlying
EFI_PCI_IO_PROTOCOL instance, in order to facilitate the future use of
the DMA mapping methods within the fast data path.

Do not require the use of this stored EFI_PCI_IO_PROTOCOL instance for
memory-mapped I/O (since the entire point of memory-mapped I/O as a
concept is to avoid this kind of unnecessary complexity) or for
slow-path PCI configuration space accesses (since these may be
required for access to PCI bus:dev.fn addresses that do not correspond
to a device bound via our driver binding protocol instance).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
pull/171/head
Michael Brown 2020-11-04 15:08:48 +00:00
parent f560e7b70b
commit 36dde9b0bf
4 changed files with 60 additions and 49 deletions

View File

@ -17,9 +17,17 @@ static inline EFIAPI uint64_t LShiftU64 ( UINT64 value, UINTN shift ) {
return ( value << shift ); return ( value << shift );
} }
/** An EFI PCI device */
struct efi_pci_device {
/** PCI device */
struct pci_device pci;
/** PCI I/O protocol */
EFI_PCI_IO_PROTOCOL *io;
};
extern int efipci_open ( EFI_HANDLE device, UINT32 attributes, extern int efipci_open ( EFI_HANDLE device, UINT32 attributes,
struct pci_device *pci ); struct efi_pci_device *efipci );
extern void efipci_close ( EFI_HANDLE device ); extern void efipci_close ( EFI_HANDLE device );
extern int efipci_info ( EFI_HANDLE device, struct pci_device *pci ); extern int efipci_info ( EFI_HANDLE device, struct efi_pci_device *efipci );
#endif /* _IPXE_EFI_PCI_H */ #endif /* _IPXE_EFI_PCI_H */

View File

@ -164,7 +164,7 @@ static EFI_GUID bofm2_protocol_guid =
*/ */
static int efi_bofm_supported ( EFI_HANDLE device ) { static int efi_bofm_supported ( EFI_HANDLE device ) {
EFI_BOOT_SERVICES *bs = efi_systab->BootServices; EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
struct pci_device pci; struct efi_pci_device efipci;
union { union {
IBM_BOFM_DRIVER_CONFIGURATION_PROTOCOL *bofm1; IBM_BOFM_DRIVER_CONFIGURATION_PROTOCOL *bofm1;
void *interface; void *interface;
@ -173,11 +173,11 @@ static int efi_bofm_supported ( EFI_HANDLE device ) {
int rc; int rc;
/* Get PCI device information */ /* Get PCI device information */
if ( ( rc = efipci_info ( device, &pci ) ) != 0 ) if ( ( rc = efipci_info ( device, &efipci ) ) != 0 )
return rc; return rc;
/* Look for a BOFM driver */ /* Look for a BOFM driver */
if ( ( rc = bofm_find_driver ( &pci ) ) != 0 ) { if ( ( rc = bofm_find_driver ( &efipci.pci ) ) != 0 ) {
DBGCP ( device, "EFIBOFM %s has no driver\n", DBGCP ( device, "EFIBOFM %s has no driver\n",
efi_handle_name ( device ) ); efi_handle_name ( device ) );
return rc; return rc;
@ -204,7 +204,7 @@ static int efi_bofm_supported ( EFI_HANDLE device ) {
} }
DBGC ( device, "EFIBOFM %s has driver \"%s\"\n", DBGC ( device, "EFIBOFM %s has driver \"%s\"\n",
efi_handle_name ( device ), pci.id->name ); efi_handle_name ( device ), efipci.pci.id->name );
return 0; return 0;
} }
@ -225,7 +225,7 @@ static int efi_bofm_start ( struct efi_device *efidev ) {
IBM_BOFM_DRIVER_CONFIGURATION_PROTOCOL2 *bofm2; IBM_BOFM_DRIVER_CONFIGURATION_PROTOCOL2 *bofm2;
void *interface; void *interface;
} bofm2; } bofm2;
struct pci_device pci; struct efi_pci_device efipci;
IBM_BOFM_TABLE *bofmtab; IBM_BOFM_TABLE *bofmtab;
IBM_BOFM_TABLE *bofmtab2; IBM_BOFM_TABLE *bofmtab2;
int bofmrc; int bofmrc;
@ -234,7 +234,7 @@ static int efi_bofm_start ( struct efi_device *efidev ) {
/* Open PCI device, if possible */ /* Open PCI device, if possible */
if ( ( rc = efipci_open ( device, EFI_OPEN_PROTOCOL_GET_PROTOCOL, if ( ( rc = efipci_open ( device, EFI_OPEN_PROTOCOL_GET_PROTOCOL,
&pci ) ) != 0 ) &efipci ) ) != 0 )
goto err_open; goto err_open;
/* Locate BOFM protocol */ /* Locate BOFM protocol */
@ -274,7 +274,8 @@ static int efi_bofm_start ( struct efi_device *efidev ) {
efi_handle_name ( device ) ); efi_handle_name ( device ) );
DBGC2_HD ( device, bofmtab2, bofmtab2->Parameters.Length ); DBGC2_HD ( device, bofmtab2, bofmtab2->Parameters.Length );
} }
bofmrc = bofm ( virt_to_user ( bofmtab2 ? bofmtab2 : bofmtab ), &pci ); bofmrc = bofm ( virt_to_user ( bofmtab2 ? bofmtab2 : bofmtab ),
&efipci.pci );
DBGC ( device, "EFIBOFM %s status %08x\n", DBGC ( device, "EFIBOFM %s status %08x\n",
efi_handle_name ( device ), bofmrc ); efi_handle_name ( device ), bofmrc );
DBGC2 ( device, "EFIBOFM %s version 1 after processing:\n", DBGC2 ( device, "EFIBOFM %s version 1 after processing:\n",

View File

@ -316,11 +316,11 @@ PROVIDE_PCIAPI ( efi, pci_ioremap, efipci_ioremap );
* *
* @v device EFI device handle * @v device EFI device handle
* @v attributes Protocol opening attributes * @v attributes Protocol opening attributes
* @v pci PCI device to fill in * @v efipci EFI PCI device to fill in
* @ret rc Return status code * @ret rc Return status code
*/ */
int efipci_open ( EFI_HANDLE device, UINT32 attributes, int efipci_open ( EFI_HANDLE device, UINT32 attributes,
struct pci_device *pci ) { struct efi_pci_device *efipci ) {
EFI_BOOT_SERVICES *bs = efi_systab->BootServices; EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
union { union {
EFI_PCI_IO_PROTOCOL *pci_io; EFI_PCI_IO_PROTOCOL *pci_io;
@ -340,6 +340,7 @@ int efipci_open ( EFI_HANDLE device, UINT32 attributes,
efi_handle_name ( device ), strerror ( rc ) ); efi_handle_name ( device ), strerror ( rc ) );
goto err_open_protocol; goto err_open_protocol;
} }
efipci->io = pci_io.pci_io;
/* Get PCI bus:dev.fn address */ /* Get PCI bus:dev.fn address */
if ( ( efirc = pci_io.pci_io->GetLocation ( pci_io.pci_io, &pci_segment, if ( ( efirc = pci_io.pci_io->GetLocation ( pci_io.pci_io, &pci_segment,
@ -351,9 +352,9 @@ int efipci_open ( EFI_HANDLE device, UINT32 attributes,
goto err_get_location; goto err_get_location;
} }
busdevfn = PCI_BUSDEVFN ( pci_segment, pci_bus, pci_dev, pci_fn ); busdevfn = PCI_BUSDEVFN ( pci_segment, pci_bus, pci_dev, pci_fn );
pci_init ( pci, busdevfn ); pci_init ( &efipci->pci, busdevfn );
DBGCP ( device, "EFIPCI " PCI_FMT " is %s\n", DBGCP ( device, "EFIPCI " PCI_FMT " is %s\n",
PCI_ARGS ( pci ), efi_handle_name ( device ) ); PCI_ARGS ( &efipci->pci ), efi_handle_name ( device ) );
/* Try to enable I/O cycles, memory cycles, and bus mastering. /* Try to enable I/O cycles, memory cycles, and bus mastering.
* Some platforms will 'helpfully' report errors if these bits * Some platforms will 'helpfully' report errors if these bits
@ -372,10 +373,10 @@ int efipci_open ( EFI_HANDLE device, UINT32 attributes,
EFI_PCI_IO_ATTRIBUTE_BUS_MASTER, NULL ); EFI_PCI_IO_ATTRIBUTE_BUS_MASTER, NULL );
/* Populate PCI device */ /* Populate PCI device */
if ( ( rc = pci_read_config ( pci ) ) != 0 ) { if ( ( rc = pci_read_config ( &efipci->pci ) ) != 0 ) {
DBGC ( device, "EFIPCI " PCI_FMT " cannot read PCI " DBGC ( device, "EFIPCI " PCI_FMT " cannot read PCI "
"configuration: %s\n", "configuration: %s\n",
PCI_ARGS ( pci ), strerror ( rc ) ); PCI_ARGS ( &efipci->pci ), strerror ( rc ) );
goto err_pci_read_config; goto err_pci_read_config;
} }
@ -405,15 +406,15 @@ void efipci_close ( EFI_HANDLE device ) {
* Get EFI PCI device information * Get EFI PCI device information
* *
* @v device EFI device handle * @v device EFI device handle
* @v pci PCI device to fill in * @v efipci EFI PCI device to fill in
* @ret rc Return status code * @ret rc Return status code
*/ */
int efipci_info ( EFI_HANDLE device, struct pci_device *pci ) { int efipci_info ( EFI_HANDLE device, struct efi_pci_device *efipci ) {
int rc; int rc;
/* Open PCI device, if possible */ /* Open PCI device, if possible */
if ( ( rc = efipci_open ( device, EFI_OPEN_PROTOCOL_GET_PROTOCOL, if ( ( rc = efipci_open ( device, EFI_OPEN_PROTOCOL_GET_PROTOCOL,
pci ) ) != 0 ) efipci ) ) != 0 )
return rc; return rc;
/* Close PCI device */ /* Close PCI device */
@ -436,23 +437,24 @@ int efipci_info ( EFI_HANDLE device, struct pci_device *pci ) {
* @ret rc Return status code * @ret rc Return status code
*/ */
static int efipci_supported ( EFI_HANDLE device ) { static int efipci_supported ( EFI_HANDLE device ) {
struct pci_device pci; struct efi_pci_device efipci;
int rc; int rc;
/* Get PCI device information */ /* Get PCI device information */
if ( ( rc = efipci_info ( device, &pci ) ) != 0 ) if ( ( rc = efipci_info ( device, &efipci ) ) != 0 )
return rc; return rc;
/* Look for a driver */ /* Look for a driver */
if ( ( rc = pci_find_driver ( &pci ) ) != 0 ) { if ( ( rc = pci_find_driver ( &efipci.pci ) ) != 0 ) {
DBGC ( device, "EFIPCI " PCI_FMT " (%04x:%04x class %06x) " DBGC ( device, "EFIPCI " PCI_FMT " (%04x:%04x class %06x) "
"has no driver\n", PCI_ARGS ( &pci ), pci.vendor, "has no driver\n", PCI_ARGS ( &efipci.pci ),
pci.device, pci.class ); efipci.pci.vendor, efipci.pci.device,
efipci.pci.class );
return rc; return rc;
} }
DBGC ( device, "EFIPCI " PCI_FMT " (%04x:%04x class %06x) has driver " DBGC ( device, "EFIPCI " PCI_FMT " (%04x:%04x class %06x) has driver "
"\"%s\"\n", PCI_ARGS ( &pci ), pci.vendor, pci.device, "\"%s\"\n", PCI_ARGS ( &efipci.pci ), efipci.pci.vendor,
pci.class, pci.id->name ); efipci.pci.device, efipci.pci.class, efipci.pci.id->name );
return 0; return 0;
} }
@ -465,12 +467,12 @@ static int efipci_supported ( EFI_HANDLE device ) {
*/ */
static int efipci_start ( struct efi_device *efidev ) { static int efipci_start ( struct efi_device *efidev ) {
EFI_HANDLE device = efidev->device; EFI_HANDLE device = efidev->device;
struct pci_device *pci; struct efi_pci_device *efipci;
int rc; int rc;
/* Allocate PCI device */ /* Allocate PCI device */
pci = zalloc ( sizeof ( *pci ) ); efipci = zalloc ( sizeof ( *efipci ) );
if ( ! pci ) { if ( ! efipci ) {
rc = -ENOMEM; rc = -ENOMEM;
goto err_alloc; goto err_alloc;
} }
@ -478,7 +480,7 @@ static int efipci_start ( struct efi_device *efidev ) {
/* Open PCI device */ /* Open PCI device */
if ( ( rc = efipci_open ( device, ( EFI_OPEN_PROTOCOL_BY_DRIVER | if ( ( rc = efipci_open ( device, ( EFI_OPEN_PROTOCOL_BY_DRIVER |
EFI_OPEN_PROTOCOL_EXCLUSIVE ), EFI_OPEN_PROTOCOL_EXCLUSIVE ),
pci ) ) != 0 ) { efipci ) ) != 0 ) {
DBGC ( device, "EFIPCI %s could not open PCI device: %s\n", DBGC ( device, "EFIPCI %s could not open PCI device: %s\n",
efi_handle_name ( device ), strerror ( rc ) ); efi_handle_name ( device ), strerror ( rc ) );
DBGC_EFI_OPENERS ( device, device, &efi_pci_io_protocol_guid ); DBGC_EFI_OPENERS ( device, device, &efi_pci_io_protocol_guid );
@ -486,36 +488,36 @@ static int efipci_start ( struct efi_device *efidev ) {
} }
/* Find driver */ /* Find driver */
if ( ( rc = pci_find_driver ( pci ) ) != 0 ) { if ( ( rc = pci_find_driver ( &efipci->pci ) ) != 0 ) {
DBGC ( device, "EFIPCI " PCI_FMT " has no driver\n", DBGC ( device, "EFIPCI " PCI_FMT " has no driver\n",
PCI_ARGS ( pci ) ); PCI_ARGS ( &efipci->pci ) );
goto err_find_driver; goto err_find_driver;
} }
/* Mark PCI device as a child of the EFI device */ /* Mark PCI device as a child of the EFI device */
pci->dev.parent = &efidev->dev; efipci->pci.dev.parent = &efidev->dev;
list_add ( &pci->dev.siblings, &efidev->dev.children ); list_add ( &efipci->pci.dev.siblings, &efidev->dev.children );
/* Probe driver */ /* Probe driver */
if ( ( rc = pci_probe ( pci ) ) != 0 ) { if ( ( rc = pci_probe ( &efipci->pci ) ) != 0 ) {
DBGC ( device, "EFIPCI " PCI_FMT " could not probe driver " DBGC ( device, "EFIPCI " PCI_FMT " could not probe driver "
"\"%s\": %s\n", PCI_ARGS ( pci ), pci->id->name, "\"%s\": %s\n", PCI_ARGS ( &efipci->pci ),
strerror ( rc ) ); efipci->pci.id->name, strerror ( rc ) );
goto err_probe; goto err_probe;
} }
DBGC ( device, "EFIPCI " PCI_FMT " using driver \"%s\"\n", DBGC ( device, "EFIPCI " PCI_FMT " using driver \"%s\"\n",
PCI_ARGS ( pci ), pci->id->name ); PCI_ARGS ( &efipci->pci ), efipci->pci.id->name );
efidev_set_drvdata ( efidev, pci ); efidev_set_drvdata ( efidev, efipci );
return 0; return 0;
pci_remove ( pci ); pci_remove ( &efipci->pci );
err_probe: err_probe:
list_del ( &pci->dev.siblings ); list_del ( &efipci->pci.dev.siblings );
err_find_driver: err_find_driver:
efipci_close ( device ); efipci_close ( device );
err_open: err_open:
free ( pci ); free ( efipci );
err_alloc: err_alloc:
return rc; return rc;
} }
@ -526,13 +528,13 @@ static int efipci_start ( struct efi_device *efidev ) {
* @v efidev EFI device * @v efidev EFI device
*/ */
static void efipci_stop ( struct efi_device *efidev ) { static void efipci_stop ( struct efi_device *efidev ) {
struct pci_device *pci = efidev_get_drvdata ( efidev ); struct efi_pci_device *efipci = efidev_get_drvdata ( efidev );
EFI_HANDLE device = efidev->device; EFI_HANDLE device = efidev->device;
pci_remove ( pci ); pci_remove ( &efipci->pci );
list_del ( &pci->dev.siblings ); list_del ( &efipci->pci.dev.siblings );
efipci_close ( device ); efipci_close ( device );
free ( pci ); free ( efipci );
} }
/** EFI PCI driver */ /** EFI PCI driver */

View File

@ -145,7 +145,7 @@ void efi_child_del ( EFI_HANDLE parent, EFI_HANDLE child ) {
static int efi_pci_info ( EFI_HANDLE device, const char *prefix, static int efi_pci_info ( EFI_HANDLE device, const char *prefix,
struct device *dev ) { struct device *dev ) {
EFI_HANDLE pci_device; EFI_HANDLE pci_device;
struct pci_device pci; struct efi_pci_device efipci;
int rc; int rc;
/* Find parent PCI device */ /* Find parent PCI device */
@ -157,16 +157,16 @@ static int efi_pci_info ( EFI_HANDLE device, const char *prefix,
} }
/* Get PCI device information */ /* Get PCI device information */
if ( ( rc = efipci_info ( pci_device, &pci ) ) != 0 ) { if ( ( rc = efipci_info ( pci_device, &efipci ) ) != 0 ) {
DBGC ( device, "EFIDEV %s could not get PCI information: %s\n", DBGC ( device, "EFIDEV %s could not get PCI information: %s\n",
efi_handle_name ( device ), strerror ( rc ) ); efi_handle_name ( device ), strerror ( rc ) );
return rc; return rc;
} }
/* Populate device information */ /* Populate device information */
memcpy ( &dev->desc, &pci.dev.desc, sizeof ( dev->desc ) ); memcpy ( &dev->desc, &efipci.pci.dev.desc, sizeof ( dev->desc ) );
snprintf ( dev->name, sizeof ( dev->name ), "%s-%s", snprintf ( dev->name, sizeof ( dev->name ), "%s-%s",
prefix, pci.dev.name ); prefix, efipci.pci.dev.name );
return 0; return 0;
} }