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