summaryrefslogtreecommitdiff
path: root/Platform/96Boards/96BoardsI2cDxe/96BoardsI2cDxe.c
blob: 79bb9ed5ffeedc2a10896e79ce61f7717bc5acbc (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
/** @file

  Copyright (c) 2018, Linaro, Ltd. 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 <PiDxe.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Protocol/I2cBusConfigurationManagement.h>
#include <Protocol/I2cEnumerate.h>
#include <Protocol/I2cMaster.h>
#include <Protocol/Mezzanine.h>

STATIC MEZZANINE_PROTOCOL     *mMezzanine;

typedef struct {
  EFI_I2C_ENUMERATE_PROTOCOL                    I2cEnumerate;
  EFI_I2C_BUS_CONFIGURATION_MANAGEMENT_PROTOCOL I2cConfigManagement;
  EFI_HANDLE                                    I2cMasterHandle;
  UINT32                                        BusFrequency;
  UINTN                                         NumDevices;
  CONST EFI_I2C_DEVICE                          *Devices;
} I2C_BUS;

STATIC
EFI_STATUS
EFIAPI
I2cEnumerate (
  IN CONST EFI_I2C_ENUMERATE_PROTOCOL *This,
  IN OUT CONST EFI_I2C_DEVICE         **Device
  )
{
  I2C_BUS     *Bus;

  if (Device == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  Bus = BASE_CR (This, I2C_BUS, I2cEnumerate);

  if (Bus->NumDevices == 0 ||
      (Bus->NumDevices > 0 && *Device == &Bus->Devices[Bus->NumDevices - 1])) {
    *Device = NULL;
  } else if (*Device == NULL) {
    *Device = &Bus->Devices[0];
  } else if (Bus->NumDevices > 1 &&
             *Device >= &Bus->Devices[0] &&
             *Device < &Bus->Devices[Bus->NumDevices - 1]) {
    ++*Device;
  } else {
    return EFI_NO_MAPPING;
  }
  return EFI_SUCCESS;
}

STATIC
EFI_STATUS
EFIAPI
I2cGetBusFrequency (
  IN CONST EFI_I2C_ENUMERATE_PROTOCOL *This,
  IN UINTN                            I2cBusConfiguration,
  OUT UINTN                           *BusClockHertz
  )
{
  I2C_BUS     *Bus;

  if (BusClockHertz == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  if (I2cBusConfiguration > 0) {
    return EFI_NO_MAPPING;
  }

  Bus = BASE_CR (This, I2C_BUS, I2cEnumerate);

  *BusClockHertz = Bus->BusFrequency;

  return EFI_SUCCESS;
}

STATIC
EFI_STATUS
EFIAPI
EnableI2cBusConfiguration (
  IN CONST EFI_I2C_BUS_CONFIGURATION_MANAGEMENT_PROTOCOL  *This,
  IN UINTN                                                I2cBusConfiguration,
  IN EFI_EVENT                                            Event       OPTIONAL,
  IN EFI_STATUS                                           *I2cStatus  OPTIONAL
  )
{
  EFI_I2C_MASTER_PROTOCOL *I2cMaster;
  EFI_STATUS              Status;
  UINTN                   BusClockHertz;
  I2C_BUS                 *Bus;

  if (I2cBusConfiguration > 0) {
    return EFI_NO_MAPPING;
  }

  Bus = BASE_CR (This, I2C_BUS, I2cConfigManagement);

  Status = gBS->HandleProtocol (Bus->I2cMasterHandle,
                  &gEfiI2cMasterProtocolGuid, (VOID **)&I2cMaster);
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_ERROR, "%a: gBS->HandleProtocol() failed - %r\n",
      __FUNCTION__, Status));
    return Status;
  }

  BusClockHertz = Bus->BusFrequency;
  Status = I2cMaster->SetBusFrequency (I2cMaster, &BusClockHertz);
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_ERROR, "%a: I2cMaster->SetBusFrequency() failed - %r\n",
      __FUNCTION__, Status));
    return Status;
  }

  if (Event != NULL) {
    *I2cStatus = EFI_SUCCESS;
    gBS->SignalEvent (Event);
  }
  return EFI_SUCCESS;
}

STATIC I2C_BUS mI2cBus0 = {
  { I2cEnumerate, I2cGetBusFrequency },
  { EnableI2cBusConfiguration },
  NULL,
  FixedPcdGet32 (PcdI2c0BusFrequencyHz),
  0,
  NULL,
};

STATIC I2C_BUS mI2cBus1 = {
  { I2cEnumerate, I2cGetBusFrequency },
  { EnableI2cBusConfiguration },
  NULL,
  FixedPcdGet32 (PcdI2c1BusFrequencyHz),
  0,
  NULL,
};

STATIC
VOID
RegisterI2cBus (
  IN  EFI_GUID                *Guid,
  IN  I2C_BUS                 *I2cBus,
  IN  UINTN                   NumDevices,
  IN  CONST EFI_I2C_DEVICE    *Devices
  )
{
  EFI_STATUS    Status;
  UINTN         BufferSize;

  BufferSize = sizeof (EFI_HANDLE);
  Status = gBS->LocateHandle (ByProtocol, Guid, NULL, &BufferSize,
                  &I2cBus->I2cMasterHandle);
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_INFO, "%a: gBS->LocateHandle() failed - %r\n", __FUNCTION__,
      Status));
    return;
  }

  I2cBus->NumDevices = NumDevices;
  I2cBus->Devices = Devices;

  Status = gBS->InstallMultipleProtocolInterfaces (&I2cBus->I2cMasterHandle,
                  &gEfiI2cEnumerateProtocolGuid,
                  &I2cBus->I2cEnumerate,
                  &gEfiI2cBusConfigurationManagementProtocolGuid,
                  &I2cBus->I2cConfigManagement,
                  NULL);
  ASSERT_EFI_ERROR (Status);
}

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

  Status = gBS->LocateProtocol (&g96BoardsMezzanineProtocolGuid, NULL,
                  (VOID **)&mMezzanine);
  ASSERT_EFI_ERROR (Status);

  RegisterI2cBus (&g96BoardsI2c0MasterGuid, &mI2cBus0,
    mMezzanine->I2c0NumDevices, mMezzanine->I2c0DeviceArray);
  RegisterI2cBus (&g96BoardsI2c1MasterGuid, &mI2cBus1,
    mMezzanine->I2c1NumDevices, mMezzanine->I2c1DeviceArray);

  return EFI_SUCCESS;
}