usbtmc.c 38 KB

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