linux-stable/drivers/usb/serial/cypress_m8.h
James Hilliard 5c45d04c50 USB: serial: cypress_m8: enable Simply Automated UPB PIM
This is a UPB (Universal Powerline Bus) PIM (Powerline Interface Module)
which allows for controlling multiple UPB compatible devices from Linux
using the standard serial interface.

Based on vendor application source code there are two different models
of USB based PIM devices in addition to a number of RS232 based PIM's.

The vendor UPB application source contains the following USB ID's:

	#define USB_PCS_VENDOR_ID 0x04b4
	#define USB_PCS_PIM_PRODUCT_ID 0x5500

	#define USB_SAI_VENDOR_ID 0x17dd
	#define USB_SAI_PIM_PRODUCT_ID 0x5500

The first set of ID's correspond to the PIM variant sold by Powerline
Control Systems while the second corresponds to the Simply Automated
Incorporated PIM. As the product ID for both of these match the default
cypress HID->COM RS232 product ID it assumed that they both use an
internal variant of this HID->COM RS232 converter hardware. However
as the vendor ID for the Simply Automated variant is different we need
to also add it to the cypress_M8 driver so that it is properly
detected.

Signed-off-by: James Hilliard <james.hilliard1@gmail.com>
Link: https://lore.kernel.org/r/20200616220403.1807003-1-james.hilliard1@gmail.com
Cc: stable@vger.kernel.org
[ johan: amend VID define entry ]
Signed-off-by: Johan Hovold <johan@kernel.org>
2020-06-23 09:56:17 +02:00

82 lines
2.3 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef CYPRESS_M8_H
#define CYPRESS_M8_H
/*
* definitions and function prototypes used for the cypress USB to Serial
* controller
*/
/*
* For sending our feature buffer - controlling serial communication states.
* Linux HID has no support for serial devices so we do this through the driver
*/
#define HID_REQ_GET_REPORT 0x01
#define HID_REQ_SET_REPORT 0x09
/* List other cypress USB to Serial devices here, and add them to the id_table */
/* DeLorme Earthmate USB - a GPS device */
#define VENDOR_ID_DELORME 0x1163
#define PRODUCT_ID_EARTHMATEUSB 0x0100
#define PRODUCT_ID_EARTHMATEUSB_LT20 0x0200
/* Cypress HID->COM RS232 Adapter */
#define VENDOR_ID_CYPRESS 0x04b4
#define PRODUCT_ID_CYPHIDCOM 0x5500
/* Simply Automated HID->COM UPB PIM (using Cypress PID 0x5500) */
#define VENDOR_ID_SAI 0x17dd
/* FRWD Dongle - a GPS sports watch */
#define VENDOR_ID_FRWD 0x6737
#define PRODUCT_ID_CYPHIDCOM_FRWD 0x0001
/* Powercom UPS, chip CY7C63723 */
#define VENDOR_ID_POWERCOM 0x0d9f
#define PRODUCT_ID_UPS 0x0002
/* Nokia CA-42 USB to serial cable */
#define VENDOR_ID_DAZZLE 0x07d0
#define PRODUCT_ID_CA42 0x4101
/* End of device listing */
/* Used for setting / requesting serial line settings */
#define CYPRESS_SET_CONFIG 0x01
#define CYPRESS_GET_CONFIG 0x02
/* Used for throttle control */
#define THROTTLED 0x1
#define ACTUALLY_THROTTLED 0x2
/*
* chiptypes - used in case firmware differs from the generic form ... offering
* different baud speeds/etc.
*/
#define CT_EARTHMATE 0x01
#define CT_CYPHIDCOM 0x02
#define CT_CA42V2 0x03
#define CT_GENERIC 0x0F
/* End of chiptype definitions */
/*
* RS-232 serial data communication protocol definitions.
*
* These are sent / read at byte 0 of the input/output hid reports.
* You can find these values defined in the CY4601 USB to Serial design notes.
*/
#define CONTROL_DTR 0x20 /* data terminal ready */
#define CONTROL_RTS 0x10 /* request to send */
#define CONTROL_RESET 0x08 /* sent with output report */
#define UART_MSR_MASK 0xf0
#define UART_RI 0x80 /* ring indicator */
#define UART_CD 0x40 /* carrier detect */
#define UART_DSR 0x20 /* data set ready */
#define UART_CTS 0x10 /* clear to send */
#define CYP_ERROR 0x08 /* received from input report */
/* End of RS-232 protocol definitions */
#endif /* CYPRESS_M8_H */