From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S935555AbcIGOoK (ORCPT ); Wed, 7 Sep 2016 10:44:10 -0400 Received: from mail-il-dmz.mellanox.com ([193.47.165.129]:43812 "EHLO mellanox.co.il" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1757447AbcIGOoH (ORCPT ); Wed, 7 Sep 2016 10:44:07 -0400 From: vadimp@mellanox.com To: rpurdie@rpsys.net, j.anaszewski@samsung.com Cc: dave@treblig.org, linux-leds@vger.kernel.org, linux-kernel@vger.kernel.org, jiri@resnulli.us, michaelsh@mellanox.com, Vadim Pasternak Subject: [patch v3] leds: add driver for Mellanox systems leds Date: Wed, 7 Sep 2016 16:42:51 +0000 Message-Id: <1473266571-7105-1-git-send-email-vadimp@mellanox.com> X-Mailer: git-send-email 2.1.4 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Vadim Pasternak This makes it possible to create a set of LEDs for Mellanox systems: "msx6710", "msx6720", "msb7700", "msn2700", "msx1410", "msn2410", "msb7800", "msn2740", "msn2100". Driver obtains led devices according to system configuration, provided through system DMI data, like fan1:green, fan1:red and creates devices in form: "devicename:colour:function". led setting is controlled through on board CPLD Lattice device. For setting particular led off, solid, blink (blink requires ledtrig-timer module): echo 0 > /sys/class/leds/status\:green/brightness echo 1 > /sys/class/leds/status\:green/brightness echo timer > /sys/class/leds/status\:green/trigger On module probing all leds are set green, on removing - off. Last setting overwrites previous, f.e. sequence for changing led from green - red - green: echo 1 > /sys/class/leds/psu\:green/brightness echo 1 > /sys/class/leds/psu\:red/brightness echo 1 > /sys/class/leds/psu\:green/brightness Note: leds cannot be turned on/off simultaneously. The Kconfig currently controlling compilation of this code is: drivers/leds/Kconfig:config LEDS_MLXCPLD Signed-off-by: Vadim Pasternak Reviewed-by: Jiri Pirko --- v2->v3: Fixes issues pointed out by Dave: - fix in comments 3KHz and 6KHz to 3Hz and 6Hz respectively; --- v1->v2: Fixes issues pointed out by Jacek: - fix style in patch cover text; - add doc file with hw description; - arrange include directives in alphabetical order; - make defines more clear; - fix several comments for structure descriptions; - add several empty lines between defentions; - change max_brightness profile setting to 1 instead of LED_FULL; - use capital letters for the enumerator; - change in if (product == NULL) to (!product); - add comments to mlxcpld_led_store_hw; - remove switch statement from mlxcpld_led_brightness; - modify mlxcpld_led_blink; - remove unnecessary devm_kfree in mlxcpld_led_config; - remove switch statement from mlxcpld_led_config; - remove platform_get_drvdata from mlxcpld_led_probe; --- Documentation/leds/leds-mlxcpld.txt | 88 ++++++++ MAINTAINERS | 8 + drivers/leds/Kconfig | 8 + drivers/leds/Makefile | 1 + drivers/leds/leds-mlxcpld.c | 399 ++++++++++++++++++++++++++++++++++++ 5 files changed, 504 insertions(+) create mode 100644 Documentation/leds/leds-mlxcpld.txt create mode 100644 drivers/leds/leds-mlxcpld.c diff --git a/Documentation/leds/leds-mlxcpld.txt b/Documentation/leds/leds-mlxcpld.txt new file mode 100644 index 0000000..575d765 --- /dev/null +++ b/Documentation/leds/leds-mlxcpld.txt @@ -0,0 +1,88 @@ +ver leds-mlxcpld +========================== +Driver for Mellanox systems leds. +Provide system led support for the nex Mellanox systems: +"msx6710", "msx6720", "msb7700", "msn2700", "msx1410", +"msn2410", "msb7800", "msn2740", "msn2100". + +Description +----------- +Driver provides the following leds for the systems "msx6710", "msx6720", +"msb7700", "msn2700", "msx1410", "msn2410", "msb7800", "msn2740": + + "status" + CPLD reg offset: 0x20 + Bits [3:0] + + "psu" + CPLD reg offset: 0x20 + Bits [7:4] + + "fan1" + CPLD reg offset: 0x21 + Bits [3:0] + + "fan2" + CPLD reg offset: 0x21 + Bits [7:4] + + "fan3" + CPLD reg offset: 0x22 + Bits [3:0] + + "fan4" + CPLD reg offset: 0x22 + Bits [7:4] + + Color mask for all the above leds: + [bit3,bit2,bit1,bit0] or + [bit7,bit6,bit5,bit4]: + [0,0,0,0] = LED OFF + [0,1,0,1] = Red static ON + [1,1,0,1] = Green static ON + [0,1,1,0] = Red blink 3Hz + [1,1,1,0] = Green blink 3Hz + [0,1,1,1] = Red blink 6Hz + [1,1,1,1] = Green blink 6Hz + +Driver provides the following leds for the system "msn2100": + "status" + CPLD reg offset: 0x20 + Bits [3:0] + + "fan" + CPLD reg offset: 0x21 + Bits [3:0] + + "psu1" + CPLD reg offset: 0x23 + Bits [3:0] + + "psu2" + CPLD reg offset: 0x23 + Bits [7:4] + + "uid" + CPLD reg offset: 0x24 + Bits [3:0] + + Color mask for all the above leds, excepted uid: + [bit3,bit2,bit1,bit0] or + [bit7,bit6,bit5,bit4]: + [0,0,0,0] = LED OFF + [0,1,0,1] = Red static ON + [1,1,0,1] = Green static ON + [0,1,1,0] = Red blink 3Hz + [1,1,1,0] = Green blink 3Hz + [0,1,1,1] = Red blink 6Hz + [1,1,1,1] = Green blink 6Hz + + Color mask for uid led: + [bit3,bit2,bit1,bit0]: + [0,0,0,0] = LED OFF + [1,1,0,1] = Blue static ON + [1,1,1,0] = Blue blink 3Hz + [1,1,1,1] = Blue blink 6Hz + +Driver supports HW blinking at 3Hz and 6Hz frequency (50% duty cycle). +For 3Hz it is about 40 msec off and 40 msec on, for 6Hz - 80 msec off and on. diff --git a/MAINTAINERS b/MAINTAINERS index 0bbe4b1..adb9e9b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7655,6 +7655,14 @@ W: http://www.mellanox.com Q: http://patchwork.ozlabs.org/project/netdev/list/ F: drivers/net/ethernet/mellanox/mlxsw/ +MELLANOX MLXCPLD LED DRIVER +M: Vadim Pasternak +L: linux-leds@vger.kernel.org +S: Supported +W: http://www.mellanox.com +F: drivers/leds/leds-mlxcpld.c +F: Documentation/leds/leds-mlxcpld.txt + SOFT-ROCE DRIVER (rxe) M: Moni Shoua L: linux-rdma@vger.kernel.org diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig index 9dcc9b1..4cd85be 100644 --- a/drivers/leds/Kconfig +++ b/drivers/leds/Kconfig @@ -631,6 +631,14 @@ config LEDS_VERSATILE This option enabled support for the LEDs on the ARM Versatile and RealView boards. Say Y to enabled these. +config LEDS_MLXCPLD + tristate "LED support for the Mellanox boards" + depends on X86_64 && DMI + depends on LEDS_CLASS + help + This option enabled support for the LEDs on the Mellanox + boards. Say Y to enabled these. + comment "LED Triggers" source "drivers/leds/trigger/Kconfig" diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile index 0684c86..9a2494b 100644 --- a/drivers/leds/Makefile +++ b/drivers/leds/Makefile @@ -68,6 +68,7 @@ obj-$(CONFIG_LEDS_KTD2692) += leds-ktd2692.o obj-$(CONFIG_LEDS_POWERNV) += leds-powernv.o obj-$(CONFIG_LEDS_SEAD3) += leds-sead3.o obj-$(CONFIG_LEDS_IS31FL32XX) += leds-is31fl32xx.o +obj-$(CONFIG_LEDS_MLXCPLD) += leds-mlxcpld.o # LED SPI Drivers obj-$(CONFIG_LEDS_DAC124S085) += leds-dac124s085.o diff --git a/drivers/leds/leds-mlxcpld.c b/drivers/leds/leds-mlxcpld.c new file mode 100644 index 0000000..eeed35c --- /dev/null +++ b/drivers/leds/leds-mlxcpld.c @@ -0,0 +1,399 @@ +/* + * drivers/leds/leds-mlxcpld.c + * Copyright (c) 2016 Mellanox Technologies. All rights reserved. + * Copyright (c) 2016 Vadim Pasternak + * + * 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 +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define MLXPLAT_CPLD_LPC_REG_BASE_ADRR 0x2500 /* LPC bus access */ + +/* Color codes for leds */ +#define LED_OFFSET_HALF 0x01 /* Offset from solid for 3Hz blink */ +#define LED_OFFSET_FULL 0x02 /* Offset from solid for 6Hz blink */ +#define LED_IS_OFF 0x00 /* Off */ +#define LED_RED_STATIC_ON 0x05 /* Solid red */ +#define LED_RED_BLINK_HALF (LED_RED_STATIC_ON + LED_OFFSET_HALF) +#define LED_RED_BLINK_FULL (LED_RED_STATIC_ON + LED_OFFSET_FULL) +#define LED_GREEN_STATIC_ON 0x0D /* Solid green */ +#define LED_GREEN_BLINK_HALF (LED_GREEN_STATIC_ON + LED_OFFSET_HALF) +#define LED_GREEN_BLINK_FULL (LED_GREEN_STATIC_ON + LED_OFFSET_FULL) +#define LED_BLINK_3HZ 160 /* ~160 msec off/on */ +#define LED_BLINK_6HZ 80 /* ~80 msec off/on */ + +/** + * mlxcpld_param - led access parameters: + * @offset - offset for led access in CPLD device + * @mask - mask for led access in CPLD device + * @base_color - base color code for led +**/ +struct mlxcpld_param { + u8 offset; + u8 mask; + u8 base_color; +}; + +/** + * mlxcpld_led_priv - led private data: + * @cled - led class device instance + * @param - led CPLD access parameters +**/ +struct mlxcpld_led_priv { + struct led_classdev cdev; + struct mlxcpld_param param; +}; + +#define cdev_to_priv(c) container_of(c, struct mlxcpld_led_priv, cdev) + +/** + * mlxcpld_led_profile - system led profile (defined per system class): + * @offset - offset for led access in CPLD device + * @mask - mask for led access in CPLD device + * @base_color - base color code + * @brightness - default brightness setting (on/off) + * @name - led name +**/ +struct mlxcpld_led_profile { + u8 offset; + u8 mask; + u8 base_color; + enum led_brightness brightness; + const char *name; +}; + +/** + * mlxcpld_led_pdata - system led private data + * @pdev - platform device pointer + * @pled - led class device instance + * @profile - system configuration profile + * @num_led_instances - number of led instances + * @lock - device access lock +**/ +struct mlxcpld_led_pdata { + struct platform_device *pdev; + struct mlxcpld_led_priv *pled; + struct mlxcpld_led_profile *profile; + int num_led_instances; + spinlock_t lock; +}; + +static struct mlxcpld_led_pdata *mlxcpld_led; + +/* Default profile fit the next Mellanox systems: + * "msx6710", "msx6720", "msb7700", "msn2700", "msx1410", + * "msn2410", "msb7800", "msn2740" + */ +struct mlxcpld_led_profile mlxcpld_led_default_profile[] = { + { + 0x21, 0xf0, LED_GREEN_STATIC_ON, 1, "fan1:green", + }, + { + 0x21, 0xf0, LED_RED_STATIC_ON, LED_OFF, "fan1:red", + }, + { + 0x21, 0x0f, LED_GREEN_STATIC_ON, 1, "fan2:green", + }, + { + 0x21, 0x0f, LED_RED_STATIC_ON, LED_OFF, "fan2:red", + }, + { + 0x22, 0xf0, LED_GREEN_STATIC_ON, 1, "fan3:green", + }, + { + 0x22, 0xf0, LED_RED_STATIC_ON, LED_OFF, "fan3:red", + }, + { + 0x22, 0x0f, LED_GREEN_STATIC_ON, 1, "fan4:green", + }, + { + 0x22, 0x0f, LED_RED_STATIC_ON, LED_OFF, "fan4:red", + }, + { + 0x20, 0x0f, LED_GREEN_STATIC_ON, 1, "psu:green", + }, + { + 0x20, 0x0f, LED_RED_STATIC_ON, LED_OFF, "psu:red", + }, + { + 0x20, 0xf0, LED_GREEN_STATIC_ON, 1, "status:green", + }, + { + 0x20, 0xf0, LED_RED_STATIC_ON, LED_OFF, "status:red", + }, +}; + +/* Profile fit the Mellanox systems based on "msn2100" */ +struct mlxcpld_led_profile mlxcpld_led_msn2100_profile[] = { + { + 0x21, 0xf0, LED_GREEN_STATIC_ON, 1, "fan:green", + }, + { + 0x21, 0xf0, LED_RED_STATIC_ON, LED_OFF, "fan:red", + }, + { + 0x23, 0xf0, LED_GREEN_STATIC_ON, 1, "psu1:green", + }, + { + 0x23, 0xf0, LED_RED_STATIC_ON, LED_OFF, "psu1:red", + }, + { + 0x23, 0x0f, LED_GREEN_STATIC_ON, 1, "psu2:green", + }, + { + 0x23, 0x0f, LED_RED_STATIC_ON, LED_OFF, "psu2:red", + }, + { + 0x20, 0xf0, LED_GREEN_STATIC_ON, 1, "status:green", + }, + { + 0x20, 0xf0, LED_RED_STATIC_ON, LED_OFF, "status:red", + }, + { + 0x24, 0xf0, LED_GREEN_STATIC_ON, LED_OFF, "uid:blue", + }, +}; + +enum mlxcpld_led_platform_types { + MLXCPLD_LED_PLATFORM_DEFAULT, + MLXCPLD_LED_PLATFORM_MSN2100, +}; + +const char *mlx_product_names[] = { + "DEFAULT", + "MSN2100", +}; + +static enum +mlxcpld_led_platform_types mlxcpld_led_platform_check_sys_type(void) +{ + const char *mlx_product_name; + int i; + + mlx_product_name = dmi_get_system_info(DMI_PRODUCT_NAME); + if (!mlx_product_name) + return MLXCPLD_LED_PLATFORM_DEFAULT; + + for (i = 1; i < ARRAY_SIZE(mlx_product_names); i++) { + if (strstr(mlx_product_name, mlx_product_names[i])) + return i; + } + + return MLXCPLD_LED_PLATFORM_DEFAULT; +} + +static void mlxcpld_led_bus_access_func(u16 base, u8 offset, u8 rw_flag, + u8 *data) +{ + u32 addr = base + offset; + + if (rw_flag == 0) + outb(*data, addr); + else + *data = inb(addr); +} + +static void mlxcpld_led_store_hw(u8 mask, u8 off, u8 vset) +{ + u8 nib, val; + + /* Each led is controlled through low or high nibble of the relevant + * CPLD register. 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). + */ + spin_lock(&mlxcpld_led->lock); + mlxcpld_led_bus_access_func(MLXPLAT_CPLD_LPC_REG_BASE_ADRR, off, 1, + &val); + nib = (mask == 0xf0) ? vset : (vset << 4); + val = (val & mask) | nib; + mlxcpld_led_bus_access_func(MLXPLAT_CPLD_LPC_REG_BASE_ADRR, off, 0, + &val); + spin_unlock(&mlxcpld_led->lock); +} + +static void mlxcpld_led_brightness(struct led_classdev *led, + enum led_brightness value) +{ + struct mlxcpld_led_priv *pled = cdev_to_priv(led); + + if (value) { + mlxcpld_led_store_hw(pled->param.mask, pled->param.offset, + pled->param.base_color); + return; + } + + mlxcpld_led_store_hw(pled->param.mask, pled->param.offset, + LED_IS_OFF); +} + +static int mlxcpld_led_blink(struct led_classdev *led, + unsigned long *delay_on, + unsigned long *delay_off) +{ + struct mlxcpld_led_priv *pled = cdev_to_priv(led); + + /* HW supports two types of blinking: full (6Hz) and half (3Hz). + * For delay on/off zero default setting 3Hz is used. + */ + if (!(*delay_on == 0 && *delay_off == 0) && + !(*delay_on == LED_BLINK_3HZ && *delay_off == LED_BLINK_3HZ) && + !(*delay_on == LED_BLINK_6HZ && *delay_off == LED_BLINK_6HZ)) + return -EINVAL; + + if (*delay_on == LED_BLINK_6HZ) + mlxcpld_led_store_hw(pled->param.mask, pled->param.offset, + pled->param.base_color + LED_OFFSET_FULL); + else + mlxcpld_led_store_hw(pled->param.mask, pled->param.offset, + pled->param.base_color + LED_OFFSET_HALF); + + return 0; +} + +static int mlxcpld_led_config(struct device *dev, + struct mlxcpld_led_pdata *cpld) +{ + int i; + int err; + + cpld->pled = devm_kzalloc(dev, sizeof(struct mlxcpld_led_priv) * + cpld->num_led_instances, GFP_KERNEL); + if (!cpld->pled) + return -ENOMEM; + + for (i = 0; i < cpld->num_led_instances; i++) { + cpld->pled[i].cdev.name = cpld->profile[i].name; + cpld->pled[i].cdev.brightness = cpld->profile[i].brightness; + cpld->pled[i].cdev.max_brightness = 1; + cpld->pled[i].cdev.brightness_set = mlxcpld_led_brightness; + cpld->pled[i].cdev.blink_set = mlxcpld_led_blink; + cpld->pled[i].cdev.flags = LED_CORE_SUSPENDRESUME; + err = devm_led_classdev_register(dev, &cpld->pled[i].cdev); + if (err) + return err; + + cpld->pled[i].param.offset = mlxcpld_led->profile[i].offset; + cpld->pled[i].param.mask = mlxcpld_led->profile[i].mask; + cpld->pled[i].param.base_color = + mlxcpld_led->profile[i].base_color; + + if (mlxcpld_led->profile[i].brightness) + mlxcpld_led_brightness(&cpld->pled[i].cdev, + mlxcpld_led->profile[i].brightness); + } + + return 0; +} + +static int __init mlxcpld_led_probe(struct platform_device *pdev) +{ + enum mlxcpld_led_platform_types mlxcpld_led_plat = + mlxcpld_led_platform_check_sys_type(); + + mlxcpld_led = devm_kzalloc(&pdev->dev, sizeof(*mlxcpld_led), + GFP_KERNEL); + if (!mlxcpld_led) + return -ENOMEM; + + mlxcpld_led->pdev = pdev; + + switch (mlxcpld_led_plat) { + case MLXCPLD_LED_PLATFORM_MSN2100: + mlxcpld_led->profile = mlxcpld_led_msn2100_profile; + mlxcpld_led->num_led_instances = + ARRAY_SIZE(mlxcpld_led_msn2100_profile); + break; + + default: + mlxcpld_led->profile = mlxcpld_led_default_profile; + mlxcpld_led->num_led_instances = + ARRAY_SIZE(mlxcpld_led_default_profile); + break; + } + + spin_lock_init(&mlxcpld_led->lock); + + return mlxcpld_led_config(&pdev->dev, mlxcpld_led); +} + +static struct platform_driver mlxcpld_led_driver = { + .driver = { + .name = KBUILD_MODNAME, + }, +}; + +static int __init mlxcpld_led_init(void) +{ + struct platform_device *pdev; + int err; + + pdev = platform_device_register_simple(KBUILD_MODNAME, -1, NULL, 0); + if (!pdev) { + pr_err("Device allocation failed\n"); + return -ENOMEM; + } + + err = platform_driver_probe(&mlxcpld_led_driver, mlxcpld_led_probe); + if (err) { + pr_err("Probe platform driver failed\n"); + platform_device_unregister(pdev); + } + + return err; +} + +static void __exit mlxcpld_led_exit(void) +{ + platform_device_unregister(mlxcpld_led->pdev); + platform_driver_unregister(&mlxcpld_led_driver); +} + +module_init(mlxcpld_led_init); +module_exit(mlxcpld_led_exit); + +MODULE_AUTHOR("Vadim Pasternak (vadimp@mellanox.com)"); +MODULE_DESCRIPTION("Mellanox board LED driver"); +MODULE_LICENSE("GPL v2"); +MODULE_ALIAS("platform:leds_mlxcpld"); -- 2.1.4