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 typedef struct SDAddr
  85 {
  86         uint32_t rca;
  87         uint32_t status;
  88 } SDAddr;
  89
  90 int sd_decode_csd(SDcsd *csd, uint32_t *resp, size_t len);
  91 void sd_dump_csd(SDcsd *csd);
  92 void sd_decode_cid(SDcid *cid, uint32_t *resp, size_t len);
  93 void sd_dump_cid(SDcid *cid);
  94 void sd_send_init(void);
  95 void sd_go_idle(void);
  96 int sd_send_if_cond(void);
  97 int sd_send_app_op_cond(void);
  98 int sd_get_cid(uint32_t *resp, size_t len);
  99 int sd_get_csd(uint32_t *resp, size_t len);
 100 int sd_app_status(uint32_t *resp, size_t len);
 101 int sd_send_relative_addr(uint32_t *resp, size_t len);
 102 void sd_decode_addr(SDAddr *addr, uint32_t *resp, size_t len);
 103 void sd_dump_addr(SDAddr *addr);
 104 #endif
 105
 106
 107 #define SD_UNBUFFERED     BV(0) ///< Open SD memory disabling page caching, no modification and partial write are allowed.
 108
 109 /**
 110  * SD Card context structure.
 111  */
 112 typedef struct Sd
 113 {
 114         KBlock b;   ///< KBlock base class
 115         KFile *ch;  ///< SPI communication channel
 116         uint16_t r1;  ///< Last status data received from SD
 117         uint16_t tranfer_len; ///< Lenght for the read/write commands, cached in order to increase speed.
 118 } Sd;
 119
 120 bool sd_initUnbuf(Sd *sd, KFile *ch);
 121 bool sd_initBuf(Sd *sd, KFile *ch);
 122
 123 #if CONFIG_SD_OLD_INIT
 124         #if !(ARCH & ARCH_NIGHTTEST)
 125                 #warning "Deprecated: this API will be removed in the next major release,"
 126                 #warning "please disable CONFIG_SD_OLD_INIT and pass explicitly the SD context to sd_init()."
 127         #endif
 128
 129         /**
 130          * Initializes the SD driver.
 131          *
 132          * \param ch A pointer to a SPI channel where the SD will read/write to.
 133          *
 134          * \return true if initialization succeds, false otherwise.
 135          *
 136          * \note This API is deprecated, disable CONFIG_SD_OLD_INIT and
 137          *       use the new one instead.
 138          *
 139          * \see CONFIG_SD_OLD_INIT.
 140          */
 141         #define sd_init(ch) {static struct Sd sd; sd_initUnbuf(&sd, (ch));}
 142
 143 #else
 144
 145         /**
 146          * Initializes the SD driver.
 147          *
 148          * \param sd The SD KBlock context.
 149          * \param ch A pointer to a SPI channel where the SD will read/write to.
 150          * \param buffered Set to true if you want the KBlock to be buffered,
 151          *        to false otherwise. The FatFs module does not require the device
 152          *        to be buffered because it has an internal cache. This will save
 153          *        512 bytes of RAM in this case.
 154          *
 155          * \return true if initialization succeds, false otherwise.
 156          */
 157         #define sd_init(sd, ch, buffered) ((buffered & SD_UNBUFFERED) ? sd_initUnbuf((sd), (ch)) : sd_initBuf((sd), (ch)))
 158
 159 #endif
 160
 161
 162 #define KBT_SD MAKE_ID('S', 'D', 'B', 'K')
 163
 164 bool sd_test(Sd *sd);
 165 void sd_writeTest(Sd *sd);
 166
 167 INLINE Sd *SD_CAST(KBlock *b)
 168 {
 169         ASSERT(b->priv.type == KBT_SD);
 170         return (Sd *)b;
 171 }
 172
 173 #endif /* DRV_SD_H */