pytest.yml: added testroutine pipeline
[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 and development 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 ## Usage
16 ```
17 usage: raflash [-h] {write,read,erase,info} ...
18
19 RA Flasher Tool
20
21 options:
22   -h, --help            show this help message and exit
23
24 Commands:
25   {write,read,erase,info}
26     write               Write data to flash
27     read                Read data from flash
28     erase               Erase sectors
29     info                Show flasher information
30 ```
31 Each command has various options. For example, use RAFlasher write -h to see all write options:
32 ```
33 usage: raflash write [-h] [--start_address START_ADDRESS] [--size SIZE] [--verify] file_name
34
35 positional arguments:
36   file_name             File name
37
38 options:
39   -h, --help            show this help message and exit
40   --start_address START_ADDRESS
41                         Start address
42   --size SIZE           Size in bytes
43   --verify              Verify after writing
44
45 ```
46
47 ## Dev
48  - [X] Pull requests
49 - [X] Issues
50
51 ## Supported functionality
52 - [X] Read
53 - [X] Write
54 - [X] Erase / sector erase
55 - [X] Info / area information
56 - [ ] ID Authentication
57 - [ ] Baud rate (only for SCI)
58
59 ## Supported interfaces
60 - [X] USB
61 - [ ] SCI
62
63 ## Supported MCUs
64 - [X] RA4 (tested)
65 - [ ] RA2 (should potentially work)
66 - [ ] RA6 
67
68 *Note: only tested on RA4 hardware*
69
70 ## Resources
71 https://www.renesas.com/us/en/document/apn/renesas-ra-family-system-specifications-standard-boot-firmware