1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * rio_cm - RapidIO Channelized Messaging Driver
5 * Copyright 2013-2016 Integrated Device Technology, Inc.
6 * Copyright (c) 2015, Prodrive Technologies
7 * Copyright (c) 2015, RapidIO Trade Association
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/delay.h>
14 #include <linux/sched.h>
15 #include <linux/rio.h>
16 #include <linux/rio_drv.h>
17 #include <linux/slab.h>
18 #include <linux/idr.h>
19 #include <linux/interrupt.h>
20 #include <linux/cdev.h>
22 #include <linux/poll.h>
23 #include <linux/reboot.h>
24 #include <linux/bitops.h>
25 #include <linux/printk.h>
26 #include <linux/rio_cm_cdev.h>
28 #define DRV_NAME "rio_cm"
29 #define DRV_VERSION "1.0.0"
30 #define DRV_AUTHOR "Alexandre Bounine <alexandre.bounine@idt.com>"
31 #define DRV_DESC "RapidIO Channelized Messaging Driver"
32 #define DEV_NAME "rio_cm"
34 /* Debug output filtering masks */
37 DBG_INIT = BIT(0), /* driver init */
38 DBG_EXIT = BIT(1), /* driver exit */
39 DBG_MPORT = BIT(2), /* mport add/remove */
40 DBG_RDEV = BIT(3), /* RapidIO device add/remove */
41 DBG_CHOP = BIT(4), /* channel operations */
42 DBG_WAIT = BIT(5), /* waiting for events */
43 DBG_TX = BIT(6), /* message TX */
44 DBG_TX_EVENT = BIT(7), /* message TX event */
45 DBG_RX_DATA = BIT(8), /* inbound data messages */
46 DBG_RX_CMD = BIT(9), /* inbound REQ/ACK/NACK messages */
51 #define riocm_debug(level, fmt, arg...) \
53 if (DBG_##level & dbg_level) \
54 pr_debug(DRV_NAME ": %s " fmt "\n", \
58 #define riocm_debug(level, fmt, arg...) \
59 no_printk(KERN_DEBUG pr_fmt(DRV_NAME fmt "\n"), ##arg)
62 #define riocm_warn(fmt, arg...) \
63 pr_warn(DRV_NAME ": %s WARNING " fmt "\n", __func__, ##arg)
65 #define riocm_error(fmt, arg...) \
66 pr_err(DRV_NAME ": %s ERROR " fmt "\n", __func__, ##arg)
70 module_param(cmbox, int, S_IRUGO);
71 MODULE_PARM_DESC(cmbox, "RapidIO Mailbox number (default 1)");
73 static int chstart = 256;
74 module_param(chstart, int, S_IRUGO);
75 MODULE_PARM_DESC(chstart,
76 "Start channel number for dynamic allocation (default 256)");
79 static u32 dbg_level = DBG_NONE;
80 module_param(dbg_level, uint, S_IWUSR | S_IRUGO);
81 MODULE_PARM_DESC(dbg_level, "Debugging output level (default 0 = none)");
84 MODULE_AUTHOR(DRV_AUTHOR);
85 MODULE_DESCRIPTION(DRV_DESC);
86 MODULE_LICENSE("GPL");
87 MODULE_VERSION(DRV_VERSION);
89 #define RIOCM_TX_RING_SIZE 128
90 #define RIOCM_RX_RING_SIZE 128
91 #define RIOCM_CONNECT_TO 3 /* connect response TO (in sec) */
93 #define RIOCM_MAX_CHNUM 0xffff /* Use full range of u16 field */
94 #define RIOCM_CHNUM_AUTO 0
95 #define RIOCM_MAX_EP_COUNT 0x10000 /* Max number of endpoints */
107 enum rio_cm_pkt_type {
119 struct rio_ch_base_bhdr {
122 #define RIO_HDR_LETTER_MASK 0xffff0000
123 #define RIO_HDR_MBOX_MASK 0x0000ffff
127 } __attribute__((__packed__));
129 struct rio_ch_chan_hdr {
130 struct rio_ch_base_bhdr bhdr;
136 } __attribute__((__packed__));
139 struct list_head node;
140 struct rio_dev *rdev;
146 struct list_head list;
147 struct rio_mport *mport;
148 void *rx_buf[RIOCM_RX_RING_SIZE];
150 struct mutex rx_lock;
152 void *tx_buf[RIOCM_TX_RING_SIZE];
156 struct list_head tx_reqs;
159 struct list_head peers;
161 struct workqueue_struct *rx_wq;
162 struct work_struct rx_work;
165 struct chan_rx_ring {
166 void *buf[RIOCM_RX_RING_SIZE];
171 /* Tracking RX buffers reported to upper level */
172 void *inuse[RIOCM_RX_RING_SIZE];
177 u16 id; /* local channel ID */
178 struct kref ref; /* channel refcount */
180 struct cm_dev *cmdev; /* associated CM device object */
181 struct rio_dev *rdev; /* remote RapidIO device */
182 enum rio_cm_state state;
186 u32 loc_destid; /* local destID */
187 u32 rem_destid; /* remote destID */
188 u16 rem_channel; /* remote channel ID */
189 struct list_head accept_queue;
190 struct list_head ch_node;
191 struct completion comp;
192 struct completion comp_close;
193 struct chan_rx_ring rx_ring;
197 struct list_head node;
198 struct rio_dev *rdev;
202 struct work_struct work;
208 struct list_head node;
209 u32 destid; /* requester destID */
210 u16 chan; /* requester channel ID */
211 struct cm_dev *cmdev;
215 * A channel_dev structure represents a CM_CDEV
216 * @cdev Character device
217 * @dev Associated device object
224 static struct rio_channel *riocm_ch_alloc(u16 ch_num);
225 static void riocm_ch_free(struct kref *ref);
226 static int riocm_post_send(struct cm_dev *cm, struct rio_dev *rdev,
227 void *buffer, size_t len);
228 static int riocm_ch_close(struct rio_channel *ch);
230 static DEFINE_SPINLOCK(idr_lock);
231 static DEFINE_IDR(ch_idr);
233 static LIST_HEAD(cm_dev_list);
234 static DECLARE_RWSEM(rdev_sem);
236 static struct class *dev_class;
237 static unsigned int dev_major;
238 static unsigned int dev_minor_base;
239 static dev_t dev_number;
240 static struct channel_dev riocm_cdev;
242 #define is_msg_capable(src_ops, dst_ops) \
243 ((src_ops & RIO_SRC_OPS_DATA_MSG) && \
244 (dst_ops & RIO_DST_OPS_DATA_MSG))
245 #define dev_cm_capable(dev) \
246 is_msg_capable(dev->src_ops, dev->dst_ops)
248 static int riocm_cmp(struct rio_channel *ch, enum rio_cm_state cmp)
252 spin_lock_bh(&ch->lock);
253 ret = (ch->state == cmp);
254 spin_unlock_bh(&ch->lock);
258 static int riocm_cmp_exch(struct rio_channel *ch,
259 enum rio_cm_state cmp, enum rio_cm_state exch)
263 spin_lock_bh(&ch->lock);
264 ret = (ch->state == cmp);
267 spin_unlock_bh(&ch->lock);
271 static enum rio_cm_state riocm_exch(struct rio_channel *ch,
272 enum rio_cm_state exch)
274 enum rio_cm_state old;
276 spin_lock_bh(&ch->lock);
279 spin_unlock_bh(&ch->lock);
283 static struct rio_channel *riocm_get_channel(u16 nr)
285 struct rio_channel *ch;
287 spin_lock_bh(&idr_lock);
288 ch = idr_find(&ch_idr, nr);
291 spin_unlock_bh(&idr_lock);
295 static void riocm_put_channel(struct rio_channel *ch)
297 kref_put(&ch->ref, riocm_ch_free);
300 static void *riocm_rx_get_msg(struct cm_dev *cm)
305 msg = rio_get_inb_message(cm->mport, cmbox);
307 for (i = 0; i < RIOCM_RX_RING_SIZE; i++) {
308 if (cm->rx_buf[i] == msg) {
309 cm->rx_buf[i] = NULL;
315 if (i == RIOCM_RX_RING_SIZE)
316 riocm_warn("no record for buffer 0x%p", msg);
323 * riocm_rx_fill - fills a ring of receive buffers for given cm device
325 * @nent: max number of entries to fill
329 static void riocm_rx_fill(struct cm_dev *cm, int nent)
333 if (cm->rx_slots == 0)
336 for (i = 0; i < RIOCM_RX_RING_SIZE && cm->rx_slots && nent; i++) {
337 if (cm->rx_buf[i] == NULL) {
338 cm->rx_buf[i] = kmalloc(RIO_MAX_MSG_SIZE, GFP_KERNEL);
339 if (cm->rx_buf[i] == NULL)
341 rio_add_inb_buffer(cm->mport, cmbox, cm->rx_buf[i]);
349 * riocm_rx_free - frees all receive buffers associated with given cm device
354 static void riocm_rx_free(struct cm_dev *cm)
358 for (i = 0; i < RIOCM_RX_RING_SIZE; i++) {
359 if (cm->rx_buf[i] != NULL) {
360 kfree(cm->rx_buf[i]);
361 cm->rx_buf[i] = NULL;
367 * riocm_req_handler - connection request handler
369 * @req_data: pointer to the request packet
371 * Returns: 0 if success, or
372 * -EINVAL if channel is not in correct state,
373 * -ENODEV if cannot find a channel with specified ID,
374 * -ENOMEM if unable to allocate memory to store the request
376 static int riocm_req_handler(struct cm_dev *cm, void *req_data)
378 struct rio_channel *ch;
379 struct conn_req *req;
380 struct rio_ch_chan_hdr *hh = req_data;
383 chnum = ntohs(hh->dst_ch);
385 ch = riocm_get_channel(chnum);
390 if (ch->state != RIO_CM_LISTEN) {
391 riocm_debug(RX_CMD, "channel %d is not in listen state", chnum);
392 riocm_put_channel(ch);
396 req = kzalloc(sizeof(*req), GFP_KERNEL);
398 riocm_put_channel(ch);
402 req->destid = ntohl(hh->bhdr.src_id);
403 req->chan = ntohs(hh->src_ch);
406 spin_lock_bh(&ch->lock);
407 list_add_tail(&req->node, &ch->accept_queue);
408 spin_unlock_bh(&ch->lock);
410 riocm_put_channel(ch);
416 * riocm_resp_handler - response to connection request handler
417 * @resp_data: pointer to the response packet
419 * Returns: 0 if success, or
420 * -EINVAL if channel is not in correct state,
421 * -ENODEV if cannot find a channel with specified ID,
423 static int riocm_resp_handler(void *resp_data)
425 struct rio_channel *ch;
426 struct rio_ch_chan_hdr *hh = resp_data;
429 chnum = ntohs(hh->dst_ch);
430 ch = riocm_get_channel(chnum);
434 if (ch->state != RIO_CM_CONNECT) {
435 riocm_put_channel(ch);
439 riocm_exch(ch, RIO_CM_CONNECTED);
440 ch->rem_channel = ntohs(hh->src_ch);
442 riocm_put_channel(ch);
448 * riocm_close_handler - channel close request handler
449 * @req_data: pointer to the request packet
451 * Returns: 0 if success, or
452 * -ENODEV if cannot find a channel with specified ID,
453 * + error codes returned by riocm_ch_close.
455 static int riocm_close_handler(void *data)
457 struct rio_channel *ch;
458 struct rio_ch_chan_hdr *hh = data;
461 riocm_debug(RX_CMD, "for ch=%d", ntohs(hh->dst_ch));
463 spin_lock_bh(&idr_lock);
464 ch = idr_find(&ch_idr, ntohs(hh->dst_ch));
466 spin_unlock_bh(&idr_lock);
469 idr_remove(&ch_idr, ch->id);
470 spin_unlock_bh(&idr_lock);
472 riocm_exch(ch, RIO_CM_DISCONNECT);
474 ret = riocm_ch_close(ch);
476 riocm_debug(RX_CMD, "riocm_ch_close() returned %d", ret);
482 * rio_cm_handler - function that services request (non-data) packets
484 * @data: pointer to the packet
486 static void rio_cm_handler(struct cm_dev *cm, void *data)
488 struct rio_ch_chan_hdr *hdr;
490 if (!rio_mport_is_running(cm->mport))
495 riocm_debug(RX_CMD, "OP=%x for ch=%d from %d",
496 hdr->ch_op, ntohs(hdr->dst_ch), ntohs(hdr->src_ch));
498 switch (hdr->ch_op) {
500 riocm_req_handler(cm, data);
503 riocm_resp_handler(data);
506 riocm_close_handler(data);
509 riocm_error("Invalid packet header");
517 * rio_rx_data_handler - received data packet handler
521 * Returns: 0 if success, or
522 * -ENODEV if cannot find a channel with specified ID,
523 * -EIO if channel is not in CONNECTED state,
524 * -ENOMEM if channel RX queue is full (packet discarded)
526 static int rio_rx_data_handler(struct cm_dev *cm, void *buf)
528 struct rio_ch_chan_hdr *hdr;
529 struct rio_channel *ch;
533 riocm_debug(RX_DATA, "for ch=%d", ntohs(hdr->dst_ch));
535 ch = riocm_get_channel(ntohs(hdr->dst_ch));
537 /* Discard data message for non-existing channel */
542 /* Place pointer to the buffer into channel's RX queue */
543 spin_lock(&ch->lock);
545 if (ch->state != RIO_CM_CONNECTED) {
546 /* Channel is not ready to receive data, discard a packet */
547 riocm_debug(RX_DATA, "ch=%d is in wrong state=%d",
549 spin_unlock(&ch->lock);
551 riocm_put_channel(ch);
555 if (ch->rx_ring.count == RIOCM_RX_RING_SIZE) {
556 /* If RX ring is full, discard a packet */
557 riocm_debug(RX_DATA, "ch=%d is full", ch->id);
558 spin_unlock(&ch->lock);
560 riocm_put_channel(ch);
564 ch->rx_ring.buf[ch->rx_ring.head] = buf;
567 ch->rx_ring.head %= RIOCM_RX_RING_SIZE;
571 spin_unlock(&ch->lock);
572 riocm_put_channel(ch);
578 * rio_ibmsg_handler - inbound message packet handler
580 static void rio_ibmsg_handler(struct work_struct *work)
582 struct cm_dev *cm = container_of(work, struct cm_dev, rx_work);
584 struct rio_ch_chan_hdr *hdr;
586 if (!rio_mport_is_running(cm->mport))
590 mutex_lock(&cm->rx_lock);
591 data = riocm_rx_get_msg(cm);
593 riocm_rx_fill(cm, 1);
594 mutex_unlock(&cm->rx_lock);
601 if (hdr->bhdr.type != RIO_CM_CHAN) {
602 /* For now simply discard packets other than channel */
603 riocm_error("Unsupported TYPE code (0x%x). Msg dropped",
609 /* Process a channel message */
610 if (hdr->ch_op == CM_DATA_MSG)
611 rio_rx_data_handler(cm, data);
613 rio_cm_handler(cm, data);
617 static void riocm_inb_msg_event(struct rio_mport *mport, void *dev_id,
620 struct cm_dev *cm = dev_id;
622 if (rio_mport_is_running(cm->mport) && !work_pending(&cm->rx_work))
623 queue_work(cm->rx_wq, &cm->rx_work);
627 * rio_txcq_handler - TX completion handler
629 * @slot: TX queue slot
631 * TX completion handler also ensures that pending request packets are placed
632 * into transmit queue as soon as a free slot becomes available. This is done
633 * to give higher priority to request packets during high intensity data flow.
635 static void rio_txcq_handler(struct cm_dev *cm, int slot)
639 /* ATTN: Add TX completion notification if/when direct buffer
640 * transfer is implemented. At this moment only correct tracking
641 * of tx_count is important.
643 riocm_debug(TX_EVENT, "for mport_%d slot %d tx_cnt %d",
644 cm->mport->id, slot, cm->tx_cnt);
646 spin_lock(&cm->tx_lock);
647 ack_slot = cm->tx_ack_slot;
649 if (ack_slot == slot)
650 riocm_debug(TX_EVENT, "slot == ack_slot");
652 while (cm->tx_cnt && ((ack_slot != slot) ||
653 (cm->tx_cnt == RIOCM_TX_RING_SIZE))) {
655 cm->tx_buf[ack_slot] = NULL;
657 ack_slot &= (RIOCM_TX_RING_SIZE - 1);
661 if (cm->tx_cnt < 0 || cm->tx_cnt > RIOCM_TX_RING_SIZE)
662 riocm_error("tx_cnt %d out of sync", cm->tx_cnt);
664 WARN_ON((cm->tx_cnt < 0) || (cm->tx_cnt > RIOCM_TX_RING_SIZE));
666 cm->tx_ack_slot = ack_slot;
669 * If there are pending requests, insert them into transmit queue
671 if (!list_empty(&cm->tx_reqs) && (cm->tx_cnt < RIOCM_TX_RING_SIZE)) {
672 struct tx_req *req, *_req;
675 list_for_each_entry_safe(req, _req, &cm->tx_reqs, node) {
676 list_del(&req->node);
677 cm->tx_buf[cm->tx_slot] = req->buffer;
678 rc = rio_add_outb_message(cm->mport, req->rdev, cmbox,
679 req->buffer, req->len);
685 cm->tx_slot &= (RIOCM_TX_RING_SIZE - 1);
686 if (cm->tx_cnt == RIOCM_TX_RING_SIZE)
691 spin_unlock(&cm->tx_lock);
694 static void riocm_outb_msg_event(struct rio_mport *mport, void *dev_id,
697 struct cm_dev *cm = dev_id;
699 if (cm && rio_mport_is_running(cm->mport))
700 rio_txcq_handler(cm, slot);
703 static int riocm_queue_req(struct cm_dev *cm, struct rio_dev *rdev,
704 void *buffer, size_t len)
709 treq = kzalloc(sizeof(*treq), GFP_KERNEL);
714 treq->buffer = buffer;
717 spin_lock_irqsave(&cm->tx_lock, flags);
718 list_add_tail(&treq->node, &cm->tx_reqs);
719 spin_unlock_irqrestore(&cm->tx_lock, flags);
724 * riocm_post_send - helper function that places packet into msg TX queue
726 * @rdev: target RapidIO device object (required by outbound msg interface)
727 * @buffer: pointer to a packet buffer to send
728 * @len: length of data to transfer
729 * @req: request priority flag
731 * Returns: 0 if success, or error code otherwise.
733 static int riocm_post_send(struct cm_dev *cm, struct rio_dev *rdev,
734 void *buffer, size_t len)
739 spin_lock_irqsave(&cm->tx_lock, flags);
741 if (cm->mport == NULL) {
746 if (cm->tx_cnt == RIOCM_TX_RING_SIZE) {
747 riocm_debug(TX, "Tx Queue is full");
752 cm->tx_buf[cm->tx_slot] = buffer;
753 rc = rio_add_outb_message(cm->mport, rdev, cmbox, buffer, len);
755 riocm_debug(TX, "Add buf@%p destid=%x tx_slot=%d tx_cnt=%d",
756 buffer, rdev->destid, cm->tx_slot, cm->tx_cnt);
760 cm->tx_slot &= (RIOCM_TX_RING_SIZE - 1);
763 spin_unlock_irqrestore(&cm->tx_lock, flags);
768 * riocm_ch_send - sends a data packet to a remote device
769 * @ch_id: local channel ID
770 * @buf: pointer to a data buffer to send (including CM header)
771 * @len: length of data to transfer (including CM header)
773 * ATTN: ASSUMES THAT THE HEADER SPACE IS RESERVED PART OF THE DATA PACKET
775 * Returns: 0 if success, or
776 * -EINVAL if one or more input parameters is/are not valid,
777 * -ENODEV if cannot find a channel with specified ID,
778 * -EAGAIN if a channel is not in CONNECTED state,
779 * + error codes returned by HW send routine.
781 static int riocm_ch_send(u16 ch_id, void *buf, int len)
783 struct rio_channel *ch;
784 struct rio_ch_chan_hdr *hdr;
787 if (buf == NULL || ch_id == 0 || len == 0 || len > RIO_MAX_MSG_SIZE)
790 ch = riocm_get_channel(ch_id);
792 riocm_error("%s(%d) ch_%d not found", current->comm,
793 task_pid_nr(current), ch_id);
797 if (!riocm_cmp(ch, RIO_CM_CONNECTED)) {
803 * Fill buffer header section with corresponding channel data
807 hdr->bhdr.src_id = htonl(ch->loc_destid);
808 hdr->bhdr.dst_id = htonl(ch->rem_destid);
809 hdr->bhdr.src_mbox = cmbox;
810 hdr->bhdr.dst_mbox = cmbox;
811 hdr->bhdr.type = RIO_CM_CHAN;
812 hdr->ch_op = CM_DATA_MSG;
813 hdr->dst_ch = htons(ch->rem_channel);
814 hdr->src_ch = htons(ch->id);
815 hdr->msg_len = htons((u16)len);
817 /* ATTN: the function call below relies on the fact that underlying
818 * HW-specific add_outb_message() routine copies TX data into its own
819 * internal transfer buffer (true for all RIONET compatible mport
820 * drivers). Must be reviewed if mport driver uses the buffer directly.
823 ret = riocm_post_send(ch->cmdev, ch->rdev, buf, len);
825 riocm_debug(TX, "ch %d send_err=%d", ch->id, ret);
827 riocm_put_channel(ch);
831 static int riocm_ch_free_rxbuf(struct rio_channel *ch, void *buf)
833 int i, ret = -EINVAL;
835 spin_lock_bh(&ch->lock);
837 for (i = 0; i < RIOCM_RX_RING_SIZE; i++) {
838 if (ch->rx_ring.inuse[i] == buf) {
839 ch->rx_ring.inuse[i] = NULL;
840 ch->rx_ring.inuse_cnt--;
846 spin_unlock_bh(&ch->lock);
855 * riocm_ch_receive - fetch a data packet received for the specified channel
856 * @ch: local channel ID
857 * @buf: pointer to a packet buffer
858 * @timeout: timeout to wait for incoming packet (in jiffies)
860 * Returns: 0 and valid buffer pointer if success, or NULL pointer and one of:
861 * -EAGAIN if a channel is not in CONNECTED state,
862 * -ENOMEM if in-use tracking queue is full,
863 * -ETIME if wait timeout expired,
864 * -EINTR if wait was interrupted.
866 static int riocm_ch_receive(struct rio_channel *ch, void **buf, long timeout)
872 if (!riocm_cmp(ch, RIO_CM_CONNECTED)) {
877 if (ch->rx_ring.inuse_cnt == RIOCM_RX_RING_SIZE) {
878 /* If we do not have entries to track buffers given to upper
879 * layer, reject request.
885 wret = wait_for_completion_interruptible_timeout(&ch->comp, timeout);
887 riocm_debug(WAIT, "wait on %d returned %ld", ch->id, wret);
891 else if (wret == -ERESTARTSYS)
894 ret = riocm_cmp(ch, RIO_CM_CONNECTED) ? 0 : -ECONNRESET;
899 spin_lock_bh(&ch->lock);
901 rxmsg = ch->rx_ring.buf[ch->rx_ring.tail];
902 ch->rx_ring.buf[ch->rx_ring.tail] = NULL;
905 ch->rx_ring.tail %= RIOCM_RX_RING_SIZE;
908 for (i = 0; i < RIOCM_RX_RING_SIZE; i++) {
909 if (ch->rx_ring.inuse[i] == NULL) {
910 ch->rx_ring.inuse[i] = rxmsg;
911 ch->rx_ring.inuse_cnt++;
918 /* We have no entry to store pending message: drop it */
923 spin_unlock_bh(&ch->lock);
930 * riocm_ch_connect - sends a connect request to a remote device
931 * @loc_ch: local channel ID
932 * @cm: CM device to send connect request
933 * @peer: target RapidIO device
934 * @rem_ch: remote channel ID
936 * Returns: 0 if success, or
937 * -EINVAL if the channel is not in IDLE state,
938 * -EAGAIN if no connection request available immediately,
939 * -ETIME if ACK response timeout expired,
940 * -EINTR if wait for response was interrupted.
942 static int riocm_ch_connect(u16 loc_ch, struct cm_dev *cm,
943 struct cm_peer *peer, u16 rem_ch)
945 struct rio_channel *ch = NULL;
946 struct rio_ch_chan_hdr *hdr;
950 ch = riocm_get_channel(loc_ch);
954 if (!riocm_cmp_exch(ch, RIO_CM_IDLE, RIO_CM_CONNECT)) {
960 ch->rdev = peer->rdev;
962 ch->loc_destid = cm->mport->host_deviceid;
963 ch->rem_channel = rem_ch;
966 * Send connect request to the remote RapidIO device
969 hdr = kzalloc(sizeof(*hdr), GFP_KERNEL);
975 hdr->bhdr.src_id = htonl(ch->loc_destid);
976 hdr->bhdr.dst_id = htonl(peer->rdev->destid);
977 hdr->bhdr.src_mbox = cmbox;
978 hdr->bhdr.dst_mbox = cmbox;
979 hdr->bhdr.type = RIO_CM_CHAN;
980 hdr->ch_op = CM_CONN_REQ;
981 hdr->dst_ch = htons(rem_ch);
982 hdr->src_ch = htons(loc_ch);
984 /* ATTN: the function call below relies on the fact that underlying
985 * HW-specific add_outb_message() routine copies TX data into its
986 * internal transfer buffer. Must be reviewed if mport driver uses
987 * this buffer directly.
989 ret = riocm_post_send(cm, peer->rdev, hdr, sizeof(*hdr));
994 ret = riocm_queue_req(cm, peer->rdev, hdr, sizeof(*hdr));
1000 riocm_cmp_exch(ch, RIO_CM_CONNECT, RIO_CM_IDLE);
1004 /* Wait for connect response from the remote device */
1005 wret = wait_for_completion_interruptible_timeout(&ch->comp,
1006 RIOCM_CONNECT_TO * HZ);
1007 riocm_debug(WAIT, "wait on %d returns %ld", ch->id, wret);
1011 else if (wret == -ERESTARTSYS)
1014 ret = riocm_cmp(ch, RIO_CM_CONNECTED) ? 0 : -1;
1017 riocm_put_channel(ch);
1021 static int riocm_send_ack(struct rio_channel *ch)
1023 struct rio_ch_chan_hdr *hdr;
1026 hdr = kzalloc(sizeof(*hdr), GFP_KERNEL);
1030 hdr->bhdr.src_id = htonl(ch->loc_destid);
1031 hdr->bhdr.dst_id = htonl(ch->rem_destid);
1032 hdr->dst_ch = htons(ch->rem_channel);
1033 hdr->src_ch = htons(ch->id);
1034 hdr->bhdr.src_mbox = cmbox;
1035 hdr->bhdr.dst_mbox = cmbox;
1036 hdr->bhdr.type = RIO_CM_CHAN;
1037 hdr->ch_op = CM_CONN_ACK;
1039 /* ATTN: the function call below relies on the fact that underlying
1040 * add_outb_message() routine copies TX data into its internal transfer
1041 * buffer. Review if switching to direct buffer version.
1043 ret = riocm_post_send(ch->cmdev, ch->rdev, hdr, sizeof(*hdr));
1045 if (ret == -EBUSY && !riocm_queue_req(ch->cmdev,
1046 ch->rdev, hdr, sizeof(*hdr)))
1051 riocm_error("send ACK to ch_%d on %s failed (ret=%d)",
1052 ch->id, rio_name(ch->rdev), ret);
1057 * riocm_ch_accept - accept incoming connection request
1058 * @ch_id: channel ID
1059 * @new_ch_id: local mport device
1060 * @timeout: wait timeout (if 0 non-blocking call, do not wait if connection
1061 * request is not available).
1063 * Returns: pointer to new channel struct if success, or error-valued pointer:
1064 * -ENODEV - cannot find specified channel or mport,
1065 * -EINVAL - the channel is not in IDLE state,
1066 * -EAGAIN - no connection request available immediately (timeout=0),
1067 * -ENOMEM - unable to allocate new channel,
1068 * -ETIME - wait timeout expired,
1069 * -EINTR - wait was interrupted.
1071 static struct rio_channel *riocm_ch_accept(u16 ch_id, u16 *new_ch_id,
1074 struct rio_channel *ch;
1075 struct rio_channel *new_ch;
1076 struct conn_req *req;
1077 struct cm_peer *peer;
1082 ch = riocm_get_channel(ch_id);
1084 return ERR_PTR(-EINVAL);
1086 if (!riocm_cmp(ch, RIO_CM_LISTEN)) {
1091 /* Don't sleep if this is a non blocking call */
1093 if (!try_wait_for_completion(&ch->comp)) {
1098 riocm_debug(WAIT, "on %d", ch->id);
1100 wret = wait_for_completion_interruptible_timeout(&ch->comp,
1105 } else if (wret == -ERESTARTSYS) {
1111 spin_lock_bh(&ch->lock);
1113 if (ch->state != RIO_CM_LISTEN) {
1115 } else if (list_empty(&ch->accept_queue)) {
1116 riocm_debug(WAIT, "on %d accept_queue is empty on completion",
1121 spin_unlock_bh(&ch->lock);
1124 riocm_debug(WAIT, "on %d returns %d", ch->id, err);
1128 /* Create new channel for this connection */
1129 new_ch = riocm_ch_alloc(RIOCM_CHNUM_AUTO);
1131 if (IS_ERR(new_ch)) {
1132 riocm_error("failed to get channel for new req (%ld)",
1138 spin_lock_bh(&ch->lock);
1140 req = list_first_entry(&ch->accept_queue, struct conn_req, node);
1141 list_del(&req->node);
1142 new_ch->cmdev = ch->cmdev;
1143 new_ch->loc_destid = ch->loc_destid;
1144 new_ch->rem_destid = req->destid;
1145 new_ch->rem_channel = req->chan;
1147 spin_unlock_bh(&ch->lock);
1148 riocm_put_channel(ch);
1152 down_read(&rdev_sem);
1153 /* Find requester's device object */
1154 list_for_each_entry(peer, &new_ch->cmdev->peers, node) {
1155 if (peer->rdev->destid == new_ch->rem_destid) {
1156 riocm_debug(RX_CMD, "found matching device(%s)",
1157 rio_name(peer->rdev));
1165 /* If peer device object not found, simply ignore the request */
1167 goto err_put_new_ch;
1170 new_ch->rdev = peer->rdev;
1171 new_ch->state = RIO_CM_CONNECTED;
1172 spin_lock_init(&new_ch->lock);
1174 /* Acknowledge the connection request. */
1175 riocm_send_ack(new_ch);
1177 *new_ch_id = new_ch->id;
1181 spin_lock_bh(&idr_lock);
1182 idr_remove(&ch_idr, new_ch->id);
1183 spin_unlock_bh(&idr_lock);
1184 riocm_put_channel(new_ch);
1188 riocm_put_channel(ch);
1190 return ERR_PTR(err);
1194 * riocm_ch_listen - puts a channel into LISTEN state
1195 * @ch_id: channel ID
1197 * Returns: 0 if success, or
1198 * -EINVAL if the specified channel does not exists or
1199 * is not in CHAN_BOUND state.
1201 static int riocm_ch_listen(u16 ch_id)
1203 struct rio_channel *ch = NULL;
1206 riocm_debug(CHOP, "(ch_%d)", ch_id);
1208 ch = riocm_get_channel(ch_id);
1211 if (!riocm_cmp_exch(ch, RIO_CM_CHAN_BOUND, RIO_CM_LISTEN))
1213 riocm_put_channel(ch);
1218 * riocm_ch_bind - associate a channel object and an mport device
1219 * @ch_id: channel ID
1220 * @mport_id: local mport device ID
1221 * @context: pointer to the additional caller's context
1223 * Returns: 0 if success, or
1224 * -ENODEV if cannot find specified mport,
1225 * -EINVAL if the specified channel does not exist or
1226 * is not in IDLE state.
1228 static int riocm_ch_bind(u16 ch_id, u8 mport_id, void *context)
1230 struct rio_channel *ch = NULL;
1234 riocm_debug(CHOP, "ch_%d to mport_%d", ch_id, mport_id);
1236 /* Find matching cm_dev object */
1237 down_read(&rdev_sem);
1238 list_for_each_entry(cm, &cm_dev_list, list) {
1239 if ((cm->mport->id == mport_id) &&
1240 rio_mport_is_running(cm->mport)) {
1249 ch = riocm_get_channel(ch_id);
1255 spin_lock_bh(&ch->lock);
1256 if (ch->state != RIO_CM_IDLE) {
1257 spin_unlock_bh(&ch->lock);
1263 ch->loc_destid = cm->mport->host_deviceid;
1264 ch->context = context;
1265 ch->state = RIO_CM_CHAN_BOUND;
1266 spin_unlock_bh(&ch->lock);
1268 riocm_put_channel(ch);
1275 * riocm_ch_alloc - channel object allocation helper routine
1276 * @ch_num: channel ID (1 ... RIOCM_MAX_CHNUM, 0 = automatic)
1278 * Return value: pointer to newly created channel object,
1279 * or error-valued pointer
1281 static struct rio_channel *riocm_ch_alloc(u16 ch_num)
1285 struct rio_channel *ch;
1287 ch = kzalloc(sizeof(*ch), GFP_KERNEL);
1289 return ERR_PTR(-ENOMEM);
1292 /* If requested, try to obtain the specified channel ID */
1296 /* Obtain channel ID from the dynamic allocation range */
1298 end = RIOCM_MAX_CHNUM + 1;
1301 idr_preload(GFP_KERNEL);
1302 spin_lock_bh(&idr_lock);
1303 id = idr_alloc_cyclic(&ch_idr, ch, start, end, GFP_NOWAIT);
1304 spin_unlock_bh(&idr_lock);
1309 return ERR_PTR(id == -ENOSPC ? -EBUSY : id);
1313 ch->state = RIO_CM_IDLE;
1314 spin_lock_init(&ch->lock);
1315 INIT_LIST_HEAD(&ch->accept_queue);
1316 INIT_LIST_HEAD(&ch->ch_node);
1317 init_completion(&ch->comp);
1318 init_completion(&ch->comp_close);
1319 kref_init(&ch->ref);
1320 ch->rx_ring.head = 0;
1321 ch->rx_ring.tail = 0;
1322 ch->rx_ring.count = 0;
1323 ch->rx_ring.inuse_cnt = 0;
1329 * riocm_ch_create - creates a new channel object and allocates ID for it
1330 * @ch_num: channel ID (1 ... RIOCM_MAX_CHNUM, 0 = automatic)
1332 * Allocates and initializes a new channel object. If the parameter ch_num > 0
1333 * and is within the valid range, riocm_ch_create tries to allocate the
1334 * specified ID for the new channel. If ch_num = 0, channel ID will be assigned
1335 * automatically from the range (chstart ... RIOCM_MAX_CHNUM).
1336 * Module parameter 'chstart' defines start of an ID range available for dynamic
1337 * allocation. Range below 'chstart' is reserved for pre-defined ID numbers.
1338 * Available channel numbers are limited by 16-bit size of channel numbers used
1339 * in the packet header.
1341 * Return value: PTR to rio_channel structure if successful (with channel number
1342 * updated via pointer) or error-valued pointer if error.
1344 static struct rio_channel *riocm_ch_create(u16 *ch_num)
1346 struct rio_channel *ch = NULL;
1348 ch = riocm_ch_alloc(*ch_num);
1351 riocm_debug(CHOP, "Failed to allocate channel %d (err=%ld)",
1352 *ch_num, PTR_ERR(ch));
1360 * riocm_ch_free - channel object release routine
1361 * @ref: pointer to a channel's kref structure
1363 static void riocm_ch_free(struct kref *ref)
1365 struct rio_channel *ch = container_of(ref, struct rio_channel, ref);
1368 riocm_debug(CHOP, "(ch_%d)", ch->id);
1370 if (ch->rx_ring.inuse_cnt) {
1372 i < RIOCM_RX_RING_SIZE && ch->rx_ring.inuse_cnt; i++) {
1373 if (ch->rx_ring.inuse[i] != NULL) {
1374 kfree(ch->rx_ring.inuse[i]);
1375 ch->rx_ring.inuse_cnt--;
1380 if (ch->rx_ring.count)
1381 for (i = 0; i < RIOCM_RX_RING_SIZE && ch->rx_ring.count; i++) {
1382 if (ch->rx_ring.buf[i] != NULL) {
1383 kfree(ch->rx_ring.buf[i]);
1384 ch->rx_ring.count--;
1388 complete(&ch->comp_close);
1391 static int riocm_send_close(struct rio_channel *ch)
1393 struct rio_ch_chan_hdr *hdr;
1397 * Send CH_CLOSE notification to the remote RapidIO device
1400 hdr = kzalloc(sizeof(*hdr), GFP_KERNEL);
1404 hdr->bhdr.src_id = htonl(ch->loc_destid);
1405 hdr->bhdr.dst_id = htonl(ch->rem_destid);
1406 hdr->bhdr.src_mbox = cmbox;
1407 hdr->bhdr.dst_mbox = cmbox;
1408 hdr->bhdr.type = RIO_CM_CHAN;
1409 hdr->ch_op = CM_CONN_CLOSE;
1410 hdr->dst_ch = htons(ch->rem_channel);
1411 hdr->src_ch = htons(ch->id);
1413 /* ATTN: the function call below relies on the fact that underlying
1414 * add_outb_message() routine copies TX data into its internal transfer
1415 * buffer. Needs to be reviewed if switched to direct buffer mode.
1417 ret = riocm_post_send(ch->cmdev, ch->rdev, hdr, sizeof(*hdr));
1419 if (ret == -EBUSY && !riocm_queue_req(ch->cmdev, ch->rdev,
1425 riocm_error("ch(%d) send CLOSE failed (ret=%d)", ch->id, ret);
1431 * riocm_ch_close - closes a channel object with specified ID (by local request)
1432 * @ch: channel to be closed
1434 static int riocm_ch_close(struct rio_channel *ch)
1436 unsigned long tmo = msecs_to_jiffies(3000);
1437 enum rio_cm_state state;
1441 riocm_debug(CHOP, "ch_%d by %s(%d)",
1442 ch->id, current->comm, task_pid_nr(current));
1444 state = riocm_exch(ch, RIO_CM_DESTROYING);
1445 if (state == RIO_CM_CONNECTED)
1446 riocm_send_close(ch);
1448 complete_all(&ch->comp);
1450 riocm_put_channel(ch);
1451 wret = wait_for_completion_interruptible_timeout(&ch->comp_close, tmo);
1453 riocm_debug(WAIT, "wait on %d returns %ld", ch->id, wret);
1456 /* Timeout on wait occurred */
1457 riocm_debug(CHOP, "%s(%d) timed out waiting for ch %d",
1458 current->comm, task_pid_nr(current), ch->id);
1460 } else if (wret == -ERESTARTSYS) {
1461 /* Wait_for_completion was interrupted by a signal */
1462 riocm_debug(CHOP, "%s(%d) wait for ch %d was interrupted",
1463 current->comm, task_pid_nr(current), ch->id);
1468 riocm_debug(CHOP, "ch_%d resources released", ch->id);
1471 riocm_debug(CHOP, "failed to release ch_%d resources", ch->id);
1478 * riocm_cdev_open() - Open character device
1480 static int riocm_cdev_open(struct inode *inode, struct file *filp)
1482 riocm_debug(INIT, "by %s(%d) filp=%p ",
1483 current->comm, task_pid_nr(current), filp);
1485 if (list_empty(&cm_dev_list))
1492 * riocm_cdev_release() - Release character device
1494 static int riocm_cdev_release(struct inode *inode, struct file *filp)
1496 struct rio_channel *ch, *_c;
1500 riocm_debug(EXIT, "by %s(%d) filp=%p",
1501 current->comm, task_pid_nr(current), filp);
1503 /* Check if there are channels associated with this file descriptor */
1504 spin_lock_bh(&idr_lock);
1505 idr_for_each_entry(&ch_idr, ch, i) {
1506 if (ch && ch->filp == filp) {
1507 riocm_debug(EXIT, "ch_%d not released by %s(%d)",
1508 ch->id, current->comm,
1509 task_pid_nr(current));
1510 idr_remove(&ch_idr, ch->id);
1511 list_add(&ch->ch_node, &list);
1514 spin_unlock_bh(&idr_lock);
1516 if (!list_empty(&list)) {
1517 list_for_each_entry_safe(ch, _c, &list, ch_node) {
1518 list_del(&ch->ch_node);
1527 * cm_ep_get_list_size() - Reports number of endpoints in the network
1529 static int cm_ep_get_list_size(void __user *arg)
1531 u32 __user *p = arg;
1536 if (get_user(mport_id, p))
1538 if (mport_id >= RIO_MAX_MPORTS)
1541 /* Find a matching cm_dev object */
1542 down_read(&rdev_sem);
1543 list_for_each_entry(cm, &cm_dev_list, list) {
1544 if (cm->mport->id == mport_id) {
1547 if (copy_to_user(arg, &count, sizeof(u32)))
1558 * cm_ep_get_list() - Returns list of attached endpoints
1560 static int cm_ep_get_list(void __user *arg)
1563 struct cm_peer *peer;
1571 if (copy_from_user(&info, arg, sizeof(info)))
1574 if (info[1] >= RIO_MAX_MPORTS || info[0] > RIOCM_MAX_EP_COUNT)
1577 /* Find a matching cm_dev object */
1578 down_read(&rdev_sem);
1579 list_for_each_entry(cm, &cm_dev_list, list)
1580 if (cm->mport->id == (u8)info[1])
1587 nent = min(info[0], cm->npeers);
1588 buf = kcalloc(nent + 2, sizeof(u32), GFP_KERNEL);
1594 entry_ptr = (u32 *)((uintptr_t)buf + 2*sizeof(u32));
1596 list_for_each_entry(peer, &cm->peers, node) {
1597 *entry_ptr = (u32)peer->rdev->destid;
1604 ((u32 *)buf)[0] = i; /* report an updated number of entries */
1605 ((u32 *)buf)[1] = info[1]; /* put back an mport ID */
1606 if (copy_to_user(arg, buf, sizeof(u32) * (info[0] + 2)))
1614 * cm_mport_get_list() - Returns list of available local mport devices
1616 static int cm_mport_get_list(void __user *arg)
1625 if (copy_from_user(&entries, arg, sizeof(entries)))
1627 if (entries == 0 || entries > RIO_MAX_MPORTS)
1629 buf = kcalloc(entries + 1, sizeof(u32), GFP_KERNEL);
1633 /* Scan all registered cm_dev objects */
1634 entry_ptr = (u32 *)((uintptr_t)buf + sizeof(u32));
1635 down_read(&rdev_sem);
1636 list_for_each_entry(cm, &cm_dev_list, list) {
1637 if (count++ < entries) {
1638 *entry_ptr = (cm->mport->id << 16) |
1639 cm->mport->host_deviceid;
1645 *((u32 *)buf) = count; /* report a real number of entries */
1646 if (copy_to_user(arg, buf, sizeof(u32) * (count + 1)))
1654 * cm_chan_create() - Create a message exchange channel
1656 static int cm_chan_create(struct file *filp, void __user *arg)
1658 u16 __user *p = arg;
1660 struct rio_channel *ch;
1662 if (get_user(ch_num, p))
1665 riocm_debug(CHOP, "ch_%d requested by %s(%d)",
1666 ch_num, current->comm, task_pid_nr(current));
1667 ch = riocm_ch_create(&ch_num);
1672 riocm_debug(CHOP, "ch_%d created by %s(%d)",
1673 ch_num, current->comm, task_pid_nr(current));
1674 return put_user(ch_num, p);
1678 * cm_chan_close() - Close channel
1679 * @filp: Pointer to file object
1680 * @arg: Channel to close
1682 static int cm_chan_close(struct file *filp, void __user *arg)
1684 u16 __user *p = arg;
1686 struct rio_channel *ch;
1688 if (get_user(ch_num, p))
1691 riocm_debug(CHOP, "ch_%d by %s(%d)",
1692 ch_num, current->comm, task_pid_nr(current));
1694 spin_lock_bh(&idr_lock);
1695 ch = idr_find(&ch_idr, ch_num);
1697 spin_unlock_bh(&idr_lock);
1700 if (ch->filp != filp) {
1701 spin_unlock_bh(&idr_lock);
1704 idr_remove(&ch_idr, ch->id);
1705 spin_unlock_bh(&idr_lock);
1707 return riocm_ch_close(ch);
1711 * cm_chan_bind() - Bind channel
1712 * @arg: Channel number
1714 static int cm_chan_bind(void __user *arg)
1716 struct rio_cm_channel chan;
1718 if (copy_from_user(&chan, arg, sizeof(chan)))
1720 if (chan.mport_id >= RIO_MAX_MPORTS)
1723 return riocm_ch_bind(chan.id, chan.mport_id, NULL);
1727 * cm_chan_listen() - Listen on channel
1728 * @arg: Channel number
1730 static int cm_chan_listen(void __user *arg)
1732 u16 __user *p = arg;
1735 if (get_user(ch_num, p))
1738 return riocm_ch_listen(ch_num);
1742 * cm_chan_accept() - Accept incoming connection
1743 * @filp: Pointer to file object
1744 * @arg: Channel number
1746 static int cm_chan_accept(struct file *filp, void __user *arg)
1748 struct rio_cm_accept param;
1750 struct rio_channel *ch;
1752 if (copy_from_user(¶m, arg, sizeof(param)))
1755 riocm_debug(CHOP, "on ch_%d by %s(%d)",
1756 param.ch_num, current->comm, task_pid_nr(current));
1758 accept_to = param.wait_to ?
1759 msecs_to_jiffies(param.wait_to) : 0;
1761 ch = riocm_ch_accept(param.ch_num, ¶m.ch_num, accept_to);
1766 riocm_debug(CHOP, "new ch_%d for %s(%d)",
1767 ch->id, current->comm, task_pid_nr(current));
1769 if (copy_to_user(arg, ¶m, sizeof(param)))
1775 * cm_chan_connect() - Connect on channel
1776 * @arg: Channel information
1778 static int cm_chan_connect(void __user *arg)
1780 struct rio_cm_channel chan;
1782 struct cm_peer *peer;
1785 if (copy_from_user(&chan, arg, sizeof(chan)))
1787 if (chan.mport_id >= RIO_MAX_MPORTS)
1790 down_read(&rdev_sem);
1792 /* Find matching cm_dev object */
1793 list_for_each_entry(cm, &cm_dev_list, list) {
1794 if (cm->mport->id == chan.mport_id) {
1803 if (chan.remote_destid >= RIO_ANY_DESTID(cm->mport->sys_size)) {
1808 /* Find corresponding RapidIO endpoint device object */
1811 list_for_each_entry(peer, &cm->peers, node) {
1812 if (peer->rdev->destid == chan.remote_destid) {
1823 return riocm_ch_connect(chan.id, cm, peer, chan.remote_channel);
1830 * cm_chan_msg_send() - Send a message through channel
1831 * @arg: Outbound message information
1833 static int cm_chan_msg_send(void __user *arg)
1835 struct rio_cm_msg msg;
1839 if (copy_from_user(&msg, arg, sizeof(msg)))
1841 if (msg.size > RIO_MAX_MSG_SIZE)
1844 buf = memdup_user((void __user *)(uintptr_t)msg.msg, msg.size);
1846 return PTR_ERR(buf);
1848 ret = riocm_ch_send(msg.ch_num, buf, msg.size);
1855 * cm_chan_msg_rcv() - Receive a message through channel
1856 * @arg: Inbound message information
1858 static int cm_chan_msg_rcv(void __user *arg)
1860 struct rio_cm_msg msg;
1861 struct rio_channel *ch;
1864 int ret = 0, msg_size;
1866 if (copy_from_user(&msg, arg, sizeof(msg)))
1869 if (msg.ch_num == 0 || msg.size == 0)
1872 ch = riocm_get_channel(msg.ch_num);
1876 rxto = msg.rxto ? msecs_to_jiffies(msg.rxto) : MAX_SCHEDULE_TIMEOUT;
1878 ret = riocm_ch_receive(ch, &buf, rxto);
1882 msg_size = min(msg.size, (u16)(RIO_MAX_MSG_SIZE));
1884 if (copy_to_user((void __user *)(uintptr_t)msg.msg, buf, msg_size))
1887 riocm_ch_free_rxbuf(ch, buf);
1889 riocm_put_channel(ch);
1894 * riocm_cdev_ioctl() - IOCTL requests handler
1897 riocm_cdev_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1900 case RIO_CM_EP_GET_LIST_SIZE:
1901 return cm_ep_get_list_size((void __user *)arg);
1902 case RIO_CM_EP_GET_LIST:
1903 return cm_ep_get_list((void __user *)arg);
1904 case RIO_CM_CHAN_CREATE:
1905 return cm_chan_create(filp, (void __user *)arg);
1906 case RIO_CM_CHAN_CLOSE:
1907 return cm_chan_close(filp, (void __user *)arg);
1908 case RIO_CM_CHAN_BIND:
1909 return cm_chan_bind((void __user *)arg);
1910 case RIO_CM_CHAN_LISTEN:
1911 return cm_chan_listen((void __user *)arg);
1912 case RIO_CM_CHAN_ACCEPT:
1913 return cm_chan_accept(filp, (void __user *)arg);
1914 case RIO_CM_CHAN_CONNECT:
1915 return cm_chan_connect((void __user *)arg);
1916 case RIO_CM_CHAN_SEND:
1917 return cm_chan_msg_send((void __user *)arg);
1918 case RIO_CM_CHAN_RECEIVE:
1919 return cm_chan_msg_rcv((void __user *)arg);
1920 case RIO_CM_MPORT_GET_LIST:
1921 return cm_mport_get_list((void __user *)arg);
1929 static const struct file_operations riocm_cdev_fops = {
1930 .owner = THIS_MODULE,
1931 .open = riocm_cdev_open,
1932 .release = riocm_cdev_release,
1933 .unlocked_ioctl = riocm_cdev_ioctl,
1937 * riocm_add_dev - add new remote RapidIO device into channel management core
1938 * @dev: device object associated with RapidIO device
1939 * @sif: subsystem interface
1941 * Adds the specified RapidIO device (if applicable) into peers list of
1942 * the corresponding channel management device (cm_dev).
1944 static int riocm_add_dev(struct device *dev, struct subsys_interface *sif)
1946 struct cm_peer *peer;
1947 struct rio_dev *rdev = to_rio_dev(dev);
1950 /* Check if the remote device has capabilities required to support CM */
1951 if (!dev_cm_capable(rdev))
1954 riocm_debug(RDEV, "(%s)", rio_name(rdev));
1956 peer = kmalloc(sizeof(*peer), GFP_KERNEL);
1960 /* Find a corresponding cm_dev object */
1961 down_write(&rdev_sem);
1962 list_for_each_entry(cm, &cm_dev_list, list) {
1963 if (cm->mport == rdev->net->hport)
1967 up_write(&rdev_sem);
1973 list_add_tail(&peer->node, &cm->peers);
1976 up_write(&rdev_sem);
1981 * riocm_remove_dev - remove remote RapidIO device from channel management core
1982 * @dev: device object associated with RapidIO device
1983 * @sif: subsystem interface
1985 * Removes the specified RapidIO device (if applicable) from peers list of
1986 * the corresponding channel management device (cm_dev).
1988 static void riocm_remove_dev(struct device *dev, struct subsys_interface *sif)
1990 struct rio_dev *rdev = to_rio_dev(dev);
1992 struct cm_peer *peer;
1993 struct rio_channel *ch, *_c;
1998 /* Check if the remote device has capabilities required to support CM */
1999 if (!dev_cm_capable(rdev))
2002 riocm_debug(RDEV, "(%s)", rio_name(rdev));
2004 /* Find matching cm_dev object */
2005 down_write(&rdev_sem);
2006 list_for_each_entry(cm, &cm_dev_list, list) {
2007 if (cm->mport == rdev->net->hport) {
2014 up_write(&rdev_sem);
2018 /* Remove remote device from the list of peers */
2020 list_for_each_entry(peer, &cm->peers, node) {
2021 if (peer->rdev == rdev) {
2022 riocm_debug(RDEV, "removing peer %s", rio_name(rdev));
2024 list_del(&peer->node);
2031 up_write(&rdev_sem);
2037 * Release channels associated with this peer
2040 spin_lock_bh(&idr_lock);
2041 idr_for_each_entry(&ch_idr, ch, i) {
2042 if (ch && ch->rdev == rdev) {
2043 if (atomic_read(&rdev->state) != RIO_DEVICE_SHUTDOWN)
2044 riocm_exch(ch, RIO_CM_DISCONNECT);
2045 idr_remove(&ch_idr, ch->id);
2046 list_add(&ch->ch_node, &list);
2049 spin_unlock_bh(&idr_lock);
2051 if (!list_empty(&list)) {
2052 list_for_each_entry_safe(ch, _c, &list, ch_node) {
2053 list_del(&ch->ch_node);
2060 * riocm_cdev_add() - Create rio_cm char device
2061 * @devno: device number assigned to device (MAJ + MIN)
2063 static int riocm_cdev_add(dev_t devno)
2067 cdev_init(&riocm_cdev.cdev, &riocm_cdev_fops);
2068 riocm_cdev.cdev.owner = THIS_MODULE;
2069 ret = cdev_add(&riocm_cdev.cdev, devno, 1);
2071 riocm_error("Cannot register a device with error %d", ret);
2075 riocm_cdev.dev = device_create(dev_class, NULL, devno, NULL, DEV_NAME);
2076 if (IS_ERR(riocm_cdev.dev)) {
2077 cdev_del(&riocm_cdev.cdev);
2078 return PTR_ERR(riocm_cdev.dev);
2081 riocm_debug(MPORT, "Added %s cdev(%d:%d)",
2082 DEV_NAME, MAJOR(devno), MINOR(devno));
2088 * riocm_add_mport - add new local mport device into channel management core
2089 * @dev: device object associated with mport
2090 * @class_intf: class interface
2092 * When a new mport device is added, CM immediately reserves inbound and
2093 * outbound RapidIO mailboxes that will be used.
2095 static int riocm_add_mport(struct device *dev,
2096 struct class_interface *class_intf)
2101 struct rio_mport *mport = to_rio_mport(dev);
2103 riocm_debug(MPORT, "add mport %s", mport->name);
2105 cm = kzalloc(sizeof(*cm), GFP_KERNEL);
2111 rc = rio_request_outb_mbox(mport, cm, cmbox,
2112 RIOCM_TX_RING_SIZE, riocm_outb_msg_event);
2114 riocm_error("failed to allocate OBMBOX_%d on %s",
2115 cmbox, mport->name);
2120 rc = rio_request_inb_mbox(mport, cm, cmbox,
2121 RIOCM_RX_RING_SIZE, riocm_inb_msg_event);
2123 riocm_error("failed to allocate IBMBOX_%d on %s",
2124 cmbox, mport->name);
2125 rio_release_outb_mbox(mport, cmbox);
2130 cm->rx_wq = create_workqueue(DRV_NAME "/rxq");
2132 rio_release_inb_mbox(mport, cmbox);
2133 rio_release_outb_mbox(mport, cmbox);
2139 * Allocate and register inbound messaging buffers to be ready
2140 * to receive channel and system management requests
2142 for (i = 0; i < RIOCM_RX_RING_SIZE; i++)
2143 cm->rx_buf[i] = NULL;
2145 cm->rx_slots = RIOCM_RX_RING_SIZE;
2146 mutex_init(&cm->rx_lock);
2147 riocm_rx_fill(cm, RIOCM_RX_RING_SIZE);
2148 INIT_WORK(&cm->rx_work, rio_ibmsg_handler);
2152 cm->tx_ack_slot = 0;
2153 spin_lock_init(&cm->tx_lock);
2155 INIT_LIST_HEAD(&cm->peers);
2157 INIT_LIST_HEAD(&cm->tx_reqs);
2159 down_write(&rdev_sem);
2160 list_add_tail(&cm->list, &cm_dev_list);
2161 up_write(&rdev_sem);
2167 * riocm_remove_mport - remove local mport device from channel management core
2168 * @dev: device object associated with mport
2169 * @class_intf: class interface
2171 * Removes a local mport device from the list of registered devices that provide
2172 * channel management services. Returns an error if the specified mport is not
2173 * registered with the CM core.
2175 static void riocm_remove_mport(struct device *dev,
2176 struct class_interface *class_intf)
2178 struct rio_mport *mport = to_rio_mport(dev);
2180 struct cm_peer *peer, *temp;
2181 struct rio_channel *ch, *_c;
2186 riocm_debug(MPORT, "%s", mport->name);
2188 /* Find a matching cm_dev object */
2189 down_write(&rdev_sem);
2190 list_for_each_entry(cm, &cm_dev_list, list) {
2191 if (cm->mport == mport) {
2192 list_del(&cm->list);
2197 up_write(&rdev_sem);
2201 flush_workqueue(cm->rx_wq);
2202 destroy_workqueue(cm->rx_wq);
2204 /* Release channels bound to this mport */
2205 spin_lock_bh(&idr_lock);
2206 idr_for_each_entry(&ch_idr, ch, i) {
2207 if (ch->cmdev == cm) {
2208 riocm_debug(RDEV, "%s drop ch_%d",
2209 mport->name, ch->id);
2210 idr_remove(&ch_idr, ch->id);
2211 list_add(&ch->ch_node, &list);
2214 spin_unlock_bh(&idr_lock);
2216 if (!list_empty(&list)) {
2217 list_for_each_entry_safe(ch, _c, &list, ch_node) {
2218 list_del(&ch->ch_node);
2223 rio_release_inb_mbox(mport, cmbox);
2224 rio_release_outb_mbox(mport, cmbox);
2226 /* Remove and free peer entries */
2227 if (!list_empty(&cm->peers))
2228 riocm_debug(RDEV, "ATTN: peer list not empty");
2229 list_for_each_entry_safe(peer, temp, &cm->peers, node) {
2230 riocm_debug(RDEV, "removing peer %s", rio_name(peer->rdev));
2231 list_del(&peer->node);
2237 riocm_debug(MPORT, "%s done", mport->name);
2240 static int rio_cm_shutdown(struct notifier_block *nb, unsigned long code,
2243 struct rio_channel *ch;
2247 riocm_debug(EXIT, ".");
2250 * If there are any channels left in connected state send
2251 * close notification to the connection partner.
2252 * First build a list of channels that require a closing
2253 * notification because function riocm_send_close() should
2254 * be called outside of spinlock protected code.
2256 spin_lock_bh(&idr_lock);
2257 idr_for_each_entry(&ch_idr, ch, i) {
2258 if (ch->state == RIO_CM_CONNECTED) {
2259 riocm_debug(EXIT, "close ch %d", ch->id);
2260 idr_remove(&ch_idr, ch->id);
2261 list_add(&ch->ch_node, &list);
2264 spin_unlock_bh(&idr_lock);
2266 list_for_each_entry(ch, &list, ch_node)
2267 riocm_send_close(ch);
2273 * riocm_interface handles addition/removal of remote RapidIO devices
2275 static struct subsys_interface riocm_interface = {
2277 .subsys = &rio_bus_type,
2278 .add_dev = riocm_add_dev,
2279 .remove_dev = riocm_remove_dev,
2283 * rio_mport_interface handles addition/removal local mport devices
2285 static struct class_interface rio_mport_interface __refdata = {
2286 .class = &rio_mport_class,
2287 .add_dev = riocm_add_mport,
2288 .remove_dev = riocm_remove_mport,
2291 static struct notifier_block rio_cm_notifier = {
2292 .notifier_call = rio_cm_shutdown,
2295 static int __init riocm_init(void)
2299 /* Create device class needed by udev */
2300 dev_class = class_create(THIS_MODULE, DRV_NAME);
2301 if (IS_ERR(dev_class)) {
2302 riocm_error("Cannot create " DRV_NAME " class");
2303 return PTR_ERR(dev_class);
2306 ret = alloc_chrdev_region(&dev_number, 0, 1, DRV_NAME);
2308 class_destroy(dev_class);
2312 dev_major = MAJOR(dev_number);
2313 dev_minor_base = MINOR(dev_number);
2314 riocm_debug(INIT, "Registered class with %d major", dev_major);
2317 * Register as rapidio_port class interface to get notifications about
2318 * mport additions and removals.
2320 ret = class_interface_register(&rio_mport_interface);
2322 riocm_error("class_interface_register error: %d", ret);
2327 * Register as RapidIO bus interface to get notifications about
2328 * addition/removal of remote RapidIO devices.
2330 ret = subsys_interface_register(&riocm_interface);
2332 riocm_error("subsys_interface_register error: %d", ret);
2336 ret = register_reboot_notifier(&rio_cm_notifier);
2338 riocm_error("failed to register reboot notifier (err=%d)", ret);
2342 ret = riocm_cdev_add(dev_number);
2344 unregister_reboot_notifier(&rio_cm_notifier);
2351 subsys_interface_unregister(&riocm_interface);
2353 class_interface_unregister(&rio_mport_interface);
2355 unregister_chrdev_region(dev_number, 1);
2356 class_destroy(dev_class);
2360 static void __exit riocm_exit(void)
2362 riocm_debug(EXIT, "enter");
2363 unregister_reboot_notifier(&rio_cm_notifier);
2364 subsys_interface_unregister(&riocm_interface);
2365 class_interface_unregister(&rio_mport_interface);
2366 idr_destroy(&ch_idr);
2368 device_unregister(riocm_cdev.dev);
2369 cdev_del(&(riocm_cdev.cdev));
2371 class_destroy(dev_class);
2372 unregister_chrdev_region(dev_number, 1);
2375 late_initcall(riocm_init);
2376 module_exit(riocm_exit);