summaryrefslogtreecommitdiff
path: root/xpp/fpga_load.8
blob: dd21db06d2851dd65d4e417e8fa8452583a35e5a (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
.TH "FPGA_LOAD" "8" "16 April 2006" "" ""

.SH NAME
fpga_load \- Xorcom Astribank (xpp) firmware tool
.SH SYNOPSIS

.B fpga_load 
[\fB-g\fR] [\fB-r\fR] [\fB-v\fR] \fB-D \fR{/proc/bus/usb|/dev/bus/usb}/\fIBUS/DEV\fR 

.B fpga_load 
[\fB-g\fR] [\fB-v\fR] \fB-D \fR{/proc/bus/usb|/dev/bus/usb}/\fIBUS/DEV\fR \fB-I \fIfirmware.hex\fR [\fB-b \fIdump.bin\fR] [\fB-i\fR]

.B fpga_load -h

.SH DESCRIPTION
.B fpga_load 
loads the FPGA firmware to the Xorcom Astribank device.
The syntax resembles that of fxload(8).

.SH OPTIONS
.B -b
.I dump.bin
.RS
Before writing firmware, bump the processed binary file to 
.I dump.bin\fR.
.RE

.B -D 
.I DEVICE
.RS
Required. The device to read from/write to. On modern UDEV-based system
this is usually /dev/bus/usb/\fIbus_num\fR/\fIdevice_num\fR,
where \fIbus_num\fR and \fIdevice_num\fR are the first two numbers in the
output of lsusb(8).
On older systems that use usbfs, it is usually
/proc/bus/usb/\fIbus_num\fR/\fIdevice_num\fR.
.RE

.B -r
.RS
Reset the Astribank and renumerate its USB connection to power on product ID.
.RE

.B -g
.RS
Dump all eeprom data to standard output.
.RE

.B -I
.I fireware_file
.RS
The firmware file to write to the device.
.RE

.B -i
.RS
Show information about the firmware file (valid only with \fB-I\fR option).
Example:
.PP
	./FPGA_1151.hex: Version=3297 Checksum=58270

In particular, the calculated checksum should match the output of \fIsum(1)\fR
on the binary firmware file generated by the \fB-b\fR option.
.RE

.B -v
.RS
Increase verbosity. May be used multiple times.
.RE

.B -h
.RS
Displays usage message.
.RE

.SH SEE ALSO
fxload(8), lsusb(8)

.SH AUTHOR
This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> .
Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU General Public License, Version 2 any 
later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.