From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=104.47.41.51; helo=nam03-dm3-obe.outbound.protection.outlook.com; envelope-from=meenakshi.aggarwal@nxp.com; receiver=edk2-devel@lists.01.org Received: from NAM03-DM3-obe.outbound.protection.outlook.com (mail-dm3nam03on0051.outbound.protection.outlook.com [104.47.41.51]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 2FE2A2034A7A2 for ; Wed, 22 Nov 2017 01:57:08 -0800 (PST) Received: from BN6PR03CA0095.namprd03.prod.outlook.com (2603:10b6:405:6f::33) by SN2PR03MB2365.namprd03.prod.outlook.com (2603:10b6:804:e::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.239.5; Wed, 22 Nov 2017 10:01:22 +0000 Received: from BL2FFO11FD045.protection.gbl (2a01:111:f400:7c09::110) by BN6PR03CA0095.outlook.office365.com (2603:10b6:405:6f::33) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.239.5 via Frontend Transport; Wed, 22 Nov 2017 10:01:22 +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 BL2FFO11FD045.mail.protection.outlook.com (10.173.161.207) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.218.12 via Frontend Transport; Wed, 22 Nov 2017 10:01:22 +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 vAMA0nI8030922; Wed, 22 Nov 2017 03:01:19 -0700 From: Meenakshi Aggarwal To: , , , Date: Wed, 22 Nov 2017 21:18:56 +0530 Message-ID: <1511365740-1157-5-git-send-email-meenakshi.aggarwal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1511365740-1157-1-git-send-email-meenakshi.aggarwal@nxp.com> References: <1510065736-9394-1-git-send-email-meenakshi.aggarwal@nxp.com> <1511365740-1157-1-git-send-email-meenakshi.aggarwal@nxp.com> X-EOPAttributedMessage: 0 X-Matching-Connectors: 131558184825705814; (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)(7966004)(346002)(39380400002)(39860400002)(376002)(2980300002)(1110001)(1109001)(339900001)(189002)(199003)(77096006)(68736007)(105606002)(86362001)(575784001)(106466001)(498600001)(8656006)(2201001)(53376002)(316002)(4326008)(97736004)(16586007)(6306002)(8936002)(85426001)(50226002)(33646002)(54906003)(2906002)(5003940100001)(5660300001)(53936002)(50466002)(110136005)(48376002)(81166006)(81156014)(966005)(16799955002)(189998001)(8676002)(551934003)(76176999)(104016004)(356003)(47776003)(36756003)(50986999)(305945005)(2950100002)(15188155005)(6666003)(44824005)(19627235001); DIR:OUT; SFP:1101; SCL:1; SRVR:SN2PR03MB2365; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BL2FFO11FD045; 1:t3DS5vwfX8iw3wQrslMaznO9/jlYAaynxuih/loBQemZ6MBsU043vQe6hXrp4SFwnsqAqUJ+zPgtpko9KuLETaS557IUd0KTfS/jpIaRdNXIyhNm2Ft8VmHRm3LROZ3W MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 3efe9ef6-f2cf-438d-d556-08d5318ffc4b X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(5600022)(4604075)(4534020)(4628075)(201703131517081)(2017052603258); SRVR:SN2PR03MB2365; X-Microsoft-Exchange-Diagnostics: 1; SN2PR03MB2365; 3:xZwCJ38Z+HDeTjaWsEBggKByru42OFlXMlDdjDGZfVSKhdqzrCIu5NMuN0c6X8zXy0JP7qnBzyakqDm4A5ObrVeMiNFPxYlxci+ZKKZUUm81GwHDeCm9NsWDHZtHPP3HZ/nvt/0J6rk7Dgb5lf8x0hIwbcBRi8ZDdVhUT23ov97SqTHtCdFkAkkVpHI1n+FA9G2R9usVemIx8Bop/L3ca4lUCeu/dQnUcuQerf/6ydLmLJ1VK6Efj9Uk+KRT6MzvIbQPejIDtO8XZBBb4K0coyhQGRA+AkdezyOOXOLcJoiKYWNIrLn+roSyX+PM7O9kmSYK3OXul0wGzFzy9xWnVEcK51q0NvmrE//Ch4kzZoU=; 25:4JSBT390Ozrr86UuSLMi925a8YTJ2xDkq7weID3CY+vZZrlzG5Feg0pA30cTzl0TOMTUr3gPTvxuZDqaNIYli30dn8FDEkR4hSGNZvObTOMWhPpX9OR+Mm13tRz9KawaX6llm+SgPLMV9w246R9842el3yz1fY8oOECg9fdMNeSLPk9pyiCjNaWURHVl1JbZOO36vG6Msj1AQL7VG4I9BnwyzmLEIVdaEW2w9iu/AjLsttKTpQJ5qk7r1f86TszxZv0F4kz/Dxah2ZE0vFdE9wuvQUFseVjR6G7oWBBSqSesQxcGC0T7RJCZEh4Kt725xMlTrE6LtzBy0lFGsaL44e/xu/MLEezRt8czdBvnUyI= X-MS-TrafficTypeDiagnostic: SN2PR03MB2365: X-Microsoft-Exchange-Diagnostics: 1; SN2PR03MB2365; 31:tGf+8r5N7tI3XR9K62kG/yB2zRA7jOsirs0S6mp5JQ2fFj0UDtk5vvf8zHIzz1cdyOLACm+aBS+Bv8cPzw0QDKp9UmVh5gmIbB8li4DJmehgXL42eh7vbuM3TCSoTNJRcQ7VgsY8tYEyUoh4R6AjqP1yF9tQf8+GxoMf8/5eE25bWKObd3Pun3+BXNuquYPIxHlH6YM66tAnz0F5bQy5rxfDthVjU85ZHitr1qzZsXQ=; 4:X+1hlfYy2Kps39FTsMmUYYOldd5Ilbwyvn5q8WgfU377JZwnVEZGi+jyULUj24ZfXRzodW2L/98g7Ow5OXDwZnnNgABYMUU0I1ne6fCdhO1gmjj0KKPpI+xpALEcTlR0YnIN7FJ0zeI7ggVbx69hKpt/2TPwKchT9JA8b/XD4P+9Hq8W1wtcYaB3q7+Dyu2jNbQbF03c5VzrJ/3HbJzTEw5wF42Nq7Di7l9+a+F+o4BUxgssC/UIV8f5+jxI/SEHwldU6NMsxHtsr1gnyk6ewjXIjJZk6zZeSX6Ua9gak+yusG/fVA5R41vcCtb0pAx6 X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6095135)(2401047)(5005006)(8121501046)(100000703101)(100105400095)(3002001)(93006095)(93001095)(10201501046)(3231022)(6055026)(6096035)(20161123565025)(20161123561025)(20161123556025)(20161123559100)(201703131430075)(201703131433075)(201703131441075)(201703131448075)(201703161259150)(20161123563025)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:SN2PR03MB2365; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(400006)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:SN2PR03MB2365; X-Forefront-PRVS: 0499DAF22A X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; SN2PR03MB2365; 23:Dx0/wqcIPuquDDVRBZ2d58I9XWKN2J94hYJ2vj8Ga?= =?us-ascii?Q?p2rhZ+cx7eubBqLddUIdqhH1aABrYek/A4NyRjzgz1LgLlKJQzvzasyyfjlx?= =?us-ascii?Q?TUklVLTxZMEtFXB2FrEv1RFJWpWwvxtX64xrauFYHdm6/BGbvqFaw5leQRod?= =?us-ascii?Q?pmQxfGV159Nvs9l/AsoG0GVj4kqSHbFVq9udxJbWhwvINPirRr4YWnKjH/8E?= =?us-ascii?Q?THHoGYrntSglmdr2xF3ij0oa16ji3ruQ4vvdDjvbcbWJW+wpLvN0lnjVf5xJ?= =?us-ascii?Q?hS7k/o3r6gmR6Qha+BN8fRE7kk4SAukHru47F4kUBSE05gbQble06AUi+5iq?= =?us-ascii?Q?b72MV2KUEVklA2W2Ozr1DyOvKyzMqZaVn2a2AdEncVy7QzixfzFlNNNoXjfl?= =?us-ascii?Q?4POGkc6/jSsojsWNfdELSoumq928/mZzoZ5dJ4//c1Ck0trWzLmxMTAysA5j?= =?us-ascii?Q?/hx4BgIO1VZYSJ0dZWnsFZECD17vPmmY3JOWWPa4u/KaRthZYOOA12sIOKxA?= =?us-ascii?Q?udnGG9HuZbPl9QfTrzGz9L/2U4SqVxKmitjc2S6idkgkxfpB8cjnzI6tQDc1?= =?us-ascii?Q?CWjWhGsxVSsop4D9RPRPkIqciGzgS5ugx7SeO7y/LWMUvIM74caGXWrVTXmV?= =?us-ascii?Q?11oWCiqs6FEsffcvCy5+KdbKQZe55wEfKw4Hx8beL2rSgejNtMmpFmBUudUc?= =?us-ascii?Q?aJ3HiFFQdX5u9QVxOGrsVdefZXK6/qg7bEOUbJ4VelivztaYY7d0/ESPJU9p?= =?us-ascii?Q?6vkKd8xb/QxLGKWOKMa9KUY12bnsn6jj6OkdURzbevTEXTPMErQWtmXZ+jB5?= =?us-ascii?Q?wlkTU4XUVuLs1chmzCVEC6ZFqMxgC/KQoEYVNfC7WG3TW2+f+yZQikaxvtAB?= =?us-ascii?Q?jLBcFlH3mf6FM8Je2/5prs4LHDTdM+yGGlHhCUzWNatTEeHAXmcjgUUgGGba?= =?us-ascii?Q?WqN6r5koGAPdyhdJugdZnIv3JqeyFmSN8qyqPLlzyuM/p2mMDgniqZ/v+gNR?= =?us-ascii?Q?SgqKbi0Bylt8GcRWdeop/tkehlDnw2D4eIfKxbVhxIdR7Pr+0luY3rqaGH4U?= =?us-ascii?Q?xt24aabhJGbfT7uarosLMqVEtLIbiqBxFRIq6Gex2TrvLPafVhxa/jBHtI2M?= =?us-ascii?Q?PNhvCt9asjiWAFR2eVN6w6Gvx30LS9DU0iQPagTdROuB8O1bge7afYkCKD0W?= =?us-ascii?Q?FAGwr5YZFgt5yRp2Mcy3XVLIcZayMFOYoKrwVdA0SsHfVVX1I6cLxRGidF5I?= =?us-ascii?Q?OGOHN0aNFtZyUGkqaDLiAqnzthm+uunfHKnoE4G6vRnpXWabeeTMAXD/el3z?= =?us-ascii?Q?CnlwY6EMxMkKuVr0UxEAwUa888Th/88OJYWIwPLRrPlhlS2015E3mLlYYc1G?= =?us-ascii?Q?QEUBM4GdElvI6r0CHIR3i3mkQUwB7wZvKUeHymh4fsyIdSm?= X-Microsoft-Exchange-Diagnostics: 1; SN2PR03MB2365; 6:qwSSXN92eGhSEb+PRG2wSIOSZpi1Eegd1Epw7j3IkSRyhXq/umYbOnbVSEwMsj/P7LPg/MFI88BNKfVUVa4hE7gzAF5ZRWQQ/+YW7RIKa5P/Y0qzqf/NOazfrxz/Rbl4/QDHZEYCEt6MzeeqvbsDnlSKAPaRocR4puAkzOi0JEsruqdMt5hwnLjWV5BxTtOUXTLLrs+FVhQxbW55o305bDTNABhJZS2vqzaQCKcuwvPvwOvTLV5cu8MFwk5reBixu6x4egpCro/J/Hhp6R/CU3Io8Naxbv37cz8Th0YNziOdXdEf8j7D3vSZH2USEF1hQQbGIVFU+cPOvLdTI8tSIPX/w/XQKZyqBHD5PgbiSsg=; 5:4K9qvDULWadu5HW4at6RwL0JpMbIQiKjojJ0l269UHsXYMAdWKQ1dW87rokxYpajCOdzjl78iw1vi2DDoUHXqLni/ITRBlAJkqUfimlRHdbhHOlHlADtOvFs0vN3ZH3a6+7oxdUcGAmPBZt4xQZ5xwLSZ/4xuGK5SfT1AObIkxA=; 24:C9j9EHKYc2q9UCtQPJdyY4JMrEdSwD7s6Ldqbv14gD3xv6YWgrkR1JDn0c+qx4zjmDauIjxc8YFBAMoBBy3P/R8l1ymzknagRbEDX3sMMKo=; 7:2eeCSLkM7U4eDR/NSz09LpifNNYZEOVd5p6CVOJdFhiY6abErJeuSSIdP/ETEu+bdpHRVfdb7p/N4E24NL2cWZZn+CbmGvV8xynTt8yqJiJYNGnnBCsNB+C/kU0Qtchvdlg50dwYsN5H6SJ+2sFUNP97zh2aRNtyXEHHi9YDKGzAr/b9Bz8XA0MOHCHTgBweG+vQuHDNP5EK+2uIWo5E1h/hy5lunTXp60O56+T/Oehd9Dh/E/7/Xp4gURO/YT/e SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Nov 2017 10:01:22.3989 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 3efe9ef6-f2cf-438d-d556-08d5318ffc4b 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: SN2PR03MB2365 Subject: [PATCH v2 5/9] Platform/NXP: Add support for I2c driver 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: Wed, 22 Nov 2017 09:57:08 -0000 Content-Type: text/plain I2C driver produces gEfiI2cMasterProtocolGuid which can be used by other modules. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Meenakshi Aggarwal --- Platform/NXP/Drivers/I2cDxe/I2cDxe.c | 728 +++++++++++++++++++++++++++++++++ Platform/NXP/Drivers/I2cDxe/I2cDxe.h | 64 +++ Platform/NXP/Drivers/I2cDxe/I2cDxe.inf | 57 +++ 3 files changed, 849 insertions(+) create mode 100644 Platform/NXP/Drivers/I2cDxe/I2cDxe.c create mode 100644 Platform/NXP/Drivers/I2cDxe/I2cDxe.h create mode 100644 Platform/NXP/Drivers/I2cDxe/I2cDxe.inf diff --git a/Platform/NXP/Drivers/I2cDxe/I2cDxe.c b/Platform/NXP/Drivers/I2cDxe/I2cDxe.c new file mode 100644 index 0000000..1f43f9a --- /dev/null +++ b/Platform/NXP/Drivers/I2cDxe/I2cDxe.c @@ -0,0 +1,728 @@ +/** I2cDxe.c + I2c driver APIs for read, write, initialize, set speed and reset + + Copyright NXP 2017 + + 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 "I2cDxe.h" + +STATIC CONST EFI_PHYSICAL_ADDRESS I2cAddrArr[FixedPcdGet32 (PcdNumI2cController)] = { + FixedPcdGet64 (PcdI2c0BaseAddr), + FixedPcdGet64 (PcdI2c1BaseAddr), + FixedPcdGet64 (PcdI2c2BaseAddr), + FixedPcdGet64 (PcdI2c3BaseAddr) +}; + +STATIC CONST UINT16 ClkDiv[60][2] = { + { 20, 0x00 }, { 22, 0x01 }, { 24, 0x02 }, { 26, 0x03 }, + { 28, 0x04 }, { 30, 0x05 }, { 32, 0x09 }, { 34, 0x06 }, + { 36, 0x0A }, { 40, 0x07 }, { 44, 0x0C }, { 48, 0x0D }, + { 52, 0x43 }, { 56, 0x0E }, { 60, 0x45 }, { 64, 0x12 }, + { 68, 0x0F }, { 72, 0x13 }, { 80, 0x14 }, { 88, 0x15 }, + { 96, 0x19 }, { 104, 0x16 }, { 112, 0x1A }, { 128, 0x17 }, + { 136, 0x4F }, { 144, 0x1C }, { 160, 0x1D }, { 176, 0x55 }, + { 192, 0x1E }, { 208, 0x56 }, { 224, 0x22 }, { 228, 0x24 }, + { 240, 0x1F }, { 256, 0x23 }, { 288, 0x5C }, { 320, 0x25 }, + { 384, 0x26 }, { 448, 0x2A }, { 480, 0x27 }, { 512, 0x2B }, + { 576, 0x2C }, { 640, 0x2D }, { 768, 0x31 }, { 896, 0x32 }, + { 960, 0x2F }, { 1024, 0x33 }, { 1152, 0x34 },{ 1280, 0x35 }, + { 1536, 0x36 }, { 1792, 0x3A }, { 1920, 0x37 }, { 2048, 0x3B }, + { 2304, 0x3C }, { 2560, 0x3D }, { 3072, 0x3E }, { 3584, 0x7A }, + { 3840, 0x3F }, { 4096, 0x7B }, { 5120, 0x7D }, { 6144, 0x7E }, +}; + +/** + Calculate and set proper clock divider + + @param Rate clock rate + + @retval ClkDiv Value used to get frequency divider value + +**/ +STATIC +UINT8 +GetClk ( + IN UINT32 Rate + ) +{ + UINTN ClkRate; + UINT32 Div; + UINT8 ClkDivx; + + ClkRate = CalculateI2cClockRate (); + + Div = (ClkRate + Rate - 1) / Rate; + + if (Div < ClkDiv[0][0]) { + ClkDivx = 0; + } else if (Div > ClkDiv[ARRAY_SIZE (ClkDiv) - 1][0]){ + ClkDivx = ARRAY_SIZE (ClkDiv) - 1; + } else { + for (ClkDivx = 0; ClkDiv[ClkDivx][0] < Div; ClkDivx++); + } + + return ClkDivx; +} + +/** + Function used to check if i2c is in mentioned state or not + + @param I2cRegs Pointer to I2C registers + @param State i2c state need to be checked + + @retval EFI_NOT_READY Arbitration was lost + @retval EFI_TIMEOUT Timeout occured + @retval CurrState Value of state register + +**/ +STATIC +EFI_STATUS +WaitForI2cState ( + IN I2C_REGS *I2cRegs, + IN UINT32 State + ) +{ + UINT8 CurrState; + UINT64 Cnt; + + for (Cnt = 0; Cnt < 50000; Cnt++) { + MemoryFence (); + CurrState = MmioRead8 ((UINTN)&I2cRegs->I2cSr); + if (CurrState & I2C_SR_IAL) { + MmioWrite8 ((UINTN)&I2cRegs->I2cSr, CurrState | I2C_SR_IAL); + return EFI_NOT_READY; + } + + if ((CurrState & (State >> 8)) == (UINT8)State) { + return CurrState; + } + } + + return EFI_TIMEOUT; +} + +/** + Function to transfer byte on i2c + + @param I2cRegs Pointer to i2c registers + @param Byte Byte to be transferred on i2c bus + + @retval EFI_NOT_READY Arbitration was lost + @retval EFI_TIMEOUT Timeout occured + @retval EFI_NOT_FOUND ACK was not recieved + @retval EFI_SUCCESS Data transfer was succesful + +**/ +STATIC +EFI_STATUS +TransferByte ( + IN I2C_REGS *I2cRegs, + IN UINT8 Byte + ) +{ + EFI_STATUS Ret; + + MmioWrite8 ((UINTN)&I2cRegs->I2cSr, I2C_SR_IIF_CLEAR); + MmioWrite8 ((UINTN)&I2cRegs->I2cDr, Byte); + + Ret = WaitForI2cState (I2cRegs, IIF); + if ((Ret == EFI_TIMEOUT) || (Ret == EFI_NOT_READY)) { + return Ret; + } + + if (Ret & I2C_SR_RX_NO_AK) { + return EFI_NOT_FOUND; + } + + return EFI_SUCCESS; +} + +/** + Function to stop transaction on i2c bus + + @param I2cRegs Pointer to i2c registers + + @retval EFI_NOT_READY Arbitration was lost + @retval EFI_TIMEOUT Timeout occured + @retval EFI_SUCCESS Stop operation was successful + +**/ +STATIC +EFI_STATUS +I2cStop ( + IN I2C_REGS *I2cRegs + ) +{ + INT32 Ret; + UINT32 Temp; + + Temp = MmioRead8 ((UINTN)&I2cRegs->I2cCr); + + Temp &= ~(I2C_CR_MSTA | I2C_CR_MTX); + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, Temp); + + Ret = WaitForI2cState (I2cRegs, BUS_IDLE); + + if (Ret < 0) { + return Ret; + } else { + return EFI_SUCCESS; + } +} + +/** + Function to send start signal, Chip Address and + memory offset + + @param I2cRegs Pointer to i2c base registers + @param Chip Chip Address + @param Offset Slave memory's offset + @param Alen length of chip address + + @retval EFI_NOT_READY Arbitration lost + @retval EFI_TIMEOUT Failed to initialize data transfer in predefined time + @retval EFI_NOT_FOUND ACK was not recieved + @retval EFI_SUCCESS Read was successful + +**/ +STATIC +EFI_STATUS +InitTransfer ( + IN I2C_REGS *I2cRegs, + IN UINT8 Chip, + IN UINT32 Offset, + IN INT32 Alen + ) +{ + UINT32 Temp; + EFI_STATUS Ret; + + // Enable I2C controller + if (MmioRead8 ((UINTN)&I2cRegs->I2cCr) & I2C_CR_IDIS) { + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, I2C_CR_IEN); + } + + if (MmioRead8 ((UINTN)&I2cRegs->I2cAdr) == (Chip << 1)) { + MmioWrite8 ((UINTN)&I2cRegs->I2cAdr, (Chip << 1) ^ 2); + } + + MmioWrite8 ((UINTN)&I2cRegs->I2cSr, I2C_SR_IIF_CLEAR); + Ret = WaitForI2cState (I2cRegs, BUS_IDLE); + if ((Ret == EFI_TIMEOUT) || (Ret == EFI_NOT_READY)) { + return Ret; + } + + // Start I2C transaction + Temp = MmioRead8 ((UINTN)&I2cRegs->I2cCr); + // set to master mode + Temp |= I2C_CR_MSTA; + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, Temp); + + Ret = WaitForI2cState (I2cRegs, BUS_BUSY); + if ((Ret == EFI_TIMEOUT) || (Ret == EFI_NOT_READY)) { + return Ret; + } + + Temp |= I2C_CR_MTX | I2C_CR_TX_NO_AK; + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, Temp); + + // write slave Address + Ret = TransferByte (I2cRegs, Chip << 1); + if (Ret != EFI_SUCCESS) { + return Ret; + } + + if (Alen >= 0) { + while (Alen--) { + Ret = TransferByte (I2cRegs, (Offset >> (Alen * 8)) & 0xff); + if (Ret != EFI_SUCCESS) + return Ret; + } + } + return EFI_SUCCESS; +} + +/** + Function to check if i2c bus is idle + + @param Base Pointer to base address of I2c controller + + @retval EFI_SUCCESS + +**/ +STATIC +INT32 +I2cBusIdle ( + IN VOID *Base + ) +{ + return EFI_SUCCESS; +} + +/** + Function to initiate data transfer on i2c bus + + @param I2cRegs Pointer to i2c base registers + @param Chip Chip Address + @param Offset Slave memory's offset + @param Alen length of chip address + + @retval EFI_NOT_READY Arbitration lost + @retval EFI_TIMEOUT Failed to initialize data transfer in predefined time + @retval EFI_NOT_FOUND ACK was not recieved + @retval EFI_SUCCESS Read was successful + +**/ +STATIC +EFI_STATUS +InitDataTransfer ( + IN I2C_REGS *I2cRegs, + IN UINT8 Chip, + IN UINT32 Offset, + IN INT32 Alen + ) +{ + EFI_STATUS Status; + INT32 Retry; + + for (Retry = 0; Retry < 3; Retry++) { + Status = InitTransfer (I2cRegs, Chip, Offset, Alen); + if (Status == EFI_SUCCESS) { + return EFI_SUCCESS; + } + + I2cStop (I2cRegs); + + if (EFI_NOT_FOUND == Status) { + return Status; + } + + // Disable controller + if (Status != EFI_NOT_READY) { + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, I2C_CR_IDIS); + } + + if (I2cBusIdle (I2cRegs) < 0) { + break; + } + } + return Status; +} + +/** + Function to read data using i2c bus + + @param I2cBus I2c Controller number + @param Chip Address of slave device from where data to be read + @param Offset Offset of slave memory + @param Alen Address length of slave + @param Buffer A pointer to the destination buffer for the data + @param Len Length of data to be read + + @retval EFI_NOT_READY Arbitration lost + @retval EFI_TIMEOUT Failed to initialize data transfer in predefined time + @retval EFI_NOT_FOUND ACK was not recieved + @retval EFI_SUCCESS Read was successful + +**/ +STATIC +EFI_STATUS +I2cDataRead ( + IN UINT32 I2cBus, + IN UINT8 Chip, + IN UINT32 Offset, + IN UINT32 Alen, + IN UINT8 *Buffer, + IN UINT32 Len + ) +{ + EFI_STATUS Status; + UINT32 Temp; + INT32 I; + I2C_REGS *I2cRegs; + + I2cRegs = (I2C_REGS *)I2cAddrArr[I2cBus]; + + Status = InitDataTransfer (I2cRegs, Chip, Offset, Alen); + if (Status != EFI_SUCCESS) { + return Status; + } + + Temp = MmioRead8 ((UINTN)&I2cRegs->I2cCr); + Temp |= I2C_CR_RSTA; + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, Temp); + + Status = TransferByte (I2cRegs, (Chip << 1) | 1); + if (Status != EFI_SUCCESS) { + I2cStop (I2cRegs); + return Status; + } + + // setup bus to read data + Temp = MmioRead8 ((UINTN)&I2cRegs->I2cCr); + Temp &= ~(I2C_CR_MTX | I2C_CR_TX_NO_AK); + if (Len == 1) { + Temp |= I2C_CR_TX_NO_AK; + } + + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, Temp); + MmioWrite8 ((UINTN)&I2cRegs->I2cSr, I2C_SR_IIF_CLEAR); + + // Dummy Read to initiate recieve operation + MmioRead8 ((UINTN)&I2cRegs->I2cDr); + + for (I = 0; I < Len; I++) { + Status = WaitForI2cState (I2cRegs, IIF); + if ((Status == EFI_TIMEOUT) || (Status == EFI_NOT_READY)) { + I2cStop (I2cRegs); + return Status; + } + // + // It must generate STOP before read I2DR to prevent + // controller from generating another clock cycle + // + if (I == (Len - 1)) { + I2cStop (I2cRegs); + } else if (I == (Len - 2)) { + Temp = MmioRead8 ((UINTN)&I2cRegs->I2cCr); + Temp |= I2C_CR_TX_NO_AK; + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, Temp); + } + MmioWrite8 ((UINTN)&I2cRegs->I2cSr, I2C_SR_IIF_CLEAR); + Buffer[I] = MmioRead8 ((UINTN)&I2cRegs->I2cDr); + } + + I2cStop (I2cRegs); + + return EFI_SUCCESS; +} + +/** + Function to write data using i2c bus + + @param I2cBus I2c Controller number + @param Chip Address of slave device where data to be written + @param Offset Offset of slave memory + @param Alen Address length of slave + @param Buffer A pointer to the source buffer for the data + @param Len Length of data to be write + + @retval EFI_NOT_READY Arbitration lost + @retval EFI_TIMEOUT Failed to initialize data transfer in predefined time + @retval EFI_NOT_FOUND ACK was not recieved + @retval EFI_SUCCESS Read was successful + +**/ +STATIC +EFI_STATUS +I2cDataWrite ( + IN UINT32 I2cBus, + IN UINT8 Chip, + IN UINT32 Offset, + IN INT32 Alen, + OUT UINT8 *Buffer, + IN INT32 Len + ) +{ + EFI_STATUS Status; + I2C_REGS *I2cRegs; + INT32 I; + + I2cRegs = (I2C_REGS *)I2cAddrArr[I2cBus]; + + Status = InitDataTransfer (I2cRegs, Chip, Offset, Alen); + if (Status != EFI_SUCCESS) { + return Status; + } + + // Write operation + for (I = 0; I < Len; I++) { + Status = TransferByte (I2cRegs, Buffer[I]); + if (Status != EFI_SUCCESS) { + break; + } + } + + I2cStop (I2cRegs); + return Status; +} + +/** + Function to set i2c bus frequency + + @param This Pointer to I2c master protocol + @param BusClockHertz value to be set + + @retval EFI_SUCCESS Operation successfull +**/ + +EFI_STATUS +EFIAPI +SetBusFrequency ( + IN CONST EFI_I2C_MASTER_PROTOCOL *This, + IN OUT UINTN *BusClockHertz + ) +{ + I2C_REGS *I2cRegs; + UINT8 ClkId; + UINT8 SpeedId; + + I2cRegs = (I2C_REGS *)I2cAddrArr[PcdGet32 (PcdI2cBus)]; + + ClkId = GetClk (*BusClockHertz); + SpeedId = ClkDiv[ClkId][1]; + + // Store divider value + MmioWrite8 ((UINTN)&I2cRegs->I2cFdr, SpeedId); + + MemoryFence (); + + return EFI_SUCCESS; +} + +/** + Function to reset I2c Controller + + @param This Pointer to I2c master protocol + + @return EFI_SUCCESS Operation successfull +**/ +EFI_STATUS +EFIAPI +Reset ( + IN CONST EFI_I2C_MASTER_PROTOCOL *This + ) +{ + I2C_REGS *I2cRegs; + + I2cRegs = (I2C_REGS *)I2cAddrArr[PcdGet32 (PcdI2cBus)]; + + // Reset module + MmioWrite8 ((UINTN)&I2cRegs->I2cCr, I2C_CR_IDIS); + MmioWrite8 ((UINTN)&I2cRegs->I2cSr, 0); + + MemoryFence (); + + return EFI_SUCCESS; +} + +EFI_STATUS +EFIAPI +StartRequest ( + IN CONST EFI_I2C_MASTER_PROTOCOL *This, + IN UINTN SlaveAddress, + IN EFI_I2C_REQUEST_PACKET *RequestPacket, + IN EFI_EVENT Event OPTIONAL, + OUT EFI_STATUS *I2cStatus OPTIONAL + ) +{ + UINT32 Count; + INT32 Ret; + UINT32 Length; + UINT8 *Buffer; + UINT32 Flag; + UINT8 RegAddress; + + RegAddress = 0; + + if (RequestPacket->OperationCount <= 0) { + DEBUG ((DEBUG_ERROR,"%a: Operation count is not valid %d\n", + __FUNCTION__, RequestPacket->OperationCount)); + return EFI_INVALID_PARAMETER; + } + + for (Count = 0; Count < RequestPacket->OperationCount; Count++) { + Flag = RequestPacket->Operation[Count].Flags; + Length = RequestPacket->Operation[Count].LengthInBytes; + Buffer = RequestPacket->Operation[Count].Buffer; + + if (Length <= 0) { + DEBUG ((DEBUG_ERROR,"%a: Invalid length of buffer %d\n", + __FUNCTION__, Length)); + return EFI_INVALID_PARAMETER; + } + + if (Flag == I2C_FLAG_WRITE && Count == 0) { + RegAddress = *Buffer; + continue; + } else if (Flag == I2C_FLAG_READ) { + Ret = I2cDataRead (PcdGet32 (PcdI2cBus), SlaveAddress, + RegAddress, sizeof(SlaveAddress)/8, Buffer, Length); + if (Ret != EFI_SUCCESS) { + DEBUG ((DEBUG_ERROR,"%a: I2c read operation failed (error %d)\n", + __FUNCTION__, Ret)); + return Ret; + } + } else if (Flag == I2C_FLAG_WRITE) { + Ret = I2cDataWrite (PcdGet32 (PcdI2cBus), SlaveAddress, + RegAddress, sizeof(SlaveAddress)/8, Buffer, Length); + if (Ret != EFI_SUCCESS) { + DEBUG ((DEBUG_ERROR,"%a: I2c write operation failed (error %d)\n", + __FUNCTION__, Ret)); + return Ret; + } + } else { + DEBUG ((DEBUG_ERROR,"%a: Invalid Flag %d\n", + __FUNCTION__, Flag)); + return EFI_INVALID_PARAMETER; + } + } + + return EFI_SUCCESS; +} + +CONST EFI_I2C_CONTROLLER_CAPABILITIES I2cControllerCapabilities = { + 0, + 0, + 0, + 0 +}; + +STATIC EFI_I2C_MASTER_PROTOCOL gI2c = { + /// + /// Set the clock frequency for the I2C bus. + /// + SetBusFrequency, + /// + /// Reset the I2C host controller. + /// + Reset, + /// + /// Start an I2C transaction in master mode on the host controller. + /// + StartRequest, + /// + /// Pointer to an EFI_I2C_CONTROLLER_CAPABILITIES data structure containing + /// the capabilities of the I2C host controller. + /// + &I2cControllerCapabilities +}; + +STATIC I2C_DEVICE_PATH gDevicePath = { + { + { + HARDWARE_DEVICE_PATH, HW_VENDOR_DP, + { + sizeof (VENDOR_DEVICE_PATH), 0 + } + }, + EFI_CALLER_ID_GUID + }, + { + END_DEVICE_PATH_TYPE, + END_ENTIRE_DEVICE_PATH_SUBTYPE, + { + sizeof (EFI_DEVICE_PATH_PROTOCOL), 0 + } + } +}; + +/** + The Entry Point for I2C driver. + + @param[in] ImageHandle The firmware allocated handle for the EFI image. + @param[in] SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The entry point is executed successfully. + @retval other Some error occurs when executing this entry point. + +**/ +EFI_STATUS +EFIAPI +I2cDxeEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_STATUS Status; + + // + // Install I2c Master protocol on this controller + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &ImageHandle, + &gEfiI2cMasterProtocolGuid, + (VOID**)&gI2c, + &gEfiDevicePathProtocolGuid, + &gDevicePath, + NULL + ); + + ASSERT_EFI_ERROR (Status); + + return Status; +} + +/** + Unload function for the I2c Driver. + + @param ImageHandle[in] The allocated handle for the EFI image + + @retval EFI_SUCCESS The driver was unloaded successfully + @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle. + +**/ +EFI_STATUS +EFIAPI +I2cDxeUnload ( + IN EFI_HANDLE ImageHandle + ) +{ + EFI_STATUS Status; + EFI_HANDLE *HandleBuffer; + UINTN HandleCount; + UINTN Index; + + // + // Retrieve all I2c handles in the handle database + // + Status = gBS->LocateHandleBuffer (ByProtocol, + &gEfiI2cMasterProtocolGuid, + NULL, + &HandleCount, + &HandleBuffer); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Disconnect the driver from the handles in the handle database + // + for (Index = 0; Index < HandleCount; Index++) { + Status = gBS->DisconnectController (HandleBuffer[Index], + gImageHandle, + NULL); + } + + // + // Free the handle array + // + gBS->FreePool (HandleBuffer); + + // + // Uninstall protocols installed by the driver in its entrypoint + // + Status = gBS->UninstallMultipleProtocolInterfaces (ImageHandle, + &gEfiI2cMasterProtocolGuid, &gI2c, + &gEfiDevicePathProtocolGuid, &gDevicePath, + NULL); + + return Status; +} diff --git a/Platform/NXP/Drivers/I2cDxe/I2cDxe.h b/Platform/NXP/Drivers/I2cDxe/I2cDxe.h new file mode 100644 index 0000000..01c9d8c --- /dev/null +++ b/Platform/NXP/Drivers/I2cDxe/I2cDxe.h @@ -0,0 +1,64 @@ +/** I2cDxe.h + Header defining the constant, base address amd function for I2C controller + + 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 __I2C_DXE_H___ +#define __I2C_DXE_H__ + +#include + +#define I2C_CR_IIEN (1 << 6) +#define I2C_CR_MSTA (1 << 5) +#define I2C_CR_MTX (1 << 4) +#define I2C_CR_TX_NO_AK (1 << 3) +#define I2C_CR_RSTA (1 << 2) + +#define I2C_SR_ICF (1 << 7) +#define I2C_SR_IBB (1 << 5) +#define I2C_SR_IAL (1 << 4) +#define I2C_SR_IIF (1 << 1) +#define I2C_SR_RX_NO_AK (1 << 0) + +#define I2C_CR_IEN (0 << 7) +#define I2C_CR_IDIS (1 << 7) +#define I2C_SR_IIF_CLEAR (1 << 1) + +#define BUS_IDLE (0 | (I2C_SR_IBB << 8)) +#define BUS_BUSY (I2C_SR_IBB | (I2C_SR_IBB << 8)) +#define IIF (I2C_SR_IIF | (I2C_SR_IIF << 8)) + +#define I2C_FLAG_WRITE 0x0 + +typedef struct { + VENDOR_DEVICE_PATH Guid; + EFI_DEVICE_PATH_PROTOCOL End; +} I2C_DEVICE_PATH; + +/** + Record defining i2c registers +**/ +typedef struct { + UINT8 I2cAdr; + UINT8 I2cFdr; + UINT8 I2cCr; + UINT8 I2cSr; + UINT8 I2cDr; +} I2C_REGS ; + +UINT32 +CalculateI2cClockRate ( + VOID + ); + +#endif diff --git a/Platform/NXP/Drivers/I2cDxe/I2cDxe.inf b/Platform/NXP/Drivers/I2cDxe/I2cDxe.inf new file mode 100644 index 0000000..6768b14 --- /dev/null +++ b/Platform/NXP/Drivers/I2cDxe/I2cDxe.inf @@ -0,0 +1,57 @@ +# @file +# +# Component description file for I2c driver +# +# Copyright (c) 2015, Freescale Semiconductor, Inc. All rights reserved. +# Copyright NXP 2017 +# +# 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 = I2cDxe + FILE_GUID = 5f2927ba-1b04-4d5f-8bef-2b50c635d1e7 + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = I2cDxeEntryPoint + UNLOAD = I2cDxeUnload + +[Sources.common] + I2cDxe.c + +[LibraryClasses] + ArmLib + IoLib + MemoryAllocationLib + PcdLib + SocLib + TimerLib + UefiDriverEntryPoint + UefiLib + +[Packages] + MdePkg/MdePkg.dec + Platform/NXP/NxpQoriqLs.dec + +[Protocols] + gEfiI2cMasterProtocolGuid + +[Pcd] + gNxpQoriqLsTokenSpaceGuid.PcdI2cBus + gNxpQoriqLsTokenSpaceGuid.PcdI2cSpeed + gNxpQoriqLsTokenSpaceGuid.PcdI2c0BaseAddr + gNxpQoriqLsTokenSpaceGuid.PcdI2c1BaseAddr + gNxpQoriqLsTokenSpaceGuid.PcdI2c2BaseAddr + gNxpQoriqLsTokenSpaceGuid.PcdI2c3BaseAddr + gNxpQoriqLsTokenSpaceGuid.PcdNumI2cController + +[Depex] + TRUE -- 1.9.1