All of lore.kernel.org
 help / color / mirror / Atom feed
* Re: [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs for BMC
  2017-08-03 12:03 ` [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs for BMC Vadim Pasternak
@ 2017-08-03 11:43   ` Jacek Anaszewski
  2017-08-03 12:05     ` Vadim Pasternak
  0 siblings, 1 reply; 5+ messages in thread
From: Jacek Anaszewski @ 2017-08-03 11:43 UTC (permalink / raw)
  To: Vadim Pasternak, j.anaszewski, rpurdie
  Cc: linux-leds, lee.jones, robh+dt, jiri, pavel

Hi Vadim,

Thanks for the update. I'm still worried about variable
naming. Please refer below.

On 08/03/2017 02:03 PM, Vadim Pasternak wrote:
> Driver obtains LED devices according to system configuration and creates
> devices in form: "devicename:color:function", like
> The full path is to be:
> /sys/class/leds/mlxreg\:status\:amber/brightness
> After timer trigger activation:
> echo timer > /sys/class/leds/mlxreg\:status\:amber/trigger
> Attributes for LED blinking will appaer in sysfs infrastructure:
> /sys/class/leds/mlxreg\:status\:amber/delay_off
> /sys/class/leds/mlxreg\:status\:amber/delay_on
> 
> LED setting is controlled through the on-board programmable devices,
> which exports its register map. This device could be attached to any
> bus type, for which register mapping is supported.
> 
> Signed-off-by: Vadim Pasternak <vadimp@mellanox.com>
> Acked-by: Pavel Machek <pavel@ucw.cz>
> ---
> v3->v4
>  Comments pointed out by Jacek:
>  - add led in declaration mlxreg_led_store_hw and mlxreg_led_get_hw;
>  - rearrange local variables names in mlxreg_led_config;
>  Comments pointed out by Pavel:
>  - replace _HALF/_FULL with BLINK_3HZ/BLINK_6HZ;
>  - in mlxreg_led_get_hw just return after access error;
>  - explicit check for green led is not added, since control device can be
>    programmed for blue LED and this case it reuses masks of green LED.
> v2->v3:
>  Comments pointed out by Jacek:
>  - fix order in includes;
>  - add declaration pdata in mlxreg_led_store_hw and mlxreg_led_get_hw;
>  - add declaration of led_data in mlxreg_led_config;
>  - use LED_ON in assignment instead of 1;
>  - fix mutex call in mlxreg_led_remove;
> v1->v2:
>  Comments pointed out by Jacek:
>  - remove macros MLXREG_MAP and MLXREG_CDEV;
>  - brightness_set_blocking insteaf of brightness_set, this fix allows
>    removing of context validation and workqueue and also three fields from
>    struct mlxreg_core_led_data in mlxreg.h;
>  - remove MLXREG_LED_NAME;
>  - extend Kconfig description;
>  Changes added by Vadim:
>  - remove unnecessary includes after dropping workqueue;
> ---
>  MAINTAINERS                |   1 +
>  drivers/leds/Kconfig       |  10 ++
>  drivers/leds/Makefile      |   1 +
>  drivers/leds/leds-mlxreg.c | 297 +++++++++++++++++++++++++++++++++++++++++++++
>  4 files changed, 309 insertions(+)
>  create mode 100644 drivers/leds/leds-mlxreg.c
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 205d397..ac6b0d0 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -8566,6 +8566,7 @@ M:	Vadim Pasternak <vadimp@mellanox.com>
>  L:	linux-leds@vger.kernel.org
>  S:	Supported
>  F:	drivers/leds/leds-mlxcpld.c
> +F:	drivers/leds/leds-mlxreg.c
>  F:	Documentation/leds/leds-mlxcpld.txt
>  
>  MELLANOX PLATFORM DRIVER
> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
> index 594b24d..1c6563d 100644
> --- a/drivers/leds/Kconfig
> +++ b/drivers/leds/Kconfig
> @@ -657,6 +657,16 @@ config LEDS_MLXCPLD
>  	  This option enabled support for the LEDs on the Mellanox
>  	  boards. Say Y to enabled these.
>  
> +config LEDS_MLXREG
> +	tristate "LED support for the Mellanox BMC cards"
> +	depends on LEDS_CLASS
> +	help
> +	  This option enabled support for the LEDs on the Mellanox BMC cards.
> +	  The driver can be activated from the device tree or by the direct
> +	  platform device add call. Say Y to enabled these. To compile this
> +	  driver as a module, choose 'M' here: the module will be called
> +	  leds-mlxreg.
> +
>  config LEDS_USER
>  	tristate "Userspace LED support"
>  	depends on LEDS_CLASS
> diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
> index 909dae6..3eb76e5 100644
> --- a/drivers/leds/Makefile
> +++ b/drivers/leds/Makefile
> @@ -69,6 +69,7 @@ obj-$(CONFIG_LEDS_IS31FL319X)		+= leds-is31fl319x.o
>  obj-$(CONFIG_LEDS_IS31FL32XX)		+= leds-is31fl32xx.o
>  obj-$(CONFIG_LEDS_PM8058)		+= leds-pm8058.o
>  obj-$(CONFIG_LEDS_MLXCPLD)		+= leds-mlxcpld.o
> +obj-$(CONFIG_LEDS_MLXREG)		+= leds-mlxreg.o
>  obj-$(CONFIG_LEDS_NIC78BX)		+= leds-nic78bx.o
>  obj-$(CONFIG_LEDS_MT6323)		+= leds-mt6323.o
>  
> diff --git a/drivers/leds/leds-mlxreg.c b/drivers/leds/leds-mlxreg.c
> new file mode 100644
> index 0000000..41ba10e
> --- /dev/null
> +++ b/drivers/leds/leds-mlxreg.c
> @@ -0,0 +1,297 @@
> +/*
> + * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
> + * Copyright (c) 2017 Vadim Pasternak <vadimp@mellanox.com>
> + *
> + * Redistribution and use in source and binary forms, with or without
> + * modification, are permitted provided that the following conditions are met:
> + *
> + * 1. Redistributions of source code must retain the above copyright
> + *    notice, this list of conditions and the following disclaimer.
> + * 2. Redistributions in binary form must reproduce the above copyright
> + *    notice, this list of conditions and the following disclaimer in the
> + *    documentation and/or other materials provided with the distribution.
> + * 3. Neither the names of the copyright holders nor the names of its
> + *    contributors may be used to endorse or promote products derived from
> + *    this software without specific prior written permission.
> + *
> + * Alternatively, this software may be distributed under the terms of the
> + * GNU General Public License ("GPL") version 2 as published by the Free
> + * Software Foundation.
> + *
> + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
> + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
> + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
> + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
> + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
> + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
> + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
> + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
> + * POSSIBILITY OF SUCH DAMAGE.
> + */
> +
> +#include <linux/bitops.h>
> +#include <linux/device.h>
> +#include <linux/io.h>
> +#include <linux/leds.h>
> +#include <linux/module.h>
> +#include <linux/of_device.h>
> +#include <linux/platform_data/mlxreg.h>
> +#include <linux/platform_device.h>
> +#include <linux/regmap.h>
> +
> +/* Codes for LEDs. */
> +#define MLXREG_LED_OFFSET_BLINK_3HZ	0x01 /* Offset from solid: 3Hz blink */
> +#define MLXREG_LED_OFFSET_BLINK_6HZ	0x02 /* Offset from solid: 6Hz blink */
> +#define MLXREG_LED_IS_OFF		0x00 /* Off */
> +#define MLXREG_LED_RED_SOLID		0x05 /* Solid red */
> +#define MLXREG_LED_GREEN_SOLID		0x0D /* Solid green */
> +#define MLXREG_LED_AMBER_SOLID		0x09 /* Solid amber */
> +#define MLXREG_LED_BLINK_3HZ		167 /* ~167 msec off/on - HW support */
> +#define MLXREG_LED_BLINK_6HZ		83 /* ~83 msec off/on - HW support */
> +
> +#define cdev_to_priv(c) container_of(c, struct mlxreg_core_led_data, led_cdev)
> +
> +/**
> + * struct mlxreg_led_priv_data - platform private data:
> + *
> + * @pdev: platform device;
> + * @pdata: platform data;
> + * @access_lock: mutex for attribute IO access;
> + */
> +struct mlxreg_led_priv_data {
> +	struct platform_device *pdev;
> +	struct mlxreg_core_led_platform_data *pdata;
> +	struct mutex access_lock; /* protect IO operations */
> +};
> +
> +static int
> +mlxreg_led_store_hw(struct mlxreg_core_led_data *led_pdata, u8 vset)
> +{
> +	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
> +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
> +	struct mlxreg_core_data *led = led_pdata->led;
> +	u32 regval;
> +	u32 nib;
> +	int ret;
> +
> +	/*
> +	 * Each LED is controlled through low or high nibble of the relevant
> +	 * register byte. Register offset is specified by off parameter.
> +	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
> +	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
> +	 * green.
> +	 * Parameter mask specifies which nibble is used for specific LED: mask
> +	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
> +	 * higher nibble (bits from 4 to 7).
> +	 */
> +	mutex_lock(&priv->access_lock);
> +
> +	ret = regmap_read(pdata->regmap, led->reg, &regval);
> +	if (ret)
> +		goto access_error;
> +
> +	nib = (ror32(led->mask, led->bit) == 0xf0) ? rol32(vset, led->bit) :
> +	      rol32(vset, led->bit + 4);
> +	regval = (regval & led->mask) | nib;
> +
> +	ret = regmap_write(pdata->regmap, led->reg, regval);
> +
> +access_error:
> +	mutex_unlock(&priv->access_lock);
> +
> +	return ret;
> +}
> +
> +static enum led_brightness
> +mlxreg_led_get_hw(struct mlxreg_core_led_data *led_pdata)
> +{
> +	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
> +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
> +	struct mlxreg_core_data *led = led_pdata->led;
> +	u32 regval;
> +	int ret;
> +
> +	/*
> +	 * Each LED is controlled through low or high nibble of the relevant
> +	 * register byte. Register offset is specified by off parameter.
> +	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
> +	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
> +	 * green.
> +	 * Parameter mask specifies which nibble is used for specific LED: mask
> +	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
> +	 * higher nibble (bits from 4 to 7).
> +	 */
> +	ret = regmap_read(pdata->regmap, led->reg, &regval);
> +	if (ret < 0) {
> +		dev_warn(led_pdata->led_cdev.dev, "Failed to get current brightness, error: %d\n",
> +			 ret);
> +		/* Assume the LED is OFF */
> +		return LED_OFF;
> +	}
> +
> +	regval = regval & ~led->mask;
> +	regval = (ror32(led->mask, led->bit) == 0xf0) ? ror32(regval, led->bit)
> +		 : ror32(regval, led->bit + 4);
> +	if (regval >= led_pdata->base_color &&
> +	    regval <= (led_pdata->base_color + MLXREG_LED_OFFSET_BLINK_6HZ))
> +		ret = LED_FULL;
> +	else
> +		ret = LED_OFF;
> +
> +	return ret;
> +}
> +
> +static int
> +mlxreg_led_brightness_set(struct led_classdev *cled, enum led_brightness value)
> +{
> +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
> +
> +	if (value)
> +		return mlxreg_led_store_hw(led_pdata, led_pdata->base_color);
> +	else
> +		return mlxreg_led_store_hw(led_pdata, MLXREG_LED_IS_OFF);
> +}
> +
> +static enum led_brightness
> +mlxreg_led_brightness_get(struct led_classdev *cled)
> +{
> +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
> +
> +	return mlxreg_led_get_hw(led_pdata);
> +}
> +
> +static int
> +mlxreg_led_blink_set(struct led_classdev *cled, unsigned long *delay_on,
> +		     unsigned long *delay_off)
> +{
> +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
> +	int err;
> +
> +	/*
> +	 * HW supports two types of blinking: full (6Hz) and half (3Hz).
> +	 * For delay on/off zero LED is setting to solid color. For others
> +	 * combination blinking is to be controlled by the software timer.
> +	 */
> +	if (!(*delay_on == 0 && *delay_off == 0) &&
> +	    !(*delay_on == MLXREG_LED_BLINK_3HZ &&
> +	      *delay_off == MLXREG_LED_BLINK_3HZ) &&
> +	    !(*delay_on == MLXREG_LED_BLINK_6HZ &&
> +	      *delay_off == MLXREG_LED_BLINK_6HZ))
> +		return -EINVAL;
> +
> +	if (*delay_on == MLXREG_LED_BLINK_6HZ)
> +		err = mlxreg_led_store_hw(led_pdata, led_pdata->base_color +
> +					  MLXREG_LED_OFFSET_BLINK_6HZ);
> +	else if (*delay_on == MLXREG_LED_BLINK_3HZ)
> +		err = mlxreg_led_store_hw(led_pdata, led_pdata->base_color +
> +					  MLXREG_LED_OFFSET_BLINK_3HZ);
> +	else
> +		err = mlxreg_led_store_hw(led_pdata, led_pdata->base_color);
> +
> +	return err;
> +}
> +
> +static int mlxreg_led_config(struct mlxreg_led_priv_data *priv)
> +{
> +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
> +	struct mlxreg_core_led_data *led_data = pdata->led_data;

Please keep the naming consistent. In this function the variable of
"struct mlxreg_core_led_data" type is named "led_data" and above it is
'led_pdata'.

We have also "struct mlxreg_core_led_platform_data *pdata" for which
led_pdata would fit much better.

> +	struct mlxreg_core_data *led = led_data->led;
> +	struct mlxreg_core_led_data *data;
> +	struct led_classdev *led_cdev;
> +	int brightness;
> +	int i;
> +	int err;
> +
> +	for (i = 0; i < pdata->counter; i++, led_data++, led++) {
> +		data = led_data;

'data' seems to be redundant. You can use led_data directly.
Anyway, we will have to wait for a review from mfd side. The whole set
will go through an integration branch presumably.

> +		led_cdev = &data->led_cdev;
> +		data->data_parent = priv;
> +		if (strstr(led->label, "red")) {
> +			brightness = LED_OFF;
> +			data->base_color = MLXREG_LED_RED_SOLID;
> +		} else if (strstr(led->label, "amber")) {
> +			brightness = LED_OFF;
> +			data->base_color = MLXREG_LED_AMBER_SOLID;
> +		} else {
> +			brightness = LED_OFF;
> +			data->base_color = MLXREG_LED_GREEN_SOLID;
> +		}
> +		sprintf(data->led_cdev_name, "%s:%s", "mlxreg",
> +			led->label);
> +		led_cdev->name = data->led_cdev_name;
> +		led_cdev->brightness = brightness;
> +		led_cdev->max_brightness = LED_ON;
> +		led_cdev->brightness_set_blocking =
> +						mlxreg_led_brightness_set;
> +		led_cdev->brightness_get = mlxreg_led_brightness_get;
> +		led_cdev->blink_set = mlxreg_led_blink_set;
> +		led_cdev->flags = LED_CORE_SUSPENDRESUME;
> +		data->led = led;
> +		err = devm_led_classdev_register(&priv->pdev->dev, led_cdev);
> +		if (err)
> +			return err;
> +
> +		if (led_cdev->brightness)
> +			mlxreg_led_brightness_set(led_cdev,
> +						  led_cdev->brightness);
> +		dev_info(led_cdev->dev, "label: %s, mask: 0x%02x, offset:0x%02x\n",
> +			 led->label, led->mask, led->reg);
> +	}
> +
> +	return 0;
> +}
> +
> +static int mlxreg_led_probe(struct platform_device *pdev)
> +{
> +	struct mlxreg_core_led_platform_data *pdata;
> +	struct mlxreg_led_priv_data *priv;
> +
> +	pdata = dev_get_platdata(&pdev->dev);
> +	if (!pdata) {
> +		dev_err(&pdev->dev, "Failed to get platform data.\n");
> +		return -EINVAL;
> +	}
> +
> +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
> +	if (!priv)
> +		return -ENOMEM;
> +
> +	mutex_init(&priv->access_lock);
> +	priv->pdev = pdev;
> +	priv->pdata = pdata;
> +
> +	return mlxreg_led_config(priv);
> +}
> +
> +static int mlxreg_led_remove(struct platform_device *pdev)
> +{
> +	struct mlxreg_led_priv_data *priv = dev_get_drvdata(&pdev->dev);
> +
> +	mutex_destroy(&priv->access_lock);
> +
> +	return 0;
> +}
> +
> +static const struct of_device_id mlxreg_led_dt_match[] = {
> +	{ .compatible = "mellanox,leds-mlxreg" },
> +	{ },
> +};
> +MODULE_DEVICE_TABLE(of, mlxreg_dt_match);
> +
> +static struct platform_driver mlxreg_led_driver = {
> +	.driver = {
> +	    .name = "leds-mlxreg",
> +	    .of_match_table = of_match_ptr(mlxreg_led_dt_match),
> +	},
> +	.probe = mlxreg_led_probe,
> +	.remove = mlxreg_led_remove,
> +};
> +
> +module_platform_driver(mlxreg_led_driver);
> +
> +MODULE_AUTHOR("Vadim Pasternak <vadimp@mellanox.com>");
> +MODULE_DESCRIPTION("Mellanox LED regmap driver");
> +MODULE_LICENSE("Dual BSD/GPL");
> +MODULE_ALIAS("platform:leds-mlxreg");
> 

-- 
Best regards,
Jacek Anaszewski

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [patch v4 0/1] Introduce support for mlxreg LED driver
@ 2017-08-03 12:03 Vadim Pasternak
  2017-08-03 12:03 ` [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs for BMC Vadim Pasternak
  0 siblings, 1 reply; 5+ messages in thread
From: Vadim Pasternak @ 2017-08-03 12:03 UTC (permalink / raw)
  To: j.anaszewski, rpurdie
  Cc: linux-leds, lee.jones, robh+dt, jiri, jacek.anaszewski, pavel,
	Vadim Pasternak

This patch introduces LED driver, based on regmap interface.
This patch depends on previously sent:
[patch v3 1/2] mfd: Add Mellanox regmap core driver
because it includes include/linux/platform_data/mlxreg.h from this patch.

Vadim Pasternak (1):
  leds: add driver for support Mellanox regmap LEDs for BMC

 MAINTAINERS                |   1 +
 drivers/leds/Kconfig       |  10 ++
 drivers/leds/Makefile      |   1 +
 drivers/leds/leds-mlxreg.c | 297 +++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 309 insertions(+)
 create mode 100644 drivers/leds/leds-mlxreg.c

-- 
2.1.4

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs for BMC
  2017-08-03 12:03 [patch v4 0/1] Introduce support for mlxreg LED driver Vadim Pasternak
@ 2017-08-03 12:03 ` Vadim Pasternak
  2017-08-03 11:43   ` Jacek Anaszewski
  0 siblings, 1 reply; 5+ messages in thread
From: Vadim Pasternak @ 2017-08-03 12:03 UTC (permalink / raw)
  To: j.anaszewski, rpurdie
  Cc: linux-leds, lee.jones, robh+dt, jiri, jacek.anaszewski, pavel,
	Vadim Pasternak

Driver obtains LED devices according to system configuration and creates
devices in form: "devicename:color:function", like
The full path is to be:
/sys/class/leds/mlxreg\:status\:amber/brightness
After timer trigger activation:
echo timer > /sys/class/leds/mlxreg\:status\:amber/trigger
Attributes for LED blinking will appaer in sysfs infrastructure:
/sys/class/leds/mlxreg\:status\:amber/delay_off
/sys/class/leds/mlxreg\:status\:amber/delay_on

LED setting is controlled through the on-board programmable devices,
which exports its register map. This device could be attached to any
bus type, for which register mapping is supported.

Signed-off-by: Vadim Pasternak <vadimp@mellanox.com>
Acked-by: Pavel Machek <pavel@ucw.cz>
---
v3->v4
 Comments pointed out by Jacek:
 - add led in declaration mlxreg_led_store_hw and mlxreg_led_get_hw;
 - rearrange local variables names in mlxreg_led_config;
 Comments pointed out by Pavel:
 - replace _HALF/_FULL with BLINK_3HZ/BLINK_6HZ;
 - in mlxreg_led_get_hw just return after access error;
 - explicit check for green led is not added, since control device can be
   programmed for blue LED and this case it reuses masks of green LED.
v2->v3:
 Comments pointed out by Jacek:
 - fix order in includes;
 - add declaration pdata in mlxreg_led_store_hw and mlxreg_led_get_hw;
 - add declaration of led_data in mlxreg_led_config;
 - use LED_ON in assignment instead of 1;
 - fix mutex call in mlxreg_led_remove;
v1->v2:
 Comments pointed out by Jacek:
 - remove macros MLXREG_MAP and MLXREG_CDEV;
 - brightness_set_blocking insteaf of brightness_set, this fix allows
   removing of context validation and workqueue and also three fields from
   struct mlxreg_core_led_data in mlxreg.h;
 - remove MLXREG_LED_NAME;
 - extend Kconfig description;
 Changes added by Vadim:
 - remove unnecessary includes after dropping workqueue;
---
 MAINTAINERS                |   1 +
 drivers/leds/Kconfig       |  10 ++
 drivers/leds/Makefile      |   1 +
 drivers/leds/leds-mlxreg.c | 297 +++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 309 insertions(+)
 create mode 100644 drivers/leds/leds-mlxreg.c

diff --git a/MAINTAINERS b/MAINTAINERS
index 205d397..ac6b0d0 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8566,6 +8566,7 @@ M:	Vadim Pasternak <vadimp@mellanox.com>
 L:	linux-leds@vger.kernel.org
 S:	Supported
 F:	drivers/leds/leds-mlxcpld.c
+F:	drivers/leds/leds-mlxreg.c
 F:	Documentation/leds/leds-mlxcpld.txt
 
 MELLANOX PLATFORM DRIVER
diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
index 594b24d..1c6563d 100644
--- a/drivers/leds/Kconfig
+++ b/drivers/leds/Kconfig
@@ -657,6 +657,16 @@ config LEDS_MLXCPLD
 	  This option enabled support for the LEDs on the Mellanox
 	  boards. Say Y to enabled these.
 
+config LEDS_MLXREG
+	tristate "LED support for the Mellanox BMC cards"
+	depends on LEDS_CLASS
+	help
+	  This option enabled support for the LEDs on the Mellanox BMC cards.
+	  The driver can be activated from the device tree or by the direct
+	  platform device add call. Say Y to enabled these. To compile this
+	  driver as a module, choose 'M' here: the module will be called
+	  leds-mlxreg.
+
 config LEDS_USER
 	tristate "Userspace LED support"
 	depends on LEDS_CLASS
diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
index 909dae6..3eb76e5 100644
--- a/drivers/leds/Makefile
+++ b/drivers/leds/Makefile
@@ -69,6 +69,7 @@ obj-$(CONFIG_LEDS_IS31FL319X)		+= leds-is31fl319x.o
 obj-$(CONFIG_LEDS_IS31FL32XX)		+= leds-is31fl32xx.o
 obj-$(CONFIG_LEDS_PM8058)		+= leds-pm8058.o
 obj-$(CONFIG_LEDS_MLXCPLD)		+= leds-mlxcpld.o
+obj-$(CONFIG_LEDS_MLXREG)		+= leds-mlxreg.o
 obj-$(CONFIG_LEDS_NIC78BX)		+= leds-nic78bx.o
 obj-$(CONFIG_LEDS_MT6323)		+= leds-mt6323.o
 
diff --git a/drivers/leds/leds-mlxreg.c b/drivers/leds/leds-mlxreg.c
new file mode 100644
index 0000000..41ba10e
--- /dev/null
+++ b/drivers/leds/leds-mlxreg.c
@@ -0,0 +1,297 @@
+/*
+ * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
+ * Copyright (c) 2017 Vadim Pasternak <vadimp@mellanox.com>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the names of the copyright holders nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * Alternatively, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") version 2 as published by the Free
+ * Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <linux/bitops.h>
+#include <linux/device.h>
+#include <linux/io.h>
+#include <linux/leds.h>
+#include <linux/module.h>
+#include <linux/of_device.h>
+#include <linux/platform_data/mlxreg.h>
+#include <linux/platform_device.h>
+#include <linux/regmap.h>
+
+/* Codes for LEDs. */
+#define MLXREG_LED_OFFSET_BLINK_3HZ	0x01 /* Offset from solid: 3Hz blink */
+#define MLXREG_LED_OFFSET_BLINK_6HZ	0x02 /* Offset from solid: 6Hz blink */
+#define MLXREG_LED_IS_OFF		0x00 /* Off */
+#define MLXREG_LED_RED_SOLID		0x05 /* Solid red */
+#define MLXREG_LED_GREEN_SOLID		0x0D /* Solid green */
+#define MLXREG_LED_AMBER_SOLID		0x09 /* Solid amber */
+#define MLXREG_LED_BLINK_3HZ		167 /* ~167 msec off/on - HW support */
+#define MLXREG_LED_BLINK_6HZ		83 /* ~83 msec off/on - HW support */
+
+#define cdev_to_priv(c) container_of(c, struct mlxreg_core_led_data, led_cdev)
+
+/**
+ * struct mlxreg_led_priv_data - platform private data:
+ *
+ * @pdev: platform device;
+ * @pdata: platform data;
+ * @access_lock: mutex for attribute IO access;
+ */
+struct mlxreg_led_priv_data {
+	struct platform_device *pdev;
+	struct mlxreg_core_led_platform_data *pdata;
+	struct mutex access_lock; /* protect IO operations */
+};
+
+static int
+mlxreg_led_store_hw(struct mlxreg_core_led_data *led_pdata, u8 vset)
+{
+	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
+	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
+	struct mlxreg_core_data *led = led_pdata->led;
+	u32 regval;
+	u32 nib;
+	int ret;
+
+	/*
+	 * Each LED is controlled through low or high nibble of the relevant
+	 * register byte. Register offset is specified by off parameter.
+	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
+	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
+	 * green.
+	 * Parameter mask specifies which nibble is used for specific LED: mask
+	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
+	 * higher nibble (bits from 4 to 7).
+	 */
+	mutex_lock(&priv->access_lock);
+
+	ret = regmap_read(pdata->regmap, led->reg, &regval);
+	if (ret)
+		goto access_error;
+
+	nib = (ror32(led->mask, led->bit) == 0xf0) ? rol32(vset, led->bit) :
+	      rol32(vset, led->bit + 4);
+	regval = (regval & led->mask) | nib;
+
+	ret = regmap_write(pdata->regmap, led->reg, regval);
+
+access_error:
+	mutex_unlock(&priv->access_lock);
+
+	return ret;
+}
+
+static enum led_brightness
+mlxreg_led_get_hw(struct mlxreg_core_led_data *led_pdata)
+{
+	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
+	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
+	struct mlxreg_core_data *led = led_pdata->led;
+	u32 regval;
+	int ret;
+
+	/*
+	 * Each LED is controlled through low or high nibble of the relevant
+	 * register byte. Register offset is specified by off parameter.
+	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
+	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
+	 * green.
+	 * Parameter mask specifies which nibble is used for specific LED: mask
+	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
+	 * higher nibble (bits from 4 to 7).
+	 */
+	ret = regmap_read(pdata->regmap, led->reg, &regval);
+	if (ret < 0) {
+		dev_warn(led_pdata->led_cdev.dev, "Failed to get current brightness, error: %d\n",
+			 ret);
+		/* Assume the LED is OFF */
+		return LED_OFF;
+	}
+
+	regval = regval & ~led->mask;
+	regval = (ror32(led->mask, led->bit) == 0xf0) ? ror32(regval, led->bit)
+		 : ror32(regval, led->bit + 4);
+	if (regval >= led_pdata->base_color &&
+	    regval <= (led_pdata->base_color + MLXREG_LED_OFFSET_BLINK_6HZ))
+		ret = LED_FULL;
+	else
+		ret = LED_OFF;
+
+	return ret;
+}
+
+static int
+mlxreg_led_brightness_set(struct led_classdev *cled, enum led_brightness value)
+{
+	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
+
+	if (value)
+		return mlxreg_led_store_hw(led_pdata, led_pdata->base_color);
+	else
+		return mlxreg_led_store_hw(led_pdata, MLXREG_LED_IS_OFF);
+}
+
+static enum led_brightness
+mlxreg_led_brightness_get(struct led_classdev *cled)
+{
+	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
+
+	return mlxreg_led_get_hw(led_pdata);
+}
+
+static int
+mlxreg_led_blink_set(struct led_classdev *cled, unsigned long *delay_on,
+		     unsigned long *delay_off)
+{
+	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
+	int err;
+
+	/*
+	 * HW supports two types of blinking: full (6Hz) and half (3Hz).
+	 * For delay on/off zero LED is setting to solid color. For others
+	 * combination blinking is to be controlled by the software timer.
+	 */
+	if (!(*delay_on == 0 && *delay_off == 0) &&
+	    !(*delay_on == MLXREG_LED_BLINK_3HZ &&
+	      *delay_off == MLXREG_LED_BLINK_3HZ) &&
+	    !(*delay_on == MLXREG_LED_BLINK_6HZ &&
+	      *delay_off == MLXREG_LED_BLINK_6HZ))
+		return -EINVAL;
+
+	if (*delay_on == MLXREG_LED_BLINK_6HZ)
+		err = mlxreg_led_store_hw(led_pdata, led_pdata->base_color +
+					  MLXREG_LED_OFFSET_BLINK_6HZ);
+	else if (*delay_on == MLXREG_LED_BLINK_3HZ)
+		err = mlxreg_led_store_hw(led_pdata, led_pdata->base_color +
+					  MLXREG_LED_OFFSET_BLINK_3HZ);
+	else
+		err = mlxreg_led_store_hw(led_pdata, led_pdata->base_color);
+
+	return err;
+}
+
+static int mlxreg_led_config(struct mlxreg_led_priv_data *priv)
+{
+	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
+	struct mlxreg_core_led_data *led_data = pdata->led_data;
+	struct mlxreg_core_data *led = led_data->led;
+	struct mlxreg_core_led_data *data;
+	struct led_classdev *led_cdev;
+	int brightness;
+	int i;
+	int err;
+
+	for (i = 0; i < pdata->counter; i++, led_data++, led++) {
+		data = led_data;
+		led_cdev = &data->led_cdev;
+		data->data_parent = priv;
+		if (strstr(led->label, "red")) {
+			brightness = LED_OFF;
+			data->base_color = MLXREG_LED_RED_SOLID;
+		} else if (strstr(led->label, "amber")) {
+			brightness = LED_OFF;
+			data->base_color = MLXREG_LED_AMBER_SOLID;
+		} else {
+			brightness = LED_OFF;
+			data->base_color = MLXREG_LED_GREEN_SOLID;
+		}
+		sprintf(data->led_cdev_name, "%s:%s", "mlxreg",
+			led->label);
+		led_cdev->name = data->led_cdev_name;
+		led_cdev->brightness = brightness;
+		led_cdev->max_brightness = LED_ON;
+		led_cdev->brightness_set_blocking =
+						mlxreg_led_brightness_set;
+		led_cdev->brightness_get = mlxreg_led_brightness_get;
+		led_cdev->blink_set = mlxreg_led_blink_set;
+		led_cdev->flags = LED_CORE_SUSPENDRESUME;
+		data->led = led;
+		err = devm_led_classdev_register(&priv->pdev->dev, led_cdev);
+		if (err)
+			return err;
+
+		if (led_cdev->brightness)
+			mlxreg_led_brightness_set(led_cdev,
+						  led_cdev->brightness);
+		dev_info(led_cdev->dev, "label: %s, mask: 0x%02x, offset:0x%02x\n",
+			 led->label, led->mask, led->reg);
+	}
+
+	return 0;
+}
+
+static int mlxreg_led_probe(struct platform_device *pdev)
+{
+	struct mlxreg_core_led_platform_data *pdata;
+	struct mlxreg_led_priv_data *priv;
+
+	pdata = dev_get_platdata(&pdev->dev);
+	if (!pdata) {
+		dev_err(&pdev->dev, "Failed to get platform data.\n");
+		return -EINVAL;
+	}
+
+	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		return -ENOMEM;
+
+	mutex_init(&priv->access_lock);
+	priv->pdev = pdev;
+	priv->pdata = pdata;
+
+	return mlxreg_led_config(priv);
+}
+
+static int mlxreg_led_remove(struct platform_device *pdev)
+{
+	struct mlxreg_led_priv_data *priv = dev_get_drvdata(&pdev->dev);
+
+	mutex_destroy(&priv->access_lock);
+
+	return 0;
+}
+
+static const struct of_device_id mlxreg_led_dt_match[] = {
+	{ .compatible = "mellanox,leds-mlxreg" },
+	{ },
+};
+MODULE_DEVICE_TABLE(of, mlxreg_dt_match);
+
+static struct platform_driver mlxreg_led_driver = {
+	.driver = {
+	    .name = "leds-mlxreg",
+	    .of_match_table = of_match_ptr(mlxreg_led_dt_match),
+	},
+	.probe = mlxreg_led_probe,
+	.remove = mlxreg_led_remove,
+};
+
+module_platform_driver(mlxreg_led_driver);
+
+MODULE_AUTHOR("Vadim Pasternak <vadimp@mellanox.com>");
+MODULE_DESCRIPTION("Mellanox LED regmap driver");
+MODULE_LICENSE("Dual BSD/GPL");
+MODULE_ALIAS("platform:leds-mlxreg");
-- 
2.1.4

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* RE: [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs for BMC
  2017-08-03 11:43   ` Jacek Anaszewski
@ 2017-08-03 12:05     ` Vadim Pasternak
  2017-08-03 21:29       ` Jacek Anaszewski
  0 siblings, 1 reply; 5+ messages in thread
From: Vadim Pasternak @ 2017-08-03 12:05 UTC (permalink / raw)
  To: Jacek Anaszewski, j.anaszewski, rpurdie
  Cc: linux-leds, lee.jones, robh+dt, jiri, pavel

Hi Jacek,

Thank you very much for your reviews.

> -----Original Message-----
> From: Jacek Anaszewski [mailto:jacek.anaszewski@gmail.com]
> Sent: Thursday, August 03, 2017 2:44 PM
> To: Vadim Pasternak <vadimp@mellanox.com>;
> j.anaszewski@samsung.com; rpurdie@rpsys.net
> Cc: linux-leds@vger.kernel.org; lee.jones@linaro.org; robh+dt@kernel.org;
> jiri@resnulli.us; pavel@ucw.cz
> Subject: Re: [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs
> for BMC
> 
> Hi Vadim,
> 
> Thanks for the update. I'm still worried about variable naming. Please refer
> below.
> 
> On 08/03/2017 02:03 PM, Vadim Pasternak wrote:
> > Driver obtains LED devices according to system configuration and
> > creates devices in form: "devicename:color:function", like The full
> > path is to be:
> > /sys/class/leds/mlxreg\:status\:amber/brightness
> > After timer trigger activation:
> > echo timer > /sys/class/leds/mlxreg\:status\:amber/trigger
> > Attributes for LED blinking will appaer in sysfs infrastructure:
> > /sys/class/leds/mlxreg\:status\:amber/delay_off
> > /sys/class/leds/mlxreg\:status\:amber/delay_on
> >
> > LED setting is controlled through the on-board programmable devices,
> > which exports its register map. This device could be attached to any
> > bus type, for which register mapping is supported.
> >
> > Signed-off-by: Vadim Pasternak <vadimp@mellanox.com>
> > Acked-by: Pavel Machek <pavel@ucw.cz>
> > ---
> > v3->v4
> >  Comments pointed out by Jacek:
> >  - add led in declaration mlxreg_led_store_hw and mlxreg_led_get_hw;
> >  - rearrange local variables names in mlxreg_led_config;  Comments
> > pointed out by Pavel:
> >  - replace _HALF/_FULL with BLINK_3HZ/BLINK_6HZ;
> >  - in mlxreg_led_get_hw just return after access error;
> >  - explicit check for green led is not added, since control device can be
> >    programmed for blue LED and this case it reuses masks of green LED.
> > v2->v3:
> >  Comments pointed out by Jacek:
> >  - fix order in includes;
> >  - add declaration pdata in mlxreg_led_store_hw and mlxreg_led_get_hw;
> >  - add declaration of led_data in mlxreg_led_config;
> >  - use LED_ON in assignment instead of 1;
> >  - fix mutex call in mlxreg_led_remove;
> > v1->v2:
> >  Comments pointed out by Jacek:
> >  - remove macros MLXREG_MAP and MLXREG_CDEV;
> >  - brightness_set_blocking insteaf of brightness_set, this fix allows
> >    removing of context validation and workqueue and also three fields from
> >    struct mlxreg_core_led_data in mlxreg.h;
> >  - remove MLXREG_LED_NAME;
> >  - extend Kconfig description;
> >  Changes added by Vadim:
> >  - remove unnecessary includes after dropping workqueue;
> > ---
> >  MAINTAINERS                |   1 +
> >  drivers/leds/Kconfig       |  10 ++
> >  drivers/leds/Makefile      |   1 +
> >  drivers/leds/leds-mlxreg.c | 297
> > +++++++++++++++++++++++++++++++++++++++++++++
> >  4 files changed, 309 insertions(+)
> >  create mode 100644 drivers/leds/leds-mlxreg.c
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS index 205d397..ac6b0d0 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -8566,6 +8566,7 @@ M:	Vadim Pasternak <vadimp@mellanox.com>
> >  L:	linux-leds@vger.kernel.org
> >  S:	Supported
> >  F:	drivers/leds/leds-mlxcpld.c
> > +F:	drivers/leds/leds-mlxreg.c
> >  F:	Documentation/leds/leds-mlxcpld.txt
> >
> >  MELLANOX PLATFORM DRIVER
> > diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig index
> > 594b24d..1c6563d 100644
> > --- a/drivers/leds/Kconfig
> > +++ b/drivers/leds/Kconfig
> > @@ -657,6 +657,16 @@ config LEDS_MLXCPLD
> >  	  This option enabled support for the LEDs on the Mellanox
> >  	  boards. Say Y to enabled these.
> >
> > +config LEDS_MLXREG
> > +	tristate "LED support for the Mellanox BMC cards"
> > +	depends on LEDS_CLASS
> > +	help
> > +	  This option enabled support for the LEDs on the Mellanox BMC
> cards.
> > +	  The driver can be activated from the device tree or by the direct
> > +	  platform device add call. Say Y to enabled these. To compile this
> > +	  driver as a module, choose 'M' here: the module will be called
> > +	  leds-mlxreg.
> > +
> >  config LEDS_USER
> >  	tristate "Userspace LED support"
> >  	depends on LEDS_CLASS
> > diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile index
> > 909dae6..3eb76e5 100644
> > --- a/drivers/leds/Makefile
> > +++ b/drivers/leds/Makefile
> > @@ -69,6 +69,7 @@ obj-$(CONFIG_LEDS_IS31FL319X)		+=
> leds-is31fl319x.o
> >  obj-$(CONFIG_LEDS_IS31FL32XX)		+= leds-is31fl32xx.o
> >  obj-$(CONFIG_LEDS_PM8058)		+= leds-pm8058.o
> >  obj-$(CONFIG_LEDS_MLXCPLD)		+= leds-mlxcpld.o
> > +obj-$(CONFIG_LEDS_MLXREG)		+= leds-mlxreg.o
> >  obj-$(CONFIG_LEDS_NIC78BX)		+= leds-nic78bx.o
> >  obj-$(CONFIG_LEDS_MT6323)		+= leds-mt6323.o
> >
> > diff --git a/drivers/leds/leds-mlxreg.c b/drivers/leds/leds-mlxreg.c
> > new file mode 100644 index 0000000..41ba10e
> > --- /dev/null
> > +++ b/drivers/leds/leds-mlxreg.c
> > @@ -0,0 +1,297 @@
> > +/*
> > + * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
> > + * Copyright (c) 2017 Vadim Pasternak <vadimp@mellanox.com>
> > + *
> > + * Redistribution and use in source and binary forms, with or without
> > + * modification, are permitted provided that the following conditions are
> met:
> > + *
> > + * 1. Redistributions of source code must retain the above copyright
> > + *    notice, this list of conditions and the following disclaimer.
> > + * 2. Redistributions in binary form must reproduce the above copyright
> > + *    notice, this list of conditions and the following disclaimer in the
> > + *    documentation and/or other materials provided with the distribution.
> > + * 3. Neither the names of the copyright holders nor the names of its
> > + *    contributors may be used to endorse or promote products derived
> from
> > + *    this software without specific prior written permission.
> > + *
> > + * Alternatively, this software may be distributed under the terms of
> > +the
> > + * GNU General Public License ("GPL") version 2 as published by the
> > +Free
> > + * Software Foundation.
> > + *
> > + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
> CONTRIBUTORS "AS IS"
> > + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> LIMITED
> > +TO, THE
> > + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
> PARTICULAR
> > +PURPOSE
> > + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
> > +CONTRIBUTORS BE
> > + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
> > +OR
> > + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
> PROCUREMENT
> > +OF
> > + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
> > +BUSINESS
> > + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
> > +WHETHER IN
> > + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
> > +OTHERWISE)
> > + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
> > +ADVISED OF THE
> > + * POSSIBILITY OF SUCH DAMAGE.
> > + */
> > +
> > +#include <linux/bitops.h>
> > +#include <linux/device.h>
> > +#include <linux/io.h>
> > +#include <linux/leds.h>
> > +#include <linux/module.h>
> > +#include <linux/of_device.h>
> > +#include <linux/platform_data/mlxreg.h> #include
> > +<linux/platform_device.h> #include <linux/regmap.h>
> > +
> > +/* Codes for LEDs. */
> > +#define MLXREG_LED_OFFSET_BLINK_3HZ	0x01 /* Offset from solid: 3Hz
> blink */
> > +#define MLXREG_LED_OFFSET_BLINK_6HZ	0x02 /* Offset from solid: 6Hz
> blink */
> > +#define MLXREG_LED_IS_OFF		0x00 /* Off */
> > +#define MLXREG_LED_RED_SOLID		0x05 /* Solid red */
> > +#define MLXREG_LED_GREEN_SOLID		0x0D /* Solid green
> */
> > +#define MLXREG_LED_AMBER_SOLID		0x09 /* Solid amber
> */
> > +#define MLXREG_LED_BLINK_3HZ		167 /* ~167 msec off/on - HW
> support */
> > +#define MLXREG_LED_BLINK_6HZ		83 /* ~83 msec off/on - HW
> support */
> > +
> > +#define cdev_to_priv(c) container_of(c, struct mlxreg_core_led_data,
> > +led_cdev)
> > +
> > +/**
> > + * struct mlxreg_led_priv_data - platform private data:
> > + *
> > + * @pdev: platform device;
> > + * @pdata: platform data;
> > + * @access_lock: mutex for attribute IO access;  */ struct
> > +mlxreg_led_priv_data {
> > +	struct platform_device *pdev;
> > +	struct mlxreg_core_led_platform_data *pdata;
> > +	struct mutex access_lock; /* protect IO operations */ };
> > +
> > +static int
> > +mlxreg_led_store_hw(struct mlxreg_core_led_data *led_pdata, u8 vset)
> > +{
> > +	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
> > +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
> > +	struct mlxreg_core_data *led = led_pdata->led;
> > +	u32 regval;
> > +	u32 nib;
> > +	int ret;
> > +
> > +	/*
> > +	 * Each LED is controlled through low or high nibble of the relevant
> > +	 * register byte. Register offset is specified by off parameter.
> > +	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
> > +	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
> > +	 * green.
> > +	 * Parameter mask specifies which nibble is used for specific LED:
> mask
> > +	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
> > +	 * higher nibble (bits from 4 to 7).
> > +	 */
> > +	mutex_lock(&priv->access_lock);
> > +
> > +	ret = regmap_read(pdata->regmap, led->reg, &regval);
> > +	if (ret)
> > +		goto access_error;
> > +
> > +	nib = (ror32(led->mask, led->bit) == 0xf0) ? rol32(vset, led->bit) :
> > +	      rol32(vset, led->bit + 4);
> > +	regval = (regval & led->mask) | nib;
> > +
> > +	ret = regmap_write(pdata->regmap, led->reg, regval);
> > +
> > +access_error:
> > +	mutex_unlock(&priv->access_lock);
> > +
> > +	return ret;
> > +}
> > +
> > +static enum led_brightness
> > +mlxreg_led_get_hw(struct mlxreg_core_led_data *led_pdata) {
> > +	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
> > +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
> > +	struct mlxreg_core_data *led = led_pdata->led;
> > +	u32 regval;
> > +	int ret;
> > +
> > +	/*
> > +	 * Each LED is controlled through low or high nibble of the relevant
> > +	 * register byte. Register offset is specified by off parameter.
> > +	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
> > +	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
> > +	 * green.
> > +	 * Parameter mask specifies which nibble is used for specific LED:
> mask
> > +	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
> > +	 * higher nibble (bits from 4 to 7).
> > +	 */
> > +	ret = regmap_read(pdata->regmap, led->reg, &regval);
> > +	if (ret < 0) {
> > +		dev_warn(led_pdata->led_cdev.dev, "Failed to get current
> brightness, error: %d\n",
> > +			 ret);
> > +		/* Assume the LED is OFF */
> > +		return LED_OFF;
> > +	}
> > +
> > +	regval = regval & ~led->mask;
> > +	regval = (ror32(led->mask, led->bit) == 0xf0) ? ror32(regval, led->bit)
> > +		 : ror32(regval, led->bit + 4);
> > +	if (regval >= led_pdata->base_color &&
> > +	    regval <= (led_pdata->base_color +
> MLXREG_LED_OFFSET_BLINK_6HZ))
> > +		ret = LED_FULL;
> > +	else
> > +		ret = LED_OFF;
> > +
> > +	return ret;
> > +}
> > +
> > +static int
> > +mlxreg_led_brightness_set(struct led_classdev *cled, enum
> > +led_brightness value) {
> > +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
> > +
> > +	if (value)
> > +		return mlxreg_led_store_hw(led_pdata, led_pdata-
> >base_color);
> > +	else
> > +		return mlxreg_led_store_hw(led_pdata,
> MLXREG_LED_IS_OFF); }
> > +
> > +static enum led_brightness
> > +mlxreg_led_brightness_get(struct led_classdev *cled) {
> > +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
> > +
> > +	return mlxreg_led_get_hw(led_pdata); }
> > +
> > +static int
> > +mlxreg_led_blink_set(struct led_classdev *cled, unsigned long
> *delay_on,
> > +		     unsigned long *delay_off)
> > +{
> > +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
> > +	int err;
> > +
> > +	/*
> > +	 * HW supports two types of blinking: full (6Hz) and half (3Hz).
> > +	 * For delay on/off zero LED is setting to solid color. For others
> > +	 * combination blinking is to be controlled by the software timer.
> > +	 */
> > +	if (!(*delay_on == 0 && *delay_off == 0) &&
> > +	    !(*delay_on == MLXREG_LED_BLINK_3HZ &&
> > +	      *delay_off == MLXREG_LED_BLINK_3HZ) &&
> > +	    !(*delay_on == MLXREG_LED_BLINK_6HZ &&
> > +	      *delay_off == MLXREG_LED_BLINK_6HZ))
> > +		return -EINVAL;
> > +
> > +	if (*delay_on == MLXREG_LED_BLINK_6HZ)
> > +		err = mlxreg_led_store_hw(led_pdata, led_pdata-
> >base_color +
> > +					  MLXREG_LED_OFFSET_BLINK_6HZ);
> > +	else if (*delay_on == MLXREG_LED_BLINK_3HZ)
> > +		err = mlxreg_led_store_hw(led_pdata, led_pdata-
> >base_color +
> > +					  MLXREG_LED_OFFSET_BLINK_3HZ);
> > +	else
> > +		err = mlxreg_led_store_hw(led_pdata, led_pdata-
> >base_color);
> > +
> > +	return err;
> > +}
> > +
> > +static int mlxreg_led_config(struct mlxreg_led_priv_data *priv) {
> > +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
> > +	struct mlxreg_core_led_data *led_data = pdata->led_data;
> 
> Please keep the naming consistent. In this function the variable of "struct
> mlxreg_core_led_data" type is named "led_data" and above it is 'led_pdata'.
> 
> We have also "struct mlxreg_core_led_platform_data *pdata" for which
> led_pdata would fit much better.

OK.
So would it be good to follow:
	struct mlxreg_core_led_platform_data *led_pdata = priv->pdata;
	struct mlxreg_core_led_data *led_data = pdata->led_data;
And drop
	struct mlxreg_core_led_data *data;

Or I again missed something?


> 
> > +	struct mlxreg_core_data *led = led_data->led;
> > +	struct mlxreg_core_led_data *data;
> > +	struct led_classdev *led_cdev;
> > +	int brightness;
> > +	int i;
> > +	int err;
> > +
> > +	for (i = 0; i < pdata->counter; i++, led_data++, led++) {
> > +		data = led_data;
> 
> 'data' seems to be redundant. You can use led_data directly.
> Anyway, we will have to wait for a review from mfd side. The whole set will
> go through an integration branch presumably.

Would be OK to resend the patch v5 after applying your comments?
Or you suggest to wait with it until mfd and dts reviews?

> 
> > +		led_cdev = &data->led_cdev;
> > +		data->data_parent = priv;
> > +		if (strstr(led->label, "red")) {
> > +			brightness = LED_OFF;
> > +			data->base_color = MLXREG_LED_RED_SOLID;
> > +		} else if (strstr(led->label, "amber")) {
> > +			brightness = LED_OFF;
> > +			data->base_color = MLXREG_LED_AMBER_SOLID;
> > +		} else {
> > +			brightness = LED_OFF;
> > +			data->base_color = MLXREG_LED_GREEN_SOLID;
> > +		}
> > +		sprintf(data->led_cdev_name, "%s:%s", "mlxreg",
> > +			led->label);
> > +		led_cdev->name = data->led_cdev_name;
> > +		led_cdev->brightness = brightness;
> > +		led_cdev->max_brightness = LED_ON;
> > +		led_cdev->brightness_set_blocking =
> > +						mlxreg_led_brightness_set;
> > +		led_cdev->brightness_get = mlxreg_led_brightness_get;
> > +		led_cdev->blink_set = mlxreg_led_blink_set;
> > +		led_cdev->flags = LED_CORE_SUSPENDRESUME;
> > +		data->led = led;
> > +		err = devm_led_classdev_register(&priv->pdev->dev,
> led_cdev);
> > +		if (err)
> > +			return err;
> > +
> > +		if (led_cdev->brightness)
> > +			mlxreg_led_brightness_set(led_cdev,
> > +						  led_cdev->brightness);
> > +		dev_info(led_cdev->dev, "label: %s, mask: 0x%02x,
> offset:0x%02x\n",
> > +			 led->label, led->mask, led->reg);
> > +	}
> > +
> > +	return 0;
> > +}
> > +
> > +static int mlxreg_led_probe(struct platform_device *pdev) {
> > +	struct mlxreg_core_led_platform_data *pdata;
> > +	struct mlxreg_led_priv_data *priv;
> > +
> > +	pdata = dev_get_platdata(&pdev->dev);
> > +	if (!pdata) {
> > +		dev_err(&pdev->dev, "Failed to get platform data.\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
> > +	if (!priv)
> > +		return -ENOMEM;
> > +
> > +	mutex_init(&priv->access_lock);
> > +	priv->pdev = pdev;
> > +	priv->pdata = pdata;
> > +
> > +	return mlxreg_led_config(priv);
> > +}
> > +
> > +static int mlxreg_led_remove(struct platform_device *pdev) {
> > +	struct mlxreg_led_priv_data *priv = dev_get_drvdata(&pdev->dev);
> > +
> > +	mutex_destroy(&priv->access_lock);
> > +
> > +	return 0;
> > +}
> > +
> > +static const struct of_device_id mlxreg_led_dt_match[] = {
> > +	{ .compatible = "mellanox,leds-mlxreg" },
> > +	{ },
> > +};
> > +MODULE_DEVICE_TABLE(of, mlxreg_dt_match);
> > +
> > +static struct platform_driver mlxreg_led_driver = {
> > +	.driver = {
> > +	    .name = "leds-mlxreg",
> > +	    .of_match_table = of_match_ptr(mlxreg_led_dt_match),
> > +	},
> > +	.probe = mlxreg_led_probe,
> > +	.remove = mlxreg_led_remove,
> > +};
> > +
> > +module_platform_driver(mlxreg_led_driver);
> > +
> > +MODULE_AUTHOR("Vadim Pasternak <vadimp@mellanox.com>");
> > +MODULE_DESCRIPTION("Mellanox LED regmap driver");
> > +MODULE_LICENSE("Dual BSD/GPL"); MODULE_ALIAS("platform:leds-
> mlxreg");
> >
> 
> --
> Best regards,
> Jacek Anaszewski

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs for BMC
  2017-08-03 12:05     ` Vadim Pasternak
@ 2017-08-03 21:29       ` Jacek Anaszewski
  0 siblings, 0 replies; 5+ messages in thread
From: Jacek Anaszewski @ 2017-08-03 21:29 UTC (permalink / raw)
  To: Vadim Pasternak, j.anaszewski, rpurdie
  Cc: linux-leds, lee.jones, robh+dt, jiri, pavel

On 08/03/2017 02:05 PM, Vadim Pasternak wrote:
> Hi Jacek,
> 
> Thank you very much for your reviews.
> 
>> -----Original Message-----
>> From: Jacek Anaszewski [mailto:jacek.anaszewski@gmail.com]
>> Sent: Thursday, August 03, 2017 2:44 PM
>> To: Vadim Pasternak <vadimp@mellanox.com>;
>> j.anaszewski@samsung.com; rpurdie@rpsys.net
>> Cc: linux-leds@vger.kernel.org; lee.jones@linaro.org; robh+dt@kernel.org;
>> jiri@resnulli.us; pavel@ucw.cz
>> Subject: Re: [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs
>> for BMC
>>
>> Hi Vadim,
>>
>> Thanks for the update. I'm still worried about variable naming. Please refer
>> below.
>>
>> On 08/03/2017 02:03 PM, Vadim Pasternak wrote:
>>> Driver obtains LED devices according to system configuration and
>>> creates devices in form: "devicename:color:function", like The full
>>> path is to be:
>>> /sys/class/leds/mlxreg\:status\:amber/brightness
>>> After timer trigger activation:
>>> echo timer > /sys/class/leds/mlxreg\:status\:amber/trigger
>>> Attributes for LED blinking will appaer in sysfs infrastructure:
>>> /sys/class/leds/mlxreg\:status\:amber/delay_off
>>> /sys/class/leds/mlxreg\:status\:amber/delay_on
>>>
>>> LED setting is controlled through the on-board programmable devices,
>>> which exports its register map. This device could be attached to any
>>> bus type, for which register mapping is supported.
>>>
>>> Signed-off-by: Vadim Pasternak <vadimp@mellanox.com>
>>> Acked-by: Pavel Machek <pavel@ucw.cz>
>>> ---
>>> v3->v4
>>>  Comments pointed out by Jacek:
>>>  - add led in declaration mlxreg_led_store_hw and mlxreg_led_get_hw;
>>>  - rearrange local variables names in mlxreg_led_config;  Comments
>>> pointed out by Pavel:
>>>  - replace _HALF/_FULL with BLINK_3HZ/BLINK_6HZ;
>>>  - in mlxreg_led_get_hw just return after access error;
>>>  - explicit check for green led is not added, since control device can be
>>>    programmed for blue LED and this case it reuses masks of green LED.
>>> v2->v3:
>>>  Comments pointed out by Jacek:
>>>  - fix order in includes;
>>>  - add declaration pdata in mlxreg_led_store_hw and mlxreg_led_get_hw;
>>>  - add declaration of led_data in mlxreg_led_config;
>>>  - use LED_ON in assignment instead of 1;
>>>  - fix mutex call in mlxreg_led_remove;
>>> v1->v2:
>>>  Comments pointed out by Jacek:
>>>  - remove macros MLXREG_MAP and MLXREG_CDEV;
>>>  - brightness_set_blocking insteaf of brightness_set, this fix allows
>>>    removing of context validation and workqueue and also three fields from
>>>    struct mlxreg_core_led_data in mlxreg.h;
>>>  - remove MLXREG_LED_NAME;
>>>  - extend Kconfig description;
>>>  Changes added by Vadim:
>>>  - remove unnecessary includes after dropping workqueue;
>>> ---
>>>  MAINTAINERS                |   1 +
>>>  drivers/leds/Kconfig       |  10 ++
>>>  drivers/leds/Makefile      |   1 +
>>>  drivers/leds/leds-mlxreg.c | 297
>>> +++++++++++++++++++++++++++++++++++++++++++++
>>>  4 files changed, 309 insertions(+)
>>>  create mode 100644 drivers/leds/leds-mlxreg.c
>>>
>>> diff --git a/MAINTAINERS b/MAINTAINERS index 205d397..ac6b0d0 100644
>>> --- a/MAINTAINERS
>>> +++ b/MAINTAINERS
>>> @@ -8566,6 +8566,7 @@ M:	Vadim Pasternak <vadimp@mellanox.com>
>>>  L:	linux-leds@vger.kernel.org
>>>  S:	Supported
>>>  F:	drivers/leds/leds-mlxcpld.c
>>> +F:	drivers/leds/leds-mlxreg.c
>>>  F:	Documentation/leds/leds-mlxcpld.txt
>>>
>>>  MELLANOX PLATFORM DRIVER
>>> diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig index
>>> 594b24d..1c6563d 100644
>>> --- a/drivers/leds/Kconfig
>>> +++ b/drivers/leds/Kconfig
>>> @@ -657,6 +657,16 @@ config LEDS_MLXCPLD
>>>  	  This option enabled support for the LEDs on the Mellanox
>>>  	  boards. Say Y to enabled these.
>>>
>>> +config LEDS_MLXREG
>>> +	tristate "LED support for the Mellanox BMC cards"
>>> +	depends on LEDS_CLASS
>>> +	help
>>> +	  This option enabled support for the LEDs on the Mellanox BMC
>> cards.
>>> +	  The driver can be activated from the device tree or by the direct
>>> +	  platform device add call. Say Y to enabled these. To compile this
>>> +	  driver as a module, choose 'M' here: the module will be called
>>> +	  leds-mlxreg.
>>> +
>>>  config LEDS_USER
>>>  	tristate "Userspace LED support"
>>>  	depends on LEDS_CLASS
>>> diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile index
>>> 909dae6..3eb76e5 100644
>>> --- a/drivers/leds/Makefile
>>> +++ b/drivers/leds/Makefile
>>> @@ -69,6 +69,7 @@ obj-$(CONFIG_LEDS_IS31FL319X)		+=
>> leds-is31fl319x.o
>>>  obj-$(CONFIG_LEDS_IS31FL32XX)		+= leds-is31fl32xx.o
>>>  obj-$(CONFIG_LEDS_PM8058)		+= leds-pm8058.o
>>>  obj-$(CONFIG_LEDS_MLXCPLD)		+= leds-mlxcpld.o
>>> +obj-$(CONFIG_LEDS_MLXREG)		+= leds-mlxreg.o
>>>  obj-$(CONFIG_LEDS_NIC78BX)		+= leds-nic78bx.o
>>>  obj-$(CONFIG_LEDS_MT6323)		+= leds-mt6323.o
>>>
>>> diff --git a/drivers/leds/leds-mlxreg.c b/drivers/leds/leds-mlxreg.c
>>> new file mode 100644 index 0000000..41ba10e
>>> --- /dev/null
>>> +++ b/drivers/leds/leds-mlxreg.c
>>> @@ -0,0 +1,297 @@
>>> +/*
>>> + * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
>>> + * Copyright (c) 2017 Vadim Pasternak <vadimp@mellanox.com>
>>> + *
>>> + * Redistribution and use in source and binary forms, with or without
>>> + * modification, are permitted provided that the following conditions are
>> met:
>>> + *
>>> + * 1. Redistributions of source code must retain the above copyright
>>> + *    notice, this list of conditions and the following disclaimer.
>>> + * 2. Redistributions in binary form must reproduce the above copyright
>>> + *    notice, this list of conditions and the following disclaimer in the
>>> + *    documentation and/or other materials provided with the distribution.
>>> + * 3. Neither the names of the copyright holders nor the names of its
>>> + *    contributors may be used to endorse or promote products derived
>> from
>>> + *    this software without specific prior written permission.
>>> + *
>>> + * Alternatively, this software may be distributed under the terms of
>>> +the
>>> + * GNU General Public License ("GPL") version 2 as published by the
>>> +Free
>>> + * Software Foundation.
>>> + *
>>> + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
>> CONTRIBUTORS "AS IS"
>>> + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
>> LIMITED
>>> +TO, THE
>>> + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
>> PARTICULAR
>>> +PURPOSE
>>> + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
>>> +CONTRIBUTORS BE
>>> + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
>>> +OR
>>> + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
>> PROCUREMENT
>>> +OF
>>> + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
>>> +BUSINESS
>>> + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
>>> +WHETHER IN
>>> + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
>>> +OTHERWISE)
>>> + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
>>> +ADVISED OF THE
>>> + * POSSIBILITY OF SUCH DAMAGE.
>>> + */
>>> +
>>> +#include <linux/bitops.h>
>>> +#include <linux/device.h>
>>> +#include <linux/io.h>
>>> +#include <linux/leds.h>
>>> +#include <linux/module.h>
>>> +#include <linux/of_device.h>
>>> +#include <linux/platform_data/mlxreg.h> #include
>>> +<linux/platform_device.h> #include <linux/regmap.h>
>>> +
>>> +/* Codes for LEDs. */
>>> +#define MLXREG_LED_OFFSET_BLINK_3HZ	0x01 /* Offset from solid: 3Hz
>> blink */
>>> +#define MLXREG_LED_OFFSET_BLINK_6HZ	0x02 /* Offset from solid: 6Hz
>> blink */
>>> +#define MLXREG_LED_IS_OFF		0x00 /* Off */
>>> +#define MLXREG_LED_RED_SOLID		0x05 /* Solid red */
>>> +#define MLXREG_LED_GREEN_SOLID		0x0D /* Solid green
>> */
>>> +#define MLXREG_LED_AMBER_SOLID		0x09 /* Solid amber
>> */
>>> +#define MLXREG_LED_BLINK_3HZ		167 /* ~167 msec off/on - HW
>> support */
>>> +#define MLXREG_LED_BLINK_6HZ		83 /* ~83 msec off/on - HW
>> support */
>>> +
>>> +#define cdev_to_priv(c) container_of(c, struct mlxreg_core_led_data,
>>> +led_cdev)
>>> +
>>> +/**
>>> + * struct mlxreg_led_priv_data - platform private data:
>>> + *
>>> + * @pdev: platform device;
>>> + * @pdata: platform data;
>>> + * @access_lock: mutex for attribute IO access;  */ struct
>>> +mlxreg_led_priv_data {
>>> +	struct platform_device *pdev;
>>> +	struct mlxreg_core_led_platform_data *pdata;
>>> +	struct mutex access_lock; /* protect IO operations */ };
>>> +
>>> +static int
>>> +mlxreg_led_store_hw(struct mlxreg_core_led_data *led_pdata, u8 vset)
>>> +{
>>> +	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
>>> +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
>>> +	struct mlxreg_core_data *led = led_pdata->led;
>>> +	u32 regval;
>>> +	u32 nib;
>>> +	int ret;
>>> +
>>> +	/*
>>> +	 * Each LED is controlled through low or high nibble of the relevant
>>> +	 * register byte. Register offset is specified by off parameter.
>>> +	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
>>> +	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
>>> +	 * green.
>>> +	 * Parameter mask specifies which nibble is used for specific LED:
>> mask
>>> +	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
>>> +	 * higher nibble (bits from 4 to 7).
>>> +	 */
>>> +	mutex_lock(&priv->access_lock);
>>> +
>>> +	ret = regmap_read(pdata->regmap, led->reg, &regval);
>>> +	if (ret)
>>> +		goto access_error;
>>> +
>>> +	nib = (ror32(led->mask, led->bit) == 0xf0) ? rol32(vset, led->bit) :
>>> +	      rol32(vset, led->bit + 4);
>>> +	regval = (regval & led->mask) | nib;
>>> +
>>> +	ret = regmap_write(pdata->regmap, led->reg, regval);
>>> +
>>> +access_error:
>>> +	mutex_unlock(&priv->access_lock);
>>> +
>>> +	return ret;
>>> +}
>>> +
>>> +static enum led_brightness
>>> +mlxreg_led_get_hw(struct mlxreg_core_led_data *led_pdata) {
>>> +	struct mlxreg_led_priv_data *priv = led_pdata->data_parent;
>>> +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
>>> +	struct mlxreg_core_data *led = led_pdata->led;
>>> +	u32 regval;
>>> +	int ret;
>>> +
>>> +	/*
>>> +	 * Each LED is controlled through low or high nibble of the relevant
>>> +	 * register byte. Register offset is specified by off parameter.
>>> +	 * Parameter vset provides color code: 0x0 for off, 0x5 for solid red,
>>> +	 * 0x6 for 3Hz blink red, 0xd for solid green, 0xe for 3Hz blink
>>> +	 * green.
>>> +	 * Parameter mask specifies which nibble is used for specific LED:
>> mask
>>> +	 * 0xf0 - lower nibble is to be used (bits from 0 to 3), mask 0x0f -
>>> +	 * higher nibble (bits from 4 to 7).
>>> +	 */
>>> +	ret = regmap_read(pdata->regmap, led->reg, &regval);
>>> +	if (ret < 0) {
>>> +		dev_warn(led_pdata->led_cdev.dev, "Failed to get current
>> brightness, error: %d\n",
>>> +			 ret);
>>> +		/* Assume the LED is OFF */
>>> +		return LED_OFF;
>>> +	}
>>> +
>>> +	regval = regval & ~led->mask;
>>> +	regval = (ror32(led->mask, led->bit) == 0xf0) ? ror32(regval, led->bit)
>>> +		 : ror32(regval, led->bit + 4);
>>> +	if (regval >= led_pdata->base_color &&
>>> +	    regval <= (led_pdata->base_color +
>> MLXREG_LED_OFFSET_BLINK_6HZ))
>>> +		ret = LED_FULL;
>>> +	else
>>> +		ret = LED_OFF;
>>> +
>>> +	return ret;
>>> +}
>>> +
>>> +static int
>>> +mlxreg_led_brightness_set(struct led_classdev *cled, enum
>>> +led_brightness value) {
>>> +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
>>> +
>>> +	if (value)
>>> +		return mlxreg_led_store_hw(led_pdata, led_pdata-
>>> base_color);
>>> +	else
>>> +		return mlxreg_led_store_hw(led_pdata,
>> MLXREG_LED_IS_OFF); }
>>> +
>>> +static enum led_brightness
>>> +mlxreg_led_brightness_get(struct led_classdev *cled) {
>>> +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
>>> +
>>> +	return mlxreg_led_get_hw(led_pdata); }
>>> +
>>> +static int
>>> +mlxreg_led_blink_set(struct led_classdev *cled, unsigned long
>> *delay_on,
>>> +		     unsigned long *delay_off)
>>> +{
>>> +	struct mlxreg_core_led_data *led_pdata = cdev_to_priv(cled);
>>> +	int err;
>>> +
>>> +	/*
>>> +	 * HW supports two types of blinking: full (6Hz) and half (3Hz).
>>> +	 * For delay on/off zero LED is setting to solid color. For others
>>> +	 * combination blinking is to be controlled by the software timer.
>>> +	 */
>>> +	if (!(*delay_on == 0 && *delay_off == 0) &&
>>> +	    !(*delay_on == MLXREG_LED_BLINK_3HZ &&
>>> +	      *delay_off == MLXREG_LED_BLINK_3HZ) &&
>>> +	    !(*delay_on == MLXREG_LED_BLINK_6HZ &&
>>> +	      *delay_off == MLXREG_LED_BLINK_6HZ))
>>> +		return -EINVAL;
>>> +
>>> +	if (*delay_on == MLXREG_LED_BLINK_6HZ)
>>> +		err = mlxreg_led_store_hw(led_pdata, led_pdata-
>>> base_color +
>>> +					  MLXREG_LED_OFFSET_BLINK_6HZ);
>>> +	else if (*delay_on == MLXREG_LED_BLINK_3HZ)
>>> +		err = mlxreg_led_store_hw(led_pdata, led_pdata-
>>> base_color +
>>> +					  MLXREG_LED_OFFSET_BLINK_3HZ);
>>> +	else
>>> +		err = mlxreg_led_store_hw(led_pdata, led_pdata-
>>> base_color);
>>> +
>>> +	return err;
>>> +}
>>> +
>>> +static int mlxreg_led_config(struct mlxreg_led_priv_data *priv) {
>>> +	struct mlxreg_core_led_platform_data *pdata = priv->pdata;
>>> +	struct mlxreg_core_led_data *led_data = pdata->led_data;
>>
>> Please keep the naming consistent. In this function the variable of "struct
>> mlxreg_core_led_data" type is named "led_data" and above it is 'led_pdata'.
>>
>> We have also "struct mlxreg_core_led_platform_data *pdata" for which
>> led_pdata would fit much better.
> 
> OK.
> So would it be good to follow:
> 	struct mlxreg_core_led_platform_data *led_pdata = priv->pdata;
> 	struct mlxreg_core_led_data *led_data = pdata->led_data;
> And drop
> 	struct mlxreg_core_led_data *data;
> 
> Or I again missed something?

Seems reasonable. Please apply this scheme also to the other functions.
In mlxreg_led_brightness_set() you have for instance:

struct mlxreg_core_led_data *led_pdata

The naming should be consistent across whole driver and its
dependencies, i.e. mfd core too.

> 
>>
>>> +	struct mlxreg_core_data *led = led_data->led;
>>> +	struct mlxreg_core_led_data *data;
>>> +	struct led_classdev *led_cdev;
>>> +	int brightness;
>>> +	int i;
>>> +	int err;
>>> +
>>> +	for (i = 0; i < pdata->counter; i++, led_data++, led++) {
>>> +		data = led_data;
>>
>> 'data' seems to be redundant. You can use led_data directly.
>> Anyway, we will have to wait for a review from mfd side. The whole set will
>> go through an integration branch presumably.
> 
> Would be OK to resend the patch v5 after applying your comments?
> Or you suggest to wait with it until mfd and dts reviews?

I suggest to wait for the other reviews.

-- 
Best regards,
Jacek Anaszewski

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2017-08-03 21:29 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-08-03 12:03 [patch v4 0/1] Introduce support for mlxreg LED driver Vadim Pasternak
2017-08-03 12:03 ` [patch v4 1/1] leds: add driver for support Mellanox regmap LEDs for BMC Vadim Pasternak
2017-08-03 11:43   ` Jacek Anaszewski
2017-08-03 12:05     ` Vadim Pasternak
2017-08-03 21:29       ` Jacek Anaszewski

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.