Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Register 1 (Transmit Poll Demand Register) - Transmit_Poll_Demand

Description

The Transmit Poll Demand register enables the Tx DMA to check whether or not the DMA owns the current descriptor. The Transmit Poll Demand command is given to wake up the Tx DMA if it is in the Suspend mode. The Tx DMA can go into the Suspend mode because of an Underflow error in a transmitted frame or the unavailability of descriptors owned by it. You can give this command anytime and the Tx DMA resets this command when it again starts fetching the current descriptor from host memory.

Register Layout

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

Field : Transmit Poll Demand - tpd

When these bits are written with any value, the DMA reads the current descriptor pointed to by Register 18 (Current Host Transmit Descriptor Register). If that descriptor is not available (owned by the Host), the transmission returns to the Suspend state and the Bit 2 (TU) of Register 5 (Status Register) is asserted. If the descriptor is available, the transmission resumes.

Field Access Macros:

#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_LSB   0
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_MSB   31
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_WIDTH   32
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_SET_MSK   0xffffffff
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_CLR_MSK   0x00000000
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_RESET   0x0
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_GET(value)   (((value) & 0xffffffff) >> 0)
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_SET(value)   (((value) << 0) & 0xffffffff)
 

Data Structures

struct  ALT_EMAC_DMA_TX_POLL_DEMAND_s
 

Macros

#define ALT_EMAC_DMA_TX_POLL_DEMAND_OFST   0x4
 
#define ALT_EMAC_DMA_TX_POLL_DEMAND_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_EMAC_DMA_TX_POLL_DEMAND_OFST))
 

Typedefs

typedef struct
ALT_EMAC_DMA_TX_POLL_DEMAND_s 
ALT_EMAC_DMA_TX_POLL_DEMAND_t
 

Data Structure Documentation

struct ALT_EMAC_DMA_TX_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_TX_POLL_DEMAND.

Data Fields
uint32_t tpd: 32 Transmit Poll Demand

Macro Definitions

#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_LSB   0

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

#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_MSB   31

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

#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_WIDTH   32

The width in bits of the ALT_EMAC_DMA_TX_POLL_DEMAND_TPD register field.

#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_SET_MSK   0xffffffff

The mask used to set the ALT_EMAC_DMA_TX_POLL_DEMAND_TPD register field value.

#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_CLR_MSK   0x00000000

The mask used to clear the ALT_EMAC_DMA_TX_POLL_DEMAND_TPD register field value.

#define ALT_EMAC_DMA_TX_POLL_DEMAND_TPD_RESET   0x0

The reset value of the ALT_EMAC_DMA_TX_POLL_DEMAND_TPD register field.

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

Extracts the ALT_EMAC_DMA_TX_POLL_DEMAND_TPD field value from a register.

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

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

#define ALT_EMAC_DMA_TX_POLL_DEMAND_OFST   0x4

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

#define ALT_EMAC_DMA_TX_POLL_DEMAND_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_EMAC_DMA_TX_POLL_DEMAND_OFST))

The address of the ALT_EMAC_DMA_TX_POLL_DEMAND register.

Typedef Documentation

The typedef declaration for register ALT_EMAC_DMA_TX_POLL_DEMAND.