]>
Commit | Line | Data |
---|---|---|
31ef9134 CL |
1 | #ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED |
2 | #define SOUND_FIREWIRE_AMDTP_H_INCLUDED | |
3 | ||
20b65dd0 | 4 | #include <linux/err.h> |
76fb8789 | 5 | #include <linux/interrupt.h> |
31ef9134 | 6 | #include <linux/mutex.h> |
777fb574 | 7 | #include <sound/asound.h> |
31ef9134 CL |
8 | #include "packets-buffer.h" |
9 | ||
10 | /** | |
be4a2894 | 11 | * enum cip_flags - describes details of the streaming protocol |
31ef9134 CL |
12 | * @CIP_NONBLOCKING: In non-blocking mode, each packet contains |
13 | * sample_rate/8000 samples, with rounding up or down to adjust | |
14 | * for clock skew and left-over fractional samples. This should | |
15 | * be used if supported by the device. | |
e84d15f6 CL |
16 | * @CIP_BLOCKING: In blocking mode, each packet contains either zero or |
17 | * SYT_INTERVAL samples, with these two types alternating so that | |
18 | * the overall sample rate comes out right. | |
a7304e3b CL |
19 | * @CIP_HI_DUALWIRE: At rates above 96 kHz, pretend that the stream runs |
20 | * at half the actual sample rate with twice the number of channels; | |
21 | * two samples of a channel are stored consecutively in the packet. | |
22 | * Requires blocking mode and SYT_INTERVAL-aligned PCM buffer size. | |
31ef9134 | 23 | */ |
be4a2894 | 24 | enum cip_flags { |
e84d15f6 CL |
25 | CIP_NONBLOCKING = 0x00, |
26 | CIP_BLOCKING = 0x01, | |
a7304e3b | 27 | CIP_HI_DUALWIRE = 0x02, |
31ef9134 CL |
28 | }; |
29 | ||
30 | /** | |
31 | * enum cip_sfc - a stream's sample rate | |
32 | */ | |
33 | enum cip_sfc { | |
34 | CIP_SFC_32000 = 0, | |
35 | CIP_SFC_44100 = 1, | |
36 | CIP_SFC_48000 = 2, | |
37 | CIP_SFC_88200 = 3, | |
38 | CIP_SFC_96000 = 4, | |
39 | CIP_SFC_176400 = 5, | |
40 | CIP_SFC_192000 = 6, | |
a7304e3b | 41 | CIP_SFC_COUNT |
31ef9134 CL |
42 | }; |
43 | ||
2b3fc456 TS |
44 | #define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32 |
45 | ||
31ef9134 CL |
46 | #define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 | \ |
47 | SNDRV_PCM_FMTBIT_S32) | |
48 | ||
83d8d72d TS |
49 | |
50 | /* | |
51 | * AMDTP packet can include channels for MIDI conformant data. | |
52 | * Each MIDI conformant data channel includes 8 MPX-MIDI data stream. | |
53 | * Each MPX-MIDI data stream includes one data stream from/to MIDI ports. | |
54 | * | |
55 | * This module supports maximum 1 MIDI conformant data channels. | |
56 | * Then this AMDTP packets can transfer maximum 8 MIDI data streams. | |
57 | */ | |
58 | #define AMDTP_MAX_CHANNELS_FOR_MIDI 1 | |
59 | ||
31ef9134 CL |
60 | struct fw_unit; |
61 | struct fw_iso_context; | |
62 | struct snd_pcm_substream; | |
83d8d72d | 63 | struct snd_rawmidi_substream; |
31ef9134 | 64 | |
3ff7e8f0 TS |
65 | enum amdtp_stream_direction { |
66 | AMDTP_OUT_STREAM = 0, | |
67 | AMDTP_IN_STREAM | |
68 | }; | |
69 | ||
be4a2894 | 70 | struct amdtp_stream { |
31ef9134 | 71 | struct fw_unit *unit; |
be4a2894 | 72 | enum cip_flags flags; |
3ff7e8f0 | 73 | enum amdtp_stream_direction direction; |
31ef9134 CL |
74 | struct fw_iso_context *context; |
75 | struct mutex mutex; | |
76 | ||
77 | enum cip_sfc sfc; | |
a7304e3b | 78 | bool dual_wire; |
31ef9134 CL |
79 | unsigned int data_block_quadlets; |
80 | unsigned int pcm_channels; | |
81 | unsigned int midi_ports; | |
be4a2894 | 82 | void (*transfer_samples)(struct amdtp_stream *s, |
31ef9134 CL |
83 | struct snd_pcm_substream *pcm, |
84 | __be32 *buffer, unsigned int frames); | |
85 | ||
86 | unsigned int syt_interval; | |
e84d15f6 | 87 | unsigned int transfer_delay; |
31ef9134 CL |
88 | unsigned int source_node_id_field; |
89 | struct iso_packets_buffer buffer; | |
90 | ||
91 | struct snd_pcm_substream *pcm; | |
76fb8789 | 92 | struct tasklet_struct period_tasklet; |
31ef9134 | 93 | |
ec00f5e4 | 94 | int packet_index; |
31ef9134 CL |
95 | unsigned int data_block_counter; |
96 | ||
97 | unsigned int data_block_state; | |
98 | ||
99 | unsigned int last_syt_offset; | |
100 | unsigned int syt_offset_state; | |
101 | ||
102 | unsigned int pcm_buffer_pointer; | |
103 | unsigned int pcm_period_pointer; | |
92b862c7 | 104 | bool pointer_flush; |
83d8d72d TS |
105 | |
106 | struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8]; | |
31ef9134 CL |
107 | }; |
108 | ||
be4a2894 | 109 | int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, |
3ff7e8f0 | 110 | enum amdtp_stream_direction dir, |
be4a2894 TS |
111 | enum cip_flags flags); |
112 | void amdtp_stream_destroy(struct amdtp_stream *s); | |
31ef9134 | 113 | |
be4a2894 TS |
114 | void amdtp_stream_set_parameters(struct amdtp_stream *s, |
115 | unsigned int rate, | |
116 | unsigned int pcm_channels, | |
117 | unsigned int midi_ports); | |
118 | unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s); | |
31ef9134 | 119 | |
be4a2894 TS |
120 | int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed); |
121 | void amdtp_stream_update(struct amdtp_stream *s); | |
122 | void amdtp_stream_stop(struct amdtp_stream *s); | |
31ef9134 | 123 | |
be4a2894 TS |
124 | void amdtp_stream_set_pcm_format(struct amdtp_stream *s, |
125 | snd_pcm_format_t format); | |
126 | void amdtp_stream_pcm_prepare(struct amdtp_stream *s); | |
127 | unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s); | |
128 | void amdtp_stream_pcm_abort(struct amdtp_stream *s); | |
31ef9134 | 129 | |
c5280e99 | 130 | extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT]; |
a7304e3b | 131 | |
be4a2894 TS |
132 | /** |
133 | * amdtp_stream_running - check stream is running or not | |
134 | * @s: the AMDTP stream | |
135 | * | |
136 | * If this function returns true, the stream is running. | |
137 | */ | |
138 | static inline bool amdtp_stream_running(struct amdtp_stream *s) | |
20b65dd0 CL |
139 | { |
140 | return !IS_ERR(s->context); | |
141 | } | |
142 | ||
ec00f5e4 | 143 | /** |
be4a2894 TS |
144 | * amdtp_streaming_error - check for streaming error |
145 | * @s: the AMDTP stream | |
ec00f5e4 CL |
146 | * |
147 | * If this function returns true, the stream's packet queue has stopped due to | |
148 | * an asynchronous error. | |
149 | */ | |
be4a2894 | 150 | static inline bool amdtp_streaming_error(struct amdtp_stream *s) |
ec00f5e4 CL |
151 | { |
152 | return s->packet_index < 0; | |
153 | } | |
154 | ||
83d8d72d TS |
155 | /** |
156 | * amdtp_stream_pcm_running - check PCM substream is running or not | |
157 | * @s: the AMDTP stream | |
158 | * | |
159 | * If this function returns true, PCM substream in the AMDTP stream is running. | |
160 | */ | |
161 | static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s) | |
162 | { | |
163 | return !!s->pcm; | |
164 | } | |
165 | ||
31ef9134 | 166 | /** |
be4a2894 TS |
167 | * amdtp_stream_pcm_trigger - start/stop playback from a PCM device |
168 | * @s: the AMDTP stream | |
31ef9134 CL |
169 | * @pcm: the PCM device to be started, or %NULL to stop the current device |
170 | * | |
171 | * Call this function on a running isochronous stream to enable the actual | |
172 | * transmission of PCM data. This function should be called from the PCM | |
173 | * device's .trigger callback. | |
174 | */ | |
be4a2894 TS |
175 | static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s, |
176 | struct snd_pcm_substream *pcm) | |
31ef9134 CL |
177 | { |
178 | ACCESS_ONCE(s->pcm) = pcm; | |
179 | } | |
180 | ||
83d8d72d TS |
181 | /** |
182 | * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device | |
183 | * @s: the AMDTP stream | |
184 | * @port: index of MIDI port | |
185 | * @midi: the MIDI device to be started, or %NULL to stop the current device | |
186 | * | |
187 | * Call this function on a running isochronous stream to enable the actual | |
188 | * transmission of MIDI data. This function should be called from the MIDI | |
189 | * device's .trigger callback. | |
190 | */ | |
191 | static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s, | |
192 | unsigned int port, | |
193 | struct snd_rawmidi_substream *midi) | |
194 | { | |
195 | if (port < s->midi_ports) | |
196 | ACCESS_ONCE(s->midi[port]) = midi; | |
197 | } | |
198 | ||
31ef9134 CL |
199 | static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc) |
200 | { | |
201 | return sfc & 1; | |
202 | } | |
203 | ||
204 | #endif |