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 $ */
33 /*****************************************************************************
35 ****************************************************************************/
38 #include <asm/types.h>
39 #include <linux/input.h>
54 #ifndef NEED_XF86_TYPES
55 #define NEED_XF86_TYPES
57 #include <xf86_OSproc.h>
59 #include <xf86Xinput.h>
61 #include <xf86Module.h>
70 /*****************************************************************************
72 ****************************************************************************/
75 /*****************************************************************************
76 * Variables without includable headers
77 ****************************************************************************/
79 /*****************************************************************************
81 ****************************************************************************/
84 #define read(a,b,c) xf86ReadSerial((a),(b),(c))
86 /* max number of input events to read in one read call */
89 _X_EXPORT InputDriverRec ACECAD =
101 static XF86ModuleVersionInfo VersionRec =
107 XORG_VERSION_CURRENT,
116 _X_EXPORT XF86ModuleData acecadModuleData = {
122 /*****************************************************************************
123 * Function Definitions
124 ****************************************************************************/
127 SetupProc( pointer module,
132 xf86AddInputDriver(&ACECAD, module, 0);
137 TearDownProc( pointer p )
140 LocalDevicePtr local = (LocalDevicePtr) p;
141 AceCadPrivatePtr priv = (AceCadPrivatePtr) local->private;
143 DeviceOff (local->dev);
145 xf86CloseSerial (local->fd);
146 XisbFree (priv->buffer);
154 static const char *default_options[] =
162 "FlowControl", "Xoff",
173 SYSCALL(err = ioctl(fd, EVIOCGVERSION, &version));
176 xf86Msg(X_PROBED, "Kernel Input driver version is %d.%d.%d\n",
177 version >> 16, (version >> 8) & 0xff, version & 0xff);
180 xf86Msg(X_PROBED, "No Kernel Input driver found\n");
187 AceCadPreInit(InputDriverPtr drv, IDevPtr dev, int flags)
189 LocalDevicePtr local = xf86AllocateInput(drv, 0);
190 AceCadPrivatePtr priv = xcalloc (1, sizeof (AceCadPrivateRec));
195 if ((!local) || (!priv))
198 memset(priv,0,sizeof (AceCadPrivateRec));
200 local->name = dev->identifier;
201 local->type_name = "AceCad Tablet";
202 local->flags = XI86_POINTER_CAPABLE | XI86_SEND_DRAG_EVENTS;
203 local->motion_history_proc = xf86GetMotionEvents;
204 local->control_proc = NULL;
205 local->close_proc = CloseProc;
206 local->switch_mode = NULL;
207 local->conversion_proc = ConvertProc;
208 local->reverse_conversion_proc = ReverseConvertProc;
210 local->private = priv;
211 local->private_flags = 0;
212 local->conf_idev = dev;
213 local->device_control = DeviceControl;
214 /*local->always_core_feedback = 0;*/
216 xf86CollectInputOptions(local, default_options, NULL);
218 xf86OptionListReport(local->options);
220 priv->acecadInc = xf86SetIntOption(local->options, "Increment", 0 );
222 local->fd = xf86OpenSerial (local->options);
225 xf86Msg(X_ERROR, "AceCad driver unable to open device\n");
228 xf86ErrorFVerb( 6, "tty port opened successfully\n" );
231 if(IsUSBLine(local->fd)){
234 local->read_input = USBReadInput;
236 if (USBQueryHardware(local) != Success)
238 ErrorF ("Unable to query/initialize AceCad hardware.\n");
246 local->read_input = ReadInput;
249 if (xf86FindOptionValue(local->options, "ReportSpeed")) {
251 speed = xf86SetIntOption(local->options, "ReportSpeed", 85 );
259 priv->acecadReportSpeed = 'Q';
262 priv->acecadReportSpeed = 'R';
265 priv->acecadReportSpeed = 'S';
268 priv->acecadReportSpeed = 'T';
271 priv->acecadReportSpeed = 'R';
273 xf86Msg(X_ERROR, "Acecad Tablet: ReportSpeed value %d invalid. Possible values: 120, 85, 10, 2. Defaulting to 85\n", speed);
277 xf86Msg(msgtype, "Acecad Tablet report %d points/s\n", speed);
279 priv->buffer = XisbNew (local->fd, 200);
282 * Verify that hardware is attached and fuctional
284 if (QueryHardware(priv) != Success)
286 xf86Msg(X_ERROR, "Unable to query/initialize AceCad hardware.\n");
291 s = xf86FindOptionValue(local->options, "Mode");
292 msgtype = s ? X_CONFIG : X_DEFAULT;
293 if (s && (xf86NameCmp(s, "Relative") == 0))
295 priv->flags = priv->flags & ~ABSOLUTE_FLAG;
299 priv->flags = priv->flags | ABSOLUTE_FLAG;
302 xf86Msg(msgtype, "Acecad Tablet is in %s mode\n", (priv->flags & ABSOLUTE_FLAG) ? "absolute" : "relative");
303 DBG (9, XisbTrace (priv->buffer, 1));
305 local->history_size = xf86SetIntOption(local->options , "HistorySize", 0);
307 xf86ProcessCommonOptions(local, local->options);
309 local->flags |= XI86_CONFIGURED;
313 RemoveEnabledDevice (local->fd);
316 XisbFree(priv->buffer);
319 xf86CloseSerial(local->fd);
321 RemoveEnabledDevice (local->fd);
326 * If something went wrong, cleanup and return NULL
329 if ((local) && (local->fd))
330 xf86CloseSerial (local->fd);
331 if ((priv) && (priv->buffer))
332 XisbFree (priv->buffer);
339 DeviceControl (DeviceIntPtr dev, int mode)
350 RetValue = DeviceOn( dev );
353 RetValue = DeviceOff( dev );
356 RetValue = DeviceClose( dev );
366 DeviceOn (DeviceIntPtr dev)
369 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
370 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
372 xf86Msg(X_INFO, "Acecad Tablet Device On\n");
374 local->fd = xf86OpenSerial(local->options);
377 xf86Msg(X_WARNING, "%s: cannot open input device\n", local->name);
382 if (priv->acecadUSB==0){
383 priv->buffer = XisbNew(local->fd, 200);
386 xf86CloseSerial(local->fd);
391 /*Rets qu'a l'envoyer a la tablette */
392 sprintf(buffer, "%s%c%c%c%c", acecad_initstr, priv->acecadReportSpeed, ACECAD_INCREMENT, 32 + priv->acecadInc, (priv->flags & ABSOLUTE_FLAG)? ACECAD_ABSOLUTE: ACECAD_RELATIVE);
393 XisbWrite (priv->buffer, (unsigned char *)buffer, strlen(buffer));
396 xf86FlushInput(local->fd);
397 xf86AddEnabledDevice (local);
398 dev->public.on = TRUE;
403 DeviceOff (DeviceIntPtr dev)
405 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
406 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
411 RemoveEnabledDevice (local->fd);
414 XisbFree(priv->buffer);
417 xf86CloseSerial(local->fd);
421 xf86RemoveEnabledDevice (local);
422 dev->public.on = FALSE;
427 DeviceClose (DeviceIntPtr dev)
429 xf86Msg(X_INFO, "Acecad Tablet Device Close\n");
434 ControlProc(DeviceIntPtr device,
437 xf86Msg(X_INFO, "Acecad Tablet Control Proc\n");
441 DeviceInit (DeviceIntPtr dev)
444 LocalDevicePtr local = (LocalDevicePtr) dev->public.devicePrivate;
445 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
446 unsigned char map[] =
449 xf86Msg(X_INFO, "Acecad Tablet Device Init\n");
452 if (InitButtonClassDeviceStruct (dev, 3, map) == FALSE)
454 ErrorF ("Unable to allocate AceCad ButtonClassDeviceStruct\n");
458 if (InitFocusClassDeviceStruct (dev) == FALSE)
460 ErrorF("Unable to allocate AceCad FocusClassDeviceStruct\n");
464 if (InitPtrFeedbackClassDeviceStruct(dev,
465 ControlProc) == FALSE) {
466 ErrorF("unable to init ptr feedback\n");
472 if (InitValuatorClassDeviceStruct (dev, 3, xf86GetMotionEvents,
474 ((priv->flags & ABSOLUTE_FLAG)? Absolute: Relative)|OutOfProximity)
477 ErrorF ("Unable to allocate AceCad ValuatorClassDeviceStruct\n");
483 InitValuatorAxisStruct(dev,
486 priv->acecadMaxX, /* max val */
487 1000, /* resolution */
490 InitValuatorAxisStruct(dev,
493 priv->acecadMaxY, /* max val */
494 1000, /* resolution */
497 InitValuatorAxisStruct(dev,
500 priv->acecadMaxZ, /* max val */
501 1000, /* resolution */
507 if (InitProximityClassDeviceStruct (dev) == FALSE)
509 ErrorF ("Unable to allocate ProximityClassDeviceStruct\n");
513 xf86MotionHistoryAllocate (local);
516 /* On ne peut pas calculer l'increment avant, faute d'ecran pour
517 connaitre la taille... */
519 if (priv->acecadInc > 95)
520 priv->acecadInc = 95;
521 if (priv->acecadInc < 1)
523 /* guess the best increment value given video mode */
524 rx=priv->acecadMaxX / screenInfo.screens[0]->width;
525 ry=priv->acecadMaxY / screenInfo.screens[0]->height;
527 priv->acecadInc = rx;
529 priv->acecadInc = ry;
530 if (priv->acecadInc < 1)
534 xf86Msg(X_INFO, "Acecad Tablet Increment: %d\n", priv->acecadInc);
540 ReadInput (LocalDevicePtr local)
544 int is_core_pointer, is_absolute;
545 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
547 /*xf86Msg(X_INFO, "Acecad Tablet Read Input\n");*/
549 is_absolute = (priv->flags & ABSOLUTE_FLAG);
550 is_core_pointer = xf86IsCorePointer(local->dev);
553 * set blocking to -1 on the first call because we know there is data to
554 * read. Xisb automatically clears it after one successful read so that
555 * succeeding reads are preceeded buy a select with a 0 timeout to prevent
556 * read from blocking indefinately.
558 XisbBlockDuration (priv->buffer, -1);
560 while (AceCadGetPacket (priv) == Success)
562 x = (int)priv->packet[1] | ((int)priv->packet[2] << 7);
563 y = (int)priv->packet[3] | ((int)priv->packet[4] << 7);
565 if (!(priv->flags & ABSOLUTE_FLAG))
567 x = priv->packet[0] & XSIGN_BIT? x:-x;
568 y = priv->packet[0] & YSIGN_BIT? y:-y;
572 y = priv->acecadMaxY - y ;
576 z = ((int)priv->packet[5] << 2) |
577 (((int)priv->packet[6] & 0x01) << 1) |
578 (((int)priv->packet[6] & 0x10) >> 4);
580 buttons = ((int)priv->packet[0] & 0x07) |
581 ((int)priv->packet[6] & 0x02 << 2);
583 prox = (priv->packet[0] & PROXIMITY_BIT)? 0: 1;
587 if (!(priv->acecadOldProximity))
588 if (!is_core_pointer)
590 /*xf86Msg(X_INFO, "Acecad Tablet ProxIN %d %d %d\n",x, y, z);*/
591 xf86PostProximityEvent(local->dev, 1, 0, 3 , x, y, z);
594 if ((is_absolute && ((priv->acecadOldX != x) || (priv->acecadOldY != y) || (priv->acecadOldZ != z)))
595 || (!is_absolute && (x || y)))
597 if (is_absolute || priv->acecadOldProximity)
599 /*xf86Msg(X_INFO, "Acecad Tablet Motion %d %d %d\n", x, y, z);*/
600 xf86PostMotionEvent(local->dev, is_absolute, 0, 3, x, y, z);
604 if (priv->acecadOldButtons != buttons)
608 delta = buttons ^ priv->acecadOldButtons;
614 delta &= ~(1 << (id-1));
616 /*xf86Msg(X_INFO, "Acecad Tablet Button %d 0x%x\n",id,(buttons&(1<<(id-1))));*/
617 xf86PostButtonEvent(local->dev, is_absolute, id, (buttons&(1<<(id-1))), 0, 3, x, y,z);
621 priv->acecadOldButtons = buttons;
622 priv->acecadOldX = x;
623 priv->acecadOldY = y;
624 priv->acecadOldZ = z;
625 priv->acecadOldProximity = prox;
629 if (!is_core_pointer)
630 if (priv->acecadOldProximity)
632 /*xf86Msg(X_INFO, "Acecad Tablet ProxOUT %d %d %d\n",x, y, z);*/
633 xf86PostProximityEvent(local->dev, 0, 0, 3, x,y,z);
635 priv->acecadOldProximity = 0;
638 /*xf86Msg(X_INFO, "Acecad Tablet Sortie Read Input\n");*/
642 #define set_bit(byte,nb,bit) (bit ? byte | (1<<nb) : byte & (~(1<<nb)))
644 USBReadInput (LocalDevicePtr local)
647 struct input_event * event;
648 char eventbuf[sizeof(struct input_event) * MAX_EVENTS];
649 AceCadPrivatePtr priv = (AceCadPrivatePtr) (local->private);
650 int x = priv->acecadOldX;
651 int y = priv->acecadOldY;
652 int z = priv->acecadOldZ;
653 int prox = priv->acecadOldProximity;
654 int buttons = priv->acecadOldButtons;
657 is_core_pointer = xf86IsCorePointer(local->dev);
659 SYSCALL(len = read(local->fd, eventbuf, sizeof(eventbuf)));
662 ErrorF("Error reading wacom device : %s\n", strerror(errno));
666 for (event=(struct input_event *)eventbuf;
667 event<(struct input_event *)(eventbuf+len); event++) {
669 switch (event->type) {
670 case EV_SYN: /* 2.6.x */
671 if (event->code != SYN_REPORT)
672 xf86Msg(X_ERROR, "UNKNOWN EV_SYN code %d\n", event->code);
675 switch (event->code) {
695 switch (event->code) {
701 buttons=set_bit(buttons,0,event->value);
705 buttons=set_bit(buttons,1,event->value);
709 buttons=set_bit(buttons,2,event->value);
714 xf86Msg(X_ERROR, "UNKNOWN event type/code %d/%d\n", event->type, event->code);
715 } /* switch event->type */
717 /* Linux Kernel 2.6.x sends EV_SYN/SYN_REPORT as an event terminator,
718 * whereas 2.4.x sends EV_ABS/ABS_MISC. We have to support both.
720 if (!( (event->type == EV_SYN && event->code == SYN_REPORT) ||
721 (event->type == EV_ABS && event->code == ABS_MISC)
728 if (!(priv->acecadOldProximity))
729 if (!is_core_pointer)
731 xf86PostProximityEvent(local->dev, 1, 0, 3 , x, y, z);
735 xf86PostMotionEvent(local->dev, 1, 0, 3, x, y, z);
737 if (priv->acecadOldButtons != buttons)
741 delta = buttons ^ priv->acecadOldButtons;
747 delta &= ~(1 << (id-1));
749 xf86PostButtonEvent(local->dev, 1, id, (buttons&(1<<(id-1))), 0, 3, x, y,z);
755 if (!is_core_pointer)
756 if (priv->acecadOldProximity)
758 xf86PostProximityEvent(local->dev, 0, 0, 3, x,y,z);
760 priv->acecadOldProximity = 0;
763 priv->acecadOldButtons = buttons;
764 priv->acecadOldX = x;
765 priv->acecadOldY = y;
766 priv->acecadOldZ = z;
767 priv->acecadOldProximity = prox;
769 /*xf86Msg(X_INFO, "Acecad Tablet Sortie Read Input\n");*/
774 CloseProc (LocalDevicePtr local)
779 * The ConvertProc function may need to be tailored for your device.
780 * This function converts the device's valuator outputs to x and y coordinates
781 * to simulate mouse events.
784 ConvertProc (LocalDevicePtr local,
796 AceCadPrivatePtr priv = (AceCadPrivatePtr)(local->private);
798 *x = v0 * screenInfo.screens[0]->width / priv->acecadMaxX;
799 *y = v1 * screenInfo.screens[0]->height / priv->acecadMaxY;
805 ReverseConvertProc( LocalDevicePtr local,
810 AceCadPrivatePtr priv = (AceCadPrivatePtr)(local->private);
812 valuators[0] = x * priv->acecadMaxX / screenInfo.screens[0]->width;
813 valuators[1] = y * priv->acecadMaxY / screenInfo.screens[0]->height;
819 #define WriteString(str)\
820 XisbWrite (priv->buffer, (unsigned char *)(str), strlen(str))
824 QueryHardware (AceCadPrivatePtr priv)
833 /* Prompt Mode in order to not be disturbed */
834 WriteString(ACECAD_PROMPT_MODE);
837 while(XisbRead(priv->buffer)>=0);
839 /* Ask for Config packet*/
840 WriteString(ACECAD_CONFIG);
842 /* Read the packet */
843 XisbBlockDuration (priv->buffer, 1000000);
846 /*xf86Msg(X_CONFIG, "Acecad Tablet init envoyé \n");*/
848 if ((AceCadGetPacket (priv) == Success))
850 priv->acecadMaxX = (int)priv->packet[1] + ((int)priv->packet[2] << 7);
851 priv->acecadMaxY = (int)priv->packet[3] + ((int)priv->packet[4] << 7);
852 priv->acecadMaxZ = 512;
853 xf86Msg(X_INFO, "Acecad Tablet MaxX:%d MaxY:%d\n",priv->acecadMaxX,priv->acecadMaxY);
858 /*xf86Msg(X_INFO, "Acecad Tablet query hardware fini \n");*/
862 #define BITS_PER_LONG (sizeof(long) * 8)
863 #define NBITS(x) ((((x)-1)/BITS_PER_LONG)+1)
864 #define test_bit(bit, array) ((array[LONG(bit)] >> OFF(bit)) & 1)
865 #define OFF(x) ((x)%BITS_PER_LONG)
866 #define LONG(x) ((x)/BITS_PER_LONG)
870 USBQueryHardware (LocalDevicePtr local)
872 AceCadPrivatePtr priv = (AceCadPrivatePtr) local->private;
873 unsigned long bit[EV_MAX][NBITS(KEY_MAX)];
876 char name[256] = "Unknown";
878 ioctl(local->fd, EVIOCGNAME(sizeof(name)), name);
879 xf86Msg(X_PROBED, "Kernel Input device name: \"%s\"\n", name);
881 memset(bit, 0, sizeof(bit));
882 ioctl(local->fd, EVIOCGBIT(0, EV_MAX), bit[0]);
884 for (i = 0; i < EV_MAX; i++)
885 if (test_bit(i, bit[0])) {
886 ioctl(local->fd, EVIOCGBIT(i, KEY_MAX), bit[i]);
887 for (j = 0; j < KEY_MAX; j++)
888 if (test_bit(j, bit[i])) {
890 ioctl(local->fd, EVIOCGABS(j), abs);
893 priv->acecadMaxX = abs[2];
897 priv->acecadMaxY = abs[2];
901 priv->acecadMaxZ = abs[2];
908 xf86Msg(X_PROBED, "Acecad Tablet MaxX:%d MaxY:%d MaxZ:%d\n", priv->acecadMaxX, priv->acecadMaxY,priv->acecadMaxZ);
914 NewPacket (AceCadPrivatePtr priv)
920 AceCadGetPacket (AceCadPrivatePtr priv)
925 while((c = XisbRead(priv->buffer))>=0 )
929 * fail after 500 bytes so the server doesn't hang forever if a
930 * device sends bad data.
942 /*xf86Msg(X_CONFIG, "Push %2.2x\n",(char) c);*/
943 XisbBlockDuration (priv->buffer, 10000);
944 priv->packet[priv->packeti++] = c;
945 count=ACECAD_PACKET_SIZE-1;
946 while(count-- && (c = XisbRead(priv->buffer))>=0)
948 /*xf86Msg(X_INFO, "Push %2.2x\n",(char) c);*/
949 priv->packet[priv->packeti++] = c;
951 XisbBlockDuration (priv->buffer, 0);