Blame view
sound/firewire/amdtp-am824.c
11.8 KB
da607e196 treewide: Replace... |
1 |
// SPDX-License-Identifier: GPL-2.0-only |
5955815e7 ALSA: firewire-li... |
2 3 4 |
/* * AM824 format in Audio and Music Data Transmission Protocol (IEC 61883-6) * |
df075feef ALSA: firewire-li... |
5 |
* Copyright (c) Clemens Ladisch <clemens@ladisch.de> |
5955815e7 ALSA: firewire-li... |
6 |
* Copyright (c) 2015 Takashi Sakamoto <o-takashi@sakamocchi.jp> |
5955815e7 ALSA: firewire-li... |
7 |
*/ |
df075feef ALSA: firewire-li... |
8 |
#include <linux/slab.h> |
5955815e7 ALSA: firewire-li... |
9 10 11 |
#include "amdtp-am824.h" #define CIP_FMT_AM 0x10 |
51c29fd21 ALSA: firewire-li... |
12 13 |
/* "Clock-based rate control mode" is just supported. */ #define AMDTP_FDF_AM824 0x00 |
df075feef ALSA: firewire-li... |
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
/* * Nominally 3125 bytes/second, but the MIDI port's clock might be * 1% too slow, and the bus clock 100 ppm too fast. */ #define MIDI_BYTES_PER_SECOND 3093 /* * Several devices look only at the first eight data blocks. * In any case, this is more than enough for the MIDI data rate. */ #define MAX_MIDI_RX_BLOCKS 8 struct amdtp_am824 { struct snd_rawmidi_substream *midi[AM824_MAX_CHANNELS_FOR_MIDI * 8]; int midi_fifo_limit; int midi_fifo_used[AM824_MAX_CHANNELS_FOR_MIDI * 8]; unsigned int pcm_channels; unsigned int midi_ports; u8 pcm_positions[AM824_MAX_CHANNELS_FOR_PCM]; u8 midi_position; |
df075feef ALSA: firewire-li... |
35 36 |
unsigned int frame_multiplier; }; |
51c29fd21 ALSA: firewire-li... |
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
/** * amdtp_am824_set_parameters - set stream parameters * @s: the AMDTP stream to configure * @rate: the sample rate * @pcm_channels: the number of PCM samples in each data block, to be encoded * as AM824 multi-bit linear audio * @midi_ports: the number of MIDI ports (i.e., MPX-MIDI Data Channels) * @double_pcm_frames: one data block transfers two PCM frames * * The parameters must be set before the stream is started, and must not be * changed while the stream is running. */ int amdtp_am824_set_parameters(struct amdtp_stream *s, unsigned int rate, unsigned int pcm_channels, unsigned int midi_ports, bool double_pcm_frames) { |
df075feef ALSA: firewire-li... |
54 55 56 |
struct amdtp_am824 *p = s->protocol; unsigned int midi_channels; unsigned int i; |
51c29fd21 ALSA: firewire-li... |
57 |
int err; |
df075feef ALSA: firewire-li... |
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
if (amdtp_stream_running(s)) return -EINVAL; if (pcm_channels > AM824_MAX_CHANNELS_FOR_PCM) return -EINVAL; midi_channels = DIV_ROUND_UP(midi_ports, 8); if (midi_channels > AM824_MAX_CHANNELS_FOR_MIDI) return -EINVAL; if (WARN_ON(amdtp_stream_running(s)) || WARN_ON(pcm_channels > AM824_MAX_CHANNELS_FOR_PCM) || WARN_ON(midi_channels > AM824_MAX_CHANNELS_FOR_MIDI)) return -EINVAL; err = amdtp_stream_set_parameters(s, rate, pcm_channels + midi_channels); |
51c29fd21 ALSA: firewire-li... |
75 76 |
if (err < 0) return err; |
8304cf77c ALSA: firewire-li... |
77 78 |
if (s->direction == AMDTP_OUT_STREAM) s->ctx_data.rx.fdf = AMDTP_FDF_AM824 | s->sfc; |
51c29fd21 ALSA: firewire-li... |
79 |
|
df075feef ALSA: firewire-li... |
80 81 |
p->pcm_channels = pcm_channels; p->midi_ports = midi_ports; |
51c29fd21 ALSA: firewire-li... |
82 83 84 85 86 87 |
/* * In IEC 61883-6, one data block represents one event. In ALSA, one * event equals to one PCM frame. But Dice has a quirk at higher * sampling rate to transfer two PCM frames in one data block. */ if (double_pcm_frames) |
df075feef ALSA: firewire-li... |
88 |
p->frame_multiplier = 2; |
51c29fd21 ALSA: firewire-li... |
89 |
else |
df075feef ALSA: firewire-li... |
90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
p->frame_multiplier = 1; /* init the position map for PCM and MIDI channels */ for (i = 0; i < pcm_channels; i++) p->pcm_positions[i] = i; p->midi_position = p->pcm_channels; /* * We do not know the actual MIDI FIFO size of most devices. Just * assume two bytes, i.e., one byte can be received over the bus while * the previous one is transmitted over MIDI. * (The value here is adjusted for midi_ratelimit_per_packet().) */ p->midi_fifo_limit = rate - MIDI_BYTES_PER_SECOND * s->syt_interval + 1; |
51c29fd21 ALSA: firewire-li... |
104 105 106 107 |
return 0; } EXPORT_SYMBOL_GPL(amdtp_am824_set_parameters); |
5955815e7 ALSA: firewire-li... |
108 |
/** |
f65be911c ALSA: firewire-li... |
109 110 111 112 113 114 115 116 117 |
* amdtp_am824_set_pcm_position - set an index of data channel for a channel * of PCM frame * @s: the AMDTP stream * @index: the index of data channel in an data block * @position: the channel of PCM frame */ void amdtp_am824_set_pcm_position(struct amdtp_stream *s, unsigned int index, unsigned int position) { |
df075feef ALSA: firewire-li... |
118 119 120 121 |
struct amdtp_am824 *p = s->protocol; if (index < p->pcm_channels) p->pcm_positions[index] = position; |
f65be911c ALSA: firewire-li... |
122 123 124 125 126 127 128 129 130 131 132 133 |
} EXPORT_SYMBOL_GPL(amdtp_am824_set_pcm_position); /** * amdtp_am824_set_midi_position - set a index of data channel for MIDI * conformant data channel * @s: the AMDTP stream * @position: the index of data channel in an data block */ void amdtp_am824_set_midi_position(struct amdtp_stream *s, unsigned int position) { |
df075feef ALSA: firewire-li... |
134 135 136 |
struct amdtp_am824 *p = s->protocol; p->midi_position = position; |
f65be911c ALSA: firewire-li... |
137 138 |
} EXPORT_SYMBOL_GPL(amdtp_am824_set_midi_position); |
9fc90644c ALSA: firewire-li... |
139 140 141 |
static void write_pcm_s32(struct amdtp_stream *s, struct snd_pcm_substream *pcm, __be32 *buffer, unsigned int frames, unsigned int pcm_frames) |
df075feef ALSA: firewire-li... |
142 143 |
{ struct amdtp_am824 *p = s->protocol; |
9fc90644c ALSA: firewire-li... |
144 |
unsigned int channels = p->pcm_channels; |
df075feef ALSA: firewire-li... |
145 |
struct snd_pcm_runtime *runtime = pcm->runtime; |
9fc90644c ALSA: firewire-li... |
146 147 |
unsigned int pcm_buffer_pointer; int remaining_frames; |
df075feef ALSA: firewire-li... |
148 |
const u32 *src; |
9fc90644c ALSA: firewire-li... |
149 150 151 152 |
int i, c; pcm_buffer_pointer = s->pcm_buffer_pointer + pcm_frames; pcm_buffer_pointer %= runtime->buffer_size; |
df075feef ALSA: firewire-li... |
153 |
|
df075feef ALSA: firewire-li... |
154 |
src = (void *)runtime->dma_area + |
9fc90644c ALSA: firewire-li... |
155 156 |
frames_to_bytes(runtime, pcm_buffer_pointer); remaining_frames = runtime->buffer_size - pcm_buffer_pointer; |
df075feef ALSA: firewire-li... |
157 158 159 160 161 162 163 164 165 166 167 168 |
for (i = 0; i < frames; ++i) { for (c = 0; c < channels; ++c) { buffer[p->pcm_positions[c]] = cpu_to_be32((*src >> 8) | 0x40000000); src++; } buffer += s->data_block_quadlets; if (--remaining_frames == 0) src = (void *)runtime->dma_area; } } |
9fc90644c ALSA: firewire-li... |
169 170 171 |
static void read_pcm_s32(struct amdtp_stream *s, struct snd_pcm_substream *pcm, __be32 *buffer, unsigned int frames, unsigned int pcm_frames) |
df075feef ALSA: firewire-li... |
172 173 |
{ struct amdtp_am824 *p = s->protocol; |
9fc90644c ALSA: firewire-li... |
174 |
unsigned int channels = p->pcm_channels; |
df075feef ALSA: firewire-li... |
175 |
struct snd_pcm_runtime *runtime = pcm->runtime; |
9fc90644c ALSA: firewire-li... |
176 177 |
unsigned int pcm_buffer_pointer; int remaining_frames; |
df075feef ALSA: firewire-li... |
178 |
u32 *dst; |
9fc90644c ALSA: firewire-li... |
179 180 181 182 |
int i, c; pcm_buffer_pointer = s->pcm_buffer_pointer + pcm_frames; pcm_buffer_pointer %= runtime->buffer_size; |
df075feef ALSA: firewire-li... |
183 |
|
df075feef ALSA: firewire-li... |
184 |
dst = (void *)runtime->dma_area + |
9fc90644c ALSA: firewire-li... |
185 186 |
frames_to_bytes(runtime, pcm_buffer_pointer); remaining_frames = runtime->buffer_size - pcm_buffer_pointer; |
df075feef ALSA: firewire-li... |
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
for (i = 0; i < frames; ++i) { for (c = 0; c < channels; ++c) { *dst = be32_to_cpu(buffer[p->pcm_positions[c]]) << 8; dst++; } buffer += s->data_block_quadlets; if (--remaining_frames == 0) dst = (void *)runtime->dma_area; } } static void write_pcm_silence(struct amdtp_stream *s, __be32 *buffer, unsigned int frames) { struct amdtp_am824 *p = s->protocol; unsigned int i, c, channels = p->pcm_channels; for (i = 0; i < frames; ++i) { for (c = 0; c < channels; ++c) buffer[p->pcm_positions[c]] = cpu_to_be32(0x40000000); buffer += s->data_block_quadlets; } } /** |
bc8500da3 ALSA: firewire-li... |
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
* amdtp_am824_add_pcm_hw_constraints - add hw constraints for PCM substream * @s: the AMDTP stream for AM824 data block, must be initialized. * @runtime: the PCM substream runtime * */ int amdtp_am824_add_pcm_hw_constraints(struct amdtp_stream *s, struct snd_pcm_runtime *runtime) { int err; err = amdtp_stream_add_pcm_hw_constraints(s, runtime); if (err < 0) return err; /* AM824 in IEC 61883-6 can deliver 24bit data. */ return snd_pcm_hw_constraint_msbits(runtime, 0, 32, 24); } EXPORT_SYMBOL_GPL(amdtp_am824_add_pcm_hw_constraints); /** |
03e2a67ee ALSA: firewire-li... |
233 234 235 236 237 238 239 240 241 242 243 244 |
* amdtp_am824_midi_trigger - start/stop playback/capture with a MIDI device * @s: the AMDTP stream * @port: index of MIDI port * @midi: the MIDI device to be started, or %NULL to stop the current device * * Call this function on a running isochronous stream to enable the actual * transmission of MIDI data. This function should be called from the MIDI * device's .trigger callback. */ void amdtp_am824_midi_trigger(struct amdtp_stream *s, unsigned int port, struct snd_rawmidi_substream *midi) { |
df075feef ALSA: firewire-li... |
245 246 247 |
struct amdtp_am824 *p = s->protocol; if (port < p->midi_ports) |
6aa7de059 locking/atomics: ... |
248 |
WRITE_ONCE(p->midi[port], midi); |
03e2a67ee ALSA: firewire-li... |
249 250 |
} EXPORT_SYMBOL_GPL(amdtp_am824_midi_trigger); |
df075feef ALSA: firewire-li... |
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
/* * To avoid sending MIDI bytes at too high a rate, assume that the receiving * device has a FIFO, and track how much it is filled. This values increases * by one whenever we send one byte in a packet, but the FIFO empties at * a constant rate independent of our packet rate. One packet has syt_interval * samples, so the number of bytes that empty out of the FIFO, per packet(!), * is MIDI_BYTES_PER_SECOND * syt_interval / sample_rate. To avoid storing * fractional values, the values in midi_fifo_used[] are measured in bytes * multiplied by the sample rate. */ static bool midi_ratelimit_per_packet(struct amdtp_stream *s, unsigned int port) { struct amdtp_am824 *p = s->protocol; int used; used = p->midi_fifo_used[port]; if (used == 0) /* common shortcut */ return true; used -= MIDI_BYTES_PER_SECOND * s->syt_interval; used = max(used, 0); p->midi_fifo_used[port] = used; return used < p->midi_fifo_limit; } static void midi_rate_use_one_byte(struct amdtp_stream *s, unsigned int port) { struct amdtp_am824 *p = s->protocol; p->midi_fifo_used[port] += amdtp_rate_table[s->sfc]; } static void write_midi_messages(struct amdtp_stream *s, __be32 *buffer, |
ab7548120 ALSA: firewire-li... |
285 |
unsigned int frames, unsigned int data_block_counter) |
df075feef ALSA: firewire-li... |
286 287 288 289 290 291 292 |
{ struct amdtp_am824 *p = s->protocol; unsigned int f, port; u8 *b; for (f = 0; f < frames; f++) { b = (u8 *)&buffer[p->midi_position]; |
ab7548120 ALSA: firewire-li... |
293 |
port = (data_block_counter + f) % 8; |
df075feef ALSA: firewire-li... |
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
if (f < MAX_MIDI_RX_BLOCKS && midi_ratelimit_per_packet(s, port) && p->midi[port] != NULL && snd_rawmidi_transmit(p->midi[port], &b[1], 1) == 1) { midi_rate_use_one_byte(s, port); b[0] = 0x81; } else { b[0] = 0x80; b[1] = 0; } b[2] = 0; b[3] = 0; buffer += s->data_block_quadlets; } } |
ab7548120 ALSA: firewire-li... |
310 311 |
static void read_midi_messages(struct amdtp_stream *s, __be32 *buffer, unsigned int frames, unsigned int data_block_counter) |
df075feef ALSA: firewire-li... |
312 313 |
{ struct amdtp_am824 *p = s->protocol; |
df075feef ALSA: firewire-li... |
314 315 |
int len; u8 *b; |
588f2e2ca ALSA: firewire-li... |
316 |
int f; |
df075feef ALSA: firewire-li... |
317 318 |
for (f = 0; f < frames; f++) { |
588f2e2ca ALSA: firewire-li... |
319 320 321 |
unsigned int port = f; if (!(s->flags & CIP_UNALIGHED_DBC)) |
ab7548120 ALSA: firewire-li... |
322 |
port += data_block_counter; |
588f2e2ca ALSA: firewire-li... |
323 |
port %= 8; |
df075feef ALSA: firewire-li... |
324 325 326 327 328 329 330 331 332 |
b = (u8 *)&buffer[p->midi_position]; len = b[0] - 0x80; if ((1 <= len) && (len <= 3) && (p->midi[port])) snd_rawmidi_receive(p->midi[port], b + 1, len); buffer += s->data_block_quadlets; } } |
9a738ad1b ALSA: firewire-li... |
333 334 335 336 |
static unsigned int process_it_ctx_payloads(struct amdtp_stream *s, const struct pkt_desc *descs, unsigned int packets, struct snd_pcm_substream *pcm) |
df075feef ALSA: firewire-li... |
337 338 |
{ struct amdtp_am824 *p = s->protocol; |
9fc90644c ALSA: firewire-li... |
339 |
unsigned int pcm_frames = 0; |
9a738ad1b ALSA: firewire-li... |
340 |
int i; |
df075feef ALSA: firewire-li... |
341 |
|
9a738ad1b ALSA: firewire-li... |
342 343 344 345 |
for (i = 0; i < packets; ++i) { const struct pkt_desc *desc = descs + i; __be32 *buf = desc->ctx_payload; unsigned int data_blocks = desc->data_blocks; |
df075feef ALSA: firewire-li... |
346 |
|
9a738ad1b ALSA: firewire-li... |
347 348 349 350 351 352 353 354 355 356 357 |
if (pcm) { write_pcm_s32(s, pcm, buf, data_blocks, pcm_frames); pcm_frames += data_blocks * p->frame_multiplier; } else { write_pcm_silence(s, buf, data_blocks); } if (p->midi_ports) { write_midi_messages(s, buf, data_blocks, desc->data_block_counter); } |
d2c104a34 ALSA: firewire-li... |
358 |
} |
df075feef ALSA: firewire-li... |
359 360 361 |
return pcm_frames; } |
9a738ad1b ALSA: firewire-li... |
362 363 364 365 |
static unsigned int process_ir_ctx_payloads(struct amdtp_stream *s, const struct pkt_desc *descs, unsigned int packets, struct snd_pcm_substream *pcm) |
df075feef ALSA: firewire-li... |
366 367 |
{ struct amdtp_am824 *p = s->protocol; |
9fc90644c ALSA: firewire-li... |
368 |
unsigned int pcm_frames = 0; |
9a738ad1b ALSA: firewire-li... |
369 |
int i; |
df075feef ALSA: firewire-li... |
370 |
|
9a738ad1b ALSA: firewire-li... |
371 372 373 374 375 376 377 378 379 |
for (i = 0; i < packets; ++i) { const struct pkt_desc *desc = descs + i; __be32 *buf = desc->ctx_payload; unsigned int data_blocks = desc->data_blocks; if (pcm) { read_pcm_s32(s, pcm, buf, data_blocks, pcm_frames); pcm_frames += data_blocks * p->frame_multiplier; } |
df075feef ALSA: firewire-li... |
380 |
|
9a738ad1b ALSA: firewire-li... |
381 382 383 384 |
if (p->midi_ports) { read_midi_messages(s, buf, data_blocks, desc->data_block_counter); } |
d2c104a34 ALSA: firewire-li... |
385 |
} |
df075feef ALSA: firewire-li... |
386 387 388 |
return pcm_frames; } |
03e2a67ee ALSA: firewire-li... |
389 |
/** |
5955815e7 ALSA: firewire-li... |
390 391 392 393 394 395 396 397 398 399 |
* amdtp_am824_init - initialize an AMDTP stream structure to handle AM824 * data block * @s: the AMDTP stream to initialize * @unit: the target of the stream * @dir: the direction of stream * @flags: the packet transmission method to use */ int amdtp_am824_init(struct amdtp_stream *s, struct fw_unit *unit, enum amdtp_stream_direction dir, enum cip_flags flags) { |
9a738ad1b ALSA: firewire-li... |
400 |
amdtp_stream_process_ctx_payloads_t process_ctx_payloads; |
df075feef ALSA: firewire-li... |
401 402 |
if (dir == AMDTP_IN_STREAM) |
9a738ad1b ALSA: firewire-li... |
403 |
process_ctx_payloads = process_ir_ctx_payloads; |
df075feef ALSA: firewire-li... |
404 |
else |
9a738ad1b ALSA: firewire-li... |
405 |
process_ctx_payloads = process_it_ctx_payloads; |
df075feef ALSA: firewire-li... |
406 407 |
return amdtp_stream_init(s, unit, dir, flags, CIP_FMT_AM, |
9a738ad1b ALSA: firewire-li... |
408 |
process_ctx_payloads, sizeof(struct amdtp_am824)); |
5955815e7 ALSA: firewire-li... |
409 410 |
} EXPORT_SYMBOL_GPL(amdtp_am824_init); |