Skip to contentSkip to conversation

i2c: add driver for Mellanox BlueField SoC

PATCH Superseded Khalil Blaiech 2 participants 4 messages Mar 27, 2020 – Mar 28, 2020

Subsystems (3)

v8 of 9 Superseded Latest is v9 →

lore
Share & tools
lore
#0 lore raw

v8 cover i2c: add driver for Mellanox BlueField SoC

Add I2C SMBus driver and device tree bindings documentation.

The Mellanox BlueField is a System-on-Chip (SoC) that combines Arm cores and ConnectX network adapter technology intended to accelerate storage network solutions. The Mellanox BlueField incorporates various I2C devices that are accessed using SMBus protocol, a variant of the I2C protocol. On storage controllers, the BlueField SoC is connected to a management controller board, e.g., BMC via an I2C bus.

An I2C driver running on the Arm side is needed to manage the hardware I2C controllers. The driver enables a master function to transfer data back and forth from/to I2C devices, such as EEPROM parts and implements a slave function to handle the BMC controller requests.
---
v7->v8:
- Updating the dependency expression in Kconfig.
- Fixing an implicit fallthrough build error.
v6->v7:
- Fixing kernel coding style issues as suggested by Mellanox internal code reviewers.
- Updating the dependency expression in Kconfig.
- Fixing various device driver bugs.
- Adding an entry to MAINTAINERS file.
v5->v6:
- Fixing kernel coding style issues detected using '--strict' flag.
- Updating the device binding documentation to add support for BlueField-2 SoCs.
v4->v5:
- Fixing device driver bug.
v3->v4:
- Review of the device binding documentation to fix format issue and miscellaneous cleanup.
v2->v3:
- Various device driver changes and bug fixes.
- Updating the device property in the device binding documentation and file format review.
v1->v2:
- Various device driver changes and bug fixes.
- Cleanup of the device binding documentation.

Khalil Blaiech (2):
i2c: i2c-mlxbf: I2C SMBus driver for Mellanox BlueField SoC
dt-bindings: i2c: I2C binding for Mellanox BlueField SoC

 .../devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt |   42 +
 MAINTAINERS                                        |    6 +
 drivers/i2c/busses/Kconfig                         |   13 +
 drivers/i2c/busses/Makefile                        |    1 +
 drivers/i2c/busses/i2c-mlxbf.c                     | 2507 ++++++++++++++++++++
 5 files changed, 2569 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt
 create mode 100644 drivers/i2c/busses/i2c-mlxbf.c
Signature · 1 line
2.1.2
#1 lore raw

PATCH v8 1/2 i2c: i2c-mlxbf: I2C SMBus driver for Mellanox BlueField SoC

Add BlueField I2C driver to offer master and slave support for Mellanox BlueField SoCs. The driver implements an SMBus adapter and interfaces to multiple busses that can be probed using both ACPI and Device Tree infrastructures.

The driver supports several SMBus operations to transfer data back and forth from/to various I2C devices. It is mainly intended to be consumed by userspace tools and utilities, such as i2c-tools and decode-dimms to collect memory module information.

On the other hand, the driver has a slave function to support, among others, an IPMB interface that requires both master and slave functions to handle transfers between the BlueField SoC and a board management controllers (e.g., BMC).

---
v7->v8:
- Removing 'COMPILE_TEST' dependency in Kconfig.
- Fixing switch statement fallthrough comment to prevent warnings and/or build errors.
v6->v7:
- Fixing kernel coding style issues.
- Rewording of the commit message.
- Renaming of the driver filename.
- Renaming of the macro, struture, variable and function names to be consistent with the module name.
- Removing 'MELLANOX_PLATFORM' dependency in Kconfig.
- Fixing bug in mlxbf_i2c_get_shared_resource() to prevent null pointer dereference.
- Fixing bug in mlxbf_i2c_release_gpio() to prevent the use of null pointers.
- Adding an entry to MAINTAINERS file.
v5->v6:
- Fixing kernel coding style issues detected using '--strict' flag.
- Updating SPDX identifier and module license.
v4->v5:
- Fixing bug in mlx_slave_enale routine.
v2->v3:
- Updating the "compatible" string and add a new entry to the mlx_i2c_dt_ids array.
- Adding a new entry to the mlx_i2c_acpi_ids array to support a new device _HID.
- Updating the device probe routines to derive the device type based on the instance property described in either devicetree or ACPI.
- Definition of new handlers to request and release the shared resources. These handlers relies on the device type.
v1->v2:
- Updating the '.compatible' field of of_device_id.
- Updating mlx_i2c_of_probe() call to extract the bus identifier from the pre-defined aliases.
- Removing the 'profile' property.
- Setting the timing parameters according to the value of 'clock-frequency' property.
- Convertng the timing configuration from KHz to Hz.

