4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
32 * \version $Id: pocketbus.h 20131 2007-12-13 17:39:55Z batt $
34 * \author Francesco Sacchi <batt@develer.com>
36 * \brief Basical functions to use pocketBus protocol.
38 * $WIZ$ module_name = "pocketbus"
39 * $WIZ$ module_depends = "rotating_hash", "kfile"
40 * $WIZ$ module_configuration = "bertos/cfg/cfg_pocketbus.h"
43 #ifndef NET_POCKETBUS_H
44 #define NET_POCKETBUS_H
46 #include "cfg/cfg_pocketbus.h" /* for CONFIG_POCKETBUS_BUFLEN */
47 #include <cfg/compiler.h>
49 #include <algo/rotating_hash.h>
53 #include <kern/kfile.h>
56 * pocketBus special characters definitions.
59 #define POCKETBUS_STX 0x02 //ASCII STX
60 #define POCKETBUS_ETX 0x03 //ASCII ETX
61 #define POCKETBUS_ESC 0x1B //ASCII ESC
62 #define POCKETBUS_ACK 0x06 //ASCII ACK
63 #define POCKETBUS_NAK 0x15 //ASCII NAK
66 #define POCKETBUS_BROADCAST_ADDR 0xFFFF ///< pocketBus broadcast address
69 * Type for pocketBus length.
71 typedef uint16_t pocketbus_len_t;
74 * Type for pocketBus addresses.
76 typedef uint16_t pocketbus_addr_t;
79 * Header of pocketBus messages.
81 typedef struct PocketBusHdr
83 #define POCKETBUS_VER 1
84 uint8_t ver; ///< packet version
85 pocketbus_addr_t addr; ///< slave address
89 * pocketBus context structure.
91 typedef struct PocketBusCtx
93 struct KFile *fd; ///< File descriptor
94 bool sync; ///< Status flag: true if we have received an STX, false otherwise
95 bool escape; ///< Status flag: true if we are in escape mode, false otherwise
96 rotating_t in_cks; ///< Checksum computation for received data.
97 rotating_t out_cks; ///< Checksum computation for transmitted data.
98 pocketbus_len_t len; ///< Received length
99 uint8_t buf[CONFIG_POCKETBUS_BUFLEN]; ///< receiving Buffer
103 * Structure holding pocketBus message parameters.
105 typedef struct PocketMsg
107 struct PocketBusCtx *ctx; ///< pocketBus message context
108 pocketbus_addr_t addr; ///< address for received packet
109 pocketbus_len_t len; ///< payload length
110 const uint8_t *payload; ///< payload data
114 * This ensure that endianess convertion functions work on
115 * the right data size.
118 STATIC_ASSERT(sizeof(pocketbus_addr_t) == sizeof(uint16_t));
119 STATIC_ASSERT(sizeof(rotating_t) == sizeof(uint16_t));
122 void pocketbus_putchar(struct PocketBusCtx *ctx, uint8_t c);
123 void pocketbus_begin(struct PocketBusCtx *ctx, pocketbus_addr_t addr);
124 void pocketbus_write(struct PocketBusCtx *ctx, const void *_data, size_t len);
125 void pocketbus_end(struct PocketBusCtx *ctx);
127 void pocketbus_send(struct PocketBusCtx *ctx, pocketbus_addr_t addr, const void *data, size_t len);
128 bool pocketbus_recv(struct PocketBusCtx *ctx, struct PocketMsg *msg);
129 void pocketbus_init(struct PocketBusCtx *ctx, struct KFile *fd);
131 #endif /* NET_POCKETBUS_H */