usbtmc.c 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561
  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. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  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/poll.h>
  29. #include <linux/mutex.h>
  30. #include <linux/usb.h>
  31. #include <linux/usb/tmc.h>
  32. #define RIGOL 1
  33. #define USBTMC_HEADER_SIZE 12
  34. #define USBTMC_MINOR_BASE 176
  35. /*
  36. * Size of driver internal IO buffer. Must be multiple of 4 and at least as
  37. * large as wMaxPacketSize (which is usually 512 bytes).
  38. */
  39. #define USBTMC_SIZE_IOBUFFER 2048
  40. /* Default USB timeout (in milliseconds) */
  41. #define USBTMC_TIMEOUT 5000
  42. /*
  43. * Maximum number of read cycles to empty bulk in endpoint during CLEAR and
  44. * ABORT_BULK_IN requests. Ends the loop if (for whatever reason) a short
  45. * packet is never read.
  46. */
  47. #define USBTMC_MAX_READS_TO_CLEAR_BULK_IN 100
  48. static const struct usb_device_id usbtmc_devices[] = {
  49. { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 0), },
  50. { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, 3, 1), },
  51. { 0, } /* terminating entry */
  52. };
  53. MODULE_DEVICE_TABLE(usb, usbtmc_devices);
  54. /*
  55. * This structure is the capabilities for the device
  56. * See section 4.2.1.8 of the USBTMC specification,
  57. * and section 4.2.2 of the USBTMC usb488 subclass
  58. * specification for details.
  59. */
  60. struct usbtmc_dev_capabilities {
  61. __u8 interface_capabilities;
  62. __u8 device_capabilities;
  63. __u8 usb488_interface_capabilities;
  64. __u8 usb488_device_capabilities;
  65. };
  66. /* This structure holds private data for each USBTMC device. One copy is
  67. * allocated for each USBTMC device in the driver's probe function.
  68. */
  69. struct usbtmc_device_data {
  70. const struct usb_device_id *id;
  71. struct usb_device *usb_dev;
  72. struct usb_interface *intf;
  73. unsigned int bulk_in;
  74. unsigned int bulk_out;
  75. u8 bTag;
  76. u8 bTag_last_write; /* needed for abort */
  77. u8 bTag_last_read; /* needed for abort */
  78. /* data for interrupt in endpoint handling */
  79. u8 bNotify1;
  80. u8 bNotify2;
  81. u16 ifnum;
  82. u8 iin_bTag;
  83. u8 *iin_buffer;
  84. atomic_t iin_data_valid;
  85. unsigned int iin_ep;
  86. int iin_ep_present;
  87. int iin_interval;
  88. struct urb *iin_urb;
  89. u16 iin_wMaxPacketSize;
  90. atomic_t srq_asserted;
  91. /* coalesced usb488_caps from usbtmc_dev_capabilities */
  92. __u8 usb488_caps;
  93. u8 rigol_quirk;
  94. /* attributes from the USB TMC spec for this device */
  95. u8 TermChar;
  96. bool TermCharEnabled;
  97. bool auto_abort;
  98. bool zombie; /* fd of disconnected device */
  99. struct usbtmc_dev_capabilities capabilities;
  100. struct kref kref;
  101. struct mutex io_mutex; /* only one i/o function running at a time */
  102. wait_queue_head_t waitq;
  103. struct fasync_struct *fasync;
  104. };
  105. #define to_usbtmc_data(d) container_of(d, struct usbtmc_device_data, kref)
  106. struct usbtmc_ID_rigol_quirk {
  107. __u16 idVendor;
  108. __u16 idProduct;
  109. };
  110. static const struct usbtmc_ID_rigol_quirk usbtmc_id_quirk[] = {
  111. { 0x1ab1, 0x0588 },
  112. { 0x1ab1, 0x04b0 },
  113. { 0, 0 }
  114. };
  115. /* Forward declarations */
  116. static struct usb_driver usbtmc_driver;
  117. static void usbtmc_delete(struct kref *kref)
  118. {
  119. struct usbtmc_device_data *data = to_usbtmc_data(kref);
  120. usb_put_dev(data->usb_dev);
  121. }
  122. static int usbtmc_open(struct inode *inode, struct file *filp)
  123. {
  124. struct usb_interface *intf;
  125. struct usbtmc_device_data *data;
  126. int retval = 0;
  127. intf = usb_find_interface(&usbtmc_driver, iminor(inode));
  128. if (!intf) {
  129. pr_err("can not find device for minor %d", iminor(inode));
  130. return -ENODEV;
  131. }
  132. data = usb_get_intfdata(intf);
  133. kref_get(&data->kref);
  134. /* Store pointer in file structure's private data field */
  135. filp->private_data = data;
  136. return retval;
  137. }
  138. static int usbtmc_release(struct inode *inode, struct file *file)
  139. {
  140. struct usbtmc_device_data *data = file->private_data;
  141. kref_put(&data->kref, usbtmc_delete);
  142. return 0;
  143. }
  144. static int usbtmc_ioctl_abort_bulk_in(struct usbtmc_device_data *data)
  145. {
  146. u8 *buffer;
  147. struct device *dev;
  148. int rv;
  149. int n;
  150. int actual;
  151. struct usb_host_interface *current_setting;
  152. int max_size;
  153. dev = &data->intf->dev;
  154. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  155. if (!buffer)
  156. return -ENOMEM;
  157. rv = usb_control_msg(data->usb_dev,
  158. usb_rcvctrlpipe(data->usb_dev, 0),
  159. USBTMC_REQUEST_INITIATE_ABORT_BULK_IN,
  160. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  161. data->bTag_last_read, data->bulk_in,
  162. buffer, 2, USBTMC_TIMEOUT);
  163. if (rv < 0) {
  164. dev_err(dev, "usb_control_msg returned %d\n", rv);
  165. goto exit;
  166. }
  167. dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
  168. if (buffer[0] == USBTMC_STATUS_FAILED) {
  169. rv = 0;
  170. goto exit;
  171. }
  172. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  173. dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n",
  174. buffer[0]);
  175. rv = -EPERM;
  176. goto exit;
  177. }
  178. max_size = 0;
  179. current_setting = data->intf->cur_altsetting;
  180. for (n = 0; n < current_setting->desc.bNumEndpoints; n++)
  181. if (current_setting->endpoint[n].desc.bEndpointAddress ==
  182. data->bulk_in)
  183. max_size = usb_endpoint_maxp(&current_setting->endpoint[n].desc);
  184. if (max_size == 0) {
  185. dev_err(dev, "Couldn't get wMaxPacketSize\n");
  186. rv = -EPERM;
  187. goto exit;
  188. }
  189. dev_dbg(&data->intf->dev, "wMaxPacketSize is %d\n", max_size);
  190. n = 0;
  191. do {
  192. dev_dbg(dev, "Reading from bulk in EP\n");
  193. rv = usb_bulk_msg(data->usb_dev,
  194. usb_rcvbulkpipe(data->usb_dev,
  195. data->bulk_in),
  196. buffer, USBTMC_SIZE_IOBUFFER,
  197. &actual, USBTMC_TIMEOUT);
  198. n++;
  199. if (rv < 0) {
  200. dev_err(dev, "usb_bulk_msg returned %d\n", rv);
  201. goto exit;
  202. }
  203. } while ((actual == max_size) &&
  204. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
  205. if (actual == max_size) {
  206. dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
  207. USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
  208. rv = -EPERM;
  209. goto exit;
  210. }
  211. n = 0;
  212. usbtmc_abort_bulk_in_status:
  213. rv = usb_control_msg(data->usb_dev,
  214. usb_rcvctrlpipe(data->usb_dev, 0),
  215. USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS,
  216. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  217. 0, data->bulk_in, buffer, 0x08,
  218. USBTMC_TIMEOUT);
  219. if (rv < 0) {
  220. dev_err(dev, "usb_control_msg returned %d\n", rv);
  221. goto exit;
  222. }
  223. dev_dbg(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
  224. if (buffer[0] == USBTMC_STATUS_SUCCESS) {
  225. rv = 0;
  226. goto exit;
  227. }
  228. if (buffer[0] != USBTMC_STATUS_PENDING) {
  229. dev_err(dev, "INITIATE_ABORT_BULK_IN returned %x\n", buffer[0]);
  230. rv = -EPERM;
  231. goto exit;
  232. }
  233. if (buffer[1] == 1)
  234. do {
  235. dev_dbg(dev, "Reading from bulk in EP\n");
  236. rv = usb_bulk_msg(data->usb_dev,
  237. usb_rcvbulkpipe(data->usb_dev,
  238. data->bulk_in),
  239. buffer, USBTMC_SIZE_IOBUFFER,
  240. &actual, USBTMC_TIMEOUT);
  241. n++;
  242. if (rv < 0) {
  243. dev_err(dev, "usb_bulk_msg returned %d\n", rv);
  244. goto exit;
  245. }
  246. } while ((actual == max_size) &&
  247. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
  248. if (actual == max_size) {
  249. dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
  250. USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
  251. rv = -EPERM;
  252. goto exit;
  253. }
  254. goto usbtmc_abort_bulk_in_status;
  255. exit:
  256. kfree(buffer);
  257. return rv;
  258. }
  259. static int usbtmc_ioctl_abort_bulk_out(struct usbtmc_device_data *data)
  260. {
  261. struct device *dev;
  262. u8 *buffer;
  263. int rv;
  264. int n;
  265. dev = &data->intf->dev;
  266. buffer = kmalloc(8, GFP_KERNEL);
  267. if (!buffer)
  268. return -ENOMEM;
  269. rv = usb_control_msg(data->usb_dev,
  270. usb_rcvctrlpipe(data->usb_dev, 0),
  271. USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT,
  272. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  273. data->bTag_last_write, data->bulk_out,
  274. buffer, 2, USBTMC_TIMEOUT);
  275. if (rv < 0) {
  276. dev_err(dev, "usb_control_msg returned %d\n", rv);
  277. goto exit;
  278. }
  279. dev_dbg(dev, "INITIATE_ABORT_BULK_OUT returned %x\n", buffer[0]);
  280. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  281. dev_err(dev, "INITIATE_ABORT_BULK_OUT returned %x\n",
  282. buffer[0]);
  283. rv = -EPERM;
  284. goto exit;
  285. }
  286. n = 0;
  287. usbtmc_abort_bulk_out_check_status:
  288. rv = usb_control_msg(data->usb_dev,
  289. usb_rcvctrlpipe(data->usb_dev, 0),
  290. USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS,
  291. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
  292. 0, data->bulk_out, buffer, 0x08,
  293. USBTMC_TIMEOUT);
  294. n++;
  295. if (rv < 0) {
  296. dev_err(dev, "usb_control_msg returned %d\n", rv);
  297. goto exit;
  298. }
  299. dev_dbg(dev, "CHECK_ABORT_BULK_OUT returned %x\n", buffer[0]);
  300. if (buffer[0] == USBTMC_STATUS_SUCCESS)
  301. goto usbtmc_abort_bulk_out_clear_halt;
  302. if ((buffer[0] == USBTMC_STATUS_PENDING) &&
  303. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN))
  304. goto usbtmc_abort_bulk_out_check_status;
  305. rv = -EPERM;
  306. goto exit;
  307. usbtmc_abort_bulk_out_clear_halt:
  308. rv = usb_clear_halt(data->usb_dev,
  309. usb_sndbulkpipe(data->usb_dev, data->bulk_out));
  310. if (rv < 0) {
  311. dev_err(dev, "usb_control_msg returned %d\n", rv);
  312. goto exit;
  313. }
  314. rv = 0;
  315. exit:
  316. kfree(buffer);
  317. return rv;
  318. }
  319. static int usbtmc488_ioctl_read_stb(struct usbtmc_device_data *data,
  320. void __user *arg)
  321. {
  322. struct device *dev = &data->intf->dev;
  323. u8 *buffer;
  324. u8 tag;
  325. __u8 stb;
  326. int rv;
  327. dev_dbg(dev, "Enter ioctl_read_stb iin_ep_present: %d\n",
  328. data->iin_ep_present);
  329. buffer = kmalloc(8, GFP_KERNEL);
  330. if (!buffer)
  331. return -ENOMEM;
  332. atomic_set(&data->iin_data_valid, 0);
  333. /* must issue read_stb before using poll or select */
  334. atomic_set(&data->srq_asserted, 0);
  335. rv = usb_control_msg(data->usb_dev,
  336. usb_rcvctrlpipe(data->usb_dev, 0),
  337. USBTMC488_REQUEST_READ_STATUS_BYTE,
  338. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  339. data->iin_bTag,
  340. data->ifnum,
  341. buffer, 0x03, USBTMC_TIMEOUT);
  342. if (rv < 0) {
  343. dev_err(dev, "stb usb_control_msg returned %d\n", rv);
  344. goto exit;
  345. }
  346. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  347. dev_err(dev, "control status returned %x\n", buffer[0]);
  348. rv = -EIO;
  349. goto exit;
  350. }
  351. if (data->iin_ep_present) {
  352. rv = wait_event_interruptible_timeout(
  353. data->waitq,
  354. atomic_read(&data->iin_data_valid) != 0,
  355. USBTMC_TIMEOUT);
  356. if (rv < 0) {
  357. dev_dbg(dev, "wait interrupted %d\n", rv);
  358. goto exit;
  359. }
  360. if (rv == 0) {
  361. dev_dbg(dev, "wait timed out\n");
  362. rv = -ETIME;
  363. goto exit;
  364. }
  365. tag = data->bNotify1 & 0x7f;
  366. if (tag != data->iin_bTag) {
  367. dev_err(dev, "expected bTag %x got %x\n",
  368. data->iin_bTag, tag);
  369. }
  370. stb = data->bNotify2;
  371. } else {
  372. stb = buffer[2];
  373. }
  374. rv = copy_to_user(arg, &stb, sizeof(stb));
  375. if (rv)
  376. rv = -EFAULT;
  377. exit:
  378. /* bump interrupt bTag */
  379. data->iin_bTag += 1;
  380. if (data->iin_bTag > 127)
  381. /* 1 is for SRQ see USBTMC-USB488 subclass spec section 4.3.1 */
  382. data->iin_bTag = 2;
  383. kfree(buffer);
  384. return rv;
  385. }
  386. static int usbtmc488_ioctl_simple(struct usbtmc_device_data *data,
  387. void __user *arg, unsigned int cmd)
  388. {
  389. struct device *dev = &data->intf->dev;
  390. __u8 val;
  391. u8 *buffer;
  392. u16 wValue;
  393. int rv;
  394. if (!(data->usb488_caps & USBTMC488_CAPABILITY_SIMPLE))
  395. return -EINVAL;
  396. buffer = kmalloc(8, GFP_KERNEL);
  397. if (!buffer)
  398. return -ENOMEM;
  399. if (cmd == USBTMC488_REQUEST_REN_CONTROL) {
  400. rv = copy_from_user(&val, arg, sizeof(val));
  401. if (rv) {
  402. rv = -EFAULT;
  403. goto exit;
  404. }
  405. wValue = val ? 1 : 0;
  406. } else {
  407. wValue = 0;
  408. }
  409. rv = usb_control_msg(data->usb_dev,
  410. usb_rcvctrlpipe(data->usb_dev, 0),
  411. cmd,
  412. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  413. wValue,
  414. data->ifnum,
  415. buffer, 0x01, USBTMC_TIMEOUT);
  416. if (rv < 0) {
  417. dev_err(dev, "simple usb_control_msg failed %d\n", rv);
  418. goto exit;
  419. } else if (rv != 1) {
  420. dev_warn(dev, "simple usb_control_msg returned %d\n", rv);
  421. rv = -EIO;
  422. goto exit;
  423. }
  424. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  425. dev_err(dev, "simple control status returned %x\n", buffer[0]);
  426. rv = -EIO;
  427. goto exit;
  428. }
  429. rv = 0;
  430. exit:
  431. kfree(buffer);
  432. return rv;
  433. }
  434. /*
  435. * Sends a REQUEST_DEV_DEP_MSG_IN message on the Bulk-IN endpoint.
  436. * @transfer_size: number of bytes to request from the device.
  437. *
  438. * See the USBTMC specification, Table 4.
  439. *
  440. * Also updates bTag_last_write.
  441. */
  442. static int send_request_dev_dep_msg_in(struct usbtmc_device_data *data, size_t transfer_size)
  443. {
  444. int retval;
  445. u8 *buffer;
  446. int actual;
  447. buffer = kmalloc(USBTMC_HEADER_SIZE, GFP_KERNEL);
  448. if (!buffer)
  449. return -ENOMEM;
  450. /* Setup IO buffer for REQUEST_DEV_DEP_MSG_IN message
  451. * Refer to class specs for details
  452. */
  453. buffer[0] = 2;
  454. buffer[1] = data->bTag;
  455. buffer[2] = ~data->bTag;
  456. buffer[3] = 0; /* Reserved */
  457. buffer[4] = transfer_size >> 0;
  458. buffer[5] = transfer_size >> 8;
  459. buffer[6] = transfer_size >> 16;
  460. buffer[7] = transfer_size >> 24;
  461. buffer[8] = data->TermCharEnabled * 2;
  462. /* Use term character? */
  463. buffer[9] = data->TermChar;
  464. buffer[10] = 0; /* Reserved */
  465. buffer[11] = 0; /* Reserved */
  466. /* Send bulk URB */
  467. retval = usb_bulk_msg(data->usb_dev,
  468. usb_sndbulkpipe(data->usb_dev,
  469. data->bulk_out),
  470. buffer, USBTMC_HEADER_SIZE, &actual, USBTMC_TIMEOUT);
  471. /* Store bTag (in case we need to abort) */
  472. data->bTag_last_write = data->bTag;
  473. /* Increment bTag -- and increment again if zero */
  474. data->bTag++;
  475. if (!data->bTag)
  476. data->bTag++;
  477. kfree(buffer);
  478. if (retval < 0) {
  479. dev_err(&data->intf->dev, "usb_bulk_msg in send_request_dev_dep_msg_in() returned %d\n", retval);
  480. return retval;
  481. }
  482. return 0;
  483. }
  484. static ssize_t usbtmc_read(struct file *filp, char __user *buf,
  485. size_t count, loff_t *f_pos)
  486. {
  487. struct usbtmc_device_data *data;
  488. struct device *dev;
  489. u32 n_characters;
  490. u8 *buffer;
  491. int actual;
  492. size_t done;
  493. size_t remaining;
  494. int retval;
  495. size_t this_part;
  496. /* Get pointer to private data structure */
  497. data = filp->private_data;
  498. dev = &data->intf->dev;
  499. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  500. if (!buffer)
  501. return -ENOMEM;
  502. mutex_lock(&data->io_mutex);
  503. if (data->zombie) {
  504. retval = -ENODEV;
  505. goto exit;
  506. }
  507. if (data->rigol_quirk) {
  508. dev_dbg(dev, "usb_bulk_msg_in: count(%zu)\n", count);
  509. retval = send_request_dev_dep_msg_in(data, count);
  510. if (retval < 0) {
  511. if (data->auto_abort)
  512. usbtmc_ioctl_abort_bulk_out(data);
  513. goto exit;
  514. }
  515. }
  516. /* Loop until we have fetched everything we requested */
  517. remaining = count;
  518. this_part = remaining;
  519. done = 0;
  520. while (remaining > 0) {
  521. if (!data->rigol_quirk) {
  522. dev_dbg(dev, "usb_bulk_msg_in: remaining(%zu), count(%zu)\n", remaining, count);
  523. if (remaining > USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE - 3)
  524. this_part = USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE - 3;
  525. else
  526. this_part = remaining;
  527. retval = send_request_dev_dep_msg_in(data, this_part);
  528. if (retval < 0) {
  529. dev_err(dev, "usb_bulk_msg returned %d\n", retval);
  530. if (data->auto_abort)
  531. usbtmc_ioctl_abort_bulk_out(data);
  532. goto exit;
  533. }
  534. }
  535. /* Send bulk URB */
  536. retval = usb_bulk_msg(data->usb_dev,
  537. usb_rcvbulkpipe(data->usb_dev,
  538. data->bulk_in),
  539. buffer, USBTMC_SIZE_IOBUFFER, &actual,
  540. USBTMC_TIMEOUT);
  541. dev_dbg(dev, "usb_bulk_msg: retval(%u), done(%zu), remaining(%zu), actual(%d)\n", retval, done, remaining, actual);
  542. /* Store bTag (in case we need to abort) */
  543. data->bTag_last_read = data->bTag;
  544. if (retval < 0) {
  545. dev_dbg(dev, "Unable to read data, error %d\n", retval);
  546. if (data->auto_abort)
  547. usbtmc_ioctl_abort_bulk_in(data);
  548. goto exit;
  549. }
  550. /* Parse header in first packet */
  551. if ((done == 0) || !data->rigol_quirk) {
  552. /* Sanity checks for the header */
  553. if (actual < USBTMC_HEADER_SIZE) {
  554. dev_err(dev, "Device sent too small first packet: %u < %u\n", actual, USBTMC_HEADER_SIZE);
  555. if (data->auto_abort)
  556. usbtmc_ioctl_abort_bulk_in(data);
  557. goto exit;
  558. }
  559. if (buffer[0] != 2) {
  560. dev_err(dev, "Device sent reply with wrong MsgID: %u != 2\n", buffer[0]);
  561. if (data->auto_abort)
  562. usbtmc_ioctl_abort_bulk_in(data);
  563. goto exit;
  564. }
  565. if (buffer[1] != data->bTag_last_write) {
  566. dev_err(dev, "Device sent reply with wrong bTag: %u != %u\n", buffer[1], data->bTag_last_write);
  567. if (data->auto_abort)
  568. usbtmc_ioctl_abort_bulk_in(data);
  569. goto exit;
  570. }
  571. /* How many characters did the instrument send? */
  572. n_characters = buffer[4] +
  573. (buffer[5] << 8) +
  574. (buffer[6] << 16) +
  575. (buffer[7] << 24);
  576. if (n_characters > this_part) {
  577. dev_err(dev, "Device wants to return more data than requested: %u > %zu\n", n_characters, count);
  578. if (data->auto_abort)
  579. usbtmc_ioctl_abort_bulk_in(data);
  580. goto exit;
  581. }
  582. /* Remove the USBTMC header */
  583. actual -= USBTMC_HEADER_SIZE;
  584. /* Check if the message is smaller than requested */
  585. if (data->rigol_quirk) {
  586. if (remaining > n_characters)
  587. remaining = n_characters;
  588. /* Remove padding if it exists */
  589. if (actual > remaining)
  590. actual = remaining;
  591. }
  592. else {
  593. if (this_part > n_characters)
  594. this_part = n_characters;
  595. /* Remove padding if it exists */
  596. if (actual > this_part)
  597. actual = this_part;
  598. }
  599. dev_dbg(dev, "Bulk-IN header: N_characters(%u), bTransAttr(%u)\n", n_characters, buffer[8]);
  600. remaining -= actual;
  601. /* Terminate if end-of-message bit received from device */
  602. if ((buffer[8] & 0x01) && (actual >= n_characters))
  603. remaining = 0;
  604. dev_dbg(dev, "Bulk-IN header: remaining(%zu), buf(%p), buffer(%p) done(%zu)\n", remaining,buf,buffer,done);
  605. /* Copy buffer to user space */
  606. if (copy_to_user(buf + done, &buffer[USBTMC_HEADER_SIZE], actual)) {
  607. /* There must have been an addressing problem */
  608. retval = -EFAULT;
  609. goto exit;
  610. }
  611. done += actual;
  612. }
  613. else {
  614. if (actual > remaining)
  615. actual = remaining;
  616. remaining -= actual;
  617. dev_dbg(dev, "Bulk-IN header cont: actual(%u), done(%zu), remaining(%zu), buf(%p), buffer(%p)\n", actual, done, remaining,buf,buffer);
  618. /* Copy buffer to user space */
  619. if (copy_to_user(buf + done, buffer, actual)) {
  620. /* There must have been an addressing problem */
  621. retval = -EFAULT;
  622. goto exit;
  623. }
  624. done += actual;
  625. }
  626. }
  627. /* Update file position value */
  628. *f_pos = *f_pos + done;
  629. retval = done;
  630. exit:
  631. mutex_unlock(&data->io_mutex);
  632. kfree(buffer);
  633. return retval;
  634. }
  635. static ssize_t usbtmc_write(struct file *filp, const char __user *buf,
  636. size_t count, loff_t *f_pos)
  637. {
  638. struct usbtmc_device_data *data;
  639. u8 *buffer;
  640. int retval;
  641. int actual;
  642. unsigned long int n_bytes;
  643. int remaining;
  644. int done;
  645. int this_part;
  646. data = filp->private_data;
  647. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  648. if (!buffer)
  649. return -ENOMEM;
  650. mutex_lock(&data->io_mutex);
  651. if (data->zombie) {
  652. retval = -ENODEV;
  653. goto exit;
  654. }
  655. remaining = count;
  656. done = 0;
  657. while (remaining > 0) {
  658. if (remaining > USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE) {
  659. this_part = USBTMC_SIZE_IOBUFFER - USBTMC_HEADER_SIZE;
  660. buffer[8] = 0;
  661. } else {
  662. this_part = remaining;
  663. buffer[8] = 1;
  664. }
  665. /* Setup IO buffer for DEV_DEP_MSG_OUT message */
  666. buffer[0] = 1;
  667. buffer[1] = data->bTag;
  668. buffer[2] = ~data->bTag;
  669. buffer[3] = 0; /* Reserved */
  670. buffer[4] = this_part >> 0;
  671. buffer[5] = this_part >> 8;
  672. buffer[6] = this_part >> 16;
  673. buffer[7] = this_part >> 24;
  674. /* buffer[8] is set above... */
  675. buffer[9] = 0; /* Reserved */
  676. buffer[10] = 0; /* Reserved */
  677. buffer[11] = 0; /* Reserved */
  678. if (copy_from_user(&buffer[USBTMC_HEADER_SIZE], buf + done, this_part)) {
  679. retval = -EFAULT;
  680. goto exit;
  681. }
  682. n_bytes = roundup(USBTMC_HEADER_SIZE + this_part, 4);
  683. memset(buffer + USBTMC_HEADER_SIZE + this_part, 0, n_bytes - (USBTMC_HEADER_SIZE + this_part));
  684. do {
  685. retval = usb_bulk_msg(data->usb_dev,
  686. usb_sndbulkpipe(data->usb_dev,
  687. data->bulk_out),
  688. buffer, n_bytes,
  689. &actual, USBTMC_TIMEOUT);
  690. if (retval != 0)
  691. break;
  692. n_bytes -= actual;
  693. } while (n_bytes);
  694. data->bTag_last_write = data->bTag;
  695. data->bTag++;
  696. if (!data->bTag)
  697. data->bTag++;
  698. if (retval < 0) {
  699. dev_err(&data->intf->dev,
  700. "Unable to send data, error %d\n", retval);
  701. if (data->auto_abort)
  702. usbtmc_ioctl_abort_bulk_out(data);
  703. goto exit;
  704. }
  705. remaining -= this_part;
  706. done += this_part;
  707. }
  708. retval = count;
  709. exit:
  710. mutex_unlock(&data->io_mutex);
  711. kfree(buffer);
  712. return retval;
  713. }
  714. static int usbtmc_ioctl_clear(struct usbtmc_device_data *data)
  715. {
  716. struct usb_host_interface *current_setting;
  717. struct usb_endpoint_descriptor *desc;
  718. struct device *dev;
  719. u8 *buffer;
  720. int rv;
  721. int n;
  722. int actual = 0;
  723. int max_size;
  724. dev = &data->intf->dev;
  725. dev_dbg(dev, "Sending INITIATE_CLEAR request\n");
  726. buffer = kmalloc(USBTMC_SIZE_IOBUFFER, GFP_KERNEL);
  727. if (!buffer)
  728. return -ENOMEM;
  729. rv = usb_control_msg(data->usb_dev,
  730. usb_rcvctrlpipe(data->usb_dev, 0),
  731. USBTMC_REQUEST_INITIATE_CLEAR,
  732. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  733. 0, 0, buffer, 1, USBTMC_TIMEOUT);
  734. if (rv < 0) {
  735. dev_err(dev, "usb_control_msg returned %d\n", rv);
  736. goto exit;
  737. }
  738. dev_dbg(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
  739. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  740. dev_err(dev, "INITIATE_CLEAR returned %x\n", buffer[0]);
  741. rv = -EPERM;
  742. goto exit;
  743. }
  744. max_size = 0;
  745. current_setting = data->intf->cur_altsetting;
  746. for (n = 0; n < current_setting->desc.bNumEndpoints; n++) {
  747. desc = &current_setting->endpoint[n].desc;
  748. if (desc->bEndpointAddress == data->bulk_in)
  749. max_size = usb_endpoint_maxp(desc);
  750. }
  751. if (max_size == 0) {
  752. dev_err(dev, "Couldn't get wMaxPacketSize\n");
  753. rv = -EPERM;
  754. goto exit;
  755. }
  756. dev_dbg(dev, "wMaxPacketSize is %d\n", max_size);
  757. n = 0;
  758. usbtmc_clear_check_status:
  759. dev_dbg(dev, "Sending CHECK_CLEAR_STATUS request\n");
  760. rv = usb_control_msg(data->usb_dev,
  761. usb_rcvctrlpipe(data->usb_dev, 0),
  762. USBTMC_REQUEST_CHECK_CLEAR_STATUS,
  763. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  764. 0, 0, buffer, 2, USBTMC_TIMEOUT);
  765. if (rv < 0) {
  766. dev_err(dev, "usb_control_msg returned %d\n", rv);
  767. goto exit;
  768. }
  769. dev_dbg(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
  770. if (buffer[0] == USBTMC_STATUS_SUCCESS)
  771. goto usbtmc_clear_bulk_out_halt;
  772. if (buffer[0] != USBTMC_STATUS_PENDING) {
  773. dev_err(dev, "CHECK_CLEAR_STATUS returned %x\n", buffer[0]);
  774. rv = -EPERM;
  775. goto exit;
  776. }
  777. if (buffer[1] == 1)
  778. do {
  779. dev_dbg(dev, "Reading from bulk in EP\n");
  780. rv = usb_bulk_msg(data->usb_dev,
  781. usb_rcvbulkpipe(data->usb_dev,
  782. data->bulk_in),
  783. buffer, USBTMC_SIZE_IOBUFFER,
  784. &actual, USBTMC_TIMEOUT);
  785. n++;
  786. if (rv < 0) {
  787. dev_err(dev, "usb_control_msg returned %d\n",
  788. rv);
  789. goto exit;
  790. }
  791. } while ((actual == max_size) &&
  792. (n < USBTMC_MAX_READS_TO_CLEAR_BULK_IN));
  793. if (actual == max_size) {
  794. dev_err(dev, "Couldn't clear device buffer within %d cycles\n",
  795. USBTMC_MAX_READS_TO_CLEAR_BULK_IN);
  796. rv = -EPERM;
  797. goto exit;
  798. }
  799. goto usbtmc_clear_check_status;
  800. usbtmc_clear_bulk_out_halt:
  801. rv = usb_clear_halt(data->usb_dev,
  802. usb_sndbulkpipe(data->usb_dev, data->bulk_out));
  803. if (rv < 0) {
  804. dev_err(dev, "usb_control_msg returned %d\n", rv);
  805. goto exit;
  806. }
  807. rv = 0;
  808. exit:
  809. kfree(buffer);
  810. return rv;
  811. }
  812. static int usbtmc_ioctl_clear_out_halt(struct usbtmc_device_data *data)
  813. {
  814. int rv;
  815. rv = usb_clear_halt(data->usb_dev,
  816. usb_sndbulkpipe(data->usb_dev, data->bulk_out));
  817. if (rv < 0) {
  818. dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
  819. rv);
  820. return rv;
  821. }
  822. return 0;
  823. }
  824. static int usbtmc_ioctl_clear_in_halt(struct usbtmc_device_data *data)
  825. {
  826. int rv;
  827. rv = usb_clear_halt(data->usb_dev,
  828. usb_rcvbulkpipe(data->usb_dev, data->bulk_in));
  829. if (rv < 0) {
  830. dev_err(&data->usb_dev->dev, "usb_control_msg returned %d\n",
  831. rv);
  832. return rv;
  833. }
  834. return 0;
  835. }
  836. static int get_capabilities(struct usbtmc_device_data *data)
  837. {
  838. struct device *dev = &data->usb_dev->dev;
  839. char *buffer;
  840. int rv = 0;
  841. buffer = kmalloc(0x18, GFP_KERNEL);
  842. if (!buffer)
  843. return -ENOMEM;
  844. rv = usb_control_msg(data->usb_dev, usb_rcvctrlpipe(data->usb_dev, 0),
  845. USBTMC_REQUEST_GET_CAPABILITIES,
  846. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  847. 0, 0, buffer, 0x18, USBTMC_TIMEOUT);
  848. if (rv < 0) {
  849. dev_err(dev, "usb_control_msg returned %d\n", rv);
  850. goto err_out;
  851. }
  852. dev_dbg(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
  853. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  854. dev_err(dev, "GET_CAPABILITIES returned %x\n", buffer[0]);
  855. rv = -EPERM;
  856. goto err_out;
  857. }
  858. dev_dbg(dev, "Interface capabilities are %x\n", buffer[4]);
  859. dev_dbg(dev, "Device capabilities are %x\n", buffer[5]);
  860. dev_dbg(dev, "USB488 interface capabilities are %x\n", buffer[14]);
  861. dev_dbg(dev, "USB488 device capabilities are %x\n", buffer[15]);
  862. data->capabilities.interface_capabilities = buffer[4];
  863. data->capabilities.device_capabilities = buffer[5];
  864. data->capabilities.usb488_interface_capabilities = buffer[14];
  865. data->capabilities.usb488_device_capabilities = buffer[15];
  866. data->usb488_caps = (buffer[14] & 0x07) | ((buffer[15] & 0x0f) << 4);
  867. rv = 0;
  868. err_out:
  869. kfree(buffer);
  870. return rv;
  871. }
  872. #define capability_attribute(name) \
  873. static ssize_t name##_show(struct device *dev, \
  874. struct device_attribute *attr, char *buf) \
  875. { \
  876. struct usb_interface *intf = to_usb_interface(dev); \
  877. struct usbtmc_device_data *data = usb_get_intfdata(intf); \
  878. \
  879. return sprintf(buf, "%d\n", data->capabilities.name); \
  880. } \
  881. static DEVICE_ATTR_RO(name)
  882. capability_attribute(interface_capabilities);
  883. capability_attribute(device_capabilities);
  884. capability_attribute(usb488_interface_capabilities);
  885. capability_attribute(usb488_device_capabilities);
  886. static struct attribute *capability_attrs[] = {
  887. &dev_attr_interface_capabilities.attr,
  888. &dev_attr_device_capabilities.attr,
  889. &dev_attr_usb488_interface_capabilities.attr,
  890. &dev_attr_usb488_device_capabilities.attr,
  891. NULL,
  892. };
  893. static struct attribute_group capability_attr_grp = {
  894. .attrs = capability_attrs,
  895. };
  896. static ssize_t TermChar_show(struct device *dev,
  897. struct device_attribute *attr, char *buf)
  898. {
  899. struct usb_interface *intf = to_usb_interface(dev);
  900. struct usbtmc_device_data *data = usb_get_intfdata(intf);
  901. return sprintf(buf, "%c\n", data->TermChar);
  902. }
  903. static ssize_t TermChar_store(struct device *dev,
  904. struct device_attribute *attr,
  905. const char *buf, size_t count)
  906. {
  907. struct usb_interface *intf = to_usb_interface(dev);
  908. struct usbtmc_device_data *data = usb_get_intfdata(intf);
  909. if (count < 1)
  910. return -EINVAL;
  911. data->TermChar = buf[0];
  912. return count;
  913. }
  914. static DEVICE_ATTR_RW(TermChar);
  915. #define data_attribute(name) \
  916. static ssize_t name##_show(struct device *dev, \
  917. struct device_attribute *attr, char *buf) \
  918. { \
  919. struct usb_interface *intf = to_usb_interface(dev); \
  920. struct usbtmc_device_data *data = usb_get_intfdata(intf); \
  921. \
  922. return sprintf(buf, "%d\n", data->name); \
  923. } \
  924. static ssize_t name##_store(struct device *dev, \
  925. struct device_attribute *attr, \
  926. const char *buf, size_t count) \
  927. { \
  928. struct usb_interface *intf = to_usb_interface(dev); \
  929. struct usbtmc_device_data *data = usb_get_intfdata(intf); \
  930. ssize_t result; \
  931. unsigned val; \
  932. \
  933. result = sscanf(buf, "%u\n", &val); \
  934. if (result != 1) \
  935. result = -EINVAL; \
  936. data->name = val; \
  937. if (result < 0) \
  938. return result; \
  939. else \
  940. return count; \
  941. } \
  942. static DEVICE_ATTR_RW(name)
  943. data_attribute(TermCharEnabled);
  944. data_attribute(auto_abort);
  945. static struct attribute *data_attrs[] = {
  946. &dev_attr_TermChar.attr,
  947. &dev_attr_TermCharEnabled.attr,
  948. &dev_attr_auto_abort.attr,
  949. NULL,
  950. };
  951. static struct attribute_group data_attr_grp = {
  952. .attrs = data_attrs,
  953. };
  954. static int usbtmc_ioctl_indicator_pulse(struct usbtmc_device_data *data)
  955. {
  956. struct device *dev;
  957. u8 *buffer;
  958. int rv;
  959. dev = &data->intf->dev;
  960. buffer = kmalloc(2, GFP_KERNEL);
  961. if (!buffer)
  962. return -ENOMEM;
  963. rv = usb_control_msg(data->usb_dev,
  964. usb_rcvctrlpipe(data->usb_dev, 0),
  965. USBTMC_REQUEST_INDICATOR_PULSE,
  966. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  967. 0, 0, buffer, 0x01, USBTMC_TIMEOUT);
  968. if (rv < 0) {
  969. dev_err(dev, "usb_control_msg returned %d\n", rv);
  970. goto exit;
  971. }
  972. dev_dbg(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
  973. if (buffer[0] != USBTMC_STATUS_SUCCESS) {
  974. dev_err(dev, "INDICATOR_PULSE returned %x\n", buffer[0]);
  975. rv = -EPERM;
  976. goto exit;
  977. }
  978. rv = 0;
  979. exit:
  980. kfree(buffer);
  981. return rv;
  982. }
  983. static long usbtmc_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
  984. {
  985. struct usbtmc_device_data *data;
  986. int retval = -EBADRQC;
  987. data = file->private_data;
  988. mutex_lock(&data->io_mutex);
  989. if (data->zombie) {
  990. retval = -ENODEV;
  991. goto skip_io_on_zombie;
  992. }
  993. switch (cmd) {
  994. case USBTMC_IOCTL_CLEAR_OUT_HALT:
  995. retval = usbtmc_ioctl_clear_out_halt(data);
  996. break;
  997. case USBTMC_IOCTL_CLEAR_IN_HALT:
  998. retval = usbtmc_ioctl_clear_in_halt(data);
  999. break;
  1000. case USBTMC_IOCTL_INDICATOR_PULSE:
  1001. retval = usbtmc_ioctl_indicator_pulse(data);
  1002. break;
  1003. case USBTMC_IOCTL_CLEAR:
  1004. retval = usbtmc_ioctl_clear(data);
  1005. break;
  1006. case USBTMC_IOCTL_ABORT_BULK_OUT:
  1007. retval = usbtmc_ioctl_abort_bulk_out(data);
  1008. break;
  1009. case USBTMC_IOCTL_ABORT_BULK_IN:
  1010. retval = usbtmc_ioctl_abort_bulk_in(data);
  1011. break;
  1012. case USBTMC488_IOCTL_GET_CAPS:
  1013. retval = copy_to_user((void __user *)arg,
  1014. &data->usb488_caps,
  1015. sizeof(data->usb488_caps));
  1016. if (retval)
  1017. retval = -EFAULT;
  1018. break;
  1019. case USBTMC488_IOCTL_READ_STB:
  1020. retval = usbtmc488_ioctl_read_stb(data, (void __user *)arg);
  1021. break;
  1022. case USBTMC488_IOCTL_REN_CONTROL:
  1023. retval = usbtmc488_ioctl_simple(data, (void __user *)arg,
  1024. USBTMC488_REQUEST_REN_CONTROL);
  1025. break;
  1026. case USBTMC488_IOCTL_GOTO_LOCAL:
  1027. retval = usbtmc488_ioctl_simple(data, (void __user *)arg,
  1028. USBTMC488_REQUEST_GOTO_LOCAL);
  1029. break;
  1030. case USBTMC488_IOCTL_LOCAL_LOCKOUT:
  1031. retval = usbtmc488_ioctl_simple(data, (void __user *)arg,
  1032. USBTMC488_REQUEST_LOCAL_LOCKOUT);
  1033. break;
  1034. }
  1035. skip_io_on_zombie:
  1036. mutex_unlock(&data->io_mutex);
  1037. return retval;
  1038. }
  1039. static int usbtmc_fasync(int fd, struct file *file, int on)
  1040. {
  1041. struct usbtmc_device_data *data = file->private_data;
  1042. return fasync_helper(fd, file, on, &data->fasync);
  1043. }
  1044. static unsigned int usbtmc_poll(struct file *file, poll_table *wait)
  1045. {
  1046. struct usbtmc_device_data *data = file->private_data;
  1047. unsigned int mask;
  1048. mutex_lock(&data->io_mutex);
  1049. if (data->zombie) {
  1050. mask = POLLHUP | POLLERR;
  1051. goto no_poll;
  1052. }
  1053. poll_wait(file, &data->waitq, wait);
  1054. mask = (atomic_read(&data->srq_asserted)) ? POLLIN | POLLRDNORM : 0;
  1055. no_poll:
  1056. mutex_unlock(&data->io_mutex);
  1057. return mask;
  1058. }
  1059. static const struct file_operations fops = {
  1060. .owner = THIS_MODULE,
  1061. .read = usbtmc_read,
  1062. .write = usbtmc_write,
  1063. .open = usbtmc_open,
  1064. .release = usbtmc_release,
  1065. .unlocked_ioctl = usbtmc_ioctl,
  1066. .fasync = usbtmc_fasync,
  1067. .poll = usbtmc_poll,
  1068. .llseek = default_llseek,
  1069. };
  1070. static struct usb_class_driver usbtmc_class = {
  1071. .name = "usbtmc%d",
  1072. .fops = &fops,
  1073. .minor_base = USBTMC_MINOR_BASE,
  1074. };
  1075. static void usbtmc_interrupt(struct urb *urb)
  1076. {
  1077. struct usbtmc_device_data *data = urb->context;
  1078. struct device *dev = &data->intf->dev;
  1079. int status = urb->status;
  1080. int rv;
  1081. dev_dbg(&data->intf->dev, "int status: %d len %d\n",
  1082. status, urb->actual_length);
  1083. switch (status) {
  1084. case 0: /* SUCCESS */
  1085. /* check for valid STB notification */
  1086. if (data->iin_buffer[0] > 0x81) {
  1087. data->bNotify1 = data->iin_buffer[0];
  1088. data->bNotify2 = data->iin_buffer[1];
  1089. atomic_set(&data->iin_data_valid, 1);
  1090. wake_up_interruptible(&data->waitq);
  1091. goto exit;
  1092. }
  1093. /* check for SRQ notification */
  1094. if (data->iin_buffer[0] == 0x81) {
  1095. if (data->fasync)
  1096. kill_fasync(&data->fasync,
  1097. SIGIO, POLL_IN);
  1098. atomic_set(&data->srq_asserted, 1);
  1099. wake_up_interruptible(&data->waitq);
  1100. goto exit;
  1101. }
  1102. dev_warn(dev, "invalid notification: %x\n", data->iin_buffer[0]);
  1103. break;
  1104. case -EOVERFLOW:
  1105. dev_err(dev, "overflow with length %d, actual length is %d\n",
  1106. data->iin_wMaxPacketSize, urb->actual_length);
  1107. case -ECONNRESET:
  1108. case -ENOENT:
  1109. case -ESHUTDOWN:
  1110. case -EILSEQ:
  1111. case -ETIME:
  1112. /* urb terminated, clean up */
  1113. dev_dbg(dev, "urb terminated, status: %d\n", status);
  1114. return;
  1115. default:
  1116. dev_err(dev, "unknown status received: %d\n", status);
  1117. }
  1118. exit:
  1119. rv = usb_submit_urb(urb, GFP_ATOMIC);
  1120. if (rv)
  1121. dev_err(dev, "usb_submit_urb failed: %d\n", rv);
  1122. }
  1123. static void usbtmc_free_int(struct usbtmc_device_data *data)
  1124. {
  1125. if (!data->iin_ep_present || !data->iin_urb)
  1126. return;
  1127. usb_kill_urb(data->iin_urb);
  1128. kfree(data->iin_buffer);
  1129. usb_free_urb(data->iin_urb);
  1130. kref_put(&data->kref, usbtmc_delete);
  1131. }
  1132. static int usbtmc_probe(struct usb_interface *intf,
  1133. const struct usb_device_id *id)
  1134. {
  1135. struct usbtmc_device_data *data;
  1136. struct usb_host_interface *iface_desc;
  1137. struct usb_endpoint_descriptor *endpoint;
  1138. int n;
  1139. int retcode;
  1140. dev_dbg(&intf->dev, "%s called\n", __func__);
  1141. data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
  1142. if (!data)
  1143. return -ENOMEM;
  1144. data->intf = intf;
  1145. data->id = id;
  1146. data->usb_dev = usb_get_dev(interface_to_usbdev(intf));
  1147. usb_set_intfdata(intf, data);
  1148. kref_init(&data->kref);
  1149. mutex_init(&data->io_mutex);
  1150. init_waitqueue_head(&data->waitq);
  1151. atomic_set(&data->iin_data_valid, 0);
  1152. atomic_set(&data->srq_asserted, 0);
  1153. data->zombie = 0;
  1154. /* Determine if it is a Rigol or not */
  1155. data->rigol_quirk = 0;
  1156. dev_dbg(&intf->dev, "Trying to find if device Vendor 0x%04X Product 0x%04X has the RIGOL quirk\n",
  1157. le16_to_cpu(data->usb_dev->descriptor.idVendor),
  1158. le16_to_cpu(data->usb_dev->descriptor.idProduct));
  1159. for(n = 0; usbtmc_id_quirk[n].idVendor > 0; n++) {
  1160. if ((usbtmc_id_quirk[n].idVendor == le16_to_cpu(data->usb_dev->descriptor.idVendor)) &&
  1161. (usbtmc_id_quirk[n].idProduct == le16_to_cpu(data->usb_dev->descriptor.idProduct))) {
  1162. dev_dbg(&intf->dev, "Setting this device as having the RIGOL quirk\n");
  1163. data->rigol_quirk = 1;
  1164. break;
  1165. }
  1166. }
  1167. /* Initialize USBTMC bTag and other fields */
  1168. data->bTag = 1;
  1169. data->TermCharEnabled = 0;
  1170. data->TermChar = '\n';
  1171. /* 2 <= bTag <= 127 USBTMC-USB488 subclass specification 4.3.1 */
  1172. data->iin_bTag = 2;
  1173. /* USBTMC devices have only one setting, so use that */
  1174. iface_desc = data->intf->cur_altsetting;
  1175. data->ifnum = iface_desc->desc.bInterfaceNumber;
  1176. /* Find bulk in endpoint */
  1177. for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
  1178. endpoint = &iface_desc->endpoint[n].desc;
  1179. if (usb_endpoint_is_bulk_in(endpoint)) {
  1180. data->bulk_in = endpoint->bEndpointAddress;
  1181. dev_dbg(&intf->dev, "Found bulk in endpoint at %u\n",
  1182. data->bulk_in);
  1183. break;
  1184. }
  1185. }
  1186. /* Find bulk out endpoint */
  1187. for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
  1188. endpoint = &iface_desc->endpoint[n].desc;
  1189. if (usb_endpoint_is_bulk_out(endpoint)) {
  1190. data->bulk_out = endpoint->bEndpointAddress;
  1191. dev_dbg(&intf->dev, "Found Bulk out endpoint at %u\n",
  1192. data->bulk_out);
  1193. break;
  1194. }
  1195. }
  1196. /* Find int endpoint */
  1197. for (n = 0; n < iface_desc->desc.bNumEndpoints; n++) {
  1198. endpoint = &iface_desc->endpoint[n].desc;
  1199. if (usb_endpoint_is_int_in(endpoint)) {
  1200. data->iin_ep_present = 1;
  1201. data->iin_ep = endpoint->bEndpointAddress;
  1202. data->iin_wMaxPacketSize = usb_endpoint_maxp(endpoint);
  1203. data->iin_interval = endpoint->bInterval;
  1204. dev_dbg(&intf->dev, "Found Int in endpoint at %u\n",
  1205. data->iin_ep);
  1206. break;
  1207. }
  1208. }
  1209. retcode = get_capabilities(data);
  1210. if (retcode)
  1211. dev_err(&intf->dev, "can't read capabilities\n");
  1212. else
  1213. retcode = sysfs_create_group(&intf->dev.kobj,
  1214. &capability_attr_grp);
  1215. if (data->iin_ep_present) {
  1216. /* allocate int urb */
  1217. data->iin_urb = usb_alloc_urb(0, GFP_KERNEL);
  1218. if (!data->iin_urb) {
  1219. dev_err(&intf->dev, "Failed to allocate int urb\n");
  1220. goto error_register;
  1221. }
  1222. /* will reference data in int urb */
  1223. kref_get(&data->kref);
  1224. /* allocate buffer for interrupt in */
  1225. data->iin_buffer = kmalloc(data->iin_wMaxPacketSize,
  1226. GFP_KERNEL);
  1227. if (!data->iin_buffer) {
  1228. dev_err(&intf->dev, "Failed to allocate int buf\n");
  1229. goto error_register;
  1230. }
  1231. /* fill interrupt urb */
  1232. usb_fill_int_urb(data->iin_urb, data->usb_dev,
  1233. usb_rcvintpipe(data->usb_dev, data->iin_ep),
  1234. data->iin_buffer, data->iin_wMaxPacketSize,
  1235. usbtmc_interrupt,
  1236. data, data->iin_interval);
  1237. retcode = usb_submit_urb(data->iin_urb, GFP_KERNEL);
  1238. if (retcode) {
  1239. dev_err(&intf->dev, "Failed to submit iin_urb\n");
  1240. goto error_register;
  1241. }
  1242. }
  1243. retcode = sysfs_create_group(&intf->dev.kobj, &data_attr_grp);
  1244. retcode = usb_register_dev(intf, &usbtmc_class);
  1245. if (retcode) {
  1246. dev_err(&intf->dev, "Not able to get a minor"
  1247. " (base %u, slice default): %d\n", USBTMC_MINOR_BASE,
  1248. retcode);
  1249. goto error_register;
  1250. }
  1251. dev_dbg(&intf->dev, "Using minor number %d\n", intf->minor);
  1252. return 0;
  1253. error_register:
  1254. sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
  1255. sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
  1256. usbtmc_free_int(data);
  1257. kref_put(&data->kref, usbtmc_delete);
  1258. return retcode;
  1259. }
  1260. static void usbtmc_disconnect(struct usb_interface *intf)
  1261. {
  1262. struct usbtmc_device_data *data;
  1263. dev_dbg(&intf->dev, "usbtmc_disconnect called\n");
  1264. data = usb_get_intfdata(intf);
  1265. usb_deregister_dev(intf, &usbtmc_class);
  1266. sysfs_remove_group(&intf->dev.kobj, &capability_attr_grp);
  1267. sysfs_remove_group(&intf->dev.kobj, &data_attr_grp);
  1268. mutex_lock(&data->io_mutex);
  1269. data->zombie = 1;
  1270. wake_up_all(&data->waitq);
  1271. mutex_unlock(&data->io_mutex);
  1272. usbtmc_free_int(data);
  1273. kref_put(&data->kref, usbtmc_delete);
  1274. }
  1275. static int usbtmc_suspend(struct usb_interface *intf, pm_message_t message)
  1276. {
  1277. /* this driver does not have pending URBs */
  1278. return 0;
  1279. }
  1280. static int usbtmc_resume(struct usb_interface *intf)
  1281. {
  1282. return 0;
  1283. }
  1284. static struct usb_driver usbtmc_driver = {
  1285. .name = "usbtmc",
  1286. .id_table = usbtmc_devices,
  1287. .probe = usbtmc_probe,
  1288. .disconnect = usbtmc_disconnect,
  1289. .suspend = usbtmc_suspend,
  1290. .resume = usbtmc_resume,
  1291. };
  1292. module_usb_driver(usbtmc_driver);
  1293. MODULE_LICENSE("GPL");