QuarkSocPkg/QuarkSouthCluster/Include/SDCard.h

   1 /** @file
   2
   3 Header file for Industry SD Card 2.0 spec.
   4
   5 Copyright (c) 2013-2015 Intel Corporation.
   6
   7 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef _SD_CARD_H
  12 #define _SD_CARD_H
  13
  14 #include "MMC.h"
  15
  16 #pragma pack(1)
  17
  18 #define CHECK_PATTERN     0xAA  ///< Physical Layer Simplified Specification Version 3.01 recommended 0xAA
  19
  20 #define ACMD6             6
  21 #define ACMD13            13
  22 #define ACMD23            23
  23 #define ACMD41            41
  24 #define ACMD42            42
  25 #define ACMD51            51
  26
  27
  28 #define SWITCH_FUNC              CMD6
  29 #define SEND_IF_COND             CMD8
  30
  31
  32 #define SET_BUS_WIDTH            ACMD6
  33 #define SD_STATUS                ACMD13
  34 #define SET_WR_BLK_ERASE_COUNT   ACMD23
  35 #define SD_SEND_OP_COND          ACMD41
  36 #define SET_CLR_CARD_DETECT      ACMD42
  37 #define SEND_SCR                 ACMD51
  38
  39
  40
  41 #define SD_BUS_WIDTH_1              0
  42 #define SD_BUS_WIDTH_4              2
  43
  44
  45
  46 #define FREQUENCY_SD_PP        (25 * 1000 * 1000)
  47 #define FREQUENCY_SD_PP_HIGH   (50 * 1000 * 1000)
  48
  49
  50 #define SD_SPEC_10                  0
  51 #define SD_SPEC_11                  1
  52 #define SD_SPEC_20                  2
  53
  54
  55 #define VOLTAGE_27_36               0x1
  56
  57 typedef struct {
  58   UINT8   NotUsed:            1; //  1 [0:0]
  59   UINT8   CRC:                7; //  CRC [7:1]
  60   UINT8   ECC:                2; //  ECC code [9:8]
  61   UINT8   FILE_FORMAT:        2; //  File format [11:10]
  62   UINT8   TMP_WRITE_PROTECT:  1; //  Temporary write protection [12:12]
  63   UINT8   PERM_WRITE_PROTECT: 1; //  Permanent write protection [13:13]
  64   UINT8   COPY:               1; //  Copy flag (OTP) [14:14]
  65   UINT8   FILE_FORMAT_GRP:    1; //  File format group [15:15]
  66   UINT16  Reserved0:          5; //  0 [20:16]
  67   UINT16  WRITE_BL_PARTIAL:   1; //  Partial blocks for write allowed [21:21]
  68   UINT16  WRITE_BL_LEN:       4; //  Max. write data block length [25:22]
  69   UINT16  R2W_FACTOR:         3; //  Write speed factor [28:26]
  70   UINT16  DEFAULT_ECC:        2; //  Manufacturer default ECC [30:29]
  71   UINT16  WP_GRP_ENABLE:      1; //  Write protect group enable [31:31]
  72   UINT16  WP_GRP_SIZE:        7; //  Write protect group size [38:32]
  73   UINT16  SECTOR_SIZE:        7; //  Erase sector size [45:39]
  74   UINT16  ERASE_BLK_EN:       1; //  Erase single block enable [46:46]
  75   UINT16  Reserved1:          1; //  0 [47:47]
  76
  77   UINT32  C_SIZE:             22; //  Device size [69:48]
  78   UINT32  Reserved2:          6;  //  0 [75:70]
  79   UINT32  DSR_IMP:            1;  //  DSR implemented [76:76]
  80   UINT32  READ_BLK_MISALIGN:  1;  //  Read block misalignment [77:77]
  81   UINT32  WRITE_BLK_MISALIGN: 1;  //  Write block misalignment [78:78]
  82   UINT32  READ_BL_PARTIAL:    1;  //  Partial blocks for read allowed [79:79]
  83
  84   UINT16  READ_BL_LEN:        4;  //  Max. read data block length [83:80]
  85   UINT16  CCC:                12; //  Card command classes [95:84]
  86   UINT8   TRAN_SPEED          ;   //  Max. bus clock frequency [103:96]
  87   UINT8   NSAC                ;   //  Data read access-time 2 in CLK cycles (NSAC*100) [111:104]
  88   UINT8   TAAC                ;   //  Data read access-time 1 [119:112]
  89   UINT8   Reserved3:          6;  //  0 [125:120]
  90   UINT8   CSD_STRUCTURE:      2;  //  CSD structure [127:126]
  91 }CSD_SDV2;
  92
  93 typedef struct {
  94   UINT32  Reserved0;
  95   UINT32  Reserved1:               16;
  96   UINT32  SD_BUS_WIDTH:            4;
  97   UINT32  SD_SECURITY:             3;
  98   UINT32  DATA_STAT_AFTER_ERASE:   1;
  99   UINT32  SD_SPEC:                 4;
 100   UINT32  SCR_STRUCT:              4;
 101 }SCR;
 102
 103
 104 typedef struct {
 105   UINT8   Reserved0[50];
 106   UINT8   ERASE_OFFSET:               2;
 107   UINT8   ERASE_TIMEOUT:              6;
 108   UINT16  ERASE_SIZE;
 109   UINT8   Reserved1:                  4;
 110   UINT8   AU_SIZE:                    4;
 111   UINT8   PERFORMANCE_MOVE;
 112   UINT8   SPEED_CLASS;
 113   UINT32  SIZE_OF_PROTECTED_AREA;
 114   UINT32  SD_CARD_TYPE:              16;
 115   UINT32  Reserved2:                 13;
 116   UINT32  SECURED_MODE:               1;
 117   UINT32  DAT_BUS_WIDTH:              2;
 118 }SD_STATUS_REG;
 119
 120
 121
 122 typedef struct {
 123   UINT8   Reserved0[34];
 124   UINT16  Group1BusyStatus;
 125   UINT16  Group2BusyStatus;
 126   UINT16  Group3BusyStatus;
 127   UINT16  Group4BusyStatus;
 128   UINT16  Group5BusyStatus;
 129   UINT16  Group6BusyStatus;
 130   UINT8   DataStructureVersion;
 131   UINT8   Group21Status;
 132   UINT8   Group43Status;
 133   UINT8   Group65Status;
 134   UINT16  Group1Function;
 135   UINT16  Group2Function;
 136   UINT16  Group3Function;
 137   UINT16  Group4Function;
 138   UINT16  Group5Function;
 139   UINT16  Group6Function;
 140   UINT16  MaxCurrent;
 141 }SWITCH_STATUS;
 142
 143
 144 #pragma pack()
 145 #endif
 146