mikisama/FreeRTOS-Kernel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Replace <pre> with @code - remaining files (#388)

Browse Source 
Co-authored-by: Paul Bartell <pbartell@amazon.com>
Co-authored-by: Ming Yue <mingyue86010@gmail.com>
This commit is contained in:
Zim Kalinowski
2021-09-08 03:03:12 +08:00
committed by GitHub
parent fa0f5c436c
commit f8ada39d85
7 changed files with 421 additions and 381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
include/croutine.h
View File

@ -62,13 +62,13 @@ typedef struct corCoRoutineControlBlock
/**
* croutine. h
* <pre>
* @code{c}
* BaseType_t xCoRoutineCreate(
* crCOROUTINE_CODE pxCoRoutineCode,
* UBaseType_t uxPriority,
* UBaseType_t uxIndex
* );
* </pre>
* @endcode
*
* Create a new co-routine and add it to the list of co-routines that are
* ready to run.
@ -88,7 +88,7 @@ typedef struct corCoRoutineControlBlock
* list, otherwise an error code defined with ProjDefs.h.
*
* Example usage:
* <pre>
* @code{c}
* // Co-routine to be created.
* void vFlashCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
* {
@ -129,7 +129,7 @@ typedef struct corCoRoutineControlBlock
* xCoRoutineCreate( vFlashCoRoutine, 0, uxIndex );
* }
* }
* </pre>
* @endcode
* \defgroup xCoRoutineCreate xCoRoutineCreate
* \ingroup Tasks
*/
@ -140,9 +140,9 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
/**
* croutine. h
* <pre>
* @code{c}
* void vCoRoutineSchedule( void );
* </pre>
* @endcode
*
* Run a co-routine.
*
@ -156,7 +156,7 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
* hook).
*
* Example usage:
* <pre>
* @code{c}
* // This idle task hook will schedule a co-routine each time it is called.
* // The rest of the idle task will execute between co-routine calls.
* void vApplicationIdleHook( void )
@ -174,7 +174,7 @@ BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode,
* vCoRoutineSchedule();
* }
* }
* </pre>
* @endcode
* \defgroup vCoRoutineSchedule vCoRoutineSchedule
* \ingroup Tasks
*/
@ -182,14 +182,14 @@ void vCoRoutineSchedule( void );
/**
* croutine. h
* <pre>
* @code{c}
* crSTART( CoRoutineHandle_t xHandle );
* </pre>
* @endcode
*
* This macro MUST always be called at the start of a co-routine function.
*
* Example usage:
* <pre>
* @code{c}
* // Co-routine to be created.
* void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
* {
@ -207,7 +207,7 @@ void vCoRoutineSchedule( void );
* // Must end every co-routine with a call to crEND();
* crEND();
* }
* </pre>
* @endcode
* \defgroup crSTART crSTART
* \ingroup Tasks
*/
@ -217,14 +217,14 @@ void vCoRoutineSchedule( void );
/**
* croutine. h
* <pre>
* @code{c}
* crEND();
* </pre>
* @endcode
*
* This macro MUST always be called at the end of a co-routine function.
*
* Example usage:
* <pre>
* @code{c}
* // Co-routine to be created.
* void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
* {
@ -242,7 +242,7 @@ void vCoRoutineSchedule( void );
* // Must end every co-routine with a call to crEND();
* crEND();
* }
* </pre>
* @endcode
* \defgroup crSTART crSTART
* \ingroup Tasks
*/
@ -261,9 +261,9 @@ void vCoRoutineSchedule( void );
/**
* croutine. h
* <pre>
* @code{c}
* crDELAY( CoRoutineHandle_t xHandle, TickType_t xTicksToDelay );
* </pre>
* @endcode
*
* Delay a co-routine for a fixed period of time.
*
@ -280,7 +280,7 @@ void vCoRoutineSchedule( void );
* can be used to convert ticks to milliseconds.
*
* Example usage:
* <pre>
* @code{c}
* // Co-routine to be created.
* void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
* {
@ -303,7 +303,7 @@ void vCoRoutineSchedule( void );
* // Must end every co-routine with a call to crEND();
* crEND();
* }
* </pre>
* @endcode
* \defgroup crDELAY crDELAY
* \ingroup Tasks
*/
@ -315,7 +315,7 @@ void vCoRoutineSchedule( void );
crSET_STATE0( ( xHandle ) );
/**
* <pre>
* @code{c}
* crQUEUE_SEND(
* CoRoutineHandle_t xHandle,
* QueueHandle_t pxQueue,
@ -323,7 +323,7 @@ void vCoRoutineSchedule( void );
* TickType_t xTicksToWait,
* BaseType_t *pxResult
* )
* </pre>
* @endcode
*
* The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
* equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.
@ -363,7 +363,7 @@ void vCoRoutineSchedule( void );
* error defined within ProjDefs.h.
*
* Example usage:
* <pre>
* @code{c}
* // Co-routine function that blocks for a fixed period then posts a number onto
* // a queue.
* static void prvCoRoutineFlashTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
@ -395,7 +395,7 @@ void vCoRoutineSchedule( void );
* // Co-routines must end with a call to crEND().
* crEND();
* }
* </pre>
* @endcode
* \defgroup crQUEUE_SEND crQUEUE_SEND
* \ingroup Tasks
*/
@ -416,7 +416,7 @@ void vCoRoutineSchedule( void );
/**
* croutine. h
* <pre>
* @code{c}
* crQUEUE_RECEIVE(
* CoRoutineHandle_t xHandle,
* QueueHandle_t pxQueue,
@ -424,7 +424,7 @@ void vCoRoutineSchedule( void );
* TickType_t xTicksToWait,
* BaseType_t *pxResult
* )
* </pre>
* @endcode
*
* The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine
* equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.
@ -463,7 +463,7 @@ void vCoRoutineSchedule( void );
* an error code as defined within ProjDefs.h.
*
* Example usage:
* <pre>
* @code{c}
* // A co-routine receives the number of an LED to flash from a queue. It
* // blocks on the queue until the number is received.
* static void prvCoRoutineFlashWorkTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
@ -489,7 +489,7 @@ void vCoRoutineSchedule( void );
*
* crEND();
* }
* </pre>
* @endcode
* \defgroup crQUEUE_RECEIVE crQUEUE_RECEIVE
* \ingroup Tasks
*/
@ -510,13 +510,13 @@ void vCoRoutineSchedule( void );
/**
* croutine. h
* <pre>
* @code{c}
* crQUEUE_SEND_FROM_ISR(
* QueueHandle_t pxQueue,
* void *pvItemToQueue,
* BaseType_t xCoRoutinePreviouslyWoken
* )
* </pre>
* @endcode
*
* The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the
* co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()
@ -551,7 +551,7 @@ void vCoRoutineSchedule( void );
* the ISR.
*
* Example usage:
* <pre>
* @code{c}
* // A co-routine that blocks on a queue waiting for characters to be received.
* static void vReceivingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
* {
@ -600,7 +600,7 @@ void vCoRoutineSchedule( void );
* xCRWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsRxQueue, &cRxedChar, xCRWokenByPost );
* }
* }
* </pre>
* @endcode
* \defgroup crQUEUE_SEND_FROM_ISR crQUEUE_SEND_FROM_ISR
* \ingroup Tasks
*/
@ -610,13 +610,13 @@ void vCoRoutineSchedule( void );
/**
* croutine. h
* <pre>
* @code{c}
* crQUEUE_SEND_FROM_ISR(
* QueueHandle_t pxQueue,
* void *pvBuffer,
* BaseType_t * pxCoRoutineWoken
* )
* </pre>
* @endcode
*
* The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the
* co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()
@ -651,7 +651,7 @@ void vCoRoutineSchedule( void );
* pdFALSE.
*
* Example usage:
* <pre>
* @code{c}
* // A co-routine that posts a character to a queue then blocks for a fixed
* // period. The character is incremented each time.
* static void vSendingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )
@ -716,7 +716,7 @@ void vCoRoutineSchedule( void );
* }
* }
* }
* </pre>
* @endcode
* \defgroup crQUEUE_RECEIVE_FROM_ISR crQUEUE_RECEIVE_FROM_ISR
* \ingroup Tasks
*/

80
include/message_buffer.h
View File

@ -89,9 +89,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* MessageBufferHandle_t xMessageBufferCreate( size_t xBufferSizeBytes );
* </pre>
* @endcode
*
* Creates a new message buffer using dynamically allocated memory. See
* xMessageBufferCreateStatic() for a version that uses statically allocated
@ -115,7 +115,7 @@ typedef void * MessageBufferHandle_t;
* buffer.
*
* Example use:
* <pre>
* @code{c}
*
* void vAFunction( void )
* {
@ -138,7 +138,7 @@ typedef void * MessageBufferHandle_t;
* // The message buffer was created successfully and can now be used.
* }
*
* </pre>
* @endcode
* \defgroup xMessageBufferCreate xMessageBufferCreate
* \ingroup MessageBufferManagement
*/
@ -148,11 +148,11 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* MessageBufferHandle_t xMessageBufferCreateStatic( size_t xBufferSizeBytes,
* uint8_t *pucMessageBufferStorageArea,
* StaticMessageBuffer_t *pxStaticMessageBuffer );
* </pre>
* @endcode
* Creates a new message buffer using statically allocated memory. See
* xMessageBufferCreate() for a version that uses dynamically allocated memory.
*
@ -177,7 +177,7 @@ typedef void * MessageBufferHandle_t;
* pxStaticmessageBuffer are NULL then NULL is returned.
*
* Example use:
* <pre>
* @code{c}
*
* // Used to dimension the array used to hold the messages. The available space
* // will actually be one less than this, so 999.
@ -205,7 +205,7 @@ typedef void * MessageBufferHandle_t;
* // Other code that uses the message buffer can go here.
* }
*
* </pre>
* @endcode
* \defgroup xMessageBufferCreateStatic xMessageBufferCreateStatic
* \ingroup MessageBufferManagement
*/
@ -215,12 +215,12 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* size_t xMessageBufferSend( MessageBufferHandle_t xMessageBuffer,
* const void *pvTxData,
* size_t xDataLengthBytes,
* TickType_t xTicksToWait );
* </pre>
* @endcode
*
* Sends a discrete message to the message buffer. The message can be any
* length that fits within the buffer's free space, and is copied into the
@ -277,7 +277,7 @@ typedef void * MessageBufferHandle_t;
* time out then xDataLengthBytes is returned.
*
* Example use:
* <pre>
* @code{c}
* void vAFunction( MessageBufferHandle_t xMessageBuffer )
* {
* size_t xBytesSent;
@ -305,7 +305,7 @@ typedef void * MessageBufferHandle_t;
* // not enough free space in the buffer.
* }
* }
* </pre>
* @endcode
* \defgroup xMessageBufferSend xMessageBufferSend
* \ingroup MessageBufferManagement
*/
@ -315,12 +315,12 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* size_t xMessageBufferSendFromISR( MessageBufferHandle_t xMessageBuffer,
* const void *pvTxData,
* size_t xDataLengthBytes,
* BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* Interrupt safe version of the API function that sends a discrete message to
* the message buffer. The message can be any length that fits within the
@ -378,7 +378,7 @@ typedef void * MessageBufferHandle_t;
* then 0 is returned, otherwise xDataLengthBytes is returned.
*
* Example use:
* <pre>
* @code{c}
* // A message buffer that has already been created.
* MessageBufferHandle_t xMessageBuffer;
*
@ -410,7 +410,7 @@ typedef void * MessageBufferHandle_t;
* // documentation for the port in use for port specific instructions.
* portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
* }
* </pre>
* @endcode
* \defgroup xMessageBufferSendFromISR xMessageBufferSendFromISR
* \ingroup MessageBufferManagement
*/
@ -420,12 +420,12 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* size_t xMessageBufferReceive( MessageBufferHandle_t xMessageBuffer,
* void *pvRxData,
* size_t xBufferLengthBytes,
* TickType_t xTicksToWait );
* </pre>
* @endcode
*
* Receives a discrete message from a message buffer. Messages can be of
* variable length and are copied out of the buffer.
@ -478,7 +478,7 @@ typedef void * MessageBufferHandle_t;
* zero is returned.
*
* Example use:
* <pre>
* @code{c}
* void vAFunction( MessageBuffer_t xMessageBuffer )
* {
* uint8_t ucRxData[ 20 ];
@ -499,7 +499,7 @@ typedef void * MessageBufferHandle_t;
* // the message here....
* }
* }
* </pre>
* @endcode
* \defgroup xMessageBufferReceive xMessageBufferReceive
* \ingroup MessageBufferManagement
*/
@ -510,12 +510,12 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* size_t xMessageBufferReceiveFromISR( MessageBufferHandle_t xMessageBuffer,
* void *pvRxData,
* size_t xBufferLengthBytes,
* BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* An interrupt safe version of the API function that receives a discrete
* message from a message buffer. Messages can be of variable length and are
@ -569,7 +569,7 @@ typedef void * MessageBufferHandle_t;
* any.
*
* Example use:
* <pre>
* @code{c}
* // A message buffer that has already been created.
* MessageBuffer_t xMessageBuffer;
*
@ -601,7 +601,7 @@ typedef void * MessageBufferHandle_t;
* // documentation for the port in use for port specific instructions.
* portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
* }
* </pre>
* @endcode
* \defgroup xMessageBufferReceiveFromISR xMessageBufferReceiveFromISR
* \ingroup MessageBufferManagement
*/
@ -611,9 +611,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* void vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer );
* </pre>
* @endcode
*
* Deletes a message buffer that was previously created using a call to
* xMessageBufferCreate() or xMessageBufferCreateStatic(). If the message
@ -631,9 +631,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* @code{c}
* BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer );
* </pre>
* @endcode
*
* Tests to see if a message buffer is full. A message buffer is full if it
* cannot accept any more messages, of any size, until space is made available
@ -649,9 +649,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* @code{c}
* BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer );
* </pre>
* @endcode
*
* Tests to see if a message buffer is empty (does not contain any messages).
*
@ -666,9 +666,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* @code{c}
* BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer );
* </pre>
* @endcode
*
* Resets a message buffer to its initial empty state, discarding any message it
* contained.
@ -691,9 +691,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* @code{c}
* size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer );
* </pre>
* @endcode
* Returns the number of bytes of free space in the message buffer.
*
* @param xMessageBuffer The handle of the message buffer being queried.
@ -715,9 +715,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* @code{c}
* size_t xMessageBufferNextLengthBytes( MessageBufferHandle_t xMessageBuffer );
* </pre>
* @endcode
* Returns the length (in bytes) of the next message in a message buffer.
* Useful if xMessageBufferReceive() returned 0 because the size of the buffer
* passed into xMessageBufferReceive() was too small to hold the next message.
@ -736,9 +736,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xMessageBufferSendCompletedFromISR( MessageBufferHandle_t xMessageBuffer, BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* For advanced users only.
*
@ -776,9 +776,9 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xMessageBufferReceiveCompletedFromISR( MessageBufferHandle_t xMessageBuffer, BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* For advanced users only.
*

136
include/queue.h
View File

File diff suppressed because it is too large Load Diff

136
include/semphr.h
View File

File diff suppressed because it is too large Load Diff

84
include/stream_buffer.h
View File

@ -75,9 +75,9 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* StreamBufferHandle_t xStreamBufferCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes );
* </pre>
* @endcode
*
* Creates a new stream buffer using dynamically allocated memory. See
* xStreamBufferCreateStatic() for a version that uses statically allocated
@ -111,7 +111,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
* buffer.
*
* Example use:
* <pre>
* @code{c}
*
* void vAFunction( void )
* {
@ -133,7 +133,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
* // The stream buffer was created successfully and can now be used.
* }
* }
* </pre>
* @endcode
* \defgroup xStreamBufferCreate xStreamBufferCreate
* \ingroup StreamBufferManagement
*/
@ -142,12 +142,12 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* StreamBufferHandle_t xStreamBufferCreateStatic( size_t xBufferSizeBytes,
* size_t xTriggerLevelBytes,
* uint8_t *pucStreamBufferStorageArea,
* StaticStreamBuffer_t *pxStaticStreamBuffer );
* </pre>
* @endcode
* Creates a new stream buffer using statically allocated memory. See
* xStreamBufferCreate() for a version that uses dynamically allocated memory.
*
@ -184,7 +184,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
* pxStaticstreamBuffer are NULL then NULL is returned.
*
* Example use:
* <pre>
* @code{c}
*
* // Used to dimension the array used to hold the streams. The available space
* // will actually be one less than this, so 999.
@ -214,7 +214,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
* // Other code that uses the stream buffer can go here.
* }
*
* </pre>
* @endcode
* \defgroup xStreamBufferCreateStatic xStreamBufferCreateStatic
* \ingroup StreamBufferManagement
*/
@ -224,12 +224,12 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,
* const void *pvTxData,
* size_t xDataLengthBytes,
* TickType_t xTicksToWait );
* </pre>
* @endcode
*
* Sends bytes to a stream buffer. The bytes are copied into the stream buffer.
*
@ -279,7 +279,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
* write as many bytes as possible.
*
* Example use:
* <pre>
* @code{c}
* void vAFunction( StreamBufferHandle_t xStreamBuffer )
* {
* size_t xBytesSent;
@ -309,7 +309,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
* // were sent. Could try again to send the remaining bytes.
* }
* }
* </pre>
* @endcode
* \defgroup xStreamBufferSend xStreamBufferSend
* \ingroup StreamBufferManagement
*/
@ -321,12 +321,12 @@ size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
* const void *pvTxData,
* size_t xDataLengthBytes,
* BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* Interrupt safe version of the API function that sends a stream of bytes to
* the stream buffer.
@ -378,7 +378,7 @@ size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,
* space for all the bytes to be written.
*
* Example use:
* <pre>
* @code{c}
* // A stream buffer that has already been created.
* StreamBufferHandle_t xStreamBuffer;
*
@ -410,7 +410,7 @@ size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,
* // documentation for the port in use for port specific instructions.
* taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );
* }
* </pre>
* @endcode
* \defgroup xStreamBufferSendFromISR xStreamBufferSendFromISR
* \ingroup StreamBufferManagement
*/
@ -422,12 +422,12 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,
* void *pvRxData,
* size_t xBufferLengthBytes,
* TickType_t xTicksToWait );
* </pre>
* @endcode
*
* Receives bytes from a stream buffer.
*
@ -477,7 +477,7 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
* out before xBufferLengthBytes were available.
*
* Example use:
* <pre>
* @code{c}
* void vAFunction( StreamBuffer_t xStreamBuffer )
* {
* uint8_t ucRxData[ 20 ];
@ -499,7 +499,7 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,
* // be processed here....
* }
* }
* </pre>
* @endcode
* \defgroup xStreamBufferReceive xStreamBufferReceive
* \ingroup StreamBufferManagement
*/
@ -511,12 +511,12 @@ size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,
* void *pvRxData,
* size_t xBufferLengthBytes,
* BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* An interrupt safe version of the API function that receives bytes from a
* stream buffer.
@ -553,7 +553,7 @@ size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,
* @return The number of bytes read from the stream buffer, if any.
*
* Example use:
* <pre>
* @code{c}
* // A stream buffer that has already been created.
* StreamBuffer_t xStreamBuffer;
*
@ -585,7 +585,7 @@ size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,
* // documentation for the port in use for port specific instructions.
* taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );
* }
* </pre>
* @endcode
* \defgroup xStreamBufferReceiveFromISR xStreamBufferReceiveFromISR
* \ingroup StreamBufferManagement
*/
@ -597,9 +597,9 @@ size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer );
* </pre>
* @endcode
*
* Deletes a stream buffer that was previously created using a call to
* xStreamBufferCreate() or xStreamBufferCreateStatic(). If the stream
@ -619,9 +619,9 @@ void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTI
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer );
* </pre>
* @endcode
*
* Queries a stream buffer to see if it is full. A stream buffer is full if it
* does not have any free space, and therefore cannot accept any more data.
@ -639,9 +639,9 @@ BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );
* </pre>
* @endcode
*
* Queries a stream buffer to see if it is empty. A stream buffer is empty if
* it does not contain any data.
@ -659,9 +659,9 @@ BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer );
* </pre>
* @endcode
*
* Resets a stream buffer to its initial, empty, state. Any data that was in
* the stream buffer is discarded. A stream buffer can only be reset if there
@ -682,9 +682,9 @@ BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_F
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer );
* </pre>
* @endcode
*
* Queries a stream buffer to see how much free space it contains, which is
* equal to the amount of data that can be sent to the stream buffer before it
@ -703,9 +703,9 @@ size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVIL
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer );
* </pre>
* @endcode
*
* Queries a stream buffer to see how much data it contains, which is equal to
* the number of bytes that can be read from the stream buffer before the stream
@ -724,9 +724,9 @@ size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILE
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel );
* </pre>
* @endcode
*
* A stream buffer's trigger level is the number of bytes that must be in the
* stream buffer before a task that is blocked on the stream buffer to
@ -762,9 +762,9 @@ BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer,
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* For advanced users only.
*
@ -802,9 +802,9 @@ BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer
/**
* stream_buffer.h
*
* <pre>
* @code{c}
* BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );
* </pre>
* @endcode
*
* For advanced users only.
*

290
include/task.h
View File

File diff suppressed because it is too large Load Diff

4
include/timers.h
View File

@ -1330,7 +1330,9 @@ BaseType_t xTimerGenericCommand( TimerHandle_t xTimer,
/**
* task.h
* <pre>void vApplicationGetTimerTaskMemory( StaticTask_t ** ppxTimerTaskTCBBuffer, StackType_t ** ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize ) </pre>
* @code{c}
* void vApplicationGetTimerTaskMemory( StaticTask_t ** ppxTimerTaskTCBBuffer, StackType_t ** ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize )
* @endcode
*
* This function is used to provide a statically allocated block of memory to FreeRTOS to hold the Timer Task TCB. This function is required when
* configSUPPORT_STATIC_ALLOCATION is set. For more information see this URI: https://www.FreeRTOS.org/a00110.html#configSUPPORT_STATIC_ALLOCATION