summaryrefslogtreecommitdiffstats
path: root/bsps/shared
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2023-01-23 15:26:10 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2023-01-24 09:56:53 +0100
commit6136e28bf95c8cadf4892fd3e1333e489aff139a (patch)
treeee95f7da351ee4bfefef7cfef5ab0a510cc043cc /bsps/shared
parenttm27: Avoid function pointer casts (diff)
downloadrtems-6136e28bf95c8cadf4892fd3e1333e489aff139a.tar.bz2
clockdrv: Add clock driver implementation group
Use standard wording in Clock Driver related files. Update #3706.
Diffstat (limited to 'bsps/shared')
-rw-r--r--bsps/shared/dev/clock/clockimpl.h23
1 files changed, 13 insertions, 10 deletions
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