[linux.git] / include / linux / usb / cdc_ncm.h

/*
 * Copyright (C) ST-Ericsson 2010-2012
 * Contact: Alexey Orishko <[email protected]>
 * Original author: Hans Petter Selasky <[email protected]>
 *
 * USB Host Driver for Network Control Model (NCM)
 * http://www.usb.org/developers/devclass_docs/NCM10.zip
 *
 * The NCM encoding, decoding and initialization logic
 * derives from FreeBSD 8.x. if_cdce.c and if_cdcereg.h
 *
 * This software is available to you under a choice of one of two
 * licenses. You may choose this file to be licensed under the terms
 * of the GNU General Public License (GPL) Version 2 or the 2-clause
 * BSD license listed below:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef __LINUX_USB_CDC_NCM_H
#define __LINUX_USB_CDC_NCM_H

#define CDC_NCM_COMM_ALTSETTING_NCM		0
#define CDC_NCM_COMM_ALTSETTING_MBIM		1

#define CDC_NCM_DATA_ALTSETTING_NCM		1
#define CDC_NCM_DATA_ALTSETTING_MBIM		2

/* CDC NCM subclass 3.2.1 */
#define USB_CDC_NCM_NDP16_LENGTH_MIN		0x10

/* Maximum NTB length */
#define	CDC_NCM_NTB_MAX_SIZE_TX			32768	/* bytes */
#define	CDC_NCM_NTB_MAX_SIZE_RX			32768	/* bytes */

/* Initial NTB length */
#define	CDC_NCM_NTB_DEF_SIZE_TX			16384	/* bytes */
#define	CDC_NCM_NTB_DEF_SIZE_RX			16384	/* bytes */

/* Minimum value for MaxDatagramSize, ch. 6.2.9 */
#define	CDC_NCM_MIN_DATAGRAM_SIZE		1514	/* bytes */

/* Minimum value for MaxDatagramSize, ch. 8.1.3 */
#define CDC_MBIM_MIN_DATAGRAM_SIZE		2048	/* bytes */

#define	CDC_NCM_MIN_TX_PKT			512	/* bytes */

/* Default value for MaxDatagramSize */
#define	CDC_NCM_MAX_DATAGRAM_SIZE		8192	/* bytes */

/*
 * Maximum amount of datagrams in NCM Datagram Pointer Table, not counting
 * the last NULL entry.
 */
#define	CDC_NCM_DPT_DATAGRAMS_MAX		40

/* Restart the timer, if amount of datagrams is less than given value */
#define	CDC_NCM_RESTART_TIMER_DATAGRAM_CNT	3
#define	CDC_NCM_TIMER_PENDING_CNT		2
#define CDC_NCM_TIMER_INTERVAL_USEC		400UL
#define CDC_NCM_TIMER_INTERVAL_MIN		5UL
#define CDC_NCM_TIMER_INTERVAL_MAX		(U32_MAX / NSEC_PER_USEC)

#define cdc_ncm_comm_intf_is_mbim(x)  ((x)->desc.bInterfaceSubClass == USB_CDC_SUBCLASS_MBIM && \
				       (x)->desc.bInterfaceProtocol == USB_CDC_PROTO_NONE)
#define cdc_ncm_data_intf_is_mbim(x)  ((x)->desc.bInterfaceProtocol == USB_CDC_MBIM_PROTO_NTB)

struct cdc_ncm_ctx {
	struct usb_cdc_ncm_ntb_parameters ncm_parm;
	struct hrtimer tx_timer;
	struct tasklet_struct bh;

	const struct usb_cdc_ncm_desc *func_desc;
	const struct usb_cdc_mbim_desc *mbim_desc;
	const struct usb_cdc_mbim_extended_desc *mbim_extended_desc;
	const struct usb_cdc_ether_desc *ether_desc;

	struct usb_interface *control;
	struct usb_interface *data;

	struct sk_buff *tx_curr_skb;
	struct sk_buff *tx_rem_skb;
	__le32 tx_rem_sign;

	spinlock_t mtx;
	atomic_t stop;

	u32 timer_interval;
	u32 max_ndp_size;

	u32 tx_timer_pending;
	u32 tx_curr_frame_num;
	u32 rx_max;
	u32 tx_max;
	u32 max_datagram_size;
	u16 tx_max_datagrams;
	u16 tx_remainder;
	u16 tx_modulus;
	u16 tx_ndp_modulus;
	u16 tx_seq;
	u16 rx_seq;
	u16 min_tx_pkt;

	/* statistics */
	u32 tx_curr_frame_payload;
	u32 tx_reason_ntb_full;
	u32 tx_reason_ndp_full;
	u32 tx_reason_timeout;
	u32 tx_reason_max_datagram;
	u64 tx_overhead;
	u64 tx_ntbs;
	u64 rx_overhead;
	u64 rx_ntbs;
};

