[linux.git] / drivers / usb / gadget / rndis.h

/*
 * RNDIS	Definitions for Remote NDIS
 *
 * Authors:	Benedikt Spranger, Pengutronix
 *		Robert Schwebel, Pengutronix
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		version 2, as published by the Free Software Foundation.
 *
 *		This software was originally developed in conformance with
 *		Microsoft's Remote NDIS Specification License Agreement.
 */

#ifndef _LINUX_RNDIS_H
#define _LINUX_RNDIS_H

#include "ndis.h"

#define RNDIS_MAXIMUM_FRAME_SIZE	1518
#define RNDIS_MAX_TOTAL_SIZE		1558

/* Remote NDIS Versions */
#define RNDIS_MAJOR_VERSION		1
#define RNDIS_MINOR_VERSION		0

/* Status Values */
#define RNDIS_STATUS_SUCCESS		0x00000000U	/* Success           */
#define RNDIS_STATUS_FAILURE		0xC0000001U	/* Unspecified error */
#define RNDIS_STATUS_INVALID_DATA	0xC0010015U	/* Invalid data      */
#define RNDIS_STATUS_NOT_SUPPORTED	0xC00000BBU	/* Unsupported request */
#define RNDIS_STATUS_MEDIA_CONNECT	0x4001000BU	/* Device connected  */
#define RNDIS_STATUS_MEDIA_DISCONNECT	0x4001000CU	/* Device disconnected */
/* For all not specified status messages:
 * RNDIS_STATUS_Xxx -> NDIS_STATUS_Xxx
 */

/* Message Set for Connectionless (802.3) Devices */
#define REMOTE_NDIS_PACKET_MSG		0x00000001U
#define REMOTE_NDIS_INITIALIZE_MSG	0x00000002U	/* Initialize device */
#define REMOTE_NDIS_HALT_MSG		0x00000003U
#define REMOTE_NDIS_QUERY_MSG		0x00000004U
#define REMOTE_NDIS_SET_MSG		0x00000005U
#define REMOTE_NDIS_RESET_MSG		0x00000006U
#define REMOTE_NDIS_INDICATE_STATUS_MSG	0x00000007U
#define REMOTE_NDIS_KEEPALIVE_MSG	0x00000008U

/* Message completion */
#define REMOTE_NDIS_INITIALIZE_CMPLT	0x80000002U
#define REMOTE_NDIS_QUERY_CMPLT		0x80000004U
#define REMOTE_NDIS_SET_CMPLT		0x80000005U
#define REMOTE_NDIS_RESET_CMPLT		0x80000006U
#define REMOTE_NDIS_KEEPALIVE_CMPLT	0x80000008U

/* Device Flags */
#define RNDIS_DF_CONNECTIONLESS		0x00000001U
#define RNDIS_DF_CONNECTION_ORIENTED	0x00000002U

#define RNDIS_MEDIUM_802_3		0x00000000U

/* from drivers/net/sk98lin/h/skgepnmi.h */
#define OID_PNP_CAPABILITIES			0xFD010100
#define OID_PNP_SET_POWER			0xFD010101
#define OID_PNP_QUERY_POWER			0xFD010102
#define OID_PNP_ADD_WAKE_UP_PATTERN		0xFD010103
#define OID_PNP_REMOVE_WAKE_UP_PATTERN		0xFD010104
#define OID_PNP_ENABLE_WAKE_UP			0xFD010106


typedef struct rndis_init_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
	__le32	MajorVersion;
	__le32	MinorVersion;
	__le32	MaxTransferSize;
} rndis_init_msg_type;

typedef struct rndis_init_cmplt_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
	__le32	Status;
	__le32	MajorVersion;
	__le32	MinorVersion;
	__le32	DeviceFlags;
	__le32	Medium;
	__le32	MaxPacketsPerTransfer;
	__le32	MaxTransferSize;
	__le32	PacketAlignmentFactor;
	__le32	AFListOffset;
	__le32	AFListSize;
} rndis_init_cmplt_type;

