From b7212b9f1f6813c3fbe549ea6cd8559a59f584ea Mon Sep 17 00:00:00 2001 From: Szkocsovszki Zsolt Date: Sun, 22 Dec 2013 21:07:02 -0500 Subject: libbsp/arm: add doxygen to arm shared headers --- c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/comm/uart.h | 7 +++++++ c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-gic.h | 16 ++++++++++++++++ c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-pl011.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-pl050.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h | 8 ++++++++ c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h | 8 ++++++++ 15 files changed, 127 insertions(+) diff --git a/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h b/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h index 80af772dd1..6213ed12e0 100644 --- a/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h +++ b/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARMV7M Support + */ + /* * Copyright (c) 2012 Sebastian Huber. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/comm/uart.h b/c/src/lib/libbsp/arm/shared/comm/uart.h index 4e6e1026e0..1370f7a36e 100644 --- a/c/src/lib/libbsp/arm/shared/comm/uart.h +++ b/c/src/lib/libbsp/arm/shared/comm/uart.h @@ -1,3 +1,10 @@ +/** + * @file + * + * @ingroup arm_comm + * + * @brief UART Support + */ /* * This software is Copyright (C) 1998 by T.sqware - all rights limited diff --git a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h index 0361d4fe00..be164df2e8 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM_A9MPCORE_IRQ Support + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h index dc7fd758ed..86bdcb2d20 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM_A9MPCORE_REGS Support + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h index 3c41d4e9ae..a62dcdaf83 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief A9MPCORE_START Support + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h b/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h index 5c152a179e..7d5fc8f0cc 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_gic + * + * @brief ARM GIC IRQ + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h index 1c1608afa3..c76aa195c6 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_gic + * + * @brief ARM GIC Register definitions + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h b/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h index 45e6c5d616..0ca7fcf879 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_gic + * + * @brief ARM GIC TM27 Support + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic.h b/c/src/lib/libbsp/arm/shared/include/arm-gic.h index a336bfa7b4..61e21beed2 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-gic.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-gic.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_gic + * + * @brief ARM GIC Support + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * @@ -23,6 +31,14 @@ extern "C" { #endif /* __cplusplus */ +/** + * @defgroup arm_gic ARM GIC + * + * @ingroup arm_shared + * + * @brief ARM_GIC Support Package + */ + #define GIC_ID_TO_ONE_BIT_REG_INDEX(id) ((id) >> 5) #define GIC_ID_TO_ONE_BIT_REG_BIT(id) (1U << ((id) & 0x1fU)) diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h index 0b0bd1f081..876f02970c 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM PL011 Register definitions + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl011.h b/c/src/lib/libbsp/arm/shared/include/arm-pl011.h index 537e382a9a..8db75520d9 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-pl011.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-pl011.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM PL011 Support Package + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h index 93c99b65fa..32e927c6bf 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM PL050 Register Definitions + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl050.h b/c/src/lib/libbsp/arm/shared/include/arm-pl050.h index 4bb6b79f1d..0233bcdfd6 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-pl050.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-pl050.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM PL050 Support + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h b/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h index 0503c6c172..4e448937cf 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM PL111 FB Support + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h index 02ea3f43e3..e30d46abb7 100644 --- a/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h +++ b/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_shared + * + * @brief ARM PL111 Register definitions + */ + /* * Copyright (c) 2013 embedded brains GmbH. All rights reserved. * -- cgit v1.2.3