1GigaSet 307x Device Driver
   41.   Requirements
   5     ------------
   61.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 and
  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
  481.2. Software
  49     --------
  50     The driver works with the Kernel CAPI subsystem as well as the old
  51     ISDN4Linux subsystem, so it can be used with any software which is able
  52     to use CAPI 2.0 or ISDN4Linux for ISDN connections (voice or data).
  54     There are some user space tools available at
  56     which provide access to additional device specific functions like SMS,
  57     phonebook or call journal.
  602.   How to use the driver
  61     ---------------------
  622.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 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.
  87     The modules accept the following parameters:
  89        Module          Parameter  Meaning
  91        gigaset         debug      debug level (see section 3.2.)
  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
  99     Depending on your distribution you may want to create a separate module
 100     configuration file like /etc/modprobe.d/gigaset.conf for these.
 1022.2. Device nodes for user space programs
 103     ------------------------------------
 104     The device can be accessed from user space (eg. by the user space tools
 105     mentioned in 1.2.) through the device nodes:
 107     - /dev/ttyGS0 for M101 (RS232 data boxes)
 108     - /dev/ttyGU0 for M105 (USB data boxes)
 109     - /dev/ttyGB0 for the base driver (direct USB connection)
 111     If you connect more than one device of a type, they will get consecutive
 112     device nodes, eg. /dev/ttyGU1 for a second M105.
 114     You can also set a "default device" for the user space tools to use when
 115     no device node is given as parameter, by creating a symlink /dev/ttyG to
 116     one of them, eg.:
 118        ln -s /dev/ttyGB0 /dev/ttyG
 120     The devices accept the following device specific ioctl calls
 121     (defined in gigaset_dev.h):
 123     ioctl(int fd, GIGASET_REDIR, int *cmd);
 124     If cmd==1, the device is set to be controlled exclusively through the
 125     character device node; access from the ISDN subsystem is blocked.
 126     If cmd==0, the device is set to be used from the ISDN subsystem and does
 127     not communicate through the character device node.
 129     ioctl(int fd, GIGASET_CONFIG, int *cmd);
 130     (ser_gigaset and usb_gigaset only)
 131     If cmd==1, the device is set to adapter configuration mode where commands
 132     are interpreted by the M10x DECT adapter itself instead of being
 133     forwarded to the base station. In this mode, the device accepts the
 134     commands described in Siemens document "AT-Kommando Alignment M10x Data"
 135     for setting the operation mode, associating with a base station and
 136     querying parameters like field strengh and signal quality.
 137     Note that there is no ioctl command for leaving adapter configuration
 138     mode and returning to regular operation. In order to leave adapter
 139     configuration mode, write the command ATO to the device.
 141     ioctl(int fd, GIGASET_BRKCHARS, unsigned char brkchars[6]);
 142     (usb_gigaset only)
 143     Set the break characters on an M105's internal serial adapter to the six
 144     bytes stored in brkchars[]. Unused bytes should be set to zero.
 146     ioctl(int fd, GIGASET_VERSION, unsigned version[4]);
 147     Retrieve version information from the driver. version[0] must be set to
 148     one of:
 149     - GIGVER_DRIVER: retrieve driver version
 150     - GIGVER_COMPAT: retrieve interface compatibility version
 151     - GIGVER_FWBASE: retrieve the firmware version of the base
 152     Upon return, version[] is filled with the requested version information.
 1542.3. CAPI
 155     ----
 156     If the driver is compiled with CAPI support (kernel configuration option
 157     GIGASET_CAPI) the devices will show up as CAPI controllers as soon as the
 158     corresponding driver module is loaded, and can then be used with CAPI 2.0
 159     kernel and user space applications. For user space access, the module
 160     capi.ko must be loaded.
 162     Legacy ISDN4Linux applications are supported via the capidrv
 163     compatibility driver. The kernel module capidrv.ko must be loaded
 164     explicitly with the command
 165        modprobe capidrv
 166     if needed, and cannot be unloaded again without unloading the driver
 167     first. (These are limitations of capidrv.)
 169     Most distributions handle loading and unloading of the various CAPI
 170     modules automatically via the command capiinit(1) from the capi4k-utils
 171     package or a similar mechanism. Note that capiinit(1) cannot unload the
 172     Gigaset drivers because it doesn't support more than one module per
 173     driver.
 1752.4. ISDN4Linux
 176     ----------
 177     If the driver is compiled without CAPI support (native ISDN4Linux
 178     variant), it registers the device with the legacy ISDN4Linux subsystem
 179     after loading the module. It can then be used with ISDN4Linux
 180     applications only. Most distributions provide some configuration utility
 181     for setting up that subsystem. Otherwise you can use some HOWTOs like
 1852.5. Unimodem mode
 186     -------------
 187     In this mode the device works like a modem connected to a serial port
 188     (the /dev/ttyGU0, ... mentioned above) which understands the commands
 190         ATZ                 init, reset
 191             => OK or ERROR
 192         ATD
 193         ATDT                dial
 194             => OK, CONNECT,
 195                BUSY,
 196                NO DIAL TONE,
 197                NO CARRIER,
 198                NO ANSWER
 199         <pause>+++<pause>   change to command mode when connected
 200         ATH                 hangup
 202     You can use some configuration tool of your distribution to configure this
 203     "modem" or configure pppd/wvdial manually. There are some example ppp
 204     configuration files and chat scripts in the gigaset-VERSION/ppp directory
 205     in the driver packages from
 206     Please note that the USB drivers are not able to change the state of the
 207     control lines. This means you must use "Stupid Mode" if you are using
 208     wvdial or you should use the nocrtscts option of pppd.
 209     You must also assure that the ppp_async module is loaded with the parameter
 210     flag_time=0. You can do this e.g. by adding a line like
 212        options ppp_async flag_time=0
 214     to an appropriate module configuration file, like
 215     /etc/modprobe.d/gigaset.conf.
 217     Unimodem mode is needed for making some devices [e.g. SX100] work which
 218     do not support the regular Gigaset command set. If debug output (see
 219     section 3.2.) shows something like this when dialing:
 220         CMD Received: ERROR
 221         Available Params: 0
 222         Connection State: 0, Response: -1
 223         gigaset_process_response: resp_code -1 in ConState 0 !
 224         Timeout occurred
 225     then switching to unimodem mode may help.
 227     If you have installed the command line tool gigacontr, you can enter
 228     unimodem mode using
 229         gigacontr --mode unimodem
 230     You can switch back using
 231         gigacontr --mode isdn
 233     You can also put the driver directly into Unimodem mode when it's loaded,
 234     by passing the module parameter startmode=0 to the hardware specific
 235     module, e.g.
 236        modprobe usb_gigaset startmode=0
 237     or by adding a line like
 238        options usb_gigaset startmode=0
 239     to an appropriate module configuration file, like
 240     /etc/modprobe.d/gigaset.conf
 2422.6. Call-ID (CID) mode
 243     ------------------
 244     Call-IDs are numbers used to tag commands to, and responses from, the
 245     Gigaset base in order to support the simultaneous handling of multiple
 246     ISDN calls. Their use can be enabled ("CID mode") or disabled ("Unimodem
 247     mode"). Without Call-IDs (in Unimodem mode), only a very limited set of
 248     functions is available. It allows outgoing data connections only, but
 249     does not signal incoming calls or other base events.
 251     DECT cordless data devices (M10x) permanently occupy the cordless
 252     connection to the base while Call-IDs are activated. As the Gigaset
 253     bases only support one DECT data connection at a time, this prevents
 254     other DECT cordless data devices from accessing the base.
 256     During active operation, the driver switches to the necessary mode
 257     automatically. However, for the reasons above, the mode chosen when
 258     the device is not in use (idle) can be selected by the user.
 259     - If you want to receive incoming calls, you can use the default
 260       settings (CID mode).
 261     - If you have several DECT data devices (M10x) which you want to use
 262       in turn, select Unimodem mode by passing the parameter "cidmode=0" to
 263       the appropriate driver module (ser_gigaset or usb_gigaset).
 265     If you want both of these at once, you are out of luck.
 267     You can also use the tty class parameter "cidmode" of the device to
 268     change its CID mode while the driver is loaded, eg.
 269        echo 0 > /sys/class/tty/ttyGU0/cidmode
 2712.7. Dialing Numbers
 272     ---------------
 273     The called party number provided by an application for dialing out must
 274     be a public network number according to the local dialing plan, without
 275     any dial prefix for getting an outside line.
 277     Internal calls can be made by providing an internal extension number
 278     prefixed with "**" (two asterisks) as the called party number. So to dial
 279     eg. the first registered DECT handset, give "**11" as the called party
 280     number. Dialing "***" (three asterisks) calls all extensions
 281     simultaneously (global call).
 283     This holds for both CAPI 2.0 and ISDN4Linux applications. Unimodem mode
 284     does not support internal calls.
 2862.8. Unregistered Wireless Devices (M101/M105)
 287     -----------------------------------------
 288     The main purpose of the ser_gigaset and usb_gigaset drivers is to allow
 289     the M101 and M105 wireless devices to be used as ISDN devices for ISDN
 290     connections through a Gigaset base. Therefore they assume that the device
 291     is registered to a DECT base.
 293     If the M101/M105 device is not registered to a base, initialization of
 294     the device fails, and a corresponding error message is logged by the
 295     driver. In that situation, a restricted set of functions is available
 296     which includes, in particular, those necessary for registering the device
 297     to a base or for switching it between Fixed Part and Portable Part
 298     modes. See the gigacontr(8) manpage for details.
 3003.   Troubleshooting
 301     ---------------
 3023.1. Solutions to frequently reported problems
 303     -----------------------------------------
 304     Problem:
 305        You have a slow provider and isdn4linux gives up dialing too early.
 306     Solution:
 307        Load the isdn module using the dialtimeout option. You can do this e.g.
 308        by adding a line like
 310           options isdn dialtimeout=15
 312        to /etc/modprobe.d/gigaset.conf or a similar file.
 314     Problem:
 315        The isdnlog program emits error messages or just doesn't work.
 316     Solution:
 317        Isdnlog supports only the HiSax driver. Do not attempt to use it with
 318        other drivers such as Gigaset.
 320     Problem:
 321        You have two or more DECT data adapters (M101/M105) and only the
 322        first one you turn on works.
 323     Solution:
 324        Select Unimodem mode for all DECT data adapters. (see section 2.5.)
 326     Problem:
 327        Messages like this:
 328            usb_gigaset 3-2:1.0: Could not initialize the device.
 329        appear in your syslog.
 330     Solution:
 331        Check whether your M10x wireless device is correctly registered to the
 332        Gigaset base. (see section 2.7.)
 3343.2. Telling the driver to provide more information
 335     ----------------------------------------------
 336     Building the driver with the "Gigaset debugging" kernel configuration
 337     option (CONFIG_GIGASET_DEBUG) gives it the ability to produce additional
 338     information useful for debugging.
 340     You can control the amount of debugging information the driver produces by
 341     writing an appropriate value to /sys/module/gigaset/parameters/debug, e.g.
 342        echo 0 > /sys/module/gigaset/parameters/debug
 343     switches off debugging output completely,
 344        echo 0x302020 > /sys/module/gigaset/parameters/debug
 345     enables a reasonable set of debugging output messages. These values are
 346     bit patterns where every bit controls a certain type of debugging output.
 347     See the constants DEBUG_* in the source file gigaset.h for details.
 349     The initial value can be set using the debug parameter when loading the
 350     module "gigaset", e.g. by adding a line
 351        options gigaset debug=0
 352     to your module configuration file, eg. /etc/modprobe.d/gigaset.conf
 354     Generated debugging information can be found
 355     - as output of the command
 356         dmesg
 357     - in system log files written by your syslog daemon, usually
 358       in /var/log/, e.g. /var/log/messages.
 3603.3. Reporting problems and bugs
 361     ---------------------------
 362     If you can't solve problems with the driver on your own, feel free to
 363     use one of the forums, bug trackers, or mailing lists on
 365     or write an electronic mail to the maintainers.
 367     Try to provide as much information as possible, such as
 368     - distribution
 369     - kernel version (uname -r)
 370     - gcc version (gcc --version)
 371     - hardware architecture (uname -m, ...)
 372     - type and firmware version of your device (base and wireless module,
 373       if any)
 374     - output of "lsusb -v" (if using an USB device)
 375     - error messages
 376     - relevant system log messages (it would help if you activate debug
 377       output as described in 3.2.)
 379     For help with general configuration problems not specific to our driver,
 380     such as isdn4linux and network configuration issues, please refer to the
 381     appropriate forums and newsgroups.
 3833.4. Reporting problem solutions
 384     ---------------------------
 385     If you solved a problem with our drivers, wrote startup scripts for your
 386     distribution, ... feel free to contact us (using one of the places
 387     mentioned in 3.3.). We'd like to add scripts, hints, documentation
 388     to the driver and/or the project web page.
 3914.   Links, other software
 392     ---------------------
 393     - Sourceforge project developing this driver and associated tools
 395     - Yahoo! Group on the Siemens Gigaset family of devices
 397     - Siemens Gigaset/T-Sinus compatibility table
 4015.   Credits
 402     -------
 403     Thanks to
 405     Karsten Keil
 406        for his help with isdn4linux
 407     Deti Fliegl
 408        for his base driver code
 409     Dennis Dietrich
 410        for his kernel 2.6 patches
 411     Andreas Rummel
 412        for his work and logs to get unimodem mode working
 413     Andreas Degert
 414        for his logs and patches to get cx 100 working
 415     Dietrich Feist
 416        for his generous donation of one M105 and two M101 cordless adapters
 417     Christoph Schweers
 418        for his generous donation of a M34 device
 420     and all the other people who sent logs and other information.
 422 kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.