iPXE
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
efx_common.h File Reference
#include <stdbool.h>
#include <ipxe/io.h>
#include <ipxe/netdevice.h>
#include "efx_bitfield.h"
#include "mcdi.h"

Go to the source code of this file.

Data Structures

struct  efx_special_buffer
 A buffer table allocation backing a tx dma, rx dma or eventq. More...
 
struct  efx_tx_queue
 A transmit queue. More...
 
struct  efx_rx_queue
 A receive queue. More...
 
struct  efx_ev_queue
 An event queue. More...
 
struct  efx_nic
 Hardware access. More...
 
struct  efx_nic_type
 Efx device type definition. More...
 

Macros

#define __packed   __attribute__((__packed__))
 
#define __force   /*nothing*/
 
#define BUILD_BUG_ON_ZERO(e)   (sizeof(struct{int: -!!(e); }))
 
#define BUILD_BUG_ON(e)   ((void)BUILD_BUG_ON_ZERO(e))
 
#define ARRAY_SIZE(x)   (sizeof(x) / sizeof((x)[0]))
 
#define EFX_BUF_ALIGN   4096
 
#define EFX_RXD_SIZE   512
 
#define EFX_RXD_MASK   (EFX_RXD_SIZE - 1)
 
#define EFX_TXD_SIZE   512
 
#define EFX_TXD_MASK   (EFX_TXD_SIZE - 1)
 
#define EFX_EVQ_SIZE   512
 
#define EFX_EVQ_MASK   (EFX_EVQ_SIZE - 1)
 
#define EFX_NUM_RX_DESC   64
 
#define EFX_NUM_RX_DESC_MASK   (EFX_NUM_RX_DESC - 1)
 
#define EFX_RX_BUF_SIZE   1600
 
#define EFX_STATE_POLLING   1
 
#define EFX_MAC_FRAME_LEN(_mtu)
 
#define efx_writel_table(efx, value, index, reg)   efx_writel(efx, value, (reg) + ((index) * reg##_STEP))
 
#define efx_writel_page(efx, value, index, reg)   efx_writel(efx, value, (reg) + ((index) * 0x2000))
 

Typedefs

typedef uint16_t __le16
 
typedef uint32_t __le32
 
typedef uint64_t __le64
 
typedef efx_qword_t efx_rx_desc_t
 
typedef efx_qword_t efx_tx_desc_t
 
typedef efx_qword_t efx_event_t
 
typedef unsigned long long dma_addr_t
 

Enumerations

enum  efx_revision { EFX_HUNTINGTON }
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
static void _efx_writel (struct efx_nic *efx, uint32_t value, unsigned int reg)
 
static uint32_t _efx_readl (struct efx_nic *efx, unsigned int reg)
 
void efx_writel (struct efx_nic *efx, efx_dword_t *value, unsigned int reg)
 
void efx_readl (struct efx_nic *efx, efx_dword_t *value, unsigned int reg)
 
void efx_probe (struct net_device *netdev, enum efx_revision rev)
 
void efx_remove (struct net_device *netdev)
 

Variables

const struct efx_nic_type hunt_nic_type
 

Macro Definition Documentation

◆ __packed

#define __packed   __attribute__((__packed__))

Definition at line 26 of file efx_common.h.

◆ __force

#define __force   /*nothing*/

Definition at line 27 of file efx_common.h.

◆ BUILD_BUG_ON_ZERO

#define BUILD_BUG_ON_ZERO (   e)    (sizeof(struct{int: -!!(e); }))

Definition at line 33 of file efx_common.h.

◆ BUILD_BUG_ON

#define BUILD_BUG_ON (   e)    ((void)BUILD_BUG_ON_ZERO(e))

Definition at line 34 of file efx_common.h.

◆ ARRAY_SIZE

#define ARRAY_SIZE (   x)    (sizeof(x) / sizeof((x)[0]))

Definition at line 43 of file efx_common.h.

◆ EFX_BUF_ALIGN

#define EFX_BUF_ALIGN   4096

Definition at line 55 of file efx_common.h.

◆ EFX_RXD_SIZE

#define EFX_RXD_SIZE   512

Definition at line 56 of file efx_common.h.

◆ EFX_RXD_MASK

#define EFX_RXD_MASK   (EFX_RXD_SIZE - 1)

Definition at line 57 of file efx_common.h.

◆ EFX_TXD_SIZE

#define EFX_TXD_SIZE   512

Definition at line 58 of file efx_common.h.

◆ EFX_TXD_MASK

#define EFX_TXD_MASK   (EFX_TXD_SIZE - 1)

Definition at line 59 of file efx_common.h.

◆ EFX_EVQ_SIZE

#define EFX_EVQ_SIZE   512

Definition at line 60 of file efx_common.h.

◆ EFX_EVQ_MASK

#define EFX_EVQ_MASK   (EFX_EVQ_SIZE - 1)

Definition at line 61 of file efx_common.h.