---
 MAINTAINERS                    |    6 +
 drivers/i2c/busses/Kconfig     |   13 +
 drivers/i2c/busses/Makefile    |    1 +
 drivers/i2c/busses/i2c-mlxbf.c | 2507 ++++++++++++++++++++++++++++++++++++++++
 4 files changed, 2527 insertions(+)
 create mode 100644 drivers/i2c/busses/i2c-mlxbf.c
MAINTAINERS +6 -0
index 5a5332b..6157022 100644
@@ -10669,6 +10669,12 @@ S:	Supported
 F:	drivers/input/touchscreen/melfas_mip4.c
 F:	Documentation/devicetree/bindings/input/touchscreen/melfas_mip4.txt
 
+MELLANOX BLUEFIELD I2C DRIVER
+M:	Khalil Blaiech <[email protected]>
+L:	[email protected]
+S:	Supported
+F:	drivers/i2c/busses/i2c-mlxbf.c
+
 MELLANOX ETHERNET DRIVER (mlx4_en)
 M:	Tariq Toukan <[email protected]>
 L:	[email protected]
drivers/i2c/busses/Kconfig +13 -0
index 2ddca08..8bb571c 100644
@@ -726,6 +726,19 @@ config I2C_LPC2K
 	  This driver can also be built as a module.  If so, the module
 	  will be called i2c-lpc2k.
 
+config I2C_MLXBF
+        tristate "Mellanox BlueField I2C controller"
+        depends on ARM64
+        help
+          Enabling this option will add I2C SMBus support for Mellanox BlueField
+          system.
+
+          This driver can also be built as a module. If so, the module will be
+          called i2c-mlxbf.
+
+          This driver implements an I2C SMBus host controller and enables both
+          master and slave functions.
+
 config I2C_MESON
 	tristate "Amlogic Meson I2C controller"
 	depends on ARCH_MESON || COMPILE_TEST
drivers/i2c/busses/Makefile +1 -0
index 25d6088..2f558fe 100644
@@ -140,6 +140,7 @@ obj-$(CONFIG_I2C_BRCMSTB)	+= i2c-brcmstb.o
 obj-$(CONFIG_I2C_CROS_EC_TUNNEL)	+= i2c-cros-ec-tunnel.o
 obj-$(CONFIG_I2C_ELEKTOR)	+= i2c-elektor.o
 obj-$(CONFIG_I2C_ICY)		+= i2c-icy.o
+obj-$(CONFIG_I2C_MLXBF)		+= i2c-mlxbf.o
 obj-$(CONFIG_I2C_MLXCPLD)	+= i2c-mlxcpld.o
 obj-$(CONFIG_I2C_OPAL)		+= i2c-opal.o
 obj-$(CONFIG_I2C_PCA_ISA)	+= i2c-pca-isa.o
drivers/i2c/busses/i2c-mlxbf.c new file +2507 -0

2,507 lines not on this page · raw message

Signature · 1 line
2.1.2
#2 lore raw

Re: [PATCH v8 1/2] i2c: i2c-mlxbf: I2C SMBus driver for Mellanox BlueField SoC

I love your patch! Yet something to improve:

Hi Khalil,

I love your patch! Yet something to improve:

