Re: [PATCH] Add Silicom Platform Driver
From: Ilpo Järvinen
Date: Wed Jul 19 2023 - 08:13:33 EST
On Tue, 18 Jul 2023, Henry Shi wrote:
> The Silicom platform (silicom-platform) Linux driver for Swisscom
> Business Box (Swisscom BB) as well as Cordoba family products is a
> software solution designed to facilitate the efficient management
> and control of devices through the integration of various Linux
> frameworks. This platform driver provides seamless support for
> device management via the Linux LED framework, GPIO framework,
> Hardware Monitoring (HWMON), and device attributes. The Silicom
> platform driver's compatibility with these Linux frameworks allows
> applications to access and control Cordoba family devices using
> existing software that is compatible with these frameworks. This
> compatibility simplifies the development process, reduces
> dependencies on proprietary solutions, and promotes
> interoperability with other Linux-based systems and software.
>
> Signed-off-by: Henry Shi <henryshi2018@xxxxxxxxx>
> ---
> drivers/platform/x86/Kconfig | 12 +
> drivers/platform/x86/Makefile | 1 +
> drivers/platform/x86/silicom-platform.c | 1123 +++++++++++++++++++++++
> 3 files changed, 1136 insertions(+)
> create mode 100644 drivers/platform/x86/silicom-platform.c
>
> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> index 22052031c719..8c0988c2b4ce 100644
> --- a/drivers/platform/x86/Kconfig
> +++ b/drivers/platform/x86/Kconfig
> @@ -188,6 +188,18 @@ config ACER_WMI
> If you have an ACPI-WMI compatible Acer/ Wistron laptop, say Y or M
> here.
>
> +
Extra newline
> +config SILICOM_PLATFORM
> + tristate "Silicom Edge Networking device support"
> + depends on DMI
> + select LEDS_CLASS_MULTICOLOR
> + select GPIOLIB
> + help
> + This option enables support for the LEDs/GPIO/etc downstream of the
> + embedded controller on Silicom "Cordoba" hardware and derivatives.
> +
> + If you have a Silicom network appliance, say Y or M here.
> +
> source "drivers/platform/x86/amd/Kconfig"
>
> config ADV_SWBUTTON
> diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
> index 2cafe51ec4d8..f2f5743a9e54 100644
> --- a/drivers/platform/x86/Makefile
> +++ b/drivers/platform/x86/Makefile
> @@ -113,6 +113,7 @@ obj-$(CONFIG_SERIAL_MULTI_INSTANTIATE) += serial-multi-instantiate.o
> obj-$(CONFIG_MLX_PLATFORM) += mlx-platform.o
> obj-$(CONFIG_TOUCHSCREEN_DMI) += touchscreen_dmi.o
> obj-$(CONFIG_WIRELESS_HOTKEY) += wireless-hotkey.o
> +obj-$(CONFIG_SILICOM_PLATFORM) += silicom-platform.o
Use tabs like the other lines.
> obj-$(CONFIG_X86_ANDROID_TABLETS) += x86-android-tablets/
>
> # Intel uncore drivers
> diff --git a/drivers/platform/x86/silicom-platform.c b/drivers/platform/x86/silicom-platform.c
> new file mode 100644
> index 000000000000..90431f733682
> --- /dev/null
> +++ b/drivers/platform/x86/silicom-platform.c
> @@ -0,0 +1,1123 @@
> +// SPDX-License-Identifier: GPL-2.0+
> +//
> +// silicom-platform.c - Silicom MEC170x platform driver
> +//
> +// Copyright (C) 2023 Henry Shi <henrys@xxxxxxxxxxxxxxx>
> +
> +#include <linux/dmi.h>
> +#include <linux/gpio/driver.h>
> +#include <linux/init.h>
> +#include <linux/ioport.h>
> +#include <linux/io.h>
> +#include <linux/kernel.h>
> +#include <linux/led-class-multicolor.h>
> +#include <linux/module.h>
> +#include <linux/hwmon.h>
> +#include <linux/mutex.h>
> +#include <linux/platform_device.h>
> +#include <linux/string.h>
> +#include <linux/thermal.h>
> +#include <linux/kobject.h>
> +#include <linux/sysfs.h>
> +
> +#define MEC_ADDR ((mec_io_base) + 0x02)
> +#define MEC_DATA(byte) ((mec_io_base) + 0x04 + (byte))
> +#define EC_ADDR_LSB MEC_ADDR
> +#define EC_ADDR_MSB ((mec_io_base) + 0x03)
> +#define SILICOM_MEC_MAGIC 0x5a
> +#define OFFSET_BIT_TO_CHANNEL(off, bit) ((((off) + 0x014) << 3) | (bit))
> +#define CHANNEL_TO_OFFSET(chan) (((chan) >> 3) - 0x14)
So you have two fields, offset and "bit", whatever that is. It would seem
named define with GENMASK() for these two fields and FIELD_PREP() is
appropriate here. And FIELD_GET() (and perhaps also FIELD_PREP()) used in
the code below where appropriate.
0x14 should be named with a define.
> +#define CHANNEL_TO_BIT(chan) ((chan) & 0x07)
Unused.
> +
> +static DEFINE_MUTEX(mec_io_mutex);
> +static int mec_io_base, mec_io_len;
> +
> +struct silicom_fan_control_data {
> + struct device *hdev;
> + int temp;
> + int fan_speed;
> +};
> +
> +static const struct hwmon_channel_info *silicom_fan_control_info[] = {
> + HWMON_CHANNEL_INFO(fan, HWMON_F_INPUT | HWMON_F_LABEL),
> + HWMON_CHANNEL_INFO(temp, HWMON_T_INPUT | HWMON_T_LABEL),
> + NULL
> +};
> +
> +struct silicom_device_control_data {
> + struct device *my_dev;
> + int efuse_status;
> + int uc_version;
> + int power_cycle;
> +};
> +static struct silicom_device_control_data my_dev_ctl;
> +
> +struct silicom_platform_info {
> + int io_base;
> + int io_len;
> + struct led_classdev_mc *led_info;
> + struct gpio_chip *gpiochip;
> + u8 *gpio_channels;
> + u16 ngpio;
> +};
> +
> +static const char * const plat_0222_gpio_names[] = {
> + "AUTOM0_SFP_TX_FAULT",
> + "SLOT2_LED_OUT",
> + "SIM_M2_SLOT2_B_DET",
> + "SIM_M2_SLOT2_A_DET",
> + "SLOT1_LED_OUT",
> + "SIM_M2_SLOT1_B_DET",
> + "SIM_M2_SLOT1_A_DET",
> + "SLOT0_LED_OUT",
> + "WAN_SFP0_RX_LOS",
> + "WAN_SFP0_PRSNT_N",
> + "WAN_SFP0_TX_FAULT",
> + "AUTOM1_SFP_RX_LOS",
> + "AUTOM1_SFP_PRSNT_N",
> + "AUTOM1_SFP_TX_FAULT",
> + "AUTOM0_SFP_RX_LOS",
> + "AUTOM0_SFP_PRSNT_N",
> + "WAN_SFP1_RX_LOS",
> + "WAN_SFP1_PRSNT_N",
> + "WAN_SFP1_TX_FAULT",
> + "SIM_M2_SLOT1_MUX_SEL",
> + "W_DISABLE_M2_SLOT1_N",
> + "W_DISABLE_MPCIE_SLOT0_N",
> + "W_DISABLE_M2_SLOT0_N",
> + "BT_COMMAND_MODE",
> + "WAN_SFP1_TX_DISABLE",
> + "WAN_SFP0_TX_DISABLE",
> + "AUTOM1_SFP_TX_DISABLE",
> + "AUTOM0_SFP_TX_DISABLE",
> + "SIM_M2_SLOT2_MUX_SEL",
> + "W_DISABLE_M2_SLOT2_N",
> + "RST_CTL_M2_SLOT_1_N",
> + "RST_CTL_M2_SLOT_2_N",
> + "PM_USB_PWR_EN_BOT",
> + "PM_USB_PWR_EN_TOP",
> +};
> +
> +static u8 plat_0222_gpio_channels[] = {
> + OFFSET_BIT_TO_CHANNEL(0x00, 0),
> + OFFSET_BIT_TO_CHANNEL(0x00, 1),
> + OFFSET_BIT_TO_CHANNEL(0x00, 2),
> + OFFSET_BIT_TO_CHANNEL(0x00, 3),
> + OFFSET_BIT_TO_CHANNEL(0x00, 4),
> + OFFSET_BIT_TO_CHANNEL(0x00, 5),
> + OFFSET_BIT_TO_CHANNEL(0x00, 6),
> + OFFSET_BIT_TO_CHANNEL(0x00, 7),
> + OFFSET_BIT_TO_CHANNEL(0x01, 0),
> + OFFSET_BIT_TO_CHANNEL(0x01, 1),
> + OFFSET_BIT_TO_CHANNEL(0x01, 2),
> + OFFSET_BIT_TO_CHANNEL(0x01, 3),
> + OFFSET_BIT_TO_CHANNEL(0x01, 4),
> + OFFSET_BIT_TO_CHANNEL(0x01, 5),
> + OFFSET_BIT_TO_CHANNEL(0x01, 6),
> + OFFSET_BIT_TO_CHANNEL(0x01, 7),
> + OFFSET_BIT_TO_CHANNEL(0x02, 0),
> + OFFSET_BIT_TO_CHANNEL(0x02, 1),
> + OFFSET_BIT_TO_CHANNEL(0x02, 2),
> + OFFSET_BIT_TO_CHANNEL(0x09, 0),
> + OFFSET_BIT_TO_CHANNEL(0x09, 1),
> + OFFSET_BIT_TO_CHANNEL(0x09, 2),
> + OFFSET_BIT_TO_CHANNEL(0x09, 3),
> + OFFSET_BIT_TO_CHANNEL(0x0a, 0),
> + OFFSET_BIT_TO_CHANNEL(0x0a, 1),
> + OFFSET_BIT_TO_CHANNEL(0x0a, 2),
> + OFFSET_BIT_TO_CHANNEL(0x0a, 3),
> + OFFSET_BIT_TO_CHANNEL(0x0a, 4),
> + OFFSET_BIT_TO_CHANNEL(0x0a, 5),
> + OFFSET_BIT_TO_CHANNEL(0x0a, 6),
> + OFFSET_BIT_TO_CHANNEL(0x0b, 0),
> + OFFSET_BIT_TO_CHANNEL(0x0b, 1),
> + OFFSET_BIT_TO_CHANNEL(0x0b, 2),
> + OFFSET_BIT_TO_CHANNEL(0x0b, 3),
> +};
> +
> +static int silicom_gpio_get_direction(struct gpio_chip *gc, unsigned int offset);
> +static int silicom_gpio_direction_input(struct gpio_chip *gc, unsigned int offset);
> +static int silicom_gpio_direction_output(struct gpio_chip *gc, unsigned int offset, int value);
> +static int silicom_gpio_get(struct gpio_chip *gc, unsigned int offset);
> +static void silicom_gpio_set(struct gpio_chip *gc, unsigned int offset, int value);
> +static void silicom_mec_led_mc_brightness_set(struct led_classdev *led_cdev,
> + enum led_brightness brightness);
> +static enum led_brightness silicom_mec_led_mc_brightness_get(struct led_classdev *led_cdev);
Try to organize the code such that no forward declarations are necessary.
> +static struct platform_device *silicom_platform_dev;
> +static struct led_classdev_mc *silicom_led_info __initdata;
> +static struct gpio_chip *silicom_gpiochip __initdata;
> +static u8 *silicom_gpio_channels __initdata;
> +static struct gpio_chip silicom_gpio_chip = {
> + .label = "silicom-gpio",
> + .get_direction = silicom_gpio_get_direction,
> + .direction_input = silicom_gpio_direction_input,
> + .direction_output = silicom_gpio_direction_output,
> + .get = silicom_gpio_get,
> + .set = silicom_gpio_set,
> + .base = -1,
> + .ngpio = ARRAY_SIZE(plat_0222_gpio_channels),
> + .names = plat_0222_gpio_names,
> + /* We're using a mutex to protect the indirect access, so we can sleep if the lock blocks */
> + .can_sleep = true,
> +};
> +
> +static struct mc_subled plat_0222_wan_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_WHITE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 7),
> + },
> + {
> + .color_index = LED_COLOR_ID_YELLOW,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 6),
> + },
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 5),
> + },
> +};
> +
> +static struct mc_subled plat_0222_sys_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_WHITE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 4),
> + },
> + {
> + .color_index = LED_COLOR_ID_AMBER,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 3),
> + },
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 2),
> + },
> +};
> +
> +static struct mc_subled plat_0222_stat1_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 1),
> + },
> + {
> + .color_index = LED_COLOR_ID_GREEN,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0c, 0),
> + },
> + {
> + .color_index = LED_COLOR_ID_BLUE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 7),
> + },
> + {
> + .color_index = LED_COLOR_ID_YELLOW,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 6),
> + },
> +};
> +
> +static struct mc_subled plat_0222_stat2_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 5),
> + },
> + {
> + .color_index = LED_COLOR_ID_GREEN,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 4),
> + },
> + {
> + .color_index = LED_COLOR_ID_BLUE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 3),
> + },
> + {
> + .color_index = LED_COLOR_ID_YELLOW,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 2),
> + },
> +};
> +
> +static struct mc_subled plat_0222_stat3_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 1),
> + },
> + {
> + .color_index = LED_COLOR_ID_GREEN,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0d, 0),
> + },
> + {
> + .color_index = LED_COLOR_ID_BLUE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0e, 1),
> + },
> + {
> + .color_index = LED_COLOR_ID_YELLOW,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x0e, 0),
> + },
> +};
> +
> +static struct led_classdev_mc plat_0222_mc_led_info[] __initdata = {
> + {
> + .led_cdev = {
> + .name = "multicolor:wan",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(plat_0222_wan_mc_subled_info),
> + .subled_info = plat_0222_wan_mc_subled_info,
> + },
> + {
> + .led_cdev = {
> + .name = "multicolor:sys",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(plat_0222_sys_mc_subled_info),
> + .subled_info = plat_0222_sys_mc_subled_info,
> + },
> + {
> + .led_cdev = {
> + .name = "multicolor:stat1",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(plat_0222_stat1_mc_subled_info),
> + .subled_info = plat_0222_stat1_mc_subled_info,
> + },
> + {
> + .led_cdev = {
> + .name = "multicolor:stat2",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(plat_0222_stat2_mc_subled_info),
> + .subled_info = plat_0222_stat2_mc_subled_info,
> + },
> + {
> + .led_cdev = {
> + .name = "multicolor:stat3",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(plat_0222_stat3_mc_subled_info),
> + .subled_info = plat_0222_stat3_mc_subled_info,
> + },
> + { },
> +};
> +
> +static struct silicom_platform_info silicom_plat_0222_cordoba_info __initdata = {
> + .io_base = 0x800,
> + .io_len = 8,
> + .led_info = plat_0222_mc_led_info,
> + .gpiochip = &silicom_gpio_chip,
> + .gpio_channels = plat_0222_gpio_channels,
> + /* The original generic cordoba does not have the last 4 outputs of the plat_0222 BB variant,
> + * the rest are the same, so use the same longer list, but ignore the last entries here
> + */
> + .ngpio = ARRAY_SIZE(plat_0222_gpio_channels),
> +
> +};
> +
> +static struct mc_subled cordoba_fp_left_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 6),
> + },
> + {
> + .color_index = LED_COLOR_ID_GREEN,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 5),
> + },
> + {
> + .color_index = LED_COLOR_ID_BLUE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x09, 7),
> + },
> + {
> + .color_index = LED_COLOR_ID_AMBER,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x09, 4),
> + },
> +};
> +
> +static struct mc_subled cordoba_fp_center_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 7),
> + },
> + {
> + .color_index = LED_COLOR_ID_GREEN,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 4),
> + },
> + {
> + .color_index = LED_COLOR_ID_BLUE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 3),
> + },
> + {
> + .color_index = LED_COLOR_ID_AMBER,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x09, 6),
> + },
> +};
> +
> +static struct mc_subled cordoba_fp_right_mc_subled_info[] __initdata = {
> + {
> + .color_index = LED_COLOR_ID_RED,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 2),
> + },
> + {
> + .color_index = LED_COLOR_ID_GREEN,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 1),
> + },
> + {
> + .color_index = LED_COLOR_ID_BLUE,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x08, 0),
> + },
> + {
> + .color_index = LED_COLOR_ID_AMBER,
> + .brightness = 1,
> + .intensity = 0,
> + .channel = OFFSET_BIT_TO_CHANNEL(0x09, 5),
> + },
> +};
> +
> +static struct led_classdev_mc cordoba_mc_led_info[] __initdata = {
> + {
> + .led_cdev = {
> + .name = "multicolor:fp_left",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(cordoba_fp_left_mc_subled_info),
> + .subled_info = cordoba_fp_left_mc_subled_info,
> + },
> + {
> + .led_cdev = {
> + .name = "multicolor:fp_center",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(cordoba_fp_center_mc_subled_info),
> + .subled_info = cordoba_fp_center_mc_subled_info,
> + },
> + {
> + .led_cdev = {
> + .name = "multicolor:fp_right",
> + .brightness = 0,
> + .max_brightness = 1,
> + .brightness_set = silicom_mec_led_mc_brightness_set,
> + .brightness_get = silicom_mec_led_mc_brightness_get,
> + },
> + .num_colors = ARRAY_SIZE(cordoba_fp_right_mc_subled_info),
> + .subled_info = cordoba_fp_right_mc_subled_info,
> + },
> + { },
> +};
> +
> +static struct silicom_platform_info silicom_generic_cordoba_info __initdata = {
> + .io_base = 0x800,
> + .io_len = 8,
> + .led_info = cordoba_mc_led_info,
> + .gpiochip = &silicom_gpio_chip,
> + .gpio_channels = plat_0222_gpio_channels,
> + .ngpio = ARRAY_SIZE(plat_0222_gpio_channels),
> +};
> +
> +static struct platform_driver silicom_platform_driver = {
> + .driver = {
> + .name = "silicom-platform",
> + },
> +};
> +
> +void lock_io_modules(void)
> +{
> + mutex_lock(&mec_io_mutex);
> +}
> +EXPORT_SYMBOL(lock_io_modules);
> +
> +void unlock_io_modules(void)
> +{
> + mutex_unlock(&mec_io_mutex);
> +}
> +EXPORT_SYMBOL(unlock_io_modules);
> +
> +static ssize_t efuse_status_show(struct device *dev, struct device_attribute *attr,
> + char *buf)
> +{
> + u32 reg;
> + u32 bank = 0;
> + u32 offset = 0x28;
Why is this not a named define?
No need for bank & offset variables.
> + u32 byte_pos = 0;
> +
> + mutex_lock(&mec_io_mutex);
> + /* Select memory region */
> + outb(bank, EC_ADDR_MSB);
> + outb(offset, EC_ADDR_LSB);
> +
> + /* Get current date from the address */
> + reg = inl(MEC_DATA(byte_pos));
> + mutex_unlock(&mec_io_mutex);
> +
> + my_dev_ctl.efuse_status = reg & 0x1;
> +
> + return sprintf(buf, "%d\n", my_dev_ctl.efuse_status);
> +}
> +
> +static ssize_t uc_version_show(struct device *dev,
> + struct device_attribute *attr,
> + char *buf)
> +{
> + u32 reg;
> + u32 bank = 0;
> + u32 offset = 0x0;
Ditto.
> + u32 byte_pos = 0;
> + int uc_version;
> +
> + mutex_lock(&mec_io_mutex);
> + outb(bank, EC_ADDR_MSB);
> + outb(offset, EC_ADDR_LSB);
> +
> + reg = inl(MEC_DATA(byte_pos));
> + mutex_unlock(&mec_io_mutex);
> +
> + uc_version = (reg >> 8) & 0xFF;
Define a named mask with GENMASK() and use FIELD_GET().
> + if (uc_version >= 64 && uc_version < 128) {
> + uc_version = uc_version - 64;
Testing for a bit (or two bit field inside the version actually
considering the other if too) in version and then handcrafting & ~THATBIT?
> + if (uc_version < 10)
> + uc_version = 100 + uc_version;
> + else
> + uc_version = 100 + 10 * (uc_version / 10) + uc_version % 10;
Why is this if necessary? Doesn't the latter yield the same value as the
first one when uc_version < 10?
> + } else if (uc_version >= 128 && uc_version < 192) {
> + uc_version = uc_version - 128;
> + if (uc_version < 10)
> + uc_version = 200 + uc_version;
> + else
> + uc_version = 200 + 10 * (uc_version / 10) + uc_version % 10;
Similar comments to this block.
> + }
> + my_dev_ctl.uc_version = uc_version;
> + return sprintf(buf, "%d\n", my_dev_ctl.uc_version);
> +}
> +
> +static ssize_t power_cycle_show(struct device *dev,
> + struct device_attribute *attr,
> + char *buf)
> +{
> + return sprintf(buf, "%d\n", my_dev_ctl.power_cycle);
> +}
> +
> +static void powercycle_uc(void)
> +{
> + u32 bank = 0;
> + u32 offset = 0x24;
Named define, no need for these variables.
> + u32 byte_pos = 0;
> +
> + mutex_lock(&mec_io_mutex);
> + /* Select memory region */
> + outb(bank, EC_ADDR_MSB);
> + outb(offset, EC_ADDR_LSB);
> +
> + /* Set to 1 for current date from the address */
> + outb(1, MEC_DATA(byte_pos));
Hmm, this is really misleading. MEC_DATA() seems to calculate _an offset_,
not data? Name things accordingly.
> + mutex_unlock(&mec_io_mutex);
> +}
> +
> +static ssize_t power_cycle_store(struct device *dev, struct device_attribute *attr,
> + const char *buf, size_t count)
> +{
> + if (sscanf(buf, "%du", &my_dev_ctl.power_cycle) != 1) {
> + dev_err(dev, "Failed to read power_cycle\n");
> + return -EINVAL;
> + }
> + if (my_dev_ctl.power_cycle > 0)
> + powercycle_uc();
> +
> + return count;
> +}
> +
> +static struct device_attribute my_dev_attr[] = {
> + {
> + .attr = {.name = "efuse_status", .mode = 0644},
> + .show = efuse_status_show,
> + .store = NULL
> + },
> + {
> + .attr = {.name = "uc_version", .mode = 0644},
> + .show = uc_version_show,
> + .store = NULL
> + },
> + {
> + .attr = {.name = "power_cycle", .mode = 0644},
> + .show = power_cycle_show,
> + .store = power_cycle_store
> + },
> +};
> +
> +static int silicom_gpio_get_direction(struct gpio_chip *gc, unsigned int offset)
> +{
> + u8 *channels = gpiochip_get_data(gc);
> +
> + /* Input registers have offsets between [0x00, 0x07] */
> + if (CHANNEL_TO_OFFSET(channels[offset]) < 0x08)
> + return GPIO_LINE_DIRECTION_IN;
> +
> + return GPIO_LINE_DIRECTION_OUT;
> +}
> +
> +static int silicom_gpio_direction_input(struct gpio_chip *gc, unsigned int offset)
> +{
> + int direction = silicom_gpio_get_direction(gc, offset);
> +
> + return direction == GPIO_LINE_DIRECTION_IN ? 0 : -EINVAL;
> +}
> +
> +static void silicom_gpio_set(struct gpio_chip *gc, unsigned int offset, int value)
> +{
> + u8 *channels = gpiochip_get_data(gc);
> + int direction = silicom_gpio_get_direction(gc, offset);
> + int channel = channels[offset];
> + u8 reg;
> +
> + if (direction == GPIO_LINE_DIRECTION_IN)
> + return;
> +
> + mutex_lock(&mec_io_mutex);
> + /* Get the dword offset from the channel */
> + outb((channel >> 3) & 0xfc, MEC_ADDR);
> +
> + /* Get the current register */
> + reg = inb(MEC_DATA((channel >> 3) & 0x03));
> + if (value == 0)
> + reg &= ~(1 << (channel & 0x7));
> + else if (value > 0)
> + reg |= 1 << (channel & 0x7);
> + else
> + pr_err("Invalid GPIO value: %d\n", value);
> + outb(reg, MEC_DATA((channel >> 3) & 0x03));
> + mutex_unlock(&mec_io_mutex);
> +}
> +
> +static int silicom_gpio_direction_output(struct gpio_chip *gc, unsigned int offset, int value)
> +{
> + int direction = silicom_gpio_get_direction(gc, offset);
> +
> + if (direction == GPIO_LINE_DIRECTION_IN)
> + return -EINVAL;
> +
> + silicom_gpio_set(gc, offset, value);
> +
> + return 0;
> +}
> +
> +static int silicom_gpio_get(struct gpio_chip *gc, unsigned int offset)
> +{
> + u8 *channels = gpiochip_get_data(gc);
> + int channel = channels[offset];
> + u8 reg;
> +
> + mutex_lock(&mec_io_mutex);
> + /* Get the dword offset from the channel */
> + outb((channel >> 3) & 0xfc, MEC_ADDR);
> +
> + /* Get the current register */
> + reg = inb(MEC_DATA((channel >> 3) & 0x03));
> + mutex_unlock(&mec_io_mutex);
> +
> + return (reg >> (channel & 0x7)) & 0x01;
> +}
> +
> +static int __init silicom_mc_leds_register(struct device *dev,
> + const struct led_classdev_mc *mc_leds)
> +{
> + struct led_classdev_mc *led;
> + int i, err;
> +
> + for (i = 0; mc_leds[i].led_cdev.name; i++) {
> + /* allocate and copy data from the init constansts */
There's a typo in the constansts but the code seems obvious enough to not
need a comment at all.
> + led = devm_kzalloc(dev, sizeof(struct led_classdev_mc), GFP_KERNEL);
> + if (IS_ERR_OR_NULL(led)) {
> + dev_err(dev, "Failed to alloc led_classdev_mc[%d]: %ld\n", i, PTR_ERR(led));
> + return -ENOMEM;
> + }
> + memcpy(led, &mc_leds[i], sizeof(*led));
> +
> + led->subled_info = devm_kzalloc(dev, led->num_colors * sizeof(struct mc_subled),
array_size() from linux/overflow.h
> + GFP_KERNEL);
> + if (IS_ERR_OR_NULL(led->subled_info)) {
> + dev_err(dev, "Failed to alloc subled_info[%d]: %ld\n",
> + i, PTR_ERR(led->subled_info));
> + return -ENOMEM;
> + }
> + memcpy(led->subled_info, mc_leds[i].subled_info,
> + led->num_colors * sizeof(struct mc_subled));
array_size()
Although a local variable could be used to hold it as it's used for alloc
and this line.
> +
> + err = devm_led_classdev_multicolor_register(dev, led);
> + if (err) {
> + dev_err(dev, "Failed to register[%d]: %d\n", i, err);
> + return err;
> + }
> + }
> +
> + return 0;
> +}
> +
> +static void silicom_mec_led_set(int channel, int on)
> +{
> + u8 reg;
> +
> + mutex_lock(&mec_io_mutex);
> + /* Get the dword offset from the channel */
> + outb((channel >> 3) & 0xfc, MEC_ADDR);
> + /* Get the current LED settings */
> + reg = inb(MEC_DATA((channel >> 3) & 0x03));
> +
> + /* Outputs are active low, so clear the bit for on, or set it for off */
> + if (on)
> + reg &= ~(1 << (channel & 0x7));
> + else
> + reg |= 1 << (channel & 0x7);
> +
> + /* Write back the updated register */
> + outb(reg, MEC_DATA((channel >> 3) & 0x03));
> +
> + mutex_unlock(&mec_io_mutex);
There's an identical code block in silicom_gpio_set(). Why not simply call
this from silicom_gpio_set()?
> +}
> +
> +static void silicom_mec_led_mc_brightness_set(struct led_classdev *led_cdev,
> + enum led_brightness brightness)
> +{
> + struct led_classdev_mc *mc_cdev = lcdev_to_mccdev(led_cdev);
> + int i;
> +
> + led_mc_calc_color_components(mc_cdev, brightness);
> +
> + for (i = 0; i < mc_cdev->num_colors; i++) {
> + silicom_mec_led_set(mc_cdev->subled_info[i].channel,
> + mc_cdev->subled_info[i].brightness);
> + }
> +}
> +
> +static enum led_brightness silicom_mec_led_get(int channel)
> +{
> + u8 reg;
> +
> + mutex_lock(&mec_io_mutex);
> + /* Get the dword offset of the register for this LED from the channel */
> + outb((channel >> 3) & 0xfc, MEC_ADDR);
> + /* Get the current LED settings */
> + reg = inb(MEC_DATA((channel >> 3) & 0x03));
> + mutex_unlock(&mec_io_mutex);
> +
> + /* Outputs are active low */
> + return reg & (1 << (channel & 0x7)) ? LED_OFF : LED_ON;
Looks identical to a part of silicom_gpio_get(). Perhaps it should call
this function??
> +}
> +
> +static enum led_brightness silicom_mec_led_mc_brightness_get(struct led_classdev *led_cdev)
> +{
> + struct led_classdev_mc *mc_cdev = lcdev_to_mccdev(led_cdev);
> + enum led_brightness brightness = LED_OFF;
> + int i;
> +
> + for (i = 0; i < mc_cdev->num_colors; i++) {
> + mc_cdev->subled_info[i].brightness =
> + silicom_mec_led_get(mc_cdev->subled_info[i].channel);
> +
> + /* Mark the overall brightness as LED_ON if any of the subleds are on */
> + if (mc_cdev->subled_info[i].brightness != LED_OFF)
> + brightness = LED_ON;
> + }
> +
> + return brightness;
> +}
> +
> +
> +static u32 rpm_get(void)
> +{
> + u32 reg;
> + u32 bank = 0;
> + u32 offset = 0xc;
Named with a define. Remove unnecessary local vars.
> + u32 byte_pos = 0;
> +
> + mutex_lock(&mec_io_mutex);
> + /* Select memory region */
> + outb(bank, EC_ADDR_MSB);
> + outb(offset, EC_ADDR_LSB);
> + /* Get current date from the address */
> + reg = inw(MEC_DATA(byte_pos));
> + mutex_unlock(&mec_io_mutex);
> +
> + return reg;
> +}
> +
> +static u32 temp_get(void)
> +{
> + u32 reg;
> + u32 bank = 0;
> + u32 offset = 0xc;
> + u32 byte_pos = 0;
Ditto.
> + mutex_lock(&mec_io_mutex);
> + /* Select memory region */
> + outb(bank, EC_ADDR_MSB);
> + outb(offset, EC_ADDR_LSB);
> + /* Get current date from the address */
> + reg = inl(MEC_DATA(byte_pos));
> + mutex_unlock(&mec_io_mutex);
> +
> + return (reg >> 16) / 10;
Should that >> 16 do a FIELD_GET() for a named field, I suspect it should?
> +}
> +
> +static umode_t silicom_fan_control_fan_is_visible(const u32 attr)
> +{
> + switch (attr) {
> + case hwmon_fan_input:
> + case hwmon_fan_label:
> + return 0444;
> + default:
> + return 0;
> + }
> +}
> +
> +static umode_t silicom_fan_control_temp_is_visible(const u32 attr)
> +{
> + switch (attr) {
> + case hwmon_temp_input:
> + case hwmon_temp_label:
> + return 0444;
> + default:
> + return 0;
> + }
> +}
> +
> +static int silicom_fan_control_read_fan(struct device *dev, u32 attr, long *val)
> +{
> + struct silicom_fan_control_data *ctl = dev_get_drvdata(dev);
> +
> + switch (attr) {
> + case hwmon_fan_input:
> + ctl->fan_speed = rpm_get();
> + *val = ctl->fan_speed;
> + return 0;
> + default:
> + return -EOPNOTSUPP;
> + }
> +}
> +
> +static int silicom_fan_control_read_temp(struct device *dev, u32 attr, long *val)
> +{
> + struct silicom_fan_control_data *ctl = dev_get_drvdata(dev);
> +
> + switch (attr) {
> + case hwmon_temp_input:
> + ctl->temp = temp_get();
> + *val = ctl->temp;
> + return 0;
> + default:
> + return -EOPNOTSUPP;
> + }
> +}
> +
> +static umode_t silicom_fan_control_is_visible(const void *data,
> + enum hwmon_sensor_types type,
> + u32 attr, int channel)
> +{
> + switch (type) {
> + case hwmon_fan:
> + return silicom_fan_control_fan_is_visible(attr);
> + case hwmon_temp:
> + return silicom_fan_control_temp_is_visible(attr);
> + default:
> + return 0;
> + }
> +}
> +
> +static int silicom_fan_control_read(struct device *dev, enum hwmon_sensor_types type,
> + u32 attr, int channel, long *val)
> +{
> + switch (type) {
> + case hwmon_fan:
> + return silicom_fan_control_read_fan(dev, attr, val);
> + case hwmon_temp:
> + return silicom_fan_control_read_temp(dev, attr, val);
> + default:
> + return -EOPNOTSUPP;
> + }
> +}
> +
> +static int silicom_fan_control_read_labels(struct device *dev, enum hwmon_sensor_types type,
> + u32 attr, int channel, const char **str)
> +{
> + switch (type) {
> + case hwmon_fan:
> + *str = "Fan Speed (RPM)";
> + return 0;
> + case hwmon_temp:
> + *str = "Thermostat Sensor";
> + return 0;
> + default:
> + return -EOPNOTSUPP;
> + }
> +}
> +
> +static int silicom_fan_control_write(struct device *dev, enum hwmon_sensor_types type,
> + u32 attr, int channel, long val)
> +{
> + return 0;
> +}
> +
> +static const struct hwmon_ops silicom_fan_control_hwmon_ops = {
> + .is_visible = silicom_fan_control_is_visible,
> + .read = silicom_fan_control_read,
> + .write = silicom_fan_control_write,
> + .read_string = silicom_fan_control_read_labels,
> +};
> +
> +static const struct hwmon_chip_info silicom_chip_info = {
> + .ops = &silicom_fan_control_hwmon_ops,
> + .info = silicom_fan_control_info,
> +};
> +
> +static int __init silicom_platform_probe(struct platform_device *device)
> +{
> + int i, err;
> + u8 magic, ver;
> + struct silicom_fan_control_data *ctl;
> + const char *name = "Silocom_Fan_Monitor";
> + const char *dev_name = "Silicom_platform";
> +
> + mec_io_base = 0x0800;
> + mec_io_len = 8;
> + if (!devm_request_region(&device->dev, mec_io_base, mec_io_len, "mec")) {
> + dev_err(&device->dev, "couldn't reserve MEC io ports\n");
> + return -EBUSY;
> + }
> +
> + /* Sanity check magic number read for EC */
> + outb(0x00, MEC_ADDR);
> + magic = inb(MEC_DATA(0));
> + ver = inb(MEC_DATA(1));
0 and 1 should be named with defines.
> + dev_dbg(&device->dev, "EC magic 0x%02x, version 0x%02x\n", magic, ver);
> +
> + if (magic != SILICOM_MEC_MAGIC) {
> + dev_err(&device->dev, "Bad EC magic 0x%02x!\n", magic);
> + return -ENODEV;
> + }
> +
> + if (silicom_led_info) {
How can this be NULL?
> + err = silicom_mc_leds_register(&device->dev, silicom_led_info);
> + if (err) {
> + dev_err(&device->dev, "Failed to register LEDs\n");
> + return err;
> + }
> + }
> +
> + if (silicom_gpiochip) {
How can this be NULL?
> + err = devm_gpiochip_add_data(&device->dev, silicom_gpiochip, silicom_gpio_channels);
> + if (err) {
> + dev_err(&device->dev, "Failed to register gpiochip: %d\n", err);
> + return err;
> + }
> + }
> +
> + ctl = devm_kzalloc(&device->dev, sizeof(*ctl), GFP_KERNEL);
> + if (!ctl)
> + return -ENOMEM;
> +
> + ctl->hdev = devm_hwmon_device_register_with_info(&device->dev, name, ctl,
> + &silicom_chip_info, NULL);
> +
> + my_dev_ctl.my_dev = root_device_register(dev_name);
> + for (i = 0; i < ARRAY_SIZE(my_dev_attr); i++) {
> + err = sysfs_create_file(&my_dev_ctl.my_dev->kobj, &my_dev_attr[i].attr);
> + if (err) {
> + pr_debug("failed to create the foo file in /sys/devices/Silicom_platform\n");
> + break;
> + }
> + }
> +
> + return err;
> +}
> +
> +static int __init silicom_platform_info_init(const struct dmi_system_id *id)
> +{
> + struct silicom_platform_info *info = id->driver_data;
> +
> + dev_info(&silicom_platform_dev->dev, "Detected %s\n", id->ident);
> +
> + mec_io_base = info->io_base;
> + mec_io_len = info->io_len;
> + silicom_led_info = info->led_info;
> + silicom_gpio_channels = info->gpio_channels;
> + silicom_gpiochip = info->gpiochip;
> + if (silicom_gpiochip)
How can this be NULL?
> + silicom_gpiochip->ngpio = info->ngpio;
> +
> + return 1;
> +}
> +
> +static const struct dmi_system_id silicom_dmi_ids[] __initconst = {
> + {
> + .callback = silicom_platform_info_init,
> + .ident = "Silicom Cordoba (Generic)",
> + .matches = {
> + DMI_MATCH(DMI_BOARD_VENDOR, "Silicom"),
> + DMI_MATCH(DMI_BOARD_NAME, "80300-0214-G"),
> + },
> + .driver_data = &silicom_generic_cordoba_info,
> + },
> + {
> + .callback = silicom_platform_info_init,
> + .ident = "Silicom Cordoba (Generic)",
> + .matches = {
> + DMI_MATCH(DMI_BOARD_VENDOR, "Silicom"),
> + DMI_MATCH(DMI_BOARD_NAME, "80500-0214-G"),
> + },
> + .driver_data = &silicom_generic_cordoba_info,
> + },
> + {
> + .callback = silicom_platform_info_init,
> + .ident = "Silicom Cordoba (plat_0222)",
> + .matches = {
> + DMI_MATCH(DMI_BOARD_VENDOR, "Silicom"),
> + DMI_MATCH(DMI_BOARD_NAME, "80300-0222-G"),
> + },
Incorrect indentation x6.
> + .driver_data = &silicom_plat_0222_cordoba_info,
> + },
> + { },
> +};
> +
> +static int __init silicom_platform_init(void)
> +{
> + struct device *dev;
> + int err;
> +
> + /* register a platform device to act as the parent for LEDS, etc. */
> + silicom_platform_dev = platform_device_register_simple("silicom-platform", -1, NULL, 0);
> + if (IS_ERR(silicom_platform_dev)) {
> + err = PTR_ERR(silicom_platform_dev);
> + pr_err("failed to register silicom-platform device: %d\n", err);
> + goto silicom_init_register_err;
> + }
> + dev = &silicom_platform_dev->dev;
> +
> + err = dmi_check_system(silicom_dmi_ids);
> + if (err == 0) {
> + dev_err(dev, "No DMI match for this platform\n");
> + err = -ENODEV;
> + goto silicom_init_probe_err;
> + }
> +
> + /* Directly probe the platform driver in init since this isn't a
> + * hotpluggable device. That means we don't need to register a driver
> + * that needs to wait around in memory on the chance a matching device
> + * would get added. Instead run once in __init so that we can free all
> + * those resources when the __init region is wiped
> + */
> + err = platform_driver_probe(&silicom_platform_driver, silicom_platform_probe);
> + if (err) {
> + dev_err(dev, "Failed to probe platform driver %d\n", err);
> + goto silicom_init_probe_err;
> + }
> +
> + return 0;
> +
> +silicom_init_probe_err:
> + if (silicom_platform_dev) {
How can this by NULL?
> + platform_device_unregister(silicom_platform_dev);
> + silicom_platform_dev = NULL;
Seems unnecessary.
> + }
> + if (my_dev_ctl.my_dev) {
> + root_device_unregister(my_dev_ctl.my_dev);
> + my_dev_ctl.my_dev = NULL;
Ditto.
> + }
> +
> +silicom_init_register_err:
> + return err;
> +}
> +
> +static void __exit silicom_platform_exit(void)
> +{
> + int i;
> +
> + if (silicom_platform_dev) {
> + platform_device_unregister(silicom_platform_dev);
> + platform_driver_unregister(&silicom_platform_driver);
> + }
> +
> + if (my_dev_ctl.my_dev) {
> + for (i = 0; i < ARRAY_SIZE(my_dev_attr); i++)
> + sysfs_remove_file(&my_dev_ctl.my_dev->kobj, &my_dev_attr[i].attr);
> + root_device_unregister(my_dev_ctl.my_dev);
> + }
> + mutex_destroy(&mec_io_mutex);
> +}
> +
> +module_init(silicom_platform_init);
> +module_exit(silicom_platform_exit);
> +
> +MODULE_LICENSE("GPL");
> +MODULE_AUTHOR("Henry Shi <henrys@xxxxxxxxxxxxxxx>");
> +MODULE_DESCRIPTION("Platform driver for Silicom network appliances");
> +
> +MODULE_DEVICE_TABLE(dmi, silicom_dmi_ids);
> +
Extra newline in the end.
--
i.