RTEMS 6.1-rc7
Loading...
Searching...
No Matches
clock.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-2-Clause */
2
12/*
13 * Copyright (C) 2020 embedded brains GmbH & Co. KG
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
17 * are met:
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _RTEMS_CONFDEFS_CLOCK_H
38#define _RTEMS_CONFDEFS_CLOCK_H
39
40#ifndef __CONFIGURATION_TEMPLATE_h
41#error "Do not include this file directly, use <rtems/confdefs.h> instead"
42#endif
43
44#ifdef CONFIGURE_INIT
45
47
48#if !defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) \
49 && !defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER) \
50 && !defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER)
51 #error "You must define one of CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER, CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER, and CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER"
52#endif
53
54#if ( defined(CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER) \
55 + defined(CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER) + \
56 + defined(CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER) ) > 1
57 #error "CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER, CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER, and CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER are mutually exclusive"
58#endif
59
60#ifdef CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
61 #include <rtems/clockdrv.h>
62 #include <rtems/sysinit.h>
63#endif
64
65#ifndef CONFIGURE_MICROSECONDS_PER_TICK
66 #define CONFIGURE_MICROSECONDS_PER_TICK 10000
67#endif
68
69#if 1000000 % CONFIGURE_MICROSECONDS_PER_TICK != 0
70 #warning "The clock ticks per second is not an integer"
71#endif
72
73#if defined(CONFIGURE_TICKS_PER_TIMESLICE) \
74 && CONFIGURE_TICKS_PER_TIMESLICE <= 0
75 #error "CONFIGURE_TICKS_PER_TIMESLICE shall be greater than zero"
76#endif
77
78#if CONFIGURE_MICROSECONDS_PER_TICK <= 0
79 #error "CONFIGURE_MICROSECONDS_PER_TICK must be positive"
80#endif
81
82#ifdef __cplusplus
83extern "C" {
84#endif
85
86#ifdef CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
89 RTEMS_SYSINIT_DEVICE_DRIVERS,
90 RTEMS_SYSINIT_ORDER_THIRD
91 );
92#endif
93
96
97const uint32_t _Watchdog_Nanoseconds_per_tick =
98 (uint32_t) 1000 * CONFIGURE_MICROSECONDS_PER_TICK;
99
100const uint32_t _Watchdog_Ticks_per_second =
102
103#if defined(CONFIGURE_TICKS_PER_TIMESLICE) \
104 && CONFIGURE_TICKS_PER_TIMESLICE != WATCHDOG_TICKS_PER_TIMESLICE_DEFAULT
105 const uint32_t _Watchdog_Ticks_per_timeslice =
107#endif
108
109#ifdef __cplusplus
110}
111#endif
112
113#endif /* CONFIGURE_INIT */
114
115#endif /* _RTEMS_CONFDEFS_CLOCK_H */
This header file defines the Clock Driver API.
#define RTEMS_SYSINIT_ITEM(handler, module, order)
Creates the system initialization item associated with the handler, module, and order.
Definition: sysinit.h:204
#define CONFIGURE_MICROSECONDS_PER_TICK
This configuration option is an integer define.
Definition: appl-config.h:3230
#define CONFIGURE_TICKS_PER_TIMESLICE
This configuration option is an integer define.
Definition: appl-config.h:3336
void _Clock_Initialize(void)
Initialize the clock driver.
Definition: clock.c:56
const uint32_t _Watchdog_Microseconds_per_tick
The watchdog microseconds per tick.
const uint32_t _Watchdog_Nanoseconds_per_tick
The watchdog nanoseconds per tick.
const uint32_t _Watchdog_Ticks_per_second
The watchdog ticks per second.
const uint32_t _Watchdog_Ticks_per_timeslice
The watchdog ticks per timeslice.
Definition: watchdogtimeslicedefault.c:43
This header file provides the API of the System Initialization Support.
This header file provides the interfaces of the Watchdog Handler related to watchdog ticks which are ...