From patchwork Mon Oct 28 05:32:19 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Troy Mitchell X-Patchwork-Id: 839932 Received: from mail-pl1-f195.google.com (mail-pl1-f195.google.com [209.85.214.195]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 965E018D63A; Mon, 28 Oct 2024 05:32:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.195 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730093560; cv=none; b=RLn/tNUs0nXcO4kzkDihIAfriiF9RlFqeF/2VS57tJoSJuSejvNkFc0Yp9h8/Ftytw86oqw1G4locFOMHuIMAxYQtzfJnUeYYN1Myv733zCACKt8Xl6SMyswwTa4PFvSZ4ML10CbJSlUqlt6WXJmE7FGfd267I8GS+mKyTSzW2o= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730093560; c=relaxed/simple; bh=9ODG9hyXhdmAAGRH9ua3WZ/J3tbFi/hoEZZb8ZSdZoQ=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=Yd78JlO7L3gqR9XW1dkQyqdHorX/p2H8ezTl7oXv7rDcdTquPgMY2U37Z9Py+krV4HUd4rLgIENnPbq6CWaCOEewt62kIj1IPEYmqqRRkm5fZJ5wVscz00LJcmotoTeWeyiBE/IaMuRZnyRzYrzSgrbbVzVDDXXrT3gY/RKTfTE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=LytCWwNY; arc=none smtp.client-ip=209.85.214.195 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="LytCWwNY" Received: by mail-pl1-f195.google.com with SMTP id d9443c01a7336-20cf6eea3c0so29869975ad.0; Sun, 27 Oct 2024 22:32:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1730093558; x=1730698358; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=2Rxzu8/nDrEhPkjYLwk7/lZitCFsLtWr9y8ItsfrPD0=; b=LytCWwNYDJ7JrOb61Ks3NUrTqz8Qd2zPzxgXasJMS2P1AdwSE4dGmRle/Cs9yJqplV AlIc0ALxRWxG/aCIh2JZX31O82cgcc72wWhXA/PkRIl4Px2zY73EL1nVBTxIXlf4le9w eHVpFZRg0eTpeFpqwA9aeGgA7k5dJMRBIXUlvpbwNORlWIFF57sO8PsZAPgYsMV7fIoR Vu64F7TT2lyeHUauJjT+eK5sh4Hrr+S4QIId6rs9gjGN1Gji5HLJNWtQ6Dbwcgg8yb+n osQb2be+BxBpC0O9t+ez6GDhgTnzJZ9Muzv508aiiNjuZD9hLIc2KY+g0lhLz5yiKTfj Q1BQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730093558; x=1730698358; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=2Rxzu8/nDrEhPkjYLwk7/lZitCFsLtWr9y8ItsfrPD0=; b=qBx46MWzNhq1si35OX3Rx1JVKdbo2252T3NIKZnZgTuxc9afkkhwVL/t0UexGp7wXl jigDMQ6Q/LC2kFTbUc6Wi0mIGy76svMGxHWjAeAgKf7yinG4Ciux6qK9VBgqLmiA/xNk 6XWhvnTac4JFvHCxaAU6tzWT763H7xX7I4nfBhrTWQQ05klssXgGxlE2NOUWcTeK1Bns A07za949yFm58dIKWvJYnQz87xBmKEpy4ROjP+LL5izHdUrjtMPwBg4VZgP5cg8efW1i +u3QdW9H2IpP2DW5Svo3d6vEqC3aD+qJ2T0gnXV/6A9/WFxsdXhL+c+9P6wKoBtz80QN 32dA== X-Forwarded-Encrypted: i=1; AJvYcCVnOstgP7f/1NTHfgE5H1G1MT9Z4QrMvc1VfeacCNUDYW34PSC4XK6Ov7OXg4UCHa+q890gLZgYBfRiXbLp@vger.kernel.org, AJvYcCW7ZwlYB3oPtrEiN+QrIFWvCoDLFkGQeIaREp2zW3fZoubCEOBIHOjb4k8PyLFhX0guEvqKvBeMGRTR@vger.kernel.org, AJvYcCWSHIafo1ou/UM+27MknjodyylnbUKWBG+xlAAbzmnZRbaQifD6y4vc35U2K6BnkXJMiJ9M0qMxhA8z@vger.kernel.org X-Gm-Message-State: AOJu0Yz/wnAv9qWJD7DP+19noQ/EA3U4QNh7RztDtPASdA6gh0H7OoQ1 kdO7QSHV6/OqiZ1gKKrpj0uIqa7ehGW6bGNOMEX7xbJhZcYDua8F X-Google-Smtp-Source: AGHT+IE617UFyReq24qO6TxPn5hfQbe0B4rWfputWH0r22erL33CcMpWVuxE+z7NOwutSFUjIDEE5A== X-Received: by 2002:a17:903:11cd:b0:20c:f0dd:c408 with SMTP id d9443c01a7336-210c6897f24mr90859605ad.20.1730093557918; Sun, 27 Oct 2024 22:32:37 -0700 (PDT) Received: from troy-WUJIE14-PRO.tailc1d423.ts.net ([120.211.145.167]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-210bc02e941sm43216475ad.204.2024.10.27.22.32.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 27 Oct 2024 22:32:37 -0700 (PDT) From: Troy Mitchell X-Google-Original-From: Troy Mitchell To: andi.shyti@kernel.org, robh@kernel.org, krzk+dt@kernel.org, conor+dt@kernel.org Cc: troymitchell988@gmail.com, linux-i2c@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-riscv@lists.infradead.org Subject: [PATCH v2 1/2] dt-bindings: i2c: spacemit: add support for K1 SoC Date: Mon, 28 Oct 2024 13:32:19 +0800 Message-Id: <20241028053220.346283-2-TroyMitchell988@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241028053220.346283-1-TroyMitchell988@gmail.com> References: <20241028053220.346283-1-TroyMitchell988@gmail.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 The I2C of K1 supports fast-speed-mode and high-speed-mode, and supports FIFO transmission. Signed-off-by: Troy Mitchell --- .../bindings/i2c/spacemit,k1-i2c.yaml | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Documentation/devicetree/bindings/i2c/spacemit,k1-i2c.yaml diff --git a/Documentation/devicetree/bindings/i2c/spacemit,k1-i2c.yaml b/Documentation/devicetree/bindings/i2c/spacemit,k1-i2c.yaml new file mode 100644 index 000000000000..57af66f494e7 --- /dev/null +++ b/Documentation/devicetree/bindings/i2c/spacemit,k1-i2c.yaml @@ -0,0 +1,51 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/i2c/spacemit,k1-i2c.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: I2C controller embedded in SpacemiT's K1 SoC + +maintainers: + - Troy Mitchell + +properties: + compatible: + const: spacemit,k1-i2c + + reg: + maxItems: 2 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + + clock-frequency: + description: + Desired I2C bus clock frequency in Hz. As only fast and high-speed + modes are supported by hardware, possible values are 100000 and 400000. + enum: [100000, 400000] + default: 100000 + +required: + - compatible + - reg + - interrupts + - clocks + +unevaluatedProperties: false + +examples: + - | + i2c@d4010800 { + compatible = "spacemit,k1-i2c"; + reg = <0x0 0xd4010800 0x0 0x38>; + interrupt-parent = <&plic>; + interrupts = <36>; + clocks = <&ccu 90>; + clock-frequency = <100000>; + }; + +... From patchwork Mon Oct 28 05:32:20 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Troy Mitchell X-Patchwork-Id: 839222 Received: from mail-pl1-f194.google.com (mail-pl1-f194.google.com [209.85.214.194]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 234D71DA5A; Mon, 28 Oct 2024 05:32:44 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.194 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730093567; cv=none; b=nZ5FVUqj2DXexNg+BbeVrdoZ4PNJapEpHh3XlqZ5e+7BFuP9QVzUMTKtq7dKHXNpqUH44eubPwLpurpcDrCCfoCdsfkbCAfr/JZJw6ExIU2wGRKGwTXJLiB0v/diuxORC7UedmIKO2XHVaeSeDrYBO4ODkL7HulraqoDZk6KECc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730093567; c=relaxed/simple; bh=o20HoDSw39tnvfuRTu/joVZWLy5gNkg9/sWlICNmnuU=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=rp6DmG0h1pLTshMHEX05Lnd8Gy12hAbMUfivByaEjb9R4EXQSZUJaUWBkasQ7uoH93YVCMhXXk/7V4GPevrq5Bh7nSYnBNSbq3JV90hW1fP0N4paHwnNbtH20jKWn23AuB3i5tJovYuywT1T4F/iMk0cVuYOT8c8E/G3zDyNw40= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=BBBGV18X; arc=none smtp.client-ip=209.85.214.194 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="BBBGV18X" Received: by mail-pl1-f194.google.com with SMTP id d9443c01a7336-20ca7fc4484so25835115ad.3; Sun, 27 Oct 2024 22:32:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1730093563; x=1730698363; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=e2boxZqsgzmAXMQP+Yr/T00L5rNoRmEc3fqLr5HLeNI=; b=BBBGV18XodtjyrSQ025rFoU9WVft+1+K6PEZ4Dn62tmqlLIxOYZ1pv3tTb3wzr0X6a GML3eYzIn3wT91QTRp4Ub2+l9e6ccooq6CWSBAhI95Rl1A29qzsrkYXptTWY41hXK9hU GATKNvaAXqGG+5yv02ILhu9vYwmW1H1TyEyaArBya5KiJK8qRPOlWhTI64ewG9HmhLih Hv6BpOrPUUSjd64cW6esi/QnTdmk1nV8LIdhVTtfo3zJ3lrTF/5ItmK+brTKVpjGoOzO WIP3sR+zaDy7pbYx0pWhjMSTs+XNx13E4G3Vm357gOUKrYKO4aOa5SMUSj/1xOvwcEHB WVaQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730093563; x=1730698363; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=e2boxZqsgzmAXMQP+Yr/T00L5rNoRmEc3fqLr5HLeNI=; b=RTAlxq3qsR52tW9yHmyHb6gPy3/b2lh9rig1Nz0gGd/VFgV/IoMDT8gw9ora+h/igI I7lqY/xdniZJ9V+CJjpX+cCHtD5sB5gX1yRee7NF0Ih3PqoTW5hTHGavEcqvndRYbp1N N1+ax+VLMkxe71q8ak9yGLLjS2UXdMr0vEjG2dwGeO+h8VAUtdcEg/TUuCu9idCi4oxb TL/7WfnJh4c45/yVZiZMs7Gm7FOC4PZiKAk3H7+dsuapkMV+EGxLVfB3dAWRhzZ4O2+i zASOjS/bRekOIOyeh9Rt97HSwAPTPLka7QgSEbaiPJ1ynbi0PKnboE9VvUMPjehOcnpb jb4w== X-Forwarded-Encrypted: i=1; AJvYcCW8jG0LQ7aZ5jGuKkkH3sdzKoyaZUXtcSq+yzcjQzCyaJUxzSM7l7Oh3jVb/A6mQvEX5CF6DfIBMMc0@vger.kernel.org, AJvYcCWbdMvJsBp3C8b+5/dreuiIowezQsx9Lz8V8iP8QpZi4m2ah3hvnlCoRJYoSOJFs2uSDPchNKkfAimHnZHH@vger.kernel.org, AJvYcCXkNmSRhi70AUE50pSmyc7Fa5MVXvvSh3u4qwkmLRQNOHb2ZQe4fXUVmpopXrQYvSEhGEUgqlJU/JPw@vger.kernel.org X-Gm-Message-State: AOJu0YxxzdTdityCZQnz/t//YcyBOov/CLadkRl/5qTTvDSt3fK2iGAA bOMzsbUVQ3/9KG+BKD8Q9nwYIrprbZTnT/eoIHtnQJMNYfP6vTf3 X-Google-Smtp-Source: AGHT+IE+gm5K5E7r1O0TdDy/rukq5lyE89pmWig+/cILi8n03/tQgGxRWZ49XZPr3NYuBnrY9DDhwA== X-Received: by 2002:a17:903:2345:b0:20c:7be3:2832 with SMTP id d9443c01a7336-210c6ae34d3mr96973255ad.31.1730093563254; Sun, 27 Oct 2024 22:32:43 -0700 (PDT) Received: from troy-WUJIE14-PRO.tailc1d423.ts.net ([120.211.145.167]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-210bc02e941sm43216475ad.204.2024.10.27.22.32.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 27 Oct 2024 22:32:42 -0700 (PDT) From: Troy Mitchell X-Google-Original-From: Troy Mitchell To: andi.shyti@kernel.org, robh@kernel.org, krzk+dt@kernel.org, conor+dt@kernel.org Cc: troymitchell988@gmail.com, linux-i2c@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-riscv@lists.infradead.org Subject: [PATCH v2 2/2] i2c: spacemit: add support for SpacemiT K1 SoC Date: Mon, 28 Oct 2024 13:32:20 +0800 Message-Id: <20241028053220.346283-3-TroyMitchell988@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241028053220.346283-1-TroyMitchell988@gmail.com> References: <20241028053220.346283-1-TroyMitchell988@gmail.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This patch introduces basic I2C support for the SpacemiT K1 SoC, utilizing interrupts for transfers. The driver has been tested using i2c-tools on a Bananapi-F3 board, and basic I2C read/write operations have been confirmed to work. Signed-off-by: Troy Mitchell --- drivers/i2c/busses/Kconfig | 18 + drivers/i2c/busses/Makefile | 1 + drivers/i2c/busses/i2c-k1.c | 658 ++++++++++++++++++++++++++++++++++++ 3 files changed, 677 insertions(+) create mode 100644 drivers/i2c/busses/i2c-k1.c diff --git a/drivers/i2c/busses/Kconfig b/drivers/i2c/busses/Kconfig index 6b3ba7e5723a..38ebfd38dc41 100644 --- a/drivers/i2c/busses/Kconfig +++ b/drivers/i2c/busses/Kconfig @@ -779,6 +779,24 @@ config I2C_JZ4780 If you don't know what to do here, say N. +config I2C_K1 + tristate "Spacemit K1 I2C adapter" + depends on HAS_IOMEM + help + This option enables support for the I2C interface on the Spacemit K1 + platform. + + If you enable this configuration, the kernel will include support for + the I2C adapter specific to the Spacemit K1 platform. This driver ca + be used to manage I2C bus transactions, which are necessary for + interfacing with I2C peripherals such as sensors, EEPROMs, and other + devices. + + This driver can also be compiled as a module. If you choose to build + it as a module, the resulting kernel module will be named `i2c-k1`. + Loading this module will enable the I2C functionality for the K1 + platform dynamically, without requiring a rebuild of the kernel. + config I2C_KEBA tristate "KEBA I2C controller support" depends on HAS_IOMEM diff --git a/drivers/i2c/busses/Makefile b/drivers/i2c/busses/Makefile index ecc07c50f2a0..9744b0e58598 100644 --- a/drivers/i2c/busses/Makefile +++ b/drivers/i2c/busses/Makefile @@ -76,6 +76,7 @@ obj-$(CONFIG_I2C_IMX) += i2c-imx.o obj-$(CONFIG_I2C_IMX_LPI2C) += i2c-imx-lpi2c.o obj-$(CONFIG_I2C_IOP3XX) += i2c-iop3xx.o obj-$(CONFIG_I2C_JZ4780) += i2c-jz4780.o +obj-$(CONFIG_I2C_K1) += i2c-k1.o obj-$(CONFIG_I2C_KEBA) += i2c-keba.o obj-$(CONFIG_I2C_KEMPLD) += i2c-kempld.o obj-$(CONFIG_I2C_LPC2K) += i2c-lpc2k.o diff --git a/drivers/i2c/busses/i2c-k1.c b/drivers/i2c/busses/i2c-k1.c new file mode 100644 index 000000000000..844d4a721760 --- /dev/null +++ b/drivers/i2c/busses/i2c-k1.c @@ -0,0 +1,658 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * Copyright (C) 2024 Troy Mitchell + */ + + #include + #include + #include + #include + #include + #include + +/* spacemit i2c registers */ +#define ICR 0x0 /* Control Register */ +#define ISR 0x4 /* Status Register */ +#define ISAR 0x8 /* Slave Address Register */ +#define IDBR 0xc /* Data Buffer Register */ +#define ILCR 0x10 /* Load Count Register */ +#define IWCR 0x14 /* Wait Count Register */ +#define IRST_CYC 0x18 /* Bus reset cycle counter */ +#define IBMR 0x1c /* Bus monitor register */ +#define IWFIFO 0x20 /* Write FIFO Register */ +#define IWFIFO_WPTR 0x24 /* Write FIFO Write Pointer Register */ +#define IWFIFO_RPTR 0x28 /* Write FIFO Read Pointer Register */ +#define IRFIFO 0x2c /* Read FIFO Register */ +#define IRFIFO_WPTR 0x30 /* Read FIFO Write Pointer Register */ +#define IRFIFO_RPTR 0x34 /* Read FIFO Read Pointer Register */ + +/* register ICR fields */ +#define CR_START BIT(0) /* start bit */ +#define CR_STOP BIT(1) /* stop bit */ +#define CR_ACKNAK BIT(2) /* send ACK(0) or NAK(1) */ +#define CR_TB BIT(3) /* transfer byte bit */ +#define CR_TXBEGIN BIT(4) /* transaction begin */ +#define CR_FIFOEN BIT(5) /* enable FIFO mode */ +#define CR_GPIOEN BIT(6) /* enable GPIO mode for SCL in HS */ +#define CR_DMAEN BIT(7) /* enable DMA for TX and RX FIFOs */ +#define CR_MODE_FAST BIT(8) /* bus mode (master operation) */ +#define CR_MODE_HIGH BIT(9) /* bus mode (master operation) */ +#define CR_UR BIT(10) /* unit reset */ +#define CR_RSTREQ BIT(11) /* i2c bus reset request */ +#define CR_MA BIT(12) /* master abort */ +#define CR_SCLE BIT(13) /* master clock enable */ +#define CR_IUE BIT(14) /* unit enable */ +#define CR_HS_STRETCH BIT(16) /* I2C hs stretch */ +#define CR_ALDIE BIT(18) /* enable arbitration interrupt */ +#define CR_DTEIE BIT(19) /* enable tx interrupts */ +#define CR_DRFIE BIT(20) /* enable rx interrupts */ +#define CR_GCD BIT(21) /* general call disable */ +#define CR_BEIE BIT(22) /* enable bus error ints */ +#define CR_SADIE BIT(23) /* slave address detected int enable */ +#define CR_SSDIE BIT(24) /* slave STOP detected int enable */ +#define CR_MSDIE BIT(25) /* master STOP detected int enable */ +#define CR_MSDE BIT(26) /* master STOP detected enable */ +#define CR_TXDONEIE BIT(27) /* transaction done int enable */ +#define CR_TXEIE BIT(28) /* transmit FIFO empty int enable */ +#define CR_RXHFIE BIT(29) /* receive FIFO half-full int enable */ +#define CR_RXFIE BIT(30) /* receive FIFO full int enable */ +#define CR_RXOVIE BIT(31) /* receive FIFO overrun int enable */ + +/* register ISR fields */ +#define SR_RWM BIT(13) /* read/write mode */ +#define SR_ACKNAK BIT(14) /* ACK/NACK status */ +#define SR_UB BIT(15) /* unit busy */ +#define SR_IBB BIT(16) /* i2c bus busy */ +#define SR_EBB BIT(17) /* early bus busy */ +#define SR_ALD BIT(18) /* arbitration loss detected */ +#define SR_ITE BIT(19) /* tx buffer empty */ +#define SR_IRF BIT(20) /* rx buffer full */ +#define SR_GCAD BIT(21) /* general call address detected */ +#define SR_BED BIT(22) /* bus error no ACK/NAK */ +#define SR_SAD BIT(23) /* slave address detected */ +#define SR_SSD BIT(24) /* slave stop detected */ +#define SR_MSD BIT(26) /* master stop detected */ +#define SR_TXDONE BIT(27) /* transaction done */ +#define SR_TXE BIT(28) /* tx FIFO empty */ +#define SR_RXHF BIT(29) /* rx FIFO half-full */ +#define SR_RXF BIT(30) /* rx FIFO full */ +#define SR_RXOV BIT(31) /* RX FIFO overrun */ + +/* register ILCR fields */ +#define LCR_SLV 0x000001FF /* SLV: bit[8:0] */ +#define LCR_FLV 0x0003FE00 /* FLV: bit[17:9] */ +#define LCR_HLVH 0x07FC0000 /* HLVH: bit[26:18] */ +#define LCR_HLVL 0xF8000000 /* HLVL: bit[31:27] */ + +/* register IWCR fields */ +#define WCR_COUNT 0x0000001F /* COUNT: bit[4:0] */ +#define WCR_COUNT1 0x000003E0 /* HS_COUNT1: bit[9:5] */ +#define WCR_COUNT2 0x00007C00 /* HS_COUNT2: bit[14:10] */ + +/* register IBMR fields */ +#define BMR_SDA BIT(0) /* SDA line level */ +#define BMR_SCL BIT(1) /* SCL line level */ + +/* register IWFIFO fields */ +#define WFIFO_DATA_MSK 0x000000FF /* data: bit[7:0] */ +#define WFIFO_CTRL_MSK 0x000003E0 /* control: bit[11:8] */ +#define WFIFO_CTRL_START BIT(8) /* start bit */ +#define WFIFO_CTRL_STOP BIT(9) /* stop bit */ +#define WFIFO_CTRL_ACKNAK BIT(10) /* send ACK(0) or NAK(1) */ +#define WFIFO_CTRL_TB BIT(11) /* transfer byte bit */ + +/* status register init value */ +#define I2C_INT_STATUS_MASK 0xfffc0000 /* SR bits[31:18] */ +#define I2C_INT_CTRL_MASK (CR_ALDIE | CR_DTEIE | CR_DRFIE | \ + CR_BEIE | CR_TXDONEIE | CR_TXEIE | \ + CR_RXHFIE | CR_RXFIE | CR_RXOVIE | \ + CR_MSDIE) + +/* i2c bus recover timeout: us */ +#define I2C_BUS_RECOVER_TIMEOUT (100000) + +#define I2C_FAST_MODE_FREQ (400000) + +enum spacemit_i2c_state { + STATE_IDLE, + STATE_START, + STATE_READ, + STATE_WRITE, +}; + +enum spacemit_i2c_dir { + DIR_WRITE, + DIR_READ +}; + +/* i2c-spacemit driver's main struct */ +struct spacemit_i2c_dev { + struct device *dev; + struct i2c_adapter adapt; + + /* hardware resources */ + void __iomem *base; + int irq; + + struct i2c_msg *msgs; + int msg_num; + struct i2c_msg *cur_msg; + + /* index of the current message being processed */ + int msg_idx; + u8 *msg_buf; + /* the number of unprocessed bytes remaining in each message */ + size_t unprocessed; + + enum spacemit_i2c_state state; + enum spacemit_i2c_dir dir; + struct completion complete; + u32 status; + u32 err; +}; + +static void spacemit_i2c_enable(struct spacemit_i2c_dev *i2c) +{ + u32 val; + + val = readl(i2c->base + ICR); + writel(val | CR_IUE, i2c->base + ICR); +} + +static void spacemit_i2c_disable(struct spacemit_i2c_dev *i2c) +{ + u32 val; + + val = readl(i2c->base + ICR); + val &= ~CR_IUE; + writel(val, i2c->base + ICR); +} + +static void spacemit_i2c_reset(struct spacemit_i2c_dev *i2c) +{ + writel(CR_UR, i2c->base + ICR); + udelay(5); + writel(0, i2c->base + ICR); +} + +static int spacemit_i2c_handle_err(struct spacemit_i2c_dev *i2c); + +static void spacemit_i2c_bus_reset(struct spacemit_i2c_dev *i2c) +{ + u32 status; + + /* if bus is locked, reset unit. 0: locked */ + status = readl(i2c->base + IBMR); + if ((status & BMR_SDA) && (status & BMR_SCL)) + return; + + spacemit_i2c_reset(i2c); + usleep_range(10, 20); + + /* check scl status again */ + status = readl(i2c->base + IBMR); + if (!(status & BMR_SCL)) + dev_warn_ratelimited(i2c->dev, "unit reset failed\n"); +} + +static int spacemit_i2c_recover_bus_busy(struct spacemit_i2c_dev *i2c) +{ + int ret = 0; + u32 val; + + val = readl(i2c->base + ISR); + if (likely(!(val & (SR_UB | SR_IBB)))) + return 0; + + ret = readl_poll_timeout(i2c->base + ISR, val, !(val & (SR_UB | SR_IBB)), + 1500, I2C_BUS_RECOVER_TIMEOUT); + if (unlikely(ret)) { + spacemit_i2c_reset(i2c); + ret = -EAGAIN; + } + + return ret; +} + +static void spacemit_i2c_check_bus_release(struct spacemit_i2c_dev *i2c) +{ + /* in case bus is not released after transfer completes */ + if (unlikely(readl(i2c->base + ISR) & SR_EBB)) { + spacemit_i2c_bus_reset(i2c); + usleep_range(90, 150); + } +} + +static void spacemit_i2c_init(struct spacemit_i2c_dev *i2c) +{ + u32 val = 0; + + /* + * Unmask interrupt bits for all xfer mode: + * bus error, arbitration loss detected. + * For transaction complete signal, we use master stop + * interrupt, so we don't need to unmask CR_TXDONEIE. + */ + val |= CR_BEIE | CR_ALDIE; + + /* + * Unmask interrupt bits for interrupt xfer mode: + * DBR rx full. + * For tx empty interrupt CR_DTEIE, we only + * need to enable when trigger byte transfer to start + * data sending. + */ + val |= CR_DRFIE; + + /* set speed bits: default fast mode */ + val |= CR_MODE_FAST; + + /* disable response to general call */ + val |= CR_GCD; + + /* enable SCL clock output */ + val |= CR_SCLE; + + /* enable master stop detected */ + val |= CR_MSDE | CR_MSDIE; + + writel(val, i2c->base + ICR); +} + +static inline void +spacemit_i2c_clear_int_status(struct spacemit_i2c_dev *i2c, u32 mask) +{ + writel(mask & I2C_INT_STATUS_MASK, i2c->base + ISR); +} + +static void spacemit_i2c_start(struct spacemit_i2c_dev *i2c) +{ + u32 slave_addr_rw, val; + + i2c->dir = i2c->cur_msg->flags & I2C_M_RD; + i2c->state = STATE_START; + + if (i2c->cur_msg->flags & I2C_M_RD) + slave_addr_rw = ((i2c->cur_msg->addr & 0x7f) << 1) | 1; + else + slave_addr_rw = (i2c->cur_msg->addr & 0x7f) << 1; + + writel(slave_addr_rw, i2c->base + IDBR); + + val = readl(i2c->base + ICR); + + /* send start pulse */ + val &= ~CR_STOP; + val |= CR_START | CR_TB | CR_DTEIE; + writel(val, i2c->base + ICR); +} + +static void spacemit_i2c_stop(struct spacemit_i2c_dev *i2c) +{ + u32 val; + + val = readl(i2c->base + ICR); + + val |= CR_STOP | CR_ALDIE | CR_TB; + + if (i2c->dir == DIR_READ) + val |= CR_ACKNAK; + + writel(val, i2c->base + ICR); +} + +static int spacemit_i2c_xfer_msg(struct spacemit_i2c_dev *i2c) +{ + unsigned long time_left; + + if (unlikely(i2c->err)) + return -1; + + for (i2c->msg_idx = 0; i2c->msg_idx < i2c->msg_num; i2c->msg_idx++) { + i2c->cur_msg = i2c->msgs + i2c->msg_idx; + i2c->msg_buf = i2c->cur_msg->buf; + i2c->err = 0; + i2c->status = 0; + i2c->unprocessed = i2c->cur_msg->len; + + reinit_completion(&i2c->complete); + + spacemit_i2c_start(i2c); + + time_left = wait_for_completion_timeout(&i2c->complete, + i2c->adapt.timeout); + if (unlikely(time_left == 0)) { + dev_alert(i2c->dev, "msg completion timeout\n"); + spacemit_i2c_bus_reset(i2c); + spacemit_i2c_reset(i2c); + return -ETIMEDOUT; + } + + if (unlikely(i2c->err)) + return spacemit_i2c_handle_err(i2c); + } + + return 0; +} + +static int spacemit_i2c_is_last_msg(struct spacemit_i2c_dev *i2c) +{ + if (i2c->dir == DIR_READ) + if (i2c->unprocessed == 1 && i2c->msg_idx == i2c->msg_num - 1) + return 1; + else if (i2c->dir == DIR_WRITE) + if (!i2c->unprocessed && i2c->msg_idx == i2c->msg_num - 1) + return 1; + + return 0; +} + +static void spacemit_i2c_handle_write(struct spacemit_i2c_dev *i2c) +{ + /* if transfer completes, ISR will handle it */ + if (i2c->status & SR_MSD) + return; + + if (i2c->unprocessed) { + writel(*i2c->msg_buf++, i2c->base + IDBR); + i2c->unprocessed--; + return; + } + + /* STATE_IDLE avoids trigger next byte */ + i2c->state = STATE_IDLE; + complete(&i2c->complete); +} + +static void spacemit_i2c_handle_read(struct spacemit_i2c_dev *i2c) +{ + if (i2c->unprocessed) { + *i2c->msg_buf++ = readl(i2c->base + IDBR); + i2c->unprocessed--; + } + + /* if transfer completes, ISR will handle it */ + if (i2c->status & (SR_MSD | SR_ACKNAK)) + return; + + /* it has to append stop bit in icr that read last byte */ + if (i2c->unprocessed) + return; + + /* STATE_IDLE avoids trigger next byte */ + i2c->state = STATE_IDLE; + complete(&i2c->complete); +} + +static void spacemit_i2c_handle_start(struct spacemit_i2c_dev *i2c) +{ + if (i2c->dir == DIR_READ) { + i2c->state = STATE_READ; + return; + } + + if (i2c->dir == DIR_WRITE) { + i2c->state = STATE_WRITE; + spacemit_i2c_handle_write(i2c); + } +} + +static int spacemit_i2c_handle_err(struct spacemit_i2c_dev *i2c) +{ + if (!i2c->err) + return 0; + + dev_dbg(i2c->dev, "i2c error status: 0x%08x\n", i2c->status); + + if (i2c->err & (SR_BED | SR_ALD)) + spacemit_i2c_reset(i2c); + + if (i2c->err & (SR_RXOV | SR_ALD)) + return -EAGAIN; + + return (i2c->status & SR_ACKNAK) ? -ENXIO : -EIO; +} + +static void spacemit_i2c_err_check(struct spacemit_i2c_dev *i2c) +{ + u32 val; + /* + * send transaction complete signal: + * error happens, detect master stop + */ + if (likely(i2c->err || (i2c->status & SR_MSD))) { + /* + * Here the transaction is already done, we don't need any + * other interrupt signals from now, in case any interrupt + * happens before spacemit_i2c_xfer to disable irq and i2c unit, + * we mask all the interrupt signals and clear the interrupt + * status. + */ + val = readl(i2c->base + ICR); + val &= ~I2C_INT_CTRL_MASK; + writel(val, i2c->base + ICR); + + spacemit_i2c_clear_int_status(i2c, I2C_INT_STATUS_MASK); + + i2c->state = STATE_IDLE; + complete(&i2c->complete); + } +} + +static irqreturn_t spacemit_i2c_irq_handler(int irq, void *devid) +{ + struct spacemit_i2c_dev *i2c = devid; + u32 status, val; + + status = readl(i2c->base + ISR); + if (!status) + return IRQ_HANDLED; + + i2c->status = status; + + i2c->err = status & (SR_BED | SR_RXOV | SR_ALD); + + spacemit_i2c_clear_int_status(i2c, status); + + if (unlikely(i2c->err)) + goto err_out; + + val = readl(i2c->base + ICR); + + val &= ~(CR_TB | CR_ACKNAK | CR_STOP | CR_START); + writel(val, i2c->base + ICR); + + switch (i2c->state) { + case STATE_START: + spacemit_i2c_handle_start(i2c); + break; + case STATE_READ: + spacemit_i2c_handle_read(i2c); + break; + case STATE_WRITE: + spacemit_i2c_handle_write(i2c); + break; + default: + break; + } + + if (i2c->state != STATE_IDLE) { + if (spacemit_i2c_is_last_msg(i2c)) { + /* trigger next byte with stop */ + spacemit_i2c_stop(i2c); + } else { + /* trigger next byte */ + val |= CR_ALDIE | CR_TB; + writel(val, i2c->base + ICR); + } + } + +err_out: + spacemit_i2c_err_check(i2c); + return IRQ_HANDLED; +} + +static void spacemit_i2c_calc_timeout(struct spacemit_i2c_dev *i2c) +{ + unsigned long timeout; + int idx = 0, cnt = 0, freq; + + while (idx < i2c->msg_num) { + cnt += (i2c->msgs + idx)->len + 1; + idx++; + } + + freq = I2C_FAST_MODE_FREQ; + /* + * multiply by 9 because each byte in I2C transmission requires + * 9 clock cycles: 8 bits of data plus 1 ACK/NACK bit. + */ + timeout = cnt * 9 * USEC_PER_SEC / freq; + + i2c->adapt.timeout = usecs_to_jiffies(timeout + USEC_PER_SEC / 2) / i2c->msg_num; +} + +static inline int spacemit_i2c_xfer_core(struct spacemit_i2c_dev *i2c) +{ + int ret = 0; + + spacemit_i2c_reset(i2c); + + spacemit_i2c_calc_timeout(i2c); + + spacemit_i2c_init(i2c); + + spacemit_i2c_enable(i2c); + enable_irq(i2c->irq); + + /* i2c wait for bus busy */ + ret = spacemit_i2c_recover_bus_busy(i2c); + if (unlikely(ret)) + return ret; + + ret = spacemit_i2c_xfer_msg(i2c); + if (unlikely(ret < 0)) { + dev_dbg(i2c->dev, "i2c transfer error\n"); + /* timeout error should not be overridden, and the transfer + * error will be confirmed by err handle function latter, + * the reset should be invalid argument error. + */ + if (ret != -ETIMEDOUT) + ret = -EINVAL; + } + + return ret; +} + +static int +spacemit_i2c_xfer(struct i2c_adapter *adapt, struct i2c_msg msgs[], int num) +{ + struct spacemit_i2c_dev *i2c = i2c_get_adapdata(adapt); + int ret; + + i2c->msgs = msgs; + i2c->msg_num = num; + + ret = spacemit_i2c_xfer_core(i2c); + if (likely(!ret)) + spacemit_i2c_check_bus_release(i2c); + + disable_irq(i2c->irq); + + spacemit_i2c_disable(i2c); + + if (unlikely((ret == -ETIMEDOUT || ret == -EAGAIN))) + dev_alert(i2c->dev, "i2c transfer failed, ret %d err 0x%x\n", ret, i2c->err); + + return ret < 0 ? ret : num; +} + +static u32 spacemit_i2c_func(struct i2c_adapter *adap) +{ + return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK); +} + +static const struct i2c_algorithm spacemit_i2c_algo = { + .xfer = spacemit_i2c_xfer, + .functionality = spacemit_i2c_func, +}; + +static int spacemit_i2c_probe(struct platform_device *pdev) +{ + struct spacemit_i2c_dev *i2c; + struct device_node *of_node = pdev->dev.of_node; + struct clk *clk; + int ret = 0; + + i2c = devm_kzalloc(&pdev->dev, sizeof(*i2c), GFP_KERNEL); + if (!i2c) + return -ENOMEM; + + i2c->dev = &pdev->dev; + + i2c->base = devm_platform_ioremap_resource(pdev, 0); + if (!i2c->base) + return dev_err_probe(&pdev->dev, PTR_ERR(i2c->base), "failed to do ioremap"); + + i2c->irq = platform_get_irq(pdev, 0); + if (i2c->irq < 0) + return dev_err_probe(&pdev->dev, i2c->irq, "failed to get irq resource"); + + ret = devm_request_irq(i2c->dev, i2c->irq, spacemit_i2c_irq_handler, + IRQF_NO_SUSPEND | IRQF_ONESHOT, dev_name(i2c->dev), i2c); + if (ret) + return dev_err_probe(&pdev->dev, ret, "failed to request irq"); + + disable_irq(i2c->irq); + + clk = devm_clk_get_enabled(&pdev->dev, NULL); + if (IS_ERR(clk)) + return dev_err_probe(&pdev->dev, PTR_ERR(clk), "failed to enable clock"); + + i2c_set_adapdata(&i2c->adapt, i2c); + i2c->adapt.owner = THIS_MODULE; + i2c->adapt.algo = &spacemit_i2c_algo; + i2c->adapt.dev.parent = i2c->dev; + i2c->adapt.nr = pdev->id; + + i2c->adapt.dev.of_node = of_node; + i2c->adapt.algo_data = i2c; + + strscpy(i2c->adapt.name, "spacemit-i2c-adapter", sizeof(i2c->adapt.name)); + + init_completion(&i2c->complete); + + ret = i2c_add_numbered_adapter(&i2c->adapt); + if (ret) + return dev_err_probe(&pdev->dev, ret, "failed to add i2c adapter"); + + platform_set_drvdata(pdev, i2c); + + return 0; +} + +static void spacemit_i2c_remove(struct platform_device *pdev) +{ + struct spacemit_i2c_dev *i2c = platform_get_drvdata(pdev); + + i2c_del_adapter(&i2c->adapt); +} + +static const struct of_device_id spacemit_i2c_of_match[] = { + { .compatible = "spacemit,k1-i2c", }, + { /* sentinel */ } +}; +MODULE_DEVICE_TABLE(of, spacemit_i2c_of_match); + +static struct platform_driver spacemit_i2c_driver = { + .probe = spacemit_i2c_probe, + .remove = spacemit_i2c_remove, + .driver = { + .name = "i2c-k1", + .of_match_table = spacemit_i2c_of_match, + }, +}; +module_platform_driver(spacemit_i2c_driver); + +MODULE_LICENSE("GPL"); +MODULE_DESCRIPTION("I2C bus driver for SpacemiT K1 SoC");