Zephyr API Documentation 4.2.0-rc1
A Scalable Open Source RTOS
 4.2.0-rc1
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
syscon.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2021 Carlo Caione <ccaione@baylibre.com>
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_DRIVERS_SYSCON_H_
13#define ZEPHYR_INCLUDE_DRIVERS_SYSCON_H_
14
22#include <errno.h>
23
24#include <zephyr/types.h>
25#include <zephyr/device.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
36typedef int (*syscon_api_get_base)(const struct device *dev, uintptr_t *addr);
37
43typedef int (*syscon_api_read_reg)(const struct device *dev, uint16_t reg, uint32_t *val);
44
50typedef int (*syscon_api_write_reg)(const struct device *dev, uint16_t reg, uint32_t val);
51
57typedef int (*syscon_api_get_size)(const struct device *dev, size_t *size);
58
68
77__syscall int syscon_get_base(const struct device *dev, uintptr_t *addr);
78
79static inline int z_impl_syscon_get_base(const struct device *dev, uintptr_t *addr)
80{
81 const struct syscon_driver_api *api = (const struct syscon_driver_api *)dev->api;
82
83 if ((api == NULL) || (api->get_base == NULL)) {
84 return -ENOSYS;
85 }
86
87 return api->get_base(dev, addr);
88}
89
90
103__syscall int syscon_read_reg(const struct device *dev, uint16_t reg, uint32_t *val);
104
105static inline int z_impl_syscon_read_reg(const struct device *dev, uint16_t reg, uint32_t *val)
106{
107 const struct syscon_driver_api *api = (const struct syscon_driver_api *)dev->api;
108
109 if ((api == NULL) || (api->read == NULL)) {
110 return -ENOSYS;
111 }
112
113 return api->read(dev, reg, val);
114}
115
116
129__syscall int syscon_write_reg(const struct device *dev, uint16_t reg, uint32_t val);
130
131static inline int z_impl_syscon_write_reg(const struct device *dev, uint16_t reg, uint32_t val)
132{
133 const struct syscon_driver_api *api = (const struct syscon_driver_api *)dev->api;
134
135 if ((api == NULL) || (api->write == NULL)) {
136 return -ENOSYS;
137 }
138
139 return api->write(dev, reg, val);
140}
141
150__syscall int syscon_get_size(const struct device *dev, size_t *size);
151
152static inline int z_impl_syscon_get_size(const struct device *dev, size_t *size)
153{
154 const struct syscon_driver_api *api = (const struct syscon_driver_api *)dev->api;
155
156 if ((api == NULL) || (api->get_size == NULL)) {
157 return -ENOSYS;
158 }
159
160 return api->get_size(dev, size);
161}
162
167#ifdef __cplusplus
168}
169#endif
170
171#include <zephyr/syscalls/syscon.h>
172
173#endif /* ZEPHYR_INCLUDE_DRIVERS_SYSCON_H_ */
System error numbers.
int syscon_get_base(const struct device *dev, uintptr_t *addr)
Get the syscon base address.
int(* syscon_api_write_reg)(const struct device *dev, uint16_t reg, uint32_t val)
API template to write a single register.
Definition syscon.h:50
int syscon_read_reg(const struct device *dev, uint16_t reg, uint32_t *val)
Read from syscon register.
int syscon_get_size(const struct device *dev, size_t *size)
Get the size of the syscon register in bytes.
int(* syscon_api_get_base)(const struct device *dev, uintptr_t *addr)
API template to get the base address of the syscon region.
Definition syscon.h:36
int(* syscon_api_read_reg)(const struct device *dev, uint16_t reg, uint32_t *val)
API template to read a single register.
Definition syscon.h:43
int syscon_write_reg(const struct device *dev, uint16_t reg, uint32_t val)
Write to syscon register.
int(* syscon_api_get_size)(const struct device *dev, size_t *size)
API template to get the size of the syscon register.
Definition syscon.h:57
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define NULL
Definition iar_missing_defs.h:20
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
System Control (syscon) register driver API.
Definition syscon.h:62
syscon_api_get_base get_base
Definition syscon.h:65
syscon_api_read_reg read
Definition syscon.h:63
syscon_api_get_size get_size
Definition syscon.h:66
syscon_api_write_reg write
Definition syscon.h:64