EmbeddedPkg/MmcDxe: Update Mmc code to conform to coding standard
[mirror_edk2.git] / EmbeddedPkg / Universal / MmcDxe / MmcBlockIo.c
index 33f2c56..57fa14e 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
 *\r
 *  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
-*  \r
-*  This program and the accompanying materials                          \r
-*  are licensed and made available under the terms and conditions of the BSD License         \r
-*  which accompanies this distribution.  The full text of the license may be found at        \r
-*  http://opensource.org/licenses/bsd-license.php                                            \r
 *\r
-*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+*  This program and the accompanying materials\r
+*  are licensed and made available under the terms and conditions of the BSD License\r
+*  which accompanies this distribution.  The full text of the license may be found at\r
+*  http://opensource.org/licenses/bsd-license.php\r
+*\r
+*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 *\r
 **/\r
 \r
@@ -19,9 +19,6 @@
 \r
 #include "Mmc.h"\r
 \r
-// Untested ...\r
-//#define USE_STREAM\r
-\r
 #define MAX_RETRY_COUNT  1000\r
 #define CMD_RETRY_COUNT  20\r
 \r
@@ -112,7 +109,7 @@ PrintCSD (
   DEBUG ((EFI_D_ERROR, "\t- Maximum Read Data Block: %d\n",2 << (MMC_CSD_GET_READBLLEN(Csd)-1)));\r
   DEBUG ((EFI_D_ERROR, "\t- Maximum Write Data Block: %d\n",2 << (MMC_CSD_GET_WRITEBLLEN(Csd)-1)));\r
 \r
-  if (!MMC_CSD_GET_FILEFORMATGRP(Csd)) {\r
+  if (!MMC_CSD_GET_FILEFORMATGRP (Csd)) {\r
     Value = MMC_CSD_GET_FILEFORMAT (Csd);\r
     if (Value == 0)         DEBUG ((EFI_D_ERROR, "\t- Format (0): Hard disk-like file system with partition table\n"));\r
     else if (Value == 1)    DEBUG ((EFI_D_ERROR, "\t- Format (1): DOS FAT (floppy-like) with boot sector only (no partition table)\n"));\r
@@ -157,7 +154,7 @@ PrintResponseR1 (
 \r
 EFI_STATUS\r
 EFIAPI\r
-MmcGetCardStatus(\r
+MmcGetCardStatus (\r
        IN MMC_HOST_INSTANCE     *MmcHostInstance\r
   )\r
 {\r
@@ -173,7 +170,7 @@ MmcGetCardStatus(
   if (MmcHost == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
-  if(MmcHostInstance->State != MmcHwInitializationState){\r
+  if (MmcHostInstance->State != MmcHwInitializationState) {\r
     //Get the Status of the card.\r
     CmdArg = MmcHostInstance->CardInfo.RCA << 16;\r
     Status = MmcHost->SendCommand (MmcHost, MMC_CMD13, CmdArg);\r
@@ -249,7 +246,7 @@ MmcIdentificationMode (
     MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_R7, Response);\r
     PrintResponseR1 (Response[0]);\r
     //check if it is valid response\r
-    if(Response[0] != CmdArg){\r
+    if (Response[0] != CmdArg) {\r
       DEBUG ((EFI_D_ERROR, "The Card is not usable\n"));\r
       return EFI_UNSUPPORTED;\r
     }\r
@@ -263,44 +260,44 @@ MmcIdentificationMode (
     // SD Card or MMC Card ? CMD55 indicates to the card that the next command is an application specific command\r
     Status = MmcHost->SendCommand (MmcHost, MMC_CMD55, 0);\r
     if (Status == EFI_SUCCESS) {\r
-        DEBUG ((EFI_D_INFO, "Card should be SD\n"));\r
-        if (IsHCS) {\r
-            MmcHostInstance->CardInfo.CardType = SD_CARD_2;\r
-        } else {\r
-            MmcHostInstance->CardInfo.CardType = SD_CARD;\r
-        }\r
+      DEBUG ((EFI_D_INFO, "Card should be SD\n"));\r
+      if (IsHCS) {\r
+        MmcHostInstance->CardInfo.CardType = SD_CARD_2;\r
+      } else {\r
+        MmcHostInstance->CardInfo.CardType = SD_CARD;\r
+      }\r
 \r
-        // Note: The first time CmdArg will be zero\r
-        CmdArg = ((UINTN *) &(MmcHostInstance->CardInfo.OCRData))[0];\r
-        if (IsHCS) {\r
-            CmdArg |= BIT30;\r
-        }\r
-        Status = MmcHost->SendCommand (MmcHost, MMC_ACMD41, CmdArg);\r
-        if (!EFI_ERROR (Status)) {\r
-          MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_OCR, Response);\r
-          ((UINT32 *) &(MmcHostInstance->CardInfo.OCRData))[0] = Response[0];\r
-        }\r
+      // Note: The first time CmdArg will be zero\r
+      CmdArg = ((UINTN *) &(MmcHostInstance->CardInfo.OCRData))[0];\r
+      if (IsHCS) {\r
+        CmdArg |= BIT30;\r
+      }\r
+      Status = MmcHost->SendCommand (MmcHost, MMC_ACMD41, CmdArg);\r
+      if (!EFI_ERROR (Status)) {\r
+        MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_OCR, Response);\r
+        ((UINT32 *) &(MmcHostInstance->CardInfo.OCRData))[0] = Response[0];\r
+      }\r
     } else {\r
-        DEBUG ((EFI_D_INFO, "Card should be MMC\n"));\r
-        MmcHostInstance->CardInfo.CardType = MMC_CARD;\r
+      DEBUG ((EFI_D_INFO, "Card should be MMC\n"));\r
+      MmcHostInstance->CardInfo.CardType = MMC_CARD;\r
 \r
-        Status = MmcHost->SendCommand (MmcHost, MMC_CMD1, 0x800000);\r
-        if (!EFI_ERROR (Status)) {\r
-          MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_OCR, Response);\r
-          ((UINT32 *) &(MmcHostInstance->CardInfo.OCRData))[0] = Response[0];\r
-        }\r
+      Status = MmcHost->SendCommand (MmcHost, MMC_CMD1, 0x800000);\r
+      if (!EFI_ERROR (Status)) {\r
+        MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_OCR, Response);\r
+        ((UINT32 *) &(MmcHostInstance->CardInfo.OCRData))[0] = Response[0];\r
+      }\r
     }\r
 \r
     if (!EFI_ERROR (Status)) {\r
       if (!MmcHostInstance->CardInfo.OCRData.PowerUp) {\r
-          MicroSecondDelay (1);\r
-          Timeout--;\r
+        MicroSecondDelay (1);\r
+        Timeout--;\r
       } else {\r
-          if ((MmcHostInstance->CardInfo.CardType == SD_CARD_2) && (MmcHostInstance->CardInfo.OCRData.AccessMode & BIT1)) {\r
-              MmcHostInstance->CardInfo.CardType = SD_CARD_2_HIGH;\r
-              DEBUG ((EFI_D_ERROR, "High capacity card.\n"));\r
-          }\r
-          break;  // The MMC/SD card is ready. Continue the Identification Mode\r
+        if ((MmcHostInstance->CardInfo.CardType == SD_CARD_2) && (MmcHostInstance->CardInfo.OCRData.AccessMode & BIT1)) {\r
+          MmcHostInstance->CardInfo.CardType = SD_CARD_2_HIGH;\r
+          DEBUG ((EFI_D_ERROR, "High capacity card.\n"));\r
+        }\r
+        break;  // The MMC/SD card is ready. Continue the Identification Mode\r
       }\r
     } else {\r
       MicroSecondDelay (1);\r
@@ -327,7 +324,7 @@ MmcIdentificationMode (
     return Status;\r
   }\r
   MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_CID, Response);\r
-  PrintCID(Response);\r
+  PrintCID (Response);\r
 \r
   Status = MmcNotifyState (MmcHostInstance, MmcIdentificationState);\r
   if (EFI_ERROR (Status)) {\r
@@ -374,8 +371,9 @@ EFI_STATUS InitializeMmcDevice (
   EFI_STATUS              Status;\r
   UINTN                   CardSize, NumBlocks, BlockSize, CmdArg;\r
   EFI_MMC_HOST_PROTOCOL   *MmcHost;\r
-  UINTN                   BlockCount = 1;\r
-  \r
+  UINTN                   BlockCount;\r
+\r
+  BlockCount = 1;\r
   MmcHost = MmcHostInstance->MmcHost;\r
 \r
   MmcIdentificationMode (MmcHostInstance);\r
@@ -384,21 +382,21 @@ EFI_STATUS InitializeMmcDevice (
   CmdArg = MmcHostInstance->CardInfo.RCA << 16;\r
   Status = MmcHost->SendCommand (MmcHost, MMC_CMD9, CmdArg);\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "MmcIdentificationMode(MMC_CMD9): Error, Status=%r\n", Status));\r
+    DEBUG((EFI_D_ERROR, "InitializeMmcDevice(MMC_CMD9): Error, Status=%r\n", Status));\r
     return Status;\r
   }\r
   //Read Response\r
   MmcHost->ReceiveResponse (MmcHost, MMC_RESPONSE_TYPE_CSD, Response);\r
-  PrintCSD(Response);\r
+  PrintCSD (Response);\r
 \r
   if (MmcHostInstance->CardInfo.CardType == SD_CARD_2_HIGH) {\r
     CardSize = HC_MMC_CSD_GET_DEVICESIZE (Response);\r
     NumBlocks = ((CardSize + 1) * 1024);\r
-    BlockSize = 1 << MMC_CSD_GET_READBLLEN(Response);\r
+    BlockSize = 1 << MMC_CSD_GET_READBLLEN (Response);\r
   } else {\r
     CardSize = MMC_CSD_GET_DEVICESIZE (Response);\r
     NumBlocks = (CardSize + 1) * (1 << (MMC_CSD_GET_DEVICESIZEMULT (Response) + 2));\r
-    BlockSize = 1 << MMC_CSD_GET_READBLLEN(Response);\r
+    BlockSize = 1 << MMC_CSD_GET_READBLLEN (Response);\r
   }\r
 \r
   //For >=2G card, BlockSize may be 1K, but the transfer size is 512 bytes.\r
@@ -416,20 +414,21 @@ EFI_STATUS InitializeMmcDevice (
   CmdArg = MmcHostInstance->CardInfo.RCA << 16;\r
   Status = MmcHost->SendCommand (MmcHost, MMC_CMD7, CmdArg);\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "MmcIdentificationMode(MMC_CMD7): Error and Status = %r\n", Status));\r
+    DEBUG((EFI_D_ERROR, "InitializeMmcDevice(MMC_CMD7): Error and Status = %r\n", Status));\r
     return Status;\r
   }\r
 \r
   Status = MmcNotifyState (MmcHostInstance, MmcTransferState);\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "MmcIdentificationMode() : Error MmcTransferState\n"));\r
+    DEBUG((EFI_D_ERROR, "InitializeMmcDevice(): Error MmcTransferState\n"));\r
     return Status;\r
   }\r
 \r
   // Set Block Length\r
   Status = MmcHost->SendCommand (MmcHost, MMC_CMD16, MmcHostInstance->BlockIo.Media->BlockSize);\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((EFI_D_ERROR, "MmcIdentificationMode(MMC_CMD16): Error MmcHostInstance->BlockIo.Media->BlockSize: %d and Error = %r\n", MmcHostInstance->BlockIo.Media->BlockSize, Status));\r
+    DEBUG((EFI_D_ERROR, "InitializeMmcDevice(MMC_CMD16): Error MmcHostInstance->BlockIo.Media->BlockSize: %d and Error = %r\n",\r
+                        MmcHostInstance->BlockIo.Media->BlockSize, Status));\r
     return Status;\r
   }\r
 \r
@@ -508,10 +507,11 @@ MmcIoBlocks (
   MMC_HOST_INSTANCE       *MmcHostInstance;\r
   EFI_MMC_HOST_PROTOCOL   *MmcHost;\r
   UINTN                   BytesRemainingToBeTransfered;\r
-  UINTN                   BlockCount = 1;\r
+  UINTN                   BlockCount;\r
 \r
+  BlockCount = 1;\r
   MmcHostInstance = MMC_HOST_INSTANCE_FROM_BLOCK_IO_THIS (This);\r
-  ASSERT (MmcHostInstance != 0);\r
+  ASSERT (MmcHostInstance != NULL);\r
   MmcHost = MmcHostInstance->MmcHost;\r
   ASSERT (MmcHost);\r
 \r
@@ -519,7 +519,7 @@ MmcIoBlocks (
     return EFI_MEDIA_CHANGED;\r
   }\r
 \r
-  if ((MmcHost == 0)|| (Buffer == NULL)) {\r
+  if ((MmcHost == NULL) || (Buffer == NULL)) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -529,11 +529,11 @@ MmcIoBlocks (
   }\r
 \r
   // All blocks must be within the device\r
-  if ((Lba + (BufferSize / This->Media->BlockSize)) > (This->Media->LastBlock + 1)){\r
+  if ((Lba + (BufferSize / This->Media->BlockSize)) > (This->Media->LastBlock + 1)) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  if((Transfer == MMC_IOBLOCKS_WRITE) && (This->Media->ReadOnly == TRUE)) {\r
+  if ((Transfer == MMC_IOBLOCKS_WRITE) && (This->Media->ReadOnly == TRUE)) {\r
     return EFI_WRITE_PROTECTED;\r
   }\r
 \r
@@ -581,19 +581,11 @@ MmcIoBlocks (
     }\r
 \r
     if (Transfer == MMC_IOBLOCKS_READ) {\r
-#ifndef USE_STREAM\r
       // Read a single block\r
       Cmd = MMC_CMD17;\r
-#else\r
-      //TODO: Should we support read stream (MMC_CMD11)\r
-#endif\r
     } else {\r
-#ifndef USE_STREAM\r
       // Write a single block\r
       Cmd = MMC_CMD24;\r
-#else\r
-      //TODO: Should we support write stream (MMC_CMD20)\r
-#endif\r
     }\r
     Status = MmcHost->SendCommand (MmcHost, Cmd, CmdArg);\r
     if (EFI_ERROR (Status)) {\r
@@ -602,34 +594,24 @@ MmcIoBlocks (
     }\r
 \r
     if (Transfer == MMC_IOBLOCKS_READ) {\r
-#ifndef USE_STREAM\r
       // Read one block of Data\r
       Status = MmcHost->ReadBlockData (MmcHost, Lba, This->Media->BlockSize, Buffer);\r
       if (EFI_ERROR (Status)) {\r
         DEBUG ((EFI_D_BLKIO, "MmcIoBlocks(): Error Read Block Data and Status = %r\n", Status));\r
         return Status;\r
       }\r
-#else\r
-      //TODO: Read a stream\r
-      ASSERT (0);\r
-#endif\r
       Status = MmcNotifyState (MmcHostInstance, MmcProgrammingState);\r
       if (EFI_ERROR (Status)) {\r
         DEBUG ((EFI_D_ERROR, "MmcIoBlocks() : Error MmcProgrammingState\n"));\r
         return Status;\r
       }\r
     } else {\r
-#ifndef USE_STREAM\r
       // Write one block of Data\r
       Status = MmcHost->WriteBlockData (MmcHost, Lba, This->Media->BlockSize, Buffer);\r
       if (EFI_ERROR (Status)) {\r
         DEBUG ((EFI_D_BLKIO, "MmcIoBlocks(): Error Write Block Data and Status = %r\n", Status));\r
         return Status;\r
       }\r
-#else\r
-      //TODO: Write a stream\r
-      ASSERT (0);\r
-#endif\r
     }\r
 \r
     // Command 12 - Stop transmission (ends read)\r