◆ EFX_NUM_RX_DESC

#define EFX_NUM_RX_DESC   64

Definition at line 68 of file efx_common.h.

◆ EFX_NUM_RX_DESC_MASK

#define EFX_NUM_RX_DESC_MASK   (EFX_NUM_RX_DESC - 1)

Definition at line 69 of file efx_common.h.

◆ EFX_RX_BUF_SIZE

#define EFX_RX_BUF_SIZE   1600

Definition at line 74 of file efx_common.h.

◆ EFX_STATE_POLLING

#define EFX_STATE_POLLING   1

Definition at line 78 of file efx_common.h.

◆ EFX_MAC_FRAME_LEN

#define EFX_MAC_FRAME_LEN (   _mtu)
Value:
(((_mtu) \
+ /* EtherII already included */ \
+ 4 /* FCS */ \
/* No VLAN supported */ \
+ 16 /* bug16772 */ \
+ 7) & ~7)

Definition at line 190 of file efx_common.h.

◆ efx_writel_table

#define efx_writel_table (   efx,
  value,
  index,
  reg 
)    efx_writel(efx, value, (reg) + ((index) * reg##_STEP))

Definition at line 216 of file efx_common.h.

◆ efx_writel_page

#define efx_writel_page (   efx,
  value,
  index,
  reg 
)    efx_writel(efx, value, (reg) + ((index) * 0x2000))

Definition at line 219 of file efx_common.h.

Typedef Documentation

◆ __le16

typedef uint16_t __le16

Definition at line 29 of file efx_common.h.

◆ __le32

typedef uint32_t __le32

Definition at line 30 of file efx_common.h.

◆ __le64

typedef uint64_t __le64

Definition at line 31 of file efx_common.h.

◆ efx_rx_desc_t

Definition at line 51 of file efx_common.h.

◆ efx_tx_desc_t

Definition at line 52 of file efx_common.h.

◆ efx_event_t

Definition at line 53 of file efx_common.h.

◆ dma_addr_t

typedef unsigned long long dma_addr_t

Definition at line 80 of file efx_common.h.

Enumeration Type Documentation

◆ efx_revision

Enumerator
EFX_HUNTINGTON 

Definition at line 142 of file efx_common.h.

142  {
144 };

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ _efx_writel()

static void _efx_writel ( struct efx_nic efx,
uint32_t  value,
unsigned int  reg 
)
inlinestatic

Definition at line 205 of file efx_common.h.

207 {
208  writel((value), (efx)->membase + (reg));
209 }
void writel(uint32_t data, volatile uint32_t *io_addr)
Write 32-bit dword to memory-mapped device.
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
static unsigned int unsigned int reg
Definition: intel.h:245
void * membase
Memory and IO base.
Definition: efx_common.h:156

References reg, value, and writel().

Referenced by efx_writel(), hunt_mcdi_copyin(), and hunt_probe().

◆ _efx_readl()

static uint32_t _efx_readl ( struct efx_nic efx,
unsigned int  reg 
)
inlinestatic

Definition at line 211 of file efx_common.h.

212 {
213  return readl((efx)->membase + (reg));
214 }
uint32_t readl(volatile uint32_t *io_addr)
Read 32-bit dword from memory-mapped device.
static unsigned int unsigned int reg
Definition: intel.h:245
void * membase
Memory and IO base.
Definition: efx_common.h:156

References readl(), and reg.

Referenced by efx_readl().

◆ efx_writel()

void efx_writel ( struct efx_nic efx,
efx_dword_t value,
unsigned int  reg 
)

Definition at line 48 of file efx_common.c.

49 {
50  DBGCIO(efx, "Writing partial register %x with " EFX_DWORD_FMT "\n",
52  _efx_writel(efx, value->u32[0], reg);
53 }
static void _efx_writel(struct efx_nic *efx, uint32_t value, unsigned int reg)
Definition: efx_common.h:205
#define EFX_DWORD_FMT
Definition: efx_bitfield.h:107
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
static unsigned int unsigned int reg
Definition: intel.h:245
#define EFX_DWORD_VAL(dword)
Definition: efx_bitfield.h:110
#define DBGCIO(...)
Definition: compiler.h:556

References _efx_writel(), DBGCIO, EFX_DWORD_FMT, EFX_DWORD_VAL, reg, and value.

◆ efx_readl()

void efx_readl ( struct efx_nic efx,
efx_dword_t value,
unsigned int  reg 
)

Definition at line 56 of file efx_common.c.

57 {
58  value->u32[0] = _efx_readl(efx, reg);
59  DBGCIO(efx, "Read from register %x, got " EFX_DWORD_FMT "\n",
61 }
#define EFX_DWORD_FMT
Definition: efx_bitfield.h:107
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
static unsigned int unsigned int reg
Definition: intel.h:245
#define EFX_DWORD_VAL(dword)
Definition: efx_bitfield.h:110
#define DBGCIO(...)
Definition: compiler.h:556
static uint32_t _efx_readl(struct efx_nic *efx, unsigned int reg)
Definition: efx_common.h:211

References _efx_readl(), DBGCIO, EFX_DWORD_FMT, EFX_DWORD_VAL, reg, and value.

Referenced by efx_hunt_clear_interrupts().

◆ efx_probe()

void efx_probe ( struct net_device netdev,
enum efx_revision  rev 
)

Definition at line 70 of file efx_common.c.

71 {
72  struct efx_nic *efx = netdev_priv(netdev);
73  struct pci_device *pci = container_of(netdev->dev,
74  struct pci_device, dev);
75  unsigned int reg = PCI_BASE_ADDRESS_0;
76  uint32_t bar_low;
77 
78  efx->netdev = netdev;
79  efx->revision = revision;
80 
81  /* Find the memory bar to use */
82  pci_read_config_dword(pci, reg, &bar_low);
85 
86  efx->mmio_start = pci_bar_start(pci, reg);
87  efx->mmio_len = pci_bar_size(pci, reg);
88  efx->membase = ioremap(efx->mmio_start, efx->mmio_len);
89 
90  DBGCP(efx, "BAR of %lx bytes at phys %lx mapped at %p\n",
91  efx->mmio_len, efx->mmio_start, efx->membase);
92 
93  /* Enable PCI access */
94  adjust_pci_device(pci);
95 }
static void * netdev_priv(struct net_device *netdev)
Get driver private area for this network device.
Definition: netdevice.h:566
Hardware access.
Definition: efx_common.h:147
#define PCI_BASE_ADDRESS_0
Definition: pci.h:61
void adjust_pci_device(struct pci_device *pci)
Enable PCI device.
Definition: pci.c:149
struct device dev
Generic device.
Definition: pci.h:189
unsigned long mmio_len
Definition: efx_common.h:158
#define PCI_BASE_ADDRESS_IO_MASK
I/O BAR mask.
Definition: pci.h:68
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
int pci_read_config_dword(struct pci_device *pci, unsigned int where, uint32_t *value)
Read 32-bit dword from PCI configuration space.
#define PCI_BASE_ADDRESS_2
Definition: pci.h:63
static struct net_device * netdev
Definition: gdbudp.c:52
unsigned long pci_bar_start(struct pci_device *pci, unsigned int reg)
Find the start of a PCI BAR.
Definition: pci.c:96
uint32_t revision
Definition: ib_mad.h:20
unsigned long pci_bar_size(struct pci_device *pci, unsigned int reg)
Find the size of a PCI BAR.
Definition: pciextra.c:90
static unsigned int unsigned int reg
Definition: intel.h:245
A PCI device.
Definition: pci.h:187
enum efx_revision revision
Definition: efx_common.h:149
unsigned int uint32_t
Definition: stdint.h:12
#define PCI_BASE_ADDRESS_SPACE_IO
I/O BAR.
Definition: pci.h:67
struct device * dev
Underlying hardware device.
Definition: netdevice.h:360
void * membase
Memory and IO base.
Definition: efx_common.h:156
unsigned long mmio_start
Definition: efx_common.h:157
#define DBGCP(...)
Definition: compiler.h:539
void * ioremap(unsigned long bus_addr, size_t len)
Map bus address as an I/O address.
struct net_device * netdev
Definition: efx_common.h:148

References adjust_pci_device(), container_of, DBGCP, pci_device::dev, net_device::dev, ioremap(), efx_nic::membase, efx_nic::mmio_len, efx_nic::mmio_start, netdev, efx_nic::netdev, netdev_priv(), pci_bar_size(), pci_bar_start(), PCI_BASE_ADDRESS_0, PCI_BASE_ADDRESS_2, PCI_BASE_ADDRESS_IO_MASK, PCI_BASE_ADDRESS_SPACE_IO, pci_read_config_dword(), reg, revision, and efx_nic::revision.

Referenced by hunt_probe().

◆ efx_remove()

void efx_remove ( struct net_device netdev)

Definition at line 97 of file efx_common.c.

98 {
99  struct efx_nic *efx = netdev_priv(netdev);
100 
101  iounmap(efx->membase);
102  efx->membase = NULL;
103 }
static void * netdev_priv(struct net_device *netdev)
Get driver private area for this network device.
Definition: netdevice.h:566
Hardware access.
Definition: efx_common.h:147
static struct net_device * netdev
Definition: gdbudp.c:52
void * membase
Memory and IO base.
Definition: efx_common.h:156
void iounmap(volatile const void *io_addr)
Unmap I/O address.
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References iounmap(), efx_nic::membase, netdev, netdev_priv(), and NULL.

Referenced by hunt_probe(), and hunt_remove().

Variable Documentation

◆ hunt_nic_type

const struct efx_nic_type hunt_nic_type

Definition at line 1312 of file sfc_hunt.c.

Referenced by hunt_probe().