1da607e19SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
2bde8a8f2STakashi Sakamoto /*
3bde8a8f2STakashi Sakamoto * fireworks_transaction.c - a part of driver for Fireworks based devices
4bde8a8f2STakashi Sakamoto *
5bde8a8f2STakashi Sakamoto * Copyright (c) 2013-2014 Takashi Sakamoto
6bde8a8f2STakashi Sakamoto */
7bde8a8f2STakashi Sakamoto
8bde8a8f2STakashi Sakamoto /*
9bde8a8f2STakashi Sakamoto * Fireworks have its own transaction. The transaction can be delivered by AV/C
1072f784f7STakashi Sakamoto * Vendor Specific command frame or usual asynchronous transaction. At least,
1172f784f7STakashi Sakamoto * Windows driver and firmware version 5.5 or later don't use AV/C command.
12bde8a8f2STakashi Sakamoto *
13bde8a8f2STakashi Sakamoto * Transaction substance:
1472f784f7STakashi Sakamoto * At first, 6 data exist. Following to the data, parameters for each command
15ce991981SYannick Guerrini * exist. All of the parameters are 32 bit aligned to big endian.
16bde8a8f2STakashi Sakamoto * data[0]: Length of transaction substance
17bde8a8f2STakashi Sakamoto * data[1]: Transaction version
18bde8a8f2STakashi Sakamoto * data[2]: Sequence number. This is incremented by the device
1972f784f7STakashi Sakamoto * data[3]: Transaction category
2072f784f7STakashi Sakamoto * data[4]: Transaction command
2172f784f7STakashi Sakamoto * data[5]: Return value in response.
2272f784f7STakashi Sakamoto * data[6-]: Parameters
23bde8a8f2STakashi Sakamoto *
24bde8a8f2STakashi Sakamoto * Transaction address:
25bde8a8f2STakashi Sakamoto * command: 0xecc000000000
26bde8a8f2STakashi Sakamoto * response: 0xecc080000000 (default)
27bde8a8f2STakashi Sakamoto *
28bde8a8f2STakashi Sakamoto * I note that the address for response can be changed by command. But this
29bde8a8f2STakashi Sakamoto * module uses the default address.
30bde8a8f2STakashi Sakamoto */
31bde8a8f2STakashi Sakamoto #include "./fireworks.h"
32bde8a8f2STakashi Sakamoto
339b5f0edfSTakashi Sakamoto #define MEMORY_SPACE_EFW_COMMAND 0xecc000000000ULL
349b5f0edfSTakashi Sakamoto #define MEMORY_SPACE_EFW_RESPONSE 0xecc080000000ULL
35bde8a8f2STakashi Sakamoto
36bde8a8f2STakashi Sakamoto #define ERROR_RETRIES 3
37bde8a8f2STakashi Sakamoto #define ERROR_DELAY_MS 5
38bde8a8f2STakashi Sakamoto #define EFC_TIMEOUT_MS 125
39bde8a8f2STakashi Sakamoto
40555e8a8fSTakashi Sakamoto static DEFINE_SPINLOCK(instances_lock);
41555e8a8fSTakashi Sakamoto static struct snd_efw *instances[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
42555e8a8fSTakashi Sakamoto
43bde8a8f2STakashi Sakamoto static DEFINE_SPINLOCK(transaction_queues_lock);
44bde8a8f2STakashi Sakamoto static LIST_HEAD(transaction_queues);
45bde8a8f2STakashi Sakamoto
46bde8a8f2STakashi Sakamoto enum transaction_queue_state {
47bde8a8f2STakashi Sakamoto STATE_PENDING,
48bde8a8f2STakashi Sakamoto STATE_BUS_RESET,
49bde8a8f2STakashi Sakamoto STATE_COMPLETE
50bde8a8f2STakashi Sakamoto };
51bde8a8f2STakashi Sakamoto
52bde8a8f2STakashi Sakamoto struct transaction_queue {
53bde8a8f2STakashi Sakamoto struct list_head list;
54bde8a8f2STakashi Sakamoto struct fw_unit *unit;
55bde8a8f2STakashi Sakamoto void *buf;
56bde8a8f2STakashi Sakamoto unsigned int size;
57bde8a8f2STakashi Sakamoto u32 seqnum;
58bde8a8f2STakashi Sakamoto enum transaction_queue_state state;
59bde8a8f2STakashi Sakamoto wait_queue_head_t wait;
60bde8a8f2STakashi Sakamoto };
61bde8a8f2STakashi Sakamoto
snd_efw_transaction_cmd(struct fw_unit * unit,const void * cmd,unsigned int size)62555e8a8fSTakashi Sakamoto int snd_efw_transaction_cmd(struct fw_unit *unit,
63555e8a8fSTakashi Sakamoto const void *cmd, unsigned int size)
64555e8a8fSTakashi Sakamoto {
65555e8a8fSTakashi Sakamoto return snd_fw_transaction(unit, TCODE_WRITE_BLOCK_REQUEST,
66555e8a8fSTakashi Sakamoto MEMORY_SPACE_EFW_COMMAND,
67555e8a8fSTakashi Sakamoto (void *)cmd, size, 0);
68555e8a8fSTakashi Sakamoto }
69555e8a8fSTakashi Sakamoto
snd_efw_transaction_run(struct fw_unit * unit,const void * cmd,unsigned int cmd_size,void * resp,unsigned int resp_size)70bde8a8f2STakashi Sakamoto int snd_efw_transaction_run(struct fw_unit *unit,
71bde8a8f2STakashi Sakamoto const void *cmd, unsigned int cmd_size,
72bde8a8f2STakashi Sakamoto void *resp, unsigned int resp_size)
73bde8a8f2STakashi Sakamoto {
74bde8a8f2STakashi Sakamoto struct transaction_queue t;
75bde8a8f2STakashi Sakamoto unsigned int tries;
76bde8a8f2STakashi Sakamoto int ret;
77bde8a8f2STakashi Sakamoto
78bde8a8f2STakashi Sakamoto t.unit = unit;
79bde8a8f2STakashi Sakamoto t.buf = resp;
80bde8a8f2STakashi Sakamoto t.size = resp_size;
81bde8a8f2STakashi Sakamoto t.seqnum = be32_to_cpu(((struct snd_efw_transaction *)cmd)->seqnum) + 1;
82bde8a8f2STakashi Sakamoto t.state = STATE_PENDING;
83bde8a8f2STakashi Sakamoto init_waitqueue_head(&t.wait);
84bde8a8f2STakashi Sakamoto
85bde8a8f2STakashi Sakamoto spin_lock_irq(&transaction_queues_lock);
86bde8a8f2STakashi Sakamoto list_add_tail(&t.list, &transaction_queues);
87bde8a8f2STakashi Sakamoto spin_unlock_irq(&transaction_queues_lock);
88bde8a8f2STakashi Sakamoto
89bde8a8f2STakashi Sakamoto tries = 0;
90bde8a8f2STakashi Sakamoto do {
91555e8a8fSTakashi Sakamoto ret = snd_efw_transaction_cmd(t.unit, (void *)cmd, cmd_size);
92bde8a8f2STakashi Sakamoto if (ret < 0)
93bde8a8f2STakashi Sakamoto break;
94bde8a8f2STakashi Sakamoto
95bde8a8f2STakashi Sakamoto wait_event_timeout(t.wait, t.state != STATE_PENDING,
96bde8a8f2STakashi Sakamoto msecs_to_jiffies(EFC_TIMEOUT_MS));
97bde8a8f2STakashi Sakamoto
98bde8a8f2STakashi Sakamoto if (t.state == STATE_COMPLETE) {
99bde8a8f2STakashi Sakamoto ret = t.size;
100bde8a8f2STakashi Sakamoto break;
101bde8a8f2STakashi Sakamoto } else if (t.state == STATE_BUS_RESET) {
102bde8a8f2STakashi Sakamoto msleep(ERROR_DELAY_MS);
103bde8a8f2STakashi Sakamoto } else if (++tries >= ERROR_RETRIES) {
104bde8a8f2STakashi Sakamoto dev_err(&t.unit->device, "EFW transaction timed out\n");
105bde8a8f2STakashi Sakamoto ret = -EIO;
106bde8a8f2STakashi Sakamoto break;
107bde8a8f2STakashi Sakamoto }
108bde8a8f2STakashi Sakamoto } while (1);
109bde8a8f2STakashi Sakamoto
110bde8a8f2STakashi Sakamoto spin_lock_irq(&transaction_queues_lock);
111bde8a8f2STakashi Sakamoto list_del(&t.list);
112bde8a8f2STakashi Sakamoto spin_unlock_irq(&transaction_queues_lock);
113bde8a8f2STakashi Sakamoto
114bde8a8f2STakashi Sakamoto return ret;
115bde8a8f2STakashi Sakamoto }
116bde8a8f2STakashi Sakamoto
117bde8a8f2STakashi Sakamoto static void
copy_resp_to_buf(struct snd_efw * efw,void * data,size_t length,int * rcode)118555e8a8fSTakashi Sakamoto copy_resp_to_buf(struct snd_efw *efw, void *data, size_t length, int *rcode)
119555e8a8fSTakashi Sakamoto {
120555e8a8fSTakashi Sakamoto size_t capacity, till_end;
121555e8a8fSTakashi Sakamoto struct snd_efw_transaction *t;
122555e8a8fSTakashi Sakamoto
123555e8a8fSTakashi Sakamoto t = (struct snd_efw_transaction *)data;
12492cb4658STakashi Sakamoto length = min_t(size_t, be32_to_cpu(t->length) * sizeof(u32), length);
125555e8a8fSTakashi Sakamoto
12602a9c6eeSDan Carpenter spin_lock(&efw->lock);
1276b1ca4bcSTakashi Sakamoto
128555e8a8fSTakashi Sakamoto if (efw->push_ptr < efw->pull_ptr)
129555e8a8fSTakashi Sakamoto capacity = (unsigned int)(efw->pull_ptr - efw->push_ptr);
130555e8a8fSTakashi Sakamoto else
131555e8a8fSTakashi Sakamoto capacity = snd_efw_resp_buf_size -
132555e8a8fSTakashi Sakamoto (unsigned int)(efw->push_ptr - efw->pull_ptr);
133555e8a8fSTakashi Sakamoto
134555e8a8fSTakashi Sakamoto /* confirm enough space for this response */
135555e8a8fSTakashi Sakamoto if (capacity < length) {
136555e8a8fSTakashi Sakamoto *rcode = RCODE_CONFLICT_ERROR;
137555e8a8fSTakashi Sakamoto goto end;
138555e8a8fSTakashi Sakamoto }
139555e8a8fSTakashi Sakamoto
140555e8a8fSTakashi Sakamoto /* copy to ring buffer */
141555e8a8fSTakashi Sakamoto while (length > 0) {
142555e8a8fSTakashi Sakamoto till_end = snd_efw_resp_buf_size -
143555e8a8fSTakashi Sakamoto (unsigned int)(efw->push_ptr - efw->resp_buf);
144555e8a8fSTakashi Sakamoto till_end = min_t(unsigned int, length, till_end);
145555e8a8fSTakashi Sakamoto
146555e8a8fSTakashi Sakamoto memcpy(efw->push_ptr, data, till_end);
147555e8a8fSTakashi Sakamoto
148555e8a8fSTakashi Sakamoto efw->push_ptr += till_end;
149555e8a8fSTakashi Sakamoto if (efw->push_ptr >= efw->resp_buf + snd_efw_resp_buf_size)
150cf44a136STakashi Sakamoto efw->push_ptr -= snd_efw_resp_buf_size;
151555e8a8fSTakashi Sakamoto
152555e8a8fSTakashi Sakamoto length -= till_end;
153555e8a8fSTakashi Sakamoto data += till_end;
154555e8a8fSTakashi Sakamoto }
155555e8a8fSTakashi Sakamoto
156555e8a8fSTakashi Sakamoto /* for hwdep */
157555e8a8fSTakashi Sakamoto wake_up(&efw->hwdep_wait);
158555e8a8fSTakashi Sakamoto
159555e8a8fSTakashi Sakamoto *rcode = RCODE_COMPLETE;
160555e8a8fSTakashi Sakamoto end:
161555e8a8fSTakashi Sakamoto spin_unlock_irq(&efw->lock);
162555e8a8fSTakashi Sakamoto }
163555e8a8fSTakashi Sakamoto
164555e8a8fSTakashi Sakamoto static void
handle_resp_for_user(struct fw_card * card,int generation,int source,void * data,size_t length,int * rcode)165555e8a8fSTakashi Sakamoto handle_resp_for_user(struct fw_card *card, int generation, int source,
166555e8a8fSTakashi Sakamoto void *data, size_t length, int *rcode)
167555e8a8fSTakashi Sakamoto {
168555e8a8fSTakashi Sakamoto struct fw_device *device;
169555e8a8fSTakashi Sakamoto struct snd_efw *efw;
170555e8a8fSTakashi Sakamoto unsigned int i;
171555e8a8fSTakashi Sakamoto
172555e8a8fSTakashi Sakamoto spin_lock_irq(&instances_lock);
173555e8a8fSTakashi Sakamoto
174555e8a8fSTakashi Sakamoto for (i = 0; i < SNDRV_CARDS; i++) {
175555e8a8fSTakashi Sakamoto efw = instances[i];
176555e8a8fSTakashi Sakamoto if (efw == NULL)
177555e8a8fSTakashi Sakamoto continue;
178555e8a8fSTakashi Sakamoto device = fw_parent_device(efw->unit);
179555e8a8fSTakashi Sakamoto if ((device->card != card) ||
180555e8a8fSTakashi Sakamoto (device->generation != generation))
181555e8a8fSTakashi Sakamoto continue;
182555e8a8fSTakashi Sakamoto smp_rmb(); /* node id vs. generation */
183555e8a8fSTakashi Sakamoto if (device->node_id != source)
184555e8a8fSTakashi Sakamoto continue;
185555e8a8fSTakashi Sakamoto
186555e8a8fSTakashi Sakamoto break;
187555e8a8fSTakashi Sakamoto }
188555e8a8fSTakashi Sakamoto if (i == SNDRV_CARDS)
189555e8a8fSTakashi Sakamoto goto end;
190555e8a8fSTakashi Sakamoto
191555e8a8fSTakashi Sakamoto copy_resp_to_buf(efw, data, length, rcode);
192555e8a8fSTakashi Sakamoto end:
19302a9c6eeSDan Carpenter spin_unlock(&instances_lock);
194555e8a8fSTakashi Sakamoto }
195555e8a8fSTakashi Sakamoto
196555e8a8fSTakashi Sakamoto static void
handle_resp_for_kernel(struct fw_card * card,int generation,int source,void * data,size_t length,int * rcode,u32 seqnum)197555e8a8fSTakashi Sakamoto handle_resp_for_kernel(struct fw_card *card, int generation, int source,
198555e8a8fSTakashi Sakamoto void *data, size_t length, int *rcode, u32 seqnum)
199bde8a8f2STakashi Sakamoto {
200bde8a8f2STakashi Sakamoto struct fw_device *device;
201bde8a8f2STakashi Sakamoto struct transaction_queue *t;
202bde8a8f2STakashi Sakamoto unsigned long flags;
203bde8a8f2STakashi Sakamoto
204bde8a8f2STakashi Sakamoto spin_lock_irqsave(&transaction_queues_lock, flags);
205bde8a8f2STakashi Sakamoto list_for_each_entry(t, &transaction_queues, list) {
206bde8a8f2STakashi Sakamoto device = fw_parent_device(t->unit);
207bde8a8f2STakashi Sakamoto if ((device->card != card) ||
208bde8a8f2STakashi Sakamoto (device->generation != generation))
209bde8a8f2STakashi Sakamoto continue;
210bde8a8f2STakashi Sakamoto smp_rmb(); /* node_id vs. generation */
211bde8a8f2STakashi Sakamoto if (device->node_id != source)
212bde8a8f2STakashi Sakamoto continue;
213bde8a8f2STakashi Sakamoto
214bde8a8f2STakashi Sakamoto if ((t->state == STATE_PENDING) && (t->seqnum == seqnum)) {
215bde8a8f2STakashi Sakamoto t->state = STATE_COMPLETE;
216bde8a8f2STakashi Sakamoto t->size = min_t(unsigned int, length, t->size);
217bde8a8f2STakashi Sakamoto memcpy(t->buf, data, t->size);
218bde8a8f2STakashi Sakamoto wake_up(&t->wait);
219555e8a8fSTakashi Sakamoto *rcode = RCODE_COMPLETE;
220bde8a8f2STakashi Sakamoto }
221bde8a8f2STakashi Sakamoto }
222bde8a8f2STakashi Sakamoto spin_unlock_irqrestore(&transaction_queues_lock, flags);
223555e8a8fSTakashi Sakamoto }
224555e8a8fSTakashi Sakamoto
225555e8a8fSTakashi Sakamoto static void
efw_response(struct fw_card * card,struct fw_request * request,int tcode,int destination,int source,int generation,unsigned long long offset,void * data,size_t length,void * callback_data)226555e8a8fSTakashi Sakamoto efw_response(struct fw_card *card, struct fw_request *request,
227555e8a8fSTakashi Sakamoto int tcode, int destination, int source,
228555e8a8fSTakashi Sakamoto int generation, unsigned long long offset,
229555e8a8fSTakashi Sakamoto void *data, size_t length, void *callback_data)
230555e8a8fSTakashi Sakamoto {
231555e8a8fSTakashi Sakamoto int rcode, dummy;
232555e8a8fSTakashi Sakamoto u32 seqnum;
233555e8a8fSTakashi Sakamoto
234555e8a8fSTakashi Sakamoto rcode = RCODE_TYPE_ERROR;
235555e8a8fSTakashi Sakamoto if (length < sizeof(struct snd_efw_transaction)) {
236555e8a8fSTakashi Sakamoto rcode = RCODE_DATA_ERROR;
237555e8a8fSTakashi Sakamoto goto end;
238555e8a8fSTakashi Sakamoto } else if (offset != MEMORY_SPACE_EFW_RESPONSE) {
239555e8a8fSTakashi Sakamoto rcode = RCODE_ADDRESS_ERROR;
240555e8a8fSTakashi Sakamoto goto end;
241555e8a8fSTakashi Sakamoto }
242555e8a8fSTakashi Sakamoto
243555e8a8fSTakashi Sakamoto seqnum = be32_to_cpu(((struct snd_efw_transaction *)data)->seqnum);
244555e8a8fSTakashi Sakamoto if (seqnum > SND_EFW_TRANSACTION_USER_SEQNUM_MAX + 1) {
245555e8a8fSTakashi Sakamoto handle_resp_for_kernel(card, generation, source,
246555e8a8fSTakashi Sakamoto data, length, &rcode, seqnum);
247555e8a8fSTakashi Sakamoto if (snd_efw_resp_buf_debug)
248555e8a8fSTakashi Sakamoto handle_resp_for_user(card, generation, source,
249555e8a8fSTakashi Sakamoto data, length, &dummy);
250555e8a8fSTakashi Sakamoto } else {
251555e8a8fSTakashi Sakamoto handle_resp_for_user(card, generation, source,
252555e8a8fSTakashi Sakamoto data, length, &rcode);
253555e8a8fSTakashi Sakamoto }
254bde8a8f2STakashi Sakamoto end:
255bde8a8f2STakashi Sakamoto fw_send_response(card, request, rcode);
256bde8a8f2STakashi Sakamoto }
257bde8a8f2STakashi Sakamoto
snd_efw_transaction_add_instance(struct snd_efw * efw)258555e8a8fSTakashi Sakamoto void snd_efw_transaction_add_instance(struct snd_efw *efw)
259555e8a8fSTakashi Sakamoto {
260555e8a8fSTakashi Sakamoto unsigned int i;
261555e8a8fSTakashi Sakamoto
262555e8a8fSTakashi Sakamoto spin_lock_irq(&instances_lock);
263555e8a8fSTakashi Sakamoto
264555e8a8fSTakashi Sakamoto for (i = 0; i < SNDRV_CARDS; i++) {
265555e8a8fSTakashi Sakamoto if (instances[i] != NULL)
266555e8a8fSTakashi Sakamoto continue;
267555e8a8fSTakashi Sakamoto instances[i] = efw;
268555e8a8fSTakashi Sakamoto break;
269555e8a8fSTakashi Sakamoto }
270555e8a8fSTakashi Sakamoto
271555e8a8fSTakashi Sakamoto spin_unlock_irq(&instances_lock);
272555e8a8fSTakashi Sakamoto }
273555e8a8fSTakashi Sakamoto
snd_efw_transaction_remove_instance(struct snd_efw * efw)274555e8a8fSTakashi Sakamoto void snd_efw_transaction_remove_instance(struct snd_efw *efw)
275555e8a8fSTakashi Sakamoto {
276555e8a8fSTakashi Sakamoto unsigned int i;
277555e8a8fSTakashi Sakamoto
278555e8a8fSTakashi Sakamoto spin_lock_irq(&instances_lock);
279555e8a8fSTakashi Sakamoto
280555e8a8fSTakashi Sakamoto for (i = 0; i < SNDRV_CARDS; i++) {
281555e8a8fSTakashi Sakamoto if (instances[i] != efw)
282555e8a8fSTakashi Sakamoto continue;
283555e8a8fSTakashi Sakamoto instances[i] = NULL;
284555e8a8fSTakashi Sakamoto }
285555e8a8fSTakashi Sakamoto
286555e8a8fSTakashi Sakamoto spin_unlock_irq(&instances_lock);
287555e8a8fSTakashi Sakamoto }
288555e8a8fSTakashi Sakamoto
snd_efw_transaction_bus_reset(struct fw_unit * unit)289bde8a8f2STakashi Sakamoto void snd_efw_transaction_bus_reset(struct fw_unit *unit)
290bde8a8f2STakashi Sakamoto {
291bde8a8f2STakashi Sakamoto struct transaction_queue *t;
292bde8a8f2STakashi Sakamoto
293bde8a8f2STakashi Sakamoto spin_lock_irq(&transaction_queues_lock);
294bde8a8f2STakashi Sakamoto list_for_each_entry(t, &transaction_queues, list) {
295bde8a8f2STakashi Sakamoto if ((t->unit == unit) &&
296bde8a8f2STakashi Sakamoto (t->state == STATE_PENDING)) {
297bde8a8f2STakashi Sakamoto t->state = STATE_BUS_RESET;
298bde8a8f2STakashi Sakamoto wake_up(&t->wait);
299bde8a8f2STakashi Sakamoto }
300bde8a8f2STakashi Sakamoto }
301bde8a8f2STakashi Sakamoto spin_unlock_irq(&transaction_queues_lock);
302bde8a8f2STakashi Sakamoto }
303bde8a8f2STakashi Sakamoto
304bde8a8f2STakashi Sakamoto static struct fw_address_handler resp_register_handler = {
305bde8a8f2STakashi Sakamoto .length = SND_EFW_RESPONSE_MAXIMUM_BYTES,
306bde8a8f2STakashi Sakamoto .address_callback = efw_response
307bde8a8f2STakashi Sakamoto };
308bde8a8f2STakashi Sakamoto
snd_efw_transaction_register(void)309bde8a8f2STakashi Sakamoto int snd_efw_transaction_register(void)
310bde8a8f2STakashi Sakamoto {
311bde8a8f2STakashi Sakamoto static const struct fw_address_region resp_register_region = {
312bde8a8f2STakashi Sakamoto .start = MEMORY_SPACE_EFW_RESPONSE,
313bde8a8f2STakashi Sakamoto .end = MEMORY_SPACE_EFW_RESPONSE +
314bde8a8f2STakashi Sakamoto SND_EFW_RESPONSE_MAXIMUM_BYTES
315bde8a8f2STakashi Sakamoto };
316bde8a8f2STakashi Sakamoto return fw_core_add_address_handler(&resp_register_handler,
317bde8a8f2STakashi Sakamoto &resp_register_region);
318bde8a8f2STakashi Sakamoto }
319bde8a8f2STakashi Sakamoto
snd_efw_transaction_unregister(void)320bde8a8f2STakashi Sakamoto void snd_efw_transaction_unregister(void)
321bde8a8f2STakashi Sakamoto {
322bde8a8f2STakashi Sakamoto WARN_ON(!list_empty(&transaction_queues));
323bde8a8f2STakashi Sakamoto fw_core_remove_address_handler(&resp_register_handler);
324bde8a8f2STakashi Sakamoto }
325