Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * Char device for device raw access
0004  *
0005  * Copyright (C) 2005-2007  Kristian Hoegsberg <krh@bitplanet.net>
0006  */
0007 
0008 #include <linux/bug.h>
0009 #include <linux/compat.h>
0010 #include <linux/delay.h>
0011 #include <linux/device.h>
0012 #include <linux/dma-mapping.h>
0013 #include <linux/err.h>
0014 #include <linux/errno.h>
0015 #include <linux/firewire.h>
0016 #include <linux/firewire-cdev.h>
0017 #include <linux/idr.h>
0018 #include <linux/irqflags.h>
0019 #include <linux/jiffies.h>
0020 #include <linux/kernel.h>
0021 #include <linux/kref.h>
0022 #include <linux/mm.h>
0023 #include <linux/module.h>
0024 #include <linux/mutex.h>
0025 #include <linux/poll.h>
0026 #include <linux/sched.h> /* required for linux/wait.h */
0027 #include <linux/slab.h>
0028 #include <linux/spinlock.h>
0029 #include <linux/string.h>
0030 #include <linux/time.h>
0031 #include <linux/uaccess.h>
0032 #include <linux/vmalloc.h>
0033 #include <linux/wait.h>
0034 #include <linux/workqueue.h>
0035 
0036 
0037 #include "core.h"
0038 
0039 /*
0040  * ABI version history is documented in linux/firewire-cdev.h.
0041  */
0042 #define FW_CDEV_KERNEL_VERSION          5
0043 #define FW_CDEV_VERSION_EVENT_REQUEST2      4
0044 #define FW_CDEV_VERSION_ALLOCATE_REGION_END 4
0045 #define FW_CDEV_VERSION_AUTO_FLUSH_ISO_OVERFLOW 5
0046 
0047 struct client {
0048     u32 version;
0049     struct fw_device *device;
0050 
0051     spinlock_t lock;
0052     bool in_shutdown;
0053     struct idr resource_idr;
0054     struct list_head event_list;
0055     wait_queue_head_t wait;
0056     wait_queue_head_t tx_flush_wait;
0057     u64 bus_reset_closure;
0058 
0059     struct fw_iso_context *iso_context;
0060     u64 iso_closure;
0061     struct fw_iso_buffer buffer;
0062     unsigned long vm_start;
0063     bool buffer_is_mapped;
0064 
0065     struct list_head phy_receiver_link;
0066     u64 phy_receiver_closure;
0067 
0068     struct list_head link;
0069     struct kref kref;
0070 };
0071 
0072 static inline void client_get(struct client *client)
0073 {
0074     kref_get(&client->kref);
0075 }
0076 
0077 static void client_release(struct kref *kref)
0078 {
0079     struct client *client = container_of(kref, struct client, kref);
0080 
0081     fw_device_put(client->device);
0082     kfree(client);
0083 }
0084 
0085 static void client_put(struct client *client)
0086 {
0087     kref_put(&client->kref, client_release);
0088 }
0089 
0090 struct client_resource;
0091 typedef void (*client_resource_release_fn_t)(struct client *,
0092                          struct client_resource *);
0093 struct client_resource {
0094     client_resource_release_fn_t release;
0095     int handle;
0096 };
0097 
0098 struct address_handler_resource {
0099     struct client_resource resource;
0100     struct fw_address_handler handler;
0101     __u64 closure;
0102     struct client *client;
0103 };
0104 
0105 struct outbound_transaction_resource {
0106     struct client_resource resource;
0107     struct fw_transaction transaction;
0108 };
0109 
0110 struct inbound_transaction_resource {
0111     struct client_resource resource;
0112     struct fw_card *card;
0113     struct fw_request *request;
0114     void *data;
0115     size_t length;
0116 };
0117 
0118 struct descriptor_resource {
0119     struct client_resource resource;
0120     struct fw_descriptor descriptor;
0121     u32 data[];
0122 };
0123 
0124 struct iso_resource {
0125     struct client_resource resource;
0126     struct client *client;
0127     /* Schedule work and access todo only with client->lock held. */
0128     struct delayed_work work;
0129     enum {ISO_RES_ALLOC, ISO_RES_REALLOC, ISO_RES_DEALLOC,
0130           ISO_RES_ALLOC_ONCE, ISO_RES_DEALLOC_ONCE,} todo;
0131     int generation;
0132     u64 channels;
0133     s32 bandwidth;
0134     struct iso_resource_event *e_alloc, *e_dealloc;
0135 };
0136 
0137 static void release_iso_resource(struct client *, struct client_resource *);
0138 
0139 static void schedule_iso_resource(struct iso_resource *r, unsigned long delay)
0140 {
0141     client_get(r->client);
0142     if (!queue_delayed_work(fw_workqueue, &r->work, delay))
0143         client_put(r->client);
0144 }
0145 
0146 static void schedule_if_iso_resource(struct client_resource *resource)
0147 {
0148     if (resource->release == release_iso_resource)
0149         schedule_iso_resource(container_of(resource,
0150                     struct iso_resource, resource), 0);
0151 }
0152 
0153 /*
0154  * dequeue_event() just kfree()'s the event, so the event has to be
0155  * the first field in a struct XYZ_event.
0156  */
0157 struct event {
0158     struct { void *data; size_t size; } v[2];
0159     struct list_head link;
0160 };
0161 
0162 struct bus_reset_event {
0163     struct event event;
0164     struct fw_cdev_event_bus_reset reset;
0165 };
0166 
0167 struct outbound_transaction_event {
0168     struct event event;
0169     struct client *client;
0170     struct outbound_transaction_resource r;
0171     struct fw_cdev_event_response response;
0172 };
0173 
0174 struct inbound_transaction_event {
0175     struct event event;
0176     union {
0177         struct fw_cdev_event_request request;
0178         struct fw_cdev_event_request2 request2;
0179     } req;
0180 };
0181 
0182 struct iso_interrupt_event {
0183     struct event event;
0184     struct fw_cdev_event_iso_interrupt interrupt;
0185 };
0186 
0187 struct iso_interrupt_mc_event {
0188     struct event event;
0189     struct fw_cdev_event_iso_interrupt_mc interrupt;
0190 };
0191 
0192 struct iso_resource_event {
0193     struct event event;
0194     struct fw_cdev_event_iso_resource iso_resource;
0195 };
0196 
0197 struct outbound_phy_packet_event {
0198     struct event event;
0199     struct client *client;
0200     struct fw_packet p;
0201     struct fw_cdev_event_phy_packet phy_packet;
0202 };
0203 
0204 struct inbound_phy_packet_event {
0205     struct event event;
0206     struct fw_cdev_event_phy_packet phy_packet;
0207 };
0208 
0209 #ifdef CONFIG_COMPAT
0210 static void __user *u64_to_uptr(u64 value)
0211 {
0212     if (in_compat_syscall())
0213         return compat_ptr(value);
0214     else
0215         return (void __user *)(unsigned long)value;
0216 }
0217 
0218 static u64 uptr_to_u64(void __user *ptr)
0219 {
0220     if (in_compat_syscall())
0221         return ptr_to_compat(ptr);
0222     else
0223         return (u64)(unsigned long)ptr;
0224 }
0225 #else
0226 static inline void __user *u64_to_uptr(u64 value)
0227 {
0228     return (void __user *)(unsigned long)value;
0229 }
0230 
0231 static inline u64 uptr_to_u64(void __user *ptr)
0232 {
0233     return (u64)(unsigned long)ptr;
0234 }
0235 #endif /* CONFIG_COMPAT */
0236 
0237 static int fw_device_op_open(struct inode *inode, struct file *file)
0238 {
0239     struct fw_device *device;
0240     struct client *client;
0241 
0242     device = fw_device_get_by_devt(inode->i_rdev);
0243     if (device == NULL)
0244         return -ENODEV;
0245 
0246     if (fw_device_is_shutdown(device)) {
0247         fw_device_put(device);
0248         return -ENODEV;
0249     }
0250 
0251     client = kzalloc(sizeof(*client), GFP_KERNEL);
0252     if (client == NULL) {
0253         fw_device_put(device);
0254         return -ENOMEM;
0255     }
0256 
0257     client->device = device;
0258     spin_lock_init(&client->lock);
0259     idr_init(&client->resource_idr);
0260     INIT_LIST_HEAD(&client->event_list);
0261     init_waitqueue_head(&client->wait);
0262     init_waitqueue_head(&client->tx_flush_wait);
0263     INIT_LIST_HEAD(&client->phy_receiver_link);
0264     INIT_LIST_HEAD(&client->link);
0265     kref_init(&client->kref);
0266 
0267     file->private_data = client;
0268 
0269     return nonseekable_open(inode, file);
0270 }
0271 
0272 static void queue_event(struct client *client, struct event *event,
0273             void *data0, size_t size0, void *data1, size_t size1)
0274 {
0275     unsigned long flags;
0276 
0277     event->v[0].data = data0;
0278     event->v[0].size = size0;
0279     event->v[1].data = data1;
0280     event->v[1].size = size1;
0281 
0282     spin_lock_irqsave(&client->lock, flags);
0283     if (client->in_shutdown)
0284         kfree(event);
0285     else
0286         list_add_tail(&event->link, &client->event_list);
0287     spin_unlock_irqrestore(&client->lock, flags);
0288 
0289     wake_up_interruptible(&client->wait);
0290 }
0291 
0292 static int dequeue_event(struct client *client,
0293              char __user *buffer, size_t count)
0294 {
0295     struct event *event;
0296     size_t size, total;
0297     int i, ret;
0298 
0299     ret = wait_event_interruptible(client->wait,
0300             !list_empty(&client->event_list) ||
0301             fw_device_is_shutdown(client->device));
0302     if (ret < 0)
0303         return ret;
0304 
0305     if (list_empty(&client->event_list) &&
0306                fw_device_is_shutdown(client->device))
0307         return -ENODEV;
0308 
0309     spin_lock_irq(&client->lock);
0310     event = list_first_entry(&client->event_list, struct event, link);
0311     list_del(&event->link);
0312     spin_unlock_irq(&client->lock);
0313 
0314     total = 0;
0315     for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) {
0316         size = min(event->v[i].size, count - total);
0317         if (copy_to_user(buffer + total, event->v[i].data, size)) {
0318             ret = -EFAULT;
0319             goto out;
0320         }
0321         total += size;
0322     }
0323     ret = total;
0324 
0325  out:
0326     kfree(event);
0327 
0328     return ret;
0329 }
0330 
0331 static ssize_t fw_device_op_read(struct file *file, char __user *buffer,
0332                  size_t count, loff_t *offset)
0333 {
0334     struct client *client = file->private_data;
0335 
0336     return dequeue_event(client, buffer, count);
0337 }
0338 
0339 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
0340                  struct client *client)
0341 {
0342     struct fw_card *card = client->device->card;
0343 
0344     spin_lock_irq(&card->lock);
0345 
0346     event->closure       = client->bus_reset_closure;
0347     event->type          = FW_CDEV_EVENT_BUS_RESET;
0348     event->generation    = client->device->generation;
0349     event->node_id       = client->device->node_id;
0350     event->local_node_id = card->local_node->node_id;
0351     event->bm_node_id    = card->bm_node_id;
0352     event->irm_node_id   = card->irm_node->node_id;
0353     event->root_node_id  = card->root_node->node_id;
0354 
0355     spin_unlock_irq(&card->lock);
0356 }
0357 
0358 static void for_each_client(struct fw_device *device,
0359                 void (*callback)(struct client *client))
0360 {
0361     struct client *c;
0362 
0363     mutex_lock(&device->client_list_mutex);
0364     list_for_each_entry(c, &device->client_list, link)
0365         callback(c);
0366     mutex_unlock(&device->client_list_mutex);
0367 }
0368 
0369 static int schedule_reallocations(int id, void *p, void *data)
0370 {
0371     schedule_if_iso_resource(p);
0372 
0373     return 0;
0374 }
0375 
0376 static void queue_bus_reset_event(struct client *client)
0377 {
0378     struct bus_reset_event *e;
0379 
0380     e = kzalloc(sizeof(*e), GFP_KERNEL);
0381     if (e == NULL)
0382         return;
0383 
0384     fill_bus_reset_event(&e->reset, client);
0385 
0386     queue_event(client, &e->event,
0387             &e->reset, sizeof(e->reset), NULL, 0);
0388 
0389     spin_lock_irq(&client->lock);
0390     idr_for_each(&client->resource_idr, schedule_reallocations, client);
0391     spin_unlock_irq(&client->lock);
0392 }
0393 
0394 void fw_device_cdev_update(struct fw_device *device)
0395 {
0396     for_each_client(device, queue_bus_reset_event);
0397 }
0398 
0399 static void wake_up_client(struct client *client)
0400 {
0401     wake_up_interruptible(&client->wait);
0402 }
0403 
0404 void fw_device_cdev_remove(struct fw_device *device)
0405 {
0406     for_each_client(device, wake_up_client);
0407 }
0408 
0409 union ioctl_arg {
0410     struct fw_cdev_get_info         get_info;
0411     struct fw_cdev_send_request     send_request;
0412     struct fw_cdev_allocate         allocate;
0413     struct fw_cdev_deallocate       deallocate;
0414     struct fw_cdev_send_response        send_response;
0415     struct fw_cdev_initiate_bus_reset   initiate_bus_reset;
0416     struct fw_cdev_add_descriptor       add_descriptor;
0417     struct fw_cdev_remove_descriptor    remove_descriptor;
0418     struct fw_cdev_create_iso_context   create_iso_context;
0419     struct fw_cdev_queue_iso        queue_iso;
0420     struct fw_cdev_start_iso        start_iso;
0421     struct fw_cdev_stop_iso         stop_iso;
0422     struct fw_cdev_get_cycle_timer      get_cycle_timer;
0423     struct fw_cdev_allocate_iso_resource    allocate_iso_resource;
0424     struct fw_cdev_send_stream_packet   send_stream_packet;
0425     struct fw_cdev_get_cycle_timer2     get_cycle_timer2;
0426     struct fw_cdev_send_phy_packet      send_phy_packet;
0427     struct fw_cdev_receive_phy_packets  receive_phy_packets;
0428     struct fw_cdev_set_iso_channels     set_iso_channels;
0429     struct fw_cdev_flush_iso        flush_iso;
0430 };
0431 
0432 static int ioctl_get_info(struct client *client, union ioctl_arg *arg)
0433 {
0434     struct fw_cdev_get_info *a = &arg->get_info;
0435     struct fw_cdev_event_bus_reset bus_reset;
0436     unsigned long ret = 0;
0437 
0438     client->version = a->version;
0439     a->version = FW_CDEV_KERNEL_VERSION;
0440     a->card = client->device->card->index;
0441 
0442     down_read(&fw_device_rwsem);
0443 
0444     if (a->rom != 0) {
0445         size_t want = a->rom_length;
0446         size_t have = client->device->config_rom_length * 4;
0447 
0448         ret = copy_to_user(u64_to_uptr(a->rom),
0449                    client->device->config_rom, min(want, have));
0450     }
0451     a->rom_length = client->device->config_rom_length * 4;
0452 
0453     up_read(&fw_device_rwsem);
0454 
0455     if (ret != 0)
0456         return -EFAULT;
0457 
0458     mutex_lock(&client->device->client_list_mutex);
0459 
0460     client->bus_reset_closure = a->bus_reset_closure;
0461     if (a->bus_reset != 0) {
0462         fill_bus_reset_event(&bus_reset, client);
0463         /* unaligned size of bus_reset is 36 bytes */
0464         ret = copy_to_user(u64_to_uptr(a->bus_reset), &bus_reset, 36);
0465     }
0466     if (ret == 0 && list_empty(&client->link))
0467         list_add_tail(&client->link, &client->device->client_list);
0468 
0469     mutex_unlock(&client->device->client_list_mutex);
0470 
0471     return ret ? -EFAULT : 0;
0472 }
0473 
0474 static int add_client_resource(struct client *client,
0475                    struct client_resource *resource, gfp_t gfp_mask)
0476 {
0477     bool preload = gfpflags_allow_blocking(gfp_mask);
0478     unsigned long flags;
0479     int ret;
0480 
0481     if (preload)
0482         idr_preload(gfp_mask);
0483     spin_lock_irqsave(&client->lock, flags);
0484 
0485     if (client->in_shutdown)
0486         ret = -ECANCELED;
0487     else
0488         ret = idr_alloc(&client->resource_idr, resource, 0, 0,
0489                 GFP_NOWAIT);
0490     if (ret >= 0) {
0491         resource->handle = ret;
0492         client_get(client);
0493         schedule_if_iso_resource(resource);
0494     }
0495 
0496     spin_unlock_irqrestore(&client->lock, flags);
0497     if (preload)
0498         idr_preload_end();
0499 
0500     return ret < 0 ? ret : 0;
0501 }
0502 
0503 static int release_client_resource(struct client *client, u32 handle,
0504                    client_resource_release_fn_t release,
0505                    struct client_resource **return_resource)
0506 {
0507     struct client_resource *resource;
0508 
0509     spin_lock_irq(&client->lock);
0510     if (client->in_shutdown)
0511         resource = NULL;
0512     else
0513         resource = idr_find(&client->resource_idr, handle);
0514     if (resource && resource->release == release)
0515         idr_remove(&client->resource_idr, handle);
0516     spin_unlock_irq(&client->lock);
0517 
0518     if (!(resource && resource->release == release))
0519         return -EINVAL;
0520 
0521     if (return_resource)
0522         *return_resource = resource;
0523     else
0524         resource->release(client, resource);
0525 
0526     client_put(client);
0527 
0528     return 0;
0529 }
0530 
0531 static void release_transaction(struct client *client,
0532                 struct client_resource *resource)
0533 {
0534 }
0535 
0536 static void complete_transaction(struct fw_card *card, int rcode,
0537                  void *payload, size_t length, void *data)
0538 {
0539     struct outbound_transaction_event *e = data;
0540     struct fw_cdev_event_response *rsp = &e->response;
0541     struct client *client = e->client;
0542     unsigned long flags;
0543 
0544     if (length < rsp->length)
0545         rsp->length = length;
0546     if (rcode == RCODE_COMPLETE)
0547         memcpy(rsp->data, payload, rsp->length);
0548 
0549     spin_lock_irqsave(&client->lock, flags);
0550     idr_remove(&client->resource_idr, e->r.resource.handle);
0551     if (client->in_shutdown)
0552         wake_up(&client->tx_flush_wait);
0553     spin_unlock_irqrestore(&client->lock, flags);
0554 
0555     rsp->type = FW_CDEV_EVENT_RESPONSE;
0556     rsp->rcode = rcode;
0557 
0558     /*
0559      * In the case that sizeof(*rsp) doesn't align with the position of the
0560      * data, and the read is short, preserve an extra copy of the data
0561      * to stay compatible with a pre-2.6.27 bug.  Since the bug is harmless
0562      * for short reads and some apps depended on it, this is both safe
0563      * and prudent for compatibility.
0564      */
0565     if (rsp->length <= sizeof(*rsp) - offsetof(typeof(*rsp), data))
0566         queue_event(client, &e->event, rsp, sizeof(*rsp),
0567                 rsp->data, rsp->length);
0568     else
0569         queue_event(client, &e->event, rsp, sizeof(*rsp) + rsp->length,
0570                 NULL, 0);
0571 
0572     /* Drop the idr's reference */
0573     client_put(client);
0574 }
0575 
0576 static int init_request(struct client *client,
0577             struct fw_cdev_send_request *request,
0578             int destination_id, int speed)
0579 {
0580     struct outbound_transaction_event *e;
0581     int ret;
0582 
0583     if (request->tcode != TCODE_STREAM_DATA &&
0584         (request->length > 4096 || request->length > 512 << speed))
0585         return -EIO;
0586 
0587     if (request->tcode == TCODE_WRITE_QUADLET_REQUEST &&
0588         request->length < 4)
0589         return -EINVAL;
0590 
0591     e = kmalloc(sizeof(*e) + request->length, GFP_KERNEL);
0592     if (e == NULL)
0593         return -ENOMEM;
0594 
0595     e->client = client;
0596     e->response.length = request->length;
0597     e->response.closure = request->closure;
0598 
0599     if (request->data &&
0600         copy_from_user(e->response.data,
0601                u64_to_uptr(request->data), request->length)) {
0602         ret = -EFAULT;
0603         goto failed;
0604     }
0605 
0606     e->r.resource.release = release_transaction;
0607     ret = add_client_resource(client, &e->r.resource, GFP_KERNEL);
0608     if (ret < 0)
0609         goto failed;
0610 
0611     fw_send_request(client->device->card, &e->r.transaction,
0612             request->tcode, destination_id, request->generation,
0613             speed, request->offset, e->response.data,
0614             request->length, complete_transaction, e);
0615     return 0;
0616 
0617  failed:
0618     kfree(e);
0619 
0620     return ret;
0621 }
0622 
0623 static int ioctl_send_request(struct client *client, union ioctl_arg *arg)
0624 {
0625     switch (arg->send_request.tcode) {
0626     case TCODE_WRITE_QUADLET_REQUEST:
0627     case TCODE_WRITE_BLOCK_REQUEST:
0628     case TCODE_READ_QUADLET_REQUEST:
0629     case TCODE_READ_BLOCK_REQUEST:
0630     case TCODE_LOCK_MASK_SWAP:
0631     case TCODE_LOCK_COMPARE_SWAP:
0632     case TCODE_LOCK_FETCH_ADD:
0633     case TCODE_LOCK_LITTLE_ADD:
0634     case TCODE_LOCK_BOUNDED_ADD:
0635     case TCODE_LOCK_WRAP_ADD:
0636     case TCODE_LOCK_VENDOR_DEPENDENT:
0637         break;
0638     default:
0639         return -EINVAL;
0640     }
0641 
0642     return init_request(client, &arg->send_request, client->device->node_id,
0643                 client->device->max_speed);
0644 }
0645 
0646 static inline bool is_fcp_request(struct fw_request *request)
0647 {
0648     return request == NULL;
0649 }
0650 
0651 static void release_request(struct client *client,
0652                 struct client_resource *resource)
0653 {
0654     struct inbound_transaction_resource *r = container_of(resource,
0655             struct inbound_transaction_resource, resource);
0656 
0657     if (is_fcp_request(r->request))
0658         kfree(r->data);
0659     else
0660         fw_send_response(r->card, r->request, RCODE_CONFLICT_ERROR);
0661 
0662     fw_card_put(r->card);
0663     kfree(r);
0664 }
0665 
0666 static void handle_request(struct fw_card *card, struct fw_request *request,
0667                int tcode, int destination, int source,
0668                int generation, unsigned long long offset,
0669                void *payload, size_t length, void *callback_data)
0670 {
0671     struct address_handler_resource *handler = callback_data;
0672     struct inbound_transaction_resource *r;
0673     struct inbound_transaction_event *e;
0674     size_t event_size0;
0675     void *fcp_frame = NULL;
0676     int ret;
0677 
0678     /* card may be different from handler->client->device->card */
0679     fw_card_get(card);
0680 
0681     r = kmalloc(sizeof(*r), GFP_ATOMIC);
0682     e = kmalloc(sizeof(*e), GFP_ATOMIC);
0683     if (r == NULL || e == NULL)
0684         goto failed;
0685 
0686     r->card    = card;
0687     r->request = request;
0688     r->data    = payload;
0689     r->length  = length;
0690 
0691     if (is_fcp_request(request)) {
0692         /*
0693          * FIXME: Let core-transaction.c manage a
0694          * single reference-counted copy?
0695          */
0696         fcp_frame = kmemdup(payload, length, GFP_ATOMIC);
0697         if (fcp_frame == NULL)
0698             goto failed;
0699 
0700         r->data = fcp_frame;
0701     }
0702 
0703     r->resource.release = release_request;
0704     ret = add_client_resource(handler->client, &r->resource, GFP_ATOMIC);
0705     if (ret < 0)
0706         goto failed;
0707 
0708     if (handler->client->version < FW_CDEV_VERSION_EVENT_REQUEST2) {
0709         struct fw_cdev_event_request *req = &e->req.request;
0710 
0711         if (tcode & 0x10)
0712             tcode = TCODE_LOCK_REQUEST;
0713 
0714         req->type   = FW_CDEV_EVENT_REQUEST;
0715         req->tcode  = tcode;
0716         req->offset = offset;
0717         req->length = length;
0718         req->handle = r->resource.handle;
0719         req->closure    = handler->closure;
0720         event_size0 = sizeof(*req);
0721     } else {
0722         struct fw_cdev_event_request2 *req = &e->req.request2;
0723 
0724         req->type   = FW_CDEV_EVENT_REQUEST2;
0725         req->tcode  = tcode;
0726         req->offset = offset;
0727         req->source_node_id = source;
0728         req->destination_node_id = destination;
0729         req->card   = card->index;
0730         req->generation = generation;
0731         req->length = length;
0732         req->handle = r->resource.handle;
0733         req->closure    = handler->closure;
0734         event_size0 = sizeof(*req);
0735     }
0736 
0737     queue_event(handler->client, &e->event,
0738             &e->req, event_size0, r->data, length);
0739     return;
0740 
0741  failed:
0742     kfree(r);
0743     kfree(e);
0744     kfree(fcp_frame);
0745 
0746     if (!is_fcp_request(request))
0747         fw_send_response(card, request, RCODE_CONFLICT_ERROR);
0748 
0749     fw_card_put(card);
0750 }
0751 
0752 static void release_address_handler(struct client *client,
0753                     struct client_resource *resource)
0754 {
0755     struct address_handler_resource *r =
0756         container_of(resource, struct address_handler_resource, resource);
0757 
0758     fw_core_remove_address_handler(&r->handler);
0759     kfree(r);
0760 }
0761 
0762 static int ioctl_allocate(struct client *client, union ioctl_arg *arg)
0763 {
0764     struct fw_cdev_allocate *a = &arg->allocate;
0765     struct address_handler_resource *r;
0766     struct fw_address_region region;
0767     int ret;
0768 
0769     r = kmalloc(sizeof(*r), GFP_KERNEL);
0770     if (r == NULL)
0771         return -ENOMEM;
0772 
0773     region.start = a->offset;
0774     if (client->version < FW_CDEV_VERSION_ALLOCATE_REGION_END)
0775         region.end = a->offset + a->length;
0776     else
0777         region.end = a->region_end;
0778 
0779     r->handler.length           = a->length;
0780     r->handler.address_callback = handle_request;
0781     r->handler.callback_data    = r;
0782     r->closure   = a->closure;
0783     r->client    = client;
0784 
0785     ret = fw_core_add_address_handler(&r->handler, &region);
0786     if (ret < 0) {
0787         kfree(r);
0788         return ret;
0789     }
0790     a->offset = r->handler.offset;
0791 
0792     r->resource.release = release_address_handler;
0793     ret = add_client_resource(client, &r->resource, GFP_KERNEL);
0794     if (ret < 0) {
0795         release_address_handler(client, &r->resource);
0796         return ret;
0797     }
0798     a->handle = r->resource.handle;
0799 
0800     return 0;
0801 }
0802 
0803 static int ioctl_deallocate(struct client *client, union ioctl_arg *arg)
0804 {
0805     return release_client_resource(client, arg->deallocate.handle,
0806                        release_address_handler, NULL);
0807 }
0808 
0809 static int ioctl_send_response(struct client *client, union ioctl_arg *arg)
0810 {
0811     struct fw_cdev_send_response *a = &arg->send_response;
0812     struct client_resource *resource;
0813     struct inbound_transaction_resource *r;
0814     int ret = 0;
0815 
0816     if (release_client_resource(client, a->handle,
0817                     release_request, &resource) < 0)
0818         return -EINVAL;
0819 
0820     r = container_of(resource, struct inbound_transaction_resource,
0821              resource);
0822     if (is_fcp_request(r->request))
0823         goto out;
0824 
0825     if (a->length != fw_get_response_length(r->request)) {
0826         ret = -EINVAL;
0827         kfree(r->request);
0828         goto out;
0829     }
0830     if (copy_from_user(r->data, u64_to_uptr(a->data), a->length)) {
0831         ret = -EFAULT;
0832         kfree(r->request);
0833         goto out;
0834     }
0835     fw_send_response(r->card, r->request, a->rcode);
0836  out:
0837     fw_card_put(r->card);
0838     kfree(r);
0839 
0840     return ret;
0841 }
0842 
0843 static int ioctl_initiate_bus_reset(struct client *client, union ioctl_arg *arg)
0844 {
0845     fw_schedule_bus_reset(client->device->card, true,
0846             arg->initiate_bus_reset.type == FW_CDEV_SHORT_RESET);
0847     return 0;
0848 }
0849 
0850 static void release_descriptor(struct client *client,
0851                    struct client_resource *resource)
0852 {
0853     struct descriptor_resource *r =
0854         container_of(resource, struct descriptor_resource, resource);
0855 
0856     fw_core_remove_descriptor(&r->descriptor);
0857     kfree(r);
0858 }
0859 
0860 static int ioctl_add_descriptor(struct client *client, union ioctl_arg *arg)
0861 {
0862     struct fw_cdev_add_descriptor *a = &arg->add_descriptor;
0863     struct descriptor_resource *r;
0864     int ret;
0865 
0866     /* Access policy: Allow this ioctl only on local nodes' device files. */
0867     if (!client->device->is_local)
0868         return -ENOSYS;
0869 
0870     if (a->length > 256)
0871         return -EINVAL;
0872 
0873     r = kmalloc(sizeof(*r) + a->length * 4, GFP_KERNEL);
0874     if (r == NULL)
0875         return -ENOMEM;
0876 
0877     if (copy_from_user(r->data, u64_to_uptr(a->data), a->length * 4)) {
0878         ret = -EFAULT;
0879         goto failed;
0880     }
0881 
0882     r->descriptor.length    = a->length;
0883     r->descriptor.immediate = a->immediate;
0884     r->descriptor.key       = a->key;
0885     r->descriptor.data      = r->data;
0886 
0887     ret = fw_core_add_descriptor(&r->descriptor);
0888     if (ret < 0)
0889         goto failed;
0890 
0891     r->resource.release = release_descriptor;
0892     ret = add_client_resource(client, &r->resource, GFP_KERNEL);
0893     if (ret < 0) {
0894         fw_core_remove_descriptor(&r->descriptor);
0895         goto failed;
0896     }
0897     a->handle = r->resource.handle;
0898 
0899     return 0;
0900  failed:
0901     kfree(r);
0902 
0903     return ret;
0904 }
0905 
0906 static int ioctl_remove_descriptor(struct client *client, union ioctl_arg *arg)
0907 {
0908     return release_client_resource(client, arg->remove_descriptor.handle,
0909                        release_descriptor, NULL);
0910 }
0911 
0912 static void iso_callback(struct fw_iso_context *context, u32 cycle,
0913              size_t header_length, void *header, void *data)
0914 {
0915     struct client *client = data;
0916     struct iso_interrupt_event *e;
0917 
0918     e = kmalloc(sizeof(*e) + header_length, GFP_ATOMIC);
0919     if (e == NULL)
0920         return;
0921 
0922     e->interrupt.type      = FW_CDEV_EVENT_ISO_INTERRUPT;
0923     e->interrupt.closure   = client->iso_closure;
0924     e->interrupt.cycle     = cycle;
0925     e->interrupt.header_length = header_length;
0926     memcpy(e->interrupt.header, header, header_length);
0927     queue_event(client, &e->event, &e->interrupt,
0928             sizeof(e->interrupt) + header_length, NULL, 0);
0929 }
0930 
0931 static void iso_mc_callback(struct fw_iso_context *context,
0932                 dma_addr_t completed, void *data)
0933 {
0934     struct client *client = data;
0935     struct iso_interrupt_mc_event *e;
0936 
0937     e = kmalloc(sizeof(*e), GFP_ATOMIC);
0938     if (e == NULL)
0939         return;
0940 
0941     e->interrupt.type      = FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL;
0942     e->interrupt.closure   = client->iso_closure;
0943     e->interrupt.completed = fw_iso_buffer_lookup(&client->buffer,
0944                               completed);
0945     queue_event(client, &e->event, &e->interrupt,
0946             sizeof(e->interrupt), NULL, 0);
0947 }
0948 
0949 static enum dma_data_direction iso_dma_direction(struct fw_iso_context *context)
0950 {
0951         if (context->type == FW_ISO_CONTEXT_TRANSMIT)
0952             return DMA_TO_DEVICE;
0953         else
0954             return DMA_FROM_DEVICE;
0955 }
0956 
0957 static struct fw_iso_context *fw_iso_mc_context_create(struct fw_card *card,
0958                         fw_iso_mc_callback_t callback,
0959                         void *callback_data)
0960 {
0961     struct fw_iso_context *ctx;
0962 
0963     ctx = fw_iso_context_create(card, FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL,
0964                     0, 0, 0, NULL, callback_data);
0965     if (!IS_ERR(ctx))
0966         ctx->callback.mc = callback;
0967 
0968     return ctx;
0969 }
0970 
0971 static int ioctl_create_iso_context(struct client *client, union ioctl_arg *arg)
0972 {
0973     struct fw_cdev_create_iso_context *a = &arg->create_iso_context;
0974     struct fw_iso_context *context;
0975     union fw_iso_callback cb;
0976     int ret;
0977 
0978     BUILD_BUG_ON(FW_CDEV_ISO_CONTEXT_TRANSMIT != FW_ISO_CONTEXT_TRANSMIT ||
0979              FW_CDEV_ISO_CONTEXT_RECEIVE  != FW_ISO_CONTEXT_RECEIVE  ||
0980              FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL !=
0981                     FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL);
0982 
0983     switch (a->type) {
0984     case FW_ISO_CONTEXT_TRANSMIT:
0985         if (a->speed > SCODE_3200 || a->channel > 63)
0986             return -EINVAL;
0987 
0988         cb.sc = iso_callback;
0989         break;
0990 
0991     case FW_ISO_CONTEXT_RECEIVE:
0992         if (a->header_size < 4 || (a->header_size & 3) ||
0993             a->channel > 63)
0994             return -EINVAL;
0995 
0996         cb.sc = iso_callback;
0997         break;
0998 
0999     case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
1000         cb.mc = iso_mc_callback;
1001         break;
1002 
1003     default:
1004         return -EINVAL;
1005     }
1006 
1007     if (a->type == FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL)
1008         context = fw_iso_mc_context_create(client->device->card, cb.mc,
1009                            client);
1010     else
1011         context = fw_iso_context_create(client->device->card, a->type,
1012                         a->channel, a->speed,
1013                         a->header_size, cb.sc, client);
1014     if (IS_ERR(context))
1015         return PTR_ERR(context);
1016     if (client->version < FW_CDEV_VERSION_AUTO_FLUSH_ISO_OVERFLOW)
1017         context->drop_overflow_headers = true;
1018 
1019     /* We only support one context at this time. */
1020     spin_lock_irq(&client->lock);
1021     if (client->iso_context != NULL) {
1022         spin_unlock_irq(&client->lock);
1023         fw_iso_context_destroy(context);
1024 
1025         return -EBUSY;
1026     }
1027     if (!client->buffer_is_mapped) {
1028         ret = fw_iso_buffer_map_dma(&client->buffer,
1029                         client->device->card,
1030                         iso_dma_direction(context));
1031         if (ret < 0) {
1032             spin_unlock_irq(&client->lock);
1033             fw_iso_context_destroy(context);
1034 
1035             return ret;
1036         }
1037         client->buffer_is_mapped = true;
1038     }
1039     client->iso_closure = a->closure;
1040     client->iso_context = context;
1041     spin_unlock_irq(&client->lock);
1042 
1043     a->handle = 0;
1044 
1045     return 0;
1046 }
1047 
1048 static int ioctl_set_iso_channels(struct client *client, union ioctl_arg *arg)
1049 {
1050     struct fw_cdev_set_iso_channels *a = &arg->set_iso_channels;
1051     struct fw_iso_context *ctx = client->iso_context;
1052 
1053     if (ctx == NULL || a->handle != 0)
1054         return -EINVAL;
1055 
1056     return fw_iso_context_set_channels(ctx, &a->channels);
1057 }
1058 
1059 /* Macros for decoding the iso packet control header. */
1060 #define GET_PAYLOAD_LENGTH(v)   ((v) & 0xffff)
1061 #define GET_INTERRUPT(v)    (((v) >> 16) & 0x01)
1062 #define GET_SKIP(v)     (((v) >> 17) & 0x01)
1063 #define GET_TAG(v)      (((v) >> 18) & 0x03)
1064 #define GET_SY(v)       (((v) >> 20) & 0x0f)
1065 #define GET_HEADER_LENGTH(v)    (((v) >> 24) & 0xff)
1066 
1067 static int ioctl_queue_iso(struct client *client, union ioctl_arg *arg)
1068 {
1069     struct fw_cdev_queue_iso *a = &arg->queue_iso;
1070     struct fw_cdev_iso_packet __user *p, *end, *next;
1071     struct fw_iso_context *ctx = client->iso_context;
1072     unsigned long payload, buffer_end, transmit_header_bytes = 0;
1073     u32 control;
1074     int count;
1075     struct {
1076         struct fw_iso_packet packet;
1077         u8 header[256];
1078     } u;
1079 
1080     if (ctx == NULL || a->handle != 0)
1081         return -EINVAL;
1082 
1083     /*
1084      * If the user passes a non-NULL data pointer, has mmap()'ed
1085      * the iso buffer, and the pointer points inside the buffer,
1086      * we setup the payload pointers accordingly.  Otherwise we
1087      * set them both to 0, which will still let packets with
1088      * payload_length == 0 through.  In other words, if no packets
1089      * use the indirect payload, the iso buffer need not be mapped
1090      * and the a->data pointer is ignored.
1091      */
1092     payload = (unsigned long)a->data - client->vm_start;
1093     buffer_end = client->buffer.page_count << PAGE_SHIFT;
1094     if (a->data == 0 || client->buffer.pages == NULL ||
1095         payload >= buffer_end) {
1096         payload = 0;
1097         buffer_end = 0;
1098     }
1099 
1100     if (ctx->type == FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL && payload & 3)
1101         return -EINVAL;
1102 
1103     p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(a->packets);
1104 
1105     end = (void __user *)p + a->size;
1106     count = 0;
1107     while (p < end) {
1108         if (get_user(control, &p->control))
1109             return -EFAULT;
1110         u.packet.payload_length = GET_PAYLOAD_LENGTH(control);
1111         u.packet.interrupt = GET_INTERRUPT(control);
1112         u.packet.skip = GET_SKIP(control);
1113         u.packet.tag = GET_TAG(control);
1114         u.packet.sy = GET_SY(control);
1115         u.packet.header_length = GET_HEADER_LENGTH(control);
1116 
1117         switch (ctx->type) {
1118         case FW_ISO_CONTEXT_TRANSMIT:
1119             if (u.packet.header_length & 3)
1120                 return -EINVAL;
1121             transmit_header_bytes = u.packet.header_length;
1122             break;
1123 
1124         case FW_ISO_CONTEXT_RECEIVE:
1125             if (u.packet.header_length == 0 ||
1126                 u.packet.header_length % ctx->header_size != 0)
1127                 return -EINVAL;
1128             break;
1129 
1130         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
1131             if (u.packet.payload_length == 0 ||
1132                 u.packet.payload_length & 3)
1133                 return -EINVAL;
1134             break;
1135         }
1136 
1137         next = (struct fw_cdev_iso_packet __user *)
1138             &p->header[transmit_header_bytes / 4];
1139         if (next > end)
1140             return -EINVAL;
1141         if (copy_from_user
1142             (u.packet.header, p->header, transmit_header_bytes))
1143             return -EFAULT;
1144         if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
1145             u.packet.header_length + u.packet.payload_length > 0)
1146             return -EINVAL;
1147         if (payload + u.packet.payload_length > buffer_end)
1148             return -EINVAL;
1149 
1150         if (fw_iso_context_queue(ctx, &u.packet,
1151                      &client->buffer, payload))
1152             break;
1153 
1154         p = next;
1155         payload += u.packet.payload_length;
1156         count++;
1157     }
1158     fw_iso_context_queue_flush(ctx);
1159 
1160     a->size    -= uptr_to_u64(p) - a->packets;
1161     a->packets  = uptr_to_u64(p);
1162     a->data     = client->vm_start + payload;
1163 
1164     return count;
1165 }
1166 
1167 static int ioctl_start_iso(struct client *client, union ioctl_arg *arg)
1168 {
1169     struct fw_cdev_start_iso *a = &arg->start_iso;
1170 
1171     BUILD_BUG_ON(
1172         FW_CDEV_ISO_CONTEXT_MATCH_TAG0 != FW_ISO_CONTEXT_MATCH_TAG0 ||
1173         FW_CDEV_ISO_CONTEXT_MATCH_TAG1 != FW_ISO_CONTEXT_MATCH_TAG1 ||
1174         FW_CDEV_ISO_CONTEXT_MATCH_TAG2 != FW_ISO_CONTEXT_MATCH_TAG2 ||
1175         FW_CDEV_ISO_CONTEXT_MATCH_TAG3 != FW_ISO_CONTEXT_MATCH_TAG3 ||
1176         FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS != FW_ISO_CONTEXT_MATCH_ALL_TAGS);
1177 
1178     if (client->iso_context == NULL || a->handle != 0)
1179         return -EINVAL;
1180 
1181     if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE &&
1182         (a->tags == 0 || a->tags > 15 || a->sync > 15))
1183         return -EINVAL;
1184 
1185     return fw_iso_context_start(client->iso_context,
1186                     a->cycle, a->sync, a->tags);
1187 }
1188 
1189 static int ioctl_stop_iso(struct client *client, union ioctl_arg *arg)
1190 {
1191     struct fw_cdev_stop_iso *a = &arg->stop_iso;
1192 
1193     if (client->iso_context == NULL || a->handle != 0)
1194         return -EINVAL;
1195 
1196     return fw_iso_context_stop(client->iso_context);
1197 }
1198 
1199 static int ioctl_flush_iso(struct client *client, union ioctl_arg *arg)
1200 {
1201     struct fw_cdev_flush_iso *a = &arg->flush_iso;
1202 
1203     if (client->iso_context == NULL || a->handle != 0)
1204         return -EINVAL;
1205 
1206     return fw_iso_context_flush_completions(client->iso_context);
1207 }
1208 
1209 static int ioctl_get_cycle_timer2(struct client *client, union ioctl_arg *arg)
1210 {
1211     struct fw_cdev_get_cycle_timer2 *a = &arg->get_cycle_timer2;
1212     struct fw_card *card = client->device->card;
1213     struct timespec64 ts = {0, 0};
1214     u32 cycle_time = 0;
1215     int ret = 0;
1216 
1217     local_irq_disable();
1218 
1219     ret = fw_card_read_cycle_time(card, &cycle_time);
1220     if (ret < 0)
1221         goto end;
1222 
1223     switch (a->clk_id) {
1224     case CLOCK_REALTIME:      ktime_get_real_ts64(&ts); break;
1225     case CLOCK_MONOTONIC:     ktime_get_ts64(&ts);      break;
1226     case CLOCK_MONOTONIC_RAW: ktime_get_raw_ts64(&ts);  break;
1227     default:
1228         ret = -EINVAL;
1229     }
1230 end:
1231     local_irq_enable();
1232 
1233     a->tv_sec      = ts.tv_sec;
1234     a->tv_nsec     = ts.tv_nsec;
1235     a->cycle_timer = cycle_time;
1236 
1237     return ret;
1238 }
1239 
1240 static int ioctl_get_cycle_timer(struct client *client, union ioctl_arg *arg)
1241 {
1242     struct fw_cdev_get_cycle_timer *a = &arg->get_cycle_timer;
1243     struct fw_cdev_get_cycle_timer2 ct2;
1244 
1245     ct2.clk_id = CLOCK_REALTIME;
1246     ioctl_get_cycle_timer2(client, (union ioctl_arg *)&ct2);
1247 
1248     a->local_time = ct2.tv_sec * USEC_PER_SEC + ct2.tv_nsec / NSEC_PER_USEC;
1249     a->cycle_timer = ct2.cycle_timer;
1250 
1251     return 0;
1252 }
1253 
1254 static void iso_resource_work(struct work_struct *work)
1255 {
1256     struct iso_resource_event *e;
1257     struct iso_resource *r =
1258             container_of(work, struct iso_resource, work.work);
1259     struct client *client = r->client;
1260     int generation, channel, bandwidth, todo;
1261     bool skip, free, success;
1262 
1263     spin_lock_irq(&client->lock);
1264     generation = client->device->generation;
1265     todo = r->todo;
1266     /* Allow 1000ms grace period for other reallocations. */
1267     if (todo == ISO_RES_ALLOC &&
1268         time_before64(get_jiffies_64(),
1269               client->device->card->reset_jiffies + HZ)) {
1270         schedule_iso_resource(r, DIV_ROUND_UP(HZ, 3));
1271         skip = true;
1272     } else {
1273         /* We could be called twice within the same generation. */
1274         skip = todo == ISO_RES_REALLOC &&
1275                r->generation == generation;
1276     }
1277     free = todo == ISO_RES_DEALLOC ||
1278            todo == ISO_RES_ALLOC_ONCE ||
1279            todo == ISO_RES_DEALLOC_ONCE;
1280     r->generation = generation;
1281     spin_unlock_irq(&client->lock);
1282 
1283     if (skip)
1284         goto out;
1285 
1286     bandwidth = r->bandwidth;
1287 
1288     fw_iso_resource_manage(client->device->card, generation,
1289             r->channels, &channel, &bandwidth,
1290             todo == ISO_RES_ALLOC ||
1291             todo == ISO_RES_REALLOC ||
1292             todo == ISO_RES_ALLOC_ONCE);
1293     /*
1294      * Is this generation outdated already?  As long as this resource sticks
1295      * in the idr, it will be scheduled again for a newer generation or at
1296      * shutdown.
1297      */
1298     if (channel == -EAGAIN &&
1299         (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC))
1300         goto out;
1301 
1302     success = channel >= 0 || bandwidth > 0;
1303 
1304     spin_lock_irq(&client->lock);
1305     /*
1306      * Transit from allocation to reallocation, except if the client
1307      * requested deallocation in the meantime.
1308      */
1309     if (r->todo == ISO_RES_ALLOC)
1310         r->todo = ISO_RES_REALLOC;
1311     /*
1312      * Allocation or reallocation failure?  Pull this resource out of the
1313      * idr and prepare for deletion, unless the client is shutting down.
1314      */
1315     if (r->todo == ISO_RES_REALLOC && !success &&
1316         !client->in_shutdown &&
1317         idr_remove(&client->resource_idr, r->resource.handle)) {
1318         client_put(client);
1319         free = true;
1320     }
1321     spin_unlock_irq(&client->lock);
1322 
1323     if (todo == ISO_RES_ALLOC && channel >= 0)
1324         r->channels = 1ULL << channel;
1325 
1326     if (todo == ISO_RES_REALLOC && success)
1327         goto out;
1328 
1329     if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) {
1330         e = r->e_alloc;
1331         r->e_alloc = NULL;
1332     } else {
1333         e = r->e_dealloc;
1334         r->e_dealloc = NULL;
1335     }
1336     e->iso_resource.handle    = r->resource.handle;
1337     e->iso_resource.channel   = channel;
1338     e->iso_resource.bandwidth = bandwidth;
1339 
1340     queue_event(client, &e->event,
1341             &e->iso_resource, sizeof(e->iso_resource), NULL, 0);
1342 
1343     if (free) {
1344         cancel_delayed_work(&r->work);
1345         kfree(r->e_alloc);
1346         kfree(r->e_dealloc);
1347         kfree(r);
1348     }
1349  out:
1350     client_put(client);
1351 }
1352 
1353 static void release_iso_resource(struct client *client,
1354                  struct client_resource *resource)
1355 {
1356     struct iso_resource *r =
1357         container_of(resource, struct iso_resource, resource);
1358 
1359     spin_lock_irq(&client->lock);
1360     r->todo = ISO_RES_DEALLOC;
1361     schedule_iso_resource(r, 0);
1362     spin_unlock_irq(&client->lock);
1363 }
1364 
1365 static int init_iso_resource(struct client *client,
1366         struct fw_cdev_allocate_iso_resource *request, int todo)
1367 {
1368     struct iso_resource_event *e1, *e2;
1369     struct iso_resource *r;
1370     int ret;
1371 
1372     if ((request->channels == 0 && request->bandwidth == 0) ||
1373         request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL)
1374         return -EINVAL;
1375 
1376     r  = kmalloc(sizeof(*r), GFP_KERNEL);
1377     e1 = kmalloc(sizeof(*e1), GFP_KERNEL);
1378     e2 = kmalloc(sizeof(*e2), GFP_KERNEL);
1379     if (r == NULL || e1 == NULL || e2 == NULL) {
1380         ret = -ENOMEM;
1381         goto fail;
1382     }
1383 
1384     INIT_DELAYED_WORK(&r->work, iso_resource_work);
1385     r->client   = client;
1386     r->todo     = todo;
1387     r->generation   = -1;
1388     r->channels = request->channels;
1389     r->bandwidth    = request->bandwidth;
1390     r->e_alloc  = e1;
1391     r->e_dealloc    = e2;
1392 
1393     e1->iso_resource.closure = request->closure;
1394     e1->iso_resource.type    = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED;
1395     e2->iso_resource.closure = request->closure;
1396     e2->iso_resource.type    = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED;
1397 
1398     if (todo == ISO_RES_ALLOC) {
1399         r->resource.release = release_iso_resource;
1400         ret = add_client_resource(client, &r->resource, GFP_KERNEL);
1401         if (ret < 0)
1402             goto fail;
1403     } else {
1404         r->resource.release = NULL;
1405         r->resource.handle = -1;
1406         schedule_iso_resource(r, 0);
1407     }
1408     request->handle = r->resource.handle;
1409 
1410     return 0;
1411  fail:
1412     kfree(r);
1413     kfree(e1);
1414     kfree(e2);
1415 
1416     return ret;
1417 }
1418 
1419 static int ioctl_allocate_iso_resource(struct client *client,
1420                        union ioctl_arg *arg)
1421 {
1422     return init_iso_resource(client,
1423             &arg->allocate_iso_resource, ISO_RES_ALLOC);
1424 }
1425 
1426 static int ioctl_deallocate_iso_resource(struct client *client,
1427                      union ioctl_arg *arg)
1428 {
1429     return release_client_resource(client,
1430             arg->deallocate.handle, release_iso_resource, NULL);
1431 }
1432 
1433 static int ioctl_allocate_iso_resource_once(struct client *client,
1434                         union ioctl_arg *arg)
1435 {
1436     return init_iso_resource(client,
1437             &arg->allocate_iso_resource, ISO_RES_ALLOC_ONCE);
1438 }
1439 
1440 static int ioctl_deallocate_iso_resource_once(struct client *client,
1441                           union ioctl_arg *arg)
1442 {
1443     return init_iso_resource(client,
1444             &arg->allocate_iso_resource, ISO_RES_DEALLOC_ONCE);
1445 }
1446 
1447 /*
1448  * Returns a speed code:  Maximum speed to or from this device,
1449  * limited by the device's link speed, the local node's link speed,
1450  * and all PHY port speeds between the two links.
1451  */
1452 static int ioctl_get_speed(struct client *client, union ioctl_arg *arg)
1453 {
1454     return client->device->max_speed;
1455 }
1456 
1457 static int ioctl_send_broadcast_request(struct client *client,
1458                     union ioctl_arg *arg)
1459 {
1460     struct fw_cdev_send_request *a = &arg->send_request;
1461 
1462     switch (a->tcode) {
1463     case TCODE_WRITE_QUADLET_REQUEST:
1464     case TCODE_WRITE_BLOCK_REQUEST:
1465         break;
1466     default:
1467         return -EINVAL;
1468     }
1469 
1470     /* Security policy: Only allow accesses to Units Space. */
1471     if (a->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END)
1472         return -EACCES;
1473 
1474     return init_request(client, a, LOCAL_BUS | 0x3f, SCODE_100);
1475 }
1476 
1477 static int ioctl_send_stream_packet(struct client *client, union ioctl_arg *arg)
1478 {
1479     struct fw_cdev_send_stream_packet *a = &arg->send_stream_packet;
1480     struct fw_cdev_send_request request;
1481     int dest;
1482 
1483     if (a->speed > client->device->card->link_speed ||
1484         a->length > 1024 << a->speed)
1485         return -EIO;
1486 
1487     if (a->tag > 3 || a->channel > 63 || a->sy > 15)
1488         return -EINVAL;
1489 
1490     dest = fw_stream_packet_destination_id(a->tag, a->channel, a->sy);
1491     request.tcode       = TCODE_STREAM_DATA;
1492     request.length      = a->length;
1493     request.closure     = a->closure;
1494     request.data        = a->data;
1495     request.generation  = a->generation;
1496 
1497     return init_request(client, &request, dest, a->speed);
1498 }
1499 
1500 static void outbound_phy_packet_callback(struct fw_packet *packet,
1501                      struct fw_card *card, int status)
1502 {
1503     struct outbound_phy_packet_event *e =
1504         container_of(packet, struct outbound_phy_packet_event, p);
1505     struct client *e_client;
1506 
1507     switch (status) {
1508     /* expected: */
1509     case ACK_COMPLETE:  e->phy_packet.rcode = RCODE_COMPLETE;   break;
1510     /* should never happen with PHY packets: */
1511     case ACK_PENDING:   e->phy_packet.rcode = RCODE_COMPLETE;   break;
1512     case ACK_BUSY_X:
1513     case ACK_BUSY_A:
1514     case ACK_BUSY_B:    e->phy_packet.rcode = RCODE_BUSY;   break;
1515     case ACK_DATA_ERROR:    e->phy_packet.rcode = RCODE_DATA_ERROR; break;
1516     case ACK_TYPE_ERROR:    e->phy_packet.rcode = RCODE_TYPE_ERROR; break;
1517     /* stale generation; cancelled; on certain controllers: no ack */
1518     default:        e->phy_packet.rcode = status;       break;
1519     }
1520     e->phy_packet.data[0] = packet->timestamp;
1521 
1522     e_client = e->client;
1523     queue_event(e->client, &e->event, &e->phy_packet,
1524             sizeof(e->phy_packet) + e->phy_packet.length, NULL, 0);
1525     client_put(e_client);
1526 }
1527 
1528 static int ioctl_send_phy_packet(struct client *client, union ioctl_arg *arg)
1529 {
1530     struct fw_cdev_send_phy_packet *a = &arg->send_phy_packet;
1531     struct fw_card *card = client->device->card;
1532     struct outbound_phy_packet_event *e;
1533 
1534     /* Access policy: Allow this ioctl only on local nodes' device files. */
1535     if (!client->device->is_local)
1536         return -ENOSYS;
1537 
1538     e = kzalloc(sizeof(*e) + 4, GFP_KERNEL);
1539     if (e == NULL)
1540         return -ENOMEM;
1541 
1542     client_get(client);
1543     e->client       = client;
1544     e->p.speed      = SCODE_100;
1545     e->p.generation     = a->generation;
1546     e->p.header[0]      = TCODE_LINK_INTERNAL << 4;
1547     e->p.header[1]      = a->data[0];
1548     e->p.header[2]      = a->data[1];
1549     e->p.header_length  = 12;
1550     e->p.callback       = outbound_phy_packet_callback;
1551     e->phy_packet.closure   = a->closure;
1552     e->phy_packet.type  = FW_CDEV_EVENT_PHY_PACKET_SENT;
1553     if (is_ping_packet(a->data))
1554             e->phy_packet.length = 4;
1555 
1556     card->driver->send_request(card, &e->p);
1557 
1558     return 0;
1559 }
1560 
1561 static int ioctl_receive_phy_packets(struct client *client, union ioctl_arg *arg)
1562 {
1563     struct fw_cdev_receive_phy_packets *a = &arg->receive_phy_packets;
1564     struct fw_card *card = client->device->card;
1565 
1566     /* Access policy: Allow this ioctl only on local nodes' device files. */
1567     if (!client->device->is_local)
1568         return -ENOSYS;
1569 
1570     spin_lock_irq(&card->lock);
1571 
1572     list_move_tail(&client->phy_receiver_link, &card->phy_receiver_list);
1573     client->phy_receiver_closure = a->closure;
1574 
1575     spin_unlock_irq(&card->lock);
1576 
1577     return 0;
1578 }
1579 
1580 void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p)
1581 {
1582     struct client *client;
1583     struct inbound_phy_packet_event *e;
1584     unsigned long flags;
1585 
1586     spin_lock_irqsave(&card->lock, flags);
1587 
1588     list_for_each_entry(client, &card->phy_receiver_list, phy_receiver_link) {
1589         e = kmalloc(sizeof(*e) + 8, GFP_ATOMIC);
1590         if (e == NULL)
1591             break;
1592 
1593         e->phy_packet.closure   = client->phy_receiver_closure;
1594         e->phy_packet.type  = FW_CDEV_EVENT_PHY_PACKET_RECEIVED;
1595         e->phy_packet.rcode = RCODE_COMPLETE;
1596         e->phy_packet.length    = 8;
1597         e->phy_packet.data[0]   = p->header[1];
1598         e->phy_packet.data[1]   = p->header[2];
1599         queue_event(client, &e->event,
1600                 &e->phy_packet, sizeof(e->phy_packet) + 8, NULL, 0);
1601     }
1602 
1603     spin_unlock_irqrestore(&card->lock, flags);
1604 }
1605 
1606 static int (* const ioctl_handlers[])(struct client *, union ioctl_arg *) = {
1607     [0x00] = ioctl_get_info,
1608     [0x01] = ioctl_send_request,
1609     [0x02] = ioctl_allocate,
1610     [0x03] = ioctl_deallocate,
1611     [0x04] = ioctl_send_response,
1612     [0x05] = ioctl_initiate_bus_reset,
1613     [0x06] = ioctl_add_descriptor,
1614     [0x07] = ioctl_remove_descriptor,
1615     [0x08] = ioctl_create_iso_context,
1616     [0x09] = ioctl_queue_iso,
1617     [0x0a] = ioctl_start_iso,
1618     [0x0b] = ioctl_stop_iso,
1619     [0x0c] = ioctl_get_cycle_timer,
1620     [0x0d] = ioctl_allocate_iso_resource,
1621     [0x0e] = ioctl_deallocate_iso_resource,
1622     [0x0f] = ioctl_allocate_iso_resource_once,
1623     [0x10] = ioctl_deallocate_iso_resource_once,
1624     [0x11] = ioctl_get_speed,
1625     [0x12] = ioctl_send_broadcast_request,
1626     [0x13] = ioctl_send_stream_packet,
1627     [0x14] = ioctl_get_cycle_timer2,
1628     [0x15] = ioctl_send_phy_packet,
1629     [0x16] = ioctl_receive_phy_packets,
1630     [0x17] = ioctl_set_iso_channels,
1631     [0x18] = ioctl_flush_iso,
1632 };
1633 
1634 static int dispatch_ioctl(struct client *client,
1635               unsigned int cmd, void __user *arg)
1636 {
1637     union ioctl_arg buffer;
1638     int ret;
1639 
1640     if (fw_device_is_shutdown(client->device))
1641         return -ENODEV;
1642 
1643     if (_IOC_TYPE(cmd) != '#' ||
1644         _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers) ||
1645         _IOC_SIZE(cmd) > sizeof(buffer))
1646         return -ENOTTY;
1647 
1648     memset(&buffer, 0, sizeof(buffer));
1649 
1650     if (_IOC_DIR(cmd) & _IOC_WRITE)
1651         if (copy_from_user(&buffer, arg, _IOC_SIZE(cmd)))
1652             return -EFAULT;
1653 
1654     ret = ioctl_handlers[_IOC_NR(cmd)](client, &buffer);
1655     if (ret < 0)
1656         return ret;
1657 
1658     if (_IOC_DIR(cmd) & _IOC_READ)
1659         if (copy_to_user(arg, &buffer, _IOC_SIZE(cmd)))
1660             return -EFAULT;
1661 
1662     return ret;
1663 }
1664 
1665 static long fw_device_op_ioctl(struct file *file,
1666                    unsigned int cmd, unsigned long arg)
1667 {
1668     return dispatch_ioctl(file->private_data, cmd, (void __user *)arg);
1669 }
1670 
1671 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
1672 {
1673     struct client *client = file->private_data;
1674     unsigned long size;
1675     int page_count, ret;
1676 
1677     if (fw_device_is_shutdown(client->device))
1678         return -ENODEV;
1679 
1680     /* FIXME: We could support multiple buffers, but we don't. */
1681     if (client->buffer.pages != NULL)
1682         return -EBUSY;
1683 
1684     if (!(vma->vm_flags & VM_SHARED))
1685         return -EINVAL;
1686 
1687     if (vma->vm_start & ~PAGE_MASK)
1688         return -EINVAL;
1689 
1690     client->vm_start = vma->vm_start;
1691     size = vma->vm_end - vma->vm_start;
1692     page_count = size >> PAGE_SHIFT;
1693     if (size & ~PAGE_MASK)
1694         return -EINVAL;
1695 
1696     ret = fw_iso_buffer_alloc(&client->buffer, page_count);
1697     if (ret < 0)
1698         return ret;
1699 
1700     spin_lock_irq(&client->lock);
1701     if (client->iso_context) {
1702         ret = fw_iso_buffer_map_dma(&client->buffer,
1703                 client->device->card,
1704                 iso_dma_direction(client->iso_context));
1705         client->buffer_is_mapped = (ret == 0);
1706     }
1707     spin_unlock_irq(&client->lock);
1708     if (ret < 0)
1709         goto fail;
1710 
1711     ret = vm_map_pages_zero(vma, client->buffer.pages,
1712                 client->buffer.page_count);
1713     if (ret < 0)
1714         goto fail;
1715 
1716     return 0;
1717  fail:
1718     fw_iso_buffer_destroy(&client->buffer, client->device->card);
1719     return ret;
1720 }
1721 
1722 static int is_outbound_transaction_resource(int id, void *p, void *data)
1723 {
1724     struct client_resource *resource = p;
1725 
1726     return resource->release == release_transaction;
1727 }
1728 
1729 static int has_outbound_transactions(struct client *client)
1730 {
1731     int ret;
1732 
1733     spin_lock_irq(&client->lock);
1734     ret = idr_for_each(&client->resource_idr,
1735                is_outbound_transaction_resource, NULL);
1736     spin_unlock_irq(&client->lock);
1737 
1738     return ret;
1739 }
1740 
1741 static int shutdown_resource(int id, void *p, void *data)
1742 {
1743     struct client_resource *resource = p;
1744     struct client *client = data;
1745 
1746     resource->release(client, resource);
1747     client_put(client);
1748 
1749     return 0;
1750 }
1751 
1752 static int fw_device_op_release(struct inode *inode, struct file *file)
1753 {
1754     struct client *client = file->private_data;
1755     struct event *event, *next_event;
1756 
1757     spin_lock_irq(&client->device->card->lock);
1758     list_del(&client->phy_receiver_link);
1759     spin_unlock_irq(&client->device->card->lock);
1760 
1761     mutex_lock(&client->device->client_list_mutex);
1762     list_del(&client->link);
1763     mutex_unlock(&client->device->client_list_mutex);
1764 
1765     if (client->iso_context)
1766         fw_iso_context_destroy(client->iso_context);
1767 
1768     if (client->buffer.pages)
1769         fw_iso_buffer_destroy(&client->buffer, client->device->card);
1770 
1771     /* Freeze client->resource_idr and client->event_list */
1772     spin_lock_irq(&client->lock);
1773     client->in_shutdown = true;
1774     spin_unlock_irq(&client->lock);
1775 
1776     wait_event(client->tx_flush_wait, !has_outbound_transactions(client));
1777 
1778     idr_for_each(&client->resource_idr, shutdown_resource, client);
1779     idr_destroy(&client->resource_idr);
1780 
1781     list_for_each_entry_safe(event, next_event, &client->event_list, link)
1782         kfree(event);
1783 
1784     client_put(client);
1785 
1786     return 0;
1787 }
1788 
1789 static __poll_t fw_device_op_poll(struct file *file, poll_table * pt)
1790 {
1791     struct client *client = file->private_data;
1792     __poll_t mask = 0;
1793 
1794     poll_wait(file, &client->wait, pt);
1795 
1796     if (fw_device_is_shutdown(client->device))
1797         mask |= EPOLLHUP | EPOLLERR;
1798     if (!list_empty(&client->event_list))
1799         mask |= EPOLLIN | EPOLLRDNORM;
1800 
1801     return mask;
1802 }
1803 
1804 const struct file_operations fw_device_ops = {
1805     .owner      = THIS_MODULE,
1806     .llseek     = no_llseek,
1807     .open       = fw_device_op_open,
1808     .read       = fw_device_op_read,
1809     .unlocked_ioctl = fw_device_op_ioctl,
1810     .mmap       = fw_device_op_mmap,
1811     .release    = fw_device_op_release,
1812     .poll       = fw_device_op_poll,
1813     .compat_ioctl   = compat_ptr_ioctl,
1814 };