MicroAPRS/bertos/drv/sd.h

123 lines
3.7 KiB
C

/**
* \file
* <!--
* This file is part of BeRTOS.
*
* Bertos is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As a special exception, you may use this file as part of a free software
* library without restriction. Specifically, if other files instantiate
* templates or use macros or inline functions from this file, or you compile
* this file and link it with other files to produce an executable, this
* file does not by itself cause the resulting executable to be covered by
* the GNU General Public License. This exception does not however
* invalidate any other reasons why the executable file might be covered by
* the GNU General Public License.
*
* Copyright 2007 Develer S.r.l. (http://www.develer.com/)
* -->
*
* \brief Function library for secure digital memory.
*
*
* \author Francesco Sacchi <batt@develer.com>
*
* $WIZ$ module_name = "sd"
* $WIZ$ module_depends = "kfile", "timer", "kblock"
* $WIZ$ module_hw = "bertos/hw/hw_sd.h"
* $WIZ$ module_configuration = "bertos/cfg/cfg_sd.h"
*/
#ifndef DRV_SD_H
#define DRV_SD_H
#include "cfg/cfg_sd.h"
#include <io/kfile.h>
#include <io/kblock.h>
#include <fs/fatfs/diskio.h>
#define SD_UNBUFFERED BV(0) ///< Open SD memory disabling page caching, no modification and partial write are allowed.
/**
* SD Card context structure.
*/
typedef struct Sd
{
KBlock b; ///< KBlock base class
KFile *ch; ///< SPI communication channel
uint16_t r1; ///< Last status data received from SD
uint16_t tranfer_len; ///< Lenght for the read/write commands, cached in order to increase speed.
} Sd;
bool sd_initUnbuf(Sd *sd, KFile *ch);
bool sd_initBuf(Sd *sd, KFile *ch);
#if CONFIG_SD_OLD_INIT
#if !(ARCH & ARCH_NIGHTTEST)
#warning "Deprecated: this API will be removed in the next major release,"
#warning "please disable CONFIG_SD_OLD_INIT and pass explicitly the SD context to sd_init()."
#endif
/**
* Initializes the SD driver.
*
* \param ch A pointer to a SPI channel where the SD will read/write to.
*
* \return true if initialization succeds, false otherwise.
*
* \note This API is deprecated, disable CONFIG_SD_OLD_INIT and
* use the new one instead.
*
* \see CONFIG_SD_OLD_INIT.
*/
#define sd_init(ch) {static struct Sd sd; sd_initUnbuf(&sd, (ch));}
#else
/**
* Initializes the SD driver.
*
* \param sd The SD KBlock context.
* \param ch A pointer to a SPI channel where the SD will read/write to.
* \param buffered Set to true if you want the KBlock to be buffered,
* to false otherwise. The FatFs module does not require the device
* to be buffered because it has an internal cache. This will save
* 512 bytes of RAM in this case.
*
* \return true if initialization succeds, false otherwise.
*/
#define sd_init(sd, ch, buffered) ((buffered & SD_UNBUFFERED) ? sd_initUnbuf((sd), (ch)) : sd_initBuf((sd), (ch)))
#endif
#define KBT_SD MAKE_ID('S', 'D', 'B', 'K')
bool sd_test(Sd *sd);
void sd_writeTest(Sd *sd);
INLINE Sd *SD_CAST(KBlock *b)
{
ASSERT(b->priv.type == KBT_SD);
return (Sd *)b;
}
#endif /* DRV_SD_H */