ecam_io.h File Reference

PCI I/O API for Enhanced Configuration Access Mechanism (ECAM) More...

#include <stdint.h>

Go to the source code of this file.

Macros
#define	PCIAPI_PREFIX_ecam   __ecam_
#define	ECAM_LOC(where, len)   ( ( (len) << 16 ) | where )
	Construct ECAM location. More...
#define	ECAM_WHERE(location)   ( (location) & 0xffff )
	Extract offset from ECAM location. More...
#define	ECAM_LEN(location)   ( (location) >> 16 )
	Extract length from ECAM location. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
int	ecam_read (struct pci_device *pci, unsigned int location, void *value)
	Read from PCI configuration space. More...
int	ecam_write (struct pci_device *pci, unsigned int location, unsigned long value)
	Write to PCI configuration space. More...
static __always_inline int	PCIAPI_INLINE (ecam, pci_read_config_byte)(struct pci_device *pci
	Read byte from PCI configuration space via ECAM. More...
static __always_inline int	PCIAPI_INLINE (ecam, pci_read_config_word)(struct pci_device *pci
	Read word from PCI configuration space via ECAM. More...
static __always_inline int	PCIAPI_INLINE (ecam, pci_read_config_dword)(struct pci_device *pci
	Read dword from PCI configuration space via ECAM. More...
static __always_inline int	PCIAPI_INLINE (ecam, pci_write_config_byte)(struct pci_device *pci
	Write byte to PCI configuration space via ECAM. More...
static __always_inline int	PCIAPI_INLINE (ecam, pci_write_config_word)(struct pci_device *pci
	Write word to PCI configuration space via ECAM. More...
static __always_inline int	PCIAPI_INLINE (ecam, pci_write_config_dword)(struct pci_device *pci
	Write dword to PCI configuration space via ECAM. More...
static __always_inline void *	PCIAPI_INLINE (ecam, pci_ioremap)(struct pci_device *pci __unused
	Map PCI bus address as an I/O address. More...

Variables
static __always_inline int unsigned int	where
static __always_inline int unsigned int uint8_t *	value
static __always_inline void unsigned long	bus_addr
static __always_inline void unsigned long size_t	len

Detailed Description

PCI I/O API for Enhanced Configuration Access Mechanism (ECAM)

Definition in file ecam_io.h.

Macro Definition Documentation

PCIAPI_PREFIX_ecam

#define PCIAPI_PREFIX_ecam   __ecam_

Definition at line 17 of file ecam_io.h.

ECAM_LOC

#define ECAM_LOC	(		where,
			len
	)		( ( (len) << 16 ) | where )

Construct ECAM location.

Definition at line 23 of file ecam_io.h.

ECAM_WHERE

#define ECAM_WHERE

(

location

)

( (location) & 0xffff )

Extract offset from ECAM location.

Definition at line 26 of file ecam_io.h.

ECAM_LEN

#define ECAM_LEN

(

location

)

( (location) >> 16 )

Extract length from ECAM location.

Definition at line 29 of file ecam_io.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

ecam_read()

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

Read from PCI configuration space.

Parameters

pci	PCI device
location	Offset and length within PCI configuration space
value	Value read

Return values

rc	Return status code

Definition at line 184 of file ecam.c.

                                                                             {
        unsigned int where = ECAM_WHERE ( location );
        unsigned int len = ECAM_LEN ( location );
        unsigned int index;
        void *addr;
        int rc;

        /* Return all-ones on error */
        memset ( value, 0xff, len );

        /* Access configuration space */
        if ( ( rc = ecam_access ( pci ) ) != 0 )
                return rc;

        /* Read from address */
        index = ( pci->busdevfn - ecam.range.start );
        addr = ( ecam.regs + ( index * ECAM_SIZE ) + where );
        switch ( len ) {
        case 4:
                *( ( uint32_t *) value ) = readl ( addr );
                break;
        case 2:
                *( ( uint16_t *) value ) = readw ( addr );
                break;
        case 1:
                *( ( uint8_t *) value ) = readb ( addr );
                break;
        default:
                assert ( 0 );
        }

        return 0;
}

References addr, assert(), pci_device::busdevfn, ecam, ecam_access(), ECAM_LEN, ECAM_SIZE, ECAM_WHERE, index, len, memset(), ecam_mapping::range, rc, readb(), readl(), readw(), ecam_mapping::regs, pci_range::start, value, and where.

ecam_write()

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

Write to PCI configuration space.

Parameters

pci	PCI device
location	Offset and length within PCI configuration space
value	Value to write

Return values

rc	Return status code

Definition at line 226 of file ecam.c.

                                       {
        unsigned int where = ECAM_WHERE ( location );
        unsigned int len = ECAM_LEN ( location );
        unsigned int index;
        void *addr;
        int rc;

        /* Access configuration space */
        if ( ( rc = ecam_access ( pci ) ) != 0 )
                return rc;

        /* Read from address */
        index = ( pci->busdevfn - ecam.range.start );
        addr = ( ecam.regs + ( index * ECAM_SIZE ) + where );
        switch ( len ) {
        case 4:
                writel ( value, addr );
                break;
        case 2:
                writew ( value, addr );
                break;
        case 1:
                writeb ( value, addr );
                break;
        default:
                assert ( 0 );
        }

        return 0;
}

References addr, assert(), pci_device::busdevfn, ecam, ecam_access(), ECAM_LEN, ECAM_SIZE, ECAM_WHERE, index, len, ecam_mapping::range, rc, ecam_mapping::regs, pci_range::start, value, where, writeb(), writel(), and writew.

PCIAPI_INLINE() [1/7]

static __always_inline int PCIAPI_INLINE ( ecam  , pci_read_config_byte    )

inlinestatic

Read byte from PCI configuration space via ECAM.

Parameters

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

Return values

rc	Return status code

PCIAPI_INLINE() [2/7]

static __always_inline int PCIAPI_INLINE ( ecam  , pci_read_config_word    )

inlinestatic

Read word from PCI configuration space via ECAM.

Parameters

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

Return values

rc	Return status code

PCIAPI_INLINE() [3/7]

static __always_inline int PCIAPI_INLINE ( ecam  , pci_read_config_dword    )

inlinestatic

Read dword from PCI configuration space via ECAM.

Parameters

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

Return values

rc	Return status code

PCIAPI_INLINE() [4/7]

static __always_inline int PCIAPI_INLINE ( ecam  , pci_write_config_byte    )

inlinestatic

Write byte to PCI configuration space via ECAM.

Parameters

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

Return values

rc	Return status code

PCIAPI_INLINE() [5/7]

static __always_inline int PCIAPI_INLINE ( ecam  , pci_write_config_word    )

inlinestatic

Write word to PCI configuration space via ECAM.

Parameters

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

Return values

rc	Return status code

PCIAPI_INLINE() [6/7]

static __always_inline int PCIAPI_INLINE ( ecam  , pci_write_config_dword    )

inlinestatic

Write dword to PCI configuration space via ECAM.

Parameters

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

Return values

rc	Return status code

PCIAPI_INLINE() [7/7]

static __always_inline void* PCIAPI_INLINE ( ecam  , pci_ioremap    )

inlinestatic

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

Variable Documentation

where

static __always_inline int unsigned int where

Definition at line 46 of file ecam_io.h.

Referenced by ecam_read(), ecam_write(), pcicloud_read_config_byte(), pcicloud_read_config_dword(), pcicloud_read_config_word(), pcicloud_write_config_byte(), pcicloud_write_config_dword(), pcicloud_write_config_word(), and pcidirect_prepare().

value

__always_inline int unsigned int uint32_t value

Initial value:

{
        return ecam_read ( pci, ECAM_LOC ( where, sizeof ( *value ) ), value )

Definition at line 47 of file ecam_io.h.

bus_addr

__always_inline void unsigned long bus_addr

Definition at line 135 of file ecam_io.h.

Referenced by bus_to_virt(), efipci_ioremap(), IOAPI_INLINE(), ioremap_pages(), and pcicloud_ioremap().

len

__always_inline void unsigned long size_t len

Initial value:

{
        return ioremap ( bus_addr, len )

Definition at line 135 of file ecam_io.h.