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

Description

This write one to clear register indicates that the DCLKCNT has counted down to zero. The DCLKCNT is used by software to drive spurious DCLKs to the FPGA. Software will poll this bit after writing DCLKCNT to know when all of the DCLKs have been sent.

Register Layout

Bits Access Reset Description
[0] RW 0x0 DCLK Count Done
[31:1] ??? 0x0 UNDEFINED

Field : DCLK Count Done - dcntdone

This bit is write one to clear. This bit gets set after the DCLKCNT has counted down to zero (transition from 1 to 0).

Field Enumeration Values:

Enum Value Description
ALT_FPGAMGR_DCLKSTAT_DCNTDONE_E_NOTDONE 0x0 DCLKCNT is still counting down.
ALT_FPGAMGR_DCLKSTAT_DCNTDONE_E_DONE 0x1 DCLKCNT is done counting down.

Field Access Macros:

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_E_NOTDONE   0x0
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_E_DONE   0x1
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_LSB   0
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_MSB   0
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_WIDTH   1
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_SET_MSK   0x00000001
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_CLR_MSK   0xfffffffe
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_RESET   0x0
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_SET(value)   (((value) << 0) & 0x00000001)
 

Data Structures

struct  ALT_FPGAMGR_DCLKSTAT_s
 

Macros

#define ALT_FPGAMGR_DCLKSTAT_OFST   0xc
 

Typedefs

typedef struct
ALT_FPGAMGR_DCLKSTAT_s 
ALT_FPGAMGR_DCLKSTAT_t
 

Data Structure Documentation

struct ALT_FPGAMGR_DCLKSTAT_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_FPGAMGR_DCLKSTAT.

Data Fields
uint32_t dcntdone: 1 DCLK Count Done
uint32_t __pad0__: 31 UNDEFINED

Macro Definitions

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_E_NOTDONE   0x0

Enumerated value for register field ALT_FPGAMGR_DCLKSTAT_DCNTDONE

DCLKCNT is still counting down.

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_E_DONE   0x1

Enumerated value for register field ALT_FPGAMGR_DCLKSTAT_DCNTDONE

DCLKCNT is done counting down.

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_LSB   0

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

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_MSB   0

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

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_WIDTH   1

The width in bits of the ALT_FPGAMGR_DCLKSTAT_DCNTDONE register field.

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_SET_MSK   0x00000001

The mask used to set the ALT_FPGAMGR_DCLKSTAT_DCNTDONE register field value.

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_CLR_MSK   0xfffffffe

The mask used to clear the ALT_FPGAMGR_DCLKSTAT_DCNTDONE register field value.

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_RESET   0x0

The reset value of the ALT_FPGAMGR_DCLKSTAT_DCNTDONE register field.

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_GET (   value)    (((value) & 0x00000001) >> 0)

Extracts the ALT_FPGAMGR_DCLKSTAT_DCNTDONE field value from a register.

#define ALT_FPGAMGR_DCLKSTAT_DCNTDONE_SET (   value)    (((value) << 0) & 0x00000001)

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

#define ALT_FPGAMGR_DCLKSTAT_OFST   0xc

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

Typedef Documentation

The typedef declaration for register ALT_FPGAMGR_DCLKSTAT.