usbtmc.c 38 KB

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