1 /* 2 * max8997.h - Driver for the Maxim 8997/8966 3 * 4 * Copyright (C) 2009-2010 Samsung Electrnoics 5 * MyungJoo Ham <myungjoo.ham@samsung.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 as published by 9 * the Free Software Foundation; either version 2 of the License, or 10 * (at your option) any later version. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 20 * 21 * This driver is based on max8998.h 22 * 23 * MAX8997 has PMIC, MUIC, HAPTIC, RTC, FLASH, and Fuel Gauge devices. 24 * Except Fuel Gauge, every device shares the same I2C bus and included in 25 * this mfd driver. Although the fuel gauge is included in the chip, it is 26 * excluded from the driver because a) it has a different I2C bus from 27 * others and b) it can be enabled simply by using MAX17042 driver. 28 */ 29 30 #ifndef __LINUX_MFD_MAX8998_H 31 #define __LINUX_MFD_MAX8998_H 32 33 #include <linux/regulator/consumer.h> 34 35 /* MAX8997/8966 regulator IDs */ 36 enum max8998_regulators { 37 MAX8997_LDO1 = 0, 38 MAX8997_LDO2, 39 MAX8997_LDO3, 40 MAX8997_LDO4, 41 MAX8997_LDO5, 42 MAX8997_LDO6, 43 MAX8997_LDO7, 44 MAX8997_LDO8, 45 MAX8997_LDO9, 46 MAX8997_LDO10, 47 MAX8997_LDO11, 48 MAX8997_LDO12, 49 MAX8997_LDO13, 50 MAX8997_LDO14, 51 MAX8997_LDO15, 52 MAX8997_LDO16, 53 MAX8997_LDO17, 54 MAX8997_LDO18, 55 MAX8997_LDO21, 56 MAX8997_BUCK1, 57 MAX8997_BUCK2, 58 MAX8997_BUCK3, 59 MAX8997_BUCK4, 60 MAX8997_BUCK5, 61 MAX8997_BUCK6, 62 MAX8997_BUCK7, 63 MAX8997_EN32KHZ_AP, 64 MAX8997_EN32KHZ_CP, 65 MAX8997_ENVICHG, 66 MAX8997_ESAFEOUT1, 67 MAX8997_ESAFEOUT2, 68 MAX8997_CHARGER_CV, /* control MBCCV of MBCCTRL3 */ 69 MAX8997_CHARGER, /* charger current, MBCCTRL4 */ 70 MAX8997_CHARGER_TOPOFF, /* MBCCTRL5 */ 71 72 MAX8997_REG_MAX, 73 }; 74 75 struct max8997_regulator_data { 76 int id; 77 struct regulator_init_data *initdata; 78 }; 79 80 enum max8997_muic_usb_type { 81 MAX8997_USB_HOST, 82 MAX8997_USB_DEVICE, 83 }; 84 85 enum max8997_muic_charger_type { 86 MAX8997_CHARGER_TYPE_NONE = 0, 87 MAX8997_CHARGER_TYPE_USB, 88 MAX8997_CHARGER_TYPE_DOWNSTREAM_PORT, 89 MAX8997_CHARGER_TYPE_DEDICATED_CHG, 90 MAX8997_CHARGER_TYPE_500MA, 91 MAX8997_CHARGER_TYPE_1A, 92 MAX8997_CHARGER_TYPE_DEAD_BATTERY = 7, 93 }; 94 95 struct max8997_muic_reg_data { 96 u8 addr; 97 u8 data; 98 }; 99 100 /** 101 * struct max8997_muic_platform_data 102 * @usb_callback: callback function for USB 103 * inform callee of USB type (HOST or DEVICE) 104 * and attached state(true or false) 105 * @charger_callback: callback function for charger 106 * inform callee of charger_type 107 * and attached state(true or false) 108 * @deskdock_callback: callback function for desk dock 109 * inform callee of attached state(true or false) 110 * @cardock_callback: callback function for car dock 111 * inform callee of attached state(true or false) 112 * @mhl_callback: callback function for MHL (Mobile High-definition Link) 113 * inform callee of attached state(true or false) 114 * @uart_callback: callback function for JIG UART 115 * inform callee of attached state(true or false) 116 * @init_data: array of max8997_muic_reg_data 117 * used for initializing registers of MAX8997 MUIC device 118 * @num_init_data: array size of init_data 119 */ 120 struct max8997_muic_platform_data { 121 void (*usb_callback)(enum max8997_muic_usb_type usb_type, 122 bool attached); 123 void (*charger_callback)(bool attached, 124 enum max8997_muic_charger_type charger_type); 125 void (*deskdock_callback) (bool attached); 126 void (*cardock_callback) (bool attached); 127 void (*mhl_callback) (bool attached); 128 void (*uart_callback) (bool attached); 129 130 struct max8997_muic_reg_data *init_data; 131 int num_init_data; 132 }; 133 134 enum max8997_haptic_motor_type { 135 MAX8997_HAPTIC_ERM, 136 MAX8997_HAPTIC_LRA, 137 }; 138 139 enum max8997_haptic_pulse_mode { 140 MAX8997_EXTERNAL_MODE, 141 MAX8997_INTERNAL_MODE, 142 }; 143 144 enum max8997_haptic_pwm_divisor { 145 MAX8997_PWM_DIVISOR_32, 146 MAX8997_PWM_DIVISOR_64, 147 MAX8997_PWM_DIVISOR_128, 148 MAX8997_PWM_DIVISOR_256, 149 }; 150 151 /** 152 * max8997_haptic_platform_data 153 * @pwm_channel_id: channel number of PWM device 154 * valid for MAX8997_EXTERNAL_MODE 155 * @pwm_period: period in nano second for PWM device 156 * valid for MAX8997_EXTERNAL_MODE 157 * @type: motor type 158 * @mode: pulse mode 159 * MAX8997_EXTERNAL_MODE: external PWM device is used to control motor 160 * MAX8997_INTERNAL_MODE: internal pulse generator is used to control motor 161 * @pwm_divisor: divisor for external PWM device 162 * @internal_mode_pattern: internal mode pattern for internal mode 163 * [0 - 3]: valid pattern number 164 * @pattern_cycle: the number of cycles of the waveform 165 * for the internal mode pattern 166 * [0 - 15]: available cycles 167 * @pattern_signal_period: period of the waveform for the internal mode pattern 168 * [0 - 255]: available period 169 */ 170 struct max8997_haptic_platform_data { 171 unsigned int pwm_channel_id; 172 unsigned int pwm_period; 173 174 enum max8997_haptic_motor_type type; 175 enum max8997_haptic_pulse_mode mode; 176 enum max8997_haptic_pwm_divisor pwm_divisor; 177 178 unsigned int internal_mode_pattern; 179 unsigned int pattern_cycle; 180 unsigned int pattern_signal_period; 181 }; 182 183 enum max8997_led_mode { 184 MAX8997_NONE, 185 MAX8997_FLASH_MODE, 186 MAX8997_MOVIE_MODE, 187 MAX8997_FLASH_PIN_CONTROL_MODE, 188 MAX8997_MOVIE_PIN_CONTROL_MODE, 189 }; 190 191 /** 192 * struct max8997_led_platform_data 193 * The number of LED devices for MAX8997 is two 194 * @mode: LED mode for each LED device 195 * @brightness: initial brightness for each LED device 196 * range: 197 * [0 - 31]: MAX8997_FLASH_MODE and MAX8997_FLASH_PIN_CONTROL_MODE 198 * [0 - 15]: MAX8997_MOVIE_MODE and MAX8997_MOVIE_PIN_CONTROL_MODE 199 */ 200 struct max8997_led_platform_data { 201 enum max8997_led_mode mode[2]; 202 u8 brightness[2]; 203 }; 204 205 struct max8997_platform_data { 206 /* IRQ */ 207 int irq_base; 208 int ono; 209 int wakeup; 210 211 /* ---- PMIC ---- */ 212 struct max8997_regulator_data *regulators; 213 int num_regulators; 214 215 /* 216 * SET1~3 DVS GPIOs control Buck1, 2, and 5 simultaneously. Therefore, 217 * With buckx_gpiodvs enabled, the buckx cannot be controlled 218 * independently. To control buckx (of 1, 2, and 5) independently, 219 * disable buckx_gpiodvs and control with BUCKxDVS1 register. 220 * 221 * When buckx_gpiodvs and bucky_gpiodvs are both enabled, set_voltage 222 * on buckx will change the voltage of bucky at the same time. 223 * 224 */ 225 bool ignore_gpiodvs_side_effect; 226 int buck125_gpios[3]; /* GPIO of [0]SET1, [1]SET2, [2]SET3 */ 227 int buck125_default_idx; /* Default value of SET1, 2, 3 */ 228 unsigned int buck1_voltage[8]; /* buckx_voltage in uV */ 229 bool buck1_gpiodvs; 230 unsigned int buck2_voltage[8]; 231 bool buck2_gpiodvs; 232 unsigned int buck5_voltage[8]; 233 bool buck5_gpiodvs; 234 235 /* ---- Charger control ---- */ 236 /* eoc stands for 'end of charge' */ 237 int eoc_mA; /* 50 ~ 200mA by 10mA step */ 238 /* charge Full Timeout */ 239 int timeout; /* 0 (no timeout), 5, 6, 7 hours */ 240 241 /* ---- MUIC ---- */ 242 struct max8997_muic_platform_data *muic_pdata; 243 244 /* ---- HAPTIC ---- */ 245 struct max8997_haptic_platform_data *haptic_pdata; 246 247 /* RTC: Not implemented */ 248 /* ---- LED ---- */ 249 struct max8997_led_platform_data *led_pdata; 250 }; 251 252 #endif /* __LINUX_MFD_MAX8998_H */ 253