4 * The low level driver for Roland MPU-401 compatible Midi cards.
7 * Copyright (C) by Hannu Savolainen 1993-1997
9 * OSS/Free for Linux is distributed under the GNU GENERAL PUBLIC LICENSE (GPL)
10 * Version 2 (June 1991). See the "COPYING" file distributed with this software
14 * Thomas Sailer ioctl code reworked (vmalloc/vfree removed)
15 * Alan Cox modularisation, use normal request_irq, use dev_id
16 * Bartlomiej Zolnierkiewicz removed some __init to allow using many drivers
17 * Chris Rankin Update the module-usage counter for the coprocessor
18 * Zwane Mwaikambo Changed attach/unload resource freeing
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/init.h>
24 #include <linux/interrupt.h>
25 #include <linux/spinlock.h>
26 #define USE_SEQ_MACROS
27 #define USE_SIMPLE_MACROS
29 #include "sound_config.h"
34 static int timer_mode
= TMR_INTERNAL
, timer_caps
= TMR_INTERNAL
;
52 unsigned char version
, revision
;
53 unsigned int capabilities
;
54 #define MPU_CAP_INTLG 0x10000000
55 #define MPU_CAP_SYNC 0x00000010
56 #define MPU_CAP_FSK 0x00000020
57 #define MPU_CAP_CLS 0x00000040
58 #define MPU_CAP_SMPTE 0x00000080
59 #define MPU_CAP_2PORT 0x00000001
63 #define BUFTEST(dc) if (dc->m_ptr >= MBUF_MAX || dc->m_ptr < 0) \
64 {printk( "MPU: Invalid buffer pointer %d/%d, s=%d\n", dc->m_ptr, dc->m_left, dc->m_state);dc->m_ptr--;}
66 unsigned char m_buf
[MBUF_MAX
];
70 unsigned char last_status
;
71 void (*inputintr
) (int dev
, unsigned char data
);
77 #define DATAPORT(base) (base)
78 #define COMDPORT(base) (base+1)
79 #define STATPORT(base) (base+1)
82 static void mpu401_close(int dev
);
84 static inline int mpu401_status(struct mpu_config
*devc
)
86 return inb(STATPORT(devc
->base
));
89 #define input_avail(devc) (!(mpu401_status(devc)&INPUT_AVAIL))
90 #define output_ready(devc) (!(mpu401_status(devc)&OUTPUT_READY))
92 static inline void write_command(struct mpu_config
*devc
, unsigned char cmd
)
94 outb(cmd
, COMDPORT(devc
->base
));
97 static inline int read_data(struct mpu_config
*devc
)
99 return inb(DATAPORT(devc
->base
));
102 static inline void write_data(struct mpu_config
*devc
, unsigned char byte
)
104 outb(byte
, DATAPORT(devc
->base
));
107 #define OUTPUT_READY 0x40
108 #define INPUT_AVAIL 0x80
110 #define MPU_RESET 0xFF
111 #define UART_MODE_ON 0x3F
113 static struct mpu_config dev_conf
[MAX_MIDI_DEV
];
115 static int n_mpu_devs
;
117 static int reset_mpu401(struct mpu_config
*devc
);
118 static void set_uart_mode(int dev
, struct mpu_config
*devc
, int arg
);
120 static int mpu_timer_init(int midi_dev
);
121 static void mpu_timer_interrupt(void);
122 static void timer_ext_event(struct mpu_config
*devc
, int event
, int parm
);
124 static struct synth_info mpu_synth_info_proto
= {
125 "MPU-401 MIDI interface",
134 static struct synth_info mpu_synth_info
[MAX_MIDI_DEV
];
137 * States for the input scanner
140 #define ST_INIT 0 /* Ready for timing byte or msg */
141 #define ST_TIMED 1 /* Leading timing byte rcvd */
142 #define ST_DATABYTE 2 /* Waiting for (nr_left) data bytes */
144 #define ST_SYSMSG 100 /* System message (sysx etc). */
145 #define ST_SYSEX 101 /* System exclusive msg */
146 #define ST_MTC 102 /* Midi Time Code (MTC) qframe msg */
147 #define ST_SONGSEL 103 /* Song select */
148 #define ST_SONGPOS 104 /* Song position pointer */
150 static unsigned char len_tab
[] = /* # of data bytes following a status
166 unsigned char obuf[8]; \
168 seq_input_event(obuf, len); \
173 #define _SEQ_ADVBUF(x) len=x
175 static int mpu_input_scanner(struct mpu_config
*devc
, unsigned char midic
)
178 switch (devc
->m_state
)
192 if (devc
->timer_flag
)
193 mpu_timer_interrupt();
207 printk("<Trk data rq #%d>", midic
& 0x0f);
211 printk("<conductor rq>");
215 devc
->m_state
= ST_SYSMSG
;
221 /* printk( "mpu time: %d ", midic); */
222 devc
->m_state
= ST_TIMED
;
225 printk("<MPU: Unknown event %02x> ", midic
);
231 int msg
= ((int) (midic
& 0xf0) >> 4);
233 devc
->m_state
= ST_DATABYTE
;
235 if (msg
< 8) /* Data byte */
237 /* printk( "midi msg (running status) "); */
238 msg
= ((int) (devc
->last_status
& 0xf0) >> 4);
240 devc
->m_left
= len_tab
[msg
] - 1;
243 devc
->m_buf
[0] = devc
->last_status
;
244 devc
->m_buf
[1] = midic
;
246 if (devc
->m_left
<= 0)
248 devc
->m_state
= ST_INIT
;
249 do_midi_msg(devc
->synthno
, devc
->m_buf
, devc
->m_ptr
);
253 else if (msg
== 0xf) /* MPU MARK */
255 devc
->m_state
= ST_INIT
;
260 /* printk( "NOP "); */
264 /* printk( "meas end "); */
268 /* printk( "data end "); */
272 printk("Unknown MPU mark %02x\n", midic
);
277 devc
->last_status
= midic
;
278 /* printk( "midi msg "); */
280 devc
->m_left
= len_tab
[msg
];
283 devc
->m_buf
[0] = midic
;
285 if (devc
->m_left
<= 0)
287 devc
->m_state
= ST_INIT
;
288 do_midi_msg(devc
->synthno
, devc
->m_buf
, devc
->m_ptr
);
300 devc
->m_state
= ST_SYSEX
;
304 devc
->m_state
= ST_MTC
;
308 devc
->m_state
= ST_SONGPOS
;
313 devc
->m_state
= ST_SONGSEL
;
317 /* printk( "tune_request\n"); */
318 devc
->m_state
= ST_INIT
;
325 devc
->m_state
= ST_INIT
;
326 timer_ext_event(devc
, TMR_CLOCK
, 0);
330 devc
->m_state
= ST_INIT
;
331 timer_ext_event(devc
, TMR_START
, 0);
335 devc
->m_state
= ST_INIT
;
336 timer_ext_event(devc
, TMR_CONTINUE
, 0);
340 devc
->m_state
= ST_INIT
;
341 timer_ext_event(devc
, TMR_STOP
, 0);
346 devc
->m_state
= ST_INIT
;
350 /* printk( "midi hard reset"); */
351 devc
->m_state
= ST_INIT
;
355 printk("unknown MIDI sysmsg %0x\n", midic
);
356 devc
->m_state
= ST_INIT
;
361 devc
->m_state
= ST_INIT
;
362 printk("MTC frame %x02\n", midic
);
369 devc
->m_state
= ST_INIT
;
372 printk("%02x ", midic
);
377 devc
->m_buf
[devc
->m_ptr
++] = midic
;
378 if (devc
->m_ptr
== 2)
380 devc
->m_state
= ST_INIT
;
382 timer_ext_event(devc
, TMR_SPP
,
383 ((devc
->m_buf
[1] & 0x7f) << 7) |
384 (devc
->m_buf
[0] & 0x7f));
390 devc
->m_buf
[devc
->m_ptr
++] = midic
;
391 if ((--devc
->m_left
) <= 0)
393 devc
->m_state
= ST_INIT
;
394 do_midi_msg(devc
->synthno
, devc
->m_buf
, devc
->m_ptr
);
400 printk("Bad state %d ", devc
->m_state
);
401 devc
->m_state
= ST_INIT
;
406 static void mpu401_input_loop(struct mpu_config
*devc
)
412 spin_lock_irqsave(&devc
->lock
,flags
);
415 spin_unlock_irqrestore(&devc
->lock
,flags
);
417 if (busy
) /* Already inside the scanner */
422 while (input_avail(devc
) && n
-- > 0)
424 unsigned char c
= read_data(devc
);
426 if (devc
->mode
== MODE_SYNTH
)
428 mpu_input_scanner(devc
, c
);
430 else if (devc
->opened
& OPEN_READ
&& devc
->inputintr
!= NULL
)
431 devc
->inputintr(devc
->devno
, c
);
436 static irqreturn_t
mpuintr(int irq
, void *dev_id
)
438 struct mpu_config
*devc
;
439 int dev
= (int)(unsigned long) dev_id
;
442 devc
= &dev_conf
[dev
];
444 if (input_avail(devc
))
447 if (devc
->base
!= 0 && (devc
->opened
& OPEN_READ
|| devc
->mode
== MODE_SYNTH
))
448 mpu401_input_loop(devc
);
451 /* Dummy read (just to acknowledge the interrupt) */
455 return IRQ_RETVAL(handled
);
458 static int mpu401_open(int dev
, int mode
,
459 void (*input
) (int dev
, unsigned char data
),
460 void (*output
) (int dev
)
464 struct mpu_config
*devc
;
465 struct coproc_operations
*coprocessor
;
467 if (dev
< 0 || dev
>= num_midis
|| midi_devs
[dev
] == NULL
)
470 devc
= &dev_conf
[dev
];
475 * Verify that the device is really running.
476 * Some devices (such as Ensoniq SoundScape don't
477 * work before the on board processor (OBP) is initialized
478 * by downloading its microcode.
481 if (!devc
->initialized
)
483 if (mpu401_status(devc
) == 0xff) /* Bus float */
485 printk(KERN_ERR
"mpu401: Device not initialized properly\n");
491 if ( (coprocessor
= midi_devs
[dev
]->coproc
) != NULL
)
493 if (!try_module_get(coprocessor
->owner
)) {
498 if ((err
= coprocessor
->open(coprocessor
->devc
, COPR_MIDI
)) < 0)
500 printk(KERN_WARNING
"MPU-401: Can't access coprocessor device\n");
506 set_uart_mode(dev
, devc
, 1);
507 devc
->mode
= MODE_MIDI
;
510 mpu401_input_loop(devc
);
512 devc
->inputintr
= input
;
518 static void mpu401_close(int dev
)
520 struct mpu_config
*devc
;
521 struct coproc_operations
*coprocessor
;
523 devc
= &dev_conf
[dev
];
525 reset_mpu401(devc
); /*
526 * This disables the UART mode
529 devc
->inputintr
= NULL
;
531 coprocessor
= midi_devs
[dev
]->coproc
;
533 coprocessor
->close(coprocessor
->devc
, COPR_MIDI
);
534 module_put(coprocessor
->owner
);
539 static int mpu401_out(int dev
, unsigned char midi_byte
)
544 struct mpu_config
*devc
;
546 devc
= &dev_conf
[dev
];
549 * Sometimes it takes about 30000 loops before the output becomes ready
550 * (After reset). Normally it takes just about 10 loops.
553 for (timeout
= 30000; timeout
> 0 && !output_ready(devc
); timeout
--);
555 spin_lock_irqsave(&devc
->lock
,flags
);
556 if (!output_ready(devc
))
558 printk(KERN_WARNING
"mpu401: Send data timeout\n");
559 spin_unlock_irqrestore(&devc
->lock
,flags
);
562 write_data(devc
, midi_byte
);
563 spin_unlock_irqrestore(&devc
->lock
,flags
);
567 static int mpu401_command(int dev
, mpu_command_rec
* cmd
)
571 struct mpu_config
*devc
;
573 devc
= &dev_conf
[dev
];
575 if (devc
->uart_mode
) /*
576 * Not possible in UART mode
579 printk(KERN_WARNING
"mpu401: commands not possible in the UART mode\n");
583 * Test for input since pending input seems to block the output.
585 if (input_avail(devc
))
586 mpu401_input_loop(devc
);
589 * Sometimes it takes about 50000 loops before the output becomes ready
590 * (After reset). Normally it takes just about 10 loops.
597 printk(KERN_WARNING
"mpu401: Command (0x%x) timeout\n", (int) cmd
->cmd
);
600 spin_lock_irqsave(&devc
->lock
,flags
);
602 if (!output_ready(devc
))
604 spin_unlock_irqrestore(&devc
->lock
,flags
);
607 write_command(devc
, cmd
->cmd
);
610 for (timeout
= 50000; timeout
> 0 && !ok
; timeout
--)
612 if (input_avail(devc
))
614 if (devc
->opened
&& devc
->mode
== MODE_SYNTH
)
616 if (mpu_input_scanner(devc
, read_data(devc
)) == MPU_ACK
)
621 /* Device is not currently open. Use simpler method */
622 if (read_data(devc
) == MPU_ACK
)
629 spin_unlock_irqrestore(&devc
->lock
,flags
);
634 for (i
= 0; i
< cmd
->nr_args
; i
++)
636 for (timeout
= 3000; timeout
> 0 && !output_ready(devc
); timeout
--);
638 if (!mpu401_out(dev
, cmd
->data
[i
]))
640 spin_unlock_irqrestore(&devc
->lock
,flags
);
641 printk(KERN_WARNING
"mpu401: Command (0x%x), parm send failed.\n", (int) cmd
->cmd
);
650 for (i
= 0; i
< cmd
->nr_returns
; i
++)
653 for (timeout
= 5000; timeout
> 0 && !ok
; timeout
--)
654 if (input_avail(devc
))
656 cmd
->data
[i
] = read_data(devc
);
661 spin_unlock_irqrestore(&devc
->lock
,flags
);
666 spin_unlock_irqrestore(&devc
->lock
,flags
);
670 static int mpu_cmd(int dev
, int cmd
, int data
)
674 static mpu_command_rec rec
;
676 rec
.cmd
= cmd
& 0xff;
677 rec
.nr_args
= ((cmd
& 0xf0) == 0xE0);
678 rec
.nr_returns
= ((cmd
& 0xf0) == 0xA0);
679 rec
.data
[0] = data
& 0xff;
681 if ((ret
= mpu401_command(dev
, &rec
)) < 0)
683 return (unsigned char) rec
.data
[0];
686 static int mpu401_prefix_cmd(int dev
, unsigned char status
)
688 struct mpu_config
*devc
= &dev_conf
[dev
];
695 if (mpu_cmd(dev
, 0xD0, 0) < 0)
702 if (mpu_cmd(dev
, 0xDF, 0) < 0)
711 static int mpu401_start_read(int dev
)
716 static int mpu401_end_read(int dev
)
721 static int mpu401_ioctl(int dev
, unsigned cmd
, void __user
*arg
)
723 struct mpu_config
*devc
;
727 devc
= &dev_conf
[dev
];
730 case SNDCTL_MIDI_MPUMODE
:
731 if (!(devc
->capabilities
& MPU_CAP_INTLG
)) { /* No intelligent mode */
732 printk(KERN_WARNING
"mpu401: Intelligent mode not supported by the HW\n");
735 if (get_user(val
, (int __user
*)arg
))
737 set_uart_mode(dev
, devc
, !val
);
740 case SNDCTL_MIDI_MPUCMD
:
741 if (copy_from_user(&rec
, arg
, sizeof(rec
)))
743 if ((ret
= mpu401_command(dev
, &rec
)) < 0)
745 if (copy_to_user(arg
, &rec
, sizeof(rec
)))
754 static void mpu401_kick(int dev
)
758 static int mpu401_buffer_status(int dev
)
765 static int mpu_synth_ioctl(int dev
, unsigned int cmd
, void __user
*arg
)
768 struct mpu_config
*devc
;
770 midi_dev
= synth_devs
[dev
]->midi_dev
;
772 if (midi_dev
< 0 || midi_dev
>= num_midis
|| midi_devs
[midi_dev
] == NULL
)
775 devc
= &dev_conf
[midi_dev
];
780 case SNDCTL_SYNTH_INFO
:
781 if (copy_to_user(arg
, &mpu_synth_info
[midi_dev
],
782 sizeof(struct synth_info
)))
786 case SNDCTL_SYNTH_MEMAVL
:
794 static int mpu_synth_open(int dev
, int mode
)
797 struct mpu_config
*devc
;
798 struct coproc_operations
*coprocessor
;
800 midi_dev
= synth_devs
[dev
]->midi_dev
;
802 if (midi_dev
< 0 || midi_dev
> num_midis
|| midi_devs
[midi_dev
] == NULL
)
805 devc
= &dev_conf
[midi_dev
];
808 * Verify that the device is really running.
809 * Some devices (such as Ensoniq SoundScape don't
810 * work before the on board processor (OBP) is initialized
811 * by downloading its microcode.
814 if (!devc
->initialized
)
816 if (mpu401_status(devc
) == 0xff) /* Bus float */
818 printk(KERN_ERR
"mpu401: Device not initialized properly\n");
825 devc
->mode
= MODE_SYNTH
;
828 devc
->inputintr
= NULL
;
830 coprocessor
= midi_devs
[midi_dev
]->coproc
;
832 if (!try_module_get(coprocessor
->owner
))
835 if ((err
= coprocessor
->open(coprocessor
->devc
, COPR_MIDI
)) < 0)
837 printk(KERN_WARNING
"mpu401: Can't access coprocessor device\n");
844 if (mode
& OPEN_READ
)
846 mpu_cmd(midi_dev
, 0x8B, 0); /* Enable data in stop mode */
847 mpu_cmd(midi_dev
, 0x34, 0); /* Return timing bytes in stop mode */
848 mpu_cmd(midi_dev
, 0x87, 0); /* Enable pitch & controller */
853 static void mpu_synth_close(int dev
)
856 struct mpu_config
*devc
;
857 struct coproc_operations
*coprocessor
;
859 midi_dev
= synth_devs
[dev
]->midi_dev
;
861 devc
= &dev_conf
[midi_dev
];
862 mpu_cmd(midi_dev
, 0x15, 0); /* Stop recording, playback and MIDI */
863 mpu_cmd(midi_dev
, 0x8a, 0); /* Disable data in stopped mode */
865 devc
->inputintr
= NULL
;
867 coprocessor
= midi_devs
[midi_dev
]->coproc
;
869 coprocessor
->close(coprocessor
->devc
, COPR_MIDI
);
870 module_put(coprocessor
->owner
);
876 #define MIDI_SYNTH_NAME "MPU-401 UART Midi"
877 #define MIDI_SYNTH_CAPS SYNTH_CAP_INPUT
878 #include "midi_synth.h"
880 static struct synth_operations mpu401_synth_proto
=
882 .owner
= THIS_MODULE
,
886 .synth_type
= SYNTH_TYPE_MIDI
,
888 .open
= mpu_synth_open
,
889 .close
= mpu_synth_close
,
890 .ioctl
= mpu_synth_ioctl
,
891 .kill_note
= midi_synth_kill_note
,
892 .start_note
= midi_synth_start_note
,
893 .set_instr
= midi_synth_set_instr
,
894 .reset
= midi_synth_reset
,
895 .hw_control
= midi_synth_hw_control
,
896 .load_patch
= midi_synth_load_patch
,
897 .aftertouch
= midi_synth_aftertouch
,
898 .controller
= midi_synth_controller
,
899 .panning
= midi_synth_panning
,
900 .bender
= midi_synth_bender
,
901 .setup_voice
= midi_synth_setup_voice
,
902 .send_sysex
= midi_synth_send_sysex
905 static struct synth_operations
*mpu401_synth_operations
[MAX_MIDI_DEV
];
907 static struct midi_operations mpu401_midi_proto
=
909 .owner
= THIS_MODULE
,
910 .info
= {"MPU-401 Midi", 0, MIDI_CAP_MPU401
, SNDCARD_MPU401
},
913 .close
= mpu401_close
,
914 .ioctl
= mpu401_ioctl
,
915 .outputc
= mpu401_out
,
916 .start_read
= mpu401_start_read
,
917 .end_read
= mpu401_end_read
,
919 .buffer_status
= mpu401_buffer_status
,
920 .prefix_cmd
= mpu401_prefix_cmd
923 static struct midi_operations mpu401_midi_operations
[MAX_MIDI_DEV
];
925 static void mpu401_chk_version(int n
, struct mpu_config
*devc
)
929 devc
->version
= devc
->revision
= 0;
931 tmp
= mpu_cmd(n
, 0xAC, 0);
934 if ((tmp
& 0xf0) > 0x20) /* Why it's larger than 2.x ??? */
938 if ((tmp
= mpu_cmd(n
, 0xAD, 0)) < 0) {
942 devc
->revision
= tmp
;
945 int attach_mpu401(struct address_info
*hw_config
, struct module
*owner
)
951 struct mpu_config
*devc
;
953 hw_config
->slots
[1] = -1;
954 m
= sound_alloc_mididev();
957 printk(KERN_WARNING
"MPU-401: Too many midi devices detected\n");
962 devc
->base
= hw_config
->io_base
;
963 devc
->osp
= hw_config
->osp
;
964 devc
->irq
= hw_config
->irq
;
967 devc
->initialized
= 0;
970 devc
->capabilities
= 0;
971 devc
->timer_flag
= 0;
973 devc
->m_state
= ST_INIT
;
974 devc
->shared_irq
= hw_config
->always_detect
;
975 devc
->irq
= hw_config
->irq
;
976 spin_lock_init(&devc
->lock
);
981 devc
->shared_irq
= 1;
984 if (!hw_config
->always_detect
)
986 /* Verify the hardware again */
987 if (!reset_mpu401(devc
))
989 printk(KERN_WARNING
"mpu401: Device didn't respond\n");
993 if (!devc
->shared_irq
)
995 if (request_irq(devc
->irq
, mpuintr
, 0, "mpu401",
998 printk(KERN_WARNING
"mpu401: Failed to allocate IRQ%d\n", devc
->irq
);
1003 spin_lock_irqsave(&devc
->lock
,flags
);
1004 mpu401_chk_version(m
, devc
);
1005 if (devc
->version
== 0)
1006 mpu401_chk_version(m
, devc
);
1007 spin_unlock_irqrestore(&devc
->lock
, flags
);
1010 if (devc
->version
!= 0)
1011 if (mpu_cmd(m
, 0xC5, 0) >= 0) /* Set timebase OK */
1012 if (mpu_cmd(m
, 0xE0, 120) >= 0) /* Set tempo OK */
1013 devc
->capabilities
|= MPU_CAP_INTLG
; /* Supports intelligent mode */
1016 mpu401_synth_operations
[m
] = kmalloc(sizeof(struct synth_operations
), GFP_KERNEL
);
1018 if (mpu401_synth_operations
[m
] == NULL
)
1020 printk(KERN_ERR
"mpu401: Can't allocate memory\n");
1024 if (!(devc
->capabilities
& MPU_CAP_INTLG
)) /* No intelligent mode */
1026 memcpy((char *) mpu401_synth_operations
[m
],
1027 (char *) &std_midi_synth
,
1028 sizeof(struct synth_operations
));
1032 memcpy((char *) mpu401_synth_operations
[m
],
1033 (char *) &mpu401_synth_proto
,
1034 sizeof(struct synth_operations
));
1037 mpu401_synth_operations
[m
]->owner
= owner
;
1039 memcpy((char *) &mpu401_midi_operations
[m
],
1040 (char *) &mpu401_midi_proto
,
1041 sizeof(struct midi_operations
));
1043 mpu401_midi_operations
[m
].converter
= mpu401_synth_operations
[m
];
1045 memcpy((char *) &mpu_synth_info
[m
],
1046 (char *) &mpu_synth_info_proto
,
1047 sizeof(struct synth_info
));
1051 if (devc
->version
== 0x20 && devc
->revision
>= 0x07) /* MusicQuest interface */
1053 int ports
= (devc
->revision
& 0x08) ? 32 : 16;
1055 devc
->capabilities
|= MPU_CAP_SYNC
| MPU_CAP_SMPTE
|
1056 MPU_CAP_CLS
| MPU_CAP_2PORT
;
1058 revision_char
= (devc
->revision
== 0x7f) ? 'M' : ' ';
1059 sprintf(mpu_synth_info
[m
].name
, "MQX-%d%c MIDI Interface #%d",
1066 revision_char
= devc
->revision
? devc
->revision
+ '@' : ' ';
1067 if ((int) devc
->revision
> ('Z' - '@'))
1068 revision_char
= '+';
1070 devc
->capabilities
|= MPU_CAP_SYNC
| MPU_CAP_FSK
;
1072 if (hw_config
->name
)
1073 sprintf(mpu_synth_info
[m
].name
, "%s (MPU401)", hw_config
->name
);
1075 sprintf(mpu_synth_info
[m
].name
,
1076 "MPU-401 %d.%d%c MIDI #%d",
1077 (int) (devc
->version
& 0xf0) >> 4,
1078 devc
->version
& 0x0f,
1083 strcpy(mpu401_midi_operations
[m
].info
.name
,
1084 mpu_synth_info
[m
].name
);
1086 conf_printf(mpu_synth_info
[m
].name
, hw_config
);
1088 mpu401_synth_operations
[m
]->midi_dev
= devc
->devno
= m
;
1089 mpu401_synth_operations
[devc
->devno
]->info
= &mpu_synth_info
[devc
->devno
];
1091 if (devc
->capabilities
& MPU_CAP_INTLG
) /* Intelligent mode */
1092 hw_config
->slots
[2] = mpu_timer_init(m
);
1094 midi_devs
[m
] = &mpu401_midi_operations
[devc
->devno
];
1097 midi_devs
[m
]->owner
= owner
;
1099 hw_config
->slots
[1] = m
;
1105 free_irq(devc
->irq
, hw_config
);
1107 sound_unload_mididev(m
);
1109 release_region(hw_config
->io_base
, 2);
1113 static int reset_mpu401(struct mpu_config
*devc
)
1115 unsigned long flags
;
1120 * Send the RESET command. Try again if no success at the first time.
1121 * (If the device is in the UART mode, it will not ack the reset cmd).
1126 timeout_limit
= devc
->initialized
? 30000 : 100000;
1127 devc
->initialized
= 1;
1129 for (n
= 0; n
< 2 && !ok
; n
++)
1131 for (timeout
= timeout_limit
; timeout
> 0 && !ok
; timeout
--)
1132 ok
= output_ready(devc
);
1134 write_command(devc
, MPU_RESET
); /*
1135 * Send MPU-401 RESET Command
1139 * Wait at least 25 msec. This method is not accurate so let's make the
1140 * loop bit longer. Cannot sleep since this is called during boot.
1143 for (timeout
= timeout_limit
* 2; timeout
> 0 && !ok
; timeout
--)
1145 spin_lock_irqsave(&devc
->lock
,flags
);
1146 if (input_avail(devc
))
1147 if (read_data(devc
) == MPU_ACK
)
1149 spin_unlock_irqrestore(&devc
->lock
,flags
);
1154 devc
->m_state
= ST_INIT
;
1157 devc
->last_status
= 0;
1158 devc
->uart_mode
= 0;
1163 static void set_uart_mode(int dev
, struct mpu_config
*devc
, int arg
)
1165 if (!arg
&& (devc
->capabilities
& MPU_CAP_INTLG
))
1167 if ((devc
->uart_mode
== 0) == (arg
== 0))
1168 return; /* Already set */
1169 reset_mpu401(devc
); /* This exits the uart mode */
1173 if (mpu_cmd(dev
, UART_MODE_ON
, 0) < 0)
1175 printk(KERN_ERR
"mpu401: Can't enter UART mode\n");
1176 devc
->uart_mode
= 0;
1180 devc
->uart_mode
= arg
;
1184 int probe_mpu401(struct address_info
*hw_config
, struct resource
*ports
)
1187 struct mpu_config tmp_devc
;
1189 tmp_devc
.base
= hw_config
->io_base
;
1190 tmp_devc
.irq
= hw_config
->irq
;
1191 tmp_devc
.initialized
= 0;
1192 tmp_devc
.opened
= 0;
1193 tmp_devc
.osp
= hw_config
->osp
;
1195 if (hw_config
->always_detect
)
1198 if (inb(hw_config
->io_base
+ 1) == 0xff)
1200 DDB(printk("MPU401: Port %x looks dead.\n", hw_config
->io_base
));
1201 return 0; /* Just bus float? */
1203 ok
= reset_mpu401(&tmp_devc
);
1207 DDB(printk("MPU401: Reset failed on port %x\n", hw_config
->io_base
));
1212 void unload_mpu401(struct address_info
*hw_config
)
1215 int n
=hw_config
->slots
[1];
1218 release_region(hw_config
->io_base
, 2);
1219 if (hw_config
->always_detect
== 0 && hw_config
->irq
> 0)
1220 free_irq(hw_config
->irq
, hw_config
);
1221 p
=mpu401_synth_operations
[n
];
1222 sound_unload_mididev(n
);
1223 sound_unload_timerdev(hw_config
->slots
[2]);
1228 /*****************************************************
1230 ****************************************************/
1232 static volatile int timer_initialized
= 0, timer_open
= 0, tmr_running
= 0;
1233 static volatile int curr_tempo
, curr_timebase
, hw_timebase
;
1234 static int max_timebase
= 8; /* 8*24=192 ppqn */
1235 static volatile unsigned long next_event_time
;
1236 static volatile unsigned long curr_ticks
, curr_clocks
;
1237 static unsigned long prev_event_time
;
1238 static int metronome_mode
;
1240 static unsigned long clocks2ticks(unsigned long clocks
)
1243 * The MPU-401 supports just a limited set of possible timebase values.
1244 * Since the applications require more choices, the driver has to
1245 * program the HW to do its best and to convert between the HW and
1248 return ((clocks
* curr_timebase
) + (hw_timebase
/ 2)) / hw_timebase
;
1251 static void set_timebase(int midi_dev
, int val
)
1261 hw_val
= (hw_val
+ 12) / 24;
1262 if (hw_val
> max_timebase
)
1263 hw_val
= max_timebase
;
1265 if (mpu_cmd(midi_dev
, 0xC0 | (hw_val
& 0x0f), 0) < 0)
1267 printk(KERN_WARNING
"mpu401: Can't set HW timebase to %d\n", hw_val
* 24);
1270 hw_timebase
= hw_val
* 24;
1271 curr_timebase
= val
;
1275 static void tmr_reset(struct mpu_config
*devc
)
1277 unsigned long flags
;
1279 spin_lock_irqsave(&devc
->lock
,flags
);
1280 next_event_time
= (unsigned long) -1;
1281 prev_event_time
= 0;
1282 curr_ticks
= curr_clocks
= 0;
1283 spin_unlock_irqrestore(&devc
->lock
,flags
);
1286 static void set_timer_mode(int midi_dev
)
1288 if (timer_mode
& TMR_MODE_CLS
)
1289 mpu_cmd(midi_dev
, 0x3c, 0); /* Use CLS sync */
1290 else if (timer_mode
& TMR_MODE_SMPTE
)
1291 mpu_cmd(midi_dev
, 0x3d, 0); /* Use SMPTE sync */
1293 if (timer_mode
& TMR_INTERNAL
)
1295 mpu_cmd(midi_dev
, 0x80, 0); /* Use MIDI sync */
1299 if (timer_mode
& (TMR_MODE_MIDI
| TMR_MODE_CLS
))
1301 mpu_cmd(midi_dev
, 0x82, 0); /* Use MIDI sync */
1302 mpu_cmd(midi_dev
, 0x91, 0); /* Enable ext MIDI ctrl */
1304 else if (timer_mode
& TMR_MODE_FSK
)
1305 mpu_cmd(midi_dev
, 0x81, 0); /* Use FSK sync */
1309 static void stop_metronome(int midi_dev
)
1311 mpu_cmd(midi_dev
, 0x84, 0); /* Disable metronome */
1314 static void setup_metronome(int midi_dev
)
1316 int numerator
, denominator
;
1317 int clks_per_click
, num_32nds_per_beat
;
1318 int beats_per_measure
;
1320 numerator
= ((unsigned) metronome_mode
>> 24) & 0xff;
1321 denominator
= ((unsigned) metronome_mode
>> 16) & 0xff;
1322 clks_per_click
= ((unsigned) metronome_mode
>> 8) & 0xff;
1323 num_32nds_per_beat
= (unsigned) metronome_mode
& 0xff;
1324 beats_per_measure
= (numerator
* 4) >> denominator
;
1326 if (!metronome_mode
)
1327 mpu_cmd(midi_dev
, 0x84, 0); /* Disable metronome */
1330 mpu_cmd(midi_dev
, 0xE4, clks_per_click
);
1331 mpu_cmd(midi_dev
, 0xE6, beats_per_measure
);
1332 mpu_cmd(midi_dev
, 0x83, 0); /* Enable metronome without accents */
1336 static int mpu_start_timer(int midi_dev
)
1338 struct mpu_config
*devc
= &dev_conf
[midi_dev
];
1341 set_timer_mode(midi_dev
);
1344 return TIMER_NOT_ARMED
; /* Already running */
1346 if (timer_mode
& TMR_INTERNAL
)
1348 mpu_cmd(midi_dev
, 0x02, 0); /* Send MIDI start */
1350 return TIMER_NOT_ARMED
;
1354 mpu_cmd(midi_dev
, 0x35, 0); /* Enable mode messages to PC */
1355 mpu_cmd(midi_dev
, 0x38, 0); /* Enable sys common messages to PC */
1356 mpu_cmd(midi_dev
, 0x39, 0); /* Enable real time messages to PC */
1357 mpu_cmd(midi_dev
, 0x97, 0); /* Enable system exclusive messages to PC */
1362 static int mpu_timer_open(int dev
, int mode
)
1364 int midi_dev
= sound_timer_devs
[dev
]->devlink
;
1365 struct mpu_config
*devc
= &dev_conf
[midi_dev
];
1372 mpu_cmd(midi_dev
, 0xE0, 50);
1373 curr_timebase
= hw_timebase
= 120;
1374 set_timebase(midi_dev
, 120);
1377 set_timer_mode(midi_dev
);
1379 mpu_cmd(midi_dev
, 0xe7, 0x04); /* Send all clocks to host */
1380 mpu_cmd(midi_dev
, 0x95, 0); /* Enable clock to host */
1385 static void mpu_timer_close(int dev
)
1387 int midi_dev
= sound_timer_devs
[dev
]->devlink
;
1389 timer_open
= tmr_running
= 0;
1390 mpu_cmd(midi_dev
, 0x15, 0); /* Stop all */
1391 mpu_cmd(midi_dev
, 0x94, 0); /* Disable clock to host */
1392 mpu_cmd(midi_dev
, 0x8c, 0); /* Disable measure end messages to host */
1393 stop_metronome(midi_dev
);
1396 static int mpu_timer_event(int dev
, unsigned char *event
)
1398 unsigned char command
= event
[1];
1399 unsigned long parm
= *(unsigned int *) &event
[4];
1400 int midi_dev
= sound_timer_devs
[dev
]->devlink
;
1405 parm
+= prev_event_time
;
1411 if (parm
<= curr_ticks
) /* It's the time */
1412 return TIMER_NOT_ARMED
;
1414 next_event_time
= prev_event_time
= time
;
1423 return mpu_start_timer(midi_dev
);
1426 mpu_cmd(midi_dev
, 0x01, 0); /* Send MIDI stop */
1427 stop_metronome(midi_dev
);
1434 mpu_cmd(midi_dev
, 0x03, 0); /* Send MIDI continue */
1435 setup_metronome(midi_dev
);
1446 if (mpu_cmd(midi_dev
, 0xE0, parm
) < 0)
1447 printk(KERN_WARNING
"mpu401: Can't set tempo to %d\n", (int) parm
);
1453 seq_copy_to_input(event
, 8);
1457 if (metronome_mode
) /* Metronome enabled */
1459 metronome_mode
= parm
;
1460 setup_metronome(midi_dev
);
1466 return TIMER_NOT_ARMED
;
1469 static unsigned long mpu_timer_get_time(int dev
)
1477 static int mpu_timer_ioctl(int dev
, unsigned int command
, void __user
*arg
)
1479 int midi_dev
= sound_timer_devs
[dev
]->devlink
;
1480 int __user
*p
= (int __user
*)arg
;
1484 case SNDCTL_TMR_SOURCE
:
1488 if (get_user(parm
, p
))
1496 if (timer_mode
& TMR_MODE_CLS
)
1497 mpu_cmd(midi_dev
, 0x3c, 0); /* Use CLS sync */
1498 else if (timer_mode
& TMR_MODE_SMPTE
)
1499 mpu_cmd(midi_dev
, 0x3d, 0); /* Use SMPTE sync */
1501 if (put_user(timer_mode
, p
))
1507 case SNDCTL_TMR_START
:
1508 mpu_start_timer(midi_dev
);
1511 case SNDCTL_TMR_STOP
:
1513 mpu_cmd(midi_dev
, 0x01, 0); /* Send MIDI stop */
1514 stop_metronome(midi_dev
);
1517 case SNDCTL_TMR_CONTINUE
:
1521 mpu_cmd(midi_dev
, 0x03, 0); /* Send MIDI continue */
1524 case SNDCTL_TMR_TIMEBASE
:
1527 if (get_user(val
, p
))
1530 set_timebase(midi_dev
, val
);
1531 if (put_user(curr_timebase
, p
))
1533 return curr_timebase
;
1537 case SNDCTL_TMR_TEMPO
:
1542 if (get_user(val
, p
))
1551 if ((ret
= mpu_cmd(midi_dev
, 0xE0, val
)) < 0)
1553 printk(KERN_WARNING
"mpu401: Can't set tempo to %d\n", (int) val
);
1558 if (put_user(curr_tempo
, p
))
1564 case SNDCTL_SEQ_CTRLRATE
:
1567 if (get_user(val
, p
))
1570 if (val
!= 0) /* Can't change */
1572 val
= ((curr_tempo
* curr_timebase
) + 30)/60;
1573 if (put_user(val
, p
))
1579 case SNDCTL_SEQ_GETTIME
:
1580 if (put_user(curr_ticks
, p
))
1584 case SNDCTL_TMR_METRONOME
:
1585 if (get_user(metronome_mode
, p
))
1587 setup_metronome(midi_dev
);
1595 static void mpu_timer_arm(int dev
, long time
)
1598 time
= curr_ticks
+ 1;
1599 else if (time
<= curr_ticks
) /* It's the time */
1601 next_event_time
= prev_event_time
= time
;
1605 static struct sound_timer_operations mpu_timer
=
1607 .owner
= THIS_MODULE
,
1608 .info
= {"MPU-401 Timer", 0},
1609 .priority
= 10, /* Priority */
1610 .devlink
= 0, /* Local device link */
1611 .open
= mpu_timer_open
,
1612 .close
= mpu_timer_close
,
1613 .event
= mpu_timer_event
,
1614 .get_time
= mpu_timer_get_time
,
1615 .ioctl
= mpu_timer_ioctl
,
1616 .arm_timer
= mpu_timer_arm
1619 static void mpu_timer_interrupt(void)
1628 curr_ticks
= clocks2ticks(curr_clocks
);
1630 if (curr_ticks
>= next_event_time
)
1632 next_event_time
= (unsigned long) -1;
1637 static void timer_ext_event(struct mpu_config
*devc
, int event
, int parm
)
1639 int midi_dev
= devc
->devno
;
1641 if (!devc
->timer_flag
)
1647 printk("<MIDI clk>");
1651 printk("Ext MIDI start\n");
1654 if (timer_mode
& TMR_EXTERNAL
)
1657 setup_metronome(midi_dev
);
1658 next_event_time
= 0;
1659 STORE(SEQ_START_TIMER());
1665 printk("Ext MIDI stop\n");
1666 if (timer_mode
& TMR_EXTERNAL
)
1669 stop_metronome(midi_dev
);
1670 STORE(SEQ_STOP_TIMER());
1675 printk("Ext MIDI continue\n");
1676 if (timer_mode
& TMR_EXTERNAL
)
1679 setup_metronome(midi_dev
);
1680 STORE(SEQ_CONTINUE_TIMER());
1685 printk("Songpos: %d\n", parm
);
1686 if (timer_mode
& TMR_EXTERNAL
)
1688 STORE(SEQ_SONGPOS(parm
));
1694 static int mpu_timer_init(int midi_dev
)
1696 struct mpu_config
*devc
;
1699 devc
= &dev_conf
[midi_dev
];
1701 if (timer_initialized
)
1702 return -1; /* There is already a similar timer */
1704 timer_initialized
= 1;
1706 mpu_timer
.devlink
= midi_dev
;
1707 dev_conf
[midi_dev
].timer_flag
= 1;
1709 n
= sound_alloc_timerdev();
1712 sound_timer_devs
[n
] = &mpu_timer
;
1714 if (devc
->version
< 0x20) /* Original MPU-401 */
1715 timer_caps
= TMR_INTERNAL
| TMR_EXTERNAL
| TMR_MODE_FSK
| TMR_MODE_MIDI
;
1719 * The version number 2.0 is used (at least) by the
1720 * MusicQuest cards and the Roland Super-MPU.
1722 * MusicQuest has given a special meaning to the bits of the
1723 * revision number. The Super-MPU returns 0.
1727 timer_caps
|= TMR_EXTERNAL
| TMR_MODE_MIDI
;
1729 if (devc
->revision
& 0x02)
1730 timer_caps
|= TMR_MODE_CLS
;
1733 if (devc
->revision
& 0x40)
1734 max_timebase
= 10; /* Has the 216 and 240 ppqn modes */
1737 timer_mode
= (TMR_INTERNAL
| TMR_MODE_MIDI
) & timer_caps
;
1742 EXPORT_SYMBOL(probe_mpu401
);
1743 EXPORT_SYMBOL(attach_mpu401
);
1744 EXPORT_SYMBOL(unload_mpu401
);
1746 static struct address_info cfg
;
1749 static int irq
= -1;
1751 module_param(irq
, int, 0);
1752 module_param(io
, int, 0);
1754 static int __init
init_mpu401(void)
1757 /* Can be loaded either for module use or to provide functions
1759 if (io
!= -1 && irq
!= -1) {
1760 struct resource
*ports
;
1763 ports
= request_region(io
, 2, "mpu401");
1766 if (probe_mpu401(&cfg
, ports
) == 0) {
1767 release_region(io
, 2);
1770 if ((ret
= attach_mpu401(&cfg
, THIS_MODULE
)))
1777 static void __exit
cleanup_mpu401(void)
1779 if (io
!= -1 && irq
!= -1) {
1780 /* Check for use by, for example, sscape driver */
1781 unload_mpu401(&cfg
);
1785 module_init(init_mpu401
);
1786 module_exit(cleanup_mpu401
);
1789 static int __init
setup_mpu401(char *str
)
1794 str
= get_options(str
, ARRAY_SIZE(ints
), ints
);
1802 __setup("mpu401=", setup_mpu401
);
1804 MODULE_LICENSE("GPL");