include/uapi/linux/usb/tmc.h

   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 <gregkh@suse.de>
   6  * Copyright (C) 2015 Dave Penkler <dpenkler@gmail.com>
   7  *
   8  * This file holds USB constants defined by the USB Device Class
   9  * and USB488 Subclass Definitions for Test and Measurement devices
  10  * published by the USB-IF.
  11  *
  12  * It also has the ioctl and capability definitions for the
  13  * usbtmc kernel driver that userspace needs to know about.
  14  */
  15
  16 #ifndef __LINUX_USB_TMC_H
  17 #define __LINUX_USB_TMC_H
  18
  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
  27 /* USB TMC requests values */
  28 #define USBTMC_REQUEST_INITIATE_ABORT_BULK_OUT          1
  29 #define USBTMC_REQUEST_CHECK_ABORT_BULK_OUT_STATUS      2
  30 #define USBTMC_REQUEST_INITIATE_ABORT_BULK_IN           3
  31 #define USBTMC_REQUEST_CHECK_ABORT_BULK_IN_STATUS       4
  32 #define USBTMC_REQUEST_INITIATE_CLEAR                   5
  33 #define USBTMC_REQUEST_CHECK_CLEAR_STATUS               6
  34 #define USBTMC_REQUEST_GET_CAPABILITIES                 7
  35 #define USBTMC_REQUEST_INDICATOR_PULSE                  64
  36 #define USBTMC488_REQUEST_READ_STATUS_BYTE              128
  37 #define USBTMC488_REQUEST_REN_CONTROL                   160
  38 #define USBTMC488_REQUEST_GOTO_LOCAL                    161
  39 #define USBTMC488_REQUEST_LOCAL_LOCKOUT                 162
  40
  41 /* Request values for USBTMC driver's ioctl entry point */
  42 #define USBTMC_IOC_NR                   91
  43 #define USBTMC_IOCTL_INDICATOR_PULSE    _IO(USBTMC_IOC_NR, 1)
  44 #define USBTMC_IOCTL_CLEAR              _IO(USBTMC_IOC_NR, 2)
  45 #define USBTMC_IOCTL_ABORT_BULK_OUT     _IO(USBTMC_IOC_NR, 3)
  46 #define USBTMC_IOCTL_ABORT_BULK_IN      _IO(USBTMC_IOC_NR, 4)
  47 #define USBTMC_IOCTL_CLEAR_OUT_HALT     _IO(USBTMC_IOC_NR, 6)
  48 #define USBTMC_IOCTL_CLEAR_IN_HALT      _IO(USBTMC_IOC_NR, 7)
  49 #define USBTMC488_IOCTL_GET_CAPS        _IOR(USBTMC_IOC_NR, 17, unsigned char)
  50 #define USBTMC488_IOCTL_READ_STB        _IOR(USBTMC_IOC_NR, 18, unsigned char)
  51 #define USBTMC488_IOCTL_REN_CONTROL     _IOW(USBTMC_IOC_NR, 19, unsigned char)
  52 #define USBTMC488_IOCTL_GOTO_LOCAL      _IO(USBTMC_IOC_NR, 20)
  53 #define USBTMC488_IOCTL_LOCAL_LOCKOUT   _IO(USBTMC_IOC_NR, 21)
  54
  55 /* Driver encoded usb488 capabilities */
  56 #define USBTMC488_CAPABILITY_TRIGGER         1
  57 #define USBTMC488_CAPABILITY_SIMPLE          2
  58 #define USBTMC488_CAPABILITY_REN_CONTROL     2
  59 #define USBTMC488_CAPABILITY_GOTO_LOCAL      2
  60 #define USBTMC488_CAPABILITY_LOCAL_LOCKOUT   2
  61 #define USBTMC488_CAPABILITY_488_DOT_2       4
  62 #define USBTMC488_CAPABILITY_DT1             16
  63 #define USBTMC488_CAPABILITY_RL1             32
  64 #define USBTMC488_CAPABILITY_SR1             64
  65 #define USBTMC488_CAPABILITY_FULL_SCPI       128
  66
  67 #endif