Zephyr API Documentation 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
policy.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_PM_POLICY_H_
8#define ZEPHYR_INCLUDE_PM_POLICY_H_
9
10#include <stdbool.h>
11#include <stdint.h>
12
13#include <zephyr/device.h>
14#include <zephyr/pm/state.h>
15#include <zephyr/sys/slist.h>
16#include <zephyr/toolchain.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
28
36typedef void (*pm_policy_latency_changed_cb_t)(int32_t latency);
37
49
57 sys_snode_t node;
58 uint32_t value_us;
60};
61
69 sys_snode_t node;
70 int64_t uptime_ticks;
72};
73
75
89const struct pm_state_info *pm_policy_next_state(uint8_t cpu, int32_t ticks);
90
92
94#define PM_ALL_SUBSTATES (UINT8_MAX)
95
96#if defined(CONFIG_PM) || defined(__DOXYGEN__)
116
127
142
157
169
183
194
213void pm_policy_event_register(struct pm_policy_event *evt, int64_t uptime_ticks);
214
226void pm_policy_event_update(struct pm_policy_event *evt, int64_t uptime_ticks);
227
236
251
263
264#else
266{
267 ARG_UNUSED(state);
268 ARG_UNUSED(substate_id);
269}
270
272{
273 ARG_UNUSED(state);
274 ARG_UNUSED(substate_id);
275}
276
278{
279 ARG_UNUSED(state);
280 ARG_UNUSED(substate_id);
281
282 return false;
283}
284
285static inline void pm_policy_event_register(struct pm_policy_event *evt, uint32_t cycle)
286{
287 ARG_UNUSED(evt);
288 ARG_UNUSED(cycle);
289}
290
291static inline void pm_policy_event_update(struct pm_policy_event *evt, uint32_t cycle)
292{
293 ARG_UNUSED(evt);
294 ARG_UNUSED(cycle);
295}
296
297static inline void pm_policy_event_unregister(struct pm_policy_event *evt)
298{
299 ARG_UNUSED(evt);
300}
301
302static inline int64_t pm_policy_next_event_ticks(void)
303{
304 return -1;
305}
306
307#endif /* CONFIG_PM */
308
309#if defined(CONFIG_PM_POLICY_DEVICE_CONSTRAINTS) || defined(__DOXYGEN__)
322
335
336#else
337
338static inline void pm_policy_device_power_lock_get(const struct device *dev)
339{
340 ARG_UNUSED(dev);
341}
342
343static inline void pm_policy_device_power_lock_put(const struct device *dev)
344{
345 ARG_UNUSED(dev);
346}
347#endif /* CONFIG_PM_POLICY_DEVICE_CONSTRAINTS */
348
349#if defined(CONFIG_PM) || defined(CONFIG_PM_POLICY_LATENCY_STANDALONE) || defined(__DOXYGEN__)
360 uint32_t value_us);
361
369 uint32_t value_us);
370
377
386
393#else
394static inline void pm_policy_latency_request_add(
395 struct pm_policy_latency_request *req, uint32_t value_us)
396{
397 ARG_UNUSED(req);
398 ARG_UNUSED(value_us);
399}
400
401static inline void pm_policy_latency_request_update(
402 struct pm_policy_latency_request *req, uint32_t value_us)
403{
404 ARG_UNUSED(req);
405 ARG_UNUSED(value_us);
406}
407
408static inline void pm_policy_latency_request_remove(
409 struct pm_policy_latency_request *req)
410{
411 ARG_UNUSED(req);
412}
413#endif /* CONFIG_PM CONFIG_PM_POLICY_LATENCY_STANDALONE */
414
418
419#ifdef __cplusplus
420}
421#endif
422
423#endif /* ZEPHYR_INCLUDE_PM_POLICY_H_ */
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
pm_state
Power management state.
Definition state.h:28
void pm_policy_event_update(struct pm_policy_event *evt, int64_t uptime_ticks)
Update an event.
bool pm_policy_state_any_active(void)
Check if any power state can be used.
void pm_policy_state_lock_put(enum pm_state state, uint8_t substate_id)
Decrease a power state lock counter.
bool pm_policy_state_is_available(enum pm_state state, uint8_t substate_id)
Check if a power state is available.
bool pm_policy_state_lock_is_active(enum pm_state state, uint8_t substate_id)
Check if a power state lock is active (not allowed).
void pm_policy_state_constraints_get(struct pm_state_constraints *constraints)
Apply power state constraints by locking the specified states.
bool pm_policy_device_is_disabling_state(const struct device *dev, enum pm_state state, uint8_t substate_id)
Check if a state will disable a device.
void pm_policy_event_register(struct pm_policy_event *evt, int64_t uptime_ticks)
Register an event.
void pm_policy_latency_request_update(struct pm_policy_latency_request *req, uint32_t value_us)
Update a latency requirement.
void pm_policy_device_power_lock_get(const struct device *dev)
Increase power state locks.
void pm_policy_state_constraints_put(struct pm_state_constraints *constraints)
Remove power state constraints by unlocking the specified states.
void pm_policy_latency_request_add(struct pm_policy_latency_request *req, uint32_t value_us)
Add a new latency requirement.
void pm_policy_latency_changed_unsubscribe(struct pm_policy_latency_subscription *req)
Unsubscribe to maximum latency changes.
void pm_policy_event_unregister(struct pm_policy_event *evt)
Unregister an event.
void pm_policy_latency_request_remove(struct pm_policy_latency_request *req)
Remove a latency requirement.
void(* pm_policy_latency_changed_cb_t)(int32_t latency)
Callback to notify when maximum latency changes.
Definition policy.h:36
void pm_policy_state_lock_get(enum pm_state state, uint8_t substate_id)
Increase a power state lock counter.
void pm_policy_latency_changed_subscribe(struct pm_policy_latency_subscription *req, pm_policy_latency_changed_cb_t cb)
Subscribe to maximum latency changes.
int64_t pm_policy_next_event_ticks(void)
Returns the ticks until the next event.
void pm_policy_device_power_lock_put(const struct device *dev)
Decrease power state locks.
state
Definition parser_state.h:29
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__INT64_TYPE__ int64_t
Definition stdint.h:75
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
Event.
Definition policy.h:67
Latency request.
Definition policy.h:55
Latency change subscription.
Definition policy.h:43
Collection of multiple power state constraints.
Definition state.h:192
Information about a power management state.
Definition state.h:115
uint8_t substate_id
Some platforms have multiple states that map to one Zephyr power state.
Definition state.h:143
Macros to abstract toolchain specific capabilities.