My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Sd2Card.cpp 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724
  1. /*
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. /*
  23. * Arduino Sd2Card Library
  24. * Copyright (C) 2009 by William Greiman
  25. *
  26. * This file is part of the Arduino Sd2Card Library
  27. */
  28. #include "Marlin.h"
  29. #if ENABLED(SDSUPPORT)
  30. #include "Sd2Card.h"
  31. //------------------------------------------------------------------------------
  32. #if DISABLED(SOFTWARE_SPI)
  33. // functions for hardware SPI
  34. //------------------------------------------------------------------------------
  35. // make sure SPCR rate is in expected bits
  36. #if (SPR0 != 0 || SPR1 != 1)
  37. #error unexpected SPCR bits
  38. #endif
  39. /**
  40. * Initialize hardware SPI
  41. * Set SCK rate to F_CPU/pow(2, 1 + spiRate) for spiRate [0,6]
  42. */
  43. static void spiInit(uint8_t spiRate) {
  44. // See avr processor documentation
  45. SPCR = _BV(SPE) | _BV(MSTR) | (spiRate >> 1);
  46. SPSR = spiRate & 1 || spiRate == 6 ? 0 : _BV(SPI2X);
  47. }
  48. //------------------------------------------------------------------------------
  49. /** SPI receive a byte */
  50. static uint8_t spiRec() {
  51. SPDR = 0XFF;
  52. while (!TEST(SPSR, SPIF)) { /* Intentionally left empty */ }
  53. return SPDR;
  54. }
  55. //------------------------------------------------------------------------------
  56. /** SPI read data - only one call so force inline */
  57. static inline __attribute__((always_inline))
  58. void spiRead(uint8_t* buf, uint16_t nbyte) {
  59. if (nbyte-- == 0) return;
  60. SPDR = 0XFF;
  61. for (uint16_t i = 0; i < nbyte; i++) {
  62. while (!TEST(SPSR, SPIF)) { /* Intentionally left empty */ }
  63. buf[i] = SPDR;
  64. SPDR = 0XFF;
  65. }
  66. while (!TEST(SPSR, SPIF)) { /* Intentionally left empty */ }
  67. buf[nbyte] = SPDR;
  68. }
  69. //------------------------------------------------------------------------------
  70. /** SPI send a byte */
  71. static void spiSend(uint8_t b) {
  72. SPDR = b;
  73. while (!TEST(SPSR, SPIF)) { /* Intentionally left empty */ }
  74. }
  75. //------------------------------------------------------------------------------
  76. /** SPI send block - only one call so force inline */
  77. static inline __attribute__((always_inline))
  78. void spiSendBlock(uint8_t token, const uint8_t* buf) {
  79. SPDR = token;
  80. for (uint16_t i = 0; i < 512; i += 2) {
  81. while (!TEST(SPSR, SPIF)) { /* Intentionally left empty */ }
  82. SPDR = buf[i];
  83. while (!TEST(SPSR, SPIF)) { /* Intentionally left empty */ }
  84. SPDR = buf[i + 1];
  85. }
  86. while (!TEST(SPSR, SPIF)) { /* Intentionally left empty */ }
  87. }
  88. //------------------------------------------------------------------------------
  89. #else // SOFTWARE_SPI
  90. //------------------------------------------------------------------------------
  91. /** nop to tune soft SPI timing */
  92. #define nop asm volatile ("nop\n\t")
  93. //------------------------------------------------------------------------------
  94. /** Soft SPI receive byte */
  95. static uint8_t spiRec() {
  96. uint8_t data = 0;
  97. // no interrupts during byte receive - about 8 us
  98. cli();
  99. // output pin high - like sending 0XFF
  100. fastDigitalWrite(SPI_MOSI_PIN, HIGH);
  101. for (uint8_t i = 0; i < 8; i++) {
  102. fastDigitalWrite(SPI_SCK_PIN, HIGH);
  103. // adjust so SCK is nice
  104. nop;
  105. nop;
  106. data <<= 1;
  107. if (fastDigitalRead(SPI_MISO_PIN)) data |= 1;
  108. fastDigitalWrite(SPI_SCK_PIN, LOW);
  109. }
  110. // enable interrupts
  111. sei();
  112. return data;
  113. }
  114. //------------------------------------------------------------------------------
  115. /** Soft SPI read data */
  116. static void spiRead(uint8_t* buf, uint16_t nbyte) {
  117. for (uint16_t i = 0; i < nbyte; i++)
  118. buf[i] = spiRec();
  119. }
  120. //------------------------------------------------------------------------------
  121. /** Soft SPI send byte */
  122. static void spiSend(uint8_t data) {
  123. // no interrupts during byte send - about 8 us
  124. cli();
  125. for (uint8_t i = 0; i < 8; i++) {
  126. fastDigitalWrite(SPI_SCK_PIN, LOW);
  127. fastDigitalWrite(SPI_MOSI_PIN, data & 0X80);
  128. data <<= 1;
  129. fastDigitalWrite(SPI_SCK_PIN, HIGH);
  130. }
  131. // hold SCK high for a few ns
  132. nop;
  133. nop;
  134. nop;
  135. nop;
  136. fastDigitalWrite(SPI_SCK_PIN, LOW);
  137. // enable interrupts
  138. sei();
  139. }
  140. //------------------------------------------------------------------------------
  141. /** Soft SPI send block */
  142. void spiSendBlock(uint8_t token, const uint8_t* buf) {
  143. spiSend(token);
  144. for (uint16_t i = 0; i < 512; i++)
  145. spiSend(buf[i]);
  146. }
  147. #endif // SOFTWARE_SPI
  148. //------------------------------------------------------------------------------
  149. // send command and return error code. Return zero for OK
  150. uint8_t Sd2Card::cardCommand(uint8_t cmd, uint32_t arg) {
  151. // select card
  152. chipSelectLow();
  153. // wait up to 300 ms if busy
  154. waitNotBusy(300);
  155. // send command
  156. spiSend(cmd | 0x40);
  157. // send argument
  158. for (int8_t s = 24; s >= 0; s -= 8) spiSend(arg >> s);
  159. // send CRC
  160. uint8_t crc = 0XFF;
  161. if (cmd == CMD0) crc = 0X95; // correct crc for CMD0 with arg 0
  162. if (cmd == CMD8) crc = 0X87; // correct crc for CMD8 with arg 0X1AA
  163. spiSend(crc);
  164. // skip stuff byte for stop read
  165. if (cmd == CMD12) spiRec();
  166. // wait for response
  167. for (uint8_t i = 0; ((status_ = spiRec()) & 0X80) && i != 0XFF; i++) { /* Intentionally left empty */ }
  168. return status_;
  169. }
  170. //------------------------------------------------------------------------------
  171. /**
  172. * Determine the size of an SD flash memory card.
  173. *
  174. * \return The number of 512 byte data blocks in the card
  175. * or zero if an error occurs.
  176. */
  177. uint32_t Sd2Card::cardSize() {
  178. csd_t csd;
  179. if (!readCSD(&csd)) return 0;
  180. if (csd.v1.csd_ver == 0) {
  181. uint8_t read_bl_len = csd.v1.read_bl_len;
  182. uint16_t c_size = (csd.v1.c_size_high << 10)
  183. | (csd.v1.c_size_mid << 2) | csd.v1.c_size_low;
  184. uint8_t c_size_mult = (csd.v1.c_size_mult_high << 1)
  185. | csd.v1.c_size_mult_low;
  186. return (uint32_t)(c_size + 1) << (c_size_mult + read_bl_len - 7);
  187. }
  188. else if (csd.v2.csd_ver == 1) {
  189. uint32_t c_size = ((uint32_t)csd.v2.c_size_high << 16)
  190. | (csd.v2.c_size_mid << 8) | csd.v2.c_size_low;
  191. return (c_size + 1) << 10;
  192. }
  193. else {
  194. error(SD_CARD_ERROR_BAD_CSD);
  195. return 0;
  196. }
  197. }
  198. //------------------------------------------------------------------------------
  199. void Sd2Card::chipSelectHigh() {
  200. digitalWrite(chipSelectPin_, HIGH);
  201. }
  202. //------------------------------------------------------------------------------
  203. void Sd2Card::chipSelectLow() {
  204. #if DISABLED(SOFTWARE_SPI)
  205. spiInit(spiRate_);
  206. #endif // SOFTWARE_SPI
  207. digitalWrite(chipSelectPin_, LOW);
  208. }
  209. //------------------------------------------------------------------------------
  210. /** Erase a range of blocks.
  211. *
  212. * \param[in] firstBlock The address of the first block in the range.
  213. * \param[in] lastBlock The address of the last block in the range.
  214. *
  215. * \note This function requests the SD card to do a flash erase for a
  216. * range of blocks. The data on the card after an erase operation is
  217. * either 0 or 1, depends on the card vendor. The card must support
  218. * single block erase.
  219. *
  220. * \return The value one, true, is returned for success and
  221. * the value zero, false, is returned for failure.
  222. */
  223. bool Sd2Card::erase(uint32_t firstBlock, uint32_t lastBlock) {
  224. csd_t csd;
  225. if (!readCSD(&csd)) goto fail;
  226. // check for single block erase
  227. if (!csd.v1.erase_blk_en) {
  228. // erase size mask
  229. uint8_t m = (csd.v1.sector_size_high << 1) | csd.v1.sector_size_low;
  230. if ((firstBlock & m) != 0 || ((lastBlock + 1) & m) != 0) {
  231. // error card can't erase specified area
  232. error(SD_CARD_ERROR_ERASE_SINGLE_BLOCK);
  233. goto fail;
  234. }
  235. }
  236. if (type_ != SD_CARD_TYPE_SDHC) {
  237. firstBlock <<= 9;
  238. lastBlock <<= 9;
  239. }
  240. if (cardCommand(CMD32, firstBlock)
  241. || cardCommand(CMD33, lastBlock)
  242. || cardCommand(CMD38, 0)) {
  243. error(SD_CARD_ERROR_ERASE);
  244. goto fail;
  245. }
  246. if (!waitNotBusy(SD_ERASE_TIMEOUT)) {
  247. error(SD_CARD_ERROR_ERASE_TIMEOUT);
  248. goto fail;
  249. }
  250. chipSelectHigh();
  251. return true;
  252. fail:
  253. chipSelectHigh();
  254. return false;
  255. }
  256. //------------------------------------------------------------------------------
  257. /** Determine if card supports single block erase.
  258. *
  259. * \return The value one, true, is returned if single block erase is supported.
  260. * The value zero, false, is returned if single block erase is not supported.
  261. */
  262. bool Sd2Card::eraseSingleBlockEnable() {
  263. csd_t csd;
  264. return readCSD(&csd) ? csd.v1.erase_blk_en : false;
  265. }
  266. //------------------------------------------------------------------------------
  267. /**
  268. * Initialize an SD flash memory card.
  269. *
  270. * \param[in] sckRateID SPI clock rate selector. See setSckRate().
  271. * \param[in] chipSelectPin SD chip select pin number.
  272. *
  273. * \return The value one, true, is returned for success and
  274. * the value zero, false, is returned for failure. The reason for failure
  275. * can be determined by calling errorCode() and errorData().
  276. */
  277. bool Sd2Card::init(uint8_t sckRateID, uint8_t chipSelectPin) {
  278. errorCode_ = type_ = 0;
  279. chipSelectPin_ = chipSelectPin;
  280. // 16-bit init start time allows over a minute
  281. uint16_t t0 = (uint16_t)millis();
  282. uint32_t arg;
  283. // set pin modes
  284. pinMode(chipSelectPin_, OUTPUT);
  285. chipSelectHigh();
  286. pinMode(SPI_MISO_PIN, INPUT);
  287. pinMode(SPI_MOSI_PIN, OUTPUT);
  288. pinMode(SPI_SCK_PIN, OUTPUT);
  289. #if DISABLED(SOFTWARE_SPI)
  290. // SS must be in output mode even it is not chip select
  291. pinMode(SS_PIN, OUTPUT);
  292. // set SS high - may be chip select for another SPI device
  293. #if SET_SPI_SS_HIGH
  294. digitalWrite(SS_PIN, HIGH);
  295. #endif // SET_SPI_SS_HIGH
  296. // set SCK rate for initialization commands
  297. spiRate_ = SPI_SD_INIT_RATE;
  298. spiInit(spiRate_);
  299. #endif // SOFTWARE_SPI
  300. // must supply min of 74 clock cycles with CS high.
  301. for (uint8_t i = 0; i < 10; i++) spiSend(0XFF);
  302. // command to go idle in SPI mode
  303. while ((status_ = cardCommand(CMD0, 0)) != R1_IDLE_STATE) {
  304. if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {
  305. error(SD_CARD_ERROR_CMD0);
  306. goto fail;
  307. }
  308. }
  309. // check SD version
  310. if ((cardCommand(CMD8, 0x1AA) & R1_ILLEGAL_COMMAND)) {
  311. type(SD_CARD_TYPE_SD1);
  312. }
  313. else {
  314. // only need last byte of r7 response
  315. for (uint8_t i = 0; i < 4; i++) status_ = spiRec();
  316. if (status_ != 0XAA) {
  317. error(SD_CARD_ERROR_CMD8);
  318. goto fail;
  319. }
  320. type(SD_CARD_TYPE_SD2);
  321. }
  322. // initialize card and send host supports SDHC if SD2
  323. arg = type() == SD_CARD_TYPE_SD2 ? 0X40000000 : 0;
  324. while ((status_ = cardAcmd(ACMD41, arg)) != R1_READY_STATE) {
  325. // check for timeout
  326. if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {
  327. error(SD_CARD_ERROR_ACMD41);
  328. goto fail;
  329. }
  330. }
  331. // if SD2 read OCR register to check for SDHC card
  332. if (type() == SD_CARD_TYPE_SD2) {
  333. if (cardCommand(CMD58, 0)) {
  334. error(SD_CARD_ERROR_CMD58);
  335. goto fail;
  336. }
  337. if ((spiRec() & 0XC0) == 0XC0) type(SD_CARD_TYPE_SDHC);
  338. // discard rest of ocr - contains allowed voltage range
  339. for (uint8_t i = 0; i < 3; i++) spiRec();
  340. }
  341. chipSelectHigh();
  342. #if DISABLED(SOFTWARE_SPI)
  343. return setSckRate(sckRateID);
  344. #else // SOFTWARE_SPI
  345. return true;
  346. #endif // SOFTWARE_SPI
  347. fail:
  348. chipSelectHigh();
  349. return false;
  350. }
  351. //------------------------------------------------------------------------------
  352. /**
  353. * Read a 512 byte block from an SD card.
  354. *
  355. * \param[in] blockNumber Logical block to be read.
  356. * \param[out] dst Pointer to the location that will receive the data.
  357. * \return The value one, true, is returned for success and
  358. * the value zero, false, is returned for failure.
  359. */
  360. bool Sd2Card::readBlock(uint32_t blockNumber, uint8_t* dst) {
  361. #if ENABLED(SD_CHECK_AND_RETRY)
  362. uint8_t retryCnt = 3;
  363. // use address if not SDHC card
  364. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  365. retry2:
  366. retryCnt --;
  367. if (cardCommand(CMD17, blockNumber)) {
  368. error(SD_CARD_ERROR_CMD17);
  369. if (retryCnt > 0) goto retry;
  370. goto fail;
  371. }
  372. if (!readData(dst, 512)) {
  373. if (retryCnt > 0) goto retry;
  374. goto fail;
  375. }
  376. return true;
  377. retry:
  378. chipSelectHigh();
  379. cardCommand(CMD12, 0);//Try sending a stop command, but ignore the result.
  380. errorCode_ = 0;
  381. goto retry2;
  382. #else
  383. // use address if not SDHC card
  384. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  385. if (cardCommand(CMD17, blockNumber)) {
  386. error(SD_CARD_ERROR_CMD17);
  387. goto fail;
  388. }
  389. return readData(dst, 512);
  390. #endif
  391. fail:
  392. chipSelectHigh();
  393. return false;
  394. }
  395. //------------------------------------------------------------------------------
  396. /** Read one data block in a multiple block read sequence
  397. *
  398. * \param[in] dst Pointer to the location for the data to be read.
  399. *
  400. * \return The value one, true, is returned for success and
  401. * the value zero, false, is returned for failure.
  402. */
  403. bool Sd2Card::readData(uint8_t* dst) {
  404. chipSelectLow();
  405. return readData(dst, 512);
  406. }
  407. #if ENABLED(SD_CHECK_AND_RETRY)
  408. static const uint16_t crctab[] PROGMEM = {
  409. 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
  410. 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
  411. 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
  412. 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
  413. 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
  414. 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
  415. 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
  416. 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
  417. 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
  418. 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
  419. 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
  420. 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
  421. 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
  422. 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
  423. 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
  424. 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
  425. 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
  426. 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
  427. 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
  428. 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
  429. 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
  430. 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
  431. 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
  432. 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
  433. 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
  434. 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
  435. 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
  436. 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
  437. 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
  438. 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
  439. 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
  440. 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
  441. };
  442. static uint16_t CRC_CCITT(const uint8_t* data, size_t n) {
  443. uint16_t crc = 0;
  444. for (size_t i = 0; i < n; i++) {
  445. crc = pgm_read_word(&crctab[(crc >> 8 ^ data[i]) & 0XFF]) ^ (crc << 8);
  446. }
  447. return crc;
  448. }
  449. #endif
  450. //------------------------------------------------------------------------------
  451. bool Sd2Card::readData(uint8_t* dst, uint16_t count) {
  452. // wait for start block token
  453. uint16_t t0 = millis();
  454. while ((status_ = spiRec()) == 0XFF) {
  455. if (((uint16_t)millis() - t0) > SD_READ_TIMEOUT) {
  456. error(SD_CARD_ERROR_READ_TIMEOUT);
  457. goto fail;
  458. }
  459. }
  460. if (status_ != DATA_START_BLOCK) {
  461. error(SD_CARD_ERROR_READ);
  462. goto fail;
  463. }
  464. // transfer data
  465. spiRead(dst, count);
  466. #if ENABLED(SD_CHECK_AND_RETRY)
  467. {
  468. uint16_t calcCrc = CRC_CCITT(dst, count);
  469. uint16_t recvCrc = spiRec() << 8;
  470. recvCrc |= spiRec();
  471. if (calcCrc != recvCrc) {
  472. error(SD_CARD_ERROR_CRC);
  473. goto fail;
  474. }
  475. }
  476. #else
  477. // discard CRC
  478. spiRec();
  479. spiRec();
  480. #endif
  481. chipSelectHigh();
  482. // Send an additional dummy byte, required by Toshiba Flash Air SD Card
  483. spiSend(0XFF);
  484. return true;
  485. fail:
  486. chipSelectHigh();
  487. // Send an additional dummy byte, required by Toshiba Flash Air SD Card
  488. spiSend(0XFF);
  489. return false;
  490. }
  491. //------------------------------------------------------------------------------
  492. /** read CID or CSR register */
  493. bool Sd2Card::readRegister(uint8_t cmd, void* buf) {
  494. uint8_t* dst = reinterpret_cast<uint8_t*>(buf);
  495. if (cardCommand(cmd, 0)) {
  496. error(SD_CARD_ERROR_READ_REG);
  497. goto fail;
  498. }
  499. return readData(dst, 16);
  500. fail:
  501. chipSelectHigh();
  502. return false;
  503. }
  504. //------------------------------------------------------------------------------
  505. /** Start a read multiple blocks sequence.
  506. *
  507. * \param[in] blockNumber Address of first block in sequence.
  508. *
  509. * \note This function is used with readData() and readStop() for optimized
  510. * multiple block reads. SPI chipSelect must be low for the entire sequence.
  511. *
  512. * \return The value one, true, is returned for success and
  513. * the value zero, false, is returned for failure.
  514. */
  515. bool Sd2Card::readStart(uint32_t blockNumber) {
  516. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  517. if (cardCommand(CMD18, blockNumber)) {
  518. error(SD_CARD_ERROR_CMD18);
  519. goto fail;
  520. }
  521. chipSelectHigh();
  522. return true;
  523. fail:
  524. chipSelectHigh();
  525. return false;
  526. }
  527. //------------------------------------------------------------------------------
  528. /** End a read multiple blocks sequence.
  529. *
  530. * \return The value one, true, is returned for success and
  531. * the value zero, false, is returned for failure.
  532. */
  533. bool Sd2Card::readStop() {
  534. chipSelectLow();
  535. if (cardCommand(CMD12, 0)) {
  536. error(SD_CARD_ERROR_CMD12);
  537. goto fail;
  538. }
  539. chipSelectHigh();
  540. return true;
  541. fail:
  542. chipSelectHigh();
  543. return false;
  544. }
  545. //------------------------------------------------------------------------------
  546. /**
  547. * Set the SPI clock rate.
  548. *
  549. * \param[in] sckRateID A value in the range [0, 6].
  550. *
  551. * The SPI clock will be set to F_CPU/pow(2, 1 + sckRateID). The maximum
  552. * SPI rate is F_CPU/2 for \a sckRateID = 0 and the minimum rate is F_CPU/128
  553. * for \a scsRateID = 6.
  554. *
  555. * \return The value one, true, is returned for success and the value zero,
  556. * false, is returned for an invalid value of \a sckRateID.
  557. */
  558. bool Sd2Card::setSckRate(uint8_t sckRateID) {
  559. if (sckRateID > 6) {
  560. error(SD_CARD_ERROR_SCK_RATE);
  561. return false;
  562. }
  563. spiRate_ = sckRateID;
  564. return true;
  565. }
  566. //------------------------------------------------------------------------------
  567. // wait for card to go not busy
  568. bool Sd2Card::waitNotBusy(uint16_t timeoutMillis) {
  569. uint16_t t0 = millis();
  570. while (spiRec() != 0XFF) {
  571. if (((uint16_t)millis() - t0) >= timeoutMillis) goto fail;
  572. }
  573. return true;
  574. fail:
  575. return false;
  576. }
  577. //------------------------------------------------------------------------------
  578. /**
  579. * Writes a 512 byte block to an SD card.
  580. *
  581. * \param[in] blockNumber Logical block to be written.
  582. * \param[in] src Pointer to the location of the data to be written.
  583. * \return The value one, true, is returned for success and
  584. * the value zero, false, is returned for failure.
  585. */
  586. bool Sd2Card::writeBlock(uint32_t blockNumber, const uint8_t* src) {
  587. // use address if not SDHC card
  588. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  589. if (cardCommand(CMD24, blockNumber)) {
  590. error(SD_CARD_ERROR_CMD24);
  591. goto fail;
  592. }
  593. if (!writeData(DATA_START_BLOCK, src)) goto fail;
  594. // wait for flash programming to complete
  595. if (!waitNotBusy(SD_WRITE_TIMEOUT)) {
  596. error(SD_CARD_ERROR_WRITE_TIMEOUT);
  597. goto fail;
  598. }
  599. // response is r2 so get and check two bytes for nonzero
  600. if (cardCommand(CMD13, 0) || spiRec()) {
  601. error(SD_CARD_ERROR_WRITE_PROGRAMMING);
  602. goto fail;
  603. }
  604. chipSelectHigh();
  605. return true;
  606. fail:
  607. chipSelectHigh();
  608. return false;
  609. }
  610. //------------------------------------------------------------------------------
  611. /** Write one data block in a multiple block write sequence
  612. * \param[in] src Pointer to the location of the data to be written.
  613. * \return The value one, true, is returned for success and
  614. * the value zero, false, is returned for failure.
  615. */
  616. bool Sd2Card::writeData(const uint8_t* src) {
  617. chipSelectLow();
  618. // wait for previous write to finish
  619. if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;
  620. if (!writeData(WRITE_MULTIPLE_TOKEN, src)) goto fail;
  621. chipSelectHigh();
  622. return true;
  623. fail:
  624. error(SD_CARD_ERROR_WRITE_MULTIPLE);
  625. chipSelectHigh();
  626. return false;
  627. }
  628. //------------------------------------------------------------------------------
  629. // send one block of data for write block or write multiple blocks
  630. bool Sd2Card::writeData(uint8_t token, const uint8_t* src) {
  631. spiSendBlock(token, src);
  632. spiSend(0xff); // dummy crc
  633. spiSend(0xff); // dummy crc
  634. status_ = spiRec();
  635. if ((status_ & DATA_RES_MASK) != DATA_RES_ACCEPTED) {
  636. error(SD_CARD_ERROR_WRITE);
  637. goto fail;
  638. }
  639. return true;
  640. fail:
  641. chipSelectHigh();
  642. return false;
  643. }
  644. //------------------------------------------------------------------------------
  645. /** Start a write multiple blocks sequence.
  646. *
  647. * \param[in] blockNumber Address of first block in sequence.
  648. * \param[in] eraseCount The number of blocks to be pre-erased.
  649. *
  650. * \note This function is used with writeData() and writeStop()
  651. * for optimized multiple block writes.
  652. *
  653. * \return The value one, true, is returned for success and
  654. * the value zero, false, is returned for failure.
  655. */
  656. bool Sd2Card::writeStart(uint32_t blockNumber, uint32_t eraseCount) {
  657. // send pre-erase count
  658. if (cardAcmd(ACMD23, eraseCount)) {
  659. error(SD_CARD_ERROR_ACMD23);
  660. goto fail;
  661. }
  662. // use address if not SDHC card
  663. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  664. if (cardCommand(CMD25, blockNumber)) {
  665. error(SD_CARD_ERROR_CMD25);
  666. goto fail;
  667. }
  668. chipSelectHigh();
  669. return true;
  670. fail:
  671. chipSelectHigh();
  672. return false;
  673. }
  674. //------------------------------------------------------------------------------
  675. /** End a write multiple blocks sequence.
  676. *
  677. * \return The value one, true, is returned for success and
  678. * the value zero, false, is returned for failure.
  679. */
  680. bool Sd2Card::writeStop() {
  681. chipSelectLow();
  682. if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;
  683. spiSend(STOP_TRAN_TOKEN);
  684. if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;
  685. chipSelectHigh();
  686. return true;
  687. fail:
  688. error(SD_CARD_ERROR_STOP_TRAN);
  689. chipSelectHigh();
  690. return false;
  691. }
  692. #endif