4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
33 * \author Andrea Grandi <andrea@develer.com>
34 * \author Daniele Basile <asterix@develer.com>
36 * \brief KeyTAG parser.
38 * This module parse TAG message that come from comunication channel,
39 * and convert the tag value into string.
41 * TAG protocol is decribed in this way:
43 * ---------------------------------------------------
44 * |STX (0x02)|data...(10 HEX chars)|CR|LF|ETX (0x03)|
45 * ---------------------------------------------------
51 #include <cfg/debug.h>
52 // Define log settings for cfg/log.h
53 #define LOG_LEVEL CONFIG_KEYTAG_LOG_LEVEL
54 #define LOG_FORMAT CONFIG_KEYTAG_LOG_FORMAT
56 #include <cfg/macros.h>
62 * Starting communication char (STX).
67 * Ending communication char (ETX).
71 static void keytag_clearPkt(struct TagPacket *pkt)
78 * DEPRECATED FUCNTIONS
79 * To read the tag string from device you shoul use the keytag_recv
80 * fuction, that return the string if we had received it.
82 void keytag_poll(struct TagPacket *pkt)
84 #warning __FILTER_NEXT_WARNING__
85 #warning keytag_poll function is depreca use keytag_recv instead
86 uint8_t buf[CONFIG_TAG_MAX_LEN];
88 if ((len = keytag_recv(pkt, buf, sizeof(buf))) != EOF)
89 kfile_write(pkt->host, buf, len);
93 * Receive the tag message from channel, and if
94 * the tag is good put the converted string into given buffer.
95 * The fuction return the len of found tag string, otherwise EOF.
97 int keytag_recv(struct TagPacket *pkt, uint8_t *tag, size_t len)
101 /* Get all chars from buffer */
102 while ((c = kfile_getc(pkt->tag)) != EOF)
104 /* Search for STX char in received chars */
107 /* When STX is found a new packet begins */
109 LOG_WARN("TAG double sync!\n");
110 keytag_clearPkt(pkt);
115 /* Check for end of packet */
118 /* Terminate the tag string */
119 size_t tag_len = MIN(len, pkt->len);
122 memcpy(tag, pkt->buf, tag_len);
128 /* Check for buffer overflow */
129 if (pkt->len >= CONFIG_TAG_MAX_LEN)
131 LOG_ERR("TAG buffer overflow\n");
136 /* Add every char after STX to tag reading buffer */
139 pkt->buf[pkt->len] = c;
146 if (kfile_error(pkt->tag) != 0)
148 LOG_ERR("Error %04x\n", kfile_error(pkt->tag));
149 kfile_clearerr(pkt->tag);
156 * Init the keytag module.
158 void keytag_init(struct TagPacket *pkt, struct KFile *comm, struct KFile *tag)
160 keytag_clearPkt(pkt);