Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Write AXI Master Mapping Status Register for Fixed Virtual ID 4 - vid4wr_s

Description

The Write AXI Master Mapping Status Register contains the configured USER, ADDR page, and ID signals mapping values for particular transaction with 12-bit ID which locks the fixed 3-bit virtual ID.

Register Layout

Bits Access Reset Description
[3:0] ??? 0x0 UNDEFINED
[8:4] R Unknown AWUSER value to SCU (Status)
[11:9] ??? 0x0 UNDEFINED
[13:12] R Unknown AWADDR 1GB Page Decoder (Status)
[15:14] ??? 0x0 UNDEFINED
[27:16] R Unknown Remap Master ID (Status)
[30:28] ??? 0x0 UNDEFINED
[31] R Unknown Force Mapping (Status)

Field : AWUSER value to SCU (Status) - user

This value is propagated to SCU as AWUSERS.

Field Access Macros:

#define ALT_ACPIDMAP_VID4WR_S_USER_LSB   4
 
#define ALT_ACPIDMAP_VID4WR_S_USER_MSB   8
 
#define ALT_ACPIDMAP_VID4WR_S_USER_WIDTH   5
 
#define ALT_ACPIDMAP_VID4WR_S_USER_SET_MSK   0x000001f0
 
#define ALT_ACPIDMAP_VID4WR_S_USER_CLR_MSK   0xfffffe0f
 
#define ALT_ACPIDMAP_VID4WR_S_USER_RESET   0x0
 
#define ALT_ACPIDMAP_VID4WR_S_USER_GET(value)   (((value) & 0x000001f0) >> 4)
 
#define ALT_ACPIDMAP_VID4WR_S_USER_SET(value)   (((value) << 4) & 0x000001f0)
 

Field : AWADDR 1GB Page Decoder (Status) - page

AWADDR remap to 1st, 2nd, 3rd, or 4th 1GB memory region.

Field Access Macros:

#define ALT_ACPIDMAP_VID4WR_S_PAGE_LSB   12
 
#define ALT_ACPIDMAP_VID4WR_S_PAGE_MSB   13
 
#define ALT_ACPIDMAP_VID4WR_S_PAGE_WIDTH   2
 
#define ALT_ACPIDMAP_VID4WR_S_PAGE_SET_MSK   0x00003000
 
#define ALT_ACPIDMAP_VID4WR_S_PAGE_CLR_MSK   0xffffcfff
 
#define ALT_ACPIDMAP_VID4WR_S_PAGE_RESET   0x0
 
#define ALT_ACPIDMAP_VID4WR_S_PAGE_GET(value)   (((value) & 0x00003000) >> 12)
 
#define ALT_ACPIDMAP_VID4WR_S_PAGE_SET(value)   (((value) << 12) & 0x00003000)
 

Field : Remap Master ID (Status) - mid

The 12-bit ID of the master to remap to 3-bit virtual ID N, where N is the 3-bit ID to use.

Field Access Macros:

#define ALT_ACPIDMAP_VID4WR_S_MID_LSB   16
 
#define ALT_ACPIDMAP_VID4WR_S_MID_MSB   27
 
#define ALT_ACPIDMAP_VID4WR_S_MID_WIDTH   12
 
#define ALT_ACPIDMAP_VID4WR_S_MID_SET_MSK   0x0fff0000
 
#define ALT_ACPIDMAP_VID4WR_S_MID_CLR_MSK   0xf000ffff
 
#define ALT_ACPIDMAP_VID4WR_S_MID_RESET   0x0
 
#define ALT_ACPIDMAP_VID4WR_S_MID_GET(value)   (((value) & 0x0fff0000) >> 16)
 
#define ALT_ACPIDMAP_VID4WR_S_MID_SET(value)   (((value) << 16) & 0x0fff0000)
 

Field : Force Mapping (Status) - force

Set to 1 to force the mapping between the 12-bit ID and 3-bit virtual ID N. Set to 0 to allow the 3-bit ID N to be dynamically allocated.

Field Access Macros:

#define ALT_ACPIDMAP_VID4WR_S_FORCE_LSB   31
 
#define ALT_ACPIDMAP_VID4WR_S_FORCE_MSB   31
 
#define ALT_ACPIDMAP_VID4WR_S_FORCE_WIDTH   1
 
#define ALT_ACPIDMAP_VID4WR_S_FORCE_SET_MSK   0x80000000
 
#define ALT_ACPIDMAP_VID4WR_S_FORCE_CLR_MSK   0x7fffffff
 
#define ALT_ACPIDMAP_VID4WR_S_FORCE_RESET   0x0
 
#define ALT_ACPIDMAP_VID4WR_S_FORCE_GET(value)   (((value) & 0x80000000) >> 31)
 
#define ALT_ACPIDMAP_VID4WR_S_FORCE_SET(value)   (((value) << 31) & 0x80000000)
 

Data Structures

struct  ALT_ACPIDMAP_VID4WR_S_s
 

Macros

#define ALT_ACPIDMAP_VID4WR_S_OFST   0x44
 

Typedefs

typedef struct
ALT_ACPIDMAP_VID4WR_S_s 
ALT_ACPIDMAP_VID4WR_S_t
 

Data Structure Documentation

struct ALT_ACPIDMAP_VID4WR_S_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_ACPIDMAP_VID4WR_S.

Data Fields
uint32_t __pad0__: 4 UNDEFINED
const uint32_t user: 5 AWUSER value to SCU (Status)
uint32_t __pad1__: 3 UNDEFINED
const uint32_t page: 2 AWADDR 1GB Page Decoder (Status)
uint32_t __pad2__: 2 UNDEFINED
const uint32_t mid: 12 Remap Master ID (Status)
uint32_t __pad3__: 3 UNDEFINED
const uint32_t force: 1 Force Mapping (Status)

