mm-only debug patch...
[mmotm.git] / Documentation / isdn / README.gigaset
blob0fc9831d7ecbe3e3c8f605767df3a9a3fca365e4
1 GigaSet 307x Device Driver
2 ==========================
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:
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)
21      RS232 data boxes:
22         Siemens Gigaset M101 Data
23         T-Com Sinus 45 Data 1
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)
32      See also http://www.erbze.info/sinus_gigaset.htm and
33               http://gigaset307x.sourceforge.net/
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.
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
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.
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.
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.
70      The module ser_gigaset provides a serial line discipline N_GIGASET_M101
71      which drives the device through the regular serial line driver. It must
72      be attached to the serial line to which the M101 is connected with the
73      ldattach(8) command (requires util-linux-ng release 2.14 or later), for
74      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.
87 2.2. Device nodes for user space programs
88      ------------------------------------
89      The device can be accessed from user space (eg. by the user space tools
90      mentioned in 1.2.) through the device nodes:
92      - /dev/ttyGS0 for M101 (RS232 data boxes)
93      - /dev/ttyGU0 for M105 (USB data boxes)
94      - /dev/ttyGB0 for the base driver (direct USB connection)
96      You can also select a "default device" which is used by the frontends when
97      no device node is given as parameter, by creating a symlink /dev/ttyG to
98      one of them, eg.:
100         ln -s /dev/ttyGB0 /dev/ttyG
102 2.3. ISDN4linux
103      ----------
104      This is the "normal" mode of operation. After loading the module you can
105      set up the ISDN system just as you'd do with any ISDN card supported by
106      the ISDN4Linux subsystem. Most distributions provide some configuration
107      utility. If not, you can use some HOWTOs like
108          http://www.linuxhaven.de/dlhp/HOWTO/DE-ISDN-HOWTO-5.html
109      If this doesn't work, because you have some device like SX100 where
110      debug output (see section 3.2.) shows something like this when dialing
111          CMD Received: ERROR
112          Available Params: 0
113          Connection State: 0, Response: -1
114          gigaset_process_response: resp_code -1 in ConState 0 !
115          Timeout occurred
116      you might need to use unimodem mode. (see section 2.5.)
118 2.4. CAPI
119      ----
120      If the driver is compiled with CAPI support (kernel configuration option
121      GIGASET_CAPI, experimental) it can also be used with CAPI 2.0 kernel and
122      user space applications.  ISDN4Linux is supported in this configuration
123      via the capidrv compatibility driver. The kernel module capidrv.ko must
124      be loaded explicitly ("modprobe capidrv") if needed.
126 2.5. Unimodem mode
127      -------------
128      This is needed for some devices [e.g. SX100] as they have problems with
129      the "normal" commands.
131      If you have installed the command line tool gigacontr, you can enter
132      unimodem mode using
133          gigacontr --mode unimodem
134      You can switch back using
135          gigacontr --mode isdn
137      You can also load the driver using e.g.
138          modprobe usb_gigaset startmode=0
139      to prevent the driver from starting in "isdn4linux mode".
141      In this mode the device works like a modem connected to a serial port
142      (the /dev/ttyGU0, ... mentioned above) which understands the commands
143          ATZ                 init, reset
144              => OK or ERROR
145          ATD
146          ATDT                dial
147              => OK, CONNECT,
148                 BUSY,
149                 NO DIAL TONE,
150                 NO CARRIER,
151                 NO ANSWER
152          <pause>+++<pause>   change to command mode when connected
153          ATH                 hangup
155      You can use some configuration tool of your distribution to configure this
156      "modem" or configure pppd/wvdial manually. There are some example ppp
157      configuration files and chat scripts in the gigaset-VERSION/ppp directory
158      in the driver packages from http://sourceforge.net/projects/gigaset307x/.
159      Please note that the USB drivers are not able to change the state of the
160      control lines. This means you must use "Stupid Mode" if you are using
161      wvdial or you should use the nocrtscts option of pppd.
162      You must also assure that the ppp_async module is loaded with the parameter
163      flag_time=0. You can do this e.g. by adding a line like
165         options ppp_async flag_time=0
167      to /etc/modprobe.conf. If your distribution has some local module
168      configuration file like /etc/modprobe.conf.local,
169      using that should be preferred.
171 2.6. Call-ID (CID) mode
172      ------------------
173      Call-IDs are numbers used to tag commands to, and responses from, the
174      Gigaset base in order to support the simultaneous handling of multiple
175      ISDN calls. Their use can be enabled ("CID mode") or disabled ("Unimodem
176      mode"). Without Call-IDs (in Unimodem mode), only a very limited set of
177      functions is available. It allows outgoing data connections only, but
178      does not signal incoming calls or other base events.
180      DECT cordless data devices (M10x) permanently occupy the cordless
181      connection to the base while Call-IDs are activated. As the Gigaset
182      bases only support one DECT data connection at a time, this prevents
183      other DECT cordless data devices from accessing the base.
185      During active operation, the driver switches to the necessary mode
186      automatically. However, for the reasons above, the mode chosen when
187      the device is not in use (idle) can be selected by the user.
188      - If you want to receive incoming calls, you can use the default
189        settings (CID mode).
190      - If you have several DECT data devices (M10x) which you want to use
191        in turn, select Unimodem mode by passing the parameter "cidmode=0" to
192        the driver ("modprobe usb_gigaset cidmode=0" or modprobe.conf).
194      If you want both of these at once, you are out of luck.
196      You can also use /sys/class/tty/ttyGxy/cidmode for changing the CID mode
197      setting (ttyGxy is ttyGU0 or ttyGB0).
199 2.7. Unregistered Wireless Devices (M101/M105)
200      -----------------------------------------
201      The main purpose of the ser_gigaset and usb_gigaset drivers is to allow
202      the M101 and M105 wireless devices to be used as ISDN devices for ISDN
203      connections through a Gigaset base. Therefore they assume that the device
204      is registered to a DECT base.
206      If the M101/M105 device is not registered to a base, initialization of
207      the device fails, and a corresponding error message is logged by the
208      driver. In that situation, a restricted set of functions is available
209      which includes, in particular, those necessary for registering the device
210      to a base or for switching it between Fixed Part and Portable Part
211      modes.
213 3.   Troubleshooting
214      ---------------
215 3.1. Solutions to frequently reported problems
216      -----------------------------------------
217      Problem:
218         You have a slow provider and isdn4linux gives up dialing too early.
219      Solution:
220         Load the isdn module using the dialtimeout option. You can do this e.g.
221         by adding a line like
223            options isdn dialtimeout=15
225         to /etc/modprobe.conf. If your distribution has some local module
226         configuration file like /etc/modprobe.conf.local,
227         using that should be preferred.
229      Problem:
230         Your isdn script aborts with a message about isdnlog.
231      Solution:
232         Try deactivating (or commenting out) isdnlog. This driver does not
233         support it.
235      Problem:
236         You have two or more DECT data adapters (M101/M105) and only the
237         first one you turn on works.
238      Solution:
239         Select Unimodem mode for all DECT data adapters. (see section 2.5.)
241      Problem:
242         Messages like this:
243             usb_gigaset 3-2:1.0: Could not initialize the device.
244         appear in your syslog.
245      Solution:
246         Check whether your M10x wireless device is correctly registered to the
247         Gigaset base. (see section 2.7.)
249 3.2. Telling the driver to provide more information
250      ----------------------------------------------
251      Building the driver with the "Gigaset debugging" kernel configuration
252      option (CONFIG_GIGASET_DEBUG) gives it the ability to produce additional
253      information useful for debugging.
255      You can control the amount of debugging information the driver produces by
256      writing an appropriate value to /sys/module/gigaset/parameters/debug, e.g.
257         echo 0 > /sys/module/gigaset/parameters/debug
258      switches off debugging output completely,
259         echo 0x10a020 > /sys/module/gigaset/parameters/debug
260      enables the standard set of debugging output messages. These values are
261      bit patterns where every bit controls a certain type of debugging output.
262      See the constants DEBUG_* in the source file gigaset.h for details.
264      The initial value can be set using the debug parameter when loading the
265      module "gigaset", e.g. by adding a line
266         options gigaset debug=0
267      to /etc/modprobe.conf, ...
269      Generated debugging information can be found
270      - as output of the command
271          dmesg
272      - in system log files written by your syslog daemon, usually
273        in /var/log/, e.g. /var/log/messages.
275 3.3. Reporting problems and bugs
276      ---------------------------
277      If you can't solve problems with the driver on your own, feel free to
278      use one of the forums, bug trackers, or mailing lists on
279          http://sourceforge.net/projects/gigaset307x
280      or write an electronic mail to the maintainers.
282      Try to provide as much information as possible, such as
283      - distribution
284      - kernel version (uname -r)
285      - gcc version (gcc --version)
286      - hardware architecture (uname -m, ...)
287      - type and firmware version of your device (base and wireless module,
288        if any)
289      - output of "lsusb -v" (if using an USB device)
290      - error messages
291      - relevant system log messages (it would help if you activate debug
292        output as described in 3.2.)
294      For help with general configuration problems not specific to our driver,
295      such as isdn4linux and network configuration issues, please refer to the
296      appropriate forums and newsgroups.
298 3.4. Reporting problem solutions
299      ---------------------------
300      If you solved a problem with our drivers, wrote startup scripts for your
301      distribution, ... feel free to contact us (using one of the places
302      mentioned in 3.3.). We'd like to add scripts, hints, documentation
303      to the driver and/or the project web page.
306 4.   Links, other software
307      ---------------------
308      - Sourceforge project developing this driver and associated tools
309          http://sourceforge.net/projects/gigaset307x
310      - Yahoo! Group on the Siemens Gigaset family of devices
311          http://de.groups.yahoo.com/group/Siemens-Gigaset
312      - Siemens Gigaset/T-Sinus compatibility table
313          http://www.erbze.info/sinus_gigaset.htm
316 5.   Credits
317      -------
318      Thanks to
320      Karsten Keil
321         for his help with isdn4linux
322      Deti Fliegl
323         for his base driver code
324      Dennis Dietrich
325         for his kernel 2.6 patches
326      Andreas Rummel
327         for his work and logs to get unimodem mode working
328      Andreas Degert
329         for his logs and patches to get cx 100 working
330      Dietrich Feist
331         for his generous donation of one M105 and two M101 cordless adapters
332      Christoph Schweers
333         for his generous donation of a M34 device
335      and all the other people who sent logs and other information.