flash-microSD.h

Go to the documentation of this file.

/* Copyright (c) 2010, Ulf Kulau
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

/**
 * \addtogroup Device Interfaces
 * @{
 *
 * \defgroup microSD_interface MicroSD Card Interface
 *
 *      \note This sd-card interface is based on the work of Ulrich Radig
 *            "Connect AVR to MMC/SD" and was a little bit modified plus
 *            adapted to the mspi-drv
 *
 * <p> Huge memory space is always nice to have, because you don't have to
 * decide which data has to be stored, just store everything! Furthermore you
 * can buffer your data, whenever wireless connection breaks down.
 * An easy and modular way is a SD card. For smaller applications (like
 * sensor nodes), the tiny version "microSD" would be the best choice. Both, the
 * "big" SD-Cards and the microSD-Cards can be interfaced by SPI and use the same
 * Instruction set, so this interface can be used for both SD-Card types.</p>
 *
 * @{
 *
 */

/**
 * \file
 *              MicroSD Card interface definitions
 * \author
 *              Original Source Code:
 *              Ulrich Radig
 *              Modified by:
 *      Ulf Kulau <kulau@ibr.cs.tu-bs.de>
 */

#ifndef FLASH_MICROSD_H_
#define FLASH_MICROSD_H_

#include "../drv/mspi-drv.h"
#include <stdio.h>
#include <util/delay.h>

/*!
 * SPI device order. The chip select number where the
 * microSD-Card is connected to the BCD-decimal decoder
 */
#define MICRO_SD_CS                                     5

#define MICRO_SD_PWR_PORT                               PORTA
#define MICRO_SD_PWR_PORT_DDR                   DDRA
#define MICRO_SD_PWR_PIN                                PORTA4

/**
 * \brief Powers on and initialize the microSD / SD-Card
 *
 * \return <ul>
 *              <li> 0 : SD-Card was initialized without an error
 *              <li> 1 : CMD0 failure!
 *              <li> 2 : CMD1 failure!
 *                 </ul>
 */
uint8_t microSD_init(void);

uint8_t microSD_deinit(void);

/**
 * \brief This function will read one block (512Byte) of the SD-Card.
 *
 * \param addr Block address
 * \param *buffer Pointer to a block buffer
 *
 * \return <ul>
 *              <li> 0 : SD-Card block read was successful
 *              <li> 1 : CMD17 failure!
 *                 </ul>
 */
uint8_t microSD_read_block(uint32_t addr, uint8_t *buffer);

/**
 * \brief This function will write one block (512Byte) of the SD-Card.
 *
 * \param addr Block address
 * \param *buffer Pointer to a block buffer
 *
 * \return <ul>
 *              <li> 0 : SD-Card block write was successful
 *              <li> 1 : CMD24 failure!
 *                 </ul>
 */
uint8_t microSD_write_block(uint32_t addr, uint8_t *buffer);

/**
 * \brief This function sends a command via SPI to the SD-Card. An SPI
 * command consists off 6 bytes
 *
 * \param *cmd Pointer to the command array
 *
 * \return <ul>
 *              <li> 1 : Acknowledge
 *              <li> other failure code
 *                 </ul>
 */
uint8_t microSD_write_cmd(uint8_t *cmd);





#endif /* FLASH_MICROSD_H_ */