R_RTOS_msgQueuing.h

Go to the documentation of this file.

#ifndef HEADERS_R_RTOS_MSGQUEUING_H_
#define HEADERS_R_RTOS_MSGQUEUING_H_

#include "R_RTOS_inc.h"

#define MAX_MSGQ_SIZE   (uint8_t)0x8u

#define MAX_MSGQ_MSK    (uint8_t)(MAX_MSGQ_SIZE-(uint8_t)0x1u)

typedef enum partIDType
{
    PartID_TSK = (uint8_t) 0x0u, 
    PartID_SYS = (uint8_t) 0x1u  
} PartIDType;

typedef struct mqDummyElmnt
{
    void *element;                  
} MQDummyElmnt, *PMQDummyElmnt;

typedef struct mqPub
{
    volatile PTskTCB publisher;      
} MQPub, *PMQPub;

typedef PMQPub MQPubs;

typedef struct mqTskSub
{
    volatile PTskMB tskMailBox;             
} MQTskSub, *PMQTskSub;

typedef struct mqSysSub
{
    volatile PMsgFktCall msgCallBack;    
} MQSysSub, *PMQSysSub;

typedef struct mqSub
{
    union
    {
        MQTskSub tskSub;
        MQSysSub sysSub;
    } mqSubT; 
} MQSub, *PMQSub;

typedef PMQSub MQSubs;

typedef enum mqPrtcpntTypeEnum
{
    MQPrtcpnt_TskPub = (uint8_t) 0x1u,
    MQPrtcpnt_TskSub = (uint8_t) 0x3u,
    MQPrtcpnt_SysSub = (uint8_t) 0x4u 
} MQPrtcpntType;

typedef struct mqPrtcpnt
{
    struct mqPrtcpnt * nxtMQPrtcpnt;  
    PartID mqPrtcpntID; 
    MQPrtcpntType prtcpntType; 
    uint8_t DUMMY; 
    union
    {
        MQPub pub;
        MQSub sub;
        MQDummyElmnt dummy;
    } MQElmnt; 
} MQPrtcpnt, *PMQPrtcpnt;

typedef PMQPrtcpnt MQPrtcpnts;

typedef struct msgQ
{
    MQData dataQueue[MAX_MSGQ_SIZE ];    
    MQPrtcpnts pubs;               
    MQPrtcpnts subs;              
    QID queueID;                     
    uint8_t dataQueueStart;    
    uint8_t dataQueueEnd;            
    uint8_t subscbrCnt;              
    //uint8_t msgQSize; //Dynamic message queue sizing... instead of subscrbrCnt
} MsgQ, *PMsgQ;

RetCode msgQ_initQueue( QID msgQID);

RetCode msgQ_delQueue( const QID msgQID );

RetCode msgQ_regTskPub( PTskTCB const pubTsk, const QID msgQID );

RetCode msgQ_regSysPub( const uint8_t participant, const QID msgQID );

RetCode msgQ_regTskSub(
                        PTskTCB const subTsk,
                        const QID msgQID);

RetCode msgQ_regSysSub( const SysFktID subSysFktID, const QID msgQID );

RetCode msgQ_unSub( const QID msgQID, const uint16_t id );

RetCode msgQ_pubDataToQ(
                         const QID msgQID,
                         const DataSize size,
                         const DataType type,
                         CData const data );
RetCode msgQ_readDataFrmQ(
                           const QID msgQID,
                           const TskID tskID,
                           PMQData * data );

RetCode msgQ_takeDataFrmQ(
                           const QID msgQID,
                           const TskID tskID,
                           PMQData * data );

#endif /* HEADERS_R_RTOS_MSGQUEUING_H_ */