xref: /freebsd/sys/arm/broadcom/bcm2835/bcm2835_dma.h (revision 02e9120893770924227138ba49df1edb3896112a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2013 Daisuke Aoyama <aoyama@peach.ne.jp>
5  * Copyright (c) 2013 Oleksandr Tymoshenko <gonzo@bluezbox.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef	_BCM2835_DMA_H_
30 #define	_BCM2835_DMA_H_
31 
32 #define	BCM_DMA_BLOCK_SIZE	512
33 
34 /* DMA0-DMA15 but DMA15 is special */
35 #define	BCM_DMA_CH_MAX		12
36 
37 /* request CH for any nubmer */
38 #define	BCM_DMA_CH_INVALID	(-1)
39 #define	BCM_DMA_CH_ANY		(-1)
40 
41 /* Peripheral DREQ Signals (4.2.1.3) */
42 #define	BCM_DMA_DREQ_NONE	0
43 /*
44  * XXX This doesn't seem to work for the Raspberry Pi 4, but the peripheral
45  * documentation still lists it at 11.
46  */
47 #define	BCM_DMA_DREQ_EMMC	11
48 #define	BCM_DMA_DREQ_SDHOST	13
49 
50 #define	BCM_DMA_SAME_ADDR	0
51 #define	BCM_DMA_INC_ADDR	1
52 
53 #define	BCM_DMA_32BIT		0
54 #define	BCM_DMA_128BIT		1
55 
56 int bcm_dma_allocate(int req_ch);
57 int bcm_dma_free(int ch);
58 int bcm_dma_setup_intr(int ch, void (*func)(int, void *), void *arg);
59 int bcm_dma_setup_src(int ch, int dreq, int inc_addr, int width);
60 int bcm_dma_setup_dst(int ch, int dreq, int inc_addr, int width);
61 int bcm_dma_start(int ch, vm_paddr_t src, vm_paddr_t dst, int len);
62 uint32_t bcm_dma_length(int ch);
63 
64 #endif	/* _BCM2835_DMA_H_ */
65