bertos/net/pocketbus.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 2007 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  * \version $Id$
  33  *
  34  * \author Francesco Sacchi <batt@develer.com>
  35  *
  36  * \brief Basical functions to use pocketBus protocol.
  37  *
  38  * $WIZ$ module_name = "pocketbus"
  39  * $WIZ$ module_depends = "rotating_hash", "kfile"
  40  * $WIZ$ module_configuration = "bertos/cfg/cfg_pocketbus.h"
  41  */
  42
  43 #ifndef NET_POCKETBUS_H
  44 #define NET_POCKETBUS_H
  45
  46 #include "cfg/cfg_pocketbus.h"        /* for CONFIG_POCKETBUS_BUFLEN */
  47 #include <cfg/compiler.h>
  48
  49 #include <algo/rotating_hash.h>
  50
  51 #include <io/kfile.h>
  52
  53 /**
  54  * pocketBus special characters definitions.
  55  * \{
  56  */
  57 #define POCKETBUS_STX 0x02 //ASCII STX
  58 #define POCKETBUS_ETX 0x03 //ASCII ETX
  59 #define POCKETBUS_ESC 0x1B //ASCII ESC
  60 #define POCKETBUS_ACK 0x06 //ASCII ACK
  61 #define POCKETBUS_NAK 0x15 //ASCII NAK
  62 /*\}*/
  63
  64 #define POCKETBUS_BROADCAST_ADDR 0xFFFF ///< pocketBus broadcast address
  65
  66 /**
  67  * Type for pocketBus length.
  68  */
  69 typedef uint16_t pocketbus_len_t;
  70
  71 /**
  72  * Type for pocketBus addresses.
  73  */
  74 typedef uint16_t pocketbus_addr_t;
  75
  76 /**
  77  * Header of pocketBus messages.
  78  */
  79 typedef struct PocketBusHdr
  80 {
  81         #define POCKETBUS_VER 1
  82         uint8_t ver;   ///< packet version
  83         pocketbus_addr_t addr; ///< slave address
  84 } PocketBusHdr;
  85
  86 /**
  87  * pocketBus context structure.
  88  */
  89 typedef struct PocketBusCtx
  90 {
  91         uint8_t buf[CONFIG_POCKETBUS_BUFLEN]; ///< receiving Buffer
  92         struct KFile *fd;   ///< File descriptor
  93         bool sync;           ///< Status flag: true if we have received an STX, false otherwise
  94         bool escape;         ///< Status flag: true if we are in escape mode, false otherwise
  95         rotating_t in_cks;   ///< Checksum computation for received data.
  96         rotating_t out_cks;  ///< Checksum computation for transmitted data.
  97         pocketbus_len_t len; ///< Received length
  98 } PocketBusCtx;
  99
 100 STATIC_ASSERT(offsetof(PocketBusCtx, buf) == 0);
 101 /**
 102  * Structure holding pocketBus message parameters.
 103  */
 104 typedef struct PocketMsg
 105 {
 106         struct PocketBusCtx *ctx; ///< pocketBus message context
 107         pocketbus_addr_t addr;    ///< address for received packet
 108         pocketbus_len_t len;      ///< payload length
 109         const uint8_t *payload;   ///< payload data
 110 } PocketMsg;
 111
 112 /**
 113  * This ensure that endianess convertion functions work on
 114  * the right data size.
 115  * \{
 116  */
 117 STATIC_ASSERT(sizeof(pocketbus_addr_t) == sizeof(uint16_t));
 118 STATIC_ASSERT(sizeof(rotating_t) == sizeof(uint16_t));
 119 /*\}*/
 120
 121 void pocketbus_putchar(struct PocketBusCtx *ctx, uint8_t c);
 122 void pocketbus_begin(struct PocketBusCtx *ctx, pocketbus_addr_t addr);
 123 void pocketbus_write(struct PocketBusCtx *ctx, const void *_data, size_t len);
 124 void pocketbus_end(struct PocketBusCtx *ctx);
 125
 126 void pocketbus_send(struct PocketBusCtx *ctx, pocketbus_addr_t addr, const void *data, size_t len);
 127 bool pocketbus_recv(struct PocketBusCtx *ctx, struct PocketMsg *msg);
 128 void pocketbus_init(struct PocketBusCtx *ctx, struct KFile *fd);
 129
 130 #endif /* NET_POCKETBUS_H */