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