Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : TCK Divide ratio - jtag_kick

Description

Jtag Master Control Triggers. Each of this bit field triggers a specific hardware operation.

Register Layout

Bits Access Reset Description
[0] RW 0x0 Kick off a new Session
[1] RW 0x0 force stop an ongoing session.
[2] RW 0x0 Clear TX FIFO
[3] RW 0x0 Clear RX FIFO
[31:4] ??? Unknown UNDEFINED

Field : Kick off a new Session - startSession

A write 1 to this bit field will kick off a session of TX and RX. Please note that there should be alteast 1 word available in the Tx Fifo for this kick off to be successful. The status of this kick off can be read from status register SessionStatus field.

stopSession has priority over startSession.

Field Access Macros:

#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_LSB   0
 
#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_MSB   0
 
#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_WIDTH   1
 
#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_SET_MSK   0x00000001
 
#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_CLR_MSK   0xfffffffe
 
#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_RESET   0x0
 
#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_SET(value)   (((value) << 0) & 0x00000001)
 

Field : force stop an ongoing session. - stopSession

A write 1 to this bit field will kick off stop of an ongoing session of TX and RX. Please note that there should be alteast 1 word available in the Tx Fifo for this kick off to be successful. The status of this kick off can be read from status register SessionStatus field.

stopSession has priority over startSession.

Field Access Macros:

#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_LSB   1
 
#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_MSB   1
 
#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_WIDTH   1
 
#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_SET_MSK   0x00000002
 
#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_CLR_MSK   0xfffffffd
 
#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_RESET   0x0
 
#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_GET(value)   (((value) & 0x00000002) >> 1)
 
#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_SET(value)   (((value) << 1) & 0x00000002)
 

Field : Clear TX FIFO - clearTxFifo

A write 1 to this bit field will empty the TxFifo. A read will always return 0.

Field Access Macros:

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_LSB   2
 
#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_MSB   2
 
#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_WIDTH   1
 
#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_SET_MSK   0x00000004
 
#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_CLR_MSK   0xfffffffb
 
#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_RESET   0x0
 
#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_GET(value)   (((value) & 0x00000004) >> 2)
 
#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_SET(value)   (((value) << 2) & 0x00000004)
 

Field : Clear RX FIFO - clearRxFifo

A write 1 to this bit field will empty the RxFifo. A read will always return 0.

Field Access Macros:

#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_LSB   3
 
#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_MSB   3
 
#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_WIDTH   1
 
#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_SET_MSK   0x00000008
 
#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_CLR_MSK   0xfffffff7
 
#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_RESET   0x0
 
#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_GET(value)   (((value) & 0x00000008) >> 3)
 
#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_SET(value)   (((value) << 3) & 0x00000008)
 

Data Structures

struct  ALT_FPGAMGR_JTAG_KICK_s
 

Macros

#define ALT_FPGAMGR_JTAG_KICK_RESET   0x00000000
 
#define ALT_FPGAMGR_JTAG_KICK_OFST   0x58
 

Typedefs

typedef struct
ALT_FPGAMGR_JTAG_KICK_s 
ALT_FPGAMGR_JTAG_KICK_t
 

Data Structure Documentation

struct ALT_FPGAMGR_JTAG_KICK_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_JTAG_KICK.

Data Fields
uint32_t startSession: 1 Kick off a new Session
uint32_t stopSession: 1 force stop an ongoing session.
uint32_t clearTxFifo: 1 Clear TX FIFO
uint32_t clearRxFifo: 1 Clear RX FIFO
uint32_t __pad0__: 28 UNDEFINED

Macro Definitions

#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_LSB   0

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

#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_MSB   0

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

#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_WIDTH   1

The width in bits of the ALT_FPGAMGR_JTAG_KICK_STARTSESSION register field.

#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_SET_MSK   0x00000001

The mask used to set the ALT_FPGAMGR_JTAG_KICK_STARTSESSION register field value.

#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_CLR_MSK   0xfffffffe

The mask used to clear the ALT_FPGAMGR_JTAG_KICK_STARTSESSION register field value.

#define ALT_FPGAMGR_JTAG_KICK_STARTSESSION_RESET   0x0

The reset value of the ALT_FPGAMGR_JTAG_KICK_STARTSESSION register field.

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

Extracts the ALT_FPGAMGR_JTAG_KICK_STARTSESSION field value from a register.

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

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

#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_LSB   1

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

#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_MSB   1

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

#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_WIDTH   1

The width in bits of the ALT_FPGAMGR_JTAG_KICK_STOPSESSION register field.

#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_SET_MSK   0x00000002

The mask used to set the ALT_FPGAMGR_JTAG_KICK_STOPSESSION register field value.

#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_CLR_MSK   0xfffffffd

The mask used to clear the ALT_FPGAMGR_JTAG_KICK_STOPSESSION register field value.

#define ALT_FPGAMGR_JTAG_KICK_STOPSESSION_RESET   0x0

The reset value of the ALT_FPGAMGR_JTAG_KICK_STOPSESSION register field.

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

Extracts the ALT_FPGAMGR_JTAG_KICK_STOPSESSION field value from a register.

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

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

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_LSB   2

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

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_MSB   2

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

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_WIDTH   1

The width in bits of the ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO register field.

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_SET_MSK   0x00000004

The mask used to set the ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO register field value.

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_CLR_MSK   0xfffffffb

The mask used to clear the ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO register field value.

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_RESET   0x0

The reset value of the ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO register field.

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_GET (   value)    (((value) & 0x00000004) >> 2)

Extracts the ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO field value from a register.

#define ALT_FPGAMGR_JTAG_KICK_CLRTXFIFO_SET (   value)    (((value) << 2) & 0x00000004)

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

#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_LSB   3

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

#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_MSB   3

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

#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_WIDTH   1

The width in bits of the ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO register field.

#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_SET_MSK   0x00000008

The mask used to set the ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO register field value.

#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_CLR_MSK   0xfffffff7

The mask used to clear the ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO register field value.

#define ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO_RESET   0x0

The reset value of the ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO register field.

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

Extracts the ALT_FPGAMGR_JTAG_KICK_CLRRXFIFO field value from a register.

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

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

#define ALT_FPGAMGR_JTAG_KICK_RESET   0x00000000

The reset value of the ALT_FPGAMGR_JTAG_KICK register.

#define ALT_FPGAMGR_JTAG_KICK_OFST   0x58

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

Typedef Documentation

The typedef declaration for register ALT_FPGAMGR_JTAG_KICK.