usbtmc.c 26 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088
  1. /**
  2. * drivers/usb/class/usbtmc.c - USB Test & Measurment class driver
  3. *
  4. * Copyright (C) 2007 Stefan Kopp, Gechingen, Germany
  5. * Copyright (C) 2008 Novell, Inc.
  6. * Copyright (C) 2008 Greg Kroah-Hartman <gregkh@suse.de>
  7. *
  8. * This program is free software; you can redistribute it and/or
  9. * modify it under the terms of the GNU General Public License
  10. * as published by the Free Software Foundation; either version 2
  11. * of the License, or (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. *
  18. * The GNU General Public License is available at
  19. * http://www.gnu.org/copyleft/gpl.html.
  20. */
  21. #include <linux/init.h>
  22. #include <linux/module.h>
  23. #include <linux/fs.h>
  24. #include <linux/uaccess.h>
  25. #include <linux/kref.h>
  26. #include <linux/mutex.h>
  27. #include <linux/usb.h>
  28. #include <linux/usb/tmc.h>
  29. #define USBTMC_MINOR_BASE 176
  30. /*
  31. * Size of driver internal IO buffer. Must be multiple of 4 and at least as
  32. * large as wMaxPacketSize (which is usually 512 bytes).
  33. */
  34. #define USBTMC_SIZE_IOBUFFER 2048
  35. /* Default USB timeout (in milliseconds) */
  36. #define USBTMC_TIMEOUT 10
  37. /*
  38. * Maximum number of read cycles to empty bulk in endpoint during CLEAR and
  39. * ABORT_BULK_IN requests. Ends the loop if (for whatever reason) a short
  40. * packet is never read.
  41. */
  42. #define USBTMC_MAX_READS_TO_CLEAR_BULK_IN 100
  43. static struct usb_device_id usbtmc_devices[] = {
  44. { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 0), },
  45. { 0, } /* terminating entry */
  46. };
  47. MODULE_DEVICE_TABLE(usb, usbtmc_devices);
  48. /*
  49. * This structure is the capabilities for the device
  50. * See section 4.2.1.8 of the USBTMC specification for details.
  51. */
  52. struct usbtmc_dev_capabilities {
  53. __u8 interface_capabilities;
  54. __u8 device_capabilities;
  55. __u8 usb488_interface_capabilities;
  56. __u8 usb488_device_capabilities;
  57. };
  58. /* This structure holds private data for each USBTMC device. One copy is
  59. * allocated for each USBTMC device in the driver's probe function.
  60. */
  61. struct usbtmc_device_data {
  62. const struct usb_device_id *id;
  63. struct usb_device *usb_dev;
  64. struct usb_interface *intf;
  65. unsigned int bulk_in;
  66. unsigned int bulk_out;
  67. u8 bTag;
  68. u8 bTag_last_write; /* needed for abort */
  69. u8 bTag_last_read; /* needed for abort */
  70. /* attributes from the USB TMC spec for this device */
  71. u8 TermChar;
  72. bool TermCharEnabled;
  73. bool auto_abort;
  74. struct usbtmc_dev_capabilities capabilities;
  75. struct kref kref;
  76. struct mutex io_mutex; /* only one i/o function running at a time */
  77. };
  78. #define to_usbtmc_data(d) container_of(d, struct usbtmc_device_data, kref)
  79. /* Forward declarations */
  80. static struct usb_driver usbtmc_driver;
  81. static void usbtmc_delete(struct kref *kref)
  82. {
  83. struct usbtmc_device_data *data = to_usbtmc_data(kref);
  84. usb_put_dev(data->usb_dev);
  85. kfree(data);
  86. }
  87. static int usbtmc_open(struct inode *inode, struct file *filp)
  88. {
  89. struct usb_interface *intf;
  90. struct usbtmc_device_data *data;
  91. int retval = -ENODEV;
  92. intf = usb_find_interface(&usbtmc_driver, iminor(inode));
  93. if (!intf) {
  94. printk(KERN_ERR KBUILD_MODNAME
  95. ": can not find device for minor %d", iminor(inode));
  96. goto exit;
  97. }
  98. data = usb_get_intfdata(intf);
  99. kref_get(&data->kref);
  100. /* Store pointer in file structure's private data field */
  101. filp->private_data = data;
  102. exit:
  103. return retval;
  104. }
  105. static int usbtmc_release(struct inode *inode, struct file *file)
  106. {
  107. struct usbtmc_device_data *data = file->private_data;
  108. kref_put(&data->kref, usbtmc_delete);
  109. return 0;
  110. }
  111. static int usbtmc_ioctl_abort_bulk_in(struct usbtmc_device_data *data)
  112. {
  113. u8 *buffer;
  114. struct device *dev;
  115. int rv;
  116. int n;
  117. int actual;
  118. struct usb_host_interface *current_setting;
  119. int max_size;
  120. dev = &data->intf->dev;
  121. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  122. if (!buffer)
  123. return -ENOMEM;
  124. rv = usb_control_msg(data->usb_dev,
  125. usb_rcvctrlpipe(data->usb_dev, 0),
  126. USBTMC_REQUEST_INITIATE_ABORT_BULK_IN,
  127. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  128. data->bTag_last_read, data->bulk_in,
  129. buffer, 2, USBTMC_TIMEOUT);
  130. if (rv < 0) {
  131. dev_err(dev, "usb_control_msg returned %d\n", rv);
  132. goto exit;
  133. }
  134. dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
  135. if (buffer[0] == USBTMC_STATUS_FAILED) {
  136. rv = 0;
  137. goto exit;
  138. }
  139. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  140. dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n",
  141. buffer[0]);
  142. rv = -EPERM;
  143. goto exit;
  144. }
  145. max_size = 0;
  146. current_setting = data->intf->cur_altsetting;
  147. for (n = 0; n < current_setting->desc.bNumEndpoints; n++)
  148. if (current_setting->endpoint[n].desc.bEndpointAddress ==
  149. data->bulk_in)
  150. max_size = le16_to_cpu(current_setting->endpoint[n].
  151. desc.wMaxPacketSize);
  152. if (max_size == 0) {
  153. dev_err(dev, "Couldn't get wMaxPacketSize\n");
  154. rv = -EPERM;
  155. goto exit;
  156. }
  157. dev_dbg(&data->intf->dev, "wMaxPacketSize is %d\n", max_size);
  158. n = 0;
  159. do {
  160. dev_dbg(dev, "Reading from bulk in EP\n");
  161. rv = usb_bulk_msg(data->usb_dev,
  162. usb_rcvbulkpipe(data->usb_dev,
  163. data->bulk_in),
  164. buffer, USBTMC_SIZE_IOBUFFER,
  165. &actual, USBTMC_TIMEOUT);
  166. n++;
  167. if (rv < 0) {
  168. dev_err(dev, "usb_bulk_msg returned %d\n", rv);
  169. goto exit;
  170. }
  171. } while ((actual == max_size) &&
  172. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
  173. if (actual == max_size) {
  174. dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
  175. USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
  176. rv = -EPERM;
  177. goto exit;
  178. }
  179. n = 0;
  180. usbtmc_abort_bulk_in_status:
  181. rv = usb_control_msg(data->usb_dev,
  182. usb_rcvctrlpipe(data->usb_dev, 0),
  183. USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS,
  184. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  185. 0, data->bulk_in, buffer, 0x08,
  186. USBTMC_TIMEOUT);
  187. if (rv < 0) {
  188. dev_err(dev, "usb_control_msg returned %d\n", rv);
  189. goto exit;
  190. }
  191. dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
  192. if (buffer[0] == USBTMC_STATUS_SUCCESS) {
  193. rv = 0;
  194. goto exit;
  195. }
  196. if (buffer[0] != USBTMC_STATUS_PENDING) {
  197. dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
  198. rv = -EPERM;
  199. goto exit;
  200. }
  201. if (buffer[1] == 1)
  202. do {
  203. dev_dbg(dev, "Reading from bulk in EP\n");
  204. rv = usb_bulk_msg(data->usb_dev,
  205. usb_rcvbulkpipe(data->usb_dev,
  206. data->bulk_in),
  207. buffer, USBTMC_SIZE_IOBUFFER,
  208. &actual, USBTMC_TIMEOUT);
  209. n++;
  210. if (rv < 0) {
  211. dev_err(dev, "usb_bulk_msg returned %d\n", rv);
  212. goto exit;
  213. }
  214. } while ((actual = max_size) &&
  215. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
  216. if (actual == max_size) {
  217. dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
  218. USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
  219. rv = -EPERM;
  220. goto exit;
  221. }
  222. goto usbtmc_abort_bulk_in_status;
  223. exit:
  224. kfree(buffer);
  225. return rv;
  226. }
  227. static int usbtmc_ioctl_abort_bulk_out(struct usbtmc_device_data *data)
  228. {
  229. struct device *dev;
  230. u8 *buffer;
  231. int rv;
  232. int n;
  233. dev = &data->intf->dev;
  234. buffer = kmalloc(8, GFP_KERNEL);
  235. if (!buffer)
  236. return -ENOMEM;
  237. rv = usb_control_msg(data->usb_dev,
  238. usb_rcvctrlpipe(data->usb_dev, 0),
  239. USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT,
  240. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  241. data->bTag_last_write, data->bulk_out,
  242. buffer, 2, USBTMC_TIMEOUT);
  243. if (rv < 0) {
  244. dev_err(dev, "usb_control_msg returned %d\n", rv);
  245. goto exit;
  246. }
  247. dev_dbg(dev, "INITIATE_ABORT_BULK_OUT returned %x\n", buffer[0]);
  248. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  249. dev_err(dev, "INITIATE_ABORT_BULK_OUT returned %x\n",
  250. buffer[0]);
  251. rv = -EPERM;
  252. goto exit;
  253. }
  254. n = 0;
  255. usbtmc_abort_bulk_out_check_status:
  256. rv = usb_control_msg(data->usb_dev,
  257. usb_rcvctrlpipe(data->usb_dev, 0),
  258. USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS,
  259. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  260. 0, data->bulk_out, buffer, 0x08,
  261. USBTMC_TIMEOUT);
  262. n++;
  263. if (rv < 0) {
  264. dev_err(dev, "usb_control_msg returned %d\n", rv);
  265. goto exit;
  266. }
  267. dev_dbg(dev, "CHECK_ABORT_BULK_OUT returned %x\n", buffer[0]);
  268. if (buffer[0] == USBTMC_STATUS_SUCCESS)
  269. goto usbtmc_abort_bulk_out_clear_halt;
  270. if ((buffer[0] == USBTMC_STATUS_PENDING) &&
  271. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN))
  272. goto usbtmc_abort_bulk_out_check_status;
  273. rv = -EPERM;
  274. goto exit;
  275. usbtmc_abort_bulk_out_clear_halt:
  276. rv = usb_control_msg(data->usb_dev,
  277. usb_sndctrlpipe(data->usb_dev, 0),
  278. USB_REQ_CLEAR_FEATURE,
  279. USB_DIR_OUT | USB_TYPE_STANDARD |
  280. USB_RECIP_ENDPOINT,
  281. USB_ENDPOINT_HALT, data->bulk_out, buffer,
  282. 0, USBTMC_TIMEOUT);
  283. if (rv < 0) {
  284. dev_err(dev, "usb_control_msg returned %d\n", rv);
  285. goto exit;
  286. }
  287. rv = 0;
  288. exit:
  289. kfree(buffer);
  290. return rv;
  291. }
  292. static ssize_t usbtmc_read(struct file *filp, char __user *buf,
  293. size_t count, loff_t *f_pos)
  294. {
  295. struct usbtmc_device_data *data;
  296. struct device *dev;
  297. unsigned long int n_characters;
  298. u8 *buffer;
  299. int actual;
  300. int done;
  301. int remaining;
  302. int retval;
  303. int this_part;
  304. /* Get pointer to private data structure */
  305. data = filp->private_data;
  306. dev = &data->intf->dev;
  307. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  308. if (!buffer)
  309. return -ENOMEM;
  310. mutex_lock(&data->io_mutex);
  311. remaining = count;
  312. done = 0;
  313. while (remaining > 0) {
  314. if (remaining > USBTMC_SIZE_IOBUFFER - 12 - 3)
  315. this_part = USBTMC_SIZE_IOBUFFER - 12 - 3;
  316. else
  317. this_part = remaining;
  318. /* Setup IO buffer for DEV_DEP_MSG_IN message
  319. * Refer to class specs for details
  320. */
  321. buffer[0] = 2;
  322. buffer[1] = data->bTag;
  323. buffer[2] = ~(data->bTag);
  324. buffer[3] = 0; /* Reserved */
  325. buffer[4] = (this_part - 12 - 3) & 255;
  326. buffer[5] = ((this_part - 12 - 3) >> 8) & 255;
  327. buffer[6] = ((this_part - 12 - 3) >> 16) & 255;
  328. buffer[7] = ((this_part - 12 - 3) >> 24) & 255;
  329. buffer[8] = data->TermCharEnabled * 2;
  330. /* Use term character? */
  331. buffer[9] = data->TermChar;
  332. buffer[10] = 0; /* Reserved */
  333. buffer[11] = 0; /* Reserved */
  334. /* Send bulk URB */
  335. retval = usb_bulk_msg(data->usb_dev,
  336. usb_sndbulkpipe(data->usb_dev,
  337. data->bulk_out),
  338. buffer, 12, &actual, USBTMC_TIMEOUT);
  339. /* Store bTag (in case we need to abort) */
  340. data->bTag_last_write = data->bTag;
  341. /* Increment bTag -- and increment again if zero */
  342. data->bTag++;
  343. if (!data->bTag)
  344. (data->bTag)++;
  345. if (retval < 0) {
  346. dev_err(dev, "usb_bulk_msg returned %d\n", retval);
  347. if (data->auto_abort)
  348. usbtmc_ioctl_abort_bulk_out(data);
  349. goto exit;
  350. }
  351. /* Send bulk URB */
  352. retval = usb_bulk_msg(data->usb_dev,
  353. usb_rcvbulkpipe(data->usb_dev,
  354. data->bulk_in),
  355. buffer, USBTMC_SIZE_IOBUFFER, &actual,
  356. USBTMC_TIMEOUT);
  357. /* Store bTag (in case we need to abort) */
  358. data->bTag_last_read = data->bTag;
  359. if (retval < 0) {
  360. dev_err(dev, "Unable to read data, error %d\n", retval);
  361. if (data->auto_abort)
  362. usbtmc_ioctl_abort_bulk_in(data);
  363. goto exit;
  364. }
  365. /* How many characters did the instrument send? */
  366. n_characters = buffer[4] +
  367. (buffer[5] << 8) +
  368. (buffer[6] << 16) +
  369. (buffer[7] << 24);
  370. /* Copy buffer to user space */
  371. if (copy_to_user(buf + done, &buffer[12], n_characters)) {
  372. /* There must have been an addressing problem */
  373. retval = -EFAULT;
  374. goto exit;
  375. }
  376. done += n_characters;
  377. if (n_characters < USBTMC_SIZE_IOBUFFER)
  378. remaining = 0;
  379. }
  380. /* Update file position value */
  381. *f_pos = *f_pos + done;
  382. retval = done;
  383. exit:
  384. mutex_unlock(&data->io_mutex);
  385. kfree(buffer);
  386. return retval;
  387. }
  388. static ssize_t usbtmc_write(struct file *filp, const char __user *buf,
  389. size_t count, loff_t *f_pos)
  390. {
  391. struct usbtmc_device_data *data;
  392. u8 *buffer;
  393. int retval;
  394. int actual;
  395. unsigned long int n_bytes;
  396. int n;
  397. int remaining;
  398. int done;
  399. int this_part;
  400. data = filp->private_data;
  401. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  402. if (!buffer)
  403. return -ENOMEM;
  404. mutex_lock(&data->io_mutex);
  405. remaining = count;
  406. done = 0;
  407. while (remaining > 0) {
  408. if (remaining > USBTMC_SIZE_IOBUFFER - 12) {
  409. this_part = USBTMC_SIZE_IOBUFFER - 12;
  410. buffer[8] = 0;
  411. } else {
  412. this_part = remaining;
  413. buffer[8] = 1;
  414. }
  415. /* Setup IO buffer for DEV_DEP_MSG_OUT message */
  416. buffer[0] = 1;
  417. buffer[1] = data->bTag;
  418. buffer[2] = ~(data->bTag);
  419. buffer[3] = 0; /* Reserved */
  420. buffer[4] = this_part & 255;
  421. buffer[5] = (this_part >> 8) & 255;
  422. buffer[6] = (this_part >> 16) & 255;
  423. buffer[7] = (this_part >> 24) & 255;
  424. /* buffer[8] is set above... */
  425. buffer[9] = 0; /* Reserved */
  426. buffer[10] = 0; /* Reserved */
  427. buffer[11] = 0; /* Reserved */
  428. if (copy_from_user(&buffer[12], buf + done, this_part)) {
  429. retval = -EFAULT;
  430. goto exit;
  431. }
  432. n_bytes = 12 + this_part;
  433. if (this_part % 4)
  434. n_bytes += 4 - this_part % 4;
  435. for (n = 12 + this_part; n < n_bytes; n++)
  436. buffer[n] = 0;
  437. retval = usb_bulk_msg(data->usb_dev,
  438. usb_sndbulkpipe(data->usb_dev,
  439. data->bulk_out),
  440. buffer, n_bytes, &actual, USBTMC_TIMEOUT);
  441. data->bTag_last_write = data->bTag;
  442. data->bTag++;
  443. if (!data->bTag)
  444. data->bTag++;
  445. if (retval < 0) {
  446. dev_err(&data->intf->dev,
  447. "Unable to send data, error %d\n", retval);
  448. if (data->auto_abort)
  449. usbtmc_ioctl_abort_bulk_out(data);
  450. goto exit;
  451. }
  452. remaining -= this_part;
  453. done += this_part;
  454. }
  455. retval = count;
  456. exit:
  457. mutex_unlock(&data->io_mutex);
  458. kfree(buffer);
  459. return retval;
  460. }
  461. static int usbtmc_ioctl_clear(struct usbtmc_device_data *data)
  462. {
  463. struct usb_host_interface *current_setting;
  464. struct usb_endpoint_descriptor *desc;
  465. struct device *dev;
  466. u8 *buffer;
  467. int rv;
  468. int n;
  469. int actual;
  470. int max_size;
  471. dev = &data->intf->dev;
  472. dev_dbg(dev, "Sending INITIATE_CLEAR request\n");
  473. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  474. if (!buffer)
  475. return -ENOMEM;
  476. rv = usb_control_msg(data->usb_dev,
  477. usb_rcvctrlpipe(data->usb_dev, 0),
  478. USBTMC_REQUEST_INITIATE_CLEAR,
  479. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  480. 0, 0, buffer, 1, USBTMC_TIMEOUT);
  481. if (rv < 0) {
  482. dev_err(dev, "usb_control_msg returned %d\n", rv);
  483. goto exit;
  484. }
  485. dev_dbg(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
  486. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  487. dev_err(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
  488. rv = -EPERM;
  489. goto exit;
  490. }
  491. max_size = 0;
  492. current_setting = data->intf->cur_altsetting;
  493. for (n = 0; n < current_setting->desc.bNumEndpoints; n++) {
  494. desc = &current_setting->endpoint[n].desc;
  495. if (desc->bEndpointAddress == data->bulk_in)
  496. max_size = le16_to_cpu(desc->wMaxPacketSize);
  497. }
  498. if (max_size == 0) {
  499. dev_err(dev, "Couldn't get wMaxPacketSize\n");
  500. rv = -EPERM;
  501. goto exit;
  502. }
  503. dev_dbg(dev, "wMaxPacketSize is %d\n", max_size);
  504. n = 0;
  505. usbtmc_clear_check_status:
  506. dev_dbg(dev, "Sending CHECK_CLEAR_STATUS request\n");
  507. rv = usb_control_msg(data->usb_dev,
  508. usb_rcvctrlpipe(data->usb_dev, 0),
  509. USBTMC_REQUEST_CHECK_CLEAR_STATUS,
  510. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  511. 0, 0, buffer, 2, USBTMC_TIMEOUT);
  512. if (rv < 0) {
  513. dev_err(dev, "usb_control_msg returned %d\n", rv);
  514. goto exit;
  515. }
  516. dev_dbg(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
  517. if (buffer[0] == USBTMC_STATUS_SUCCESS)
  518. goto usbtmc_clear_bulk_out_halt;
  519. if (buffer[0] != USBTMC_STATUS_PENDING) {
  520. dev_err(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
  521. rv = -EPERM;
  522. goto exit;
  523. }
  524. if (buffer[1] == 1)
  525. do {
  526. dev_dbg(dev, "Reading from bulk in EP\n");
  527. rv = usb_bulk_msg(data->usb_dev,
  528. usb_rcvbulkpipe(data->usb_dev,
  529. data->bulk_in),
  530. buffer, USBTMC_SIZE_IOBUFFER,
  531. &actual, USBTMC_TIMEOUT);
  532. n++;
  533. if (rv < 0) {
  534. dev_err(dev, "usb_control_msg returned %d\n",
  535. rv);
  536. goto exit;
  537. }
  538. } while ((actual == max_size) &&
  539. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
  540. if (actual == max_size) {
  541. dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
  542. USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
  543. rv = -EPERM;
  544. goto exit;
  545. }
  546. goto usbtmc_clear_check_status;
  547. usbtmc_clear_bulk_out_halt:
  548. rv = usb_control_msg(data->usb_dev,
  549. usb_sndctrlpipe(data->usb_dev, 0),
  550. USB_REQ_CLEAR_FEATURE,
  551. USB_DIR_OUT | USB_TYPE_STANDARD |
  552. USB_RECIP_ENDPOINT,
  553. USB_ENDPOINT_HALT,
  554. data->bulk_out, buffer, 0,
  555. USBTMC_TIMEOUT);
  556. if (rv < 0) {
  557. dev_err(dev, "usb_control_msg returned %d\n", rv);
  558. goto exit;
  559. }
  560. rv = 0;
  561. exit:
  562. kfree(buffer);
  563. return rv;
  564. }
  565. static int usbtmc_ioctl_clear_out_halt(struct usbtmc_device_data *data)
  566. {
  567. u8 *buffer;
  568. int rv;
  569. buffer = kmalloc(2, GFP_KERNEL);
  570. if (!buffer)
  571. return -ENOMEM;
  572. rv = usb_control_msg(data->usb_dev,
  573. usb_sndctrlpipe(data->usb_dev, 0),
  574. USB_REQ_CLEAR_FEATURE,
  575. USB_DIR_OUT | USB_TYPE_STANDARD |
  576. USB_RECIP_ENDPOINT,
  577. USB_ENDPOINT_HALT, data->bulk_out,
  578. buffer, 0, USBTMC_TIMEOUT);
  579. if (rv < 0) {
  580. dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
  581. rv);
  582. goto exit;
  583. }
  584. rv = 0;
  585. exit:
  586. kfree(buffer);
  587. return rv;
  588. }
  589. static int usbtmc_ioctl_clear_in_halt(struct usbtmc_device_data *data)
  590. {
  591. u8 *buffer;
  592. int rv;
  593. buffer = kmalloc(2, GFP_KERNEL);
  594. if (!buffer)
  595. return -ENOMEM;
  596. rv = usb_control_msg(data->usb_dev, usb_sndctrlpipe(data->usb_dev, 0),
  597. USB_REQ_CLEAR_FEATURE,
  598. USB_DIR_OUT | USB_TYPE_STANDARD |
  599. USB_RECIP_ENDPOINT,
  600. USB_ENDPOINT_HALT, data->bulk_in, buffer, 0,
  601. USBTMC_TIMEOUT);
  602. if (rv < 0) {
  603. dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
  604. rv);
  605. goto exit;
  606. }
  607. rv = 0;
  608. exit:
  609. kfree(buffer);
  610. return rv;
  611. }
  612. static int get_capabilities(struct usbtmc_device_data *data)
  613. {
  614. struct device *dev = &data->usb_dev->dev;
  615. char *buffer;
  616. int rv;
  617. buffer = kmalloc(0x18, GFP_KERNEL);
  618. if (!buffer)
  619. return -ENOMEM;
  620. rv = usb_control_msg(data->usb_dev, usb_rcvctrlpipe(data->usb_dev, 0),
  621. USBTMC_REQUEST_GET_CAPABILITIES,
  622. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  623. 0, 0, buffer, 0x18, USBTMC_TIMEOUT);
  624. if (rv < 0) {
  625. dev_err(dev, "usb_control_msg returned %d\n", rv);
  626. return rv;
  627. }
  628. dev_dbg(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
  629. dev_dbg(dev, "Interface capabilities are %x\n", buffer[4]);
  630. dev_dbg(dev, "Device capabilities are %x\n", buffer[5]);
  631. dev_dbg(dev, "USB488 interface capabilities are %x\n", buffer[14]);
  632. dev_dbg(dev, "USB488 device capabilities are %x\n", buffer[15]);
  633. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  634. dev_err(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
  635. return -EPERM;
  636. }
  637. data->capabilities.interface_capabilities = buffer[4];
  638. data->capabilities.device_capabilities = buffer[5];
  639. data->capabilities.usb488_interface_capabilities = buffer[14];
  640. data->capabilities.usb488_device_capabilities = buffer[15];
  641. kfree(buffer);
  642. return 0;
  643. }
  644. #define capability_attribute(name) \
  645. static ssize_t show_##name(struct device *dev, \
  646. struct device_attribute *attr, char *buf) \
  647. { \
  648. struct usb_interface *intf = to_usb_interface(dev); \
  649. struct usbtmc_device_data *data = usb_get_intfdata(intf); \
  650. \
  651. return sprintf(buf, "%d\n", data->capabilities.name); \
  652. } \
  653. static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
  654. capability_attribute(interface_capabilities);
  655. capability_attribute(device_capabilities);
  656. capability_attribute(usb488_interface_capabilities);
  657. capability_attribute(usb488_device_capabilities);
  658. static struct attribute *capability_attrs[] = {
  659. &dev_attr_interface_capabilities.attr,
  660. &dev_attr_device_capabilities.attr,
  661. &dev_attr_usb488_interface_capabilities.attr,
  662. &dev_attr_usb488_device_capabilities.attr,
  663. NULL,
  664. };
  665. static struct attribute_group capability_attr_grp = {
  666. .attrs = capability_attrs,
  667. };
  668. static ssize_t show_TermChar(struct device *dev,
  669. struct device_attribute *attr, char *buf)
  670. {
  671. struct usb_interface *intf = to_usb_interface(dev);
  672. struct usbtmc_device_data *data = usb_get_intfdata(intf);
  673. return sprintf(buf, "%c\n", data->TermChar);
  674. }
  675. static ssize_t store_TermChar(struct device *dev,
  676. struct device_attribute *attr,
  677. const char *buf, size_t count)
  678. {
  679. struct usb_interface *intf = to_usb_interface(dev);
  680. struct usbtmc_device_data *data = usb_get_intfdata(intf);
  681. if (count < 1)
  682. return -EINVAL;
  683. data->TermChar = buf[0];
  684. return count;
  685. }
  686. static DEVICE_ATTR(TermChar, S_IRUGO, show_TermChar, store_TermChar);
  687. #define data_attribute(name) \
  688. static ssize_t show_##name(struct device *dev, \
  689. struct device_attribute *attr, char *buf) \
  690. { \
  691. struct usb_interface *intf = to_usb_interface(dev); \
  692. struct usbtmc_device_data *data = usb_get_intfdata(intf); \
  693. \
  694. return sprintf(buf, "%d\n", data->name); \
  695. } \
  696. static ssize_t store_##name(struct device *dev, \
  697. struct device_attribute *attr, \
  698. const char *buf, size_t count) \
  699. { \
  700. struct usb_interface *intf = to_usb_interface(dev); \
  701. struct usbtmc_device_data *data = usb_get_intfdata(intf); \
  702. ssize_t result; \
  703. unsigned val; \
  704. \
  705. result = sscanf(buf, "%u\n", &val); \
  706. if (result != 1) \
  707. result = -EINVAL; \
  708. data->name = val; \
  709. if (result < 0) \
  710. return result; \
  711. else \
  712. return count; \
  713. } \
  714. static DEVICE_ATTR(name, S_IRUGO, show_##name, store_##name)
  715. data_attribute(TermCharEnabled);
  716. data_attribute(auto_abort);
  717. static struct attribute *data_attrs[] = {
  718. &dev_attr_TermChar.attr,
  719. &dev_attr_TermCharEnabled.attr,
  720. &dev_attr_auto_abort.attr,
  721. NULL,
  722. };
  723. static struct attribute_group data_attr_grp = {
  724. .attrs = data_attrs,
  725. };
  726. static int usbtmc_ioctl_indicator_pulse(struct usbtmc_device_data *data)
  727. {
  728. struct device *dev;
  729. u8 *buffer;
  730. int rv;
  731. dev = &data->intf->dev;
  732. buffer = kmalloc(2, GFP_KERNEL);
  733. if (!buffer)
  734. return -ENOMEM;
  735. rv = usb_control_msg(data->usb_dev,
  736. usb_rcvctrlpipe(data->usb_dev, 0),
  737. USBTMC_REQUEST_INDICATOR_PULSE,
  738. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  739. 0, 0, buffer, 0x01, USBTMC_TIMEOUT);
  740. if (rv < 0) {
  741. dev_err(dev, "usb_control_msg returned %d\n", rv);
  742. goto exit;
  743. }
  744. dev_dbg(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
  745. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  746. dev_err(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
  747. rv = -EPERM;
  748. goto exit;
  749. }
  750. rv = 0;
  751. exit:
  752. kfree(buffer);
  753. return rv;
  754. }
  755. static long usbtmc_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
  756. {
  757. struct usbtmc_device_data *data;
  758. int retval = -EBADRQC;
  759. data = file->private_data;
  760. mutex_lock(&data->io_mutex);
  761. switch (cmd) {
  762. case USBTMC_IOCTL_CLEAR_OUT_HALT:
  763. retval = usbtmc_ioctl_clear_out_halt(data);
  764. case USBTMC_IOCTL_CLEAR_IN_HALT:
  765. retval = usbtmc_ioctl_clear_in_halt(data);
  766. case USBTMC_IOCTL_INDICATOR_PULSE:
  767. retval = usbtmc_ioctl_indicator_pulse(data);
  768. case USBTMC_IOCTL_CLEAR:
  769. retval = usbtmc_ioctl_clear(data);
  770. case USBTMC_IOCTL_ABORT_BULK_OUT:
  771. retval = usbtmc_ioctl_abort_bulk_out(data);
  772. case USBTMC_IOCTL_ABORT_BULK_IN:
  773. retval = usbtmc_ioctl_abort_bulk_in(data);
  774. }
  775. mutex_unlock(&data->io_mutex);
  776. return retval;
  777. }
  778. static struct file_operations fops = {
  779. .owner = THIS_MODULE,
  780. .read = usbtmc_read,
  781. .write = usbtmc_write,
  782. .open = usbtmc_open,
  783. .release = usbtmc_release,
  784. .unlocked_ioctl = usbtmc_ioctl,
  785. };
  786. static struct usb_class_driver usbtmc_class = {
  787. .name = "usbtmc%d",
  788. .fops = &fops,
  789. .minor_base = USBTMC_MINOR_BASE,
  790. };
  791. static int usbtmc_probe(struct usb_interface *intf,
  792. const struct usb_device_id *id)
  793. {
  794. struct usbtmc_device_data *data;
  795. struct usb_host_interface *iface_desc;
  796. struct usb_endpoint_descriptor *endpoint;
  797. int n;
  798. int retcode;
  799. dev_dbg(&intf->dev, "%s called\n", __func__);
  800. data = kmalloc(sizeof(struct usbtmc_device_data), GFP_KERNEL);
  801. if (!data) {
  802. dev_err(&intf->dev, "Unable to allocate kernel memory\n");
  803. return -ENOMEM;
  804. }
  805. data->intf = intf;
  806. data->id = id;
  807. data->usb_dev = usb_get_dev(interface_to_usbdev(intf));
  808. usb_set_intfdata(intf, data);
  809. kref_init(&data->kref);
  810. mutex_init(&data->io_mutex);
  811. /* Initialize USBTMC bTag and other fields */
  812. data->bTag = 1;
  813. data->TermCharEnabled = 0;
  814. data->TermChar = '\n';
  815. /* USBTMC devices have only one setting, so use that */
  816. iface_desc = data->intf->cur_altsetting;
  817. /* Find bulk in endpoint */
  818. for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
  819. endpoint = &iface_desc->endpoint[n].desc;
  820. if (usb_endpoint_is_bulk_in(endpoint)) {
  821. data->bulk_in = endpoint->bEndpointAddress;
  822. dev_dbg(&intf->dev, "Found bulk in endpoint at %u\n",
  823. data->bulk_in);
  824. break;
  825. }
  826. }
  827. /* Find bulk out endpoint */
  828. for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
  829. endpoint = &iface_desc->endpoint[n].desc;
  830. if (usb_endpoint_is_bulk_out(endpoint)) {
  831. data->bulk_out = endpoint->bEndpointAddress;
  832. dev_dbg(&intf->dev, "Found Bulk out endpoint at %u\n",
  833. data->bulk_out);
  834. break;
  835. }
  836. }
  837. retcode = get_capabilities(data);
  838. if (retcode)
  839. dev_err(&intf->dev, "can't read capabilities\n");
  840. else
  841. retcode = sysfs_create_group(&intf->dev.kobj,
  842. &capability_attr_grp);
  843. retcode = sysfs_create_group(&intf->dev.kobj, &data_attr_grp);
  844. retcode = usb_register_dev(intf, &usbtmc_class);
  845. if (retcode) {
  846. dev_err(&intf->dev, "Not able to get a minor"
  847. " (base %u, slice default): %d\n", USBTMC_MINOR_BASE,
  848. retcode);
  849. goto error_register;
  850. }
  851. dev_dbg(&intf->dev, "Using minor number %d\n", intf->minor);
  852. return 0;
  853. error_register:
  854. sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
  855. sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
  856. kref_put(&data->kref, usbtmc_delete);
  857. return retcode;
  858. }
  859. static void usbtmc_disconnect(struct usb_interface *intf)
  860. {
  861. struct usbtmc_device_data *data;
  862. dev_dbg(&intf->dev, "usbtmc_disconnect called\n");
  863. data = usb_get_intfdata(intf);
  864. usb_deregister_dev(intf, &usbtmc_class);
  865. sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
  866. sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
  867. kref_put(&data->kref, usbtmc_delete);
  868. }
  869. static struct usb_driver usbtmc_driver = {
  870. .name = "usbtmc",
  871. .id_table = usbtmc_devices,
  872. .probe = usbtmc_probe,
  873. .disconnect = usbtmc_disconnect
  874. };
  875. static int __init usbtmc_init(void)
  876. {
  877. int retcode;
  878. retcode = usb_register(&usbtmc_driver);
  879. if (retcode)
  880. printk(KERN_ERR KBUILD_MODNAME": Unable to register driver\n");
  881. return retcode;
  882. }
  883. module_init(usbtmc_init);
  884. static void __exit usbtmc_exit(void)
  885. {
  886. usb_deregister(&usbtmc_driver);
  887. }
  888. module_exit(usbtmc_exit);
  889. MODULE_LICENSE("GPL");