usbtmc.c 37 KB

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