[linux-2.6-block.git] / tools / usb / usbip / src / usbip_network.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2005-2007 Takahiro Hirofuchi
 */

#ifndef __USBIP_NETWORK_H
#define __USBIP_NETWORK_H

#ifdef HAVE_CONFIG_H
#include "../config.h"
#endif

#include <sys/types.h>

#include <stdint.h>

extern int usbip_port;
extern char *usbip_port_string;
void usbip_setup_port_number(char *arg);

/* ---------------------------------------------------------------------- */
/* Common header for all the kinds of PDUs. */
struct op_common {
	uint16_t version;

#define OP_REQUEST	(0x80 << 8)
#define OP_REPLY	(0x00 << 8)
	uint16_t code;

	/* status codes defined in usbip_common.h */
	uint32_t status; /* op_code status (for reply) */

} __attribute__((packed));

#define PACK_OP_COMMON(pack, op_common)  do {\
	usbip_net_pack_uint16_t(pack, &(op_common)->version);\
	usbip_net_pack_uint16_t(pack, &(op_common)->code);\
	usbip_net_pack_uint32_t(pack, &(op_common)->status);\
} while (0)

/* ---------------------------------------------------------------------- */
/* Dummy Code */
#define OP_UNSPEC	0x00
#define OP_REQ_UNSPEC	OP_UNSPEC
#define OP_REP_UNSPEC	OP_UNSPEC

/* ---------------------------------------------------------------------- */
/* Retrieve USB device information. (still not used) */
#define OP_DEVINFO	0x02
#define OP_REQ_DEVINFO	(OP_REQUEST | OP_DEVINFO)
#define OP_REP_DEVINFO	(OP_REPLY   | OP_DEVINFO)

struct op_devinfo_request {
	char busid[SYSFS_BUS_ID_SIZE];
} __attribute__((packed));

struct op_devinfo_reply {
	struct usbip_usb_device udev;
	struct usbip_usb_interface uinf[];
} __attribute__((packed));

/* ---------------------------------------------------------------------- */
/* Import a remote USB device. */
#define OP_IMPORT	0x03
#define OP_REQ_IMPORT	(OP_REQUEST | OP_IMPORT)
#define OP_REP_IMPORT   (OP_REPLY   | OP_IMPORT)

struct op_import_request {
	char busid[SYSFS_BUS_ID_SIZE];
} __attribute__((packed));

struct op_import_reply {
	struct usbip_usb_device udev;
//	struct usbip_usb_interface uinf[];
} __attribute__((packed));

#define PACK_OP_IMPORT_REQUEST(pack, request)  do {\
} while (0)

#define PACK_OP_IMPORT_REPLY(pack, reply)  do {\
	usbip_net_pack_usb_device(pack, &(reply)->udev);\
} while (0)

/* ---------------------------------------------------------------------- */
/* Export a USB device to a remote host. */
#define OP_EXPORT	0x06
#define OP_REQ_EXPORT	(OP_REQUEST | OP_EXPORT)
#define OP_REP_EXPORT	(OP_REPLY   | OP_EXPORT)

struct op_export_request {
	struct usbip_usb_device udev;
} __attribute__((packed));

struct op_export_reply {
	int returncode;
} __attribute__((packed));


#define PACK_OP_EXPORT_REQUEST(pack, request)  do {\
	usbip_net_pack_usb_device(pack, &(request)->udev);\
} while (0)

#define PACK_OP_EXPORT_REPLY(pack, reply)  do {\
} while (0)

/* ---------------------------------------------------------------------- */
/* un-Export a USB device from a remote host. */
#define OP_UNEXPORT	0x07
#define OP_REQ_UNEXPORT	(OP_REQUEST | OP_UNEXPORT)
#define OP_REP_UNEXPORT	(OP_REPLY   | OP_UNEXPORT)

struct op_unexport_request {
	struct usbip_usb_device udev;
} __attribute__((packed));

