2 comedi/drivers/jr3_pci.c
3 hardware driver for JR3/PCI force sensor board
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 2007 Anders Blomdell <anders.blomdell@control.lth.se>
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 Description: JR3/PCI force sensor board
26 Author: Anders Blomdell <anders.blomdell@control.lth.se>
28 Devices: [JR3] PCI force sensor board (jr3_pci)
30 The DSP on the board requires initialization code, which can
31 be loaded by placing it in /lib/firmware/comedi.
32 The initialization code should be somewhere on the media you got
33 with your card. One version is available from http://www.comedi.org
34 in the comedi_nonfree_firmware tarball.
36 Configuration options:
37 [0] - PCI bus number - if bus number and slot number are 0,
38 then driver search for first unused card
43 #include "../comedidev.h"
45 #include <linux/delay.h>
46 #include <linux/ctype.h>
47 #include <linux/firmware.h>
48 #include <linux/jiffies.h>
49 #include <linux/timer.h>
50 #include "comedi_pci.h"
53 #define PCI_VENDOR_ID_JR3 0x1762
54 #define PCI_DEVICE_ID_JR3_1_CHANNEL 0x3111
55 #define PCI_DEVICE_ID_JR3_2_CHANNEL 0x3112
56 #define PCI_DEVICE_ID_JR3_3_CHANNEL 0x3113
57 #define PCI_DEVICE_ID_JR3_4_CHANNEL 0x3114
59 static int jr3_pci_attach(struct comedi_device *dev,
60 struct comedi_devconfig *it);
61 static int jr3_pci_detach(struct comedi_device *dev);
63 static struct comedi_driver driver_jr3_pci = {
64 .driver_name = "jr3_pci",
65 .module = THIS_MODULE,
66 .attach = jr3_pci_attach,
67 .detach = jr3_pci_detach,
70 static DEFINE_PCI_DEVICE_TABLE(jr3_pci_pci_table) = {
72 PCI_VENDOR_ID_JR3, PCI_DEVICE_ID_JR3_1_CHANNEL,
73 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
74 PCI_VENDOR_ID_JR3, PCI_DEVICE_ID_JR3_2_CHANNEL,
75 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
76 PCI_VENDOR_ID_JR3, PCI_DEVICE_ID_JR3_3_CHANNEL,
77 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
78 PCI_VENDOR_ID_JR3, PCI_DEVICE_ID_JR3_4_CHANNEL,
79 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
83 MODULE_DEVICE_TABLE(pci, jr3_pci_pci_table);
85 struct jr3_pci_dev_private {
87 struct pci_dev *pci_dev;
89 volatile struct jr3_t *iobase;
91 struct timer_list timer;
100 struct jr3_pci_subdev_private {
101 volatile struct jr3_channel *channel;
102 unsigned long next_time_min;
103 unsigned long next_time_max;
104 enum { state_jr3_poll,
105 state_jr3_init_wait_for_offset,
106 state_jr3_init_transform_complete,
107 state_jr3_init_set_full_scale_complete,
108 state_jr3_init_use_offset_complete,
116 struct comedi_krange range;
118 const struct comedi_lrange *range_table_list[8 * 7 + 2];
119 unsigned int maxdata_list[8 * 7 + 2];
124 /* Hotplug firmware loading stuff */
126 typedef int comedi_firmware_callback(struct comedi_device *dev,
127 const u8 * data, size_t size);
129 static int comedi_load_firmware(struct comedi_device *dev, char *name,
130 comedi_firmware_callback cb)
133 const struct firmware *fw;
135 static const char *prefix = "comedi/";
136 struct jr3_pci_dev_private *devpriv = dev->private;
138 firmware_path = kmalloc(strlen(prefix) + strlen(name) + 1, GFP_KERNEL);
139 if (!firmware_path) {
142 firmware_path[0] = '\0';
143 strcat(firmware_path, prefix);
144 strcat(firmware_path, name);
145 result = request_firmware(&fw, firmware_path,
146 &devpriv->pci_dev->dev);
151 result = cb(dev, fw->data, fw->size);
152 release_firmware(fw);
154 kfree(firmware_path);
159 static struct poll_delay_t poll_delay_min_max(int min, int max)
161 struct poll_delay_t result;
168 static int is_complete(volatile struct jr3_channel *channel)
170 return get_s16(&channel->command_word0) == 0;
180 static void set_transforms(volatile struct jr3_channel *channel,
181 struct transform_t transf, short num)
185 num &= 0x000f; /* Make sure that 0 <= num <= 15 */
186 for (i = 0; i < 8; i++) {
188 set_u16(&channel->transforms[num].link[i].link_type,
189 transf.link[i].link_type);
191 set_s16(&channel->transforms[num].link[i].link_amount,
192 transf.link[i].link_amount);
194 if (transf.link[i].link_type == end_x_form) {
200 static void use_transform(volatile struct jr3_channel *channel,
203 set_s16(&channel->command_word0, 0x0500 + (transf_num & 0x000f));
206 static void use_offset(volatile struct jr3_channel *channel, short offset_num)
208 set_s16(&channel->command_word0, 0x0600 + (offset_num & 0x000f));
211 static void set_offset(volatile struct jr3_channel *channel)
213 set_s16(&channel->command_word0, 0x0700);
225 static void set_full_scales(volatile struct jr3_channel *channel,
226 struct six_axis_t full_scale)
228 printk("%d %d %d %d %d %d\n",
231 full_scale.fz, full_scale.mx, full_scale.my, full_scale.mz);
232 set_s16(&channel->full_scale.fx, full_scale.fx);
233 set_s16(&channel->full_scale.fy, full_scale.fy);
234 set_s16(&channel->full_scale.fz, full_scale.fz);
235 set_s16(&channel->full_scale.mx, full_scale.mx);
236 set_s16(&channel->full_scale.my, full_scale.my);
237 set_s16(&channel->full_scale.mz, full_scale.mz);
238 set_s16(&channel->command_word0, 0x0a00);
241 static struct six_axis_t get_min_full_scales(volatile struct jr3_channel
244 struct six_axis_t result;
245 result.fx = get_s16(&channel->min_full_scale.fx);
246 result.fy = get_s16(&channel->min_full_scale.fy);
247 result.fz = get_s16(&channel->min_full_scale.fz);
248 result.mx = get_s16(&channel->min_full_scale.mx);
249 result.my = get_s16(&channel->min_full_scale.my);
250 result.mz = get_s16(&channel->min_full_scale.mz);
254 static struct six_axis_t get_max_full_scales(volatile struct jr3_channel
257 struct six_axis_t result;
258 result.fx = get_s16(&channel->max_full_scale.fx);
259 result.fy = get_s16(&channel->max_full_scale.fy);
260 result.fz = get_s16(&channel->max_full_scale.fz);
261 result.mx = get_s16(&channel->max_full_scale.mx);
262 result.my = get_s16(&channel->max_full_scale.my);
263 result.mz = get_s16(&channel->max_full_scale.mz);
267 static int jr3_pci_ai_insn_read(struct comedi_device *dev,
268 struct comedi_subdevice *s,
269 struct comedi_insn *insn, unsigned int *data)
272 struct jr3_pci_subdev_private *p;
276 channel = CR_CHAN(insn->chanspec);
277 if (p == NULL || channel > 57) {
283 if (p->state != state_jr3_done ||
284 (get_u16(&p->channel->errors) & (watch_dog | watch_dog2 |
286 /* No sensor or sensor changed */
287 if (p->state == state_jr3_done) {
288 /* Restart polling */
289 p->state = state_jr3_poll;
293 for (i = 0; i < insn->n; i++) {
298 filter = channel / 8;
299 if (p->state != state_jr3_done) {
353 data[i] = F + 0x4000;
355 } else if (channel == 56) {
356 if (p->state != state_jr3_done) {
360 get_u16(&p->channel->model_no);
362 } else if (channel == 57) {
363 if (p->state != state_jr3_done) {
367 get_u16(&p->channel->serial_no);
375 static void jr3_pci_open(struct comedi_device *dev)
378 struct jr3_pci_dev_private *devpriv = dev->private;
380 printk("jr3_pci_open\n");
381 for (i = 0; i < devpriv->n_channels; i++) {
382 struct jr3_pci_subdev_private *p;
384 p = dev->subdevices[i].private;
386 printk("serial: %p %d (%d)\n", p, p->serial_no,
392 int read_idm_word(const u8 * data, size_t size, int *pos, unsigned int *val)
395 if (pos != 0 && val != 0) {
396 /* Skip over non hex */
397 for (; *pos < size && !isxdigit(data[*pos]); (*pos)++) {
401 for (; *pos < size && isxdigit(data[*pos]); (*pos)++) {
402 char ch = tolower(data[*pos]);
404 if ('0' <= ch && ch <= '9') {
405 *val = (*val << 4) + (ch - '0');
406 } else if ('a' <= ch && ch <= 'f') {
407 *val = (*val << 4) + (ch - 'a' + 10);
414 static int jr3_download_firmware(struct comedi_device *dev, const u8 * data,
418 * IDM file format is:
419 * { count, address, data <count> } *
422 int result, more, pos, OK;
429 unsigned int count, addr;
431 more = more && read_idm_word(data, size, &pos, &count);
432 if (more && count == 0xffff) {
436 more = more && read_idm_word(data, size, &pos, &addr);
437 while (more && count > 0) {
439 more = more && read_idm_word(data, size, &pos, &dummy);
448 struct jr3_pci_dev_private *p = dev->private;
450 for (i = 0; i < p->n_channels; i++) {
451 struct jr3_pci_subdev_private *sp;
453 sp = dev->subdevices[i].private;
457 unsigned int count, addr;
459 && read_idm_word(data, size, &pos, &count);
460 if (more && count == 0xffff) {
464 && read_idm_word(data, size, &pos, &addr);
465 printk("Loading#%d %4.4x bytes at %4.4x\n", i,
467 while (more && count > 0) {
469 /* 16 bit data, never seen in real life!! */
473 && read_idm_word(data,
477 /* printk("jr3_data, not tested\n"); */
478 /* jr3[addr + 0x20000 * pnum] = data1; */
480 /* Download 24 bit program */
481 unsigned int data1, data2;
484 && read_idm_word(data,
488 && read_idm_word(data, size,
514 static struct poll_delay_t jr3_pci_poll_subdevice(struct comedi_subdevice *s)
516 struct poll_delay_t result = poll_delay_min_max(1000, 2000);
517 struct jr3_pci_subdev_private *p = s->private;
520 volatile struct jr3_channel *channel = p->channel;
521 int errors = get_u16(&channel->errors);
523 if (errors != p->errors) {
524 printk("Errors: %x -> %x\n", p->errors, errors);
527 if (errors & (watch_dog | watch_dog2 | sensor_change)) {
528 /* Sensor communication lost, force poll mode */
529 p->state = state_jr3_poll;
533 case state_jr3_poll:{
534 u16 model_no = get_u16(&channel->model_no);
535 u16 serial_no = get_u16(&channel->serial_no);
536 if ((errors & (watch_dog | watch_dog2)) ||
537 model_no == 0 || serial_no == 0) {
539 * Still no sensor, keep on polling. Since it takes up to 10 seconds
540 * for offsets to stabilize, polling each second should suffice.
542 result = poll_delay_min_max(1000, 2000);
546 state_jr3_init_wait_for_offset;
547 result = poll_delay_min_max(1000, 2000);
551 case state_jr3_init_wait_for_offset:{
553 if (p->retries < 10) {
554 /* Wait for offeset to stabilize (< 10 s according to manual) */
555 result = poll_delay_min_max(1000, 2000);
557 struct transform_t transf;
560 get_u16(&channel->model_no);
562 get_u16(&channel->serial_no);
565 ("Setting transform for channel %d\n",
567 printk("Sensor Model = %i\n",
569 printk("Sensor Serial = %i\n",
572 /* Transformation all zeros */
573 transf.link[0].link_type =
575 transf.link[0].link_amount = 0;
576 transf.link[1].link_type =
578 transf.link[1].link_amount = 0;
579 transf.link[2].link_type =
581 transf.link[2].link_amount = 0;
582 transf.link[3].link_type =
584 transf.link[3].link_amount = 0;
586 set_transforms(channel, transf, 0);
587 use_transform(channel, 0);
589 state_jr3_init_transform_complete;
590 result = poll_delay_min_max(20, 100); /* Allow 20 ms for completion */
593 case state_jr3_init_transform_complete:{
594 if (!is_complete(channel)) {
596 ("state_jr3_init_transform_complete complete = %d\n",
597 is_complete(channel));
598 result = poll_delay_min_max(20, 100);
601 struct six_axis_t min_full_scale;
602 struct six_axis_t max_full_scale;
605 get_min_full_scales(channel);
606 printk("Obtained Min. Full Scales:\n");
607 printk("%i ", (min_full_scale).fx);
608 printk("%i ", (min_full_scale).fy);
609 printk("%i ", (min_full_scale).fz);
610 printk("%i ", (min_full_scale).mx);
611 printk("%i ", (min_full_scale).my);
612 printk("%i ", (min_full_scale).mz);
616 get_max_full_scales(channel);
617 printk("Obtained Max. Full Scales:\n");
618 printk("%i ", (max_full_scale).fx);
619 printk("%i ", (max_full_scale).fy);
620 printk("%i ", (max_full_scale).fz);
621 printk("%i ", (max_full_scale).mx);
622 printk("%i ", (max_full_scale).my);
623 printk("%i ", (max_full_scale).mz);
626 set_full_scales(channel,
630 state_jr3_init_set_full_scale_complete;
631 result = poll_delay_min_max(20, 100); /* Allow 20 ms for completion */
635 case state_jr3_init_set_full_scale_complete:{
636 if (!is_complete(channel)) {
638 ("state_jr3_init_set_full_scale_complete complete = %d\n",
639 is_complete(channel));
640 result = poll_delay_min_max(20, 100);
642 volatile struct force_array *full_scale;
644 /* Use ranges in kN or we will overflow arount 2000N! */
645 full_scale = &channel->full_scale;
646 p->range[0].range.min =
647 -get_s16(&full_scale->fx) * 1000;
648 p->range[0].range.max =
649 get_s16(&full_scale->fx) * 1000;
650 p->range[1].range.min =
651 -get_s16(&full_scale->fy) * 1000;
652 p->range[1].range.max =
653 get_s16(&full_scale->fy) * 1000;
654 p->range[2].range.min =
655 -get_s16(&full_scale->fz) * 1000;
656 p->range[2].range.max =
657 get_s16(&full_scale->fz) * 1000;
658 p->range[3].range.min =
659 -get_s16(&full_scale->mx) * 100;
660 p->range[3].range.max =
661 get_s16(&full_scale->mx) * 100;
662 p->range[4].range.min =
663 -get_s16(&full_scale->my) * 100;
664 p->range[4].range.max =
665 get_s16(&full_scale->my) * 100;
666 p->range[5].range.min =
667 -get_s16(&full_scale->mz) * 100;
668 p->range[5].range.max =
669 get_s16(&full_scale->mz) * 100;
670 p->range[6].range.min = -get_s16(&full_scale->v1) * 100; /* ?? */
671 p->range[6].range.max = get_s16(&full_scale->v1) * 100; /* ?? */
672 p->range[7].range.min = -get_s16(&full_scale->v2) * 100; /* ?? */
673 p->range[7].range.max = get_s16(&full_scale->v2) * 100; /* ?? */
674 p->range[8].range.min = 0;
675 p->range[8].range.max = 65535;
679 for (i = 0; i < 9; i++) {
680 printk("%d %d - %d\n",
691 use_offset(channel, 0);
693 state_jr3_init_use_offset_complete;
694 result = poll_delay_min_max(40, 100); /* Allow 40 ms for completion */
698 case state_jr3_init_use_offset_complete:{
699 if (!is_complete(channel)) {
701 ("state_jr3_init_use_offset_complete complete = %d\n",
702 is_complete(channel));
703 result = poll_delay_min_max(20, 100);
706 ("Default offsets %d %d %d %d %d %d\n",
707 get_s16(&channel->offsets.fx),
708 get_s16(&channel->offsets.fy),
709 get_s16(&channel->offsets.fz),
710 get_s16(&channel->offsets.mx),
711 get_s16(&channel->offsets.my),
712 get_s16(&channel->offsets.mz));
714 set_s16(&channel->offsets.fx, 0);
715 set_s16(&channel->offsets.fy, 0);
716 set_s16(&channel->offsets.fz, 0);
717 set_s16(&channel->offsets.mx, 0);
718 set_s16(&channel->offsets.my, 0);
719 set_s16(&channel->offsets.mz, 0);
723 p->state = state_jr3_done;
727 case state_jr3_done:{
728 poll_delay_min_max(10000, 20000);
732 poll_delay_min_max(1000, 2000);
740 static void jr3_pci_poll_dev(unsigned long data)
743 struct comedi_device *dev = (struct comedi_device *)data;
744 struct jr3_pci_dev_private *devpriv = dev->private;
749 spin_lock_irqsave(&dev->spinlock, flags);
752 /* Poll all channels that are ready to be polled */
753 for (i = 0; i < devpriv->n_channels; i++) {
754 struct jr3_pci_subdev_private *subdevpriv =
755 dev->subdevices[i].private;
756 if (now > subdevpriv->next_time_min) {
757 struct poll_delay_t sub_delay;
759 sub_delay = jr3_pci_poll_subdevice(&dev->subdevices[i]);
760 subdevpriv->next_time_min =
761 jiffies + msecs_to_jiffies(sub_delay.min);
762 subdevpriv->next_time_max =
763 jiffies + msecs_to_jiffies(sub_delay.max);
764 if (sub_delay.max && sub_delay.max < delay) {
766 * Wake up as late as possible -> poll as many channels as possible
769 delay = sub_delay.max;
773 spin_unlock_irqrestore(&dev->spinlock, flags);
775 devpriv->timer.expires = jiffies + msecs_to_jiffies(delay);
776 add_timer(&devpriv->timer);
779 static int jr3_pci_attach(struct comedi_device *dev,
780 struct comedi_devconfig *it)
783 struct pci_dev *card = NULL;
784 int opt_bus, opt_slot, i;
785 struct jr3_pci_dev_private *devpriv;
787 printk("comedi%d: jr3_pci\n", dev->minor);
789 opt_bus = it->options[0];
790 opt_slot = it->options[1];
792 if (sizeof(struct jr3_channel) != 0xc00) {
793 printk("sizeof(struct jr3_channel) = %x [expected %x]\n",
794 (unsigned)sizeof(struct jr3_channel), 0xc00);
798 result = alloc_private(dev, sizeof(struct jr3_pci_dev_private));
803 devpriv = dev->private;
804 init_timer(&devpriv->timer);
806 card = pci_get_device(PCI_VENDOR_ID_JR3, PCI_ANY_ID, card);
811 switch (card->device) {
812 case PCI_DEVICE_ID_JR3_1_CHANNEL:{
813 devpriv->n_channels = 1;
816 case PCI_DEVICE_ID_JR3_2_CHANNEL:{
817 devpriv->n_channels = 2;
820 case PCI_DEVICE_ID_JR3_3_CHANNEL:{
821 devpriv->n_channels = 3;
824 case PCI_DEVICE_ID_JR3_4_CHANNEL:{
825 devpriv->n_channels = 4;
829 devpriv->n_channels = 0;
832 if (devpriv->n_channels >= 1) {
833 if (opt_bus == 0 && opt_slot == 0) {
834 /* Take first available card */
836 } else if (opt_bus == card->bus->number &&
837 opt_slot == PCI_SLOT(card->devfn)) {
838 /* Take requested card */
845 printk(" no jr3_pci found\n");
848 devpriv->pci_dev = card;
849 dev->board_name = "jr3_pci";
852 result = comedi_pci_enable(card, "jr3_pci");
857 devpriv->pci_enabled = 1;
859 ioremap(pci_resource_start(card, 0), sizeof(struct jr3_t));
860 result = alloc_subdevices(dev, devpriv->n_channels);
864 dev->open = jr3_pci_open;
865 for (i = 0; i < devpriv->n_channels; i++) {
866 dev->subdevices[i].type = COMEDI_SUBD_AI;
867 dev->subdevices[i].subdev_flags = SDF_READABLE | SDF_GROUND;
868 dev->subdevices[i].n_chan = 8 * 7 + 2;
869 dev->subdevices[i].insn_read = jr3_pci_ai_insn_read;
870 dev->subdevices[i].private =
871 kzalloc(sizeof(struct jr3_pci_subdev_private), GFP_KERNEL);
872 if (dev->subdevices[i].private) {
873 struct jr3_pci_subdev_private *p;
876 p = dev->subdevices[i].private;
877 p->channel = &devpriv->iobase->channel[i].data;
878 printk("p->channel %p %p (%tx)\n",
879 p->channel, devpriv->iobase,
880 ((char *)(p->channel) -
881 (char *)(devpriv->iobase)));
883 for (j = 0; j < 8; j++) {
886 p->range[j].length = 1;
887 p->range[j].range.min = -1000000;
888 p->range[j].range.max = 1000000;
889 for (k = 0; k < 7; k++) {
890 p->range_table_list[j + k * 8] =
891 (struct comedi_lrange *)&p->
893 p->maxdata_list[j + k * 8] = 0x7fff;
896 p->range[8].length = 1;
897 p->range[8].range.min = 0;
898 p->range[8].range.max = 65536;
900 p->range_table_list[56] =
901 (struct comedi_lrange *)&p->range[8];
902 p->range_table_list[57] =
903 (struct comedi_lrange *)&p->range[8];
904 p->maxdata_list[56] = 0xffff;
905 p->maxdata_list[57] = 0xffff;
906 /* Channel specific range and maxdata */
907 dev->subdevices[i].range_table = 0;
908 dev->subdevices[i].range_table_list =
910 dev->subdevices[i].maxdata = 0;
911 dev->subdevices[i].maxdata_list = p->maxdata_list;
916 devpriv->iobase->channel[0].reset = 0;
918 result = comedi_load_firmware(dev, "jr3pci.idm", jr3_download_firmware);
919 printk("Firmare load %d\n", result);
925 * TODO: use firmware to load preferred offset tables. Suggested
927 * model serial Fx Fy Fz Mx My Mz\n
929 * comedi_load_firmware(dev, "jr3_offsets_table", jr3_download_firmware);
933 * It takes a few milliseconds for software to settle as much as we
934 * can read firmware version
936 msleep_interruptible(25);
937 for (i = 0; i < 0x18; i++) {
939 get_u16(&devpriv->iobase->channel[0].
940 data.copyright[i]) >> 8);
943 /* Start card timer */
944 for (i = 0; i < devpriv->n_channels; i++) {
945 struct jr3_pci_subdev_private *p = dev->subdevices[i].private;
947 p->next_time_min = jiffies + msecs_to_jiffies(500);
948 p->next_time_max = jiffies + msecs_to_jiffies(2000);
951 devpriv->timer.data = (unsigned long)dev;
952 devpriv->timer.function = jr3_pci_poll_dev;
953 devpriv->timer.expires = jiffies + msecs_to_jiffies(1000);
954 add_timer(&devpriv->timer);
960 static int jr3_pci_detach(struct comedi_device *dev)
963 struct jr3_pci_dev_private *devpriv = dev->private;
965 printk("comedi%d: jr3_pci: remove\n", dev->minor);
967 del_timer_sync(&devpriv->timer);
969 if (dev->subdevices) {
970 for (i = 0; i < devpriv->n_channels; i++) {
971 kfree(dev->subdevices[i].private);
975 if (devpriv->iobase) {
976 iounmap((void *)devpriv->iobase);
978 if (devpriv->pci_enabled) {
979 comedi_pci_disable(devpriv->pci_dev);
982 if (devpriv->pci_dev) {
983 pci_dev_put(devpriv->pci_dev);
989 COMEDI_PCI_INITCLEANUP(driver_jr3_pci, jr3_pci_pci_table);