lm32: Add doxygen

c/src/lib/libbsp/lm32/shared/clock/clock.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_clock
+ * @brief LatticeMico32 Timer (Clock) definitions
+ */
+
 /*
  *  This file contains definitions for LatticeMico32 Timer (Clock)
  *
@@ -12,16 +18,23 @@
  *  Micro-Research Finland Oy
  */
 
+/**
+ * @defgroup lm32_clock LM32 Clock
+ * @ingroup lm32_shared
+ * @brief LatticeMico32 Timer (Clock) definitions.
+ * @{
+ */
+
 #ifndef _BSPCLOCK_H
 #define _BSPCLOCK_H
 
-/* Status Register */
+/** @brief Status Register */
 
 #define LM32_CLOCK_SR       (0x0000)
 #define LM32_CLOCK_SR_TO    (0x0001)
 #define LM32_CLOCK_SR_RUN   (0x0002)
 
-/* Control Register */
+/** @brief Control Register */
 
 #define LM32_CLOCK_CR       (0x0004)
 #define LM32_CLOCK_CR_ITO   (0x0001)
@@ -29,12 +42,14 @@
 #define LM32_CLOCK_CR_START (0x0004)
 #define LM32_CLOCK_CR_STOP  (0x0008)
 
-/* Period Register */
+/** @brief Period Register */
 
 #define LM32_CLOCK_PERIOD   (0x0008)
 
-/* Snapshot Register */
+/** @brief Snapshot Register */
 
 #define LM32_CLOCK_SNAPSHOT (0x000C)
 
 #endif /* _BSPCLOCK_H */
+
+/** @} */

c/src/lib/libbsp/lm32/shared/doxygen.h

@@ -0,0 +1,23 @@
+  /**
+  *  @defgroup bsp_lm32 Lattice Mico32
+  *
+  *  @ingroup bsp_kit
+  *
+  *  @brief Lattice Mico32 Board Support Packages
+  */
+
+ /**
+  *  @defgroup lm32_shared Lattice Mico32 Shared Modules
+  *
+  *  @ingroup bsp_lm32
+  *
+  *  @brief Lattice Mico32 Shared Modules
+  */
+
+ /**
+  *  @defgroup lm32_milkymist_shared LM32 Milkymist One
+  *
+  *  @ingroup lm32_shared
+  *
+  *  @brief Lattice Mico32 Milkymist One
+  */

c/src/lib/libbsp/lm32/shared/gdbstub/gdb_if.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_gdb
+ * @brief definition of the interface between the stub and gdb
+ */
+
 /*
  * gdb_if.h - definition of the interface between the stub and gdb
  *
@@ -12,10 +18,17 @@
  *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  */
 
+/**
+ * @defgroup lm32_gdb LM32 GDB Interface
+ * @ingroup lm32_shared
+ * @brief Definition of the interface between the stub and gdb,
+ * @{
+ */
+
 #ifndef _GDB_IF_H
 #define _GDB_IF_H
 
