Linux-2.6.12-rc2
[linux-2.6.git] / Documentation / sound / oss / CMI8338
1 Audio driver for CM8338/CM8738 chips by Chen-Li Tien
2
3
4 HARDWARE SUPPORTED
5 ================================================================================
6 C-Media CMI8338
7 C-Media CMI8738
8 On-board C-Media chips
9
10
11 STEPS TO BUILD DRIVER
12 ================================================================================
13
14   1. Backup the Config.in and Makefile in the sound driver directory
15      (/usr/src/linux/driver/sound).
16      The Configure.help provide help when you config driver in step
17      4, please backup the original one (/usr/src/linux/Document) and
18      copy this file.
19      The cmpci is document for the driver in detail, please copy it
20      to /usr/src/linux/Document/sound so you can refer it. Backup if
21      there is already one.
22
23   2. Extract the tar file by 'tar xvzf cmpci-xx.tar.gz' in the above
24      directory.
25
26   3. Change directory to /usr/src/linux
27
28   4. Config cm8338 driver by 'make menuconfig', 'make config' or
29      'make xconfig' command.
30
31   5. Please select Sound Card (CONFIG_SOUND=m) support and CMPCI
32      driver (CONFIG_SOUND_CMPCI=m) as modules. Resident mode not tested.
33      For driver option, please refer 'DRIVER PARAMETER'
34
35   6. Compile the kernel if necessary.
36
37   7. Compile the modules by 'make modules'.
38
39   8. Install the modules by 'make modules_install'
40
41
42 INSTALL DRIVER
43 ================================================================================
44
45   1. Before first time to run the driver, create module dependency by
46      'depmod -a'
47
48   2. To install the driver manually, enter 'modprobe cmpci'.
49
50   3. Driver installation for various distributions:
51
52     a. Slackware 4.0
53        Add the 'modprobe cmpci' command in your /etc/rc.d/rc.modules
54        file.so you can start the driver automatically each time booting.
55
56     b. Caldera OpenLinux 2.2
57        Use LISA to load the cmpci module.
58
59     c. RedHat 6.0 and S.u.S.E. 6.1
60        Add following command in /etc/conf.modules:
61
62        alias sound cmpci
63
64         also visit http://www.cmedia.com.tw for installation instruction.
65
66 DRIVER PARAMETER
67 ================================================================================
68
69   Some functions for the cm8738 can be configured in Kernel Configuration
70   or modules parameters. Set these parameters to 1 to enable.
71
72   mpuio:        I/O ports base for MPU-401, 0 if disabled.
73   fmio:         I/O ports base for OPL-3, 0 if disabled.
74   spdif_inverse:Inverse the S/PDIF-in signal, this depends on your
75                 CD-ROM or DVD-ROM.
76   spdif_loop:   Enable S/PDIF loop, this route S/PDIF-in to S/PDIF-out
77                 directly.
78   speakers:     Number of speakers used.
79   use_line_as_rear:Enable this if you want to use line-in as
80                 rear-out.
81   use_line_as_bass:Enable this if you want to use line-in as
82                 bass-out.
83   joystick:     Enable joystick. You will need to install Linux joystick
84                 driver.
85