-/* Arduino Sd2Card Library
- * Copyright (C) 2009 by William Greiman
- *
- * This file is part of the Arduino Sd2Card Library
- *
- * This Library is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This Library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with the Arduino Sd2Card Library. If not, see
- * <http://www.gnu.org/licenses/>.
- */
-#if ARDUINO < 100
-#define HardwareSerial_h // trick to disable the standard HWserial
-#include <WProgram.h>
-#else // ARDUINO
-#include <Arduino.h>
-#endif // ARDUINO
-#include "Sd2Card.h"
-//------------------------------------------------------------------------------
-#ifndef SOFTWARE_SPI
-// functions for hardware SPI
-//------------------------------------------------------------------------------
-// make sure SPCR rate is in expected bits
-#if (SPR0 != 0 || SPR1 != 1)
-#error unexpected SPCR bits
-#endif
-/**
- * Initialize hardware SPI
- * Set SCK rate to F_CPU/pow(2, 1 + spiRate) for spiRate [0,6]
- */
-static void spiInit(uint8_t spiRate) {
- // See avr processor documentation
- SPCR = (1 << SPE) | (1 << MSTR) | (spiRate >> 1);
- SPSR = spiRate & 1 || spiRate == 6 ? 0 : 1 << SPI2X;
-}
-//------------------------------------------------------------------------------
-/** SPI receive a byte */
-static uint8_t spiRec() {
- SPDR = 0XFF;
- while (!(SPSR & (1 << SPIF)));
- return SPDR;
-}
-//------------------------------------------------------------------------------
-/** SPI read data - only one call so force inline */
-static inline __attribute__((always_inline))
- void spiRead(uint8_t* buf, uint16_t nbyte) {
- if (nbyte-- == 0) return;
- SPDR = 0XFF;
- for (uint16_t i = 0; i < nbyte; i++) {
- while (!(SPSR & (1 << SPIF)));
- buf[i] = SPDR;
- SPDR = 0XFF;
- }
- while (!(SPSR & (1 << SPIF)));
- buf[nbyte] = SPDR;
-}
-//------------------------------------------------------------------------------
-/** SPI send a byte */
-static void spiSend(uint8_t b) {
- SPDR = b;
- while (!(SPSR & (1 << SPIF)));
-}
-//------------------------------------------------------------------------------
-/** SPI send block - only one call so force inline */
-static inline __attribute__((always_inline))
- void spiSendBlock(uint8_t token, const uint8_t* buf) {
- SPDR = token;
- for (uint16_t i = 0; i < 512; i += 2) {
- while (!(SPSR & (1 << SPIF)));
- SPDR = buf[i];
- while (!(SPSR & (1 << SPIF)));
- SPDR = buf[i + 1];
- }
- while (!(SPSR & (1 << SPIF)));
-}
-//------------------------------------------------------------------------------
-#else // SOFTWARE_SPI
-//------------------------------------------------------------------------------
-/** nop to tune soft SPI timing */
-#define nop asm volatile ("nop\n\t")
-//------------------------------------------------------------------------------
-/** Soft SPI receive byte */
-static uint8_t spiRec() {
- uint8_t data = 0;
- // no interrupts during byte receive - about 8 us
- cli();
- // output pin high - like sending 0XFF
- fastDigitalWrite(SPI_MOSI_PIN, HIGH);
-
- for (uint8_t i = 0; i < 8; i++) {
- fastDigitalWrite(SPI_SCK_PIN, HIGH);
-
- // adjust so SCK is nice
- nop;
- nop;
-
- data <<= 1;
-
- if (fastDigitalRead(SPI_MISO_PIN)) data |= 1;
-
- fastDigitalWrite(SPI_SCK_PIN, LOW);
- }
- // enable interrupts
- sei();
- return data;
-}
-//------------------------------------------------------------------------------
-/** Soft SPI read data */
-static void spiRead(uint8_t* buf, uint16_t nbyte) {
- for (uint16_t i = 0; i < nbyte; i++) {
- buf[i] = spiRec();
- }
-}
-//------------------------------------------------------------------------------
-/** Soft SPI send byte */
-static void spiSend(uint8_t data) {
- // no interrupts during byte send - about 8 us
- cli();
- for (uint8_t i = 0; i < 8; i++) {
- fastDigitalWrite(SPI_SCK_PIN, LOW);
-
- fastDigitalWrite(SPI_MOSI_PIN, data & 0X80);
-
- data <<= 1;
-
- fastDigitalWrite(SPI_SCK_PIN, HIGH);
- }
- // hold SCK high for a few ns
- nop;
- nop;
- nop;
- nop;
-
- fastDigitalWrite(SPI_SCK_PIN, LOW);
- // enable interrupts
- sei();
-}
-//------------------------------------------------------------------------------
-/** Soft SPI send block */
- void spiSendBlock(uint8_t token, const uint8_t* buf) {
- spiSend(token);
- for (uint16_t i = 0; i < 512; i++) {
- spiSend(buf[i]);
- }
-}
-#endif // SOFTWARE_SPI
-//------------------------------------------------------------------------------
-// send command and return error code. Return zero for OK
-uint8_t Sd2Card::cardCommand(uint8_t cmd, uint32_t arg) {
- // select card
- chipSelectLow();
-
- // wait up to 300 ms if busy
- waitNotBusy(300);
-
- // send command
- spiSend(cmd | 0x40);
-
- // send argument
- for (int8_t s = 24; s >= 0; s -= 8) spiSend(arg >> s);
-
- // send CRC
- uint8_t crc = 0XFF;
- if (cmd == CMD0) crc = 0X95; // correct crc for CMD0 with arg 0
- if (cmd == CMD8) crc = 0X87; // correct crc for CMD8 with arg 0X1AA
- spiSend(crc);
-
- // skip stuff byte for stop read
- if (cmd == CMD12) spiRec();
-
- // wait for response
- for (uint8_t i = 0; ((status_ = spiRec()) & 0X80) && i != 0XFF; i++);
- return status_;
-}
-//------------------------------------------------------------------------------
-/**
- * Determine the size of an SD flash memory card.
- *
- * \return The number of 512 byte data blocks in the card
- * or zero if an error occurs.
- */
-uint32_t Sd2Card::cardSize() {
- csd_t csd;
- if (!readCSD(&csd)) return 0;
- if (csd.v1.csd_ver == 0) {
- uint8_t read_bl_len = csd.v1.read_bl_len;
- uint16_t c_size = (csd.v1.c_size_high << 10)
- | (csd.v1.c_size_mid << 2) | csd.v1.c_size_low;
- uint8_t c_size_mult = (csd.v1.c_size_mult_high << 1)
- | csd.v1.c_size_mult_low;
- return (uint32_t)(c_size + 1) << (c_size_mult + read_bl_len - 7);
- } else if (csd.v2.csd_ver == 1) {
- uint32_t c_size = ((uint32_t)csd.v2.c_size_high << 16)
- | (csd.v2.c_size_mid << 8) | csd.v2.c_size_low;
- return (c_size + 1) << 10;
- } else {
- error(SD_CARD_ERROR_BAD_CSD);
- return 0;
- }
-}
-//------------------------------------------------------------------------------
-void Sd2Card::chipSelectHigh() {
- digitalWrite(chipSelectPin_, HIGH);
-}
-//------------------------------------------------------------------------------
-void Sd2Card::chipSelectLow() {
-#ifndef SOFTWARE_SPI
- spiInit(spiRate_);
-#endif // SOFTWARE_SPI
- digitalWrite(chipSelectPin_, LOW);
-}
-//------------------------------------------------------------------------------
-/** Erase a range of blocks.
- *
- * \param[in] firstBlock The address of the first block in the range.
- * \param[in] lastBlock The address of the last block in the range.
- *
- * \note This function requests the SD card to do a flash erase for a
- * range of blocks. The data on the card after an erase operation is
- * either 0 or 1, depends on the card vendor. The card must support
- * single block erase.
- *
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::erase(uint32_t firstBlock, uint32_t lastBlock) {
- csd_t csd;
- if (!readCSD(&csd)) goto fail;
- // check for single block erase
- if (!csd.v1.erase_blk_en) {
- // erase size mask
- uint8_t m = (csd.v1.sector_size_high << 1) | csd.v1.sector_size_low;
- if ((firstBlock & m) != 0 || ((lastBlock + 1) & m) != 0) {
- // error card can't erase specified area
- error(SD_CARD_ERROR_ERASE_SINGLE_BLOCK);
- goto fail;
- }
- }
- if (type_ != SD_CARD_TYPE_SDHC) {
- firstBlock <<= 9;
- lastBlock <<= 9;
- }
- if (cardCommand(CMD32, firstBlock)
- || cardCommand(CMD33, lastBlock)
- || cardCommand(CMD38, 0)) {
- error(SD_CARD_ERROR_ERASE);
- goto fail;
- }
- if (!waitNotBusy(SD_ERASE_TIMEOUT)) {
- error(SD_CARD_ERROR_ERASE_TIMEOUT);
- goto fail;
- }
- chipSelectHigh();
- return true;
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** Determine if card supports single block erase.
- *
- * \return The value one, true, is returned if single block erase is supported.
- * The value zero, false, is returned if single block erase is not supported.
- */
-bool Sd2Card::eraseSingleBlockEnable() {
- csd_t csd;
- return readCSD(&csd) ? csd.v1.erase_blk_en : false;
-}
-//------------------------------------------------------------------------------
-/**
- * Initialize an SD flash memory card.
- *
- * \param[in] sckRateID SPI clock rate selector. See setSckRate().
- * \param[in] chipSelectPin SD chip select pin number.
- *
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure. The reason for failure
- * can be determined by calling errorCode() and errorData().
- */
-bool Sd2Card::init(uint8_t sckRateID, uint8_t chipSelectPin) {
- errorCode_ = type_ = 0;
- chipSelectPin_ = chipSelectPin;
- // 16-bit init start time allows over a minute
- uint16_t t0 = (uint16_t)millis();
- uint32_t arg;
-
- // set pin modes
- pinMode(chipSelectPin_, OUTPUT);
- chipSelectHigh();
- pinMode(SPI_MISO_PIN, INPUT);
- pinMode(SPI_MOSI_PIN, OUTPUT);
- pinMode(SPI_SCK_PIN, OUTPUT);
-
-#ifndef SOFTWARE_SPI
- // SS must be in output mode even it is not chip select
- pinMode(SS_PIN, OUTPUT);
- // set SS high - may be chip select for another SPI device
-#if SET_SPI_SS_HIGH
- digitalWrite(SS_PIN, HIGH);
-#endif // SET_SPI_SS_HIGH
- // set SCK rate for initialization commands
- spiRate_ = SPI_SD_INIT_RATE;
- spiInit(spiRate_);
-#endif // SOFTWARE_SPI
-
- // must supply min of 74 clock cycles with CS high.
- for (uint8_t i = 0; i < 10; i++) spiSend(0XFF);
-
- // command to go idle in SPI mode
- while ((status_ = cardCommand(CMD0, 0)) != R1_IDLE_STATE) {
- if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {
- error(SD_CARD_ERROR_CMD0);
- goto fail;
- }
- }
- // check SD version
- if ((cardCommand(CMD8, 0x1AA) & R1_ILLEGAL_COMMAND)) {
- type(SD_CARD_TYPE_SD1);
- } else {
- // only need last byte of r7 response
- for (uint8_t i = 0; i < 4; i++) status_ = spiRec();
- if (status_ != 0XAA) {
- error(SD_CARD_ERROR_CMD8);
- goto fail;
- }
- type(SD_CARD_TYPE_SD2);
- }
- // initialize card and send host supports SDHC if SD2
- arg = type() == SD_CARD_TYPE_SD2 ? 0X40000000 : 0;
-
- while ((status_ = cardAcmd(ACMD41, arg)) != R1_READY_STATE) {
- // check for timeout
- if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {
- error(SD_CARD_ERROR_ACMD41);
- goto fail;
- }
- }
- // if SD2 read OCR register to check for SDHC card
- if (type() == SD_CARD_TYPE_SD2) {
- if (cardCommand(CMD58, 0)) {
- error(SD_CARD_ERROR_CMD58);
- goto fail;
- }
- if ((spiRec() & 0XC0) == 0XC0) type(SD_CARD_TYPE_SDHC);
- // discard rest of ocr - contains allowed voltage range
- for (uint8_t i = 0; i < 3; i++) spiRec();
- }
- chipSelectHigh();
-
-#ifndef SOFTWARE_SPI
- return setSckRate(sckRateID);
-#else // SOFTWARE_SPI
- return true;
-#endif // SOFTWARE_SPI
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/**
- * Read a 512 byte block from an SD card.
- *
- * \param[in] blockNumber Logical block to be read.
- * \param[out] dst Pointer to the location that will receive the data.
-
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::readBlock(uint32_t blockNumber, uint8_t* dst) {
- // use address if not SDHC card
- if (type()!= SD_CARD_TYPE_SDHC) blockNumber <<= 9;
- if (cardCommand(CMD17, blockNumber)) {
- error(SD_CARD_ERROR_CMD17);
- goto fail;
- }
- return readData(dst, 512);
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** Read one data block in a multiple block read sequence
- *
- * \param[in] dst Pointer to the location for the data to be read.
- *
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::readData(uint8_t *dst) {
- chipSelectLow();
- return readData(dst, 512);
-}
-//------------------------------------------------------------------------------
-bool Sd2Card::readData(uint8_t* dst, uint16_t count) {
- // wait for start block token
- uint16_t t0 = millis();
- while ((status_ = spiRec()) == 0XFF) {
- if (((uint16_t)millis() - t0) > SD_READ_TIMEOUT) {
- error(SD_CARD_ERROR_READ_TIMEOUT);
- goto fail;
- }
- }
- if (status_ != DATA_START_BLOCK) {
- error(SD_CARD_ERROR_READ);
- goto fail;
- }
- // transfer data
- spiRead(dst, count);
-
- // discard CRC
- spiRec();
- spiRec();
- chipSelectHigh();
- return true;
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** read CID or CSR register */
-bool Sd2Card::readRegister(uint8_t cmd, void* buf) {
- uint8_t* dst = reinterpret_cast<uint8_t*>(buf);
- if (cardCommand(cmd, 0)) {
- error(SD_CARD_ERROR_READ_REG);
- goto fail;
- }
- return readData(dst, 16);
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** Start a read multiple blocks sequence.
- *
- * \param[in] blockNumber Address of first block in sequence.
- *
- * \note This function is used with readData() and readStop() for optimized
- * multiple block reads. SPI chipSelect must be low for the entire sequence.
- *
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::readStart(uint32_t blockNumber) {
- if (type()!= SD_CARD_TYPE_SDHC) blockNumber <<= 9;
- if (cardCommand(CMD18, blockNumber)) {
- error(SD_CARD_ERROR_CMD18);
- goto fail;
- }
- chipSelectHigh();
- return true;
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** End a read multiple blocks sequence.
- *
-* \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::readStop() {
- chipSelectLow();
- if (cardCommand(CMD12, 0)) {
- error(SD_CARD_ERROR_CMD12);
- goto fail;
- }
- chipSelectHigh();
- return true;
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/**
- * Set the SPI clock rate.
- *
- * \param[in] sckRateID A value in the range [0, 6].
- *
- * The SPI clock will be set to F_CPU/pow(2, 1 + sckRateID). The maximum
- * SPI rate is F_CPU/2 for \a sckRateID = 0 and the minimum rate is F_CPU/128
- * for \a scsRateID = 6.
- *
- * \return The value one, true, is returned for success and the value zero,
- * false, is returned for an invalid value of \a sckRateID.
- */
-bool Sd2Card::setSckRate(uint8_t sckRateID) {
- if (sckRateID > 6) {
- error(SD_CARD_ERROR_SCK_RATE);
- return false;
- }
- spiRate_ = sckRateID;
- return true;
-}
-//------------------------------------------------------------------------------
-// wait for card to go not busy
-bool Sd2Card::waitNotBusy(uint16_t timeoutMillis) {
- uint16_t t0 = millis();
- while (spiRec() != 0XFF) {
- if (((uint16_t)millis() - t0) >= timeoutMillis) goto fail;
- }
- return true;
-
- fail:
- return false;
-}
-//------------------------------------------------------------------------------
-/**
- * Writes a 512 byte block to an SD card.
- *
- * \param[in] blockNumber Logical block to be written.
- * \param[in] src Pointer to the location of the data to be written.
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::writeBlock(uint32_t blockNumber, const uint8_t* src) {
- // use address if not SDHC card
- if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
- if (cardCommand(CMD24, blockNumber)) {
- error(SD_CARD_ERROR_CMD24);
- goto fail;
- }
- if (!writeData(DATA_START_BLOCK, src)) goto fail;
-
- // wait for flash programming to complete
- if (!waitNotBusy(SD_WRITE_TIMEOUT)) {
- error(SD_CARD_ERROR_WRITE_TIMEOUT);
- goto fail;
- }
- // response is r2 so get and check two bytes for nonzero
- if (cardCommand(CMD13, 0) || spiRec()) {
- error(SD_CARD_ERROR_WRITE_PROGRAMMING);
- goto fail;
- }
- chipSelectHigh();
- return true;
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** Write one data block in a multiple block write sequence
- * \param[in] src Pointer to the location of the data to be written.
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::writeData(const uint8_t* src) {
- chipSelectLow();
- // wait for previous write to finish
- if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;
- if (!writeData(WRITE_MULTIPLE_TOKEN, src)) goto fail;
- chipSelectHigh();
- return true;
-
- fail:
- error(SD_CARD_ERROR_WRITE_MULTIPLE);
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-// send one block of data for write block or write multiple blocks
-bool Sd2Card::writeData(uint8_t token, const uint8_t* src) {
- spiSendBlock(token, src);
-
- spiSend(0xff); // dummy crc
- spiSend(0xff); // dummy crc
-
- status_ = spiRec();
- if ((status_ & DATA_RES_MASK) != DATA_RES_ACCEPTED) {
- error(SD_CARD_ERROR_WRITE);
- goto fail;
- }
- return true;
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** Start a write multiple blocks sequence.
- *
- * \param[in] blockNumber Address of first block in sequence.
- * \param[in] eraseCount The number of blocks to be pre-erased.
- *
- * \note This function is used with writeData() and writeStop()
- * for optimized multiple block writes.
- *
- * \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::writeStart(uint32_t blockNumber, uint32_t eraseCount) {
- // send pre-erase count
- if (cardAcmd(ACMD23, eraseCount)) {
- error(SD_CARD_ERROR_ACMD23);
- goto fail;
- }
- // use address if not SDHC card
- if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;
- if (cardCommand(CMD25, blockNumber)) {
- error(SD_CARD_ERROR_CMD25);
- goto fail;
- }
- chipSelectHigh();
- return true;
-
- fail:
- chipSelectHigh();
- return false;
-}
-//------------------------------------------------------------------------------
-/** End a write multiple blocks sequence.
- *
-* \return The value one, true, is returned for success and
- * the value zero, false, is returned for failure.
- */
-bool Sd2Card::writeStop() {
- chipSelectLow();
- if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;
- spiSend(STOP_TRAN_TOKEN);
- if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;
- chipSelectHigh();
- return true;
-
- fail:
- error(SD_CARD_ERROR_STOP_TRAN);
- chipSelectHigh();
- return false;
+/* Arduino Sd2Card Library\r
+ * Copyright (C) 2009 by William Greiman\r
+ *\r
+ * This file is part of the Arduino Sd2Card Library\r
+ *\r
+ * This Library is free software: you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation, either version 3 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * This Library is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with the Arduino Sd2Card Library. If not, see\r
+ * <http://www.gnu.org/licenses/>.\r
+ */\r
+#define HardwareSerial_h // trick to disable the standard HWserial\r
+#if ARDUINO < 100\r
+#include <WProgram.h>\r
+#else // ARDUINO\r
+#include <Arduino.h>\r
+#endif // ARDUINO\r
+#include "Sd2Card.h"\r
+//------------------------------------------------------------------------------\r
+#ifndef SOFTWARE_SPI\r
+// functions for hardware SPI\r
+//------------------------------------------------------------------------------\r
+// make sure SPCR rate is in expected bits\r
+#if (SPR0 != 0 || SPR1 != 1)\r
+#error unexpected SPCR bits\r
+#endif\r
+/**\r
+ * Initialize hardware SPI\r
+ * Set SCK rate to F_CPU/pow(2, 1 + spiRate) for spiRate [0,6]\r
+ */\r
+static void spiInit(uint8_t spiRate) {\r
+ // See avr processor documentation\r
+ SPCR = (1 << SPE) | (1 << MSTR) | (spiRate >> 1);\r
+ SPSR = spiRate & 1 || spiRate == 6 ? 0 : 1 << SPI2X;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** SPI receive a byte */\r
+static uint8_t spiRec() {\r
+ SPDR = 0XFF;\r
+ while (!(SPSR & (1 << SPIF)));\r
+ return SPDR;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** SPI read data - only one call so force inline */\r
+static inline __attribute__((always_inline))\r
+ void spiRead(uint8_t* buf, uint16_t nbyte) {\r
+ if (nbyte-- == 0) return;\r
+ SPDR = 0XFF;\r
+ for (uint16_t i = 0; i < nbyte; i++) {\r
+ while (!(SPSR & (1 << SPIF)));\r
+ buf[i] = SPDR;\r
+ SPDR = 0XFF;\r
+ }\r
+ while (!(SPSR & (1 << SPIF)));\r
+ buf[nbyte] = SPDR;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** SPI send a byte */\r
+static void spiSend(uint8_t b) {\r
+ SPDR = b;\r
+ while (!(SPSR & (1 << SPIF)));\r
+}\r
+//------------------------------------------------------------------------------\r
+/** SPI send block - only one call so force inline */\r
+static inline __attribute__((always_inline))\r
+ void spiSendBlock(uint8_t token, const uint8_t* buf) {\r
+ SPDR = token;\r
+ for (uint16_t i = 0; i < 512; i += 2) {\r
+ while (!(SPSR & (1 << SPIF)));\r
+ SPDR = buf[i];\r
+ while (!(SPSR & (1 << SPIF)));\r
+ SPDR = buf[i + 1];\r
+ }\r
+ while (!(SPSR & (1 << SPIF)));\r
+}\r
+//------------------------------------------------------------------------------\r
+#else // SOFTWARE_SPI\r
+//------------------------------------------------------------------------------\r
+/** nop to tune soft SPI timing */\r
+#define nop asm volatile ("nop\n\t")\r
+//------------------------------------------------------------------------------\r
+/** Soft SPI receive byte */\r
+static uint8_t spiRec() {\r
+ uint8_t data = 0;\r
+ // no interrupts during byte receive - about 8 us\r
+ cli();\r
+ // output pin high - like sending 0XFF\r
+ fastDigitalWrite(SPI_MOSI_PIN, HIGH);\r
+\r
+ for (uint8_t i = 0; i < 8; i++) {\r
+ fastDigitalWrite(SPI_SCK_PIN, HIGH);\r
+\r
+ // adjust so SCK is nice\r
+ nop;\r
+ nop;\r
+\r
+ data <<= 1;\r
+\r
+ if (fastDigitalRead(SPI_MISO_PIN)) data |= 1;\r
+\r
+ fastDigitalWrite(SPI_SCK_PIN, LOW);\r
+ }\r
+ // enable interrupts\r
+ sei();\r
+ return data;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Soft SPI read data */\r
+static void spiRead(uint8_t* buf, uint16_t nbyte) {\r
+ for (uint16_t i = 0; i < nbyte; i++) {\r
+ buf[i] = spiRec();\r
+ }\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Soft SPI send byte */\r
+static void spiSend(uint8_t data) {\r
+ // no interrupts during byte send - about 8 us\r
+ cli();\r
+ for (uint8_t i = 0; i < 8; i++) {\r
+ fastDigitalWrite(SPI_SCK_PIN, LOW);\r
+\r
+ fastDigitalWrite(SPI_MOSI_PIN, data & 0X80);\r
+\r
+ data <<= 1;\r
+\r
+ fastDigitalWrite(SPI_SCK_PIN, HIGH);\r
+ }\r
+ // hold SCK high for a few ns\r
+ nop;\r
+ nop;\r
+ nop;\r
+ nop;\r
+\r
+ fastDigitalWrite(SPI_SCK_PIN, LOW);\r
+ // enable interrupts\r
+ sei();\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Soft SPI send block */\r
+ void spiSendBlock(uint8_t token, const uint8_t* buf) {\r
+ spiSend(token);\r
+ for (uint16_t i = 0; i < 512; i++) {\r
+ spiSend(buf[i]);\r
+ }\r
+}\r
+#endif // SOFTWARE_SPI\r
+//------------------------------------------------------------------------------\r
+// send command and return error code. Return zero for OK\r
+uint8_t Sd2Card::cardCommand(uint8_t cmd, uint32_t arg) {\r
+ // select card\r
+ chipSelectLow();\r
+\r
+ // wait up to 300 ms if busy\r
+ waitNotBusy(300);\r
+\r
+ // send command\r
+ spiSend(cmd | 0x40);\r
+\r
+ // send argument\r
+ for (int8_t s = 24; s >= 0; s -= 8) spiSend(arg >> s);\r
+\r
+ // send CRC\r
+ uint8_t crc = 0XFF;\r
+ if (cmd == CMD0) crc = 0X95; // correct crc for CMD0 with arg 0\r
+ if (cmd == CMD8) crc = 0X87; // correct crc for CMD8 with arg 0X1AA\r
+ spiSend(crc);\r
+\r
+ // skip stuff byte for stop read\r
+ if (cmd == CMD12) spiRec();\r
+\r
+ // wait for response\r
+ for (uint8_t i = 0; ((status_ = spiRec()) & 0X80) && i != 0XFF; i++);\r
+ return status_;\r
+}\r
+//------------------------------------------------------------------------------\r
+/**\r
+ * Determine the size of an SD flash memory card.\r
+ *\r
+ * \return The number of 512 byte data blocks in the card\r
+ * or zero if an error occurs.\r
+ */\r
+uint32_t Sd2Card::cardSize() {\r
+ csd_t csd;\r
+ if (!readCSD(&csd)) return 0;\r
+ if (csd.v1.csd_ver == 0) {\r
+ uint8_t read_bl_len = csd.v1.read_bl_len;\r
+ uint16_t c_size = (csd.v1.c_size_high << 10)\r
+ | (csd.v1.c_size_mid << 2) | csd.v1.c_size_low;\r
+ uint8_t c_size_mult = (csd.v1.c_size_mult_high << 1)\r
+ | csd.v1.c_size_mult_low;\r
+ return (uint32_t)(c_size + 1) << (c_size_mult + read_bl_len - 7);\r
+ } else if (csd.v2.csd_ver == 1) {\r
+ uint32_t c_size = ((uint32_t)csd.v2.c_size_high << 16)\r
+ | (csd.v2.c_size_mid << 8) | csd.v2.c_size_low;\r
+ return (c_size + 1) << 10;\r
+ } else {\r
+ error(SD_CARD_ERROR_BAD_CSD);\r
+ return 0;\r
+ }\r
+}\r
+//------------------------------------------------------------------------------\r
+void Sd2Card::chipSelectHigh() {\r
+ digitalWrite(chipSelectPin_, HIGH);\r
+}\r
+//------------------------------------------------------------------------------\r
+void Sd2Card::chipSelectLow() {\r
+#ifndef SOFTWARE_SPI\r
+ spiInit(spiRate_);\r
+#endif // SOFTWARE_SPI\r
+ digitalWrite(chipSelectPin_, LOW);\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Erase a range of blocks.\r
+ *\r
+ * \param[in] firstBlock The address of the first block in the range.\r
+ * \param[in] lastBlock The address of the last block in the range.\r
+ *\r
+ * \note This function requests the SD card to do a flash erase for a\r
+ * range of blocks. The data on the card after an erase operation is\r
+ * either 0 or 1, depends on the card vendor. The card must support\r
+ * single block erase.\r
+ *\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::erase(uint32_t firstBlock, uint32_t lastBlock) {\r
+ csd_t csd;\r
+ if (!readCSD(&csd)) goto fail;\r
+ // check for single block erase\r
+ if (!csd.v1.erase_blk_en) {\r
+ // erase size mask\r
+ uint8_t m = (csd.v1.sector_size_high << 1) | csd.v1.sector_size_low;\r
+ if ((firstBlock & m) != 0 || ((lastBlock + 1) & m) != 0) {\r
+ // error card can't erase specified area\r
+ error(SD_CARD_ERROR_ERASE_SINGLE_BLOCK);\r
+ goto fail;\r
+ }\r
+ }\r
+ if (type_ != SD_CARD_TYPE_SDHC) {\r
+ firstBlock <<= 9;\r
+ lastBlock <<= 9;\r
+ }\r
+ if (cardCommand(CMD32, firstBlock)\r
+ || cardCommand(CMD33, lastBlock)\r
+ || cardCommand(CMD38, 0)) {\r
+ error(SD_CARD_ERROR_ERASE);\r
+ goto fail;\r
+ }\r
+ if (!waitNotBusy(SD_ERASE_TIMEOUT)) {\r
+ error(SD_CARD_ERROR_ERASE_TIMEOUT);\r
+ goto fail;\r
+ }\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Determine if card supports single block erase.\r
+ *\r
+ * \return The value one, true, is returned if single block erase is supported.\r
+ * The value zero, false, is returned if single block erase is not supported.\r
+ */\r
+bool Sd2Card::eraseSingleBlockEnable() {\r
+ csd_t csd;\r
+ return readCSD(&csd) ? csd.v1.erase_blk_en : false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/**\r
+ * Initialize an SD flash memory card.\r
+ *\r
+ * \param[in] sckRateID SPI clock rate selector. See setSckRate().\r
+ * \param[in] chipSelectPin SD chip select pin number.\r
+ *\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure. The reason for failure\r
+ * can be determined by calling errorCode() and errorData().\r
+ */\r
+bool Sd2Card::init(uint8_t sckRateID, uint8_t chipSelectPin) {\r
+ errorCode_ = type_ = 0;\r
+ chipSelectPin_ = chipSelectPin;\r
+ // 16-bit init start time allows over a minute\r
+ uint16_t t0 = (uint16_t)millis();\r
+ uint32_t arg;\r
+\r
+ // set pin modes\r
+ pinMode(chipSelectPin_, OUTPUT);\r
+ chipSelectHigh();\r
+ pinMode(SPI_MISO_PIN, INPUT);\r
+ pinMode(SPI_MOSI_PIN, OUTPUT);\r
+ pinMode(SPI_SCK_PIN, OUTPUT);\r
+\r
+#ifndef SOFTWARE_SPI\r
+ // SS must be in output mode even it is not chip select\r
+ pinMode(SS_PIN, OUTPUT);\r
+ // set SS high - may be chip select for another SPI device\r
+#if SET_SPI_SS_HIGH\r
+ digitalWrite(SS_PIN, HIGH);\r
+#endif // SET_SPI_SS_HIGH\r
+ // set SCK rate for initialization commands\r
+ spiRate_ = SPI_SD_INIT_RATE;\r
+ spiInit(spiRate_);\r
+#endif // SOFTWARE_SPI\r
+\r
+ // must supply min of 74 clock cycles with CS high.\r
+ for (uint8_t i = 0; i < 10; i++) spiSend(0XFF);\r
+\r
+ // command to go idle in SPI mode\r
+ while ((status_ = cardCommand(CMD0, 0)) != R1_IDLE_STATE) {\r
+ if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {\r
+ error(SD_CARD_ERROR_CMD0);\r
+ goto fail;\r
+ }\r
+ }\r
+ // check SD version\r
+ if ((cardCommand(CMD8, 0x1AA) & R1_ILLEGAL_COMMAND)) {\r
+ type(SD_CARD_TYPE_SD1);\r
+ } else {\r
+ // only need last byte of r7 response\r
+ for (uint8_t i = 0; i < 4; i++) status_ = spiRec();\r
+ if (status_ != 0XAA) {\r
+ error(SD_CARD_ERROR_CMD8);\r
+ goto fail;\r
+ }\r
+ type(SD_CARD_TYPE_SD2);\r
+ }\r
+ // initialize card and send host supports SDHC if SD2\r
+ arg = type() == SD_CARD_TYPE_SD2 ? 0X40000000 : 0;\r
+\r
+ while ((status_ = cardAcmd(ACMD41, arg)) != R1_READY_STATE) {\r
+ // check for timeout\r
+ if (((uint16_t)millis() - t0) > SD_INIT_TIMEOUT) {\r
+ error(SD_CARD_ERROR_ACMD41);\r
+ goto fail;\r
+ }\r
+ }\r
+ // if SD2 read OCR register to check for SDHC card\r
+ if (type() == SD_CARD_TYPE_SD2) {\r
+ if (cardCommand(CMD58, 0)) {\r
+ error(SD_CARD_ERROR_CMD58);\r
+ goto fail;\r
+ }\r
+ if ((spiRec() & 0XC0) == 0XC0) type(SD_CARD_TYPE_SDHC);\r
+ // discard rest of ocr - contains allowed voltage range\r
+ for (uint8_t i = 0; i < 3; i++) spiRec();\r
+ }\r
+ chipSelectHigh();\r
+\r
+#ifndef SOFTWARE_SPI\r
+ return setSckRate(sckRateID);\r
+#else // SOFTWARE_SPI\r
+ return true;\r
+#endif // SOFTWARE_SPI\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/**\r
+ * Read a 512 byte block from an SD card.\r
+ *\r
+ * \param[in] blockNumber Logical block to be read.\r
+ * \param[out] dst Pointer to the location that will receive the data.\r
+\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::readBlock(uint32_t blockNumber, uint8_t* dst) {\r
+ // use address if not SDHC card\r
+ if (type()!= SD_CARD_TYPE_SDHC) blockNumber <<= 9;\r
+ if (cardCommand(CMD17, blockNumber)) {\r
+ error(SD_CARD_ERROR_CMD17);\r
+ goto fail;\r
+ }\r
+ return readData(dst, 512);\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Read one data block in a multiple block read sequence\r
+ *\r
+ * \param[in] dst Pointer to the location for the data to be read.\r
+ *\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::readData(uint8_t *dst) {\r
+ chipSelectLow();\r
+ return readData(dst, 512);\r
+}\r
+//------------------------------------------------------------------------------\r
+bool Sd2Card::readData(uint8_t* dst, uint16_t count) {\r
+ // wait for start block token\r
+ uint16_t t0 = millis();\r
+ while ((status_ = spiRec()) == 0XFF) {\r
+ if (((uint16_t)millis() - t0) > SD_READ_TIMEOUT) {\r
+ error(SD_CARD_ERROR_READ_TIMEOUT);\r
+ goto fail;\r
+ }\r
+ }\r
+ if (status_ != DATA_START_BLOCK) {\r
+ error(SD_CARD_ERROR_READ);\r
+ goto fail;\r
+ }\r
+ // transfer data\r
+ spiRead(dst, count);\r
+\r
+ // discard CRC\r
+ spiRec();\r
+ spiRec();\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** read CID or CSR register */\r
+bool Sd2Card::readRegister(uint8_t cmd, void* buf) {\r
+ uint8_t* dst = reinterpret_cast<uint8_t*>(buf);\r
+ if (cardCommand(cmd, 0)) {\r
+ error(SD_CARD_ERROR_READ_REG);\r
+ goto fail;\r
+ }\r
+ return readData(dst, 16);\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Start a read multiple blocks sequence.\r
+ *\r
+ * \param[in] blockNumber Address of first block in sequence.\r
+ *\r
+ * \note This function is used with readData() and readStop() for optimized\r
+ * multiple block reads. SPI chipSelect must be low for the entire sequence.\r
+ *\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::readStart(uint32_t blockNumber) {\r
+ if (type()!= SD_CARD_TYPE_SDHC) blockNumber <<= 9;\r
+ if (cardCommand(CMD18, blockNumber)) {\r
+ error(SD_CARD_ERROR_CMD18);\r
+ goto fail;\r
+ }\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** End a read multiple blocks sequence.\r
+ *\r
+* \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::readStop() {\r
+ chipSelectLow();\r
+ if (cardCommand(CMD12, 0)) {\r
+ error(SD_CARD_ERROR_CMD12);\r
+ goto fail;\r
+ }\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/**\r
+ * Set the SPI clock rate.\r
+ *\r
+ * \param[in] sckRateID A value in the range [0, 6].\r
+ *\r
+ * The SPI clock will be set to F_CPU/pow(2, 1 + sckRateID). The maximum\r
+ * SPI rate is F_CPU/2 for \a sckRateID = 0 and the minimum rate is F_CPU/128\r
+ * for \a scsRateID = 6.\r
+ *\r
+ * \return The value one, true, is returned for success and the value zero,\r
+ * false, is returned for an invalid value of \a sckRateID.\r
+ */\r
+bool Sd2Card::setSckRate(uint8_t sckRateID) {\r
+ if (sckRateID > 6) {\r
+ error(SD_CARD_ERROR_SCK_RATE);\r
+ return false;\r
+ }\r
+ spiRate_ = sckRateID;\r
+ return true;\r
+}\r
+//------------------------------------------------------------------------------\r
+// wait for card to go not busy\r
+bool Sd2Card::waitNotBusy(uint16_t timeoutMillis) {\r
+ uint16_t t0 = millis();\r
+ while (spiRec() != 0XFF) {\r
+ if (((uint16_t)millis() - t0) >= timeoutMillis) goto fail;\r
+ }\r
+ return true;\r
+\r
+ fail:\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/**\r
+ * Writes a 512 byte block to an SD card.\r
+ *\r
+ * \param[in] blockNumber Logical block to be written.\r
+ * \param[in] src Pointer to the location of the data to be written.\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::writeBlock(uint32_t blockNumber, const uint8_t* src) {\r
+ // use address if not SDHC card\r
+ if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;\r
+ if (cardCommand(CMD24, blockNumber)) {\r
+ error(SD_CARD_ERROR_CMD24);\r
+ goto fail;\r
+ }\r
+ if (!writeData(DATA_START_BLOCK, src)) goto fail;\r
+\r
+ // wait for flash programming to complete\r
+ if (!waitNotBusy(SD_WRITE_TIMEOUT)) {\r
+ error(SD_CARD_ERROR_WRITE_TIMEOUT);\r
+ goto fail;\r
+ }\r
+ // response is r2 so get and check two bytes for nonzero\r
+ if (cardCommand(CMD13, 0) || spiRec()) {\r
+ error(SD_CARD_ERROR_WRITE_PROGRAMMING);\r
+ goto fail;\r
+ }\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Write one data block in a multiple block write sequence\r
+ * \param[in] src Pointer to the location of the data to be written.\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::writeData(const uint8_t* src) {\r
+ chipSelectLow();\r
+ // wait for previous write to finish\r
+ if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;\r
+ if (!writeData(WRITE_MULTIPLE_TOKEN, src)) goto fail;\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ error(SD_CARD_ERROR_WRITE_MULTIPLE);\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+// send one block of data for write block or write multiple blocks\r
+bool Sd2Card::writeData(uint8_t token, const uint8_t* src) {\r
+ spiSendBlock(token, src);\r
+\r
+ spiSend(0xff); // dummy crc\r
+ spiSend(0xff); // dummy crc\r
+\r
+ status_ = spiRec();\r
+ if ((status_ & DATA_RES_MASK) != DATA_RES_ACCEPTED) {\r
+ error(SD_CARD_ERROR_WRITE);\r
+ goto fail;\r
+ }\r
+ return true;\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** Start a write multiple blocks sequence.\r
+ *\r
+ * \param[in] blockNumber Address of first block in sequence.\r
+ * \param[in] eraseCount The number of blocks to be pre-erased.\r
+ *\r
+ * \note This function is used with writeData() and writeStop()\r
+ * for optimized multiple block writes.\r
+ *\r
+ * \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::writeStart(uint32_t blockNumber, uint32_t eraseCount) {\r
+ // send pre-erase count\r
+ if (cardAcmd(ACMD23, eraseCount)) {\r
+ error(SD_CARD_ERROR_ACMD23);\r
+ goto fail;\r
+ }\r
+ // use address if not SDHC card\r
+ if (type() != SD_CARD_TYPE_SDHC) blockNumber <<= 9;\r
+ if (cardCommand(CMD25, blockNumber)) {\r
+ error(SD_CARD_ERROR_CMD25);\r
+ goto fail;\r
+ }\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ chipSelectHigh();\r
+ return false;\r
+}\r
+//------------------------------------------------------------------------------\r
+/** End a write multiple blocks sequence.\r
+ *\r
+* \return The value one, true, is returned for success and\r
+ * the value zero, false, is returned for failure.\r
+ */\r
+bool Sd2Card::writeStop() {\r
+ chipSelectLow();\r
+ if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;\r
+ spiSend(STOP_TRAN_TOKEN);\r
+ if (!waitNotBusy(SD_WRITE_TIMEOUT)) goto fail;\r
+ chipSelectHigh();\r
+ return true;\r
+\r
+ fail:\r
+ error(SD_CARD_ERROR_STOP_TRAN);\r
+ chipSelectHigh();\r
+ return false;\r
}\r
~ianmdlvl / marlin.git / commitdiff