Microchip® Advanced Software Framework

stream_buffer.c File Reference
#include <stdint.h>
#include <string.h>
#include "FreeRTOS.h"
#include "task.h"
#include "stream_buffer.h"

Data Structures

struct  xSTREAM_BUFFER
 

Macros

#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
 
#define sbBYTES_TO_STORE_MESSAGE_LENGTH   ( sizeof( size_t ) )
 
#define sbFLAGS_IS_MESSAGE_BUFFER   ( ( uint8_t ) 1 ) /* Set if the stream buffer was created as a message buffer, in which case it holds discrete messages rather than a stream. */
 
#define sbFLAGS_IS_STATICALLY_ALLOCATED   ( ( uint8_t ) 2 ) /* Set if the stream buffer was created using statically allocated memory. */
 
#define sbRECEIVE_COMPLETED(pxStreamBuffer)
 
#define sbRECEIVE_COMPLETED_FROM_ISR(pxStreamBuffer,pxHigherPriorityTaskWoken)
 
#define sbSEND_COMPLETE_FROM_ISR(pxStreamBuffer, pxHigherPriorityTaskWoken)
 
#define sbSEND_COMPLETED(pxStreamBuffer)
 

Typedefs

typedef struct xSTREAM_BUFFER StreamBuffer_t
 

Functions

static size_t prvBytesInBuffer (const StreamBuffer_t *const pxStreamBuffer) PRIVILEGED_FUNCTION
 
static PRIVILEGED_FUNCTION void prvInitialiseNewStreamBuffer (StreamBuffer_t *const pxStreamBuffer, uint8_t *const pucBuffer, size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer) PRIVILEGED_FUNCTION
 
static size_t prvReadBytesFromBuffer (StreamBuffer_t *pxStreamBuffer, uint8_t *pucData, size_t xMaxCount, size_t xBytesAvailable)
 
static size_t prvReadMessageFromBuffer (StreamBuffer_t *pxStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, size_t xBytesAvailable, size_t xBytesToStoreMessageLength) PRIVILEGED_FUNCTION
 
static size_t prvWriteBytesToBuffer (StreamBuffer_t *const pxStreamBuffer, const uint8_t *pucData, size_t xCount) PRIVILEGED_FUNCTION
 
static size_t prvWriteMessageToBuffer (StreamBuffer_t *const pxStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, size_t xSpace, size_t xRequiredSpace) PRIVILEGED_FUNCTION
 
void vStreamBufferDelete (StreamBufferHandle_t xStreamBuffer)
 
size_t xStreamBufferBytesAvailable (StreamBufferHandle_t xStreamBuffer)
 
StreamBufferHandle_t xStreamBufferGenericCreate (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer)
 
BaseType_t xStreamBufferIsEmpty (StreamBufferHandle_t xStreamBuffer)
 
BaseType_t xStreamBufferIsFull (StreamBufferHandle_t xStreamBuffer)
 
size_t xStreamBufferReceive (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait)
 
BaseType_t xStreamBufferReceiveCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken)
 
size_t xStreamBufferReceiveFromISR (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken)
 
BaseType_t xStreamBufferReset (StreamBufferHandle_t xStreamBuffer)
 
size_t xStreamBufferSend (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait)
 
BaseType_t xStreamBufferSendCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken)
 
size_t xStreamBufferSendFromISR (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken)
 
BaseType_t xStreamBufferSetTriggerLevel (StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel)
 
size_t xStreamBufferSpacesAvailable (StreamBufferHandle_t xStreamBuffer)
 

#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
#define sbFLAGS_IS_MESSAGE_BUFFER   ( ( uint8_t ) 1 ) /* Set if the stream buffer was created as a message buffer, in which case it holds discrete messages rather than a stream. */
#define sbFLAGS_IS_STATICALLY_ALLOCATED   ( ( uint8_t ) 2 ) /* Set if the stream buffer was created using statically allocated memory. */

Referenced by vStreamBufferDelete().

#define sbRECEIVE_COMPLETED (   pxStreamBuffer)
Value:
{ \
if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL ) \
{ \
( void ) xTaskNotify( ( pxStreamBuffer )->xTaskWaitingToSend, \
( uint32_t ) 0, \
eNoAction ); \
( pxStreamBuffer )->xTaskWaitingToSend = NULL; \
} \
} \
( void ) xTaskResumeAll();
Definition: task.h:84
void vTaskSuspendAll(void)
Definition: tasks.c:2032
#define xTaskNotify(xTaskToNotify, ulValue, eAction)
Definition: task.h:1767
BaseType_t xTaskResumeAll(void)
Definition: tasks.c:2105

Referenced by xStreamBufferReceive().

