blob: d45218b44dfe590364acc94af00c039c32e15e30 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_MPU401_H
2#define __SOUND_MPU401_H
3
4/*
5 * Header file for MPU-401 and compatible cards
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02006 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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
Takashi Iwai302e4c22006-05-23 13:24:30 +020048#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#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
Takashi Iwaie1fad172005-11-17 14:12:45 +010067struct snd_mpu401 {
68 struct snd_rawmidi *rmidi;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 unsigned short hardware; /* MPU401_HW_XXXX */
Takashi Iwai302e4c22006-05-23 13:24:30 +020071 unsigned int info_flags; /* MPU401_INFO_XXX */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 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
Takashi Iwaie1fad172005-11-17 14:12:45 +010081 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 void *private_data;
86
Takashi Iwaie1fad172005-11-17 14:12:45 +010087 struct snd_rawmidi_substream *substream_input;
88 struct snd_rawmidi_substream *substream_output;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90 spinlock_t input_lock;
91 spinlock_t output_lock;
92 spinlock_t timer_lock;
93
94 struct timer_list timer;
95
Takashi Iwaie1fad172005-11-17 14:12:45 +010096 void (*write) (struct snd_mpu401 * mpu, unsigned char data, unsigned long addr);
97 unsigned char (*read) (struct snd_mpu401 *mpu, unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098};
99
100/* I/O ports */
101
102#define MPU401C(mpu) (mpu)->cport
103#define MPU401D(mpu) (mpu)->port
104
105/*
106
107 */
108
David Howells7d12e782006-10-05 14:55:46 +0100109irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id);
110irqreturn_t snd_mpu401_uart_interrupt_tx(int irq, void *dev_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Takashi Iwaie1fad172005-11-17 14:12:45 +0100112int snd_mpu401_uart_new(struct snd_card *card,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 int device,
114 unsigned short hardware,
115 unsigned long port,
Takashi Iwai302e4c22006-05-23 13:24:30 +0200116 unsigned int info_flags,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 int irq,
118 int irq_flags,
Takashi Iwaie1fad172005-11-17 14:12:45 +0100119 struct snd_rawmidi ** rrawmidi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121#endif /* __SOUND_MPU401_H */