1 /* 2 * max8997.h - Driver for the Maxim 8997/8966 3 * 4 * Copyright (C) 2009-2010 Samsung Electrnoics 5 * MyungJoo Ham <[email protected]> 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 struct device_node *reg_node; 79 }; 80 81 enum max8997_muic_usb_type { 82 MAX8997_USB_HOST, 83 MAX8997_USB_DEVICE, 84 }; 85 86 enum max8997_muic_charger_type { 87 MAX8997_CHARGER_TYPE_NONE = 0, 88 MAX8997_CHARGER_TYPE_USB, 89 MAX8997_CHARGER_TYPE_DOWNSTREAM_PORT, 90 MAX8997_CHARGER_TYPE_DEDICATED_CHG, 91 MAX8997_CHARGER_TYPE_500MA, 92 MAX8997_CHARGER_TYPE_1A, 93 MAX8997_CHARGER_TYPE_DEAD_BATTERY = 7, 94 }; 95 96 struct max8997_muic_reg_data { 97 u8 addr; 98 u8 data; 99 }; 100 101 /** 102 * struct max8997_muic_platform_data 103 * @init_data: array of max8997_muic_reg_data 104 * used for initializing registers of MAX8997 MUIC device 105 * @num_init_data: array size of init_data 106 */ 107 struct max8997_muic_platform_data { 108 struct max8997_muic_reg_data *init_data; 109 int num_init_data; 110 }; 111 112 enum max8997_haptic_motor_type { 113 MAX8997_HAPTIC_ERM, 114 MAX8997_HAPTIC_LRA, 115 }; 116 117 enum max8997_haptic_pulse_mode { 118 MAX8997_EXTERNAL_MODE, 119 MAX8997_INTERNAL_MODE, 120 }; 121 122 enum max8997_haptic_pwm_divisor { 123 MAX8997_PWM_DIVISOR_32, 124 MAX8997_PWM_DIVISOR_64, 125 MAX8997_PWM_DIVISOR_128, 126 MAX8997_PWM_DIVISOR_256, 127 }; 128 129 /** 130 * max8997_haptic_platform_data 131 * @pwm_channel_id: channel number of PWM device 132 * valid for MAX8997_EXTERNAL_MODE 133 * @pwm_period: period in nano second for PWM device 134 * valid for MAX8997_EXTERNAL_MODE 135 * @type: motor type 136 * @mode: pulse mode 137 * MAX8997_EXTERNAL_MODE: external PWM device is used to control motor 138 * MAX8997_INTERNAL_MODE: internal pulse generator is used to control motor 139 * @pwm_divisor: divisor for external PWM device 140 * @internal_mode_pattern: internal mode pattern for internal mode 141 * [0 - 3]: valid pattern number 142 * @pattern_cycle: the number of cycles of the waveform 143 * for the internal mode pattern 144 * [0 - 15]: available cycles 145 * @pattern_signal_period: period of the waveform for the internal mode pattern 146 * [0 - 255]: available period 147 */ 148 struct max8997_haptic_platform_data { 149 unsigned int pwm_channel_id; 150 unsigned int pwm_period; 151 152 enum max8997_haptic_motor_type type; 153 enum max8997_haptic_pulse_mode mode; 154 enum max8997_haptic_pwm_divisor pwm_divisor; 155 156 unsigned int internal_mode_pattern; 157 unsigned int pattern_cycle; 158 unsigned int pattern_signal_period; 159 }; 160 161 enum max8997_led_mode { 162 MAX8997_NONE, 163 MAX8997_FLASH_MODE, 164 MAX8997_MOVIE_MODE, 165 MAX8997_FLASH_PIN_CONTROL_MODE, 166 MAX8997_MOVIE_PIN_CONTROL_MODE, 167 }; 168 169 /** 170 * struct max8997_led_platform_data 171 * The number of LED devices for MAX8997 is two 172 * @mode: LED mode for each LED device 173 * @brightness: initial brightness for each LED device 174 * range: 175 * [0 - 31]: MAX8997_FLASH_MODE and MAX8997_FLASH_PIN_CONTROL_MODE 176 * [0 - 15]: MAX8997_MOVIE_MODE and MAX8997_MOVIE_PIN_CONTROL_MODE 177 */ 178 struct max8997_led_platform_data { 179 enum max8997_led_mode mode[2]; 180 u8 brightness[2]; 181 }; 182 183 struct max8997_platform_data { 184 /* IRQ */ 185 int ono; 186 int wakeup; 187 188 /* ---- PMIC ---- */ 189 struct max8997_regulator_data *regulators; 190 int num_regulators; 191 192 /* 193 * SET1~3 DVS GPIOs control Buck1, 2, and 5 simultaneously. Therefore, 194 * With buckx_gpiodvs enabled, the buckx cannot be controlled 195 * independently. To control buckx (of 1, 2, and 5) independently, 196 * disable buckx_gpiodvs and control with BUCKxDVS1 register. 197 * 198 * When buckx_gpiodvs and bucky_gpiodvs are both enabled, set_voltage 199 * on buckx will change the voltage of bucky at the same time. 200 * 201 */ 202 bool ignore_gpiodvs_side_effect; 203 int buck125_gpios[3]; /* GPIO of [0]SET1, [1]SET2, [2]SET3 */ 204 int buck125_default_idx; /* Default value of SET1, 2, 3 */ 205 unsigned int buck1_voltage[8]; /* buckx_voltage in uV */ 206 bool buck1_gpiodvs; 207 unsigned int buck2_voltage[8]; 208 bool buck2_gpiodvs; 209 unsigned int buck5_voltage[8]; 210 bool buck5_gpiodvs; 211 212 /* ---- Charger control ---- */ 213 /* eoc stands for 'end of charge' */ 214 int eoc_mA; /* 50 ~ 200mA by 10mA step */ 215 /* charge Full Timeout */ 216 int timeout; /* 0 (no timeout), 5, 6, 7 hours */ 217 218 /* ---- MUIC ---- */ 219 struct max8997_muic_platform_data *muic_pdata; 220 221 /* ---- HAPTIC ---- */ 222 struct max8997_haptic_platform_data *haptic_pdata; 223 224 /* RTC: Not implemented */ 225 /* ---- LED ---- */ 226 struct max8997_led_platform_data *led_pdata; 227 }; 228 229 #endif /* __LINUX_MFD_MAX8998_H */ 230