usbtmc.c 41 KB

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