Zephyr API Documentation 4.0.0-rc2
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
34#define DAC_CHANNEL_BROADCAST 0xFF
35
48 bool buffered: 1;
53 bool internal: 1;
54};
55
62/*
63 * Type definition of DAC API function for configuring a channel.
64 * See dac_channel_setup() for argument descriptions.
65 */
66typedef int (*dac_api_channel_setup)(const struct device *dev,
67 const struct dac_channel_cfg *channel_cfg);
68
69/*
70 * Type definition of DAC API function for setting a write request.
71 * See dac_write_value() for argument descriptions.
72 */
73typedef int (*dac_api_write_value)(const struct device *dev,
74 uint8_t channel, uint32_t value);
75
76/*
77 * DAC driver API
78 *
79 * This is the mandatory API any DAC driver needs to expose.
80 */
81__subsystem struct dac_driver_api {
82 dac_api_channel_setup channel_setup;
83 dac_api_write_value write_value;
84};
85
103__syscall int dac_channel_setup(const struct device *dev,
104 const struct dac_channel_cfg *channel_cfg);
105
106static inline int z_impl_dac_channel_setup(const struct device *dev,
107 const struct dac_channel_cfg *channel_cfg)
108{
109 const struct dac_driver_api *api =
110 (const struct dac_driver_api *)dev->api;
111
112 return api->channel_setup(dev, channel_cfg);
113}
114
125__syscall int dac_write_value(const struct device *dev, uint8_t channel,
126 uint32_t value);
127
128static inline int z_impl_dac_write_value(const struct device *dev,
129 uint8_t channel, uint32_t value)
130{
131 const struct dac_driver_api *api =
132 (const struct dac_driver_api *)dev->api;
133
134 return api->write_value(dev, channel, value);
135}
136
141#ifdef __cplusplus
142}
143#endif
144
145#include <zephyr/syscalls/dac.h>
146
147#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:39
bool buffered
Enable output buffer for this channel.
Definition dac.h:48
uint8_t channel_id
Channel identifier of the DAC that should be configured.
Definition dac.h:41
uint8_t resolution
Desired resolution of the DAC (depends on device capabilities).
Definition dac.h:43
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:418