1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2007 by Will Robertson
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
29 #include "ata-target.h"
30 #include "ccm-imx31.h"
32 #include "sdma-imx31.h"
33 #include "mmu-imx31.h"
36 /* PIO modes timing info */
37 static const struct ata_pio_timings
39 uint16_t time_2w
; /* t2 during write */
40 uint16_t time_2r
; /* t2 during read */
41 uint8_t time_ax
; /* tA */
42 uint8_t time_1
; /* t1 */
43 uint8_t time_4
; /* t4 */
44 uint8_t time_9
; /* t9 */
47 [0] = /* PIO mode 0 */
56 [1] = /* PIO mode 1 */
65 [2] = /* PIO mode 2 */
74 [3] = /* PIO mode 3 */
83 [4] = /* PIO mode 4 */
94 /* Track first init */
95 static bool initialized
= false;
98 /* One DMA channel for reads, the other for writes othewise one channel would
99 * have to be reinitialized every time the direction changed. (Different
100 * SDMA scripts are used for reading or writing) */
101 #define ATA_DMA_CH_NUM_RD 3
102 #define ATA_DMA_CH_NUM_WR 4
103 /* Use default priority for these channels (1) - ATA isn't realtime urgent. */
104 /* Maximum DMA size per buffer descriptor (32-byte aligned) */
105 #define ATA_MAX_BD_SIZE (65534 & ~31) /* 65504 */
107 /* Number of buffer descriptors required for a maximum sector count trasfer.
108 * NOTE: Assumes LBA28 and 512-byte sectors! */
109 #define ATA_BASE_BD_COUNT ((256*512 + (ATA_MAX_BD_SIZE-1)) / ATA_MAX_BD_SIZE)
110 #define ATA_BD_COUNT (ATA_BASE_BD_COUNT + 2)
112 static const struct ata_mdma_timings
114 uint8_t time_m
; /* tM */
115 uint8_t time_jn
; /* tH */
116 uint8_t time_d
; /* tD */
117 uint8_t time_k
; /* tKW */
120 [0] = /* MDMA mode 0 */
127 [1] = /* MDMA mode 1 */
134 [2] = /* MDMA mode 2 */
143 static const struct ata_udma_timings
145 uint8_t time_ack
; /* tACK */
146 uint8_t time_env
; /* tENV */
147 uint8_t time_rpx
; /* tRP */
148 uint8_t time_zah
; /* tZAH */
149 uint8_t time_mlix
; /* tMLI */
150 uint8_t time_dvh
; /* tDVH */
151 uint8_t time_dzfs
; /* tDVS+tDVH? */
152 uint8_t time_dvs
; /* tDVS */
153 uint8_t time_cvh
; /* ?? */
154 uint8_t time_ss
; /* tSS */
155 uint8_t time_cyc
; /* tCYC */
158 [0] = /* UDMA mode 0 */
172 [1] = /* UDMA mode 1 */
186 [2] = /* UDMA mode 2 */
200 [3] = /* UDMA mode 3 */
214 [4] = /* UDMA mode 4 */
229 [5] = /* UDMA mode 5 (bus clock 80MHz or higher only) */
247 /* Signal to tell thread when DMA is done */
248 static struct wakeup ata_dma_wakeup
;
251 /* Array of buffer descriptors for large transfers and alignnment */
252 static struct buffer_descriptor ata_bda
[ATA_BD_COUNT
] NOCACHEBSS_ATTR
;
253 /* ATA channel descriptors */
254 /* Read/write channels share buffer descriptors and callbacks */
255 static void ata_dma_callback(void);
257 static struct channel_descriptor ata_cd_rd
= /* read channel */
259 .bd_count
= ATA_BD_COUNT
,
260 .callback
= ata_dma_callback
,
261 .shp_addr
= SDMA_PER_ADDR_ATA_RX
,
263 .per_type
= SDMA_PER_ATA
,
264 .tran_type
= SDMA_TRAN_PER_2_EMI
,
265 .event_id1
= SDMA_REQ_ATA_TXFER_END
,
266 .event_id2
= SDMA_REQ_ATA_RX
,
269 static struct channel_descriptor ata_cd_wr
= /* write channel */
271 .bd_count
= ATA_BD_COUNT
,
272 .callback
= ata_dma_callback
,
273 .shp_addr
= SDMA_PER_ADDR_ATA_TX
,
275 .per_type
= SDMA_PER_ATA
,
276 .tran_type
= SDMA_TRAN_EMI_2_PER
,
277 .event_id1
= SDMA_REQ_ATA_TXFER_END
,
278 .event_id2
= SDMA_REQ_ATA_TX
,
281 /* DMA channel to be started for transfer */
282 static unsigned int current_channel
= 0;
285 /* Scatter buffer for first and last 32 bytes of a non cache-aligned transfer
287 static uint32_t scatter_buffer
[32/4*2] NOCACHEBSS_ATTR
;
288 /* Address of ends in destination buffer for unaligned reads - copied after
290 static void *sb_dst
[2] = { NULL
, NULL
};
293 #define ATA_DMA_MWDMA 0x00000000 /* Using multiword DMA */
294 #define ATA_DMA_UDMA ATA_DMA_ULTRA_SELECTED /* Using Ultra DMA */
295 #define ATA_DMA_PIO 0x80000000 /* Using PIO */
296 #define ATA_DMA_DISABLED 0x80000001 /* DMA init error - use PIO */
297 static unsigned long ata_dma_selected
= ATA_DMA_PIO
;
298 #endif /* HAVE_ATA_DMA */
300 static unsigned int get_T(void)
302 /* T = ATA clock period in nanoseconds */
303 return 1000 * 1000 * 1000 / ccm_get_ata_clk();
306 static void ata_wait_for_idle(void)
308 while (!(ATA_INTERRUPT_PENDING
& ATA_CONTROLLER_IDLE
));
311 /* Route the INTRQ to either the MCU or SDMA depending upon whether there is
312 * a DMA transfer in progress. */
313 static inline void ata_set_intrq(bool to_dma
)
315 ATA_INTERRUPT_ENABLE
=
316 (ATA_INTERRUPT_ENABLE
& ~(ATA_INTRQ1
| ATA_INTRQ2
)) |
317 (to_dma
? ATA_INTRQ1
: ATA_INTRQ2
);
320 /* Setup the timing for PIO mode */
321 void ata_set_pio_timings(int mode
)
323 const struct ata_pio_timings
* const timings
= &pio_timings
[mode
];
324 unsigned int T
= get_T();
328 ATA_TIME_1
= (timings
->time_1
+ T
) / T
;
329 ATA_TIME_2W
= (timings
->time_2w
+ T
) / T
;
330 ATA_TIME_2R
= (timings
->time_2r
+ T
) / T
;
331 ATA_TIME_AX
= (timings
->time_ax
+ T
) / T
+ 2; /* 1.5 + tAX */
332 ATA_TIME_PIO_RDX
= 1;
333 ATA_TIME_4
= (timings
->time_4
+ T
) / T
;
334 ATA_TIME_9
= (timings
->time_9
+ T
) / T
;
339 /* Be sure we're not busy */
342 ATA_INTF_CONTROL
&= ~(ATA_ATA_RST
| ATA_FIFO_RST
);
344 ATA_INTF_CONTROL
= ATA_ATA_RST
| ATA_FIFO_RST
;
350 void ata_enable(bool on
)
352 /* Unconditionally clock module before writing regs */
353 ccm_module_clock_gating(CG_ATA
, CGM_ON_RUN_WAIT
);
358 ATA_INTF_CONTROL
= ATA_ATA_RST
| ATA_FIFO_RST
;
363 ATA_INTF_CONTROL
&= ~(ATA_ATA_RST
| ATA_FIFO_RST
);
366 /* Disable off - unclock ATA module */
367 ccm_module_clock_gating(CG_ATA
, CGM_OFF
);
371 bool ata_is_coldstart(void)
377 static void ata_set_mdma_timings(unsigned int mode
)
379 const struct ata_mdma_timings
* const timings
= &mdma_timings
[mode
];
380 unsigned int T
= get_T();
382 ATA_TIME_M
= (timings
->time_m
+ T
) / T
;
383 ATA_TIME_JN
= (timings
->time_jn
+ T
) / T
;
384 ATA_TIME_D
= (timings
->time_d
+ T
) / T
;
385 ATA_TIME_K
= (timings
->time_k
+ T
) / T
;
388 static void ata_set_udma_timings(unsigned int mode
)
390 const struct ata_udma_timings
* const timings
= &udma_timings
[mode
];
391 unsigned int T
= get_T();
393 ATA_TIME_ACK
= (timings
->time_ack
+ T
) / T
;
394 ATA_TIME_ENV
= (timings
->time_env
+ T
) / T
;
395 ATA_TIME_RPX
= (timings
->time_rpx
+ T
) / T
;
396 ATA_TIME_ZAH
= (timings
->time_zah
+ T
) / T
;
397 ATA_TIME_MLIX
= (timings
->time_mlix
+ T
) / T
;
398 ATA_TIME_DVH
= (timings
->time_dvh
+ T
) / T
+ 1;
399 ATA_TIME_DZFS
= (timings
->time_dzfs
+ T
) / T
;
400 ATA_TIME_DVS
= (timings
->time_dvs
+ T
) / T
;
401 ATA_TIME_CVH
= (timings
->time_cvh
+ T
) / T
;
402 ATA_TIME_SS
= (timings
->time_ss
+ T
) / T
;
403 ATA_TIME_CYC
= (timings
->time_cyc
+ T
) / T
;
406 void ata_dma_set_mode(unsigned char mode
)
408 unsigned int modeidx
= mode
& 0x07;
409 unsigned int dmamode
= mode
& 0xf8;
413 if (ata_dma_selected
== ATA_DMA_DISABLED
)
415 /* Configuration error - no DMA */
417 else if (dmamode
== 0x40 && modeidx
<= ATA_MAX_UDMA
)
419 /* Using Ultra DMA */
420 ata_set_udma_timings(dmamode
);
421 ata_dma_selected
= ATA_DMA_UDMA
;
423 else if (dmamode
== 0x20 && modeidx
<= ATA_MAX_MWDMA
)
425 /* Using Multiword DMA */
426 ata_set_mdma_timings(dmamode
);
427 ata_dma_selected
= ATA_DMA_MWDMA
;
431 /* Don't understand this - force PIO. */
432 ata_dma_selected
= ATA_DMA_PIO
;
436 /* Called by SDMA when transfer is complete */
437 static void ata_dma_callback(void)
439 /* Clear FIFO if not empty - shouldn't happen */
440 while (ATA_FIFO_FILL
!= 0)
443 /* Clear FIFO interrupts (the only ones that can be) */
444 ATA_INTERRUPT_CLEAR
= ATA_INTERRUPT_PENDING
;
446 ata_set_intrq(false); /* Return INTRQ to MCU */
447 wakeup_signal(&ata_dma_wakeup
); /* Signal waiting thread */
450 bool ata_dma_setup(void *addr
, unsigned long bytes
, bool write
)
452 struct buffer_descriptor
*bd_p
;
455 if (UNLIKELY(bytes
> ATA_BASE_BD_COUNT
*ATA_MAX_BD_SIZE
||
456 (ata_dma_selected
& ATA_DMA_PIO
)))
458 /* Too much? Implies BD count should be reevaluated since this
459 * shouldn't be reached based upon size. Otherwise we simply didn't
460 * understand the DMA mode setup. Force PIO in both cases. */
461 ATA_INTF_CONTROL
= ATA_FIFO_RST
| ATA_ATA_RST
;
466 buf
= (unsigned char *)addr_virt_to_phys((unsigned long)addr
);
467 sb_dst
[0] = NULL
; /* Assume not needed */
471 /* No cache alignment concerns */
472 current_channel
= ATA_DMA_CH_NUM_WR
;
474 if (LIKELY(buf
!= addr
))
476 /* addr is virtual */
477 clean_dcache_range(addr
, bytes
);
480 /* Setup ATA controller for DMA transmit */
481 ATA_INTF_CONTROL
= ATA_FIFO_RST
| ATA_ATA_RST
| ATA_FIFO_TX_EN
|
482 ATA_DMA_PENDING
| ata_dma_selected
| ATA_DMA_WRITE
;
483 ATA_FIFO_ALARM
= SDMA_ATA_WML
/ 2;
487 current_channel
= ATA_DMA_CH_NUM_RD
;
489 /* Setup ATA controller for DMA receive */
490 ATA_INTF_CONTROL
= ATA_FIFO_RST
| ATA_ATA_RST
| ATA_FIFO_RCV_EN
|
491 ATA_DMA_PENDING
| ata_dma_selected
;
492 ATA_FIFO_ALARM
= SDMA_ATA_WML
/ 2;
494 if (LIKELY(buf
!= addr
))
496 /* addr is virtual */
497 dump_dcache_range(addr
, bytes
);
499 if ((unsigned long)addr
& 31)
501 /* Not cache aligned, must use scatter buffers for first and
503 unsigned char *bufstart
= buf
;
506 bd_p
->buf_addr
= scatter_buffer
;
507 bd_p
->mode
.count
= 32;
508 bd_p
->mode
.status
= BD_DONE
| BD_CONT
;
514 while (bytes
> ATA_MAX_BD_SIZE
)
516 bd_p
->buf_addr
= buf
;
517 bd_p
->mode
.count
= ATA_MAX_BD_SIZE
;
518 bd_p
->mode
.status
= BD_DONE
| BD_CONT
;
519 buf
+= ATA_MAX_BD_SIZE
;
520 bytes
-= ATA_MAX_BD_SIZE
;
526 unsigned long size
= bytes
- 32;
527 bd_p
->buf_addr
= buf
;
528 bd_p
->mode
.count
= size
;
529 bd_p
->mode
.status
= BD_DONE
| BD_CONT
;
534 /* There will be exactly 32 bytes left */
536 /* Final buffer - wrap to base bd, interrupt */
537 sb_dst
[1] = addr
+ (buf
- bufstart
);
538 bd_p
->buf_addr
= &scatter_buffer
[32/4];
539 bd_p
->mode
.count
= 32;
540 bd_p
->mode
.status
= BD_DONE
| BD_WRAP
| BD_INTR
;
547 /* Setup buffer descriptors for both cache-aligned reads and all write
549 while (bytes
> ATA_MAX_BD_SIZE
)
551 bd_p
->buf_addr
= buf
;
552 bd_p
->mode
.count
= ATA_MAX_BD_SIZE
;
553 bd_p
->mode
.status
= BD_DONE
| BD_CONT
;
554 buf
+= ATA_MAX_BD_SIZE
;
555 bytes
-= ATA_MAX_BD_SIZE
;
559 /* Final buffer - wrap to base bd, interrupt */
560 bd_p
->buf_addr
= buf
;
561 bd_p
->mode
.count
= bytes
;
562 bd_p
->mode
.status
= BD_DONE
| BD_WRAP
| BD_INTR
;
567 bool ata_dma_finish(void)
569 unsigned int channel
= current_channel
;
570 long timeout
= current_tick
+ HZ
*10;
574 ata_set_intrq(true); /* Give INTRQ to DMA */
575 sdma_channel_run(channel
); /* Kick the channel to wait for events */
581 if (LIKELY(wakeup_wait(&ata_dma_wakeup
, HZ
/2) == OBJ_WAIT_SUCCEEDED
))
586 if (TIME_BEFORE(current_tick
, timeout
))
589 /* Epic fail - timed out - maybe. */
590 oldirq
= disable_irq_save();
591 ata_set_intrq(false); /* Strip INTRQ from DMA */
592 sdma_channel_stop(channel
); /* Stop DMA */
595 if (wakeup_wait(&ata_dma_wakeup
, TIMEOUT_NOBLOCK
) == OBJ_WAIT_SUCCEEDED
)
596 break; /* DMA really did finish after timeout */
598 sdma_channel_reset(channel
); /* Reset everything + clear error */
602 if (sdma_channel_is_error(channel
))
604 /* Channel error in one or more descriptors */
605 sdma_channel_reset(channel
); /* Reset everything + clear error */
609 if (sb_dst
[0] != NULL
)
611 /* NOTE: This requires that unaligned access support be enabled! */
612 register void *sbs
= scatter_buffer
;
613 register void *sbd0
= sb_dst
[0];
614 register void *sbd1
= sb_dst
[1];
616 "add r0, %1, #32 \n" /* Prefetch at DMA-direct boundaries */
617 "mcrr p15, 2, r0, r0, c12 \n"
618 "mcrr p15, 2, %2, %2, c12 \n"
619 "ldmia %0!, { r0-r3 } \n" /* Copy the 32-bytes to destination */
620 "str r0, [%1], #4 \n" /* stmia doesn't work unaligned */
621 "str r1, [%1], #4 \n"
622 "str r2, [%1], #4 \n"
623 "str r3, [%1], #4 \n"
624 "ldmia %0!, { r0-r3 } \n"
625 "str r0, [%1], #4 \n"
626 "str r1, [%1], #4 \n"
627 "str r2, [%1], #4 \n"
629 "ldmia %0!, { r0-r3 } \n" /* Copy the 32-bytes to destination */
630 "str r0, [%2], #4 \n" /* stmia doesn't work unaligned */
631 "str r1, [%2], #4 \n"
632 "str r2, [%2], #4 \n"
633 "str r3, [%2], #4 \n"
634 "ldmia %0!, { r0-r3 } \n"
635 "str r0, [%2], #4 \n"
636 "str r1, [%2], #4 \n"
637 "str r2, [%2], #4 \n"
639 : "+r"(sbs
), "+r"(sbd0
), "+r"(sbd1
)
641 : "r0", "r1", "r2", "r3");
646 #endif /* HAVE_ATA_DMA */
648 void ata_device_init(void)
650 /* Make sure we're not in reset mode */
655 ATA_INTERRUPT_ENABLE
= 0;
656 ATA_INTERRUPT_CLEAR
= ATA_INTERRUPT_PENDING
;
659 ata_set_intrq(false);
664 /* All modes use same tOFF/tON */
668 /* Setup mode 0 for all by default
669 * Mode may be switched later once identify info is ready in which
670 * case the main driver calls back */
671 ata_set_pio_timings(0);
674 ata_set_mdma_timings(0);
675 ata_set_udma_timings(0);
677 ata_dma_selected
= ATA_DMA_PIO
;
679 /* Called for first time at startup */
680 wakeup_init(&ata_dma_wakeup
);
682 if (!sdma_channel_init(ATA_DMA_CH_NUM_RD
, &ata_cd_rd
, ata_bda
) ||
683 !sdma_channel_init(ATA_DMA_CH_NUM_WR
, &ata_cd_wr
, ata_bda
))
685 /* Channel init error - disable DMA forever */
686 ata_dma_selected
= ATA_DMA_DISABLED
;
688 #endif /* HAVE_ATA_DMA */