score misc: Clean up Doxygen #12 (GCI 2012)

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

http://www.google-melange.com/gci/task/view/google/gci2012/8025203
This commit is contained in:
Alex Ivanov
2012-12-02 10:03:09 -06:00
committed by Joel Sherrill
parent 5a58b1e498
commit 52adc80842
30 changed files with 251 additions and 385 deletions

View File

@@ -435,6 +435,11 @@ typedef struct {
*/
#define EVENT_CURRENT 0
/**
* @brief Event Manager Initialization
*
* This routine performs the initialization necessary for this manager.
*/
void _Event_Manager_initialization( void );
void _Event_Seize(

View File

@@ -63,11 +63,18 @@ typedef rtems_isr ( *rtems_isr_entry )(
);
/**
* @brief Implementation of the rtems_interrupt_catch directive.
* @brief RTEMS Interrupt Catch
*
* This directive installs @a new_isr_handler as the RTEMS interrupt service
* routine for the interrupt vector with number @a vector. The previous RTEMS
* interrupt service routine is returned in @a old_isr_handler.
*
* @param[in] new_isr_handler is the address of interrupt service routine
* @param[in] vector is the interrupt vector number
* @param[in] old_isr_handler address at which to store previous ISR address
*
* @return RTEMS_SUCCESSFUL and *old_isr_handler filled with previous ISR
* address
*/
rtems_status_code rtems_interrupt_catch(
rtems_isr_entry new_isr_handler,
@@ -77,8 +84,7 @@ rtems_status_code rtems_interrupt_catch(
#endif
/**
* @brief Disables all maskable interrupts and returns the previous level in
* @a _isr_cookie.
* @brief Disable RTEMS Interrupt
*
* @note The interrupt level shall be of type @ref rtems_interrupt_level.
*/
@@ -86,8 +92,7 @@ rtems_status_code rtems_interrupt_catch(
_ISR_Disable(_isr_cookie)
/**
* @brief Enables maskable interrupts to the level indicated by @a
* _isr_cookie.
* @brief Enable RTEMS Interrupt
*
* @note The interrupt level shall be of type @ref rtems_interrupt_level.
*/
@@ -95,8 +100,7 @@ rtems_status_code rtems_interrupt_catch(
_ISR_Enable(_isr_cookie)
/**
* @brief Temporarily enables maskable interrupts to the level in @a
* _isr_cookie before redisabling them.
* @brief Flash RTEMS Interrupt
*
* @note The interrupt level shall be of type @ref rtems_interrupt_level.
*/
@@ -104,8 +108,7 @@ rtems_status_code rtems_interrupt_catch(
_ISR_Flash(_isr_cookie)
/**
* @brief Returns true if the processor is currently servicing an interrupt
* and false otherwise.
* @brief RTEMS Interrupt Is in Progress
*
* A return value of true indicates that the caller is an interrupt service
* routine and @b not a thread. The directives available to an interrupt

View File

@@ -168,13 +168,19 @@ rtems_status_code rtems_message_queue_send(
);
/**
* @brief rtems_message_queue_urgent
* @brief RTEMS Urgent Message Queue
*
* This routine implements the rtems_message_queue_urgent directive.
* This directive has the same behavior as rtems_message_queue_send
* except that if no tasks are waiting, the message buffer will
* be placed at the FRONT of the chain of pending messages rather
* than at the REAR.
*
* @param[in] id is the pointer to message queue
* @param[in] buffer is the pointer to message buffer
* @param[in] size is the size of message to send urgently
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_message_queue_urgent(
rtems_id id,
@@ -183,12 +189,20 @@ rtems_status_code rtems_message_queue_urgent(
);
/**
* @brief rtems_message_queue_broadcast
* @brief RTEMS Broadcast Message Queue
*
* This routine implements the rtems_message_queue_broadcast directive.
* This directive sends the message buffer to all of the tasks blocked
* waiting for a message on the message queue indicated by ID.
* If no tasks are waiting, then the message buffer will not be queued.
*
* @param[in] id is the pointer to message queue
* @param[in] buffer is the pointer to message buffer
* @param[in] size is the size of message to broadcast
* @param[in] count pointer to area to store number of threads made ready
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* *count filled in with number of threads made ready
*/
rtems_status_code rtems_message_queue_broadcast(
rtems_id id,

View File

@@ -111,7 +111,7 @@ rtems_status_code rtems_partition_create(
);
/**
* @brief rtems_partition_ident
* @brief RTEMS Partition Ident
*
* This routine implements the rtems_partition_ident directive.
* This directive returns the partition ID associated with name.
@@ -120,6 +120,13 @@ rtems_status_code rtems_partition_create(
* extent of the search for the ID of the partition named name.
* The search can be limited to a particular node or allowed to
* encompass all nodes.
*
* @param[in] name is the user defined partition name
* @param[in] node is(are) the node(s) to be searched
* @param[in] id is the pointer to partition id
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* *id filled in with the partition id
*/
rtems_status_code rtems_partition_ident(
rtems_name name,

View File

@@ -391,7 +391,7 @@ rtems_status_code rtems_rate_monotonic_period(
);
/**
* @brief _Rate_monotonic_Timeout
* @brief Rate Monotonic Timeout
*
* This routine is invoked when the period represented
* by ID expires. If the thread which owns this period is blocked
@@ -399,6 +399,8 @@ rtems_status_code rtems_rate_monotonic_period(
* period is restarted. If the owning thread is not waiting for the
* period to expire, then the period is placed in the EXPIRED
* state and not restarted.
*
* @param[in] id is the period id
*/
void _Rate_monotonic_Timeout(
rtems_id id,

View File

@@ -217,7 +217,7 @@ rtems_status_code rtems_region_return_segment(
);
/**
* @brief rtems_region_resize_segment
* @brief Resize RTEMS Region Segment
*
* This routine implements the rtems_region_resize_segment directive. It
* tries to resize segment in the region associated with 'id' to the new size
@@ -228,13 +228,16 @@ rtems_status_code rtems_region_return_segment(
* rtems_region_get_segment of the first blocked task, then that task and as
* many subsequent tasks as possible will be unblocked with their requests
* satisfied.
* Returns:
* RTEMS_SUCCESSFUL - operation successful
* RTEMS_UNSATISFIED - the segment can't be resized in place
* any other code - failure.
* On RTEMS_SUCCESSFUL or RTEMS_UNSATISFIED exit it returns into the
* 'old_size' the old size in bytes of the user memory area of the specified
* segment.
*
* @param[in] id is the region id
* @param[in] segmet is the pointer to segment address
* @param[in] size is the new required size
* @return RTEMS_SUCCESSFUL if operation successful, RTEMS_UNSATISFIED if the
* the segment can't be resized in place or any other code atfailure
*
* @note On RTEMS_SUCCESSFUL or RTEMS_UNSATISFIED exit it returns into the
* 'old_size' the old size in bytes of the user memory area of the
* specified segment.
*/
rtems_status_code rtems_region_resize_segment(
rtems_id id,

View File

@@ -185,8 +185,18 @@ rtems_status_code rtems_semaphore_release(
);
/**
* @brief rtems_semaphore_flush
* @brief RTEMS Semaphore Flush
*
* DESCRIPTION:
* This package is the implementation of the flush directive
* of the Semaphore Manager.
*
* This directive allows a thread to flush the threads
* pending on the semaphore.
*
* @param[in] id is the semaphore id
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_semaphore_flush(
rtems_id id

View File

@@ -63,7 +63,7 @@ typedef struct {
} Semaphore_MP_Packet;
/**
* @brief Semaphore_MP_Send_process_packet
* @brief Semaphore MP Send Process Packet
*
* This routine performs a remote procedure call so that a
* process operation can be performed on another node.
@@ -76,7 +76,7 @@ void _Semaphore_MP_Send_process_packet (
);
/**
* @brief Semaphore_MP_Send_request_packet
* @brief Semaphore MP Send Request Packet
*
* This routine performs a remote procedure call so that a
* directive operation can be initiated on another node.
@@ -89,7 +89,7 @@ rtems_status_code _Semaphore_MP_Send_request_packet (
);
/**
* @brief Semaphore_MP_Send_response_packet
* @brief Semaphore MP Send Response Packet
*
* This routine performs a remote procedure call so that a
* directive can be performed on another node.
@@ -101,7 +101,7 @@ void _Semaphore_MP_Send_response_packet (
);
/**
* @brief Semaphore_MP_Process_packet
* @brief Semaphore MP Process Packet
*
* This routine performs the actions specific to this package for
* the request from another node.
@@ -111,7 +111,7 @@ void _Semaphore_MP_Process_packet (
);
/**
* @brief Semaphore_MP_Send_object_was_deleted
* @brief Semaphore MP Send Object was Deleted
*
* This routine is invoked indirectly by the thread queue
* when a proxy has been removed from the thread queue and
@@ -122,7 +122,7 @@ void _Semaphore_MP_Send_object_was_deleted (
);
/**
* @brief Semaphore_MP_Send_extract_proxy
* @brief Semaphore MP Send Extract Proxy
*
* This routine is invoked when a task is deleted and it
* has a proxy which must be removed from a thread queue and
@@ -133,18 +133,21 @@ void _Semaphore_MP_Send_extract_proxy (
);
/**
* @brief Semaphore_MP_Get_packet
* @brief Semaphore MP Get Packet
*
* This function is used to obtain a semaphore mp packet.
*/
Semaphore_MP_Packet *_Semaphore_MP_Get_packet ( void );
/**
* @brief _Semaphore_Core_mutex_mp_support
* @brief Semaphore Core Mutex MP Support
*
* This function processes the global actions necessary for remote
* accesses to a global semaphore based on a core mutex. This function
* is called by the core.
*
* @param[in] the_thread the remote thread the semaphore was surrendered to
* @param[in] id is the id of the surrendered semaphore
*/
void _Semaphore_Core_mutex_mp_support (
Thread_Control *the_thread,
@@ -152,11 +155,14 @@ void _Semaphore_Core_mutex_mp_support (
);
/**
* @brief Semaphore_Core_mp_support
* @brief Semaphore Core MP Support
*
* This function processes the global actions necessary for remote
* accesses to a global semaphore based on a core semaphore. This function
* is called by the core.
*
* @param[in] the_thread the remote thread the semaphore was surrendered to
* @param[in] id is the id of the surrendered semaphore
*/
void _Semaphore_Core_semaphore_mp_support (
Thread_Control *the_thread,

View File

@@ -240,14 +240,14 @@ RTEMS_TASKS_EXTERN Objects_Information _RTEMS_tasks_Information;
extern void (*_RTEMS_tasks_Initialize_user_tasks_p)(void);
/**
* @brief _RTEMS_tasks_Manager_initialization
* @brief RTEMS Task Manager Initialization
*
* This routine initializes all Task Manager related data structures.
*/
void _RTEMS_tasks_Manager_initialization(void);
/**
* @brief rtems_task_create
* @brief RTEMS Task Create
*
* This routine implements the rtems_task_create directive. The task
* will have the name name. The attribute_set can be used to indicate
@@ -255,6 +255,16 @@ void _RTEMS_tasks_Manager_initialization(void);
* The task's stack will be stack_size bytes. The task will begin
* execution with initial_priority and initial_modes. It returns the
* id of the created task in ID.
*
* @param[in] name is the user defined thread name
* @param[in] initial_priority is the thread priority
* @param[in] stack_size is the stack size in bytes
* @param[in] initial_modes is the initial thread mode
* @param[in] attribute_set is the thread attributes
* @param[in] id is the pointer to thread id
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
* and *id thread id filled in
*/
rtems_status_code rtems_task_create(
rtems_name name,
@@ -392,22 +402,29 @@ rtems_status_code rtems_task_start(
);
/**
* @brief rtems_task_wake_when
* @brief RTEMS Task Wake When
*
* This routine implements the rtems_task_wake_when directive. The
* calling task is blocked until the current time of day is
* equal to that indicated by time_buffer.
*
* @param[in] time_buffer is the pointer to the time and date structure
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_task_wake_when(
rtems_time_of_day *time_buffer
);
/**
* @brief rtems_task_wake_after
* @brief RTEMS Task Wake After
*
* This routine implements the rtems_task_wake_after directive. The
* calling task is blocked until the indicated number of clock
* ticks have occurred.
*
* @param[in] ticks is the number of ticks to wait
* @return RTEMS_SUCCESSFUL
*/
rtems_status_code rtems_task_wake_after(
rtems_interval ticks
@@ -446,7 +463,7 @@ rtems_status_code rtems_task_variable_get(
);
/**
* @brief rtems_task_variable_delete
* @brief RTEMS Delete Task Variable
*
* This directive removes a per task variable.
*/
@@ -463,14 +480,10 @@ rtems_status_code rtems_task_variable_delete(
rtems_id rtems_task_self(void);
/**
* @brief _RTEMS_tasks_Initialize_user_tasks
* @brief RTEMS User Task Initialization
*
* This routine creates and starts all configured user
* initialization threads.
*
* Input parameters: NONE
*
* Output parameters: NONE
*/
void _RTEMS_tasks_Initialize_user_tasks( void );

View File

@@ -383,10 +383,16 @@ typedef struct {
} rtems_timer_information;
/**
* @brief rtems_timer_get_information
* @brief RTEMS Get Timer Information
*
* This routine implements the rtems_timer_get_information directive.
* This directive returns information about the timer.
*
* @param[in] id is the timer id
* @param[in] the_info is the pointer to timer information block
*
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* *the_info region information block filled in
*/
rtems_status_code rtems_timer_get_information(
rtems_id id,

View File

@@ -1,6 +1,11 @@
/*
* Clock Manager - Get Seconds Since Epoch
/**
* @file
*
* @brief Obtain Seconds Since Epoch
* @ingroup ClassicClock
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,6 +1,11 @@
/*
* Clock Manager - Get Ticks Per Second
/**
* @file
*
* @brief Obtain Ticks Per Seconds
* @ingroup ClassicClock
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,6 +1,11 @@
/*
* Event Manager
/**
* @file
*
* @brief Event Manager Initialization
* @ingroup ClassicEvent
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,14 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/rtems/tasks.h>
/*
* _Event_Manager_initialization
*
* DESCRIPTION:
*
* This routine performs the initialization necessary for this manager.
*/
void _Event_Manager_initialization( void )
{
_Event_Sync_state = THREAD_BLOCKING_OPERATION_SYNCHRONIZED;

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Interrupt Support
* @ingroup ClassicINTR
*/
/*
* Bodies for Inlined Interrupt Manager Routines
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,10 +23,6 @@
#include <rtems/score/isr.h>
#include <rtems/rtems/intr.h>
/*
* Real body for rtems_interrupt_disable
*/
#undef rtems_interrupt_disable
rtems_interrupt_level rtems_interrupt_disable( void )
@@ -34,10 +34,6 @@ rtems_interrupt_level rtems_interrupt_disable( void )
return previous_level;
}
/*
* Real body for rtems_interrupt_enable
*/
#undef rtems_interrupt_enable
void rtems_interrupt_enable(
@@ -47,10 +43,6 @@ void rtems_interrupt_enable(
_ISR_Enable( previous_level );
}
/*
* Real body for rtems_interrupt_flash
*/
#undef rtems_interrupt_flash
void rtems_interrupt_flash(
@@ -60,10 +52,6 @@ void rtems_interrupt_flash(
_ISR_Flash( previous_level );
}
/*
* Real body for rtems_interrupt_is_in_progress
*/
#undef rtems_interrupt_is_in_progress
bool rtems_interrupt_is_in_progress( void )

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Interrupt Catch
* @ingroup ClassicINTR
*/
/*
* Interrupt Manager
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,21 +25,6 @@
#if (CPU_SIMPLE_VECTORED_INTERRUPTS == TRUE)
/* rtems_interrupt_catch
*
* This directive allows a thread to specify what action to take when
* catching signals.
*
* Input parameters:
* new_isr_handler - address of interrupt service routine (isr)
* vector - interrupt vector number
* old_isr_handler - address at which to store previous ISR address
*
* Output parameters:
* RTEMS_SUCCESSFUL - always succeeds
* *old_isr_handler - previous ISR address
*/
rtems_status_code rtems_interrupt_catch(
rtems_isr_entry new_isr_handler,
rtems_vector_number vector,

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Broadcast Message Queue
* @ingroup ClassicMessageQueue
*/
/*
* Message Queue Manager
*
*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -32,24 +36,6 @@
#include <rtems/rtems/options.h>
#include <rtems/rtems/support.h>
/*
* rtems_message_queue_broadcast
*
* This directive sends a message for every thread waiting on the queue
* designated by id.
*
* Input parameters:
* id - pointer to message queue
* buffer - pointer to message buffer
* size - size of message to broadcast
* count - pointer to area to store number of threads made ready
*
* Output parameters:
* count - number of threads made ready
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
rtems_status_code rtems_message_queue_broadcast(
rtems_id id,
const void *buffer,

View File

@@ -1,6 +1,11 @@
/*
* Message Queue Manager - rtems_message_queue_urgent
/**
* @file
*
* @brief RTEMS Urgent Message Queue
* @ingroup ClassicMessageQueue
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -31,22 +36,6 @@
#include <rtems/rtems/options.h>
#include <rtems/rtems/support.h>
/*
* rtems_message_queue_urgent
*
* This routine implements the directives rtems_message_queue_urgent. It
* prepends a message to the specified message queue.
*
* Input parameters:
* id - pointer to message queue
* buffer - pointer to message buffer
* size - size of message to send urgently
*
* Output parameters:
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
#if defined(RTEMS_MULTIPROCESSING)
#define MESSAGE_QUEUE_MP_HANDLER _Message_queue_Core_message_queue_mp_support
#else

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Partition Name to Id
* @ingroup ClassicPart
*/
/*
* Partition Manager
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,23 +27,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/sysstate.h>
/*
* rtems_partition_ident
*
* This directive returns the system ID associated with
* the partition name.
*
* Input parameters:
* name - user defined partition name
* node - node(s) to be searched
* id - pointer to partition id
*
* Output parameters:
* *id - partition id
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
rtems_status_code rtems_partition_ident(
rtems_name name,
uint32_t node,

View File

@@ -1,6 +1,11 @@
/*
* Rate Monotonic Manager -- Instantiate Data
/**
* @file
*
* @brief Instantiate RTEMS Period Data
* @ingroup ClassicRateMon
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*

View File

@@ -1,6 +1,11 @@
/*
* Rate Monotonic Manager -- Period End Timeout Handler
/**
* @file
*
* @brief Rate Monotonic Timeout
* @ingroup ClassicRateMon
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,20 +26,6 @@
#include <rtems/rtems/ratemon.h>
#include <rtems/score/thread.h>
/*
* _Rate_monotonic_Timeout
*
* This routine processes a period ending. If the owning thread
* is waiting for the period, that thread is unblocked and the
* period reinitiated. Otherwise, the period is expired.
* This routine is called by the watchdog handler.
*
* Input parameters:
* id - period id
*
* Output parameters: NONE
*/
void _Rate_monotonic_Timeout(
Objects_Id id,
void *ignored

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Resize RTEMS Region Segment
* @ingroup ClassicRegion
*/
/*
* Region Manager
*
*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -24,22 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/apimutex.h>
/*
* rtems_region_resize_segment
*
* This directive will try to resize segment to the new size 'size'
* "in place".
*
* Input parameters:
* id - region id
* segment - pointer to segment address
* size - new required size
*
* Output parameters:
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
rtems_status_code rtems_region_resize_segment(
rtems_id id,
void *segment,

View File

@@ -1,6 +1,11 @@
/*
* RTEMS Object Helper -- Obtain Name of Object as String
/**
* @file
*
* @brief Obtain Object Name as String
* @ingroup ClassicClassInfo
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -17,11 +22,6 @@
#include <rtems/score/object.h>
#include <rtems/rtems/object.h>
/*
* This method obtain the name of an object and returns its name
* in the form of a C string. It attempts to be careful about
* overflowing the user's string and about returning unprintable characters.
*/
char *rtems_object_get_name(
Objects_Id id,
size_t length,

View File

@@ -1,11 +1,11 @@
/**
* @file
*
* @brief RTEMS Semaphore Flush
* @ingroup ClassicSem
*/
/*
* rtems_semaphore_flush
*
* DESCRIPTION:
*
* This package is the implementation of the flush directive
* of the Semaphore Manager.
*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -38,20 +38,6 @@
#include <rtems/score/interr.h>
/*
* rtems_semaphore_flush
*
* This directive allows a thread to flush the threads
* pending on the semaphore.
*
* Input parameters:
* id - semaphore id
*
* Output parameters:
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
#if defined(RTEMS_MULTIPROCESSING)
#define SEND_OBJECT_WAS_DELETED _Semaphore_MP_Send_object_was_deleted
#else

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief Semaphore MP Support
* @ingroup ClassicSEM
*/
/*
* Multiprocessing Support for the Semaphore Manager
*
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,11 +34,6 @@ RTEMS_STATIC_ASSERT(
Semaphore_MP_Packet
);
/*
* _Semaphore_MP_Send_process_packet
*
*/
void _Semaphore_MP_Send_process_packet (
Semaphore_MP_Remote_operations operation,
Objects_Id semaphore_id,
@@ -76,11 +75,6 @@ void _Semaphore_MP_Send_process_packet (
}
}
/*
* _Semaphore_MP_Send_request_packet
*
*/
rtems_status_code _Semaphore_MP_Send_request_packet (
Semaphore_MP_Remote_operations operation,
Objects_Id semaphore_id,
@@ -128,11 +122,6 @@ rtems_status_code _Semaphore_MP_Send_request_packet (
return RTEMS_SUCCESSFUL;
}
/*
* _Semaphore_MP_Send_response_packet
*
*/
void _Semaphore_MP_Send_response_packet (
Semaphore_MP_Remote_operations operation,
Objects_Id semaphore_id,
@@ -171,12 +160,6 @@ void _Semaphore_MP_Send_response_packet (
}
}
/*
*
* _Semaphore_MP_Process_packet
*
*/
void _Semaphore_MP_Process_packet (
rtems_packet_prefix *the_packet_prefix
)
@@ -257,11 +240,6 @@ void _Semaphore_MP_Process_packet (
}
}
/*
* _Semaphore_MP_Send_object_was_deleted
*
*/
void _Semaphore_MP_Send_object_was_deleted (
Thread_Control *the_proxy
)
@@ -276,11 +254,6 @@ void _Semaphore_MP_Send_object_was_deleted (
}
/*
* _Semaphore_MP_Send_extract_proxy
*
*/
void _Semaphore_MP_Send_extract_proxy (
void *argument
)
@@ -296,26 +269,11 @@ void _Semaphore_MP_Send_extract_proxy (
}
/*
* _Semaphore_MP_Get_packet
*
*/
Semaphore_MP_Packet *_Semaphore_MP_Get_packet ( void )
{
return ( (Semaphore_MP_Packet *) _MPCI_Get_packet() );
}
/*
* _Semaphore_Core_mutex_mp_support
*
* Input parameters:
* the_thread - the remote thread the semaphore was surrendered to
* id - id of the surrendered semaphore
*
* Output parameters: NONE
*/
#if defined(RTEMS_MULTIPROCESSING)
void _Semaphore_Core_mutex_mp_support (
Thread_Control *the_thread,
@@ -332,17 +290,6 @@ void _Semaphore_Core_mutex_mp_support (
}
#endif
/*
* _Semaphore_Core_semaphore_mp_support
*
* Input parameters:
* the_thread - the remote thread the semaphore was surrendered to
* id - id of the surrendered semaphore
*
* Output parameters: NONE
*/
#if defined(RTEMS_MULTIPROCESSING)
void _Semaphore_Core_semaphore_mp_support (
Thread_Control *the_thread,

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Task Create
* @ingroup ClassicTasks
*/
/*
* RTEMS Task Manager
*
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,27 +34,6 @@
#include <rtems/score/sysstate.h>
#include <rtems/score/apimutex.h>
/*
* rtems_task_create
*
* This directive creates a thread by allocating and initializing a
* thread control block and a stack. The newly created thread is
* placed in the dormant state.
*
* Input parameters:
* name - user defined thread name
* initial_priority - thread priority
* stack_size - stack size in bytes
* initial_modes - initial thread mode
* attribute_set - thread attributes
* id - pointer to thread id
*
* Output parameters:
* id - thread id
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
rtems_status_code rtems_task_create(
rtems_name name,
rtems_task_priority initial_priority,

View File

@@ -1,6 +1,11 @@
/*
* RTEMS Task Manager -- Initialize Manager
/**
* @file
*
* @brief RTEMS Task API Extensions
* @ingroup ClassicTasks
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -230,16 +235,6 @@ User_extensions_Control _RTEMS_tasks_User_extensions = {
}
};
/*
* _RTEMS_tasks_Manager_initialization
*
* This routine initializes all Task Manager related data structures.
*
* Input parameters: NONE
*
* Output parameters: NONE
*/
void _RTEMS_tasks_Manager_initialization(void)
{
_Objects_Initialize_information(
@@ -279,17 +274,6 @@ void _RTEMS_tasks_Manager_initialization(void)
}
/*
* _RTEMS_tasks_Initialize_user_tasks
*
* This routine creates and starts all configured user
* initialization threads.
*
* Input parameters: NONE
*
* Output parameters: NONE
*/
void _RTEMS_tasks_Initialize_user_tasks( void )
{
if ( _RTEMS_tasks_Initialize_user_tasks_p )

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Delete Task Variable
* @ingroup ClassicTasks
*/
/*
* rtems_task_variable_delete - Delete a per-task variable
*
*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -18,12 +22,6 @@
#include <rtems/rtems/tasks.h>
#include <rtems/score/wkspace.h>
/*
* rtems_task_variable_delete
*
* This directive removes a task variable.
*/
rtems_status_code rtems_task_variable_delete(
rtems_id tid,
void **ptr

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Task Wake After
* @ingroup ClassicTasks
*/
/*
* RTEMS Task Manager
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,19 +34,6 @@
#include <rtems/score/apiext.h>
#include <rtems/score/sysstate.h>
/*
* rtems_task_wake_after
*
* This directive suspends the requesting thread for the given amount
* of ticks.
*
* Input parameters:
* ticks - number of ticks to wait
*
* Output parameters:
* RTEMS_SUCCESSFUL - always successful
*/
rtems_status_code rtems_task_wake_after(
rtems_interval ticks
)

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Task Wake When
* @ingroup ClassicTasks
*/
/*
* RTEMS Task Manager
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,20 +34,6 @@
#include <rtems/score/apiext.h>
#include <rtems/score/sysstate.h>
/*
* rtems_task_wake_when
*
* This directive blocks the requesting thread until the given date and
* time is reached.
*
* Input parameters:
* time_buffer - pointer to the time and date structure
*
* Output parameters:
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
rtems_status_code rtems_task_wake_when(
rtems_time_of_day *time_buffer
)

View File

@@ -1,7 +1,11 @@
/**
* @file
*
* @brief RTEMS Get Timer Information
* @ingroup ClassicTimer
*/
/*
* Timer Manager - rtems_timer_get_information directive
*
*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,22 +27,6 @@
#include <rtems/score/tod.h>
#include <rtems/score/watchdog.h>
/*
* rtems_timer_get_information
*
* This directive allows a thread to obtain information about a timer.
*
* Input parameters:
* id - timer id
* the_info - pointer to timer information block
*
* Output parameters:
* *the_info - region information block filled in
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*
*/
rtems_status_code rtems_timer_get_information(
rtems_id id,
rtems_timer_information *the_info