1 // SPDX-License-Identifier: GPL-2.0+
3 * mxuport.c - MOXA UPort series driver
5 * Copyright (c) 2006 Moxa Technologies Co., Ltd.
6 * Copyright (c) 2013 Andrew Lunn <andrew@lunn.ch>
8 * Supports the following Moxa USB to serial converters:
9 * 2 ports : UPort 1250, UPort 1250I
10 * 4 ports : UPort 1410, UPort 1450, UPort 1450I
11 * 8 ports : UPort 1610-8, UPort 1650-8
12 * 16 ports : UPort 1610-16, UPort 1650-16
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/firmware.h>
18 #include <linux/jiffies.h>
19 #include <linux/serial.h>
20 #include <linux/serial_reg.h>
21 #include <linux/slab.h>
22 #include <linux/tty.h>
23 #include <linux/tty_driver.h>
24 #include <linux/tty_flip.h>
25 #include <linux/uaccess.h>
26 #include <linux/usb.h>
27 #include <linux/usb/serial.h>
28 #include <asm/unaligned.h>
30 /* Definitions for the vendor ID and device ID */
31 #define MX_USBSERIAL_VID 0x110A
32 #define MX_UPORT1250_PID 0x1250
33 #define MX_UPORT1251_PID 0x1251
34 #define MX_UPORT1410_PID 0x1410
35 #define MX_UPORT1450_PID 0x1450
36 #define MX_UPORT1451_PID 0x1451
37 #define MX_UPORT1618_PID 0x1618
38 #define MX_UPORT1658_PID 0x1658
39 #define MX_UPORT1613_PID 0x1613
40 #define MX_UPORT1653_PID 0x1653
42 /* Definitions for USB info */
44 #define EVENT_LENGTH 8
45 #define DOWN_BLOCK_SIZE 64
47 /* Definitions for firmware info */
48 #define VER_ADDR_1 0x20
49 #define VER_ADDR_2 0x24
50 #define VER_ADDR_3 0x28
52 /* Definitions for USB vendor request */
53 #define RQ_VENDOR_NONE 0x00
54 #define RQ_VENDOR_SET_BAUD 0x01 /* Set baud rate */
55 #define RQ_VENDOR_SET_LINE 0x02 /* Set line status */
56 #define RQ_VENDOR_SET_CHARS 0x03 /* Set Xon/Xoff chars */
57 #define RQ_VENDOR_SET_RTS 0x04 /* Set RTS */
58 #define RQ_VENDOR_SET_DTR 0x05 /* Set DTR */
59 #define RQ_VENDOR_SET_XONXOFF 0x06 /* Set auto Xon/Xoff */
60 #define RQ_VENDOR_SET_RX_HOST_EN 0x07 /* Set RX host enable */
61 #define RQ_VENDOR_SET_OPEN 0x08 /* Set open/close port */
62 #define RQ_VENDOR_PURGE 0x09 /* Purge Rx/Tx buffer */
63 #define RQ_VENDOR_SET_MCR 0x0A /* Set MCR register */
64 #define RQ_VENDOR_SET_BREAK 0x0B /* Set Break signal */
66 #define RQ_VENDOR_START_FW_DOWN 0x0C /* Start firmware download */
67 #define RQ_VENDOR_STOP_FW_DOWN 0x0D /* Stop firmware download */
68 #define RQ_VENDOR_QUERY_FW_READY 0x0E /* Query if new firmware ready */
70 #define RQ_VENDOR_SET_FIFO_DISABLE 0x0F /* Set fifo disable */
71 #define RQ_VENDOR_SET_INTERFACE 0x10 /* Set interface */
72 #define RQ_VENDOR_SET_HIGH_PERFOR 0x11 /* Set hi-performance */
74 #define RQ_VENDOR_ERASE_BLOCK 0x12 /* Erase flash block */
75 #define RQ_VENDOR_WRITE_PAGE 0x13 /* Write flash page */
76 #define RQ_VENDOR_PREPARE_WRITE 0x14 /* Prepare write flash */
77 #define RQ_VENDOR_CONFIRM_WRITE 0x15 /* Confirm write flash */
78 #define RQ_VENDOR_LOCATE 0x16 /* Locate the device */
80 #define RQ_VENDOR_START_ROM_DOWN 0x17 /* Start firmware download */
81 #define RQ_VENDOR_ROM_DATA 0x18 /* Rom file data */
82 #define RQ_VENDOR_STOP_ROM_DOWN 0x19 /* Stop firmware download */
83 #define RQ_VENDOR_FW_DATA 0x20 /* Firmware data */
85 #define RQ_VENDOR_RESET_DEVICE 0x23 /* Try to reset the device */
86 #define RQ_VENDOR_QUERY_FW_CONFIG 0x24
88 #define RQ_VENDOR_GET_VERSION 0x81 /* Get firmware version */
89 #define RQ_VENDOR_GET_PAGE 0x82 /* Read flash page */
90 #define RQ_VENDOR_GET_ROM_PROC 0x83 /* Get ROM process state */
92 #define RQ_VENDOR_GET_INQUEUE 0x84 /* Data in input buffer */
93 #define RQ_VENDOR_GET_OUTQUEUE 0x85 /* Data in output buffer */
95 #define RQ_VENDOR_GET_MSR 0x86 /* Get modem status register */
97 /* Definitions for UPort event type */
98 #define UPORT_EVENT_NONE 0 /* None */
99 #define UPORT_EVENT_TXBUF_THRESHOLD 1 /* Tx buffer threshold */
100 #define UPORT_EVENT_SEND_NEXT 2 /* Send next */
101 #define UPORT_EVENT_MSR 3 /* Modem status */
102 #define UPORT_EVENT_LSR 4 /* Line status */
103 #define UPORT_EVENT_MCR 5 /* Modem control */
105 /* Definitions for serial event type */
106 #define SERIAL_EV_CTS 0x0008 /* CTS changed state */
107 #define SERIAL_EV_DSR 0x0010 /* DSR changed state */
108 #define SERIAL_EV_RLSD 0x0020 /* RLSD changed state */
110 /* Definitions for modem control event type */
111 #define SERIAL_EV_XOFF 0x40 /* XOFF received */
113 /* Definitions for line control of communication */
114 #define MX_WORDLENGTH_5 5
115 #define MX_WORDLENGTH_6 6
116 #define MX_WORDLENGTH_7 7
117 #define MX_WORDLENGTH_8 8
119 #define MX_PARITY_NONE 0
120 #define MX_PARITY_ODD 1
121 #define MX_PARITY_EVEN 2
122 #define MX_PARITY_MARK 3
123 #define MX_PARITY_SPACE 4
125 #define MX_STOP_BITS_1 0
126 #define MX_STOP_BITS_1_5 1
127 #define MX_STOP_BITS_2 2
129 #define MX_RTS_DISABLE 0x0
130 #define MX_RTS_ENABLE 0x1
131 #define MX_RTS_HW 0x2
132 #define MX_RTS_NO_CHANGE 0x3 /* Flag, not valid register value*/
134 #define MX_INT_RS232 0
135 #define MX_INT_2W_RS485 1
136 #define MX_INT_RS422 2
137 #define MX_INT_4W_RS485 3
139 /* Definitions for holding reason */
140 #define MX_WAIT_FOR_CTS 0x0001
141 #define MX_WAIT_FOR_DSR 0x0002
142 #define MX_WAIT_FOR_DCD 0x0004
143 #define MX_WAIT_FOR_XON 0x0008
144 #define MX_WAIT_FOR_START_TX 0x0010
145 #define MX_WAIT_FOR_UNTHROTTLE 0x0020
146 #define MX_WAIT_FOR_LOW_WATER 0x0040
147 #define MX_WAIT_FOR_SEND_NEXT 0x0080
149 #define MX_UPORT_2_PORT BIT(0)
150 #define MX_UPORT_4_PORT BIT(1)
151 #define MX_UPORT_8_PORT BIT(2)
152 #define MX_UPORT_16_PORT BIT(3)
154 /* This structure holds all of the local port information */
155 struct mxuport_port {
156 u8 mcr_state; /* Last MCR state */
157 u8 msr_state; /* Last MSR state */
158 struct mutex mutex; /* Protects mcr_state */
159 spinlock_t spinlock; /* Protects msr_state */
162 /* Table of devices that work with this driver */
163 static const struct usb_device_id mxuport_idtable[] = {
164 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1250_PID),
165 .driver_info = MX_UPORT_2_PORT },
166 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1251_PID),
167 .driver_info = MX_UPORT_2_PORT },
168 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1410_PID),
169 .driver_info = MX_UPORT_4_PORT },
170 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1450_PID),
171 .driver_info = MX_UPORT_4_PORT },
172 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1451_PID),
173 .driver_info = MX_UPORT_4_PORT },
174 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1618_PID),
175 .driver_info = MX_UPORT_8_PORT },
176 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1658_PID),
177 .driver_info = MX_UPORT_8_PORT },
178 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1613_PID),
179 .driver_info = MX_UPORT_16_PORT },
180 { USB_DEVICE(MX_USBSERIAL_VID, MX_UPORT1653_PID),
181 .driver_info = MX_UPORT_16_PORT },
182 {} /* Terminating entry */
185 MODULE_DEVICE_TABLE(usb, mxuport_idtable);
188 * Add a four byte header containing the port number and the number of
189 * bytes of data in the message. Return the number of bytes in the
192 static int mxuport_prepare_write_buffer(struct usb_serial_port *port,
193 void *dest, size_t size)
198 count = kfifo_out_locked(&port->write_fifo, buf + HEADER_SIZE,
202 put_unaligned_be16(port->port_number, buf);
203 put_unaligned_be16(count, buf + 2);
205 dev_dbg(&port->dev, "%s - size %zd count %d\n", __func__,
208 return count + HEADER_SIZE;
211 /* Read the given buffer in from the control pipe. */
212 static int mxuport_recv_ctrl_urb(struct usb_serial *serial,
213 u8 request, u16 value, u16 index,
214 u8 *data, size_t size)
218 status = usb_control_msg(serial->dev,
219 usb_rcvctrlpipe(serial->dev, 0),
221 (USB_DIR_IN | USB_TYPE_VENDOR |
222 USB_RECIP_DEVICE), value, index,
224 USB_CTRL_GET_TIMEOUT);
226 dev_err(&serial->interface->dev,
227 "%s - usb_control_msg failed (%d)\n",
232 if (status != size) {
233 dev_err(&serial->interface->dev,
234 "%s - short read (%d / %zd)\n",
235 __func__, status, size);
242 /* Write the given buffer out to the control pipe. */
243 static int mxuport_send_ctrl_data_urb(struct usb_serial *serial,
245 u16 value, u16 index,
246 u8 *data, size_t size)
250 status = usb_control_msg(serial->dev,
251 usb_sndctrlpipe(serial->dev, 0),
253 (USB_DIR_OUT | USB_TYPE_VENDOR |
254 USB_RECIP_DEVICE), value, index,
256 USB_CTRL_SET_TIMEOUT);
258 dev_err(&serial->interface->dev,
259 "%s - usb_control_msg failed (%d)\n",
267 /* Send a vendor request without any data */
268 static int mxuport_send_ctrl_urb(struct usb_serial *serial,
269 u8 request, u16 value, u16 index)
271 return mxuport_send_ctrl_data_urb(serial, request, value, index,
276 * mxuport_throttle - throttle function of driver
278 * This function is called by the tty driver when it wants to stop the
279 * data being read from the port. Since all the data comes over one
280 * bulk in endpoint, we cannot stop submitting urbs by setting
281 * port->throttle. Instead tell the device to stop sending us data for
284 static void mxuport_throttle(struct tty_struct *tty)
286 struct usb_serial_port *port = tty->driver_data;
287 struct usb_serial *serial = port->serial;
289 dev_dbg(&port->dev, "%s\n", __func__);
291 mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_RX_HOST_EN,
292 0, port->port_number);
296 * mxuport_unthrottle - unthrottle function of driver
298 * This function is called by the tty driver when it wants to resume
299 * the data being read from the port. Tell the device it can resume
300 * sending us received data from the port.
302 static void mxuport_unthrottle(struct tty_struct *tty)
305 struct usb_serial_port *port = tty->driver_data;
306 struct usb_serial *serial = port->serial;
308 dev_dbg(&port->dev, "%s\n", __func__);
310 mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_RX_HOST_EN,
311 1, port->port_number);
315 * Processes one chunk of data received for a port. Mostly a copy of
316 * usb_serial_generic_process_read_urb().
318 static void mxuport_process_read_urb_data(struct usb_serial_port *port,
319 char *data, int size)
324 for (i = 0; i < size; i++, data++) {
325 if (!usb_serial_handle_sysrq_char(port, *data))
326 tty_insert_flip_char(&port->port, *data,
330 tty_insert_flip_string(&port->port, data, size);
332 tty_flip_buffer_push(&port->port);
335 static void mxuport_msr_event(struct usb_serial_port *port, u8 buf[4])
337 struct mxuport_port *mxport = usb_get_serial_port_data(port);
338 u8 rcv_msr_hold = buf[2] & 0xF0;
339 u16 rcv_msr_event = get_unaligned_be16(buf);
342 if (rcv_msr_event == 0)
345 /* Update MSR status */
346 spin_lock_irqsave(&mxport->spinlock, flags);
348 dev_dbg(&port->dev, "%s - current MSR status = 0x%x\n",
349 __func__, mxport->msr_state);
351 if (rcv_msr_hold & UART_MSR_CTS) {
352 mxport->msr_state |= UART_MSR_CTS;
353 dev_dbg(&port->dev, "%s - CTS high\n", __func__);
355 mxport->msr_state &= ~UART_MSR_CTS;
356 dev_dbg(&port->dev, "%s - CTS low\n", __func__);
359 if (rcv_msr_hold & UART_MSR_DSR) {
360 mxport->msr_state |= UART_MSR_DSR;
361 dev_dbg(&port->dev, "%s - DSR high\n", __func__);
363 mxport->msr_state &= ~UART_MSR_DSR;
364 dev_dbg(&port->dev, "%s - DSR low\n", __func__);
367 if (rcv_msr_hold & UART_MSR_DCD) {
368 mxport->msr_state |= UART_MSR_DCD;
369 dev_dbg(&port->dev, "%s - DCD high\n", __func__);
371 mxport->msr_state &= ~UART_MSR_DCD;
372 dev_dbg(&port->dev, "%s - DCD low\n", __func__);
374 spin_unlock_irqrestore(&mxport->spinlock, flags);
377 (SERIAL_EV_CTS | SERIAL_EV_DSR | SERIAL_EV_RLSD)) {
379 if (rcv_msr_event & SERIAL_EV_CTS) {
381 dev_dbg(&port->dev, "%s - CTS change\n", __func__);
384 if (rcv_msr_event & SERIAL_EV_DSR) {
386 dev_dbg(&port->dev, "%s - DSR change\n", __func__);
389 if (rcv_msr_event & SERIAL_EV_RLSD) {
391 dev_dbg(&port->dev, "%s - DCD change\n", __func__);
393 wake_up_interruptible(&port->port.delta_msr_wait);
397 static void mxuport_lsr_event(struct usb_serial_port *port, u8 buf[4])
399 u8 lsr_event = buf[2];
401 if (lsr_event & UART_LSR_BI) {
403 dev_dbg(&port->dev, "%s - break error\n", __func__);
406 if (lsr_event & UART_LSR_FE) {
407 port->icount.frame++;
408 dev_dbg(&port->dev, "%s - frame error\n", __func__);
411 if (lsr_event & UART_LSR_PE) {
412 port->icount.parity++;
413 dev_dbg(&port->dev, "%s - parity error\n", __func__);
416 if (lsr_event & UART_LSR_OE) {
417 port->icount.overrun++;
418 dev_dbg(&port->dev, "%s - overrun error\n", __func__);
423 * When something interesting happens, modem control lines XON/XOFF
424 * etc, the device sends an event. Process these events.
426 static void mxuport_process_read_urb_event(struct usb_serial_port *port,
427 u8 buf[4], u32 event)
429 dev_dbg(&port->dev, "%s - receive event : %04x\n", __func__, event);
432 case UPORT_EVENT_SEND_NEXT:
434 * Sent as part of the flow control on device buffers.
435 * Not currently used.
438 case UPORT_EVENT_MSR:
439 mxuport_msr_event(port, buf);
441 case UPORT_EVENT_LSR:
442 mxuport_lsr_event(port, buf);
444 case UPORT_EVENT_MCR:
446 * Event to indicate a change in XON/XOFF from the
447 * peer. Currently not used. We just continue
448 * sending the device data and it will buffer it if
449 * needed. This event could be used for flow control
450 * between the host and the device.
454 dev_dbg(&port->dev, "Unexpected event\n");
460 * One URB can contain data for multiple ports. Demultiplex the data,
461 * checking the port exists, is opened and the message is valid.
463 static void mxuport_process_read_urb_demux_data(struct urb *urb)
465 struct usb_serial_port *port = urb->context;
466 struct usb_serial *serial = port->serial;
467 u8 *data = urb->transfer_buffer;
468 u8 *end = data + urb->actual_length;
469 struct usb_serial_port *demux_port;
475 if (data + HEADER_SIZE > end) {
476 dev_warn(&port->dev, "%s - message with short header\n",
481 rcv_port = get_unaligned_be16(data);
482 if (rcv_port >= serial->num_ports) {
483 dev_warn(&port->dev, "%s - message for invalid port\n",
488 demux_port = serial->port[rcv_port];
489 rcv_len = get_unaligned_be16(data + 2);
490 if (!rcv_len || data + HEADER_SIZE + rcv_len > end) {
491 dev_warn(&port->dev, "%s - short data\n", __func__);
495 if (tty_port_initialized(&demux_port->port)) {
496 ch = data + HEADER_SIZE;
497 mxuport_process_read_urb_data(demux_port, ch, rcv_len);
499 dev_dbg(&demux_port->dev, "%s - data for closed port\n",
502 data += HEADER_SIZE + rcv_len;
507 * One URB can contain events for multiple ports. Demultiplex the event,
508 * checking the port exists, and is opened.
510 static void mxuport_process_read_urb_demux_event(struct urb *urb)
512 struct usb_serial_port *port = urb->context;
513 struct usb_serial *serial = port->serial;
514 u8 *data = urb->transfer_buffer;
515 u8 *end = data + urb->actual_length;
516 struct usb_serial_port *demux_port;
522 if (data + EVENT_LENGTH > end) {
523 dev_warn(&port->dev, "%s - message with short event\n",
528 rcv_port = get_unaligned_be16(data);
529 if (rcv_port >= serial->num_ports) {
530 dev_warn(&port->dev, "%s - message for invalid port\n",
535 demux_port = serial->port[rcv_port];
536 if (tty_port_initialized(&demux_port->port)) {
537 ch = data + HEADER_SIZE;
538 rcv_event = get_unaligned_be16(data + 2);
539 mxuport_process_read_urb_event(demux_port, ch,
542 dev_dbg(&demux_port->dev,
543 "%s - event for closed port\n", __func__);
545 data += EVENT_LENGTH;
550 * This is called when we have received data on the bulk in
551 * endpoint. Depending on which port it was received on, it can
552 * contain serial data or events.
554 static void mxuport_process_read_urb(struct urb *urb)
556 struct usb_serial_port *port = urb->context;
557 struct usb_serial *serial = port->serial;
559 if (port == serial->port[0])
560 mxuport_process_read_urb_demux_data(urb);
562 if (port == serial->port[1])
563 mxuport_process_read_urb_demux_event(urb);
567 * Ask the device how many bytes it has queued to be sent out. If
568 * there are none, return true.
570 static bool mxuport_tx_empty(struct usb_serial_port *port)
572 struct usb_serial *serial = port->serial;
573 bool is_empty = true;
578 len_buf = kzalloc(4, GFP_KERNEL);
582 err = mxuport_recv_ctrl_urb(serial, RQ_VENDOR_GET_OUTQUEUE, 0,
583 port->port_number, len_buf, 4);
587 txlen = get_unaligned_be32(len_buf);
588 dev_dbg(&port->dev, "%s - tx len = %u\n", __func__, txlen);
598 static int mxuport_set_mcr(struct usb_serial_port *port, u8 mcr_state)
600 struct usb_serial *serial = port->serial;
603 dev_dbg(&port->dev, "%s - %02x\n", __func__, mcr_state);
605 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_MCR,
606 mcr_state, port->port_number);
608 dev_err(&port->dev, "%s - failed to change MCR\n", __func__);
613 static int mxuport_set_dtr(struct usb_serial_port *port, int on)
615 struct mxuport_port *mxport = usb_get_serial_port_data(port);
616 struct usb_serial *serial = port->serial;
619 mutex_lock(&mxport->mutex);
621 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_DTR,
622 !!on, port->port_number);
625 mxport->mcr_state |= UART_MCR_DTR;
627 mxport->mcr_state &= ~UART_MCR_DTR;
630 mutex_unlock(&mxport->mutex);
635 static int mxuport_set_rts(struct usb_serial_port *port, u8 state)
637 struct mxuport_port *mxport = usb_get_serial_port_data(port);
638 struct usb_serial *serial = port->serial;
642 mutex_lock(&mxport->mutex);
643 mcr_state = mxport->mcr_state;
647 mcr_state &= ~UART_MCR_RTS;
650 mcr_state |= UART_MCR_RTS;
654 * Do not update mxport->mcr_state when doing hardware
660 * Should not happen, but somebody might try passing
661 * MX_RTS_NO_CHANGE, which is not valid.
666 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_RTS,
667 state, port->port_number);
669 mxport->mcr_state = mcr_state;
672 mutex_unlock(&mxport->mutex);
677 static void mxuport_dtr_rts(struct usb_serial_port *port, int on)
679 struct mxuport_port *mxport = usb_get_serial_port_data(port);
683 mutex_lock(&mxport->mutex);
684 mcr_state = mxport->mcr_state;
687 mcr_state |= (UART_MCR_RTS | UART_MCR_DTR);
689 mcr_state &= ~(UART_MCR_RTS | UART_MCR_DTR);
691 err = mxuport_set_mcr(port, mcr_state);
693 mxport->mcr_state = mcr_state;
695 mutex_unlock(&mxport->mutex);
698 static int mxuport_tiocmset(struct tty_struct *tty, unsigned int set,
701 struct usb_serial_port *port = tty->driver_data;
702 struct mxuport_port *mxport = usb_get_serial_port_data(port);
706 mutex_lock(&mxport->mutex);
707 mcr_state = mxport->mcr_state;
710 mcr_state |= UART_MCR_RTS;
713 mcr_state |= UART_MCR_DTR;
715 if (clear & TIOCM_RTS)
716 mcr_state &= ~UART_MCR_RTS;
718 if (clear & TIOCM_DTR)
719 mcr_state &= ~UART_MCR_DTR;
721 err = mxuport_set_mcr(port, mcr_state);
723 mxport->mcr_state = mcr_state;
725 mutex_unlock(&mxport->mutex);
730 static int mxuport_tiocmget(struct tty_struct *tty)
732 struct mxuport_port *mxport;
733 struct usb_serial_port *port = tty->driver_data;
739 mxport = usb_get_serial_port_data(port);
741 mutex_lock(&mxport->mutex);
742 spin_lock_irqsave(&mxport->spinlock, flags);
744 msr = mxport->msr_state;
745 mcr = mxport->mcr_state;
747 spin_unlock_irqrestore(&mxport->spinlock, flags);
748 mutex_unlock(&mxport->mutex);
750 result = (((mcr & UART_MCR_DTR) ? TIOCM_DTR : 0) | /* 0x002 */
751 ((mcr & UART_MCR_RTS) ? TIOCM_RTS : 0) | /* 0x004 */
752 ((msr & UART_MSR_CTS) ? TIOCM_CTS : 0) | /* 0x020 */
753 ((msr & UART_MSR_DCD) ? TIOCM_CAR : 0) | /* 0x040 */
754 ((msr & UART_MSR_RI) ? TIOCM_RI : 0) | /* 0x080 */
755 ((msr & UART_MSR_DSR) ? TIOCM_DSR : 0)); /* 0x100 */
757 dev_dbg(&port->dev, "%s - 0x%04x\n", __func__, result);
762 static int mxuport_set_termios_flow(struct tty_struct *tty,
763 struct ktermios *old_termios,
764 struct usb_serial_port *port,
765 struct usb_serial *serial)
767 u8 xon = START_CHAR(tty);
768 u8 xoff = STOP_CHAR(tty);
774 buf = kmalloc(2, GFP_KERNEL);
778 /* S/W flow control settings */
779 if (I_IXOFF(tty) || I_IXON(tty)) {
784 err = mxuport_send_ctrl_data_urb(serial, RQ_VENDOR_SET_CHARS,
785 0, port->port_number,
790 dev_dbg(&port->dev, "%s - XON = 0x%02x, XOFF = 0x%02x\n",
791 __func__, xon, xoff);
796 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_XONXOFF,
797 enable, port->port_number);
801 rts = MX_RTS_NO_CHANGE;
803 /* H/W flow control settings */
805 C_CRTSCTS(tty) != (old_termios->c_cflag & CRTSCTS)) {
813 if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
814 /* Raise DTR and RTS */
819 mxuport_set_dtr(port, 1);
822 /* Drop DTR and RTS */
823 rts = MX_RTS_DISABLE;
824 mxuport_set_dtr(port, 0);
827 if (rts != MX_RTS_NO_CHANGE)
828 err = mxuport_set_rts(port, rts);
835 static void mxuport_set_termios(struct tty_struct *tty,
836 struct usb_serial_port *port,
837 struct ktermios *old_termios)
839 struct usb_serial *serial = port->serial;
848 !tty_termios_hw_change(&tty->termios, old_termios) &&
849 tty->termios.c_iflag == old_termios->c_iflag) {
850 dev_dbg(&port->dev, "%s - nothing to change\n", __func__);
854 buf = kmalloc(4, GFP_KERNEL);
858 /* Set data bit of termios */
859 switch (C_CSIZE(tty)) {
861 data_bits = MX_WORDLENGTH_5;
864 data_bits = MX_WORDLENGTH_6;
867 data_bits = MX_WORDLENGTH_7;
871 data_bits = MX_WORDLENGTH_8;
875 /* Set parity of termios */
879 parity = MX_PARITY_MARK;
881 parity = MX_PARITY_SPACE;
884 parity = MX_PARITY_ODD;
886 parity = MX_PARITY_EVEN;
889 parity = MX_PARITY_NONE;
892 /* Set stop bit of termios */
894 stop_bits = MX_STOP_BITS_2;
896 stop_bits = MX_STOP_BITS_1;
903 err = mxuport_send_ctrl_data_urb(serial, RQ_VENDOR_SET_LINE,
904 0, port->port_number, buf, 4);
908 err = mxuport_set_termios_flow(tty, old_termios, port, serial);
912 baud = tty_get_baud_rate(tty);
916 /* Note: Little Endian */
917 put_unaligned_le32(baud, buf);
919 err = mxuport_send_ctrl_data_urb(serial, RQ_VENDOR_SET_BAUD,
920 0, port->port_number,
925 dev_dbg(&port->dev, "baud_rate : %d\n", baud);
926 dev_dbg(&port->dev, "data_bits : %d\n", data_bits);
927 dev_dbg(&port->dev, "parity : %d\n", parity);
928 dev_dbg(&port->dev, "stop_bits : %d\n", stop_bits);
935 * Determine how many ports this device has dynamically. It will be
936 * called after the probe() callback is called, but before attach().
938 static int mxuport_calc_num_ports(struct usb_serial *serial,
939 struct usb_serial_endpoints *epds)
941 unsigned long features = (unsigned long)usb_get_serial_data(serial);
945 if (features & MX_UPORT_2_PORT) {
947 } else if (features & MX_UPORT_4_PORT) {
949 } else if (features & MX_UPORT_8_PORT) {
951 } else if (features & MX_UPORT_16_PORT) {
954 dev_warn(&serial->interface->dev,
955 "unknown device, assuming two ports\n");
960 * Setup bulk-out endpoint multiplexing. All ports share the same
963 BUILD_BUG_ON(ARRAY_SIZE(epds->bulk_out) < 16);
965 for (i = 1; i < num_ports; ++i)
966 epds->bulk_out[i] = epds->bulk_out[0];
968 epds->num_bulk_out = num_ports;
973 /* Get the version of the firmware currently running. */
974 static int mxuport_get_fw_version(struct usb_serial *serial, u32 *version)
979 ver_buf = kzalloc(4, GFP_KERNEL);
983 /* Get firmware version from SDRAM */
984 err = mxuport_recv_ctrl_urb(serial, RQ_VENDOR_GET_VERSION, 0, 0,
991 *version = (ver_buf[0] << 16) | (ver_buf[1] << 8) | ver_buf[2];
998 /* Given a firmware blob, download it to the device. */
999 static int mxuport_download_fw(struct usb_serial *serial,
1000 const struct firmware *fw_p)
1007 fw_buf = kmalloc(DOWN_BLOCK_SIZE, GFP_KERNEL);
1011 dev_dbg(&serial->interface->dev, "Starting firmware download...\n");
1012 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_START_FW_DOWN, 0, 0);
1018 txlen = min_t(size_t, (fw_p->size - fwidx), DOWN_BLOCK_SIZE);
1020 memcpy(fw_buf, &fw_p->data[fwidx], txlen);
1021 err = mxuport_send_ctrl_data_urb(serial, RQ_VENDOR_FW_DATA,
1022 0, 0, fw_buf, txlen);
1024 mxuport_send_ctrl_urb(serial, RQ_VENDOR_STOP_FW_DOWN,
1030 usleep_range(1000, 2000);
1032 } while (fwidx < fw_p->size);
1035 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_STOP_FW_DOWN, 0, 0);
1040 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_QUERY_FW_READY, 0, 0);
1047 static int mxuport_probe(struct usb_serial *serial,
1048 const struct usb_device_id *id)
1050 u16 productid = le16_to_cpu(serial->dev->descriptor.idProduct);
1051 const struct firmware *fw_p = NULL;
1057 /* Load our firmware */
1058 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_QUERY_FW_CONFIG, 0, 0);
1060 mxuport_send_ctrl_urb(serial, RQ_VENDOR_RESET_DEVICE, 0, 0);
1064 err = mxuport_get_fw_version(serial, &version);
1068 dev_dbg(&serial->interface->dev, "Device firmware version v%x.%x.%x\n",
1069 (version & 0xff0000) >> 16,
1070 (version & 0xff00) >> 8,
1073 snprintf(buf, sizeof(buf) - 1, "moxa/moxa-%04x.fw", productid);
1075 err = request_firmware(&fw_p, buf, &serial->interface->dev);
1077 dev_warn(&serial->interface->dev, "Firmware %s not found\n",
1080 /* Use the firmware already in the device */
1083 local_ver = ((fw_p->data[VER_ADDR_1] << 16) |
1084 (fw_p->data[VER_ADDR_2] << 8) |
1085 fw_p->data[VER_ADDR_3]);
1086 dev_dbg(&serial->interface->dev,
1087 "Available firmware version v%x.%x.%x\n",
1088 fw_p->data[VER_ADDR_1], fw_p->data[VER_ADDR_2],
1089 fw_p->data[VER_ADDR_3]);
1090 if (local_ver > version) {
1091 err = mxuport_download_fw(serial, fw_p);
1094 err = mxuport_get_fw_version(serial, &version);
1100 dev_info(&serial->interface->dev,
1101 "Using device firmware version v%x.%x.%x\n",
1102 (version & 0xff0000) >> 16,
1103 (version & 0xff00) >> 8,
1107 * Contains the features of this hardware. Store away for
1108 * later use, eg, number of ports.
1110 usb_set_serial_data(serial, (void *)id->driver_info);
1113 release_firmware(fw_p);
1118 static int mxuport_port_probe(struct usb_serial_port *port)
1120 struct usb_serial *serial = port->serial;
1121 struct mxuport_port *mxport;
1124 mxport = devm_kzalloc(&port->dev, sizeof(struct mxuport_port),
1129 mutex_init(&mxport->mutex);
1130 spin_lock_init(&mxport->spinlock);
1132 /* Set the port private data */
1133 usb_set_serial_port_data(port, mxport);
1135 /* Set FIFO (Enable) */
1136 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_FIFO_DISABLE,
1137 0, port->port_number);
1141 /* Set transmission mode (Hi-Performance) */
1142 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_HIGH_PERFOR,
1143 0, port->port_number);
1147 /* Set interface (RS-232) */
1148 return mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_INTERFACE,
1153 static int mxuport_attach(struct usb_serial *serial)
1155 struct usb_serial_port *port0 = serial->port[0];
1156 struct usb_serial_port *port1 = serial->port[1];
1160 * All data from the ports is received on the first bulk in
1161 * endpoint, with a multiplex header. The second bulk in is
1164 * Start to read from the device.
1166 err = usb_serial_generic_submit_read_urbs(port0, GFP_KERNEL);
1170 err = usb_serial_generic_submit_read_urbs(port1, GFP_KERNEL);
1172 usb_serial_generic_close(port0);
1179 static void mxuport_release(struct usb_serial *serial)
1181 struct usb_serial_port *port0 = serial->port[0];
1182 struct usb_serial_port *port1 = serial->port[1];
1184 usb_serial_generic_close(port1);
1185 usb_serial_generic_close(port0);
1188 static int mxuport_open(struct tty_struct *tty, struct usb_serial_port *port)
1190 struct mxuport_port *mxport = usb_get_serial_port_data(port);
1191 struct usb_serial *serial = port->serial;
1194 /* Set receive host (enable) */
1195 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_RX_HOST_EN,
1196 1, port->port_number);
1200 err = mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_OPEN,
1201 1, port->port_number);
1203 mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_RX_HOST_EN,
1204 0, port->port_number);
1208 /* Initial port termios */
1210 mxuport_set_termios(tty, port, NULL);
1213 * TODO: use RQ_VENDOR_GET_MSR, once we know what it
1216 mxport->msr_state = 0;
1221 static void mxuport_close(struct usb_serial_port *port)
1223 struct usb_serial *serial = port->serial;
1225 mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_OPEN, 0,
1228 mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_RX_HOST_EN, 0,
1232 /* Send a break to the port. */
1233 static void mxuport_break_ctl(struct tty_struct *tty, int break_state)
1235 struct usb_serial_port *port = tty->driver_data;
1236 struct usb_serial *serial = port->serial;
1239 if (break_state == -1) {
1241 dev_dbg(&port->dev, "%s - sending break\n", __func__);
1244 dev_dbg(&port->dev, "%s - clearing break\n", __func__);
1247 mxuport_send_ctrl_urb(serial, RQ_VENDOR_SET_BREAK,
1248 enable, port->port_number);
1251 static int mxuport_resume(struct usb_serial *serial)
1253 struct usb_serial_port *port;
1258 for (i = 0; i < 2; i++) {
1259 port = serial->port[i];
1261 r = usb_serial_generic_submit_read_urbs(port, GFP_NOIO);
1266 for (i = 0; i < serial->num_ports; i++) {
1267 port = serial->port[i];
1268 if (!tty_port_initialized(&port->port))
1271 r = usb_serial_generic_write_start(port, GFP_NOIO);
1276 return c ? -EIO : 0;
1279 static struct usb_serial_driver mxuport_device = {
1281 .owner = THIS_MODULE,
1284 .description = "MOXA UPort",
1285 .id_table = mxuport_idtable,
1288 .probe = mxuport_probe,
1289 .port_probe = mxuport_port_probe,
1290 .attach = mxuport_attach,
1291 .release = mxuport_release,
1292 .calc_num_ports = mxuport_calc_num_ports,
1293 .open = mxuport_open,
1294 .close = mxuport_close,
1295 .set_termios = mxuport_set_termios,
1296 .break_ctl = mxuport_break_ctl,
1297 .tx_empty = mxuport_tx_empty,
1298 .tiocmiwait = usb_serial_generic_tiocmiwait,
1299 .get_icount = usb_serial_generic_get_icount,
1300 .throttle = mxuport_throttle,
1301 .unthrottle = mxuport_unthrottle,
1302 .tiocmget = mxuport_tiocmget,
1303 .tiocmset = mxuport_tiocmset,
1304 .dtr_rts = mxuport_dtr_rts,
1305 .process_read_urb = mxuport_process_read_urb,
1306 .prepare_write_buffer = mxuport_prepare_write_buffer,
1307 .resume = mxuport_resume,
1310 static struct usb_serial_driver *const serial_drivers[] = {
1311 &mxuport_device, NULL
1314 module_usb_serial_driver(serial_drivers, mxuport_idtable);
1316 MODULE_AUTHOR("Andrew Lunn <andrew@lunn.ch>");
1317 MODULE_AUTHOR("<support@moxa.com>");
1318 MODULE_LICENSE("GPL");