summaryrefslogtreecommitdiff
path: root/EmbeddedPkg/Universal/MmcDxe/Mmc.c
blob: 9c67867aa309686cd1f892e4c63d432ad7b3fb82 (plain)
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
/** @file
  Main file of the MMC Dxe driver. The driver entrypoint is defined into this file.

  Copyright (c) 2011, ARM Limited. All rights reserved.
  
  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.             

**/

#include <Protocol/DevicePath.h>
#include <Protocol/MmcHost.h>

#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DevicePathLib.h>
#include <Library/DebugLib.h>

#include "Mmc.h"

EFI_BLOCK_IO_MEDIA mMmcMediaTemplate = {
  SIGNATURE_32('m','m','c','o'),            // MediaId
  TRUE,                                     // RemovableMedia
  FALSE,                                    // MediaPresent
  FALSE,                                    // LogicalPartition
  FALSE,                                    // ReadOnly
  FALSE,                                    // WriteCaching
  512,                                      // BlockSize
  4,                                        // IoAlign
  0,                                        // Pad
  0                                         // LastBlock
};

//
// This device structure is serviced as a header.
// Its next field points to the first root bridge device node.
//
LIST_ENTRY  mMmcHostPool;

/**
  Initialize the MMC Host Pool to support multiple MMC devices
**/
VOID
InitializeMmcHostPool (
  VOID
  )
{
    InitializeListHead (&mMmcHostPool);
}

/**
  Insert a new Mmc Host controller to the pool
**/
VOID
InsertMmcHost (
  IN MMC_HOST_INSTANCE      *MmcHostInstance
  )
{
    InsertTailList (&mMmcHostPool, &(MmcHostInstance->Link));
}

/*
  Remove a new Mmc Host controller to the pool
*/
VOID
RemoveMmcHost (
  IN MMC_HOST_INSTANCE      *MmcHostInstance
  )
{
    RemoveEntryList (&(MmcHostInstance->Link));
}

MMC_HOST_INSTANCE* CreateMmcHostInstance(
  IN EFI_MMC_HOST_PROTOCOL* MmcHost
  )
{
    EFI_STATUS          Status;
    MMC_HOST_INSTANCE*  MmcHostInstance;
    EFI_DEVICE_PATH_PROTOCOL    *NewDevicePathNode;
    EFI_DEVICE_PATH_PROTOCOL    *DevicePath;

    MmcHostInstance = AllocateZeroPool (sizeof (MMC_HOST_INSTANCE));
    if (MmcHostInstance == NULL) {
        return NULL;
    }

    MmcHostInstance->Signature = MMC_HOST_INSTANCE_SIGNATURE;

    MmcHostInstance->State = MmcHwInitializationState;
    
    MmcHostInstance->BlockIo.Media = AllocateCopyPool (sizeof(EFI_BLOCK_IO_MEDIA), &mMmcMediaTemplate);
    if (MmcHostInstance->BlockIo.Media == NULL) {
        goto FREE_INSTANCE;
    }

    MmcHostInstance->BlockIo.Revision = EFI_BLOCK_IO_INTERFACE_REVISION;
    MmcHostInstance->BlockIo.Reset = MmcReset;
    MmcHostInstance->BlockIo.ReadBlocks = MmcReadBlocks;
    MmcHostInstance->BlockIo.WriteBlocks = MmcWriteBlocks;
    MmcHostInstance->BlockIo.FlushBlocks = MmcFlushBlocks;

    MmcHostInstance->MmcHost = MmcHost;

    // Create DevicePath for the new MMC Host
    Status = MmcHost->BuildDevicePath(&NewDevicePathNode);
    if (EFI_ERROR (Status)) {
        goto FREE_MEDIA;
    }

    DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) AllocatePool (END_DEVICE_PATH_LENGTH);
    if (DevicePath == NULL) {
        goto FREE_MEDIA;
    }
    
    SetDevicePathEndNode (DevicePath);
    MmcHostInstance->DevicePath = AppendDevicePathNode (DevicePath, NewDevicePathNode);

    // Publish BlockIO protocol interface
    Status = gBS->InstallMultipleProtocolInterfaces (
                  &MmcHostInstance->MmcHandle,
                  &gEfiBlockIoProtocolGuid,&(MmcHostInstance->BlockIo),
                  &gEfiDevicePathProtocolGuid,MmcHostInstance->DevicePath,
                  NULL
                  );
    if (EFI_ERROR(Status)) {
        goto FREE_DEVICE_PATH;
    }

    return MmcHostInstance;

