Manual Pages  — PSM

At the level one, a data packet is encoded in the standard format MOUSE_PROTO_SYSMOUSE as defined in mouse(4).

At the level two, native level, there is no standard on the size and format of the data packet.

Tap and drag gestures can be disabled by setting hw.psm.tap_enabled to 0 at boot-time. Currently, this is supported on Synaptics touchpads regardless of Extended support state and on Elantech touchpads with Extended support enabled. The behaviour may be changed after boot by setting the sysctl with the same name and by restarting moused(8) using /etc/rc.d/moused.

Active multiplexing support can be disabled by setting hw.psm.mux_disabled to 1 at boot-time. This will prevent psm from enabling active multiplexing mode needed for some Synaptics touchpads.

MOUSE_GETLEVEL int *level MOUSE_SETLEVEL int *level
	These commands manipulate the operation level of the psm driver.
MOUSE_GETHWINFO mousehw_t *hw
	Returns the hardware information of the attached device in the following structure. typedef struct mousehw { int buttons; /* number of buttons */ int iftype; /* I/F type */ int type; /* mouse/track ball/pad... */ int model; /* I/F dependent model ID */ int hwid; /* I/F dependent hardware ID */ } mousehw_t; The buttons field holds the number of buttons on the device. The psm driver currently can detect the 3 button mouse from Logitech and report accordingly. The 3 button mouse from the other manufacturer may or may not be reported correctly. However, it will not affect the operation of the driver. The iftype is always MOUSE_IF_PS2. The type tells the device type: MOUSE_MOUSE, MOUSE_TRACKBALL, MOUSE_STICK, MOUSE_PAD, or MOUSE_UNKNOWN. The user should not heavily rely on this field, as the driver may not always, in fact it is very rarely able to, identify the device type. The model is always MOUSE_MODEL_GENERIC at the operation level 0. It may be MOUSE_MODEL_GENERIC or one of MOUSE_MODEL_XXX constants at higher operation levels. Again the psm driver may or may not set an appropriate value in this field. The hwid is the ID value returned by the device. Known IDs include:
0	Mouse (Microsoft, Logitech and many other manufacturers)
2	Microsoft Ballpoint mouse
3	Microsoft IntelliMouse

MOUSE_SYN_GETHWINFO synapticshw_t *synhw
	Retrieves extra information associated with Synaptics Touchpad. Only available when a supported device has been detected. typedef struct synapticshw { int infoMajor;      /* major hardware revision */ int infoMinor;      /* minor hardware revision */ int infoRot180;     /* touchpad is rotated */ int infoPortrait;   /* touchpad is a portrait */ int infoSensor;     /* sensor model */ int infoHardware;   /* hardware model */ int infoNewAbs;     /* supports the newabs format */ int capPen;         /* can detect a pen */ int infoSimplC;     /* supports simple commands */ int infoGeometry;   /* touchpad dimensions */ int capExtended;    /* supports extended packets */ int capSleep;       /* can be suspended/resumed */ int capFourButtons; /* has four buttons */ int capMultiFinger; /* can detect multiple fingers */ int capPalmDetect;  /* can detect a palm */ int capPassthrough; /* can passthrough guest packets */ int capMiddle;      /* has a physical middle button */ int nExtendedButtons; /* has N additional buttons */ int nExtendedQueries; /* supports N extended queries */ } synapticshw_t; See the Synaptics TouchPad Interfacing Guide for more information about the fields in this structure.
MOUSE_GETMODE mousemode_t *mode
	The command gets the current operation parameters of the mouse driver. typedef struct mousemode { int protocol; /* MOUSE_PROTO_XXX */ int rate; /* report rate (per sec), -1 if unknown */ int resolution; /* MOUSE_RES_XXX, -1 if unknown */ int accelfactor; /* acceleration factor */ int level; /* driver operation level */ int packetsize; /* the length of the data packet */ unsigned char syncmask[2]; /* sync. bits */ } mousemode_t; The protocol is MOUSE_PROTO_PS2 at the operation level zero and two. MOUSE_PROTO_SYSMOUSE at the operation level one. The rate is the status report rate (reports/sec) at which the device will send movement report to the host computer. Typical supported values are 10, 20, 40, 60, 80, 100 and 200. Some mice may accept other arbitrary values too. The resolution of the pointing device must be one of MOUSE_RES_XXX constants or a positive value. The greater the value is, the finer resolution the mouse will select. Actual resolution selected by the MOUSE_RES_XXX constant varies according to the model of mouse. Typical resolutions are:

