[mirror_ubuntu-artful-kernel.git] / drivers / net / ethernet / mellanox / mlx4 / icm.h

/*
 * Copyright (c) 2005, 2006, 2007, 2008 Mellanox Technologies. All rights reserved.
 * Copyright (c) 2006, 2007 Cisco Systems, Inc.  All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef MLX4_ICM_H
#define MLX4_ICM_H

#include <linux/list.h>
#include <linux/pci.h>
#include <linux/mutex.h>

#define MLX4_ICM_CHUNK_LEN						\
	((256 - sizeof (struct list_head) - 2 * sizeof (int)) /		\
	 (sizeof (struct scatterlist)))

enum {
	MLX4_ICM_PAGE_SHIFT	= 12,
	MLX4_ICM_PAGE_SIZE	= 1 << MLX4_ICM_PAGE_SHIFT,
};

struct mlx4_icm_chunk {
	struct list_head	list;
	int			npages;
	int			nsg;
	struct scatterlist	mem[MLX4_ICM_CHUNK_LEN];
};

struct mlx4_icm {
	struct list_head	chunk_list;
	int			refcount;
};

struct mlx4_icm_iter {
	struct mlx4_icm	       *icm;
	struct mlx4_icm_chunk  *chunk;
	int			page_idx;
};

struct mlx4_dev;

struct mlx4_icm *mlx4_alloc_icm(struct mlx4_dev *dev, int npages,
				gfp_t gfp_mask, int coherent);
void mlx4_free_icm(struct mlx4_dev *dev, struct mlx4_icm *icm, int coherent);

int mlx4_table_get(struct mlx4_dev *dev, struct mlx4_icm_table *table, u32 obj);
void mlx4_table_put(struct mlx4_dev *dev, struct mlx4_icm_table *table, u32 obj);
int mlx4_table_get_range(struct mlx4_dev *dev, struct mlx4_icm_table *table,
			 u32 start, u32 end);
void mlx4_table_put_range(struct mlx4_dev *dev, struct mlx4_icm_table *table,
			  u32 start, u32 end);
int mlx4_init_icm_table(struct mlx4_dev *dev, struct mlx4_icm_table *table,
			u64 virt, int obj_size,	u32 nobj, int reserved,
			int use_lowmem, int use_coherent);
void mlx4_cleanup_icm_table(struct mlx4_dev *dev, struct mlx4_icm_table *table);
void *mlx4_table_find(struct mlx4_icm_table *table, u32 obj, dma_addr_t *dma_handle);

static inline void mlx4_icm_first(struct mlx4_icm *icm,
				  struct mlx4_icm_iter *iter)
{
	iter->icm      = icm;
	iter->chunk    = list_empty(&icm->chunk_list) ?
		NULL : list_entry(icm->chunk_list.next,
				  struct mlx4_icm_chunk, list);
	iter->page_idx = 0;
}

static inline int mlx4_icm_last(struct mlx4_icm_iter *iter)
{
	return !iter->chunk;
}

static inline void mlx4_icm_next(struct mlx4_icm_iter *iter)
{
	if (++iter->page_idx >= iter->chunk->nsg) {
		if (iter->chunk->list.next == &iter->icm->chunk_list) {
			iter->chunk = NULL;
			return;
		}

		iter->chunk = list_entry(iter->chunk->list.next,
					 struct mlx4_icm_chunk, list);
		iter->page_idx = 0;
	}
}

static inline dma_addr_t mlx4_icm_addr(struct mlx4_icm_iter *iter)
{
	return sg_dma_address(&iter->chunk->mem[iter->page_idx]);
}

static inline unsigned long mlx4_icm_size(struct mlx4_icm_iter *iter)
{
	return sg_dma_len(&iter->chunk->mem[iter->page_idx]);
}

int mlx4_MAP_ICM_AUX(struct mlx4_dev *dev, struct mlx4_icm *icm);
int mlx4_UNMAP_ICM_AUX(struct mlx4_dev *dev);

#endif /* MLX4_ICM_H */
Commit	Line	Data
225c7b1f	1	/*
51a379d0	2	* Copyright (c) 2005, 2006, 2007, 2008 Mellanox Technologies. All rights reserved.
225c7b1f RD	3	* Copyright (c) 2006, 2007 Cisco Systems, 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	#ifndef MLX4_ICM_H
	35	#define MLX4_ICM_H
	36
	37	#include <linux/list.h>
	38	#include <linux/pci.h>
	39	#include <linux/mutex.h>
	40
	41	#define MLX4_ICM_CHUNK_LEN \
	42	((256 - sizeof (struct list_head) - 2 * sizeof (int)) / \
	43	(sizeof (struct scatterlist)))
	44
	45	enum {
	46	MLX4_ICM_PAGE_SHIFT = 12,
	47	MLX4_ICM_PAGE_SIZE = 1 << MLX4_ICM_PAGE_SHIFT,
	48	};
	49
	50	struct mlx4_icm_chunk {
	51	struct list_head list;
	52	int npages;
	53	int nsg;
	54	struct scatterlist mem[MLX4_ICM_CHUNK_LEN];
	55	};
	56
	57	struct mlx4_icm {
	58	struct list_head chunk_list;
	59	int refcount;
	60	};
	61
	62	struct mlx4_icm_iter {
	63	struct mlx4_icm *icm;
	64	struct mlx4_icm_chunk *chunk;
	65	int page_idx;
	66	};
67
68	struct mlx4_dev;
69
5b0bf5e2 JM	70	struct mlx4_icm mlx4_alloc_icm(struct mlx4_dev dev, int npages,
	71	gfp_t gfp_mask, int coherent);
	72	void mlx4_free_icm(struct mlx4_dev dev, struct mlx4_icm icm, int coherent);
225c7b1f	73
8900b894	74	int mlx4_table_get(struct mlx4_dev dev, struct mlx4_icm_table table, u32 obj);
dd03e734	75	void mlx4_table_put(struct mlx4_dev dev, struct mlx4_icm_table table, u32 obj);
225c7b1f	76	int mlx4_table_get_range(struct mlx4_dev dev, struct mlx4_icm_table table,
dd03e734	77	u32 start, u32 end);
225c7b1f	78	void mlx4_table_put_range(struct mlx4_dev dev, struct mlx4_icm_table table,
dd03e734	79	u32 start, u32 end);
225c7b1f	80	int mlx4_init_icm_table(struct mlx4_dev dev, struct mlx4_icm_table table,
3de819e6	81	u64 virt, int obj_size, u32 nobj, int reserved,
5b0bf5e2	82	int use_lowmem, int use_coherent);
225c7b1f	83	void mlx4_cleanup_icm_table(struct mlx4_dev dev, struct mlx4_icm_table table);
dd03e734	84	void mlx4_table_find(struct mlx4_icm_table table, u32 obj, dma_addr_t *dma_handle);
225c7b1f RD	85
	86	static inline void mlx4_icm_first(struct mlx4_icm *icm,
	87	struct mlx4_icm_iter *iter)
	88	{
	89	iter->icm = icm;
	90	iter->chunk = list_empty(&icm->chunk_list) ?
	91	NULL : list_entry(icm->chunk_list.next,
	92	struct mlx4_icm_chunk, list);
	93	iter->page_idx = 0;
	94	}
	95
	96	static inline int mlx4_icm_last(struct mlx4_icm_iter *iter)
	97	{
	98	return !iter->chunk;
	99	}
	100
	101	static inline void mlx4_icm_next(struct mlx4_icm_iter *iter)
	102	{
	103	if (++iter->page_idx >= iter->chunk->nsg) {
	104	if (iter->chunk->list.next == &iter->icm->chunk_list) {
	105	iter->chunk = NULL;
	106	return;
	107	}
	108
	109	iter->chunk = list_entry(iter->chunk->list.next,
	110	struct mlx4_icm_chunk, list);
	111	iter->page_idx = 0;
	112	}
	113	}
	114
	115	static inline dma_addr_t mlx4_icm_addr(struct mlx4_icm_iter *iter)
	116	{
	117	return sg_dma_address(&iter->chunk->mem[iter->page_idx]);
	118	}
	119
	120	static inline unsigned long mlx4_icm_size(struct mlx4_icm_iter *iter)
	121	{
	122	return sg_dma_len(&iter->chunk->mem[iter->page_idx]);
	123	}
	124
225c7b1f RD	125	int mlx4_MAP_ICM_AUX(struct mlx4_dev dev, struct mlx4_icm icm);
	126	int mlx4_UNMAP_ICM_AUX(struct mlx4_dev *dev);
	127
	128	#endif /* MLX4_ICM_H */