Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
dac.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Libre Solar Technologies GmbH
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
13#ifndef ZEPHYR_INCLUDE_DRIVERS_DAC_H_
14#define ZEPHYR_INCLUDE_DRIVERS_DAC_H_
15
16#include <zephyr/device.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
35#define DAC_CHANNEL_BROADCAST 0xFF
36
49 bool buffered: 1;
54 bool internal: 1;
55};
56
63/*
64 * Type definition of DAC API function for configuring a channel.
65 * See dac_channel_setup() for argument descriptions.
66 */
67typedef int (*dac_api_channel_setup)(const struct device *dev,
68 const struct dac_channel_cfg *channel_cfg);
69
70/*
71 * Type definition of DAC API function for setting a write request.
72 * See dac_write_value() for argument descriptions.
73 */
74typedef int (*dac_api_write_value)(const struct device *dev,
75 uint8_t channel, uint32_t value);
76
77/*
78 * DAC driver API
79 *
80 * This is the mandatory API any DAC driver needs to expose.
81 */
82__subsystem struct dac_driver_api {
83 dac_api_channel_setup channel_setup;
84 dac_api_write_value write_value;
85};
86
104__syscall int dac_channel_setup(const struct device *dev,
105 const struct dac_channel_cfg *channel_cfg);
106
107static inline int z_impl_dac_channel_setup(const struct device *dev,
108 const struct dac_channel_cfg *channel_cfg)
109{
110 const struct dac_driver_api *api =
111 (const struct dac_driver_api *)dev->api;
112
113 return api->channel_setup(dev, channel_cfg);
114}
115
126__syscall int dac_write_value(const struct device *dev, uint8_t channel,
127 uint32_t value);
128
129static inline int z_impl_dac_write_value(const struct device *dev,
130 uint8_t channel, uint32_t value)
131{
132 const struct dac_driver_api *api =
133 (const struct dac_driver_api *)dev->api;
134
135 return api->write_value(dev, channel, value);
136}
137
142#ifdef __cplusplus
143}
144#endif
145
146#include <zephyr/syscalls/dac.h>
147
148#endif /* ZEPHYR_INCLUDE_DRIVERS_DAC_H_ */
int dac_write_value(const struct device *dev, uint8_t channel, uint32_t value)
Write a single value to a DAC channel.
int dac_channel_setup(const struct device *dev, const struct dac_channel_cfg *channel_cfg)
Configure a DAC channel.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Structure for specifying the configuration of a DAC channel.
Definition dac.h:40
bool buffered
Enable output buffer for this channel.
Definition dac.h:49
uint8_t channel_id
Channel identifier of the DAC that should be configured.
Definition dac.h:42
uint8_t resolution
Desired resolution of the DAC (depends on device capabilities).
Definition dac.h:44
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