]> git.proxmox.com Git - mirror_edk2.git/blame - ArmPlatformPkg/Drivers/PL180MciDxe/PL180Mci.h
ArmPlatformPkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / ArmPlatformPkg / Drivers / PL180MciDxe / PL180Mci.h
CommitLineData
633724f4 1/** @file\r
2 Header for the MMC Host Protocol implementation for the ARM PrimeCell PL180.\r
3\r
93b429fc 4 Copyright (c) 2011-2012, ARM Limited. All rights reserved.\r
3402aac7 5\r
f4dfad05 6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
633724f4 7\r
8**/\r
9\r
10#ifndef __PL180_MCI_H\r
11#define __PL180_MCI_H\r
12\r
13#include <Uefi.h>\r
14\r
15#include <Protocol/MmcHost.h>\r
16\r
17#include <Library/UefiLib.h>\r
18#include <Library/DebugLib.h>\r
19#include <Library/UefiBootServicesTableLib.h>\r
20#include <Library/IoLib.h>\r
21#include <Library/TimerLib.h>\r
22#include <Library/PcdLib.h>\r
23\r
93b429fc 24#define PL180_MCI_DXE_VERSION 0x10\r
25\r
26#define MCI_SYSCTL FixedPcdGet32 (PcdPL180MciBaseAddress)\r
27\r
28#define MCI_POWER_CONTROL_REG (MCI_SYSCTL + 0x000)\r
29#define MCI_CLOCK_CONTROL_REG (MCI_SYSCTL + 0x004)\r
30#define MCI_ARGUMENT_REG (MCI_SYSCTL + 0x008)\r
31#define MCI_COMMAND_REG (MCI_SYSCTL + 0x00C)\r
32#define MCI_RESPCMD_REG (MCI_SYSCTL + 0x010)\r
33#define MCI_RESPONSE3_REG (MCI_SYSCTL + 0x014)\r
34#define MCI_RESPONSE2_REG (MCI_SYSCTL + 0x018)\r
35#define MCI_RESPONSE1_REG (MCI_SYSCTL + 0x01C)\r
36#define MCI_RESPONSE0_REG (MCI_SYSCTL + 0x020)\r
37#define MCI_DATA_TIMER_REG (MCI_SYSCTL + 0x024)\r
38#define MCI_DATA_LENGTH_REG (MCI_SYSCTL + 0x028)\r
39#define MCI_DATA_CTL_REG (MCI_SYSCTL + 0x02C)\r
40#define MCI_DATA_COUNTER (MCI_SYSCTL + 0x030)\r
41#define MCI_STATUS_REG (MCI_SYSCTL + 0x034)\r
42#define MCI_CLEAR_STATUS_REG (MCI_SYSCTL + 0x038)\r
43#define MCI_INT0_MASK_REG (MCI_SYSCTL + 0x03C)\r
44#define MCI_INT1_MASK_REG (MCI_SYSCTL + 0x040)\r
45#define MCI_SELECT_REG (MCI_SYSCTL + 0x044)\r
46#define MCI_FIFOCOUNT_REG (MCI_SYSCTL + 0x048)\r
47#define MCI_FIFO_REG (MCI_SYSCTL + 0x080)\r
300fc77a
AB
48#define MCI_PERIPH_ID_REG0 (MCI_SYSCTL + 0xFE0)\r
49#define MCI_PERIPH_ID_REG1 (MCI_SYSCTL + 0xFE4)\r
50#define MCI_PERIPH_ID_REG2 (MCI_SYSCTL + 0xFE8)\r
51#define MCI_PERIPH_ID_REG3 (MCI_SYSCTL + 0xFEC)\r
52#define MCI_PCELL_ID_REG0 (MCI_SYSCTL + 0xFF0)\r
53#define MCI_PCELL_ID_REG1 (MCI_SYSCTL + 0xFF4)\r
54#define MCI_PCELL_ID_REG2 (MCI_SYSCTL + 0xFF8)\r
55#define MCI_PCELL_ID_REG3 (MCI_SYSCTL + 0xFFC)\r
56\r
57#define MCI_PERIPH_ID0 0x80\r
58#define MCI_PERIPH_ID1 0x11\r
59#define MCI_PERIPH_ID2 0x04\r
60#define MCI_PERIPH_ID3 0x00\r
61#define MCI_PCELL_ID0 0x0D\r
62#define MCI_PCELL_ID1 0xF0\r
63#define MCI_PCELL_ID2 0x05\r
64#define MCI_PCELL_ID3 0xB1\r
93b429fc 65\r
66#define MCI_POWER_OFF 0\r
67#define MCI_POWER_UP BIT1\r
68#define MCI_POWER_ON (BIT1 | BIT0)\r
69#define MCI_POWER_OPENDRAIN BIT6\r
70#define MCI_POWER_ROD BIT7\r
71\r
72#define MCI_CLOCK_ENABLE BIT8\r
73#define MCI_CLOCK_POWERSAVE BIT9\r
74#define MCI_CLOCK_BYPASS BIT10\r
75#define MCI_CLOCK_WIDEBUS BIT11\r
76\r
77#define MCI_STATUS_CMD_CMDCRCFAIL BIT0\r
78#define MCI_STATUS_CMD_DATACRCFAIL BIT1\r
79#define MCI_STATUS_CMD_CMDTIMEOUT BIT2\r
80#define MCI_STATUS_CMD_DATATIMEOUT BIT3\r
81#define MCI_STATUS_CMD_TX_UNDERRUN BIT4\r
82#define MCI_STATUS_CMD_RXOVERRUN BIT5\r
83#define MCI_STATUS_CMD_RESPEND BIT6\r
84#define MCI_STATUS_CMD_SENT BIT7\r
85#define MCI_STATUS_CMD_DATAEND BIT8\r
86#define MCI_STATUS_CMD_START_BIT_ERROR BIT9\r
87#define MCI_STATUS_CMD_DATABLOCKEND BIT10\r
88#define MCI_STATUS_CMD_ACTIVE BIT11\r
89#define MCI_STATUS_CMD_TXACTIVE BIT12\r
90#define MCI_STATUS_CMD_RXACTIVE BIT13\r
91#define MCI_STATUS_CMD_TXFIFOHALFEMPTY BIT14\r
92#define MCI_STATUS_CMD_RXFIFOHALFFULL BIT15\r
93#define MCI_STATUS_CMD_TXFIFOFULL BIT16\r
94#define MCI_STATUS_CMD_RXFIFOFULL BIT17\r
95#define MCI_STATUS_CMD_TXFIFOEMPTY BIT18\r
96#define MCI_STATUS_CMD_RXFIFOEMPTY BIT19\r
97#define MCI_STATUS_CMD_TXDATAAVAILBL BIT20\r
98#define MCI_STATUS_CMD_RXDATAAVAILBL BIT21\r
99\r
100#define MCI_STATUS_TXDONE (MCI_STATUS_CMD_DATAEND | MCI_STATUS_CMD_DATABLOCKEND)\r
101#define MCI_STATUS_RXDONE (MCI_STATUS_CMD_DATAEND | MCI_STATUS_CMD_DATABLOCKEND)\r
102#define MCI_STATUS_READ_ERROR ( MCI_STATUS_CMD_DATACRCFAIL \\r
103 | MCI_STATUS_CMD_DATATIMEOUT \\r
104 | MCI_STATUS_CMD_RXOVERRUN \\r
105 | MCI_STATUS_CMD_START_BIT_ERROR )\r
106#define MCI_STATUS_WRITE_ERROR ( MCI_STATUS_CMD_DATACRCFAIL \\r
107 | MCI_STATUS_CMD_DATATIMEOUT \\r
108 | MCI_STATUS_CMD_TX_UNDERRUN )\r
109#define MCI_STATUS_CMD_ERROR ( MCI_STATUS_CMD_CMDCRCFAIL \\r
110 | MCI_STATUS_CMD_CMDTIMEOUT \\r
111 | MCI_STATUS_CMD_START_BIT_ERROR )\r
112\r
113#define MCI_CLR_CMD_STATUS ( MCI_STATUS_CMD_RESPEND \\r
114 | MCI_STATUS_CMD_SENT \\r
115 | MCI_STATUS_CMD_ERROR )\r
116\r
117#define MCI_CLR_READ_STATUS ( MCI_STATUS_RXDONE \\r
118 | MCI_STATUS_READ_ERROR )\r
119\r
120#define MCI_CLR_WRITE_STATUS ( MCI_STATUS_TXDONE \\r
121 | MCI_STATUS_WRITE_ERROR )\r
122\r
123#define MCI_CLR_ALL_STATUS (BIT11 - 1)\r
124\r
125#define MCI_DATACTL_DISABLE_MASK 0xFE\r
126#define MCI_DATACTL_ENABLE BIT0\r
633724f4 127#define MCI_DATACTL_CONT_TO_CARD 0\r
93b429fc 128#define MCI_DATACTL_CARD_TO_CONT BIT1\r
633724f4 129#define MCI_DATACTL_BLOCK_TRANS 0\r
93b429fc 130#define MCI_DATACTL_STREAM_TRANS BIT2\r
131#define MCI_DATACTL_DMA_DISABLED 0\r
132#define MCI_DATACTL_DMA_ENABLE BIT3\r
633724f4 133\r
134#define INDX_MASK 0x3F\r
135\r
93b429fc 136#define MCI_CPSM_WAIT_RESPONSE BIT6\r
137#define MCI_CPSM_LONG_RESPONSE BIT7\r
138#define MCI_CPSM_LONG_INTERRUPT BIT8\r
139#define MCI_CPSM_LONG_PENDING BIT9\r
140#define MCI_CPSM_ENABLE BIT10\r
633724f4 141\r
93b429fc 142#define MCI_TRACE(txt) DEBUG ((EFI_D_BLKIO, "ARM_MCI: " txt "\n"))\r
633724f4 143\r
144EFI_STATUS\r
145EFIAPI\r
146MciGetDriverName (\r
147 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
148 IN CHAR8 *Language,\r
149 OUT CHAR16 **DriverName\r
150 );\r
151\r
152EFI_STATUS\r
153EFIAPI\r
154MciGetControllerName (\r
155 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
156 IN EFI_HANDLE ControllerHandle,\r
157 IN EFI_HANDLE ChildHandle OPTIONAL,\r
158 IN CHAR8 *Language,\r
159 OUT CHAR16 **ControllerName\r
160 );\r
161\r
162#endif\r