configure.ac: add libusb/libusbx support (for xpp)
[dahdi/tools.git] / xpp / astribank_hexload.8
1 .TH "ASTRIBANK_HEXLOAD" "8" "30 May 2011" "" ""
2
3 .SH NAME
4 astribank_hexload \- Xorcom Astribank (xpp) firmware loader
5 .SH SYNOPSIS
6 .B astribank_hexload \-D \fIdevice-path\fR \-F [\fIoptions\fR] \fIhexfile\fR
7
8 .B astribank_hexload \-D \fIdevice-path\fR \-p [\fIoptions\fR] \fIhexfile1 .. hexfile4\fR
9
10 .B astribank_hexload \-D \fIdevice-path\fR \-O [-A] [-S \fIspan-specs\fR] [\fIoptions\fR] \fIimagefile\fR
11
12 .B astribank_hexload \-D \fIdevice-path\fR \-o [\fIoptions\fR]
13
14 .B astribank_hexload \-D \fIdevice-path\fR \-E [\fIoptions\fR] \fIhexfile\fR
15
16 .B astribank_hexload \-h
17
18 .SH DESCRIPTION
19 .B astribank_hexload
20 is a second-stage firmware loader for Xorcom Astribanks.
21
22 Note that some very old models use fpga_load(8) instead.
23 This legacy tool hasn't been used for several releases.
24 It can be found in version 2.6 and below of dahdi-tools.
25
26 The astribank_hexload(8) program is used to load a file in the
27 Intel HEX format into a Xorcom Astribank.
28 It can be used to load either an FPGA firmware or a PIC
29 firmware. It is normally run by the script xpp_fxloader.
30
31 .SH OPTIONS
32 .B \-D
33 .I device-path
34 .RS
35 Required. The device to read from/write to. This is
36 \fIbus_num\fR/\fIdevice_num\fR, where \fIbus_num\fR and \fIdevice_num\fR
37 are the first two numbers in the output of lsusb(8) or dahdi_hardware(8).
38 On older versions of this tool you needed a complete path to the device,
39 which would be /dev/bus/usb/\fIbus_num\fR/\fIdevice_num\fR, or
40 /proc/bus/usb/\fIbus_num\fR/\fIdevice_num\fR.
41 .RE
42
43 One of the following is required:
44
45 .B \-F
46 .RS
47 The firmware to load is a FPGA firmware.
48 .RE
49
50 .B \-p
51 .RS
52 The firmwares to load is are PIC firmwares. All (typically 4) should be
53 on the command-line.
54 .RE
55
56 .B \-O
57 .RS
58 The firmware to load is an Octasic echo canceller firmware image file.
59 .RE
60
61 .B \-o
62 .RS
63 Don't load firmware. Just print the version number of the currently-loaded
64 Octasic echo canceller firmware.
65 .RE
66
67 .B \-E
68 .RS
69 The firmware to load is a special EEPROM burning one.
70 .RE
71
72
73 Other options:
74
75 .B \-v
76 .RS
77 Increase verbosity. May be used multiple times.
78 .RE
79
80 .B \-d \fImask\fR
81 .RS
82 Set debug mask to \fImask\fR. Default is 0, 0xFF is "everything".
83 .RE
84
85 .B \-h
86 .RS
87 Displays usage message.
88 .RE
89
90 .B \-A
91 .RS
92 When loading a Octasic echo canceller firmware, set the channels of the
93 first Astribank module to use aLaw (G.711a). This is what you'd normally
94 use for BRI and E1. If not set, the default mu-Law (G.711u), which is
95 what you'd normally use for FXS, FXO and T1.
96 .RE
97
98 .B \-S \fIspan-specs\fR
99 .RS
100 This option should only be used when loading Octasic echo canceller firmware
101 and only if the first Astribank module is PRI.
102
103 Its goal is to allow specifying different \fIline-mode\fR (E1/T1/J1) in different
104 ports of the PRI module. \fBastribank_hexload\fR use the \fIspan-specs\fR argument
105 to select aLaw/uLaw for each of the PRI ports in the module.
106
107 The \fIspan-specs\fR is a list of items separated by whitespace or commas.
108 Each item is composed of a port selector, colon and a \fIline-mode\fR specifier.
109 This syntax follows the syntax of specifiers in \fB/etc/dahdi/span-types.conf\fR.
110
111 Examples:
112 .RS
113 3:E1 \- The 3'rd port is E1.
114
115 *:T1 \- Any unspecified port is T1 (wildcard match).
116
117 1:T1,2:T1,*:E1 \- First and second ports are T1, the rest are E1.
118 .RE
119
120 If the \fB\-S\fR is not given, the PRI default is determined by the existance of the \fB\-A-fR option.
121 .RE
122
123 .SH SEE ALSO
124 fxload(8), lsusb(8), astribank_tool(8)
125
126 .SH AUTHOR
127 This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> .
128 Permission is granted to copy, distribute and/or modify this document under
129 the terms of the GNU General Public License, Version 2 any
130 later version published by the Free Software Foundation.
131
132 On Debian systems, the complete text of the GNU General Public
133 License can be found in /usr/share/common\-licenses/GPL.