LXR linux/include/linux/mfd/adp5520.h

   1/*
   2 * Definitions and platform data for Analog Devices
   3 * ADP5520/ADP5501 MFD PMICs (Backlight, LED, GPIO and Keys)
   4 *
   5 * Copyright 2009 Analog Devices Inc.
   6 *
   7 * Licensed under the GPL-2 or later.
   8 */
   9
  10
  11#ifndef __LINUX_MFD_ADP5520_H
  12#define __LINUX_MFD_ADP5520_H
  13
  14#define ID_ADP5520              5520
  15#define ID_ADP5501              5501
  16
  17/*
  18 * ADP5520/ADP5501 Register Map
  19 */
  20
  21#define ADP5520_MODE_STATUS             0x00
  22#define ADP5520_INTERRUPT_ENABLE        0x01
  23#define ADP5520_BL_CONTROL              0x02
  24#define ADP5520_BL_TIME                 0x03
  25#define ADP5520_BL_FADE                 0x04
  26#define ADP5520_DAYLIGHT_MAX            0x05
  27#define ADP5520_DAYLIGHT_DIM            0x06
  28#define ADP5520_OFFICE_MAX              0x07
  29#define ADP5520_OFFICE_DIM              0x08
  30#define ADP5520_DARK_MAX                0x09
  31#define ADP5520_DARK_DIM                0x0A
  32#define ADP5520_BL_VALUE                0x0B
  33#define ADP5520_ALS_CMPR_CFG            0x0C
  34#define ADP5520_L2_TRIP                 0x0D
  35#define ADP5520_L2_HYS                  0x0E
  36#define ADP5520_L3_TRIP                 0x0F
  37#define ADP5520_L3_HYS                  0x10
  38#define ADP5520_LED_CONTROL             0x11
  39#define ADP5520_LED_TIME                0x12
  40#define ADP5520_LED_FADE                0x13
  41#define ADP5520_LED1_CURRENT            0x14
  42#define ADP5520_LED2_CURRENT            0x15
  43#define ADP5520_LED3_CURRENT            0x16
  44
  45/*
  46 * ADP5520 Register Map
  47 */
  48
  49#define ADP5520_GPIO_CFG_1              0x17
  50#define ADP5520_GPIO_CFG_2              0x18
  51#define ADP5520_GPIO_IN                 0x19
  52#define ADP5520_GPIO_OUT                0x1A
  53#define ADP5520_GPIO_INT_EN             0x1B
  54#define ADP5520_GPIO_INT_STAT           0x1C
  55#define ADP5520_GPIO_INT_LVL            0x1D
  56#define ADP5520_GPIO_DEBOUNCE           0x1E
  57#define ADP5520_GPIO_PULLUP             0x1F
  58#define ADP5520_KP_INT_STAT_1           0x20
  59#define ADP5520_KP_INT_STAT_2           0x21
  60#define ADP5520_KR_INT_STAT_1           0x22
  61#define ADP5520_KR_INT_STAT_2           0x23
  62#define ADP5520_KEY_STAT_1              0x24
  63#define ADP5520_KEY_STAT_2              0x25
  64
  65/*
  66 * MODE_STATUS bits
  67 */
  68
  69#define ADP5520_nSTNBY          (1 << 7)
  70#define ADP5520_BL_EN           (1 << 6)
  71#define ADP5520_DIM_EN          (1 << 5)
  72#define ADP5520_OVP_INT         (1 << 4)
  73#define ADP5520_CMPR_INT        (1 << 3)
  74#define ADP5520_GPI_INT         (1 << 2)
  75#define ADP5520_KR_INT          (1 << 1)
  76#define ADP5520_KP_INT          (1 << 0)
  77
  78/*
  79 * INTERRUPT_ENABLE bits
  80 */
  81
  82#define ADP5520_AUTO_LD_EN      (1 << 4)
  83#define ADP5520_CMPR_IEN        (1 << 3)
  84#define ADP5520_OVP_IEN         (1 << 2)
  85#define ADP5520_KR_IEN          (1 << 1)
  86#define ADP5520_KP_IEN          (1 << 0)
  87
  88/*
  89 * BL_CONTROL bits
  90 */
  91
  92#define ADP5520_BL_LVL          ((x) << 5)
  93#define ADP5520_BL_LAW          ((x) << 4)
  94#define ADP5520_BL_AUTO_ADJ     (1 << 3)
  95#define ADP5520_OVP_EN          (1 << 2)
  96#define ADP5520_FOVR            (1 << 1)
  97#define ADP5520_KP_BL_EN        (1 << 0)
  98
  99/*
 100 * ALS_CMPR_CFG bits
 101 */
 102
 103#define ADP5520_L3_OUT          (1 << 3)
 104#define ADP5520_L2_OUT          (1 << 2)
 105#define ADP5520_L3_EN           (1 << 1)
 106
 107#define ADP5020_MAX_BRIGHTNESS  0x7F
 108
 109#define FADE_VAL(in, out)       ((0xF & (in)) | ((0xF & (out)) << 4))
 110#define BL_CTRL_VAL(law, auto)  (((1 & (auto)) << 3) | ((0x3 & (law)) << 4))
 111#define ALS_CMPR_CFG_VAL(filt, l3_en)   (((0x7 & filt) << 5) | l3_en)
 112
 113/*
 114 * LEDs subdevice bits and masks
 115 */
 116
 117#define ADP5520_01_MAXLEDS 3
 118
 119#define ADP5520_FLAG_LED_MASK           0x3
 120#define ADP5520_FLAG_OFFT_SHIFT         8
 121#define ADP5520_FLAG_OFFT_MASK          0x3
 122
 123#define ADP5520_R3_MODE         (1 << 5)
 124#define ADP5520_C3_MODE         (1 << 4)
 125#define ADP5520_LED_LAW         (1 << 3)
 126#define ADP5520_LED3_EN         (1 << 2)
 127#define ADP5520_LED2_EN         (1 << 1)
 128#define ADP5520_LED1_EN         (1 << 0)
 129
 130/*
 131 * GPIO subdevice bits and masks
 132 */
 133
 134#define ADP5520_MAXGPIOS        8
 135
 136#define ADP5520_GPIO_C3         (1 << 7)        /* LED2 or GPIO7 aka C3 */
 137#define ADP5520_GPIO_C2         (1 << 6)
 138#define ADP5520_GPIO_C1         (1 << 5)
 139#define ADP5520_GPIO_C0         (1 << 4)
 140#define ADP5520_GPIO_R3         (1 << 3)        /* LED3 or GPIO3 aka R3 */
 141#define ADP5520_GPIO_R2         (1 << 2)
 142#define ADP5520_GPIO_R1         (1 << 1)
 143#define ADP5520_GPIO_R0         (1 << 0)
 144
 145struct adp5520_gpio_platform_data {
 146        unsigned gpio_start;
 147        u8 gpio_en_mask;
 148        u8 gpio_pullup_mask;
 149};
 150
 151/*
 152 * Keypad subdevice bits and masks
 153 */
 154
 155#define ADP5520_MAXKEYS 16
 156
 157#define ADP5520_COL_C3          (1 << 7)        /* LED2 or GPIO7 aka C3 */
 158#define ADP5520_COL_C2          (1 << 6)
 159#define ADP5520_COL_C1          (1 << 5)
 160#define ADP5520_COL_C0          (1 << 4)
 161#define ADP5520_ROW_R3          (1 << 3)        /* LED3 or GPIO3 aka R3 */
 162#define ADP5520_ROW_R2          (1 << 2)
 163#define ADP5520_ROW_R1          (1 << 1)
 164#define ADP5520_ROW_R0          (1 << 0)
 165
 166#define ADP5520_KEY(row, col) (col + row * 4)
 167#define ADP5520_KEYMAPSIZE      ADP5520_MAXKEYS
 168
 169struct adp5520_keys_platform_data {
 170        int rows_en_mask;               /* Number of rows */
 171        int cols_en_mask;               /* Number of columns */
 172        const unsigned short *keymap;   /* Pointer to keymap */
 173        unsigned short keymapsize;      /* Keymap size */
 174        unsigned repeat:1;              /* Enable key repeat */
 175};
 176
 177
 178/*
 179 * LEDs subdevice platform data
 180 */
 181
 182#define FLAG_ID_ADP5520_LED1_ADP5501_LED0       1       /* ADP5520 PIN ILED */
 183#define FLAG_ID_ADP5520_LED2_ADP5501_LED1       2       /* ADP5520 PIN C3 */
 184#define FLAG_ID_ADP5520_LED3_ADP5501_LED2       3       /* ADP5520 PIN R3 */
 185
 186#define ADP5520_LED_DIS_BLINK   (0 << ADP5520_FLAG_OFFT_SHIFT)
 187#define ADP5520_LED_OFFT_600ms  (1 << ADP5520_FLAG_OFFT_SHIFT)
 188#define ADP5520_LED_OFFT_800ms  (2 << ADP5520_FLAG_OFFT_SHIFT)
 189#define ADP5520_LED_OFFT_1200ms (3 << ADP5520_FLAG_OFFT_SHIFT)
 190
 191#define ADP5520_LED_ONT_200ms   0
 192#define ADP5520_LED_ONT_600ms   1
 193#define ADP5520_LED_ONT_800ms   2
 194#define ADP5520_LED_ONT_1200ms  3
 195
 196struct adp5520_leds_platform_data {
 197        int num_leds;
 198        struct led_info *leds;
 199        u8 fade_in;             /* Backlight Fade-In Timer */
 200        u8 fade_out;            /* Backlight Fade-Out Timer */
 201        u8 led_on_time;
 202};
 203
 204/*
 205 * Backlight subdevice platform data
 206 */
 207
 208#define ADP5520_FADE_T_DIS      0       /* Fade Timer Disabled */
 209#define ADP5520_FADE_T_300ms    1       /* 0.3 Sec */
 210#define ADP5520_FADE_T_600ms    2
 211#define ADP5520_FADE_T_900ms    3
 212#define ADP5520_FADE_T_1200ms   4
 213#define ADP5520_FADE_T_1500ms   5
 214#define ADP5520_FADE_T_1800ms   6
 215#define ADP5520_FADE_T_2100ms   7
 216#define ADP5520_FADE_T_2400ms   8
 217#define ADP5520_FADE_T_2700ms   9
 218#define ADP5520_FADE_T_3000ms   10
 219#define ADP5520_FADE_T_3500ms   11
 220#define ADP5520_FADE_T_4000ms   12
 221#define ADP5520_FADE_T_4500ms   13
 222#define ADP5520_FADE_T_5000ms   14
 223#define ADP5520_FADE_T_5500ms   15      /* 5.5 Sec */
 224
 225#define ADP5520_BL_LAW_LINEAR   0
 226#define ADP5520_BL_LAW_SQUARE   1
 227#define ADP5520_BL_LAW_CUBIC1   2
 228#define ADP5520_BL_LAW_CUBIC2   3
 229
 230#define ADP5520_BL_AMBL_FILT_80ms       0       /* Light sensor filter time */
 231#define ADP5520_BL_AMBL_FILT_160ms      1
 232#define ADP5520_BL_AMBL_FILT_320ms      2
 233#define ADP5520_BL_AMBL_FILT_640ms      3
 234#define ADP5520_BL_AMBL_FILT_1280ms     4
 235#define ADP5520_BL_AMBL_FILT_2560ms     5
 236#define ADP5520_BL_AMBL_FILT_5120ms     6
 237#define ADP5520_BL_AMBL_FILT_10240ms    7       /* 10.24 sec */
 238
 239        /*
 240         * Blacklight current 0..30mA
 241         */
 242#define ADP5520_BL_CUR_mA(I)            ((I * 127) / 30)
 243
 244        /*
 245         * L2 comparator current 0..1000uA
 246         */
 247#define ADP5520_L2_COMP_CURR_uA(I)      ((I * 255) / 1000)
 248
 249        /*
 250         * L3 comparator current 0..127uA
 251         */
 252#define ADP5520_L3_COMP_CURR_uA(I)      ((I * 255) / 127)
 253
 254struct adp5520_backlight_platform_data {
 255        u8 fade_in;             /* Backlight Fade-In Timer */
 256        u8 fade_out;            /* Backlight Fade-Out Timer */
 257        u8 fade_led_law;        /* fade-on/fade-off transfer characteristic */
 258
 259        u8 en_ambl_sens;        /* 1 = enable ambient light sensor */
 260        u8 abml_filt;           /* Light sensor filter time */
 261        u8 l1_daylight_max;     /* use BL_CUR_mA(I) 0 <= I <= 30 mA */
 262        u8 l1_daylight_dim;     /* typ = 0, use BL_CUR_mA(I) 0 <= I <= 30 mA */
 263        u8 l2_office_max;       /* use BL_CUR_mA(I) 0 <= I <= 30 mA */
 264        u8 l2_office_dim;       /* typ = 0, use BL_CUR_mA(I) 0 <= I <= 30 mA */
 265        u8 l3_dark_max;         /* use BL_CUR_mA(I) 0 <= I <= 30 mA */
 266        u8 l3_dark_dim;         /* typ = 0, use BL_CUR_mA(I) 0 <= I <= 30 mA */
 267        u8 l2_trip;             /* use L2_COMP_CURR_uA(I) 0 <= I <= 1000 uA */
 268        u8 l2_hyst;             /* use L2_COMP_CURR_uA(I) 0 <= I <= 1000 uA */
 269        u8 l3_trip;             /* use L3_COMP_CURR_uA(I) 0 <= I <= 127 uA */
 270        u8 l3_hyst;             /* use L3_COMP_CURR_uA(I) 0 <= I <= 127 uA */
 271};
 272
 273/*
 274 * MFD chip platform data
 275 */
 276
 277struct adp5520_platform_data {
 278        struct adp5520_keys_platform_data *keys;
 279        struct adp5520_gpio_platform_data *gpio;
 280        struct adp5520_leds_platform_data *leds;
 281        struct adp5520_backlight_platform_data *backlight;
 282};
 283
 284/*
 285 * MFD chip functions
 286 */
 287
 288extern int adp5520_read(struct device *dev, int reg, uint8_t *val);
 289extern int adp5520_write(struct device *dev, int reg, u8 val);
 290extern int adp5520_clr_bits(struct device *dev, int reg, uint8_t bit_mask);
 291extern int adp5520_set_bits(struct device *dev, int reg, uint8_t bit_mask);
 292
 293extern int adp5520_register_notifier(struct device *dev,
 294                 struct notifier_block *nb, unsigned int events);
 295
 296extern int adp5520_unregister_notifier(struct device *dev,
 297                struct notifier_block *nb, unsigned int events);
 298
 299#endif /* __LINUX_MFD_ADP5520_H */
 300