drivers/firewire/core-cdev.c

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