xref: /OK3568_Linux_fs/kernel/sound/pci/ctxfi/ctvmem.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /**
3*4882a593Smuzhiyun  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * @File    ctvmem.h
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * @Brief
8*4882a593Smuzhiyun  * This file contains the definition of virtual memory management object
9*4882a593Smuzhiyun  * for card device.
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * @Author Liu Chun
12*4882a593Smuzhiyun  * @Date Mar 28 2008
13*4882a593Smuzhiyun  */
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #ifndef CTVMEM_H
16*4882a593Smuzhiyun #define CTVMEM_H
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #define CT_PTP_NUM	4	/* num of device page table pages */
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #include <linux/mutex.h>
21*4882a593Smuzhiyun #include <linux/list.h>
22*4882a593Smuzhiyun #include <linux/pci.h>
23*4882a593Smuzhiyun #include <sound/memalloc.h>
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun /* The chip can handle the page table of 4k pages
26*4882a593Smuzhiyun  * (emu20k1 can handle even 8k pages, but we don't use it right now)
27*4882a593Smuzhiyun  */
28*4882a593Smuzhiyun #define CT_PAGE_SIZE	4096
29*4882a593Smuzhiyun #define CT_PAGE_SHIFT	12
30*4882a593Smuzhiyun #define CT_PAGE_MASK	(~(PAGE_SIZE - 1))
31*4882a593Smuzhiyun #define CT_PAGE_ALIGN(addr)	ALIGN(addr, CT_PAGE_SIZE)
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun struct ct_vm_block {
34*4882a593Smuzhiyun 	unsigned int addr;	/* starting logical addr of this block */
35*4882a593Smuzhiyun 	unsigned int size;	/* size of this device virtual mem block */
36*4882a593Smuzhiyun 	struct list_head list;
37*4882a593Smuzhiyun };
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun struct snd_pcm_substream;
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /* Virtual memory management object for card device */
42*4882a593Smuzhiyun struct ct_vm {
43*4882a593Smuzhiyun 	struct snd_dma_buffer ptp[CT_PTP_NUM];	/* Device page table pages */
44*4882a593Smuzhiyun 	unsigned int size;		/* Available addr space in bytes */
45*4882a593Smuzhiyun 	struct list_head unused;	/* List of unused blocks */
46*4882a593Smuzhiyun 	struct list_head used;		/* List of used blocks */
47*4882a593Smuzhiyun 	struct mutex lock;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	/* Map host addr (kmalloced/vmalloced) to device logical addr. */
50*4882a593Smuzhiyun 	struct ct_vm_block *(*map)(struct ct_vm *, struct snd_pcm_substream *,
51*4882a593Smuzhiyun 				   int size);
52*4882a593Smuzhiyun 	/* Unmap device logical addr area. */
53*4882a593Smuzhiyun 	void (*unmap)(struct ct_vm *, struct ct_vm_block *block);
54*4882a593Smuzhiyun 	dma_addr_t (*get_ptp_phys)(struct ct_vm *vm, int index);
55*4882a593Smuzhiyun };
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun int ct_vm_create(struct ct_vm **rvm, struct pci_dev *pci);
58*4882a593Smuzhiyun void ct_vm_destroy(struct ct_vm *vm);
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun #endif /* CTVMEM_H */
61