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