BoapMc1.h

Go to the documentation of this file.

/*******************************************************************************
 *  BoapMc1.h   BoapMc1 RPC protocol
 *  T.Barnaby,  BEAM Ltd,   2018-06-21
 *  Copyright (c) 2022 All Right Reserved, Beam Ltd, https://www.beam.ltd.uk
 *  For license see LICENSE.txt at the root of the beamlib source tree.
 *******************************************************************************
 */
#ifndef BoapMc1_h
#define BoapMc1_h
 
#include <BTypes.h>
#include <BMutex.h>
#include <BSemaphore.h>
#include <BQueue.h>
#include <BFifo.h>
#include <BComms.h>
 
// Main BOAP Types
const BUInt16   BoapMc1Magic    = 0x5542;
enum BoapMc1Type        { BoapMc1TypeRequest = 0x0000, BoapMc1TypeReply = 0x8000 };
 
// BoapMc1 packet header
struct BoapMc1PacketHead {
    BUInt16     magic;              
    BUInt16     length;             
    BUInt16     addressTo;          
    BUInt16     addressFrom;            
    BUInt16     cmd;                
    BInt16      error;              
    BUInt32     checksum;           
} __attribute__((aligned(8),packed));
 
// BoapMc1 packet
class BoapMc1Packet {
public:
    BoapMc1PacketHead   head;
    char            data[8];
} __attribute__((aligned(8),packed));
 
struct BoapMc1Error {
    BInt16      number;             
    char        string[32];         
} __attribute__((aligned(8),packed));
 
inline BUInt32 boapMc1CommsRoundupLen(BUInt32 len){
    return ((len + 3) & ~3);
}
 
/*******************************************************************************
 *  Base for bidirectional communications objects
 *******************************************************************************
 */
 
class BoapMc1Comms {
public:
            BoapMc1Comms(Bool threaded = 0, BUInt reqSize = 512);
    virtual     ~BoapMc1Comms();
 
    void        setCommsMode(Bool halfDuplex);              
    void        setComms(BComms& comms);                
    void        setComms(BComms* comms);                
    void        setAddress(BUInt16 addressTo, BUInt16 addressFrom); 
    BUInt32     getApiVersion();                    
    BUInt32     setTimeout(BUInt32 timeoutUs);              
 
    virtual BError  validate();                     
    BoapMc1Packet*  packetRx();                     
 
    virtual BError  processRx();                        
 
protected:
    // Communications functions
    virtual BError      processRequests();              
    virtual BError      processRequest();               
 
    BError          packetTx(BDataChunk* chunks, BUInt nChunks, BUInt16 waitCmdReply);
 
#ifdef ZAP_IDEAS
    BError          packetRxWait(BUInt num, char** data);       
    BError          packetRxWait(BUInt16 cmd);
#endif
 
    BError          packetRxData(void* data, BUInt nBytes);
    BError          packetRxEnd();
 
    Bool            othreaded;              
    BUInt32         oreqSize;               
    BMutex          olockCall;              
    BMutex          olockTx;                
    BComms*         ocomms;
    BUInt32         oapiVersion;
    Bool            ohalfDuplex;                
    BUInt32         otimeout;               
    BUInt16         oaddressTo;
    BUInt16         oaddressFrom;
 
    BoapMc1Packet       opacketRxBase;
    BoapMc1Packet*      opacketRx;              
    BoapMc1Packet       opacketTxBase;
    BoapMc1Packet*      opacketTx;              
    BUInt           opacketRpcCmd;              
    BSemaphore      opacketRpcSema;             
    BSemaphore      opacketRpcDoneSema;         
    BoapMc1Error        oerror;                 
};
 
 
#endif