EmbeddedPkg/Include/Protocol/MmcHost.h

   1 /** @file
   2   Definition of the MMC Host Protocol
   3
   4   Copyright (c) 2011, 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 typedef enum _MMC_STATE {
  68     MmcInvalidState = 0,
  69     MmcHwInitializationState,
  70     MmcIdleState,
  71     MmcReadyState,
  72     MmcIdentificationState,
  73     MmcStandByState,
  74     MmcTransferState,
  75     MmcSendingDataState,
  76     MmcReceiveDataState,
  77     MmcProgrammingState,
  78     MmcDisconnectState,
  79 } MMC_STATE;
  80
  81 ///
  82 /// Forward declaration for EFI_MMC_HOST_PROTOCOL
  83 ///
  84 typedef struct _EFI_MMC_HOST_PROTOCOL  EFI_MMC_HOST_PROTOCOL;
  85
  86 typedef BOOLEAN (EFIAPI *MMC_ISCARDPRESENT) (
  87   IN  EFI_MMC_HOST_PROTOCOL   *This
  88   );
  89
  90 typedef BOOLEAN (EFIAPI *MMC_ISREADONLY) (
  91   IN  EFI_MMC_HOST_PROTOCOL   *This
  92   );
  93
  94 typedef EFI_STATUS (EFIAPI *MMC_BUILDDEVICEPATH) (
  95   IN  EFI_MMC_HOST_PROTOCOL     *This,
  96   OUT EFI_DEVICE_PATH_PROTOCOL  **DevicePath
  97   );
  98
  99 typedef EFI_STATUS (EFIAPI *MMC_NOTIFYSTATE) (
 100   IN  EFI_MMC_HOST_PROTOCOL     *This,
 101   IN  MMC_STATE                 State
 102   );
 103
 104 typedef EFI_STATUS (EFIAPI *MMC_SENDCOMMAND) (
 105   IN  EFI_MMC_HOST_PROTOCOL     *This,
 106   IN  MMC_CMD                   Cmd,
 107   IN  UINT32                    Argument
 108   );
 109
 110 typedef EFI_STATUS (EFIAPI *MMC_RECEIVERESPONSE) (
 111   IN  EFI_MMC_HOST_PROTOCOL     *This,
 112   IN  MMC_RESPONSE_TYPE         Type,
 113   IN  UINT32                    *Buffer
 114   );
 115
 116 typedef EFI_STATUS (EFIAPI *MMC_READBLOCKDATA) (
 117   IN  EFI_MMC_HOST_PROTOCOL     *This,
 118   IN  EFI_LBA                   Lba,
 119   IN  UINTN                     Length,
 120   OUT UINT32                    *Buffer
 121   );
 122
 123 typedef EFI_STATUS (EFIAPI *MMC_WRITEBLOCKDATA) (
 124   IN  EFI_MMC_HOST_PROTOCOL     *This,
 125   IN  EFI_LBA                   Lba,
 126   IN  UINTN                     Length,
 127   IN  UINT32                    *Buffer
 128   );
 129
 130
 131 typedef struct _EFI_MMC_HOST_PROTOCOL {
 132
 133   UINT32                  Revision;
 134   MMC_ISCARDPRESENT       IsCardPresent;
 135   MMC_ISREADONLY          IsReadOnly;
 136   MMC_BUILDDEVICEPATH     BuildDevicePath;
 137
 138   MMC_NOTIFYSTATE         NotifyState;
 139
 140   MMC_SENDCOMMAND         SendCommand;
 141   MMC_RECEIVERESPONSE     ReceiveResponse;
 142
 143   MMC_READBLOCKDATA       ReadBlockData;
 144   MMC_WRITEBLOCKDATA      WriteBlockData;
 145
 146 } EFI_MMC_HOST_PROTOCOL;
 147
 148 #define MMC_HOST_PROTOCOL_REVISION    0x00010001    // 1.1
 149
 150 extern EFI_GUID gEfiMmcHostProtocolGuid;
 151
 152 #endif
 153