rapidio: fix new kernel-doc warnings
[pandora-kernel.git] / include / rdma / ib_addr.h
1 /*
2  * Copyright (c) 2005 Voltaire Inc.  All rights reserved.
3  * Copyright (c) 2005 Intel Corporation.  All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33
34 #if !defined(IB_ADDR_H)
35 #define IB_ADDR_H
36
37 #include <linux/in.h>
38 #include <linux/in6.h>
39 #include <linux/if_arp.h>
40 #include <linux/netdevice.h>
41 #include <linux/socket.h>
42 #include <rdma/ib_verbs.h>
43
44 struct rdma_addr_client {
45         atomic_t refcount;
46         struct completion comp;
47 };
48
49 /**
50  * rdma_addr_register_client - Register an address client.
51  */
52 void rdma_addr_register_client(struct rdma_addr_client *client);
53
54 /**
55  * rdma_addr_unregister_client - Deregister an address client.
56  * @client: Client object to deregister.
57  */
58 void rdma_addr_unregister_client(struct rdma_addr_client *client);
59
60 struct rdma_dev_addr {
61         unsigned char src_dev_addr[MAX_ADDR_LEN];
62         unsigned char dst_dev_addr[MAX_ADDR_LEN];
63         unsigned char broadcast[MAX_ADDR_LEN];
64         unsigned short dev_type;
65         int bound_dev_if;
66 };
67
68 /**
69  * rdma_translate_ip - Translate a local IP address to an RDMA hardware
70  *   address.
71  */
72 int rdma_translate_ip(struct sockaddr *addr, struct rdma_dev_addr *dev_addr);
73
74 /**
75  * rdma_resolve_ip - Resolve source and destination IP addresses to
76  *   RDMA hardware addresses.
77  * @client: Address client associated with request.
78  * @src_addr: An optional source address to use in the resolution.  If a
79  *   source address is not provided, a usable address will be returned via
80  *   the callback.
81  * @dst_addr: The destination address to resolve.
82  * @addr: A reference to a data location that will receive the resolved
83  *   addresses.  The data location must remain valid until the callback has
84  *   been invoked.
85  * @timeout_ms: Amount of time to wait for the address resolution to complete.
86  * @callback: Call invoked once address resolution has completed, timed out,
87  *   or been canceled.  A status of 0 indicates success.
88  * @context: User-specified context associated with the call.
89  */
90 int rdma_resolve_ip(struct rdma_addr_client *client,
91                     struct sockaddr *src_addr, struct sockaddr *dst_addr,
92                     struct rdma_dev_addr *addr, int timeout_ms,
93                     void (*callback)(int status, struct sockaddr *src_addr,
94                                      struct rdma_dev_addr *addr, void *context),
95                     void *context);
96
97 void rdma_addr_cancel(struct rdma_dev_addr *addr);
98
99 int rdma_copy_addr(struct rdma_dev_addr *dev_addr, struct net_device *dev,
100               const unsigned char *dst_dev_addr);
101
102 static inline int ip_addr_size(struct sockaddr *addr)
103 {
104         return addr->sa_family == AF_INET6 ?
105                sizeof(struct sockaddr_in6) : sizeof(struct sockaddr_in);
106 }
107
108 static inline u16 ib_addr_get_pkey(struct rdma_dev_addr *dev_addr)
109 {
110         return ((u16)dev_addr->broadcast[8] << 8) | (u16)dev_addr->broadcast[9];
111 }
112
113 static inline void ib_addr_set_pkey(struct rdma_dev_addr *dev_addr, u16 pkey)
114 {
115         dev_addr->broadcast[8] = pkey >> 8;
116         dev_addr->broadcast[9] = (unsigned char) pkey;
117 }
118
119 static inline void ib_addr_get_mgid(struct rdma_dev_addr *dev_addr,
120                                     union ib_gid *gid)
121 {
122         memcpy(gid, dev_addr->broadcast + 4, sizeof *gid);
123 }
124
125 static inline int rdma_addr_gid_offset(struct rdma_dev_addr *dev_addr)
126 {
127         return dev_addr->dev_type == ARPHRD_INFINIBAND ? 4 : 0;
128 }
129
130 static inline void rdma_addr_get_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
131 {
132         memcpy(gid, dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
133 }
134
135 static inline void rdma_addr_set_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
136 {
137         memcpy(dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
138 }
139
140 static inline void rdma_addr_get_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
141 {
142         memcpy(gid, dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
143 }
144
145 static inline void rdma_addr_set_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
146 {
147         memcpy(dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
148 }
149
150 #endif /* IB_ADDR_H */