iPXE
Macros | Functions | Variables
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
pciPCI device
locationOffset and length within PCI configuration space
valueValue read
Return values
rcReturn status code

Definition at line 196 of file ecam.c.

196  {
197  unsigned int where = ECAM_WHERE ( location );
198  unsigned int len = ECAM_LEN ( location );
199  unsigned int index;
200  void *addr;
201  int rc;
202 
203  /* Return all-ones on error */
204  memset ( value, 0xff, len );
205 
206  /* Access configuration space */
207  if ( ( rc = ecam_access ( pci ) ) != 0 )
208  return rc;
209 
210  /* Read from address */
211  index = ( pci->busdevfn - ecam.range.start );
212  addr = ( ecam.regs + ( index * ECAM_SIZE ) + where );
213  switch ( len ) {
214  case 4:
215  *( ( uint32_t *) value ) = readl ( addr );
216  break;
217  case 2:
218  *( ( uint16_t *) value ) = readw ( addr );
219  break;
220  case 1:
221  *( ( uint8_t *) value ) = readb ( addr );
222  break;
223  default:
224  assert ( 0 );
225  }
226 
227  return 0;
228 }
ecam_access
static int ecam_access(struct pci_device *pci)
Access configuration space for PCI device.
Definition: ecam.c:123
pci_range::start
uint32_t start
Starting bus:dev.fn address.
Definition: pci_io.h:23
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
uint16_t
unsigned short uint16_t
Definition: stdint.h:11
readb
uint8_t readb(volatile uint8_t *io_addr)
Read byte from memory-mapped device.
ecam_mapping::range
struct pci_range range
PCI bus:dev.fn address range.
Definition: ecam.h:50
readw
uint16_t readw(volatile uint16_t *io_addr)
Read 16-bit word from memory-mapped device.
readl
uint32_t readl(volatile uint32_t *io_addr)
Read 32-bit dword from memory-mapped device.
index
long index
Definition: bigint.h:61
ecam
static struct ecam_mapping ecam
Cached mapped ECAM allocation.
Definition: ecam.c:37
assert
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
value
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
ecam_mapping::regs
void * regs
MMIO base address.
Definition: ecam.h:52
uint8_t
unsigned char uint8_t
Definition: stdint.h:10
ECAM_LEN
#define ECAM_LEN(location)
Extract length from ECAM location.
Definition: ecam_io.h:29
uint32_t
unsigned int uint32_t
Definition: stdint.h:12
pci_device::busdevfn
uint32_t busdevfn
Segment, bus, device, and function (bus:dev.fn) number.
Definition: pci.h:233
ECAM_SIZE
#define ECAM_SIZE
Enhanced Configuration Access Mechanism per-device size.
Definition: ecam.h:16
addr
u32 addr
Definition: sky2.h:8
where
static __always_inline int unsigned int where
Definition: pcibios.h:55
ECAM_WHERE
#define ECAM_WHERE(location)
Extract offset from ECAM location.
Definition: ecam_io.h:26
len
uint32_t len
Length.
Definition: ena.h:14
memset
void * memset(void *dest, int character, size_t len) __nonnull

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.

Referenced by ecam_write().

◆ ecam_write()

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

Write to PCI configuration space.

Parameters
pciPCI device
locationOffset and length within PCI configuration space
valueValue to write
Return values
rcReturn status code

Definition at line 238 of file ecam.c.

