charger-manager.h

Go to the documentation of this file.

/*
 * Copyright (C) 2011 Samsung Electronics Co., Ltd.
 * MyungJoo.Ham <[email protected]>
 *
 * Charger Manager.
 * This framework enables to control and multiple chargers and to
 * monitor charging even in the context of suspend-to-RAM with
 * an interface combining the chargers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
**/

#ifndef _CHARGER_MANAGER_H
#define _CHARGER_MANAGER_H

#include <linux/power_supply.h>
#include <linux/extcon.h>

enum data_source {
    CM_BATTERY_PRESENT,
    CM_NO_BATTERY,
    CM_FUEL_GAUGE,
    CM_CHARGER_STAT,
};

enum polling_modes {
    CM_POLL_DISABLE = 0,
    CM_POLL_ALWAYS,
    CM_POLL_EXTERNAL_POWER_ONLY,
    CM_POLL_CHARGING_ONLY,
};

enum cm_event_types {
    CM_EVENT_UNKNOWN = 0,
    CM_EVENT_BATT_FULL,
    CM_EVENT_BATT_IN,
    CM_EVENT_BATT_OUT,
    CM_EVENT_EXT_PWR_IN_OUT,
    CM_EVENT_CHG_START_STOP,
    CM_EVENT_OTHERS,
};

struct charger_global_desc {
    char *rtc_name;

    bool (*rtc_only_wakeup)(void);

    bool assume_timer_stops_in_suspend;
};

struct charger_cable {
    const char *extcon_name;
    const char *name;

    /* The charger-manager use Exton framework*/
    struct extcon_specific_cable_nb extcon_dev;
    struct work_struct wq;
    struct notifier_block nb;

    /* The state of charger cable */
    bool attached;

    struct charger_regulator *charger;

    /*
     * Set min/max current of regulator to protect over-current issue
     * according to a kind of charger cable when cable is attached.
     */
    int min_uA;
    int max_uA;

    struct charger_manager *cm;
};

struct charger_regulator {
    /* The name of regulator for charging */
    const char *regulator_name;
    struct regulator *consumer;

    /* charger never on when system is on */
    int externally_control;

    /*
     * Store constraint information related to current limit,
     * each cable have different condition for charging.
     */
    struct charger_cable *cables;
    int num_cables;

    struct attribute_group attr_g;
    struct device_attribute attr_name;
    struct device_attribute attr_state;
    struct device_attribute attr_externally_control;
    struct attribute *attrs[4];

    struct charger_manager *cm;
};

struct charger_desc {
    char *psy_name;

    enum polling_modes polling_mode;
    unsigned int polling_interval_ms;

    unsigned int fullbatt_vchkdrop_ms;
    unsigned int fullbatt_vchkdrop_uV;
    unsigned int fullbatt_uV;
    unsigned int fullbatt_soc;
    unsigned int fullbatt_full_capacity;

    enum data_source battery_present;

    char **psy_charger_stat;

    int num_charger_regulators;
    struct charger_regulator *charger_regulators;

    char *psy_fuel_gauge;

    int (*temperature_out_of_range)(int *mC);
    bool measure_battery_temp;

    u64 charging_max_duration_ms;
    u64 discharging_max_duration_ms;
};

#define PSY_NAME_MAX    30

struct charger_manager {
    struct list_head entry;
    struct device *dev;
    struct charger_desc *desc;

    struct power_supply *fuel_gauge;
    struct power_supply **charger_stat;

    bool charger_enabled;

    unsigned long fullbatt_vchk_jiffies_at;
    struct delayed_work fullbatt_vchk_work;

    int emergency_stop;
    int last_temp_mC;

    char psy_name_buf[PSY_NAME_MAX + 1];
    struct power_supply charger_psy;

    bool status_save_ext_pwr_inserted;
    bool status_save_batt;

    u64 charging_start_time;
    u64 charging_end_time;
};

#ifdef CONFIG_CHARGER_MANAGER
extern int setup_charger_manager(struct charger_global_desc *gd);
extern bool cm_suspend_again(void);
extern void cm_notify_event(struct power_supply *psy,
                enum cm_event_types type, char *msg);
#else
static inline int setup_charger_manager(struct charger_global_desc *gd)
{ return 0; }
static inline bool cm_suspend_again(void) { return false; }
static inline void cm_notify_event(struct power_supply *psy,
                enum cm_event_types type, char *msg) { }
#endif
#endif /* _CHARGER_MANAGER_H */