1/*
2 * Copyright (c) 2004 Topspin Communications.  All rights reserved.
3 * Copyright (c) 2005 Intel Corporation. All rights reserved.
4 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
5 *
6 * This software is available to you under a choice of one of two
7 * licenses.  You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
11 *
12 *     Redistribution and use in source and binary forms, with or
13 *     without modification, are permitted provided that the following
14 *     conditions are met:
15 *
16 *      - Redistributions of source code must retain the above
17 *        copyright notice, this list of conditions and the following
18 *        disclaimer.
19 *
20 *      - Redistributions in binary form must reproduce the above
21 *        copyright notice, this list of conditions and the following
22 *        disclaimer in the documentation and/or other materials
23 *        provided with the distribution.
24 *
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 * SOFTWARE.
33 *
34 * $Id: ib_cache.h 1349 2004-12-16 21:09:43Z roland $
35 *
36 * $FreeBSD$
37 */
38
39#ifndef _IB_CACHE_H
40#define _IB_CACHE_H
41
42#include <contrib/rdma/ib_verbs.h>
43
44/**
45 * ib_get_cached_gid - Returns a cached GID table entry
46 * @device: The device to query.
47 * @port_num: The port number of the device to query.
48 * @index: The index into the cached GID table to query.
49 * @gid: The GID value found at the specified index.
50 *
51 * ib_get_cached_gid() fetches the specified GID table entry stored in
52 * the local software cache.
53 */
54int ib_get_cached_gid(struct ib_device    *device,
55		      u8                   port_num,
56		      int                  index,
57		      union ib_gid        *gid);
58
59/**
60 * ib_find_cached_gid - Returns the port number and GID table index where
61 *   a specified GID value occurs.
62 * @device: The device to query.
63 * @gid: The GID value to search for.
64 * @port_num: The port number of the device where the GID value was found.
65 * @index: The index into the cached GID table where the GID was found.  This
66 *   parameter may be NULL.
67 *
68 * ib_find_cached_gid() searches for the specified GID value in
69 * the local software cache.
70 */
71int ib_find_cached_gid(struct ib_device *device,
72		       union ib_gid	*gid,
73		       u8               *port_num,
74		       u16              *index);
75
76/**
77 * ib_get_cached_pkey - Returns a cached PKey table entry
78 * @device: The device to query.
79 * @port_num: The port number of the device to query.
80 * @index: The index into the cached PKey table to query.
81 * @pkey: The PKey value found at the specified index.
82 *
83 * ib_get_cached_pkey() fetches the specified PKey table entry stored in
84 * the local software cache.
85 */
86int ib_get_cached_pkey(struct ib_device    *device_handle,
87		       u8                   port_num,
88		       int                  index,
89		       u16                 *pkey);
90
91/**
92 * ib_find_cached_pkey - Returns the PKey table index where a specified
93 *   PKey value occurs.
94 * @device: The device to query.
95 * @port_num: The port number of the device to search for the PKey.
96 * @pkey: The PKey value to search for.
97 * @index: The index into the cached PKey table where the PKey was found.
98 *
99 * ib_find_cached_pkey() searches the specified PKey table in
100 * the local software cache.
101 */
102int ib_find_cached_pkey(struct ib_device    *device,
103			u8                   port_num,
104			u16                  pkey,
105			u16                 *index);
106
107/**
108 * ib_get_cached_lmc - Returns a cached lmc table entry
109 * @device: The device to query.
110 * @port_num: The port number of the device to query.
111 * @lmc: The lmc value for the specified port for that device.
112 *
113 * ib_get_cached_lmc() fetches the specified lmc table entry stored in
114 * the local software cache.
115 */
116int ib_get_cached_lmc(struct ib_device *device,
117		      u8                port_num,
118		      u8                *lmc);
119
120#endif /* _IB_CACHE_H */
121