libbsp/arm: add doxygen to arm shared headers

This commit is contained in:
Szkocsovszki Zsolt
2013-12-22 21:07:02 -05:00
committed by Gedare Bloom
parent 21dd58d99d
commit b7212b9f1f
15 changed files with 127 additions and 0 deletions

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARMV7M Support
*/
/*
* Copyright (c) 2012 Sebastian Huber. All rights reserved.
*

View File

@@ -1,3 +1,10 @@
/**
* @file
*
* @ingroup arm_comm
*
* @brief UART Support
*/
/*
* This software is Copyright (C) 1998 by T.sqware - all rights limited

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM_A9MPCORE_IRQ Support
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM_A9MPCORE_REGS Support
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief A9MPCORE_START Support
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_gic
*
* @brief ARM GIC IRQ
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_gic
*
* @brief ARM GIC Register definitions
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_gic
*
* @brief ARM GIC TM27 Support
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -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))

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM PL011 Register definitions
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM PL011 Support Package
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM PL050 Register Definitions
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM PL050 Support
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM PL111 FB Support
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup arm_shared
*
* @brief ARM PL111 Register definitions
*/
/*
* Copyright (c) 2013 embedded brains GmbH. All rights reserved.
*