/*********************************************************************
   *
   * msnd.h
   *
   * Turtle Beach MultiSound Sound Card Driver for Linux
   *
   * Some parts of this header file were derived from the Turtle Beach
   * MultiSound Driver Development Kit.
   *
   * Copyright (C) 1998 Andrew Veliath
   * Copyright (C) 1993 Turtle Beach Systems, Inc.
   *
   * This program is free software; you can redistribute it and/or modify
   * it under the terms of the GNU General Public License as published by
   * the Free Software Foundation; either version 2 of the License, or
   * (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   *
   ********************************************************************/
  #ifndef __MSND_H
  #define __MSND_H
  
  #define VERSION			"0.8.3.1"
  
  #define DEFSAMPLERATE		DSP_DEFAULT_SPEED
  #define DEFSAMPLESIZE		AFMT_U8
  #define DEFCHANNELS		1
  
  #define DEFFIFOSIZE		128
  
  #define SNDCARD_MSND		38
  
  #define SRAM_BANK_SIZE		0x8000
  #define SRAM_CNTL_START		0x7F00
  
  #define DSP_BASE_ADDR		0x4000
  #define DSP_BANK_BASE		0x4000
  
  #define	HP_ICR			0x00
  #define	HP_CVR			0x01
  #define	HP_ISR			0x02
  #define	HP_IVR			0x03
  #define HP_NU			0x04
  #define HP_INFO			0x04
  #define	HP_TXH			0x05
  #define	HP_RXH			0x05
  #define	HP_TXM			0x06
  #define	HP_RXM			0x06
  #define	HP_TXL			0x07
  #define	HP_RXL			0x07
  
  #define HP_ICR_DEF		0x00
  #define HP_CVR_DEF		0x12
  #define HP_ISR_DEF		0x06
  #define HP_IVR_DEF		0x0f
  #define HP_NU_DEF		0x00
  
  #define	HP_IRQM			0x09
  
  #define	HPR_BLRC		0x08
  #define	HPR_SPR1		0x09
  #define	HPR_SPR2		0x0A
  #define	HPR_TCL0		0x0B
  #define	HPR_TCL1		0x0C
  #define	HPR_TCL2		0x0D
  #define	HPR_TCL3		0x0E
  #define	HPR_TCL4		0x0F
  
  #define	HPICR_INIT		0x80
  #define HPICR_HM1		0x40
  #define HPICR_HM0		0x20
  #define HPICR_HF1		0x10
  #define HPICR_HF0		0x08
  #define	HPICR_TREQ		0x02
  #define	HPICR_RREQ		0x01
  
  #define HPCVR_HC		0x80
  
  #define	HPISR_HREQ		0x80
  #define HPISR_DMA		0x40
  #define HPISR_HF3		0x10
  #define HPISR_HF2		0x08
  #define	HPISR_TRDY		0x04
  #define	HPISR_TXDE		0x02
  #define	HPISR_RXDF		0x01
  
  #define	HPIO_290		0
  #define	HPIO_260		1
  #define	HPIO_250		2
  #define	HPIO_240		3
  #define	HPIO_230		4
  #define	HPIO_220		5
  #define	HPIO_210		6
  #define	HPIO_3E0		7
  
  #define	HPMEM_NONE		0
  #define	HPMEM_B000		1
  #define	HPMEM_C800		2
  #define	HPMEM_D000		3
  #define	HPMEM_D400		4
  #define	HPMEM_D800		5
  #define	HPMEM_E000		6
  #define	HPMEM_E800		7
  
  #define	HPIRQ_NONE		0
  #define HPIRQ_5			1
  #define HPIRQ_7			2
  #define HPIRQ_9			3
  #define HPIRQ_10		4
  #define HPIRQ_11		5
  #define HPIRQ_12		6
  #define HPIRQ_15		7
  
  #define	HIMT_PLAY_DONE		0x00
  #define	HIMT_RECORD_DONE	0x01
  #define	HIMT_MIDI_EOS		0x02
  #define	HIMT_MIDI_OUT		0x03
  
  #define	HIMT_MIDI_IN_UCHAR	0x0E
  #define	HIMT_DSP		0x0F
  
  #define	HDEX_BASE	       	0x92
  #define	HDEX_PLAY_START		(0 + HDEX_BASE)
  #define	HDEX_PLAY_STOP		(1 + HDEX_BASE)
  #define	HDEX_PLAY_PAUSE		(2 + HDEX_BASE)
  #define	HDEX_PLAY_RESUME	(3 + HDEX_BASE)
  #define	HDEX_RECORD_START	(4 + HDEX_BASE)
  #define	HDEX_RECORD_STOP	(5 + HDEX_BASE)
  #define	HDEX_MIDI_IN_START 	(6 + HDEX_BASE)
  #define	HDEX_MIDI_IN_STOP	(7 + HDEX_BASE)
  #define	HDEX_MIDI_OUT_START	(8 + HDEX_BASE)
  #define	HDEX_MIDI_OUT_STOP	(9 + HDEX_BASE)
  #define	HDEX_AUX_REQ		(10 + HDEX_BASE)
  
  #define HIWORD(l)		((WORD)((((DWORD)(l)) >> 16) & 0xFFFF))
  #define LOWORD(l)		((WORD)(DWORD)(l))
  #define HIBYTE(w)		((BYTE)(((WORD)(w) >> 8) & 0xFF))
  #define LOBYTE(w)		((BYTE)(w))
  #define MAKELONG(low,hi)	((long)(((WORD)(low))|(((DWORD)((WORD)(hi)))<<16)))
  #define MAKEWORD(low,hi)	((WORD)(((BYTE)(low))|(((WORD)((BYTE)(hi)))<<8)))
  
  #define PCTODSP_OFFSET(w)	(USHORT)((w)/2)
  #define PCTODSP_BASED(w)	(USHORT)(((w)/2) + DSP_BASE_ADDR)
  #define DSPTOPC_BASED(w)	(((w) - DSP_BASE_ADDR) * 2)
  
  #ifdef SLOWIO
  #define msnd_outb			outb_p
  #define msnd_inb			inb_p
  #else
  #define msnd_outb			outb
  #define msnd_inb			inb
  #endif
  
  /* JobQueueStruct */
  #define JQS_wStart		0x00
  #define JQS_wSize		0x02
  #define JQS_wHead		0x04
  #define JQS_wTail		0x06
  #define JQS__size		0x08
  
  /* DAQueueDataStruct */
  #define DAQDS_wStart		0x00
  #define DAQDS_wSize		0x02
  #define DAQDS_wFormat		0x04
  #define DAQDS_wSampleSize	0x06
  #define DAQDS_wChannels		0x08
  #define DAQDS_wSampleRate	0x0A
  #define DAQDS_wIntMsg		0x0C
  #define DAQDS_wFlags		0x0E
  #define DAQDS__size		0x10
  
  typedef u8			BYTE;
  typedef u16			USHORT;
  typedef u16			WORD;
  typedef u32			DWORD;
  typedef void __iomem *		LPDAQD;
  
  /* Generic FIFO */
  typedef struct {
  	size_t n, len;
  	char *data;
  	int head, tail;
  } msnd_fifo;
  
  typedef struct multisound_dev {
  	/* Linux device info */
  	char *name;
  	int dsp_minor, mixer_minor;
  	int ext_midi_dev, hdr_midi_dev;
  
  	/* Hardware resources */
  	int io, numio;
  	int memid, irqid;
  	int irq, irq_ref;
  	unsigned char info;
  	void __iomem *base;
  
  	/* Motorola 56k DSP SMA */
  	void __iomem *SMA;
  	void __iomem *DAPQ, *DARQ, *MODQ, *MIDQ, *DSPQ;
  	void __iomem *pwDSPQData, *pwMIDQData, *pwMODQData;
  	int dspq_data_buff, dspq_buff_size;
  
  	/* State variables */
  	enum { msndClassic, msndPinnacle } type;
  	fmode_t mode;
  	unsigned long flags;
  #define F_RESETTING			0
  #define F_HAVEDIGITAL			1
  #define F_AUDIO_WRITE_INUSE		2
  #define F_WRITING			3
  #define F_WRITEBLOCK			4
  #define F_WRITEFLUSH			5
  #define F_AUDIO_READ_INUSE		6
  #define F_READING			7
  #define F_READBLOCK			8
  #define F_EXT_MIDI_INUSE		9
  #define F_HDR_MIDI_INUSE		10
  #define F_DISABLE_WRITE_NDELAY		11
  	wait_queue_head_t writeblock;
  	wait_queue_head_t readblock;
  	wait_queue_head_t writeflush;
  	spinlock_t lock;
  	int nresets;
  	unsigned long recsrc;
  	int left_levels[32];
  	int right_levels[32];
  	int mixer_mod_count;
  	int calibrate_signal;
  	int play_sample_size, play_sample_rate, play_channels;
  	int play_ndelay;
  	int rec_sample_size, rec_sample_rate, rec_channels;
  	int rec_ndelay;
  	BYTE bCurrentMidiPatch;
  
  	/* Digital audio FIFOs */
  	msnd_fifo DAPF, DARF;
  	int fifosize;
  	int last_playbank, last_recbank;
  
  	/* MIDI in callback */
  	void (*midi_in_interrupt)(struct multisound_dev *);
  } multisound_dev_t;
  
  #ifndef mdelay
  #  define mdelay(a)		udelay((a) * 1000)
  #endif
  
  int				msnd_register(multisound_dev_t *dev);
  void				msnd_unregister(multisound_dev_t *dev);
  
  void				msnd_init_queue(void __iomem *, int start, int size);
  
  void				msnd_fifo_init(msnd_fifo *f);
  void				msnd_fifo_free(msnd_fifo *f);
  int				msnd_fifo_alloc(msnd_fifo *f, size_t n);
  void				msnd_fifo_make_empty(msnd_fifo *f);
  int				msnd_fifo_write_io(msnd_fifo *f, char __iomem *buf, size_t len);
  int				msnd_fifo_read_io(msnd_fifo *f, char __iomem *buf, size_t len);
  int				msnd_fifo_write(msnd_fifo *f, const char *buf, size_t len);
  int				msnd_fifo_read(msnd_fifo *f, char *buf, size_t len);
  
  int				msnd_send_dsp_cmd(multisound_dev_t *dev, BYTE cmd);
  int				msnd_send_word(multisound_dev_t *dev, unsigned char high,
  					       unsigned char mid, unsigned char low);
  int				msnd_upload_host(multisound_dev_t *dev, char *bin, int len);
  int				msnd_enable_irq(multisound_dev_t *dev);
  int				msnd_disable_irq(multisound_dev_t *dev);
  
  #endif /* __MSND_H */