bertos/drv/sd.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  * \brief Function library for secure digital memory.
  33  *
  34  *
  35  * \author Francesco Sacchi <batt@develer.com>
  36  *
  37  * $WIZ$ module_name = "sd"
  38  * $WIZ$ module_depends = "kfile", "timer", "kblock"
  39  * $WIZ$ module_hw = "bertos/hw/hw_sd.h"
  40  * $WIZ$ module_configuration = "bertos/cfg/cfg_sd.h"
  41  */
  42
  43
  44 #ifndef DRV_SD_H
  45 #define DRV_SD_H
  46
  47 #include "cfg/cfg_sd.h"
  48
  49 #include <io/kfile.h>
  50 #include <io/kblock.h>
  51
  52 #include <fs/fatfs/diskio.h>
  53
  54
  55 #define SD_UNBUFFERED     BV(0) ///< Open SD memory disabling page caching, no modification and partial write are allowed.
  56
  57 /**
  58  * SD Card context structure.
  59  */
  60 typedef struct Sd
  61 {
  62         KBlock b;   ///< KBlock base class
  63         KFile *ch;  ///< SPI communication channel
  64         uint16_t r1;  ///< Last status data received from SD
  65         uint16_t tranfer_len; ///< Lenght for the read/write commands, cached in order to increase speed.
  66 } Sd;
  67
  68 bool sd_initUnbuf(Sd *sd, KFile *ch);
  69 bool sd_initBuf(Sd *sd, KFile *ch);
  70
  71 #if CONFIG_SD_OLD_INIT
  72         #if !(ARCH & ARCH_NIGHTTEST)
  73                 #warning "Deprecated: this API will be removed in the next major release,"
  74                 #warning "please disable CONFIG_SD_OLD_INIT and pass explicitly the SD context to sd_init()."
  75         #endif
  76
  77         /**
  78          * Initializes the SD driver.
  79          *
  80          * \param ch A pointer to a SPI channel where the SD will read/write to.
  81          *
  82          * \return true if initialization succeds, false otherwise.
  83          *
  84          * \note This API is deprecated, disable CONFIG_SD_OLD_INIT and
  85          *       use the new one instead.
  86          *
  87          * \see CONFIG_SD_OLD_INIT.
  88          */
  89         #define sd_init(ch) {static struct Sd sd; sd_initUnbuf(&sd, (ch));}
  90
  91 #else
  92
  93         /**
  94          * Initializes the SD driver.
  95          *
  96          * \param sd The SD KBlock context.
  97          * \param ch A pointer to a SPI channel where the SD will read/write to.
  98          * \param buffered Set to true if you want the KBlock to be buffered,
  99          *        to false otherwise. The FatFs module does not require the device
 100          *        to be buffered because it has an internal cache. This will save
 101          *        512 bytes of RAM in this case.
 102          *
 103          * \return true if initialization succeds, false otherwise.
 104          */
 105         #define sd_init(sd, ch, buffered) ((buffered & SD_UNBUFFERED) ? sd_initUnbuf((sd), (ch)) : sd_initBuf((sd), (ch)))
 106
 107 #endif
 108
 109
 110 #define KBT_SD MAKE_ID('S', 'D', 'B', 'K')
 111
 112 bool sd_test(Sd *sd);
 113 void sd_writeTest(Sd *sd);
 114
 115 INLINE Sd *SD_CAST(KBlock *b)
 116 {
 117         ASSERT(b->priv.type == KBT_SD);
 118         return (Sd *)b;
 119 }
 120
 121
 122 #endif /* DRV_SD_H */