include/linux/mfd/88pm860x.h

   1 /*
   2  * Marvell 88PM860x Interface
   3  *
   4  * Copyright (C) 2009 Marvell International Ltd.
   5  *      Haojian Zhuang <haojian.zhuang@marvell.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #ifndef __LINUX_MFD_88PM860X_H
  13 #define __LINUX_MFD_88PM860X_H
  14
  15 #include <linux/interrupt.h>
  16
  17 #define MFD_NAME_SIZE           (40)
  18
  19 enum {
  20         CHIP_INVALID = 0,
  21         CHIP_PM8606,
  22         CHIP_PM8607,
  23         CHIP_MAX,
  24 };
  25
  26 enum {
  27         PM8606_ID_INVALID,
  28         PM8606_ID_BACKLIGHT,
  29         PM8606_ID_LED,
  30         PM8606_ID_VIBRATOR,
  31         PM8606_ID_TOUCH,
  32         PM8606_ID_SOUND,
  33         PM8606_ID_CHARGER,
  34         PM8606_ID_MAX,
  35 };
  36
  37 enum {
  38         PM8606_BACKLIGHT1 = 0,
  39         PM8606_BACKLIGHT2,
  40         PM8606_BACKLIGHT3,
  41 };
  42
  43 enum {
  44         PM8606_LED1_RED = 0,
  45         PM8606_LED1_GREEN,
  46         PM8606_LED1_BLUE,
  47         PM8606_LED2_RED,
  48         PM8606_LED2_GREEN,
  49         PM8606_LED2_BLUE,
  50         PM8607_LED_VIBRATOR,
  51 };
  52
  53
  54 /* 8606 Registers */
  55 #define PM8606_DCM_BOOST                (0x00)
  56 #define PM8606_PWM                      (0x01)
  57
  58 /* Backlight Registers */
  59 #define PM8606_WLED1A                   (0x02)
  60 #define PM8606_WLED1B                   (0x03)
  61 #define PM8606_WLED2A                   (0x04)
  62 #define PM8606_WLED2B                   (0x05)
  63 #define PM8606_WLED3A                   (0x06)
  64 #define PM8606_WLED3B                   (0x07)
  65
  66 /* LED Registers */
  67 #define PM8606_RGB2A                    (0x08)
  68 #define PM8606_RGB2B                    (0x09)
  69 #define PM8606_RGB2C                    (0x0A)
  70 #define PM8606_RGB2D                    (0x0B)
  71 #define PM8606_RGB1A                    (0x0C)
  72 #define PM8606_RGB1B                    (0x0D)
  73 #define PM8606_RGB1C                    (0x0E)
  74 #define PM8606_RGB1D                    (0x0F)
  75
  76 #define PM8606_PREREGULATORA            (0x10)
  77 #define PM8606_PREREGULATORB            (0x11)
  78 #define PM8606_VIBRATORA                (0x12)
  79 #define PM8606_VIBRATORB                (0x13)
  80 #define PM8606_VCHG                     (0x14)
  81 #define PM8606_VSYS                     (0x15)
  82 #define PM8606_MISC                     (0x16)
  83 #define PM8606_CHIP_ID                  (0x17)
  84 #define PM8606_STATUS                   (0x18)
  85 #define PM8606_FLAGS                    (0x19)
  86 #define PM8606_PROTECTA                 (0x1A)
  87 #define PM8606_PROTECTB                 (0x1B)
  88 #define PM8606_PROTECTC                 (0x1C)
  89
  90 /* Bit definitions of PM8606 registers */
  91 #define PM8606_DCM_500MA                (0x0)   /* current limit */
  92 #define PM8606_DCM_750MA                (0x1)
  93 #define PM8606_DCM_1000MA               (0x2)
  94 #define PM8606_DCM_1250MA               (0x3)
  95 #define PM8606_DCM_250MV                (0x0 << 2)
  96 #define PM8606_DCM_300MV                (0x1 << 2)
  97 #define PM8606_DCM_350MV                (0x2 << 2)
  98 #define PM8606_DCM_400MV                (0x3 << 2)
  99
 100 #define PM8606_PWM_31200HZ              (0x0)
 101 #define PM8606_PWM_15600HZ              (0x1)
 102 #define PM8606_PWM_7800HZ               (0x2)
 103 #define PM8606_PWM_3900HZ               (0x3)
 104 #define PM8606_PWM_1950HZ               (0x4)
 105 #define PM8606_PWM_976HZ                (0x5)
 106 #define PM8606_PWM_488HZ                (0x6)
 107 #define PM8606_PWM_244HZ                (0x7)
 108 #define PM8606_PWM_FREQ_MASK            (0x7)
 109
 110 #define PM8606_WLED_ON                  (1 << 0)
 111 #define PM8606_WLED_CURRENT(x)          ((x & 0x1F) << 1)
 112
 113 #define PM8606_LED_CURRENT(x)           (((x >> 2) & 0x07) << 5)
 114
 115 #define PM8606_VSYS_EN                  (1 << 1)
 116
 117 #define PM8606_MISC_OSC_EN              (1 << 4)
 118
 119 enum {
 120         PM8607_ID_BUCK1 = 0,
 121         PM8607_ID_BUCK2,
 122         PM8607_ID_BUCK3,
 123
 124         PM8607_ID_LDO1,
 125         PM8607_ID_LDO2,
 126         PM8607_ID_LDO3,
 127         PM8607_ID_LDO4,
 128         PM8607_ID_LDO5,
 129         PM8607_ID_LDO6,
 130         PM8607_ID_LDO7,
 131         PM8607_ID_LDO8,
 132         PM8607_ID_LDO9,
 133         PM8607_ID_LDO10,
 134         PM8607_ID_LDO11,
 135         PM8607_ID_LDO12,
 136         PM8607_ID_LDO13,
 137         PM8607_ID_LDO14,
 138         PM8607_ID_LDO15,
 139         PM8606_ID_PREG,
 140
 141         PM8607_ID_RG_MAX,
 142 };
 143
 144 /* 8607 chip ID is 0x40 or 0x50 */
 145 #define PM8607_VERSION_MASK             (0xF0)  /* 8607 chip ID mask */
 146
 147 /* Interrupt Registers */
 148 #define PM8607_STATUS_1                 (0x01)
 149 #define PM8607_STATUS_2                 (0x02)
 150 #define PM8607_INT_STATUS1              (0x03)
 151 #define PM8607_INT_STATUS2              (0x04)
 152 #define PM8607_INT_STATUS3              (0x05)
 153 #define PM8607_INT_MASK_1               (0x06)
 154 #define PM8607_INT_MASK_2               (0x07)
 155 #define PM8607_INT_MASK_3               (0x08)
 156
 157 /* Regulator Control Registers */
 158 #define PM8607_LDO1                     (0x10)
 159 #define PM8607_LDO2                     (0x11)
 160 #define PM8607_LDO3                     (0x12)
 161 #define PM8607_LDO4                     (0x13)
 162 #define PM8607_LDO5                     (0x14)
 163 #define PM8607_LDO6                     (0x15)
 164 #define PM8607_LDO7                     (0x16)
 165 #define PM8607_LDO8                     (0x17)
 166 #define PM8607_LDO9                     (0x18)
 167 #define PM8607_LDO10                    (0x19)
 168 #define PM8607_LDO12                    (0x1A)
 169 #define PM8607_LDO14                    (0x1B)
 170 #define PM8607_SLEEP_MODE1              (0x1C)
 171 #define PM8607_SLEEP_MODE2              (0x1D)
 172 #define PM8607_SLEEP_MODE3              (0x1E)
 173 #define PM8607_SLEEP_MODE4              (0x1F)
 174 #define PM8607_GO                       (0x20)
 175 #define PM8607_SLEEP_BUCK1              (0x21)
 176 #define PM8607_SLEEP_BUCK2              (0x22)
 177 #define PM8607_SLEEP_BUCK3              (0x23)
 178 #define PM8607_BUCK1                    (0x24)
 179 #define PM8607_BUCK2                    (0x25)
 180 #define PM8607_BUCK3                    (0x26)
 181 #define PM8607_BUCK_CONTROLS            (0x27)
 182 #define PM8607_SUPPLIES_EN11            (0x2B)
 183 #define PM8607_SUPPLIES_EN12            (0x2C)
 184 #define PM8607_GROUP1                   (0x2D)
 185 #define PM8607_GROUP2                   (0x2E)
 186 #define PM8607_GROUP3                   (0x2F)
 187 #define PM8607_GROUP4                   (0x30)
 188 #define PM8607_GROUP5                   (0x31)
 189 #define PM8607_GROUP6                   (0x32)
 190 #define PM8607_SUPPLIES_EN21            (0x33)
 191 #define PM8607_SUPPLIES_EN22            (0x34)
 192
 193 /* Vibrator Control Registers */
 194 #define PM8607_VIBRATOR_SET             (0x28)
 195 #define PM8607_VIBRATOR_PWM             (0x29)
 196
 197 /* GPADC Registers */
 198 #define PM8607_GP_BIAS1                 (0x4F)
 199 #define PM8607_MEAS_EN1                 (0x50)
 200 #define PM8607_MEAS_EN2                 (0x51)
 201 #define PM8607_MEAS_EN3                 (0x52)
 202 #define PM8607_MEAS_OFF_TIME1           (0x53)
 203 #define PM8607_MEAS_OFF_TIME2           (0x54)
 204 #define PM8607_TSI_PREBIAS              (0x55)  /* prebias time */
 205 #define PM8607_PD_PREBIAS               (0x56)  /* prebias time */
 206 #define PM8607_GPADC_MISC1              (0x57)
 207
 208 /* RTC Control Registers */
 209 #define PM8607_RTC1                     (0xA0)
 210 #define PM8607_RTC_COUNTER1             (0xA1)
 211 #define PM8607_RTC_COUNTER2             (0xA2)
 212 #define PM8607_RTC_COUNTER3             (0xA3)
 213 #define PM8607_RTC_COUNTER4             (0xA4)
 214 #define PM8607_RTC_EXPIRE1              (0xA5)
 215 #define PM8607_RTC_EXPIRE2              (0xA6)
 216 #define PM8607_RTC_EXPIRE3              (0xA7)
 217 #define PM8607_RTC_EXPIRE4              (0xA8)
 218 #define PM8607_RTC_TRIM1                (0xA9)
 219 #define PM8607_RTC_TRIM2                (0xAA)
 220 #define PM8607_RTC_TRIM3                (0xAB)
 221 #define PM8607_RTC_TRIM4                (0xAC)
 222 #define PM8607_RTC_MISC1                (0xAD)
 223 #define PM8607_RTC_MISC2                (0xAE)
 224 #define PM8607_RTC_MISC3                (0xAF)
 225
 226 /* Misc Registers */
 227 #define PM8607_CHIP_ID                  (0x00)
 228 #define PM8607_B0_MISC1                 (0x0C)
 229 #define PM8607_LDO1                     (0x10)
 230 #define PM8607_DVC3                     (0x26)
 231 #define PM8607_A1_MISC1                 (0x40)
 232
 233 /* bit definitions of Status Query Interface */
 234 #define PM8607_STATUS_CC                (1 << 3)
 235 #define PM8607_STATUS_PEN               (1 << 4)
 236 #define PM8607_STATUS_HEADSET           (1 << 5)
 237 #define PM8607_STATUS_HOOK              (1 << 6)
 238 #define PM8607_STATUS_MICIN             (1 << 7)
 239 #define PM8607_STATUS_ONKEY             (1 << 8)
 240 #define PM8607_STATUS_EXTON             (1 << 9)
 241 #define PM8607_STATUS_CHG               (1 << 10)
 242 #define PM8607_STATUS_BAT               (1 << 11)
 243 #define PM8607_STATUS_VBUS              (1 << 12)
 244 #define PM8607_STATUS_OV                (1 << 13)
 245
 246 /* bit definitions of BUCK3 */
 247 #define PM8607_BUCK3_DOUBLE             (1 << 6)
 248
 249 /* bit definitions of Misc1 */
 250 #define PM8607_A1_MISC1_PI2C            (1 << 0)
 251 #define PM8607_B0_MISC1_INV_INT         (1 << 0)
 252 #define PM8607_B0_MISC1_INT_CLEAR       (1 << 1)
 253 #define PM8607_B0_MISC1_INT_MASK        (1 << 2)
 254 #define PM8607_B0_MISC1_PI2C            (1 << 3)
 255 #define PM8607_B0_MISC1_RESET           (1 << 6)
 256
 257 /* bits definitions of GPADC */
 258 #define PM8607_GPADC_EN                 (1 << 0)
 259 #define PM8607_GPADC_PREBIAS_MASK       (3 << 1)
 260 #define PM8607_GPADC_SLOT_CYCLE_MASK    (3 << 3)        /* slow mode */
 261 #define PM8607_GPADC_OFF_SCALE_MASK     (3 << 5)        /* GP sleep mode */
 262 #define PM8607_GPADC_SW_CAL_MASK        (1 << 7)
 263
 264 #define PM8607_PD_PREBIAS_MASK          (0x1F << 0)
 265 #define PM8607_PD_PRECHG_MASK           (7 << 5)
 266
 267 #define PM8606_REF_GP_OSC_OFF         0
 268 #define PM8606_REF_GP_OSC_ON          1
 269 #define PM8606_REF_GP_OSC_UNKNOWN     2
 270
 271 /* Clients of reference group and 8MHz oscillator in 88PM8606 */
 272 enum pm8606_ref_gp_and_osc_clients {
 273         REF_GP_NO_CLIENTS       = 0,
 274         WLED1_DUTY              = (1<<0), /*PF 0x02.7:0*/
 275         WLED2_DUTY              = (1<<1), /*PF 0x04.7:0*/
 276         WLED3_DUTY              = (1<<2), /*PF 0x06.7:0*/
 277         RGB1_ENABLE             = (1<<3), /*PF 0x07.1*/
 278         RGB2_ENABLE             = (1<<4), /*PF 0x07.2*/
 279         LDO_VBR_EN              = (1<<5), /*PF 0x12.0*/
 280         REF_GP_MAX_CLIENT       = 0xFFFF
 281 };
 282
 283 /* Interrupt Number in 88PM8607 */
 284 enum {
 285         PM8607_IRQ_ONKEY,
 286         PM8607_IRQ_EXTON,
 287         PM8607_IRQ_CHG,
 288         PM8607_IRQ_BAT,
 289         PM8607_IRQ_RTC,
 290         PM8607_IRQ_CC,
 291         PM8607_IRQ_VBAT,
 292         PM8607_IRQ_VCHG,
 293         PM8607_IRQ_VSYS,
 294         PM8607_IRQ_TINT,
 295         PM8607_IRQ_GPADC0,
 296         PM8607_IRQ_GPADC1,
 297         PM8607_IRQ_GPADC2,
 298         PM8607_IRQ_GPADC3,
 299         PM8607_IRQ_AUDIO_SHORT,
 300         PM8607_IRQ_PEN,
 301         PM8607_IRQ_HEADSET,
 302         PM8607_IRQ_HOOK,
 303         PM8607_IRQ_MICIN,
 304         PM8607_IRQ_CHG_FAIL,
 305         PM8607_IRQ_CHG_DONE,
 306         PM8607_IRQ_CHG_FAULT,
 307 };
 308
 309 enum {
 310         PM8607_CHIP_A0 = 0x40,
 311         PM8607_CHIP_A1 = 0x41,
 312         PM8607_CHIP_B0 = 0x48,
 313 };
 314
 315 struct pm860x_chip {
 316         struct device           *dev;
 317         struct mutex            irq_lock;
 318         struct mutex            osc_lock;
 319         struct i2c_client       *client;
 320         struct i2c_client       *companion;     /* companion chip client */
 321         struct regmap           *regmap;
 322         struct regmap           *regmap_companion;
 323
 324         int                     buck3_double;   /* DVC ramp slope double */
 325         unsigned short          companion_addr;
 326         unsigned short          osc_vote;
 327         int                     id;
 328         int                     irq_mode;
 329         int                     irq_base;
 330         int                     core_irq;
 331         unsigned char           chip_version;
 332         unsigned char           osc_status;
 333
 334         unsigned int            wakeup_flag;
 335 };
 336
 337 enum {
 338         GI2C_PORT = 0,
 339         PI2C_PORT,
 340 };
 341
 342 struct pm860x_backlight_pdata {
 343         int             id;
 344         int             pwm;
 345         int             iset;
 346         unsigned long   flags;
 347 };
 348
 349 struct pm860x_led_pdata {
 350         int             id;
 351         int             iset;
 352         unsigned long   flags;
 353 };
 354
 355 struct pm860x_rtc_pdata {
 356         int             (*sync)(unsigned int ticks);
 357         int             vrtc;
 358 };
 359
 360 struct pm860x_touch_pdata {
 361         int             gpadc_prebias;
 362         int             slot_cycle;
 363         int             off_scale;
 364         int             sw_cal;
 365         int             tsi_prebias;    /* time, slot */
 366         int             pen_prebias;    /* time, slot */
 367         int             pen_prechg;     /* time, slot */
 368         int             res_x;          /* resistor of Xplate */
 369         unsigned long   flags;
 370 };
 371
 372 struct pm860x_power_pdata {
 373         unsigned        fast_charge;    /* charge current */
 374 };
 375
 376 struct pm860x_platform_data {
 377         struct pm860x_backlight_pdata   *backlight;
 378         struct pm860x_led_pdata         *led;
 379         struct pm860x_rtc_pdata         *rtc;
 380         struct pm860x_touch_pdata       *touch;
 381         struct pm860x_power_pdata       *power;
 382         struct regulator_init_data      *regulator;
 383
 384         unsigned short  companion_addr; /* I2C address of companion chip */
 385         int             i2c_port;       /* Controlled by GI2C or PI2C */
 386         int             irq_mode;       /* Clear interrupt by read/write(0/1) */
 387         int             irq_base;       /* IRQ base number of 88pm860x */
 388         int             num_leds;
 389         int             num_backlights;
 390         int             num_regulators;
 391 };
 392
 393 extern int pm8606_osc_enable(struct pm860x_chip *, unsigned short);
 394 extern int pm8606_osc_disable(struct pm860x_chip *, unsigned short);
 395
 396 extern int pm860x_reg_read(struct i2c_client *, int);
 397 extern int pm860x_reg_write(struct i2c_client *, int, unsigned char);
 398 extern int pm860x_bulk_read(struct i2c_client *, int, int, unsigned char *);
 399 extern int pm860x_bulk_write(struct i2c_client *, int, int, unsigned char *);
 400 extern int pm860x_set_bits(struct i2c_client *, int, unsigned char,
 401                            unsigned char);
 402 extern int pm860x_page_reg_read(struct i2c_client *, int);
 403 extern int pm860x_page_reg_write(struct i2c_client *, int, unsigned char);
 404 extern int pm860x_page_bulk_read(struct i2c_client *, int, int,
 405                                  unsigned char *);
 406 extern int pm860x_page_bulk_write(struct i2c_client *, int, int,
 407                                   unsigned char *);
 408 extern int pm860x_page_set_bits(struct i2c_client *, int, unsigned char,
 409                                 unsigned char);
 410
 411 extern int pm860x_device_init(struct pm860x_chip *chip,
 412                               struct pm860x_platform_data *pdata) __devinit ;
 413 extern void pm860x_device_exit(struct pm860x_chip *chip) __devexit ;
 414
 415 #endif /* __LINUX_MFD_88PM860X_H */