xref: /freebsd/sys/ofed/drivers/infiniband/core/smi.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3  *
4  * Copyright (c) 2004 Mellanox Technologies Ltd.  All rights reserved.
5  * Copyright (c) 2004 Infinicon Corporation.  All rights reserved.
6  * Copyright (c) 2004 Intel Corporation.  All rights reserved.
7  * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
8  * Copyright (c) 2004-2007 Voltaire Corporation.  All rights reserved.
9  *
10  * This software is available to you under a choice of one of two
11  * licenses.  You may choose to be licensed under the terms of the GNU
12  * General Public License (GPL) Version 2, available from the file
13  * COPYING in the main directory of this source tree, or the
14  * OpenIB.org BSD license below:
15  *
16  *     Redistribution and use in source and binary forms, with or
17  *     without modification, are permitted provided that the following
18  *     conditions are met:
19  *
20  *      - Redistributions of source code must retain the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer.
23  *
24  *      - Redistributions in binary form must reproduce the above
25  *        copyright notice, this list of conditions and the following
26  *        disclaimer in the documentation and/or other materials
27  *        provided with the distribution.
28  *
29  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
33  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
34  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
35  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36  * SOFTWARE.
37  */
38 
39 #ifndef __SMI_H_
40 #define __SMI_H_
41 
42 #include <rdma/ib_smi.h>
43 
44 enum smi_action {
45 	IB_SMI_DISCARD,
46 	IB_SMI_HANDLE
47 };
48 
49 enum smi_forward_action {
50 	IB_SMI_LOCAL,	/* SMP should be completed up the stack */
51 	IB_SMI_SEND,	/* received DR SMP should be forwarded to the send queue */
52 	IB_SMI_FORWARD	/* SMP should be forwarded (for switches only) */
53 };
54 
55 enum smi_action smi_handle_dr_smp_recv(struct ib_smp *smp, bool is_switch,
56 				       int port_num, int phys_port_cnt);
57 int smi_get_fwd_port(struct ib_smp *smp);
58 extern enum smi_forward_action smi_check_forward_dr_smp(struct ib_smp *smp);
59 extern enum smi_action smi_handle_dr_smp_send(struct ib_smp *smp,
60 					      bool is_switch, int port_num);
61 
62 /*
63  * Return IB_SMI_HANDLE if the SMP should be handled by the local SMA/SM
64  * via process_mad
65  */
66 static inline enum smi_action smi_check_local_smp(struct ib_smp *smp,
67 						  struct ib_device *device)
68 {
69 	/* C14-9:3 -- We're at the end of the DR segment of path */
70 	/* C14-9:4 -- Hop Pointer = Hop Count + 1 -> give to SMA/SM */
71 	return ((device->process_mad &&
72 		!ib_get_smp_direction(smp) &&
73 		(smp->hop_ptr == smp->hop_cnt + 1)) ?
74 		IB_SMI_HANDLE : IB_SMI_DISCARD);
75 }
76 
77 /*
78  * Return IB_SMI_HANDLE if the SMP should be handled by the local SMA/SM
79  * via process_mad
80  */
81 static inline enum smi_action smi_check_local_returning_smp(struct ib_smp *smp,
82 						   struct ib_device *device)
83 {
84 	/* C14-13:3 -- We're at the end of the DR segment of path */
85 	/* C14-13:4 -- Hop Pointer == 0 -> give to SM */
86 	return ((device->process_mad &&
87 		ib_get_smp_direction(smp) &&
88 		!smp->hop_ptr) ? IB_SMI_HANDLE : IB_SMI_DISCARD);
89 }
90 
91 #endif	/* __SMI_H_ */
92