diff options
author | Quinn Jensen <quinn.jensen@freescale.com> | 2007-05-24 18:13:31 -0600 |
---|---|---|
committer | Quinn Jensen <quinn.jensen@freescale.com> | 2007-05-24 18:13:31 -0600 |
commit | 057e4ecfe2eb6cf841e5c019cc2e498bb549bf14 (patch) | |
tree | 29868e251336775614090aab9c5daeb6776169c3 /drivers | |
parent | 8315d2a76d9c2062242d95d5efff076c3ba3da9c (diff) |
CR ENGR00025276: Fix doxygen
Fix doxygen for one set of documents for the supported mxc and imx platforms.
http://www.bitshrine.org/gpp/linux-2.6.19.2-mx-unified_doxygen.patch
Diffstat (limited to 'drivers')
39 files changed, 51 insertions, 49 deletions
diff --git a/drivers/media/video/mxc/capture/mxc_v4l2_capture.c b/drivers/media/video/mxc/capture/mxc_v4l2_capture.c index 1e92f6bc8c30..059e03bfff7e 100644 --- a/drivers/media/video/mxc/capture/mxc_v4l2_capture.c +++ b/drivers/media/video/mxc/capture/mxc_v4l2_capture.c @@ -12,7 +12,7 @@ */ /*! - * @file mxc_v4l2_capture.c + * @file drivers/media/video/mxc/capture/mxc_v4l2_capture.c * * @brief Mxc Video For Linux 2 driver * diff --git a/drivers/media/video/mxc/output/mxc_v4l2_output.c b/drivers/media/video/mxc/output/mxc_v4l2_output.c index 3d5890e32c75..651b8e986d47 100644 --- a/drivers/media/video/mxc/output/mxc_v4l2_output.c +++ b/drivers/media/video/mxc/output/mxc_v4l2_output.c @@ -12,7 +12,7 @@ */ /*! - * @file mxc_v4l2_output.c + * @file drivers/media/video/mxc/output/mxc_v4l2_output.c * * @brief MXC V4L2 Video Output Driver * diff --git a/drivers/mxc/pm/dptc.c b/drivers/mxc/pm/dptc.c index b161876fd605..6aee33af2f55 100644 --- a/drivers/mxc/pm/dptc.c +++ b/drivers/mxc/pm/dptc.c @@ -29,7 +29,7 @@ * Driver ioctls are used to change driver parameters and enable/disable the * DPTC operation. * - * @ingroup PM + * @ingroup PM_MX31 */ #include <linux/module.h> diff --git a/drivers/mxc/pm/dptc_mx27.c b/drivers/mxc/pm/dptc_mx27.c index 59f2ddce8184..e4e65090da08 100644 --- a/drivers/mxc/pm/dptc_mx27.c +++ b/drivers/mxc/pm/dptc_mx27.c @@ -28,7 +28,7 @@ * in-order to update the translation table. Driver ioctls are used to change * driver parameters and enable/disable the DPTC operation. * - * @ingroup PM + * @ingroup PM_MX27 */ #include <linux/module.h> diff --git a/drivers/mxc/pm/dvfs_dptc.c b/drivers/mxc/pm/dvfs_dptc.c index 5ac1f66bf83c..a279a8595e92 100644 --- a/drivers/mxc/pm/dvfs_dptc.c +++ b/drivers/mxc/pm/dvfs_dptc.c @@ -27,7 +27,7 @@ * into the driver (the voltage changes are done by calling some routines * of the mc13783 driver). * - * @ingroup PM + * @ingroup PM_MX31 */ #include <linux/module.h> diff --git a/drivers/mxc/pm/dvfs_dptc.h b/drivers/mxc/pm/dvfs_dptc.h index 2c0a28013914..a3d8b1b31a15 100644 --- a/drivers/mxc/pm/dvfs_dptc.h +++ b/drivers/mxc/pm/dvfs_dptc.h @@ -16,7 +16,7 @@ * * @brief MXC dvfs & dptc header file. * - * @ingroup PM + * @ingroup PM_MX27 PM_MX31 */ #ifndef __DVFS_DPTC_H__ #define __DVFS_DPTC_H__ diff --git a/drivers/mxc/pm/dvfs_dptc_table_mx27.h b/drivers/mxc/pm/dvfs_dptc_table_mx27.h index dfbe6a6cec63..83438707ee92 100644 --- a/drivers/mxc/pm/dvfs_dptc_table_mx27.h +++ b/drivers/mxc/pm/dvfs_dptc_table_mx27.h @@ -16,7 +16,7 @@ * * @brief i.MX27 dptc table file. * - * @ingroup PM + * @ingroup PM_MX27 */ #ifndef __DVFS_DPTC_TABLE_MX27_H__ #define __DVFS_DPTC_TABLE_MX27_H__ diff --git a/drivers/mxc/pm/dvfs_dptc_table_mx31.h b/drivers/mxc/pm/dvfs_dptc_table_mx31.h index 1fca1a55d4f9..81fe80f28af8 100644 --- a/drivers/mxc/pm/dvfs_dptc_table_mx31.h +++ b/drivers/mxc/pm/dvfs_dptc_table_mx31.h @@ -25,7 +25,7 @@ * * @brief MX31 dvfs & dptc table file for CKIH clock 26MHz. * - * @ingroup PM + * @ingroup PM_MX31 */ #ifndef __DVFS_DPTC_TABLE_MX31_H__ #define __DVFS_DPTC_TABLE_MX31_H__ diff --git a/drivers/mxc/pm/dvfs_dptc_table_mx31_27ckih.h b/drivers/mxc/pm/dvfs_dptc_table_mx31_27ckih.h index 3dd4d4a762f1..ff8b520776c0 100644 --- a/drivers/mxc/pm/dvfs_dptc_table_mx31_27ckih.h +++ b/drivers/mxc/pm/dvfs_dptc_table_mx31_27ckih.h @@ -25,7 +25,7 @@ * * @brief MX31 dvfs & dptc table file for CKIH clock 27MHz. * - * @ingroup PM + * @ingroup PM_MX31 */ #ifndef __DVFS_DPTC_TABLE_MX31_27CKIH_H__ #define __DVFS_DPTC_TABLE_MX31_27CKIH_H__ diff --git a/drivers/mxc/pm/dvfs_dptc_table_mx31_rev2.h b/drivers/mxc/pm/dvfs_dptc_table_mx31_rev2.h index aeb18cf40bc6..cb0f64c98749 100644 --- a/drivers/mxc/pm/dvfs_dptc_table_mx31_rev2.h +++ b/drivers/mxc/pm/dvfs_dptc_table_mx31_rev2.h @@ -25,7 +25,7 @@ * * @brief MX31 dvfs & dptc table file for MX31 2.0 * - * @ingroup PM + * @ingroup PM_MX31 */ #ifndef __DVFS_DPTC_TABLE_MX3_REV2_H__ #define __DVFS_DPTC_TABLE_MX3_REV2_H__ diff --git a/drivers/mxc/pmic/mc13783/pmic_adc.c b/drivers/mxc/pmic/mc13783/pmic_adc.c index 1cd58f29427f..5f72f0d43d2a 100644 --- a/drivers/mxc/pmic/mc13783/pmic_adc.c +++ b/drivers/mxc/pmic/mc13783/pmic_adc.c @@ -12,7 +12,7 @@ */ /*! - * @file pmic_adc.c + * @file mc13783/pmic_adc.c * @brief This is the main file of PMIC(mc13783) ADC driver. * * @ingroup PMIC_ADC diff --git a/drivers/mxc/pmic/mc13783/pmic_adc_defs.h b/drivers/mxc/pmic/mc13783/pmic_adc_defs.h index 77663c164ea1..5278814d9c0a 100644 --- a/drivers/mxc/pmic/mc13783/pmic_adc_defs.h +++ b/drivers/mxc/pmic/mc13783/pmic_adc_defs.h @@ -12,7 +12,7 @@ */ /*! - * @file pmic_adc_defs.h + * @file mc13783/pmic_adc_defs.h * @brief This header contains all defines for PMIC(mc13783) ADC driver. * * @ingroup PMIC_ADC diff --git a/drivers/mxc/pmic/mc13783/pmic_audio.c b/drivers/mxc/pmic/mc13783/pmic_audio.c index a9af4422c7af..017902384175 100644 --- a/drivers/mxc/pmic/mc13783/pmic_audio.c +++ b/drivers/mxc/pmic/mc13783/pmic_audio.c @@ -12,7 +12,7 @@ */ /*! - * @file pmic_audio.c + * @file mc13783/pmic_audio.c * @brief Implementation of the PMIC(mc13783) Audio driver APIs. * * The PMIC Audio driver and this API were developed to support the diff --git a/drivers/mxc/pmic/mc13783/pmic_battery.c b/drivers/mxc/pmic/mc13783/pmic_battery.c index cac5609475dc..66f578c8a8c6 100644 --- a/drivers/mxc/pmic/mc13783/pmic_battery.c +++ b/drivers/mxc/pmic/mc13783/pmic_battery.c @@ -12,7 +12,7 @@ */ /*! - * @file pmic_battery.c + * @file mc13783/pmic_battery.c * @brief This is the main file of PMIC(mc13783) Battery driver. * * @ingroup PMIC_BATTERY diff --git a/drivers/mxc/pmic/mc13783/pmic_battery_defs.h b/drivers/mxc/pmic/mc13783/pmic_battery_defs.h index 047c21c436bf..9f66a185cd2f 100644 --- a/drivers/mxc/pmic/mc13783/pmic_battery_defs.h +++ b/drivers/mxc/pmic/mc13783/pmic_battery_defs.h @@ -12,7 +12,7 @@ */ /*! - * @file pmic_battery_defs.h + * @file mc13783/pmic_battery_defs.h * @brief This is the internal header for PMIC(mc13783) Battery driver. * * @ingroup PMIC_BATTERY diff --git a/drivers/mxc/pmic/mc13783/pmic_convity.c b/drivers/mxc/pmic/mc13783/pmic_convity.c index 1d21657d1fa0..91eafd0f23aa 100644 --- a/drivers/mxc/pmic/mc13783/pmic_convity.c +++ b/drivers/mxc/pmic/mc13783/pmic_convity.c @@ -12,7 +12,7 @@ */ /*! - * @file pmic_convity.c + * @file mc13783/pmic_convity.c * @brief Implementation of the PMIC Connectivity driver APIs. * * The PMIC connectivity device driver and this API were developed to support diff --git a/drivers/mxc/pmic/mc13783/pmic_light.c b/drivers/mxc/pmic/mc13783/pmic_light.c index c0dc29944952..60999028b753 100644 --- a/drivers/mxc/pmic/mc13783/pmic_light.c +++ b/drivers/mxc/pmic/mc13783/pmic_light.c @@ -12,7 +12,7 @@ */ /*! - * @file pmic_light.c + * @file mc13783/pmic_light.c * @brief This is the main file of PMIC(mc13783) Light and Backlight driver. * * @ingroup PMIC_LIGHT diff --git a/drivers/mxc/pmic/mc13783/pmic_light_defs.h b/drivers/mxc/pmic/mc13783/pmic_light_defs.h index 172159fbb430..80082363d9ed 100644 --- a/drivers/mxc/pmic/mc13783/pmic_light_defs.h +++ b/drivers/mxc/pmic/mc13783/pmic_light_defs.h @@ -12,7 +12,7 @@ */ /*! - * @file pmic_light_defs.h + * @file mc13783/pmic_light_defs.h * @brief This is the internal header PMIC(mc13783) Light and Backlight driver. * * @ingroup PMIC_LIGHT diff --git a/drivers/mxc/pmic/mc13783/pmic_power.c b/drivers/mxc/pmic/mc13783/pmic_power.c index 73dfc5a67a14..7d212b753937 100644 --- a/drivers/mxc/pmic/mc13783/pmic_power.c +++ b/drivers/mxc/pmic/mc13783/pmic_power.c @@ -12,7 +12,7 @@ */ /*! - * @file pmic_power.c + * @file mc13783/pmic_power.c * @brief This is the main file of PMIC(mc13783) Power driver. * * @ingroup PMIC_POWER diff --git a/drivers/mxc/pmic/mc13783/pmic_power_defs.h b/drivers/mxc/pmic/mc13783/pmic_power_defs.h index 17db8db5306e..38e554146a70 100644 --- a/drivers/mxc/pmic/mc13783/pmic_power_defs.h +++ b/drivers/mxc/pmic/mc13783/pmic_power_defs.h @@ -12,7 +12,7 @@ */ /*! - * @file pmic_power_defs.h + * @file mc13783/pmic_power_defs.h * @brief This is the internal header define of PMIC(mc13783) Power driver. * * @ingroup PMIC_POWER diff --git a/drivers/mxc/pmic/mc13783/pmic_rtc.c b/drivers/mxc/pmic/mc13783/pmic_rtc.c index bcc42f3dc785..94ba4efacf60 100644 --- a/drivers/mxc/pmic/mc13783/pmic_rtc.c +++ b/drivers/mxc/pmic/mc13783/pmic_rtc.c @@ -12,7 +12,7 @@ */ /*! - * @file pmic_rtc.c + * @file mc13783/pmic_rtc.c * @brief This is the main file of PMIC(mc13783) RTC driver. * * @ingroup PMIC_RTC diff --git a/drivers/mxc/pmic/mc13783/pmic_rtc_defs.h b/drivers/mxc/pmic/mc13783/pmic_rtc_defs.h index 7832c51223ea..16e968dd9977 100644 --- a/drivers/mxc/pmic/mc13783/pmic_rtc_defs.h +++ b/drivers/mxc/pmic/mc13783/pmic_rtc_defs.h @@ -14,7 +14,7 @@ #define __MC13783_RTC_DEFS_H__ /*! - * @file pmic_rtc_defs.h + * @file mc13783/pmic_rtc_defs.h * @brief This is the internal header of PMIC(mc13783) RTC driver. * * @ingroup PMIC_RTC diff --git a/drivers/mxc/security/sahara2/fsl_shw_auth.c b/drivers/mxc/security/sahara2/fsl_shw_auth.c index f15748acad98..df45ee098b2d 100644 --- a/drivers/mxc/security/sahara2/fsl_shw_auth.c +++ b/drivers/mxc/security/sahara2/fsl_shw_auth.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! - * @file fsl_shw_auth.c + * @file drivers/mxc/security/sahara2/fsl_shw_auth.c * * @brief This file contains the routines which do the combined encrypt+authentication * functions. For now, only AES-CCM is supported. diff --git a/drivers/mxc/security/sahara2/fsl_shw_hash.c b/drivers/mxc/security/sahara2/fsl_shw_hash.c index f4a01017f83d..bb144f53ee06 100644 --- a/drivers/mxc/security/sahara2/fsl_shw_hash.c +++ b/drivers/mxc/security/sahara2/fsl_shw_hash.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! - * @file fsl_shw_hash.c + * @file drivers/mxc/security/sahara2/fsl_shw_hash.c * * @brief This file implements Cryptographic Hashing functions of the FSL SHW API * for Sahara. This does not include HMAC. diff --git a/drivers/mxc/security/sahara2/fsl_shw_hmac.c b/drivers/mxc/security/sahara2/fsl_shw_hmac.c index 07acb25339bd..14245d0f6a29 100644 --- a/drivers/mxc/security/sahara2/fsl_shw_hmac.c +++ b/drivers/mxc/security/sahara2/fsl_shw_hmac.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! - * @file fsl_shw_hmac.c + * @file drivers/mxc/security/sahara2/fsl_shw_hmac.c * * @brief This file implements Hashed Message Authentication Code functions of the FSL * SHW API for Sahara. diff --git a/drivers/mxc/security/sahara2/fsl_shw_rand.c b/drivers/mxc/security/sahara2/fsl_shw_rand.c index 2b1fd6c261b1..ca213456457d 100644 --- a/drivers/mxc/security/sahara2/fsl_shw_rand.c +++ b/drivers/mxc/security/sahara2/fsl_shw_rand.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! - * @file fsl_shw_rand.c + * @file drivers/mxc/security/sahara2/fsl_shw_rand.c * * @brief This file implements Random Number Generation functions of the FSL SHW API for * for Sahara. diff --git a/drivers/mxc/security/sahara2/fsl_shw_sym.c b/drivers/mxc/security/sahara2/fsl_shw_sym.c index a22daf115bf3..bb3ea836d83d 100644 --- a/drivers/mxc/security/sahara2/fsl_shw_sym.c +++ b/drivers/mxc/security/sahara2/fsl_shw_sym.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! - * @file fsl_shw_sym.c + * @file drivers/mxc/security/sahara2/fsl_shw_sym.c * * @brief This file implements Symmetric Cipher functions of the FSL SHW API for * Sahara. This does not include CCM. diff --git a/drivers/mxc/security/sahara2/fsl_shw_user.c b/drivers/mxc/security/sahara2/fsl_shw_user.c index 2b914e5f04cc..7cbf45664a9a 100644 --- a/drivers/mxc/security/sahara2/fsl_shw_user.c +++ b/drivers/mxc/security/sahara2/fsl_shw_user.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! - * @file fsl_shw_user.c + * @file drivers/mxc/security/sahara2/fsl_shw_user.c * * @brief This file implements user and platform capabilities functions of the FSL SHW API * API for Sahara diff --git a/drivers/mxc/security/sahara2/fsl_shw_wrap.c b/drivers/mxc/security/sahara2/fsl_shw_wrap.c index fdc48d7bb658..e8cd5ddc6606 100644 --- a/drivers/mxc/security/sahara2/fsl_shw_wrap.c +++ b/drivers/mxc/security/sahara2/fsl_shw_wrap.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! - * @file fsl_shw_wrap.c + * @file drivers/mxc/security/sahara2/fsl_shw_wrap.c * * @brief This file implements Key-Wrap (Black Key) functions of the FSL SHW API for * Sahara. diff --git a/drivers/mxc/security/sahara2/include/fsl_shw.h b/drivers/mxc/security/sahara2/include/fsl_shw.h index 38b7ffc4c230..e3125db35a1b 100644 --- a/drivers/mxc/security/sahara2/include/fsl_shw.h +++ b/drivers/mxc/security/sahara2/include/fsl_shw.h @@ -1903,7 +1903,7 @@ extern fsl_shw_return_t fsl_shw_release_key(fsl_shw_uco_t * user_ctx, */ /*! - * @example wrapped_key.c + * @example wrap.c */ #endif /* API_DOC */ diff --git a/drivers/mxc/security/sahara2/sf_util.c b/drivers/mxc/security/sahara2/sf_util.c index 256edf69994a..a10b2fb304a1 100644 --- a/drivers/mxc/security/sahara2/sf_util.c +++ b/drivers/mxc/security/sahara2/sf_util.c @@ -11,7 +11,7 @@ * http://www.gnu.org/copyleft/gpl.html */ /*! -* @file sf_util.c +* @file drivers/mxc/security/sahara2/sf_util.c * * @brief Security Functions component API - Utility functions * diff --git a/drivers/serial/mxc_uart.c b/drivers/serial/mxc_uart.c index 018f04bea45f..66bd87d33b0b 100644 --- a/drivers/serial/mxc_uart.c +++ b/drivers/serial/mxc_uart.c @@ -12,7 +12,7 @@ */ /*! - * @file mxc_uart.c + * @file drivers/serial/mxc_uart.c * * @brief Driver for the Freescale Semiconductor MXC serial ports based on * drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o. diff --git a/drivers/spi/mxc_spi.c b/drivers/spi/mxc_spi.c index b878652f0af4..f417fa649826 100644 --- a/drivers/spi/mxc_spi.c +++ b/drivers/spi/mxc_spi.c @@ -12,6 +12,10 @@ */ /*! + * @defgroup SPI Configurable Serial Peripheral Interface (CSPI) Driver + */ + +/*! * @file mxc_spi.c * @brief This file contains the implementation of the SPI master controller services * diff --git a/drivers/spi/mxc_spi.h b/drivers/spi/mxc_spi.h index 894cc1de4845..6316282d6cff 100644 --- a/drivers/spi/mxc_spi.h +++ b/drivers/spi/mxc_spi.h @@ -12,12 +12,8 @@ */ /*! - * @defgroup SPI Configurable Serial Peripheral Interface (CSPI) Driver - */ - -/*! * @file mxc_spi.h - * @brief This header file contains SPI driver low level definition to access module registers. + * @brief This header file contains SPI driver low level register definitions. * * @ingroup SPI */ diff --git a/drivers/spi/mxc_spi_mx27.h b/drivers/spi/mxc_spi_mx27.h index 80f4962caef5..2323cd96e494 100644 --- a/drivers/spi/mxc_spi_mx27.h +++ b/drivers/spi/mxc_spi_mx27.h @@ -12,16 +12,12 @@ */ /*! - * @defgroup SPI Configurable Serial Peripheral Interface (CSPI) Driver + * @file mxc_spi_mx27.h + * @brief This header file contains SPI driver low level register definitions for MX27. + * + * @ingroup SPI */ - /*! - * @file mxc_spi_mx27.h - * @brief This header file contains SPI driver low level definition to access module registers. - * - * @ingroup SPI - */ - #ifndef __MXC_SPI_MX27_H__ #define __MXC_SPI_MX27_H__ diff --git a/drivers/usb/host/ehci-arc.c b/drivers/usb/host/ehci-arc.c index 6933c1a6a774..69637b8821aa 100644 --- a/drivers/usb/host/ehci-arc.c +++ b/drivers/usb/host/ehci-arc.c @@ -14,6 +14,9 @@ */ /*! + * @defgroup USB ARC OTG USB Driver + */ +/*! * @file ehci-arc.c * @brief platform related part of usb host driver. * @ingroup USB diff --git a/drivers/video/mxc/fs453.c b/drivers/video/mxc/fs453.c index 3fe9c6ec28b7..1e71c39c54e1 100644 --- a/drivers/video/mxc/fs453.c +++ b/drivers/video/mxc/fs453.c @@ -12,10 +12,13 @@ */ /*! + * @defgroup FS453 Focus FS453 TV Encoder Driver + */ +/*! * @file fs453.c * @brief Driver for FS453/4 TV encoder * - * @ingroup Framebuffer + * @ingroup FS453 */ #include <linux/kernel.h> diff --git a/drivers/video/mxc/fs453.h b/drivers/video/mxc/fs453.h index 4dba9416114e..1edd11481b76 100644 --- a/drivers/video/mxc/fs453.h +++ b/drivers/video/mxc/fs453.h @@ -15,7 +15,7 @@ * @file fs453.h * @brief Driver for FS453/4 TV encoder * - * @ingroup Framebuffer + * @ingroup FS453 */ #ifndef __FS453_H__ diff --git a/drivers/video/mxc/mx2fb.c b/drivers/video/mxc/mx2fb.c index 0657c3c90621..8db83df1d6a9 100644 --- a/drivers/video/mxc/mx2fb.c +++ b/drivers/video/mxc/mx2fb.c @@ -12,7 +12,7 @@ */ /*! - * @defgroup Framebuffer Framebuffer Driver for MX27 ADS. + * @defgroup Framebuffer_MX27 Framebuffer Driver for MX27. */ /*! @@ -20,7 +20,7 @@ * * @brief Frame buffer driver for MX27 ADS. * - * @ingroup Framebuffer + * @ingroup Framebuffer_MX27 */ #include <linux/module.h> |