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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2020 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) && NONE(USB_FLASH_DRIVE_SUPPORT, SDIO_SUPPORT)
  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 "../MarlinCore.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. LOOP_L_N(i, n) {
  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(const uint8_t cmd, const 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. LOOP_L_N(k, 6) spiSend(d[k]);
  94. #else
  95. // Send command
  96. spiSend(cmd | 0x40);
  97. // Send argument
  98. for (int8_t i = 3; i >= 0; i--) spiSend(pa[i]);
  99. // Send CRC - correct for CMD0 with arg zero or CMD8 with arg 0X1AA
  100. spiSend(cmd == CMD0 ? 0X95 : 0X87);
  101. #endif
  102. // Skip stuff byte for stop read
  103. if (cmd == CMD12) spiRec();
  104. // Wait for response
  105. for (uint8_t i = 0; ((status_ = spiRec()) & 0x80) && i != 0xFF; i++) { /* Intentionally left empty */ }
  106. return status_;
  107. }
  108. /**
  109. * Determine the size of an SD flash memory card.
  110. *
  111. * \return The number of 512 byte data blocks in the card
  112. * or zero if an error occurs.
  113. */
  114. uint32_t Sd2Card::cardSize() {
  115. csd_t csd;
  116. if (!readCSD(&csd)) return 0;
  117. if (csd.v1.csd_ver == 0) {
  118. uint8_t read_bl_len = csd.v1.read_bl_len;
  119. uint16_t c_size = (csd.v1.c_size_high << 10)
  120. | (csd.v1.c_size_mid << 2) | csd.v1.c_size_low;
  121. uint8_t c_size_mult = (csd.v1.c_size_mult_high << 1)
  122. | csd.v1.c_size_mult_low;
  123. return (uint32_t)(c_size + 1) << (c_size_mult + read_bl_len - 7);
  124. }
  125. else if (csd.v2.csd_ver == 1) {
  126. uint32_t c_size = ((uint32_t)csd.v2.c_size_high << 16)
  127. | (csd.v2.c_size_mid << 8) | csd.v2.c_size_low;
  128. return (c_size + 1) << 10;
  129. }
  130. else {
  131. error(SD_CARD_ERROR_BAD_CSD);
  132. return 0;
  133. }
  134. }
  135. void Sd2Card::chipDeselect() {
  136. extDigitalWrite(chipSelectPin_, HIGH);
  137. spiSend(0xFF); // Ensure MISO goes high impedance
  138. }
  139. void Sd2Card::chipSelect() {
  140. spiInit(spiRate_);
  141. extDigitalWrite(chipSelectPin_, LOW);
  142. }
  143. /**
  144. * Erase a range of blocks.
  145. *
  146. * \param[in] firstBlock The address of the first block in the range.
  147. * \param[in] lastBlock The address of the last block in the range.
  148. *
  149. * \note This function requests the SD card to do a flash erase for a
  150. * range of blocks. The data on the card after an erase operation is
  151. * either 0 or 1, depends on the card vendor. The card must support
  152. * single block erase.
  153. *
  154. * \return true for success, false for failure.
  155. */
  156. bool Sd2Card::erase(uint32_t firstBlock, uint32_t lastBlock) {
  157. csd_t csd;
  158. if (!readCSD(&csd)) goto FAIL;
  159. // check for single block erase
  160. if (!csd.v1.erase_blk_en) {
  161. // erase size mask
  162. uint8_t m = (csd.v1.sector_size_high << 1) | csd.v1.sector_size_low;
  163. if ((firstBlock & m) != 0 || ((lastBlock + 1) & m) != 0) {
  164. // error card can't erase specified area
  165. error(SD_CARD_ERROR_ERASE_SINGLE_BLOCK);
  166. goto FAIL;
  167. }
  168. }
  169. if (type_ != SD_CARD_TYPE_SDHC) { firstBlock <<= 9; lastBlock <<= 9; }
  170. if (cardCommand(CMD32, firstBlock) || cardCommand(CMD33, lastBlock) || cardCommand(CMD38, 0)) {
  171. error(SD_CARD_ERROR_ERASE);
  172. goto FAIL;
  173. }
  174. if (!waitNotBusy(SD_ERASE_TIMEOUT)) {
  175. error(SD_CARD_ERROR_ERASE_TIMEOUT);
  176. goto FAIL;
  177. }
  178. chipDeselect();
  179. return true;
  180. FAIL:
  181. chipDeselect();
  182. return false;
  183. }
  184. /**
  185. * Determine if card supports single block erase.
  186. *
  187. * \return true if single block erase is supported.
  188. * false if single block erase is not supported.
  189. */
  190. bool Sd2Card::eraseSingleBlockEnable() {
  191. csd_t csd;
  192. return readCSD(&csd) ? csd.v1.erase_blk_en : false;
  193. }
  194. /**
  195. * Initialize an SD flash memory card.
  196. *
  197. * \param[in] sckRateID SPI clock rate selector. See setSckRate().
  198. * \param[in] chipSelectPin SD chip select pin number.
  199. *
  200. * \return true for success, false for failure.
  201. * The reason for failure can be determined by calling errorCode() and errorData().
  202. */
  203. bool Sd2Card::init(const uint8_t sckRateID, const pin_t chipSelectPin) {
  204. errorCode_ = type_ = 0;
  205. chipSelectPin_ = chipSelectPin;
  206. // 16-bit init start time allows over a minute
  207. const millis_t init_timeout = millis() + SD_INIT_TIMEOUT;
  208. uint32_t arg;
  209. watchdog_refresh(); // In case init takes too long
  210. // Set pin modes
  211. extDigitalWrite(chipSelectPin_, HIGH); // For some CPUs pinMode can write the wrong data so init desired data value first
  212. pinMode(chipSelectPin_, OUTPUT); // Solution for #8746 by @benlye
  213. spiBegin();
  214. // Set SCK rate for initialization commands
  215. spiRate_ = SPI_SD_INIT_RATE;
  216. spiInit(spiRate_);
  217. // Must supply min of 74 clock cycles with CS high.
  218. LOOP_L_N(i, 10) spiSend(0xFF);
  219. watchdog_refresh(); // In case init takes too long
  220. // Command to go idle in SPI mode
  221. while ((status_ = cardCommand(CMD0, 0)) != R1_IDLE_STATE) {
  222. if (ELAPSED(millis(), init_timeout)) {
  223. error(SD_CARD_ERROR_CMD0);
  224. goto FAIL;
  225. }
  226. }
  227. #if ENABLED(SD_CHECK_AND_RETRY)
  228. crcSupported = (cardCommand(CMD59, 1) == R1_IDLE_STATE);
  229. #endif
  230. watchdog_refresh(); // In case init takes too long
  231. // check SD version
  232. for (;;) {
  233. if (cardCommand(CMD8, 0x1AA) == (R1_ILLEGAL_COMMAND | R1_IDLE_STATE)) {
  234. type(SD_CARD_TYPE_SD1);
  235. break;
  236. }
  237. // Get the last byte of r7 response
  238. LOOP_L_N(i, 4) status_ = spiRec();
  239. if (status_ == 0xAA) {
  240. type(SD_CARD_TYPE_SD2);
  241. break;
  242. }
  243. if (ELAPSED(millis(), init_timeout)) {
  244. error(SD_CARD_ERROR_CMD8);
  245. goto FAIL;
  246. }
  247. }
  248. watchdog_refresh(); // In case init takes too long
  249. // Initialize card and send host supports SDHC if SD2
  250. arg = type() == SD_CARD_TYPE_SD2 ? 0x40000000 : 0;
  251. while ((status_ = cardAcmd(ACMD41, arg)) != R1_READY_STATE) {
  252. // Check for timeout
  253. if (ELAPSED(millis(), init_timeout)) {
  254. error(SD_CARD_ERROR_ACMD41);
  255. goto FAIL;
  256. }
  257. }
  258. // If SD2 read OCR register to check for SDHC card
  259. if (type() == SD_CARD_TYPE_SD2) {
  260. if (cardCommand(CMD58, 0)) {
  261. error(SD_CARD_ERROR_CMD58);
  262. goto FAIL;
  263. }
  264. if ((spiRec() & 0xC0) == 0xC0) type(SD_CARD_TYPE_SDHC);
  265. // Discard rest of ocr - contains allowed voltage range
  266. LOOP_L_N(i, 3) spiRec();
  267. }
  268. chipDeselect();
  269. return setSckRate(sckRateID);
  270. FAIL:
  271. chipDeselect();
  272. return false;
  273. }
  274. /**
  275. * Read a 512 byte block from an SD card.
  276. *
  277. * \param[in] blockNumber Logical block to be read.
  278. * \param[out] dst Pointer to the location that will receive the data.
  279. * \return true for success, false for failure.
  280. */
  281. bool Sd2Card::readBlock(uint32_t blockNumber, uint8_t* dst) {
  282. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9; // Use address if not SDHC card
  283. #if ENABLED(SD_CHECK_AND_RETRY)
  284. uint8_t retryCnt = 3;
  285. for (;;) {
  286. if (cardCommand(CMD17, blockNumber))
  287. error(SD_CARD_ERROR_CMD17);
  288. else if (readData(dst, 512))
  289. return true;
  290. chipDeselect();
  291. if (!--retryCnt) break;
  292. cardCommand(CMD12, 0); // Try sending a stop command, ignore the result.
  293. errorCode_ = 0;
  294. }
  295. return false;
  296. #else
  297. if (cardCommand(CMD17, blockNumber)) {
  298. error(SD_CARD_ERROR_CMD17);
  299. chipDeselect();
  300. return false;
  301. }
  302. else
  303. return readData(dst, 512);
  304. #endif
  305. }
  306. /**
  307. * Read one data block in a multiple block read sequence
  308. *
  309. * \param[in] dst Pointer to the location for the data to be read.
  310. *
  311. * \return true for success, false for failure.
  312. */
  313. bool Sd2Card::readData(uint8_t* dst) {
  314. chipSelect();
  315. return readData(dst, 512);
  316. }
  317. #if ENABLED(SD_CHECK_AND_RETRY)
  318. #ifdef FAST_CRC
  319. static const uint16_t crctab16[] PROGMEM = {
  320. 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
  321. 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
  322. 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
  323. 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
  324. 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
  325. 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
  326. 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
  327. 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
  328. 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
  329. 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
  330. 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
  331. 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
  332. 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
  333. 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
  334. 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
  335. 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
  336. 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
  337. 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
  338. 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
  339. 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
  340. 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
  341. 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
  342. 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
  343. 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
  344. 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
  345. 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
  346. 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
  347. 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
  348. 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
  349. 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
  350. 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
  351. 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
  352. };
  353. // faster CRC-CCITT
  354. // uses the x^16,x^12,x^5,x^1 polynomial.
  355. static uint16_t CRC_CCITT(const uint8_t* data, size_t n) {
  356. uint16_t crc = 0;
  357. for (size_t i = 0; i < n; i++) {
  358. crc = pgm_read_word(&crctab16[(crc >> 8 ^ data[i]) & 0xFF]) ^ (crc << 8);
  359. }
  360. return crc;
  361. }
  362. #else
  363. // slower CRC-CCITT
  364. // uses the x^16,x^12,x^5,x^1 polynomial.
  365. static uint16_t CRC_CCITT(const uint8_t* data, size_t n) {
  366. uint16_t crc = 0;
  367. for (size_t i = 0; i < n; i++) {
  368. crc = (uint8_t)(crc >> 8) | (crc << 8);
  369. crc ^= data[i];
  370. crc ^= (uint8_t)(crc & 0xFF) >> 4;
  371. crc ^= crc << 12;
  372. crc ^= (crc & 0xFF) << 5;
  373. }
  374. return crc;
  375. }
  376. #endif
  377. #endif // SD_CHECK_AND_RETRY
  378. bool Sd2Card::readData(uint8_t* dst, const uint16_t count) {
  379. bool success = false;
  380. const millis_t read_timeout = millis() + SD_READ_TIMEOUT;
  381. while ((status_ = spiRec()) == 0xFF) { // Wait for start block token
  382. if (ELAPSED(millis(), read_timeout)) {
  383. error(SD_CARD_ERROR_READ_TIMEOUT);
  384. goto FAIL;
  385. }
  386. }
  387. if (status_ == DATA_START_BLOCK) {
  388. spiRead(dst, count); // Transfer data
  389. const uint16_t recvCrc = (spiRec() << 8) | spiRec();
  390. #if ENABLED(SD_CHECK_AND_RETRY)
  391. success = !crcSupported || recvCrc == CRC_CCITT(dst, count);
  392. if (!success) error(SD_CARD_ERROR_READ_CRC);
  393. #else
  394. success = true;
  395. UNUSED(recvCrc);
  396. #endif
  397. }
  398. else
  399. error(SD_CARD_ERROR_READ);
  400. FAIL:
  401. chipDeselect();
  402. return success;
  403. }
  404. /** read CID or CSR register */
  405. bool Sd2Card::readRegister(const uint8_t cmd, void* buf) {
  406. uint8_t* dst = reinterpret_cast<uint8_t*>(buf);
  407. if (cardCommand(cmd, 0)) {
  408. error(SD_CARD_ERROR_READ_REG);
  409. chipDeselect();
  410. return false;
  411. }
  412. return readData(dst, 16);
  413. }
  414. /**
  415. * Start a read multiple blocks sequence.
  416. *
  417. * \param[in] blockNumber Address of first block in sequence.
  418. *
  419. * \note This function is used with readData() and readStop() for optimized
  420. * multiple block reads. SPI chipSelect must be low for the entire sequence.
  421. *
  422. * \return true for success, false for failure.
  423. */
  424. bool Sd2Card::readStart(uint32_t blockNumber) {
  425. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
  426. const bool success = !cardCommand(CMD18, blockNumber);
  427. if (!success) error(SD_CARD_ERROR_CMD18);
  428. chipDeselect();
  429. return success;
  430. }
  431. /**
  432. * End a read multiple blocks sequence.
  433. *
  434. * \return true for success, false for failure.
  435. */
  436. bool Sd2Card::readStop() {
  437. chipSelect();
  438. const bool success = !cardCommand(CMD12, 0);
  439. if (!success) error(SD_CARD_ERROR_CMD12);
  440. chipDeselect();
  441. return success;
  442. }
  443. /**
  444. * Set the SPI clock rate.
  445. *
  446. * \param[in] sckRateID A value in the range [0, 6].
  447. *
  448. * The SPI clock will be set to F_CPU/pow(2, 1 + sckRateID). The maximum
  449. * SPI rate is F_CPU/2 for \a sckRateID = 0 and the minimum rate is F_CPU/128
  450. * for \a scsRateID = 6.
  451. *
  452. * \return The value one, true, is returned for success and the value zero,
  453. * false, is returned for an invalid value of \a sckRateID.
  454. */
  455. bool Sd2Card::setSckRate(const uint8_t sckRateID) {
  456. const bool success = (sckRateID <= 6);
  457. if (success) spiRate_ = sckRateID; else error(SD_CARD_ERROR_SCK_RATE);
  458. return success;
  459. }
  460. /**
  461. * Wait for card to become not-busy
  462. * \param[in] timeout_ms Timeout to abort.
  463. * \return true for success, false for timeout.
  464. */
  465. bool Sd2Card::waitNotBusy(const millis_t timeout_ms) {
  466. const millis_t wait_timeout = millis() + timeout_ms;
  467. while (spiRec() != 0xFF) if (ELAPSED(millis(), wait_timeout)) return false;
  468. return true;
  469. }
  470. /**
  471. * Write a 512 byte block to an SD card.
  472. *
  473. * \param[in] blockNumber Logical block to be written.
  474. * \param[in] src Pointer to the location of the data to be written.
  475. * \return true for success, false for failure.
  476. */
  477. bool Sd2Card::writeBlock(uint32_t blockNumber, const uint8_t* src) {
  478. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9; // Use address if not SDHC card
  479. bool success = false;
  480. if (!cardCommand(CMD24, blockNumber)) {
  481. if (writeData(DATA_START_BLOCK, src)) {
  482. if (waitNotBusy(SD_WRITE_TIMEOUT)) { // Wait for flashing to complete
  483. success = !(cardCommand(CMD13, 0) || spiRec()); // Response is r2 so get and check two bytes for nonzero
  484. if (!success) error(SD_CARD_ERROR_WRITE_PROGRAMMING);
  485. }
  486. else
  487. error(SD_CARD_ERROR_WRITE_TIMEOUT);
  488. }
  489. }
  490. else
  491. error(SD_CARD_ERROR_CMD24);
  492. chipDeselect();
  493. return success;
  494. }
  495. /**
  496. * Write one data block in a multiple block write sequence
  497. * \param[in] src Pointer to the location of the data to be written.
  498. * \return true for success, false for failure.
  499. */
  500. bool Sd2Card::writeData(const uint8_t* src) {
  501. bool success = true;
  502. chipSelect();
  503. // Wait for previous write to finish
  504. if (!waitNotBusy(SD_WRITE_TIMEOUT) || !writeData(WRITE_MULTIPLE_TOKEN, src)) {
  505. error(SD_CARD_ERROR_WRITE_MULTIPLE);
  506. success = false;
  507. }
  508. chipDeselect();
  509. return success;
  510. }
  511. // Send one block of data for write block or write multiple blocks
  512. bool Sd2Card::writeData(const uint8_t token, const uint8_t* src) {
  513. uint16_t crc =
  514. #if ENABLED(SD_CHECK_AND_RETRY)
  515. CRC_CCITT(src, 512)
  516. #else
  517. 0xFFFF
  518. #endif
  519. ;
  520. spiSendBlock(token, src);
  521. spiSend(crc >> 8);
  522. spiSend(crc & 0xFF);
  523. status_ = spiRec();
  524. if ((status_ & DATA_RES_MASK) != DATA_RES_ACCEPTED) {
  525. error(SD_CARD_ERROR_WRITE);
  526. chipDeselect();
  527. return false;
  528. }
  529. return true;
  530. }
  531. /**
  532. * Start a write multiple blocks sequence.
  533. *
  534. * \param[in] blockNumber Address of first block in sequence.
  535. * \param[in] eraseCount The number of blocks to be pre-erased.
  536. *
  537. * \note This function is used with writeData() and writeStop()
  538. * for optimized multiple block writes.
  539. *
  540. * \return true for success, false for failure.
  541. */
  542. bool Sd2Card::writeStart(uint32_t blockNumber, const uint32_t eraseCount) {
  543. bool success = false;
  544. if (!cardAcmd(ACMD23, eraseCount)) { // Send pre-erase count
  545. if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9; // Use address if not SDHC card
  546. success = !cardCommand(CMD25, blockNumber);
  547. if (!success) error(SD_CARD_ERROR_CMD25);
  548. }
  549. else
  550. error(SD_CARD_ERROR_ACMD23);
  551. chipDeselect();
  552. return success;
  553. }
  554. /**
  555. * End a write multiple blocks sequence.
  556. *
  557. * \return true for success, false for failure.
  558. */
  559. bool Sd2Card::writeStop() {
  560. bool success = false;
  561. chipSelect();
  562. if (waitNotBusy(SD_WRITE_TIMEOUT)) {
  563. spiSend(STOP_TRAN_TOKEN);
  564. success = waitNotBusy(SD_WRITE_TIMEOUT);
  565. }
  566. else
  567. error(SD_CARD_ERROR_STOP_TRAN);
  568. chipDeselect();
  569. return success;
  570. }
  571. #endif // SDSUPPORT