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.h 9.1KB

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