xref: /openbmc/linux/drivers/infiniband/sw/rdmavt/mad.c (revision 3dd1faf89b418f036ff664edbf04d4e266e2ceaa)
1 /*
2  * Copyright(c) 2015 Intel Corporation.
3  *
4  * This file is provided under a dual BSD/GPLv2 license.  When using or
5  * redistributing this file, you may do so under either license.
6  *
7  * GPL LICENSE SUMMARY
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * BSD LICENSE
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  *
24  *  - Redistributions of source code must retain the above copyright
25  *    notice, this list of conditions and the following disclaimer.
26  *  - Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in
28  *    the documentation and/or other materials provided with the
29  *    distribution.
30  *  - Neither the name of Intel Corporation nor the names of its
31  *    contributors may be used to endorse or promote products derived
32  *    from this software without specific prior written permission.
33  *
34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
37  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
38  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
41  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
42  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  */
47 
48 #include "mad.h"
49 
50 /**
51  * rvt_process_mad - process an incoming MAD packet
52  * @ibdev: the infiniband device this packet came in on
53  * @mad_flags: MAD flags
54  * @port: the port number this packet came in on
55  * @in_wc: the work completion entry for this packet
56  * @in_grh: the global route header for this packet
57  * @in_mad: the incoming MAD
58  * @out_mad: any outgoing MAD reply
59  *
60  * Returns IB_MAD_RESULT_SUCCESS if this is a MAD that we are not
61  * interested in processing.
62  *
63  * Note that the verbs framework has already done the MAD sanity checks,
64  * and hop count/pointer updating for IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE
65  * MADs.
66  *
67  * This is called by the ib_mad module.
68  */
69 int rvt_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
70 		    const struct ib_wc *in_wc, const struct ib_grh *in_grh,
71 		    const struct ib_mad_hdr *in, size_t in_mad_size,
72 		    struct ib_mad_hdr *out, size_t *out_mad_size,
73 		    u16 *out_mad_pkey_index)
74 {
75 	/*
76 	 * Drivers will need to provide a number of things. For exmaple counters
77 	 * will need to be maintained by the driver but shoud live in the rvt
78 	 * structure. More study will be needed to finalize the interface
79 	 * between drivers and rvt for mad packets.
80 	 *
81 	 *VT-DRIVER-API: ????
82 	 *
83 	 */
84 	return IB_MAD_RESULT_FAILURE;
85 }
86