source: rtems/cpukit/include/rtems/clockdrv.h @ 6136e28b

Last change on this file since 6136e28b was 6136e28b, checked in by Sebastian Huber <sebastian.huber@…>, on 01/23/23 at 14:26:10

clockdrv: Add clock driver implementation group

Use standard wording in Clock Driver related files.

Update #3706.
  • Property mode set to 100644
File size: 2.1 KB
Line 
1/* SPDX-License-Identifier: BSD-2-Clause */
2
3/**
4 * @file
5 *
6 * @ingroup RTEMSDriverClock
7 *
8 * @brief This header file defines the Clock Driver API.
9 */
10
11/*
12 *  COPYRIGHT (c) 1989-2011.
13 *  On-Line Applications Research Corporation (OAR).
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_CLOCKDRV_H
38#define _RTEMS_CLOCKDRV_H
39
40#include <stdint.h>
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46/**
47 * @defgroup RTEMSDriverClock Clock Driver
48 *
49 * @ingroup RTEMSDeviceDrivers
50 *
51 * @brief This group contains the Clock Driver API.
52 *
53 * @{
54 */
55
56/**
57 * @brief Count of clock driver ticks since system boot or last overflow.
58 *
59 * This counter may overflow.
60 */
61extern volatile uint32_t Clock_driver_ticks;
62
63/**
64 * @brief Initialize the clock driver.
65 */
66void _Clock_Initialize( void );
67
68/** @} */
69
70#ifdef __cplusplus
71}
72#endif
73
74#endif
75/* end of include file */
Note: See TracBrowser for help on using the repository browser.