1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
|
/** @file
Header file for MMC driver.
Copyright (c) 1999 - 2016, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _MMC_HOST_DRIVER_H
#define _MMC_HOST_DRIVER_H
#include <Uefi.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiLib.h>
#include <Library/DevicePathLib.h>
#include <Library/IoLib.h>
#include <IndustryStandard/Pci.h>
#include <IndustryStandard/SdCard.h>
#include <ScAccess.h>
//
// Driver Consumed Protocol Prototypes
//
#include <Protocol/DevicePath.h>
#include <Protocol/PciIo.h>
//
// Driver Produced Protocol Prototypes
//
#include <Protocol/DriverBinding.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/MmcHostIo.h>
extern EFI_COMPONENT_NAME_PROTOCOL gMmcHostComponentName;
extern EFI_DRIVER_BINDING_PROTOCOL gMmcHostDriverBinding;
#define MMCHOST_DATA_SIGNATURE SIGNATURE_32 ('m', 'c', 'h', 's')
#define MMCHOST_DATA_FROM_THIS(a) \
CR (a, MMCHOST_DATA, MmcHostIo, MMCHOST_DATA_SIGNATURE)
#define BLOCK_SIZE 0x200
#define TIME_OUT_1S 1000
#define INTEL_VENDOR_ID 0x8086
#define BUFFER_CTL_REGISTER 0x84
#pragma pack(1)
//
// PCI Class Code structure
//
typedef struct {
UINT8 PI;
UINT8 SubClassCode;
UINT8 BaseCode;
} PCI_CLASSC;
#pragma pack()
//
// MMCHOST_DATA structure
//
typedef struct {
UINTN Signature;
EFI_MMC_HOST_IO_PROTOCOL MmcHostIo;
EFI_PCI_IO_PROTOCOL *PciIo;
UINT16 PciVid;
UINT16 PciDid;
BOOLEAN IsAutoStopCmd;
BOOLEAN IsEmmc;
BOOLEAN EnableVerboseDebug;
UINT32 BaseClockInMHz;
UINT32 CurrentClockInKHz;
UINT32 BlockLength;
EFI_UNICODE_STRING_TABLE *ControllerNameTable;
UINT32 ControllerVersion;
} MMCHOST_DATA;
//
// Prototypes
// Driver model protocol interface
//
/**
Entry point for MMC Host EFI drivers.
@param[in] ImageHandle EFI_HANDLE
@param[in] SystemTable EFI_SYSTEM_TABLE
@retval EFI_SUCCESS The function completed successfully
@retval EFI_DEVICE_ERROR The function failed to complete
**/
EFI_STATUS
EFIAPI
MmcHostDriverEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
/**
Test to see if this MMC Host driver supports ControllerHandle.
Any ControllerHandle that has installed will be supported.
@param[in] This Protocol instance pointer
@param[in] Controller Handle of device to test
@param[in] RemainingDevicePath Not used
@retval EFI_SUCCESS This driver supports this device
@retval EFI_UNSUPPORTED This driver does not support this device
**/
EFI_STATUS
EFIAPI
MmcHostDriverBindingSupported (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
);
/**
Starting the MMC Host Driver
@param[in] This Protocol instance pointer
@param[in] Controller Handle of device to start
@param[in] RemainingDevicePath Not used
@retval EFI_SUCCESS This driver start this device
@retval EFI_UNSUPPORTED This driver does not support this device
@retval EFI_DEVICE_ERROR This driver cannot be started due to device Error
@retval EFI_OUT_OF_RESOURCES This driver cannot allocate resources
**/
EFI_STATUS
EFIAPI
MmcHostDriverBindingStart (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
);
/**
Stop MMC Host driver on ControllerHandle. Support stopping any child handles
created by this driver.
@param[in] This Protocol instance pointer
@param[in] Controller Handle of device to stop driver on
@param[in] NumberOfChildren Number of Children in the ChildHandleBuffer
@param[in] ChildHandleBuffer List of handles for the children we need to stop
@retval EFI_SUCCESS This driver stop this device
@retval EFI_DEVICE_ERROR This driver cannot be stop due to device Error
**/
EFI_STATUS
EFIAPI
MmcHostDriverBindingStop (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
);
//
// EFI Component Name Functions
//
/**
Retrieves a Unicode string that is the user readable name of the EFI Driver.
@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param[in] Language A pointer to a three character ISO 639-2 language identifier.
This is the language of the driver name that that the caller
is requesting, and it must match one of the languages specified
in SupportedLanguages. The number of languages supported by a
driver is up to the driver writer.
@param[out] DriverName A pointer to the Unicode string to return. This Unicode string
is the name of the driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by This
and the language specified by Language was returned
in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
language specified by Language.
**/
EFI_STATUS
EFIAPI
MmcHostComponentNameGetDriverName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN CHAR8 *Language,
OUT CHAR16 **DriverName
);
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by an EFI Driver.
@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param[in] ControllerHandle The handle of a controller that the driver specified by
This is managing. This handle specifies the controller
whose name is to be returned.
@param[in] ChildHandle The handle of the child controller to retrieve the name
of. This is an optional parameter that may be NULL. It
will be NULL for device drivers. It will also be NULL
for a bus drivers that wish to retrieve the name of the
bus controller. It will not be NULL for a bus driver
that wishes to retrieve the name of a child controller.
@param[in] Language A pointer to a three character ISO 639-2 language
identifier. This is the language of the controller name
that that the caller is requesting, and it must match one
of the languages specified in SupportedLanguages. The
number of languages supported by a driver is up to the
driver writer.
@param[out] ControllerName A pointer to the Unicode string to return. This Unicode
string is the name of the controller specified by
ControllerHandle and ChildHandle in the language
specified by Language from the point of view of the
driver specified by This.
@retval EFI_SUCCESS The Unicode string for the user readable name in the
language specified by Language for the driver
specified by This was returned in DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
language specified by Language.
**/
EFI_STATUS
EFIAPI
MmcHostComponentNameGetControllerName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle, OPTIONAL
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
);
/**
The main function used to send the command to the card inserted into the MMC host
slot.
It will assemble the arguments to set the command register and wait for the command
and transfer completed until timeout. Then it will read the response register to fill
the ResponseData
@param[in] This Pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
@param[in] CommandIndex The command index to set the command index field of command register
@param[in] Argument Command argument to set the argument field of command register
@param[in] DataType TRANSFER_TYPE, indicates no data, data in or data out
@param[in] Buffer Contains the data read from / write to the device
@param[in] BufferSize The size of the buffer
@param[in] ResponseType RESPONSE_TYPE
@param[in] TimeOut Time out value in 1 ms unit
@param[out] ResponseData Depending on the ResponseType, such as CSD or card status
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
@retval EFI_OUT_OF_RESOURCES
@retval EFI_TIMEOUT
@retval EFI_DEVICE_ERROR
**/
EFI_STATUS
EFIAPI
SendCommand (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT16 CommandIndex,
IN UINT32 Argument,
IN TRANSFER_TYPE DataType,
IN UINT8 *Buffer, OPTIONAL
IN UINT32 BufferSize,
IN RESPONSE_TYPE ResponseType,
IN UINT32 TimeOut,
OUT UINT32 *ResponseData OPTIONAL
);
/**
Set max clock frequency of the host, the actual frequency
may not be the same as MaxFrequencyInKHz. It depends on
the max frequency the host can support, divider, and host
speed mode.
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] MaxFrequency Max frequency in HZ
@retval EFI_SUCCESS
@retval EFI_TIMEOUT
**/
EFI_STATUS
EFIAPI
SetClockFrequency (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT32 MaxFrequencyInKHz
);
/**
Set bus width of the host
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] BusWidth Bus width in 1, 4, 8 bits
@retval EFI_STATUS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
SetBusWidth (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT32 BusWidth
);
/**
Set voltage which could supported by the host.
Support 0(Power off the host), 1.8V, 3.0V, 3.3V
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] Voltage Units in 0.1 V
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
SetHostVoltage (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT32 Voltage
);
/**
Set Host mode in DDR
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] DdrMode True for DDR Mode set, false returns EFI_SUCCESS
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
SetHostDdrMode (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT32 DdrMode
);
/**
Set Host SDR Mode
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] DdrMode True for SDR Mode set, false for normal mode
@retval EFI_SUCCESS The function completed successfully
@retval EFI_INVALID_PARAMETER A parameter was incorrect.
**/
EFI_STATUS
EFIAPI
SetHostSdrMode (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT32 SdrMode
);
/**
Set Host High Speed
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] HighSpeed True for High Speed Mode set, false for normal mode
@retval EFI_SUCCESS The function completed successfully
@retval EFI_INVALID_PARAMETER A parameter was incorrect.
**/
EFI_STATUS
EFIAPI
SetHostSpeedMode (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT32 HighSpeed
);
/**
Reset the host
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] ResetAll TRUE to reset all
@retval EFI_SUCCESS The function completed successfully
@retval EFI_TIMEOUT The timeout time expired.
**/
EFI_STATUS
EFIAPI
ResetMmcHost (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN RESET_TYPE ResetType
);
/**
Reset the host
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] ResetAll TRUE to reset all
@retval EFI_SUCCESS The function completed successfully
@retval EFI_TIMEOUT The timeout time expired.
**/
EFI_STATUS
EFIAPI
EnableAutoStopCmd (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN BOOLEAN Enable
);
/**
Find whether these is a card inserted into the slot. If so
init the host. If not, return EFI_NOT_FOUND.
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@retval EFI_SUCCESS Success
@retval EFI_DEVICE_ERROR Fail
**/
EFI_STATUS
EFIAPI
DetectCardAndInitHost (
IN EFI_MMC_HOST_IO_PROTOCOL *This
);
/**
Set the Block length
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] BlockLength card supports block length
@retval EFI_SUCCESS Success
@retval EFI_DEVICE_ERROR Fail
**/
EFI_STATUS
EFIAPI
SetBlockLength (
IN EFI_MMC_HOST_IO_PROTOCOL *This,
IN UINT32 BlockLength
);
/**
Setup Device
@param[in] This Pointer to EFI_MMC_HOST_IO_PROTOCOL
@retval EFI_SUCCESS Success
@retval EFI_DEVICE_ERROR Fail
**/
EFI_STATUS
EFIAPI
SetupDevice(
IN EFI_MMC_HOST_IO_PROTOCOL *This
);
/**
Read MMC host register
@param[in] MmcHost Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] Offset Offset of the eMMC
@retval Data Data read from eMMC
**/
UINT8
MmcHostRead8 (
IN MMCHOST_DATA *MmcHost,
IN UINTN Offset
);
/**
Read MMC host register
@param[in] MmcHost Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] Offset Offset of the eMMC
@retval Data Data read from eMMC
**/
UINT16
MmcHostRead16 (
IN MMCHOST_DATA *MmcHost,
IN UINTN Offset
);
/**
Read MMC host register
@param[in] MmcHost Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] Offset Offset of the eMMC
@retval Data Data read from eMMC
**/
UINT32
MmcHostRead32 (
IN MMCHOST_DATA *MmcHost,
IN UINTN Offset
);
/**
Write MMC host register
@param[in] MmcHost Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] Offset Offset of the eMMC
@param[in] Data Data write to eMMC
@retval Data Written to MmcHost
**/
UINT8
MmcHostWrite8 (
IN MMCHOST_DATA *MmcHost,
IN UINTN Offset,
IN UINT8 Data
);
/**
Write MMC host register
@param[in] MmcHost Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] Offset Offset of the eMMC
@param[in] Data Data write to eMMC
@retval Data Data written to eMMC
**/
UINT16
MmcHostWrite16 (
IN MMCHOST_DATA *MmcHost,
IN UINTN Offset,
IN UINT16 Data
);
/**
Write MMC host register
@param[in] MmcHost Pointer to EFI_MMC_HOST_IO_PROTOCOL
@param[in] Offset Offset of the eMMC
@param[in] Data Data write to eMMC
@retval Data Data written to eMMC
**/
UINT32
MmcHostWrite32 (
IN MMCHOST_DATA *MmcHost,
IN UINTN Offset,
IN UINT32 Data
);
#endif
|
