About
=====

This is PC software to program RL78 microcontrollers via serial bootloader.
This version can not set any security mode. Only S-record image files are
accepted as input files. Both (1-wire and 2-wire UART) communication modes are
supported. By default 1-wire mode is used. Reset signal can be generated by
RTS or DTR pin. DTR is used by default.

Thanks to Hiroaki Okoshi for proposal.

Download
========

Binary version for Windows can be downloader from
https://github.com/msalau/rl78flash/releases

Linux users are encouraged to build rl78flash by himself.

Usage
=====

user@host:~$ rl78flash -h
rl78s [options] <port> [<file>]
        -v      Verbose mode (several times increase verbose level)
        -i      Dispaly info about MCU
        -a      Auto mode (Erase-Write-Verify-Reset)
        -e      Erase memory
        -w      Write memory
        -c      Verify memory
        -r      Reset MCU (switch to RUN mode)
        -b baud Set baudrate (supported baudrates: 115200, 250000, 500000, 1000000)
                        default: 115200
        -m n    Set communication mode
                        n=1 Single-wire UART, Reset by DTR
                        n=2 Two-wire UART, Reset by DTR
                        n=3 Single-wire UART, Reset by RTS
                        n=4 Two-wire UART, Reset by RTS
                        default: n=1
        -p v    Specify power supply voltage
                        default: 3.3
        -t baud Start terminal with specified baudrate
        -h      Display help

In case of Windows, port is specified by it's name (e.g. COM14), in case of Linux --
by it's full path (e.g. /dev/ttyUSB0).

Program flow
------------

Info -> Erase -> Write -> Verify -> Reset -> Terminal

Reset is generated if:
* terminal is disabled and '-r' argument is passed
* terminal is enabled and any other action is enabled

Typical invocation
------------------

user@host:~$ rl78flash -viva /dev/ttyUSB0 R5F100SL.mot
Device: R5F100SL
Code size: 512 kB
Data size: 8 kB
Erase
*..................................................................................
...................................................................................
...................................................................................
...................................................................................
...................................................................................
...................................................................................
..............
Read file "R5F100SL.mot"
Write
*
Verify
*..................................................................................
...................................................................................
...................................................................................
...................................................................................
...................................................................................
...................................................................................
..............
Reset MCU
user@host:~$

-or-

user@host:~$ rl78flash -vviw /dev/ttyUSB0 R5F100SL.mot
Device: R5F100SL
Code size: 512 kB
Data size: 8 kB
Read file "R5F100SL.mot"
Write
*
Reset MCU
user@host:~$

Legend
------

'.' -- blank block (1 kB)
'*' -- not blank block (1 kB)

License
=======

The MIT License (MIT)
Copyright (c) 2012 Maxim Salov

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.