sbgEComProtocol.c

Go to the documentation of this file.

#include "sbgEComProtocol.h"
#include <crc/sbgCrc.h>

//----------------------------------------------------------------------//
//- Communication protocol operations                                  -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComProtocolInit(SbgEComProtocol *pHandle, SbgInterface *pInterface)
{
        SbgErrorCode    errorCode = SBG_NO_ERROR;
        
        //
        // Check input parameters
        //
        SBG_ASSERT(pHandle);
        SBG_ASSERT(pInterface);
                
        //
        // Initialize the created protocol handle
        //
        pHandle->pLinkedInterface = pInterface;
        pHandle->rxBufferSize = 0;
        
        return errorCode;
}

SbgErrorCode sbgEComProtocolClose(SbgEComProtocol *pHandle)
{
        //
        // Check input arguments
        //
        SBG_ASSERT(pHandle);

        //
        // Reset all members to zero
        //
        pHandle->pLinkedInterface = NULL;
        pHandle->rxBufferSize = 0;
        
        //
        // Don't have to do anything
        //
        return SBG_NO_ERROR;
}

SbgErrorCode sbgEComProtocolSend(SbgEComProtocol *pHandle, uint8 msgClass, uint8 msg, const void *pData, size_t size)
{
        SbgErrorCode            errorCode = SBG_NO_ERROR;
        uint8                           outputBuffer[SBG_ECOM_MAX_BUFFER_SIZE];
        SbgStreamBuffer         outputStream;
        uint16                          frameCrc;

        //
        // Check input arguments
        //
        SBG_ASSERT(pHandle);

        if ( (size <= SBG_ECOM_MAX_PAYLOAD_SIZE) && ( ((size > 0) && (pData)) || (size == 0) ) )
        {
                //
                // Create a stream buffer to write the frame
                //
                sbgStreamBufferInitForWrite(&outputStream, outputBuffer, sizeof(outputBuffer));

                //
                // Write the header
                //
                sbgStreamBufferWriteUint8LE(&outputStream, SBG_ECOM_SYNC_1);
                sbgStreamBufferWriteUint8LE(&outputStream, SBG_ECOM_SYNC_2);

                //
                // Write the message ID and class
                //
                sbgStreamBufferWriteUint8LE(&outputStream, msg);
                sbgStreamBufferWriteUint8LE(&outputStream, msgClass);

                //
                // Write the length field
                //
                sbgStreamBufferWriteUint16LE(&outputStream, (uint16)size);

                //
                // Write the payload part
                //
                sbgStreamBufferWriteBuffer(&outputStream, pData, size);

                //
                // Compute the CRC, we skip the two sync chars
                //
                frameCrc = sbgCrc16Compute(((uint8*)sbgStreamBufferGetLinkedBuffer(&outputStream)) + 2, sbgStreamBufferGetLength(&outputStream) - 2);

                //
                // Write the CRC
                //
                sbgStreamBufferWriteUint16LE(&outputStream, frameCrc);

                //
                // Write ETX char
                //
                sbgStreamBufferWriteUint8LE(&outputStream, SBG_ECOM_ETX);

                //
                // The frame has been generated so send it
                //
                errorCode = sbgInterfaceWrite(pHandle->pLinkedInterface, sbgStreamBufferGetLinkedBuffer(&outputStream), sbgStreamBufferGetLength(&outputStream));
        }
        else
        {
                //
                // Invalid input parameters
                //
                errorCode = SBG_INVALID_PARAMETER;
        }

        return errorCode;
}

