abx500.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2009 ST-Ericsson AB
 * License terms: GNU General Public License (GPL) version 2
 *
 * ABX500 core access functions.
 * The abx500 interface is used for the Analog Baseband chips.
 *
 * Author: Mattias Wallin <[email protected]>
 * Author: Mattias Nilsson <[email protected]>
 * Author: Bengt Jonsson <[email protected]>
 * Author: Rickard Andersson <[email protected]>
 */

#include <linux/regulator/machine.h>

struct device;

#ifndef MFD_ABX500_H
#define MFD_ABX500_H

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 {
    int temp;
    int resist;
};

struct abx500_v_to_cap {
    int voltage;
    int capacity;
};

/* Forward declaration */
struct abx500_fg;

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_maxim_parameters {
    bool ena_maxi;
    int chg_curr;
    int wait_cycles;
    int charger_curr_step;
};

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 {
    int critical;
    int low;
    int normal;
    int high;
    int full;
};

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 {
    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);
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