Admin: Created page with "= Action = Configures the hardware UART to use a buffer for input
2013-02-08T10:15:23Z

Created page with "= Action = Configures the hardware UART to use a buffer for input Action =

Configures the hardware UART to use a buffer for input

 

 

= Syntax =

CONFIG SERIALIN | SERIALIN1 | SERIALIN2 | SERIALIN3 = BUFFERED , SIZE = size [, BYTEMATCH=ALL|BYTE|NONE]  [,CTS=pin, RTS=pin , Threshold_full=num , Threshold_empty=num ]

 

 

= Remarks =
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="604" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 130px; border: 1px solid rgb(0, 0, 0);" |
SerialIn

| valign="top" width="90%" style="width: 465px; border: 1px solid rgb(0, 0, 0);" |
Some chips have multiple HW UARTS. Use the following parameter values:
<div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| SERIALIN or SERIALIN0 : first UART/UART0
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| SERIALIN1 : second UART/UART1
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| SERIALIN2 : third UART/UART2
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| SERIALIN3 : fourth UART/UART3
|}
</div>
|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 130px; border: 1px solid rgb(0, 0, 0);" |
Size

| valign="top" width="90%" style="width: 465px; border: 1px solid rgb(0, 0, 0);" |
A numeric constant that specifies how large the input buffer should be. The space is taken from the SRAM. The maximum is 255.

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 130px; border: 1px solid rgb(0, 0, 0);" |
Bytematch

| valign="top" width="90%" style="width: 465px; border: 1px solid rgb(0, 0, 0);" |
The ASCII value of the byte that will result in calling a user label.

When you specify ALL, the user label will be called for every byte that is received. You must include the label yourself in your code and end it with a return. The following label names must be used when you check for a specific byte value:

 
<div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial0CharMatch (for SERIALIN or the first UART/UART0)
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial1CharMatch (for SERIALIN1 or the second UART/UART1)
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial2CharMatch (for SERIALIN2 or the third UART/UART2)
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial3CharMatch (for SERIALIN3 or the fourth UART/UART3)
|}
</div>
 

The following label names must be used when you check for any value:

 
<div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial0ByteReceived (for SERIALIN or the first UART/UART0)
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial1ByteReceived (for SERIALIN1 or the second UART/UART1)
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial2ByteReceived (for SERIALIN2 or the third UART/UART2)
|}
</div><div style="padding: 0px; margin: 0px 0px 0px 11px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="13" | •
| Serial3ByteReceived (for SERIALIN3 or the fourth UART/UART3)
|}
</div>
 

When you specify NONE, it is the same as not specifying this optional parameter.

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 130px; border: 1px solid rgb(0, 0, 0);" |
CTS

| valign="top" width="90%" style="width: 465px; border: 1px solid rgb(0, 0, 0);" |
The pin used for the CTS.(Clear to send). For example PIND.6

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 130px; border: 1px solid rgb(0, 0, 0);" |
RTS

| valign="top" width="90%" style="width: 465px; border: 1px solid rgb(0, 0, 0);" |
The pin used for RTS. (Ready to send). For example PIND.7

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 130px; border: 1px solid rgb(0, 0, 0);" |
Threshold_full

| valign="top" width="90%" style="width: 465px; border: 1px solid rgb(0, 0, 0);" |
The number of bytes that will cause RTS to be set to '1'. This is an indication to the sender, that the buffer is full.

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 130px; border: 1px solid rgb(0, 0, 0);" |
Threshold_empty

| valign="top" width="90%" style="width: 465px; border: 1px solid rgb(0, 0, 0);" |
The number of free bytes that must be in the buffer before CTS may be made '0' again.

|}
</div>
 

 

The following internal variables will be generated for UART0:

_RS_HEAD_PTR0 , a byte counter that stores the head of the buffer

_RS_TAIL_PTR0 , a byte counter that stores the tail of the buffer.

_RS232INBUF0 , an array of bytes that serves as a ring buffer for the received characters.

_RS_BUFCOUNTR0, a byte that holds the number of bytes that are in the buffer.

 

For the other UARTS, the variables are named similar. But they do have a different number.

A 1 for the second UART, a 3 for the third UART and a 4 for the fourth UART. Yes, the '2' is skipped.

 

While you can read and write the internal variables, we advise not to write to them. The variables are updated inside interrupts routines, and just when you write a value to them, an ISR can overwrite the value.

 

The optional BYTEMATCH can be used to monitor the incoming bytes and call a label when the specified label is found. This label is a fixed label as mentioned in the table above.

This way you can determine the start of a serial stream.

 

While bytematch allows you to trap the incoming bytes, take care that you do not delay the program execution too much. After all the serial input interrupt is used in order not to miss incoming data. When you add delays or code that will delay execution too much you might loose incoming data.

