4 * This file is part of BeRTOS.
6 * Bertos 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 2 of the License, or
9 * (at your option) any later version.
11 * This program 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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
32 * \brief Function library for secure digital memory.
35 * \author Francesco Sacchi <batt@develer.com>
37 * $WIZ$ module_name = "sd"
38 * $WIZ$ module_depends = "kfile", "timer", "kblock", "sd_spi"
39 * $WIZ$ module_hw = "bertos/hw/hw_sd.h"
40 * $WIZ$ module_configuration = "bertos/cfg/cfg_sd.h"
47 #include "cfg/cfg_sd.h"
50 #include <io/kblock.h>
52 #include <fs/fatfs/diskio.h>
68 uint8_t ccc; ///< Card command classes
69 uint32_t erase_size; ///< The size of an erasable sector, in write block len
70 uint32_t capacity; ///< Card size in byte
71 uint32_t max_data_rate; ///< Step rate, usec
72 uint32_t block_len; ///< Block data size len in byte
73 uint32_t block_num; ///< Number of block in card
74 uint32_t write_blk_bits; ///< Max write block length in bits
75 uint32_t read_blk_bits; ///< Max read block length in bits
76 uint8_t read_partial:1,
91 #define SD_START_DELAY 10
92 #define SD_INIT_TIMEOUT ms_to_ticks(2000)
93 #define SD_IDLE_RETRIES 4
94 #define SD_DEFAULT_BLOCKLEN 512
97 * $WIZ$ sd_mode = "SD_SDMMC_MODE", "SD_SPI_MODE"
100 #define SD_SDMMC_MODE 0
101 #define SD_SPI_MODE 1
104 #define SD_UNBUFFERED BV(0) ///< Open SD memory disabling page caching, no modification and partial write are allowed.
106 struct SdHardware* hw;
108 * SD Card context structure.
112 KBlock b; ///< KBlock base class
113 KFile *ch; ///< SPI communication channel
114 struct SdHardware* hw;
119 bool sd_hw_initUnbuf(Sd *sd, KFile *ch);
120 bool sd_hw_initBuf(Sd *sd, KFile *ch);
122 bool sd_spi_initUnbuf(Sd *sd, KFile *ch);
123 bool sd_spi_initBuf(Sd *sd, KFile *ch);
125 // For old compatibility.
126 #ifndef CONFIG_SD_MODE
127 #define CONFIG_SD_MODE SD_SPI_MODE
128 #define SD_INCLUDE_SPI_SOURCE
131 #if CONFIG_SD_OLD_INIT
133 #if !(ARCH & ARCH_NIGHTTEST)
134 #warning "Deprecated: this API will be removed in the next major release,"
135 #warning "please disable CONFIG_SD_OLD_INIT and pass explicitly the SD context to sd_init()."
139 * Initializes the SD driver.
141 * \param ch A pointer to a SPI channel where the SD will read/write to.
143 * \return true if initialization succeds, false otherwise.
145 * \note This API is deprecated, disable CONFIG_SD_OLD_INIT and
146 * use the new one instead.
148 * \see CONFIG_SD_OLD_INIT.
150 #if CONFIG_SD_MODE == SD_SPI_MODE
151 #define sd_init(ch) {static struct Sd sd; sd_spi_initUnbuf(&sd, (ch));}
153 #define sd_init(ch) {static struct Sd sd; sd_hw_initUnbuf(&sd, (ch));}
159 * Initializes the SD driver.
161 * \param sd The SD KBlock context.
162 * \param ch A pointer to a SPI channel where the SD will read/write to.
163 * \param buffered Set to true if you want the KBlock to be buffered,
164 * to false otherwise. The FatFs module does not require the device
165 * to be buffered because it has an internal cache. This will save
166 * 512 bytes of RAM in this case.
168 * \return true if initialization succeds, false otherwise.
170 #if CONFIG_SD_MODE == SD_SPI_MODE
171 #define sd_init(sd, ch, buffered) ((buffered & SD_UNBUFFERED) ? sd_spi_initUnbuf((sd), (ch)) : sd_spi_initBuf((sd), (ch)))
173 #define sd_init(sd, ch, buffered) ((buffered & SD_UNBUFFERED) ? sd_hw_initUnbuf((sd), (ch)) : sd_hw_initBuf((sd), (ch)))
179 #define KBT_SD MAKE_ID('S', 'D', 'B', 'K')
181 bool sd_test(Sd *sd);
182 void sd_writeTest(Sd *sd);
184 INLINE Sd *SD_CAST(KBlock *b)
186 ASSERT(b->priv.type == KBT_SD);
190 #endif /* DRV_SD_H */