firmware/export/sd.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Alan Korr
  11  * Copyright (C) 2008 by Frank Gevaerts
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version 2
  16  * of the License, or (at your option) any later version.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ****************************************************************************/
  22 #ifndef __SD_H__
  23 #define __SD_H__
  24
  25 #include <stdbool.h>
  26 #include "config.h"
  27 #include "mv.h" /* for HAVE_MULTIDRIVE or not */
  28
  29 #ifdef HAVE_BOOTLOADER_USB_MODE
  30 #define SD_DRIVER_CLOSE
  31 #endif
  32
  33 #define SD_BLOCK_SIZE 512 /* XXX : support other sizes ? */
  34
  35 struct storage_info;
  36
  37 void sd_enable(bool on);
  38 void sd_spindown(int seconds);
  39 void sd_sleep(void);
  40 void sd_sleepnow(void);
  41 bool sd_disk_is_active(void);
  42 int  sd_soft_reset(void);
  43 int  sd_init(void) STORAGE_INIT_ATTR;
  44 void sd_close(void);
  45 int  sd_read_sectors(IF_MD2(int drive,) unsigned long start, int count, void* buf);
  46 int  sd_write_sectors(IF_MD2(int drive,) unsigned long start, int count, const void* buf);
  47 void sd_spin(void);
  48 int  sd_spinup_time(void); /* ticks */
  49
  50 #ifdef STORAGE_GET_INFO
  51 void sd_get_info(IF_MD2(int drive,) struct storage_info *info);
  52 #endif
  53 #ifdef HAVE_HOTSWAP
  54 bool sd_removable(IF_MV_NONVOID(int drive));
  55 bool sd_present(IF_MV_NONVOID(int drive));
  56 #endif
  57
  58 long sd_last_disk_activity(void);
  59
  60 #ifdef CONFIG_STORAGE_MULTI
  61 int sd_num_drives(int first_drive);
  62 #endif
  63
  64
  65 /* SD States */
  66 #define SD_IDLE             0
  67 #define SD_READY            1
  68 #define SD_IDENT            2
  69 #define SD_STBY             3
  70 #define SD_TRAN             4
  71 #define SD_DATA             5
  72 #define SD_RCV              6
  73 #define SD_PRG              7
  74 #define SD_DIS              8
  75
  76 /* SD Commands */
  77 #define SD_GO_IDLE_STATE           0
  78 #define SD_ALL_SEND_CID            2
  79 #define SD_SEND_RELATIVE_ADDR      3
  80 #define SD_SET_DSR                 4
  81 #define SD_SWITCH_FUNC             6
  82 #define SD_SET_BUS_WIDTH           6  /* acmd6 */
  83 #define SD_SELECT_CARD             7  /* with card's rca  */
  84 #define SD_DESELECT_CARD           7  /* with rca = 0  */
  85 #define SD_SEND_IF_COND            8
  86 #define SD_SEND_CSD                9
  87 #define SD_SEND_CID               10
  88 #define SD_STOP_TRANSMISSION      12
  89 #define SD_SEND_STATUS            13
  90 #define SD_SD_STATUS              13  /* acmd13 */
  91 #define SD_GO_INACTIVE_STATE      15
  92 #define SD_SET_BLOCKLEN           16
  93 #define SD_READ_SINGLE_BLOCK      17
  94 #define SD_READ_MULTIPLE_BLOCK    18
  95 #define SD_SEND_NUM_WR_BLOCKS     22  /* acmd22 */
  96 #define SD_SET_WR_BLK_ERASE_COUNT 23  /* acmd23 */
  97 #define SD_WRITE_BLOCK            24
  98 #define SD_WRITE_MULTIPLE_BLOCK   25
  99 #define SD_PROGRAM_CSD            27
 100 #define SD_ERASE_WR_BLK_START     32
 101 #define SD_ERASE_WR_BLK_END       33
 102 #define SD_ERASE                  38
 103 #define SD_APP_OP_COND            41  /* acmd41 */
 104 #define SD_LOCK_UNLOCK            42
 105 #define SD_SET_CLR_CARD_DETECT    42  /* acmd42 */
 106 #define SD_SEND_SCR               51  /* acmd51 */
 107 #define SD_APP_CMD                55
 108
 109 /*
 110   SD/MMC status in R1, for native mode (SPI bits are different)
 111   Type
 112     e : error bit
 113     s : status bit
 114     r : detected and set for the actual command response
 115     x : detected and set during command execution. the host must poll
 116             the card by sending status command in order to read these bits.
 117   Clear condition
 118     a : according to the card state
 119     b : always related to the previous command. Reception of
 120             a valid command will clear it (with a delay of one command)
 121     c : clear by read
 122  */
 123
 124 #define SD_R1_OUT_OF_RANGE         (1 << 31)   /* erx, c */
 125 #define SD_R1_ADDRESS_ERROR        (1 << 30)   /* erx, c */
 126 #define SD_R1_BLOCK_LEN_ERROR      (1 << 29)   /* erx, c */
 127 #define SD_R1_ERASE_SEQ_ERROR      (1 << 28)   /* er,  c */
 128 #define SD_R1_ERASE_PARAM          (1 << 27)   /* exx, c */
 129 #define SD_R1_WP_VIOLATION         (1 << 26)   /* erx, c */
 130 #define SD_R1_CARD_IS_LOCKED       (1 << 25)   /* sx,  a */
 131 #define SD_R1_LOCK_UNLOCK_FAILED   (1 << 24)   /* erx, c */
 132 #define SD_R1_COM_CRC_ERROR        (1 << 23)   /* er,  b */
 133 #define SD_R1_ILLEGAL_COMMAND      (1 << 22)   /* er,  b */
 134 #define SD_R1_CARD_ECC_FAILED      (1 << 21)   /* erx, c */
 135 #define SD_R1_CC_ERROR             (1 << 20)   /* erx, c */
 136 #define SD_R1_ERROR                (1 << 19)   /* erx, c */
 137 #define SD_R1_UNDERRUN             (1 << 18)   /* ex,  c */
 138 #define SD_R1_OVERRUN              (1 << 17)   /* ex,  c */
 139 #define SD_R1_CSD_OVERWRITE        (1 << 16)   /* erx, c */
 140 #define SD_R1_WP_ERASE_SKIP        (1 << 15)   /* erx, c */
 141 #define SD_R1_CARD_ECC_DISABLED    (1 << 14)   /* sx,  a */
 142 #define SD_R1_ERASE_RESET          (1 << 13)   /* sr,  c */
 143 #define SD_R1_STATUS(x)            (x & 0xFFFFE000)
 144 #define SD_R1_CURRENT_STATE(x)     ((x & 0x00001E00) >> 9) /* sx, b (4 bits) */
 145 #define SD_R1_READY_FOR_DATA       (1 << 8)    /* sx,  a */
 146 #define SD_R1_APP_CMD              (1 << 5)    /* sr,  c */
 147 #define SD_R1_AKE_SEQ_ERROR        (1 << 3)    /* er,  c */
 148
 149 /* SD OCR bits */
 150 #define SD_OCR_CARD_CAPACITY_STATUS    (1 << 30)   /* Card Capacity Status */
 151
 152 /*  All R1 Response flags that indicate Card error(vs MCI Controller error) */
 153 #define SD_R1_CARD_ERROR           ( SD_R1_OUT_OF_RANGE           \
 154                                    | SD_R1_ADDRESS_ERROR          \
 155                                    | SD_R1_BLOCK_LEN_ERROR        \
 156                                    | SD_R1_ERASE_SEQ_ERROR        \
 157                                    | SD_R1_ERASE_PARAM            \
 158                                    | SD_R1_WP_VIOLATION           \
 159                                    | SD_R1_LOCK_UNLOCK_FAILED     \
 160                                    | SD_R1_COM_CRC_ERROR          \
 161                                    | SD_R1_ILLEGAL_COMMAND        \
 162                                    | SD_R1_CARD_ECC_FAILED        \
 163                                    | SD_R1_CC_ERROR               \
 164                                    | SD_R1_ERROR                  \
 165                                    | SD_R1_UNDERRUN               \
 166                                    | SD_R1_CSD_OVERWRITE          \
 167                                    | SD_R1_WP_ERASE_SKIP          \
 168                                    | SD_R1_AKE_SEQ_ERROR)
 169
 170
 171 #endif