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