struct op_unexport_reply {
	int returncode;
} __attribute__((packed));

#define PACK_OP_UNEXPORT_REQUEST(pack, request)  do {\
	usbip_net_pack_usb_device(pack, &(request)->udev);\
} while (0)

#define PACK_OP_UNEXPORT_REPLY(pack, reply)  do {\
} while (0)

/* ---------------------------------------------------------------------- */
/* Negotiate IPSec encryption key. (still not used) */
#define OP_CRYPKEY	0x04
#define OP_REQ_CRYPKEY	(OP_REQUEST | OP_CRYPKEY)
#define OP_REP_CRYPKEY	(OP_REPLY   | OP_CRYPKEY)

struct op_crypkey_request {
	/* 128bit key */
	uint32_t key[4];
} __attribute__((packed));

struct op_crypkey_reply {
	uint32_t __reserved;
} __attribute__((packed));


/* ---------------------------------------------------------------------- */
/* Retrieve the list of exported USB devices. */
#define OP_DEVLIST	0x05
#define OP_REQ_DEVLIST	(OP_REQUEST | OP_DEVLIST)
#define OP_REP_DEVLIST	(OP_REPLY   | OP_DEVLIST)

struct op_devlist_request {
} __attribute__((packed));

struct op_devlist_reply {
	uint32_t ndev;
	/* followed by reply_extra[] */
} __attribute__((packed));

struct op_devlist_reply_extra {
	struct usbip_usb_device    udev;
	struct usbip_usb_interface uinf[];
} __attribute__((packed));

#define PACK_OP_DEVLIST_REQUEST(pack, request)  do {\
} while (0)

#define PACK_OP_DEVLIST_REPLY(pack, reply)  do {\
	usbip_net_pack_uint32_t(pack, &(reply)->ndev);\
} while (0)

void usbip_net_pack_uint32_t(int pack, uint32_t *num);
void usbip_net_pack_uint16_t(int pack, uint16_t *num);
void usbip_net_pack_usb_device(int pack, struct usbip_usb_device *udev);
void usbip_net_pack_usb_interface(int pack, struct usbip_usb_interface *uinf);

ssize_t usbip_net_recv(int sockfd, void *buff, size_t bufflen);
ssize_t usbip_net_send(int sockfd, void *buff, size_t bufflen);
int usbip_net_send_op_common(int sockfd, uint32_t code, uint32_t status);
int usbip_net_recv_op_common(int sockfd, uint16_t *code, int *status);
int usbip_net_set_reuseaddr(int sockfd);
int usbip_net_set_nodelay(int sockfd);
int usbip_net_set_keepalive(int sockfd);
int usbip_net_set_v6only(int sockfd);
int usbip_net_tcp_connect(char *hostname, char *port);

#endif /* __USBIP_NETWORK_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
0945b4fe TH	2	/*
	3	* Copyright (C) 2005-2007 Takahiro Hirofuchi
	4	*/
	5
1e35d87d	6	#ifndef __USBIP_NETWORK_H
1e35d87d	7	#define __USBIP_NETWORK_H
0945b4fe	8
1e35d87d	9	#ifdef HAVE_CONFIG_H
	10	#include "../config.h"
	11	#endif
0945b4fe	12
1e35d87d	13	#include <sys/types.h>
0945b4fe	14
1e35d87d	15	#include <stdint.h>
0945b4fe	16
7182f8f8 AF	17	extern int usbip_port;
	18	extern char *usbip_port_string;
	19	void usbip_setup_port_number(char *arg);
0945b4fe TH	20
	21	/* ---------------------------------------------------------------------- */
	22	/* Common header for all the kinds of PDUs. */
	23	struct op_common {
	24	uint16_t version;
	25
	26	#define OP_REQUEST (0x80 << 8)
	27	#define OP_REPLY (0x00 << 8)
	28	uint16_t code;
	29
f6bcbf2e	30	/* status codes defined in usbip_common.h */
0945b4fe TH	31	uint32_t status; /* op_code status (for reply) */
	32
	33	} __attribute__((packed));
	34
	35	#define PACK_OP_COMMON(pack, op_common) do {\
