xenocara/xserver/hw/xfree86/os-support/solaris/sun_mouse.c
2006-11-26 18:13:41 +00:00

718 lines
19 KiB
C

/*
* Copyright 1999-2001 The XFree86 Project, Inc. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* XFREE86 PROJECT BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Except as contained in this notice, the name of the XFree86 Project shall
* not be used in advertising or otherwise to promote the sale, use or other
* dealings in this Software without prior written authorization from the
* XFree86 Project.
*/
/* Copyright 2004-2005 Sun Microsystems, Inc. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, and/or sell copies of the Software, and to permit persons
* to whom the Software is furnished to do so, provided that the above
* copyright notice(s) and this permission notice appear in all copies of
* the Software and that both the above copyright notice(s) and this
* permission notice appear in supporting documentation.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
* OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
* INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* Except as contained in this notice, the name of a copyright holder
* shall not be used in advertising or otherwise to promote the sale, use
* or other dealings in this Software without prior written authorization
* of the copyright holder.
*/
#ifdef HAVE_XORG_CONFIG_H
#include <xorg-config.h>
#endif
#include "xf86.h"
#include "xf86_OSlib.h"
#include "xf86OSmouse.h"
#if defined(__SOL8__) || !defined(__i386)
#include "xisb.h"
#include "mipointer.h"
#include <sys/stropts.h>
#include <sys/vuid_event.h>
#include <sys/msio.h>
/* Wheel mouse support in VUID drivers in Solaris 9 updates & Solaris 10 */
#ifdef WHEEL_DEVID /* Defined in vuid_event.h if VUID wheel support present */
# define HAVE_VUID_WHEEL
#endif
#ifdef HAVE_VUID_WHEEL
# include <sys/vuid_wheel.h>
#endif
/* Support for scaling absolute coordinates to screen size in
* Solaris 10 updates and beyond */
#if !defined(HAVE_ABSOLUTE_MOUSE_SCALING)
# ifdef MSIOSRESOLUTION /* Defined in msio.h if scaling support present */
# define HAVE_ABSOLUTE_MOUSE_SCALING
# endif
#endif
/* Names of protocols that are handled internally here. */
static const char *internalNames[] = {
"VUID",
NULL
};
static const char *solarisMouseDevs[] = {
/* Device file: Protocol: */
"/dev/mouse", "VUID", /* USB or SPARC */
#if defined(__i386) || defined(__x86)
"/dev/kdmouse", "PS/2", /* PS/2 */
#endif
NULL
};
typedef struct _VuidMseRec {
struct _VuidMseRec *next;
InputInfoPtr pInfo;
Firm_event event;
unsigned char * buffer;
char * strmod;
Bool(*wrapped_device_control)(DeviceIntPtr device, int what);
#ifdef HAVE_ABSOLUTE_MOUSE_SCALING
Ms_screen_resolution absres;
#endif
} VuidMseRec, *VuidMsePtr;
static VuidMsePtr vuidMouseList = NULL;
static int vuidMouseProc(DeviceIntPtr pPointer, int what);
static void vuidReadInput(InputInfoPtr pInfo);
#ifdef HAVE_ABSOLUTE_MOUSE_SCALING
static void vuidMouseSendScreenSize(ScreenPtr pScreen, VuidMsePtr pVuidMse);
static void vuidMouseAdjustFrame(int index, int x, int y, int flags);
static int vuidMouseGeneration = 0;
static int vuidMouseScreenIndex;
#define vuidMouseScreenPrivate(s) ((s)->devPrivates[vuidMouseScreenIndex].ptr)
#endif /* HAVE_ABSOLUTE_MOUSE_SCALING */
static inline
VuidMsePtr getVuidMsePriv(InputInfoPtr pInfo)
{
VuidMsePtr m = vuidMouseList;
while ((m != NULL) && (m->pInfo != pInfo)) {
m = m->next;
}
return m;
}
/*
* Initialize and enable the mouse wheel, if present.
*
* Returns 1 if mouse wheel was successfully enabled.
* Returns 0 if an error occurred or if there is no mouse wheel.
*/
static int
vuidMouseWheelInit(InputInfoPtr pInfo)
{
#ifdef HAVE_VUID_WHEEL
wheel_state wstate;
int nwheel = -1;
int i;
wstate.vers = VUID_WHEEL_STATE_VERS;
wstate.id = 0;
wstate.stateflags = -1;
SYSCALL(i = ioctl(pInfo->fd, VUIDGWHEELCOUNT, &nwheel));
if (i != 0)
return (0);
SYSCALL(i = ioctl(pInfo->fd, VUIDGWHEELSTATE, &wstate));
if (i != 0) {
xf86Msg(X_WARNING, "%s: couldn't get wheel state\n", pInfo->name);
return (0);
}
wstate.stateflags |= VUID_WHEEL_STATE_ENABLED;
SYSCALL(i = ioctl(pInfo->fd, VUIDSWHEELSTATE, &wstate));
if (i != 0) {
xf86Msg(X_WARNING, "%s: couldn't enable wheel\n", pInfo->name);
return (0);
}
return (1);
#else
return (0);
#endif
}
/* This function is called when the protocol is "VUID". */
static Bool
vuidPreInit(InputInfoPtr pInfo, const char *protocol, int flags)
{
MouseDevPtr pMse = pInfo->private;
VuidMsePtr pVuidMse;
int buttons, i;
pVuidMse = xcalloc(sizeof(VuidMseRec), 1);
if (pVuidMse == NULL) {
xf86Msg(X_ERROR, "%s: cannot allocate VuidMouseRec\n", pInfo->name);
xfree(pMse);
return FALSE;
}
pMse->protocol = protocol;
xf86Msg(X_CONFIG, "%s: Protocol: %s\n", pInfo->name, protocol);
/* Collect the options, and process the common options. */
xf86CollectInputOptions(pInfo, NULL, NULL);
xf86ProcessCommonOptions(pInfo, pInfo->options);
/* Check if the device can be opened. */
pInfo->fd = xf86OpenSerial(pInfo->options);
if (pInfo->fd == -1) {
if (xf86GetAllowMouseOpenFail())
xf86Msg(X_WARNING, "%s: cannot open input device\n", pInfo->name);
else {
xf86Msg(X_ERROR, "%s: cannot open input device\n", pInfo->name);
xfree(pVuidMse);
xfree(pMse);
return FALSE;
}
}
pVuidMse->buffer = (unsigned char *)&pVuidMse->event;
pVuidMse->strmod = xf86SetStrOption(pInfo->options, "StreamsModule", NULL);
if (pVuidMse->strmod) {
SYSCALL(i = ioctl(pInfo->fd, I_PUSH, pVuidMse->strmod));
if (i < 0) {
xf86Msg(X_ERROR,
"%s: cannot push module '%s' onto mouse device: %s\n",
pInfo->name, pVuidMse->strmod, strerror(errno));
xf86CloseSerial(pInfo->fd);
pInfo->fd = -1;
xfree(pVuidMse->strmod);
xfree(pVuidMse);
xfree(pMse);
return FALSE;
}
}
buttons = xf86SetIntOption(pInfo->options, "Buttons", 0);
if (buttons == 0) {
SYSCALL(i = ioctl(pInfo->fd, MSIOBUTTONS, &buttons));
if (i == 0) {
pInfo->conf_idev->commonOptions =
xf86ReplaceIntOption(pInfo->conf_idev->commonOptions,
"Buttons", buttons);
xf86Msg(X_INFO, "%s: Setting Buttons option to \"%d\"\n",
pInfo->name, buttons);
}
}
if (pVuidMse->strmod) {
SYSCALL(i = ioctl(pInfo->fd, I_POP, pVuidMse->strmod));
if (i == -1) {
xf86Msg(X_WARNING,
"%s: cannot pop module '%s' off mouse device: %s\n",
pInfo->name, pVuidMse->strmod, strerror(errno));
}
}
xf86CloseSerial(pInfo->fd);
pInfo->fd = -1;
/* Process common mouse options (like Emulate3Buttons, etc). */
pMse->CommonOptions(pInfo);
/* Setup the local procs. */
pVuidMse->wrapped_device_control = pInfo->device_control;
pInfo->device_control = vuidMouseProc;
pInfo->read_input = vuidReadInput;
pMse->xisbscale = sizeof(Firm_event);
#ifdef HAVE_ABSOLUTE_MOUSE_SCALING
pVuidMse->absres.height = pVuidMse->absres.width = 0;
#endif
pVuidMse->pInfo = pInfo;
pVuidMse->next = vuidMouseList;
vuidMouseList = pVuidMse;
pInfo->flags |= XI86_CONFIGURED;
return TRUE;
}
static void
vuidFlushAbsEvents(InputInfoPtr pInfo, int absX, int absY,
Bool *absXset, Bool *absYset)
{
#ifdef DEBUG
ErrorF("vuidFlushAbsEvents: %d,%d (set: %d, %d)\n", absX, absY,
*absXset, *absYset);
#endif
if ((*absXset) && (*absYset)) {
xf86PostMotionEvent(pInfo->dev,
/* is_absolute: */ TRUE,
/* first_valuator: */ 0,
/* num_valuators: */ 2,
absX, absY);
} else if (*absXset) {
xf86PostMotionEvent(pInfo->dev,
/* is_absolute: */ TRUE,
/* first_valuator: */ 0,
/* num_valuators: */ 1,
absX);
} else if (*absYset) {
xf86PostMotionEvent(pInfo->dev,
/* is_absolute: */ TRUE,
/* first_valuator: */ 1,
/* num_valuators: */ 1,
absY);
}
*absXset = FALSE;
*absYset = FALSE;
}
static void
vuidReadInput(InputInfoPtr pInfo)
{
MouseDevPtr pMse;
VuidMsePtr pVuidMse;
int buttons;
int dx = 0, dy = 0, dz = 0, dw = 0;
unsigned int n;
int c;
unsigned char *pBuf;
int wmask;
int absX, absY;
Bool absXset = FALSE, absYset = FALSE;
pMse = pInfo->private;
pVuidMse = getVuidMsePriv(pInfo);
buttons = pMse->lastButtons;
XisbBlockDuration(pMse->buffer, -1);
pBuf = pVuidMse->buffer;
n = 0;
do {
while (n < sizeof(Firm_event) && (c = XisbRead(pMse->buffer)) >= 0) {
pBuf[n++] = (unsigned char)c;
}
if (n == 0)
return;
if (n != sizeof(Firm_event)) {
xf86Msg(X_WARNING, "%s: incomplete packet, size %d\n",
pInfo->name, n);
}
#ifdef DEBUG
ErrorF("vuidReadInput: event type: %3d value: %5d\n",
pVuidMse->event.id, pVuidMse->event.value);
#endif
if (pVuidMse->event.id >= BUT_FIRST && pVuidMse->event.id <= BUT_LAST) {
/* button */
int butnum = pVuidMse->event.id - BUT_FIRST;
if (butnum < 3)
butnum = 2 - butnum;
if (!pVuidMse->event.value)
buttons &= ~(1 << butnum);
else
buttons |= (1 << butnum);
} else if (pVuidMse->event.id >= VLOC_FIRST &&
pVuidMse->event.id <= VLOC_LAST) {
/* axis */
int delta = pVuidMse->event.value;
switch(pVuidMse->event.id) {
case LOC_X_DELTA:
dx += delta;
break;
case LOC_Y_DELTA:
dy -= delta;
break;
case LOC_X_ABSOLUTE:
if (absXset) {
vuidFlushAbsEvents(pInfo, absX, absY, &absXset, &absYset);
}
absX = delta;
absXset = TRUE;
break;
case LOC_Y_ABSOLUTE:
if (absYset) {
vuidFlushAbsEvents(pInfo, absX, absY, &absXset, &absYset);
}
absY = delta;
absYset = TRUE;
break;
}
}
#ifdef HAVE_VUID_WHEEL
else if (vuid_in_range(VUID_WHEEL, pVuidMse->event.id)) {
if (vuid_id_offset(pVuidMse->event.id) == 0)
dz -= VUID_WHEEL_GETDELTA(pVuidMse->event.value);
else
dw -= VUID_WHEEL_GETDELTA(pVuidMse->event.value);
}
#endif
#ifdef HAVE_ABSOLUTE_MOUSE_SCALING
else if (pVuidMse->event.id == MOUSE_TYPE_ABSOLUTE) {
/* force sending absolute resolution scaling ioctl */
pVuidMse->absres.height = pVuidMse->absres.width = 0;
vuidMouseSendScreenSize(miPointerCurrentScreen(), pVuidMse);
}
#endif
n = 0;
if ((c = XisbRead(pMse->buffer)) >= 0) {
/* Another packet. Handle it right away. */
pBuf[n++] = c;
}
} while (n != 0);
if (absXset || absYset) {
vuidFlushAbsEvents(pInfo, absX, absY, &absXset, &absYset);
}
pMse->PostEvent(pInfo, buttons, dx, dy, dz, dw);
return;
}
#ifdef HAVE_ABSOLUTE_MOUSE_SCALING
static void vuidMouseSendScreenSize(ScreenPtr pScreen, VuidMsePtr pVuidMse)
{
InputInfoPtr pInfo = pVuidMse->pInfo;
ScrnInfoPtr pScr = XF86SCRNINFO(pScreen);
int result;
if ((pVuidMse->absres.width != pScr->currentMode->HDisplay) ||
(pVuidMse->absres.height != pScr->currentMode->VDisplay))
{
pVuidMse->absres.width = pScr->currentMode->HDisplay;
pVuidMse->absres.height = pScr->currentMode->VDisplay;
do {
result = ioctl(pInfo->fd, MSIOSRESOLUTION, &(pVuidMse->absres));
} while ( (result != 0) && (errno == EINTR) );
if (result != 0) {
xf86Msg(X_WARNING,
"%s: couldn't set absolute mouse scaling resolution: %s\n",
pInfo->name, strerror(errno));
#ifdef DEBUG
} else {
xf86Msg(X_INFO,
"%s: absolute mouse scaling resolution set to %d x %d\n",
pInfo->name,
pVuidMse->absres.width, pVuidMse->absres.height);
#endif
}
}
}
static void vuidMouseAdjustFrame(int index, int x, int y, int flags)
{
ScrnInfoPtr pScrn = xf86Screens[index];
ScreenPtr pScreen = pScrn->pScreen;
xf86AdjustFrameProc *wrappedAdjustFrame
= (xf86AdjustFrameProc *) vuidMouseScreenPrivate(pScreen);
VuidMsePtr m;
if(wrappedAdjustFrame) {
pScrn->AdjustFrame = wrappedAdjustFrame;
(*pScrn->AdjustFrame)(index, x, y, flags);
pScrn->AdjustFrame = vuidMouseAdjustFrame;
}
if (miPointerCurrentScreen() == pScreen) {
for (m = vuidMouseList; m != NULL ; m = m->next) {
vuidMouseSendScreenSize(pScreen, m);
}
}
}
#endif /* HAVE_ABSOLUTE_MOUSE_SCALING */
static int
vuidMouseProc(DeviceIntPtr pPointer, int what)
{
InputInfoPtr pInfo;
MouseDevPtr pMse;
VuidMsePtr pVuidMse;
int ret = Success;
int i;
pInfo = pPointer->public.devicePrivate;
pMse = pInfo->private;
pMse->device = pPointer;
pVuidMse = getVuidMsePriv(pInfo);
if (pVuidMse == NULL) {
return BadImplementation;
}
switch (what) {
case DEVICE_INIT:
#ifdef HAVE_ABSOLUTE_MOUSE_SCALING
if (vuidMouseGeneration != serverGeneration) {
if ((vuidMouseScreenIndex = AllocateScreenPrivateIndex()) >= 0) {
for (i = 0; i < screenInfo.numScreens; i++) {
ScreenPtr pScreen = screenInfo.screens[i];
ScrnInfoPtr pScrn = XF86SCRNINFO(pScreen);
vuidMouseScreenPrivate(pScreen)
= (pointer) pScrn->AdjustFrame;
pScrn->AdjustFrame = vuidMouseAdjustFrame;
}
}
vuidMouseGeneration = serverGeneration;
}
#endif
ret = pVuidMse->wrapped_device_control(pPointer, what);
break;
case DEVICE_ON:
ret = pVuidMse->wrapped_device_control(pPointer, DEVICE_ON);
if ((ret == Success) && (pInfo->fd != -1)) {
int fmt = VUID_FIRM_EVENT;
if (pVuidMse->strmod) {
SYSCALL(i = ioctl(pInfo->fd, I_PUSH, pVuidMse->strmod));
if (i < 0) {
xf86Msg(X_WARNING,
"%s: cannot push module '%s' onto mouse device: %s\n",
pInfo->name, pVuidMse->strmod, strerror(errno));
xfree(pVuidMse->strmod);
pVuidMse->strmod = NULL;
}
}
SYSCALL(i = ioctl(pInfo->fd, VUIDSFORMAT, &fmt));
if (i < 0) {
xf86Msg(X_WARNING,
"%s: cannot set mouse device to VUID mode: %s\n",
pInfo->name, strerror(errno));
}
vuidMouseWheelInit(pInfo);
#ifdef HAVE_ABSOLUTE_MOUSE_SCALING
vuidMouseSendScreenSize(screenInfo.screens[0], pVuidMse);
#endif
xf86FlushInput(pInfo->fd);
}
break;
case DEVICE_OFF:
case DEVICE_CLOSE:
if (pInfo->fd != -1) {
if (pVuidMse->strmod) {
SYSCALL(i = ioctl(pInfo->fd, I_POP, pVuidMse->strmod));
if (i == -1) {
xf86Msg(X_WARNING,
"%s: cannot pop module '%s' off mouse device: %s\n",
pInfo->name, pVuidMse->strmod, strerror(errno));
}
}
}
ret = pVuidMse->wrapped_device_control(pPointer, what);
break;
default: /* Should never be called, but just in case */
ret = pVuidMse->wrapped_device_control(pPointer, what);
break;
}
return ret;
}
static Bool
sunMousePreInit(InputInfoPtr pInfo, const char *protocol, int flags)
{
/* The protocol is guaranteed to be one of the internalNames[] */
if (xf86NameCmp(protocol, "VUID") == 0) {
return vuidPreInit(pInfo, protocol, flags);
}
return TRUE;
}
static const char **
BuiltinNames(void)
{
return internalNames;
}
static Bool
CheckProtocol(const char *protocol)
{
int i;
for (i = 0; internalNames[i]; i++)
if (xf86NameCmp(protocol, internalNames[i]) == 0)
return TRUE;
return FALSE;
}
static const char *
DefaultProtocol(void)
{
return "Auto";
}
static Bool
solarisMouseAutoProbe(InputInfoPtr pInfo, const char **protocol,
const char **device)
{
const char **pdev, **pproto, *dev = NULL;
int fd = -1;
Bool found;
for (pdev = solarisMouseDevs; *pdev; pdev += 2) {
pproto = pdev + 1;
if ((*protocol != NULL) && (strcmp(*protocol, "Auto") != 0) &&
(*pproto != NULL) && (strcmp(*pproto, *protocol) != 0)) {
continue;
}
if ((*device != NULL) && (strcmp(*device, *pdev) != 0)) {
continue;
}
SYSCALL (fd = open(*pdev, O_RDWR | O_NONBLOCK));
if (fd == -1) {
#ifdef DEBUG
ErrorF("Cannot open %s (%s)\n", pdev, strerror(errno));
#endif
} else {
found = TRUE;
if ((*pproto != NULL) && (strcmp(*pproto, "VUID") == 0)) {
int i, r;
SYSCALL(r = ioctl(fd, VUIDGFORMAT, &i));
if (r < 0) {
found = FALSE;
}
}
close(fd);
if (found == TRUE) {
if (*pproto != NULL) {
*protocol = *pproto;
}
*device = *pdev;
return TRUE;
}
}
}
return FALSE;
}
static const char *
SetupAuto(InputInfoPtr pInfo, int *protoPara)
{
const char *pdev = NULL;
const char *pproto = NULL;
MouseDevPtr pMse = pInfo->private;
if (pInfo->fd == -1) {
/* probe to find device/protocol to use */
if (solarisMouseAutoProbe(pInfo, &pproto, &pdev) != FALSE) {
/* Set the Device option. */
pInfo->conf_idev->commonOptions =
xf86AddNewOption(pInfo->conf_idev->commonOptions, "Device", pdev);
xf86Msg(X_INFO, "%s: Setting Device option to \"%s\"\n",
pInfo->name, pdev);
}
} else if (pMse->protocolID == PROT_AUTO) {
pdev = xf86CheckStrOption(pInfo->conf_idev->commonOptions,
"Device", NULL);
solarisMouseAutoProbe(pInfo, &pproto, &pdev);
}
return pproto;
}
static const char *
FindDevice(InputInfoPtr pInfo, const char *protocol, int flags)
{
const char *pdev = NULL;
const char *pproto = protocol;
if (solarisMouseAutoProbe(pInfo, &pproto, &pdev) != FALSE) {
/* Set the Device option. */
pInfo->conf_idev->commonOptions =
xf86AddNewOption(pInfo->conf_idev->commonOptions, "Device", pdev);
xf86Msg(X_INFO, "%s: Setting Device option to \"%s\"\n",
pInfo->name, pdev);
}
return pdev;
}
#else /* __SOL8__ || !__i386 */
#undef MSE_MISC
#define MSE_MISC 0
#endif /* !__SOL8__ && __i386 */
static int
SupportedInterfaces(void)
{
/* XXX This needs to be checked. */
return MSE_SERIAL | MSE_BUS | MSE_PS2 | MSE_AUTO | MSE_XPS2 | MSE_MISC;
}
_X_EXPORT OSMouseInfoPtr
xf86OSMouseInit(int flags)
{
OSMouseInfoPtr p;
p = xcalloc(sizeof(OSMouseInfoRec), 1);
if (!p)
return NULL;
p->SupportedInterfaces = SupportedInterfaces;
#if defined(__SOL8__) || !defined(__i386)
p->BuiltinNames = BuiltinNames;
p->CheckProtocol = CheckProtocol;
p->PreInit = sunMousePreInit;
p->DefaultProtocol = DefaultProtocol;
p->SetupAuto = SetupAuto;
p->FindDevice = FindDevice;
#endif
return p;
}