From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=104.47.34.78; helo=nam01-by2-obe.outbound.protection.outlook.com; envelope-from=meenakshi.aggarwal@nxp.com; receiver=edk2-devel@lists.01.org Received: from NAM01-BY2-obe.outbound.protection.outlook.com (mail-by2nam01on0078.outbound.protection.outlook.com [104.47.34.78]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 0A66321B00DD4 for ; Sun, 26 Nov 2017 20:59:54 -0800 (PST) Received: from BN6PR03CA0081.namprd03.prod.outlook.com (10.164.122.147) by MWHPR03MB2701.namprd03.prod.outlook.com (10.168.207.135) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.260.4; Mon, 27 Nov 2017 05:04:15 +0000 Received: from BN1AFFO11FD005.protection.gbl (2a01:111:f400:7c10::114) by BN6PR03CA0081.outlook.office365.com (2603:10b6:405:6f::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.260.4 via Frontend Transport; Mon, 27 Nov 2017 05:04:15 +0000 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; nxp.com; dkim=none (message not signed) header.d=none;nxp.com; dmarc=fail action=none header.from=nxp.com; Received-SPF: Fail (protection.outlook.com: domain of nxp.com does not designate 192.88.168.50 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.168.50; helo=tx30smr01.am.freescale.net; Received: from tx30smr01.am.freescale.net (192.88.168.50) by BN1AFFO11FD005.mail.protection.outlook.com (10.58.52.65) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.218.12 via Frontend Transport; Mon, 27 Nov 2017 05:04:14 +0000 Received: from uefi-OptiPlex-790.ap.freescale.net (uefi-OptiPlex-790.ap.freescale.net [10.232.132.78]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id vAR53iMY000785; Sun, 26 Nov 2017 22:04:11 -0700 From: Meenakshi Aggarwal To: , , , Date: Mon, 27 Nov 2017 16:21:54 +0530 Message-ID: <1511779917-9255-7-git-send-email-meenakshi.aggarwal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1511779917-9255-1-git-send-email-meenakshi.aggarwal@nxp.com> References: <1511779917-9255-1-git-send-email-meenakshi.aggarwal@nxp.com> X-EOPAttributedMessage: 0 X-Matching-Connectors: 131562326547580419; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.168.50; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(336005)(346002)(376002)(39860400002)(39380400002)(2980300002)(1109001)(1110001)(339900001)(199003)(189002)(48376002)(50466002)(2201001)(6666003)(33646002)(16586007)(110136005)(575784001)(54906003)(86362001)(8936002)(51416003)(50226002)(6306002)(16799955002)(105606002)(5660300001)(85426001)(2950100002)(106466001)(2906002)(97736004)(316002)(50986999)(4326008)(76176999)(81166006)(498600001)(68736007)(81156014)(189998001)(8676002)(47776003)(36756003)(53936002)(53376002)(104016004)(8656006)(305945005)(356003)(77096006)(15188155005)(966005)(19627235001); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR03MB2701; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1AFFO11FD005; 1:V0gStrSliISgt9Mmk1PsSCX+pNLniDqsZNjISObxJhLSxr1/+H2DH/Gb4xTqpCFg+AVsFdHw0CyRkjxvrVNU+UvhjOXo0OkDcmwDIYAAJm7GG06gIF0cpklhp0Zi/833 MIME-Version: 1.0 X-MS-Office365-Filtering-Correlation-Id: 236c307c-2ade-4aae-21e0-08d535544e21 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(5600026)(4604075)(4534020)(4628075)(201703131517081)(2017052603258); SRVR:MWHPR03MB2701; X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2701; 3:iJiHOB3gvNZdXoysiy/pgKourl3l05sAK+SL8ZTeU/0ORDPOX/2tjZJ9ydV+0ThV2LdOt1YYb7yP/NawAbY3X7KiBvAy61YUDX5s8X5gubjjLwmQn6hOMzhLX8bSPUaNAjuABvqA0TcSZph9Xos0WIRaOl7HPGpLLU87DBBnlQ63tZXVAaCV/0dpaddEXrOtHSMcicgXLih6PuJvZ27KGuWp41S89Pk68vzCpJaCY1udDhZwU9DfzH4hUamRzxw4xI9HoOPlS1BczzhVdLMXFD9vHoXbFDZSOljN9GlDjlpj/s5HFHhD0PfMvtuvQeArbRi0Z8uQPwBscHjia/GeVzL+kaIz4rkhQyJsUfGfLoA=; 25:xdd8ZYh+TnZf1Xgq0WK/NqBvWx+bOTAK0ZH4jdF074sT6wd54k0XGu3Y3CREEARIhugDlH3at7AP9n1kLA79a+9qQC9wjCfSOC2/AYfkoGvg70J+vR473xB9ck/lNtaylIR2j2hTeVrc+YiB659WDe/M5HUUaJjDBJ7J8goReYhm1ECR1lXr9OZo6LOrvBKU6lMtnHSyizX/gV7sb5PVyLw4Vz/2fGVATVN8tlmyOj5nrjxOGtGvhdwh+DDdU41rI5v2+xissP5ltnc2myBIpMOVwwC7XN0cItFNvU9Z3vBx0QWtprJuhZIxw64c8gojozJ24Rgx4u4lbAZcNcuMeQ== X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: MWHPR03MB2701: X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2701; 31:V5Dt6QZ7n3o2LD04Mrt17Vu2Jh5JKVqxOpKFpdH+udxML8YL9wDl/TsltfXXV+yPkIK/ym/vIcEVjJ8CYLNOUJuN4EaPGuOQL+BwE43klLA5h94tD1Tabftw+L6ZlHz+nvQHiUCIk0eJ7+OBBt9TtJnYEH+ajV9AXZv/dNE9Oh0S1nKX8622MKUw3t5SkRhu3ebD+CB508NPpevJvHTFCngLo9qU8pPBu3wdtDgLHFo=; 4:a3Fe+TtF13NhfZcOObKoexbm1aJMX/pkHt4jtMskLQhx4jmaz2FLpfJxcu+fYB92XRB6kwxIjICVwDo/bkHA3hotmmTCUMw+b/vOPA5s0lgloyEiQpRKG4XhbTPu8n5ihqyPCHm5DYNXptDQLtYBKmHFZG6FSDZnFtO7/WLorjidQ6GlYo4MLKQVVFBs+N3xX0pEmsvOU39/XQ+CpXMjmavEpVPa5IjO18upj5VXCEjbbQj5UQksPlmF3ZqCU4NwIZiQ65lH4GtnVJLGDzvzapRBgpupZg+4J4nwx/GkeRt4a/q+wjBtUAEvCkkTpExW9nIJTWqRFeYoprpF/uUkbkEFv1VnUkeujvVsrhm6XeU= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(21532816269658); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095135)(2401047)(8121501046)(5005006)(3002001)(3231022)(10201501046)(93006095)(93001095)(6055026)(6096035)(20161123563025)(20161123559100)(20161123556025)(201703131430075)(201703131433075)(201703131448075)(201703161259150)(201703151042153)(20161123561025)(20161123565025)(201708071742011); SRVR:MWHPR03MB2701; BCL:0; PCL:0; RULEID:(100000803101)(100110400095)(400006); SRVR:MWHPR03MB2701; X-Forefront-PRVS: 0504F29D72 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; MWHPR03MB2701; 23:GFAfmwk2QOdbN9aVDGsegekfAQHkISWjFE5Y/DHjn?= =?us-ascii?Q?yaqKknc5hjGwJ9yNjZKz+zdVOIxVk9gDop9UrIjg2IR7ZyxAth4swUCicmun?= =?us-ascii?Q?K3y+CQephwR5U0RSmYK3keX/Z3ysAX5RPKbXQJB/pFKJPigOyKm0W2Adp0sv?= =?us-ascii?Q?hsSORGRWukX4vzjGWs5wUNDkLP5roSDD9ETbwRwXfAiezB6apF/VpnbdMB2c?= =?us-ascii?Q?bM/YK+KvckZJvtxGHXCKhJgTW/qcE9S3zcyRvzVRvAkhywt3DLXe/b6aQ1S6?= =?us-ascii?Q?sNyWWIRqFCPfCppt4aEaeBChq4dNZEaSSXALUimJAdJReWUqzW641GNYNZde?= =?us-ascii?Q?gWHPLrbalb7FF73pX5omesz8o09Ryd9UQ8VWr0+34UI59smsdD1AY0rpRz6l?= =?us-ascii?Q?4El6loO4vDSNYC7SaD5YZaKT8o6MG8jxayj5og4CrmqP2SWl5cP/ZOkX1GIc?= =?us-ascii?Q?X/x3aUtJdKTtBs1kwjo3KJ59S/n5tErf9FGNPX6ZzTsisv5v0RRhDXCmzhQE?= =?us-ascii?Q?f1fKgiWXRzH0oPhNnEmg3z3Jjgr5yTM7Ntf0okBQE9FEr5LEOnZF0v2N6Tjt?= =?us-ascii?Q?0f4004HJDMEXz5io79towK3arDLzJzGhmNGCfK8WSBsSNflWz8kPF/vqdmHO?= =?us-ascii?Q?7CZIdys+Oh1EYJpd9rx9W2nonhxGZb4KMv8tu2fGrnZHIHT5RMjNpjhESORL?= =?us-ascii?Q?J3vhGFmjqJAzOHvK9OaOIdT+0iLboVELqzO4JIbUFn5Ejc2FwhPJ5sQIoA0i?= =?us-ascii?Q?iG3IELJh5F/DlX8lvWoSr7O2K0n7is5JVOnPRcraQEwrd1ZwoCLuv9t1bc3d?= =?us-ascii?Q?QvUeF2SQKLJKv3fCn2JV8aT1v9MpUAdiIKCwPNQs1CuV3MwVhbrOfJ4XSifw?= =?us-ascii?Q?7CiAXwvI/nvWLX+yX3G8fPf1v0vgImDlQHVF3ev78lUCUYpX89cGQWJdg3fh?= =?us-ascii?Q?5KHW+ymZZlXD/S9+mhn0edQ2BDnnC6CqoJ7iRviHrlCjEJgVy92tdV2eE8ze?= =?us-ascii?Q?QXayYmOrHD/m/lOdGP7Prn+OxCivH9lI8PD+xnJqZn8bGxW2jz3XPMCpKkRZ?= =?us-ascii?Q?Tizf7Z8IfmixBoAOBRRTg1W3JICQtH4+9riEm6aCCzF1dsvZCw7kPSpmLPKm?= =?us-ascii?Q?KOsv9uVjJ4CJKUMvaNa1rNU54faJdFUljiLsoWznHwXrwCFMOQgWEdFwcSu4?= =?us-ascii?Q?IMq4ICy1gZFeiXKuIVNBEfiGiIWFAAUICm4M9yqrrgxIT7HAp6VGGBP4P+nK?= =?us-ascii?Q?AJDtHWazy3OsPQAwwzDX6hC0ad1RbIgPbYjK44QQdHuTfhLw0PXE/7j/5yW4?= =?us-ascii?Q?3CNQsJ+TmAYNuBBx8HYnCk=3D?= X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2701; 6:QW/jvKBjzlr4P9E9wV1cCTjzw+TQy/HnDz1z6K5e0Q91MOZVL2oLnQ1/g3nZoT17qWk7S5/GCCDvogGUtQH+jsTqV1/6s0nZZ0ZBaq7jw9RC7PgwP6eYVJUAPT2bw4/21fdGKGhD3P4N3WJHmpuHEyr0EC1ZCtoHH1Y0uXPTzZZlPMgmVD1839Hp9uzk2sqRS1ELx5x8F3bDXRkbB+B4uOkWQhpqH4kkT4fUu/tGtB9xqCDgnJG5TywI3vgvegS/sYwq4toazG5niTnMX4Kqo4mfooghAAS0hYj4VjWo5N0NBljtbdjWa6L1RgK8Qdry4I4Aej970n6zA/jqJGiJ/U5HTDVYCaTmuakl8bWGOiA=; 5:Rj4uh8G4uvMwQ9Uz8T6Ll6elEA6mSPxiyhT5vMTyAXjgEF5mdrJt30wjShBWLAFVUFJcemBzbb8Eg42o4w4L/E7YO2AnY6rxoE4TFK9GiORxWu/Qtw/miHU6x3mfZVlayLnB2B920crEZRR961ruFe+2bCkuEswEJ9qWqen/cxw=; 24:WePQm47O1K5De4UhmbuNwk5Rpc85cIEYeADg4JGCo5IQHcgAt7mUwA6QccCSYximkmRZEWphfZGDXZ5qoyxrugwSvlmumnDRKajOFiDG8Mg=; 7:jD5xc3jLwg0oZ8eHhH+gSmKAcrmg57oGQBICp/1/N/m/gYYIXEh+kFHoc4p4c7e5iUPEZsPWrj8QaHIP2g+f8WchM/EYbcgQgmza9aWhnqBuo5WVu2K8DKN0y8ZONwFY5kmrui5A+y4M4JwbDf7KvJPhgXIkZqSTrZLqcEoQwAnWlrvU8Z1GMdxFIAdLpUjdfxcKREPIGTpel/ZtXRSfQ/q16lSjmtNWCzllZSiY4d7tg05Uj362Na6JfmfH9Abw SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 Nov 2017 05:04:14.4304 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 236c307c-2ade-4aae-21e0-08d535544e21 X-MS-Exchange-CrossTenant-Id: 5afe0b00-7697-4969-b663-5eab37d5f47e X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5afe0b00-7697-4969-b663-5eab37d5f47e; Ip=[192.88.168.50]; Helo=[tx30smr01.am.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR03MB2701 Subject: [PATCH edk2-platforms] [PATCH v3 6/9] Silicon/Maxim : Add support for DS1307 RTC library X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 27 Nov 2017 04:59:55 -0000 Content-Type: text/plain Real time clock Apis on top of I2C Apis Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Meenakshi Aggarwal --- Silicon/Maxim/Library/Ds1307RtcLib/Ds1307Rtc.h | 59 ++++ Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c | 327 +++++++++++++++++++++ .../Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.dec | 26 ++ .../Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.inf | 45 +++ 4 files changed, 457 insertions(+) create mode 100644 Silicon/Maxim/Library/Ds1307RtcLib/Ds1307Rtc.h create mode 100644 Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c create mode 100644 Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.dec create mode 100644 Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.inf diff --git a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307Rtc.h b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307Rtc.h new file mode 100644 index 0000000..636be88 --- /dev/null +++ b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307Rtc.h @@ -0,0 +1,59 @@ +/** Ds1307Rtc.h +* +* Copyright 2017 NXP +* +* 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 __DS1307RTC_H__ +#define __DS1307RTC_H__ + +/* + * RTC time register + */ +#define DS1307_SEC_REG_ADDR 0x00 +#define DS1307_MIN_REG_ADDR 0x01 +#define DS1307_HR_REG_ADDR 0x02 +#define DS1307_DAY_REG_ADDR 0x03 +#define DS1307_DATE_REG_ADDR 0x04 +#define DS1307_MON_REG_ADDR 0x05 +#define DS1307_YR_REG_ADDR 0x06 + +#define DS1307_SEC_BIT_CH 0x80 /* Clock Halt (in Register 0) */ + +/* + * RTC control register + */ +#define DS1307_CTL_REG_ADDR 0x07 + +#define START_YEAR 1970 +#define END_YEAR 2070 + +/* + * TIME MASKS + */ +#define MASK_SEC 0x7F +#define MASK_MIN 0x7F +#define MASK_HOUR 0x3F +#define MASK_DAY 0x3F +#define MASK_MONTH 0x1F + +/* + * I2C FLAGS + */ +#define I2C_REG_ADDRESS 0x2 + +typedef struct { + UINTN OperationCount; + EFI_I2C_OPERATION SetAddressOp; + EFI_I2C_OPERATION GetSetDateTimeOp; +} RTC_I2C_REQUEST; + +#endif // __DS1307RTC_H__ diff --git a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c new file mode 100644 index 0000000..b09c0bf --- /dev/null +++ b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c @@ -0,0 +1,327 @@ +/** Ds1307RtcLib.c + Implement EFI RealTimeClock via RTC Lib for DS1307 RTC. + + Based on RTC implementation available in + EmbeddedPkg/Library/TemplateRealTimeClockLib/RealTimeClockLib.c + + Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
+ Copyright 2017 NXP + + 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 +#include +#include +#include +#include +#include +#include +#include + +#include "Ds1307Rtc.h" + +STATIC VOID *mDriverEventRegistration; +STATIC EFI_I2C_MASTER_PROTOCOL *mI2cMaster; + +/** + Read RTC register. + + @param RtcRegAddr Register offset of RTC to be read. + + @retval Register Value read + +**/ + +STATIC +UINT8 +RtcRead ( + IN UINT8 RtcRegAddr + ) +{ + RTC_I2C_REQUEST Req; + EFI_STATUS Status; + UINT8 Val; + + Val = 0; + + Req.OperationCount = 2; + + Req.SetAddressOp.Flags = 0; + Req.SetAddressOp.LengthInBytes = sizeof (RtcRegAddr); + Req.SetAddressOp.Buffer = &RtcRegAddr; + + Req.GetSetDateTimeOp.Flags = I2C_FLAG_READ; + Req.GetSetDateTimeOp.LengthInBytes = sizeof (Val); + Req.GetSetDateTimeOp.Buffer = &Val; + + Status = mI2cMaster->StartRequest (mI2cMaster, FixedPcdGet8 (PcdI2cSlaveAddress), + (VOID *)&Req, + NULL, NULL); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "RTC read error at Addr:0x%x\n", RtcRegAddr)); + } + + return Val; +} + +/** + Write RTC register. + + @param RtcRegAddr Register offset of RTC to write. + @param Val Value to be written + +**/ + +STATIC +VOID +RtcWrite ( + IN UINT8 RtcRegAddr, + IN UINT8 Val + ) +{ + RTC_I2C_REQUEST Req; + EFI_STATUS Status; + + Req.OperationCount = 2; + + Req.SetAddressOp.Flags = 0; + Req.SetAddressOp.LengthInBytes = sizeof (RtcRegAddr); + Req.SetAddressOp.Buffer = &RtcRegAddr; + + Req.GetSetDateTimeOp.Flags = 0; + Req.GetSetDateTimeOp.LengthInBytes = sizeof (Val); + Req.GetSetDateTimeOp.Buffer = &Val; + + Status = mI2cMaster->StartRequest (mI2cMaster, FixedPcdGet8 (PcdI2cSlaveAddress), + (VOID *)&Req, + NULL, NULL); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "RTC write error at Addr:0x%x\n", RtcRegAddr)); + } +} + +/** + Returns the current time and date information, and the time-keeping capabilities + of the hardware platform. + + @param Time A pointer to storage to receive a snapshot of the current time. + @param Capabilities An optional pointer to a buffer to receive the real time clock + device's capabilities. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER Time is NULL. + @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error. + +**/ + +EFI_STATUS +EFIAPI +LibGetTime ( + OUT EFI_TIME *Time, + OUT EFI_TIME_CAPABILITIES *Capabilities + ) +{ + EFI_STATUS Status; + UINT8 Second; + UINT8 Minute; + UINT8 Hour; + UINT8 Day; + UINT8 Month; + UINT8 Year; + + if (mI2cMaster == NULL) { + return EFI_DEVICE_ERROR; + } + + Status = EFI_SUCCESS; + + Second = RtcRead (DS1307_SEC_REG_ADDR); + Minute = RtcRead (DS1307_MIN_REG_ADDR); + Hour = RtcRead (DS1307_HR_REG_ADDR); + Day = RtcRead (DS1307_DATE_REG_ADDR); + Month = RtcRead (DS1307_MON_REG_ADDR); + Year = RtcRead (DS1307_YR_REG_ADDR); + + if (Second & DS1307_SEC_BIT_CH) { + DEBUG ((DEBUG_ERROR, "### Warning: RTC oscillator has stopped\n")); + /* clear the CH flag */ + RtcWrite (DS1307_SEC_REG_ADDR, + RtcRead (DS1307_SEC_REG_ADDR) & ~DS1307_SEC_BIT_CH); + Status = EFI_DEVICE_ERROR; + } + + Time->Second = BcdToDecimal8 (Second & MASK_SEC); + Time->Minute = BcdToDecimal8 (Minute & MASK_MIN); + Time->Hour = BcdToDecimal8 (Hour & MASK_HOUR); + Time->Day = BcdToDecimal8 (Day & MASK_DAY); + Time->Month = BcdToDecimal8 (Month & MASK_MONTH); + + // + // RTC can save year 1970 to 2069 + // On writing Year, save year % 100 + // On Reading reversing the operation e.g. 2012 + // write = 12 (2012 % 100) + // read = 2012 (12 + 2000) + // + Time->Year = BcdToDecimal8 (Year) + + (BcdToDecimal8 (Year) >= 70 ? START_YEAR - 70 : END_YEAR -70); + + return Status; +} + +/** + Sets the current local time and date information. + + @param Time A pointer to the current time. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER A time field is out of range. + +**/ +EFI_STATUS +EFIAPI +LibSetTime ( + IN EFI_TIME *Time + ) +{ + if (mI2cMaster == NULL) { + return EFI_DEVICE_ERROR; + } + + if (Time->Year < START_YEAR || Time->Year >= END_YEAR){ + DEBUG ((DEBUG_ERROR, "WARNING: Year should be between 1970 and 2069!\n")); + return EFI_INVALID_PARAMETER; + } + + RtcWrite (DS1307_YR_REG_ADDR, DecimalToBcd8 (Time->Year % 100)); + RtcWrite (DS1307_MON_REG_ADDR, DecimalToBcd8 (Time->Month)); + RtcWrite (DS1307_DATE_REG_ADDR, DecimalToBcd8 (Time->Day)); + RtcWrite (DS1307_HR_REG_ADDR, DecimalToBcd8 (Time->Hour)); + RtcWrite (DS1307_MIN_REG_ADDR, DecimalToBcd8 (Time->Minute)); + RtcWrite (DS1307_SEC_REG_ADDR, DecimalToBcd8 (Time->Second)); + + return EFI_SUCCESS; +} + +/** + Returns the current wakeup alarm clock setting. + + @param Enabled Indicates if the alarm is currently enabled or disabled. + @param Pending Indicates if the alarm signal is pending and requires acknowledgement. + @param Time The current alarm setting. + + @retval EFI_SUCCESS The alarm settings were returned. + @retval EFI_INVALID_PARAMETER Any parameter is NULL. + @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error. + +**/ +EFI_STATUS +EFIAPI +LibGetWakeupTime ( + OUT BOOLEAN *Enabled, + OUT BOOLEAN *Pending, + OUT EFI_TIME *Time + ) +{ + // Not a required feature + return EFI_UNSUPPORTED; +} + +/** + Sets the system wakeup alarm clock time. + + @param Enabled Enable or disable the wakeup alarm. + @param Time If Enable is TRUE, the time to set the wakeup alarm for. + + @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If + Enable is FALSE, then the wakeup alarm was disabled. + @retval EFI_INVALID_PARAMETER A time field is out of range. + @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error. + @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform. + +**/ +EFI_STATUS +EFIAPI +LibSetWakeupTime ( + IN BOOLEAN Enabled, + OUT EFI_TIME *Time + ) +{ + // Not a required feature + return EFI_UNSUPPORTED; +} + +STATIC +VOID +I2cDriverRegistrationEvent ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + EFI_STATUS Status; + EFI_I2C_MASTER_PROTOCOL *I2cMaster; + UINTN BusFrequency; + + Status = gBS->LocateProtocol (&gEfiI2cMasterProtocolGuid, NULL, (VOID **)&I2cMaster); + + gBS->CloseEvent (Event); + + ASSERT_EFI_ERROR (Status); + + Status = I2cMaster->Reset (I2cMaster); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "%a: I2CMaster->Reset () failed - %r\n", + __FUNCTION__, Status)); + return; + } + + BusFrequency = FixedPcdGet16 (PcdI2cBusFrequency); + Status = I2cMaster->SetBusFrequency (I2cMaster, &BusFrequency); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "%a: I2CMaster->SetBusFrequency () failed - %r\n", + __FUNCTION__, Status)); + return; + } + + mI2cMaster = I2cMaster; +} + +/** + This is the declaration of an EFI image entry point. This can be the entry point to an application + written to this specification, an EFI boot service driver. + + @param ImageHandle Handle that identifies the loaded image. + @param SystemTable System Table for this image. + + @retval EFI_SUCCESS The operation completed successfully. + +**/ +EFI_STATUS +EFIAPI +LibRtcInitialize ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + // + // Register a protocol registration notification callback on the driver + // binding protocol so we can attempt to connect our I2C master to it + // as soon as it appears. + // + EfiCreateProtocolNotifyEvent ( + &gEfiI2cMasterProtocolGuid, + TPL_CALLBACK, + I2cDriverRegistrationEvent, + NULL, + &mDriverEventRegistration); + + return EFI_SUCCESS; +} diff --git a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.dec b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.dec new file mode 100644 index 0000000..5312551 --- /dev/null +++ b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.dec @@ -0,0 +1,26 @@ +#/** @file +# +# Copyright 2017 NXP +# +# 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. +# +#**/ + +[Defines] + DEC_SPECIFICATION = 0x0001001A + PACKAGE_NAME = Ds1307RtcLib + PACKAGE_GUID = 0c095cf6-834d-4fa2-a5a0-31ac35591ad2 + PACKAGE_VERSION = 0.1 + +[Guids] + gDs1307RtcLibTokenSpaceGuid = { 0xd939eb84, 0xa95a, 0x46a0, { 0xa8, 0x2b, 0xb9, 0x64, 0x30, 0xcf, 0xf5, 0x99 }} + +[PcdsFixedAtBuild] + gDs1307RtcLibTokenSpaceGuid.PcdI2cSlaveAddress|0|UINT8|0x00000001 + gDs1307RtcLibTokenSpaceGuid.PcdI2cBusFrequency|0|UINT32|0x00000002 diff --git a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.inf b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.inf new file mode 100644 index 0000000..c0f1268 --- /dev/null +++ b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.inf @@ -0,0 +1,45 @@ +# @Ds1307RtcLib.inf +# +# Copyright (c) 2016, Freescale Semiconductor, Inc. All rights reserved. +# Copyright (c) 2017 NXP +# +# 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. +# +# + +[Defines] + INF_VERSION = 0x0001001A + BASE_NAME = Ds1307RtcLib + FILE_GUID = 7112fb46-8dda-4a41-ac40-bf212fedfc08 + MODULE_TYPE = BASE + VERSION_STRING = 1.0 + LIBRARY_CLASS = RealTimeClockLib + +[Sources.common] + Ds1307RtcLib.c + +[Packages] + EmbeddedPkg/EmbeddedPkg.dec + MdePkg/MdePkg.dec + Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.dec + +[LibraryClasses] + DebugLib + UefiBootServicesTableLib + UefiLib + +[Protocols] + gEfiDriverBindingProtocolGuid ## CONSUMES + gEfiI2cMasterProtocolGuid ## CONSUMES + +[FixedPcd] + gDs1307RtcLibTokenSpaceGuid.PcdI2cSlaveAddress + gDs1307RtcLibTokenSpaceGuid.PcdI2cBusFrequency + +[Depex] + gEfiI2cMasterProtocolGuid -- 1.9.1