[PATCH] Add clock driver implementation group
Sebastian Huber
sebastian.huber at embedded-brains.de
Mon Jan 23 14:27:16 UTC 2023
Use standard wording in Clock Driver related files.
---
bsps/arm/raspberrypi/clock/clockdrv.c | 7 +++----
bsps/or1k/generic_or1k/clock/clockdrv.c | 7 +++----
bsps/riscv/riscv/clock/clockdrv.c | 5 +++--
bsps/shared/dev/clock/clockimpl.h | 23 +++++++++++++----------
cpukit/include/rtems/clockdrv.h | 6 ++----
5 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/bsps/arm/raspberrypi/clock/clockdrv.c b/bsps/arm/raspberrypi/clock/clockdrv.c
index 9954d41741..8d220d51ba 100644
--- a/bsps/arm/raspberrypi/clock/clockdrv.c
+++ b/bsps/arm/raspberrypi/clock/clockdrv.c
@@ -1,14 +1,13 @@
/**
* @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) 2016 Pavel Pisa
*
diff --git a/bsps/or1k/generic_or1k/clock/clockdrv.c b/bsps/or1k/generic_or1k/clock/clockdrv.c
index 7b8a07fd3d..44f220e057 100644
--- a/bsps/or1k/generic_or1k/clock/clockdrv.c
+++ b/bsps/or1k/generic_or1k/clock/clockdrv.c
@@ -1,14 +1,13 @@
/**
* @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 at gmail.com>
*
* The license and distribution terms for this file may be
diff --git a/bsps/riscv/riscv/clock/clockdrv.c b/bsps/riscv/riscv/clock/clockdrv.c
index d183e65b94..28222c69db 100644
--- a/bsps/riscv/riscv/clock/clockdrv.c
+++ b/bsps/riscv/riscv/clock/clockdrv.c
@@ -1,9 +1,10 @@
/**
* @file
*
- * @ingroup bsp_clock
+ * @ingroup RTEMSDriverClockImpl
*
- * @brief riscv clock support.
+ * @brief This source file contains the implementation of the riscv Clock
+ * Driver.
*/
/*
diff --git a/bsps/shared/dev/clock/clockimpl.h b/bsps/shared/dev/clock/clockimpl.h
index ccf6d3ab60..e922c0b320 100644
--- a/bsps/shared/dev/clock/clockimpl.h
+++ b/bsps/shared/dev/clock/clockimpl.h
@@ -3,9 +3,12 @@
/**
* @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/watchdogimpl.h>
-#ifdef Clock_driver_nanoseconds_since_last_tick
-#error "Update driver to use the timecounter instead of nanoseconds extension"
-#endif
-
/**
- * @defgroup bsp_clock Clock Support
- *
- * @ingroup RTEMSBSPsShared
+ * @defgroup RTEMSDriverClockImpl Clock Driver Implementation
*
- * @brief Clock support
+ * @ingroup RTEMSDriverClock
*
+ * @brief This group contains the Clock Driver implementation.
*/
+
+#ifdef Clock_driver_nanoseconds_since_last_tick
+#error "Update driver to use the timecounter instead of nanoseconds extension"
+#endif
+
#if CLOCK_DRIVER_USE_FAST_IDLE && CLOCK_DRIVER_ISRS_PER_TICK
#error "Fast Idle PLUS n ISRs per tick is not supported"
#endif
diff --git a/cpukit/include/rtems/clockdrv.h b/cpukit/include/rtems/clockdrv.h
index 3d3a62a63f..cd55e1bfe5 100644
--- a/cpukit/include/rtems/clockdrv.h
+++ b/cpukit/include/rtems/clockdrv.h
@@ -5,9 +5,7 @@
*
* @ingroup RTEMSDriverClock
*
- * @brief Clock Driver API
- *
- * This file defines the Clock Driver API.
+ * @brief This header file defines the Clock Driver API.
*/
/*
@@ -50,7 +48,7 @@ extern "C" {
*
* @ingroup RTEMSDeviceDrivers
*
- * @brief The Clock Driver API.
+ * @brief This group contains the Clock Driver API.
*
* @{
*/
--
2.35.3
More information about the devel
mailing list