]> git.donarmstrong.com Git - tmk_firmware.git/blob - protocol/serial_uart.c
Add flow control by firmware to serial_uart
[tmk_firmware.git] / protocol / serial_uart.c
1 /*
2 Copyright 2013 Jun WAKO <wakojun@gmail.com>
3
4 This software is licensed with a Modified BSD License.
5 All of this is supposed to be Free Software, Open Source, DFSG-free,
6 GPL-compatible, and OK to use in both free and proprietary applications.
7 Additions and corrections to this file are welcome.
8
9
10 Redistribution and use in source and binary forms, with or without
11 modification, are permitted provided that the following conditions are met:
12
13 * Redistributions of source code must retain the above copyright
14   notice, this list of conditions and the following disclaimer.
15
16 * Redistributions in binary form must reproduce the above copyright
17   notice, this list of conditions and the following disclaimer in
18   the documentation and/or other materials provided with the
19   distribution.
20
21 * Neither the name of the copyright holders nor the names of
22   contributors may be used to endorse or promote products derived
23   from this software without specific prior written permission.
24
25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 #include <stdbool.h>
39 #include <avr/io.h>
40 #include <avr/interrupt.h>
41 #include "serial.h"
42
43
44 #if defined(SERIAL_UART_RTS_LO) && defined(SERIAL_UART_RTS_HI)
45     // Buffer state
46     //   Empty:           RBUF_SPACE == RBUF_SIZE(head==tail)
47     //   Last 1 space:    RBUF_SPACE == 2
48     //   Full:            RBUF_SPACE == 1(last cell of rbuf be never used.)
49     #define RBUF_SPACE()   (rbuf_head < rbuf_tail ?  (rbuf_tail - rbuf_head) : (RBUF_SIZE - rbuf_head + rbuf_tail))
50     // allow to send
51     #define rbuf_check_rts_lo() do { if (RBUF_SPACE() > 2) SERIAL_UART_RTS_LO(); } while (0)
52     // prohibit to send
53     #define rbuf_check_rts_hi() do { if (RBUF_SPACE() <= 2) SERIAL_UART_RTS_HI(); } while (0)
54 #else
55     #define rbuf_check_rts_lo()
56     #define rbuf_check_rts_hi()
57 #endif
58
59
60 void serial_init(void)
61 {
62     SERIAL_UART_INIT();
63 }
64
65 // RX ring buffer
66 #define RBUF_SIZE   256
67 static uint8_t rbuf[RBUF_SIZE];
68 static uint8_t rbuf_head = 0;
69 static uint8_t rbuf_tail = 0;
70
71 uint8_t serial_recv(void)
72 {
73     uint8_t data = 0;
74     if (rbuf_head == rbuf_tail) {
75         return 0;
76     }
77
78     data = rbuf[rbuf_tail];
79     rbuf_tail = (rbuf_tail + 1) % RBUF_SIZE;
80     rbuf_check_rts_lo();
81     return data;
82 }
83
84 int16_t serial_recv2(void)
85 {
86     uint8_t data = 0;
87     if (rbuf_head == rbuf_tail) {
88         return -1;
89     }
90
91     data = rbuf[rbuf_tail];
92     rbuf_tail = (rbuf_tail + 1) % RBUF_SIZE;
93     rbuf_check_rts_lo();
94     return data;
95 }
96
97 void serial_send(uint8_t data)
98 {
99     while (!SERIAL_UART_TXD_READY) ;
100     SERIAL_UART_DATA = data;
101 }
102
103 // USART RX complete interrupt
104 ISR(SERIAL_UART_RXD_VECT)
105 {
106     uint8_t next = (rbuf_head + 1) % RBUF_SIZE;
107     if (next != rbuf_tail) {
108         rbuf[rbuf_head] = SERIAL_UART_DATA;
109         rbuf_head = next;
110     }
111     rbuf_check_rts_hi();
112 }