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.
34 * Right now, the interface for these function is the one defined in diskio.h from
37 * \author Francesco Sacchi <batt@develer.com>
39 * $WIZ$ module_name = "sd"
40 * $WIZ$ module_depends = "kfile", "timer"
41 * $WIZ$ module_hw = "bertos/hw/hw_sd.h"
42 * $WIZ$ module_configuration = "bertos/cfg/cfg_sd.h"
50 #include <io/kblock.h>
52 #include <fs/fatfs/diskio.h>
54 #include "cfg/cfg_sd.h"
60 KFile *ch; ///< SPI communication channel
64 bool sd_initUnbuf(Sd *sd, KFile *ch);
65 bool sd_initBuf(Sd *sd, KFile *ch);
67 #if CONFIG_SD_OLD_INIT
68 #warning "Deprecated: this API will be removed in the next major release,"
69 #warning "please disable CONFIG_SD_OLD_INIT and pass explicitly the SD context to sd_init()."
72 * Initializes the SD driver.
74 * \param ch A pointer to a SPI channel where the SD will read/write to.
76 * \return true if initialization succeds, false otherwise.
78 * \note This API is deprecated, disable CONFIG_SD_OLD_INIT and
79 * use the new one instead.
81 #define sd_init(ch) {static struct Sd sd; sd_initUnbuf(&sd, (ch));}
86 * Initializes the SD driver.
88 * \param sd The SD KBlock context.
89 * \param ch A pointer to a SPI channel where the SD will read/write to.
90 * \param buffered Set to true if you want the KBlock to be buffered,
91 * to false otherwise. The FatFs module does not require the device
92 * to be buffered because it has an internal cache. This will save
93 * 512 bytes of RAM in this case.
95 * \return true if initialization succeds, false otherwise.
97 #define sd_init(sd, ch, buffered) ((buffered) ? sd_initBuf((sd), (ch)) : sd_initUnbuf((sd), (ch)))
102 #define KBT_SD MAKE_ID('S', 'D', 'B', 'K')
104 bool sd_test(Sd *sd);
106 INLINE Sd *SD_CAST(KBlock *b)
108 ASSERT(b->priv.type == KBT_SD);
113 #endif /* DRV_SD_H */