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 #define PM8607_MISC2                    (0x42)
  59
  60 /* Power Up Log Register */
  61 #define PM8607_POWER_UP_LOG             (0x3F)
  62
  63 /* Charger Control Registers */
  64 #define PM8607_CCNT                     (0x47)
  65 #define PM8607_CHG_CTRL1                (0x48)
  66 #define PM8607_CHG_CTRL2                (0x49)
  67 #define PM8607_CHG_CTRL3                (0x4A)
  68 #define PM8607_CHG_CTRL4                (0x4B)
  69 #define PM8607_CHG_CTRL5                (0x4C)
  70 #define PM8607_CHG_CTRL6                (0x4D)
  71 #define PM8607_CHG_CTRL7                (0x4E)
  72
  73 /* Backlight Registers */
  74 #define PM8606_WLED1A                   (0x02)
  75 #define PM8606_WLED1B                   (0x03)
  76 #define PM8606_WLED2A                   (0x04)
  77 #define PM8606_WLED2B                   (0x05)
  78 #define PM8606_WLED3A                   (0x06)
  79 #define PM8606_WLED3B                   (0x07)
  80
  81 /* LED Registers */
  82 #define PM8606_RGB2A                    (0x08)
  83 #define PM8606_RGB2B                    (0x09)
  84 #define PM8606_RGB2C                    (0x0A)
  85 #define PM8606_RGB2D                    (0x0B)
  86 #define PM8606_RGB1A                    (0x0C)
  87 #define PM8606_RGB1B                    (0x0D)
  88 #define PM8606_RGB1C                    (0x0E)
  89 #define PM8606_RGB1D                    (0x0F)
  90
  91 #define PM8606_PREREGULATORA            (0x10)
  92 #define PM8606_PREREGULATORB            (0x11)
  93 #define PM8606_VIBRATORA                (0x12)
  94 #define PM8606_VIBRATORB                (0x13)
  95 #define PM8606_VCHG                     (0x14)
  96 #define PM8606_VSYS                     (0x15)
  97 #define PM8606_MISC                     (0x16)
  98 #define PM8606_CHIP_ID                  (0x17)
  99 #define PM8606_STATUS                   (0x18)
 100 #define PM8606_FLAGS                    (0x19)
 101 #define PM8606_PROTECTA                 (0x1A)
 102 #define PM8606_PROTECTB                 (0x1B)
 103 #define PM8606_PROTECTC                 (0x1C)
 104
 105 /* Bit definitions of PM8606 registers */
 106 #define PM8606_DCM_500MA                (0x0)   /* current limit */
 107 #define PM8606_DCM_750MA                (0x1)
 108 #define PM8606_DCM_1000MA               (0x2)
 109 #define PM8606_DCM_1250MA               (0x3)
 110 #define PM8606_DCM_250MV                (0x0 << 2)
 111 #define PM8606_DCM_300MV                (0x1 << 2)
 112 #define PM8606_DCM_350MV                (0x2 << 2)
 113 #define PM8606_DCM_400MV                (0x3 << 2)
 114
 115 #define PM8606_PWM_31200HZ              (0x0)
 116 #define PM8606_PWM_15600HZ              (0x1)
 117 #define PM8606_PWM_7800HZ               (0x2)
 118 #define PM8606_PWM_3900HZ               (0x3)
 119 #define PM8606_PWM_1950HZ               (0x4)
 120 #define PM8606_PWM_976HZ                (0x5)
 121 #define PM8606_PWM_488HZ                (0x6)
 122 #define PM8606_PWM_244HZ                (0x7)
 123 #define PM8606_PWM_FREQ_MASK            (0x7)
 124
 125 #define PM8606_WLED_ON                  (1 << 0)
 126 #define PM8606_WLED_CURRENT(x)          ((x & 0x1F) << 1)
 127
 128 #define PM8606_LED_CURRENT(x)           (((x >> 2) & 0x07) << 5)
 129
 130 #define PM8606_VSYS_EN                  (1 << 1)
 131
 132 #define PM8606_MISC_OSC_EN              (1 << 4)
 133
 134 enum {
 135         PM8607_ID_BUCK1 = 0,
 136         PM8607_ID_BUCK2,
 137         PM8607_ID_BUCK3,
 138
 139         PM8607_ID_LDO1,
 140         PM8607_ID_LDO2,
 141         PM8607_ID_LDO3,
 142         PM8607_ID_LDO4,
 143         PM8607_ID_LDO5,
 144         PM8607_ID_LDO6,
 145         PM8607_ID_LDO7,
 146         PM8607_ID_LDO8,
 147         PM8607_ID_LDO9,
 148         PM8607_ID_LDO10,
 149         PM8607_ID_LDO11,
 150         PM8607_ID_LDO12,
 151         PM8607_ID_LDO13,
 152         PM8607_ID_LDO14,
 153         PM8607_ID_LDO15,
 154         PM8606_ID_PREG,
 155
 156         PM8607_ID_RG_MAX,
 157 };
 158
 159 /* 8607 chip ID is 0x40 or 0x50 */
 160 #define PM8607_VERSION_MASK             (0xF0)  /* 8607 chip ID mask */
 161
 162 /* Interrupt Registers */
 163 #define PM8607_STATUS_1                 (0x01)
 164 #define PM8607_STATUS_2                 (0x02)
 165 #define PM8607_INT_STATUS1              (0x03)
 166 #define PM8607_INT_STATUS2              (0x04)
 167 #define PM8607_INT_STATUS3              (0x05)
 168 #define PM8607_INT_MASK_1               (0x06)
 169 #define PM8607_INT_MASK_2               (0x07)
 170 #define PM8607_INT_MASK_3               (0x08)
 171
 172 /* Regulator Control Registers */
 173 #define PM8607_LDO1                     (0x10)
 174 #define PM8607_LDO2                     (0x11)
 175 #define PM8607_LDO3                     (0x12)
 176 #define PM8607_LDO4                     (0x13)
 177 #define PM8607_LDO5                     (0x14)
 178 #define PM8607_LDO6                     (0x15)
 179 #define PM8607_LDO7                     (0x16)
 180 #define PM8607_LDO8                     (0x17)
 181 #define PM8607_LDO9                     (0x18)
 182 #define PM8607_LDO10                    (0x19)
 183 #define PM8607_LDO12                    (0x1A)
 184 #define PM8607_LDO14                    (0x1B)
 185 #define PM8607_SLEEP_MODE1              (0x1C)
 186 #define PM8607_SLEEP_MODE2              (0x1D)
 187 #define PM8607_SLEEP_MODE3              (0x1E)
 188 #define PM8607_SLEEP_MODE4              (0x1F)
 189 #define PM8607_GO                       (0x20)
 190 #define PM8607_SLEEP_BUCK1              (0x21)
 191 #define PM8607_SLEEP_BUCK2              (0x22)
 192 #define PM8607_SLEEP_BUCK3              (0x23)
 193 #define PM8607_BUCK1                    (0x24)
 194 #define PM8607_BUCK2                    (0x25)
 195 #define PM8607_BUCK3                    (0x26)
 196 #define PM8607_BUCK_CONTROLS            (0x27)
 197 #define PM8607_SUPPLIES_EN11            (0x2B)
 198 #define PM8607_SUPPLIES_EN12            (0x2C)
 199 #define PM8607_GROUP1                   (0x2D)
 200 #define PM8607_GROUP2                   (0x2E)
 201 #define PM8607_GROUP3                   (0x2F)
 202 #define PM8607_GROUP4                   (0x30)
 203 #define PM8607_GROUP5                   (0x31)
 204 #define PM8607_GROUP6                   (0x32)
 205 #define PM8607_SUPPLIES_EN21            (0x33)
 206 #define PM8607_SUPPLIES_EN22            (0x34)
 207
 208 /* Vibrator Control Registers */
 209 #define PM8607_VIBRATOR_SET             (0x28)
 210 #define PM8607_VIBRATOR_PWM             (0x29)
 211
 212 /* GPADC Registers */
 213 #define PM8607_GP_BIAS1                 (0x4F)
 214 #define PM8607_MEAS_EN1                 (0x50)
 215 #define PM8607_MEAS_EN2                 (0x51)
 216 #define PM8607_MEAS_EN3                 (0x52)
 217 #define PM8607_MEAS_OFF_TIME1           (0x53)
 218 #define PM8607_MEAS_OFF_TIME2           (0x54)
 219 #define PM8607_TSI_PREBIAS              (0x55)  /* prebias time */
 220 #define PM8607_PD_PREBIAS               (0x56)  /* prebias time */
 221 #define PM8607_GPADC_MISC1              (0x57)
 222
 223 /* bit definitions of  MEAS_EN1*/
 224 #define PM8607_MEAS_EN1_VBAT            (1 << 0)
 225 #define PM8607_MEAS_EN1_VCHG            (1 << 1)
 226 #define PM8607_MEAS_EN1_VSYS            (1 << 2)
 227 #define PM8607_MEAS_EN1_TINT            (1 << 3)
 228 #define PM8607_MEAS_EN1_RFTMP           (1 << 4)
 229 #define PM8607_MEAS_EN1_TBAT            (1 << 5)
 230 #define PM8607_MEAS_EN1_GPADC2          (1 << 6)
 231 #define PM8607_MEAS_EN1_GPADC3          (1 << 7)
 232
 233 /* Battery Monitor Registers */
 234 #define PM8607_GP_BIAS2                 (0x5A)
 235 #define PM8607_VBAT_LOWTH               (0x5B)
 236 #define PM8607_VCHG_LOWTH               (0x5C)
 237 #define PM8607_VSYS_LOWTH               (0x5D)
 238 #define PM8607_TINT_LOWTH               (0x5E)
 239 #define PM8607_GPADC0_LOWTH             (0x5F)
 240 #define PM8607_GPADC1_LOWTH             (0x60)
 241 #define PM8607_GPADC2_LOWTH             (0x61)
 242 #define PM8607_GPADC3_LOWTH             (0x62)
 243 #define PM8607_VBAT_HIGHTH              (0x63)
 244 #define PM8607_VCHG_HIGHTH              (0x64)
 245 #define PM8607_VSYS_HIGHTH              (0x65)
 246 #define PM8607_TINT_HIGHTH              (0x66)
 247 #define PM8607_GPADC0_HIGHTH            (0x67)
 248 #define PM8607_GPADC1_HIGHTH            (0x68)
 249 #define PM8607_GPADC2_HIGHTH            (0x69)
 250 #define PM8607_GPADC3_HIGHTH            (0x6A)
 251 #define PM8607_IBAT_MEAS1               (0x6B)
 252 #define PM8607_IBAT_MEAS2               (0x6C)
 253 #define PM8607_VBAT_MEAS1               (0x6D)
 254 #define PM8607_VBAT_MEAS2               (0x6E)
 255 #define PM8607_VCHG_MEAS1               (0x6F)
 256 #define PM8607_VCHG_MEAS2               (0x70)
 257 #define PM8607_VSYS_MEAS1               (0x71)
 258 #define PM8607_VSYS_MEAS2               (0x72)
 259 #define PM8607_TINT_MEAS1               (0x73)
 260 #define PM8607_TINT_MEAS2               (0x74)
 261 #define PM8607_GPADC0_MEAS1             (0x75)
 262 #define PM8607_GPADC0_MEAS2             (0x76)
 263 #define PM8607_GPADC1_MEAS1             (0x77)
 264 #define PM8607_GPADC1_MEAS2             (0x78)
 265 #define PM8607_GPADC2_MEAS1             (0x79)
 266 #define PM8607_GPADC2_MEAS2             (0x7A)
 267 #define PM8607_GPADC3_MEAS1             (0x7B)
 268 #define PM8607_GPADC3_MEAS2             (0x7C)
 269 #define PM8607_CCNT_MEAS1               (0x95)
 270 #define PM8607_CCNT_MEAS2               (0x96)
 271 #define PM8607_VBAT_AVG                 (0x97)
 272 #define PM8607_VCHG_AVG                 (0x98)
 273 #define PM8607_VSYS_AVG                 (0x99)
 274 #define PM8607_VBAT_MIN                 (0x9A)
 275 #define PM8607_VCHG_MIN                 (0x9B)
 276 #define PM8607_VSYS_MIN                 (0x9C)
 277 #define PM8607_VBAT_MAX                 (0x9D)
 278 #define PM8607_VCHG_MAX                 (0x9E)
 279 #define PM8607_VSYS_MAX                 (0x9F)
 280
 281 #define PM8607_GPADC_MISC2              (0x59)
 282 #define PM8607_GPADC0_GP_BIAS_A0        (1 << 0)
 283 #define PM8607_GPADC1_GP_BIAS_A1        (1 << 1)
 284 #define PM8607_GPADC2_GP_BIAS_A2        (1 << 2)
 285 #define PM8607_GPADC3_GP_BIAS_A3        (1 << 3)
 286 #define PM8607_GPADC2_GP_BIAS_OUT2      (1 << 6)
 287
 288 /* RTC Control Registers */
 289 #define PM8607_RTC1                     (0xA0)
 290 #define PM8607_RTC_COUNTER1             (0xA1)
 291 #define PM8607_RTC_COUNTER2             (0xA2)
 292 #define PM8607_RTC_COUNTER3             (0xA3)
 293 #define PM8607_RTC_COUNTER4             (0xA4)
 294 #define PM8607_RTC_EXPIRE1              (0xA5)
 295 #define PM8607_RTC_EXPIRE2              (0xA6)
 296 #define PM8607_RTC_EXPIRE3              (0xA7)
 297 #define PM8607_RTC_EXPIRE4              (0xA8)
 298 #define PM8607_RTC_TRIM1                (0xA9)
 299 #define PM8607_RTC_TRIM2                (0xAA)
 300 #define PM8607_RTC_TRIM3                (0xAB)
 301 #define PM8607_RTC_TRIM4                (0xAC)
 302 #define PM8607_RTC_MISC1                (0xAD)
 303 #define PM8607_RTC_MISC2                (0xAE)
 304 #define PM8607_RTC_MISC3                (0xAF)
 305
 306 /* Misc Registers */
 307 #define PM8607_CHIP_ID                  (0x00)
 308 #define PM8607_B0_MISC1                 (0x0C)
 309 #define PM8607_LDO1                     (0x10)
 310 #define PM8607_DVC3                     (0x26)
 311 #define PM8607_A1_MISC1                 (0x40)
 312
 313 /* bit definitions of Status Query Interface */
 314 #define PM8607_STATUS_CC                (1 << 3)
 315 #define PM8607_STATUS_PEN               (1 << 4)
 316 #define PM8607_STATUS_HEADSET           (1 << 5)
 317 #define PM8607_STATUS_HOOK              (1 << 6)
 318 #define PM8607_STATUS_MICIN             (1 << 7)
 319 #define PM8607_STATUS_ONKEY             (1 << 8)
 320 #define PM8607_STATUS_EXTON             (1 << 9)
 321 #define PM8607_STATUS_CHG               (1 << 10)
 322 #define PM8607_STATUS_BAT               (1 << 11)
 323 #define PM8607_STATUS_VBUS              (1 << 12)
 324 #define PM8607_STATUS_OV                (1 << 13)
 325
 326 /* bit definitions of BUCK3 */
 327 #define PM8607_BUCK3_DOUBLE             (1 << 6)
 328
 329 /* bit definitions of Misc1 */
 330 #define PM8607_A1_MISC1_PI2C            (1 << 0)
 331 #define PM8607_B0_MISC1_INV_INT         (1 << 0)
 332 #define PM8607_B0_MISC1_INT_CLEAR       (1 << 1)
 333 #define PM8607_B0_MISC1_INT_MASK        (1 << 2)
 334 #define PM8607_B0_MISC1_PI2C            (1 << 3)
 335 #define PM8607_B0_MISC1_RESET           (1 << 6)
 336
 337 /* bits definitions of GPADC */
 338 #define PM8607_GPADC_EN                 (1 << 0)
 339 #define PM8607_GPADC_PREBIAS_MASK       (3 << 1)
 340 #define PM8607_GPADC_SLOT_CYCLE_MASK    (3 << 3)        /* slow mode */
 341 #define PM8607_GPADC_OFF_SCALE_MASK     (3 << 5)        /* GP sleep mode */
 342 #define PM8607_GPADC_SW_CAL_MASK        (1 << 7)
 343
 344 #define PM8607_PD_PREBIAS_MASK          (0x1F << 0)
 345 #define PM8607_PD_PRECHG_MASK           (7 << 5)
 346
 347 #define PM8606_REF_GP_OSC_OFF         0
 348 #define PM8606_REF_GP_OSC_ON          1
 349 #define PM8606_REF_GP_OSC_UNKNOWN     2
 350
 351 /* Clients of reference group and 8MHz oscillator in 88PM8606 */
 352 enum pm8606_ref_gp_and_osc_clients {
 353         REF_GP_NO_CLIENTS       = 0,
 354         WLED1_DUTY              = (1<<0), /*PF 0x02.7:0*/
 355         WLED2_DUTY              = (1<<1), /*PF 0x04.7:0*/
 356         WLED3_DUTY              = (1<<2), /*PF 0x06.7:0*/
 357         RGB1_ENABLE             = (1<<3), /*PF 0x07.1*/
 358         RGB2_ENABLE             = (1<<4), /*PF 0x07.2*/
 359         LDO_VBR_EN              = (1<<5), /*PF 0x12.0*/
 360         REF_GP_MAX_CLIENT       = 0xFFFF
 361 };
 362
 363 /* Interrupt Number in 88PM8607 */
 364 enum {
 365         PM8607_IRQ_ONKEY,
 366         PM8607_IRQ_EXTON,
 367         PM8607_IRQ_CHG,
 368         PM8607_IRQ_BAT,
 369         PM8607_IRQ_RTC,
 370         PM8607_IRQ_CC,
 371         PM8607_IRQ_VBAT,
 372         PM8607_IRQ_VCHG,
 373         PM8607_IRQ_VSYS,
 374         PM8607_IRQ_TINT,
 375         PM8607_IRQ_GPADC0,
 376         PM8607_IRQ_GPADC1,
 377         PM8607_IRQ_GPADC2,
 378         PM8607_IRQ_GPADC3,
 379         PM8607_IRQ_AUDIO_SHORT,
 380         PM8607_IRQ_PEN,
 381         PM8607_IRQ_HEADSET,
 382         PM8607_IRQ_HOOK,
 383         PM8607_IRQ_MICIN,
 384         PM8607_IRQ_CHG_FAIL,
 385         PM8607_IRQ_CHG_DONE,
 386         PM8607_IRQ_CHG_FAULT,
 387 };
 388
 389 enum {
 390         PM8607_CHIP_A0 = 0x40,
 391         PM8607_CHIP_A1 = 0x41,
 392         PM8607_CHIP_B0 = 0x48,
 393 };
 394
 395 struct pm860x_chip {
 396         struct device           *dev;
 397         struct mutex            irq_lock;
 398         struct mutex            osc_lock;
 399         struct i2c_client       *client;
 400         struct i2c_client       *companion;     /* companion chip client */
 401         struct regmap           *regmap;
 402         struct regmap           *regmap_companion;
 403
 404         int                     buck3_double;   /* DVC ramp slope double */
 405         unsigned short          companion_addr;
 406         unsigned short          osc_vote;
 407         int                     id;
 408         int                     irq_mode;
 409         int                     irq_base;
 410         int                     core_irq;
 411         unsigned char           chip_version;
 412         unsigned char           osc_status;
 413
 414         unsigned int            wakeup_flag;
 415 };
 416
 417 enum {
 418         GI2C_PORT = 0,
 419         PI2C_PORT,
 420 };
 421
 422 struct pm860x_backlight_pdata {
 423         int             id;
 424         int             pwm;
 425         int             iset;
 426         unsigned long   flags;
 427 };
 428
 429 struct pm860x_led_pdata {
 430         int             id;
 431         int             iset;
 432         unsigned long   flags;
 433 };
 434
 435 struct pm860x_rtc_pdata {
 436         int             (*sync)(unsigned int ticks);
 437         int             vrtc;
 438 };
 439
 440 struct pm860x_touch_pdata {
 441         int             gpadc_prebias;
 442         int             slot_cycle;
 443         int             off_scale;
 444         int             sw_cal;
 445         int             tsi_prebias;    /* time, slot */
 446         int             pen_prebias;    /* time, slot */
 447         int             pen_prechg;     /* time, slot */
 448         int             res_x;          /* resistor of Xplate */
 449         unsigned long   flags;
 450 };
 451
 452 struct pm860x_power_pdata {
 453         int             max_capacity;
 454         int             resistor;
 455 };
 456
 457 struct pm860x_platform_data {
 458         struct pm860x_backlight_pdata   *backlight;
 459         struct pm860x_led_pdata         *led;
 460         struct pm860x_rtc_pdata         *rtc;
 461         struct pm860x_touch_pdata       *touch;
 462         struct pm860x_power_pdata       *power;
 463         struct charger_desc             *chg_desc;
 464         struct regulator_init_data      *regulator;
 465
 466         unsigned short  companion_addr; /* I2C address of companion chip */
 467         int             i2c_port;       /* Controlled by GI2C or PI2C */
 468         int             irq_mode;       /* Clear interrupt by read/write(0/1) */
 469         int             irq_base;       /* IRQ base number of 88pm860x */
 470         int             num_leds;
 471         int             num_backlights;
 472         int             num_regulators;
 473 };
 474
 475 extern int pm8606_osc_enable(struct pm860x_chip *, unsigned short);
 476 extern int pm8606_osc_disable(struct pm860x_chip *, unsigned short);
 477
 478 extern int pm860x_reg_read(struct i2c_client *, int);
 479 extern int pm860x_reg_write(struct i2c_client *, int, unsigned char);
 480 extern int pm860x_bulk_read(struct i2c_client *, int, int, unsigned char *);
 481 extern int pm860x_bulk_write(struct i2c_client *, int, int, unsigned char *);
 482 extern int pm860x_set_bits(struct i2c_client *, int, unsigned char,
 483                            unsigned char);
 484 extern int pm860x_page_reg_read(struct i2c_client *, int);
 485 extern int pm860x_page_reg_write(struct i2c_client *, int, unsigned char);
 486 extern int pm860x_page_bulk_read(struct i2c_client *, int, int,
 487                                  unsigned char *);
 488 extern int pm860x_page_bulk_write(struct i2c_client *, int, int,
 489                                   unsigned char *);
 490 extern int pm860x_page_set_bits(struct i2c_client *, int, unsigned char,
 491                                 unsigned char);
 492
 493 extern int pm860x_device_init(struct pm860x_chip *chip,
 494                               struct pm860x_platform_data *pdata) __devinit ;
 495 extern void pm860x_device_exit(struct pm860x_chip *chip) __devexit ;
 496
 497 #endif /* __LINUX_MFD_88PM860X_H */