xref: /openbmc/linux/include/net/9p/transport.h (revision 6abeae2a)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * include/net/9p/transport.h
4  *
5  * Transport Definition
6  *
7  *  Copyright (C) 2005 by Latchesar Ionkov <lucho@ionkov.net>
8  *  Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
9  */
10 
11 #ifndef NET_9P_TRANSPORT_H
12 #define NET_9P_TRANSPORT_H
13 
14 #define P9_DEF_MIN_RESVPORT	(665U)
15 #define P9_DEF_MAX_RESVPORT	(1023U)
16 
17 /**
18  * struct p9_trans_module - transport module interface
19  * @list: used to maintain a list of currently available transports
20  * @name: the human-readable name of the transport
21  * @maxsize: transport provided maximum packet size
22  * @def: set if this transport should be considered the default
23  * @create: member function to create a new connection on this transport
24  * @close: member function to discard a connection on this transport
25  * @request: member function to issue a request to the transport
26  * @cancel: member function to cancel a request (if it hasn't been sent)
27  * @cancelled: member function to notify that a cancelled request will not
28  *             receive a reply
29  *
30  * This is the basic API for a transport module which is registered by the
31  * transport module with the 9P core network module and used by the client
32  * to instantiate a new connection on a transport.
33  *
34  * The transport module list is protected by v9fs_trans_lock.
35  */
36 
37 struct p9_trans_module {
38 	struct list_head list;
39 	char *name;		/* name of transport */
40 	int maxsize;		/* max message size of transport */
41 	int def;		/* this transport should be default */
42 	struct module *owner;
43 	int (*create)(struct p9_client *, const char *, char *);
44 	void (*close) (struct p9_client *);
45 	int (*request) (struct p9_client *, struct p9_req_t *req);
46 	int (*cancel) (struct p9_client *, struct p9_req_t *req);
47 	int (*cancelled)(struct p9_client *, struct p9_req_t *req);
48 	int (*zc_request)(struct p9_client *, struct p9_req_t *,
49 			  struct iov_iter *, struct iov_iter *, int , int, int);
50 	int (*show_options)(struct seq_file *, struct p9_client *);
51 };
52 
53 void v9fs_register_trans(struct p9_trans_module *m);
54 void v9fs_unregister_trans(struct p9_trans_module *m);
55 struct p9_trans_module *v9fs_get_trans_by_name(char *s);
56 struct p9_trans_module *v9fs_get_default_trans(void);
57 void v9fs_put_trans(struct p9_trans_module *m);
58 #endif /* NET_9P_TRANSPORT_H */
59