drivers/usb/class/cdc-acm.h

   1 /*
   2  *
   3  * Includes for cdc-acm.c
   4  *
   5  * Mainly take from usbnet's cdc-ether part
   6  *
   7  */
   8
   9 /*
  10  * CMSPAR, some architectures can't have space and mark parity.
  11  */
  12
  13 #ifndef CMSPAR
  14 #define CMSPAR                  0
  15 #endif
  16
  17 /*
  18  * Major and minor numbers.
  19  */
  20
  21 #define ACM_TTY_MAJOR           166
  22 #define ACM_TTY_MINORS          256
  23
  24 /*
  25  * Requests.
  26  */
  27
  28 #define USB_RT_ACM              (USB_TYPE_CLASS | USB_RECIP_INTERFACE)
  29
  30 /*
  31  * Output control lines.
  32  */
  33
  34 #define ACM_CTRL_DTR            0x01
  35 #define ACM_CTRL_RTS            0x02
  36
  37 /*
  38  * Input control lines and line errors.
  39  */
  40
  41 #define ACM_CTRL_DCD            0x01
  42 #define ACM_CTRL_DSR            0x02
  43 #define ACM_CTRL_BRK            0x04
  44 #define ACM_CTRL_RI             0x08
  45
  46 #define ACM_CTRL_FRAMING        0x10
  47 #define ACM_CTRL_PARITY         0x20
  48 #define ACM_CTRL_OVERRUN        0x40
  49
  50 /*
  51  * Internal driver structures.
  52  */
  53
  54 /*
  55  * The only reason to have several buffers is to accommodate assumptions
  56  * in line disciplines. They ask for empty space amount, receive our URB size,
  57  * and proceed to issue several 1-character writes, assuming they will fit.
  58  * The very first write takes a complete URB. Fortunately, this only happens
  59  * when processing onlcr, so we only need 2 buffers. These values must be
  60  * powers of 2.
  61  */
  62 #define ACM_NW  16
  63 #define ACM_NR  16
  64
  65 struct acm_wb {
  66         unsigned char *buf;
  67         dma_addr_t dmah;
  68         int len;
  69         int use;
  70         struct urb              *urb;
  71         struct acm              *instance;
  72 };
  73
  74 struct acm_rb {
  75         int                     size;
  76         unsigned char           *base;
  77         dma_addr_t              dma;
  78         int                     index;
  79         struct acm              *instance;
  80 };
  81
  82 struct acm {
  83         struct usb_device *dev;                         /* the corresponding usb device */
  84         struct usb_interface *control;                  /* control interface */
  85         struct usb_interface *data;                     /* data interface */
  86         unsigned in, out;                               /* i/o pipes */
  87         struct tty_port port;                           /* our tty port data */
  88         struct urb *ctrlurb;                            /* urbs */
  89         u8 *ctrl_buffer;                                /* buffers of urbs */
  90         dma_addr_t ctrl_dma;                            /* dma handles of buffers */
  91         u8 *country_codes;                              /* country codes from device */
  92         unsigned int country_code_size;                 /* size of this buffer */
  93         unsigned int country_rel_date;                  /* release date of version */
  94         struct acm_wb wb[ACM_NW];
  95         unsigned long read_urbs_free;
  96         struct urb *read_urbs[ACM_NR];
  97         struct acm_rb read_buffers[ACM_NR];
  98         struct acm_wb *putbuffer;                       /* for acm_tty_put_char() */
  99         int rx_buflimit;
 100         spinlock_t read_lock;
 101         u8 *notification_buffer;                        /* to reassemble fragmented notifications */
 102         unsigned int nb_index;
 103         unsigned int nb_size;
 104         int transmitting;
 105         spinlock_t write_lock;
 106         struct mutex mutex;
 107         bool disconnected;
 108         unsigned long flags;
 109 #               define EVENT_TTY_WAKEUP 0
 110 #               define EVENT_RX_STALL   1
 111         struct usb_cdc_line_coding line;                /* bits, stop, parity */
 112         struct work_struct work;                        /* work queue entry for line discipline waking up */
 113         unsigned int ctrlin;                            /* input control lines (DCD, DSR, RI, break, overruns) */
 114         unsigned int ctrlout;                           /* output control lines (DTR, RTS) */
 115         struct async_icount iocount;                    /* counters for control line changes */
 116         struct async_icount oldcount;                   /* for comparison of counter */
 117         wait_queue_head_t wioctl;                       /* for ioctl */
 118         unsigned int writesize;                         /* max packet size for the output bulk endpoint */
 119         unsigned int readsize,ctrlsize;                 /* buffer sizes for freeing */
 120         unsigned int minor;                             /* acm minor number */
 121         unsigned char clocal;                           /* termios CLOCAL */
 122         unsigned int ctrl_caps;                         /* control capabilities from the class specific header */
 123         unsigned int susp_count;                        /* number of suspended interfaces */
 124         unsigned int combined_interfaces:1;             /* control and data collapsed */
 125         unsigned int throttled:1;                       /* actually throttled */
 126         unsigned int throttle_req:1;                    /* throttle requested */
 127         u8 bInterval;
 128         struct usb_anchor delayed;                      /* writes queued for a device about to be woken */
 129         unsigned long quirks;
 130 };
 131
 132 #define CDC_DATA_INTERFACE_TYPE 0x0a
 133
 134 /* constants describing various quirks and errors */
 135 #define NO_UNION_NORMAL                 BIT(0)
 136 #define SINGLE_RX_URB                   BIT(1)
 137 #define NO_CAP_LINE                     BIT(2)
 138 #define NO_DATA_INTERFACE               BIT(4)
 139 #define IGNORE_DEVICE                   BIT(5)
 140 #define QUIRK_CONTROL_LINE_STATE        BIT(6)
 141 #define CLEAR_HALT_CONDITIONS           BIT(7)
 142 #define SEND_ZERO_PACKET                BIT(8)