2
* MOTU Midi Timepiece ALSA Main routines
3
* Copyright by Michael T. Mayers (c) Jan 09, 2000
4
* mail: michael@tweakoz.com
5
* Thanks to John Galbraith
7
* This program is free software; you can redistribute it and/or modify
8
* it under the terms of the GNU General Public License as published by
9
* the Free Software Foundation; either version 2 of the License, or
10
* (at your option) any later version.
12
* This program is distributed in the hope that it will be useful,
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
* GNU General Public License for more details.
17
* You should have received a copy of the GNU General Public License
18
* along with this program; if not, write to the Free Software
19
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
* This driver is for the 'Mark Of The Unicorn' (MOTU)
23
* MidiTimePiece AV multiport MIDI interface
27
* 8 MIDI Ins and 8 MIDI outs
28
* Video Sync In (BNC), Word Sync Out (BNC),
31
* 2 programmable pedal/footswitch inputs and 4 programmable MIDI controller knobs.
32
* Macintosh RS422 serial port
33
* RS422 "network" port for ganging multiple MTP's
34
* PC Parallel Port ( which this driver currently uses )
38
* Hardware MIDI routing, merging, and filtering
39
* MIDI Synchronization to Video, ADAT, SMPTE and other Clock sources
40
* 128 'scene' memories, recallable from MIDI program change
44
* Jun 11 2001 Takashi Iwai <tiwai@suse.de>
45
* - Recoded & debugged
46
* - Added timer interrupt for midi outputs
47
* - hwports is between 1 and 8, which specifies the number of hardware ports.
48
* The three global ports, computer, adat and broadcast ports, are created
49
* always after h/w and remote ports.
53
#include <linux/init.h>
54
#include <linux/interrupt.h>
55
#include <linux/module.h>
56
#include <linux/err.h>
57
#include <linux/platform_device.h>
58
#include <linux/ioport.h>
60
#include <linux/moduleparam.h>
61
#include <sound/core.h>
62
#include <sound/initval.h>
63
#include <sound/rawmidi.h>
64
#include <linux/delay.h>
69
MODULE_AUTHOR("Michael T. Mayers");
70
MODULE_DESCRIPTION("MOTU MidiTimePiece AV multiport MIDI");
71
MODULE_LICENSE("GPL");
72
MODULE_SUPPORTED_DEVICE("{{MOTU,MidiTimePiece AV multiport MIDI}}");
75
#define MTPAV_IOBASE 0x378
77
#define MTPAV_MAX_PORTS 8
79
static int index = SNDRV_DEFAULT_IDX1;
80
static char *id = SNDRV_DEFAULT_STR1;
81
static long port = MTPAV_IOBASE; /* 0x378, 0x278 */
82
static int irq = MTPAV_IRQ; /* 7, 5 */
83
static int hwports = MTPAV_MAX_PORTS; /* use hardware ports 1-8 */
85
module_param(index, int, 0444);
86
MODULE_PARM_DESC(index, "Index value for MotuMTPAV MIDI.");
87
module_param(id, charp, 0444);
88
MODULE_PARM_DESC(id, "ID string for MotuMTPAV MIDI.");
89
module_param(port, long, 0444);
90
MODULE_PARM_DESC(port, "Parallel port # for MotuMTPAV MIDI.");
91
module_param(irq, int, 0444);
92
MODULE_PARM_DESC(irq, "Parallel IRQ # for MotuMTPAV MIDI.");
93
module_param(hwports, int, 0444);
94
MODULE_PARM_DESC(hwports, "Hardware ports # for MotuMTPAV MIDI.");
96
static struct platform_device *device;
101
//#define USE_FAKE_MTP // don't actually read/write to MTP device (for debugging without an actual unit) (does not work yet)
103
// parallel port usage masks
104
#define SIGS_BYTE 0x08
105
#define SIGS_RFD 0x80
106
#define SIGS_IRQ 0x40
107
#define SIGS_IN0 0x10
108
#define SIGS_IN1 0x20
110
#define SIGC_WRITE 0x04
111
#define SIGC_READ 0x08
112
#define SIGC_INTEN 0x10
119
#define MTPAV_MODE_INPUT_OPENED 0x01
120
#define MTPAV_MODE_OUTPUT_OPENED 0x02
121
#define MTPAV_MODE_INPUT_TRIGGERED 0x04
122
#define MTPAV_MODE_OUTPUT_TRIGGERED 0x08
124
#define NUMPORTS (0x12+1)
135
struct snd_rawmidi_substream *input;
136
struct snd_rawmidi_substream *output;
140
struct snd_card *card;
142
struct resource *res_port;
143
int irq; /* interrupt (for inputs) */
145
int share_irq; /* number of accesses to input interrupts */
146
int istimer; /* number of accesses to timer interrupts */
147
struct timer_list timer; /* timer interrupts for outputs */
148
struct snd_rawmidi *rmidi;
149
int num_ports; /* number of hw ports (1-8) */
150
struct mtpav_port ports[NUMPORTS]; /* all ports including computer, adat and bc */
152
u32 inmidiport; /* selected input midi port */
153
u32 inmidistate; /* during midi command 0xf5 */
155
u32 outmidihwport; /* selected output midi hw port */
160
* possible hardware ports (selected by 0xf5 port message)
162
* 0x01 .. 0x08 this MTP's ports 1..8
163
* 0x09 .. 0x10 networked MTP's ports (9..16)
164
* 0x11 networked MTP's computer port
168
* subdevice 0 - (X-1) ports
169
* X - (2*X-1) networked ports
174
* where X = chip->num_ports
177
#define MTPAV_PIDX_COMPUTER 0
178
#define MTPAV_PIDX_ADAT 1
179
#define MTPAV_PIDX_BROADCAST 2
182
static int translate_subdevice_to_hwport(struct mtpav *chip, int subdev)
185
return 0x01; /* invalid - use port 0 as default */
186
else if (subdev < chip->num_ports)
187
return subdev + 1; /* single mtp port */
188
else if (subdev < chip->num_ports * 2)
189
return subdev - chip->num_ports + 0x09; /* remote port */
190
else if (subdev == chip->num_ports * 2 + MTPAV_PIDX_COMPUTER)
191
return 0x11; /* computer port */
192
else if (subdev == chip->num_ports + MTPAV_PIDX_ADAT)
193
return 0x63; /* ADAT */
194
return 0; /* all ports */
197
static int translate_hwport_to_subdevice(struct mtpav *chip, int hwport)
200
if (hwport <= 0x00) /* all ports */
201
return chip->num_ports + MTPAV_PIDX_BROADCAST;
202
else if (hwport <= 0x08) { /* single port */
204
if (p >= chip->num_ports)
207
} else if (hwport <= 0x10) { /* remote port */
208
p = hwport - 0x09 + chip->num_ports;
209
if (p >= chip->num_ports * 2)
212
} else if (hwport == 0x11) /* computer port */
213
return chip->num_ports + MTPAV_PIDX_COMPUTER;
215
return chip->num_ports + MTPAV_PIDX_ADAT;
222
static u8 snd_mtpav_getreg(struct mtpav *chip, u16 reg)
227
rval = inb(chip->port + SREG);
228
rval = (rval & 0xf8);
229
} else if (reg == CREG) {
230
rval = inb(chip->port + CREG);
231
rval = (rval & 0x1c);
240
static inline void snd_mtpav_mputreg(struct mtpav *chip, u16 reg, u8 val)
242
if (reg == DREG || reg == CREG)
243
outb(val, chip->port + reg);
249
static void snd_mtpav_wait_rfdhi(struct mtpav *chip)
254
sbyte = snd_mtpav_getreg(chip, SREG);
255
while (!(sbyte & SIGS_RFD) && counts--) {
256
sbyte = snd_mtpav_getreg(chip, SREG);
261
static void snd_mtpav_send_byte(struct mtpav *chip, u8 byte)
267
snd_mtpav_wait_rfdhi(chip);
271
tcbyt = snd_mtpav_getreg(chip, CREG);
272
clrwrite = tcbyt & (SIGC_WRITE ^ 0xff);
273
setwrite = tcbyt | SIGC_WRITE;
275
snd_mtpav_mputreg(chip, DREG, byte);
276
snd_mtpav_mputreg(chip, CREG, clrwrite); // clear write bit
278
snd_mtpav_mputreg(chip, CREG, setwrite); // set write bit
286
/* call this with spin lock held */
287
static void snd_mtpav_output_port_write(struct mtpav *mtp_card,
288
struct mtpav_port *portp,
289
struct snd_rawmidi_substream *substream)
293
// Get the outbyte first, so we can emulate running status if
295
if (snd_rawmidi_transmit(substream, &outbyte, 1) != 1)
298
// send port change command if necessary
300
if (portp->hwport != mtp_card->outmidihwport) {
301
mtp_card->outmidihwport = portp->hwport;
303
snd_mtpav_send_byte(mtp_card, 0xf5);
304
snd_mtpav_send_byte(mtp_card, portp->hwport);
306
snd_printk(KERN_DEBUG "new outport: 0x%x\n",
307
(unsigned int) portp->hwport);
309
if (!(outbyte & 0x80) && portp->running_status)
310
snd_mtpav_send_byte(mtp_card, portp->running_status);
317
portp->running_status = outbyte;
319
snd_mtpav_send_byte(mtp_card, outbyte);
320
} while (snd_rawmidi_transmit(substream, &outbyte, 1) == 1);
323
static void snd_mtpav_output_write(struct snd_rawmidi_substream *substream)
325
struct mtpav *mtp_card = substream->rmidi->private_data;
326
struct mtpav_port *portp = &mtp_card->ports[substream->number];
329
spin_lock_irqsave(&mtp_card->spinlock, flags);
330
snd_mtpav_output_port_write(mtp_card, portp, substream);
331
spin_unlock_irqrestore(&mtp_card->spinlock, flags);
339
static void snd_mtpav_portscan(struct mtpav *chip) // put mtp into smart routing mode
343
for (p = 0; p < 8; p++) {
344
snd_mtpav_send_byte(chip, 0xf5);
345
snd_mtpav_send_byte(chip, p);
346
snd_mtpav_send_byte(chip, 0xfe);
353
static int snd_mtpav_input_open(struct snd_rawmidi_substream *substream)
355
struct mtpav *mtp_card = substream->rmidi->private_data;
356
struct mtpav_port *portp = &mtp_card->ports[substream->number];
359
spin_lock_irqsave(&mtp_card->spinlock, flags);
360
portp->mode |= MTPAV_MODE_INPUT_OPENED;
361
portp->input = substream;
362
if (mtp_card->share_irq++ == 0)
363
snd_mtpav_mputreg(mtp_card, CREG, (SIGC_INTEN | SIGC_WRITE)); // enable pport interrupts
364
spin_unlock_irqrestore(&mtp_card->spinlock, flags);
371
static int snd_mtpav_input_close(struct snd_rawmidi_substream *substream)
373
struct mtpav *mtp_card = substream->rmidi->private_data;
374
struct mtpav_port *portp = &mtp_card->ports[substream->number];
377
spin_lock_irqsave(&mtp_card->spinlock, flags);
378
portp->mode &= ~MTPAV_MODE_INPUT_OPENED;
380
if (--mtp_card->share_irq == 0)
381
snd_mtpav_mputreg(mtp_card, CREG, 0); // disable pport interrupts
382
spin_unlock_irqrestore(&mtp_card->spinlock, flags);
389
static void snd_mtpav_input_trigger(struct snd_rawmidi_substream *substream, int up)
391
struct mtpav *mtp_card = substream->rmidi->private_data;
392
struct mtpav_port *portp = &mtp_card->ports[substream->number];
395
spin_lock_irqsave(&mtp_card->spinlock, flags);
397
portp->mode |= MTPAV_MODE_INPUT_TRIGGERED;
399
portp->mode &= ~MTPAV_MODE_INPUT_TRIGGERED;
400
spin_unlock_irqrestore(&mtp_card->spinlock, flags);
406
* timer interrupt for outputs
409
static void snd_mtpav_output_timer(unsigned long data)
412
struct mtpav *chip = (struct mtpav *)data;
415
spin_lock_irqsave(&chip->spinlock, flags);
416
/* reprogram timer */
417
chip->timer.expires = 1 + jiffies;
418
add_timer(&chip->timer);
419
/* process each port */
420
for (p = 0; p <= chip->num_ports * 2 + MTPAV_PIDX_BROADCAST; p++) {
421
struct mtpav_port *portp = &chip->ports[p];
422
if ((portp->mode & MTPAV_MODE_OUTPUT_TRIGGERED) && portp->output)
423
snd_mtpav_output_port_write(chip, portp, portp->output);
425
spin_unlock_irqrestore(&chip->spinlock, flags);
429
static void snd_mtpav_add_output_timer(struct mtpav *chip)
431
chip->timer.expires = 1 + jiffies;
432
add_timer(&chip->timer);
436
static void snd_mtpav_remove_output_timer(struct mtpav *chip)
438
del_timer(&chip->timer);
444
static int snd_mtpav_output_open(struct snd_rawmidi_substream *substream)
446
struct mtpav *mtp_card = substream->rmidi->private_data;
447
struct mtpav_port *portp = &mtp_card->ports[substream->number];
450
spin_lock_irqsave(&mtp_card->spinlock, flags);
451
portp->mode |= MTPAV_MODE_OUTPUT_OPENED;
452
portp->output = substream;
453
spin_unlock_irqrestore(&mtp_card->spinlock, flags);
460
static int snd_mtpav_output_close(struct snd_rawmidi_substream *substream)
462
struct mtpav *mtp_card = substream->rmidi->private_data;
463
struct mtpav_port *portp = &mtp_card->ports[substream->number];
466
spin_lock_irqsave(&mtp_card->spinlock, flags);
467
portp->mode &= ~MTPAV_MODE_OUTPUT_OPENED;
468
portp->output = NULL;
469
spin_unlock_irqrestore(&mtp_card->spinlock, flags);
476
static void snd_mtpav_output_trigger(struct snd_rawmidi_substream *substream, int up)
478
struct mtpav *mtp_card = substream->rmidi->private_data;
479
struct mtpav_port *portp = &mtp_card->ports[substream->number];
482
spin_lock_irqsave(&mtp_card->spinlock, flags);
484
if (! (portp->mode & MTPAV_MODE_OUTPUT_TRIGGERED)) {
485
if (mtp_card->istimer++ == 0)
486
snd_mtpav_add_output_timer(mtp_card);
487
portp->mode |= MTPAV_MODE_OUTPUT_TRIGGERED;
490
portp->mode &= ~MTPAV_MODE_OUTPUT_TRIGGERED;
491
if (--mtp_card->istimer == 0)
492
snd_mtpav_remove_output_timer(mtp_card);
494
spin_unlock_irqrestore(&mtp_card->spinlock, flags);
497
snd_mtpav_output_write(substream);
501
* midi interrupt for inputs
504
static void snd_mtpav_inmidi_process(struct mtpav *mcrd, u8 inbyte)
506
struct mtpav_port *portp;
508
if ((int)mcrd->inmidiport > mcrd->num_ports * 2 + MTPAV_PIDX_BROADCAST)
511
portp = &mcrd->ports[mcrd->inmidiport];
512
if (portp->mode & MTPAV_MODE_INPUT_TRIGGERED)
513
snd_rawmidi_receive(portp->input, &inbyte, 1);
516
static void snd_mtpav_inmidi_h(struct mtpav *mcrd, u8 inbyte)
518
if (inbyte >= 0xf8) {
519
/* real-time midi code */
520
snd_mtpav_inmidi_process(mcrd, inbyte);
524
if (mcrd->inmidistate == 0) { // awaiting command
525
if (inbyte == 0xf5) // MTP port #
526
mcrd->inmidistate = 1;
528
snd_mtpav_inmidi_process(mcrd, inbyte);
529
} else if (mcrd->inmidistate) {
530
mcrd->inmidiport = translate_hwport_to_subdevice(mcrd, inbyte);
531
mcrd->inmidistate = 0;
535
static void snd_mtpav_read_bytes(struct mtpav *mcrd)
542
u8 sbyt = snd_mtpav_getreg(mcrd, SREG);
544
/* printk(KERN_DEBUG "snd_mtpav_read_bytes() sbyt: 0x%x\n", sbyt); */
546
if (!(sbyt & SIGS_BYTE))
549
cbyt = snd_mtpav_getreg(mcrd, CREG);
550
clrread = cbyt & (SIGC_READ ^ 0xff);
551
setread = cbyt | SIGC_READ;
556
for (i = 0; i < 4; i++) {
557
snd_mtpav_mputreg(mcrd, CREG, setread);
558
sr = snd_mtpav_getreg(mcrd, SREG);
559
snd_mtpav_mputreg(mcrd, CREG, clrread);
561
sr &= SIGS_IN0 | SIGS_IN1;
563
mtp_read_byte |= sr << (i * 2);
566
snd_mtpav_inmidi_h(mcrd, mtp_read_byte);
568
sbyt = snd_mtpav_getreg(mcrd, SREG);
570
} while (sbyt & SIGS_BYTE);
573
static irqreturn_t snd_mtpav_irqh(int irq, void *dev_id)
575
struct mtpav *mcard = dev_id;
577
spin_lock(&mcard->spinlock);
578
snd_mtpav_read_bytes(mcard);
579
spin_unlock(&mcard->spinlock);
586
static int __devinit snd_mtpav_get_ISA(struct mtpav * mcard)
588
if ((mcard->res_port = request_region(port, 3, "MotuMTPAV MIDI")) == NULL) {
589
snd_printk(KERN_ERR "MTVAP port 0x%lx is busy\n", port);
593
if (request_irq(irq, snd_mtpav_irqh, 0, "MOTU MTPAV", mcard)) {
594
snd_printk(KERN_ERR "MTVAP IRQ %d busy\n", irq);
605
static struct snd_rawmidi_ops snd_mtpav_output = {
606
.open = snd_mtpav_output_open,
607
.close = snd_mtpav_output_close,
608
.trigger = snd_mtpav_output_trigger,
611
static struct snd_rawmidi_ops snd_mtpav_input = {
612
.open = snd_mtpav_input_open,
613
.close = snd_mtpav_input_close,
614
.trigger = snd_mtpav_input_trigger,
619
* get RAWMIDI resources
622
static void __devinit snd_mtpav_set_name(struct mtpav *chip,
623
struct snd_rawmidi_substream *substream)
625
if (substream->number >= 0 && substream->number < chip->num_ports)
626
sprintf(substream->name, "MTP direct %d", (substream->number % chip->num_ports) + 1);
627
else if (substream->number >= 8 && substream->number < chip->num_ports * 2)
628
sprintf(substream->name, "MTP remote %d", (substream->number % chip->num_ports) + 1);
629
else if (substream->number == chip->num_ports * 2)
630
strcpy(substream->name, "MTP computer");
631
else if (substream->number == chip->num_ports * 2 + 1)
632
strcpy(substream->name, "MTP ADAT");
634
strcpy(substream->name, "MTP broadcast");
637
static int __devinit snd_mtpav_get_RAWMIDI(struct mtpav *mcard)
640
struct snd_rawmidi *rawmidi;
641
struct snd_rawmidi_substream *substream;
642
struct list_head *list;
646
else if (hwports > 8)
648
mcard->num_ports = hwports;
650
if ((rval = snd_rawmidi_new(mcard->card, "MotuMIDI", 0,
651
mcard->num_ports * 2 + MTPAV_PIDX_BROADCAST + 1,
652
mcard->num_ports * 2 + MTPAV_PIDX_BROADCAST + 1,
655
rawmidi = mcard->rmidi;
656
rawmidi->private_data = mcard;
658
list_for_each(list, &rawmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT].substreams) {
659
substream = list_entry(list, struct snd_rawmidi_substream, list);
660
snd_mtpav_set_name(mcard, substream);
661
substream->ops = &snd_mtpav_input;
663
list_for_each(list, &rawmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT].substreams) {
664
substream = list_entry(list, struct snd_rawmidi_substream, list);
665
snd_mtpav_set_name(mcard, substream);
666
substream->ops = &snd_mtpav_output;
667
mcard->ports[substream->number].hwport = translate_subdevice_to_hwport(mcard, substream->number);
669
rawmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT | SNDRV_RAWMIDI_INFO_INPUT |
670
SNDRV_RAWMIDI_INFO_DUPLEX;
671
sprintf(rawmidi->name, "MTP AV MIDI");
678
static void snd_mtpav_free(struct snd_card *card)
680
struct mtpav *crd = card->private_data;
683
spin_lock_irqsave(&crd->spinlock, flags);
684
if (crd->istimer > 0)
685
snd_mtpav_remove_output_timer(crd);
686
spin_unlock_irqrestore(&crd->spinlock, flags);
688
free_irq(crd->irq, (void *)crd);
689
release_and_free_resource(crd->res_port);
694
static int __devinit snd_mtpav_probe(struct platform_device *dev)
696
struct snd_card *card;
698
struct mtpav *mtp_card;
700
err = snd_card_create(index, id, THIS_MODULE, sizeof(*mtp_card), &card);
704
mtp_card = card->private_data;
705
spin_lock_init(&mtp_card->spinlock);
706
init_timer(&mtp_card->timer);
707
mtp_card->card = card;
709
mtp_card->share_irq = 0;
710
mtp_card->inmidistate = 0;
711
mtp_card->outmidihwport = 0xffffffff;
712
init_timer(&mtp_card->timer);
713
mtp_card->timer.function = snd_mtpav_output_timer;
714
mtp_card->timer.data = (unsigned long) mtp_card;
716
card->private_free = snd_mtpav_free;
718
err = snd_mtpav_get_RAWMIDI(mtp_card);
722
mtp_card->inmidiport = mtp_card->num_ports + MTPAV_PIDX_BROADCAST;
724
err = snd_mtpav_get_ISA(mtp_card);
728
strcpy(card->driver, "MTPAV");
729
strcpy(card->shortname, "MTPAV on parallel port");
730
snprintf(card->longname, sizeof(card->longname),
731
"MTPAV on parallel port at 0x%lx", port);
733
snd_mtpav_portscan(mtp_card);
735
snd_card_set_dev(card, &dev->dev);
736
err = snd_card_register(mtp_card->card);
740
platform_set_drvdata(dev, card);
741
printk(KERN_INFO "Motu MidiTimePiece on parallel port irq: %d ioport: 0x%lx\n", irq, port);
749
static int __devexit snd_mtpav_remove(struct platform_device *devptr)
751
snd_card_free(platform_get_drvdata(devptr));
752
platform_set_drvdata(devptr, NULL);
756
#define SND_MTPAV_DRIVER "snd_mtpav"
758
static struct platform_driver snd_mtpav_driver = {
759
.probe = snd_mtpav_probe,
760
.remove = __devexit_p(snd_mtpav_remove),
762
.name = SND_MTPAV_DRIVER
766
static int __init alsa_card_mtpav_init(void)
770
if ((err = platform_driver_register(&snd_mtpav_driver)) < 0)
773
device = platform_device_register_simple(SND_MTPAV_DRIVER, -1, NULL, 0);
774
if (!IS_ERR(device)) {
775
if (platform_get_drvdata(device))
777
platform_device_unregister(device);
780
err = PTR_ERR(device);
781
platform_driver_unregister(&snd_mtpav_driver);
785
static void __exit alsa_card_mtpav_exit(void)
787
platform_device_unregister(device);
788
platform_driver_unregister(&snd_mtpav_driver);
791
module_init(alsa_card_mtpav_init)
792
module_exit(alsa_card_mtpav_exit)