[[File:Important.jpg|left|Important.jpg]]When using the BYTEMATCH option, you must preserve the registers you alter. If you do not know which one, use [[PUSHALL]] and [[POPALL]].

 

[[File:Notice.jpg|left|Notice.jpg]]To clear the buffer, use [[CLEAR]] SERIALIN. Do not read and write the internal buffer variables yourself.

 

 

CTS-RTS is hardware flow control. Both the sender and receiver need to use CTS-RTS when CTS-RTS is used. When one of the parties does not use CTS-RTS, no communication will be possible.

CTS-RTS use two extra lines. The receiver must check the CTS pin to see if it may send. The CTS pin is a input pin as the receiver looks at the level that the sender can change.

 

The receiver can set the RTS pin to indicate to the sender that it can accept data.

In the start condition, RTS is made '0' by the receiver.  The sender will then check this logic level with it's CTS pin, and will start to send data. The receiver will store the data into the buffer and when the buffer is almost full, or better said, when the Threshold_full is the same as the number of bytes in the receive buffer, the receiver will make RTS '1' to signal to the sender, that the buffer is full. The sender will stop sending data. And will continue when the RTS is made '0' again.

 

The receiver can send data to the sender and it will check the CTS pin to see if it may send data.

 

In order to work with CTS-RTS, you need both a serial input buffer, and a serial output buffer. So use both CONFIG SERIALIN and CONFIG SERIALOUT to specify the buffers.

The CTS-RTS can only be configured with the CONFIG SERIALIN statement.

 

The thresholds are needed for high baud rates where it will take some time to react on a CTS-RTS.

You need to experiment with the thresholds but good start values are 80% full, and 20% empty.

 

[[File:Notice.jpg|left|Notice.jpg]]You need to use a pin that is bit addressable. For most chips this is a pin from port A, B,C or D.

 

 

Additional Infos for XMEGA Devices:

 

Since buffered serial output uses interrupts, you must enable the global interrupts in your code with : ENABLE INTERRUPTS.

For the XMEGA, if you set the priority with CONFIG PRIORITY, you must enable the MED priority.

 

Q: Is Serialin and Serialout supported for UART Interfaces above COM4

