Skip to content

Commit 769b1dc

Browse files
committed
Documentation updates
1 parent dc241b2 commit 769b1dc

File tree

2 files changed

+69
-6
lines changed

2 files changed

+69
-6
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,61 @@
1+
### A tool for programming Nuvoton devices, particularly focusing on their modern 8051 family
2+
3+
### \*\* Experimental MS51FB version \*\*
4+
5+
### Notes:
6+
Possible targets are Nuvoton N76E003 and MS51FB9AE.
7+
The programmer utility has been tested with Nu-Link-Me on a NT-MS51FB 8051 NuTiny dev board.
8+
9+
The Program memory is limited to 12KB for both the N76E003 and MS51FB9AE processors because the image split command does not
10+
parse the chip configuration to determine the split between the program flash and load flash memory,
11+
So it defaults to the worst case of 4KB of load flash. (The N76E003 might be able to be upped to 14KB, but it was set to
12+
12KB by original author).
13+
14+
### If you are going to rebuild this program:
15+
The include paths are setup as relative, so this program source code should be copied to your system
16+
(git clone of zip file - https://github.com/mountaintom/nuvoprog.git - at this time the latest version may be in one of the branches) and
17+
compiled (go build) in-place on your computer. The nuvoprog command should be run from there or manually moved to where you want it.
18+
19+
You can compile the nuvoprog utility as another name (such as nuvoprog-test) by changing the main directory name (such as nuvoprog to nuvoprog-test) then run go build.
20+
21+
### Examples:
22+
```
23+
Download flash data from chip:
24+
./nuvoprog read ./flash-read.ihx --target MS51FB9AE
25+
26+
Split downloaded flash data into Program, Load ROM and chip configuration files:
27+
./nuvoprog image split -i ./flash-read.ihx --target MS51FB9AE -a program-flash-data.ihx -l loader-flas-data.ihx -c chip-configuration.json
28+
Note: This is how to get an example chip-config json file to work with.
29+
30+
Program flash in chip:
31+
./nuvoprog program --target ms51fb9ae -a ./program-to-flash.ihx -c @chip-configuration.json
32+
Note: The files may be combined with "image merge" and the resulting ihx file programmed with the "-i" flag.
33+
```
34+
Usage:
35+
```
36+
nuvoprog [command]
37+
38+
Available Commands:
39+
config Configuration tools
40+
devices List connected programmers
41+
help Help about any command
42+
image Image manipulation commands
43+
program Program a target device
44+
read Read device flash contents
45+
46+
Flags:
47+
-h, --help help for nuvoprog
48+
-t, --target string target device
49+
-v, --verbose make verbose (enable debug logging)
50+
51+
Use "nuvoprog [command] --help" for more information about a command.
52+
subcommand is required
53+
```
54+
55+
56+
\*\*\*\*\*\*
57+
58+
159
#nuvoprog - Nuvoton microcontroller programmer
260

361
`nuvoprog` is an open source tool for programming Nuvoton microcontollers;

cmd/root.go

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,13 @@ var targetName string
3333
// rootCmd represents the base command when called without any subcommands
3434
var rootCmd = &cobra.Command{
3535
Use: "nuvoprog",
36-
Short: "Nuvoton device programmer ** experimental MS51FB upgraded version **",
36+
Short: "Nuvoton device programmer ** experimental MS51FB version **",
3737
Long: `A tool for programming Nuvoton devices, particularly
38-
focusing on their modern 8051 family ** experimental MS51FB upgraded version **
38+
focusing on their modern 8051 family ** experimental MS51FB version **
3939
4040
Notes:
41-
Possible targets are Novoton N76E003 and MS51FB9AE. The programmer utility has been tested with MyLink on a 8051 NuTiny dev board.
41+
Possible targets are Novoton N76E003 and MS51FB9AE.
42+
The programmer utility has been tested with Nu-Link-Me on a NT-MS51FB 8051 NuTiny dev board.
4243
4344
The Program memory is limited to 12KB for both the N76E003 and MS51FB9AE processors because the image split command does not
4445
parse the chip configuration to determine the split between the program flash and load flash memory,
@@ -47,8 +48,8 @@ So it defaults to the worst case of 4KB of load flash. (The N76E003 might be abl
4748
4849
If you are going to rebuild this program:
4950
The include paths are setup as relative, so this program source code should be copied to your system
50-
(git clone of zip file - https://github.com/mountaintom/nuvoprog.git - at this time this modified version in in one of the branches) and
51-
compiled (go build) in-place on your computer. The nuvoprog command run from there or manually moved to where you want it.
51+
(git clone of zip file - https://github.com/mountaintom/nuvoprog.git - at this time the latest version may be in one of the branches) and
52+
compiled (go build) in-place on your computer. The nuvoprog command should be run from there or manually moved to where you want it.
5253
5354
You can compile the nuvoprog utility as another name (such as nuvoprog-test) by changing the main directory name (such as nuvoprog to nuvoprog-test) then run go build.
5455
@@ -58,7 +59,11 @@ Examples:
5859
5960
Split downloaded flash data into Program, Load ROM and chip configuration files:
6061
./nuvoprog image split -i ./flash-read.ihx --target MS51FB9AE -a program-flash-data.ihx -l loader-flas-data.ihx -c chip-configuration.json
61-
Note: This is how to get an example chip-config json to work with file.
62+
Note: This is how to get an example chip-config json file to work with.
63+
64+
Program flash in chip:
65+
./nuvoprog program --target ms51fb9ae -a ./program-to-flash.ihx -c @chip-configuration.json
66+
Note: The files may be combined with "image merge" and the resulting ihx file programmed with the "-i" flag.
6267
`,
6368
PersistentPreRun: func(cmd *cobra.Command, args []string) {
6469
if !verbose {

0 commit comments

Comments
 (0)