bsps/arm: Add Doxygen group for Armv7-M SysTick

Change license to BSD-2-Clause according to file history and contributor
agreements.
This commit is contained in:
Sebastian Huber
2024-04-23 21:06:52 +02:00
parent d19c322259
commit 7024401d76
3 changed files with 62 additions and 5 deletions

View File

@@ -1,9 +1,37 @@
/*
* Copyright (c) 2011, 2018 Sebastian Huber. All rights reserved.
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* 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.
* @ingroup RTEMSDriverClockArmv7MSysTick
*
* @brief This header file provides support for Armv7-M clock drivers.
*/
/*
* Copyright (C) 2024 embedded brains GmbH & Co. KG
* Copyright (C) 2011, 2018 Sebastian Huber
*
* 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 BSP_CLOCK_ARMV7M_H
@@ -18,6 +46,17 @@
extern "C" {
#endif /* __cplusplus */
/**
* @defgroup RTEMSDriverClockArmv7MSysTick Armv7-M SysTick Clock Driver
*
* @ingroup RTEMSDriverClockImpl
*
* @brief This group contains the Armv7-M SysTick support and Clock Driver
* implementation.
*
* @{
*/
#ifdef ARM_MULTILIB_ARCH_V7M
typedef struct {
@@ -67,6 +106,8 @@ static uint32_t _ARMV7M_Clock_counter(ARMV7M_Timecounter *tc)
#endif /* ARM_MULTILIB_ARCH_V7M */
/** @} */
#ifdef __cplusplus
}
#endif /* __cplusplus */

View File

@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSDriverClockArmv7MSysTick
*
* @brief This source file contains the Armv7-M SysTick Clock Driver.
*/
/*
* Copyright (C) 2020 embedded brains GmbH & Co. KG
* Copyright (C) 2011, 2018 Sebastian Huber

View File

@@ -1,5 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSDriverClockArmv7MSysTick
*
* @brief This source file contains the Armv7-M SysTick CPU counter.
*/
/*
* Copyright (C) 2016, 2018 embedded brains GmbH & Co. KG
*