1 /******************************************************************************
3 * Copyright (C) 2013 - 2014 Xilinx, Inc. All rights reserved.
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * Use of the Software is limited solely to applications:
16 * (a) running on a Xilinx device, or
17 * (b) that interact with a Xilinx device through a bus or interconnect.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * XILINX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * Except as contained in this notice, the name of the Xilinx shall not be used
28 * in advertising or otherwise to promote the sale, use or other dealings in
29 * this Software without prior written authorization from Xilinx.
31 ******************************************************************************/
32 /*****************************************************************************/
35 * @file xsdps_options.c
37 * Contains API's for changing the various options in host and card.
38 * See xsdps.h for a detailed description of the device and driver.
41 * MODIFICATION HISTORY:
43 * Ver Who Date Changes
44 * ----- --- -------- -----------------------------------------------
45 * 1.00a hk/sg 10/17/13 Initial release
46 * 2.1 hk 04/18/14 Increase sleep for eMMC switch command.
47 * Add sleep for microblaze designs. CR# 781117.
51 ******************************************************************************/
53 /***************************** Include Files *********************************/
56 * The header sleep.h and API usleep() can only be used with an arm design.
57 * MB_Sleep() is used for microblaze design.
67 #include "microblaze_sleep.h"
71 /************************** Constant Definitions *****************************/
72 #define XSDPS_SCR_BLKCNT 1
73 #define XSDPS_SCR_BLKSIZE 8
74 #define XSDPS_4_BIT_WIDTH 0x2
75 #define XSDPS_SWITCH_CMD_BLKCNT 1
76 #define XSDPS_SWITCH_CMD_BLKSIZE 64
77 #define XSDPS_SWITCH_CMD_HS_GET 0x00FFFFF0
78 #define XSDPS_SWITCH_CMD_HS_SET 0x80FFFFF1
79 #define XSDPS_EXT_CSD_CMD_BLKCNT 1
80 #define XSDPS_EXT_CSD_CMD_BLKSIZE 512
81 #define XSDPS_CLK_52_MHZ 52000000
82 #define XSDPS_MMC_HIGH_SPEED_ARG 0x03B90100
83 #define XSDPS_MMC_4_BIT_BUS_ARG 0x03B70100
84 #define XSDPS_MMC_DELAY_FOR_SWITCH 2000
86 /**************************** Type Definitions *******************************/
88 /***************** Macros (Inline Functions) Definitions *********************/
90 /************************** Function Prototypes ******************************/
91 int XSdPs_CmdTransfer(XSdPs *InstancePtr, u32 Cmd, u32 Arg, u32 BlkCnt);
92 void XSdPs_SetupADMA2DescTbl(XSdPs *InstancePtr, u32 BlkCnt, const u8 *Buff);
94 /*****************************************************************************/
96 * Update Block size for read/write operations.
98 * @param InstancePtr is a pointer to the instance to be worked on.
99 * @param BlkSize - Block size passed by the user.
103 ******************************************************************************/
104 int XSdPs_SetBlkSize(XSdPs *InstancePtr, u16 BlkSize)
107 u32 PresentStateReg = 0;
109 Xil_AssertNonvoid(InstancePtr != NULL);
110 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
112 PresentStateReg = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
113 XSDPS_PRES_STATE_OFFSET);
115 if (PresentStateReg & (XSDPS_PSR_INHIBIT_CMD_MASK |
116 XSDPS_PSR_INHIBIT_DAT_MASK |
117 XSDPS_PSR_WR_ACTIVE_MASK | XSDPS_PSR_RD_ACTIVE_MASK)) {
118 Status = XST_FAILURE;
124 * Send block write command
126 Status = XSdPs_CmdTransfer(InstancePtr, CMD16, BlkSize, 0);
127 if (Status != XST_SUCCESS) {
128 Status = XST_FAILURE;
132 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
136 * Set block size to the value passed
138 BlkSize &= XSDPS_BLK_SIZE_MASK;
139 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress, XSDPS_BLK_SIZE_OFFSET,
142 Status = XST_SUCCESS;
149 /*****************************************************************************/
152 * API to get bus width support by card.
155 * @param InstancePtr is a pointer to the XSdPs instance.
156 * @param SCR - buffer to store SCR register returned by card.
159 * - XST_SUCCESS if successful.
160 * - XST_FAILURE if fail.
164 ******************************************************************************/
165 int XSdPs_Get_BusWidth(XSdPs *InstancePtr, u8 *SCR)
173 Xil_AssertNonvoid(InstancePtr != NULL);
174 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
176 for (LoopCnt = 0; LoopCnt < 8; LoopCnt++) {
181 * Send block write command
183 Status = XSdPs_CmdTransfer(InstancePtr, CMD55,
184 InstancePtr->RelCardAddr, 0);
185 if (Status != XST_SUCCESS) {
186 Status = XST_FAILURE;
190 BlkCnt = XSDPS_SCR_BLKCNT;
191 BlkSize = XSDPS_SCR_BLKSIZE;
194 * Set block size to the value passed
196 BlkSize &= XSDPS_BLK_SIZE_MASK;
197 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
198 XSDPS_BLK_SIZE_OFFSET, BlkSize);
200 XSdPs_SetupADMA2DescTbl(InstancePtr, BlkCnt, SCR);
202 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
203 XSDPS_XFER_MODE_OFFSET,
204 XSDPS_TM_DAT_DIR_SEL_MASK | XSDPS_TM_DMA_EN_MASK);
206 Status = XSdPs_CmdTransfer(InstancePtr, ACMD51, 0, BlkCnt);
207 if (Status != XST_SUCCESS) {
208 Status = XST_FAILURE;
213 * Check for transfer complete
214 * Polling for response for now
217 StatusReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
218 XSDPS_NORM_INTR_STS_OFFSET);
219 if (StatusReg & XSDPS_INTR_ERR_MASK) {
221 * Write to clear error bits
223 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
224 XSDPS_ERR_INTR_STS_OFFSET,
225 XSDPS_ERROR_INTR_ALL_MASK);
226 Status = XST_FAILURE;
229 } while ((StatusReg & XSDPS_INTR_TC_MASK) == 0);
234 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
235 XSDPS_NORM_INTR_STS_OFFSET, XSDPS_INTR_TC_MASK);
237 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
240 Status = XST_SUCCESS;
247 /*****************************************************************************/
250 * API to set bus width to 4-bit in card and host
253 * @param InstancePtr is a pointer to the XSdPs instance.
256 * - XST_SUCCESS if successful.
257 * - XST_FAILURE if fail.
261 ******************************************************************************/
262 int XSdPs_Change_BusWidth(XSdPs *InstancePtr)
268 Xil_AssertNonvoid(InstancePtr != NULL);
269 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
273 Status = XSdPs_CmdTransfer(InstancePtr, CMD55,
274 InstancePtr->RelCardAddr, 0);
275 if (Status != XST_SUCCESS) {
276 Status = XST_FAILURE;
280 Arg = XSDPS_4_BIT_WIDTH;
281 Status = XSdPs_CmdTransfer(InstancePtr, ACMD6, Arg, 0);
282 if (Status != XST_SUCCESS) {
283 Status = XST_FAILURE;
287 StatusReg = XSdPs_ReadReg8(InstancePtr->Config.BaseAddress,
288 XSDPS_HOST_CTRL1_OFFSET);
289 StatusReg |= XSDPS_HC_WIDTH_MASK;
290 XSdPs_WriteReg8(InstancePtr->Config.BaseAddress,
291 XSDPS_HOST_CTRL1_OFFSET,StatusReg);
293 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
298 Arg = XSDPS_MMC_4_BIT_BUS_ARG;
299 Status = XSdPs_CmdTransfer(InstancePtr, ACMD6, Arg, 0);
300 if (Status != XST_SUCCESS) {
301 Status = XST_FAILURE;
307 usleep(XSDPS_MMC_DELAY_FOR_SWITCH);
311 #ifdef __MICROBLAZE__
318 StatusReg = XSdPs_ReadReg8(InstancePtr->Config.BaseAddress,
319 XSDPS_HOST_CTRL1_OFFSET);
320 StatusReg |= XSDPS_HC_WIDTH_MASK;
321 XSdPs_WriteReg8(InstancePtr->Config.BaseAddress,
322 XSDPS_HOST_CTRL1_OFFSET,StatusReg);
324 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
329 Status = XST_SUCCESS;
336 /*****************************************************************************/
339 * API to get bus speed supported by card.
342 * @param InstancePtr is a pointer to the XSdPs instance.
343 * @param ReadBuff - buffer to store function group support data
347 * - XST_SUCCESS if successful.
348 * - XST_FAILURE if fail.
352 ******************************************************************************/
353 int XSdPs_Get_BusSpeed(XSdPs *InstancePtr, u8 *ReadBuff)
362 Xil_AssertNonvoid(InstancePtr != NULL);
363 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
365 for (LoopCnt = 0; LoopCnt < 64; LoopCnt++) {
366 ReadBuff[LoopCnt] = 0;
369 BlkCnt = XSDPS_SWITCH_CMD_BLKCNT;
370 BlkSize = XSDPS_SWITCH_CMD_BLKSIZE;
371 BlkSize &= XSDPS_BLK_SIZE_MASK;
372 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
373 XSDPS_BLK_SIZE_OFFSET, BlkSize);
375 XSdPs_SetupADMA2DescTbl(InstancePtr, BlkCnt, ReadBuff);
377 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
378 XSDPS_XFER_MODE_OFFSET,
379 XSDPS_TM_DAT_DIR_SEL_MASK | XSDPS_TM_DMA_EN_MASK);
381 Arg = XSDPS_SWITCH_CMD_HS_GET;
383 Status = XSdPs_CmdTransfer(InstancePtr, CMD6, Arg, 1);
384 if (Status != XST_SUCCESS) {
385 Status = XST_FAILURE;
390 * Check for transfer complete
391 * Polling for response for now
394 StatusReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
395 XSDPS_NORM_INTR_STS_OFFSET);
396 if (StatusReg & XSDPS_INTR_ERR_MASK) {
398 * Write to clear error bits
400 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
401 XSDPS_ERR_INTR_STS_OFFSET,
402 XSDPS_ERROR_INTR_ALL_MASK);
403 Status = XST_FAILURE;
406 } while ((StatusReg & XSDPS_INTR_TC_MASK) == 0);
411 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
412 XSDPS_NORM_INTR_STS_OFFSET, XSDPS_INTR_TC_MASK);
414 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
417 Status = XST_SUCCESS;
424 /*****************************************************************************/
427 * API to set high speed in card and host. Changes clock in host accordingly.
430 * @param InstancePtr is a pointer to the XSdPs instance.
433 * - XST_SUCCESS if successful.
434 * - XST_FAILURE if fail.
438 ******************************************************************************/
439 int XSdPs_Change_BusSpeed(XSdPs *InstancePtr)
452 Xil_AssertNonvoid(InstancePtr != NULL);
453 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
457 BlkCnt = XSDPS_SWITCH_CMD_BLKCNT;
458 BlkSize = XSDPS_SWITCH_CMD_BLKSIZE;
459 BlkSize &= XSDPS_BLK_SIZE_MASK;
460 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
461 XSDPS_BLK_SIZE_OFFSET, BlkSize);
463 XSdPs_SetupADMA2DescTbl(InstancePtr, BlkCnt, ReadBuff);
465 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
466 XSDPS_XFER_MODE_OFFSET,
467 XSDPS_TM_DAT_DIR_SEL_MASK | XSDPS_TM_DMA_EN_MASK);
469 Arg = XSDPS_SWITCH_CMD_HS_SET;
470 Status = XSdPs_CmdTransfer(InstancePtr, CMD6, Arg, 1);
471 if (Status != XST_SUCCESS) {
472 Status = XST_FAILURE;
477 * Check for transfer complete
478 * Polling for response for now
481 StatusReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
482 XSDPS_NORM_INTR_STS_OFFSET);
483 if (StatusReg & XSDPS_INTR_ERR_MASK) {
485 * Write to clear error bits
487 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
488 XSDPS_ERR_INTR_STS_OFFSET,
489 XSDPS_ERROR_INTR_ALL_MASK);
490 Status = XST_FAILURE;
493 } while ((StatusReg & XSDPS_INTR_TC_MASK) == 0);
498 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
499 XSDPS_NORM_INTR_STS_OFFSET, XSDPS_INTR_TC_MASK);
501 ClockReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
502 XSDPS_CLK_CTRL_OFFSET);
503 ClockReg &= ~(XSDPS_CC_INT_CLK_EN_MASK | XSDPS_CC_SD_CLK_EN_MASK);
505 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
506 XSDPS_CLK_CTRL_OFFSET, ClockReg);
508 ClockReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
509 XSDPS_CLK_CTRL_OFFSET);
510 ClockReg &= (~XSDPS_CC_SDCLK_FREQ_SEL_MASK);
511 ClockReg |= XSDPS_CC_SDCLK_FREQ_BASE_MASK | XSDPS_CC_INT_CLK_EN_MASK;
512 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
513 XSDPS_CLK_CTRL_OFFSET, ClockReg);
516 * Wait for internal clock to stabilize
518 while((XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
519 XSDPS_CLK_CTRL_OFFSET) & XSDPS_CC_INT_CLK_STABLE_MASK) == 0);
524 ClockReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
525 XSDPS_CLK_CTRL_OFFSET);
526 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
527 XSDPS_CLK_CTRL_OFFSET,
528 ClockReg | XSDPS_CC_SD_CLK_EN_MASK);
531 StatusReg = XSdPs_ReadReg8(InstancePtr->Config.BaseAddress,
532 XSDPS_HOST_CTRL1_OFFSET);
533 StatusReg |= XSDPS_HC_SPEED_MASK;
534 XSdPs_WriteReg8(InstancePtr->Config.BaseAddress,
535 XSDPS_HOST_CTRL1_OFFSET,StatusReg);
537 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
542 Arg = XSDPS_MMC_HIGH_SPEED_ARG;
543 Status = XSdPs_CmdTransfer(InstancePtr, CMD6, Arg, 0);
544 if (Status != XST_SUCCESS) {
545 Status = XST_FAILURE;
551 usleep(XSDPS_MMC_DELAY_FOR_SWITCH);
555 #ifdef __MICROBLAZE__
562 XSdPs_Change_ClkFreq(InstancePtr, XSDPS_CLK_52_MHZ);
564 StatusReg = XSdPs_ReadReg8(InstancePtr->Config.BaseAddress,
565 XSDPS_HOST_CTRL1_OFFSET);
566 StatusReg |= XSDPS_HC_SPEED_MASK;
567 XSdPs_WriteReg8(InstancePtr->Config.BaseAddress,
568 XSDPS_HOST_CTRL1_OFFSET,StatusReg);
570 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
574 Status = XST_SUCCESS;
581 /*****************************************************************************/
584 * API to change clock freq to given value.
587 * @param InstancePtr is a pointer to the XSdPs instance.
588 * @param SelFreq - Clock frequency in Hz.
592 * @note This API will change clock frequency to the value less than
593 * or equal to the given value using the permissible dividors.
595 ******************************************************************************/
596 int XSdPs_Change_ClkFreq(XSdPs *InstancePtr, u32 SelFreq)
604 Xil_AssertNonvoid(InstancePtr != NULL);
605 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
610 ClockReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
611 XSDPS_CLK_CTRL_OFFSET);
612 ClockReg &= ~(XSDPS_CC_INT_CLK_EN_MASK | XSDPS_CC_SD_CLK_EN_MASK);
614 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
615 XSDPS_CLK_CTRL_OFFSET, ClockReg);
621 for(ClkLoopCnt = 0; ClkLoopCnt < XSDPS_CC_MAX_NUM_OF_DIV;
623 if( ((InstancePtr->Config.InputClockHz)/DivCnt) <= SelFreq) {
625 Divisor = Divisor << XSDPS_CC_DIV_SHIFT;
628 DivCnt = DivCnt << 1;
631 if(ClkLoopCnt == 9) {
634 * No valid divisor found for given frequency
636 Status = XST_FAILURE;
643 ClockReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
644 XSDPS_CLK_CTRL_OFFSET);
645 ClockReg &= (~XSDPS_CC_SDCLK_FREQ_SEL_MASK);
647 ClockReg |= Divisor | XSDPS_CC_INT_CLK_EN_MASK;
648 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
649 XSDPS_CLK_CTRL_OFFSET, ClockReg);
652 * Wait for internal clock to stabilize
654 while((XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
655 XSDPS_CLK_CTRL_OFFSET) & XSDPS_CC_INT_CLK_STABLE_MASK) == 0);
660 ClockReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
661 XSDPS_CLK_CTRL_OFFSET);
662 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
663 XSDPS_CLK_CTRL_OFFSET,
664 ClockReg | XSDPS_CC_SD_CLK_EN_MASK);
666 Status = XST_SUCCESS;
673 /*****************************************************************************/
676 * API to send pullup command to card before using DAT line 3(using 4-bit bus)
679 * @param InstancePtr is a pointer to the XSdPs instance.
682 * - XST_SUCCESS if successful.
683 * - XST_FAILURE if fail.
687 ******************************************************************************/
688 int XSdPs_Pullup(XSdPs *InstancePtr)
692 Xil_AssertNonvoid(InstancePtr != NULL);
693 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
695 Status = XSdPs_CmdTransfer(InstancePtr, CMD55,
696 InstancePtr->RelCardAddr, 0);
697 if (Status != XST_SUCCESS) {
698 Status = XST_FAILURE;
702 Status = XSdPs_CmdTransfer(InstancePtr, ACMD42, 0, 0);
703 if (Status != XST_SUCCESS) {
704 Status = XST_FAILURE;
708 Status = XST_SUCCESS;
715 /*****************************************************************************/
718 * API to get EXT_CSD register of eMMC.
721 * @param InstancePtr is a pointer to the XSdPs instance.
722 * @param ReadBuff - buffer to store EXT_CSD
725 * - XST_SUCCESS if successful.
726 * - XST_FAILURE if fail.
730 ******************************************************************************/
731 int XSdPs_Get_Mmc_ExtCsd(XSdPs *InstancePtr, u8 *ReadBuff)
740 Xil_AssertNonvoid(InstancePtr != NULL);
741 Xil_AssertNonvoid(InstancePtr->IsReady == XIL_COMPONENT_IS_READY);
743 for (LoopCnt = 0; LoopCnt < 512; LoopCnt++) {
744 ReadBuff[LoopCnt] = 0;
747 BlkCnt = XSDPS_EXT_CSD_CMD_BLKCNT;
748 BlkSize = XSDPS_EXT_CSD_CMD_BLKSIZE;
749 BlkSize &= XSDPS_BLK_SIZE_MASK;
750 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
751 XSDPS_BLK_SIZE_OFFSET, BlkSize);
753 XSdPs_SetupADMA2DescTbl(InstancePtr, BlkCnt, ReadBuff);
755 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
756 XSDPS_XFER_MODE_OFFSET,
757 XSDPS_TM_DAT_DIR_SEL_MASK | XSDPS_TM_DMA_EN_MASK);
762 * Send SEND_EXT_CSD command
764 Status = XSdPs_CmdTransfer(InstancePtr, CMD8, Arg, 1);
765 if (Status != XST_SUCCESS) {
766 Status = XST_FAILURE;
771 * Check for transfer complete
772 * Polling for response for now
775 StatusReg = XSdPs_ReadReg16(InstancePtr->Config.BaseAddress,
776 XSDPS_NORM_INTR_STS_OFFSET);
777 if (StatusReg & XSDPS_INTR_ERR_MASK) {
779 * Write to clear error bits
781 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
782 XSDPS_ERR_INTR_STS_OFFSET,
783 XSDPS_ERROR_INTR_ALL_MASK);
784 Status = XST_FAILURE;
787 } while ((StatusReg & XSDPS_INTR_TC_MASK) == 0);
792 XSdPs_WriteReg16(InstancePtr->Config.BaseAddress,
793 XSDPS_NORM_INTR_STS_OFFSET, XSDPS_INTR_TC_MASK);
795 Status = XSdPs_ReadReg(InstancePtr->Config.BaseAddress,
798 Status = XST_SUCCESS;