239  {
240  unsigned int where = ECAM_WHERE ( location );
241  unsigned int len = ECAM_LEN ( location );
242  unsigned int index;
243  void *addr;
244  int rc;
245 
246  /* Access configuration space */
247  if ( ( rc = ecam_access ( pci ) ) != 0 )
248  return rc;
249 
250  /* Write to address */
251  index = ( pci->busdevfn - ecam.range.start );
252  addr = ( ecam.regs + ( index * ECAM_SIZE ) + where );
253  switch ( len ) {
254  case 4:
255  writel ( value, addr );
256  break;
257  case 2:
258  writew ( value, addr );
259  break;
260  case 1:
261  writeb ( value, addr );
262  break;
263  default:
264  assert ( 0 );
265  }
266 
267  /* Read from address, to guarantee completion of the write
268  *
269  * PCIe configuration space registers may not have read side
270  * effects. Reading back is therefore always safe to do, and
271  * guarantees that the write has reached the device.
272  */
273  mb();
274  ecam_read ( pci, location, &value );
275 
276  return 0;
277 }
ecam_access
static int ecam_access(struct pci_device *pci)
Access configuration space for PCI device.
Definition: ecam.c:123
pci_range::start
uint32_t start
Starting bus:dev.fn address.
Definition: pci_io.h:23
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
ecam_mapping::range
struct pci_range range
PCI bus:dev.fn address range.
Definition: ecam.h:50
index
long index
Definition: bigint.h:61
ecam
static struct ecam_mapping ecam
Cached mapped ECAM allocation.
Definition: ecam.c:37
writeb
void writeb(uint8_t data, volatile uint8_t *io_addr)
Write byte to memory-mapped device.
assert
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
value
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
ecam_read
int ecam_read(struct pci_device *pci, unsigned int location, void *value)
Read from PCI configuration space.
Definition: ecam.c:196
writel
void writel(uint32_t data, volatile uint32_t *io_addr)
Write 32-bit dword to memory-mapped device.
ecam_mapping::regs
void * regs
MMIO base address.
Definition: ecam.h:52
ECAM_LEN
#define ECAM_LEN(location)
Extract length from ECAM location.
Definition: ecam_io.h:29
pci_device::busdevfn
uint32_t busdevfn
Segment, bus, device, and function (bus:dev.fn) number.
Definition: pci.h:233
writew
#define writew
Definition: w89c840.c:159
ECAM_SIZE
#define ECAM_SIZE
Enhanced Configuration Access Mechanism per-device size.
Definition: ecam.h:16
addr
u32 addr
Definition: sky2.h:8
where
static __always_inline int unsigned int where
Definition: pcibios.h:55
mb
void mb(void)
Memory barrier.
ECAM_WHERE
#define ECAM_WHERE(location)
Extract offset from ECAM location.
Definition: ecam_io.h:26
len
uint32_t len
Length.
Definition: ena.h:14

References addr, assert(), pci_device::busdevfn, ecam, ecam_access(), ECAM_LEN, ecam_read(), ECAM_SIZE, ECAM_WHERE, index, len, mb(), 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
pciPCI device
whereLocation within PCI configuration space
valueValue read
Return values
rcReturn 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
pciPCI device
whereLocation within PCI configuration space
valueValue read
Return values
rcReturn 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
pciPCI device
whereLocation within PCI configuration space
valueValue read
Return values
rcReturn 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
pciPCI device
whereLocation within PCI configuration space
valueValue to be written
Return values
rcReturn 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
pciPCI device
whereLocation within PCI configuration space
valueValue to be written
Return values
rcReturn 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
pciPCI device
whereLocation within PCI configuration space
valueValue to be written
Return values
rcReturn 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_addrPCI bus address
lenLength of region
Return values
io_addrI/O address, or NULL on error

Variable Documentation

◆ where

__always_inline int unsigned int where

Definition at line 46 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 )
where
static __always_inline int unsigned int where
Definition: ecam_io.h:46
value
static __always_inline int unsigned int uint8_t * value
Definition: ecam_io.h:47
ECAM_LOC
#define ECAM_LOC(where, len)
Construct ECAM location.
Definition: ecam_io.h:23
ecam_read
int ecam_read(struct pci_device *pci, unsigned int location, void *value)
Read from PCI configuration space.
Definition: ecam.c:196

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.

◆ len

__always_inline void unsigned long size_t len
Initial value:
{
return ioremap ( bus_addr, len )
len
static __always_inline void unsigned long size_t len
Definition: ecam_io.h:135
ioremap
void * ioremap(unsigned long bus_addr, size_t len)
Map bus address as an I/O address.
bus_addr
static __always_inline void unsigned long bus_addr
Definition: ecam_io.h:135

Definition at line 135 of file ecam_io.h.

Generated by   doxygen 1.8.15