Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Control/Status Word Register - stat

Description

Consist of control bit and status information.

Register Layout

Bits Access Reset Description
[0] ??? 0x0 UNDEFINED
[1] RW 0x0 Reset output to the FPGA JTAG
[2] ??? 0x0 UNDEFINED
[3] R Unknown Ignore
[23:4] ??? 0x0 UNDEFINED
[26:24] R 0x0 Response FIFO Outstanding Byte Count
[27] ??? 0x0 UNDEFINED
[30:28] R 0x0 Command FIFO Outstanding Byte Count
[31] R 0x0 Scan-Chain Engine Active

Field : Reset output to the FPGA JTAG - trst

Specifies the value of the nTRST signal driven to the FPGA JTAG only. The FPGA JTAG scan-chain must be enabled via the EN register to drive the value specified in this field. The nTRST signal is driven with the inverted value of this field.The nTRST signal is active low so, when this bit is set to 1, FPGA JTAG is reset.

The name of this field in ARM documentation is TRST_OUT.

Field Enumeration Values:

Enum Value Description
ALT_SCANMGR_STAT_TRST_E_DONT_RST_FPGA_JTAG 0x0 Don't reset FPGA JTAG.
ALT_SCANMGR_STAT_TRST_E_RST_FPGA_JTAG 0x1 Reset FPGA JTAG. Must have the FPGA JTAG scan-
: chain enabled in the EN register to take effect.

Field Access Macros:

#define ALT_SCANMGR_STAT_TRST_E_DONT_RST_FPGA_JTAG   0x0
 
#define ALT_SCANMGR_STAT_TRST_E_RST_FPGA_JTAG   0x1
 
#define ALT_SCANMGR_STAT_TRST_LSB   1
 
#define ALT_SCANMGR_STAT_TRST_MSB   1
 
#define ALT_SCANMGR_STAT_TRST_WIDTH   1
 
#define ALT_SCANMGR_STAT_TRST_SET_MSK   0x00000002
 
#define ALT_SCANMGR_STAT_TRST_CLR_MSK   0xfffffffd
 
#define ALT_SCANMGR_STAT_TRST_RESET   0x0
 
#define ALT_SCANMGR_STAT_TRST_GET(value)   (((value) & 0x00000002) >> 1)
 
#define ALT_SCANMGR_STAT_TRST_SET(value)   (((value) << 1) & 0x00000002)
 

Field : Ignore - ignore

Ignore this field. Its value is undefined (may be 0 or 1).

The name of this field in ARM documentation is PORTCONNECTED.

Field Access Macros:

#define ALT_SCANMGR_STAT_IGNORE_LSB   3
 
#define ALT_SCANMGR_STAT_IGNORE_MSB   3
 
#define ALT_SCANMGR_STAT_IGNORE_WIDTH   1
 
#define ALT_SCANMGR_STAT_IGNORE_SET_MSK   0x00000008
 
#define ALT_SCANMGR_STAT_IGNORE_CLR_MSK   0xfffffff7
 
#define ALT_SCANMGR_STAT_IGNORE_RESET   0x0
 
#define ALT_SCANMGR_STAT_IGNORE_GET(value)   (((value) & 0x00000008) >> 3)
 
#define ALT_SCANMGR_STAT_IGNORE_SET(value)   (((value) << 3) & 0x00000008)
 

Field : Response FIFO Outstanding Byte Count - rfifocnt

Response FIFO outstanding byte count. Returns the number of bytes of response data available in the Response FIFO.

Field Access Macros:

#define ALT_SCANMGR_STAT_RFIFOCNT_LSB   24
 
#define ALT_SCANMGR_STAT_RFIFOCNT_MSB   26
 
#define ALT_SCANMGR_STAT_RFIFOCNT_WIDTH   3
 
#define ALT_SCANMGR_STAT_RFIFOCNT_SET_MSK   0x07000000
 
#define ALT_SCANMGR_STAT_RFIFOCNT_CLR_MSK   0xf8ffffff
 
#define ALT_SCANMGR_STAT_RFIFOCNT_RESET   0x0
 
#define ALT_SCANMGR_STAT_RFIFOCNT_GET(value)   (((value) & 0x07000000) >> 24)
 
#define ALT_SCANMGR_STAT_RFIFOCNT_SET(value)   (((value) << 24) & 0x07000000)
 

Field : Command FIFO Outstanding Byte Count - wfifocnt

Command FIFO outstanding byte count. Returns the number of command bytes held in the Command FIFO that have yet to be processed by the Scan-Chain Engine.

Field Access Macros:

#define ALT_SCANMGR_STAT_WFIFOCNT_LSB   28
 
#define ALT_SCANMGR_STAT_WFIFOCNT_MSB   30
 
#define ALT_SCANMGR_STAT_WFIFOCNT_WIDTH   3
 
#define ALT_SCANMGR_STAT_WFIFOCNT_SET_MSK   0x70000000
 
