text: /*
   * sound/oss/pss.c
   *
   * The low level driver for the Personal Sound System (ECHO ESC614).
   *
   *
   * Copyright (C) by Hannu Savolainen 1993-1997
   *
   * OSS/Free for Linux is distributed under the GNU GENERAL PUBLIC LICENSE (GPL)
   * Version 2 (June 1991). See the "COPYING" file distributed with this software
   * for more info.
   *
   *
   * Thomas Sailer	ioctl code reworked (vmalloc/vfree removed)
   * Alan Cox		modularisation, clean up.
   *
   * 98-02-21: Vladimir Michl <vladimir.michl@upol.cz>
   *          Added mixer device for Beethoven ADSP-16 (master volume,
   *	    bass, treble, synth), only for speakers.
   *          Fixed bug in pss_write (exchange parameters)
   *          Fixed config port of SB
   *          Requested two regions for PSS (PSS mixer, PSS config)
   *          Modified pss_download_boot
   *          To probe_pss_mss added test for initialize AD1848
   * 98-05-28: Vladimir Michl <vladimir.michl@upol.cz>
   *          Fixed computation of mixer volumes
   * 04-05-1999: Anthony Barbachan <barbcode@xmen.cis.fordham.edu>
   *          Added code that allows the user to enable his cdrom and/or 
   *          joystick through the module parameters pss_cdrom_port and 
   *          pss_enable_joystick.  pss_cdrom_port takes a port address as its
   *          argument.  pss_enable_joystick takes either a 0 or a non-0 as its
   *          argument.
   * 04-06-1999: Anthony Barbachan <barbcode@xmen.cis.fordham.edu>
   *          Separated some code into new functions for easier reuse.  
   *          Cleaned up and streamlined new code.  Added code to allow a user 
   *          to only use this driver for enabling non-sound components 
   *          through the new module parameter pss_no_sound (flag).  Added 
   *          code that would allow a user to decide whether the driver should 
   *          reset the configured hardware settings for the PSS board through 
   *          the module parameter pss_keep_settings (flag).   This flag will 
   *          allow a user to free up resources in use by this card if needbe, 
   *          furthermore it allows him to use this driver to just enable the 
   *          emulations and then be unloaded as it is no longer needed.  Both 
   *          new settings are only available to this driver if compiled as a 
   *          module.  The default settings of all new parameters are set to 
   *          load the driver as it did in previous versions.
   * 04-07-1999: Anthony Barbachan <barbcode@xmen.cis.fordham.edu>
   *          Added module parameter pss_firmware to allow the user to tell 
   *          the driver where the firmware file is located.  The default 
   *          setting is the previous hardcoded setting "/etc/sound/pss_synth".
   * 00-03-03: Christoph Hellwig <chhellwig@infradead.org>
   *	    Adapted to module_init/module_exit
   * 11-10-2000: Bartlomiej Zolnierkiewicz <bkz@linux-ide.org>
   *	    Added __init to probe_pss(), attach_pss() and probe_pss_mpu()
   * 02-Jan-2001: Chris Rankin
   *          Specify that this module owns the coprocessor
   */
  
  
  #include <linux/init.h>
  #include <linux/module.h>
  #include <linux/spinlock.h>
  
  #include "sound_config.h"
  #include "sound_firmware.h"
  
  #include "ad1848.h"
  #include "mpu401.h"
  
  /*
   * PSS registers.
   */
  #define REG(x)	(devc->base+x)
  #define	PSS_DATA	0
  #define	PSS_STATUS	2
  #define PSS_CONTROL	2
  #define	PSS_ID		4
  #define	PSS_IRQACK	4
  #define	PSS_PIO		0x1a
  
  /*
   * Config registers
   */
  #define CONF_PSS	0x10
  #define CONF_WSS	0x12
  #define CONF_SB		0x14
  #define CONF_CDROM	0x16
  #define CONF_MIDI	0x18
  
  /*
   * Status bits.
   */
  #define PSS_FLAG3     0x0800
  #define PSS_FLAG2     0x0400
  #define PSS_FLAG1     0x1000
  #define PSS_FLAG0     0x0800
  #define PSS_WRITE_EMPTY  0x8000
  #define PSS_READ_FULL    0x4000
  
  /*
   * WSS registers
   */
  #define WSS_INDEX 4
  #define WSS_DATA 5
  
  /*
   * WSS status bits
   */
  #define WSS_INITIALIZING 0x80
  #define WSS_AUTOCALIBRATION 0x20
  
  #define NO_WSS_MIXER	-1
  
  #include "coproc.h"
  
  #include "pss_boot.h"
  
  /* If compiled into kernel, it enable or disable pss mixer */
  #ifdef CONFIG_PSS_MIXER
  static bool pss_mixer = 1;
  #else
  static bool pss_mixer;
  #endif
  
  
  struct pss_mixerdata {
  	unsigned int volume_l;
  	unsigned int volume_r;
  	unsigned int bass;
  	unsigned int treble;
  	unsigned int synth;
  };
  
  struct pss_confdata {
  	int             base;
  	int             irq;
  	int             dma;
  	int            *osp;
  	struct pss_mixerdata mixer;
  	int             ad_mixer_dev;
  };
    
  static struct pss_confdata pss_data;
  static struct pss_confdata *devc = &pss_data;
  static DEFINE_SPINLOCK(lock);
  
  static int      pss_initialized;
  static int      nonstandard_microcode;
  static int	pss_cdrom_port = -1;	/* Parameter for the PSS cdrom port */
  static bool	pss_enable_joystick;    /* Parameter for enabling the joystick */
  static coproc_operations pss_coproc_operations;
  
  static void pss_write(struct pss_confdata *devc, int data)
  {
  	unsigned long i, limit;
  
  	limit = jiffies + HZ/10;	/* The timeout is 0.1 seconds */
  	/*
  	 * Note! the i<5000000 is an emergency exit. The dsp_command() is sometimes
  	 * called while interrupts are disabled. This means that the timer is
  	 * disabled also. However the timeout situation is a abnormal condition.
  	 * Normally the DSP should be ready to accept commands after just couple of
  	 * loops.
  	 */
  
  	for (i = 0; i < 5000000 && time_before(jiffies, limit); i++)
   	{
   		if (inw(REG(PSS_STATUS)) & PSS_WRITE_EMPTY)
   		{
   			outw(data, REG(PSS_DATA));
   			return;
   		}
   	}
   	printk(KERN_WARNING "PSS: DSP Command (%04x) Timeout.\n", data);
  }
  
  static int __init probe_pss(struct address_info *hw_config)
  {
  	unsigned short id;
  	int irq, dma;
  
  	devc->base = hw_config->io_base;
  	irq = devc->irq = hw_config->irq;
  	dma = devc->dma = hw_config->dma;
  	devc->osp = hw_config->osp;
  
  	if (devc->base != 0x220 && devc->base != 0x240)
  		if (devc->base != 0x230 && devc->base != 0x250)		/* Some cards use these */
  			return 0;
  
  	if (!request_region(devc->base, 0x10, "PSS mixer, SB emulation")) {
  		printk(KERN_ERR "PSS: I/O port conflict\n");
  		return 0;
  	}
  	id = inw(REG(PSS_ID));
  	if ((id >> 8) != 'E') {
  		printk(KERN_ERR "No PSS signature detected at 0x%x (0x%x)\n",  devc->base,  id); 
  		release_region(devc->base, 0x10);
  		return 0;
  	}
  	if (!request_region(devc->base + 0x10, 0x9, "PSS config")) {
  		printk(KERN_ERR "PSS: I/O port conflict\n");
  		release_region(devc->base, 0x10);
  		return 0;
  	}
  	return 1;
  }
  
  static int set_irq(struct pss_confdata *devc, int dev, int irq)
  {
  	static unsigned short irq_bits[16] =
  	{
  		0x0000, 0x0000, 0x0000, 0x0008,
  		0x0000, 0x0010, 0x0000, 0x0018,
  		0x0000, 0x0020, 0x0028, 0x0030,
  		0x0038, 0x0000, 0x0000, 0x0000
  	};
  
  	unsigned short  tmp, bits;
  
  	if (irq < 0 || irq > 15)
  		return 0;
  
  	tmp = inw(REG(dev)) & ~0x38;	/* Load confreg, mask IRQ bits out */
  
  	if ((bits = irq_bits[irq]) == 0 && irq != 0)
  	{
  		printk(KERN_ERR "PSS: Invalid IRQ %d\n", irq);
  		return 0;
  	}
  	outw(tmp | bits, REG(dev));
  	return 1;
  }
  
  static void set_io_base(struct pss_confdata *devc, int dev, int base)
  {
  	unsigned short  tmp = inw(REG(dev)) & 0x003f;
  	unsigned short  bits = (base & 0x0ffc) << 4;
  
  	outw(bits | tmp, REG(dev));
  }
  
  static int set_dma(struct pss_confdata *devc, int dev, int dma)
  {
  	static unsigned short dma_bits[8] =
  	{
  		0x0001, 0x0002, 0x0000, 0x0003,
  		0x0000, 0x0005, 0x0006, 0x0007
  	};
  
  	unsigned short  tmp, bits;
  
  	if (dma < 0 || dma > 7)
  		return 0;
  
  	tmp = inw(REG(dev)) & ~0x07;	/* Load confreg, mask DMA bits out */
  
  	if ((bits = dma_bits[dma]) == 0 && dma != 4)
  	{
  		  printk(KERN_ERR "PSS: Invalid DMA %d\n", dma);
  		  return 0;
  	}
  	outw(tmp | bits, REG(dev));
  	return 1;
  }
  
  static int pss_reset_dsp(struct pss_confdata *devc)
  {
  	unsigned long   i, limit = jiffies + HZ/10;
  
  	outw(0x2000, REG(PSS_CONTROL));
  	for (i = 0; i < 32768 && time_after_eq(limit, jiffies); i++)
  		inw(REG(PSS_CONTROL));
  	outw(0x0000, REG(PSS_CONTROL));
  	return 1;
  }
  
  static int pss_put_dspword(struct pss_confdata *devc, unsigned short word)
  {
  	int i, val;
  
  	for (i = 0; i < 327680; i++)
  	{
  		val = inw(REG(PSS_STATUS));
  		if (val & PSS_WRITE_EMPTY)
  		{
  			outw(word, REG(PSS_DATA));
  			return 1;
  		}
  	}
  	return 0;
  }
  
  static int pss_get_dspword(struct pss_confdata *devc, unsigned short *word)
  {
  	int i, val;
  
  	for (i = 0; i < 327680; i++)
  	{
  		val = inw(REG(PSS_STATUS));
  		if (val & PSS_READ_FULL)
  		{
  			*word = inw(REG(PSS_DATA));
  			return 1;
  		}
  	}
  	return 0;
  }
  
  static int pss_download_boot(struct pss_confdata *devc, unsigned char *block,
  			     int size, int flags)
  {
  	int i, val, count;
  	unsigned long limit;
  
  	if (flags & CPF_FIRST)
  	{
  /*_____ Warn DSP software that a boot is coming */
  		outw(0x00fe, REG(PSS_DATA));
  
  		limit = jiffies + HZ/10;
  		for (i = 0; i < 32768 && time_before(jiffies, limit); i++)
  			if (inw(REG(PSS_DATA)) == 0x5500)
  				break;
  
  		outw(*block++, REG(PSS_DATA));
  		pss_reset_dsp(devc);
  	}
  	count = 1;
  	while ((flags&CPF_LAST) || count<size )
  	{
  		int j;
  
  		for (j = 0; j < 327670; j++)
  		{
  /*_____ Wait for BG to appear */
  			if (inw(REG(PSS_STATUS)) & PSS_FLAG3)
  				break;
  		}
  
  		if (j == 327670)
  		{
  			/* It's ok we timed out when the file was empty */
  			if (count >= size && flags & CPF_LAST)
  				break;
  			else
  			{
  				printk("\n");
  				printk(KERN_ERR "PSS: Download timeout problems, byte %d=%d\n", count, size);
  				return 0;
  			}
  		}
  /*_____ Send the next byte */
  		if (count >= size) 
  		{
  			/* If not data in block send 0xffff */
  			outw (0xffff, REG (PSS_DATA));
  		}
  		else
  		{
  			/*_____ Send the next byte */
  			outw (*block++, REG (PSS_DATA));
  		}
  		count++;
  	}
  
  	if (flags & CPF_LAST)
  	{
  /*_____ Why */
  		outw(0, REG(PSS_DATA));
  
  		limit = jiffies + HZ/10;
  		for (i = 0; i < 32768 && time_after_eq(limit, jiffies); i++)
  			val = inw(REG(PSS_STATUS));
  
  		limit = jiffies + HZ/10;
  		for (i = 0; i < 32768 && time_after_eq(limit, jiffies); i++)
  		{
  			val = inw(REG(PSS_STATUS));
  			if (val & 0x4000)
  				break;
  		}
  
  		/* now read the version */
  		for (i = 0; i < 32000; i++)
  		{
  			val = inw(REG(PSS_STATUS));
  			if (val & PSS_READ_FULL)
  				break;
  		}
  		if (i == 32000)
  			return 0;
  
  		val = inw(REG(PSS_DATA));
  		/* printk( "<PSS: microcode version %d.%d loaded>",  val/16,  val % 16); */
  	}
  	return 1;
  }
  
  /* Mixer */
  static void set_master_volume(struct pss_confdata *devc, int left, int right)
  {
  	static unsigned char log_scale[101] =  {
  		0xdb, 0xe0, 0xe3, 0xe5, 0xe7, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xed, 0xee,
  		0xef, 0xef, 0xf0, 0xf0, 0xf1, 0xf1, 0xf2, 0xf2, 0xf2, 0xf3, 0xf3, 0xf3,
  		0xf4, 0xf4, 0xf4, 0xf5, 0xf5, 0xf5, 0xf5, 0xf6, 0xf6, 0xf6, 0xf6, 0xf7,
  		0xf7, 0xf7, 0xf7, 0xf7, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf9, 0xf9, 0xf9,
  		0xf9, 0xf9, 0xf9, 0xfa, 0xfa, 0xfa, 0xfa, 0xfa, 0xfa, 0xfa, 0xfb, 0xfb,
  		0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfc, 0xfc, 0xfc, 0xfc, 0xfc, 0xfc,
  		0xfc, 0xfc, 0xfc, 0xfc, 0xfd, 0xfd, 0xfd, 0xfd, 0xfd, 0xfd, 0xfd, 0xfd,
  		0xfd, 0xfd, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe,
  		0xfe, 0xfe, 0xff, 0xff, 0xff
  	};
  	pss_write(devc, 0x0010);
  	pss_write(devc, log_scale[left] | 0x0000);
  	pss_write(devc, 0x0010);
  	pss_write(devc, log_scale[right] | 0x0100);
  }
  
  static void set_synth_volume(struct pss_confdata *devc, int volume)
  {
  	int vol = ((0x8000*volume)/100L);
  	pss_write(devc, 0x0080);
  	pss_write(devc, vol);
  	pss_write(devc, 0x0081);
  	pss_write(devc, vol);
  }
  
  static void set_bass(struct pss_confdata *devc, int level)
  {
  	int vol = (int)(((0xfd - 0xf0) * level)/100L) + 0xf0;
  	pss_write(devc, 0x0010);
  	pss_write(devc, vol | 0x0200);
  };
  
  static void set_treble(struct pss_confdata *devc, int level)
  {	
  	int vol = (((0xfd - 0xf0) * level)/100L) + 0xf0;
  	pss_write(devc, 0x0010);
  	pss_write(devc, vol | 0x0300);
  };
  
  static void pss_mixer_reset(struct pss_confdata *devc)
  {
  	set_master_volume(devc, 33, 33);
  	set_bass(devc, 50);
  	set_treble(devc, 50);
  	set_synth_volume(devc, 30);
  	pss_write (devc, 0x0010);
  	pss_write (devc, 0x0800 | 0xce);	/* Stereo */
  	
  	if(pss_mixer)
  	{
  		devc->mixer.volume_l = devc->mixer.volume_r = 33;
  		devc->mixer.bass = 50;
  		devc->mixer.treble = 50;
  		devc->mixer.synth = 30;
  	}
  }
  
  static int set_volume_mono(unsigned __user *p, unsigned int *aleft)
  {
  	unsigned int left, volume;
  	if (get_user(volume, p))
  		return -EFAULT;
  	
  	left = volume & 0xff;
  	if (left > 100)
  		left = 100;
  	*aleft = left;
  	return 0;
  }
  
  static int set_volume_stereo(unsigned __user *p,
  			     unsigned int *aleft,
  			     unsigned int *aright)
  {
  	unsigned int left, right, volume;
  	if (get_user(volume, p))
  		return -EFAULT;
  
  	left = volume & 0xff;
  	if (left > 100)
  		left = 100;
  	right = (volume >> 8) & 0xff;
  	if (right > 100)
  		right = 100;
  	*aleft = left;
  	*aright = right;
  	return 0;
  }
  
  static int ret_vol_mono(int left)
  {
  	return ((left << 8) | left);
  }
  
  static int ret_vol_stereo(int left, int right)
  {
  	return ((right << 8) | left);
  }
  
  static int call_ad_mixer(struct pss_confdata *devc, unsigned int cmd,
  			 void __user *arg)
  {
  	if (devc->ad_mixer_dev != NO_WSS_MIXER) 
  		return mixer_devs[devc->ad_mixer_dev]->ioctl(devc->ad_mixer_dev, cmd, arg);
  	else 
  		return -EINVAL;
  }
  
  static int pss_mixer_ioctl (int dev, unsigned int cmd, void __user *arg)
  {
  	struct pss_confdata *devc = mixer_devs[dev]->devc;
  	int cmdf = cmd & 0xff;
  	
  	if ((cmdf != SOUND_MIXER_VOLUME) && (cmdf != SOUND_MIXER_BASS) &&
  		(cmdf != SOUND_MIXER_TREBLE) && (cmdf != SOUND_MIXER_SYNTH) &&
  		(cmdf != SOUND_MIXER_DEVMASK) && (cmdf != SOUND_MIXER_STEREODEVS) &&
  		(cmdf != SOUND_MIXER_RECMASK) && (cmdf != SOUND_MIXER_CAPS) &&
  		(cmdf != SOUND_MIXER_RECSRC)) 
  	{
  		return call_ad_mixer(devc, cmd, arg);
  	}
  	
  	if (((cmd >> 8) & 0xff) != 'M')	
  		return -EINVAL;
  		
  	if (_SIOC_DIR (cmd) & _SIOC_WRITE)
  	{
  		switch (cmdf)	
  		{
  			case SOUND_MIXER_RECSRC:
  				if (devc->ad_mixer_dev != NO_WSS_MIXER)
  					return call_ad_mixer(devc, cmd, arg);
  				else
  				{
  					int v;
  					if (get_user(v, (int __user *)arg))
  						return -EFAULT;
  					if (v != 0)
  						return -EINVAL;
  					return 0;
  				}
  			case SOUND_MIXER_VOLUME:
  				if (set_volume_stereo(arg,
  					&devc->mixer.volume_l,
  					&devc->mixer.volume_r))
  					return -EFAULT;
  				set_master_volume(devc, devc->mixer.volume_l,
  					devc->mixer.volume_r);
  				return ret_vol_stereo(devc->mixer.volume_l,
  					devc->mixer.volume_r);
  		  
  			case SOUND_MIXER_BASS:
  				if (set_volume_mono(arg, &devc->mixer.bass))
  					return -EFAULT;
  				set_bass(devc, devc->mixer.bass);
  				return ret_vol_mono(devc->mixer.bass);
  		  
  			case SOUND_MIXER_TREBLE:
  				if (set_volume_mono(arg, &devc->mixer.treble))
  					return -EFAULT;
  				set_treble(devc, devc->mixer.treble);
  				return ret_vol_mono(devc->mixer.treble);
  		  
  			case SOUND_MIXER_SYNTH:
  				if (set_volume_mono(arg, &devc->mixer.synth))
  					return -EFAULT;
  				set_synth_volume(devc, devc->mixer.synth);
  				return ret_vol_mono(devc->mixer.synth);
  		  
  			default:
  				return -EINVAL;
  		}
  	}
  	else			
  	{
  		int val, and_mask = 0, or_mask = 0;
  		/*
  		 * Return parameters
  		 */
  		switch (cmdf)
  		{
  			case SOUND_MIXER_DEVMASK:
  				if (call_ad_mixer(devc, cmd, arg) == -EINVAL)
  					break;
  				and_mask = ~0;
  				or_mask = SOUND_MASK_VOLUME | SOUND_MASK_BASS | SOUND_MASK_TREBLE | SOUND_MASK_SYNTH;
  				break;
  		  
  			case SOUND_MIXER_STEREODEVS:
  				if (call_ad_mixer(devc, cmd, arg) == -EINVAL)
  					break;
  				and_mask = ~0;
  				or_mask = SOUND_MASK_VOLUME;
  				break;
  		  
  			case SOUND_MIXER_RECMASK:
  				if (devc->ad_mixer_dev != NO_WSS_MIXER)
  					return call_ad_mixer(devc, cmd, arg);
  				break;
  
  			case SOUND_MIXER_CAPS:
  				if (devc->ad_mixer_dev != NO_WSS_MIXER)
  					return call_ad_mixer(devc, cmd, arg);
  				or_mask = SOUND_CAP_EXCL_INPUT;
  				break;
  
  			case SOUND_MIXER_RECSRC:
  				if (devc->ad_mixer_dev != NO_WSS_MIXER)
  					return call_ad_mixer(devc, cmd, arg);
  				break;
  
  			case SOUND_MIXER_VOLUME:
  				or_mask =  ret_vol_stereo(devc->mixer.volume_l, devc->mixer.volume_r);
  				break;
  			  
  			case SOUND_MIXER_BASS:
  				or_mask =  ret_vol_mono(devc->mixer.bass);
  				break;
  			  
  			case SOUND_MIXER_TREBLE:
  				or_mask = ret_vol_mono(devc->mixer.treble);
  				break;
  			  
  			case SOUND_MIXER_SYNTH:
  				or_mask = ret_vol_mono(devc->mixer.synth);
  				break;
  			default:
  				return -EINVAL;
  		}
  		if (get_user(val, (int __user *)arg))
  			return -EFAULT;
  		val &= and_mask;
  		val |= or_mask;
  		if (put_user(val, (int __user *)arg))
  			return -EFAULT;
  		return val;
  	}
  }
  
  static struct mixer_operations pss_mixer_operations =
  {
  	.owner	= THIS_MODULE,
  	.id	= "SOUNDPORT",
  	.name	= "PSS-AD1848",
  	.ioctl	= pss_mixer_ioctl
  };
  
  static void disable_all_emulations(void)
  {
  	outw(0x0000, REG(CONF_PSS));	/* 0x0400 enables joystick */
  	outw(0x0000, REG(CONF_WSS));
  	outw(0x0000, REG(CONF_SB));
  	outw(0x0000, REG(CONF_MIDI));
  	outw(0x0000, REG(CONF_CDROM));
  }
  
  static void configure_nonsound_components(void)
  {
  	/* Configure Joystick port */
  
  	if(pss_enable_joystick)
  	{
  		outw(0x0400, REG(CONF_PSS));	/* 0x0400 enables joystick */
  		printk(KERN_INFO "PSS: joystick enabled.\n");
  	}
  	else
  	{
  		printk(KERN_INFO "PSS: joystick port not enabled.\n");
  	}
  
  	/* Configure CDROM port */
  
  	if (pss_cdrom_port == -1) {	/* If cdrom port enablation wasn't requested */
  		printk(KERN_INFO "PSS: CDROM port not enabled.\n");
  	} else if (!request_region(pss_cdrom_port, 2, "PSS CDROM")) {
  		pss_cdrom_port = -1;
  		printk(KERN_ERR "PSS: CDROM I/O port conflict.\n");
  	} else {
  		set_io_base(devc, CONF_CDROM, pss_cdrom_port);
  		printk(KERN_INFO "PSS: CDROM I/O port set to 0x%x.\n", pss_cdrom_port);
  	}
  }
  
  static int __init attach_pss(struct address_info *hw_config)
  {
  	unsigned short  id;
  	char tmp[100];
  
  	devc->base = hw_config->io_base;
  	devc->irq = hw_config->irq;
  	devc->dma = hw_config->dma;
  	devc->osp = hw_config->osp;
  	devc->ad_mixer_dev = NO_WSS_MIXER;
  
  	if (!probe_pss(hw_config))
  		return 0;
  
  	id = inw(REG(PSS_ID)) & 0x00ff;
  
  	/*
  	 * Disable all emulations. Will be enabled later (if required).
  	 */
  	 
  	disable_all_emulations();
  
  #ifdef YOU_REALLY_WANT_TO_ALLOCATE_THESE_RESOURCES
  	if (sound_alloc_dma(hw_config->dma, "PSS"))
  	{
  		printk("pss.c: Can't allocate DMA channel.\n");
  		release_region(hw_config->io_base, 0x10);
  		release_region(hw_config->io_base+0x10, 0x9);
  		return 0;
  	}
  	if (!set_irq(devc, CONF_PSS, devc->irq))
  	{
  		printk("PSS: IRQ allocation error.\n");
  		release_region(hw_config->io_base, 0x10);
  		release_region(hw_config->io_base+0x10, 0x9);
  		return 0;
  	}
  	if (!set_dma(devc, CONF_PSS, devc->dma))
  	{
  		printk(KERN_ERR "PSS: DMA allocation error\n");
  		release_region(hw_config->io_base, 0x10);
  		release_region(hw_config->io_base+0x10, 0x9);
  		return 0;
  	}
  #endif
  
  	configure_nonsound_components();
  	pss_initialized = 1;
  	sprintf(tmp, "ECHO-PSS  Rev. %d", id);
  	conf_printf(tmp, hw_config);
  	return 1;
  }
  
  static int __init probe_pss_mpu(struct address_info *hw_config)
  {
  	struct resource *ports;
  	int timeout;
  
  	if (!pss_initialized)
  		return 0;
  
  	ports = request_region(hw_config->io_base, 2, "mpu401");
  
  	if (!ports) {
  		printk(KERN_ERR "PSS: MPU I/O port conflict\n");
  		return 0;
  	}
  	set_io_base(devc, CONF_MIDI, hw_config->io_base);
  	if (!set_irq(devc, CONF_MIDI, hw_config->irq)) {
  		printk(KERN_ERR "PSS: MIDI IRQ allocation error.\n");
  		goto fail;
  	}
  	if (!pss_synthLen) {
  		printk(KERN_ERR "PSS: Can't enable MPU. MIDI synth microcode not available.\n");
  		goto fail;
  	}
  	if (!pss_download_boot(devc, pss_synth, pss_synthLen, CPF_FIRST | CPF_LAST)) {
  		printk(KERN_ERR "PSS: Unable to load MIDI synth microcode to DSP.\n");
  		goto fail;
  	}
  
  	/*
  	 * Finally wait until the DSP algorithm has initialized itself and
  	 * deactivates receive interrupt.
  	 */
  
  	for (timeout = 900000; timeout > 0; timeout--)
  	{
  		if ((inb(hw_config->io_base + 1) & 0x80) == 0)	/* Input data avail */
  			inb(hw_config->io_base);	/* Discard it */
  		else
  			break;	/* No more input */
  	}
  
  	if (!probe_mpu401(hw_config, ports))
  		goto fail;
  
  	attach_mpu401(hw_config, THIS_MODULE);	/* Slot 1 */
  	if (hw_config->slots[1] != -1)	/* The MPU driver installed itself */
  		midi_devs[hw_config->slots[1]]->coproc = &pss_coproc_operations;
  	return 1;
  fail:
  	release_region(hw_config->io_base, 2);
  	return 0;
  }
  
  static int pss_coproc_open(void *dev_info, int sub_device)
  {
  	switch (sub_device)
  	{
  		case COPR_MIDI:
  			if (pss_synthLen == 0)
  			{
  				printk(KERN_ERR "PSS: MIDI synth microcode not available.\n");
  				return -EIO;
  			}
  			if (nonstandard_microcode)
  				if (!pss_download_boot(devc, pss_synth, pss_synthLen, CPF_FIRST | CPF_LAST))
  			{
  				printk(KERN_ERR "PSS: Unable to load MIDI synth microcode to DSP.\n");
  				return -EIO;
  			}
  			nonstandard_microcode = 0;
  			break;
  
  		default:
  			break;
  	}
  	return 0;
  }
  
  static void pss_coproc_close(void *dev_info, int sub_device)
  {
  	return;
  }
  
  static void pss_coproc_reset(void *dev_info)
  {
  	if (pss_synthLen)
  		if (!pss_download_boot(devc, pss_synth, pss_synthLen, CPF_FIRST | CPF_LAST))
  		{
  			printk(KERN_ERR "PSS: Unable to load MIDI synth microcode to DSP.\n");
  		}
  	nonstandard_microcode = 0;
  }
  
  static int download_boot_block(void *dev_info, copr_buffer * buf)
  {
  	if (buf->len <= 0 || buf->len > sizeof(buf->data))
  		return -EINVAL;
  
  	if (!pss_download_boot(devc, buf->data, buf->len, buf->flags))
  	{
  		printk(KERN_ERR "PSS: Unable to load microcode block to DSP.\n");
  		return -EIO;
  	}
  	nonstandard_microcode = 1;	/* The MIDI microcode has been overwritten */
  	return 0;
  }
  
  static int pss_coproc_ioctl(void *dev_info, unsigned int cmd, void __user *arg, int local)
  {
  	copr_buffer *buf;
  	copr_msg *mbuf;
  	copr_debug_buf dbuf;
  	unsigned short tmp;
  	unsigned long flags;
  	unsigned short *data;
  	int i, err;
  	/* printk( "PSS coproc ioctl %x %x %d\n",  cmd,  arg,  local); */
  	
  	switch (cmd) 
  	{
  		case SNDCTL_COPR_RESET:
  			pss_coproc_reset(dev_info);
  			return 0;
  
  		case SNDCTL_COPR_LOAD:
  			buf = vmalloc(sizeof(copr_buffer));
  			if (buf == NULL)
  				return -ENOSPC;
  			if (copy_from_user(buf, arg, sizeof(copr_buffer))) {
  				vfree(buf);
  				return -EFAULT;
  			}
  			err = download_boot_block(dev_info, buf);
  			vfree(buf);
  			return err;
  		
  		case SNDCTL_COPR_SENDMSG:
  			mbuf = vmalloc(sizeof(copr_msg));
  			if (mbuf == NULL)
  				return -ENOSPC;
  			if (copy_from_user(mbuf, arg, sizeof(copr_msg))) {
  				vfree(mbuf);
  				return -EFAULT;
  			}
  			data = (unsigned short *)(mbuf->data);
  			spin_lock_irqsave(&lock, flags);
  			for (i = 0; i < mbuf->len; i++) {
  				if (!pss_put_dspword(devc, *data++)) {
  					spin_unlock_irqrestore(&lock,flags);
  					mbuf->len = i;	/* feed back number of WORDs sent */
  					err = copy_to_user(arg, mbuf, sizeof(copr_msg));
  					vfree(mbuf);
  					return err ? -EFAULT : -EIO;
  				}
  			}
  			spin_unlock_irqrestore(&lock,flags);
  			vfree(mbuf);
  			return 0;
  
  		case SNDCTL_COPR_RCVMSG:
  			err = 0;
  			mbuf = vmalloc(sizeof(copr_msg));
  			if (mbuf == NULL)
  				return -ENOSPC;
  			data = (unsigned short *)mbuf->data;
  			spin_lock_irqsave(&lock, flags);
  			for (i = 0; i < sizeof(mbuf->data)/sizeof(unsigned short); i++) {
  				mbuf->len = i;	/* feed back number of WORDs read */
  				if (!pss_get_dspword(devc, data++)) {
  					if (i == 0)
  						err = -EIO;
  					break;
  				}
  			}
  			spin_unlock_irqrestore(&lock,flags);
  			if (copy_to_user(arg, mbuf, sizeof(copr_msg)))
  				err = -EFAULT;
  			vfree(mbuf);
  			return err;
  		
  		case SNDCTL_COPR_RDATA:
  			if (copy_from_user(&dbuf, arg, sizeof(dbuf)))
  				return -EFAULT;
  			spin_lock_irqsave(&lock, flags);
  			if (!pss_put_dspword(devc, 0x00d0)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			if (!pss_put_dspword(devc, (unsigned short)(dbuf.parm1 & 0xffff))) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			if (!pss_get_dspword(devc, &tmp)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			dbuf.parm1 = tmp;
  			spin_unlock_irqrestore(&lock,flags);
  			if (copy_to_user(arg, &dbuf, sizeof(dbuf)))
  				return -EFAULT;
  			return 0;
  		
  		case SNDCTL_COPR_WDATA:
  			if (copy_from_user(&dbuf, arg, sizeof(dbuf)))
  				return -EFAULT;
  			spin_lock_irqsave(&lock, flags);
  			if (!pss_put_dspword(devc, 0x00d1)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			if (!pss_put_dspword(devc, (unsigned short) (dbuf.parm1 & 0xffff))) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			tmp = (unsigned int)dbuf.parm2 & 0xffff;
  			if (!pss_put_dspword(devc, tmp)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			spin_unlock_irqrestore(&lock,flags);
  			return 0;
  		
  		case SNDCTL_COPR_WCODE:
  			if (copy_from_user(&dbuf, arg, sizeof(dbuf)))
  				return -EFAULT;
  			spin_lock_irqsave(&lock, flags);
  			if (!pss_put_dspword(devc, 0x00d3)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			if (!pss_put_dspword(devc, (unsigned short)(dbuf.parm1 & 0xffff))) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			tmp = (unsigned int)dbuf.parm2 & 0x00ff;
  			if (!pss_put_dspword(devc, tmp)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			tmp = ((unsigned int)dbuf.parm2 >> 8) & 0xffff;
  			if (!pss_put_dspword(devc, tmp)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			spin_unlock_irqrestore(&lock,flags);
  			return 0;
  		
  		case SNDCTL_COPR_RCODE:
  			if (copy_from_user(&dbuf, arg, sizeof(dbuf)))
  				return -EFAULT;
  			spin_lock_irqsave(&lock, flags);
  			if (!pss_put_dspword(devc, 0x00d2)) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			if (!pss_put_dspword(devc, (unsigned short)(dbuf.parm1 & 0xffff))) {
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			if (!pss_get_dspword(devc, &tmp)) { /* Read MSB */
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			dbuf.parm1 = tmp << 8;
  			if (!pss_get_dspword(devc, &tmp)) { /* Read LSB */
  				spin_unlock_irqrestore(&lock,flags);
  				return -EIO;
  			}
  			dbuf.parm1 |= tmp & 0x00ff;
  			spin_unlock_irqrestore(&lock,flags);
  			if (copy_to_user(arg, &dbuf, sizeof(dbuf)))
  				return -EFAULT;
  			return 0;
  
  		default:
  			return -EINVAL;
  	}
  	return -EINVAL;
  }
  
  static coproc_operations pss_coproc_operations =
  {
  	"ADSP-2115",
  	THIS_MODULE,
  	pss_coproc_open,
  	pss_coproc_close,
  	pss_coproc_ioctl,
  	pss_coproc_reset,
  	&pss_data
  };
  
  static int __init probe_pss_mss(struct address_info *hw_config)
  {
  	volatile int timeout;
  	struct resource *ports;
  	int        my_mix = -999;	/* gcc shut up */
  
  	if (!pss_initialized)
  		return 0;
  
  	if (!request_region(hw_config->io_base, 4, "WSS config")) {
  		printk(KERN_ERR "PSS: WSS I/O port conflicts.\n");
  		return 0;
  	}
  	ports = request_region(hw_config->io_base + 4, 4, "ad1848");
  	if (!ports) {
  		printk(KERN_ERR "PSS: WSS I/O port conflicts.\n");
  		release_region(hw_config->io_base, 4);
  		return 0;
  	}
  	set_io_base(devc, CONF_WSS, hw_config->io_base);
  	if (!set_irq(devc, CONF_WSS, hw_config->irq)) {
  		printk("PSS: WSS IRQ allocation error.\n");
  		goto fail;
  	}
  	if (!set_dma(devc, CONF_WSS, hw_config->dma)) {
  		printk(KERN_ERR "PSS: WSS DMA allocation error\n");
  		goto fail;
  	}
  	/*
  	 * For some reason the card returns 0xff in the WSS status register
  	 * immediately after boot. Probably MIDI+SB emulation algorithm
  	 * downloaded to the ADSP2115 spends some time initializing the card.
  	 * Let's try to wait until it finishes this task.
  	 */
  	for (timeout = 0; timeout < 100000 && (inb(hw_config->io_base + WSS_INDEX) &
  	  WSS_INITIALIZING); timeout++)
  		;
  
  	outb((0x0b), hw_config->io_base + WSS_INDEX);	/* Required by some cards */
  
  	for (timeout = 0; (inb(hw_config->io_base + WSS_DATA) & WSS_AUTOCALIBRATION) &&
  	  (timeout < 100000); timeout++)
  		;
  
  	if (!probe_ms_sound(hw_config, ports))
  		goto fail;
  
  	devc->ad_mixer_dev = NO_WSS_MIXER;
  	if (pss_mixer) 
  	{
  		if ((my_mix = sound_install_mixer (MIXER_DRIVER_VERSION,
  			"PSS-SPEAKERS and AD1848 (through MSS audio codec)",
  			&pss_mixer_operations,
  			sizeof (struct mixer_operations),
  			devc)) < 0) 
  		{
  			printk(KERN_ERR "Could not install PSS mixer\n");
  			goto fail;
  		}
  	}
  	pss_mixer_reset(devc);
  	attach_ms_sound(hw_config, ports, THIS_MODULE);	/* Slot 0 */
  
  	if (hw_config->slots[0] != -1)
  	{
  		/* The MSS driver installed itself */
  		audio_devs[hw_config->slots[0]]->coproc = &pss_coproc_operations;
  		if (pss_mixer && (num_mixers == (my_mix + 2)))
  		{
  			/* The MSS mixer installed */
  			devc->ad_mixer_dev = audio_devs[hw_config->slots[0]]->mixer_dev;
  		}
  	}
  	return 1;
  fail:
  	release_region(hw_config->io_base + 4, 4);
  	release_region(hw_config->io_base, 4);
  	return 0;
  }
  
  static inline void __exit unload_pss(struct address_info *hw_config)
  {
  	release_region(hw_config->io_base, 0x10);
  	release_region(hw_config->io_base+0x10, 0x9);
  }
  
  static inline void __exit unload_pss_mpu(struct address_info *hw_config)
  {
  	unload_mpu401(hw_config);
  }
  
  static inline void __exit unload_pss_mss(struct address_info *hw_config)
  {
  	unload_ms_sound(hw_config);
  }
  
  
  static struct address_info cfg;
  static struct address_info cfg2;
  static struct address_info cfg_mpu;
  
  static int pss_io __initdata	= -1;
  static int mss_io __initdata	= -1;
  static int mss_irq __initdata	= -1;
  static int mss_dma __initdata	= -1;
  static int mpu_io __initdata	= -1;
  static int mpu_irq __initdata	= -1;
  static bool pss_no_sound = 0;	/* Just configure non-sound components */
  static bool pss_keep_settings  = 1;	/* Keep hardware settings at module exit */
  static char *pss_firmware = "/etc/sound/pss_synth";
  
  module_param(pss_io, int, 0);
  MODULE_PARM_DESC(pss_io, "Set i/o base of PSS card (probably 0x220 or 0x240)");
  module_param(mss_io, int, 0);
  MODULE_PARM_DESC(mss_io, "Set WSS (audio) i/o base (0x530, 0x604, 0xE80, 0xF40, or other. Address must end in 0 or 4 and must be from 0x100 to 0xFF4)");
  module_param(mss_irq, int, 0);
  MODULE_PARM_DESC(mss_irq, "Set WSS (audio) IRQ (3, 5, 7, 9, 10, 11, 12)");
  module_param(mss_dma, int, 0);
  MODULE_PARM_DESC(mss_dma, "Set WSS (audio) DMA (0, 1, 3)");
  module_param(mpu_io, int, 0);
  MODULE_PARM_DESC(mpu_io, "Set MIDI i/o base (0x330 or other. Address must be on 4 location boundaries and must be from 0x100 to 0xFFC)");
  module_param(mpu_irq, int, 0);
  MODULE_PARM_DESC(mpu_irq, "Set MIDI IRQ (3, 5, 7, 9, 10, 11, 12)");
  module_param(pss_cdrom_port, int, 0);
  MODULE_PARM_DESC(pss_cdrom_port, "Set the PSS CDROM port i/o base (0x340 or other)");
  module_param(pss_enable_joystick, bool, 0);
  MODULE_PARM_DESC(pss_enable_joystick, "Enables the PSS joystick port (1 to enable, 0 to disable)");
  module_param(pss_no_sound, bool, 0);
  MODULE_PARM_DESC(pss_no_sound, "Configure sound compoents (0 - no, 1 - yes)");
  module_param(pss_keep_settings, bool, 0);
  MODULE_PARM_DESC(pss_keep_settings, "Keep hardware setting at driver unloading (0 - no, 1 - yes)");
  module_param(pss_firmware, charp, 0);
  MODULE_PARM_DESC(pss_firmware, "Location of the firmware file (default - /etc/sound/pss_synth)");
  module_param(pss_mixer, bool, 0);
  MODULE_PARM_DESC(pss_mixer, "Enable (1) or disable (0) PSS mixer (controlling of output volume, bass, treble, synth volume). The mixer is not available on all PSS cards.");
  MODULE_AUTHOR("Hannu Savolainen, Vladimir Michl");
  MODULE_DESCRIPTION("Module for PSS sound cards (based on AD1848, ADSP-2115 and ESC614). This module includes control of output amplifier and synth volume of the Beethoven ADSP-16 card (this may work with other PSS cards).");
  MODULE_LICENSE("GPL");
  
  
  static int fw_load = 0;
  static int pssmpu = 0, pssmss = 0;
  
  /*
   *    Load a PSS sound card module
   */
  
  static int __init init_pss(void)
  {
  
  	if(pss_no_sound)		/* If configuring only nonsound components */
  	{
  		cfg.io_base = pss_io;
  		if(!probe_pss(&cfg))
  			return -ENODEV;
  		printk(KERN_INFO "ECHO-PSS  Rev. %d\n", inw(REG(PSS_ID)) & 0x00ff);
  		printk(KERN_INFO "PSS: loading in no sound mode.\n");
  		disable_all_emulations();
  		configure_nonsound_components();
  		release_region(pss_io, 0x10);
  		release_region(pss_io + 0x10, 0x9);
  		return 0;
  	}
  
  	cfg.io_base = pss_io;
  
  	cfg2.io_base = mss_io;
  	cfg2.irq = mss_irq;
  	cfg2.dma = mss_dma;
  
  	cfg_mpu.io_base = mpu_io;
  	cfg_mpu.irq = mpu_irq;
  
  	if (cfg.io_base == -1 || cfg2.io_base == -1 || cfg2.irq == -1 || cfg.dma == -1) {
  		printk(KERN_INFO "pss: mss_io, mss_dma, mss_irq and pss_io must be set.\n");
  		return -EINVAL;
  	}
  
  	if (!pss_synth) {
  		fw_load = 1;
  		pss_synthLen = mod_firmware_load(pss_firmware, (void *) &pss_synth);
  	}
  	if (!attach_pss(&cfg))
  		return -ENODEV;
  	/*
  	 *    Attach stuff
  	 */
  	if (probe_pss_mpu(&cfg_mpu))
  		pssmpu = 1;
  
  	if (probe_pss_mss(&cfg2))
  		pssmss = 1;
  
  	return 0;
  }
  
  static void __exit cleanup_pss(void)
  {
  	if(!pss_no_sound)
  	{
  		if (fw_load)
  			vfree(pss_synth);
  		if(pssmss)
  			unload_pss_mss(&cfg2);
  		if(pssmpu)
  			unload_pss_mpu(&cfg_mpu);
  		unload_pss(&cfg);
  	} else if (pss_cdrom_port != -1)
  		release_region(pss_cdrom_port, 2);
  
  	if(!pss_keep_settings)	/* Keep hardware settings if asked */
  	{
  		disable_all_emulations();
  		printk(KERN_INFO "Resetting PSS sound card configurations.\n");
  	}
  }
  
  module_init(init_pss);
  module_exit(cleanup_pss);
  
  #ifndef MODULE
  static int __init setup_pss(char *str)
  {
  	/* io, mss_io, mss_irq, mss_dma, mpu_io, mpu_irq */
  	int ints[7];
  	
  	str = get_options(str, ARRAY_SIZE(ints), ints);
  
  	pss_io	= ints[1];
  	mss_io	= ints[2];
  	mss_irq	= ints[3];
  	mss_dma	= ints[4];
  	mpu_io	= ints[5];
  	mpu_irq	= ints[6];
  
  	return 1;
  }
  
  __setup("pss=", setup_pss);
  #endif
  