2011-03-15 00:53:21 -06:00
|
|
|
/*
|
|
|
|
* Audio and Music Data Transmission Protocol (IEC 61883-6) streams
|
|
|
|
* with Common Isochronous Packet (IEC 61883-1) headers
|
|
|
|
*
|
|
|
|
* Copyright (c) Clemens Ladisch <clemens@ladisch.de>
|
|
|
|
* Licensed under the terms of the GNU General Public License, version 2.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <linux/device.h>
|
|
|
|
#include <linux/err.h>
|
|
|
|
#include <linux/firewire.h>
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/slab.h>
|
|
|
|
#include <sound/pcm.h>
|
2014-04-25 07:44:52 -06:00
|
|
|
#include <sound/pcm_params.h>
|
2015-09-18 20:21:54 -06:00
|
|
|
#include "amdtp-stream.h"
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
#define TICKS_PER_CYCLE 3072
|
|
|
|
#define CYCLES_PER_SECOND 8000
|
|
|
|
#define TICKS_PER_SECOND (TICKS_PER_CYCLE * CYCLES_PER_SECOND)
|
|
|
|
|
ALSA: firewire-lib: add tracepoints to dump a part of isochronous packet data
When audio and music units have some quirks in their sequence of packet,
it's really hard for non-owners to identify the quirks. Although developers
need dumps for sequence of packets, it's difficult for users who have no
knowledges and no equipments for this purpose.
This commit adds tracepoints for this situation. When users encounter
the issue, they can dump a part of packet data via Linux tracing framework
as long as using drivers in ALSA firewire stack.
Additionally, tracepoints for outgoing packets will be our help to check
and debug packet processing of ALSA firewire stack.
This commit newly adds 'snd_firewire_lib' subsystem with 'in_packet' and
'out_packet' events. In the events, some attributes of packets and the
index of packet managed by this module are recorded per packet.
This is an usage:
$ trace-cmd record -e snd_firewire_lib:out_packet \
-e snd_firewire_lib:in_packet
/sys/kernel/tracing/events/snd_firewire_lib/out_packet/filter
/sys/kernel/tracing/events/snd_firewire_lib/in_packet/filter
Hit Ctrl^C to stop recording
^C
$ trace-cmd report trace.dat
...
23647.033934: in_packet: 01 4073 ffc0 ffc1 00 000f0040 9001b2d1 122 44
23647.033936: in_packet: 01 4074 ffc0 ffc1 00 000f0048 9001c83b 122 45
23647.033937: in_packet: 01 4075 ffc0 ffc1 00 000f0050 9001ffff 002 46
23647.033938: in_packet: 01 4076 ffc0 ffc1 00 000f0050 9001e1a6 122 47
23647.035426: out_packet: 01 4123 ffc1 ffc0 01 010f00d0 9001fb40 122 17
23647.035428: out_packet: 01 4124 ffc1 ffc0 01 010f00d8 9001ffff 002 18
23647.035429: out_packet: 01 4125 ffc1 ffc0 01 010f00d8 900114aa 122 19
23647.035430: out_packet: 01 4126 ffc1 ffc0 01 010f00e0 90012a15 122 20
(Here, some common fields are omitted so that a line to be within 80
characters.)
...
One line represent one packet. The legend for the last nine fields is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- Some devices transfer packets with invalid source node ID in their CIP
header.
- The ID of node as destination (hex)
- The value is not in CIP header of packets.
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
This is an example to parse these lines from text file by Python3 script:
\#!/usr/bin/env python3
import sys
def parse_ts(second, cycle, syt):
offset = syt & 0xfff
syt >>= 12
if cycle & 0x0f > syt:
cycle += 0x10
cycle &= 0x1ff0
cycle |= syt
second += cycle // 8000
cycle %= 8000
# In CYCLE_TIMER of 1394 OHCI, second is represented in 8 bit.
second %= 128
return (second, cycle, offset)
def calc_ts(second, cycle, offset):
ts = offset
ts += cycle * 3072
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
ts += (second % 8) * 8000 * 3072
return ts
def subtract_ts(minuend, subtrahend):
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
if minuend < subtrahend:
minuend += 8 * 8000 * 3072
return minuend - subtrahend
if len(sys.argv) != 2:
print('At least, one argument is required for packet dump.')
sys.exit()
filename = sys.argv[1]
data = []
prev = 0
with open(filename, 'r') as f:
for line in f:
pos = line.find('packet:')
if pos < 0:
continue
pos += len('packet:')
line = line[pos:].strip()
fields = line.split(' ')
datum = []
datum.append(fields[8])
syt = int(fields[6][4:], 16)
# Empty packet in IEC 61883-1, or NODATA in IEC 61883-6
if syt == 0xffff:
data_blocks = 0
else:
payload_size = int(fields[7], 10)
data_block_size = int(fields[5][2:4], 16)
data_blocks = (payload_size - 2) / data_block_size
datum.append(data_blocks)
second = int(fields[0], 10)
cycle = int(fields[1], 10)
start = (second << 25) | (cycle << 12)
datum.append('0x{0:08x}'.format(start))
start = calc_ts(second, cycle, 0)
datum.append("0x" + fields[5])
datum.append("0x" + fields[6])
if syt == 0xffff:
second = 0
cycle = 0
tick = 0
else:
second, cycle, tick = parse_ts(second, cycle, syt)
ts = calc_ts(second, cycle, tick)
datum.append(start)
datum.append(ts)
if ts == 0:
datum.append(0)
datum.append(0)
else:
# Usual case, or a case over 8 seconds.
if ts > start or start > 7 * 8000 * 3072:
datum.append(subtract_ts(ts, start))
if ts > prev or start > 7 * 8000 * 3072:
gap = subtract_ts(ts, prev)
datum.append(gap)
else:
datum.append('backward')
else:
datum.append('invalid')
prev = ts
data.append(datum)
sys.exit()
The data variable includes array with these elements:
- The index of the packet
- The number of data blocks in the packet
- The value of cycle count (hex)
- The value of CIP header 1 (hex)
- The value of CIP header 2 (hex)
- The value of cycle count (tick)
- The value of calculated presentation timestamp (tick)
- The offset between the cycle count and presentation timestamp
- The elapsed ticks from the previous presentation timestamp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:46 -06:00
|
|
|
/* Always support Linux tracing subsystem. */
|
|
|
|
#define CREATE_TRACE_POINTS
|
|
|
|
#include "amdtp-stream-trace.h"
|
|
|
|
|
2015-02-20 19:50:17 -07:00
|
|
|
#define TRANSFER_DELAY_TICKS 0x2e00 /* 479.17 microseconds */
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2014-04-25 07:44:43 -06:00
|
|
|
/* isochronous header parameters */
|
|
|
|
#define ISO_DATA_LENGTH_SHIFT 16
|
2011-03-15 00:53:21 -06:00
|
|
|
#define TAG_CIP 1
|
|
|
|
|
2014-04-25 07:44:43 -06:00
|
|
|
/* common isochronous packet header parameters */
|
2015-05-22 08:21:12 -06:00
|
|
|
#define CIP_EOH_SHIFT 31
|
|
|
|
#define CIP_EOH (1u << CIP_EOH_SHIFT)
|
2014-04-25 07:44:43 -06:00
|
|
|
#define CIP_EOH_MASK 0x80000000
|
2015-05-22 08:21:12 -06:00
|
|
|
#define CIP_SID_SHIFT 24
|
|
|
|
#define CIP_SID_MASK 0x3f000000
|
|
|
|
#define CIP_DBS_MASK 0x00ff0000
|
|
|
|
#define CIP_DBS_SHIFT 16
|
|
|
|
#define CIP_DBC_MASK 0x000000ff
|
|
|
|
#define CIP_FMT_SHIFT 24
|
2014-04-25 07:44:43 -06:00
|
|
|
#define CIP_FMT_MASK 0x3f000000
|
2015-05-22 08:21:12 -06:00
|
|
|
#define CIP_FDF_MASK 0x00ff0000
|
|
|
|
#define CIP_FDF_SHIFT 16
|
2014-04-25 07:44:43 -06:00
|
|
|
#define CIP_SYT_MASK 0x0000ffff
|
|
|
|
#define CIP_SYT_NO_INFO 0xffff
|
|
|
|
|
2015-09-18 20:21:56 -06:00
|
|
|
/* Audio and Music transfer protocol specific parameters */
|
2015-09-18 20:21:53 -06:00
|
|
|
#define CIP_FMT_AM 0x10
|
2014-04-25 07:44:46 -06:00
|
|
|
#define AMDTP_FDF_NO_DATA 0xff
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
/* TODO: make these configurable */
|
|
|
|
#define INTERRUPT_INTERVAL 16
|
|
|
|
#define QUEUE_LENGTH 48
|
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
#define IN_PACKET_HEADER_SIZE 4
|
2014-04-25 07:44:45 -06:00
|
|
|
#define OUT_PACKET_HEADER_SIZE 0
|
|
|
|
|
2012-05-13 14:03:09 -06:00
|
|
|
static void pcm_period_tasklet(unsigned long data);
|
|
|
|
|
2011-03-15 00:53:21 -06:00
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_init - initialize an AMDTP stream structure
|
|
|
|
* @s: the AMDTP stream to initialize
|
2011-03-15 00:53:21 -06:00
|
|
|
* @unit: the target of the stream
|
2014-04-25 07:44:44 -06:00
|
|
|
* @dir: the direction of stream
|
2011-03-15 00:53:21 -06:00
|
|
|
* @flags: the packet transmission method to use
|
2015-09-18 20:21:55 -06:00
|
|
|
* @fmt: the value of fmt field in CIP header
|
2015-09-18 20:22:02 -06:00
|
|
|
* @process_data_blocks: callback handler to process data blocks
|
|
|
|
* @protocol_size: the size to allocate newly for protocol
|
2011-03-15 00:53:21 -06:00
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
|
2015-09-18 20:21:55 -06:00
|
|
|
enum amdtp_stream_direction dir, enum cip_flags flags,
|
2015-09-18 20:22:02 -06:00
|
|
|
unsigned int fmt,
|
|
|
|
amdtp_stream_process_data_blocks_t process_data_blocks,
|
|
|
|
unsigned int protocol_size)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
2015-09-18 20:22:02 -06:00
|
|
|
if (process_data_blocks == NULL)
|
|
|
|
return -EINVAL;
|
|
|
|
|
|
|
|
s->protocol = kzalloc(protocol_size, GFP_KERNEL);
|
|
|
|
if (!s->protocol)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
2015-02-21 07:54:58 -07:00
|
|
|
s->unit = unit;
|
2014-04-25 07:44:44 -06:00
|
|
|
s->direction = dir;
|
2011-03-15 00:53:21 -06:00
|
|
|
s->flags = flags;
|
|
|
|
s->context = ERR_PTR(-1);
|
|
|
|
mutex_init(&s->mutex);
|
2012-05-13 14:03:09 -06:00
|
|
|
tasklet_init(&s->period_tasklet, pcm_period_tasklet, (unsigned long)s);
|
2011-03-15 00:57:24 -06:00
|
|
|
s->packet_index = 0;
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2014-04-25 07:44:49 -06:00
|
|
|
init_waitqueue_head(&s->callback_wait);
|
|
|
|
s->callbacked = false;
|
|
|
|
|
2015-09-18 20:21:55 -06:00
|
|
|
s->fmt = fmt;
|
2015-09-18 20:22:02 -06:00
|
|
|
s->process_data_blocks = process_data_blocks;
|
2015-09-18 20:21:53 -06:00
|
|
|
|
2011-03-15 00:53:21 -06:00
|
|
|
return 0;
|
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_init);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_destroy - free stream resources
|
|
|
|
* @s: the AMDTP stream to destroy
|
2011-03-15 00:53:21 -06:00
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
void amdtp_stream_destroy(struct amdtp_stream *s)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
2016-03-30 17:47:02 -06:00
|
|
|
/* Not initialized. */
|
|
|
|
if (s->protocol == NULL)
|
|
|
|
return;
|
|
|
|
|
2014-04-25 07:44:42 -06:00
|
|
|
WARN_ON(amdtp_stream_running(s));
|
2015-09-18 20:22:02 -06:00
|
|
|
kfree(s->protocol);
|
2011-03-15 00:53:21 -06:00
|
|
|
mutex_destroy(&s->mutex);
|
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_destroy);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2011-10-16 13:39:00 -06:00
|
|
|
const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT] = {
|
2011-09-04 14:16:10 -06:00
|
|
|
[CIP_SFC_32000] = 8,
|
|
|
|
[CIP_SFC_44100] = 8,
|
|
|
|
[CIP_SFC_48000] = 8,
|
|
|
|
[CIP_SFC_88200] = 16,
|
|
|
|
[CIP_SFC_96000] = 16,
|
|
|
|
[CIP_SFC_176400] = 32,
|
|
|
|
[CIP_SFC_192000] = 32,
|
|
|
|
};
|
|
|
|
EXPORT_SYMBOL(amdtp_syt_intervals);
|
|
|
|
|
2014-05-27 09:14:36 -06:00
|
|
|
const unsigned int amdtp_rate_table[CIP_SFC_COUNT] = {
|
2014-04-25 07:44:59 -06:00
|
|
|
[CIP_SFC_32000] = 32000,
|
|
|
|
[CIP_SFC_44100] = 44100,
|
|
|
|
[CIP_SFC_48000] = 48000,
|
|
|
|
[CIP_SFC_88200] = 88200,
|
|
|
|
[CIP_SFC_96000] = 96000,
|
|
|
|
[CIP_SFC_176400] = 176400,
|
|
|
|
[CIP_SFC_192000] = 192000,
|
|
|
|
};
|
|
|
|
EXPORT_SYMBOL(amdtp_rate_table);
|
|
|
|
|
2014-04-25 07:44:52 -06:00
|
|
|
/**
|
|
|
|
* amdtp_stream_add_pcm_hw_constraints - add hw constraints for PCM substream
|
|
|
|
* @s: the AMDTP stream, which must be initialized.
|
|
|
|
* @runtime: the PCM substream runtime
|
|
|
|
*/
|
|
|
|
int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
|
|
|
|
struct snd_pcm_runtime *runtime)
|
|
|
|
{
|
|
|
|
int err;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Currently firewire-lib processes 16 packets in one software
|
|
|
|
* interrupt callback. This equals to 2msec but actually the
|
|
|
|
* interval of the interrupts has a jitter.
|
|
|
|
* Additionally, even if adding a constraint to fit period size to
|
|
|
|
* 2msec, actual calculated frames per period doesn't equal to 2msec,
|
|
|
|
* depending on sampling rate.
|
|
|
|
* Anyway, the interval to call snd_pcm_period_elapsed() cannot 2msec.
|
|
|
|
* Here let us use 5msec for safe period interrupt.
|
|
|
|
*/
|
|
|
|
err = snd_pcm_hw_constraint_minmax(runtime,
|
|
|
|
SNDRV_PCM_HW_PARAM_PERIOD_TIME,
|
|
|
|
5000, UINT_MAX);
|
|
|
|
if (err < 0)
|
|
|
|
goto end;
|
|
|
|
|
|
|
|
/* Non-Blocking stream has no more constraints */
|
|
|
|
if (!(s->flags & CIP_BLOCKING))
|
|
|
|
goto end;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* One AMDTP packet can include some frames. In blocking mode, the
|
|
|
|
* number equals to SYT_INTERVAL. So the number is 8, 16 or 32,
|
|
|
|
* depending on its sampling rate. For accurate period interrupt, it's
|
2015-03-09 15:13:03 -06:00
|
|
|
* preferrable to align period/buffer sizes to current SYT_INTERVAL.
|
2014-04-25 07:44:52 -06:00
|
|
|
*
|
2015-03-09 15:13:03 -06:00
|
|
|
* TODO: These constraints can be improved with proper rules.
|
|
|
|
* Currently apply LCM of SYT_INTERVALs.
|
2014-04-25 07:44:52 -06:00
|
|
|
*/
|
|
|
|
err = snd_pcm_hw_constraint_step(runtime, 0,
|
|
|
|
SNDRV_PCM_HW_PARAM_PERIOD_SIZE, 32);
|
|
|
|
if (err < 0)
|
|
|
|
goto end;
|
|
|
|
err = snd_pcm_hw_constraint_step(runtime, 0,
|
|
|
|
SNDRV_PCM_HW_PARAM_BUFFER_SIZE, 32);
|
|
|
|
end:
|
|
|
|
return err;
|
|
|
|
}
|
|
|
|
EXPORT_SYMBOL(amdtp_stream_add_pcm_hw_constraints);
|
|
|
|
|
2011-03-15 00:53:21 -06:00
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_set_parameters - set stream parameters
|
|
|
|
* @s: the AMDTP stream to configure
|
2011-03-15 00:53:21 -06:00
|
|
|
* @rate: the sample rate
|
2015-09-18 20:22:02 -06:00
|
|
|
* @data_block_quadlets: the size of a data block in quadlet unit
|
2011-03-15 00:53:21 -06:00
|
|
|
*
|
2011-09-04 14:16:10 -06:00
|
|
|
* The parameters must be set before the stream is started, and must not be
|
2011-03-15 00:53:21 -06:00
|
|
|
* changed while the stream is running.
|
|
|
|
*/
|
2015-09-18 20:22:02 -06:00
|
|
|
int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate,
|
|
|
|
unsigned int data_block_quadlets)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
2015-09-18 20:22:02 -06:00
|
|
|
unsigned int sfc;
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2015-09-18 20:21:49 -06:00
|
|
|
for (sfc = 0; sfc < ARRAY_SIZE(amdtp_rate_table); ++sfc) {
|
2014-04-25 07:44:59 -06:00
|
|
|
if (amdtp_rate_table[sfc] == rate)
|
2015-09-18 20:21:49 -06:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (sfc == ARRAY_SIZE(amdtp_rate_table))
|
|
|
|
return -EINVAL;
|
2011-09-04 14:12:48 -06:00
|
|
|
|
|
|
|
s->sfc = sfc;
|
2015-09-18 20:22:02 -06:00
|
|
|
s->data_block_quadlets = data_block_quadlets;
|
2011-09-04 14:16:10 -06:00
|
|
|
s->syt_interval = amdtp_syt_intervals[sfc];
|
2011-09-04 14:12:48 -06:00
|
|
|
|
|
|
|
/* default buffering in the device */
|
|
|
|
s->transfer_delay = TRANSFER_DELAY_TICKS - TICKS_PER_CYCLE;
|
|
|
|
if (s->flags & CIP_BLOCKING)
|
|
|
|
/* additional buffering needed to adjust for no-data packets */
|
|
|
|
s->transfer_delay += TICKS_PER_SECOND * s->syt_interval / rate;
|
2014-04-25 07:44:50 -06:00
|
|
|
|
2015-09-18 20:21:49 -06:00
|
|
|
return 0;
|
2011-03-15 00:53:21 -06:00
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_set_parameters);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_get_max_payload - get the stream's packet size
|
|
|
|
* @s: the AMDTP stream
|
2011-03-15 00:53:21 -06:00
|
|
|
*
|
|
|
|
* This function must not be called before the stream has been configured
|
2014-04-25 07:44:42 -06:00
|
|
|
* with amdtp_stream_set_parameters().
|
2011-03-15 00:53:21 -06:00
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
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 08:00:50 -06:00
|
|
|
unsigned int multiplier = 1;
|
|
|
|
|
|
|
|
if (s->flags & CIP_JUMBO_PAYLOAD)
|
|
|
|
multiplier = 5;
|
|
|
|
|
|
|
|
return 8 + s->syt_interval * s->data_block_quadlets * 4 * multiplier;
|
2011-03-15 00:53:21 -06:00
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_get_max_payload);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2012-05-13 14:03:09 -06:00
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_pcm_prepare - prepare PCM device for running
|
|
|
|
* @s: the AMDTP stream
|
2012-05-13 14:03:09 -06:00
|
|
|
*
|
|
|
|
* This function should be called from the PCM device's .prepare callback.
|
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
void amdtp_stream_pcm_prepare(struct amdtp_stream *s)
|
2012-05-13 14:03:09 -06:00
|
|
|
{
|
|
|
|
tasklet_kill(&s->period_tasklet);
|
|
|
|
s->pcm_buffer_pointer = 0;
|
|
|
|
s->pcm_period_pointer = 0;
|
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_pcm_prepare);
|
2012-05-13 14:03:09 -06:00
|
|
|
|
2015-05-22 08:00:51 -06:00
|
|
|
static unsigned int calculate_data_blocks(struct amdtp_stream *s,
|
|
|
|
unsigned int syt)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
|
|
|
unsigned int phase, data_blocks;
|
|
|
|
|
2015-05-22 08:00:51 -06:00
|
|
|
/* Blocking mode. */
|
|
|
|
if (s->flags & CIP_BLOCKING) {
|
|
|
|
/* This module generate empty packet for 'no data'. */
|
|
|
|
if (syt == CIP_SYT_NO_INFO)
|
|
|
|
data_blocks = 0;
|
|
|
|
else
|
|
|
|
data_blocks = s->syt_interval;
|
|
|
|
/* Non-blocking mode. */
|
2011-03-15 00:53:21 -06:00
|
|
|
} else {
|
2015-05-22 08:00:51 -06:00
|
|
|
if (!cip_sfc_is_base_44100(s->sfc)) {
|
|
|
|
/* Sample_rate / 8000 is an integer, and precomputed. */
|
|
|
|
data_blocks = s->data_block_state;
|
|
|
|
} else {
|
|
|
|
phase = s->data_block_state;
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
/*
|
|
|
|
* This calculates the number of data blocks per packet so that
|
|
|
|
* 1) the overall rate is correct and exactly synchronized to
|
|
|
|
* the bus clock, and
|
|
|
|
* 2) packets with a rounded-up number of blocks occur as early
|
|
|
|
* as possible in the sequence (to prevent underruns of the
|
|
|
|
* device's buffer).
|
|
|
|
*/
|
2015-05-22 08:00:51 -06:00
|
|
|
if (s->sfc == CIP_SFC_44100)
|
|
|
|
/* 6 6 5 6 5 6 5 ... */
|
|
|
|
data_blocks = 5 + ((phase & 1) ^
|
|
|
|
(phase == 0 || phase >= 40));
|
|
|
|
else
|
|
|
|
/* 12 11 11 11 11 ... or 23 22 22 22 22 ... */
|
|
|
|
data_blocks = 11 * (s->sfc >> 1) + (phase == 0);
|
|
|
|
if (++phase >= (80 >> (s->sfc >> 1)))
|
|
|
|
phase = 0;
|
|
|
|
s->data_block_state = phase;
|
|
|
|
}
|
2011-03-15 00:53:21 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
return data_blocks;
|
|
|
|
}
|
|
|
|
|
2014-04-25 07:44:42 -06:00
|
|
|
static unsigned int calculate_syt(struct amdtp_stream *s,
|
2011-03-15 00:53:21 -06:00
|
|
|
unsigned int cycle)
|
|
|
|
{
|
|
|
|
unsigned int syt_offset, phase, index, syt;
|
|
|
|
|
|
|
|
if (s->last_syt_offset < TICKS_PER_CYCLE) {
|
|
|
|
if (!cip_sfc_is_base_44100(s->sfc))
|
|
|
|
syt_offset = s->last_syt_offset + s->syt_offset_state;
|
|
|
|
else {
|
|
|
|
/*
|
|
|
|
* The time, in ticks, of the n'th SYT_INTERVAL sample is:
|
|
|
|
* n * SYT_INTERVAL * 24576000 / sample_rate
|
|
|
|
* Modulo TICKS_PER_CYCLE, the difference between successive
|
|
|
|
* elements is about 1386.23. Rounding the results of this
|
|
|
|
* formula to the SYT precision results in a sequence of
|
|
|
|
* differences that begins with:
|
|
|
|
* 1386 1386 1387 1386 1386 1386 1387 1386 1386 1386 1387 ...
|
|
|
|
* This code generates _exactly_ the same sequence.
|
|
|
|
*/
|
|
|
|
phase = s->syt_offset_state;
|
|
|
|
index = phase % 13;
|
|
|
|
syt_offset = s->last_syt_offset;
|
|
|
|
syt_offset += 1386 + ((index && !(index & 3)) ||
|
|
|
|
phase == 146);
|
|
|
|
if (++phase >= 147)
|
|
|
|
phase = 0;
|
|
|
|
s->syt_offset_state = phase;
|
|
|
|
}
|
|
|
|
} else
|
|
|
|
syt_offset = s->last_syt_offset - TICKS_PER_CYCLE;
|
|
|
|
s->last_syt_offset = syt_offset;
|
|
|
|
|
2011-03-15 00:55:02 -06:00
|
|
|
if (syt_offset < TICKS_PER_CYCLE) {
|
2011-09-04 14:12:48 -06:00
|
|
|
syt_offset += s->transfer_delay;
|
2011-03-15 00:55:02 -06:00
|
|
|
syt = (cycle + syt_offset / TICKS_PER_CYCLE) << 12;
|
|
|
|
syt += syt_offset % TICKS_PER_CYCLE;
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2014-04-25 07:44:43 -06:00
|
|
|
return syt & CIP_SYT_MASK;
|
2011-03-15 00:55:02 -06:00
|
|
|
} else {
|
2014-04-25 07:44:43 -06:00
|
|
|
return CIP_SYT_NO_INFO;
|
2011-03-15 00:55:02 -06:00
|
|
|
}
|
2011-03-15 00:53:21 -06:00
|
|
|
}
|
|
|
|
|
2014-04-25 07:44:45 -06:00
|
|
|
static void update_pcm_pointers(struct amdtp_stream *s,
|
|
|
|
struct snd_pcm_substream *pcm,
|
|
|
|
unsigned int frames)
|
2014-08-28 22:40:45 -06:00
|
|
|
{
|
|
|
|
unsigned int ptr;
|
|
|
|
|
2014-04-25 07:44:45 -06:00
|
|
|
ptr = s->pcm_buffer_pointer + frames;
|
|
|
|
if (ptr >= pcm->runtime->buffer_size)
|
|
|
|
ptr -= pcm->runtime->buffer_size;
|
|
|
|
ACCESS_ONCE(s->pcm_buffer_pointer) = ptr;
|
|
|
|
|
|
|
|
s->pcm_period_pointer += frames;
|
|
|
|
if (s->pcm_period_pointer >= pcm->runtime->period_size) {
|
|
|
|
s->pcm_period_pointer -= pcm->runtime->period_size;
|
|
|
|
tasklet_hi_schedule(&s->period_tasklet);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void pcm_period_tasklet(unsigned long data)
|
|
|
|
{
|
|
|
|
struct amdtp_stream *s = (void *)data;
|
|
|
|
struct snd_pcm_substream *pcm = ACCESS_ONCE(s->pcm);
|
|
|
|
|
|
|
|
if (pcm)
|
|
|
|
snd_pcm_period_elapsed(pcm);
|
|
|
|
}
|
|
|
|
|
2016-05-10 16:35:09 -06:00
|
|
|
static int queue_packet(struct amdtp_stream *s, unsigned int header_length,
|
|
|
|
unsigned int payload_length)
|
2014-04-25 07:44:45 -06:00
|
|
|
{
|
|
|
|
struct fw_iso_packet p = {0};
|
2014-04-25 07:44:49 -06:00
|
|
|
int err = 0;
|
|
|
|
|
|
|
|
if (IS_ERR(s->context))
|
|
|
|
goto end;
|
2014-04-25 07:44:45 -06:00
|
|
|
|
|
|
|
p.interrupt = IS_ALIGNED(s->packet_index + 1, INTERRUPT_INTERVAL);
|
|
|
|
p.tag = TAG_CIP;
|
|
|
|
p.header_length = header_length;
|
2016-05-10 16:35:09 -06:00
|
|
|
if (payload_length > 0)
|
|
|
|
p.payload_length = payload_length;
|
|
|
|
else
|
|
|
|
p.skip = true;
|
2014-04-25 07:44:45 -06:00
|
|
|
err = fw_iso_context_queue(s->context, &p, &s->buffer.iso_buffer,
|
|
|
|
s->buffer.packets[s->packet_index].offset);
|
|
|
|
if (err < 0) {
|
|
|
|
dev_err(&s->unit->device, "queueing error: %d\n", err);
|
|
|
|
goto end;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (++s->packet_index >= QUEUE_LENGTH)
|
|
|
|
s->packet_index = 0;
|
|
|
|
end:
|
|
|
|
return err;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int queue_out_packet(struct amdtp_stream *s,
|
2016-05-10 16:35:09 -06:00
|
|
|
unsigned int payload_length)
|
2014-04-25 07:44:45 -06:00
|
|
|
{
|
2016-05-10 16:35:09 -06:00
|
|
|
return queue_packet(s, OUT_PACKET_HEADER_SIZE, payload_length);
|
2014-04-25 07:44:45 -06:00
|
|
|
}
|
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
static inline int queue_in_packet(struct amdtp_stream *s)
|
|
|
|
{
|
|
|
|
return queue_packet(s, IN_PACKET_HEADER_SIZE,
|
2016-05-10 16:35:09 -06:00
|
|
|
amdtp_stream_get_max_payload(s));
|
2014-04-25 07:44:46 -06:00
|
|
|
}
|
|
|
|
|
ALSA: firewire-lib: add context information to tracepoints
In current implementation, packet processing is done in both of software
IRQ contexts of IR/IT contexts and process contexts.
This is usual interrupt handling of IR/IT context for 1394 OHCI.
(in hardware IRQ context)
irq_handler() (drivers/firewire/ohci.c)
->tasklet_schedule()
(in software IRQ context)
handle_it_packet() or handle_ir_packet_per_buffer() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
However, we have another chance for packet processing. It's done in PCM
frame handling via ALSA PCM interfaces.
(in process context)
ioctl(i.e. SNDRV_PCM_IOCTL_HWSYNC)
->snd_pcm_hwsync() (sound/core/pcm_native.c)
->snd_pcm_update_hw_ptr() (sound/core/pcm_lib.c)
->snd_pcm_update_hw_ptr0()
->struct snd_pcm_ops.pointer()
= amdtp_stream_pcm_pointer()
->fw_iso_context_flush_completions() (drivers/firewire/core-iso.c)
->struct fw_card_driver.flush_iso_completions()
= ohci_flush_iso_completions() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
This design is for a better granularity of PCM pointer. When ioctl(2) is
executed with some commands for ALSA PCM interface, queued packets are
handled at first. Then, the latest number of handled PCM frames is
reported. The number can represent PCM frames transferred in most near
isochronous cycle.
Current tracepoints include no information to distinguish running contexts.
When tracing the interval of software IRQ context, this is not good.
This commit adds more information for current context. Additionally, the
index of packet processed in one context is added in a case that packet
processing is executed in continuous context of the same kind,
As a result, the output includes 11 fields with additional two fields
to commit 0c95c1d6197f ("ALSA: firewire-lib: add tracepoints to dump a part
of isochronous packet data"):
17131.9186: out_packet: 07 7494 ffc0 ffc1 00 000700c0 9001a496 058 45 1 13
17131.9186: out_packet: 07 7495 ffc0 ffc1 00 000700c8 9001ba00 058 46 1 14
17131.9186: out_packet: 07 7496 ffc0 ffc1 00 000700d0 9001ffff 002 47 1 15
17131.9189: out_packet: 07 7497 ffc0 ffc1 00 000700d0 9001d36a 058 00 0 00
17131.9189: out_packet: 07 7498 ffc0 ffc1 00 000700d8 9001e8d4 058 01 0 01
17131.9189: out_packet: 07 7499 ffc0 ffc1 00 000700e0 9001023e 058 02 0 00
17131.9206: in_packet: 07 7447 ffc1 ffc0 01 3f070072 9001783d 058 32 1 00
17131.9206: in_packet: 07 7448 ffc1 ffc0 01 3f070072 90ffffff 002 33 1 01
17131.9206: in_packet: 07 7449 ffc1 ffc0 01 3f07007a 900191a8 058 34 1 02
(Here, some common fields are omitted so that a line is within 80
characters.)
The legend is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- The ID of node as destination (hex)
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
- 0 in process context, 1 in IRQ context
- The index of packet processed in the context
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-10 16:33:27 -06:00
|
|
|
static int handle_out_packet(struct amdtp_stream *s, unsigned int cycle,
|
|
|
|
unsigned int index)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
|
|
|
__be32 *buffer;
|
2016-05-09 08:15:55 -06:00
|
|
|
unsigned int syt;
|
|
|
|
unsigned int data_blocks;
|
2015-05-22 08:00:52 -06:00
|
|
|
unsigned int payload_length;
|
2015-09-18 20:21:52 -06:00
|
|
|
unsigned int pcm_frames;
|
2011-03-15 00:53:21 -06:00
|
|
|
struct snd_pcm_substream *pcm;
|
|
|
|
|
2014-04-25 07:44:48 -06:00
|
|
|
buffer = s->buffer.packets[s->packet_index].buffer;
|
2016-05-09 08:15:55 -06:00
|
|
|
syt = calculate_syt(s, cycle);
|
|
|
|
data_blocks = calculate_data_blocks(s, syt);
|
2015-09-18 20:22:02 -06:00
|
|
|
pcm_frames = s->process_data_blocks(s, buffer + 2, data_blocks, &syt);
|
2015-09-18 20:21:52 -06:00
|
|
|
|
2011-03-15 00:53:21 -06:00
|
|
|
buffer[0] = cpu_to_be32(ACCESS_ONCE(s->source_node_id_field) |
|
2015-05-22 08:21:12 -06:00
|
|
|
(s->data_block_quadlets << CIP_DBS_SHIFT) |
|
2011-03-15 00:53:21 -06:00
|
|
|
s->data_block_counter);
|
2015-09-18 20:21:53 -06:00
|
|
|
buffer[1] = cpu_to_be32(CIP_EOH |
|
|
|
|
((s->fmt << CIP_FMT_SHIFT) & CIP_FMT_MASK) |
|
|
|
|
((s->fdf << CIP_FDF_SHIFT) & CIP_FDF_MASK) |
|
|
|
|
(syt & CIP_SYT_MASK));
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
s->data_block_counter = (s->data_block_counter + data_blocks) & 0xff;
|
2014-04-25 07:44:45 -06:00
|
|
|
payload_length = 8 + data_blocks * 4 * s->data_block_quadlets;
|
ALSA: firewire-lib: add tracepoints to dump a part of isochronous packet data
When audio and music units have some quirks in their sequence of packet,
it's really hard for non-owners to identify the quirks. Although developers
need dumps for sequence of packets, it's difficult for users who have no
knowledges and no equipments for this purpose.
This commit adds tracepoints for this situation. When users encounter
the issue, they can dump a part of packet data via Linux tracing framework
as long as using drivers in ALSA firewire stack.
Additionally, tracepoints for outgoing packets will be our help to check
and debug packet processing of ALSA firewire stack.
This commit newly adds 'snd_firewire_lib' subsystem with 'in_packet' and
'out_packet' events. In the events, some attributes of packets and the
index of packet managed by this module are recorded per packet.
This is an usage:
$ trace-cmd record -e snd_firewire_lib:out_packet \
-e snd_firewire_lib:in_packet
/sys/kernel/tracing/events/snd_firewire_lib/out_packet/filter
/sys/kernel/tracing/events/snd_firewire_lib/in_packet/filter
Hit Ctrl^C to stop recording
^C
$ trace-cmd report trace.dat
...
23647.033934: in_packet: 01 4073 ffc0 ffc1 00 000f0040 9001b2d1 122 44
23647.033936: in_packet: 01 4074 ffc0 ffc1 00 000f0048 9001c83b 122 45
23647.033937: in_packet: 01 4075 ffc0 ffc1 00 000f0050 9001ffff 002 46
23647.033938: in_packet: 01 4076 ffc0 ffc1 00 000f0050 9001e1a6 122 47
23647.035426: out_packet: 01 4123 ffc1 ffc0 01 010f00d0 9001fb40 122 17
23647.035428: out_packet: 01 4124 ffc1 ffc0 01 010f00d8 9001ffff 002 18
23647.035429: out_packet: 01 4125 ffc1 ffc0 01 010f00d8 900114aa 122 19
23647.035430: out_packet: 01 4126 ffc1 ffc0 01 010f00e0 90012a15 122 20
(Here, some common fields are omitted so that a line to be within 80
characters.)
...
One line represent one packet. The legend for the last nine fields is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- Some devices transfer packets with invalid source node ID in their CIP
header.
- The ID of node as destination (hex)
- The value is not in CIP header of packets.
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
This is an example to parse these lines from text file by Python3 script:
\#!/usr/bin/env python3
import sys
def parse_ts(second, cycle, syt):
offset = syt & 0xfff
syt >>= 12
if cycle & 0x0f > syt:
cycle += 0x10
cycle &= 0x1ff0
cycle |= syt
second += cycle // 8000
cycle %= 8000
# In CYCLE_TIMER of 1394 OHCI, second is represented in 8 bit.
second %= 128
return (second, cycle, offset)
def calc_ts(second, cycle, offset):
ts = offset
ts += cycle * 3072
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
ts += (second % 8) * 8000 * 3072
return ts
def subtract_ts(minuend, subtrahend):
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
if minuend < subtrahend:
minuend += 8 * 8000 * 3072
return minuend - subtrahend
if len(sys.argv) != 2:
print('At least, one argument is required for packet dump.')
sys.exit()
filename = sys.argv[1]
data = []
prev = 0
with open(filename, 'r') as f:
for line in f:
pos = line.find('packet:')
if pos < 0:
continue
pos += len('packet:')
line = line[pos:].strip()
fields = line.split(' ')
datum = []
datum.append(fields[8])
syt = int(fields[6][4:], 16)
# Empty packet in IEC 61883-1, or NODATA in IEC 61883-6
if syt == 0xffff:
data_blocks = 0
else:
payload_size = int(fields[7], 10)
data_block_size = int(fields[5][2:4], 16)
data_blocks = (payload_size - 2) / data_block_size
datum.append(data_blocks)
second = int(fields[0], 10)
cycle = int(fields[1], 10)
start = (second << 25) | (cycle << 12)
datum.append('0x{0:08x}'.format(start))
start = calc_ts(second, cycle, 0)
datum.append("0x" + fields[5])
datum.append("0x" + fields[6])
if syt == 0xffff:
second = 0
cycle = 0
tick = 0
else:
second, cycle, tick = parse_ts(second, cycle, syt)
ts = calc_ts(second, cycle, tick)
datum.append(start)
datum.append(ts)
if ts == 0:
datum.append(0)
datum.append(0)
else:
# Usual case, or a case over 8 seconds.
if ts > start or start > 7 * 8000 * 3072:
datum.append(subtract_ts(ts, start))
if ts > prev or start > 7 * 8000 * 3072:
gap = subtract_ts(ts, prev)
datum.append(gap)
else:
datum.append('backward')
else:
datum.append('invalid')
prev = ts
data.append(datum)
sys.exit()
The data variable includes array with these elements:
- The index of the packet
- The number of data blocks in the packet
- The value of cycle count (hex)
- The value of CIP header 1 (hex)
- The value of CIP header 2 (hex)
- The value of cycle count (tick)
- The value of calculated presentation timestamp (tick)
- The offset between the cycle count and presentation timestamp
- The elapsed ticks from the previous presentation timestamp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:46 -06:00
|
|
|
|
ALSA: firewire-lib: add context information to tracepoints
In current implementation, packet processing is done in both of software
IRQ contexts of IR/IT contexts and process contexts.
This is usual interrupt handling of IR/IT context for 1394 OHCI.
(in hardware IRQ context)
irq_handler() (drivers/firewire/ohci.c)
->tasklet_schedule()
(in software IRQ context)
handle_it_packet() or handle_ir_packet_per_buffer() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
However, we have another chance for packet processing. It's done in PCM
frame handling via ALSA PCM interfaces.
(in process context)
ioctl(i.e. SNDRV_PCM_IOCTL_HWSYNC)
->snd_pcm_hwsync() (sound/core/pcm_native.c)
->snd_pcm_update_hw_ptr() (sound/core/pcm_lib.c)
->snd_pcm_update_hw_ptr0()
->struct snd_pcm_ops.pointer()
= amdtp_stream_pcm_pointer()
->fw_iso_context_flush_completions() (drivers/firewire/core-iso.c)
->struct fw_card_driver.flush_iso_completions()
= ohci_flush_iso_completions() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
This design is for a better granularity of PCM pointer. When ioctl(2) is
executed with some commands for ALSA PCM interface, queued packets are
handled at first. Then, the latest number of handled PCM frames is
reported. The number can represent PCM frames transferred in most near
isochronous cycle.
Current tracepoints include no information to distinguish running contexts.
When tracing the interval of software IRQ context, this is not good.
This commit adds more information for current context. Additionally, the
index of packet processed in one context is added in a case that packet
processing is executed in continuous context of the same kind,
As a result, the output includes 11 fields with additional two fields
to commit 0c95c1d6197f ("ALSA: firewire-lib: add tracepoints to dump a part
of isochronous packet data"):
17131.9186: out_packet: 07 7494 ffc0 ffc1 00 000700c0 9001a496 058 45 1 13
17131.9186: out_packet: 07 7495 ffc0 ffc1 00 000700c8 9001ba00 058 46 1 14
17131.9186: out_packet: 07 7496 ffc0 ffc1 00 000700d0 9001ffff 002 47 1 15
17131.9189: out_packet: 07 7497 ffc0 ffc1 00 000700d0 9001d36a 058 00 0 00
17131.9189: out_packet: 07 7498 ffc0 ffc1 00 000700d8 9001e8d4 058 01 0 01
17131.9189: out_packet: 07 7499 ffc0 ffc1 00 000700e0 9001023e 058 02 0 00
17131.9206: in_packet: 07 7447 ffc1 ffc0 01 3f070072 9001783d 058 32 1 00
17131.9206: in_packet: 07 7448 ffc1 ffc0 01 3f070072 90ffffff 002 33 1 01
17131.9206: in_packet: 07 7449 ffc1 ffc0 01 3f07007a 900191a8 058 34 1 02
(Here, some common fields are omitted so that a line is within 80
characters.)
The legend is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- The ID of node as destination (hex)
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
- 0 in process context, 1 in IRQ context
- The index of packet processed in the context
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-10 16:33:27 -06:00
|
|
|
trace_out_packet(s, cycle, buffer, payload_length, index);
|
ALSA: firewire-lib: add tracepoints to dump a part of isochronous packet data
When audio and music units have some quirks in their sequence of packet,
it's really hard for non-owners to identify the quirks. Although developers
need dumps for sequence of packets, it's difficult for users who have no
knowledges and no equipments for this purpose.
This commit adds tracepoints for this situation. When users encounter
the issue, they can dump a part of packet data via Linux tracing framework
as long as using drivers in ALSA firewire stack.
Additionally, tracepoints for outgoing packets will be our help to check
and debug packet processing of ALSA firewire stack.
This commit newly adds 'snd_firewire_lib' subsystem with 'in_packet' and
'out_packet' events. In the events, some attributes of packets and the
index of packet managed by this module are recorded per packet.
This is an usage:
$ trace-cmd record -e snd_firewire_lib:out_packet \
-e snd_firewire_lib:in_packet
/sys/kernel/tracing/events/snd_firewire_lib/out_packet/filter
/sys/kernel/tracing/events/snd_firewire_lib/in_packet/filter
Hit Ctrl^C to stop recording
^C
$ trace-cmd report trace.dat
...
23647.033934: in_packet: 01 4073 ffc0 ffc1 00 000f0040 9001b2d1 122 44
23647.033936: in_packet: 01 4074 ffc0 ffc1 00 000f0048 9001c83b 122 45
23647.033937: in_packet: 01 4075 ffc0 ffc1 00 000f0050 9001ffff 002 46
23647.033938: in_packet: 01 4076 ffc0 ffc1 00 000f0050 9001e1a6 122 47
23647.035426: out_packet: 01 4123 ffc1 ffc0 01 010f00d0 9001fb40 122 17
23647.035428: out_packet: 01 4124 ffc1 ffc0 01 010f00d8 9001ffff 002 18
23647.035429: out_packet: 01 4125 ffc1 ffc0 01 010f00d8 900114aa 122 19
23647.035430: out_packet: 01 4126 ffc1 ffc0 01 010f00e0 90012a15 122 20
(Here, some common fields are omitted so that a line to be within 80
characters.)
...
One line represent one packet. The legend for the last nine fields is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- Some devices transfer packets with invalid source node ID in their CIP
header.
- The ID of node as destination (hex)
- The value is not in CIP header of packets.
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
This is an example to parse these lines from text file by Python3 script:
\#!/usr/bin/env python3
import sys
def parse_ts(second, cycle, syt):
offset = syt & 0xfff
syt >>= 12
if cycle & 0x0f > syt:
cycle += 0x10
cycle &= 0x1ff0
cycle |= syt
second += cycle // 8000
cycle %= 8000
# In CYCLE_TIMER of 1394 OHCI, second is represented in 8 bit.
second %= 128
return (second, cycle, offset)
def calc_ts(second, cycle, offset):
ts = offset
ts += cycle * 3072
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
ts += (second % 8) * 8000 * 3072
return ts
def subtract_ts(minuend, subtrahend):
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
if minuend < subtrahend:
minuend += 8 * 8000 * 3072
return minuend - subtrahend
if len(sys.argv) != 2:
print('At least, one argument is required for packet dump.')
sys.exit()
filename = sys.argv[1]
data = []
prev = 0
with open(filename, 'r') as f:
for line in f:
pos = line.find('packet:')
if pos < 0:
continue
pos += len('packet:')
line = line[pos:].strip()
fields = line.split(' ')
datum = []
datum.append(fields[8])
syt = int(fields[6][4:], 16)
# Empty packet in IEC 61883-1, or NODATA in IEC 61883-6
if syt == 0xffff:
data_blocks = 0
else:
payload_size = int(fields[7], 10)
data_block_size = int(fields[5][2:4], 16)
data_blocks = (payload_size - 2) / data_block_size
datum.append(data_blocks)
second = int(fields[0], 10)
cycle = int(fields[1], 10)
start = (second << 25) | (cycle << 12)
datum.append('0x{0:08x}'.format(start))
start = calc_ts(second, cycle, 0)
datum.append("0x" + fields[5])
datum.append("0x" + fields[6])
if syt == 0xffff:
second = 0
cycle = 0
tick = 0
else:
second, cycle, tick = parse_ts(second, cycle, syt)
ts = calc_ts(second, cycle, tick)
datum.append(start)
datum.append(ts)
if ts == 0:
datum.append(0)
datum.append(0)
else:
# Usual case, or a case over 8 seconds.
if ts > start or start > 7 * 8000 * 3072:
datum.append(subtract_ts(ts, start))
if ts > prev or start > 7 * 8000 * 3072:
gap = subtract_ts(ts, prev)
datum.append(gap)
else:
datum.append('backward')
else:
datum.append('invalid')
prev = ts
data.append(datum)
sys.exit()
The data variable includes array with these elements:
- The index of the packet
- The number of data blocks in the packet
- The value of cycle count (hex)
- The value of CIP header 1 (hex)
- The value of CIP header 2 (hex)
- The value of cycle count (tick)
- The value of calculated presentation timestamp (tick)
- The offset between the cycle count and presentation timestamp
- The elapsed ticks from the previous presentation timestamp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:46 -06:00
|
|
|
|
2016-05-10 16:35:09 -06:00
|
|
|
if (queue_out_packet(s, payload_length) < 0)
|
2015-05-22 08:00:53 -06:00
|
|
|
return -EIO;
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2015-09-18 20:21:52 -06:00
|
|
|
pcm = ACCESS_ONCE(s->pcm);
|
|
|
|
if (pcm && pcm_frames > 0)
|
|
|
|
update_pcm_pointers(s, pcm, pcm_frames);
|
2015-05-22 08:00:53 -06:00
|
|
|
|
|
|
|
/* No need to return the number of handled data blocks. */
|
|
|
|
return 0;
|
2012-05-13 14:03:09 -06:00
|
|
|
}
|
|
|
|
|
2015-05-22 08:00:52 -06:00
|
|
|
static int handle_in_packet(struct amdtp_stream *s,
|
ALSA: firewire-lib: add context information to tracepoints
In current implementation, packet processing is done in both of software
IRQ contexts of IR/IT contexts and process contexts.
This is usual interrupt handling of IR/IT context for 1394 OHCI.
(in hardware IRQ context)
irq_handler() (drivers/firewire/ohci.c)
->tasklet_schedule()
(in software IRQ context)
handle_it_packet() or handle_ir_packet_per_buffer() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
However, we have another chance for packet processing. It's done in PCM
frame handling via ALSA PCM interfaces.
(in process context)
ioctl(i.e. SNDRV_PCM_IOCTL_HWSYNC)
->snd_pcm_hwsync() (sound/core/pcm_native.c)
->snd_pcm_update_hw_ptr() (sound/core/pcm_lib.c)
->snd_pcm_update_hw_ptr0()
->struct snd_pcm_ops.pointer()
= amdtp_stream_pcm_pointer()
->fw_iso_context_flush_completions() (drivers/firewire/core-iso.c)
->struct fw_card_driver.flush_iso_completions()
= ohci_flush_iso_completions() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
This design is for a better granularity of PCM pointer. When ioctl(2) is
executed with some commands for ALSA PCM interface, queued packets are
handled at first. Then, the latest number of handled PCM frames is
reported. The number can represent PCM frames transferred in most near
isochronous cycle.
Current tracepoints include no information to distinguish running contexts.
When tracing the interval of software IRQ context, this is not good.
This commit adds more information for current context. Additionally, the
index of packet processed in one context is added in a case that packet
processing is executed in continuous context of the same kind,
As a result, the output includes 11 fields with additional two fields
to commit 0c95c1d6197f ("ALSA: firewire-lib: add tracepoints to dump a part
of isochronous packet data"):
17131.9186: out_packet: 07 7494 ffc0 ffc1 00 000700c0 9001a496 058 45 1 13
17131.9186: out_packet: 07 7495 ffc0 ffc1 00 000700c8 9001ba00 058 46 1 14
17131.9186: out_packet: 07 7496 ffc0 ffc1 00 000700d0 9001ffff 002 47 1 15
17131.9189: out_packet: 07 7497 ffc0 ffc1 00 000700d0 9001d36a 058 00 0 00
17131.9189: out_packet: 07 7498 ffc0 ffc1 00 000700d8 9001e8d4 058 01 0 01
17131.9189: out_packet: 07 7499 ffc0 ffc1 00 000700e0 9001023e 058 02 0 00
17131.9206: in_packet: 07 7447 ffc1 ffc0 01 3f070072 9001783d 058 32 1 00
17131.9206: in_packet: 07 7448 ffc1 ffc0 01 3f070072 90ffffff 002 33 1 01
17131.9206: in_packet: 07 7449 ffc1 ffc0 01 3f07007a 900191a8 058 34 1 02
(Here, some common fields are omitted so that a line is within 80
characters.)
The legend is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- The ID of node as destination (hex)
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
- 0 in process context, 1 in IRQ context
- The index of packet processed in the context
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-10 16:33:27 -06:00
|
|
|
unsigned int payload_quadlets, unsigned int cycle,
|
|
|
|
unsigned int index)
|
2014-04-25 07:44:46 -06:00
|
|
|
{
|
2016-05-09 08:15:54 -06:00
|
|
|
__be32 *buffer;
|
2014-04-25 07:44:46 -06:00
|
|
|
u32 cip_header[2];
|
2016-05-09 08:15:54 -06:00
|
|
|
unsigned int fmt, fdf, syt;
|
2015-05-22 08:00:52 -06:00
|
|
|
unsigned int data_block_quadlets, data_block_counter, dbc_interval;
|
2016-05-09 08:15:54 -06:00
|
|
|
unsigned int data_blocks;
|
2015-09-18 20:21:52 -06:00
|
|
|
struct snd_pcm_substream *pcm;
|
|
|
|
unsigned int pcm_frames;
|
2014-04-25 07:45:04 -06:00
|
|
|
bool lost;
|
2014-04-25 07:44:46 -06:00
|
|
|
|
2016-05-09 08:15:54 -06:00
|
|
|
buffer = s->buffer.packets[s->packet_index].buffer;
|
2014-04-25 07:44:46 -06:00
|
|
|
cip_header[0] = be32_to_cpu(buffer[0]);
|
|
|
|
cip_header[1] = be32_to_cpu(buffer[1]);
|
|
|
|
|
ALSA: firewire-lib: add context information to tracepoints
In current implementation, packet processing is done in both of software
IRQ contexts of IR/IT contexts and process contexts.
This is usual interrupt handling of IR/IT context for 1394 OHCI.
(in hardware IRQ context)
irq_handler() (drivers/firewire/ohci.c)
->tasklet_schedule()
(in software IRQ context)
handle_it_packet() or handle_ir_packet_per_buffer() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
However, we have another chance for packet processing. It's done in PCM
frame handling via ALSA PCM interfaces.
(in process context)
ioctl(i.e. SNDRV_PCM_IOCTL_HWSYNC)
->snd_pcm_hwsync() (sound/core/pcm_native.c)
->snd_pcm_update_hw_ptr() (sound/core/pcm_lib.c)
->snd_pcm_update_hw_ptr0()
->struct snd_pcm_ops.pointer()
= amdtp_stream_pcm_pointer()
->fw_iso_context_flush_completions() (drivers/firewire/core-iso.c)
->struct fw_card_driver.flush_iso_completions()
= ohci_flush_iso_completions() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
This design is for a better granularity of PCM pointer. When ioctl(2) is
executed with some commands for ALSA PCM interface, queued packets are
handled at first. Then, the latest number of handled PCM frames is
reported. The number can represent PCM frames transferred in most near
isochronous cycle.
Current tracepoints include no information to distinguish running contexts.
When tracing the interval of software IRQ context, this is not good.
This commit adds more information for current context. Additionally, the
index of packet processed in one context is added in a case that packet
processing is executed in continuous context of the same kind,
As a result, the output includes 11 fields with additional two fields
to commit 0c95c1d6197f ("ALSA: firewire-lib: add tracepoints to dump a part
of isochronous packet data"):
17131.9186: out_packet: 07 7494 ffc0 ffc1 00 000700c0 9001a496 058 45 1 13
17131.9186: out_packet: 07 7495 ffc0 ffc1 00 000700c8 9001ba00 058 46 1 14
17131.9186: out_packet: 07 7496 ffc0 ffc1 00 000700d0 9001ffff 002 47 1 15
17131.9189: out_packet: 07 7497 ffc0 ffc1 00 000700d0 9001d36a 058 00 0 00
17131.9189: out_packet: 07 7498 ffc0 ffc1 00 000700d8 9001e8d4 058 01 0 01
17131.9189: out_packet: 07 7499 ffc0 ffc1 00 000700e0 9001023e 058 02 0 00
17131.9206: in_packet: 07 7447 ffc1 ffc0 01 3f070072 9001783d 058 32 1 00
17131.9206: in_packet: 07 7448 ffc1 ffc0 01 3f070072 90ffffff 002 33 1 01
17131.9206: in_packet: 07 7449 ffc1 ffc0 01 3f07007a 900191a8 058 34 1 02
(Here, some common fields are omitted so that a line is within 80
characters.)
The legend is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- The ID of node as destination (hex)
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
- 0 in process context, 1 in IRQ context
- The index of packet processed in the context
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-10 16:33:27 -06:00
|
|
|
trace_in_packet(s, cycle, cip_header, payload_quadlets, index);
|
ALSA: firewire-lib: add tracepoints to dump a part of isochronous packet data
When audio and music units have some quirks in their sequence of packet,
it's really hard for non-owners to identify the quirks. Although developers
need dumps for sequence of packets, it's difficult for users who have no
knowledges and no equipments for this purpose.
This commit adds tracepoints for this situation. When users encounter
the issue, they can dump a part of packet data via Linux tracing framework
as long as using drivers in ALSA firewire stack.
Additionally, tracepoints for outgoing packets will be our help to check
and debug packet processing of ALSA firewire stack.
This commit newly adds 'snd_firewire_lib' subsystem with 'in_packet' and
'out_packet' events. In the events, some attributes of packets and the
index of packet managed by this module are recorded per packet.
This is an usage:
$ trace-cmd record -e snd_firewire_lib:out_packet \
-e snd_firewire_lib:in_packet
/sys/kernel/tracing/events/snd_firewire_lib/out_packet/filter
/sys/kernel/tracing/events/snd_firewire_lib/in_packet/filter
Hit Ctrl^C to stop recording
^C
$ trace-cmd report trace.dat
...
23647.033934: in_packet: 01 4073 ffc0 ffc1 00 000f0040 9001b2d1 122 44
23647.033936: in_packet: 01 4074 ffc0 ffc1 00 000f0048 9001c83b 122 45
23647.033937: in_packet: 01 4075 ffc0 ffc1 00 000f0050 9001ffff 002 46
23647.033938: in_packet: 01 4076 ffc0 ffc1 00 000f0050 9001e1a6 122 47
23647.035426: out_packet: 01 4123 ffc1 ffc0 01 010f00d0 9001fb40 122 17
23647.035428: out_packet: 01 4124 ffc1 ffc0 01 010f00d8 9001ffff 002 18
23647.035429: out_packet: 01 4125 ffc1 ffc0 01 010f00d8 900114aa 122 19
23647.035430: out_packet: 01 4126 ffc1 ffc0 01 010f00e0 90012a15 122 20
(Here, some common fields are omitted so that a line to be within 80
characters.)
...
One line represent one packet. The legend for the last nine fields is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- Some devices transfer packets with invalid source node ID in their CIP
header.
- The ID of node as destination (hex)
- The value is not in CIP header of packets.
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
This is an example to parse these lines from text file by Python3 script:
\#!/usr/bin/env python3
import sys
def parse_ts(second, cycle, syt):
offset = syt & 0xfff
syt >>= 12
if cycle & 0x0f > syt:
cycle += 0x10
cycle &= 0x1ff0
cycle |= syt
second += cycle // 8000
cycle %= 8000
# In CYCLE_TIMER of 1394 OHCI, second is represented in 8 bit.
second %= 128
return (second, cycle, offset)
def calc_ts(second, cycle, offset):
ts = offset
ts += cycle * 3072
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
ts += (second % 8) * 8000 * 3072
return ts
def subtract_ts(minuend, subtrahend):
# In DMA descriptor of 1394 OHCI, second is represented in 3 bit.
if minuend < subtrahend:
minuend += 8 * 8000 * 3072
return minuend - subtrahend
if len(sys.argv) != 2:
print('At least, one argument is required for packet dump.')
sys.exit()
filename = sys.argv[1]
data = []
prev = 0
with open(filename, 'r') as f:
for line in f:
pos = line.find('packet:')
if pos < 0:
continue
pos += len('packet:')
line = line[pos:].strip()
fields = line.split(' ')
datum = []
datum.append(fields[8])
syt = int(fields[6][4:], 16)
# Empty packet in IEC 61883-1, or NODATA in IEC 61883-6
if syt == 0xffff:
data_blocks = 0
else:
payload_size = int(fields[7], 10)
data_block_size = int(fields[5][2:4], 16)
data_blocks = (payload_size - 2) / data_block_size
datum.append(data_blocks)
second = int(fields[0], 10)
cycle = int(fields[1], 10)
start = (second << 25) | (cycle << 12)
datum.append('0x{0:08x}'.format(start))
start = calc_ts(second, cycle, 0)
datum.append("0x" + fields[5])
datum.append("0x" + fields[6])
if syt == 0xffff:
second = 0
cycle = 0
tick = 0
else:
second, cycle, tick = parse_ts(second, cycle, syt)
ts = calc_ts(second, cycle, tick)
datum.append(start)
datum.append(ts)
if ts == 0:
datum.append(0)
datum.append(0)
else:
# Usual case, or a case over 8 seconds.
if ts > start or start > 7 * 8000 * 3072:
datum.append(subtract_ts(ts, start))
if ts > prev or start > 7 * 8000 * 3072:
gap = subtract_ts(ts, prev)
datum.append(gap)
else:
datum.append('backward')
else:
datum.append('invalid')
prev = ts
data.append(datum)
sys.exit()
The data variable includes array with these elements:
- The index of the packet
- The number of data blocks in the packet
- The value of cycle count (hex)
- The value of CIP header 1 (hex)
- The value of CIP header 2 (hex)
- The value of cycle count (tick)
- The value of calculated presentation timestamp (tick)
- The offset between the cycle count and presentation timestamp
- The elapsed ticks from the previous presentation timestamp
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:46 -06:00
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
/*
|
|
|
|
* This module supports 'Two-quadlet CIP header with SYT field'.
|
2014-04-25 07:44:50 -06:00
|
|
|
* For convenience, also check FMT field is AM824 or not.
|
2014-04-25 07:44:46 -06:00
|
|
|
*/
|
|
|
|
if (((cip_header[0] & CIP_EOH_MASK) == CIP_EOH) ||
|
2015-09-18 20:21:53 -06:00
|
|
|
((cip_header[1] & CIP_EOH_MASK) != CIP_EOH)) {
|
2014-04-25 07:44:46 -06:00
|
|
|
dev_info_ratelimited(&s->unit->device,
|
|
|
|
"Invalid CIP header for AMDTP: %08X:%08X\n",
|
|
|
|
cip_header[0], cip_header[1]);
|
2016-05-09 08:15:54 -06:00
|
|
|
data_blocks = 0;
|
2015-09-18 20:21:52 -06:00
|
|
|
pcm_frames = 0;
|
2014-04-25 07:44:46 -06:00
|
|
|
goto end;
|
|
|
|
}
|
|
|
|
|
2015-09-18 20:21:53 -06:00
|
|
|
/* Check valid protocol or not. */
|
|
|
|
fmt = (cip_header[1] & CIP_FMT_MASK) >> CIP_FMT_SHIFT;
|
|
|
|
if (fmt != s->fmt) {
|
2015-10-11 07:33:50 -06:00
|
|
|
dev_info_ratelimited(&s->unit->device,
|
|
|
|
"Detect unexpected protocol: %08x %08x\n",
|
|
|
|
cip_header[0], cip_header[1]);
|
2016-05-09 08:15:54 -06:00
|
|
|
data_blocks = 0;
|
2015-10-11 07:33:50 -06:00
|
|
|
pcm_frames = 0;
|
|
|
|
goto end;
|
2015-09-18 20:21:53 -06:00
|
|
|
}
|
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
/* Calculate data blocks */
|
2015-09-18 20:21:53 -06:00
|
|
|
fdf = (cip_header[1] & CIP_FDF_MASK) >> CIP_FDF_SHIFT;
|
2014-04-25 07:44:46 -06:00
|
|
|
if (payload_quadlets < 3 ||
|
2015-09-18 20:21:53 -06:00
|
|
|
(fmt == CIP_FMT_AM && fdf == AMDTP_FDF_NO_DATA)) {
|
2016-05-09 08:15:54 -06:00
|
|
|
data_blocks = 0;
|
2014-04-25 07:44:46 -06:00
|
|
|
} else {
|
|
|
|
data_block_quadlets =
|
2015-05-22 08:21:12 -06:00
|
|
|
(cip_header[0] & CIP_DBS_MASK) >> CIP_DBS_SHIFT;
|
2014-04-25 07:44:46 -06:00
|
|
|
/* avoid division by zero */
|
|
|
|
if (data_block_quadlets == 0) {
|
2015-05-22 08:21:13 -06:00
|
|
|
dev_err(&s->unit->device,
|
2014-04-25 07:44:46 -06:00
|
|
|
"Detect invalid value in dbs field: %08X\n",
|
|
|
|
cip_header[0]);
|
2015-05-22 08:21:14 -06:00
|
|
|
return -EPROTO;
|
2014-04-25 07:44:46 -06:00
|
|
|
}
|
2014-04-25 07:45:05 -06:00
|
|
|
if (s->flags & CIP_WRONG_DBS)
|
|
|
|
data_block_quadlets = s->data_block_quadlets;
|
2014-04-25 07:44:46 -06:00
|
|
|
|
2016-05-09 08:15:54 -06:00
|
|
|
data_blocks = (payload_quadlets - 2) / data_block_quadlets;
|
2014-04-25 07:44:46 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Check data block counter continuity */
|
2015-05-22 08:21:12 -06:00
|
|
|
data_block_counter = cip_header[0] & CIP_DBC_MASK;
|
2016-05-09 08:15:54 -06:00
|
|
|
if (data_blocks == 0 && (s->flags & CIP_EMPTY_HAS_WRONG_DBC) &&
|
2014-04-25 07:45:27 -06:00
|
|
|
s->data_block_counter != UINT_MAX)
|
|
|
|
data_block_counter = s->data_block_counter;
|
|
|
|
|
2015-08-04 18:21:05 -06:00
|
|
|
if (((s->flags & CIP_SKIP_DBC_ZERO_CHECK) &&
|
|
|
|
data_block_counter == s->tx_first_dbc) ||
|
|
|
|
s->data_block_counter == UINT_MAX) {
|
2014-04-25 07:45:07 -06:00
|
|
|
lost = false;
|
|
|
|
} else if (!(s->flags & CIP_DBC_IS_END_EVENT)) {
|
2014-04-25 07:45:04 -06:00
|
|
|
lost = data_block_counter != s->data_block_counter;
|
2014-04-25 07:45:06 -06:00
|
|
|
} else {
|
2016-05-09 08:15:54 -06:00
|
|
|
if (data_blocks > 0 && s->tx_dbc_interval > 0)
|
2014-04-25 07:45:06 -06:00
|
|
|
dbc_interval = s->tx_dbc_interval;
|
|
|
|
else
|
2016-05-09 08:15:54 -06:00
|
|
|
dbc_interval = data_blocks;
|
2014-04-25 07:45:06 -06:00
|
|
|
|
2014-04-25 07:45:04 -06:00
|
|
|
lost = data_block_counter !=
|
2014-04-25 07:45:06 -06:00
|
|
|
((s->data_block_counter + dbc_interval) & 0xff);
|
|
|
|
}
|
2014-04-25 07:45:04 -06:00
|
|
|
|
|
|
|
if (lost) {
|
2015-05-22 08:21:13 -06:00
|
|
|
dev_err(&s->unit->device,
|
|
|
|
"Detect discontinuity of CIP: %02X %02X\n",
|
|
|
|
s->data_block_counter, data_block_counter);
|
2015-05-22 08:00:52 -06:00
|
|
|
return -EIO;
|
2014-04-25 07:44:46 -06:00
|
|
|
}
|
|
|
|
|
2016-05-09 08:15:54 -06:00
|
|
|
syt = be32_to_cpu(buffer[1]) & CIP_SYT_MASK;
|
|
|
|
pcm_frames = s->process_data_blocks(s, buffer + 2, data_blocks, &syt);
|
2014-04-25 07:44:46 -06:00
|
|
|
|
2014-04-25 07:45:04 -06:00
|
|
|
if (s->flags & CIP_DBC_IS_END_EVENT)
|
|
|
|
s->data_block_counter = data_block_counter;
|
|
|
|
else
|
|
|
|
s->data_block_counter =
|
2016-05-09 08:15:54 -06:00
|
|
|
(data_block_counter + data_blocks) & 0xff;
|
2014-04-25 07:44:46 -06:00
|
|
|
end:
|
|
|
|
if (queue_in_packet(s) < 0)
|
2015-05-22 08:00:52 -06:00
|
|
|
return -EIO;
|
2014-04-25 07:44:46 -06:00
|
|
|
|
2015-09-18 20:21:52 -06:00
|
|
|
pcm = ACCESS_ONCE(s->pcm);
|
|
|
|
if (pcm && pcm_frames > 0)
|
|
|
|
update_pcm_pointers(s, pcm, pcm_frames);
|
2014-04-25 07:44:46 -06:00
|
|
|
|
2015-05-27 09:02:59 -06:00
|
|
|
return 0;
|
2014-04-25 07:44:46 -06:00
|
|
|
}
|
|
|
|
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
/*
|
|
|
|
* In CYCLE_TIMER register of IEEE 1394, 7 bits are used to represent second. On
|
|
|
|
* the other hand, in DMA descriptors of 1394 OHCI, 3 bits are used to represent
|
|
|
|
* it. Thus, via Linux firewire subsystem, we can get the 3 bits for second.
|
|
|
|
*/
|
|
|
|
static inline u32 compute_cycle_count(u32 tstamp)
|
|
|
|
{
|
|
|
|
return (((tstamp >> 13) & 0x07) * 8000) + (tstamp & 0x1fff);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline u32 increment_cycle_count(u32 cycle, unsigned int addend)
|
|
|
|
{
|
|
|
|
cycle += addend;
|
|
|
|
if (cycle >= 8 * CYCLES_PER_SECOND)
|
|
|
|
cycle -= 8 * CYCLES_PER_SECOND;
|
|
|
|
return cycle;
|
|
|
|
}
|
|
|
|
|
2016-05-09 06:12:45 -06:00
|
|
|
static inline u32 decrement_cycle_count(u32 cycle, unsigned int subtrahend)
|
|
|
|
{
|
|
|
|
if (cycle < subtrahend)
|
|
|
|
cycle += 8 * CYCLES_PER_SECOND;
|
|
|
|
return cycle - subtrahend;
|
|
|
|
}
|
|
|
|
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
static void out_stream_callback(struct fw_iso_context *context, u32 tstamp,
|
2014-04-25 07:44:45 -06:00
|
|
|
size_t header_length, void *header,
|
|
|
|
void *private_data)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
2014-04-25 07:44:42 -06:00
|
|
|
struct amdtp_stream *s = private_data;
|
2016-05-09 08:15:55 -06:00
|
|
|
unsigned int i, packets = header_length / 4;
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
u32 cycle;
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2015-05-22 08:00:53 -06:00
|
|
|
if (s->packet_index < 0)
|
|
|
|
return;
|
|
|
|
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
cycle = compute_cycle_count(tstamp);
|
|
|
|
|
|
|
|
/* Align to actual cycle count for the last packet. */
|
|
|
|
cycle = increment_cycle_count(cycle, QUEUE_LENGTH - packets);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2014-04-25 07:44:48 -06:00
|
|
|
for (i = 0; i < packets; ++i) {
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
cycle = increment_cycle_count(cycle, 1);
|
ALSA: firewire-lib: add context information to tracepoints
In current implementation, packet processing is done in both of software
IRQ contexts of IR/IT contexts and process contexts.
This is usual interrupt handling of IR/IT context for 1394 OHCI.
(in hardware IRQ context)
irq_handler() (drivers/firewire/ohci.c)
->tasklet_schedule()
(in software IRQ context)
handle_it_packet() or handle_ir_packet_per_buffer() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
However, we have another chance for packet processing. It's done in PCM
frame handling via ALSA PCM interfaces.
(in process context)
ioctl(i.e. SNDRV_PCM_IOCTL_HWSYNC)
->snd_pcm_hwsync() (sound/core/pcm_native.c)
->snd_pcm_update_hw_ptr() (sound/core/pcm_lib.c)
->snd_pcm_update_hw_ptr0()
->struct snd_pcm_ops.pointer()
= amdtp_stream_pcm_pointer()
->fw_iso_context_flush_completions() (drivers/firewire/core-iso.c)
->struct fw_card_driver.flush_iso_completions()
= ohci_flush_iso_completions() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
This design is for a better granularity of PCM pointer. When ioctl(2) is
executed with some commands for ALSA PCM interface, queued packets are
handled at first. Then, the latest number of handled PCM frames is
reported. The number can represent PCM frames transferred in most near
isochronous cycle.
Current tracepoints include no information to distinguish running contexts.
When tracing the interval of software IRQ context, this is not good.
This commit adds more information for current context. Additionally, the
index of packet processed in one context is added in a case that packet
processing is executed in continuous context of the same kind,
As a result, the output includes 11 fields with additional two fields
to commit 0c95c1d6197f ("ALSA: firewire-lib: add tracepoints to dump a part
of isochronous packet data"):
17131.9186: out_packet: 07 7494 ffc0 ffc1 00 000700c0 9001a496 058 45 1 13
17131.9186: out_packet: 07 7495 ffc0 ffc1 00 000700c8 9001ba00 058 46 1 14
17131.9186: out_packet: 07 7496 ffc0 ffc1 00 000700d0 9001ffff 002 47 1 15
17131.9189: out_packet: 07 7497 ffc0 ffc1 00 000700d0 9001d36a 058 00 0 00
17131.9189: out_packet: 07 7498 ffc0 ffc1 00 000700d8 9001e8d4 058 01 0 01
17131.9189: out_packet: 07 7499 ffc0 ffc1 00 000700e0 9001023e 058 02 0 00
17131.9206: in_packet: 07 7447 ffc1 ffc0 01 3f070072 9001783d 058 32 1 00
17131.9206: in_packet: 07 7448 ffc1 ffc0 01 3f070072 90ffffff 002 33 1 01
17131.9206: in_packet: 07 7449 ffc1 ffc0 01 3f07007a 900191a8 058 34 1 02
(Here, some common fields are omitted so that a line is within 80
characters.)
The legend is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- The ID of node as destination (hex)
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
- 0 in process context, 1 in IRQ context
- The index of packet processed in the context
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-10 16:33:27 -06:00
|
|
|
if (handle_out_packet(s, cycle, i) < 0) {
|
2015-05-22 08:00:53 -06:00
|
|
|
s->packet_index = -1;
|
|
|
|
amdtp_stream_pcm_abort(s);
|
|
|
|
return;
|
|
|
|
}
|
2014-04-25 07:44:48 -06:00
|
|
|
}
|
2015-05-22 08:00:53 -06:00
|
|
|
|
2011-05-02 01:33:56 -06:00
|
|
|
fw_iso_context_queue_flush(s->context);
|
2011-03-15 00:53:21 -06:00
|
|
|
}
|
|
|
|
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
static void in_stream_callback(struct fw_iso_context *context, u32 tstamp,
|
2014-04-25 07:44:46 -06:00
|
|
|
size_t header_length, void *header,
|
|
|
|
void *private_data)
|
|
|
|
{
|
|
|
|
struct amdtp_stream *s = private_data;
|
2016-05-09 08:15:54 -06:00
|
|
|
unsigned int i, packets;
|
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 08:00:50 -06:00
|
|
|
unsigned int payload_quadlets, max_payload_quadlets;
|
2016-05-09 08:15:54 -06:00
|
|
|
__be32 *headers = header;
|
2016-05-09 06:12:45 -06:00
|
|
|
u32 cycle;
|
2014-04-25 07:44:46 -06:00
|
|
|
|
2015-05-22 08:00:53 -06:00
|
|
|
if (s->packet_index < 0)
|
|
|
|
return;
|
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
/* The number of packets in buffer */
|
|
|
|
packets = header_length / IN_PACKET_HEADER_SIZE;
|
|
|
|
|
2016-05-09 06:12:45 -06:00
|
|
|
cycle = compute_cycle_count(tstamp);
|
|
|
|
|
|
|
|
/* Align to actual cycle count for the last packet. */
|
|
|
|
cycle = decrement_cycle_count(cycle, packets);
|
|
|
|
|
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 08:00:50 -06:00
|
|
|
/* For buffer-over-run prevention. */
|
|
|
|
max_payload_quadlets = amdtp_stream_get_max_payload(s) / 4;
|
|
|
|
|
2016-05-09 08:15:54 -06:00
|
|
|
for (i = 0; i < packets; i++) {
|
2016-05-09 06:12:45 -06:00
|
|
|
cycle = increment_cycle_count(cycle, 1);
|
2014-04-25 07:44:46 -06:00
|
|
|
|
|
|
|
/* The number of quadlets in this packet */
|
|
|
|
payload_quadlets =
|
2016-05-09 08:15:54 -06:00
|
|
|
(be32_to_cpu(headers[i]) >> ISO_DATA_LENGTH_SHIFT) / 4;
|
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 08:00:50 -06:00
|
|
|
if (payload_quadlets > max_payload_quadlets) {
|
|
|
|
dev_err(&s->unit->device,
|
|
|
|
"Detect jumbo payload: %02x %02x\n",
|
|
|
|
payload_quadlets, max_payload_quadlets);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
ALSA: firewire-lib: add context information to tracepoints
In current implementation, packet processing is done in both of software
IRQ contexts of IR/IT contexts and process contexts.
This is usual interrupt handling of IR/IT context for 1394 OHCI.
(in hardware IRQ context)
irq_handler() (drivers/firewire/ohci.c)
->tasklet_schedule()
(in software IRQ context)
handle_it_packet() or handle_ir_packet_per_buffer() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
However, we have another chance for packet processing. It's done in PCM
frame handling via ALSA PCM interfaces.
(in process context)
ioctl(i.e. SNDRV_PCM_IOCTL_HWSYNC)
->snd_pcm_hwsync() (sound/core/pcm_native.c)
->snd_pcm_update_hw_ptr() (sound/core/pcm_lib.c)
->snd_pcm_update_hw_ptr0()
->struct snd_pcm_ops.pointer()
= amdtp_stream_pcm_pointer()
->fw_iso_context_flush_completions() (drivers/firewire/core-iso.c)
->struct fw_card_driver.flush_iso_completions()
= ohci_flush_iso_completions() (drivers/firewire/ohci.c)
->flush_iso_completions()
->struct fw_iso_context.callback.sc()
= out_stream_callback() or in_stream_callback()
This design is for a better granularity of PCM pointer. When ioctl(2) is
executed with some commands for ALSA PCM interface, queued packets are
handled at first. Then, the latest number of handled PCM frames is
reported. The number can represent PCM frames transferred in most near
isochronous cycle.
Current tracepoints include no information to distinguish running contexts.
When tracing the interval of software IRQ context, this is not good.
This commit adds more information for current context. Additionally, the
index of packet processed in one context is added in a case that packet
processing is executed in continuous context of the same kind,
As a result, the output includes 11 fields with additional two fields
to commit 0c95c1d6197f ("ALSA: firewire-lib: add tracepoints to dump a part
of isochronous packet data"):
17131.9186: out_packet: 07 7494 ffc0 ffc1 00 000700c0 9001a496 058 45 1 13
17131.9186: out_packet: 07 7495 ffc0 ffc1 00 000700c8 9001ba00 058 46 1 14
17131.9186: out_packet: 07 7496 ffc0 ffc1 00 000700d0 9001ffff 002 47 1 15
17131.9189: out_packet: 07 7497 ffc0 ffc1 00 000700d0 9001d36a 058 00 0 00
17131.9189: out_packet: 07 7498 ffc0 ffc1 00 000700d8 9001e8d4 058 01 0 01
17131.9189: out_packet: 07 7499 ffc0 ffc1 00 000700e0 9001023e 058 02 0 00
17131.9206: in_packet: 07 7447 ffc1 ffc0 01 3f070072 9001783d 058 32 1 00
17131.9206: in_packet: 07 7448 ffc1 ffc0 01 3f070072 90ffffff 002 33 1 01
17131.9206: in_packet: 07 7449 ffc1 ffc0 01 3f07007a 900191a8 058 34 1 02
(Here, some common fields are omitted so that a line is within 80
characters.)
The legend is:
- The second of cycle scheduled for the packet
- The count of cycle scheduled for the packet
- The ID of node as source (hex)
- The ID of node as destination (hex)
- The value of isochronous channel
- The first quadlet of CIP header (hex)
- The second quadlet of CIP header (hex)
- The number of included quadlets
- The index of packet in a buffer maintained by this module
- 0 in process context, 1 in IRQ context
- The index of packet processed in the context
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-10 16:33:27 -06:00
|
|
|
if (handle_in_packet(s, payload_quadlets, cycle, i) < 0)
|
2015-05-22 08:00:52 -06:00
|
|
|
break;
|
2014-04-25 07:44:46 -06:00
|
|
|
}
|
|
|
|
|
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 08:15:53 -06:00
|
|
|
/* Queueing error or detecting invalid payload. */
|
2016-05-09 08:15:54 -06:00
|
|
|
if (i < packets) {
|
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 08:15:53 -06:00
|
|
|
s->packet_index = -1;
|
2015-05-22 08:00:52 -06:00
|
|
|
amdtp_stream_pcm_abort(s);
|
2014-04-25 07:44:49 -06:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
fw_iso_context_queue_flush(s->context);
|
|
|
|
}
|
|
|
|
|
2014-04-25 07:44:49 -06:00
|
|
|
/* this is executed one time */
|
|
|
|
static void amdtp_stream_first_callback(struct fw_iso_context *context,
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
u32 tstamp, size_t header_length,
|
2014-04-25 07:44:49 -06:00
|
|
|
void *header, void *private_data)
|
|
|
|
{
|
|
|
|
struct amdtp_stream *s = private_data;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* For in-stream, first packet has come.
|
|
|
|
* For out-stream, prepared to transmit first packet
|
|
|
|
*/
|
|
|
|
s->callbacked = true;
|
|
|
|
wake_up(&s->callback_wait);
|
|
|
|
|
|
|
|
if (s->direction == AMDTP_IN_STREAM)
|
|
|
|
context->callback.sc = in_stream_callback;
|
|
|
|
else
|
|
|
|
context->callback.sc = out_stream_callback;
|
|
|
|
|
ALSA: firewire-lib: compute the value of second field in cycle count for IT context
In callback function of isochronous context, u32 variable is passed for
cycle count. The value of this variable comes from DMA descriptors of 1394
Open Host Controller Interface (1394 OHCI). In the specification, DMA
descriptors transport lower 3 bits for second field and full cycle field in
16 bits field, therefore 16 bits of the u32 variable are available. The
value for second is modulo 8, and the value for cycle is modulo 8,000.
Currently, ALSA firewire-lib module don't use the value of the second
field, because the value is useless to calculate presentation timestamp in
IEC 61883-6. However, the value may be useful for debugging. In later
commit, it will be printed with the other parameters for debugging.
This commit makes this module to handle the whole cycle count including
second. The value is calculated by cycle unit. The existed code is already
written with ignoring the value of second, thus this commit causes no
issues.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-05-09 06:12:44 -06:00
|
|
|
context->callback.sc(context, tstamp, header_length, header, s);
|
2014-04-25 07:44:49 -06:00
|
|
|
}
|
|
|
|
|
2011-03-15 00:53:21 -06:00
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_start - start transferring packets
|
|
|
|
* @s: the AMDTP stream to start
|
2011-03-15 00:53:21 -06:00
|
|
|
* @channel: the isochronous channel on the bus
|
|
|
|
* @speed: firewire speed code
|
|
|
|
*
|
|
|
|
* The stream cannot be started until it has been configured with
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_set_parameters() and it must be started before any PCM or MIDI
|
|
|
|
* device can be started.
|
2011-03-15 00:53:21 -06:00
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
|
|
|
static const struct {
|
|
|
|
unsigned int data_block;
|
|
|
|
unsigned int syt_offset;
|
|
|
|
} initial_state[] = {
|
|
|
|
[CIP_SFC_32000] = { 4, 3072 },
|
|
|
|
[CIP_SFC_48000] = { 6, 1024 },
|
|
|
|
[CIP_SFC_96000] = { 12, 1024 },
|
|
|
|
[CIP_SFC_192000] = { 24, 1024 },
|
|
|
|
[CIP_SFC_44100] = { 0, 67 },
|
|
|
|
[CIP_SFC_88200] = { 0, 67 },
|
|
|
|
[CIP_SFC_176400] = { 0, 67 },
|
|
|
|
};
|
2014-04-25 07:44:46 -06:00
|
|
|
unsigned int header_size;
|
|
|
|
enum dma_data_direction dir;
|
2014-04-25 07:45:03 -06:00
|
|
|
int type, tag, err;
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
mutex_lock(&s->mutex);
|
|
|
|
|
2014-04-25 07:44:42 -06:00
|
|
|
if (WARN_ON(amdtp_stream_running(s) ||
|
2014-04-25 07:44:45 -06:00
|
|
|
(s->data_block_quadlets < 1))) {
|
2011-03-15 00:53:21 -06:00
|
|
|
err = -EBADFD;
|
|
|
|
goto err_unlock;
|
|
|
|
}
|
|
|
|
|
2016-05-09 08:15:56 -06:00
|
|
|
if (s->direction == AMDTP_IN_STREAM)
|
2014-04-25 07:45:16 -06:00
|
|
|
s->data_block_counter = UINT_MAX;
|
|
|
|
else
|
|
|
|
s->data_block_counter = 0;
|
2011-03-15 00:53:21 -06:00
|
|
|
s->data_block_state = initial_state[s->sfc].data_block;
|
|
|
|
s->syt_offset_state = initial_state[s->sfc].syt_offset;
|
|
|
|
s->last_syt_offset = TICKS_PER_CYCLE;
|
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
/* initialize packet buffer */
|
|
|
|
if (s->direction == AMDTP_IN_STREAM) {
|
|
|
|
dir = DMA_FROM_DEVICE;
|
|
|
|
type = FW_ISO_CONTEXT_RECEIVE;
|
|
|
|
header_size = IN_PACKET_HEADER_SIZE;
|
|
|
|
} else {
|
|
|
|
dir = DMA_TO_DEVICE;
|
|
|
|
type = FW_ISO_CONTEXT_TRANSMIT;
|
|
|
|
header_size = OUT_PACKET_HEADER_SIZE;
|
|
|
|
}
|
2011-03-15 00:53:21 -06:00
|
|
|
err = iso_packets_buffer_init(&s->buffer, s->unit, QUEUE_LENGTH,
|
2014-04-25 07:44:46 -06:00
|
|
|
amdtp_stream_get_max_payload(s), dir);
|
2011-03-15 00:53:21 -06:00
|
|
|
if (err < 0)
|
|
|
|
goto err_unlock;
|
|
|
|
|
|
|
|
s->context = fw_iso_context_create(fw_parent_device(s->unit)->card,
|
2014-04-25 07:44:46 -06:00
|
|
|
type, channel, speed, header_size,
|
2014-04-25 07:44:49 -06:00
|
|
|
amdtp_stream_first_callback, s);
|
2011-03-15 00:53:21 -06:00
|
|
|
if (IS_ERR(s->context)) {
|
|
|
|
err = PTR_ERR(s->context);
|
|
|
|
if (err == -EBUSY)
|
|
|
|
dev_err(&s->unit->device,
|
2014-04-25 07:44:42 -06:00
|
|
|
"no free stream on this controller\n");
|
2011-03-15 00:53:21 -06:00
|
|
|
goto err_buffer;
|
|
|
|
}
|
|
|
|
|
2014-04-25 07:44:42 -06:00
|
|
|
amdtp_stream_update(s);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2011-03-15 00:57:24 -06:00
|
|
|
s->packet_index = 0;
|
2014-04-25 07:44:45 -06:00
|
|
|
do {
|
2014-04-25 07:44:46 -06:00
|
|
|
if (s->direction == AMDTP_IN_STREAM)
|
|
|
|
err = queue_in_packet(s);
|
|
|
|
else
|
2016-05-10 16:35:09 -06:00
|
|
|
err = queue_out_packet(s, 0);
|
2014-04-25 07:44:45 -06:00
|
|
|
if (err < 0)
|
|
|
|
goto err_context;
|
|
|
|
} while (s->packet_index > 0);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2014-04-25 07:44:46 -06:00
|
|
|
/* NOTE: TAG1 matches CIP. This just affects in stream. */
|
2014-04-25 07:45:03 -06:00
|
|
|
tag = FW_ISO_CONTEXT_MATCH_TAG1;
|
|
|
|
if (s->flags & CIP_EMPTY_WITH_TAG0)
|
|
|
|
tag |= FW_ISO_CONTEXT_MATCH_TAG0;
|
|
|
|
|
2014-04-25 07:44:49 -06:00
|
|
|
s->callbacked = false;
|
2014-04-25 07:45:03 -06:00
|
|
|
err = fw_iso_context_start(s->context, -1, 0, tag);
|
2011-03-15 00:53:21 -06:00
|
|
|
if (err < 0)
|
|
|
|
goto err_context;
|
|
|
|
|
|
|
|
mutex_unlock(&s->mutex);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
err_context:
|
|
|
|
fw_iso_context_destroy(s->context);
|
|
|
|
s->context = ERR_PTR(-1);
|
|
|
|
err_buffer:
|
|
|
|
iso_packets_buffer_destroy(&s->buffer, s->unit);
|
|
|
|
err_unlock:
|
|
|
|
mutex_unlock(&s->mutex);
|
|
|
|
|
|
|
|
return err;
|
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_start);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
2012-05-13 10:49:14 -06:00
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_pcm_pointer - get the PCM buffer position
|
|
|
|
* @s: the AMDTP stream that transports the PCM data
|
2012-05-13 10:49:14 -06:00
|
|
|
*
|
|
|
|
* Returns the current buffer position, in frames.
|
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s)
|
2012-05-13 10:49:14 -06:00
|
|
|
{
|
2016-05-11 11:17:39 -06:00
|
|
|
/*
|
|
|
|
* This function is called in software IRQ context of period_tasklet or
|
|
|
|
* process context.
|
|
|
|
*
|
|
|
|
* When the software IRQ context was scheduled by software IRQ context
|
|
|
|
* of IR/IT contexts, queued packets were already handled. Therefore,
|
|
|
|
* no need to flush the queue in buffer anymore.
|
|
|
|
*
|
|
|
|
* When the process context reach here, some packets will be already
|
|
|
|
* queued in the buffer. These packets should be handled immediately
|
|
|
|
* to keep better granularity of PCM pointer.
|
|
|
|
*
|
|
|
|
* Later, the process context will sometimes schedules software IRQ
|
|
|
|
* context of the period_tasklet. Then, no need to flush the queue by
|
|
|
|
* the same reason as described for IR/IT contexts.
|
|
|
|
*/
|
|
|
|
if (!in_interrupt() && amdtp_stream_running(s))
|
2012-05-13 11:07:22 -06:00
|
|
|
fw_iso_context_flush_completions(s->context);
|
2012-05-13 10:49:14 -06:00
|
|
|
|
|
|
|
return ACCESS_ONCE(s->pcm_buffer_pointer);
|
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_pcm_pointer);
|
2012-05-13 10:49:14 -06:00
|
|
|
|
2011-03-15 00:53:21 -06:00
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_update - update the stream after a bus reset
|
|
|
|
* @s: the AMDTP stream
|
2011-03-15 00:53:21 -06:00
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
void amdtp_stream_update(struct amdtp_stream *s)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
2015-05-22 08:21:12 -06:00
|
|
|
/* Precomputing. */
|
2011-03-15 00:53:21 -06:00
|
|
|
ACCESS_ONCE(s->source_node_id_field) =
|
2015-05-22 08:21:12 -06:00
|
|
|
(fw_parent_device(s->unit)->card->node_id << CIP_SID_SHIFT) &
|
|
|
|
CIP_SID_MASK;
|
2011-03-15 00:53:21 -06:00
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_update);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_stop - stop sending packets
|
|
|
|
* @s: the AMDTP stream to stop
|
2011-03-15 00:53:21 -06:00
|
|
|
*
|
|
|
|
* All PCM and MIDI devices of the stream must be stopped before the stream
|
|
|
|
* itself can be stopped.
|
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
void amdtp_stream_stop(struct amdtp_stream *s)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
|
|
|
mutex_lock(&s->mutex);
|
|
|
|
|
2014-04-25 07:44:42 -06:00
|
|
|
if (!amdtp_stream_running(s)) {
|
2011-03-15 00:53:21 -06:00
|
|
|
mutex_unlock(&s->mutex);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2012-05-13 14:03:09 -06:00
|
|
|
tasklet_kill(&s->period_tasklet);
|
2011-03-15 00:53:21 -06:00
|
|
|
fw_iso_context_stop(s->context);
|
|
|
|
fw_iso_context_destroy(s->context);
|
|
|
|
s->context = ERR_PTR(-1);
|
|
|
|
iso_packets_buffer_destroy(&s->buffer, s->unit);
|
|
|
|
|
2014-04-25 07:44:49 -06:00
|
|
|
s->callbacked = false;
|
|
|
|
|
2011-03-15 00:53:21 -06:00
|
|
|
mutex_unlock(&s->mutex);
|
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_stop);
|
2011-03-15 00:53:21 -06:00
|
|
|
|
|
|
|
/**
|
2014-04-25 07:44:42 -06:00
|
|
|
* amdtp_stream_pcm_abort - abort the running PCM device
|
2011-03-15 00:53:21 -06:00
|
|
|
* @s: the AMDTP stream about to be stopped
|
|
|
|
*
|
|
|
|
* If the isochronous stream needs to be stopped asynchronously, call this
|
|
|
|
* function first to stop the PCM device.
|
|
|
|
*/
|
2014-04-25 07:44:42 -06:00
|
|
|
void amdtp_stream_pcm_abort(struct amdtp_stream *s)
|
2011-03-15 00:53:21 -06:00
|
|
|
{
|
|
|
|
struct snd_pcm_substream *pcm;
|
|
|
|
|
|
|
|
pcm = ACCESS_ONCE(s->pcm);
|
2014-11-07 09:08:28 -07:00
|
|
|
if (pcm)
|
|
|
|
snd_pcm_stop_xrun(pcm);
|
2011-03-15 00:53:21 -06:00
|
|
|
}
|
2014-04-25 07:44:42 -06:00
|
|
|
EXPORT_SYMBOL(amdtp_stream_pcm_abort);
|