[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;
struct vm_area_struct;

/*
 * 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_WC		5	/* continuous write-combined */
#ifdef CONFIG_SND_DMA_SGBUF
#define SNDRV_DMA_TYPE_DEV_SG		3	/* generic device SG-buffer */
#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
#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;
}

/* 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);
int snd_dma_buffer_mmap(struct snd_dma_buffer *dmab,
			struct vm_area_struct *area);

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_pages(struct device *dev, int type,
					    size_t size);

#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
83fbcaed TI	12	#include <asm/page.h>
83fbcaed TI	13
1da177e4	14	struct device;
a202bd1a	15	struct vm_area_struct;
1da177e4 LT	16
	17	/*
	18	* buffer device info
	19	*/
	20	struct snd_dma_device {
	21	int type; /* SNDRV_DMA_TYPE_XXX */
	22	struct device dev; / generic device */
	23	};
	24
019d80db	25	#define snd_dma_continuous_data(x) ((struct device *)(__force unsigned long)(x))
1da177e4 LT	26
	27
	28	/*
	29	* buffer types
	30	*/
	31	#define SNDRV_DMA_TYPE_UNKNOWN 0 /* not defined */
	32	#define SNDRV_DMA_TYPE_CONTINUOUS 1 /* continuous no-DMA memory */
	33	#define SNDRV_DMA_TYPE_DEV 2 /* generic device continuous */
58a95dfa	34	#define SNDRV_DMA_TYPE_DEV_WC 5 /* continuous write-combined */
cc6a8acd	35	#ifdef CONFIG_SND_DMA_SGBUF
1da177e4	36	#define SNDRV_DMA_TYPE_DEV_SG 3 /* generic device SG-buffer */
58a95dfa	37	#define SNDRV_DMA_TYPE_DEV_WC_SG 6 /* SG write-combined */
cc6a8acd TI	38	#else
cc6a8acd TI	39	#define SNDRV_DMA_TYPE_DEV_SG SNDRV_DMA_TYPE_DEV /* no SG-buf support */
58a95dfa	40	#define SNDRV_DMA_TYPE_DEV_WC_SG SNDRV_DMA_TYPE_DEV_WC
cc6a8acd	41	#endif
a5606f85	42	#ifdef CONFIG_GENERIC_ALLOCATOR
05503214	43	#define SNDRV_DMA_TYPE_DEV_IRAM 4 /* generic device iram-buffer */
a5606f85 TI	44	#else
	45	#define SNDRV_DMA_TYPE_DEV_IRAM SNDRV_DMA_TYPE_DEV
	46	#endif
1fe7f397	47	#define SNDRV_DMA_TYPE_VMALLOC 7 /* vmalloc'ed buffer */
1da177e4 LT	48
	49	/*
	50	* info for buffer allocation
	51	*/
	52	struct snd_dma_buffer {
	53	struct snd_dma_device dev; /* device type */
	54	unsigned char area; / virtual pointer */
	55	dma_addr_t addr; /* physical address */
	56	size_t bytes; /* buffer size in bytes */
	57	void private_data; / private for allocator; don't touch */
	58	};
	59
4cae99d9 PLB	60	/*
	61	* return the pages matching with the given byte size
	62	*/
	63	static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
	64	{
	65	return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
	66	}
	67
1da177e4 LT	68	/* allocate/release a buffer */
	69	int snd_dma_alloc_pages(int type, struct device *dev, size_t size,
	70	struct snd_dma_buffer *dmab);
	71	int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
	72	struct snd_dma_buffer *dmab);
	73	void snd_dma_free_pages(struct snd_dma_buffer *dmab);
a202bd1a TI	74	int snd_dma_buffer_mmap(struct snd_dma_buffer *dmab,
a202bd1a TI	75	struct vm_area_struct *area);
1da177e4	76
37af81c5 TI	77	dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab, size_t offset);
	78	struct page snd_sgbuf_get_page(struct snd_dma_buffer dmab, size_t offset);
	79	unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
	80	unsigned int ofs, unsigned int size);
	81
427ae268 TI	82	/* device-managed memory allocator */
	83	struct snd_dma_buffer snd_devm_alloc_pages(struct device dev, int type,
	84	size_t size);
	85
1da177e4 LT	86	#endif /* __SOUND_MEMALLOC_H */
1da177e4 LT	87