w1: Add subsystem kernel public interface
Subsystems (3)
PATCH v2 1/1 w1: Add subsystem kernel public interface
In reply to a message not in the archiveLike other subsystems we should be able to define slave devices outside of the w1 directory. To do this we move public facing interface definitions to include/linux/w1.h and rename the internal definition file to w1_internal.h.
As w1_family.h and w1_int.h contained almost entirely public driver interface definitions we simply removed these files and moved the remaining definitions into w1_internal.h.
With this we can now start to move slave devices out of w1/slaves and into the subsystem based on the function they implement, again like other drivers.
---
MAINTAINERS | 1 +
drivers/w1/masters/ds1wm.c | 3 +-
drivers/w1/masters/ds2482.c | 3 +-
drivers/w1/masters/ds2490.c | 3 +-
drivers/w1/masters/matrox_w1.c | 3 +-
drivers/w1/masters/mxc_w1.c | 3 +-
drivers/w1/masters/omap_hdq.c | 3 +-
drivers/w1/masters/w1-gpio.c | 3 +-
drivers/w1/slaves/w1_bq27000.c | 6 +-
drivers/w1/slaves/w1_ds2405.c | 5 +-
drivers/w1/slaves/w1_ds2406.c | 6 +-
drivers/w1/slaves/w1_ds2408.c | 6 +-
drivers/w1/slaves/w1_ds2413.c | 6 +-
drivers/w1/slaves/w1_ds2423.c | 6 +-
drivers/w1/slaves/w1_ds2431.c | 6 +-
drivers/w1/slaves/w1_ds2433.c | 6 +-
drivers/w1/slaves/w1_ds2438.c | 5 +-
drivers/w1/slaves/w1_ds2760.c | 7 ++-
drivers/w1/slaves/w1_ds2780.c | 7 ++-
drivers/w1/slaves/w1_ds2781.c | 7 ++-
drivers/w1/slaves/w1_ds28e04.c | 6 +-
drivers/w1/slaves/w1_smem.c | 7 ++-
drivers/w1/slaves/w1_therm.c | 10 +++-
drivers/w1/w1.c | 6 +-
drivers/w1/w1_family.c | 3 +-
drivers/w1/w1_family.h | 98 -------------------------------
drivers/w1/w1_int.c | 3 +-
drivers/w1/w1_int.h | 27 ---------
drivers/w1/w1_internal.h | 87 ++++++++++++++++++++++++++++
drivers/w1/w1_io.c | 2 +-
drivers/w1/w1_netlink.c | 2 +-
drivers/w1/w1_netlink.h | 2 +-
{drivers/w1 => include/linux}/w1.h | 114 ++++++++++++++++---------------------
33 files changed, 205 insertions(+), 257 deletions(-)
delete mode 100644 drivers/w1/w1_family.h
delete mode 100644 drivers/w1/w1_int.h
create mode 100644 drivers/w1/w1_internal.h
rename {drivers/w1 => include/linux}/w1.h (76%)MAINTAINERS +1 -0
@@ -13766,6 +13766,7 @@ M: Evgeniy Polyakov <[email protected]> S: Maintained F: Documentation/w1/ F: drivers/w1/ +F: include/linux/w1.h W83791D HARDWARE MONITORING DRIVER M: Marc Hulsman <[email protected]>
drivers/w1/masters/ds1wm.c +1 -2
@@ -25,8 +25,7 @@#include <asm/io.h> -#include "../w1.h" -#include "../w1_int.h" +#include <linux/w1.h> #define DS1WM_CMD 0x00/* R/W 4 bits command */
drivers/w1/masters/ds2482.c +1 -2
@@ -20,8 +20,7 @@#include <linux/delay.h> #include <asm/delay.h> -#include "../w1.h" -#include "../w1_int.h" +#include <linux/w1.h> /** * Allow the active pullup to be disabled, default is enabled.
drivers/w1/masters/ds2490.c +1 -2
@@ -25,8 +25,7 @@#include <linux/usb.h> #include <linux/slab.h> -#include "../w1_int.h" -#include "../w1.h" +#include <linux/w1.h> /* USB Standard */ /* USB Control request vendor type */
drivers/w1/masters/matrox_w1.c +1 -2
@@ -34,8 +34,7 @@#include <linux/pci_ids.h> #include <linux/pci.h> -#include "../w1.h" -#include "../w1_int.h" +#include <linux/w1.h> /* * Matrox G400 DDC registers.
drivers/w1/masters/mxc_w1.c +1 -2
@@ -19,8 +19,7 @@#include <linux/module.h> #include <linux/platform_device.h> -#include "../w1.h" -#include "../w1_int.h" +#include <linux/w1.h> /* * MXC W1 Register offsets
drivers/w1/masters/omap_hdq.c +1 -2
@@ -19,8 +19,7 @@#include <linux/pm_runtime.h> #include <linux/of.h> -#include "../w1.h" -#include "../w1_int.h" +#include <linux/w1.h> #define MOD_NAME "OMAP_HDQ:"
drivers/w1/masters/w1-gpio.c +1 -2
@@ -20,8 +20,7 @@#include <linux/of.h> #include <linux/delay.h> -#include "../w1.h" -#include "../w1_int.h" +#include <linux/w1.h> static u8 w1_gpio_set_pullup (void *data,int delay) {
drivers/w1/slaves/w1_bq27000.c +3 -3
@@ -17,9 +17,9 @@#include <linux/mutex.h> #include <linux/power/bq27xxx_battery.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_BQ27000 0x01#define HDQ_CMD_READ (0)#define HDQ_CMD_WRITE (1<<7)
drivers/w1/slaves/w1_ds2405.c +3 -2
@@ -24,8 +24,9 @@#include <linux/string.h> #include <linux/types.h> -#include "../w1.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_DS2405 0x05MODULE_LICENSE ("GPL" );MODULE_AUTHOR ("Maciej S. Szmigiero <[email protected]>" );
drivers/w1/slaves/w1_ds2406.c +3 -3
@@ -17,9 +17,9 @@#include <linux/slab.h> #include <linux/crc16.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_DS2406 0x12#define W1_F12_FUNC_READ_STATUS 0xAA#define W1_F12_FUNC_WRITE_STATUS 0x55
drivers/w1/slaves/w1_ds2408.c +3 -3
@@ -15,9 +15,9 @@#include <linux/delay.h> #include <linux/slab.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_DS2408 0x29#define W1_F29_RETRIES 3
drivers/w1/slaves/w1_ds2413.c +3 -3
@@ -16,9 +16,9 @@#include <linux/delay.h> #include <linux/slab.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_DS2413 0x3A#define W1_F3A_RETRIES 3#define W1_F3A_FUNC_PIO_ACCESS_READ 0xF5
drivers/w1/slaves/w1_ds2423.c +3 -3
@@ -30,9 +30,9 @@#include <linux/delay.h> #include <linux/crc16.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_COUNTER_DS2423 0x1D#define CRC16_VALID 0xb001#define CRC16_INIT 0
drivers/w1/slaves/w1_ds2431.c +3 -3
@@ -16,9 +16,9 @@#include <linux/types.h> #include <linux/delay.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_EEPROM_DS2431 0x2D#define W1_F2D_EEPROM_SIZE 128#define W1_F2D_PAGE_COUNT 4
drivers/w1/slaves/w1_ds2433.c +3 -3
@@ -22,9 +22,9 @@#endif -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_EEPROM_DS2433 0x23#define W1_EEPROM_SIZE 512#define W1_PAGE_COUNT 16
drivers/w1/slaves/w1_ds2438.c +3 -2
@@ -13,8 +13,9 @@#include <linux/types.h> #include <linux/delay.h> -#include "../w1.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_DS2438 0x26#define W1_DS2438_RETRIES 3
drivers/w1/slaves/w1_ds2760.c +4 -3
@@ -18,11 +18,12 @@#include <linux/idr.h> #include <linux/gfp.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> +#include "w1_ds2760.h" +#define W1_FAMILY_DS2760 0x30 +static int w1_ds2760_io (struct device *dev,char *buf,int addr,size_t count,int io) {
drivers/w1/slaves/w1_ds2780.c +4 -3
@@ -21,11 +21,12 @@#include <linux/mutex.h> #include <linux/idr.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> +#include "w1_ds2780.h" +#define W1_FAMILY_DS2780 0x32 +static int w1_ds2780_do_io (struct device *dev,char *buf,int addr,size_t count,int io) {
drivers/w1/slaves/w1_ds2781.c +4 -3
@@ -18,11 +18,12 @@#include <linux/platform_device.h> #include <linux/mutex.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> +#include "w1_ds2781.h" +#define W1_FAMILY_DS2781 0x3D +static int w1_ds2781_do_io (struct device *dev,char *buf,int addr,size_t count,int io) {
drivers/w1/slaves/w1_ds28e04.c +3 -3
@@ -20,9 +20,9 @@#define CRC16_INIT 0#define CRC16_VALID 0xb001 -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_DS28E04 0x1C/* Allow the strong pullup to be disabled, but default to enabled. * If it was disabled a parasite powered device might not get the required
drivers/w1/slaves/w1_smem.c +4 -3
@@ -27,9 +27,10 @@#include <linux/device.h> #include <linux/types.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_FAMILY_SMEM_01 0x01 +#define W1_FAMILY_SMEM_81 0x81static struct w1_family w1_smem_family_01 = { .fid =W1_FAMILY_SMEM_01 ,
drivers/w1/slaves/w1_therm.c +7 -3
@@ -30,9 +30,13 @@#include <linux/slab.h> #include <linux/delay.h> -#include "../w1.h" -#include "../w1_int.h" -#include "../w1_family.h" +#include <linux/w1.h> + +#define W1_THERM_DS18S20 0x10 +#define W1_THERM_DS1822 0x22 +#define W1_THERM_DS18B20 0x28 +#define W1_THERM_DS1825 0x3B +#define W1_THERM_DS28EA00 0x42/* Allow the strong pullup to be disabled, but default to enabled. * If it was disabled a parasite powered device might not get the require
drivers/w1/w1.c +3 -3
@@ -28,11 +28,11 @@#include <linux/atomic.h> -#include "w1.h" -#include "w1_int.h" -#include "w1_family.h" +#include "w1_internal.h" #include "w1_netlink.h" +#define W1_FAMILY_DEFAULT 0 +static int w1_timeout =10 ;module_param_named (timeout, w1_timeout, int,0 );MODULE_PARM_DESC (timeout,"time in seconds between automatic slave searches" );
drivers/w1/w1_family.c +1 -2
@@ -18,8 +18,7 @@#include <linux/delay.h> #include <linux/export.h> -#include "w1_family.h" -#include "w1.h" +#include "w1_internal.h" DEFINE_SPINLOCK (w1_flock);static LIST_HEAD (w1_families);
drivers/w1/w1_family.h deleted +0 -98
98 lines not on this page · raw message
drivers/w1/w1_int.c +1 -2
@@ -21,9 +21,8 @@#include <linux/export.h> #include <linux/moduleparam.h> -#include "w1.h" +#include "w1_internal.h" #include "w1_netlink.h" -#include "w1_int.h" static int w1_search_count =-1 ;/* Default is continual scan */ module_param_named (search_count, w1_search_count, int,0 );
drivers/w1/w1_int.h deleted +0 -27
@@ -1,27 +0,0 @@ -/* -* Copyright (c) 2004 Evgeniy Polyakov <[email protected]> -* -* This program is free software; you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation; either version 2 of the License, or -* (at your option) any later version. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -* GNU General Public License for more details. -*/ - -#ifndef __W1_INT_H -#define __W1_INT_H - -#include <linux/kernel.h> -#include <linux/device.h> - -#include "w1.h" - -int w1_add_master_device (struct w1_bus_master *); -void w1_remove_master_device (struct w1_bus_master *); -void __w1_remove_master_device (struct w1_master *); - -#endif /* __W1_INT_H */
drivers/w1/w1_internal.h new file +87 -0
87 lines not on this page · raw message
drivers/w1/w1_io.c +1 -1
@@ -18,7 +18,7 @@#include <linux/moduleparam.h> #include <linux/module.h> -#include "w1.h" +#include "w1_internal.h" static int w1_delay_parm =1 ;module_param_named (delay_coef, w1_delay_parm, int,0 );
drivers/w1/w1_netlink.c +1 -1
@@ -17,7 +17,7 @@#include <linux/netlink.h> #include <linux/connector.h> -#include "w1.h" +#include "w1_internal.h" #include "w1_netlink.h" #if defined(CONFIG_W1_CON ) && (defined(CONFIG_CONNECTOR ) || (defined(CONFIG_CONNECTOR_MODULE ) && defined(CONFIG_W1_MODULE )))
drivers/w1/w1_netlink.h +1 -1
@@ -18,7 +18,7 @@#include <asm/types.h> #include <linux/connector.h> -#include "w1.h" +#include "w1_internal.h" /** * enum w1_cn_msg_flags - bitfield flags for struct cn_msg.flags
include/linux/w1.h renamed from drivers/w1/w1.h +49 -65
178 lines not on this page · raw message
Signature · 1 line
2.11.0
Quoted 5 lines · Andrew F. Davis
Like other subsystems we should be able to define slave devices outside of the w1 directory. To do this we move public facing interface definitions to
include/linux/w1.hand rename the internal definition file tow1_internal.h.
Quoted 7 lines
As
w1_family.handw1_int.hcontained almost entirely public driver interface definitions we simply removed these files and moved the remaining definitions intow1_internal.h.With this we can now start to move slave devices out of w1/slaves and into the subsystem based on the function they implement, again like other drivers.
Do you have a patch that does that? I don't want to accept this patch if that never happens...
thanks,
greg k-h
Quoted 10 lines · Greg Kroah-Hartman
Quoted 9 lines · Andrew F. Davis
Like other subsystems we should be able to define slave devices outside of the w1 directory. To do this we move public facing interface definitions to
include/linux/w1.hand rename the internal definition file tow1_internal.h.As
w1_family.handw1_int.hcontained almost entirely public driver interface definitions we simply removed these files and moved the remaining definitions intow1_internal.h.
Quoted 7 lines
Quoted 3 lines
With this we can now start to move slave devices out of w1/slaves and into the subsystem based on the function they implement, again like other drivers.
Do you have a patch that does that? I don't want to accept this patch if that never happens...
Yes, this reorganization stems from the need to move the BQ27xxx slave out, patches were posted and reviewed last cycle here[0] and will be reposted when this patch is accepted. Other w1/slaves can be moved out at their owners convenience if/when they wish.
Thanks,
Andrew
[0] https://lkml.org/lkml/2017/3/16/688
Quoted 4 lines
thanks,
greg k-h
Quoted 7 lines · Evgeniy Polyakov
Hi everyone
25.05.2017, 16:07, "Andrew F. Davis" <[email protected]>:
Quoted 3 lines
Quoted 2 lines
Do you have a patch that does that? I don't want to accept this patch if that never happens...
Quoted 7 lines
Quoted 4 lines
Yes, this reorganization stems from the need to move the BQ27xxx slave out, patches were posted and reviewed last cycle here[0] and will be reposted when this patch is accepted. Other w1/slaves can be moved out at their owners convenience if/when they wish.
Why does BQ27xxx need to move out of w1 tree?
Currently we have to enable a pseudo-platform device driver in the power/supply BQ27xxx driver, then the w1 driver has to instantiate this platform device and then they connect and communicate by sharing callbacks. This is rather hacky.
Other buses USB, SPI, I2C, etc. allow the client device drivers to live with the subsystem they for whose functionality they expose (e.g an I2C attached temp sensor goes in drivers/hwmon, not drivers/i2c).
"Need" is a bit strong, but moving this out makes things a lot cleaner and more consistent.
Andrew
Quoted 11 lines · Evgeniy Polyakov
25.05.2017, 16:22, "Andrew F. Davis" <[email protected]>:
Quoted 6 lines
Quoted 1 line
Why does BQ27xxx need to move out of w1 tree?
Currently we have to enable a pseudo-platform device driver in the power/supply BQ27xxx driver, then the w1 driver has to instantiate this platform device and then they connect and communicate by sharing callbacks. This is rather hacky.
Quoted 6 lines
Why do you have to create a pseudo-platform device driver to connect w1 and power/supply?
I'm not against creating w1 drivers in different places than
drivers/w1, but so far it was only power drivers which have problem with it (and they easily work it out), and this rises a flag.
We could keep it in w1 if we really wanted, but then things like Kconfig will get difficult to manage (we will jump between menus and have odd dependencies).
The other w1/slaves seem to mostly be simple EEPROMs and Gauges that would otherwise end up in misc/ so it is fine if they live in w1, but BQ27xxx does have a proper home in power/supplies and its i2c interface is already there, so moving the w1 interface there also makes sense to me.
Quoted 2 lines
I would rather move w1 header into
include/linux, will it be enough?
That's what this patch does, we just also re-organize things a bit so only things that need to be public end up in include/linux. It seems to be all that is needed for my use-case at least.
Quoted 10 lines · Evgeniy Polyakov
25.05.2017, 16:50, "Andrew F. Davis" <[email protected]>:
Quoted 6 lines
Quoted 5 lines
Why do you have to create a pseudo-platform device driver to connect w1 and power/supply?
I'm not against creating w1 drivers in different places than
drivers/w1, but so far it was only power drivers which have problem with it (and they easily work it out), and this rises a flag.
Quoted 7 lines
Quoted 3 lines
We could keep it in w1 if we really wanted, but then things like
Kconfigwill get difficult to manage (we will jump between menus and have odd dependencies).One still has to jump between kconfig menus to enable w1 and power devices, or to use 'select', nothing really changes.
Well, one less step in that we get to drop the platform shim driver, but I see what you mean.
Quoted 5 lines
Quoted 5 lines
The other w1/slaves seem to mostly be simple EEPROMs and Gauges that would otherwise end up in misc/ so it is fine if they live in w1, but BQ27xxx does have a proper home in power/supplies and its i2c interface is already there, so moving the w1 interface there also makes sense to me.
Quoted 7 lines
Quoted 5 lines
Quoted 1 line
I would rather move w1 header into
include/linux, will it be enough?That's what this patch does, we just also re-organize things a bit so only things that need to be public end up in
include/linux. It seems to be all that is needed for my use-case at least.Ok, lets merge it.
Great, thanks!
Quoted 4 lines
My personal note: please drop TI copyright from headers, at least from those which already exist and you move them around, it is your work and not TI. It is up to you to put into driver itself.
9-5 TI owns everything I touch :) so I just figured I should add it, but I have no personal problem dropping the copyright notice (actually I already did this as you requested this in v1).
Quoted 9 lines · Andrew F. Davis
Like other subsystems we should be able to define slave devices outside of the w1 directory. To do this we move public facing interface definitions to
include/linux/w1.hand rename the internal definition file tow1_internal.h.As
w1_family.handw1_int.hcontained almost entirely public driver interface definitions we simply removed these files and moved the remaining definitions intow1_internal.h.
Quoted 6 lines
With this we can now start to move slave devices out of w1/slaves and into the subsystem based on the function they implement, again like other drivers.
Signed-off-by Andrew F. Davis <[email protected]>Reviewed-by Sebastian Reichel <[email protected]>
This breaks the build for me:
CC [M] drivers/power/supply/ds2760_battery.odrivers/power/supply/ds2760_battery.c:31:10: fatal error: ../../w1/w1.h: No such file or directory
#include "../../w1/w1.h"
^~~~~~~~~~~~~~~compilation terminated.
So there was w1 drivers outside of the drivers/w1/ directory :)
Please fix and resend.
thanks,
greg k-h
Quoted 20 lines · Greg Kroah-Hartman
Quoted 9 lines · Andrew F. Davis
Like other subsystems we should be able to define slave devices outside of the w1 directory. To do this we move public facing interface definitions to
include/linux/w1.hand rename the internal definition file tow1_internal.h.As
w1_family.handw1_int.hcontained almost entirely public driver interface definitions we simply removed these files and moved the remaining definitions intow1_internal.h.Quoted 6 lines
With this we can now start to move slave devices out of w1/slaves and into the subsystem based on the function they implement, again like other drivers.
Signed-off-by Andrew F. Davis <[email protected]>Reviewed-by Sebastian Reichel <[email protected]>This breaks the build for me:
CC [M]drivers/power/supply/ds2760_battery.odrivers/power/supply/ds2760_battery.c:31:10: fatal error:../../w1/w1.h: No such file or directory
Quoted 7 lines
#include "../../w1/w1.h" ^~~~~~~~~~~~~~~compilation terminated.
So there was w1 drivers outside of the
drivers/w1/directory :)
Seems these drivers are like the BQ27xxx I'm trying to fix-up, these are platform drivers that connect with the real driver in w1/. Must have missed my search.
Quoted 2 lines
Please fix and resend.
Fix sent in v3.
Thanks,
Andrew
Quoted 4 lines
thanks,
greg k-h