u8 cdc_ncm_select_altsetting(struct usb_interface *intf);
int cdc_ncm_bind_common(struct usbnet *dev, struct usb_interface *intf, u8 data_altsetting);
void cdc_ncm_unbind(struct usbnet *dev, struct usb_interface *intf);
struct sk_buff *cdc_ncm_fill_tx_frame(struct usbnet *dev, struct sk_buff *skb, __le32 sign);
int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx *ctx, struct sk_buff *skb_in);
int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset);
struct sk_buff *
cdc_ncm_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags);
int cdc_ncm_rx_fixup(struct usbnet *dev, struct sk_buff *skb_in);

#endif /* __LINUX_USB_CDC_NCM_H */
Commit	Line	Data
c91ce3b6 BM	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
f6701d5f BM	39	#ifndef __LINUX_USB_CDC_NCM_H
	40	#define __LINUX_USB_CDC_NCM_H
	41
9bf211a3 GS	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
c91ce3b6 BM	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
50f1cb1c BM	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
c91ce3b6 BM	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
6c4e548f BM	79	#define CDC_NCM_TIMER_INTERVAL_USEC 400UL
6c4e548f BM	80	#define CDC_NCM_TIMER_INTERVAL_MIN 5UL
7d10d261	81	#define CDC_NCM_TIMER_INTERVAL_MAX (U32_MAX / NSEC_PER_USEC)
c91ce3b6	82
9bf211a3 GS	83	#define cdc_ncm_comm_intf_is_mbim(x) ((x)->desc.bInterfaceSubClass == USB_CDC_SUBCLASS_MBIM && \
	84	(x)->desc.bInterfaceProtocol == USB_CDC_PROTO_NONE)
	85	#define cdc_ncm_data_intf_is_mbim(x) ((x)->desc.bInterfaceProtocol == USB_CDC_MBIM_PROTO_NTB)
	86
c91ce3b6	87	struct cdc_ncm_ctx {
ff0992e9	88	struct usb_cdc_ncm_ntb_parameters ncm_parm;
c91ce3b6 BM	89	struct hrtimer tx_timer;
	90	struct tasklet_struct bh;
	91
	92	const struct usb_cdc_ncm_desc *func_desc;
83292236	93	const struct usb_cdc_mbim_desc *mbim_desc;
259fef03	94	const struct usb_cdc_mbim_extended_desc *mbim_extended_desc;
c91ce3b6 BM	95	const struct usb_cdc_ether_desc *ether_desc;
c91ce3b6 BM	96
c91ce3b6 BM	97	struct usb_interface *control;
	98	struct usb_interface *data;
	99
	100	struct sk_buff *tx_curr_skb;
	101	struct sk_buff *tx_rem_skb;
	102	__le32 tx_rem_sign;
	103
	104	spinlock_t mtx;
	105	atomic_t stop;
	106
7d10d261	107	u32 timer_interval;
70559b89	108	u32 max_ndp_size;
6c4e548f	109
c91ce3b6 BM	110	u32 tx_timer_pending;
c91ce3b6 BM	111	u32 tx_curr_frame_num;
c91ce3b6 BM	112	u32 rx_max;
	113	u32 tx_max;
	114	u32 max_datagram_size;
	115	u16 tx_max_datagrams;
	116	u16 tx_remainder;
	117	u16 tx_modulus;
	118	u16 tx_ndp_modulus;
	119	u16 tx_seq;
	120	u16 rx_seq;
43e4c6df	121	u16 min_tx_pkt;
beeecd42 BM	122
	123	/* statistics */
	124	u32 tx_curr_frame_payload;
	125	u32 tx_reason_ntb_full;
	126	u32 tx_reason_ndp_full;
	127	u32 tx_reason_timeout;
	128	u32 tx_reason_max_datagram;
	129	u64 tx_overhead;
	130	u64 tx_ntbs;
	131	u64 rx_overhead;
	132	u64 rx_ntbs;
c91ce3b6 BM	133	};
c91ce3b6 BM	134
50a0ffaf	135	u8 cdc_ncm_select_altsetting(struct usb_interface *intf);
6dd13e83 BM	136	int cdc_ncm_bind_common(struct usbnet dev, struct usb_interface intf, u8 data_altsetting);
	137	void cdc_ncm_unbind(struct usbnet dev, struct usb_interface intf);
	138	struct sk_buff cdc_ncm_fill_tx_frame(struct usbnet dev, struct sk_buff *skb, __le32 sign);
	139	int cdc_ncm_rx_verify_nth16(struct cdc_ncm_ctx ctx, struct sk_buff skb_in);
	140	int cdc_ncm_rx_verify_ndp16(struct sk_buff *skb_in, int ndpoffset);
2f69702c EM	141	struct sk_buff *
	142	cdc_ncm_tx_fixup(struct usbnet dev, struct sk_buff skb, gfp_t flags);
	143	int cdc_ncm_rx_fixup(struct usbnet dev, struct sk_buff skb_in);
f6701d5f BM	144
f6701d5f BM	145	#endif /* __LINUX_USB_CDC_NCM_H */