A: No buffered serialin and buffered serialout is supported for the first 4 UARTS (COM1....COM4). For COM5....COM8 you can use an interrupt routine or DMA (Direct Memory Access) as an alternative.

 

  For ATXMEGA the first 4 UARTS can use for example serialin:

  SERIALIN   : first UART/UART0        --> COM1   SERIALIN1 : second UART/UART1 --> COM2   SERIALIN2 : third UART/UART2        --> COM3   SERIALIN3 : fourth UART/UART3        --> COM4  

 

  For example with an ATXMEGA128A1 you get 8 UARTS:

  Every of the 8 USART’s has for example a Receive Interrupt which you can use to analyze incoming data:

 

    ATXMEGA128A1 Receive Interrupts:     COM1 --> Usartc0_rxc     COM2 --> Usartc1_rxc     COM3 --> Usartd0_rxc     COM4 --> Usartd1_rxc     COM5 --> Usarte0_rxc     COM6 --> Usarte1_rxc     COM7 --> Usartf0_rxc     COM8 --> Usartf1_rxc

 

   In the interrupt routine you need to use the inkey(#X) function because inkey(#X) is reading the data register and

   therefore reset the interrupt flag. Without reading the data register or resetting the interrupt flag manual the

   interrupt will fire again and again.

 

   Example the interrupt routine:

 

  Rxc_isr:      Rs232 = Inkey(#1)     'do something with the data  Return

 

 

= ASM =

Routines called from MCS.LIB :

 

_GotChar. This is an ISR that gets called when ever a character is received.

When there is no room for the data it will not be stored.

So the buffer must be emptied periodic by reading from the serial port using the normal statements like INKEY() and INPUT.

 

Since URXC interrupt is used by _GotChar, you can not use this interrupt anymore. Unless you modify the _gotchar routine of course.

 

 

= See also =

[[CONFIG SERIALOUT|CONFIG SERIALOUT]] , [[ISCHARWAITING]] , [[CLEAR]]

 

 

= Example =

 <source lang="bascomavr">
'-----------------------------------------------------------------------------------------
'name : rs232buffer.bas
'copyright : (c) 1995-2005, MCS Electronics
'purpose : example shows the difference between normal and buffered
' serial INPUT
'micro : Mega161
'suited for demo : yes
'commercial addon needed : no
'-----------------------------------------------------------------------------------------

$regfile = "m161def.dat" ' specify the used micro
$crystal = 4000000 ' used crystal frequency
$baud = 9600 ' use baud rate
$hwstack = 32 ' default use 32 for the hardware stack
$swstack = 10 ' default use 10 for the SW stack
$framesize = 40 ' default use 40 for the frame space

'first compile and run this program with the line below remarked
Config Serialin = Buffered , Size = 20

Dim Na As String * 10

'the enabling of interrupts is not needed for the normal serial mode
'So the line below must be remarked to for the first test
Enable Interrupts

Print "Start"
Do
'get a char from the UART

If Ischarwaiting() = 1 Then 'was there a char?
Input Na
Print Na 'print it
End If

Wait 1 'wait 1 second
Loop

'You will see that when you slowly enter characters in the terminal emulator
'they will be received/displayed.
'When you enter them fast you will see that you loose some chars

'NOW remove the remarks from line 11 and 18
'and compile and program and run again
'This time the chars are received by an interrupt routine and are
'stored in a buffer. This way you will not loose characters providing that
'you empty the buffer
'So when you fast type abcdefg, they will be printed after each other with the
'1 second delay

'Using the CONFIG SERIAL=BUFFERED, SIZE = 10 for example will
'use some SRAM memory
'The following internal variables will be generated :
'_Rs_head_ptr0 BYTE , a pointer to the location of the start of the buffer
'_Rs_tail_ptr0 BYTE , a pointer to the location of tail of the buffer
'_RS232INBUF0 BYTE ARRAY , the actual buffer with the size of SIZE
</source>

= Example2 =

 <source lang="bascomavr">
'-----------------------------------------------------------------------------------------
'name :
'copyright : (c) 1995-2008, MCS Electronics
'purpose : test for M2560 support
'micro : Mega2560
'suited for demo : yes
'commercial addon needed : no
'-----------------------------------------------------------------------------------------

$regfile = "m2560def.dat" ' specify the used micro
$crystal = 8000000 ' used crystal frequency
$hwstack = 40 ' default use 32 for the hardware stack
$swstack = 40 ' default use 10 for the SW stack
$framesize = 40 ' default use 40 for the frame space

'$timeout = 1000000

'The M128 has an extended UART.
'when CO'NFIG COMx is not used, the default N,8,1 will be used
Config Com1 = 19200 , Synchrone = 0 , Parity = None , Stopbits = 1 , Databits = 8 , Clockpol = 0
Config Com2 = 19200 , Synchrone = 0 , Parity = None , Stopbits = 1 , Databits = 8 , Clockpol = 0
Config Com3 = 19200 , Synchrone = 0 , Parity = None , Stopbits = 1 , Databits = 8 , Clockpol = 0
Config Com4 = 19200 , Synchrone = 0 , Parity = None , Stopbits = 1 , Databits = 8 , Clockpol = 0

Enable Interrupts
Config Serialin = Buffered , Size = 20
Config Serialin1 = Buffered , Size = 20 , Bytematch = 65
Config Serialin2 = Buffered , Size = 20 , Bytematch = 66
Config Serialin3 = Buffered , Size = 20 , Bytematch = All

'Open all UARTS
Open "COM2:" For Binary As #2
Open "COM3:" For Binary As #3
Open "COM4:" For Binary As #4

Print "Hello" 'first uart
Dim B1 As Byte , B2 As Byte , B3 As Byte , B4 As Byte
Dim Tel As Word , Nm As String * 16

'unremark to test second UART
'Input #2 , "Name ?" , Nm
'Print #2 , "Hello " ; Nm

Do
Incr Tel
Print Tel ; " test serial port 1"
Print #2 , Tel ; " test serial port 2"
Print #3 , Tel ; " test serial port 3"
Print #4 , Tel ; " test serial port 4"

B1 = Inkey() 'first uart
B2 = Inkey(#2)
B3 = Inkey(#3)
B4 = Inkey(#4)

If B1 <> 0 Then
Print B1 ; " from port 1"
End If
If B2 <> 0 Then
Print #2 , B2 ; " from port 2"
End If
If B3 <> 0 Then
Print #3 , B3 ; " from port 3"
End If
If B4 <> 0 Then
Print #4 , B4 ; " from port 4"
End If

Waitms 500
Loop

'Label called when UART2 received an A
Serial1charmatch:
Print #2 , "we got an A"
Return

'Label called when UART2 received a B
Serial2charmatch:
Print #3 , "we got a B"
Return

'Label called when UART3 receives a char
Serial3bytereceived:
Print #4 , "we got a char"
Return

End

Close #2
Close #3
Close #4

$eeprom
Data 1 , 2
</source> {{Languages}}

[[Category:BASCOM Language Reference/de]]

CONFIG SERIALIN/de - Revision history

Admin: 1 revision