xref: /OK3568_Linux_fs/kernel/drivers/usb/serial/belkin_sa.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Definitions for Belkin USB Serial Adapter Driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  *  Copyright (C) 2000
6*4882a593Smuzhiyun  *      William Greathouse (wgreathouse@smva.com)
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  *  This program is largely derived from work by the linux-usb group
9*4882a593Smuzhiyun  *  and associated source files.  Please see the usb/serial files for
10*4882a593Smuzhiyun  *  individual credits and copyrights.
11*4882a593Smuzhiyun  *
12*4882a593Smuzhiyun  * See Documentation/usb/usb-serial.rst for more information on using this
13*4882a593Smuzhiyun  * driver
14*4882a593Smuzhiyun  *
15*4882a593Smuzhiyun  * 12-Mar-2001 gkh
16*4882a593Smuzhiyun  *	Added GoHubs GO-COM232 device id.
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  * 06-Nov-2000 gkh
19*4882a593Smuzhiyun  *	Added old Belkin and Peracom device ids, which this driver supports
20*4882a593Smuzhiyun  *
21*4882a593Smuzhiyun  * 12-Oct-2000 William Greathouse
22*4882a593Smuzhiyun  *    First cut at supporting Belkin USB Serial Adapter F5U103
23*4882a593Smuzhiyun  *    I did not have a copy of the original work to support this
24*4882a593Smuzhiyun  *    adapter, so pardon any stupid mistakes.  All of the information
25*4882a593Smuzhiyun  *    I am using to write this driver was acquired by using a modified
26*4882a593Smuzhiyun  *    UsbSnoop on Windows2000.
27*4882a593Smuzhiyun  *
28*4882a593Smuzhiyun  */
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun #ifndef __LINUX_USB_SERIAL_BSA_H
31*4882a593Smuzhiyun #define __LINUX_USB_SERIAL_BSA_H
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #define BELKIN_DOCKSTATION_VID	0x050d	/* Vendor Id */
34*4882a593Smuzhiyun #define BELKIN_DOCKSTATION_PID	0x1203	/* Product Id */
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun #define BELKIN_SA_VID	0x050d	/* Vendor Id */
37*4882a593Smuzhiyun #define BELKIN_SA_PID	0x0103	/* Product Id */
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun #define BELKIN_OLD_VID	0x056c	/* Belkin's "old" vendor id */
40*4882a593Smuzhiyun #define BELKIN_OLD_PID	0x8007	/* Belkin's "old" single port serial converter's id */
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun #define PERACOM_VID	0x0565	/* Peracom's vendor id */
43*4882a593Smuzhiyun #define PERACOM_PID	0x0001	/* Peracom's single port serial converter's id */
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun #define GOHUBS_VID	0x0921	/* GoHubs vendor id */
46*4882a593Smuzhiyun #define GOHUBS_PID	0x1000	/* GoHubs single port serial converter's id (identical to the Peracom device) */
47*4882a593Smuzhiyun #define HANDYLINK_PID	0x1200	/* HandyLink USB's id (identical to the Peracom device) */
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun /* Vendor Request Interface */
50*4882a593Smuzhiyun #define BELKIN_SA_SET_BAUDRATE_REQUEST	0  /* Set baud rate */
51*4882a593Smuzhiyun #define BELKIN_SA_SET_STOP_BITS_REQUEST	1  /* Set stop bits (1,2) */
52*4882a593Smuzhiyun #define BELKIN_SA_SET_DATA_BITS_REQUEST	2  /* Set data bits (5,6,7,8) */
53*4882a593Smuzhiyun #define BELKIN_SA_SET_PARITY_REQUEST	3  /* Set parity (None, Even, Odd) */
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun #define BELKIN_SA_SET_DTR_REQUEST	10 /* Set DTR state */
56*4882a593Smuzhiyun #define BELKIN_SA_SET_RTS_REQUEST	11 /* Set RTS state */
57*4882a593Smuzhiyun #define BELKIN_SA_SET_BREAK_REQUEST	12 /* Set BREAK state */
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun #define BELKIN_SA_SET_FLOW_CTRL_REQUEST	16 /* Set flow control mode */
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun #ifdef WHEN_I_LEARN_THIS
63*4882a593Smuzhiyun #define BELKIN_SA_SET_MAGIC_REQUEST	17 /* I don't know, possibly flush */
64*4882a593Smuzhiyun 					   /* (always in Wininit sequence before flow control) */
65*4882a593Smuzhiyun #define BELKIN_SA_RESET			xx /* Reset the port */
66*4882a593Smuzhiyun #define BELKIN_SA_GET_MODEM_STATUS	xx /* Force return of modem status register */
67*4882a593Smuzhiyun #endif
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun #define BELKIN_SA_SET_REQUEST_TYPE	0x40
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun #define BELKIN_SA_BAUD(b)		(230400/b)
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun #define BELKIN_SA_STOP_BITS(b)		(b-1)
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun #define BELKIN_SA_DATA_BITS(b)		(b-5)
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun #define BELKIN_SA_PARITY_NONE		0
78*4882a593Smuzhiyun #define BELKIN_SA_PARITY_EVEN		1
79*4882a593Smuzhiyun #define BELKIN_SA_PARITY_ODD		2
80*4882a593Smuzhiyun #define BELKIN_SA_PARITY_MARK		3
81*4882a593Smuzhiyun #define BELKIN_SA_PARITY_SPACE		4
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun #define BELKIN_SA_FLOW_NONE		0x0000	/* No flow control */
84*4882a593Smuzhiyun #define BELKIN_SA_FLOW_OCTS		0x0001	/* use CTS input to throttle output */
85*4882a593Smuzhiyun #define BELKIN_SA_FLOW_ODSR		0x0002	/* use DSR input to throttle output */
86*4882a593Smuzhiyun #define BELKIN_SA_FLOW_IDSR		0x0004	/* use DSR input to enable receive */
87*4882a593Smuzhiyun #define BELKIN_SA_FLOW_IDTR		0x0008	/* use DTR output for input flow control */
88*4882a593Smuzhiyun #define BELKIN_SA_FLOW_IRTS		0x0010	/* use RTS output for input flow control */
89*4882a593Smuzhiyun #define BELKIN_SA_FLOW_ORTS		0x0020	/* use RTS to indicate data available to send */
90*4882a593Smuzhiyun #define BELKIN_SA_FLOW_ERRSUB		0x0040	/* ???? guess ???? substitute inline errors */
91*4882a593Smuzhiyun #define BELKIN_SA_FLOW_OXON		0x0080	/* use XON/XOFF for output flow control */
92*4882a593Smuzhiyun #define BELKIN_SA_FLOW_IXON		0x0100	/* use XON/XOFF for input flow control */
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun /*
95*4882a593Smuzhiyun  * It seems that the interrupt pipe is closely modelled after the
96*4882a593Smuzhiyun  * 16550 register layout.  This is probably because the adapter can
97*4882a593Smuzhiyun  * be used in a "DOS" environment to simulate a standard hardware port.
98*4882a593Smuzhiyun  */
99*4882a593Smuzhiyun #define BELKIN_SA_LSR_INDEX		2	/*     Line Status Register */
100*4882a593Smuzhiyun #define BELKIN_SA_LSR_RDR		0x01	/* receive data ready */
101*4882a593Smuzhiyun #define BELKIN_SA_LSR_OE		0x02	/* overrun error */
102*4882a593Smuzhiyun #define BELKIN_SA_LSR_PE		0x04	/* parity error */
103*4882a593Smuzhiyun #define BELKIN_SA_LSR_FE		0x08	/* framing error */
104*4882a593Smuzhiyun #define BELKIN_SA_LSR_BI		0x10	/* break indicator */
105*4882a593Smuzhiyun #define BELKIN_SA_LSR_THE		0x20	/* tx holding register empty */
106*4882a593Smuzhiyun #define BELKIN_SA_LSR_TE		0x40	/* transmit register empty */
107*4882a593Smuzhiyun #define BELKIN_SA_LSR_ERR		0x80	/* OE | PE | FE | BI */
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun #define BELKIN_SA_MSR_INDEX		3	/*     Modem Status Register */
110*4882a593Smuzhiyun #define BELKIN_SA_MSR_DCTS		0x01	/* Delta CTS */
111*4882a593Smuzhiyun #define BELKIN_SA_MSR_DDSR		0x02	/* Delta DSR */
112*4882a593Smuzhiyun #define BELKIN_SA_MSR_DRI		0x04	/* Delta RI */
113*4882a593Smuzhiyun #define BELKIN_SA_MSR_DCD		0x08	/* Delta CD */
114*4882a593Smuzhiyun #define BELKIN_SA_MSR_CTS		0x10	/* Current CTS */
115*4882a593Smuzhiyun #define BELKIN_SA_MSR_DSR		0x20	/* Current DSR */
116*4882a593Smuzhiyun #define BELKIN_SA_MSR_RI		0x40	/* Current RI */
117*4882a593Smuzhiyun #define BELKIN_SA_MSR_CD		0x80	/* Current CD */
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun #endif /* __LINUX_USB_SERIAL_BSA_H */
120*4882a593Smuzhiyun 
121