Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Register 2 (Receive Poll Demand Register) - Receive_Poll_Demand

Description

The Receive Poll Demand register enables the receive DMA to check for new descriptors. This command is used to wake up the Rx DMA from the SUSPEND state. The RxDMA can go into the SUSPEND state only because of the unavailability of descriptors it owns.

Register Layout

Bits Access Reset Description
[31:0] RW 0x0 Receive Poll Demand

Field : Receive Poll Demand - rpd

When these bits are written with any value, the DMA reads the current descriptor pointed to by Register 19 (Current Host Receive Descriptor Register). If that descriptor is not available (owned by the Host), the reception returns to the Suspended state and the Bit 7 (RU) of Register 5 (Status Register) is not asserted. If the descriptor is available, the Rx DMA returns to the active state.

Field Access Macros:

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_LSB   0
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_MSB   31
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_WIDTH   32
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_SET_MSK   0xffffffff
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_CLR_MSK   0x00000000
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_RESET   0x0
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_GET(value)   (((value) & 0xffffffff) >> 0)
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_SET(value)   (((value) << 0) & 0xffffffff)
 

Data Structures

struct  ALT_EMAC_DMA_RX_POLL_DEMAND_s
 

Macros

#define ALT_EMAC_DMA_RX_POLL_DEMAND_OFST   0x8
 
#define ALT_EMAC_DMA_RX_POLL_DEMAND_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_EMAC_DMA_RX_POLL_DEMAND_OFST))
 

Typedefs

typedef struct
ALT_EMAC_DMA_RX_POLL_DEMAND_s 
ALT_EMAC_DMA_RX_POLL_DEMAND_t
 

Data Structure Documentation

struct ALT_EMAC_DMA_RX_POLL_DEMAND_s

WARNING: The C register and register group struct declarations are provided for convenience and illustrative purposes. They should, however, be used with caution as the C language standard provides no guarantees about the alignment or atomicity of device memory accesses. The recommended practice for writing hardware drivers is to use the SoCAL access macros and alt_read_word() and alt_write_word() functions.

The struct declaration for register ALT_EMAC_DMA_RX_POLL_DEMAND.

Data Fields
uint32_t rpd: 32 Receive Poll Demand

Macro Definitions

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_LSB   0

The Least Significant Bit (LSB) position of the ALT_EMAC_DMA_RX_POLL_DEMAND_RPD register field.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_MSB   31

The Most Significant Bit (MSB) position of the ALT_EMAC_DMA_RX_POLL_DEMAND_RPD register field.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_WIDTH   32

The width in bits of the ALT_EMAC_DMA_RX_POLL_DEMAND_RPD register field.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_SET_MSK   0xffffffff

The mask used to set the ALT_EMAC_DMA_RX_POLL_DEMAND_RPD register field value.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_CLR_MSK   0x00000000

The mask used to clear the ALT_EMAC_DMA_RX_POLL_DEMAND_RPD register field value.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_RESET   0x0

The reset value of the ALT_EMAC_DMA_RX_POLL_DEMAND_RPD register field.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_GET (   value)    (((value) & 0xffffffff) >> 0)

Extracts the ALT_EMAC_DMA_RX_POLL_DEMAND_RPD field value from a register.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_RPD_SET (   value)    (((value) << 0) & 0xffffffff)

Produces a ALT_EMAC_DMA_RX_POLL_DEMAND_RPD register field value suitable for setting the register.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_OFST   0x8

The byte offset of the ALT_EMAC_DMA_RX_POLL_DEMAND register from the beginning of the component.

#define ALT_EMAC_DMA_RX_POLL_DEMAND_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_EMAC_DMA_RX_POLL_DEMAND_OFST))

The address of the ALT_EMAC_DMA_RX_POLL_DEMAND register.

Typedef Documentation

The typedef declaration for register ALT_EMAC_DMA_RX_POLL_DEMAND.