stream_buffer.h File Reference

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

Typedefs
typedef struct StreamBufferDef_t *	StreamBufferHandle_t

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

Macro Definition Documentation

#define xStreamBufferCreate	(		xBufferSizeBytes,
			xTriggerLevelBytes
	)

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

Typedef Documentation

typedef struct StreamBufferDef_t* StreamBufferHandle_t

Function Documentation

void vStreamBufferDelete

(

StreamBufferHandle_t

xStreamBuffer

)

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

Referenced by MPU_vStreamBufferDelete().

size_t xStreamBufferBytesAvailable

(

StreamBufferHandle_t

xStreamBuffer

)

References configASSERT, and prvBytesInBuffer().

Referenced by MPU_xStreamBufferBytesAvailable().

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

)

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

Referenced by MPU_xStreamBufferIsEmpty().

BaseType_t xStreamBufferIsFull

(

StreamBufferHandle_t

xStreamBuffer

)

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

Referenced by MPU_xStreamBufferIsFull().

size_t xStreamBufferNextMessageLengthBytes

(

StreamBufferHandle_t

xStreamBuffer

)

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

Referenced by MPU_xStreamBufferNextMessageLengthBytes().

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

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

Referenced by MPU_xStreamBufferReceive().

BaseType_t xStreamBufferReceiveCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

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

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

References configASSERT, mtCOVERAGE_TEST_MARKER, prvBytesInBuffer(), prvReadMessageFromBuffer(), sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, sbRECEIVE_COMPLETED_FROM_ISR, traceSTREAM_BUFFER_RECEIVE_FROM_ISR, and StreamBuffer_t::ucFlags.

BaseType_t xStreamBufferReset

(

StreamBufferHandle_t

xStreamBuffer

)

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

Referenced by MPU_xStreamBufferReset().

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

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

Referenced by MPU_xStreamBufferSend().

BaseType_t xStreamBufferSendCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

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

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

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

BaseType_t xStreamBufferSetTriggerLevel	(	StreamBufferHandle_t	xStreamBuffer,
		size_t	xTriggerLevel
	)

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

Referenced by MPU_xStreamBufferSetTriggerLevel().

size_t xStreamBufferSpacesAvailable

(

StreamBufferHandle_t

xStreamBuffer

)

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

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