typedef struct rndis_halt_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
} rndis_halt_msg_type;

typedef struct rndis_query_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
	__le32	OID;
	__le32	InformationBufferLength;
	__le32	InformationBufferOffset;
	__le32	DeviceVcHandle;
} rndis_query_msg_type;

typedef struct rndis_query_cmplt_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
	__le32	Status;
	__le32	InformationBufferLength;
	__le32	InformationBufferOffset;
} rndis_query_cmplt_type;

typedef struct rndis_set_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
	__le32	OID;
	__le32	InformationBufferLength;
	__le32	InformationBufferOffset;
	__le32	DeviceVcHandle;
} rndis_set_msg_type;

typedef struct rndis_set_cmplt_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
	__le32	Status;
} rndis_set_cmplt_type;

typedef struct rndis_reset_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	Reserved;
} rndis_reset_msg_type;

typedef struct rndis_reset_cmplt_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	Status;
	__le32	AddressingReset;
} rndis_reset_cmplt_type;

typedef struct rndis_indicate_status_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	Status;
	__le32	StatusBufferLength;
	__le32	StatusBufferOffset;
} rndis_indicate_status_msg_type;

typedef struct rndis_keepalive_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
} rndis_keepalive_msg_type;

typedef struct rndis_keepalive_cmplt_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	RequestID;
	__le32	Status;
} rndis_keepalive_cmplt_type;

struct rndis_packet_msg_type
{
	__le32	MessageType;
	__le32	MessageLength;
	__le32	DataOffset;
	__le32	DataLength;
	__le32	OOBDataOffset;
	__le32	OOBDataLength;
	__le32	NumOOBDataElements;
	__le32	PerPacketInfoOffset;
	__le32	PerPacketInfoLength;
	__le32	VcHandle;
	__le32	Reserved;
} __attribute__ ((packed));

struct rndis_config_parameter
{
	__le32	ParameterNameOffset;
	__le32	ParameterNameLength;
	__le32	ParameterType;
	__le32	ParameterValueOffset;
	__le32	ParameterValueLength;
};

/* implementation specific */
enum rndis_state
{
	RNDIS_UNINITIALIZED,
	RNDIS_INITIALIZED,
	RNDIS_DATA_INITIALIZED,
};

typedef struct rndis_resp_t
{
	struct list_head	list;
	u8			*buf;
	u32			length;
	int			send;
} rndis_resp_t;

typedef struct rndis_params
{
	u8			confignr;
	u8			used;
	u16			saved_filter;
	enum rndis_state	state;
	u32			medium;
	u32			speed;
	u32			media_state;

	const u8		*host_mac;
	u16			*filter;
	struct net_device	*dev;

	u32			vendorID;
	const char		*vendorDescr;
	void			(*resp_avail)(void *v);
	void			*v;
	struct list_head	resp_queue;
} rndis_params;

/* RNDIS Message parser and other useless functions */
int  rndis_msg_parser (u8 configNr, u8 *buf);
int  rndis_register(void (*resp_avail)(void *v), void *v);
void rndis_deregister (int configNr);
int  rndis_set_param_dev (u8 configNr, struct net_device *dev,
			 u16 *cdc_filter);
int  rndis_set_param_vendor (u8 configNr, u32 vendorID,
			    const char *vendorDescr);
int  rndis_set_param_medium (u8 configNr, u32 medium, u32 speed);
void rndis_add_hdr (struct sk_buff *skb);
int rndis_rm_hdr(struct gether *port, struct sk_buff *skb,
			struct sk_buff_head *list);
u8   *rndis_get_next_response (int configNr, u32 *length);
void rndis_free_response (int configNr, u8 *buf);

