xref: /freebsd/sys/dev/ice/irdma_di_if.m (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1# SPDX-License-Identifier: BSD-3-Clause
2#  Copyright (c) 2023, Intel Corporation
3#  All rights reserved.
4#
5#  Redistribution and use in source and binary forms, with or without
6#  modification, are permitted provided that the following conditions are met:
7#
8#   1. Redistributions of source code must retain the above copyright notice,
9#      this list of conditions and the following disclaimer.
10#
11#   2. Redistributions in binary form must reproduce the above copyright
12#      notice, this list of conditions and the following disclaimer in the
13#      documentation and/or other materials provided with the distribution.
14#
15#   3. Neither the name of the Intel Corporation nor the names of its
16#      contributors may be used to endorse or promote products derived from
17#      this software without specific prior written permission.
18#
19#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29#  POSSIBILITY OF SUCH DAMAGE.
30
31/**
32 * @file irdma_di_if.m
33 * @brief RDMA client kobject driver interface
34 *
35 * KObject methods implemented by the ice driver. These functions are called
36 * by the RDMA client driver to connect with the ice driver and request
37 * operations or notify the driver of RDMA events.
38 */
39#include "ice_rdma.h"
40
41INTERFACE irdma_di;
42
43/**
44 * reset - Request the ice driver to perform a reset
45 * @peer: the RDMA peer structure
46 *
47 * Called by the RDMA client driver to request a reset of the ice device.
48 */
49METHOD int reset {
50	struct ice_rdma_peer *peer;
51};
52
53/**
54 * msix_init - Initialize MSI-X resources for the RDMA driver
55 * @peer: the RDMA peer structure
56 * @msix_info: the requested MSI-X mapping
57 *
58 * Called by the RDMA client driver to request initialization of the MSI-X
59 * resources used for RDMA functionality.
60 */
61METHOD int msix_init {
62	struct ice_rdma_peer *peer;
63	struct ice_rdma_msix_mapping *msix_info;
64};
65
66/**
67 * qset_register_request - RDMA client interface request qset
68 *                         registration or deregistration
69 * @peer: the RDMA peer client structure
70 * @res: resources to be registered or unregistered
71 */
72METHOD int qset_register_request {
73	struct ice_rdma_peer *peer;
74	struct ice_rdma_qset_update *res;
75};
76
77/**
78 * vsi_filter_update - configure vsi information
79 *                     when opening or closing rdma driver
80 * @peer: the RDMA peer client structure
81 * @enable: enable or disable the rdma filter
82 */
83METHOD int vsi_filter_update {
84	struct ice_rdma_peer *peer;
85	bool enable;
86};
87
88/**
89 * req_handler - handle requests incoming from RDMA driver
90 * @peer: the RDMA peer client structure
91 * @req: structure containing request
92 */
93METHOD void req_handler {
94	struct ice_rdma_peer *peer;
95	struct ice_rdma_request *req;
96};
97