RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

score misc: Score misc: Clean up Doxygen #7 (GCI 2012)

Browse Source 
This patch is a task from GCI 2012 which improves the Doxygen
    comments in the RTEMS source.

https://google-melange.appspot.com/gci/task/view/google/gci2012/7986214
This commit is contained in:
Alex Ivanov
2012-11-29 17:14:28 -06:00
committed by Joel Sherrill
parent 1b4758602f
commit f2f63d1548
27 changed files with 184 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
cpukit/score/include/rtems/score/object.h
View File

@@ -497,6 +497,8 @@ void _Objects_Initialize_information (
);
/**
* @brief Object API Maximum Class
*
* This function returns the highest numeric value of a valid
* API for the specified @a api.
*
@@ -509,6 +511,8 @@ unsigned int _Objects_API_maximum_class(
);
/**
* @brief Allocate Object
*
* This function allocates a object control block from
* the inactive chain of free object control blocks.
*
@@ -670,6 +674,8 @@ Objects_Control *_Objects_Get (
);
/**
* @brief Object Get Isr Disable
*
* This function maps object ids to object control blocks.
* If id corresponds to a local object, then it returns
* the_object control pointer which maps to id and location
@@ -831,6 +837,8 @@ void _Objects_Namespace_remove(
);
/**
* @brief Close Object
*
* This function removes the_object control pointer and object name
* in the Local Pointer and Local Name Tables.
*

2
cpukit/score/include/rtems/score/objectmp.h
View File

@@ -55,7 +55,7 @@ typedef struct {
void _Objects_MP_Handler_initialization(void);
/**
* @brief Objects MP Handler Early initialization
* @brief Objects MP Handler Early Initialization
*
* This routine intializes the global object node number
* used in the ID field of all objects.

5
cpukit/score/include/rtems/score/rbtree.h
View File

@@ -189,6 +189,11 @@ RBTree_Node name = RBTREE_NODE_INITIALIZER_EMPTY(name)
* This routine initializes @a the_rbtree structure to manage the
* contiguous array of @a number_nodes nodes which starts at
* @a starting_address. Each node is of @a node_size bytes.
*
* @param[in] the_rbtree is the pointer to rbtree header
* @param[in] starting_address is the starting address of first node
* @param[in] number_nodes is the number of nodes in rbtree
* @param[in] node_size is the size of node in bytes
*/
void _RBTree_Initialize(
RBTree_Control *the_rbtree,

4
cpukit/score/include/rtems/score/schedulerpriority.h
View File

@@ -91,6 +91,8 @@ void _Scheduler_priority_Block(
void _Scheduler_priority_Schedule(void);
/**
* @brief Allocate Scheduler Priority
*
* This routine allocates @a the_thread->scheduler.
*
* @param[in] the_thread is the thread the scheduler is allocating
@@ -164,6 +166,8 @@ void _Scheduler_priority_Enqueue(
);
/**
* @brief Scheduler Priority Enqueue First
*
* This routine puts @a the_thread to the head of the ready queue.
* For priority-based ready queues, the thread will be the first thread
* at its priority level.

2
cpukit/score/include/rtems/score/schedulersimple.h
View File

@@ -190,7 +190,7 @@ void _Scheduler_simple_Ready_queue_enqueue(
);
/**
* _Scheduler_simple_Ready_queue_enqueue_first
* @brief Scheduler Simple Ready Queue Enqueue First
*
* This routine puts @a the_thread on to the ready queue
* at the beginning of its priority group.

8
cpukit/score/include/rtems/score/thread.h
View File

@@ -647,6 +647,8 @@ void _Thread_Reset(
);
/**
* @brief Thread Close
*
* This routine frees all memory associated with the specified
* thread and removes it from the local object table so no further
* operations on this thread are allowed.
@@ -657,9 +659,15 @@ void _Thread_Close(
);
/**
* @brief Thread Ready
*
* This routine removes any set states for @a the_thread. It performs
* any necessary scheduling operations including the selection of
* a new heir thread.
*
* - INTERRUPT LATENCY:
* + ready chain
* + select heir
*/
void _Thread_Ready(
Thread_Control *the_thread

22
cpukit/score/include/rtems/score/threadq.h
View File

@@ -149,6 +149,10 @@ bool _Thread_queue_Extract_with_proxy(
* This function returns a pointer to the "first" thread
* on the_thread_queue. The "first" thread is selected
* based on the discipline of the_thread_queue.
*
* @param[in] the_thread_queue pointer to thread queue
*
* @return first thread or NULL
*/
Thread_Control *_Thread_queue_First(
Thread_queue_Control *the_thread_queue
@@ -172,6 +176,11 @@ void _Thread_queue_Flush(
* This routine initializes the_thread_queue based on the
* discipline indicated in attribute_set. The state set on
* threads which block on the_thread_queue is state.
*
* @param[in] the_thread_queue is the pointer to a threadq header
* @param[in] discipline is the queueing discipline
* @param[in] state is the state of waiting threads
* @param[in] timeout_status is the return on a timeout
*/
void _Thread_queue_Initialize(
Thread_queue_Control *the_thread_queue,
@@ -199,11 +208,18 @@ Thread_Control *_Thread_queue_Dequeue_priority(
);
/**
* @brief Thread Queue Enqueue priority
* @brief Thread Queue Enqueue Priority
*
* This routine enqueues the currently executing thread on
* the_thread_queue with an optional timeout using the
* priority discipline.
*
* @param[in] the_thread_queue is the pointer to threadq
* @param[in] thread is the thread to insert
*
* - INTERRUPT LATENCY:
* + forward less than
* + forward equal
*/
Thread_blocking_operation_States _Thread_queue_Enqueue_priority (
Thread_queue_Control *the_thread_queue,
@@ -307,13 +323,15 @@ Thread_Control *_Thread_queue_First_fifo(
);
/**
* @brief Thread Queue timeout
* @brief Thread Queue Timeout
*
* This routine is invoked when a task's request has not
* been satisfied after the timeout interval specified to
* enqueue. The task represented by ID will be unblocked and
* its status code will be set in it's control block to indicate
* that a timeout has occurred.
*
* @param[in] id thread id
*/
void _Thread_queue_Timeout (
Objects_Id id,

19
cpukit/score/src/objectallocate.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Allocate Object
* @ingroup ScoreObject
*/
/*
* Object Handler
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -32,15 +36,6 @@
#include <rtems/bspIo.h>
#endif
/*
* _Objects_Allocate
*
* DESCRIPTION:
*
* This function allocates a object control block from
* the inactive chain of free object control blocks.
*/
Objects_Control *_Objects_Allocate(
Objects_Information *information
)

7
cpukit/score/src/objectapimaximumclass.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Object API Maximum Class
* @ingroup ScoreObject
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).

7
cpukit/score/src/objectclose.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Close Object
* @ingroup ScoreObject
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).

31
cpukit/score/src/objectgetisr.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Object Get Isr Disable
* @ingroup ScoreObject
*/
/*
* Object Handler
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -26,27 +30,6 @@
#include <rtems/score/sysstate.h>
#include <rtems/score/isr.h>
/*
* _Objects_Get_isr_disable
*
* This routine sets the object pointer for the given
* object id based on the given object information structure.
*
* Input parameters:
* information - pointer to entry in table for this class
* id - object id to search for
* location - address of where to store the location
* level - pointer to previous interrupt level
*
* Output parameters:
* returns - address of object if local
* location - one of the following:
* OBJECTS_ERROR - invalid object ID
* OBJECTS_REMOTE - remote object
* OBJECTS_LOCAL - local object
* *level - previous interrupt level
*/
Objects_Control *_Objects_Get_isr_disable(
Objects_Information *information,
Objects_Id id,

39
cpukit/score/src/objectmp.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Objects MP Support
* @ingroup ScoreObjectMP
*/
/*
* Multiprocessing Support for the Object Handler
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,10 +25,6 @@
#include <rtems/score/wkspace.h>
#include <rtems/score/thread.h>
/*
* _Objects_MP_Handler_early_initialization
*
*/
void _Objects_MP_Handler_early_initialization(void)
{
uint32_t node;
@@ -74,11 +74,6 @@ void _Objects_MP_Handler_initialization(void)
}
/*
* _Objects_MP_Open
*
*/
void _Objects_MP_Open (
Objects_Information *information,
Objects_MP_Control *the_global_object,
@@ -96,11 +91,6 @@ void _Objects_MP_Open (
}
/*
* _Objects_MP_Allocate_and_open
*
*/
bool _Objects_MP_Allocate_and_open (
Objects_Information *information,
uint32_t the_name, /* XXX -- wrong for variable */
@@ -129,11 +119,6 @@ bool _Objects_MP_Allocate_and_open (
return true;
}
/*
* _Objects_MP_Close
*
*/
void _Objects_MP_Close (
Objects_Information *information,
Objects_Id the_id
@@ -167,11 +152,6 @@ void _Objects_MP_Close (
);
}
/*
* _Objects_MP_Global_name_search
*
*/
Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search (
Objects_Information *information,
Objects_Name the_name,
@@ -235,11 +215,6 @@ Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search (
return OBJECTS_INVALID_NAME;
}
/*
* _Objects_MP_Is_remote
*
*/
void _Objects_MP_Is_remote (
Objects_Information *information,
Objects_Id the_id,

21
cpukit/score/src/rbtree.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Initialize a RBTree Header
* @ingroup ScoreRBTree
*/
/*
* Copyright (c) 2010 Gedare Bloom.
*
@@ -15,20 +22,6 @@
#include <rtems/score/rbtree.h>
#include <rtems/score/isr.h>
/*
* _RBTree_Initialize
*
* This kernel routine initializes a Red-Black Tree.
*
* Input parameters:
* the_rbtree - pointer to rbtree header
* starting_address - starting address of first node
* number_nodes - number of nodes in rbtree
* node_size - size of node in bytes
*
* Output parameters: NONE
*/
void _RBTree_Initialize(
RBTree_Control *the_rbtree,
RBTree_Compare_function compare_function,

7
cpukit/score/src/scheduleredfextract.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Scheduler EDF Extract
* @ingroup ScoreScheduler
*/
/*
* Copyright (C) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).

9
cpukit/score/src/schedulerpriorityallocate.c
View File

@@ -1,6 +1,11 @@
/*
* Scheduler Priority Handler / Allocate
/**
* @file
*
* @brief Allocate Scheduler Priority
* @ingroup ScoreScheduler
*/
/*
* Copyright (C) 2010 Gedare Bloom.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
*

7
cpukit/score/src/schedulerpriorityenqueuefirst.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Scheduler Priority Enqueue First
* @ingroup ScoreScheduler
*/
/*
* COPYRIGHT (c) 2011.
* On-Line Applications Research Corporation (OAR).

9
cpukit/score/src/schedulersimplereadyqueueenqueuefirst.c
View File

@@ -1,6 +1,11 @@
/*
* Schedule Simple Handler / Ready Queue Enqueue First
/**
* @file
*
* @brief Scheduler Simple Ready Queue Enqueue First
* @ingroup ScoreScheduler
*/
/*
* COPYRIGHT (c) 2011.
* On-Line Applications Research Corporation (OAR).
*

9
cpukit/score/src/threadclose.c
View File

@@ -1,6 +1,11 @@
/*
* Thread Handler / Thread Close
/**
* @file
*
* @brief Thread Close
* @ingroup ScoreThread
*/
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*

24
cpukit/score/src/threadq.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Thread Queue Initialize
* @ingroup ScoreThreadQ
*/
/*
* Thread Queue Handler
*
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,20 +27,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/tqdata.h>
/*
* _Thread_queue_Initialize
*
* This routine initializes the specified threadq.
*
* Input parameters:
* the_thread_queue - pointer to a threadq header
* discipline - queueing discipline
* state - state of waiting threads
* timeout_status - return on a timeout
*
* Output parameters: NONE
*/
void _Thread_queue_Initialize(
Thread_queue_Control *the_thread_queue,
Thread_queue_Disciplines the_discipline,

25
cpukit/score/src/threadqenqueuepriority.c
View File

@@ -1,6 +1,11 @@
/*
* Thread Queue Handler - Enqueue By Priority
/**
* @file
*
* @brief Thread Queue Enqueue Priority
* @ingroup ScoreThreadQ
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,22 +35,6 @@
#define CPU_UNROLL_ENQUEUE_PRIORITY FALSE
#endif
/*
* _Thread_queue_Enqueue_priority
*
* This routine places a blocked thread on a priority thread queue.
*
* Input parameters:
* the_thread_queue - pointer to threadq
* thread - thread to insert
*
* Output parameters: NONE
*
* INTERRUPT LATENCY:
* forward less than
* forward equal
*/
Thread_blocking_operation_States _Thread_queue_Enqueue_priority (
Thread_queue_Control *the_thread_queue,
Thread_Control *the_thread,

23
cpukit/score/src/threadqfirst.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Thread Queue First
* @ingroup ScoreThreadQ
*/
/*
* Thread Queue Handler
*
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,19 +27,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/tqdata.h>
/*
* _Thread_queue_First
*
* This routines returns a pointer to the first thread on the
* specified threadq.
*
* Input parameters:
* the_thread_queue - pointer to thread queue
*
* Output parameters:
* returns - first thread or NULL
*/
Thread_Control *_Thread_queue_First(
Thread_queue_Control *the_thread_queue
)

22
cpukit/score/src/threadqtimeout.c
View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Thread Queue Timeout
* @ingroup ScoreThreadQ
*/
/*
* Thread Queue Handler
*
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,18 +27,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/tqdata.h>
/*
* _Thread_queue_Timeout
*
* This routine processes a thread which timeouts while waiting on
* a thread queue. It is called by the watchdog handler.
*
* Input parameters:
* id - thread id
*
* Output parameters: NONE
*/
void _Thread_queue_Timeout(
Objects_Id id,
void *ignored __attribute__((unused))

14
cpukit/score/src/threadready.c
View File

@@ -1,6 +1,11 @@
/*
* Thread Handler / Thread Ready
/**
* @file
*
* @brief Thread Ready
* @ingroup ScoreThread
*/
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
@@ -27,11 +32,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/wkspace.h>
/*
* INTERRUPT LATENCY:
* ready chain
* select heir
*/
void _Thread_Ready(
Thread_Control *the_thread
)

7
cpukit/score/src/timespecfromticks.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Convert Ticks to Timespec
* @ingroup Timespec
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).

5
cpukit/score/src/timespecisvalid.c
View File

@@ -1,5 +1,8 @@
/**
* @file score/src/timespecisvalid.c
* @file
*
* @brief Is Timespec Valid
* @ingroup Timespec
*/
/*

17
cpukit/score/src/watchdog.c
View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @brief Watchdog Handler Initialization
* @ingroup ScoreWatchdog
*/
/*
* Watchdog Handler
*
@@ -18,16 +25,6 @@
#include <rtems/score/isr.h>
#include <rtems/score/watchdog.h>
/*
* _Watchdog_Handler_initialization
*
* This routine initializes the watchdog handler.
*
* Input parameters: NONE
*
* Output parameters: NONE
*/
void _Watchdog_Handler_initialization( void )
{
_Watchdog_Sync_count = 0;

18
cpukit/score/src/wkspace.c
View File

@@ -1,6 +1,11 @@
/*
* Workspace Handler
/**
* @file
*
* @brief Workspace Handler Support
* @ingroup ScoreWorkspace
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -25,9 +30,6 @@
#include <rtems/bspIo.h>
#endif
/*
* _Workspace_Handler_initialization
*/
void _Workspace_Handler_initialization(
Heap_Area *areas,
size_t area_count,
@@ -93,9 +95,6 @@ void _Workspace_Handler_initialization(
}
}
/*
* _Workspace_Allocate
*/
void *_Workspace_Allocate(
size_t size
)
@@ -133,9 +132,6 @@ void _Workspace_Free(
_Heap_Free( &_Workspace_Area, block );
}
/*
* _Workspace_Allocate_or_fatal_error
*/
void *_Workspace_Allocate_or_fatal_error(
size_t size
)