mmc_sd.h

Go to the documentation of this file.

/*This file has been prepared for Doxygen automatic documentation generation.*/

/* Copyright (c) 2007, Atmel Corporation All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The name of ATMEL may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY AND
 * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */



#ifndef _MMC_SD_H_
#define _MMC_SD_H_

/*_____ I N C L U D E S ____________________________________________________*/

#include "config.h"


/*_____ M A C R O S ________________________________________________________*/

#ifndef MMC_SECTOR_SIZE
#define MMC_SECTOR_SIZE   512   //default sector size is 512 bytes
#endif

#define byte_adr_of_block(ad)   (ad<<9)   // returns the first byte address of a specified sector/block number (512bytes/block)

/*_____ D E F I N I T I O N ________________________________________________*/

// Card identification
#define MMC_CARD                                0
#define SD_CARD                                 1

// Lock operations
#define OP_UNLOCK                               0x00
#define OP_LOCK                                 0x04
#define OP_RESET_PWD                            0x02
#define OP_SET_PWD                              0x01
#define OP_FORCED_ERASE                         0x08

// MMC commands (taken from sandisk MMC reference)
#define MMC_GO_IDLE_STATE         0      
#define MMC_SEND_OP_COND         1      
#define MMC_CMD2                                2               
#define MMC_SEND_CSD            9      
#define MMC_SEND_CID            10      
#define MMC_SEND_STATUS            13
#define MMC_SET_BLOCKLEN         16      
#define MMC_READ_SINGLE_BLOCK              17      
#define MMC_WRITE_BLOCK            24      
#define MMC_PROGRAM_CSD            27
#define MMC_SET_WRITE_PROT         28
#define MMC_CLR_WRITE_PROT         29
#define MMC_SEND_WRITE_PROT         30
#define SD_TAG_WR_ERASE_GROUP_START             32
#define SD_TAG_WR_ERASE_GROUP_END               33
#define MMC_TAG_SECTOR_START              32
#define MMC_TAG_SECTOR_END         33
#define MMC_UNTAG_SECTOR         34
#define MMC_TAG_ERASE_GROUP_START            35      
#define MMC_TAG_ERASE_GROUP_END              36      
#define MMC_UNTAG_ERASE_GROUP              37      
#define MMC_ERASE            38      
#define SD_SEND_OP_COND_ACMD                    41              
#define MMC_LOCK_UNLOCK                         42              
#define SD_APP_CMD55                            55              
#define MMC_CRC_ON_OFF            59      
// R1 Response bit-defines
#define MMC_R1_BUSY            0x80   
#define MMC_R1_PARAMETER         0x40
#define MMC_R1_ADDRESS            0x20
#define MMC_R1_ERASE_SEQ         0x10
#define MMC_R1_COM_CRC            0x08
#define MMC_R1_ILLEGAL_COM         0x04
#define MMC_R1_ERASE_RESET         0x02
#define MMC_R1_IDLE_STATE         0x01
// Data Start tokens
#define MMC_STARTBLOCK_READ         0xFE   
#define MMC_STARTBLOCK_WRITE              0xFE   
#define MMC_STARTBLOCK_MWRITE              0xFC
// Data Stop tokens
#define MMC_STOPTRAN_WRITE         0xFD
// Data Error Token values
#define MMC_DE_MASK            0x1F
#define MMC_DE_ERROR            0x01
#define MMC_DE_CC_ERROR            0x02
#define MMC_DE_ECC_FAIL            0x04
#define MMC_DE_OUT_OF_RANGE         0x04
#define MMC_DE_CARD_LOCKED         0x04
// Data Response Token values
#define MMC_DR_MASK            0x1F
#define MMC_DR_ACCEPT            0x05
#define MMC_DR_REJECT_CRC         0x0B
#define MMC_DR_REJECT_WRITE_ERROR               0x0D



/*_____ D E C L A R A T I O N ______________________________________________*/

void    mmc_sd_spi_init(void);          // initializes the SPI bus and settings for SD/MMD card
bit     mmc_sd_init (void);             // initializes the SD/MMC card (reset, init, analyse)
bit     mmc_sd_check_presence(void);    // check the presence of the card
bit     mmc_sd_mem_check(void);         // check the presence of the card, and initialize if inserted
bit     mmc_sd_wait_not_busy (void);    // wait for the card to be not busy (exits with timeout)
bit     mmc_sd_get_csd(U8 *);           // stores the CSD of the card into csd[16]
bit     mmc_sd_get_cid(U8 *);           // stores the CID of the card into cid[16]
void    mmc_sd_get_capacity(void);      // extract parameters from CSD and compute capacity, last block adress, erase group size
bit     mmc_sd_get_status(void);        // read the status register of the card (R2 response)
U8      mmc_sd_send_and_read(U8);       // send a byte on SPI and returns the received byte
U8      mmc_sd_send_command(U8, U32);   // send a single command + argument (R1 response expected and returned), with memory select then unselect
U8      mmc_sd_command(U8, U32);        // send a command + argument (R1 response expected and returned), without memory selct/unselect

bit     is_mmc_sd_write_pwd_locked(void);     // check if the lock protection on the card is featured and enabled
bit     mmc_sd_lock_operation(U8, U8, U8 *);  // use this function to lock/unlock the card or modify password

bit     mmc_sd_read_open (U32);         // to call before first access to a random page
void    mmc_sd_read_close (void);
bit     mmc_sd_write_open (U32);        // to call before first access to a random page
void    mmc_sd_write_close (void);

bit     mmc_sd_write_sector (U16);      // write a 512b sector from USB buffer
bit     mmc_sd_read_sector (U16);       // reads a 512b sector to an USB buffer

/*
bit     mmc_sd_host_write_sector (U16);
bit     mmc_sd_host_read_sector (U16);
*/

bit     mmc_sd_read_sector_to_ram(U8 *ram);     // reads a data block and send it to a buffer (512b)
bit     mmc_sd_write_sector_from_ram(U8 *ram);  // writes a data block from a buffer (512b)
bit     mmc_sd_erase_sector_group(U32, U32);    // erase a group of sectors defined by start and end address (details in mmc_sd.c)


extern U8            csd[16];                    // stores the Card Specific Data
extern volatile U32  capacity;                   // stores the capacity in bytes
extern volatile U32  mmc_sd_last_block_address;
extern  U16 erase_group_size;
extern  U8  r1;
extern  U16 r2;
extern  U8   card_type;                   // stores SD_CARD or MMC_CARD type card
extern  bit  mmc_sd_init_done;

#endif  /* _MMC_SD_H_ */

---