Sd2Card.h 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  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. #ifndef Sd2Card_h
  23. #define Sd2Card_h
  24. /**
  25. * \file
  26. * \brief Sd2Card class for V2 SD/SDHC cards
  27. */
  28. #include "SdFatConfig.h"
  29. #include "Sd2PinMap.h"
  30. #include "SdInfo.h"
  31. //------------------------------------------------------------------------------
  32. // SPI speed is F_CPU/2^(1 + index), 0 <= index <= 6
  33. /** Set SCK to max rate of F_CPU/2. See Sd2Card::setSckRate(). */
  34. uint8_t const SPI_FULL_SPEED = 0;
  35. /** Set SCK rate to F_CPU/4. See Sd2Card::setSckRate(). */
  36. uint8_t const SPI_HALF_SPEED = 1;
  37. /** Set SCK rate to F_CPU/8. See Sd2Card::setSckRate(). */
  38. uint8_t const SPI_QUARTER_SPEED = 2;
  39. /** Set SCK rate to F_CPU/16. See Sd2Card::setSckRate(). */
  40. uint8_t const SPI_EIGHTH_SPEED = 3;
  41. /** Set SCK rate to F_CPU/32. See Sd2Card::setSckRate(). */
  42. uint8_t const SPI_SIXTEENTH_SPEED = 4;
  43. //------------------------------------------------------------------------------
  44. /** init timeout ms */
  45. uint16_t const SD_INIT_TIMEOUT = 2000;
  46. /** erase timeout ms */
  47. uint16_t const SD_ERASE_TIMEOUT = 10000;
  48. /** read timeout ms */
  49. uint16_t const SD_READ_TIMEOUT = 300;
  50. /** write time out ms */
  51. uint16_t const SD_WRITE_TIMEOUT = 600;
  52. //------------------------------------------------------------------------------
  53. // SD card errors
  54. /** timeout error for command CMD0 (initialize card in SPI mode) */
  55. uint8_t const SD_CARD_ERROR_CMD0 = 0X1;
  56. /** CMD8 was not accepted - not a valid SD card*/
  57. uint8_t const SD_CARD_ERROR_CMD8 = 0X2;
  58. /** card returned an error response for CMD12 (write stop) */
  59. uint8_t const SD_CARD_ERROR_CMD12 = 0X3;
  60. /** card returned an error response for CMD17 (read block) */
  61. uint8_t const SD_CARD_ERROR_CMD17 = 0X4;
  62. /** card returned an error response for CMD18 (read multiple block) */
  63. uint8_t const SD_CARD_ERROR_CMD18 = 0X5;
  64. /** card returned an error response for CMD24 (write block) */
  65. uint8_t const SD_CARD_ERROR_CMD24 = 0X6;
  66. /** WRITE_MULTIPLE_BLOCKS command failed */
  67. uint8_t const SD_CARD_ERROR_CMD25 = 0X7;
  68. /** card returned an error response for CMD58 (read OCR) */
  69. uint8_t const SD_CARD_ERROR_CMD58 = 0X8;
  70. /** SET_WR_BLK_ERASE_COUNT failed */
  71. uint8_t const SD_CARD_ERROR_ACMD23 = 0X9;
  72. /** ACMD41 initialization process timeout */
  73. uint8_t const SD_CARD_ERROR_ACMD41 = 0XA;
  74. /** card returned a bad CSR version field */
  75. uint8_t const SD_CARD_ERROR_BAD_CSD = 0XB;
  76. /** erase block group command failed */
  77. uint8_t const SD_CARD_ERROR_ERASE = 0XC;
  78. /** card not capable of single block erase */
  79. uint8_t const SD_CARD_ERROR_ERASE_SINGLE_BLOCK = 0XD;
  80. /** Erase sequence timed out */
  81. uint8_t const SD_CARD_ERROR_ERASE_TIMEOUT = 0XE;
  82. /** card returned an error token instead of read data */
  83. uint8_t const SD_CARD_ERROR_READ = 0XF;
  84. /** read CID or CSD failed */
  85. uint8_t const SD_CARD_ERROR_READ_REG = 0X10;
  86. /** timeout while waiting for start of read data */
  87. uint8_t const SD_CARD_ERROR_READ_TIMEOUT = 0X11;
  88. /** card did not accept STOP_TRAN_TOKEN */
  89. uint8_t const SD_CARD_ERROR_STOP_TRAN = 0X12;
  90. /** card returned an error token as a response to a write operation */
  91. uint8_t const SD_CARD_ERROR_WRITE = 0X13;
  92. /** attempt to write protected block zero */
  93. uint8_t const SD_CARD_ERROR_WRITE_BLOCK_ZERO = 0X14; // REMOVE - not used
  94. /** card did not go ready for a multiple block write */
  95. uint8_t const SD_CARD_ERROR_WRITE_MULTIPLE = 0X15;
  96. /** card returned an error to a CMD13 status check after a write */
  97. uint8_t const SD_CARD_ERROR_WRITE_PROGRAMMING = 0X16;
  98. /** timeout occurred during write programming */
  99. uint8_t const SD_CARD_ERROR_WRITE_TIMEOUT = 0X17;
  100. /** incorrect rate selected */
  101. uint8_t const SD_CARD_ERROR_SCK_RATE = 0X18;
  102. /** init() not called */
  103. uint8_t const SD_CARD_ERROR_INIT_NOT_CALLED = 0X19;
  104. //------------------------------------------------------------------------------
  105. // card types
  106. /** Standard capacity V1 SD card */
  107. uint8_t const SD_CARD_TYPE_SD1 = 1;
  108. /** Standard capacity V2 SD card */
  109. uint8_t const SD_CARD_TYPE_SD2 = 2;
  110. /** High Capacity SD card */
  111. uint8_t const SD_CARD_TYPE_SDHC = 3;
  112. /**
  113. * define SOFTWARE_SPI to use bit-bang SPI
  114. */
  115. //------------------------------------------------------------------------------
  116. #if MEGA_SOFT_SPI && (defined(__AVR_ATmega1280__)||defined(__AVR_ATmega2560__))
  117. #define SOFTWARE_SPI
  118. #elif USE_SOFTWARE_SPI
  119. #define SOFTWARE_SPI
  120. #endif // MEGA_SOFT_SPI
  121. //------------------------------------------------------------------------------
  122. // SPI pin definitions - do not edit here - change in SdFatConfig.h
  123. //
  124. #ifndef SOFTWARE_SPI
  125. // hardware pin defs
  126. /** The default chip select pin for the SD card is SS. */
  127. uint8_t const SD_CHIP_SELECT_PIN = SS_PIN;
  128. // The following three pins must not be redefined for hardware SPI.
  129. /** SPI Master Out Slave In pin */
  130. uint8_t const SPI_MOSI_PIN = MOSI_PIN;
  131. /** SPI Master In Slave Out pin */
  132. uint8_t const SPI_MISO_PIN = MISO_PIN;
  133. /** SPI Clock pin */
  134. uint8_t const SPI_SCK_PIN = SCK_PIN;
  135. #else // SOFTWARE_SPI
  136. /** SPI chip select pin */
  137. uint8_t const SD_CHIP_SELECT_PIN = SOFT_SPI_CS_PIN;
  138. /** SPI Master Out Slave In pin */
  139. uint8_t const SPI_MOSI_PIN = SOFT_SPI_MOSI_PIN;
  140. /** SPI Master In Slave Out pin */
  141. uint8_t const SPI_MISO_PIN = SOFT_SPI_MISO_PIN;
  142. /** SPI Clock pin */
  143. uint8_t const SPI_SCK_PIN = SOFT_SPI_SCK_PIN;
  144. #endif // SOFTWARE_SPI
  145. //------------------------------------------------------------------------------
  146. /**
  147. * \class Sd2Card
  148. * \brief Raw access to SD and SDHC flash memory cards.
  149. */
  150. class Sd2Card {
  151. public:
  152. /** Construct an instance of Sd2Card. */
  153. Sd2Card() : errorCode_(SD_CARD_ERROR_INIT_NOT_CALLED), type_(0) {}
  154. uint32_t cardSize();
  155. bool erase(uint32_t firstBlock, uint32_t lastBlock);
  156. bool eraseSingleBlockEnable();
  157. /**
  158. * Set SD error code.
  159. * \param[in] code value for error code.
  160. */
  161. void error(uint8_t code) {errorCode_ = code;}
  162. /**
  163. * \return error code for last error. See Sd2Card.h for a list of error codes.
  164. */
  165. int errorCode() const {return errorCode_;}
  166. /** \return error data for last error. */
  167. int errorData() const {return status_;}
  168. /**
  169. * Initialize an SD flash memory card with default clock rate and chip
  170. * select pin. See sd2Card::init(uint8_t sckRateID, uint8_t chipSelectPin).
  171. *
  172. * \return true for success or false for failure.
  173. */
  174. bool init(uint8_t sckRateID = SPI_FULL_SPEED,
  175. uint8_t chipSelectPin = SD_CHIP_SELECT_PIN);
  176. bool readBlock(uint32_t block, uint8_t* dst);
  177. /**
  178. * Read a card's CID register. The CID contains card identification
  179. * information such as Manufacturer ID, Product name, Product serial
  180. * number and Manufacturing date.
  181. *
  182. * \param[out] cid pointer to area for returned data.
  183. *
  184. * \return true for success or false for failure.
  185. */
  186. bool readCID(cid_t* cid) {
  187. return readRegister(CMD10, cid);
  188. }
  189. /**
  190. * Read a card's CSD register. The CSD contains Card-Specific Data that
  191. * provides information regarding access to the card's contents.
  192. *
  193. * \param[out] csd pointer to area for returned data.
  194. *
  195. * \return true for success or false for failure.
  196. */
  197. bool readCSD(csd_t* csd) {
  198. return readRegister(CMD9, csd);
  199. }
  200. bool readData(uint8_t *dst);
  201. bool readStart(uint32_t blockNumber);
  202. bool readStop();
  203. bool setSckRate(uint8_t sckRateID);
  204. /** Return the card type: SD V1, SD V2 or SDHC
  205. * \return 0 - SD V1, 1 - SD V2, or 3 - SDHC.
  206. */
  207. int type() const {return type_;}
  208. bool writeBlock(uint32_t blockNumber, const uint8_t* src);
  209. bool writeData(const uint8_t* src);
  210. bool writeStart(uint32_t blockNumber, uint32_t eraseCount);
  211. bool writeStop();
  212. private:
  213. //----------------------------------------------------------------------------
  214. uint8_t chipSelectPin_;
  215. uint8_t errorCode_;
  216. uint8_t spiRate_;
  217. uint8_t status_;
  218. uint8_t type_;
  219. // private functions
  220. uint8_t cardAcmd(uint8_t cmd, uint32_t arg) {
  221. cardCommand(CMD55, 0);
  222. return cardCommand(cmd, arg);
  223. }
  224. uint8_t cardCommand(uint8_t cmd, uint32_t arg);
  225. bool readData(uint8_t* dst, uint16_t count);
  226. bool readRegister(uint8_t cmd, void* buf);
  227. void chipSelectHigh();
  228. void chipSelectLow();
  229. void type(uint8_t value) {type_ = value;}
  230. bool waitNotBusy(uint16_t timeoutMillis);
  231. bool writeData(uint8_t token, const uint8_t* src);
  232. };
  233. #endif // Sd2Card_h
  234. #endif