drivers/firewire/core-cdev.c

   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 #include <asm/system.h>
  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                  4
  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
  75         struct list_head phy_receiver_link;
  76         u64 phy_receiver_closure;
  77
  78         struct list_head link;
  79         struct kref kref;
  80 };
  81
  82 static inline void client_get(struct client *client)
  83 {
  84         kref_get(&client->kref);
  85 }
  86
  87 static void client_release(struct kref *kref)
  88 {
  89         struct client *client = container_of(kref, struct client, kref);
  90
  91         fw_device_put(client->device);
  92         kfree(client);
  93 }
  94
  95 static void client_put(struct client *client)
  96 {
  97         kref_put(&client->kref, client_release);
  98 }
  99
 100 struct client_resource;
 101 typedef void (*client_resource_release_fn_t)(struct client *,
 102                                              struct client_resource *);
 103 struct client_resource {
 104         client_resource_release_fn_t release;
 105         int handle;
 106 };
 107
 108 struct address_handler_resource {
 109         struct client_resource resource;
 110         struct fw_address_handler handler;
 111         __u64 closure;
 112         struct client *client;
 113 };
 114
 115 struct outbound_transaction_resource {
 116         struct client_resource resource;
 117         struct fw_transaction transaction;
 118 };
 119
 120 struct inbound_transaction_resource {
 121         struct client_resource resource;
 122         struct fw_card *card;
 123         struct fw_request *request;
 124         void *data;
 125         size_t length;
 126 };
 127
 128 struct descriptor_resource {
 129         struct client_resource resource;
 130         struct fw_descriptor descriptor;
 131         u32 data[0];
 132 };
 133
 134 struct iso_resource {
 135         struct client_resource resource;
 136         struct client *client;
 137         /* Schedule work and access todo only with client->lock held. */
 138         struct delayed_work work;
 139         enum {ISO_RES_ALLOC, ISO_RES_REALLOC, ISO_RES_DEALLOC,
 140               ISO_RES_ALLOC_ONCE, ISO_RES_DEALLOC_ONCE,} todo;
 141         int generation;
 142         u64 channels;
 143         s32 bandwidth;
 144         struct iso_resource_event *e_alloc, *e_dealloc;
 145 };
 146
 147 static void release_iso_resource(struct client *, struct client_resource *);
 148
 149 static void schedule_iso_resource(struct iso_resource *r, unsigned long delay)
 150 {
 151         client_get(r->client);
 152         if (!queue_delayed_work(fw_workqueue, &r->work, delay))
 153                 client_put(r->client);
 154 }
 155
 156 static void schedule_if_iso_resource(struct client_resource *resource)
 157 {
 158         if (resource->release == release_iso_resource)
 159                 schedule_iso_resource(container_of(resource,
 160                                         struct iso_resource, resource), 0);
 161 }
 162
 163 /*
 164  * dequeue_event() just kfree()'s the event, so the event has to be
 165  * the first field in a struct XYZ_event.
 166  */
 167 struct event {
 168         struct { void *data; size_t size; } v[2];
 169         struct list_head link;
 170 };
 171
 172 struct bus_reset_event {
 173         struct event event;
 174         struct fw_cdev_event_bus_reset reset;
 175 };
 176
 177 struct outbound_transaction_event {
 178         struct event event;
 179         struct client *client;
 180         struct outbound_transaction_resource r;
 181         struct fw_cdev_event_response response;
 182 };
 183
 184 struct inbound_transaction_event {
 185         struct event event;
 186         union {
 187                 struct fw_cdev_event_request request;
 188                 struct fw_cdev_event_request2 request2;
 189         } req;
 190 };
 191
 192 struct iso_interrupt_event {
 193         struct event event;
 194         struct fw_cdev_event_iso_interrupt interrupt;
 195 };
 196
 197 struct iso_interrupt_mc_event {
 198         struct event event;
 199         struct fw_cdev_event_iso_interrupt_mc interrupt;
 200 };
 201
 202 struct iso_resource_event {
 203         struct event event;
 204         struct fw_cdev_event_iso_resource iso_resource;
 205 };
 206
 207 struct outbound_phy_packet_event {
 208         struct event event;
 209         struct client *client;
 210         struct fw_packet p;
 211         struct fw_cdev_event_phy_packet phy_packet;
 212 };
 213
 214 struct inbound_phy_packet_event {
 215         struct event event;
 216         struct fw_cdev_event_phy_packet phy_packet;
 217 };
 218
 219 #ifdef CONFIG_COMPAT
 220 static void __user *u64_to_uptr(u64 value)
 221 {
 222         if (is_compat_task())
 223                 return compat_ptr(value);
 224         else
 225                 return (void __user *)(unsigned long)value;
 226 }
 227
 228 static u64 uptr_to_u64(void __user *ptr)
 229 {
 230         if (is_compat_task())
 231                 return ptr_to_compat(ptr);
 232         else
 233                 return (u64)(unsigned long)ptr;
 234 }
 235 #else
 236 static inline void __user *u64_to_uptr(u64 value)
 237 {
 238         return (void __user *)(unsigned long)value;
 239 }
 240
 241 static inline u64 uptr_to_u64(void __user *ptr)
 242 {
 243         return (u64)(unsigned long)ptr;
 244 }
 245 #endif /* CONFIG_COMPAT */
 246
 247 static int fw_device_op_open(struct inode *inode, struct file *file)
 248 {
 249         struct fw_device *device;
 250         struct client *client;
 251
 252         device = fw_device_get_by_devt(inode->i_rdev);
 253         if (device == NULL)
 254                 return -ENODEV;
 255
 256         if (fw_device_is_shutdown(device)) {
 257                 fw_device_put(device);
 258                 return -ENODEV;
 259         }
 260
 261         client = kzalloc(sizeof(*client), GFP_KERNEL);
 262         if (client == NULL) {
 263                 fw_device_put(device);
 264                 return -ENOMEM;
 265         }
 266
 267         client->device = device;
 268         spin_lock_init(&client->lock);
 269         idr_init(&client->resource_idr);
 270         INIT_LIST_HEAD(&client->event_list);
 271         init_waitqueue_head(&client->wait);
 272         init_waitqueue_head(&client->tx_flush_wait);
 273         INIT_LIST_HEAD(&client->phy_receiver_link);
 274         INIT_LIST_HEAD(&client->link);
 275         kref_init(&client->kref);
 276
 277         file->private_data = client;
 278
 279         return nonseekable_open(inode, file);
 280 }
 281
 282 static void queue_event(struct client *client, struct event *event,
 283                         void *data0, size_t size0, void *data1, size_t size1)
 284 {
 285         unsigned long flags;
 286
 287         event->v[0].data = data0;
 288         event->v[0].size = size0;
 289         event->v[1].data = data1;
 290         event->v[1].size = size1;
 291
 292         spin_lock_irqsave(&client->lock, flags);
 293         if (client->in_shutdown)
 294                 kfree(event);
 295         else
 296                 list_add_tail(&event->link, &client->event_list);
 297         spin_unlock_irqrestore(&client->lock, flags);
 298
 299         wake_up_interruptible(&client->wait);
 300 }
 301
 302 static int dequeue_event(struct client *client,
 303                          char __user *buffer, size_t count)
 304 {
 305         struct event *event;
 306         size_t size, total;
 307         int i, ret;
 308
 309         ret = wait_event_interruptible(client->wait,
 310                         !list_empty(&client->event_list) ||
 311                         fw_device_is_shutdown(client->device));
 312         if (ret < 0)
 313                 return ret;
 314
 315         if (list_empty(&client->event_list) &&
 316                        fw_device_is_shutdown(client->device))
 317                 return -ENODEV;
 318
 319         spin_lock_irq(&client->lock);
 320         event = list_first_entry(&client->event_list, struct event, link);
 321         list_del(&event->link);
 322         spin_unlock_irq(&client->lock);
 323
 324         total = 0;
 325         for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) {
 326                 size = min(event->v[i].size, count - total);
 327                 if (copy_to_user(buffer + total, event->v[i].data, size)) {
 328                         ret = -EFAULT;
 329                         goto out;
 330                 }
 331                 total += size;
 332         }
 333         ret = total;
 334
 335  out:
 336         kfree(event);
 337
 338         return ret;
 339 }
 340
 341 static ssize_t fw_device_op_read(struct file *file, char __user *buffer,
 342                                  size_t count, loff_t *offset)
 343 {
 344         struct client *client = file->private_data;
 345
 346         return dequeue_event(client, buffer, count);
 347 }
 348
 349 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
 350                                  struct client *client)
 351 {
 352         struct fw_card *card = client->device->card;
 353
 354         spin_lock_irq(&card->lock);
 355
 356         event->closure       = client->bus_reset_closure;
 357         event->type          = FW_CDEV_EVENT_BUS_RESET;
 358         event->generation    = client->device->generation;
 359         event->node_id       = client->device->node_id;
 360         event->local_node_id = card->local_node->node_id;
 361         event->bm_node_id    = card->bm_node_id;
 362         event->irm_node_id   = card->irm_node->node_id;
 363         event->root_node_id  = card->root_node->node_id;
 364
 365         spin_unlock_irq(&card->lock);
 366 }
 367
 368 static void for_each_client(struct fw_device *device,
 369                             void (*callback)(struct client *client))
 370 {
 371         struct client *c;
 372
 373         mutex_lock(&device->client_list_mutex);
 374         list_for_each_entry(c, &device->client_list, link)
 375                 callback(c);
 376         mutex_unlock(&device->client_list_mutex);
 377 }
 378
 379 static int schedule_reallocations(int id, void *p, void *data)
 380 {
 381         schedule_if_iso_resource(p);
 382
 383         return 0;
 384 }
 385
 386 static void queue_bus_reset_event(struct client *client)
 387 {
 388         struct bus_reset_event *e;
 389
 390         e = kzalloc(sizeof(*e), GFP_KERNEL);
 391         if (e == NULL) {
 392                 fw_notify("Out of memory when allocating event\n");
 393                 return;
 394         }
 395
 396         fill_bus_reset_event(&e->reset, client);
 397
 398         queue_event(client, &e->event,
 399                     &e->reset, sizeof(e->reset), NULL, 0);
 400
 401         spin_lock_irq(&client->lock);
 402         idr_for_each(&client->resource_idr, schedule_reallocations, client);
 403         spin_unlock_irq(&client->lock);
 404 }
 405
 406 void fw_device_cdev_update(struct fw_device *device)
 407 {
 408         for_each_client(device, queue_bus_reset_event);
 409 }
 410
 411 static void wake_up_client(struct client *client)
 412 {
 413         wake_up_interruptible(&client->wait);
 414 }
 415
 416 void fw_device_cdev_remove(struct fw_device *device)
 417 {
 418         for_each_client(device, wake_up_client);
 419 }
 420
 421 union ioctl_arg {
 422         struct fw_cdev_get_info                 get_info;
 423         struct fw_cdev_send_request             send_request;
 424         struct fw_cdev_allocate                 allocate;
 425         struct fw_cdev_deallocate               deallocate;
 426         struct fw_cdev_send_response            send_response;
 427         struct fw_cdev_initiate_bus_reset       initiate_bus_reset;
 428         struct fw_cdev_add_descriptor           add_descriptor;
 429         struct fw_cdev_remove_descriptor        remove_descriptor;
 430         struct fw_cdev_create_iso_context       create_iso_context;
 431         struct fw_cdev_queue_iso                queue_iso;
 432         struct fw_cdev_start_iso                start_iso;
 433         struct fw_cdev_stop_iso                 stop_iso;
 434         struct fw_cdev_get_cycle_timer          get_cycle_timer;
 435         struct fw_cdev_allocate_iso_resource    allocate_iso_resource;
 436         struct fw_cdev_send_stream_packet       send_stream_packet;
 437         struct fw_cdev_get_cycle_timer2         get_cycle_timer2;
 438         struct fw_cdev_send_phy_packet          send_phy_packet;
 439         struct fw_cdev_receive_phy_packets      receive_phy_packets;
 440         struct fw_cdev_set_iso_channels         set_iso_channels;
 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_notify("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, &region);
 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_notify("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_notify("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_get_cycle_timer2(struct client *client, union ioctl_arg *arg)
1172 {
1173         struct fw_cdev_get_cycle_timer2 *a = &arg->get_cycle_timer2;
1174         struct fw_card *card = client->device->card;
1175         struct timespec ts = {0, 0};
1176         u32 cycle_time;
1177         int ret = 0;
1178
1179         local_irq_disable();
1180
1181         cycle_time = card->driver->read_csr(card, CSR_CYCLE_TIME);
1182
1183         switch (a->clk_id) {
1184         case CLOCK_REALTIME:      getnstimeofday(&ts);                   break;
1185         case CLOCK_MONOTONIC:     do_posix_clock_monotonic_gettime(&ts); break;
1186         case CLOCK_MONOTONIC_RAW: getrawmonotonic(&ts);                  break;
1187         default:
1188                 ret = -EINVAL;
1189         }
1190
1191         local_irq_enable();
1192
1193         a->tv_sec      = ts.tv_sec;
1194         a->tv_nsec     = ts.tv_nsec;
1195         a->cycle_timer = cycle_time;
1196
1197         return ret;
1198 }
1199
1200 static int ioctl_get_cycle_timer(struct client *client, union ioctl_arg *arg)
1201 {
1202         struct fw_cdev_get_cycle_timer *a = &arg->get_cycle_timer;
1203         struct fw_cdev_get_cycle_timer2 ct2;
1204
1205         ct2.clk_id = CLOCK_REALTIME;
1206         ioctl_get_cycle_timer2(client, (union ioctl_arg *)&ct2);
1207
1208         a->local_time = ct2.tv_sec * USEC_PER_SEC + ct2.tv_nsec / NSEC_PER_USEC;
1209         a->cycle_timer = ct2.cycle_timer;
1210
1211         return 0;
1212 }
1213
1214 static void iso_resource_work(struct work_struct *work)
1215 {
1216         struct iso_resource_event *e;
1217         struct iso_resource *r =
1218                         container_of(work, struct iso_resource, work.work);
1219         struct client *client = r->client;
1220         int generation, channel, bandwidth, todo;
1221         bool skip, free, success;
1222
1223         spin_lock_irq(&client->lock);
1224         generation = client->device->generation;
1225         todo = r->todo;
1226         /* Allow 1000ms grace period for other reallocations. */
1227         if (todo == ISO_RES_ALLOC &&
1228             time_before64(get_jiffies_64(),
1229                           client->device->card->reset_jiffies + HZ)) {
1230                 schedule_iso_resource(r, DIV_ROUND_UP(HZ, 3));
1231                 skip = true;
1232         } else {
1233                 /* We could be called twice within the same generation. */
1234                 skip = todo == ISO_RES_REALLOC &&
1235                        r->generation == generation;
1236         }
1237         free = todo == ISO_RES_DEALLOC ||
1238                todo == ISO_RES_ALLOC_ONCE ||
1239                todo == ISO_RES_DEALLOC_ONCE;
1240         r->generation = generation;
1241         spin_unlock_irq(&client->lock);
1242
1243         if (skip)
1244                 goto out;
1245
1246         bandwidth = r->bandwidth;
1247
1248         fw_iso_resource_manage(client->device->card, generation,
1249                         r->channels, &channel, &bandwidth,
1250                         todo == ISO_RES_ALLOC ||
1251                         todo == ISO_RES_REALLOC ||
1252                         todo == ISO_RES_ALLOC_ONCE);
1253         /*
1254          * Is this generation outdated already?  As long as this resource sticks
1255          * in the idr, it will be scheduled again for a newer generation or at
1256          * shutdown.
1257          */
1258         if (channel == -EAGAIN &&
1259             (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC))
1260                 goto out;
1261
1262         success = channel >= 0 || bandwidth > 0;
1263
1264         spin_lock_irq(&client->lock);
1265         /*
1266          * Transit from allocation to reallocation, except if the client
1267          * requested deallocation in the meantime.
1268          */
1269         if (r->todo == ISO_RES_ALLOC)
1270                 r->todo = ISO_RES_REALLOC;
1271         /*
1272          * Allocation or reallocation failure?  Pull this resource out of the
1273          * idr and prepare for deletion, unless the client is shutting down.
1274          */
1275         if (r->todo == ISO_RES_REALLOC && !success &&
1276             !client->in_shutdown &&
1277             idr_find(&client->resource_idr, r->resource.handle)) {
1278                 idr_remove(&client->resource_idr, r->resource.handle);
1279                 client_put(client);
1280                 free = true;
1281         }
1282         spin_unlock_irq(&client->lock);
1283
1284         if (todo == ISO_RES_ALLOC && channel >= 0)
1285                 r->channels = 1ULL << channel;
1286
1287         if (todo == ISO_RES_REALLOC && success)
1288                 goto out;
1289
1290         if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) {
1291                 e = r->e_alloc;
1292                 r->e_alloc = NULL;
1293         } else {
1294                 e = r->e_dealloc;
1295                 r->e_dealloc = NULL;
1296         }
1297         e->iso_resource.handle    = r->resource.handle;
1298         e->iso_resource.channel   = channel;
1299         e->iso_resource.bandwidth = bandwidth;
1300
1301         queue_event(client, &e->event,
1302                     &e->iso_resource, sizeof(e->iso_resource), NULL, 0);
1303
1304         if (free) {
1305                 cancel_delayed_work(&r->work);
1306                 kfree(r->e_alloc);
1307                 kfree(r->e_dealloc);
1308                 kfree(r);
1309         }
1310  out:
1311         client_put(client);
1312 }
1313
1314 static void release_iso_resource(struct client *client,
1315                                  struct client_resource *resource)
1316 {
1317         struct iso_resource *r =
1318                 container_of(resource, struct iso_resource, resource);
1319
1320         spin_lock_irq(&client->lock);
1321         r->todo = ISO_RES_DEALLOC;
1322         schedule_iso_resource(r, 0);
1323         spin_unlock_irq(&client->lock);
1324 }
1325
1326 static int init_iso_resource(struct client *client,
1327                 struct fw_cdev_allocate_iso_resource *request, int todo)
1328 {
1329         struct iso_resource_event *e1, *e2;
1330         struct iso_resource *r;
1331         int ret;
1332
1333         if ((request->channels == 0 && request->bandwidth == 0) ||
1334             request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL ||
1335             request->bandwidth < 0)
1336                 return -EINVAL;
1337
1338         r  = kmalloc(sizeof(*r), GFP_KERNEL);
1339         e1 = kmalloc(sizeof(*e1), GFP_KERNEL);
1340         e2 = kmalloc(sizeof(*e2), GFP_KERNEL);
1341         if (r == NULL || e1 == NULL || e2 == NULL) {
1342                 ret = -ENOMEM;
1343                 goto fail;
1344         }
1345
1346         INIT_DELAYED_WORK(&r->work, iso_resource_work);
1347         r->client       = client;
1348         r->todo         = todo;
1349         r->generation   = -1;
1350         r->channels     = request->channels;
1351         r->bandwidth    = request->bandwidth;
1352         r->e_alloc      = e1;
1353         r->e_dealloc    = e2;
1354
1355         e1->iso_resource.closure = request->closure;
1356         e1->iso_resource.type    = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED;
1357         e2->iso_resource.closure = request->closure;
1358         e2->iso_resource.type    = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED;
1359
1360         if (todo == ISO_RES_ALLOC) {
1361                 r->resource.release = release_iso_resource;
1362                 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
1363                 if (ret < 0)
1364                         goto fail;
1365         } else {
1366                 r->resource.release = NULL;
1367                 r->resource.handle = -1;
1368                 schedule_iso_resource(r, 0);
1369         }
1370         request->handle = r->resource.handle;
1371
1372         return 0;
1373  fail:
1374         kfree(r);
1375         kfree(e1);
1376         kfree(e2);
1377
1378         return ret;
1379 }
1380
1381 static int ioctl_allocate_iso_resource(struct client *client,
1382                                        union ioctl_arg *arg)
1383 {
1384         return init_iso_resource(client,
1385                         &arg->allocate_iso_resource, ISO_RES_ALLOC);
1386 }
1387
1388 static int ioctl_deallocate_iso_resource(struct client *client,
1389                                          union ioctl_arg *arg)
1390 {
1391         return release_client_resource(client,
1392                         arg->deallocate.handle, release_iso_resource, NULL);
1393 }
1394
1395 static int ioctl_allocate_iso_resource_once(struct client *client,
1396                                             union ioctl_arg *arg)
1397 {
1398         return init_iso_resource(client,
1399                         &arg->allocate_iso_resource, ISO_RES_ALLOC_ONCE);
1400 }
1401
1402 static int ioctl_deallocate_iso_resource_once(struct client *client,
1403                                               union ioctl_arg *arg)
1404 {
1405         return init_iso_resource(client,
1406                         &arg->allocate_iso_resource, ISO_RES_DEALLOC_ONCE);
1407 }
1408
1409 /*
1410  * Returns a speed code:  Maximum speed to or from this device,
1411  * limited by the device's link speed, the local node's link speed,
1412  * and all PHY port speeds between the two links.
1413  */
1414 static int ioctl_get_speed(struct client *client, union ioctl_arg *arg)
1415 {
1416         return client->device->max_speed;
1417 }
1418
1419 static int ioctl_send_broadcast_request(struct client *client,
1420                                         union ioctl_arg *arg)
1421 {
1422         struct fw_cdev_send_request *a = &arg->send_request;
1423
1424         switch (a->tcode) {
1425         case TCODE_WRITE_QUADLET_REQUEST:
1426         case TCODE_WRITE_BLOCK_REQUEST:
1427                 break;
1428         default:
1429                 return -EINVAL;
1430         }
1431
1432         /* Security policy: Only allow accesses to Units Space. */
1433         if (a->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END)
1434                 return -EACCES;
1435
1436         return init_request(client, a, LOCAL_BUS | 0x3f, SCODE_100);
1437 }
1438
1439 static int ioctl_send_stream_packet(struct client *client, union ioctl_arg *arg)
1440 {
1441         struct fw_cdev_send_stream_packet *a = &arg->send_stream_packet;
1442         struct fw_cdev_send_request request;
1443         int dest;
1444
1445         if (a->speed > client->device->card->link_speed ||
1446             a->length > 1024 << a->speed)
1447                 return -EIO;
1448
1449         if (a->tag > 3 || a->channel > 63 || a->sy > 15)
1450                 return -EINVAL;
1451
1452         dest = fw_stream_packet_destination_id(a->tag, a->channel, a->sy);
1453         request.tcode           = TCODE_STREAM_DATA;
1454         request.length          = a->length;
1455         request.closure         = a->closure;
1456         request.data            = a->data;
1457         request.generation      = a->generation;
1458
1459         return init_request(client, &request, dest, a->speed);
1460 }
1461
1462 static void outbound_phy_packet_callback(struct fw_packet *packet,
1463                                          struct fw_card *card, int status)
1464 {
1465         struct outbound_phy_packet_event *e =
1466                 container_of(packet, struct outbound_phy_packet_event, p);
1467
1468         switch (status) {
1469         /* expected: */
1470         case ACK_COMPLETE:      e->phy_packet.rcode = RCODE_COMPLETE;   break;
1471         /* should never happen with PHY packets: */
1472         case ACK_PENDING:       e->phy_packet.rcode = RCODE_COMPLETE;   break;
1473         case ACK_BUSY_X:
1474         case ACK_BUSY_A:
1475         case ACK_BUSY_B:        e->phy_packet.rcode = RCODE_BUSY;       break;
1476         case ACK_DATA_ERROR:    e->phy_packet.rcode = RCODE_DATA_ERROR; break;
1477         case ACK_TYPE_ERROR:    e->phy_packet.rcode = RCODE_TYPE_ERROR; break;
1478         /* stale generation; cancelled; on certain controllers: no ack */
1479         default:                e->phy_packet.rcode = status;           break;
1480         }
1481         e->phy_packet.data[0] = packet->timestamp;
1482
1483         queue_event(e->client, &e->event, &e->phy_packet,
1484                     sizeof(e->phy_packet) + e->phy_packet.length, NULL, 0);
1485         client_put(e->client);
1486 }
1487
1488 static int ioctl_send_phy_packet(struct client *client, union ioctl_arg *arg)
1489 {
1490         struct fw_cdev_send_phy_packet *a = &arg->send_phy_packet;
1491         struct fw_card *card = client->device->card;
1492         struct outbound_phy_packet_event *e;
1493
1494         /* Access policy: Allow this ioctl only on local nodes' device files. */
1495         if (!client->device->is_local)
1496                 return -ENOSYS;
1497
1498         e = kzalloc(sizeof(*e) + 4, GFP_KERNEL);
1499         if (e == NULL)
1500                 return -ENOMEM;
1501
1502         client_get(client);
1503         e->client               = client;
1504         e->p.speed              = SCODE_100;
1505         e->p.generation         = a->generation;
1506         e->p.header[0]          = TCODE_LINK_INTERNAL << 4;
1507         e->p.header[1]          = a->data[0];
1508         e->p.header[2]          = a->data[1];
1509         e->p.header_length      = 12;
1510         e->p.callback           = outbound_phy_packet_callback;
1511         e->phy_packet.closure   = a->closure;
1512         e->phy_packet.type      = FW_CDEV_EVENT_PHY_PACKET_SENT;
1513         if (is_ping_packet(a->data))
1514                         e->phy_packet.length = 4;
1515
1516         card->driver->send_request(card, &e->p);
1517
1518         return 0;
1519 }
1520
1521 static int ioctl_receive_phy_packets(struct client *client, union ioctl_arg *arg)
1522 {
1523         struct fw_cdev_receive_phy_packets *a = &arg->receive_phy_packets;
1524         struct fw_card *card = client->device->card;
1525
1526         /* Access policy: Allow this ioctl only on local nodes' device files. */
1527         if (!client->device->is_local)
1528                 return -ENOSYS;
1529
1530         spin_lock_irq(&card->lock);
1531
1532         list_move_tail(&client->phy_receiver_link, &card->phy_receiver_list);
1533         client->phy_receiver_closure = a->closure;
1534
1535         spin_unlock_irq(&card->lock);
1536
1537         return 0;
1538 }
1539
1540 void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p)
1541 {
1542         struct client *client;
1543         struct inbound_phy_packet_event *e;
1544         unsigned long flags;
1545
1546         spin_lock_irqsave(&card->lock, flags);
1547
1548         list_for_each_entry(client, &card->phy_receiver_list, phy_receiver_link) {
1549                 e = kmalloc(sizeof(*e) + 8, GFP_ATOMIC);
1550                 if (e == NULL) {
1551                         fw_notify("Out of memory when allocating event\n");
1552                         break;
1553                 }
1554                 e->phy_packet.closure   = client->phy_receiver_closure;
1555                 e->phy_packet.type      = FW_CDEV_EVENT_PHY_PACKET_RECEIVED;
1556                 e->phy_packet.rcode     = RCODE_COMPLETE;
1557                 e->phy_packet.length    = 8;
1558                 e->phy_packet.data[0]   = p->header[1];
1559                 e->phy_packet.data[1]   = p->header[2];
1560                 queue_event(client, &e->event,
1561                             &e->phy_packet, sizeof(e->phy_packet) + 8, NULL, 0);
1562         }
1563
1564         spin_unlock_irqrestore(&card->lock, flags);
1565 }
1566
1567 static int (* const ioctl_handlers[])(struct client *, union ioctl_arg *) = {
1568         [0x00] = ioctl_get_info,
1569         [0x01] = ioctl_send_request,
1570         [0x02] = ioctl_allocate,
1571         [0x03] = ioctl_deallocate,
1572         [0x04] = ioctl_send_response,
1573         [0x05] = ioctl_initiate_bus_reset,
1574         [0x06] = ioctl_add_descriptor,
1575         [0x07] = ioctl_remove_descriptor,
1576         [0x08] = ioctl_create_iso_context,
1577         [0x09] = ioctl_queue_iso,
1578         [0x0a] = ioctl_start_iso,
1579         [0x0b] = ioctl_stop_iso,
1580         [0x0c] = ioctl_get_cycle_timer,
1581         [0x0d] = ioctl_allocate_iso_resource,
1582         [0x0e] = ioctl_deallocate_iso_resource,
1583         [0x0f] = ioctl_allocate_iso_resource_once,
1584         [0x10] = ioctl_deallocate_iso_resource_once,
1585         [0x11] = ioctl_get_speed,
1586         [0x12] = ioctl_send_broadcast_request,
1587         [0x13] = ioctl_send_stream_packet,
1588         [0x14] = ioctl_get_cycle_timer2,
1589         [0x15] = ioctl_send_phy_packet,
1590         [0x16] = ioctl_receive_phy_packets,
1591         [0x17] = ioctl_set_iso_channels,
1592 };
1593
1594 static int dispatch_ioctl(struct client *client,
1595                           unsigned int cmd, void __user *arg)
1596 {
1597         union ioctl_arg buffer;
1598         int ret;
1599
1600         if (fw_device_is_shutdown(client->device))
1601                 return -ENODEV;
1602
1603         if (_IOC_TYPE(cmd) != '#' ||
1604             _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers) ||
1605             _IOC_SIZE(cmd) > sizeof(buffer))
1606                 return -ENOTTY;
1607
1608         if (_IOC_DIR(cmd) == _IOC_READ)
1609                 memset(&buffer, 0, _IOC_SIZE(cmd));
1610
1611         if (_IOC_DIR(cmd) & _IOC_WRITE)
1612                 if (copy_from_user(&buffer, arg, _IOC_SIZE(cmd)))
1613                         return -EFAULT;
1614
1615         ret = ioctl_handlers[_IOC_NR(cmd)](client, &buffer);
1616         if (ret < 0)
1617                 return ret;
1618
1619         if (_IOC_DIR(cmd) & _IOC_READ)
1620                 if (copy_to_user(arg, &buffer, _IOC_SIZE(cmd)))
1621                         return -EFAULT;
1622
1623         return ret;
1624 }
1625
1626 static long fw_device_op_ioctl(struct file *file,
1627                                unsigned int cmd, unsigned long arg)
1628 {
1629         return dispatch_ioctl(file->private_data, cmd, (void __user *)arg);
1630 }
1631
1632 #ifdef CONFIG_COMPAT
1633 static long fw_device_op_compat_ioctl(struct file *file,
1634                                       unsigned int cmd, unsigned long arg)
1635 {
1636         return dispatch_ioctl(file->private_data, cmd, compat_ptr(arg));
1637 }
1638 #endif
1639
1640 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
1641 {
1642         struct client *client = file->private_data;
1643         enum dma_data_direction direction;
1644         unsigned long size;
1645         int page_count, ret;
1646
1647         if (fw_device_is_shutdown(client->device))
1648                 return -ENODEV;
1649
1650         /* FIXME: We could support multiple buffers, but we don't. */
1651         if (client->buffer.pages != NULL)
1652                 return -EBUSY;
1653
1654         if (!(vma->vm_flags & VM_SHARED))
1655                 return -EINVAL;
1656
1657         if (vma->vm_start & ~PAGE_MASK)
1658                 return -EINVAL;
1659
1660         client->vm_start = vma->vm_start;
1661         size = vma->vm_end - vma->vm_start;
1662         page_count = size >> PAGE_SHIFT;
1663         if (size & ~PAGE_MASK)
1664                 return -EINVAL;
1665
1666         if (vma->vm_flags & VM_WRITE)
1667                 direction = DMA_TO_DEVICE;
1668         else
1669                 direction = DMA_FROM_DEVICE;
1670
1671         ret = fw_iso_buffer_init(&client->buffer, client->device->card,
1672                                  page_count, direction);
1673         if (ret < 0)
1674                 return ret;
1675
1676         ret = fw_iso_buffer_map(&client->buffer, vma);
1677         if (ret < 0)
1678                 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1679
1680         return ret;
1681 }
1682
1683 static int is_outbound_transaction_resource(int id, void *p, void *data)
1684 {
1685         struct client_resource *resource = p;
1686
1687         return resource->release == release_transaction;
1688 }
1689
1690 static int has_outbound_transactions(struct client *client)
1691 {
1692         int ret;
1693
1694         spin_lock_irq(&client->lock);
1695         ret = idr_for_each(&client->resource_idr,
1696                            is_outbound_transaction_resource, NULL);
1697         spin_unlock_irq(&client->lock);
1698
1699         return ret;
1700 }
1701
1702 static int shutdown_resource(int id, void *p, void *data)
1703 {
1704         struct client_resource *resource = p;
1705         struct client *client = data;
1706
1707         resource->release(client, resource);
1708         client_put(client);
1709
1710         return 0;
1711 }
1712
1713 static int fw_device_op_release(struct inode *inode, struct file *file)
1714 {
1715         struct client *client = file->private_data;
1716         struct event *event, *next_event;
1717
1718         spin_lock_irq(&client->device->card->lock);
1719         list_del(&client->phy_receiver_link);
1720         spin_unlock_irq(&client->device->card->lock);
1721
1722         mutex_lock(&client->device->client_list_mutex);
1723         list_del(&client->link);
1724         mutex_unlock(&client->device->client_list_mutex);
1725
1726         if (client->iso_context)
1727                 fw_iso_context_destroy(client->iso_context);
1728
1729         if (client->buffer.pages)
1730                 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1731
1732         /* Freeze client->resource_idr and client->event_list */
1733         spin_lock_irq(&client->lock);
1734         client->in_shutdown = true;
1735         spin_unlock_irq(&client->lock);
1736
1737         wait_event(client->tx_flush_wait, !has_outbound_transactions(client));
1738
1739         idr_for_each(&client->resource_idr, shutdown_resource, client);
1740         idr_remove_all(&client->resource_idr);
1741         idr_destroy(&client->resource_idr);
1742
1743         list_for_each_entry_safe(event, next_event, &client->event_list, link)
1744                 kfree(event);
1745
1746         client_put(client);
1747
1748         return 0;
1749 }
1750
1751 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
1752 {
1753         struct client *client = file->private_data;
1754         unsigned int mask = 0;
1755
1756         poll_wait(file, &client->wait, pt);
1757
1758         if (fw_device_is_shutdown(client->device))
1759                 mask |= POLLHUP | POLLERR;
1760         if (!list_empty(&client->event_list))
1761                 mask |= POLLIN | POLLRDNORM;
1762
1763         return mask;
1764 }
1765
1766 const struct file_operations fw_device_ops = {
1767         .owner          = THIS_MODULE,
1768         .llseek         = no_llseek,
1769         .open           = fw_device_op_open,
1770         .read           = fw_device_op_read,
1771         .unlocked_ioctl = fw_device_op_ioctl,
1772         .mmap           = fw_device_op_mmap,
1773         .release        = fw_device_op_release,
1774         .poll           = fw_device_op_poll,
1775 #ifdef CONFIG_COMPAT
1776         .compat_ioctl   = fw_device_op_compat_ioctl,
1777 #endif
1778 };