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 7.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2019 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. #pragma once
  23. /**
  24. * \file
  25. * \brief Sd2Card class for V2 SD/SDHC cards
  26. */
  27. /**
  28. * Arduino Sd2Card Library
  29. * Copyright (c) 2009 by William Greiman
  30. *
  31. * This file is part of the Arduino Sd2Card Library
  32. */
  33. #include "SdFatConfig.h"
  34. #include "SdInfo.h"
  35. #include <stdint.h>
  36. uint16_t const SD_INIT_TIMEOUT = 2000, // init timeout ms
  37. SD_ERASE_TIMEOUT = 10000, // erase timeout ms
  38. SD_READ_TIMEOUT = 300, // read timeout ms
  39. SD_WRITE_TIMEOUT = 600; // write time out ms
  40. // SD card errors
  41. uint8_t const SD_CARD_ERROR_CMD0 = 0x01, // timeout error for command CMD0 (initialize card in SPI mode)
  42. SD_CARD_ERROR_CMD8 = 0x02, // CMD8 was not accepted - not a valid SD card
  43. SD_CARD_ERROR_CMD12 = 0x03, // card returned an error response for CMD12 (write stop)
  44. SD_CARD_ERROR_CMD17 = 0x04, // card returned an error response for CMD17 (read block)
  45. SD_CARD_ERROR_CMD18 = 0x05, // card returned an error response for CMD18 (read multiple block)
  46. SD_CARD_ERROR_CMD24 = 0x06, // card returned an error response for CMD24 (write block)
  47. SD_CARD_ERROR_CMD25 = 0x07, // WRITE_MULTIPLE_BLOCKS command failed
  48. SD_CARD_ERROR_CMD58 = 0x08, // card returned an error response for CMD58 (read OCR)
  49. SD_CARD_ERROR_ACMD23 = 0x09, // SET_WR_BLK_ERASE_COUNT failed
  50. SD_CARD_ERROR_ACMD41 = 0x0A, // ACMD41 initialization process timeout
  51. SD_CARD_ERROR_BAD_CSD = 0x0B, // card returned a bad CSR version field
  52. SD_CARD_ERROR_ERASE = 0x0C, // erase block group command failed
  53. SD_CARD_ERROR_ERASE_SINGLE_BLOCK = 0x0D, // card not capable of single block erase
  54. SD_CARD_ERROR_ERASE_TIMEOUT = 0x0E, // Erase sequence timed out
  55. SD_CARD_ERROR_READ = 0x0F, // card returned an error token instead of read data
  56. SD_CARD_ERROR_READ_REG = 0x10, // read CID or CSD failed
  57. SD_CARD_ERROR_READ_TIMEOUT = 0x11, // timeout while waiting for start of read data
  58. SD_CARD_ERROR_STOP_TRAN = 0x12, // card did not accept STOP_TRAN_TOKEN
  59. SD_CARD_ERROR_WRITE = 0x13, // card returned an error token as a response to a write operation
  60. SD_CARD_ERROR_WRITE_BLOCK_ZERO = 0x14, // REMOVE - not used ... attempt to write protected block zero
  61. SD_CARD_ERROR_WRITE_MULTIPLE = 0x15, // card did not go ready for a multiple block write
  62. SD_CARD_ERROR_WRITE_PROGRAMMING = 0x16, // card returned an error to a CMD13 status check after a write
  63. SD_CARD_ERROR_WRITE_TIMEOUT = 0x17, // timeout occurred during write programming
  64. SD_CARD_ERROR_SCK_RATE = 0x18, // incorrect rate selected
  65. SD_CARD_ERROR_INIT_NOT_CALLED = 0x19, // init() not called
  66. // 0x1A is unused now, it was: card returned an error for CMD59 (CRC_ON_OFF)
  67. SD_CARD_ERROR_READ_CRC = 0x1B; // invalid read CRC
  68. // card types
  69. uint8_t const SD_CARD_TYPE_SD1 = 1, // Standard capacity V1 SD card
  70. SD_CARD_TYPE_SD2 = 2, // Standard capacity V2 SD card
  71. SD_CARD_TYPE_SDHC = 3; // High Capacity SD card
  72. /**
  73. * define SOFTWARE_SPI to use bit-bang SPI
  74. */
  75. #if MEGA_SOFT_SPI
  76. #define SOFTWARE_SPI
  77. #elif USE_SOFTWARE_SPI
  78. #define SOFTWARE_SPI
  79. #endif // MEGA_SOFT_SPI
  80. /**
  81. * \class Sd2Card
  82. * \brief Raw access to SD and SDHC flash memory cards.
  83. */
  84. class Sd2Card {
  85. public:
  86. Sd2Card() : errorCode_(SD_CARD_ERROR_INIT_NOT_CALLED), type_(0) {}
  87. uint32_t cardSize();
  88. bool erase(uint32_t firstBlock, uint32_t lastBlock);
  89. bool eraseSingleBlockEnable();
  90. /**
  91. * Set SD error code.
  92. * \param[in] code value for error code.
  93. */
  94. inline void error(const uint8_t code) { errorCode_ = code; }
  95. /**
  96. * \return error code for last error. See Sd2Card.h for a list of error codes.
  97. */
  98. inline int errorCode() const { return errorCode_; }
  99. /** \return error data for last error. */
  100. inline int errorData() const { return status_; }
  101. /**
  102. * Initialize an SD flash memory card with default clock rate and chip
  103. * select pin. See sd2Card::init(uint8_t sckRateID, uint8_t chipSelectPin).
  104. *
  105. * \return true for success or false for failure.
  106. */
  107. bool init(const uint8_t sckRateID, const pin_t chipSelectPin);
  108. bool readBlock(uint32_t block, uint8_t* dst);
  109. /**
  110. * Read a card's CID register. The CID contains card identification
  111. * information such as Manufacturer ID, Product name, Product serial
  112. * number and Manufacturing date.
  113. *
  114. * \param[out] cid pointer to area for returned data.
  115. *
  116. * \return true for success or false for failure.
  117. */
  118. bool readCID(cid_t* cid) { return readRegister(CMD10, cid); }
  119. /**
  120. * Read a card's CSD register. The CSD contains Card-Specific Data that
  121. * provides information regarding access to the card's contents.
  122. *
  123. * \param[out] csd pointer to area for returned data.
  124. *
  125. * \return true for success or false for failure.
  126. */
  127. inline bool readCSD(csd_t* csd) { return readRegister(CMD9, csd); }
  128. bool readData(uint8_t* dst);
  129. bool readStart(uint32_t blockNumber);
  130. bool readStop();
  131. bool setSckRate(const uint8_t sckRateID);
  132. /**
  133. * Return the card type: SD V1, SD V2 or SDHC
  134. * \return 0 - SD V1, 1 - SD V2, or 3 - SDHC.
  135. */
  136. int type() const {return type_;}
  137. bool writeBlock(uint32_t blockNumber, const uint8_t* src);
  138. bool writeData(const uint8_t* src);
  139. bool writeStart(uint32_t blockNumber, const uint32_t eraseCount);
  140. bool writeStop();
  141. private:
  142. uint8_t chipSelectPin_,
  143. errorCode_,
  144. spiRate_,
  145. status_,
  146. type_;
  147. // private functions
  148. inline uint8_t cardAcmd(const uint8_t cmd, const uint32_t arg) {
  149. cardCommand(CMD55, 0);
  150. return cardCommand(cmd, arg);
  151. }
  152. uint8_t cardCommand(const uint8_t cmd, const uint32_t arg);
  153. bool readData(uint8_t* dst, const uint16_t count);
  154. bool readRegister(const uint8_t cmd, void* buf);
  155. void chipDeselect();
  156. void chipSelect();
  157. inline void type(const uint8_t value) { type_ = value; }
  158. bool waitNotBusy(const millis_t timeout_ms);
  159. bool writeData(const uint8_t token, const uint8_t* src);
  160. };