Macro Definitions

#define ALT_ACPIDMAP_VID4WR_S_USER_LSB   4

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

#define ALT_ACPIDMAP_VID4WR_S_USER_MSB   8

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

#define ALT_ACPIDMAP_VID4WR_S_USER_WIDTH   5

The width in bits of the ALT_ACPIDMAP_VID4WR_S_USER register field.

#define ALT_ACPIDMAP_VID4WR_S_USER_SET_MSK   0x000001f0

The mask used to set the ALT_ACPIDMAP_VID4WR_S_USER register field value.

#define ALT_ACPIDMAP_VID4WR_S_USER_CLR_MSK   0xfffffe0f

The mask used to clear the ALT_ACPIDMAP_VID4WR_S_USER register field value.

#define ALT_ACPIDMAP_VID4WR_S_USER_RESET   0x0

The reset value of the ALT_ACPIDMAP_VID4WR_S_USER register field is UNKNOWN.

#define ALT_ACPIDMAP_VID4WR_S_USER_GET (   value)    (((value) & 0x000001f0) >> 4)

Extracts the ALT_ACPIDMAP_VID4WR_S_USER field value from a register.

#define ALT_ACPIDMAP_VID4WR_S_USER_SET (   value)    (((value) << 4) & 0x000001f0)

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

#define ALT_ACPIDMAP_VID4WR_S_PAGE_LSB   12

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

#define ALT_ACPIDMAP_VID4WR_S_PAGE_MSB   13

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

#define ALT_ACPIDMAP_VID4WR_S_PAGE_WIDTH   2

The width in bits of the ALT_ACPIDMAP_VID4WR_S_PAGE register field.

#define ALT_ACPIDMAP_VID4WR_S_PAGE_SET_MSK   0x00003000

The mask used to set the ALT_ACPIDMAP_VID4WR_S_PAGE register field value.

#define ALT_ACPIDMAP_VID4WR_S_PAGE_CLR_MSK   0xffffcfff

The mask used to clear the ALT_ACPIDMAP_VID4WR_S_PAGE register field value.

#define ALT_ACPIDMAP_VID4WR_S_PAGE_RESET   0x0

The reset value of the ALT_ACPIDMAP_VID4WR_S_PAGE register field is UNKNOWN.

#define ALT_ACPIDMAP_VID4WR_S_PAGE_GET (   value)    (((value) & 0x00003000) >> 12)

Extracts the ALT_ACPIDMAP_VID4WR_S_PAGE field value from a register.

#define ALT_ACPIDMAP_VID4WR_S_PAGE_SET (   value)    (((value) << 12) & 0x00003000)

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

#define ALT_ACPIDMAP_VID4WR_S_MID_LSB   16

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

#define ALT_ACPIDMAP_VID4WR_S_MID_MSB   27

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

#define ALT_ACPIDMAP_VID4WR_S_MID_WIDTH   12

The width in bits of the ALT_ACPIDMAP_VID4WR_S_MID register field.

#define ALT_ACPIDMAP_VID4WR_S_MID_SET_MSK   0x0fff0000

The mask used to set the ALT_ACPIDMAP_VID4WR_S_MID register field value.

#define ALT_ACPIDMAP_VID4WR_S_MID_CLR_MSK   0xf000ffff

The mask used to clear the ALT_ACPIDMAP_VID4WR_S_MID register field value.

#define ALT_ACPIDMAP_VID4WR_S_MID_RESET   0x0

The reset value of the ALT_ACPIDMAP_VID4WR_S_MID register field is UNKNOWN.

#define ALT_ACPIDMAP_VID4WR_S_MID_GET (   value)    (((value) & 0x0fff0000) >> 16)

Extracts the ALT_ACPIDMAP_VID4WR_S_MID field value from a register.

#define ALT_ACPIDMAP_VID4WR_S_MID_SET (   value)    (((value) << 16) & 0x0fff0000)

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

#define ALT_ACPIDMAP_VID4WR_S_FORCE_LSB   31

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

#define ALT_ACPIDMAP_VID4WR_S_FORCE_MSB   31

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

#define ALT_ACPIDMAP_VID4WR_S_FORCE_WIDTH   1

The width in bits of the ALT_ACPIDMAP_VID4WR_S_FORCE register field.

#define ALT_ACPIDMAP_VID4WR_S_FORCE_SET_MSK   0x80000000

The mask used to set the ALT_ACPIDMAP_VID4WR_S_FORCE register field value.

#define ALT_ACPIDMAP_VID4WR_S_FORCE_CLR_MSK   0x7fffffff

The mask used to clear the ALT_ACPIDMAP_VID4WR_S_FORCE register field value.

#define ALT_ACPIDMAP_VID4WR_S_FORCE_RESET   0x0

The reset value of the ALT_ACPIDMAP_VID4WR_S_FORCE register field is UNKNOWN.

#define ALT_ACPIDMAP_VID4WR_S_FORCE_GET (   value)    (((value) & 0x80000000) >> 31)

Extracts the ALT_ACPIDMAP_VID4WR_S_FORCE field value from a register.

#define ALT_ACPIDMAP_VID4WR_S_FORCE_SET (   value)    (((value) << 31) & 0x80000000)

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

#define ALT_ACPIDMAP_VID4WR_S_OFST   0x44

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

Typedef Documentation

The typedef declaration for register ALT_ACPIDMAP_VID4WR_S.