pcicloud.c File Reference

Cloud VM PCI configuration space access. More...

#include <stdint.h>
#include <string.h>
#include <ipxe/pci.h>
#include <ipxe/pcicloud.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static struct pci_api *	pcicloud_find (uint32_t busdevfn, struct pci_range *range)
	Find PCI configuration space access API for address. More...
static void	pcicloud_discover (uint32_t busdevfn, struct pci_range *range)
	Find next PCI bus:dev.fn address range in system. More...
static struct pci_api *	pcicloud_api (struct pci_device *pci)
	Find configuration space access API for PCI device. More...
static int	pcicloud_can_probe (struct pci_device *pci)
	Check if PCI bus probing is allowed. More...
static int	pcicloud_read_config_byte (struct pci_device *pci, unsigned int where, uint8_t *value)
	Read byte from PCI configuration space. More...
static int	pcicloud_read_config_word (struct pci_device *pci, unsigned int where, uint16_t *value)
	Read 16-bit word from PCI configuration space. More...
static int	pcicloud_read_config_dword (struct pci_device *pci, unsigned int where, uint32_t *value)
	Read 32-bit dword from PCI configuration space. More...
static int	pcicloud_write_config_byte (struct pci_device *pci, unsigned int where, uint8_t value)
	Write byte to PCI configuration space. More...
static int	pcicloud_write_config_word (struct pci_device *pci, unsigned int where, uint16_t value)
	Write 16-bit word to PCI configuration space. More...
static int	pcicloud_write_config_dword (struct pci_device *pci, unsigned int where, uint32_t value)
	Write 32-bit dword to PCI configuration space. More...
static void *	pcicloud_ioremap (struct pci_device *pci, unsigned long bus_addr, size_t len)
	Map PCI bus address as an I/O address. More...
	PROVIDE_PCIAPI (cloud, pci_can_probe, pcicloud_can_probe)
	PROVIDE_PCIAPI (cloud, pci_discover, pcicloud_discover)
	PROVIDE_PCIAPI (cloud, pci_read_config_byte, pcicloud_read_config_byte)
	PROVIDE_PCIAPI (cloud, pci_read_config_word, pcicloud_read_config_word)
	PROVIDE_PCIAPI (cloud, pci_read_config_dword, pcicloud_read_config_dword)
	PROVIDE_PCIAPI (cloud, pci_write_config_byte, pcicloud_write_config_byte)
	PROVIDE_PCIAPI (cloud, pci_write_config_word, pcicloud_write_config_word)
	PROVIDE_PCIAPI (cloud, pci_write_config_dword, pcicloud_write_config_dword)
	PROVIDE_PCIAPI (cloud, pci_ioremap, pcicloud_ioremap)

Variables
struct {
struct pci_range   range
	PCI bus:dev.fn address range. More...
struct pci_api *   api
	API for this bus:dev.fn address. More...
}	pcicloud
	Cached PCI configuration space access API. More...

Detailed Description

Cloud VM PCI configuration space access.

Definition in file pcicloud.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

pcicloud_find()

static struct pci_api* pcicloud_find ( uint32_t  busdevfn, struct pci_range *  range  )

static

Find PCI configuration space access API for address.

Parameters

busdevfn	Starting PCI bus:dev.fn address
range	PCI bus:dev.fn address range to fill in

Return values

api	Configuration space access API, or NULL

Definition at line 52 of file pcicloud.c.

                                                                  {
        struct pci_range candidate;
        struct pci_api *api;
        uint32_t best = 0;
        uint32_t index;
        uint32_t first;
        uint32_t last;

        /* Return empty range on error */
        range->count = 0;

        /* Try discovery via all known APIs */
        for_each_table_entry ( api, PCI_APIS ) {

                /* Discover via this API */
                api->pci_discover ( busdevfn, &candidate );

                /* Check for a matching or new closest allocation */
                index = ( busdevfn - candidate.start );
                if ( ( index < candidate.count ) || ( index > best ) ) {
                        memcpy ( range, &candidate, sizeof ( *range ) );
                        best = index;
                }

                /* Stop if this range contains the target bus:dev.fn address */
                if ( index < candidate.count ) {
                        first = range->start;
                        last = ( range->start + range->count - 1 );
                        DBGC ( &pcicloud, "PCICLOUD [" PCI_FMT "," PCI_FMT ") "
                               "using %s API\n", PCI_SEG ( first ),
                               PCI_BUS ( first ), PCI_SLOT ( first ),
                               PCI_FUNC ( first ), PCI_SEG ( last ),
                               PCI_BUS ( last ), PCI_SLOT ( last ),
                               PCI_FUNC ( last ), api->name );
                        return api;
                }
        }

        return NULL;
}

