make: check if git is available before calculate version
[pyfrprog.git] / README
1 What is frprog?
2 frprog is a programmer written in Python for programming a microcontroller of
3 the FR Family by Fujitsu. It also includes a simple "kernel" (let's name it
4 "pkernel") for communication to the PC, since the BootROM isn't able to modify
5 the flash.
6
7 Why?
8 There are only programmers available on Windows.
9 And Windows sucks, in particular we hate the clickage every time we want to
10 flash a programm on the board. Sadly we don't have a monkey to do this job for
11 us.
12
13
14 Usage:
15 > frprog [target mhx-file]
16 where the target file must be a valid MHX output of the Softune linker / f2ms
17 converter. frprog will instruct you through the process then.
18 (We also built up a simple Makefile which calls their toolchain through wine,
19 so we actually don't rely on Windows for our work :) Contact us if you are
20 interested!)
21
22
23 Supported Microcontroller:
24 o MB91F465X (you find this controller in the "bits pot blue" board by Fujitsu)
25
26
27 Installation:
28 Do the common trick
29 > make && sudo make install
30 to install it. In case, adjust $PREFIX in the Makefile.
31
32 For zsh-users, add this to your .zshrc:
33 > _frprog() {
34 >       _files -J files -g '*.(#i)mhx(.)'
35 > }
36 > compdef _frprog frprog
37
38
39 ToDo:
40 o use checksum for transmission
41 o verify flash
42 o maybe test/port frprog to other platforms if there's enough interest
43 o <insert your idea here>
44
45 feel free to contribute!
46
47
48 License and Disclaimer:
49 GPL2 of course and YOU USE THIS PROGRAM ON YOUR OWN
50 RISK ...
51
52
53 Credits:
54 Sebastian "theStack" Falbesoner // sebastian.falbesoner _AT_ gmail _DOT_ com
55 Bernhard "lewurm" Urban // lewurm _AT_ gmail _DOT_ com
56
57 Serial port access is performed via USPP ("Universal Serial Port Python
58 Library"), a multi-platform Python module written by Isaac Barona (see
59 http://sites.google.com/site/ibarona/uspp). Thanks for providing such a
60 comfortable tty interface!
61
62 Thanks to Holger Wech for his valuable hints (check out also his featurerich
63 programmer "FLASHly" http://home.arcor.de/ho/holger.wech/elektronik/ for
64 Windows)