[linux-block.git] / include / linux / dma-fence-array.h

/*
 * fence-array: aggregates fence to be waited together
 *
 * Copyright (C) 2016 Collabora Ltd
 * Copyright (C) 2016 Advanced Micro Devices, Inc.
 * Authors:
 *	Gustavo Padovan <gustavo@padovan.org>
 *	Christian König <christian.koenig@amd.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */

#ifndef __LINUX_DMA_FENCE_ARRAY_H
#define __LINUX_DMA_FENCE_ARRAY_H

#include <linux/dma-fence.h>
#include <linux/irq_work.h>

/**
 * struct dma_fence_array_cb - callback helper for fence array
 * @cb: fence callback structure for signaling
 * @array: reference to the parent fence array object
 */
struct dma_fence_array_cb {
	struct dma_fence_cb cb;
	struct dma_fence_array *array;
};

/**
 * struct dma_fence_array - fence to represent an array of fences
 * @base: fence base class
 * @lock: spinlock for fence handling
 * @num_fences: number of fences in the array
 * @num_pending: fences in the array still pending
 * @fences: array of the fences
 * @work: internal irq_work function
 */
struct dma_fence_array {
	struct dma_fence base;

	spinlock_t lock;
	unsigned num_fences;
	atomic_t num_pending;
	struct dma_fence **fences;

	struct irq_work work;
};

extern const struct dma_fence_ops dma_fence_array_ops;

/**
 * dma_fence_is_array - check if a fence is from the array subsclass
 * @fence: fence to test
 *
 * Return true if it is a dma_fence_array and false otherwise.
 */
static inline bool dma_fence_is_array(struct dma_fence *fence)
{
	return fence->ops == &dma_fence_array_ops;
}

/**
 * to_dma_fence_array - cast a fence to a dma_fence_array
 * @fence: fence to cast to a dma_fence_array
 *
 * Returns NULL if the fence is not a dma_fence_array,
 * or the dma_fence_array otherwise.
 */
static inline struct dma_fence_array *
to_dma_fence_array(struct dma_fence *fence)
{
	if (fence->ops != &dma_fence_array_ops)
		return NULL;

	return container_of(fence, struct dma_fence_array, base);
}

struct dma_fence_array *dma_fence_array_create(int num_fences,
					       struct dma_fence **fences,
					       u64 context, unsigned seqno,
					       bool signal_on_any);

bool dma_fence_match_context(struct dma_fence *fence, u64 context);

#endif /* __LINUX_DMA_FENCE_ARRAY_H */
Commit	Line	Data
f54d1867 CW	1	/*
	2	* fence-array: aggregates fence to be waited together
	3	*
	4	* Copyright (C) 2016 Collabora Ltd
	5	* Copyright (C) 2016 Advanced Micro Devices, Inc.
	6	* Authors:
	7	* Gustavo Padovan <gustavo@padovan.org>
	8	* Christian König <christian.koenig@amd.com>
	9	*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License version 2 as published by
	12	* the Free Software Foundation.
	13	*
	14	* This program is distributed in the hope that it will be useful, but WITHOUT
	15	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	16	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	17	* more details.
	18	*/
	19
	20	#ifndef __LINUX_DMA_FENCE_ARRAY_H
	21	#define __LINUX_DMA_FENCE_ARRAY_H
	22
	23	#include <linux/dma-fence.h>
03e4e0a9	24	#include <linux/irq_work.h>
f54d1867 CW	25
	26	/**
	27	* struct dma_fence_array_cb - callback helper for fence array
	28	* @cb: fence callback structure for signaling
	29	* @array: reference to the parent fence array object
	30	*/
	31	struct dma_fence_array_cb {
	32	struct dma_fence_cb cb;
	33	struct dma_fence_array *array;
	34	};
	35
	36	/**
	37	* struct dma_fence_array - fence to represent an array of fences
	38	* @base: fence base class
	39	* @lock: spinlock for fence handling
	40	* @num_fences: number of fences in the array
	41	* @num_pending: fences in the array still pending
	42	* @fences: array of the fences
3725cd09	43	* @work: internal irq_work function
f54d1867 CW	44	*/
	45	struct dma_fence_array {
	46	struct dma_fence base;
	47
	48	spinlock_t lock;
	49	unsigned num_fences;
	50	atomic_t num_pending;
	51	struct dma_fence **fences;
03e4e0a9 CW	52
03e4e0a9 CW	53	struct irq_work work;
f54d1867 CW	54	};
	55
	56	extern const struct dma_fence_ops dma_fence_array_ops;
	57
	58	/**
	59	* dma_fence_is_array - check if a fence is from the array subsclass
	60	* @fence: fence to test
	61	*
	62	* Return true if it is a dma_fence_array and false otherwise.
	63	*/
	64	static inline bool dma_fence_is_array(struct dma_fence *fence)
	65	{
	66	return fence->ops == &dma_fence_array_ops;
	67	}
	68
	69	/**
	70	* to_dma_fence_array - cast a fence to a dma_fence_array
	71	* @fence: fence to cast to a dma_fence_array
	72	*
	73	* Returns NULL if the fence is not a dma_fence_array,
	74	* or the dma_fence_array otherwise.
	75	*/
	76	static inline struct dma_fence_array *
	77	to_dma_fence_array(struct dma_fence *fence)
	78	{
	79	if (fence->ops != &dma_fence_array_ops)
	80	return NULL;
	81
	82	return container_of(fence, struct dma_fence_array, base);
	83	}
	84
	85	struct dma_fence_array *dma_fence_array_create(int num_fences,
	86	struct dma_fence **fences,
	87	u64 context, unsigned seqno,
	88	bool signal_on_any);
	89
d5b72a21 PZ	90	bool dma_fence_match_context(struct dma_fence *fence, u64 context);
d5b72a21 PZ	91
f54d1867	92	#endif /* __LINUX_DMA_FENCE_ARRAY_H */