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