83531ebeee99084746d9679dce3c29e47471e38c
[linux-2.6.git] / include / net / 9p / transport.h
1 /*
2  * include/net/9p/transport.h
3  *
4  * Transport Definition
5  *
6  *  Copyright (C) 2005 by Latchesar Ionkov <lucho@ionkov.net>
7  *  Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License version 2
11  *  as published by the Free Software Foundation.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to:
20  *  Free Software Foundation
21  *  51 Franklin Street, Fifth Floor
22  *  Boston, MA  02111-1301  USA
23  *
24  */
25
26 #ifndef NET_9P_TRANSPORT_H
27 #define NET_9P_TRANSPORT_H
28
29 #define P9_TRANS_PREF_PAYLOAD_MASK 0x1
30
31 /* Default. Add Payload to PDU before sending it down to transport layer */
32 #define P9_TRANS_PREF_PAYLOAD_DEF  0x0
33 /* Send pay load separately to transport layer along with PDU.*/
34 #define P9_TRANS_PREF_PAYLOAD_SEP  0x1
35
36 /**
37  * struct p9_trans_module - transport module interface
38  * @list: used to maintain a list of currently available transports
39  * @name: the human-readable name of the transport
40  * @maxsize: transport provided maximum packet size
41  * @pref: Preferences of this transport
42  * @def: set if this transport should be considered the default
43  * @create: member function to create a new connection on this transport
44  * @close: member function to discard a connection on this transport
45  * @request: member function to issue a request to the transport
46  * @cancel: member function to cancel a request (if it hasn't been sent)
47  *
48  * This is the basic API for a transport module which is registered by the
49  * transport module with the 9P core network module and used by the client
50  * to instantiate a new connection on a transport.
51  *
52  * The transport module list is protected by v9fs_trans_lock.
53  */
54
55 struct p9_trans_module {
56         struct list_head list;
57         char *name;             /* name of transport */
58         int maxsize;            /* max message size of transport */
59         int pref;               /* Preferences of this transport */
60         int def;                /* this transport should be default */
61         struct module *owner;
62         int (*create)(struct p9_client *, const char *, char *);
63         void (*close) (struct p9_client *);
64         int (*request) (struct p9_client *, struct p9_req_t *req);
65         int (*cancel) (struct p9_client *, struct p9_req_t *req);
66 };
67
68 void v9fs_register_trans(struct p9_trans_module *m);
69 void v9fs_unregister_trans(struct p9_trans_module *m);
70 struct p9_trans_module *v9fs_get_trans_by_name(char *s);
71 struct p9_trans_module *v9fs_get_default_trans(void);
72 void v9fs_put_trans(struct p9_trans_module *m);
73 #endif /* NET_9P_TRANSPORT_H */