LXR linux/drivers/misc/ad525x

   1/* SPDX-License-Identifier: GPL-2.0-or-later */
   2/*
   3 * Driver for the Analog Devices digital potentiometers
   4 *
   5 * Copyright (C) 2010 Michael Hennerich, Analog Devices Inc.
   6 */
   7
   8#ifndef _AD_DPOT_H_
   9#define _AD_DPOT_H_
  10
  11#include <linux/types.h>
  12
  13#define DPOT_CONF(features, wipers, max_pos, uid) \
  14                (((features) << 18) | (((wipers) & 0xFF) << 10) | \
  15                ((max_pos & 0xF) << 6) | (uid & 0x3F))
  16
  17#define DPOT_UID(conf)          (conf & 0x3F)
  18#define DPOT_MAX_POS(conf)      ((conf >> 6) & 0xF)
  19#define DPOT_WIPERS(conf)       ((conf >> 10) & 0xFF)
  20#define DPOT_FEAT(conf)         (conf >> 18)
  21
  22#define BRDAC0                  (1 << 0)
  23#define BRDAC1                  (1 << 1)
  24#define BRDAC2                  (1 << 2)
  25#define BRDAC3                  (1 << 3)
  26#define BRDAC4                  (1 << 4)
  27#define BRDAC5                  (1 << 5)
  28#define MAX_RDACS               6
  29
  30#define F_CMD_INC               (1 << 0)        /* Features INC/DEC ALL, 6dB */
  31#define F_CMD_EEP               (1 << 1)        /* Features EEPROM */
  32#define F_CMD_OTP               (1 << 2)        /* Features OTP */
  33#define F_CMD_TOL               (1 << 3)        /* RDACS feature Tolerance REG */
  34#define F_RDACS_RW              (1 << 4)        /* RDACS are Read/Write  */
  35#define F_RDACS_WONLY           (1 << 5)        /* RDACS are Write only */
  36#define F_AD_APPDATA            (1 << 6)        /* RDAC Address append to data */
  37#define F_SPI_8BIT              (1 << 7)        /* All SPI XFERS are 8-bit */
  38#define F_SPI_16BIT             (1 << 8)        /* All SPI XFERS are 16-bit */
  39#define F_SPI_24BIT             (1 << 9)        /* All SPI XFERS are 24-bit */
  40
  41#define F_RDACS_RW_TOL  (F_RDACS_RW | F_CMD_EEP | F_CMD_TOL)
  42#define F_RDACS_RW_EEP  (F_RDACS_RW | F_CMD_EEP)
  43#define F_SPI           (F_SPI_8BIT | F_SPI_16BIT | F_SPI_24BIT)
  44
  45enum dpot_devid {
  46        AD5258_ID = DPOT_CONF(F_RDACS_RW_TOL, BRDAC0, 6, 0), /* I2C */
  47        AD5259_ID = DPOT_CONF(F_RDACS_RW_TOL, BRDAC0, 8, 1),
  48        AD5251_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC,
  49                        BRDAC1 | BRDAC3, 6, 2),
  50        AD5252_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC,
  51                        BRDAC1 | BRDAC3, 8, 3),
  52        AD5253_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC,
  53                        BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 6, 4),
  54        AD5254_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC,
  55                        BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 8, 5),
  56        AD5255_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC,
  57                        BRDAC0 | BRDAC1 | BRDAC2, 9, 6),
  58        AD5160_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  59                        BRDAC0, 8, 7), /* SPI */
  60        AD5161_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  61                        BRDAC0, 8, 8),
  62        AD5162_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
  63                        BRDAC0 | BRDAC1, 8, 9),
  64        AD5165_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  65                        BRDAC0, 8, 10),
  66        AD5200_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  67                        BRDAC0, 8, 11),
  68        AD5201_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  69                        BRDAC0, 5, 12),
  70        AD5203_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  71                        BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 6, 13),
  72        AD5204_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
  73                        BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 8, 14),
  74        AD5206_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
  75                        BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3 | BRDAC4 | BRDAC5,
  76                        8, 15),
  77        AD5207_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
  78                        BRDAC0 | BRDAC1, 8, 16),
  79        AD5231_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_24BIT,
  80                        BRDAC0, 10, 17),
  81        AD5232_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_16BIT,
  82                        BRDAC0 | BRDAC1, 8, 18),
  83        AD5233_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_16BIT,
  84                        BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 6, 19),
  85        AD5235_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_24BIT,
  86                        BRDAC0 | BRDAC1, 10, 20),
  87        AD5260_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  88                        BRDAC0, 8, 21),
  89        AD5262_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
  90                        BRDAC0 | BRDAC1, 8, 22),
  91        AD5263_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
  92                        BRDAC0 | BRDAC1 | BRDAC2 | BRDAC3, 8, 23),
  93        AD5290_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
  94                        BRDAC0, 8, 24),
  95        AD5291_ID = DPOT_CONF(F_RDACS_RW | F_SPI_16BIT | F_CMD_OTP,
  96                        BRDAC0, 8, 25),
  97        AD5292_ID = DPOT_CONF(F_RDACS_RW | F_SPI_16BIT | F_CMD_OTP,
  98                        BRDAC0, 10, 26),
  99        AD5293_ID = DPOT_CONF(F_RDACS_RW | F_SPI_16BIT, BRDAC0, 10, 27),
 100        AD7376_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_8BIT,
 101                        BRDAC0, 7, 28),
 102        AD8400_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
 103                        BRDAC0, 8, 29),
 104        AD8402_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
 105                        BRDAC0 | BRDAC1, 8, 30),
 106        AD8403_ID = DPOT_CONF(F_RDACS_WONLY | F_AD_APPDATA | F_SPI_16BIT,
 107                        BRDAC0 | BRDAC1 | BRDAC2, 8, 31),
 108        ADN2850_ID = DPOT_CONF(F_RDACS_RW_EEP | F_CMD_INC | F_SPI_24BIT,
 109                        BRDAC0 | BRDAC1, 10, 32),
 110        AD5241_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 8, 33),
 111        AD5242_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 34),
 112        AD5243_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 35),
 113        AD5245_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 8, 36),
 114        AD5246_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 7, 37),
 115        AD5247_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 7, 38),
 116        AD5248_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 39),
 117        AD5280_ID = DPOT_CONF(F_RDACS_RW, BRDAC0, 8, 40),
 118        AD5282_ID = DPOT_CONF(F_RDACS_RW, BRDAC0 | BRDAC1, 8, 41),
 119        ADN2860_ID = DPOT_CONF(F_RDACS_RW_TOL | F_CMD_INC,
 120                        BRDAC0 | BRDAC1 | BRDAC2, 9, 42),
 121        AD5273_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 6, 43),
 122        AD5171_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 6, 44),
 123        AD5170_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 8, 45),
 124        AD5172_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0 | BRDAC1, 8, 46),
 125        AD5173_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0 | BRDAC1, 8, 47),
 126        AD5270_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP | F_SPI_16BIT,
 127                        BRDAC0, 10, 48),
 128        AD5271_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP | F_SPI_16BIT,
 129                        BRDAC0, 8, 49),
 130        AD5272_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 10, 50),
 131        AD5274_ID = DPOT_CONF(F_RDACS_RW | F_CMD_OTP, BRDAC0, 8, 51),
 132};
 133
 134#define DPOT_RDAC0              0
 135#define DPOT_RDAC1              1
 136#define DPOT_RDAC2              2
 137#define DPOT_RDAC3              3
 138#define DPOT_RDAC4              4
 139#define DPOT_RDAC5              5
 140
 141#define DPOT_RDAC_MASK          0x1F
 142
 143#define DPOT_REG_TOL            0x18
 144#define DPOT_TOL_RDAC0          (DPOT_REG_TOL | DPOT_RDAC0)
 145#define DPOT_TOL_RDAC1          (DPOT_REG_TOL | DPOT_RDAC1)
 146#define DPOT_TOL_RDAC2          (DPOT_REG_TOL | DPOT_RDAC2)
 147#define DPOT_TOL_RDAC3          (DPOT_REG_TOL | DPOT_RDAC3)
 148#define DPOT_TOL_RDAC4          (DPOT_REG_TOL | DPOT_RDAC4)
 149#define DPOT_TOL_RDAC5          (DPOT_REG_TOL | DPOT_RDAC5)
 150
 151/* RDAC-to-EEPROM Interface Commands */
 152#define DPOT_ADDR_RDAC          (0x0 << 5)
 153#define DPOT_ADDR_EEPROM        (0x1 << 5)
 154#define DPOT_ADDR_OTP           (0x1 << 6)
 155#define DPOT_ADDR_CMD           (0x1 << 7)
 156#define DPOT_ADDR_OTP_EN        (0x1 << 9)
 157
 158#define DPOT_DEC_ALL_6DB        (DPOT_ADDR_CMD | (0x4 << 3))
 159#define DPOT_INC_ALL_6DB        (DPOT_ADDR_CMD | (0x9 << 3))
 160#define DPOT_DEC_ALL            (DPOT_ADDR_CMD | (0x6 << 3))
 161#define DPOT_INC_ALL            (DPOT_ADDR_CMD | (0xB << 3))
 162
 163#define DPOT_SPI_RDAC           0xB0
 164#define DPOT_SPI_EEPROM         0x30
 165#define DPOT_SPI_READ_RDAC      0xA0
 166#define DPOT_SPI_READ_EEPROM    0x90
 167#define DPOT_SPI_DEC_ALL_6DB    0x50
 168#define DPOT_SPI_INC_ALL_6DB    0xD0
 169#define DPOT_SPI_DEC_ALL        0x70
 170#define DPOT_SPI_INC_ALL        0xF0
 171
 172/* AD5291/2/3 use special commands */
 173#define DPOT_AD5291_RDAC        0x01
 174#define DPOT_AD5291_READ_RDAC   0x02
 175#define DPOT_AD5291_STORE_XTPM  0x03
 176#define DPOT_AD5291_CTRLREG     0x06
 177#define DPOT_AD5291_UNLOCK_CMD  0x03
 178
 179/* AD5270/1/2/4 use special commands */
 180#define DPOT_AD5270_1_2_4_RDAC          0x01
 181#define DPOT_AD5270_1_2_4_READ_RDAC     0x02
 182#define DPOT_AD5270_1_2_4_STORE_XTPM    0x03
 183#define DPOT_AD5270_1_2_4_CTRLREG       0x07
 184#define DPOT_AD5270_1_2_4_UNLOCK_CMD    0x03
 185
 186#define DPOT_AD5282_RDAC_AB     0x80
 187
 188#define DPOT_AD5273_FUSE        0x80
 189#define DPOT_AD5170_2_3_FUSE    0x20
 190#define DPOT_AD5170_2_3_OW      0x08
 191#define DPOT_AD5172_3_A0        0x08
 192#define DPOT_AD5170_2FUSE       0x80
 193
 194struct dpot_data;
 195
 196struct ad_dpot_bus_ops {
 197        int (*read_d8)(void *client);
 198        int (*read_r8d8)(void *client, u8 reg);
 199        int (*read_r8d16)(void *client, u8 reg);
 200        int (*write_d8)(void *client, u8 val);
 201        int (*write_r8d8)(void *client, u8 reg, u8 val);
 202        int (*write_r8d16)(void *client, u8 reg, u16 val);
 203};
 204
 205struct ad_dpot_bus_data {
 206        void *client;
 207        const struct ad_dpot_bus_ops *bops;
 208};
 209
 210int ad_dpot_probe(struct device *dev, struct ad_dpot_bus_data *bdata,
 211                  unsigned long devid, const char *name);
 212int ad_dpot_remove(struct device *dev);
 213
 214#endif
 215