Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : L4_MP_rate_ad_main_RateAdapter_Rate

Description

Register Layout

Bits Access Reset Description
[9:0] RW 0x100 ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE
[31:10] ??? Unknown UNDEFINED

Field : RATE

The ratio of outgoing to incoming throughput. This value determines what portion of a received packet will be stored before its head is transmitted. An optimal setting avoids transmitting bubbles, while adding no delay to packets. The ratio is expressed as 256 / (ratio - 1). For example, a 3:1 ratio of outgoing to incoming throughput would be indicated by value 0x06E. Note that throughput is the product of clock frequency x data bus width. A value of 0x000 causes the rate adapter to store a packet until either the entire packet is received or the buffer becomes full.

Field Access Macros:

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_LSB   0
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_MSB   9
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_WIDTH   10
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_SET_MSK   0x000003ff
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_CLR_MSK   0xfffffc00
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_RESET   0x100
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_GET(value)   (((value) & 0x000003ff) >> 0)
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_SET(value)   (((value) << 0) & 0x000003ff)
 

Data Structures

struct  ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_s
 

Macros

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RESET   0x00000100
 
#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_OFST   0x8
 

Typedefs

typedef struct
ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_s 
ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_t
 

Data Structure Documentation

struct ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_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_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE.

Data Fields
uint32_t RATE: 10 ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE
uint32_t __pad0__: 22 UNDEFINED

Macro Definitions

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_LSB   0

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

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_MSB   9

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

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_WIDTH   10

The width in bits of the ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE register field.

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_SET_MSK   0x000003ff

The mask used to set the ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE register field value.

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_CLR_MSK   0xfffffc00

The mask used to clear the ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE register field value.

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_RESET   0x100

The reset value of the ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE register field.

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_GET (   value)    (((value) & 0x000003ff) >> 0)

Extracts the ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE field value from a register.

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RATE_SET (   value)    (((value) << 0) & 0x000003ff)

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

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_RESET   0x00000100

The reset value of the ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE register.

#define ALT_NOC_MPU_L4_MP_AD_MAIN_RATE_RATE_OFST   0x8

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

Typedef Documentation