home *** CD-ROM | disk | FTP | other *** search
/ PCNET 2006 September - Disc 1 / PCNET_CD_2006_09.iso / linux / puppy-barebones-2.01r2.iso / pup_201.sfs / usr / share / doc / slmodem.txt < prev    next >
Encoding:
Text File  |  2006-06-12  |  6.8 KB  |  254 lines
  1. Smart Link Ltd.
  2. http://www.smlink.com
  3. Sep 30, 2003
  4.  
  5. ****************
  6. PUPPY UPDATE JUNE 2006:
  7. Thanks to rerwin who found this:
  8. slamr and slusb device major numbers now have to be 242 and 243.
  9. ****************
  10.  
  11. Smart Link Soft Modem for Linux
  12. -------------------------------
  13.  
  14.  
  15. Introduction
  16. ============
  17.  
  18. This is Smart Link Soft Modem for Linux version 2.9. It provides
  19. full-featured 56K Voice Fax Modem.
  20. This is implemented as generic application (slmodemd) and set of
  21. hardware specific kernel-space drivers (slamr, slusb).
  22. ALSA modem drivers may be used instead of proprietary ones (see ALSA mode).
  23.  
  24. Features
  25. ========
  26.  
  27. Modem: V.92, V.90, V.34, V.32bis, V.32, V.23, V.22, V.21, Bell 103/212.
  28. Flow control: V.42.
  29. Compression: V.44, V.42bis.
  30. Fax: Class 1.
  31. Voice: V253 like modem.
  32. Multiple modems are supported.
  33.  
  34.  
  35. Supported Hardware
  36. ==================
  37.  
  38. HAMR5600 based AMR/CNR/MDC/ACR modem cards on the following Southbridge
  39. chips:
  40. - Intel ICH0,ICH2, ICH3, ICH4
  41. - Via 686A, 686B, 8231, 8233
  42. - SiS 630
  43. - ALI 1535.
  44. SmartPCI56/561/562/563 based PCI modem cards.
  45. SmartUSB56 based USB modem.
  46.  
  47.  
  48.  
  49. Requirements
  50. ============
  51.  
  52. CPU: Intel Pentium II, Celron. AMD K6, Cyrix 500MHz or higher.
  53. Memory: 64MB.
  54.  
  55. OS: Linux 2.4. You need the kernel header files at least (or full kernel
  56.                source tree) installed and configured.
  57.     Linux 2.6. You need the full kernel source tree installed and configured.
  58.  
  59. Note: Most Linux Distributions have 'ready to use' kernel source package -
  60.       be sure that this is installed.
  61.  
  62.  
  63. Installation
  64. ============
  65.  
  66. 1. Unpack tar.gz package file:
  67.  
  68.     $ gzip -dc slmodem-2.9.X.tar.gz | tar xf -
  69.  
  70. 2. 'cd' to package directory:
  71.  
  72.     $ cd slmodem-2.9.X
  73.  
  74. 3. Review and edit 'Makefile' (if need):
  75.  
  76.    In many cases you will need to correct path to your local kernel
  77.    source tree:
  78.  
  79.         KERNEL_DIR=/path/to/linux
  80.  
  81.    Default KERNEL_DIR is '/lib/modules/<kerne-version>/build'. Many Linux
  82.    Distributions use directory '/usr/src/linux-<version>' also.
  83.  
  84.    Note: If you are using Linux kernel 2.4, only header files should be
  85.          available for build in $(KERNEL_DIR)/include
  86.  
  87.    Another way to pass right value KERNEL_DIR is to use command line
  88.    parameter while running 'make':
  89.  
  90.         $ make KERNEL_DIR=/path/to/linux ...
  91.  
  92. 4. Run 'make' command to compile package:
  93.  
  94.     $ make
  95.  
  96. 5. Install. As 'root' user run:
  97.  
  98.     # make install
  99.  
  100.    It will install:
  101.  
  102.    - application 'slmodemd' under '/usr/sbin' directory
  103.  
  104.    - hardware specific drivers (kernel modules) 'slamr' and 'slusb'
  105.      under conventional kernel modules directory
  106.  
  107.    - character device nodes '/dev/slamr0-3' with major number 212
  108.      (for pci modems) and '/dev/slusb0-3' with major number 213
  109.      (for usb modems).
  110.  
  111.    - config modules for autoloading (by editing file '/etc/modules.conf')
  112.      (only with 2.4 kernels)
  113.  
  114. 6. Config modem country.
  115.  
  116.    Use AT+GCI=<T.35 country code> command to setup country.
  117.  
  118.    Also you can setup default modem country by passing command line
  119.    parameter '--country=MY_COUNTRY' to program 'slmodemd'.
  120.  
  121.    See output of 'slmodemd --countrylist' for a list of supported
  122.    country names and T.35 country codes (see also 'slmodemd --help').
  123.  
  124.    Note: Command ATI7 shows currently installed country setting.
  125.  
  126. 8. Uninstallation.
  127.  
  128.    In package directory just type:
  129.  
  130.     # make uninstall
  131.  
  132.  
  133. Getting Started
  134. ===============
  135.  
  136. After successful installation and configuration:
  137.  
  138. 1. Load modem driver.
  139.  
  140.    Load your modem hardware specific kernel module:
  141.  
  142.     # modprobe slamr
  143.  
  144.    if you are using AMR/CNR/PCI modem, or
  145.  
  146.     # modprobe slusb
  147.  
  148.    if you are using SmartUSB56 Modem.
  149.  
  150.    Note: this will be done automatically when modules were
  151.          configured for 'loading on demand'
  152.  
  153.    Note: this is safe to load both 'alamr' and 'slusb' modules.
  154.  
  155. 2. Run soft modem application.
  156.  
  157.        # /usr/sbin/slmodemd [options] <device_name>
  158.  
  159.    Where device name is appropriate device node for your modem
  160.    (look at output of 'dmesg' command).
  161.    Run '/usr/sbin/slmodemd --help' for details.
  162.  
  163.    Examples:
  164.  
  165.        # /usr/sbin/slmodemd --country=USA /dev/slamr0
  166.  
  167.    , or for SmartUSB56 Modems:
  168.  
  169.        # /usr/sbin/slmodemd --country=ITALY /dev/slusb0
  170.  
  171. 3. Using the modem.
  172.  
  173.    When 'slmodemd' is running this creates PTY (pseudo-terminal) to
  174.    emulate modem port device, also this creates symbolic link
  175.    like '/dev/ttySL0' (shown at startup).
  176.  
  177.    Config your application to use this link '/dev/ttySL0' (or PTY node
  178.    itself) as modem port.
  179.  
  180.    Note: Some application want 'to know' that they are working with
  181.          pseudo-terminal and may require additional configurations.
  182.  
  183.    Known application notes:
  184.  
  185.    - 'wvdial' requires option 'Carrier Check = no' in config file
  186.  
  187.    - some versions of 'kppp' may not work properly with devices named
  188.      like '/dev/ttySL0'. To workaround this you may create symbolic link
  189.      '/dev/modem' ( # ln -s /dev/ttySL0 /dev/modem ) and use this link
  190.      as modem device with 'kppp'
  191.  
  192. 4. Startup automation.
  193.  
  194.     There are examples of startup scripts in 'scripts' directory.
  195.  
  196.  
  197. ALSA mode
  198. =========
  199.  
  200. ALSA has the built-in modem drivers included in 'alsa-driver' >= 1.0.2
  201. and in Linux kernel >= 2.6.5. Currently there is 'intel8x0m' (snd-intel8x0m)
  202. modem driver, which supports ICH based AC97 modems (MC97).
  203.  
  204. Recent 'alsa-driver' (>=1.0.6) has also support for NVidia NForce
  205. (snd-intel8x0m) and ATI IXP (snd-atiixp-modem) based modems.
  206.  
  207. 1. Configure your kernel and enable ALSA and ICH based modem support
  208.    ( 'Device Drivers' -> 'Sound' -> 'Advanced Linux Sound Architecture' ->
  209.      'PCI devices' -> 'Intel i8x0/MX440; AMD768/8111 modems' ) .
  210.  
  211. 2. Build and install kernel and modules as usual (make , make modules_install,
  212.    etc.). ICH modem driver modem module name is 'snd-intel8x0m'
  213.    (if was configured as module).
  214.  
  215. 3. Build application 'slmodemd' with ALSA support. For this in
  216.    slmodem-2.9.x dir:
  217.  
  218.       $ cd modem
  219.       $ make SUPPORT_ALSA=1
  220.  
  221.    This will build 'slmodemd' with ALSA support. If compilation is failed
  222.    review Makefile (near ALSA_SUPPORT condition) and define right library
  223.    and/or CFLAGS
  224.  
  225. 4. Use option '--alsa' when running 'slmodemd' and ALSA conventional
  226.    device name ('hw:0' or 'hw:1' for instance). If modem support in
  227.    the kernel was enabled as module module 'snd-intel8x0m' should be loaded.
  228.  
  229. Note: Recent version of 'alsa-lib' (>= 1.0.6) has built-in "modem" device
  230.       name support ('modem:0', 'modem:1', etc). It is recommended to use
  231.       those names with modems (mandatory with ATI IXP modems).
  232.  
  233. Note: When using ALSA modem driver you don't need to load other
  234.       modules ('slamr').
  235.  
  236.  
  237. Troubleshooting
  238. ===============
  239.  
  240. If you get an error message during installation/configuration or loading
  241. the modules try to see it in FAQ file.
  242.  
  243. Please report the problem to your modem provider or to us
  244. (linux-support@smlink.com). 
  245.  
  246.  
  247. Feedback
  248. ========
  249.  
  250. Please send any feedbacks to Smart Link. See the Smart Link
  251. web site for contact information (www.smlink.com) or to
  252. linux-support@smlink.com.
  253.  
  254.