[net-next-2.6.git] / include / sound / mpu401.h

#ifndef __SOUND_MPU401_H
#define __SOUND_MPU401_H

/*
 *  Header file for MPU-401 and compatible cards
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 *
 *
 *   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include "rawmidi.h"
#include <linux/interrupt.h>

#define MPU401_HW_MPU401		1	/* native MPU401 */
#define MPU401_HW_SB			2	/* SoundBlaster MPU-401 UART */
#define MPU401_HW_ES1688		3	/* AudioDrive ES1688 MPU-401 UART */
#define MPU401_HW_OPL3SA2		4	/* Yamaha OPL3-SA2 */
#define MPU401_HW_SONICVIBES		5	/* S3 SonicVibes */
#define MPU401_HW_CS4232		6	/* CS4232 */
#define MPU401_HW_ES18XX		7	/* AudioDrive ES18XX MPU-401 UART */
#define MPU401_HW_FM801			8	/* ForteMedia FM801 */
#define MPU401_HW_TRID4DWAVE		9	/* Trident 4DWave */
#define MPU401_HW_AZT2320		10	/* Aztech AZT2320 */
#define MPU401_HW_ALS100		11	/* Avance Logic ALS100 */
#define MPU401_HW_ICE1712		12	/* Envy24 */
#define MPU401_HW_VIA686A		13	/* VIA 82C686A */
#define MPU401_HW_YMFPCI		14	/* YMF DS-XG PCI */
#define MPU401_HW_CMIPCI		15	/* CMIPCI MPU-401 UART */
#define MPU401_HW_ALS4000		16	/* Avance Logic ALS4000 */
#define MPU401_HW_INTEL8X0		17	/* Intel8x0 driver */
#define MPU401_HW_PC98II		18	/* Roland PC98II */
#define MPU401_HW_AUREAL		19	/* Aureal Vortex */

#define MPU401_INFO_INPUT	(1 << 0)	/* input stream */
#define MPU401_INFO_OUTPUT	(1 << 1)	/* output stream */
#define MPU401_INFO_INTEGRATED	(1 << 2)	/* integrated h/w port */
#define MPU401_INFO_MMIO	(1 << 3)	/* MMIO access */
#define MPU401_INFO_TX_IRQ	(1 << 4)	/* independent TX irq */

#define MPU401_MODE_BIT_INPUT		0
#define MPU401_MODE_BIT_OUTPUT		1
#define MPU401_MODE_BIT_INPUT_TRIGGER	2
#define MPU401_MODE_BIT_OUTPUT_TRIGGER	3

#define MPU401_MODE_INPUT		(1<<MPU401_MODE_BIT_INPUT)
#define MPU401_MODE_OUTPUT		(1<<MPU401_MODE_BIT_OUTPUT)
#define MPU401_MODE_INPUT_TRIGGER	(1<<MPU401_MODE_BIT_INPUT_TRIGGER)
#define MPU401_MODE_OUTPUT_TRIGGER	(1<<MPU401_MODE_BIT_OUTPUT_TRIGGER)

#define MPU401_MODE_INPUT_TIMER		(1<<0)
#define MPU401_MODE_OUTPUT_TIMER	(1<<1)

struct snd_mpu401 {
	struct snd_rawmidi *rmidi;

	unsigned short hardware;	/* MPU401_HW_XXXX */
	unsigned int info_flags;	/* MPU401_INFO_XXX */
	unsigned long port;		/* base port of MPU-401 chip */
	unsigned long cport;		/* port + 1 (usually) */
	struct resource *res;		/* port resource */
	int irq;			/* IRQ number of MPU-401 chip (-1 = poll) */
	int irq_flags;

	unsigned long mode;		/* MPU401_MODE_XXXX */
	int timer_invoked;

	int (*open_input) (struct snd_mpu401 * mpu);
	void (*close_input) (struct snd_mpu401 * mpu);
	int (*open_output) (struct snd_mpu401 * mpu);
	void (*close_output) (struct snd_mpu401 * mpu);
	void *private_data;

	struct snd_rawmidi_substream *substream_input;
	struct snd_rawmidi_substream *substream_output;

	spinlock_t input_lock;
	spinlock_t output_lock;
	spinlock_t timer_lock;
	
	struct timer_list timer;

	void (*write) (struct snd_mpu401 * mpu, unsigned char data, unsigned long addr);
	unsigned char (*read) (struct snd_mpu401 *mpu, unsigned long addr);
};

/* I/O ports */

#define MPU401C(mpu) (mpu)->cport
#define MPU401D(mpu) (mpu)->port

/*

 */

irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id);
irqreturn_t snd_mpu401_uart_interrupt_tx(int irq, void *dev_id);

int snd_mpu401_uart_new(struct snd_card *card,
			int device,
			unsigned short hardware,
			unsigned long port,
			unsigned int info_flags,
			int irq,
			int irq_flags,
			struct snd_rawmidi ** rrawmidi);

