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 #if CPU_CM3_SAM3X8
  55
  56 typedef struct SDcid
  57 {
  58     uint8_t        manfid;
  59     uint8_t        prod_name[8];
  60     uint32_t       serial;
  61     uint16_t       oemid;
  62     uint32_t       year_off;
  63     uint8_t        m_rev;
  64     uint8_t        l_rev;
  65 }SDcid;
  66
  67 typedef struct SDcsd
  68 {
  69         uint8_t     structure;
  70     uint8_t     ccc;          ///< Card command classes
  71     uint32_t    erase_size;  ///< The size of an erasable sector, in write block len
  72         uint32_t    capacity;     ///< Card size in byte
  73     uint32_t    blk_len;      ///< Block data size len in byte
  74         uint32_t    blk_num;      ///< Number of block in card
  75         uint32_t        write_blk_bits; ///< Max write block length in bits
  76         uint32_t        read_blk_bits;  ///< Max read block length in bits
  77     uint8_t     read_partial:1,
  78                 read_misalign:1,
  79                 write_partial:1,
  80                 write_misalign:1;
  81 } SDcsd;
  82
  83
  84 #define SD_READY_FOR_DATA         BV(8)
  85 #define SD_CARD_IS_LOCKED         BV(25)
  86
  87 #define SD_SEND_CID_RCA     0
  88 #define SD_SEND_ALL_CID   BV(0)
  89
  90 #endif
  91
  92
  93 #define SD_UNBUFFERED     BV(0) ///< Open SD memory disabling page caching, no modification and partial write are allowed.
  94
  95 /**
  96  * SD Card context structure.
  97  */
  98 typedef struct Sd
  99 {
 100
 101         KBlock b;   ///< KBlock base class
 102         KFile *ch;  ///< SPI communication channel
 103         uint16_t r1;  ///< Last status data received from SD
 104         uint16_t tranfer_len; ///< Lenght for the read/write commands, cached in order to increase speed.
 105
 106         #if CPU_CM3_SAM3X8
 107         SDcid cid;
 108         SDcsd csd;
 109         uint32_t addr;
 110         uint32_t status;
 111         #endif
 112
 113 } Sd;
 114
 115 bool sd_initUnbuf(Sd *sd, KFile *ch);
 116 bool sd_initBuf(Sd *sd, KFile *ch);
 117
 118
 119 #if CPU_CM3_SAM3X8
 120
 121 void sd_dumpCsd(Sd *sd);
 122 void sd_dumpCid(Sd *sd);
 123
 124 void sd_sendInit(void);
 125 void sd_goIdle(void);
 126 int sd_sendIfCond(void);
 127 int sd_sendAppOpCond(void);
 128
 129 int sd_getCid(Sd *sd, uint32_t addr, uint8_t flag);
 130 int sd_getCsd(Sd *sd);
 131 int sd_getSrc(Sd *sd);
 132
 133 int sd_appStatus(Sd *sd);
 134 int sd_getRelativeAddr(Sd *sd);
 135
 136 int sd_selectCard(Sd *sd);
 137 int sd_deSelectCard(Sd *sd);
 138 int sd_setBusWidth(Sd *sd, size_t len);
 139 int sd_set_BlockLen(Sd *sd, size_t len);
 140
 141 int sd_readSingleBlock(Sd *sd, size_t index, void *_buf, size_t len);
 142
 143
 144 INLINE int sd_setBus4bit(Sd *sd)
 145 {
 146         return sd_setBusWidth(sd, 1);
 147 }
 148
 149 INLINE int sd_setBus1bit(Sd *sd)
 150 {
 151         return sd_setBusWidth(sd, 0);
 152 }
 153
 154 #endif
 155
 156
 157 #if CONFIG_SD_OLD_INIT
 158         #if !(ARCH & ARCH_NIGHTTEST)
 159                 #warning "Deprecated: this API will be removed in the next major release,"
 160                 #warning "please disable CONFIG_SD_OLD_INIT and pass explicitly the SD context to sd_init()."
 161         #endif
 162
 163         /**
 164          * Initializes the SD driver.
 165          *
 166          * \param ch A pointer to a SPI channel where the SD will read/write to.
 167          *
 168          * \return true if initialization succeds, false otherwise.
 169          *
 170          * \note This API is deprecated, disable CONFIG_SD_OLD_INIT and
 171          *       use the new one instead.
 172          *
 173          * \see CONFIG_SD_OLD_INIT.
 174          */
 175         #define sd_init(ch) {static struct Sd sd; sd_initUnbuf(&sd, (ch));}
 176
 177 #else
 178
 179         /**
 180          * Initializes the SD driver.
 181          *
 182          * \param sd The SD KBlock context.
 183          * \param ch A pointer to a SPI channel where the SD will read/write to.
 184          * \param buffered Set to true if you want the KBlock to be buffered,
 185          *        to false otherwise. The FatFs module does not require the device
 186          *        to be buffered because it has an internal cache. This will save
 187          *        512 bytes of RAM in this case.
 188          *
 189          * \return true if initialization succeds, false otherwise.
 190          */
 191         #define sd_init(sd, ch, buffered) ((buffered & SD_UNBUFFERED) ? sd_initUnbuf((sd), (ch)) : sd_initBuf((sd), (ch)))
 192
 193 #endif
 194
 195
 196 #define KBT_SD MAKE_ID('S', 'D', 'B', 'K')
 197
 198 bool sd_test(Sd *sd);
 199 void sd_writeTest(Sd *sd);
 200
 201 INLINE Sd *SD_CAST(KBlock *b)
 202 {
 203         ASSERT(b->priv.type == KBT_SD);
 204         return (Sd *)b;
 205 }
 206
 207 #endif /* DRV_SD_H */
 208