pcimsix.h File Reference

PCI MSI-X interrupts. More...

#include <ipxe/pci.h>

Go to the source code of this file.

Data Structures
struct	pci_msix
	PCI MSI-X capability. More...

Macros
#define	PCI_MSIX_LEN   0x1000
	MSI-X BAR mapped length. More...
#define	PCI_MSIX_VECTOR(n)   ( (n) * 0x10 )
	MSI-X vector offset. More...
#define	PCI_MSIX_ADDRESS_LO   0x0
	MSI-X vector address low 32 bits. More...
#define	PCI_MSIX_ADDRESS_HI   0x4
	MSI-X vector address high 32 bits. More...
#define	PCI_MSIX_DATA   0x8
	MSI-X vector data. More...
#define	PCI_MSIX_CONTROL   0xc
	MSI-X vector control. More...
#define	PCI_MSIX_CONTROL_MASK   0x00000001
	Vector is masked. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	pci_msix_enable (struct pci_device *pci, struct pci_msix *msix)
	Enable MSI-X interrupts. More...
void	pci_msix_disable (struct pci_device *pci, struct pci_msix *msix)
	Disable MSI-X interrupts. More...
void	pci_msix_map (struct pci_msix *msix, unsigned int vector, physaddr_t address, uint32_t data)
	Map MSI-X interrupt vector. More...
void	pci_msix_control (struct pci_msix *msix, unsigned int vector, uint32_t mask)
	Control MSI-X interrupt vector. More...
void	pci_msix_dump (struct pci_msix *msix, unsigned int vector)
	Dump MSI-X interrupt state (for debugging) More...
static void	pci_msix_mask (struct pci_msix *msix, unsigned int vector)
	Mask MSI-X interrupt vector. More...
static void	pci_msix_unmask (struct pci_msix *msix, unsigned int vector)
	Unmask MSI-X interrupt vector. More...

Detailed Description

PCI MSI-X interrupts.

Definition in file pcimsix.h.

Macro Definition Documentation

PCI_MSIX_LEN

#define PCI_MSIX_LEN   0x1000

MSI-X BAR mapped length.

Definition at line 16 of file pcimsix.h.

PCI_MSIX_VECTOR

#define PCI_MSIX_VECTOR

(

n

)

( (n) * 0x10 )

MSI-X vector offset.

Definition at line 19 of file pcimsix.h.

PCI_MSIX_ADDRESS_LO

#define PCI_MSIX_ADDRESS_LO   0x0

MSI-X vector address low 32 bits.

Definition at line 22 of file pcimsix.h.

PCI_MSIX_ADDRESS_HI

#define PCI_MSIX_ADDRESS_HI   0x4

MSI-X vector address high 32 bits.

Definition at line 25 of file pcimsix.h.

PCI_MSIX_DATA

#define PCI_MSIX_DATA   0x8

MSI-X vector data.

Definition at line 28 of file pcimsix.h.

PCI_MSIX_CONTROL

#define PCI_MSIX_CONTROL   0xc

MSI-X vector control.

Definition at line 31 of file pcimsix.h.

PCI_MSIX_CONTROL_MASK

#define PCI_MSIX_CONTROL_MASK   0x00000001

Vector is masked.

Definition at line 32 of file pcimsix.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

pci_msix_enable()

int pci_msix_enable	(	struct pci_device *	pci,
		struct pci_msix *	msix
	)

Enable MSI-X interrupts.

Parameters

pci	PCI device
msix	MSI-X capability

Return values

rc	Return status code

