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

sapi misc: Clean up Doxygen GCI task #1

Browse Source 
http://www.google-melange.com/gci/task/view/google/gci2012/8011204
This commit is contained in:
Christopher Kerl
2012-12-07 09:49:54 -05:00
committed by Gedare Bloom
parent 80232ee7a4
commit 4c98a3ea29
26 changed files with 273 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cpukit/rtems/include/rtems/rtems/rtemsapi.h
View File

@@ -18,7 +18,7 @@
#include <rtems/config.h>
/**
* _RTEMS_API_Initialize
* @brief Initializes the RTEMS API
*
* This routine initializes the RTEMS API by invoking the initialization
* routine for each RTEMS manager with the appropriate parameters

5
cpukit/sapi/include/rtems/extension.h
View File

@@ -38,6 +38,11 @@ typedef struct {
User_extensions_Control Extension;
} Extension_Control;
/**
* @brief Initialize Extension Manager
*
* This routine initializes all extension manager related data structures.
*/
void _Extension_Manager_initialization(void);
typedef User_extensions_routine

12
cpukit/sapi/include/rtems/fatal.h
View File

@@ -57,9 +57,7 @@ static inline void rtems_exception_frame_print(
* @brief Invokes the internal error handler with a source of
* INTERNAL_ERROR_RTEMS_API and is internal set to false.
*
* @param[in] the_error A 32-bit fatal error code.
*
* @return This function will not return.
* @param[in] the_error is a 32-bit fatal error code.
*
* @see _Internal_error_Occurred().
*/
@@ -70,10 +68,8 @@ void rtems_fatal_error_occurred(
/**
* @brief Invokes the internal error handler with is internal set to false.
*
* @param[in] source The fatal source.
* @param[in] error The fatal code.
*
* @return This function will not return.
* @param[in] source is the fatal source.
* @param[in] error is the fatal code.
*
* @see _Internal_error_Occurred().
*/
@@ -85,7 +81,7 @@ void rtems_fatal(
/**
* @brief Returns a description for an internal error code.
*
* @param[in] error The error code.
* @param[in] error is the error code.
*
* @return The error code description or "?" in case the passed error code is
* invalid.

2
cpukit/sapi/include/rtems/init.h
View File

@@ -87,7 +87,7 @@ void rtems_initialize_start_multitasking(void)
RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
/**
* @brief rtems_shutdown_executive
* @brief Shutdown the RTEMS environment
*
* This routine implements the rtems_shutdown_executive directive. The
* invocation of this directive results in the RTEMS environment being

112
cpukit/sapi/include/rtems/io.h
View File

@@ -100,11 +100,13 @@ rtems_status_code rtems_io_register_driver(
);
/**
* @brief Unregisters the device driver with number @a major.
* @brief Unregister a Driver from the Device Driver Table.
*
* @retval RTEMS_SUCCESSFUL Device driver successfully unregistered.
* @retval RTEMS_UNSATISFIED Invalid major number.
* @retval RTEMS_CALLED_FROM_ISR Called from interrupt context.
* @param[in] major is the device major number.
*
* @retval RTEMS_SUCCESSFUL Device driver successfully unregistered.
* @retval RTEMS_UNSATISFIED Invalid major number.
* @retval RTEMS_CALLED_FROM_ISR Called from interrupt context.
*/
rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major
@@ -126,41 +128,101 @@ rtems_status_code rtems_io_register_name(
/** @} */
/**
* @name Device Driver Invocation
* @brief IO Driver Initialization
*
* @{
* This routine is the initialization directive of the IO manager.
*
* @param[in] major is the device drive number
* @param[in] minor is the device number
* @param[in] argument is the pointer to the argument(s)
*
* @return status code
*/
rtems_status_code rtems_io_initialize(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Opening for The IO Manager
*
* Opens a device driver with the number @a major.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_open(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Closing for The IO Manager
*
* This routine is the close directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_close(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Reading for The IO Manager
*
* This routine is the read directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_read(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Writing for The IO Manager
*
* This routine is the write directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_write(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Control for The IO Manager
*
* This routine is the control directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_control(
rtems_device_major_number major,
rtems_device_minor_number minor,
@@ -190,8 +252,20 @@ SAPI_IO_EXTERN uint32_t _IO_Number_of_drivers;
SAPI_IO_EXTERN rtems_driver_address_table *_IO_Driver_address_table;
/**
* @brief Initialization of Device Drivers
*
* @note The IO manager has been extended to support runtime driver
* registration. The driver table is now allocated in the
* workspace.
*/
void _IO_Manager_initialization( void );
/**
* @brief Initialization of All Device Drivers
*
* Initializes all device drivers.
*/
void _IO_Initialize_all_drivers( void );
#ifdef __cplusplus
@@ -199,4 +273,26 @@ void _IO_Initialize_all_drivers( void );
#endif
#endif
/* end of include file */
rtems_io_write(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Control for The IO Manager
*
* This routine is the control directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_control(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);

21
cpukit/sapi/src/debug.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Debug Manager
*
* @ingroup ClassicDebug
*/
/*
* Debug Manager
*
@@ -16,18 +24,11 @@
#include <rtems/system.h>
#include <rtems/debug.h>
/*
*
* _Debug_Manager_initialization
*/
void _Debug_Manager_initialization( void )
{
rtems_debug_disable( RTEMS_DEBUG_ALL_MASK );
}
/*
* rtems_debug_enable
*/
void rtems_debug_enable (
rtems_debug_control to_be_enabled
)
@@ -35,9 +36,6 @@ void rtems_debug_enable (
_Debug_Level |= to_be_enabled;
}
/*
* rtems_debug_disable
*/
void rtems_debug_disable (
rtems_debug_control to_be_disabled
)
@@ -45,9 +43,6 @@ void rtems_debug_disable (
_Debug_Level &= ~to_be_disabled;
}
/*
* rtems_debug_is_enabled
*/
bool rtems_debug_is_enabled(
rtems_debug_control level
)

8
cpukit/sapi/src/exinit.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Device Driver Initialization Functions
*
* @ingroup ClassicRTEMS
*/
/*
* Initialization Manager
*

2
cpukit/sapi/src/exshutdown.c
View File

@@ -50,12 +50,10 @@ void rtems_shutdown_executive(
_Thread_Stop_multitasking();
/*******************************************************************
*******************************************************************
*******************************************************************
****** RETURN TO RTEMS_INITIALIZE_START_MULTITASKING() ******
****** AND THEN TO BOOT_CARD() ******
*******************************************************************
*******************************************************************
*******************************************************************/
}
_Internal_error_Occurred(

18
cpukit/sapi/src/extension.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Initialize Extension Manager
*
* @ingroup ClassicUserExtensions
*/
/*
* Extension Manager
*
@@ -20,16 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/extension.h>
/*
* _Extension_Manager_initialization
*
* This routine initializes all extension manager related data structures.
*
* Input parameters: NONE
*
* Output parameters: NONE
*/
void _Extension_Manager_initialization(void)
{
_Objects_Initialize_information(

10
cpukit/sapi/src/extensiondata.c
View File

@@ -1,6 +1,12 @@
/*
* Extension Manager -- Instantiate Data
/**
* @file
*
* @brief Extension Data
*
* @ingroup ClassicUserExtensions
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*

20
cpukit/sapi/src/fatal.c
View File

@@ -1,3 +1,12 @@
/**
* @file
*
* @brief Invokes the internal error handler with a source of
* INTERNAL_ERROR_RTEMS_API and is internal set to false.
*
* @ingroup ClassicFatal
*/
/*
* Fatal Error Manager
*
@@ -17,17 +26,6 @@
#include <rtems/fatal.h>
#include <rtems/score/interr.h>
/*
* rtems_fatal_error_occurred
*
* This directive will invoke the internal fatal error handler.
*
* Input parameters:
* the_error - fatal error status code
*
* Output parameters: NONE
*/
void rtems_fatal_error_occurred(
uint32_t the_error
)

8
cpukit/sapi/src/fatal2.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Invokes the internal error handler with is internal set to false.
*
* @ingroup ClassicFatal
*/
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*

8
cpukit/sapi/src/getversionstring.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Get the RTEMS Version as a String
*
* @ingroup ClassicRTEMS
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).

8
cpukit/sapi/src/interrdesc.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Returns a description for an internal error code.
*
* @ingroup ClassicFatal
*/
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*

29
cpukit/sapi/src/io.c
View File

@@ -1,6 +1,12 @@
/*
* Input/Output Manager - Initialize Device Driver Subsystem
/**
* @file
*
* @brief Initialization of Device Drivers
*
* @ingroup ClassicIO
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -22,15 +28,6 @@
#include <string.h>
/*
* _IO_Manager_initialization
*
* The IO manager has been extended to support runtime driver
* registration. The driver table is now allocated in the
* workspace.
*
*/
void _IO_Manager_initialization(void)
{
uint32_t index;
@@ -80,16 +77,6 @@ void _IO_Manager_initialization(void)
_IO_Driver_address_table[index] = driver_table[index];
}
/*
* _IO_Initialize_all_drivers
*
* This routine initializes all device drivers
*
* Input Paramters: NONE
*
* Output Parameters: NONE
*/
void _IO_Initialize_all_drivers( void )
{
rtems_device_major_number major;

22
cpukit/sapi/src/ioclose.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Closing for The IO Manager
*
* @ingroup ClassicIO
*/
/*
* Input/Output Manager -- Close Device
*
@@ -16,20 +24,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
/*
* rtems_io_close
*
* This routine is the close directive of the IO manager.
*
* Input Paramters:
* major - device driver number
* minor - device number
* argument - pointer to argument(s)
*
* Output Parameters:
* returns - return code
*/
rtems_status_code rtems_io_close(
rtems_device_major_number major,
rtems_device_minor_number minor,

24
cpukit/sapi/src/iocontrol.c
View File

@@ -1,6 +1,12 @@
/*
* Input/Output Manager - Device Control
/**
* @file
*
* @brief Control for The IO Manager
*
* @ingroup ClassicIO
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
/*
* rtems_io_control
*
* This routine is the control directive of the IO manager.
*
* Input Paramters:
* major - device driver number
* minor - device number
* argument - pointer to argument(s)
*
* Output Parameters:
* returns - return code
*/
rtems_status_code rtems_io_control(
rtems_device_major_number major,
rtems_device_minor_number minor,

10
cpukit/sapi/src/iodata.c
View File

@@ -1,6 +1,12 @@
/*
* RTEMS Task Manager -- Instantiate Data
/**
* @file
*
* @brief IO Data
*
* @ingroup ClassicIO
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*

24
cpukit/sapi/src/ioinitialize.c
View File

@@ -1,6 +1,12 @@
/*
* Input/Output Manager - Initialize Device
/**
* @file
*
* @brief IO Driver Initialization
*
* @ingroup ClassicIO
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
/*
* rtems_io_initialize
*
* This routine is the initialization directive of the IO manager.
*
* Input Paramters:
* major - device driver number
* minor - device number
* argument - pointer to argument(s)
*
* Output Parameters:
* returns - return code
*/
rtems_status_code rtems_io_initialize(
rtems_device_major_number major,
rtems_device_minor_number minor,

22
cpukit/sapi/src/ioopen.c
View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Opening for The IO Manager
*
* @ingroup ClassicIO
*/
/*
* Input/Output Manager - Open Device
*
@@ -16,20 +24,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
/*
* rtems_io_open
*
* This routine is the open directive of the IO manager.
*
* Input Paramters:
* major - device driver number
* minor - device number
* argument - pointer to argument(s)
*
* Output Parameters:
* returns - return code
*/
rtems_status_code rtems_io_open(
rtems_device_major_number major,
rtems_device_minor_number minor,

24
cpukit/sapi/src/ioread.c
View File

@@ -1,6 +1,12 @@
/*
* Input/Output Manager - Device Read
/**
* @file
*
* @brief Reading for The IO Manager
*
* @ingroup ClassicIO
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
/*
* rtems_io_read
*
* This routine is the read directive of the IO manager.
*
* Input Paramters:
* major - device driver number
* minor - device number
* argument - pointer to argument(s)
*
* Output Parameters:
* returns - return code
*/
rtems_status_code rtems_io_read(
rtems_device_major_number major,
rtems_device_minor_number minor,

23
cpukit/sapi/src/iounregisterdriver.c
View File

@@ -1,6 +1,12 @@
/*
* Input/Output Manager - Dynamically Unregister Device Driver
/**
* @file
*
* @brief Unregister a Driver from the Device Driver Table.
*
* @ingroup ClassicIO
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,19 +25,6 @@
#include <rtems/score/thread.h>
#include <string.h>
/*
* rtems_io_unregister_driver
*
* Unregister a driver from the device driver table.
*
* Input Paramters:
* major - device major number
*
* Output Parameters:
* RTEMS_SUCCESSFUL - if successful
* error code - if unsuccessful
*/
rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major
)

24
cpukit/sapi/src/iowrite.c
View File

@@ -1,6 +1,12 @@
/*
* Input/Output Manager - Device Write
/**
* @file
*
* @brief Writing for The IO Manager
*
* @ingroup ClassicIO
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
/*
* rtems_io_write
*
* This routine is the write directive of the IO manager.
*
* Input Paramters:
* major - device driver number
* minor - device number
* argument - pointer to argument(s)
*
* Output Parameters:
* returns - return code
*/
rtems_status_code rtems_io_write(
rtems_device_major_number major,
rtems_device_minor_number minor,

24
cpukit/sapi/src/posixapi.c
View File

@@ -1,8 +1,12 @@
/**
* @file
*
* @brief Initialize POSIX API
*
* @ingroup ClassicRTEMS
*/
/*
* RTEMS API Initialization Support
*
* NOTE:
*
* COPYRIGHT (c) 1989-2010.
* On-Line Applications Research Corporation (OAR).
*
@@ -15,11 +19,6 @@
#include "config.h"
#endif
/*
* POSIX_API_INIT is defined so all of the POSIX API
* data will be included in this object file.
*/
#define POSIX_API_INIT
#include <rtems/system.h> /* include this before checking RTEMS_POSIX_API */
@@ -45,12 +44,6 @@
#include <rtems/posix/spinlock.h>
#include <rtems/posix/time.h>
/*
* _POSIX_API_Initialize
*
* XXX
*/
Objects_Information *_POSIX_Objects[ OBJECTS_POSIX_CLASSES_LAST + 1 ];
void _POSIX_API_Initialize(void)
@@ -82,4 +75,3 @@ void _POSIX_API_Initialize(void)
}
#endif
/* end of file */

25
cpukit/sapi/src/rtemsapi.c
View File

@@ -1,8 +1,12 @@
/**
* @file
*
* @brief Initializes the RTEMS API
*
* @ingroup ClassicRTEMS
*/
/*
* POSIX API Initialization Support
*
* NOTE:
*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -15,11 +19,6 @@
#include "config.h"
#endif
/*
* RTEMS_API_INIT is defined so all of the RTEMS API
* data will be included in this object file.
*/
#define RTEMS_API_INIT
#include <rtems/system.h>
@@ -45,12 +44,6 @@
Objects_Information *_RTEMS_Objects[ OBJECTS_RTEMS_CLASSES_LAST + 1 ];
/*
* _RTEMS_API_Initialize
*
* XXX
*/
void _RTEMS_API_Initialize(void)
{
/*
@@ -75,5 +68,3 @@ void _RTEMS_API_Initialize(void)
_Rate_monotonic_Manager_initialization();
_Barrier_Manager_initialization();
}
/* end of file */

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

@@ -45,25 +45,27 @@ typedef uint32_t rtems_debug_control;
SCORE_EXTERN rtems_debug_control _Debug_Level;
/**
* This routine performs the initialization necessary for this manager.
* @brief Initialize Debug Manager
*/
void _Debug_Manager_initialization( void );
/**
* This routine enables the specified types of debug checks.
* @brief Enable Debugging
*/
void rtems_debug_enable(
rtems_debug_control to_be_enabled
);
/**
* This routine disables the specified types of debug checks.
* @brief Disable Debugging
*/
void rtems_debug_disable(
rtems_debug_control to_be_disabled
);
/**
* @brief Check if Debug is Enabled
*
* This routine returns TRUE if the requested debug level is
* enabled, and FALSE otherwise.
*/