linux/usb/cdc_ncm.h

0001 // SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
0002 /*
0003  * Copyright (C) ST-Ericsson 2010-2012
0004  * Contact: Alexey Orishko <alexey.orishko@stericsson.com>
0005  * Original author: Hans Petter Selasky <hans.petter.selasky@stericsson.com>
0006  *
0007  * USB Host Driver for Network Control Model (NCM)
0008  * http://www.usb.org/developers/devclass_docs/NCM10.zip
0009  *
0010  * The NCM encoding, decoding and initialization logic
0011  * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
0012  *
0013  * This software is available to you under a choice of one of two
0014  * licenses. You may choose this file to be licensed under the terms
0015  * of the GNU General Public License (GPL) Version 2 or the 2-clause
0016  * BSD license listed below:
0017  *
0018  * Redistribution and use in source and binary forms, with or without
0019  * modification, are permitted provided that the following conditions
0020  * are met:
0021  * 1. Redistributions of source code must retain the above copyright
0022  *    notice, this list of conditions and the following disclaimer.
0023  * 2. Redistributions in binary form must reproduce the above copyright
0024  *    notice, this list of conditions and the following disclaimer in the
0025  *    documentation and/or other materials provided with the distribution.
0026  *
0027  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
0028  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0029  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0030  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
0031  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
0032  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
0033  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
0034  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
0035  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
0036  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
0037  * SUCH DAMAGE.
0038  */
0039
0040 #ifndef __LINUX_USB_CDC_NCM_H
0041 #define __LINUX_USB_CDC_NCM_H
0042
0043 #define CDC_NCM_COMM_ALTSETTING_NCM     0
0044 #define CDC_NCM_COMM_ALTSETTING_MBIM        1
0045
0046 #define CDC_NCM_DATA_ALTSETTING_NCM     1
0047 #define CDC_NCM_DATA_ALTSETTING_MBIM        2
0048
0049 /* CDC NCM subclass 3.3.1 */
0050 #define USB_CDC_NCM_NDP16_LENGTH_MIN        0x10
0051
0052 /* CDC NCM subclass 3.3.2 */
0053 #define USB_CDC_NCM_NDP32_LENGTH_MIN        0x20
0054
0055 /* Maximum NTB length */
0056 #define CDC_NCM_NTB_MAX_SIZE_TX         65536   /* bytes */
0057 #define CDC_NCM_NTB_MAX_SIZE_RX         65536   /* bytes */
0058
0059 /* Initial NTB length */
0060 #define CDC_NCM_NTB_DEF_SIZE_TX         16384   /* bytes */
0061 #define CDC_NCM_NTB_DEF_SIZE_RX         16384   /* bytes */
0062
0063 /* Minimum value for MaxDatagramSize, ch. 6.2.9 */
0064 #define CDC_NCM_MIN_DATAGRAM_SIZE       1514    /* bytes */
0065
0066 /* Minimum value for MaxDatagramSize, ch. 8.1.3 */
0067 #define CDC_MBIM_MIN_DATAGRAM_SIZE      2048    /* bytes */
0068
0069 #define CDC_NCM_MIN_TX_PKT          512 /* bytes */
0070
0071 /* Default value for MaxDatagramSize */
0072 #define CDC_NCM_MAX_DATAGRAM_SIZE       8192    /* bytes */
0073
0074 /*
0075  * Maximum amount of datagrams in NCM Datagram Pointer Table, not counting
0076  * the last NULL entry.
0077  */
0078 #define CDC_NCM_DPT_DATAGRAMS_MAX       40
0079
0080 /* Restart the timer, if amount of datagrams is less than given value */
0081 #define CDC_NCM_RESTART_TIMER_DATAGRAM_CNT  3
0082 #define CDC_NCM_TIMER_PENDING_CNT       2
0083 #define CDC_NCM_TIMER_INTERVAL_USEC     400UL
0084 #define CDC_NCM_TIMER_INTERVAL_MIN      5UL
0085 #define CDC_NCM_TIMER_INTERVAL_MAX      (U32_MAX / NSEC_PER_USEC)
0086
0087 /* Driver flags */
0088 #define CDC_NCM_FLAG_NDP_TO_END         0x02    /* NDP is placed at end of frame */
0089 #define CDC_MBIM_FLAG_AVOID_ALTSETTING_TOGGLE   0x04    /* Avoid altsetting toggle during init */
0090 #define CDC_NCM_FLAG_PREFER_NTB32 0x08  /* prefer NDP32 over NDP16 */
0091
0092 #define cdc_ncm_comm_intf_is_mbim(x)  ((x)->desc.bInterfaceSubClass == USB_CDC_SUBCLASS_MBIM && \
0093                        (x)->desc.bInterfaceProtocol == USB_CDC_PROTO_NONE)
0094 #define cdc_ncm_data_intf_is_mbim(x)  ((x)->desc.bInterfaceProtocol == USB_CDC_MBIM_PROTO_NTB)
0095
0096 struct cdc_ncm_ctx {
0097     struct usb_cdc_ncm_ntb_parameters ncm_parm;
0098     struct hrtimer tx_timer;
0099     struct tasklet_struct bh;
0100
0101     struct usbnet *dev;
0102
0103     const struct usb_cdc_ncm_desc *func_desc;
0104     const struct usb_cdc_mbim_desc *mbim_desc;
0105     const struct usb_cdc_mbim_extended_desc *mbim_extended_desc;
0106     const struct usb_cdc_ether_desc *ether_desc;
0107
0108     struct usb_interface *control;
0109     struct usb_interface *data;
0110
0111     struct sk_buff *tx_curr_skb;
0112     struct sk_buff *tx_rem_skb;
0113     __le32 tx_rem_sign;
0114
0115     spinlock_t mtx;
0116     atomic_t stop;
0117     int drvflags;
0118
0119     u32 timer_interval;
0120     u32 max_ndp_size;
0121     u8 is_ndp16;
0122     union {
0123         struct usb_cdc_ncm_ndp16 *delayed_ndp16;
0124         struct usb_cdc_ncm_ndp32 *delayed_ndp32;
0125     };
0126
0127     u32 tx_timer_pending;
0128     u32 tx_curr_frame_num;
0129     u32 rx_max;
0130     u32 tx_max;
0131     u32 tx_curr_size;
0132     u32 tx_low_mem_max_cnt;
0133     u32 tx_low_mem_val;
0134     u32 max_datagram_size;
0135     u16 tx_max_datagrams;
0136     u16 tx_remainder;
0137     u16 tx_modulus;
0138     u16 tx_ndp_modulus;
0139     u16 tx_seq;
0140     u16 rx_seq;
0141     u16 min_tx_pkt;
0142
0143     /* statistics */
0144     u32 tx_curr_frame_payload;
0145     u32 tx_reason_ntb_full;
0146     u32 tx_reason_ndp_full;
0147     u32 tx_reason_timeout;
0148     u32 tx_reason_max_datagram;
0149     u64 tx_overhead;
0150     u64 tx_ntbs;
0151     u64 rx_overhead;
0152     u64 rx_ntbs;
0153 };
0154
0155 u8 cdc_ncm_select_altsetting(struct usb_interface *intf);
0156 int cdc_ncm_change_mtu(struct net_device *net, int new_mtu);
0157 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting, int drvflags);
0158 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf);
0159 struct sk_buff *cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign);
0160 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in);
0161 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset);
0162 int cdc_ncm_rx_verify_nth32(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in);
0163 int cdc_ncm_rx_verify_ndp32(struct sk_buff *skb_in, int ndpoffset);
0164 struct sk_buff *
0165 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags);
0166 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in);
0167
0168 #endif /* __LINUX_USB_CDC_NCM_H */