summaryrefslogtreecommitdiffstats
path: root/README
blob: c16dcdd2bf365ebc434b44f99c3dca71c2902ca4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
>>>                         toprammer                                <<<
>>>                                                                  <<<
>>>  TOP2049 universal programmer                                    <<<
>>>  Open Source programming suite                                   <<<
>>>  Copyright (c) 2009-2010 Michael Buesch <mb@bu3sch.de>           <<<



=== DEPENDENCIES ===

* Python 2.5 or Python 2.6 is required
  http://python.org/

* python-usb module is required
  http://sourceforge.net/apps/mediawiki/pyusb/index.php?title=Main_Page

* python-pkg-resources module is required
  'pkg_resources' is part of the Python 'setuptools' package.
  http://pypi.python.org/pypi/setuptools



=== SUPPORTED CHIPS ===

Chip                      | State        | Note
-------------------------------------------------------------------------------
Atmel Mega32 DIP40        | supported    | Insert chip upside-down into ZIF
Atmel Mega8 DIP28         | supported    |
Atmel Mega88 DIP28        | supported    |
m2764a EPROM              | uncertain    |



=== INSTALLATION ===

Just execute
	python setup.py install
as root inside of the toprammer distribution package's root directory.



=== USAGE ===

A .BIT file is always needed to do operations on the inserted chip.
The .BIT file must match the chip. For example, do do operations on an
Atmel Mega8 DIP microcontroller, the atmega8dip28.bit file is needed.
Prebuilt .BIT files can be found in the "libtoprammer/bit/" subdirectory.
Sourcecode for these .BIT files is located in "libtoprammer/bit/src/".
However, the full path to the .BIT file doesn't need to be specified to
the toprammer tool. If you just pass the chip-name, toprammer will search
for a matching .BIT file in some standard search paths.

The .BIT file basically is the firmware that runs on the FPGA in the
TOP2049 programmer.

See toprammer --help for device actions to read/write stuff from/to
the chip.

Example:

	Checking which chips are supported:
	toprammer --list

	Reading the flash of an Atmel Mega8 DIP to the file flash.img:
	toprammer --bitfile atmega8dip28 --read-prog flash.img



=== ADD SUPPORT FOR NEW CHIPS ===

To add support for new chips, two things are required:
The bottom-half FPGA implementation of the programming algorithm and
the top-half Python implementation.

For the FPGA part you need to get the Xilinx development suite (ISE)
version 9.2i. It can be downloaded as "WebPACK" for free from the Xilinx
homepage in the "archive" section.
Linux 32bit:	http://www.xilinx.com/support/download/i92linwp.htm
Windows 32bit:	http://www.xilinx.com/support/download/i92winwp.htm

The top-half Python implementation must be put into a chip_xxx.py file.
That file also needs to be imported from toprammer_main.py. That's all
for the top-half.

--- Bottom-half FPGA implementation ---

To create a new sourcecode template fileset for a new chip, go to the
libtoprammer/bit/src/ subdirectory and execute the "create.sh" script:
	./create.sh name_of_chip
where "name_of_chip" is the name of the new chip.
Now go to libtoprammer/bit/src/name_of_chip/ and implement the bottom-half algorithm
in the name_of_chip.v Verilog file.
To build the .BIT file from the Verilog sources, go to the libtoprammer/bit/ directory
and execute:
	./build.sh name_of_chip
(if you omit the chipname, all chips will be rebuilt).

--- Top-half Python implementation ---

You basically need to create a new chip_nameofchip.py file with a class in
it. This class has to be derived from the "Chip" class from chip.py.
Re-implement all required methods from the "Chip" class in your subclass.
Finally add an instance of the new class to the "supportedChips" array:
	supportedChips.append(Chip_nameofchip())



=== ZIF SOCKET LAYOUT GENERATOR ===

The ZIF socket layout generator "toprammer-layout" will try to generate a chip-insert
layout with the given parameters and print it as ASCII-art to the console.

For example, if you have a DIP28 packaged chip, that needs VCC on pin 7,
VPP on pin 1 and GND on pin 8, you'd issue the following command:

	toprammer-layout -d top2049 --package DIP28 --vccx 7 --vpp 1 --gnd 8

This will show you a layout of how to insert the chip into the programmer.
It will also show which pins of the ZIF are powered. This will hopefully match
your request. :)
Alternatively, it will yield an error message, if it was unable to find a layout
that fits the contraints.
Note that the --vccx, --vpp and --gnd pins specified on the commandline are
with respect to the package (_not_ the ZIF socket). The whole purpose of the
tool is to map the package and its pin layout to the ZIF socket, while obeying
the programmer constraints.
bues.ch cgit interface