Linux power supply framwork & drvs

转自 ：http://www.wowotech.net/pm_subsystem/psy_class_overview.html

0.涉及文件

framwork
drivers\power\power_supply_core.c
drivers\power\power_supply_sysfs.c
drivers\power\power_supply_leds.c

PSY drv
drivers\power\qpnp-charger.c // “battery”
drivers\power\qpnp-bms.c // “bms”
drivers\usb\otg\msm_otg.c // “usb”

---

重要函数

power_supply_register     // 向core 注册 psy drv
power_supply_changed      // psy设备状态改变调用core中的此函数，这个函数会回调 drv中的 power_supply->external_power_changed 函数

---

1. 前言

power supply class为编写供电设备（power supply，后面简称PSY）的驱动提供了统一的框架，功能包括：
1）抽象PSY设备的共性，向用户空间提供统一的API。
2）为底层PSY驱动的编写，提供简单、统一的方式。同时封装并实现公共逻辑，驱动工程师只需把精力集中在和硬件相关的部分即可。
注：其实所有的class（如input subsystem），思路都是这样的—-抽象共性、统一接口、屏蔽细节。我们在“Linux设备模型(7)_Class”中介绍过，本文在介绍power supply class同时，也以此为例，进一步理解设备模型中class的存在意义和使用方法。

---

2. 设计思路

先来回答一个问题：kernel中设备驱动的目的，是管理设备，并提供给用户空间程序使用，那么对PSY设备而言，kernel要管理什么？用户空间程序要使用什么？
其实PSY设备是一个特例，它的目的很单纯，就是为系统供电。如果只考虑这个目的，就不需要任何驱动了，但情况会稍微复杂，因为：

1）PSY设备可能是电池设备（battery，这在嵌入式系统中很常见），这会引申出电量检测、充电管理等多个议题。
此时，PSY driver需要管理的事情包括：检测电池类型；检测电池电量；检测充电状态；等等。而用户空间程序则需要将检测到的结果，显示给用户。

2）系统中可能有多个PSY设备，这些设备还可能有级联关系，如有些平板电脑中，可能同时存在DC-charger、USB-charger、battery三个供电设备，其中DC-charger和USB-charger可能会给battery供电，再由battery向系统供电。
此时，PSY driver需要管理的事情包括：获取外部供电设备的连接状态；充电状态；等等。同样，用户空间程序需要将这些信息显示给用户。
那么，共性已经总结出来了：PSY driver的主要功能，就是向用户空间程序汇整各类状态信息。因此，power supply class的核心思路就是：
将这些状态信息，抽象为“属性（properties）”。由于状态信息的类型是有限的，properties的个数也是有限的。
PSY driver只需要负责：该PSY设备具有哪些“属性”；这些“属性”的“值（value）”是什么；当“属性值”发生改变时，通知power supply class。
power supply class负责：将某个PSY设备支持的属性及其value，以sysfs的形式，提供给用户空间；当属性值改变时，以uevent的形式，广播给用户空间程序。
另外，power supply class也会协助处理PSY级联的情况（后面会详细描述）。

---

3. 软件架构和API汇整

---

3.1 软件架构

power supply class位于drivers/power/目录中，主要由3部分组成（可参考下图的软件架构）：

---

1）power supply core，用于抽象核心数据结构、实现公共逻辑。位于drivers/power/power_supply_core.c中。
2）power supply sysfs，实现sysfs以及uevent功能。位于drivers/power/power_supply_sysfs.c中。
3）power supply leds，基于linux led class，提供PSY设备状态指示的通用实现。位于drivers/power/power_suppply_leds.c中。
最后，驱动工程师可以基于power supply class，实现具体的PSY drivers，主要处理平台相关、硬件相关的逻辑。这些drivers都位于drivers/power/目录下。

---

3.2 核心数据结构

1）struct power_supply

struct power_supply为power supply class的核心数据结构，用于抽象PSY设备。其定义如下：

