updated C code, added timeouts etc, not tested!

pull/9/head
Ondřej Hruška 7 years ago
parent c7f4e2c6f9
commit b6532962a4
  1. 249
      TinyFrame.c
  2. 34
      TinyFrame.h

@ -20,9 +20,12 @@ enum TFState {
TFState_DATA_CKSUM //!< Wait for Checksum
};
typedef struct _IdListener_struct {
typedef struct _IdListener_struct_ {
TF_ID id;
TF_LISTENER fn;
unsigned int timeout; // nr of ticks remaining to disable this listener
unsigned int timeout_max; // the original timeout is stored here
void *userdata;
} IdListener;
typedef struct _TypeListener_struct_ {
@ -37,17 +40,17 @@ typedef struct _GenericListener_struct_ {
/**
* Frame parser internal state
*/
static struct TinyFrameStruct {
static struct TinyFrameInstance {
/* Own state */
TF_PEER peer_bit; //!< Own peer bit (unqiue to avoid msg ID clash)
TF_ID next_id; //!< Next frame / frame chain ID
/* Parser state */
enum TFState state;
unsigned int parser_timeout_ticks;
TF_TICKS parser_timeout_ticks;
TF_ID id; //!< Incoming packet ID
TF_LEN len; //!< Payload length
uint8_t data[TF_MAX_PAYLOAD]; //!< Data byte buffer
uint8_t data[TF_MAX_PAYLOAD_RX]; //!< Data byte buffer
size_t rxi; //!< Byte counter
TF_CKSUM cksum; //!< Checksum calculated of the data stream
TF_CKSUM ref_cksum; //!< Reference checksum read from the message
@ -61,34 +64,37 @@ static struct TinyFrameStruct {
TypeListener type_listeners[TF_MAX_TYPE_LST];
GenericListener generic_listeners[TF_MAX_GEN_LST];
// Those counters are used to optimize look-up times.
// They point to the highest used slot number,
// or close to it, depending on the removal order.
size_t count_id_lst;
size_t count_type_lst;
size_t count_generic_lst;
// Buffer for building frames
uint8_t sendbuf[TF_MAX_PAYLOAD + TF_OVERHEAD_BYTES];
uint8_t sendbuf[TF_MAX_PAYLOAD_TX + TF_OVERHEAD_BYTES]; // TODO generate and send frames without a buffer
} tf;
//region Checksums
#if TF_CKSUM_TYPE == 0
// NONE
#define CKSUM_RESET(cksum)
#define CKSUM_ADD(cksum, byte)
#define CKSUM_FINALIZE(cksum)
// NONE
#define CKSUM_RESET(cksum)
#define CKSUM_ADD(cksum, byte)
#define CKSUM_FINALIZE(cksum)
#elif TF_CKSUM_TYPE == 8
// ~XOR
#define CKSUM_RESET(cksum) do { cksum = 0; } while (0)
#define CKSUM_ADD(cksum, byte) do { cksum ^= byte; } while(0)
#define CKSUM_FINALIZE(cksum) do { cksum = (TF_CKSUM)~cksum; } while(0)
// ~XOR
#define CKSUM_RESET(cksum) do { cksum = 0; } while (0)
#define CKSUM_ADD(cksum, byte) do { cksum ^= byte; } while(0)
#define CKSUM_FINALIZE(cksum) do { cksum = (TF_CKSUM)~cksum; } while(0)
#elif TF_CKSUM_TYPE == 16
/** CRC table for the CRC-16. The poly is 0x8005 (x^16 + x^15 + x^2 + 1) */
static const uint16_t crc16_table[256] = {
/** CRC table for the CRC-16. The poly is 0x8005 (x^16 + x^15 + x^2 + 1) */
static const uint16_t crc16_table[256] = {
0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
@ -121,20 +127,20 @@ static const uint16_t crc16_table[256] = {
0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040
};
};
static inline uint16_t crc16_byte(uint16_t cksum, const uint8_t byte)
{
static inline uint16_t crc16_byte(uint16_t cksum, const uint8_t byte)
{
return (cksum >> 8) ^ crc16_table[(cksum ^ byte) & 0xff];
}
}
#define CKSUM_RESET(cksum) do { cksum = 0; } while (0)
#define CKSUM_ADD(cksum, byte) do { cksum = crc16_byte(cksum, byte); } while(0)
#define CKSUM_FINALIZE(cksum)
#define CKSUM_RESET(cksum) do { cksum = 0; } while (0)
#define CKSUM_ADD(cksum, byte) do { cksum = crc16_byte(cksum, byte); } while(0)
#define CKSUM_FINALIZE(cksum)
#elif TF_CKSUM_TYPE == 32
static const uint32_t crc32_table[] = { /* CRC polynomial 0xedb88320 */
static const uint32_t crc32_table[] = { /* CRC polynomial 0xedb88320 */
0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
@ -178,16 +184,16 @@ static const uint32_t crc32_table[] = { /* CRC polynomial 0xedb88320 */
0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
};
};
static inline uint32_t crc32_byte(uint32_t cksum, const uint8_t byte)
{
static inline uint32_t crc32_byte(uint32_t cksum, const uint8_t byte)
{
return (crc32_table[((cksum) ^ ((uint8_t)byte)) & 0xff] ^ ((cksum) >> 8));
}
}
#define CKSUM_RESET(cksum) do { cksum = (TF_CKSUM)0xFFFFFFFF; } while (0)
#define CKSUM_ADD(cksum, byte) do { cksum = crc32_byte(cksum, byte); } while(0)
#define CKSUM_FINALIZE(cksum) do { cksum = (TF_CKSUM)~cksum; } while(0)
#define CKSUM_RESET(cksum) do { cksum = (TF_CKSUM)0xFFFFFFFF; } while (0)
#define CKSUM_ADD(cksum, byte) do { cksum = crc32_byte(cksum, byte); } while(0)
#define CKSUM_FINALIZE(cksum) do { cksum = (TF_CKSUM)~cksum; } while(0)
#endif
@ -204,13 +210,17 @@ void _TF_FN TF_Init(TF_PEER peer_bit)
//region Listeners
bool _TF_FN TF_AddIdListener(TF_ID frame_id, TF_LISTENER cb)
bool _TF_FN TF_AddIdListener(TF_MSG *msg, TF_LISTENER cb, TF_TICKS timeout)
{
size_t i;
IdListener *lst;
for (i = 0; i < TF_MAX_ID_LST; i++) {
if (tf.id_listeners[i].fn == NULL) {
tf.id_listeners[i].fn = cb;
tf.id_listeners[i].id = frame_id;
lst = &tf.id_listeners[i];
if (lst->fn == NULL) {
lst->fn = cb;
lst->id = msg->frame_id;
lst->userdata = msg->userdata;
lst->timeout_max = lst->timeout = timeout;
if (i >= tf.count_id_lst) {
tf.count_id_lst = i + 1;
}
@ -223,10 +233,12 @@ bool _TF_FN TF_AddIdListener(TF_ID frame_id, TF_LISTENER cb)
bool _TF_FN TF_AddTypeListener(TF_TYPE frame_type, TF_LISTENER cb)
{
size_t i;
TypeListener *lst;
for (i = 0; i < TF_MAX_TYPE_LST; i++) {
if (tf.type_listeners[i].fn == NULL) {
tf.type_listeners[i].fn = cb;
tf.type_listeners[i].type = frame_type;
lst = &tf.type_listeners[i];
if (lst->fn == NULL) {
lst->fn = cb;
lst->type = frame_type;
if (i >= tf.count_type_lst) {
tf.count_type_lst = i + 1;
}
@ -239,9 +251,11 @@ bool _TF_FN TF_AddTypeListener(TF_TYPE frame_type, TF_LISTENER cb)
bool _TF_FN TF_AddGenericListener(TF_LISTENER cb)
{
size_t i;
GenericListener *lst;
for (i = 0; i < TF_MAX_GEN_LST; i++) {
if (tf.generic_listeners[i].fn == NULL) {
tf.generic_listeners[i].fn = cb;
lst = &tf.generic_listeners[i];
if (lst->fn == NULL) {
lst->fn = cb;
if (i >= tf.count_generic_lst) {
tf.count_generic_lst = i + 1;
}
@ -254,10 +268,11 @@ bool _TF_FN TF_AddGenericListener(TF_LISTENER cb)
bool _TF_FN TF_RemoveIdListener(TF_ID frame_id)
{
size_t i;
IdListener *lst;
for (i = 0; i < tf.count_id_lst; i++) {
if (tf.id_listeners[i].fn != NULL
&& tf.id_listeners[i].id == frame_id) {
tf.id_listeners[i].fn = NULL;
lst = &tf.id_listeners[i];
if (lst->fn != NULL && lst->id == frame_id) {
lst->fn = NULL;
if (i == tf.count_id_lst - 1) {
tf.count_id_lst--;
}
@ -270,10 +285,11 @@ bool _TF_FN TF_RemoveIdListener(TF_ID frame_id)
bool _TF_FN TF_RemoveTypeListener(TF_TYPE type)
{
size_t i;
TypeListener *lst;
for (i = 0; i < tf.count_type_lst; i++) {
if (tf.type_listeners[i].fn != NULL
&& tf.type_listeners[i].type == type) {
tf.type_listeners[i].fn = NULL;
lst = &tf.type_listeners[i];
if (lst->fn != NULL && lst->type == type) {
lst->fn = NULL;
if (i == tf.count_type_lst - 1) {
tf.count_type_lst--;
}
@ -286,9 +302,11 @@ bool _TF_FN TF_RemoveTypeListener(TF_TYPE type)
bool _TF_FN TF_RemoveGenericListener(TF_LISTENER cb)
{
size_t i;
GenericListener *lst;
for (i = 0; i < tf.count_generic_lst; i++) {
if (tf.generic_listeners[i].fn == cb) {
tf.generic_listeners[i].fn = NULL;
lst = &tf.generic_listeners[i];
if (lst->fn == cb) {
lst->fn = NULL;
if (i == tf.count_generic_lst - 1) {
tf.count_generic_lst--;
}
@ -299,9 +317,20 @@ bool _TF_FN TF_RemoveGenericListener(TF_LISTENER cb)
}
/** Handle a message that was just collected & verified by the parser */
static void _TF_FN TF_HandleReceivedMessage(TF_ID frame_id, TF_TYPE type, uint8_t *data, TF_LEN data_len)
static void _TF_FN TF_HandleReceivedMessage(void)
{
size_t i;
IdListener *ilst;
TypeListener *tlst;
GenericListener *glst;
// Prepare message object
TF_MSG msg;
msg.frame_id = tf.id;
msg.is_response = false;
msg.type = tf.type;
msg.data = tf.data;
msg.len = tf.len;
// Any listener can consume the message (return true),
// or let someone else handle it.
@ -311,28 +340,28 @@ static void _TF_FN TF_HandleReceivedMessage(TF_ID frame_id, TF_TYPE type, uint8_
// ID listeners first
for (i = 0; i < tf.count_id_lst; i++) {
if (tf.id_listeners[i].fn && (tf.id_listeners[i].id == frame_id)) {
if (tf.id_listeners[i].fn(frame_id, type, data, data_len)) {
return;
}
ilst = &tf.id_listeners[i];
if (ilst->fn && ilst->id == frame_id) {
msg.userdata = ilst->userdata;
if (ilst->fn(&msg)) return;
}
}
msg.userdata = NULL;
// clean up for the following listeners that don't use userdata
// Type listeners
for (i = 0; i < tf.count_type_lst; i++) {
if (tf.type_listeners[i].fn && (tf.type_listeners[i].type == type)) {
if (tf.type_listeners[i].fn(frame_id, type, data, data_len)) {
return;
}
tlst = &tf.type_listeners[i];
if (tlst->fn && tlst->type == type) {
if (tlst->fn(&msg)) return;
}
}
// Generic listeners
for (i = 0; i < tf.count_generic_lst; i++) {
if (tf.generic_listeners[i].fn) {
if (tf.generic_listeners[i].fn(frame_id, type, data, data_len)) {
return;
}
glst = &tf.generic_listeners[i];
if (glst->fn) {
if (glst->fn(&msg)) return;
}
}
}
@ -369,7 +398,7 @@ static void _TF_FN TF_ParsBeginFrame(void) {
void _TF_FN TF_AcceptChar(unsigned char c)
{
// Timeout - clear
// Parser timeout - clear
if (tf.parser_timeout_ticks >= TF_PARSER_TIMEOUT_TICKS) {
TF_ResetParser();
}
@ -436,7 +465,7 @@ void _TF_FN TF_AcceptChar(unsigned char c)
}
if (tf.len == 0) {
TF_HandleReceivedMessage(tf.id, tf.type, NULL, 0);
TF_HandleReceivedMessage();
TF_ResetParser();
break;
}
@ -465,7 +494,7 @@ void _TF_FN TF_AcceptChar(unsigned char c)
if (tf.rxi == tf.len) {
#if TF_CKSUM_TYPE == 0
// All done
TF_HandleReceivedMessage(tf.id, tf.type, tf.data, tf.len);
TF_HandleReceivedMessage();
TF_ResetParser();
#else
// Enter DATA_CKSUM state
@ -481,7 +510,7 @@ void _TF_FN TF_AcceptChar(unsigned char c)
// Check the header checksum against the computed value
CKSUM_FINALIZE(tf.cksum);
if (!tf.discard_data && tf.cksum == tf.ref_cksum) {
TF_HandleReceivedMessage(tf.id, tf.type, tf.data, tf.len);
TF_HandleReceivedMessage();
}
TF_ResetParser();
@ -503,7 +532,7 @@ void _TF_FN TF_AcceptChar(unsigned char c)
* @param use_expl_id - whether to use the previous param
* @return nr of bytes in outbuff used by the frame, TF_ERROR (-1) on failure
*/
static int _TF_FN TF_Compose(uint8_t *outbuff, TF_ID *id_ptr,
static inline int _TF_FN TF_Compose(uint8_t *outbuff, TF_ID *id_ptr,
TF_TYPE type,
const uint8_t *data, TF_LEN data_len,
TF_ID explicit_id, bool use_expl_id)
@ -584,73 +613,73 @@ static int _TF_FN TF_Compose(uint8_t *outbuff, TF_ID *id_ptr,
return pos;
}
bool _TF_FN TF_Send(TF_TYPE type,
const uint8_t *payload, TF_LEN payload_len,
TF_LISTENER listener,
TF_ID *id_ptr)
bool _TF_FN TF_Send(TF_MSG *msg, TF_LISTENER listener, TF_TICKS timeout)
{
TF_ID msgid = 0;
int len;
len = TF_Compose(tf.sendbuf, &msgid, type, payload, payload_len, 0, false);
len = TF_Compose(tf.sendbuf,
&msg->frame_id,
msg->type,
msg->data,
msg->len,
msg->frame_id,
msg->is_response);
if (len == TF_ERROR) return false;
if (listener) TF_AddIdListener(msgid, listener);
if (id_ptr) *id_ptr = msgid;
if (listener) TF_AddIdListener(msg->frame_id, listener);
TF_WriteImpl((const uint8_t *) tf.sendbuf, (TF_LEN)len);
return true;
}
// Like TF_Send, but with explicit frame ID
bool _TF_FN TF_Respond(TF_TYPE type,
const uint8_t *data, TF_LEN data_len,
TF_ID frame_id)
bool _TF_FN TF_Respond(TF_MSG *msg, bool renew)
{
int len;
len = TF_Compose(tf.sendbuf, NULL, type, data, data_len, frame_id, true);
if (len == TF_ERROR) return false;
msg->is_response = true;
bool suc = TF_Send(msg, NULL, 0);
TF_WriteImpl(tf.sendbuf, (TF_LEN)len);
return true;
if (suc && renew) TF_RenewIdListener(msg->frame_id);
return suc;
}
/**
* Like TF_Send(), but with no data
*/
bool _TF_FN TF_Send0(TF_TYPE type,
TF_LISTENER listener,
TF_ID *id_ptr)
bool _TF_FN TF_RenewIdListener(TF_ID id)
{
return TF_Send(type, NULL, 0, listener, id_ptr);
}
/**
* Like TF_Send(), but with just 1 data byte
*/
bool _TF_FN TF_Send1(TF_TYPE type, uint8_t b1,
TF_LISTENER listener,
TF_ID *id_ptr)
{
unsigned char b[] = {b1};
return TF_Send(type, b, 1, listener, id_ptr);
}
/**
* Like TF_Send(), but with just 2 data bytes
*/
bool _TF_FN TF_Send2(TF_TYPE type, uint8_t b1, uint8_t b2,
TF_LISTENER listener,
TF_ID *id_ptr)
{
unsigned char b[] = {b1, b2};
return TF_Send(type, b, 2, listener, id_ptr);
IdListener *lst;
for (i = 0; i < tf.count_id_lst; i++) {
lst = &tf.id_listeners[i];
if (lst->fn && lst->id == id) {
lst->timeout = lst->timeout_max;
return true;
}
}
return false;
}
/** Timebase hook - for timeouts */
void _TF_FN TF_Tick(void)
{
int i;
TF_MSG msg;
IdListener *lst;
// increment parser timeout (timeout is handled when receiving next byte)
if (tf.parser_timeout_ticks < TF_PARSER_TIMEOUT_TICKS) {
tf.parser_timeout_ticks++;
}
// decrement and expire ID listeners
for (i = 0; i < tf.count_id_lst; i++) {
lst = &tf.id_listeners[i];
if (lst->fn && lst->timeout > 0) {
if (--lst->timeout != 0) continue;
// Notify listener about timeout
msg.userdata = lst->userdata;
msg.data = NULL; // this is a signal that listener should clean up
lst->fn(msg);
lst->fn = NULL; // Discard listener
}
}
}

@ -14,7 +14,8 @@
// Maximum send / receive payload size (static buffers size)
// Larger payloads will be rejected.
#define TF_MAX_PAYLOAD 1024
#define TF_MAX_PAYLOAD_RX 1024
#define TF_MAX_PAYLOAD_TX 1024
// --- Listener counts - determine sizes of the static slot tables ---
@ -57,6 +58,7 @@
//------------------------- End of user config ------------------------------
typedef unsigned int TF_TICKS;
//region Resolve data types
@ -138,12 +140,12 @@ typedef enum {
/** Data structure for sending / receiving messages */
typedef struct {
TF_ID frame_id, // message ID
bool is_response, // internal flag, set when using the Respond function. frame_id is then kept unchanged.
TF_TYPE type, // received or sent message type
const uint8_t *data, // buffer of received data or data to send. NULL = listener timed out, free userdata!
TF_LEN len, // length of the buffer
void *userdata // here's a place for custom data; this data will be
TF_ID frame_id; // message ID
bool is_response; // internal flag, set when using the Respond function. frame_id is then kept unchanged.
TF_TYPE type; // received or sent message type
const uint8_t *data; // buffer of received data or data to send. NULL = listener timed out, free userdata!
TF_LEN len; // length of the buffer
void *userdata; // here's a place for custom data; this data will be
// stored with the listener
} TF_MSG;
@ -188,11 +190,12 @@ void TF_ResetParser(void);
/**
* Register a frame type listener.
*
* @param frame_type - frame ID to listen for
* @param msg - message (contains frame_id and userdata)
* @param cb - callback
* @param timeout - timeout in ticks to auto-remove the listener (0 = keep forever)
* @return slot index (for removing), or TF_ERROR (-1)
*/
bool TF_AddIdListener(TF_ID frame_id, TF_LISTENER cb);
bool TF_AddIdListener(TF_MSG *msg, TF_LISTENER cb, TF_TICKS timeout);
/**
* Remove a listener by the message ID it's registered for
@ -240,15 +243,24 @@ bool TF_RemoveGenericListener(TF_LISTENER cb);
* @param timeout - listener expiry time in ticks
* @return success
*/
bool TF_Send(TF_MSG *msg, TF_LISTENER listener, unsigned int timeout);
bool TF_Send(TF_MSG *msg, TF_LISTENER listener, TF_TICKS timeout);
/**
* Send a response to a received message.
*
* @param msg - message struct. ID is read from frame_id
* @param renew - renew the listener timeout (waiting for more data)
* @return success
*/
bool TF_Respond(TF_MSG *msg);
bool TF_Respond(TF_MSG *msg, bool renew);
/**
* Renew ID listener timeout
*
* @param id - listener ID to renew
* @return true if listener was found and renewed
*/
bool TF_RenewIdListener(TF_ID id);
/**
* Accept incoming bytes & parse frames

Loading…
Cancel
Save