1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 4 * Copyright (c) 2004 Topspin Corporation. All rights reserved. 5 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved. 6 * 7 * This software is available to you under a choice of one of two 8 * licenses. You may choose to be licensed under the terms of the GNU 9 * General Public License (GPL) Version 2, available from the file 10 * COPYING in the main directory of this source tree, or the 11 * OpenIB.org BSD license below: 12 * 13 * Redistribution and use in source and binary forms, with or 14 * without modification, are permitted provided that the following 15 * conditions are met: 16 * 17 * - Redistributions of source code must retain the above 18 * copyright notice, this list of conditions and the following 19 * disclaimer. 20 * 21 * - Redistributions in binary form must reproduce the above 22 * copyright notice, this list of conditions and the following 23 * disclaimer in the documentation and/or other materials 24 * provided with the distribution. 25 * 26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 29 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 30 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 31 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 32 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 33 * SOFTWARE. 34 */ 35 36 #if !defined(IB_FMR_POOL_H) 37 #define IB_FMR_POOL_H 38 39 #include <rdma/ib_verbs.h> 40 41 struct ib_fmr_pool; 42 43 /** 44 * struct ib_fmr_pool_param - Parameters for creating FMR pool 45 * @max_pages_per_fmr:Maximum number of pages per map request. 46 * @page_shift: Log2 of sizeof "pages" mapped by this fmr 47 * @access:Access flags for FMRs in pool. 48 * @pool_size:Number of FMRs to allocate for pool. 49 * @dirty_watermark:Flush is triggered when @dirty_watermark dirty 50 * FMRs are present. 51 * @flush_function:Callback called when unmapped FMRs are flushed and 52 * more FMRs are possibly available for mapping 53 * @flush_arg:Context passed to user's flush function. 54 * @cache:If set, FMRs may be reused after unmapping for identical map 55 * requests. 56 */ 57 struct ib_fmr_pool_param { 58 int max_pages_per_fmr; 59 int page_shift; 60 enum ib_access_flags access; 61 int pool_size; 62 int dirty_watermark; 63 void (*flush_function)(struct ib_fmr_pool *pool, 64 void *arg); 65 void *flush_arg; 66 unsigned cache:1; 67 }; 68 69 struct ib_pool_fmr { 70 struct ib_fmr *fmr; 71 struct ib_fmr_pool *pool; 72 struct list_head list; 73 struct hlist_node cache_node; 74 int ref_count; 75 int remap_count; 76 u64 io_virtual_address; 77 int page_list_len; 78 u64 page_list[0]; 79 }; 80 81 struct ib_fmr_pool *ib_create_fmr_pool(struct ib_pd *pd, 82 struct ib_fmr_pool_param *params); 83 84 void ib_destroy_fmr_pool(struct ib_fmr_pool *pool); 85 86 int ib_flush_fmr_pool(struct ib_fmr_pool *pool); 87 88 struct ib_pool_fmr *ib_fmr_pool_map_phys(struct ib_fmr_pool *pool_handle, 89 u64 *page_list, 90 int list_len, 91 u64 io_virtual_address); 92 93 int ib_fmr_pool_unmap(struct ib_pool_fmr *fmr); 94 95 #endif /* IB_FMR_POOL_H */ 96