FREE_DEVICE_PATH:
    FreePool(DevicePath);

FREE_MEDIA:
    FreePool(MmcHostInstance->BlockIo.Media);

FREE_INSTANCE:
    FreePool(MmcHostInstance);

    return NULL;
}

EFI_STATUS DestroyMmcHostInstance(
  IN MMC_HOST_INSTANCE* MmcHostInstance
  )
{
    EFI_STATUS Status;

    // Uninstall Protocol Interfaces
    Status = gBS->UninstallMultipleProtocolInterfaces(
        MmcHostInstance->MmcHandle,
            &gEfiBlockIoProtocolGuid,&(MmcHostInstance->BlockIo),
        &gEfiDevicePathProtocolGuid,MmcHostInstance->DevicePath,
            NULL
            );
    ASSERT_EFI_ERROR (Status);
    
    // Free Memory allocated for the instance
    if (MmcHostInstance->BlockIo.Media) {
        FreePool(MmcHostInstance->BlockIo.Media);
    }
    FreePool (MmcHostInstance);

    return Status;
}

/**
  This function checks if the controller implement the Mmc Host and the Device Path Protocols
**/
EFI_STATUS
EFIAPI
MmcDriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,
  IN EFI_HANDLE                     Controller,
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath
  )
{
    EFI_STATUS                      Status;
    //EFI_DEVICE_PATH_PROTOCOL        *ParentDevicePath;
    EFI_MMC_HOST_PROTOCOL           *MmcHost;
    EFI_DEV_PATH_PTR                Node;

    //
    // Check RemainingDevicePath validation
    //
    if (RemainingDevicePath != NULL) {
        //
        // Check if RemainingDevicePath is the End of Device Path Node, 
        // if yes, go on checking other conditions
        //
        if (!IsDevicePathEnd (RemainingDevicePath)) {
            //
            // If RemainingDevicePath isn't the End of Device Path Node,
            // check its validation
            //
            Node.DevPath = RemainingDevicePath;
            if (Node.DevPath->Type != HARDWARE_DEVICE_PATH ||
              Node.DevPath->SubType != HW_VENDOR_DP      ||
              DevicePathNodeLength(Node.DevPath) != sizeof(VENDOR_DEVICE_PATH)) {
                return EFI_UNSUPPORTED;
            }
        }
    }

    //
    // Check if Mmc Host protocol is installed by platform
    //
    Status = gBS->OpenProtocol (
                  Controller,
                  &gEfiMmcHostProtocolGuid,
                  (VOID **) &MmcHost,
                  This->DriverBindingHandle,
                  Controller,
                  EFI_OPEN_PROTOCOL_BY_DRIVER
                  );
    if (Status == EFI_ALREADY_STARTED) {
        return EFI_SUCCESS;
    }
    if (EFI_ERROR (Status)) {
        return Status;
    }

    //
    // Close the Mmc Host used to perform the supported test
    //
    gBS->CloseProtocol (
        Controller,
        &gEfiMmcHostProtocolGuid,
        This->DriverBindingHandle,
        Controller
        );

    return EFI_SUCCESS;
}

