2 * Copyright (c) 2001 Edouard TISSERANT <tissered@esstin.u-nancy.fr>
3 * Parts inspired from Shane Watts <shane@bofh.asn.au> XFree86 3 Acecad Driver
4 * Thanks to Emily, from AceCad, For giving me documents.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
21 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 /* $XFree86: xc/programs/Xserver/hw/xfree86/input/acecad/acecad.c,v 1.4 2003/10/30 00:40:45 dawes Exp $ */
31 /*****************************************************************************
33 ****************************************************************************/
36 #include <asm/types.h>
37 #include <linux/input.h>
52 #ifndef NEED_XF86_TYPES
53 #define NEED_XF86_TYPES
55 #include <xf86_OSproc.h>
57 #include <xf86Xinput.h>
59 #include <xf86Module.h>
68 /*****************************************************************************
70 ****************************************************************************/
73 /*****************************************************************************
74 * Variables without includable headers
75 ****************************************************************************/
77 /*****************************************************************************
79 ****************************************************************************/
82 #define read(a,b,c) xf86ReadSerial((a),(b),(c))
84 /* max number of input events to read in one read call */
87 _X_EXPORT InputDriverRec ACECAD =
99 static XF86ModuleVersionInfo VersionRec =
105 XORG_VERSION_CURRENT,
106 PACKAGE_VERSION_MAJOR, PACKAGE_VERSION_MINOR, PACKAGE_VERSION_PATCHLEVEL,
114 _X_EXPORT XF86ModuleData acecadModuleData = {
120 /*****************************************************************************
121 * Function Definitions
122 ****************************************************************************/
125 SetupProc( pointer module,
130 xf86AddInputDriver(&ACECAD, module, 0);
135 TearDownProc( pointer p )
138 LocalDevicePtr local = (LocalDevicePtr) p;
139 AceCadPrivatePtr priv = (AceCadPrivatePtr) local->private;
141 DeviceOff (local->dev);
143 xf86CloseSerial (local->fd);
144 XisbFree (priv->buffer);
152 static const char *default_options[] =
160 "FlowControl", "Xoff",
171 SYSCALL(err = ioctl(fd, EVIOCGVERSION, &version));
174 xf86MsgVerb(X_PROBED, 4, "Kernel Input driver version is %d.%d.%d\n",
175 version >> 16, (version >> 8) & 0xff, version & 0xff);
178 xf86MsgVerb(X_PROBED, 4, "No Kernel Input driver found\n");
185 AceCadPreInit(InputDriverPtr drv, IDevPtr dev, int flags)
187 LocalDevicePtr local = xf86AllocateInput(drv, 0);
188 AceCadPrivatePtr priv = xcalloc (1, sizeof (AceCadPrivateRec));
193 if ((!local) || (!priv))
196 memset(priv,0,sizeof (AceCadPrivateRec));
198 local->name = dev->identifier;
199 local->type_name = "ACECAD Tablet";
200 local->flags = XI86_POINTER_CAPABLE | XI86_SEND_DRAG_EVENTS;
201 local->motion_history_proc = xf86GetMotionEvents;
202 local->control_proc = NULL;
203 local->close_proc = CloseProc;
204 local->switch_mode = NULL;
205 local->conversion_proc = ConvertProc;
206 local->reverse_conversion_proc = ReverseConvertProc;
208 local->private = priv;
209 local->private_flags = 0;
210 local->conf_idev = dev;
211 local->device_control = DeviceControl;
212 /*local->always_core_feedback = 0;*/
214 xf86CollectInputOptions(local, default_options, NULL);
216 xf86OptionListReport(local->options);
218 priv->acecadInc = xf86SetIntOption(local->options, "Increment", 0 );
220 local->fd = xf86OpenSerial (local->options);
223 xf86Msg(X_ERROR, "%s: unable to open device\n", local->name);
226 xf86ErrorFVerb( 6, "tty port opened successfully\n" );
229 if(IsUSBLine(local->fd)){
232 local->read_input = USBReadInput;
234 if (USBQueryHardware(local) != Success)
236 xf86Msg(X_ERROR, "%s: unable to query/initialize hardware (not an %s?).\n", local->name, local->type_name);
244 local->read_input = ReadInput;
247 if (xf86FindOptionValue(local->options, "ReportSpeed")) {
249 speed = xf86SetIntOption(local->options, "ReportSpeed", 85 );
257 priv->acecadReportSpeed = 'Q';
260 priv->acecadReportSpeed = 'R';
263 priv->acecadReportSpeed = 'S';
266 priv->acecadReportSpeed = 'T';
269 priv->acecadReportSpeed = 'R';
271 xf86Msg(X_ERROR, "%s: ReportSpeed value %d invalid. Possible values: 120, 85, 10, 2. Defaulting to 85\n", local->name, speed);
275 xf86Msg(msgtype, "%s report %d points/s\n", local->name, speed);
277 priv->buffer = XisbNew (local->fd, 200);
280 * Verify that hardware is attached and fuctional
282 if (QueryHardware(priv) != Success)
284 xf86Msg(X_ERROR, "%s: unable to query/initialize hardware (not an %s?).\n", local->name, local->type_name);
289 s = xf86FindOptionValue(local->options, "Mode");
290 msgtype = s ? X_CONFIG : X_DEFAULT;
291 if (s && (xf86NameCmp(s, "Relative") == 0))
293 priv->flags = priv->flags & ~ABSOLUTE_FLAG;
297 priv->flags = priv->flags | ABSOLUTE_FLAG;
300 xf86Msg(msgtype, "%s is in %s mode\n", local->name, (priv->flags & ABSOLUTE_FLAG) ? "absolute" : "relative");
301 DBG (9, XisbTrace (priv->buffer, 1));
303 local->history_size = xf86SetIntOption(local->options , "HistorySize", 0);
305 xf86ProcessCommonOptions(local, local->options);
307 local->flags |= XI86_CONFIGURED;
311 RemoveEnabledDevice (local->fd);
314 XisbFree(priv->buffer);
317 xf86CloseSerial(local->fd);
319 RemoveEnabledDevice (local->fd);
324 * If something went wrong, cleanup and return NULL
327 if ((local) && (local->fd))
328 xf86CloseSerial (local->fd);
329 if ((priv) && (priv->buffer))
330 XisbFree (priv->buffer);
337 DeviceControl (DeviceIntPtr dev, int mode)
348 RetValue = DeviceOn( dev );
351 RetValue = DeviceOff( dev );
354 RetValue = DeviceClose( dev );
364 DeviceOn (DeviceIntPtr dev)
367 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
368 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
370 xf86MsgVerb(X_INFO, 4, "%s Device On\n", local->name);
372 local->fd = xf86OpenSerial(local->options);
375 xf86Msg(X_WARNING, "%s: cannot open input device\n", local->name);
380 if (priv->acecadUSB==0){
381 priv->buffer = XisbNew(local->fd, 200);
384 xf86CloseSerial(local->fd);
389 /*Rets qu'a l'envoyer a la tablette */
390 sprintf(buffer, "%s%c%c%c%c", acecad_initstr, priv->acecadReportSpeed, ACECAD_INCREMENT, 32 + priv->acecadInc, (priv->flags & ABSOLUTE_FLAG)? ACECAD_ABSOLUTE: ACECAD_RELATIVE);
391 XisbWrite (priv->buffer, (unsigned char *)buffer, strlen(buffer));
394 xf86FlushInput(local->fd);
395 xf86AddEnabledDevice (local);
396 dev->public.on = TRUE;
401 DeviceOff (DeviceIntPtr dev)
403 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
404 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
406 xf86MsgVerb(X_INFO, 4, "%s Device Off\n", local->name);
410 RemoveEnabledDevice (local->fd);
413 XisbFree(priv->buffer);
416 xf86CloseSerial(local->fd);
420 xf86RemoveEnabledDevice (local);
421 dev->public.on = FALSE;
426 DeviceClose (DeviceIntPtr dev)
428 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
430 xf86MsgVerb(X_INFO, 4, "%s Device Close\n", local->name);
436 ControlProc(DeviceIntPtr dev, PtrCtrl *ctrl)
438 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
440 xf86MsgVerb(X_INFO, 4, "%s Control Proc\n", local->name);
444 DeviceInit (DeviceIntPtr dev)
447 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
448 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
449 unsigned char map[] =
452 xf86MsgVerb(X_INFO, 4, "%s Init\n", local->name);
455 if (InitButtonClassDeviceStruct (dev, 3, map) == FALSE)
457 xf86Msg(X_ERROR, "%s: unable to allocate ButtonClassDeviceStruct\n", local->name);
461 if (InitFocusClassDeviceStruct (dev) == FALSE)
463 xf86Msg(X_ERROR, "%s: unable to allocate FocusClassDeviceStruct\n", local->name);
467 if (InitPtrFeedbackClassDeviceStruct(dev, ControlProc) == FALSE) {
468 xf86Msg(X_ERROR, "%s: unable to init ptr feedback\n", local->name);
474 if (InitValuatorClassDeviceStruct (dev, 3, xf86GetMotionEvents,
476 ((priv->flags & ABSOLUTE_FLAG)? Absolute: Relative)|OutOfProximity)
479 xf86Msg(X_ERROR, "%s: unable to allocate ValuatorClassDeviceStruct\n", local->name);
485 InitValuatorAxisStruct(dev,
488 priv->acecadMaxX, /* max val */
489 1000, /* resolution */
492 InitValuatorAxisStruct(dev,
495 priv->acecadMaxY, /* max val */
496 1000, /* resolution */
499 InitValuatorAxisStruct(dev,
502 priv->acecadMaxZ, /* max val */
503 1000, /* resolution */
509 if (InitProximityClassDeviceStruct (dev) == FALSE)
511 xf86Msg(X_ERROR, "%s: unable to allocate ProximityClassDeviceStruct\n", local->name);
515 xf86MotionHistoryAllocate (local);
518 /* On ne peut pas calculer l'increment avant, faute d'ecran pour
519 connaitre la taille... */
521 if (priv->acecadInc > 95)
522 priv->acecadInc = 95;
523 if (priv->acecadInc < 1)
525 /* guess the best increment value given video mode */
526 rx=priv->acecadMaxX / screenInfo.screens[0]->width;
527 ry=priv->acecadMaxY / screenInfo.screens[0]->height;
529 priv->acecadInc = rx;
531 priv->acecadInc = ry;
532 if (priv->acecadInc < 1)
536 xf86Msg(X_INFO, "%s Increment: %d\n", local->name, priv->acecadInc);
542 ReadInput (LocalDevicePtr local)
546 int is_core_pointer, is_absolute;
547 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
549 /*xf86Msg(X_INFO, "ACECAD Tablet Read Input\n");*/
551 is_absolute = (priv->flags & ABSOLUTE_FLAG);
552 is_core_pointer = xf86IsCorePointer(local->dev);
555 * set blocking to -1 on the first call because we know there is data to
556 * read. Xisb automatically clears it after one successful read so that
557 * succeeding reads are preceeded buy a select with a 0 timeout to prevent
558 * read from blocking indefinately.
560 XisbBlockDuration (priv->buffer, -1);
562 while (AceCadGetPacket (priv) == Success)
564 x = (int)priv->packet[1] | ((int)priv->packet[2] << 7);
565 y = (int)priv->packet[3] | ((int)priv->packet[4] << 7);
567 if (!(priv->flags & ABSOLUTE_FLAG))
569 x = priv->packet[0] & XSIGN_BIT? x:-x;
570 y = priv->packet[0] & YSIGN_BIT? y:-y;
574 y = priv->acecadMaxY - y ;
578 z = ((int)priv->packet[5] << 2) |
579 (((int)priv->packet[6] & 0x01) << 1) |
580 (((int)priv->packet[6] & 0x10) >> 4);
582 buttons = ((int)priv->packet[0] & 0x07) |
583 ((int)priv->packet[6] & 0x02 << 2);
585 prox = (priv->packet[0] & PROXIMITY_BIT)? 0: 1;
589 if (!(priv->acecadOldProximity))
590 if (!is_core_pointer)
592 /*xf86Msg(X_INFO, "ACECAD Tablet ProxIN %d %d %d\n",x, y, z);*/
593 xf86PostProximityEvent(local->dev, 1, 0, 3 , x, y, z);
596 if ((is_absolute && ((priv->acecadOldX != x) || (priv->acecadOldY != y) || (priv->acecadOldZ != z)))
597 || (!is_absolute && (x || y)))
599 if (is_absolute || priv->acecadOldProximity)
601 /*xf86Msg(X_INFO, "ACECAD Tablet Motion %d %d %d\n", x, y, z);*/
602 xf86PostMotionEvent(local->dev, is_absolute, 0, 3, x, y, z);
606 if (priv->acecadOldButtons != buttons)
610 delta = buttons ^ priv->acecadOldButtons;
616 delta &= ~(1 << (id-1));
618 /*xf86Msg(X_INFO, "ACECAD Tablet Button %d 0x%x\n",id,(buttons&(1<<(id-1))));*/
619 xf86PostButtonEvent(local->dev, is_absolute, id, (buttons&(1<<(id-1))), 0, 3, x, y,z);
623 priv->acecadOldButtons = buttons;
624 priv->acecadOldX = x;
625 priv->acecadOldY = y;
626 priv->acecadOldZ = z;
627 priv->acecadOldProximity = prox;
631 if (!is_core_pointer)
632 if (priv->acecadOldProximity)
634 /*xf86Msg(X_INFO, "ACECAD Tablet ProxOUT %d %d %d\n",x, y, z);*/
635 xf86PostProximityEvent(local->dev, 0, 0, 3, x,y,z);
637 priv->acecadOldProximity = 0;
640 /*xf86Msg(X_INFO, "ACECAD Tablet Sortie Read Input\n");*/
644 #define set_bit(byte,nb,bit) (bit ? byte | (1<<nb) : byte & (~(1<<nb)))
646 USBReadInput (LocalDevicePtr local)
649 struct input_event * event;
650 char eventbuf[sizeof(struct input_event) * MAX_EVENTS];
651 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
652 int x = priv->acecadOldX;
653 int y = priv->acecadOldY;
654 int z = priv->acecadOldZ;
655 int prox = priv->acecadOldProximity;
656 int buttons = priv->acecadOldButtons;
659 is_core_pointer = xf86IsCorePointer(local->dev);
661 SYSCALL(len = read(local->fd, eventbuf, sizeof(eventbuf)));
664 xf86Msg(X_ERROR, "%s: error reading device: %s\n", local->name, strerror(errno));
668 for (event=(struct input_event *)eventbuf;
669 event<(struct input_event *)(eventbuf+len); event++) {
671 switch (event->type) {
672 case EV_SYN: /* 2.6.x */
673 if (event->code != SYN_REPORT)
674 xf86Msg(X_ERROR, "%s: unknown EV_SYN code %d\n", local->name, event->code);
677 switch (event->code) {
697 switch (event->code) {
703 buttons=set_bit(buttons,0,event->value);
707 buttons=set_bit(buttons,1,event->value);
711 buttons=set_bit(buttons,2,event->value);
716 xf86Msg(X_ERROR, "%s: unknown event type/code %d/%d\n", local->name, event->type, event->code);
717 } /* switch event->type */
719 /* Linux Kernel 2.6.x sends EV_SYN/SYN_REPORT as an event terminator,
720 * whereas 2.4.x sends EV_ABS/ABS_MISC. We have to support both.
722 if (!( (event->type == EV_SYN && event->code == SYN_REPORT) ||
723 (event->type == EV_ABS && event->code == ABS_MISC)
730 if (!(priv->acecadOldProximity))
731 if (!is_core_pointer)
733 xf86PostProximityEvent(local->dev, 1, 0, 3 , x, y, z);
737 xf86PostMotionEvent(local->dev, 1, 0, 3, x, y, z);
739 if (priv->acecadOldButtons != buttons)
743 delta = buttons ^ priv->acecadOldButtons;
749 delta &= ~(1 << (id-1));
751 xf86PostButtonEvent(local->dev, 1, id, (buttons&(1<<(id-1))), 0, 3, x, y,z);
757 if (!is_core_pointer)
758 if (priv->acecadOldProximity)
760 xf86PostProximityEvent(local->dev, 0, 0, 3, x,y,z);
762 priv->acecadOldProximity = 0;
765 priv->acecadOldButtons = buttons;
766 priv->acecadOldX = x;
767 priv->acecadOldY = y;
768 priv->acecadOldZ = z;
769 priv->acecadOldProximity = prox;
771 /*xf86Msg(X_INFO, "ACECAD Tablet Sortie Read Input\n");*/
776 CloseProc (LocalDevicePtr local)
781 * The ConvertProc function may need to be tailored for your device.
782 * This function converts the device's valuator outputs to x and y coordinates
783 * to simulate mouse events.
786 ConvertProc (LocalDevicePtr local,
798 AceCadPrivatePtr priv = (AceCadPrivatePtr)(local->private);
800 *x = v0 * screenInfo.screens[0]->width / priv->acecadMaxX;
801 *y = v1 * screenInfo.screens[0]->height / priv->acecadMaxY;
807 ReverseConvertProc( LocalDevicePtr local,
812 AceCadPrivatePtr priv = (AceCadPrivatePtr)(local->private);
814 valuators[0] = x * priv->acecadMaxX / screenInfo.screens[0]->width;
815 valuators[1] = y * priv->acecadMaxY / screenInfo.screens[0]->height;
821 #define WriteString(str)\
822 XisbWrite (priv->buffer, (unsigned char *)(str), strlen(str))
826 QueryHardware (AceCadPrivatePtr priv)
835 /* Prompt Mode in order to not be disturbed */
836 WriteString(ACECAD_PROMPT_MODE);
839 while(XisbRead(priv->buffer)>=0);
841 /* Ask for Config packet*/
842 WriteString(ACECAD_CONFIG);
844 /* Read the packet */
845 XisbBlockDuration (priv->buffer, 1000000);
848 /*xf86Msg(X_CONFIG, "ACECAD Tablet init envoyé \n");*/
850 if ((AceCadGetPacket (priv) == Success))
852 priv->acecadMaxX = (int)priv->packet[1] + ((int)priv->packet[2] << 7);
853 priv->acecadMaxY = (int)priv->packet[3] + ((int)priv->packet[4] << 7);
854 priv->acecadMaxZ = 512;
855 xf86Msg(X_PROBED, "ACECAD Tablet MaxX:%d MaxY:%d\n", priv->acecadMaxX, priv->acecadMaxY);
860 /*xf86Msg(X_INFO, "ACECAD Tablet query hardware fini \n");*/
864 #define BITS_PER_LONG (sizeof(long) * 8)
865 #define NBITS(x) ((((x)-1)/BITS_PER_LONG)+1)
866 #define test_bit(bit, array) ((array[LONG(bit)] >> OFF(bit)) & 1)
867 #define OFF(x) ((x)%BITS_PER_LONG)
868 #define LONG(x) ((x)/BITS_PER_LONG)
872 USBQueryHardware (LocalDevicePtr local)
874 AceCadPrivatePtr priv = (AceCadPrivatePtr) local->private;
875 unsigned long bit[EV_MAX][NBITS(KEY_MAX)];
878 char name[256] = "Unknown";
880 ioctl(local->fd, EVIOCGNAME(sizeof(name)), name);
881 xf86MsgVerb(X_PROBED, 4, "Kernel Input device name: \"%s\"\n", name);
883 memset(bit, 0, sizeof(bit));
884 ioctl(local->fd, EVIOCGBIT(0, EV_MAX), bit[0]);
886 for (i = 0; i < EV_MAX; i++)
887 if (test_bit(i, bit[0])) {
888 ioctl(local->fd, EVIOCGBIT(i, KEY_MAX), bit[i]);
889 for (j = 0; j < KEY_MAX; j++)
890 if (test_bit(j, bit[i])) {
892 ioctl(local->fd, EVIOCGABS(j), abs);
895 priv->acecadMaxX = abs[2];
899 priv->acecadMaxY = abs[2];
903 priv->acecadMaxZ = abs[2];
910 xf86Msg(X_PROBED, "ACECAD Tablet MaxX:%d MaxY:%d MaxZ:%d\n", priv->acecadMaxX, priv->acecadMaxY,priv->acecadMaxZ);
916 NewPacket (AceCadPrivatePtr priv)
922 AceCadGetPacket (AceCadPrivatePtr priv)
927 while((c = XisbRead(priv->buffer))>=0 )
931 * fail after 500 bytes so the server doesn't hang forever if a
932 * device sends bad data.
944 /*xf86Msg(X_CONFIG, "Push %2.2x\n",(char) c);*/
945 XisbBlockDuration (priv->buffer, 10000);
946 priv->packet[priv->packeti++] = c;
947 count=ACECAD_PACKET_SIZE-1;
948 while(count-- && (c = XisbRead(priv->buffer))>=0)
950 /*xf86Msg(X_INFO, "Push %2.2x\n",(char) c);*/
951 priv->packet[priv->packeti++] = c;
953 XisbBlockDuration (priv->buffer, 0);