MOUSEDRV.TXT - MouseWare 6.43 (c) Copyright 1993-1994 Logitech, Inc. All Rights Reserved *************************************************************************** This file documents the MOUSEDRV.INI parameters and the DOS mouse driver parameters. To view or print this file under DOS, use README.EXE which is supplied on the installation disks. At the DOS prompt type the following: README MOUSEDRV.TXT *************************************************************************** TABLE OF CONTENTS 1. INI FILE STRUCTURE 1.1 [Global] Section 1.2 [COMx] Section 1.3 [DOSGlobal] Section 1.4 [Display] Section 1.5 [WinGlobal] Section 1.6 [DeviceType] Section 1.7 [Technical] Section 2. DOS MOUSE DRIVER COMMAND LINE PARAMETERS 2.1 Acceleration 2.2 Button Mapping 2.3 Button Swap 2.4 COM Port 2.5 Cursor Blinking Rate 2.6 Cursor Lock 2.7 Cursor Trail 2.8 Device Type 2.9 Drag Lock 2.10 Mouse Speed 2.11 Orientation 2.12 Memory 2.13 Miscellaneous 3. VESA Super VGA Support 3.1 VESA Background 3.2 VCI Background 3.3 The Logitech MOUSE driver and VCI Module 3.4 Other Operating Environments/Systems 3.5 Enabling LVESA.OVL 3.6 Loading VCI Overlay Modules 3.7 ROM Resident Overlay or TSR's 3.8 Disabling VCI module loading 4. DOS Mouse Driver Memory Management 4.1 DOS Memory Regions 4.2 Cloaking Interface 4.3 DOS Driver Memory Location *************************************************************************** 1. INI FILE STRUCTURE MOUSEDRV.INI is a configuration file used by both the DOS and Windows drivers. This allows the mouse to have similar behavior under the two environments. Because the settings are stored in a file, the mouse settings will be the same from one boot session to another. To change the settings, use either the DOS or Windows Mouse Control Center. The format of MOUSEDRV.INI file is as follows: [section name] keyname=value The square brackets ([]) in the [section name] are required. Section names must start in the leftmost column. Within each sections are one or more "keyname=value" statements. Typically, a system has only one pointing device attached. Notebook users may have two pointing devices: a built-in trackball and a serial mouse. Others may use the DOS mouse driver in dual mode. For built-in trackball users, the mouse drivers will maintain two separate [DeviceType] sections. (Only one mouse may be in use at a time unless the DOS mouse driver is in dual mode.) The user will be able to maintain separate parameters for each device. When the DOS mouse driver is in dual mode, two [DeviceType] sections will be written. Parameters for the first mouse found will be used. Some parameters in the configuration file need to specify a particular button. This is designated as follows: 100 Primary button 010 Secondary button 001 Third button These button values might be conbined to allow multiple buttons to be specified. For example: DragLock=011 Assign the DragLock to the secondary and third buttons. 1.1 [Global] Section This section contains information common to both DOS and Windows mouse drivers. Connection= The hardware device type for the mouse that is currently connected. Only one device type will be listed. By default, Connection=None. BUS Search for a BUS mouse Inport Search for a Microsoft Inport mouse PS2 Search for a PS/2 mouse Serial Search for a Serial mouse ConnectionPort= Current connection port used. By default, ConnectionPort=None. COM1 Serial COM port 1 COM2 Serial COM port 2 COM3 Serial COM port 3 COM4 Serial COM port 4 ForcedConnection= Determines if the mouse driver will use the 'Connection' and 'ConnectionPort' parameters above to search for a mouse or use only the search order to find a mouse. On Use Connection information to find a mouse (default) Off Perform a full search for mouse each launch time using the search order given below. SearchOrder= Lists the order the driver uses to search for a mouse. The default search order is PS2, Serial, Bus, Inport. Bus Search for a bus mouse Inport Search for a Microsoft Inport mouse PS2 Search for a PS/2 mouse Serial Search for a Serial mouse (M-series and C-series) PortSearchOrder= Lists the order the serial ports are searched. This is valid only for a Serial device. The default port search order is COM1, COM2. ActiveMouse= This parameter indicates which [DeviceType] section is used. The default is Unknown. Refer to the "[DeviceType] Section" in this document for a list of valid device types. 1.2 [COMx] Section This section defines the COM ports used by the computer. This section allows advanced users to configure their mouse for upper IRQ values and non-standard COM port address. The 'x' value must be filled in by the user as must the values in this section. Valid values for 'x' are 1, 2, 3, and 4. Note: The COM port must be supported by the user's computer configuration. The mouse driver cannot configure the users COM ports. This value must match values that are used by the Windows PORTS Control Panel. BaseAddress= The base address of the COM port (given in hexadecimal). By default, the driver determines this value. IRQValue= The IRQ value of the COM port (given in decimal). By default, the driver determines this value. 1.3 [DOSGlobal] Section This section describes the settings used by the DOS mouse driver and DOS Mouse Control Center. BlinkingRate= Rate at which the DOS mouse cursor blinks. This setting is used only if the DOS mouse driver is loaded with cursor enhancements enabled. Fast Sets text cursor to blink fast Slow Sets text cursor to blink slow Off Turns blinking off (default) CursorEnhancement= Indicates if the driver should load the cursor enhancements feature set. On Load the cursor enhancements Off Do not to load cursor enhancements (default) CursorLock= This locks the shape of the cursor in the DOS environment. This setting is used only if the DOS mouse driver is loaded with cursor enhancements enabled. On Enables locking of the cursor shape Off Disables locking of the cursor shape (default) CursorTrails= Enables or disables the cursor trails function. This setting is used only if the DOS mouse driver is loaded with the cursor enhancements enabled. On Enables DOS cursor trails Off Disables DOS cursor trails (default) CordlessReminder= The driver can check for the status of a cordless device when applications are launched. Depending on the device, the status can include information about the battery level or the interference of two or more cordless devices. This checking can be disabled if the status check is too time consuming or if it takes to much memory space. It is recommended to leave this setting enabled. On Enable the cordless mouse reminder (default) Off Do not install the cordless reminder DriverVersion= The DOS driver version number for this release. Memory= The memory allocation strategy the driver will use to relocate itself. The default setting will allow the driver to look for the best location available in memory. The driver will try to relocate itself first in extended memory, next in upper memory and finally in conventional memory. This default behavior can be overriden with the value below. In case an option cannot be satisfied, the next lower allocation strategy will be used. Automatic Load in the best memory available (Default) Upper Load in upper memory Conventional Load in conventional memory MemoryStub= When the driver runs in extended memory, it still needs to maintain a stub of about 1K in conventional or upper memory. Automatic Load the stub in upper memory (Default) Conventional Load the stub in conventional memory 1.4 [Display] Section UseVCIOverlay= The driver can use an external video overlay instead of its built- in video code. This flag will enable or disable the search for such a module. On Attempt to load the video overlay specified in the VideoModule keyname. Off Use the mouse driver built-in video code. (Default) VideoModule= Location of the VESA VCI video cursor overlay. This value is either a file name, the keyword RESIDENT, or blank for no VCI support. If only a file name is present, the driver will assume that the VCI file is located in the driver directory. By default, the directory where MOUSEDRV.INI is located is used. If the overlay cannot be found or has an incorrect format, the driver will revert to its internal video code. 1.5 [WinGlobal] Section The section describes the settings used by the Windows mouse driver. UseDOSDriver= This parameter must be used with caution and might help to solve some compatibility problems. If you experience serious troubles with the Windows mouse driver, you can still use your mouse (with limited functionality) under Windows through the use of the DOS mouse driver. When you set this parameter to On, make sure you've got the DOS mouse driver launched before you start Windows. On Use the DOS mouse driver under Windows. The mouse functionality will then be limited. Off Normal use of the Windows mouse driver (default) DriverVersion= Windows mouse driver version number. WinCC= The full path and file name of the Windows Control Center. The default directory is same as the location of the Windows mouse driver LMOUSE.DRV. 1.6 [DeviceType] Section Each connected device will have its own section defining that device's characteristics. The 'DeviceType' name will be a text string describing the mouse model as follows. Values written here are for mice that can identify themselves (e.g. MouseMan) or for general groups of mice (e.g. SerialM). For unidentifiable mice, the 'DeviceModel' parameter may be used to specify a device shape. By default, the DeviceModel name will be the same as the DeviceType. Note for DOS dual mode: Only one device's [DeviceType] section will be supported at a time. For dual mode, the DOS mouse driver will write out the second mouse's [DeviceType] section but will not use it. Only the first mouse found section will be used. To indicate the active device section, the parameter 'ActiveMouse' will be used. Please see ActiveMouse description in the [Global] section. The device types are: Bus Bus mouse Inport Microsoft Inport mouse PS2 Non-identifiable PS/2 type mice SerialC C7, C9, TrackMan I, etc. (Non-identifiable C- Series type mice) SerialM Kidz mouse, Microsoft mouse, etc. (Non- identifiable M-type mice) SerialV MouseMan Serial, First mouse, etc. (Non- identifiable V-type mice) MouseMan MouseMan mice (W-type, W-type lefty, A-type) MouseMan2 MouseMan mice (PnP/A-type, new shape) TrackMan2 TrackMan II stationary mouse (W-type) TrackMan3 TrackMan II stationary mouse (A-type) TrackManPortable1 TrackMan Portable (W-type) TrackManPortable2 TrackMan Portable (A-type) TrackManVoyager TrackMan Voyager (A-type) Cordless1 MouseMan Cordless (original cordless mouse) Cordless2 MouseMan Cordless (second generation cordless mouse) Cordless3 MouseMan Cordless (PnP/A-type, new receiver) IntegratedTrackBall1Integrated trackball OS2Mouse Windows driver only: for use under WINOS2, OS2 2.X Acceleration= The acceleration setting for the mouse drivers. Low Low acceleration setting (default) Medium Medium acceleration setting High High acceleration setting Off Disable acceleration BaudRate= This parameter sets the baud rate for the mouse. Values of 1200 and 9600 are valid for M series type 'W' mice. All values are valid for C series mice. 1200 Mouse is communicating at 1200 baud 2400 Mouse is communicating at 2400 baud 4800 Mouse is communicating at 4800 baud 9600 Mouse is communicating at 9600 baud The default value varies according to mouse type: C Series = 2400 M Series = 1200 Cordless = 9600 ChannelNumber= Identifies the channel number on which the cordless mouse is communicating. Available channels are 1 through 8 for original cordless mice, and 1 through 4 for new cordless mice. This value is provided for information only. The default value is 4. DeviceModel= A text string that identifies mice that do not have identification sending ability. This command will allow the Windows Control Center to display pictures of unidentifiable mice. This parameter will be entered either by the end user or through the installation program. By default, the DeviceModel name will be the same as the DeviceType. C7 Logitech C7 three button square mice C9 Logitech Series 9 three button mice TrackMan1 Logitech TrackMan I stationary mouse Kidz Logitech Kidz mouse Microsoft1 Old Microsoft mouse Microsoft2 Square Microsoft mouse Microsoft3 New Microsoft mouse FirstMouse Logitech First mouse PilotMouse Logitech Pilot mouse MouseManLeft1Logitech original left-handed MouseMan NumberOfButtons= This parameter identifies the number of buttons a mouse has. It is used for mice that cannot identify the number of buttons they have (such as Inport mice). The default is 3 buttons. Orientation= Degree setting from 0 to 359. The default is 0 degrees. MouseSpeed= Mouse sensitivity value ranging from 1 to 100. The default is 50. DragLock= Drag lock is defined for the primary button only. The button value will indicate the buttons currently acting as a drag lock source. For example DragLock=011 sets the draglock function for the secondary and third buttons. MappingButtonX= The 'X' will be replaced by a physical button number. This give the correspondance between a physical button and a logical button. For example MappingButton2=010 means that the physical button number two on the mouse generates a logical secondary button. ChordDelay= Chording delay for 2 button devices. The value ranges from 0 to 100. The larger the value, the more time the driver will wait for a chording. The null value effectively disables the chording functionality. DoubleClick= Logical buttons on the pointing device that will generate a double- click of the primary button. Disabler= Decimal value representing the shift, control or alt keys on the keyboard that will disable the macro function assigned to a logical button. 1.7 [Technical] Section This section describes technical settings used by the mouse drivers. These settings might help to solve compatibility problems with certain type of hardware or BIOS. ForcePS2EquipmentFlag= Indicates if the driver should force the detection of a PS2 mouse. On Simulate a PS2 mouse found during boot time. Off The flag is set by the BIOS during boot time.(default) Timing= Indicates which timing procedures the driver should use. Software Use software loops to compute timing (default) Hardware Use the PC timer chip to compute timing DetectIPDevice= Indicates if the driver should use the BIOS integrated pointing device interface to identify a device. On Use the BIOS interface. Off Ignore the BIOS interface (default) DebugTiming= Technical support flag. Do not change. On Allow special timing specification Off Use normal timing (default) 2. DOS MOUSE DRIVER PARAMETERS The DOS mouse driver has the ability to read parameters from the command line. This section lists the valid parameters. The syntax for the command line is: MOUSE [Option1], [Option2], ... For example: MOUSE SWAP S07 will SWAP the mouse buttons and set a slightly above medium sensitivity. 2.1 Acceleration With Acceleration, you can make the mouse more or less sensitive to movement relative to the speed with which you move the mouse. By moving the mouse quickly, you can sweep the cursor across your screen with very little mouse movement. Likewise, by moving the mouse slowly you can zero in on an exact screen position. AOFF Turns acceleration off ALOW Sets acceleration to low AMEDIUM Sets acceleration to medium AHIGH Sets acceleration to high 2.2 Button Mapping The 1K and 3K options set the mapping of the physical mouse buttons. The default is 3K and will map the physical buttons to their default logical mapping. The 1K option will map all the buttons to the primary button. To revert to the default button mapping, use the 3K option. 2.3 Button Swap Use the Button Swap option to logically swap the function of the mouse buttons. SWAP Swaps two predifined mouse buttons On regular mice and trackballs, the predifined buttons are the physical left and right buttons. On the TrackMan Portable the buttons are the bottom and middle buttons. 2.4 COM Port This setting forces the driver to look for the serial mouse on either COM1 or COM2. If not found, the driver will search for all the other attached mice. 1 Serial COM port 1 2 Serial COM port 2 2.5 Cursor Blinking Rate This setting determines how fast the cursor blinks. This option is only available if the mouse driver was loaded with cursor enhancements. COFF Turns off the cursor blinking rate CSLOW Sets the cursor blinking rate to slow CFAST Sets the cursor blinking rate to fast 2.6 Cursor Lock This locks the shape of the cursor in the DOS environment. This option is only available if the mouse driver was loaded with cursor enhancements. DCURSOR Sets the default mouse cursor LCURSOR Locks the mouse cursor shape 2.7 Cursor Trail This flag sets the mouse trail either on or off. The mouse trail is useful on laptop/notebook computers where the cursor is sometimes difficult to find. This option is only available if the mouse driver was loaded with cursor enhancements. TON Turns on the mouse trail for text video modes TOFF Turns off the mouse trail 2.8 Device Type This setting allows you to force the mouse driver to look for the type of mouse attached. If the device is not found, it will search for the other types. BUS Search for a bus mouse SER Search for a serial mouse INP Search for a Microsoft Inport mouse PS2 Search for a PS/2 mouse 2.9 Drag Lock Drag lock lets you drag an object without having to hold down a mouse button as you move the mouse. When you click the mouse button assigned to Drag Lock, the driver interprets this as though you were pressing and holding down the left mouse button. Simply moving your mouse performs the drag. To end the drag, click the assigned mouse button again. DMIDDLE Sets the drag lock function to the middle button. This drags the left (primary) button. DRIGHT Sets the drag lock function to the right button. This drags the left (primary) button. DBOTH Sets the drag lock function to both the middle and right buttons. This drags the left (primary) button. DNONE Disables the mouse drag lock effect. 2.10 Mouse Speed You can make the mouse move faster or slower relative to the distance in which you move your mouse. By setting the speed very fast (e.g. S10), you can move your mouse a very small distance to sweep the mouse cursor from one side of the screen to the other. A slow speed setting (e.g. S01) requires that you move the mouse a greater distance to sweep the cursor from one side of the screen to the other. S00 - S10 Values range from S00 (slow) to S10 (fast) 2.11 Orientation This option is useful for the TrackMan Portable. Orientation sets the direction to which the mouse ball must be moved in order to move the mouse cursor in a given direction on the screen. The valid angles are from 0 to 359 degrees in one degree steps (Default: 0). ORIENT=0-359 0 Sets the orientation to north (default). This setting is mainly used by right-handed people. Rolling the track ball away from you moves the cursor up. 180 Sets the orientation to south. This setting is mainly used by left-handed people. Rolling the track ball away from you moves the cursor up. 90 Sets the orientation to west. This setting can be used by both left- and right-handed people. Rolling the track ball up moves the cursor up. 270 Sets the orientation to east. Though supported, this option is not useful for the TrackMan Portable. 2.12 Memory The memory options allow to specify where in memory the driver will be resident. The options related to the stub are applicable only when the driver is loaded in extended memory. MEMA Place the driver in extended memory if possible MEMU Place the driver in upper memory if possible MEMC Place the driver in conventional memory MEMSA Place the stub in upper memory if possible MEMSC Place the stub in conventional memory 2.13 Miscellaneous The following lists the miscellaneous options available to the mouse driver. ? Displays the mouse configuration information /? Display the list of options INIT Resets the mouse to the factory default settings NOINI Loads the driver without using the MOUSEDRV.INI file settings. The driver default settings will be used. NOVCI Loads the driver without Super VGA support. (Default) VCI Enable loading of an external video module OUT Removes the mouse driver from memory CENHANCE Loads the mouse driver with cursor enhancement NOCENHANCE Loads the mouse driver without cursor enhancement 3. VESA Super VGA Support 3.1 VESA Background The VGA standard was established by IBM to define a video architecture and video mode. Super VGA is loosely defined as anything above the VGA standard. This includes higher resolutions (e.g. 800 x 600 for VESA mode 100h) and greater or equal number of colors (e.g. 256 colors for VESA mode 103h). While many video manufacturers follow the VGA standard, some add their own custom enhancements. VESA (Video Electronics Standard Association) was formed to bring together the different video schemes, and to give direction to the future of video standards for the IBM personal computer. 3.2 VCI Background Under DOS, many applications require the mouse driver to draw the mouse cursor. To do this, the mouse driver must have knowledge of the underlying video architecture and video mode being displayed. This present problems as video boards surpass the VGA limit. As video boards become more complex the mouse driver must be expanded to handle all situations. To remedy this, both VESA and Logitech Inc. have established the Video Cursor Interface (VCI) Standard. This standard outlines the interface between an input device, such as a mouse, and a small overlay program containing hardware dependent cursor movement and drawing code. The host (or mouse driver in this case) calls the VCI module to perform all cursor functions. The host need not have any knowledge of the cursor drawing software/hardware. The VCI module can be implemented in one of three forms: - as an overlay program that the host program loads, - as a TSR/device driver program that redirects INT 10h to itself, - as a ROM resident code. 3.3 The Logitech DOS mouse driver and VCI Module The Logitech mouse driver contains video cursor support for CGA, EGA, VGA and VESA Super VGA video modes version 1.1. Although this code will work with all these video modes, video manufacturers might provide a VCI module to take advantage of special features in their hardware. During initialization, the MOUSE driver will search MOUSEDRV.INI for the location of a VCI module if the UseVCIOverlay is enabled. Refer to Section 1 for more information on MOUSEDRV.INI. If an overlay file is specified, the mouse driver loads it into memory, then calls the VCI module initialization routine. If initialization is successful, the overlay code is copied into the mouse driver, becoming part of the resident mouse driver. If initialization fails, the mouse driver uses it's default video cursor code. 3.4 Other Operating Environments/Systems Under other operating environments (Windows, GEM) and operating systems (OS/2, UNIX) the mouse driver is not required to display the cursor on the video screen. The mouse driver simply acquires button and movement information and passes it to the operating environment/system which does the rest of the work. The VCI does not apply to such operating environments/systems. 3.6 Loading VCI Overlay Modules To change the overlay file being used, edit MOUSEDRV.INI as follows: [Display] VideoModule=DRIVE:PATH\NEW_OVL.OVL where NEW_OVL.OVL is the name of the new overlay program. The DRIVE:PATH are needed if the overlay is not located in the mouse driver's directory. 3.7 ROM Resident Overlay or TSR's Some video manufacturers may put their video overlay code in the ROM BIOS or in a TSR (Terminate and Stay Resident) program. The video manufacturer should provide information to the user about this. To enable the mouse driver to search for a BIOS VCI implementation or TSR, edit MOUSEDRV.INI as follows: [Display] VideoModule=RESIDENT This tells the mouse driver to search for the video overlay that is already present in memory. 3.8 Disabling VCI module loading To disable the usage of a VCI overlay, edit MOUSEDRV.INI. Either remove the filename: [Display] VideoModule= or set the UseVCIOverlay keyname to disabled: [Display] UseVCIOverlay=Off VideoModule=VCI.OVL Alternatively, on the first call to the DOS mouse driver, type: MOUSE NOVCI NOVCI forces the mouse driver to use it's internal video code. 4. DOS Mouse Driver Memory Management 4.1 DOS Memory Regions The DOS operating system and the PC architecture sudivided the memory available on a computer in different regions. These regions are: Conventional Memory: Conventional memory is the first 640K of memory. This is the memory that all DOS applications use. Upper Memory Block (UMB): The upper memory area was originally defined as a region reserved for system hardware like the video or hard-disk controllers. With the advent of memory managers, unused portions of this area are available for storing DOS device drivers and TSR. It contains a maximum of 384K of memory. High Memory Area (HMA): The high memory area is the first 64K of extended memory. The himem.sys or third-party memory managers are often used by DOS to access this part of the memory. This is where DOS is often stored. Extended Memory: Extended memory is any region above one megabyte. DOS is unable to use this memory without the use of an additional memory manager. This memory is often used by programs to store data. As DOS applications have increased in sophistication, they have also increased in size. Since all DOS applications must run, at least in part, in conventional memory, it is desirable that as much conventional memory as possible be kept free. On today's systems, with the software needed to run their sound cards, mice and other peripherals, this is increasingly difficult. The adroit user will place the software for these devices in upper memory, but this area has also become increasingly crowded. Abetting this so called "ram cram" is the design goal of the DOS mouse driver memory management. 4.2 Cloaking Interface This interface allows software to load and run in extended memory, and is provided by the CLOAKING.EXE program. This file should be loaded after a compatible memory manager and prior to the DOS mouse driver. Once executed, it will stay in memory using about 1K of conventional memory. When the DOS mouse driver loads, it will check for the existence of this interface. If it finds it and is configured to use it (see command line parameters), the mouse driver will relocate itself in extended memory and use a mere 1K of conventional or upper memory. This approximately 1K size memory block is called the stub and provides the entry points that program using a mouse expect. The bulk of the driver is running in protected mode in extended memory. 4.3 DOS Driver Memory Location By default, the DOS mouse driver will load in the best location possible in memory. If the cloaking interface is present, the driver will load in extended memory. If not, the driver checks for available space in the upper memory blocks and relocates itself there. Otherwise, the driver will stay in conventional memory. To allow for different configuration, the memory location of the driver can be forced through the use of command line flags. Note: the driver will try to satisfy the requested memory flags but in case of failure, it will automatically use the next lower memory allocation strategy. ------------------------------------------------------------------------- End of file MOUSEDRV.TXT -------------------------------------------------------------------------