doc: handlers: ucfw: improve description
diff mbox series

Message ID 1559849220-25673-1-git-send-email-pjtexier@koncepto.io
State Accepted
Headers show
Series
  • doc: handlers: ucfw: improve description
Related show

Commit Message

'Pierre-Jean Texier' via swupdate June 6, 2019, 7:27 p.m. UTC
The example was not explicit enough.
So, this commit adds the other required properties:

- filename: microcontroller image (binary name)
- type: handler name (ucfw here)
- device: serial port used to communicate (i.e: /dev/ttymxc5 for NXP WaRP7)

Tested on WaRP7:
---------------

[INFO ] : SWUPDATE started :  Software Update started !
[TRACE] : SWUPDATE running :  [extract_file_to_tmp] : Found file:
	filename sw-description
	size 778
[TRACE] : SWUPDATE running :  [get_common_fields] : Version 1.0
[TRACE] : SWUPDATE running :  [parse_hw_compatibility] : Accepted Hw Revision : rev0.2
[TRACE] : SWUPDATE running :  [add_properties] : Found properties for foo.bin:
[TRACE] : SWUPDATE running :  [add_properties_cb] : 		Property reset: /dev/gpiochip3:23:false
[TRACE] : SWUPDATE running :  [add_properties_cb] : 		Property prog: /dev/gpiochip6:8:false
[TRACE] : SWUPDATE running :  [parse_images] : Found Image: foo.bin in device : /dev/ttymxc5 for handler ucfw
[TRACE] : SWUPDATE running :  [check_hw_compatibility] : Hardware warp7 Revision: rev0.2
[TRACE] : SWUPDATE running :  [check_hw_compatibility] : Hardware compatibility verified
[TRACE] : SWUPDATE running :  [extract_files] : Found file:
	filename foo.bin
	size 14644 required
[TRACE] : SWUPDATE running :  [network_initializer] : Valid image found: copying to FLASH
[INFO ] : SWUPDATE running :  Installation in progress
[TRACE] : SWUPDATE running :  [install_single_image] : Found installer for stream foo.bin ucfw
[DEBUG] : SWUPDATE running :  [install_uc_firmware_image] : line reset : device /dev/gpiochip3, num = 23, active_low = false
[DEBUG] : SWUPDATE running :  [install_uc_firmware_image] : line prog : device /dev/gpiochip6, num = 8, active_low = false
[DEBUG] : SWUPDATE running :  [prepare_update] : Using /dev/ttymxc5

Signed-off-by: Pierre-Jean Texier <pjtexier@koncepto.io>
---
 doc/source/handlers.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

Patch
diff mbox series

diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst
index eb04478..03c0a69 100644
--- a/doc/source/handlers.rst
+++ b/doc/source/handlers.rst
@@ -528,8 +528,16 @@  Example:
 
 ::
 
-        properties = {
+    images: (
+        {
+            filename = "microcontroller-image";
+            type = "ucfw";
+            device = "/dev/ttymxc5";
+
+            properties: {
                 reset =  "/dev/gpiochip0:38:false";
                 prog =  "/dev/gpiochip0:39:false";
+            };
         }
+    );