/* include/linux/power_supply.h */
 struct power_supply {
     const char *name;                                // 该PSY的名称
     enum power_supply_type type;                     // 该PSY的类型，枚举型，包括：battery、USB charger等等

/* ★  sys/class/power_supply/xxx/ 下面的节点属性 ★
   该PSY具有的属性列表，枚举型 
*/
     enum power_supply_property *properties;        

     size_t num_properties;                           // 属性的个数


  /* 一个字符串数组，保存了由该PSY供电的PSY列表，以此可将PSY组织成相互级联的PSY链。
     这些“被供电”的PSY，称作supplicant（客户端、乞求者）
  */
     char **supplied_to;  
     size_t num_supplicants;

  /*
     一个字符串数组，保存了向该PSY供电的PSY列表，也称作supply（提供者）。
     从另一个方向，组织PSY之间的级联关系
  */
     char **supplied_from; 
     size_t num_supplies;
     struct device_node *of_node;

/* ★core中会调用set回调设置psy的各种属性动作  power_supply_set_online、power_supply_set_current_limit 
(sys节点的回调)★
   PSY driver需要重点实现的两个回调函数，用于获取/设置属性值 properties 
 */
     int (*get_property)(struct power_supply *psy,
                 enum power_supply_property psp,
                 union power_supply_propval *val);

     int (*set_property)(struct power_supply *psy,
                 enum power_supply_property psp,
                 const union power_supply_propval *val);

     int (*property_is_writeable)(struct power_supply *psy,
                      enum power_supply_property psp);


/*  ★（power_supply_core.c的回调函数）★ 
    当一个PSY设备存在supply PSY，且该supply PSY的属性发生改变（如online、offline）时，
    power_supply_core.c 会调用该回调函数，通知 《PSY driver》以便让它做出相应的处理
*/
     void (*external_power_changed)(struct power_supply *psy);


/* 
   该回调函数的应用场景有点奇怪：外部模块通知PSY driver，该PSY设备的状态改变了。
   自己改变了自己不知道，要外部通知，希望大家在实际工作中不要遇到，不然太纠结了 
*/     
     void (*set_charged)(struct power_supply *psy);

     /* For APM emulation, think legacy userspace. */
     int use_for_apm;

     /* private */
     struct device *dev;

/*
    一个用于处理状态改变的workqueue，主要思路是：当该PSY的状态发生改变，
    启动一个workqueue，查询并通知所有的supplicants
*/
     struct work_struct changed_work;
     spinlock_t changed_lock;
     bool changed;


/*
    一个用于处理状态改变的workqueue，主要思路是：当该PSY的状态发生改变，
    启动一个workqueue，查询并通知所有的supplicants
*/
 #ifdef CONFIG_THERMAL
     struct thermal_zone_device *tzd;
     struct thermal_cooling_device *tcd;
 #endif

 /*如果配置了CONFIG_LEDS_TRIGGERS，则调用linux led class的接口，注册相应的LED设备，用于PSY状态指示*/
#ifdef CONFIG_LEDS_TRIGGERS 
     struct led_trigger *charging_full_trig;
     char *charging_full_trig_name;
     struct led_trigger *charging_trig;
     char *charging_trig_name;
     struct led_trigger *full_trig;
     char *full_trig_name;
     struct led_trigger *online_trig;
     char *online_trig_name;
     struct led_trigger *charging_blink_full_solid_trig;
     char *charging_blink_full_solid_trig_name;
 #endif
 };

---

2）PSY类型
PSY类型由enum power_supply_type定义：

  enum power_supply_type {
      POWER_SUPPLY_TYPE_UNKNOWN = 0,
      POWER_SUPPLY_TYPE_BATTERY,   // 电池，嵌入式设备、手持式智能设备常用的供电形式
      POWER_SUPPLY_TYPE_UPS,  // 不间断式供电设备，通过将交流电和蓄电池连接，正常情况下由交流电供电，同时向蓄电池充电。当交流电断电时，由蓄电池紧急供电。一般用于服务器等设备；
      POWER_SUPPLY_TYPE_MAINS, // 主供电设备，如笔记本电脑的适配器，其特点是可以单独供电，当其断电时，再由辅助供电设备供电（如battery）

/*USB类型的供电，不同点在于充电电流的限制，由USB Battery Charge Spec规定，具体可参考USB组织的规范 */
      POWER_SUPPLY_TYPE_USB,        /* Standard Downstream Port */
      POWER_SUPPLY_TYPE_USB_DCP,    /* Dedicated Charging Port */
      POWER_SUPPLY_TYPE_USB_CDP,    /* Charging Downstream Port */
      POWER_SUPPLY_TYPE_USB_ACA,    /* Accessory Charger Adapters */
  };

---

3）PSY属性
power supply class将所有可能PSY属性，以枚举型变量（enum power_supply_property ）的形式抽象出来，PSY driver可以根据设备的实际情况，从中选取一些。

 enum power_supply_property {
     /* Properties of type `int' */
     POWER_SUPPLY_PROP_STATUS = 0,
     POWER_SUPPLY_PROP_CHARGE_TYPE,
     POWER_SUPPLY_PROP_HEALTH,
     POWER_SUPPLY_PROP_PRESENT,
     POWER_SUPPLY_PROP_ONLINE,
     POWER_SUPPLY_PROP_AUTHENTIC,
     POWER_SUPPLY_PROP_TECHNOLOGY,
     POWER_SUPPLY_PROP_CYCLE_COUNT,
     POWER_SUPPLY_PROP_VOLTAGE_MAX,
     POWER_SUPPLY_PROP_VOLTAGE_MIN,
     POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
     ......
 };

