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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
/* Copyright 2021 The ChromiumOS Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* @file
* @brief Public API for cros system drivers
*/
#ifndef ZEPHYR_INCLUDE_DRIVERS_CROS_SYSTEM_H_
#define ZEPHYR_INCLUDE_DRIVERS_CROS_SYSTEM_H_
/**
* @brief cros system Interface
* @defgroup cros_system_interface cros system Interface
* @ingroup io_interfaces
* @{
*/
#include <zephyr/kernel.h>
#include <zephyr/device.h>
/**
* @brief system_reset_cause enum
* Identify the reset cause.
*/
enum system_reset_cause {
/* the reset is triggered by VCC power-up */
POWERUP = 0,
/* the reset is triggered by external VCC1 reset pin */
VCC1_RST_PIN = 1,
/* the reset is triggered by ICE debug reset request */
DEBUG_RST = 2,
/* the reset is triggered by watchdog */
WATCHDOG_RST = 3,
/* unknown reset type */
UNKNOWN_RST,
};
/**
* @brief Get a node from path '/hibernate_wakeup_pins' which has a property
* 'wakeup-pins' contains GPIO list for hibernate wake-up
*
* @return node identifier with that path.
*/
#define SYSTEM_DT_NODE_HIBERNATE_CONFIG DT_INST(0, cros_ec_hibernate_wake_pins)
/**
* @typedef cros_system_get_reset_cause_api
* @brief Callback API for getting reset cause instance.
* See cros_system_get_reset_cause() for argument descriptions
*/
typedef int (*cros_system_get_reset_cause_api)(const struct device *dev);
/**
* @typedef cros_system_soc_reset_api
* @brief Callback API for soc-reset instance.
* See cros_system_soc_reset() for argument descriptions
*/
typedef int (*cros_system_soc_reset_api)(const struct device *dev);
/**
* @typedef cros_system_hibernate_api
* @brief Callback API for entering hibernate state (lowest EC power state).
* See cros_system_hibernate() for argument descriptions
*/
typedef int (*cros_system_hibernate_api)(const struct device *dev,
uint32_t seconds,
uint32_t microseconds);
/**
* @typedef cros_system_chip_vendor_api
* @brief Callback API for getting the chip vendor.
* See cros_system_chip_vendor() for argument descriptions
*/
typedef const char *(*cros_system_chip_vendor_api)(const struct device *dev);
/**
* @typedef cros_system_chip_name_api
* @brief Callback API for getting the chip name.
* See cros_system_chip_name() for argument descriptions
*/
typedef const char *(*cros_system_chip_name_api)(const struct device *dev);
/**
* @typedef cros_system_chip_revision_api
* @brief Callback API for getting the chip revision.
* See cros_system_chip_revision() for argument descriptions
*/
typedef const char *(*cros_system_chip_revision_api)(const struct device *dev);
/**
* @typedef cros_system_get_deep_sleep_ticks_api
* @brief Callback API for getting number of ticks spent in deep sleep.
* See cros_system_deep_sleep_ticks() for argument descriptions
*/
typedef uint64_t (*cros_system_deep_sleep_ticks_api)(const struct device *dev);
/** @brief Driver API structure. */
__subsystem struct cros_system_driver_api {
cros_system_get_reset_cause_api get_reset_cause;
cros_system_soc_reset_api soc_reset;
cros_system_hibernate_api hibernate;
cros_system_chip_vendor_api chip_vendor;
cros_system_chip_name_api chip_name;
cros_system_chip_revision_api chip_revision;
cros_system_deep_sleep_ticks_api deep_sleep_ticks;
};
/**
* @brief Get the chip-reset cause
*
* @param dev Pointer to the device structure for the driver instance.
*
* @retval non-negative if successful.
* @retval Negative errno code if failure.
*/
__syscall int cros_system_get_reset_cause(const struct device *dev);
static inline int z_impl_cros_system_get_reset_cause(const struct device *dev)
{
const struct cros_system_driver_api *api =
(const struct cros_system_driver_api *)dev->api;
if (!api->get_reset_cause) {
return -ENOTSUP;
}
return api->get_reset_cause(dev);
}
/**
* @brief reset the soc
*
* @param dev Pointer to the device structure for the driver instance.
*
* @retval no return if successful.
* @retval Negative errno code if failure.
*/
__syscall int cros_system_soc_reset(const struct device *dev);
static inline int z_impl_cros_system_soc_reset(const struct device *dev)
{
const struct cros_system_driver_api *api =
(const struct cros_system_driver_api *)dev->api;
if (!api->soc_reset) {
return -ENOTSUP;
}
return api->soc_reset(dev);
}
/**
* @brief put the EC in hibernate (lowest EC power state).
*
* @param dev Pointer to the device structure for the driver instance.
* @param seconds Number of seconds before EC enters hibernate state.
* @param microseconds Number of micro-secs before EC enters hibernate state.
* @retval no return if successful.
* @retval Negative errno code if failure.
*/
__syscall int cros_system_hibernate(const struct device *dev, uint32_t seconds,
uint32_t microseconds);
static inline int z_impl_cros_system_hibernate(const struct device *dev,
uint32_t seconds,
uint32_t microseconds)
{
const struct cros_system_driver_api *api =
(const struct cros_system_driver_api *)dev->api;
if (!api->hibernate) {
return -ENOTSUP;
}
return api->hibernate(dev, seconds, microseconds);
}
/**
* @brief Get the chip vendor.
*
* @param dev Pointer to the device structure for the driver instance.
* @retval Chip vendor string if successful.
* @retval Null string if failure.
*/
__syscall const char *cros_system_chip_vendor(const struct device *dev);
static inline const char *
z_impl_cros_system_chip_vendor(const struct device *dev)
{
const struct cros_system_driver_api *api =
(const struct cros_system_driver_api *)dev->api;
if (!api->chip_vendor) {
return "";
}
return api->chip_vendor(dev);
}
/**
* @brief Get the chip name.
*
* @param dev Pointer to the device structure for the driver instance.
* @retval Chip name string if successful.
* @retval Null string if failure.
*/
__syscall const char *cros_system_chip_name(const struct device *dev);
static inline const char *z_impl_cros_system_chip_name(const struct device *dev)
{
const struct cros_system_driver_api *api =
(const struct cros_system_driver_api *)dev->api;
if (!api->chip_name) {
return "";
}
return api->chip_name(dev);
}
/**
* @brief Get the chip revision.
*
* @param dev Pointer to the device structure for the driver instance.
* @retval Chip revision string if successful.
* @retval Null string if failure.
*/
__syscall const char *cros_system_chip_revision(const struct device *dev);
static inline const char *
z_impl_cros_system_chip_revision(const struct device *dev)
{
const struct cros_system_driver_api *api =
(const struct cros_system_driver_api *)dev->api;
if (!api->chip_revision) {
return "";
}
return api->chip_revision(dev);
}
/**
* @brief Get total number of ticks spent in deep sleep.
*
* @param dev Pointer to the device structure for the driver instance.
* @retval Number of ticks spent in deep sleep.
*/
__syscall uint64_t cros_system_deep_sleep_ticks(const struct device *dev);
static inline uint64_t
z_impl_cros_system_deep_sleep_ticks(const struct device *dev)
{
const struct cros_system_driver_api *api =
(const struct cros_system_driver_api *)dev->api;
if (!api->deep_sleep_ticks) {
return 0;
}
return api->deep_sleep_ticks(dev);
}
/**
* @}
*/
#include <syscalls/cros_system.h>
#endif /* ZEPHYR_INCLUDE_DRIVERS_CROS_SYSTEM_H_ */
|
