From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=104.47.36.79; helo=nam02-sn1-obe.outbound.protection.outlook.com; envelope-from=meenakshi.aggarwal@nxp.com; receiver=edk2-devel@lists.01.org Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0079.outbound.protection.outlook.com [104.47.36.79]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 698BC21B00DD4 for ; Sun, 26 Nov 2017 20:59:49 -0800 (PST) Received: from MWHPR03CA0013.namprd03.prod.outlook.com (10.175.133.151) by MWHPR03MB2702.namprd03.prod.outlook.com (10.168.207.136) 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:08 +0000 Received: from BY2FFO11FD005.protection.gbl (2a01:111:f400:7c0c::101) by MWHPR03CA0013.outlook.office365.com (2603:10b6:300:117::23) 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:08 +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 BY2FFO11FD005.mail.protection.outlook.com (10.1.14.126) 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:08 +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 vAR53iMX000785; Sun, 26 Nov 2017 22:04:05 -0700 From: Meenakshi Aggarwal To: , , , Date: Mon, 27 Nov 2017 16:21:53 +0530 Message-ID: <1511779917-9255-6-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: 131562326487944791; (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)(376002)(39860400002)(39380400002)(346002)(2980300002)(1109001)(1110001)(339900001)(189002)(199003)(106466001)(498600001)(76176999)(15188155005)(16799955002)(189998001)(53936002)(551934003)(50986999)(33646002)(53376002)(105606002)(4326008)(6306002)(5660300001)(50466002)(2950100002)(48376002)(6666003)(47776003)(966005)(2201001)(305945005)(2906002)(104016004)(356003)(8656006)(81156014)(81166006)(575784001)(8936002)(86362001)(36756003)(316002)(97736004)(110136005)(50226002)(68736007)(8676002)(54906003)(16586007)(51416003)(77096006)(85426001)(44824005)(19627235001); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR03MB2702; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BY2FFO11FD005; 1:f5FDnkcFnHrAcWoiB8oNJQa/ndgvmEZfzkELr2eLGq058DR9baMHyWmzjaRkaHlVk+FDq2h4f0gICC/46hN6MOfIma8E8U+ClRqbwj0rz7lRiDoKnXBpeQw5kV/s9DC3 MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 0267b2e0-aac6-4c9e-4367-08d535544a87 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(5600026)(4604075)(4534020)(4628075)(201703131517081)(2017052603258); SRVR:MWHPR03MB2702; X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2702; 3:rXw/bSxYwp0FYTWOPIt7HOl/3m/q0TDDGs/i6+Wnyr4lmOeXS+DJgVozvjZN0s9O0Qv1Bw8W3lGbR+EgTYE86tkTJ02/GQd6br1uFucijtoLttgCf6sTPYf9LwgEjFziLdUGmiB0lZgpkQaGHuIK+gIrX8axVjygUxGYNgMtxU5xE4BzzwwPlHMBjGVGxf6F8xFOrRzHEBVcVeI9I4dVyIkEIRSyP59jnhbkEm827kP2EBWVGJd+TuWYi+O/0H/S54kZ5ypFDRP/lbrxv1GNn7AShUXz2XNrkqe2vrFl78+8AuFVPDfTkL304okD4f/53nBjtqi/3ztm+KN0yHZqh8bAfixxuufY3qyzCIwIHXc=; 25:13fTqMWRqb/4YbvVRuOOrKbjJ4LhDqIjTlwUljHgdSmQS/dQISomt3FmNHxvJGVV4Fb3zGta8dsomwHC556OaTwtLAsXV86ZUVU650bsyo3+UDtPMI7MQcb2qH2yaFN2SacSXEdX+g8+OiLhJ6blHH19CnXQ1XVfI1W33NdfepIGU7TL/ynQ3kGOwkeLowPiYagfFWxq66d0tpzLDQPMMu8H3IiNOwX/2Km16ZunnTTk7mvE3nrryEDH1z9bUhT6poxmlWlXTkr1wQcGfxhe3V9+QSFDLe3OsmCbzQA8oynQruvGAef6GVxVui+cd0qH3OlK8pEPyGzYWfFzEDrMRw== X-MS-TrafficTypeDiagnostic: MWHPR03MB2702: X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2702; 31:FpfLyxO7rinF/tYuUiKLS1cvoF3lRDGhi7dJGHVaZhtgSX9B2S13zrDRlitHcsdHvB64mukqMGZ3CCNF3ZM3fpKbAu5WPilzCgVWLAd2ifmrPJa2J7OPKqqDIWKlN5nj+bMjkbT2SRNxtqjDJjiv6brFfl7TtiBftQqSfQ6EXB68FiR0XBX3f9dlUQzvB5kFUVKq+L7iCwbOJy/IzwWDA8fDqJy3BCJu47TW3yyUIEI=; 4:c3mtb0lo2wVdkk+G6+vvyrwK/Drb9/2w5iGO8invoQamu5wtsKnQNhzHzaWk9LXlNVWDjne9orzF9kje74ALI9rK+opbwZYmaby9uw12B4fVnkxCymT5rjtt2KKfOWcF0pS0XHsOPsDgATrHpZ6zNdkPMqNA+HXo16BYiFuvvSimiRK25l4hPO6OzTRGGay4FsGWS1ADGIKRNHXHTD9379OaDZJIx6OM3J0Z31x/tEIloJtBK/udbfTGRquwvdzzTgW34oNg81WGuoZDrTdphIp8b1Qiqx087UVieipm+JBoWv3zHEfKn7wFGG4vtvXP X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095135)(2401047)(8121501046)(5005006)(10201501046)(3002001)(3231022)(93006095)(93001095)(6055026)(6096035)(20161123565025)(201703131430075)(201703131433075)(201703131448075)(201703161259150)(201703151042153)(20161123559100)(20161123556025)(20161123561025)(20161123563025)(201708071742011); SRVR:MWHPR03MB2702; BCL:0; PCL:0; RULEID:(100000803101)(100110400095)(400006); SRVR:MWHPR03MB2702; X-Forefront-PRVS: 0504F29D72 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; MWHPR03MB2702; 23:DvGiIizyeCok/VS8yHVYErlVIl4FcPXalPkhMHZ++?= =?us-ascii?Q?nVrBUr+UbJrItTDyQrEyuuOrJlqiGtyF389oFxx20CLwUrEkg6yqMSHybExg?= =?us-ascii?Q?VnTPrX38yE+V8X5nIg6WOjZl0LkbChA9B43k6JmgibS9236mtJ2JshiDwexV?= =?us-ascii?Q?3kt7bhx/9x38LbDosPioUECQCvkmd/B7dvrc3hZQFLjgkIfwenANqYer3Lyq?= =?us-ascii?Q?shWBz3TjlBjLu47eWCvPZpCHh4CIxeANtJIFwWt+TGurq245eMv3a9FQXzpK?= =?us-ascii?Q?rPQT68XVHspASL5jucrFu1aY9PskyZ92O5bYfH3n5AWjBKaJdvvPFFSNkFfS?= =?us-ascii?Q?ghvDUoSDRgAJd5Bfgp8tWJx1Xjf/m5LoIkiMkQtv6jxZ1Wz4tB0wFS37IAyY?= =?us-ascii?Q?I1V4btKqoS+xtqcOyevaOCxc1rpxTggC05YUFJ2rAySTiBvarBvWmFH79UV7?= =?us-ascii?Q?AIcoCUR+7+8dTu5NEQBPdKOsQQB8OHDeTc7T5HQAXizGKQKmPlz4WWyT0Ong?= =?us-ascii?Q?p+iJ9ZT+KgwcPm5eEUXYS/pfiodKmG+oURij9qDi1UEKsNwl1ZUOCOBVX/qA?= =?us-ascii?Q?3qvkhhcEsHIyEM+H0uDabvI8i4OEewkaE+2ADPKmDCl56m5+4+0Q5ZFm9adV?= =?us-ascii?Q?0DCL+j9aS+z8mJBl3WbtLPectYbQwRIvZLVpG/dtFv7QgPEWtPPyeHNiRYUU?= =?us-ascii?Q?sx4rc+OnM8DaCtg3yG4YAmJ64WPgt1Y8ZqUAqn59+bt5M/SSAXAopqAS6ZLx?= =?us-ascii?Q?RKAYYRdqeHVz+eVxQ+IBDsH0WgjiPV3zgXPC2GSn3NIHzDHPoet5gjMIxIOj?= =?us-ascii?Q?/Gec9valemAHe/YjVdhSikWTkE/PnT1QZIHL03cqoUAgp7hyTFEdOzaRl4Fv?= =?us-ascii?Q?CpZXRzIvtWvlR6UbD3+YmRprt2QrnSKsKAOZY0DqmlEocrOlfHfJZ/hG34HK?= =?us-ascii?Q?mRS9PNQ6GSgBS4pLQJbc/w06V9sYpfwpLvGnpW1cKIwjnezF+xPeWNYPz22L?= =?us-ascii?Q?XoqxYuknXikDzQPOxpcRQFkwGP1lU6yE/F/4fwlvUj78aFKoCxakED33T9DF?= =?us-ascii?Q?Zgnv8K8S4wVj7DaMXUgsNFq8EWcO6ADeHY/ktKMjQBrQAaCJVIWFwW2KEB7e?= =?us-ascii?Q?13TVV0BuFjZ0POBfokAW+ExYiMp1ER2gOmklt7GNL4b5Call7FOuunNGVELz?= =?us-ascii?Q?mOXfcPxWbxryH/7eW1FjHhXaT7oTaqm5b4pmNC6X7vcyAj8zrfdmyiRExW5d?= =?us-ascii?Q?Ap8WlKTv6xlpXJ7/xvPZzAcmbUbEp1kln30ShSTMVM6+0R6CXxre3s2pKtvH?= =?us-ascii?Q?wxmsLPj9312CLsPSbyAXe23xciSkL/ay1EhR7IsEvyCWlzYkFqKsjHsl1Swk?= =?us-ascii?Q?MnY+A=3D=3D?= X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2702; 6:jQ5TkDvhDgOINlMJVob7QBS9ZWTJo7OQlkiFW0bW+cWWP6pyvym0GYWapfzBB5Z4escZ8jJ47u0Gu2NDsgwrawQCpM1GozLbXYKJbfjYxdFk8y2W7yOzN34MvwTaOLgDlDL0800Mb1K7N0OOUOK80wAMVbcl53z+KyE5AqEOQ/Otw8ZSfz2XI3AKpPT2AQJtvDVi1PbwjRhTj5oiuZ5s0k6gEHP7zD3mzysKnk+4n3aUAr3MypjuyuwASK54f+1Wq7u6LorGWewjF5eDBaTGPQTYN9xVQLCWKVtXfMiWVbMLvoEwOoa0olndb8arGT4HwUCKVe4yOHV0sqRbz2itoV8ghPEgVj13rHclTZ+9FeQ=; 5:2XPfVhWpx4NYr3b6hx4ImeuVY9sPpJZZGqY76uhLjmbXKaAkmQ2JuqPuPnxe9LS15pzNCZ9eCFF2HSl1w0xkaPZX1TBVj/3uPly4hlUsbDSLlSCNM5jBflCJL+pR0qlUd5r9k1YlGjt199EHFcvt2sq3qBWUuNIdFeDt8lFM4hc=; 24:Q6gSCOKqVccztdPHJyAgK0mw6E/8jrjPMT50DkYl+exPTbgndGvUEbT7MkFG6sqbIs1ZoH9vv1bd3pxPzS3/miiKCVL+WQ3NGJtza5WEAfo=; 7:VFnXyPL9kT8eKsLh1z/TzXR33ra/2nHbmAlaWDKInkhWfmr8xCBWkVVWYjItljGgCZeNlXmHNruUdU2OR7bJMgSnafyAE7Gy7w+xBid7wCPRLEsj2gN6wjnFj2K+PMCDUs8kQLkj4RzlF25hfgYzeNOkZm2jpE3jhbZyFExE5PPWLN9/8cQJKZgKdQws17uqvmQbVAOQWU8ZO2l7yhpeC67uO5m3axKddtYLsQxWqLXkbf5QXUii5m9EtFljtund SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 Nov 2017 05:04:08.4824 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 0267b2e0-aac6-4c9e-4367-08d535544a87 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: MWHPR03MB2702 Subject: [PATCH edk2-platforms] [PATCH v3 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: Mon, 27 Nov 2017 04:59:49 -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..30eb6f4 --- /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..604396c --- /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..d6496cf --- /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