STAR
Cal STAR — firmware, DAQ server, and engine design
Loading...
Searching...
No Matches
stream_buffer.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define xStreamBufferCreate(xBufferSizeBytes, xTriggerLevelBytes)
#define xStreamBufferCreateStatic(xBufferSizeBytes, xTriggerLevelBytes, pucStreamBufferStorageArea, pxStaticStreamBuffer)

Typedefs

typedef struct StreamBufferDef_t * StreamBufferHandle_t
typedef void(* StreamBufferCallbackFunction_t) (StreamBufferHandle_t xStreamBuffer, BaseType_t xIsInsideISR, BaseType_t *const pxHigherPriorityTaskWoken)
 Type used as a stream buffer's optional callback.

Functions

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

Macro Definition Documentation

◆ xStreamBufferCreate

#define xStreamBufferCreate ( xBufferSizeBytes,
xTriggerLevelBytes )
Value:
xStreamBufferGenericCreate( ( xBufferSizeBytes ), ( xTriggerLevelBytes ), pdFALSE, NULL, NULL )
NULL
#define NULL
Definition usbd_def.h:44
pdFALSE
#define pdFALSE
Definition projdefs.h:45
xStreamBufferGenericCreate
StreamBufferHandle_t xStreamBufferGenericCreate(size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer, StreamBufferCallbackFunction_t pxSendCompletedCallback, StreamBufferCallbackFunction_t pxReceiveCompletedCallback) PRIVILEGED_FUNCTION

Definition at line 157 of file stream_buffer.h.

◆ xStreamBufferCreateStatic

#define xStreamBufferCreateStatic ( xBufferSizeBytes,
xTriggerLevelBytes,
pucStreamBufferStorageArea,
pxStaticStreamBuffer )
Value:
xStreamBufferGenericCreateStatic( ( xBufferSizeBytes ), ( xTriggerLevelBytes ), pdFALSE, ( pucStreamBufferStorageArea ), ( pxStaticStreamBuffer ), NULL, NULL )
xStreamBufferGenericCreateStatic
StreamBufferHandle_t xStreamBufferGenericCreateStatic(size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer, uint8_t *const pucStreamBufferStorageArea, StaticStreamBuffer_t *const pxStaticStreamBuffer, StreamBufferCallbackFunction_t pxSendCompletedCallback, StreamBufferCallbackFunction_t pxReceiveCompletedCallback) PRIVILEGED_FUNCTION

Definition at line 255 of file stream_buffer.h.

Typedef Documentation

◆ StreamBufferCallbackFunction_t

typedef void(* StreamBufferCallbackFunction_t) (StreamBufferHandle_t xStreamBuffer, BaseType_t xIsInsideISR, BaseType_t *const pxHigherPriorityTaskWoken)

Type used as a stream buffer's optional callback.

Definition at line 77 of file stream_buffer.h.

◆ StreamBufferHandle_t

typedef struct StreamBufferDef_t* StreamBufferHandle_t

Definition at line 72 of file stream_buffer.h.

Function Documentation

◆ vStreamBufferDelete()

void vStreamBufferDelete ( StreamBufferHandle_t xStreamBuffer)

Definition at line 505 of file stream_buffer.c.

References configASSERT, pdFALSE, sbFLAGS_IS_STATICALLY_ALLOCATED, traceSTREAM_BUFFER_DELETE, StreamBufferDef_t::ucFlags, and vPortFree().

◆ xStreamBufferBytesAvailable()

size_t xStreamBufferBytesAvailable ( StreamBufferHandle_t xStreamBuffer)

Definition at line 658 of file stream_buffer.c.

References configASSERT, and prvBytesInBuffer().

◆ xStreamBufferGenericCreate()

StreamBufferHandle_t xStreamBufferGenericCreate ( size_t xBufferSizeBytes,
size_t xTriggerLevelBytes,
BaseType_t xIsMessageBuffer,
StreamBufferCallbackFunction_t pxSendCompletedCallback,
StreamBufferCallbackFunction_t pxReceiveCompletedCallback )

