Microchip® Advanced Software Framework

stream_buffer.h File Reference

Macros

#define xStreamBufferCreate(xBufferSizeBytes, xTriggerLevelBytes)   xStreamBufferGenericCreate( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE )
 
#define xStreamBufferCreateStatic(xBufferSizeBytes, xTriggerLevelBytes, pucStreamBufferStorageArea, pxStaticStreamBuffer)   xStreamBufferGenericCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE, pucStreamBufferStorageArea, pxStaticStreamBuffer )
 

Typedefs

typedef void * StreamBufferHandle_t
 Type by which stream buffers are referenced. More...
 

Functions

void vStreamBufferDelete (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
 
size_t xStreamBufferBytesAvailable (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
 
StreamBufferHandle_t xStreamBufferGenericCreate (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer) PRIVILEGED_FUNCTION
 
StreamBufferHandle_t xStreamBufferGenericCreateStatic (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer, uint8_t *const pucStreamBufferStorageArea, StaticStreamBuffer_t *const pxStaticStreamBuffer) PRIVILEGED_FUNCTION
 
BaseType_t xStreamBufferIsEmpty (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
 
BaseType_t xStreamBufferIsFull (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
 
size_t xStreamBufferReceive (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
 
BaseType_t xStreamBufferReceiveCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
 
size_t xStreamBufferReceiveFromISR (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
 
BaseType_t xStreamBufferReset (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
 
size_t xStreamBufferSend (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
 
BaseType_t xStreamBufferSendCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
 
size_t xStreamBufferSendFromISR (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
 
BaseType_t xStreamBufferSetTriggerLevel (StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel) PRIVILEGED_FUNCTION
 
size_t xStreamBufferSpacesAvailable (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
 

#define xStreamBufferCreate (   xBufferSizeBytes,
  xTriggerLevelBytes 
)    xStreamBufferGenericCreate( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE )
#define xStreamBufferCreateStatic (   xBufferSizeBytes,
  xTriggerLevelBytes,
  pucStreamBufferStorageArea,
  pxStaticStreamBuffer 
)    xStreamBufferGenericCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE, pucStreamBufferStorageArea, pxStaticStreamBuffer )

typedef void* StreamBufferHandle_t

Type by which stream buffers are referenced.

For example, a call to xStreamBufferCreate() returns an StreamBufferHandle_t variable that can then be used as a parameter to xStreamBufferSend(), xStreamBufferReceive(), etc.

size_t xStreamBufferBytesAvailable ( StreamBufferHandle_t  xStreamBuffer)

References configASSERT, and prvBytesInBuffer().

StreamBufferHandle_t xStreamBufferGenericCreate ( size_t  xBufferSizeBytes,
size_t  xTriggerLevelBytes,
BaseType_t  xIsMessageBuffer 
)
StreamBufferHandle_t xStreamBufferGenericCreateStatic ( size_t  xBufferSizeBytes,
size_t  xTriggerLevelBytes,
BaseType_t  xIsMessageBuffer,
uint8_t *const  pucStreamBufferStorageArea,
StaticStreamBuffer_t *const  pxStaticStreamBuffer 
)
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 
)