References api, busdevfn, pci_range::count, DBGC, first, for_each_table_entry, index, memcpy(), pci_api::name, NULL, PCI_APIS, PCI_BUS, pci_api::pci_discover, PCI_FMT, PCI_FUNC, PCI_SEG, PCI_SLOT, pcicloud, range, and pci_range::start.

Referenced by pcicloud_api(), and pcicloud_discover().

pcicloud_discover()

static void pcicloud_discover ( uint32_t  busdevfn, struct pci_range *  range  )

static

Find next PCI bus:dev.fn address range in system.

Parameters

busdevfn	Starting PCI bus:dev.fn address
range	PCI bus:dev.fn address range to fill in

Definition at line 100 of file pcicloud.c.

                                                                             {

        /* Find new range, if any */
        pcicloud_find ( busdevfn, range );
}

References busdevfn, pcicloud_find(), and range.

pcicloud_api()

static struct pci_api* pcicloud_api ( struct pci_device *  pci )

static

Find configuration space access API for PCI device.

Parameters

pci	PCI device

Return values

api	Configuration space access API

Definition at line 112 of file pcicloud.c.

                                                                {
        struct pci_range *range = &pcicloud.range;
        struct pci_api *api;
        uint32_t first;
        uint32_t last;

        /* Reuse cached API if applicable */
        if ( ( pci->busdevfn - range->start ) < range->count )
                return pcicloud.api;

        /* Find highest priority API claiming this range */
        api = pcicloud_find ( pci->busdevfn, range );

        /* Fall back to lowest priority API for any unclaimed gaps in ranges */
        if ( ! api ) {
                api = ( table_end ( PCI_APIS ) - 1 );
                range->count = ( range->start - pci->busdevfn );
                range->start = pci->busdevfn;
                first = range->start;
                last = ( range->start + range->count - 1 );
                DBGC ( &pcicloud, "PCICLOUD [" PCI_FMT "," PCI_FMT ") falling "
                       "back to %s API\n", PCI_SEG ( first ),
                       PCI_BUS ( first ), PCI_SLOT ( first ),
                       PCI_FUNC ( first ), PCI_SEG ( last ), PCI_BUS ( last ),
                       PCI_SLOT ( last ),  PCI_FUNC ( last ), api->name );
        }

        /* Cache API for this range */
        pcicloud.api = api;

        return api;
}

References api, pci_device::busdevfn, pci_range::count, DBGC, first, pci_api::name, PCI_APIS, PCI_BUS, PCI_FMT, PCI_FUNC, PCI_SEG, PCI_SLOT, pcicloud, pcicloud_find(), range, pci_range::start, and table_end.

Referenced by pcicloud_can_probe(), pcicloud_ioremap(), pcicloud_read_config_byte(), pcicloud_read_config_dword(), pcicloud_read_config_word(), pcicloud_write_config_byte(), pcicloud_write_config_dword(), and pcicloud_write_config_word().

pcicloud_can_probe()

static int pcicloud_can_probe ( struct pci_device *  pci )

static

Check if PCI bus probing is allowed.

Parameters

pci	PCI device

Return values

ok	Bus probing is allowed

Definition at line 151 of file pcicloud.c.

                                                         {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_can_probe ( pci );
}

References api, pci_api::pci_can_probe, and pcicloud_api().

pcicloud_read_config_byte()

static int pcicloud_read_config_byte ( struct pci_device *  pci, unsigned int  where, uint8_t *  value  )

static

Read byte from PCI configuration space.

Parameters

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

Return values

rc	Return status code

Definition at line 165 of file pcicloud.c.

                                                                            {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_read_config_byte ( pci, where, value );
}

References api, pci_api::pci_read_config_byte, pcicloud_api(), value, and where.

pcicloud_read_config_word()

static int pcicloud_read_config_word ( struct pci_device *  pci, unsigned int  where, uint16_t *  value  )

static

Read 16-bit word from PCI configuration space.

Parameters

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

Return values

rc	Return status code

Definition at line 180 of file pcicloud.c.

                                                                             {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_read_config_word ( pci, where, value );
}

References api, pci_api::pci_read_config_word, pcicloud_api(), value, and where.

pcicloud_read_config_dword()

static int pcicloud_read_config_dword ( struct pci_device *  pci, unsigned int  where, uint32_t *  value  )