SbgErrorCode sbgEComProtocolReceive(SbgEComProtocol *pHandle, uint8 *pMsgClass, uint8 *pMsg, void *pData, size_t *pSize, size_t maxSize)
{
        SbgErrorCode            errorCode = SBG_NOT_READY;
        SbgStreamBuffer         inputStream;
        bool                            syncFound;
        size_t                          payloadSize = 0;
        uint16                          frameCrc;
        uint16                          computedCrc;
        size_t                          i;
        size_t                          numBytesRead;
        uint8                           receivedMsgClass;
        uint8                           receivedMsg;
        size_t                          payloadOffset;

        //
        // Check input arguments
        //
        SBG_ASSERT(pHandle);
        
        // 
        // Set the return size to 0 in order to avoid possible bugs
        //
        if (pSize)
        {
                *pSize = 0;
        }

        //
        // Check if we can receive some new data (the receive buffer isn't full)
        //
        if (pHandle->rxBufferSize < SBG_ECOM_MAX_BUFFER_SIZE)
        {
                //
                // First try to read as much data as we can
                //
                if (sbgInterfaceRead(pHandle->pLinkedInterface, pHandle->rxBuffer + pHandle->rxBufferSize, &numBytesRead, SBG_ECOM_MAX_BUFFER_SIZE - pHandle->rxBufferSize) == SBG_NO_ERROR)
                {
                        //
                        // No error during reading so increment the number of bytes stored in the rx buffer
                        //
                        pHandle->rxBufferSize += numBytesRead;
                }
        }

        //
        // We have read all available data and stored them into the rx buffer
        // We will try to process all received data until we have found a valid frame.
        //
        while (pHandle->rxBufferSize > 0)
        {
                //
                // For now, we haven't found any start of frame
                //
                syncFound = FALSE;

                //
                // To find a valid start of frame we need at least 2 bytes in the reception buffer
                //
                if (pHandle->rxBufferSize >= 2)
                {
                        //
                        // Try to find a valid start of frame by looking for SYNC_1 and SYNC_2 chars
                        //
                        for (i = 0; i < pHandle->rxBufferSize-1; i++)
                        {
                                //
                                // A valid start of frame should begin with SYNC and when STX chars
                                //
                                if ( (pHandle->rxBuffer[i] == SBG_ECOM_SYNC_1) && (pHandle->rxBuffer[i+1] == SBG_ECOM_SYNC_2) )
                                {
                                        //
                                        // We have found the sync char, test if we have dummy bytes at the begining of the frame
                                        //
                                        if (i > 0)
                                        {
                                                //
                                                // Remove all dumy received bytes before the begining of the frame
                                                //
                                                memmove(pHandle->rxBuffer, pHandle->rxBuffer+i, pHandle->rxBufferSize-i);
                                                pHandle->rxBufferSize = pHandle->rxBufferSize-i;
                                        }

                                        //
                                        // The sync has been found
                                        //
                                        syncFound = TRUE;
                                        break;
                                }
                        }
                }

                //
                // Check if a valid start of frame has been found
                //
                if (syncFound)
                {
                        //
                        // A valid start of frame has been found, try to extract the frame if we have at least a whole frame.
                        //
                        if (pHandle->rxBufferSize < 8)
                        {
                                //
                                // Don't have enough data for a valid frame
                                //
                                return SBG_NOT_READY;
                        }

                        //
                        // Initialize an input stream buffer to parse the received frame
                        //
                        sbgStreamBufferInitForRead(&inputStream, pHandle->rxBuffer, pHandle->rxBufferSize);

                        //
                        // Skip both the Sync 1 and Sync 2 chars
                        //
                        sbgStreamBufferSeek(&inputStream, sizeof(uint8)*2, SB_SEEK_CUR_INC);

                        //
                        // Read the command
                        //
                        receivedMsg = sbgStreamBufferReadUint8LE(&inputStream);
                        receivedMsgClass = sbgStreamBufferReadUint8LE(&inputStream);

                        //
                        // Read the payload size
                        //
                        payloadSize = (uint16)sbgStreamBufferReadUint16LE(&inputStream);

                        //
                        // Check that the payload size is valid
                        //
                        if (payloadSize <= SBG_ECOM_MAX_PAYLOAD_SIZE)
                        {
                                //
                                // Check if we have received the whole frame
                                //
                                if (pHandle->rxBufferSize < payloadSize+9)
                                {
                                        //
                                        // Don't have received the whole frame
                                        //
                                        return SBG_NOT_READY;
                                }

                                //
                                // We should have the whole frame so for now, skip the payload part but before store the current cursor
                                //
                                payloadOffset = sbgStreamBufferTell(&inputStream);
                                sbgStreamBufferSeek(&inputStream, payloadSize, SB_SEEK_CUR_INC);

                                //
                                // Read the frame CRC
                                //
                                frameCrc = sbgStreamBufferReadUint16LE(&inputStream);

                                //
                                // Read and test the frame ETX
                                //
                                if (sbgStreamBufferReadUint8(&inputStream) == SBG_ECOM_ETX)
                                {
                                        //
                                        // Go back at the beginning of the payload part
                                        //
                                        sbgStreamBufferSeek(&inputStream, payloadOffset, SB_SEEK_SET);

                                        //
                                        // We have a frame so return the received command if needed even if the CRC is still not validated
                                        //
                                        if (pMsg)
                                        {
                                                *pMsg = receivedMsg;
                                        }
                                        if (pMsgClass)
                                        {
                                                *pMsgClass = receivedMsgClass;
                                        }

                                        //
                                        // Compute the CRC of the received frame (Skip SYNC 1 and SYNC 2 chars)
                                        //
                                        computedCrc = sbgCrc16Compute(((uint8*)sbgStreamBufferGetLinkedBuffer(&inputStream)) + 2, payloadSize + 4);
                                                
                                        //
                                        // Check if the received frame has a valid CRC
                                        //
                                        if (frameCrc == computedCrc)
                                        {
                                                //
                                                // Extract the payload if needed
                                                //
                                                if (payloadSize > 0)
                                                {
                                                        //
                                                        // Check if input parameters are valid
                                                        //
                                                        if ( (pData) && (pSize) )
                                                        {
                                                                //
                                                                // Check if we have enough space to store the payload
                                                                //
                                                                if (payloadSize <= maxSize)
                                                                {
                                                                        //
                                                                        // Copy the payload and return the payload size
                                                                        //
                                                                        *pSize = payloadSize;
                                                                        memcpy(pData, sbgStreamBufferGetCursor(&inputStream), payloadSize);
                                                                        errorCode = SBG_NO_ERROR;
                                                                }
                                                                else
                                                                {
                                                                        //
                                                                        // Not enough space to store the payload, we will just drop the received data
                                                                        //
                                                                        errorCode = SBG_BUFFER_OVERFLOW;
                                                                }                                                                       
                                                        }
                                                        else
                                                        {
                                                                errorCode = SBG_NULL_POINTER;
                                                        }
                                                }
                                                else
                                                {
                                                        //
                                                        // No payload but the frame has been read successfully
                                                        //
                                                        errorCode = SBG_NO_ERROR;
                                                }
                                        }
                                        else
                                        {
                                                //
                                                // We have an invalid frame CRC and we will directly return this error
                                                //
                                                errorCode = SBG_INVALID_CRC;
                                        }

                                        //
                                        // We have read a whole valid frame so remove it from the buffer
                                        // First, test if the reception buffer contains more than just the current frame
                                        //
                                        if (pHandle->rxBufferSize > payloadSize+9)
                                        {
                                                //
                                                // We remove the read frame but we keep the remaining data
                                                //
                                                pHandle->rxBufferSize = pHandle->rxBufferSize-(payloadSize+9);
                                                memmove(pHandle->rxBuffer, pHandle->rxBuffer+payloadSize+9, pHandle->rxBufferSize);
                                        }
                                        else
                                        {
                                                //
                                                // We have parsed the whole received buffer so just empty it
                                                //
                                                pHandle->rxBufferSize = 0;
                                        }

                                        //
                                        // We have at least found a complete frame
                                        //
                                        return errorCode;
                                }
                        }
                                
                        //
                        // Frame size invalid or the found frame is invalid so we should have incorrectly detected a start of frame.
                        // Remove the SYNC 1 and SYNC 2 chars to retry to find a new frame
                        //
                        pHandle->rxBufferSize -= 2;
                        memmove(pHandle->rxBuffer, pHandle->rxBuffer+2, pHandle->rxBufferSize);
                }
                else
                {
                        //
                        // Unable to find a valid start of frame so check if the last byte is a SYNC char in order to keep it for next time
                        //
                        if (pHandle->rxBuffer[pHandle->rxBufferSize-1] == SBG_ECOM_SYNC_1)
                        {
                                //
                                // Report the SYNC char and discard all other bytes in the buffer
                                //
                                pHandle->rxBuffer[0] = SBG_ECOM_SYNC_1;
                                pHandle->rxBufferSize = 1;
                        }
                        else
                        {
                                //
                                // Discard the whole buffer
                                //
                                pHandle->rxBufferSize = 0;
                        }

                        //
                        // Unable to find a frame
                        //
                        return SBG_NOT_READY;
                }
        }

        //
        // The whole buffer has been paresed and no valid frame has been found
        //
        return SBG_NOT_READY;
}

