2 * comedi/drivers/ni_usb6501.c
3 * Comedi driver for National Instruments USB-6501
5 * COMEDI - Linux Control and Measurement Device Interface
6 * Copyright (C) 2014 Luca Ellero <luca.ellero@brickedbrain.com>
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.
21 * Description: National Instruments USB-6501 module
22 * Devices: [National Instruments] USB-6501 (ni_usb6501)
23 * Author: Luca Ellero <luca.ellero@brickedbrain.com>
28 * Configuration Options:
33 * NI-6501 - USB PROTOCOL DESCRIPTION
35 * Every command is composed by two USB packets:
39 * Every packet is at least 12 bytes long, here is the meaning of
40 * every field (all values are hex):
45 * byte 3 is the total packet length
48 * byte 5 is is the total packet length - 4
50 * byte 7 is the command
52 * byte 8 is 02 (request) or 00 (response)
53 * byte 9 is 00 (response) or 10 (port request) or 20 (counter request)
54 * byte 10 is always 00
55 * byte 11 is 00 (request) or 02 (response)
60 * REQ: 00 01 00 10 00 0C 01 0E 02 10 00 00 00 03 <PORT> 00
61 * RES: 00 01 00 10 00 0C 01 00 00 00 00 02 00 03 <BMAP> 00
64 * REQ: 00 01 00 14 00 10 01 0F 02 10 00 00 00 03 <PORT> 00 03 <BMAP> 00 00
65 * RES: 00 01 00 0C 00 08 01 00 00 00 00 02
67 * CMD: 0x12 SET_PORT_DIR (0 = input, 1 = output)
68 * REQ: 00 01 00 18 00 14 01 12 02 10 00 00
69 * 00 05 <PORT 0> <PORT 1> <PORT 2> 00 05 00 00 00 00 00
70 * RES: 00 01 00 0C 00 08 01 00 00 00 00 02
74 * CMD 0x9: START_COUNTER
75 * REQ: 00 01 00 0C 00 08 01 09 02 20 00 00
76 * RES: 00 01 00 0C 00 08 01 00 00 00 00 02
78 * CMD 0xC: STOP_COUNTER
79 * REQ: 00 01 00 0C 00 08 01 0C 02 20 00 00
80 * RES: 00 01 00 0C 00 08 01 00 00 00 00 02
82 * CMD 0xE: READ_COUNTER
83 * REQ: 00 01 00 0C 00 08 01 0E 02 20 00 00
84 * RES: 00 01 00 10 00 0C 01 00 00 00 00 02 <u32 counter value, Big Endian>
86 * CMD 0xF: WRITE_COUNTER
87 * REQ: 00 01 00 10 00 0C 01 0F 02 20 00 00 <u32 counter value, Big Endian>
88 * RES: 00 01 00 0C 00 08 01 00 00 00 00 02
91 * Please visit http://www.brickedbrain.com if you need
92 * additional information or have any questions.
96 #include <linux/kernel.h>
97 #include <linux/module.h>
98 #include <linux/slab.h>
100 #include "../comedi_usb.h"
102 #define NI6501_TIMEOUT 1000
104 /* Port request packets */
105 static const u8 READ_PORT_REQUEST[] = {0x00, 0x01, 0x00, 0x10,
106 0x00, 0x0C, 0x01, 0x0E,
107 0x02, 0x10, 0x00, 0x00,
108 0x00, 0x03, 0x00, 0x00};
110 static const u8 WRITE_PORT_REQUEST[] = {0x00, 0x01, 0x00, 0x14,
111 0x00, 0x10, 0x01, 0x0F,
112 0x02, 0x10, 0x00, 0x00,
113 0x00, 0x03, 0x00, 0x00,
114 0x03, 0x00, 0x00, 0x00};
116 static const u8 SET_PORT_DIR_REQUEST[] = {0x00, 0x01, 0x00, 0x18,
117 0x00, 0x14, 0x01, 0x12,
118 0x02, 0x10, 0x00, 0x00,
119 0x00, 0x05, 0x00, 0x00,
120 0x00, 0x00, 0x05, 0x00,
121 0x00, 0x00, 0x00, 0x00};
123 /* Counter request packets */
124 static const u8 START_COUNTER_REQUEST[] = {0x00, 0x01, 0x00, 0x0C,
125 0x00, 0x08, 0x01, 0x09,
126 0x02, 0x20, 0x00, 0x00};
128 static const u8 STOP_COUNTER_REQUEST[] = {0x00, 0x01, 0x00, 0x0C,
129 0x00, 0x08, 0x01, 0x0C,
130 0x02, 0x20, 0x00, 0x00};
132 static const u8 READ_COUNTER_REQUEST[] = {0x00, 0x01, 0x00, 0x0C,
133 0x00, 0x08, 0x01, 0x0E,
134 0x02, 0x20, 0x00, 0x00};
136 static const u8 WRITE_COUNTER_REQUEST[] = {0x00, 0x01, 0x00, 0x10,
137 0x00, 0x0C, 0x01, 0x0F,
138 0x02, 0x20, 0x00, 0x00,
139 0x00, 0x00, 0x00, 0x00};
141 /* Response packets */
142 static const u8 GENERIC_RESPONSE[] = {0x00, 0x01, 0x00, 0x0C,
143 0x00, 0x08, 0x01, 0x00,
144 0x00, 0x00, 0x00, 0x02};
146 static const u8 READ_PORT_RESPONSE[] = {0x00, 0x01, 0x00, 0x10,
147 0x00, 0x0C, 0x01, 0x00,
148 0x00, 0x00, 0x00, 0x02,
149 0x00, 0x03, 0x00, 0x00};
151 static const u8 READ_COUNTER_RESPONSE[] = {0x00, 0x01, 0x00, 0x10,
152 0x00, 0x0C, 0x01, 0x00,
153 0x00, 0x00, 0x00, 0x02,
154 0x00, 0x00, 0x00, 0x00};
166 struct ni6501_private {
167 struct usb_endpoint_descriptor *ep_rx;
168 struct usb_endpoint_descriptor *ep_tx;
174 static int ni6501_port_command(struct comedi_device *dev, int command,
175 unsigned int val, u8 *bitmap)
177 struct usb_device *usb = comedi_to_usb_dev(dev);
178 struct ni6501_private *devpriv = dev->private;
179 int request_size, response_size;
180 u8 *tx = devpriv->usb_tx_buf;
183 if (command != SET_PORT_DIR && !bitmap)
186 mutex_lock(&devpriv->mut);
190 request_size = sizeof(READ_PORT_REQUEST);
191 response_size = sizeof(READ_PORT_RESPONSE);
192 memcpy(tx, READ_PORT_REQUEST, request_size);
196 request_size = sizeof(WRITE_PORT_REQUEST);
197 response_size = sizeof(GENERIC_RESPONSE);
198 memcpy(tx, WRITE_PORT_REQUEST, request_size);
203 request_size = sizeof(SET_PORT_DIR_REQUEST);
204 response_size = sizeof(GENERIC_RESPONSE);
205 memcpy(tx, SET_PORT_DIR_REQUEST, request_size);
207 tx[15] = (val >> 8) & 0xff;
208 tx[16] = (val >> 16) & 0xff;
215 ret = usb_bulk_msg(usb,
217 devpriv->ep_tx->bEndpointAddress),
225 ret = usb_bulk_msg(usb,
227 devpriv->ep_rx->bEndpointAddress),
235 /* Check if results are valid */
237 if (command == READ_PORT) {
238 *bitmap = devpriv->usb_rx_buf[14];
239 /* mask bitmap for comparing */
240 devpriv->usb_rx_buf[14] = 0x00;
242 if (memcmp(devpriv->usb_rx_buf, READ_PORT_RESPONSE,
243 sizeof(READ_PORT_RESPONSE))) {
246 } else if (memcmp(devpriv->usb_rx_buf, GENERIC_RESPONSE,
247 sizeof(GENERIC_RESPONSE))) {
251 mutex_unlock(&devpriv->mut);
256 static int ni6501_counter_command(struct comedi_device *dev, int command,
259 struct usb_device *usb = comedi_to_usb_dev(dev);
260 struct ni6501_private *devpriv = dev->private;
261 int request_size, response_size;
262 u8 *tx = devpriv->usb_tx_buf;
265 if ((command == READ_COUNTER || command == WRITE_COUNTER) && !val)
268 mutex_lock(&devpriv->mut);
272 request_size = sizeof(START_COUNTER_REQUEST);
273 response_size = sizeof(GENERIC_RESPONSE);
274 memcpy(tx, START_COUNTER_REQUEST, request_size);
277 request_size = sizeof(STOP_COUNTER_REQUEST);
278 response_size = sizeof(GENERIC_RESPONSE);
279 memcpy(tx, STOP_COUNTER_REQUEST, request_size);
282 request_size = sizeof(READ_COUNTER_REQUEST);
283 response_size = sizeof(READ_COUNTER_RESPONSE);
284 memcpy(tx, READ_COUNTER_REQUEST, request_size);
287 request_size = sizeof(WRITE_COUNTER_REQUEST);
288 response_size = sizeof(GENERIC_RESPONSE);
289 memcpy(tx, WRITE_COUNTER_REQUEST, request_size);
290 /* Setup tx packet: bytes 12,13,14,15 hold the */
291 /* u32 counter value (Big Endian) */
292 *((__be32 *)&tx[12]) = cpu_to_be32(*val);
299 ret = usb_bulk_msg(usb,
301 devpriv->ep_tx->bEndpointAddress),
309 ret = usb_bulk_msg(usb,
311 devpriv->ep_rx->bEndpointAddress),
319 /* Check if results are valid */
321 if (command == READ_COUNTER) {
324 /* Read counter value: bytes 12,13,14,15 of rx packet */
325 /* hold the u32 counter value (Big Endian) */
326 *val = be32_to_cpu(*((__be32 *)&devpriv->usb_rx_buf[12]));
328 /* mask counter value for comparing */
329 for (i = 12; i < sizeof(READ_COUNTER_RESPONSE); ++i)
330 devpriv->usb_rx_buf[i] = 0x00;
332 if (memcmp(devpriv->usb_rx_buf, READ_COUNTER_RESPONSE,
333 sizeof(READ_COUNTER_RESPONSE))) {
336 } else if (memcmp(devpriv->usb_rx_buf, GENERIC_RESPONSE,
337 sizeof(GENERIC_RESPONSE))) {
341 mutex_unlock(&devpriv->mut);
346 static int ni6501_dio_insn_config(struct comedi_device *dev,
347 struct comedi_subdevice *s,
348 struct comedi_insn *insn,
353 ret = comedi_dio_insn_config(dev, s, insn, data, 0);
357 ret = ni6501_port_command(dev, SET_PORT_DIR, s->io_bits, NULL);
364 static int ni6501_dio_insn_bits(struct comedi_device *dev,
365 struct comedi_subdevice *s,
366 struct comedi_insn *insn,
374 mask = comedi_dio_update_state(s, data);
376 for (port = 0; port < 3; port++) {
377 if (mask & (0xFF << port * 8)) {
378 bitmap = (s->state >> port * 8) & 0xFF;
379 ret = ni6501_port_command(dev, WRITE_PORT,
388 for (port = 0; port < 3; port++) {
389 ret = ni6501_port_command(dev, READ_PORT, port, &bitmap);
392 data[1] |= bitmap << port * 8;
398 static int ni6501_cnt_insn_config(struct comedi_device *dev,
399 struct comedi_subdevice *s,
400 struct comedi_insn *insn,
407 case INSN_CONFIG_ARM:
408 ret = ni6501_counter_command(dev, START_COUNTER, NULL);
410 case INSN_CONFIG_DISARM:
411 ret = ni6501_counter_command(dev, STOP_COUNTER, NULL);
413 case INSN_CONFIG_RESET:
414 ret = ni6501_counter_command(dev, STOP_COUNTER, NULL);
417 ret = ni6501_counter_command(dev, WRITE_COUNTER, &val);
423 return ret ? ret : insn->n;
426 static int ni6501_cnt_insn_read(struct comedi_device *dev,
427 struct comedi_subdevice *s,
428 struct comedi_insn *insn,
435 for (i = 0; i < insn->n; i++) {
436 ret = ni6501_counter_command(dev, READ_COUNTER, &val);
445 static int ni6501_cnt_insn_write(struct comedi_device *dev,
446 struct comedi_subdevice *s,
447 struct comedi_insn *insn,
453 u32 val = data[insn->n - 1];
455 ret = ni6501_counter_command(dev, WRITE_COUNTER, &val);
463 static int ni6501_alloc_usb_buffers(struct comedi_device *dev)
465 struct ni6501_private *devpriv = dev->private;
468 size = le16_to_cpu(devpriv->ep_rx->wMaxPacketSize);
469 devpriv->usb_rx_buf = kzalloc(size, GFP_KERNEL);
470 if (!devpriv->usb_rx_buf)
473 size = le16_to_cpu(devpriv->ep_tx->wMaxPacketSize);
474 devpriv->usb_tx_buf = kzalloc(size, GFP_KERNEL);
475 if (!devpriv->usb_tx_buf) {
476 kfree(devpriv->usb_rx_buf);
483 static int ni6501_find_endpoints(struct comedi_device *dev)
485 struct usb_interface *intf = comedi_to_usb_interface(dev);
486 struct ni6501_private *devpriv = dev->private;
487 struct usb_host_interface *iface_desc = intf->cur_altsetting;
488 struct usb_endpoint_descriptor *ep_desc;
491 if (iface_desc->desc.bNumEndpoints != 2) {
492 dev_err(dev->class_dev, "Wrong number of endpoints\n");
496 for (i = 0; i < iface_desc->desc.bNumEndpoints; i++) {
497 ep_desc = &iface_desc->endpoint[i].desc;
499 if (usb_endpoint_is_bulk_in(ep_desc)) {
501 devpriv->ep_rx = ep_desc;
505 if (usb_endpoint_is_bulk_out(ep_desc)) {
507 devpriv->ep_tx = ep_desc;
512 if (!devpriv->ep_rx || !devpriv->ep_tx)
518 static int ni6501_auto_attach(struct comedi_device *dev,
519 unsigned long context)
521 struct usb_interface *intf = comedi_to_usb_interface(dev);
522 struct ni6501_private *devpriv;
523 struct comedi_subdevice *s;
526 devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
530 ret = ni6501_find_endpoints(dev);
534 ret = ni6501_alloc_usb_buffers(dev);
538 mutex_init(&devpriv->mut);
539 usb_set_intfdata(intf, devpriv);
541 ret = comedi_alloc_subdevices(dev, 2);
545 /* Digital Input/Output subdevice */
546 s = &dev->subdevices[0];
547 s->type = COMEDI_SUBD_DIO;
548 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
551 s->range_table = &range_digital;
552 s->insn_bits = ni6501_dio_insn_bits;
553 s->insn_config = ni6501_dio_insn_config;
555 /* Counter subdevice */
556 s = &dev->subdevices[1];
557 s->type = COMEDI_SUBD_COUNTER;
558 s->subdev_flags = SDF_READABLE | SDF_WRITABLE | SDF_LSAMPL;
560 s->maxdata = 0xffffffff;
561 s->insn_read = ni6501_cnt_insn_read;
562 s->insn_write = ni6501_cnt_insn_write;
563 s->insn_config = ni6501_cnt_insn_config;
568 static void ni6501_detach(struct comedi_device *dev)
570 struct usb_interface *intf = comedi_to_usb_interface(dev);
571 struct ni6501_private *devpriv = dev->private;
576 mutex_lock(&devpriv->mut);
578 usb_set_intfdata(intf, NULL);
580 kfree(devpriv->usb_rx_buf);
581 kfree(devpriv->usb_tx_buf);
583 mutex_unlock(&devpriv->mut);
586 static struct comedi_driver ni6501_driver = {
587 .module = THIS_MODULE,
588 .driver_name = "ni6501",
589 .auto_attach = ni6501_auto_attach,
590 .detach = ni6501_detach,
593 static int ni6501_usb_probe(struct usb_interface *intf,
594 const struct usb_device_id *id)
596 return comedi_usb_auto_config(intf, &ni6501_driver, id->driver_info);
599 static const struct usb_device_id ni6501_usb_table[] = {
600 { USB_DEVICE(0x3923, 0x718a) },
603 MODULE_DEVICE_TABLE(usb, ni6501_usb_table);
605 static struct usb_driver ni6501_usb_driver = {
607 .id_table = ni6501_usb_table,
608 .probe = ni6501_usb_probe,
609 .disconnect = comedi_usb_auto_unconfig,
611 module_comedi_usb_driver(ni6501_driver, ni6501_usb_driver);
613 MODULE_AUTHOR("Luca Ellero");
614 MODULE_DESCRIPTION("Comedi driver for National Instruments USB-6501");
615 MODULE_LICENSE("GPL");