summaryrefslogtreecommitdiff
path: root/Silicon/BroxtonSoC/BroxtonSiPkg/SouthCluster/Sdio/Dxe/MMC/MmcMediaDeviceDxe/ComponentName.c
blob: a0b09402a0431a6f4c567470834287c162aebd1e (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
/** @file
  Header file for ComponentName.

  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.

**/

#include <MediaDeviceDriver.h>

//
// EFI Component Name Protocol
//
EFI_COMPONENT_NAME_PROTOCOL     gMediaDeviceComponentName = {
  MediaDeviceComponentNameGetDriverName,
  MediaDeviceComponentNameGetControllerName,
  "eng"
};


static EFI_UNICODE_STRING_TABLE mMediaDeviceDriverNameTable[] = {
  { "eng", L"UEFI MMC/SD Media Device Driver" },
  { NULL , NULL }
};


/**
  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
MediaDeviceComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL     *This,
  IN  CHAR8                           *Language,
  OUT CHAR16                          **DriverName
  )
{
  return LookupUnicodeString (
           Language,
           gMediaDeviceComponentName.SupportedLanguages,
           mMediaDeviceDriverNameTable,
           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
MediaDeviceComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL     *This,
  IN  EFI_HANDLE                      ControllerHandle,
  IN  EFI_HANDLE                      ChildHandle, OPTIONAL
  IN  CHAR8                           *Language,
  OUT CHAR16                          **ControllerName
  )
{
  EFI_STATUS               Status;
  EFI_BLOCK_IO_PROTOCOL    *BlockIo;
  CARD_DATA                *CardData;

  //
  // This is a device driver, so ChildHandle must be NULL.
  //
  if (ChildHandle != NULL) {
    return EFI_UNSUPPORTED;
  }

  //
  // Get the device context
  //
  Status = gBS->OpenProtocol (
                  ControllerHandle,
                  &gEfiBlockIoProtocolGuid,
                  (VOID **) &BlockIo,
                  gMediaDeviceDriverBinding.DriverBindingHandle,
                  ControllerHandle,
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL
                  );

  if (EFI_ERROR (Status)) {
    return Status;
  }

  CardData  = CARD_DATA_FROM_THIS (BlockIo);
  return LookupUnicodeString (
           Language,
           gMediaDeviceComponentName.SupportedLanguages,
           CardData->ControllerNameTable,
           ControllerName
           );
}