config: Add <rtems/confdefs/clock.h>

Remove all comments and copyrightable content from the moved content.
Use BSD-2-Clause license for new file.

Update #3053.
Update #3875.

3 files changed, 111 insertions, 88 deletions

diff --git a/cpukit/headers.am b/cpukit/headers.am
index 20059a7909..60a3687db8 100644
--- a/cpukit/headers.am
+++ b/cpukit/headers.am
@@ -185,6 +185,7 @@ include_rtems_HEADERS += include/rtems/vmeintr.h
 include_rtems_HEADERS += include/rtems/watchdogdrv.h
 include_rtems_confdefs_HEADERS += include/rtems/confdefs/bdbuf.h
 include_rtems_confdefs_HEADERS += include/rtems/confdefs/bsp.h
+include_rtems_confdefs_HEADERS += include/rtems/confdefs/clock.h
 include_rtems_confdefs_HEADERS += include/rtems/confdefs/libio.h
 include_rtems_confdefs_HEADERS += include/rtems/confdefs/libpci.h
 include_rtems_confdefs_HEADERS += include/rtems/confdefs/malloc.h
diff --git a/cpukit/include/rtems/confdefs.h b/cpukit/include/rtems/confdefs.h
index a28e277311..f4cbe43908 100644
--- a/cpukit/include/rtems/confdefs.h
+++ b/cpukit/include/rtems/confdefs.h
@@ -51,6 +51,7 @@
 #include <rtems/posix/timer.h>
 #include <rtems/confdefs/obsolete.h>
 #include <rtems/confdefs/bdbuf.h>
+#include <rtems/confdefs/clock.h>
 #include <rtems/confdefs/libio.h>
 #include <rtems/confdefs/libpci.h>
 #include <rtems/confdefs/malloc.h>