//----------------------------------------------------------------------//
//- Frame generation to stream buffer                                  -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComStartFrameGeneration(SbgStreamBuffer *pOutputStream, uint8 msgClass, uint8 msg)
{
        //
        // Check input arguments
        //
        SBG_ASSERT(pOutputStream);

        //
        // Go to the beginning of the stream to ease frame size computation
        //
        sbgStreamBufferSeek(pOutputStream, 0, SB_SEEK_SET);

        //
        // Write the header
        //
        sbgStreamBufferWriteUint8LE(pOutputStream, SBG_ECOM_SYNC_1);
        sbgStreamBufferWriteUint8LE(pOutputStream, SBG_ECOM_SYNC_2);

        //
        // Write the message ID and class
        //
        sbgStreamBufferWriteUint8LE(pOutputStream, msg);
        sbgStreamBufferWriteUint8LE(pOutputStream, msgClass);
        
        //
        // For now, we don't know the payload size so skip it
        //
        return sbgStreamBufferSeek(pOutputStream, sizeof(uint16), SB_SEEK_CUR_INC);
}

SbgErrorCode sbgEComFinalizeFrameGeneration(SbgStreamBuffer *pOutputStream)
{
        SbgErrorCode    errorCode;
        size_t                  payloadSize;    
        size_t                  currentPos;
        uint16                  frameCrc;

        //
        // Check input arguments
        //
        SBG_ASSERT(pOutputStream);

        //
        // Test if any error has occurred on the stream first
        //
        errorCode = sbgStreamBufferGetLastError(pOutputStream);

        //
        // Is the stream buffer error free ?
        //
        if (errorCode == SBG_NO_ERROR)
        {
                //
                // Compute the payload size (written data minus the header)
                //
                payloadSize = sbgStreamBufferGetLength(pOutputStream) - 6;

                //
                // Test that the payload size is valid
                //
                if (payloadSize <= SBG_ECOM_MAX_PAYLOAD_SIZE)
                {
                        //
                        // Backup the current cursor position
                        //
                        currentPos = sbgStreamBufferTell(pOutputStream);

                        //
                        // Goto the payload size field
                        //
                        sbgStreamBufferSeek(pOutputStream, 4, SB_SEEK_SET);

                        //
                        // Write the payload size
                        //
                        sbgStreamBufferWriteUint16LE(pOutputStream, (uint16)payloadSize);

                        //
                        // Go back to the previous position
                        //
                        sbgStreamBufferSeek(pOutputStream, currentPos, SB_SEEK_SET);

                        //
                        // Compute the 16 bits CRC on the whole frame except Sync 1 and Sync 2
                        //
                        frameCrc = sbgCrc16Compute((uint8*)sbgStreamBufferGetLinkedBuffer(pOutputStream) + 2, payloadSize + 4);

                        //
                        // Append the CRC
                        //
                        sbgStreamBufferWriteUint16LE(pOutputStream, frameCrc);

                        //
                        // Append the ETX
                        //
                        errorCode = sbgStreamBufferWriteUint8LE(pOutputStream, SBG_ECOM_ETX);
                }
                else
                {
                        //
                        // Invalid payload size
                        //
                        errorCode = SBG_BUFFER_OVERFLOW;
                }
        }
        else
        {
                //
                // Notify error
                //
                SBG_LOG_ERROR(errorCode, "Unable to finalize frame because of an error on Stream Buffer");
        }

        return errorCode;
}