[mirror_ubuntu-jammy-kernel.git] / include / sound / memalloc.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 *                   Takashi Iwai <tiwai@suse.de>
 * 
 *  Generic memory allocators
 */

#ifndef __SOUND_MEMALLOC_H
#define __SOUND_MEMALLOC_H

#include <asm/page.h>

struct device;

/*
 * buffer device info
 */
struct snd_dma_device {
	int type;			/* SNDRV_DMA_TYPE_XXX */
	struct device *dev;		/* generic device */
};

#define snd_dma_continuous_data(x)	((struct device *)(__force unsigned long)(x))


/*
 * 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_UC		5	/* continuous non-cahced */
#ifdef CONFIG_SND_DMA_SGBUF
#define SNDRV_DMA_TYPE_DEV_SG		3	/* generic device SG-buffer */
#define SNDRV_DMA_TYPE_DEV_UC_SG	6	/* SG non-cached */
#else
#define SNDRV_DMA_TYPE_DEV_SG	SNDRV_DMA_TYPE_DEV /* no SG-buf support */
#define SNDRV_DMA_TYPE_DEV_UC_SG	SNDRV_DMA_TYPE_DEV_UC
#endif
#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 */

/*
 * 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;
}

#ifdef CONFIG_SND_DMA_SGBUF
/*
 * Scatter-Gather generic device pages
 */
void *snd_malloc_sgbuf_pages(struct device *device,
			     size_t size, struct snd_dma_buffer *dmab,
			     size_t *res_size);
int snd_free_sgbuf_pages(struct snd_dma_buffer *dmab);

struct snd_sg_page {
	void *buf;
	dma_addr_t addr;
};

struct snd_sg_buf {
	int size;	/* allocated byte size */
	int pages;	/* allocated pages */
	int tblsize;	/* allocated table size */
	struct snd_sg_page *table;	/* address table */
	struct page **page_table;	/* page table (for vmap/vunmap) */
	struct device *dev;
};

/*
 * return the physical address at the corresponding offset
 */
static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
					   size_t offset)
{
	struct snd_sg_buf *sgbuf = dmab->private_data;
	dma_addr_t addr;

	if (!sgbuf)
		return dmab->addr + offset;
	addr = sgbuf->table[offset >> PAGE_SHIFT].addr;
	addr &= ~((dma_addr_t)PAGE_SIZE - 1);
	return addr + offset % PAGE_SIZE;
}

/*
 * return the virtual address at the corresponding offset
 */
static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
				     size_t offset)
{
	struct snd_sg_buf *sgbuf = dmab->private_data;

	if (!sgbuf)
		return dmab->area + offset;
	return sgbuf->table[offset >> PAGE_SHIFT].buf + offset % PAGE_SIZE;
}

unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
				      unsigned int ofs, unsigned int size);
#else
/* non-SG versions */
static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
					    size_t offset)
{
	return dmab->addr + offset;
}

static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
				      size_t offset)
{
	return dmab->area + offset;
}

#define snd_sgbuf_get_chunk_size(dmab, ofs, size)	(size)

#endif /* CONFIG_SND_DMA_SGBUF */

/* allocate/release a buffer */
int snd_dma_alloc_pages(int type, struct device *dev, size_t size,
			struct snd_dma_buffer *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);

#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 <perex@perex.cz>
1da177e4 LT	4	* Takashi Iwai <tiwai@suse.de>
	5	*
	6	* Generic memory allocators
1da177e4 LT	7	*/
	8
	9	#ifndef __SOUND_MEMALLOC_H
	10	#define __SOUND_MEMALLOC_H
	11
345a9ca3 TI	12	#include <asm/page.h>
345a9ca3 TI	13
1da177e4 LT	14	struct device;
	15
	16	/*
	17	* buffer device info
	18	*/
	19	struct snd_dma_device {
	20	int type; /* SNDRV_DMA_TYPE_XXX */
	21	struct device dev; / generic device */
	22	};
	23
019d80db	24	#define snd_dma_continuous_data(x) ((struct device *)(__force unsigned long)(x))
1da177e4 LT	25
	26
	27	/*
	28	* buffer types
	29	*/
	30	#define SNDRV_DMA_TYPE_UNKNOWN 0 /* not defined */
	31	#define SNDRV_DMA_TYPE_CONTINUOUS 1 /* continuous no-DMA memory */
	32	#define SNDRV_DMA_TYPE_DEV 2 /* generic device continuous */