#define ALT_SCANMGR_STAT_WFIFOCNT_CLR_MSK   0x8fffffff
 
#define ALT_SCANMGR_STAT_WFIFOCNT_RESET   0x0
 
#define ALT_SCANMGR_STAT_WFIFOCNT_GET(value)   (((value) & 0x70000000) >> 28)
 
#define ALT_SCANMGR_STAT_WFIFOCNT_SET(value)   (((value) << 28) & 0x70000000)
 

Field : Scan-Chain Engine Active - active

Indicates if the Scan-Chain Engine is processing commands from the Command FIFO or not.

The Scan-Chain Engine is only guaranteed to be inactive if both the ACTIVE and WFIFOCNT fields are zero.

The name of this field in ARM documentation is SERACTV.

Field Enumeration Values:

Enum Value Description
ALT_SCANMGR_STAT_ACT_E_POSSIBLY_INACT 0x0 The Scan-Chain Engine may or may not be
: processing commands from the Command FIFO. The
: Scan-Chain Engine is only guaranteed to be
: inactive if both this ACTIVE field and the
: WFIFOCNT fields are both zero.
ALT_SCANMGR_STAT_ACT_E_ACT 0x1 The Scan-Chain Engine is processing commands
: from the Command FIFO.

Field Access Macros:

#define ALT_SCANMGR_STAT_ACT_E_POSSIBLY_INACT   0x0
 
#define ALT_SCANMGR_STAT_ACT_E_ACT   0x1
 
#define ALT_SCANMGR_STAT_ACT_LSB   31
 
#define ALT_SCANMGR_STAT_ACT_MSB   31
 
#define ALT_SCANMGR_STAT_ACT_WIDTH   1
 
#define ALT_SCANMGR_STAT_ACT_SET_MSK   0x80000000
 
#define ALT_SCANMGR_STAT_ACT_CLR_MSK   0x7fffffff
 
#define ALT_SCANMGR_STAT_ACT_RESET   0x0
 
#define ALT_SCANMGR_STAT_ACT_GET(value)   (((value) & 0x80000000) >> 31)
 
#define ALT_SCANMGR_STAT_ACT_SET(value)   (((value) << 31) & 0x80000000)
 

Data Structures

struct  ALT_SCANMGR_STAT_s
 

Macros

#define ALT_SCANMGR_STAT_OFST   0x0
 

Typedefs

typedef struct ALT_SCANMGR_STAT_s ALT_SCANMGR_STAT_t
 

Data Structure Documentation

struct ALT_SCANMGR_STAT_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_SCANMGR_STAT.

Data Fields
uint32_t __pad0__: 1 UNDEFINED
uint32_t trst: 1 Reset output to the FPGA JTAG
uint32_t __pad1__: 1 UNDEFINED
const uint32_t ignore: 1 Ignore
uint32_t __pad2__: 20 UNDEFINED
const uint32_t rfifocnt: 3 Response FIFO Outstanding Byte Count
uint32_t __pad3__: 1 UNDEFINED
const uint32_t wfifocnt: 3 Command FIFO Outstanding Byte Count
const uint32_t active: 1 Scan-Chain Engine Active

Macro Definitions

#define ALT_SCANMGR_STAT_TRST_E_DONT_RST_FPGA_JTAG   0x0

Enumerated value for register field ALT_SCANMGR_STAT_TRST

Don't reset FPGA JTAG.

#define ALT_SCANMGR_STAT_TRST_E_RST_FPGA_JTAG   0x1

Enumerated value for register field ALT_SCANMGR_STAT_TRST

Reset FPGA JTAG. Must have the FPGA JTAG scan-chain enabled in the EN register to take effect.

#define ALT_SCANMGR_STAT_TRST_LSB   1

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

#define ALT_SCANMGR_STAT_TRST_MSB   1

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

#define ALT_SCANMGR_STAT_TRST_WIDTH   1

The width in bits of the ALT_SCANMGR_STAT_TRST register field.

#define ALT_SCANMGR_STAT_TRST_SET_MSK   0x00000002

The mask used to set the ALT_SCANMGR_STAT_TRST register field value.

#define ALT_SCANMGR_STAT_TRST_CLR_MSK   0xfffffffd

The mask used to clear the ALT_SCANMGR_STAT_TRST register field value.

#define ALT_SCANMGR_STAT_TRST_RESET   0x0

The reset value of the ALT_SCANMGR_STAT_TRST register field.

#define ALT_SCANMGR_STAT_TRST_GET (   value)    (((value) & 0x00000002) >> 1)

Extracts the ALT_SCANMGR_STAT_TRST field value from a register.

#define ALT_SCANMGR_STAT_TRST_SET (   value)    (((value) << 1) & 0x00000002)

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

#define ALT_SCANMGR_STAT_IGNORE_LSB   3

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

#define ALT_SCANMGR_STAT_IGNORE_MSB   3

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

#define ALT_SCANMGR_STAT_IGNORE_WIDTH   1

