bertos/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  * $WIZ$ module_name = "keytag"
  38  * $WIZ$ module_configuration = "bertos/cfg/cfg_keytag.h"
  39  * $WIZ$ module_depends = "kfile"
  40  * $WIZ$ module_hw = ""
  41  */
  42
  43 #ifndef NET_KEYTAG_H
  44 #define NET_KEYTAG_H
  45
  46 #include "cfg/cfg_keytag.h"
  47 #include <cfg/compiler.h>
  48
  49 #include <io/kfile.h>
  50
  51
  52 /**
  53  * Structure of a Tag packet
  54  */
  55 typedef struct TagPacket
  56 {
  57         KFile *tag;                        ///< Tag communication channel
  58         KFile *host;                       ///< Host communication channel
  59         bool sync;                         ///< Status flag: true if we find an STX
  60         size_t len;                        ///< Packet lenght
  61         uint8_t buf[CONFIG_TAG_MAX_LEN];   ///< Reception buffer
  62 } TagPacket;
  63
  64 void keytag_init(struct TagPacket *pkt, struct KFile *comm, struct KFile *tag);
  65 int keytag_recv(struct TagPacket *pkt, uint8_t *tag, size_t len);
  66
  67 DEPRECATED void keytag_poll(struct TagPacket *pkt);
  68
  69 #endif /* NET_TAG_H */