status ：主要是充电状态，包括：”Unknown”, “Charging”, “Discharging”, “Not charging”, “Full”，
charge_type：充电类型，包括：”Unknown”, “N/A”, “Trickle”, “Fast”，
health：“健康”情况，包括：”Unknown”, “Good”, “Overheat”, “Dead”, “Over voltage”等等,
tecgnology：采用的技术，包括：”Unknown”, “NiMH”, “Li-ion”, “Li-poly”, “LiFe”, “NiCd”, “LiMn”
capbility: 电量值
type：PSY类型 (battry 、usb)，比较特殊，保存在“psy->type”变量中，而不在properties数组中。

---

3.3 向具体的PSY driver提供的API

power supply class首要任务，是向PSY driver提供统一的驱动编写接口，主要包括：

1）PSY的 register/unregister

   power_supply_register(struct device *parent, struct power_supply *psy); 
   power_supply_register_no_ws(struct device *parent, struct power_supply *psy);
   power_supply_unregister(struct power_supply *psy);

其中power_supply_register和power_supply_register_no_ws的区别是：power_supply_register注册的PSY，具备wakeup系统的能力，而power_supply_register_no_ws不具备。

---

2）PSY状态改变时通知power supply core

 power_supply_changed(struct power_supply *psy);

当PSY driver检测到该设备某些属性值改变时，会调用这个接口，通知power supply core，power supply core会有如下动作：

a.如果该PSY是其它PSY的供电源，调用这些PSY的external_power_changed回调函数，通知它们（这些PSY具体要做些什么，由它们的自身逻辑决定）；

b.如果配置了CONFIG_LEDS_TRIGGERS，调用power_supply_update_leds，更新该PSY有关的led状态；
发送notifier，通知那些关心PSY设备状态的drivers；
以统一的格式，向用户空间发送uevent（这就是设备模型中class的魅力，对外接口由class core提供，可以节省driver的工作量，同时确保了接口的一致性）。

---

3）其它杂项接口

// 通过名字获取PSY指针
 power_supply_get_by_name(const char *name); 

// 从DTS中，解析出对应dePSY指针
 power_supply_get_by_phandle(struct device_node *np, const char *property); 

// 查询自己是否由其它PSY供电                                         
 power_supply_am_i_supplied(struct power_supply *psy); 

// 调用指定PSY的set_charged回调
 power_supply_set_battery_charged(struct power_supply *psy); 

// 查询系统是否有有效的或者处于online状态的PSY，如果没有，可能为桌面系统。
 power_supply_is_system_supplied(void); 

// 在指定设备（通常是该PSY设备）的sysfs目录（/sys/devices/xxx/）下，创建指定PSY的符号链接（/sys/devices/xxx/powers）。
 power_supply_powers(struct power_supply *psy, struct device *dev);

---

3.4 向其它driver提供的用于接收PSY状态改变notifier的API

1: extern int power_supply_reg_notifier(struct notifier_block *nb);
2: extern void power_supply_unreg_notifier(struct notifier_block *nb);
通过notifier注册接口注册notifier之后，系统任何PSY设备的状态发生改变，并调用了power_supply_changed接口，power supply core就是通知notifier的监听者。

---

3.5 向用户空间程序提供的API

power supply class通过两种形式向用户空间提供接口。
1）uevent（具体可参考“Linux设备模型(3)_Uevent”），以“名字=value”的形式，上报所有property的值，格式如下：

POWER_SUPPLY_NAME=xxx                     /* power supply name */ 
POWER_SUPPLY_xxx1=xxx                       /* property = value */ 
POWER_SUPPLY_xxx2=xxx 

…
uevent一般会在PSY设备添加到kernel时，或者PSY属性发生改变时（可参考3.3中的介绍）发送。
2）sysfs
power supply class在power_supply_sysfs.c中，定义了相当多的默认attribute（见下面），如果某个PSY设备具有某个属性，该属性对应的attribute就会体现在sysfs中（一般位于“/sys/class/power_supply/xxx/”中）。

