From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=40.107.0.80; helo=eur02-am5-obe.outbound.protection.outlook.com; envelope-from=meenakshi.aggarwal@nxp.com; receiver=edk2-devel@lists.01.org Received: from EUR02-AM5-obe.outbound.protection.outlook.com (mail-eopbgr00080.outbound.protection.outlook.com [40.107.0.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id CCB04223230CE for ; Fri, 16 Feb 2018 00:48:38 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=ApLKjSWaty4P0ts8hb6vgYbEKZjfU70M031KdMVVBn4=; b=ZZp6lsQEsJJPhQEioxPiumCKNEZOzrUTWurSoOqZil4CbTr6r0EWoTWhcYi2AvJZSaXJnt8T4hiB7FrEhKqPnHynvHNzvwjGQ6gfHHZeZHXdjgsEPs4JUGK3hzy2Nx0zJEZIkD8fT9+SDRdhMwvTmeSfN0FTb6hWGegBjiwiMgI= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=meenakshi.aggarwal@nxp.com; Received: from idcbfarm.ap.freescale.net (192.88.169.1) by VI1PR04MB1008.eurprd04.prod.outlook.com (2a01:111:e400:5090::28) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.485.10; Fri, 16 Feb 2018 08:54:26 +0000 From: Meenakshi To: ard.biesheuvel@linaro.org, leif.lindholm@linaro.org, michael.d.kinney@intel.com, edk2-devel@lists.01.org Date: Fri, 16 Feb 2018 14:20:22 +0530 Message-Id: <1518771035-6733-27-git-send-email-meenakshi.aggarwal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1518771035-6733-1-git-send-email-meenakshi.aggarwal@nxp.com> References: <1518771035-6733-1-git-send-email-meenakshi.aggarwal@nxp.com> MIME-Version: 1.0 X-Originating-IP: [192.88.169.1] X-ClientProxiedBy: HK2PR02CA0172.apcprd02.prod.outlook.com (2603:1096:201:1f::32) To VI1PR04MB1008.eurprd04.prod.outlook.com (2a01:111:e400:5090::28) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-HT: Tenant X-MS-Office365-Filtering-Correlation-Id: cb03231a-7089-425d-230d-08d5751ae3d8 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(48565401081)(5600026)(4604075)(4534165)(4627221)(201703031133081)(201702281549075)(2017052603307)(7153060)(7193020); SRVR:VI1PR04MB1008; X-Microsoft-Exchange-Diagnostics: 1; VI1PR04MB1008; 3:sFTq/LxdPKrHnZzcyOyMIYDs1g8uNhiUSjCablM1flCzpXoney8wjUBaoX89dS/vssUzUkJK+rSJg5Brs1kmkTRtJFIzrbWa6sxrTAQMMSpb+jA6sk02iW7K/g/kE/yqFj97VECAiVSnbxlxvj0AQLxfrItlR4W6D9dgWp409rumFFnKT3YI6t8SKklN9MjSGPtCwtswARmvbGRn8H4ybIlvcglNnn3cnp9EOfjiU7IsR/JMjm+Hengox6tvI1Hq; 25:E+F7XTCU4imh50xk2/0BvKCkPmzARX1dgX7nE+Orl+WqiCYLIaJHUjLbT4bGRjiReZhYrWYqMlTw9kPT/4lxisZb/nnwBlQAo3VHyF/x4C8vIADB+67PDs88wI9kdd1aTr3j7kv8UnNunZfNutz1BPNWP/WjQY/25qlx5VIfaIpb/X0AqypCwJddFTQBMnRK7nBmXTSXzia0qci/RlVnPssKz7ZIbtsbCYNXgdIQqIXKFnyMzqUsEkgl33cub09RT7ddxMcM95sFLG/8Wb75aOkXYTvLVPYxYHgUDoCNzvqvQqGlEHy2rDavyCYughbAT/tmGNS7rFjxxIuujL90zw==; 31:FBl6IQX5IQm/+Y3qxjZv6/QHnzvdWOXniRflykPV7f8xPpqbAPtaYqMW2hymropmKhYySSZRTLxbBXku0Ij0z6rjixhaWBSTLNudkpZXiA7oA8v97JwvvanBqZKxLAuEUuRA7/mBVyg/4SDwuPnN5JrqlQLS2PLOnRD825qEjZ6ONcYVfrPCXrH2RDWZhZm0WmCxMu9IZVx7Kr/tTRkhb/+U/7DspMgOxP4iJy19maE= X-MS-TrafficTypeDiagnostic: VI1PR04MB1008: X-Microsoft-Exchange-Diagnostics: 1; VI1PR04MB1008; 20:UgDH1cRtPTsSvQ272/et4EX/j3ZCOEFmXgxeQDM4FOOik7vjaKsj+xgor+gJxTeXw47mdCkaDEwAGXhzpgHaxi5hUc3Ahmigo+FHPSvdipc013OrLK5f94IZvsz7cRbfrHKlu/MlmZEKi4Cr7ZEXR/UfNJ3dKytWZYAqDo0tYSGTXq1TjxtGoOPlmSqM7yWufmffAahCDRjzD/tzsHZkjqODnBKf2RiqKHeryf7xYLjdsu3DQ3UAUY+0TBfNXncKEenIr392AwKHv4PbZtbb+mwRlpEfuc9mJRndcFnB3F84hEs/56tixGepepClyGESNEJrmzoJU7ehvVRPFw7njJmrz9jWj+YtcruL4UIvmZAWJa98xdjnSI3ING1ruxWQrkc4O2N47nqTIP3XLVHJU0FzefrBY+gndcuSq2sm0B0JnLjqDICmN/+lTX3tTQxjm4q2yb30KIN4nBQXtmg+Rj9ELgVc9bdI1yj1ues03GxlDFDMDxS5/Fith0KPRu8x; 4:L0GCeSxa34z3UfD4jwbmBLwuOjDfUZ6HZ0ho6zPsf/MEdv1GInj5qt8BPw5d95xvajTYPHfPzYVanncqwM05i4xsr4gZdZmCgj2osJgJufDcBon54lry09wuy24clDCB51vP28lJ4aw6AvIchueMhleU7nUbZSN79I0wbEbyHWpEOElwXGqOWo3DpDcjKU8GNUz8JcuP3hurMfhtQ/PSxaJhdnl7VzSbQ1W79YgDyZD5B9j93hrKaVYApTHY1l4M1934YMvjWWsjD8GoZ52IhRQR82be4kX1ajb4tWMI9aYc55J7YTqbk2QGhZn9fFtPgm+AcIvuA7JCd5xJj38NNfCjlflspZMFpKCDyiGxQEU= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(21532816269658); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040501)(2401047)(8121501046)(5005006)(93006095)(93001095)(10201501046)(3002001)(3231101)(944501161)(6055026)(6041288)(20161123558120)(20161123564045)(20161123560045)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011); SRVR:VI1PR04MB1008; BCL:0; PCL:0; RULEID:; SRVR:VI1PR04MB1008; X-Forefront-PRVS: 0585417D7B X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(346002)(376002)(39380400002)(396003)(39860400002)(366004)(199004)(189003)(86362001)(575784001)(6486002)(8676002)(76176011)(36756003)(53376002)(966005)(4326008)(6116002)(15188155005)(16799955002)(7736002)(386003)(68736007)(186003)(26005)(53936002)(305945005)(16526019)(81156014)(3846002)(6506007)(478600001)(50226002)(16586007)(8936002)(2950100002)(316002)(2906002)(59450400001)(25786009)(97736004)(50466002)(48376002)(105586002)(52116002)(47776003)(81166006)(51416003)(5660300001)(6666003)(106356001)(66066001)(6306002)(6512007)(19627235001); DIR:OUT; SFP:1101; SCL:1; SRVR:VI1PR04MB1008; H:idcbfarm.ap.freescale.net; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; LANG:en; Received-SPF: None (protection.outlook.com: nxp.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; VI1PR04MB1008; 23:5RotyTGSE6jIpg0zbuVapxt2urlDSmm4nN+4na/Qw?= =?us-ascii?Q?0i/7wa2EegKsUG5FuJ01F10dfCUrXAh6kM1cP1rnb55QqS02olNA/HHj85w1?= =?us-ascii?Q?9l/i7EdtmvrH5KUK+DYs1g5GRdHKaij0etpGrKlGQ9bfJ/xQh6VDvUDdVeyG?= =?us-ascii?Q?OOM/JaECeMWXrRj1yHYjxZ5gDPUQ+DREXKpnd4ZHqIGGLcgrNwgCaJiSfMt/?= =?us-ascii?Q?be3KoJCzZ5ePwLdtQRU21zehjS7G7wyn/1cX4czo6cBIGSOO85nUOcj5uuNC?= =?us-ascii?Q?h09shM5dGs9cnS8vwJv74D5iiVVtJvrFk8AcpEZ4T9Kj7Use61pSNC91pd/O?= =?us-ascii?Q?75drBQcA7vA9br8ElYvoNnM/TVHi7JGV2LXzUeoNQI3eWHtHg6DfdoZMBDlL?= =?us-ascii?Q?vs3vIVUcXWw/rJ7ElEsgb3Yi5F+z/vxw795k9RExXpTiT5jA6wbHOEiPF3SN?= =?us-ascii?Q?7UcRTUlgp76s5Dmxe7W/JpJFMRh9kCZ4lLyS+h9wMkq+DJ/nFwzSDDBr5HxN?= =?us-ascii?Q?CrHmLM9j9p2Qz927O/deEfRJOPK1aY40IEKFbeNl/1bha1ttaPV56M2YLStP?= =?us-ascii?Q?DyHa6aH3q6qPZsEzJFu5EHffZEePCBW5HKrj8SvA0BiugqRa4hvkfuluQoSo?= =?us-ascii?Q?ybKP0v3jLcCIBIVhT+/eD7K3TNcbGjOGwH9DcJ+ktfJ2lC2wNW1tsC7WTaLH?= =?us-ascii?Q?MRKY6Jsk1jZzE0+OijcOwxW77nWEnuoUJ7MXDAQlQD7GNf+TwsAoE1kmkOZ5?= =?us-ascii?Q?DeU813ZcOFOCQh2XywrkG5zH17Ml2S9WAos+z8ZkDYJSpTMV8wxtuySb/Lh2?= =?us-ascii?Q?qtTO1rghl6BXS3G317z2PezbzFVyaBo1gpbzcoU2nQy/w6/d0gLsnJgFL4qj?= =?us-ascii?Q?jUOPT6crTR1jfm0q6kKztZ/h8Mw+LagJnGhWgGs+xVc5CIn47kGZRR5C0+tI?= =?us-ascii?Q?OIfdEKVpTeeFtF8vXqiJoyuOrKX0FnUEKTOLldd/WasDCGA1NF/aWYo7hI37?= =?us-ascii?Q?PZfkYLsdRsh7+G4dCPaaI6Y1Q6BM+bF8+i9rEQk2MxbpJe6ZcP17V/BP/yBm?= =?us-ascii?Q?30zEcyZfkfMmiqIFwu9JBBiHbZrTN0xzDXOiLYpCJE+9pQ4LYIoM6cp3KDj4?= =?us-ascii?Q?U9ThTokMq6sk3bPRBhlmvmfY2WjZvsO7yhNppWAdudjOpK/eOAE5i1ohcLv+?= =?us-ascii?Q?nnnAWvDneBjp5OfBiAX6vFkv1pNzOJ8a6MwCaKM4NCfX5X5+/f+lmJUv9i4z?= =?us-ascii?Q?ajeGuE0qjB7fhP/U5Vnl8z6AW/A+Kk/rDNPy9nI?= X-Microsoft-Exchange-Diagnostics: 1; VI1PR04MB1008; 6:NJuwbfNPVkVLTvy+nFpO7dknO6I2rdi23r56IbtPSb+SjdiHuPvrKCUk5BR2H1oxBsS6o0EyehzerEgHvcUVBfAruK79m1ctdmVa5NO5L4UcU/5FkFA558EoWCv22q89Mdk2QwQ6qXxvOFSkqSC540zg6WTx7+tm/zNW8iK1/bABLTlCNX5GdzYrgm3I+204C2bjnOWjsJ5OEvdVVQuXfG2bCfsmZRNuYtdh5pCrcOk1RwzhdGh3j/9kqnTcHFsUtfvTqNCLfc8CSe3U0Nuw1iSaViB++X6Hrwozs6Ui96qNLgNVVSktz+h7EepWW/swspjCbJAFFUA/GJkDBOsM42leCzBHzbA+yGD6gXANh/o=; 5:cf10LCDSP9arEALr9vxvgSJ4MTk0qLJBwDNdstpcm94EnVnayWovFzXflmqRewVEfzZR94Zh60h9nLFppl+planvYiRs0pl7q70HwuevINGbg3bBdNrBD/N3ronBjcRj8SEumdSoB6AWC7C0KV24WHOPyrp/zl7x4wf/fA4owSM=; 24:sMsJFImfCF0iWzHkg9iags2fQ4VKdYg8DqDbpapIR5vIsax4IN7KhZG+5KJ7IWfW4Z058f0o4Cu1nH7GVKtR1GO6HIdLqcECuUiKNG8syR8=; 7:KPdod3TEQ2qBT14WncR3tqlzQDq/nRQwbK9Tac4WjJwD/OUohlcsWSk/M30kPEqAASnMxeWAdEEYmWQx0JakPF/Xgt+zwTSHdOFvb4OSVITugjMT6x6p+wApbOGMymH0aELP9mn//l+VPgCGSB6xOT/4u3hy5PW4nUzepzBYmWAvHPAopZqZITG/4e2lV90/pk3yZWRqOkF21B9NDn8yWCRBvGdPiEi5wuL6qD657Lbq1gdDFyWIsmy4Gwt7++bA SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Feb 2018 08:54:26.4516 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: cb03231a-7089-425d-230d-08d5751ae3d8 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB1008 Subject: [PATCH edk2-platforms 26/39] Silicon/Maxim: DS3232 RTC Library Support X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 16 Feb 2018 08:48:39 -0000 Content-Type: text/plain From: Wasim Khan Add Maxim DS3232 RTC Library support Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Wasim Khan --- Silicon/Maxim/Library/Ds3232RtcLib/Ds3232Rtc.h | 49 +++ Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.c | 370 +++++++++++++++++++++ .../Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.dec | 31 ++ .../Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.inf | 49 +++ 4 files changed, 499 insertions(+) create mode 100644 Silicon/Maxim/Library/Ds3232RtcLib/Ds3232Rtc.h create mode 100644 Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.c create mode 100644 Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.dec create mode 100644 Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.inf diff --git a/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232Rtc.h b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232Rtc.h new file mode 100644 index 0000000..cd1a321 --- /dev/null +++ b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232Rtc.h @@ -0,0 +1,49 @@ +/** Ds3232Rtc.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 __DS3232RTC_H__ +#define __DS3232RTC_H__ + +//RTC time register +#define DS3232_SEC_REG_ADDR 0x00 +#define DS3232_MIN_REG_ADDR 0x01 +#define DS3232_HR_REG_ADDR 0x02 +#define DS3232_DAY_REG_ADDR 0x03 +#define DS3232_DATE_REG_ADDR 0x04 +#define DS3232_MON_REG_ADDR 0x05 +#define DS3232_YR_REG_ADDR 0x06 + +#define DS3232_SEC_BIT_CH 0x80 // Clock Halt (in Register 0) + +//RTC control register +#define DS3232_CTL_REG_ADDR 0x0e +#define DS3232_STAT_REG_ADDR 0x0f + +#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 + +typedef struct { + UINTN OperationCount; + EFI_I2C_OPERATION SetAddressOp; + EFI_I2C_OPERATION GetSetDateTimeOp; +} RTC_I2C_REQUEST; + +#endif // __DS3232RTC_H__ diff --git a/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.c b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.c new file mode 100644 index 0000000..1a852e9 --- /dev/null +++ b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.c @@ -0,0 +1,370 @@ +/** Ds3232RtcLib.c +* Implement EFI RealTimeClock via RTC Lib for DS3232 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 "Ds3232Rtc.h" + +STATIC VOID *mDriverEventRegistration; +STATIC EFI_I2C_MASTER_PROTOCOL *mI2cMaster; + +/** + Read RTC register. + + @param SlaveDeviceAddress Slave device address offset of RTC to be read. + @param RtcRegAddr Register offset of RTC to be read. + + @retval Register Value read + +**/ +STATIC +UINT8 +RtcRead ( + IN UINT8 SlaveDeviceAddress, + 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, SlaveDeviceAddress, + (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 SlaveDeviceAddress Slave device address offset of RTC to be read. + @param RtcRegAddr Register offset of RTC to write. + @param Val Value to be written + +**/ +STATIC +VOID +RtcWrite ( + IN UINT8 SlaveDeviceAddress, + 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, SlaveDeviceAddress, + (VOID *)&Req, + NULL, NULL); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "RTC write error at Addr:0x%x\n", RtcRegAddr)); + } +} + +/** + Configure the MUX device connected to I2C. + + @param RegValue Value to write on mux device register address + +**/ +VOID +ConfigureMuxDevice ( + IN UINT8 RegValue + ) +{ + RtcWrite (FixedPcdGet8 (PcdMuxDeviceAddress), FixedPcdGet8 (PcdMuxControlRegOffset), RegValue); +} + +/** + 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; + + // + // Check if the I2C device is connected though a MUX device. + // + if (FixedPcdGetBool (PcdIsRtcDeviceMuxed)) { + // Switch to the channel connected to Ds3232 RTC + ConfigureMuxDevice (FixedPcdGet8 (PcdMuxRtcChannelValue)); + } + + Second = RtcRead (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_SEC_REG_ADDR); + Minute = RtcRead (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_MIN_REG_ADDR); + Hour = RtcRead (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_HR_REG_ADDR); + Day = RtcRead (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_DATE_REG_ADDR); + Month = RtcRead (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_MON_REG_ADDR); + Year = RtcRead (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_YR_REG_ADDR); + + if (Second & DS3232_SEC_BIT_CH) { + DEBUG ((DEBUG_ERROR, "### Warning: RTC oscillator has stopped\n")); + /* clear the CH flag */ + RtcWrite (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_SEC_REG_ADDR, + RtcRead (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_SEC_REG_ADDR) & ~DS3232_SEC_BIT_CH); + Status = EFI_DEVICE_ERROR; + goto EXIT; + } + + 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); + +EXIT: + if (FixedPcdGetBool (PcdIsRtcDeviceMuxed)) { + // Switch to the default channel + ConfigureMuxDevice (FixedPcdGet8 (PcdMuxDefaultChannelValue)); + } + + 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; + } + + // + // Check if the I2C device is connected though a MUX device. + // + if (FixedPcdGetBool (PcdIsRtcDeviceMuxed)) { + // Switch to the channel connected to Ds3232 RTC + ConfigureMuxDevice (FixedPcdGet8 (PcdMuxRtcChannelValue)); + } + + RtcWrite (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_YR_REG_ADDR, DecimalToBcd8 (Time->Year % 100)); + RtcWrite (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_MON_REG_ADDR, DecimalToBcd8 (Time->Month)); + RtcWrite (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_DATE_REG_ADDR, DecimalToBcd8 (Time->Day)); + RtcWrite (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_HR_REG_ADDR, DecimalToBcd8 (Time->Hour)); + RtcWrite (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_MIN_REG_ADDR, DecimalToBcd8 (Time->Minute)); + RtcWrite (FixedPcdGet8 (PcdI2cSlaveAddress), DS3232_SEC_REG_ADDR, DecimalToBcd8 (Time->Second)); + + if (FixedPcdGetBool (PcdIsRtcDeviceMuxed)) { + // Switch to the default channel + ConfigureMuxDevice (FixedPcdGet8 (PcdMuxDefaultChannelValue)); + } + + 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 + ) +{ + // Currently not supporting this 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 + ) +{ + // Currently not supporting this 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/Ds3232RtcLib/Ds3232RtcLib.dec b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.dec new file mode 100644 index 0000000..4471d57 --- /dev/null +++ b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.dec @@ -0,0 +1,31 @@ +#/** @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 = Ds3232RtcLib + PACKAGE_GUID = 0b4192f7-e404-4019-b2e5-1e6004da3313 + PACKAGE_VERSION = 0.1 + +[Guids] + gDs3232RtcLibTokenSpaceGuid = { 0x7960fc51, 0x0832, 0x4f0b, { 0xb4, 0x22, 0x53, 0x87, 0x03, 0xaa, 0x85, 0xda }} + +[PcdsFixedAtBuild] + gDs3232RtcLibTokenSpaceGuid.PcdI2cSlaveAddress|0|UINT8|0x00000001 + gDs3232RtcLibTokenSpaceGuid.PcdI2cBusFrequency|0|UINT32|0x00000002 + gDs3232RtcLibTokenSpaceGuid.PcdIsRtcDeviceMuxed|FALSE|BOOLEAN|0x00000003 + gDs3232RtcLibTokenSpaceGuid.PcdMuxDeviceAddress|0|UINT8|0x00000004 + gDs3232RtcLibTokenSpaceGuid.PcdMuxControlRegOffset|0|UINT8|0x00000005 + gDs3232RtcLibTokenSpaceGuid.PcdMuxRtcChannelValue|0|UINT8|0x00000006 + gDs3232RtcLibTokenSpaceGuid.PcdMuxDefaultChannelValue|0|UINT8|0x00000007 diff --git a/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.inf b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.inf new file mode 100644 index 0000000..9cac100 --- /dev/null +++ b/Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.inf @@ -0,0 +1,49 @@ +# @Ds3232RtcLib.inf +# +# Copyright (c) 2016, Freescale Semiconductor, 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. +# +# + +[Defines] + INF_VERSION = 0x0001001A + BASE_NAME = Ds3232RtcLib + FILE_GUID = 97f1f2c2-51e1-47ad-9660-70b33da1fe71 + MODULE_TYPE = BASE + VERSION_STRING = 1.0 + LIBRARY_CLASS = RealTimeClockLib + +[Sources.common] + Ds3232RtcLib.c + +[Packages] + EmbeddedPkg/EmbeddedPkg.dec + MdePkg/MdePkg.dec + Silicon/Maxim/Library/Ds3232RtcLib/Ds3232RtcLib.dec + +[LibraryClasses] + DebugLib + UefiBootServicesTableLib + UefiLib + +[Protocols] + gEfiI2cMasterProtocolGuid ## CONSUMES + +[FixedPcd] + gDs3232RtcLibTokenSpaceGuid.PcdI2cSlaveAddress + gDs3232RtcLibTokenSpaceGuid.PcdI2cBusFrequency + gDs3232RtcLibTokenSpaceGuid.PcdIsRtcDeviceMuxed + gDs3232RtcLibTokenSpaceGuid.PcdMuxDeviceAddress + gDs3232RtcLibTokenSpaceGuid.PcdMuxControlRegOffset + gDs3232RtcLibTokenSpaceGuid.PcdMuxRtcChannelValue + gDs3232RtcLibTokenSpaceGuid.PcdMuxDefaultChannelValue + +[Depex] + gEfiI2cMasterProtocolGuid -- 1.9.1