static

Read 32-bit dword from PCI configuration space.

Parameters

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

Return values

rc	Return status code

Definition at line 195 of file pcicloud.c.

                                                                              {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_read_config_dword ( pci, where, value );
}

References api, pci_api::pci_read_config_dword, pcicloud_api(), value, and where.

pcicloud_write_config_byte()

static int pcicloud_write_config_byte ( struct pci_device *  pci, unsigned int  where, uint8_t  value  )

static

Write byte to PCI configuration space.

Parameters

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

Return values

rc	Return status code

Definition at line 210 of file pcicloud.c.

                                                                            {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_write_config_byte ( pci, where, value );
}

References api, pci_api::pci_write_config_byte, pcicloud_api(), value, and where.

pcicloud_write_config_word()

static int pcicloud_write_config_word ( struct pci_device *  pci, unsigned int  where, uint16_t  value  )

static

Write 16-bit word to PCI configuration space.

Parameters

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

Return values

rc	Return status code

Definition at line 225 of file pcicloud.c.

                                                                             {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_write_config_word ( pci, where, value );
}

References api, pci_api::pci_write_config_word, pcicloud_api(), value, and where.

pcicloud_write_config_dword()

static int pcicloud_write_config_dword ( struct pci_device *  pci, unsigned int  where, uint32_t  value  )

static

Write 32-bit dword to PCI configuration space.

Parameters

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

Return values

rc	Return status code

Definition at line 240 of file pcicloud.c.

                                                                              {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_write_config_dword ( pci, where, value );
}

References api, pci_api::pci_write_config_dword, pcicloud_api(), value, and where.

pcicloud_ioremap()

static void* pcicloud_ioremap ( struct pci_device *  pci, unsigned long  bus_addr, size_t  len  )

static

Map PCI bus address as an I/O address.

Parameters

bus_addr	PCI bus address
len	Length of region

Return values

io_addr

I/O address, or NULL on error

Definition at line 254 of file pcicloud.c.

                                                                      {
        struct pci_api *api = pcicloud_api ( pci );

        return api->pci_ioremap ( pci, bus_addr, len );
}

References api, bus_addr, len, pci_api::pci_ioremap, and pcicloud_api().

PROVIDE_PCIAPI() [1/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_can_probe	,
		pcicloud_can_probe
	)

PROVIDE_PCIAPI() [2/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_discover	,
		pcicloud_discover
	)

PROVIDE_PCIAPI() [3/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_read_config_byte	,
		pcicloud_read_config_byte
	)

PROVIDE_PCIAPI() [4/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_read_config_word	,
		pcicloud_read_config_word
	)

PROVIDE_PCIAPI() [5/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_read_config_dword	,
		pcicloud_read_config_dword
	)

PROVIDE_PCIAPI() [6/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_write_config_byte	,
		pcicloud_write_config_byte
	)

PROVIDE_PCIAPI() [7/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_write_config_word	,
		pcicloud_write_config_word
	)

PROVIDE_PCIAPI() [8/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_write_config_dword	,
		pcicloud_write_config_dword
	)

PROVIDE_PCIAPI() [9/9]

PROVIDE_PCIAPI	(	cloud	,
		pci_ioremap	,
		pcicloud_ioremap
	)

Variable Documentation

range

struct pci_range range

PCI bus:dev.fn address range.

Definition at line 40 of file pcicloud.c.

Referenced by ar9003_hw_spur_mitigate_mrc_cck(), ar9003_hw_spur_mitigate_ofdm(), ecam_discover(), ecam_find(), efipci_discover(), efipci_discover_any(), efipci_discover_one(), http_block_read(), http_open(), pci_find_next(), pcibios_discover(), pcicloud_api(), pcicloud_discover(), pcicloud_find(), peerblk_raw_open(), vmbus_establish_gpadl(), and vmbus_send_data().

api

struct pci_api* api

API for this bus:dev.fn address.

Definition at line 42 of file pcicloud.c.

Referenced by ice_admin_version(), intelxl_admin_version(), intelxlvf_admin_version(), pcicloud_api(), pcicloud_can_probe(), pcicloud_find(), pcicloud_ioremap(), pcicloud_read_config_byte(), pcicloud_read_config_dword(), pcicloud_read_config_word(), pcicloud_write_config_byte(), pcicloud_write_config_dword(), and pcicloud_write_config_word().

pcicloud

struct { ... } pcicloud

Cached PCI configuration space access API.

Referenced by pcicloud_api(), and pcicloud_find().