License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 22:07:57 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2005-04-17 06:20:36 +08:00
|
|
|
/*
|
2009-12-17 04:45:10 +08:00
|
|
|
* Driver definitions for the FTDI USB Single Port Serial Converter -
|
2008-07-22 18:11:23 +08:00
|
|
|
* known as FTDI_SIO (Serial Input/Output application of the chipset)
|
2005-04-17 06:20:36 +08:00
|
|
|
*
|
2009-12-17 04:45:10 +08:00
|
|
|
* For USB vendor/product IDs (VID/PID), please see ftdi_sio_ids.h
|
|
|
|
*
|
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* 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.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!
|
|
|
|
*
|
2008-07-22 18:11:23 +08:00
|
|
|
* The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side,
|
2005-04-17 06:20:36 +08:00
|
|
|
* USB on the other.
|
|
|
|
*
|
2009-04-09 22:03:09 +08:00
|
|
|
* Thanx to FTDI (http://www.ftdichip.com) for so kindly providing details
|
2005-04-17 06:20:36 +08:00
|
|
|
* of the protocol required to talk to the device and ongoing assistence
|
|
|
|
* during development.
|
|
|
|
*
|
2008-07-22 18:11:23 +08:00
|
|
|
* Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the
|
2005-04-17 06:20:36 +08:00
|
|
|
* FTDI_SIO implementation.
|
|
|
|
*
|
2006-05-04 18:34:25 +08:00
|
|
|
*/
|
2009-01-13 07:05:59 +08:00
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/* Commands */
|
2010-05-18 01:33:41 +08:00
|
|
|
#define FTDI_SIO_RESET 0 /* Reset the port */
|
|
|
|
#define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
|
|
|
|
#define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
|
|
|
|
#define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
|
|
|
|
#define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of
|
|
|
|
the port */
|
|
|
|
#define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modem
|
|
|
|
status register */
|
|
|
|
#define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
|
|
|
|
#define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
|
2005-04-17 06:20:36 +08:00
|
|
|
#define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */
|
|
|
|
#define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */
|
|
|
|
|
2010-01-17 18:45:47 +08:00
|
|
|
/* Interface indices for FT2232, FT2232H and FT4232H devices */
|
2009-04-09 22:03:09 +08:00
|
|
|
#define INTERFACE_A 1
|
|
|
|
#define INTERFACE_B 2
|
|
|
|
#define INTERFACE_C 3
|
|
|
|
#define INTERFACE_D 4
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2009-08-27 20:15:50 +08:00
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/*
|
|
|
|
* BmRequestType: 1100 0000b
|
|
|
|
* bRequest: FTDI_E2_READ
|
|
|
|
* wValue: 0
|
|
|
|
* wIndex: Address of word to read
|
|
|
|
* wLength: 2
|
|
|
|
* Data: Will return a word of data from E2Address
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Port Identifier Table */
|
2010-05-18 01:33:41 +08:00
|
|
|
#define PIT_DEFAULT 0 /* SIOA */
|
2005-04-17 06:20:36 +08:00
|
|
|
#define PIT_SIOA 1 /* SIOA */
|
|
|
|
/* The device this driver is tested with one has only one port */
|
|
|
|
#define PIT_SIOB 2 /* SIOB */
|
|
|
|
#define PIT_PARALLEL 3 /* Parallel */
|
|
|
|
|
|
|
|
/* FTDI_SIO_RESET */
|
|
|
|
#define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
|
|
|
|
#define FTDI_SIO_RESET_REQUEST_TYPE 0x40
|
|
|
|
#define FTDI_SIO_RESET_SIO 0
|
|
|
|
#define FTDI_SIO_RESET_PURGE_RX 1
|
|
|
|
#define FTDI_SIO_RESET_PURGE_TX 2
|
|
|
|
|
|
|
|
/*
|
|
|
|
* BmRequestType: 0100 0000B
|
|
|
|
* bRequest: FTDI_SIO_RESET
|
2008-07-22 18:11:23 +08:00
|
|
|
* wValue: Control Value
|
2005-04-17 06:20:36 +08:00
|
|
|
* 0 = Reset SIO
|
|
|
|
* 1 = Purge RX buffer
|
|
|
|
* 2 = Purge TX buffer
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: None
|
|
|
|
*
|
|
|
|
* The Reset SIO command has this effect:
|
|
|
|
*
|
|
|
|
* Sets flow control set to 'none'
|
|
|
|
* Event char = $0D
|
|
|
|
* Event trigger = disabled
|
|
|
|
* Purge RX buffer
|
|
|
|
* Purge TX buffer
|
|
|
|
* Clear DTR
|
|
|
|
* Clear RTS
|
|
|
|
* baud and data format not reset
|
|
|
|
*
|
|
|
|
* The Purge RX and TX buffer commands affect nothing except the buffers
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* FTDI_SIO_SET_BAUDRATE */
|
|
|
|
#define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
|
|
|
|
#define FTDI_SIO_SET_BAUDRATE_REQUEST 3
|
|
|
|
|
|
|
|
/*
|
|
|
|
* BmRequestType: 0100 0000B
|
|
|
|
* bRequest: FTDI_SIO_SET_BAUDRATE
|
|
|
|
* wValue: BaudDivisor value - see below
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: None
|
|
|
|
* The BaudDivisor values are calculated as follows:
|
2010-05-18 01:33:41 +08:00
|
|
|
* - BaseClock is either 12000000 or 48000000 depending on the device.
|
|
|
|
* FIXME: I wish I knew how to detect old chips to select proper base clock!
|
2005-04-17 06:20:36 +08:00
|
|
|
* - BaudDivisor is a fixed point number encoded in a funny way.
|
|
|
|
* (--WRONG WAY OF THINKING--)
|
|
|
|
* BaudDivisor is a fixed point number encoded with following bit weighs:
|
|
|
|
* (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
|
|
|
|
* end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
|
|
|
|
* (--THE REALITY--)
|
2010-05-18 01:33:41 +08:00
|
|
|
* The both-bits-set has quite different meaning from 0.75 - the chip
|
|
|
|
* designers have decided it to mean 0.125 instead of 0.75.
|
2005-04-17 06:20:36 +08:00
|
|
|
* This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
|
|
|
|
* and Flow Control Consideration for USB to RS232".
|
|
|
|
* - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
|
2010-05-18 01:33:41 +08:00
|
|
|
* automagically re-encode the resulting value to take fractions into
|
|
|
|
* consideration.
|
2005-04-17 06:20:36 +08:00
|
|
|
* As all values are integers, some bit twiddling is in order:
|
|
|
|
* BaudDivisor = (BaseClock / 16 / BaudRate) |
|
|
|
|
* (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5
|
|
|
|
* : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25
|
|
|
|
* : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125
|
|
|
|
* : 0)
|
|
|
|
*
|
|
|
|
* For the FT232BM, a 17th divisor bit was introduced to encode the multiples
|
|
|
|
* of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows
|
|
|
|
* (the first four codes are the same as for the FT8U232AM, where bit 16 is
|
|
|
|
* always 0):
|
|
|
|
* 000 - add .000 to divisor
|
|
|
|
* 001 - add .500 to divisor
|
|
|
|
* 010 - add .250 to divisor
|
|
|
|
* 011 - add .125 to divisor
|
|
|
|
* 100 - add .375 to divisor
|
|
|
|
* 101 - add .625 to divisor
|
|
|
|
* 110 - add .750 to divisor
|
|
|
|
* 111 - add .875 to divisor
|
2008-07-22 18:11:23 +08:00
|
|
|
* Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is
|
2005-04-17 06:20:36 +08:00
|
|
|
* placed in bit 0 of the urb index.
|
|
|
|
*
|
|
|
|
* Note that there are a couple of special cases to support the highest baud
|
|
|
|
* rates. If the calculated divisor value is 1, this needs to be replaced with
|
|
|
|
* 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001
|
|
|
|
* (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
|
|
|
|
* not supported by the FT8U232AM).
|
|
|
|
*/
|
|
|
|
|
2010-05-18 01:33:41 +08:00
|
|
|
enum ftdi_chip_type {
|
2005-04-17 06:20:36 +08:00
|
|
|
SIO = 1,
|
|
|
|
FT8U232AM = 2,
|
|
|
|
FT232BM = 3,
|
|
|
|
FT2232C = 4,
|
2007-03-05 07:03:26 +08:00
|
|
|
FT232RL = 5,
|
2009-04-09 22:03:09 +08:00
|
|
|
FT2232H = 6,
|
2011-06-17 23:30:23 +08:00
|
|
|
FT4232H = 7,
|
USB: ftdi_sio: add support for FT-X series devices
Add PID 0x6015, corresponding to the new series of FT-X chips
(FT220XD, FT201X, FT220X, FT221X, FT230X, FT231X, FT240X). They all
appear as serial devices, and seem indistinguishable except for the
default product string stored in their EEPROM. The baudrate
generation matches FT232RL devices.
Tested with a FT201X and FT230X at various baudrates (100 - 3000000).
Sample dmesg:
ftdi_sio: v1.6.0:USB FTDI Serial Converters Driver
usb 2-1: new full-speed USB device number 6 using ohci_hcd
usb 2-1: New USB device found, idVendor=0403, idProduct=6015
usb 2-1: New USB device strings: Mfr=1, Product=2, SerialNumber=3
usb 2-1: Product: FT230X USB Half UART
usb 2-1: Manufacturer: FTDI
usb 2-1: SerialNumber: DC001WI6
ftdi_sio 2-1:1.0: FTDI USB Serial Device converter detected
drivers/usb/serial/ftdi_sio.c: ftdi_sio_port_probe
drivers/usb/serial/ftdi_sio.c: ftdi_determine_type: bcdDevice = 0x1000, bNumInterfaces = 1
usb 2-1: Detected FT-X
usb 2-1: Number of endpoints 2
usb 2-1: Endpoint 1 MaxPacketSize 64
usb 2-1: Endpoint 2 MaxPacketSize 64
usb 2-1: Setting MaxPacketSize 64
drivers/usb/serial/ftdi_sio.c: read_latency_timer
drivers/usb/serial/ftdi_sio.c: write_latency_timer: setting latency timer = 1
drivers/usb/serial/ftdi_sio.c: create_sysfs_attrs
drivers/usb/serial/ftdi_sio.c: sysfs attributes for FT-X
usb 2-1: FTDI USB Serial Device converter now attached to ttyUSB0
Signed-off-by: Jim Paris <jim@jtan.com>
Cc: stable <stable@vger.kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2012-03-15 05:54:25 +08:00
|
|
|
FT232H = 8,
|
|
|
|
FTX = 9,
|
2010-05-18 01:33:41 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
enum ftdi_sio_baudrate {
|
|
|
|
ftdi_sio_b300 = 0,
|
|
|
|
ftdi_sio_b600 = 1,
|
|
|
|
ftdi_sio_b1200 = 2,
|
|
|
|
ftdi_sio_b2400 = 3,
|
|
|
|
ftdi_sio_b4800 = 4,
|
|
|
|
ftdi_sio_b9600 = 5,
|
|
|
|
ftdi_sio_b19200 = 6,
|
|
|
|
ftdi_sio_b38400 = 7,
|
|
|
|
ftdi_sio_b57600 = 8,
|
|
|
|
ftdi_sio_b115200 = 9
|
|
|
|
};
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
/*
|
2010-05-18 01:33:41 +08:00
|
|
|
* The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor
|
|
|
|
* values are calculated internally.
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|
2010-05-18 01:33:41 +08:00
|
|
|
#define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
|
|
|
|
#define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
|
|
|
|
#define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 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_MARK (0x3 << 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_15 (0x1 << 11)
|
|
|
|
#define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11)
|
|
|
|
#define FTDI_SIO_SET_BREAK (0x1 << 14)
|
2005-04-17 06:20:36 +08:00
|
|
|
/* FTDI_SIO_SET_DATA */
|
|
|
|
|
|
|
|
/*
|
2008-07-22 18:11:23 +08:00
|
|
|
* BmRequestType: 0100 0000B
|
2005-04-17 06:20:36 +08:00
|
|
|
* bRequest: FTDI_SIO_SET_DATA
|
|
|
|
* wValue: Data characteristics (see below)
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: No
|
|
|
|
*
|
|
|
|
* Data characteristics
|
|
|
|
*
|
|
|
|
* B0..7 Number of data bits
|
|
|
|
* B8..10 Parity
|
|
|
|
* 0 = None
|
|
|
|
* 1 = Odd
|
|
|
|
* 2 = Even
|
|
|
|
* 3 = Mark
|
|
|
|
* 4 = Space
|
|
|
|
* B11..13 Stop Bits
|
|
|
|
* 0 = 1
|
|
|
|
* 1 = 1.5
|
|
|
|
* 2 = 2
|
|
|
|
* B14
|
|
|
|
* 1 = TX ON (break)
|
|
|
|
* 0 = TX OFF (normal state)
|
|
|
|
* B15 Reserved
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* FTDI_SIO_MODEM_CTRL */
|
|
|
|
#define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
|
|
|
|
#define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
|
|
|
|
|
2008-07-22 18:11:23 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* BmRequestType: 0100 0000B
|
|
|
|
* bRequest: FTDI_SIO_MODEM_CTRL
|
|
|
|
* wValue: ControlValue (see below)
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: None
|
|
|
|
*
|
|
|
|
* NOTE: If the device is in RTS/CTS flow control, the RTS set by this
|
|
|
|
* command will be IGNORED without an error being returned
|
|
|
|
* Also - you can not set DTR and RTS with one control message
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define FTDI_SIO_SET_DTR_MASK 0x1
|
2016-02-05 02:01:27 +08:00
|
|
|
#define FTDI_SIO_SET_DTR_HIGH ((FTDI_SIO_SET_DTR_MASK << 8) | 1)
|
|
|
|
#define FTDI_SIO_SET_DTR_LOW ((FTDI_SIO_SET_DTR_MASK << 8) | 0)
|
2005-04-17 06:20:36 +08:00
|
|
|
#define FTDI_SIO_SET_RTS_MASK 0x2
|
2016-02-05 02:01:27 +08:00
|
|
|
#define FTDI_SIO_SET_RTS_HIGH ((FTDI_SIO_SET_RTS_MASK << 8) | 2)
|
|
|
|
#define FTDI_SIO_SET_RTS_LOW ((FTDI_SIO_SET_RTS_MASK << 8) | 0)
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
/*
|
|
|
|
* ControlValue
|
|
|
|
* B0 DTR state
|
|
|
|
* 0 = reset
|
|
|
|
* 1 = set
|
|
|
|
* B1 RTS state
|
|
|
|
* 0 = reset
|
|
|
|
* 1 = set
|
|
|
|
* B2..7 Reserved
|
|
|
|
* B8 DTR state enable
|
|
|
|
* 0 = ignore
|
|
|
|
* 1 = use DTR state
|
|
|
|
* B9 RTS state enable
|
|
|
|
* 0 = ignore
|
|
|
|
* 1 = use RTS state
|
|
|
|
* B10..15 Reserved
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* FTDI_SIO_SET_FLOW_CTRL */
|
|
|
|
#define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
|
|
|
|
#define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
|
2008-07-22 18:11:23 +08:00
|
|
|
#define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
|
2005-04-17 06:20:36 +08:00
|
|
|
#define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
|
|
|
|
#define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
|
|
|
|
#define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
|
|
|
|
/*
|
|
|
|
* BmRequestType: 0100 0000b
|
|
|
|
* bRequest: FTDI_SIO_SET_FLOW_CTRL
|
|
|
|
* wValue: Xoff/Xon
|
2010-01-17 18:45:47 +08:00
|
|
|
* wIndex: Protocol/Port - hIndex is protocol / lIndex is port
|
2008-07-22 18:11:23 +08:00
|
|
|
* wLength: 0
|
2005-04-17 06:20:36 +08:00
|
|
|
* Data: None
|
|
|
|
*
|
|
|
|
* hIndex protocol is:
|
|
|
|
* B0 Output handshaking using RTS/CTS
|
|
|
|
* 0 = disabled
|
|
|
|
* 1 = enabled
|
|
|
|
* B1 Output handshaking using DTR/DSR
|
|
|
|
* 0 = disabled
|
|
|
|
* 1 = enabled
|
|
|
|
* B2 Xon/Xoff handshaking
|
|
|
|
* 0 = disabled
|
|
|
|
* 1 = enabled
|
|
|
|
*
|
|
|
|
* A value of zero in the hIndex field disables handshaking
|
|
|
|
*
|
2010-05-18 01:33:41 +08:00
|
|
|
* If Xon/Xoff handshaking is specified, the hValue field should contain the
|
|
|
|
* XOFF character and the lValue field contains the XON character.
|
2008-07-22 18:11:23 +08:00
|
|
|
*/
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/*
|
|
|
|
* FTDI_SIO_GET_LATENCY_TIMER
|
|
|
|
*
|
|
|
|
* Set the timeout interval. The FTDI collects data from the slave
|
|
|
|
* device, transmitting it to the host when either A) 62 bytes are
|
|
|
|
* received, or B) the timeout interval has elapsed and the buffer
|
|
|
|
* contains at least 1 byte. Setting this value to a small number
|
|
|
|
* can dramatically improve performance for applications which send
|
|
|
|
* small packets, since the default value is 16ms.
|
|
|
|
*/
|
|
|
|
#define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
|
|
|
|
#define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
|
|
|
|
|
2008-07-22 18:11:23 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* BmRequestType: 1100 0000b
|
|
|
|
* bRequest: FTDI_SIO_GET_LATENCY_TIMER
|
|
|
|
* wValue: 0
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: latency (on return)
|
|
|
|
*/
|
|
|
|
|
2008-07-22 18:11:23 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* FTDI_SIO_SET_LATENCY_TIMER
|
|
|
|
*
|
|
|
|
* Set the timeout interval. The FTDI collects data from the slave
|
|
|
|
* device, transmitting it to the host when either A) 62 bytes are
|
|
|
|
* received, or B) the timeout interval has elapsed and the buffer
|
|
|
|
* contains at least 1 byte. Setting this value to a small number
|
|
|
|
* can dramatically improve performance for applications which send
|
|
|
|
* small packets, since the default value is 16ms.
|
|
|
|
*/
|
|
|
|
#define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
|
|
|
|
#define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
|
|
|
|
|
2008-07-22 18:11:23 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* BmRequestType: 0100 0000b
|
|
|
|
* bRequest: FTDI_SIO_SET_LATENCY_TIMER
|
|
|
|
* wValue: Latency (milliseconds)
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: None
|
|
|
|
*
|
|
|
|
* wValue:
|
|
|
|
* B0..7 Latency timer
|
|
|
|
* B8..15 0
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2008-07-22 18:11:23 +08:00
|
|
|
* FTDI_SIO_SET_EVENT_CHAR
|
2005-04-17 06:20:36 +08:00
|
|
|
*
|
|
|
|
* Set the special event character for the specified communications port.
|
|
|
|
* If the device sees this character it will immediately return the
|
|
|
|
* data read so far - rather than wait 40ms or until 62 bytes are read
|
|
|
|
* which is what normally happens.
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
#define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
|
|
|
|
#define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
|
|
|
|
|
|
|
|
|
2008-07-22 18:11:23 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* BmRequestType: 0100 0000b
|
|
|
|
* bRequest: FTDI_SIO_SET_EVENT_CHAR
|
|
|
|
* wValue: EventChar
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: None
|
|
|
|
*
|
|
|
|
* wValue:
|
|
|
|
* B0..7 Event Character
|
|
|
|
* B8 Event Character Processing
|
|
|
|
* 0 = disabled
|
|
|
|
* 1 = enabled
|
|
|
|
* B9..15 Reserved
|
|
|
|
*
|
|
|
|
*/
|
2008-07-22 18:11:23 +08:00
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/* FTDI_SIO_SET_ERROR_CHAR */
|
|
|
|
|
2010-05-18 01:33:41 +08:00
|
|
|
/*
|
|
|
|
* Set the parity error replacement character for the specified communications
|
|
|
|
* port
|
|
|
|
*/
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2008-07-22 18:11:23 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* BmRequestType: 0100 0000b
|
|
|
|
* bRequest: FTDI_SIO_SET_EVENT_CHAR
|
|
|
|
* wValue: Error Char
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 0
|
|
|
|
* Data: None
|
|
|
|
*
|
|
|
|
*Error Char
|
|
|
|
* B0..7 Error Character
|
|
|
|
* B8 Error Character Processing
|
|
|
|
* 0 = disabled
|
|
|
|
* 1 = enabled
|
|
|
|
* B9..15 Reserved
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* FTDI_SIO_GET_MODEM_STATUS */
|
2006-01-03 20:27:11 +08:00
|
|
|
/* Retrieve the current value of the modem status register */
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
#define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
|
|
|
|
#define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
|
|
|
|
#define FTDI_SIO_CTS_MASK 0x10
|
|
|
|
#define FTDI_SIO_DSR_MASK 0x20
|
|
|
|
#define FTDI_SIO_RI_MASK 0x40
|
|
|
|
#define FTDI_SIO_RLSD_MASK 0x80
|
2008-07-22 18:11:23 +08:00
|
|
|
/*
|
2005-04-17 06:20:36 +08:00
|
|
|
* BmRequestType: 1100 0000b
|
|
|
|
* bRequest: FTDI_SIO_GET_MODEM_STATUS
|
|
|
|
* wValue: zero
|
|
|
|
* wIndex: Port
|
|
|
|
* wLength: 1
|
|
|
|
* Data: Status
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
|
|
|
* One byte of data is returned
|
2005-04-17 06:20:36 +08:00
|
|
|
* B0..3 0
|
|
|
|
* B4 CTS
|
|
|
|
* 0 = inactive
|
|
|
|
* 1 = active
|
|
|
|
* B5 DSR
|
|
|
|
* 0 = inactive
|
|
|
|
* 1 = active
|
|
|
|
* B6 Ring Indicator (RI)
|
|
|
|
* 0 = inactive
|
|
|
|
* 1 = active
|
|
|
|
* B7 Receive Line Signal Detect (RLSD)
|
|
|
|
* 0 = inactive
|
2008-07-22 18:11:23 +08:00
|
|
|
* 1 = active
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
|
2008-07-22 18:11:23 +08:00
|
|
|
/* Descriptors returned by the device
|
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Device Descriptor
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Field Size Value Description
|
|
|
|
* 0 bLength 1 0x12 Size of descriptor in bytes
|
|
|
|
* 1 bDescriptorType 1 0x01 DEVICE Descriptor Type
|
|
|
|
* 2 bcdUSB 2 0x0110 USB Spec Release Number
|
|
|
|
* 4 bDeviceClass 1 0x00 Class Code
|
|
|
|
* 5 bDeviceSubClass 1 0x00 SubClass Code
|
|
|
|
* 6 bDeviceProtocol 1 0x00 Protocol Code
|
|
|
|
* 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0
|
|
|
|
* 8 idVendor 2 0x0403 Vendor ID
|
|
|
|
* 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID)
|
|
|
|
* 12 bcdDevice 2 0x0001 Device release number
|
|
|
|
* 14 iManufacturer 1 0x01 Index of man. string desc
|
|
|
|
* 15 iProduct 1 0x02 Index of prod string desc
|
|
|
|
* 16 iSerialNumber 1 0x02 Index of serial nmr string desc
|
|
|
|
* 17 bNumConfigurations 1 0x01 Number of possible configurations
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Configuration Descriptor
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Field Size Value
|
|
|
|
* 0 bLength 1 0x09 Size of descriptor in bytes
|
|
|
|
* 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type
|
|
|
|
* 2 wTotalLength 2 0x0020 Total length of data
|
|
|
|
* 4 bNumInterfaces 1 0x01 Number of interfaces supported
|
|
|
|
* 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req
|
|
|
|
* 6 iConfiguration 1 0x02 Index of config string descriptor
|
|
|
|
* 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup
|
|
|
|
* 8 MaxPower 1 0x1E Max power consumption
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Interface Descriptor
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Field Size Value
|
|
|
|
* 0 bLength 1 0x09 Size of descriptor in bytes
|
|
|
|
* 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type
|
|
|
|
* 2 bInterfaceNumber 1 0x00 Number of interface
|
|
|
|
* 3 bAlternateSetting 1 0x00 Value used to select alternate
|
|
|
|
* 4 bNumEndpoints 1 0x02 Number of endpoints
|
|
|
|
* 5 bInterfaceClass 1 0xFF Class Code
|
|
|
|
* 6 bInterfaceSubClass 1 0xFF Subclass Code
|
|
|
|
* 7 bInterfaceProtocol 1 0xFF Protocol Code
|
|
|
|
* 8 iInterface 1 0x02 Index of interface string description
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* IN Endpoint Descriptor
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Field Size Value
|
|
|
|
* 0 bLength 1 0x07 Size of descriptor in bytes
|
|
|
|
* 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
|
|
|
|
* 2 bEndpointAddress 1 0x82 Address of endpoint
|
|
|
|
* 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
|
|
|
|
* 4 bNumEndpoints 2 0x0040 maximum packet size
|
|
|
|
* 5 bInterval 1 0x00 Interval for polling endpoint
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* OUT Endpoint Descriptor
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Field Size Value
|
|
|
|
* 0 bLength 1 0x07 Size of descriptor in bytes
|
|
|
|
* 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
|
|
|
|
* 2 bEndpointAddress 1 0x02 Address of endpoint
|
|
|
|
* 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
|
|
|
|
* 4 bNumEndpoints 2 0x0040 maximum packet size
|
|
|
|
* 5 bInterval 1 0x00 Interval for polling endpoint
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* DATA FORMAT
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* IN Endpoint
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2010-05-18 01:33:41 +08:00
|
|
|
* 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 generates a message consisting of these two status bytes
|
|
|
|
* every 40 ms
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Byte 0: Modem Status
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Description
|
|
|
|
* B0 Reserved - must be 1
|
|
|
|
* B1 Reserved - must be 0
|
|
|
|
* B2 Reserved - must be 0
|
|
|
|
* B3 Reserved - must be 0
|
|
|
|
* B4 Clear to Send (CTS)
|
|
|
|
* B5 Data Set Ready (DSR)
|
|
|
|
* B6 Ring Indicator (RI)
|
|
|
|
* B7 Receive Line Signal Detect (RLSD)
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Byte 1: Line Status
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Description
|
|
|
|
* B0 Data Ready (DR)
|
|
|
|
* B1 Overrun Error (OE)
|
|
|
|
* B2 Parity Error (PE)
|
|
|
|
* B3 Framing Error (FE)
|
|
|
|
* B4 Break Interrupt (BI)
|
|
|
|
* B5 Transmitter Holding Register (THRE)
|
|
|
|
* B6 Transmitter Empty (TEMT)
|
|
|
|
* B7 Error in RCVR FIFO
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|
|
|
|
#define FTDI_RS0_CTS (1 << 4)
|
|
|
|
#define FTDI_RS0_DSR (1 << 5)
|
|
|
|
#define FTDI_RS0_RI (1 << 6)
|
|
|
|
#define FTDI_RS0_RLSD (1 << 7)
|
|
|
|
|
2010-05-18 01:33:41 +08:00
|
|
|
#define FTDI_RS_DR 1
|
|
|
|
#define FTDI_RS_OE (1<<1)
|
|
|
|
#define FTDI_RS_PE (1<<2)
|
|
|
|
#define FTDI_RS_FE (1<<3)
|
|
|
|
#define FTDI_RS_BI (1<<4)
|
|
|
|
#define FTDI_RS_THRE (1<<5)
|
|
|
|
#define FTDI_RS_TEMT (1<<6)
|
|
|
|
#define FTDI_RS_FIFO (1<<7)
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
/*
|
|
|
|
* OUT Endpoint
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2010-05-18 01:33:41 +08:00
|
|
|
* 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 identifier is always 1.
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Byte 0: Line Status
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
* Offset Description
|
|
|
|
* B0 Reserved - must be 1
|
|
|
|
* B1 Reserved - must be 0
|
|
|
|
* B2..7 Length of message - (not including Byte 0)
|
2008-07-22 18:11:23 +08:00
|
|
|
*
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|