uart

Documentation

Overview

Package uart implements a driver for NXP UART controllers adopting the following reference specifications:

• IMX6ULLRM - i.MX 6ULL Applications Processor Reference Manual - Rev 1 2017/11

This package is only meant to be used with `GOOS=tamago GOARCH=arm` as supported by the TamaGo framework for bare metal Go, see https://github.com/usbarmory/tamago.

Index

• Constants
• type UART
  • func (hw *UART) Disable()
  • func (hw *UART) Enable()
  • func (hw *UART) Init()
  • func (hw *UART) Read(buf []byte) (n int, _ error)
  • func (hw *UART) Rx() (c byte, valid bool)
  • func (hw *UART) Tx(c byte)
  • func (hw *UART) Write(buf []byte) (n int, _ error)

Constants

const (
	UART_DEFAULT_BAUDRATE = 115200
	ESC                   = 0x1b

	UARTx_URXD   = 0x0000
	URXD_CHARRDY = 15
	URXD_ERR     = 14
	URXD_OVRRUN  = 13
	URXD_FRMERR  = 12
	URXD_BRK     = 11
	URXD_PRERR   = 10
	URXD_RX_DATA = 0

	UARTx_UTXD   = 0x0040
	UTXD_TX_DATA = 0

	UARTx_UCR1    = 0x0080
	UCR1_ADEN     = 15
	UCR1_ADBR     = 14
	UCR1_TRDYEN   = 13
	UCR1_IDEN     = 12
	UCR1_ICD      = 10
	UCR1_RRDYEN   = 9
	UCR1_RXDMAEN  = 8
	UCR1_IREN     = 7
	UCR1_TXMPTYEN = 6
	UCR1_RTSDEN   = 5
	UCR1_SNDBRK   = 4
	UCR1_TXDMAEN  = 3
	UCR1_ATDMAEN  = 2
	UCR1_DOZE     = 1
	UCR1_UARTEN   = 0

	UARTx_UCR2 = 0x0084
	UCR2_ESCI  = 15
	UCR2_IRTS  = 14
	UCR2_CTSC  = 13
	UCR2_CTS   = 12
	UCR2_ESCEN = 11
	UCR2_RTEC  = 9
	UCR2_PREN  = 8
	UCR2_PROE  = 7
	UCR2_STPB  = 6
	UCR2_WS    = 5
	UCR2_RTSEN = 4
	UCR2_ATEN  = 3
	UCR2_TXEN  = 2
	UCR2_RXEN  = 1
	UCR2_SRST  = 0

	UARTx_UCR3     = 0x0088
	UCR3_DPEC      = 14
	UCR3_DTREN     = 13
	UCR3_PARERREN  = 12
	UCR3_FRAERREN  = 11
	UCR3_DSR       = 10
	UCR3_DCD       = 9
	UCR3_RI        = 8
	UCR3_ADNIMP    = 7
	UCR3_RXDSEN    = 6
	UCR3_AIRINTEN  = 5
	UCR3_AWAKEN    = 4
	UCR3_DTRDEN    = 3
	UCR3_RXDMUXSEL = 2
	UCR3_INVT      = 1
	UCR3_ACIEN     = 0

	UARTx_UCR4 = 0x008c
	UCR4_CTSTL = 10

	UARTx_UFCR  = 0x0090
	UFCR_TXTL   = 10
	UFCR_RFDIV  = 7
	UFCR_DCEDTE = 6
	UFCR_RXTL   = 0

	UARTx_USR2 = 0x0098
	USR2_RDR   = 0

	UARTx_UESC = 0x009c
	UARTx_UTIM = 0x00a0
	UARTx_UBIR = 0x00a4
	UARTx_UBMR = 0x00a8

	UARTx_UTS  = 0x00b4
	UTS_TXFULL = 4
)

UART registers

Types

type UART

type UART struct {
	// Controller index
	Index int
	// Base register
	Base uint32
	// Clock gate register
	CCGR uint32
	// Clock gate
	CG int
	// Clock retrieval function
	Clock func() uint32
	// port speed
	Baudrate uint32
	// DTE mode
	DTE bool
	// hardware flow control
	Flow bool
	// contains filtered or unexported fields
}

UART represents a serial port instance.

func (*UART) Disable

func (hw *UART) Disable()

Disable disables the UART.

func (*UART) Enable

func (hw *UART) Enable()

Enable enables the UART, this is only required after an explicit disable (see Disable()) as initialized interfaces (see Init()) are enabled by default.

func (*UART) Init

func (hw *UART) Init()

Init initializes and enables the UART for RS-232 mode, p3605, 55.13.1 Programming the UART in RS-232 mode, IMX6ULLRM.

func (*UART) Read

func (hw *UART) Read(buf []byte) (n int, _ error)

Read available data to buffer from serial port.

func (*UART) Rx

func (hw *UART) Rx() (c byte, valid bool)

Rx receives a single character from the serial port.

func (*UART) Tx

func (hw *UART) Tx(c byte)

Tx transmits a single character to the serial port.

func (*UART) Write

func (hw *UART) Write(buf []byte) (n int, _ error)

Write data from buffer to serial port.