Documentation/sound/cards/serial-u16550.rst

   1 ===================================
   2 Serial UART 16450/16550 MIDI driver
   3 ===================================
   4
   5 The adaptor module parameter allows you to select either:
   6
   7 * 0 - Roland Soundcanvas support (default)
   8 * 1 - Midiator MS-124T support (1)
   9 * 2 - Midiator MS-124W S/A mode (2)
  10 * 3 - MS-124W M/B mode support (3)
  11 * 4 - Generic device with multiple input support (4)
  12
  13 For the Midiator MS-124W, you must set the physical M-S and A-B
  14 switches on the Midiator to match the driver mode you select.
  15
  16 In Roland Soundcanvas mode, multiple ALSA raw MIDI substreams are supported
  17 (midiCnD0-midiCnD15).  Whenever you write to a different substream, the driver
  18 sends the nonstandard MIDI command sequence F5 NN, where NN is the substream
  19 number plus 1.  Roland modules use this command to switch between different
  20 "parts", so this feature lets you treat each part as a distinct raw MIDI
  21 substream. The driver provides no way to send F5 00 (no selection) or to not
  22 send the F5 NN command sequence at all; perhaps it ought to.
  23
  24 Usage example for simple serial converter:
  25 ::
  26
  27         /sbin/setserial /dev/ttyS0 uart none
  28         /sbin/modprobe snd-serial-u16550 port=0x3f8 irq=4 speed=115200
  29
  30 Usage example for Roland SoundCanvas with 4 MIDI ports:
  31 ::
  32
  33         /sbin/setserial /dev/ttyS0 uart none
  34         /sbin/modprobe snd-serial-u16550 port=0x3f8 irq=4 outs=4
  35
  36 In MS-124T mode, one raw MIDI substream is supported (midiCnD0); the outs
  37 module parameter is automatically set to 1. The driver sends the same data to
  38 all four MIDI Out connectors.  Set the A-B switch and the speed module
  39 parameter to match (A=19200, B=9600).
  40
  41 Usage example for MS-124T, with A-B switch in A position:
  42 ::
  43
  44         /sbin/setserial /dev/ttyS0 uart none
  45         /sbin/modprobe snd-serial-u16550 port=0x3f8 irq=4 adaptor=1 \
  46                         speed=19200
  47
  48 In MS-124W S/A mode, one raw MIDI substream is supported (midiCnD0);
  49 the outs module parameter is automatically set to 1. The driver sends
  50 the same data to all four MIDI Out connectors at full MIDI speed.
  51
  52 Usage example for S/A mode:
  53 ::
  54
  55         /sbin/setserial /dev/ttyS0 uart none
  56         /sbin/modprobe snd-serial-u16550 port=0x3f8 irq=4 adaptor=2
  57
  58 In MS-124W M/B mode, the driver supports 16 ALSA raw MIDI substreams;
  59 the outs module parameter is automatically set to 16.  The substream
  60 number gives a bitmask of which MIDI Out connectors the data should be
  61 sent to, with midiCnD1 sending to Out 1, midiCnD2 to Out 2, midiCnD4 to
  62 Out 3, and midiCnD8 to Out 4.  Thus midiCnD15 sends the data to all 4 ports.
  63 As a special case, midiCnD0 also sends to all ports, since it is not useful
  64 to send the data to no ports.  M/B mode has extra overhead to select the MIDI
  65 Out for each byte, so the aggregate data rate across all four MIDI Outs is
  66 at most one byte every 520 us, as compared with the full MIDI data rate of
  67 one byte every 320 us per port.
  68
  69 Usage example for M/B mode:
  70 ::
  71
  72         /sbin/setserial /dev/ttyS0 uart none
  73         /sbin/modprobe snd-serial-u16550 port=0x3f8 irq=4 adaptor=3
  74
  75 The MS-124W hardware's M/A mode is currently not supported. This mode allows
  76 the MIDI Outs to act independently at double the aggregate throughput of M/B,
  77 but does not allow sending the same byte simultaneously to multiple MIDI Outs.
  78 The M/A protocol requires the driver to twiddle the modem control lines under
  79 timing constraints, so it would be a bit more complicated to implement than
  80 the other modes.
  81
  82 Midiator models other than MS-124W and MS-124T are currently not supported.
  83 Note that the suffix letter is significant; the MS-124 and MS-124B are not
  84 compatible, nor are the other known models MS-101, MS-101B, MS-103, and MS-114.
  85 I do have documentation (tim.mann@compaq.com) that partially covers these models,
  86 but no units to experiment with.  The MS-124W support is tested with a real unit.
  87 The MS-124T support is untested, but should work.
  88
  89 The Generic driver supports multiple input and output substreams over a single
  90 serial port.  Similar to Roland Soundcanvas mode, F5 NN is used to select the
  91 appropriate input or output stream (depending on the data direction).
  92 Additionally, the CTS signal is used to regulate the data flow.  The number of
  93 inputs is specified by the ins parameter.