[deliverable/linux.git] / sound / pci / ctxfi / ctvmem.h

/**
 * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
 *
 * This source file is released under GPL v2 license (no other versions).
 * See the COPYING file included in the main directory of this source
 * distribution for the license terms and conditions.
 *
 * @File    ctvmem.h
 *
 * @Brief
 * This file contains the definition of virtual memory management object
 * for card device.
 *
 * @Author Liu Chun
 * @Date Mar 28 2008
 */

#ifndef CTVMEM_H
#define CTVMEM_H

#define CT_PTP_NUM	1	/* num of device page table pages */

#include <linux/mutex.h>
#include <linux/list.h>

/* The chip can handle the page table of 4k pages
 * (emu20k1 can handle even 8k pages, but we don't use it right now)
 */
#define CT_PAGE_SIZE	4096
#define CT_PAGE_SHIFT	12
#define CT_PAGE_MASK	(~(PAGE_SIZE - 1))
#define CT_PAGE_ALIGN(addr)	ALIGN(addr, CT_PAGE_SIZE)

struct ct_vm_block {
	unsigned int addr;	/* starting logical addr of this block */
	unsigned int size;	/* size of this device virtual mem block */
	struct list_head list;
};

struct snd_pcm_substream;

/* Virtual memory management object for card device */
struct ct_vm {
	void *ptp[CT_PTP_NUM];		/* Device page table pages */
	unsigned int size;		/* Available addr space in bytes */
	struct list_head unused;	/* List of unused blocks */
	struct list_head used;		/* List of used blocks */
	struct mutex lock;

	/* Map host addr (kmalloced/vmalloced) to device logical addr. */
	struct ct_vm_block *(*map)(struct ct_vm *, struct snd_pcm_substream *,
				   int size);
	/* Unmap device logical addr area. */
	void (*unmap)(struct ct_vm *, struct ct_vm_block *block);
	void *(*get_ptp_virt)(struct ct_vm *vm, int index);
};

int ct_vm_create(struct ct_vm **rvm);
void ct_vm_destroy(struct ct_vm *vm);

#endif /* CTVMEM_H */
Commit	Line	Data
8cc72361 WYC	1	/**
	2	* Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
	3	*
	4	* This source file is released under GPL v2 license (no other versions).
	5	* See the COPYING file included in the main directory of this source
	6	* distribution for the license terms and conditions.
	7	*
	8	* @File ctvmem.h
	9	*
	10	* @Brief
	11	* This file contains the definition of virtual memory management object
	12	* for card device.
	13	*
	14	* @Author Liu Chun
	15	* @Date Mar 28 2008
	16	*/
	17
	18	#ifndef CTVMEM_H
	19	#define CTVMEM_H
	20
	21	#define CT_PTP_NUM 1 /* num of device page table pages */
	22
8a4259bf	23	#include <linux/mutex.h>
8cc72361 WYC	24	#include <linux/list.h>
8cc72361 WYC	25
cd391e20 TI	26	/* The chip can handle the page table of 4k pages
	27	* (emu20k1 can handle even 8k pages, but we don't use it right now)
	28	*/
	29	#define CT_PAGE_SIZE 4096
	30	#define CT_PAGE_SHIFT 12
	31	#define CT_PAGE_MASK (~(PAGE_SIZE - 1))
	32	#define CT_PAGE_ALIGN(addr) ALIGN(addr, CT_PAGE_SIZE)
	33
8cc72361 WYC	34	struct ct_vm_block {
	35	unsigned int addr; /* starting logical addr of this block */
	36	unsigned int size; /* size of this device virtual mem block */
	37	struct list_head list;
	38	};
	39
c76157d9 TI	40	struct snd_pcm_substream;
c76157d9 TI	41
8cc72361 WYC	42	/* Virtual memory management object for card device */
	43	struct ct_vm {
	44	void ptp[CT_PTP_NUM]; / Device page table pages */
	45	unsigned int size; /* Available addr space in bytes */
	46	struct list_head unused; /* List of unused blocks */
	47	struct list_head used; /* List of used blocks */
8a4259bf	48	struct mutex lock;
8cc72361 WYC	49
8cc72361 WYC	50	/* Map host addr (kmalloced/vmalloced) to device logical addr. */
c76157d9 TI	51	struct ct_vm_block (map)(struct ct_vm , struct snd_pcm_substream ,
c76157d9 TI	52	int size);
8cc72361 WYC	53	/* Unmap device logical addr area. */
	54	void (unmap)(struct ct_vm , struct ct_vm_block *block);
	55	void (get_ptp_virt)(struct ct_vm *vm, int index);
	56	};
	57
	58	int ct_vm_create(struct ct_vm **rvm);
	59	void ct_vm_destroy(struct ct_vm *vm);
	60
	61	#endif /* CTVMEM_H */