1 |
199 |
simons |
$Id: INTERFACE,v 1.1.1.1 2001-09-10 07:44:09 simons Exp $
|
2 |
|
|
|
3 |
|
|
Description of the Interface between Linklevel and Hardwarelevel
|
4 |
|
|
of isdn4linux:
|
5 |
|
|
|
6 |
|
|
|
7 |
|
|
The Communication between Linklevel (LL) and Hardwarelevel (HL)
|
8 |
|
|
is based on the struct isdn_if (defined in isdnif.h).
|
9 |
|
|
|
10 |
|
|
An HL-driver can register itself at LL by calling the function
|
11 |
|
|
register_isdn() with a pointer to that struct. Prior to that, it has
|
12 |
|
|
to preset some of the fields of isdn_if. The LL sets the rest of
|
13 |
|
|
the fields. All further communication is done via callbacks using
|
14 |
|
|
the function-pointers defined in isdn_if.
|
15 |
|
|
|
16 |
|
|
Changes/Version numbering:
|
17 |
|
|
|
18 |
|
|
During development of the ISDN subsystem, several changes have been
|
19 |
|
|
made to the interface. Before it went into kernel, the package
|
20 |
|
|
had a unique version number. The last version, distributed separately
|
21 |
|
|
was 0.7.4. When the subsystem went into kernel, every functional unit
|
22 |
|
|
got a separate version number. These numbers are shown at initialization,
|
23 |
|
|
separated by slashes:
|
24 |
|
|
|
25 |
|
|
c.c/t.t/n.n/p.p/a.a
|
26 |
|
|
|
27 |
|
|
where
|
28 |
|
|
|
29 |
|
|
c.c is the revision of the common code.
|
30 |
|
|
t.t is the revision of the tty related code.
|
31 |
|
|
n.n is the revision of the network related code.
|
32 |
|
|
p.p is the revision of the ppp related code.
|
33 |
|
|
a.a is the revision of the audio related code.
|
34 |
|
|
|
35 |
|
|
Changes in this document are marked with '***CHANGEx' where x representing
|
36 |
|
|
the version number. If that number starts with 0, it refers to the old,
|
37 |
|
|
separately distributed package. If it starts with one of the letters
|
38 |
|
|
above, it refers to the revision of the corresponding module.
|
39 |
|
|
|
40 |
|
|
1. Description of the fields of isdn_if:
|
41 |
|
|
|
42 |
|
|
int channels;
|
43 |
|
|
|
44 |
|
|
This field has to be set by the HL-driver to the number of channels
|
45 |
|
|
supported prior to calling register_isdn(). Upon return of the call,
|
46 |
|
|
the LL puts an id there, which has to be used by the HL-driver when
|
47 |
|
|
invoking the other callbacks.
|
48 |
|
|
|
49 |
|
|
int maxbufsize;
|
50 |
|
|
|
51 |
|
|
***CHANGE0.6: New since this version.
|
52 |
|
|
|
53 |
|
|
Also to be preset by the HL-driver. With this value the HL-driver
|
54 |
|
|
tells to the LL the maximum size of a data-packet it will accept.
|
55 |
|
|
|
56 |
|
|
unsigned long features;
|
57 |
|
|
|
58 |
|
|
To be preset by the HL-driver. Using this field, the HL-driver
|
59 |
|
|
announces the features supported. At the moment this is limited to
|
60 |
|
|
report the supported layer2 and layer3-protocols. For setting this
|
61 |
|
|
field the constants ISDN_FEATURE..., declared in isdnif.h have to be
|
62 |
|
|
used.
|
63 |
|
|
|
64 |
|
|
***CHANGE0.7.1: The line type (1TR6, EDSS1) has to be set.
|
65 |
|
|
|
66 |
|
|
unsigned short hl_hdrlen;
|
67 |
|
|
|
68 |
|
|
***CHANGED.7.4: New field.
|
69 |
|
|
|
70 |
|
|
To be preset by the HL-driver, if it supports sk_buff's. The driver
|
71 |
|
|
should put here the amount of additional space needed in sk-buff's for
|
72 |
|
|
its internal purposes. Drivers not supporting sk_buff's should put
|
73 |
|
|
initialize this field to 0.
|
74 |
|
|
|
75 |
|
|
void (*rcvcallb)(int, int, u_char*, int);
|
76 |
|
|
|
77 |
|
|
***CHANGEc1.14: Declared obsolete. Do NOT use this field/function
|
78 |
|
|
anymore, since it will be removed when all current
|
79 |
|
|
LL drivers have been changed accordingly. Use
|
80 |
|
|
rcvcallb_skb instead.
|
81 |
|
|
|
82 |
|
|
This field will be set by LL. The HL-driver delivers received data-
|
83 |
|
|
packets by calling this function.
|
84 |
|
|
|
85 |
|
|
Parameter:
|
86 |
|
|
int driver-Id
|
87 |
|
|
int Channel-number locally to the driver. (starting with 0)
|
88 |
|
|
u_char Pointer to received data. (in kernel-space)
|
89 |
|
|
int length of data-packet.
|
90 |
|
|
|
91 |
|
|
void (*rcvcallb_skb)(int, int, struct sk_buff *)
|
92 |
|
|
|
93 |
|
|
***CHANGED.7.4: New field.
|
94 |
|
|
|
95 |
|
|
This field will be set by LL. The HL-driver delivers received data-
|
96 |
|
|
packets by calling this function. Upon calling, the HL-driver must
|
97 |
|
|
already have its private data pulled off the head of the sk_buff.
|
98 |
|
|
|
99 |
|
|
Parameter:
|
100 |
|
|
int driver-Id
|
101 |
|
|
int Channel-number locally to the driver. (starting with 0)
|
102 |
|
|
struct sk_buff * Pointer to sk_buff, containing received data.
|
103 |
|
|
|
104 |
|
|
int (*statcallb)(isdn_ctrl*);
|
105 |
|
|
|
106 |
|
|
This field will be set by LL. This function has to be called by the
|
107 |
|
|
HL-driver for signaling status-changes or other events to the LL.
|
108 |
|
|
|
109 |
|
|
Parameter:
|
110 |
|
|
isdn_ctrl*
|
111 |
|
|
|
112 |
|
|
The struct isdn_ctrl also defined in isdn_if. The exact meanings of its
|
113 |
|
|
fields are described together with the descriptions of the possible
|
114 |
|
|
events. Here is only a short description of the fields:
|
115 |
|
|
|
116 |
|
|
driver = driver Id.
|
117 |
|
|
command = event-type. (one of the constants ISDN_STAT_...)
|
118 |
|
|
arg = depends on event-type.
|
119 |
|
|
num = depends on event-type.
|
120 |
|
|
|
121 |
|
|
Returnvalue:
|
122 |
|
|
|
123 |
|
|
|
124 |
|
|
int (*command)(isdn_ctrl*);
|
125 |
|
|
|
126 |
|
|
This field has to be preset by the HL-driver. It points to a function,
|
127 |
|
|
to be called by LL to perform functions like dialing, B-channel
|
128 |
|
|
setup, etc. The exact meaning of the parameters is described with the
|
129 |
|
|
descriptions of the possible commands.
|
130 |
|
|
|
131 |
|
|
Parameter:
|
132 |
|
|
isdn_ctrl*
|
133 |
|
|
driver = driver-Id
|
134 |
|
|
command = command to perform. (one of the constants ISDN_CMD_...)
|
135 |
|
|
arg = depends on command.
|
136 |
|
|
num = depends on command.
|
137 |
|
|
|
138 |
|
|
Returnvalue:
|
139 |
|
|
>=0 on success, else error-code (-ENODEV etc.)
|
140 |
|
|
|
141 |
|
|
int (*writebuf)(int, int, u_char*, int, int);
|
142 |
|
|
|
143 |
|
|
***CHANGED1.14: Declared obsolete. Do NOT use this field/function
|
144 |
|
|
anymore, since it will be removed when all current
|
145 |
|
|
LL drivers have been changed accordingly. Set this
|
146 |
|
|
field to NULL and use writebuf_skb instead.
|
147 |
|
|
|
148 |
|
|
This field has to be preset by the HL-driver. The given function will
|
149 |
|
|
be called by the LL for delivering data to be send via B-Channel.
|
150 |
|
|
|
151 |
|
|
Parameter:
|
152 |
|
|
int driver-Id ***CHANGE.7.4: New parameter.
|
153 |
|
|
int channel-number locally to the HL-driver. (starts with 0)
|
154 |
|
|
u_char* pointer to data.
|
155 |
|
|
int length of data-packet.
|
156 |
|
|
int flag: 0 = call from within kernel-space. (HL-driver must use
|
157 |
|
|
memcpy, may NOT use schedule())
|
158 |
|
|
1 = call from user-space. (HL-driver must use
|
159 |
|
|
memcpy_fromfs, use of schedule() allowed)
|
160 |
|
|
|
161 |
|
|
Returnvalue:
|
162 |
|
|
Length of data accepted on success, else error-code (-EINVAL on
|
163 |
|
|
oversized packets etc.)
|
164 |
|
|
|
165 |
|
|
int (*writebuf_skb)(int, int, struct sk_buff *)
|
166 |
|
|
|
167 |
|
|
***CHANGED.7.4: New field.
|
168 |
|
|
|
169 |
|
|
This field has to be preset by the HL-driver. The given function will
|
170 |
|
|
be called by the LL for delivering data to be send via B-Channel.
|
171 |
|
|
|
172 |
|
|
|
173 |
|
|
Parameter:
|
174 |
|
|
int driver-Id ***CHANGE.7.4: New parameter.
|
175 |
|
|
int channel-number locally to the HL-driver. (starts with 0)
|
176 |
|
|
struct sk_buff * Pointer to sk_buff containing data to be send via
|
177 |
|
|
B-channel.
|
178 |
|
|
|
179 |
|
|
Returnvalue:
|
180 |
|
|
Length of data accepted on success, else error-code (-EINVAL on
|
181 |
|
|
oversized packets etc.)
|
182 |
|
|
|
183 |
|
|
int (*writecmd)(u_char*, int, int, int, int);
|
184 |
|
|
|
185 |
|
|
This field has to be preset by the HL-driver. The given function will be
|
186 |
|
|
called to perform write-requests on /dev/isdnctrl (i.e. sending commands
|
187 |
|
|
to the card) The data-format is hardware-specific. This function is
|
188 |
|
|
intended for debugging only. It is not necessary for normal operation
|
189 |
|
|
and never will be called by the tty-emulation- or network-code. If
|
190 |
|
|
this function is not supported, the driver has to set NULL here.
|
191 |
|
|
|
192 |
|
|
Parameter:
|
193 |
|
|
u_char* pointer to data.
|
194 |
|
|
int length of data.
|
195 |
|
|
int flag: 0 = call from within kernel-space. (HL-driver must use
|
196 |
|
|
memcpy, may NOT use schedule())
|
197 |
|
|
1 = call from user-space. (HL-driver must use
|
198 |
|
|
memcpy_fromfs, use of schedule() allowed)
|
199 |
|
|
int driver-Id.
|
200 |
|
|
int channel-number locally to the HL-driver. (starts with 0)
|
201 |
|
|
|
202 |
|
|
***CHANGED1.14: The driver-Id and channel-number are new since this revision.
|
203 |
|
|
|
204 |
|
|
Returnvalue:
|
205 |
|
|
Length of data accepted on success, else error-code (-EINVAL etc.)
|
206 |
|
|
|
207 |
|
|
int (*readstat)(u_char*, int, int, int, int);
|
208 |
|
|
|
209 |
|
|
This field has to be preset by the HL-driver. The given function will be
|
210 |
|
|
called to perform read-requests on /dev/isdnctrl (i.e. reading replies
|
211 |
|
|
from the card) The data-format is hardware-specific. This function is
|
212 |
|
|
intended for debugging only. It is not necessary for normal operation
|
213 |
|
|
and never will be called by the tty-emulation- or network-code. If
|
214 |
|
|
this function is not supported, the driver has to set NULL here.
|
215 |
|
|
|
216 |
|
|
Parameter:
|
217 |
|
|
u_char* pointer to data.
|
218 |
|
|
int length of data.
|
219 |
|
|
int flag: 0 = call from within kernel-space. (HL-driver must use
|
220 |
|
|
memcpy, may NOT use schedule())
|
221 |
|
|
1 = call from user-space. (HL-driver must use
|
222 |
|
|
memcpy_fromfs, use of schedule() allowed)
|
223 |
|
|
int driver-Id.
|
224 |
|
|
int channel-number locally to the HL-driver. (starts with 0)
|
225 |
|
|
|
226 |
|
|
***CHANGED1.14: The driver-Id and channel-number are new since this revision.
|
227 |
|
|
|
228 |
|
|
Returnvalue:
|
229 |
|
|
Length of data on success, else error-code (-EINVAL etc.)
|
230 |
|
|
|
231 |
|
|
char id[20];
|
232 |
|
|
***CHANGE0.7: New since this version.
|
233 |
|
|
|
234 |
|
|
This string has to be preset by the HL-driver. Its purpose is for
|
235 |
|
|
identification of the driver by the user. Eg.: it is shown in the
|
236 |
|
|
status-info of /dev/isdninfo. Furthermore it is used as Id for binding
|
237 |
|
|
net-interfaces to a specific channel. If a string of length zero is
|
238 |
|
|
given, upon return, isdn4linux will replace it by a generic name. (line0,
|
239 |
|
|
line1 etc.) It is recommended to make this string configurable during
|
240 |
|
|
module-load-time. (copy a global variable to this string.) For doing that,
|
241 |
|
|
modules 1.2.8 or newer are necessary.
|
242 |
|
|
|
243 |
|
|
2. Description of the commands, a HL-driver has to support:
|
244 |
|
|
|
245 |
|
|
All commands will be performed by calling the function command() described
|
246 |
|
|
above from within the LL. The field command of the struct-parameter will
|
247 |
|
|
contain the desired command, the field driver always is set to the
|
248 |
|
|
appropriate driver-Id.
|
249 |
|
|
|
250 |
|
|
Until now, the following commands are defined:
|
251 |
|
|
|
252 |
|
|
***CHANGED1.34: The parameter "num" has been replaced by a union "para" containing
|
253 |
|
|
the old "num" and a new setup_type struct used for ISDN_CMD_DIAL
|
254 |
|
|
and ISDN_STAT_ICALL callback.
|
255 |
|
|
|
256 |
|
|
ISDN_CMD_IOCTL:
|
257 |
|
|
|
258 |
|
|
This command is intended for performing ioctl-calls for configuring
|
259 |
|
|
hardware or similar purposes (setting port-addresses, loading firmware
|
260 |
|
|
etc.) For this purpose, in the LL all ioctl-calls with an argument
|
261 |
|
|
>= IIOCDRVCTL (0x100) will be handed transparently to this
|
262 |
|
|
function after subtracting 0x100 and placing the result in arg.
|
263 |
|
|
Example:
|
264 |
|
|
If a userlevel-program calls ioctl(0x101,...) the function gets
|
265 |
|
|
called with the field command set to 1.
|
266 |
|
|
|
267 |
|
|
Parameter:
|
268 |
|
|
driver = driver-Id.
|
269 |
|
|
command = ISDN_CMD_IOCTL
|
270 |
|
|
arg = Original ioctl-cmd - IIOCDRVCTL
|
271 |
|
|
para.num = first bytes filled with (unsigned long)arg
|
272 |
|
|
|
273 |
|
|
Returnvalue:
|
274 |
|
|
Depending on driver.
|
275 |
|
|
|
276 |
|
|
|
277 |
|
|
ISDN_CMD_DIAL:
|
278 |
|
|
|
279 |
|
|
This command is used to tell the HL-driver it should dial a given
|
280 |
|
|
number.
|
281 |
|
|
|
282 |
|
|
Parameter:
|
283 |
|
|
driver = driver-Id.
|
284 |
|
|
command = ISDN_CMD_DIAL
|
285 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
286 |
|
|
|
287 |
|
|
para.setup.phone = An ASCII-String containing the number to dial.
|
288 |
|
|
para.setup.eazmsn = An ASCII-Sting containing the own EAZ or MSN.
|
289 |
|
|
para.setup.si1 = The Service-Indicator.
|
290 |
|
|
para.setup.si2 = Additional Service-Indicator.
|
291 |
|
|
|
292 |
|
|
If the Line has been designed as SPV (a special german
|
293 |
|
|
feature, meaning semi-leased-line) the phone has to
|
294 |
|
|
start with an "S".
|
295 |
|
|
***CHANGE0.6: In previous versions the EAZ has been given in the
|
296 |
|
|
highbyte of arg.
|
297 |
|
|
***CHANGE0.7.1: New since this version: ServiceIndicator and AddInfo.
|
298 |
|
|
|
299 |
|
|
ISDN_CMD_ACCEPTD:
|
300 |
|
|
|
301 |
|
|
With this command, the HL-driver is told to accept a D-Channel-setup.
|
302 |
|
|
(Response to an incoming call)
|
303 |
|
|
|
304 |
|
|
Parameter:
|
305 |
|
|
driver = driver-Id.
|
306 |
|
|
command = ISDN_CMD_ACCEPTD
|
307 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
308 |
|
|
para = unused.
|
309 |
|
|
|
310 |
|
|
ISDN_CMD_ACCEPTB:
|
311 |
|
|
|
312 |
|
|
With this command, the HL-driver is told to perform a B-Channel-setup.
|
313 |
|
|
(after establishing D-Channel-Connection)
|
314 |
|
|
|
315 |
|
|
Parameter:
|
316 |
|
|
driver = driver-Id.
|
317 |
|
|
command = ISDN_CMD_ACCEPTB
|
318 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
319 |
|
|
para = unused.
|
320 |
|
|
|
321 |
|
|
ISDN_CMD_HANGUP:
|
322 |
|
|
|
323 |
|
|
With this command, the HL-driver is told to hangup (B-Channel if
|
324 |
|
|
established first, then D-Channel). This command is also used for
|
325 |
|
|
actively rejecting an incoming call.
|
326 |
|
|
|
327 |
|
|
Parameter:
|
328 |
|
|
driver = driver-Id.
|
329 |
|
|
command = ISDN_CMD_HANGUP
|
330 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
331 |
|
|
para = unused.
|
332 |
|
|
|
333 |
|
|
ISDN_CMD_CLREAZ:
|
334 |
|
|
|
335 |
|
|
With this command, the HL-driver is told not to signal incoming
|
336 |
|
|
calls to the LL.
|
337 |
|
|
|
338 |
|
|
Parameter:
|
339 |
|
|
driver = driver-Id.
|
340 |
|
|
command = ISDN_CMD_CLREAZ
|
341 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
342 |
|
|
para = unused.
|
343 |
|
|
|
344 |
|
|
ISDN_CMD_SETEAZ:
|
345 |
|
|
|
346 |
|
|
With this command, the HL-driver is told to signal incoming calls for
|
347 |
|
|
the given EAZs/MSNs to the LL.
|
348 |
|
|
|
349 |
|
|
Parameter:
|
350 |
|
|
driver = driver-Id.
|
351 |
|
|
command = ISDN_CMD_SETEAZ
|
352 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
353 |
|
|
para.num = ASCII-String, containing the desired EAZ's/MSN's
|
354 |
|
|
(comma-separated). If an empty String is given, the
|
355 |
|
|
HL-driver should respond to ALL incoming calls,
|
356 |
|
|
regardless of the destination-address.
|
357 |
|
|
***CHANGE0.6: New since this version the "empty-string"-feature.
|
358 |
|
|
|
359 |
|
|
ISDN_CMD_GETEAZ: (currently unused)
|
360 |
|
|
|
361 |
|
|
With this command, the HL-driver is told to report the current setting
|
362 |
|
|
given with ISDN_CMD_SETEAZ.
|
363 |
|
|
|
364 |
|
|
Parameter:
|
365 |
|
|
driver = driver-Id.
|
366 |
|
|
command = ISDN_CMD_GETEAZ
|
367 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
368 |
|
|
para.num = ASCII-String, containing the current EAZ's/MSN's
|
369 |
|
|
|
370 |
|
|
ISDN_CMD_SETSIL: (currently unused)
|
371 |
|
|
|
372 |
|
|
With this command, the HL-driver is told to signal only incoming
|
373 |
|
|
calls with the given Service-Indicators.
|
374 |
|
|
|
375 |
|
|
Parameter:
|
376 |
|
|
driver = driver-Id.
|
377 |
|
|
command = ISDN_CMD_SETSIL
|
378 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
379 |
|
|
para.num = ASCII-String, containing the desired Service-Indicators.
|
380 |
|
|
|
381 |
|
|
ISDN_CMD_GETSIL: (currently unused)
|
382 |
|
|
|
383 |
|
|
With this command, the HL-driver is told to return the current
|
384 |
|
|
Service-Indicators it will respond to.
|
385 |
|
|
|
386 |
|
|
Parameter:
|
387 |
|
|
driver = driver-Id.
|
388 |
|
|
command = ISDN_CMD_SETSIL
|
389 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
390 |
|
|
para.num = ASCII-String, containing the current Service-Indicators.
|
391 |
|
|
|
392 |
|
|
ISDN_CMD_SETL2:
|
393 |
|
|
|
394 |
|
|
With this command, the HL-driver is told to select the given Layer-2-
|
395 |
|
|
protocol. This command is issued by the LL prior to ISDN_CMD_DIAL or
|
396 |
|
|
ISDN_CMD_ACCEPTD.
|
397 |
|
|
|
398 |
|
|
|
399 |
|
|
Parameter:
|
400 |
|
|
driver = driver-Id.
|
401 |
|
|
command = ISDN_CMD_SETL2
|
402 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
403 |
|
|
logical or'ed with (protocol-Id << 8)
|
404 |
|
|
protocol-Id is one of the constants ISDN_PROTO_L2...
|
405 |
|
|
para = unused.
|
406 |
|
|
|
407 |
|
|
ISDN_CMD_GETL2: (currently unused)
|
408 |
|
|
|
409 |
|
|
With this command, the HL-driver is told to return the current
|
410 |
|
|
setting of the Layer-2-protocol.
|
411 |
|
|
|
412 |
|
|
Parameter:
|
413 |
|
|
driver = driver-Id.
|
414 |
|
|
command = ISDN_CMD_GETL2
|
415 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
416 |
|
|
para = unused.
|
417 |
|
|
Returnvalue:
|
418 |
|
|
current protocol-Id (one of the constants ISDN_L2_PROTO)
|
419 |
|
|
|
420 |
|
|
ISDN_CMD_SETL3:
|
421 |
|
|
|
422 |
|
|
With this command, the HL-driver is told to select the given Layer-3-
|
423 |
|
|
protocol. This command is issued by the LL prior to ISDN_CMD_DIAL or
|
424 |
|
|
ISDN_CMD_ACCEPTD.
|
425 |
|
|
|
426 |
|
|
|
427 |
|
|
Parameter:
|
428 |
|
|
driver = driver-Id.
|
429 |
|
|
command = ISDN_CMD_SETL3
|
430 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
431 |
|
|
logical or'ed with (protocol-Id << 8)
|
432 |
|
|
protocol-Id is one of the constants ISDN_PROTO_L3...
|
433 |
|
|
para = unused.
|
434 |
|
|
|
435 |
|
|
ISDN_CMD_GETL2: (currently unused)
|
436 |
|
|
|
437 |
|
|
With this command, the HL-driver is told to return the current
|
438 |
|
|
setting of the Layer-3-protocol.
|
439 |
|
|
|
440 |
|
|
Parameter:
|
441 |
|
|
driver = driver-Id.
|
442 |
|
|
command = ISDN_CMD_GETL3
|
443 |
|
|
arg = channel-number locally to the driver. (starting with 0)
|
444 |
|
|
para = unused.
|
445 |
|
|
Returnvalue:
|
446 |
|
|
current protocol-Id (one of the constants ISDN_L3_PROTO)
|
447 |
|
|
|
448 |
|
|
ISDN_CMD_LOCK:
|
449 |
|
|
|
450 |
|
|
With this command the HL-driver is told, that it will be used by the
|
451 |
|
|
LL and therefore may not be unloaded. The HL-driver should use
|
452 |
|
|
MOD_INC_USE_COUNT to tell that to the kernel.
|
453 |
|
|
|
454 |
|
|
Parameter:
|
455 |
|
|
driver = driver-Id.
|
456 |
|
|
command = ISDN_CMD_LOCK
|
457 |
|
|
arg = unused.
|
458 |
|
|
para = unused.
|
459 |
|
|
|
460 |
|
|
ISDN_CMD_UNLOCK:
|
461 |
|
|
|
462 |
|
|
With this command the HL-driver is told, that it is no more used by the
|
463 |
|
|
LL and therefore may be unloaded. The HL-driver should use
|
464 |
|
|
DEC_INC_USE_COUNT to tell that to the kernel.
|
465 |
|
|
|
466 |
|
|
Parameter:
|
467 |
|
|
driver = driver-Id.
|
468 |
|
|
command = ISDN_CMD_UNLOCK
|
469 |
|
|
arg = unused.
|
470 |
|
|
para = unused.
|
471 |
|
|
|
472 |
|
|
3. Description of the events to be signaled by the HL-driver to th LL.
|
473 |
|
|
|
474 |
|
|
All status-changes are signaled via calling the previously described
|
475 |
|
|
function statcallb(). The field command of the struct isdn_cmd has
|
476 |
|
|
to be set by the HL-driver with the appropriate Status-Id (event-number).
|
477 |
|
|
The field arg has to be set to the channel-number (locally to the driver,
|
478 |
|
|
starting with 0) to which this event applies. (Exception: STAVAIL-event)
|
479 |
|
|
|
480 |
|
|
Until now, the following Status-Ids are defined:
|
481 |
|
|
|
482 |
|
|
ISDN_STAT_AVAIL:
|
483 |
|
|
|
484 |
|
|
With this call, the HL-driver signals the availability of new data
|
485 |
|
|
for readstat(). Used only for debugging-purposes, see description
|
486 |
|
|
of readstat().
|
487 |
|
|
|
488 |
|
|
Parameter:
|
489 |
|
|
driver = driver-Id
|
490 |
|
|
command = ISDN_STAT_STAVAIL
|
491 |
|
|
arg = length of available data.
|
492 |
|
|
para = unused.
|
493 |
|
|
|
494 |
|
|
ISDN_STAT_ICALL:
|
495 |
|
|
|
496 |
|
|
With this call, the HL-driver signals an incoming call to the LL.
|
497 |
|
|
|
498 |
|
|
Parameter:
|
499 |
|
|
driver = driver-Id
|
500 |
|
|
command = ISDN_STAT_ICALL
|
501 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
502 |
|
|
para.setup.phone = Callernumber.
|
503 |
|
|
para.setup.eazmsn = CalledNumber.
|
504 |
|
|
para.setup.si1 = Service Indicator.
|
505 |
|
|
para.setup.si2 = Additional Service Indicator.
|
506 |
|
|
para.setup.plan = octet 3 from Calling party number Information Element.
|
507 |
|
|
para.setup.screen = octet 3a from Calling party number Information Element.
|
508 |
|
|
|
509 |
|
|
Return:
|
510 |
|
|
|
511 |
|
|
1 = At least one device matching this call (RING on ttyI).
|
512 |
|
|
HL-driver may send ALERTING on the D-channel in this case.
|
513 |
|
|
2 = Call will be rejected.
|
514 |
|
|
-1 = An error happened. (Invalid parameters for example.)
|
515 |
|
|
|
516 |
|
|
ISDN_STAT_RUN:
|
517 |
|
|
|
518 |
|
|
With this call, the HL-driver signals availability of the ISDN-card.
|
519 |
|
|
(after initializing, loading firmware)
|
520 |
|
|
|
521 |
|
|
Parameter:
|
522 |
|
|
driver = driver-Id
|
523 |
|
|
command = ISDN_STAT_RUN
|
524 |
|
|
arg = unused.
|
525 |
|
|
para = unused.
|
526 |
|
|
|
527 |
|
|
ISDN_STAT_STOP:
|
528 |
|
|
|
529 |
|
|
With this call, the HL-driver signals unavailability of the ISDN-card.
|
530 |
|
|
(before unloading, while resetting/reconfiguring the card)
|
531 |
|
|
|
532 |
|
|
Parameter:
|
533 |
|
|
driver = driver-Id
|
534 |
|
|
command = ISDN_STAT_STOP
|
535 |
|
|
arg = unused.
|
536 |
|
|
para = unused.
|
537 |
|
|
|
538 |
|
|
ISDN_STAT_DCONN:
|
539 |
|
|
|
540 |
|
|
With this call, the HL-driver signals the successful establishment of
|
541 |
|
|
a D-Channel-connection. (Response to ISDN_CMD_ACCEPTD or ISDN_CMD_DIAL)
|
542 |
|
|
|
543 |
|
|
Parameter:
|
544 |
|
|
driver = driver-Id
|
545 |
|
|
command = ISDN_STAT_DCONN
|
546 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
547 |
|
|
para = unused.
|
548 |
|
|
|
549 |
|
|
ISDN_STAT_BCONN:
|
550 |
|
|
|
551 |
|
|
With this call, the HL-driver signals the successful establishment of
|
552 |
|
|
a B-Channel-connection. (Response to ISDN_CMD_ACCEPTB or because the
|
553 |
|
|
remote-station has initiated establishment)
|
554 |
|
|
|
555 |
|
|
Parameter:
|
556 |
|
|
driver = driver-Id
|
557 |
|
|
command = ISDN_STAT_BCONN
|
558 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
559 |
|
|
para = unused.
|
560 |
|
|
|
561 |
|
|
ISDN_STAT_DHUP:
|
562 |
|
|
|
563 |
|
|
With this call, the HL-driver signals the shutdown of a
|
564 |
|
|
D-Channel-connection. This could be a response to a prior ISDN_CMD_HANGUP,
|
565 |
|
|
or caused by a remote-hangup or if the remote-station has actively
|
566 |
|
|
rejected a call.
|
567 |
|
|
|
568 |
|
|
Parameter:
|
569 |
|
|
driver = driver-Id
|
570 |
|
|
command = ISDN_STAT_DHUP
|
571 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
572 |
|
|
para = unused.
|
573 |
|
|
|
574 |
|
|
ISDN_STAT_BHUP:
|
575 |
|
|
|
576 |
|
|
With this call, the HL-driver signals the shutdown of a
|
577 |
|
|
B-Channel-connection. This could be a response to a prior ISDN_CMD_HANGUP,
|
578 |
|
|
or caused by a remote-hangup.
|
579 |
|
|
|
580 |
|
|
Parameter:
|
581 |
|
|
driver = driver-Id
|
582 |
|
|
command = ISDN_STAT_BHUP
|
583 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
584 |
|
|
para = unused.
|
585 |
|
|
|
586 |
|
|
ISDN_STAT_CINF:
|
587 |
|
|
|
588 |
|
|
With this call, the HL-driver delivers charge-unit information to the
|
589 |
|
|
LL.
|
590 |
|
|
|
591 |
|
|
Parameter:
|
592 |
|
|
driver = driver-Id
|
593 |
|
|
command = ISDN_STAT_CINF
|
594 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
595 |
|
|
para.num = ASCII string containing charge-units (digits only).
|
596 |
|
|
|
597 |
|
|
ISDN_STAT_LOAD: (currently unused)
|
598 |
|
|
|
599 |
|
|
ISDN_STAT_UNLOAD:
|
600 |
|
|
|
601 |
|
|
With this call, the HL-driver signals that it will be unloaded now. This
|
602 |
|
|
tells the LL to release all corresponding data-structures.
|
603 |
|
|
|
604 |
|
|
Parameter:
|
605 |
|
|
driver = driver-Id
|
606 |
|
|
command = ISDN_STAT_UNLOAD
|
607 |
|
|
arg = unused.
|
608 |
|
|
para = unused.
|
609 |
|
|
|
610 |
|
|
ISDN_STAT_BSENT:
|
611 |
|
|
|
612 |
|
|
With this call the HL-driver signals the delivery of a data-packet.
|
613 |
|
|
This callback is used by the network-interfaces only, tty-Emulation
|
614 |
|
|
does not need this call.
|
615 |
|
|
|
616 |
|
|
Parameter:
|
617 |
|
|
driver = driver-Id
|
618 |
|
|
command = ISDN_STAT_BSENT
|
619 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
620 |
|
|
para = unused.
|
621 |
|
|
|
622 |
|
|
ISDN_STAT_NODCH:
|
623 |
|
|
|
624 |
|
|
With this call, the driver has to respond to a prior ISDN_CMD_DIAL, if
|
625 |
|
|
no D-Channel is available.
|
626 |
|
|
|
627 |
|
|
Parameter:
|
628 |
|
|
driver = driver-Id
|
629 |
|
|
command = ISDN_STAT_NODCH
|
630 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
631 |
|
|
para = unused.
|
632 |
|
|
|
633 |
|
|
ISDN_STAT_ADDCH: (currently unused)
|
634 |
|
|
|
635 |
|
|
This call is planned for HL-drivers, which are unable to check card-type
|
636 |
|
|
or numbers of supported channels before they have loaded any firmware
|
637 |
|
|
using ioctl. Those HL-driver simply set the channel-parameter to zero
|
638 |
|
|
or a minimum channel-number when registering, and later if they know
|
639 |
|
|
the real amount, perform this call, allocating additional channels.
|
640 |
|
|
|
641 |
|
|
Parameter:
|
642 |
|
|
driver = driver-Id
|
643 |
|
|
command = ISDN_STAT_ADDCH
|
644 |
|
|
arg = to be defined.
|
645 |
|
|
para = to be defined.
|
646 |
|
|
|
647 |
|
|
ISDN_STAT_CAUSE:
|
648 |
|
|
|
649 |
|
|
With this call, the HL-driver delivers CAUSE-messages to the LL.
|
650 |
|
|
Currently the LL does not use this messages. Their contents is simply
|
651 |
|
|
logged via kernel-messages. Therefore, currently the format of the
|
652 |
|
|
messages is currently completely free. However they should be printable.
|
653 |
|
|
|
654 |
|
|
Parameter:
|
655 |
|
|
driver = driver-Id
|
656 |
|
|
command = ISDN_STAT_NODCH
|
657 |
|
|
arg = channel-number, locally to the driver. (starting with 0)
|
658 |
|
|
para.num = ASCII string containing CAUSE-message.
|
659 |
|
|
|