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