ٵsphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget&/translations/zh_CN/input/devices/alpsmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/zh_TW/input/devices/alpsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/it_IT/input/devices/alpsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/ja_JP/input/devices/alpsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/ko_KR/input/devices/alpsmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/sp_SP/input/devices/alpsmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(hALPS Touchpad Protocolh]hALPS Touchpad Protocol}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhh@/var/lib/git/docbuild/linux/Documentation/input/devices/alps.rsthKubh)}(hhh](h)}(h Introductionh]h Introduction}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hCurrently the ALPS touchpad driver supports seven protocol versions in use by ALPS touchpads, called versions 1, 2, 3, 4, 5, 6, 7 and 8.h]hCurrently the ALPS touchpad driver supports seven protocol versions in use by ALPS touchpads, called versions 1, 2, 3, 4, 5, 6, 7 and 8.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXSince roughly mid-2010 several new ALPS touchpads have been released and integrated into a variety of laptops and netbooks. These new touchpads have enough behavior differences that the alps_model_data definition table, describing the properties of the different versions, is no longer adequate. The design choices were to re-define the alps_model_data table, with the risk of regression testing existing devices, or isolate the new devices outside of the alps_model_data table. The latter design choice was made. The new touchpad signatures are named: "Rushmore", "Pinnacle", and "Dolphin", which you will see in the alps.c code. For the purposes of this document, this group of ALPS touchpads will generically be called "new ALPS touchpads".h]hXSince roughly mid-2010 several new ALPS touchpads have been released and integrated into a variety of laptops and netbooks. These new touchpads have enough behavior differences that the alps_model_data definition table, describing the properties of the different versions, is no longer adequate. The design choices were to re-define the alps_model_data table, with the risk of regression testing existing devices, or isolate the new devices outside of the alps_model_data table. The latter design choice was made. The new touchpad signatures are named: “Rushmore”, “Pinnacle”, and “Dolphin”, which you will see in the alps.c code. For the purposes of this document, this group of ALPS touchpads will generically be called “new ALPS touchpads”.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hX"We experimented with probing the ACPI interface _HID (Hardware ID)/_CID (Compatibility ID) definition as a way to uniquely identify the different ALPS variants but there did not appear to be a 1:1 mapping. In fact, it appeared to be an m:n mapping between the _HID and actual hardware type.h]hX"We experimented with probing the ACPI interface _HID (Hardware ID)/_CID (Compatibility ID) definition as a way to uniquely identify the different ALPS variants but there did not appear to be a 1:1 mapping. In fact, it appeared to be an m:n mapping between the _HID and actual hardware type.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubeh}(h] introductionah ]h"] introductionah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Detectionh]h Detection}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hAll ALPS touchpads should respond to the "E6 report" command sequence: E8-E6-E6-E6-E9. An ALPS touchpad should respond with either 00-00-0A or 00-00-64 if no buttons are pressed. The bits 0-2 of the first byte will be 1s if some buttons are pressed.h]hAll ALPS touchpads should respond to the “E6 report” command sequence: E8-E6-E6-E6-E9. An ALPS touchpad should respond with either 00-00-0A or 00-00-64 if no buttons are pressed. The bits 0-2 of the first byte will be 1s if some buttons are pressed.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hIf the E6 report is successful, the touchpad model is identified using the "E7 report" sequence: E8-E7-E7-E7-E9. The response is the model signature and is matched against known models in the alps_model_data_array.h]hIf the E6 report is successful, the touchpad model is identified using the “E7 report” sequence: E8-E7-E7-E7-E9. The response is the model signature and is matched against known models in the alps_model_data_array.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK$hhhhubh)}(hFor older touchpads supporting protocol versions 3 and 4, the E7 report model signature is always 73-02-64. To differentiate between these versions, the response from the "Enter Command Mode" sequence must be inspected as described below.h]hFor older touchpads supporting protocol versions 3 and 4, the E7 report model signature is always 73-02-64. To differentiate between these versions, the response from the “Enter Command Mode” sequence must be inspected as described below.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK(hhhhubh)}(hThe new ALPS touchpads have an E7 signature of 73-03-50 or 73-03-0A but seem to be better differentiated by the EC Command Mode response.h]hThe new ALPS touchpads have an E7 signature of 73-03-50 or 73-03-0A but seem to be better differentiated by the EC Command Mode response.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK-hhhhubeh}(h] detectionah ]h"] detectionah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Command Modeh]h Command Mode}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjMhhhhhK1ubh)}(hXeProtocol versions 3 and 4 have a command mode that is used to read and write one-byte device registers in a 16-bit address space. The command sequence EC-EC-EC-E9 places the device in command mode, and the device will respond with 88-07 followed by a third byte. This third byte can be used to determine whether the devices uses the version 3 or 4 protocol.h]hXeProtocol versions 3 and 4 have a command mode that is used to read and write one-byte device registers in a 16-bit address space. The command sequence EC-EC-EC-E9 places the device in command mode, and the device will respond with 88-07 followed by a third byte. This third byte can be used to determine whether the devices uses the version 3 or 4 protocol.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK3hjMhhubh)}(hITo exit command mode, PSMOUSE_CMD_SETSTREAM (EA) is sent to the touchpad.h]hITo exit command mode, PSMOUSE_CMD_SETSTREAM (EA) is sent to the touchpad.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK9hjMhhubh)}(hX5While in command mode, register addresses can be set by first sending a specific command, either EC for v3 devices or F5 for v4 devices. Then the address is sent one nibble at a time, where each nibble is encoded as a command with optional data. This encoding differs slightly between the v3 and v4 protocols.h]hX5While in command mode, register addresses can be set by first sending a specific command, either EC for v3 devices or F5 for v4 devices. Then the address is sent one nibble at a time, where each nibble is encoded as a command with optional data. This encoding differs slightly between the v3 and v4 protocols.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK;hjMhhubh)}(hXXOnce an address has been set, the addressed register can be read by sending PSMOUSE_CMD_GETINFO (E9). The first two bytes of the response contains the address of the register being read, and the third contains the value of the register. Registers are written by writing the value one nibble at a time using the same encoding used for addresses.h]hXXOnce an address has been set, the addressed register can be read by sending PSMOUSE_CMD_GETINFO (E9). The first two bytes of the response contains the address of the register being read, and the third contains the value of the register. Registers are written by writing the value one nibble at a time using the same encoding used for addresses.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhjMhhubh)}(hXFor the new ALPS touchpads, the EC command is used to enter command mode. The response in the new ALPS touchpads is significantly different, and more important in determining the behavior. This code has been separated from the original alps_model_data table and put in the alps_identify function. For example, there seem to be two hardware init sequences for the "Dolphin" touchpads as determined by the second byte of the EC response.h]hXFor the new ALPS touchpads, the EC command is used to enter command mode. The response in the new ALPS touchpads is significantly different, and more important in determining the behavior. This code has been separated from the original alps_model_data table and put in the alps_identify function. For example, there seem to be two hardware init sequences for the “Dolphin” touchpads as determined by the second byte of the EC response.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKGhjMhhubeh}(h] command-modeah ]h"] command modeah$]h&]uh1hhhhhhhhK1ubh)}(hhh](h)}(h Packet Formath]h Packet Format}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKPubh)}(h9In the following tables, the following notation is used::h]h8In the following tables, the following notation is used:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKRhjhhubh literal_block)}(h'CAPITALS = stick, miniscules = touchpadh]h'CAPITALS = stick, miniscules = touchpad}hjsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jhhhKThjhhubh)}(h~?'s can have different meanings on different models, such as wheel rotation, extra buttons, stick buttons on a dualpoint, etc.h]h?’s can have different meanings on different models, such as wheel rotation, extra buttons, stick buttons on a dualpoint, etc.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKVhjhhubeh}(h] packet-formatah ]h"] packet formatah$]h&]uh1hhhhhhhhKPubh)}(hhh](h)}(hPS/2 packet formath]hPS/2 packet format}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKZubj)}(hbyte 0: 0 0 YSGN XSGN 1 M R L byte 1: X7 X6 X5 X4 X3 X2 X1 X0 byte 2: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0h]hbyte 0: 0 0 YSGN XSGN 1 M R L byte 1: X7 X6 X5 X4 X3 X2 X1 X0 byte 2: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhK^hjhhubh)}(h6Note that the device never signals overflow condition.h]h6Note that the device never signals overflow condition.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKbhjhhubh)}(hFor protocol version 2 devices when the trackpoint is used, and no fingers are on the touchpad, the M R L bits signal the combined status of both the pointingstick and touchpad buttons.h]hFor protocol version 2 devices when the trackpoint is used, and no fingers are on the touchpad, the M R L bits signal the combined status of both the pointingstick and touchpad buttons.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKdhjhhubeh}(h]ps-2-packet-formatah ]h"]ps/2 packet formatah$]h&]uh1hhhhhhhhKZubh)}(hhh](h)}(h'ALPS Absolute Mode - Protocol Version 1h]h'ALPS Absolute Mode - Protocol Version 1}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hhhhhKiubj)}(hXbyte 0: 1 0 0 0 1 x9 x8 x7 byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 ? ? l r ? fin ges byte 3: 0 ? ? ? ? y9 y8 y7 byte 4: 0 y6 y5 y4 y3 y2 y1 y0 byte 5: 0 z6 z5 z4 z3 z2 z1 z0h]hXbyte 0: 1 0 0 0 1 x9 x8 x7 byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 ? ? l r ? fin ges byte 3: 0 ? ? ? ? y9 y8 y7 byte 4: 0 y6 y5 y4 y3 y2 y1 y0 byte 5: 0 z6 z5 z4 z3 z2 z1 z0}hjGsbah}(h]h ]h"]h$]h&]jjuh1jhhhKmhj6hhubeh}(h]%alps-absolute-mode-protocol-version-1ah ]h"]'alps absolute mode - protocol version 1ah$]h&]uh1hhhhhhhhKiubh)}(hhh](h)}(h'ALPS Absolute Mode - Protocol Version 2h]h'ALPS Absolute Mode - Protocol Version 2}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]hhhhhKuubj)}(hXbyte 0: 1 ? ? ? 1 PSM PSR PSL byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 x10 x9 x8 x7 ? fin ges byte 3: 0 y9 y8 y7 1 M R L byte 4: 0 y6 y5 y4 y3 y2 y1 y0 byte 5: 0 z6 z5 z4 z3 z2 z1 z0h]hXbyte 0: 1 ? ? ? 1 PSM PSR PSL byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 x10 x9 x8 x7 ? fin ges byte 3: 0 y9 y8 y7 1 M R L byte 4: 0 y6 y5 y4 y3 y2 y1 y0 byte 5: 0 z6 z5 z4 z3 z2 z1 z0}hjnsbah}(h]h ]h"]h$]h&]jjuh1jhhhKyhj]hhubh)}(hX5Protocol Version 2 DualPoint devices send standard PS/2 mouse packets for the DualPoint Stick. The M, R and L bits signal the combined status of both the pointingstick and touchpad buttons, except for Dell dualpoint devices where the pointingstick buttons get reported separately in the PSM, PSR and PSL bits.h]hX5Protocol Version 2 DualPoint devices send standard PS/2 mouse packets for the DualPoint Stick. The M, R and L bits signal the combined status of both the pointingstick and touchpad buttons, except for Dell dualpoint devices where the pointingstick buttons get reported separately in the PSM, PSR and PSL bits.}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj]hhubeh}(h]%alps-absolute-mode-protocol-version-2ah ]h"]'alps absolute mode - protocol version 2ah$]h&]uh1hhhhhhhhKuubh)}(hhh](h)}(h-Dualpoint device -- interleaved packet formath]h-Dualpoint device -- interleaved packet format}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubj)}(hXbyte 0: 1 1 0 0 1 1 1 1 byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 x10 x9 x8 x7 0 fin ges byte 3: 0 0 YSGN XSGN 1 1 1 1 byte 4: X7 X6 X5 X4 X3 X2 X1 X0 byte 5: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 byte 6: 0 y9 y8 y7 1 m r l byte 7: 0 y6 y5 y4 y3 y2 y1 y0 byte 8: 0 z6 z5 z4 z3 z2 z1 z0h]hXbyte 0: 1 1 0 0 1 1 1 1 byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 x10 x9 x8 x7 0 fin ges byte 3: 0 0 YSGN XSGN 1 1 1 1 byte 4: X7 X6 X5 X4 X3 X2 X1 X0 byte 5: Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 byte 6: 0 y9 y8 y7 1 m r l byte 7: 0 y6 y5 y4 y3 y2 y1 y0 byte 8: 0 z6 z5 z4 z3 z2 z1 z0}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hXDevices which use the interleaving format normally send standard PS/2 mouse packets for the DualPoint Stick + ALPS Absolute Mode packets for the touchpad, switching to the interleaved packet format when both the stick and the touchpad are used at the same time.h]hXDevices which use the interleaving format normally send standard PS/2 mouse packets for the DualPoint Stick + ALPS Absolute Mode packets for the touchpad, switching to the interleaved packet format when both the stick and the touchpad are used at the same time.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]*dualpoint-device-interleaved-packet-formatah ]h"]-dualpoint device -- interleaved packet formatah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h'ALPS Absolute Mode - Protocol Version 3h]h'ALPS Absolute Mode - Protocol Version 3}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hALPS protocol version 3 has three different packet formats. The first two are associated with touchpad events, and the third is associated with trackstick events.h]hALPS protocol version 3 has three different packet formats. The first two are associated with touchpad events, and the third is associated with trackstick events.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h0The first type is the touchpad position packet::h]h/The first type is the touchpad position packet:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hXbyte 0: 1 ? x1 x0 1 1 1 1 byte 1: 0 x10 x9 x8 x7 x6 x5 x4 byte 2: 0 y10 y9 y8 y7 y6 y5 y4 byte 3: 0 M R L 1 m r l byte 4: 0 mt x3 x2 y3 y2 y1 y0 byte 5: 0 z6 z5 z4 z3 z2 z1 z0h]hXbyte 0: 1 ? x1 x0 1 1 1 1 byte 1: 0 x10 x9 x8 x7 x6 x5 x4 byte 2: 0 y10 y9 y8 y7 y6 y5 y4 byte 3: 0 M R L 1 m r l byte 4: 0 mt x3 x2 y3 y2 y1 y0 byte 5: 0 z6 z5 z4 z3 z2 z1 z0}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hNote that for some devices the trackstick buttons are reported in this packet, and on others it is reported in the trackstick packets.h]hNote that for some devices the trackstick buttons are reported in this packet, and on others it is reported in the trackstick packets.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hXkThe second packet type contains bitmaps representing the x and y axes. In the bitmaps a given bit is set if there is a finger covering that position on the given axis. Thus the bitmap packet can be used for low-resolution multi-touch data, although finger tracking is not possible. This packet also encodes the number of contacts (f1 and f0 in the table below)::h]hXjThe second packet type contains bitmaps representing the x and y axes. In the bitmaps a given bit is set if there is a finger covering that position on the given axis. Thus the bitmap packet can be used for low-resolution multi-touch data, although finger tracking is not possible. This packet also encodes the number of contacts (f1 and f0 in the table below):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hXbyte 0: 1 1 x1 x0 1 1 1 1 byte 1: 0 x8 x7 x6 x5 x4 x3 x2 byte 2: 0 y7 y6 y5 y4 y3 y2 y1 byte 3: 0 y10 y9 y8 1 1 1 1 byte 4: 0 x14 x13 x12 x11 x10 x9 y0 byte 5: 0 1 ? ? ? ? f1 f0h]hXbyte 0: 1 1 x1 x0 1 1 1 1 byte 1: 0 x8 x7 x6 x5 x4 x3 x2 byte 2: 0 y7 y6 y5 y4 y3 y2 y1 byte 3: 0 y10 y9 y8 1 1 1 1 byte 4: 0 x14 x13 x12 x11 x10 x9 y0 byte 5: 0 1 ? ? ? ? f1 f0}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hThis packet only appears after a position packet with the mt bit set, and usually only appears when there are two or more contacts (although occasionally it's seen with only a single contact).h]hThis packet only appears after a position packet with the mt bit set, and usually only appears when there are two or more contacts (although occasionally it’s seen with only a single contact).}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h3The final v3 packet type is the trackstick packet::h]h2The final v3 packet type is the trackstick packet:}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hXbyte 0: 1 1 x7 y7 1 1 1 1 byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 y6 y5 y4 y3 y2 y1 y0 byte 3: 0 1 TP SW 1 M R L byte 4: 0 z6 z5 z4 z3 z2 z1 z0 byte 5: 0 0 1 1 1 1 1 1h]hXbyte 0: 1 1 x7 y7 1 1 1 1 byte 1: 0 x6 x5 x4 x3 x2 x1 x0 byte 2: 0 y6 y5 y4 y3 y2 y1 y0 byte 3: 0 1 TP SW 1 M R L byte 4: 0 z6 z5 z4 z3 z2 z1 z0 byte 5: 0 0 1 1 1 1 1 1}hjHsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hTP means Tap SW status when tap processing is enabled or Press status when press processing is enabled. SW means scroll up when 4 buttons are available.h]hTP means Tap SW status when tap processing is enabled or Press status when press processing is enabled. SW means scroll up when 4 buttons are available.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]%alps-absolute-mode-protocol-version-3ah ]h"]'alps absolute mode - protocol version 3ah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h'ALPS Absolute Mode - Protocol Version 4h]h'ALPS Absolute Mode - Protocol Version 4}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjlhhhhhKubh)}(h0Protocol version 4 has an 8-byte packet format::h]h/Protocol version 4 has an 8-byte packet format:}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjlhhubj)}(hXqbyte 0: 1 ? x1 x0 1 1 1 1 byte 1: 0 x10 x9 x8 x7 x6 x5 x4 byte 2: 0 y10 y9 y8 y7 y6 y5 y4 byte 3: 0 1 x3 x2 y3 y2 y1 y0 byte 4: 0 ? ? ? 1 ? r l byte 5: 0 z6 z5 z4 z3 z2 z1 z0 byte 6: bitmap data (described below) byte 7: bitmap data (described below)h]hXqbyte 0: 1 ? x1 x0 1 1 1 1 byte 1: 0 x10 x9 x8 x7 x6 x5 x4 byte 2: 0 y10 y9 y8 y7 y6 y5 y4 byte 3: 0 1 x3 x2 y3 y2 y1 y0 byte 4: 0 ? ? ? 1 ? r l byte 5: 0 z6 z5 z4 z3 z2 z1 z0 byte 6: bitmap data (described below) byte 7: bitmap data (described below)}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjlhhubh)}(hThe last two bytes represent a partial bitmap packet, with 3 full packets required to construct a complete bitmap packet. Once assembled, the 6-byte bitmap packet has the following format::h]hThe last two bytes represent a partial bitmap packet, with 3 full packets required to construct a complete bitmap packet. Once assembled, the 6-byte bitmap packet has the following format:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjlhhubj)}(hXbyte 0: 0 1 x7 x6 x5 x4 x3 x2 byte 1: 0 x1 x0 y4 y3 y2 y1 y0 byte 2: 0 0 ? x14 x13 x12 x11 x10 byte 3: 0 x9 x8 y9 y8 y7 y6 y5 byte 4: 0 0 0 0 0 0 0 0 byte 5: 0 0 0 0 0 0 0 y10h]hXbyte 0: 0 1 x7 x6 x5 x4 x3 x2 byte 1: 0 x1 x0 y4 y3 y2 y1 y0 byte 2: 0 0 ? x14 x13 x12 x11 x10 byte 3: 0 x9 x8 y9 y8 y7 y6 y5 byte 4: 0 0 0 0 0 0 0 0 byte 5: 0 0 0 0 0 0 0 y10}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjlhhubh)}(h+There are several things worth noting here.h]h+There are several things worth noting here.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjlhhubh block_quote)}(hX~1) In the bitmap data, bit 6 of byte 0 serves as a sync byte to identify the first fragment of a bitmap packet. 2) The bitmaps represent the same data as in the v3 bitmap packets, although the packet layout is different. 3) There doesn't seem to be a count of the contact points anywhere in the v4 protocol packets. Deriving a count of contact points must be done by analyzing the bitmaps. 4) There is a 3 to 1 ratio of position packets to bitmap packets. Therefore MT position can only be updated for every third ST position update, and the count of contact points can only be updated every third packet as well. h]henumerated_list)}(hhh](h list_item)}(hmIn the bitmap data, bit 6 of byte 0 serves as a sync byte to identify the first fragment of a bitmap packet. h]h)}(hlIn the bitmap data, bit 6 of byte 0 serves as a sync byte to identify the first fragment of a bitmap packet.h]hlIn the bitmap data, bit 6 of byte 0 serves as a sync byte to identify the first fragment of a bitmap packet.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hjThe bitmaps represent the same data as in the v3 bitmap packets, although the packet layout is different. h]h)}(hiThe bitmaps represent the same data as in the v3 bitmap packets, although the packet layout is different.h]hiThe bitmaps represent the same data as in the v3 bitmap packets, although the packet layout is different.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hThere doesn't seem to be a count of the contact points anywhere in the v4 protocol packets. Deriving a count of contact points must be done by analyzing the bitmaps. h]h)}(hThere doesn't seem to be a count of the contact points anywhere in the v4 protocol packets. Deriving a count of contact points must be done by analyzing the bitmaps.h]hThere doesn’t seem to be a count of the contact points anywhere in the v4 protocol packets. Deriving a count of contact points must be done by analyzing the bitmaps.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hThere is a 3 to 1 ratio of position packets to bitmap packets. Therefore MT position can only be updated for every third ST position update, and the count of contact points can only be updated every third packet as well. h]h)}(hThere is a 3 to 1 ratio of position packets to bitmap packets. Therefore MT position can only be updated for every third ST position update, and the count of contact points can only be updated every third packet as well.h]hThere is a 3 to 1 ratio of position packets to bitmap packets. Therefore MT position can only be updated for every third ST position update, and the count of contact points can only be updated every third packet as well.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix)uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjlhhubh)}(h 2 fingers are down, and some fingers are in the button area, then the 2 coordinates reported are for fingers outside the button area and these report extra fingers being present in the right / left button area. Note these fingers are not added to the F field! so if a TWO packet is received and R = 1 then there are 3 fingers down, etc. TWO: 1: Two touches present, byte 0/4/5 are in TWO fmt 0: If byte 4 bit 0 is 1, then byte 0/4/5 are in MULTI fmt otherwise byte 0 bit 4 must be set and byte 0/4/5 are in NEW fmt F: Number of fingers - 3, 0 means 3 fingers, 1 means 4 ...h]hXR packet-fmt b7 b6 b5 b4 b3 b2 b1 b0 byte 0: TWO & MULTI L 1 R M 1 Y0-2 Y0-1 Y0-0 byte 0: NEW L 1 X1-5 1 1 Y0-2 Y0-1 Y0-0 byte 1: Y0-10 Y0-9 Y0-8 Y0-7 Y0-6 Y0-5 Y0-4 Y0-3 byte 2: X0-11 1 X0-10 X0-9 X0-8 X0-7 X0-6 X0-5 byte 3: X1-11 1 X0-4 X0-3 1 X0-2 X0-1 X0-0 byte 4: TWO X1-10 TWO X1-9 X1-8 X1-7 X1-6 X1-5 X1-4 byte 4: MULTI X1-10 TWO X1-9 X1-8 X1-7 X1-6 Y1-5 1 byte 4: NEW X1-10 TWO X1-9 X1-8 X1-7 X1-6 0 0 byte 5: TWO & NEW Y1-10 0 Y1-9 Y1-8 Y1-7 Y1-6 Y1-5 Y1-4 byte 5: MULTI Y1-10 0 Y1-9 Y1-8 Y1-7 Y1-6 F-1 F-0 L: Left button R / M: Non-clickpads: Right / Middle button Clickpads: When > 2 fingers are down, and some fingers are in the button area, then the 2 coordinates reported are for fingers outside the button area and these report extra fingers being present in the right / left button area. Note these fingers are not added to the F field! so if a TWO packet is received and R = 1 then there are 3 fingers down, etc. TWO: 1: Two touches present, byte 0/4/5 are in TWO fmt 0: If byte 4 bit 0 is 1, then byte 0/4/5 are in MULTI fmt otherwise byte 0 bit 4 must be set and byte 0/4/5 are in NEW fmt F: Number of fingers - 3, 0 means 3 fingers, 1 means 4 ...}hjPsbah}(h]h ]h"]h$]h&]jjuh1jhhhM4hjhhubeh}(h]%alps-absolute-mode-protocol-version-7ah ]h"]'alps absolute mode - protocol version 7ah$]h&]uh1hhhhhhhhM'ubh)}(hhh](h)}(h'ALPS Absolute Mode - Protocol Version 8h]h'ALPS Absolute Mode - Protocol Version 8}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhhhhhMQubh)}(h5Spoken by SS4 (73 03 14) and SS5 (73 03 28) hardware.h]h5Spoken by SS4 (73 03 14) and SS5 (73 03 28) hardware.}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMShjfhhubh)}(h>The packet type is given by the APD field, bits 4-5 of byte 3.h]h>The packet type is given by the APD field, bits 4-5 of byte 3.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMUhjfhhubh)}(hTouchpad packet (APD = 0x2)::h]hTouchpad packet (APD = 0x2):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMWhjfhhubj)}(hXO b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 0 0 X7 byte 1: 0 X6 X5 X4 X3 X2 X1 X0 byte 2: 0 Y6 Y5 Y4 Y3 Y2 Y1 Y0 byte 3: 0 T&P 1 0 1 0 0 Y7 byte 4: 0 Z6 Z5 Z4 Z3 Z2 Z1 Z0 byte 5: 0 0 0 0 0 0 0 0h]hXO b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 0 0 X7 byte 1: 0 X6 X5 X4 X3 X2 X1 X0 byte 2: 0 Y6 Y5 Y4 Y3 Y2 Y1 Y0 byte 3: 0 T&P 1 0 1 0 0 Y7 byte 4: 0 Z6 Z5 Z4 Z3 Z2 Z1 Z0 byte 5: 0 0 0 0 0 0 0 0}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMYhjfhhubh)}(h4SWM, SWR, SWL: Middle, Right, and Left button statesh]h4SWM, SWR, SWL: Middle, Right, and Left button states}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMahjfhhubh)}(h&Touchpad 1 Finger packet (APD = 0x0)::h]h%Touchpad 1 Finger packet (APD = 0x0):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMchjfhhubj)}(hXR b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 X2 X1 X0 byte 1: X9 X8 X7 1 X6 X5 X4 X3 byte 2: 0 X11 X10 LFB Y3 Y2 Y1 Y0 byte 3: Y5 Y4 0 0 1 TAPF2 TAPF1 TAPF0 byte 4: Zv7 Y11 Y10 1 Y9 Y8 Y7 Y6 byte 5: Zv6 Zv5 Zv4 0 Zv3 Zv2 Zv1 Zv0h]hXR b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 X2 X1 X0 byte 1: X9 X8 X7 1 X6 X5 X4 X3 byte 2: 0 X11 X10 LFB Y3 Y2 Y1 Y0 byte 3: Y5 Y4 0 0 1 TAPF2 TAPF1 TAPF0 byte 4: Zv7 Y11 Y10 1 Y9 Y8 Y7 Y6 byte 5: Zv6 Zv5 Zv4 0 Zv3 Zv2 Zv1 Zv0}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMehjfhhubh)}(hTAPF: ??? LFB: ???h]hTAPF: ??? LFB: ???}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMmhjfhhubh)}(h&Touchpad 2 Finger packet (APD = 0x1)::h]h%Touchpad 2 Finger packet (APD = 0x1):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMphjfhhubj)}(hXO b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 AX6 AX5 AX4 byte 1: AX11 AX10 AX9 AX8 AX7 AZ1 AY4 AZ0 byte 2: AY11 AY10 AY9 CONT AY8 AY7 AY6 AY5 byte 3: 0 0 0 1 1 BX6 BX5 BX4 byte 4: BX11 BX10 BX9 BX8 BX7 BZ1 BY4 BZ0 byte 5: BY11 BY10 BY9 0 BY8 BY7 BY5 BY5h]hXO b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 AX6 AX5 AX4 byte 1: AX11 AX10 AX9 AX8 AX7 AZ1 AY4 AZ0 byte 2: AY11 AY10 AY9 CONT AY8 AY7 AY6 AY5 byte 3: 0 0 0 1 1 BX6 BX5 BX4 byte 4: BX11 BX10 BX9 BX8 BX7 BZ1 BY4 BZ0 byte 5: BY11 BY10 BY9 0 BY8 BY7 BY5 BY5}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMrhjfhhubh)}(h)CONT: A 3-or-4 Finger packet is to followh]h)CONT: A 3-or-4 Finger packet is to follow}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMzhjfhhubh)}(h+Touchpad 3-or-4 Finger packet (APD = 0x3)::h]h*Touchpad 3-or-4 Finger packet (APD = 0x3):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM|hjfhhubj)}(hXO b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 AX6 AX5 AX4 byte 1: AX11 AX10 AX9 AX8 AX7 AZ1 AY4 AZ0 byte 2: AY11 AY10 AY9 OVF AY8 AY7 AY6 AY5 byte 3: 0 0 1 1 1 BX6 BX5 BX4 byte 4: BX11 BX10 BX9 BX8 BX7 BZ1 BY4 BZ0 byte 5: BY11 BY10 BY9 0 BY8 BY7 BY5 BY5h]hXO b7 b6 b5 b4 b3 b2 b1 b0 byte 0: SWM SWR SWL 1 1 AX6 AX5 AX4 byte 1: AX11 AX10 AX9 AX8 AX7 AZ1 AY4 AZ0 byte 2: AY11 AY10 AY9 OVF AY8 AY7 AY6 AY5 byte 3: 0 0 1 1 1 BX6 BX5 BX4 byte 4: BX11 BX10 BX9 BX8 BX7 BZ1 BY4 BZ0 byte 5: BY11 BY10 BY9 0 BY8 BY7 BY5 BY5}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhM~hjfhhubh)}(hOVF: 5th finger detectedh]hOVF: 5th finger detected}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjfhhubeh}(h]%alps-absolute-mode-protocol-version-8ah ]h"]'alps absolute mode - protocol version 8ah$]h&]uh1hhhhhhhhMQubeh}(h]alps-touchpad-protocolah ]h"]alps touchpad protocolah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjnerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(jHjEhhjJjGjjjjj3j0jZjWjjjjjijfjTjQjjjjjcj`j@j=u nametypes}(jHhjJjjj3jZjjjijTjjjcj@uh}(jEhhhjGhjjMjjj0jjWj6jj]jjjfjjQjljjWjjj`jj=jfu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.