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