[PATCH] Added doxygen headers to 20 files in tms570
Joel Sherrill
joel at rtems.org
Sat Dec 26 15:33:38 UTC 2015
The files you edited are automatically generated from the manual
for the processor. I am not sure whether it is OK to add the Doxygen
file header to these or not based on that.
Please file a ticket and attach any work on tms750 to it. It should
be assigned to Pavel Pisa. Make sure the description is clear that
this adds Doxygen but Joel was unsure if it should be added since
the files are auto-generated.
Once the ticket is filed, I will close the GCI task.
--joel
On Fri, Dec 25, 2015 at 7:21 PM, Tangem <gemtan.19 at robcol.k12.tr> wrote:
> ---
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_adc.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_ccmsr.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dcan.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dmm.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_efuse.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_emif.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flash.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flex_ray.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_i2c.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_iomm.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_lin.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_n2het.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pll.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pom.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_rtp.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_spi.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_stc.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_sys2.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_tcr.h | 6 ++++++
> c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_vim.h | 6 ++++++
> 20 files changed, 120 insertions(+), 0 deletions(-)
>
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_adc.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_adc.h
> index 1649fbe..24fb3fa 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_adc.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_adc.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_adc.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Analog to Digital Converter
> + */
> +
> /* The header file is generated by make_header.py from ADC.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_ccmsr.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_ccmsr.h
> index 941ed54..f352306d 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_ccmsr.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_ccmsr.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_ccmsr.h
> + * @ingroup arm_tms570
> + * @brief TMS570 CPU Compare Module for Cortex
> + */
> +
> /* The header file is generated by make_header.py from CCMSR.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dcan.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dcan.h
> index c278f55..30314da 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dcan.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dcan.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_dcan.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Controller Area Network
> + */
> +
> /* The header file is generated by make_header.py from DCAN.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dmm.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dmm.h
> index 55d656e..f710794 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dmm.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_dmm.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_dmm.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Data Modification Module
> + */
> +
> /* The header file is generated by make_header.py from DMM.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_efuse.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_efuse.h
> index decf5bb..98809cd 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_efuse.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_efuse.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_efuse.h
> + * @ingroup arm_tms570
> + * @brief TMS570 eFuse Controller
> + */
> +
> /* The header file is generated by make_header.py from EFUSE.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_emif.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_emif.h
> index 0810fd0..7070384 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_emif.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_emif.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_emif.h
> + * @ingroup arm_tms570
> + * @brief TMS570 External Memory Interface
> + */
> +
> /* The header file is generated by make_header.py from EMIF.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flash.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flash.h
> index 6c5a127..566032a 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flash.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flash.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_flash.h
> + * @ingroup arm_tms570
> + * @brief TMS570 F0212 Flash Module Controller
> + */
> +
> /* The header file is generated by make_header.py from FLASH.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flex_ray.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flex_ray.h
> index e077ab6..cff7700 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flex_ray.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_flex_ray.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_flex_ray.h
> + * @ingroup arm_tms570
> + * @brief TMS570 FlexRay Module
> + */
> +
> /* The header file is generated by make_header.py from FLEX_RAY.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_i2c.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_i2c.h
> index 63ed3f8..ed37e9e 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_i2c.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_i2c.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_i2c.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Inter-Integrated Circuit
> + */
> +
> /* The header file is generated by make_header.py from I2C.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_iomm.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_iomm.h
> index f6197e8..3956cde 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_iomm.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_iomm.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_iomm.h
> + * @ingroup arm_tms570
> + * @brief TMS570 I/O Multiplexing and Control Module
> + */
> +
> /* The header file is generated by make_header.py from IOMM.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_lin.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_lin.h
> index d2c3a3b..c08eda5 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_lin.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_lin.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_lin.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Serial Communication Interface/Local Interconnect
> Network
> + */
> +
> /* The header file is generated by make_header.py from LIN.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_n2het.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_n2het.h
> index 06b8bbe..2fcb3c1 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_n2het.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_n2het.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_n2het.h
> + * @ingroup arm_tms570
> + * @brief TMS570 High-End Timer
> + */
> +
> /* The header file is generated by make_header.py from N2HET.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pll.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pll.h
> index 1cb8b03..f89bd67 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pll.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pll.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_pll.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Oscillator and PLL
> + */
> +
> /* The header file is generated by make_header.py from PLL.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pom.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pom.h
> index 1a4df19..6f8b163 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pom.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_pom.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_pom.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Parameter Overlay Module
> + */
> +
> /* The header file is generated by make_header.py from POM.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_rtp.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_rtp.h
> index cd54b29..e921c0d 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_rtp.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_rtp.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_rtp.h
> + * @ingroup arm_tms570
> + * @brief TMS570 RAM Trace Port
> + */
> +
> /* The header file is generated by make_header.py from RTP.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_spi.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_spi.h
> index 35335c6..09fff1a 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_spi.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_spi.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_spi.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Multi-Buffered Serial Peripheral Interface Module
> + */
> +
> /* The header file is generated by make_header.py from SPI.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_stc.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_stc.h
> index e935f45..cefbd49 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_stc.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_stc.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_stc.h
> + * @ingroup arm_tms570
> + * @brief TMS570 CPU Self-Test Controller
> + */
> +
> /* The header file is generated by make_header.py from STC.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_sys2.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_sys2.h
> index 29ec5a1..3127000 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_sys2.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_sys2.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_sys2.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Secondary System Control Registers
> + */
> +
> /* The header file is generated by make_header.py from SYS2.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_tcr.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_tcr.h
> index 5304504..01585c8 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_tcr.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_tcr.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_tcr.h
> + * @ingroup arm_tms570
> + * @brief TMS570 FlexyRay Module - Transfer Configuration RAM
> + */
> +
> /* The header file is generated by make_header.py from TCR.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> diff --git a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_vim.h
> b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_vim.h
> index d0347a4..32ca506 100644
> --- a/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_vim.h
> +++ b/c/src/lib/libbsp/arm/tms570/include/ti_herc/reg_vim.h
> @@ -1,3 +1,9 @@
> +/**
> + * @file reg_vim.h
> + * @ingroup arm_tms570
> + * @brief TMS570 Vectored Interrupt Manager
> + */
> +
> /* The header file is generated by make_header.py from VIM.json */
> /* Current script's version can be found at: */
> /*
> https://github.com/AoLaD/rtems-tms570-utils/tree/headers/headers/python */
> --
> 2.5.0
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20151226/2aac20e0/attachment-0002.html>
More information about the devel
mailing list