[linux.git] / include / sound / memalloc.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *  Copyright (c) by Jaroslav Kysela <[email protected]>
 *                   Takashi Iwai <[email protected]>
 * 
 *  Generic memory allocators
 */

#ifndef __SOUND_MEMALLOC_H
#define __SOUND_MEMALLOC_H

#include <linux/dma-direction.h>
#include <asm/page.h>

struct device;
struct vm_area_struct;
struct sg_table;

/*
 * buffer device info
 */
struct snd_dma_device {
	int type;			/* SNDRV_DMA_TYPE_XXX */
	enum dma_data_direction dir;	/* DMA direction */
	bool need_sync;			/* explicit sync needed? */
	struct device *dev;		/* generic device */
};

/*
 * buffer types
 */
#define SNDRV_DMA_TYPE_UNKNOWN		0	/* not defined */
#define SNDRV_DMA_TYPE_CONTINUOUS	1	/* continuous no-DMA memory */
#define SNDRV_DMA_TYPE_DEV		2	/* generic device continuous */
#define SNDRV_DMA_TYPE_DEV_WC		5	/* continuous write-combined */
#ifdef CONFIG_GENERIC_ALLOCATOR
#define SNDRV_DMA_TYPE_DEV_IRAM		4	/* generic device iram-buffer */
#else
#define SNDRV_DMA_TYPE_DEV_IRAM	SNDRV_DMA_TYPE_DEV
#endif
#define SNDRV_DMA_TYPE_VMALLOC		7	/* vmalloc'ed buffer */
#define SNDRV_DMA_TYPE_NONCONTIG	8	/* non-coherent SG buffer */
#define SNDRV_DMA_TYPE_NONCOHERENT	9	/* non-coherent buffer */
#ifdef CONFIG_SND_DMA_SGBUF
#define SNDRV_DMA_TYPE_DEV_SG		SNDRV_DMA_TYPE_NONCONTIG
#define SNDRV_DMA_TYPE_DEV_WC_SG	6	/* SG write-combined */
#else
#define SNDRV_DMA_TYPE_DEV_SG	SNDRV_DMA_TYPE_DEV /* no SG-buf support */
#define SNDRV_DMA_TYPE_DEV_WC_SG	SNDRV_DMA_TYPE_DEV_WC
#endif
/* fallback types, don't use those directly */
#ifdef CONFIG_SND_DMA_SGBUF
#define SNDRV_DMA_TYPE_DEV_SG_FALLBACK		10
#define SNDRV_DMA_TYPE_DEV_WC_SG_FALLBACK	11
#endif

/*
 * info for buffer allocation
 */
struct snd_dma_buffer {
	struct snd_dma_device dev;	/* device type */
	unsigned char *area;	/* virtual pointer */
	dma_addr_t addr;	/* physical address */
	size_t bytes;		/* buffer size in bytes */
	void *private_data;	/* private for allocator; don't touch */
};

/*
 * return the pages matching with the given byte size
 */
static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
{
	return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
}

/* allocate/release a buffer */
int snd_dma_alloc_dir_pages(int type, struct device *dev,
			    enum dma_data_direction dir, size_t size,
			    struct snd_dma_buffer *dmab);

static inline int snd_dma_alloc_pages(int type, struct device *dev,
				      size_t size, struct snd_dma_buffer *dmab)
{
	return snd_dma_alloc_dir_pages(type, dev, DMA_BIDIRECTIONAL, size, dmab);
}

int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
                                 struct snd_dma_buffer *dmab);
void snd_dma_free_pages(struct snd_dma_buffer *dmab);
int snd_dma_buffer_mmap(struct snd_dma_buffer *dmab,
			struct vm_area_struct *area);

enum snd_dma_sync_mode { SNDRV_DMA_SYNC_CPU, SNDRV_DMA_SYNC_DEVICE };
#ifdef CONFIG_HAS_DMA
void snd_dma_buffer_sync(struct snd_dma_buffer *dmab,
			 enum snd_dma_sync_mode mode);
#else
static inline void snd_dma_buffer_sync(struct snd_dma_buffer *dmab,
				       enum snd_dma_sync_mode mode) {}
#endif

dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab, size_t offset);
struct page *snd_sgbuf_get_page(struct snd_dma_buffer *dmab, size_t offset);
unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
				      unsigned int ofs, unsigned int size);

/* device-managed memory allocator */
struct snd_dma_buffer *snd_devm_alloc_dir_pages(struct device *dev, int type,
						enum dma_data_direction dir,
						size_t size);

static inline struct snd_dma_buffer *
snd_devm_alloc_pages(struct device *dev, int type, size_t size)
{
	return snd_devm_alloc_dir_pages(dev, type, DMA_BIDIRECTIONAL, size);
}

static inline struct sg_table *
snd_dma_noncontig_sg_table(struct snd_dma_buffer *dmab)
{
	return dmab->private_data;
}

#endif /* __SOUND_MEMALLOC_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4	2	/*
c1017a4c	3	* Copyright (c) by Jaroslav Kysela <[email protected]>
1da177e4 LT	4	* Takashi Iwai <[email protected]>
	5	*
	6	* Generic memory allocators
1da177e4 LT	7	*/
	8
	9	#ifndef __SOUND_MEMALLOC_H
	10	#define __SOUND_MEMALLOC_H
	11