#define sbRECEIVE_COMPLETED_FROM_ISR (   pxStreamBuffer,
  pxHigherPriorityTaskWoken 
)
Value:
{ \
UBaseType_t uxSavedInterruptStatus; \
\
uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR(); \
{ \
if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL ) \
{ \
( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToSend, \
( uint32_t ) 0, \
pxHigherPriorityTaskWoken ); \
( pxStreamBuffer )->xTaskWaitingToSend = NULL; \
} \
} \
portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ); \
}
Definition: task.h:84
#define portCLEAR_INTERRUPT_MASK_FROM_ISR(uxSavedStatusValue)
Definition: FreeRTOS.h:263
#define xTaskNotifyFromISR(xTaskToNotify, ulValue, eAction, pxHigherPriorityTaskWoken)
Definition: task.h:1858
#define portSET_INTERRUPT_MASK_FROM_ISR()
Definition: FreeRTOS.h:259

Referenced by xStreamBufferReceiveFromISR().

#define sbSEND_COMPLETE_FROM_ISR (   pxStreamBuffer,
  pxHigherPriorityTaskWoken 
)
Value:
{ \
UBaseType_t uxSavedInterruptStatus; \
\
uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR(); \
{ \
if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL ) \
{ \
( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToReceive, \
( uint32_t ) 0, \
pxHigherPriorityTaskWoken ); \
( pxStreamBuffer )->xTaskWaitingToReceive = NULL; \
} \
} \
portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ); \
}
Definition: task.h:84
#define portCLEAR_INTERRUPT_MASK_FROM_ISR(uxSavedStatusValue)
Definition: FreeRTOS.h:263
#define xTaskNotifyFromISR(xTaskToNotify, ulValue, eAction, pxHigherPriorityTaskWoken)
Definition: task.h:1858
#define portSET_INTERRUPT_MASK_FROM_ISR()
Definition: FreeRTOS.h:259

Referenced by xStreamBufferSendFromISR().

#define sbSEND_COMPLETED (   pxStreamBuffer)
Value:
{ \
if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL ) \
{ \
( void ) xTaskNotify( ( pxStreamBuffer )->xTaskWaitingToReceive, \
( uint32_t ) 0, \
eNoAction ); \
( pxStreamBuffer )->xTaskWaitingToReceive = NULL; \
} \
} \
( void ) xTaskResumeAll();
Definition: task.h:84
void vTaskSuspendAll(void)
Definition: tasks.c:2032
#define xTaskNotify(xTaskToNotify, ulValue, eAction)
Definition: task.h:1767
BaseType_t xTaskResumeAll(void)
Definition: tasks.c:2105

Referenced by xStreamBufferSend().

static void prvInitialiseNewStreamBuffer ( StreamBuffer_t *const  pxStreamBuffer,
uint8_t *const  pucBuffer,
size_t  xBufferSizeBytes,
size_t  xTriggerLevelBytes,
BaseType_t  xIsMessageBuffer 
)
static
static size_t prvReadBytesFromBuffer ( StreamBuffer_t pxStreamBuffer,
uint8_t *  pucData,
size_t  xMaxCount,
size_t  xBytesAvailable 
)
static
static size_t prvReadMessageFromBuffer ( StreamBuffer_t pxStreamBuffer,
void *  pvRxData,
size_t  xBufferLengthBytes,
size_t  xBytesAvailable,
size_t  xBytesToStoreMessageLength 
)
static
static size_t prvWriteBytesToBuffer ( StreamBuffer_t *const  pxStreamBuffer,
const uint8_t *  pucData,
size_t  xCount 
)
static
static size_t prvWriteMessageToBuffer ( StreamBuffer_t *const  pxStreamBuffer,
const void *  pvTxData,
size_t  xDataLengthBytes,
size_t  xSpace,
size_t  xRequiredSpace 
)
static
size_t xStreamBufferBytesAvailable ( StreamBufferHandle_t  xStreamBuffer)

References configASSERT, and prvBytesInBuffer().

StreamBufferHandle_t xStreamBufferGenericCreate ( size_t  xBufferSizeBytes,
size_t  xTriggerLevelBytes,
BaseType_t  xIsMessageBuffer 
)
BaseType_t xStreamBufferIsEmpty ( StreamBufferHandle_t  xStreamBuffer)
BaseType_t xStreamBufferReceiveCompletedFromISR ( StreamBufferHandle_t  xStreamBuffer,
BaseType_t *  pxHigherPriorityTaskWoken 
)
size_t xStreamBufferReceiveFromISR ( StreamBufferHandle_t  xStreamBuffer,
void *  pvRxData,
size_t  xBufferLengthBytes,
BaseType_t *const  pxHigherPriorityTaskWoken 
)
BaseType_t xStreamBufferSendCompletedFromISR ( StreamBufferHandle_t  xStreamBuffer,
BaseType_t *  pxHigherPriorityTaskWoken 
)
BaseType_t xStreamBufferSetTriggerLevel ( StreamBufferHandle_t  xStreamBuffer,
size_t  xTriggerLevel 
)