bertos/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 <cfg/debug.h>
  48 // Define log settings for cfg/log.h
  49 #define LOG_LEVEL    CONFIG_KEYTAG_LOG_LEVEL
  50 #define LOG_FORMAT   CONFIG_KEYTAG_LOG_FORMAT
  51 #include <cfg/log.h>
  52 #include <cfg/macros.h>
  53
  54 #include <kern/kfile.h>
  55
  56 #include <string.h>
  57 /**
  58  * Starting communication char (STX).
  59  */
  60 #define TAG_STX 0x02
  61
  62 /**
  63  * Ending communication char (ETX).
  64  */
  65 #define TAG_ETX 0x03
  66
  67 static void keytag_clearPkt(struct TagPacket *pkt)
  68 {
  69         pkt->sync = false;
  70         pkt->len = 0;
  71 }
  72
  73 /**
  74  * DEPRECATED FUCNTIONS
  75  * To read the tag string from device you shoul use the keytag_recv
  76  * fuction, that return the string if we had received it.
  77  */
  78 void keytag_poll(struct TagPacket *pkt)
  79 {
  80         #warning __FILTER_NEXT_WARNING__
  81         #warning keytag_poll function is depreca use keytag_recv instead
  82         uint8_t buf[CONFIG_TAG_MAX_LEN];
  83         int len;
  84         if ((len = keytag_recv(pkt, buf, sizeof(buf))) != EOF)
  85                 kfile_write(pkt->host, buf, len);
  86 }
  87
  88 int keytag_recv(struct TagPacket *pkt, uint8_t *tag, size_t len)
  89 {
  90         int c;
  91
  92         /* Get all chars from buffer */
  93         while ((c = kfile_getc(pkt->tag)) != EOF)
  94         {
  95                 /* Search for STX char in received chars */
  96                 if (c == TAG_STX)
  97                 {
  98                         /* When STX is found a new packet begins */
  99                         if (pkt->sync)
 100                                 LOG_WARN("TAG double sync!\n");
 101                         keytag_clearPkt(pkt);
 102                         pkt->sync = true;
 103                 }
 104                 else if (pkt->sync)
 105                 {
 106                         /* Check for end of packet */
 107                         if (c == TAG_ETX)
 108                         {
 109                                 /* Terminate the tag string */
 110                                 size_t tag_len = MIN(len, pkt->len);
 111
 112                                 /* Save read tag */
 113                                 memcpy(tag, pkt->buf, tag_len);
 114                                 pkt->sync = false;
 115                                 return tag_len;
 116                         }
 117                         else
 118                         {
 119                                 /* Check for buffer overflow */
 120                                 if (pkt->len >= CONFIG_TAG_MAX_LEN)
 121                                 {
 122                                         LOG_ERR("TAG buffer overflow\n");
 123                                         pkt->sync = false;
 124                                 }
 125                                 else
 126                                 {
 127                                         /* Add every char after STX to tag reading buffer */
 128                                         if (pkt->sync)
 129                                         {
 130                                                 pkt->buf[pkt->len] = c;
 131                                                 pkt->len++;
 132                                         }
 133                                 }
 134                         }
 135                 }
 136         }
 137         if (kfile_error(pkt->tag) != 0)
 138         {
 139                 LOG_ERR("Error %04x\n", kfile_error(pkt->tag));
 140                 kfile_clearerr(pkt->tag);
 141         }
 142
 143         return EOF;
 144 }
 145
 146 /**
 147  * Init the keytag module.
 148  */
 149 void keytag_init(struct TagPacket *pkt, struct KFile *comm, struct KFile *tag)
 150 {
 151         keytag_clearPkt(pkt);
 152         pkt->tag = tag;
 153         pkt->host = comm;
 154 }
 155