/**
  
**/
EFI_STATUS
EFIAPI
MmcDriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  )
{
    EFI_STATUS              Status;
    MMC_HOST_INSTANCE       *MmcHostInstance;
    EFI_MMC_HOST_PROTOCOL   *MmcHost;

    //
    // Check RemainingDevicePath validation
    //
    if (RemainingDevicePath != NULL) {
        //
        // Check if RemainingDevicePath is the End of Device Path Node, 
        // if yes, return EFI_SUCCESS
        //
        if (IsDevicePathEnd (RemainingDevicePath)) {
            return EFI_SUCCESS;
        }
    }

    //
    // Get the Mmc Host protocol
    //
    Status = gBS->OpenProtocol (
                  Controller,
                  &gEfiMmcHostProtocolGuid,
                  (VOID **) &MmcHost,
                  This->DriverBindingHandle,
                  Controller,
                  EFI_OPEN_PROTOCOL_BY_DRIVER
                  );
    if (EFI_ERROR (Status)) {
        if (Status == EFI_ALREADY_STARTED) {
            return EFI_SUCCESS;
        }
        return Status;
    }

    MmcHostInstance = CreateMmcHostInstance(MmcHost);
    if (MmcHostInstance != NULL) {
        // Add the handle to the pool
        InsertMmcHost (MmcHostInstance);
    }

    return EFI_SUCCESS;
}

/**
  
**/
EFI_STATUS
EFIAPI
MmcDriverBindingStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL   *This,
  IN  EFI_HANDLE                    Controller,
  IN  UINTN                         NumberOfChildren,
  IN  EFI_HANDLE                    *ChildHandleBuffer
  )
{
    EFI_STATUS          Status = EFI_SUCCESS;
    LIST_ENTRY          *CurrentLink;
    MMC_HOST_INSTANCE   *MmcHostInstance;

    MMC_TRACE("MmcDriverBindingStop()");

    // For each MMC instance
    CurrentLink = mMmcHostPool.ForwardLink;
    while (CurrentLink != NULL && CurrentLink != &mMmcHostPool && (Status == EFI_SUCCESS)) {
        MmcHostInstance = MMC_HOST_INSTANCE_FROM_LINK(CurrentLink);
        ASSERT(MmcHostInstance != NULL);

        // Close gEfiMmcHostProtocolGuid
        Status = gBS->CloseProtocol (
                    Controller,
                    &gEfiMmcHostProtocolGuid,(VOID **) &MmcHostInstance->MmcHost,
                    This->DriverBindingHandle
                    );

        // Remove MMC Host Instance from the pool
        RemoveMmcHost (MmcHostInstance);

        // Destroy MmcHostInstance
        DestroyMmcHostInstance (MmcHostInstance);
    }

    return Status;
}

EFI_DRIVER_BINDING_PROTOCOL gMmcDriverBinding = {
  MmcDriverBindingSupported,
  MmcDriverBindingStart,
  MmcDriverBindingStop,
  0xa,
  NULL,
  NULL
};

/**
  
**/
EFI_STATUS
EFIAPI
MmcDxeInitialize (
  IN EFI_HANDLE         ImageHandle,
  IN EFI_SYSTEM_TABLE   *SystemTable
  )
{
    EFI_STATUS  Status;

    //
    // Initializes MMC Host pool
    //
    InitializeMmcHostPool ();

    //
    // Install driver model protocol(s).
    //
    Status = EfiLibInstallDriverBindingComponentName2 (
             ImageHandle,
             SystemTable,
             &gMmcDriverBinding,
             ImageHandle,
             &gMmcComponentName,
             &gMmcComponentName2
             );
    ASSERT_EFI_ERROR (Status);

    // Install driver diagnostics
    Status = gBS->InstallMultipleProtocolInterfaces (
                  &ImageHandle, 
                  &gEfiDriverDiagnostics2ProtocolGuid,&gMmcDriverDiagnostics2,
                  NULL
                  );
    ASSERT_EFI_ERROR (Status);

    return Status;
}