xref: /openbmc/linux/include/sound/mpu401.h (revision cfbb9be8)
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@perex.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 <sound/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_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 #define MPU401_INFO_IRQ_HOOK	(1 << 5)	/* mpu401 irq handler is called
54 						   from driver irq handler */
55 #define MPU401_INFO_NO_ACK	(1 << 6)	/* No ACK cmd needed */
56 #define MPU401_INFO_USE_TIMER	(1 << 15)	/* internal */
57 
58 #define MPU401_MODE_BIT_INPUT		0
59 #define MPU401_MODE_BIT_OUTPUT		1
60 #define MPU401_MODE_BIT_INPUT_TRIGGER	2
61 #define MPU401_MODE_BIT_OUTPUT_TRIGGER	3
62 
63 #define MPU401_MODE_INPUT		(1<<MPU401_MODE_BIT_INPUT)
64 #define MPU401_MODE_OUTPUT		(1<<MPU401_MODE_BIT_OUTPUT)
65 #define MPU401_MODE_INPUT_TRIGGER	(1<<MPU401_MODE_BIT_INPUT_TRIGGER)
66 #define MPU401_MODE_OUTPUT_TRIGGER	(1<<MPU401_MODE_BIT_OUTPUT_TRIGGER)
67 
68 #define MPU401_MODE_INPUT_TIMER		(1<<0)
69 #define MPU401_MODE_OUTPUT_TIMER	(1<<1)
70 
71 struct snd_mpu401 {
72 	struct snd_rawmidi *rmidi;
73 
74 	unsigned short hardware;	/* MPU401_HW_XXXX */
75 	unsigned int info_flags;	/* MPU401_INFO_XXX */
76 	unsigned long port;		/* base port of MPU-401 chip */
77 	unsigned long cport;		/* port + 1 (usually) */
78 	struct resource *res;		/* port resource */
79 	int irq;			/* IRQ number of MPU-401 chip */
80 
81 	unsigned long mode;		/* MPU401_MODE_XXXX */
82 	int timer_invoked;
83 
84 	int (*open_input) (struct snd_mpu401 * mpu);
85 	void (*close_input) (struct snd_mpu401 * mpu);
86 	int (*open_output) (struct snd_mpu401 * mpu);
87 	void (*close_output) (struct snd_mpu401 * mpu);
88 	void *private_data;
89 
90 	struct snd_rawmidi_substream *substream_input;
91 	struct snd_rawmidi_substream *substream_output;
92 
93 	spinlock_t input_lock;
94 	spinlock_t output_lock;
95 	spinlock_t timer_lock;
96 
97 	struct timer_list timer;
98 
99 	void (*write) (struct snd_mpu401 * mpu, unsigned char data, unsigned long addr);
100 	unsigned char (*read) (struct snd_mpu401 *mpu, unsigned long addr);
101 };
102 
103 /* I/O ports */
104 
105 #define MPU401C(mpu) (mpu)->cport
106 #define MPU401D(mpu) (mpu)->port
107 
108 /*
109  * control register bits
110  */
111 /* read MPU401C() */
112 #define MPU401_RX_EMPTY		0x80
113 #define MPU401_TX_FULL		0x40
114 
115 /* write MPU401C() */
116 #define MPU401_RESET		0xff
117 #define MPU401_ENTER_UART	0x3f
118 
119 /* read MPU401D() */
120 #define MPU401_ACK		0xfe
121 
122 
123 /*
124 
125  */
126 
127 irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id);
128 irqreturn_t snd_mpu401_uart_interrupt_tx(int irq, void *dev_id);
129 
130 int snd_mpu401_uart_new(struct snd_card *card,
131 			int device,
132 			unsigned short hardware,
133 			unsigned long port,
134 			unsigned int info_flags,
135 			int irq,
136 			struct snd_rawmidi ** rrawmidi);
137 
138 #endif /* __SOUND_MPU401_H */
139