MOUSE_RES_LOW	25 ppi
MOUSE_RES_MEDIUMLOW	50 ppi
MOUSE_RES_MEDIUMHIGH	100 ppi
MOUSE_RES_HIGH	200 ppi

The accelfactor field holds a value to control acceleration feature (see Acceleration). It must be zero or greater. If it is zero, acceleration is disabled.

The packetsize field specifies the length of the data packet. It depends on the operation level and the model of the pointing device.

level 0	3 bytes
level 1	8 bytes
level 2	Depends on the model of the device

The array syncmask holds a bit mask and pattern to detect the first byte of the data packet. syncmask[0] is the bit mask to be ANDed with a byte. If the result is equal to syncmask[1], the byte is likely to be the first byte of the data packet. Note that this detection method is not 100% reliable, thus, should be taken only as an advisory measure.

MOUSE_SETMODE mousemode_t *mode
	The command changes the current operation parameters of the mouse driver as specified in mode. Only rate, resolution, level and accelfactor may be modifiable. Setting values in the other field does not generate error and has no effect. If you do not want to change the current setting of a field, put -1 there. You may also put zero in resolution and rate, and the default value for the fields will be selected.
MOUSE_READDATA mousedata_t *data MOUSE_READSTATE mousedata_t *state
	These commands are not currently supported by the psm driver.
MOUSE_GETSTATUS mousestatus_t *status
	The command returns the current state of buttons and movement counts as described in mouse(4).

psm0: device ID X

At debug level 1 more information will be logged while the driver probes the auxiliary port (mouse port). Messages are logged with the LOG_KERN facility at the LOG_DEBUG level (see syslogd(8)).

psm0: current command byte:xxxx
kbdio: TEST_AUX_PORT status:0000
kbdio: RESET_AUX return code:00fa
kbdio: RESET_AUX status:00aa
kbdio: RESET_AUX ID:0000
[...]
psm: status 00 02 64
psm0 irq 12 on isa
psm0: model AAAA, device ID X, N buttons
psm0: config:00000www, flags:0000uuuu, packet size:M
psm0: syncmask:xx, syncbits:yy

The first line shows the command byte value of the keyboard controller just before the auxiliary port is probed. It usually is 40, 45, 47 or 65, depending on how the motherboard BIOS initialized the keyboard controller upon power-up.

The second line shows the result of the keyboard controller's test on the auxiliary port interface, with zero indicating no error; note that some controllers report no error even if the port does not exist in the system, however.

The third through fifth lines show the reset status of the pointing device. The functioning device should return the sequence of FA AA <ID>. The ID code is described above.

The seventh line shows the current hardware settings. These bytes are formatted as follows:

Byte 1
bit 7	Reserved.
bit 6	0 - stream mode, 1 - remote mode. In the stream mode, the pointing device sends the device status whenever its state changes. In the remote mode, the host computer must request the status to be sent. The psm driver puts the device in the stream mode.
bit 5	Set if the pointing device is currently enabled. Otherwise zero.
bit 4	0 - 1:1 scaling, 1 - 2:1 scaling. 1:1 scaling is the default.
bit 3	Reserved.
bit 2	Left button status; set if pressed.
bit 1	Middle button status; set if pressed.
bit 0	Right button status; set if pressed.

Byte 2

bit 7	Reserved.
bit 6..0	Resolution code: zero through three. Actual resolution for the resolution code varies from one device to another.

Byte 3	The status report rate (reports/sec) at which the device will send movement report to the host computer.

Note that the pointing device will not be enabled until the psm driver is opened by the user program.

The rest of the lines show the device ID code, the number of detected buttons and internal variables.

At debug level 2, much more detailed information is logged.

Synaptics TouchPad Interfacing Guide,

There is not a guaranteed way to re-synchronize with the first byte of the packet once we are out of synchronization with the data stream. However, if you are using the XFree86 server and experiencing the problem, you may be able to make the X server synchronize with the mouse by switching away to a virtual terminal and getting back to the X server, unless the X server is accessing the mouse via moused(8). Clicking any button without moving the mouse may also work.