180503b23SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */ 26c536e4cSMichael Hennerich /* 36c536e4cSMichael Hennerich * Driver for the Analog Devices digital potentiometers 46c536e4cSMichael Hennerich * 56c536e4cSMichael Hennerich * Copyright (C) 2010 Michael Hennerich, Analog Devices Inc. 66c536e4cSMichael Hennerich */ 76c536e4cSMichael Hennerich 86c536e4cSMichael Hennerich #ifndef _AD_DPOT_H_ 96c536e4cSMichael Hennerich #define _AD_DPOT_H_ 106c536e4cSMichael Hennerich 116c536e4cSMichael Hennerich #include <linux/types.h> 126c536e4cSMichael Hennerich 136c536e4cSMichael Hennerich #define DPOT_CONF(features, wipers, max_pos, uid) \ 146c536e4cSMichael Hennerich (((features) << 18) | (((wipers) & 0xFF) << 10) | \ 156c536e4cSMichael Hennerich ((max_pos & 0xF) << 6) | (uid & 0x3F)) 166c536e4cSMichael Hennerich 176c536e4cSMichael Hennerich #define DPOT_UID(conf) (conf & 0x3F) 186c536e4cSMichael Hennerich #define DPOT_MAX_POS(conf) ((conf >> 6) & 0xF) 196c536e4cSMichael Hennerich #define DPOT_WIPERS(conf) ((conf >> 10) & 0xFF) 206c536e4cSMichael Hennerich #define DPOT_FEAT(conf) (conf >> 18) 216c536e4cSMichael Hennerich 226c536e4cSMichael Hennerich #define BRDAC0 (1 << 0) 236c536e4cSMichael Hennerich #define BRDAC1 (1 << 1) 246c536e4cSMichael Hennerich #define BRDAC2 (1 << 2) 256c536e4cSMichael Hennerich #define BRDAC3 (1 << 3) 266c536e4cSMichael Hennerich #define BRDAC4 (1 << 4) 276c536e4cSMichael Hennerich #define BRDAC5 (1 << 5) 2859592d0cSMichael Hennerich #define MAX_RDACS 6 296c536e4cSMichael Hennerich 306c536e4cSMichael Hennerich #define F_CMD_INC (1 << 0) /* Features INC/DEC ALL, 6dB */ 316c536e4cSMichael Hennerich #define F_CMD_EEP (1 << 1) /* Features EEPROM */ 32e3ae6847SMichael Hennerich #define F_CMD_OTP (1 << 2) /* Features OTP */ 33e3ae6847SMichael Hennerich #define F_CMD_TOL (1 << 3) /* RDACS feature Tolerance REG */ 34e3ae6847SMichael Hennerich #define F_RDACS_RW (1 << 4) /* RDACS are Read/Write */ 35e3ae6847SMichael Hennerich #define F_RDACS_WONLY (1 << 5) /* RDACS are Write only */ 36e3ae6847SMichael Hennerich #define F_AD_APPDATA (1 << 6) /* RDAC Address append to data */ 37e3ae6847SMichael Hennerich #define F_SPI_8BIT (1 << 7) /* All SPI XFERS are 8-bit */ 38e3ae6847SMichael Hennerich #define F_SPI_16BIT (1 << 8) /* All SPI XFERS are 16-bit */ 39e3ae6847SMichael Hennerich #define F_SPI_24BIT (1 << 9) /* All SPI XFERS are 24-bit */ 406c536e4cSMichael Hennerich 416c536e4cSMichael Hennerich #define F_RDACS_RW_TOL (F_RDACS_RW | F_CMD_EEP | F_CMD_TOL) 426c536e4cSMichael Hennerich #define F_RDACS_RW_EEP (F_RDACS_RW | F_CMD_EEP) 436c536e4cSMichael Hennerich #define F_SPI (F_SPI_8BIT | F_SPI_16BIT | F_SPI_24BIT) 446c536e4cSMichael Hennerich 456c536e4cSMichael Hennerich enum dpot_devid { 466c536e4cSMichael Hennerich AD5258_ID = DPOT_CONF(F_RDACS_RW_TOL, BRDAC0, 6, 0), /* I2C */ 476c536e4cSMichael Hennerich AD5259_ID = DPOT_CONF(F_RDACS_RW_TOL, BRDAC0, 8, 1), 486c536e4cSMichael Hennerich AD5251_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC, 494b068de9Ssteven miao BRDAC1 | BRDAC3, 6, 2), 506c536e4cSMichael Hennerich AD5252_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC, 514b068de9Ssteven miao BRDAC1 | BRDAC3, 8, 3), 526c536e4cSMichael Hennerich AD5253_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC, 536c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 6, 4), 546c536e4cSMichael Hennerich AD5254_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC, 556c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 8, 5), 566c536e4cSMichael Hennerich AD5255_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC, 576c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2, 9, 6), 586c536e4cSMichael Hennerich AD5160_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 596c536e4cSMichael Hennerich BRDAC0, 8, 7), /* SPI */ 606c536e4cSMichael Hennerich AD5161_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 616c536e4cSMichael Hennerich BRDAC0, 8, 8), 626c536e4cSMichael Hennerich AD5162_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 636c536e4cSMichael Hennerich BRDAC0 | BRDAC1, 8, 9), 646c536e4cSMichael Hennerich AD5165_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 656c536e4cSMichael Hennerich BRDAC0, 8, 10), 666c536e4cSMichael Hennerich AD5200_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 676c536e4cSMichael Hennerich BRDAC0, 8, 11), 686c536e4cSMichael Hennerich AD5201_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 696c536e4cSMichael Hennerich BRDAC0, 5, 12), 706c536e4cSMichael Hennerich AD5203_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 716c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 6, 13), 726c536e4cSMichael Hennerich AD5204_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 736c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 8, 14), 746c536e4cSMichael Hennerich AD5206_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 756c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3 | BRDAC4 | BRDAC5, 766c536e4cSMichael Hennerich 8, 15), 776c536e4cSMichael Hennerich AD5207_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 786c536e4cSMichael Hennerich BRDAC0 | BRDAC1, 8, 16), 796c536e4cSMichael Hennerich AD5231_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_24BIT, 806c536e4cSMichael Hennerich BRDAC0, 10, 17), 816c536e4cSMichael Hennerich AD5232_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_16BIT, 826c536e4cSMichael Hennerich BRDAC0 | BRDAC1, 8, 18), 836c536e4cSMichael Hennerich AD5233_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_16BIT, 846c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 6, 19), 856c536e4cSMichael Hennerich AD5235_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_24BIT, 866c536e4cSMichael Hennerich BRDAC0 | BRDAC1, 10, 20), 876c536e4cSMichael Hennerich AD5260_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 886c536e4cSMichael Hennerich BRDAC0, 8, 21), 896c536e4cSMichael Hennerich AD5262_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 906c536e4cSMichael Hennerich BRDAC0 | BRDAC1, 8, 22), 916c536e4cSMichael Hennerich AD5263_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 926c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 8, 23), 936c536e4cSMichael Hennerich AD5290_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 946c536e4cSMichael Hennerich BRDAC0, 8, 24), 95a4bd3949SMichael Hennerich AD5291_ID = DPOT_CONF(F_RDACS_RW | F_SPI_16BIT | F_CMD_OTP, 96a4bd3949SMichael Hennerich BRDAC0, 8, 25), 97a4bd3949SMichael Hennerich AD5292_ID = DPOT_CONF(F_RDACS_RW | F_SPI_16BIT | F_CMD_OTP, 98a4bd3949SMichael Hennerich BRDAC0, 10, 26), 996c536e4cSMichael Hennerich AD5293_ID = DPOT_CONF(F_RDACS_RW | F_SPI_16BIT, BRDAC0, 10, 27), 1006c536e4cSMichael Hennerich AD7376_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT, 1016c536e4cSMichael Hennerich BRDAC0, 7, 28), 1026ac2afb3SMichael Hennerich AD8400_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 1036c536e4cSMichael Hennerich BRDAC0, 8, 29), 1046c536e4cSMichael Hennerich AD8402_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 1056c536e4cSMichael Hennerich BRDAC0 | BRDAC1, 8, 30), 1066c536e4cSMichael Hennerich AD8403_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT, 1076c536e4cSMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2, 8, 31), 1086c536e4cSMichael Hennerich ADN2850_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_24BIT, 1096c536e4cSMichael Hennerich BRDAC0 | BRDAC1, 10, 32), 110e3ae6847SMichael Hennerich AD5241_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 8, 33), 111e3ae6847SMichael Hennerich AD5242_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 34), 112e3ae6847SMichael Hennerich AD5243_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 35), 113e3ae6847SMichael Hennerich AD5245_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 8, 36), 114e3ae6847SMichael Hennerich AD5246_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 7, 37), 115e3ae6847SMichael Hennerich AD5247_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 7, 38), 116e3ae6847SMichael Hennerich AD5248_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 39), 117c74cba61SMichael Hennerich AD5280_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 8, 40), 118c74cba61SMichael Hennerich AD5282_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 41), 119c74cba61SMichael Hennerich ADN2860_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC, 120c74cba61SMichael Hennerich BRDAC0 | BRDAC1 | BRDAC2, 9, 42), 12159592d0cSMichael Hennerich AD5273_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 6, 43), 12259592d0cSMichael Hennerich AD5171_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 6, 44), 12359592d0cSMichael Hennerich AD5170_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 8, 45), 12459592d0cSMichael Hennerich AD5172_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0 | BRDAC1, 8, 46), 12559592d0cSMichael Hennerich AD5173_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0 | BRDAC1, 8, 47), 126a4bd3949SMichael Hennerich AD5270_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP | F_SPI_16BIT, 127a4bd3949SMichael Hennerich BRDAC0, 10, 48), 128a4bd3949SMichael Hennerich AD5271_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP | F_SPI_16BIT, 129a4bd3949SMichael Hennerich BRDAC0, 8, 49), 130a4bd3949SMichael Hennerich AD5272_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 10, 50), 131a4bd3949SMichael Hennerich AD5274_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 8, 51), 1326c536e4cSMichael Hennerich }; 1336c536e4cSMichael Hennerich 1346c536e4cSMichael Hennerich #define DPOT_RDAC0 0 1356c536e4cSMichael Hennerich #define DPOT_RDAC1 1 1366c536e4cSMichael Hennerich #define DPOT_RDAC2 2 1376c536e4cSMichael Hennerich #define DPOT_RDAC3 3 1386c536e4cSMichael Hennerich #define DPOT_RDAC4 4 1396c536e4cSMichael Hennerich #define DPOT_RDAC5 5 1406c536e4cSMichael Hennerich 1416c536e4cSMichael Hennerich #define DPOT_RDAC_MASK 0x1F 1426c536e4cSMichael Hennerich 1436c536e4cSMichael Hennerich #define DPOT_REG_TOL 0x18 1446c536e4cSMichael Hennerich #define DPOT_TOL_RDAC0 (DPOT_REG_TOL | DPOT_RDAC0) 1456c536e4cSMichael Hennerich #define DPOT_TOL_RDAC1 (DPOT_REG_TOL | DPOT_RDAC1) 1466c536e4cSMichael Hennerich #define DPOT_TOL_RDAC2 (DPOT_REG_TOL | DPOT_RDAC2) 1476c536e4cSMichael Hennerich #define DPOT_TOL_RDAC3 (DPOT_REG_TOL | DPOT_RDAC3) 1486c536e4cSMichael Hennerich #define DPOT_TOL_RDAC4 (DPOT_REG_TOL | DPOT_RDAC4) 1496c536e4cSMichael Hennerich #define DPOT_TOL_RDAC5 (DPOT_REG_TOL | DPOT_RDAC5) 1506c536e4cSMichael Hennerich 1516c536e4cSMichael Hennerich /* RDAC-to-EEPROM Interface Commands */ 15259592d0cSMichael Hennerich #define DPOT_ADDR_RDAC (0x0 << 5) 15359592d0cSMichael Hennerich #define DPOT_ADDR_EEPROM (0x1 << 5) 15459592d0cSMichael Hennerich #define DPOT_ADDR_OTP (0x1 << 6) 15559592d0cSMichael Hennerich #define DPOT_ADDR_CMD (0x1 << 7) 15659592d0cSMichael Hennerich #define DPOT_ADDR_OTP_EN (0x1 << 9) 1576c536e4cSMichael Hennerich 1586c536e4cSMichael Hennerich #define DPOT_DEC_ALL_6DB (DPOT_ADDR_CMD | (0x4 << 3)) 1596c536e4cSMichael Hennerich #define DPOT_INC_ALL_6DB (DPOT_ADDR_CMD | (0x9 << 3)) 1606c536e4cSMichael Hennerich #define DPOT_DEC_ALL (DPOT_ADDR_CMD | (0x6 << 3)) 1616c536e4cSMichael Hennerich #define DPOT_INC_ALL (DPOT_ADDR_CMD | (0xB << 3)) 1626c536e4cSMichael Hennerich 1636c536e4cSMichael Hennerich #define DPOT_SPI_RDAC 0xB0 1646c536e4cSMichael Hennerich #define DPOT_SPI_EEPROM 0x30 1656c536e4cSMichael Hennerich #define DPOT_SPI_READ_RDAC 0xA0 1666c536e4cSMichael Hennerich #define DPOT_SPI_READ_EEPROM 0x90 1676c536e4cSMichael Hennerich #define DPOT_SPI_DEC_ALL_6DB 0x50 1686c536e4cSMichael Hennerich #define DPOT_SPI_INC_ALL_6DB 0xD0 1696c536e4cSMichael Hennerich #define DPOT_SPI_DEC_ALL 0x70 1706c536e4cSMichael Hennerich #define DPOT_SPI_INC_ALL 0xF0 1716c536e4cSMichael Hennerich 1726c536e4cSMichael Hennerich /* AD5291/2/3 use special commands */ 1736c536e4cSMichael Hennerich #define DPOT_AD5291_RDAC 0x01 1746c536e4cSMichael Hennerich #define DPOT_AD5291_READ_RDAC 0x02 175a4bd3949SMichael Hennerich #define DPOT_AD5291_STORE_XTPM 0x03 176a4bd3949SMichael Hennerich #define DPOT_AD5291_CTRLREG 0x06 177a4bd3949SMichael Hennerich #define DPOT_AD5291_UNLOCK_CMD 0x03 1786c536e4cSMichael Hennerich 179a4bd3949SMichael Hennerich /* AD5270/1/2/4 use special commands */ 180a4bd3949SMichael Hennerich #define DPOT_AD5270_1_2_4_RDAC 0x01 181a4bd3949SMichael Hennerich #define DPOT_AD5270_1_2_4_READ_RDAC 0x02 182a4bd3949SMichael Hennerich #define DPOT_AD5270_1_2_4_STORE_XTPM 0x03 183a4bd3949SMichael Hennerich #define DPOT_AD5270_1_2_4_CTRLREG 0x07 184a4bd3949SMichael Hennerich #define DPOT_AD5270_1_2_4_UNLOCK_CMD 0x03 185e3ae6847SMichael Hennerich 1865f400cf4SMichael Hennerich #define DPOT_AD5282_RDAC_AB 0x80 187a4bd3949SMichael Hennerich 18859592d0cSMichael Hennerich #define DPOT_AD5273_FUSE 0x80 1895f400cf4SMichael Hennerich #define DPOT_AD5170_2_3_FUSE 0x20 1905f400cf4SMichael Hennerich #define DPOT_AD5170_2_3_OW 0x08 1915f400cf4SMichael Hennerich #define DPOT_AD5172_3_A0 0x08 1925f400cf4SMichael Hennerich #define DPOT_AD5170_2FUSE 0x80 19359592d0cSMichael Hennerich 1946c536e4cSMichael Hennerich struct dpot_data; 1956c536e4cSMichael Hennerich 1966c536e4cSMichael Hennerich struct ad_dpot_bus_ops { 1976c536e4cSMichael Hennerich int (*read_d8)(void *client); 1986c536e4cSMichael Hennerich int (*read_r8d8)(void *client, u8 reg); 1996c536e4cSMichael Hennerich int (*read_r8d16)(void *client, u8 reg); 2006c536e4cSMichael Hennerich int (*write_d8)(void *client, u8 val); 2016c536e4cSMichael Hennerich int (*write_r8d8)(void *client, u8 reg, u8 val); 2026c536e4cSMichael Hennerich int (*write_r8d16)(void *client, u8 reg, u16 val); 2036c536e4cSMichael Hennerich }; 2046c536e4cSMichael Hennerich 2056c536e4cSMichael Hennerich struct ad_dpot_bus_data { 2066c536e4cSMichael Hennerich void *client; 2076c536e4cSMichael Hennerich const struct ad_dpot_bus_ops *bops; 2086c536e4cSMichael Hennerich }; 2096c536e4cSMichael Hennerich 2107f3379deSMichael Hennerich int ad_dpot_probe(struct device *dev, struct ad_dpot_bus_data *bdata, 2117f3379deSMichael Hennerich unsigned long devid, const char *name); 212*85385a51SUwe Kleine-König void ad_dpot_remove(struct device *dev); 2136c536e4cSMichael Hennerich 2146c536e4cSMichael Hennerich #endif 215