clockdrv: Add clock driver implementation group

Use standard wording in Clock Driver related files.

Update #3706.
This commit is contained in:
Sebastian Huber
2023-01-23 15:26:10 +01:00
parent 10ee41a8a3
commit 6136e28bf9
5 changed files with 24 additions and 24 deletions

View File

@@ -1,14 +1,13 @@
/** /**
* @file * @file
* *
* @ingroup bsp_clock * @ingroup RTEMSDriverClockImpl
* *
* @brief Raspberry Pi clock support. * @brief This source file contains the implementation of the BCM2835 Clock
* Driver.
*/ */
/* /*
* BCM2835 Clock driver
*
* Copyright (c) 2013 Alan Cudmore * Copyright (c) 2013 Alan Cudmore
* Copyright (c) 2016 Pavel Pisa * Copyright (c) 2016 Pavel Pisa
* *

View File

@@ -1,14 +1,13 @@
/** /**
* @file * @file
* *
* @ingroup bsp_clock * @ingroup RTEMSDriverClockImpl
* *
* @brief or1k clock support. * @brief This source file contains the implementation of the or1k Clock
* Driver.
*/ */
/* /*
* generic_or1k Clock driver
*
* COPYRIGHT (c) 2014-2015 Hesham ALMatary <heshamelmatary@gmail.com> * COPYRIGHT (c) 2014-2015 Hesham ALMatary <heshamelmatary@gmail.com>
* *
* The license and distribution terms for this file may be * The license and distribution terms for this file may be

View File

@@ -1,9 +1,10 @@
/** /**
* @file * @file
* *
* @ingroup bsp_clock * @ingroup RTEMSDriverClockImpl
* *
* @brief riscv clock support. * @brief This source file contains the implementation of the riscv Clock
* Driver.
*/ */
/* /*

View File

@@ -3,9 +3,12 @@
/** /**
* @file * @file
* *
* @ingroup bsp_clock * @ingroup RTEMSDriverClockImpl
* *
* @brief Clock Tick Device Driver Shell * @brief This header file contains the shared Clock Driver implementation.
*
* This header file shall only be included by a particular Clock Driver
* implementation source file.
*/ */
/* /*
@@ -44,18 +47,18 @@
#include <rtems/score/thread.h> #include <rtems/score/thread.h>
#include <rtems/score/watchdogimpl.h> #include <rtems/score/watchdogimpl.h>
/**
* @defgroup RTEMSDriverClockImpl Clock Driver Implementation
*
* @ingroup RTEMSDriverClock
*
* @brief This group contains the Clock Driver implementation.
*/
#ifdef Clock_driver_nanoseconds_since_last_tick #ifdef Clock_driver_nanoseconds_since_last_tick
#error "Update driver to use the timecounter instead of nanoseconds extension" #error "Update driver to use the timecounter instead of nanoseconds extension"
#endif #endif
/**
* @defgroup bsp_clock Clock Support
*
* @ingroup RTEMSBSPsShared
*
* @brief Clock support
*
*/
#if CLOCK_DRIVER_USE_FAST_IDLE && CLOCK_DRIVER_ISRS_PER_TICK #if CLOCK_DRIVER_USE_FAST_IDLE && CLOCK_DRIVER_ISRS_PER_TICK
#error "Fast Idle PLUS n ISRs per tick is not supported" #error "Fast Idle PLUS n ISRs per tick is not supported"
#endif #endif

View File

@@ -5,9 +5,7 @@
* *
* @ingroup RTEMSDriverClock * @ingroup RTEMSDriverClock
* *
* @brief Clock Driver API * @brief This header file defines the Clock Driver API.
*
* This file defines the Clock Driver API.
*/ */
/* /*
@@ -50,7 +48,7 @@ extern "C" {
* *
* @ingroup RTEMSDeviceDrivers * @ingroup RTEMSDeviceDrivers
* *
* @brief The Clock Driver API. * @brief This group contains the Clock Driver API.
* *
* @{ * @{
*/ */