CO_fifo.h

Go to the documentation of this file.

 
#ifndef CO_FIFO_H
#define CO_FIFO_H
 
#include "301/CO_driver.h"
 
/* default configuration, see CO_config.h */
#ifndef CO_CONFIG_FIFO
#define CO_CONFIG_FIFO (0)
#endif
 
#if ((CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ENABLE) || defined CO_DOXYGEN
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    char *buf;
    size_t bufSize;
    size_t writePtr;
    size_t readPtr;
#if ((CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ALT_READ) || defined CO_DOXYGEN
 
    size_t altReadPtr;
#endif
#if ((CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ASCII_DATATYPES) || defined CO_DOXYGEN
 
    bool_t started;
    uint32_t aux;
#endif
} CO_fifo_t;
 
 
 
void CO_fifo_init(CO_fifo_t *fifo, char *buf, size_t bufSize);
 
 
static inline void CO_fifo_reset(CO_fifo_t *fifo) {
    if (fifo != NULL) {
        fifo->readPtr = 0;
        fifo->writePtr = 0;
#if (CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ASCII_DATATYPES
        fifo->started = false;
#endif
    }
 
    return;
}
 
 
static inline bool_t CO_fifo_purge(CO_fifo_t *fifo) {
    if (fifo != NULL && fifo->readPtr != fifo->writePtr) {
        fifo->readPtr = 0;
        fifo->writePtr = 0;
        return true;
    }
 
    return false;
}
 
 
static inline size_t CO_fifo_getSpace(CO_fifo_t *fifo) {
    int sizeLeft = (int)fifo->readPtr - fifo->writePtr - 1;
    if (sizeLeft < 0) {
        sizeLeft += fifo->bufSize;
    }
 
    return (size_t) sizeLeft;
}
 
 
static inline size_t CO_fifo_getOccupied(CO_fifo_t *fifo) {
    int sizeOccupied = (int)fifo->writePtr - fifo->readPtr;
    if (sizeOccupied < 0) {
        sizeOccupied += fifo->bufSize;
    }
 
    return (size_t) sizeOccupied;
}
 
 
static inline bool_t CO_fifo_putc(CO_fifo_t *fifo, const char c) {
    if (fifo != NULL && fifo->buf != NULL) {
        size_t writePtrNext = fifo->writePtr + 1;
        if (writePtrNext != fifo->readPtr &&
            !(writePtrNext == fifo->bufSize && fifo->readPtr == 0))
        {
            fifo->buf[fifo->writePtr] = c;
            fifo->writePtr = (writePtrNext == fifo->bufSize) ? 0 : writePtrNext;
            return true;
        }
    }
    return false;
}
 
 
static inline void CO_fifo_putc_ov(CO_fifo_t *fifo, const char c) {
    if (fifo != NULL && fifo->buf != NULL) {
        fifo->buf[fifo->writePtr] = c;
 
        if (++fifo->writePtr == fifo->bufSize) fifo->writePtr = 0;
        if (fifo->readPtr == fifo->writePtr) {
            if (++fifo->readPtr == fifo->bufSize) fifo->readPtr = 0;
        }
    }
}
 
 
static inline bool_t CO_fifo_getc(CO_fifo_t *fifo, char *buf) {
    if (fifo != NULL && buf != NULL && fifo->readPtr != fifo->writePtr) {
        *buf = fifo->buf[fifo->readPtr];
        if (++fifo->readPtr == fifo->bufSize) {
            fifo->readPtr = 0;
        }
        return true;
    }
    return false;
}
 
 
size_t CO_fifo_write(CO_fifo_t *fifo,
                     const char *buf,
                     size_t count,
                     uint16_t *crc);
 
 
size_t CO_fifo_read(CO_fifo_t *fifo, char *buf, size_t count, bool_t *eof);
 
 
#if ((CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ALT_READ) || defined CO_DOXYGEN
 
size_t CO_fifo_altBegin(CO_fifo_t *fifo, size_t offset);
 
 
void CO_fifo_altFinish(CO_fifo_t *fifo, uint16_t *crc);
 
 
static inline size_t CO_fifo_altGetOccupied(CO_fifo_t *fifo) {
    int sizeOccupied = (int)fifo->writePtr - fifo->altReadPtr;
    if (sizeOccupied < 0) {
        sizeOccupied += fifo->bufSize;
    }
 
    return (size_t) sizeOccupied;
}
 
 
size_t CO_fifo_altRead(CO_fifo_t *fifo, char *buf, size_t count);
#endif /* #if (CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ALT_READ */
 
 
#if ((CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ASCII_COMMANDS) || defined CO_DOXYGEN
 
bool_t CO_fifo_CommSearch(CO_fifo_t *fifo, bool_t clear);
 
 
bool_t CO_fifo_trimSpaces(CO_fifo_t *fifo, bool_t *insideComment);
 
 
size_t CO_fifo_readToken(CO_fifo_t *fifo,
                         char *buf,
                         size_t count,
                         char *closed,
                         bool_t *err);
#endif /* (CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ASCII_COMMANDS */
 
 
#if ((CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ASCII_DATATYPES) || defined CO_DOXYGEN
 
size_t CO_fifo_readU82a (CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readU162a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readU322a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readU642a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readX82a (CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readX162a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readX322a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readX642a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readI82a (CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readI162a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readI322a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readI642a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readR322a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readR642a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readHex2a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readVs2a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
size_t CO_fifo_readB642a(CO_fifo_t *fifo, char *buf, size_t count, bool_t end);
 
 
typedef enum {
    CO_fifo_st_closed  = 0x01U,
    CO_fifo_st_partial = 0x02U,
    CO_fifo_st_errTok  = 0x10U,
    CO_fifo_st_errVal  = 0x20U,
    CO_fifo_st_errBuf  = 0x40U,
    CO_fifo_st_errInt  = 0x80U,
    CO_fifo_st_errMask = 0xF0U
} CO_fifo_st;
 
size_t CO_fifo_cpyTok2U8 (CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2U16(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2U32(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2U64(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2I8 (CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2I16(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2I32(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2I64(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2R32(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2R64(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2Hex(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2Vs(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
size_t CO_fifo_cpyTok2B64(CO_fifo_t *dest, CO_fifo_t *src, CO_fifo_st *status);
 
#endif /* (CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ASCII_DATATYPES */
 /* CO_CANopen_301_fifo */
 
#ifdef __cplusplus
}
#endif /*__cplusplus*/
 
#endif /* (CO_CONFIG_FIFO) & CO_CONFIG_FIFO_ENABLE */
 
#endif /* CO_FIFO_H */