hc
2024-03-26 e0728245c89800c2038c23308f2d88969d5b41c8
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
/** @file
 
  Copyright (c) 2020, Hisilicon Limited. All rights reserved.<BR>
 
  SPDX-License-Identifier: BSD-2-Clause-Patent
 
**/
 
#include <Uefi.h>
#include <PiDxe.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/I2CLib.h>
#include <Library/RtcHelperLib.h>
#include <Library/TimeBaseLib.h>
#include <Library/TimerLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiRuntimeLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Protocol/RealTimeClock.h>
#include "RX8900RealTimeClock.h"
 
extern I2C_DEVICE gRtcDevice;
 
STATIC BOOLEAN       mRX8900Initialized = FALSE;
STATIC CONST CHAR16  mTimeZoneVariableName[] = L"RX8900RtcTimeZone";
STATIC CONST CHAR16  mDaylightVariableName[] = L"RX8900RtcDaylight";
 
EFI_STATUS
InitializeRX8900 (
  VOID
  )
{
  EFI_STATUS    Status;
  unsigned char writeTemp;
 
  Status = SwitchRtcI2cChannelAndLock ();
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
 
  Status = I2CInit (gRtcDevice.Socket, gRtcDevice.Port, Normal);
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
 
  writeTemp = RX8900_VDETOFF_SWOFF;
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_BACKUP_FUN, 1, &writeTemp);
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
  writeTemp = TEMPERATURE_COMPENSATION_2S;
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_CONTRLREG, 1, &writeTemp);
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
  writeTemp = OUTPUT_FREQUENCY_32768;
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_EXTENSIONREG, 1, &writeTemp);
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
 
  writeTemp = FLAG_REG_DEFAULT;
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_FLAGREG, 1, &writeTemp);
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
  writeTemp = RX8900_RAM_REG_DEFAULT;
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_RAM, 1, &writeTemp);
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
 
  mRX8900Initialized = TRUE;
 
  EXIT:
 
  ReleaseOwnershipOfRtc ();
  return Status;
}
 
STATIC
INT16
GetTimeZone (
  VOID
  )
{
  EFI_STATUS  Status;
  INT16       TimeZone;
  UINTN       Size;
 
  TimeZone = EFI_UNSPECIFIED_TIMEZONE;
  Size = sizeof (TimeZone);
  Status = EfiGetVariable (
             (CHAR16 *)mTimeZoneVariableName,
             &gEfiCallerIdGuid,
             NULL,
             &Size,
             (VOID *)&TimeZone
             );
 
  if (EFI_ERROR (Status)) {
    TimeZone = EFI_UNSPECIFIED_TIMEZONE;
    // The time zone variable does not exist in non-volatile storage, so create it.
    Status = EfiSetVariable (
               (CHAR16 *)mTimeZoneVariableName,
               &gEfiCallerIdGuid,
               EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
               Size,
               (VOID *)&TimeZone
               );
 
    if (EFI_ERROR (Status)) {
        DEBUG ((DEBUG_INFO, "Failed to save %s variable, Status = %r\n",
          mTimeZoneVariableName, Status));
    }
  } else {
    // Check TimeZone bounds:   -1440 to 1440 or 2047
    if ((TimeZone < -EFI_TIMEOFFSET_TIMEZONE) || (TimeZone > EFI_TIMEOFFSET_TIMEZONE)) {
      TimeZone = EFI_UNSPECIFIED_TIMEZONE;
    }
  }
 
  return TimeZone;
}
 
STATIC
UINT8
GetDayLight (
  VOID
  )
{
  EFI_STATUS  Status;
  UINT8       DayLight;
  UINTN       Size;
 
  DayLight = 0;
  // Get the current daylight information from non-volatile storage
  Size = sizeof (DayLight);
  Status = EfiGetVariable (
             (CHAR16 *)mDaylightVariableName,
             &gEfiCallerIdGuid,
             NULL,
             &Size,
             (VOID *)&DayLight
             );
 
  if (EFI_ERROR (Status)) {
    DayLight = 0;
    // The daylight variable does not exist in non-volatile storage, so create it.
    Status = EfiSetVariable (
               (CHAR16 *)mDaylightVariableName,
               &gEfiCallerIdGuid,
               EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
               Size,
               (VOID *)&DayLight
               );
    if (EFI_ERROR (Status)) {
      DEBUG ((DEBUG_INFO, "Failed to save %s variable, Status = %r\n",
          mDaylightVariableName, Status));
    }
  }
 
  return DayLight;
}
 
