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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
|
/** @file
Media Device Driver header.
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 _MEDIA_DEVICE_DRIVER_H
#define _MEDIA_DEVICE_DRIVER_H
#include <Uefi.h>
#include <Guid/EventGroup.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 <Library/PcdLib.h>
#include <PiDxe.h>
#include <Library/HobLib.h>
#include <Guid/HobList.h>
#include <Library/PciLib.h>
#include <IndustryStandard/Mmc.h>
#include <IndustryStandard/CeAta.h>
#include <IndustryStandard/SdCard.h>
//
// Driver Consumed Protocol Prototypes
//
#include <Protocol/DevicePath.h>
#include <Protocol/MmcHostIo.h>
//
// Driver Produced Protocol Prototypes
//
#include <Protocol/DriverBinding.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/BlockIo.h>
extern EFI_COMPONENT_NAME_PROTOCOL gMediaDeviceComponentName;
extern EFI_DRIVER_BINDING_PROTOCOL gMediaDeviceDriverBinding;
extern EFI_COMPONENT_NAME2_PROTOCOL gMmcMediaDeviceName2;
extern UINT32 gMediaDeviceDebugLevel;
extern EFI_GUID gEfiEmmcBootPartitionProtocolGuid;
#define CARD_DATA_SIGNATURE SIGNATURE_32 ('c', 'a', 'r', 'd')
#define CARD_PARTITION_SIGNATURE SIGNATURE_32 ('c', 'p', 'a', 'r')
#define CARD_PARTITION_DATA_FROM_THIS(a) \
CR(a, MMC_PARTITION_DATA, BlockIo, CARD_PARTITION_SIGNATURE)
#define CARD_DATA_FROM_THIS(a) \
((CARD_PARTITION_DATA_FROM_THIS(a))->CardData)
#define CARD_DATA_PARTITION_NUM(p) \
((((UINTN) p) - ((UINTN) &(p->CardData->Partitions))) / sizeof (*p))
//
// Partition Number
//
#define NO_ACCESS_TO_BOOT_PARTITION 0x00
#define BOOT_PARTITION_1 0x01
#define BOOT_PARTITION_2 0x02
#define REPLAY_PROTECTED_MEMORY_BLOCK 0x03
#define GENERAL_PURPOSE_PARTITION_1 0x04
#define GENERAL_PURPOSE_PARTITION_2 0x05
#define GENERAL_PURPOSE_PARTITION_3 0x06
#define GENERAL_PURPOSE_PARTITION_4 0x07
//
// Command timeout will be max 100 ms
//
#define TIMEOUT_COMMAND 100
#define TIMEOUT_DATA 5000
typedef enum {
UnknownCard = 0,
MMCCard, ///< MMC card
CEATACard, ///< CE-ATA device
SdMemoryCard, ///< SD 1.1 card
SdMemoryCard2, ///< SD 2.0 or above standard card
SdMemoryCard2High ///< SD 2.0 or above high capacity card
} CARD_TYPE;
typedef struct _CARD_DATA CARD_DATA;
typedef struct {
//
// BlockIO
//
UINT32 Signature;
EFI_HANDLE Handle;
BOOLEAN Present;
EFI_DEVICE_PATH_PROTOCOL *DevPath;
EFI_BLOCK_IO_PROTOCOL BlockIo;
EFI_BLOCK_IO_MEDIA BlockIoMedia;
CARD_DATA *CardData;
} MMC_PARTITION_DATA;
#define MAX_NUMBER_OF_PARTITIONS 8
struct _CARD_DATA {
//
// BlockIO
//
UINT32 Signature;
EFI_HANDLE Handle;
MMC_PARTITION_DATA Partitions[MAX_NUMBER_OF_PARTITIONS];
EFI_MMC_HOST_IO_PROTOCOL *MmcHostIo;
EFI_UNICODE_STRING_TABLE *ControllerNameTable;
CARD_TYPE CardType;
UINT8 CurrentBusWidth;
BOOLEAN DualVoltage;
BOOLEAN NeedFlush;
UINT8 Reserved[3];
UINT16 Address;
UINT32 BlockLen;
UINT32 MaxFrequency;
UINT64 BlockNumber;
//
// Common used
//
CARD_STATUS CardStatus;
OCR OCRRegister;
CID CIDRegister;
CSD CSDRegister;
EXT_CSD ExtCSDRegister;
UINT8 *RawBufferPointer;
UINT8 *AlignedBuffer;
//
// CE-ATA specific
//
TASK_FILE TaskFile;
IDENTIFY_DEVICE_DATA IndentifyDeviceData;
//
// SD specific
//
SCR SCRRegister;
SD_STATUS_REG SdSattus;
SWITCH_STATUS SwitchStatus;
};
/**
MediaDeviceDriverEntryPoint
@param[in] ImageHandle
@param[in] SystemTable
@retval EFI_STATUS
**/
EFI_STATUS
EFIAPI
MediaDeviceDriverEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
/**
MediaDeviceDriverInstallBlockIo
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
MediaDeviceDriverInstallBlockIo (
IN CARD_DATA *CardData
);
/**
MediaDeviceDriverUninstallBlockIo
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
MediaDeviceDriverUninstallBlockIo (
IN CARD_DATA *CardData
);
/**
MediaDeviceComponentNameGetDriverName
@param[in] This
@param[in] Language
@param[out] DriverName
@retval EFI_STATUS
**/
EFI_STATUS
EFIAPI
MediaDeviceComponentNameGetDriverName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN CHAR8 *Language,
OUT CHAR16 **DriverName
);
/**
MediaDeviceComponentNameGetControllerName
@param[in] This
@param[in] ControllerHandle
@param[in] ChildHandle
@param[in] Language
@param[out] ControllerName
@retval EFI_STATUS
**/
EFI_STATUS
EFIAPI
MediaDeviceComponentNameGetControllerName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle, OPTIONAL
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
);
/**
MediaDeviceDriverBindingSupported
@param[in] This
@param[in] Controller
@param[in] RemainingDevicePath
@retval EFI_STATUS
**/
EFI_STATUS
EFIAPI
MediaDeviceDriverBindingSupported (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
);
/**
MediaDeviceDriverBindingStart
@param[in] This
@param[in] Controller
@param[in] RemainingDevicePath
@retval EFI_STATUS
**/
EFI_STATUS
EFIAPI
MediaDeviceDriverBindingStart (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
);
/**
MediaDeviceDriverBindingStop
@param[in] This
@param[in] Controller
@param[in] NumberOfChildren
@param[in] ChildHandleBuffer
@retval EFI_STATUS
**/
EFI_STATUS
EFIAPI
MediaDeviceDriverBindingStop (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
);
/**
MMCSDCardInit
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
MMCSDCardInit (
IN CARD_DATA *CardData
);
/**
MMCSDBlockIoInit
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
MMCSDBlockIoInit (
IN CARD_DATA *CardData
);
/**
SendCommand
@param[in] This
@param[in] CommandIndex
@param[in] Argument
@param[in] DataType
@param[in] Buffer
@param[in] BufferSize
@param[in] ResponseType
@param[in] TimeOut
@param[out] ResponseData
@retval EFI_STATUS
**/
EFI_STATUS
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
);
/**
FastIO
@param[in] CardData
@param[in] RegisterAddress
@param[in, out] RegisterData
@param[in] Write
@retval EFI_STATUS
**/
EFI_STATUS
FastIO (
IN CARD_DATA *CardData,
IN UINT8 RegisterAddress,
IN OUT UINT8 *RegisterData,
IN BOOLEAN Write
);
/**
IsCEATADevice
@param[in] CardData
@retval EFI_STATUS
**/
BOOLEAN
IsCEATADevice (
IN CARD_DATA *CardData
);
/**
CEATABlockIoInit
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
CEATABlockIoInit (
IN CARD_DATA *CardData
);
/**
IndentifyDevice
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
IndentifyDevice (
IN CARD_DATA *CardData
);
/**
FlushCache
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
FlushCache (
IN CARD_DATA *CardData
);
/**
StandByImmediate
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
StandByImmediate (
IN CARD_DATA *CardData
);
/**
ReadDMAExt
@param[in] CardData
@param[in] LBA
@param[in] Buffer
@param[in] SectorCount
@retval EFI_STATUS
**/
EFI_STATUS
ReadDMAExt (
IN CARD_DATA *CardData,
IN EFI_LBA LBA,
IN UINT8 *Buffer,
IN UINT16 SectorCount
);
/**
WriteDMAExt
@param[in] CardData
@param[in] LBA
@param[in] Buffer
@param[in] SectorCount
@retval EFI_STATUS
**/
EFI_STATUS
WriteDMAExt (
IN CARD_DATA *CardData,
IN EFI_LBA LBA,
IN UINT8 *Buffer,
IN UINT16 SectorCount
);
/**
SoftwareReset
@param[in] CardData
@retval EFI_STATUS
**/
EFI_STATUS
SoftwareReset (
IN CARD_DATA *CardData
);
/**
SendAppCommand
@param[in] CardData
@param[in] CommandIndex
@param[in] Argument
@param[in] DataType
@param[in] Buffer
@param[in] BufferSize
@param[in] ResponseType
@param[in] TimeOut
@param[out] ResponseData
@retval EFI_STATUS
**/
EFI_STATUS
SendAppCommand (
IN CARD_DATA *CardData,
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
);
/**
MmcGetExtCsd8
@param[in] CardData
@param[in] Offset
@retval UINT32
**/
UINT32
MmcGetExtCsd8 (
IN CARD_DATA *CardData,
IN UINTN Offset
);
/**
MmcGetExtCsd24
@param[in] CardData
@param[in] Offset
@retval UINT32
**/
UINT32
MmcGetExtCsd24 (
IN CARD_DATA *CardData,
IN UINTN Offset
);
/**
MmcGetExtCsd32
@param[in] CardData
@param[in] Offset
@retval UINT32
**/
UINT32
MmcGetExtCsd32 (
IN CARD_DATA *CardData,
IN UINTN Offset
);
/**
MmcGetCurrentPartitionNum
@param[in] CardData
@retval UINTN
**/
UINTN
MmcGetCurrentPartitionNum (
IN CARD_DATA *CardData
);
/**
SetEmmcWpOnEvent
@param[in] Event
@param[in] Context
@retval None
**/
VOID
EFIAPI
SetEmmcWpOnEvent(
IN EFI_EVENT Event,
IN VOID *Context
);
/**
MmcSelectPartitionNum
@param[in] CardData
@param[in] Partition
@retval EFI_STATUS
**/
EFI_STATUS
MmcSelectPartitionNum (
IN CARD_DATA *CardData,
IN UINT8 Partition
);
/**
MmcSelectPartition
@param[in] Partition
@retval EFI_STATUS
**/
EFI_STATUS
MmcSelectPartition (
IN MMC_PARTITION_DATA *Partition
);
/**
MmcSetPartition
@param[in] CardData
@param[in] Value
@retval EFI_STATUS
**/
EFI_STATUS
MmcSetPartition (
IN CARD_DATA *CardData,
IN UINT8 Value
);
#endif
|
