[mirror_edk2.git] / Omap35xxPkg / MMCHSDxe / MMCHS.h

/** @file\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\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
\r
**/\r
\r
#ifndef _MMCHS_H_\r
#define _MMCHS_H_\r
\r
#include <Uefi.h>
\r
#include <Library/BaseLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DebugLib.h>
#include <Library/IoLib.h>
#include <Library/PcdLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/OmapLib.h>
#include <Library/OmapDmaLib.h>

#include <Protocol/EmbeddedExternalDevice.h>\r
#include <Protocol/BlockIo.h>
#include <Protocol/DevicePath.h>

#include <Omap3530/Omap3530.h>\r
#include <TPS65950.h>\r
\r
#define MAX_RETRY_COUNT  (100*5)

#define HCS               BIT30 //Host capacity support/1 = Supporting high capacity\r
#define CCS               BIT30 //Card capacity status/1 = High capacity card\r
typedef struct {\r
  UINT32  Reserved0:   7; // 0 \r
  UINT32  V170_V195:   1; // 1.70V - 1.95V\r
  UINT32  V200_V260:   7; // 2.00V - 2.60V\r
  UINT32  V270_V360:   9; // 2.70V - 3.60V\r
  UINT32  RESERVED_1:  5; // Reserved\r
  UINT32  AccessMode:  2; // 00b (byte mode), 10b (sector mode) \r
  UINT32  Busy:        1; // This bit is set to LOW if the card has not finished the power up routine\r
}OCR;\r
\r
typedef struct {\r
  UINT32  NOT_USED;   // 1 [0:0]\r
  UINT32  CRC;        // CRC7 checksum [7:1]\r
  UINT32  MDT;        // Manufacturing date [19:8]\r
  UINT32  RESERVED_1; // Reserved [23:20]\r
  UINT32  PSN;        // Product serial number [55:24]\r
  UINT8   PRV;        // Product revision [63:56]\r
  UINT8   PNM[5];     // Product name [64:103]\r
  UINT16  OID;        // OEM/Application ID [119:104]\r
  UINT8   MID;        // Manufacturer ID [127:120]\r
}CID;\r
\r
typedef struct {\r
  UINT8   NOT_USED:           1; // Not used, always 1 [0:0]\r
  UINT8   CRC:                7; // CRC [7:1]\r
\r
  UINT8   RESERVED_1:         2; // Reserved [9:8]\r
  UINT8   FILE_FORMAT:        2; // File format [11:10]\r
  UINT8   TMP_WRITE_PROTECT:  1; // Temporary write protection [12:12]\r
  UINT8   PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
  UINT8   COPY:               1; // Copy flag (OTP) [14:14]\r
  UINT8   FILE_FORMAT_GRP:    1; // File format group [15:15]\r
  \r
  UINT16  RESERVED_2:         5; // Reserved [20:16]\r
  UINT16  WRITE_BL_PARTIAL:   1; // Partial blocks for write allowed [21:21]\r
  UINT16  WRITE_BL_LEN:       4; // Max. write data block length [25:22]\r
  UINT16  R2W_FACTOR:         3; // Write speed factor [28:26]\r
  UINT16  RESERVED_3:         2; // Reserved [30:29]\r
  UINT16  WP_GRP_ENABLE:      1; // Write protect group enable [31:31]\r
  \r
  UINT32  WP_GRP_SIZE:        7; // Write protect group size [38:32]\r
  UINT32  SECTOR_SIZE:        7; // Erase sector size [45:39]\r
  UINT32  ERASE_BLK_EN:       1; // Erase single block enable [46:46]\r
  UINT32  C_SIZE_MULT:        3; // Device size multiplier [49:47]\r
  UINT32  VDD_W_CURR_MAX:     3; // Max. write current @ VDD max [52:50]\r
  UINT32  VDD_W_CURR_MIN:     3; // Max. write current @ VDD min [55:53]\r
  UINT32  VDD_R_CURR_MAX:     3; // Max. read current @ VDD max [58:56]\r
  UINT32  VDD_R_CURR_MIN:     3; // Max. read current @ VDD min [61:59]\r
  UINT32  C_SIZELow2:         2; // Device size [63:62]\r
  \r
  UINT32  C_SIZEHigh10:       10;// Device size [73:64]\r
  UINT32  RESERVED_4:         2; // Reserved [75:74]\r
  UINT32  DSR_IMP:            1; // DSR implemented [76:76]\r
  UINT32  READ_BLK_MISALIGN:  1; // Read block misalignment [77:77]\r
  UINT32  WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
  UINT32  READ_BL_PARTIAL:    1; // Partial blocks for read allowed [79:79]\r
  UINT32  READ_BL_LEN:        4; // Max. read data block length [83:80]\r
  UINT32  CCC:                12;// Card command classes [95:84]\r
\r
  UINT8   TRAN_SPEED          ;  // Max. bus clock frequency [103:96]\r
  UINT8   NSAC                ;  // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
  UINT8   TAAC                ;  // Data read access-time 1 [119:112]\r
  \r
  UINT8   RESERVED_5:         6; // Reserved [125:120]\r
  UINT8   CSD_STRUCTURE:      2; // CSD structure [127:126]\r
}CSD;\r
\r
typedef struct {\r
  UINT8   NOT_USED:           1; // Not used, always 1 [0:0]\r
  UINT8   CRC:                7; // CRC [7:1]\r
  UINT8   RESERVED_1:         2; // Reserved [9:8]\r
  UINT8   FILE_FORMAT:        2; // File format [11:10]\r
  UINT8   TMP_WRITE_PROTECT:  1; // Temporary write protection [12:12]\r
  UINT8   PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
  UINT8   COPY:               1; // Copy flag (OTP) [14:14]\r
  UINT8   FILE_FORMAT_GRP:    1; // File format group [15:15]\r
  UINT16  RESERVED_2:         5; // Reserved [20:16]\r
  UINT16  WRITE_BL_PARTIAL:   1; // Partial blocks for write allowed [21:21]\r
  UINT16  WRITE_BL_LEN:       4; // Max. write data block length [25:22]\r
  UINT16  R2W_FACTOR:         3; // Write speed factor [28:26]\r
  UINT16  RESERVED_3:         2; // Reserved [30:29]\r
  UINT16  WP_GRP_ENABLE:      1; // Write protect group enable [31:31]\r
  UINT16  WP_GRP_SIZE:        7; // Write protect group size [38:32]\r
  UINT16  SECTOR_SIZE:        7; // Erase sector size [45:39]\r
  UINT16  ERASE_BLK_EN:       1; // Erase single block enable [46:46]\r
  UINT16  RESERVED_4:         1; // Reserved [47:47]\r
  UINT32  C_SIZELow16:        16;// Device size [69:48]\r
  UINT32  C_SIZEHigh6:        6; // Device size [69:48]\r
  UINT32  RESERVED_5:         6; // Reserved [75:70]\r
  UINT32  DSR_IMP:            1; // DSR implemented [76:76]\r
  UINT32  READ_BLK_MISALIGN:  1; // Read block misalignment [77:77]\r
  UINT32  WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
  UINT32  READ_BL_PARTIAL:    1; // Partial blocks for read allowed [79:79]\r
  UINT16  READ_BL_LEN:        4; // Max. read data block length [83:80]\r
  UINT16  CCC:                12;// Card command classes [95:84]\r
  UINT8   TRAN_SPEED          ;  // Max. bus clock frequency [103:96]\r
  UINT8   NSAC                ;  // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
  UINT8   TAAC                ;  // Data read access-time 1 [119:112]\r
  UINT8   RESERVED_6:         6; // 0 [125:120]\r
  UINT8   CSD_STRUCTURE:      2; // CSD structure [127:126]\r
}CSD_SDV2;\r
\r
typedef enum {
  UNKNOWN_CARD,
  MMC_CARD,              //MMC card
  SD_CARD,               //SD 1.1 card
  SD_CARD_2,             //SD 2.0 or above standard card
  SD_CARD_2_HIGH         //SD 2.0 or above high capacity card
} CARD_TYPE;\r
\r
typedef enum {\r
  READ,\r
  WRITE\r
} OPERATION_TYPE;\r
\r
typedef struct  {\r
  UINT16    RCA;\r
  UINTN     BlockSize;\r
  UINTN     NumBlocks;\r
  UINTN     ClockFrequencySelect;\r
  CARD_TYPE CardType;\r
  OCR       OCRData;\r
  CID       CIDData;\r
  CSD       CSDData;\r
} CARD_INFO;\r
\r
EFI_STATUS
DetectCard (
  VOID
  );\r
