stream_buffer.c File Reference

Data Structures
struct	StreamBuffer_t

Macros
#define	MPU_WRAPPERS_INCLUDED_FROM_API_FILE
#define	sbRECEIVE_COMPLETED(pxStreamBuffer)
#define	sbRECEIVE_COMPLETED_FROM_ISR(pxStreamBuffer,pxHigherPriorityTaskWoken)
#define	sbSEND_COMPLETED(pxStreamBuffer)
#define	sbSEND_COMPLETE_FROM_ISR(pxStreamBuffer, pxHigherPriorityTaskWoken)
#define	sbBYTES_TO_STORE_MESSAGE_LENGTH
#define	sbFLAGS_IS_MESSAGE_BUFFER
#define	sbFLAGS_IS_STATICALLY_ALLOCATED

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

Macro Definition Documentation

#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE

#define sbBYTES_TO_STORE_MESSAGE_LENGTH

Referenced by prvWriteMessageToBuffer(), xStreamBufferIsFull(), xStreamBufferNextMessageLengthBytes(), xStreamBufferReceive(), xStreamBufferReceiveFromISR(), xStreamBufferSend(), and xStreamBufferSendFromISR().

#define sbFLAGS_IS_MESSAGE_BUFFER

Referenced by prvWriteMessageToBuffer(), xStreamBufferIsFull(), xStreamBufferNextMessageLengthBytes(), xStreamBufferReceive(), xStreamBufferReceiveFromISR(), xStreamBufferSend(), and xStreamBufferSendFromISR().

#define sbFLAGS_IS_STATICALLY_ALLOCATED

Referenced by vStreamBufferDelete().

#define sbRECEIVE_COMPLETED

(

pxStreamBuffer

)

Referenced by xStreamBufferReceive().

#define sbRECEIVE_COMPLETED_FROM_ISR	(		pxStreamBuffer,
			pxHigherPriorityTaskWoken
	)

Referenced by xStreamBufferReceiveFromISR().

#define sbSEND_COMPLETE_FROM_ISR	(		pxStreamBuffer,
			pxHigherPriorityTaskWoken
	)

Referenced by xStreamBufferSendFromISR().

#define sbSEND_COMPLETED

(

pxStreamBuffer

)

Referenced by xStreamBufferSend().

Function Documentation

static size_t prvBytesInBuffer ( const StreamBuffer_t *const  pxStreamBuffer )

static

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

Referenced by xStreamBufferBytesAvailable(), xStreamBufferNextMessageLengthBytes(), xStreamBufferReceive(), xStreamBufferReceiveFromISR(), xStreamBufferSend(), and xStreamBufferSendFromISR().

static void prvInitialiseNewStreamBuffer ( StreamBuffer_t *const  pxStreamBuffer, uint8_t *const  pucBuffer, size_t  xBufferSizeBytes, size_t  xTriggerLevelBytes, uint8_t  ucFlags  )

static

References configASSERT, memset(), StreamBuffer_t::pucBuffer, StreamBuffer_t::ucFlags, StreamBuffer_t::xLength, and StreamBuffer_t::xTriggerLevelBytes.

Referenced by xStreamBufferReset().

static size_t prvReadBytesFromBuffer ( StreamBuffer_t *  pxStreamBuffer, uint8_t *  pucData, size_t  xMaxCount, size_t  xBytesAvailable  )

static

References configASSERT, configMIN, memcpy(), mtCOVERAGE_TEST_MARKER, StreamBuffer_t::pucBuffer, StreamBuffer_t::xLength, and StreamBuffer_t::xTail.

Referenced by prvReadMessageFromBuffer(), and xStreamBufferNextMessageLengthBytes().

static size_t prvReadMessageFromBuffer ( StreamBuffer_t *  pxStreamBuffer, void *  pvRxData, size_t  xBufferLengthBytes, size_t  xBytesAvailable, size_t  xBytesToStoreMessageLength  )

static

References configMESSAGE_BUFFER_LENGTH_TYPE, mtCOVERAGE_TEST_MARKER, prvReadBytesFromBuffer(), and StreamBuffer_t::xTail.

Referenced by xStreamBufferReceive(), and xStreamBufferReceiveFromISR().

static size_t prvWriteBytesToBuffer ( StreamBuffer_t *const  pxStreamBuffer, const uint8_t *  pucData, size_t  xCount  )

static

References configASSERT, configMIN, memcpy(), mtCOVERAGE_TEST_MARKER, StreamBuffer_t::pucBuffer, StreamBuffer_t::xHead, and StreamBuffer_t::xLength.

Referenced by prvWriteMessageToBuffer().

static size_t prvWriteMessageToBuffer ( StreamBuffer_t *const  pxStreamBuffer, const void *  pvTxData, size_t  xDataLengthBytes, size_t  xSpace, size_t  xRequiredSpace  )

static

References configMIN, pdFALSE, pdTRUE, prvWriteBytesToBuffer(), sbBYTES_TO_STORE_MESSAGE_LENGTH, sbFLAGS_IS_MESSAGE_BUFFER, and StreamBuffer_t::ucFlags.

Referenced by xStreamBufferSend(), and xStreamBufferSendFromISR().

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().

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().