References PRIVILEGED_FUNCTION.

◆ xStreamBufferGenericCreateStatic()

StreamBufferHandle_t xStreamBufferGenericCreateStatic ( size_t xBufferSizeBytes,
size_t xTriggerLevelBytes,
BaseType_t xIsMessageBuffer,
uint8_t *const pucStreamBufferStorageArea,
StaticStreamBuffer_t *const pxStaticStreamBuffer,
StreamBufferCallbackFunction_t pxSendCompletedCallback,
StreamBufferCallbackFunction_t pxReceiveCompletedCallback )

References PRIVILEGED_FUNCTION.

◆ xStreamBufferIsEmpty()

BaseType_t xStreamBufferIsEmpty ( StreamBufferHandle_t xStreamBuffer)

Definition at line 1155 of file stream_buffer.c.

References configASSERT, pdFALSE, pdTRUE, StreamBufferDef_t::xHead, and StreamBufferDef_t::xTail.

◆ xStreamBufferIsFull()

BaseType_t xStreamBufferIsFull ( StreamBufferHandle_t xStreamBuffer)

Definition at line 1179 of file stream_buffer.c.

References configASSERT, pdFALSE, pdTRUE, sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, StreamBufferDef_t::ucFlags, and xStreamBufferSpacesAvailable().

◆ xStreamBufferNextMessageLengthBytes()

size_t xStreamBufferNextMessageLengthBytes ( StreamBufferHandle_t xStreamBuffer)

Definition at line 1006 of file stream_buffer.c.

References configASSERT, configMESSAGE_BUFFER_LENGTH_TYPE, prvBytesInBuffer(), prvReadBytesFromBuffer(), sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, StreamBufferDef_t::ucFlags, and StreamBufferDef_t::xTail.

◆ xStreamBufferReceive()

size_t xStreamBufferReceive ( StreamBufferHandle_t xStreamBuffer,
void * pvRxData,
size_t xBufferLengthBytes,
TickType_t xTicksToWait )

Definition at line 902 of file stream_buffer.c.

References configASSERT, mtCOVERAGE_TEST_MARKER, NULL, prvBytesInBuffer(), prvReadMessageFromBuffer(), prvRECEIVE_COMPLETED, sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, taskENTER_CRITICAL, taskEXIT_CRITICAL, traceBLOCKING_ON_STREAM_BUFFER_RECEIVE, traceSTREAM_BUFFER_RECEIVE, traceSTREAM_BUFFER_RECEIVE_FAILED, StreamBufferDef_t::ucFlags, xTaskGetCurrentTaskHandle(), xTaskNotifyStateClear, xTaskNotifyWait, and StreamBufferDef_t::xTaskWaitingToReceive.

◆ xStreamBufferReceiveCompletedFromISR()

BaseType_t xStreamBufferReceiveCompletedFromISR ( StreamBufferHandle_t xStreamBuffer,
BaseType_t * pxHigherPriorityTaskWoken )

Definition at line 1245 of file stream_buffer.c.

References configASSERT, eNoAction, NULL, pdFALSE, pdTRUE, portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, and xTaskNotifyFromISR.

◆ xStreamBufferReceiveFromISR()

size_t xStreamBufferReceiveFromISR ( StreamBufferHandle_t xStreamBuffer,
void * pvRxData,
size_t xBufferLengthBytes,
BaseType_t *const pxHigherPriorityTaskWoken )

Definition at line 1046 of file stream_buffer.c.

References configASSERT, mtCOVERAGE_TEST_MARKER, prvBytesInBuffer(), prvReadMessageFromBuffer(), prvRECEIVE_COMPLETED_FROM_ISR, sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, traceSTREAM_BUFFER_RECEIVE_FROM_ISR, and StreamBufferDef_t::ucFlags.

◆ xStreamBufferReset()