@@ -302,18 +303,6 @@ extern "C" {
   #endif
 #endif
 
-#ifdef CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
-  #include <rtems/clockdrv.h>
-
-  #ifdef CONFIGURE_INIT
-    RTEMS_SYSINIT_ITEM(
-      _Clock_Initialize,
-      RTEMS_SYSINIT_DEVICE_DRIVERS,
-      RTEMS_SYSINIT_ORDER_THIRD
-    );
-  #endif
-#endif
-
 #ifdef CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
   #include <rtems/btimer.h>
 #endif
@@ -605,54 +594,6 @@ extern "C" {
 
 /**@}*/ /* end of Classic API Configuration */
 
-/**
- * @defgroup ConfigurationGeneral General System Configuration
- *
- * @ingroup Configuration
- *
- * This module contains configuration parameters that are independent
- * of any API but impact general system configuration.
- */
-/**@{*/
-
-/** The configures the number of microseconds per clock tick. */
-#ifndef CONFIGURE_MICROSECONDS_PER_TICK
-  #define CONFIGURE_MICROSECONDS_PER_TICK \
-          RTEMS_MILLISECONDS_TO_MICROSECONDS(10)
-#endif
-
-#if 1000000 % CONFIGURE_MICROSECONDS_PER_TICK != 0
-  #warning "The clock ticks per second is not an integer"
-#endif
-
-#if CONFIGURE_MICROSECONDS_PER_TICK <= 0
-  #error "The CONFIGURE_MICROSECONDS_PER_TICK must be positive"
-#endif
-
-#ifdef CONFIGURE_INIT
-  const uint32_t _Watchdog_Microseconds_per_tick =
-    CONFIGURE_MICROSECONDS_PER_TICK;
-
-  const uint32_t _Watchdog_Nanoseconds_per_tick =
-    (uint32_t) 1000 * CONFIGURE_MICROSECONDS_PER_TICK;
-
-  const uint32_t _Watchdog_Ticks_per_second =
-    1000000 / CONFIGURE_MICROSECONDS_PER_TICK;
-#endif
-
-/** The configures the number of clock ticks per timeslice. */
-#if defined(CONFIGURE_TICKS_PER_TIMESLICE) && \
-  CONFIGURE_TICKS_PER_TIMESLICE != WATCHDOG_TICKS_PER_TIMESLICE_DEFAULT
-
-#ifdef CONFIGURE_INIT
-  const uint32_t _Watchdog_Ticks_per_timeslice =
-    CONFIGURE_TICKS_PER_TIMESLICE;
-#endif
-
-#endif /* CONFIGURE_TICKS_PER_TIMESLICE */
-
-/**@}*/ /* end of General Configuration */
-
 /*
  *  Initial Extension Set
  */
@@ -1419,34 +1360,6 @@ struct _reent *__getreent(void)
 #endif
 #endif
 
-#if !defined(RTEMS_SCHEDSIM)
-/*
- *  You must either explicitly include or exclude the clock driver.
- *  It is such a common newbie error to leave it out.  Maybe this
- *  will put an end to it.
- *
- *  NOTE: If you are using the timer driver, it is considered
- *        mutually exclusive with the clock driver because the
- *        drivers are assumed to use the same "timer" hardware
- *        on many boards.
- */
-#if !defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) && \
-    !defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER) && \
-    !defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER)
-  #error "CONFIGURATION ERROR: Do you want the clock driver or not?!?"
- #endif
-
-/*
- * Only one of the following three configuration parameters should be
- * defined at a time.
- */
-#if ((defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) + \
-      defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER) + \
-      defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER)) > 1)
-   #error "CONFIGURATION ERROR: More than one clock/timer driver configuration parameter specified?!?"
-#endif
-#endif   /* !defined(RTEMS_SCHEDSIM) */
-
 /*
  * POSIX Key pair shouldn't be less than POSIX Key, which is highly
  * likely to be error.
diff --git a/cpukit/include/rtems/confdefs/clock.h b/cpukit/include/rtems/confdefs/clock.h
new file mode 100644
index 0000000000..1c70ca0019
--- /dev/null
+++ b/cpukit/include/rtems/confdefs/clock.h
@@ -0,0 +1,109 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSApplicationConfiguration
+ *
+ * @brief Evaluate Clock Configuration Options
+ */
+
+/*
+ * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ *
+ * 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 _RTEMS_CONFDEFS_CLOCK_H
+#define _RTEMS_CONFDEFS_CLOCK_H
+
+#ifndef __CONFIGURATION_TEMPLATE_h
+#error "Do not include this file directly, use <rtems/confdefs.h> instead"
+#endif
+
+#ifdef CONFIGURE_INIT
+
+#include <rtems/score/watchdogticks.h>
+
+#if !defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) \
+  && !defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER) \
+  && !defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER)
+  #error "You must define one of CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER, CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER, and CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER"
+#endif
+
+#if ( defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) \
+  + defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER) + \
+  + defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER) ) > 1
+  #error "CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER, CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER, and CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER are mutually exclusive"
+#endif
+
+#ifdef CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
+  #include <rtems/clockdrv.h>
+  #include <rtems/sysinit.h>
+#endif
+
+#ifndef CONFIGURE_MICROSECONDS_PER_TICK
+  #define CONFIGURE_MICROSECONDS_PER_TICK 10000
+#endif
+
+#if 1000000 % CONFIGURE_MICROSECONDS_PER_TICK != 0
+  #warning "The clock ticks per second is not an integer"
+#endif
+
+#if CONFIGURE_MICROSECONDS_PER_TICK <= 0
+  #error "CONFIGURE_MICROSECONDS_PER_TICK must be positive"
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifdef CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
+  RTEMS_SYSINIT_ITEM(
+    _Clock_Initialize,
+    RTEMS_SYSINIT_DEVICE_DRIVERS,
+    RTEMS_SYSINIT_ORDER_THIRD
+  );
+#endif
+
+const uint32_t _Watchdog_Microseconds_per_tick =
+  CONFIGURE_MICROSECONDS_PER_TICK;
+
+const uint32_t _Watchdog_Nanoseconds_per_tick =
+  (uint32_t) 1000 * CONFIGURE_MICROSECONDS_PER_TICK;
+
+const uint32_t _Watchdog_Ticks_per_second =
+  1000000 / CONFIGURE_MICROSECONDS_PER_TICK;
+
+#if defined(CONFIGURE_TICKS_PER_TIMESLICE) \
+  && CONFIGURE_TICKS_PER_TIMESLICE != WATCHDOG_TICKS_PER_TIMESLICE_DEFAULT
+  const uint32_t _Watchdog_Ticks_per_timeslice =
+    CONFIGURE_TICKS_PER_TIMESLICE;
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* CONFIGURE_INIT */
+
+#endif /* _RTEMS_CONFDEFS_CLOCK_H */