include/linux/mfd/abx500.h

   1 /*
   2  * Copyright (C) 2007-2009 ST-Ericsson AB
   3  * License terms: GNU General Public License (GPL) version 2
   4  * AB3100 core access functions
   5  * Author: Linus Walleij <linus.walleij@stericsson.com>
   6  *
   7  * ABX500 core access functions.
   8  * The abx500 interface is used for the Analog Baseband chip
   9  * ab3100, ab3550, ab5500 and possibly comming. It is not used for
  10  * ab4500 and ab8500 since they are another family of chip.
  11  *
  12  * Author: Mattias Wallin <mattias.wallin@stericsson.com>
  13  * Author: Mattias Nilsson <mattias.i.nilsson@stericsson.com>
  14  * Author: Bengt Jonsson <bengt.g.jonsson@stericsson.com>
  15  * Author: Rickard Andersson <rickard.andersson@stericsson.com>
  16  */
  17
  18 #include <linux/device.h>
  19 #include <linux/regulator/machine.h>
  20
  21 #ifndef MFD_ABX500_H
  22 #define MFD_ABX500_H
  23
  24 #define AB3100_P1A      0xc0
  25 #define AB3100_P1B      0xc1
  26 #define AB3100_P1C      0xc2
  27 #define AB3100_P1D      0xc3
  28 #define AB3100_P1E      0xc4
  29 #define AB3100_P1F      0xc5
  30 #define AB3100_P1G      0xc6
  31 #define AB3100_R2A      0xc7
  32 #define AB3100_R2B      0xc8
  33 #define AB3550_P1A      0x10
  34 #define AB5500_1_0      0x20
  35 #define AB5500_2_0      0x21
  36 #define AB5500_2_1      0x22
  37
  38 /*
  39  * AB3100, EVENTA1, A2 and A3 event register flags
  40  * these are catenated into a single 32-bit flag in the code
  41  * for event notification broadcasts.
  42  */
  43 #define AB3100_EVENTA1_ONSWA                            (0x01<<16)
  44 #define AB3100_EVENTA1_ONSWB                            (0x02<<16)
  45 #define AB3100_EVENTA1_ONSWC                            (0x04<<16)
  46 #define AB3100_EVENTA1_DCIO                             (0x08<<16)
  47 #define AB3100_EVENTA1_OVER_TEMP                        (0x10<<16)
  48 #define AB3100_EVENTA1_SIM_OFF                          (0x20<<16)
  49 #define AB3100_EVENTA1_VBUS                             (0x40<<16)
  50 #define AB3100_EVENTA1_VSET_USB                         (0x80<<16)
  51
  52 #define AB3100_EVENTA2_READY_TX                         (0x01<<8)
  53 #define AB3100_EVENTA2_READY_RX                         (0x02<<8)
  54 #define AB3100_EVENTA2_OVERRUN_ERROR                    (0x04<<8)
  55 #define AB3100_EVENTA2_FRAMING_ERROR                    (0x08<<8)
  56 #define AB3100_EVENTA2_CHARG_OVERCURRENT                (0x10<<8)
  57 #define AB3100_EVENTA2_MIDR                             (0x20<<8)
  58 #define AB3100_EVENTA2_BATTERY_REM                      (0x40<<8)
  59 #define AB3100_EVENTA2_ALARM                            (0x80<<8)
  60
  61 #define AB3100_EVENTA3_ADC_TRIG5                        (0x01)
  62 #define AB3100_EVENTA3_ADC_TRIG4                        (0x02)
  63 #define AB3100_EVENTA3_ADC_TRIG3                        (0x04)
  64 #define AB3100_EVENTA3_ADC_TRIG2                        (0x08)
  65 #define AB3100_EVENTA3_ADC_TRIGVBAT                     (0x10)
  66 #define AB3100_EVENTA3_ADC_TRIGVTX                      (0x20)
  67 #define AB3100_EVENTA3_ADC_TRIG1                        (0x40)
  68 #define AB3100_EVENTA3_ADC_TRIG0                        (0x80)
  69
  70 /* AB3100, STR register flags */
  71 #define AB3100_STR_ONSWA                                (0x01)
  72 #define AB3100_STR_ONSWB                                (0x02)
  73 #define AB3100_STR_ONSWC                                (0x04)
  74 #define AB3100_STR_DCIO                                 (0x08)
  75 #define AB3100_STR_BOOT_MODE                            (0x10)
  76 #define AB3100_STR_SIM_OFF                              (0x20)
  77 #define AB3100_STR_BATT_REMOVAL                         (0x40)
  78 #define AB3100_STR_VBUS                                 (0x80)
  79
  80 /*
  81  * AB3100 contains 8 regulators, one external regulator controller
  82  * and a buck converter, further the LDO E and buck converter can
  83  * have separate settings if they are in sleep mode, this is
  84  * modeled as a separate regulator.
  85  */
  86 #define AB3100_NUM_REGULATORS                           10
  87
  88 /**
  89  * struct ab3100
  90  * @access_mutex: lock out concurrent accesses to the AB3100 registers
  91  * @dev: pointer to the containing device
  92  * @i2c_client: I2C client for this chip
  93  * @testreg_client: secondary client for test registers
  94  * @chip_name: name of this chip variant
  95  * @chip_id: 8 bit chip ID for this chip variant
  96  * @event_subscribers: event subscribers are listed here
  97  * @startup_events: a copy of the first reading of the event registers
  98  * @startup_events_read: whether the first events have been read
  99  *
 100  * This struct is PRIVATE and devices using it should NOT
 101  * access ANY fields. It is used as a token for calling the
 102  * AB3100 functions.
 103  */
 104 struct ab3100 {
 105         struct mutex access_mutex;
 106         struct device *dev;
 107         struct i2c_client *i2c_client;
 108         struct i2c_client *testreg_client;
 109         char chip_name[32];
 110         u8 chip_id;
 111         struct blocking_notifier_head event_subscribers;
 112         u8 startup_events[3];
 113         bool startup_events_read;
 114 };
 115
 116 /**
 117  * struct ab3100_platform_data
 118  * Data supplied to initialize board connections to the AB3100
 119  * @reg_constraints: regulator constraints for target board
 120  *     the order of these constraints are: LDO A, C, D, E,
 121  *     F, G, H, K, EXT and BUCK.
 122  * @reg_initvals: initial values for the regulator registers
 123  *     plus two sleep settings for LDO E and the BUCK converter.
 124  *     exactly AB3100_NUM_REGULATORS+2 values must be sent in.
 125  *     Order: LDO A, C, E, E sleep, F, G, H, K, EXT, BUCK,
 126  *     BUCK sleep, LDO D. (LDO D need to be initialized last.)
 127  * @external_voltage: voltage level of the external regulator.
 128  */
 129 struct ab3100_platform_data {
 130         struct regulator_init_data reg_constraints[AB3100_NUM_REGULATORS];
 131         u8 reg_initvals[AB3100_NUM_REGULATORS+2];
 132         int external_voltage;
 133 };
 134
 135 int ab3100_event_register(struct ab3100 *ab3100,
 136                           struct notifier_block *nb);
 137 int ab3100_event_unregister(struct ab3100 *ab3100,
 138                             struct notifier_block *nb);
 139
 140 /* AB3550, STR register flags */
 141 #define AB3550_STR_ONSWA                                (0x01)
 142 #define AB3550_STR_ONSWB                                (0x02)
 143 #define AB3550_STR_ONSWC                                (0x04)
 144 #define AB3550_STR_DCIO                                 (0x08)
 145 #define AB3550_STR_BOOT_MODE                            (0x10)
 146 #define AB3550_STR_SIM_OFF                              (0x20)
 147 #define AB3550_STR_BATT_REMOVAL                         (0x40)
 148 #define AB3550_STR_VBUS                                 (0x80)
 149
 150 /* Interrupt mask registers */
 151 #define AB3550_IMR1 0x29
 152 #define AB3550_IMR2 0x2a
 153 #define AB3550_IMR3 0x2b
 154 #define AB3550_IMR4 0x2c
 155 #define AB3550_IMR5 0x2d
 156
 157 enum ab3550_devid {
 158         AB3550_DEVID_ADC,
 159         AB3550_DEVID_DAC,
 160         AB3550_DEVID_LEDS,
 161         AB3550_DEVID_POWER,
 162         AB3550_DEVID_REGULATORS,
 163         AB3550_DEVID_SIM,
 164         AB3550_DEVID_UART,
 165         AB3550_DEVID_RTC,
 166         AB3550_DEVID_CHARGER,
 167         AB3550_DEVID_FUELGAUGE,
 168         AB3550_DEVID_VIBRATOR,
 169         AB3550_DEVID_CODEC,
 170         AB3550_NUM_DEVICES,
 171 };
 172
 173 /**
 174  * struct abx500_init_setting
 175  * Initial value of the registers for driver to use during setup.
 176  */
 177 struct abx500_init_settings {
 178         u8 bank;
 179         u8 reg;
 180         u8 setting;
 181 };
 182
 183 /**
 184  * struct ab3550_platform_data
 185  * Data supplied to initialize board connections to the AB3550
 186  */
 187 struct ab3550_platform_data {
 188         struct {unsigned int base; unsigned int count; } irq;
 189         void *dev_data[AB3550_NUM_DEVICES];
 190         size_t dev_data_sz[AB3550_NUM_DEVICES];
 191         struct abx500_init_settings *init_settings;
 192         unsigned int init_settings_sz;
 193 };
 194
 195 int abx500_set_register_interruptible(struct device *dev, u8 bank, u8 reg,
 196         u8 value);
 197 int abx500_get_register_interruptible(struct device *dev, u8 bank, u8 reg,
 198         u8 *value);
 199 int abx500_get_register_page_interruptible(struct device *dev, u8 bank,
 200         u8 first_reg, u8 *regvals, u8 numregs);
 201 int abx500_set_register_page_interruptible(struct device *dev, u8 bank,
 202         u8 first_reg, u8 *regvals, u8 numregs);
 203 /**
 204  * abx500_mask_and_set_register_inerruptible() - Modifies selected bits of a
 205  *      target register
 206  *
 207  * @dev: The AB sub device.
 208  * @bank: The i2c bank number.
 209  * @bitmask: The bit mask to use.
 210  * @bitvalues: The new bit values.
 211  *
 212  * Updates the value of an AB register:
 213  * value -> ((value & ~bitmask) | (bitvalues & bitmask))
 214  */
 215 int abx500_mask_and_set_register_interruptible(struct device *dev, u8 bank,
 216         u8 reg, u8 bitmask, u8 bitvalues);
 217 int abx500_get_chip_id(struct device *dev);
 218 int abx500_event_registers_startup_state_get(struct device *dev, u8 *event);
 219 int abx500_startup_irq_enabled(struct device *dev, unsigned int irq);
 220
 221 struct abx500_ops {
 222         int (*get_chip_id) (struct device *);
 223         int (*get_register) (struct device *, u8, u8, u8 *);
 224         int (*set_register) (struct device *, u8, u8, u8);
 225         int (*get_register_page) (struct device *, u8, u8, u8 *, u8);
 226         int (*set_register_page) (struct device *, u8, u8, u8 *, u8);
 227         int (*mask_and_set_register) (struct device *, u8, u8, u8, u8);
 228         int (*event_registers_startup_state_get) (struct device *, u8 *);
 229         int (*startup_irq_enabled) (struct device *, unsigned int);
 230 };
 231
 232 int abx500_register_ops(struct device *core_dev, struct abx500_ops *ops);
 233 #endif