\r
extern EFI_BLOCK_IO_PROTOCOL gBlockIo;\r
\r
#endif\r
Commit	Line	Data
a3f98646	1	/** @file\r
a3f98646	2	\r
3d70643b	3	Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
a3f98646	4	\r
3d70643b	5	This program and the accompanying materials\r
a3f98646	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef _MMCHS_H_\r
	16	#define _MMCHS_H_\r
	17	\r
7f814ffd	18	#include <Uefi.h>
7f814ffd	19	\r
a3f98646	20	#include <Library/BaseLib.h>
	21	#include <Library/MemoryAllocationLib.h>
	22	#include <Library/DebugLib.h>
	23	#include <Library/IoLib.h>
	24	#include <Library/PcdLib.h>
	25	#include <Library/UefiBootServicesTableLib.h>
8c6151f2	26	#include <Library/BaseMemoryLib.h>
7f814ffd	27	#include <Library/OmapLib.h>
7f814ffd	28	#include <Library/OmapDmaLib.h>
a3f98646	29
	30	#include <Protocol/EmbeddedExternalDevice.h>\r
	31	#include <Protocol/BlockIo.h>
a3f98646	32	#include <Protocol/DevicePath.h>
	33
	34	#include <Omap3530/Omap3530.h>\r
	35	#include <TPS65950.h>\r
	36	\r
8c6151f2	37	#define MAX_RETRY_COUNT (100*5)
a3f98646	38
43263288	39	#define HCS BIT30 //Host capacity support/1 = Supporting high capacity\r
43263288	40	#define CCS BIT30 //Card capacity status/1 = High capacity card\r
a3f98646	41	typedef struct {\r
	42	UINT32 Reserved0: 7; // 0 \r
	43	UINT32 V170_V195: 1; // 1.70V - 1.95V\r
	44	UINT32 V200_V260: 7; // 2.00V - 2.60V\r
	45	UINT32 V270_V360: 9; // 2.70V - 3.60V\r
	46	UINT32 RESERVED_1: 5; // Reserved\r
	47	UINT32 AccessMode: 2; // 00b (byte mode), 10b (sector mode) \r
	48	UINT32 Busy: 1; // This bit is set to LOW if the card has not finished the power up routine\r
	49	}OCR;\r
	50	\r
	51	typedef struct {\r
	52	UINT32 NOT_USED; // 1 [0:0]\r
	53	UINT32 CRC; // CRC7 checksum [7:1]\r
	54	UINT32 MDT; // Manufacturing date [19:8]\r
	55	UINT32 RESERVED_1; // Reserved [23:20]\r
	56	UINT32 PSN; // Product serial number [55:24]\r
	57	UINT8 PRV; // Product revision [63:56]\r
	58	UINT8 PNM[5]; // Product name [64:103]\r
	59	UINT16 OID; // OEM/Application ID [119:104]\r
	60	UINT8 MID; // Manufacturer ID [127:120]\r
	61	}CID;\r
	62	\r
	63	typedef struct {\r
	64	UINT8 NOT_USED: 1; // Not used, always 1 [0:0]\r
	65	UINT8 CRC: 7; // CRC [7:1]\r
8c6151f2	66	\r
a3f98646	67	UINT8 RESERVED_1: 2; // Reserved [9:8]\r
	68	UINT8 FILE_FORMAT: 2; // File format [11:10]\r
	69	UINT8 TMP_WRITE_PROTECT: 1; // Temporary write protection [12:12]\r
	70	UINT8 PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
	71	UINT8 COPY: 1; // Copy flag (OTP) [14:14]\r
	72	UINT8 FILE_FORMAT_GRP: 1; // File format group [15:15]\r
8c6151f2	73	\r
a3f98646	74	UINT16 RESERVED_2: 5; // Reserved [20:16]\r
	75	UINT16 WRITE_BL_PARTIAL: 1; // Partial blocks for write allowed [21:21]\r
	76	UINT16 WRITE_BL_LEN: 4; // Max. write data block length [25:22]\r
	77	UINT16 R2W_FACTOR: 3; // Write speed factor [28:26]\r
	78	UINT16 RESERVED_3: 2; // Reserved [30:29]\r
	79	UINT16 WP_GRP_ENABLE: 1; // Write protect group enable [31:31]\r
8c6151f2	80	\r
a3f98646	81	UINT32 WP_GRP_SIZE: 7; // Write protect group size [38:32]\r
	82	UINT32 SECTOR_SIZE: 7; // Erase sector size [45:39]\r
	83	UINT32 ERASE_BLK_EN: 1; // Erase single block enable [46:46]\r
	84	UINT32 C_SIZE_MULT: 3; // Device size multiplier [49:47]\r
	85	UINT32 VDD_W_CURR_MAX: 3; // Max. write current @ VDD max [52:50]\r
	86	UINT32 VDD_W_CURR_MIN: 3; // Max. write current @ VDD min [55:53]\r
	87	UINT32 VDD_R_CURR_MAX: 3; // Max. read current @ VDD max [58:56]\r
	88	UINT32 VDD_R_CURR_MIN: 3; // Max. read current @ VDD min [61:59]\r
8c6151f2	89	UINT32 C_SIZELow2: 2; // Device size [63:62]\r
	90	\r
	91	UINT32 C_SIZEHigh10: 10;// Device size [73:64]\r
a3f98646	92	UINT32 RESERVED_4: 2; // Reserved [75:74]\r
	93	UINT32 DSR_IMP: 1; // DSR implemented [76:76]\r
	94	UINT32 READ_BLK_MISALIGN: 1; // Read block misalignment [77:77]\r
	95	UINT32 WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
	96	UINT32 READ_BL_PARTIAL: 1; // Partial blocks for read allowed [79:79]\r
	97	UINT32 READ_BL_LEN: 4; // Max. read data block length [83:80]\r
	98	UINT32 CCC: 12;// Card command classes [95:84]\r
8c6151f2	99	\r
a3f98646	100	UINT8 TRAN_SPEED ; // Max. bus clock frequency [103:96]\r
	101	UINT8 NSAC ; // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
	102	UINT8 TAAC ; // Data read access-time 1 [119:112]\r
8c6151f2	103	\r
a3f98646	104	UINT8 RESERVED_5: 6; // Reserved [125:120]\r
	105	UINT8 CSD_STRUCTURE: 2; // CSD structure [127:126]\r
	106	}CSD;\r
	107	\r
	108	typedef struct {\r
	109	UINT8 NOT_USED: 1; // Not used, always 1 [0:0]\r
	110	UINT8 CRC: 7; // CRC [7:1]\r
	111	UINT8 RESERVED_1: 2; // Reserved [9:8]\r
	112	UINT8 FILE_FORMAT: 2; // File format [11:10]\r
	113	UINT8 TMP_WRITE_PROTECT: 1; // Temporary write protection [12:12]\r
	114	UINT8 PERM_WRITE_PROTECT: 1; // Permanent write protection [13:13]\r
	115	UINT8 COPY: 1; // Copy flag (OTP) [14:14]\r
	116	UINT8 FILE_FORMAT_GRP: 1; // File format group [15:15]\r
	117	UINT16 RESERVED_2: 5; // Reserved [20:16]\r
	118	UINT16 WRITE_BL_PARTIAL: 1; // Partial blocks for write allowed [21:21]\r
	119	UINT16 WRITE_BL_LEN: 4; // Max. write data block length [25:22]\r
	120	UINT16 R2W_FACTOR: 3; // Write speed factor [28:26]\r
	121	UINT16 RESERVED_3: 2; // Reserved [30:29]\r
	122	UINT16 WP_GRP_ENABLE: 1; // Write protect group enable [31:31]\r
	123	UINT16 WP_GRP_SIZE: 7; // Write protect group size [38:32]\r
	124	UINT16 SECTOR_SIZE: 7; // Erase sector size [45:39]\r
	125	UINT16 ERASE_BLK_EN: 1; // Erase single block enable [46:46]\r
	126	UINT16 RESERVED_4: 1; // Reserved [47:47]\r
	127	UINT32 C_SIZELow16: 16;// Device size [69:48]\r
	128	UINT32 C_SIZEHigh6: 6; // Device size [69:48]\r
	129	UINT32 RESERVED_5: 6; // Reserved [75:70]\r
	130	UINT32 DSR_IMP: 1; // DSR implemented [76:76]\r
	131	UINT32 READ_BLK_MISALIGN: 1; // Read block misalignment [77:77]\r
	132	UINT32 WRITE_BLK_MISALIGN: 1; // Write block misalignment [78:78]\r
	133	UINT32 READ_BL_PARTIAL: 1; // Partial blocks for read allowed [79:79]\r
	134	UINT16 READ_BL_LEN: 4; // Max. read data block length [83:80]\r
	135	UINT16 CCC: 12;// Card command classes [95:84]\r
	136	UINT8 TRAN_SPEED ; // Max. bus clock frequency [103:96]\r
	137	UINT8 NSAC ; // Data read access-time 2 in CLK cycles (NSAC*100) [111:104]\r
	138	UINT8 TAAC ; // Data read access-time 1 [119:112]\r
	139	UINT8 RESERVED_6: 6; // 0 [125:120]\r
	140	UINT8 CSD_STRUCTURE: 2; // CSD structure [127:126]\r
	141	}CSD_SDV2;\r
	142	\r
	143	typedef enum {
	144	UNKNOWN_CARD,
	145	MMC_CARD, //MMC card
	146	SD_CARD, //SD 1.1 card
	147	SD_CARD_2, //SD 2.0 or above standard card
	148	SD_CARD_2_HIGH //SD 2.0 or above high capacity card
	149	} CARD_TYPE;\r
	150	\r
	151	typedef enum {\r
	152	READ,\r
	153	WRITE\r
	154	} OPERATION_TYPE;\r
	155	\r
8c6151f2	156	typedef struct {\r
a3f98646	157	UINT16 RCA;\r
	158	UINTN BlockSize;\r
	159	UINTN NumBlocks;\r
	160	UINTN ClockFrequencySelect;\r
	161	CARD_TYPE CardType;\r
	162	OCR OCRData;\r
	163	CID CIDData;\r
	164	CSD CSDData;\r
	165	} CARD_INFO;\r
	166	\r
8c6151f2	167	EFI_STATUS
	168	DetectCard (
	169	VOID
	170	);\r
	171	\r
	172	extern EFI_BLOCK_IO_PROTOCOL gBlockIo;\r
	173	\r
a3f98646	174	#endif\r