xref: /openbmc/linux/drivers/infiniband/hw/mthca/mthca_memfree.h (revision 96de0e252cedffad61b3cb5e05662c591898e69a)
1 /*
2  * Copyright (c) 2004, 2005 Topspin Communications.  All rights reserved.
3  * Copyright (c) 2005 Cisco Systems.  All rights reserved.
4  * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenIB.org BSD license below:
11  *
12  *     Redistribution and use in source and binary forms, with or
13  *     without modification, are permitted provided that the following
14  *     conditions are met:
15  *
16  *      - Redistributions of source code must retain the above
17  *        copyright notice, this list of conditions and the following
18  *        disclaimer.
19  *
20  *      - Redistributions in binary form must reproduce the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer in the documentation and/or other materials
23  *        provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  *
34  * $Id$
35  */
36 
37 #ifndef MTHCA_MEMFREE_H
38 #define MTHCA_MEMFREE_H
39 
40 #include <linux/list.h>
41 #include <linux/mutex.h>
42 
43 #define MTHCA_ICM_CHUNK_LEN \
44 	((256 - sizeof (struct list_head) - 2 * sizeof (int)) /		\
45 	 (sizeof (struct scatterlist)))
46 
47 enum {
48 	MTHCA_ICM_PAGE_SHIFT	= 12,
49 	MTHCA_ICM_PAGE_SIZE	= 1 << MTHCA_ICM_PAGE_SHIFT,
50 	MTHCA_DB_REC_PER_PAGE	= MTHCA_ICM_PAGE_SIZE / 8
51 };
52 
53 struct mthca_icm_chunk {
54 	struct list_head   list;
55 	int                npages;
56 	int                nsg;
57 	struct scatterlist mem[MTHCA_ICM_CHUNK_LEN];
58 };
59 
60 struct mthca_icm {
61 	struct list_head chunk_list;
62 	int              refcount;
63 };
64 
65 struct mthca_icm_table {
66 	u64               virt;
67 	int               num_icm;
68 	int               num_obj;
69 	int               obj_size;
70 	int               lowmem;
71 	int               coherent;
72 	struct mutex      mutex;
73 	struct mthca_icm *icm[0];
74 };
75 
76 struct mthca_icm_iter {
77 	struct mthca_icm       *icm;
78 	struct mthca_icm_chunk *chunk;
79 	int                     page_idx;
80 };
81 
82 struct mthca_dev;
83 
84 struct mthca_icm *mthca_alloc_icm(struct mthca_dev *dev, int npages,
85 				  gfp_t gfp_mask, int coherent);
86 void mthca_free_icm(struct mthca_dev *dev, struct mthca_icm *icm, int coherent);
87 
88 struct mthca_icm_table *mthca_alloc_icm_table(struct mthca_dev *dev,
89 					      u64 virt, int obj_size,
90 					      int nobj, int reserved,
91 					      int use_lowmem, int use_coherent);
92 void mthca_free_icm_table(struct mthca_dev *dev, struct mthca_icm_table *table);
93 int mthca_table_get(struct mthca_dev *dev, struct mthca_icm_table *table, int obj);
94 void mthca_table_put(struct mthca_dev *dev, struct mthca_icm_table *table, int obj);
95 void *mthca_table_find(struct mthca_icm_table *table, int obj, dma_addr_t *dma_handle);
96 int mthca_table_get_range(struct mthca_dev *dev, struct mthca_icm_table *table,
97 			  int start, int end);
98 void mthca_table_put_range(struct mthca_dev *dev, struct mthca_icm_table *table,
99 			   int start, int end);
100 
101 static inline void mthca_icm_first(struct mthca_icm *icm,
102 				   struct mthca_icm_iter *iter)
103 {
104 	iter->icm      = icm;
105 	iter->chunk    = list_empty(&icm->chunk_list) ?
106 		NULL : list_entry(icm->chunk_list.next,
107 				  struct mthca_icm_chunk, list);
108 	iter->page_idx = 0;
109 }
110 
111 static inline int mthca_icm_last(struct mthca_icm_iter *iter)
112 {
113 	return !iter->chunk;
114 }
115 
116 static inline void mthca_icm_next(struct mthca_icm_iter *iter)
117 {
118 	if (++iter->page_idx >= iter->chunk->nsg) {
119 		if (iter->chunk->list.next == &iter->icm->chunk_list) {
120 			iter->chunk = NULL;
121 			return;
122 		}
123 
124 		iter->chunk = list_entry(iter->chunk->list.next,
125 					 struct mthca_icm_chunk, list);
126 		iter->page_idx = 0;
127 	}
128 }
129 
130 static inline dma_addr_t mthca_icm_addr(struct mthca_icm_iter *iter)
131 {
132 	return sg_dma_address(&iter->chunk->mem[iter->page_idx]);
133 }
134 
135 static inline unsigned long mthca_icm_size(struct mthca_icm_iter *iter)
136 {
137 	return sg_dma_len(&iter->chunk->mem[iter->page_idx]);
138 }
139 
140 struct mthca_db_page {
141 	DECLARE_BITMAP(used, MTHCA_DB_REC_PER_PAGE);
142 	__be64    *db_rec;
143 	dma_addr_t mapping;
144 };
145 
146 struct mthca_db_table {
147 	int 	       	      npages;
148 	int 	       	      max_group1;
149 	int 	       	      min_group2;
150 	struct mthca_db_page *page;
151 	struct mutex          mutex;
152 };
153 
154 enum mthca_db_type {
155 	MTHCA_DB_TYPE_INVALID   = 0x0,
156 	MTHCA_DB_TYPE_CQ_SET_CI = 0x1,
157 	MTHCA_DB_TYPE_CQ_ARM    = 0x2,
158 	MTHCA_DB_TYPE_SQ        = 0x3,
159 	MTHCA_DB_TYPE_RQ        = 0x4,
160 	MTHCA_DB_TYPE_SRQ       = 0x5,
161 	MTHCA_DB_TYPE_GROUP_SEP = 0x7
162 };
163 
164 struct mthca_user_db_table;
165 struct mthca_uar;
166 
167 int mthca_map_user_db(struct mthca_dev *dev, struct mthca_uar *uar,
168 		      struct mthca_user_db_table *db_tab, int index, u64 uaddr);
169 void mthca_unmap_user_db(struct mthca_dev *dev, struct mthca_uar *uar,
170 			 struct mthca_user_db_table *db_tab, int index);
171 struct mthca_user_db_table *mthca_init_user_db_tab(struct mthca_dev *dev);
172 void mthca_cleanup_user_db_tab(struct mthca_dev *dev, struct mthca_uar *uar,
173 			       struct mthca_user_db_table *db_tab);
174 
175 int mthca_init_db_tab(struct mthca_dev *dev);
176 void mthca_cleanup_db_tab(struct mthca_dev *dev);
177 int mthca_alloc_db(struct mthca_dev *dev, enum mthca_db_type type,
178 		   u32 qn, __be32 **db);
179 void mthca_free_db(struct mthca_dev *dev, int type, int db_index);
180 
181 #endif /* MTHCA_MEMFREE_H */
182