1 #ifndef _HFI1_USER_SDMA_H 2 #define _HFI1_USER_SDMA_H 3 /* 4 * Copyright(c) 2015 - 2017 Intel Corporation. 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 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * BSD LICENSE 21 * 22 * Redistribution and use in source and binary forms, with or without 23 * modification, are permitted provided that the following conditions 24 * are met: 25 * 26 * - Redistributions of source code must retain the above copyright 27 * notice, this list of conditions and the following disclaimer. 28 * - Redistributions in binary form must reproduce the above copyright 29 * notice, this list of conditions and the following disclaimer in 30 * the documentation and/or other materials provided with the 31 * distribution. 32 * - Neither the name of Intel Corporation nor the names of its 33 * contributors may be used to endorse or promote products derived 34 * from this software without specific prior written permission. 35 * 36 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 37 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 38 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 39 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 40 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 43 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 44 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 45 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 46 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 47 * 48 */ 49 #include <linux/device.h> 50 #include <linux/wait.h> 51 52 #include "common.h" 53 #include "iowait.h" 54 #include "user_exp_rcv.h" 55 56 /* The maximum number of Data io vectors per message/request */ 57 #define MAX_VECTORS_PER_REQ 8 58 /* 59 * Maximum number of packet to send from each message/request 60 * before moving to the next one. 61 */ 62 #define MAX_PKTS_PER_QUEUE 16 63 64 #define num_pages(x) (1 + ((((x) - 1) & PAGE_MASK) >> PAGE_SHIFT)) 65 66 #define req_opcode(x) \ 67 (((x) >> HFI1_SDMA_REQ_OPCODE_SHIFT) & HFI1_SDMA_REQ_OPCODE_MASK) 68 #define req_version(x) \ 69 (((x) >> HFI1_SDMA_REQ_VERSION_SHIFT) & HFI1_SDMA_REQ_OPCODE_MASK) 70 #define req_iovcnt(x) \ 71 (((x) >> HFI1_SDMA_REQ_IOVCNT_SHIFT) & HFI1_SDMA_REQ_IOVCNT_MASK) 72 73 /* Number of BTH.PSN bits used for sequence number in expected rcvs */ 74 #define BTH_SEQ_MASK 0x7ffull 75 76 #define AHG_KDETH_INTR_SHIFT 12 77 #define AHG_KDETH_SH_SHIFT 13 78 #define AHG_KDETH_ARRAY_SIZE 9 79 80 #define PBC2LRH(x) ((((x) & 0xfff) << 2) - 4) 81 #define LRH2PBC(x) ((((x) >> 2) + 1) & 0xfff) 82 83 #define AHG_HEADER_SET(arr, idx, dw, bit, width, value) \ 84 do { \ 85 if ((idx) < ARRAY_SIZE((arr))) \ 86 (arr)[(idx++)] = sdma_build_ahg_descriptor( \ 87 (__force u16)(value), (dw), (bit), \ 88 (width)); \ 89 else \ 90 return -ERANGE; \ 91 } while (0) 92 93 /* Tx request flag bits */ 94 #define TXREQ_FLAGS_REQ_ACK BIT(0) /* Set the ACK bit in the header */ 95 #define TXREQ_FLAGS_REQ_DISABLE_SH BIT(1) /* Disable header suppression */ 96 97 #define SDMA_PKT_Q_INACTIVE BIT(0) 98 #define SDMA_PKT_Q_ACTIVE BIT(1) 99 #define SDMA_PKT_Q_DEFERRED BIT(2) 100 101 /* 102 * Maximum retry attempts to submit a TX request 103 * before putting the process to sleep. 104 */ 105 #define MAX_DEFER_RETRY_COUNT 1 106 107 #define SDMA_IOWAIT_TIMEOUT 1000 /* in milliseconds */ 108 109 #define SDMA_DBG(req, fmt, ...) \ 110 hfi1_cdbg(SDMA, "[%u:%u:%u:%u] " fmt, (req)->pq->dd->unit, \ 111 (req)->pq->ctxt, (req)->pq->subctxt, (req)->info.comp_idx, \ 112 ##__VA_ARGS__) 113 114 extern uint extended_psn; 115 116 struct hfi1_user_sdma_pkt_q { 117 u16 ctxt; 118 u16 subctxt; 119 u16 n_max_reqs; 120 atomic_t n_reqs; 121 u16 reqidx; 122 struct hfi1_devdata *dd; 123 struct kmem_cache *txreq_cache; 124 struct user_sdma_request *reqs; 125 unsigned long *req_in_use; 126 struct iowait busy; 127 unsigned state; 128 wait_queue_head_t wait; 129 unsigned long unpinned; 130 struct mmu_rb_handler *handler; 131 atomic_t n_locked; 132 struct mm_struct *mm; 133 }; 134 135 struct hfi1_user_sdma_comp_q { 136 u16 nentries; 137 struct hfi1_sdma_comp_entry *comps; 138 }; 139 140 struct sdma_mmu_node { 141 struct mmu_rb_node rb; 142 struct hfi1_user_sdma_pkt_q *pq; 143 atomic_t refcount; 144 struct page **pages; 145 unsigned int npages; 146 }; 147 148 struct user_sdma_iovec { 149 struct list_head list; 150 struct iovec iov; 151 /* number of pages in this vector */ 152 unsigned int npages; 153 /* array of pinned pages for this vector */ 154 struct page **pages; 155 /* 156 * offset into the virtual address space of the vector at 157 * which we last left off. 158 */ 159 u64 offset; 160 struct sdma_mmu_node *node; 161 }; 162 163 /* evict operation argument */ 164 struct evict_data { 165 u32 cleared; /* count evicted so far */ 166 u32 target; /* target count to evict */ 167 }; 168 169 struct user_sdma_request { 170 /* This is the original header from user space */ 171 struct hfi1_pkt_header hdr; 172 173 /* Read mostly fields */ 174 struct hfi1_user_sdma_pkt_q *pq ____cacheline_aligned_in_smp; 175 struct hfi1_user_sdma_comp_q *cq; 176 /* 177 * Pointer to the SDMA engine for this request. 178 * Since different request could be on different VLs, 179 * each request will need it's own engine pointer. 180 */ 181 struct sdma_engine *sde; 182 struct sdma_req_info info; 183 /* TID array values copied from the tid_iov vector */ 184 u32 *tids; 185 /* total length of the data in the request */ 186 u32 data_len; 187 /* number of elements copied to the tids array */ 188 u16 n_tids; 189 /* 190 * We copy the iovs for this request (based on 191 * info.iovcnt). These are only the data vectors 192 */ 193 u8 data_iovs; 194 s8 ahg_idx; 195 196 /* Writeable fields shared with interrupt */ 197 u64 seqcomp ____cacheline_aligned_in_smp; 198 u64 seqsubmitted; 199 /* status of the last txreq completed */ 200 int status; 201 202 /* Send side fields */ 203 struct list_head txps ____cacheline_aligned_in_smp; 204 u64 seqnum; 205 /* 206 * KDETH.OFFSET (TID) field 207 * The offset can cover multiple packets, depending on the 208 * size of the TID entry. 209 */ 210 u32 tidoffset; 211 /* 212 * KDETH.Offset (Eager) field 213 * We need to remember the initial value so the headers 214 * can be updated properly. 215 */ 216 u32 koffset; 217 u32 sent; 218 /* TID index copied from the tid_iov vector */ 219 u16 tididx; 220 /* progress index moving along the iovs array */ 221 u8 iov_idx; 222 u8 done; 223 u8 has_error; 224 225 struct user_sdma_iovec iovs[MAX_VECTORS_PER_REQ]; 226 } ____cacheline_aligned_in_smp; 227 228 /* 229 * A single txreq could span up to 3 physical pages when the MTU 230 * is sufficiently large (> 4K). Each of the IOV pointers also 231 * needs it's own set of flags so the vector has been handled 232 * independently of each other. 233 */ 234 struct user_sdma_txreq { 235 /* Packet header for the txreq */ 236 struct hfi1_pkt_header hdr; 237 struct sdma_txreq txreq; 238 struct list_head list; 239 struct user_sdma_request *req; 240 u16 flags; 241 unsigned int busycount; 242 u64 seqnum; 243 }; 244 245 int hfi1_user_sdma_alloc_queues(struct hfi1_ctxtdata *uctxt, 246 struct hfi1_filedata *fd); 247 int hfi1_user_sdma_free_queues(struct hfi1_filedata *fd, 248 struct hfi1_ctxtdata *uctxt); 249 int hfi1_user_sdma_process_request(struct hfi1_filedata *fd, 250 struct iovec *iovec, unsigned long dim, 251 unsigned long *count); 252 253 #endif /* _HFI1_USER_SDMA_H */ 254