The width in bits of the ALT_SCANMGR_STAT_IGNORE register field.

#define ALT_SCANMGR_STAT_IGNORE_SET_MSK   0x00000008

The mask used to set the ALT_SCANMGR_STAT_IGNORE register field value.

#define ALT_SCANMGR_STAT_IGNORE_CLR_MSK   0xfffffff7

The mask used to clear the ALT_SCANMGR_STAT_IGNORE register field value.

#define ALT_SCANMGR_STAT_IGNORE_RESET   0x0

The reset value of the ALT_SCANMGR_STAT_IGNORE register field is UNKNOWN.

#define ALT_SCANMGR_STAT_IGNORE_GET (   value)    (((value) & 0x00000008) >> 3)

Extracts the ALT_SCANMGR_STAT_IGNORE field value from a register.

#define ALT_SCANMGR_STAT_IGNORE_SET (   value)    (((value) << 3) & 0x00000008)

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

#define ALT_SCANMGR_STAT_RFIFOCNT_LSB   24

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

#define ALT_SCANMGR_STAT_RFIFOCNT_MSB   26

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

#define ALT_SCANMGR_STAT_RFIFOCNT_WIDTH   3

The width in bits of the ALT_SCANMGR_STAT_RFIFOCNT register field.

#define ALT_SCANMGR_STAT_RFIFOCNT_SET_MSK   0x07000000

The mask used to set the ALT_SCANMGR_STAT_RFIFOCNT register field value.

#define ALT_SCANMGR_STAT_RFIFOCNT_CLR_MSK   0xf8ffffff

The mask used to clear the ALT_SCANMGR_STAT_RFIFOCNT register field value.

#define ALT_SCANMGR_STAT_RFIFOCNT_RESET   0x0

The reset value of the ALT_SCANMGR_STAT_RFIFOCNT register field.

#define ALT_SCANMGR_STAT_RFIFOCNT_GET (   value)    (((value) & 0x07000000) >> 24)

Extracts the ALT_SCANMGR_STAT_RFIFOCNT field value from a register.

#define ALT_SCANMGR_STAT_RFIFOCNT_SET (   value)    (((value) << 24) & 0x07000000)

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

#define ALT_SCANMGR_STAT_WFIFOCNT_LSB   28

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

#define ALT_SCANMGR_STAT_WFIFOCNT_MSB   30

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

#define ALT_SCANMGR_STAT_WFIFOCNT_WIDTH   3

The width in bits of the ALT_SCANMGR_STAT_WFIFOCNT register field.

#define ALT_SCANMGR_STAT_WFIFOCNT_SET_MSK   0x70000000

The mask used to set the ALT_SCANMGR_STAT_WFIFOCNT register field value.

#define ALT_SCANMGR_STAT_WFIFOCNT_CLR_MSK   0x8fffffff

The mask used to clear the ALT_SCANMGR_STAT_WFIFOCNT register field value.

#define ALT_SCANMGR_STAT_WFIFOCNT_RESET   0x0

The reset value of the ALT_SCANMGR_STAT_WFIFOCNT register field.

#define ALT_SCANMGR_STAT_WFIFOCNT_GET (   value)    (((value) & 0x70000000) >> 28)

Extracts the ALT_SCANMGR_STAT_WFIFOCNT field value from a register.

#define ALT_SCANMGR_STAT_WFIFOCNT_SET (   value)    (((value) << 28) & 0x70000000)

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

#define ALT_SCANMGR_STAT_ACT_E_POSSIBLY_INACT   0x0

Enumerated value for register field ALT_SCANMGR_STAT_ACT

The Scan-Chain Engine may or may not be processing commands from the Command FIFO. The Scan-Chain Engine is only guaranteed to be inactive if both this ACTIVE field and the WFIFOCNT fields are both zero.

#define ALT_SCANMGR_STAT_ACT_E_ACT   0x1

Enumerated value for register field ALT_SCANMGR_STAT_ACT

The Scan-Chain Engine is processing commands from the Command FIFO.

#define ALT_SCANMGR_STAT_ACT_LSB   31

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

#define ALT_SCANMGR_STAT_ACT_MSB   31

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

#define ALT_SCANMGR_STAT_ACT_WIDTH   1

The width in bits of the ALT_SCANMGR_STAT_ACT register field.

#define ALT_SCANMGR_STAT_ACT_SET_MSK   0x80000000

The mask used to set the ALT_SCANMGR_STAT_ACT register field value.

#define ALT_SCANMGR_STAT_ACT_CLR_MSK   0x7fffffff

The mask used to clear the ALT_SCANMGR_STAT_ACT register field value.

#define ALT_SCANMGR_STAT_ACT_RESET   0x0

The reset value of the ALT_SCANMGR_STAT_ACT register field.

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

Extracts the ALT_SCANMGR_STAT_ACT field value from a register.

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

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

#define ALT_SCANMGR_STAT_OFST   0x0

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

Typedef Documentation

The typedef declaration for register ALT_SCANMGR_STAT.