1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/*
* Copyright (c) 2016 Intel Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @brief Public API for counter and timer drivers
*/
#ifndef __COUNTER_H__
#define __COUNTER_H__
/**
* @brief COUNTER Interface
* @defgroup counter_interface COUNTER Interface
* @ingroup io_interfaces
* @{
*/
#include <stdint.h>
#include <stddef.h>
#include <device.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef void (*counter_callback_t)(struct device *dev, void *user_data);
typedef int (*counter_api_start)(struct device *dev);
typedef int (*counter_api_stop)(struct device *dev);
typedef uint32_t (*counter_api_read)(void);
typedef int (*counter_api_set_alarm)(struct device *dev,
counter_callback_t callback,
uint32_t count, void *user_data);
struct counter_driver_api {
counter_api_start start;
counter_api_stop stop;
counter_api_read read;
counter_api_set_alarm set_alarm;
};
/**
* @brief Start counter device in free running mode.
*
* Start the counter device. If the device is a 'countup' counter, the
* counter initial value is set to zero. If it is a 'countdown' counter,
* the initial value is set to the maximum value supported by the device.
*
* @param dev Pointer to the device structure for the driver instance.
*
* @retval 0 If successful.
* @retval Negative errno code if failure.
*/
static inline int counter_start(struct device *dev)
{
const struct counter_driver_api *api = dev->driver_api;
return api->start(dev);
}
/**
* @brief Stop counter device.
* @param dev Pointer to the device structure for the driver instance.
*
* @retval 0 If successful.
* @retval -ENODEV if the device doesn't support stopping the
* counter.
*/
static inline int counter_stop(struct device *dev)
{
const struct counter_driver_api *api = dev->driver_api;
return api->stop(dev);
}
/**
* @brief Read current counter value.
* @param dev Pointer to the device structure for the driver instance.
*
* @return 32-bit value
*/
static inline uint32_t counter_read(struct device *dev)
{
const struct counter_driver_api *api = dev->driver_api;
return api->read();
}
/**
* @brief Set an alarm.
* @param dev Pointer to the device structure for the driver instance.
* @param callback Pointer to the callback function. if this is NULL,
* this function unsets the alarm.
* @param count Number of counter ticks.
* @param user_data Pointer to user data.
*
* @retval 0 If successful.
* @retval -ENOTSUP if the counter was not started yet.
* @retval -ENODEV if the device doesn't support interrupt (e.g. free
* running counters).
* @retval Negative errno code if failure.
*/
static inline int counter_set_alarm(struct device *dev,
counter_callback_t callback,
uint32_t count, void *user_data)
{
const struct counter_driver_api *api = dev->driver_api;
return api->set_alarm(dev, callback, count, user_data);
}
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif /* __COUNTER_H__ */
|
