epagris/FreeRTOS-Kernel
1
0
Fork 1
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2026-04-22 14:40:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix stream/message buffer type and timeout in example

Browse Source
This commit is contained in:
1294644079@qq.com 2026-04-18 23:35:43 +08:00 committed by Kody Stribrny
parent 7c0c890c64
commit 5f2cc25b17
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/message_buffer.h
View File

@ -560,14 +560,14 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
* *
* Example use: * Example use:
* @code{c} * @code{c}
* void vAFunction( MessageBuffer_t xMessageBuffer ) * void vAFunction( MessageBufferHandle_t xMessageBuffer )
* { * {
* uint8_t ucRxData[ 20 ]; * uint8_t ucRxData[ 20 ];
* size_t xReceivedBytes; * size_t xReceivedBytes;
* const TickType_t xBlockTime = pdMS_TO_TICKS( 20 ); * const TickType_t xBlockTime = pdMS_TO_TICKS( 20 );
* *
* // Receive the next message from the message buffer. Wait in the Blocked * // Receive the next message from the message buffer. Wait in the Blocked
* // state (so not using any CPU processing time) for a maximum of 100ms for * // state (so not using any CPU processing time) for a maximum of 20ms for
* // a message to become available. * // a message to become available.
* xReceivedBytes = xMessageBufferReceive( xMessageBuffer, * xReceivedBytes = xMessageBufferReceive( xMessageBuffer,
* ( void * ) ucRxData, * ( void * ) ucRxData,
@ -655,7 +655,7 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
* Example use: * Example use:
* @code{c} * @code{c}
* // A message buffer that has already been created. * // A message buffer that has already been created.
* MessageBuffer_t xMessageBuffer; * MessageBufferHandle_t xMessageBuffer;
* *
* void vAnInterruptServiceRoutine( void ) * void vAnInterruptServiceRoutine( void )
* { * {

8
include/stream_buffer.h
View File

@ -760,7 +760,7 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
* *
* Example use: * Example use:
* @code{c} * @code{c}
* void vAFunction( StreamBuffer_t xStreamBuffer ) * void vAFunction( StreamBufferHandle_t xStreamBuffer )
* { * {
* uint8_t ucRxData[ 20 ]; * uint8_t ucRxData[ 20 ];
* size_t xReceivedBytes; * size_t xReceivedBytes;
@ -768,7 +768,7 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
* *
* // Receive up to another sizeof( ucRxData ) bytes from the stream buffer. * // Receive up to another sizeof( ucRxData ) bytes from the stream buffer.
* // Wait in the Blocked state (so not using any CPU processing time) for a * // Wait in the Blocked state (so not using any CPU processing time) for a
* // maximum of 100ms for the full sizeof( ucRxData ) number of bytes to be * // maximum of 20ms for the full sizeof( ucRxData ) number of bytes to be
* // available. * // available.
* xReceivedBytes = xStreamBufferReceive( xStreamBuffer, * xReceivedBytes = xStreamBufferReceive( xStreamBuffer,
* ( void * ) ucRxData, * ( void * ) ucRxData,
@ -840,7 +840,7 @@ size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,
* Example use: * Example use:
* @code{c} * @code{c}
* // A stream buffer that has already been created. * // A stream buffer that has already been created.
* StreamBuffer_t xStreamBuffer; * StreamBufferHandle_t xStreamBuffer;
* *
* void vAnInterruptServiceRoutine( void ) * void vAnInterruptServiceRoutine( void )
* { * {
@ -1218,7 +1218,7 @@ UBaseType_t uxStreamBufferGetStreamBufferNotificationIndex( StreamBufferHandle_t
* stream_buffer.h * stream_buffer.h
* *
* @code{c} * @code{c}
* void vStreamBufferSetStreamBufferNotificationIndex ( StreamBuffer_t xStreamBuffer, UBaseType_t uxNotificationIndex ); * void vStreamBufferSetStreamBufferNotificationIndex ( StreamBufferHandle_t xStreamBuffer, UBaseType_t uxNotificationIndex );
* @endcode * @endcode
* *
* Set the task notification index used for the supplied stream buffer. * Set the task notification index used for the supplied stream buffer.