42e748a0	33	#define SNDRV_DMA_TYPE_DEV_UC 5 /* continuous non-cahced */
cc6a8acd	34	#ifdef CONFIG_SND_DMA_SGBUF
1da177e4	35	#define SNDRV_DMA_TYPE_DEV_SG 3 /* generic device SG-buffer */
42e748a0	36	#define SNDRV_DMA_TYPE_DEV_UC_SG 6 /* SG non-cached */
cc6a8acd TI	37	#else
cc6a8acd TI	38	#define SNDRV_DMA_TYPE_DEV_SG SNDRV_DMA_TYPE_DEV /* no SG-buf support */
42e748a0	39	#define SNDRV_DMA_TYPE_DEV_UC_SG SNDRV_DMA_TYPE_DEV_UC
cc6a8acd	40	#endif
a5606f85	41	#ifdef CONFIG_GENERIC_ALLOCATOR
05503214	42	#define SNDRV_DMA_TYPE_DEV_IRAM 4 /* generic device iram-buffer */
a5606f85 TI	43	#else
	44	#define SNDRV_DMA_TYPE_DEV_IRAM SNDRV_DMA_TYPE_DEV
	45	#endif
1fe7f397	46	#define SNDRV_DMA_TYPE_VMALLOC 7 /* vmalloc'ed buffer */
1da177e4 LT	47
	48	/*
	49	* info for buffer allocation
	50	*/
	51	struct snd_dma_buffer {
	52	struct snd_dma_device dev; /* device type */
	53	unsigned char area; / virtual pointer */
	54	dma_addr_t addr; /* physical address */
	55	size_t bytes; /* buffer size in bytes */
	56	void private_data; / private for allocator; don't touch */
	57	};
	58
4cae99d9 PLB	59	/*
	60	* return the pages matching with the given byte size
	61	*/
	62	static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
	63	{
	64	return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
	65	}
	66
cc6a8acd	67	#ifdef CONFIG_SND_DMA_SGBUF
1da177e4 LT	68	/*
	69	* Scatter-Gather generic device pages
	70	*/
77a23f26 TI	71	void snd_malloc_sgbuf_pages(struct device device,
	72	size_t size, struct snd_dma_buffer *dmab,
	73	size_t *res_size);
	74	int snd_free_sgbuf_pages(struct snd_dma_buffer *dmab);
	75
1da177e4 LT	76	struct snd_sg_page {
	77	void *buf;
	78	dma_addr_t addr;
	79	};
	80
	81	struct snd_sg_buf {
	82	int size; /* allocated byte size */
	83	int pages; /* allocated pages */
	84	int tblsize; /* allocated table size */
	85	struct snd_sg_page table; / address table */
	86	struct page *page_table; / page table (for vmap/vunmap) */
	87	struct device *dev;
	88	};
	89
1da177e4 LT	90	/*
	91	* return the physical address at the corresponding offset
	92	*/
9d069dc0 TI	93	static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
9d069dc0 TI	94	size_t offset)
1da177e4	95	{
9d069dc0	96	struct snd_sg_buf *sgbuf = dmab->private_data;
2a1f3368 TI	97	dma_addr_t addr;
	98
	99	if (!sgbuf)
	100	return dmab->addr + offset;
	101	addr = sgbuf->table[offset >> PAGE_SHIFT].addr;
932e9dec	102	addr &= ~((dma_addr_t)PAGE_SIZE - 1);
51e9f2e6	103	return addr + offset % PAGE_SIZE;
1da177e4 LT	104	}
1da177e4 LT	105
77a23f26 TI	106	/*
	107	* return the virtual address at the corresponding offset
	108	*/
9d069dc0 TI	109	static inline void snd_sgbuf_get_ptr(struct snd_dma_buffer dmab,
9d069dc0 TI	110	size_t offset)
77a23f26	111	{
9d069dc0	112	struct snd_sg_buf *sgbuf = dmab->private_data;
2a1f3368 TI	113
	114	if (!sgbuf)
	115	return dmab->area + offset;
77a23f26 TI	116	return sgbuf->table[offset >> PAGE_SHIFT].buf + offset % PAGE_SIZE;
77a23f26 TI	117	}
9d069dc0 TI	118
	119	unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
	120	unsigned int ofs, unsigned int size);
	121	#else
	122	/* non-SG versions */
	123	static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
	124	size_t offset)
	125	{
	126	return dmab->addr + offset;
	127	}
	128
	129	static inline void snd_sgbuf_get_ptr(struct snd_dma_buffer dmab,
	130	size_t offset)
	131	{
	132	return dmab->area + offset;
	133	}
	134
	135	#define snd_sgbuf_get_chunk_size(dmab, ofs, size) (size)
	136
cc6a8acd	137	#endif /* CONFIG_SND_DMA_SGBUF */
1da177e4 LT	138
	139	/* allocate/release a buffer */
	140	int snd_dma_alloc_pages(int type, struct device *dev, size_t size,
	141	struct snd_dma_buffer *dmab);
	142	int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
	143	struct snd_dma_buffer *dmab);
	144	void snd_dma_free_pages(struct snd_dma_buffer *dmab);
	145
1da177e4 LT	146	#endif /* __SOUND_MEMALLOC_H */
1da177e4 LT	147