drivers/infiniband/include/ib_fmr_pool.h

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