1 /*
2  * arch/arm/mach-tegra/include/mach/dma.h
3  *
4  * Copyright (c) 2008-2009, NVIDIA Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
19  */
20 
21 #ifndef __MACH_TEGRA_DMA_H
22 #define __MACH_TEGRA_DMA_H
23 
24 #include <linux/list.h>
25 
26 #if defined(CONFIG_TEGRA_SYSTEM_DMA)
27 
28 struct tegra_dma_req;
29 struct tegra_dma_channel;
30 
31 #define TEGRA_DMA_REQ_SEL_CNTR			0
32 #define TEGRA_DMA_REQ_SEL_I2S_2			1
33 #define TEGRA_DMA_REQ_SEL_I2S_1			2
34 #define TEGRA_DMA_REQ_SEL_SPD_I			3
35 #define TEGRA_DMA_REQ_SEL_UI_I			4
36 #define TEGRA_DMA_REQ_SEL_MIPI			5
37 #define TEGRA_DMA_REQ_SEL_I2S2_2		6
38 #define TEGRA_DMA_REQ_SEL_I2S2_1		7
39 #define TEGRA_DMA_REQ_SEL_UARTA			8
40 #define TEGRA_DMA_REQ_SEL_UARTB			9
41 #define TEGRA_DMA_REQ_SEL_UARTC			10
42 #define TEGRA_DMA_REQ_SEL_SPI			11
43 #define TEGRA_DMA_REQ_SEL_AC97			12
44 #define TEGRA_DMA_REQ_SEL_ACMODEM		13
45 #define TEGRA_DMA_REQ_SEL_SL4B			14
46 #define TEGRA_DMA_REQ_SEL_SL2B1			15
47 #define TEGRA_DMA_REQ_SEL_SL2B2			16
48 #define TEGRA_DMA_REQ_SEL_SL2B3			17
49 #define TEGRA_DMA_REQ_SEL_SL2B4			18
50 #define TEGRA_DMA_REQ_SEL_UARTD			19
51 #define TEGRA_DMA_REQ_SEL_UARTE			20
52 #define TEGRA_DMA_REQ_SEL_I2C			21
53 #define TEGRA_DMA_REQ_SEL_I2C2			22
54 #define TEGRA_DMA_REQ_SEL_I2C3			23
55 #define TEGRA_DMA_REQ_SEL_DVC_I2C		24
56 #define TEGRA_DMA_REQ_SEL_OWR			25
57 #define TEGRA_DMA_REQ_SEL_INVALID		31
58 
59 enum tegra_dma_mode {
60 	TEGRA_DMA_SHARED = 1,
61 	TEGRA_DMA_MODE_CONTINOUS = 2,
62 	TEGRA_DMA_MODE_ONESHOT = 4,
63 };
64 
65 enum tegra_dma_req_error {
66 	TEGRA_DMA_REQ_SUCCESS = 0,
67 	TEGRA_DMA_REQ_ERROR_ABORTED,
68 	TEGRA_DMA_REQ_INFLIGHT,
69 };
70 
71 enum tegra_dma_req_buff_status {
72 	TEGRA_DMA_REQ_BUF_STATUS_EMPTY = 0,
73 	TEGRA_DMA_REQ_BUF_STATUS_HALF_FULL,
74 	TEGRA_DMA_REQ_BUF_STATUS_FULL,
75 };
76 
77 struct tegra_dma_req {
78 	struct list_head node;
79 	unsigned int modid;
80 	int instance;
81 
82 	/* Called when the req is complete and from the DMA ISR context.
83 	 * When this is called the req structure is no longer queued by
84 	 * the DMA channel.
85 	 *
86 	 * State of the DMA depends on the number of req it has. If there are
87 	 * no DMA requests queued up, then it will STOP the DMA. It there are
88 	 * more requests in the DMA, then it will queue the next request.
89 	 */
90 	void (*complete)(struct tegra_dma_req *req);
91 
92 	/*  This is a called from the DMA ISR context when the DMA is still in
93 	 *  progress and is actively filling same buffer.
94 	 *
95 	 *  In case of continuous mode receive, this threshold is 1/2 the buffer
96 	 *  size. In other cases, this will not even be called as there is no
97 	 *  hardware support for it.
98 	 *
99 	 * In the case of continuous mode receive, if there is next req already
100 	 * queued, DMA programs the HW to use that req when this req is
101 	 * completed. If there is no "next req" queued, then DMA ISR doesn't do
102 	 * anything before calling this callback.
103 	 *
104 	 *	This is mainly used by the cases, where the clients has queued
105 	 *	only one req and want to get some sort of DMA threshold
106 	 *	callback to program the next buffer.
107 	 *
108 	 */
109 	void (*threshold)(struct tegra_dma_req *req);
110 
111 	/* 1 to copy to memory.
112 	 * 0 to copy from the memory to device FIFO */
113 	int to_memory;
114 
115 	void *virt_addr;
116 
117 	unsigned long source_addr;
118 	unsigned long dest_addr;
119 	unsigned long dest_wrap;
120 	unsigned long source_wrap;
121 	unsigned long source_bus_width;
122 	unsigned long dest_bus_width;
123 	unsigned long req_sel;
124 	unsigned int size;
125 
126 	/* Updated by the DMA driver on the conpletion of the request. */
127 	int bytes_transferred;
128 	int status;
129 
130 	/* DMA completion tracking information */
131 	int buffer_status;
132 
133 	/* Client specific data */
134 	void *dev;
135 };
136 
137 int tegra_dma_enqueue_req(struct tegra_dma_channel *ch,
138 	struct tegra_dma_req *req);
139 int tegra_dma_dequeue_req(struct tegra_dma_channel *ch,
140 	struct tegra_dma_req *req);
141 void tegra_dma_dequeue(struct tegra_dma_channel *ch);
142 void tegra_dma_flush(struct tegra_dma_channel *ch);
143 
144 bool tegra_dma_is_req_inflight(struct tegra_dma_channel *ch,
145 	struct tegra_dma_req *req);
146 bool tegra_dma_is_empty(struct tegra_dma_channel *ch);
147 
148 struct tegra_dma_channel *tegra_dma_allocate_channel(int mode);
149 void tegra_dma_free_channel(struct tegra_dma_channel *ch);
150 
151 int __init tegra_dma_init(void);
152 
153 #endif
154 
155 #endif
156