gis_logo.png

Datasheet for the UART_1MBD_3 GIS Soft IP Embedded Logic

Register Definitions

uart_1MBd_3 This block is the 1MBaud UART interface for alerts
Register Name Byte Addr Offset Field Bits Type subtype Reset Description
CSR_UART_1MBD_3_IP_ID 0x0 32 Unique ID for this IP block
IP_NUMBER 7:0 c 0x0e IP identifier number
MFR_NUMBER 15:8 c 0xFF Manufacturer number
RESERVED 31:16 rsv 0 Reserved bits
CSR_UART_1MBD_3_IP_VER 0x4 32 Bits[7:0] = Minor version number, Bits[15:8] = Major version number, etc.
MINOR_NUMBER 7:0 c 0x03 Minor number
MAJOR_NUMBER 15:8 c 0x00 Major number
RESERVED 31:16 rsv 0 Reserved bits
CSR_UART_1MBD_3_CODES 0x8 16 Three bit codes for the over/under range and return events
OVER 2:0 w 3 Code for over-range alert (bits 7 down to 5 of received byte).
RESERVED0 3 rsv 0 Reserved bits
OVER_RTN 6:4 w 4 Code for over-range return alert (bits 7 down to 5 of received byte).
RESERVED1 7 rsv 0 Reserved bits
UNDER 10:8 w 5 Code for over-range alert (bits 7 down to 5 of received byte).
RESERVED2 11 rsv 0 Reserved bits
UNDER_RTN 14:12 w 6 Code for under-range return alert (bits 7 down to 5 of received byte).
RESERVED3 15 rsv 0 Reserved bits
CSR_UART_1MBD_3_OVRG_EN 0xc 32 w 0 Enable bitmap of ADC ordinals for over-range events for over-range trigger output
CSR_UART_1MBD_3_UNRG_EN 0x10 32 w 0 Enable bitmap of ADC ordinals for under-range events for under-range output
CSR_UART_1MBD_3_OVRG_RTN_EN 0x14 32 w 0 Enable bitmap of ADC ordinals for over-range return events for over-range return trigger output
CSR_UART_1MBD_3_UNRG_RTN_EN 0x18 32 w 0 Enable bitmap of ADC ordinals for under-range return events for under-range trigger output
CSR_UART_1MBD_3_CLR_ALERT_INT 0x1c 1 wp 0 Writing to this register clears any alert interrupts status. Reading returns interrupts status.
CSR_UART_1MBD_3_RX 0x20 32 UART Receive register. Writing to this register enables the write FIFO.
READ_DATA 7:0 rp 0x00 RX read data byte
RESERVED0 8 rsv 0 Reserved bits
PARITY_ERROR 9 rp 0x0 Parity error status
RESERVED1 14:10 rsv 0 Reserved bits
READ_DATA_VALID 15 rp 0x0 Receiver read data is valid
READ_DATA_AVAIL 23:16 rp 0x0 Receiver read data is available
RESERVED2 31:24 rsv 0 Reserved bits
CSR_UART_1MBD_3_CONTROL 0x24 32 UART control (and status) register
RD_INT_EN 0 rwp 0 Read interrupt enable
WR_INT_EN 1 rwp 0 Write interrupt enable
RESERVED0 7:2 rsv 0 Reserved bits
RD_INT 8 rwp 0 Read interrupt active (actually read-only, but violates mixing rules)
WR_INT 9 rwp 0 Write interrupt active (actually read-only, but violates mixing rules)
RESERVED1 15:10 rsv 0 Reserved bits
WR_SPACE 23:16 rwp 0 Write FIFO space available (actually read-only, but violates mixing rules)
RESERVED2 31:24 rsv 0 Reserved bits

Register/field type key:

TypeDescription
cConstant, with value defined by "reset" attribute
rsvSame as constant, except no reset value and always 0. Can be mixed with write types.
wWrite register (and read—no write only type). Register defined in register block and reset to "reset" attribute value. Split into fields (if applicable) for signalling and output, where attribute associated with fields, not register.
wpWrite with pulse. Register is not declared in block, but write bus split into fields as output port signals, and a pulse generated on write to register address. Register reads back 0. The "reset" attribute is for documentation only, as set externally.
w0Same as w, but auto-clears to 0 (and thus always reads as 0). At output port, signal will go high for one cycle when bit is written with a 1 (no effect if written to a 0). No "reset" attribute, as must always be 0.
rRead only value. Input ports generated for each field (where applicable), and concatenated on returned read data bus.
rpSimilar to r, but a pulse generated on a read access to the register address to allow peripheral logic to update value. The "reset" attribute is for documentation only, as set externally.
rwpSimilar to wp, but also generates a (separate) pulse on a read access to the register
bitdefDefines the bits used in the read, set, clear registers
  
SubypeDescription
unsignedRegister/field is specified as an unsigned value.
signedRegister/field is specified as a signed value.
<blank>Register/field sign status is not explicitly defined and defaults to unsigned.

Usage Notes

The 1MBaud UART is used as a receiver only UART for STM8 alert data, mapping received byte codes to trigger pulse, with enables. The core logic is generated from the Altera soft IP suite. The RX register is used to give the CPU access to the received data, with the READ_DATA fields giving the received byte. When reading the register, if read data is valid (READ_DATA_VALID bit), the byte is 'popped' from the receiver fifo queue. Parity error status is given (PARITY_ERROR bit), along with the data valid and a count of queued received data (READ_DATA_AVAIL bits). The CONTROL register allows the enabling of receive interrupts (RD_INT_EN), as well as (on reads) the status of the interrupt (RD_INT). All the fields associated with transmission are not used.

For the generation of emergency shutdown request, the CODES register is used to define the 3 upper bit codes for the four events (by default they are the values defined at this link). The OVRG_EN register is a bitmap for the ADC ordinals of the over-range event. Reception of an over-range event with a bit set in this register, as indexed by the ordinal, will generate an over-range trigger output. Similarly for the UNRG_EN register and under-range trigger, the OVRG_RTN_EN register and the over-range return trigger and the UNRG_RTN_EN register and under-range return trigger outputs.

The block will generate an interrupt if the over- or under-range trigger outputs pulse (and thus enabled by the enable registers being non-zero), or by the UART core, enabled by the UART's CONTROL register.

 


Copyright © 2024 Global Inkjet Systems. Generated by gen_htm.py —2024-10-30 09:43