blob: adcbb20f65118be16489b65f2e087d3bf3128980 [file] [log] [blame]
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -05001/*
2 * include/net/9p/transport.h
3 *
4 * Transport Definition
5 *
6 * Copyright (C) 2005 by Latchesar Ionkov <lucho@ionkov.net>
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -06007 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -05008 *
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
Eric Van Hensbergenee443992008-03-05 07:08:09 -060029/**
30 * struct p9_trans_module - transport module interface
31 * @list: used to maintain a list of currently available transports
32 * @name: the human-readable name of the transport
33 * @maxsize: transport provided maximum packet size
Venkateswararao Jujjuri (JV)6f69c392011-02-06 12:08:01 -080034 * @pref: Preferences of this transport
Eric Van Hensbergenee443992008-03-05 07:08:09 -060035 * @def: set if this transport should be considered the default
36 * @create: member function to create a new connection on this transport
Rob Landleyaca00762011-05-08 18:46:38 +000037 * @close: member function to discard a connection on this transport
Eric Van Hensbergen91b85342008-10-13 18:45:21 -050038 * @request: member function to issue a request to the transport
39 * @cancel: member function to cancel a request (if it hasn't been sent)
Eric Van Hensbergenee443992008-03-05 07:08:09 -060040 *
41 * This is the basic API for a transport module which is registered by the
42 * transport module with the 9P core network module and used by the client
43 * to instantiate a new connection on a transport.
44 *
Rob Landleyaca00762011-05-08 18:46:38 +000045 * The transport module list is protected by v9fs_trans_lock.
Eric Van Hensbergenee443992008-03-05 07:08:09 -060046 */
47
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050048struct p9_trans_module {
49 struct list_head list;
50 char *name; /* name of transport */
51 int maxsize; /* max message size of transport */
52 int def; /* this transport should be default */
Tejun Heo72029fe2008-09-24 16:22:23 -050053 struct module *owner;
Eric Van Hensbergen8b81ef52008-10-13 18:45:25 -050054 int (*create)(struct p9_client *, const char *, char *);
55 void (*close) (struct p9_client *);
Eric Van Hensbergen91b85342008-10-13 18:45:21 -050056 int (*request) (struct p9_client *, struct p9_req_t *req);
57 int (*cancel) (struct p9_client *, struct p9_req_t *req);
Aneesh Kumar K.Vabfa0342011-08-16 10:50:10 +053058 int (*zc_request)(struct p9_client *, struct p9_req_t *,
59 char *, char *, int , int, int, int);
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050060};
61
62void v9fs_register_trans(struct p9_trans_module *m);
Tejun Heo72029fe2008-09-24 16:22:23 -050063void v9fs_unregister_trans(struct p9_trans_module *m);
Prem Karat4d630552011-05-06 18:35:32 +053064struct p9_trans_module *v9fs_get_trans_by_name(char *s);
Tejun Heo72029fe2008-09-24 16:22:23 -050065struct p9_trans_module *v9fs_get_default_trans(void);
66void v9fs_put_trans(struct p9_trans_module *m);
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -050067#endif /* NET_9P_TRANSPORT_H */