| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | This file contains notes for users of PSS sound cards who wish to use the |
| 2 | newly added features of the newest version of this driver. |
| 3 | |
| 4 | The major enhancements present in this new revision of this driver is the |
| 5 | addition of two new module parameters that allow you to take full advantage of |
| 6 | all the features present on your PSS sound card. These features include the |
| 7 | ability to enable both the builtin CDROM and joystick ports. |
| 8 | |
| 9 | pss_enable_joystick |
| 10 | |
| 11 | This parameter is basically a flag. A 0 will leave the joystick port |
| 12 | disabled, while a non-zero value would enable the joystick port. The default |
| 13 | setting is pss_enable_joystick=0 as this keeps this driver fully compatible |
| 14 | with systems that were using previous versions of this driver. If you wish to |
| 15 | enable the joystick port you will have to add pss_enable_joystick=1 as an |
| 16 | argument to the driver. To actually use the joystick port you will then have |
| 17 | to load the joystick driver itself. Just remember to load the joystick driver |
| 18 | AFTER the pss sound driver. |
| 19 | |
| 20 | pss_cdrom_port |
| 21 | |
| 22 | This parameter takes a port address as its parameter. Any available port |
| 23 | address can be specified to enable the CDROM port, except for 0x0 and -1 as |
| 24 | these values would leave the port disabled. Like the joystick port, the cdrom |
| 25 | port will require that an appropriate CDROM driver be loaded before you can make |
| 26 | use of the newly enabled CDROM port. Like the joystick port option above, |
| 27 | remember to load the CDROM driver AFTER the pss sound driver. While it may |
| 28 | differ on some PSS sound cards, all the PSS sound cards that I have seen have a |
| 29 | builtin Wearnes CDROM port. If this is the case with your PSS sound card you |
| 30 | should load aztcd with the appropriate port option that matches the port you |
| 31 | assigned to the CDROM port when you loaded your pss sound driver. (ex. |
| 32 | modprobe pss pss_cdrom_port=0x340 && modprobe aztcd aztcd=0x340) The default |
| 33 | setting of this parameter leaves the CDROM port disabled to maintain full |
| 34 | compatibility with systems using previous versions of this driver. |
| 35 | |
| 36 | Other options have also been added for the added convenience and utility |
| 37 | of the user. These options are only available if this driver is loaded as a |
| 38 | module. |
| 39 | |
| 40 | pss_no_sound |
| 41 | |
| 42 | This module parameter is a flag that can be used to tell the driver to |
| 43 | just configure non-sound components. 0 configures all components, a non-0 |
| 44 | value will only attept to configure the CDROM and joystick ports. This |
| 45 | parameter can be used by a user who only wished to use the builtin joystick |
| 46 | and/or CDROM port(s) of his PSS sound card. If this driver is loaded with this |
| 47 | parameter and with the parameter below set to true then a user can safely unload |
| 48 | this driver with the following command "rmmod pss && rmmod ad1848 && rmmod |
| 49 | mpu401 && rmmod sound && rmmod soundcore" and retain the full functionality of |
| 50 | his CDROM and/or joystick port(s) while gaining back the memory previously used |
| 51 | by the sound drivers. This default setting of this parameter is 0 to retain |
| 52 | full behavioral compatibility with previous versions of this driver. |
| 53 | |
| 54 | pss_keep_settings |
| 55 | |
| 56 | This parameter can be used to specify whether you want the driver to reset |
| 57 | all emulations whenever its unloaded. This can be useful for those who are |
| 58 | sharing resources (io ports, IRQ's, DMA's) between different ISA cards. This |
| 59 | flag can also be useful in that future versions of this driver may reset all |
| 60 | emulations by default on the driver's unloading (as it probably should), so |
| 61 | specifying it now will ensure that all future versions of this driver will |
| 62 | continue to work as expected. The default value of this parameter is 1 to |
| 63 | retain full behavioral compatibility with previous versions of this driver. |
| 64 | |
| 65 | pss_firmware |
| 66 | |
| 67 | This parameter can be used to specify the file containing the firmware |
| 68 | code so that a user could tell the driver where that file is located instead |
| 69 | of having to put it in a predefined location with a predefined name. The |
| 70 | default setting of this parameter is "/etc/sound/pss_synth" as this was the |
| 71 | path and filename the hardcoded value in the previous versions of this driver. |
| 72 | |
| 73 | Examples: |
| 74 | |
| 75 | # Normal PSS sound card system, loading of drivers. |
| 76 | # Should be specified in an rc file (ex. Slackware uses /etc/rc.d/rc.modules). |
| 77 | |
| 78 | /sbin/modprobe pss pss_io=0x220 mpu_io=0x338 mpu_irq=9 mss_io=0x530 mss_irq=10 mss_dma=1 pss_cdrom_port=0x340 pss_enable_joystick=1 |
| 79 | /sbin/modprobe aztcd aztcd=0x340 |
| 80 | /sbin/modprobe joystick |
| 81 | |
| 82 | # System using the PSS sound card just for its CDROM and joystick ports. |
| 83 | # Should be specified in an rc file (ex. Slackware uses /etc/rc.d/rc.modules). |
| 84 | |
| 85 | /sbin/modprobe pss pss_io=0x220 pss_cdrom_port=0x340 pss_enable_joystick=1 pss_no_sound=1 |
| 86 | /sbin/rmmod pss && /sbin/rmmod ad1848 && /sbin/rmmod mpu401 && /sbin/rmmod sound && /sbin/rmmod soundcore # This line not needed, but saves memory. |
| 87 | /sbin/modprobe aztcd aztcd=0x340 |
| 88 | /sbin/modprobe joystick |