From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.6 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 302F7C83000 for ; Wed, 29 Apr 2020 23:02:21 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 01A9F206D9 for ; Wed, 29 Apr 2020 23:02:21 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="hS9ExHKr" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727890AbgD2XCU (ORCPT ); Wed, 29 Apr 2020 19:02:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57362 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726164AbgD2XCT (ORCPT ); Wed, 29 Apr 2020 19:02:19 -0400 Received: from mail-wm1-x342.google.com (mail-wm1-x342.google.com [IPv6:2a00:1450:4864:20::342]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3CAE3C03C1AE for ; Wed, 29 Apr 2020 16:02:19 -0700 (PDT) Received: by mail-wm1-x342.google.com with SMTP id u127so3891301wmg.1 for ; Wed, 29 Apr 2020 16:02:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=W2FsMhiDDO52tTAkJaSM2RdI/ojRCeOtD9NB/fk6mHM=; b=hS9ExHKrephNuuTy9xt7UMNCY3IMu1DLtIMULsRaJ9cmajd/xCE5O4zvWN1dIwiiuT LN+bVyw8TTcIYCMENaLGimDQe/j0A+XZUa1s4Cl9ZHgYIBUcu4ncUBRIpijJ8aCDAjdo PihBSq50dtX90nqt49iN0BABioNLOL1JekqkUbaNYzxLA2TOitRSnB73+CBSEp662nQo SMV3oHiTGQnzc/V+qd9JsRFL4AFYgmojA6IfuKO9N88IG7A1My845oDVZylRtusAHG/T IR0XvIapHEqjac5QgXVwiMHwqueiIpRvwydIjpcQXy4WZu1ku24TwSyeoMWSOZAUiaKI nsOg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=W2FsMhiDDO52tTAkJaSM2RdI/ojRCeOtD9NB/fk6mHM=; b=PG2C/HrFlg/W9lx6IS6VOd4z2ue5SxUYpf1/10Ah4PeOKJGoFf4sr5NAG5gJjPdX96 8Ujry0LEVJSkf0TxBXpfGuyzvS2wtNPontkB9aAwMW2pOMz8QK03OpvsksiSkVSfYfiQ wLo+WiWAZFZuJ7yrOSurAG6ytN+Ct1MQ5tQqTB1Wdtaq62oNhv7vS6OSN+ZPmKAOOiJx Rex6oI9H1tEdF/1ue+1aen1Zfqpq4f3OmJmuP80SnhdqvlqWu+DNIfr+/c+kDOYsB+3e NFd4Qnyz2/WJVzteM1wsK20WVzHTNZk/W8nGgKy8yHvxNk+3Dlr0fGsHDp6cdrz0ET4E XIpQ== X-Gm-Message-State: AGi0PuaN7O2n3/eW0K2VYY7FD8/wUxHcc7ysLbfwv5DiFGdfMgwa3QEt R9C1Gid9AZw6XSdcNKFh1N8= X-Google-Smtp-Source: APiQypIn39T3suadAvir6wLA9B6hgCdiuxULHHPMTEEc3mhQbisF4zNzNXN+4RXTPVbU7yHoQCilVw== X-Received: by 2002:a05:600c:2941:: with SMTP id n1mr174030wmd.25.1588201337843; Wed, 29 Apr 2020 16:02:17 -0700 (PDT) Received: from akira-laptop.home ([2a01:cb19:8b28:7600:a0b9:1c6f:cfba:2b21]) by smtp.googlemail.com with ESMTPSA id v7sm9371769wmg.3.2020.04.29.16.02.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Apr 2020 16:02:17 -0700 (PDT) From: Akira Shimahara To: greg@kroah.com Cc: zbr@ioremap.net, linux-kernel@vger.kernel.org, Akira Shimahara Subject: [PATCH v4 8/9] w1_therm: adding alarm sysfs entry to set device internal alarms values Date: Thu, 30 Apr 2020 01:02:09 +0200 Message-Id: <20200429230209.200751-1-akira215corp@gmail.com> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Adding device alarms settings by a dedicated sysfs entry alarms (RW): read or write TH and TL in the device RAM. Checking devices in alarm state could be performed using the master search command. As alarms temperature level are store in a 8 bit register on the device and are signed values, a safe cast shall be performed using the min and max temperature that device are able to measure. This is done by int_to_short inline function. Updating doc in Documentation/ABI/testing/sysfs-driver-w1_therm accordingly. Signed-off-by: Akira Shimahara --- .../ABI/testing/sysfs-driver-w1_therm | 15 ++ drivers/w1/slaves/w1_therm.c | 138 ++++++++++++++++++ drivers/w1/slaves/w1_therm.h | 22 +++ 3 files changed, 175 insertions(+) diff --git a/Documentation/ABI/testing/sysfs-driver-w1_therm b/Documentation/ABI/testing/sysfs-driver-w1_therm index 279e13d..39488a4 100644 --- a/Documentation/ABI/testing/sysfs-driver-w1_therm +++ b/Documentation/ABI/testing/sysfs-driver-w1_therm @@ -1,3 +1,18 @@ +What: /sys/bus/w1/devices/.../alarms +Date: Apr 2020 +Contact: Akira Shimahara +Description: + (RW) read or write TH and TL (Temperature High an Low) alarms. + Values shall be space separated and in the device range + (typical -55 degC to 125 degC). Values are integer as they + are store in a 8bit register in the device. + Lowest value is automatically put to TL. + Once set, alarms could be search at master level, refer to + Documentation/w1/w1_generic.rst for detailed information +Users: any user space application which wants to communicate with + w1_term device + + What: /sys/bus/w1/devices/.../eeprom Date: Apr 2020 Contact: Akira Shimahara diff --git a/drivers/w1/slaves/w1_therm.c b/drivers/w1/slaves/w1_therm.c index 2c89d9f..90217b1 100644 --- a/drivers/w1/slaves/w1_therm.c +++ b/drivers/w1/slaves/w1_therm.c @@ -68,6 +68,12 @@ module_param_named(strong_pullup, w1_strong_pullup, int, 0); * (device do that automatically on power-up) * * + * alarms (RW) : read TH and TL (Temperature High an Low) alarms + * Values shall be space separated and in the device range + * (typically -55° to 125°) + * Values are integer are they are store in a 8bit field in the device + * Lowest value is automatically put to TL + * */ /* @@ -81,6 +87,7 @@ static struct attribute *w1_therm_attrs[] = { &dev_attr_ext_power.attr, &dev_attr_resolution.attr, &dev_attr_eeprom.attr, + &dev_attr_alarms.attr, NULL, }; @@ -89,6 +96,7 @@ static struct attribute *w1_ds18s20_attrs[] = { &dev_attr_temperature.attr, &dev_attr_ext_power.attr, &dev_attr_eeprom.attr, + &dev_attr_alarms.attr, NULL, }; @@ -99,6 +107,7 @@ static struct attribute *w1_ds28ea00_attrs[] = { &dev_attr_ext_power.attr, &dev_attr_resolution.attr, &dev_attr_eeprom.attr, + &dev_attr_alarms.attr, NULL, }; @@ -206,6 +215,7 @@ static struct w1_family w1_therm_family_DS1825 = { }; /*----------------------Device capability description-----------------------*/ + static struct w1_therm_family_converter w1_therm_families[] = { { .f = &w1_therm_family_DS18S20, @@ -431,6 +441,14 @@ static inline int temperature_from_RAM(struct w1_slave *sl, u8 rom[9]) return 0; /* No device family */ } +static inline s8 int_to_short(int i) +{ + /* Prepare to cast to short by eliminating out of range values */ + i = i > MAX_TEMP ? MAX_TEMP : i; + i = i < MIN_TEMP ? MIN_TEMP : i; + return (s8) i; +} + /*-------------------------Interface Functions------------------------------*/ static int w1_therm_add_slave(struct w1_slave *sl) @@ -1000,6 +1018,126 @@ static ssize_t eeprom_store(struct device *device, return size; } +static ssize_t alarms_show(struct device *device, + struct device_attribute *attr, char *buf) +{ + struct w1_slave *sl = dev_to_w1_slave(device); + int ret = -ENODEV; + s8 th = 0, tl = 0; + struct therm_info scratchpad; + + ret = read_scratchpad(sl, &scratchpad); + + if (!ret) { + th = scratchpad.rom[2]; // TH is byte 2 + tl = scratchpad.rom[3]; // TL is byte 3 + } else { + dev_info(device, + "%s: error reading alarms register %d\n", + __func__, ret); + } + + return sprintf(buf, "%hd %hd\n", tl, th); +} + +static ssize_t alarms_store(struct device *device, + struct device_attribute *attr, const char *buf, size_t size) +{ + struct w1_slave *sl = dev_to_w1_slave(device); + struct therm_info info; + u8 new_config_register[3]; /* array of data to be written */ + int temp, ret = -EINVAL; + char *token = NULL; + s8 tl, th, tt; /* 1 byte per value + temp ring order */ + char *p_args = kmalloc(size, GFP_KERNEL); + + /* Safe string copys as buf is const */ + if (!p_args) { + dev_warn(device, + "%s: error unable to allocate memory %d\n", + __func__, -ENOMEM); + return size; + } + strcpy(p_args, buf); + + /* Split string using space char */ + token = strsep(&p_args, " "); + + if (!token) { + dev_info(device, + "%s: error parsing args %d\n", __func__, -EINVAL); + goto free_m; + } + + /* Convert 1st entry to int */ + ret = kstrtoint (token, 10, &temp); + if (ret) { + dev_info(device, + "%s: error parsing args %d\n", __func__, ret); + goto free_m; + } + + tl = int_to_short(temp); + + /* Split string using space char */ + token = strsep(&p_args, " "); + if (!token) { + dev_info(device, + "%s: error parsing args %d\n", __func__, -EINVAL); + goto free_m; + } + /* Convert 2nd entry to int */ + ret = kstrtoint (token, 10, &temp); + if (ret) { + dev_info(device, + "%s: error parsing args %d\n", __func__, ret); + goto free_m; + } + + /* Prepare to cast to short by eliminating out of range values */ + th = int_to_short(temp); + + /* Reorder if required th and tl */ + if (tl > th) { + tt = tl; tl = th; th = tt; + } + + /* Read the scratchpad to change only the required bits + * (th : byte 2 - tl: byte 3) + */ + ret = read_scratchpad(sl, &info); + if (!ret) { + new_config_register[0] = th; // Byte 2 + new_config_register[1] = tl; // Byte 3 + new_config_register[2] = info.rom[4];// Byte 4 + } else { + dev_info(device, + "%s: error reading from the slave device %d\n", + __func__, ret); + goto free_m; + } + + /* Write data in the device RAM */ + if (!SLAVE_SPECIFIC_FUNC(sl)) { + dev_info(device, + "%s: Device not supported by the driver %d\n", + __func__, -ENODEV); + goto free_m; + } + + ret = SLAVE_SPECIFIC_FUNC(sl)->write_data(sl, new_config_register); + if (ret) + dev_info(device, + "%s: error writing to the slave device %d\n", + __func__, ret); + +free_m: + /* free allocated memory */ + kfree(p_args); + + return size; +} + #if IS_REACHABLE(CONFIG_HWMON) static int w1_read_temp(struct device *device, u32 attr, int channel, long *val) diff --git a/drivers/w1/slaves/w1_therm.h b/drivers/w1/slaves/w1_therm.h index 6929991..d4c560a 100644 --- a/drivers/w1/slaves/w1_therm.h +++ b/drivers/w1/slaves/w1_therm.h @@ -40,6 +40,9 @@ #define EEPROM_CMD_WRITE "save" /* cmd for write eeprom sysfs */ #define EEPROM_CMD_READ "restore" /* cmd for read eeprom sysfs */ +#define MIN_TEMP -55 /* min temperature that can be mesured */ +#define MAX_TEMP 125 /* max temperature that can be mesured */ + /*----------------------------------Structs---------------------------------*/ /** @@ -159,6 +162,13 @@ static inline int conversion_time(struct w1_slave *sl); */ static inline int temperature_from_RAM(struct w1_slave *sl, u8 rom[9]); +/** int_to_short() safe casting of int to short + * min/max values are defined by macro + * @param i integer to be converted to short + * @return a short in the range of min/max value + */ +static inline s8 int_to_short(int i); + /*---------------------------Hardware Functions-----------------------------*/ /** @@ -277,6 +287,17 @@ static ssize_t resolution_store(struct device *device, static ssize_t eeprom_store(struct device *device, struct device_attribute *attr, const char *buf, size_t size); +/** @brief A callback function to set the alarms level + * @param device represents the master device + */ +static ssize_t alarms_store(struct device *device, + struct device_attribute *attr, const char *buf, size_t size); + +/** @brief A callback function to get the alarms level + * @return Low and High alarm, separate by one space + */ +static ssize_t alarms_show(struct device *device, + struct device_attribute *attr, char *buf); /*-----------------------------Attributes declarations----------------------*/ static DEVICE_ATTR_RW(w1_slave); @@ -285,6 +306,7 @@ static DEVICE_ATTR_RO(temperature); static DEVICE_ATTR_RO(ext_power); static DEVICE_ATTR_RW(resolution); static DEVICE_ATTR_WO(eeprom); +static DEVICE_ATTR_RW(alarms); /*--------------------------Interface Functions-----------------------------*/ -- 2.26.2