linux/drivers/input/mouse/synaptics.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Synaptics TouchPad PS/2 mouse driver
 */

#ifndef _SYNAPTICS_H
#define _SYNAPTICS_H

/* synaptics queries */
#define SYN_QUE_IDENTIFY
#define SYN_QUE_MODES
#define SYN_QUE_CAPABILITIES
#define SYN_QUE_MODEL
#define SYN_QUE_SERIAL_NUMBER_PREFIX
#define SYN_QUE_SERIAL_NUMBER_SUFFIX
#define SYN_QUE_RESOLUTION
#define SYN_QUE_EXT_CAPAB
#define SYN_QUE_FIRMWARE_ID
#define SYN_QUE_EXT_CAPAB_0C
#define SYN_QUE_EXT_MAX_COORDS
#define SYN_QUE_EXT_MIN_COORDS
#define SYN_QUE_MEXT_CAPAB_10

/* synatics modes */
#define SYN_BIT_ABSOLUTE_MODE
#define SYN_BIT_HIGH_RATE
#define SYN_BIT_SLEEP_MODE
#define SYN_BIT_DISABLE_GESTURE
#define SYN_BIT_FOUR_BYTE_CLIENT
#define SYN_BIT_W_MODE

/* synaptics model ID bits */
#define SYN_MODEL_ROT180(m)
#define SYN_MODEL_PORTRAIT(m)
#define SYN_MODEL_SENSOR(m)
#define SYN_MODEL_HARDWARE(m)
#define SYN_MODEL_NEWABS(m)
#define SYN_MODEL_PEN(m)
#define SYN_MODEL_SIMPLIC(m)
#define SYN_MODEL_GEOMETRY(m)

/* synaptics capability bits */
#define SYN_CAP_EXTENDED(c)
#define SYN_CAP_MIDDLE_BUTTON(c)
#define SYN_CAP_PASS_THROUGH(c)
#define SYN_CAP_SLEEP(c)
#define SYN_CAP_FOUR_BUTTON(c)
#define SYN_CAP_MULTIFINGER(c)
#define SYN_CAP_PALMDETECT(c)
#define SYN_CAP_SUBMODEL_ID(c)
#define SYN_EXT_CAP_REQUESTS(c)
#define SYN_CAP_MB_MASK
#define SYN_CAP_MULTI_BUTTON_NO(ec)
#define SYN_CAP_PRODUCT_ID(ec)
#define SYN_MEXT_CAP_BIT(m)

/*
 * The following describes response for the 0x0c query.
 *
 * byte	mask	name			meaning
 * ----	----	-------			------------
 * 1	0x01	adjustable threshold	capacitive button sensitivity
 *					can be adjusted
 * 1	0x02	report max		query 0x0d gives max coord reported
 * 1	0x04	clearpad		sensor is ClearPad product
 * 1	0x08	advanced gesture	not particularly meaningful
 * 1	0x10	clickpad bit 0		1-button ClickPad
 * 1	0x60	multifinger mode	identifies firmware finger counting
 *					(not reporting!) algorithm.
 *					Not particularly meaningful
 * 1	0x80	covered pad		W clipped to 14, 15 == pad mostly covered
 * 2	0x01	clickpad bit 1		2-button ClickPad
 * 2	0x02	deluxe LED controls	touchpad support LED commands
 *					ala multimedia control bar
 * 2	0x04	reduced filtering	firmware does less filtering on
 *					position data, driver should watch
 *					for noise.
 * 2	0x08	image sensor		image sensor tracks 5 fingers, but only
 *					reports 2.
 * 2	0x01	uniform clickpad	whole clickpad moves instead of being
 *					hinged at the top.
 * 2	0x20	report min		query 0x0f gives min coord reported
 */
#define SYN_CAP_CLICKPAD(ex0c)
#define SYN_CAP_CLICKPAD2BTN(ex0c)
#define SYN_CAP_MAX_DIMENSIONS(ex0c)
#define SYN_CAP_MIN_DIMENSIONS(ex0c)
#define SYN_CAP_ADV_GESTURE(ex0c)
#define SYN_CAP_REDUCED_FILTERING(ex0c)
#define SYN_CAP_IMAGE_SENSOR(ex0c)
#define SYN_CAP_INTERTOUCH(ex0c)

/*
 * The following descibes response for the 0x10 query.
 *
 * byte	mask	name			meaning
 * ----	----	-------			------------
 * 1	0x01	ext buttons are stick	buttons exported in the extended
 *					capability are actually meant to be used
 *					by the tracktick (pass-through).
 * 1	0x02	SecurePad		the touchpad is a SecurePad, so it
 *					contains a built-in fingerprint reader.
 * 1	0xe0	more ext count		how many more extented queries are
 *					available after this one.
 * 2	0xff	SecurePad width		the width of the SecurePad fingerprint
 *					reader.
 * 3	0xff	SecurePad height	the height of the SecurePad fingerprint
 *					reader.
 */
#define SYN_CAP_EXT_BUTTONS_STICK(ex10)
#define SYN_CAP_SECUREPAD(ex10)

#define SYN_EXT_BUTTON_STICK_L(eb)
#define SYN_EXT_BUTTON_STICK_M(eb)
#define SYN_EXT_BUTTON_STICK_R(eb)

/* synaptics modes query bits */
#define SYN_MODE_ABSOLUTE(m)
#define SYN_MODE_RATE(m)
#define SYN_MODE_BAUD_SLEEP(m)
#define SYN_MODE_DISABLE_GESTURE(m)
#define SYN_MODE_PACKSIZE(m)
#define SYN_MODE_WMODE(m)

/* synaptics identify query bits */
#define SYN_ID_MODEL(i)
#define SYN_ID_MAJOR(i)
#define SYN_ID_MINOR(i)
#define SYN_ID_FULL(i)
#define SYN_ID_IS_SYNAPTICS(i)
#define SYN_ID_DISGEST_SUPPORTED(i)

/* synaptics special commands */
#define SYN_PS_SET_MODE2
#define SYN_PS_CLIENT_CMD

/* amount to fuzz position data when touchpad reports reduced filtering */
#define SYN_REDUCED_FILTER_FUZZ

/* synaptics packet types */
enum synaptics_pkt_type {};

/*
 * A structure to describe the state of the touchpad hardware (buttons and pad)
 */
struct synaptics_hw_state {};

/* Data read from the touchpad */
struct synaptics_device_info {};

struct synaptics_data {};

void synaptics_module_init(void);
int synaptics_detect(struct psmouse *psmouse, bool set_properties);
int synaptics_init_absolute(struct psmouse *psmouse);
int synaptics_init_relative(struct psmouse *psmouse);
int synaptics_init_smbus(struct psmouse *psmouse);
int synaptics_init(struct psmouse *psmouse);
void synaptics_reset(struct psmouse *psmouse);

#endif /* _SYNAPTICS_H */