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