Skip to content

L
linux
Commit 9dc500a3 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Dmitry Torokhov
Browse files
Options

Input: sentelic - convert documentation into ReST format 

This file has its own particular format that doesn't match any
markup one.

Manually change it to get something that would be readable
using ReST markup language.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarDmitry Torokhov <dmitry.torokhov@gmail.com>
parent 42f2309b
Hide whitespace changes
Inline Side-by-side
Showing with 518 additions and 490 deletions
Documentation/input/sentelic.txt
View file @ 9dc500a3
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
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|---------------|
1 |Y|X|y|x|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 | | |B|F|W|W|W|W| 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
BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------|
Byte 1: Bit7 => Y overflow 1 |Y|X|y|x|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 | | |B|F|W|W|W|W|
Bit6 => X overflow |---------------| |---------------| |---------------| |---------------|
Bit5 => Y sign bit
Bit4 => X sign bit Byte 1: Bit7 => Y overflow
Bit3 => 1 Bit6 => X overflow
Bit2 => Middle Button, 1 is pressed, 0 is not pressed. Bit5 => Y sign bit
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Bit4 => X sign bit
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit3 => 1
Byte 2: X Movement(9-bit 2's complement integers) Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Byte 3: Y Movement(9-bit 2's complement integers) Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Byte 4: Bit3~Bit0 => the scrolling wheel's movement since the last data report. Bit0 => Left Button, 1 is pressed, 0 is not pressed.
valid values, -8 ~ +7 Byte 2: X Movement(9-bit 2's complement integers)
Bit4 => 1 = 4th mouse button is pressed, Forward one page. Byte 3: Y Movement(9-bit 2's complement integers)
0 = 4th mouse button is not pressed. Byte 4: Bit3~Bit0 => the scrolling wheel's movement since the last data report.
Bit5 => 1 = 5th mouse button is pressed, Backward one page. valid values, -8 ~ +7
0 = 5th mouse button is not pressed. Bit4 => 1 = 4th mouse button is pressed, Forward one page.
0 = 4th mouse button is not pressed.
B) MSID 6: Horizontal and Vertical scrolling. Bit5 => 1 = 5th mouse button is pressed, Backward one page.
@ Set bit 1 in register 0x40 to 1 0 = 5th mouse button is not pressed.
# FSP replaces scrolling wheel's movement as 4 bits to show horizontal and B) MSID 6: Horizontal and Vertical scrolling
vertical scrolling.
- Set bit 1 in register 0x40 to 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 FSP replaces scrolling wheel's movement as 4 bits to show horizontal and
BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------| vertical scrolling.
1 |Y|X|y|x|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 | | |B|F|r|l|u|d|
|---------------| |---------------| |---------------| |---------------| ::
Byte 1: Bit7 => Y overflow Packet 1
Bit6 => X overflow 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
Bit5 => Y sign bit BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------|
Bit4 => X sign bit 1 |Y|X|y|x|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 | | |B|F|r|l|u|d|
Bit3 => 1 |---------------| |---------------| |---------------| |---------------|
Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Byte 1: Bit7 => Y overflow
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit6 => X overflow
Byte 2: X Movement(9-bit 2's complement integers) Bit5 => Y sign bit
Byte 3: Y Movement(9-bit 2's complement integers) Bit4 => X sign bit
Byte 4: Bit0 => the Vertical scrolling movement downward. Bit3 => 1
Bit1 => the Vertical scrolling movement upward. Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Bit2 => the Horizontal scrolling movement leftward. Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Bit3 => the Horizontal scrolling movement rightward. Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Bit4 => 1 = 4th mouse button is pressed, Forward one page. Byte 2: X Movement(9-bit 2's complement integers)
0 = 4th mouse button is not pressed. Byte 3: Y Movement(9-bit 2's complement integers)
Bit5 => 1 = 5th mouse button is pressed, Backward one page. Byte 4: Bit0 => the Vertical scrolling movement downward.
0 = 5th mouse button is not pressed. Bit1 => the Vertical scrolling movement upward.
Bit2 => the Horizontal scrolling movement leftward.
C) MSID 7: Bit3 => the Horizontal scrolling movement rightward.
# FSP uses 2 packets (8 Bytes) to represent Absolute Position. Bit4 => 1 = 4th mouse button is pressed, Forward one page.
so we have PACKET NUMBER to identify packets. 0 = 4th mouse button is not pressed.
Bit5 => 1 = 5th mouse button is pressed, Backward one page.
0 = 5th mouse button is not pressed.
C) MSID 7
FSP uses 2 packets (8 Bytes) to represent Absolute Position.
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) ::
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|---------------| Packet 1 (ABSOLUTE POSITION)
1 |0|1|V|1|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|d|u|X|X|Y|Y| 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|---------------|
1 |0|1|V|1|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|d|u|X|X|Y|Y|
Byte 1: Bit7~Bit6 => 00, Normal data packet |---------------| |---------------| |---------------| |---------------|
=> 01, Absolute coordination packet
=> 10, Notify packet Byte 1: Bit7~Bit6 => 00, Normal data packet
Bit5 => valid bit => 01, Absolute coordination packet
Bit4 => 1 => 10, Notify packet
Bit3 => 1 Bit5 => valid bit
Bit2 => Middle Button, 1 is pressed, 0 is not pressed. Bit4 => 1
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Bit3 => 1
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Byte 2: X coordinate (xpos[9:2]) Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Byte 3: Y coordinate (ypos[9:2]) Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0]) Byte 2: X coordinate (xpos[9:2])
Bit3~Bit2 => X coordinate (ypos[1:0]) Byte 3: Y coordinate (ypos[9:2])
Bit4 => scroll up Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
Bit5 => scroll down Bit3~Bit2 => X coordinate (ypos[1:0])
Bit6 => scroll left Bit4 => scroll up
Bit7 => scroll right Bit5 => scroll down
Bit6 => scroll left
Notify Packet for G0 Bit7 => scroll right
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|---------------| Notify Packet for G0
1 |1|0|0|1|1|M|R|L| 2 |C|C|C|C|C|C|C|C| 3 |M|M|M|M|M|M|M|M| 4 |0|0|0|0|0|0|0|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|---------------|
1 |1|0|0|1|1|M|R|L| 2 |C|C|C|C|C|C|C|C| 3 |M|M|M|M|M|M|M|M| 4 |0|0|0|0|0|0|0|0|
Byte 1: Bit7~Bit6 => 00, Normal data packet |---------------| |---------------| |---------------| |---------------|
=> 01, Absolute coordination packet
=> 10, Notify packet Byte 1: Bit7~Bit6 => 00, Normal data packet
Bit5 => 0 => 01, Absolute coordination packet
Bit4 => 1 => 10, Notify packet
Bit3 => 1 Bit5 => 0
Bit2 => Middle Button, 1 is pressed, 0 is not pressed. Bit4 => 1
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Bit3 => 1
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Byte 2: Message Type => 0x5A (Enable/Disable status packet) Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Mode Type => 0xA5 (Normal/Icon mode status) Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Byte 3: Message Type => 0x00 (Disabled) Byte 2: Message Type => 0x5A (Enable/Disable status packet)
=> 0x01 (Enabled) Mode Type => 0xA5 (Normal/Icon mode status)
Mode Type => 0x00 (Normal) Byte 3: Message Type => 0x00 (Disabled)
=> 0x01 (Icon) => 0x01 (Enabled)
Byte 4: Bit7~Bit0 => Don't Care Mode Type => 0x00 (Normal)
=> 0x01 (Icon)
============================================================================== Byte 4: Bit7~Bit0 => Don't Care
* Absolute position for STL3888-Ax.
============================================================================== Absolute position for STL3888-Ax
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
BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------| ::
1 |0|1|V|A|1|L|0|1| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |x|x|y|y|X|X|Y|Y|
|---------------| |---------------| |---------------| |---------------| 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
Byte 1: Bit7~Bit6 => 00, Normal data packet BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------|
=> 01, Absolute coordination packet 1 |0|1|V|A|1|L|0|1| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |x|x|y|y|X|X|Y|Y|
=> 10, Notify packet |---------------| |---------------| |---------------| |---------------|
=> 11, Normal data packet with on-pad click
Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up. Byte 1: Bit7~Bit6 => 00, Normal data packet
When both fingers are up, the last two reports have zero valid => 01, Absolute coordination packet
bit. => 10, Notify packet
Bit4 => arc => 11, Normal data packet with on-pad click
Bit3 => 1 Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up.
Bit2 => Left Button, 1 is pressed, 0 is released. When both fingers are up, the last two reports have zero valid
Bit1 => 0 bit.
Bit0 => 1 Bit4 => arc
Byte 2: X coordinate (xpos[9:2]) Bit3 => 1
Byte 3: Y coordinate (ypos[9:2]) Bit2 => Left Button, 1 is pressed, 0 is released.
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0]) Bit1 => 0
Bit3~Bit2 => X coordinate (ypos[1:0]) Bit0 => 1
Bit5~Bit4 => y1_g Byte 2: X coordinate (xpos[9:2])
Bit7~Bit6 => x1_g Byte 3: Y coordinate (ypos[9:2])
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
Packet 2 (ABSOLUTE POSITION) Bit3~Bit2 => X coordinate (ypos[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 Bit5~Bit4 => y1_g
BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------| Bit7~Bit6 => x1_g
1 |0|1|V|A|1|R|1|0| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |x|x|y|y|X|X|Y|Y|
|---------------| |---------------| |---------------| |---------------| Packet 2 (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
Byte 1: Bit7~Bit6 => 00, Normal data packet BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------|
=> 01, Absolute coordinates packet 1 |0|1|V|A|1|R|1|0| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |x|x|y|y|X|X|Y|Y|
=> 10, Notify packet |---------------| |---------------| |---------------| |---------------|
=> 11, Normal data packet with on-pad click
Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up. Byte 1: Bit7~Bit6 => 00, Normal data packet
When both fingers are up, the last two reports have zero valid => 01, Absolute coordinates packet
bit. => 10, Notify packet
Bit4 => arc => 11, Normal data packet with on-pad click
Bit3 => 1 Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up.
Bit2 => Right Button, 1 is pressed, 0 is released. When both fingers are up, the last two reports have zero valid
Bit1 => 1 bit.
Bit0 => 0 Bit4 => arc
Byte 2: X coordinate (xpos[9:2]) Bit3 => 1
Byte 3: Y coordinate (ypos[9:2]) Bit2 => Right Button, 1 is pressed, 0 is released.
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0]) Bit1 => 1
Bit3~Bit2 => X coordinate (ypos[1:0]) Bit0 => 0
Bit5~Bit4 => y2_g Byte 2: X coordinate (xpos[9:2])
Bit7~Bit6 => x2_g Byte 3: Y coordinate (ypos[9:2])
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
Notify Packet for STL3888-Ax Bit3~Bit2 => X coordinate (ypos[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 Bit5~Bit4 => y2_g
BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------| Bit7~Bit6 => x2_g
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|d|u|0|0|0|0|
|---------------| |---------------| |---------------| |---------------| Notify Packet for STL3888-Ax
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 1: Bit7~Bit6 => 00, Normal data packet BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------|
=> 01, Absolute coordinates packet 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|d|u|0|0|0|0|
=> 10, Notify packet |---------------| |---------------| |---------------| |---------------|
=> 11, Normal data packet with on-pad click
Bit5 => 1 Byte 1: Bit7~Bit6 => 00, Normal data packet
Bit4 => when in absolute coordinates mode (valid when EN_PKT_GO is 1): => 01, Absolute coordinates packet
0: left button is generated by the on-pad command => 10, Notify packet
1: left button is generated by the external button => 11, Normal data packet with on-pad click
Bit3 => 1 Bit5 => 1
Bit2 => Middle Button, 1 is pressed, 0 is not pressed. Bit4 => when in absolute coordinates mode (valid when EN_PKT_GO is 1):
Bit1 => Right Button, 1 is pressed, 0 is not pressed. 0: left button is generated by the on-pad command
Bit0 => Left Button, 1 is pressed, 0 is not pressed. 1: left button is generated by the external button
Byte 2: Message Type => 0xB7 (Multi Finger, Multi Coordinate mode) Bit3 => 1
Byte 3: Bit7~Bit6 => Don't care Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Bit5~Bit4 => Number of fingers Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Bit3~Bit1 => Reserved Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Bit0 => 1: enter gesture mode; 0: leaving gesture mode Byte 2: Message Type => 0xB7 (Multi Finger, Multi Coordinate mode)
Byte 4: Bit7 => scroll right button Byte 3: Bit7~Bit6 => Don't care
Bit6 => scroll left button Bit5~Bit4 => Number of fingers
Bit5 => scroll down button Bit3~Bit1 => Reserved
Bit4 => scroll up button Bit0 => 1: enter gesture mode; 0: leaving gesture mode
* Note that if gesture and additional button (Bit4~Bit7) Byte 4: Bit7 => scroll right button
happen at the same time, the button information will not Bit6 => scroll left button
be sent. Bit5 => scroll down button
Bit3~Bit0 => Reserved Bit4 => scroll up button
* Note that if gesture and additional button (Bit4~Bit7)
happen at the same time, the button information will not
be sent.
Bit3~Bit0 => Reserved
Sample sequence of Multi-finger, Multi-coordinate mode: 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) ::
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|---------------| Packet 1(ABSOLUTE POSITION)
1 |0|1|V|F|1|0|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|u|d|X|X|Y|Y| 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|---------------|
1 |0|1|V|F|1|0|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|u|d|X|X|Y|Y|
Byte 1: Bit7~Bit6 => 00, Normal data packet |---------------| |---------------| |---------------| |---------------|
=> 01, Absolute coordinates packet
=> 10, Notify packet Byte 1: Bit7~Bit6 => 00, Normal data packet
=> 11, Normal data packet with on-pad click => 01, Absolute coordinates packet
Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up. => 10, Notify packet
When both fingers are up, the last two reports have zero valid => 11, Normal data packet with on-pad click
bit. Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up.
Bit4 => finger up/down information. 1: finger down, 0: finger up. When both fingers are up, the last two reports have zero valid
Bit3 => 1 bit.
Bit2 => finger index, 0 is the first finger, 1 is the second finger. Bit4 => finger up/down information. 1: finger down, 0: finger up.
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Bit3 => 1
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit2 => finger index, 0 is the first finger, 1 is the second finger.
Byte 2: X coordinate (xpos[9:2]) Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Byte 3: Y coordinate (ypos[9:2]) Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0]) Byte 2: X coordinate (xpos[9:2])
Bit3~Bit2 => X coordinate (ypos[1:0]) Byte 3: Y coordinate (ypos[9:2])
Bit4 => scroll down button Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
Bit5 => scroll up button Bit3~Bit2 => X coordinate (ypos[1:0])
Bit6 => scroll left button Bit4 => scroll down button
Bit7 => scroll right button Bit5 => scroll up button
Bit6 => scroll left button
Packet 2 (ABSOLUTE POSITION) Bit7 => scroll right button
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|---------------| Packet 2 (ABSOLUTE POSITION)
1 |0|1|V|F|1|1|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|u|d|X|X|Y|Y| 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|---------------|
1 |0|1|V|F|1|1|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|u|d|X|X|Y|Y|
Byte 1: Bit7~Bit6 => 00, Normal data packet |---------------| |---------------| |---------------| |---------------|
=> 01, Absolute coordination packet
=> 10, Notify packet Byte 1: Bit7~Bit6 => 00, Normal data packet
=> 11, Normal data packet with on-pad click => 01, Absolute coordination packet
Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up. => 10, Notify packet
When both fingers are up, the last two reports have zero valid => 11, Normal data packet with on-pad click
bit. Bit5 => Valid bit, 0 means that the coordinate is invalid or finger up.
Bit4 => finger up/down information. 1: finger down, 0: finger up. When both fingers are up, the last two reports have zero valid
Bit3 => 1 bit.
Bit2 => finger index, 0 is the first finger, 1 is the second finger. Bit4 => finger up/down information. 1: finger down, 0: finger up.
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Bit3 => 1
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit2 => finger index, 0 is the first finger, 1 is the second finger.
Byte 2: X coordinate (xpos[9:2]) Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Byte 3: Y coordinate (ypos[9:2]) Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0]) Byte 2: X coordinate (xpos[9:2])
Bit3~Bit2 => X coordinate (ypos[1:0]) Byte 3: Y coordinate (ypos[9:2])
Bit4 => scroll down button Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
Bit5 => scroll up button Bit3~Bit2 => X coordinate (ypos[1:0])
Bit6 => scroll left button Bit4 => scroll down button
Bit7 => scroll right button Bit5 => scroll up button
Bit6 => scroll left button
Notify Packet for STL3888-B0 Bit7 => scroll right button
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|---------------| Notify Packet for STL3888-B0::
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|
|---------------| |---------------| |---------------| |---------------| 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 1: Bit7~Bit6 => 00, Normal data packet 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|
=> 01, Absolute coordination packet |---------------| |---------------| |---------------| |---------------|
=> 10, Notify packet
=> 11, Normal data packet with on-pad click Byte 1: Bit7~Bit6 => 00, Normal data packet
Bit5 => 1 => 01, Absolute coordination packet
Bit4 => when in absolute coordinates mode (valid when EN_PKT_GO is 1): => 10, Notify packet
0: left button is generated by the on-pad command => 11, Normal data packet with on-pad click
1: left button is generated by the external button Bit5 => 1
Bit3 => 1 Bit4 => when in absolute coordinates mode (valid when EN_PKT_GO is 1):
Bit2 => Middle Button, 1 is pressed, 0 is not pressed. 0: left button is generated by the on-pad command
Bit1 => Right Button, 1 is pressed, 0 is not pressed. 1: left button is generated by the external button
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit3 => 1
Byte 2: Message Type => 0xB7 (Multi Finger, Multi Coordinate mode) Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Byte 3: Bit7~Bit6 => Don't care Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Bit5~Bit4 => Number of fingers Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Bit3~Bit1 => Reserved Byte 2: Message Type => 0xB7 (Multi Finger, Multi Coordinate mode)
Bit0 => 1: enter gesture mode; 0: leaving gesture mode Byte 3: Bit7~Bit6 => Don't care
Byte 4: Bit7 => scroll right button Bit5~Bit4 => Number of fingers
Bit6 => scroll left button Bit3~Bit1 => Reserved
Bit5 => scroll up button Bit0 => 1: enter gesture mode; 0: leaving gesture mode
Bit4 => scroll down button Byte 4: Bit7 => scroll right button
* Note that if gesture and additional button(Bit4~Bit7) Bit6 => scroll left button
happen at the same time, the button information will not Bit5 => scroll up button
be sent. Bit4 => scroll down button
Bit3~Bit0 => Reserved * Note that if gesture and additional button(Bit4~Bit7)
happen at the same time, the button information will not
be sent.
Bit3~Bit0 => Reserved
Sample sequence of Multi-finger, Multi-coordinate mode: 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) ::
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|---------------| Single Finger, Absolute Coordinate Mode (SFAC)
1 |0|1|0|P|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|B|F|X|X|Y|Y| 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|---------------|
1 |0|1|0|P|1|M|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|B|F|X|X|Y|Y|
Byte 1: Bit7~Bit6 => 00, Normal data packet |---------------| |---------------| |---------------| |---------------|
=> 01, Absolute coordinates packet
=> 10, Notify packet Byte 1: Bit7~Bit6 => 00, Normal data packet
Bit5 => Coordinate mode(always 0 in SFAC mode): => 01, Absolute coordinates packet
0: single-finger absolute coordinates (SFAC) mode => 10, Notify packet
1: multi-finger, multiple coordinates (MFMC) mode Bit5 => Coordinate mode(always 0 in SFAC mode):
Bit4 => 0: The LEFT button is generated by on-pad command (OPC) 0: single-finger absolute coordinates (SFAC) mode
1: The LEFT button is generated by external button 1: multi-finger, multiple coordinates (MFMC) mode
Default is 1 even if the LEFT button is not pressed. Bit4 => 0: The LEFT button is generated by on-pad command (OPC)
Bit3 => Always 1, as specified by PS/2 protocol. 1: The LEFT button is generated by external button
Bit2 => Middle Button, 1 is pressed, 0 is not pressed. Default is 1 even if the LEFT button is not pressed.
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Bit3 => Always 1, as specified by PS/2 protocol.
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Byte 2: X coordinate (xpos[9:2]) Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Byte 3: Y coordinate (ypos[9:2]) Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0]) Byte 2: X coordinate (xpos[9:2])
Bit3~Bit2 => X coordinate (ypos[1:0]) Byte 3: Y coordinate (ypos[9:2])
Bit4 => 4th mouse button(forward one page) Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
Bit5 => 5th mouse button(backward one page) Bit3~Bit2 => X coordinate (ypos[1:0])
Bit6 => scroll left button Bit4 => 4th mouse button(forward one page)
Bit7 => scroll right button Bit5 => 5th mouse button(backward one page)
Bit6 => scroll left button
Multi Finger, Multiple Coordinates Mode (MFMC): Bit7 => scroll right button
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|---------------| Multi Finger, Multiple Coordinates Mode (MFMC):
1 |0|1|1|P|1|F|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|B|F|X|X|Y|Y| 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|---------------|
1 |0|1|1|P|1|F|R|L| 2 |X|X|X|X|X|X|X|X| 3 |Y|Y|Y|Y|Y|Y|Y|Y| 4 |r|l|B|F|X|X|Y|Y|
Byte 1: Bit7~Bit6 => 00, Normal data packet |---------------| |---------------| |---------------| |---------------|
=> 01, Absolute coordination packet
=> 10, Notify packet Byte 1: Bit7~Bit6 => 00, Normal data packet
Bit5 => Coordinate mode (always 1 in MFMC mode): => 01, Absolute coordination packet
0: single-finger absolute coordinates (SFAC) mode => 10, Notify packet
1: multi-finger, multiple coordinates (MFMC) mode Bit5 => Coordinate mode (always 1 in MFMC mode):
Bit4 => 0: The LEFT button is generated by on-pad command (OPC) 0: single-finger absolute coordinates (SFAC) mode
1: The LEFT button is generated by external button 1: multi-finger, multiple coordinates (MFMC) mode
Default is 1 even if the LEFT button is not pressed. Bit4 => 0: The LEFT button is generated by on-pad command (OPC)
Bit3 => Always 1, as specified by PS/2 protocol. 1: The LEFT button is generated by external button
Bit2 => Finger index, 0 is the first finger, 1 is the second finger. Default is 1 even if the LEFT button is not pressed.
If bit 1 and 0 are all 1 and bit 4 is 0, the middle external Bit3 => Always 1, as specified by PS/2 protocol.
button is pressed. Bit2 => Finger index, 0 is the first finger, 1 is the second finger.
Bit1 => Right Button, 1 is pressed, 0 is not pressed. If bit 1 and 0 are all 1 and bit 4 is 0, the middle external
Bit0 => Left Button, 1 is pressed, 0 is not pressed. button is pressed.
Byte 2: X coordinate (xpos[9:2]) Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Byte 3: Y coordinate (ypos[9:2]) Bit0 => Left Button, 1 is pressed, 0 is not pressed.
Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0]) Byte 2: X coordinate (xpos[9:2])
Bit3~Bit2 => X coordinate (ypos[1:0]) Byte 3: Y coordinate (ypos[9:2])
Bit4 => 4th mouse button(forward one page) Byte 4: Bit1~Bit0 => Y coordinate (xpos[1:0])
Bit5 => 5th mouse button(backward one page) Bit3~Bit2 => X coordinate (ypos[1:0])
Bit6 => scroll left button Bit4 => 4th mouse button(forward one page)
Bit7 => scroll right button Bit5 => 5th mouse button(backward one page)
Bit6 => scroll left button
When one of the two fingers is up, the device will output four consecutive Bit7 => scroll right button
When one of the two fingers is up, the device will output four consecutive
MFMC#0 report packets with zero X and Y to represent 1st finger is up or MFMC#0 report packets with zero X and Y to represent 1st finger is up or
four consecutive MFMC#1 report packets with zero X and Y to represent that four consecutive MFMC#1 report packets with zero X and Y to represent that
the 2nd finger is up. On the other hand, if both fingers are up, the device 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
BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------| 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
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| 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|
|---------------| |---------------| |---------------| |---------------|
Byte 1: Bit7~Bit6 => 00, Normal data packet
=> 01, Absolute coordinates packet Byte 1: Bit7~Bit6 => 00, Normal data packet
=> 10, Notify packet => 01, Absolute coordinates packet
Bit5 => Always 0 => 10, Notify packet
Bit4 => 0: The LEFT button is generated by on-pad command(OPC) Bit5 => Always 0
1: The LEFT button is generated by external button Bit4 => 0: The LEFT button is generated by on-pad command(OPC)
Default is 1 even if the LEFT button is not pressed. 1: The LEFT button is generated by external button
Bit3 => 1 Default is 1 even if the LEFT button is not pressed.
Bit2 => Middle Button, 1 is pressed, 0 is not pressed. Bit3 => 1
Bit1 => Right Button, 1 is pressed, 0 is not pressed. Bit2 => Middle Button, 1 is pressed, 0 is not pressed.
Bit0 => Left Button, 1 is pressed, 0 is not pressed. Bit1 => Right Button, 1 is pressed, 0 is not pressed.
Byte 2: Message type: Bit0 => Left Button, 1 is pressed, 0 is not pressed.
0xba => gesture information Byte 2: Message type:
0xc0 => one finger hold-rotating gesture 0xba => gesture information
Byte 3: The first parameter for the received message: 0xc0 => one finger hold-rotating gesture
0xba => gesture ID (refer to the 'Gesture ID' section) Byte 3: The first parameter for the received message:
0xc0 => region ID 0xba => gesture ID (refer to the 'Gesture ID' section)
Byte 4: The second parameter for the received message: 0xc0 => region ID
0xba => N/A Byte 4: The second parameter for the received message:
0xc0 => finger up/down information 0xba => N/A
0xc0 => finger up/down information
Sample sequence of Multi-finger, Multi-coordinates mode: Sample sequence of Multi-finger, Multi-coordinates mode:
...@@ -416,50 +442,51 @@ Sample sequence of Multi-finger, Multi-coordinates mode: ...@@ -416,50 +442,51 @@ 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 ::
BYTE |---------------|BYTE |---------------|BYTE|---------------|BYTE|---------------|
1 |Y|X|0|0|1|M|R|L| 2 |0|1|0|1|1|0|1|E| 3 | | | | | | | | | 4 | | | | | | | | | 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|---------------|
1 |Y|X|0|0|1|M|R|L| 2 |0|1|0|1|1|0|1|E| 3 | | | | | | | | | 4 | | | | | | | | |
FSP will send out enable/disable packet when FSP receive PS/2 enable/disable |---------------| |---------------| |---------------| |---------------|
command. Host will receive the packet which Middle, Right, Left button will
be set. The packet only use byte 0 and byte 1 as a pattern of original packet. FSP will send out enable/disable packet when FSP receive PS/2 enable/disable
Ignore the other bytes of the packet. command. Host will receive the packet which Middle, Right, Left button will
be set. The packet only use byte 0 and byte 1 as a pattern of original packet.
Byte 1: Bit7 => 0, Y overflow Ignore the other bytes of the packet.
Bit6 => 0, X overflow
Bit5 => 0, Y sign bit Byte 1: Bit7 => 0, Y overflow
Bit4 => 0, X sign bit Bit6 => 0, X overflow
Bit3 => 1 Bit5 => 0, Y sign bit
Bit2 => 1, Middle Button Bit4 => 0, X sign bit
Bit1 => 1, Right Button Bit3 => 1
Bit0 => 1, Left Button Bit2 => 1, Middle Button
Byte 2: Bit7~1 => (0101101b) Bit1 => 1, Right Button
Bit0 => 1 = Enable Bit0 => 1, Left Button
0 = Disable Byte 2: Bit7~1 => (0101101b)
Byte 3: Don't care Bit0 => 1 = Enable
Byte 4: Don't care (MOUSE ID 3, 4) 0 = Disable
Byte 5~8: Don't care (Absolute packet) Byte 3: Don't care
Byte 4: Don't care (MOUSE ID 3, 4)
============================================================================== 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/ ...@@ -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: ...@@ -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: ...@@ -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,43 +599,42 @@ Register writing sequence: ...@@ -573,43 +599,42 @@ 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
'pages.' Each page is able to include up to 255 registers. 'pages.' Each page is able to include up to 255 registers.
The default page after power up is 0x82; therefore, if one has to get The default page after power up is 0x82; therefore, if one has to get
access to register 0x8301, one has to use following sequence to switch access to register 0x8301, one has to use following sequence to switch
to page 0x83, then start reading/writing from/to offset 0x01 by using to page 0x83, then start reading/writing from/to offset 0x01 by using
the register read/write sequence described in previous section. the register read/write sequence described in previous section.
...@@ -632,6 +657,7 @@ Page register reading sequence: ...@@ -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: ...@@ -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: ...@@ -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,38 +714,38 @@ supported gesture IDs: ...@@ -687,38 +714,38 @@ 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
0x8201 bit7~bit0 RW version ID 0x8201 bit7~bit0 RW version ID
0xc1: STL3888 Ax 0xc1: STL3888 Ax
0xd0 ~ 0xd2: STL3888 Bx 0xd0 ~ 0xd2: STL3888 Bx
0xe0 ~ 0xe1: STL3888 Cx 0xe0 ~ 0xe1: STL3888 Cx
0xe2 ~ 0xe3: STL3888 Dx 0xe2 ~ 0xe3: STL3888 Dx
0x8202 bit7~bit0 0x01 RO vendor ID 0x8202 bit7~bit0 0x01 RO vendor ID
0x8203 bit7~bit0 0x01 RO product ID 0x8203 bit7~bit0 0x01 RO product ID
0x8204 bit3~bit0 0x01 RW revision ID 0x8204 bit3~bit0 0x01 RW revision ID
0x820b test mode status 1 0x820b test mode status 1
bit3 1 RO 0: rotate 180 degree bit3 1 RO 0: rotate 180 degree
1: no rotation 1: no rotation
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x820f register file page control 0x820f register file page control
bit2 0 RW 1: rotate 180 degree bit2 0 RW 1: rotate 180 degree
0: no rotation 0: no rotation
*supported since Cx *supported since Cx
...@@ -726,7 +753,7 @@ offset width default r/w name ...@@ -726,7 +753,7 @@ offset width default r/w name
bit0 0 RW 1 to enable page 1 register files bit0 0 RW 1 to enable page 1 register files
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8210 RW system control 1 0x8210 RW system control 1
bit0 1 RW Reserved, must be 1 bit0 1 RW Reserved, must be 1
bit1 0 RW Reserved, must be 0 bit1 0 RW Reserved, must be 0
bit4 0 RW Reserved, must be 0 bit4 0 RW Reserved, must be 0
...@@ -737,7 +764,7 @@ offset width default r/w name ...@@ -737,7 +764,7 @@ offset width default r/w name
40 41 42 43. In addition to that, this bit must be 1 when gesture 40 41 42 43. In addition to that, this bit must be 1 when gesture
mode is enabled) mode is enabled)
0x8220 test mode status 0x8220 test mode status
bit5~bit4 RO number of buttons bit5~bit4 RO number of buttons
11 => 2, lbtn/rbtn 11 => 2, lbtn/rbtn
10 => 4, lbtn/rbtn/scru/scrd 10 => 4, lbtn/rbtn/scru/scrd
...@@ -745,13 +772,13 @@ offset width default r/w name ...@@ -745,13 +772,13 @@ offset width default r/w name
00 => 6, lbtn/rbtn/scru/scrd/fbtn/bbtn 00 => 6, lbtn/rbtn/scru/scrd/fbtn/bbtn
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8231 RW on-pad command detection 0x8231 RW on-pad command detection
bit7 0 RW on-pad command left button down tag bit7 0 RW on-pad command left button down tag
enable enable
0: disable, 1: enable 0: disable, 1: enable
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8234 RW on-pad command control 5 0x8234 RW on-pad command control 5
bit4~bit0 0x05 RW XLO in 0s/4/1, so 03h = 0010.1b = 2.5 bit4~bit0 0x05 RW XLO in 0s/4/1, so 03h = 0010.1b = 2.5
(Note that position unit is in 0.5 scanline) (Note that position unit is in 0.5 scanline)
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
...@@ -760,22 +787,22 @@ offset width default r/w name ...@@ -760,22 +787,22 @@ offset width default r/w name
0: disable, 1: enable 0: disable, 1: enable
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8235 RW on-pad command control 6 0x8235 RW on-pad command control 6
bit4~bit0 0x1d RW XHI in 0s/4/1, so 19h = 1100.1b = 12.5 bit4~bit0 0x1d RW XHI in 0s/4/1, so 19h = 1100.1b = 12.5
(Note that position unit is in 0.5 scanline) (Note that position unit is in 0.5 scanline)
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8236 RW on-pad command control 7 0x8236 RW on-pad command control 7
bit4~bit0 0x04 RW YLO in 0s/4/1, so 03h = 0010.1b = 2.5 bit4~bit0 0x04 RW YLO in 0s/4/1, so 03h = 0010.1b = 2.5
(Note that position unit is in 0.5 scanline) (Note that position unit is in 0.5 scanline)
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8237 RW on-pad command control 8 0x8237 RW on-pad command control 8
bit4~bit0 0x13 RW YHI in 0s/4/1, so 11h = 1000.1b = 8.5 bit4~bit0 0x13 RW YHI in 0s/4/1, so 11h = 1000.1b = 8.5
(Note that position unit is in 0.5 scanline) (Note that position unit is in 0.5 scanline)
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8240 RW system control 5 0x8240 RW system control 5
bit1 0 RW FSP Intellimouse mode enable bit1 0 RW FSP Intellimouse mode enable
0: disable, 1: enable 0: disable, 1: enable
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
...@@ -813,7 +840,7 @@ offset width default r/w name ...@@ -813,7 +840,7 @@ offset width default r/w name
0: disable, 1: enable 0: disable, 1: enable
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8243 RW on-pad control 0x8243 RW on-pad control
bit0 0 RW on-pad control enable bit0 0 RW on-pad control enable
0: disable, 1: enable 0: disable, 1: enable
(Note that if this bit is cleared, bit 3/5 will be ineffective) (Note that if this bit is cleared, bit 3/5 will be ineffective)
...@@ -827,7 +854,7 @@ offset width default r/w name ...@@ -827,7 +854,7 @@ offset width default r/w name
0: disable, 1: enable 0: disable, 1: enable
*only supported by H/W prior to Cx *only supported by H/W prior to Cx
0x8290 RW software control register 1 0x8290 RW software control register 1
bit0 0 RW absolute coordination mode bit0 0 RW absolute coordination mode
0: disable, 1: enable 0: disable, 1: enable
*supported since Cx *supported since Cx
...@@ -856,16 +883,17 @@ offset width default r/w name ...@@ -856,16 +883,17 @@ 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
0x833d RW on-pad command control 1 0x833d RW on-pad command control 1
bit7 1 RW on-pad command detection enable bit7 1 RW on-pad command detection enable
0: disable, 1: enable 0: disable, 1: enable
*supported since Cx *supported since Cx
0x833e RW on-pad command detection 0x833e RW on-pad command detection
bit7 0 RW on-pad command left button down tag bit7 0 RW on-pad command left button down tag
enable. Works only in H/W based PS/2 enable. Works only in H/W based PS/2
data packet mode. data packet mode.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7