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