1 /* 2 * Copyright (C) ST-Ericsson 2010-2012 3 * Contact: Alexey Orishko <[email protected]> 4 * Original author: Hans Petter Selasky <[email protected]> 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 /* Minimum value for MaxDatagramSize, ch. 6.2.9 */ 56 #define CDC_NCM_MIN_DATAGRAM_SIZE 1514 /* bytes */ 57 58 /* Minimum value for MaxDatagramSize, ch. 8.1.3 */ 59 #define CDC_MBIM_MIN_DATAGRAM_SIZE 2048 /* bytes */ 60 61 #define CDC_NCM_MIN_TX_PKT 512 /* bytes */ 62 63 /* Default value for MaxDatagramSize */ 64 #define CDC_NCM_MAX_DATAGRAM_SIZE 8192 /* bytes */ 65 66 /* 67 * Maximum amount of datagrams in NCM Datagram Pointer Table, not counting 68 * the last NULL entry. 69 */ 70 #define CDC_NCM_DPT_DATAGRAMS_MAX 40 71 72 /* Restart the timer, if amount of datagrams is less than given value */ 73 #define CDC_NCM_RESTART_TIMER_DATAGRAM_CNT 3 74 #define CDC_NCM_TIMER_PENDING_CNT 2 75 #define CDC_NCM_TIMER_INTERVAL_USEC 400UL 76 #define CDC_NCM_TIMER_INTERVAL_MIN 5UL 77 #define CDC_NCM_TIMER_INTERVAL_MAX (15UL * USEC_PER_SEC) 78 79 /* The following macro defines the minimum header space */ 80 #define CDC_NCM_MIN_HDR_SIZE \ 81 (sizeof(struct usb_cdc_ncm_nth16) + sizeof(struct usb_cdc_ncm_ndp16) + \ 82 (CDC_NCM_DPT_DATAGRAMS_MAX + 1) * sizeof(struct usb_cdc_ncm_dpe16)) 83 84 #define CDC_NCM_NDP_SIZE \ 85 (sizeof(struct usb_cdc_ncm_ndp16) + \ 86 (CDC_NCM_DPT_DATAGRAMS_MAX + 1) * sizeof(struct usb_cdc_ncm_dpe16)) 87 88 #define cdc_ncm_comm_intf_is_mbim(x) ((x)->desc.bInterfaceSubClass == USB_CDC_SUBCLASS_MBIM && \ 89 (x)->desc.bInterfaceProtocol == USB_CDC_PROTO_NONE) 90 #define cdc_ncm_data_intf_is_mbim(x) ((x)->desc.bInterfaceProtocol == USB_CDC_MBIM_PROTO_NTB) 91 92 struct cdc_ncm_ctx { 93 struct usb_cdc_ncm_ntb_parameters ncm_parm; 94 struct hrtimer tx_timer; 95 struct tasklet_struct bh; 96 97 const struct usb_cdc_ncm_desc *func_desc; 98 const struct usb_cdc_mbim_desc *mbim_desc; 99 const struct usb_cdc_mbim_extended_desc *mbim_extended_desc; 100 const struct usb_cdc_ether_desc *ether_desc; 101 102 struct usb_interface *control; 103 struct usb_interface *data; 104 105 struct sk_buff *tx_curr_skb; 106 struct sk_buff *tx_rem_skb; 107 __le32 tx_rem_sign; 108 109 spinlock_t mtx; 110 atomic_t stop; 111 112 u64 timer_interval; 113 114 u32 tx_timer_pending; 115 u32 tx_curr_frame_num; 116 u32 rx_max; 117 u32 tx_max; 118 u32 max_datagram_size; 119 u16 tx_max_datagrams; 120 u16 tx_remainder; 121 u16 tx_modulus; 122 u16 tx_ndp_modulus; 123 u16 tx_seq; 124 u16 rx_seq; 125 u16 connected; 126 }; 127 128 u8 cdc_ncm_select_altsetting(struct usb_interface *intf); 129 int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting); 130 void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf); 131 struct sk_buff *cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign); 132 int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in); 133 int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset); 134 struct sk_buff * 135 cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags); 136 int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in); 137 138 #endif /* __LINUX_USB_CDC_NCM_H */ 139