CuteMouse driver v1.8. Copyright (c) 1997-2000 Nagy Daniel Release date: 2000-09-16 License: -------- CuteMouse is released under the GPL license. For further information please read the COPYING file. Description: ------------ CuteMouse is a mouse driver which supports many mouse protocols, serial and PS/2. It can search for serial mice at all COM ports or only at a specified port. An important CuteMouse feature is its small memory footprint: the TSR part occupies less than 3.5K. CuteMouse also can install itself in upper memory when it is available without requiring external utilities such as DOS 'lh' command. CuteMouse supports cursor drawing in all standard graphics and text modes with any screen size. These are automatically detected whenever reset functions are called or the video mode is changed. You can subscribe to the CuteMouse discussion group at the official homepage http://www.vein.hu/~nagyd or by sending an empty letter to . CuteMouse is part of the FreeDOS project at http://www.freedos.org Details: -------- CTMOUSE supports standard PS/2 and Mouse Systems, Microsoft (including Intellimouse/Wheel Mouse) and Logitech serial protocols. When searching for a connected mouse the PS/2 port is checked first then all COM ports are scanned. Option /S, whose syntax is described in the help screen, disables PS/2 support and can specify the COM port and the IRQ line to be checked for a mouse connection; option /P disables serial protocols. When a COM port must be forced but PS/2 support is also required, both options must be present in the command line. By default, a PS/2 mouse is searched for before a serial mouse, but option /V reverses this. Option /V can be useful, for example, on notebooks with a built-in PS/2 pointing device to enable use of a serial mouse, when attached, by causing CTMOUSE to look for a serial mouse before checking the PS/2 device. Using option /Y (see below) also may be required along with /V. Note: option /V enables both serial and PS/2 protocols, so using options /P and /S without arguments along with /V in the command line is meaningless. For serial mice, CTMOUSE searches all COM ports (or at the port specified by option /S) for an attached Microsoft or Logitech mouse. If no such mouse is found then CTMOUSE installs at the first existing (or specified) COM port for a Mouse Systems mouse, whether a mouse is there or not (this is because Mouse Systems protocol defines no detection sequence). Option /Y in the command line disables Mouse Systems protocol support and prevents driver installation if no Microsoft or Logitech mouse is found. Note: option /Y forces serial mouse search but, unlike option /S, doesn't disable PS/2 support. Both PS/2 and plain Microsoft protocols assume two button mice but option /3 in the command line can be used to enable the middle button if one is present. WARNING: when the middle button of a plain Microsoft mouse is enabled, pressing left or right button along with the middle button can cause "middle button state triggering" - i.e. when the middle button is pressed the driver thinks it is released and vice-versa. This is a peculiarity of the Microsoft protocol and can't be changed. If button triggering occurs simply press the left or right button along with the middle button once again to clear the problem. CTMOUSE supports 9 fixed resolution levels plus auto resolution, which define the relationship between cursor and mouse movement - the higher the resolution level, the further the cursor moves for a given mouse movement. Resolution level 1 or small mouse movements at any resolution provides a direct relationship between cursor and mouse movement, which enables precise screen positioning even at the highest resolution levels. Larger mouse movements and higher resolution levels are multiplied together to determine the cursor movement, enabling rapid cursor movements across the screen for relatively small mouse movements. Auto resolution means dynamic resolution change, where the faster the mouse moves, the greater the resolution by which the mouse movements are multiplied, giving the cursor a nonlinear acceleration. Option /R, whose syntax is described in the help screen, allows the preferred resolution level to be specified for each direction. If installing from low memory, CTMOUSE attempts to move itself into upper memory (UMB) if there is a suitable free UMB block and option /W is not used. With option /W any external utility can be used to install CTMOUSE at a specific location. Subsequent CTMOUSE runs simply reset the resident part to the new command line options, unless the mouse is not found or option /B is used. When installing, CTMOUSE also ignores and hides any present mouse services unless option /B is used. Option /U in command line can be used to unload the resident part of CTMOUSE unless driver interrupts have been intercepted by another program. After successful unloading, CTMOUSE restores mouse services that were present at installation time. Option /B in the command line cancels CTMOUSE execution if any (including CTMOUSE itself) mouse services are already present. With option /B CTMOUSE will not install itself above loaded mouse drivers and will not reset the resident part to new command line options. For each event CTMOUSE returns an appropriate exit code which can be used in "if errorlevel" statements in batch files: 0 - PS/2, Microsoft or Logitech mouse found and CTMOUSE installed; unload successful; /? option used 1 - CTMOUSE installed for Mouse Systems protocol; unload failed - CTMOUSE not installed 2 - resident part switched to PS/2, Microsoft or Logitech protocol; unload failed - driver interrupts intercepted 3 - resident part switched to Mouse Systems protocol 4 - mouse services already present (returned for option /B only) 5 - mouse not found; invalid option used Along with option /B, this enables creation of complex batch files. For example, the following batch can be used to run a program that requires mouse services to be present: if "%1"=="@" goto skipmouse ctmouse/b/y>nul if errorlevel 5 echo Mouse not found! if errorlevel 5 goto end if errorlevel 2 goto run call %0 @ %1 %2 %3 %4 %5 %6 %7 %8 %9 ctmouse/u>nul goto end :skipmouse shift :run %1 %2 %3 %4 %5 %6 %7 %8 %9 :end Option /B can also be used to manually specify a mouse search sequence. In the following example, CTMOUSE is installed by the first command that finds a mouse and the following commands will have no affect on the resident part: ctmouse/b/s4/y>nul ctmouse/b/p/y>nul ctmouse/b/s2/y>nul A help screen with all option descriptions can be obtained with the /? command line option. The CuteMouse package also includes a protocol analyzer. This program shows how mice work and what they send to the computer for each action. PROTOCOL can even decipher information sent by PNP mice. All output goes through DOS functions and can be redirected to a file for subsequent analysis or sending to someone else. Compiling: ---------- To assemble the English version of the driver use TASM (or any compatible assembler) and any linker that can produce a COM file from OBJ files: copy ctm-en.msg ctmouse.msg tasm /m ctmouse.asm tlink /t /x ctmouse.obj,ctmouse.exe ctm2exe ctmouse.exe To assemble the serial protocol analyzer: tasm /m protocol.asm tlink /t /x protocol.obj To compile or delete temporary files, the MAKE utility also can be used (see makefile). Contents: --------- copying - GNU license file ctmouse.asm - CuteMouse source code ctm-en.msg - CuteMouse source file with messages in English ctm-*.msg - messages in other languages ctm2exe.asm - .COM files to .EXE files converter source ctm2exe.exe - .COM files to .EXE files converter executable makefile - script file for MAKE national.bat - batch file to compile other language versions of CuteMouse alllang.bat - batch file to compile all other language versions of CuteMouse ctmouse.exe - CuteMouse driver executable with English messages ctm-*.exe - CuteMouse driver executables with other language messages ctmouse.txt - this file history.txt - detailed version history mousetst.cpp - mouse test example source (written under BC++ 3.1) mousetst.com - mouse test example executable (for debugging purposes) protocol.asm - protocol analyzer source protocol.com - protocol analyzer executable (for debugging purposes) protocol.txt - description of some low level mouse protocols technote.txt - technical notes for advanced users Credits: -------- - Arkady V.Belousov : many bugfixes, optimizations and features - Alain M. : many ideas and message files - Frank Pruefer : documentation proofreading - Mike Millen : documentation proofreading - Robert Riebisch : mode 13h positioning bugfix - Fernando Papa Budzyn: self-loadhigh capability - Martin : optimizations - Paul Schubert: much faster PS/2 codes - All who helped me with ideas and codes Contacts: --------- mailto:nagyd@almos.vein.hu http://www.vein.hu/~nagyd