Blame view
sound/firewire/fcp.c
10.3 KB
da607e196 treewide: Replace... |
1 |
// SPDX-License-Identifier: GPL-2.0-only |
31ef9134e ALSA: add LaCie F... |
2 3 4 5 |
/* * Function Control Protocol (IEC 61883-1) helper functions * * Copyright (c) Clemens Ladisch <clemens@ladisch.de> |
31ef9134e ALSA: add LaCie F... |
6 7 8 9 10 11 12 |
*/ #include <linux/device.h> #include <linux/firewire.h> #include <linux/firewire-constants.h> #include <linux/list.h> #include <linux/module.h> |
1017abed1 ALSA: firewire-li... |
13 |
#include <linux/slab.h> |
31ef9134e ALSA: add LaCie F... |
14 15 16 |
#include <linux/sched.h> #include <linux/spinlock.h> #include <linux/wait.h> |
5de0ee574 ALSA: firewire - ... |
17 |
#include <linux/delay.h> |
31ef9134e ALSA: add LaCie F... |
18 19 |
#include "fcp.h" #include "lib.h" |
d67c46b95 ALSA: firewire-li... |
20 |
#include "amdtp-stream.h" |
31ef9134e ALSA: add LaCie F... |
21 22 23 24 25 26 |
#define CTS_AVC 0x00 #define ERROR_RETRIES 3 #define ERROR_DELAY_MS 5 #define FCP_TIMEOUT_MS 125 |
1017abed1 ALSA: firewire-li... |
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
int avc_general_set_sig_fmt(struct fw_unit *unit, unsigned int rate, enum avc_general_plug_dir dir, unsigned short pid) { unsigned int sfc; u8 *buf; bool flag; int err; flag = false; for (sfc = 0; sfc < CIP_SFC_COUNT; sfc++) { if (amdtp_rate_table[sfc] == rate) { flag = true; break; } } if (!flag) return -EINVAL; buf = kzalloc(8, GFP_KERNEL); if (buf == NULL) return -ENOMEM; buf[0] = 0x00; /* AV/C CONTROL */ buf[1] = 0xff; /* UNIT */ if (dir == AVC_GENERAL_PLUG_DIR_IN) buf[2] = 0x19; /* INPUT PLUG SIGNAL FORMAT */ else buf[2] = 0x18; /* OUTPUT PLUG SIGNAL FORMAT */ buf[3] = 0xff & pid; /* plug id */ buf[4] = 0x90; /* EOH_1, Form_1, FMT. AM824 */ buf[5] = 0x07 & sfc; /* FDF-hi. AM824, frequency */ buf[6] = 0xff; /* FDF-mid. AM824, SYT hi (not used)*/ buf[7] = 0xff; /* FDF-low. AM824, SYT lo (not used) */ /* do transaction and check buf[1-5] are the same against command */ err = fcp_avc_transaction(unit, buf, 8, buf, 8, BIT(1) | BIT(2) | BIT(3) | BIT(4) | BIT(5)); |
7e1621de1 ALSA: firewire-li... |
65 66 67 |
if (err < 0) ; else if (err < 8) |
1017abed1 ALSA: firewire-li... |
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
err = -EIO; else if (buf[0] == 0x08) /* NOT IMPLEMENTED */ err = -ENOSYS; else if (buf[0] == 0x0a) /* REJECTED */ err = -EINVAL; if (err < 0) goto end; err = 0; end: kfree(buf); return err; } EXPORT_SYMBOL(avc_general_set_sig_fmt); int avc_general_get_sig_fmt(struct fw_unit *unit, unsigned int *rate, enum avc_general_plug_dir dir, unsigned short pid) { unsigned int sfc; u8 *buf; int err; buf = kzalloc(8, GFP_KERNEL); if (buf == NULL) return -ENOMEM; buf[0] = 0x01; /* AV/C STATUS */ buf[1] = 0xff; /* Unit */ if (dir == AVC_GENERAL_PLUG_DIR_IN) buf[2] = 0x19; /* INPUT PLUG SIGNAL FORMAT */ else buf[2] = 0x18; /* OUTPUT PLUG SIGNAL FORMAT */ buf[3] = 0xff & pid; /* plug id */ buf[4] = 0x90; /* EOH_1, Form_1, FMT. AM824 */ buf[5] = 0xff; /* FDF-hi. AM824, frequency */ buf[6] = 0xff; /* FDF-mid. AM824, SYT hi (not used) */ buf[7] = 0xff; /* FDF-low. AM824, SYT lo (not used) */ /* do transaction and check buf[1-4] are the same against command */ err = fcp_avc_transaction(unit, buf, 8, buf, 8, BIT(1) | BIT(2) | BIT(3) | BIT(4)); |
7e1621de1 ALSA: firewire-li... |
110 111 112 |
if (err < 0) ; else if (err < 8) |
1017abed1 ALSA: firewire-li... |
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
err = -EIO; else if (buf[0] == 0x08) /* NOT IMPLEMENTED */ err = -ENOSYS; else if (buf[0] == 0x0a) /* REJECTED */ err = -EINVAL; else if (buf[0] == 0x0b) /* IN TRANSITION */ err = -EAGAIN; if (err < 0) goto end; /* check sfc field and pick up rate */ sfc = 0x07 & buf[5]; if (sfc >= CIP_SFC_COUNT) { err = -EAGAIN; /* also in transition */ goto end; } *rate = amdtp_rate_table[sfc]; err = 0; end: kfree(buf); return err; } EXPORT_SYMBOL(avc_general_get_sig_fmt); int avc_general_get_plug_info(struct fw_unit *unit, unsigned int subunit_type, unsigned int subunit_id, unsigned int subfunction, u8 info[AVC_PLUG_INFO_BUF_BYTES]) { u8 *buf; int err; /* extended subunit in spec.4.2 is not supported */ if ((subunit_type == 0x1E) || (subunit_id == 5)) return -EINVAL; buf = kzalloc(8, GFP_KERNEL); if (buf == NULL) return -ENOMEM; buf[0] = 0x01; /* AV/C STATUS */ /* UNIT or Subunit, Functionblock */ buf[1] = ((subunit_type & 0x1f) << 3) | (subunit_id & 0x7); buf[2] = 0x02; /* PLUG INFO */ buf[3] = 0xff & subfunction; err = fcp_avc_transaction(unit, buf, 8, buf, 8, BIT(1) | BIT(2)); |
7e1621de1 ALSA: firewire-li... |
160 161 162 |
if (err < 0) ; else if (err < 8) |
1017abed1 ALSA: firewire-li... |
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
err = -EIO; else if (buf[0] == 0x08) /* NOT IMPLEMENTED */ err = -ENOSYS; else if (buf[0] == 0x0a) /* REJECTED */ err = -EINVAL; else if (buf[0] == 0x0b) /* IN TRANSITION */ err = -EAGAIN; if (err < 0) goto end; info[0] = buf[4]; info[1] = buf[5]; info[2] = buf[6]; info[3] = buf[7]; err = 0; end: kfree(buf); return err; } EXPORT_SYMBOL(avc_general_get_plug_info); |
31ef9134e ALSA: add LaCie F... |
184 185 186 187 188 189 190 |
static DEFINE_SPINLOCK(transactions_lock); static LIST_HEAD(transactions); enum fcp_state { STATE_PENDING, STATE_BUS_RESET, STATE_COMPLETE, |
00a7bb81c ALSA: firewire-li... |
191 |
STATE_DEFERRED, |
31ef9134e ALSA: add LaCie F... |
192 193 194 195 196 197 198 199 200 201 |
}; struct fcp_transaction { struct list_head list; struct fw_unit *unit; void *response_buffer; unsigned int response_size; unsigned int response_match_bytes; enum fcp_state state; wait_queue_head_t wait; |
00a7bb81c ALSA: firewire-li... |
202 |
bool deferrable; |
31ef9134e ALSA: add LaCie F... |
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
}; /** * fcp_avc_transaction - send an AV/C command and wait for its response * @unit: a unit on the target device * @command: a buffer containing the command frame; must be DMA-able * @command_size: the size of @command * @response: a buffer for the response frame * @response_size: the maximum size of @response * @response_match_bytes: a bitmap specifying the bytes used to detect the * correct response frame * * This function sends a FCP command frame to the target and waits for the * corresponding response frame to be returned. * * Because it is possible for multiple FCP transactions to be active at the * same time, the correct response frame is detected by the value of certain * bytes. These bytes must be set in @response before calling this function, * and the corresponding bits must be set in @response_match_bytes. * * @command and @response can point to the same buffer. * |
31ef9134e ALSA: add LaCie F... |
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
* Returns the actual size of the response frame, or a negative error code. */ int fcp_avc_transaction(struct fw_unit *unit, const void *command, unsigned int command_size, void *response, unsigned int response_size, unsigned int response_match_bytes) { struct fcp_transaction t; int tcode, ret, tries = 0; t.unit = unit; t.response_buffer = response; t.response_size = response_size; t.response_match_bytes = response_match_bytes; t.state = STATE_PENDING; init_waitqueue_head(&t.wait); |
00a7bb81c ALSA: firewire-li... |
241 242 |
if (*(const u8 *)command == 0x00 || *(const u8 *)command == 0x03) t.deferrable = true; |
31ef9134e ALSA: add LaCie F... |
243 244 245 246 247 248 249 250 251 |
spin_lock_irq(&transactions_lock); list_add_tail(&t.list, &transactions); spin_unlock_irq(&transactions_lock); for (;;) { tcode = command_size == 4 ? TCODE_WRITE_QUADLET_REQUEST : TCODE_WRITE_BLOCK_REQUEST; ret = snd_fw_transaction(t.unit, tcode, CSR_REGISTER_BASE + CSR_FCP_COMMAND, |
1b70485f1 ALSA: firewire: e... |
252 |
(void *)command, command_size, 0); |
31ef9134e ALSA: add LaCie F... |
253 254 |
if (ret < 0) break; |
00a7bb81c ALSA: firewire-li... |
255 |
deferred: |
31ef9134e ALSA: add LaCie F... |
256 257 |
wait_event_timeout(t.wait, t.state != STATE_PENDING, msecs_to_jiffies(FCP_TIMEOUT_MS)); |
00a7bb81c ALSA: firewire-li... |
258 259 260 261 262 263 264 265 266 267 268 |
if (t.state == STATE_DEFERRED) { /* * 'AV/C General Specification' define no time limit * on command completion once an INTERIM response has * been sent. but we promise to finish this function * for a caller. Here we use FCP_TIMEOUT_MS for next * interval. This is not in the specification. */ t.state = STATE_PENDING; goto deferred; } else if (t.state == STATE_COMPLETE) { |
31ef9134e ALSA: add LaCie F... |
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
ret = t.response_size; break; } else if (t.state == STATE_BUS_RESET) { msleep(ERROR_DELAY_MS); } else if (++tries >= ERROR_RETRIES) { dev_err(&t.unit->device, "FCP command timed out "); ret = -EIO; break; } } spin_lock_irq(&transactions_lock); list_del(&t.list); spin_unlock_irq(&transactions_lock); return ret; } EXPORT_SYMBOL(fcp_avc_transaction); /** * fcp_bus_reset - inform the target handler about a bus reset * @unit: the unit that might be used by fcp_avc_transaction() * * This function must be called from the driver's .update handler to inform * the FCP transaction handler that a bus reset has happened. Any pending FCP * transactions are retried. */ void fcp_bus_reset(struct fw_unit *unit) { struct fcp_transaction *t; spin_lock_irq(&transactions_lock); list_for_each_entry(t, &transactions, list) { if (t->unit == unit && |
00a7bb81c ALSA: firewire-li... |
304 305 |
(t->state == STATE_PENDING || t->state == STATE_DEFERRED)) { |
31ef9134e ALSA: add LaCie F... |
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
t->state = STATE_BUS_RESET; wake_up(&t->wait); } } spin_unlock_irq(&transactions_lock); } EXPORT_SYMBOL(fcp_bus_reset); /* checks whether the response matches the masked bytes in response_buffer */ static bool is_matching_response(struct fcp_transaction *transaction, const void *response, size_t length) { const u8 *p1, *p2; unsigned int mask, i; p1 = response; p2 = transaction->response_buffer; mask = transaction->response_match_bytes; for (i = 0; ; ++i) { if ((mask & 1) && p1[i] != p2[i]) return false; mask >>= 1; if (!mask) return true; if (--length == 0) return false; } } static void fcp_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) { struct fcp_transaction *t; unsigned long flags; if (length < 1 || (*(const u8 *)data & 0xf0) != CTS_AVC) return; spin_lock_irqsave(&transactions_lock, flags); list_for_each_entry(t, &transactions, list) { struct fw_device *device = fw_parent_device(t->unit); if (device->card != card || device->generation != generation) continue; smp_rmb(); /* node_id vs. generation */ if (device->node_id != source) continue; if (t->state == STATE_PENDING && is_matching_response(t, data, length)) { |
00a7bb81c ALSA: firewire-li... |
359 360 361 362 363 364 365 366 367 |
if (t->deferrable && *(const u8 *)data == 0x0f) { t->state = STATE_DEFERRED; } else { t->state = STATE_COMPLETE; t->response_size = min_t(unsigned int, length, t->response_size); memcpy(t->response_buffer, data, t->response_size); } |
31ef9134e ALSA: add LaCie F... |
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 |
wake_up(&t->wait); } } spin_unlock_irqrestore(&transactions_lock, flags); } static struct fw_address_handler response_register_handler = { .length = 0x200, .address_callback = fcp_response, }; static int __init fcp_module_init(void) { static const struct fw_address_region response_register_region = { .start = CSR_REGISTER_BASE + CSR_FCP_RESPONSE, .end = CSR_REGISTER_BASE + CSR_FCP_END, }; fw_core_add_address_handler(&response_register_handler, &response_register_region); return 0; } static void __exit fcp_module_exit(void) { WARN_ON(!list_empty(&transactions)); fw_core_remove_address_handler(&response_register_handler); } module_init(fcp_module_init); module_exit(fcp_module_exit); |