len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-09-12 00:57:44 -04:00
Code Issues Projects Releases Packages Wiki Activity

Remove unnecessary header inclusion and touch up comments

Browse source
This commit is contained in:
David Chalco 2020-03-25 19:09:17 -07:00
parent fd85f367c3
commit 057701d574
4 changed files with 7 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

1
include/queue.h
View file

@ -38,7 +38,6 @@ extern "C" {
#endif #endif
#include "task.h" #include "task.h"
#include "list.h"
/** /**
* Type by which queues are referenced. For example, a call to xQueueCreate() * Type by which queues are referenced. For example, a call to xQueueCreate()

11
include/task.h
View file

@ -156,7 +156,7 @@ typedef enum
eNotBlocked eNotBlocked
} eBlockedStatus; } eBlockedStatus;
/* Used with eTaskGetCurrentBlocker to return either a pointer or a integer */ /* Used with vTaskGetCurrentBlocker to return details on what is blocking a task */
typedef struct XTASK_BLOCKED_STATUS typedef struct XTASK_BLOCKED_STATUS
{ {
eBlockedStatus eStatus; eBlockedStatus eStatus;
@ -1799,22 +1799,22 @@ uint32_t ulTaskGetIdleRunTimeCounter( void ) PRIVILEGED_FUNCTION;
* INCLUDE_vTaskGetCurrentBlocker must be defined as 1 for this function to be available. * INCLUDE_vTaskGetCurrentBlocker must be defined as 1 for this function to be available.
* See the configuration section for more information. * See the configuration section for more information.
* *
* Note, if xTask is NULL or is the running task this function the return eStatus will always be eNotBlocked because * Note, if xTask is NULL or is the running task eStatus will always be eNotBlocked because
* the task can not be blocked if it is running. * the task can not be blocked if it is running.
* *
* TaskBlockedStatus_t holds an eStatus member and both pxEventList in xUntilTick in union. eStatus will always be * TaskBlockedStatus_t holds an eStatus member and a union containing pxEventList and xUntilTick. eStatus will always be
* be set, however pxEventList will only ever be assigned the blocking event list when the task is eBlockedForEvent. * be set, however pxEventList will only ever be assigned the blocking event list when the task is eBlockedForEvent.
* When the the task is eBlockedForTime, xUntilTick will be assigned the tick index at which the task can exit * When the the task is eBlockedForTime, xUntilTick will be assigned the tick index at which the task can exit
* the Blocked state. * the Blocked state.
* *
* eStatus will be eBlockedForEvent if the task is blocked and waiting on a RTOS object event list. * eStatus will be eBlockedForEvent if the task is blocked and waiting on a RTOS object event list.
* If it is not eBlockedEvent, eStatus will be eBlockedForNotification if config_USENOTIFICATIONS is set to 1 * If it is not eBlockedEvent, eStatus will be eBlockedForNotification if configUSE_TASK_NOTIFICATIONS is set to 1
* and the task is waiting for a notification. If the task is blocked but neither eBlockedForEvent nor eBlockedForNotification, * and the task is waiting for a notification. If the task is blocked but neither eBlockedForEvent nor eBlockedForNotification,
* eStatus will be eBlockedForTime and xUntilTick will be assigned the tick value at which the task can exit the blocked state. * eStatus will be eBlockedForTime and xUntilTick will be assigned the tick value at which the task can exit the blocked state.
* list. If the task is not blocked, eStatus will be eNotBlocked. * list. If the task is not blocked, eStatus will be eNotBlocked.
* *
* Some RTOS objects establish ownership of their event lists, such as semaphores. To retrieve the owner of the event list, * Some RTOS objects establish ownership of their event lists, such as semaphores. To retrieve the owner of the event list,
* you can call listGET_LIST_OWNER() to get a void * pointer to the * you can call listGET_LIST_OWNER() to get a void * pointer to the owner, in the case of semaphores the owner would be a SemaphoreHandle_t.
* *
* @param xTask The handle of the task to query. If xTask == NULL, the current running task is evaluated. * @param xTask The handle of the task to query. If xTask == NULL, the current running task is evaluated.
* *
@ -1824,7 +1824,6 @@ uint32_t ulTaskGetIdleRunTimeCounter( void ) PRIVILEGED_FUNCTION;
* \ingroup TaskUtils * \ingroup TaskUtils
* *
*/ */
void vTaskGetCurrentBlocker( TaskHandle_t xTask, TaskBlockedStatus_t * pxBlockedStatus ) PRIVILEGED_FUNCTION; void vTaskGetCurrentBlocker( TaskHandle_t xTask, TaskBlockedStatus_t * pxBlockedStatus ) PRIVILEGED_FUNCTION;
/** /**

2
list.c
View file

@ -36,7 +36,7 @@
void vListInitialise( List_t * const pxList ) void vListInitialise( List_t * const pxList )
{ {
/* Ownership of a list is claimed/queried via listLIST_SET_OWNER and listLIST_GET_OWNER*/ /* Ownership of a list is claimed/queried via listSET_LIST_OWNER and listGET_LIST_OWNER*/
pxList->pvOwner = NULL; pxList->pvOwner = NULL;
/* The list structure contains a list item which is used to mark the /* The list structure contains a list item which is used to mark the