2011-03-15 14:53:21 +08:00
|
|
|
#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
|
|
|
|
|
#define SOUND_FIREWIRE_AMDTP_H_INCLUDED
|
|
|
|
|
|
2011-09-05 04:15:44 +08:00
|
|
|
#include <linux/err.h>
|
2012-05-14 04:03:09 +08:00
|
|
|
#include <linux/interrupt.h>
|
2011-03-15 14:53:21 +08:00
|
|
|
#include <linux/mutex.h>
|
2015-09-19 10:21:55 +08:00
|
|
|
#include <linux/sched.h>
|
2013-11-19 12:29:24 +08:00
|
|
|
#include <sound/asound.h>
|
2011-03-15 14:53:21 +08:00
|
|
|
#include "packets-buffer.h"
|
|
|
|
|
|
|
|
|
|
/**
|
2014-04-25 21:44:42 +08:00
|
|
|
* enum cip_flags - describes details of the streaming protocol
|
2011-03-15 14:53:21 +08:00
|
|
|
* @CIP_NONBLOCKING: In non-blocking mode, each packet contains
|
|
|
|
|
* sample_rate/8000 samples, with rounding up or down to adjust
|
|
|
|
|
* for clock skew and left-over fractional samples. This should
|
|
|
|
|
* be used if supported by the device.
|
2011-09-05 04:12:48 +08:00
|
|
|
* @CIP_BLOCKING: In blocking mode, each packet contains either zero or
|
|
|
|
|
* SYT_INTERVAL samples, with these two types alternating so that
|
|
|
|
|
* the overall sample rate comes out right.
|
2014-04-25 21:45:03 +08:00
|
|
|
* @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
|
2017-03-22 20:30:17 +08:00
|
|
|
* @CIP_DBC_IS_END_EVENT: The value of dbc in an packet corresponds to the end
|
|
|
|
|
* of event in the packet. Out of IEC 61883.
|
2014-04-25 21:45:05 +08:00
|
|
|
* @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets.
|
|
|
|
|
* The value of data_block_quadlets is used instead of reported value.
|
2014-11-18 22:59:40 +08:00
|
|
|
* @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is
|
2014-04-25 21:45:07 +08:00
|
|
|
* skipped for detecting discontinuity.
|
2014-04-25 21:45:27 +08:00
|
|
|
* @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
|
|
|
|
|
* packet is wrong but the others are correct.
|
ALSA: firewire-lib: add buffer-over-run protection at receiving more data blocks than expected
In IEC 61883-6, the number of data blocks in a packet is limited up to
the value of SYT_INTERVAL. Current implementation is compliant to the
limitation, while it can cause buffer-over-run when the value of dbs
field in received packet is illegally large.
This commit adds a validator to detect such illegal packets to prevent
the buffer-over-run. Actually, the buffer is aligned to the size of memory
page, thus this issue hardly causes system errors due to the room to page
alignment, as long as a few packets includes such jumbo payload; i.e.
a packet to several received packets.
Here, Behringer F-Control Audio 202 (based on OXFW 960) has a quirk to
postpone transferring isochronous packet till finish handling any
asynchronous packets. In this case, this model is lazy, transfers no
packets according to several cycle-start packets. After finishing, this
model pushes required data in next isochronous packet. As a result, the
packet include more data blocks than IEC 61883-6 defines.
To continue to support this model, this commit adds a new flag to extend
the length of calculated payload. This flag allows the size of payload
5 times as large as IEC 61883-6 defines. As a result, packets from this
model passed the validator successfully.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-05-22 22:00:50 +08:00
|
|
|
* @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an
|
|
|
|
|
* packet is larger than IEC 61883-6 defines. Current implementation
|
|
|
|
|
* allows 5 times as large as IEC 61883-6 defines.
|
2017-03-22 20:30:27 +08:00
|
|
|
* @CIP_HEADER_WITHOUT_EOH: Only for in-stream. CIP Header doesn't include
|
|
|
|
|
* valid EOH.
|
ALSA: firewire-lib: add no-header packet processing
As long as investigating Fireface 400, IEC 61883-1/6 is not applied to
its packet streaming protocol. Remarks of the specific protocol are:
* Each packet doesn't include CIP headers.
* 64,0 and 128,0 kHz are supported.
* The device doesn't necessarily transmit 8,000 packets per second.
* 0, 1, 2, 3 are used as tag for rx isochronous packets, however 0 is
used for tx isochronous packets.
On the other hand, there's a common feature. The number of data blocks
transferred in a second is the same as sampling transmission frequency.
Current ALSA IEC 61883-1/6 engine already has a method to calculate it and
this driver can utilize it for rx packets, as well as tx packets.
This commit adds support for the transferring protocol. CIP_NO_HEADERS
flag is newly added. When this flag is set:
* Both of 0 (without CIP header) and 1 (with CIP header) are used as tag
to handle incoming isochronous packet.
* 0 (without CIP header) is used as tag to transfer outgoing isochronous
packet.
* Skip CIP header evaluation.
* Use unique way to calculate the quadlets of isochronous packet payload.
In ALSA PCM interface, 128.0 kHz is not supported, and the ALSA
IEC 61883-1/6 engine doesn't support 64.0 kHz. These modes are dropped.
The sequence of rx packet has a remarkable quirk about tag. This will be
described in later commits.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 21:06:07 +08:00
|
|
|
* @CIP_NO_HEADERS: a lack of headers in packets
|
2011-03-15 14:53:21 +08:00
|
|
|
*/
|
2014-04-25 21:44:42 +08:00
|
|
|
enum cip_flags {
|
2014-04-25 21:44:49 +08:00
|
|
|
CIP_NONBLOCKING = 0x00,
|
|
|
|
|
CIP_BLOCKING = 0x01,
|
ALSA: firewire-lib: handle IT/IR contexts in each software interrupt context
In clause 6.3 of IEC 61883-6:2000, there's an explanation about processing
of presentation timestamp. In the clause, we can see "If a function block
receives a CIP, processes it and subsequently re-transmits it, then the
SYT of the outgoing CIP shall be the sum of the incoming SYT and the
processing delay." ALSA firewire stack has an implementation to partly
satisfy this specification. Developers assumed the stack to perform as an
Audio function block[1].
Following to the assumption, current implementation of ALSA firewire stack
use one software interrupt context to handle both of in/out packets. In
most case, this is processed in 1394 OHCI IR context independently of the
opposite context. Thus, this implementation uses longer CPU time in the
software interrupt context. This is not better for whole system.
Against the assumption, I confirmed that each ASIC for IEC 61883-1/6
doesn't necessarily expect it to the stack. Thus, current implementation
of ALSA firewire stack includes over-engineering.
This commit purges the implementation. As a result, packets of one
direction are handled in one software interrupt context and spends
minimum CPU time.
[1] [alsa-devel] [PATCH 0/8] [RFC] new driver for Echo Audio's Fireworks based devices
http://mailman.alsa-project.org/pipermail/alsa-devel/2013-June/062660.html
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 22:15:53 +08:00
|
|
|
CIP_EMPTY_WITH_TAG0 = 0x02,
|
|
|
|
|
CIP_DBC_IS_END_EVENT = 0x04,
|
|
|
|
|
CIP_WRONG_DBS = 0x08,
|
|
|
|
|
CIP_SKIP_DBC_ZERO_CHECK = 0x10,
|
2016-05-09 22:15:56 +08:00
|
|
|
CIP_EMPTY_HAS_WRONG_DBC = 0x20,
|
|
|
|
|
CIP_JUMBO_PAYLOAD = 0x40,
|
2017-03-22 20:30:27 +08:00
|
|
|
CIP_HEADER_WITHOUT_EOH = 0x80,
|
ALSA: firewire-lib: add no-header packet processing
As long as investigating Fireface 400, IEC 61883-1/6 is not applied to
its packet streaming protocol. Remarks of the specific protocol are:
* Each packet doesn't include CIP headers.
* 64,0 and 128,0 kHz are supported.
* The device doesn't necessarily transmit 8,000 packets per second.
* 0, 1, 2, 3 are used as tag for rx isochronous packets, however 0 is
used for tx isochronous packets.
On the other hand, there's a common feature. The number of data blocks
transferred in a second is the same as sampling transmission frequency.
Current ALSA IEC 61883-1/6 engine already has a method to calculate it and
this driver can utilize it for rx packets, as well as tx packets.
This commit adds support for the transferring protocol. CIP_NO_HEADERS
flag is newly added. When this flag is set:
* Both of 0 (without CIP header) and 1 (with CIP header) are used as tag
to handle incoming isochronous packet.
* 0 (without CIP header) is used as tag to transfer outgoing isochronous
packet.
* Skip CIP header evaluation.
* Use unique way to calculate the quadlets of isochronous packet payload.
In ALSA PCM interface, 128.0 kHz is not supported, and the ALSA
IEC 61883-1/6 engine doesn't support 64.0 kHz. These modes are dropped.
The sequence of rx packet has a remarkable quirk about tag. This will be
described in later commits.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 21:06:07 +08:00
|
|
|
CIP_NO_HEADER = 0x100,
|
2011-03-15 14:53:21 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2014-11-18 22:59:40 +08:00
|
|
|
* enum cip_sfc - supported Sampling Frequency Codes (SFCs)
|
|
|
|
|
* @CIP_SFC_32000: 32,000 data blocks
|
|
|
|
|
* @CIP_SFC_44100: 44,100 data blocks
|
|
|
|
|
* @CIP_SFC_48000: 48,000 data blocks
|
|
|
|
|
* @CIP_SFC_88200: 88,200 data blocks
|
|
|
|
|
* @CIP_SFC_96000: 96,000 data blocks
|
|
|
|
|
* @CIP_SFC_176400: 176,400 data blocks
|
|
|
|
|
* @CIP_SFC_192000: 192,000 data blocks
|
|
|
|
|
* @CIP_SFC_COUNT: the number of supported SFCs
|
|
|
|
|
*
|
|
|
|
|
* These values are used to show nominal Sampling Frequency Code in
|
|
|
|
|
* Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
|
|
|
|
|
* this code means the number of events per second. Actually the code
|
|
|
|
|
* represents the number of data blocks transferred per second in an AMDTP
|
|
|
|
|
* stream.
|
|
|
|
|
*
|
|
|
|
|
* In IEC 61883-6:2005, some extensions were added to support more types of
|
|
|
|
|
* data such as 'One Bit LInear Audio', therefore the meaning of SFC became
|
|
|
|
|
* different depending on the types.
|
|
|
|
|
*
|
|
|
|
|
* Currently our implementation is compatible with IEC 61883-6:2002.
|
2011-03-15 14:53:21 +08:00
|
|
|
*/
|
|
|
|
|
enum cip_sfc {
|
|
|
|
|
CIP_SFC_32000 = 0,
|
|
|
|
|
CIP_SFC_44100 = 1,
|
|
|
|
|
CIP_SFC_48000 = 2,
|
|
|
|
|
CIP_SFC_88200 = 3,
|
|
|
|
|
CIP_SFC_96000 = 4,
|
|
|
|
|
CIP_SFC_176400 = 5,
|
|
|
|
|
CIP_SFC_192000 = 6,
|
2011-09-05 04:16:10 +08:00
|
|
|
CIP_SFC_COUNT
|
2011-03-15 14:53:21 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct fw_unit;
|
|
|
|
|
struct fw_iso_context;
|
|
|
|
|
struct snd_pcm_substream;
|
2014-04-25 21:44:52 +08:00
|
|
|
struct snd_pcm_runtime;
|
2011-03-15 14:53:21 +08:00
|
|
|
|
2014-04-25 21:44:44 +08:00
|
|
|
enum amdtp_stream_direction {
|
|
|
|
|
AMDTP_OUT_STREAM = 0,
|
|
|
|
|
AMDTP_IN_STREAM
|
|
|
|
|
};
|
|
|
|
|
|
2015-09-19 10:22:02 +08:00
|
|
|
struct amdtp_stream;
|
|
|
|
|
typedef unsigned int (*amdtp_stream_process_data_blocks_t)(
|
|
|
|
|
struct amdtp_stream *s,
|
|
|
|
|
__be32 *buffer,
|
|
|
|
|
unsigned int data_blocks,
|
|
|
|
|
unsigned int *syt);
|
2014-04-25 21:44:42 +08:00
|
|
|
struct amdtp_stream {
|
2011-03-15 14:53:21 +08:00
|
|
|
struct fw_unit *unit;
|
2014-04-25 21:44:42 +08:00
|
|
|
enum cip_flags flags;
|
2014-04-25 21:44:44 +08:00
|
|
|
enum amdtp_stream_direction direction;
|
2011-03-15 14:53:21 +08:00
|
|
|
struct mutex mutex;
|
|
|
|
|
|
2015-09-19 10:21:48 +08:00
|
|
|
/* For packet processing. */
|
|
|
|
|
struct fw_iso_context *context;
|
2011-03-15 14:53:21 +08:00
|
|
|
struct iso_packets_buffer buffer;
|
2011-03-15 14:57:24 +08:00
|
|
|
int packet_index;
|
ALSA: firewire-lib: add no-header packet processing
As long as investigating Fireface 400, IEC 61883-1/6 is not applied to
its packet streaming protocol. Remarks of the specific protocol are:
* Each packet doesn't include CIP headers.
* 64,0 and 128,0 kHz are supported.
* The device doesn't necessarily transmit 8,000 packets per second.
* 0, 1, 2, 3 are used as tag for rx isochronous packets, however 0 is
used for tx isochronous packets.
On the other hand, there's a common feature. The number of data blocks
transferred in a second is the same as sampling transmission frequency.
Current ALSA IEC 61883-1/6 engine already has a method to calculate it and
this driver can utilize it for rx packets, as well as tx packets.
This commit adds support for the transferring protocol. CIP_NO_HEADERS
flag is newly added. When this flag is set:
* Both of 0 (without CIP header) and 1 (with CIP header) are used as tag
to handle incoming isochronous packet.
* 0 (without CIP header) is used as tag to transfer outgoing isochronous
packet.
* Skip CIP header evaluation.
* Use unique way to calculate the quadlets of isochronous packet payload.
In ALSA PCM interface, 128.0 kHz is not supported, and the ALSA
IEC 61883-1/6 engine doesn't support 64.0 kHz. These modes are dropped.
The sequence of rx packet has a remarkable quirk about tag. This will be
described in later commits.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 21:06:07 +08:00
|
|
|
int tag;
|
|
|
|
|
int (*handle_packet)(struct amdtp_stream *s,
|
|
|
|
|
unsigned int payload_quadlets, unsigned int cycle,
|
|
|
|
|
unsigned int index);
|
2017-04-11 19:33:18 +08:00
|
|
|
unsigned int max_payload_length;
|
2015-09-19 10:21:48 +08:00
|
|
|
|
|
|
|
|
/* For CIP headers. */
|
|
|
|
|
unsigned int source_node_id_field;
|
|
|
|
|
unsigned int data_block_quadlets;
|
2011-03-15 14:53:21 +08:00
|
|
|
unsigned int data_block_counter;
|
2017-03-22 20:30:16 +08:00
|
|
|
unsigned int sph;
|
2015-09-19 10:21:53 +08:00
|
|
|
unsigned int fmt;
|
|
|
|
|
unsigned int fdf;
|
2015-09-19 10:21:48 +08:00
|
|
|
/* quirk: fixed interval of dbc between previos/current packets. */
|
|
|
|
|
unsigned int tx_dbc_interval;
|
|
|
|
|
/* quirk: indicate the value of dbc field in a first packet. */
|
|
|
|
|
unsigned int tx_first_dbc;
|
2011-03-15 14:53:21 +08:00
|
|
|
|
2015-09-19 10:21:48 +08:00
|
|
|
/* Internal flags. */
|
|
|
|
|
enum cip_sfc sfc;
|
|
|
|
|
unsigned int syt_interval;
|
|
|
|
|
unsigned int transfer_delay;
|
2011-03-15 14:53:21 +08:00
|
|
|
unsigned int data_block_state;
|
|
|
|
|
unsigned int last_syt_offset;
|
|
|
|
|
unsigned int syt_offset_state;
|
|
|
|
|
|
2015-09-19 10:21:48 +08:00
|
|
|
/* For a PCM substream processing. */
|
|
|
|
|
struct snd_pcm_substream *pcm;
|
|
|
|
|
struct tasklet_struct period_tasklet;
|
ALSA: firewire-lib: Fix stall of process context at packet error
At Linux v3.5, packet processing can be done in process context of ALSA
PCM application as well as software IRQ context for OHCI 1394. Below is
an example of the callgraph (some calls are omitted).
ioctl(2) with e.g. HWSYNC
(sound/core/pcm_native.c)
->snd_pcm_common_ioctl1()
->snd_pcm_hwsync()
->snd_pcm_stream_lock_irq
(sound/core/pcm_lib.c)
->snd_pcm_update_hw_ptr()
->snd_pcm_udpate_hw_ptr0()
->struct snd_pcm_ops.pointer()
(sound/firewire/*)
= Each handler on drivers in ALSA firewire stack
(sound/firewire/amdtp-stream.c)
->amdtp_stream_pcm_pointer()
(drivers/firewire/core-iso.c)
->fw_iso_context_flush_completions()
->struct fw_card_driver.flush_iso_completion()
(drivers/firewire/ohci.c)
= flush_iso_completions()
->struct fw_iso_context.callback.sc
(sound/firewire/amdtp-stream.c)
= in_stream_callback() or out_stream_callback()
->...
->snd_pcm_stream_unlock_irq
When packet queueing error occurs or detecting invalid packets in
'in_stream_callback()' or 'out_stream_callback()', 'snd_pcm_stop_xrun()'
is called on local CPU with disabled IRQ.
(sound/firewire/amdtp-stream.c)
in_stream_callback() or out_stream_callback()
->amdtp_stream_pcm_abort()
->snd_pcm_stop_xrun()
->snd_pcm_stream_lock_irqsave()
->snd_pcm_stop()
->snd_pcm_stream_unlock_irqrestore()
The process is stalled on the CPU due to attempt to acquire recursive lock.
[ 562.630853] INFO: rcu_sched detected stalls on CPUs/tasks:
[ 562.630861] 2-...: (1 GPs behind) idle=37d/140000000000000/0 softirq=38323/38323 fqs=7140
[ 562.630862] (detected by 3, t=15002 jiffies, g=21036, c=21035, q=5933)
[ 562.630866] Task dump for CPU 2:
[ 562.630867] alsa-source-OXF R running task 0 6619 1 0x00000008
[ 562.630870] Call Trace:
[ 562.630876] ? vt_console_print+0x79/0x3e0
[ 562.630880] ? msg_print_text+0x9d/0x100
[ 562.630883] ? up+0x32/0x50
[ 562.630885] ? irq_work_queue+0x8d/0xa0
[ 562.630886] ? console_unlock+0x2b6/0x4b0
[ 562.630888] ? vprintk_emit+0x312/0x4a0
[ 562.630892] ? dev_vprintk_emit+0xbf/0x230
[ 562.630895] ? do_sys_poll+0x37a/0x550
[ 562.630897] ? dev_printk_emit+0x4e/0x70
[ 562.630900] ? __dev_printk+0x3c/0x80
[ 562.630903] ? _raw_spin_lock+0x20/0x30
[ 562.630909] ? snd_pcm_stream_lock+0x31/0x50 [snd_pcm]
[ 562.630914] ? _snd_pcm_stream_lock_irqsave+0x2e/0x40 [snd_pcm]
[ 562.630918] ? snd_pcm_stop_xrun+0x16/0x70 [snd_pcm]
[ 562.630922] ? in_stream_callback+0x3e6/0x450 [snd_firewire_lib]
[ 562.630925] ? handle_ir_packet_per_buffer+0x8e/0x1a0 [firewire_ohci]
[ 562.630928] ? ohci_flush_iso_completions+0xa3/0x130 [firewire_ohci]
[ 562.630932] ? fw_iso_context_flush_completions+0x15/0x20 [firewire_core]
[ 562.630935] ? amdtp_stream_pcm_pointer+0x2d/0x40 [snd_firewire_lib]
[ 562.630938] ? pcm_capture_pointer+0x19/0x20 [snd_oxfw]
[ 562.630943] ? snd_pcm_update_hw_ptr0+0x47/0x3d0 [snd_pcm]
[ 562.630945] ? poll_select_copy_remaining+0x150/0x150
[ 562.630947] ? poll_select_copy_remaining+0x150/0x150
[ 562.630952] ? snd_pcm_update_hw_ptr+0x10/0x20 [snd_pcm]
[ 562.630956] ? snd_pcm_hwsync+0x45/0xb0 [snd_pcm]
[ 562.630960] ? snd_pcm_common_ioctl1+0x1ff/0xc90 [snd_pcm]
[ 562.630962] ? futex_wake+0x90/0x170
[ 562.630966] ? snd_pcm_capture_ioctl1+0x136/0x260 [snd_pcm]
[ 562.630970] ? snd_pcm_capture_ioctl+0x27/0x40 [snd_pcm]
[ 562.630972] ? do_vfs_ioctl+0xa3/0x610
[ 562.630974] ? vfs_read+0x11b/0x130
[ 562.630976] ? SyS_ioctl+0x79/0x90
[ 562.630978] ? entry_SYSCALL_64_fastpath+0x1e/0xad
This commit fixes the above bug. This assumes two cases:
1. Any error is detected in software IRQ context of OHCI 1394 context.
In this case, PCM substream should be aborted in packet handler. On the
other hand, it should not be done in any process context. TO distinguish
these two context, use 'in_interrupt()' macro.
2. Any error is detect in process context of ALSA PCM application.
In this case, PCM substream should not be aborted in packet handler
because PCM substream lock is acquired. The task to abort PCM substream
should be done in ALSA PCM core. For this purpose, SNDRV_PCM_POS_XRUN is
returned at 'struct snd_pcm_ops.pointer()'.
Suggested-by: Clemens Ladisch <clemens@ladisch.de>
Fixes: e9148dddc3c7("ALSA: firewire-lib: flush completed packets when reading PCM position")
Cc: <stable@vger.kernel.org> # 4.9+
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-06-11 15:08:21 +08:00
|
|
|
snd_pcm_uframes_t pcm_buffer_pointer;
|
2011-03-15 14:53:21 +08:00
|
|
|
unsigned int pcm_period_pointer;
|
ALSA: firewire-lib: Add support for MIDI capture/playback
For capturing/playbacking MIDI messages, this commit adds one MIDI conformant
data channel. This data channel has multiplexed 8 MIDI data streams. So this
data channel can transfer messages from/to 8 MIDI ports.
And this commit allows to set PCM format even if AMDTP streams already start.
I suppose the case that PCM substreams are going to be joined into AMDTP
streams when AMDTP streams are already started for MIDI substreams. Each
driver must count how many PCM/MIDI substreams use AMDTP streams to stop
AMDTP streams.
There are differences between specifications about MIDI conformant data.
About the multiplexing, IEC 61883-6:2002, itself, has no information. It
describes labels and bytes for MIDI messages and refers to MMA/AMEI RP-027
for 'successfull implementation'. MMA/AMEI RP-027 describes 8 MPX-MIDI data
streams for one MIDI conformant data channel. IEC 61883-6:2005 adds
'sequence multiplexing' and apply this way and describe incompatibility
between 2002 and 2005.
So this commit applies IEC 61883-6:2005. When we find some devices compliant
to IEC 61883-6:2002, then this difference should be handles as device quirk
in additional work.
About the number of bytes in an MIDI conformant data, IEC 61883-6:2002 describe
0,1,2,3 bytes. MMA/AMEI RP-027 describes 'MIDI1.0-1x-SPEED', 'MIDI1.0-2x-SPEED',
'MIDI1.0-3x-SPEED' modes and the maximum bytes for each mode corresponds to 1,
2, 3 bytes. The 'MIDI1.0-2x/3x-SPEED' modes are accompanied with 'negotiation
procedure' and 'encapsulation details' but there is no specifications for them.
So this commit implements 'MIDI1.0-1x-SPEED' mode for playback, but allows
to pick up 1-3 bytes for capturing.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-04-25 21:44:47 +08:00
|
|
|
|
2015-09-19 10:21:48 +08:00
|
|
|
/* To wait for first packet. */
|
|
|
|
|
bool callbacked;
|
|
|
|
|
wait_queue_head_t callback_wait;
|
2017-03-22 20:30:15 +08:00
|
|
|
u32 start_cycle;
|
2015-09-19 10:21:48 +08:00
|
|
|
|
2015-09-19 10:22:02 +08:00
|
|
|
/* For backends to process data blocks. */
|
|
|
|
|
void *protocol;
|
|
|
|
|
amdtp_stream_process_data_blocks_t process_data_blocks;
|
2011-03-15 14:53:21 +08:00
|
|
|
};
|
|
|
|
|
|
2014-04-25 21:44:42 +08:00
|
|
|
int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
|
2015-09-19 10:22:02 +08:00
|
|
|
enum amdtp_stream_direction dir, enum cip_flags flags,
|
|
|
|
|
unsigned int fmt,
|
|
|
|
|
amdtp_stream_process_data_blocks_t process_data_blocks,
|
|
|
|
|
unsigned int protocol_size);
|
2014-04-25 21:44:42 +08:00
|
|
|
void amdtp_stream_destroy(struct amdtp_stream *s);
|
2011-03-15 14:53:21 +08:00
|
|
|
|
2015-09-19 10:22:02 +08:00
|
|
|
int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate,
|
|
|
|
|
unsigned int data_block_quadlets);
|
2014-04-25 21:44:42 +08:00
|
|
|
unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
|
2011-03-15 14:53:21 +08:00
|
|
|
|
2014-04-25 21:44:42 +08:00
|
|
|
int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
|
|
|
|
|
void amdtp_stream_update(struct amdtp_stream *s);
|
|
|
|
|
void amdtp_stream_stop(struct amdtp_stream *s);
|
2011-03-15 14:53:21 +08:00
|
|
|
|
2014-04-25 21:44:52 +08:00
|
|
|
int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
|
|
|
|
|
struct snd_pcm_runtime *runtime);
|
2015-09-19 10:22:02 +08:00
|
|
|
|
2014-04-25 21:44:42 +08:00
|
|
|
void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
|
|
|
|
|
unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
|
2017-06-07 08:38:05 +08:00
|
|
|
int amdtp_stream_pcm_ack(struct amdtp_stream *s);
|
2014-04-25 21:44:42 +08:00
|
|
|
void amdtp_stream_pcm_abort(struct amdtp_stream *s);
|
2011-03-15 14:53:21 +08:00
|
|
|
|
2011-10-17 03:39:00 +08:00
|
|
|
extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
|
2014-04-25 21:44:59 +08:00
|
|
|
extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
|
2011-09-05 04:16:10 +08:00
|
|
|
|
2014-04-25 21:44:42 +08:00
|
|
|
/**
|
|
|
|
|
* amdtp_stream_running - check stream is running or not
|
|
|
|
|
* @s: the AMDTP stream
|
|
|
|
|
*
|
|
|
|
|
* If this function returns true, the stream is running.
|
|
|
|
|
*/
|
|
|
|
|
static inline bool amdtp_stream_running(struct amdtp_stream *s)
|
2011-09-05 04:15:44 +08:00
|
|
|
{
|
|
|
|
|
return !IS_ERR(s->context);
|
|
|
|
|
}
|
|
|
|
|
|
2011-03-15 14:57:24 +08:00
|
|
|
/**
|
2014-04-25 21:44:42 +08:00
|
|
|
* amdtp_streaming_error - check for streaming error
|
|
|
|
|
* @s: the AMDTP stream
|
2011-03-15 14:57:24 +08:00
|
|
|
*
|
|
|
|
|
* If this function returns true, the stream's packet queue has stopped due to
|
|
|
|
|
* an asynchronous error.
|
|
|
|
|
*/
|
2014-04-25 21:44:42 +08:00
|
|
|
static inline bool amdtp_streaming_error(struct amdtp_stream *s)
|
2011-03-15 14:57:24 +08:00
|
|
|
{
|
|
|
|
|
return s->packet_index < 0;
|
|
|
|
|
}
|
|
|
|
|
|
ALSA: firewire-lib: Add support for MIDI capture/playback
For capturing/playbacking MIDI messages, this commit adds one MIDI conformant
data channel. This data channel has multiplexed 8 MIDI data streams. So this
data channel can transfer messages from/to 8 MIDI ports.
And this commit allows to set PCM format even if AMDTP streams already start.
I suppose the case that PCM substreams are going to be joined into AMDTP
streams when AMDTP streams are already started for MIDI substreams. Each
driver must count how many PCM/MIDI substreams use AMDTP streams to stop
AMDTP streams.
There are differences between specifications about MIDI conformant data.
About the multiplexing, IEC 61883-6:2002, itself, has no information. It
describes labels and bytes for MIDI messages and refers to MMA/AMEI RP-027
for 'successfull implementation'. MMA/AMEI RP-027 describes 8 MPX-MIDI data
streams for one MIDI conformant data channel. IEC 61883-6:2005 adds
'sequence multiplexing' and apply this way and describe incompatibility
between 2002 and 2005.
So this commit applies IEC 61883-6:2005. When we find some devices compliant
to IEC 61883-6:2002, then this difference should be handles as device quirk
in additional work.
About the number of bytes in an MIDI conformant data, IEC 61883-6:2002 describe
0,1,2,3 bytes. MMA/AMEI RP-027 describes 'MIDI1.0-1x-SPEED', 'MIDI1.0-2x-SPEED',
'MIDI1.0-3x-SPEED' modes and the maximum bytes for each mode corresponds to 1,
2, 3 bytes. The 'MIDI1.0-2x/3x-SPEED' modes are accompanied with 'negotiation
procedure' and 'encapsulation details' but there is no specifications for them.
So this commit implements 'MIDI1.0-1x-SPEED' mode for playback, but allows
to pick up 1-3 bytes for capturing.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-04-25 21:44:47 +08:00
|
|
|
/**
|
|
|
|
|
* amdtp_stream_pcm_running - check PCM substream is running or not
|
|
|
|
|
* @s: the AMDTP stream
|
|
|
|
|
*
|
|
|
|
|
* If this function returns true, PCM substream in the AMDTP stream is running.
|
|
|
|
|
*/
|
|
|
|
|
static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
|
|
|
|
|
{
|
|
|
|
|
return !!s->pcm;
|
|
|
|
|
}
|
|
|
|
|
|
2011-03-15 14:53:21 +08:00
|
|
|
/**
|
2014-04-25 21:44:42 +08:00
|
|
|
* amdtp_stream_pcm_trigger - start/stop playback from a PCM device
|
|
|
|
|
* @s: the AMDTP stream
|
2011-03-15 14:53:21 +08:00
|
|
|
* @pcm: the PCM device to be started, or %NULL to stop the current device
|
|
|
|
|
*
|
|
|
|
|
* Call this function on a running isochronous stream to enable the actual
|
|
|
|
|
* transmission of PCM data. This function should be called from the PCM
|
|
|
|
|
* device's .trigger callback.
|
|
|
|
|
*/
|
2014-04-25 21:44:42 +08:00
|
|
|
static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
|
|
|
|
|
struct snd_pcm_substream *pcm)
|
2011-03-15 14:53:21 +08:00
|
|
|
{
|
|
|
|
|
ACCESS_ONCE(s->pcm) = pcm;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
|
|
|
|
|
{
|
|
|
|
|
return sfc & 1;
|
|
|
|
|
}
|
|
|
|
|
|
2014-04-25 21:44:49 +08:00
|
|
|
/**
|
|
|
|
|
* amdtp_stream_wait_callback - sleep till callbacked or timeout
|
|
|
|
|
* @s: the AMDTP stream
|
|
|
|
|
* @timeout: msec till timeout
|
|
|
|
|
*
|
|
|
|
|
* If this function return false, the AMDTP stream should be stopped.
|
|
|
|
|
*/
|
|
|
|
|
static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
|
|
|
|
|
unsigned int timeout)
|
|
|
|
|
{
|
|
|
|
|
return wait_event_timeout(s->callback_wait,
|
|
|
|
|
s->callbacked == true,
|
|
|
|
|
msecs_to_jiffies(timeout)) > 0;
|
|
|
|
|
}
|
|
|
|
|
|
2011-03-15 14:53:21 +08:00
|
|
|
#endif
|