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