#endif /* __SOUND_MPU401_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __SOUND_MPU401_H
	2	#define __SOUND_MPU401_H
	3
	4	/*
	5	* Header file for MPU-401 and compatible cards
c1017a4c	6	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	7	*
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*
	23	*/
	24
	25	#include "rawmidi.h"
	26	#include <linux/interrupt.h>
	27
	28	#define MPU401_HW_MPU401 1 /* native MPU401 */
	29	#define MPU401_HW_SB 2 /* SoundBlaster MPU-401 UART */
	30	#define MPU401_HW_ES1688 3 /* AudioDrive ES1688 MPU-401 UART */
	31	#define MPU401_HW_OPL3SA2 4 /* Yamaha OPL3-SA2 */
	32	#define MPU401_HW_SONICVIBES 5 /* S3 SonicVibes */
	33	#define MPU401_HW_CS4232 6 /* CS4232 */
	34	#define MPU401_HW_ES18XX 7 /* AudioDrive ES18XX MPU-401 UART */
	35	#define MPU401_HW_FM801 8 /* ForteMedia FM801 */
	36	#define MPU401_HW_TRID4DWAVE 9 /* Trident 4DWave */
	37	#define MPU401_HW_AZT2320 10 /* Aztech AZT2320 */
	38	#define MPU401_HW_ALS100 11 /* Avance Logic ALS100 */
	39	#define MPU401_HW_ICE1712 12 /* Envy24 */
	40	#define MPU401_HW_VIA686A 13 /* VIA 82C686A */
	41	#define MPU401_HW_YMFPCI 14 /* YMF DS-XG PCI */
	42	#define MPU401_HW_CMIPCI 15 /* CMIPCI MPU-401 UART */
	43	#define MPU401_HW_ALS4000 16 /* Avance Logic ALS4000 */
	44	#define MPU401_HW_INTEL8X0 17 /* Intel8x0 driver */
	45	#define MPU401_HW_PC98II 18 /* Roland PC98II */
	46	#define MPU401_HW_AUREAL 19 /* Aureal Vortex */
	47
302e4c2f TI	48	#define MPU401_INFO_INPUT (1 << 0) /* input stream */
	49	#define MPU401_INFO_OUTPUT (1 << 1) /* output stream */
	50	#define MPU401_INFO_INTEGRATED (1 << 2) /* integrated h/w port */
	51	#define MPU401_INFO_MMIO (1 << 3) /* MMIO access */
	52	#define MPU401_INFO_TX_IRQ (1 << 4) /* independent TX irq */
	53
1da177e4 LT	54	#define MPU401_MODE_BIT_INPUT 0
	55	#define MPU401_MODE_BIT_OUTPUT 1
	56	#define MPU401_MODE_BIT_INPUT_TRIGGER 2
	57	#define MPU401_MODE_BIT_OUTPUT_TRIGGER 3
	58
	59	#define MPU401_MODE_INPUT (1<<MPU401_MODE_BIT_INPUT)
	60	#define MPU401_MODE_OUTPUT (1<<MPU401_MODE_BIT_OUTPUT)
	61	#define MPU401_MODE_INPUT_TRIGGER (1<<MPU401_MODE_BIT_INPUT_TRIGGER)
	62	#define MPU401_MODE_OUTPUT_TRIGGER (1<<MPU401_MODE_BIT_OUTPUT_TRIGGER)
	63
	64	#define MPU401_MODE_INPUT_TIMER (1<<0)
	65	#define MPU401_MODE_OUTPUT_TIMER (1<<1)
	66
e1fad17b TI	67	struct snd_mpu401 {
e1fad17b TI	68	struct snd_rawmidi *rmidi;
1da177e4 LT	69
1da177e4 LT	70	unsigned short hardware; /* MPU401_HW_XXXX */
302e4c2f	71	unsigned int info_flags; /* MPU401_INFO_XXX */
1da177e4 LT	72	unsigned long port; /* base port of MPU-401 chip */
	73	unsigned long cport; /* port + 1 (usually) */
	74	struct resource res; / port resource */
	75	int irq; /* IRQ number of MPU-401 chip (-1 = poll) */
	76	int irq_flags;
	77
	78	unsigned long mode; /* MPU401_MODE_XXXX */
	79	int timer_invoked;
	80
e1fad17b TI	81	int (open_input) (struct snd_mpu401 mpu);
	82	void (close_input) (struct snd_mpu401 mpu);
	83	int (open_output) (struct snd_mpu401 mpu);
	84	void (close_output) (struct snd_mpu401 mpu);
1da177e4 LT	85	void *private_data;
1da177e4 LT	86
e1fad17b TI	87	struct snd_rawmidi_substream *substream_input;
e1fad17b TI	88	struct snd_rawmidi_substream *substream_output;
1da177e4 LT	89
	90	spinlock_t input_lock;
	91	spinlock_t output_lock;
	92	spinlock_t timer_lock;
	93
	94	struct timer_list timer;
	95
e1fad17b TI	96	void (write) (struct snd_mpu401 mpu, unsigned char data, unsigned long addr);
e1fad17b TI	97	unsigned char (read) (struct snd_mpu401 mpu, unsigned long addr);
1da177e4 LT	98	};
	99
	100	/* I/O ports */
	101
	102	#define MPU401C(mpu) (mpu)->cport
	103	#define MPU401D(mpu) (mpu)->port
	104
	105	/*
	106
	107	*/
	108
7d12e780 DH	109	irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id);
7d12e780 DH	110	irqreturn_t snd_mpu401_uart_interrupt_tx(int irq, void *dev_id);
1da177e4	111
e1fad17b	112	int snd_mpu401_uart_new(struct snd_card *card,
1da177e4 LT	113	int device,
	114	unsigned short hardware,
	115	unsigned long port,
302e4c2f	116	unsigned int info_flags,
1da177e4 LT	117	int irq,
1da177e4 LT	118	int irq_flags,
e1fad17b	119	struct snd_rawmidi ** rrawmidi);
1da177e4 LT	120
1da177e4 LT	121	#endif /* __SOUND_MPU401_H */