usbtmc.c 41 KB

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