1 /* 2 * Char device for device raw access 3 * 4 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net> 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software Foundation, 18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 19 */ 20 21 #include <linux/compat.h> 22 #include <linux/delay.h> 23 #include <linux/device.h> 24 #include <linux/errno.h> 25 #include <linux/firewire.h> 26 #include <linux/firewire-cdev.h> 27 #include <linux/idr.h> 28 #include <linux/jiffies.h> 29 #include <linux/kernel.h> 30 #include <linux/kref.h> 31 #include <linux/mm.h> 32 #include <linux/module.h> 33 #include <linux/mutex.h> 34 #include <linux/poll.h> 35 #include <linux/preempt.h> 36 #include <linux/sched.h> 37 #include <linux/spinlock.h> 38 #include <linux/time.h> 39 #include <linux/uaccess.h> 40 #include <linux/vmalloc.h> 41 #include <linux/wait.h> 42 #include <linux/workqueue.h> 43 44 #include <asm/system.h> 45 46 #include "core.h" 47 48 struct client { 49 u32 version; 50 struct fw_device *device; 51 52 spinlock_t lock; 53 bool in_shutdown; 54 struct idr resource_idr; 55 struct list_head event_list; 56 wait_queue_head_t wait; 57 u64 bus_reset_closure; 58 59 struct fw_iso_context *iso_context; 60 u64 iso_closure; 61 struct fw_iso_buffer buffer; 62 unsigned long vm_start; 63 64 struct list_head link; 65 struct kref kref; 66 }; 67 68 static inline void client_get(struct client *client) 69 { 70 kref_get(&client->kref); 71 } 72 73 static void client_release(struct kref *kref) 74 { 75 struct client *client = container_of(kref, struct client, kref); 76 77 fw_device_put(client->device); 78 kfree(client); 79 } 80 81 static void client_put(struct client *client) 82 { 83 kref_put(&client->kref, client_release); 84 } 85 86 struct client_resource; 87 typedef void (*client_resource_release_fn_t)(struct client *, 88 struct client_resource *); 89 struct client_resource { 90 client_resource_release_fn_t release; 91 int handle; 92 }; 93 94 struct address_handler_resource { 95 struct client_resource resource; 96 struct fw_address_handler handler; 97 __u64 closure; 98 struct client *client; 99 }; 100 101 struct outbound_transaction_resource { 102 struct client_resource resource; 103 struct fw_transaction transaction; 104 }; 105 106 struct inbound_transaction_resource { 107 struct client_resource resource; 108 struct fw_request *request; 109 void *data; 110 size_t length; 111 }; 112 113 struct descriptor_resource { 114 struct client_resource resource; 115 struct fw_descriptor descriptor; 116 u32 data[0]; 117 }; 118 119 struct iso_resource { 120 struct client_resource resource; 121 struct client *client; 122 /* Schedule work and access todo only with client->lock held. */ 123 struct delayed_work work; 124 enum {ISO_RES_ALLOC, ISO_RES_REALLOC, ISO_RES_DEALLOC, 125 ISO_RES_ALLOC_ONCE, ISO_RES_DEALLOC_ONCE,} todo; 126 int generation; 127 u64 channels; 128 s32 bandwidth; 129 __be32 transaction_data[2]; 130 struct iso_resource_event *e_alloc, *e_dealloc; 131 }; 132 133 static void release_iso_resource(struct client *, struct client_resource *); 134 135 static void schedule_iso_resource(struct iso_resource *r, unsigned long delay) 136 { 137 client_get(r->client); 138 if (!schedule_delayed_work(&r->work, delay)) 139 client_put(r->client); 140 } 141 142 static void schedule_if_iso_resource(struct client_resource *resource) 143 { 144 if (resource->release == release_iso_resource) 145 schedule_iso_resource(container_of(resource, 146 struct iso_resource, resource), 0); 147 } 148 149 /* 150 * dequeue_event() just kfree()'s the event, so the event has to be 151 * the first field in a struct XYZ_event. 152 */ 153 struct event { 154 struct { void *data; size_t size; } v[2]; 155 struct list_head link; 156 }; 157 158 struct bus_reset_event { 159 struct event event; 160 struct fw_cdev_event_bus_reset reset; 161 }; 162 163 struct outbound_transaction_event { 164 struct event event; 165 struct client *client; 166 struct outbound_transaction_resource r; 167 struct fw_cdev_event_response response; 168 }; 169 170 struct inbound_transaction_event { 171 struct event event; 172 struct fw_cdev_event_request request; 173 }; 174 175 struct iso_interrupt_event { 176 struct event event; 177 struct fw_cdev_event_iso_interrupt interrupt; 178 }; 179 180 struct iso_resource_event { 181 struct event event; 182 struct fw_cdev_event_iso_resource iso_resource; 183 }; 184 185 static inline void __user *u64_to_uptr(__u64 value) 186 { 187 return (void __user *)(unsigned long)value; 188 } 189 190 static inline __u64 uptr_to_u64(void __user *ptr) 191 { 192 return (__u64)(unsigned long)ptr; 193 } 194 195 static int fw_device_op_open(struct inode *inode, struct file *file) 196 { 197 struct fw_device *device; 198 struct client *client; 199 200 device = fw_device_get_by_devt(inode->i_rdev); 201 if (device == NULL) 202 return -ENODEV; 203 204 if (fw_device_is_shutdown(device)) { 205 fw_device_put(device); 206 return -ENODEV; 207 } 208 209 client = kzalloc(sizeof(*client), GFP_KERNEL); 210 if (client == NULL) { 211 fw_device_put(device); 212 return -ENOMEM; 213 } 214 215 client->device = device; 216 spin_lock_init(&client->lock); 217 idr_init(&client->resource_idr); 218 INIT_LIST_HEAD(&client->event_list); 219 init_waitqueue_head(&client->wait); 220 kref_init(&client->kref); 221 222 file->private_data = client; 223 224 mutex_lock(&device->client_list_mutex); 225 list_add_tail(&client->link, &device->client_list); 226 mutex_unlock(&device->client_list_mutex); 227 228 return 0; 229 } 230 231 static void queue_event(struct client *client, struct event *event, 232 void *data0, size_t size0, void *data1, size_t size1) 233 { 234 unsigned long flags; 235 236 event->v[0].data = data0; 237 event->v[0].size = size0; 238 event->v[1].data = data1; 239 event->v[1].size = size1; 240 241 spin_lock_irqsave(&client->lock, flags); 242 if (client->in_shutdown) 243 kfree(event); 244 else 245 list_add_tail(&event->link, &client->event_list); 246 spin_unlock_irqrestore(&client->lock, flags); 247 248 wake_up_interruptible(&client->wait); 249 } 250 251 static int dequeue_event(struct client *client, 252 char __user *buffer, size_t count) 253 { 254 struct event *event; 255 size_t size, total; 256 int i, ret; 257 258 ret = wait_event_interruptible(client->wait, 259 !list_empty(&client->event_list) || 260 fw_device_is_shutdown(client->device)); 261 if (ret < 0) 262 return ret; 263 264 if (list_empty(&client->event_list) && 265 fw_device_is_shutdown(client->device)) 266 return -ENODEV; 267 268 spin_lock_irq(&client->lock); 269 event = list_first_entry(&client->event_list, struct event, link); 270 list_del(&event->link); 271 spin_unlock_irq(&client->lock); 272 273 total = 0; 274 for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) { 275 size = min(event->v[i].size, count - total); 276 if (copy_to_user(buffer + total, event->v[i].data, size)) { 277 ret = -EFAULT; 278 goto out; 279 } 280 total += size; 281 } 282 ret = total; 283 284 out: 285 kfree(event); 286 287 return ret; 288 } 289 290 static ssize_t fw_device_op_read(struct file *file, char __user *buffer, 291 size_t count, loff_t *offset) 292 { 293 struct client *client = file->private_data; 294 295 return dequeue_event(client, buffer, count); 296 } 297 298 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset *event, 299 struct client *client) 300 { 301 struct fw_card *card = client->device->card; 302 303 spin_lock_irq(&card->lock); 304 305 event->closure = client->bus_reset_closure; 306 event->type = FW_CDEV_EVENT_BUS_RESET; 307 event->generation = client->device->generation; 308 event->node_id = client->device->node_id; 309 event->local_node_id = card->local_node->node_id; 310 event->bm_node_id = 0; /* FIXME: We don't track the BM. */ 311 event->irm_node_id = card->irm_node->node_id; 312 event->root_node_id = card->root_node->node_id; 313 314 spin_unlock_irq(&card->lock); 315 } 316 317 static void for_each_client(struct fw_device *device, 318 void (*callback)(struct client *client)) 319 { 320 struct client *c; 321 322 mutex_lock(&device->client_list_mutex); 323 list_for_each_entry(c, &device->client_list, link) 324 callback(c); 325 mutex_unlock(&device->client_list_mutex); 326 } 327 328 static int schedule_reallocations(int id, void *p, void *data) 329 { 330 schedule_if_iso_resource(p); 331 332 return 0; 333 } 334 335 static void queue_bus_reset_event(struct client *client) 336 { 337 struct bus_reset_event *e; 338 339 e = kzalloc(sizeof(*e), GFP_KERNEL); 340 if (e == NULL) { 341 fw_notify("Out of memory when allocating bus reset event\n"); 342 return; 343 } 344 345 fill_bus_reset_event(&e->reset, client); 346 347 queue_event(client, &e->event, 348 &e->reset, sizeof(e->reset), NULL, 0); 349 350 spin_lock_irq(&client->lock); 351 idr_for_each(&client->resource_idr, schedule_reallocations, client); 352 spin_unlock_irq(&client->lock); 353 } 354 355 void fw_device_cdev_update(struct fw_device *device) 356 { 357 for_each_client(device, queue_bus_reset_event); 358 } 359 360 static void wake_up_client(struct client *client) 361 { 362 wake_up_interruptible(&client->wait); 363 } 364 365 void fw_device_cdev_remove(struct fw_device *device) 366 { 367 for_each_client(device, wake_up_client); 368 } 369 370 static int ioctl_get_info(struct client *client, void *buffer) 371 { 372 struct fw_cdev_get_info *get_info = buffer; 373 struct fw_cdev_event_bus_reset bus_reset; 374 unsigned long ret = 0; 375 376 client->version = get_info->version; 377 get_info->version = FW_CDEV_VERSION; 378 get_info->card = client->device->card->index; 379 380 down_read(&fw_device_rwsem); 381 382 if (get_info->rom != 0) { 383 void __user *uptr = u64_to_uptr(get_info->rom); 384 size_t want = get_info->rom_length; 385 size_t have = client->device->config_rom_length * 4; 386 387 ret = copy_to_user(uptr, client->device->config_rom, 388 min(want, have)); 389 } 390 get_info->rom_length = client->device->config_rom_length * 4; 391 392 up_read(&fw_device_rwsem); 393 394 if (ret != 0) 395 return -EFAULT; 396 397 client->bus_reset_closure = get_info->bus_reset_closure; 398 if (get_info->bus_reset != 0) { 399 void __user *uptr = u64_to_uptr(get_info->bus_reset); 400 401 fill_bus_reset_event(&bus_reset, client); 402 if (copy_to_user(uptr, &bus_reset, sizeof(bus_reset))) 403 return -EFAULT; 404 } 405 406 return 0; 407 } 408 409 static int add_client_resource(struct client *client, 410 struct client_resource *resource, gfp_t gfp_mask) 411 { 412 unsigned long flags; 413 int ret; 414 415 retry: 416 if (idr_pre_get(&client->resource_idr, gfp_mask) == 0) 417 return -ENOMEM; 418 419 spin_lock_irqsave(&client->lock, flags); 420 if (client->in_shutdown) 421 ret = -ECANCELED; 422 else 423 ret = idr_get_new(&client->resource_idr, resource, 424 &resource->handle); 425 if (ret >= 0) { 426 client_get(client); 427 schedule_if_iso_resource(resource); 428 } 429 spin_unlock_irqrestore(&client->lock, flags); 430 431 if (ret == -EAGAIN) 432 goto retry; 433 434 return ret < 0 ? ret : 0; 435 } 436 437 static int release_client_resource(struct client *client, u32 handle, 438 client_resource_release_fn_t release, 439 struct client_resource **return_resource) 440 { 441 struct client_resource *resource; 442 443 spin_lock_irq(&client->lock); 444 if (client->in_shutdown) 445 resource = NULL; 446 else 447 resource = idr_find(&client->resource_idr, handle); 448 if (resource && resource->release == release) 449 idr_remove(&client->resource_idr, handle); 450 spin_unlock_irq(&client->lock); 451 452 if (!(resource && resource->release == release)) 453 return -EINVAL; 454 455 if (return_resource) 456 *return_resource = resource; 457 else 458 resource->release(client, resource); 459 460 client_put(client); 461 462 return 0; 463 } 464 465 static void release_transaction(struct client *client, 466 struct client_resource *resource) 467 { 468 struct outbound_transaction_resource *r = container_of(resource, 469 struct outbound_transaction_resource, resource); 470 471 fw_cancel_transaction(client->device->card, &r->transaction); 472 } 473 474 static void complete_transaction(struct fw_card *card, int rcode, 475 void *payload, size_t length, void *data) 476 { 477 struct outbound_transaction_event *e = data; 478 struct fw_cdev_event_response *rsp = &e->response; 479 struct client *client = e->client; 480 unsigned long flags; 481 482 if (length < rsp->length) 483 rsp->length = length; 484 if (rcode == RCODE_COMPLETE) 485 memcpy(rsp->data, payload, rsp->length); 486 487 spin_lock_irqsave(&client->lock, flags); 488 /* 489 * 1. If called while in shutdown, the idr tree must be left untouched. 490 * The idr handle will be removed and the client reference will be 491 * dropped later. 492 * 2. If the call chain was release_client_resource -> 493 * release_transaction -> complete_transaction (instead of a normal 494 * conclusion of the transaction), i.e. if this resource was already 495 * unregistered from the idr, the client reference will be dropped 496 * by release_client_resource and we must not drop it here. 497 */ 498 if (!client->in_shutdown && 499 idr_find(&client->resource_idr, e->r.resource.handle)) { 500 idr_remove(&client->resource_idr, e->r.resource.handle); 501 /* Drop the idr's reference */ 502 client_put(client); 503 } 504 spin_unlock_irqrestore(&client->lock, flags); 505 506 rsp->type = FW_CDEV_EVENT_RESPONSE; 507 rsp->rcode = rcode; 508 509 /* 510 * In the case that sizeof(*rsp) doesn't align with the position of the 511 * data, and the read is short, preserve an extra copy of the data 512 * to stay compatible with a pre-2.6.27 bug. Since the bug is harmless 513 * for short reads and some apps depended on it, this is both safe 514 * and prudent for compatibility. 515 */ 516 if (rsp->length <= sizeof(*rsp) - offsetof(typeof(*rsp), data)) 517 queue_event(client, &e->event, rsp, sizeof(*rsp), 518 rsp->data, rsp->length); 519 else 520 queue_event(client, &e->event, rsp, sizeof(*rsp) + rsp->length, 521 NULL, 0); 522 523 /* Drop the transaction callback's reference */ 524 client_put(client); 525 } 526 527 static int init_request(struct client *client, 528 struct fw_cdev_send_request *request, 529 int destination_id, int speed) 530 { 531 struct outbound_transaction_event *e; 532 int ret; 533 534 if (request->tcode != TCODE_STREAM_DATA && 535 (request->length > 4096 || request->length > 512 << speed)) 536 return -EIO; 537 538 e = kmalloc(sizeof(*e) + request->length, GFP_KERNEL); 539 if (e == NULL) 540 return -ENOMEM; 541 542 e->client = client; 543 e->response.length = request->length; 544 e->response.closure = request->closure; 545 546 if (request->data && 547 copy_from_user(e->response.data, 548 u64_to_uptr(request->data), request->length)) { 549 ret = -EFAULT; 550 goto failed; 551 } 552 553 e->r.resource.release = release_transaction; 554 ret = add_client_resource(client, &e->r.resource, GFP_KERNEL); 555 if (ret < 0) 556 goto failed; 557 558 /* Get a reference for the transaction callback */ 559 client_get(client); 560 561 fw_send_request(client->device->card, &e->r.transaction, 562 request->tcode, destination_id, request->generation, 563 speed, request->offset, e->response.data, 564 request->length, complete_transaction, e); 565 return 0; 566 567 failed: 568 kfree(e); 569 570 return ret; 571 } 572 573 static int ioctl_send_request(struct client *client, void *buffer) 574 { 575 struct fw_cdev_send_request *request = buffer; 576 577 switch (request->tcode) { 578 case TCODE_WRITE_QUADLET_REQUEST: 579 case TCODE_WRITE_BLOCK_REQUEST: 580 case TCODE_READ_QUADLET_REQUEST: 581 case TCODE_READ_BLOCK_REQUEST: 582 case TCODE_LOCK_MASK_SWAP: 583 case TCODE_LOCK_COMPARE_SWAP: 584 case TCODE_LOCK_FETCH_ADD: 585 case TCODE_LOCK_LITTLE_ADD: 586 case TCODE_LOCK_BOUNDED_ADD: 587 case TCODE_LOCK_WRAP_ADD: 588 case TCODE_LOCK_VENDOR_DEPENDENT: 589 break; 590 default: 591 return -EINVAL; 592 } 593 594 return init_request(client, request, client->device->node_id, 595 client->device->max_speed); 596 } 597 598 static void release_request(struct client *client, 599 struct client_resource *resource) 600 { 601 struct inbound_transaction_resource *r = container_of(resource, 602 struct inbound_transaction_resource, resource); 603 604 fw_send_response(client->device->card, r->request, 605 RCODE_CONFLICT_ERROR); 606 kfree(r); 607 } 608 609 static void handle_request(struct fw_card *card, struct fw_request *request, 610 int tcode, int destination, int source, 611 int generation, int speed, 612 unsigned long long offset, 613 void *payload, size_t length, void *callback_data) 614 { 615 struct address_handler_resource *handler = callback_data; 616 struct inbound_transaction_resource *r; 617 struct inbound_transaction_event *e; 618 int ret; 619 620 r = kmalloc(sizeof(*r), GFP_ATOMIC); 621 e = kmalloc(sizeof(*e), GFP_ATOMIC); 622 if (r == NULL || e == NULL) 623 goto failed; 624 625 r->request = request; 626 r->data = payload; 627 r->length = length; 628 629 r->resource.release = release_request; 630 ret = add_client_resource(handler->client, &r->resource, GFP_ATOMIC); 631 if (ret < 0) 632 goto failed; 633 634 e->request.type = FW_CDEV_EVENT_REQUEST; 635 e->request.tcode = tcode; 636 e->request.offset = offset; 637 e->request.length = length; 638 e->request.handle = r->resource.handle; 639 e->request.closure = handler->closure; 640 641 queue_event(handler->client, &e->event, 642 &e->request, sizeof(e->request), payload, length); 643 return; 644 645 failed: 646 kfree(r); 647 kfree(e); 648 fw_send_response(card, request, RCODE_CONFLICT_ERROR); 649 } 650 651 static void release_address_handler(struct client *client, 652 struct client_resource *resource) 653 { 654 struct address_handler_resource *r = 655 container_of(resource, struct address_handler_resource, resource); 656 657 fw_core_remove_address_handler(&r->handler); 658 kfree(r); 659 } 660 661 static int ioctl_allocate(struct client *client, void *buffer) 662 { 663 struct fw_cdev_allocate *request = buffer; 664 struct address_handler_resource *r; 665 struct fw_address_region region; 666 int ret; 667 668 r = kmalloc(sizeof(*r), GFP_KERNEL); 669 if (r == NULL) 670 return -ENOMEM; 671 672 region.start = request->offset; 673 region.end = request->offset + request->length; 674 r->handler.length = request->length; 675 r->handler.address_callback = handle_request; 676 r->handler.callback_data = r; 677 r->closure = request->closure; 678 r->client = client; 679 680 ret = fw_core_add_address_handler(&r->handler, ®ion); 681 if (ret < 0) { 682 kfree(r); 683 return ret; 684 } 685 686 r->resource.release = release_address_handler; 687 ret = add_client_resource(client, &r->resource, GFP_KERNEL); 688 if (ret < 0) { 689 release_address_handler(client, &r->resource); 690 return ret; 691 } 692 request->handle = r->resource.handle; 693 694 return 0; 695 } 696 697 static int ioctl_deallocate(struct client *client, void *buffer) 698 { 699 struct fw_cdev_deallocate *request = buffer; 700 701 return release_client_resource(client, request->handle, 702 release_address_handler, NULL); 703 } 704 705 static int ioctl_send_response(struct client *client, void *buffer) 706 { 707 struct fw_cdev_send_response *request = buffer; 708 struct client_resource *resource; 709 struct inbound_transaction_resource *r; 710 int ret = 0; 711 712 if (release_client_resource(client, request->handle, 713 release_request, &resource) < 0) 714 return -EINVAL; 715 716 r = container_of(resource, struct inbound_transaction_resource, 717 resource); 718 if (request->length < r->length) 719 r->length = request->length; 720 721 if (copy_from_user(r->data, u64_to_uptr(request->data), r->length)) { 722 ret = -EFAULT; 723 goto out; 724 } 725 726 fw_send_response(client->device->card, r->request, request->rcode); 727 out: 728 kfree(r); 729 730 return ret; 731 } 732 733 static int ioctl_initiate_bus_reset(struct client *client, void *buffer) 734 { 735 struct fw_cdev_initiate_bus_reset *request = buffer; 736 int short_reset; 737 738 short_reset = (request->type == FW_CDEV_SHORT_RESET); 739 740 return fw_core_initiate_bus_reset(client->device->card, short_reset); 741 } 742 743 static void release_descriptor(struct client *client, 744 struct client_resource *resource) 745 { 746 struct descriptor_resource *r = 747 container_of(resource, struct descriptor_resource, resource); 748 749 fw_core_remove_descriptor(&r->descriptor); 750 kfree(r); 751 } 752 753 static int ioctl_add_descriptor(struct client *client, void *buffer) 754 { 755 struct fw_cdev_add_descriptor *request = buffer; 756 struct descriptor_resource *r; 757 int ret; 758 759 /* Access policy: Allow this ioctl only on local nodes' device files. */ 760 if (!client->device->is_local) 761 return -ENOSYS; 762 763 if (request->length > 256) 764 return -EINVAL; 765 766 r = kmalloc(sizeof(*r) + request->length * 4, GFP_KERNEL); 767 if (r == NULL) 768 return -ENOMEM; 769 770 if (copy_from_user(r->data, 771 u64_to_uptr(request->data), request->length * 4)) { 772 ret = -EFAULT; 773 goto failed; 774 } 775 776 r->descriptor.length = request->length; 777 r->descriptor.immediate = request->immediate; 778 r->descriptor.key = request->key; 779 r->descriptor.data = r->data; 780 781 ret = fw_core_add_descriptor(&r->descriptor); 782 if (ret < 0) 783 goto failed; 784 785 r->resource.release = release_descriptor; 786 ret = add_client_resource(client, &r->resource, GFP_KERNEL); 787 if (ret < 0) { 788 fw_core_remove_descriptor(&r->descriptor); 789 goto failed; 790 } 791 request->handle = r->resource.handle; 792 793 return 0; 794 failed: 795 kfree(r); 796 797 return ret; 798 } 799 800 static int ioctl_remove_descriptor(struct client *client, void *buffer) 801 { 802 struct fw_cdev_remove_descriptor *request = buffer; 803 804 return release_client_resource(client, request->handle, 805 release_descriptor, NULL); 806 } 807 808 static void iso_callback(struct fw_iso_context *context, u32 cycle, 809 size_t header_length, void *header, void *data) 810 { 811 struct client *client = data; 812 struct iso_interrupt_event *e; 813 814 e = kzalloc(sizeof(*e) + header_length, GFP_ATOMIC); 815 if (e == NULL) 816 return; 817 818 e->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT; 819 e->interrupt.closure = client->iso_closure; 820 e->interrupt.cycle = cycle; 821 e->interrupt.header_length = header_length; 822 memcpy(e->interrupt.header, header, header_length); 823 queue_event(client, &e->event, &e->interrupt, 824 sizeof(e->interrupt) + header_length, NULL, 0); 825 } 826 827 static int ioctl_create_iso_context(struct client *client, void *buffer) 828 { 829 struct fw_cdev_create_iso_context *request = buffer; 830 struct fw_iso_context *context; 831 832 /* We only support one context at this time. */ 833 if (client->iso_context != NULL) 834 return -EBUSY; 835 836 if (request->channel > 63) 837 return -EINVAL; 838 839 switch (request->type) { 840 case FW_ISO_CONTEXT_RECEIVE: 841 if (request->header_size < 4 || (request->header_size & 3)) 842 return -EINVAL; 843 844 break; 845 846 case FW_ISO_CONTEXT_TRANSMIT: 847 if (request->speed > SCODE_3200) 848 return -EINVAL; 849 850 break; 851 852 default: 853 return -EINVAL; 854 } 855 856 context = fw_iso_context_create(client->device->card, 857 request->type, 858 request->channel, 859 request->speed, 860 request->header_size, 861 iso_callback, client); 862 if (IS_ERR(context)) 863 return PTR_ERR(context); 864 865 client->iso_closure = request->closure; 866 client->iso_context = context; 867 868 /* We only support one context at this time. */ 869 request->handle = 0; 870 871 return 0; 872 } 873 874 /* Macros for decoding the iso packet control header. */ 875 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff) 876 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01) 877 #define GET_SKIP(v) (((v) >> 17) & 0x01) 878 #define GET_TAG(v) (((v) >> 18) & 0x03) 879 #define GET_SY(v) (((v) >> 20) & 0x0f) 880 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff) 881 882 static int ioctl_queue_iso(struct client *client, void *buffer) 883 { 884 struct fw_cdev_queue_iso *request = buffer; 885 struct fw_cdev_iso_packet __user *p, *end, *next; 886 struct fw_iso_context *ctx = client->iso_context; 887 unsigned long payload, buffer_end, header_length; 888 u32 control; 889 int count; 890 struct { 891 struct fw_iso_packet packet; 892 u8 header[256]; 893 } u; 894 895 if (ctx == NULL || request->handle != 0) 896 return -EINVAL; 897 898 /* 899 * If the user passes a non-NULL data pointer, has mmap()'ed 900 * the iso buffer, and the pointer points inside the buffer, 901 * we setup the payload pointers accordingly. Otherwise we 902 * set them both to 0, which will still let packets with 903 * payload_length == 0 through. In other words, if no packets 904 * use the indirect payload, the iso buffer need not be mapped 905 * and the request->data pointer is ignored. 906 */ 907 908 payload = (unsigned long)request->data - client->vm_start; 909 buffer_end = client->buffer.page_count << PAGE_SHIFT; 910 if (request->data == 0 || client->buffer.pages == NULL || 911 payload >= buffer_end) { 912 payload = 0; 913 buffer_end = 0; 914 } 915 916 p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(request->packets); 917 918 if (!access_ok(VERIFY_READ, p, request->size)) 919 return -EFAULT; 920 921 end = (void __user *)p + request->size; 922 count = 0; 923 while (p < end) { 924 if (get_user(control, &p->control)) 925 return -EFAULT; 926 u.packet.payload_length = GET_PAYLOAD_LENGTH(control); 927 u.packet.interrupt = GET_INTERRUPT(control); 928 u.packet.skip = GET_SKIP(control); 929 u.packet.tag = GET_TAG(control); 930 u.packet.sy = GET_SY(control); 931 u.packet.header_length = GET_HEADER_LENGTH(control); 932 933 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) { 934 header_length = u.packet.header_length; 935 } else { 936 /* 937 * We require that header_length is a multiple of 938 * the fixed header size, ctx->header_size. 939 */ 940 if (ctx->header_size == 0) { 941 if (u.packet.header_length > 0) 942 return -EINVAL; 943 } else if (u.packet.header_length % ctx->header_size != 0) { 944 return -EINVAL; 945 } 946 header_length = 0; 947 } 948 949 next = (struct fw_cdev_iso_packet __user *) 950 &p->header[header_length / 4]; 951 if (next > end) 952 return -EINVAL; 953 if (__copy_from_user 954 (u.packet.header, p->header, header_length)) 955 return -EFAULT; 956 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT && 957 u.packet.header_length + u.packet.payload_length > 0) 958 return -EINVAL; 959 if (payload + u.packet.payload_length > buffer_end) 960 return -EINVAL; 961 962 if (fw_iso_context_queue(ctx, &u.packet, 963 &client->buffer, payload)) 964 break; 965 966 p = next; 967 payload += u.packet.payload_length; 968 count++; 969 } 970 971 request->size -= uptr_to_u64(p) - request->packets; 972 request->packets = uptr_to_u64(p); 973 request->data = client->vm_start + payload; 974 975 return count; 976 } 977 978 static int ioctl_start_iso(struct client *client, void *buffer) 979 { 980 struct fw_cdev_start_iso *request = buffer; 981 982 if (client->iso_context == NULL || request->handle != 0) 983 return -EINVAL; 984 985 if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE) { 986 if (request->tags == 0 || request->tags > 15) 987 return -EINVAL; 988 989 if (request->sync > 15) 990 return -EINVAL; 991 } 992 993 return fw_iso_context_start(client->iso_context, request->cycle, 994 request->sync, request->tags); 995 } 996 997 static int ioctl_stop_iso(struct client *client, void *buffer) 998 { 999 struct fw_cdev_stop_iso *request = buffer; 1000 1001 if (client->iso_context == NULL || request->handle != 0) 1002 return -EINVAL; 1003 1004 return fw_iso_context_stop(client->iso_context); 1005 } 1006 1007 static int ioctl_get_cycle_timer(struct client *client, void *buffer) 1008 { 1009 struct fw_cdev_get_cycle_timer *request = buffer; 1010 struct fw_card *card = client->device->card; 1011 unsigned long long bus_time; 1012 struct timeval tv; 1013 unsigned long flags; 1014 1015 preempt_disable(); 1016 local_irq_save(flags); 1017 1018 bus_time = card->driver->get_bus_time(card); 1019 do_gettimeofday(&tv); 1020 1021 local_irq_restore(flags); 1022 preempt_enable(); 1023 1024 request->local_time = tv.tv_sec * 1000000ULL + tv.tv_usec; 1025 request->cycle_timer = bus_time & 0xffffffff; 1026 return 0; 1027 } 1028 1029 static void iso_resource_work(struct work_struct *work) 1030 { 1031 struct iso_resource_event *e; 1032 struct iso_resource *r = 1033 container_of(work, struct iso_resource, work.work); 1034 struct client *client = r->client; 1035 int generation, channel, bandwidth, todo; 1036 bool skip, free, success; 1037 1038 spin_lock_irq(&client->lock); 1039 generation = client->device->generation; 1040 todo = r->todo; 1041 /* Allow 1000ms grace period for other reallocations. */ 1042 if (todo == ISO_RES_ALLOC && 1043 time_is_after_jiffies(client->device->card->reset_jiffies + HZ)) { 1044 schedule_iso_resource(r, DIV_ROUND_UP(HZ, 3)); 1045 skip = true; 1046 } else { 1047 /* We could be called twice within the same generation. */ 1048 skip = todo == ISO_RES_REALLOC && 1049 r->generation == generation; 1050 } 1051 free = todo == ISO_RES_DEALLOC || 1052 todo == ISO_RES_ALLOC_ONCE || 1053 todo == ISO_RES_DEALLOC_ONCE; 1054 r->generation = generation; 1055 spin_unlock_irq(&client->lock); 1056 1057 if (skip) 1058 goto out; 1059 1060 bandwidth = r->bandwidth; 1061 1062 fw_iso_resource_manage(client->device->card, generation, 1063 r->channels, &channel, &bandwidth, 1064 todo == ISO_RES_ALLOC || 1065 todo == ISO_RES_REALLOC || 1066 todo == ISO_RES_ALLOC_ONCE, 1067 r->transaction_data); 1068 /* 1069 * Is this generation outdated already? As long as this resource sticks 1070 * in the idr, it will be scheduled again for a newer generation or at 1071 * shutdown. 1072 */ 1073 if (channel == -EAGAIN && 1074 (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC)) 1075 goto out; 1076 1077 success = channel >= 0 || bandwidth > 0; 1078 1079 spin_lock_irq(&client->lock); 1080 /* 1081 * Transit from allocation to reallocation, except if the client 1082 * requested deallocation in the meantime. 1083 */ 1084 if (r->todo == ISO_RES_ALLOC) 1085 r->todo = ISO_RES_REALLOC; 1086 /* 1087 * Allocation or reallocation failure? Pull this resource out of the 1088 * idr and prepare for deletion, unless the client is shutting down. 1089 */ 1090 if (r->todo == ISO_RES_REALLOC && !success && 1091 !client->in_shutdown && 1092 idr_find(&client->resource_idr, r->resource.handle)) { 1093 idr_remove(&client->resource_idr, r->resource.handle); 1094 client_put(client); 1095 free = true; 1096 } 1097 spin_unlock_irq(&client->lock); 1098 1099 if (todo == ISO_RES_ALLOC && channel >= 0) 1100 r->channels = 1ULL << channel; 1101 1102 if (todo == ISO_RES_REALLOC && success) 1103 goto out; 1104 1105 if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) { 1106 e = r->e_alloc; 1107 r->e_alloc = NULL; 1108 } else { 1109 e = r->e_dealloc; 1110 r->e_dealloc = NULL; 1111 } 1112 e->iso_resource.handle = r->resource.handle; 1113 e->iso_resource.channel = channel; 1114 e->iso_resource.bandwidth = bandwidth; 1115 1116 queue_event(client, &e->event, 1117 &e->iso_resource, sizeof(e->iso_resource), NULL, 0); 1118 1119 if (free) { 1120 cancel_delayed_work(&r->work); 1121 kfree(r->e_alloc); 1122 kfree(r->e_dealloc); 1123 kfree(r); 1124 } 1125 out: 1126 client_put(client); 1127 } 1128 1129 static void release_iso_resource(struct client *client, 1130 struct client_resource *resource) 1131 { 1132 struct iso_resource *r = 1133 container_of(resource, struct iso_resource, resource); 1134 1135 spin_lock_irq(&client->lock); 1136 r->todo = ISO_RES_DEALLOC; 1137 schedule_iso_resource(r, 0); 1138 spin_unlock_irq(&client->lock); 1139 } 1140 1141 static int init_iso_resource(struct client *client, 1142 struct fw_cdev_allocate_iso_resource *request, int todo) 1143 { 1144 struct iso_resource_event *e1, *e2; 1145 struct iso_resource *r; 1146 int ret; 1147 1148 if ((request->channels == 0 && request->bandwidth == 0) || 1149 request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL || 1150 request->bandwidth < 0) 1151 return -EINVAL; 1152 1153 r = kmalloc(sizeof(*r), GFP_KERNEL); 1154 e1 = kmalloc(sizeof(*e1), GFP_KERNEL); 1155 e2 = kmalloc(sizeof(*e2), GFP_KERNEL); 1156 if (r == NULL || e1 == NULL || e2 == NULL) { 1157 ret = -ENOMEM; 1158 goto fail; 1159 } 1160 1161 INIT_DELAYED_WORK(&r->work, iso_resource_work); 1162 r->client = client; 1163 r->todo = todo; 1164 r->generation = -1; 1165 r->channels = request->channels; 1166 r->bandwidth = request->bandwidth; 1167 r->e_alloc = e1; 1168 r->e_dealloc = e2; 1169 1170 e1->iso_resource.closure = request->closure; 1171 e1->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED; 1172 e2->iso_resource.closure = request->closure; 1173 e2->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED; 1174 1175 if (todo == ISO_RES_ALLOC) { 1176 r->resource.release = release_iso_resource; 1177 ret = add_client_resource(client, &r->resource, GFP_KERNEL); 1178 if (ret < 0) 1179 goto fail; 1180 } else { 1181 r->resource.release = NULL; 1182 r->resource.handle = -1; 1183 schedule_iso_resource(r, 0); 1184 } 1185 request->handle = r->resource.handle; 1186 1187 return 0; 1188 fail: 1189 kfree(r); 1190 kfree(e1); 1191 kfree(e2); 1192 1193 return ret; 1194 } 1195 1196 static int ioctl_allocate_iso_resource(struct client *client, void *buffer) 1197 { 1198 struct fw_cdev_allocate_iso_resource *request = buffer; 1199 1200 return init_iso_resource(client, request, ISO_RES_ALLOC); 1201 } 1202 1203 static int ioctl_deallocate_iso_resource(struct client *client, void *buffer) 1204 { 1205 struct fw_cdev_deallocate *request = buffer; 1206 1207 return release_client_resource(client, request->handle, 1208 release_iso_resource, NULL); 1209 } 1210 1211 static int ioctl_allocate_iso_resource_once(struct client *client, void *buffer) 1212 { 1213 struct fw_cdev_allocate_iso_resource *request = buffer; 1214 1215 return init_iso_resource(client, request, ISO_RES_ALLOC_ONCE); 1216 } 1217 1218 static int ioctl_deallocate_iso_resource_once(struct client *client, void *buffer) 1219 { 1220 struct fw_cdev_allocate_iso_resource *request = buffer; 1221 1222 return init_iso_resource(client, request, ISO_RES_DEALLOC_ONCE); 1223 } 1224 1225 /* 1226 * Returns a speed code: Maximum speed to or from this device, 1227 * limited by the device's link speed, the local node's link speed, 1228 * and all PHY port speeds between the two links. 1229 */ 1230 static int ioctl_get_speed(struct client *client, void *buffer) 1231 { 1232 return client->device->max_speed; 1233 } 1234 1235 static int ioctl_send_broadcast_request(struct client *client, void *buffer) 1236 { 1237 struct fw_cdev_send_request *request = buffer; 1238 1239 switch (request->tcode) { 1240 case TCODE_WRITE_QUADLET_REQUEST: 1241 case TCODE_WRITE_BLOCK_REQUEST: 1242 break; 1243 default: 1244 return -EINVAL; 1245 } 1246 1247 /* Security policy: Only allow accesses to Units Space. */ 1248 if (request->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END) 1249 return -EACCES; 1250 1251 return init_request(client, request, LOCAL_BUS | 0x3f, SCODE_100); 1252 } 1253 1254 static int ioctl_send_stream_packet(struct client *client, void *buffer) 1255 { 1256 struct fw_cdev_send_stream_packet *p = buffer; 1257 struct fw_cdev_send_request request; 1258 int dest; 1259 1260 if (p->speed > client->device->card->link_speed || 1261 p->length > 1024 << p->speed) 1262 return -EIO; 1263 1264 if (p->tag > 3 || p->channel > 63 || p->sy > 15) 1265 return -EINVAL; 1266 1267 dest = fw_stream_packet_destination_id(p->tag, p->channel, p->sy); 1268 request.tcode = TCODE_STREAM_DATA; 1269 request.length = p->length; 1270 request.closure = p->closure; 1271 request.data = p->data; 1272 request.generation = p->generation; 1273 1274 return init_request(client, &request, dest, p->speed); 1275 } 1276 1277 static int (* const ioctl_handlers[])(struct client *client, void *buffer) = { 1278 ioctl_get_info, 1279 ioctl_send_request, 1280 ioctl_allocate, 1281 ioctl_deallocate, 1282 ioctl_send_response, 1283 ioctl_initiate_bus_reset, 1284 ioctl_add_descriptor, 1285 ioctl_remove_descriptor, 1286 ioctl_create_iso_context, 1287 ioctl_queue_iso, 1288 ioctl_start_iso, 1289 ioctl_stop_iso, 1290 ioctl_get_cycle_timer, 1291 ioctl_allocate_iso_resource, 1292 ioctl_deallocate_iso_resource, 1293 ioctl_allocate_iso_resource_once, 1294 ioctl_deallocate_iso_resource_once, 1295 ioctl_get_speed, 1296 ioctl_send_broadcast_request, 1297 ioctl_send_stream_packet, 1298 }; 1299 1300 static int dispatch_ioctl(struct client *client, 1301 unsigned int cmd, void __user *arg) 1302 { 1303 char buffer[sizeof(union { 1304 struct fw_cdev_get_info _00; 1305 struct fw_cdev_send_request _01; 1306 struct fw_cdev_allocate _02; 1307 struct fw_cdev_deallocate _03; 1308 struct fw_cdev_send_response _04; 1309 struct fw_cdev_initiate_bus_reset _05; 1310 struct fw_cdev_add_descriptor _06; 1311 struct fw_cdev_remove_descriptor _07; 1312 struct fw_cdev_create_iso_context _08; 1313 struct fw_cdev_queue_iso _09; 1314 struct fw_cdev_start_iso _0a; 1315 struct fw_cdev_stop_iso _0b; 1316 struct fw_cdev_get_cycle_timer _0c; 1317 struct fw_cdev_allocate_iso_resource _0d; 1318 struct fw_cdev_send_stream_packet _13; 1319 })]; 1320 int ret; 1321 1322 if (_IOC_TYPE(cmd) != '#' || 1323 _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers)) 1324 return -EINVAL; 1325 1326 if (_IOC_DIR(cmd) & _IOC_WRITE) { 1327 if (_IOC_SIZE(cmd) > sizeof(buffer) || 1328 copy_from_user(buffer, arg, _IOC_SIZE(cmd))) 1329 return -EFAULT; 1330 } 1331 1332 ret = ioctl_handlers[_IOC_NR(cmd)](client, buffer); 1333 if (ret < 0) 1334 return ret; 1335 1336 if (_IOC_DIR(cmd) & _IOC_READ) { 1337 if (_IOC_SIZE(cmd) > sizeof(buffer) || 1338 copy_to_user(arg, buffer, _IOC_SIZE(cmd))) 1339 return -EFAULT; 1340 } 1341 1342 return ret; 1343 } 1344 1345 static long fw_device_op_ioctl(struct file *file, 1346 unsigned int cmd, unsigned long arg) 1347 { 1348 struct client *client = file->private_data; 1349 1350 if (fw_device_is_shutdown(client->device)) 1351 return -ENODEV; 1352 1353 return dispatch_ioctl(client, cmd, (void __user *) arg); 1354 } 1355 1356 #ifdef CONFIG_COMPAT 1357 static long fw_device_op_compat_ioctl(struct file *file, 1358 unsigned int cmd, unsigned long arg) 1359 { 1360 struct client *client = file->private_data; 1361 1362 if (fw_device_is_shutdown(client->device)) 1363 return -ENODEV; 1364 1365 return dispatch_ioctl(client, cmd, compat_ptr(arg)); 1366 } 1367 #endif 1368 1369 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma) 1370 { 1371 struct client *client = file->private_data; 1372 enum dma_data_direction direction; 1373 unsigned long size; 1374 int page_count, ret; 1375 1376 if (fw_device_is_shutdown(client->device)) 1377 return -ENODEV; 1378 1379 /* FIXME: We could support multiple buffers, but we don't. */ 1380 if (client->buffer.pages != NULL) 1381 return -EBUSY; 1382 1383 if (!(vma->vm_flags & VM_SHARED)) 1384 return -EINVAL; 1385 1386 if (vma->vm_start & ~PAGE_MASK) 1387 return -EINVAL; 1388 1389 client->vm_start = vma->vm_start; 1390 size = vma->vm_end - vma->vm_start; 1391 page_count = size >> PAGE_SHIFT; 1392 if (size & ~PAGE_MASK) 1393 return -EINVAL; 1394 1395 if (vma->vm_flags & VM_WRITE) 1396 direction = DMA_TO_DEVICE; 1397 else 1398 direction = DMA_FROM_DEVICE; 1399 1400 ret = fw_iso_buffer_init(&client->buffer, client->device->card, 1401 page_count, direction); 1402 if (ret < 0) 1403 return ret; 1404 1405 ret = fw_iso_buffer_map(&client->buffer, vma); 1406 if (ret < 0) 1407 fw_iso_buffer_destroy(&client->buffer, client->device->card); 1408 1409 return ret; 1410 } 1411 1412 static int shutdown_resource(int id, void *p, void *data) 1413 { 1414 struct client_resource *resource = p; 1415 struct client *client = data; 1416 1417 resource->release(client, resource); 1418 client_put(client); 1419 1420 return 0; 1421 } 1422 1423 static int fw_device_op_release(struct inode *inode, struct file *file) 1424 { 1425 struct client *client = file->private_data; 1426 struct event *event, *next_event; 1427 1428 mutex_lock(&client->device->client_list_mutex); 1429 list_del(&client->link); 1430 mutex_unlock(&client->device->client_list_mutex); 1431 1432 if (client->iso_context) 1433 fw_iso_context_destroy(client->iso_context); 1434 1435 if (client->buffer.pages) 1436 fw_iso_buffer_destroy(&client->buffer, client->device->card); 1437 1438 /* Freeze client->resource_idr and client->event_list */ 1439 spin_lock_irq(&client->lock); 1440 client->in_shutdown = true; 1441 spin_unlock_irq(&client->lock); 1442 1443 idr_for_each(&client->resource_idr, shutdown_resource, client); 1444 idr_remove_all(&client->resource_idr); 1445 idr_destroy(&client->resource_idr); 1446 1447 list_for_each_entry_safe(event, next_event, &client->event_list, link) 1448 kfree(event); 1449 1450 client_put(client); 1451 1452 return 0; 1453 } 1454 1455 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt) 1456 { 1457 struct client *client = file->private_data; 1458 unsigned int mask = 0; 1459 1460 poll_wait(file, &client->wait, pt); 1461 1462 if (fw_device_is_shutdown(client->device)) 1463 mask |= POLLHUP | POLLERR; 1464 if (!list_empty(&client->event_list)) 1465 mask |= POLLIN | POLLRDNORM; 1466 1467 return mask; 1468 } 1469 1470 const struct file_operations fw_device_ops = { 1471 .owner = THIS_MODULE, 1472 .open = fw_device_op_open, 1473 .read = fw_device_op_read, 1474 .unlocked_ioctl = fw_device_op_ioctl, 1475 .poll = fw_device_op_poll, 1476 .release = fw_device_op_release, 1477 .mmap = fw_device_op_mmap, 1478 1479 #ifdef CONFIG_COMPAT 1480 .compat_ioctl = fw_device_op_compat_ioctl, 1481 #endif 1482 }; 1483