/* Must be in the same order as POWER_SUPPLY_PROP_* */
 static struct device_attribute power_supply_attrs[] = {
     /* Properties of type `int' */
     POWER_SUPPLY_ATTR(status),
     POWER_SUPPLY_ATTR(charge_type),
     POWER_SUPPLY_ATTR(health),
     POWER_SUPPLY_ATTR(present),
     POWER_SUPPLY_ATTR(online),
     POWER_SUPPLY_ATTR(authentic),
     POWER_SUPPLY_ATTR(technology),
     POWER_SUPPLY_ATTR(cycle_count),
     POWER_SUPPLY_ATTR(voltage_max),
     POWER_SUPPLY_ATTR(voltage_min),
     POWER_SUPPLY_ATTR(voltage_max_design),
     POWER_SUPPLY_ATTR(voltage_min_design),
     POWER_SUPPLY_ATTR(voltage_now),
     POWER_SUPPLY_ATTR(voltage_avg),
     POWER_SUPPLY_ATTR(voltage_ocv),
     POWER_SUPPLY_ATTR(voltage_boot),
     POWER_SUPPLY_ATTR(current_max),
     POWER_SUPPLY_ATTR(current_now),
     POWER_SUPPLY_ATTR(current_avg),
     POWER_SUPPLY_ATTR(current_boot),
     POWER_SUPPLY_ATTR(power_now),
     POWER_SUPPLY_ATTR(power_avg),
     POWER_SUPPLY_ATTR(charge_full_design),
     POWER_SUPPLY_ATTR(charge_empty_design),
     POWER_SUPPLY_ATTR(charge_full),
     POWER_SUPPLY_ATTR(charge_empty),
     POWER_SUPPLY_ATTR(charge_now),
     POWER_SUPPLY_ATTR(charge_avg),
     POWER_SUPPLY_ATTR(charge_counter),
     POWER_SUPPLY_ATTR(constant_charge_current),
     POWER_SUPPLY_ATTR(constant_charge_current_max),
     POWER_SUPPLY_ATTR(constant_charge_voltage),
     POWER_SUPPLY_ATTR(constant_charge_voltage_max),
     POWER_SUPPLY_ATTR(charge_control_limit),
     POWER_SUPPLY_ATTR(charge_control_limit_max),
     POWER_SUPPLY_ATTR(input_current_limit),
     POWER_SUPPLY_ATTR(energy_full_design),
     POWER_SUPPLY_ATTR(energy_empty_design),
     POWER_SUPPLY_ATTR(energy_full),
     POWER_SUPPLY_ATTR(energy_empty),
     POWER_SUPPLY_ATTR(energy_now),
     POWER_SUPPLY_ATTR(energy_avg),
     POWER_SUPPLY_ATTR(capacity),
     POWER_SUPPLY_ATTR(capacity_alert_min),
     POWER_SUPPLY_ATTR(capacity_alert_max),
     POWER_SUPPLY_ATTR(capacity_level),
     POWER_SUPPLY_ATTR(temp),
     POWER_SUPPLY_ATTR(temp_max),
     POWER_SUPPLY_ATTR(temp_min),
     POWER_SUPPLY_ATTR(temp_alert_min),
     POWER_SUPPLY_ATTR(temp_alert_max),
     POWER_SUPPLY_ATTR(temp_ambient),
     POWER_SUPPLY_ATTR(temp_ambient_alert_min),
     POWER_SUPPLY_ATTR(temp_ambient_alert_max),
     POWER_SUPPLY_ATTR(time_to_empty_now),
     POWER_SUPPLY_ATTR(time_to_empty_avg),
     POWER_SUPPLY_ATTR(time_to_full_now),
     POWER_SUPPLY_ATTR(time_to_full_avg),
     POWER_SUPPLY_ATTR(type),
     POWER_SUPPLY_ATTR(scope),
     POWER_SUPPLY_ATTR(charge_term_current),
     POWER_SUPPLY_ATTR(calibrate),
     /* Properties of type `const char *' */
     POWER_SUPPLY_ATTR(model_name),
     POWER_SUPPLY_ATTR(manufacturer),
     POWER_SUPPLY_ATTR(serial_number),
 };

具体意义这里就不再详细说明了。

---

4. 怎样基于power supply class编写PSY driver

最后从PSY driver的角度，说明一下怎么基于power supply class，编写驱动：
1）根据硬件spec，确定该PSY设备具备哪些特性，并把它们和enum power_supply_property 中所定义的property对应。
2）根据实际情况，实现这些properties的get/set接口。
3）定义一个struct power_supply变量，并初始化必要的字段后，调用power_supply_register或者power_supply_register_no_ws，将其注册到kernel中。
4）根据实际情况，启动设备属性变化的监控逻辑，例如中断、轮询等，并在发生改变时，调用power_supply_changed，通知power supply core。
也许您会笑，说着简单啊！确实如此，不变的原则：framework只能给我们提供良好的机制、便捷的方式、等等，但是，设备要做什么事情，只有设备驱动最清楚，永远都不可能偷懒啊！