1 #ifndef DEF_RDMAVT_INCCQ_H
2 #define DEF_RDMAVT_INCCQ_H
3
4 /*
5 *
6 * This file is provided under a dual BSD/GPLv2 license. When using or
7 * redistributing this file, you may do so under either license.
8 *
9 * GPL LICENSE SUMMARY
10 *
11 * Copyright(c) 2016 - 2018 Intel Corporation.
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of version 2 of the GNU General Public License as
15 * published by the Free Software Foundation.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * BSD LICENSE
23 *
24 * Copyright(c) 2015 Intel Corporation.
25 *
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions
28 * are met:
29 *
30 * - Redistributions of source code must retain the above copyright
31 * notice, this list of conditions and the following disclaimer.
32 * - Redistributions in binary form must reproduce the above copyright
33 * notice, this list of conditions and the following disclaimer in
34 * the documentation and/or other materials provided with the
35 * distribution.
36 * - Neither the name of Intel Corporation nor the names of its
37 * contributors may be used to endorse or promote products derived
38 * from this software without specific prior written permission.
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 *
52 */
53
54 #include <linux/kthread.h>
55 #include <rdma/ib_user_verbs.h>
56 #include <rdma/ib_verbs.h>
57
58 /*
59 * Define an ib_cq_notify value that is not valid so we know when CQ
60 * notifications are armed.
61 */
62 #define RVT_CQ_NONE (IB_CQ_NEXT_COMP + 1)
63
64 /*
65 * Define read macro that apply smp_load_acquire memory barrier
66 * when reading indice of circular buffer that mmaped to user space.
67 */
68 #define RDMA_READ_UAPI_ATOMIC(member) smp_load_acquire(&(member).val)
69
70 /*
71 * Define write macro that uses smp_store_release memory barrier
72 * when writing indice of circular buffer that mmaped to user space.
73 */
74 #define RDMA_WRITE_UAPI_ATOMIC(member, x) smp_store_release(&(member).val, x)
75 #include <rdma/rvt-abi.h>
76
77 /*
78 * This structure is used to contain the head pointer, tail pointer,
79 * and completion queue entries as a single memory allocation so
80 * it can be mmap'ed into user space.
81 */
82 struct rvt_k_cq_wc {
83 u32 head; /* index of next entry to fill */
84 u32 tail; /* index of next ib_poll_cq() entry */
85 struct ib_wc kqueue[];
86 };
87
88 /*
89 * The completion queue structure.
90 */
91 struct rvt_cq {
92 struct ib_cq ibcq;
93 struct work_struct comptask;
94 spinlock_t lock; /* protect changes in this struct */
95 u8 notify;
96 u8 triggered;
97 u8 cq_full;
98 int comp_vector_cpu;
99 struct rvt_dev_info *rdi;
100 struct rvt_cq_wc *queue;
101 struct rvt_mmap_info *ip;
102 struct rvt_k_cq_wc *kqueue;
103 };
104
105 static inline struct rvt_cq *ibcq_to_rvtcq(struct ib_cq *ibcq)
106 {
107 return container_of(ibcq, struct rvt_cq, ibcq);
108 }
109
110 bool rvt_cq_enter(struct rvt_cq *cq, struct ib_wc *entry, bool solicited);
111
112 #endif /* DEF_RDMAVT_INCCQH */