efi_pci_api.h File Reference

iPXE PCI I/O API for EFI More...

Go to the source code of this file.

Macros
#define	PCIAPI_PREFIX_efi   __efi_
#define	EFIPCI_WIDTH_BYTE   0
#define	EFIPCI_WIDTH_WORD   1
#define	EFIPCI_WIDTH_DWORD   2
#define	EFIPCI_LOCATION(_offset, _width)
#define	EFIPCI_OFFSET(_location)
#define	EFIPCI_WIDTH(_location)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	efipci_read (struct pci_device *pci, unsigned long location, void *value)
	Read from PCI configuration space.
int	efipci_write (struct pci_device *pci, unsigned long location, unsigned long value)
	Write to PCI configuration space.
static __always_inline int	PCIAPI_INLINE (efi, pci_can_probe)(struct pci_device *pci __unused)
	Check if PCI bus probing is allowed.
static __always_inline int	PCIAPI_INLINE (efi, pci_read_config_byte)(struct pci_device *pci
	Read byte from PCI configuration space via EFI.
return	efipci_read (pci, EFIPCI_LOCATION(where, EFIPCI_WIDTH_BYTE), value)
static __always_inline int	PCIAPI_INLINE (efi, pci_read_config_word)(struct pci_device *pci
	Read word from PCI configuration space via EFI.
return	efipci_read (pci, EFIPCI_LOCATION(where, EFIPCI_WIDTH_WORD), value)
static __always_inline int	PCIAPI_INLINE (efi, pci_read_config_dword)(struct pci_device *pci
	Read dword from PCI configuration space via EFI.
return	efipci_read (pci, EFIPCI_LOCATION(where, EFIPCI_WIDTH_DWORD), value)
static __always_inline int	PCIAPI_INLINE (efi, pci_write_config_byte)(struct pci_device *pci
	Write byte to PCI configuration space via EFI.
static __always_inline int	PCIAPI_INLINE (efi, pci_write_config_word)(struct pci_device *pci
	Write word to PCI configuration space via EFI.
static __always_inline int	PCIAPI_INLINE (efi, pci_write_config_dword)(struct pci_device *pci
	Write dword to PCI configuration space via EFI.

Variables
static __always_inline int unsigned int	where
static __always_inline int unsigned int uint8_t *	value

Detailed Description

iPXE PCI I/O API for EFI

Definition in file efi_pci_api.h.

Macro Definition Documentation

PCIAPI_PREFIX_efi

#define PCIAPI_PREFIX_efi   __efi_

Definition at line 16 of file efi_pci_api.h.

EFIPCI_WIDTH_BYTE

#define EFIPCI_WIDTH_BYTE   0

Definition at line 20 of file efi_pci_api.h.

Referenced by efipci_read(), and PCIAPI_INLINE().

EFIPCI_WIDTH_WORD

#define EFIPCI_WIDTH_WORD   1

Definition at line 21 of file efi_pci_api.h.

Referenced by efipci_read(), and PCIAPI_INLINE().

EFIPCI_WIDTH_DWORD

#define EFIPCI_WIDTH_DWORD   2

Definition at line 22 of file efi_pci_api.h.

Referenced by efipci_read(), and PCIAPI_INLINE().

EFIPCI_LOCATION

#define EFIPCI_LOCATION	(		_offset,
			_width )

Value:

        ( (_offset) | ( (_width) << 16 ) )

Definition at line 24 of file efi_pci_api.h.

#define EFIPCI_LOCATION( _offset, _width ) \
        ( (_offset) | ( (_width) << 16 ) )

Referenced by efipci_read(), efipci_read(), efipci_read(), PCIAPI_INLINE(), PCIAPI_INLINE(), and PCIAPI_INLINE().

EFIPCI_OFFSET

#define EFIPCI_OFFSET

(

_location

)

Value:

( (_location) & 0xffff )

Definition at line 26 of file efi_pci_api.h.

Referenced by efipci_address(), efipci_read(), and efipci_write().

EFIPCI_WIDTH

#define EFIPCI_WIDTH

(

_location

)

Value:

( (_location) >> 16 )

Definition at line 27 of file efi_pci_api.h.

Referenced by efipci_read(), and efipci_write().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

efipci_read() [1/4]

int efipci_read ( struct pci_device * pci, unsigned long location, void * value )

extern

Read from PCI configuration space.

Parameters

pci	PCI device
location	Encoded offset and width

Return values

value	Value
rc	Return status code

Definition at line 307 of file efi_pci.c.

                                {
        EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *root;
        EFI_HANDLE handle;
        EFI_STATUS efirc;
        int rc;
 
        /* Open root bridge */
        if ( ( rc = efipci_root_open ( pci, &handle, &root ) ) != 0 )
                return rc;
 
        /* Read from configuration space */
        if ( ( efirc = root->Pci.Read ( root, EFIPCI_WIDTH ( location ),
                                        efipci_address ( pci, location ), 1,
                                        value ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( pci, "EFIPCI " PCI_FMT " config read from offset %02lx "
                       "failed: %s\n", PCI_ARGS ( pci ),
                       EFIPCI_OFFSET ( location ), strerror ( rc ) );
                return rc;
        }
 
        return 0;
}

References DBGC, EEFI, EFI_HANDLE, efipci_address(), EFIPCI_OFFSET, efipci_root_open(), EFIPCI_WIDTH, handle, PCI_ARGS, PCI_FMT, rc, root, strerror(), and value.

efipci_write()

int efipci_write ( struct pci_device * pci, unsigned long location, unsigned long value )

extern

Write to PCI configuration space.

Parameters

pci	PCI device
location	Encoded offset and width
value	Value

Return values

rc	Return status code

Definition at line 340 of file efi_pci.c.

                                         {
        EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *root;
        EFI_HANDLE handle;
        EFI_STATUS efirc;
        int rc;
 
        /* Open root bridge */
        if ( ( rc = efipci_root_open ( pci, &handle, &root ) ) != 0 )
                return rc;
 
        /* Read from configuration space */
        if ( ( efirc = root->Pci.Write ( root, EFIPCI_WIDTH ( location ),
                                         efipci_address ( pci, location ), 1,
                                         &value ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( pci, "EFIPCI " PCI_FMT " config write to offset %02lx "
                       "failed: %s\n", PCI_ARGS ( pci ),
                       EFIPCI_OFFSET ( location ), strerror ( rc ) );
                return rc;
        }
 
        return 0;
}

References DBGC, EEFI, EFI_HANDLE, efipci_address(), EFIPCI_OFFSET, efipci_root_open(), EFIPCI_WIDTH, handle, PCI_ARGS, PCI_FMT, rc, root, strerror(), and value.

Referenced by PCIAPI_INLINE(), PCIAPI_INLINE(), and PCIAPI_INLINE().

PCIAPI_INLINE() [1/7]

__always_inline int PCIAPI_INLINE ( efi , pci_can_probe  )

inlinestatic

Check if PCI bus probing is allowed.

Parameters

pci	PCI device

Return values

ok	Bus probing is allowed

Definition at line 43 of file efi_pci_api.h.

                                                                         {
        return 0;
}

References __unused, and pci_can_probe().

PCIAPI_INLINE() [2/7]

__always_inline int PCIAPI_INLINE ( efi , pci_read_config_byte  )

inlinestatic

Read byte from PCI configuration space via EFI.

Parameters

pci	PCI device
where	Location within PCI configuration space
value	Value read

Return values

rc	Return status code

References pci_read_config_byte().

efipci_read() [2/4]

return efipci_read	(	pci	,
		EFIPCI_LOCATION(where, EFIPCI_WIDTH_BYTE)	,
		value	)

References EFIPCI_LOCATION, EFIPCI_WIDTH_BYTE, value, and where.

PCIAPI_INLINE() [3/7]

__always_inline int PCIAPI_INLINE ( efi , pci_read_config_word  )

inlinestatic

Read word from PCI configuration space via EFI.

Parameters

pci	PCI device
where	Location within PCI configuration space
value	Value read

Return values

rc	Return status code

References pci_read_config_word(), value, and where.

efipci_read() [3/4]

return efipci_read	(	pci	,
		EFIPCI_LOCATION(where, EFIPCI_WIDTH_WORD)	,
		value	)

References EFIPCI_LOCATION, EFIPCI_WIDTH_WORD, value, and where.

PCIAPI_INLINE() [4/7]

__always_inline int PCIAPI_INLINE ( efi , pci_read_config_dword  )

inlinestatic

Read dword from PCI configuration space via EFI.

Parameters

pci	PCI device
where	Location within PCI configuration space
value	Value read

Return values

rc	Return status code

References pci_read_config_dword(), value, and where.

efipci_read() [4/4]

return efipci_read	(	pci	,
		EFIPCI_LOCATION(where, EFIPCI_WIDTH_DWORD)	,
		value	)

References EFIPCI_LOCATION, EFIPCI_WIDTH_DWORD, value, and where.

PCIAPI_INLINE() [5/7]

__always_inline int PCIAPI_INLINE ( efi , pci_write_config_byte  )

inlinestatic

Write byte to PCI configuration space via EFI.

Parameters

pci	PCI device
where	Location within PCI configuration space
value	Value to be written

Return values

rc	Return status code

References EFIPCI_LOCATION, EFIPCI_WIDTH_BYTE, efipci_write(), pci_write_config_byte(), value, and where.

PCIAPI_INLINE() [6/7]

__always_inline int PCIAPI_INLINE ( efi , pci_write_config_word  )

inlinestatic

Write word to PCI configuration space via EFI.

Parameters

pci	PCI device
where	Location within PCI configuration space
value	Value to be written

Return values

rc	Return status code

References EFIPCI_LOCATION, EFIPCI_WIDTH_WORD, efipci_write(), pci_write_config_word(), value, and where.

PCIAPI_INLINE() [7/7]

__always_inline int PCIAPI_INLINE ( efi , pci_write_config_dword  )

inlinestatic

Write dword to PCI configuration space via EFI.

Parameters

pci	PCI device
where	Location within PCI configuration space
value	Value to be written

Return values

rc	Return status code

References EFIPCI_LOCATION, EFIPCI_WIDTH_DWORD, efipci_write(), pci_write_config_dword(), value, and where.

Variable Documentation

where

__always_inline int unsigned int where

Definition at line 57 of file efi_pci_api.h.

value

__always_inline int unsigned int uint32_t value

Initial value:

{
        *value = 0xff

Definition at line 58 of file efi_pci_api.h.