Merge branches 'slab/align', 'slab/cleanups', 'slab/fixes', 'slab/memhotadd' and...
[linux-2.6.git] / Documentation / isdn / README.gigaset
1 GigaSet 307x Device Driver
2 ==========================
3
4 1.   Requirements
5      ------------
6 1.1. Hardware
7      --------
8      This driver supports the connection of the Gigaset 307x/417x family of
9      ISDN DECT bases via Gigaset M101 Data, Gigaset M105 Data or direct USB
10      connection. The following devices are reported to be compatible:
11
12      Bases:
13         Siemens Gigaset 3070/3075 isdn
14         Siemens Gigaset 4170/4175 isdn
15         Siemens Gigaset SX205/255
16         Siemens Gigaset SX353
17         T-Com Sinus 45 [AB] isdn
18         T-Com Sinus 721X[A] [SE]
19         Vox Chicago 390 ISDN (KPN Telecom)
20
21      RS232 data boxes:
22         Siemens Gigaset M101 Data
23         T-Com Sinus 45 Data 1
24
25      USB data boxes:
26         Siemens Gigaset M105 Data
27         Siemens Gigaset USB Adapter DECT
28         T-Com Sinus 45 Data 2
29         T-Com Sinus 721 data
30         Chicago 390 USB (KPN)
31
32      See also http://www.erbze.info/sinus_gigaset.htm and
33               http://gigaset307x.sourceforge.net/
34
35      We had also reports from users of Gigaset M105 who could use the drivers
36      with SX 100 and CX 100 ISDN bases (only in unimodem mode, see section 2.5.)
37      If you have another device that works with our driver, please let us know.
38
39      Chances of getting an USB device to work are good if the output of
40         lsusb
41      at the command line contains one of the following:
42         ID 0681:0001
43         ID 0681:0002
44         ID 0681:0009
45         ID 0681:0021
46         ID 0681:0022
47
48 1.2. Software
49      --------
50      The driver works with ISDN4linux and so can be used with any software
51      which is able to use ISDN4linux for ISDN connections (voice or data).
52      Experimental Kernel CAPI support is available as a compilation option.
53
54      There are some user space tools available at
55      http://sourceforge.net/projects/gigaset307x/
56      which provide access to additional device specific functions like SMS,
57      phonebook or call journal.
58
59
60 2.   How to use the driver
61      ---------------------
62 2.1. Modules
63      -------
64      For the devices to work, the proper kernel modules have to be loaded.
65      This normally happens automatically when the system detects the USB
66      device (base, M105) or when the line discipline is attached (M101). It
67      can also be triggered manually using the modprobe(8) command, for example
68      for troubleshooting or to pass module parameters.
69
70      The module ser_gigaset provides a serial line discipline N_GIGASET_M101
71      which uses the regular serial port driver to access the device, and must
72      therefore be attached to the serial device to which the M101 is connected.
73      The ldattach(8) command (included in util-linux-ng release 2.14 or later)
74      can be used for that purpose, for example:
75         ldattach GIGASET_M101 /dev/ttyS1
76      This will open the device file, attach the line discipline to it, and
77      then sleep in the background, keeping the device open so that the line
78      discipline remains active. To deactivate it, kill the daemon, for example
79      with
80         killall ldattach
81      before disconnecting the device. To have this happen automatically at
82      system startup/shutdown on an LSB compatible system, create and activate
83      an appropriate LSB startup script /etc/init.d/gigaset. (The init name
84      'gigaset' is officially assigned to this project by LANANA.)
85      Alternatively, just add the 'ldattach' command line to /etc/rc.local.
86
87      The modules accept the following parameters:
88
89         Module          Parameter  Meaning
90
91         gigaset         debug      debug level (see section 3.2.)
92
93                         startmode  initial operation mode (see section 2.5.):
94         bas_gigaset )              1=ISDN4linux/CAPI (default), 0=Unimodem
95         ser_gigaset )
96         usb_gigaset )   cidmode    initial Call-ID mode setting (see section
97                                    2.5.): 1=on (default), 0=off
98
99      Depending on your distribution you may want to create a separate module
100      configuration file /etc/modprobe.d/gigaset for these, or add them to a
101      custom file like /etc/modprobe.conf.local.
102
103 2.2. Device nodes for user space programs
104      ------------------------------------
105      The device can be accessed from user space (eg. by the user space tools
106      mentioned in 1.2.) through the device nodes:
107
108      - /dev/ttyGS0 for M101 (RS232 data boxes)
109      - /dev/ttyGU0 for M105 (USB data boxes)
110      - /dev/ttyGB0 for the base driver (direct USB connection)
111
112      If you connect more than one device of a type, they will get consecutive
113      device nodes, eg. /dev/ttyGU1 for a second M105.
114
115      You can also set a "default device" for the user space tools to use when
116      no device node is given as parameter, by creating a symlink /dev/ttyG to
117      one of them, eg.:
118
119         ln -s /dev/ttyGB0 /dev/ttyG
120
121      The devices accept the following device specific ioctl calls
122      (defined in gigaset_dev.h):
123
124      ioctl(int fd, GIGASET_REDIR, int *cmd);
125      If cmd==1, the device is set to be controlled exclusively through the
126      character device node; access from the ISDN subsystem is blocked.
127      If cmd==0, the device is set to be used from the ISDN subsystem and does
128      not communicate through the character device node.
129
130      ioctl(int fd, GIGASET_CONFIG, int *cmd);
131      (ser_gigaset and usb_gigaset only)
132      If cmd==1, the device is set to adapter configuration mode where commands
133      are interpreted by the M10x DECT adapter itself instead of being
134      forwarded to the base station. In this mode, the device accepts the
135      commands described in Siemens document "AT-Kommando Alignment M10x Data"
136      for setting the operation mode, associating with a base station and
137      querying parameters like field strengh and signal quality.
138      Note that there is no ioctl command for leaving adapter configuration
139      mode and returning to regular operation. In order to leave adapter
140      configuration mode, write the command ATO to the device.
141
142      ioctl(int fd, GIGASET_BRKCHARS, unsigned char brkchars[6]);
143      (usb_gigaset only)
144      Set the break characters on an M105's internal serial adapter to the six
145      bytes stored in brkchars[]. Unused bytes should be set to zero.
146
147      ioctl(int fd, GIGASET_VERSION, unsigned version[4]);
148      Retrieve version information from the driver. version[0] must be set to
149      one of:
150      - GIGVER_DRIVER: retrieve driver version
151      - GIGVER_COMPAT: retrieve interface compatibility version
152      - GIGVER_FWBASE: retrieve the firmware version of the base
153      Upon return, version[] is filled with the requested version information.
154
155 2.3. ISDN4linux
156      ----------
157      This is the "normal" mode of operation. After loading the module you can
158      set up the ISDN system just as you'd do with any ISDN card supported by
159      the ISDN4Linux subsystem. Most distributions provide some configuration
160      utility. If not, you can use some HOWTOs like
161          http://www.linuxhaven.de/dlhp/HOWTO/DE-ISDN-HOWTO-5.html
162      If this doesn't work, because you have some device like SX100 where
163      debug output (see section 3.2.) shows something like this when dialing
164          CMD Received: ERROR
165          Available Params: 0
166          Connection State: 0, Response: -1
167          gigaset_process_response: resp_code -1 in ConState 0 !
168          Timeout occurred
169      you probably need to use unimodem mode. (see section 2.5.)
170
171 2.4. CAPI
172      ----
173      If the driver is compiled with CAPI support (kernel configuration option
174      GIGASET_CAPI, experimental) it can also be used with CAPI 2.0 kernel and
175      user space applications. For user space access, the module capi.ko must
176      be loaded. The capiinit command (included in the capi4k-utils package)
177      does this for you.
178
179      The CAPI variant of the driver supports legacy ISDN4Linux applications
180      via the capidrv compatibility driver. The kernel module capidrv.ko must
181      be loaded explicitly with the command
182         modprobe capidrv
183      if needed, and cannot be unloaded again without unloading the driver
184      first. (These are limitations of capidrv.)
185
186      The note about unimodem mode in the preceding section applies here, too.
187
188 2.5. Unimodem mode
189      -------------
190      This is needed for some devices [e.g. SX100] as they have problems with
191      the "normal" commands.
192
193      If you have installed the command line tool gigacontr, you can enter
194      unimodem mode using
195          gigacontr --mode unimodem
196      You can switch back using
197          gigacontr --mode isdn
198
199      You can also put the driver directly into Unimodem mode when it's loaded,
200      by passing the module parameter startmode=0 to the hardware specific
201      module, e.g.
202         modprobe usb_gigaset startmode=0
203      or by adding a line like
204         options usb_gigaset startmode=0
205      to an appropriate module configuration file, like /etc/modprobe.d/gigaset
206      or /etc/modprobe.conf.local.
207
208      In this mode the device works like a modem connected to a serial port
209      (the /dev/ttyGU0, ... mentioned above) which understands the commands
210          ATZ                 init, reset
211              => OK or ERROR
212          ATD
213          ATDT                dial
214              => OK, CONNECT,
215                 BUSY,
216                 NO DIAL TONE,
217                 NO CARRIER,
218                 NO ANSWER
219          <pause>+++<pause>   change to command mode when connected
220          ATH                 hangup
221
222      You can use some configuration tool of your distribution to configure this
223      "modem" or configure pppd/wvdial manually. There are some example ppp
224      configuration files and chat scripts in the gigaset-VERSION/ppp directory
225      in the driver packages from http://sourceforge.net/projects/gigaset307x/.
226      Please note that the USB drivers are not able to change the state of the
227      control lines. This means you must use "Stupid Mode" if you are using
228      wvdial or you should use the nocrtscts option of pppd.
229      You must also assure that the ppp_async module is loaded with the parameter
230      flag_time=0. You can do this e.g. by adding a line like
231
232         options ppp_async flag_time=0
233
234      to an appropriate module configuration file, like /etc/modprobe.d/gigaset
235      or /etc/modprobe.conf.local.
236
237 2.6. Call-ID (CID) mode
238      ------------------
239      Call-IDs are numbers used to tag commands to, and responses from, the
240      Gigaset base in order to support the simultaneous handling of multiple
241      ISDN calls. Their use can be enabled ("CID mode") or disabled ("Unimodem
242      mode"). Without Call-IDs (in Unimodem mode), only a very limited set of
243      functions is available. It allows outgoing data connections only, but
244      does not signal incoming calls or other base events.
245
246      DECT cordless data devices (M10x) permanently occupy the cordless
247      connection to the base while Call-IDs are activated. As the Gigaset
248      bases only support one DECT data connection at a time, this prevents
249      other DECT cordless data devices from accessing the base.
250
251      During active operation, the driver switches to the necessary mode
252      automatically. However, for the reasons above, the mode chosen when
253      the device is not in use (idle) can be selected by the user.
254      - If you want to receive incoming calls, you can use the default
255        settings (CID mode).
256      - If you have several DECT data devices (M10x) which you want to use
257        in turn, select Unimodem mode by passing the parameter "cidmode=0" to
258        the appropriate driver module (ser_gigaset or usb_gigaset).
259
260      If you want both of these at once, you are out of luck.
261
262      You can also use the tty class parameter "cidmode" of the device to
263      change its CID mode while the driver is loaded, eg.
264         echo 0 > /sys/class/tty/ttyGU0/cidmode
265
266 2.7. Unregistered Wireless Devices (M101/M105)
267      -----------------------------------------
268      The main purpose of the ser_gigaset and usb_gigaset drivers is to allow
269      the M101 and M105 wireless devices to be used as ISDN devices for ISDN
270      connections through a Gigaset base. Therefore they assume that the device
271      is registered to a DECT base.
272
273      If the M101/M105 device is not registered to a base, initialization of
274      the device fails, and a corresponding error message is logged by the
275      driver. In that situation, a restricted set of functions is available
276      which includes, in particular, those necessary for registering the device
277      to a base or for switching it between Fixed Part and Portable Part
278      modes. See the gigacontr(8) manpage for details.
279
280 3.   Troubleshooting
281      ---------------
282 3.1. Solutions to frequently reported problems
283      -----------------------------------------
284      Problem:
285         You have a slow provider and isdn4linux gives up dialing too early.
286      Solution:
287         Load the isdn module using the dialtimeout option. You can do this e.g.
288         by adding a line like
289
290            options isdn dialtimeout=15
291
292         to /etc/modprobe.d/gigaset, /etc/modprobe.conf.local or a similar file.
293
294      Problem:
295         The isdnlog program emits error messages or just doesn't work.
296      Solution:
297         Isdnlog supports only the HiSax driver. Do not attempt to use it with
298         other drivers such as Gigaset.
299
300      Problem:
301         You have two or more DECT data adapters (M101/M105) and only the
302         first one you turn on works.
303      Solution:
304         Select Unimodem mode for all DECT data adapters. (see section 2.5.)
305
306      Problem:
307         Messages like this:
308             usb_gigaset 3-2:1.0: Could not initialize the device.
309         appear in your syslog.
310      Solution:
311         Check whether your M10x wireless device is correctly registered to the
312         Gigaset base. (see section 2.7.)
313
314 3.2. Telling the driver to provide more information
315      ----------------------------------------------
316      Building the driver with the "Gigaset debugging" kernel configuration
317      option (CONFIG_GIGASET_DEBUG) gives it the ability to produce additional
318      information useful for debugging.
319
320      You can control the amount of debugging information the driver produces by
321      writing an appropriate value to /sys/module/gigaset/parameters/debug, e.g.
322         echo 0 > /sys/module/gigaset/parameters/debug
323      switches off debugging output completely,
324         echo 0x302020 > /sys/module/gigaset/parameters/debug
325      enables a reasonable set of debugging output messages. These values are
326      bit patterns where every bit controls a certain type of debugging output.
327      See the constants DEBUG_* in the source file gigaset.h for details.
328
329      The initial value can be set using the debug parameter when loading the
330      module "gigaset", e.g. by adding a line
331         options gigaset debug=0
332      to your module configuration file, eg. /etc/modprobe.d/gigaset or
333      /etc/modprobe.conf.local.
334
335      Generated debugging information can be found
336      - as output of the command
337          dmesg
338      - in system log files written by your syslog daemon, usually
339        in /var/log/, e.g. /var/log/messages.
340
341 3.3. Reporting problems and bugs
342      ---------------------------
343      If you can't solve problems with the driver on your own, feel free to
344      use one of the forums, bug trackers, or mailing lists on
345          http://sourceforge.net/projects/gigaset307x
346      or write an electronic mail to the maintainers.
347
348      Try to provide as much information as possible, such as
349      - distribution
350      - kernel version (uname -r)
351      - gcc version (gcc --version)
352      - hardware architecture (uname -m, ...)
353      - type and firmware version of your device (base and wireless module,
354        if any)
355      - output of "lsusb -v" (if using an USB device)
356      - error messages
357      - relevant system log messages (it would help if you activate debug
358        output as described in 3.2.)
359
360      For help with general configuration problems not specific to our driver,
361      such as isdn4linux and network configuration issues, please refer to the
362      appropriate forums and newsgroups.
363
364 3.4. Reporting problem solutions
365      ---------------------------
366      If you solved a problem with our drivers, wrote startup scripts for your
367      distribution, ... feel free to contact us (using one of the places
368      mentioned in 3.3.). We'd like to add scripts, hints, documentation
369      to the driver and/or the project web page.
370
371
372 4.   Links, other software
373      ---------------------
374      - Sourceforge project developing this driver and associated tools
375          http://sourceforge.net/projects/gigaset307x
376      - Yahoo! Group on the Siemens Gigaset family of devices
377          http://de.groups.yahoo.com/group/Siemens-Gigaset
378      - Siemens Gigaset/T-Sinus compatibility table
379          http://www.erbze.info/sinus_gigaset.htm
380
381
382 5.   Credits
383      -------
384      Thanks to
385
386      Karsten Keil
387         for his help with isdn4linux
388      Deti Fliegl
389         for his base driver code
390      Dennis Dietrich
391         for his kernel 2.6 patches
392      Andreas Rummel
393         for his work and logs to get unimodem mode working
394      Andreas Degert
395         for his logs and patches to get cx 100 working
396      Dietrich Feist
397         for his generous donation of one M105 and two M101 cordless adapters
398      Christoph Schweers
399         for his generous donation of a M34 device
400
401      and all the other people who sent logs and other information.
402