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