1isdnctrl(4)                      Special files                     isdnctrl(4)
2
3
4

NAME

6       isdnctrl - ISDN control device
7

SYNOPSIS

9       #include <linux/isdn.h>
10

DESCRIPTION

12       /dev/isdnctrl is a character device with major number 45 and minor num‐
13       bers 64 to 127.  It allows controlling functionality of the Linux  ISDN
14       subsystem.
15

IOCTL FUNCTIONS

17       Currently, the following ioctl calls are supported:
18
19       IIOCNETAIF
20              Add an ISDN network interface.
21              This  function  adds  a network interface to the kernel's device
22              table.  This interface can be used just like normal  eth  inter‐
23              faces.
24
25              Argument:
26                     arg  should  point to a zero terminated string of max. 10
27                     characters.  if arg is NULL, the kernel assigns a name.
28
29              Return:
30                     On success, the name of the new interface  is  copied  to
31                     arg.   and  the call returns 0. On failure, an error code
32                     is returned.
33
34       IIOCNETASL
35              Create a slave interface.
36              Creates  a  slave  interface  for  RAW-device  channel-bundling.
37              These  devices  behave  like network-interfaces, except they are
38              invisible to user. Only ISDN parameters can be  controlled,  not
39              IP-parameters.  IP-parameters are inherited from the correspond‐
40              ing master-device.
41
42              Argument:
43                     arg should point to a zero terminated string of  max.  21
44                     characters  containing  two  comma-separated  names.  The
45                     first part is  the  name  of  an  existing  ISDN  network
46                     device, which will be master. The second part will be the
47                     name of the new slave interface.
48
49              Return:
50                     On success, the name of the new interface  is  copied  to
51                     arg.   and  the call returns 0. On failure, an error code
52                     is returned.
53
54       IIOCNETDIF
55              Delete a network-interface.
56              This call deletes an existing ISDN network interface.
57
58              Argument:
59                     arg should point to a zero terminated string of  max.  10
60                     characters  naming  an  existing  interface which will be
61                     deleted. If the interface is a master interface, all  its
62                     slave-interfaces will be deleted also.
63
64              Return:
65                     On success, the call returns 0. On failure, an error code
66                     is returned.
67
68       IIOCNETSCF
69              Set configurable parameters of an ISDN network interface.
70              This call replaces all ISDN related parameters of  an  interface
71              by the parameters given.
72
73              Argument:
74                     arg  should point to a struct isdn_net_ioctl_cfg (defined
75                     in linux/isdn.h)
76
77              Return:
78                     On success, the call returns 0. On failure, an error code
79                     is returned.
80
81       IIOCNETGCF
82              Get configurable parameters of an ISDN network interface.
83              This call returns all ISDN related parameters of an interface.
84
85              Argument:
86                     arg  should point to a struct isdn_net_ioctl_cfg (defined
87                     in linux/isdn.h) which will be filled by the current set‐
88                     up.
89
90              Return:
91                     On success, the call returns 0 and the interface-setup is
92                     copied to *arg. On failure, an error code is returned.
93
94       IIOCNETANM
95              Add a phone number to an ISDN network interface.
96              This call adds a phone number to an existing network interface.
97
98              Argument:
99                     arg should point to a struct  isdn_net_ioctl_phone  which
100                     contains necessary information.
101
102              Return:
103                     On  success,  the  call returns 0 and the phone number is
104                     added to either outgoing  or  incoming  number  list.  On
105                     failure, an error code is returned.
106
107       IIOCNETDNM
108              Delete a phone number from an ISDN network interface.
109              This call deletes a phone number from an existing network inter‐
110              face.
111
112              Argument:
113                     arg should point to a struct  isdn_net_ioctl_phone  which
114                     contains necessary information.
115
116              Return:
117                     On  success,  the  call returns 0 and the phone number is
118                     deleted from either outgoing or incoming number list.  On
119                     failure, an error code is returned.
120
121       IIOCNETGNM
122              Get list of phone numbers from an ISDN network interface.
123              This  call  returns  the  list of phone numbers associated to an
124              existing network interface.
125
126              Argument:
127                     arg   should    point    to    a    union    of    struct
128                     isdn_net_ioctl_phone and a buffer, large enough to hold a
129                     concatenated list of strings containing  the  phone  num‐
130                     bers.
131
132              Return:
133                     On success, the call returns 0 and the list of phone num‐
134                     bers is returned as a  space-separated  list  of  number-
135                     strings terminated by a NULL byte.
136
137       IIOCNETDIL
138              Trigger dialing of an ISDN network interface.
139              This  call initiates dialing of an ISDN network interface, if it
140              is not connected. Normally, this ioctl is  not  needed,  because
141              ISDN network interface perform dial on demand by default.
142
143              Argument:
144                     arg  should  point to a zero terminated string of max. 10
145                     characters naming the desired interface.
146
147              Return:
148                     On success, the call returns 0 and the  interface  starts
149                     dialing.
150
151       IIOCNETHUP
152              Hangup an ISDN network interface.
153              This  call  initiates hangup of an ISDN network interface, if it
154              is connected.
155
156              Argument:
157                     arg should point to a zero terminated string of  max.  10
158                     characters naming the desired interface.
159
160              Return:
161                     On  success,  the  call returns 0 and the interface hangs
162                     up.
163
164       IIOCNETALN
165              Add a link of an MPP-configured ISDN network interface.
166              This call initiates dialing of a Multilink-PPP slave  ISDN  net‐
167              work interface, if it is not connected.
168
169              Argument:
170                     arg  should  point to a zero terminated string of max. 10
171                     characters naming the desired interface.
172
173              Return:
174                     On success, the call returns 0 and the  interface  starts
175                     dialing.
176
177       IIOCNETDLN
178              Hangup an MPP-configured ISDN network interface.
179              This  call  initiates  hangup  of  an Multilink-PPP ISDN network
180              interface, if it is connected.
181
182              Argument:
183                     arg should point to a zero terminated string of  max.  10
184                     characters naming the desired interface.
185
186              Return:
187                     On  success,  the  call returns 0 and the interface hangs
188                     up.
189
190       IIOCNETARU
191              Add a timeout rule to an ISDN network interface.
192              This call adds a timeout rule to an existing interface.
193
194              Argument:
195                     arg should point to a struct isdn_ioctl_timeout_rule con‐
196                     taining the necessary parameters.
197
198              Return:
199                     On  success,  the call returns 0 and the rule is added to
200                     the rule list of the interface.
201
202       IIOCNETDRU
203              Delete a timeout rule from an ISDN network interface.
204              This call deletes a timeout rule from an existing interface.
205
206              Argument:
207                     arg should point to a struct isdn_ioctl_timeout_rule con‐
208                     taining the necessary parameters.
209
210              Return:
211                     On  success,  the  call returns 0 and the rule is deleted
212                     from the rule list of the interface.
213
214       IIOCNETGRU
215              Get a timeout rule from an ISDN network interface.
216              This call returns a timeout rule from an existing interface.
217
218              Argument:
219                     arg should point to a struct isdn_ioctl_timeout_rule con‐
220                     taining the necessary parameters.
221
222              Return:
223                     On  success,  the call returns 0 and the struct is filled
224                     from the rule list of the interface.
225
226       IIOCNETBUD
227              Handle budget accounting of an ISDN network interface.
228
229              Argument and Return:
230                     to be defined.
231
232       IIOCSETVER
233              Set verbosity of link level.
234
235              Argument:
236                     arg is an integer, defining the new verbose value.
237
238              Return:
239                     This call always returns 0.
240
241       IIOCSETGST
242              Set global stop flag of link level.
243
244              Argument:
245                     arg is an integer, defining the new stop flag value (0 or
246                     !0).
247
248              Return:
249                     This call always returns 0.
250
251       IIOCSETBRJ
252              Set busreject flag of a lowlevel driver.
253
254              Argument:
255                     arg  should point to an struct isdn_ioctl_struct contain‐
256                     ing the driver's ID and the value of the busreject flag.
257
258              Return:
259                     On success, the call returns 0 and the busreject flag  of
260                     the selected driver is set according the given parameter.
261
262       IIOCSIGPRF
263              Enable signaling on change of modem profiles.
264              With  this  call, the calling process is registered to receive a
265              SIGIO on every change of any register of any ttyI. Thus  it  can
266              read  register  settings  and  save  them to a file. The calling
267              process has to keep the device open in order to receive  notifi‐
268              cations.   As  soon  as  it  closes  the device, registration is
269              deleted.
270
271              Argument:
272                     none
273
274              Return:
275                     This call always returns 0.
276
277       IIOCGETPRF
278              Get all modem register settings.
279              With this call, all modem registers of all ttyI devices  can  be
280              read.
281
282              Argument:
283                     arg    should   point   to   a   buffer   of   length   (
284                     ISDN_MODEM_ANZREG + ISDN_MSNLEN ) * ISDN_MAX_CHANNELS.
285
286              Return:
287                     On return, the provided buffer is filled with the  regis‐
288                     ter values.
289
290       IIOCSETPRF
291              Set all modem register settings.
292              With  this  call, all modem registers of all ttyI devices can be
293              written.
294
295              Argument:
296                     arg   should   point   to   a   buffer   of   length    (
297                     ISDN_MODEM_ANZREG  +  ISDN_MSNLEN  ) * ISDN_MAX_CHANNELS.
298                     filled with the values of all modem registers.
299
300              Return:
301                     On return, the modem registers are set from the  contents
302                     of the provided buffer.
303
304       IIOCSETMAP
305              Set Mapping table.
306              This call is used to set EAZ/MSN mapping of a lowlevel driver.
307
308              Argument:
309                     arg should point to a struct isdn_ioctl_struct containing
310                     the necessary parameters.
311
312              Return:
313                     On success, the mapping  table  is  set  from  the  given
314                     parameters an the call returns 0.
315
316       IIOCGETMAP
317              Get Mapping table.
318              This call is used to get EAZ/MSN mapping of a lowlevel driver.
319
320              Argument:
321                     arg should point to a struct isdn_ioctl_struct containing
322                     the necessary parameters.
323
324              Return:
325                     On success, the current mapping table of the given driver
326                     is returned and the call returns 0.
327
328       IIOCDRVCTL
329              Lowlevel driver ioctl.
330              This  call is used for controlling various lowlevel drivers. The
331              ioctl-code for this command is assembled  by  adding  IIOCDRVCTL
332              (128)  and  the desired driver ioctl-code. Therefore, a lowlevel
333              driver can understand a maximum of 127 different ioctls.
334
335              Argument:
336                     arg should point to a struct isdn_ioctl_struct containing
337                     the  necessary  parameters, especially the driver-Id must
338                     be   filled   correctly.   The   arg   component   inside
339                     isdn_ioctl_struct  is  handed  down to the driver's ioctl
340                     function. Its meaning is not defined here and depends  on
341                     the  lowlevel  driver.  See documentation for the various
342                     lowlevel drivers for information about  driver-  specific
343                     ioctl.
344
345              Return:
346                     The  return  code depends on the driver's ioctl function.
347                     Usually, 0 means no error.
348
349

AUTHOR

351       Fritz Elfert <fritz@isdn4linux.de>
352

SEE ALSO

354       isdninfo(4), icnctrl(4).
355
356
357
358ISDN 4 Linux 3.27                 1999/09/06                       isdnctrl(4)
Impressum