Doc fixes.
[bertos.git] / net / keytag.h
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. (interface).
36  */
37
38 #ifndef NET_KEYTAG_H
39 #define NET_KEYTAG_H
40
41 #include <kern/kfile.h>
42 #include <drv/ser.h>
43
44 /**
45  * Starting communication char (STX).
46  */
47 #define TAG_STX 0x02
48
49 /**
50  * Ending communication char (ETX).
51  */
52 #define TAG_ETX 0x03
53
54 /**
55  * Max buffer lenght
56  */
57 #define TAG_MAX_LEN 14
58
59 #define TAG_SER_PORT 0
60 #define TAG_SER_BAUDRATE 9600
61
62 /**
63  * Max number of chars to print in the communication serial
64  */
65 #define TAG_MAX_PRINT_CHARS 12
66
67 /**
68  * Structure of a Tag packet
69  */
70 typedef struct TagPacket
71 {
72         KFileSerial *tag_ser;           // Tag serial
73         KFileSerial *comm_ser;        // Communication serial
74         bool sync;                      // Status flag: true if we find an STX
75         uint16_t len;                   // Packet lenght
76         uint8_t buf[TAG_MAX_LEN];       // Reception buffer
77 } TagPacket;
78
79 void keytag_init(struct TagPacket *pkt);
80 void keytag_poll(struct TagPacket *pkt);
81
82 #endif /* NET_TAG_H */