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)
	Construct ECAM location.
#define	ECAM_WHERE(location)
	Extract offset from ECAM location.
#define	ECAM_LEN(location)
	Extract length from ECAM location.

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

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 18 of file ecam_io.h.

ECAM_LOC

#define ECAM_LOC	(		where,
			len )

Value:

( ( (len) << 16 ) | where )

Construct ECAM location.

Definition at line 24 of file ecam_io.h.

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

ECAM_WHERE

#define ECAM_WHERE

(

location

)

Value:

( (location) & 0xffff )

Extract offset from ECAM location.

Definition at line 27 of file ecam_io.h.

Referenced by ecam_read(), and ecam_write().

ECAM_LEN

#define ECAM_LEN

(

location

)

Value:

( (location) >> 16 )

Extract length from ECAM location.

Definition at line 30 of file ecam_io.h.

Referenced by ecam_read(), and ecam_write().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ecam_read()

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

extern

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 190 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(), rc, readb, readl, readw, value, and where.

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

ecam_write()

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

extern

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 232 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;
 
        /* Write to 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 );
        }
 
        /* Read from address, to guarantee completion of the write
         *
         * PCIe configuration space registers may not have read side
         * effects.  Reading back is therefore always safe to do, and
         * guarantees that the write has reached the device.
         */
        mb();
        ecam_read ( pci, location, &value );
 
        return 0;
}

References addr, assert, pci_device::busdevfn, ecam, ecam_access(), ECAM_LEN, ecam_read(), ECAM_SIZE, ECAM_WHERE, index, len, mb(), rc, value, where, writeb, writel, and writew.

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

PCIAPI_INLINE() [1/8]

__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

References ecam, and pci_read_config_byte().

PCIAPI_INLINE() [2/8]

__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

References ecam, ECAM_LOC, ecam_read(), pci_read_config_word(), value, and where.

PCIAPI_INLINE() [3/8]

__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

References ecam, ECAM_LOC, ecam_read(), pci_read_config_dword(), value, and where.

PCIAPI_INLINE() [4/8]

__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

References ecam, ECAM_LOC, ecam_write(), pci_write_config_byte(), value, and where.

PCIAPI_INLINE() [5/8]

__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

References ecam, ECAM_LOC, ecam_write(), pci_write_config_word(), value, and where.

PCIAPI_INLINE() [6/8]

__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

References ecam, ECAM_LOC, ecam_write(), pci_write_config_dword(), value, and where.

PCIAPI_INLINE() [7/8]

__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

References __unused, ecam, and pci_ioremap().

PCIAPI_INLINE() [8/8]

__always_inline int PCIAPI_INLINE ( ecam , 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 147 of file ecam_io.h.

                                                                          {
        return 1;
}

References __unused, ecam, and pci_can_probe().

Variable Documentation

where

__always_inline int unsigned int where

Definition at line 47 of file ecam_io.h.

value

__always_inline int unsigned int uint32_t value

Initial value:

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

Definition at line 48 of file ecam_io.h.

bus_addr

__always_inline void unsigned long bus_addr

Definition at line 136 of file ecam_io.h.

len

__always_inline void unsigned long size_t len

Initial value:

{
        return ioremap ( bus_addr, len )

Definition at line 136 of file ecam_io.h.