include/linux/mfd/ab3100.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
   8 #include <linux/device.h>
   9
  10 #ifndef MFD_AB3100_H
  11 #define MFD_AB3100_H
  12
  13 #define ABUNKNOWN       0
  14 #define AB3000          1
  15 #define AB3100          2
  16
  17 /*
  18  * AB3100, EVENTA1, A2 and A3 event register flags
  19  * these are catenated into a single 32-bit flag in the code
  20  * for event notification broadcasts.
  21  */
  22 #define AB3100_EVENTA1_ONSWA                            (0x01<<16)
  23 #define AB3100_EVENTA1_ONSWB                            (0x02<<16)
  24 #define AB3100_EVENTA1_ONSWC                            (0x04<<16)
  25 #define AB3100_EVENTA1_DCIO                             (0x08<<16)
  26 #define AB3100_EVENTA1_OVER_TEMP                        (0x10<<16)
  27 #define AB3100_EVENTA1_SIM_OFF                          (0x20<<16)
  28 #define AB3100_EVENTA1_VBUS                             (0x40<<16)
  29 #define AB3100_EVENTA1_VSET_USB                         (0x80<<16)
  30
  31 #define AB3100_EVENTA2_READY_TX                         (0x01<<8)
  32 #define AB3100_EVENTA2_READY_RX                         (0x02<<8)
  33 #define AB3100_EVENTA2_OVERRUN_ERROR                    (0x04<<8)
  34 #define AB3100_EVENTA2_FRAMING_ERROR                    (0x08<<8)
  35 #define AB3100_EVENTA2_CHARG_OVERCURRENT                (0x10<<8)
  36 #define AB3100_EVENTA2_MIDR                             (0x20<<8)
  37 #define AB3100_EVENTA2_BATTERY_REM                      (0x40<<8)
  38 #define AB3100_EVENTA2_ALARM                            (0x80<<8)
  39
  40 #define AB3100_EVENTA3_ADC_TRIG5                        (0x01)
  41 #define AB3100_EVENTA3_ADC_TRIG4                        (0x02)
  42 #define AB3100_EVENTA3_ADC_TRIG3                        (0x04)
  43 #define AB3100_EVENTA3_ADC_TRIG2                        (0x08)
  44 #define AB3100_EVENTA3_ADC_TRIGVBAT                     (0x10)
  45 #define AB3100_EVENTA3_ADC_TRIGVTX                      (0x20)
  46 #define AB3100_EVENTA3_ADC_TRIG1                        (0x40)
  47 #define AB3100_EVENTA3_ADC_TRIG0                        (0x80)
  48
  49 /* AB3100, STR register flags */
  50 #define AB3100_STR_ONSWA                                (0x01)
  51 #define AB3100_STR_ONSWB                                (0x02)
  52 #define AB3100_STR_ONSWC                                (0x04)
  53 #define AB3100_STR_DCIO                                 (0x08)
  54 #define AB3100_STR_BOOT_MODE                            (0x10)
  55 #define AB3100_STR_SIM_OFF                              (0x20)
  56 #define AB3100_STR_BATT_REMOVAL                         (0x40)
  57 #define AB3100_STR_VBUS                                 (0x80)
  58
  59 /**
  60  * struct ab3100
  61  * @access_mutex: lock out concurrent accesses to the AB3100 registers
  62  * @dev: pointer to the containing device
  63  * @i2c_client: I2C client for this chip
  64  * @testreg_client: secondary client for test registers
  65  * @chip_name: name of this chip variant
  66  * @chip_id: 8 bit chip ID for this chip variant
  67  * @work: an event handling worker
  68  * @event_subscribers: event subscribers are listed here
  69  * @startup_events: a copy of the first reading of the event registers
  70  * @startup_events_read: whether the first events have been read
  71  *
  72  * This struct is PRIVATE and devices using it should NOT
  73  * access ANY fields. It is used as a token for calling the
  74  * AB3100 functions.
  75  */
  76 struct ab3100 {
  77         struct mutex access_mutex;
  78         struct device *dev;
  79         struct i2c_client *i2c_client;
  80         struct i2c_client *testreg_client;
  81         char chip_name[32];
  82         u8 chip_id;
  83         struct work_struct work;
  84         struct blocking_notifier_head event_subscribers;
  85         u32 startup_events;
  86         bool startup_events_read;
  87 };
  88
  89 int ab3100_set_register(struct ab3100 *ab3100, u8 reg, u8 regval);
  90 int ab3100_get_register(struct ab3100 *ab3100, u8 reg, u8 *regval);
  91 int ab3100_get_register_page(struct ab3100 *ab3100,
  92                              u8 first_reg, u8 *regvals, u8 numregs);
  93 int ab3100_mask_and_set_register(struct ab3100 *ab3100,
  94                                  u8 reg, u8 andmask, u8 ormask);
  95 u8 ab3100_get_chip_type(struct ab3100 *ab3100);
  96 int ab3100_event_register(struct ab3100 *ab3100,
  97                           struct notifier_block *nb);
  98 int ab3100_event_unregister(struct ab3100 *ab3100,
  99                             struct notifier_block *nb);
 100 int ab3100_event_registers_startup_state_get(struct ab3100 *ab3100,
 101                                              u32 *fatevent);
 102
 103 #endif