void rndis_uninit (int configNr);
int  rndis_signal_connect (int configNr);
int  rndis_signal_disconnect (int configNr);
int  rndis_state (int configNr);
extern void rndis_set_host_mac (int configNr, const u8 *addr);

int rndis_init(void);
void rndis_exit (void);

#endif  /* _LINUX_RNDIS_H */
Commit	Line	Data
7e27f18c	1	/*
1da177e4	2	* RNDIS Definitions for Remote NDIS
7e27f18c	3	*
1da177e4	4	* Authors: Benedikt Spranger, Pengutronix
7e27f18c DB	5	* Robert Schwebel, Pengutronix
	6	*
	7	* This program is free software; you can redistribute it and/or
1da177e4	8	* modify it under the terms of the GNU General Public License
7e27f18c DB	9	* version 2, as published by the Free Software Foundation.
7e27f18c DB	10	*
1da177e4 LT	11	* This software was originally developed in conformance with
	12	* Microsoft's Remote NDIS Specification License Agreement.
	13	*/
	14
	15	#ifndef _LINUX_RNDIS_H
	16	#define _LINUX_RNDIS_H
	17
	18	#include "ndis.h"
	19
	20	#define RNDIS_MAXIMUM_FRAME_SIZE 1518
	21	#define RNDIS_MAX_TOTAL_SIZE 1558
	22
	23	/* Remote NDIS Versions */
	24	#define RNDIS_MAJOR_VERSION 1
	25	#define RNDIS_MINOR_VERSION 0
	26
	27	/* Status Values */
	28	#define RNDIS_STATUS_SUCCESS 0x00000000U /* Success */
	29	#define RNDIS_STATUS_FAILURE 0xC0000001U /* Unspecified error */
	30	#define RNDIS_STATUS_INVALID_DATA 0xC0010015U /* Invalid data */
	31	#define RNDIS_STATUS_NOT_SUPPORTED 0xC00000BBU /* Unsupported request */
	32	#define RNDIS_STATUS_MEDIA_CONNECT 0x4001000BU /* Device connected */
	33	#define RNDIS_STATUS_MEDIA_DISCONNECT 0x4001000CU /* Device disconnected */
	34	/* For all not specified status messages:
7e27f18c	35	* RNDIS_STATUS_Xxx -> NDIS_STATUS_Xxx
1da177e4 LT	36	*/
	37
	38	/* Message Set for Connectionless (802.3) Devices */
6cdee106	39	#define REMOTE_NDIS_PACKET_MSG 0x00000001U
1da177e4 LT	40	#define REMOTE_NDIS_INITIALIZE_MSG 0x00000002U /* Initialize device */
	41	#define REMOTE_NDIS_HALT_MSG 0x00000003U
	42	#define REMOTE_NDIS_QUERY_MSG 0x00000004U
	43	#define REMOTE_NDIS_SET_MSG 0x00000005U
	44	#define REMOTE_NDIS_RESET_MSG 0x00000006U
	45	#define REMOTE_NDIS_INDICATE_STATUS_MSG 0x00000007U
	46	#define REMOTE_NDIS_KEEPALIVE_MSG 0x00000008U
	47
	48	/* Message completion */
	49	#define REMOTE_NDIS_INITIALIZE_CMPLT 0x80000002U
	50	#define REMOTE_NDIS_QUERY_CMPLT 0x80000004U
	51	#define REMOTE_NDIS_SET_CMPLT 0x80000005U
	52	#define REMOTE_NDIS_RESET_CMPLT 0x80000006U
	53	#define REMOTE_NDIS_KEEPALIVE_CMPLT 0x80000008U
	54
	55	/* Device Flags */
	56	#define RNDIS_DF_CONNECTIONLESS 0x00000001U
	57	#define RNDIS_DF_CONNECTION_ORIENTED 0x00000002U
	58
	59	#define RNDIS_MEDIUM_802_3 0x00000000U
	60
	61	/* from drivers/net/sk98lin/h/skgepnmi.h */
	62	#define OID_PNP_CAPABILITIES 0xFD010100
	63	#define OID_PNP_SET_POWER 0xFD010101
	64	#define OID_PNP_QUERY_POWER 0xFD010102
	65	#define OID_PNP_ADD_WAKE_UP_PATTERN 0xFD010103
	66	#define OID_PNP_REMOVE_WAKE_UP_PATTERN 0xFD010104
	67	#define OID_PNP_ENABLE_WAKE_UP 0xFD010106
	68
	69
