doc: add references to flashstream file format spec in documentation
authorAneesh V <aneesh@ti.com>
Fri, 14 Feb 2014 20:53:47 +0000 (12:53 -0800)
committerAneesh V <aneesh@ti.com>
Fri, 14 Feb 2014 20:53:47 +0000 (12:53 -0800)
Signed-off-by: Aneesh V <aneesh@ti.com>
README
bqtool.c

diff --git a/README b/README
index c99033cb8983be70a895ee57ddbfa8793993e094..c51ce23598ea65f8d692759e57fab4103ff92068 100644 (file)
--- a/README
+++ b/README
@@ -15,9 +15,10 @@ cd <android-root-dir>
 source build/envsetup.sh
 mm TARGET_PRODUCT=<product>
 
-Running bqtool
-==============
---flash command:
-  bqtool --flash <bqfs file|dffs file>
-  Eg: 
-    bqtool --flash /system/bin/bq27520_v302.bqfs
+Commands supported:
+--flash :
+       bqtool --flash <bqfs file|dffs file>
+       Eg: bqtool --flash /system/bin/bq27520_v302.bqfs
+
+       For details of flashstream file format(.bqfs/.dffs) see:
+       http://www.ti.com.cn/cn/lit/an/slua541a/slua541a.pdf
index 84384cdf0d5c20afd38a780c20ba79f4953602e4..fe0f95282d7cd73be202b53f035c9dd0f849e0c7 100644 (file)
--- a/bqtool.c
+++ b/bqtool.c
  * limitations under the License.
  */
 
+/*
+ * Android utility for programming and debugging TI's bq27xxx
+ * family of gas gauges
+ *
+ * Commands supported:
+ * --flash :
+ *     bqtool --flash <bqfs file|dffs file>
+ *     Eg: bqtool --flash /system/bin/bq27520_v302.bqfs
+ *
+ *     For details of flashstream file format(.bqfs/.dffs) see:
+ *     http://www.ti.com.cn/cn/lit/an/slua541a/slua541a.pdf
+ *
+ */
+
 #include <stdio.h>
 #include <string.h>
 #include <i2c-dev.h>