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

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