DESCRIPTION

The STREAMS modules vuidm3p, vuidm4p, vuidm5p, vuid2ps2, and vuid3ps2 convert mouse protocols to Firm
events. The Firm event structure is described in <sys/vuid_event.h>. Pushing a STREAMS module does not automatically enable mouse protocol conversion to Firm events.
The STREAMS module state is initially set to raw or VUID_NATIVE mode which performs no message processing. The user will need to
change the state to VUID_FIRM_EVENT mode in order to initiate mouse protocol conversion to Firm events. This can be accomplished by the following code:

The remainder of this section describes the processing of STREAMS messages on the read- and write-side.

Read Side Behavior

M_DATA

The messages coming in are queued and converted to Firm events.

M_FLUSH

The read queue of the module is flushed of all its data messages and all data in the record being accumulated
are also flushed. The message is passed upstream.

Write Side Behavior

M_IOCTL

Messages sent downstream as a result of an ioctl(2) system call. There are two valid ioctl options processed by the vuidmice modules VUIDGFORMAT and VUIDSFORMAT.

VUIDGFORMAT

This option returns the current state of the STREAMS
module. The state of the vuidmice STREAMS module may either be VUID_NATIVE (no message processing) or VUID_FIRM_EVENT (convert to Firm events).

VUIDSFORMAT

This option sets the state of the STREAMS module to VUID_FIRM_EVENT.
If the state of the STREAMS module is already in VUID_FIRM_EVENT then this option is non-operational. It is not possible to set the state back to VUID_NATIVE once the state becomes VUID_FIRM_EVENT. To disable message processing, pop the STREAMS module out by calling ioctl(fd, 1I_POP, vuid*).

M_FLUSH

The write queue of the module is flushed of all its data messages and the message is passed downstream.