Merge tag 'tty-5.6-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty
[linux-2.6-microblaze.git] / Documentation / isdn / avmb1.rst
1 ================================
2 Driver for active AVM Controller
3 ================================
4
5 The driver provides a kernel capi2.0 Interface (kernelcapi) and
6 on top of this a User-Level-CAPI2.0-interface (capi)
7 and a driver to connect isdn4linux with CAPI2.0 (capidrv).
8 The lowlevel interface can be used to implement a CAPI2.0
9 also for passive cards since July 1999.
10
11 The author can be reached at calle@calle.in-berlin.de.
12 The command avmcapictrl is part of the isdn4k-utils.
13 t4-files can be found at ftp://ftp.avm.de/cardware/b1/linux/firmware
14
15 Currently supported cards:
16
17         - B1 ISA (all versions)
18         - B1 PCI
19         - T1/T1B (HEMA card)
20         - M1
21         - M2
22         - B1 PCMCIA
23
24 Installing
25 ----------
26
27 You need at least /dev/capi20 to load the firmware.
28
29 ::
30
31     mknod /dev/capi20 c 68 0
32     mknod /dev/capi20.00 c 68 1
33     mknod /dev/capi20.01 c 68 2
34     .
35     .
36     .
37     mknod /dev/capi20.19 c 68 20
38
39 Running
40 -------
41
42 To use the card you need the t4-files to download the firmware.
43 AVM GmbH provides several t4-files for the different D-channel
44 protocols (b1.t4 for Euro-ISDN). Install these file in /lib/isdn.
45
46 if you configure as modules load the modules this way::
47
48     insmod /lib/modules/current/misc/capiutil.o
49     insmod /lib/modules/current/misc/b1.o
50     insmod /lib/modules/current/misc/kernelcapi.o
51     insmod /lib/modules/current/misc/capidrv.o
52     insmod /lib/modules/current/misc/capi.o
53
54 if you have an B1-PCI card load the module b1pci.o::
55
56     insmod /lib/modules/current/misc/b1pci.o
57
58 and load the firmware with::
59
60     avmcapictrl load /lib/isdn/b1.t4 1
61
62 if you have an B1-ISA card load the module b1isa.o
63 and add the card by calling::
64
65     avmcapictrl add 0x150 15
66
67 and load the firmware by calling::
68
69     avmcapictrl load /lib/isdn/b1.t4 1
70
71 if you have an T1-ISA card load the module t1isa.o
72 and add the card by calling::
73
74     avmcapictrl add 0x450 15 T1 0
75
76 and load the firmware by calling::
77
78     avmcapictrl load /lib/isdn/t1.t4 1
79
80 if you have an PCMCIA card (B1/M1/M2) load the module b1pcmcia.o
81 before you insert the card.
82
83 Leased Lines with B1
84 --------------------
85
86 Init card and load firmware.
87
88 For an D64S use "FV: 1" as phone number
89
90 For an D64S2 use "FV: 1" and "FV: 2" for multilink
91 or "FV: 1,2" to use CAPI channel bundling.
92
93 /proc-Interface
94 -----------------
95
96 /proc/capi::
97
98   dr-xr-xr-x   2 root     root            0 Jul  1 14:03 .
99   dr-xr-xr-x  82 root     root            0 Jun 30 19:08 ..
100   -r--r--r--   1 root     root            0 Jul  1 14:03 applications
101   -r--r--r--   1 root     root            0 Jul  1 14:03 applstats
102   -r--r--r--   1 root     root            0 Jul  1 14:03 capi20
103   -r--r--r--   1 root     root            0 Jul  1 14:03 capidrv
104   -r--r--r--   1 root     root            0 Jul  1 14:03 controller
105   -r--r--r--   1 root     root            0 Jul  1 14:03 contrstats
106   -r--r--r--   1 root     root            0 Jul  1 14:03 driver
107   -r--r--r--   1 root     root            0 Jul  1 14:03 ncci
108   -r--r--r--   1 root     root            0 Jul  1 14:03 users
109
110 /proc/capi/applications:
111    applid level3cnt datablkcnt datablklen ncci-cnt recvqueuelen
112         level3cnt:
113             capi_register parameter
114         datablkcnt:
115             capi_register parameter
116         ncci-cnt:
117             current number of nccis (connections)
118         recvqueuelen:
119             number of messages on receive queue
120
121    for example::
122
123         1 -2 16 2048 1 0
124         2 2 7 2048 1 0
125
126 /proc/capi/applstats:
127    applid recvctlmsg nrecvdatamsg nsentctlmsg nsentdatamsg
128         recvctlmsg:
129             capi messages received without DATA_B3_IND
130         recvdatamsg:
131             capi DATA_B3_IND received
132         sentctlmsg:
133             capi messages sent without DATA_B3_REQ
134         sentdatamsg:
135             capi DATA_B3_REQ sent
136
137    for example::
138
139         1 2057 1699 1721 1699
140
141 /proc/capi/capi20: statistics of capi.o (/dev/capi20)
142     minor nopen nrecvdropmsg nrecvctlmsg nrecvdatamsg sentctlmsg sentdatamsg
143         minor:
144             minor device number of capi device
145         nopen:
146             number of calls to devices open
147         nrecvdropmsg:
148             capi messages dropped (messages in recvqueue in close)
149         nrecvctlmsg:
150             capi messages received without DATA_B3_IND
151         nrecvdatamsg:
152             capi DATA_B3_IND received
153         nsentctlmsg:
154             capi messages sent without DATA_B3_REQ
155         nsentdatamsg:
156             capi DATA_B3_REQ sent
157
158    for example::
159
160         1 2 18 0 16 2
161
162 /proc/capi/capidrv: statistics of capidrv.o (capi messages)
163     nrecvctlmsg nrecvdatamsg sentctlmsg sentdatamsg
164         nrecvctlmsg:
165             capi messages received without DATA_B3_IND
166         nrecvdatamsg:
167             capi DATA_B3_IND received
168         nsentctlmsg:
169             capi messages sent without DATA_B3_REQ
170         nsentdatamsg:
171             capi DATA_B3_REQ sent
172
173    for example:
174         2780 2226 2256 2226
175
176 /proc/capi/controller:
177    controller drivername state cardname   controllerinfo
178
179    for example::
180
181         1 b1pci      running  b1pci-e000       B1 3.07-01 0xe000 19
182         2 t1isa      running  t1isa-450        B1 3.07-01 0x450 11 0
183         3 b1pcmcia   running  m2-150           B1 3.07-01 0x150 5
184
185 /proc/capi/contrstats:
186     controller nrecvctlmsg nrecvdatamsg sentctlmsg sentdatamsg
187         nrecvctlmsg:
188             capi messages received without DATA_B3_IND
189         nrecvdatamsg:
190             capi DATA_B3_IND received
191         nsentctlmsg:
192             capi messages sent without DATA_B3_REQ
193         nsentdatamsg:
194             capi DATA_B3_REQ sent
195
196    for example::
197
198         1 2845 2272 2310 2274
199         2 2 0 2 0
200         3 2 0 2 0
201
202 /proc/capi/driver:
203    drivername ncontroller
204
205    for example::
206
207         b1pci                            1
208         t1isa                            1
209         b1pcmcia                         1
210         b1isa                            0
211
212 /proc/capi/ncci:
213    apllid ncci winsize sendwindow
214
215    for example::
216
217         1 0x10101 8 0
218
219 /proc/capi/users: kernelmodules that use the kernelcapi.
220    name
221
222    for example::
223
224         capidrv
225         capi20
226
227 Questions
228 ---------
229
230 Check out the FAQ (ftp.isdn4linux.de) or subscribe to the
231 linux-avmb1@calle.in-berlin.de mailing list by sending
232 a mail to majordomo@calle.in-berlin.de with
233 subscribe linux-avmb1
234 in the body.
235
236 German documentation and several scripts can be found at
237 ftp://ftp.avm.de/cardware/b1/linux/
238
239 Bugs
240 ----
241
242 If you find any please let me know.
243
244 Enjoy,
245
246 Carsten Paeth (calle@calle.in-berlin.de)