[linux-2.6-block.git] / drivers / ieee1394 / dma.h

/*
 * DMA region bookkeeping routines
 *
 * Copyright (C) 2002 Maas Digital LLC
 *
 * This code is licensed under the GPL.  See the file COPYING in the root
 * directory of the kernel sources for details.
 */

#ifndef IEEE1394_DMA_H
#define IEEE1394_DMA_H

#include <asm/types.h>

struct file;
struct pci_dev;
struct scatterlist;
struct vm_area_struct;

/**
 * struct dma_prog_region - small contiguous DMA buffer
 * @kvirt:    kernel virtual address
 * @dev:      PCI device
 * @n_pages:  number of kernel pages
 * @bus_addr: base bus address
 *
 * a small, physically contiguous DMA buffer with random-access, synchronous
 * usage characteristics
 */
struct dma_prog_region {
	unsigned char *kvirt;
	struct pci_dev *dev;
	unsigned int n_pages;
	dma_addr_t bus_addr;
};

/* clear out all fields but do not allocate any memory */
void dma_prog_region_init(struct dma_prog_region *prog);
int dma_prog_region_alloc(struct dma_prog_region *prog, unsigned long n_bytes,
			  struct pci_dev *dev);
void dma_prog_region_free(struct dma_prog_region *prog);

static inline dma_addr_t dma_prog_region_offset_to_bus(
		struct dma_prog_region *prog, unsigned long offset)
{
	return prog->bus_addr + offset;
}

/**
 * struct dma_region - large non-contiguous DMA buffer
 * @virt:        kernel virtual address
 * @dev:         PCI device
 * @n_pages:     number of kernel pages
 * @n_dma_pages: number of IOMMU pages
 * @sglist:      IOMMU mapping
 * @direction:   PCI_DMA_TODEVICE, etc.
 *
 * a large, non-physically-contiguous DMA buffer with streaming, asynchronous
 * usage characteristics
 */
struct dma_region {
	unsigned char *kvirt;
	struct pci_dev *dev;
	unsigned int n_pages;
	unsigned int n_dma_pages;
	struct scatterlist *sglist;
	int direction;
};

void dma_region_init(struct dma_region *dma);
int dma_region_alloc(struct dma_region *dma, unsigned long n_bytes,
		     struct pci_dev *dev, int direction);
void dma_region_free(struct dma_region *dma);
void dma_region_sync_for_cpu(struct dma_region *dma, unsigned long offset,
			     unsigned long len);
void dma_region_sync_for_device(struct dma_region *dma, unsigned long offset,
				unsigned long len);
int  dma_region_mmap(struct dma_region *dma, struct file *file,
		     struct vm_area_struct *vma);
dma_addr_t dma_region_offset_to_bus(struct dma_region *dma,
				    unsigned long offset);

/**
 * dma_region_i - macro to index into a DMA region (or dma_prog_region)
 */
#define dma_region_i(_dma, _type, _index) \
	( ((_type*) ((_dma)->kvirt)) + (_index) )

#endif /* IEEE1394_DMA_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* DMA region bookkeeping routines
	3	*
	4	* Copyright (C) 2002 Maas Digital LLC
	5	*
	6	* This code is licensed under the GPL. See the file COPYING in the root
	7	* directory of the kernel sources for details.
	8	*/
	9
	10	#ifndef IEEE1394_DMA_H
	11	#define IEEE1394_DMA_H
	12
de4394f1 SR	13	#include <asm/types.h>
de4394f1 SR	14
612262a5	15	struct file;
de4394f1 SR	16	struct pci_dev;
	17	struct scatterlist;
	18	struct vm_area_struct;
1da177e4	19
e1d118f1 SR	20	/**
	21	* struct dma_prog_region - small contiguous DMA buffer
	22	* @kvirt: kernel virtual address
	23	* @dev: PCI device
	24	* @n_pages: number of kernel pages
	25	* @bus_addr: base bus address
	26	*
	27	* a small, physically contiguous DMA buffer with random-access, synchronous
	28	* usage characteristics
	29	*/
1da177e4	30	struct dma_prog_region {
e1d118f1 SR	31	unsigned char *kvirt;
	32	struct pci_dev *dev;
	33	unsigned int n_pages;
	34	dma_addr_t bus_addr;
1da177e4 LT	35	};
	36
	37	/* clear out all fields but do not allocate any memory */
	38	void dma_prog_region_init(struct dma_prog_region *prog);
e1d118f1 SR	39	int dma_prog_region_alloc(struct dma_prog_region *prog, unsigned long n_bytes,
e1d118f1 SR	40	struct pci_dev *dev);
1da177e4 LT	41	void dma_prog_region_free(struct dma_prog_region *prog);
1da177e4 LT	42
e1d118f1 SR	43	static inline dma_addr_t dma_prog_region_offset_to_bus(
e1d118f1 SR	44	struct dma_prog_region *prog, unsigned long offset)
1da177e4 LT	45	{
	46	return prog->bus_addr + offset;
	47	}
	48
e1d118f1 SR	49	/**
	50	* struct dma_region - large non-contiguous DMA buffer
	51	* @virt: kernel virtual address
	52	* @dev: PCI device
	53	* @n_pages: number of kernel pages
	54	* @n_dma_pages: number of IOMMU pages
	55	* @sglist: IOMMU mapping
	56	* @direction: PCI_DMA_TODEVICE, etc.
	57	*
	58	* a large, non-physically-contiguous DMA buffer with streaming, asynchronous
	59	* usage characteristics
	60	*/
1da177e4	61	struct dma_region {
e1d118f1 SR	62	unsigned char *kvirt;
	63	struct pci_dev *dev;
	64	unsigned int n_pages;
	65	unsigned int n_dma_pages;
	66	struct scatterlist *sglist;
	67	int direction;
1da177e4 LT	68	};
1da177e4 LT	69
1da177e4	70	void dma_region_init(struct dma_region *dma);
e1d118f1 SR	71	int dma_region_alloc(struct dma_region *dma, unsigned long n_bytes,
e1d118f1 SR	72	struct pci_dev *dev, int direction);
1da177e4	73	void dma_region_free(struct dma_region *dma);
e1d118f1 SR	74	void dma_region_sync_for_cpu(struct dma_region *dma, unsigned long offset,
e1d118f1 SR	75	unsigned long len);
e1d118f1 SR	76	void dma_region_sync_for_device(struct dma_region *dma, unsigned long offset,
e1d118f1 SR	77	unsigned long len);
e1d118f1 SR	78	int dma_region_mmap(struct dma_region dma, struct file file,
e1d118f1 SR	79	struct vm_area_struct *vma);
afd6546d SR	80	dma_addr_t dma_region_offset_to_bus(struct dma_region *dma,
afd6546d SR	81	unsigned long offset);
1da177e4	82
afd6546d SR	83	/**
	84	* dma_region_i - macro to index into a DMA region (or dma_prog_region)
	85	*/
e1d118f1 SR	86	#define dma_region_i(_dma, _type, _index) \
e1d118f1 SR	87	( ((_type*) ((_dma)->kvirt)) + (_index) )
1da177e4	88
1da177e4	89	#endif /* IEEE1394_DMA_H */