patch-2.4.7 linux/Documentation/sound/CMI8338

Next file: linux/Documentation/sound/OPL3-SA2
Previous file: linux/Documentation/sonypi.txt
Back to the patch index
Back to the overall index

diff -u --recursive --new-file v2.4.6/linux/Documentation/sound/CMI8338 linux/Documentation/sound/CMI8338
@@ -8,59 +8,80 @@
 On-board C-Media chips
 
 
-WHAT'S NEW
+STEPS TO BUILD DRIVER
 ================================================================================
 
-  1. Support modem interface for 8738. (select in kernel configuration)
-  2. Enable S/PDIF-in to S/PDIF-out (S/PDIF loop).
-  3. Enable 4 channels analog duplicate mode on 3 jack or 4 jack
-     configuration.
+  1. Backup the Config.in and Makefile in the sound driver directory
+     (/usr/src/linux/driver/sound).
+     The Configure.help provide help when you config driver in step
+     4, please backup the original one (/usr/src/linux/Document) and
+     copy this file.
+     The cmpci is document for the driver in detail, please copy it
+     to /usr/src/linux/Document/sound so you can refer it. Backup if
+     there is already one.
 
+  2. Extract the tar file by 'tar xvzf cmpci-xx.tar.gz' in the above
+     directory.
 
-   Be aware: C-Media Electronics Inc. is basically an IC design house,
-   and whose development of software drivers is mainly for use by its OEM
-   customers in their products. C-Media Electronics Inc. itself does not
-   manufacture end-user products, such as PC or sound cards, so it can
-   not fully control the drivers provided to consumers. Drivers provided
-   at this site, therefore, MAY NOT BE APPLICABLE to all sound cards.
-   Drivers you download from this site may function well at certain
-   situation, but C-Media Electronics Inc. does not give any guarantee or
-   assurances. Please be aware that these drivers might cause some
-   technical difficulties when installed
+  3. Change directory to /usr/src/linux
 
+  4. Config cm8338 driver by 'make menuconfig', 'make config' or
+     'make xconfig' command.
 
-1. Config cm8338 driver by 'make menuconfig' or 'make config' command.
+  5. Please select Sound Card (CONFIG_SOUND=m) support and CMPCI
+     driver (CONFIG_SOUND_CMPCI=m) as modules. Resident mode not tested.
+     For driver option, please refer 'DRIVER PARAMETER'
 
-2. Please select Sound Card (CONFIG_SOUND=m) support and CMPCI driver (CONFIG_SOUND_CMPCI=m) as modules. Resident mode not tested.
+  6. Compile the kernel if necessary.
 
-3. Compile the kernel if necessary.
+  7. Compile the modules by 'make modules'.
 
-4. Compile the modules by 'make modules'.
+  8. Install the modules by 'make modules_install'
 
-5. Install the modules by 'make modules_install'
 
-6. Before first time to run the driver, create module dependency by 'depmod -a'
+INSTALL DRIVER
+================================================================================
+
+  1. Before first time to run the driver, create module dependency by
+     'depmod -a'
+
+  2. To install the driver manually, enter 'modprobe cmpci'.
+
+  3. Driver installation for various distributions:
 
-7. To install the driver, enter 'modprobe cmpci'.
+    a. Slackware 4.0
+       Add the 'modprobe cmpci' command in your /etc/rc.d/rc.modules
+       file.so you can start the driver automatically each time booting.
 
+    b. Caldera OpenLinux 2.2
+       Use LISA to load the cmpci module.
 
-DRIVER PARAMETERS
+    c. RedHat 6.0 and S.u.S.E. 6.1
+       Add following command in /etc/conf.modules:
+
+       alias sound cmpci
+
+	also visit http://www.cmedia.com.tw for installation instruction.
+
+DRIVER PARAMETER
 ================================================================================
 
   Some functions for the cm8738 can be configured in Kernel Configuration
   or modules parameters. Set these parameters to 1 to enable.
 
+  mpu_io:	I/O ports base for MPU-401, 0 if disabled.
+  fm_io:	I/O ports base for OPL-3, 0 if disabled.
+  spdif_inverse:Inverse the S/PDIF-in signal, this depends on your
+		CD-ROM or DVD-ROM.
   spdif_loop:   Enable S/PDIF loop, this route S/PDIF-in to S/PDIF-out
                 directly.
-  four_ch:      Enable 4 channels mode, rear-out or line-in will output
-                the same as line-out.
-  rear_out:     Enable this if you have independent rear-out jacket on
-                your sound card, otherwise line-in will be used as
+  speakers:     Number of speakers used.
+  use_line_as_rear:Enable this if you want to use line-in as
                 rear-out.
+  use_line_as_bass:Enable this if you want to use line-in as
+                bass-out.
   modem:	You will need to set this parameter if you want to use
 		the HSP modem. You need install the pctel.o, the modem
 		driver itself.
-
-  (You will need to get the pctel driver (binary only) and the support for
-  this option from the CMI site. It is not included in the Linux kernel 
-  proper as it is non-free).
+  joystick:	Enable joystick. You will need to install Linux joystick
+		driver.

FUNET's LINUX-ADM group, linux-adm@nic.funet.fi
TCL-scripts by Sam Shen (who was at: slshen@lbl.gov)