2 * include/net/tipc/tipc_port.h: Include file for privileged access to TIPC ports
4 * Copyright (c) 2003-2005, Ericsson Research Canada
5 * Copyright (c) 2005, Wind River Systems
6 * Copyright (c) 2005-2006, Ericsson AB
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 * list of conditions and the following disclaimer.
14 * Redistributions in binary form must reproduce the above copyright notice,
15 * this list of conditions and the following disclaimer in the documentation
16 * and/or other materials provided with the distribution.
17 * Neither the names of the copyright holders nor the names of its
18 * contributors may be used to endorse or promote products derived from this
19 * software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _NET_TIPC_PORT_H_
35 #define _NET_TIPC_PORT_H_
39 #include <linux/tipc.h>
40 #include <linux/skbuff.h>
41 #include <net/tipc/tipc_msg.h>
43 #define TIPC_FLOW_CONTROL_WIN 512
46 * struct tipc_port - native TIPC port info available to privileged users
47 * @usr_handle: pointer to additional user-defined information about port
48 * @lock: pointer to spinlock for controlling access to port
49 * @connected: non-zero if port is currently connected to a peer port
50 * @conn_type: TIPC type used when connection was established
51 * @conn_instance: TIPC instance used when connection was established
52 * @conn_unacked: number of unacknowledged messages received from peer port
53 * @published: non-zero if port has one or more associated names
54 * @congested: non-zero if cannot send because of link or port congestion
55 * @ref: unique reference to port in TIPC object registry
56 * @phdr: preformatted message header used when sending messages
74 * tipc_createport_raw - create a native TIPC port and return it's reference
76 * Note: 'dispatcher' and 'wakeup' deliver a locked port.
79 u32 tipc_createport_raw(void *usr_handle,
80 u32 (*dispatcher)(struct tipc_port *, struct sk_buff *),
81 void (*wakeup)(struct tipc_port *),
82 const u32 importance);
85 * tipc_set_msg_option(): port must be locked.
87 int tipc_set_msg_option(struct tipc_port *tp_ptr,
91 int tipc_reject_msg(struct sk_buff *buf, u32 err);
93 int tipc_send_buf_fast(struct sk_buff *buf, u32 destnode);
95 void tipc_acknowledge(u32 port_ref,u32 ack);
97 struct tipc_port *tipc_get_port(const u32 ref);
99 void *tipc_get_handle(const u32 ref);