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 20KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  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. * Updated with backports of the latest SdFat library from the same author
  26. *
  27. * This file is part of the Arduino Sd2Card Library
  28. */
  29. #include "../inc/MarlinConfig.h"
  30. #if ENABLED(SDSUPPORT)
  31. /* Enable FAST CRC computations - You can trade speed for FLASH space if
  32. * needed by disabling the following define */
  33. #define FAST_CRC 1
  34. #include "Sd2Card.h"
  35. #include "../Marlin.h"
  36. #if ENABLED(SD_CHECK_AND_RETRY)
  37. static bool crcSupported = true;
  38. #ifdef FAST_CRC
  39. static const uint8_t crctab7[] PROGMEM = {
  40. 0x00,0x09,0x12,0x1b,0x24,0x2d,0x36,0x3f,0x48,0x41,0x5a,0x53,0x6c,0x65,0x7e,0x77,
  41. 0x19,0x10,0x0b,0x02,0x3d,0x34,0x2f,0x26,0x51,0x58,0x43,0x4a,0x75,0x7c,0x67,0x6e,
  42. 0x32,0x3b,0x20,0x29,0x16,0x1f,0x04,0x0d,0x7a,0x73,0x68,0x61,0x5e,0x57,0x4c,0x45,
  43. 0x2b,0x22,0x39,0x30,0x0f,0x06,0x1d,0x14,0x63,0x6a,0x71,0x78,0x47,0x4e,0x55,0x5c,
  44. 0x64,0x6d,0x76,0x7f,0x40,0x49,0x52,0x5b,0x2c,0x25,0x3e,0x37,0x08,0x01,0x1a,0x13,
  45. 0x7d,0x74,0x6f,0x66,0x59,0x50,0x4b,0x42,0x35,0x3c,0x27,0x2e,0x11,0x18,0x03,0x0a,
  46. 0x56,0x5f,0x44,0x4d,0x72,0x7b,0x60,0x69,0x1e,0x17,0x0c,0x05,0x3a,0x33,0x28,0x21,
  47. 0x4f,0x46,0x5d,0x54,0x6b,0x62,0x79,0x70,0x07,0x0e,0x15,0x1c,0x23,0x2a,0x31,0x38,
  48. 0x41,0x48,0x53,0x5a,0x65,0x6c,0x77,0x7e,0x09,0x00,0x1b,0x12,0x2d,0x24,0x3f,0x36,
  49. 0x58,0x51,0x4a,0x43,0x7c,0x75,0x6e,0x67,0x10,0x19,0x02,0x0b,0x34,0x3d,0x26,0x2f,
  50. 0x73,0x7a,0x61,0x68,0x57,0x5e,0x45,0x4c,0x3b,0x32,0x29,0x20,0x1f,0x16,0x0d,0x04,
  51. 0x6a,0x63,0x78,0x71,0x4e,0x47,0x5c,0x55,0x22,0x2b,0x30,0x39,0x06,0x0f,0x14,0x1d,
  52. 0x25,0x2c,0x37,0x3e,0x01,0x08,0x13,0x1a,0x6d,0x64,0x7f,0x76,0x49,0x40,0x5b,0x52,
  53. 0x3c,0x35,0x2e,0x27,0x18,0x11,0x0a,0x03,0x74,0x7d,0x66,0x6f,0x50,0x59,0x42,0x4b,
  54. 0x17,0x1e,0x05,0x0c,0x33,0x3a,0x21,0x28,0x5f,0x56,0x4d,0x44,0x7b,0x72,0x69,0x60,
  55. 0x0e,0x07,0x1c,0x15,0x2a,0x23,0x38,0x31,0x46,0x4f,0x54,0x5d,0x62,0x6b,0x70,0x79
  56. };
  57. static uint8_t CRC7(const uint8_t* data, uint8_t n) {
  58. uint8_t crc = 0;
  59. while ( n > 0 ) {
  60. crc = pgm_read_byte(&crctab7[ (crc << 1) ^ *data++ ]);
  61. n--;
  62. }
  63. return (crc << 1) | 1;
  64. }
  65. #else
  66. static uint8_t CRC7(const uint8_t* data, uint8_t n) {
  67. uint8_t crc = 0;
  68. for (uint8_t i = 0; i < n; i++) {
  69. uint8_t d = data[i];
  70. d ^= crc << 1;
  71. if (d & 0x80) d ^= 9;
  72. crc = d ^ (crc & 0x78) ^ (crc << 4) ^ ((crc >> 3) & 15);
  73. crc &= 0x7f;
  74. }
  75. crc = (crc << 1) ^ (crc << 4) ^ (crc & 0x70) ^ ((crc >> 3) & 0x0f);
  76. return crc | 1;
  77. }
  78. #endif
  79. #endif
  80. // send command and return error code. Return zero for OK
  81. uint8_t Sd2Card::cardCommand(uint8_t cmd, uint32_t arg) {
  82. // select card
  83. chipSelect();
  84. // wait up to 300 ms if busy
  85. waitNotBusy( SD_WRITE_TIMEOUT );
  86. uint8_t *pa = (uint8_t *)(&arg);
  87. #if ENABLED(SD_CHECK_AND_RETRY)
  88. // form message
  89. uint8_t d[6] = {(uint8_t) (cmd | 0x40), pa[3], pa[2], pa[1], pa[0] };
  90. // add crc
  91. d[5] = CRC7(d, 5);
  92. // send message
  93. for (uint8_t k = 0; k < 6; k++ )
  94. spiSend( d[k] );
  95. #else
  96. // send command
  97. spiSend(cmd | 0x40);
  98. // send argument
  99. for( int8_t i = 3; i >= 0; i-- )
  100. spiSend( pa[i] );
  101. // send CRC - correct for CMD0 with arg zero or CMD8 with arg 0X1AA
  102. spiSend( cmd == CMD0 ? 0X95 : 0X87 );
  103. #endif
  104. // skip stuff byte for stop read
  105. if (cmd == CMD12) spiRec();
  106. // wait for response
  107. for (uint8_t i = 0; ((status_ = spiRec()) & 0x80) && i != 0xFF; i++) { /* Intentionally left empty */ }
  108. return status_;
  109. }
  110. /**
  111. * Determine the size of an SD flash memory card.
  112. *
  113. * \return The number of 512 byte data blocks in the card
  114. * or zero if an error occurs.
  115. */
  116. uint32_t Sd2Card::cardSize() {
  117. csd_t csd;
  118. if (!readCSD(&csd)) return 0;
  119. if (csd.v1.csd_ver == 0) {
  120. uint8_t read_bl_len = csd.v1.read_bl_len;
  121. uint16_t c_size = (csd.v1.c_size_high << 10)
  122. | (csd.v1.c_size_mid << 2) | csd.v1.c_size_low;
  123. uint8_t c_size_mult = (csd.v1.c_size_mult_high << 1)
  124. | csd.v1.c_size_mult_low;
  125. return (uint32_t)(c_size + 1) << (c_size_mult + read_bl_len - 7);
  126. }
  127. else if (csd.v2.csd_ver == 1) {
  128. uint32_t c_size = ((uint32_t)csd.v2.c_size_high << 16)
  129. | (csd.v2.c_size_mid << 8) | csd.v2.c_size_low;
  130. return (c_size + 1) << 10;
  131. }
  132. else {
  133. error(SD_CARD_ERROR_BAD_CSD);
  134. return 0;
  135. }
  136. }
  137. void Sd2Card::chipDeselect() {
  138. digitalWrite(chipSelectPin_, HIGH);
  139. // insure MISO goes high impedance
  140. spiSend( 0xFF );
  141. }
  142. void Sd2Card::chipSelect() {
  143. spiInit(spiRate_);
  144. digitalWrite(chipSelectPin_, LOW);
  145. }
  146. /**
  147. * Erase a range of blocks.
  148. *
  149. * \param[in] firstBlock The address of the first block in the range.
  150. * \param[in] lastBlock The address of the last block in the range.
  151. *
  152. * \note This function requests the SD card to do a flash erase for a
  153. * range of blocks. The data on the card after an erase operation is
  154. * either 0 or 1, depends on the card vendor. The card must support
  155. * single block erase.
  156. *
  157. * \return true for success, false for failure.
  158. */
  159. bool Sd2Card::erase(uint32_t firstBlock, uint32_t lastBlock) {
  160. csd_t csd;
  161. if (!readCSD(&csd)) goto FAIL;
  162. // check for single block erase
  163. if (!csd.v1.erase_blk_en) {
  164. // erase size mask
  165. uint8_t m = (csd.v1.sector_size_high << 1) | csd.v1.sector_size_low;
  166. if ((firstBlock & m) != 0 || ((lastBlock + 1) & m) != 0) {
  167. // error card can't erase specified area
  168. error(SD_CARD_ERROR_ERASE_SINGLE_BLOCK);
  169. goto FAIL;
  170. }
  171. }
  172. if (type_ != SD_CARD_TYPE_SDHC) {
  173. firstBlock <<= 9;
  174. lastBlock <<= 9;
  175. }
  176. if (cardCommand(CMD32, firstBlock)
  177. || cardCommand(CMD33, lastBlock)
  178. || cardCommand(CMD38, 0)) {
  179. error(SD_CARD_ERROR_ERASE);
  180. goto FAIL;
  181. }
  182. if (!waitNotBusy(SD_ERASE_TIMEOUT)) {
  183. error(SD_CARD_ERROR_ERASE_TIMEOUT);
  184. goto FAIL;
  185. }
  186. chipDeselect();
  187. return true;
  188. FAIL:
  189. chipDeselect();
  190. return false;
  191. }
  192. /**
  193. * Determine if card supports single block erase.
  194. *
  195. * \return true if single block erase is supported.
  196. * false if single block erase is not supported.
  197. */
  198. bool Sd2Card::eraseSingleBlockEnable() {
  199. csd_t csd;
  200. return readCSD(&csd) ? csd.v1.erase_blk_en : false;
  201. }
  202. /**
  203. * Initialize an SD flash memory card.
  204. *
  205. * \param[in] sckRateID SPI clock rate selector. See setSckRate().
  206. * \param[in] chipSelectPin SD chip select pin number.
  207. *
  208. * \return true for success, false for failure.
  209. * The reason for failure can be determined by calling errorCode() and errorData().
  210. */
  211. bool Sd2Card::init(uint8_t sckRateID, pin_t chipSelectPin) {
  212. errorCode_ = type_ = 0;
  213. chipSelectPin_ = chipSelectPin;
  214. // 16-bit init start time allows over a minute
  215. uint16_t t0 = (uint16_t)millis();
  216. uint32_t arg;
  217. // If init takes more than 4s it could trigger
  218. // watchdog leading to a reboot loop.
  219. #if ENABLED(USE_WATCHDOG)
  220. watchdog_reset();
  221. #endif
  222. // Set pin modes
  223. digitalWrite(chipSelectPin_, HIGH); // For some CPUs pinMode can write the wrong data so init desired data value first
  224. pinMode(chipSelectPin_, OUTPUT); // Solution for #8746 by @benlye
  225. spiBegin();
  226. // Set SCK rate for initialization commands
  227. spiRate_ = SPI_SD_INIT_RATE;
  228. spiInit(spiRate_);
  229. // Must supply min of 74 clock cycles with CS high.
  230. for (uint8_t i = 0; i < 10; i++) spiSend(0xFF);
  231. // Initialization can cause the watchdog to timeout, so reinit it here
  232. #if ENABLED(USE_WATCHDOG)
  233. watchdog_reset();
  234. #endif
  235. // Command to go idle in SPI mode
  236. while ((status_ = cardCommand(CMD0, 0)) != R1_IDLE_STATE) {
  237. if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {
  238. error(SD_CARD_ERROR_CMD0);
  239. goto FAIL;
  240. }
  241. }
  242. #if ENABLED(SD_CHECK_AND_RETRY)
  243. crcSupported = (cardCommand(CMD59, 1) == R1_IDLE_STATE);
  244. #endif
  245. // Initialization can cause the watchdog to timeout, so reinit it here
  246. #if ENABLED(USE_WATCHDOG)
  247. watchdog_reset();
  248. #endif
  249. // check SD version
  250. for (;;) {
  251. if (cardCommand(CMD8, 0x1AA) == (R1_ILLEGAL_COMMAND | R1_IDLE_STATE)) {
  252. type(SD_CARD_TYPE_SD1);
  253. break;
  254. }
  255. // Get the last byte of r7 response
  256. for (uint8_t i = 0; i < 4; i++) status_ = spiRec();
  257. if (status_ == 0xAA) {
  258. type(SD_CARD_TYPE_SD2);
  259. break;
  260. }
  261. if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {
  262. error(SD_CARD_ERROR_CMD8);
  263. goto FAIL;
  264. }
  265. }
  266. // Initialization can cause the watchdog to timeout, so reinit it here
  267. #if ENABLED(USE_WATCHDOG)
  268. watchdog_reset();
  269. #endif
  270. // initialize card and send host supports SDHC if SD2
  271. arg = type() == SD_CARD_TYPE_SD2 ? 0x40000000 : 0;
  272. while ((status_ = cardAcmd(ACMD41, arg)) != R1_READY_STATE) {
  273. // check for timeout
  274. if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {
  275. error(SD_CARD_ERROR_ACMD41);
  276. goto FAIL;
  277. }
  278. }
  279. // if SD2 read OCR register to check for SDHC card
  280. if (type() == SD_CARD_TYPE_SD2) {
  281. if (cardCommand(CMD58, 0)) {
  282. error(SD_CARD_ERROR_CMD58);
  283. goto FAIL;
  284. }
  285. if ((spiRec() & 0xC0) == 0xC0) type(SD_CARD_TYPE_SDHC);
  286. // discard rest of ocr - contains allowed voltage range
  287. for (uint8_t i = 0; i < 3; i++) spiRec();
  288. }
  289. chipDeselect();
  290. return setSckRate(sckRateID);
  291. FAIL:
  292. chipDeselect();
  293. return false;
  294. }
  295. /**
  296. * Read a 512 byte block from an SD card.
  297. *
  298. * \param[in] blockNumber Logical block to be read.
  299. * \param[out] dst Pointer to the location that will receive the data.
  300. * \return true for success, false for failure.
  301. */
  302. bool Sd2Card::readBlock(uint32_t blockNumber, uint8_t* dst) {
  303. // use address if not SDHC card
  304. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  305. #if ENABLED(SD_CHECK_AND_RETRY)
  306. uint8_t retryCnt = 3;
  307. for(;;) {
  308. if (cardCommand(CMD17, blockNumber))
  309. error(SD_CARD_ERROR_CMD17);
  310. else if (readData(dst, 512))
  311. return true;
  312. chipDeselect();
  313. if (!--retryCnt) break;
  314. cardCommand(CMD12, 0); // Try sending a stop command, ignore the result.
  315. errorCode_ = 0;
  316. }
  317. return false;
  318. #else
  319. if (cardCommand(CMD17, blockNumber)) {
  320. error(SD_CARD_ERROR_CMD17);
  321. chipDeselect();
  322. return false;
  323. }
  324. else
  325. return readData(dst, 512);
  326. #endif
  327. }
  328. /**
  329. * Read one data block in a multiple block read sequence
  330. *
  331. * \param[in] dst Pointer to the location for the data to be read.
  332. *
  333. * \return true for success, false for failure.
  334. */
  335. bool Sd2Card::readData(uint8_t* dst) {
  336. chipSelect();
  337. return readData(dst, 512);
  338. }
  339. #if ENABLED(SD_CHECK_AND_RETRY)
  340. #ifdef FAST_CRC
  341. static const uint16_t crctab16[] PROGMEM = {
  342. 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
  343. 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
  344. 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
  345. 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
  346. 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
  347. 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
  348. 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
  349. 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
  350. 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
  351. 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
  352. 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
  353. 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
  354. 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
  355. 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
  356. 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
  357. 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
  358. 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
  359. 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
  360. 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
  361. 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
  362. 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
  363. 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
  364. 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
  365. 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
  366. 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
  367. 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
  368. 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
  369. 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
  370. 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
  371. 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
  372. 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
  373. 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
  374. };
  375. // faster CRC-CCITT
  376. // uses the x^16,x^12,x^5,x^1 polynomial.
  377. static uint16_t CRC_CCITT(const uint8_t* data, size_t n) {
  378. uint16_t crc = 0;
  379. for (size_t i = 0; i < n; i++) {
  380. crc = pgm_read_word(&crctab16[(crc >> 8 ^ data[i]) & 0xFF]) ^ (crc << 8);
  381. }
  382. return crc;
  383. }
  384. #else
  385. // slower CRC-CCITT
  386. // uses the x^16,x^12,x^5,x^1 polynomial.
  387. static uint16_t CRC_CCITT(const uint8_t* data, size_t n) {
  388. uint16_t crc = 0;
  389. for (size_t i = 0; i < n; i++) {
  390. crc = (uint8_t)(crc >> 8) | (crc << 8);
  391. crc ^= data[i];
  392. crc ^= (uint8_t)(crc & 0xff) >> 4;
  393. crc ^= crc << 12;
  394. crc ^= (crc & 0xff) << 5;
  395. }
  396. return crc;
  397. }
  398. #endif
  399. #endif // SD_CHECK_AND_RETRY
  400. bool Sd2Card::readData(uint8_t* dst, uint16_t count) {
  401. // wait for start block token
  402. uint16_t t0 = millis();
  403. while ((status_ = spiRec()) == 0xFF) {
  404. if (((uint16_t)millis() - t0) > SD_READ_TIMEOUT) {
  405. error(SD_CARD_ERROR_READ_TIMEOUT);
  406. goto FAIL;
  407. }
  408. }
  409. if (status_ != DATA_START_BLOCK) {
  410. error(SD_CARD_ERROR_READ);
  411. goto FAIL;
  412. }
  413. // transfer data
  414. spiRead(dst, count);
  415. #if ENABLED(SD_CHECK_AND_RETRY)
  416. {
  417. uint16_t recvCrc = (spiRec() << 8) | spiRec();
  418. if (crcSupported && recvCrc != CRC_CCITT(dst, count)) {
  419. error(SD_CARD_ERROR_READ_CRC);
  420. goto FAIL;
  421. }
  422. }
  423. #else
  424. // discard CRC
  425. spiRec();
  426. spiRec();
  427. #endif
  428. chipDeselect();
  429. return true;
  430. FAIL:
  431. chipDeselect();
  432. return false;
  433. }
  434. /** read CID or CSR register */
  435. bool Sd2Card::readRegister(uint8_t cmd, void* buf) {
  436. uint8_t* dst = reinterpret_cast<uint8_t*>(buf);
  437. if (cardCommand(cmd, 0)) {
  438. error(SD_CARD_ERROR_READ_REG);
  439. chipDeselect();
  440. return false;
  441. }
  442. return readData(dst, 16);
  443. }
  444. /**
  445. * Start a read multiple blocks sequence.
  446. *
  447. * \param[in] blockNumber Address of first block in sequence.
  448. *
  449. * \note This function is used with readData() and readStop() for optimized
  450. * multiple block reads. SPI chipSelect must be low for the entire sequence.
  451. *
  452. * \return true for success, false for failure.
  453. */
  454. bool Sd2Card::readStart(uint32_t blockNumber) {
  455. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  456. if (cardCommand(CMD18, blockNumber)) {
  457. error(SD_CARD_ERROR_CMD18);
  458. chipDeselect();
  459. return false;
  460. }
  461. chipDeselect();
  462. return true;
  463. }
  464. /**
  465. * End a read multiple blocks sequence.
  466. *
  467. * \return true for success, false for failure.
  468. */
  469. bool Sd2Card::readStop() {
  470. chipSelect();
  471. if (cardCommand(CMD12, 0)) {
  472. error(SD_CARD_ERROR_CMD12);
  473. chipDeselect();
  474. return false;
  475. }
  476. chipDeselect();
  477. return true;
  478. }
  479. /**
  480. * Set the SPI clock rate.
  481. *
  482. * \param[in] sckRateID A value in the range [0, 6].
  483. *
  484. * The SPI clock will be set to F_CPU/pow(2, 1 + sckRateID). The maximum
  485. * SPI rate is F_CPU/2 for \a sckRateID = 0 and the minimum rate is F_CPU/128
  486. * for \a scsRateID = 6.
  487. *
  488. * \return The value one, true, is returned for success and the value zero,
  489. * false, is returned for an invalid value of \a sckRateID.
  490. */
  491. bool Sd2Card::setSckRate(uint8_t sckRateID) {
  492. if (sckRateID > 6) {
  493. error(SD_CARD_ERROR_SCK_RATE);
  494. return false;
  495. }
  496. spiRate_ = sckRateID;
  497. return true;
  498. }
  499. // wait for card to go not busy
  500. bool Sd2Card::waitNotBusy(uint16_t timeoutMillis) {
  501. uint16_t t0 = millis();
  502. while (spiRec() != 0xFF)
  503. if (((uint16_t)millis() - t0) >= timeoutMillis) return false;
  504. return true;
  505. }
  506. /**
  507. * Writes a 512 byte block to an SD card.
  508. *
  509. * \param[in] blockNumber Logical block to be written.
  510. * \param[in] src Pointer to the location of the data to be written.
  511. * \return true for success, false for failure.
  512. */
  513. bool Sd2Card::writeBlock(uint32_t blockNumber, const uint8_t* src) {
  514. // use address if not SDHC card
  515. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  516. if (cardCommand(CMD24, blockNumber)) {
  517. error(SD_CARD_ERROR_CMD24);
  518. goto FAIL;
  519. }
  520. if (!writeData(DATA_START_BLOCK, src)) goto FAIL;
  521. // wait for flash programming to complete
  522. if (!waitNotBusy(SD_WRITE_TIMEOUT)) {
  523. error(SD_CARD_ERROR_WRITE_TIMEOUT);
  524. goto FAIL;
  525. }
  526. // response is r2 so get and check two bytes for nonzero
  527. if (cardCommand(CMD13, 0) || spiRec()) {
  528. error(SD_CARD_ERROR_WRITE_PROGRAMMING);
  529. goto FAIL;
  530. }
  531. chipDeselect();
  532. return true;
  533. FAIL:
  534. chipDeselect();
  535. return false;
  536. }
  537. /**
  538. * Write one data block in a multiple block write sequence
  539. * \param[in] src Pointer to the location of the data to be written.
  540. * \return true for success, false for failure.
  541. */
  542. bool Sd2Card::writeData(const uint8_t* src) {
  543. chipSelect();
  544. // wait for previous write to finish
  545. if (!waitNotBusy(SD_WRITE_TIMEOUT) || !writeData(WRITE_MULTIPLE_TOKEN, src)) {
  546. error(SD_CARD_ERROR_WRITE_MULTIPLE);
  547. chipDeselect();
  548. return false;
  549. }
  550. chipDeselect();
  551. return true;
  552. }
  553. // send one block of data for write block or write multiple blocks
  554. bool Sd2Card::writeData(uint8_t token, const uint8_t* src) {
  555. #if ENABLED(SD_CHECK_AND_RETRY)
  556. uint16_t crc = CRC_CCITT( src, 512 );
  557. #else // ENABLED(SD_CHECK_AND_RETRY)
  558. uint16_t crc = 0xFFFF;
  559. #endif // ENABLED(SD_CHECK_AND_RETRY)
  560. spiSendBlock( token, src );
  561. spiSend( crc >> 8 );
  562. spiSend( crc & 0XFF );
  563. status_ = spiRec();
  564. if ((status_ & DATA_RES_MASK) != DATA_RES_ACCEPTED) {
  565. error(SD_CARD_ERROR_WRITE);
  566. chipDeselect();
  567. return false;
  568. }
  569. return true;
  570. }
  571. /**
  572. * Start a write multiple blocks sequence.
  573. *
  574. * \param[in] blockNumber Address of first block in sequence.
  575. * \param[in] eraseCount The number of blocks to be pre-erased.
  576. *
  577. * \note This function is used with writeData() and writeStop()
  578. * for optimized multiple block writes.
  579. *
  580. * \return true for success, false for failure.
  581. */
  582. bool Sd2Card::writeStart(uint32_t blockNumber, uint32_t eraseCount) {
  583. // send pre-erase count
  584. if (cardAcmd(ACMD23, eraseCount)) {
  585. error(SD_CARD_ERROR_ACMD23);
  586. goto FAIL;
  587. }
  588. // use address if not SDHC card
  589. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  590. if (cardCommand(CMD25, blockNumber)) {
  591. error(SD_CARD_ERROR_CMD25);
  592. goto FAIL;
  593. }
  594. chipDeselect();
  595. return true;
  596. FAIL:
  597. chipDeselect();
  598. return false;
  599. }
  600. /**
  601. * End a write multiple blocks sequence.
  602. *
  603. * \return true for success, false for failure.
  604. */
  605. bool Sd2Card::writeStop() {
  606. chipSelect();
  607. if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto FAIL;
  608. spiSend(STOP_TRAN_TOKEN);
  609. if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto FAIL;
  610. chipDeselect();
  611. return true;
  612. FAIL:
  613. error(SD_CARD_ERROR_STOP_TRAN);
  614. chipDeselect();
  615. return false;
  616. }
  617. #endif // SDSUPPORT