xref: /freebsd/sys/dev/ice/irdma_di_if.m (revision d9a42747950146bf03cda7f6e25d219253f8a57a)
1# SPDX-License-Identifier: BSD-3-Clause
2#  Copyright (c) 2022, 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# $FreeBSD$
31
32/**
33 * @file irdma_di_if.m
34 * @brief RDMA client kobject driver interface
35 *
36 * KObject methods implemented by the ice driver. These functions are called
37 * by the RDMA client driver to connect with the ice driver and request
38 * operations or notify the driver of RDMA events.
39 */
40#include "ice_rdma.h"
41
42INTERFACE irdma_di;
43
44/**
45 * reset - Request the ice driver to perform a reset
46 * @peer: the RDMA peer structure
47 *
48 * Called by the RDMA client driver to request a reset of the ice device.
49 */
50METHOD int reset {
51	struct ice_rdma_peer *peer;
52};
53
54/**
55 * msix_init - Initialize MSI-X resources for the RDMA driver
56 * @peer: the RDMA peer structure
57 * @msix_info: the requested MSI-X mapping
58 *
59 * Called by the RDMA client driver to request initialization of the MSI-X
60 * resources used for RDMA functionality.
61 */
62METHOD int msix_init {
63	struct ice_rdma_peer *peer;
64	struct ice_rdma_msix_mapping *msix_info;
65};
66
67/**
68 * qset_register_request - RDMA client interface request qset
69 *                         registration or deregistration
70 * @peer: the RDMA peer client structure
71 * @res: resources to be registered or unregistered
72 */
73METHOD int qset_register_request {
74	struct ice_rdma_peer *peer;
75	struct ice_rdma_qset_update *res;
76};
77
78/**
79 * vsi_filter_update - configure vsi information
80 *                     when opening or closing rdma driver
81 * @peer: the RDMA peer client structure
82 * @enable: enable or disable the rdma filter
83 */
84METHOD int vsi_filter_update {
85	struct ice_rdma_peer *peer;
86	bool enable;
87};
88
89/**
90 * req_handler - handle requests incoming from RDMA driver
91 * @peer: the RDMA peer client structure
92 * @req: structure containing request
93 */
94METHOD void req_handler {
95	struct ice_rdma_peer *peer;
96	struct ice_rdma_request *req;
97};
98