1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * This file is part of AD5686 DAC driver 4 * 5 * Copyright 2018 Analog Devices Inc. 6 */ 7 8 #ifndef __DRIVERS_IIO_DAC_AD5686_H__ 9 #define __DRIVERS_IIO_DAC_AD5686_H__ 10 11 #include <linux/types.h> 12 #include <linux/cache.h> 13 #include <linux/mutex.h> 14 #include <linux/kernel.h> 15 16 #include <linux/iio/iio.h> 17 18 #define AD5310_CMD(x) ((x) << 12) 19 20 #define AD5683_DATA(x) ((x) << 4) 21 22 #define AD5686_ADDR(x) ((x) << 16) 23 #define AD5686_CMD(x) ((x) << 20) 24 25 #define AD5686_ADDR_DAC(chan) (0x1 << (chan)) 26 #define AD5686_ADDR_ALL_DAC 0xF 27 28 #define AD5686_CMD_NOOP 0x0 29 #define AD5686_CMD_WRITE_INPUT_N 0x1 30 #define AD5686_CMD_UPDATE_DAC_N 0x2 31 #define AD5686_CMD_WRITE_INPUT_N_UPDATE_N 0x3 32 #define AD5686_CMD_POWERDOWN_DAC 0x4 33 #define AD5686_CMD_LDAC_MASK 0x5 34 #define AD5686_CMD_RESET 0x6 35 #define AD5686_CMD_INTERNAL_REFER_SETUP 0x7 36 #define AD5686_CMD_DAISY_CHAIN_ENABLE 0x8 37 #define AD5686_CMD_READBACK_ENABLE 0x9 38 39 #define AD5686_LDAC_PWRDN_NONE 0x0 40 #define AD5686_LDAC_PWRDN_1K 0x1 41 #define AD5686_LDAC_PWRDN_100K 0x2 42 #define AD5686_LDAC_PWRDN_3STATE 0x3 43 44 #define AD5686_CMD_CONTROL_REG 0x4 45 #define AD5686_CMD_READBACK_ENABLE_V2 0x5 46 47 #define AD5310_REF_BIT_MSK BIT(8) 48 #define AD5683_REF_BIT_MSK BIT(12) 49 #define AD5686_REF_BIT_MSK BIT(0) 50 #define AD5693_REF_BIT_MSK BIT(12) 51 52 /** 53 * ad5686_supported_device_ids: 54 */ 55 enum ad5686_supported_device_ids { 56 ID_AD5310R, 57 ID_AD5311R, 58 ID_AD5337R, 59 ID_AD5338R, 60 ID_AD5671R, 61 ID_AD5672R, 62 ID_AD5673R, 63 ID_AD5674R, 64 ID_AD5675R, 65 ID_AD5676, 66 ID_AD5676R, 67 ID_AD5677R, 68 ID_AD5679R, 69 ID_AD5681R, 70 ID_AD5682R, 71 ID_AD5683, 72 ID_AD5683R, 73 ID_AD5684, 74 ID_AD5684R, 75 ID_AD5685R, 76 ID_AD5686, 77 ID_AD5686R, 78 ID_AD5691R, 79 ID_AD5692R, 80 ID_AD5693, 81 ID_AD5693R, 82 ID_AD5694, 83 ID_AD5694R, 84 ID_AD5695R, 85 ID_AD5696, 86 ID_AD5696R, 87 }; 88 89 enum ad5686_regmap_type { 90 AD5310_REGMAP, 91 AD5683_REGMAP, 92 AD5686_REGMAP, 93 AD5693_REGMAP 94 }; 95 96 struct ad5686_state; 97 98 typedef int (*ad5686_write_func)(struct ad5686_state *st, 99 u8 cmd, u8 addr, u16 val); 100 101 typedef int (*ad5686_read_func)(struct ad5686_state *st, u8 addr); 102 103 /** 104 * struct ad5686_chip_info - chip specific information 105 * @int_vref_mv: AD5620/40/60: the internal reference voltage 106 * @num_channels: number of channels 107 * @channel: channel specification 108 * @regmap_type: register map layout variant 109 */ 110 111 struct ad5686_chip_info { 112 u16 int_vref_mv; 113 unsigned int num_channels; 114 const struct iio_chan_spec *channels; 115 enum ad5686_regmap_type regmap_type; 116 }; 117 118 /** 119 * struct ad5686_state - driver instance specific data 120 * @spi: spi_device 121 * @chip_info: chip model specific constants, available modes etc 122 * @vref_mv: actual reference voltage used 123 * @pwr_down_mask: power down mask 124 * @pwr_down_mode: current power down mode 125 * @use_internal_vref: set to true if the internal reference voltage is used 126 * @lock lock to protect the data buffer during regmap ops 127 * @data: spi transfer buffers 128 */ 129 130 struct ad5686_state { 131 struct device *dev; 132 const struct ad5686_chip_info *chip_info; 133 unsigned short vref_mv; 134 unsigned int pwr_down_mask; 135 unsigned int pwr_down_mode; 136 ad5686_write_func write; 137 ad5686_read_func read; 138 bool use_internal_vref; 139 struct mutex lock; 140 141 /* 142 * DMA (thus cache coherency maintenance) may require the 143 * transfer buffers to live in their own cache lines. 144 */ 145 146 union { 147 __be32 d32; 148 __be16 d16; 149 u8 d8[4]; 150 } data[3] __aligned(IIO_DMA_MINALIGN); 151 }; 152 153 154 int ad5686_probe(struct device *dev, 155 enum ad5686_supported_device_ids chip_type, 156 const char *name, ad5686_write_func write, 157 ad5686_read_func read); 158 159 160 #endif /* __DRIVERS_IIO_DAC_AD5686_H__ */ 161