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