[net-next-2.6.git] / include / rdma / ib_cache.h

/*
 * Copyright (c) 2004 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005 Intel Corporation. All rights reserved.
 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef _IB_CACHE_H
#define _IB_CACHE_H

#include <rdma/ib_verbs.h>

/**
 * ib_get_cached_gid - Returns a cached GID table entry
 * @device: The device to query.
 * @port_num: The port number of the device to query.
 * @index: The index into the cached GID table to query.
 * @gid: The GID value found at the specified index.
 *
 * ib_get_cached_gid() fetches the specified GID table entry stored in
 * the local software cache.
 */
int ib_get_cached_gid(struct ib_device    *device,
		      u8                   port_num,
		      int                  index,
		      union ib_gid        *gid);

/**
 * ib_find_cached_gid - Returns the port number and GID table index where
 *   a specified GID value occurs.
 * @device: The device to query.
 * @gid: The GID value to search for.
 * @port_num: The port number of the device where the GID value was found.
 * @index: The index into the cached GID table where the GID was found.  This
 *   parameter may be NULL.
 *
 * ib_find_cached_gid() searches for the specified GID value in
 * the local software cache.
 */
int ib_find_cached_gid(struct ib_device *device,
		       union ib_gid	*gid,
		       u8               *port_num,
		       u16              *index);

/**
 * ib_get_cached_pkey - Returns a cached PKey table entry
 * @device: The device to query.
 * @port_num: The port number of the device to query.
 * @index: The index into the cached PKey table to query.
 * @pkey: The PKey value found at the specified index.
 *
 * ib_get_cached_pkey() fetches the specified PKey table entry stored in
 * the local software cache.
 */
int ib_get_cached_pkey(struct ib_device    *device_handle,
		       u8                   port_num,
		       int                  index,
		       u16                 *pkey);

/**
 * ib_find_cached_pkey - Returns the PKey table index where a specified
 *   PKey value occurs.
 * @device: The device to query.
 * @port_num: The port number of the device to search for the PKey.
 * @pkey: The PKey value to search for.
 * @index: The index into the cached PKey table where the PKey was found.
 *
 * ib_find_cached_pkey() searches the specified PKey table in
 * the local software cache.
 */
int ib_find_cached_pkey(struct ib_device    *device,
			u8                   port_num,
			u16                  pkey,
			u16                 *index);

/**
 * ib_get_cached_lmc - Returns a cached lmc table entry
 * @device: The device to query.
 * @port_num: The port number of the device to query.
 * @lmc: The lmc value for the specified port for that device.
 *
 * ib_get_cached_lmc() fetches the specified lmc table entry stored in
 * the local software cache.
 */
int ib_get_cached_lmc(struct ib_device *device,
		      u8                port_num,
		      u8                *lmc);

#endif /* _IB_CACHE_H */
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* Copyright (c) 2004 Topspin Communications. All rights reserved.
2a1d9b7f RD	3	* Copyright (c) 2005 Intel Corporation. All rights reserved.
2a1d9b7f RD	4	* Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
1da177e4 LT	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.
1da177e4 LT	33	*/
	34
	35	#ifndef _IB_CACHE_H
	36	#define _IB_CACHE_H
	37
a4d61e84	38	#include <rdma/ib_verbs.h>
1da177e4 LT	39
	40	/**
	41	* ib_get_cached_gid - Returns a cached GID table entry
	42	* @device: The device to query.
	43	* @port_num: The port number of the device to query.
	44	* @index: The index into the cached GID table to query.
	45	* @gid: The GID value found at the specified index.
	46	*
	47	* ib_get_cached_gid() fetches the specified GID table entry stored in
	48	* the local software cache.
	49	*/
	50	int ib_get_cached_gid(struct ib_device *device,
	51	u8 port_num,
	52	int index,
	53	union ib_gid *gid);
	54
	55	/**
	56	* ib_find_cached_gid - Returns the port number and GID table index where
	57	* a specified GID value occurs.
	58	* @device: The device to query.
	59	* @gid: The GID value to search for.
	60	* @port_num: The port number of the device where the GID value was found.
	61	* @index: The index into the cached GID table where the GID was found. This
	62	* parameter may be NULL.
	63	*
	64	* ib_find_cached_gid() searches for the specified GID value in
	65	* the local software cache.
	66	*/
	67	int ib_find_cached_gid(struct ib_device *device,
	68	union ib_gid *gid,
	69	u8 *port_num,
	70	u16 *index);
	71
	72	/**
	73	* ib_get_cached_pkey - Returns a cached PKey table entry
	74	* @device: The device to query.
	75	* @port_num: The port number of the device to query.
	76	* @index: The index into the cached PKey table to query.
	77	* @pkey: The PKey value found at the specified index.
	78	*
	79	* ib_get_cached_pkey() fetches the specified PKey table entry stored in
	80	* the local software cache.
	81	*/
	82	int ib_get_cached_pkey(struct ib_device *device_handle,
	83	u8 port_num,
	84	int index,
	85	u16 *pkey);
	86
	87	/**
	88	* ib_find_cached_pkey - Returns the PKey table index where a specified
	89	* PKey value occurs.
	90	* @device: The device to query.
	91	* @port_num: The port number of the device to search for the PKey.
	92	* @pkey: The PKey value to search for.
	93	* @index: The index into the cached PKey table where the PKey was found.
	94	*
	95	* ib_find_cached_pkey() searches the specified PKey table in
	96	* the local software cache.
	97	*/
	98	int ib_find_cached_pkey(struct ib_device *device,
	99	u8 port_num,
	100	u16 pkey,
	101	u16 *index);
	102
6fb9cdbf JM	103	/**
	104	* ib_get_cached_lmc - Returns a cached lmc table entry
	105	* @device: The device to query.
	106	* @port_num: The port number of the device to query.
	107	* @lmc: The lmc value for the specified port for that device.
	108	*
	109	* ib_get_cached_lmc() fetches the specified lmc table entry stored in
	110	* the local software cache.
	111	*/
	112	int ib_get_cached_lmc(struct ib_device *device,
	113	u8 port_num,
	114	u8 *lmc);
	115
1da177e4	116	#endif /* _IB_CACHE_H */