blob: 6c4ff023717f0f80de0d153ceb879d5207124a89 [file] [log] [blame]
Anders Blomdell07b509e2009-02-12 16:07:16 -08001/*
Ravishankar Karkala Mallikarjunayyafb999e72016-06-06 16:31:17 +05302 * comedi/drivers/jr3_pci.c
3 * hardware driver for JR3/PCI force sensor board
4 *
5 * COMEDI - Linux Control and Measurement Device Interface
6 * Copyright (C) 2007 Anders Blomdell <anders.blomdell@control.lth.se>
7 *
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.
12 *
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.
17 */
Anders Blomdell07b509e2009-02-12 16:07:16 -080018/*
Ian Abbott10ba6192012-11-01 18:34:40 +000019 * Driver: jr3_pci
20 * Description: JR3/PCI force sensor board
21 * Author: Anders Blomdell <anders.blomdell@control.lth.se>
22 * Updated: Thu, 01 Nov 2012 17:34:55 +0000
23 * Status: works
24 * Devices: [JR3] PCI force sensor board (jr3_pci)
25 *
26 * Configuration options:
27 * None
28 *
29 * Manual configuration of comedi devices is not supported by this
30 * driver; supported PCI devices are configured as comedi devices
31 * automatically.
32 *
33 * The DSP on the board requires initialization code, which can be
34 * loaded by placing it in /lib/firmware/comedi. The initialization
35 * code should be somewhere on the media you got with your card. One
36 * version is available from http://www.comedi.org in the
37 * comedi_nonfree_firmware tarball. The file is called "jr3pci.idm".
38 */
Anders Blomdell07b509e2009-02-12 16:07:16 -080039
H Hartley Sweeten33782dd2013-01-30 15:22:21 -070040#include <linux/kernel.h>
H Hartley Sweetence157f82013-06-24 17:04:43 -070041#include <linux/module.h>
Anders Blomdell07b509e2009-02-12 16:07:16 -080042#include <linux/delay.h>
43#include <linux/ctype.h>
Alexander Beregalov9b5de0a2009-06-20 03:52:47 +040044#include <linux/jiffies.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090045#include <linux/slab.h>
Alexander Beregalov9b5de0a2009-06-20 03:52:47 +040046#include <linux/timer.h>
H Hartley Sweeten33782dd2013-01-30 15:22:21 -070047
Ian Abbotte4c296d2015-03-10 16:10:59 +000048#include "../comedi_pci.h"
H Hartley Sweeten33782dd2013-01-30 15:22:21 -070049
Anders Blomdell07b509e2009-02-12 16:07:16 -080050#include "jr3_pci.h"
51
Anders Blomdell07b509e2009-02-12 16:07:16 -080052#define PCI_VENDOR_ID_JR3 0x1762
H Hartley Sweeten72118062014-03-11 10:03:31 -070053
54enum jr3_pci_boardid {
55 BOARD_JR3_1,
56 BOARD_JR3_2,
57 BOARD_JR3_3,
58 BOARD_JR3_4,
59};
60
61struct jr3_pci_board {
62 const char *name;
63 int n_subdevs;
64};
65
66static const struct jr3_pci_board jr3_pci_boards[] = {
67 [BOARD_JR3_1] = {
68 .name = "jr3_pci_1",
69 .n_subdevs = 1,
70 },
71 [BOARD_JR3_2] = {
72 .name = "jr3_pci_2",
73 .n_subdevs = 2,
74 },
75 [BOARD_JR3_3] = {
76 .name = "jr3_pci_3",
77 .n_subdevs = 3,
78 },
79 [BOARD_JR3_4] = {
80 .name = "jr3_pci_4",
81 .n_subdevs = 4,
82 },
83};
Anders Blomdell07b509e2009-02-12 16:07:16 -080084
H Hartley Sweeten0a444932014-03-07 13:41:06 -070085struct jr3_pci_transform {
86 struct {
87 u16 link_type;
88 s16 link_amount;
89 } link[8];
90};
91
H Hartley Sweetenda1331a2014-03-07 13:41:07 -070092struct jr3_pci_poll_delay {
93 int min;
94 int max;
95};
96
Bill Pemberton217fbbb2009-03-16 22:15:24 -040097struct jr3_pci_dev_private {
Ian Abbott95b24682012-10-15 12:20:00 +010098 struct jr3_t __iomem *iobase;
Anders Blomdell07b509e2009-02-12 16:07:16 -080099 struct timer_list timer;
Bill Pemberton217fbbb2009-03-16 22:15:24 -0400100};
101
Bill Pembertonc6a3b7b2009-03-16 22:20:25 -0400102struct jr3_pci_subdev_private {
Ian Abbott95b24682012-10-15 12:20:00 +0100103 struct jr3_channel __iomem *channel;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800104 unsigned long next_time_min;
105 unsigned long next_time_max;
106 enum { state_jr3_poll,
107 state_jr3_init_wait_for_offset,
108 state_jr3_init_transform_complete,
109 state_jr3_init_set_full_scale_complete,
110 state_jr3_init_use_offset_complete,
111 state_jr3_done
112 } state;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800113 int serial_no;
114 int model_no;
115 struct {
116 int length;
Bill Pemberton1f6325d2009-03-16 22:06:31 -0400117 struct comedi_krange range;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800118 } range[9];
Bill Pemberton9ced1de2009-03-16 22:05:31 -0400119 const struct comedi_lrange *range_table_list[8 * 7 + 2];
Bill Pemberton790c5542009-03-16 22:05:02 -0400120 unsigned int maxdata_list[8 * 7 + 2];
Anders Blomdell07b509e2009-02-12 16:07:16 -0800121 u16 errors;
122 int retries;
Bill Pembertonc6a3b7b2009-03-16 22:20:25 -0400123};
Anders Blomdell07b509e2009-02-12 16:07:16 -0800124
H Hartley Sweetenda1331a2014-03-07 13:41:07 -0700125static struct jr3_pci_poll_delay poll_delay_min_max(int min, int max)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800126{
H Hartley Sweetenda1331a2014-03-07 13:41:07 -0700127 struct jr3_pci_poll_delay result;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800128
129 result.min = min;
130 result.max = max;
131 return result;
132}
133
Ian Abbott95b24682012-10-15 12:20:00 +0100134static int is_complete(struct jr3_channel __iomem *channel)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800135{
136 return get_s16(&channel->command_word0) == 0;
137}
138
Ian Abbott95b24682012-10-15 12:20:00 +0100139static void set_transforms(struct jr3_channel __iomem *channel,
H Hartley Sweeten0a444932014-03-07 13:41:06 -0700140 struct jr3_pci_transform transf, short num)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800141{
142 int i;
143
Bill Pemberton2696fb52009-03-27 11:29:34 -0400144 num &= 0x000f; /* Make sure that 0 <= num <= 15 */
Anders Blomdell07b509e2009-02-12 16:07:16 -0800145 for (i = 0; i < 8; i++) {
Anders Blomdell07b509e2009-02-12 16:07:16 -0800146 set_u16(&channel->transforms[num].link[i].link_type,
147 transf.link[i].link_type);
Greg Kroah-Hartman5f74ea12009-04-27 14:44:31 -0700148 udelay(1);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800149 set_s16(&channel->transforms[num].link[i].link_amount,
150 transf.link[i].link_amount);
Greg Kroah-Hartman5f74ea12009-04-27 14:44:31 -0700151 udelay(1);
Stephane Pajotc77049e2011-05-09 15:51:59 +0200152 if (transf.link[i].link_type == end_x_form)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800153 break;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800154 }
155}
156
Ian Abbott95b24682012-10-15 12:20:00 +0100157static void use_transform(struct jr3_channel __iomem *channel,
Mithlesh Thukral0a85b6f2009-06-08 21:04:41 +0530158 short transf_num)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800159{
160 set_s16(&channel->command_word0, 0x0500 + (transf_num & 0x000f));
161}
162
Ian Abbott95b24682012-10-15 12:20:00 +0100163static void use_offset(struct jr3_channel __iomem *channel, short offset_num)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800164{
165 set_s16(&channel->command_word0, 0x0600 + (offset_num & 0x000f));
166}
167
Ian Abbott95b24682012-10-15 12:20:00 +0100168static void set_offset(struct jr3_channel __iomem *channel)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800169{
170 set_s16(&channel->command_word0, 0x0700);
171}
172
Bill Pemberton050509f2009-03-16 22:20:57 -0400173struct six_axis_t {
Anders Blomdell07b509e2009-02-12 16:07:16 -0800174 s16 fx;
175 s16 fy;
176 s16 fz;
177 s16 mx;
178 s16 my;
179 s16 mz;
Bill Pemberton050509f2009-03-16 22:20:57 -0400180};
Anders Blomdell07b509e2009-02-12 16:07:16 -0800181
Ian Abbott95b24682012-10-15 12:20:00 +0100182static void set_full_scales(struct jr3_channel __iomem *channel,
Mithlesh Thukral0a85b6f2009-06-08 21:04:41 +0530183 struct six_axis_t full_scale)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800184{
Anders Blomdell07b509e2009-02-12 16:07:16 -0800185 set_s16(&channel->full_scale.fx, full_scale.fx);
186 set_s16(&channel->full_scale.fy, full_scale.fy);
187 set_s16(&channel->full_scale.fz, full_scale.fz);
188 set_s16(&channel->full_scale.mx, full_scale.mx);
189 set_s16(&channel->full_scale.my, full_scale.my);
190 set_s16(&channel->full_scale.mz, full_scale.mz);
191 set_s16(&channel->command_word0, 0x0a00);
192}
193
Ian Abbott95b24682012-10-15 12:20:00 +0100194static struct six_axis_t get_min_full_scales(struct jr3_channel __iomem
Mithlesh Thukral0a85b6f2009-06-08 21:04:41 +0530195 *channel)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800196{
Bill Pemberton050509f2009-03-16 22:20:57 -0400197 struct six_axis_t result;
H Hartley Sweetencd9da612014-07-16 11:01:59 -0700198
Anders Blomdell07b509e2009-02-12 16:07:16 -0800199 result.fx = get_s16(&channel->min_full_scale.fx);
200 result.fy = get_s16(&channel->min_full_scale.fy);
201 result.fz = get_s16(&channel->min_full_scale.fz);
202 result.mx = get_s16(&channel->min_full_scale.mx);
203 result.my = get_s16(&channel->min_full_scale.my);
204 result.mz = get_s16(&channel->min_full_scale.mz);
205 return result;
206}
207
Ian Abbott95b24682012-10-15 12:20:00 +0100208static struct six_axis_t get_max_full_scales(struct jr3_channel __iomem
Mithlesh Thukral0a85b6f2009-06-08 21:04:41 +0530209 *channel)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800210{
Bill Pemberton050509f2009-03-16 22:20:57 -0400211 struct six_axis_t result;
H Hartley Sweetencd9da612014-07-16 11:01:59 -0700212
Anders Blomdell07b509e2009-02-12 16:07:16 -0800213 result.fx = get_s16(&channel->max_full_scale.fx);
214 result.fy = get_s16(&channel->max_full_scale.fy);
215 result.fz = get_s16(&channel->max_full_scale.fz);
216 result.mx = get_s16(&channel->max_full_scale.mx);
217 result.my = get_s16(&channel->max_full_scale.my);
218 result.mz = get_s16(&channel->max_full_scale.mz);
219 return result;
220}
221
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700222static unsigned int jr3_pci_ai_read_chan(struct comedi_device *dev,
223 struct comedi_subdevice *s,
224 unsigned int chan)
225{
226 struct jr3_pci_subdev_private *spriv = s->private;
227 unsigned int val = 0;
228
229 if (spriv->state != state_jr3_done)
230 return 0;
231
232 if (chan < 56) {
233 unsigned int axis = chan % 8;
Ravishankar Karkala Mallikarjunayya5efe1152016-06-06 16:31:23 +0530234 unsigned int filter = chan / 8;
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700235
236 switch (axis) {
237 case 0:
238 val = get_s16(&spriv->channel->filter[filter].fx);
239 break;
240 case 1:
241 val = get_s16(&spriv->channel->filter[filter].fy);
242 break;
243 case 2:
244 val = get_s16(&spriv->channel->filter[filter].fz);
245 break;
246 case 3:
247 val = get_s16(&spriv->channel->filter[filter].mx);
248 break;
249 case 4:
250 val = get_s16(&spriv->channel->filter[filter].my);
251 break;
252 case 5:
253 val = get_s16(&spriv->channel->filter[filter].mz);
254 break;
255 case 6:
256 val = get_s16(&spriv->channel->filter[filter].v1);
257 break;
258 case 7:
259 val = get_s16(&spriv->channel->filter[filter].v2);
260 break;
261 }
262 val += 0x4000;
263 } else if (chan == 56) {
264 val = get_u16(&spriv->channel->model_no);
265 } else if (chan == 57) {
266 val = get_u16(&spriv->channel->serial_no);
267 }
268
269 return val;
270}
271
Mithlesh Thukral0a85b6f2009-06-08 21:04:41 +0530272static int jr3_pci_ai_insn_read(struct comedi_device *dev,
273 struct comedi_subdevice *s,
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700274 struct comedi_insn *insn,
275 unsigned int *data)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800276{
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700277 struct jr3_pci_subdev_private *spriv = s->private;
278 unsigned int chan = CR_CHAN(insn->chanspec);
279 u16 errors;
280 int i;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800281
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700282 if (!spriv)
283 return -EINVAL;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800284
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700285 errors = get_u16(&spriv->channel->errors);
286 if (spriv->state != state_jr3_done ||
287 (errors & (watch_dog | watch_dog2 | sensor_change))) {
288 /* No sensor or sensor changed */
289 if (spriv->state == state_jr3_done) {
290 /* Restart polling */
291 spriv->state = state_jr3_poll;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800292 }
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700293 return -EAGAIN;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800294 }
H Hartley Sweeten16a86ab2014-03-07 13:41:03 -0700295
296 for (i = 0; i < insn->n; i++)
297 data[i] = jr3_pci_ai_read_chan(dev, s, chan);
298
299 return insn->n;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800300}
301
Ian Abbott3c17ba072010-05-19 14:10:00 +0100302static int jr3_pci_open(struct comedi_device *dev)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800303{
H Hartley Sweeten617cd652014-03-07 13:41:02 -0700304 struct jr3_pci_subdev_private *spriv;
305 struct comedi_subdevice *s;
306 int i;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800307
Ian Abbottf41ad662012-06-18 14:05:34 +0100308 dev_dbg(dev->class_dev, "jr3_pci_open\n");
H Hartley Sweetened8cd562014-03-07 13:41:05 -0700309 for (i = 0; i < dev->n_subdevices; i++) {
H Hartley Sweeten617cd652014-03-07 13:41:02 -0700310 s = &dev->subdevices[i];
311 spriv = s->private;
312 if (spriv)
313 dev_dbg(dev->class_dev, "serial: %p %d (%d)\n",
H Hartley Sweetend6ae5062014-03-07 13:41:08 -0700314 spriv, spriv->serial_no, s->index);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800315 }
Ian Abbott3c17ba072010-05-19 14:10:00 +0100316 return 0;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800317}
318
H Hartley Sweeten2ca9bc22012-09-17 13:14:08 -0700319static int read_idm_word(const u8 *data, size_t size, int *pos,
320 unsigned int *val)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800321{
322 int result = 0;
H Hartley Sweetencd9da612014-07-16 11:01:59 -0700323 int value;
324
H Hartley Sweeten57991b62012-09-17 13:17:19 -0700325 if (pos && val) {
Bill Pemberton2696fb52009-03-27 11:29:34 -0400326 /* Skip over non hex */
Ian Abbottabcdc992012-11-01 18:34:41 +0000327 for (; *pos < size && !isxdigit(data[*pos]); (*pos)++)
328 ;
Bill Pemberton2696fb52009-03-27 11:29:34 -0400329 /* Collect value */
Anders Blomdell07b509e2009-02-12 16:07:16 -0800330 *val = 0;
Andy Shevchenko3ff16c22010-06-15 17:25:38 +0300331 for (; *pos < size; (*pos)++) {
Andy Shevchenko3ff16c22010-06-15 17:25:38 +0300332 value = hex_to_bin(data[*pos]);
333 if (value >= 0) {
334 result = 1;
335 *val = (*val << 4) + value;
Ian Abbottabcdc992012-11-01 18:34:41 +0000336 } else {
Andy Shevchenko3ff16c22010-06-15 17:25:38 +0300337 break;
Ian Abbottabcdc992012-11-01 18:34:41 +0000338 }
Anders Blomdell07b509e2009-02-12 16:07:16 -0800339 }
340 }
341 return result;
342}
343
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700344static int jr3_check_firmware(struct comedi_device *dev,
345 const u8 *data, size_t size)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800346{
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700347 int more = 1;
348 int pos = 0;
349
Anders Blomdell07b509e2009-02-12 16:07:16 -0800350 /*
351 * IDM file format is:
352 * { count, address, data <count> } *
353 * ffff
354 */
Anders Blomdell07b509e2009-02-12 16:07:16 -0800355 while (more) {
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700356 unsigned int count = 0;
357 unsigned int addr = 0;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800358
359 more = more && read_idm_word(data, size, &pos, &count);
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700360 if (more && count == 0xffff)
361 return 0;
362
Anders Blomdell07b509e2009-02-12 16:07:16 -0800363 more = more && read_idm_word(data, size, &pos, &addr);
364 while (more && count > 0) {
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700365 unsigned int dummy = 0;
366
Anders Blomdell07b509e2009-02-12 16:07:16 -0800367 more = more && read_idm_word(data, size, &pos, &dummy);
368 count--;
369 }
370 }
371
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700372 return -ENODATA;
373}
Anders Blomdell07b509e2009-02-12 16:07:16 -0800374
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700375static void jr3_write_firmware(struct comedi_device *dev,
376 int subdev, const u8 *data, size_t size)
377{
378 struct jr3_pci_dev_private *devpriv = dev->private;
379 struct jr3_t __iomem *iobase = devpriv->iobase;
380 u32 __iomem *lo;
381 u32 __iomem *hi;
382 int more = 1;
383 int pos = 0;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800384
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700385 while (more) {
386 unsigned int count = 0;
387 unsigned int addr = 0;
388
389 more = more && read_idm_word(data, size, &pos, &count);
390 if (more && count == 0xffff)
391 return;
392
393 more = more && read_idm_word(data, size, &pos, &addr);
394
395 dev_dbg(dev->class_dev, "Loading#%d %4.4x bytes at %4.4x\n",
396 subdev, count, addr);
397
398 while (more && count > 0) {
399 if (addr & 0x4000) {
400 /* 16 bit data, never seen in real life!! */
401 unsigned int data1 = 0;
402
Ian Abbottabcdc992012-11-01 18:34:41 +0000403 more = more &&
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700404 read_idm_word(data, size, &pos, &data1);
405 count--;
406 /* jr3[addr + 0x20000 * pnum] = data1; */
407 } else {
408 /* Download 24 bit program */
409 unsigned int data1 = 0;
410 unsigned int data2 = 0;
411
412 lo = &iobase->channel[subdev].program_lo[addr];
413 hi = &iobase->channel[subdev].program_hi[addr];
414
Ian Abbottabcdc992012-11-01 18:34:41 +0000415 more = more &&
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700416 read_idm_word(data, size, &pos, &data1);
417 more = more &&
418 read_idm_word(data, size, &pos, &data2);
419 count -= 2;
420 if (more) {
421 set_u16(lo, data1);
422 udelay(1);
423 set_u16(hi, data2);
424 udelay(1);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800425 }
426 }
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700427 addr++;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800428 }
429 }
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700430}
431
432static int jr3_download_firmware(struct comedi_device *dev,
433 const u8 *data, size_t size,
434 unsigned long context)
435{
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700436 int subdev;
437 int ret;
438
439 /* verify IDM file format */
440 ret = jr3_check_firmware(dev, data, size);
441 if (ret)
442 return ret;
443
444 /* write firmware to each subdevice */
H Hartley Sweetened8cd562014-03-07 13:41:05 -0700445 for (subdev = 0; subdev < dev->n_subdevices; subdev++)
H Hartley Sweeten127301c2014-03-07 13:41:01 -0700446 jr3_write_firmware(dev, subdev, data, size);
447
448 return 0;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800449}
450
H Hartley Sweetenda1331a2014-03-07 13:41:07 -0700451static struct jr3_pci_poll_delay jr3_pci_poll_subdevice(struct comedi_subdevice *s)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800452{
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700453 struct jr3_pci_subdev_private *spriv = s->private;
H Hartley Sweetenda1331a2014-03-07 13:41:07 -0700454 struct jr3_pci_poll_delay result = poll_delay_min_max(1000, 2000);
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700455 struct jr3_channel __iomem *channel;
456 u16 model_no;
457 u16 serial_no;
458 int errors;
Ian Abbottb1f68dc2009-09-21 15:12:32 -0400459 int i;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800460
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700461 if (!spriv)
462 return result;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800463
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700464 channel = spriv->channel;
465 errors = get_u16(&channel->errors);
Kumar Amit Mehta7803d8e2012-11-07 04:08:09 -0800466
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700467 if (errors != spriv->errors)
468 spriv->errors = errors;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800469
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700470 /* Sensor communication lost? force poll mode */
471 if (errors & (watch_dog | watch_dog2 | sensor_change))
472 spriv->state = state_jr3_poll;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800473
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700474 switch (spriv->state) {
475 case state_jr3_poll:
476 model_no = get_u16(&channel->model_no);
477 serial_no = get_u16(&channel->serial_no);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800478
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700479 if ((errors & (watch_dog | watch_dog2)) ||
480 model_no == 0 || serial_no == 0) {
481 /*
482 * Still no sensor, keep on polling.
483 * Since it takes up to 10 seconds for offsets to
484 * stabilize, polling each second should suffice.
485 */
486 } else {
487 spriv->retries = 0;
488 spriv->state = state_jr3_init_wait_for_offset;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800489 }
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700490 break;
491 case state_jr3_init_wait_for_offset:
492 spriv->retries++;
493 if (spriv->retries < 10) {
494 /*
495 * Wait for offeset to stabilize
496 * (< 10 s according to manual)
497 */
498 } else {
H Hartley Sweeten0a444932014-03-07 13:41:06 -0700499 struct jr3_pci_transform transf;
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700500
501 spriv->model_no = get_u16(&channel->model_no);
502 spriv->serial_no = get_u16(&channel->serial_no);
503
504 /* Transformation all zeros */
505 for (i = 0; i < ARRAY_SIZE(transf.link); i++) {
506 transf.link[i].link_type = (enum link_types)0;
507 transf.link[i].link_amount = 0;
508 }
509
510 set_transforms(channel, transf, 0);
511 use_transform(channel, 0);
512 spriv->state = state_jr3_init_transform_complete;
513 /* Allow 20 ms for completion */
514 result = poll_delay_min_max(20, 100);
515 }
516 break;
517 case state_jr3_init_transform_complete:
518 if (!is_complete(channel)) {
519 result = poll_delay_min_max(20, 100);
520 } else {
521 /* Set full scale */
522 struct six_axis_t min_full_scale;
523 struct six_axis_t max_full_scale;
524
525 min_full_scale = get_min_full_scales(channel);
526 max_full_scale = get_max_full_scales(channel);
527 set_full_scales(channel, max_full_scale);
528
529 spriv->state = state_jr3_init_set_full_scale_complete;
530 /* Allow 20 ms for completion */
531 result = poll_delay_min_max(20, 100);
532 }
533 break;
534 case state_jr3_init_set_full_scale_complete:
535 if (!is_complete(channel)) {
536 result = poll_delay_min_max(20, 100);
537 } else {
538 struct force_array __iomem *fs = &channel->full_scale;
539
540 /* Use ranges in kN or we will overflow around 2000N! */
541 spriv->range[0].range.min = -get_s16(&fs->fx) * 1000;
542 spriv->range[0].range.max = get_s16(&fs->fx) * 1000;
543 spriv->range[1].range.min = -get_s16(&fs->fy) * 1000;
544 spriv->range[1].range.max = get_s16(&fs->fy) * 1000;
545 spriv->range[2].range.min = -get_s16(&fs->fz) * 1000;
546 spriv->range[2].range.max = get_s16(&fs->fz) * 1000;
547 spriv->range[3].range.min = -get_s16(&fs->mx) * 100;
548 spriv->range[3].range.max = get_s16(&fs->mx) * 100;
549 spriv->range[4].range.min = -get_s16(&fs->my) * 100;
550 spriv->range[4].range.max = get_s16(&fs->my) * 100;
551 spriv->range[5].range.min = -get_s16(&fs->mz) * 100;
552 /* the next five are questionable */
553 spriv->range[5].range.max = get_s16(&fs->mz) * 100;
554 spriv->range[6].range.min = -get_s16(&fs->v1) * 100;
555 spriv->range[6].range.max = get_s16(&fs->v1) * 100;
556 spriv->range[7].range.min = -get_s16(&fs->v2) * 100;
557 spriv->range[7].range.max = get_s16(&fs->v2) * 100;
558 spriv->range[8].range.min = 0;
559 spriv->range[8].range.max = 65535;
560
561 use_offset(channel, 0);
562 spriv->state = state_jr3_init_use_offset_complete;
563 /* Allow 40 ms for completion */
564 result = poll_delay_min_max(40, 100);
565 }
566 break;
567 case state_jr3_init_use_offset_complete:
568 if (!is_complete(channel)) {
569 result = poll_delay_min_max(20, 100);
570 } else {
571 set_s16(&channel->offsets.fx, 0);
572 set_s16(&channel->offsets.fy, 0);
573 set_s16(&channel->offsets.fz, 0);
574 set_s16(&channel->offsets.mx, 0);
575 set_s16(&channel->offsets.my, 0);
576 set_s16(&channel->offsets.mz, 0);
577
578 set_offset(channel);
579
580 spriv->state = state_jr3_done;
581 }
582 break;
583 case state_jr3_done:
584 result = poll_delay_min_max(10000, 20000);
585 break;
586 default:
587 break;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800588 }
H Hartley Sweeten01fca472014-03-07 13:41:00 -0700589
Anders Blomdell07b509e2009-02-12 16:07:16 -0800590 return result;
591}
592
593static void jr3_pci_poll_dev(unsigned long data)
594{
Mithlesh Thukral0a85b6f2009-06-08 21:04:41 +0530595 struct comedi_device *dev = (struct comedi_device *)data;
Bill Pemberton217fbbb2009-03-16 22:15:24 -0400596 struct jr3_pci_dev_private *devpriv = dev->private;
H Hartley Sweetena4483762014-03-07 13:40:59 -0700597 struct jr3_pci_subdev_private *spriv;
598 struct comedi_subdevice *s;
599 unsigned long flags;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800600 unsigned long now;
601 int delay;
602 int i;
603
Greg Kroah-Hartman5f74ea12009-04-27 14:44:31 -0700604 spin_lock_irqsave(&dev->spinlock, flags);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800605 delay = 1000;
606 now = jiffies;
H Hartley Sweetena4483762014-03-07 13:40:59 -0700607
608 /* Poll all channels that are ready to be polled */
H Hartley Sweetened8cd562014-03-07 13:41:05 -0700609 for (i = 0; i < dev->n_subdevices; i++) {
H Hartley Sweetena4483762014-03-07 13:40:59 -0700610 s = &dev->subdevices[i];
611 spriv = s->private;
612
613 if (now > spriv->next_time_min) {
H Hartley Sweetenda1331a2014-03-07 13:41:07 -0700614 struct jr3_pci_poll_delay sub_delay;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800615
H Hartley Sweetena4483762014-03-07 13:40:59 -0700616 sub_delay = jr3_pci_poll_subdevice(s);
617
618 spriv->next_time_min = jiffies +
619 msecs_to_jiffies(sub_delay.min);
620 spriv->next_time_max = jiffies +
621 msecs_to_jiffies(sub_delay.max);
622
Ian Abbottabcdc992012-11-01 18:34:41 +0000623 if (sub_delay.max && sub_delay.max < delay)
624 /*
625 * Wake up as late as possible ->
626 * poll as many channels as possible at once.
627 */
Anders Blomdell07b509e2009-02-12 16:07:16 -0800628 delay = sub_delay.max;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800629 }
630 }
Greg Kroah-Hartman5f74ea12009-04-27 14:44:31 -0700631 spin_unlock_irqrestore(&dev->spinlock, flags);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800632
633 devpriv->timer.expires = jiffies + msecs_to_jiffies(delay);
634 add_timer(&devpriv->timer);
635}
636
H Hartley Sweeten9e4d6742014-03-07 13:40:57 -0700637static struct jr3_pci_subdev_private *
638jr3_pci_alloc_spriv(struct comedi_device *dev, struct comedi_subdevice *s)
639{
640 struct jr3_pci_dev_private *devpriv = dev->private;
641 struct jr3_pci_subdev_private *spriv;
642 int j;
643 int k;
644
645 spriv = comedi_alloc_spriv(s, sizeof(*spriv));
646 if (!spriv)
647 return NULL;
648
649 spriv->channel = &devpriv->iobase->channel[s->index].data;
H Hartley Sweeten9e4d6742014-03-07 13:40:57 -0700650
651 for (j = 0; j < 8; j++) {
652 spriv->range[j].length = 1;
653 spriv->range[j].range.min = -1000000;
654 spriv->range[j].range.max = 1000000;
655
656 for (k = 0; k < 7; k++) {
657 spriv->range_table_list[j + k * 8] =
658 (struct comedi_lrange *)&spriv->range[j];
659 spriv->maxdata_list[j + k * 8] = 0x7fff;
660 }
661 }
662 spriv->range[8].length = 1;
663 spriv->range[8].range.min = 0;
664 spriv->range[8].range.max = 65536;
665
666 spriv->range_table_list[56] = (struct comedi_lrange *)&spriv->range[8];
667 spriv->range_table_list[57] = (struct comedi_lrange *)&spriv->range[8];
668 spriv->maxdata_list[56] = 0xffff;
669 spriv->maxdata_list[57] = 0xffff;
670
671 dev_dbg(dev->class_dev, "p->channel %p %p (%tx)\n",
672 spriv->channel, devpriv->iobase,
673 ((char __iomem *)spriv->channel -
674 (char __iomem *)devpriv->iobase));
675
676 return spriv;
677}
678
Bill Pembertona690b7e2012-11-19 13:21:58 -0500679static int jr3_pci_auto_attach(struct comedi_device *dev,
H Hartley Sweeten72118062014-03-11 10:03:31 -0700680 unsigned long context)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800681{
Ian Abbott6af0cf72012-11-01 18:34:36 +0000682 struct pci_dev *pcidev = comedi_to_pci_dev(dev);
Vladimir A. Nazarenko165356c2014-08-27 17:48:21 +1100683 static const struct jr3_pci_board *board;
Bill Pemberton217fbbb2009-03-16 22:15:24 -0400684 struct jr3_pci_dev_private *devpriv;
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700685 struct jr3_pci_subdev_private *spriv;
H Hartley Sweeten050389f2014-03-07 13:40:55 -0700686 struct comedi_subdevice *s;
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700687 int ret;
H Hartley Sweeten050389f2014-03-07 13:40:55 -0700688 int i;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800689
Bill Pemberton67080792009-03-16 22:13:31 -0400690 if (sizeof(struct jr3_channel) != 0xc00) {
Ian Abbottf41ad662012-06-18 14:05:34 +0100691 dev_err(dev->class_dev,
692 "sizeof(struct jr3_channel) = %x [expected %x]\n",
Ravishankar Karkala Mallikarjunayya5efe1152016-06-06 16:31:23 +0530693 (unsigned int)sizeof(struct jr3_channel), 0xc00);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800694 return -EINVAL;
695 }
696
H Hartley Sweeten72118062014-03-11 10:03:31 -0700697 if (context < ARRAY_SIZE(jr3_pci_boards))
698 board = &jr3_pci_boards[context];
699 if (!board)
700 return -ENODEV;
701 dev->board_ptr = board;
702 dev->board_name = board->name;
703
H Hartley Sweeten0bdab502013-06-24 16:55:44 -0700704 devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
H Hartley Sweetenc34fa262012-10-23 13:22:37 -0700705 if (!devpriv)
706 return -ENOMEM;
H Hartley Sweeten9a1a6cf2012-10-15 10:15:52 -0700707
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700708 ret = comedi_pci_enable(dev);
709 if (ret)
710 return ret;
H Hartley Sweeten818f5692013-03-13 10:36:31 -0700711
H Hartley Sweeten8567a852013-04-10 11:31:05 -0700712 devpriv->iobase = pci_ioremap_bar(pcidev, 0);
Ian Abbottfa5c5f42009-11-30 10:59:27 +0000713 if (!devpriv->iobase)
714 return -ENOMEM;
715
H Hartley Sweetened8cd562014-03-07 13:41:05 -0700716 ret = comedi_alloc_subdevices(dev, board->n_subdevs);
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700717 if (ret)
718 return ret;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800719
720 dev->open = jr3_pci_open;
H Hartley Sweetened8cd562014-03-07 13:41:05 -0700721 for (i = 0; i < dev->n_subdevices; i++) {
H Hartley Sweeten050389f2014-03-07 13:40:55 -0700722 s = &dev->subdevices[i];
723 s->type = COMEDI_SUBD_AI;
724 s->subdev_flags = SDF_READABLE | SDF_GROUND;
725 s->n_chan = 8 * 7 + 2;
726 s->insn_read = jr3_pci_ai_insn_read;
727
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700728 spriv = jr3_pci_alloc_spriv(dev, s);
729 if (spriv) {
H Hartley Sweeten9e4d6742014-03-07 13:40:57 -0700730 /* Channel specific range and maxdata */
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700731 s->range_table_list = spriv->range_table_list;
732 s->maxdata_list = spriv->maxdata_list;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800733 }
734 }
735
Bill Pemberton2696fb52009-03-27 11:29:34 -0400736 /* Reset DSP card */
Ian Abbotte18789572012-09-27 17:45:27 +0100737 writel(0, &devpriv->iobase->channel[0].reset);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800738
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700739 ret = comedi_load_firmware(dev, &comedi_to_pci_dev(dev)->dev,
740 "comedi/jr3pci.idm",
741 jr3_download_firmware, 0);
742 dev_dbg(dev->class_dev, "Firmare load %d\n", ret);
743 if (ret < 0)
744 return ret;
Ian Abbottabcdc992012-11-01 18:34:41 +0000745 /*
746 * TODO: use firmware to load preferred offset tables. Suggested
747 * format:
748 * model serial Fx Fy Fz Mx My Mz\n
749 *
H Hartley Sweeten9ff8b152013-05-17 11:17:00 -0700750 * comedi_load_firmware(dev, &comedi_to_pci_dev(dev)->dev,
751 * "comedi/jr3_offsets_table",
H Hartley Sweetend5695412013-05-17 11:18:01 -0700752 * jr3_download_firmware, 1);
Ian Abbottabcdc992012-11-01 18:34:41 +0000753 */
Anders Blomdell07b509e2009-02-12 16:07:16 -0800754
Ian Abbottabcdc992012-11-01 18:34:41 +0000755 /*
756 * It takes a few milliseconds for software to settle as much as we
757 * can read firmware version
758 */
Anders Blomdell07b509e2009-02-12 16:07:16 -0800759 msleep_interruptible(25);
760 for (i = 0; i < 0x18; i++) {
Ian Abbottf41ad662012-06-18 14:05:34 +0100761 dev_dbg(dev->class_dev, "%c\n",
Ravishankar karkala Mallikarjunayya351a1d32011-12-12 10:49:25 +0530762 get_u16(&devpriv->iobase->channel[0].
763 data.copyright[i]) >> 8);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800764 }
765
Bill Pemberton2696fb52009-03-27 11:29:34 -0400766 /* Start card timer */
H Hartley Sweetened8cd562014-03-07 13:41:05 -0700767 for (i = 0; i < dev->n_subdevices; i++) {
H Hartley Sweeten050389f2014-03-07 13:40:55 -0700768 s = &dev->subdevices[i];
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700769 spriv = s->private;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800770
H Hartley Sweeten3c772742014-03-07 13:40:58 -0700771 spriv->next_time_min = jiffies + msecs_to_jiffies(500);
772 spriv->next_time_max = jiffies + msecs_to_jiffies(2000);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800773 }
774
Somya Anand81906c32015-03-11 17:02:13 +0530775 setup_timer(&devpriv->timer, jr3_pci_poll_dev, (unsigned long)dev);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800776 devpriv->timer.expires = jiffies + msecs_to_jiffies(1000);
777 add_timer(&devpriv->timer);
778
H Hartley Sweetenfb780d22014-02-03 11:26:51 -0700779 return 0;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800780}
781
H Hartley Sweeten484ecc92012-05-17 17:11:14 -0700782static void jr3_pci_detach(struct comedi_device *dev)
Anders Blomdell07b509e2009-02-12 16:07:16 -0800783{
Bill Pemberton217fbbb2009-03-16 22:15:24 -0400784 struct jr3_pci_dev_private *devpriv = dev->private;
Anders Blomdell07b509e2009-02-12 16:07:16 -0800785
Anders Blomdell07b509e2009-02-12 16:07:16 -0800786 if (devpriv) {
787 del_timer_sync(&devpriv->timer);
788
Stephane Pajotc77049e2011-05-09 15:51:59 +0200789 if (devpriv->iobase)
Ian Abbott95b24682012-10-15 12:20:00 +0100790 iounmap(devpriv->iobase);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800791 }
H Hartley Sweeten7f072f52013-03-13 10:35:51 -0700792 comedi_pci_disable(dev);
Anders Blomdell07b509e2009-02-12 16:07:16 -0800793}
794
H Hartley Sweeten75e63012012-05-11 16:16:20 -0700795static struct comedi_driver jr3_pci_driver = {
H Hartley Sweetendf611782012-05-04 15:57:24 -0700796 .driver_name = "jr3_pci",
797 .module = THIS_MODULE,
Ian Abbottb7703d72012-11-01 18:34:35 +0000798 .auto_attach = jr3_pci_auto_attach,
H Hartley Sweetendf611782012-05-04 15:57:24 -0700799 .detach = jr3_pci_detach,
800};
801
Bill Pembertona690b7e2012-11-19 13:21:58 -0500802static int jr3_pci_pci_probe(struct pci_dev *dev,
H Hartley Sweetenb8f4ac22013-03-05 09:53:41 -0700803 const struct pci_device_id *id)
Arun Thomas727b2862010-06-06 22:23:31 +0200804{
H Hartley Sweetenb8f4ac22013-03-05 09:53:41 -0700805 return comedi_pci_auto_config(dev, &jr3_pci_driver, id->driver_data);
Arun Thomas727b2862010-06-06 22:23:31 +0200806}
807
Jingoo Han41e043f2013-12-03 08:26:00 +0900808static const struct pci_device_id jr3_pci_pci_table[] = {
H Hartley Sweeten72118062014-03-11 10:03:31 -0700809 { PCI_VDEVICE(JR3, 0x1111), BOARD_JR3_1 },
810 { PCI_VDEVICE(JR3, 0x3111), BOARD_JR3_1 },
811 { PCI_VDEVICE(JR3, 0x3112), BOARD_JR3_2 },
812 { PCI_VDEVICE(JR3, 0x3113), BOARD_JR3_3 },
813 { PCI_VDEVICE(JR3, 0x3114), BOARD_JR3_4 },
H Hartley Sweetendf611782012-05-04 15:57:24 -0700814 { 0 }
815};
816MODULE_DEVICE_TABLE(pci, jr3_pci_pci_table);
817
H Hartley Sweeten75e63012012-05-11 16:16:20 -0700818static struct pci_driver jr3_pci_pci_driver = {
819 .name = "jr3_pci",
H Hartley Sweetendf611782012-05-04 15:57:24 -0700820 .id_table = jr3_pci_pci_table,
H Hartley Sweeten75e63012012-05-11 16:16:20 -0700821 .probe = jr3_pci_pci_probe,
Peter Huewe9901a4d2013-01-22 23:40:03 +0100822 .remove = comedi_pci_auto_unconfig,
Arun Thomas727b2862010-06-06 22:23:31 +0200823};
H Hartley Sweeten75e63012012-05-11 16:16:20 -0700824module_comedi_pci_driver(jr3_pci_driver, jr3_pci_pci_driver);
Arun Thomas90f703d2010-06-06 22:23:29 +0200825
826MODULE_AUTHOR("Comedi http://www.comedi.org");
827MODULE_DESCRIPTION("Comedi low-level driver");
828MODULE_LICENSE("GPL");
H Hartley Sweetendf611782012-05-04 15:57:24 -0700829MODULE_FIRMWARE("comedi/jr3pci.idm");