[auto build test ERROR on wsa/i2c/for-next]
[also build test ERROR on robh/for-next linus/master v5.6-rc7 next-20200327] [if your patch is applied to the wrong git tree, please drop us a note to help improve the system. BTW, we also suggest to use '--base' option to specify the base tree in git format-patch, please see https://stackoverflow.com/a/37406982]

url:    https://github.com/0day-ci/linux/commits/Khalil-Blaiech/i2c-add-driver-for-Mellanox-BlueField-SoC/20200328-042750
base:   https://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux.git i2c/for-next
config: arm64-allyesconfig (attached as .config)
compiler: aarch64-linux-gcc (GCC) 9.2.0

reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
GCC_VERSION=9.2.0 make.cross ARCH=arm64

If you fix the issue, kindly add following tag

All errors (new ones prefixed by >>):

drivers/i2c/busses/i2c-mlxbf.c: In function 'mlxbf_i2c_get_gpio':

>> drivers/i2c/busses/i2c-mlxbf.c:1288:17: error: implicit declaration of function 'devm_ioremap_nocache'; did you mean 'devm_ioremap_release'? [-Werror=implicit-function-declaration]
    1288 |  gpio_res->io = devm_ioremap_nocache(dev, params->start, size);
         |                 ^~~~~~~~~~~~~~~~~~~~
         |                 devm_ioremap_release
   drivers/i2c/busses/i2c-mlxbf.c:1288:15: warning: assignment to 'void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
    1288 |  gpio_res->io = devm_ioremap_nocache(dev, params->start, size);
         |               ^
   drivers/i2c/busses/i2c-mlxbf.c: In function 'mlxbf_i2c_get_corepll':
   drivers/i2c/busses/i2c-mlxbf.c:1353:18: warning: assignment to 'void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
    1353 |  corepll_res->io = devm_ioremap_nocache(dev, params->start, size);
         |                  ^
   drivers/i2c/busses/i2c-mlxbf.c: In function 'mlxbf_i2c_init_coalesce':
   drivers/i2c/busses/i2c-mlxbf.c:1755:22: error: implicit declaration of function 'ioremap_nocache'; did you mean 'ioremap_cache'? [-Werror=implicit-function-declaration]
    1755 |   coalesce_res->io = ioremap_nocache(params->start, size);
         |                      ^~~~~~~~~~~~~~~
         |                      ioremap_cache
   drivers/i2c/busses/i2c-mlxbf.c:1755:20: warning: assignment to 'void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
    1755 |   coalesce_res->io = ioremap_nocache(params->start, size);
         |                    ^

cc1: some warnings being treated as errors

vim +1288 drivers/i2c/busses/i2c-mlxbf.c

1258
1259 static int mlxbf_i2c_get_gpio(struct platform_device *pdev,
1260 struct mlxbf_i2c_priv *priv)
1261 {
1262 struct mlxbf_i2c_resource *gpio_res;
1263 struct device *dev = &pdev->dev;
1264 struct resource *params;
1265 resource_size_t size;
1266
1267 gpio_res = mlxbf_i2c_get_shared_resource(priv, MLXBF_I2C_GPIO_RES);
1268 if (!gpio_res)
1269 return -EPERM;
1270
1271 /*
1272 * The GPIO region in TYU space is shared among I2C busses.
1273 * This function MUST be serialized to avoid racing when
1274 * claiming the memory region and/or setting up the GPIO.
1275 */
1276 lockdep_assert_held(gpio_res->lock);
1277
1278 /* Check whether the memory map exist. */
1279 if (gpio_res->io)
1280 return 0;
1281
1282 params = gpio_res->params;
1283 size = resource_size(params);
1284
1285 if (!devm_request_mem_region(dev, params->start, size, params->name))
1286 return -EFAULT;
1287

> 1288		gpio_res->io = devm_ioremap_nocache(dev, params->start, size);

1289 if (IS_ERR(gpio_res->io)) {
1290 devm_release_mem_region(dev, params->start, size);
1291 return PTR_ERR(gpio_res->io);
1292 }
1293
1294 return 0;
1295 }
1296

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

#3 lore raw

PATCH v8 2/2 dt-bindings: i2c: I2C binding for Mellanox BlueField SoC

In reply to Khalil Blaiech

Added device tree bindings documentation for Mellanox BlueField I2C SMBus controller.

---
v5->v6:
- Adding description of an extra resource to be consistent with new BlueField-2 SoCs.
- Adding an additional example of device instance.
v3->v4:
- Re-ordering of the property descriptions.
- Removing useless register addresses from the resource description.
- Definition of default clock-frequency value.
- Fixing format issues; removing spaces.
- Removing "aliases" from Example section.
- Renaming device instance node in Example section.
v2->v3:
- Removing shared resources from the controller instance.
- Updating the 'compatible' property and support the second generation of the Mellanox BlueField SoC.
- Fixing file format; replacing spaces with tabs.
v1->v2:
- Enumeration of the device resources.
- Updating the 'compatible' property to make it less generic.
- Removing the 'bus' index property and replace it with standard approach to read the bus identifier.
- Getting rid of the 'profile' property.
- Using 'clock-frequency' property instead of 'bus-freq'.
- Convertion of the clock frequency from KHz to Hz.
- Removing useless examples.

---
 .../devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt | 42 ++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt
Documentation/devicetree/bindings/i2c/mellanox,i2c-mlxbf.txt new file +42 -0
new file mode 100644
index 0000000..566ea86
@@ -0,0 +1,42 @@
+Device tree configuration for the Mellanox I2C SMBus on BlueField SoCs
+
+Required Properties:
+
+- compatible : should be "mellanox,i2c-mlxbf1" or "mellanox,i2c-mlxbf2".
+
+- reg : address offset and length of the device registers. The
+	registers consist of the following set of resources:
+		1) Smbus block registers.
+		2) Cause master registers.
+		3) Cause slave registers.
+		4) Cause coalesce registers (if compatible isn't set
+		   to "mellanox,i2c-mlxbf1").
+
+- interrupts : interrupt number.
+
+Optional Properties:
+
+- clock-frequency : bus frequency used to configure timing registers;
+			allowed values are 100000, 400000 and 1000000;
+			those are expressed in Hz. Default is 100000.
+
+Example:
+
+i2c@2804000 {
+	compatible = "mellanox,i2c-mlxbf1";
+	reg =	<0x02804000 0x800>,
+		<0x02801200 0x020>,
+		<0x02801260 0x020>;
+	interrupts = <57>;
+	clock-frequency = <100000>;
+};
+
+i2c@2808800 {
+	compatible = "mellanox,i2c-mlxbf2";
+	reg =	<0x02808800 0x600>,
+	        <0x02808e00 0x020>,
+		<0x02808e20 0x020>,
+		<0x02808e40 0x010>;
+	interrupts = <57>;
+	clock-frequency = <400000>;
+};
Signature · 1 line
2.1.2