1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Char device for device raw access 4 * 5 * Copyright (C) 2005-2007 Kristian Hoegsberg <[email protected]> 6 */ 7 8 #include <linux/bug.h> 9 #include <linux/compat.h> 10 #include <linux/delay.h> 11 #include <linux/device.h> 12 #include <linux/dma-mapping.h> 13 #include <linux/err.h> 14 #include <linux/errno.h> 15 #include <linux/firewire.h> 16 #include <linux/firewire-cdev.h> 17 #include <linux/idr.h> 18 #include <linux/irqflags.h> 19 #include <linux/jiffies.h> 20 #include <linux/kernel.h> 21 #include <linux/kref.h> 22 #include <linux/mm.h> 23 #include <linux/module.h> 24 #include <linux/mutex.h> 25 #include <linux/poll.h> 26 #include <linux/sched.h> /* required for linux/wait.h */ 27 #include <linux/slab.h> 28 #include <linux/spinlock.h> 29 #include <linux/string.h> 30 #include <linux/time.h> 31 #include <linux/uaccess.h> 32 #include <linux/vmalloc.h> 33 #include <linux/wait.h> 34 #include <linux/workqueue.h> 35 36 37 #include "core.h" 38 #include <trace/events/firewire.h> 39 40 #include "packet-header-definitions.h" 41 42 /* 43 * ABI version history is documented in linux/firewire-cdev.h. 44 */ 45 #define FW_CDEV_KERNEL_VERSION 5 46 #define FW_CDEV_VERSION_EVENT_REQUEST2 4 47 #define FW_CDEV_VERSION_ALLOCATE_REGION_END 4 48 #define FW_CDEV_VERSION_AUTO_FLUSH_ISO_OVERFLOW 5 49 #define FW_CDEV_VERSION_EVENT_ASYNC_TSTAMP 6 50 51 struct client { 52 u32 version; 53 struct fw_device *device; 54 55 spinlock_t lock; 56 bool in_shutdown; 57 struct idr resource_idr; 58 struct list_head event_list; 59 wait_queue_head_t wait; 60 wait_queue_head_t tx_flush_wait; 61 u64 bus_reset_closure; 62 63 struct fw_iso_context *iso_context; 64 u64 iso_closure; 65 struct fw_iso_buffer buffer; 66 unsigned long vm_start; 67 bool buffer_is_mapped; 68 69 struct list_head phy_receiver_link; 70 u64 phy_receiver_closure; 71 72 struct list_head link; 73 struct kref kref; 74 }; 75 76 static inline void client_get(struct client *client) 77 { 78 kref_get(&client->kref); 79 } 80 81 static void client_release(struct kref *kref) 82 { 83 struct client *client = container_of(kref, struct client, kref); 84 85 fw_device_put(client->device); 86 kfree(client); 87 } 88 89 static void client_put(struct client *client) 90 { 91 kref_put(&client->kref, client_release); 92 } 93 94 struct client_resource; 95 typedef void (*client_resource_release_fn_t)(struct client *, 96 struct client_resource *); 97 struct client_resource { 98 client_resource_release_fn_t release; 99 int handle; 100 }; 101 102 struct address_handler_resource { 103 struct client_resource resource; 104 struct fw_address_handler handler; 105 __u64 closure; 106 struct client *client; 107 }; 108 109 struct outbound_transaction_resource { 110 struct client_resource resource; 111 struct fw_transaction transaction; 112 }; 113 114 struct inbound_transaction_resource { 115 struct client_resource resource; 116 struct fw_card *card; 117 struct fw_request *request; 118 bool is_fcp; 119 void *data; 120 size_t length; 121 }; 122 123 struct descriptor_resource { 124 struct client_resource resource; 125 struct fw_descriptor descriptor; 126 u32 data[]; 127 }; 128 129 struct iso_resource { 130 struct client_resource resource; 131 struct client *client; 132 /* Schedule work and access todo only with client->lock held. */ 133 struct delayed_work work; 134 enum {ISO_RES_ALLOC, ISO_RES_REALLOC, ISO_RES_DEALLOC, 135 ISO_RES_ALLOC_ONCE, ISO_RES_DEALLOC_ONCE,} todo; 136 int generation; 137 u64 channels; 138 s32 bandwidth; 139 struct iso_resource_event *e_alloc, *e_dealloc; 140 }; 141 142 static struct address_handler_resource *to_address_handler_resource(struct client_resource *resource) 143 { 144 return container_of(resource, struct address_handler_resource, resource); 145 } 146 147 static struct inbound_transaction_resource *to_inbound_transaction_resource(struct client_resource *resource) 148 { 149 return container_of(resource, struct inbound_transaction_resource, resource); 150 } 151 152 static struct descriptor_resource *to_descriptor_resource(struct client_resource *resource) 153 { 154 return container_of(resource, struct descriptor_resource, resource); 155 } 156 157 static struct iso_resource *to_iso_resource(struct client_resource *resource) 158 { 159 return container_of(resource, struct iso_resource, resource); 160 } 161 162 static void release_iso_resource(struct client *, struct client_resource *); 163 164 static int is_iso_resource(const struct client_resource *resource) 165 { 166 return resource->release == release_iso_resource; 167 } 168 169 static void release_transaction(struct client *client, 170 struct client_resource *resource); 171 172 static int is_outbound_transaction_resource(const struct client_resource *resource) 173 { 174 return resource->release == release_transaction; 175 } 176 177 static void schedule_iso_resource(struct iso_resource *r, unsigned long delay) 178 { 179 client_get(r->client); 180 if (!queue_delayed_work(fw_workqueue, &r->work, delay)) 181 client_put(r->client); 182 } 183 184 /* 185 * dequeue_event() just kfree()'s the event, so the event has to be 186 * the first field in a struct XYZ_event. 187 */ 188 struct event { 189 struct { void *data; size_t size; } v[2]; 190 struct list_head link; 191 }; 192 193 struct bus_reset_event { 194 struct event event; 195 struct fw_cdev_event_bus_reset reset; 196 }; 197 198 struct outbound_transaction_event { 199 struct event event; 200 struct client *client; 201 struct outbound_transaction_resource r; 202 union { 203 struct fw_cdev_event_response without_tstamp; 204 struct fw_cdev_event_response2 with_tstamp; 205 } rsp; 206 }; 207 208 struct inbound_transaction_event { 209 struct event event; 210 union { 211 struct fw_cdev_event_request request; 212 struct fw_cdev_event_request2 request2; 213 struct fw_cdev_event_request3 with_tstamp; 214 } req; 215 }; 216 217 struct iso_interrupt_event { 218 struct event event; 219 struct fw_cdev_event_iso_interrupt interrupt; 220 }; 221 222 struct iso_interrupt_mc_event { 223 struct event event; 224 struct fw_cdev_event_iso_interrupt_mc interrupt; 225 }; 226 227 struct iso_resource_event { 228 struct event event; 229 struct fw_cdev_event_iso_resource iso_resource; 230 }; 231 232 struct outbound_phy_packet_event { 233 struct event event; 234 struct client *client; 235 struct fw_packet p; 236 union { 237 struct fw_cdev_event_phy_packet without_tstamp; 238 struct fw_cdev_event_phy_packet2 with_tstamp; 239 } phy_packet; 240 }; 241 242 struct inbound_phy_packet_event { 243 struct event event; 244 union { 245 struct fw_cdev_event_phy_packet without_tstamp; 246 struct fw_cdev_event_phy_packet2 with_tstamp; 247 } phy_packet; 248 }; 249 250 #ifdef CONFIG_COMPAT 251 static void __user *u64_to_uptr(u64 value) 252 { 253 if (in_compat_syscall()) 254 return compat_ptr(value); 255 else 256 return (void __user *)(unsigned long)value; 257 } 258 259 static u64 uptr_to_u64(void __user *ptr) 260 { 261 if (in_compat_syscall()) 262 return ptr_to_compat(ptr); 263 else 264 return (u64)(unsigned long)ptr; 265 } 266 #else 267 static inline void __user *u64_to_uptr(u64 value) 268 { 269 return (void __user *)(unsigned long)value; 270 } 271 272 static inline u64 uptr_to_u64(void __user *ptr) 273 { 274 return (u64)(unsigned long)ptr; 275 } 276 #endif /* CONFIG_COMPAT */ 277 278 static int fw_device_op_open(struct inode *inode, struct file *file) 279 { 280 struct fw_device *device; 281 struct client *client; 282 283 device = fw_device_get_by_devt(inode->i_rdev); 284 if (device == NULL) 285 return -ENODEV; 286 287 if (fw_device_is_shutdown(device)) { 288 fw_device_put(device); 289 return -ENODEV; 290 } 291 292 client = kzalloc(sizeof(*client), GFP_KERNEL); 293 if (client == NULL) { 294 fw_device_put(device); 295 return -ENOMEM; 296 } 297 298 client->device = device; 299 spin_lock_init(&client->lock); 300 idr_init(&client->resource_idr); 301 INIT_LIST_HEAD(&client->event_list); 302 init_waitqueue_head(&client->wait); 303 init_waitqueue_head(&client->tx_flush_wait); 304 INIT_LIST_HEAD(&client->phy_receiver_link); 305 INIT_LIST_HEAD(&client->link); 306 kref_init(&client->kref); 307 308 file->private_data = client; 309 310 return nonseekable_open(inode, file); 311 } 312 313 static void queue_event(struct client *client, struct event *event, 314 void *data0, size_t size0, void *data1, size_t size1) 315 { 316 event->v[0].data = data0; 317 event->v[0].size = size0; 318 event->v[1].data = data1; 319 event->v[1].size = size1; 320 321 scoped_guard(spinlock_irqsave, &client->lock) { 322 if (client->in_shutdown) 323 kfree(event); 324 else 325 list_add_tail(&event->link, &client->event_list); 326 } 327 328 wake_up_interruptible(&client->wait); 329 } 330 331 static int dequeue_event(struct client *client, 332 char __user *buffer, size_t count) 333 { 334 struct event *event; 335 size_t size, total; 336 int i, ret; 337 338 ret = wait_event_interruptible(client->wait, 339 !list_empty(&client->event_list) || 340 fw_device_is_shutdown(client->device)); 341 if (ret < 0) 342 return ret; 343 344 if (list_empty(&client->event_list) && 345 fw_device_is_shutdown(client->device)) 346 return -ENODEV; 347 348 scoped_guard(spinlock_irq, &client->lock) { 349 event = list_first_entry(&client->event_list, struct event, link); 350 list_del(&event->link); 351 } 352 353 total = 0; 354 for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) { 355 size = min(event->v[i].size, count - total); 356 if (copy_to_user(buffer + total, event->v[i].data, size)) { 357 ret = -EFAULT; 358 goto out; 359 } 360 total += size; 361 } 362 ret = total; 363 364 out: 365 kfree(event); 366 367 return ret; 368 } 369 370 static ssize_t fw_device_op_read(struct file *file, char __user *buffer, 371 size_t count, loff_t *offset) 372 { 373 struct client *client = file->private_data; 374 375 return dequeue_event(client, buffer, count); 376 } 377 378 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset *event, 379 struct client *client) 380 { 381 struct fw_card *card = client->device->card; 382 383 guard(spinlock_irq)(&card->lock); 384 385 event->closure = client->bus_reset_closure; 386 event->type = FW_CDEV_EVENT_BUS_RESET; 387 event->generation = client->device->generation; 388 event->node_id = client->device->node_id; 389 event->local_node_id = card->local_node->node_id; 390 event->bm_node_id = card->bm_node_id; 391 event->irm_node_id = card->irm_node->node_id; 392 event->root_node_id = card->root_node->node_id; 393 } 394 395 static void for_each_client(struct fw_device *device, 396 void (*callback)(struct client *client)) 397 { 398 struct client *c; 399 400 guard(mutex)(&device->client_list_mutex); 401 402 list_for_each_entry(c, &device->client_list, link) 403 callback(c); 404 } 405 406 static void queue_bus_reset_event(struct client *client) 407 { 408 struct bus_reset_event *e; 409 struct client_resource *resource; 410 int id; 411 412 e = kzalloc(sizeof(*e), GFP_KERNEL); 413 if (e == NULL) 414 return; 415 416 fill_bus_reset_event(&e->reset, client); 417 418 queue_event(client, &e->event, 419 &e->reset, sizeof(e->reset), NULL, 0); 420 421 guard(spinlock_irq)(&client->lock); 422 423 idr_for_each_entry(&client->resource_idr, resource, id) { 424 if (is_iso_resource(resource)) 425 schedule_iso_resource(to_iso_resource(resource), 0); 426 } 427 } 428 429 void fw_device_cdev_update(struct fw_device *device) 430 { 431 for_each_client(device, queue_bus_reset_event); 432 } 433 434 static void wake_up_client(struct client *client) 435 { 436 wake_up_interruptible(&client->wait); 437 } 438 439 void fw_device_cdev_remove(struct fw_device *device) 440 { 441 for_each_client(device, wake_up_client); 442 } 443 444 union ioctl_arg { 445 struct fw_cdev_get_info get_info; 446 struct fw_cdev_send_request send_request; 447 struct fw_cdev_allocate allocate; 448 struct fw_cdev_deallocate deallocate; 449 struct fw_cdev_send_response send_response; 450 struct fw_cdev_initiate_bus_reset initiate_bus_reset; 451 struct fw_cdev_add_descriptor add_descriptor; 452 struct fw_cdev_remove_descriptor remove_descriptor; 453 struct fw_cdev_create_iso_context create_iso_context; 454 struct fw_cdev_queue_iso queue_iso; 455 struct fw_cdev_start_iso start_iso; 456 struct fw_cdev_stop_iso stop_iso; 457 struct fw_cdev_get_cycle_timer get_cycle_timer; 458 struct fw_cdev_allocate_iso_resource allocate_iso_resource; 459 struct fw_cdev_send_stream_packet send_stream_packet; 460 struct fw_cdev_get_cycle_timer2 get_cycle_timer2; 461 struct fw_cdev_send_phy_packet send_phy_packet; 462 struct fw_cdev_receive_phy_packets receive_phy_packets; 463 struct fw_cdev_set_iso_channels set_iso_channels; 464 struct fw_cdev_flush_iso flush_iso; 465 }; 466 467 static int ioctl_get_info(struct client *client, union ioctl_arg *arg) 468 { 469 struct fw_cdev_get_info *a = &arg->get_info; 470 struct fw_cdev_event_bus_reset bus_reset; 471 unsigned long ret = 0; 472 473 client->version = a->version; 474 a->version = FW_CDEV_KERNEL_VERSION; 475 a->card = client->device->card->index; 476 477 scoped_guard(rwsem_read, &fw_device_rwsem) { 478 if (a->rom != 0) { 479 size_t want = a->rom_length; 480 size_t have = client->device->config_rom_length * 4; 481 482 ret = copy_to_user(u64_to_uptr(a->rom), client->device->config_rom, 483 min(want, have)); 484 if (ret != 0) 485 return -EFAULT; 486 } 487 a->rom_length = client->device->config_rom_length * 4; 488 } 489 490 guard(mutex)(&client->device->client_list_mutex); 491 492 client->bus_reset_closure = a->bus_reset_closure; 493 if (a->bus_reset != 0) { 494 fill_bus_reset_event(&bus_reset, client); 495 /* unaligned size of bus_reset is 36 bytes */ 496 ret = copy_to_user(u64_to_uptr(a->bus_reset), &bus_reset, 36); 497 } 498 if (ret == 0 && list_empty(&client->link)) 499 list_add_tail(&client->link, &client->device->client_list); 500 501 return ret ? -EFAULT : 0; 502 } 503 504 static int add_client_resource(struct client *client, 505 struct client_resource *resource, gfp_t gfp_mask) 506 { 507 bool preload = gfpflags_allow_blocking(gfp_mask); 508 int ret; 509 510 if (preload) 511 idr_preload(gfp_mask); 512 513 scoped_guard(spinlock_irqsave, &client->lock) { 514 if (client->in_shutdown) 515 ret = -ECANCELED; 516 else 517 ret = idr_alloc(&client->resource_idr, resource, 0, 0, GFP_NOWAIT); 518 if (ret >= 0) { 519 resource->handle = ret; 520 client_get(client); 521 if (is_iso_resource(resource)) 522 schedule_iso_resource(to_iso_resource(resource), 0); 523 } 524 } 525 526 if (preload) 527 idr_preload_end(); 528 529 return ret < 0 ? ret : 0; 530 } 531 532 static int release_client_resource(struct client *client, u32 handle, 533 client_resource_release_fn_t release, 534 struct client_resource **return_resource) 535 { 536 struct client_resource *resource; 537 538 scoped_guard(spinlock_irq, &client->lock) { 539 if (client->in_shutdown) 540 return -EINVAL; 541 542 resource = idr_find(&client->resource_idr, handle); 543 if (!resource || resource->release != release) 544 return -EINVAL; 545 546 idr_remove(&client->resource_idr, handle); 547 } 548 549 if (return_resource) 550 *return_resource = resource; 551 else 552 resource->release(client, resource); 553 554 client_put(client); 555 556 return 0; 557 } 558 559 static void release_transaction(struct client *client, 560 struct client_resource *resource) 561 { 562 } 563 564 static void complete_transaction(struct fw_card *card, int rcode, u32 request_tstamp, 565 u32 response_tstamp, void *payload, size_t length, void *data) 566 { 567 struct outbound_transaction_event *e = data; 568 struct client *client = e->client; 569 570 scoped_guard(spinlock_irqsave, &client->lock) { 571 idr_remove(&client->resource_idr, e->r.resource.handle); 572 if (client->in_shutdown) 573 wake_up(&client->tx_flush_wait); 574 } 575 576 switch (e->rsp.without_tstamp.type) { 577 case FW_CDEV_EVENT_RESPONSE: 578 { 579 struct fw_cdev_event_response *rsp = &e->rsp.without_tstamp; 580 581 if (length < rsp->length) 582 rsp->length = length; 583 if (rcode == RCODE_COMPLETE) 584 memcpy(rsp->data, payload, rsp->length); 585 586 rsp->rcode = rcode; 587 588 // In the case that sizeof(*rsp) doesn't align with the position of the 589 // data, and the read is short, preserve an extra copy of the data 590 // to stay compatible with a pre-2.6.27 bug. Since the bug is harmless 591 // for short reads and some apps depended on it, this is both safe 592 // and prudent for compatibility. 593 if (rsp->length <= sizeof(*rsp) - offsetof(typeof(*rsp), data)) 594 queue_event(client, &e->event, rsp, sizeof(*rsp), rsp->data, rsp->length); 595 else 596 queue_event(client, &e->event, rsp, sizeof(*rsp) + rsp->length, NULL, 0); 597 598 break; 599 } 600 case FW_CDEV_EVENT_RESPONSE2: 601 { 602 struct fw_cdev_event_response2 *rsp = &e->rsp.with_tstamp; 603 604 if (length < rsp->length) 605 rsp->length = length; 606 if (rcode == RCODE_COMPLETE) 607 memcpy(rsp->data, payload, rsp->length); 608 609 rsp->rcode = rcode; 610 rsp->request_tstamp = request_tstamp; 611 rsp->response_tstamp = response_tstamp; 612 613 queue_event(client, &e->event, rsp, sizeof(*rsp) + rsp->length, NULL, 0); 614 615 break; 616 } 617 default: 618 WARN_ON(1); 619 break; 620 } 621 622 /* Drop the idr's reference */ 623 client_put(client); 624 } 625 626 static int init_request(struct client *client, 627 struct fw_cdev_send_request *request, 628 int destination_id, int speed) 629 { 630 struct outbound_transaction_event *e; 631 void *payload; 632 int ret; 633 634 if (request->tcode != TCODE_STREAM_DATA && 635 (request->length > 4096 || request->length > 512 << speed)) 636 return -EIO; 637 638 if (request->tcode == TCODE_WRITE_QUADLET_REQUEST && 639 request->length < 4) 640 return -EINVAL; 641 642 e = kmalloc(sizeof(*e) + request->length, GFP_KERNEL); 643 if (e == NULL) 644 return -ENOMEM; 645 e->client = client; 646 647 if (client->version < FW_CDEV_VERSION_EVENT_ASYNC_TSTAMP) { 648 struct fw_cdev_event_response *rsp = &e->rsp.without_tstamp; 649 650 rsp->type = FW_CDEV_EVENT_RESPONSE; 651 rsp->length = request->length; 652 rsp->closure = request->closure; 653 payload = rsp->data; 654 } else { 655 struct fw_cdev_event_response2 *rsp = &e->rsp.with_tstamp; 656 657 rsp->type = FW_CDEV_EVENT_RESPONSE2; 658 rsp->length = request->length; 659 rsp->closure = request->closure; 660 payload = rsp->data; 661 } 662 663 if (request->data && copy_from_user(payload, u64_to_uptr(request->data), request->length)) { 664 ret = -EFAULT; 665 goto failed; 666 } 667 668 e->r.resource.release = release_transaction; 669 ret = add_client_resource(client, &e->r.resource, GFP_KERNEL); 670 if (ret < 0) 671 goto failed; 672 673 fw_send_request_with_tstamp(client->device->card, &e->r.transaction, request->tcode, 674 destination_id, request->generation, speed, request->offset, 675 payload, request->length, complete_transaction, e); 676 return 0; 677 678 failed: 679 kfree(e); 680 681 return ret; 682 } 683 684 static int ioctl_send_request(struct client *client, union ioctl_arg *arg) 685 { 686 switch (arg->send_request.tcode) { 687 case TCODE_WRITE_QUADLET_REQUEST: 688 case TCODE_WRITE_BLOCK_REQUEST: 689 case TCODE_READ_QUADLET_REQUEST: 690 case TCODE_READ_BLOCK_REQUEST: 691 case TCODE_LOCK_MASK_SWAP: 692 case TCODE_LOCK_COMPARE_SWAP: 693 case TCODE_LOCK_FETCH_ADD: 694 case TCODE_LOCK_LITTLE_ADD: 695 case TCODE_LOCK_BOUNDED_ADD: 696 case TCODE_LOCK_WRAP_ADD: 697 case TCODE_LOCK_VENDOR_DEPENDENT: 698 break; 699 default: 700 return -EINVAL; 701 } 702 703 return init_request(client, &arg->send_request, client->device->node_id, 704 client->device->max_speed); 705 } 706 707 static void release_request(struct client *client, 708 struct client_resource *resource) 709 { 710 struct inbound_transaction_resource *r = to_inbound_transaction_resource(resource); 711 712 if (r->is_fcp) 713 fw_request_put(r->request); 714 else 715 fw_send_response(r->card, r->request, RCODE_CONFLICT_ERROR); 716 717 fw_card_put(r->card); 718 kfree(r); 719 } 720 721 static void handle_request(struct fw_card *card, struct fw_request *request, 722 int tcode, int destination, int source, 723 int generation, unsigned long long offset, 724 void *payload, size_t length, void *callback_data) 725 { 726 struct address_handler_resource *handler = callback_data; 727 bool is_fcp = is_in_fcp_region(offset, length); 728 struct inbound_transaction_resource *r; 729 struct inbound_transaction_event *e; 730 size_t event_size0; 731 int ret; 732 733 /* card may be different from handler->client->device->card */ 734 fw_card_get(card); 735 736 // Extend the lifetime of data for request so that its payload is safely accessible in 737 // the process context for the client. 738 if (is_fcp) 739 fw_request_get(request); 740 741 r = kmalloc(sizeof(*r), GFP_ATOMIC); 742 e = kmalloc(sizeof(*e), GFP_ATOMIC); 743 if (r == NULL || e == NULL) 744 goto failed; 745 746 r->card = card; 747 r->request = request; 748 r->is_fcp = is_fcp; 749 r->data = payload; 750 r->length = length; 751 752 r->resource.release = release_request; 753 ret = add_client_resource(handler->client, &r->resource, GFP_ATOMIC); 754 if (ret < 0) 755 goto failed; 756 757 if (handler->client->version < FW_CDEV_VERSION_EVENT_REQUEST2) { 758 struct fw_cdev_event_request *req = &e->req.request; 759 760 if (tcode & 0x10) 761 tcode = TCODE_LOCK_REQUEST; 762 763 req->type = FW_CDEV_EVENT_REQUEST; 764 req->tcode = tcode; 765 req->offset = offset; 766 req->length = length; 767 req->handle = r->resource.handle; 768 req->closure = handler->closure; 769 event_size0 = sizeof(*req); 770 } else if (handler->client->version < FW_CDEV_VERSION_EVENT_ASYNC_TSTAMP) { 771 struct fw_cdev_event_request2 *req = &e->req.request2; 772 773 req->type = FW_CDEV_EVENT_REQUEST2; 774 req->tcode = tcode; 775 req->offset = offset; 776 req->source_node_id = source; 777 req->destination_node_id = destination; 778 req->card = card->index; 779 req->generation = generation; 780 req->length = length; 781 req->handle = r->resource.handle; 782 req->closure = handler->closure; 783 event_size0 = sizeof(*req); 784 } else { 785 struct fw_cdev_event_request3 *req = &e->req.with_tstamp; 786 787 req->type = FW_CDEV_EVENT_REQUEST3; 788 req->tcode = tcode; 789 req->offset = offset; 790 req->source_node_id = source; 791 req->destination_node_id = destination; 792 req->card = card->index; 793 req->generation = generation; 794 req->length = length; 795 req->handle = r->resource.handle; 796 req->closure = handler->closure; 797 req->tstamp = fw_request_get_timestamp(request); 798 event_size0 = sizeof(*req); 799 } 800 801 queue_event(handler->client, &e->event, 802 &e->req, event_size0, r->data, length); 803 return; 804 805 failed: 806 kfree(r); 807 kfree(e); 808 809 if (!is_fcp) 810 fw_send_response(card, request, RCODE_CONFLICT_ERROR); 811 else 812 fw_request_put(request); 813 814 fw_card_put(card); 815 } 816 817 static void release_address_handler(struct client *client, 818 struct client_resource *resource) 819 { 820 struct address_handler_resource *r = to_address_handler_resource(resource); 821 822 fw_core_remove_address_handler(&r->handler); 823 kfree(r); 824 } 825 826 static int ioctl_allocate(struct client *client, union ioctl_arg *arg) 827 { 828 struct fw_cdev_allocate *a = &arg->allocate; 829 struct address_handler_resource *r; 830 struct fw_address_region region; 831 int ret; 832 833 r = kmalloc(sizeof(*r), GFP_KERNEL); 834 if (r == NULL) 835 return -ENOMEM; 836 837 region.start = a->offset; 838 if (client->version < FW_CDEV_VERSION_ALLOCATE_REGION_END) 839 region.end = a->offset + a->length; 840 else 841 region.end = a->region_end; 842 843 r->handler.length = a->length; 844 r->handler.address_callback = handle_request; 845 r->handler.callback_data = r; 846 r->closure = a->closure; 847 r->client = client; 848 849 ret = fw_core_add_address_handler(&r->handler, ®ion); 850 if (ret < 0) { 851 kfree(r); 852 return ret; 853 } 854 a->offset = r->handler.offset; 855 856 r->resource.release = release_address_handler; 857 ret = add_client_resource(client, &r->resource, GFP_KERNEL); 858 if (ret < 0) { 859 release_address_handler(client, &r->resource); 860 return ret; 861 } 862 a->handle = r->resource.handle; 863 864 return 0; 865 } 866 867 static int ioctl_deallocate(struct client *client, union ioctl_arg *arg) 868 { 869 return release_client_resource(client, arg->deallocate.handle, 870 release_address_handler, NULL); 871 } 872 873 static int ioctl_send_response(struct client *client, union ioctl_arg *arg) 874 { 875 struct fw_cdev_send_response *a = &arg->send_response; 876 struct client_resource *resource; 877 struct inbound_transaction_resource *r; 878 int ret = 0; 879 880 if (release_client_resource(client, a->handle, 881 release_request, &resource) < 0) 882 return -EINVAL; 883 884 r = to_inbound_transaction_resource(resource); 885 if (r->is_fcp) { 886 fw_request_put(r->request); 887 goto out; 888 } 889 890 if (a->length != fw_get_response_length(r->request)) { 891 ret = -EINVAL; 892 fw_request_put(r->request); 893 goto out; 894 } 895 if (copy_from_user(r->data, u64_to_uptr(a->data), a->length)) { 896 ret = -EFAULT; 897 fw_request_put(r->request); 898 goto out; 899 } 900 fw_send_response(r->card, r->request, a->rcode); 901 out: 902 fw_card_put(r->card); 903 kfree(r); 904 905 return ret; 906 } 907 908 static int ioctl_initiate_bus_reset(struct client *client, union ioctl_arg *arg) 909 { 910 fw_schedule_bus_reset(client->device->card, true, 911 arg->initiate_bus_reset.type == FW_CDEV_SHORT_RESET); 912 return 0; 913 } 914 915 static void release_descriptor(struct client *client, 916 struct client_resource *resource) 917 { 918 struct descriptor_resource *r = to_descriptor_resource(resource); 919 920 fw_core_remove_descriptor(&r->descriptor); 921 kfree(r); 922 } 923 924 static int ioctl_add_descriptor(struct client *client, union ioctl_arg *arg) 925 { 926 struct fw_cdev_add_descriptor *a = &arg->add_descriptor; 927 struct descriptor_resource *r; 928 int ret; 929 930 /* Access policy: Allow this ioctl only on local nodes' device files. */ 931 if (!client->device->is_local) 932 return -ENOSYS; 933 934 if (a->length > 256) 935 return -EINVAL; 936 937 r = kmalloc(sizeof(*r) + a->length * 4, GFP_KERNEL); 938 if (r == NULL) 939 return -ENOMEM; 940 941 if (copy_from_user(r->data, u64_to_uptr(a->data), a->length * 4)) { 942 ret = -EFAULT; 943 goto failed; 944 } 945 946 r->descriptor.length = a->length; 947 r->descriptor.immediate = a->immediate; 948 r->descriptor.key = a->key; 949 r->descriptor.data = r->data; 950 951 ret = fw_core_add_descriptor(&r->descriptor); 952 if (ret < 0) 953 goto failed; 954 955 r->resource.release = release_descriptor; 956 ret = add_client_resource(client, &r->resource, GFP_KERNEL); 957 if (ret < 0) { 958 fw_core_remove_descriptor(&r->descriptor); 959 goto failed; 960 } 961 a->handle = r->resource.handle; 962 963 return 0; 964 failed: 965 kfree(r); 966 967 return ret; 968 } 969 970 static int ioctl_remove_descriptor(struct client *client, union ioctl_arg *arg) 971 { 972 return release_client_resource(client, arg->remove_descriptor.handle, 973 release_descriptor, NULL); 974 } 975 976 static void iso_callback(struct fw_iso_context *context, u32 cycle, 977 size_t header_length, void *header, void *data) 978 { 979 struct client *client = data; 980 struct iso_interrupt_event *e; 981 982 e = kmalloc(sizeof(*e) + header_length, GFP_ATOMIC); 983 if (e == NULL) 984 return; 985 986 e->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT; 987 e->interrupt.closure = client->iso_closure; 988 e->interrupt.cycle = cycle; 989 e->interrupt.header_length = header_length; 990 memcpy(e->interrupt.header, header, header_length); 991 queue_event(client, &e->event, &e->interrupt, 992 sizeof(e->interrupt) + header_length, NULL, 0); 993 } 994 995 static void iso_mc_callback(struct fw_iso_context *context, 996 dma_addr_t completed, void *data) 997 { 998 struct client *client = data; 999 struct iso_interrupt_mc_event *e; 1000 1001 e = kmalloc(sizeof(*e), GFP_ATOMIC); 1002 if (e == NULL) 1003 return; 1004 1005 e->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL; 1006 e->interrupt.closure = client->iso_closure; 1007 e->interrupt.completed = fw_iso_buffer_lookup(&client->buffer, 1008 completed); 1009 queue_event(client, &e->event, &e->interrupt, 1010 sizeof(e->interrupt), NULL, 0); 1011 } 1012 1013 static enum dma_data_direction iso_dma_direction(struct fw_iso_context *context) 1014 { 1015 if (context->type == FW_ISO_CONTEXT_TRANSMIT) 1016 return DMA_TO_DEVICE; 1017 else 1018 return DMA_FROM_DEVICE; 1019 } 1020 1021 static struct fw_iso_context *fw_iso_mc_context_create(struct fw_card *card, 1022 fw_iso_mc_callback_t callback, 1023 void *callback_data) 1024 { 1025 struct fw_iso_context *ctx; 1026 1027 ctx = fw_iso_context_create(card, FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL, 1028 0, 0, 0, NULL, callback_data); 1029 if (!IS_ERR(ctx)) 1030 ctx->callback.mc = callback; 1031 1032 return ctx; 1033 } 1034 1035 static int ioctl_create_iso_context(struct client *client, union ioctl_arg *arg) 1036 { 1037 struct fw_cdev_create_iso_context *a = &arg->create_iso_context; 1038 struct fw_iso_context *context; 1039 union fw_iso_callback cb; 1040 int ret; 1041 1042 BUILD_BUG_ON(FW_CDEV_ISO_CONTEXT_TRANSMIT != FW_ISO_CONTEXT_TRANSMIT || 1043 FW_CDEV_ISO_CONTEXT_RECEIVE != FW_ISO_CONTEXT_RECEIVE || 1044 FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL != 1045 FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL); 1046 1047 switch (a->type) { 1048 case FW_ISO_CONTEXT_TRANSMIT: 1049 if (a->speed > SCODE_3200 || a->channel > 63) 1050 return -EINVAL; 1051 1052 cb.sc = iso_callback; 1053 break; 1054 1055 case FW_ISO_CONTEXT_RECEIVE: 1056 if (a->header_size < 4 || (a->header_size & 3) || 1057 a->channel > 63) 1058 return -EINVAL; 1059 1060 cb.sc = iso_callback; 1061 break; 1062 1063 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL: 1064 cb.mc = iso_mc_callback; 1065 break; 1066 1067 default: 1068 return -EINVAL; 1069 } 1070 1071 if (a->type == FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL) 1072 context = fw_iso_mc_context_create(client->device->card, cb.mc, 1073 client); 1074 else 1075 context = fw_iso_context_create(client->device->card, a->type, 1076 a->channel, a->speed, 1077 a->header_size, cb.sc, client); 1078 if (IS_ERR(context)) 1079 return PTR_ERR(context); 1080 if (client->version < FW_CDEV_VERSION_AUTO_FLUSH_ISO_OVERFLOW) 1081 context->drop_overflow_headers = true; 1082 1083 // We only support one context at this time. 1084 guard(spinlock_irq)(&client->lock); 1085 1086 if (client->iso_context != NULL) { 1087 fw_iso_context_destroy(context); 1088 1089 return -EBUSY; 1090 } 1091 if (!client->buffer_is_mapped) { 1092 ret = fw_iso_buffer_map_dma(&client->buffer, 1093 client->device->card, 1094 iso_dma_direction(context)); 1095 if (ret < 0) { 1096 fw_iso_context_destroy(context); 1097 1098 return ret; 1099 } 1100 client->buffer_is_mapped = true; 1101 } 1102 client->iso_closure = a->closure; 1103 client->iso_context = context; 1104 1105 a->handle = 0; 1106 1107 return 0; 1108 } 1109 1110 static int ioctl_set_iso_channels(struct client *client, union ioctl_arg *arg) 1111 { 1112 struct fw_cdev_set_iso_channels *a = &arg->set_iso_channels; 1113 struct fw_iso_context *ctx = client->iso_context; 1114 1115 if (ctx == NULL || a->handle != 0) 1116 return -EINVAL; 1117 1118 return fw_iso_context_set_channels(ctx, &a->channels); 1119 } 1120 1121 /* Macros for decoding the iso packet control header. */ 1122 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff) 1123 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01) 1124 #define GET_SKIP(v) (((v) >> 17) & 0x01) 1125 #define GET_TAG(v) (((v) >> 18) & 0x03) 1126 #define GET_SY(v) (((v) >> 20) & 0x0f) 1127 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff) 1128 1129 static int ioctl_queue_iso(struct client *client, union ioctl_arg *arg) 1130 { 1131 struct fw_cdev_queue_iso *a = &arg->queue_iso; 1132 struct fw_cdev_iso_packet __user *p, *end, *next; 1133 struct fw_iso_context *ctx = client->iso_context; 1134 unsigned long payload, buffer_end, transmit_header_bytes = 0; 1135 u32 control; 1136 int count; 1137 struct { 1138 struct fw_iso_packet packet; 1139 u8 header[256]; 1140 } u; 1141 1142 if (ctx == NULL || a->handle != 0) 1143 return -EINVAL; 1144 1145 /* 1146 * If the user passes a non-NULL data pointer, has mmap()'ed 1147 * the iso buffer, and the pointer points inside the buffer, 1148 * we setup the payload pointers accordingly. Otherwise we 1149 * set them both to 0, which will still let packets with 1150 * payload_length == 0 through. In other words, if no packets 1151 * use the indirect payload, the iso buffer need not be mapped 1152 * and the a->data pointer is ignored. 1153 */ 1154 payload = (unsigned long)a->data - client->vm_start; 1155 buffer_end = client->buffer.page_count << PAGE_SHIFT; 1156 if (a->data == 0 || client->buffer.pages == NULL || 1157 payload >= buffer_end) { 1158 payload = 0; 1159 buffer_end = 0; 1160 } 1161 1162 if (ctx->type == FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL && payload & 3) 1163 return -EINVAL; 1164 1165 p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(a->packets); 1166 1167 end = (void __user *)p + a->size; 1168 count = 0; 1169 while (p < end) { 1170 if (get_user(control, &p->control)) 1171 return -EFAULT; 1172 u.packet.payload_length = GET_PAYLOAD_LENGTH(control); 1173 u.packet.interrupt = GET_INTERRUPT(control); 1174 u.packet.skip = GET_SKIP(control); 1175 u.packet.tag = GET_TAG(control); 1176 u.packet.sy = GET_SY(control); 1177 u.packet.header_length = GET_HEADER_LENGTH(control); 1178 1179 switch (ctx->type) { 1180 case FW_ISO_CONTEXT_TRANSMIT: 1181 if (u.packet.header_length & 3) 1182 return -EINVAL; 1183 transmit_header_bytes = u.packet.header_length; 1184 break; 1185 1186 case FW_ISO_CONTEXT_RECEIVE: 1187 if (u.packet.header_length == 0 || 1188 u.packet.header_length % ctx->header_size != 0) 1189 return -EINVAL; 1190 break; 1191 1192 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL: 1193 if (u.packet.payload_length == 0 || 1194 u.packet.payload_length & 3) 1195 return -EINVAL; 1196 break; 1197 } 1198 1199 next = (struct fw_cdev_iso_packet __user *) 1200 &p->header[transmit_header_bytes / 4]; 1201 if (next > end) 1202 return -EINVAL; 1203 if (copy_from_user 1204 (u.packet.header, p->header, transmit_header_bytes)) 1205 return -EFAULT; 1206 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT && 1207 u.packet.header_length + u.packet.payload_length > 0) 1208 return -EINVAL; 1209 if (payload + u.packet.payload_length > buffer_end) 1210 return -EINVAL; 1211 1212 if (fw_iso_context_queue(ctx, &u.packet, 1213 &client->buffer, payload)) 1214 break; 1215 1216 p = next; 1217 payload += u.packet.payload_length; 1218 count++; 1219 } 1220 fw_iso_context_queue_flush(ctx); 1221 1222 a->size -= uptr_to_u64(p) - a->packets; 1223 a->packets = uptr_to_u64(p); 1224 a->data = client->vm_start + payload; 1225 1226 return count; 1227 } 1228 1229 static int ioctl_start_iso(struct client *client, union ioctl_arg *arg) 1230 { 1231 struct fw_cdev_start_iso *a = &arg->start_iso; 1232 1233 BUILD_BUG_ON( 1234 FW_CDEV_ISO_CONTEXT_MATCH_TAG0 != FW_ISO_CONTEXT_MATCH_TAG0 || 1235 FW_CDEV_ISO_CONTEXT_MATCH_TAG1 != FW_ISO_CONTEXT_MATCH_TAG1 || 1236 FW_CDEV_ISO_CONTEXT_MATCH_TAG2 != FW_ISO_CONTEXT_MATCH_TAG2 || 1237 FW_CDEV_ISO_CONTEXT_MATCH_TAG3 != FW_ISO_CONTEXT_MATCH_TAG3 || 1238 FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS != FW_ISO_CONTEXT_MATCH_ALL_TAGS); 1239 1240 if (client->iso_context == NULL || a->handle != 0) 1241 return -EINVAL; 1242 1243 if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE && 1244 (a->tags == 0 || a->tags > 15 || a->sync > 15)) 1245 return -EINVAL; 1246 1247 return fw_iso_context_start(client->iso_context, 1248 a->cycle, a->sync, a->tags); 1249 } 1250 1251 static int ioctl_stop_iso(struct client *client, union ioctl_arg *arg) 1252 { 1253 struct fw_cdev_stop_iso *a = &arg->stop_iso; 1254 1255 if (client->iso_context == NULL || a->handle != 0) 1256 return -EINVAL; 1257 1258 return fw_iso_context_stop(client->iso_context); 1259 } 1260 1261 static int ioctl_flush_iso(struct client *client, union ioctl_arg *arg) 1262 { 1263 struct fw_cdev_flush_iso *a = &arg->flush_iso; 1264 1265 if (client->iso_context == NULL || a->handle != 0) 1266 return -EINVAL; 1267 1268 return fw_iso_context_flush_completions(client->iso_context); 1269 } 1270 1271 static int ioctl_get_cycle_timer2(struct client *client, union ioctl_arg *arg) 1272 { 1273 struct fw_cdev_get_cycle_timer2 *a = &arg->get_cycle_timer2; 1274 struct fw_card *card = client->device->card; 1275 struct timespec64 ts = {0, 0}; 1276 u32 cycle_time = 0; 1277 int ret; 1278 1279 guard(irq)(); 1280 1281 ret = fw_card_read_cycle_time(card, &cycle_time); 1282 if (ret < 0) 1283 return ret; 1284 1285 switch (a->clk_id) { 1286 case CLOCK_REALTIME: ktime_get_real_ts64(&ts); break; 1287 case CLOCK_MONOTONIC: ktime_get_ts64(&ts); break; 1288 case CLOCK_MONOTONIC_RAW: ktime_get_raw_ts64(&ts); break; 1289 default: 1290 return -EINVAL; 1291 } 1292 1293 a->tv_sec = ts.tv_sec; 1294 a->tv_nsec = ts.tv_nsec; 1295 a->cycle_timer = cycle_time; 1296 1297 return 0; 1298 } 1299 1300 static int ioctl_get_cycle_timer(struct client *client, union ioctl_arg *arg) 1301 { 1302 struct fw_cdev_get_cycle_timer *a = &arg->get_cycle_timer; 1303 struct fw_cdev_get_cycle_timer2 ct2; 1304 1305 ct2.clk_id = CLOCK_REALTIME; 1306 ioctl_get_cycle_timer2(client, (union ioctl_arg *)&ct2); 1307 1308 a->local_time = ct2.tv_sec * USEC_PER_SEC + ct2.tv_nsec / NSEC_PER_USEC; 1309 a->cycle_timer = ct2.cycle_timer; 1310 1311 return 0; 1312 } 1313 1314 static void iso_resource_work(struct work_struct *work) 1315 { 1316 struct iso_resource_event *e; 1317 struct iso_resource *r = 1318 container_of(work, struct iso_resource, work.work); 1319 struct client *client = r->client; 1320 int generation, channel, bandwidth, todo; 1321 bool skip, free, success; 1322 1323 scoped_guard(spinlock_irq, &client->lock) { 1324 generation = client->device->generation; 1325 todo = r->todo; 1326 // Allow 1000ms grace period for other reallocations. 1327 if (todo == ISO_RES_ALLOC && 1328 time_before64(get_jiffies_64(), client->device->card->reset_jiffies + HZ)) { 1329 schedule_iso_resource(r, DIV_ROUND_UP(HZ, 3)); 1330 skip = true; 1331 } else { 1332 // We could be called twice within the same generation. 1333 skip = todo == ISO_RES_REALLOC && 1334 r->generation == generation; 1335 } 1336 free = todo == ISO_RES_DEALLOC || 1337 todo == ISO_RES_ALLOC_ONCE || 1338 todo == ISO_RES_DEALLOC_ONCE; 1339 r->generation = generation; 1340 } 1341 1342 if (skip) 1343 goto out; 1344 1345 bandwidth = r->bandwidth; 1346 1347 fw_iso_resource_manage(client->device->card, generation, 1348 r->channels, &channel, &bandwidth, 1349 todo == ISO_RES_ALLOC || 1350 todo == ISO_RES_REALLOC || 1351 todo == ISO_RES_ALLOC_ONCE); 1352 /* 1353 * Is this generation outdated already? As long as this resource sticks 1354 * in the idr, it will be scheduled again for a newer generation or at 1355 * shutdown. 1356 */ 1357 if (channel == -EAGAIN && 1358 (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC)) 1359 goto out; 1360 1361 success = channel >= 0 || bandwidth > 0; 1362 1363 scoped_guard(spinlock_irq, &client->lock) { 1364 // Transit from allocation to reallocation, except if the client 1365 // requested deallocation in the meantime. 1366 if (r->todo == ISO_RES_ALLOC) 1367 r->todo = ISO_RES_REALLOC; 1368 // Allocation or reallocation failure? Pull this resource out of the 1369 // idr and prepare for deletion, unless the client is shutting down. 1370 if (r->todo == ISO_RES_REALLOC && !success && 1371 !client->in_shutdown && 1372 idr_remove(&client->resource_idr, r->resource.handle)) { 1373 client_put(client); 1374 free = true; 1375 } 1376 } 1377 1378 if (todo == ISO_RES_ALLOC && channel >= 0) 1379 r->channels = 1ULL << channel; 1380 1381 if (todo == ISO_RES_REALLOC && success) 1382 goto out; 1383 1384 if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) { 1385 e = r->e_alloc; 1386 r->e_alloc = NULL; 1387 } else { 1388 e = r->e_dealloc; 1389 r->e_dealloc = NULL; 1390 } 1391 e->iso_resource.handle = r->resource.handle; 1392 e->iso_resource.channel = channel; 1393 e->iso_resource.bandwidth = bandwidth; 1394 1395 queue_event(client, &e->event, 1396 &e->iso_resource, sizeof(e->iso_resource), NULL, 0); 1397 1398 if (free) { 1399 cancel_delayed_work(&r->work); 1400 kfree(r->e_alloc); 1401 kfree(r->e_dealloc); 1402 kfree(r); 1403 } 1404 out: 1405 client_put(client); 1406 } 1407 1408 static void release_iso_resource(struct client *client, 1409 struct client_resource *resource) 1410 { 1411 struct iso_resource *r = to_iso_resource(resource); 1412 1413 guard(spinlock_irq)(&client->lock); 1414 1415 r->todo = ISO_RES_DEALLOC; 1416 schedule_iso_resource(r, 0); 1417 } 1418 1419 static int init_iso_resource(struct client *client, 1420 struct fw_cdev_allocate_iso_resource *request, int todo) 1421 { 1422 struct iso_resource_event *e1, *e2; 1423 struct iso_resource *r; 1424 int ret; 1425 1426 if ((request->channels == 0 && request->bandwidth == 0) || 1427 request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL) 1428 return -EINVAL; 1429 1430 r = kmalloc(sizeof(*r), GFP_KERNEL); 1431 e1 = kmalloc(sizeof(*e1), GFP_KERNEL); 1432 e2 = kmalloc(sizeof(*e2), GFP_KERNEL); 1433 if (r == NULL || e1 == NULL || e2 == NULL) { 1434 ret = -ENOMEM; 1435 goto fail; 1436 } 1437 1438 INIT_DELAYED_WORK(&r->work, iso_resource_work); 1439 r->client = client; 1440 r->todo = todo; 1441 r->generation = -1; 1442 r->channels = request->channels; 1443 r->bandwidth = request->bandwidth; 1444 r->e_alloc = e1; 1445 r->e_dealloc = e2; 1446 1447 e1->iso_resource.closure = request->closure; 1448 e1->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED; 1449 e2->iso_resource.closure = request->closure; 1450 e2->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED; 1451 1452 if (todo == ISO_RES_ALLOC) { 1453 r->resource.release = release_iso_resource; 1454 ret = add_client_resource(client, &r->resource, GFP_KERNEL); 1455 if (ret < 0) 1456 goto fail; 1457 } else { 1458 r->resource.release = NULL; 1459 r->resource.handle = -1; 1460 schedule_iso_resource(r, 0); 1461 } 1462 request->handle = r->resource.handle; 1463 1464 return 0; 1465 fail: 1466 kfree(r); 1467 kfree(e1); 1468 kfree(e2); 1469 1470 return ret; 1471 } 1472 1473 static int ioctl_allocate_iso_resource(struct client *client, 1474 union ioctl_arg *arg) 1475 { 1476 return init_iso_resource(client, 1477 &arg->allocate_iso_resource, ISO_RES_ALLOC); 1478 } 1479 1480 static int ioctl_deallocate_iso_resource(struct client *client, 1481 union ioctl_arg *arg) 1482 { 1483 return release_client_resource(client, 1484 arg->deallocate.handle, release_iso_resource, NULL); 1485 } 1486 1487 static int ioctl_allocate_iso_resource_once(struct client *client, 1488 union ioctl_arg *arg) 1489 { 1490 return init_iso_resource(client, 1491 &arg->allocate_iso_resource, ISO_RES_ALLOC_ONCE); 1492 } 1493 1494 static int ioctl_deallocate_iso_resource_once(struct client *client, 1495 union ioctl_arg *arg) 1496 { 1497 return init_iso_resource(client, 1498 &arg->allocate_iso_resource, ISO_RES_DEALLOC_ONCE); 1499 } 1500 1501 /* 1502 * Returns a speed code: Maximum speed to or from this device, 1503 * limited by the device's link speed, the local node's link speed, 1504 * and all PHY port speeds between the two links. 1505 */ 1506 static int ioctl_get_speed(struct client *client, union ioctl_arg *arg) 1507 { 1508 return client->device->max_speed; 1509 } 1510 1511 static int ioctl_send_broadcast_request(struct client *client, 1512 union ioctl_arg *arg) 1513 { 1514 struct fw_cdev_send_request *a = &arg->send_request; 1515 1516 switch (a->tcode) { 1517 case TCODE_WRITE_QUADLET_REQUEST: 1518 case TCODE_WRITE_BLOCK_REQUEST: 1519 break; 1520 default: 1521 return -EINVAL; 1522 } 1523 1524 /* Security policy: Only allow accesses to Units Space. */ 1525 if (a->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END) 1526 return -EACCES; 1527 1528 return init_request(client, a, LOCAL_BUS | 0x3f, SCODE_100); 1529 } 1530 1531 static int ioctl_send_stream_packet(struct client *client, union ioctl_arg *arg) 1532 { 1533 struct fw_cdev_send_stream_packet *a = &arg->send_stream_packet; 1534 struct fw_cdev_send_request request; 1535 int dest; 1536 1537 if (a->speed > client->device->card->link_speed || 1538 a->length > 1024 << a->speed) 1539 return -EIO; 1540 1541 if (a->tag > 3 || a->channel > 63 || a->sy > 15) 1542 return -EINVAL; 1543 1544 dest = fw_stream_packet_destination_id(a->tag, a->channel, a->sy); 1545 request.tcode = TCODE_STREAM_DATA; 1546 request.length = a->length; 1547 request.closure = a->closure; 1548 request.data = a->data; 1549 request.generation = a->generation; 1550 1551 return init_request(client, &request, dest, a->speed); 1552 } 1553 1554 static void outbound_phy_packet_callback(struct fw_packet *packet, 1555 struct fw_card *card, int status) 1556 { 1557 struct outbound_phy_packet_event *e = 1558 container_of(packet, struct outbound_phy_packet_event, p); 1559 struct client *e_client = e->client; 1560 u32 rcode; 1561 1562 trace_async_phy_outbound_complete((uintptr_t)packet, card->index, status, packet->generation, 1563 packet->timestamp); 1564 1565 switch (status) { 1566 // expected: 1567 case ACK_COMPLETE: 1568 rcode = RCODE_COMPLETE; 1569 break; 1570 // should never happen with PHY packets: 1571 case ACK_PENDING: 1572 rcode = RCODE_COMPLETE; 1573 break; 1574 case ACK_BUSY_X: 1575 case ACK_BUSY_A: 1576 case ACK_BUSY_B: 1577 rcode = RCODE_BUSY; 1578 break; 1579 case ACK_DATA_ERROR: 1580 rcode = RCODE_DATA_ERROR; 1581 break; 1582 case ACK_TYPE_ERROR: 1583 rcode = RCODE_TYPE_ERROR; 1584 break; 1585 // stale generation; cancelled; on certain controllers: no ack 1586 default: 1587 rcode = status; 1588 break; 1589 } 1590 1591 switch (e->phy_packet.without_tstamp.type) { 1592 case FW_CDEV_EVENT_PHY_PACKET_SENT: 1593 { 1594 struct fw_cdev_event_phy_packet *pp = &e->phy_packet.without_tstamp; 1595 1596 pp->rcode = rcode; 1597 pp->data[0] = packet->timestamp; 1598 queue_event(e->client, &e->event, &e->phy_packet, sizeof(*pp) + pp->length, 1599 NULL, 0); 1600 break; 1601 } 1602 case FW_CDEV_EVENT_PHY_PACKET_SENT2: 1603 { 1604 struct fw_cdev_event_phy_packet2 *pp = &e->phy_packet.with_tstamp; 1605 1606 pp->rcode = rcode; 1607 pp->tstamp = packet->timestamp; 1608 queue_event(e->client, &e->event, &e->phy_packet, sizeof(*pp) + pp->length, 1609 NULL, 0); 1610 break; 1611 } 1612 default: 1613 WARN_ON(1); 1614 break; 1615 } 1616 1617 client_put(e_client); 1618 } 1619 1620 static int ioctl_send_phy_packet(struct client *client, union ioctl_arg *arg) 1621 { 1622 struct fw_cdev_send_phy_packet *a = &arg->send_phy_packet; 1623 struct fw_card *card = client->device->card; 1624 struct outbound_phy_packet_event *e; 1625 1626 /* Access policy: Allow this ioctl only on local nodes' device files. */ 1627 if (!client->device->is_local) 1628 return -ENOSYS; 1629 1630 e = kzalloc(sizeof(*e) + sizeof(a->data), GFP_KERNEL); 1631 if (e == NULL) 1632 return -ENOMEM; 1633 1634 client_get(client); 1635 e->client = client; 1636 e->p.speed = SCODE_100; 1637 e->p.generation = a->generation; 1638 async_header_set_tcode(e->p.header, TCODE_LINK_INTERNAL); 1639 e->p.header[1] = a->data[0]; 1640 e->p.header[2] = a->data[1]; 1641 e->p.header_length = 12; 1642 e->p.callback = outbound_phy_packet_callback; 1643 1644 if (client->version < FW_CDEV_VERSION_EVENT_ASYNC_TSTAMP) { 1645 struct fw_cdev_event_phy_packet *pp = &e->phy_packet.without_tstamp; 1646 1647 pp->closure = a->closure; 1648 pp->type = FW_CDEV_EVENT_PHY_PACKET_SENT; 1649 if (is_ping_packet(a->data)) 1650 pp->length = 4; 1651 } else { 1652 struct fw_cdev_event_phy_packet2 *pp = &e->phy_packet.with_tstamp; 1653 1654 pp->closure = a->closure; 1655 pp->type = FW_CDEV_EVENT_PHY_PACKET_SENT2; 1656 // Keep the data field so that application can match the response event to the 1657 // request. 1658 pp->length = sizeof(a->data); 1659 memcpy(pp->data, a->data, sizeof(a->data)); 1660 } 1661 1662 trace_async_phy_outbound_initiate((uintptr_t)&e->p, card->index, e->p.generation, 1663 e->p.header[1], e->p.header[2]); 1664 1665 card->driver->send_request(card, &e->p); 1666 1667 return 0; 1668 } 1669 1670 static int ioctl_receive_phy_packets(struct client *client, union ioctl_arg *arg) 1671 { 1672 struct fw_cdev_receive_phy_packets *a = &arg->receive_phy_packets; 1673 struct fw_card *card = client->device->card; 1674 1675 /* Access policy: Allow this ioctl only on local nodes' device files. */ 1676 if (!client->device->is_local) 1677 return -ENOSYS; 1678 1679 guard(spinlock_irq)(&card->lock); 1680 1681 list_move_tail(&client->phy_receiver_link, &card->phy_receiver_list); 1682 client->phy_receiver_closure = a->closure; 1683 1684 return 0; 1685 } 1686 1687 void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p) 1688 { 1689 struct client *client; 1690 1691 guard(spinlock_irqsave)(&card->lock); 1692 1693 list_for_each_entry(client, &card->phy_receiver_list, phy_receiver_link) { 1694 struct inbound_phy_packet_event *e = kmalloc(sizeof(*e) + 8, GFP_ATOMIC); 1695 if (e == NULL) 1696 break; 1697 1698 if (client->version < FW_CDEV_VERSION_EVENT_ASYNC_TSTAMP) { 1699 struct fw_cdev_event_phy_packet *pp = &e->phy_packet.without_tstamp; 1700 1701 pp->closure = client->phy_receiver_closure; 1702 pp->type = FW_CDEV_EVENT_PHY_PACKET_RECEIVED; 1703 pp->rcode = RCODE_COMPLETE; 1704 pp->length = 8; 1705 pp->data[0] = p->header[1]; 1706 pp->data[1] = p->header[2]; 1707 queue_event(client, &e->event, &e->phy_packet, sizeof(*pp) + 8, NULL, 0); 1708 } else { 1709 struct fw_cdev_event_phy_packet2 *pp = &e->phy_packet.with_tstamp; 1710 1711 pp = &e->phy_packet.with_tstamp; 1712 pp->closure = client->phy_receiver_closure; 1713 pp->type = FW_CDEV_EVENT_PHY_PACKET_RECEIVED2; 1714 pp->rcode = RCODE_COMPLETE; 1715 pp->length = 8; 1716 pp->tstamp = p->timestamp; 1717 pp->data[0] = p->header[1]; 1718 pp->data[1] = p->header[2]; 1719 queue_event(client, &e->event, &e->phy_packet, sizeof(*pp) + 8, NULL, 0); 1720 } 1721 } 1722 } 1723 1724 static int (* const ioctl_handlers[])(struct client *, union ioctl_arg *) = { 1725 [0x00] = ioctl_get_info, 1726 [0x01] = ioctl_send_request, 1727 [0x02] = ioctl_allocate, 1728 [0x03] = ioctl_deallocate, 1729 [0x04] = ioctl_send_response, 1730 [0x05] = ioctl_initiate_bus_reset, 1731 [0x06] = ioctl_add_descriptor, 1732 [0x07] = ioctl_remove_descriptor, 1733 [0x08] = ioctl_create_iso_context, 1734 [0x09] = ioctl_queue_iso, 1735 [0x0a] = ioctl_start_iso, 1736 [0x0b] = ioctl_stop_iso, 1737 [0x0c] = ioctl_get_cycle_timer, 1738 [0x0d] = ioctl_allocate_iso_resource, 1739 [0x0e] = ioctl_deallocate_iso_resource, 1740 [0x0f] = ioctl_allocate_iso_resource_once, 1741 [0x10] = ioctl_deallocate_iso_resource_once, 1742 [0x11] = ioctl_get_speed, 1743 [0x12] = ioctl_send_broadcast_request, 1744 [0x13] = ioctl_send_stream_packet, 1745 [0x14] = ioctl_get_cycle_timer2, 1746 [0x15] = ioctl_send_phy_packet, 1747 [0x16] = ioctl_receive_phy_packets, 1748 [0x17] = ioctl_set_iso_channels, 1749 [0x18] = ioctl_flush_iso, 1750 }; 1751 1752 static int dispatch_ioctl(struct client *client, 1753 unsigned int cmd, void __user *arg) 1754 { 1755 union ioctl_arg buffer; 1756 int ret; 1757 1758 if (fw_device_is_shutdown(client->device)) 1759 return -ENODEV; 1760 1761 if (_IOC_TYPE(cmd) != '#' || 1762 _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers) || 1763 _IOC_SIZE(cmd) > sizeof(buffer)) 1764 return -ENOTTY; 1765 1766 memset(&buffer, 0, sizeof(buffer)); 1767 1768 if (_IOC_DIR(cmd) & _IOC_WRITE) 1769 if (copy_from_user(&buffer, arg, _IOC_SIZE(cmd))) 1770 return -EFAULT; 1771 1772 ret = ioctl_handlers[_IOC_NR(cmd)](client, &buffer); 1773 if (ret < 0) 1774 return ret; 1775 1776 if (_IOC_DIR(cmd) & _IOC_READ) 1777 if (copy_to_user(arg, &buffer, _IOC_SIZE(cmd))) 1778 return -EFAULT; 1779 1780 return ret; 1781 } 1782 1783 static long fw_device_op_ioctl(struct file *file, 1784 unsigned int cmd, unsigned long arg) 1785 { 1786 return dispatch_ioctl(file->private_data, cmd, (void __user *)arg); 1787 } 1788 1789 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma) 1790 { 1791 struct client *client = file->private_data; 1792 unsigned long size; 1793 int page_count, ret; 1794 1795 if (fw_device_is_shutdown(client->device)) 1796 return -ENODEV; 1797 1798 /* FIXME: We could support multiple buffers, but we don't. */ 1799 if (client->buffer.pages != NULL) 1800 return -EBUSY; 1801 1802 if (!(vma->vm_flags & VM_SHARED)) 1803 return -EINVAL; 1804 1805 if (vma->vm_start & ~PAGE_MASK) 1806 return -EINVAL; 1807 1808 client->vm_start = vma->vm_start; 1809 size = vma->vm_end - vma->vm_start; 1810 page_count = size >> PAGE_SHIFT; 1811 if (size & ~PAGE_MASK) 1812 return -EINVAL; 1813 1814 ret = fw_iso_buffer_alloc(&client->buffer, page_count); 1815 if (ret < 0) 1816 return ret; 1817 1818 scoped_guard(spinlock_irq, &client->lock) { 1819 if (client->iso_context) { 1820 ret = fw_iso_buffer_map_dma(&client->buffer, client->device->card, 1821 iso_dma_direction(client->iso_context)); 1822 if (ret < 0) 1823 goto fail; 1824 client->buffer_is_mapped = true; 1825 } 1826 } 1827 1828 ret = vm_map_pages_zero(vma, client->buffer.pages, 1829 client->buffer.page_count); 1830 if (ret < 0) 1831 goto fail; 1832 1833 return 0; 1834 fail: 1835 fw_iso_buffer_destroy(&client->buffer, client->device->card); 1836 return ret; 1837 } 1838 1839 static bool has_outbound_transactions(struct client *client) 1840 { 1841 struct client_resource *resource; 1842 int id; 1843 1844 guard(spinlock_irq)(&client->lock); 1845 1846 idr_for_each_entry(&client->resource_idr, resource, id) { 1847 if (is_outbound_transaction_resource(resource)) 1848 return true; 1849 } 1850 1851 return false; 1852 } 1853 1854 static int fw_device_op_release(struct inode *inode, struct file *file) 1855 { 1856 struct client *client = file->private_data; 1857 struct event *event, *next_event; 1858 struct client_resource *resource; 1859 int id; 1860 1861 scoped_guard(spinlock_irq, &client->device->card->lock) 1862 list_del(&client->phy_receiver_link); 1863 1864 scoped_guard(mutex, &client->device->client_list_mutex) 1865 list_del(&client->link); 1866 1867 if (client->iso_context) 1868 fw_iso_context_destroy(client->iso_context); 1869 1870 if (client->buffer.pages) 1871 fw_iso_buffer_destroy(&client->buffer, client->device->card); 1872 1873 /* Freeze client->resource_idr and client->event_list */ 1874 scoped_guard(spinlock_irq, &client->lock) 1875 client->in_shutdown = true; 1876 1877 wait_event(client->tx_flush_wait, !has_outbound_transactions(client)); 1878 1879 idr_for_each_entry(&client->resource_idr, resource, id) { 1880 resource->release(client, resource); 1881 client_put(client); 1882 } 1883 idr_destroy(&client->resource_idr); 1884 1885 list_for_each_entry_safe(event, next_event, &client->event_list, link) 1886 kfree(event); 1887 1888 client_put(client); 1889 1890 return 0; 1891 } 1892 1893 static __poll_t fw_device_op_poll(struct file *file, poll_table * pt) 1894 { 1895 struct client *client = file->private_data; 1896 __poll_t mask = 0; 1897 1898 poll_wait(file, &client->wait, pt); 1899 1900 if (fw_device_is_shutdown(client->device)) 1901 mask |= EPOLLHUP | EPOLLERR; 1902 if (!list_empty(&client->event_list)) 1903 mask |= EPOLLIN | EPOLLRDNORM; 1904 1905 return mask; 1906 } 1907 1908 const struct file_operations fw_device_ops = { 1909 .owner = THIS_MODULE, 1910 .llseek = no_llseek, 1911 .open = fw_device_op_open, 1912 .read = fw_device_op_read, 1913 .unlocked_ioctl = fw_device_op_ioctl, 1914 .mmap = fw_device_op_mmap, 1915 .release = fw_device_op_release, 1916 .poll = fw_device_op_poll, 1917 .compat_ioctl = compat_ptr_ioctl, 1918 }; 1919