FEX-Emu/linux
1
0
Fork 0
mirror of https://github.com/FEX-Emu/linux.git synced 2025-02-11 22:37:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ftdi_sio: Coding style

Browse Source 
Signed-off-by: Alan Cox <alan@redhat.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Alan Cox 2008-07-22 11:11:23 +01:00 committed by Linus Torvalds
parent 93c467952f
commit 464cbb2469
2 changed files with 635 additions and 569 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1078
drivers/usb/serial/ftdi_sio.c
View File

File diff suppressed because it is too large Load Diff

126
drivers/usb/serial/ftdi_sio.h
View File

@ -1,20 +1,20 @@
/* /*
* Definitions for the FTDI USB Single Port Serial Converter - * Definitions for the FTDI USB Single Port Serial Converter -
* known as FTDI_SIO (Serial Input/Output application of the chipset) * known as FTDI_SIO (Serial Input/Output application of the chipset)
* *
* The example I have is known as the USC-1000 which is available from * The example I have is known as the USC-1000 which is available from
* http://www.dse.co.nz - cat no XH4214 It looks similar to this: * http://www.dse.co.nz - cat no XH4214 It looks similar to this:
* http://www.dansdata.com/usbser.htm but I can't be sure There are other * http://www.dansdata.com/usbser.htm but I can't be sure There are other
* USC-1000s which don't look like my device though so beware! * USC-1000s which don't look like my device though so beware!
* *
* The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side, * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side,
* USB on the other. * USB on the other.
* *
* Thanx to FTDI (http://www.ftdi.co.uk) for so kindly providing details * Thanx to FTDI (http://www.ftdi.co.uk) for so kindly providing details
* of the protocol required to talk to the device and ongoing assistence * of the protocol required to talk to the device and ongoing assistence
* during development. * during development.
* *
* Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the
* FTDI_SIO implementation. * FTDI_SIO implementation.
* *
* Philipp Gühring - pg@futureware.at - added the Device ID of the USB relais * Philipp Gühring - pg@futureware.at - added the Device ID of the USB relais
@ -472,7 +472,7 @@
/* /*
* DSS-20 Sync Station for Sony Ericsson P800 * DSS-20 Sync Station for Sony Ericsson P800
*/ */
#define FTDI_DSS20_PID 0xFC82 #define FTDI_DSS20_PID 0xFC82
/* /*
* Home Electronics (www.home-electro.com) USB gadgets * Home Electronics (www.home-electro.com) USB gadgets
@ -884,7 +884,7 @@
/* /*
* BmRequestType: 0100 0000B * BmRequestType: 0100 0000B
* bRequest: FTDI_SIO_RESET * bRequest: FTDI_SIO_RESET
* wValue: Control Value * wValue: Control Value
* 0 = Reset SIO * 0 = Reset SIO
* 1 = Purge RX buffer * 1 = Purge RX buffer
* 2 = Purge TX buffer * 2 = Purge TX buffer
@ -952,7 +952,7 @@
* 101 - add .625 to divisor * 101 - add .625 to divisor
* 110 - add .750 to divisor * 110 - add .750 to divisor
* 111 - add .875 to divisor * 111 - add .875 to divisor
* Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is
* placed in bit 0 of the urb index. * placed in bit 0 of the urb index.
* *
* Note that there are a couple of special cases to support the highest baud * Note that there are a couple of special cases to support the highest baud
@ -971,8 +971,8 @@ typedef enum {
} ftdi_chip_type_t; } ftdi_chip_type_t;
typedef enum { typedef enum {
ftdi_sio_b300 = 0, ftdi_sio_b300 = 0,
ftdi_sio_b600 = 1, ftdi_sio_b600 = 1,
ftdi_sio_b1200 = 2, ftdi_sio_b1200 = 2,
ftdi_sio_b2400 = 3, ftdi_sio_b2400 = 3,
ftdi_sio_b4800 = 4, ftdi_sio_b4800 = 4,
@ -981,7 +981,7 @@ typedef enum {
ftdi_sio_b38400 = 7, ftdi_sio_b38400 = 7,
ftdi_sio_b57600 = 8, ftdi_sio_b57600 = 8,
ftdi_sio_b115200 = 9 ftdi_sio_b115200 = 9
} FTDI_SIO_baudrate_t ; } FTDI_SIO_baudrate_t;
/* /*
* The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
@ -990,19 +990,19 @@ typedef enum {
#define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
#define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
#define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 ) #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8)
#define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 ) #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8)
#define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 ) #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8)
#define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 ) #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8)
#define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 ) #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8)
#define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 ) #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11)
#define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 ) #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11)
#define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 ) #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11)
#define FTDI_SIO_SET_BREAK (0x1 << 14) #define FTDI_SIO_SET_BREAK (0x1 << 14)
/* FTDI_SIO_SET_DATA */ /* FTDI_SIO_SET_DATA */
/* /*
* BmRequestType: 0100 0000B * BmRequestType: 0100 0000B
* bRequest: FTDI_SIO_SET_DATA * bRequest: FTDI_SIO_SET_DATA
* wValue: Data characteristics (see below) * wValue: Data characteristics (see below)
* wIndex: Port * wIndex: Port
@ -1035,7 +1035,7 @@ typedef enum {
#define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
#define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
/* /*
* BmRequestType: 0100 0000B * BmRequestType: 0100 0000B
* bRequest: FTDI_SIO_MODEM_CTRL * bRequest: FTDI_SIO_MODEM_CTRL
* wValue: ControlValue (see below) * wValue: ControlValue (see below)
@ -1049,11 +1049,11 @@ typedef enum {
*/ */
#define FTDI_SIO_SET_DTR_MASK 0x1 #define FTDI_SIO_SET_DTR_MASK 0x1
#define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK << 8)) #define FTDI_SIO_SET_DTR_HIGH (1 | (FTDI_SIO_SET_DTR_MASK << 8))
#define FTDI_SIO_SET_DTR_LOW ( 0 | ( FTDI_SIO_SET_DTR_MASK << 8)) #define FTDI_SIO_SET_DTR_LOW (0 | (FTDI_SIO_SET_DTR_MASK << 8))
#define FTDI_SIO_SET_RTS_MASK 0x2 #define FTDI_SIO_SET_RTS_MASK 0x2
#define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 )) #define FTDI_SIO_SET_RTS_HIGH (2 | (FTDI_SIO_SET_RTS_MASK << 8))
#define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 )) #define FTDI_SIO_SET_RTS_LOW (0 | (FTDI_SIO_SET_RTS_MASK << 8))
/* /*
* ControlValue * ControlValue
@ -1076,7 +1076,7 @@ typedef enum {
/* FTDI_SIO_SET_FLOW_CTRL */ /* FTDI_SIO_SET_FLOW_CTRL */
#define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
#define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
#define FTDI_SIO_DISABLE_FLOW_CTRL 0x0 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
#define FTDI_SIO_RTS_CTS_HS (0x1 << 8) #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
#define FTDI_SIO_DTR_DSR_HS (0x2 << 8) #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
#define FTDI_SIO_XON_XOFF_HS (0x4 << 8) #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
@ -1085,7 +1085,7 @@ typedef enum {
* bRequest: FTDI_SIO_SET_FLOW_CTRL * bRequest: FTDI_SIO_SET_FLOW_CTRL
* wValue: Xoff/Xon * wValue: Xoff/Xon
* wIndex: Protocol/Port - hIndex is protocl / lIndex is port * wIndex: Protocol/Port - hIndex is protocl / lIndex is port
* wLength: 0 * wLength: 0
* Data: None * Data: None
* *
* hIndex protocol is: * hIndex protocol is:
@ -1101,10 +1101,10 @@ typedef enum {
* *
* A value of zero in the hIndex field disables handshaking * A value of zero in the hIndex field disables handshaking
* *
* If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
* and the lValue field contains the XON character. * and the lValue field contains the XON character.
*/ */
/* /*
* FTDI_SIO_GET_LATENCY_TIMER * FTDI_SIO_GET_LATENCY_TIMER
* *
@ -1118,7 +1118,7 @@ typedef enum {
#define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
#define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
/* /*
* BmRequestType: 1100 0000b * BmRequestType: 1100 0000b
* bRequest: FTDI_SIO_GET_LATENCY_TIMER * bRequest: FTDI_SIO_GET_LATENCY_TIMER
* wValue: 0 * wValue: 0
@ -1127,7 +1127,7 @@ typedef enum {
* Data: latency (on return) * Data: latency (on return)
*/ */
/* /*
* FTDI_SIO_SET_LATENCY_TIMER * FTDI_SIO_SET_LATENCY_TIMER
* *
* Set the timeout interval. The FTDI collects data from the slave * Set the timeout interval. The FTDI collects data from the slave
@ -1140,7 +1140,7 @@ typedef enum {
#define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
#define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
/* /*
* BmRequestType: 0100 0000b * BmRequestType: 0100 0000b
* bRequest: FTDI_SIO_SET_LATENCY_TIMER * bRequest: FTDI_SIO_SET_LATENCY_TIMER
* wValue: Latency (milliseconds) * wValue: Latency (milliseconds)
@ -1155,7 +1155,7 @@ typedef enum {
*/ */
/* /*
* FTDI_SIO_SET_EVENT_CHAR * FTDI_SIO_SET_EVENT_CHAR
* *
* Set the special event character for the specified communications port. * Set the special event character for the specified communications port.
* If the device sees this character it will immediately return the * If the device sees this character it will immediately return the
@ -1168,7 +1168,7 @@ typedef enum {
#define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
/* /*
* BmRequestType: 0100 0000b * BmRequestType: 0100 0000b
* bRequest: FTDI_SIO_SET_EVENT_CHAR * bRequest: FTDI_SIO_SET_EVENT_CHAR
* wValue: EventChar * wValue: EventChar
@ -1184,12 +1184,12 @@ typedef enum {
* B9..15 Reserved * B9..15 Reserved
* *
*/ */
/* FTDI_SIO_SET_ERROR_CHAR */ /* FTDI_SIO_SET_ERROR_CHAR */
/* Set the parity error replacement character for the specified communications port */ /* Set the parity error replacement character for the specified communications port */
/* /*
* BmRequestType: 0100 0000b * BmRequestType: 0100 0000b
* bRequest: FTDI_SIO_SET_EVENT_CHAR * bRequest: FTDI_SIO_SET_EVENT_CHAR
* wValue: Error Char * wValue: Error Char
@ -1215,15 +1215,15 @@ typedef enum {
#define FTDI_SIO_DSR_MASK 0x20 #define FTDI_SIO_DSR_MASK 0x20
#define FTDI_SIO_RI_MASK 0x40 #define FTDI_SIO_RI_MASK 0x40
#define FTDI_SIO_RLSD_MASK 0x80 #define FTDI_SIO_RLSD_MASK 0x80
/* /*
* BmRequestType: 1100 0000b * BmRequestType: 1100 0000b
* bRequest: FTDI_SIO_GET_MODEM_STATUS * bRequest: FTDI_SIO_GET_MODEM_STATUS
* wValue: zero * wValue: zero
* wIndex: Port * wIndex: Port
* wLength: 1 * wLength: 1
* Data: Status * Data: Status
* *
* One byte of data is returned * One byte of data is returned
* B0..3 0 * B0..3 0
* B4 CTS * B4 CTS
* 0 = inactive * 0 = inactive
@ -1236,15 +1236,15 @@ typedef enum {
* 1 = active * 1 = active
* B7 Receive Line Signal Detect (RLSD) * B7 Receive Line Signal Detect (RLSD)
* 0 = inactive * 0 = inactive
* 1 = active * 1 = active
*/ */
/* Descriptors returned by the device /* Descriptors returned by the device
* *
* Device Descriptor * Device Descriptor
* *
* Offset Field Size Value Description * Offset Field Size Value Description
* 0 bLength 1 0x12 Size of descriptor in bytes * 0 bLength 1 0x12 Size of descriptor in bytes
* 1 bDescriptorType 1 0x01 DEVICE Descriptor Type * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type
@ -1260,9 +1260,9 @@ typedef enum {
* 15 iProduct 1 0x02 Index of prod string desc * 15 iProduct 1 0x02 Index of prod string desc
* 16 iSerialNumber 1 0x02 Index of serial nmr string desc * 16 iSerialNumber 1 0x02 Index of serial nmr string desc
* 17 bNumConfigurations 1 0x01 Number of possible configurations * 17 bNumConfigurations 1 0x01 Number of possible configurations
* *
* Configuration Descriptor * Configuration Descriptor
* *
* Offset Field Size Value * Offset Field Size Value
* 0 bLength 1 0x09 Size of descriptor in bytes * 0 bLength 1 0x09 Size of descriptor in bytes
* 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type
@ -1272,9 +1272,9 @@ typedef enum {
* 6 iConfiguration 1 0x02 Index of config string descriptor * 6 iConfiguration 1 0x02 Index of config string descriptor
* 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup
* 8 MaxPower 1 0x1E Max power consumption * 8 MaxPower 1 0x1E Max power consumption
* *
* Interface Descriptor * Interface Descriptor
* *
* Offset Field Size Value * Offset Field Size Value
* 0 bLength 1 0x09 Size of descriptor in bytes * 0 bLength 1 0x09 Size of descriptor in bytes
* 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type
@ -1285,9 +1285,9 @@ typedef enum {
* 6 bInterfaceSubClass 1 0xFF Subclass Code * 6 bInterfaceSubClass 1 0xFF Subclass Code
* 7 bInterfaceProtocol 1 0xFF Protocol Code * 7 bInterfaceProtocol 1 0xFF Protocol Code
* 8 iInterface 1 0x02 Index of interface string description * 8 iInterface 1 0x02 Index of interface string description
* *
* IN Endpoint Descriptor * IN Endpoint Descriptor
* *
* Offset Field Size Value * Offset Field Size Value
* 0 bLength 1 0x07 Size of descriptor in bytes * 0 bLength 1 0x07 Size of descriptor in bytes
* 1 bDescriptorType 1 0x05 ENDPOINT descriptor type * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
@ -1295,9 +1295,9 @@ typedef enum {
* 3 bmAttributes 1 0x02 Endpoint attributes - Bulk * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
* 4 bNumEndpoints 2 0x0040 maximum packet size * 4 bNumEndpoints 2 0x0040 maximum packet size
* 5 bInterval 1 0x00 Interval for polling endpoint * 5 bInterval 1 0x00 Interval for polling endpoint
* *
* OUT Endpoint Descriptor * OUT Endpoint Descriptor
* *
* Offset Field Size Value * Offset Field Size Value
* 0 bLength 1 0x07 Size of descriptor in bytes * 0 bLength 1 0x07 Size of descriptor in bytes
* 1 bDescriptorType 1 0x05 ENDPOINT descriptor type * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
@ -1305,17 +1305,17 @@ typedef enum {
* 3 bmAttributes 1 0x02 Endpoint attributes - Bulk * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
* 4 bNumEndpoints 2 0x0040 maximum packet size * 4 bNumEndpoints 2 0x0040 maximum packet size
* 5 bInterval 1 0x00 Interval for polling endpoint * 5 bInterval 1 0x00 Interval for polling endpoint
* *
* DATA FORMAT * DATA FORMAT
* *
* IN Endpoint * IN Endpoint
* *
* The device reserves the first two bytes of data on this endpoint to contain the current * The device reserves the first two bytes of data on this endpoint to contain the current
* values of the modem and line status registers. In the absence of data, the device * values of the modem and line status registers. In the absence of data, the device
* generates a message consisting of these two status bytes every 40 ms * generates a message consisting of these two status bytes every 40 ms
* *
* Byte 0: Modem Status * Byte 0: Modem Status
* *
* Offset Description * Offset Description
* B0 Reserved - must be 1 * B0 Reserved - must be 1
* B1 Reserved - must be 0 * B1 Reserved - must be 0
@ -1325,9 +1325,9 @@ typedef enum {
* B5 Data Set Ready (DSR) * B5 Data Set Ready (DSR)
* B6 Ring Indicator (RI) * B6 Ring Indicator (RI)
* B7 Receive Line Signal Detect (RLSD) * B7 Receive Line Signal Detect (RLSD)
* *
* Byte 1: Line Status * Byte 1: Line Status
* *
* Offset Description * Offset Description
* B0 Data Ready (DR) * B0 Data Ready (DR)
* B1 Overrun Error (OE) * B1 Overrun Error (OE)
@ -1337,7 +1337,7 @@ typedef enum {
* B5 Transmitter Holding Register (THRE) * B5 Transmitter Holding Register (THRE)
* B6 Transmitter Empty (TEMT) * B6 Transmitter Empty (TEMT)
* B7 Error in RCVR FIFO * B7 Error in RCVR FIFO
* *
*/ */
#define FTDI_RS0_CTS (1 << 4) #define FTDI_RS0_CTS (1 << 4)
#define FTDI_RS0_DSR (1 << 5) #define FTDI_RS0_DSR (1 << 5)
@ -1355,17 +1355,17 @@ typedef enum {
/* /*
* OUT Endpoint * OUT Endpoint
* *
* This device reserves the first bytes of data on this endpoint contain the length * This device reserves the first bytes of data on this endpoint contain the length
* and port identifier of the message. For the FTDI USB Serial converter the port * and port identifier of the message. For the FTDI USB Serial converter the port
* identifier is always 1. * identifier is always 1.
* *
* Byte 0: Line Status * Byte 0: Line Status
* *
* Offset Description * Offset Description
* B0 Reserved - must be 1 * B0 Reserved - must be 1
* B1 Reserved - must be 0 * B1 Reserved - must be 0
* B2..7 Length of message - (not including Byte 0) * B2..7 Length of message - (not including Byte 0)
* *
*/ */