BaseType_t xStreamBufferReset ( StreamBufferHandle_t xStreamBuffer)

Definition at line 538 of file stream_buffer.c.

References configASSERT, NULL, pdFAIL, pdPASS, prvInitialiseNewStreamBuffer(), StreamBufferDef_t::pucBuffer, taskENTER_CRITICAL, taskEXIT_CRITICAL, traceSTREAM_BUFFER_RESET, StreamBufferDef_t::ucFlags, StreamBufferDef_t::xLength, StreamBufferDef_t::xTaskWaitingToReceive, StreamBufferDef_t::xTaskWaitingToSend, and StreamBufferDef_t::xTriggerLevelBytes.

◆ xStreamBufferSend()

size_t xStreamBufferSend ( StreamBufferHandle_t xStreamBuffer,
const void * pvTxData,
size_t xDataLengthBytes,
TickType_t xTicksToWait )

Definition at line 670 of file stream_buffer.c.

References configASSERT, mtCOVERAGE_TEST_MARKER, NULL, pdFALSE, prvBytesInBuffer(), prvSEND_COMPLETED, prvWriteMessageToBuffer(), sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, taskENTER_CRITICAL, taskEXIT_CRITICAL, traceBLOCKING_ON_STREAM_BUFFER_SEND, traceSTREAM_BUFFER_SEND, traceSTREAM_BUFFER_SEND_FAILED, StreamBufferDef_t::ucFlags, vTaskSetTimeOutState(), StreamBufferDef_t::xLength, xStreamBufferSpacesAvailable(), xTaskCheckForTimeOut(), xTaskGetCurrentTaskHandle(), xTaskNotifyStateClear, xTaskNotifyWait, StreamBufferDef_t::xTaskWaitingToSend, and StreamBufferDef_t::xTriggerLevelBytes.

◆ xStreamBufferSendCompletedFromISR()

BaseType_t xStreamBufferSendCompletedFromISR ( StreamBufferHandle_t xStreamBuffer,
BaseType_t * pxHigherPriorityTaskWoken )

Definition at line 1214 of file stream_buffer.c.

References configASSERT, eNoAction, NULL, pdFALSE, pdTRUE, portCLEAR_INTERRUPT_MASK_FROM_ISR, portSET_INTERRUPT_MASK_FROM_ISR, and xTaskNotifyFromISR.

◆ xStreamBufferSendFromISR()

size_t xStreamBufferSendFromISR ( StreamBufferHandle_t xStreamBuffer,
const void * pvTxData,
size_t xDataLengthBytes,
BaseType_t *const pxHigherPriorityTaskWoken )

Definition at line 801 of file stream_buffer.c.

References configASSERT, mtCOVERAGE_TEST_MARKER, prvBytesInBuffer(), prvSEND_COMPLETE_FROM_ISR, prvWriteMessageToBuffer(), sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, traceSTREAM_BUFFER_SEND_FROM_ISR, StreamBufferDef_t::ucFlags, xStreamBufferSpacesAvailable(), and StreamBufferDef_t::xTriggerLevelBytes.

◆ xStreamBufferSetTriggerLevel()

BaseType_t xStreamBufferSetTriggerLevel ( StreamBufferHandle_t xStreamBuffer,
size_t xTriggerLevel )

Definition at line 595 of file stream_buffer.c.

References configASSERT, pdFALSE, pdPASS, and StreamBufferDef_t::xTriggerLevelBytes.

◆ xStreamBufferSpacesAvailable()

size_t xStreamBufferSpacesAvailable ( StreamBufferHandle_t xStreamBuffer)

Definition at line 625 of file stream_buffer.c.

References configASSERT, mtCOVERAGE_TEST_MARKER, StreamBufferDef_t::xHead, StreamBufferDef_t::xLength, and StreamBufferDef_t::xTail.

Referenced by xStreamBufferIsFull(), xStreamBufferSend(), and xStreamBufferSendFromISR().