summaryrefslogtreecommitdiffstats
path: root/bsps/arm/include/bsp/arm-a9mpcore-clock.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/include/bsp/arm-a9mpcore-clock.h')
-rw-r--r--bsps/arm/include/bsp/arm-a9mpcore-clock.h41
1 files changed, 38 insertions, 3 deletions
diff --git a/bsps/arm/include/bsp/arm-a9mpcore-clock.h b/bsps/arm/include/bsp/arm-a9mpcore-clock.h
index 8d6007ba03..811a2037bd 100644
--- a/bsps/arm/include/bsp/arm-a9mpcore-clock.h
+++ b/bsps/arm/include/bsp/arm-a9mpcore-clock.h
@@ -1,9 +1,36 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup A9MPCoreSupport
+ *
+ * @brief This header file provides the interfaces of the @ref A9MPCoreSupport.
+ */
+
/*
* Copyright (c) 2013 Chris Johns <chrisj@rtems.org>. All rights reserved.
*
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.org/license/LICENSE.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef LIBBSP_ARM_SHARED_ARM_A9MPCORE_CLOCK_H
@@ -15,6 +42,12 @@
extern "C" {
#endif /* __cplusplus */
+/**
+ * @addtogroup A9MPCoreSupport
+ *
+ * @{
+ */
+
/*
* Return the peripheral clock. For systems such as the zynq this
* is controlled by the PL logic generation and can vary. Provide this
@@ -22,6 +55,8 @@ extern "C" {
*/
uint32_t a9mpcore_clock_periphclk(void);
+/** @} */
+
#ifdef __cplusplus
}
#endif /* __cplusplus */