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.

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