1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * MOTU Midi Timepiece ALSA Main routines
4 * Copyright by Michael T. Mayers (c) Jan 09, 2000
5 * mail: michael@tweakoz.com
6 * Thanks to John Galbraith
8 * This driver is for the 'Mark Of The Unicorn' (MOTU)
9 * MidiTimePiece AV multiport MIDI interface
13 * 8 MIDI Ins and 8 MIDI outs
14 * Video Sync In (BNC), Word Sync Out (BNC),
17 * 2 programmable pedal/footswitch inputs and 4 programmable MIDI controller knobs.
18 * Macintosh RS422 serial port
19 * RS422 "network" port for ganging multiple MTP's
20 * PC Parallel Port ( which this driver currently uses )
24 * Hardware MIDI routing, merging, and filtering
25 * MIDI Synchronization to Video, ADAT, SMPTE and other Clock sources
26 * 128 'scene' memories, recallable from MIDI program change
29 * Jun 11 2001 Takashi Iwai <tiwai@suse.de>
30 * - Recoded & debugged
31 * - Added timer interrupt for midi outputs
32 * - hwports is between 1 and 8, which specifies the number of hardware ports.
33 * The three global ports, computer, adat and broadcast ports, are created
34 * always after h/w and remote ports.
37 #include <linux/init.h>
38 #include <linux/interrupt.h>
39 #include <linux/module.h>
40 #include <linux/err.h>
41 #include <linux/platform_device.h>
42 #include <linux/ioport.h>
44 #include <linux/moduleparam.h>
45 #include <sound/core.h>
46 #include <sound/initval.h>
47 #include <sound/rawmidi.h>
48 #include <linux/delay.h>
53 MODULE_AUTHOR("Michael T. Mayers");
54 MODULE_DESCRIPTION("MOTU MidiTimePiece AV multiport MIDI");
55 MODULE_LICENSE("GPL");
58 #define MTPAV_IOBASE 0x378
60 #define MTPAV_MAX_PORTS 8
62 static int index
= SNDRV_DEFAULT_IDX1
;
63 static char *id
= SNDRV_DEFAULT_STR1
;
64 static long port
= MTPAV_IOBASE
; /* 0x378, 0x278 */
65 static int irq
= MTPAV_IRQ
; /* 7, 5 */
66 static int hwports
= MTPAV_MAX_PORTS
; /* use hardware ports 1-8 */
68 module_param(index
, int, 0444);
69 MODULE_PARM_DESC(index
, "Index value for MotuMTPAV MIDI.");
70 module_param(id
, charp
, 0444);
71 MODULE_PARM_DESC(id
, "ID string for MotuMTPAV MIDI.");
72 module_param_hw(port
, long, ioport
, 0444);
73 MODULE_PARM_DESC(port
, "Parallel port # for MotuMTPAV MIDI.");
74 module_param_hw(irq
, int, irq
, 0444);
75 MODULE_PARM_DESC(irq
, "Parallel IRQ # for MotuMTPAV MIDI.");
76 module_param(hwports
, int, 0444);
77 MODULE_PARM_DESC(hwports
, "Hardware ports # for MotuMTPAV MIDI.");
79 static struct platform_device
*device
;
84 //#define USE_FAKE_MTP // don't actually read/write to MTP device (for debugging without an actual unit) (does not work yet)
86 // parallel port usage masks
87 #define SIGS_BYTE 0x08
93 #define SIGC_WRITE 0x04
94 #define SIGC_READ 0x08
95 #define SIGC_INTEN 0x10
102 #define MTPAV_MODE_INPUT_OPENED 0x01
103 #define MTPAV_MODE_OUTPUT_OPENED 0x02
104 #define MTPAV_MODE_INPUT_TRIGGERED 0x04
105 #define MTPAV_MODE_OUTPUT_TRIGGERED 0x08
107 #define NUMPORTS (0x12+1)
118 struct snd_rawmidi_substream
*input
;
119 struct snd_rawmidi_substream
*output
;
123 struct snd_card
*card
;
125 struct resource
*res_port
;
126 int irq
; /* interrupt (for inputs) */
128 int share_irq
; /* number of accesses to input interrupts */
129 int istimer
; /* number of accesses to timer interrupts */
130 struct timer_list timer
; /* timer interrupts for outputs */
131 struct snd_rawmidi
*rmidi
;
132 int num_ports
; /* number of hw ports (1-8) */
133 struct mtpav_port ports
[NUMPORTS
]; /* all ports including computer, adat and bc */
135 u32 inmidiport
; /* selected input midi port */
136 u32 inmidistate
; /* during midi command 0xf5 */
138 u32 outmidihwport
; /* selected output midi hw port */
143 * possible hardware ports (selected by 0xf5 port message)
145 * 0x01 .. 0x08 this MTP's ports 1..8
146 * 0x09 .. 0x10 networked MTP's ports (9..16)
147 * 0x11 networked MTP's computer port
151 * subdevice 0 - (X-1) ports
152 * X - (2*X-1) networked ports
157 * where X = chip->num_ports
160 #define MTPAV_PIDX_COMPUTER 0
161 #define MTPAV_PIDX_ADAT 1
162 #define MTPAV_PIDX_BROADCAST 2
165 static int translate_subdevice_to_hwport(struct mtpav
*chip
, int subdev
)
168 return 0x01; /* invalid - use port 0 as default */
169 else if (subdev
< chip
->num_ports
)
170 return subdev
+ 1; /* single mtp port */
171 else if (subdev
< chip
->num_ports
* 2)
172 return subdev
- chip
->num_ports
+ 0x09; /* remote port */
173 else if (subdev
== chip
->num_ports
* 2 + MTPAV_PIDX_COMPUTER
)
174 return 0x11; /* computer port */
175 else if (subdev
== chip
->num_ports
+ MTPAV_PIDX_ADAT
)
176 return 0x63; /* ADAT */
177 return 0; /* all ports */
180 static int translate_hwport_to_subdevice(struct mtpav
*chip
, int hwport
)
183 if (hwport
<= 0x00) /* all ports */
184 return chip
->num_ports
+ MTPAV_PIDX_BROADCAST
;
185 else if (hwport
<= 0x08) { /* single port */
187 if (p
>= chip
->num_ports
)
190 } else if (hwport
<= 0x10) { /* remote port */
191 p
= hwport
- 0x09 + chip
->num_ports
;
192 if (p
>= chip
->num_ports
* 2)
195 } else if (hwport
== 0x11) /* computer port */
196 return chip
->num_ports
+ MTPAV_PIDX_COMPUTER
;
198 return chip
->num_ports
+ MTPAV_PIDX_ADAT
;
205 static u8
snd_mtpav_getreg(struct mtpav
*chip
, u16 reg
)
210 rval
= inb(chip
->port
+ SREG
);
211 rval
= (rval
& 0xf8);
212 } else if (reg
== CREG
) {
213 rval
= inb(chip
->port
+ CREG
);
214 rval
= (rval
& 0x1c);
223 static inline void snd_mtpav_mputreg(struct mtpav
*chip
, u16 reg
, u8 val
)
225 if (reg
== DREG
|| reg
== CREG
)
226 outb(val
, chip
->port
+ reg
);
232 static void snd_mtpav_wait_rfdhi(struct mtpav
*chip
)
237 sbyte
= snd_mtpav_getreg(chip
, SREG
);
238 while (!(sbyte
& SIGS_RFD
) && counts
--) {
239 sbyte
= snd_mtpav_getreg(chip
, SREG
);
244 static void snd_mtpav_send_byte(struct mtpav
*chip
, u8 byte
)
250 snd_mtpav_wait_rfdhi(chip
);
254 tcbyt
= snd_mtpav_getreg(chip
, CREG
);
255 clrwrite
= tcbyt
& (SIGC_WRITE
^ 0xff);
256 setwrite
= tcbyt
| SIGC_WRITE
;
258 snd_mtpav_mputreg(chip
, DREG
, byte
);
259 snd_mtpav_mputreg(chip
, CREG
, clrwrite
); // clear write bit
261 snd_mtpav_mputreg(chip
, CREG
, setwrite
); // set write bit
269 /* call this with spin lock held */
270 static void snd_mtpav_output_port_write(struct mtpav
*mtp_card
,
271 struct mtpav_port
*portp
,
272 struct snd_rawmidi_substream
*substream
)
276 // Get the outbyte first, so we can emulate running status if
278 if (snd_rawmidi_transmit(substream
, &outbyte
, 1) != 1)
281 // send port change command if necessary
283 if (portp
->hwport
!= mtp_card
->outmidihwport
) {
284 mtp_card
->outmidihwport
= portp
->hwport
;
286 snd_mtpav_send_byte(mtp_card
, 0xf5);
287 snd_mtpav_send_byte(mtp_card
, portp
->hwport
);
288 if (!(outbyte
& 0x80) && portp
->running_status
)
289 snd_mtpav_send_byte(mtp_card
, portp
->running_status
);
296 portp
->running_status
= outbyte
;
298 snd_mtpav_send_byte(mtp_card
, outbyte
);
299 } while (snd_rawmidi_transmit(substream
, &outbyte
, 1) == 1);
302 static void snd_mtpav_output_write(struct snd_rawmidi_substream
*substream
)
304 struct mtpav
*mtp_card
= substream
->rmidi
->private_data
;
305 struct mtpav_port
*portp
= &mtp_card
->ports
[substream
->number
];
308 spin_lock_irqsave(&mtp_card
->spinlock
, flags
);
309 snd_mtpav_output_port_write(mtp_card
, portp
, substream
);
310 spin_unlock_irqrestore(&mtp_card
->spinlock
, flags
);
318 static void snd_mtpav_portscan(struct mtpav
*chip
) // put mtp into smart routing mode
322 for (p
= 0; p
< 8; p
++) {
323 snd_mtpav_send_byte(chip
, 0xf5);
324 snd_mtpav_send_byte(chip
, p
);
325 snd_mtpav_send_byte(chip
, 0xfe);
332 static int snd_mtpav_input_open(struct snd_rawmidi_substream
*substream
)
334 struct mtpav
*mtp_card
= substream
->rmidi
->private_data
;
335 struct mtpav_port
*portp
= &mtp_card
->ports
[substream
->number
];
338 spin_lock_irqsave(&mtp_card
->spinlock
, flags
);
339 portp
->mode
|= MTPAV_MODE_INPUT_OPENED
;
340 portp
->input
= substream
;
341 if (mtp_card
->share_irq
++ == 0)
342 snd_mtpav_mputreg(mtp_card
, CREG
, (SIGC_INTEN
| SIGC_WRITE
)); // enable pport interrupts
343 spin_unlock_irqrestore(&mtp_card
->spinlock
, flags
);
350 static int snd_mtpav_input_close(struct snd_rawmidi_substream
*substream
)
352 struct mtpav
*mtp_card
= substream
->rmidi
->private_data
;
353 struct mtpav_port
*portp
= &mtp_card
->ports
[substream
->number
];
356 spin_lock_irqsave(&mtp_card
->spinlock
, flags
);
357 portp
->mode
&= ~MTPAV_MODE_INPUT_OPENED
;
359 if (--mtp_card
->share_irq
== 0)
360 snd_mtpav_mputreg(mtp_card
, CREG
, 0); // disable pport interrupts
361 spin_unlock_irqrestore(&mtp_card
->spinlock
, flags
);
368 static void snd_mtpav_input_trigger(struct snd_rawmidi_substream
*substream
, int up
)
370 struct mtpav
*mtp_card
= substream
->rmidi
->private_data
;
371 struct mtpav_port
*portp
= &mtp_card
->ports
[substream
->number
];
374 spin_lock_irqsave(&mtp_card
->spinlock
, flags
);
376 portp
->mode
|= MTPAV_MODE_INPUT_TRIGGERED
;
378 portp
->mode
&= ~MTPAV_MODE_INPUT_TRIGGERED
;
379 spin_unlock_irqrestore(&mtp_card
->spinlock
, flags
);
385 * timer interrupt for outputs
388 static void snd_mtpav_output_timer(struct timer_list
*t
)
391 struct mtpav
*chip
= from_timer(chip
, t
, timer
);
394 spin_lock_irqsave(&chip
->spinlock
, flags
);
395 /* reprogram timer */
396 mod_timer(&chip
->timer
, 1 + jiffies
);
397 /* process each port */
398 for (p
= 0; p
<= chip
->num_ports
* 2 + MTPAV_PIDX_BROADCAST
; p
++) {
399 struct mtpav_port
*portp
= &chip
->ports
[p
];
400 if ((portp
->mode
& MTPAV_MODE_OUTPUT_TRIGGERED
) && portp
->output
)
401 snd_mtpav_output_port_write(chip
, portp
, portp
->output
);
403 spin_unlock_irqrestore(&chip
->spinlock
, flags
);
407 static void snd_mtpav_add_output_timer(struct mtpav
*chip
)
409 mod_timer(&chip
->timer
, 1 + jiffies
);
413 static void snd_mtpav_remove_output_timer(struct mtpav
*chip
)
415 del_timer(&chip
->timer
);
421 static int snd_mtpav_output_open(struct snd_rawmidi_substream
*substream
)
423 struct mtpav
*mtp_card
= substream
->rmidi
->private_data
;
424 struct mtpav_port
*portp
= &mtp_card
->ports
[substream
->number
];
427 spin_lock_irqsave(&mtp_card
->spinlock
, flags
);
428 portp
->mode
|= MTPAV_MODE_OUTPUT_OPENED
;
429 portp
->output
= substream
;
430 spin_unlock_irqrestore(&mtp_card
->spinlock
, flags
);
437 static int snd_mtpav_output_close(struct snd_rawmidi_substream
*substream
)
439 struct mtpav
*mtp_card
= substream
->rmidi
->private_data
;
440 struct mtpav_port
*portp
= &mtp_card
->ports
[substream
->number
];
443 spin_lock_irqsave(&mtp_card
->spinlock
, flags
);
444 portp
->mode
&= ~MTPAV_MODE_OUTPUT_OPENED
;
445 portp
->output
= NULL
;
446 spin_unlock_irqrestore(&mtp_card
->spinlock
, flags
);
453 static void snd_mtpav_output_trigger(struct snd_rawmidi_substream
*substream
, int up
)
455 struct mtpav
*mtp_card
= substream
->rmidi
->private_data
;
456 struct mtpav_port
*portp
= &mtp_card
->ports
[substream
->number
];
459 spin_lock_irqsave(&mtp_card
->spinlock
, flags
);
461 if (! (portp
->mode
& MTPAV_MODE_OUTPUT_TRIGGERED
)) {
462 if (mtp_card
->istimer
++ == 0)
463 snd_mtpav_add_output_timer(mtp_card
);
464 portp
->mode
|= MTPAV_MODE_OUTPUT_TRIGGERED
;
467 portp
->mode
&= ~MTPAV_MODE_OUTPUT_TRIGGERED
;
468 if (--mtp_card
->istimer
== 0)
469 snd_mtpav_remove_output_timer(mtp_card
);
471 spin_unlock_irqrestore(&mtp_card
->spinlock
, flags
);
474 snd_mtpav_output_write(substream
);
478 * midi interrupt for inputs
481 static void snd_mtpav_inmidi_process(struct mtpav
*mcrd
, u8 inbyte
)
483 struct mtpav_port
*portp
;
485 if ((int)mcrd
->inmidiport
> mcrd
->num_ports
* 2 + MTPAV_PIDX_BROADCAST
)
488 portp
= &mcrd
->ports
[mcrd
->inmidiport
];
489 if (portp
->mode
& MTPAV_MODE_INPUT_TRIGGERED
)
490 snd_rawmidi_receive(portp
->input
, &inbyte
, 1);
493 static void snd_mtpav_inmidi_h(struct mtpav
*mcrd
, u8 inbyte
)
495 if (inbyte
>= 0xf8) {
496 /* real-time midi code */
497 snd_mtpav_inmidi_process(mcrd
, inbyte
);
501 if (mcrd
->inmidistate
== 0) { // awaiting command
502 if (inbyte
== 0xf5) // MTP port #
503 mcrd
->inmidistate
= 1;
505 snd_mtpav_inmidi_process(mcrd
, inbyte
);
506 } else if (mcrd
->inmidistate
) {
507 mcrd
->inmidiport
= translate_hwport_to_subdevice(mcrd
, inbyte
);
508 mcrd
->inmidistate
= 0;
512 static void snd_mtpav_read_bytes(struct mtpav
*mcrd
)
519 u8 sbyt
= snd_mtpav_getreg(mcrd
, SREG
);
521 if (!(sbyt
& SIGS_BYTE
))
524 cbyt
= snd_mtpav_getreg(mcrd
, CREG
);
525 clrread
= cbyt
& (SIGC_READ
^ 0xff);
526 setread
= cbyt
| SIGC_READ
;
531 for (i
= 0; i
< 4; i
++) {
532 snd_mtpav_mputreg(mcrd
, CREG
, setread
);
533 sr
= snd_mtpav_getreg(mcrd
, SREG
);
534 snd_mtpav_mputreg(mcrd
, CREG
, clrread
);
536 sr
&= SIGS_IN0
| SIGS_IN1
;
538 mtp_read_byte
|= sr
<< (i
* 2);
541 snd_mtpav_inmidi_h(mcrd
, mtp_read_byte
);
543 sbyt
= snd_mtpav_getreg(mcrd
, SREG
);
545 } while (sbyt
& SIGS_BYTE
);
548 static irqreturn_t
snd_mtpav_irqh(int irq
, void *dev_id
)
550 struct mtpav
*mcard
= dev_id
;
552 spin_lock(&mcard
->spinlock
);
553 snd_mtpav_read_bytes(mcard
);
554 spin_unlock(&mcard
->spinlock
);
561 static int snd_mtpav_get_ISA(struct mtpav
*mcard
)
563 mcard
->res_port
= devm_request_region(mcard
->card
->dev
, port
, 3,
565 if (!mcard
->res_port
) {
566 dev_err(mcard
->card
->dev
, "MTVAP port 0x%lx is busy\n", port
);
570 if (devm_request_irq(mcard
->card
->dev
, irq
, snd_mtpav_irqh
, 0,
571 "MOTU MTPAV", mcard
)) {
572 dev_err(mcard
->card
->dev
, "MTVAP IRQ %d busy\n", irq
);
583 static const struct snd_rawmidi_ops snd_mtpav_output
= {
584 .open
= snd_mtpav_output_open
,
585 .close
= snd_mtpav_output_close
,
586 .trigger
= snd_mtpav_output_trigger
,
589 static const struct snd_rawmidi_ops snd_mtpav_input
= {
590 .open
= snd_mtpav_input_open
,
591 .close
= snd_mtpav_input_close
,
592 .trigger
= snd_mtpav_input_trigger
,
597 * get RAWMIDI resources
600 static void snd_mtpav_set_name(struct mtpav
*chip
,
601 struct snd_rawmidi_substream
*substream
)
603 if (substream
->number
>= 0 && substream
->number
< chip
->num_ports
)
604 sprintf(substream
->name
, "MTP direct %d", (substream
->number
% chip
->num_ports
) + 1);
605 else if (substream
->number
>= 8 && substream
->number
< chip
->num_ports
* 2)
606 sprintf(substream
->name
, "MTP remote %d", (substream
->number
% chip
->num_ports
) + 1);
607 else if (substream
->number
== chip
->num_ports
* 2)
608 strcpy(substream
->name
, "MTP computer");
609 else if (substream
->number
== chip
->num_ports
* 2 + 1)
610 strcpy(substream
->name
, "MTP ADAT");
612 strcpy(substream
->name
, "MTP broadcast");
615 static int snd_mtpav_get_RAWMIDI(struct mtpav
*mcard
)
618 struct snd_rawmidi
*rawmidi
;
619 struct snd_rawmidi_substream
*substream
;
620 struct list_head
*list
;
624 else if (hwports
> 8)
626 mcard
->num_ports
= hwports
;
628 rval
= snd_rawmidi_new(mcard
->card
, "MotuMIDI", 0,
629 mcard
->num_ports
* 2 + MTPAV_PIDX_BROADCAST
+ 1,
630 mcard
->num_ports
* 2 + MTPAV_PIDX_BROADCAST
+ 1,
634 rawmidi
= mcard
->rmidi
;
635 rawmidi
->private_data
= mcard
;
637 list_for_each(list
, &rawmidi
->streams
[SNDRV_RAWMIDI_STREAM_INPUT
].substreams
) {
638 substream
= list_entry(list
, struct snd_rawmidi_substream
, list
);
639 snd_mtpav_set_name(mcard
, substream
);
640 substream
->ops
= &snd_mtpav_input
;
642 list_for_each(list
, &rawmidi
->streams
[SNDRV_RAWMIDI_STREAM_OUTPUT
].substreams
) {
643 substream
= list_entry(list
, struct snd_rawmidi_substream
, list
);
644 snd_mtpav_set_name(mcard
, substream
);
645 substream
->ops
= &snd_mtpav_output
;
646 mcard
->ports
[substream
->number
].hwport
= translate_subdevice_to_hwport(mcard
, substream
->number
);
648 rawmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_OUTPUT
| SNDRV_RAWMIDI_INFO_INPUT
|
649 SNDRV_RAWMIDI_INFO_DUPLEX
;
650 sprintf(rawmidi
->name
, "MTP AV MIDI");
657 static void snd_mtpav_free(struct snd_card
*card
)
659 struct mtpav
*crd
= card
->private_data
;
662 spin_lock_irqsave(&crd
->spinlock
, flags
);
663 if (crd
->istimer
> 0)
664 snd_mtpav_remove_output_timer(crd
);
665 spin_unlock_irqrestore(&crd
->spinlock
, flags
);
670 static int snd_mtpav_probe(struct platform_device
*dev
)
672 struct snd_card
*card
;
674 struct mtpav
*mtp_card
;
676 err
= snd_devm_card_new(&dev
->dev
, index
, id
, THIS_MODULE
,
677 sizeof(*mtp_card
), &card
);
681 mtp_card
= card
->private_data
;
682 spin_lock_init(&mtp_card
->spinlock
);
683 mtp_card
->card
= card
;
685 mtp_card
->share_irq
= 0;
686 mtp_card
->inmidistate
= 0;
687 mtp_card
->outmidihwport
= 0xffffffff;
688 timer_setup(&mtp_card
->timer
, snd_mtpav_output_timer
, 0);
690 err
= snd_mtpav_get_RAWMIDI(mtp_card
);
694 mtp_card
->inmidiport
= mtp_card
->num_ports
+ MTPAV_PIDX_BROADCAST
;
696 err
= snd_mtpav_get_ISA(mtp_card
);
700 strcpy(card
->driver
, "MTPAV");
701 strcpy(card
->shortname
, "MTPAV on parallel port");
702 snprintf(card
->longname
, sizeof(card
->longname
),
703 "MTPAV on parallel port at 0x%lx", port
);
705 snd_mtpav_portscan(mtp_card
);
707 err
= snd_card_register(mtp_card
->card
);
711 card
->private_free
= snd_mtpav_free
;
713 platform_set_drvdata(dev
, card
);
715 "Motu MidiTimePiece on parallel port irq: %d ioport: 0x%lx\n",
720 #define SND_MTPAV_DRIVER "snd_mtpav"
722 static struct platform_driver snd_mtpav_driver
= {
723 .probe
= snd_mtpav_probe
,
725 .name
= SND_MTPAV_DRIVER
,
729 static int __init
alsa_card_mtpav_init(void)
733 err
= platform_driver_register(&snd_mtpav_driver
);
737 device
= platform_device_register_simple(SND_MTPAV_DRIVER
, -1, NULL
, 0);
738 if (!IS_ERR(device
)) {
739 if (platform_get_drvdata(device
))
741 platform_device_unregister(device
);
744 err
= PTR_ERR(device
);
745 platform_driver_unregister(&snd_mtpav_driver
);
749 static void __exit
alsa_card_mtpav_exit(void)
751 platform_device_unregister(device
);
752 platform_driver_unregister(&snd_mtpav_driver
);
755 module_init(alsa_card_mtpav_init
)
756 module_exit(alsa_card_mtpav_exit
)