Software Architecture Document: Addendum

Transcription

1 L3x UART Software Architecture Software Architecture Document: Addendum Information in this document is subject to change without notice. Texas Instruments may have pending patent applications, trademarks, copyrights, or other intellectual property rights covering matter in this document. The furnishing of this document is given for usage with Texas Instruments products only and does not give you any license to the intellectual property that might be contained within this document. Texas Instruments makes no implied or expressed warranties in this document and is not responsible for the products based from this document Document Version 0. Page of 9

2 TABLE OF CONTENTS Introduction Document Updates... 5 Section 2.2. Constraints...5 Section Configuration Register (CHn_Config)...5 Section Configuration Register 2 (CHn_Config2)...6 Section TX/RX Status Register (CHn_TXRXStatus)...6 Section 6.2. Function...8 Document Version 0. Page 2 of 9

3 OF FIGURES No table of figures entries found. Document Version 0. Page 3 of 9

4 Introduction This document serves as an addendum to the Soft UART Software Architecture Document available on Mistral s website. The key additions are: Parity support Pre-scalar 3 support Document Version 0. Page 4 of 9

5 2 Document Updates Section 2.2. Constraints The following feature is also supported in the soft UART: Even, odd, and none parity detection and generation. Section Configuration Register (CHn_Config) Updated register table for overrun interrupt mask: OverrunIntr Mask BIIntr Mask FEIntrMask TimeoutIntr Mask Oversampling PreScalerValue Bit Field ARM/DSP Access PRU Access 5 OverrunIntrMask W R 4 TimeoutIntrMask W R 3 BIIntrMask W R 2 FEIntrMask W R -0 Oversampling W R Value 0 Overrun Error Interrupt Masked Overrun Error Interrupt Unmasked only if ErrIntr bit of UART Interrupt Mask Register is set. 0 Timeout Error Interrupt Masked Timeout Interrupt Unmasked only if ErrIntr bit of UART Interrupt Mask Register is set. 0 Break Indicator Interrupt Masked Break Indicator Interrupt Unmasked only if ErrIntr bit of UART Interrupt Mask Register is set. 0 Framing Error Interrupt Masked Framing Error Interrupt Unmasked only if ErrIntr bit of UART Interrupt Mask Register is set. 00 No Oversampling 0 8 bits Oversampling 0 6 bits Oversampling Reserved Document Version 0. Page 5 of 9

6 9-0 PreScalerValue W R 0-9 Maximum baud rate / 2^n. Where n is the PreScalerValue Section Configuration Register 2 (CHn_Config2) Updated register table for parity support: scratch_parity DataLen Parity Unused bitsperchar Bit Field ARM/DSP PRU Value Access Access 5 2 scratch_parity W W/R 0-2 Temporary register for adding rx parity bits 8 DataLen W W/R 0-5 Length of transmit/receive buffer to be transmitted/received. 7 6 Parity W R 0-3 Parity supported Value 0 is None Value is Odd parity Value 2 is Even parity 5 4 Reserved X X X Reserved 3 0 bitsperchar W R 6-2 Number of bits per character Section TX/RX Status Register (CHn_TXRXStatus) Updated register table for parity support: Channel State Reserved PE P Mask TO BI FE TXRXRUNERR TXRXError TXRXReady TXRXComplete/ RXFIFOIndex Document Version 0. Page 6 of 9

7 Bit Field ARM/DSP Access PRU Access Value 5 Channel State X R/W 0 Channel (serializer) Inactive Channel (serializer ) Active 4-9 Reserved X X X Reserved 8 PE MASK R W 0 No Parity error 7 PE R W 0 Parity Error (RX) No Parity error Parity Error (RX) 6 TO R W 0 Time-out 5 BI R W 0 No Break Indicator Error 4 FE R W 0 3 TXRXRUNERR R W 0 Break Indicator Error (RX) No Framing error Framing Error (RX) No Error If this bit is 0 and TXRXError bit is set then it is Unknown/other TX/RX errors Overrun in case of RX Underrun in case of TX. If there is any under/over run error, this bit is set along with TXRXError. 2 TXRXError R W 0 no- Transmit/Receive error/reset Value TXComplete/RXFIFOIndex R W 0 0 Transmit/Receive Error Transmit: Reset Value Transmit Complete. This will be set by PRU on Transmit complete Receive: Data Lower upper of FIFO. Data in Upper Half of the FIFO Document Version 0. Page 7 of 9

8 0 TXRXReady R R/W 0 Transmit: Ready to Transmit. Reset by PRU R R/W TX Busy. This is set by PRU. Before interrupting for next transmission ARM has to check this bit. Receive: 0 Ready for receive. ARM/DSP reads the data and reset the bit to 0 informing PRU to receive next set of data. Receive Busy. PRU will update this bit saying that the data is ready in the receive buffer. Section 6.2. Function The following functions have been added:. pru_softuart_setparity short pru_softuart_setparity (suart_handle huart, unsigned short parity) Arguments Return Value huart - handle to UART. parity - number corresponding to parity configuration i.e. (value 0 = none, value = odd, value 2 = even) PRU_SOFTUART_SUCCESS - returns zero on success Returns non-zero value on failure, return values are o PRU_SUART_ERR_HANDLE_INVALID o PRU_SOFTUART_ERR_PARAMETER_INVALID o PRU_MODE_INVALID Pre Condition PRU_SoftUart_Open() function must be called before calling this function. Document Version 0. Page 8 of 9

9 This function sets the parity configuration for Soft UART. 2. pru_softuart_getrxcntrlreg int pru_softuart_getrxcntrlreg(suart_handle huart) Arguments Return Value huart - handle to UART. PRU_SOFTUART_SUCCESS - returns zero on success Returns non-zero value on failure, return values are o PRU_SUART_ERR_HANDLE_INVALID o PRU_MODE_INVALID Pre Condition PRU_SoftUart_Open() function must be called before calling this function. This function uses UART handle passed to it and reads the control register of the RX channel of the Soft UART. 3. pru_softuart_getrxconfig2 int pru_softuart_getrxconfig2(suart_handle huart) Arguments Return Value huart - handle to UART. PRU_SOFTUART_SUCCESS - returns zero on success Returns non-zero value on failure, return values are o PRU_SUART_ERR_HANDLE_INVALID o PRU_MODE_INVALID Pre Condition PRU_SoftUart_Open() function must be called before calling this function. This function uses UART handle passed to it and reads the Config2 register of the RX channel of the Soft UART. 4. pru_softuart_getrxdatapointer int pru_softuart_getrxdatapointer(suart_handle huart) Document Version 0. Page 9 of 9

10 Arguments Return Value huart - handle to UART. PRU_SOFTUART_SUCCESS - returns zero on success Returns non-zero value on failure, return values are o PRU_SUART_ERR_HANDLE_INVALID o PRU_MODE_INVALID Pre Condition PRU_SoftUart_Open() function must be called before calling this function. This function uses UART handle passed to it and reads the data pointer of the RX channel of the Soft UART. 5. pru_softuart_getrxfifobytes int pru_softuart_getrxfifobytes(suart_handle huart) Arguments Return Value huart - handle to UART. PRU_SOFTUART_SUCCESS - returns zero on success Returns non-zero value on failure, return values are o PRU_SUART_ERR_HANDLE_INVALID o PRU_MODE_INVALID Pre Condition PRU_SoftUart_Open() function must be called before calling this function. This function uses UART handle passed to it and reads the FIFO bytes of the RX channel of the Soft UART. Document Version 0. Page 0 of 9