79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
147 lines
3.6 KiB
C
147 lines
3.6 KiB
C
/*
|
|
* Copyright (c) 2021 Laird Connectivity
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#define DT_DRV_COMPAT microchip_mcp4725
|
|
|
|
#include <zephyr/kernel.h>
|
|
#include <zephyr/drivers/i2c.h>
|
|
#include <zephyr/drivers/dac.h>
|
|
#include <zephyr/logging/log.h>
|
|
|
|
LOG_MODULE_REGISTER(dac_mcp4725, CONFIG_DAC_LOG_LEVEL);
|
|
|
|
/* Information in this file comes from MCP4725 datasheet revision D
|
|
* found at https://ww1.microchip.com/downloads/en/DeviceDoc/22039d.pdf
|
|
*/
|
|
|
|
/* Defines for field values in MCP4725 DAC register */
|
|
#define MCP4725_DAC_MAX_VAL 0xFFF
|
|
|
|
#define MCP4725_FAST_MODE_POWER_DOWN_POS 4U
|
|
#define MCP4725_FAST_MODE_DAC_UPPER_VAL_POS 8U
|
|
#define MCP4725_FAST_MODE_DAC_UPPER_VAL_MASK 0xF
|
|
#define MCP4725_FAST_MODE_DAC_LOWER_VAL_MASK 0xFF
|
|
|
|
#define MCP4725_READ_RDY_POS 7U
|
|
#define MCP4725_READ_RDY_MASK (0x1 << MCP4725_READ_RDY_POS)
|
|
|
|
/* After writing eeprom, the MCP4725 can be in a busy state for 25 - 50ms
|
|
* See section 1.0 of MCP4725 datasheet, 'Electrical Characteristics'
|
|
*/
|
|
#define MCP4725_BUSY_TIMEOUT_MS 60U
|
|
|
|
struct mcp4725_config {
|
|
struct i2c_dt_spec i2c;
|
|
};
|
|
|
|
/* Read mcp4725 and check RDY status bit */
|
|
static int mcp4725_wait_until_ready(const struct device *dev)
|
|
{
|
|
const struct mcp4725_config *config = dev->config;
|
|
uint8_t rx_data[5];
|
|
bool mcp4725_ready = false;
|
|
int ret;
|
|
int32_t timeout = k_uptime_get_32() + MCP4725_BUSY_TIMEOUT_MS;
|
|
|
|
/* Wait until RDY bit is set or return error if timer exceeds MCP4725_BUSY_TIMEOUT_MS */
|
|
while (!mcp4725_ready) {
|
|
ret = i2c_read_dt(&config->i2c, rx_data, sizeof(rx_data));
|
|
|
|
if (ret == 0) {
|
|
mcp4725_ready = rx_data[0] & MCP4725_READ_RDY_MASK;
|
|
} else {
|
|
/* I2C error */
|
|
return ret;
|
|
}
|
|
|
|
if (k_uptime_get_32() > timeout) {
|
|
return -ETIMEDOUT;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
/* MCP4725 is a single channel 12 bit DAC */
|
|
static int mcp4725_channel_setup(const struct device *dev,
|
|
const struct dac_channel_cfg *channel_cfg)
|
|
{
|
|
if (channel_cfg->channel_id != 0) {
|
|
return -EINVAL;
|
|
}
|
|
|
|
if (channel_cfg->resolution != 12) {
|
|
return -ENOTSUP;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int mcp4725_write_value(const struct device *dev, uint8_t channel,
|
|
uint32_t value)
|
|
{
|
|
const struct mcp4725_config *config = dev->config;
|
|
uint8_t tx_data[2];
|
|
int ret;
|
|
|
|
if (channel != 0) {
|
|
return -EINVAL;
|
|
}
|
|
|
|
/* Check value isn't over 12 bits */
|
|
if (value > MCP4725_DAC_MAX_VAL) {
|
|
return -ENOTSUP;
|
|
}
|
|
|
|
/* WRITE_MODE_FAST message format (2 bytes):
|
|
*
|
|
* || 15 14 | 13 12 | 11 10 9 8 || 7 6 5 4 3 2 1 0 ||
|
|
* || Fast mode (0) | Power-down bits (0) | DAC value[11:8] || DAC value[7:0] ||
|
|
*/
|
|
tx_data[0] = ((value >> MCP4725_FAST_MODE_DAC_UPPER_VAL_POS) &
|
|
MCP4725_FAST_MODE_DAC_UPPER_VAL_MASK);
|
|
tx_data[1] = (value & MCP4725_FAST_MODE_DAC_LOWER_VAL_MASK);
|
|
ret = i2c_write_dt(&config->i2c, tx_data, sizeof(tx_data));
|
|
|
|
return ret;
|
|
}
|
|
|
|
static int dac_mcp4725_init(const struct device *dev)
|
|
{
|
|
const struct mcp4725_config *config = dev->config;
|
|
|
|
if (!device_is_ready(config->i2c.bus)) {
|
|
LOG_ERR("I2C device not found");
|
|
return -EINVAL;
|
|
}
|
|
|
|
/* Check we can read a 'RDY' bit from this device */
|
|
if (mcp4725_wait_until_ready(dev)) {
|
|
return -EBUSY;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static const struct dac_driver_api mcp4725_driver_api = {
|
|
.channel_setup = mcp4725_channel_setup,
|
|
.write_value = mcp4725_write_value,
|
|
};
|
|
|
|
|
|
#define INST_DT_MCP4725(index) \
|
|
static const struct mcp4725_config mcp4725_config_##index = { \
|
|
.i2c = I2C_DT_SPEC_INST_GET(index), \
|
|
}; \
|
|
\
|
|
DEVICE_DT_INST_DEFINE(index, dac_mcp4725_init, \
|
|
NULL, \
|
|
NULL, \
|
|
&mcp4725_config_##index, POST_KERNEL, \
|
|
CONFIG_DAC_MCP4725_INIT_PRIORITY, \
|
|
&mcp4725_driver_api);
|
|
|
|
DT_INST_FOREACH_STATUS_OKAY(INST_DT_MCP4725);
|