a25684a9	12	#include <linux/dma-direction.h>
83fbcaed TI	13	#include <asm/page.h>
83fbcaed TI	14
1da177e4	15	struct device;
a202bd1a	16	struct vm_area_struct;
a25684a9	17	struct sg_table;
1da177e4 LT	18
	19	/*
	20	* buffer device info
	21	*/
	22	struct snd_dma_device {
	23	int type; /* SNDRV_DMA_TYPE_XXX */
a25684a9 TI	24	enum dma_data_direction dir; /* DMA direction */
a25684a9 TI	25	bool need_sync; /* explicit sync needed? */
1da177e4 LT	26	struct device dev; / generic device */
	27	};
	28
1da177e4 LT	29	/*
	30	* buffer types
	31	*/
	32	#define SNDRV_DMA_TYPE_UNKNOWN 0 /* not defined */
	33	#define SNDRV_DMA_TYPE_CONTINUOUS 1 /* continuous no-DMA memory */
	34	#define SNDRV_DMA_TYPE_DEV 2 /* generic device continuous */
58a95dfa	35	#define SNDRV_DMA_TYPE_DEV_WC 5 /* continuous write-combined */
a5606f85	36	#ifdef CONFIG_GENERIC_ALLOCATOR
05503214	37	#define SNDRV_DMA_TYPE_DEV_IRAM 4 /* generic device iram-buffer */
a5606f85 TI	38	#else
	39	#define SNDRV_DMA_TYPE_DEV_IRAM SNDRV_DMA_TYPE_DEV
	40	#endif
1fe7f397	41	#define SNDRV_DMA_TYPE_VMALLOC 7 /* vmalloc'ed buffer */
a25684a9	42	#define SNDRV_DMA_TYPE_NONCONTIG 8 /* non-coherent SG buffer */
73325f60	43	#define SNDRV_DMA_TYPE_NONCOHERENT 9 /* non-coherent buffer */
2c95b92e TI	44	#ifdef CONFIG_SND_DMA_SGBUF
	45	#define SNDRV_DMA_TYPE_DEV_SG SNDRV_DMA_TYPE_NONCONTIG
	46	#define SNDRV_DMA_TYPE_DEV_WC_SG 6 /* SG write-combined */
	47	#else
	48	#define SNDRV_DMA_TYPE_DEV_SG SNDRV_DMA_TYPE_DEV /* no SG-buf support */
	49	#define SNDRV_DMA_TYPE_DEV_WC_SG SNDRV_DMA_TYPE_DEV_WC
	50	#endif
925ca893 TI	51	/* fallback types, don't use those directly */
	52	#ifdef CONFIG_SND_DMA_SGBUF
	53	#define SNDRV_DMA_TYPE_DEV_SG_FALLBACK 10
	54	#define SNDRV_DMA_TYPE_DEV_WC_SG_FALLBACK 11
	55	#endif
1da177e4 LT	56
	57	/*
	58	* info for buffer allocation
	59	*/
	60	struct snd_dma_buffer {
	61	struct snd_dma_device dev; /* device type */
	62	unsigned char area; / virtual pointer */
	63	dma_addr_t addr; /* physical address */
	64	size_t bytes; /* buffer size in bytes */
	65	void private_data; / private for allocator; don't touch */
	66	};
	67
4cae99d9 PLB	68	/*
	69	* return the pages matching with the given byte size
	70	*/
	71	static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
	72	{
	73	return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
	74	}
	75
1da177e4	76	/* allocate/release a buffer */
a25684a9 TI	77	int snd_dma_alloc_dir_pages(int type, struct device *dev,
	78	enum dma_data_direction dir, size_t size,
	79	struct snd_dma_buffer *dmab);
	80
	81	static inline int snd_dma_alloc_pages(int type, struct device *dev,
	82	size_t size, struct snd_dma_buffer *dmab)
	83	{
	84	return snd_dma_alloc_dir_pages(type, dev, DMA_BIDIRECTIONAL, size, dmab);
	85	}
	86
1da177e4 LT	87	int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
	88	struct snd_dma_buffer *dmab);
	89	void snd_dma_free_pages(struct snd_dma_buffer *dmab);
a202bd1a TI	90	int snd_dma_buffer_mmap(struct snd_dma_buffer *dmab,
a202bd1a TI	91	struct vm_area_struct *area);
1da177e4	92
a25684a9 TI	93	enum snd_dma_sync_mode { SNDRV_DMA_SYNC_CPU, SNDRV_DMA_SYNC_DEVICE };
	94	#ifdef CONFIG_HAS_DMA
	95	void snd_dma_buffer_sync(struct snd_dma_buffer *dmab,
	96	enum snd_dma_sync_mode mode);
	97	#else
	98	static inline void snd_dma_buffer_sync(struct snd_dma_buffer *dmab,
	99	enum snd_dma_sync_mode mode) {}
	100	#endif
	101
37af81c5 TI	102	dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab, size_t offset);
	103	struct page snd_sgbuf_get_page(struct snd_dma_buffer dmab, size_t offset);
	104	unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
	105	unsigned int ofs, unsigned int size);
	106
427ae268	107	/* device-managed memory allocator */
a25684a9 TI	108	struct snd_dma_buffer snd_devm_alloc_dir_pages(struct device dev, int type,
	109	enum dma_data_direction dir,
	110	size_t size);
	111
	112	static inline struct snd_dma_buffer *
	113	snd_devm_alloc_pages(struct device *dev, int type, size_t size)
	114	{
	115	return snd_devm_alloc_dir_pages(dev, type, DMA_BIDIRECTIONAL, size);
	116	}
	117
	118	static inline struct sg_table *
	119	snd_dma_noncontig_sg_table(struct snd_dma_buffer *dmab)
	120	{
	121	return dmab->private_data;
	122	}
427ae268	123
1da177e4 LT	124	#endif /* __SOUND_MEMALLOC_H */
1da177e4 LT	125