2 * FireWire Serial driver
4 * Copyright (C) 2012 Peter Hurley <peter@hurleysoftware.com>
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.
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.
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/sched.h>
20 #include <linux/slab.h>
21 #include <linux/device.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/rculist.h>
24 #include <linux/workqueue.h>
25 #include <linux/ratelimit.h>
26 #include <linux/bug.h>
27 #include <linux/uaccess.h>
31 #define be32_to_u64(hi, lo) ((u64)be32_to_cpu(hi) << 32 | be32_to_cpu(lo))
33 #define LINUX_VENDOR_ID 0xd00d1eU /* same id used in card root directory */
34 #define FWSERIAL_VERSION 0x00e81cU /* must be unique within LINUX_VENDOR_ID */
36 /* configurable options */
37 static int num_ttys = 4; /* # of std ttys to create per fw_card */
38 /* - doubles as loopback port index */
39 static bool auto_connect = true; /* try to VIRT_CABLE to every peer */
40 static bool create_loop_dev = true; /* create a loopback device for each card */
42 module_param_named(ttys, num_ttys, int, S_IRUGO | S_IWUSR);
43 module_param_named(auto, auto_connect, bool, S_IRUGO | S_IWUSR);
44 module_param_named(loop, create_loop_dev, bool, S_IRUGO | S_IWUSR);
47 * Threshold below which the tty is woken for writing
48 * - should be equal to WAKEUP_CHARS in drivers/tty/n_tty.c because
49 * even if the writer is woken, n_tty_poll() won't set POLLOUT until
50 * our fifo is below this level
52 #define WAKEUP_CHARS 256
55 * fwserial_list: list of every fw_serial created for each fw_card
56 * See discussion in fwserial_probe.
58 static LIST_HEAD(fwserial_list);
59 static DEFINE_MUTEX(fwserial_list_mutex);
62 * port_table: array of tty ports allocated to each fw_card
64 * tty ports are allocated during probe when an fw_serial is first
65 * created for a given fw_card. Ports are allocated in a contiguous block,
66 * each block consisting of 'num_ports' ports.
68 static struct fwtty_port *port_table[MAX_TOTAL_PORTS];
69 static DEFINE_MUTEX(port_table_lock);
70 static bool port_table_corrupt;
71 #define FWTTY_INVALID_INDEX MAX_TOTAL_PORTS
73 #define loop_idx(port) (((port)->index) / num_ports)
74 #define table_idx(loop) ((loop) * num_ports + num_ttys)
76 /* total # of tty ports created per fw_card */
79 /* slab used as pool for struct fwtty_transactions */
80 static struct kmem_cache *fwtty_txn_cache;
82 struct tty_driver *fwtty_driver;
83 static struct tty_driver *fwloop_driver;
85 static struct dentry *fwserial_debugfs;
87 struct fwtty_transaction;
88 typedef void (*fwtty_transaction_cb)(struct fw_card *card, int rcode,
89 void *data, size_t length,
90 struct fwtty_transaction *txn);
92 struct fwtty_transaction {
93 struct fw_transaction fw_txn;
94 fwtty_transaction_cb callback;
95 struct fwtty_port *port;
97 struct dma_pending dma_pended;
101 #define to_device(a, b) (a->b)
102 #define fwtty_err(p, fmt, ...) \
103 dev_err(to_device(p, device), fmt, ##__VA_ARGS__)
104 #define fwtty_info(p, fmt, ...) \
105 dev_info(to_device(p, device), fmt, ##__VA_ARGS__)
106 #define fwtty_notice(p, fmt, ...) \
107 dev_notice(to_device(p, device), fmt, ##__VA_ARGS__)
108 #define fwtty_dbg(p, fmt, ...) \
109 dev_dbg(to_device(p, device), "%s: " fmt, __func__, ##__VA_ARGS__)
110 #define fwtty_err_ratelimited(p, fmt, ...) \
111 dev_err_ratelimited(to_device(p, device), fmt, ##__VA_ARGS__)
114 static inline void debug_short_write(struct fwtty_port *port, int c, int n)
119 spin_lock_bh(&port->lock);
120 avail = dma_fifo_avail(&port->tx_fifo);
121 spin_unlock_bh(&port->lock);
122 fwtty_dbg(port, "short write: avail:%d req:%d wrote:%d\n",
127 #define debug_short_write(port, c, n)
130 static struct fwtty_peer *__fwserial_peer_by_node_id(struct fw_card *card,
131 int generation, int id);
133 #ifdef FWTTY_PROFILING
135 static void fwtty_profile_fifo(struct fwtty_port *port, unsigned *stat)
137 spin_lock_bh(&port->lock);
138 fwtty_profile_data(stat, dma_fifo_avail(&port->tx_fifo));
139 spin_unlock_bh(&port->lock);
142 static void fwtty_dump_profile(struct seq_file *m, struct stats *stats)
144 /* for each stat, print sum of 0 to 2^k, then individually */
150 snprintf(t, 10, "< %d", 1 << k);
151 seq_printf(m, "\n%14s %6s", " ", t);
152 for (j = k + 1; j < DISTRIBUTION_MAX_INDEX; ++j)
153 seq_printf(m, "%6d", 1 << j);
156 for (j = 0, sum = 0; j <= k; ++j)
157 sum += stats->reads[j];
158 seq_printf(m, "\n%14s: %6d", "reads", sum);
159 for (j = k + 1; j <= DISTRIBUTION_MAX_INDEX; ++j)
160 seq_printf(m, "%6d", stats->reads[j]);
162 for (j = 0, sum = 0; j <= k; ++j)
163 sum += stats->writes[j];
164 seq_printf(m, "\n%14s: %6d", "writes", sum);
165 for (j = k + 1; j <= DISTRIBUTION_MAX_INDEX; ++j)
166 seq_printf(m, "%6d", stats->writes[j]);
168 for (j = 0, sum = 0; j <= k; ++j)
169 sum += stats->txns[j];
170 seq_printf(m, "\n%14s: %6d", "txns", sum);
171 for (j = k + 1; j <= DISTRIBUTION_MAX_INDEX; ++j)
172 seq_printf(m, "%6d", stats->txns[j]);
174 for (j = 0, sum = 0; j <= k; ++j)
175 sum += stats->unthrottle[j];
176 seq_printf(m, "\n%14s: %6d", "avail @ unthr", sum);
177 for (j = k + 1; j <= DISTRIBUTION_MAX_INDEX; ++j)
178 seq_printf(m, "%6d", stats->unthrottle[j]);
182 #define fwtty_profile_fifo(port, stat)
183 #define fwtty_dump_profile(m, stats)
187 * Returns the max receive packet size for the given node
188 * Devices which are OHCI v1.0/ v1.1/ v1.2-draft or RFC 2734 compliant
189 * are required by specification to support max_rec of 8 (512 bytes) or more.
191 static inline int device_max_receive(struct fw_device *fw_device)
193 /* see IEEE 1394-2008 table 8-8 */
194 return min(2 << fw_device->max_rec, 4096);
197 static void fwtty_log_tx_error(struct fwtty_port *port, int rcode)
200 case RCODE_SEND_ERROR:
201 fwtty_err_ratelimited(port, "card busy\n");
203 case RCODE_ADDRESS_ERROR:
204 fwtty_err_ratelimited(port, "bad unit addr or write length\n");
206 case RCODE_DATA_ERROR:
207 fwtty_err_ratelimited(port, "failed rx\n");
210 fwtty_err_ratelimited(port, "missing ack\n");
213 fwtty_err_ratelimited(port, "remote busy\n");
216 fwtty_err_ratelimited(port, "failed tx: %d\n", rcode);
220 static void fwtty_txn_constructor(void *this)
222 struct fwtty_transaction *txn = this;
224 init_timer(&txn->fw_txn.split_timeout_timer);
227 static void fwtty_common_callback(struct fw_card *card, int rcode,
228 void *payload, size_t len, void *cb_data)
230 struct fwtty_transaction *txn = cb_data;
231 struct fwtty_port *port = txn->port;
233 if (port && rcode != RCODE_COMPLETE)
234 fwtty_log_tx_error(port, rcode);
236 txn->callback(card, rcode, payload, len, txn);
237 kmem_cache_free(fwtty_txn_cache, txn);
240 static int fwtty_send_data_async(struct fwtty_peer *peer, int tcode,
241 unsigned long long addr, void *payload,
242 size_t len, fwtty_transaction_cb callback,
243 struct fwtty_port *port)
245 struct fwtty_transaction *txn;
248 txn = kmem_cache_alloc(fwtty_txn_cache, GFP_ATOMIC);
252 txn->callback = callback;
255 generation = peer->generation;
257 fw_send_request(peer->serial->card, &txn->fw_txn, tcode,
258 peer->node_id, generation, peer->speed, addr, payload,
259 len, fwtty_common_callback, txn);
263 static void fwtty_send_txn_async(struct fwtty_peer *peer,
264 struct fwtty_transaction *txn, int tcode,
265 unsigned long long addr, void *payload,
266 size_t len, fwtty_transaction_cb callback,
267 struct fwtty_port *port)
271 txn->callback = callback;
274 generation = peer->generation;
276 fw_send_request(peer->serial->card, &txn->fw_txn, tcode,
277 peer->node_id, generation, peer->speed, addr, payload,
278 len, fwtty_common_callback, txn);
282 static void __fwtty_restart_tx(struct fwtty_port *port)
286 len = dma_fifo_out_level(&port->tx_fifo);
288 schedule_delayed_work(&port->drain, 0);
289 avail = dma_fifo_avail(&port->tx_fifo);
291 fwtty_dbg(port, "fifo len: %d avail: %d\n", len, avail);
294 static void fwtty_restart_tx(struct fwtty_port *port)
296 spin_lock_bh(&port->lock);
297 __fwtty_restart_tx(port);
298 spin_unlock_bh(&port->lock);
302 * fwtty_update_port_status - decodes & dispatches line status changes
304 * Note: in loopback, the port->lock is being held. Only use functions that
305 * don't attempt to reclaim the port->lock.
307 static void fwtty_update_port_status(struct fwtty_port *port, unsigned status)
310 struct tty_struct *tty;
312 /* simulated LSR/MSR status from remote */
313 status &= ~MCTRL_MASK;
314 delta = (port->mstatus ^ status) & ~MCTRL_MASK;
315 delta &= ~(status & TIOCM_RNG);
316 port->mstatus = status;
318 if (delta & TIOCM_RNG)
320 if (delta & TIOCM_DSR)
322 if (delta & TIOCM_CAR)
324 if (delta & TIOCM_CTS)
327 fwtty_dbg(port, "status: %x delta: %x\n", status, delta);
329 if (delta & TIOCM_CAR) {
330 tty = tty_port_tty_get(&port->port);
331 if (tty && !C_CLOCAL(tty)) {
332 if (status & TIOCM_CAR)
333 wake_up_interruptible(&port->port.open_wait);
335 schedule_work(&port->hangup);
340 if (delta & TIOCM_CTS) {
341 tty = tty_port_tty_get(&port->port);
342 if (tty && C_CRTSCTS(tty)) {
343 if (tty->hw_stopped) {
344 if (status & TIOCM_CTS) {
347 __fwtty_restart_tx(port);
349 fwtty_restart_tx(port);
352 if (~status & TIOCM_CTS)
358 } else if (delta & OOB_TX_THROTTLE) {
359 tty = tty_port_tty_get(&port->port);
361 if (tty->hw_stopped) {
362 if (~status & OOB_TX_THROTTLE) {
365 __fwtty_restart_tx(port);
367 fwtty_restart_tx(port);
370 if (status & OOB_TX_THROTTLE)
377 if (delta & (UART_LSR_BI << 24)) {
378 if (status & (UART_LSR_BI << 24)) {
379 port->break_last = jiffies;
380 schedule_delayed_work(&port->emit_breaks, 0);
382 /* run emit_breaks one last time (if pending) */
383 mod_delayed_work(system_wq, &port->emit_breaks, 0);
387 if (delta & (TIOCM_DSR | TIOCM_CAR | TIOCM_CTS | TIOCM_RNG))
388 wake_up_interruptible(&port->port.delta_msr_wait);
392 * __fwtty_port_line_status - generate 'line status' for indicated port
394 * This function returns a remote 'MSR' state based on the local 'MCR' state,
395 * as if a null modem cable was attached. The actual status is a mangling
396 * of TIOCM_* bits suitable for sending to a peer's status_addr.
398 * Note: caller must be holding port lock
400 static unsigned __fwtty_port_line_status(struct fwtty_port *port)
404 /* TODO: add module param to tie RNG to DTR as well */
406 if (port->mctrl & TIOCM_DTR)
407 status |= TIOCM_DSR | TIOCM_CAR;
408 if (port->mctrl & TIOCM_RTS)
410 if (port->mctrl & OOB_RX_THROTTLE)
411 status |= OOB_TX_THROTTLE;
412 /* emulate BRK as add'l line status */
414 status |= UART_LSR_BI << 24;
420 * __fwtty_write_port_status - send the port line status to peer
422 * Note: caller must be holding the port lock.
424 static int __fwtty_write_port_status(struct fwtty_port *port)
426 struct fwtty_peer *peer;
428 unsigned status = __fwtty_port_line_status(port);
431 peer = rcu_dereference(port->peer);
433 err = fwtty_send_data_async(peer, TCODE_WRITE_QUADLET_REQUEST,
434 peer->status_addr, &status,
435 sizeof(status), NULL, port);
443 * fwtty_write_port_status - same as above but locked by port lock
445 static int fwtty_write_port_status(struct fwtty_port *port)
449 spin_lock_bh(&port->lock);
450 err = __fwtty_write_port_status(port);
451 spin_unlock_bh(&port->lock);
455 static void fwtty_throttle_port(struct fwtty_port *port)
457 struct tty_struct *tty;
460 tty = tty_port_tty_get(&port->port);
464 spin_lock_bh(&port->lock);
467 port->mctrl |= OOB_RX_THROTTLE;
469 port->mctrl &= ~TIOCM_RTS;
470 if (~old & OOB_RX_THROTTLE)
471 __fwtty_write_port_status(port);
473 spin_unlock_bh(&port->lock);
479 * fwtty_do_hangup - wait for ldisc to deliver all pending rx; only then hangup
481 * When the remote has finished tx, and all in-flight rx has been received and
482 * and pushed to the flip buffer, the remote may close its device. This will
483 * drop DTR on the remote which will drop carrier here. Typically, the tty is
484 * hung up when carrier is dropped or lost.
486 * However, there is a race between the hang up and the line discipline
487 * delivering its data to the reader. A hangup will cause the ldisc to flush
488 * (ie., clear) the read buffer and flip buffer. Because of firewire's
489 * relatively high throughput, the ldisc frequently lags well behind the driver,
490 * resulting in lost data (which has already been received and written to
491 * the flip buffer) when the remote closes its end.
493 * Unfortunately, since the flip buffer offers no direct method for determining
494 * if it holds data, ensuring the ldisc has delivered all data is problematic.
497 /* FIXME: drop this workaround when __tty_hangup waits for ldisc completion */
498 static void fwtty_do_hangup(struct work_struct *work)
500 struct fwtty_port *port = to_port(work, hangup);
501 struct tty_struct *tty;
503 schedule_timeout_uninterruptible(msecs_to_jiffies(50));
505 tty = tty_port_tty_get(&port->port);
512 static void fwtty_emit_breaks(struct work_struct *work)
514 struct fwtty_port *port = to_port(to_delayed_work(work), emit_breaks);
515 static const char buf[16];
516 unsigned long now = jiffies;
517 unsigned long elapsed = now - port->break_last;
518 int n, t, c, brk = 0;
520 /* generate breaks at the line rate (but at least 1) */
521 n = (elapsed * port->cps) / HZ + 1;
522 port->break_last = now;
524 fwtty_dbg(port, "sending %d brks\n", n);
528 c = tty_insert_flip_string_fixed_flag(&port->port, buf,
535 tty_flip_buffer_push(&port->port);
537 if (port->mstatus & (UART_LSR_BI << 24))
538 schedule_delayed_work(&port->emit_breaks, FREQ_BREAKS);
539 port->icount.brk += brk;
542 static int fwtty_rx(struct fwtty_port *port, unsigned char *data, size_t len)
548 fwtty_dbg(port, "%d\n", n);
549 fwtty_profile_data(port->stats.reads, n);
551 if (port->write_only) {
556 /* disregard break status; breaks are generated by emit_breaks work */
557 lsr = (port->mstatus >> 24) & ~UART_LSR_BI;
562 if (lsr & UART_LSR_OE)
563 ++port->icount.overrun;
565 lsr &= port->status_mask;
566 if (lsr & ~port->ignore_mask & UART_LSR_OE) {
567 if (!tty_insert_flip_char(&port->port, 0, TTY_OVERRUN)) {
572 port->overrun = false;
574 if (lsr & port->ignore_mask & ~UART_LSR_OE) {
575 /* TODO: don't drop SAK and Magic SysRq here */
580 c = tty_insert_flip_string_fixed_flag(&port->port, data, TTY_NORMAL, n);
582 tty_flip_buffer_push(&port->port);
586 port->overrun = true;
588 fwtty_err_ratelimited(port, "flip buffer overrun\n");
591 /* throttle the sender if remaining flip buffer space has
592 * reached high watermark to avoid losing data which may be
593 * in-flight. Since the AR request context is 32k, that much
594 * data may have _already_ been acked.
596 if (tty_buffer_space_avail(&port->port) < HIGH_WATERMARK)
597 fwtty_throttle_port(port);
601 port->icount.rx += len;
602 port->stats.lost += n;
607 * fwtty_port_handler - bus address handler for port reads/writes
608 * @parameters: fw_address_callback_t as specified by firewire core interface
610 * This handler is responsible for handling inbound read/write dma from remotes.
612 static void fwtty_port_handler(struct fw_card *card,
613 struct fw_request *request,
614 int tcode, int destination, int source,
616 unsigned long long addr,
617 void *data, size_t len,
620 struct fwtty_port *port = callback_data;
621 struct fwtty_peer *peer;
625 /* Only accept rx from the peer virtual-cabled to this port */
627 peer = __fwserial_peer_by_node_id(card, generation, source);
629 if (!peer || peer != rcu_access_pointer(port->peer)) {
630 rcode = RCODE_ADDRESS_ERROR;
631 fwtty_err_ratelimited(port, "ignoring unauthenticated data\n");
636 case TCODE_WRITE_QUADLET_REQUEST:
637 if (addr != port->rx_handler.offset || len != 4) {
638 rcode = RCODE_ADDRESS_ERROR;
640 fwtty_update_port_status(port, *(unsigned *)data);
641 rcode = RCODE_COMPLETE;
645 case TCODE_WRITE_BLOCK_REQUEST:
646 if (addr != port->rx_handler.offset + 4 ||
647 len > port->rx_handler.length - 4) {
648 rcode = RCODE_ADDRESS_ERROR;
650 err = fwtty_rx(port, data, len);
653 rcode = RCODE_COMPLETE;
656 rcode = RCODE_DATA_ERROR;
659 rcode = RCODE_CONFLICT_ERROR;
666 rcode = RCODE_TYPE_ERROR;
670 fw_send_response(card, request, rcode);
674 * fwtty_tx_complete - callback for tx dma
675 * @data: ignored, has no meaning for write txns
676 * @length: ignored, has no meaning for write txns
678 * The writer must be woken here if the fifo has been emptied because it
679 * may have slept if chars_in_buffer was != 0
681 static void fwtty_tx_complete(struct fw_card *card, int rcode,
682 void *data, size_t length,
683 struct fwtty_transaction *txn)
685 struct fwtty_port *port = txn->port;
688 fwtty_dbg(port, "rcode: %d\n", rcode);
692 spin_lock_bh(&port->lock);
693 dma_fifo_out_complete(&port->tx_fifo, &txn->dma_pended);
694 len = dma_fifo_level(&port->tx_fifo);
695 spin_unlock_bh(&port->lock);
697 port->icount.tx += txn->dma_pended.len;
701 /* TODO: implement retries */
702 spin_lock_bh(&port->lock);
703 dma_fifo_out_complete(&port->tx_fifo, &txn->dma_pended);
704 len = dma_fifo_level(&port->tx_fifo);
705 spin_unlock_bh(&port->lock);
707 port->stats.dropped += txn->dma_pended.len;
710 if (len < WAKEUP_CHARS)
711 tty_port_tty_wakeup(&port->port);
714 static int fwtty_tx(struct fwtty_port *port, bool drain)
716 struct fwtty_peer *peer;
717 struct fwtty_transaction *txn;
718 struct tty_struct *tty;
721 tty = tty_port_tty_get(&port->port);
726 peer = rcu_dereference(port->peer);
732 if (test_and_set_bit(IN_TX, &port->flags)) {
737 /* try to write as many dma transactions out as possible */
739 while (!tty->stopped && !tty->hw_stopped &&
740 !test_bit(STOP_TX, &port->flags)) {
741 txn = kmem_cache_alloc(fwtty_txn_cache, GFP_ATOMIC);
747 spin_lock_bh(&port->lock);
748 n = dma_fifo_out_pend(&port->tx_fifo, &txn->dma_pended);
749 spin_unlock_bh(&port->lock);
751 fwtty_dbg(port, "out: %u rem: %d\n", txn->dma_pended.len, n);
754 kmem_cache_free(fwtty_txn_cache, txn);
756 ++port->stats.tx_stall;
757 } else if (n == -ENODATA) {
758 fwtty_profile_data(port->stats.txns, 0);
760 ++port->stats.fifo_errs;
761 fwtty_err_ratelimited(port, "fifo err: %d\n",
767 fwtty_profile_data(port->stats.txns, txn->dma_pended.len);
769 fwtty_send_txn_async(peer, txn, TCODE_WRITE_BLOCK_REQUEST,
770 peer->fifo_addr, txn->dma_pended.data,
771 txn->dma_pended.len, fwtty_tx_complete,
776 * Stop tx if the 'last view' of the fifo is empty or if
777 * this is the writer and there's not enough data to bother
779 if (n == 0 || (!drain && n < WRITER_MINIMUM))
783 if (n >= 0 || n == -EAGAIN || n == -ENOMEM || n == -ENODATA) {
784 spin_lock_bh(&port->lock);
785 len = dma_fifo_out_level(&port->tx_fifo);
787 unsigned long delay = (n == -ENOMEM) ? HZ : 1;
788 schedule_delayed_work(&port->drain, delay);
790 len = dma_fifo_level(&port->tx_fifo);
791 spin_unlock_bh(&port->lock);
793 /* wakeup the writer */
794 if (drain && len < WAKEUP_CHARS)
798 clear_bit(IN_TX, &port->flags);
799 wake_up_interruptible(&port->wait_tx);
807 static void fwtty_drain_tx(struct work_struct *work)
809 struct fwtty_port *port = to_port(to_delayed_work(work), drain);
811 fwtty_tx(port, true);
814 static void fwtty_write_xchar(struct fwtty_port *port, char ch)
816 struct fwtty_peer *peer;
818 ++port->stats.xchars;
820 fwtty_dbg(port, "%02x\n", ch);
823 peer = rcu_dereference(port->peer);
825 fwtty_send_data_async(peer, TCODE_WRITE_BLOCK_REQUEST,
826 peer->fifo_addr, &ch, sizeof(ch),
832 struct fwtty_port *fwtty_port_get(unsigned index)
834 struct fwtty_port *port;
836 if (index >= MAX_TOTAL_PORTS)
839 mutex_lock(&port_table_lock);
840 port = port_table[index];
842 kref_get(&port->serial->kref);
843 mutex_unlock(&port_table_lock);
846 EXPORT_SYMBOL(fwtty_port_get);
848 static int fwtty_ports_add(struct fw_serial *serial)
853 if (port_table_corrupt)
856 mutex_lock(&port_table_lock);
857 for (i = 0; i + num_ports <= MAX_TOTAL_PORTS; i += num_ports) {
858 if (!port_table[i]) {
859 for (j = 0; j < num_ports; ++i, ++j) {
860 serial->ports[j]->index = i;
861 port_table[i] = serial->ports[j];
867 mutex_unlock(&port_table_lock);
871 static void fwserial_destroy(struct kref *kref)
873 struct fw_serial *serial = to_serial(kref, kref);
874 struct fwtty_port **ports = serial->ports;
875 int j, i = ports[0]->index;
879 mutex_lock(&port_table_lock);
880 for (j = 0; j < num_ports; ++i, ++j) {
881 port_table_corrupt |= port_table[i] != ports[j];
882 WARN_ONCE(port_table_corrupt, "port_table[%d]: %p != ports[%d]: %p",
883 i, port_table[i], j, ports[j]);
885 port_table[i] = NULL;
887 mutex_unlock(&port_table_lock);
889 for (j = 0; j < num_ports; ++j) {
890 fw_core_remove_address_handler(&ports[j]->rx_handler);
891 tty_port_destroy(&ports[j]->port);
897 void fwtty_port_put(struct fwtty_port *port)
899 kref_put(&port->serial->kref, fwserial_destroy);
901 EXPORT_SYMBOL(fwtty_port_put);
903 static void fwtty_port_dtr_rts(struct tty_port *tty_port, int on)
905 struct fwtty_port *port = to_port(tty_port, port);
907 fwtty_dbg(port, "on/off: %d\n", on);
909 spin_lock_bh(&port->lock);
910 /* Don't change carrier state if this is a console */
911 if (!port->port.console) {
913 port->mctrl |= TIOCM_DTR | TIOCM_RTS;
915 port->mctrl &= ~(TIOCM_DTR | TIOCM_RTS);
918 __fwtty_write_port_status(port);
919 spin_unlock_bh(&port->lock);
923 * fwtty_port_carrier_raised: required tty_port operation
925 * This port operation is polled after a tty has been opened and is waiting for
926 * carrier detect -- see drivers/tty/tty_port:tty_port_block_til_ready().
928 static int fwtty_port_carrier_raised(struct tty_port *tty_port)
930 struct fwtty_port *port = to_port(tty_port, port);
933 rc = (port->mstatus & TIOCM_CAR);
935 fwtty_dbg(port, "%d\n", rc);
940 static unsigned set_termios(struct fwtty_port *port, struct tty_struct *tty)
942 unsigned baud, frame;
944 baud = tty_termios_baud_rate(&tty->termios);
945 tty_termios_encode_baud_rate(&tty->termios, baud, baud);
947 /* compute bit count of 2 frames */
948 frame = 12 + ((C_CSTOPB(tty)) ? 4 : 2) + ((C_PARENB(tty)) ? 2 : 0);
950 switch (C_CSIZE(tty)) {
952 frame -= (C_CSTOPB(tty)) ? 1 : 0;
965 port->cps = (baud << 1) / frame;
967 port->status_mask = UART_LSR_OE;
968 if (_I_FLAG(tty, BRKINT | PARMRK))
969 port->status_mask |= UART_LSR_BI;
971 port->ignore_mask = 0;
973 port->ignore_mask |= UART_LSR_BI;
975 port->ignore_mask |= UART_LSR_OE;
978 port->write_only = !C_CREAD(tty);
980 /* turn off echo and newline xlat if loopback */
981 if (port->loopback) {
982 tty->termios.c_lflag &= ~(ECHO | ECHOE | ECHOK | ECHOKE |
983 ECHONL | ECHOPRT | ECHOCTL);
984 tty->termios.c_oflag &= ~ONLCR;
990 static int fwtty_port_activate(struct tty_port *tty_port,
991 struct tty_struct *tty)
993 struct fwtty_port *port = to_port(tty_port, port);
997 set_bit(TTY_IO_ERROR, &tty->flags);
999 err = dma_fifo_alloc(&port->tx_fifo, FWTTY_PORT_TXFIFO_LEN,
1002 FWTTY_PORT_MAX_PEND_DMA,
1007 spin_lock_bh(&port->lock);
1009 baud = set_termios(port, tty);
1011 /* if console, don't change carrier state */
1012 if (!port->port.console) {
1015 port->mctrl = TIOCM_DTR | TIOCM_RTS;
1018 if (C_CRTSCTS(tty) && ~port->mstatus & TIOCM_CTS)
1019 tty->hw_stopped = 1;
1021 __fwtty_write_port_status(port);
1022 spin_unlock_bh(&port->lock);
1024 clear_bit(TTY_IO_ERROR, &tty->flags);
1030 * fwtty_port_shutdown
1032 * Note: the tty port core ensures this is not the console and
1033 * manages TTY_IO_ERROR properly
1035 static void fwtty_port_shutdown(struct tty_port *tty_port)
1037 struct fwtty_port *port = to_port(tty_port, port);
1039 /* TODO: cancel outstanding transactions */
1041 cancel_delayed_work_sync(&port->emit_breaks);
1042 cancel_delayed_work_sync(&port->drain);
1044 spin_lock_bh(&port->lock);
1046 port->break_ctl = 0;
1048 __fwtty_write_port_status(port);
1049 dma_fifo_free(&port->tx_fifo);
1050 spin_unlock_bh(&port->lock);
1053 static int fwtty_open(struct tty_struct *tty, struct file *fp)
1055 struct fwtty_port *port = tty->driver_data;
1057 return tty_port_open(&port->port, tty, fp);
1060 static void fwtty_close(struct tty_struct *tty, struct file *fp)
1062 struct fwtty_port *port = tty->driver_data;
1064 tty_port_close(&port->port, tty, fp);
1067 static void fwtty_hangup(struct tty_struct *tty)
1069 struct fwtty_port *port = tty->driver_data;
1071 tty_port_hangup(&port->port);
1074 static void fwtty_cleanup(struct tty_struct *tty)
1076 struct fwtty_port *port = tty->driver_data;
1078 tty->driver_data = NULL;
1079 fwtty_port_put(port);
1082 static int fwtty_install(struct tty_driver *driver, struct tty_struct *tty)
1084 struct fwtty_port *port = fwtty_port_get(tty->index);
1087 err = tty_standard_install(driver, tty);
1089 tty->driver_data = port;
1091 fwtty_port_put(port);
1095 static int fwloop_install(struct tty_driver *driver, struct tty_struct *tty)
1097 struct fwtty_port *port = fwtty_port_get(table_idx(tty->index));
1100 err = tty_standard_install(driver, tty);
1102 tty->driver_data = port;
1104 fwtty_port_put(port);
1108 static int fwtty_write(struct tty_struct *tty, const unsigned char *buf, int c)
1110 struct fwtty_port *port = tty->driver_data;
1113 fwtty_dbg(port, "%d\n", c);
1114 fwtty_profile_data(port->stats.writes, c);
1116 spin_lock_bh(&port->lock);
1117 n = dma_fifo_in(&port->tx_fifo, buf, c);
1118 len = dma_fifo_out_level(&port->tx_fifo);
1119 if (len < DRAIN_THRESHOLD)
1120 schedule_delayed_work(&port->drain, 1);
1121 spin_unlock_bh(&port->lock);
1123 if (len >= DRAIN_THRESHOLD)
1124 fwtty_tx(port, false);
1126 debug_short_write(port, c, n);
1128 return (n < 0) ? 0 : n;
1131 static int fwtty_write_room(struct tty_struct *tty)
1133 struct fwtty_port *port = tty->driver_data;
1136 spin_lock_bh(&port->lock);
1137 n = dma_fifo_avail(&port->tx_fifo);
1138 spin_unlock_bh(&port->lock);
1140 fwtty_dbg(port, "%d\n", n);
1145 static int fwtty_chars_in_buffer(struct tty_struct *tty)
1147 struct fwtty_port *port = tty->driver_data;
1150 spin_lock_bh(&port->lock);
1151 n = dma_fifo_level(&port->tx_fifo);
1152 spin_unlock_bh(&port->lock);
1154 fwtty_dbg(port, "%d\n", n);
1159 static void fwtty_send_xchar(struct tty_struct *tty, char ch)
1161 struct fwtty_port *port = tty->driver_data;
1163 fwtty_dbg(port, "%02x\n", ch);
1165 fwtty_write_xchar(port, ch);
1168 static void fwtty_throttle(struct tty_struct *tty)
1170 struct fwtty_port *port = tty->driver_data;
1173 * Ignore throttling (but not unthrottling).
1174 * It only makes sense to throttle when data will no longer be
1175 * accepted by the tty flip buffer. For example, it is
1176 * possible for received data to overflow the tty buffer long
1177 * before the line discipline ever has a chance to throttle the driver.
1178 * Additionally, the driver may have already completed the I/O
1179 * but the tty buffer is still emptying, so the line discipline is
1180 * throttling and unthrottling nothing.
1183 ++port->stats.throttled;
1186 static void fwtty_unthrottle(struct tty_struct *tty)
1188 struct fwtty_port *port = tty->driver_data;
1190 fwtty_dbg(port, "CRTSCTS: %d\n", (C_CRTSCTS(tty) != 0));
1192 fwtty_profile_fifo(port, port->stats.unthrottle);
1194 spin_lock_bh(&port->lock);
1195 port->mctrl &= ~OOB_RX_THROTTLE;
1197 port->mctrl |= TIOCM_RTS;
1198 __fwtty_write_port_status(port);
1199 spin_unlock_bh(&port->lock);
1202 static int check_msr_delta(struct fwtty_port *port, unsigned long mask,
1203 struct async_icount *prev)
1205 struct async_icount now;
1210 delta = ((mask & TIOCM_RNG && prev->rng != now.rng) ||
1211 (mask & TIOCM_DSR && prev->dsr != now.dsr) ||
1212 (mask & TIOCM_CAR && prev->dcd != now.dcd) ||
1213 (mask & TIOCM_CTS && prev->cts != now.cts));
1220 static int wait_msr_change(struct fwtty_port *port, unsigned long mask)
1222 struct async_icount prev;
1224 prev = port->icount;
1226 return wait_event_interruptible(port->port.delta_msr_wait,
1227 check_msr_delta(port, mask, &prev));
1230 static int get_serial_info(struct fwtty_port *port,
1231 struct serial_struct __user *info)
1233 struct serial_struct tmp;
1235 memset(&tmp, 0, sizeof(tmp));
1237 tmp.type = PORT_UNKNOWN;
1238 tmp.line = port->port.tty->index;
1239 tmp.flags = port->port.flags;
1240 tmp.xmit_fifo_size = FWTTY_PORT_TXFIFO_LEN;
1241 tmp.baud_base = 400000000;
1242 tmp.close_delay = port->port.close_delay;
1244 return (copy_to_user(info, &tmp, sizeof(*info))) ? -EFAULT : 0;
1247 static int set_serial_info(struct fwtty_port *port,
1248 struct serial_struct __user *info)
1250 struct serial_struct tmp;
1252 if (copy_from_user(&tmp, info, sizeof(tmp)))
1255 if (tmp.irq != 0 || tmp.port != 0 || tmp.custom_divisor != 0 ||
1256 tmp.baud_base != 400000000)
1259 if (!capable(CAP_SYS_ADMIN)) {
1260 if (((tmp.flags & ~ASYNC_USR_MASK) !=
1261 (port->port.flags & ~ASYNC_USR_MASK)))
1264 port->port.close_delay = tmp.close_delay * HZ / 100;
1270 static int fwtty_ioctl(struct tty_struct *tty, unsigned cmd,
1273 struct fwtty_port *port = tty->driver_data;
1278 mutex_lock(&port->port.mutex);
1279 err = get_serial_info(port, (void __user *)arg);
1280 mutex_unlock(&port->port.mutex);
1284 mutex_lock(&port->port.mutex);
1285 err = set_serial_info(port, (void __user *)arg);
1286 mutex_unlock(&port->port.mutex);
1290 err = wait_msr_change(port, arg);
1300 static void fwtty_set_termios(struct tty_struct *tty, struct ktermios *old)
1302 struct fwtty_port *port = tty->driver_data;
1305 spin_lock_bh(&port->lock);
1306 baud = set_termios(port, tty);
1308 if ((baud == 0) && (old->c_cflag & CBAUD)) {
1309 port->mctrl &= ~(TIOCM_DTR | TIOCM_RTS);
1310 } else if ((baud != 0) && !(old->c_cflag & CBAUD)) {
1311 if (C_CRTSCTS(tty) || !test_bit(TTY_THROTTLED, &tty->flags))
1312 port->mctrl |= TIOCM_DTR | TIOCM_RTS;
1314 port->mctrl |= TIOCM_DTR;
1316 __fwtty_write_port_status(port);
1317 spin_unlock_bh(&port->lock);
1319 if (old->c_cflag & CRTSCTS) {
1320 if (!C_CRTSCTS(tty)) {
1321 tty->hw_stopped = 0;
1322 fwtty_restart_tx(port);
1324 } else if (C_CRTSCTS(tty) && ~port->mstatus & TIOCM_CTS) {
1325 tty->hw_stopped = 1;
1330 * fwtty_break_ctl - start/stop sending breaks
1332 * Signals the remote to start or stop generating simulated breaks.
1333 * First, stop dequeueing from the fifo and wait for writer/drain to leave tx
1334 * before signalling the break line status. This guarantees any pending rx will
1335 * be queued to the line discipline before break is simulated on the remote.
1336 * Conversely, turning off break_ctl requires signalling the line status change,
1339 static int fwtty_break_ctl(struct tty_struct *tty, int state)
1341 struct fwtty_port *port = tty->driver_data;
1344 fwtty_dbg(port, "%d\n", state);
1347 set_bit(STOP_TX, &port->flags);
1348 ret = wait_event_interruptible_timeout(port->wait_tx,
1349 !test_bit(IN_TX, &port->flags),
1351 if (ret == 0 || ret == -ERESTARTSYS) {
1352 clear_bit(STOP_TX, &port->flags);
1353 fwtty_restart_tx(port);
1358 spin_lock_bh(&port->lock);
1359 port->break_ctl = (state == -1);
1360 __fwtty_write_port_status(port);
1361 spin_unlock_bh(&port->lock);
1364 spin_lock_bh(&port->lock);
1365 dma_fifo_reset(&port->tx_fifo);
1366 clear_bit(STOP_TX, &port->flags);
1367 spin_unlock_bh(&port->lock);
1372 static int fwtty_tiocmget(struct tty_struct *tty)
1374 struct fwtty_port *port = tty->driver_data;
1377 spin_lock_bh(&port->lock);
1378 tiocm = (port->mctrl & MCTRL_MASK) | (port->mstatus & ~MCTRL_MASK);
1379 spin_unlock_bh(&port->lock);
1381 fwtty_dbg(port, "%x\n", tiocm);
1386 static int fwtty_tiocmset(struct tty_struct *tty, unsigned set, unsigned clear)
1388 struct fwtty_port *port = tty->driver_data;
1390 fwtty_dbg(port, "set: %x clear: %x\n", set, clear);
1392 /* TODO: simulate loopback if TIOCM_LOOP set */
1394 spin_lock_bh(&port->lock);
1395 port->mctrl &= ~(clear & MCTRL_MASK & 0xffff);
1396 port->mctrl |= set & MCTRL_MASK & 0xffff;
1397 __fwtty_write_port_status(port);
1398 spin_unlock_bh(&port->lock);
1402 static int fwtty_get_icount(struct tty_struct *tty,
1403 struct serial_icounter_struct *icount)
1405 struct fwtty_port *port = tty->driver_data;
1408 memcpy(&stats, &port->stats, sizeof(stats));
1409 if (port->port.console)
1410 (*port->fwcon_ops->stats)(&stats, port->con_data);
1412 icount->cts = port->icount.cts;
1413 icount->dsr = port->icount.dsr;
1414 icount->rng = port->icount.rng;
1415 icount->dcd = port->icount.dcd;
1416 icount->rx = port->icount.rx;
1417 icount->tx = port->icount.tx + stats.xchars;
1418 icount->frame = port->icount.frame;
1419 icount->overrun = port->icount.overrun;
1420 icount->parity = port->icount.parity;
1421 icount->brk = port->icount.brk;
1422 icount->buf_overrun = port->icount.overrun;
1426 static void fwtty_proc_show_port(struct seq_file *m, struct fwtty_port *port)
1430 memcpy(&stats, &port->stats, sizeof(stats));
1431 if (port->port.console)
1432 (*port->fwcon_ops->stats)(&stats, port->con_data);
1434 seq_printf(m, " addr:%012llx tx:%d rx:%d", port->rx_handler.offset,
1435 port->icount.tx + stats.xchars, port->icount.rx);
1436 seq_printf(m, " cts:%d dsr:%d rng:%d dcd:%d", port->icount.cts,
1437 port->icount.dsr, port->icount.rng, port->icount.dcd);
1438 seq_printf(m, " fe:%d oe:%d pe:%d brk:%d", port->icount.frame,
1439 port->icount.overrun, port->icount.parity, port->icount.brk);
1442 static void fwtty_debugfs_show_port(struct seq_file *m, struct fwtty_port *port)
1446 memcpy(&stats, &port->stats, sizeof(stats));
1447 if (port->port.console)
1448 (*port->fwcon_ops->stats)(&stats, port->con_data);
1450 seq_printf(m, " dr:%d st:%d err:%d lost:%d", stats.dropped,
1451 stats.tx_stall, stats.fifo_errs, stats.lost);
1452 seq_printf(m, " pkts:%d thr:%d", stats.sent, stats.throttled);
1454 if (port->port.console) {
1456 (*port->fwcon_ops->proc_show)(m, port->con_data);
1459 fwtty_dump_profile(m, &port->stats);
1462 static void fwtty_debugfs_show_peer(struct seq_file *m, struct fwtty_peer *peer)
1464 int generation = peer->generation;
1467 seq_printf(m, " %s:", dev_name(&peer->unit->device));
1468 seq_printf(m, " node:%04x gen:%d", peer->node_id, generation);
1469 seq_printf(m, " sp:%d max:%d guid:%016llx", peer->speed,
1470 peer->max_payload, (unsigned long long) peer->guid);
1471 seq_printf(m, " mgmt:%012llx", (unsigned long long) peer->mgmt_addr);
1472 seq_printf(m, " addr:%012llx", (unsigned long long) peer->status_addr);
1476 static int fwtty_proc_show(struct seq_file *m, void *v)
1478 struct fwtty_port *port;
1481 seq_puts(m, "fwserinfo: 1.0 driver: 1.0\n");
1482 for (i = 0; i < MAX_TOTAL_PORTS && (port = fwtty_port_get(i)); ++i) {
1483 seq_printf(m, "%2d:", i);
1484 if (capable(CAP_SYS_ADMIN))
1485 fwtty_proc_show_port(m, port);
1486 fwtty_port_put(port);
1492 static int fwtty_debugfs_stats_show(struct seq_file *m, void *v)
1494 struct fw_serial *serial = m->private;
1495 struct fwtty_port *port;
1498 for (i = 0; i < num_ports; ++i) {
1499 port = fwtty_port_get(serial->ports[i]->index);
1501 seq_printf(m, "%2d:", port->index);
1502 fwtty_proc_show_port(m, port);
1503 fwtty_debugfs_show_port(m, port);
1504 fwtty_port_put(port);
1511 static int fwtty_debugfs_peers_show(struct seq_file *m, void *v)
1513 struct fw_serial *serial = m->private;
1514 struct fwtty_peer *peer;
1517 seq_printf(m, "card: %s guid: %016llx\n",
1518 dev_name(serial->card->device),
1519 (unsigned long long) serial->card->guid);
1520 list_for_each_entry_rcu(peer, &serial->peer_list, list)
1521 fwtty_debugfs_show_peer(m, peer);
1526 static int fwtty_proc_open(struct inode *inode, struct file *fp)
1528 return single_open(fp, fwtty_proc_show, NULL);
1531 static int fwtty_stats_open(struct inode *inode, struct file *fp)
1533 return single_open(fp, fwtty_debugfs_stats_show, inode->i_private);
1536 static int fwtty_peers_open(struct inode *inode, struct file *fp)
1538 return single_open(fp, fwtty_debugfs_peers_show, inode->i_private);
1541 static const struct file_operations fwtty_stats_fops = {
1542 .owner = THIS_MODULE,
1543 .open = fwtty_stats_open,
1545 .llseek = seq_lseek,
1546 .release = single_release,
1549 static const struct file_operations fwtty_peers_fops = {
1550 .owner = THIS_MODULE,
1551 .open = fwtty_peers_open,
1553 .llseek = seq_lseek,
1554 .release = single_release,
1557 static const struct file_operations fwtty_proc_fops = {
1558 .owner = THIS_MODULE,
1559 .open = fwtty_proc_open,
1561 .llseek = seq_lseek,
1562 .release = single_release,
1565 static const struct tty_port_operations fwtty_port_ops = {
1566 .dtr_rts = fwtty_port_dtr_rts,
1567 .carrier_raised = fwtty_port_carrier_raised,
1568 .shutdown = fwtty_port_shutdown,
1569 .activate = fwtty_port_activate,
1572 static const struct tty_operations fwtty_ops = {
1574 .close = fwtty_close,
1575 .hangup = fwtty_hangup,
1576 .cleanup = fwtty_cleanup,
1577 .install = fwtty_install,
1578 .write = fwtty_write,
1579 .write_room = fwtty_write_room,
1580 .chars_in_buffer = fwtty_chars_in_buffer,
1581 .send_xchar = fwtty_send_xchar,
1582 .throttle = fwtty_throttle,
1583 .unthrottle = fwtty_unthrottle,
1584 .ioctl = fwtty_ioctl,
1585 .set_termios = fwtty_set_termios,
1586 .break_ctl = fwtty_break_ctl,
1587 .tiocmget = fwtty_tiocmget,
1588 .tiocmset = fwtty_tiocmset,
1589 .get_icount = fwtty_get_icount,
1590 .proc_fops = &fwtty_proc_fops,
1593 static const struct tty_operations fwloop_ops = {
1595 .close = fwtty_close,
1596 .hangup = fwtty_hangup,
1597 .cleanup = fwtty_cleanup,
1598 .install = fwloop_install,
1599 .write = fwtty_write,
1600 .write_room = fwtty_write_room,
1601 .chars_in_buffer = fwtty_chars_in_buffer,
1602 .send_xchar = fwtty_send_xchar,
1603 .throttle = fwtty_throttle,
1604 .unthrottle = fwtty_unthrottle,
1605 .ioctl = fwtty_ioctl,
1606 .set_termios = fwtty_set_termios,
1607 .break_ctl = fwtty_break_ctl,
1608 .tiocmget = fwtty_tiocmget,
1609 .tiocmset = fwtty_tiocmset,
1610 .get_icount = fwtty_get_icount,
1613 static inline int mgmt_pkt_expected_len(__be16 code)
1615 static const struct fwserial_mgmt_pkt pkt;
1617 switch (be16_to_cpu(code)) {
1618 case FWSC_VIRT_CABLE_PLUG:
1619 return sizeof(pkt.hdr) + sizeof(pkt.plug_req);
1621 case FWSC_VIRT_CABLE_PLUG_RSP: /* | FWSC_RSP_OK */
1622 return sizeof(pkt.hdr) + sizeof(pkt.plug_rsp);
1625 case FWSC_VIRT_CABLE_UNPLUG:
1626 case FWSC_VIRT_CABLE_UNPLUG_RSP:
1627 case FWSC_VIRT_CABLE_PLUG_RSP | FWSC_RSP_NACK:
1628 case FWSC_VIRT_CABLE_UNPLUG_RSP | FWSC_RSP_NACK:
1629 return sizeof(pkt.hdr);
1636 static inline void fill_plug_params(struct virt_plug_params *params,
1637 struct fwtty_port *port)
1639 u64 status_addr = port->rx_handler.offset;
1640 u64 fifo_addr = port->rx_handler.offset + 4;
1641 size_t fifo_len = port->rx_handler.length - 4;
1643 params->status_hi = cpu_to_be32(status_addr >> 32);
1644 params->status_lo = cpu_to_be32(status_addr);
1645 params->fifo_hi = cpu_to_be32(fifo_addr >> 32);
1646 params->fifo_lo = cpu_to_be32(fifo_addr);
1647 params->fifo_len = cpu_to_be32(fifo_len);
1650 static inline void fill_plug_req(struct fwserial_mgmt_pkt *pkt,
1651 struct fwtty_port *port)
1653 pkt->hdr.code = cpu_to_be16(FWSC_VIRT_CABLE_PLUG);
1654 pkt->hdr.len = cpu_to_be16(mgmt_pkt_expected_len(pkt->hdr.code));
1655 fill_plug_params(&pkt->plug_req, port);
1658 static inline void fill_plug_rsp_ok(struct fwserial_mgmt_pkt *pkt,
1659 struct fwtty_port *port)
1661 pkt->hdr.code = cpu_to_be16(FWSC_VIRT_CABLE_PLUG_RSP);
1662 pkt->hdr.len = cpu_to_be16(mgmt_pkt_expected_len(pkt->hdr.code));
1663 fill_plug_params(&pkt->plug_rsp, port);
1666 static inline void fill_plug_rsp_nack(struct fwserial_mgmt_pkt *pkt)
1668 pkt->hdr.code = cpu_to_be16(FWSC_VIRT_CABLE_PLUG_RSP | FWSC_RSP_NACK);
1669 pkt->hdr.len = cpu_to_be16(mgmt_pkt_expected_len(pkt->hdr.code));
1672 static inline void fill_unplug_req(struct fwserial_mgmt_pkt *pkt)
1674 pkt->hdr.code = cpu_to_be16(FWSC_VIRT_CABLE_UNPLUG);
1675 pkt->hdr.len = cpu_to_be16(mgmt_pkt_expected_len(pkt->hdr.code));
1678 static inline void fill_unplug_rsp_nack(struct fwserial_mgmt_pkt *pkt)
1680 pkt->hdr.code = cpu_to_be16(FWSC_VIRT_CABLE_UNPLUG_RSP | FWSC_RSP_NACK);
1681 pkt->hdr.len = cpu_to_be16(mgmt_pkt_expected_len(pkt->hdr.code));
1684 static inline void fill_unplug_rsp_ok(struct fwserial_mgmt_pkt *pkt)
1686 pkt->hdr.code = cpu_to_be16(FWSC_VIRT_CABLE_UNPLUG_RSP);
1687 pkt->hdr.len = cpu_to_be16(mgmt_pkt_expected_len(pkt->hdr.code));
1690 static void fwserial_virt_plug_complete(struct fwtty_peer *peer,
1691 struct virt_plug_params *params)
1693 struct fwtty_port *port = peer->port;
1695 peer->status_addr = be32_to_u64(params->status_hi, params->status_lo);
1696 peer->fifo_addr = be32_to_u64(params->fifo_hi, params->fifo_lo);
1697 peer->fifo_len = be32_to_cpu(params->fifo_len);
1698 peer_set_state(peer, FWPS_ATTACHED);
1700 /* reconfigure tx_fifo optimally for this peer */
1701 spin_lock_bh(&port->lock);
1702 port->max_payload = min(peer->max_payload, peer->fifo_len);
1703 dma_fifo_change_tx_limit(&port->tx_fifo, port->max_payload);
1704 spin_unlock_bh(&peer->port->lock);
1706 if (port->port.console && port->fwcon_ops->notify != NULL)
1707 (*port->fwcon_ops->notify)(FWCON_NOTIFY_ATTACH, port->con_data);
1709 fwtty_info(&peer->unit, "peer (guid:%016llx) connected on %s\n",
1710 (unsigned long long)peer->guid, dev_name(port->device));
1713 static inline int fwserial_send_mgmt_sync(struct fwtty_peer *peer,
1714 struct fwserial_mgmt_pkt *pkt)
1717 int rcode, tries = 5;
1720 generation = peer->generation;
1723 rcode = fw_run_transaction(peer->serial->card,
1724 TCODE_WRITE_BLOCK_REQUEST,
1726 generation, peer->speed,
1728 pkt, be16_to_cpu(pkt->hdr.len));
1729 if (rcode == RCODE_BUSY || rcode == RCODE_SEND_ERROR ||
1730 rcode == RCODE_GENERATION) {
1731 fwtty_dbg(&peer->unit, "mgmt write error: %d\n", rcode);
1736 } while (--tries > 0);
1741 * fwserial_claim_port - attempt to claim port @ index for peer
1743 * Returns ptr to claimed port or error code (as ERR_PTR())
1744 * Can sleep - must be called from process context
1746 static struct fwtty_port *fwserial_claim_port(struct fwtty_peer *peer,
1749 struct fwtty_port *port;
1751 if (index < 0 || index >= num_ports)
1752 return ERR_PTR(-EINVAL);
1754 /* must guarantee that previous port releases have completed */
1757 port = peer->serial->ports[index];
1758 spin_lock_bh(&port->lock);
1759 if (!rcu_access_pointer(port->peer))
1760 rcu_assign_pointer(port->peer, peer);
1762 port = ERR_PTR(-EBUSY);
1763 spin_unlock_bh(&port->lock);
1769 * fwserial_find_port - find avail port and claim for peer
1771 * Returns ptr to claimed port or NULL if none avail
1772 * Can sleep - must be called from process context
1774 static struct fwtty_port *fwserial_find_port(struct fwtty_peer *peer)
1776 struct fwtty_port **ports = peer->serial->ports;
1779 /* must guarantee that previous port releases have completed */
1782 /* TODO: implement optional GUID-to-specific port # matching */
1784 /* find an unattached port (but not the loopback port, if present) */
1785 for (i = 0; i < num_ttys; ++i) {
1786 spin_lock_bh(&ports[i]->lock);
1787 if (!ports[i]->peer) {
1789 rcu_assign_pointer(ports[i]->peer, peer);
1790 spin_unlock_bh(&ports[i]->lock);
1793 spin_unlock_bh(&ports[i]->lock);
1798 static void fwserial_release_port(struct fwtty_port *port, bool reset)
1800 /* drop carrier (and all other line status) */
1802 fwtty_update_port_status(port, 0);
1804 spin_lock_bh(&port->lock);
1806 /* reset dma fifo max transmission size back to S100 */
1807 port->max_payload = link_speed_to_max_payload(SCODE_100);
1808 dma_fifo_change_tx_limit(&port->tx_fifo, port->max_payload);
1810 RCU_INIT_POINTER(port->peer, NULL);
1811 spin_unlock_bh(&port->lock);
1813 if (port->port.console && port->fwcon_ops->notify != NULL)
1814 (*port->fwcon_ops->notify)(FWCON_NOTIFY_DETACH, port->con_data);
1817 static void fwserial_plug_timeout(unsigned long data)
1819 struct fwtty_peer *peer = (struct fwtty_peer *)data;
1820 struct fwtty_port *port;
1822 spin_lock_bh(&peer->lock);
1823 if (peer->state != FWPS_PLUG_PENDING) {
1824 spin_unlock_bh(&peer->lock);
1828 port = peer_revert_state(peer);
1829 spin_unlock_bh(&peer->lock);
1832 fwserial_release_port(port, false);
1836 * fwserial_connect_peer - initiate virtual cable with peer
1838 * Returns 0 if VIRT_CABLE_PLUG request was successfully sent,
1839 * otherwise error code. Must be called from process context.
1841 static int fwserial_connect_peer(struct fwtty_peer *peer)
1843 struct fwtty_port *port;
1844 struct fwserial_mgmt_pkt *pkt;
1847 pkt = kmalloc(sizeof(*pkt), GFP_KERNEL);
1851 port = fwserial_find_port(peer);
1853 fwtty_err(&peer->unit, "avail ports in use\n");
1858 spin_lock_bh(&peer->lock);
1860 /* only initiate VIRT_CABLE_PLUG if peer is currently not attached */
1861 if (peer->state != FWPS_NOT_ATTACHED) {
1867 peer_set_state(peer, FWPS_PLUG_PENDING);
1869 fill_plug_req(pkt, peer->port);
1871 setup_timer(&peer->timer, fwserial_plug_timeout, (unsigned long)peer);
1872 mod_timer(&peer->timer, jiffies + VIRT_CABLE_PLUG_TIMEOUT);
1873 spin_unlock_bh(&peer->lock);
1875 rcode = fwserial_send_mgmt_sync(peer, pkt);
1877 spin_lock_bh(&peer->lock);
1878 if (peer->state == FWPS_PLUG_PENDING && rcode != RCODE_COMPLETE) {
1879 if (rcode == RCODE_CONFLICT_ERROR)
1885 spin_unlock_bh(&peer->lock);
1891 del_timer(&peer->timer);
1892 peer_revert_state(peer);
1894 spin_unlock_bh(&peer->lock);
1895 fwserial_release_port(port, false);
1902 * fwserial_close_port -
1903 * HUP the tty (if the tty exists) and unregister the tty device.
1904 * Only used by the unit driver upon unit removal to disconnect and
1905 * cleanup all attached ports
1907 * The port reference is put by fwtty_cleanup (if a reference was
1910 static void fwserial_close_port(struct tty_driver *driver,
1911 struct fwtty_port *port)
1913 struct tty_struct *tty;
1915 mutex_lock(&port->port.mutex);
1916 tty = tty_port_tty_get(&port->port);
1921 mutex_unlock(&port->port.mutex);
1923 if (driver == fwloop_driver)
1924 tty_unregister_device(driver, loop_idx(port));
1926 tty_unregister_device(driver, port->index);
1930 * fwserial_lookup - finds first fw_serial associated with card
1931 * @card: fw_card to match
1933 * NB: caller must be holding fwserial_list_mutex
1935 static struct fw_serial *fwserial_lookup(struct fw_card *card)
1937 struct fw_serial *serial;
1939 list_for_each_entry(serial, &fwserial_list, list) {
1940 if (card == serial->card)
1948 * __fwserial_lookup_rcu - finds first fw_serial associated with card
1949 * @card: fw_card to match
1951 * NB: caller must be inside rcu_read_lock() section
1953 static struct fw_serial *__fwserial_lookup_rcu(struct fw_card *card)
1955 struct fw_serial *serial;
1957 list_for_each_entry_rcu(serial, &fwserial_list, list) {
1958 if (card == serial->card)
1966 * __fwserial_peer_by_node_id - finds a peer matching the given generation + id
1968 * If a matching peer could not be found for the specified generation/node id,
1969 * this could be because:
1970 * a) the generation has changed and one of the nodes hasn't updated yet
1971 * b) the remote node has created its remote unit device before this
1972 * local node has created its corresponding remote unit device
1973 * In either case, the remote node should retry
1975 * Note: caller must be in rcu_read_lock() section
1977 static struct fwtty_peer *__fwserial_peer_by_node_id(struct fw_card *card,
1978 int generation, int id)
1980 struct fw_serial *serial;
1981 struct fwtty_peer *peer;
1983 serial = __fwserial_lookup_rcu(card);
1986 * Something is very wrong - there should be a matching
1987 * fw_serial structure for every fw_card. Maybe the remote node
1988 * has created its remote unit device before this driver has
1989 * been probed for any unit devices...
1991 fwtty_err(card, "unknown card (guid %016llx)\n",
1992 (unsigned long long) card->guid);
1996 list_for_each_entry_rcu(peer, &serial->peer_list, list) {
1997 int g = peer->generation;
1999 if (generation == g && id == peer->node_id)
2007 static void __dump_peer_list(struct fw_card *card)
2009 struct fw_serial *serial;
2010 struct fwtty_peer *peer;
2012 serial = __fwserial_lookup_rcu(card);
2016 list_for_each_entry_rcu(peer, &serial->peer_list, list) {
2017 int g = peer->generation;
2019 fwtty_dbg(card, "peer(%d:%x) guid: %016llx\n",
2020 g, peer->node_id, (unsigned long long) peer->guid);
2024 #define __dump_peer_list(s)
2027 static void fwserial_auto_connect(struct work_struct *work)
2029 struct fwtty_peer *peer = to_peer(to_delayed_work(work), connect);
2032 err = fwserial_connect_peer(peer);
2033 if (err == -EAGAIN && ++peer->connect_retries < MAX_CONNECT_RETRIES)
2034 schedule_delayed_work(&peer->connect, CONNECT_RETRY_DELAY);
2037 static void fwserial_peer_workfn(struct work_struct *work)
2039 struct fwtty_peer *peer = to_peer(work, work);
2045 * fwserial_add_peer - add a newly probed 'serial' unit device as a 'peer'
2046 * @serial: aggregate representing the specific fw_card to add the peer to
2047 * @unit: 'peer' to create and add to peer_list of serial
2049 * Adds a 'peer' (ie, a local or remote 'serial' unit device) to the list of
2050 * peers for a specific fw_card. Optionally, auto-attach this peer to an
2051 * available tty port. This function is called either directly or indirectly
2052 * as a result of a 'serial' unit device being created & probed.
2054 * Note: this function is serialized with fwserial_remove_peer() by the
2055 * fwserial_list_mutex held in fwserial_probe().
2057 * A 1:1 correspondence between an fw_unit and an fwtty_peer is maintained
2058 * via the dev_set_drvdata() for the device of the fw_unit.
2060 static int fwserial_add_peer(struct fw_serial *serial, struct fw_unit *unit)
2062 struct device *dev = &unit->device;
2063 struct fw_device *parent = fw_parent_device(unit);
2064 struct fwtty_peer *peer;
2065 struct fw_csr_iterator ci;
2069 peer = kzalloc(sizeof(*peer), GFP_KERNEL);
2073 peer_set_state(peer, FWPS_NOT_ATTACHED);
2075 dev_set_drvdata(dev, peer);
2077 peer->guid = (u64)parent->config_rom[3] << 32 | parent->config_rom[4];
2078 peer->speed = parent->max_speed;
2079 peer->max_payload = min(device_max_receive(parent),
2080 link_speed_to_max_payload(peer->speed));
2082 generation = parent->generation;
2084 peer->node_id = parent->node_id;
2086 peer->generation = generation;
2088 /* retrieve the mgmt bus addr from the unit directory */
2089 fw_csr_iterator_init(&ci, unit->directory);
2090 while (fw_csr_iterator_next(&ci, &key, &val)) {
2091 if (key == (CSR_OFFSET | CSR_DEPENDENT_INFO)) {
2092 peer->mgmt_addr = CSR_REGISTER_BASE + 4 * val;
2096 if (peer->mgmt_addr == 0ULL) {
2098 * No mgmt address effectively disables VIRT_CABLE_PLUG -
2099 * this peer will not be able to attach to a remote
2101 peer_set_state(peer, FWPS_NO_MGMT_ADDR);
2104 spin_lock_init(&peer->lock);
2107 init_timer(&peer->timer);
2108 INIT_WORK(&peer->work, fwserial_peer_workfn);
2109 INIT_DELAYED_WORK(&peer->connect, fwserial_auto_connect);
2111 /* associate peer with specific fw_card */
2112 peer->serial = serial;
2113 list_add_rcu(&peer->list, &serial->peer_list);
2115 fwtty_info(&peer->unit, "peer added (guid:%016llx)\n",
2116 (unsigned long long)peer->guid);
2118 /* identify the local unit & virt cable to loopback port */
2119 if (parent->is_local) {
2120 serial->self = peer;
2121 if (create_loop_dev) {
2122 struct fwtty_port *port;
2123 port = fwserial_claim_port(peer, num_ttys);
2124 if (!IS_ERR(port)) {
2125 struct virt_plug_params params;
2127 spin_lock_bh(&peer->lock);
2129 fill_plug_params(¶ms, port);
2130 fwserial_virt_plug_complete(peer, ¶ms);
2131 spin_unlock_bh(&peer->lock);
2133 fwtty_write_port_status(port);
2137 } else if (auto_connect) {
2138 /* auto-attach to remote units only (if policy allows) */
2139 schedule_delayed_work(&peer->connect, 1);
2146 * fwserial_remove_peer - remove a 'serial' unit device as a 'peer'
2148 * Remove a 'peer' from its list of peers. This function is only
2149 * called by fwserial_remove() on bus removal of the unit device.
2151 * Note: this function is serialized with fwserial_add_peer() by the
2152 * fwserial_list_mutex held in fwserial_remove().
2154 static void fwserial_remove_peer(struct fwtty_peer *peer)
2156 struct fwtty_port *port;
2158 spin_lock_bh(&peer->lock);
2159 peer_set_state(peer, FWPS_GONE);
2160 spin_unlock_bh(&peer->lock);
2162 cancel_delayed_work_sync(&peer->connect);
2163 cancel_work_sync(&peer->work);
2165 spin_lock_bh(&peer->lock);
2166 /* if this unit is the local unit, clear link */
2167 if (peer == peer->serial->self)
2168 peer->serial->self = NULL;
2170 /* cancel the request timeout timer (if running) */
2171 del_timer(&peer->timer);
2176 list_del_rcu(&peer->list);
2178 fwtty_info(&peer->unit, "peer removed (guid:%016llx)\n",
2179 (unsigned long long)peer->guid);
2181 spin_unlock_bh(&peer->lock);
2184 fwserial_release_port(port, true);
2191 * fwserial_create - init everything to create TTYs for a specific fw_card
2192 * @unit: fw_unit for first 'serial' unit device probed for this fw_card
2194 * This function inits the aggregate structure (an fw_serial instance)
2195 * used to manage the TTY ports registered by a specific fw_card. Also, the
2196 * unit device is added as the first 'peer'.
2198 * This unit device may represent a local unit device (as specified by the
2199 * config ROM unit directory) or it may represent a remote unit device
2200 * (as specified by the reading of the remote node's config ROM).
2202 * Returns 0 to indicate "ownership" of the unit device, or a negative errno
2203 * value to indicate which error.
2205 static int fwserial_create(struct fw_unit *unit)
2207 struct fw_device *parent = fw_parent_device(unit);
2208 struct fw_card *card = parent->card;
2209 struct fw_serial *serial;
2210 struct fwtty_port *port;
2211 struct device *tty_dev;
2215 serial = kzalloc(sizeof(*serial), GFP_KERNEL);
2219 kref_init(&serial->kref);
2220 serial->card = card;
2221 INIT_LIST_HEAD(&serial->peer_list);
2223 for (i = 0; i < num_ports; ++i) {
2224 port = kzalloc(sizeof(*port), GFP_KERNEL);
2229 tty_port_init(&port->port);
2230 port->index = FWTTY_INVALID_INDEX;
2231 port->port.ops = &fwtty_port_ops;
2232 port->serial = serial;
2233 tty_buffer_set_limit(&port->port, 128 * 1024);
2235 spin_lock_init(&port->lock);
2236 INIT_DELAYED_WORK(&port->drain, fwtty_drain_tx);
2237 INIT_DELAYED_WORK(&port->emit_breaks, fwtty_emit_breaks);
2238 INIT_WORK(&port->hangup, fwtty_do_hangup);
2239 init_waitqueue_head(&port->wait_tx);
2240 port->max_payload = link_speed_to_max_payload(SCODE_100);
2241 dma_fifo_init(&port->tx_fifo);
2243 RCU_INIT_POINTER(port->peer, NULL);
2244 serial->ports[i] = port;
2246 /* get unique bus addr region for port's status & recv fifo */
2247 port->rx_handler.length = FWTTY_PORT_RXFIFO_LEN + 4;
2248 port->rx_handler.address_callback = fwtty_port_handler;
2249 port->rx_handler.callback_data = port;
2251 * XXX: use custom memory region above cpu physical memory addrs
2252 * this will ease porting to 64-bit firewire adapters
2254 err = fw_core_add_address_handler(&port->rx_handler,
2255 &fw_high_memory_region);
2261 /* preserve i for error cleanup */
2263 err = fwtty_ports_add(serial);
2265 fwtty_err(&unit, "no space in port table\n");
2269 for (j = 0; j < num_ttys; ++j) {
2270 tty_dev = tty_port_register_device(&serial->ports[j]->port,
2272 serial->ports[j]->index,
2274 if (IS_ERR(tty_dev)) {
2275 err = PTR_ERR(tty_dev);
2276 fwtty_err(&unit, "register tty device error (%d)\n",
2278 goto unregister_ttys;
2281 serial->ports[j]->device = tty_dev;
2283 /* preserve j for error cleanup */
2285 if (create_loop_dev) {
2286 struct device *loop_dev;
2288 loop_dev = tty_port_register_device(&serial->ports[j]->port,
2290 loop_idx(serial->ports[j]),
2292 if (IS_ERR(loop_dev)) {
2293 err = PTR_ERR(loop_dev);
2294 fwtty_err(&unit, "create loop device failed (%d)\n",
2296 goto unregister_ttys;
2298 serial->ports[j]->device = loop_dev;
2299 serial->ports[j]->loopback = true;
2302 if (!IS_ERR_OR_NULL(fwserial_debugfs)) {
2303 serial->debugfs = debugfs_create_dir(dev_name(&unit->device),
2305 if (!IS_ERR_OR_NULL(serial->debugfs)) {
2306 debugfs_create_file("peers", 0444, serial->debugfs,
2307 serial, &fwtty_peers_fops);
2308 debugfs_create_file("stats", 0444, serial->debugfs,
2309 serial, &fwtty_stats_fops);
2313 list_add_rcu(&serial->list, &fwserial_list);
2315 fwtty_notice(&unit, "TTY over FireWire on device %s (guid %016llx)\n",
2316 dev_name(card->device), (unsigned long long) card->guid);
2318 err = fwserial_add_peer(serial, unit);
2322 fwtty_err(&unit, "unable to add peer unit device (%d)\n", err);
2324 /* fall-through to error processing */
2325 debugfs_remove_recursive(serial->debugfs);
2327 list_del_rcu(&serial->list);
2328 if (create_loop_dev)
2329 tty_unregister_device(fwloop_driver,
2330 loop_idx(serial->ports[j]));
2332 for (--j; j >= 0; --j)
2333 tty_unregister_device(fwtty_driver, serial->ports[j]->index);
2334 kref_put(&serial->kref, fwserial_destroy);
2338 for (--i; i >= 0; --i) {
2339 tty_port_destroy(&serial->ports[i]->port);
2340 kfree(serial->ports[i]);
2347 * fwserial_probe: bus probe function for firewire 'serial' unit devices
2349 * A 'serial' unit device is created and probed as a result of:
2350 * - declaring a ieee1394 bus id table for 'devices' matching a fabricated
2351 * 'serial' unit specifier id
2352 * - adding a unit directory to the config ROM(s) for a 'serial' unit
2354 * The firewire core registers unit devices by enumerating unit directories
2355 * of a node's config ROM after reading the config ROM when a new node is
2356 * added to the bus topology after a bus reset.
2358 * The practical implications of this are:
2359 * - this probe is called for both local and remote nodes that have a 'serial'
2360 * unit directory in their config ROM (that matches the specifiers in
2361 * fwserial_id_table).
2362 * - no specific order is enforced for local vs. remote unit devices
2364 * This unit driver copes with the lack of specific order in the same way the
2365 * firewire net driver does -- each probe, for either a local or remote unit
2366 * device, is treated as a 'peer' (has a struct fwtty_peer instance) and the
2367 * first peer created for a given fw_card (tracked by the global fwserial_list)
2368 * creates the underlying TTYs (aggregated in a fw_serial instance).
2370 * NB: an early attempt to differentiate local & remote unit devices by creating
2371 * peers only for remote units and fw_serial instances (with their
2372 * associated TTY devices) only for local units was discarded. Managing
2373 * the peer lifetimes on device removal proved too complicated.
2375 * fwserial_probe/fwserial_remove are effectively serialized by the
2376 * fwserial_list_mutex. This is necessary because the addition of the first peer
2377 * for a given fw_card will trigger the creation of the fw_serial for that
2378 * fw_card, which must not simultaneously contend with the removal of the
2379 * last peer for a given fw_card triggering the destruction of the same
2380 * fw_serial for the same fw_card.
2382 static int fwserial_probe(struct fw_unit *unit,
2383 const struct ieee1394_device_id *id)
2385 struct fw_serial *serial;
2388 mutex_lock(&fwserial_list_mutex);
2389 serial = fwserial_lookup(fw_parent_device(unit)->card);
2391 err = fwserial_create(unit);
2393 err = fwserial_add_peer(serial, unit);
2394 mutex_unlock(&fwserial_list_mutex);
2399 * fwserial_remove: bus removal function for firewire 'serial' unit devices
2401 * The corresponding 'peer' for this unit device is removed from the list of
2402 * peers for the associated fw_serial (which has a 1:1 correspondence with a
2403 * specific fw_card). If this is the last peer being removed, then trigger
2404 * the destruction of the underlying TTYs.
2406 static void fwserial_remove(struct fw_unit *unit)
2408 struct fwtty_peer *peer = dev_get_drvdata(&unit->device);
2409 struct fw_serial *serial = peer->serial;
2412 mutex_lock(&fwserial_list_mutex);
2413 fwserial_remove_peer(peer);
2415 if (list_empty(&serial->peer_list)) {
2416 /* unlink from the fwserial_list here */
2417 list_del_rcu(&serial->list);
2419 debugfs_remove_recursive(serial->debugfs);
2421 for (i = 0; i < num_ttys; ++i)
2422 fwserial_close_port(fwtty_driver, serial->ports[i]);
2423 if (create_loop_dev)
2424 fwserial_close_port(fwloop_driver, serial->ports[i]);
2425 kref_put(&serial->kref, fwserial_destroy);
2427 mutex_unlock(&fwserial_list_mutex);
2431 * fwserial_update: bus update function for 'firewire' serial unit devices
2433 * Updates the new node_id and bus generation for this peer. Note that locking
2434 * is unnecessary; but careful memory barrier usage is important to enforce the
2435 * load and store order of generation & node_id.
2437 * The fw-core orders the write of node_id before generation in the parent
2438 * fw_device to ensure that a stale node_id cannot be used with a current
2439 * bus generation. So the generation value must be read before the node_id.
2441 * In turn, this orders the write of node_id before generation in the peer to
2442 * also ensure a stale node_id cannot be used with a current bus generation.
2444 static void fwserial_update(struct fw_unit *unit)
2446 struct fw_device *parent = fw_parent_device(unit);
2447 struct fwtty_peer *peer = dev_get_drvdata(&unit->device);
2450 generation = parent->generation;
2452 peer->node_id = parent->node_id;
2454 peer->generation = generation;
2457 static const struct ieee1394_device_id fwserial_id_table[] = {
2459 .match_flags = IEEE1394_MATCH_SPECIFIER_ID |
2460 IEEE1394_MATCH_VERSION,
2461 .specifier_id = LINUX_VENDOR_ID,
2462 .version = FWSERIAL_VERSION,
2467 static struct fw_driver fwserial_driver = {
2469 .owner = THIS_MODULE,
2470 .name = KBUILD_MODNAME,
2471 .bus = &fw_bus_type,
2473 .probe = fwserial_probe,
2474 .update = fwserial_update,
2475 .remove = fwserial_remove,
2476 .id_table = fwserial_id_table,
2479 #define FW_UNIT_SPECIFIER(id) ((CSR_SPECIFIER_ID << 24) | (id))
2480 #define FW_UNIT_VERSION(ver) ((CSR_VERSION << 24) | (ver))
2481 #define FW_UNIT_ADDRESS(ofs) (((CSR_OFFSET | CSR_DEPENDENT_INFO) << 24) \
2482 | (((ofs) - CSR_REGISTER_BASE) >> 2))
2483 /* XXX: config ROM definitons could be improved with semi-automated offset
2484 * and length calculation
2486 #define FW_ROM_LEN(quads) ((quads) << 16)
2487 #define FW_ROM_DESCRIPTOR(ofs) (((CSR_LEAF | CSR_DESCRIPTOR) << 24) | (ofs))
2489 struct fwserial_unit_directory_data {
2492 u32 unit_sw_version;
2493 u32 unit_addr_offset;
2499 static struct fwserial_unit_directory_data fwserial_unit_directory_data = {
2500 .len_crc = FW_ROM_LEN(4),
2501 .unit_specifier = FW_UNIT_SPECIFIER(LINUX_VENDOR_ID),
2502 .unit_sw_version = FW_UNIT_VERSION(FWSERIAL_VERSION),
2503 .desc1_ofs = FW_ROM_DESCRIPTOR(1),
2504 .desc1_len_crc = FW_ROM_LEN(5),
2506 0x00000000, /* type = text */
2507 0x00000000, /* enc = ASCII, lang EN */
2508 0x4c696e75, /* 'Linux TTY' */
2514 static struct fw_descriptor fwserial_unit_directory = {
2515 .length = sizeof(fwserial_unit_directory_data) / sizeof(u32),
2516 .key = (CSR_DIRECTORY | CSR_UNIT) << 24,
2517 .data = (u32 *)&fwserial_unit_directory_data,
2521 * The management address is in the unit space region but above other known
2522 * address users (to keep wild writes from causing havoc)
2524 static const struct fw_address_region fwserial_mgmt_addr_region = {
2525 .start = CSR_REGISTER_BASE + 0x1e0000ULL,
2526 .end = 0x1000000000000ULL,
2529 static struct fw_address_handler fwserial_mgmt_addr_handler;
2532 * fwserial_handle_plug_req - handle VIRT_CABLE_PLUG request work
2533 * @work: ptr to peer->work
2535 * Attempts to complete the VIRT_CABLE_PLUG handshake sequence for this peer.
2537 * This checks for a collided request-- ie, that a VIRT_CABLE_PLUG request was
2538 * already sent to this peer. If so, the collision is resolved by comparing
2539 * guid values; the loser sends the plug response.
2541 * Note: if an error prevents a response, don't do anything -- the
2542 * remote will timeout its request.
2544 static void fwserial_handle_plug_req(struct work_struct *work)
2546 struct fwtty_peer *peer = to_peer(work, work);
2547 struct virt_plug_params *plug_req = &peer->work_params.plug_req;
2548 struct fwtty_port *port;
2549 struct fwserial_mgmt_pkt *pkt;
2552 pkt = kmalloc(sizeof(*pkt), GFP_KERNEL);
2556 port = fwserial_find_port(peer);
2558 spin_lock_bh(&peer->lock);
2560 switch (peer->state) {
2561 case FWPS_NOT_ATTACHED:
2563 fwtty_err(&peer->unit, "no more ports avail\n");
2564 fill_plug_rsp_nack(pkt);
2567 fill_plug_rsp_ok(pkt, peer->port);
2568 peer_set_state(peer, FWPS_PLUG_RESPONDING);
2569 /* don't release claimed port */
2574 case FWPS_PLUG_PENDING:
2575 if (peer->serial->card->guid > peer->guid)
2578 /* We lost - hijack the already-claimed port and send ok */
2579 del_timer(&peer->timer);
2580 fill_plug_rsp_ok(pkt, peer->port);
2581 peer_set_state(peer, FWPS_PLUG_RESPONDING);
2585 fill_plug_rsp_nack(pkt);
2588 spin_unlock_bh(&peer->lock);
2590 fwserial_release_port(port, false);
2592 rcode = fwserial_send_mgmt_sync(peer, pkt);
2594 spin_lock_bh(&peer->lock);
2595 if (peer->state == FWPS_PLUG_RESPONDING) {
2596 if (rcode == RCODE_COMPLETE) {
2597 struct fwtty_port *tmp = peer->port;
2599 fwserial_virt_plug_complete(peer, plug_req);
2600 spin_unlock_bh(&peer->lock);
2602 fwtty_write_port_status(tmp);
2603 spin_lock_bh(&peer->lock);
2605 fwtty_err(&peer->unit, "PLUG_RSP error (%d)\n", rcode);
2606 port = peer_revert_state(peer);
2610 spin_unlock_bh(&peer->lock);
2612 fwserial_release_port(port, false);
2617 static void fwserial_handle_unplug_req(struct work_struct *work)
2619 struct fwtty_peer *peer = to_peer(work, work);
2620 struct fwtty_port *port = NULL;
2621 struct fwserial_mgmt_pkt *pkt;
2624 pkt = kmalloc(sizeof(*pkt), GFP_KERNEL);
2628 spin_lock_bh(&peer->lock);
2630 switch (peer->state) {
2632 fill_unplug_rsp_ok(pkt);
2633 peer_set_state(peer, FWPS_UNPLUG_RESPONDING);
2636 case FWPS_UNPLUG_PENDING:
2637 if (peer->serial->card->guid > peer->guid)
2640 /* We lost - send unplug rsp */
2641 del_timer(&peer->timer);
2642 fill_unplug_rsp_ok(pkt);
2643 peer_set_state(peer, FWPS_UNPLUG_RESPONDING);
2647 fill_unplug_rsp_nack(pkt);
2650 spin_unlock_bh(&peer->lock);
2652 rcode = fwserial_send_mgmt_sync(peer, pkt);
2654 spin_lock_bh(&peer->lock);
2655 if (peer->state == FWPS_UNPLUG_RESPONDING) {
2656 if (rcode != RCODE_COMPLETE)
2657 fwtty_err(&peer->unit, "UNPLUG_RSP error (%d)\n",
2659 port = peer_revert_state(peer);
2662 spin_unlock_bh(&peer->lock);
2664 fwserial_release_port(port, true);
2669 static int fwserial_parse_mgmt_write(struct fwtty_peer *peer,
2670 struct fwserial_mgmt_pkt *pkt,
2671 unsigned long long addr,
2674 struct fwtty_port *port = NULL;
2678 if (addr != fwserial_mgmt_addr_handler.offset || len < sizeof(pkt->hdr))
2679 return RCODE_ADDRESS_ERROR;
2681 if (len != be16_to_cpu(pkt->hdr.len) ||
2682 len != mgmt_pkt_expected_len(pkt->hdr.code))
2683 return RCODE_DATA_ERROR;
2685 spin_lock_bh(&peer->lock);
2686 if (peer->state == FWPS_GONE) {
2688 * This should never happen - it would mean that the
2689 * remote unit that just wrote this transaction was
2690 * already removed from the bus -- and the removal was
2691 * processed before we rec'd this transaction
2693 fwtty_err(&peer->unit, "peer already removed\n");
2694 spin_unlock_bh(&peer->lock);
2695 return RCODE_ADDRESS_ERROR;
2698 rcode = RCODE_COMPLETE;
2700 fwtty_dbg(&peer->unit, "mgmt: hdr.code: %04hx\n", pkt->hdr.code);
2702 switch (be16_to_cpu(pkt->hdr.code) & FWSC_CODE_MASK) {
2703 case FWSC_VIRT_CABLE_PLUG:
2704 if (work_pending(&peer->work)) {
2705 fwtty_err(&peer->unit, "plug req: busy\n");
2706 rcode = RCODE_CONFLICT_ERROR;
2709 peer->work_params.plug_req = pkt->plug_req;
2710 peer->workfn = fwserial_handle_plug_req;
2711 queue_work(system_unbound_wq, &peer->work);
2715 case FWSC_VIRT_CABLE_PLUG_RSP:
2716 if (peer->state != FWPS_PLUG_PENDING) {
2717 rcode = RCODE_CONFLICT_ERROR;
2719 } else if (be16_to_cpu(pkt->hdr.code) & FWSC_RSP_NACK) {
2720 fwtty_notice(&peer->unit, "NACK plug rsp\n");
2721 port = peer_revert_state(peer);
2724 struct fwtty_port *tmp = peer->port;
2726 fwserial_virt_plug_complete(peer, &pkt->plug_rsp);
2727 spin_unlock_bh(&peer->lock);
2729 fwtty_write_port_status(tmp);
2730 spin_lock_bh(&peer->lock);
2734 case FWSC_VIRT_CABLE_UNPLUG:
2735 if (work_pending(&peer->work)) {
2736 fwtty_err(&peer->unit, "unplug req: busy\n");
2737 rcode = RCODE_CONFLICT_ERROR;
2739 peer->workfn = fwserial_handle_unplug_req;
2740 queue_work(system_unbound_wq, &peer->work);
2744 case FWSC_VIRT_CABLE_UNPLUG_RSP:
2745 if (peer->state != FWPS_UNPLUG_PENDING) {
2746 rcode = RCODE_CONFLICT_ERROR;
2748 if (be16_to_cpu(pkt->hdr.code) & FWSC_RSP_NACK)
2749 fwtty_notice(&peer->unit, "NACK unplug?\n");
2750 port = peer_revert_state(peer);
2756 fwtty_err(&peer->unit, "unknown mgmt code %d\n",
2757 be16_to_cpu(pkt->hdr.code));
2758 rcode = RCODE_DATA_ERROR;
2760 spin_unlock_bh(&peer->lock);
2763 fwserial_release_port(port, reset);
2769 * fwserial_mgmt_handler: bus address handler for mgmt requests
2770 * @parameters: fw_address_callback_t as specified by firewire core interface
2772 * This handler is responsible for handling virtual cable requests from remotes
2775 static void fwserial_mgmt_handler(struct fw_card *card,
2776 struct fw_request *request,
2777 int tcode, int destination, int source,
2779 unsigned long long addr,
2780 void *data, size_t len,
2781 void *callback_data)
2783 struct fwserial_mgmt_pkt *pkt = data;
2784 struct fwtty_peer *peer;
2788 peer = __fwserial_peer_by_node_id(card, generation, source);
2790 fwtty_dbg(card, "peer(%d:%x) not found\n", generation, source);
2791 __dump_peer_list(card);
2792 rcode = RCODE_CONFLICT_ERROR;
2796 case TCODE_WRITE_BLOCK_REQUEST:
2797 rcode = fwserial_parse_mgmt_write(peer, pkt, addr, len);
2801 rcode = RCODE_TYPE_ERROR;
2806 fw_send_response(card, request, rcode);
2809 static int __init fwserial_init(void)
2811 int err, num_loops = !!(create_loop_dev);
2813 /* XXX: placeholder for a "firewire" debugfs node */
2814 fwserial_debugfs = debugfs_create_dir(KBUILD_MODNAME, NULL);
2816 /* num_ttys/num_ports must not be set above the static alloc avail */
2817 if (num_ttys + num_loops > MAX_CARD_PORTS)
2818 num_ttys = MAX_CARD_PORTS - num_loops;
2819 num_ports = num_ttys + num_loops;
2821 fwtty_driver = tty_alloc_driver(MAX_TOTAL_PORTS, TTY_DRIVER_REAL_RAW
2822 | TTY_DRIVER_DYNAMIC_DEV);
2823 if (IS_ERR(fwtty_driver)) {
2824 err = PTR_ERR(fwtty_driver);
2828 fwtty_driver->driver_name = KBUILD_MODNAME;
2829 fwtty_driver->name = tty_dev_name;
2830 fwtty_driver->major = 0;
2831 fwtty_driver->minor_start = 0;
2832 fwtty_driver->type = TTY_DRIVER_TYPE_SERIAL;
2833 fwtty_driver->subtype = SERIAL_TYPE_NORMAL;
2834 fwtty_driver->init_termios = tty_std_termios;
2835 fwtty_driver->init_termios.c_cflag |= CLOCAL;
2836 tty_set_operations(fwtty_driver, &fwtty_ops);
2838 err = tty_register_driver(fwtty_driver);
2840 pr_err("register tty driver failed (%d)\n", err);
2844 if (create_loop_dev) {
2845 fwloop_driver = tty_alloc_driver(MAX_TOTAL_PORTS / num_ports,
2847 | TTY_DRIVER_DYNAMIC_DEV);
2848 if (IS_ERR(fwloop_driver)) {
2849 err = PTR_ERR(fwloop_driver);
2850 goto unregister_driver;
2853 fwloop_driver->driver_name = KBUILD_MODNAME "_loop";
2854 fwloop_driver->name = loop_dev_name;
2855 fwloop_driver->major = 0;
2856 fwloop_driver->minor_start = 0;
2857 fwloop_driver->type = TTY_DRIVER_TYPE_SERIAL;
2858 fwloop_driver->subtype = SERIAL_TYPE_NORMAL;
2859 fwloop_driver->init_termios = tty_std_termios;
2860 fwloop_driver->init_termios.c_cflag |= CLOCAL;
2861 tty_set_operations(fwloop_driver, &fwloop_ops);
2863 err = tty_register_driver(fwloop_driver);
2865 pr_err("register loop driver failed (%d)\n", err);
2870 fwtty_txn_cache = kmem_cache_create("fwtty_txn_cache",
2871 sizeof(struct fwtty_transaction),
2872 0, 0, fwtty_txn_constructor);
2873 if (!fwtty_txn_cache) {
2875 goto unregister_loop;
2879 * Ideally, this address handler would be registered per local node
2880 * (rather than the same handler for all local nodes). However,
2881 * since the firewire core requires the config rom descriptor *before*
2882 * the local unit device(s) are created, a single management handler
2883 * must suffice for all local serial units.
2885 fwserial_mgmt_addr_handler.length = sizeof(struct fwserial_mgmt_pkt);
2886 fwserial_mgmt_addr_handler.address_callback = fwserial_mgmt_handler;
2888 err = fw_core_add_address_handler(&fwserial_mgmt_addr_handler,
2889 &fwserial_mgmt_addr_region);
2891 pr_err("add management handler failed (%d)\n", err);
2895 fwserial_unit_directory_data.unit_addr_offset =
2896 FW_UNIT_ADDRESS(fwserial_mgmt_addr_handler.offset);
2897 err = fw_core_add_descriptor(&fwserial_unit_directory);
2899 pr_err("add unit descriptor failed (%d)\n", err);
2900 goto remove_handler;
2903 err = driver_register(&fwserial_driver.driver);
2905 pr_err("register fwserial driver failed (%d)\n", err);
2906 goto remove_descriptor;
2912 fw_core_remove_descriptor(&fwserial_unit_directory);
2914 fw_core_remove_address_handler(&fwserial_mgmt_addr_handler);
2916 kmem_cache_destroy(fwtty_txn_cache);
2918 if (create_loop_dev)
2919 tty_unregister_driver(fwloop_driver);
2921 if (create_loop_dev)
2922 put_tty_driver(fwloop_driver);
2924 tty_unregister_driver(fwtty_driver);
2926 put_tty_driver(fwtty_driver);
2927 debugfs_remove_recursive(fwserial_debugfs);
2931 static void __exit fwserial_exit(void)
2933 driver_unregister(&fwserial_driver.driver);
2934 fw_core_remove_descriptor(&fwserial_unit_directory);
2935 fw_core_remove_address_handler(&fwserial_mgmt_addr_handler);
2936 kmem_cache_destroy(fwtty_txn_cache);
2937 if (create_loop_dev) {
2938 tty_unregister_driver(fwloop_driver);
2939 put_tty_driver(fwloop_driver);
2941 tty_unregister_driver(fwtty_driver);
2942 put_tty_driver(fwtty_driver);
2943 debugfs_remove_recursive(fwserial_debugfs);
2946 module_init(fwserial_init);
2947 module_exit(fwserial_exit);
2949 MODULE_AUTHOR("Peter Hurley (peter@hurleysoftware.com)");
2950 MODULE_DESCRIPTION("FireWire Serial TTY Driver");
2951 MODULE_LICENSE("GPL");
2952 MODULE_DEVICE_TABLE(ieee1394, fwserial_id_table);
2953 MODULE_PARM_DESC(ttys, "Number of ttys to create for each local firewire node");
2954 MODULE_PARM_DESC(auto, "Auto-connect a tty to each firewire node discovered");
2955 MODULE_PARM_DESC(loop, "Create a loopback device, fwloop<n>, with ttys");