Typos in man pages: toolyou
[dahdi/tools.git] / xpp / astribank_hexload.8
1 .TH "ASTRIBANK_HEXLOAD" "8" "30 May 2011" "" ""
2
3 .SH NAME
4 astribank_tool \- Xorcom Astribank (xpp) firmware loader
5 .SH SYNOPSIS
6 .B astribank_tool \-D \fIdevice-path\fR \-F [\fIoptions\fR] \fIhexfile\fR
7
8 .B astribank_tool \-D \fIdevice-path\fR \-p [\fIoptions\fR] \fIhexfile1 .. hexfile4\fR
9
10 .B astribank_tool \-D \fIdevice-path\fR \-O [-A] [\fIoptions\fR] \fIimagefile\fR
11
12 .B astribank_tool \-D \fIdevice-path\fR \-o [\fIoptions\fR]
13
14 .B astribank_tool \-D \fIdevice-path\fR \-E [\fIoptions\fR] \fIhexfile\fR
15
16 .B astribank_tool \-h
17
18 .SH DESCRIPTION
19 .B astribank_hexload
20 is a second-stage firmware loader for Xorcom Astribanks. Note that some 
21 older models use fpga_load(8) instead.
22
23 It is used to load a file in the Intel HEX format into a Xorcom
24 Astribank. It can be used to load either an FPGA firmware or a PIC
25 firmware. It is normally run by the script xpp_fxloader.
26
27 .SH OPTIONS
28 .B \-D 
29 .I device-path
30 .RS
31 Required. The device to read from/write to. This is
32 \fIbus_num\fR/\fIdevice_num\fR, where \fIbus_num\fR and \fIdevice_num\fR
33 are the first two numbers in the output of lsusb(8) or dahdi_hardware(8).
34 On older versions of this tool you needed a complete path to the device,
35 which would be /dev/bus/usb/\fIbus_num\fR/\fIdevice_num\fR, or
36 /proc/bus/usb/\fIbus_num\fR/\fIdevice_num\fR.
37 .RE
38
39 One of the following is required:
40
41 .B \-F
42 .RS
43 The firmware to load is a FPGA firmware.
44 .RE
45
46 .B \-p
47 .RS
48 The firmwares to load is are PIC firmwares. All (typically 4) should be
49 on the command-line.
50 .RE
51
52 .B \-O
53 .RS
54 The firmware to load is an Octasic echo canceller firmware image file.
55 .RE
56
57 .B \-o
58 .RS
59 Don't load firmware. Just print the version number of the currently-loaded
60 Octasic echo canceller firmware.
61 .RE
62
63 .B \-E
64 .RS
65 The firmware to load is a special EEPROM burning one.
66 .RE
67
68
69 Other options:
70
71 .B \-v
72 .RS
73 Increase verbosity. May be used multiple times.
74 .RE
75
76 .B \-d \fImask\fR
77 .RS
78 Set debug mask to \fImask\fR. Default is 0, 0xFF is "everything".
79 .RE
80
81 .B \-h
82 .RS
83 Displays usage message.
84 .RE
85
86 .B \-A
87 .RS
88 When loading a Octasic echo canceller firmware, set the channels of the
89 first Astribank module to use aLaw (G.711a). This is what you'd normally
90 use for BRI and E1. If not set, the default mu-Law (G.711u), which is
91 what you'd normally use for FXS, FXO and T1.
92 .RE
93
94 .SH SEE ALSO
95 fxload(8), lsusb(8), astribank_tool(8), fpga_load(8)
96
97 .SH AUTHOR
98 This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> .
99 Permission is granted to copy, distribute and/or modify this document under
100 the terms of the GNU General Public License, Version 2 any 
101 later version published by the Free Software Foundation.
102
103 On Debian systems, the complete text of the GNU General Public
104 License can be found in /usr/share/common\-licenses/GPL.