sci_internal_types.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef SCI_INTERNAL_TYPES_H
#define SCI_INTERNAL_TYPES_H
 
/*!***************************************************************************
 * @addtogroup  sci
 * @{
 *****************************************************************************/
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
#ifndef SCI_FRAME_SIZE
#define SCI_FRAME_SIZE      64
#endif
 
#ifndef SCI_FRAME_BUF_RX_CT
#define SCI_FRAME_BUF_RX_CT 32
#endif
 
#ifndef SCI_FRAME_BUF_TX_CT
#define SCI_FRAME_BUF_TX_CT 32
#endif
 
#ifndef SCI_TX_TIMEOUT_MSEC
#define SCI_TX_TIMEOUT_MSEC 1000
#endif
 
#define SCI_FRAME_BUF_CT (SCI_FRAME_BUF_RX_CT + SCI_FRAME_BUF_TX_CT)
 
/*!*****************************************************************************
 * @brief   Data buffer for outgoing frames.
 * @details A frame needs to be initialize with an data buffer and read/write
 *          pointers equal to zero.
 *          Status of the frame can be determined by the following conditions:
 *           - Idle: WrPtr == 0 && RdPtr == 0
 *           - Write/Read: WrPtr != 0 (|| RdPtr == 0)
 *           .
 *          The total amount of stored data is given by (size_t)(WrPtr - Buffer)
 *          The amount that is still to read is given by (size_t)(WrPtr - RdPtr)
 *
 *          \code
 *          Idle:
 *          Buffer:   0000000000000000
 *          Write:  | (0x00)
 *          Read:   | (0x00)
 *
 *
 *          Write:
 *          Buffer:   xxxxxxxx00000000
 *          Write:            |
 *          Read:     | (&Buffer)
 *
 *
 *          Read:
 *          Buffer:   0000xxxxxxxx0000
 *          Write:                |
 *          Read:         |
 *
 *          (0 = empty; x = full)
 *          \endcode
 *
 *          In order to accomplish flexible frame length, the frames might link
 *          to another frame which will be sent right after the current one has
 *          completely sent.
 ******************************************************************************/
typedef struct sci_frame_t
{
    uint8_t * WrPtr;
 
    uint8_t * RdPtr;
 
    uint8_t * Buffer;
 
    struct sci_frame_t * Next;
 
} sci_frame_t;
 
typedef struct sci_frame_queue_t
{
    sci_frame_t     *Buff;
 
    sci_frame_t     *Head;
 
    volatile size_t  Load;
 
    size_t           Size;
 
} sci_frame_queue_t;
 
#endif // SCI_INTERNAL_TYPES_H