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.

void vStreamBufferDelete

(

StreamBufferHandle_t

xStreamBuffer

)

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

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

)

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

BaseType_t xStreamBufferIsFull

(

StreamBufferHandle_t

xStreamBuffer

)

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

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

References configASSERT, mtCOVERAGE_TEST_MARKER, NULL, 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, xSTREAM_BUFFER::ucFlags, xTaskGetCurrentTaskHandle(), xTaskNotifyStateClear(), xTaskNotifyWait(), and xSTREAM_BUFFER::xTaskWaitingToReceive.

BaseType_t xStreamBufferReceiveCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

References configASSERT, eNoAction, NULL, 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 xSTREAM_BUFFER::ucFlags.

BaseType_t xStreamBufferReset

(

StreamBufferHandle_t

xStreamBuffer

)

References configASSERT, NULL, pdFAIL, pdFALSE, pdPASS, pdTRUE, prvInitialiseNewStreamBuffer(), xSTREAM_BUFFER::pucBuffer, sbFLAGS_IS_MESSAGE_BUFFER, traceSTREAM_BUFFER_RESET, xSTREAM_BUFFER::ucFlags, xSTREAM_BUFFER::xLength, xSTREAM_BUFFER::xTaskWaitingToReceive, xSTREAM_BUFFER::xTaskWaitingToSend, and xSTREAM_BUFFER::xTriggerLevelBytes.

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

References configASSERT, mtCOVERAGE_TEST_MARKER, NULL, 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, xSTREAM_BUFFER::ucFlags, vTaskSetTimeOutState(), xStreamBufferSpacesAvailable(), xTaskCheckForTimeOut(), xTaskGetCurrentTaskHandle(), xTaskNotifyStateClear(), xTaskNotifyWait(), xSTREAM_BUFFER::xTaskWaitingToSend, and xSTREAM_BUFFER::xTriggerLevelBytes.

BaseType_t xStreamBufferSendCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

References configASSERT, eNoAction, NULL, 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, xSTREAM_BUFFER::ucFlags, xStreamBufferSpacesAvailable(), and xSTREAM_BUFFER::xTriggerLevelBytes.

BaseType_t xStreamBufferSetTriggerLevel	(	StreamBufferHandle_t	xStreamBuffer,
		size_t	xTriggerLevel
	)

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

size_t xStreamBufferSpacesAvailable

(

StreamBufferHandle_t

xStreamBuffer

)

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

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