2 * MUSB OTG driver - support for Mentor's DMA controller
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2007 by Texas Instruments
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
24 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
27 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
28 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <linux/device.h>
34 #include <linux/interrupt.h>
35 #include <linux/platform_device.h>
36 #include "musb_core.h"
38 #if defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP3430)
42 #define MUSB_HSDMA_BASE 0x200
43 #define MUSB_HSDMA_INTR (MUSB_HSDMA_BASE + 0)
44 #define MUSB_HSDMA_CONTROL 0x4
45 #define MUSB_HSDMA_ADDRESS 0x8
46 #define MUSB_HSDMA_COUNT 0xc
48 #define MUSB_HSDMA_CHANNEL_OFFSET(_bchannel, _offset) \
49 (MUSB_HSDMA_BASE + (_bchannel << 4) + _offset)
51 /* control register (16-bit): */
52 #define MUSB_HSDMA_ENABLE_SHIFT 0
53 #define MUSB_HSDMA_TRANSMIT_SHIFT 1
54 #define MUSB_HSDMA_MODE1_SHIFT 2
55 #define MUSB_HSDMA_IRQENABLE_SHIFT 3
56 #define MUSB_HSDMA_ENDPOINT_SHIFT 4
57 #define MUSB_HSDMA_BUSERROR_SHIFT 8
58 #define MUSB_HSDMA_BURSTMODE_SHIFT 9
59 #define MUSB_HSDMA_BURSTMODE (3 << MUSB_HSDMA_BURSTMODE_SHIFT)
60 #define MUSB_HSDMA_BURSTMODE_UNSPEC 0
61 #define MUSB_HSDMA_BURSTMODE_INCR4 1
62 #define MUSB_HSDMA_BURSTMODE_INCR8 2
63 #define MUSB_HSDMA_BURSTMODE_INCR16 3
65 #define MUSB_HSDMA_CHANNELS 8
67 struct musb_dma_controller;
69 struct musb_dma_channel {
70 struct dma_channel channel;
71 struct musb_dma_controller *controller;
80 struct musb_dma_controller {
81 struct dma_controller controller;
82 struct musb_dma_channel channel[MUSB_HSDMA_CHANNELS];
90 static int dma_controller_start(struct dma_controller *c)
96 static void dma_channel_release(struct dma_channel *channel);
98 static int dma_controller_stop(struct dma_controller *c)
100 struct musb_dma_controller *controller = container_of(c,
101 struct musb_dma_controller, controller);
102 struct musb *musb = controller->private_data;
103 struct dma_channel *channel;
106 if (controller->used_channels != 0) {
107 dev_err(musb->controller,
108 "Stopping DMA controller while channel active\n");
110 for (bit = 0; bit < MUSB_HSDMA_CHANNELS; bit++) {
111 if (controller->used_channels & (1 << bit)) {
112 channel = &controller->channel[bit].channel;
113 dma_channel_release(channel);
115 if (!controller->used_channels)
124 static struct dma_channel *dma_channel_allocate(struct dma_controller *c,
125 struct musb_hw_ep *hw_ep, u8 transmit)
127 struct musb_dma_controller *controller = container_of(c,
128 struct musb_dma_controller, controller);
129 struct musb_dma_channel *musb_channel = NULL;
130 struct dma_channel *channel = NULL;
133 for (bit = 0; bit < MUSB_HSDMA_CHANNELS; bit++) {
134 if (!(controller->used_channels & (1 << bit))) {
135 controller->used_channels |= (1 << bit);
136 musb_channel = &(controller->channel[bit]);
137 musb_channel->controller = controller;
138 musb_channel->idx = bit;
139 musb_channel->epnum = hw_ep->epnum;
140 musb_channel->transmit = transmit;
141 channel = &(musb_channel->channel);
142 channel->private_data = musb_channel;
143 channel->status = MUSB_DMA_STATUS_FREE;
144 channel->max_len = 0x10000;
145 /* Tx => mode 1; Rx => mode 0 */
146 channel->desired_mode = transmit;
147 channel->actual_len = 0;
155 static void dma_channel_release(struct dma_channel *channel)
157 struct musb_dma_channel *musb_channel = channel->private_data;
159 channel->actual_len = 0;
160 musb_channel->start_addr = 0;
161 musb_channel->len = 0;
163 musb_channel->controller->used_channels &=
164 ~(1 << musb_channel->idx);
166 channel->status = MUSB_DMA_STATUS_UNKNOWN;
169 static void configure_channel(struct dma_channel *channel,
170 u16 packet_sz, u8 mode,
171 dma_addr_t dma_addr, u32 len)
173 struct musb_dma_channel *musb_channel = channel->private_data;
174 struct musb_dma_controller *controller = musb_channel->controller;
175 void __iomem *mbase = controller->base;
176 u8 bchannel = musb_channel->idx;
179 DBG(4, "%p, pkt_sz %d, addr 0x%x, len %d, mode %d\n",
180 channel, packet_sz, dma_addr, len, mode);
183 csr |= 1 << MUSB_HSDMA_MODE1_SHIFT;
184 BUG_ON(len < packet_sz);
186 if (packet_sz >= 64) {
187 csr |= MUSB_HSDMA_BURSTMODE_INCR16
188 << MUSB_HSDMA_BURSTMODE_SHIFT;
189 } else if (packet_sz >= 32) {
190 csr |= MUSB_HSDMA_BURSTMODE_INCR8
191 << MUSB_HSDMA_BURSTMODE_SHIFT;
192 } else if (packet_sz >= 16) {
193 csr |= MUSB_HSDMA_BURSTMODE_INCR4
194 << MUSB_HSDMA_BURSTMODE_SHIFT;
198 csr |= (musb_channel->epnum << MUSB_HSDMA_ENDPOINT_SHIFT)
199 | (1 << MUSB_HSDMA_ENABLE_SHIFT)
200 | (1 << MUSB_HSDMA_IRQENABLE_SHIFT)
201 | (musb_channel->transmit
202 ? (1 << MUSB_HSDMA_TRANSMIT_SHIFT)
207 MUSB_HSDMA_CHANNEL_OFFSET(bchannel, MUSB_HSDMA_ADDRESS),
210 MUSB_HSDMA_CHANNEL_OFFSET(bchannel, MUSB_HSDMA_COUNT),
213 /* control (this should start things) */
215 MUSB_HSDMA_CHANNEL_OFFSET(bchannel, MUSB_HSDMA_CONTROL),
219 static int dma_channel_program(struct dma_channel *channel,
220 u16 packet_sz, u8 mode,
221 dma_addr_t dma_addr, u32 len)
223 struct musb_dma_channel *musb_channel = channel->private_data;
225 DBG(2, "ep%d-%s pkt_sz %d, dma_addr 0x%x length %d, mode %d\n",
227 musb_channel->transmit ? "Tx" : "Rx",
228 packet_sz, dma_addr, len, mode);
230 BUG_ON(channel->status == MUSB_DMA_STATUS_UNKNOWN ||
231 channel->status == MUSB_DMA_STATUS_BUSY);
233 channel->actual_len = 0;
234 musb_channel->start_addr = dma_addr;
235 musb_channel->len = len;
236 musb_channel->max_packet_sz = packet_sz;
237 channel->status = MUSB_DMA_STATUS_BUSY;
239 if ((mode == 1) && (len >= packet_sz))
240 configure_channel(channel, packet_sz, 1, dma_addr, len);
242 configure_channel(channel, packet_sz, 0, dma_addr, len);
247 static int dma_channel_abort(struct dma_channel *channel)
249 struct musb_dma_channel *musb_channel = channel->private_data;
250 void __iomem *mbase = musb_channel->controller->base;
252 u8 bchannel = musb_channel->idx;
255 if (channel->status == MUSB_DMA_STATUS_BUSY) {
256 if (musb_channel->transmit) {
258 csr = musb_readw(mbase,
259 MUSB_EP_OFFSET(musb_channel->epnum,
261 csr &= ~(MUSB_TXCSR_AUTOSET |
265 MUSB_EP_OFFSET(musb_channel->epnum, MUSB_TXCSR),
268 csr = musb_readw(mbase,
269 MUSB_EP_OFFSET(musb_channel->epnum,
271 csr &= ~(MUSB_RXCSR_AUTOCLEAR |
275 MUSB_EP_OFFSET(musb_channel->epnum, MUSB_RXCSR),
280 MUSB_HSDMA_CHANNEL_OFFSET(bchannel, MUSB_HSDMA_CONTROL),
283 MUSB_HSDMA_CHANNEL_OFFSET(bchannel, MUSB_HSDMA_ADDRESS),
286 MUSB_HSDMA_CHANNEL_OFFSET(bchannel, MUSB_HSDMA_COUNT),
289 channel->status = MUSB_DMA_STATUS_FREE;
295 static irqreturn_t dma_controller_irq(int irq, void *private_data)
297 struct musb_dma_controller *controller = private_data;
298 struct musb *musb = controller->private_data;
299 struct musb_dma_channel *musb_channel;
300 struct dma_channel *channel;
302 void __iomem *mbase = controller->base;
304 irqreturn_t retval = IRQ_NONE;
314 spin_lock_irqsave(&musb->lock, flags);
316 int_hsdma = musb_readb(mbase, MUSB_HSDMA_INTR);
320 for (bchannel = 0; bchannel < MUSB_HSDMA_CHANNELS; bchannel++) {
321 if (int_hsdma & (1 << bchannel)) {
322 musb_channel = (struct musb_dma_channel *)
323 &(controller->channel[bchannel]);
324 channel = &musb_channel->channel;
326 csr = musb_readw(mbase,
327 MUSB_HSDMA_CHANNEL_OFFSET(bchannel,
328 MUSB_HSDMA_CONTROL));
330 if (csr & (1 << MUSB_HSDMA_BUSERROR_SHIFT)) {
331 musb_channel->channel.status =
332 MUSB_DMA_STATUS_BUS_ABORT;
336 addr = musb_readl(mbase,
337 MUSB_HSDMA_CHANNEL_OFFSET(
339 MUSB_HSDMA_ADDRESS));
340 channel->actual_len = addr
341 - musb_channel->start_addr;
343 DBG(2, "ch %p, 0x%x -> 0x%x (%d / %d) %s\n",
344 channel, musb_channel->start_addr,
345 addr, channel->actual_len,
348 < musb_channel->len) ?
349 "=> reconfig 0" : "=> complete");
351 devctl = musb_readb(mbase, MUSB_DEVCTL);
353 channel->status = MUSB_DMA_STATUS_FREE;
356 if ((devctl & MUSB_DEVCTL_HM)
357 && (musb_channel->transmit)
358 && ((channel->desired_mode == 0)
359 || (channel->actual_len &
360 (musb_channel->max_packet_sz - 1)))
362 /* Send out the packet */
363 musb_ep_select(mbase,
364 musb_channel->epnum);
365 musb_writew(mbase, MUSB_EP_OFFSET(
368 MUSB_TXCSR_TXPKTRDY);
373 musb_channel->transmit);
378 retval = IRQ_HANDLED;
380 spin_unlock_irqrestore(&musb->lock, flags);
384 void dma_controller_destroy(struct dma_controller *c)
386 struct musb_dma_controller *controller = container_of(c,
387 struct musb_dma_controller, controller);
393 free_irq(controller->irq, c);
398 struct dma_controller *__init
399 dma_controller_create(struct musb *musb, void __iomem *base)
401 struct musb_dma_controller *controller;
402 struct device *dev = musb->controller;
403 struct platform_device *pdev = to_platform_device(dev);
404 int irq = platform_get_irq(pdev, 1);
407 dev_err(dev, "No DMA interrupt line!\n");
411 controller = kzalloc(sizeof(*controller), GFP_KERNEL);
415 controller->channel_count = MUSB_HSDMA_CHANNELS;
416 controller->private_data = musb;
417 controller->base = base;
419 controller->controller.start = dma_controller_start;
420 controller->controller.stop = dma_controller_stop;
421 controller->controller.channel_alloc = dma_channel_allocate;
422 controller->controller.channel_release = dma_channel_release;
423 controller->controller.channel_program = dma_channel_program;
424 controller->controller.channel_abort = dma_channel_abort;
426 if (request_irq(irq, dma_controller_irq, IRQF_DISABLED,
427 musb->controller->bus_id, &controller->controller)) {
428 dev_err(dev, "request_irq %d failed!\n", irq);
429 dma_controller_destroy(&controller->controller);
434 controller->irq = irq;
436 return &controller->controller;