include/linux/mfd/ab3100.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2007-2009 ST-Ericsson AB
   4  * AB3100 core access functions
   5  * Author: Linus Walleij <linus.walleij@stericsson.com>
   6  */
   7
   8 #include <linux/regulator/machine.h>
   9
  10 struct device;
  11
  12 #ifndef MFD_AB3100_H
  13 #define MFD_AB3100_H
  14
  15
  16 #define AB3100_P1A      0xc0
  17 #define AB3100_P1B      0xc1
  18 #define AB3100_P1C      0xc2
  19 #define AB3100_P1D      0xc3
  20 #define AB3100_P1E      0xc4
  21 #define AB3100_P1F      0xc5
  22 #define AB3100_P1G      0xc6
  23 #define AB3100_R2A      0xc7
  24 #define AB3100_R2B      0xc8
  25
  26 /*
  27  * AB3100, EVENTA1, A2 and A3 event register flags
  28  * these are catenated into a single 32-bit flag in the code
  29  * for event notification broadcasts.
  30  */
  31 #define AB3100_EVENTA1_ONSWA                            (0x01<<16)
  32 #define AB3100_EVENTA1_ONSWB                            (0x02<<16)
  33 #define AB3100_EVENTA1_ONSWC                            (0x04<<16)
  34 #define AB3100_EVENTA1_DCIO                             (0x08<<16)
  35 #define AB3100_EVENTA1_OVER_TEMP                        (0x10<<16)
  36 #define AB3100_EVENTA1_SIM_OFF                          (0x20<<16)
  37 #define AB3100_EVENTA1_VBUS                             (0x40<<16)
  38 #define AB3100_EVENTA1_VSET_USB                         (0x80<<16)
  39
  40 #define AB3100_EVENTA2_READY_TX                         (0x01<<8)
  41 #define AB3100_EVENTA2_READY_RX                         (0x02<<8)
  42 #define AB3100_EVENTA2_OVERRUN_ERROR                    (0x04<<8)
  43 #define AB3100_EVENTA2_FRAMING_ERROR                    (0x08<<8)
  44 #define AB3100_EVENTA2_CHARG_OVERCURRENT                (0x10<<8)
  45 #define AB3100_EVENTA2_MIDR                             (0x20<<8)
  46 #define AB3100_EVENTA2_BATTERY_REM                      (0x40<<8)
  47 #define AB3100_EVENTA2_ALARM                            (0x80<<8)
  48
  49 #define AB3100_EVENTA3_ADC_TRIG5                        (0x01)
  50 #define AB3100_EVENTA3_ADC_TRIG4                        (0x02)
  51 #define AB3100_EVENTA3_ADC_TRIG3                        (0x04)
  52 #define AB3100_EVENTA3_ADC_TRIG2                        (0x08)
  53 #define AB3100_EVENTA3_ADC_TRIGVBAT                     (0x10)
  54 #define AB3100_EVENTA3_ADC_TRIGVTX                      (0x20)
  55 #define AB3100_EVENTA3_ADC_TRIG1                        (0x40)
  56 #define AB3100_EVENTA3_ADC_TRIG0                        (0x80)
  57
  58 /* AB3100, STR register flags */
  59 #define AB3100_STR_ONSWA                                (0x01)
  60 #define AB3100_STR_ONSWB                                (0x02)
  61 #define AB3100_STR_ONSWC                                (0x04)
  62 #define AB3100_STR_DCIO                                 (0x08)
  63 #define AB3100_STR_BOOT_MODE                            (0x10)
  64 #define AB3100_STR_SIM_OFF                              (0x20)
  65 #define AB3100_STR_BATT_REMOVAL                         (0x40)
  66 #define AB3100_STR_VBUS                                 (0x80)
  67
  68 /*
  69  * AB3100 contains 8 regulators, one external regulator controller
  70  * and a buck converter, further the LDO E and buck converter can
  71  * have separate settings if they are in sleep mode, this is
  72  * modeled as a separate regulator.
  73  */
  74 #define AB3100_NUM_REGULATORS                           10
  75
  76 /**
  77  * struct ab3100
  78  * @access_mutex: lock out concurrent accesses to the AB3100 registers
  79  * @dev: pointer to the containing device
  80  * @i2c_client: I2C client for this chip
  81  * @testreg_client: secondary client for test registers
  82  * @chip_name: name of this chip variant
  83  * @chip_id: 8 bit chip ID for this chip variant
  84  * @event_subscribers: event subscribers are listed here
  85  * @startup_events: a copy of the first reading of the event registers
  86  * @startup_events_read: whether the first events have been read
  87  *
  88  * This struct is PRIVATE and devices using it should NOT
  89  * access ANY fields. It is used as a token for calling the
  90  * AB3100 functions.
  91  */
  92 struct ab3100 {
  93         struct mutex access_mutex;
  94         struct device *dev;
  95         struct i2c_client *i2c_client;
  96         struct i2c_client *testreg_client;
  97         char chip_name[32];
  98         u8 chip_id;
  99         struct blocking_notifier_head event_subscribers;
 100         u8 startup_events[3];
 101         bool startup_events_read;
 102 };
 103
 104 /**
 105  * struct ab3100_platform_data
 106  * Data supplied to initialize board connections to the AB3100
 107  * @reg_constraints: regulator constraints for target board
 108  *     the order of these constraints are: LDO A, C, D, E,
 109  *     F, G, H, K, EXT and BUCK.
 110  * @reg_initvals: initial values for the regulator registers
 111  *     plus two sleep settings for LDO E and the BUCK converter.
 112  *     exactly AB3100_NUM_REGULATORS+2 values must be sent in.
 113  *     Order: LDO A, C, E, E sleep, F, G, H, K, EXT, BUCK,
 114  *     BUCK sleep, LDO D. (LDO D need to be initialized last.)
 115  * @external_voltage: voltage level of the external regulator.
 116  */
 117 struct ab3100_platform_data {
 118         struct regulator_init_data reg_constraints[AB3100_NUM_REGULATORS];
 119         u8 reg_initvals[AB3100_NUM_REGULATORS+2];
 120         int external_voltage;
 121 };
 122
 123 int ab3100_event_register(struct ab3100 *ab3100,
 124                           struct notifier_block *nb);
 125 int ab3100_event_unregister(struct ab3100 *ab3100,
 126                             struct notifier_block *nb);
 127
 128 #endif /*  MFD_AB3100_H */