Re: [v7 10/10] platform/x86/amd/hsmp: Use dev_groups in the driver structure

["Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>]

[-- Attachment #1: Type: text/plain, Size: 15065 bytes --]

On Tue, 3 Sep 2024, Suma Hegde wrote:

> Move out of device_add_group() variants, instead assign static array of
> attribute groups to .dev_groups in platform_driver structure.
> Then use is_visible to enable only the necessary files on the platform.
> 
> .read() and .is_bin_visibile() have slightly different
> implemetations on ACPI and non-ACPI system, so move them
> to respective files.
> 
> Signed-off-by: Suma Hegde <suma.hegde@amd.com>
> Reviewed-by: Naveen Krishna Chatradhi <naveenkrishna.chatradhi@amd.com>

Thanks, looks okay now.

Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>

-- 
 i.

> ---
> Changes since v6:
> 1. Move common code of hsmp_metric_tbl_read() of plat.c and acpi.c to
>    hsmp.c with the same function name.
> 2. Rename hsmp_metric_tbl_read() to hsmp_metric_tbl_plat_read() and
>    hsmp_metric_tbl_acpi_read() in plat.c acpi.c respectively.
> 3. Add tabe space in macros definition in plat.c
> 4. Keep only one cast for sock_ind.
> 
> Changes since v5:
> Assign integer directly to .private.
> 
> Changes since v4:
> Change ->private from string pointer to u16 pointer.
> 
> Changes since v3:
> This patch and next patch(9th and 10th patch in v3 series) are merged
> and commit description is updated.
> 
> Changes since v2:
> None
> 
> Changes since v1:
> 1. Change is_visible to is_bin_visible in commit message
> 1. Add parenthesis around read and is_bin_visible in commit message
> 2. Change plat_dev to hsmp_pdev, hsmp_device to mdev
> 3. Remove unnecessary if, else conditions in hsmp_is_sock_attr_visible
> 4. Change un cached to un-cached
> 
>  drivers/platform/x86/amd/hsmp/acpi.c |  65 ++++++++++-----
>  drivers/platform/x86/amd/hsmp/hsmp.c |  64 ++-------------
>  drivers/platform/x86/amd/hsmp/hsmp.h |   9 +--
>  drivers/platform/x86/amd/hsmp/plat.c | 113 +++++++++++++++++++++------
>  4 files changed, 140 insertions(+), 111 deletions(-)
> 
> diff --git a/drivers/platform/x86/amd/hsmp/acpi.c b/drivers/platform/x86/amd/hsmp/acpi.c
> index 766617e6adc7..d226f7deb49b 100644
> --- a/drivers/platform/x86/amd/hsmp/acpi.c
> +++ b/drivers/platform/x86/amd/hsmp/acpi.c
> @@ -9,6 +9,7 @@
>  
>  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>  
> +#include <asm/amd_hsmp.h>
>  #include <asm/amd_nb.h>
>  
>  #include <linux/acpi.h>
> @@ -211,6 +212,8 @@ static int hsmp_parse_acpi_table(struct device *dev, u16 sock_ind)
>  
>  	sema_init(&sock->hsmp_sem, 1);
>  
> +	dev_set_drvdata(dev, sock);
> +
>  	/* Read MP1 base address from CRS method */
>  	ret = hsmp_read_acpi_crs(sock);
>  	if (ret)
> @@ -220,27 +223,23 @@ static int hsmp_parse_acpi_table(struct device *dev, u16 sock_ind)
>  	return hsmp_read_acpi_dsd(sock);
>  }
>  
> -static int hsmp_create_acpi_sysfs_if(struct device *dev)
> +static ssize_t hsmp_metric_tbl_acpi_read(struct file *filp, struct kobject *kobj,
> +					 struct bin_attribute *bin_attr, char *buf,
> +					 loff_t off, size_t count)
>  {
> -	struct attribute_group *attr_grp;
> -	u16 sock_ind;
> -	int ret;
> +	struct device *dev = container_of(kobj, struct device, kobj);
> +	struct hsmp_socket *sock = dev_get_drvdata(dev);
>  
> -	attr_grp = devm_kzalloc(dev, sizeof(struct attribute_group), GFP_KERNEL);
> -	if (!attr_grp)
> -		return -ENOMEM;
> -
> -	attr_grp->is_bin_visible = hsmp_is_sock_attr_visible;
> -
> -	ret = hsmp_get_uid(dev, &sock_ind);
> -	if (ret)
> -		return ret;
> +	return hsmp_metric_tbl_read(sock, buf, count);
> +}
>  
> -	ret = hsmp_create_attr_list(attr_grp, dev, sock_ind);
> -	if (ret)
> -		return ret;
> +static umode_t hsmp_is_sock_attr_visible(struct kobject *kobj,
> +					 struct bin_attribute *battr, int id)
> +{
> +	if (hsmp_pdev.proto_ver == HSMP_PROTO_VER6)
> +		return battr->attr.mode;
>  
> -	return devm_device_add_group(dev, attr_grp);
> +	return 0;
>  }
>  
>  static int init_acpi(struct device *dev)
> @@ -275,9 +274,36 @@ static int init_acpi(struct device *dev)
>  		return ret;
>  	}
>  
> +	if (hsmp_pdev.proto_ver == HSMP_PROTO_VER6) {
> +		ret = hsmp_get_tbl_dram_base(sock_ind);
> +		if (ret)
> +			dev_err(dev, "Failed to init metric table\n");
> +	}
> +
>  	return ret;
>  }
>  
> +static struct bin_attribute  hsmp_metric_tbl_attr = {
> +	.attr = { .name = HSMP_METRICS_TABLE_NAME, .mode = 0444},
> +	.read = hsmp_metric_tbl_acpi_read,
> +	.size = sizeof(struct hsmp_metric_table),
> +};
> +
> +static struct bin_attribute *hsmp_attr_list[] = {
> +	&hsmp_metric_tbl_attr,
> +	NULL
> +};
> +
> +static struct attribute_group hsmp_attr_grp = {
> +	.bin_attrs = hsmp_attr_list,
> +	.is_bin_visible = hsmp_is_sock_attr_visible,
> +};
> +
> +static const struct attribute_group *hsmp_groups[] = {
> +	&hsmp_attr_grp,
> +	NULL
> +};
> +
>  static const struct acpi_device_id amd_hsmp_acpi_ids[] = {
>  	{ACPI_HSMP_DEVICE_HID, 0},
>  	{}
> @@ -306,10 +332,6 @@ static int hsmp_acpi_probe(struct platform_device *pdev)
>  		return ret;
>  	}
>  
> -	ret = hsmp_create_acpi_sysfs_if(&pdev->dev);
> -	if (ret)
> -		dev_err(&pdev->dev, "Failed to create HSMP sysfs interface\n");
> -
>  	if (!hsmp_pdev.is_probed) {
>  		ret = hsmp_misc_register(&pdev->dev);
>  		if (ret)
> @@ -338,6 +360,7 @@ static struct platform_driver amd_hsmp_driver = {
>  	.driver		= {
>  		.name	= DRIVER_NAME,
>  		.acpi_match_table = amd_hsmp_acpi_ids,
> +		.dev_groups = hsmp_groups,
>  	},
>  };
>  
> diff --git a/drivers/platform/x86/amd/hsmp/hsmp.c b/drivers/platform/x86/amd/hsmp/hsmp.c
> index 8c8e361b1feb..e7df514c699c 100644
> --- a/drivers/platform/x86/amd/hsmp/hsmp.c
> +++ b/drivers/platform/x86/amd/hsmp/hsmp.c
> @@ -278,19 +278,16 @@ long hsmp_ioctl(struct file *fp, unsigned int cmd, unsigned long arg)
>  	return 0;
>  }
>  
> -ssize_t hsmp_metric_tbl_read(struct file *filp, struct kobject *kobj,
> -			     struct bin_attribute *bin_attr, char *buf,
> -			     loff_t off, size_t count)
> +ssize_t hsmp_metric_tbl_read(struct hsmp_socket *sock, char *buf, size_t size)
>  {
> -	struct hsmp_socket *sock = bin_attr->private;
>  	struct hsmp_message msg = { 0 };
>  	int ret;
>  
> -	if (!sock)
> +	if (!sock || !buf)
>  		return -EINVAL;
>  
> -	/* Do not support lseek(), reads entire metric table */
> -	if (count < bin_attr->size) {
> +	/* Do not support lseek(), also don't allow more than the size of metric table */
> +	if (size != sizeof(struct hsmp_metric_table)) {
>  		dev_err(sock->dev, "Wrong buffer size\n");
>  		return -EINVAL;
>  	}
> @@ -301,12 +298,12 @@ ssize_t hsmp_metric_tbl_read(struct file *filp, struct kobject *kobj,
>  	ret = hsmp_send_message(&msg);
>  	if (ret)
>  		return ret;
> -	memcpy_fromio(buf, sock->metric_tbl_addr, bin_attr->size);
> +	memcpy_fromio(buf, sock->metric_tbl_addr, size);
>  
> -	return bin_attr->size;
> +	return size;
>  }
>  
> -static int hsmp_get_tbl_dram_base(u16 sock_ind)
> +int hsmp_get_tbl_dram_base(u16 sock_ind)
>  {
>  	struct hsmp_socket *sock = &hsmp_pdev.sock[sock_ind];
>  	struct hsmp_message msg = { 0 };
> @@ -339,53 +336,6 @@ static int hsmp_get_tbl_dram_base(u16 sock_ind)
>  	return 0;
>  }
>  
> -umode_t hsmp_is_sock_attr_visible(struct kobject *kobj,
> -				  struct bin_attribute *battr, int id)
> -{
> -	if (hsmp_pdev.proto_ver == HSMP_PROTO_VER6)
> -		return battr->attr.mode;
> -	else
> -		return 0;
> -}
> -
> -static int hsmp_init_metric_tbl_bin_attr(struct bin_attribute **hattrs, u16 sock_ind)
> -{
> -	struct bin_attribute *hattr = &hsmp_pdev.sock[sock_ind].hsmp_attr;
> -
> -	sysfs_bin_attr_init(hattr);
> -	hattr->attr.name	= HSMP_METRICS_TABLE_NAME;
> -	hattr->attr.mode	= 0444;
> -	hattr->read		= hsmp_metric_tbl_read;
> -	hattr->size		= sizeof(struct hsmp_metric_table);
> -	hattr->private		= &hsmp_pdev.sock[sock_ind];
> -	hattrs[0]		= hattr;
> -
> -	if (hsmp_pdev.proto_ver == HSMP_PROTO_VER6)
> -		return hsmp_get_tbl_dram_base(sock_ind);
> -	else
> -		return 0;
> -}
> -
> -/* One bin sysfs for metrics table */
> -#define NUM_HSMP_ATTRS		1
> -
> -int hsmp_create_attr_list(struct attribute_group *attr_grp,
> -			  struct device *dev, u16 sock_ind)
> -{
> -	struct bin_attribute **hsmp_bin_attrs;
> -
> -	/* Null terminated list of attributes */
> -	hsmp_bin_attrs = devm_kcalloc(dev, NUM_HSMP_ATTRS + 1,
> -				      sizeof(*hsmp_bin_attrs),
> -				      GFP_KERNEL);
> -	if (!hsmp_bin_attrs)
> -		return -ENOMEM;
> -
> -	attr_grp->bin_attrs = hsmp_bin_attrs;
> -
> -	return hsmp_init_metric_tbl_bin_attr(hsmp_bin_attrs, sock_ind);
> -}
> -
>  int hsmp_cache_proto_ver(u16 sock_ind)
>  {
>  	struct hsmp_message msg = { 0 };
> diff --git a/drivers/platform/x86/amd/hsmp/hsmp.h b/drivers/platform/x86/amd/hsmp/hsmp.h
> index 9ab50bc74676..9b4ab6a3598c 100644
> --- a/drivers/platform/x86/amd/hsmp/hsmp.h
> +++ b/drivers/platform/x86/amd/hsmp/hsmp.h
> @@ -57,16 +57,11 @@ struct hsmp_plat_device {
>  
>  extern struct hsmp_plat_device hsmp_pdev;
>  
> -ssize_t hsmp_metric_tbl_read(struct file *filp, struct kobject *kobj,
> -			     struct bin_attribute *bin_attr, char *buf,
> -			     loff_t off, size_t count);
>  int hsmp_cache_proto_ver(u16 sock_ind);
> -umode_t hsmp_is_sock_attr_visible(struct kobject *kobj,
> -				  struct bin_attribute *battr, int id);
> -int hsmp_create_attr_list(struct attribute_group *attr_grp,
> -			  struct device *dev, u16 sock_ind);
>  int hsmp_test(u16 sock_ind, u32 value);
>  long hsmp_ioctl(struct file *fp, unsigned int cmd, unsigned long arg);
>  void hsmp_misc_deregister(void);
>  int hsmp_misc_register(struct device *dev);
> +int hsmp_get_tbl_dram_base(u16 sock_ind);
> +ssize_t hsmp_metric_tbl_read(struct hsmp_socket *sock, char *buf, size_t size);
>  #endif /* HSMP_H */
> diff --git a/drivers/platform/x86/amd/hsmp/plat.c b/drivers/platform/x86/amd/hsmp/plat.c
> index e49b53f8c5e3..a1f42163db57 100644
> --- a/drivers/platform/x86/amd/hsmp/plat.c
> +++ b/drivers/platform/x86/amd/hsmp/plat.c
> @@ -9,6 +9,7 @@
>  
>  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>  
> +#include <asm/amd_hsmp.h>
>  #include <asm/amd_nb.h>
>  
>  #include <linux/device.h>
> @@ -61,36 +62,93 @@ static const struct file_operations hsmp_fops = {
>  	.compat_ioctl	= hsmp_ioctl,
>  };
>  
> -static int hsmp_create_non_acpi_sysfs_if(struct device *dev)
> +static ssize_t hsmp_metric_tbl_plat_read(struct file *filp, struct kobject *kobj,
> +					 struct bin_attribute *bin_attr, char *buf,
> +					 loff_t off, size_t count)
>  {
> -	const struct attribute_group **hsmp_attr_grps;
> -	struct attribute_group *attr_grp;
> -	u16 i;
> +	struct hsmp_socket *sock;
> +	u16 sock_ind;
>  
> -	hsmp_attr_grps = devm_kcalloc(dev, hsmp_pdev.num_sockets + 1,
> -				      sizeof(*hsmp_attr_grps),
> -				      GFP_KERNEL);
> -	if (!hsmp_attr_grps)
> -		return -ENOMEM;
> +	sock_ind = (uintptr_t)bin_attr->private;
> +	if (sock_ind >= hsmp_pdev.num_sockets)
> +		return -EINVAL;
>  
> -	/* Create a sysfs directory for each socket */
> -	for (i = 0; i < hsmp_pdev.num_sockets; i++) {
> -		attr_grp = devm_kzalloc(dev, sizeof(struct attribute_group),
> -					GFP_KERNEL);
> -		if (!attr_grp)
> -			return -ENOMEM;
> +	sock = &hsmp_pdev.sock[sock_ind];
>  
> -		snprintf(hsmp_pdev.sock[i].name, HSMP_ATTR_GRP_NAME_SIZE, "socket%u", (u8)i);
> -		attr_grp->name			= hsmp_pdev.sock[i].name;
> -		attr_grp->is_bin_visible	= hsmp_is_sock_attr_visible;
> -		hsmp_attr_grps[i]		= attr_grp;
> +	return hsmp_metric_tbl_read(sock, buf, count);
> +}
>  
> -		hsmp_create_attr_list(attr_grp, dev, i);
> -	}
> +static umode_t hsmp_is_sock_attr_visible(struct kobject *kobj,
> +					 struct bin_attribute *battr, int id)
> +{
> +	u16 sock_ind;
> +
> +	sock_ind = (uintptr_t)battr->private;
> +
> +	if (id == 0 && sock_ind >= hsmp_pdev.num_sockets)
> +		return SYSFS_GROUP_INVISIBLE;
>  
> -	return device_add_groups(dev, hsmp_attr_grps);
> +	if (hsmp_pdev.proto_ver == HSMP_PROTO_VER6)
> +		return battr->attr.mode;
> +
> +	return 0;
>  }
>  
> +/*
> + * AMD supports maximum of 8 sockets in a system.
> + * Static array of 8 + 1(for NULL) elements is created below
> + * to create sysfs groups for sockets.
> + * is_bin_visible function is used to show / hide the necessary groups.
> + */
> +#define HSMP_BIN_ATTR(index, _list)					\
> +static struct bin_attribute attr##index = {				\
> +	.attr = { .name = HSMP_METRICS_TABLE_NAME, .mode = 0444},	\
> +	.private = (void *)index,					\
> +	.read = hsmp_metric_tbl_plat_read,					\
> +	.size = sizeof(struct hsmp_metric_table),			\
> +};									\
> +static struct bin_attribute _list[] = {					\
> +	&attr##index,							\
> +	NULL								\
> +}
> +
> +HSMP_BIN_ATTR(0, *sock0_attr_list);
> +HSMP_BIN_ATTR(1, *sock1_attr_list);
> +HSMP_BIN_ATTR(2, *sock2_attr_list);
> +HSMP_BIN_ATTR(3, *sock3_attr_list);
> +HSMP_BIN_ATTR(4, *sock4_attr_list);
> +HSMP_BIN_ATTR(5, *sock5_attr_list);
> +HSMP_BIN_ATTR(6, *sock6_attr_list);
> +HSMP_BIN_ATTR(7, *sock7_attr_list);
> +
> +#define HSMP_BIN_ATTR_GRP(index, _list, _name)			\
> +static struct attribute_group sock##index##_attr_grp = {	\
> +	.bin_attrs = _list,					\
> +	.is_bin_visible = hsmp_is_sock_attr_visible,		\
> +	.name = #_name,						\
> +}
> +
> +HSMP_BIN_ATTR_GRP(0, sock0_attr_list, socket0);
> +HSMP_BIN_ATTR_GRP(1, sock1_attr_list, socket1);
> +HSMP_BIN_ATTR_GRP(2, sock2_attr_list, socket2);
> +HSMP_BIN_ATTR_GRP(3, sock3_attr_list, socket3);
> +HSMP_BIN_ATTR_GRP(4, sock4_attr_list, socket4);
> +HSMP_BIN_ATTR_GRP(5, sock5_attr_list, socket5);
> +HSMP_BIN_ATTR_GRP(6, sock6_attr_list, socket6);
> +HSMP_BIN_ATTR_GRP(7, sock7_attr_list, socket7);
> +
> +static const struct attribute_group *hsmp_groups[] = {
> +	&sock0_attr_grp,
> +	&sock1_attr_grp,
> +	&sock2_attr_grp,
> +	&sock3_attr_grp,
> +	&sock4_attr_grp,
> +	&sock5_attr_grp,
> +	&sock6_attr_grp,
> +	&sock7_attr_grp,
> +	NULL
> +};
> +
>  static inline bool is_f1a_m0h(void)
>  {
>  	if (boot_cpu_data.x86 == 0x1A && boot_cpu_data.x86_model <= 0x0F)
> @@ -141,6 +199,12 @@ static int init_platform_device(struct device *dev)
>  			dev_err(dev, "Failed to read HSMP protocol version\n");
>  			return ret;
>  		}
> +
> +		if (hsmp_pdev.proto_ver == HSMP_PROTO_VER6) {
> +			ret = hsmp_get_tbl_dram_base(i);
> +			if (ret)
> +				dev_err(dev, "Failed to init metric table\n");
> +		}
>  	}
>  
>  	return 0;
> @@ -162,10 +226,6 @@ static int hsmp_pltdrv_probe(struct platform_device *pdev)
>  		return ret;
>  	}
>  
> -	ret = hsmp_create_non_acpi_sysfs_if(&pdev->dev);
> -	if (ret)
> -		dev_err(&pdev->dev, "Failed to create HSMP sysfs interface\n");
> -
>  	return hsmp_misc_register(&pdev->dev);
>  }
>  
> @@ -179,6 +239,7 @@ static struct platform_driver amd_hsmp_driver = {
>  	.remove_new	= hsmp_pltdrv_remove,
>  	.driver		= {
>  		.name	= DRIVER_NAME,
> +		.dev_groups = hsmp_groups,
>  	},
>  };
>  
>