usbtmc.c 30 KB

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