tmc.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. /*
  3. * Copyright (C) 2007 Stefan Kopp, Gechingen, Germany
  4. * Copyright (C) 2008 Novell, Inc.
  5. * Copyright (C) 2008 Greg Kroah-Hartman <[email protected]>
  6. * Copyright (C) 2015 Dave Penkler <[email protected]>
  7. * Copyright (C) 2018 IVI Foundation, Inc.
  8. *
  9. * This file holds USB constants defined by the USB Device Class
  10. * and USB488 Subclass Definitions for Test and Measurement devices
  11. * published by the USB-IF.
  12. *
  13. * It also has the ioctl and capability definitions for the
  14. * usbtmc kernel driver that userspace needs to know about.
  15. */
  16. #ifndef __LINUX_USB_TMC_H
  17. #define __LINUX_USB_TMC_H
  18. #include <linux/types.h> /* __u8 etc */
  19. /* USB TMC status values */
  20. #define USBTMC_STATUS_SUCCESS 0x01
  21. #define USBTMC_STATUS_PENDING 0x02
  22. #define USBTMC_STATUS_FAILED 0x80
  23. #define USBTMC_STATUS_TRANSFER_NOT_IN_PROGRESS 0x81
  24. #define USBTMC_STATUS_SPLIT_NOT_IN_PROGRESS 0x82
  25. #define USBTMC_STATUS_SPLIT_IN_PROGRESS 0x83
  26. /* USB TMC requests values */
  27. #define USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT 1
  28. #define USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS 2
  29. #define USBTMC_REQUEST_INITIATE_ABORT_BULK_IN 3
  30. #define USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS 4
  31. #define USBTMC_REQUEST_INITIATE_CLEAR 5
  32. #define USBTMC_REQUEST_CHECK_CLEAR_STATUS 6
  33. #define USBTMC_REQUEST_GET_CAPABILITIES 7
  34. #define USBTMC_REQUEST_INDICATOR_PULSE 64
  35. #define USBTMC488_REQUEST_READ_STATUS_BYTE 128
  36. #define USBTMC488_REQUEST_REN_CONTROL 160
  37. #define USBTMC488_REQUEST_GOTO_LOCAL 161
  38. #define USBTMC488_REQUEST_LOCAL_LOCKOUT 162
  39. struct usbtmc_request {
  40. __u8 bRequestType;
  41. __u8 bRequest;
  42. __u16 wValue;
  43. __u16 wIndex;
  44. __u16 wLength;
  45. } __attribute__ ((packed));
  46. struct usbtmc_ctrlrequest {
  47. struct usbtmc_request req;
  48. void __user *data; /* pointer to user space */
  49. } __attribute__ ((packed));
  50. struct usbtmc_termchar {
  51. __u8 term_char;
  52. __u8 term_char_enabled;
  53. } __attribute__ ((packed));
  54. /*
  55. * usbtmc_message->flags:
  56. */
  57. #define USBTMC_FLAG_ASYNC 0x0001
  58. #define USBTMC_FLAG_APPEND 0x0002
  59. #define USBTMC_FLAG_IGNORE_TRAILER 0x0004
  60. struct usbtmc_message {
  61. __u32 transfer_size; /* size of bytes to transfer */
  62. __u32 transferred; /* size of received/written bytes */
  63. __u32 flags; /* bit 0: 0 = synchronous; 1 = asynchronous */
  64. void __user *message; /* pointer to header and data in user space */
  65. } __attribute__ ((packed));
  66. /* Request values for USBTMC driver's ioctl entry point */
  67. #define USBTMC_IOC_NR 91
  68. #define USBTMC_IOCTL_INDICATOR_PULSE _IO(USBTMC_IOC_NR, 1)
  69. #define USBTMC_IOCTL_CLEAR _IO(USBTMC_IOC_NR, 2)
  70. #define USBTMC_IOCTL_ABORT_BULK_OUT _IO(USBTMC_IOC_NR, 3)
  71. #define USBTMC_IOCTL_ABORT_BULK_IN _IO(USBTMC_IOC_NR, 4)
  72. #define USBTMC_IOCTL_CLEAR_OUT_HALT _IO(USBTMC_IOC_NR, 6)
  73. #define USBTMC_IOCTL_CLEAR_IN_HALT _IO(USBTMC_IOC_NR, 7)
  74. #define USBTMC_IOCTL_CTRL_REQUEST _IOWR(USBTMC_IOC_NR, 8, struct usbtmc_ctrlrequest)
  75. #define USBTMC_IOCTL_GET_TIMEOUT _IOR(USBTMC_IOC_NR, 9, __u32)
  76. #define USBTMC_IOCTL_SET_TIMEOUT _IOW(USBTMC_IOC_NR, 10, __u32)
  77. #define USBTMC_IOCTL_EOM_ENABLE _IOW(USBTMC_IOC_NR, 11, __u8)
  78. #define USBTMC_IOCTL_CONFIG_TERMCHAR _IOW(USBTMC_IOC_NR, 12, struct usbtmc_termchar)
  79. #define USBTMC_IOCTL_WRITE _IOWR(USBTMC_IOC_NR, 13, struct usbtmc_message)
  80. #define USBTMC_IOCTL_READ _IOWR(USBTMC_IOC_NR, 14, struct usbtmc_message)
  81. #define USBTMC_IOCTL_WRITE_RESULT _IOWR(USBTMC_IOC_NR, 15, __u32)
  82. #define USBTMC_IOCTL_API_VERSION _IOR(USBTMC_IOC_NR, 16, __u32)
  83. #define USBTMC488_IOCTL_GET_CAPS _IOR(USBTMC_IOC_NR, 17, unsigned char)
  84. #define USBTMC488_IOCTL_READ_STB _IOR(USBTMC_IOC_NR, 18, unsigned char)
  85. #define USBTMC488_IOCTL_REN_CONTROL _IOW(USBTMC_IOC_NR, 19, unsigned char)
  86. #define USBTMC488_IOCTL_GOTO_LOCAL _IO(USBTMC_IOC_NR, 20)
  87. #define USBTMC488_IOCTL_LOCAL_LOCKOUT _IO(USBTMC_IOC_NR, 21)
  88. #define USBTMC488_IOCTL_TRIGGER _IO(USBTMC_IOC_NR, 22)
  89. #define USBTMC488_IOCTL_WAIT_SRQ _IOW(USBTMC_IOC_NR, 23, __u32)
  90. #define USBTMC_IOCTL_MSG_IN_ATTR _IOR(USBTMC_IOC_NR, 24, __u8)
  91. #define USBTMC_IOCTL_AUTO_ABORT _IOW(USBTMC_IOC_NR, 25, __u8)
  92. #define USBTMC_IOCTL_GET_STB _IOR(USBTMC_IOC_NR, 26, __u8)
  93. #define USBTMC_IOCTL_GET_SRQ_STB _IOR(USBTMC_IOC_NR, 27, __u8)
  94. /* Cancel and cleanup asynchronous calls */
  95. #define USBTMC_IOCTL_CANCEL_IO _IO(USBTMC_IOC_NR, 35)
  96. #define USBTMC_IOCTL_CLEANUP_IO _IO(USBTMC_IOC_NR, 36)
  97. /* Driver encoded usb488 capabilities */
  98. #define USBTMC488_CAPABILITY_TRIGGER 1
  99. #define USBTMC488_CAPABILITY_SIMPLE 2
  100. #define USBTMC488_CAPABILITY_REN_CONTROL 2
  101. #define USBTMC488_CAPABILITY_GOTO_LOCAL 2
  102. #define USBTMC488_CAPABILITY_LOCAL_LOCKOUT 2
  103. #define USBTMC488_CAPABILITY_488_DOT_2 4
  104. #define USBTMC488_CAPABILITY_DT1 16
  105. #define USBTMC488_CAPABILITY_RL1 32
  106. #define USBTMC488_CAPABILITY_SR1 64
  107. #define USBTMC488_CAPABILITY_FULL_SCPI 128
  108. #endif