xref: /OK3568_Linux_fs/kernel/drivers/dma-buf/rk_heaps/rk-dma-heap.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * DMABUF Heaps Allocation Infrastructure
 *
 * Copyright (C) 2011 Google, Inc.
 * Copyright (C) 2019 Linaro Ltd.
 * Copyright (C) 2022 Rockchip Electronics Co. Ltd.
 * Author: Simon Xue <xxm@rock-chips.com>
 */

#ifndef _RK_DMA_HEAPS_H
#define _RK_DMA_HEAPS_H

#include <linux/cdev.h>
#include <linux/types.h>
#include <linux/dma-buf.h>
#include <linux/rk-dma-heap.h>

#if defined(CONFIG_DMABUF_RK_HEAPS_DEBUG_PRINT)
#define dma_heap_print(fmt, ...)	\
	printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
#else
#define dma_heap_print(fmt, ...)	\
	no_printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
#endif

#define RK_DMA_HEAP_NAME_LEN 16

struct rk_vmap_pfn_data {
	unsigned long	pfn; /* first pfn of contiguous */
	pgprot_t	prot;
};

/**
 * struct rk_dma_heap_ops - ops to operate on a given heap
 * @allocate:		allocate dmabuf and return struct dma_buf ptr
 * @get_pool_size:	if heap maintains memory pools, get pool size in bytes
 *
 * allocate returns dmabuf on success, ERR_PTR(-errno) on error.
 */
struct rk_dma_heap_ops {
	struct dma_buf *(*allocate)(struct rk_dma_heap *heap,
			unsigned long len,
			unsigned long fd_flags,
			unsigned long heap_flags,
			const char *name);
	struct page *(*alloc_contig_pages)(struct rk_dma_heap *heap,
					   size_t len, const char *name);
	void (*free_contig_pages)(struct rk_dma_heap *heap,
				  struct page *pages, size_t len,
				  const char *name);
	long (*get_pool_size)(struct rk_dma_heap *heap);
};

/**
 * struct rk_dma_heap_export_info - information needed to export a new dmabuf heap
 * @name:	used for debugging/device-node name
 * @ops:	ops struct for this heap
 * @priv:	heap exporter private data
 *
 * Information needed to export a new dmabuf heap.
 */
struct rk_dma_heap_export_info {
	const char *name;
	const struct rk_dma_heap_ops *ops;
	void *priv;
	bool support_cma;
};

/**
 * struct rk_dma_heap - represents a dmabuf heap in the system
 * @name:		used for debugging/device-node name
 * @ops:		ops struct for this heap
 * @heap_devt		heap device node
 * @list		list head connecting to list of heaps
 * @heap_cdev		heap char device
 * @heap_dev		heap device struct
 *
 * Represents a heap of memory from which buffers can be made.
 */
struct rk_dma_heap {
	const char *name;
	const struct rk_dma_heap_ops *ops;
	void *priv;
	dev_t heap_devt;
	struct list_head list;
	struct list_head dmabuf_list; /* dmabuf attach to this node */
	struct mutex dmabuf_lock;
	struct list_head contig_list; /* contig buffer attach to this node */
	struct mutex contig_lock;
	struct cdev heap_cdev;
	struct kref refcount;
	struct device *heap_dev;
	bool support_cma;
	struct seq_file *s;
	struct proc_dir_entry *procfs;
	unsigned long total_size;
};

struct rk_dma_heap_dmabuf {
	struct list_head node;
	struct dma_buf *dmabuf;
	const char *orig_alloc;
	phys_addr_t start;
	phys_addr_t end;
};

struct rk_dma_heap_contig_buf {
	struct list_head node;
	const char *orig_alloc;
	phys_addr_t start;
	phys_addr_t end;
};

/**
 * rk_dma_heap_get_drvdata() - get per-heap driver data
 * @heap: DMA-Heap to retrieve private data for
 *
 * Returns:
 * The per-heap data for the heap.
 */
void *rk_dma_heap_get_drvdata(struct rk_dma_heap *heap);

/**
 * rk_dma_heap_get_dev() - get device struct for the heap
 * @heap: DMA-Heap to retrieve device struct from
 *
 * Returns:
 * The device struct for the heap.
 */
struct device *rk_dma_heap_get_dev(struct rk_dma_heap *heap);

/**
 * rk_dma_heap_get_name() - get heap name
 * @heap: DMA-Heap to retrieve private data for
 *
 * Returns:
 * The char* for the heap name.
 */
const char *rk_dma_heap_get_name(struct rk_dma_heap *heap);

/**
 * rk_dma_heap_add - adds a heap to dmabuf heaps
 * @exp_info:		information needed to register this heap
 */
struct rk_dma_heap *rk_dma_heap_add(const struct rk_dma_heap_export_info *exp_info);

/**
 * rk_dma_heap_put - drops a reference to a dmabuf heaps, potentially freeing it
 * @heap:		heap pointer
 */
void rk_dma_heap_put(struct rk_dma_heap *heap);

/**
 * rk_vmap_contig_pfn - Map contiguous pfn to vm area
 * @pfn:	indicate the first pfn of contig
 * @count:	count of pfns
 * @prot:	for mapping
 */
void *rk_vmap_contig_pfn(unsigned long pfn, unsigned int count,
				 pgprot_t prot);
/**
 * rk_dma_heap_total_inc - Increase total buffer size
 * @heap:	dma_heap to increase
 * @len:	length to increase
 */
void rk_dma_heap_total_inc(struct rk_dma_heap *heap, size_t len);
/**
 * rk_dma_heap_total_dec - Decrease total buffer size
 * @heap:	dma_heap to decrease
 * @len:	length to decrease
 */
void rk_dma_heap_total_dec(struct rk_dma_heap *heap, size_t len);
/**
 * rk_dma_heap_get_cma - get cma structure
 */
struct cma *rk_dma_heap_get_cma(void);
#endif /* _DMA_HEAPS_H */