7e27f18c	70	typedef struct rndis_init_msg_type
1da177e4 LT	71	{
	72	__le32 MessageType;
	73	__le32 MessageLength;
	74	__le32 RequestID;
	75	__le32 MajorVersion;
	76	__le32 MinorVersion;
	77	__le32 MaxTransferSize;
	78	} rndis_init_msg_type;
	79
	80	typedef struct rndis_init_cmplt_type
	81	{
	82	__le32 MessageType;
	83	__le32 MessageLength;
	84	__le32 RequestID;
	85	__le32 Status;
	86	__le32 MajorVersion;
	87	__le32 MinorVersion;
	88	__le32 DeviceFlags;
	89	__le32 Medium;
	90	__le32 MaxPacketsPerTransfer;
	91	__le32 MaxTransferSize;
	92	__le32 PacketAlignmentFactor;
	93	__le32 AFListOffset;
	94	__le32 AFListSize;
	95	} rndis_init_cmplt_type;
	96
	97	typedef struct rndis_halt_msg_type
	98	{
	99	__le32 MessageType;
	100	__le32 MessageLength;
	101	__le32 RequestID;
	102	} rndis_halt_msg_type;
	103
	104	typedef struct rndis_query_msg_type
	105	{
	106	__le32 MessageType;
	107	__le32 MessageLength;
	108	__le32 RequestID;
	109	__le32 OID;
	110	__le32 InformationBufferLength;
	111	__le32 InformationBufferOffset;
	112	__le32 DeviceVcHandle;
	113	} rndis_query_msg_type;
	114
	115	typedef struct rndis_query_cmplt_type
	116	{
	117	__le32 MessageType;
	118	__le32 MessageLength;
	119	__le32 RequestID;
	120	__le32 Status;
	121	__le32 InformationBufferLength;
	122	__le32 InformationBufferOffset;
	123	} rndis_query_cmplt_type;
	124
	125	typedef struct rndis_set_msg_type
	126	{
	127	__le32 MessageType;
	128	__le32 MessageLength;
	129	__le32 RequestID;
	130	__le32 OID;
	131	__le32 InformationBufferLength;
	132	__le32 InformationBufferOffset;
	133	__le32 DeviceVcHandle;
	134	} rndis_set_msg_type;
