rtems/confdefs/clock.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplApplConfig
0007  *
0008  * @brief This header file evaluates configuration options related to the clock
0009  *   driver configuration.
0010  */
0011
0012 /*
0013  * Copyright (C) 2020 embedded brains GmbH & Co. KG
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_CONFDEFS_CLOCK_H
0038 #define _RTEMS_CONFDEFS_CLOCK_H
0039
0040 #ifndef __CONFIGURATION_TEMPLATE_h
0041 #error "Do not include this file directly, use <rtems/confdefs.h> instead"
0042 #endif
0043
0044 #ifdef CONFIGURE_INIT
0045
0046 #include <rtems/score/watchdogticks.h>
0047
0048 #if !defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) \
0049   && !defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER) \
0050   && !defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER)
0051   #error "You must define one of CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER, CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER, and CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER"
0052 #endif
0053
0054 #if ( defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) \
0055   + defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER) + \
0056   + defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER) ) > 1
0057   #error "CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER, CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER, and CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER are mutually exclusive"
0058 #endif
0059
0060 #ifdef CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
0061   #include <rtems/clockdrv.h>
0062   #include <rtems/sysinit.h>
0063 #endif
0064
0065 #ifndef CONFIGURE_MICROSECONDS_PER_TICK
0066   #define CONFIGURE_MICROSECONDS_PER_TICK 10000
0067 #endif
0068
0069 #if 1000000 % CONFIGURE_MICROSECONDS_PER_TICK != 0
0070   #warning "The clock ticks per second is not an integer"
0071 #endif
0072
0073 #if defined(CONFIGURE_TICKS_PER_TIMESLICE) \
0074   && CONFIGURE_TICKS_PER_TIMESLICE <= 0
0075   #error "CONFIGURE_TICKS_PER_TIMESLICE shall be greater than zero"
0076 #endif
0077
0078 #if CONFIGURE_MICROSECONDS_PER_TICK <= 0
0079   #error "CONFIGURE_MICROSECONDS_PER_TICK must be positive"
0080 #endif
0081
0082 #ifdef __cplusplus
0083 extern "C" {
0084 #endif
0085
0086 #ifdef CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
0087   RTEMS_SYSINIT_ITEM(
0088     _Clock_Initialize,
0089     RTEMS_SYSINIT_DEVICE_DRIVERS,
0090     RTEMS_SYSINIT_ORDER_THIRD
0091   );
0092 #endif
0093
0094 const uint32_t _Watchdog_Microseconds_per_tick =
0095   CONFIGURE_MICROSECONDS_PER_TICK;
0096
0097 const uint32_t _Watchdog_Nanoseconds_per_tick =
0098   (uint32_t) 1000 * CONFIGURE_MICROSECONDS_PER_TICK;
0099
0100 const uint32_t _Watchdog_Ticks_per_second =
0101   1000000 / CONFIGURE_MICROSECONDS_PER_TICK;
0102
0103 #if defined(CONFIGURE_TICKS_PER_TIMESLICE) \
0104   && CONFIGURE_TICKS_PER_TIMESLICE != WATCHDOG_TICKS_PER_TIMESLICE_DEFAULT
0105   const uint32_t _Watchdog_Ticks_per_timeslice =
0106     CONFIGURE_TICKS_PER_TIMESLICE;
0107 #endif
0108
0109 #ifdef __cplusplus
0110 }
0111 #endif
0112
0113 #endif /* CONFIGURE_INIT */
0114
0115 #endif /* _RTEMS_CONFDEFS_CLOCK_H */