blob: c3768cd494a5f3fe3bb9059bd8e588c73b806c86 [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 Sakamoto923f92e2016-03-31 08:47:04 +090025void snd_fw_schedule_registration(struct fw_unit *unit,
26 struct delayed_work *dwork);
27
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090028struct snd_fw_async_midi_port;
29typedef int (*snd_fw_async_midi_port_fill)(
30 struct snd_rawmidi_substream *substream,
31 u8 *buf);
32
33struct snd_fw_async_midi_port {
34 struct fw_device *parent;
35 struct work_struct work;
Takashi Sakamotod3ef9cb2015-10-09 08:10:26 +090036 bool idling;
Takashi Sakamotoea848b72015-10-09 08:10:28 +090037 ktime_t next_ktime;
Takashi Sakamotobde3e282015-10-09 08:10:29 +090038 bool error;
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090039
40 u64 addr;
41 struct fw_transaction transaction;
42
43 u8 *buf;
44 unsigned int len;
45
46 struct snd_rawmidi_substream *substream;
47 snd_fw_async_midi_port_fill fill;
Takashi Sakamoto26b9b152017-04-14 12:43:01 +090048 int consume_bytes;
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090049};
50
51int snd_fw_async_midi_port_init(struct snd_fw_async_midi_port *port,
52 struct fw_unit *unit, u64 addr, unsigned int len,
53 snd_fw_async_midi_port_fill fill);
54void snd_fw_async_midi_port_destroy(struct snd_fw_async_midi_port *port);
55
56/**
57 * snd_fw_async_midi_port_run - run transactions for the async MIDI port
58 * @port: the asynchronous MIDI port
59 * @substream: the MIDI substream
60 */
61static inline void
62snd_fw_async_midi_port_run(struct snd_fw_async_midi_port *port,
63 struct snd_rawmidi_substream *substream)
64{
Takashi Sakamotobde3e282015-10-09 08:10:29 +090065 if (!port->error) {
66 port->substream = substream;
67 schedule_work(&port->work);
68 }
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090069}
70
71/**
72 * snd_fw_async_midi_port_finish - finish the asynchronous MIDI port
73 * @port: the asynchronous MIDI port
74 */
75static inline void
76snd_fw_async_midi_port_finish(struct snd_fw_async_midi_port *port)
77{
78 port->substream = NULL;
Takashi Sakamotobde3e282015-10-09 08:10:29 +090079 port->error = false;
Takashi Sakamoto585d7cb2015-10-09 08:10:25 +090080}
81
Clemens Ladisch31ef9132011-03-15 07:53:21 +010082#endif