EFI_STATUS
EFIAPI
LibGetTime (
  OUT EFI_TIME                *Time,
  OUT EFI_TIME_CAPABILITIES   *Capabilities
  )
{
  EFI_STATUS  Status;
  UINT8       Temp[7] = {0};
  UINT16      BaseYear = 2000;
  UINTN       EpochSeconds;
  UINT8       TryCount = 0;
 
  // Ensure Time is a valid pointer
  if (Time == NULL) {
    return EFI_INVALID_PARAMETER;
  }
 
  // Initialize the hardware if not already done
  if (!mRX8900Initialized) {
    Status = InitializeRX8900 ();
    if (EFI_ERROR (Status)) {
      return EFI_NOT_READY;
    }
  }
 
  Status = SwitchRtcI2cChannelAndLock ();
  if (EFI_ERROR (Status)) {
    ReleaseOwnershipOfRtc ();
    return Status;
  }
 
  do {
    Status = I2CRead (&gRtcDevice, RX8900_REGADDR_SECONDS, 7, Temp);
    if (EFI_ERROR (Status)) {
      Status = EFI_DEVICE_ERROR;
      goto Err;
    }
 
    Time->Second = BcdToDecimal8 (Temp[0]);
    Time->Minute = BcdToDecimal8 (Temp[1]);
    Time->Hour = BcdToDecimal8 (Temp[2]);
    Time->Day = BcdToDecimal8 (Temp[4]);
    Time->Month = BcdToDecimal8 (Temp[5]);
    Time->Year = BaseYear + BcdToDecimal8 (Temp[6]);
    Time->Nanosecond = 0;
 
    EpochSeconds = EfiTimeToEpoch (Time);
 
    Time->TimeZone = GetTimeZone ();
    // Adjust for the correct time zone
    if (Time->TimeZone != EFI_UNSPECIFIED_TIMEZONE) {
      EpochSeconds += Time->TimeZone * SEC_PER_MIN;
    }
 
    Time->Daylight = GetDayLight ();
    // Adjust for the correct period
    if ((Time->Daylight & EFI_TIME_IN_DAYLIGHT) == EFI_TIME_IN_DAYLIGHT) {
      // Convert to adjusted time, i.e. spring forwards one hour
      EpochSeconds += SEC_PER_HOUR;
    }
 
    // Convert from internal 32-bit time to UEFI time
    EpochToEfiTime (EpochSeconds, Time);
    if ((!IsTimeValid (Time)) || ((Time->Year - BaseYear) > 99) || (Time->Year < 2000)) {
      DEBUG ((DEBUG_INFO, "LibGetTime: %d-%d-%d %d-%d-%d EpochSeconds:%llx is invalid time!\n",
        Time->Second, Time->Minute, Time->Hour, Time->Day, Time->Month,
        Time->Year, EpochSeconds));
      Status = EFI_DEVICE_ERROR;
    }
 
Err:
    TryCount++;
  } while ((TryCount < 3) && (EFI_ERROR (Status)));
 
  ReleaseOwnershipOfRtc ();
  return Status;
}
 
STATIC
EFI_STATUS
SetTimeToRX8900 (
  IN  EFI_TIME                *Time
  )
{
  EFI_STATUS   Status;
  UINT8        Temp;
 
  (VOID)MicroSecondDelay (RTC_DELAY_1000_MICROSECOND);
  Temp = DecimalToBcd8 (Time->Second);
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_SECONDS, 1, &Temp);
  if(EFI_ERROR (Status)) {
    Status = EFI_DEVICE_ERROR;
    return Status;
  }
 
  Temp = DecimalToBcd8 (Time->Minute);
  (VOID)MicroSecondDelay (RTC_DELAY_1000_MICROSECOND);
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_MIUTES, 1, &Temp);
  if(EFI_ERROR (Status)) {
    Status = EFI_DEVICE_ERROR;
    return Status;
  }
 
  Temp = DecimalToBcd8 (Time->Hour);
  (VOID)MicroSecondDelay (RTC_DELAY_1000_MICROSECOND);
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_HOURS, 1, &Temp);
  if(EFI_ERROR (Status)) {
    Status = EFI_DEVICE_ERROR;
    return Status;
  }
 
  Temp = DecimalToBcd8 (Time->Day);
  (VOID)MicroSecondDelay (RTC_DELAY_1000_MICROSECOND);
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_DATE, 1, &Temp);
  if(EFI_ERROR (Status)) {
    Status = EFI_DEVICE_ERROR;
    return Status;
  }
 
  Temp = DecimalToBcd8 (Time->Month);
  (VOID)MicroSecondDelay (RTC_DELAY_1000_MICROSECOND);
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_MONTH, 1, &Temp);
  if(EFI_ERROR (Status)) {
    Status = EFI_DEVICE_ERROR;
    return Status;
  }
 
  Time->Year= Time->Year % 100;
  Temp = Time->Year;
  Temp = DecimalToBcd8 (Temp);
  (VOID)MicroSecondDelay (RTC_DELAY_1000_MICROSECOND);
  Status = I2CWrite (&gRtcDevice, RX8900_REGADDR_YEAR, 1, &Temp);
  if(EFI_ERROR (Status)) {
    Status =  EFI_DEVICE_ERROR;
    return Status;
  }
 
  return Status;
}
 
