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