drivers/staging/comedi/drivers/dt9812.c

   1 /*
   2  * comedi/drivers/dt9812.c
   3  *   COMEDI driver for DataTranslation DT9812 USB module
   4  *
   5  * Copyright (C) 2005 Anders Blomdell <anders.blomdell@control.lth.se>
   6  *
   7  * COMEDI - Linux Control and Measurement Device Interface
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13
  14  *  This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  */
  24
  25 /*
  26 Driver: dt9812
  27 Description: Data Translation DT9812 USB module
  28 Author: anders.blomdell@control.lth.se (Anders Blomdell)
  29 Status: in development
  30 Devices: [Data Translation] DT9812 (dt9812)
  31 Updated: Sun Nov 20 20:18:34 EST 2005
  32
  33 This driver works, but bulk transfers not implemented. Might be a starting point
  34 for someone else. I found out too late that USB has too high latencies (>1 ms)
  35 for my needs.
  36 */
  37
  38 /*
  39  * Nota Bene:
  40  *   1. All writes to command pipe has to be 32 bytes (ISP1181B SHRTP=0 ?)
  41  *   2. The DDK source (as of sep 2005) is in error regarding the
  42  *      input MUX bits (example code says P4, but firmware schematics
  43  *      says P1).
  44  */
  45
  46 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  47
  48 #include <linux/kernel.h>
  49 #include <linux/errno.h>
  50 #include <linux/init.h>
  51 #include <linux/slab.h>
  52 #include <linux/module.h>
  53 #include <linux/kref.h>
  54 #include <linux/uaccess.h>
  55 #include <linux/usb.h>
  56
  57 #include "../comedidev.h"
  58
  59 #define DT9812_DIAGS_BOARD_INFO_ADDR    0xFBFF
  60 #define DT9812_MAX_WRITE_CMD_PIPE_SIZE  32
  61 #define DT9812_MAX_READ_CMD_PIPE_SIZE   32
  62
  63 /*
  64  * See Silican Laboratories C8051F020/1/2/3 manual
  65  */
  66 #define F020_SFR_P4                     0x84
  67 #define F020_SFR_P1                     0x90
  68 #define F020_SFR_P2                     0xa0
  69 #define F020_SFR_P3                     0xb0
  70 #define F020_SFR_AMX0CF                 0xba
  71 #define F020_SFR_AMX0SL                 0xbb
  72 #define F020_SFR_ADC0CF                 0xbc
  73 #define F020_SFR_ADC0L                  0xbe
  74 #define F020_SFR_ADC0H                  0xbf
  75 #define F020_SFR_DAC0L                  0xd2
  76 #define F020_SFR_DAC0H                  0xd3
  77 #define F020_SFR_DAC0CN                 0xd4
  78 #define F020_SFR_DAC1L                  0xd5
  79 #define F020_SFR_DAC1H                  0xd6
  80 #define F020_SFR_DAC1CN                 0xd7
  81 #define F020_SFR_ADC0CN                 0xe8
  82
  83 #define F020_MASK_ADC0CF_AMP0GN0        0x01
  84 #define F020_MASK_ADC0CF_AMP0GN1        0x02
  85 #define F020_MASK_ADC0CF_AMP0GN2        0x04
  86
  87 #define F020_MASK_ADC0CN_AD0EN          0x80
  88 #define F020_MASK_ADC0CN_AD0INT         0x20
  89 #define F020_MASK_ADC0CN_AD0BUSY        0x10
  90
  91 #define F020_MASK_DACxCN_DACxEN         0x80
  92
  93 enum {
  94         /* A/D  D/A  DI  DO  CT */
  95         DT9812_DEVID_DT9812_10, /*  8    2   8   8   1  +/- 10V */
  96         DT9812_DEVID_DT9812_2PT5,       /* 8    2   8   8   1  0-2.44V */
  97 #if 0
  98         DT9812_DEVID_DT9813,    /*  16   2   4   4   1  +/- 10V */
  99         DT9812_DEVID_DT9814     /*  24   2   0   0   1  +/- 10V */
 100 #endif
 101 };
 102
 103 enum dt9812_gain {
 104         DT9812_GAIN_0PT25 = 1,
 105         DT9812_GAIN_0PT5 = 2,
 106         DT9812_GAIN_1 = 4,
 107         DT9812_GAIN_2 = 8,
 108         DT9812_GAIN_4 = 16,
 109         DT9812_GAIN_8 = 32,
 110         DT9812_GAIN_16 = 64,
 111 };
 112
 113 enum {
 114         DT9812_LEAST_USB_FIRMWARE_CMD_CODE = 0,
 115         /* Write Flash memory */
 116         DT9812_W_FLASH_DATA = 0,
 117         /* Read Flash memory misc config info */
 118         DT9812_R_FLASH_DATA = 1,
 119
 120         /*
 121          * Register read/write commands for processor
 122          */
 123
 124         /* Read a single byte of USB memory */
 125         DT9812_R_SINGLE_BYTE_REG = 2,
 126         /* Write a single byte of USB memory */
 127         DT9812_W_SINGLE_BYTE_REG = 3,
 128         /* Multiple Reads of USB memory */
 129         DT9812_R_MULTI_BYTE_REG = 4,
 130         /* Multiple Writes of USB memory */
 131         DT9812_W_MULTI_BYTE_REG = 5,
 132         /* Read, (AND) with mask, OR value, then write (single) */
 133         DT9812_RMW_SINGLE_BYTE_REG = 6,
 134         /* Read, (AND) with mask, OR value, then write (multiple) */
 135         DT9812_RMW_MULTI_BYTE_REG = 7,
 136
 137         /*
 138          * Register read/write commands for SMBus
 139          */
 140
 141         /* Read a single byte of SMBus */
 142         DT9812_R_SINGLE_BYTE_SMBUS = 8,
 143         /* Write a single byte of SMBus */
 144         DT9812_W_SINGLE_BYTE_SMBUS = 9,
 145         /* Multiple Reads of SMBus */
 146         DT9812_R_MULTI_BYTE_SMBUS = 10,
 147         /* Multiple Writes of SMBus */
 148         DT9812_W_MULTI_BYTE_SMBUS = 11,
 149
 150         /*
 151          * Register read/write commands for a device
 152          */
 153
 154         /* Read a single byte of a device */
 155         DT9812_R_SINGLE_BYTE_DEV = 12,
 156         /* Write a single byte of a device */
 157         DT9812_W_SINGLE_BYTE_DEV = 13,
 158         /* Multiple Reads of a device */
 159         DT9812_R_MULTI_BYTE_DEV = 14,
 160         /* Multiple Writes of a device */
 161         DT9812_W_MULTI_BYTE_DEV = 15,
 162
 163         /* Not sure if we'll need this */
 164         DT9812_W_DAC_THRESHOLD = 16,
 165
 166         /* Set interrupt on change mask */
 167         DT9812_W_INT_ON_CHANGE_MASK = 17,
 168
 169         /* Write (or Clear) the CGL for the ADC */
 170         DT9812_W_CGL = 18,
 171         /* Multiple Reads of USB memory */
 172         DT9812_R_MULTI_BYTE_USBMEM = 19,
 173         /* Multiple Writes to USB memory */
 174         DT9812_W_MULTI_BYTE_USBMEM = 20,
 175
 176         /* Issue a start command to a given subsystem */
 177         DT9812_START_SUBSYSTEM = 21,
 178         /* Issue a stop command to a given subsystem */
 179         DT9812_STOP_SUBSYSTEM = 22,
 180
 181         /* calibrate the board using CAL_POT_CMD */
 182         DT9812_CALIBRATE_POT = 23,
 183         /* set the DAC FIFO size */
 184         DT9812_W_DAC_FIFO_SIZE = 24,
 185         /* Write or Clear the CGL for the DAC */
 186         DT9812_W_CGL_DAC = 25,
 187         /* Read a single value from a subsystem */
 188         DT9812_R_SINGLE_VALUE_CMD = 26,
 189         /* Write a single value to a subsystem */
 190         DT9812_W_SINGLE_VALUE_CMD = 27,
 191         /* Valid DT9812_USB_FIRMWARE_CMD_CODE's will be less than this number */
 192         DT9812_MAX_USB_FIRMWARE_CMD_CODE,
 193 };
 194
 195 struct dt9812_flash_data {
 196         u16 numbytes;
 197         u16 address;
 198 };
 199
 200 #define DT9812_MAX_NUM_MULTI_BYTE_RDS  \
 201         ((DT9812_MAX_WRITE_CMD_PIPE_SIZE - 4 - 1) / sizeof(u8))
 202
 203 struct dt9812_read_multi {
 204         u8 count;
 205         u8 address[DT9812_MAX_NUM_MULTI_BYTE_RDS];
 206 };
 207
 208 struct dt9812_write_byte {
 209         u8 address;
 210         u8 value;
 211 };
 212
 213 #define DT9812_MAX_NUM_MULTI_BYTE_WRTS  \
 214         ((DT9812_MAX_WRITE_CMD_PIPE_SIZE - 4 - 1) / \
 215          sizeof(struct dt9812_write_byte))
 216
 217 struct dt9812_write_multi {
 218         u8 count;
 219         struct dt9812_write_byte write[DT9812_MAX_NUM_MULTI_BYTE_WRTS];
 220 };
 221
 222 struct dt9812_rmw_byte {
 223         u8 address;
 224         u8 and_mask;
 225         u8 or_value;
 226 };
 227
 228 #define DT9812_MAX_NUM_MULTI_BYTE_RMWS  \
 229         ((DT9812_MAX_WRITE_CMD_PIPE_SIZE - 4 - 1) / \
 230          sizeof(struct dt9812_rmw_byte))
 231
 232 struct dt9812_rmw_multi {
 233         u8 count;
 234         struct dt9812_rmw_byte rmw[DT9812_MAX_NUM_MULTI_BYTE_RMWS];
 235 };
 236
 237 struct dt9812_usb_cmd {
 238         u32 cmd;
 239         union {
 240                 struct dt9812_flash_data flash_data_info;
 241                 struct dt9812_read_multi read_multi_info;
 242                 struct dt9812_write_multi write_multi_info;
 243                 struct dt9812_rmw_multi rmw_multi_info;
 244         } u;
 245 #if 0
 246         WRITE_BYTE_INFO WriteByteInfo;
 247         READ_BYTE_INFO ReadByteInfo;
 248         WRITE_MULTI_INFO WriteMultiInfo;
 249         READ_MULTI_INFO ReadMultiInfo;
 250         RMW_BYTE_INFO RMWByteInfo;
 251         RMW_MULTI_INFO RMWMultiInfo;
 252         DAC_THRESHOLD_INFO DacThresholdInfo;
 253         INT_ON_CHANGE_MASK_INFO IntOnChangeMaskInfo;
 254         CGL_INFO CglInfo;
 255         SUBSYSTEM_INFO SubsystemInfo;
 256         CAL_POT_CMD CalPotCmd;
 257         WRITE_DEV_BYTE_INFO WriteDevByteInfo;
 258         READ_DEV_BYTE_INFO ReadDevByteInfo;
 259         WRITE_DEV_MULTI_INFO WriteDevMultiInfo;
 260         READ_DEV_MULTI_INFO ReadDevMultiInfo;
 261         READ_SINGLE_VALUE_INFO ReadSingleValueInfo;
 262         WRITE_SINGLE_VALUE_INFO WriteSingleValueInfo;
 263 #endif
 264 };
 265
 266 #define DT9812_NUM_SLOTS        16
 267
 268 static DEFINE_SEMAPHORE(dt9812_mutex);
 269
 270 static const struct usb_device_id dt9812_table[] = {
 271         {USB_DEVICE(0x0867, 0x9812)},
 272         {}                      /* Terminating entry */
 273 };
 274
 275 MODULE_DEVICE_TABLE(usb, dt9812_table);
 276
 277 struct usb_dt9812 {
 278         struct slot_dt9812 *slot;
 279         struct usb_device *udev;
 280         struct usb_interface *interface;
 281         u16 vendor;
 282         u16 product;
 283         u16 device;
 284         u32 serial;
 285         struct {
 286                 __u8 addr;
 287                 size_t size;
 288         } message_pipe, command_write, command_read, write_stream, read_stream;
 289         struct kref kref;
 290         u16 analog_out_shadow[2];
 291         u8 digital_out_shadow;
 292 };
 293
 294 struct comedi_dt9812 {
 295         struct slot_dt9812 *slot;
 296         u32 serial;
 297 };
 298
 299 struct slot_dt9812 {
 300         struct semaphore mutex;
 301         u32 serial;
 302         struct usb_dt9812 *usb;
 303         struct comedi_dt9812 *comedi;
 304 };
 305
 306 static const struct comedi_lrange dt9812_10_ain_range = { 1, {
 307                                                               BIP_RANGE(10),
 308                                                               }
 309 };
 310
 311 static const struct comedi_lrange dt9812_2pt5_ain_range = { 1, {
 312                                                                 UNI_RANGE(2.5),
 313                                                                 }
 314 };
 315
 316 static const struct comedi_lrange dt9812_10_aout_range = { 1, {
 317                                                                BIP_RANGE(10),
 318                                                                }
 319 };
 320
 321 static const struct comedi_lrange dt9812_2pt5_aout_range = { 1, {
 322                                                                  UNI_RANGE(2.5),
 323                                                                  }
 324 };
 325
 326 static struct slot_dt9812 dt9812[DT9812_NUM_SLOTS];
 327
 328 static inline struct usb_dt9812 *to_dt9812_dev(struct kref *d)
 329 {
 330         return container_of(d, struct usb_dt9812, kref);
 331 }
 332
 333 static void dt9812_delete(struct kref *kref)
 334 {
 335         struct usb_dt9812 *dev = to_dt9812_dev(kref);
 336
 337         usb_put_dev(dev->udev);
 338         kfree(dev);
 339 }
 340
 341 static int dt9812_read_info(struct usb_dt9812 *dev, int offset, void *buf,
 342                             size_t buf_size)
 343 {
 344         struct dt9812_usb_cmd cmd;
 345         int count, retval;
 346
 347         cmd.cmd = cpu_to_le32(DT9812_R_FLASH_DATA);
 348         cmd.u.flash_data_info.address =
 349             cpu_to_le16(DT9812_DIAGS_BOARD_INFO_ADDR + offset);
 350         cmd.u.flash_data_info.numbytes = cpu_to_le16(buf_size);
 351
 352         /* DT9812 only responds to 32 byte writes!! */
 353         count = 32;
 354         retval = usb_bulk_msg(dev->udev,
 355                               usb_sndbulkpipe(dev->udev,
 356                                               dev->command_write.addr),
 357                               &cmd, 32, &count, HZ * 1);
 358         if (retval)
 359                 return retval;
 360         retval = usb_bulk_msg(dev->udev,
 361                               usb_rcvbulkpipe(dev->udev,
 362                                               dev->command_read.addr),
 363                               buf, buf_size, &count, HZ * 1);
 364         return retval;
 365 }
 366
 367 static int dt9812_read_multiple_registers(struct usb_dt9812 *dev, int reg_count,
 368                                           u8 *address, u8 *value)
 369 {
 370         struct dt9812_usb_cmd cmd;
 371         int i, count, retval;
 372
 373         cmd.cmd = cpu_to_le32(DT9812_R_MULTI_BYTE_REG);
 374         cmd.u.read_multi_info.count = reg_count;
 375         for (i = 0; i < reg_count; i++)
 376                 cmd.u.read_multi_info.address[i] = address[i];
 377
 378         /* DT9812 only responds to 32 byte writes!! */
 379         count = 32;
 380         retval = usb_bulk_msg(dev->udev,
 381                               usb_sndbulkpipe(dev->udev,
 382                                               dev->command_write.addr),
 383                               &cmd, 32, &count, HZ * 1);
 384         if (retval)
 385                 return retval;
 386         retval = usb_bulk_msg(dev->udev,
 387                               usb_rcvbulkpipe(dev->udev,
 388                                               dev->command_read.addr),
 389                               value, reg_count, &count, HZ * 1);
 390         return retval;
 391 }
 392
 393 static int dt9812_write_multiple_registers(struct usb_dt9812 *dev,
 394                                            int reg_count, u8 *address,
 395                                            u8 *value)
 396 {
 397         struct dt9812_usb_cmd cmd;
 398         int i, count, retval;
 399
 400         cmd.cmd = cpu_to_le32(DT9812_W_MULTI_BYTE_REG);
 401         cmd.u.read_multi_info.count = reg_count;
 402         for (i = 0; i < reg_count; i++) {
 403                 cmd.u.write_multi_info.write[i].address = address[i];
 404                 cmd.u.write_multi_info.write[i].value = value[i];
 405         }
 406         /* DT9812 only responds to 32 byte writes!! */
 407         retval = usb_bulk_msg(dev->udev,
 408                               usb_sndbulkpipe(dev->udev,
 409                                               dev->command_write.addr),
 410                               &cmd, 32, &count, HZ * 1);
 411         return retval;
 412 }
 413
 414 static int dt9812_rmw_multiple_registers(struct usb_dt9812 *dev, int reg_count,
 415                                          struct dt9812_rmw_byte *rmw)
 416 {
 417         struct dt9812_usb_cmd cmd;
 418         int i, count, retval;
 419
 420         cmd.cmd = cpu_to_le32(DT9812_RMW_MULTI_BYTE_REG);
 421         cmd.u.rmw_multi_info.count = reg_count;
 422         for (i = 0; i < reg_count; i++)
 423                 cmd.u.rmw_multi_info.rmw[i] = rmw[i];
 424
 425         /* DT9812 only responds to 32 byte writes!! */
 426         retval = usb_bulk_msg(dev->udev,
 427                               usb_sndbulkpipe(dev->udev,
 428                                               dev->command_write.addr),
 429                               &cmd, 32, &count, HZ * 1);
 430         return retval;
 431 }
 432
 433 static int dt9812_digital_in(struct slot_dt9812 *slot, u8 *bits)
 434 {
 435         int result = -ENODEV;
 436
 437         down(&slot->mutex);
 438         if (slot->usb) {
 439                 u8 reg[2] = { F020_SFR_P3, F020_SFR_P1 };
 440                 u8 value[2];
 441
 442                 result = dt9812_read_multiple_registers(slot->usb, 2, reg,
 443                                                         value);
 444                 if (result == 0) {
 445                         /*
 446                          * bits 0-6 in F020_SFR_P3 are bits 0-6 in the digital
 447                          * input port bit 3 in F020_SFR_P1 is bit 7 in the
 448                          * digital input port
 449                          */
 450                         *bits = (value[0] & 0x7f) | ((value[1] & 0x08) << 4);
 451                         /* printk("%2.2x, %2.2x -> %2.2x\n",
 452                            value[0], value[1], *bits); */
 453                 }
 454         }
 455         up(&slot->mutex);
 456
 457         return result;
 458 }
 459
 460 static int dt9812_digital_out(struct slot_dt9812 *slot, u8 bits)
 461 {
 462         int result = -ENODEV;
 463
 464         down(&slot->mutex);
 465         if (slot->usb) {
 466                 u8 reg[1];
 467                 u8 value[1];
 468
 469                 reg[0] = F020_SFR_P2;
 470                 value[0] = bits;
 471                 result = dt9812_write_multiple_registers(slot->usb, 1, reg,
 472                                                          value);
 473                 slot->usb->digital_out_shadow = bits;
 474         }
 475         up(&slot->mutex);
 476         return result;
 477 }
 478
 479 static int dt9812_digital_out_shadow(struct slot_dt9812 *slot, u8 *bits)
 480 {
 481         int result = -ENODEV;
 482
 483         down(&slot->mutex);
 484         if (slot->usb) {
 485                 *bits = slot->usb->digital_out_shadow;
 486                 result = 0;
 487         }
 488         up(&slot->mutex);
 489         return result;
 490 }
 491
 492 static void dt9812_configure_mux(struct usb_dt9812 *dev,
 493                                  struct dt9812_rmw_byte *rmw, int channel)
 494 {
 495         if (dev->device == DT9812_DEVID_DT9812_10) {
 496                 /* In the DT9812/10V MUX is selected by P1.5-7 */
 497                 rmw->address = F020_SFR_P1;
 498                 rmw->and_mask = 0xe0;
 499                 rmw->or_value = channel << 5;
 500         } else {
 501                 /* In the DT9812/2.5V, internal mux is selected by bits 0:2 */
 502                 rmw->address = F020_SFR_AMX0SL;
 503                 rmw->and_mask = 0xff;
 504                 rmw->or_value = channel & 0x07;
 505         }
 506 }
 507
 508 static void dt9812_configure_gain(struct usb_dt9812 *dev,
 509                                   struct dt9812_rmw_byte *rmw,
 510                                   enum dt9812_gain gain)
 511 {
 512         if (dev->device == DT9812_DEVID_DT9812_10) {
 513                 /* In the DT9812/10V, there is an external gain of 0.5 */
 514                 gain <<= 1;
 515         }
 516
 517         rmw->address = F020_SFR_ADC0CF;
 518         rmw->and_mask = F020_MASK_ADC0CF_AMP0GN2 |
 519             F020_MASK_ADC0CF_AMP0GN1 | F020_MASK_ADC0CF_AMP0GN0;
 520         switch (gain) {
 521                 /*
 522                  * 000 -> Gain =  1
 523                  * 001 -> Gain =  2
 524                  * 010 -> Gain =  4
 525                  * 011 -> Gain =  8
 526                  * 10x -> Gain = 16
 527                  * 11x -> Gain =  0.5
 528                  */
 529         case DT9812_GAIN_0PT5:
 530                 rmw->or_value = F020_MASK_ADC0CF_AMP0GN2 |
 531                     F020_MASK_ADC0CF_AMP0GN1;
 532                 break;
 533         case DT9812_GAIN_1:
 534                 rmw->or_value = 0x00;
 535                 break;
 536         case DT9812_GAIN_2:
 537                 rmw->or_value = F020_MASK_ADC0CF_AMP0GN0;
 538                 break;
 539         case DT9812_GAIN_4:
 540                 rmw->or_value = F020_MASK_ADC0CF_AMP0GN1;
 541                 break;
 542         case DT9812_GAIN_8:
 543                 rmw->or_value = F020_MASK_ADC0CF_AMP0GN1 |
 544                     F020_MASK_ADC0CF_AMP0GN0;
 545                 break;
 546         case DT9812_GAIN_16:
 547                 rmw->or_value = F020_MASK_ADC0CF_AMP0GN2;
 548                 break;
 549         default:
 550                 dev_err(&dev->interface->dev, "Illegal gain %d\n", gain);
 551
 552         }
 553 }
 554
 555 static int dt9812_analog_in(struct slot_dt9812 *slot, int channel, u16 *value,
 556                             enum dt9812_gain gain)
 557 {
 558         struct dt9812_rmw_byte rmw[3];
 559         u8 reg[3] = {
 560                 F020_SFR_ADC0CN,
 561                 F020_SFR_ADC0H,
 562                 F020_SFR_ADC0L
 563         };
 564         u8 val[3];
 565         int result = -ENODEV;
 566
 567         down(&slot->mutex);
 568         if (!slot->usb)
 569                 goto exit;
 570
 571         /* 1 select the gain */
 572         dt9812_configure_gain(slot->usb, &rmw[0], gain);
 573
 574         /* 2 set the MUX to select the channel */
 575         dt9812_configure_mux(slot->usb, &rmw[1], channel);
 576
 577         /* 3 start conversion */
 578         rmw[2].address = F020_SFR_ADC0CN;
 579         rmw[2].and_mask = 0xff;
 580         rmw[2].or_value = F020_MASK_ADC0CN_AD0EN | F020_MASK_ADC0CN_AD0BUSY;
 581
 582         result = dt9812_rmw_multiple_registers(slot->usb, 3, rmw);
 583         if (result)
 584                 goto exit;
 585
 586         /* read the status and ADC */
 587         result = dt9812_read_multiple_registers(slot->usb, 3, reg, val);
 588         if (result)
 589                 goto exit;
 590         /*
 591          * An ADC conversion takes 16 SAR clocks cycles, i.e. about 9us.
 592          * Therefore, between the instant that AD0BUSY was set via
 593          * dt9812_rmw_multiple_registers and the read of AD0BUSY via
 594          * dt9812_read_multiple_registers, the conversion should be complete
 595          * since these two operations require two USB transactions each taking
 596          * at least a millisecond to complete.  However, lets make sure that
 597          * conversion is finished.
 598          */
 599         if ((val[0] & (F020_MASK_ADC0CN_AD0INT | F020_MASK_ADC0CN_AD0BUSY)) ==
 600             F020_MASK_ADC0CN_AD0INT) {
 601                 switch (slot->usb->device) {
 602                 case DT9812_DEVID_DT9812_10:
 603                         /*
 604                          * For DT9812-10V the personality module set the
 605                          * encoding to 2's complement. Hence, convert it before
 606                          * returning it
 607                          */
 608                         *value = ((val[1] << 8) | val[2]) + 0x800;
 609                         break;
 610                 case DT9812_DEVID_DT9812_2PT5:
 611                         *value = (val[1] << 8) | val[2];
 612                         break;
 613                 }
 614         }
 615
 616 exit:
 617         up(&slot->mutex);
 618         return result;
 619 }
 620
 621 static int dt9812_analog_out_shadow(struct slot_dt9812 *slot, int channel,
 622                                     u16 *value)
 623 {
 624         int result = -ENODEV;
 625
 626         down(&slot->mutex);
 627         if (slot->usb) {
 628                 *value = slot->usb->analog_out_shadow[channel];
 629                 result = 0;
 630         }
 631         up(&slot->mutex);
 632
 633         return result;
 634 }
 635
 636 static int dt9812_analog_out(struct slot_dt9812 *slot, int channel, u16 value)
 637 {
 638         int result = -ENODEV;
 639
 640         down(&slot->mutex);
 641         if (slot->usb) {
 642                 struct dt9812_rmw_byte rmw[3];
 643
 644                 switch (channel) {
 645                 case 0:
 646                         /* 1. Set DAC mode */
 647                         rmw[0].address = F020_SFR_DAC0CN;
 648                         rmw[0].and_mask = 0xff;
 649                         rmw[0].or_value = F020_MASK_DACxCN_DACxEN;
 650
 651                         /* 2 load low byte of DAC value first */
 652                         rmw[1].address = F020_SFR_DAC0L;
 653                         rmw[1].and_mask = 0xff;
 654                         rmw[1].or_value = value & 0xff;
 655
 656                         /* 3 load high byte of DAC value next to latch the
 657                            12-bit value */
 658                         rmw[2].address = F020_SFR_DAC0H;
 659                         rmw[2].and_mask = 0xff;
 660                         rmw[2].or_value = (value >> 8) & 0xf;
 661                         break;
 662
 663                 case 1:
 664                         /* 1. Set DAC mode */
 665                         rmw[0].address = F020_SFR_DAC1CN;
 666                         rmw[0].and_mask = 0xff;
 667                         rmw[0].or_value = F020_MASK_DACxCN_DACxEN;
 668
 669                         /* 2 load low byte of DAC value first */
 670                         rmw[1].address = F020_SFR_DAC1L;
 671                         rmw[1].and_mask = 0xff;
 672                         rmw[1].or_value = value & 0xff;
 673
 674                         /* 3 load high byte of DAC value next to latch the
 675                            12-bit value */
 676                         rmw[2].address = F020_SFR_DAC1H;
 677                         rmw[2].and_mask = 0xff;
 678                         rmw[2].or_value = (value >> 8) & 0xf;
 679                         break;
 680                 }
 681                 result = dt9812_rmw_multiple_registers(slot->usb, 3, rmw);
 682                 slot->usb->analog_out_shadow[channel] = value;
 683         }
 684         up(&slot->mutex);
 685
 686         return result;
 687 }
 688
 689 /*
 690  * USB framework functions
 691  */
 692
 693 static int dt9812_probe(struct usb_interface *interface,
 694                         const struct usb_device_id *id)
 695 {
 696         int retval = -ENOMEM;
 697         struct usb_dt9812 *dev = NULL;
 698         struct usb_host_interface *iface_desc;
 699         struct usb_endpoint_descriptor *endpoint;
 700         int i;
 701         u8 fw;
 702
 703         /* allocate memory for our device state and initialize it */
 704         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 705         if (dev == NULL)
 706                 goto error;
 707
 708         kref_init(&dev->kref);
 709
 710         dev->udev = usb_get_dev(interface_to_usbdev(interface));
 711         dev->interface = interface;
 712
 713         /* Check endpoints */
 714         iface_desc = interface->cur_altsetting;
 715
 716         if (iface_desc->desc.bNumEndpoints != 5) {
 717                 dev_err(&interface->dev, "Wrong number of endpoints.\n");
 718                 retval = -ENODEV;
 719                 goto error;
 720         }
 721
 722         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 723                 int direction = -1;
 724                 endpoint = &iface_desc->endpoint[i].desc;
 725                 switch (i) {
 726                 case 0:
 727                         direction = USB_DIR_IN;
 728                         dev->message_pipe.addr = endpoint->bEndpointAddress;
 729                         dev->message_pipe.size =
 730                             le16_to_cpu(endpoint->wMaxPacketSize);
 731
 732                         break;
 733                 case 1:
 734                         direction = USB_DIR_OUT;
 735                         dev->command_write.addr = endpoint->bEndpointAddress;
 736                         dev->command_write.size =
 737                             le16_to_cpu(endpoint->wMaxPacketSize);
 738                         break;
 739                 case 2:
 740                         direction = USB_DIR_IN;
 741                         dev->command_read.addr = endpoint->bEndpointAddress;
 742                         dev->command_read.size =
 743                             le16_to_cpu(endpoint->wMaxPacketSize);
 744                         break;
 745                 case 3:
 746                         direction = USB_DIR_OUT;
 747                         dev->write_stream.addr = endpoint->bEndpointAddress;
 748                         dev->write_stream.size =
 749                             le16_to_cpu(endpoint->wMaxPacketSize);
 750                         break;
 751                 case 4:
 752                         direction = USB_DIR_IN;
 753                         dev->read_stream.addr = endpoint->bEndpointAddress;
 754                         dev->read_stream.size =
 755                             le16_to_cpu(endpoint->wMaxPacketSize);
 756                         break;
 757                 }
 758                 if ((endpoint->bEndpointAddress & USB_DIR_IN) != direction) {
 759                         dev_err(&interface->dev,
 760                                 "Endpoint has wrong direction.\n");
 761                         retval = -ENODEV;
 762                         goto error;
 763                 }
 764         }
 765         if (dt9812_read_info(dev, 0, &fw, sizeof(fw)) != 0) {
 766                 /*
 767                  * Seems like a configuration reset is necessary if driver is
 768                  * reloaded while device is attached
 769                  */
 770                 usb_reset_configuration(dev->udev);
 771                 for (i = 0; i < 10; i++) {
 772                         retval = dt9812_read_info(dev, 1, &fw, sizeof(fw));
 773                         if (retval == 0) {
 774                                 dev_info(&interface->dev,
 775                                          "usb_reset_configuration succeeded "
 776                                          "after %d iterations\n", i);
 777                                 break;
 778                         }
 779                 }
 780         }
 781
 782         if (dt9812_read_info(dev, 1, &dev->vendor, sizeof(dev->vendor)) != 0) {
 783                 dev_err(&interface->dev, "Failed to read vendor.\n");
 784                 retval = -ENODEV;
 785                 goto error;
 786         }
 787         if (dt9812_read_info(dev, 3, &dev->product, sizeof(dev->product)) != 0) {
 788                 dev_err(&interface->dev, "Failed to read product.\n");
 789                 retval = -ENODEV;
 790                 goto error;
 791         }
 792         if (dt9812_read_info(dev, 5, &dev->device, sizeof(dev->device)) != 0) {
 793                 dev_err(&interface->dev, "Failed to read device.\n");
 794                 retval = -ENODEV;
 795                 goto error;
 796         }
 797         if (dt9812_read_info(dev, 7, &dev->serial, sizeof(dev->serial)) != 0) {
 798                 dev_err(&interface->dev, "Failed to read serial.\n");
 799                 retval = -ENODEV;
 800                 goto error;
 801         }
 802
 803         dev->vendor = le16_to_cpu(dev->vendor);
 804         dev->product = le16_to_cpu(dev->product);
 805         dev->device = le16_to_cpu(dev->device);
 806         dev->serial = le32_to_cpu(dev->serial);
 807         switch (dev->device) {
 808         case DT9812_DEVID_DT9812_10:
 809                 dev->analog_out_shadow[0] = 0x0800;
 810                 dev->analog_out_shadow[1] = 0x800;
 811                 break;
 812         case DT9812_DEVID_DT9812_2PT5:
 813                 dev->analog_out_shadow[0] = 0x0000;
 814                 dev->analog_out_shadow[1] = 0x0000;
 815                 break;
 816         }
 817         dev->digital_out_shadow = 0;
 818
 819         /* save our data pointer in this interface device */
 820         usb_set_intfdata(interface, dev);
 821
 822         /* let the user know what node this device is now attached to */
 823         dev_info(&interface->dev, "USB DT9812 (%4.4x.%4.4x.%4.4x) #0x%8.8x\n",
 824                  dev->vendor, dev->product, dev->device, dev->serial);
 825
 826         down(&dt9812_mutex);
 827         {
 828                 /* Find a slot for the USB device */
 829                 struct slot_dt9812 *first = NULL;
 830                 struct slot_dt9812 *best = NULL;
 831
 832                 for (i = 0; i < DT9812_NUM_SLOTS; i++) {
 833                         if (!first && !dt9812[i].usb && dt9812[i].serial == 0)
 834                                 first = &dt9812[i];
 835                         if (!best && dt9812[i].serial == dev->serial)
 836                                 best = &dt9812[i];
 837                 }
 838
 839                 if (!best)
 840                         best = first;
 841
 842                 if (best) {
 843                         down(&best->mutex);
 844                         best->usb = dev;
 845                         dev->slot = best;
 846                         up(&best->mutex);
 847                 }
 848         }
 849         up(&dt9812_mutex);
 850
 851         return 0;
 852
 853 error:
 854         if (dev)
 855                 kref_put(&dev->kref, dt9812_delete);
 856         return retval;
 857 }
 858
 859 static void dt9812_disconnect(struct usb_interface *interface)
 860 {
 861         struct usb_dt9812 *dev;
 862         int minor = interface->minor;
 863
 864         down(&dt9812_mutex);
 865         dev = usb_get_intfdata(interface);
 866         if (dev->slot) {
 867                 down(&dev->slot->mutex);
 868                 dev->slot->usb = NULL;
 869                 up(&dev->slot->mutex);
 870                 dev->slot = NULL;
 871         }
 872         usb_set_intfdata(interface, NULL);
 873         up(&dt9812_mutex);
 874
 875         /* queue final destruction */
 876         kref_put(&dev->kref, dt9812_delete);
 877
 878         dev_info(&interface->dev, "USB Dt9812 #%d now disconnected\n", minor);
 879 }
 880
 881 static struct usb_driver dt9812_usb_driver = {
 882         .name = "dt9812",
 883         .probe = dt9812_probe,
 884         .disconnect = dt9812_disconnect,
 885         .id_table = dt9812_table,
 886 };
 887
 888 /*
 889  * Comedi functions
 890  */
 891
 892 static int dt9812_comedi_open(struct comedi_device *dev)
 893 {
 894         struct comedi_dt9812 *devpriv = dev->private;
 895         int result = -ENODEV;
 896
 897         down(&devpriv->slot->mutex);
 898         if (devpriv->slot->usb) {
 899                 /* We have an attached device, fill in current range info */
 900                 struct comedi_subdevice *s;
 901
 902                 s = &dev->subdevices[0];
 903                 s->n_chan = 8;
 904                 s->maxdata = 1;
 905
 906                 s = &dev->subdevices[1];
 907                 s->n_chan = 8;
 908                 s->maxdata = 1;
 909
 910                 s = &dev->subdevices[2];
 911                 s->n_chan = 8;
 912                 switch (devpriv->slot->usb->device) {
 913                 case 0:{
 914                                 s->maxdata = 4095;
 915                                 s->range_table = &dt9812_10_ain_range;
 916                         }
 917                         break;
 918                 case 1:{
 919                                 s->maxdata = 4095;
 920                                 s->range_table = &dt9812_2pt5_ain_range;
 921                         }
 922                         break;
 923                 }
 924
 925                 s = &dev->subdevices[3];
 926                 s->n_chan = 2;
 927                 switch (devpriv->slot->usb->device) {
 928                 case 0:{
 929                                 s->maxdata = 4095;
 930                                 s->range_table = &dt9812_10_aout_range;
 931                         }
 932                         break;
 933                 case 1:{
 934                                 s->maxdata = 4095;
 935                                 s->range_table = &dt9812_2pt5_aout_range;
 936                         }
 937                         break;
 938                 }
 939                 result = 0;
 940         }
 941         up(&devpriv->slot->mutex);
 942         return result;
 943 }
 944
 945 static int dt9812_di_rinsn(struct comedi_device *dev,
 946                            struct comedi_subdevice *s, struct comedi_insn *insn,
 947                            unsigned int *data)
 948 {
 949         struct comedi_dt9812 *devpriv = dev->private;
 950         int n;
 951         u8 bits = 0;
 952
 953         dt9812_digital_in(devpriv->slot, &bits);
 954         for (n = 0; n < insn->n; n++)
 955                 data[n] = ((1 << insn->chanspec) & bits) != 0;
 956         return n;
 957 }
 958
 959 static int dt9812_do_winsn(struct comedi_device *dev,
 960                            struct comedi_subdevice *s, struct comedi_insn *insn,
 961                            unsigned int *data)
 962 {
 963         struct comedi_dt9812 *devpriv = dev->private;
 964         int n;
 965         u8 bits = 0;
 966
 967         dt9812_digital_out_shadow(devpriv->slot, &bits);
 968         for (n = 0; n < insn->n; n++) {
 969                 u8 mask = 1 << insn->chanspec;
 970
 971                 bits &= ~mask;
 972                 if (data[n])
 973                         bits |= mask;
 974         }
 975         dt9812_digital_out(devpriv->slot, bits);
 976         return n;
 977 }
 978
 979 static int dt9812_ai_rinsn(struct comedi_device *dev,
 980                            struct comedi_subdevice *s, struct comedi_insn *insn,
 981                            unsigned int *data)
 982 {
 983         struct comedi_dt9812 *devpriv = dev->private;
 984         int n;
 985
 986         for (n = 0; n < insn->n; n++) {
 987                 u16 value = 0;
 988
 989                 dt9812_analog_in(devpriv->slot, insn->chanspec, &value,
 990                                  DT9812_GAIN_1);
 991                 data[n] = value;
 992         }
 993         return n;
 994 }
 995
 996 static int dt9812_ao_rinsn(struct comedi_device *dev,
 997                            struct comedi_subdevice *s, struct comedi_insn *insn,
 998                            unsigned int *data)
 999 {
1000         struct comedi_dt9812 *devpriv = dev->private;
1001         int n;
1002         u16 value;
1003
1004         for (n = 0; n < insn->n; n++) {
1005                 value = 0;
1006                 dt9812_analog_out_shadow(devpriv->slot, insn->chanspec, &value);
1007                 data[n] = value;
1008         }
1009         return n;
1010 }
1011
1012 static int dt9812_ao_winsn(struct comedi_device *dev,
1013                            struct comedi_subdevice *s, struct comedi_insn *insn,
1014                            unsigned int *data)
1015 {
1016         struct comedi_dt9812 *devpriv = dev->private;
1017         int n;
1018
1019         for (n = 0; n < insn->n; n++)
1020                 dt9812_analog_out(devpriv->slot, insn->chanspec, data[n]);
1021         return n;
1022 }
1023
1024 static int dt9812_attach(struct comedi_device *dev, struct comedi_devconfig *it)
1025 {
1026         struct comedi_dt9812 *devpriv;
1027         int i;
1028         struct comedi_subdevice *s;
1029         int ret;
1030
1031         dev->board_name = "dt9812";
1032
1033         devpriv = kzalloc(sizeof(*devpriv), GFP_KERNEL);
1034         if (!devpriv)
1035                 return -ENOMEM;
1036         dev->private = devpriv;
1037
1038         /*
1039          * Special open routine, since USB unit may be unattached at
1040          * comedi_config time, hence range can not be determined
1041          */
1042         dev->open = dt9812_comedi_open;
1043
1044         devpriv->serial = it->options[0];
1045
1046         ret = comedi_alloc_subdevices(dev, 4);
1047         if (ret)
1048                 return ret;
1049
1050         /* digital input subdevice */
1051         s = &dev->subdevices[0];
1052         s->type = COMEDI_SUBD_DI;
1053         s->subdev_flags = SDF_READABLE;
1054         s->n_chan = 0;
1055         s->maxdata = 1;
1056         s->range_table = &range_digital;
1057         s->insn_read = &dt9812_di_rinsn;
1058
1059         /* digital output subdevice */
1060         s = &dev->subdevices[1];
1061         s->type = COMEDI_SUBD_DO;
1062         s->subdev_flags = SDF_WRITEABLE;
1063         s->n_chan = 0;
1064         s->maxdata = 1;
1065         s->range_table = &range_digital;
1066         s->insn_write = &dt9812_do_winsn;
1067
1068         /* analog input subdevice */
1069         s = &dev->subdevices[2];
1070         s->type = COMEDI_SUBD_AI;
1071         s->subdev_flags = SDF_READABLE | SDF_GROUND;
1072         s->n_chan = 0;
1073         s->maxdata = 1;
1074         s->range_table = NULL;
1075         s->insn_read = &dt9812_ai_rinsn;
1076
1077         /* analog output subdevice */
1078         s = &dev->subdevices[3];
1079         s->type = COMEDI_SUBD_AO;
1080         s->subdev_flags = SDF_WRITEABLE;
1081         s->n_chan = 0;
1082         s->maxdata = 1;
1083         s->range_table = NULL;
1084         s->insn_write = &dt9812_ao_winsn;
1085         s->insn_read = &dt9812_ao_rinsn;
1086
1087         dev_info(dev->class_dev, "successfully attached to dt9812.\n");
1088
1089         down(&dt9812_mutex);
1090         /* Find a slot for the comedi device */
1091         {
1092                 struct slot_dt9812 *first = NULL;
1093                 struct slot_dt9812 *best = NULL;
1094                 for (i = 0; i < DT9812_NUM_SLOTS; i++) {
1095                         if (!first && !dt9812[i].comedi) {
1096                                 /* First free slot from comedi side */
1097                                 first = &dt9812[i];
1098                         }
1099                         if (!best &&
1100                             dt9812[i].usb &&
1101                             dt9812[i].usb->serial == devpriv->serial) {
1102                                 /* We have an attaced device with matching ID */
1103                                 best = &dt9812[i];
1104                         }
1105                 }
1106                 if (!best)
1107                         best = first;
1108                 if (best) {
1109                         down(&best->mutex);
1110                         best->comedi = devpriv;
1111                         best->serial = devpriv->serial;
1112                         devpriv->slot = best;
1113                         up(&best->mutex);
1114                 }
1115         }
1116         up(&dt9812_mutex);
1117
1118         return 0;
1119 }
1120
1121 static void dt9812_detach(struct comedi_device *dev)
1122 {
1123         /* Nothing to cleanup */
1124 }
1125
1126 static struct comedi_driver dt9812_comedi_driver = {
1127         .module = THIS_MODULE,
1128         .driver_name = "dt9812",
1129         .attach = dt9812_attach,
1130         .detach = dt9812_detach,
1131 };
1132
1133 static int __init usb_dt9812_init(void)
1134 {
1135         int i;
1136
1137         /* Initialize all driver slots */
1138         for (i = 0; i < DT9812_NUM_SLOTS; i++) {
1139                 sema_init(&dt9812[i].mutex, 1);
1140                 dt9812[i].serial = 0;
1141                 dt9812[i].usb = NULL;
1142                 dt9812[i].comedi = NULL;
1143         }
1144         dt9812[12].serial = 0x0;
1145
1146         return comedi_usb_driver_register(&dt9812_comedi_driver,
1147                                                 &dt9812_usb_driver);
1148 }
1149
1150 static void __exit usb_dt9812_exit(void)
1151 {
1152         comedi_usb_driver_unregister(&dt9812_comedi_driver, &dt9812_usb_driver);
1153 }
1154
1155 module_init(usb_dt9812_init);
1156 module_exit(usb_dt9812_exit);
1157
1158 MODULE_AUTHOR("Anders Blomdell <anders.blomdell@control.lth.se>");
1159 MODULE_DESCRIPTION("Comedi DT9812 driver");
1160 MODULE_LICENSE("GPL");