include/linux/usb/cdc_ncm.h

   1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
   2 /*
   3  * Copyright (C) ST-Ericsson 2010-2012
   4  * Contact: Alexey Orishko <alexey.orishko@stericsson.com>
   5  * Original author: Hans Petter Selasky <hans.petter.selasky@stericsson.com>
   6  *
   7  * USB Host Driver for Network Control Model (NCM)
   8  * http://www.usb.org/developers/devclass_docs/NCM10.zip
   9  *
  10  * The NCM encoding, decoding and initialization logic
  11  * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
  12  *
  13  * This software is available to you under a choice of one of two
  14  * licenses. You may choose this file to be licensed under the terms
  15  * of the GNU General Public License (GPL) Version 2 or the 2-clause
  16  * BSD license listed below:
  17  *
  18  * Redistribution and use in source and binary forms, with or without
  19  * modification, are permitted provided that the following conditions
  20  * are met:
  21  * 1. Redistributions of source code must retain the above copyright
  22  *    notice, this list of conditions and the following disclaimer.
  23  * 2. Redistributions in binary form must reproduce the above copyright
  24  *    notice, this list of conditions and the following disclaimer in the
  25  *    documentation and/or other materials provided with the distribution.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  */
  39
  40 #ifndef __LINUX_USB_CDC_NCM_H
  41 #define __LINUX_USB_CDC_NCM_H
  42
  43 #define CDC_NCM_COMM_ALTSETTING_NCM             0
  44 #define CDC_NCM_COMM_ALTSETTING_MBIM            1
  45
  46 #define CDC_NCM_DATA_ALTSETTING_NCM             1
  47 #define CDC_NCM_DATA_ALTSETTING_MBIM            2
  48
  49 /* CDC NCM subclass 3.2.1 */
  50 #define USB_CDC_NCM_NDP16_LENGTH_MIN            0x10
  51
  52 /* Maximum NTB length */
  53 #define CDC_NCM_NTB_MAX_SIZE_TX                 32768   /* bytes */
  54 #define CDC_NCM_NTB_MAX_SIZE_RX                 32768   /* bytes */
  55
  56 /* Initial NTB length */
  57 #define CDC_NCM_NTB_DEF_SIZE_TX                 16384   /* bytes */
  58 #define CDC_NCM_NTB_DEF_SIZE_RX                 16384   /* bytes */
  59
  60 /* Minimum value for MaxDatagramSize, ch. 6.2.9 */
  61 #define CDC_NCM_MIN_DATAGRAM_SIZE               1514    /* bytes */
  62
  63 /* Minimum value for MaxDatagramSize, ch. 8.1.3 */
  64 #define CDC_MBIM_MIN_DATAGRAM_SIZE              2048    /* bytes */
  65
  66 #define CDC_NCM_MIN_TX_PKT                      512     /* bytes */
  67
  68 /* Default value for MaxDatagramSize */
  69 #define CDC_NCM_MAX_DATAGRAM_SIZE               8192    /* bytes */
  70
  71 /*
  72  * Maximum amount of datagrams in NCM Datagram Pointer Table, not counting
  73  * the last NULL entry.
  74  */
  75 #define CDC_NCM_DPT_DATAGRAMS_MAX               40
  76
  77 /* Restart the timer, if amount of datagrams is less than given value */
  78 #define CDC_NCM_RESTART_TIMER_DATAGRAM_CNT      3
  79 #define CDC_NCM_TIMER_PENDING_CNT               2
  80 #define CDC_NCM_TIMER_INTERVAL_USEC             400UL
  81 #define CDC_NCM_TIMER_INTERVAL_MIN              5UL
  82 #define CDC_NCM_TIMER_INTERVAL_MAX              (U32_MAX / NSEC_PER_USEC)
  83
  84 /* Driver flags */
  85 #define CDC_NCM_FLAG_NDP_TO_END                 0x02    /* NDP is placed at end of frame */
  86 #define CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE   0x04    /* Avoid altsetting toggle during init */
  87 #define CDC_NCM_FLAG_RESET_NTB16 0x08   /* set NDP16 one more time after altsetting switch */
  88
  89 #define cdc_ncm_comm_intf_is_mbim(x)  ((x)->desc.bInterfaceSubClass == USB_CDC_SUBCLASS_MBIM && \
  90                                        (x)->desc.bInterfaceProtocol == USB_CDC_PROTO_NONE)
  91 #define cdc_ncm_data_intf_is_mbim(x)  ((x)->desc.bInterfaceProtocol == USB_CDC_MBIM_PROTO_NTB)
  92
  93 struct cdc_ncm_ctx {
  94         struct usb_cdc_ncm_ntb_parameters ncm_parm;
  95         struct hrtimer tx_timer;
  96         struct tasklet_struct bh;
  97
  98         const struct usb_cdc_ncm_desc *func_desc;
  99         const struct usb_cdc_mbim_desc *mbim_desc;
 100         const struct usb_cdc_mbim_extended_desc *mbim_extended_desc;
 101         const struct usb_cdc_ether_desc *ether_desc;
 102
 103         struct usb_interface *control;
 104         struct usb_interface *data;
 105
 106         struct sk_buff *tx_curr_skb;
 107         struct sk_buff *tx_rem_skb;
 108         __le32 tx_rem_sign;
 109
 110         spinlock_t mtx;
 111         atomic_t stop;
 112         int drvflags;
 113
 114         u32 timer_interval;
 115         u32 max_ndp_size;
 116         struct usb_cdc_ncm_ndp16 *delayed_ndp16;
 117
 118         u32 tx_timer_pending;
 119         u32 tx_curr_frame_num;
 120         u32 rx_max;
 121         u32 tx_max;
 122         u32 tx_curr_size;
 123         u32 tx_low_mem_max_cnt;
 124         u32 tx_low_mem_val;
 125         u32 max_datagram_size;
 126         u16 tx_max_datagrams;
 127         u16 tx_remainder;
 128         u16 tx_modulus;
 129         u16 tx_ndp_modulus;
 130         u16 tx_seq;
 131         u16 rx_seq;
 132         u16 min_tx_pkt;
 133
 134         /* statistics */
 135         u32 tx_curr_frame_payload;
 136         u32 tx_reason_ntb_full;
 137         u32 tx_reason_ndp_full;
 138         u32 tx_reason_timeout;
 139         u32 tx_reason_max_datagram;
 140         u64 tx_overhead;
 141         u64 tx_ntbs;
 142         u64 rx_overhead;
 143         u64 rx_ntbs;
 144 };
 145
 146 u8 cdc_ncm_select_altsetting(struct usb_interface *intf);
 147 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu);
 148 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags);
 149 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf);
 150 struct sk_buff *cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign);
 151 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in);
 152 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset);
 153 struct sk_buff *
 154 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags);
 155 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in);
 156
 157 #endif /* __LINUX_USB_CDC_NCM_H */