1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
|
/*
* USB Moxa UPORT 11x0 Serial Driver
*
* Copyright (C) 2007 MOXA Technologies Co., Ltd.
* Copyright (C) 2015 Mathieu Othacehe <m.othacehe@gmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
*
* Supports the following Moxa USB to serial converters:
* UPort 1110, 1 port RS-232 USB to Serial Hub.
* UPort 1130, 1 port RS-422/485 USB to Serial Hub.
* UPort 1130I, 1 port RS-422/485 USB to Serial Hub with isolation
* protection.
* UPort 1150, 1 port RS-232/422/485 USB to Serial Hub.
* UPort 1150I, 1 port RS-232/422/485 USB to Serial Hub with isolation
* protection.
*/
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/firmware.h>
#include <linux/jiffies.h>
#include <linux/serial.h>
#include <linux/serial_reg.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/uaccess.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>
/* Vendor and product ids */
#define MXU1_VENDOR_ID 0x110a
#define MXU1_1110_PRODUCT_ID 0x1110
#define MXU1_1130_PRODUCT_ID 0x1130
#define MXU1_1150_PRODUCT_ID 0x1150
#define MXU1_1151_PRODUCT_ID 0x1151
#define MXU1_1131_PRODUCT_ID 0x1131
/* Commands */
#define MXU1_GET_VERSION 0x01
#define MXU1_GET_PORT_STATUS 0x02
#define MXU1_GET_PORT_DEV_INFO 0x03
#define MXU1_GET_CONFIG 0x04
#define MXU1_SET_CONFIG 0x05
#define MXU1_OPEN_PORT 0x06
#define MXU1_CLOSE_PORT 0x07
#define MXU1_START_PORT 0x08
#define MXU1_STOP_PORT 0x09
#define MXU1_TEST_PORT 0x0A
#define MXU1_PURGE_PORT 0x0B
#define MXU1_RESET_EXT_DEVICE 0x0C
#define MXU1_GET_OUTQUEUE 0x0D
#define MXU1_WRITE_DATA 0x80
#define MXU1_READ_DATA 0x81
#define MXU1_REQ_TYPE_CLASS 0x82
/* Module identifiers */
#define MXU1_I2C_PORT 0x01
#define MXU1_IEEE1284_PORT 0x02
#define MXU1_UART1_PORT 0x03
#define MXU1_UART2_PORT 0x04
#define MXU1_RAM_PORT 0x05
/* Modem status */
#define MXU1_MSR_DELTA_CTS 0x01
#define MXU1_MSR_DELTA_DSR 0x02
#define MXU1_MSR_DELTA_RI 0x04
#define MXU1_MSR_DELTA_CD 0x08
#define MXU1_MSR_CTS 0x10
#define MXU1_MSR_DSR 0x20
#define MXU1_MSR_RI 0x40
#define MXU1_MSR_CD 0x80
#define MXU1_MSR_DELTA_MASK 0x0F
#define MXU1_MSR_MASK 0xF0
/* Line status */
#define MXU1_LSR_OVERRUN_ERROR 0x01
#define MXU1_LSR_PARITY_ERROR 0x02
#define MXU1_LSR_FRAMING_ERROR 0x04
#define MXU1_LSR_BREAK 0x08
#define MXU1_LSR_ERROR 0x0F
#define MXU1_LSR_RX_FULL 0x10
#define MXU1_LSR_TX_EMPTY 0x20
/* Modem control */
#define MXU1_MCR_LOOP 0x04
#define MXU1_MCR_DTR 0x10
#define MXU1_MCR_RTS 0x20
/* Mask settings */
#define MXU1_UART_ENABLE_RTS_IN 0x0001
#define MXU1_UART_DISABLE_RTS 0x0002
#define MXU1_UART_ENABLE_PARITY_CHECKING 0x0008
#define MXU1_UART_ENABLE_DSR_OUT 0x0010
#define MXU1_UART_ENABLE_CTS_OUT 0x0020
#define MXU1_UART_ENABLE_X_OUT 0x0040
#define MXU1_UART_ENABLE_XA_OUT 0x0080
#define MXU1_UART_ENABLE_X_IN 0x0100
#define MXU1_UART_ENABLE_DTR_IN 0x0800
#define MXU1_UART_DISABLE_DTR 0x1000
#define MXU1_UART_ENABLE_MS_INTS 0x2000
#define MXU1_UART_ENABLE_AUTO_START_DMA 0x4000
#define MXU1_UART_SEND_BREAK_SIGNAL 0x8000
/* Parity */
#define MXU1_UART_NO_PARITY 0x00
#define MXU1_UART_ODD_PARITY 0x01
#define MXU1_UART_EVEN_PARITY 0x02
#define MXU1_UART_MARK_PARITY 0x03
#define MXU1_UART_SPACE_PARITY 0x04
/* Stop bits */
#define MXU1_UART_1_STOP_BITS 0x00
#define MXU1_UART_1_5_STOP_BITS 0x01
#define MXU1_UART_2_STOP_BITS 0x02
/* Bits per character */
#define MXU1_UART_5_DATA_BITS 0x00
#define MXU1_UART_6_DATA_BITS 0x01
#define MXU1_UART_7_DATA_BITS 0x02
#define MXU1_UART_8_DATA_BITS 0x03
/* Operation modes */
#define MXU1_UART_232 0x00
#define MXU1_UART_485_RECEIVER_DISABLED 0x01
#define MXU1_UART_485_RECEIVER_ENABLED 0x02
/* Pipe transfer mode and timeout */
#define MXU1_PIPE_MODE_CONTINUOUS 0x01
#define MXU1_PIPE_MODE_MASK 0x03
#define MXU1_PIPE_TIMEOUT_MASK 0x7C
#define MXU1_PIPE_TIMEOUT_ENABLE 0x80
/* Config struct */
struct mxu1_uart_config {
__be16 wBaudRate;
__be16 wFlags;
u8 bDataBits;
u8 bParity;
u8 bStopBits;
char cXon;
char cXoff;
u8 bUartMode;
} __packed;
/* Purge modes */
#define MXU1_PURGE_OUTPUT 0x00
#define MXU1_PURGE_INPUT 0x80
/* Read/Write data */
#define MXU1_RW_DATA_ADDR_SFR 0x10
#define MXU1_RW_DATA_ADDR_IDATA 0x20
#define MXU1_RW_DATA_ADDR_XDATA 0x30
#define MXU1_RW_DATA_ADDR_CODE 0x40
#define MXU1_RW_DATA_ADDR_GPIO 0x50
#define MXU1_RW_DATA_ADDR_I2C 0x60
#define MXU1_RW_DATA_ADDR_FLASH 0x70
#define MXU1_RW_DATA_ADDR_DSP 0x80
#define MXU1_RW_DATA_UNSPECIFIED 0x00
#define MXU1_RW_DATA_BYTE 0x01
#define MXU1_RW_DATA_WORD 0x02
#define MXU1_RW_DATA_DOUBLE_WORD 0x04
struct mxu1_write_data_bytes {
u8 bAddrType;
u8 bDataType;
u8 bDataCounter;
__be16 wBaseAddrHi;
__be16 wBaseAddrLo;
u8 bData[0];
} __packed;
/* Interrupt codes */
#define MXU1_CODE_HARDWARE_ERROR 0xFF
#define MXU1_CODE_DATA_ERROR 0x03
#define MXU1_CODE_MODEM_STATUS 0x04
static inline int mxu1_get_func_from_code(unsigned char code)
{
return code & 0x0f;
}
/* Download firmware max packet size */
#define MXU1_DOWNLOAD_MAX_PACKET_SIZE 64
/* Firmware image header */
struct mxu1_firmware_header {
__le16 wLength;
u8 bCheckSum;
} __packed;
#define MXU1_UART_BASE_ADDR 0xFFA0
#define MXU1_UART_OFFSET_MCR 0x0004
#define MXU1_BAUD_BASE 923077
#define MXU1_TRANSFER_TIMEOUT 2
#define MXU1_DOWNLOAD_TIMEOUT 1000
#define MXU1_DEFAULT_CLOSING_WAIT 4000 /* in .01 secs */
struct mxu1_port {
u8 msr;
u8 mcr;
u8 uart_mode;
spinlock_t spinlock; /* Protects msr */
struct mutex mutex; /* Protects mcr */
bool send_break;
};
struct mxu1_device {
u16 mxd_model;
};
static const struct usb_device_id mxu1_idtable[] = {
{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1110_PRODUCT_ID) },
{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1130_PRODUCT_ID) },
{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1150_PRODUCT_ID) },
{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1151_PRODUCT_ID) },
{ USB_DEVICE(MXU1_VENDOR_ID, MXU1_1131_PRODUCT_ID) },
{ }
};
MODULE_DEVICE_TABLE(usb, mxu1_idtable);
/* Write the given buffer out to the control pipe. */
static int mxu1_send_ctrl_data_urb(struct usb_serial *serial,
u8 request,
u16 value, u16 index,
void *data, size_t size)
{
int status;
status = usb_control_msg(serial->dev,
usb_sndctrlpipe(serial->dev, 0),
request,
(USB_DIR_OUT | USB_TYPE_VENDOR |
USB_RECIP_DEVICE), value, index,
data, size,
USB_CTRL_SET_TIMEOUT);
if (status < 0) {
dev_err(&serial->interface->dev,
"%s - usb_control_msg failed: %d\n",
__func__, status);
return status;
}
if (status != size) {
dev_err(&serial->interface->dev,
"%s - short write (%d / %zd)\n",
__func__, status, size);
return -EIO;
}
return 0;
}
/* Send a vendor request without any data */
static int mxu1_send_ctrl_urb(struct usb_serial *serial,
u8 request, u16 value, u16 index)
{
return mxu1_send_ctrl_data_urb(
|