Definition at line 137 of file pcimsix.c.

                                                                      {
        uint16_t ctrl;
        physaddr_t msg;
        unsigned int i;
        int rc;

        /* Locate capability */
        msix->cap = pci_find_capability ( pci, PCI_CAP_ID_MSIX );
        if ( ! msix->cap ) {
                DBGC ( msix, "MSI-X %p found no MSI-X capability in "
                       PCI_FMT "\n", msix, PCI_ARGS ( pci ) );
                rc = -ENOENT;
                goto err_cap;
        }

        /* Extract interrupt count */
        pci_read_config_word ( pci, ( msix->cap + PCI_MSIX_CTRL ), &ctrl );
        msix->count = ( PCI_MSIX_CTRL_SIZE ( ctrl ) + 1 );
        DBGC ( msix, "MSI-X %p has %d vectors for " PCI_FMT "\n",
               msix, msix->count, PCI_ARGS ( pci ) );

        /* Map MSI-X table */
        msix->table = pci_msix_ioremap ( pci, msix, PCI_MSIX_DESC_TABLE );
        if ( ! msix->table ) {
                rc = -ENOENT;
                goto err_table;
        }

        /* Map pending bit array */
        msix->pba = pci_msix_ioremap ( pci, msix, PCI_MSIX_DESC_PBA );
        if ( ! msix->pba ) {
                rc = -ENOENT;
                goto err_pba;
        }

        /* Allocate dummy target */
        msix->msg = dma_alloc ( &pci->dma, &msix->map, sizeof ( *msix->msg ),
                                sizeof ( *msix->msg ) );
        if ( ! msix->msg ) {
                rc = -ENOMEM;
                goto err_msg;
        }

        /* Map all interrupts to dummy target by default */
        msg = dma ( &msix->map, msix->msg );
        for ( i = 0 ; i < msix->count ; i++ )
                pci_msix_map ( msix, i, msg, 0 );

        /* Enable MSI-X */
        ctrl &= ~PCI_MSIX_CTRL_MASK;
        ctrl |= PCI_MSIX_CTRL_ENABLE;
        pci_write_config_word ( pci, ( msix->cap + PCI_MSIX_CTRL ), ctrl );

        return 0;

        dma_free ( &msix->map, msix->msg, sizeof ( *msix->msg ) );
 err_msg:
        iounmap ( msix->pba );
 err_pba:
        iounmap ( msix->table );
 err_table:
 err_cap:
        return rc;
}

References pci_msix::cap, pci_msix::count, ctrl, DBGC, pci_device::dma, dma(), dma_alloc(), dma_free(), ENOENT, ENOMEM, iounmap(), pci_msix::map, pci_msix::msg, msg(), pci_msix::pba, PCI_ARGS, PCI_CAP_ID_MSIX, pci_find_capability(), PCI_FMT, PCI_MSIX_CTRL, PCI_MSIX_CTRL_ENABLE, PCI_MSIX_CTRL_MASK, PCI_MSIX_CTRL_SIZE, PCI_MSIX_DESC_PBA, PCI_MSIX_DESC_TABLE, pci_msix_ioremap(), pci_msix_map(), pci_read_config_word(), pci_write_config_word(), rc, and pci_msix::table.

Referenced by gve_probe(), and intelxl_msix_enable().

pci_msix_disable()

void pci_msix_disable	(	struct pci_device *	pci,
		struct pci_msix *	msix
	)

Disable MSI-X interrupts.

Parameters

pci	PCI device
msix	MSI-X capability

Definition at line 208 of file pcimsix.c.

                                                                        {
        uint16_t ctrl;

        /* Disable MSI-X */
        pci_read_config_word ( pci, ( msix->cap + PCI_MSIX_CTRL ), &ctrl );
        ctrl &= ~PCI_MSIX_CTRL_ENABLE;
        pci_write_config_word ( pci, ( msix->cap + PCI_MSIX_CTRL ), ctrl );

        /* Free dummy target */
        dma_free ( &msix->map, msix->msg, sizeof ( *msix->msg ) );

        /* Unmap pending bit array */
        iounmap ( msix->pba );

        /* Unmap MSI-X table */
        iounmap ( msix->table );
}

References pci_msix::cap, ctrl, dma_free(), iounmap(), pci_msix::map, pci_msix::msg, pci_msix::pba, PCI_MSIX_CTRL, PCI_MSIX_CTRL_ENABLE, pci_read_config_word(), pci_write_config_word(), and pci_msix::table.

Referenced by gve_probe(), gve_remove(), intelxl_msix_disable(), and intelxl_msix_enable().

pci_msix_map()

void pci_msix_map	(	struct pci_msix *	msix,
		unsigned int	vector,
		physaddr_t	address,
		uint32_t	data
	)

Map MSI-X interrupt vector.

Parameters

msix	MSI-X capability
vector	MSI-X vector
address	Message address
data	Message data

Definition at line 234 of file pcimsix.c.

                                                        {
        void *base;

        /* Sanity check */
        assert ( vector < msix->count );

        /* Map interrupt vector */
        base = ( msix->table + PCI_MSIX_VECTOR ( vector ) );
        writel ( ( address & 0xffffffffUL ), ( base + PCI_MSIX_ADDRESS_LO ) );
        if ( sizeof ( address ) > sizeof ( uint32_t ) ) {
                writel ( ( ( ( uint64_t ) address ) >> 32 ),
                         ( base + PCI_MSIX_ADDRESS_HI ) );
        } else {
                writel ( 0, ( base + PCI_MSIX_ADDRESS_HI ) );
        }
        writel ( data, ( base + PCI_MSIX_DATA ) );
}

