lp8727_charger: Add description of platform data
authorKim, Milo <Milo.Kim@ti.com>
Fri, 27 Jan 2012 06:59:00 +0000 (22:59 -0800)
committerAnton Vorontsov <anton.vorontsov@linaro.org>
Mon, 26 Mar 2012 16:40:57 +0000 (20:40 +0400)
Add brief description of lp8727_platform_data and lp8727_chg_param.

Signed-off-by: Milo(Woogyom) Kim <milo.kim@ti.com>
Signed-off-by: Anton Vorontsov <anton.vorontsov@linaro.org>
include/linux/lp8727.h

index 95371c4..a508b45 100644 (file)
@@ -35,13 +35,24 @@ enum lp8727_ichg {
        ICHG_1000mA,
 };
 
+/**
+ * struct lp8727_chg_param
+ * @eoc_level : end of charge level setting
+ * @ichg : charging current
+ */
 struct lp8727_chg_param {
-       /* end of charge level setting */
        enum lp8727_eoc_level eoc_level;
-       /* charging current */
        enum lp8727_ichg ichg;
 };
 
+/**
+ * struct lp8727_platform_data
+ * @get_batt_present : check battery status - exists or not
+ * @get_batt_level : get battery voltage (mV)
+ * @get_batt_capacity : get battery capacity (%)
+ * @get_batt_temp : get battery temperature
+ * @ac, @usb : charging parameters each charger type
+ */
 struct lp8727_platform_data {
        u8 (*get_batt_present)(void);
        u16 (*get_batt_level)(void);