Zephyr API Documentation  3.6.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
12#ifndef ZEPHYR_INCLUDE_DRIVERS_DAC_H_
13#define ZEPHYR_INCLUDE_DRIVERS_DAC_H_
14
15#include <zephyr/device.h>
16
17#ifdef __cplusplus
18extern "C" {
19#endif
20
43};
44
51/*
52 * Type definition of DAC API function for configuring a channel.
53 * See dac_channel_setup() for argument descriptions.
54 */
55typedef int (*dac_api_channel_setup)(const struct device *dev,
56 const struct dac_channel_cfg *channel_cfg);
57
58/*
59 * Type definition of DAC API function for setting a write request.
60 * See dac_write_value() for argument descriptions.
61 */
62typedef int (*dac_api_write_value)(const struct device *dev,
63 uint8_t channel, uint32_t value);
64
65/*
66 * DAC driver API
67 *
68 * This is the mandatory API any DAC driver needs to expose.
69 */
70__subsystem struct dac_driver_api {
71 dac_api_channel_setup channel_setup;
72 dac_api_write_value write_value;
73};
74
92__syscall int dac_channel_setup(const struct device *dev,
93 const struct dac_channel_cfg *channel_cfg);
94
95static inline int z_impl_dac_channel_setup(const struct device *dev,
96 const struct dac_channel_cfg *channel_cfg)
97{
98 const struct dac_driver_api *api =
99 (const struct dac_driver_api *)dev->api;
100
101 return api->channel_setup(dev, channel_cfg);
102}
103
114__syscall int dac_write_value(const struct device *dev, uint8_t channel,
115 uint32_t value);
116
117static inline int z_impl_dac_write_value(const struct device *dev,
118 uint8_t channel, uint32_t value)
119{
120 const struct dac_driver_api *api =
121 (const struct dac_driver_api *)dev->api;
122
123 return api->write_value(dev, channel, value);
124}
125
130#ifdef __cplusplus
131}
132#endif
133
134#include <syscalls/dac.h>
135
136#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:33
bool buffered
Enable output buffer for this channel.
Definition: dac.h:42
uint8_t channel_id
Channel identifier of the DAC that should be configured.
Definition: dac.h:35
uint8_t resolution
Desired resolution of the DAC (depends on device capabilities).
Definition: dac.h:37
Runtime device structure (in ROM) per driver instance.
Definition: device.h:399
const void * api
Address of the API structure exposed by the device instance.
Definition: device.h:405