/**
* \file
* <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction. Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License. This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
* Copyright 2007 Develer S.r.l. (http://www.develer.com/)
* -->
*
- * \version $Id: pocketbus.h 20131 2007-12-13 17:39:55Z batt $
*
* \author Francesco Sacchi <batt@develer.com>
*
- * \brief pocketBus protocol interface.
+ * \brief Basical functions to use pocketBus protocol.
+ *
+ * $WIZ$ module_name = "pocketbus"
+ * $WIZ$ module_depends = "rotating_hash", "kfile"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_pocketbus.h"
*/
#ifndef NET_POCKETBUS_H
#define NET_POCKETBUS_H
-#include <algos/rotating_hash.h>
-#include <drv/ser.h>
-#include <kern/kfile.h>
+#include "cfg/cfg_pocketbus.h" /* for CONFIG_POCKETBUS_BUFLEN */
#include <cfg/compiler.h>
-#include "appconfig.h" //for CONFIG_POCKETBUS_BUFLEN
+
+#include <algo/rotating_hash.h>
+
+#include <io/kfile.h>
/**
* pocketBus special characters definitions.
*/
typedef struct PocketBusHdr
{
- #define POCKETBUS_VER 1
+ #define POCKETBUS_VER 1
uint8_t ver; ///< packet version
pocketbus_addr_t addr; ///< slave address
} PocketBusHdr;
*/
typedef struct PocketBusCtx
{
+ uint8_t buf[CONFIG_POCKETBUS_BUFLEN]; ///< receiving Buffer
struct KFile *fd; ///< File descriptor
bool sync; ///< Status flag: true if we have received an STX, false otherwise
bool escape; ///< Status flag: true if we are in escape mode, false otherwise
rotating_t in_cks; ///< Checksum computation for received data.
rotating_t out_cks; ///< Checksum computation for transmitted data.
pocketbus_len_t len; ///< Received length
- uint8_t buf[CONFIG_POCKETBUS_BUFLEN]; ///< receiving Buffer
} PocketBusCtx;
+STATIC_ASSERT(offsetof(PocketBusCtx, buf) == 0);
/**
* Structure holding pocketBus message parameters.
*/
{
struct PocketBusCtx *ctx; ///< pocketBus message context
pocketbus_addr_t addr; ///< address for received packet
- pocketbus_len_t len; ///< payload length
+ pocketbus_len_t len; ///< payload length
const uint8_t *payload; ///< payload data
} PocketMsg;