-/* Max number of threads in qM response */
+/** @brief Max number of threads in qM response */
 #define QM_MAX_THREADS (20)
 
 struct rtems_gdb_stub_thread_info {
@@ -70,7 +83,7 @@ void rtems_gdb_process_query(
   int   thread
 );
 
-/* Exception IDs */
+/** @brief Exception IDs */
 #define LM32_EXCEPTION_RESET                  0x0
 #define LM32_EXCEPTION_INST_BREAKPOINT        0x1
 #define LM32_EXCEPTION_INST_BUS_ERROR         0x2
@@ -80,10 +93,10 @@ void rtems_gdb_process_query(
 #define LM32_EXCEPTION_INTERRUPT              0x6
 #define LM32_EXCEPTION_SYSTEM_CALL            0x7
 
-/* Breakpoint instruction */
+/** @brief Breakpoint instruction */
 #define LM32_BREAK                            0xac000002UL
 
-/* This numbering must be consistant with GDBs numbering in gdb/lm32-tdep.c */
+/** @brief This numbering must be consistant with GDBs numbering in gdb/lm32-tdep.c */
 enum lm32_regnames {
   LM32_REG_R0, LM32_REG_R1, LM32_REG_R2, LM32_REG_R3, LM32_REG_R4, LM32_REG_R5,
   LM32_REG_R6, LM32_REG_R7, LM32_REG_R8, LM32_REG_R9, LM32_REG_R10,
@@ -108,3 +121,5 @@ enum lm32_int_regnames {
 };
 
 #endif /* _GDB_IF_H */
+
+/** @} */

c/src/lib/libbsp/lm32/shared/milkymist_ac97/milkymist_ac97.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_ac97 lm32_milkymist_shared
+ * @brief Milkymist AC97 driver
+ */
+
 /*  milkymist_ac97.h
  *
  *  Milkymist AC97 driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_ac97 Milkymist AC97
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist AC97 driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_AC97_H_
 #define __MILKYMIST_AC97_H_
 
@@ -54,6 +67,8 @@ rtems_device_driver ac97_control(
 #define AC97_DRIVER_TABLE_ENTRY {ac97_initialize, \
 ac97_open, NULL, NULL, NULL, ac97_control}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_buttons/milkymist_buttons.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_buttons lm32_milkymist_shared
+ * @brief Milkymist buttons driver
+ */
+
 /*  milkymist_buttons.h
  *
  *  Milkymist buttons driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2011 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_buttons Milkymist buttons
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist buttons driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_BUTTONS_H_
 #define __MILKYMIST_BUTTONS_H_
 
@@ -37,6 +50,8 @@ rtems_device_driver buttons_read(
 #define BUTTONS_DRIVER_TABLE_ENTRY { buttons_initialize, \
 buttons_open, NULL, buttons_read, NULL, NULL}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_clock/clock.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_clock lm32_milkymist_shared
+ * @brief LatticeMico32 Timer (Clock) definitions
+ */
+
 /*
  *  This file contains definitions for LatticeMico32 Timer (Clock)
  *

c/src/lib/libbsp/lm32/shared/milkymist_console/uart.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_uart lm32_milkymist_shared
+ * @brief Milkymist UART definitions
+ */
+
 /*
  *  This file contains definitions for the Milkymist UART
  *
@@ -6,6 +12,13 @@
  *  http://www.rtems.com/license/LICENSE.
  */
 
+/**
+ * @defgroup lm32_milkymist_uart Milkymist UART
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist UART definitions
+ * @{
+ */
+
 #ifndef _BSPUART_H
 #define _BSPUART_H
 
@@ -14,3 +27,5 @@ void BSP_uart_polled_write(char ch);
 int BSP_uart_polled_read(void);
 
 #endif /* _BSPUART_H */
+
+/** @} */

c/src/lib/libbsp/lm32/shared/milkymist_dmx/milkymist_dmx.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_dmx lm32_milkymist_shared
+ * @brief Milkymist DMX512 driver
+ */
+
 /*  milkymist_dmx.h
  *
  *  Milkymist DMX512 driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_dmx Milkymist DMX512
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist DMX512 driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_DMX_H_
 #define __MILKYMIST_DMX_H_
 
@@ -46,6 +59,8 @@ rtems_device_driver dmx_control(
 #define DMX_DRIVER_TABLE_ENTRY {dmx_initialize, \
 NULL, NULL, dmx_read, dmx_write, dmx_control}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_gpio/milkymist_gpio.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_gpio lm32_milkymist_shared
+ * @brief Milkymist GPIO driver
+ */
+
 /*  milkymist_gpio.h
  *
  *  Milkymist GPIO driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_gpio Milkymist GPIO
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist GPIO driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_GPIO_H_
 #define __MILKYMIST_GPIO_H_
 
@@ -37,6 +50,8 @@ rtems_device_driver gpio_write(
 #define GPIO_DRIVER_TABLE_ENTRY { gpio_initialize, \
 NULL, NULL, gpio_read, gpio_write, NULL}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_ir/milkymist_ir.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_ir lm32_milkymist_shared
+ * @brief Milkymist RC5 IR driver
+ */
+
 /*  milkymist_ir.h
  *
  *  Milkymist RC5 IR driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_ir Milkymist IR
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist RC5 IR driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_IR_H_
 #define __MILKYMIST_IR_H_
 
@@ -37,6 +50,8 @@ rtems_device_driver ir_read(
 #define IR_DRIVER_TABLE_ENTRY {ir_initialize, \
 ir_open, NULL, ir_read, NULL, NULL}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_memcard/milkymist_memcard.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_memcard lm32_milkymist_shared
+ * @brief Milkymist memory card driver
+ */
+
 /*  milkymist_memcard.h
  *
  *  Milkymist memory card driver for RTEMS
@@ -9,9 +15,18 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_memcard Milkymist memory card
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist memory card driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_MEMCARD_H_
 #define __MILKYMIST_MEMCARD_H_
 
 rtems_status_code memcard_register(void);
 
 #endif /* __MILKYMIST_MEMCARD_H_ */
+
+/** @} */

c/src/lib/libbsp/lm32/shared/milkymist_midi/milkymist_midi.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_midi lm32_milkymist_shared
+ * @brief Milkymist MIDI driver
+ */
+
 /*  milkymist_midi.h
  *
  *  Milkymist MIDI driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_midi Milkymist MIDI
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist MIDI driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_MIDI_H_
 #define __MILKYMIST_MIDI_H_
 
@@ -37,6 +50,8 @@ rtems_device_driver midi_read(
 #define MIDI_DRIVER_TABLE_ENTRY {midi_initialize, \
 midi_open, NULL, midi_read, NULL, NULL}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_networking/network.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_network lm32_milkymist_shared
+ * @brief Driver for Minimac ethernet
+ */
+
 /*  network.h
  *
  *  RTEMS driver for Minimac ethernet IP-core of Milkymist SoC
@@ -10,6 +16,12 @@
  *  Telecom SudParis, France
  */
 
+/**
+ * @defgroup lm32_milkymist_network Minimac ethernet driver
+ * @ingroup lm32_milkymist_shared
+ * @brief Driver for Minimac ethernet IP-core of Milkymist SoC
+ * @{
+ */
 
 #ifndef __MILKYMIST_NETWORKING_H_
 #define __MILKYMIST_NETWORKING_H_

c/src/lib/libbsp/lm32/shared/milkymist_pfpu/milkymist_pfpu.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_pfpu lm32_milkymist_shared
+ * @brief Milkymist PFPU driver
+ */
+
 /*  milkymist_pfpu.h
  *
  *  Milkymist PFPU driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_pfpu Milkymist PFPU
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist PFPU driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_PFPU_H_
 #define __MILKYMIST_PFPU_H_
 
@@ -29,8 +42,10 @@ struct pfpu_td {
 	unsigned int *program;
 	unsigned int progsize;
 	float *registers;
-	bool update; /* < shall we update the "registers" array after completion */
-	bool invalidate; /* < shall we invalidate L1 data cache after completion */
+	/** @brief shall we update the "registers" array after completion */
+	bool update;
+	/** @brief shall we invalidate L1 data cache after completion */
+	bool invalidate;
 };
 
 rtems_device_driver pfpu_initialize(
@@ -48,6 +63,8 @@ rtems_device_driver pfpu_control(
 #define PFPU_DRIVER_TABLE_ENTRY {pfpu_initialize, \
 NULL, NULL, NULL, NULL, pfpu_control}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_tmu/milkymist_tmu.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_tmu lm32_milkymist_shared
+ * @brief Milkymist TMU driver
+ */
+
 /*  milkymist_tmu.h
  *
  *  Milkymist TMU driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_tmu Milkymist TMU
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist TMU driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_TMU_H_
 #define __MILKYMIST_TMU_H_
 
@@ -76,6 +89,8 @@ rtems_device_driver tmu_control(
 #define TMU_DRIVER_TABLE_ENTRY {tmu_initialize, \
 NULL, NULL, NULL, NULL, tmu_control}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_usbinput/comloc.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_usbinput lm32_milkymist_shared
+ * @brief Milkymist USB input devices driver
+ */
+
 /*  comloc.h
  *
  *  Milkymist USB input devices driver for RTEMS

c/src/lib/libbsp/lm32/shared/milkymist_usbinput/milkymist_usbinput.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_usbinput lm32_milkymist_shared
+ * @brief Milkymist USB input devices driver
+ */
+
 /*  milkymist_usbinput.h
  *
  *  Milkymist USB input devices driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010, 2012 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_usbinput Milkymist USB input devices
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist USB input devices driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_USBINPUT_H_
 #define __MILKYMIST_USBINPUT_H_
 

c/src/lib/libbsp/lm32/shared/milkymist_versions/milkymist_versions.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_versions lm32_milkymist_shared
+ * @brief Milkymist versioning driver
+ */
+
 /*  milkymist_versions.h
  *
  *  Milkymist versioning driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_versions Milkymist versioning
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist versioning driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_VERSIONS_H_
 #define __MILKYMIST_VERSIONS_H_
 
@@ -31,6 +44,8 @@ rtems_device_driver versions_read(
 #define VERSIONS_DRIVER_TABLE_ENTRY {versions_initialize, \
 NULL, NULL, versions_read, NULL, NULL}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/milkymist_video/milkymist_video.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_video lm32_milkymist_shared
+ * @brief Milkymist video input driver
+ */
+
 /*  milkymist_video.h
  *
  *  Milkymist video input driver for RTEMS
@@ -9,6 +15,13 @@
  *  COPYRIGHT (c) 2010, 2011 Sebastien Bourdeauducq
  */
 
+/**
+ * @defgroup lm32_milkymist_video Milkymist Video
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist video input driver
+ * @{
+ */
+
 #ifndef __MILKYMIST_VIDEO_H_
 #define __MILKYMIST_VIDEO_H_
 
@@ -68,6 +81,8 @@ rtems_device_driver video_control(
 #define VIDEO_DRIVER_TABLE_ENTRY {video_initialize, \
 video_open, video_close, NULL, NULL, video_control}
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

c/src/lib/libbsp/lm32/shared/tsmac/dp83848phy.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_tsmac
+ * @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions
+ */
+
 /*
  *  This file contains definitions for LatticeMico32 TSMAC (Tri-Speed MAC)
  *

c/src/lib/libbsp/lm32/shared/tsmac/tsmac.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_tsmac
+ * @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions.
+ */
+
 /*
  *  This file contains definitions for LatticeMico32 TSMAC (Tri-Speed MAC)
  *
@@ -12,6 +18,13 @@
  *  Micro-Research Finland Oy
  */
 
+/**
+ * @defgroup lm32_tsmac LM32 TSMAC
+ * @ingroup lm32_shared
+ * @brief LatticeMico32 TSMAC (Tri-Speed MAC) definitions.
+ * @{
+ */
+
 #ifndef _BSPTSMAC_H
 #define _BSPTSMAC_H
 
@@ -156,3 +169,4 @@ void ipalign(struct mbuf *m);
 #endif
 
 #endif /* _BSPTSMAC_H */
+/** @} */