blob: f3f6f84c48d69747cc0fa3bd815d986c79ca0d78 [file] [log] [blame]
Clemens Ladisch31ef9132011-03-15 07:53:21 +01001#ifndef SOUND_FIREWIRE_LIB_H_INCLUDED
2#define SOUND_FIREWIRE_LIB_H_INCLUDED
3
4#include <linux/firewire-constants.h>
5#include <linux/types.h>
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +09006#include <linux/sched.h>
7#include <sound/rawmidi.h>
Clemens Ladisch31ef9132011-03-15 07:53:21 +01008
9struct fw_unit;
10
Clemens Ladisch1b704852011-09-04 22:17:38 +020011#define FW_GENERATION_MASK 0x00ff
12#define FW_FIXED_GENERATION 0x0100
13#define FW_QUIET 0x0200
14
Clemens Ladisch31ef9132011-03-15 07:53:21 +010015int snd_fw_transaction(struct fw_unit *unit, int tcode,
Clemens Ladisch1b704852011-09-04 22:17:38 +020016 u64 offset, void *buffer, size_t length,
17 unsigned int flags);
Clemens Ladisch31ef9132011-03-15 07:53:21 +010018
19/* returns true if retrying the transaction would not make sense */
20static inline bool rcode_is_permanent_error(int rcode)
21{
22 return rcode == RCODE_TYPE_ERROR || rcode == RCODE_ADDRESS_ERROR;
23}
24
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090025struct snd_fw_async_midi_port;
26typedef int (*snd_fw_async_midi_port_fill)(
27 struct snd_rawmidi_substream *substream,
28 u8 *buf);
29
30struct snd_fw_async_midi_port {
31 struct fw_device *parent;
32 struct work_struct work;
Takashi Sakamotod3ef9cb2015-10-09 08:10:26 +090033 bool idling;
Takashi Sakamotoea848b72015-10-09 08:10:28 +090034 ktime_t next_ktime;
Takashi Sakamotobde3e282015-10-09 08:10:29 +090035 bool error;
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090036
37 u64 addr;
38 struct fw_transaction transaction;
39
40 u8 *buf;
41 unsigned int len;
42
43 struct snd_rawmidi_substream *substream;
44 snd_fw_async_midi_port_fill fill;
45 unsigned int consume_bytes;
46};
47
48int snd_fw_async_midi_port_init(struct snd_fw_async_midi_port *port,
49 struct fw_unit *unit, u64 addr, unsigned int len,
50 snd_fw_async_midi_port_fill fill);
51void snd_fw_async_midi_port_destroy(struct snd_fw_async_midi_port *port);
52
53/**
54 * snd_fw_async_midi_port_run - run transactions for the async MIDI port
55 * @port: the asynchronous MIDI port
56 * @substream: the MIDI substream
57 */
58static inline void
59snd_fw_async_midi_port_run(struct snd_fw_async_midi_port *port,
60 struct snd_rawmidi_substream *substream)
61{
Takashi Sakamotobde3e282015-10-09 08:10:29 +090062 if (!port->error) {
63 port->substream = substream;
64 schedule_work(&port->work);
65 }
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090066}
67
68/**
69 * snd_fw_async_midi_port_finish - finish the asynchronous MIDI port
70 * @port: the asynchronous MIDI port
71 */
72static inline void
73snd_fw_async_midi_port_finish(struct snd_fw_async_midi_port *port)
74{
75 port->substream = NULL;
Takashi Sakamotobde3e282015-10-09 08:10:29 +090076 port->error = false;
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090077}
78
Clemens Ladisch31ef9132011-03-15 07:53:21 +010079#endif