xref: /linux/include/sound/mpu401.h (revision 4bedea94545165364618d403d03b61d797acba0b)
1 #ifndef __SOUND_MPU401_H
2 #define __SOUND_MPU401_H
3 
4 /*
5  *  Header file for MPU-401 and compatible cards
6  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
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 
48 #define MPU401_MODE_BIT_INPUT		0
49 #define MPU401_MODE_BIT_OUTPUT		1
50 #define MPU401_MODE_BIT_INPUT_TRIGGER	2
51 #define MPU401_MODE_BIT_OUTPUT_TRIGGER	3
52 
53 #define MPU401_MODE_INPUT		(1<<MPU401_MODE_BIT_INPUT)
54 #define MPU401_MODE_OUTPUT		(1<<MPU401_MODE_BIT_OUTPUT)
55 #define MPU401_MODE_INPUT_TRIGGER	(1<<MPU401_MODE_BIT_INPUT_TRIGGER)
56 #define MPU401_MODE_OUTPUT_TRIGGER	(1<<MPU401_MODE_BIT_OUTPUT_TRIGGER)
57 
58 #define MPU401_MODE_INPUT_TIMER		(1<<0)
59 #define MPU401_MODE_OUTPUT_TIMER	(1<<1)
60 
61 typedef struct _snd_mpu401 mpu401_t;
62 
63 struct _snd_mpu401 {
64 	snd_rawmidi_t *rmidi;
65 
66 	unsigned short hardware;	/* MPU401_HW_XXXX */
67 	unsigned long port;		/* base port of MPU-401 chip */
68 	unsigned long cport;		/* port + 1 (usually) */
69 	struct resource *res;		/* port resource */
70 	int irq;			/* IRQ number of MPU-401 chip (-1 = poll) */
71 	int irq_flags;
72 
73 	unsigned long mode;		/* MPU401_MODE_XXXX */
74 	int timer_invoked;
75 
76 	int (*open_input) (mpu401_t * mpu);
77 	void (*close_input) (mpu401_t * mpu);
78 	int (*open_output) (mpu401_t * mpu);
79 	void (*close_output) (mpu401_t * mpu);
80 	void *private_data;
81 
82 	snd_rawmidi_substream_t *substream_input;
83 	snd_rawmidi_substream_t *substream_output;
84 
85 	spinlock_t input_lock;
86 	spinlock_t output_lock;
87 	spinlock_t timer_lock;
88 
89 	struct timer_list timer;
90 
91 	void (*write) (mpu401_t * mpu, unsigned char data, unsigned long addr);
92 	unsigned char (*read) (mpu401_t * mpu, unsigned long addr);
93 };
94 
95 /* I/O ports */
96 
97 #define MPU401C(mpu) (mpu)->cport
98 #define MPU401D(mpu) (mpu)->port
99 
100 /*
101 
102  */
103 
104 irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id, struct pt_regs *regs);
105 
106 int snd_mpu401_uart_new(snd_card_t * card,
107 			int device,
108 			unsigned short hardware,
109 			unsigned long port,
110 			int integrated,
111 			int irq,
112 			int irq_flags,
113 			snd_rawmidi_t ** rrawmidi);
114 
115 #endif /* __SOUND_MPU401_H */
116