/* * Copyright (C) 2007-2009 ST-Ericsson AB * License terms: GNU General Public License (GPL) version 2 * AB3100 core access functions * Author: Linus Walleij * * ABX500 core access functions. * The abx500 interface is used for the Analog Baseband chip * ab3100 and ab8500. * * Author: Mattias Wallin * Author: Mattias Nilsson * Author: Bengt Jonsson * Author: Rickard Andersson */ #include struct device; #ifndef MFD_ABX500_H #define MFD_ABX500_H #define AB3100_P1A 0xc0 #define AB3100_P1B 0xc1 #define AB3100_P1C 0xc2 #define AB3100_P1D 0xc3 #define AB3100_P1E 0xc4 #define AB3100_P1F 0xc5 #define AB3100_P1G 0xc6 #define AB3100_R2A 0xc7 #define AB3100_R2B 0xc8 /* * AB3100, EVENTA1, A2 and A3 event register flags * these are catenated into a single 32-bit flag in the code * for event notification broadcasts. */ #define AB3100_EVENTA1_ONSWA (0x01<<16) #define AB3100_EVENTA1_ONSWB (0x02<<16) #define AB3100_EVENTA1_ONSWC (0x04<<16) #define AB3100_EVENTA1_DCIO (0x08<<16) #define AB3100_EVENTA1_OVER_TEMP (0x10<<16) #define AB3100_EVENTA1_SIM_OFF (0x20<<16) #define AB3100_EVENTA1_VBUS (0x40<<16) #define AB3100_EVENTA1_VSET_USB (0x80<<16) #define AB3100_EVENTA2_READY_TX (0x01<<8) #define AB3100_EVENTA2_READY_RX (0x02<<8) #define AB3100_EVENTA2_OVERRUN_ERROR (0x04<<8) #define AB3100_EVENTA2_FRAMING_ERROR (0x08<<8) #define AB3100_EVENTA2_CHARG_OVERCURRENT (0x10<<8) #define AB3100_EVENTA2_MIDR (0x20<<8) #define AB3100_EVENTA2_BATTERY_REM (0x40<<8) #define AB3100_EVENTA2_ALARM (0x80<<8) #define AB3100_EVENTA3_ADC_TRIG5 (0x01) #define AB3100_EVENTA3_ADC_TRIG4 (0x02) #define AB3100_EVENTA3_ADC_TRIG3 (0x04) #define AB3100_EVENTA3_ADC_TRIG2 (0x08) #define AB3100_EVENTA3_ADC_TRIGVBAT (0x10) #define AB3100_EVENTA3_ADC_TRIGVTX (0x20) #define AB3100_EVENTA3_ADC_TRIG1 (0x40) #define AB3100_EVENTA3_ADC_TRIG0 (0x80) /* AB3100, STR register flags */ #define AB3100_STR_ONSWA (0x01) #define AB3100_STR_ONSWB (0x02) #define AB3100_STR_ONSWC (0x04) #define AB3100_STR_DCIO (0x08) #define AB3100_STR_BOOT_MODE (0x10) #define AB3100_STR_SIM_OFF (0x20) #define AB3100_STR_BATT_REMOVAL (0x40) #define AB3100_STR_VBUS (0x80) /* * AB3100 contains 8 regulators, one external regulator controller * and a buck converter, further the LDO E and buck converter can * have separate settings if they are in sleep mode, this is * modeled as a separate regulator. */ #define AB3100_NUM_REGULATORS 10 /** * struct ab3100 * @access_mutex: lock out concurrent accesses to the AB3100 registers * @dev: pointer to the containing device * @i2c_client: I2C client for this chip * @testreg_client: secondary client for test registers * @chip_name: name of this chip variant * @chip_id: 8 bit chip ID for this chip variant * @event_subscribers: event subscribers are listed here * @startup_events: a copy of the first reading of the event registers * @startup_events_read: whether the first events have been read * * This struct is PRIVATE and devices using it should NOT * access ANY fields. It is used as a token for calling the * AB3100 functions. */ struct ab3100 { struct mutex access_mutex; struct device *dev; struct i2c_client *i2c_client; struct i2c_client *testreg_client; char chip_name[32]; u8 chip_id; struct blocking_notifier_head event_subscribers; u8 startup_events[3]; bool startup_events_read; }; /** * struct ab3100_platform_data * Data supplied to initialize board connections to the AB3100 * @reg_constraints: regulator constraints for target board * the order of these constraints are: LDO A, C, D, E, * F, G, H, K, EXT and BUCK. * @reg_initvals: initial values for the regulator registers * plus two sleep settings for LDO E and the BUCK converter. * exactly AB3100_NUM_REGULATORS+2 values must be sent in. * Order: LDO A, C, E, E sleep, F, G, H, K, EXT, BUCK, * BUCK sleep, LDO D. (LDO D need to be initialized last.) * @external_voltage: voltage level of the external regulator. */ struct ab3100_platform_data { struct regulator_init_data reg_constraints[AB3100_NUM_REGULATORS]; u8 reg_initvals[AB3100_NUM_REGULATORS+2]; int external_voltage; }; int ab3100_event_register(struct ab3100 *ab3100, struct notifier_block *nb); int ab3100_event_unregister(struct ab3100 *ab3100, struct notifier_block *nb); /** * struct abx500_init_setting * Initial value of the registers for driver to use during setup. */ struct abx500_init_settings { u8 bank; u8 reg; u8 setting; }; /* Battery driver related data */ /* * ADC for the battery thermistor. * When using the ABx500_ADC_THERM_BATCTRL the battery ID resistor is combined * with a NTC resistor to both identify the battery and to measure its * temperature. Different phone manufactures uses different techniques to both * identify the battery and to read its temperature. */ enum abx500_adc_therm { ABx500_ADC_THERM_BATCTRL, ABx500_ADC_THERM_BATTEMP, }; /** * struct abx500_res_to_temp - defines one point in a temp to res curve. To * be used in battery packs that combines the identification resistor with a * NTC resistor. * @temp: battery pack temperature in Celcius * @resist: NTC resistor net total resistance */ struct abx500_res_to_temp { int temp; int resist; }; /** * struct abx500_v_to_cap - Table for translating voltage to capacity * @voltage: Voltage in mV * @capacity: Capacity in percent */ struct abx500_v_to_cap { int voltage; int capacity; }; /* Forward declaration */ struct abx500_fg; /** * struct abx500_fg_parameters - Fuel gauge algorithm parameters, in seconds * if not specified * @recovery_sleep_timer: Time between measurements while recovering * @recovery_total_time: Total recovery time * @init_timer: Measurement interval during startup * @init_discard_time: Time we discard voltage measurement at startup * @init_total_time: Total init time during startup * @high_curr_time: Time current has to be high to go to recovery * @accu_charging: FG accumulation time while charging * @accu_high_curr: FG accumulation time in high current mode * @high_curr_threshold: High current threshold, in mA * @lowbat_threshold: Low battery threshold, in mV * @overbat_threshold: Over battery threshold, in mV * @battok_falling_th_sel0 Threshold in mV for battOk signal sel0 * Resolution in 50 mV step. * @battok_raising_th_sel1 Threshold in mV for battOk signal sel1 * Resolution in 50 mV step. * @user_cap_limit Capacity reported from user must be within this * limit to be considered as sane, in percentage * points. * @maint_thres This is the threshold where we stop reporting * battery full while in maintenance, in per cent */ struct abx500_fg_parameters { int recovery_sleep_timer; int recovery_total_time; int init_timer; int init_discard_time; int init_total_time; int high_curr_time; int accu_charging; int accu_high_curr; int high_curr_threshold; int lowbat_threshold; int overbat_threshold; int battok_falling_th_sel0; int battok_raising_th_sel1; int user_cap_limit; int maint_thres; }; /** * struct abx500_charger_maximization - struct used by the board config. * @use_maxi: Enable maximization for this battery type * @maxi_chg_curr: Maximum charger current allowed * @maxi_wait_cycles: cycles to wait before setting charger current * @charger_curr_step delta between two charger current settings (mA) */ struct abx500_maxim_parameters { bool ena_maxi; int chg_curr; int wait_cycles; int charger_curr_step; }; /** * struct abx500_battery_type - different batteries supported * @name: battery technology * @resis_high: battery upper resistance limit * @resis_low: battery lower resistance limit * @charge_full_design: Maximum battery capacity in mAh * @nominal_voltage: Nominal voltage of the battery in mV * @termination_vol: max voltage upto which battery can be charged * @termination_curr battery charging termination current in mA * @recharge_vol battery voltage limit that will trigger a new * full charging cycle in the case where maintenan- * -ce charging has been disabled * @normal_cur_lvl: charger current in normal state in mA * @normal_vol_lvl: charger voltage in normal state in mV * @maint_a_cur_lvl: charger current in maintenance A state in mA * @maint_a_vol_lvl: charger voltage in maintenance A state in mV * @maint_a_chg_timer_h: charge time in maintenance A state * @maint_b_cur_lvl: charger current in maintenance B state in mA * @maint_b_vol_lvl: charger voltage in maintenance B state in mV * @maint_b_chg_timer_h: charge time in maintenance B state * @low_high_cur_lvl: charger current in temp low/high state in mA * @low_high_vol_lvl: charger voltage in temp low/high state in mV' * @battery_resistance: battery inner resistance in mOhm. * @n_r_t_tbl_elements: number of elements in r_to_t_tbl * @r_to_t_tbl: table containing resistance to temp points * @n_v_cap_tbl_elements: number of elements in v_to_cap_tbl * @v_to_cap_tbl: Voltage to capacity (in %) table * @n_batres_tbl_elements number of elements in the batres_tbl * @batres_tbl battery internal resistance vs temperature table */ struct abx500_battery_type { int name; int resis_high; int resis_low; int charge_full_design; int nominal_voltage; int termination_vol; int termination_curr; int recharge_vol; int normal_cur_lvl; int normal_vol_lvl; int maint_a_cur_lvl; int maint_a_vol_lvl; int maint_a_chg_timer_h; int maint_b_cur_lvl; int maint_b_vol_lvl; int maint_b_chg_timer_h; int low_high_cur_lvl; int low_high_vol_lvl; int battery_resistance; int n_temp_tbl_elements; struct abx500_res_to_temp *r_to_t_tbl; int n_v_cap_tbl_elements; struct abx500_v_to_cap *v_to_cap_tbl; int n_batres_tbl_elements; struct batres_vs_temp *batres_tbl; }; /** * struct abx500_bm_capacity_levels - abx500 capacity level data * @critical: critical capacity level in percent * @low: low capacity level in percent * @normal: normal capacity level in percent * @high: high capacity level in percent * @full: full capacity level in percent */ struct abx500_bm_capacity_levels { int critical; int low; int normal; int high; int full; }; /** * struct abx500_bm_charger_parameters - Charger specific parameters * @usb_volt_max: maximum allowed USB charger voltage in mV * @usb_curr_max: maximum allowed USB charger current in mA * @ac_volt_max: maximum allowed AC charger voltage in mV * @ac_curr_max: maximum allowed AC charger current in mA */ struct abx500_bm_charger_parameters { int usb_volt_max; int usb_curr_max; int ac_volt_max; int ac_curr_max; }; /** * struct abx500_bm_data - abx500 battery management data * @temp_under under this temp, charging is stopped * @temp_low between this temp and temp_under charging is reduced * @temp_high between this temp and temp_over charging is reduced * @temp_over over this temp, charging is stopped * @temp_now present battery temperature * @temp_interval_chg temperature measurement interval in s when charging * @temp_interval_nochg temperature measurement interval in s when not charging * @main_safety_tmr_h safety timer for main charger * @usb_safety_tmr_h safety timer for usb charger * @bkup_bat_v voltage which we charge the backup battery with * @bkup_bat_i current which we charge the backup battery with * @no_maintenance indicates that maintenance charging is disabled * @abx500_adc_therm placement of thermistor, batctrl or battemp adc * @chg_unknown_bat flag to enable charging of unknown batteries * @enable_overshoot flag to enable VBAT overshoot control * @auto_trig flag to enable auto adc trigger * @fg_res resistance of FG resistor in 0.1mOhm * @n_btypes number of elements in array bat_type * @batt_id index of the identified battery in array bat_type * @interval_charging charge alg cycle period time when charging (sec) * @interval_not_charging charge alg cycle period time when not charging (sec) * @temp_hysteresis temperature hysteresis * @gnd_lift_resistance Battery ground to phone ground resistance (mOhm) * @maxi: maximization parameters * @cap_levels capacity in percent for the different capacity levels * @bat_type table of supported battery types * @chg_params charger parameters * @fg_params fuel gauge parameters */ struct abx500_bm_data { int temp_under; int temp_low; int temp_high; int temp_over; int temp_now; int temp_interval_chg; int temp_interval_nochg; int main_safety_tmr_h; int usb_safety_tmr_h; int bkup_bat_v; int bkup_bat_i; bool no_maintenance; bool chg_unknown_bat; bool enable_overshoot; bool auto_trig; enum abx500_adc_therm adc_therm; int fg_res; int n_btypes; int batt_id; int interval_charging; int interval_not_charging; int temp_hysteresis; int gnd_lift_resistance; const struct abx500_maxim_parameters *maxi; const struct abx500_bm_capacity_levels *cap_levels; const struct abx500_battery_type *bat_type; const struct abx500_bm_charger_parameters *chg_params; const struct abx500_fg_parameters *fg_params; }; struct abx500_chargalg_platform_data { char **supplied_to; size_t num_supplicants; }; struct abx500_charger_platform_data { char **supplied_to; size_t num_supplicants; bool autopower_cfg; }; struct abx500_btemp_platform_data { char **supplied_to; size_t num_supplicants; }; struct abx500_fg_platform_data { char **supplied_to; size_t num_supplicants; }; struct abx500_bm_plat_data { struct abx500_bm_data *battery; struct abx500_charger_platform_data *charger; struct abx500_btemp_platform_data *btemp; struct abx500_fg_platform_data *fg; struct abx500_chargalg_platform_data *chargalg; }; int abx500_set_register_interruptible(struct device *dev, u8 bank, u8 reg, u8 value); int abx500_get_register_interruptible(struct device *dev, u8 bank, u8 reg, u8 *value); int abx500_get_register_page_interruptible(struct device *dev, u8 bank, u8 first_reg, u8 *regvals, u8 numregs); int abx500_set_register_page_interruptible(struct device *dev, u8 bank, u8 first_reg, u8 *regvals, u8 numregs); /** * abx500_mask_and_set_register_inerruptible() - Modifies selected bits of a * target register * * @dev: The AB sub device. * @bank: The i2c bank number. * @bitmask: The bit mask to use. * @bitvalues: The new bit values. * * Updates the value of an AB register: * value -> ((value & ~bitmask) | (bitvalues & bitmask)) */ int abx500_mask_and_set_register_interruptible(struct device *dev, u8 bank, u8 reg, u8 bitmask, u8 bitvalues); int abx500_get_chip_id(struct device *dev); int abx500_event_registers_startup_state_get(struct device *dev, u8 *event); int abx500_startup_irq_enabled(struct device *dev, unsigned int irq); struct abx500_ops { int (*get_chip_id) (struct device *); int (*get_register) (struct device *, u8, u8, u8 *); int (*set_register) (struct device *, u8, u8, u8); int (*get_register_page) (struct device *, u8, u8, u8 *, u8); int (*set_register_page) (struct device *, u8, u8, u8 *, u8); int (*mask_and_set_register) (struct device *, u8, u8, u8, u8); int (*event_registers_startup_state_get) (struct device *, u8 *); int (*startup_irq_enabled) (struct device *, unsigned int); }; int abx500_register_ops(struct device *core_dev, struct abx500_ops *ops); void abx500_remove_ops(struct device *dev); #endif