| Message ID | 1493628599-30552-8-git-send-email-preid@electromag.com.au (mailing list archive) |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
Hi, On Mon, May 01, 2017 at 04:49:57PM +0800, Phil Reid wrote: > From: Karl-Heinz Schneider <karl-heinz@schneider-inet.de> > > This patch adds support for Smart Battery System Manager. > A SBSM is a device listening at I2C/SMBus address 0x0a and is capable of > communicating up to four I2C smart battery devices. All smart battery > devices are listening at address 0x0b, so the SBSM muliplexes between > them. The driver makes use of the I2C-Mux framework to allow smart > batteries to be bound via device tree, i.e. the sbs-battery driver. > > Via sysfs interface the online state and charge type are presented. If > the driver is bound as ltc1760 (an implementation of a Dual Smart Battery > System Manager) the charge type can also be changed from trickle to fast. > > Tested-by: Phil Reid <preid@electromag.com.au> > Reviewed-by: Phil Reid <preid@electromag.com.au> > Signed-off-by: Karl-Heinz Schneider <karl-heinz@schneider-inet.de> > Signed-off-by: Phil Reid <preid@electromag.com.au> > --- > drivers/power/supply/Kconfig | 13 ++ > drivers/power/supply/Makefile | 1 + > drivers/power/supply/sbs-manager.c | 325 +++++++++++++++++++++++++++++++++++++ > 3 files changed, 339 insertions(+) > create mode 100644 drivers/power/supply/sbs-manager.c > > diff --git a/drivers/power/supply/Kconfig b/drivers/power/supply/Kconfig > index da54ac8..8aa5324 100644 > --- a/drivers/power/supply/Kconfig > +++ b/drivers/power/supply/Kconfig > @@ -533,4 +533,17 @@ config AXP20X_POWER > This driver provides support for the power supply features of > AXP20x PMIC. > > +config MANAGER_SBS > + tristate "Smart Battery System Manager" > + depends on I2C && I2C_MUX > + help > + Say Y here to include support for Smart Battery System Manager > + ICs. The driver reports online and charging status via sysfs. > + It presents itself also as I2C mux which allows to bind > + smart battery driver to its ports. > + Supported is for example LTC1760. > + > + This driver can also be built as a module. If so, the module will be > + called sbs-manager. > + Let's move add this directly next to CHARGER_SBS. > endif # POWER_SUPPLY > diff --git a/drivers/power/supply/Makefile b/drivers/power/supply/Makefile > index 3789a2c..4f53c98 100644 > --- a/drivers/power/supply/Makefile > +++ b/drivers/power/supply/Makefile > @@ -74,3 +74,4 @@ obj-$(CONFIG_CHARGER_TPS65090) += tps65090-charger.o > obj-$(CONFIG_CHARGER_TPS65217) += tps65217_charger.o > obj-$(CONFIG_AXP288_FUEL_GAUGE) += axp288_fuel_gauge.o > obj-$(CONFIG_AXP288_CHARGER) += axp288_charger.o > +obj-$(CONFIG_MANAGER_SBS) += sbs-manager.o same here. > diff --git a/drivers/power/supply/sbs-manager.c b/drivers/power/supply/sbs-manager.c > new file mode 100644 > index 0000000..adf9e41 > --- /dev/null > +++ b/drivers/power/supply/sbs-manager.c > @@ -0,0 +1,325 @@ > +/* > + * Driver for SBS compliant Smart Battery System Managers > + * > + * The device communicates via i2c at address 0x0a and multiplexes access to up > + * to four smart batteries at address 0x0b. > + * > + * Via sysfs interface the online state and charge type are presented. > + * > + * Datasheet SBSM: http://sbs-forum.org/specs/sbsm100b.pdf > + * Datasheet LTC1760: http://cds.linear.com/docs/en/datasheet/1760fb.pdf > + * > + * Karl-Heinz Schneider <karl-heinz@schneider-inet.de> > + * > + * This program is free software; you can redistribute it and/or modify > + * it under the terms of the GNU General Public License version 2 as > + * published by the Free Software Foundation. > + */ > + > +#include <linux/module.h> > +#include <linux/i2c.h> > +#include <linux/i2c-mux.h> > +#include <linux/power_supply.h> > + > +#define SBSM_MAX_BATS 4 > +#define SBSM_RETRY_CNT 3 > + > +/* registers addresses */ > +#define SBSM_CMD_BATSYSSTATE 0x01 > +#define SBSM_CMD_BATSYSSTATECONT 0x02 > +#define SBSM_CMD_BATSYSINFO 0x04 > +#define SBSM_CMD_LTC 0x3c > + > +struct sbsm_data { > + struct i2c_client *client; > + struct i2c_mux_core *muxc; > + > + struct power_supply *psy; > + > + int cur_chan; /* currently selected channel */ u8? > + bool is_ltc1760; /* special capabilities */ > +}; > + > +static enum power_supply_property sbsm_props[] = { > + POWER_SUPPLY_PROP_ONLINE, > + POWER_SUPPLY_PROP_CHARGE_TYPE, > +}; > + > +static int sbsm_read_word(struct i2c_client *client, u8 address) > +{ > + int reg, retries = SBSM_RETRY_CNT; > + > + while (retries > 0) { > + reg = i2c_smbus_read_word_data(client, address); > + if (reg >= 0) > + break; > + --retries; > + } for (retries = SBSM_RETRY_CNT; retries > 0; retries--) > + > + if (reg < 0) { > + dev_err(&client->dev, "failed to read register %i\n", > + (int)address); dev_err(&client->dev, "failed to read register 0x%02x\n", address); > + return reg; > + } > + > + return le16_to_cpu(reg); This is already done by i2c_smbus_read_word_data() and doing it again will result in incorrect values on big endian architectures. > +} > + > +static int sbsm_write_word(struct i2c_client *client, u8 address, u16 word) > +{ > + int ret, retries = SBSM_RETRY_CNT; > + > + word = cpu_to_le16(word); Same as for read_word: This is already done by the i2c-core. > + while (retries > 0) { > + ret = i2c_smbus_write_word_data(client, address, word); > + if (ret >= 0) > + break; > + --retries; > + } for (retries = SBSM_RETRY_CNT; retries > 0; retries--) > + if (ret < 0) > + dev_err(&client->dev, "failed to write to register %i\n", > + (int)address); dev_err(&client->dev, "failed to read register 0x%02x\n", address); > + > + return ret; > +} > + > +static int sbsm_get_property(struct power_supply *psy, > + enum power_supply_property psp, > + union power_supply_propval *val) > +{ > + struct sbsm_data *data = power_supply_get_drvdata(psy); > + int regval = 0; > + > + switch (psp) { > + case POWER_SUPPLY_PROP_ONLINE: > + regval = sbsm_read_word(data->client, SBSM_CMD_BATSYSSTATECONT); > + if (regval < 0) > + return regval; > + val->intval = !!(regval & 0x1); > + break; > + > + case POWER_SUPPLY_PROP_CHARGE_TYPE: > + regval = sbsm_read_word(data->client, SBSM_CMD_BATSYSSTATE); > + if (regval < 0) > + return regval; > + > + if ((regval & 0x00f0) == 0) { > + val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE; > + return 0; > + } > + val->intval = POWER_SUPPLY_CHARGE_TYPE_TRICKLE; > + > + if (data->is_ltc1760) { > + /* charge mode fast if turbo is active */ > + regval = sbsm_read_word(data->client, SBSM_CMD_LTC); > + if (regval < 0) > + return regval; > + else if (regval & 0x80) > + val->intval = POWER_SUPPLY_CHARGE_TYPE_FAST; > + } > + break; > + > + default: > + return -EINVAL; > + } > + > + return 0; > +} > + > +static int sbsm_prop_is_writeable(struct power_supply *psy, > + enum power_supply_property psp) > +{ > + struct sbsm_data *data = power_supply_get_drvdata(psy); > + > + return (psp == POWER_SUPPLY_PROP_CHARGE_TYPE) && data->is_ltc1760; > +} > + > +static int sbsm_set_property(struct power_supply *psy, > + enum power_supply_property psp, > + const union power_supply_propval *val) > +{ > + struct sbsm_data *data = power_supply_get_drvdata(psy); > + int ret = -EINVAL; > + > + switch (psp) { > + case POWER_SUPPLY_PROP_CHARGE_TYPE: > + /* write 1 to TURBO if type fast is given */ > + if (data->is_ltc1760) { > + u16 regval = val->intval == > + POWER_SUPPLY_CHARGE_TYPE_FAST ? (0x1 << 7) : 0; > + ret = sbsm_write_word(data->client, SBSM_CMD_LTC, > + regval); > + } That's not nicely indented. Try doing it this way to reduce indention: if (data->is_ltc1760) break; u16 regval = ... > + break; > + > + default: > + break; > + } > + > + return ret; > +} > + > +/* > + * Switch to battery > + * Parameter chan is directly the content of SMB_BAT* nibble > + */ > +static int sbsm_select(struct i2c_mux_core *muxc, u32 chan) > +{ > + struct sbsm_data *data = i2c_mux_priv(muxc); > + int ret = 0; > + u16 reg; > + > + if (data->cur_chan == chan) > + return ret; > + > + /* chan goes from 1 ... 4 */ > + reg = 1 << (11 + chan); > + ret = sbsm_write_word(data->client, SBSM_CMD_BATSYSSTATE, reg); > + if (ret) > + dev_err(&data->client->dev, "Failed to select channel %i\n", > + chan); Add struct device *dev = &data->client->dev; at the beginning of the function and use it here to avoid line break. > + else > + data->cur_chan = chan; > + > + return ret; > +} > + > +#if defined(CONFIG_OF) > + > +#include <linux/of_device.h> Move include to top of file. You can include it unconditionally. > +static const struct of_device_id sbsm_dt_ids[] = { > + { .compatible = "sbs,sbs-manager" }, > + { .compatible = "lltc,ltc1760" }, > + { } > +}; > +MODULE_DEVICE_TABLE(of, sbsm_dt_ids); This can go next to the other MODULE_DEVICE_TABLE. > +#endif > + > +static const struct power_supply_desc sbsm_default_psy_desc = { > + .type = POWER_SUPPLY_TYPE_MAINS, > + .properties = sbsm_props, > + .num_properties = ARRAY_SIZE(sbsm_props), > + .get_property = &sbsm_get_property, > + .set_property = &sbsm_set_property, > + .property_is_writeable = &sbsm_prop_is_writeable, > +}; > + > +static int sbsm_probe(struct i2c_client *client, > + const struct i2c_device_id *id) > +{ > + struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent); > + struct sbsm_data *data; > + struct device *dev = &client->dev; > + struct power_supply_desc *psy_desc; > + struct power_supply_config psy_cfg = {}; > + int ret = 0, i, supported_bats; > + > + /* Device listens only at address 0x0a */ > + if (client->addr != 0x0a) > + return -ENODEV; I guess EINVAL makes more sense? > + if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA)) > + return -EPFNOSUPPORT; > + > + data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL); > + if (!data) > + return -ENOMEM; > + > + i2c_set_clientdata(client, data); > + > + data->client = client; > + data->is_ltc1760 = !!strstr(id->name, "ltc1760"); > + > + ret = sbsm_read_word(client, SBSM_CMD_BATSYSINFO); > + if (ret < 0) > + return ret; > + supported_bats = le16_to_cpu(ret) & 0xf; How often do you want to convert endianess? :) Drop this. > + data->muxc = i2c_mux_alloc(adapter, dev, SBSM_MAX_BATS, 0, > + I2C_MUX_LOCKED, &sbsm_select, NULL); > + if (!data->muxc) { > + dev_err(dev, "failed to alloc i2c mux\n"); > + ret = -ENOMEM; > + goto err_mux_alloc; > + } > + data->muxc->priv = data; > + > + /* register muxed i2c channels. One for each supported battery */ > + for (i = 0; i < SBSM_MAX_BATS; ++i) { > + if ((1 << i) & supported_bats) { This can be written more readable as if (supported_bats & BIT(i)) > + ret = i2c_mux_add_adapter(data->muxc, 0, i + 1, 0); > + if (ret) { > + dev_err(dev, > + "failed to register i2c mux channel %d\n", > + i + 1); > + goto err_mux_register; > + } > + } > + } > + > + psy_desc = devm_kmemdup(dev, &sbsm_default_psy_desc, > + sizeof(struct power_supply_desc), > + GFP_KERNEL); > + if (!psy_desc) { > + ret = -ENOMEM; > + goto err_psy; > + } > + > + psy_desc->name = devm_kasprintf(dev, GFP_KERNEL, "sbsm-%s", > + dev_name(&client->dev)); > + if (!psy_desc->name) { > + ret = -ENOMEM; > + goto err_psy; > + } > + > + psy_cfg.drv_data = data; Please add: psy_cfg->of_node = dev->of_node; > + data->psy = devm_power_supply_register(dev, psy_desc, &psy_cfg); > + if (IS_ERR(data->psy)) { > + ret = PTR_ERR(data->psy); > + dev_err(dev, "failed to register power supply %s\n", > + psy_desc->name); > + goto err_psy; > + } > + > + dev_info(dev, "sbsm registered\n"); > + return 0; > + > +err_psy: > +err_mux_register: > + i2c_mux_del_adapters(data->muxc); > + > +err_mux_alloc: > + return ret; > +} > + > +static int sbsm_remove(struct i2c_client *client) > +{ > + struct sbsm_data *data = i2c_get_clientdata(client); > + > + i2c_mux_del_adapters(data->muxc); > + return 0; > +} > + > +static const struct i2c_device_id sbsm_ids[] = { > + { "sbs-manager", 0 }, > + { "ltc1760", 0 }, > + { } > +}; > +MODULE_DEVICE_TABLE(i2c, sbsm_ids); > + > +static struct i2c_driver sbsm_driver = { > + .driver = { > + .name = "sbsm", > + .owner = THIS_MODULE, Please drop .owner assignment. It will be done by i2c-core. But you should add the following: .of_match_table = of_match_ptr(sbsm_dt_ids), > + }, > + .probe = sbsm_probe, > + .remove = sbsm_remove, > + .id_table = sbsm_ids > +}; > +module_i2c_driver(sbsm_driver); > + > +MODULE_LICENSE("GPL"); > +MODULE_AUTHOR("Karl-Heinz Schneider <karl-heinz@schneider-inet.de>"); > +MODULE_DESCRIPTION("SBSM Smart Battery System Manager"); -- Sebastian
G'day Sebastian, Thanks for the feedback. Next version coming soon. In regards the le to cpu conversion. grepping the supply folder finds a couple of other suspicious cases. sbs-battery & the bq24735-cahrger do similar things. thoughts on if they need to be corrected? On 1/05/2017 21:41, Sebastian Reichel wrote: > Hi, > > On Mon, May 01, 2017 at 04:49:57PM +0800, Phil Reid wrote: >> From: Karl-Heinz Schneider <karl-heinz@schneider-inet.de> >> >> This patch adds support for Smart Battery System Manager. >> A SBSM is a device listening at I2C/SMBus address 0x0a and is capable of >> communicating up to four I2C smart battery devices. All smart battery >> devices are listening at address 0x0b, so the SBSM muliplexes between >> them. The driver makes use of the I2C-Mux framework to allow smart >> batteries to be bound via device tree, i.e. the sbs-battery driver. >> >> Via sysfs interface the online state and charge type are presented. If >> the driver is bound as ltc1760 (an implementation of a Dual Smart Battery >> System Manager) the charge type can also be changed from trickle to fast. >> >> Tested-by: Phil Reid <preid@electromag.com.au> >> Reviewed-by: Phil Reid <preid@electromag.com.au> >> Signed-off-by: Karl-Heinz Schneider <karl-heinz@schneider-inet.de> >> Signed-off-by: Phil Reid <preid@electromag.com.au> >> --- >> drivers/power/supply/Kconfig | 13 ++ >> drivers/power/supply/Makefile | 1 + >> drivers/power/supply/sbs-manager.c | 325 +++++++++++++++++++++++++++++++++++++ >> 3 files changed, 339 insertions(+) >> create mode 100644 drivers/power/supply/sbs-manager.c >> >> diff --git a/drivers/power/supply/Kconfig b/drivers/power/supply/Kconfig >> index da54ac8..8aa5324 100644 >> --- a/drivers/power/supply/Kconfig >> +++ b/drivers/power/supply/Kconfig >> @@ -533,4 +533,17 @@ config AXP20X_POWER >> This driver provides support for the power supply features of >> AXP20x PMIC. >> >> +config MANAGER_SBS >> + tristate "Smart Battery System Manager" >> + depends on I2C && I2C_MUX >> + help >> + Say Y here to include support for Smart Battery System Manager >> + ICs. The driver reports online and charging status via sysfs. >> + It presents itself also as I2C mux which allows to bind >> + smart battery driver to its ports. >> + Supported is for example LTC1760. >> + >> + This driver can also be built as a module. If so, the module will be >> + called sbs-manager. >> + > > Let's move add this directly next to CHARGER_SBS. > >> endif # POWER_SUPPLY >> diff --git a/drivers/power/supply/Makefile b/drivers/power/supply/Makefile >> index 3789a2c..4f53c98 100644 >> --- a/drivers/power/supply/Makefile >> +++ b/drivers/power/supply/Makefile >> @@ -74,3 +74,4 @@ obj-$(CONFIG_CHARGER_TPS65090) += tps65090-charger.o >> obj-$(CONFIG_CHARGER_TPS65217) += tps65217_charger.o >> obj-$(CONFIG_AXP288_FUEL_GAUGE) += axp288_fuel_gauge.o >> obj-$(CONFIG_AXP288_CHARGER) += axp288_charger.o >> +obj-$(CONFIG_MANAGER_SBS) += sbs-manager.o > > same here. > >> diff --git a/drivers/power/supply/sbs-manager.c b/drivers/power/supply/sbs-manager.c >> new file mode 100644 >> index 0000000..adf9e41 >> --- /dev/null >> +++ b/drivers/power/supply/sbs-manager.c >> @@ -0,0 +1,325 @@ >> +/* >> + * Driver for SBS compliant Smart Battery System Managers >> + * >> + * The device communicates via i2c at address 0x0a and multiplexes access to up >> + * to four smart batteries at address 0x0b. >> + * >> + * Via sysfs interface the online state and charge type are presented. >> + * >> + * Datasheet SBSM: http://sbs-forum.org/specs/sbsm100b.pdf >> + * Datasheet LTC1760: http://cds.linear.com/docs/en/datasheet/1760fb.pdf >> + * >> + * Karl-Heinz Schneider <karl-heinz@schneider-inet.de> >> + * >> + * This program is free software; you can redistribute it and/or modify >> + * it under the terms of the GNU General Public License version 2 as >> + * published by the Free Software Foundation. >> + */ >> + >> +#include <linux/module.h> >> +#include <linux/i2c.h> >> +#include <linux/i2c-mux.h> >> +#include <linux/power_supply.h> >> + >> +#define SBSM_MAX_BATS 4 >> +#define SBSM_RETRY_CNT 3 >> + >> +/* registers addresses */ >> +#define SBSM_CMD_BATSYSSTATE 0x01 >> +#define SBSM_CMD_BATSYSSTATECONT 0x02 >> +#define SBSM_CMD_BATSYSINFO 0x04 >> +#define SBSM_CMD_LTC 0x3c >> + >> +struct sbsm_data { >> + struct i2c_client *client; >> + struct i2c_mux_core *muxc; >> + >> + struct power_supply *psy; >> + >> + int cur_chan; /* currently selected channel */ > > u8? > >> + bool is_ltc1760; /* special capabilities */ >> +}; >> + >> +static enum power_supply_property sbsm_props[] = { >> + POWER_SUPPLY_PROP_ONLINE, >> + POWER_SUPPLY_PROP_CHARGE_TYPE, >> +}; >> + >> +static int sbsm_read_word(struct i2c_client *client, u8 address) >> +{ >> + int reg, retries = SBSM_RETRY_CNT; >> + >> + while (retries > 0) { >> + reg = i2c_smbus_read_word_data(client, address); >> + if (reg >= 0) >> + break; >> + --retries; >> + } > > for (retries = SBSM_RETRY_CNT; retries > 0; retries--) > >> + >> + if (reg < 0) { >> + dev_err(&client->dev, "failed to read register %i\n", >> + (int)address); > > dev_err(&client->dev, "failed to read register 0x%02x\n", address); > >> + return reg; >> + } >> + >> + return le16_to_cpu(reg); > > This is already done by i2c_smbus_read_word_data() and doing it > again will result in incorrect values on big endian architectures. > >> +} >> + >> +static int sbsm_write_word(struct i2c_client *client, u8 address, u16 word) >> +{ >> + int ret, retries = SBSM_RETRY_CNT; >> + >> + word = cpu_to_le16(word); > > Same as for read_word: This is already done by the i2c-core. > >> + while (retries > 0) { >> + ret = i2c_smbus_write_word_data(client, address, word); >> + if (ret >= 0) >> + break; >> + --retries; >> + } > > for (retries = SBSM_RETRY_CNT; retries > 0; retries--) > >> + if (ret < 0) >> + dev_err(&client->dev, "failed to write to register %i\n", >> + (int)address); > > dev_err(&client->dev, "failed to read register 0x%02x\n", address); > >> + >> + return ret; >> +} >> + >> +static int sbsm_get_property(struct power_supply *psy, >> + enum power_supply_property psp, >> + union power_supply_propval *val) >> +{ >> + struct sbsm_data *data = power_supply_get_drvdata(psy); >> + int regval = 0; >> + >> + switch (psp) { >> + case POWER_SUPPLY_PROP_ONLINE: >> + regval = sbsm_read_word(data->client, SBSM_CMD_BATSYSSTATECONT); >> + if (regval < 0) >> + return regval; >> + val->intval = !!(regval & 0x1); >> + break; >> + >> + case POWER_SUPPLY_PROP_CHARGE_TYPE: >> + regval = sbsm_read_word(data->client, SBSM_CMD_BATSYSSTATE); >> + if (regval < 0) >> + return regval; >> + >> + if ((regval & 0x00f0) == 0) { >> + val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE; >> + return 0; >> + } >> + val->intval = POWER_SUPPLY_CHARGE_TYPE_TRICKLE; >> + >> + if (data->is_ltc1760) { >> + /* charge mode fast if turbo is active */ >> + regval = sbsm_read_word(data->client, SBSM_CMD_LTC); >> + if (regval < 0) >> + return regval; >> + else if (regval & 0x80) >> + val->intval = POWER_SUPPLY_CHARGE_TYPE_FAST; >> + } >> + break; >> + >> + default: >> + return -EINVAL; >> + } >> + >> + return 0; >> +} >> + >> +static int sbsm_prop_is_writeable(struct power_supply *psy, >> + enum power_supply_property psp) >> +{ >> + struct sbsm_data *data = power_supply_get_drvdata(psy); >> + >> + return (psp == POWER_SUPPLY_PROP_CHARGE_TYPE) && data->is_ltc1760; >> +} >> + >> +static int sbsm_set_property(struct power_supply *psy, >> + enum power_supply_property psp, >> + const union power_supply_propval *val) >> +{ >> + struct sbsm_data *data = power_supply_get_drvdata(psy); >> + int ret = -EINVAL; >> + >> + switch (psp) { >> + case POWER_SUPPLY_PROP_CHARGE_TYPE: >> + /* write 1 to TURBO if type fast is given */ >> + if (data->is_ltc1760) { >> + u16 regval = val->intval == >> + POWER_SUPPLY_CHARGE_TYPE_FAST ? (0x1 << 7) : 0; >> + ret = sbsm_write_word(data->client, SBSM_CMD_LTC, >> + regval); >> + } > > That's not nicely indented. Try doing it this way to > reduce indention: > > if (data->is_ltc1760) > break; > u16 regval = ... > >> + break; >> + >> + default: >> + break; >> + } >> + >> + return ret; >> +} >> + >> +/* >> + * Switch to battery >> + * Parameter chan is directly the content of SMB_BAT* nibble >> + */ >> +static int sbsm_select(struct i2c_mux_core *muxc, u32 chan) >> +{ >> + struct sbsm_data *data = i2c_mux_priv(muxc); >> + int ret = 0; >> + u16 reg; >> + >> + if (data->cur_chan == chan) >> + return ret; >> + >> + /* chan goes from 1 ... 4 */ >> + reg = 1 << (11 + chan); >> + ret = sbsm_write_word(data->client, SBSM_CMD_BATSYSSTATE, reg); >> + if (ret) >> + dev_err(&data->client->dev, "Failed to select channel %i\n", >> + chan); > > Add > > struct device *dev = &data->client->dev; > > at the beginning of the function and use it here to avoid line > break. > >> + else >> + data->cur_chan = chan; >> + >> + return ret; >> +} >> + >> +#if defined(CONFIG_OF) >> + >> +#include <linux/of_device.h> > > Move include to top of file. You can include it unconditionally. > >> +static const struct of_device_id sbsm_dt_ids[] = { >> + { .compatible = "sbs,sbs-manager" }, >> + { .compatible = "lltc,ltc1760" }, >> + { } >> +}; >> +MODULE_DEVICE_TABLE(of, sbsm_dt_ids); > > This can go next to the other MODULE_DEVICE_TABLE. > >> +#endif >> + >> +static const struct power_supply_desc sbsm_default_psy_desc = { >> + .type = POWER_SUPPLY_TYPE_MAINS, >> + .properties = sbsm_props, >> + .num_properties = ARRAY_SIZE(sbsm_props), >> + .get_property = &sbsm_get_property, >> + .set_property = &sbsm_set_property, >> + .property_is_writeable = &sbsm_prop_is_writeable, >> +}; >> + >> +static int sbsm_probe(struct i2c_client *client, >> + const struct i2c_device_id *id) >> +{ >> + struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent); >> + struct sbsm_data *data; >> + struct device *dev = &client->dev; >> + struct power_supply_desc *psy_desc; >> + struct power_supply_config psy_cfg = {}; >> + int ret = 0, i, supported_bats; >> + >> + /* Device listens only at address 0x0a */ >> + if (client->addr != 0x0a) >> + return -ENODEV; > > I guess EINVAL makes more sense? > >> + if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA)) >> + return -EPFNOSUPPORT; >> + >> + data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL); >> + if (!data) >> + return -ENOMEM; >> + >> + i2c_set_clientdata(client, data); >> + >> + data->client = client; >> + data->is_ltc1760 = !!strstr(id->name, "ltc1760"); >> + >> + ret = sbsm_read_word(client, SBSM_CMD_BATSYSINFO); >> + if (ret < 0) >> + return ret; >> + supported_bats = le16_to_cpu(ret) & 0xf; > > How often do you want to convert endianess? :) > Drop this. > >> + data->muxc = i2c_mux_alloc(adapter, dev, SBSM_MAX_BATS, 0, >> + I2C_MUX_LOCKED, &sbsm_select, NULL); >> + if (!data->muxc) { >> + dev_err(dev, "failed to alloc i2c mux\n"); >> + ret = -ENOMEM; >> + goto err_mux_alloc; >> + } >> + data->muxc->priv = data; >> + >> + /* register muxed i2c channels. One for each supported battery */ >> + for (i = 0; i < SBSM_MAX_BATS; ++i) { >> + if ((1 << i) & supported_bats) { > > This can be written more readable as > > if (supported_bats & BIT(i)) > >> + ret = i2c_mux_add_adapter(data->muxc, 0, i + 1, 0); >> + if (ret) { >> + dev_err(dev, >> + "failed to register i2c mux channel %d\n", >> + i + 1); >> + goto err_mux_register; >> + } >> + } >> + } >> + >> + psy_desc = devm_kmemdup(dev, &sbsm_default_psy_desc, >> + sizeof(struct power_supply_desc), >> + GFP_KERNEL); >> + if (!psy_desc) { >> + ret = -ENOMEM; >> + goto err_psy; >> + } >> + >> + psy_desc->name = devm_kasprintf(dev, GFP_KERNEL, "sbsm-%s", >> + dev_name(&client->dev)); >> + if (!psy_desc->name) { >> + ret = -ENOMEM; >> + goto err_psy; >> + } >> + >> + psy_cfg.drv_data = data; > > Please add: > > psy_cfg->of_node = dev->of_node; > >> + data->psy = devm_power_supply_register(dev, psy_desc, &psy_cfg); >> + if (IS_ERR(data->psy)) { >> + ret = PTR_ERR(data->psy); >> + dev_err(dev, "failed to register power supply %s\n", >> + psy_desc->name); >> + goto err_psy; >> + } >> + >> + dev_info(dev, "sbsm registered\n"); >> + return 0; >> + >> +err_psy: >> +err_mux_register: >> + i2c_mux_del_adapters(data->muxc); >> + >> +err_mux_alloc: >> + return ret; >> +} >> + >> +static int sbsm_remove(struct i2c_client *client) >> +{ >> + struct sbsm_data *data = i2c_get_clientdata(client); >> + >> + i2c_mux_del_adapters(data->muxc); >> + return 0; >> +} >> + >> +static const struct i2c_device_id sbsm_ids[] = { >> + { "sbs-manager", 0 }, >> + { "ltc1760", 0 }, >> + { } >> +}; >> +MODULE_DEVICE_TABLE(i2c, sbsm_ids); >> + >> +static struct i2c_driver sbsm_driver = { >> + .driver = { >> + .name = "sbsm", >> + .owner = THIS_MODULE, > > Please drop .owner assignment. It will be done by i2c-core. > But you should add the following: > > .of_match_table = of_match_ptr(sbsm_dt_ids), > >> + }, >> + .probe = sbsm_probe, >> + .remove = sbsm_remove, >> + .id_table = sbsm_ids >> +}; >> +module_i2c_driver(sbsm_driver); >> + >> +MODULE_LICENSE("GPL"); >> +MODULE_AUTHOR("Karl-Heinz Schneider <karl-heinz@schneider-inet.de>"); >> +MODULE_DESCRIPTION("SBSM Smart Battery System Manager"); > > -- Sebastian >
Hi Phil, On Tue, May 02, 2017 at 10:20:22AM +0800, Phil Reid wrote: > In regards the le to cpu conversion. grepping the supply folder > finds a couple of other suspicious cases. > > sbs-battery & the bq24735-cahrger do similar things. > > thoughts on if they need to be corrected? Yes, those drivers look incorrect. I guess nobody noticed, since most people use little endian machines nowadays (so le16_to_cpu and cpu_to_le16 do nothing). -- Sebastian
diff --git a/drivers/power/supply/Kconfig b/drivers/power/supply/Kconfig index da54ac8..8aa5324 100644 --- a/drivers/power/supply/Kconfig +++ b/drivers/power/supply/Kconfig @@ -533,4 +533,17 @@ config AXP20X_POWER This driver provides support for the power supply features of AXP20x PMIC. +config MANAGER_SBS + tristate "Smart Battery System Manager" + depends on I2C && I2C_MUX + help + Say Y here to include support for Smart Battery System Manager + ICs. The driver reports online and charging status via sysfs. + It presents itself also as I2C mux which allows to bind + smart battery driver to its ports. + Supported is for example LTC1760. + + This driver can also be built as a module. If so, the module will be + called sbs-manager. + endif # POWER_SUPPLY diff --git a/drivers/power/supply/Makefile b/drivers/power/supply/Makefile index 3789a2c..4f53c98 100644 --- a/drivers/power/supply/Makefile +++ b/drivers/power/supply/Makefile @@ -74,3 +74,4 @@ obj-$(CONFIG_CHARGER_TPS65090) += tps65090-charger.o obj-$(CONFIG_CHARGER_TPS65217) += tps65217_charger.o obj-$(CONFIG_AXP288_FUEL_GAUGE) += axp288_fuel_gauge.o obj-$(CONFIG_AXP288_CHARGER) += axp288_charger.o +obj-$(CONFIG_MANAGER_SBS) += sbs-manager.o diff --git a/drivers/power/supply/sbs-manager.c b/drivers/power/supply/sbs-manager.c new file mode 100644 index 0000000..adf9e41 --- /dev/null +++ b/drivers/power/supply/sbs-manager.c @@ -0,0 +1,325 @@ +/* + * Driver for SBS compliant Smart Battery System Managers + * + * The device communicates via i2c at address 0x0a and multiplexes access to up + * to four smart batteries at address 0x0b. + * + * Via sysfs interface the online state and charge type are presented. + * + * Datasheet SBSM: http://sbs-forum.org/specs/sbsm100b.pdf + * Datasheet LTC1760: http://cds.linear.com/docs/en/datasheet/1760fb.pdf + * + * Karl-Heinz Schneider <karl-heinz@schneider-inet.de> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + */ + +#include <linux/module.h> +#include <linux/i2c.h> +#include <linux/i2c-mux.h> +#include <linux/power_supply.h> + +#define SBSM_MAX_BATS 4 +#define SBSM_RETRY_CNT 3 + +/* registers addresses */ +#define SBSM_CMD_BATSYSSTATE 0x01 +#define SBSM_CMD_BATSYSSTATECONT 0x02 +#define SBSM_CMD_BATSYSINFO 0x04 +#define SBSM_CMD_LTC 0x3c + +struct sbsm_data { + struct i2c_client *client; + struct i2c_mux_core *muxc; + + struct power_supply *psy; + + int cur_chan; /* currently selected channel */ + bool is_ltc1760; /* special capabilities */ +}; + +static enum power_supply_property sbsm_props[] = { + POWER_SUPPLY_PROP_ONLINE, + POWER_SUPPLY_PROP_CHARGE_TYPE, +}; + +static int sbsm_read_word(struct i2c_client *client, u8 address) +{ + int reg, retries = SBSM_RETRY_CNT; + + while (retries > 0) { + reg = i2c_smbus_read_word_data(client, address); + if (reg >= 0) + break; + --retries; + } + + if (reg < 0) { + dev_err(&client->dev, "failed to read register %i\n", + (int)address); + return reg; + } + + return le16_to_cpu(reg); +} + +static int sbsm_write_word(struct i2c_client *client, u8 address, u16 word) +{ + int ret, retries = SBSM_RETRY_CNT; + + word = cpu_to_le16(word); + while (retries > 0) { + ret = i2c_smbus_write_word_data(client, address, word); + if (ret >= 0) + break; + --retries; + } + if (ret < 0) + dev_err(&client->dev, "failed to write to register %i\n", + (int)address); + + return ret; +} + +static int sbsm_get_property(struct power_supply *psy, + enum power_supply_property psp, + union power_supply_propval *val) +{ + struct sbsm_data *data = power_supply_get_drvdata(psy); + int regval = 0; + + switch (psp) { + case POWER_SUPPLY_PROP_ONLINE: + regval = sbsm_read_word(data->client, SBSM_CMD_BATSYSSTATECONT); + if (regval < 0) + return regval; + val->intval = !!(regval & 0x1); + break; + + case POWER_SUPPLY_PROP_CHARGE_TYPE: + regval = sbsm_read_word(data->client, SBSM_CMD_BATSYSSTATE); + if (regval < 0) + return regval; + + if ((regval & 0x00f0) == 0) { + val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE; + return 0; + } + val->intval = POWER_SUPPLY_CHARGE_TYPE_TRICKLE; + + if (data->is_ltc1760) { + /* charge mode fast if turbo is active */ + regval = sbsm_read_word(data->client, SBSM_CMD_LTC); + if (regval < 0) + return regval; + else if (regval & 0x80) + val->intval = POWER_SUPPLY_CHARGE_TYPE_FAST; + } + break; + + default: + return -EINVAL; + } + + return 0; +} + +static int sbsm_prop_is_writeable(struct power_supply *psy, + enum power_supply_property psp) +{ + struct sbsm_data *data = power_supply_get_drvdata(psy); + + return (psp == POWER_SUPPLY_PROP_CHARGE_TYPE) && data->is_ltc1760; +} + +static int sbsm_set_property(struct power_supply *psy, + enum power_supply_property psp, + const union power_supply_propval *val) +{ + struct sbsm_data *data = power_supply_get_drvdata(psy); + int ret = -EINVAL; + + switch (psp) { + case POWER_SUPPLY_PROP_CHARGE_TYPE: + /* write 1 to TURBO if type fast is given */ + if (data->is_ltc1760) { + u16 regval = val->intval == + POWER_SUPPLY_CHARGE_TYPE_FAST ? (0x1 << 7) : 0; + ret = sbsm_write_word(data->client, SBSM_CMD_LTC, + regval); + } + break; + + default: + break; + } + + return ret; +} + +/* + * Switch to battery + * Parameter chan is directly the content of SMB_BAT* nibble + */ +static int sbsm_select(struct i2c_mux_core *muxc, u32 chan) +{ + struct sbsm_data *data = i2c_mux_priv(muxc); + int ret = 0; + u16 reg; + + if (data->cur_chan == chan) + return ret; + + /* chan goes from 1 ... 4 */ + reg = 1 << (11 + chan); + ret = sbsm_write_word(data->client, SBSM_CMD_BATSYSSTATE, reg); + if (ret) + dev_err(&data->client->dev, "Failed to select channel %i\n", + chan); + else + data->cur_chan = chan; + + return ret; +} + +#if defined(CONFIG_OF) + +#include <linux/of_device.h> + +static const struct of_device_id sbsm_dt_ids[] = { + { .compatible = "sbs,sbs-manager" }, + { .compatible = "lltc,ltc1760" }, + { } +}; +MODULE_DEVICE_TABLE(of, sbsm_dt_ids); + +#endif + +static const struct power_supply_desc sbsm_default_psy_desc = { + .type = POWER_SUPPLY_TYPE_MAINS, + .properties = sbsm_props, + .num_properties = ARRAY_SIZE(sbsm_props), + .get_property = &sbsm_get_property, + .set_property = &sbsm_set_property, + .property_is_writeable = &sbsm_prop_is_writeable, +}; + +static int sbsm_probe(struct i2c_client *client, + const struct i2c_device_id *id) +{ + struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent); + struct sbsm_data *data; + struct device *dev = &client->dev; + struct power_supply_desc *psy_desc; + struct power_supply_config psy_cfg = {}; + int ret = 0, i, supported_bats; + + /* Device listens only at address 0x0a */ + if (client->addr != 0x0a) + return -ENODEV; + + if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA)) + return -EPFNOSUPPORT; + + data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + i2c_set_clientdata(client, data); + + data->client = client; + data->is_ltc1760 = !!strstr(id->name, "ltc1760"); + + ret = sbsm_read_word(client, SBSM_CMD_BATSYSINFO); + if (ret < 0) + return ret; + supported_bats = le16_to_cpu(ret) & 0xf; + + data->muxc = i2c_mux_alloc(adapter, dev, SBSM_MAX_BATS, 0, + I2C_MUX_LOCKED, &sbsm_select, NULL); + if (!data->muxc) { + dev_err(dev, "failed to alloc i2c mux\n"); + ret = -ENOMEM; + goto err_mux_alloc; + } + data->muxc->priv = data; + + /* register muxed i2c channels. One for each supported battery */ + for (i = 0; i < SBSM_MAX_BATS; ++i) { + if ((1 << i) & supported_bats) { + ret = i2c_mux_add_adapter(data->muxc, 0, i + 1, 0); + if (ret) { + dev_err(dev, + "failed to register i2c mux channel %d\n", + i + 1); + goto err_mux_register; + } + } + } + + psy_desc = devm_kmemdup(dev, &sbsm_default_psy_desc, + sizeof(struct power_supply_desc), + GFP_KERNEL); + if (!psy_desc) { + ret = -ENOMEM; + goto err_psy; + } + + psy_desc->name = devm_kasprintf(dev, GFP_KERNEL, "sbsm-%s", + dev_name(&client->dev)); + if (!psy_desc->name) { + ret = -ENOMEM; + goto err_psy; + } + + psy_cfg.drv_data = data; + data->psy = devm_power_supply_register(dev, psy_desc, &psy_cfg); + if (IS_ERR(data->psy)) { + ret = PTR_ERR(data->psy); + dev_err(dev, "failed to register power supply %s\n", + psy_desc->name); + goto err_psy; + } + + dev_info(dev, "sbsm registered\n"); + return 0; + +err_psy: +err_mux_register: + i2c_mux_del_adapters(data->muxc); + +err_mux_alloc: + return ret; +} + +static int sbsm_remove(struct i2c_client *client) +{ + struct sbsm_data *data = i2c_get_clientdata(client); + + i2c_mux_del_adapters(data->muxc); + return 0; +} + +static const struct i2c_device_id sbsm_ids[] = { + { "sbs-manager", 0 }, + { "ltc1760", 0 }, + { } +}; +MODULE_DEVICE_TABLE(i2c, sbsm_ids); + +static struct i2c_driver sbsm_driver = { + .driver = { + .name = "sbsm", + .owner = THIS_MODULE, + }, + .probe = sbsm_probe, + .remove = sbsm_remove, + .id_table = sbsm_ids +}; +module_i2c_driver(sbsm_driver); + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Karl-Heinz Schneider <karl-heinz@schneider-inet.de>"); +MODULE_DESCRIPTION("SBSM Smart Battery System Manager");