README: Update the steps with new options
authorNikhil Devshatwar <nikhil.nd@ti.com>
Thu, 13 Aug 2015 12:26:51 +0000 (17:56 +0530)
committerNikhil Devshatwar <nikhil.nd@ti.com>
Thu, 13 Aug 2015 13:47:47 +0000 (19:17 +0530)
Update the examples to use the new command line options.
Also, correct the FILES section to remove the config file which
is not being used now.
Add more examples for generating module specific config and for the
changing output format.

Signed-off-by: Nikhil Devshatwar <nikhil.nd@ti.com>
README

diff --git a/README b/README
index 1e7fd8a6731e33882ac8643f22f75d80b0fe196f..93f5b3c702ee8ecb43c73fe07474330281f3bcb7 100644 (file)
--- a/README
+++ b/README
@@ -50,7 +50,6 @@ XMLFiles/*.xml           - XML data from Pad Config Tool
 
 selected-modes.txt       - User selected delay modes to be used by script
 ctrl-core.dump           - Register dump of all the PAD registers
-config-iodelay-autogen   - Turn on/off common options for the script
 
 
 EXAMPLES
@@ -58,36 +57,32 @@ EXAMPLES
 #0 For getting the register dump of the PAD registers:-
     - Run this command on target "omapconf dump 0x4a003400 0x4a00380c"
       and save the output to a file called ctrl-core.dump
+    - Please refer to the usage and help message for more info.
+      $> ./iodelay-autogen.py --help
 
 #1 For generating the IOdelay values from the old kernel interactively:-
-    - Set interactive = 1 in the config-iodelay-autogen and run
-      $> python iodelay-autogen.py
+    - Run the script interactively with -i option (default).
     - Select the delay mode for the PAD group in conflict. Refer to the
       guidelines.txt for description about that delay mode.
     - For the peripherals in doubt, you can skip the entire PAD group
     - Selection of each PAD group and the selected mode is printed at end.
+    - e.g. to generate the pad/delay data first time, run
+      $> ./iodelay-autogen.py -i 1
+      $> ./iodelay-autogen.py
 
 #2 For generating the IOdelay values for a specific module only:-
-    - Update the selected-modes.txt with an entry for the correct delay mode
-      to be used for the specific module.
-    - Set interactive = 0 in the config-iodelay-autogen and run
-      $> python iodelay-autogen.py | grep "PAD:"     #Dumps all pad entries
-      $> python iodelay-autogen.py | grep "DELAY:"   #Dumps all manual delays
-
-#3 For generating the IOdelay values for all of the pads:-
-    - Create the selected-modes.txt either by following step #1 or
-      by referring to the guidelines.txt
-    - Set auto_decide = 1 in config-iodelay-autogen and run
-      $> python iodelay-autogen.py
-    - All the PAD and DELAY registers are dumped including the LEGACY_MODE
-      for which no manual/virtual modes are needed.
+    - Use the module filter to specify the desired module.
+      The script would only generate output wrt the module specified.
+    - e.g. to generate the pad/delay data only for VIN3A interface, run
+      $> ./iodelay-autogen.py -m VIN3A
+
+#3 For generating the IOdelay values for kernel format:-
+    - Use the format option -f to specify the output format.
+    - e.g. for generating pad/delay data for MMC1 in DTS format, run
+      $> ./iodelay-autogen.py -m MMC1 -f linux
 
 TODO
 ====
-- Do not dump the data immediately, save in a list and dump later
-- Create output in u-boot or kernel format
-- Dump data sorted by register address or by PAD group
-
 
 SUPPORT AND BUGS
 ================