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