3c6e9e8f	36	usbip_net_pack_uint16_t(pack, &(op_common)->version);\
5037307d SR	37	usbip_net_pack_uint16_t(pack, &(op_common)->code);\
5037307d SR	38	usbip_net_pack_uint32_t(pack, &(op_common)->status);\
0945b4fe TH	39	} while (0)
0945b4fe TH	40
0945b4fe TH	41	/* ---------------------------------------------------------------------- */
	42	/* Dummy Code */
	43	#define OP_UNSPEC 0x00
	44	#define OP_REQ_UNSPEC OP_UNSPEC
	45	#define OP_REP_UNSPEC OP_UNSPEC
	46
	47	/* ---------------------------------------------------------------------- */
	48	/* Retrieve USB device information. (still not used) */
	49	#define OP_DEVINFO 0x02
	50	#define OP_REQ_DEVINFO (OP_REQUEST \| OP_DEVINFO)
	51	#define OP_REP_DEVINFO (OP_REPLY \| OP_DEVINFO)
	52
	53	struct op_devinfo_request {
	54	char busid[SYSFS_BUS_ID_SIZE];
	55	} __attribute__((packed));
	56
	57	struct op_devinfo_reply {
35dd0c2d	58	struct usbip_usb_device udev;
35dd0c2d	59	struct usbip_usb_interface uinf[];
0945b4fe TH	60	} __attribute__((packed));
0945b4fe TH	61
0945b4fe TH	62	/* ---------------------------------------------------------------------- */
	63	/* Import a remote USB device. */
	64	#define OP_IMPORT 0x03
	65	#define OP_REQ_IMPORT (OP_REQUEST \| OP_IMPORT)
	66	#define OP_REP_IMPORT (OP_REPLY \| OP_IMPORT)
	67
	68	struct op_import_request {
	69	char busid[SYSFS_BUS_ID_SIZE];
	70	} __attribute__((packed));
	71
	72	struct op_import_reply {
35dd0c2d	73	struct usbip_usb_device udev;
35dd0c2d	74	// struct usbip_usb_interface uinf[];
0945b4fe TH	75	} __attribute__((packed));
	76
	77	#define PACK_OP_IMPORT_REQUEST(pack, request) do {\
	78	} while (0)
	79
	80	#define PACK_OP_IMPORT_REPLY(pack, reply) do {\
3c6e9e8f	81	usbip_net_pack_usb_device(pack, &(reply)->udev);\
0945b4fe TH	82	} while (0)
0945b4fe TH	83
0945b4fe TH	84	/* ---------------------------------------------------------------------- */
	85	/* Export a USB device to a remote host. */
	86	#define OP_EXPORT 0x06
	87	#define OP_REQ_EXPORT (OP_REQUEST \| OP_EXPORT)
	88	#define OP_REP_EXPORT (OP_REPLY \| OP_EXPORT)
	89
	90	struct op_export_request {
35dd0c2d	91	struct usbip_usb_device udev;
0945b4fe TH	92	} __attribute__((packed));
	93
	94	struct op_export_reply {
9abec452	95	int returncode;
0945b4fe TH	96	} __attribute__((packed));
	97
	98
	99	#define PACK_OP_EXPORT_REQUEST(pack, request) do {\
