Browse Source

Documentation updates for the boot command

Clara Hobbs 6 years ago
parent
commit
f3ab7120c5
2 changed files with 34 additions and 11 deletions
  1. 26
    10
      README.md
  2. 8
    1
      docs/console_config.md

+ 26
- 10
README.md View File

32
   with the ability to control whether the output is enabled or disabled.
32
   with the ability to control whether the output is enabled or disabled.
33
 * User can easily read a power supply's advertised capabilities while in Setup
33
 * User can easily read a power supply's advertised capabilities while in Setup
34
   mode.
34
   mode.
35
+* Firmware upgrades are easily possible via Setup mode and the
36
+  microcontroller's built-in DfuSe bootloader.
35
 
37
 
36
 ## Prerequisites
38
 ## Prerequisites
37
 
39
 
45
 submodule.
47
 submodule.
46
 
48
 
47
 You will also need to install some program to flash the firmware.  The simplest
49
 You will also need to install some program to flash the firmware.  The simplest
48
-option is [dfu-util][], as it requires no extra hardware (though either the
49
-Boot switch must be installed or two pads must be bridged).  If you prefer to
50
-use SWD, you could also use [stlink][] or [OpenOCD][].
50
+option is [dfu-util][], as it requires no extra hardware (though if upgrading
51
+from versions older than 1.2.0, either the Boot switch must be installed or two
52
+pads must be bridged).  If you prefer to use SWD, you could also use [stlink][]
53
+or [OpenOCD][].
51
 
54
 
52
 [toolchain]: https://launchpad.net/gcc-arm-embedded
55
 [toolchain]: https://launchpad.net/gcc-arm-embedded
53
 [dfu-util]: http://dfu-util.sourceforge.net/
56
 [dfu-util]: http://dfu-util.sourceforge.net/
70
 
73
 
71
 ### dfu-util
74
 ### dfu-util
72
 
75
 
73
-Set the Boot switch (SW1) on the PD Buddy Sink to the position not marked on
74
-the silkscreen to set the device to DFU mode.  If your Sink doesn't have a Boot
75
-switch installed, you can simply bridge the two pads of SW1 circled in [this
76
-image][dfu pads] with a blob of solder to achieve the same effect.  Once the
77
-Sink is set to DFU mode, plug it into your computer.  Flash the firmware with:
76
+To flash via DfuSe (ST Microelectronics's extended version of the standard USB
77
+DFU protocol), the Sink must first be put into DFU mode.  If upgrading from a
78
+version older than 1.2.0, or if no firmware is installed, set the Boot switch
79
+(SW1) on the PD Buddy Sink to the position not marked on the silkscreen to set
80
+the device to DFU mode.  If your Sink doesn't have a Boot switch installed, you
81
+can simply bridge the two pads of SW1 circled in [this image][dfu pads] with a
82
+blob of solder to achieve the same effect.  Once this Sink is set to DFU mode,
83
+plug it into your computer.
84
+
85
+If upgrading from firmware version 1.2.0 or later, you can easily enter DFU
86
+mode by running the following command from the Sink's configuration shell:
87
+
88
+    PDBS) boot
89
+
90
+This immediately puts the Sink in DFU mode until it is reset or unplugged.
91
+
92
+When the Sink is in DFU mode, the Status LED should be glowing dimly.  The
93
+firmware can then be flashed with:
78
 
94
 
79
     $ dfu-util -a 0 -s 0x08000000:leave -D build/pd-buddy-firmware.bin
95
     $ dfu-util -a 0 -s 0x08000000:leave -D build/pd-buddy-firmware.bin
80
 
96
 
81
-Don't forget to set the switch back to normal mode (or remove the solder blob)
82
-after unplugging the device.
97
+If applicable, don't forget to set the switch back to normal mode (or remove
98
+the solder blob) after unplugging the device.
83
 
99
 
84
 [dfu pads]: docs/dfu_pads.jpg
100
 [dfu pads]: docs/dfu_pads.jpg
85
 
101
 

+ 8
- 1
docs/console_config.md View File

1
 # PD Buddy Sink Serial Console Configuration Interface
1
 # PD Buddy Sink Serial Console Configuration Interface
2
 
2
 
3
-Version 1.2.0-dev.1, 2018-01-09
3
+Version 1.2.0-dev.1, 2018-01-10
4
 
4
 
5
 The PD Buddy Sink can be put into setup mode by holding the Setup button while
5
 The PD Buddy Sink can be put into setup mode by holding the Setup button while
6
 plugging it into a computer.  In this mode, the device runs a configuration
6
 plugging it into a computer.  In this mode, the device runs a configuration
163
 Blinks the LED quickly.  Useful for identifying which device you're connected
163
 Blinks the LED quickly.  Useful for identifying which device you're connected
164
 to if several are plugged in to your computer at once.
164
 to if several are plugged in to your computer at once.
165
 
165
 
166
+#### boot
167
+
168
+Usage: `boot`
169
+
170
+Runs the microcontroller's built-in DfuSe bootloader.  This immediately ends
171
+the configuration shell, causing any unsaved changes to be lost.
172
+
166
 ### Storage
173
 ### Storage
167
 
174
 
168
 #### get_cfg
175
 #### get_cfg

Loading…
Cancel
Save