EmbeddedPkg/Include/Protocol/MmcHost.h

   1 /** @file
   2   Definition of the MMC Host Protocol
   3
   4   Copyright (c) 2011-2014, ARM Limited. All rights reserved.
   5
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __MMC_HOST_H__
  17 #define __MMC_HOST_H__
  18
  19 ///
  20 /// Global ID for the MMC Host Protocol
  21 ///
  22 #define EFI_MMC_HOST_PROTOCOL_GUID \
  23   { 0x3e591c00, 0x9e4a, 0x11df, {0x92, 0x44, 0x00, 0x02, 0xA5, 0xD5, 0xC5, 0x1B } }
  24
  25 #define MMC_RESPONSE_TYPE_R1        0
  26 #define MMC_RESPONSE_TYPE_R1b       0
  27 #define MMC_RESPONSE_TYPE_R2        1
  28 #define MMC_RESPONSE_TYPE_R3        0
  29 #define MMC_RESPONSE_TYPE_R6        0
  30 #define MMC_RESPONSE_TYPE_R7        0
  31 #define MMC_RESPONSE_TYPE_OCR       0
  32 #define MMC_RESPONSE_TYPE_CID       1
  33 #define MMC_RESPONSE_TYPE_CSD       1
  34 #define MMC_RESPONSE_TYPE_RCA       0
  35
  36 typedef UINT32  MMC_RESPONSE_TYPE;
  37
  38 typedef UINT32 MMC_CMD;
  39
  40 #define MMC_CMD_WAIT_RESPONSE      (1 << 16)
  41 #define MMC_CMD_LONG_RESPONSE      (1 << 17)
  42 #define MMC_CMD_NO_CRC_RESPONSE    (1 << 18)
  43
  44 #define MMC_INDX(Index)       ((Index) & 0xFFFF)
  45 #define MMC_GET_INDX(MmcCmd)  ((MmcCmd) & 0xFFFF)
  46
  47 #define MMC_CMD0              (MMC_INDX(0) | MMC_CMD_NO_CRC_RESPONSE)
  48 #define MMC_CMD1              (MMC_INDX(1) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)
  49 #define MMC_CMD2              (MMC_INDX(2) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_LONG_RESPONSE)
  50 #define MMC_CMD3              (MMC_INDX(3) | MMC_CMD_WAIT_RESPONSE)
  51 #define MMC_CMD5              (MMC_INDX(5) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)
  52 #define MMC_CMD7              (MMC_INDX(7) | MMC_CMD_WAIT_RESPONSE)
  53 #define MMC_CMD8              (MMC_INDX(8) | MMC_CMD_WAIT_RESPONSE)
  54 #define MMC_CMD9              (MMC_INDX(9) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_LONG_RESPONSE)
  55 #define MMC_CMD11             (MMC_INDX(11) | MMC_CMD_WAIT_RESPONSE)
  56 #define MMC_CMD12             (MMC_INDX(12) | MMC_CMD_WAIT_RESPONSE)
  57 #define MMC_CMD13             (MMC_INDX(13) | MMC_CMD_WAIT_RESPONSE)
  58 #define MMC_CMD16             (MMC_INDX(16) | MMC_CMD_WAIT_RESPONSE)
  59 #define MMC_CMD17             (MMC_INDX(17) | MMC_CMD_WAIT_RESPONSE)
  60 #define MMC_CMD18             (MMC_INDX(18) | MMC_CMD_WAIT_RESPONSE)
  61 #define MMC_CMD20             (MMC_INDX(20) | MMC_CMD_WAIT_RESPONSE)
  62 #define MMC_CMD23             (MMC_INDX(23) | MMC_CMD_WAIT_RESPONSE)
  63 #define MMC_CMD24             (MMC_INDX(24) | MMC_CMD_WAIT_RESPONSE)
  64 #define MMC_CMD55             (MMC_INDX(55) | MMC_CMD_WAIT_RESPONSE)
  65 #define MMC_ACMD41            (MMC_INDX(41) | MMC_CMD_WAIT_RESPONSE | MMC_CMD_NO_CRC_RESPONSE)
  66
  67 // Valid responses for CMD1 in eMMC
  68 #define EMMC_CMD1_CAPACITY_LESS_THAN_2GB 0x00FF8080 // Capacity <= 2GB, byte addressing used
  69 #define EMMC_CMD1_CAPACITY_GREATER_THAN_2GB 0x40FF8080 // Capacity > 2GB, 512-byte sector addressing used
  70
  71 typedef enum _MMC_STATE {
  72     MmcInvalidState = 0,
  73     MmcHwInitializationState,
  74     MmcIdleState,
  75     MmcReadyState,
  76     MmcIdentificationState,
  77     MmcStandByState,
  78     MmcTransferState,
  79     MmcSendingDataState,
  80     MmcReceiveDataState,
  81     MmcProgrammingState,
  82     MmcDisconnectState,
  83 } MMC_STATE;
  84
  85 ///
  86 /// Forward declaration for EFI_MMC_HOST_PROTOCOL
  87 ///
  88 typedef struct _EFI_MMC_HOST_PROTOCOL  EFI_MMC_HOST_PROTOCOL;
  89
  90 typedef BOOLEAN (EFIAPI *MMC_ISCARDPRESENT) (
  91   IN  EFI_MMC_HOST_PROTOCOL   *This
  92   );
  93
  94 typedef BOOLEAN (EFIAPI *MMC_ISREADONLY) (
  95   IN  EFI_MMC_HOST_PROTOCOL   *This
  96   );
  97
  98 typedef EFI_STATUS (EFIAPI *MMC_BUILDDEVICEPATH) (
  99   IN  EFI_MMC_HOST_PROTOCOL     *This,
 100   OUT EFI_DEVICE_PATH_PROTOCOL  **DevicePath
 101   );
 102
 103 typedef EFI_STATUS (EFIAPI *MMC_NOTIFYSTATE) (
 104   IN  EFI_MMC_HOST_PROTOCOL     *This,
 105   IN  MMC_STATE                 State
 106   );
 107
 108 typedef EFI_STATUS (EFIAPI *MMC_SENDCOMMAND) (
 109   IN  EFI_MMC_HOST_PROTOCOL     *This,
 110   IN  MMC_CMD                   Cmd,
 111   IN  UINT32                    Argument
 112   );
 113
 114 typedef EFI_STATUS (EFIAPI *MMC_RECEIVERESPONSE) (
 115   IN  EFI_MMC_HOST_PROTOCOL     *This,
 116   IN  MMC_RESPONSE_TYPE         Type,
 117   IN  UINT32                    *Buffer
 118   );
 119
 120 typedef EFI_STATUS (EFIAPI *MMC_READBLOCKDATA) (
 121   IN  EFI_MMC_HOST_PROTOCOL     *This,
 122   IN  EFI_LBA                   Lba,
 123   IN  UINTN                     Length,
 124   OUT UINT32                    *Buffer
 125   );
 126
 127 typedef EFI_STATUS (EFIAPI *MMC_WRITEBLOCKDATA) (
 128   IN  EFI_MMC_HOST_PROTOCOL     *This,
 129   IN  EFI_LBA                   Lba,
 130   IN  UINTN                     Length,
 131   IN  UINT32                    *Buffer
 132   );
 133
 134
 135 struct _EFI_MMC_HOST_PROTOCOL {
 136
 137   UINT32                  Revision;
 138   MMC_ISCARDPRESENT       IsCardPresent;
 139   MMC_ISREADONLY          IsReadOnly;
 140   MMC_BUILDDEVICEPATH     BuildDevicePath;
 141
 142   MMC_NOTIFYSTATE         NotifyState;
 143
 144   MMC_SENDCOMMAND         SendCommand;
 145   MMC_RECEIVERESPONSE     ReceiveResponse;
 146
 147   MMC_READBLOCKDATA       ReadBlockData;
 148   MMC_WRITEBLOCKDATA      WriteBlockData;
 149
 150 };
 151
 152 #define MMC_HOST_PROTOCOL_REVISION    0x00010001    // 1.1
 153
 154 extern EFI_GUID gEfiMmcHostProtocolGuid;
 155
 156 #endif
 157