3c6e9e8f	100	usbip_net_pack_usb_device(pack, &(request)->udev);\
0945b4fe TH	101	} while (0)
	102
	103	#define PACK_OP_EXPORT_REPLY(pack, reply) do {\
	104	} while (0)
	105
	106	/* ---------------------------------------------------------------------- */
	107	/* un-Export a USB device from a remote host. */
	108	#define OP_UNEXPORT 0x07
	109	#define OP_REQ_UNEXPORT (OP_REQUEST \| OP_UNEXPORT)
	110	#define OP_REP_UNEXPORT (OP_REPLY \| OP_UNEXPORT)
	111
	112	struct op_unexport_request {
35dd0c2d	113	struct usbip_usb_device udev;
0945b4fe TH	114	} __attribute__((packed));
	115
	116	struct op_unexport_reply {
9abec452	117	int returncode;
0945b4fe TH	118	} __attribute__((packed));
	119
	120	#define PACK_OP_UNEXPORT_REQUEST(pack, request) do {\
3c6e9e8f	121	usbip_net_pack_usb_device(pack, &(request)->udev);\
0945b4fe TH	122	} while (0)
	123
	124	#define PACK_OP_UNEXPORT_REPLY(pack, reply) do {\
	125	} while (0)
	126
0945b4fe TH	127	/* ---------------------------------------------------------------------- */
	128	/* Negotiate IPSec encryption key. (still not used) */
	129	#define OP_CRYPKEY 0x04
	130	#define OP_REQ_CRYPKEY (OP_REQUEST \| OP_CRYPKEY)
	131	#define OP_REP_CRYPKEY (OP_REPLY \| OP_CRYPKEY)
	132
	133	struct op_crypkey_request {
	134	/* 128bit key */
	135	uint32_t key[4];
	136	} __attribute__((packed));
	137
	138	struct op_crypkey_reply {
	139	uint32_t __reserved;
	140	} __attribute__((packed));
	141
	142
	143	/* ---------------------------------------------------------------------- */
	144	/* Retrieve the list of exported USB devices. */
	145	#define OP_DEVLIST 0x05
	146	#define OP_REQ_DEVLIST (OP_REQUEST \| OP_DEVLIST)
	147	#define OP_REP_DEVLIST (OP_REPLY \| OP_DEVLIST)
	148
	149	struct op_devlist_request {
	150	} __attribute__((packed));
	151
	152	struct op_devlist_reply {
	153	uint32_t ndev;
	154	/* followed by reply_extra[] */
	155	} __attribute__((packed));
	156
	157	struct op_devlist_reply_extra {
35dd0c2d	158	struct usbip_usb_device udev;
35dd0c2d	159	struct usbip_usb_interface uinf[];
0945b4fe TH	160	} __attribute__((packed));
	161
	162	#define PACK_OP_DEVLIST_REQUEST(pack, request) do {\
	163	} while (0)
	164
	165	#define PACK_OP_DEVLIST_REPLY(pack, reply) do {\
3c6e9e8f	166	usbip_net_pack_uint32_t(pack, &(reply)->ndev);\
0945b4fe TH	167	} while (0)
0945b4fe TH	168
3c6e9e8f	169	void usbip_net_pack_uint32_t(int pack, uint32_t *num);
	170	void usbip_net_pack_uint16_t(int pack, uint16_t *num);
	171	void usbip_net_pack_usb_device(int pack, struct usbip_usb_device *udev);
	172	void usbip_net_pack_usb_interface(int pack, struct usbip_usb_interface *uinf);
	173
	174	ssize_t usbip_net_recv(int sockfd, void *buff, size_t bufflen);
	175	ssize_t usbip_net_send(int sockfd, void *buff, size_t bufflen);
	176	int usbip_net_send_op_common(int sockfd, uint32_t code, uint32_t status);
ad81b15d	177	int usbip_net_recv_op_common(int sockfd, uint16_t code, int status);
3c6e9e8f	178	int usbip_net_set_reuseaddr(int sockfd);
	179	int usbip_net_set_nodelay(int sockfd);
	180	int usbip_net_set_keepalive(int sockfd);
f49ad35c	181	int usbip_net_set_v6only(int sockfd);
1e35d87d	182	int usbip_net_tcp_connect(char hostname, char port);
0945b4fe	183
1e35d87d	184	#endif /* __USBIP_NETWORK_H */