4 * This file is part of BeRTOS.
6 * Bertos 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.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU 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 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
32 * \brief Function library for secure digital memory.
34 * \author Francesco Sacchi <batt@develer.com>
39 #include "cfg/cfg_sd.h"
42 #include <drv/timer.h>
43 #include <drv/hsmci_sam3.h>
46 #include <io/kblock.h>
50 #define LOG_LEVEL SD_LOG_LEVEL
51 #define LOG_FORMAT SD_LOG_FORMAT
53 #include <cpu/power.h>
55 #include <string.h> /* memset */
58 #define SD_SEND_ALL_CID BV(0)
59 #define SD_STATUS_APP_CMD BV(5)
60 #define SD_STATUS_READY BV(8)
61 #define SD_CARD_IS_LOCKED BV(25)
63 #define SD_GET_ERRORS(status) ((status) & 0xFFF80000)
64 #define SD_ADDR_TO_RCA(addr) (uint32_t)(((addr) << 16) & 0xFFFF0000)
65 #define SD_GET_STATE(status) (uint8_t)(((status) & 0x1E00) >> 9)
67 static const uint32_t tran_exp[] =
69 10000, 100000, 1000000, 10000000,
73 static const uint8_t tran_mant[] =
75 0, 10, 12, 13, 15, 20, 25, 30,
76 35, 40, 45, 50, 55, 60, 70, 80,
80 void sd_dumpCsd(SdCSD *csd);
81 void sd_dumpCid(SdCID *cid);
82 void sd_dumpSsr(SdSSR *ssr);
84 void sd_sendInit(void);
86 int sd_sendIfCond(Sd *sd);
87 int sd_sendAppOpCond(Sd *sd);
89 int sd_getCid(Sd *sd, SdCID *cid, uint32_t addr, uint8_t flag);
90 int sd_getCsd(Sd *sd, SdCSD *csd);
91 int sd_getSrc(Sd *sd);
93 int sd_appStatus(Sd *sd);
94 int sd_getRelativeAddr(Sd *sd);
95 int sd_getStatus(Sd *sd, SdSSR *ssr, uint32_t *buf, size_t words);
97 int sd_selectCard(Sd *sd);
98 int sd_deSelectCard(Sd *sd);
99 int sd_setBusWidth(Sd *sd, size_t len);
100 int sd_set_BlockLen(Sd *sd, size_t len);
101 void sd_setHightSpeed(Sd *sd);
104 INLINE int sd_setBus4bit(Sd *sd)
106 return sd_setBusWidth(sd, 4);
109 INLINE int sd_setBus1bit(Sd *sd)
111 return sd_setBusWidth(sd, 1);
116 static void dump(const char *label, uint32_t *r, size_t len)
121 kprintf("\n%s [\n", label);
122 for (i = 0; i < len; i++)
129 kprintf("%08lx ", r[i]);
132 kprintf("\n] len=%d\n\n", i);
136 void sd_dumpCsd(SdCSD *csd)
140 LOG_INFO("VERSION: %d.0\n", csd->structure ? 2 : 1);
141 LOG_INFO("CARD COMMAND CLASS: %d\n", csd->ccc);
142 LOG_INFO("MAX DATA RATE: %ld\n", csd->max_data_rate);
143 LOG_INFO("WRITE BLK LEN BITS: %ld\n", csd->write_blk_bits);
144 LOG_INFO("READ BLK LEN BITS: %ld\n", csd->read_blk_bits);
145 LOG_INFO("ERASE SIZE: %ld\n", csd->erase_size);
146 LOG_INFO("BLK NUM: %ld\n", csd->block_num);
147 LOG_INFO("BLK LEN: %ld\n", csd->block_len);
148 LOG_INFO("CAPACITY %ld\n", csd->capacity);
149 LOG_INFO("FLAG Write: WP %d, W MISALIGN %d\n", csd->write_partial, csd->write_misalign);
150 LOG_INFO("FLAG Read: RP %d, R MISALIGN %d\n", csd->read_partial, csd->read_misalign);
154 void sd_dumpCid(SdCID *cid)
158 LOG_INFO("MANFID: %d\n", cid->manfid);
159 LOG_INFO("OEMID: %d\n", cid->oemid);
160 LOG_INFO("SERIAL: %ld\n", cid->serial);
161 LOG_INFO("PROD_NAME: %s\n", cid->prod_name);
162 LOG_INFO("REV: %d.%d\n", cid->m_rev, cid->l_rev);
163 LOG_INFO("OFF,Y,M: %lx, %ld %ld\n", cid->year_off, (BCD_TO_INT_32BIT(cid->year_off) / 12) + 2000,
164 (BCD_TO_INT_32BIT(cid->year_off) % 12));
167 void sd_dumpSsr(SdSSR *ssr)
171 LOG_INFO("BUS_WIDTH: %d\n", ssr->bus_width);
172 LOG_INFO("TYPE: %d\n", ssr->card_type);
173 LOG_INFO("AU_TYPE: %d\n", ssr->au_size);
174 LOG_INFO("ERASE_SIZE: %d\n", ssr->erase_size);
175 LOG_INFO("SPEED_CLASS: %d\n", ssr->speed_class);
179 static int sd_decodeCsd(SdCSD *csd, uint32_t *resp, size_t len)
185 csd->structure = UNSTUFF_BITS(resp, 126, 2);
186 csd->ccc = UNSTUFF_BITS(resp, 84, 12);
188 csd->max_data_rate = tran_exp[UNSTUFF_BITS(resp, 96, 3)] * tran_mant[UNSTUFF_BITS(resp, 99, 4)];
193 * - Version 1.01-1.10
194 * - Version 2.00/Standard Capacity
196 * - Version 2.00/High Capacity
200 if (csd->structure == 0)
202 // (C_size + 1) x 2^(C_SIZE_MUL+2)
203 csd->block_num = (1 + UNSTUFF_BITS(resp, 62, 12)) << (UNSTUFF_BITS(resp, 47, 3) + 2);
205 csd->read_blk_bits = UNSTUFF_BITS(resp, 80, 4);
206 csd->write_blk_bits = UNSTUFF_BITS(resp, 22, 4);
208 csd->block_len = 1 << csd->read_blk_bits;
209 csd->capacity = csd->block_num * csd->block_len;
211 csd->read_partial = UNSTUFF_BITS(resp, 79, 1);
212 csd->read_misalign = UNSTUFF_BITS(resp, 77, 1);
214 csd->write_misalign = UNSTUFF_BITS(resp, 78, 1);
215 csd->write_partial = UNSTUFF_BITS(resp, 21, 1);
217 if (UNSTUFF_BITS(resp, 46, 1))
221 else if(csd->write_blk_bits >= 9)
223 csd->erase_size = UNSTUFF_BITS(resp, 39, 7) + 1;
224 csd->erase_size <<= csd->write_blk_bits - 9;
229 else if (csd->structure == 1)
231 kprintf("csize %ld\n", UNSTUFF_BITS(resp, 48, 22));
232 csd->capacity = (1 + UNSTUFF_BITS(resp, 48, 22)) << 10;
234 csd->write_blk_bits = 9;
235 csd->write_partial = 0;
236 csd->write_misalign = 0;
238 csd->read_blk_bits = 9;
239 csd->read_partial = 0;
240 csd->read_misalign = 0;
243 // the block size if fixed to 512kb
244 csd->block_len = (1 << csd->write_blk_bits) << 10;
250 kprintf("Unrecognised CSD structure version %d\n", csd->structure);
257 void sd_sendInit(void)
259 hsmci_init(NULL); //TODO: REMOVE IT!
261 if (hsmci_sendCmd(0, 0, HSMCI_CMDR_SPCMD_INIT | HSMCI_CMDR_RSPTYP_NORESP))
262 LOG_ERR("INIT: %lx\n", HSMCI_SR);
268 hsmci_setSpeed(HSMCI_INIT_SPEED, false);
269 if (hsmci_sendCmd(0, 0, HSMCI_CMDR_RSPTYP_NORESP))
270 LOG_ERR("GO_IDLE: %lx\n", HSMCI_SR);
273 int sd_sendIfCond(Sd *sd)
275 if (hsmci_sendCmd(8, CMD8_V_RANGE_27V_36V, HSMCI_CMDR_RSPTYP_48_BIT))
277 LOG_ERR("IF_COND %lx\n", HSMCI_SR);
280 hsmci_readResp(&(sd->status), 1);
281 if (((sd->status) & 0xFFF) == CMD8_V_RANGE_27V_36V)
283 LOG_INFO("IF_COND: %lx\n", (sd->status));
286 LOG_ERR("IF_COND: %lx\n", (sd->status));
291 int sd_sendAppOpCond(Sd *sd)
293 if (hsmci_sendCmd(55, 0, HSMCI_CMDR_RSPTYP_48_BIT))
295 LOG_ERR("APP_CMD %lx\n", HSMCI_SR);
299 hsmci_readResp(&(sd->status), 1);
300 if ((sd->status) & (SD_STATUS_APP_CMD | SD_STATUS_READY))
302 if (hsmci_sendCmd(41, SD_HOST_VOLTAGE_RANGE | SD_OCR_CCS, HSMCI_CMDR_RSPTYP_48_BIT))// se cmd 8 va ok.
304 LOG_ERR("APP_OP_COND %lx\n", HSMCI_SR);
309 hsmci_readResp(&(sd->status), 1);
310 if ((sd->status) & SD_OCR_BUSY)
312 LOG_INFO("SD power up! Hight Capability [%d]\n", (bool)((sd->status) & SD_OCR_CCS));
321 int sd_getCid(Sd *sd, SdCID *cid, uint32_t addr, uint8_t flag)
325 memset(cid, 0, sizeof(SdCID));
327 uint8_t idx = 9; // CMD9 get cid from gived sd address (RCA)
328 if (flag & SD_SEND_ALL_CID)
332 if (hsmci_sendCmd(idx, SD_ADDR_TO_RCA(addr), HSMCI_CMDR_RSPTYP_136_BIT))
334 LOG_ERR("GET_CID %lx\n", HSMCI_SR);
340 hsmci_readResp(resp, 4);
341 LOG_INFOB(dump("CID", resp, 4););
343 cid->manfid = UNSTUFF_BITS(resp, 120, 8);
344 cid->oemid = UNSTUFF_BITS(resp, 104, 16);
345 cid->prod_name[0] = UNSTUFF_BITS(resp, 96, 8);
346 cid->prod_name[1] = UNSTUFF_BITS(resp, 88, 8);
347 cid->prod_name[2] = UNSTUFF_BITS(resp, 80, 8);
348 cid->prod_name[3] = UNSTUFF_BITS(resp, 72, 8);
349 cid->prod_name[4] = UNSTUFF_BITS(resp, 64, 8);
350 cid->m_rev = UNSTUFF_BITS(resp, 60, 4);
351 cid->l_rev = UNSTUFF_BITS(resp, 56, 4);
352 cid->serial = (uint32_t)UNSTUFF_BITS(resp, 24, 32);
353 cid->year_off = UNSTUFF_BITS(resp, 8, 12);
359 int sd_getCsd(Sd *sd, SdCSD *csd)
363 memset(csd, 0, sizeof(SdCSD));
365 LOG_INFO("Send to RCA: %lx\n", SD_ADDR_TO_RCA(sd->addr));
366 if (hsmci_sendCmd(9, SD_ADDR_TO_RCA(sd->addr), HSMCI_CMDR_RSPTYP_136_BIT))
368 LOG_ERR("GET_CSD %lx\n", HSMCI_SR);
374 hsmci_readResp(resp, 4);
375 LOG_INFOB(dump("CSD", resp, 4););
376 sd_decodeCsd(csd, resp, 4);
382 int sd_getRelativeAddr(Sd *sd)
385 if (hsmci_sendCmd(3, 0, HSMCI_CMDR_RSPTYP_48_BIT))
387 LOG_ERR("RCA: %lx\n", HSMCI_SR);
391 hsmci_readResp(&sd->addr, 1);
392 sd->addr = sd->addr >> 16;
394 LOG_INFOB(dump("RCA", &sd->addr, 1););
399 int sd_appStatus(Sd *sd)
402 LOG_INFO("Send to RCA: %lx\n", SD_ADDR_TO_RCA(sd->addr));
403 if (hsmci_sendCmd(13, SD_ADDR_TO_RCA(sd->addr), HSMCI_CMDR_RSPTYP_48_BIT))
405 LOG_ERR("STATUS: %lx\n", HSMCI_SR);
409 hsmci_readResp(&(sd->status), 1);
410 LOG_INFOB(dump("STATUS", &(sd->status), 1););
412 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
414 if (sd->status & SD_STATUS_READY)
421 INLINE int sd_cardSelection(Sd *sd, uint32_t rca)
424 LOG_INFO("Select RCA: %lx\n", rca);
425 if (hsmci_sendCmd(7, rca, HSMCI_CMDR_RSPTYP_R1B))
427 LOG_ERR("SELECT_SD: %lx\n", HSMCI_SR);
432 hsmci_readResp(&(sd->status), 1);
433 LOG_INFOB(dump("SELECT_SD", &(sd->status), 1););
435 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
437 if (sd->status & SD_STATUS_READY)
443 int sd_selectCard(Sd *sd)
446 uint32_t rca = SD_ADDR_TO_RCA(sd->addr);
447 LOG_INFO("Select RCA: %lx\n", rca);
448 if (hsmci_sendCmd(7, rca, HSMCI_CMDR_RSPTYP_R1B))
450 LOG_ERR("SELECT_SD: %lx\n", HSMCI_SR);
455 hsmci_readResp(&(sd->status), 1);
457 LOG_INFOB(dump("SELECT_SD", &(sd->status), 1););
458 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
460 if (sd->status & SD_STATUS_READY)
466 int sd_deSelectCard(Sd *sd)
472 rca = SD_ADDR_TO_RCA(sd->addr + 1);
474 LOG_INFO("Select RCA: %lx\n", rca);
476 if (hsmci_sendCmd(7, rca, HSMCI_CMDR_RSPTYP_NORESP))
478 LOG_ERR("DESELECT_SD: %lx\n", HSMCI_SR);
485 int sd_setBusWidth(Sd *sd, size_t len)
489 if (hsmci_sendCmd(55, SD_ADDR_TO_RCA(sd->addr), HSMCI_CMDR_RSPTYP_48_BIT))
491 LOG_ERR("APP_CMD %lx\n", HSMCI_SR);
495 hsmci_readResp(&(sd->status), 1);
496 if ((sd->status) & (SD_STATUS_APP_CMD | SD_STATUS_READY))
498 hsmci_setBusWidth(len);
504 if (hsmci_sendCmd(6, arg, HSMCI_CMDR_RSPTYP_48_BIT))
506 LOG_ERR("SET_BUS_WIDTH CMD: %lx\n", HSMCI_SR);
510 hsmci_readResp(&(sd->status), 1);
512 LOG_INFOB(dump("SET_BUS_WIDTH", &(sd->status), 1););
513 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
515 if (sd->status & SD_STATUS_READY)
519 LOG_ERR("SET_BUS_WIDTH REP %lx\n", (sd->status));
524 int sd_set_BlockLen(Sd *sd, size_t len)
528 if (hsmci_sendCmd(16, len, HSMCI_CMDR_RSPTYP_48_BIT))
530 LOG_ERR("SET_BLK_LEN: %lx\n", HSMCI_SR);
534 hsmci_readResp(&(sd->status), 1);
536 LOG_INFOB(dump("SET_BLK_LEN", &(sd->status), 1););
537 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
539 sd->b.blk_size = len;
541 if (sd->status & SD_STATUS_READY)
547 int sd_getStatus(Sd *sd, SdSSR *ssr, uint32_t *buf, size_t words)
552 // Status reply with 512bit data, so the block size in byte is 64
553 hsmci_prgRxDMA(buf, words, 64);
555 if (hsmci_sendCmd(55, SD_ADDR_TO_RCA(sd->addr), HSMCI_CMDR_RSPTYP_48_BIT))
557 LOG_ERR("APP_CMD %lx\n", HSMCI_SR);
561 uint32_t status = HSMCI_RSPR;
562 if (status & (SD_STATUS_APP_CMD | SD_STATUS_READY))
564 if (hsmci_sendCmd(13, 0, HSMCI_CMDR_RSPTYP_48_BIT |
565 BV(HSMCI_CMDR_TRDIR) | HSMCI_CMDR_TRCMD_START_DATA | HSMCI_CMDR_TRTYP_SINGLE))
567 LOG_ERR("STATUS CMD: %lx\n", HSMCI_SR);
571 hsmci_readResp(&(sd->status), 1);
572 LOG_INFOB(dump("STATUS", &(sd->status), 1););
573 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
575 if (sd->status & SD_STATUS_READY)
577 hsmci_waitTransfer();
579 LOG_INFOB(dump("STATUS", buf, words););
580 memset(ssr, 0, sizeof(SdSSR));
581 ssr->bus_width = UNSTUFF_BITS(buf, 510, 2);
582 ssr->card_type = UNSTUFF_BITS(buf, 480, 16);
583 ssr->au_size = UNSTUFF_BITS(buf, 432, 8);
584 ssr->speed_class = UNSTUFF_BITS(buf, 440, 8);
585 ssr->erase_size = UNSTUFF_BITS(buf, 408, 24);
595 void sd_setHightSpeed(Sd *sd)
598 hsmci_setSpeed(2100000, true);
602 static size_t sd_SdReadDirect(struct KBlock *b, block_idx_t idx, void *buf, size_t offset, size_t size)
606 LOG_INFO("reading from block %ld, offset %d, size %d\n", idx, offset, size);
608 if (sd_selectCard(sd) < 0)
611 hsmci_prgRxDMA(buf, size / 4, sd->b.blk_size);
613 if (hsmci_sendCmd(17, idx * sd->b.blk_size + offset, HSMCI_CMDR_RSPTYP_48_BIT |
614 BV(HSMCI_CMDR_TRDIR) | HSMCI_CMDR_TRCMD_START_DATA | HSMCI_CMDR_TRTYP_SINGLE))
616 LOG_ERR("SIGLE_BLK_READ: %lx\n", HSMCI_SR);
621 hsmci_readResp(&(sd->status), 1);
623 LOG_INFOB(dump("SIGLE_BLK_READ", &(sd->status), 1););
624 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
626 if (sd->status & SD_STATUS_READY)
628 hsmci_waitTransfer();
637 static size_t sd_SdWriteDirect(KBlock *b, block_idx_t idx, const void *buf, size_t offset, size_t size)
641 const uint32_t *_buf = (const uint32_t *)buf;
642 LOG_INFO("reading from block %ld, offset %d, size %d\n", idx, offset, size);
644 if (sd_selectCard(sd) < 0)
647 hsmci_prgTxDMA(_buf, size / 4, sd->b.blk_size);
649 if (hsmci_sendCmd(24, idx * sd->b.blk_size + offset, HSMCI_CMDR_RSPTYP_48_BIT |
650 HSMCI_CMDR_TRCMD_START_DATA | HSMCI_CMDR_TRTYP_SINGLE))
652 LOG_ERR("SIGLE_BLK_WRITE: %lx\n", HSMCI_SR);
657 hsmci_readResp(&(sd->status), 1);
659 LOG_INFOB(dump("SIGLE_BLK_WR", &(sd->status), 1););
660 LOG_INFO("State[%d]\n", SD_GET_STATE(sd->status));
662 if (sd->status & SD_STATUS_READY)
664 hsmci_waitTransfer();
674 static int sd_SdError(KBlock *b)
677 return SD_GET_ERRORS(sd->status);
680 static void sd_SdClearerr(KBlock *b)
686 static bool sd_blockInit(Sd *sd, KFile *ch)
690 memset(sd, 0, sizeof(*sd));
691 DB(sd->b.priv.type = KBT_SD);
693 /* Wait a few moments for supply voltage to stabilize */
694 timer_delay(SD_START_DELAY);
701 ticks_t start = timer_clock();
702 bool sd_power_on = false;
705 if (!sd_sendAppOpCond(sd))
712 while (timer_clock() - start < SD_INIT_TIMEOUT);
718 if(sd_getCid(sd, &cid, 0, SD_SEND_ALL_CID) < 0)
725 if (sd_getRelativeAddr(sd) < 0)
729 LOG_INFO("RCA: %0lx\n", sd->addr);
733 if (sd_getCsd(sd, &csd) < 0)
737 sd->b.blk_cnt = csd.block_num * (csd.block_len / SD_DEFAULT_BLOCKLEN);
738 LOG_INFO("blk_size %d, blk_cnt %ld\n", sd->b.blk_size, sd->b.blk_cnt);
742 if (sd_appStatus(sd) < 0)
744 LOG_INFO("STATUS: %ld\n", sd->status);
748 if (sd->status & SD_CARD_IS_LOCKED)
750 LOG_INFO("SD is locked!\n");
754 if (sd->status & SD_STATUS_READY)
757 sd_set_BlockLen(sd, SD_DEFAULT_BLOCKLEN);
759 sd_setHightSpeed(sd);
762 #if CONFIG_SD_AUTOASSIGN_FAT
763 disk_assignDrive(&sd->b, 0);
769 LOG_ERR("SD not ready.\n");
773 static const KBlockVTable sd_unbuffered_vt =
775 .readDirect = sd_SdReadDirect,
776 .writeDirect = sd_SdWriteDirect,
779 .clearerr = sd_SdClearerr,
782 static const KBlockVTable sd_buffered_vt =
784 .readDirect = sd_SdReadDirect,
785 .writeDirect = sd_SdWriteDirect,
787 .readBuf = kblock_swReadBuf,
788 .writeBuf = kblock_swWriteBuf,
789 .load = kblock_swLoad,
790 .store = kblock_swStore,
793 .clearerr = sd_SdClearerr,
796 bool sd_hw_initUnbuf(Sd *sd, KFile *ch)
798 if (sd_blockInit(sd, ch))
800 sd->b.priv.vt = &sd_unbuffered_vt;
807 static uint8_t sd_buf[SD_DEFAULT_BLOCKLEN];
809 bool sd_hw_initBuf(Sd *sd, KFile *ch)
811 if (sd_blockInit(sd, ch))
813 sd->b.priv.buf = sd_buf;
814 sd->b.priv.flags |= KB_BUFFERED | KB_PARTIAL_WRITE;
815 sd->b.priv.vt = &sd_buffered_vt;
816 sd->b.priv.vt->load(&sd->b, 0);