Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / c91ce3b6bff780453283a5882ecd54f267f4682f / . / include / linux / usb / cdc_ncm.h
blob: d1719a72f7d2fa7707e5e25cee1e30cc0bc637e2 [file] [log] [blame]
Bjørn Morkc91ce3b2012-10-22 10:56:35 +0000[diff] [blame^]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/* CDC NCM subclass 3.2.1 */
40#define USB_CDC_NCM_NDP16_LENGTH_MIN 0x10
41
42/* Maximum NTB length */
43#define CDC_NCM_NTB_MAX_SIZE_TX 32768 /* bytes */
44#define CDC_NCM_NTB_MAX_SIZE_RX 32768 /* bytes */
45
46/* Minimum value for MaxDatagramSize, ch. 6.2.9 */
47#define CDC_NCM_MIN_DATAGRAM_SIZE 1514 /* bytes */
48
49/* Minimum value for MaxDatagramSize, ch. 8.1.3 */
50#define CDC_MBIM_MIN_DATAGRAM_SIZE 2048 /* bytes */
51
52#define CDC_NCM_MIN_TX_PKT 512 /* bytes */
53
54/* Default value for MaxDatagramSize */
55#define CDC_NCM_MAX_DATAGRAM_SIZE 8192 /* bytes */
56
57/*
58 * Maximum amount of datagrams in NCM Datagram Pointer Table, not counting
59 * the last NULL entry.
60 */
61#define CDC_NCM_DPT_DATAGRAMS_MAX 40
62
63/* Restart the timer, if amount of datagrams is less than given value */
64#define CDC_NCM_RESTART_TIMER_DATAGRAM_CNT 3
65#define CDC_NCM_TIMER_PENDING_CNT 2
66#define CDC_NCM_TIMER_INTERVAL (400UL * NSEC_PER_USEC)
67
68/* The following macro defines the minimum header space */
69#define CDC_NCM_MIN_HDR_SIZE \
70 (sizeof(struct usb_cdc_ncm_nth16) + sizeof(struct usb_cdc_ncm_ndp16) + \
71 (CDC_NCM_DPT_DATAGRAMS_MAX + 1) * sizeof(struct usb_cdc_ncm_dpe16))
72
73#define CDC_NCM_NDP_SIZE \
74 (sizeof(struct usb_cdc_ncm_ndp16) + \
75 (CDC_NCM_DPT_DATAGRAMS_MAX + 1) * sizeof(struct usb_cdc_ncm_dpe16))
76
77struct cdc_ncm_ctx {
78 struct usb_cdc_ncm_ntb_parameters ncm_parm;
79 struct hrtimer tx_timer;
80 struct tasklet_struct bh;
81
82 const struct usb_cdc_ncm_desc *func_desc;
83 const struct usb_cdc_mbim_desc *mbim_desc;
84 const struct usb_cdc_header_desc *header_desc;
85 const struct usb_cdc_union_desc *union_desc;
86 const struct usb_cdc_ether_desc *ether_desc;
87
88 struct net_device *netdev;
89 struct usb_device *udev;
90 struct usb_host_endpoint *in_ep;
91 struct usb_host_endpoint *out_ep;
92 struct usb_host_endpoint *status_ep;
93 struct usb_interface *intf;
94 struct usb_interface *control;
95 struct usb_interface *data;
96
97 struct sk_buff *tx_curr_skb;
98 struct sk_buff *tx_rem_skb;
99 __le32 tx_rem_sign;
100
101 spinlock_t mtx;
102 atomic_t stop;
103
104 u32 tx_timer_pending;
105 u32 tx_curr_frame_num;
106 u32 rx_speed;
107 u32 tx_speed;
108 u32 rx_max;
109 u32 tx_max;
110 u32 max_datagram_size;
111 u16 tx_max_datagrams;
112 u16 tx_remainder;
113 u16 tx_modulus;
114 u16 tx_ndp_modulus;
115 u16 tx_seq;
116 u16 rx_seq;
117 u16 connected;
118};
119
120extern int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting);
121extern void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf);
122extern struct sk_buff *cdc_ncm_fill_tx_frame(struct cdc_ncm_ctx *ctx, struct sk_buff *skb, __le32 sign);
123extern int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in);
124extern int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset);