[linux.git] / include / rdma / ib_sa.h

/*
 * Copyright (c) 2004 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005 Voltaire, Inc.  All rights reserved.
 * Copyright (c) 2006 Intel Corporation.  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.
 *
 * $Id: ib_sa.h 2811 2005-07-06 18:11:43Z halr $
 */

#ifndef IB_SA_H
#define IB_SA_H

#include <linux/completion.h>
#include <linux/compiler.h>

#include <asm/atomic.h>

#include <rdma/ib_verbs.h>
#include <rdma/ib_mad.h>

enum {
	IB_SA_CLASS_VERSION		= 2,	/* IB spec version 1.1/1.2 */

	IB_SA_METHOD_GET_TABLE		= 0x12,
	IB_SA_METHOD_GET_TABLE_RESP	= 0x92,
	IB_SA_METHOD_DELETE		= 0x15,
	IB_SA_METHOD_DELETE_RESP	= 0x95,
	IB_SA_METHOD_GET_MULTI		= 0x14,
	IB_SA_METHOD_GET_MULTI_RESP	= 0x94,
	IB_SA_METHOD_GET_TRACE_TBL	= 0x13
};

enum {
	IB_SA_ATTR_CLASS_PORTINFO    = 0x01,
	IB_SA_ATTR_NOTICE	     = 0x02,
	IB_SA_ATTR_INFORM_INFO	     = 0x03,
	IB_SA_ATTR_NODE_REC	     = 0x11,
	IB_SA_ATTR_PORT_INFO_REC     = 0x12,
	IB_SA_ATTR_SL2VL_REC	     = 0x13,
	IB_SA_ATTR_SWITCH_REC	     = 0x14,
	IB_SA_ATTR_LINEAR_FDB_REC    = 0x15,
	IB_SA_ATTR_RANDOM_FDB_REC    = 0x16,
	IB_SA_ATTR_MCAST_FDB_REC     = 0x17,
	IB_SA_ATTR_SM_INFO_REC	     = 0x18,
	IB_SA_ATTR_LINK_REC	     = 0x20,
	IB_SA_ATTR_GUID_INFO_REC     = 0x30,
	IB_SA_ATTR_SERVICE_REC	     = 0x31,
	IB_SA_ATTR_PARTITION_REC     = 0x33,
	IB_SA_ATTR_PATH_REC	     = 0x35,
	IB_SA_ATTR_VL_ARB_REC	     = 0x36,
	IB_SA_ATTR_MC_MEMBER_REC     = 0x38,
	IB_SA_ATTR_TRACE_REC	     = 0x39,
	IB_SA_ATTR_MULTI_PATH_REC    = 0x3a,
	IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b,
	IB_SA_ATTR_INFORM_INFO_REC   = 0xf3
};

enum ib_sa_selector {
	IB_SA_GT   = 0,
	IB_SA_LT   = 1,
	IB_SA_EQ   = 2,
	/*
	 * The meaning of "best" depends on the attribute: for
	 * example, for MTU best will return the largest available
	 * MTU, while for packet life time, best will return the
	 * smallest available life time.
	 */
	IB_SA_BEST = 3
};

/*
 * Structures for SA records are named "struct ib_sa_xxx_rec."  No
 * attempt is made to pack structures to match the physical layout of
 * SA records in SA MADs; all packing and unpacking is handled by the
 * SA query code.
 *
 * For a record with structure ib_sa_xxx_rec, the naming convention
 * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
 * never use different abbreviations or otherwise change the spelling
 * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
 *
 * Reserved rows are indicated with comments to help maintainability.
 */

/* reserved:								 0 */
/* reserved:								 1 */
#define IB_SA_PATH_REC_DGID				IB_SA_COMP_MASK( 2)
#define IB_SA_PATH_REC_SGID				IB_SA_COMP_MASK( 3)
#define IB_SA_PATH_REC_DLID				IB_SA_COMP_MASK( 4)
#define IB_SA_PATH_REC_SLID				IB_SA_COMP_MASK( 5)
#define IB_SA_PATH_REC_RAW_TRAFFIC			IB_SA_COMP_MASK( 6)
/* reserved:								 7 */
#define IB_SA_PATH_REC_FLOW_LABEL       		IB_SA_COMP_MASK( 8)
#define IB_SA_PATH_REC_HOP_LIMIT			IB_SA_COMP_MASK( 9)
#define IB_SA_PATH_REC_TRAFFIC_CLASS			IB_SA_COMP_MASK(10)
#define IB_SA_PATH_REC_REVERSIBLE			IB_SA_COMP_MASK(11)
#define IB_SA_PATH_REC_NUMB_PATH			IB_SA_COMP_MASK(12)
#define IB_SA_PATH_REC_PKEY				IB_SA_COMP_MASK(13)
/* reserved:								14 */
#define IB_SA_PATH_REC_SL				IB_SA_COMP_MASK(15)
#define IB_SA_PATH_REC_MTU_SELECTOR			IB_SA_COMP_MASK(16)
#define IB_SA_PATH_REC_MTU				IB_SA_COMP_MASK(17)
#define IB_SA_PATH_REC_RATE_SELECTOR			IB_SA_COMP_MASK(18)
#define IB_SA_PATH_REC_RATE				IB_SA_COMP_MASK(19)
#define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR	IB_SA_COMP_MASK(20)
#define IB_SA_PATH_REC_PACKET_LIFE_TIME			IB_SA_COMP_MASK(21)
#define IB_SA_PATH_REC_PREFERENCE			IB_SA_COMP_MASK(22)

struct ib_sa_path_rec {
	/* reserved */
	/* reserved */
	union ib_gid dgid;
	union ib_gid sgid;
	__be16       dlid;
	__be16       slid;
	int          raw_traffic;
	/* reserved */
	__be32       flow_label;
	u8           hop_limit;
	u8           traffic_class;
	int          reversible;
	u8           numb_path;
	__be16       pkey;
	/* reserved */
	u8           sl;
	u8           mtu_selector;
	u8           mtu;
	u8           rate_selector;
	u8           rate;
	u8           packet_life_time_selector;
	u8           packet_life_time;
	u8           preference;
};

#define IB_SA_MCMEMBER_REC_MGID				IB_SA_COMP_MASK( 0)
#define IB_SA_MCMEMBER_REC_PORT_GID			IB_SA_COMP_MASK( 1)
#define IB_SA_MCMEMBER_REC_QKEY				IB_SA_COMP_MASK( 2)
#define IB_SA_MCMEMBER_REC_MLID				IB_SA_COMP_MASK( 3)
#define IB_SA_MCMEMBER_REC_MTU_SELECTOR			IB_SA_COMP_MASK( 4)
#define IB_SA_MCMEMBER_REC_MTU				IB_SA_COMP_MASK( 5)
#define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS		IB_SA_COMP_MASK( 6)
#define IB_SA_MCMEMBER_REC_PKEY				IB_SA_COMP_MASK( 7)
#define IB_SA_MCMEMBER_REC_RATE_SELECTOR		IB_SA_COMP_MASK( 8)
#define IB_SA_MCMEMBER_REC_RATE				IB_SA_COMP_MASK( 9)
#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR	IB_SA_COMP_MASK(10)
#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME		IB_SA_COMP_MASK(11)
#define IB_SA_MCMEMBER_REC_SL				IB_SA_COMP_MASK(12)
#define IB_SA_MCMEMBER_REC_FLOW_LABEL			IB_SA_COMP_MASK(13)
#define IB_SA_MCMEMBER_REC_HOP_LIMIT			IB_SA_COMP_MASK(14)
#define IB_SA_MCMEMBER_REC_SCOPE			IB_SA_COMP_MASK(15)
#define IB_SA_MCMEMBER_REC_JOIN_STATE			IB_SA_COMP_MASK(16)
#define IB_SA_MCMEMBER_REC_PROXY_JOIN			IB_SA_COMP_MASK(17)

struct ib_sa_mcmember_rec {
	union ib_gid mgid;
	union ib_gid port_gid;
	__be32       qkey;
	__be16       mlid;
	u8           mtu_selector;
	u8           mtu;
	u8           traffic_class;
	__be16       pkey;
	u8 	     rate_selector;
	u8 	     rate;
	u8 	     packet_life_time_selector;
	u8 	     packet_life_time;
	u8           sl;
	__be32       flow_label;
	u8           hop_limit;
	u8           scope;
	u8           join_state;
	int          proxy_join;
};

/* Service Record Component Mask Sec 15.2.5.14 Ver 1.1	*/
#define IB_SA_SERVICE_REC_SERVICE_ID			IB_SA_COMP_MASK( 0)
#define IB_SA_SERVICE_REC_SERVICE_GID			IB_SA_COMP_MASK( 1)
#define IB_SA_SERVICE_REC_SERVICE_PKEY			IB_SA_COMP_MASK( 2)
/* reserved:								 3 */
#define IB_SA_SERVICE_REC_SERVICE_LEASE			IB_SA_COMP_MASK( 4)
#define IB_SA_SERVICE_REC_SERVICE_KEY			IB_SA_COMP_MASK( 5)
#define IB_SA_SERVICE_REC_SERVICE_NAME			IB_SA_COMP_MASK( 6)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_0		IB_SA_COMP_MASK( 7)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_1		IB_SA_COMP_MASK( 8)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_2		IB_SA_COMP_MASK( 9)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_3		IB_SA_COMP_MASK(10)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_4		IB_SA_COMP_MASK(11)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_5		IB_SA_COMP_MASK(12)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_6		IB_SA_COMP_MASK(13)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_7		IB_SA_COMP_MASK(14)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_8		IB_SA_COMP_MASK(15)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_9		IB_SA_COMP_MASK(16)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_10		IB_SA_COMP_MASK(17)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_11		IB_SA_COMP_MASK(18)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_12		IB_SA_COMP_MASK(19)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_13		IB_SA_COMP_MASK(20)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_14		IB_SA_COMP_MASK(21)
#define IB_SA_SERVICE_REC_SERVICE_DATA8_15		IB_SA_COMP_MASK(22)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_0		IB_SA_COMP_MASK(23)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_1		IB_SA_COMP_MASK(24)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_2		IB_SA_COMP_MASK(25)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_3		IB_SA_COMP_MASK(26)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_4		IB_SA_COMP_MASK(27)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_5		IB_SA_COMP_MASK(28)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_6		IB_SA_COMP_MASK(29)
#define IB_SA_SERVICE_REC_SERVICE_DATA16_7		IB_SA_COMP_MASK(30)
#define IB_SA_SERVICE_REC_SERVICE_DATA32_0		IB_SA_COMP_MASK(31)
#define IB_SA_SERVICE_REC_SERVICE_DATA32_1		IB_SA_COMP_MASK(32)
#define IB_SA_SERVICE_REC_SERVICE_DATA32_2		IB_SA_COMP_MASK(33)
#define IB_SA_SERVICE_REC_SERVICE_DATA32_3		IB_SA_COMP_MASK(34)
#define IB_SA_SERVICE_REC_SERVICE_DATA64_0		IB_SA_COMP_MASK(35)
#define IB_SA_SERVICE_REC_SERVICE_DATA64_1		IB_SA_COMP_MASK(36)

#define IB_DEFAULT_SERVICE_LEASE 	0xFFFFFFFF

struct ib_sa_service_rec {
	u64		id;
	union ib_gid	gid;
	__be16 		pkey;
	/* reserved */
	u32		lease;
	u8		key[16];
	u8		name[64];
	u8		data8[16];
	u16		data16[8];
	u32		data32[4];
	u64		data64[2];
};

struct ib_sa_client {
	atomic_t users;
	struct completion comp;
};

/**
 * ib_sa_register_client - Register an SA client.
 */
void ib_sa_register_client(struct ib_sa_client *client);

/**
 * ib_sa_unregister_client - Deregister an SA client.
 * @client: Client object to deregister.
 */
void ib_sa_unregister_client(struct ib_sa_client *client);

struct ib_sa_query;

void ib_sa_cancel_query(int id, struct ib_sa_query *query);

int ib_sa_path_rec_get(struct ib_sa_client *client,
		       struct ib_device *device, u8 port_num,
		       struct ib_sa_path_rec *rec,
		       ib_sa_comp_mask comp_mask,
		       int timeout_ms, gfp_t gfp_mask,
		       void (*callback)(int status,
					struct ib_sa_path_rec *resp,
					void *context),
		       void *context,
		       struct ib_sa_query **query);

int ib_sa_mcmember_rec_query(struct ib_sa_client *client,
			     struct ib_device *device, u8 port_num,
			     u8 method,
			     struct ib_sa_mcmember_rec *rec,
			     ib_sa_comp_mask comp_mask,
			     int timeout_ms, gfp_t gfp_mask,
			     void (*callback)(int status,
					      struct ib_sa_mcmember_rec *resp,
					      void *context),
			     void *context,
			     struct ib_sa_query **query);

int ib_sa_service_rec_query(struct ib_sa_client *client,
			 struct ib_device *device, u8 port_num,
			 u8 method,
			 struct ib_sa_service_rec *rec,
			 ib_sa_comp_mask comp_mask,
			 int timeout_ms, gfp_t gfp_mask,
			 void (*callback)(int status,
					  struct ib_sa_service_rec *resp,
					  void *context),
			 void *context,
			 struct ib_sa_query **sa_query);

/**
 * ib_sa_mcmember_rec_set - Start an MCMember set query
 * @client:SA client
 * @device:device to send query on
 * @port_num: port number to send query on
 * @rec:MCMember Record to send in query
 * @comp_mask:component mask to send in query
 * @timeout_ms:time to wait for response
 * @gfp_mask:GFP mask to use for internal allocations
 * @callback:function called when query completes, times out or is
 * canceled
 * @context:opaque user context passed to callback
 * @sa_query:query context, used to cancel query
 *
 * Send an MCMember Set query to the SA (eg to join a multicast
 * group).  The callback function will be called when the query
 * completes (or fails); status is 0 for a successful response, -EINTR
 * if the query is canceled, -ETIMEDOUT is the query timed out, or
 * -EIO if an error occurred sending the query.  The resp parameter of
 * the callback is only valid if status is 0.
 *
 * If the return value of ib_sa_mcmember_rec_set() is negative, it is
 * an error code.  Otherwise it is a query ID that can be used to
 * cancel the query.
 */
static inline int
ib_sa_mcmember_rec_set(struct ib_sa_client *client,
		       struct ib_device *device, u8 port_num,
		       struct ib_sa_mcmember_rec *rec,
		       ib_sa_comp_mask comp_mask,
		       int timeout_ms, gfp_t gfp_mask,
		       void (*callback)(int status,
					struct ib_sa_mcmember_rec *resp,
					void *context),
		       void *context,
		       struct ib_sa_query **query)
{
	return ib_sa_mcmember_rec_query(client, device, port_num,
					IB_MGMT_METHOD_SET,
					rec, comp_mask,
					timeout_ms, gfp_mask, callback,
					context, query);
}

/**
 * ib_sa_mcmember_rec_delete - Start an MCMember delete query
 * @client:SA client
 * @device:device to send query on
 * @port_num: port number to send query on
 * @rec:MCMember Record to send in query
 * @comp_mask:component mask to send in query
 * @timeout_ms:time to wait for response
 * @gfp_mask:GFP mask to use for internal allocations
 * @callback:function called when query completes, times out or is
 * canceled
 * @context:opaque user context passed to callback
 * @sa_query:query context, used to cancel query
 *
 * Send an MCMember Delete query to the SA (eg to leave a multicast
 * group).  The callback function will be called when the query
 * completes (or fails); status is 0 for a successful response, -EINTR
 * if the query is canceled, -ETIMEDOUT is the query timed out, or
 * -EIO if an error occurred sending the query.  The resp parameter of
 * the callback is only valid if status is 0.
 *
 * If the return value of ib_sa_mcmember_rec_delete() is negative, it
 * is an error code.  Otherwise it is a query ID that can be used to
 * cancel the query.
 */
static inline int
ib_sa_mcmember_rec_delete(struct ib_sa_client *client,
			  struct ib_device *device, u8 port_num,
			  struct ib_sa_mcmember_rec *rec,
			  ib_sa_comp_mask comp_mask,
			  int timeout_ms, gfp_t gfp_mask,
			  void (*callback)(int status,
					   struct ib_sa_mcmember_rec *resp,
					   void *context),
			  void *context,
			  struct ib_sa_query **query)
{
	return ib_sa_mcmember_rec_query(client, device, port_num,
					IB_SA_METHOD_DELETE,
					rec, comp_mask,
					timeout_ms, gfp_mask, callback,
					context, query);
}

/**
 * ib_init_ah_from_path - Initialize address handle attributes based on an SA
 *   path record.
 */
int ib_init_ah_from_path(struct ib_device *device, u8 port_num,
			 struct ib_sa_path_rec *rec,
			 struct ib_ah_attr *ah_attr);

#endif /* IB_SA_H */
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* Copyright (c) 2004 Topspin Communications. All rights reserved.
cbae32c5	3	* Copyright (c) 2005 Voltaire, Inc. All rights reserved.
c1a0b23b	4	* Copyright (c) 2006 Intel Corporation. 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.
	33	*
cbae32c5	34	* $Id: ib_sa.h 2811 2005-07-06 18:11:43Z halr $
1da177e4 LT	35	*/
	36
	37	#ifndef IB_SA_H
	38	#define IB_SA_H
	39
c1a0b23b	40	#include <linux/completion.h>
1da177e4 LT	41	#include <linux/compiler.h>
1da177e4 LT	42
c1a0b23b MT	43	#include <asm/atomic.h>
c1a0b23b MT	44
a4d61e84 RD	45	#include <rdma/ib_verbs.h>
a4d61e84 RD	46	#include <rdma/ib_mad.h>
1da177e4 LT	47
1da177e4 LT	48	enum {
cbae32c5	49	IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */
1da177e4	50
cbae32c5 HR	51	IB_SA_METHOD_GET_TABLE = 0x12,
cbae32c5 HR	52	IB_SA_METHOD_GET_TABLE_RESP = 0x92,
1325cc79 HR	53	IB_SA_METHOD_DELETE = 0x15,
	54	IB_SA_METHOD_DELETE_RESP = 0x95,
	55	IB_SA_METHOD_GET_MULTI = 0x14,
	56	IB_SA_METHOD_GET_MULTI_RESP = 0x94,
	57	IB_SA_METHOD_GET_TRACE_TBL = 0x13
1da177e4 LT	58	};
1da177e4 LT	59
fbed8eee HR	60	enum {
	61	IB_SA_ATTR_CLASS_PORTINFO = 0x01,
	62	IB_SA_ATTR_NOTICE = 0x02,
	63	IB_SA_ATTR_INFORM_INFO = 0x03,
	64	IB_SA_ATTR_NODE_REC = 0x11,
	65	IB_SA_ATTR_PORT_INFO_REC = 0x12,
	66	IB_SA_ATTR_SL2VL_REC = 0x13,
	67	IB_SA_ATTR_SWITCH_REC = 0x14,
	68	IB_SA_ATTR_LINEAR_FDB_REC = 0x15,
	69	IB_SA_ATTR_RANDOM_FDB_REC = 0x16,
	70	IB_SA_ATTR_MCAST_FDB_REC = 0x17,
	71	IB_SA_ATTR_SM_INFO_REC = 0x18,
	72	IB_SA_ATTR_LINK_REC = 0x20,
	73	IB_SA_ATTR_GUID_INFO_REC = 0x30,
	74	IB_SA_ATTR_SERVICE_REC = 0x31,
	75	IB_SA_ATTR_PARTITION_REC = 0x33,
	76	IB_SA_ATTR_PATH_REC = 0x35,
	77	IB_SA_ATTR_VL_ARB_REC = 0x36,
	78	IB_SA_ATTR_MC_MEMBER_REC = 0x38,
	79	IB_SA_ATTR_TRACE_REC = 0x39,
	80	IB_SA_ATTR_MULTI_PATH_REC = 0x3a,
	81	IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b,
	82	IB_SA_ATTR_INFORM_INFO_REC = 0xf3
	83	};
	84
1da177e4	85	enum ib_sa_selector {
aec79fcc MT	86	IB_SA_GT = 0,
aec79fcc MT	87	IB_SA_LT = 1,
1da177e4 LT	88	IB_SA_EQ = 2,
	89	/*
	90	* The meaning of "best" depends on the attribute: for
	91	* example, for MTU best will return the largest available
	92	* MTU, while for packet life time, best will return the
	93	* smallest available life time.
	94	*/
	95	IB_SA_BEST = 3
	96	};
	97
1da177e4 LT	98	/*
	99	* Structures for SA records are named "struct ib_sa_xxx_rec." No
	100	* attempt is made to pack structures to match the physical layout of
	101	* SA records in SA MADs; all packing and unpacking is handled by the
	102	* SA query code.
	103	*
	104	* For a record with structure ib_sa_xxx_rec, the naming convention
	105	* for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
	106	* never use different abbreviations or otherwise change the spelling
	107	* of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
	108	*
	109	* Reserved rows are indicated with comments to help maintainability.
	110	*/
	111
	112	/* reserved: 0 */
	113	/* reserved: 1 */
	114	#define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2)
	115	#define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3)
	116	#define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4)
	117	#define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5)
	118	#define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6)
	119	/* reserved: 7 */
	120	#define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8)
	121	#define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9)
	122	#define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10)
	123	#define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11)
	124	#define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12)
	125	#define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13)
	126	/* reserved: 14 */
	127	#define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15)
	128	#define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16)
	129	#define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17)
	130	#define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18)
	131	#define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19)
	132	#define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20)
	133	#define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21)
	134	#define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22)
	135
	136	struct ib_sa_path_rec {
	137	/* reserved */
	138	/* reserved */
	139	union ib_gid dgid;
	140	union ib_gid sgid;
97f52eb4 SH	141	__be16 dlid;
97f52eb4 SH	142	__be16 slid;
1da177e4 LT	143	int raw_traffic;
1da177e4 LT	144	/* reserved */
97f52eb4	145	__be32 flow_label;
1da177e4 LT	146	u8 hop_limit;
	147	u8 traffic_class;
	148	int reversible;
	149	u8 numb_path;
97f52eb4	150	__be16 pkey;
1da177e4 LT	151	/* reserved */
	152	u8 sl;
	153	u8 mtu_selector;
3bf4fb82	154	u8 mtu;
1da177e4 LT	155	u8 rate_selector;
	156	u8 rate;
	157	u8 packet_life_time_selector;
	158	u8 packet_life_time;
	159	u8 preference;
	160	};
	161
	162	#define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
	163	#define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
	164	#define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
	165	#define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
	166	#define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
	167	#define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
	168	#define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
	169	#define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
	170	#define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
	171	#define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
	172	#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
	173	#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
	174	#define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
	175	#define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
	176	#define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
	177	#define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
	178	#define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
	179	#define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
	180
	181	struct ib_sa_mcmember_rec {
	182	union ib_gid mgid;
	183	union ib_gid port_gid;
97f52eb4 SH	184	__be32 qkey;
97f52eb4 SH	185	__be16 mlid;
1da177e4	186	u8 mtu_selector;
3bf4fb82	187	u8 mtu;
1da177e4	188	u8 traffic_class;
97f52eb4	189	__be16 pkey;
1da177e4 LT	190	u8 rate_selector;
	191	u8 rate;
	192	u8 packet_life_time_selector;
	193	u8 packet_life_time;
	194	u8 sl;
97f52eb4	195	__be32 flow_label;
1da177e4 LT	196	u8 hop_limit;
	197	u8 scope;
	198	u8 join_state;
	199	int proxy_join;
	200	};
	201
cbae32c5 HR	202	/* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
	203	#define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
	204	#define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
	205	#define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
	206	/* reserved: 3 */
	207	#define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
	208	#define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
	209	#define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
	210	#define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
	211	#define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
	212	#define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
	213	#define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
	214	#define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
	215	#define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
	216	#define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
	217	#define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
	218	#define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
	219	#define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
	220	#define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
	221	#define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
	222	#define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
	223	#define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
	224	#define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
	225	#define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
	226	#define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
	227	#define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
	228	#define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
	229	#define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
	230	#define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
	231	#define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
	232	#define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
	233	#define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
	234	#define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
	235	#define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
	236	#define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
	237	#define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
	238	#define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
	239	#define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
	240
	241	#define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
	242
	243	struct ib_sa_service_rec {
	244	u64 id;
	245	union ib_gid gid;
97f52eb4	246	__be16 pkey;
cbae32c5 HR	247	/* reserved */
	248	u32 lease;
	249	u8 key[16];
	250	u8 name[64];
	251	u8 data8[16];
	252	u16 data16[8];
	253	u32 data32[4];
	254	u64 data64[2];
	255	};
	256
c1a0b23b MT	257	struct ib_sa_client {
	258	atomic_t users;
	259	struct completion comp;
	260	};
	261
	262	/**
	263	* ib_sa_register_client - Register an SA client.
	264	*/
	265	void ib_sa_register_client(struct ib_sa_client *client);
	266
	267	/**
	268	* ib_sa_unregister_client - Deregister an SA client.
	269	* @client: Client object to deregister.
	270	*/
	271	void ib_sa_unregister_client(struct ib_sa_client *client);
	272
1da177e4 LT	273	struct ib_sa_query;
	274
	275	void ib_sa_cancel_query(int id, struct ib_sa_query *query);
	276
c1a0b23b MT	277	int ib_sa_path_rec_get(struct ib_sa_client *client,
c1a0b23b MT	278	struct ib_device *device, u8 port_num,
1da177e4 LT	279	struct ib_sa_path_rec *rec,
1da177e4 LT	280	ib_sa_comp_mask comp_mask,
dd0fc66f	281	int timeout_ms, gfp_t gfp_mask,
1da177e4 LT	282	void (*callback)(int status,
	283	struct ib_sa_path_rec *resp,
	284	void *context),
	285	void *context,
	286	struct ib_sa_query **query);
	287
c1a0b23b MT	288	int ib_sa_mcmember_rec_query(struct ib_sa_client *client,
c1a0b23b MT	289	struct ib_device *device, u8 port_num,
1da177e4 LT	290	u8 method,
	291	struct ib_sa_mcmember_rec *rec,
	292	ib_sa_comp_mask comp_mask,
dd0fc66f	293	int timeout_ms, gfp_t gfp_mask,
1da177e4 LT	294	void (*callback)(int status,
	295	struct ib_sa_mcmember_rec *resp,
	296	void *context),
	297	void *context,
	298	struct ib_sa_query **query);
	299
c1a0b23b MT	300	int ib_sa_service_rec_query(struct ib_sa_client *client,
c1a0b23b MT	301	struct ib_device *device, u8 port_num,
cbae32c5 HR	302	u8 method,
	303	struct ib_sa_service_rec *rec,
	304	ib_sa_comp_mask comp_mask,
dd0fc66f	305	int timeout_ms, gfp_t gfp_mask,
cbae32c5 HR	306	void (*callback)(int status,
	307	struct ib_sa_service_rec *resp,
	308	void *context),
	309	void *context,
	310	struct ib_sa_query **sa_query);
	311
1da177e4 LT	312	/**
1da177e4 LT	313	* ib_sa_mcmember_rec_set - Start an MCMember set query
c1a0b23b	314	* @client:SA client
1da177e4 LT	315	* @device:device to send query on
	316	* @port_num: port number to send query on
	317	* @rec:MCMember Record to send in query
	318	* @comp_mask:component mask to send in query
	319	* @timeout_ms:time to wait for response
	320	* @gfp_mask:GFP mask to use for internal allocations
	321	* @callback:function called when query completes, times out or is
	322	* canceled
	323	* @context:opaque user context passed to callback
	324	* @sa_query:query context, used to cancel query
	325	*
	326	* Send an MCMember Set query to the SA (eg to join a multicast
	327	* group). The callback function will be called when the query
	328	* completes (or fails); status is 0 for a successful response, -EINTR
	329	* if the query is canceled, -ETIMEDOUT is the query timed out, or
	330	* -EIO if an error occurred sending the query. The resp parameter of
	331	* the callback is only valid if status is 0.
	332	*
	333	* If the return value of ib_sa_mcmember_rec_set() is negative, it is
	334	* an error code. Otherwise it is a query ID that can be used to
	335	* cancel the query.
	336	*/
	337	static inline int
c1a0b23b MT	338	ib_sa_mcmember_rec_set(struct ib_sa_client *client,
c1a0b23b MT	339	struct ib_device *device, u8 port_num,
1da177e4 LT	340	struct ib_sa_mcmember_rec *rec,
1da177e4 LT	341	ib_sa_comp_mask comp_mask,
dd0fc66f	342	int timeout_ms, gfp_t gfp_mask,
1da177e4 LT	343	void (*callback)(int status,
	344	struct ib_sa_mcmember_rec *resp,
	345	void *context),
	346	void *context,
	347	struct ib_sa_query **query)
	348	{
c1a0b23b	349	return ib_sa_mcmember_rec_query(client, device, port_num,
1da177e4 LT	350	IB_MGMT_METHOD_SET,
	351	rec, comp_mask,
	352	timeout_ms, gfp_mask, callback,
	353	context, query);
	354	}
	355
	356	/**
	357	* ib_sa_mcmember_rec_delete - Start an MCMember delete query
c1a0b23b	358	* @client:SA client
1da177e4 LT	359	* @device:device to send query on
	360	* @port_num: port number to send query on
	361	* @rec:MCMember Record to send in query
	362	* @comp_mask:component mask to send in query
	363	* @timeout_ms:time to wait for response
	364	* @gfp_mask:GFP mask to use for internal allocations
	365	* @callback:function called when query completes, times out or is
	366	* canceled
	367	* @context:opaque user context passed to callback
	368	* @sa_query:query context, used to cancel query
	369	*
	370	* Send an MCMember Delete query to the SA (eg to leave a multicast
	371	* group). The callback function will be called when the query
	372	* completes (or fails); status is 0 for a successful response, -EINTR
	373	* if the query is canceled, -ETIMEDOUT is the query timed out, or
	374	* -EIO if an error occurred sending the query. The resp parameter of
	375	* the callback is only valid if status is 0.
	376	*
	377	* If the return value of ib_sa_mcmember_rec_delete() is negative, it
	378	* is an error code. Otherwise it is a query ID that can be used to
	379	* cancel the query.
	380	*/
	381	static inline int
c1a0b23b MT	382	ib_sa_mcmember_rec_delete(struct ib_sa_client *client,
c1a0b23b MT	383	struct ib_device *device, u8 port_num,
1da177e4 LT	384	struct ib_sa_mcmember_rec *rec,
1da177e4 LT	385	ib_sa_comp_mask comp_mask,
dd0fc66f	386	int timeout_ms, gfp_t gfp_mask,
1da177e4 LT	387	void (*callback)(int status,
	388	struct ib_sa_mcmember_rec *resp,
	389	void *context),
	390	void *context,
	391	struct ib_sa_query **query)
	392	{
c1a0b23b	393	return ib_sa_mcmember_rec_query(client, device, port_num,
1da177e4 LT	394	IB_SA_METHOD_DELETE,
	395	rec, comp_mask,
	396	timeout_ms, gfp_mask, callback,
	397	context, query);
	398	}
	399
6d969a47 SH	400	/**
	401	* ib_init_ah_from_path - Initialize address handle attributes based on an SA
	402	* path record.
	403	*/
	404	int ib_init_ah_from_path(struct ib_device *device, u8 port_num,
	405	struct ib_sa_path_rec *rec,
	406	struct ib_ah_attr *ah_attr);
1da177e4 LT	407
1da177e4 LT	408	#endif /* IB_SA_H */