EFI_STATUS
EFIAPI
LibSetTime (
  IN  EFI_TIME                *Time
  )
{
  EFI_STATUS  Status;
  UINTN EpochSeconds;
 
  // Initialize the hardware if not already done
  if (!mRX8900Initialized) {
    Status = InitializeRX8900 ();
    if (EFI_ERROR (Status)) {
      goto EXIT;
    }
  }
 
  Status = SwitchRtcI2cChannelAndLock ();
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
 
  if(!IsTimeValid(Time)){
    return EFI_INVALID_PARAMETER;
  }
 
  EpochSeconds = EfiTimeToEpoch (Time);
 
  // Adjust for the correct time zone, i.e. convert to UTC time zone
  if (Time->TimeZone != EFI_UNSPECIFIED_TIMEZONE) {
    EpochSeconds -= Time->TimeZone * SEC_PER_MIN;
  }
 
  // Adjust for the correct period
  if ((Time->Daylight & EFI_TIME_IN_DAYLIGHT) == EFI_TIME_IN_DAYLIGHT) {
    // Convert to un-adjusted time, i.e. fall back one hour
    EpochSeconds -= SEC_PER_HOUR;
  }
 
  EpochToEfiTime (EpochSeconds, Time);
  Status = SetTimeToRX8900 (Time);
  if (EFI_ERROR (Status)) {
    goto EXIT;
  }
 
  // Save the current time zone information into non-volatile storage
  Status = EfiSetVariable (
             (CHAR16 *)mTimeZoneVariableName,
             &gEfiCallerIdGuid,
             EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
             sizeof (Time->TimeZone),
             (VOID *)&(Time->TimeZone)
             );
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_INFO, "LibSetTime: Failed to save %s variable, Status = %r\n",
      mTimeZoneVariableName, Status));
    goto EXIT;
  }
 
  // Save the current daylight information into non-volatile storage
  Status = EfiSetVariable (
             (CHAR16 *)mDaylightVariableName,
             &gEfiCallerIdGuid,
             EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
             sizeof(Time->Daylight),
             (VOID *)&(Time->Daylight)
             );
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_INFO, "LibSetTime: Failed to save %s variable, Status = %r\n",
      mDaylightVariableName, Status));
    goto EXIT;
  }
 
  EXIT:
  ReleaseOwnershipOfRtc ();
  return Status;
}
 
EFI_STATUS
EFIAPI
LibGetWakeupTime (
  OUT BOOLEAN     *Enabled,
  OUT BOOLEAN     *Pending,
  OUT EFI_TIME    *Time
  )
{
  // Not a required feature
  return EFI_UNSUPPORTED;
}
 
EFI_STATUS
EFIAPI
LibSetWakeupTime (
  IN BOOLEAN      Enabled,
  OUT EFI_TIME    *Time
  )
{
  // Not a required feature
  return EFI_UNSUPPORTED;
}
 
 
EFI_STATUS
EFIAPI
LibRtcInitialize (
  IN EFI_HANDLE                            ImageHandle,
  IN EFI_SYSTEM_TABLE                      *SystemTable
  )
{
  EFI_STATUS    Status;
  EFI_HANDLE    Handle;
  EFI_TIME      EfiTime;
 
  // Setup the setters and getters
  gRT->GetTime = LibGetTime;
  gRT->SetTime = LibSetTime;
  gRT->GetWakeupTime = LibGetWakeupTime;
  gRT->SetWakeupTime = LibSetWakeupTime;
 
  Status = gRT->GetTime (&EfiTime, NULL);
  if (EFI_ERROR (Status) || (EfiTime.Year < 2000) || (EfiTime.Year > 2099) ||
      (!IsTimeValid (&EfiTime))) {
       EfiTime.Year = 2000;
       EfiTime.Month = 1;
       EfiTime.Day = 1;
       EfiTime.Hour = 0;
       EfiTime.Minute = 0;
       EfiTime.Second = 0;
       EfiTime.Nanosecond = 0;
       EfiTime.Daylight = 0;
       EfiTime.TimeZone = EFI_UNSPECIFIED_TIMEZONE;
 
      Status = gRT->SetTime (&EfiTime);
      if (EFI_ERROR (Status)) {
        DEBUG ((DEBUG_ERROR, "SetTime Status : %r\n", Status));
      }
  }
 
  Handle = NULL;
  Status = gBS->InstallMultipleProtocolInterfaces (
                  &Handle,
                  &gEfiRealTimeClockArchProtocolGuid,
                  NULL,
                  NULL
                 );
 
  return Status;
}
 
 
VOID
EFIAPI
LibRtcVirtualNotifyEvent (
  IN EFI_EVENT        Event,
  IN VOID             *Context
  )
{
  return;
}