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