From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from EUR04-DB3-obe.outbound.protection.outlook.com (EUR04-DB3-obe.outbound.protection.outlook.com [40.107.6.76]) by mx.groups.io with SMTP id smtpd.web11.13794.1584628598283164677 for ; Thu, 19 Mar 2020 07:36:38 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@nxp1.onmicrosoft.com header.s=selector2-nxp1-onmicrosoft-com header.b=eXCmF8vb; spf=pass (domain: oss.nxp.com, ip: 40.107.6.76, mailfrom: pankaj.bansal@oss.nxp.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=CemyEQtRJb9E2Z+H9T3IMAaove7LNpp6U1AvIv2iJcntBBb6uH7jEp6g9UwqPTjR27v8HF61UxSIdWF0XZVk2krQg6TAR2sEVvMWvQubY/a5dlVl4qI8xLw0C0cQlBdV75T5AaqOtq6vNDPp7UBFQSf/uA1kO6Z+JKYIHLO3tTJV7rElKQsBLaABevPHhqcrCvO5W2y3tU6MAehPyh0jL+5kohwo0lRoBuY1QxiPNgtGk3em1f37Rg8wj6yEOYVzafQQOavQPshE1kZUnozHFZYxxuMYlJoPyjGLk4YXrCOOf1UpIh9kyaa0D+vdwIX9Xlpf890V6034uJrB6A/mBQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=jOPYPYLCXn4q/I2VX/IhiYnql53lSazLDewBxp7pGLE=; b=jRSOb575HUy5Ms71ezU4zNFadoe5cuLWcqnsXbS9mzeR8fUnpuBbvhLsk/Sd8vjVfMh6K4yQfFo1u2BP0kX3fV50xSWTaCQRDRmVnFk0QODGp+ISiU7+fMjpgPeO5O+InRjjxfZ1foEkufwp8L+l6R+wVvCsQl/kn8lQpl5cU8ZBR/Zfz/r4IdOtpk7UaFM+V8pZ36+ix9bbhSjhi5VH58wqZtOHWF0yRNRIlESxycCht6tzlirIw731WvQtYkUHzJetXXpQkrDwa87+rvTS7OrXSd6acItoNCkfwzP/XV7es5tEFqQ7nR7iOjO6zMDpfJYeL3NE41LfPU0E482iqQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oss.nxp.com; dmarc=pass action=none header.from=oss.nxp.com; dkim=pass header.d=oss.nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=NXP1.onmicrosoft.com; s=selector2-NXP1-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=jOPYPYLCXn4q/I2VX/IhiYnql53lSazLDewBxp7pGLE=; b=eXCmF8vbnwkBcfUr21pnyaVyHVn/D4OUHJhpIiJSPn+e7OOt16/Y/uYXt7fSY8fNw2ZnB8pi4Ld0jQJxy7YlyBEf/lt2l1WO/hx/bN1+DQftzD+Zbk5FsWlYv+786bYYIIF+zFxnQIDS+4QZALgJAkaQrSaurC5NxB+Flz9rhFY= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=pankaj.bansal@oss.nxp.com; Received: from VI1PR0401MB2496.eurprd04.prod.outlook.com (10.168.65.10) by VI1PR0401MB2382.eurprd04.prod.outlook.com (10.169.130.151) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2814.21; Thu, 19 Mar 2020 14:36:36 +0000 Received: from VI1PR0401MB2496.eurprd04.prod.outlook.com ([fe80::196a:28a9:bb9:2fae]) by VI1PR0401MB2496.eurprd04.prod.outlook.com ([fe80::196a:28a9:bb9:2fae%9]) with mapi id 15.20.2835.017; Thu, 19 Mar 2020 14:36:36 +0000 From: Pankaj Bansal To: Leif Lindholm , Meenakshi Aggarwal , Michael D Kinney , devel@edk2.groups.io, Varun Sethi , Samer El-Haj-Mahmoud , Jon Nettleton Subject: [PATCH v2 05/28] Silicon/Maxim: Add comments in Ds1307RtcLib Date: Fri, 20 Mar 2020 20:05:20 +0530 Message-ID: <20200320143543.18615-6-pankaj.bansal@oss.nxp.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200320143543.18615-1-pankaj.bansal@oss.nxp.com> References: <20200320143543.18615-1-pankaj.bansal@oss.nxp.com> X-ClientProxiedBy: SG2PR02CA0042.apcprd02.prod.outlook.com (2603:1096:3:18::30) To VI1PR0401MB2496.eurprd04.prod.outlook.com (2603:10a6:800:56::10) Return-Path: pankaj.bansal@oss.nxp.com MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from uefi-workstation.ap.freescale.net (92.120.0.69) by SG2PR02CA0042.apcprd02.prod.outlook.com (2603:1096:3:18::30) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2835.19 via Frontend Transport; Thu, 19 Mar 2020 14:36:33 +0000 X-Mailer: git-send-email 2.17.1 X-Originating-IP: [92.120.0.69] X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-HT: Tenant X-MS-Office365-Filtering-Correlation-Id: 8d73caa8-4079-4398-45c0-08d7cc12ed52 X-MS-TrafficTypeDiagnostic: VI1PR0401MB2382:|VI1PR0401MB2382: X-MS-Exchange-SharedMailbox-RoutingAgent-Processed: True X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:7219; X-Forefront-PRVS: 0347410860 X-Forefront-Antispam-Report: SFV:NSPM;SFS:(10009020)(4636009)(376002)(396003)(346002)(136003)(366004)(39860400002)(199004)(6666004)(316002)(186003)(16526019)(6506007)(8676002)(81166006)(81156014)(478600001)(86362001)(966005)(44832011)(19627235002)(26005)(8936002)(6486002)(5660300002)(52116002)(6512007)(956004)(66946007)(110136005)(66476007)(2616005)(2906002)(66556008)(1076003);DIR:OUT;SFP:1101;SCL:1;SRVR:VI1PR0401MB2382;H:VI1PR0401MB2496.eurprd04.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;A:0; Received-SPF: None (protection.outlook.com: oss.nxp.com does not designate permitted sender hosts) X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: yP9vC5HjRHGNvSjoYFASdbQwgpcxOdJvBWrOjWnfLyCEXKe0+y3FxYtZaCo1KV3rzXZiZAOhcw/eP2ZZIcVwzFf/ykE9uW/bvIRHyRcMMk+tvq9xFNehnbgv+NU4gs5QySj9HxWz8K1NtgZT3MfLqQTkj0DYI8l40+waGjN9hP4YZrSXaKHw/EP9t70+IDo1YwmJftEEKqqIbrU29IDe1Uh0Kd4qoHHbVZh8KXNlOwLr0oPgwEcMIqWrGOoTC987+yl7qSg02C2h5QdyQwWbXkx60L237fNR8SAZKR+TbSpkzd+lWOYA4/ow73LA75GMst7h2G67leqMKGtVYBlgg/XScMBGmAg2iZLEsz74ufmI5zRUgrDuNdW2hlAWBFV305hvdB4biXCN3p+VeaG6TX/2jNK1dAhRmPOJVgOX2ZSwVC0rXrZMAaWOER2uqnGuFhrgrkGG23tcBlHB/5/M/icTPPR+WmxlTVAYC6Ib7Pfor389+aWFmQSavmvP6BXKl9IhVN4IvvC02/cVgZ/EQA== X-MS-Exchange-AntiSpam-MessageData: fTJ+wbA3Lk43OuPzX9vUiC5O6oaLDMGUVWjNEqpDTfntmSeN8XvJ+d0RpfOALT1DxTiy+eNHVwtvQNnUy/6mfxgb5O+LtCAgTQ+PylJNmdy5XYPVZVwfrbbWOms3FB98dDol+HrNu0Lj0A2uczPHAw== X-OriginatorOrg: oss.nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 8d73caa8-4079-4398-45c0-08d7cc12ed52 X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Mar 2020 14:36:36.3382 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: Ib+lfJQmswEl7+hdcOQxBkKZtx1CjZGj6zN8H8BQBZCPsNEXER8GNpx95ZxFbcLz80qAGVKgFnBRjfJobmt4Kw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR0401MB2382 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain From: Pankaj Bansal Add comments to explain the register read and write operation on Ds1307. These comments have been referred from data sheet: https://datasheets.maximintegrated.com/en/ds/DS1307.pdf Signed-off-by: Pankaj Bansal --- Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c b/Silicon/Ma= xim/Library/Ds1307RtcLib/Ds1307RtcLib.c index fd7a8696e405..444e01124811 100644 --- a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c +++ b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c @@ -28,6 +28,11 @@ STATIC EFI_I2C_MASTER_PROTOCOL *mI2cMaster; =20 /** Read RTC register. + Data Read-Slave Transmitter Mode + + = + + The first byte is received and handled as in the slave receiver mode. =20 @param RtcRegAddr Register offset of RTC to be read. =20 @@ -69,6 +74,9 @@ RtcRead ( =20 /** Write RTC register. + Data Write-Slave Receiver Mode + + =20 @param RtcRegAddr Register offset of RTC to write. @param Val Value to be written --=20 2.17.1