Doc fixes.
[bertos.git] / net / keytag.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \author Andrea Grandi <andrea@develer.com>
34  *
35  * \brief Tag protocol (protocol).
36  *
37  * TAG protocol is decribed in this way:
38  * <pre>
39  * ---------------------------------------------------
40  * |STX (0x02)|data...(10 HEX chars)|CR|LF|ETX (0x03)|
41  * ---------------------------------------------------
42  * </pre>
43  */
44
45 #include "keytag.h"
46
47 #include <kern/kfile.h>
48
49 #include <drv/timer.h>
50 #include <drv/ser.h>
51
52 #include <cfg/macros.h>
53 #include <cfg/debug.h>
54
55 static void keytag_clearPkt(struct TagPacket *pkt)
56 {
57         pkt->sync = false;
58         pkt->len = 0;
59 }
60
61         void keytag_init(struct TagPacket *pkt)
62         {
63                 keytag_clearPkt(pkt);
64         }
65
66         void keytag_poll(struct TagPacket *pkt)
67 {
68         int c;
69
70         /* Get all chars from buffer */
71         while ((c = kfile_getc(&pkt->tag_ser->fd)) != EOF)
72         {
73                 /* Search for STX char in received chars */
74                 if (c == TAG_STX)
75                 {
76                         /* When STX is found a new packet begins */
77                         if (pkt->sync)
78                                 kprintf("TAG double sync!\n");
79                         keytag_clearPkt(pkt);
80                         pkt->sync = true;
81                 }
82                 else if (pkt->sync)
83                 {
84                         /* Check for end of packet */
85                         if (c == TAG_ETX)
86                         {
87                                 pkt->buf[TAG_MAX_PRINT_CHARS] = '\x0';
88                                 /* Write read TAG on communication serial */
89                                 kfile_printf(&pkt->comm_ser->fd, "tag %s", pkt->buf);
90                                 pkt->sync = false;
91                         }
92                         else
93                         {
94                                 /* Check for buffer overflow */
95                                 if (pkt->len >= TAG_MAX_LEN)
96                                 {
97                                         kprintf("TAG buffer overflow\n");
98                                         pkt->sync = false;
99                                 }
100                                 else
101                                 {
102                                         /* Add every char after STX to tag reading buffer */
103                                         if (pkt->sync)
104                                         {
105                                                 pkt->buf[pkt->len] = c;
106                                                 pkt->len++;
107                                         }
108                                 }
109                         }
110                 }
111         }
112 }