.flake8: add config + minor style fixes
[renesas-ra-flasher] / README.md
1 # Renesas RA flash tool
2 Flash tool for the built in ROM bootloader for Renesas RA microcontrollers
3
4 ## Requirements
5 - Python >= 3.6
6 - venv
7
8 ## Local install
9 *Strongly Recommended to use venv (https://docs.python.org/3/library/venv.html)*
10 - python -m venv .venv
11 - source .venv/bin/activate
12 - pip install -r requirements.txt
13 - pip install -e .
14
15 ## Package
16 WIP: currently in development mode
17
18 ## Usage
19 ```
20 usage: raflash [-h] {write,read,erase,info} ...
21
22 RA Flasher Tool
23
24 options:
25   -h, --help            show this help message and exit
26
27 Commands:
28   {write,read,erase,info}
29     write               Write data to flash
30     read                Read data from flash
31     erase               Erase sectors
32     info                Show flasher information
33 ```
34 Each command has various options. For example, use RAFlasher write -h to see all write options:
35 ```
36 usage: raflash write [-h] [--start_address START_ADDRESS] [--size SIZE] [--verify] file_name
37
38 positional arguments:
39   file_name             File name
40
41 options:
42   -h, --help            show this help message and exit
43   --start_address START_ADDRESS
44                         Start address
45   --size SIZE           Size in bytes
46   --verify              Verify after writing
47
48 ```
49
50 ## Dev
51  - [X] Pull requests
52 - [X] Issues
53
54 ## Supported functionality
55 - [X] Read
56 - [X] Write
57 - [X] Erase / sector erase
58 - [X] Info / area information
59 - [ ] ID Authentication
60 - [ ] Baud rate (only for SCI)
61
62 ## Supported interfaces
63 - [X] USB
64 - [ ] SCI
65
66 ## Supported MCUs
67 - [X] RA4 (tested)
68 - [ ] RA2 (should potentially work)
69 - [ ] RA6 
70
71 *Note: only tested on RA4 hardware*
72
73 ## Resources
74 https://www.renesas.com/us/en/document/apn/renesas-ra-family-system-specifications-standard-boot-firmware