References address, assert(), base, count, data, PCI_MSIX_ADDRESS_HI, PCI_MSIX_ADDRESS_LO, PCI_MSIX_DATA, PCI_MSIX_VECTOR, pci_msix::table, vector, and writel().

Referenced by pci_msix_enable().

pci_msix_control()

void pci_msix_control	(	struct pci_msix *	msix,
		unsigned int	vector,
		uint32_t	mask
	)

Control MSI-X interrupt vector.

Parameters

msix	MSI-X capability
vector	MSI-X vector
mask	Control mask

Definition at line 260 of file pcimsix.c.

                                        {
        void *base;
        uint32_t ctrl;

        /* Mask/unmask interrupt vector */
        base = ( msix->table + PCI_MSIX_VECTOR ( vector ) );
        ctrl = readl ( base + PCI_MSIX_CONTROL );
        ctrl &= ~PCI_MSIX_CONTROL_MASK;
        ctrl |= mask;
        writel ( ctrl, ( base + PCI_MSIX_CONTROL ) );
}

References base, ctrl, PCI_MSIX_CONTROL, PCI_MSIX_CONTROL_MASK, PCI_MSIX_VECTOR, readl(), pci_msix::table, vector, and writel().

Referenced by pci_msix_mask(), and pci_msix_unmask().

pci_msix_dump()

void pci_msix_dump	(	struct pci_msix *	msix,
		unsigned int	vector
	)

Dump MSI-X interrupt state (for debugging)

Parameters

msix	MSI-X capability
vector	MSI-X vector

Definition at line 279 of file pcimsix.c.

                                                                  {
        void *base;
        uint32_t address_hi;
        uint32_t address_lo;
        physaddr_t address;
        uint32_t data;
        uint32_t ctrl;
        uint32_t pba;

        /* Do nothing in non-debug builds */
        if ( ! DBG_LOG )
                return;

        /* Mask/unmask interrupt vector */
        base = ( msix->table + PCI_MSIX_VECTOR ( vector ) );
        address_hi = readl ( base + PCI_MSIX_ADDRESS_HI );
        address_lo = readl ( base + PCI_MSIX_ADDRESS_LO );
        data = readl ( base + PCI_MSIX_DATA );
        ctrl = readl ( base + PCI_MSIX_CONTROL );
        pba = readl ( msix->pba );
        address = ( ( ( ( uint64_t ) address_hi ) << 32 ) | address_lo );
        DBGC ( msix, "MSI-X %p vector %d %#08x => %#08lx%s%s\n",
               msix, vector, data, address,
               ( ( ctrl & PCI_MSIX_CONTROL_MASK ) ? " (masked)" : "" ),
               ( ( pba & ( 1 << vector ) ) ? " (pending)" : "" ) );
}

References address, base, ctrl, data, DBG_LOG, DBGC, pci_msix::pba, PCI_MSIX_ADDRESS_HI, PCI_MSIX_ADDRESS_LO, PCI_MSIX_CONTROL, PCI_MSIX_CONTROL_MASK, PCI_MSIX_DATA, PCI_MSIX_VECTOR, readl(), pci_msix::table, and vector.

pci_msix_mask()

static void pci_msix_mask ( struct pci_msix *  msix, unsigned int  vector  )

inlinestatic

Mask MSI-X interrupt vector.

Parameters

msix	MSI-X capability
vector	MSI-X vector

Definition at line 65 of file pcimsix.h.

                                                             {

        pci_msix_control ( msix, vector, PCI_MSIX_CONTROL_MASK );
}

References pci_msix_control(), PCI_MSIX_CONTROL_MASK, and vector.

Referenced by gve_destroy_queue(), and intelxl_msix_disable().

pci_msix_unmask()

static void pci_msix_unmask ( struct pci_msix *  msix, unsigned int  vector  )

inlinestatic

Unmask MSI-X interrupt vector.

Parameters

msix	MSI-X capability
vector	MSI-X vector

Definition at line 77 of file pcimsix.h.

                                                               {

        pci_msix_control ( msix, vector, 0 );
}

References pci_msix_control(), and vector.

Referenced by gve_create_queue(), and intelxl_msix_enable().