Sd2Card.cpp 25 KB

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