135
136	typedef struct rndis_set_cmplt_type
137	{
138	__le32 MessageType;
139	__le32 MessageLength;
140	__le32 RequestID;
141	__le32 Status;
142	} rndis_set_cmplt_type;
143
144	typedef struct rndis_reset_msg_type
145	{
146	__le32 MessageType;
147	__le32 MessageLength;
148	__le32 Reserved;
149	} rndis_reset_msg_type;
150
151	typedef struct rndis_reset_cmplt_type
152	{
153	__le32 MessageType;
154	__le32 MessageLength;
155	__le32 Status;
156	__le32 AddressingReset;
157	} rndis_reset_cmplt_type;
158
159	typedef struct rndis_indicate_status_msg_type
160	{
161	__le32 MessageType;
162	__le32 MessageLength;
163	__le32 Status;
164	__le32 StatusBufferLength;
165	__le32 StatusBufferOffset;
166	} rndis_indicate_status_msg_type;
167
168	typedef struct rndis_keepalive_msg_type
169	{
170	__le32 MessageType;
171	__le32 MessageLength;
172	__le32 RequestID;
173	} rndis_keepalive_msg_type;
174
175	typedef struct rndis_keepalive_cmplt_type
176	{
177	__le32 MessageType;
178	__le32 MessageLength;
179	__le32 RequestID;
180	__le32 Status;
181	} rndis_keepalive_cmplt_type;
182
183	struct rndis_packet_msg_type
184	{
185	__le32 MessageType;
186	__le32 MessageLength;
187	__le32 DataOffset;
188	__le32 DataLength;
189	__le32 OOBDataOffset;
190	__le32 OOBDataLength;
191	__le32 NumOOBDataElements;
192	__le32 PerPacketInfoOffset;
193	__le32 PerPacketInfoLength;
194	__le32 VcHandle;
195	__le32 Reserved;
178398dc	196	} __attribute__ ((packed));
1da177e4 LT	197
	198	struct rndis_config_parameter
	199	{
	200	__le32 ParameterNameOffset;
	201	__le32 ParameterNameLength;
	202	__le32 ParameterType;
	203	__le32 ParameterValueOffset;
	204	__le32 ParameterValueLength;
	205	};
	206
	207	/* implementation specific */
	208	enum rndis_state
	209	{
	210	RNDIS_UNINITIALIZED,
	211	RNDIS_INITIALIZED,
	212	RNDIS_DATA_INITIALIZED,
	213	};
	214
	215	typedef struct rndis_resp_t
	216	{
	217	struct list_head list;
	218	u8 *buf;
	219	u32 length;
	220	int send;
	221	} rndis_resp_t;
	222
	223	typedef struct rndis_params
	224	{
	225	u8 confignr;
340600ab DB	226	u8 used;
340600ab DB	227	u16 saved_filter;
1da177e4	228	enum rndis_state state;
1da177e4 LT	229	u32 medium;
	230	u32 speed;
	231	u32 media_state;
340600ab	232
1da177e4	233	const u8 *host_mac;
340600ab	234	u16 *filter;
7e27f18c	235	struct net_device *dev;
340600ab	236
1da177e4 LT	237	u32 vendorID;
1da177e4 LT	238	const char *vendorDescr;
15b2d2b5 DB	239	void (resp_avail)(void v);
15b2d2b5 DB	240	void *v;
1da177e4 LT	241	struct list_head resp_queue;
	242	} rndis_params;
	243
	244	/* RNDIS Message parser and other useless functions */
	245	int rndis_msg_parser (u8 configNr, u8 *buf);
15b2d2b5	246	int rndis_register(void (resp_avail)(void v), void *v);
1da177e4 LT	247	void rndis_deregister (int configNr);
1da177e4 LT	248	int rndis_set_param_dev (u8 configNr, struct net_device *dev,
340600ab	249	u16 *cdc_filter);
7e27f18c	250	int rndis_set_param_vendor (u8 configNr, u32 vendorID,
1da177e4 LT	251	const char *vendorDescr);
	252	int rndis_set_param_medium (u8 configNr, u32 medium, u32 speed);
	253	void rndis_add_hdr (struct sk_buff *skb);
9b39e9dd BN	254	int rndis_rm_hdr(struct gether port, struct sk_buff skb,
9b39e9dd BN	255	struct sk_buff_head *list);
1da177e4 LT	256	u8 rndis_get_next_response (int configNr, u32 length);
	257	void rndis_free_response (int configNr, u8 *buf);
	258
340600ab	259	void rndis_uninit (int configNr);
1da177e4 LT	260	int rndis_signal_connect (int configNr);
	261	int rndis_signal_disconnect (int configNr);
	262	int rndis_state (int configNr);
	263	extern void rndis_set_host_mac (int configNr, const u8 *addr);
	264
793f03aa	265	int rndis_init(void);
1da177e4 LT	266	void rndis_exit (void);
	267
	268	#endif /* _LINUX_RNDIS_H */