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 34bde8a8f2STakashi Sakamoto #define MEMORY_SPACE_EFW_COMMAND 0xecc000000000 35bde8a8f2STakashi Sakamoto #define MEMORY_SPACE_EFW_RESPONSE 0xecc080000000 36bde8a8f2STakashi Sakamoto 37bde8a8f2STakashi Sakamoto #define ERROR_RETRIES 3 38bde8a8f2STakashi Sakamoto #define ERROR_DELAY_MS 5 39bde8a8f2STakashi Sakamoto #define EFC_TIMEOUT_MS 125 40bde8a8f2STakashi Sakamoto 41bde8a8f2STakashi Sakamoto static DEFINE_SPINLOCK(transaction_queues_lock); 42bde8a8f2STakashi Sakamoto static LIST_HEAD(transaction_queues); 43bde8a8f2STakashi Sakamoto 44bde8a8f2STakashi Sakamoto enum transaction_queue_state { 45bde8a8f2STakashi Sakamoto STATE_PENDING, 46bde8a8f2STakashi Sakamoto STATE_BUS_RESET, 47bde8a8f2STakashi Sakamoto STATE_COMPLETE 48bde8a8f2STakashi Sakamoto }; 49bde8a8f2STakashi Sakamoto 50bde8a8f2STakashi Sakamoto struct transaction_queue { 51bde8a8f2STakashi Sakamoto struct list_head list; 52bde8a8f2STakashi Sakamoto struct fw_unit *unit; 53bde8a8f2STakashi Sakamoto void *buf; 54bde8a8f2STakashi Sakamoto unsigned int size; 55bde8a8f2STakashi Sakamoto u32 seqnum; 56bde8a8f2STakashi Sakamoto enum transaction_queue_state state; 57bde8a8f2STakashi Sakamoto wait_queue_head_t wait; 58bde8a8f2STakashi Sakamoto }; 59bde8a8f2STakashi Sakamoto 60bde8a8f2STakashi Sakamoto int snd_efw_transaction_run(struct fw_unit *unit, 61bde8a8f2STakashi Sakamoto const void *cmd, unsigned int cmd_size, 62bde8a8f2STakashi Sakamoto void *resp, unsigned int resp_size) 63bde8a8f2STakashi Sakamoto { 64bde8a8f2STakashi Sakamoto struct transaction_queue t; 65bde8a8f2STakashi Sakamoto unsigned int tries; 66bde8a8f2STakashi Sakamoto int ret; 67bde8a8f2STakashi Sakamoto 68bde8a8f2STakashi Sakamoto t.unit = unit; 69bde8a8f2STakashi Sakamoto t.buf = resp; 70bde8a8f2STakashi Sakamoto t.size = resp_size; 71bde8a8f2STakashi Sakamoto t.seqnum = be32_to_cpu(((struct snd_efw_transaction *)cmd)->seqnum) + 1; 72bde8a8f2STakashi Sakamoto t.state = STATE_PENDING; 73bde8a8f2STakashi Sakamoto init_waitqueue_head(&t.wait); 74bde8a8f2STakashi Sakamoto 75bde8a8f2STakashi Sakamoto spin_lock_irq(&transaction_queues_lock); 76bde8a8f2STakashi Sakamoto list_add_tail(&t.list, &transaction_queues); 77bde8a8f2STakashi Sakamoto spin_unlock_irq(&transaction_queues_lock); 78bde8a8f2STakashi Sakamoto 79bde8a8f2STakashi Sakamoto tries = 0; 80bde8a8f2STakashi Sakamoto do { 81bde8a8f2STakashi Sakamoto ret = snd_fw_transaction(unit, TCODE_WRITE_BLOCK_REQUEST, 82bde8a8f2STakashi Sakamoto MEMORY_SPACE_EFW_COMMAND, 83bde8a8f2STakashi Sakamoto (void *)cmd, cmd_size, 0); 84bde8a8f2STakashi Sakamoto if (ret < 0) 85bde8a8f2STakashi Sakamoto break; 86bde8a8f2STakashi Sakamoto 87bde8a8f2STakashi Sakamoto wait_event_timeout(t.wait, t.state != STATE_PENDING, 88bde8a8f2STakashi Sakamoto msecs_to_jiffies(EFC_TIMEOUT_MS)); 89bde8a8f2STakashi Sakamoto 90bde8a8f2STakashi Sakamoto if (t.state == STATE_COMPLETE) { 91bde8a8f2STakashi Sakamoto ret = t.size; 92bde8a8f2STakashi Sakamoto break; 93bde8a8f2STakashi Sakamoto } else if (t.state == STATE_BUS_RESET) { 94bde8a8f2STakashi Sakamoto msleep(ERROR_DELAY_MS); 95bde8a8f2STakashi Sakamoto } else if (++tries >= ERROR_RETRIES) { 96bde8a8f2STakashi Sakamoto dev_err(&t.unit->device, "EFW transaction timed out\n"); 97bde8a8f2STakashi Sakamoto ret = -EIO; 98bde8a8f2STakashi Sakamoto break; 99bde8a8f2STakashi Sakamoto } 100bde8a8f2STakashi Sakamoto } while (1); 101bde8a8f2STakashi Sakamoto 102bde8a8f2STakashi Sakamoto spin_lock_irq(&transaction_queues_lock); 103bde8a8f2STakashi Sakamoto list_del(&t.list); 104bde8a8f2STakashi Sakamoto spin_unlock_irq(&transaction_queues_lock); 105bde8a8f2STakashi Sakamoto 106bde8a8f2STakashi Sakamoto return ret; 107bde8a8f2STakashi Sakamoto } 108bde8a8f2STakashi Sakamoto 109bde8a8f2STakashi Sakamoto static void 110bde8a8f2STakashi Sakamoto efw_response(struct fw_card *card, struct fw_request *request, 111bde8a8f2STakashi Sakamoto int tcode, int destination, int source, 112bde8a8f2STakashi Sakamoto int generation, unsigned long long offset, 113bde8a8f2STakashi Sakamoto void *data, size_t length, void *callback_data) 114bde8a8f2STakashi Sakamoto { 115bde8a8f2STakashi Sakamoto struct fw_device *device; 116bde8a8f2STakashi Sakamoto struct transaction_queue *t; 117bde8a8f2STakashi Sakamoto unsigned long flags; 118bde8a8f2STakashi Sakamoto int rcode; 119bde8a8f2STakashi Sakamoto u32 seqnum; 120bde8a8f2STakashi Sakamoto 121bde8a8f2STakashi Sakamoto rcode = RCODE_TYPE_ERROR; 122bde8a8f2STakashi Sakamoto if (length < sizeof(struct snd_efw_transaction)) { 123bde8a8f2STakashi Sakamoto rcode = RCODE_DATA_ERROR; 124bde8a8f2STakashi Sakamoto goto end; 125bde8a8f2STakashi Sakamoto } else if (offset != MEMORY_SPACE_EFW_RESPONSE) { 126bde8a8f2STakashi Sakamoto rcode = RCODE_ADDRESS_ERROR; 127bde8a8f2STakashi Sakamoto goto end; 128bde8a8f2STakashi Sakamoto } 129bde8a8f2STakashi Sakamoto 130bde8a8f2STakashi Sakamoto seqnum = be32_to_cpu(((struct snd_efw_transaction *)data)->seqnum); 131bde8a8f2STakashi Sakamoto 132bde8a8f2STakashi Sakamoto spin_lock_irqsave(&transaction_queues_lock, flags); 133bde8a8f2STakashi Sakamoto list_for_each_entry(t, &transaction_queues, list) { 134bde8a8f2STakashi Sakamoto device = fw_parent_device(t->unit); 135bde8a8f2STakashi Sakamoto if ((device->card != card) || 136bde8a8f2STakashi Sakamoto (device->generation != generation)) 137bde8a8f2STakashi Sakamoto continue; 138bde8a8f2STakashi Sakamoto smp_rmb(); /* node_id vs. generation */ 139bde8a8f2STakashi Sakamoto if (device->node_id != source) 140bde8a8f2STakashi Sakamoto continue; 141bde8a8f2STakashi Sakamoto 142bde8a8f2STakashi Sakamoto if ((t->state == STATE_PENDING) && (t->seqnum == seqnum)) { 143bde8a8f2STakashi Sakamoto t->state = STATE_COMPLETE; 144bde8a8f2STakashi Sakamoto t->size = min_t(unsigned int, length, t->size); 145bde8a8f2STakashi Sakamoto memcpy(t->buf, data, t->size); 146bde8a8f2STakashi Sakamoto wake_up(&t->wait); 147bde8a8f2STakashi Sakamoto rcode = RCODE_COMPLETE; 148bde8a8f2STakashi Sakamoto } 149bde8a8f2STakashi Sakamoto } 150bde8a8f2STakashi Sakamoto spin_unlock_irqrestore(&transaction_queues_lock, flags); 151bde8a8f2STakashi Sakamoto end: 152bde8a8f2STakashi Sakamoto fw_send_response(card, request, rcode); 153bde8a8f2STakashi Sakamoto } 154bde8a8f2STakashi Sakamoto 155bde8a8f2STakashi Sakamoto void snd_efw_transaction_bus_reset(struct fw_unit *unit) 156bde8a8f2STakashi Sakamoto { 157bde8a8f2STakashi Sakamoto struct transaction_queue *t; 158bde8a8f2STakashi Sakamoto 159bde8a8f2STakashi Sakamoto spin_lock_irq(&transaction_queues_lock); 160bde8a8f2STakashi Sakamoto list_for_each_entry(t, &transaction_queues, list) { 161bde8a8f2STakashi Sakamoto if ((t->unit == unit) && 162bde8a8f2STakashi Sakamoto (t->state == STATE_PENDING)) { 163bde8a8f2STakashi Sakamoto t->state = STATE_BUS_RESET; 164bde8a8f2STakashi Sakamoto wake_up(&t->wait); 165bde8a8f2STakashi Sakamoto } 166bde8a8f2STakashi Sakamoto } 167bde8a8f2STakashi Sakamoto spin_unlock_irq(&transaction_queues_lock); 168bde8a8f2STakashi Sakamoto } 169bde8a8f2STakashi Sakamoto 170bde8a8f2STakashi Sakamoto static struct fw_address_handler resp_register_handler = { 171bde8a8f2STakashi Sakamoto .length = SND_EFW_RESPONSE_MAXIMUM_BYTES, 172bde8a8f2STakashi Sakamoto .address_callback = efw_response 173bde8a8f2STakashi Sakamoto }; 174bde8a8f2STakashi Sakamoto 175bde8a8f2STakashi Sakamoto int snd_efw_transaction_register(void) 176bde8a8f2STakashi Sakamoto { 177bde8a8f2STakashi Sakamoto static const struct fw_address_region resp_register_region = { 178bde8a8f2STakashi Sakamoto .start = MEMORY_SPACE_EFW_RESPONSE, 179bde8a8f2STakashi Sakamoto .end = MEMORY_SPACE_EFW_RESPONSE + 180bde8a8f2STakashi Sakamoto SND_EFW_RESPONSE_MAXIMUM_BYTES 181bde8a8f2STakashi Sakamoto }; 182bde8a8f2STakashi Sakamoto return fw_core_add_address_handler(&resp_register_handler, 183bde8a8f2STakashi Sakamoto &resp_register_region); 184bde8a8f2STakashi Sakamoto } 185bde8a8f2STakashi Sakamoto 186bde8a8f2STakashi Sakamoto void snd_efw_transaction_unregister(void) 187bde8a8f2STakashi Sakamoto { 188bde8a8f2STakashi Sakamoto WARN_ON(!list_empty(&transaction_queues)); 189bde8a8f2STakashi Sakamoto fw_core_remove_address_handler(&resp_register_handler); 190bde8a8f2STakashi Sakamoto } 191