Input: sentelic - convert documentation into ReST format (9dc500a3) · Commits · e / devices / android_kernel_fairphone_FP4

Documentation/input/sentelic.txt

+518 −490

Original line number	Original line	Diff line number	Diff line
	Copyright (C) 2002-2011 Sentelic Corporation.		.. include:: <isonum.txt>
	Last update: Dec-07-2011
			===============
			Sentelic Driver
			===============


			:Copyright: \|copy\| 2002-2011 Sentelic Corporation.

			:Last update: Dec-07-2011

			Finger Sensing Pad Intellimouse Mode(scrolling wheel, 4th and 5th buttons)
			==========================================================================

	==============================================================================
	* Finger Sensing Pad Intellimouse Mode(scrolling wheel, 4th and 5th buttons)
	==============================================================================
	A) MSID 4: Scrolling wheel mode plus Forward page(4th button) and Backward		A) MSID 4: Scrolling wheel mode plus Forward page(4th button) and Backward
	page (5th button)		page (5th button)
	@1. Set sample rate to 200;
	@2. Set sample rate to 200;		1. Set sample rate to 200;
	@3. Set sample rate to 80;		2. Set sample rate to 200;
	@4. Issuing the "Get device ID" command (0xF2) and waits for the response;		3. Set sample rate to 80;
	@5. FSP will respond 0x04.		4. Issuing the "Get device ID" command (0xF2) and waits for the response;
			5. FSP will respond 0x04.

			::

	Packet 1		Packet 1
	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	@@ -35,12 +46,15 @@ Byte 4: Bit3~Bit0 => the scrolling wheel's movement since the last data report.
	Bit5 => 1 = 5th mouse button is pressed, Backward one page.		Bit5 => 1 = 5th mouse button is pressed, Backward one page.
	0 = 5th mouse button is not pressed.		0 = 5th mouse button is not pressed.

	B) MSID 6: Horizontal and Vertical scrolling.		B) MSID 6: Horizontal and Vertical scrolling
	@ Set bit 1 in register 0x40 to 1

	# FSP replaces scrolling wheel's movement as 4 bits to show horizontal and		- Set bit 1 in register 0x40 to 1

			FSP replaces scrolling wheel's movement as 4 bits to show horizontal and
	vertical scrolling.		vertical scrolling.

			::

	Packet 1		Packet 1
	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|		BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|
	@@ -66,20 +80,24 @@ Byte 4: Bit0 => the Vertical scrolling movement downward.
	Bit5 => 1 = 5th mouse button is pressed, Backward one page.		Bit5 => 1 = 5th mouse button is pressed, Backward one page.
	0 = 5th mouse button is not pressed.		0 = 5th mouse button is not pressed.

	C) MSID 7:		C) MSID 7
	# FSP uses 2 packets (8 Bytes) to represent Absolute Position.
			FSP uses 2 packets (8 Bytes) to represent Absolute Position.
	so we have PACKET NUMBER to identify packets.		so we have PACKET NUMBER to identify packets.

	If PACKET NUMBER is 0, the packet is Packet 1.		If PACKET NUMBER is 0, the packet is Packet 1.
	If PACKET NUMBER is 1, the packet is Packet 2.		If PACKET NUMBER is 1, the packet is Packet 2.
	Please count this number in program.		Please count this number in program.

	# MSID6 special packet will be enable at the same time when enable MSID 7.		MSID6 special packet will be enable at the same time when enable MSID 7.

	==============================================================================		Absolute position for STL3886-G0
	* Absolute position for STL3886-G0.		================================
	==============================================================================
	@ Set bit 2 or 3 in register 0x40 to 1		1. Set bit 2 or 3 in register 0x40 to 1
	@ Set bit 6 in register 0x40 to 1		2. Set bit 6 in register 0x40 to 1

			::

	Packet 1 (ABSOLUTE POSITION)		Packet 1 (ABSOLUTE POSITION)
	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	@@ -128,9 +146,11 @@ Byte 3: Message Type => 0x00 (Disabled)
	=> 0x01 (Icon)		=> 0x01 (Icon)
	Byte 4: Bit7~Bit0 => Don't Care		Byte 4: Bit7~Bit0 => Don't Care

	==============================================================================		Absolute position for STL3888-Ax
	* Absolute position for STL3888-Ax.		================================
	==============================================================================
			::

	Packet 1 (ABSOLUTE POSITION)		Packet 1 (ABSOLUTE POSITION)
	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|		BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|
	@@ -218,9 +238,11 @@ Sample sequence of Multi-finger, Multi-coordinate mode:
	notify packet (valid bit == 1), abs pkt 1, abs pkt 2, abs pkt 1,		notify packet (valid bit == 1), abs pkt 1, abs pkt 2, abs pkt 1,
	abs pkt 2, ..., notify packet (valid bit == 0)		abs pkt 2, ..., notify packet (valid bit == 0)

	==============================================================================		Absolute position for STL3888-B0
	* Absolute position for STL3888-B0.		================================
	==============================================================================
			::

	Packet 1(ABSOLUTE POSITION)		Packet 1(ABSOLUTE POSITION)
	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|		BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|
	@@ -275,7 +297,8 @@ Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
	Bit6 => scroll left button		Bit6 => scroll left button
	Bit7 => scroll right button		Bit7 => scroll right button

	Notify Packet for STL3888-B0		Notify Packet for STL3888-B0::

	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|		BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|
	1 \|1\|0\|1\|P\|1\|M\|R\|L\| 2 \|C\|C\|C\|C\|C\|C\|C\|C\| 3 \|0\|0\|F\|F\|0\|0\|0\|i\| 4 \|r\|l\|u\|d\|0\|0\|0\|0\|		1 \|1\|0\|1\|P\|1\|M\|R\|L\| 2 \|C\|C\|C\|C\|C\|C\|C\|C\| 3 \|0\|0\|F\|F\|0\|0\|0\|i\| 4 \|r\|l\|u\|d\|0\|0\|0\|0\|
	@@ -312,9 +335,11 @@ Sample sequence of Multi-finger, Multi-coordinate mode:
	notify packet (valid bit == 1), abs pkt 1, abs pkt 2, abs pkt 1,		notify packet (valid bit == 1), abs pkt 1, abs pkt 2, abs pkt 1,
	abs pkt 2, ..., notify packet (valid bit == 0)		abs pkt 2, ..., notify packet (valid bit == 0)

	==============================================================================		Absolute position for STL3888-Cx and STL3888-Dx
	* Absolute position for STL3888-Cx and STL3888-Dx.		===============================================
	==============================================================================
			::

	Single Finger, Absolute Coordinate Mode (SFAC)		Single Finger, Absolute Coordinate Mode (SFAC)
	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|		BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|
	@@ -380,7 +405,8 @@ the 2nd finger is up. On the other hand, if both fingers are up, the device
	will output four consecutive single-finger, absolute coordinate(SFAC) packets		will output four consecutive single-finger, absolute coordinate(SFAC) packets
	with zero X and Y.		with zero X and Y.

	Notify Packet for STL3888-Cx/Dx		Notify Packet for STL3888-Cx/Dx::

	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|		BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|
	1 \|1\|0\|0\|P\|1\|M\|R\|L\| 2 \|C\|C\|C\|C\|C\|C\|C\|C\| 3 \|0\|0\|F\|F\|0\|0\|0\|i\| 4 \|r\|l\|u\|d\|0\|0\|0\|0\|		1 \|1\|0\|0\|P\|1\|M\|R\|L\| 2 \|C\|C\|C\|C\|C\|C\|C\|C\| 3 \|0\|0\|F\|F\|0\|0\|0\|i\| 4 \|r\|l\|u\|d\|0\|0\|0\|0\|
	@@ -416,9 +442,11 @@ Sample sequence of Multi-finger, Multi-coordinates mode:
	That is, when the device is in MFMC mode, the host will receive		That is, when the device is in MFMC mode, the host will receive
	interleaved absolute coordinate packets for each finger.		interleaved absolute coordinate packets for each finger.

	==============================================================================		FSP Enable/Disable packet
	* FSP Enable/Disable packet		=========================
	==============================================================================
			::

	Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0		Bit 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
	BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|		BYTE \|---------------\|BYTE \|---------------\|BYTE\|---------------\|BYTE\|---------------\|
	1 \|Y\|X\|0\|0\|1\|M\|R\|L\| 2 \|0\|1\|0\|1\|1\|0\|1\|E\| 3 \| \| \| \| \| \| \| \| \| 4 \| \| \| \| \| \| \| \| \|		1 \|Y\|X\|0\|0\|1\|M\|R\|L\| 2 \|0\|1\|0\|1\|1\|0\|1\|E\| 3 \| \| \| \| \| \| \| \| \| 4 \| \| \| \| \| \| \| \| \|
	@@ -444,22 +472,21 @@ Byte 3: Don't care
	Byte 4: Don't care (MOUSE ID 3, 4)		Byte 4: Don't care (MOUSE ID 3, 4)
	Byte 5~8: Don't care (Absolute packet)		Byte 5~8: Don't care (Absolute packet)

	==============================================================================		PS/2 Command Set
	* PS/2 Command Set		================
	==============================================================================

	FSP supports basic PS/2 commanding set and modes, refer to following URL for		FSP supports basic PS/2 commanding set and modes, refer to following URL for
	details about PS/2 commands:		details about PS/2 commands:

	http://www.computer-engineering.org/ps2mouse/		http://www.computer-engineering.org/ps2mouse/

	==============================================================================		Programming Sequence for Determining Packet Parsing Flow
	* Programming Sequence for Determining Packet Parsing Flow		========================================================
	==============================================================================
	1. Identify FSP by reading device ID(0x00) and version(0x01) register		1. Identify FSP by reading device ID(0x00) and version(0x01) register

	2a. For FSP version < STL3888 Cx, determine number of buttons by reading		2. For FSP version < STL3888 Cx, determine number of buttons by reading
	the 'test mode status' (0x20) register:		the 'test mode status' (0x20) register::

	buttons = reg[0x20] & 0x30		buttons = reg[0x20] & 0x30

	@@ -476,25 +503,24 @@ http://www.computer-engineering.org/ps2mouse/
	Refer to 'Finger Sensing Pad PS/2 Mouse Intellimouse'		Refer to 'Finger Sensing Pad PS/2 Mouse Intellimouse'
	section A for packet parsing detail		section A for packet parsing detail

	2b. For FSP version >= STL3888 Cx:		3. For FSP version >= STL3888 Cx:
	Refer to 'Finger Sensing Pad PS/2 Mouse Intellimouse'		Refer to 'Finger Sensing Pad PS/2 Mouse Intellimouse'
	section A for packet parsing detail (ignore byte 4, bit ~ 7)		section A for packet parsing detail (ignore byte 4, bit ~ 7)

	==============================================================================		Programming Sequence for Register Reading/Writing
	* Programming Sequence for Register Reading/Writing		=================================================
	==============================================================================

	Register inversion requirement:		Register inversion requirement:

	Following values needed to be inverted(the '~' operator in C) before being		Following values needed to be inverted(the '~' operator in C) before being
	sent to FSP:		sent to FSP::

	0xe8, 0xe9, 0xee, 0xf2, 0xf3 and 0xff.		0xe8, 0xe9, 0xee, 0xf2, 0xf3 and 0xff.

	Register swapping requirement:		Register swapping requirement:

	Following values needed to have their higher 4 bits and lower 4 bits being		Following values needed to have their higher 4 bits and lower 4 bits being
	swapped before being sent to FSP:		swapped before being sent to FSP::

	10, 20, 40, 60, 80, 100 and 200.		10, 20, 40, 60, 80, 100 and 200.

	@@ -512,33 +538,33 @@ Register reading sequence:
	inverted(refer to the 'Register inversion requirement' section),		inverted(refer to the 'Register inversion requirement' section),
	goto step 6		goto step 6

	5a. send 0x68 PS/2 command to FSP;		a. send 0x68 PS/2 command to FSP;

	5b. send the inverted register address to FSP and goto step 8;		b. send the inverted register address to FSP and goto step 8;

	6. if the register address being to read is not required to be		6. if the register address being to read is not required to be
	swapped(refer to the 'Register swapping requirement' section),		swapped(refer to the 'Register swapping requirement' section),
	goto step 7		goto step 7

	6a. send 0xcc PS/2 command to FSP;		a. send 0xcc PS/2 command to FSP;

	6b. send the swapped register address to FSP and goto step 8;		b. send the swapped register address to FSP and goto step 8;

	7. send 0x66 PS/2 command to FSP;		7. send 0x66 PS/2 command to FSP;

	7a. send the original register address to FSP and goto step 8;		a. send the original register address to FSP and goto step 8;

	8. send 0xe9(status request) PS/2 command to FSP;		8. send 0xe9(status request) PS/2 command to FSP;

	9. the 4th byte of the response read from FSP should be the		9. the 4th byte of the response read from FSP should be the
	requested register value(?? indicates don't care byte):		requested register value(?? indicates don't care byte)::

	host: 0xe9		host: 0xe9
	3888: 0xfa (??) (??) (val)		3888: 0xfa (??) (??) (val)

	* Note that since the Cx release, the hardware will return 1's		* Note that since the Cx release, the hardware will return 1's
	complement of the register value at the 3rd byte of status request		complement of the register value at the 3rd byte of status request
	result:		result::

	host: 0xe9		host: 0xe9
	3888: 0xfa (??) (~val) (val)		3888: 0xfa (??) (~val) (val)
	@@ -551,21 +577,21 @@ Register writing sequence:
	inverted(refer to the 'Register inversion requirement' section),		inverted(refer to the 'Register inversion requirement' section),
	goto step 3		goto step 3

	2a. send 0x74 PS/2 command to FSP;		a. send 0x74 PS/2 command to FSP;

	2b. send the inverted register address to FSP and goto step 5;		b. send the inverted register address to FSP and goto step 5;

	3. if the register address being to write is not required to be		3. if the register address being to write is not required to be
	swapped(refer to the 'Register swapping requirement' section),		swapped(refer to the 'Register swapping requirement' section),
	goto step 4		goto step 4

	3a. send 0x77 PS/2 command to FSP;		a. send 0x77 PS/2 command to FSP;

	3b. send the swapped register address to FSP and goto step 5;		b. send the swapped register address to FSP and goto step 5;

	4. send 0x55 PS/2 command to FSP;		4. send 0x55 PS/2 command to FSP;

	4a. send the register address to FSP and goto step 5;		a. send the register address to FSP and goto step 5;

	5. send 0xf3 PS/2 command to FSP;		5. send 0xf3 PS/2 command to FSP;

	@@ -573,37 +599,36 @@ Register writing sequence:
	inverted(refer to the 'Register inversion requirement' section),		inverted(refer to the 'Register inversion requirement' section),
	goto step 7		goto step 7

	6a. send 0x47 PS/2 command to FSP;		a. send 0x47 PS/2 command to FSP;

	6b. send the inverted register value to FSP and goto step 9;		b. send the inverted register value to FSP and goto step 9;

	7. if the register value being to write is not required to be		7. if the register value being to write is not required to be
	swapped(refer to the 'Register swapping requirement' section),		swapped(refer to the 'Register swapping requirement' section),
	goto step 8		goto step 8

	7a. send 0x44 PS/2 command to FSP;		a. send 0x44 PS/2 command to FSP;

	7b. send the swapped register value to FSP and goto step 9;		b. send the swapped register value to FSP and goto step 9;

	8. send 0x33 PS/2 command to FSP;		8. send 0x33 PS/2 command to FSP;

	8a. send the register value to FSP;		a. send the register value to FSP;

	9. the register writing sequence is completed.		9. the register writing sequence is completed.

	* Note that since the Cx release, the hardware will return 1's		* Since the Cx release, the hardware will return 1's
	complement of the register value at the 3rd byte of status request		complement of the register value at the 3rd byte of status request
	result. Host can optionally send another 0xe9 (status request) PS/2		result. Host can optionally send another 0xe9 (status request) PS/2
	command to FSP at the end of register writing to verify that the		command to FSP at the end of register writing to verify that the
	register writing operation is successful (?? indicates don't care		register writing operation is successful (?? indicates don't care
	byte):		byte)::

	host: 0xe9		host: 0xe9
	3888: 0xfa (??) (~val) (val)		3888: 0xfa (??) (~val) (val)

	==============================================================================		Programming Sequence for Page Register Reading/Writing
	* Programming Sequence for Page Register Reading/Writing		======================================================
	==============================================================================

	In order to overcome the limitation of maximum number of registers		In order to overcome the limitation of maximum number of registers
	supported, the hardware separates register into different groups called		supported, the hardware separates register into different groups called
	@@ -632,6 +657,7 @@ Page register reading sequence:

	8. the response read from FSP should be the requested page value.		8. the response read from FSP should be the requested page value.


	Page register writing sequence:		Page register writing sequence:

	1. send 0xf3 PS/2 command to FSP;		1. send 0xf3 PS/2 command to FSP;
	@@ -646,17 +672,17 @@ Page register writing sequence:
	inverted(refer to the 'Register inversion requirement' section),		inverted(refer to the 'Register inversion requirement' section),
	goto step 6		goto step 6

	5a. send 0x47 PS/2 command to FSP;		a. send 0x47 PS/2 command to FSP;

	5b. send the inverted page address to FSP and goto step 9;		b. send the inverted page address to FSP and goto step 9;

	6. if the page address being written is not required to be		6. if the page address being written is not required to be
	swapped(refer to the 'Register swapping requirement' section),		swapped(refer to the 'Register swapping requirement' section),
	goto step 7		goto step 7

	6a. send 0x44 PS/2 command to FSP;		a. send 0x44 PS/2 command to FSP;

	6b. send the swapped page address to FSP and goto step 9;		b. send the swapped page address to FSP and goto step 9;

	7. send 0x33 PS/2 command to FSP;		7. send 0x33 PS/2 command to FSP;

	@@ -664,16 +690,17 @@ Page register writing sequence:

	9. the page register writing sequence is completed.		9. the page register writing sequence is completed.

	==============================================================================		Gesture ID
	* Gesture ID		==========
	==============================================================================

	Unlike other devices which sends multiple fingers' coordinates to host,		Unlike other devices which sends multiple fingers' coordinates to host,
	FSP processes multiple fingers' coordinates internally and convert them		FSP processes multiple fingers' coordinates internally and convert them
	into a 8 bits integer, namely 'Gesture ID.' Following is a list of		into a 8 bits integer, namely 'Gesture ID.' Following is a list of
	supported gesture IDs:		supported gesture IDs:

			======= ==================================
	ID Description		ID Description
			======= ==================================
	0x86 2 finger straight up		0x86 2 finger straight up
	0x82 2 finger straight down		0x82 2 finger straight down
	0x80 2 finger straight right		0x80 2 finger straight right
	@@ -687,16 +714,16 @@ supported gesture IDs:
	0x28 3 finger straight right		0x28 3 finger straight right
	0x2c 3 finger straight left		0x2c 3 finger straight left
	0x38 palm		0x38 palm
			======= ==================================

	==============================================================================		Register Listing
	* Register Listing		================
	==============================================================================

	Registers are represented in 16 bits values. The higher 8 bits represent		Registers are represented in 16 bits values. The higher 8 bits represent
	the page address and the lower 8 bits represent the relative offset within		the page address and the lower 8 bits represent the relative offset within
	that particular page. Refer to the 'Programming Sequence for Page Register		that particular page. Refer to the 'Programming Sequence for Page Register
	Reading/Writing' section for instructions on how to change current page		Reading/Writing' section for instructions on how to change current page
	address.		address::

	offset width default r/w name		offset width default r/w name
	0x8200 bit7~bit0 0x01 RO device ID		0x8200 bit7~bit0 0x01 RO device ID
	@@ -856,7 +883,8 @@ offset width default r/w name
	*supported since Cx		*supported since Cx

	bit7 0 RW Bx packet output compatible mode		bit7 0 RW Bx packet output compatible mode
	0: disable, 1: enable *supported since Cx		0: disable, 1: enable
			*supported since Cx
	*supported since Cx		*supported since Cx