Good day,

On Thu, Apr 14, 2022 at 07:44:53AM +0100, Mike Leach wrote:

Add in functionality to allow load via configfs.

define a binary file format and provide a reader for that format that will create and populate configuration and feature structures use by the driver infrastructure.

Signed-off-by: Mike Leach mike.leach@linaro.org

drivers/hwtracing/coresight/Makefile | 2 +- .../coresight/coresight-config-file.c | 432 ++++++++++++++++++ .../coresight/coresight-config-file.h | 117 +++++ .../hwtracing/coresight/coresight-config.h | 15 + .../hwtracing/coresight/coresight-syscfg.h | 1 + 5 files changed, 566 insertions(+), 1 deletion(-) create mode 100644 drivers/hwtracing/coresight/coresight-config-file.c create mode 100644 drivers/hwtracing/coresight/coresight-config-file.h

diff --git a/drivers/hwtracing/coresight/Makefile b/drivers/hwtracing/coresight/Makefile index b6c4a48140ec..5de2bb79f4ac 100644 --- a/drivers/hwtracing/coresight/Makefile +++ b/drivers/hwtracing/coresight/Makefile @@ -6,7 +6,7 @@ obj-$(CONFIG_CORESIGHT) += coresight.o coresight-y := coresight-core.o coresight-etm-perf.o coresight-platform.o \ coresight-sysfs.o coresight-syscfg.o coresight-config.o \ coresight-cfg-preload.o coresight-cfg-afdo.o \

• coresight-syscfg-configfs.o
  

• coresight-syscfg-configfs.o coresight-config-file.o
  

obj-$(CONFIG_CORESIGHT_LINK_AND_SINK_TMC) += coresight-tmc.o coresight-tmc-y := coresight-tmc-core.o coresight-tmc-etf.o \ coresight-tmc-etr.o diff --git a/drivers/hwtracing/coresight/coresight-config-file.c b/drivers/hwtracing/coresight/coresight-config-file.c new file mode 100644 index 000000000000..3fd001938324 --- /dev/null +++ b/drivers/hwtracing/coresight/coresight-config-file.c @@ -0,0 +1,432 @@ +// SPDX-License-Identifier: GPL-2.0 +/*

• • Copyright (c) 2020 Linaro Limited, All rights reserved.
• • Author: Mike Leach mike.leach@linaro.org
• */

+#include "coresight-config.h" +#include "coresight-config-file.h" +#include "coresight-syscfg.h"

+#define cscfg_extract_u64(val64) { \

• val64 = *(u64 *)(buffer + used); \
• used += sizeof(u64); \
• }

+#define cscfg_extract_u32(val32) { \

• val32 = *(u32 *)(buffer + used); \
• used += sizeof(u32); \
• }

+#define cscfg_extract_u16(val16) { \

• val16 = *(u16 *)(buffer + used); \
• used += sizeof(u16); \
• }

+#define cscfg_extract_u8(val8) { \

• val8 = *(buffer + used); \
• used++; \
• }

+static int cscfg_file_read_hdr(const u8 *buffer, const int buflen, int *buf_used,

• 	       struct cscfg_file_header *hdr)
  

+{

• /* file header always at the start of the buffer */
• int used = 0;
• if (buflen < sizeof(struct cscfg_file_header))

• return -EINVAL;
  

• cscfg_extract_u32(hdr->magic_version);
• if (hdr->magic_version != CSCFG_FILE_MAGIC_VERSION)

• return -EINVAL;
  

• cscfg_extract_u16(hdr->length);
• if (hdr->length > buflen)

• return -EINVAL;
  

• cscfg_extract_u16(hdr->nr_features);
• *buf_used = used;
• return 0;

+}

+static int cscfg_file_read_elem_hdr(const u8 *buffer, const int buflen, int *buf_used,

• 		    struct cscfg_file_elem_header *elem_hdr)
  

+{

• int used = *buf_used;
• if ((buflen - used) < (sizeof(u16) + sizeof(u8)))

• return -EINVAL;
  

• /* read length and check enough buffer remains for this element */
• elem_hdr->elem_length = *(u16 *)(buffer + used);
• if ((buflen - used) < elem_hdr->elem_length)

• return -EINVAL;
  

• /* don't use extract fn as we update used _after_ the comparison */
• used += sizeof(u16);
• /* read type and validate */
• cscfg_extract_u8(elem_hdr->elem_type);
• if ((elem_hdr->elem_type < CSCFG_FILE_ELEM_TYPE_FEAT) ||

•    (elem_hdr->elem_type > CSCFG_FILE_ELEM_TYPE_CFG))
  

• return -EINVAL;
  

• *buf_used = used;
• return 0;

+}

+static int cscfg_file_read_elem_str(const u8 *buffer, const int buflen, int *buf_used,

• 		    struct cscfg_file_elem_str *elem_str)
  

+{

• int used = *buf_used;
• if ((buflen - used) < sizeof(u16))

• return -EINVAL;
  

• cscfg_extract_u16(elem_str->str_len);
• if ((buflen - used) < elem_str->str_len)

• return -EINVAL;
  

• /* check for 0 termination */
• if (buffer[elem_str->str_len - 1] != 0)

As far as I can see @buffer is never incremented, and @elem_str->str_len is the length of the upcoming series of characters in the buffer. As such either this will always reference the start of @buffer and it is a bug or I am missing something very subtle. In the latter case please add a comment to underline what is happening.

• return -EINVAL;
  

• elem_str->str = devm_kstrdup(cscfg_device(), (char *)buffer, GFP_KERNEL);
• used += elem_str->str_len;
• *buf_used = used;
• return 0;

+}

+static int cscfg_file_alloc_desc_arrays(struct cscfg_fs_load_descs *desc_arrays,

• 			int nr_features)
  

+{

• /* arrays are 0 terminated - max of 1 config & nr_features features */
• desc_arrays->config_descs = devm_kcalloc(cscfg_device(), 2,

• 				 sizeof(struct cscfg_config_desc *),
  

• 				 GFP_KERNEL);
  

• if (!desc_arrays->config_descs)

• return -ENOMEM;
  

• desc_arrays->feat_descs = devm_kcalloc(cscfg_device(), nr_features + 1,

• 			       sizeof(struct cscfg_feature_desc *),
  

• 			       GFP_KERNEL);
  

• if (!desc_arrays->feat_descs)

• return -ENOMEM;
  

• return 0;

+}

+static int cscfg_file_read_elem_config(const u8 *buffer, const int buflen, int *buf_used,

• 		       struct cscfg_fs_load_descs *desc_arrays)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• struct cscfg_file_elem_str elem_str;
• struct cscfg_config_desc *config_desc;
• int used = *buf_used, nr_preset_vals, nr_preset_bytes, i;
• int err = 0;
• u64 *presets;
• /*

• * read the header - if not config, then don't update buf_used
  

• * pointer on return
  

• */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_CFG)

• return 0;
  

• /* we have a config - allocate the descriptor */
• config_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_config_desc),

• 		   GFP_KERNEL);
  

• if (!config_desc)

• return -ENOMEM;
  

• /* read the name string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• config_desc->name = elem_str.str;
• /* read the description string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• config_desc->description = elem_str.str;
• /* read in some values */
• if ((buflen - used) < sizeof(u64))

• return -EINVAL;
  

• cscfg_extract_u16(config_desc->nr_presets);
• cscfg_extract_u32(config_desc->nr_total_params);
• cscfg_extract_u16(config_desc->nr_feat_refs);
• /* read the array of 64bit presets if present */
• nr_preset_vals = config_desc->nr_total_params * config_desc->nr_presets;
• if (nr_preset_vals) {

• presets = devm_kcalloc(cscfg_device(), nr_preset_vals,
  

• 		       sizeof(u64), GFP_KERNEL);
  

• if (!presets)
  

• 	return -ENOMEM;
  

• nr_preset_bytes = sizeof(u64) * nr_preset_vals;
  

• if ((buflen - used) < nr_preset_bytes)
  

• 	return -EINVAL;
  

• memcpy(presets, (buffer + used), nr_preset_bytes);
  

• config_desc->presets = presets;
  

• used += nr_preset_bytes;
  

• }
• /* read the array of feature names referenced by the config */
• if (config_desc->nr_feat_refs) {

• config_desc->feat_ref_names = devm_kcalloc(cscfg_device(),
  

• 					   config_desc->nr_feat_refs,
  

• 					   sizeof(char *),
  

• 					   GFP_KERNEL);
  

• if (!config_desc->feat_ref_names)
  

• 	return -ENOMEM;
  

• for (i = 0; i < config_desc->nr_feat_refs; i++) {
  

• 	err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

• 	if (err)
  

• 		return err;
  

• 	config_desc->feat_ref_names[i] = elem_str.str;
  

• }
  

• }
• desc_arrays->config_descs[0] = config_desc;
• *buf_used = used;
• return 0;

+}

+/* just read the config name - if there is a config at this position */

Please add a description of the return behavior. Here I have to correlate with the code in cscfg_file_read_buffer_first_name() that it is not an error to find something else than a CSCFG_FILE_ELEM_TYPE_CFG type.

More comments coming tomorrow.

Thanks, Mathieu

+static int cscfg_file_read_elem_config_name(const u8 *buffer, const int buflen, int *buf_used,

• 			    struct cscfg_file_elem_str *elem_str)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• int used = *buf_used;
• int err;
• elem_str->str_len = 0;
• /*

• * read the header - if not config, then don't update buf_used
  

• * pointer on return
  

• */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_CFG)

• return 0;
  

• /* read the name string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, elem_str);
• if (err)

• return err;
  

• *buf_used = used;
• return 0;

+}

+static int cscfg_file_read_elem_param(const u8 *buffer, const int buflen, int *buf_used,

• 		      struct cscfg_parameter_desc *param_desc)
  

+{

• struct cscfg_file_elem_str elem_str;
• int err = 0, used = *buf_used;
• /* parameter name */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• param_desc->name = elem_str.str;
• /* parameter value */
• if ((buflen - used) < sizeof(u64))

• return -EINVAL;
  

• cscfg_extract_u64(param_desc->value);
• *buf_used = used;
• return err;

+}

+static int cscfg_file_read_elem_feature(const u8 *buffer, const int buflen, int *buf_used,

• 			struct cscfg_fs_load_descs *desc_arrays,
  

• 			const int feat_idx)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• struct cscfg_file_elem_str elem_str;
• struct cscfg_feature_desc *feat_desc;
• struct cscfg_regval_desc *p_reg_desc;
• int used = *buf_used, err, i, nr_regs_bytes;
• u32 val32;
• /* allocate the feature descriptor object */
• feat_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_feature_desc),

• 		 GFP_KERNEL);
  

• if (!feat_desc)

• return -ENOMEM;
  

• /* read and check the element header */
• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_FEAT)

• return -EINVAL;
  

• /* read the feature name */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• feat_desc->name = elem_str.str;
• /* read the description string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• feat_desc->description = elem_str.str;
• /*

• * read in some values
  

• * [u32 value: match_flags]
  

• * [u16 value: nr_regs]	    - number of registers.
  

• * [u16 value: nr_params]   - number of parameters.
  

• */
  

• cscfg_extract_u32(feat_desc->match_flags);
• cscfg_extract_u16(feat_desc->nr_regs);
• cscfg_extract_u16(feat_desc->nr_params);
• /* register descriptors - 32 bit + 64 bit value */
• if (feat_desc->nr_regs) {

• nr_regs_bytes = ((sizeof(u32) + sizeof(u64)) * feat_desc->nr_regs);
  

• if ((buflen - used) < nr_regs_bytes)
  

• 	return -EINVAL;
  

• feat_desc->regs_desc = devm_kcalloc(cscfg_device(),
  

• 				    feat_desc->nr_regs,
  

• 				    sizeof(struct cscfg_regval_desc),
  

• 				    GFP_KERNEL);
  

• if (!feat_desc->regs_desc)
  

• 	return -ENOMEM;
  

• for (i = 0; i < feat_desc->nr_regs; i++) {
  

• 	cscfg_extract_u32(val32);
  

• 	p_reg_desc = (struct cscfg_regval_desc *)&feat_desc->regs_desc[i];
  

• 	CSCFG_FILE_U32_TO_REG_DESC_INFO(val32, p_reg_desc);
  

• 	cscfg_extract_u64(feat_desc->regs_desc[i].val64);
  

• }
  

• }
• /* parameter descriptors - string + 64 bit value */
• if (feat_desc->nr_params) {

• feat_desc->params_desc = devm_kcalloc(cscfg_device(),
  

• 				      feat_desc->nr_params,
  

• 				      sizeof(struct cscfg_parameter_desc),
  

• 				      GFP_KERNEL);
  

• if (!feat_desc->params_desc)
  

• 	return -ENOMEM;
  

• for (i = 0; i < feat_desc->nr_params; i++) {
  

• 	err = cscfg_file_read_elem_param(buffer, buflen, &used,
  

• 					 &feat_desc->params_desc[i]);
  

• 	if (err)
  

• 		return err;
  

• }
  

• }
• desc_arrays->feat_descs[feat_idx] = feat_desc;
• *buf_used = used;
• return 0;

+}

+/* just read the feature name - if there is a feature at this position */ +static int cscfg_file_read_elem_feat_name(const u8 *buffer, const int buflen, int *buf_used,

• 			  struct cscfg_file_elem_str *elem_str)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• int used = *buf_used;
• int err;
• elem_str->str_len = 0;
• /*

• * read the header - if not config, then don't update buf_used
  

• * pointer on return
  

• */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_FEAT)

• return -EINVAL;
  

• /* read the feature name */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, elem_str);
• if (err)

• return err;
  

• *buf_used = used;
• return 0;

+}

+/*

• • Read a buffer and create the configuration and feature
• • descriptors to load into the cscfg system
• */

+int cscfg_file_read_buffer(const u8 *buffer, const int buflen,

• 	   struct cscfg_fs_load_descs *desc_arrays)
  

+{

• struct cscfg_file_header hdr;
• int used = 0, err, i;
• /* read in the file header */
• err = cscfg_file_read_hdr(buffer, buflen, &used, &hdr);
• if (err)

• return err;
  

• /* allocate the memory for the descriptor pointer arrays */
• err = cscfg_file_alloc_desc_arrays(desc_arrays, hdr.nr_features);
• if (err)

• return err;
  

• /* read elements */
• /* first element could be a config so check */
• err = cscfg_file_read_elem_config(buffer, buflen, &used, desc_arrays);
• if (err)

• return err;
  

• /* now read and populate all the feature descriptors */
• for (i = 0; i < hdr.nr_features; i++) {

• err = cscfg_file_read_elem_feature(buffer, buflen, &used, desc_arrays, i);
  

• if (err)
  

• 	return err;
  

• }
• return used;

+}

+int cscfg_file_read_buffer_first_name(const u8 *buffer, const int buflen,

• 		      const char **name)
  

+{

• struct cscfg_file_header hdr;
• struct cscfg_file_elem_str elem_str;
• int used = 0, err = 0;
• *name = NULL;
• /* read in the file header */
• err = cscfg_file_read_hdr(buffer, buflen, &used, &hdr);
• if (err)

• return err;
  

• err = cscfg_file_read_elem_config_name(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• /* no config string - get first feature name */
• if (!elem_str.str_len) {

• err = cscfg_file_read_elem_feat_name(buffer, buflen, &used, &elem_str);
  

• if (err)
  

• 	return err;
  

• }
• if (elem_str.str_len)

• *name = elem_str.str;
  

• return err;

+} diff --git a/drivers/hwtracing/coresight/coresight-config-file.h b/drivers/hwtracing/coresight/coresight-config-file.h new file mode 100644 index 000000000000..591f4c2c4be9 --- /dev/null +++ b/drivers/hwtracing/coresight/coresight-config-file.h @@ -0,0 +1,117 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/*

• • Copyright (c) 2020 Linaro Limited, All rights reserved.
• • Author: Mike Leach mike.leach@linaro.org
• */

+#ifndef _CORESIGHT_CORESIGHT_CONFIG_FILE_H +#define _CORESIGHT_CORESIGHT_CONFIG_FILE_H

+/*

• • Structures to represent configuration descriptors in a memory buffer
• • to serialise to and from files
• • File structure - for loading a configuration + features
• • from configfs.
• • [cscfg_file_header] - mandatory
• • [CONFIG_ELEM] - optional - only one permitted,
• • [FEATURE_ELEM] * [cscfg_file_header.nr_features]

• • 	- optional - file valid with config only.
    

• • Invalid file if no config or features.
• • File structure for [CONFIG_ELEM]:
• • [cscfg_file_elem_header] - header length value to end of feature strings.
• • [cscfg_file_elem_str] - name of the configuration
• • [cscfg_file_elem_str] - description of configuration
• • [u16 value - nr_presets]
• • [u32 value - nr_total_params]
• • [u16 value - nr_feat_refs]
• • [u64 values] * (nr_presets * nr_total_params)
• • [cscfg_file_elem_str] * nr_feat_refs
• • Only one configuration per file.
• • File structure for a [FEATURE_ELEM]
• • [cscfg_file_elem_header] - header length is total bytes to end of param structures.
• • [cscfg_file_elem_str] - feature name.
• • [cscfg_file_elem_str] - feature description.
• • [u32 value: match_flags]
• • [u16 value: nr_regs] - number of registers.
• • [u16 value: nr_params] - number of parameters.
• • [cscfg_regval_desc struct] * nr_regs
• • [PARAM_ELEM] * nr_params
• • File structure for [PARAM_ELEM]
• • [cscfg_file_elem_str] - parameter name.
• • [u64 value: param_value] - initial value.
• */

+/* major element types - configurations and features */

+#define CSCFG_FILE_ELEM_TYPE_FEAT 0x1 +#define CSCFG_FILE_ELEM_TYPE_CFG 0x2

+#define CSCFG_FILE_MAGIC_VERSION 0xC5CF0001

+#define CSCFG_FILE_U32_TO_REG_DESC_INFO(val32, p_desc) \

• { \
• p_desc->type = (val32 >> 24) & 0xFF; \
• p_desc->offset = (val32 >> 12) & 0xFFF; \
• p_desc->hw_info = val32 & 0xFFF; \
• }

+#define CSCFG_FILE_REG_DESC_INFO_TO_U32(val32, p_desc) \

• { \
• val32 = p_desc->hw_info & 0xFFF; \
• val32 |= ((p_desc->offset & 0xFFF) << 12); \
• val32 |= ((p_desc->type & 0xFF) << 24); \
• }

+/* binary attributes in configfs need a max size - declare a value for this. */ +#define CSCFG_FILE_MAXSIZE 16384

+/* limit string sizes */ +#define CSCFG_FILE_STR_MAXSIZE 1024

+/**

• • file header.
• • @magic_version: magic number / version for file/buffer format.
• • @length : total length of all data in the buffer.
• • @nr_features : total number of features in the buffer.
• */

+struct cscfg_file_header {

• u32 magic_version;
• u16 length;
• u16 nr_features;

+};

+/**

• • element header
• • @elem_length: total length of this element
• • @elem_type : type of this element - one of CSCFG_FILE_ELEM_TYPE.. defines.
• */

+struct cscfg_file_elem_header {

• u16 elem_length;
• u8 elem_type;

+};

+/**

• • string file element.
• • @str_len: length of string buffer including 0 terminator
• • @str : string buffer - 0 terminated.
• */

+struct cscfg_file_elem_str {

• u16 str_len;
• char *str;

+};

+#endif /* _CORESIGHT_CORESIGHT_CONFIG_FILE_H */ diff --git a/drivers/hwtracing/coresight/coresight-config.h b/drivers/hwtracing/coresight/coresight-config.h index 2e1670523461..9cd3c26ce023 100644 --- a/drivers/hwtracing/coresight/coresight-config.h +++ b/drivers/hwtracing/coresight/coresight-config.h @@ -85,6 +85,21 @@ struct cscfg_regval_desc { }; }; +/**

• • Dynamically loaded descriptor arrays loaded via configfs.
• • For builtin or module loaded configurations / features these are
• • statically defined at compile time. For configfs we create the arrays
• • dynamically so need a structure to handle this.
• • @config_descs: array of config descriptor pointers.
• • @feat_descs: array of feature descriptor pointers.
• */

+struct cscfg_fs_load_descs {

• struct cscfg_config_desc **config_descs;
• struct cscfg_feature_desc **feat_descs;

+};

/**

• Device feature descriptor - combination of registers and parameters to
• program a device to implement a specific complex function.

diff --git a/drivers/hwtracing/coresight/coresight-syscfg.h b/drivers/hwtracing/coresight/coresight-syscfg.h index 9106ffab4833..6a6e33585be9 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg.h +++ b/drivers/hwtracing/coresight/coresight-syscfg.h @@ -66,6 +66,7 @@ struct cscfg_registered_csdev { enum cscfg_load_owner_type { CSCFG_OWNER_PRELOAD, CSCFG_OWNER_MODULE,

• CSCFG_OWNER_CONFIGFS,

}; /** -- 2.17.1

On Thu, Apr 14, 2022 at 07:44:53AM +0100, Mike Leach wrote:

Add in functionality to allow load via configfs.

define a binary file format and provide a reader for that format that will create and populate configuration and feature structures use by the driver infrastructure.

Signed-off-by: Mike Leach mike.leach@linaro.org

drivers/hwtracing/coresight/Makefile | 2 +- .../coresight/coresight-config-file.c | 432 ++++++++++++++++++ .../coresight/coresight-config-file.h | 117 +++++ .../hwtracing/coresight/coresight-config.h | 15 + .../hwtracing/coresight/coresight-syscfg.h | 1 + 5 files changed, 566 insertions(+), 1 deletion(-) create mode 100644 drivers/hwtracing/coresight/coresight-config-file.c create mode 100644 drivers/hwtracing/coresight/coresight-config-file.h

diff --git a/drivers/hwtracing/coresight/Makefile b/drivers/hwtracing/coresight/Makefile index b6c4a48140ec..5de2bb79f4ac 100644 --- a/drivers/hwtracing/coresight/Makefile +++ b/drivers/hwtracing/coresight/Makefile @@ -6,7 +6,7 @@ obj-$(CONFIG_CORESIGHT) += coresight.o coresight-y := coresight-core.o coresight-etm-perf.o coresight-platform.o \ coresight-sysfs.o coresight-syscfg.o coresight-config.o \ coresight-cfg-preload.o coresight-cfg-afdo.o \

• coresight-syscfg-configfs.o
  

• coresight-syscfg-configfs.o coresight-config-file.o
  

obj-$(CONFIG_CORESIGHT_LINK_AND_SINK_TMC) += coresight-tmc.o coresight-tmc-y := coresight-tmc-core.o coresight-tmc-etf.o \ coresight-tmc-etr.o diff --git a/drivers/hwtracing/coresight/coresight-config-file.c b/drivers/hwtracing/coresight/coresight-config-file.c new file mode 100644 index 000000000000..3fd001938324 --- /dev/null +++ b/drivers/hwtracing/coresight/coresight-config-file.c @@ -0,0 +1,432 @@ +// SPDX-License-Identifier: GPL-2.0 +/*

• • Copyright (c) 2020 Linaro Limited, All rights reserved.
• • Author: Mike Leach mike.leach@linaro.org
• */

+#include "coresight-config.h" +#include "coresight-config-file.h" +#include "coresight-syscfg.h"

+#define cscfg_extract_u64(val64) { \

• val64 = *(u64 *)(buffer + used); \
• used += sizeof(u64); \
• }

+#define cscfg_extract_u32(val32) { \

• val32 = *(u32 *)(buffer + used); \
• used += sizeof(u32); \
• }

+#define cscfg_extract_u16(val16) { \

• val16 = *(u16 *)(buffer + used); \
• used += sizeof(u16); \
• }

+#define cscfg_extract_u8(val8) { \

• val8 = *(buffer + used); \
• used++; \
• }

+static int cscfg_file_read_hdr(const u8 *buffer, const int buflen, int *buf_used,

• 	       struct cscfg_file_header *hdr)
  

+{

• /* file header always at the start of the buffer */
• int used = 0;
• if (buflen < sizeof(struct cscfg_file_header))

• return -EINVAL;
  

• cscfg_extract_u32(hdr->magic_version);
• if (hdr->magic_version != CSCFG_FILE_MAGIC_VERSION)

• return -EINVAL;
  

• cscfg_extract_u16(hdr->length);
• if (hdr->length > buflen)

• return -EINVAL;
  

• cscfg_extract_u16(hdr->nr_features);
• *buf_used = used;
• return 0;

+}

+static int cscfg_file_read_elem_hdr(const u8 *buffer, const int buflen, int *buf_used,

• 		    struct cscfg_file_elem_header *elem_hdr)
  

+{

• int used = *buf_used;
• if ((buflen - used) < (sizeof(u16) + sizeof(u8)))

• return -EINVAL;
  

• /* read length and check enough buffer remains for this element */
• elem_hdr->elem_length = *(u16 *)(buffer + used);
• if ((buflen - used) < elem_hdr->elem_length)

• return -EINVAL;
  

• /* don't use extract fn as we update used _after_ the comparison */
• used += sizeof(u16);
• /* read type and validate */
• cscfg_extract_u8(elem_hdr->elem_type);
• if ((elem_hdr->elem_type < CSCFG_FILE_ELEM_TYPE_FEAT) ||

•    (elem_hdr->elem_type > CSCFG_FILE_ELEM_TYPE_CFG))
  

• return -EINVAL;
  

• *buf_used = used;
• return 0;

+}

+static int cscfg_file_read_elem_str(const u8 *buffer, const int buflen, int *buf_used,

• 		    struct cscfg_file_elem_str *elem_str)
  

+{

• int used = *buf_used;
• if ((buflen - used) < sizeof(u16))

• return -EINVAL;
  

• cscfg_extract_u16(elem_str->str_len);
• if ((buflen - used) < elem_str->str_len)

• return -EINVAL;
  

• /* check for 0 termination */
• if (buffer[elem_str->str_len - 1] != 0)

• return -EINVAL;
  

• elem_str->str = devm_kstrdup(cscfg_device(), (char *)buffer, GFP_KERNEL);
• used += elem_str->str_len;
• *buf_used = used;
• return 0;

+}

+static int cscfg_file_alloc_desc_arrays(struct cscfg_fs_load_descs *desc_arrays,

• 			int nr_features)
  

+{

• /* arrays are 0 terminated - max of 1 config & nr_features features */
• desc_arrays->config_descs = devm_kcalloc(cscfg_device(), 2,

• 				 sizeof(struct cscfg_config_desc *),
  

• 				 GFP_KERNEL);
  

• if (!desc_arrays->config_descs)

• return -ENOMEM;
  

• desc_arrays->feat_descs = devm_kcalloc(cscfg_device(), nr_features + 1,

• 			       sizeof(struct cscfg_feature_desc *),
  

• 			       GFP_KERNEL);
  

• if (!desc_arrays->feat_descs)

• return -ENOMEM;
  

• return 0;

+}

+static int cscfg_file_read_elem_config(const u8 *buffer, const int buflen, int *buf_used,

• 		       struct cscfg_fs_load_descs *desc_arrays)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• struct cscfg_file_elem_str elem_str;
• struct cscfg_config_desc *config_desc;
• int used = *buf_used, nr_preset_vals, nr_preset_bytes, i;
• int err = 0;
• u64 *presets;
• /*

• * read the header - if not config, then don't update buf_used
  

• * pointer on return
  

• */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_CFG)

• return 0;
  

• /* we have a config - allocate the descriptor */
• config_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_config_desc),

• 		   GFP_KERNEL);
  

• if (!config_desc)

• return -ENOMEM;
  

• /* read the name string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• config_desc->name = elem_str.str;
• /* read the description string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• config_desc->description = elem_str.str;
• /* read in some values */
• if ((buflen - used) < sizeof(u64))

• return -EINVAL;
  

• cscfg_extract_u16(config_desc->nr_presets);
• cscfg_extract_u32(config_desc->nr_total_params);
• cscfg_extract_u16(config_desc->nr_feat_refs);
• /* read the array of 64bit presets if present */
• nr_preset_vals = config_desc->nr_total_params * config_desc->nr_presets;
• if (nr_preset_vals) {

• presets = devm_kcalloc(cscfg_device(), nr_preset_vals,
  

• 		       sizeof(u64), GFP_KERNEL);
  

• if (!presets)
  

• 	return -ENOMEM;
  

• nr_preset_bytes = sizeof(u64) * nr_preset_vals;
  

• if ((buflen - used) < nr_preset_bytes)
  

• 	return -EINVAL;
  

• memcpy(presets, (buffer + used), nr_preset_bytes);
  

• config_desc->presets = presets;
  

• used += nr_preset_bytes;
  

• }
• /* read the array of feature names referenced by the config */
• if (config_desc->nr_feat_refs) {

• config_desc->feat_ref_names = devm_kcalloc(cscfg_device(),
  

• 					   config_desc->nr_feat_refs,
  

• 					   sizeof(char *),
  

• 					   GFP_KERNEL);
  

• if (!config_desc->feat_ref_names)
  

• 	return -ENOMEM;
  

• for (i = 0; i < config_desc->nr_feat_refs; i++) {
  

• 	err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

• 	if (err)
  

• 		return err;
  

• 	config_desc->feat_ref_names[i] = elem_str.str;
  

• }
  

• }
• desc_arrays->config_descs[0] = config_desc;
• *buf_used = used;
• return 0;

+}

+/* just read the config name - if there is a config at this position */ +static int cscfg_file_read_elem_config_name(const u8 *buffer, const int buflen, int *buf_used,

• 			    struct cscfg_file_elem_str *elem_str)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• int used = *buf_used;
• int err;
• elem_str->str_len = 0;
• /*

• * read the header - if not config, then don't update buf_used
  

• * pointer on return
  

• */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_CFG)

• return 0;
  

• /* read the name string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, elem_str);
• if (err)

• return err;
  

• *buf_used = used;
• return 0;

+}

+static int cscfg_file_read_elem_param(const u8 *buffer, const int buflen, int *buf_used,

• 		      struct cscfg_parameter_desc *param_desc)
  

+{

• struct cscfg_file_elem_str elem_str;
• int err = 0, used = *buf_used;
• /* parameter name */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• param_desc->name = elem_str.str;
• /* parameter value */
• if ((buflen - used) < sizeof(u64))

• return -EINVAL;
  

• cscfg_extract_u64(param_desc->value);
• *buf_used = used;
• return err;

+}

+static int cscfg_file_read_elem_feature(const u8 *buffer, const int buflen, int *buf_used,

• 			struct cscfg_fs_load_descs *desc_arrays,
  

• 			const int feat_idx)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• struct cscfg_file_elem_str elem_str;
• struct cscfg_feature_desc *feat_desc;
• struct cscfg_regval_desc *p_reg_desc;
• int used = *buf_used, err, i, nr_regs_bytes;
• u32 val32;
• /* allocate the feature descriptor object */
• feat_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_feature_desc),

• 		 GFP_KERNEL);
  

• if (!feat_desc)

• return -ENOMEM;
  

• /* read and check the element header */
• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_FEAT)

• return -EINVAL;
  

• /* read the feature name */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• feat_desc->name = elem_str.str;
• /* read the description string */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• feat_desc->description = elem_str.str;
• /*

• * read in some values
  

• * [u32 value: match_flags]
  

• * [u16 value: nr_regs]	    - number of registers.
  

• * [u16 value: nr_params]   - number of parameters.
  

• */
  

I expected the same kind of check found in cscfg_file_read_elem_config().

I am done with patch, moving on with the rest in the coming days.

Thanks, Mathieu

• cscfg_extract_u32(feat_desc->match_flags);
• cscfg_extract_u16(feat_desc->nr_regs);
• cscfg_extract_u16(feat_desc->nr_params);
• /* register descriptors - 32 bit + 64 bit value */
• if (feat_desc->nr_regs) {

• nr_regs_bytes = ((sizeof(u32) + sizeof(u64)) * feat_desc->nr_regs);
  

• if ((buflen - used) < nr_regs_bytes)
  

• 	return -EINVAL;
  

• feat_desc->regs_desc = devm_kcalloc(cscfg_device(),
  

• 				    feat_desc->nr_regs,
  

• 				    sizeof(struct cscfg_regval_desc),
  

• 				    GFP_KERNEL);
  

• if (!feat_desc->regs_desc)
  

• 	return -ENOMEM;
  

• for (i = 0; i < feat_desc->nr_regs; i++) {
  

• 	cscfg_extract_u32(val32);
  

• 	p_reg_desc = (struct cscfg_regval_desc *)&feat_desc->regs_desc[i];
  

• 	CSCFG_FILE_U32_TO_REG_DESC_INFO(val32, p_reg_desc);
  

• 	cscfg_extract_u64(feat_desc->regs_desc[i].val64);
  

• }
  

• }
• /* parameter descriptors - string + 64 bit value */
• if (feat_desc->nr_params) {

• feat_desc->params_desc = devm_kcalloc(cscfg_device(),
  

• 				      feat_desc->nr_params,
  

• 				      sizeof(struct cscfg_parameter_desc),
  

• 				      GFP_KERNEL);
  

• if (!feat_desc->params_desc)
  

• 	return -ENOMEM;
  

• for (i = 0; i < feat_desc->nr_params; i++) {
  

• 	err = cscfg_file_read_elem_param(buffer, buflen, &used,
  

• 					 &feat_desc->params_desc[i]);
  

• 	if (err)
  

• 		return err;
  

• }
  

• }
• desc_arrays->feat_descs[feat_idx] = feat_desc;
• *buf_used = used;
• return 0;

+}

+/* just read the feature name - if there is a feature at this position */ +static int cscfg_file_read_elem_feat_name(const u8 *buffer, const int buflen, int *buf_used,

• 			  struct cscfg_file_elem_str *elem_str)
  

+{

• struct cscfg_file_elem_header elem_hdr;
• int used = *buf_used;
• int err;
• elem_str->str_len = 0;
• /*

• * read the header - if not config, then don't update buf_used
  

• * pointer on return
  

• */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
• if (err)

• return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_FEAT)

• return -EINVAL;
  

• /* read the feature name */
• err = cscfg_file_read_elem_str(buffer, buflen, &used, elem_str);
• if (err)

• return err;
  

• *buf_used = used;
• return 0;

+}

+/*

• • Read a buffer and create the configuration and feature
• • descriptors to load into the cscfg system
• */

+int cscfg_file_read_buffer(const u8 *buffer, const int buflen,

• 	   struct cscfg_fs_load_descs *desc_arrays)
  

+{

• struct cscfg_file_header hdr;
• int used = 0, err, i;
• /* read in the file header */
• err = cscfg_file_read_hdr(buffer, buflen, &used, &hdr);
• if (err)

• return err;
  

• /* allocate the memory for the descriptor pointer arrays */
• err = cscfg_file_alloc_desc_arrays(desc_arrays, hdr.nr_features);
• if (err)

• return err;
  

• /* read elements */
• /* first element could be a config so check */
• err = cscfg_file_read_elem_config(buffer, buflen, &used, desc_arrays);
• if (err)

• return err;
  

• /* now read and populate all the feature descriptors */
• for (i = 0; i < hdr.nr_features; i++) {

• err = cscfg_file_read_elem_feature(buffer, buflen, &used, desc_arrays, i);
  

• if (err)
  

• 	return err;
  

• }
• return used;

+}

+int cscfg_file_read_buffer_first_name(const u8 *buffer, const int buflen,

• 		      const char **name)
  

+{

• struct cscfg_file_header hdr;
• struct cscfg_file_elem_str elem_str;
• int used = 0, err = 0;
• *name = NULL;
• /* read in the file header */
• err = cscfg_file_read_hdr(buffer, buflen, &used, &hdr);
• if (err)

• return err;
  

• err = cscfg_file_read_elem_config_name(buffer, buflen, &used, &elem_str);
• if (err)

• return err;
  

• /* no config string - get first feature name */
• if (!elem_str.str_len) {

• err = cscfg_file_read_elem_feat_name(buffer, buflen, &used, &elem_str);
  

• if (err)
  

• 	return err;
  

• }
• if (elem_str.str_len)

• *name = elem_str.str;
  

• return err;

+} diff --git a/drivers/hwtracing/coresight/coresight-config-file.h b/drivers/hwtracing/coresight/coresight-config-file.h new file mode 100644 index 000000000000..591f4c2c4be9 --- /dev/null +++ b/drivers/hwtracing/coresight/coresight-config-file.h @@ -0,0 +1,117 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/*

• • Copyright (c) 2020 Linaro Limited, All rights reserved.
• • Author: Mike Leach mike.leach@linaro.org
• */

+#ifndef _CORESIGHT_CORESIGHT_CONFIG_FILE_H +#define _CORESIGHT_CORESIGHT_CONFIG_FILE_H

+/*

• • Structures to represent configuration descriptors in a memory buffer
• • to serialise to and from files
• • File structure - for loading a configuration + features
• • from configfs.
• • [cscfg_file_header] - mandatory
• • [CONFIG_ELEM] - optional - only one permitted,
• • [FEATURE_ELEM] * [cscfg_file_header.nr_features]

• • 	- optional - file valid with config only.
    

• • Invalid file if no config or features.
• • File structure for [CONFIG_ELEM]:
• • [cscfg_file_elem_header] - header length value to end of feature strings.
• • [cscfg_file_elem_str] - name of the configuration
• • [cscfg_file_elem_str] - description of configuration
• • [u16 value - nr_presets]
• • [u32 value - nr_total_params]
• • [u16 value - nr_feat_refs]
• • [u64 values] * (nr_presets * nr_total_params)
• • [cscfg_file_elem_str] * nr_feat_refs
• • Only one configuration per file.
• • File structure for a [FEATURE_ELEM]
• • [cscfg_file_elem_header] - header length is total bytes to end of param structures.
• • [cscfg_file_elem_str] - feature name.
• • [cscfg_file_elem_str] - feature description.
• • [u32 value: match_flags]
• • [u16 value: nr_regs] - number of registers.
• • [u16 value: nr_params] - number of parameters.
• • [cscfg_regval_desc struct] * nr_regs
• • [PARAM_ELEM] * nr_params
• • File structure for [PARAM_ELEM]
• • [cscfg_file_elem_str] - parameter name.
• • [u64 value: param_value] - initial value.
• */

+/* major element types - configurations and features */

+#define CSCFG_FILE_ELEM_TYPE_FEAT 0x1 +#define CSCFG_FILE_ELEM_TYPE_CFG 0x2

+#define CSCFG_FILE_MAGIC_VERSION 0xC5CF0001

+#define CSCFG_FILE_U32_TO_REG_DESC_INFO(val32, p_desc) \

• { \
• p_desc->type = (val32 >> 24) & 0xFF; \
• p_desc->offset = (val32 >> 12) & 0xFFF; \
• p_desc->hw_info = val32 & 0xFFF; \
• }

+#define CSCFG_FILE_REG_DESC_INFO_TO_U32(val32, p_desc) \

• { \
• val32 = p_desc->hw_info & 0xFFF; \
• val32 |= ((p_desc->offset & 0xFFF) << 12); \
• val32 |= ((p_desc->type & 0xFF) << 24); \
• }

+/* binary attributes in configfs need a max size - declare a value for this. */ +#define CSCFG_FILE_MAXSIZE 16384

+/* limit string sizes */ +#define CSCFG_FILE_STR_MAXSIZE 1024

+/**

• • file header.
• • @magic_version: magic number / version for file/buffer format.
• • @length : total length of all data in the buffer.
• • @nr_features : total number of features in the buffer.
• */

+struct cscfg_file_header {

• u32 magic_version;
• u16 length;
• u16 nr_features;

+};

+/**

• • element header
• • @elem_length: total length of this element
• • @elem_type : type of this element - one of CSCFG_FILE_ELEM_TYPE.. defines.
• */

+struct cscfg_file_elem_header {

• u16 elem_length;
• u8 elem_type;

+};

+/**

• • string file element.
• • @str_len: length of string buffer including 0 terminator
• • @str : string buffer - 0 terminated.
• */

+struct cscfg_file_elem_str {

• u16 str_len;
• char *str;

+};

+#endif /* _CORESIGHT_CORESIGHT_CONFIG_FILE_H */ diff --git a/drivers/hwtracing/coresight/coresight-config.h b/drivers/hwtracing/coresight/coresight-config.h index 2e1670523461..9cd3c26ce023 100644 --- a/drivers/hwtracing/coresight/coresight-config.h +++ b/drivers/hwtracing/coresight/coresight-config.h @@ -85,6 +85,21 @@ struct cscfg_regval_desc { }; }; +/**

• • Dynamically loaded descriptor arrays loaded via configfs.
• • For builtin or module loaded configurations / features these are
• • statically defined at compile time. For configfs we create the arrays
• • dynamically so need a structure to handle this.
• • @config_descs: array of config descriptor pointers.
• • @feat_descs: array of feature descriptor pointers.
• */

+struct cscfg_fs_load_descs {

• struct cscfg_config_desc **config_descs;
• struct cscfg_feature_desc **feat_descs;

+};

/**

• Device feature descriptor - combination of registers and parameters to
• program a device to implement a specific complex function.

diff --git a/drivers/hwtracing/coresight/coresight-syscfg.h b/drivers/hwtracing/coresight/coresight-syscfg.h index 9106ffab4833..6a6e33585be9 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg.h +++ b/drivers/hwtracing/coresight/coresight-syscfg.h @@ -66,6 +66,7 @@ struct cscfg_registered_csdev { enum cscfg_load_owner_type { CSCFG_OWNER_PRELOAD, CSCFG_OWNER_MODULE,

• CSCFG_OWNER_CONFIGFS,

}; /** -- 2.17.1

Hi,

On Wed, 25 May 2022 at 18:38, Mathieu Poirier mathieu.poirier@linaro.org wrote:

Good day,

I have resumed working on this patchset. More comments below as I went back while looking at other patches...

On Thu, Apr 14, 2022 at 07:44:53AM +0100, Mike Leach wrote:

...

Add in functionality to allow load via configfs.

define a binary file format and provide a reader for that format that will create and populate configuration and feature structures use by the driver infrastructure.

Signed-off-by: Mike Leach mike.leach@linaro.org

drivers/hwtracing/coresight/Makefile | 2 +- .../coresight/coresight-config-file.c | 432 ++++++++++++++++++ .../coresight/coresight-config-file.h | 117 +++++ .../hwtracing/coresight/coresight-config.h | 15 + .../hwtracing/coresight/coresight-syscfg.h | 1 + 5 files changed, 566 insertions(+), 1 deletion(-) create mode 100644 drivers/hwtracing/coresight/coresight-config-file.c create mode 100644 drivers/hwtracing/coresight/coresight-config-file.h

diff --git a/drivers/hwtracing/coresight/Makefile b/drivers/hwtracing/coresight/Makefile index b6c4a48140ec..5de2bb79f4ac 100644 --- a/drivers/hwtracing/coresight/Makefile +++ b/drivers/hwtracing/coresight/Makefile @@ -6,7 +6,7 @@ obj-$(CONFIG_CORESIGHT) += coresight.o coresight-y := coresight-core.o coresight-etm-perf.o coresight-platform.o \ coresight-sysfs.o coresight-syscfg.o coresight-config.o \ coresight-cfg-preload.o coresight-cfg-afdo.o \

•         coresight-syscfg-configfs.o
  

•         coresight-syscfg-configfs.o coresight-config-file.o
  

obj-$(CONFIG_CORESIGHT_LINK_AND_SINK_TMC) += coresight-tmc.o coresight-tmc-y := coresight-tmc-core.o coresight-tmc-etf.o \ coresight-tmc-etr.o diff --git a/drivers/hwtracing/coresight/coresight-config-file.c b/drivers/hwtracing/coresight/coresight-config-file.c new file mode 100644 index 000000000000..3fd001938324 --- /dev/null +++ b/drivers/hwtracing/coresight/coresight-config-file.c @@ -0,0 +1,432 @@ +// SPDX-License-Identifier: GPL-2.0 +/*

• • Copyright (c) 2020 Linaro Limited, All rights reserved.

I can't remember if I commented on that before but this should likely be 2022, and for all the other files introduced by this patchset.

...

• • Author: Mike Leach mike.leach@linaro.org
• */

+#include "coresight-config.h" +#include "coresight-config-file.h" +#include "coresight-syscfg.h"

+#define cscfg_extract_u64(val64) { \

• val64 = *(u64 *)(buffer + used); \
  

• used += sizeof(u64); \
  

• }
  

+#define cscfg_extract_u32(val32) { \

• val32 = *(u32 *)(buffer + used); \
  

• used += sizeof(u32); \
  

• }
  

+#define cscfg_extract_u16(val16) { \

• val16 = *(u16 *)(buffer + used); \
  

• used += sizeof(u16); \
  

• }
  

+#define cscfg_extract_u8(val8) { \

• val8 = *(buffer + used); \
  

• used++; \
  

• }
  

+static int cscfg_file_read_hdr(const u8 *buffer, const int buflen, int *buf_used,

•                        struct cscfg_file_header *hdr)
  

+{

• /* file header always at the start of the buffer */
  

• int used = 0;
  

• if (buflen < sizeof(struct cscfg_file_header))
  

•         return -EINVAL;
  

• cscfg_extract_u32(hdr->magic_version);
  

• if (hdr->magic_version != CSCFG_FILE_MAGIC_VERSION)
  

•         return -EINVAL;
  

• cscfg_extract_u16(hdr->length);
  

• if (hdr->length > buflen)
  

•         return -EINVAL;
  

• cscfg_extract_u16(hdr->nr_features);
  

• *buf_used = used;
  

• return 0;
  

+}

+static int cscfg_file_read_elem_hdr(const u8 *buffer, const int buflen, int *buf_used,

•                             struct cscfg_file_elem_header *elem_hdr)
  

+{

• int used = *buf_used;
  

• if ((buflen - used) < (sizeof(u16) + sizeof(u8)))
  

•         return -EINVAL;
  

• /* read length and check enough buffer remains for this element */
  

• elem_hdr->elem_length = *(u16 *)(buffer + used);
  

• if ((buflen - used) < elem_hdr->elem_length)
  

•         return -EINVAL;
  

• /* don't use extract fn as we update used _after_ the comparison */
  

• used += sizeof(u16);
  

• /* read type and validate */
  

• cscfg_extract_u8(elem_hdr->elem_type);
  

• if ((elem_hdr->elem_type < CSCFG_FILE_ELEM_TYPE_FEAT) ||
  

•     (elem_hdr->elem_type > CSCFG_FILE_ELEM_TYPE_CFG))
  

•         return -EINVAL;
  

• *buf_used = used;
  

• return 0;
  

+}

+static int cscfg_file_read_elem_str(const u8 *buffer, const int buflen, int *buf_used,

•                             struct cscfg_file_elem_str *elem_str)
  

+{

• int used = *buf_used;
  

• if ((buflen - used) < sizeof(u16))
  

•         return -EINVAL;
  

• cscfg_extract_u16(elem_str->str_len);
  

• if ((buflen - used) < elem_str->str_len)
  

•         return -EINVAL;
  

• /* check for 0 termination */
  

• if (buffer[elem_str->str_len - 1] != 0)
  

•         return -EINVAL;
  

• elem_str->str = devm_kstrdup(cscfg_device(), (char *)buffer, GFP_KERNEL);
  

• used += elem_str->str_len;
  

• *buf_used = used;
  

• return 0;
  

+}

+static int cscfg_file_alloc_desc_arrays(struct cscfg_fs_load_descs *desc_arrays,

•                                 int nr_features)
  

+{

• /* arrays are 0 terminated - max of 1 config & nr_features features */
  

• desc_arrays->config_descs = devm_kcalloc(cscfg_device(), 2,
  

•                                          sizeof(struct cscfg_config_desc *),
  

•                                          GFP_KERNEL);
  

• if (!desc_arrays->config_descs)
  

•         return -ENOMEM;
  

• desc_arrays->feat_descs = devm_kcalloc(cscfg_device(), nr_features + 1,
  

•                                        sizeof(struct cscfg_feature_desc *),
  

•                                        GFP_KERNEL);
  

• if (!desc_arrays->feat_descs)
  

•         return -ENOMEM;
  

• return 0;
  

+}

+static int cscfg_file_read_elem_config(const u8 *buffer, const int buflen, int *buf_used,

•                                struct cscfg_fs_load_descs *desc_arrays)
  

+{

• struct cscfg_file_elem_header elem_hdr;
  

• struct cscfg_file_elem_str elem_str;
  

• struct cscfg_config_desc *config_desc;
  

• int used = *buf_used, nr_preset_vals, nr_preset_bytes, i;
  

• int err = 0;
  

• u64 *presets;
  

• /*
  

•  * read the header - if not config, then don't update buf_used
  

•  * pointer on return
  

•  */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
  

• if (err)
  

•         return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_CFG)
  

•         return 0;
  

• /* we have a config - allocate the descriptor */
  

• config_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_config_desc),
  

•                            GFP_KERNEL);
  

• if (!config_desc)
  

•         return -ENOMEM;
  

• /* read the name string */
  

• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

• if (err)
  

•         return err;
  

• config_desc->name = elem_str.str;
  

• /* read the description string */
  

• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

• if (err)
  

•         return err;
  

• config_desc->description = elem_str.str;
  

• /* read in some values */
  

• if ((buflen - used) < sizeof(u64))
  

•         return -EINVAL;
  

• cscfg_extract_u16(config_desc->nr_presets);
  

• cscfg_extract_u32(config_desc->nr_total_params);
  

• cscfg_extract_u16(config_desc->nr_feat_refs);
  

• /* read the array of 64bit presets if present */
  

• nr_preset_vals = config_desc->nr_total_params * config_desc->nr_presets;
  

• if (nr_preset_vals) {
  

•         presets = devm_kcalloc(cscfg_device(), nr_preset_vals,
  

•                                sizeof(u64), GFP_KERNEL);
  

•         if (!presets)
  

•                 return -ENOMEM;
  

•         nr_preset_bytes = sizeof(u64) * nr_preset_vals;
  

•         if ((buflen - used) < nr_preset_bytes)
  

•                 return -EINVAL;
  

•         memcpy(presets, (buffer + used), nr_preset_bytes);
  

•         config_desc->presets = presets;
  

•         used += nr_preset_bytes;
  

• }
  

• /* read the array of feature names referenced by the config */
  

• if (config_desc->nr_feat_refs) {
  

•         config_desc->feat_ref_names = devm_kcalloc(cscfg_device(),
  

•                                                    config_desc->nr_feat_refs,
  

•                                                    sizeof(char *),
  

•                                                    GFP_KERNEL);
  

•         if (!config_desc->feat_ref_names)
  

•                 return -ENOMEM;
  

•         for (i = 0; i < config_desc->nr_feat_refs; i++) {
  

•                 err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

•                 if (err)
  

•                         return err;
  

•                 config_desc->feat_ref_names[i] = elem_str.str;
  

•         }
  

• }
  

• desc_arrays->config_descs[0] = config_desc;
  

• *buf_used = used;
  

• return 0;
  

+}

+/* just read the config name - if there is a config at this position */ +static int cscfg_file_read_elem_config_name(const u8 *buffer, const int buflen, int *buf_used,

•                                     struct cscfg_file_elem_str *elem_str)
  

+{

• struct cscfg_file_elem_header elem_hdr;
  

• int used = *buf_used;
  

• int err;
  

• elem_str->str_len = 0;
  

• /*
  

•  * read the header - if not config, then don't update buf_used
  

•  * pointer on return
  

•  */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
  

• if (err)
  

•         return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_CFG)
  

•         return 0;
  

• /* read the name string */
  

• err = cscfg_file_read_elem_str(buffer, buflen, &used, elem_str);
  

• if (err)
  

•         return err;
  

• *buf_used = used;
  

• return 0;
  

+}

+static int cscfg_file_read_elem_param(const u8 *buffer, const int buflen, int *buf_used,

•                               struct cscfg_parameter_desc *param_desc)
  

+{

• struct cscfg_file_elem_str elem_str;
  

• int err = 0, used = *buf_used;
  

• /* parameter name */
  

• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

• if (err)
  

•         return err;
  

• param_desc->name = elem_str.str;
  

• /* parameter value */
  

• if ((buflen - used) < sizeof(u64))
  

•         return -EINVAL;
  

• cscfg_extract_u64(param_desc->value);
  

• *buf_used = used;
  

• return err;
  

+}

+static int cscfg_file_read_elem_feature(const u8 *buffer, const int buflen, int *buf_used,

•                                 struct cscfg_fs_load_descs *desc_arrays,
  

•                                 const int feat_idx)
  

+{

• struct cscfg_file_elem_header elem_hdr;
  

• struct cscfg_file_elem_str elem_str;
  

• struct cscfg_feature_desc *feat_desc;
  

• struct cscfg_regval_desc *p_reg_desc;
  

• int used = *buf_used, err, i, nr_regs_bytes;
  

• u32 val32;
  

• /* allocate the feature descriptor object */
  

• feat_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_feature_desc),
  

•                          GFP_KERNEL);
  

• if (!feat_desc)
  

•         return -ENOMEM;
  

• /* read and check the element header */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
  

• if (err)
  

•         return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_FEAT)
  

•         return -EINVAL;
  

• /* read the feature name */
  

• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

• if (err)
  

•         return err;
  

• feat_desc->name = elem_str.str;
  

• /* read the description string */
  

• err = cscfg_file_read_elem_str(buffer, buflen, &used, &elem_str);
  

• if (err)
  

•         return err;
  

• feat_desc->description = elem_str.str;
  

• /*
  

•  * read in some values
  

•  * [u32 value: match_flags]
  

•  * [u16 value: nr_regs]     - number of registers.
  

•  * [u16 value: nr_params]   - number of parameters.
  

•  */
  

• cscfg_extract_u32(feat_desc->match_flags);
  

• cscfg_extract_u16(feat_desc->nr_regs);
  

• cscfg_extract_u16(feat_desc->nr_params);
  

• /* register descriptors  - 32 bit + 64 bit value */
  

• if (feat_desc->nr_regs) {
  

•         nr_regs_bytes = ((sizeof(u32) + sizeof(u64)) * feat_desc->nr_regs);
  

•         if ((buflen - used) < nr_regs_bytes)
  

•                 return -EINVAL;
  

•         feat_desc->regs_desc = devm_kcalloc(cscfg_device(),
  

•                                             feat_desc->nr_regs,
  

•                                             sizeof(struct cscfg_regval_desc),
  

•                                             GFP_KERNEL);
  

•         if (!feat_desc->regs_desc)
  

•                 return -ENOMEM;
  

•         for (i = 0; i < feat_desc->nr_regs; i++) {
  

•                 cscfg_extract_u32(val32);
  

•                 p_reg_desc = (struct cscfg_regval_desc *)&feat_desc->regs_desc[i];
  

•                 CSCFG_FILE_U32_TO_REG_DESC_INFO(val32, p_reg_desc);
  

•                 cscfg_extract_u64(feat_desc->regs_desc[i].val64);
  

•         }
  

• }
  

• /* parameter descriptors - string + 64 bit value */
  

• if (feat_desc->nr_params) {
  

•         feat_desc->params_desc = devm_kcalloc(cscfg_device(),
  

•                                               feat_desc->nr_params,
  

•                                               sizeof(struct cscfg_parameter_desc),
  

•                                               GFP_KERNEL);
  

•         if (!feat_desc->params_desc)
  

•                 return -ENOMEM;
  

•         for (i = 0; i < feat_desc->nr_params; i++) {
  

•                 err = cscfg_file_read_elem_param(buffer, buflen, &used,
  

•                                                  &feat_desc->params_desc[i]);
  

•                 if (err)
  

•                         return err;
  

•         }
  

• }
  

• desc_arrays->feat_descs[feat_idx] = feat_desc;
  

• *buf_used = used;
  

• return 0;
  

+}

+/* just read the feature name - if there is a feature at this position */ +static int cscfg_file_read_elem_feat_name(const u8 *buffer, const int buflen, int *buf_used,

•                                   struct cscfg_file_elem_str *elem_str)
  

+{

• struct cscfg_file_elem_header elem_hdr;
  

• int used = *buf_used;
  

• int err;
  

• elem_str->str_len = 0;
  

• /*
  

•  * read the header - if not config, then don't update buf_used
  

•  * pointer on return
  

•  */
  

• err = cscfg_file_read_elem_hdr(buffer, buflen, &used, &elem_hdr);
  

• if (err)
  

•         return err;
  

• if (elem_hdr.elem_type != CSCFG_FILE_ELEM_TYPE_FEAT)
  

•         return -EINVAL;
  

• /* read the feature name */
  

• err = cscfg_file_read_elem_str(buffer, buflen, &used, elem_str);
  

• if (err)
  

•         return err;
  

• *buf_used = used;
  

• return 0;
  

+}

+/*

• • Read a buffer and create the configuration and feature
• • descriptors to load into the cscfg system
• */

+int cscfg_file_read_buffer(const u8 *buffer, const int buflen,

•                    struct cscfg_fs_load_descs *desc_arrays)
  

+{

• struct cscfg_file_header hdr;
  

• int used = 0, err, i;
  

• /* read in the file header */
  

• err = cscfg_file_read_hdr(buffer, buflen, &used, &hdr);
  

• if (err)
  

•         return err;
  

• /* allocate the memory for the descriptor pointer arrays */
  

• err = cscfg_file_alloc_desc_arrays(desc_arrays, hdr.nr_features);
  

• if (err)
  

•         return err;
  

• /* read elements */
  

• /* first element could be a config so check */
  

• err = cscfg_file_read_elem_config(buffer, buflen, &used, desc_arrays);
  

• if (err)
  

•         return err;
  

• /* now read and populate all the feature descriptors */
  

• for (i = 0; i < hdr.nr_features; i++) {
  

•         err = cscfg_file_read_elem_feature(buffer, buflen, &used, desc_arrays, i);
  

•         if (err)
  

•                 return err;
  

• }
  

• return used;
  

+}

+int cscfg_file_read_buffer_first_name(const u8 *buffer, const int buflen,

•                               const char **name)
  

+{

• struct cscfg_file_header hdr;
  

• struct cscfg_file_elem_str elem_str;
  

• int used = 0, err = 0;
  

• *name = NULL;
  

• /* read in the file header */
  

• err = cscfg_file_read_hdr(buffer, buflen, &used, &hdr);
  

• if (err)
  

•         return err;
  

• err = cscfg_file_read_elem_config_name(buffer, buflen, &used, &elem_str);
  

• if (err)
  

•         return err;
  

• /* no config string - get first feature name */
  

• if (!elem_str.str_len) {
  

•         err = cscfg_file_read_elem_feat_name(buffer, buflen, &used, &elem_str);
  

•         if (err)
  

•                 return err;
  

• }
  

• if (elem_str.str_len)
  

•         *name = elem_str.str;
  

• return err;
  

+} diff --git a/drivers/hwtracing/coresight/coresight-config-file.h b/drivers/hwtracing/coresight/coresight-config-file.h new file mode 100644 index 000000000000..591f4c2c4be9 --- /dev/null +++ b/drivers/hwtracing/coresight/coresight-config-file.h @@ -0,0 +1,117 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/*

• • Copyright (c) 2020 Linaro Limited, All rights reserved.
• • Author: Mike Leach mike.leach@linaro.org
• */

+#ifndef _CORESIGHT_CORESIGHT_CONFIG_FILE_H +#define _CORESIGHT_CORESIGHT_CONFIG_FILE_H

+/*

• • Structures to represent configuration descriptors in a memory buffer
• • to serialise to and from files
• • File structure - for loading a configuration + features
• • from configfs.
• • [cscfg_file_header] - mandatory
• • [CONFIG_ELEM] - optional - only one permitted,
• • [FEATURE_ELEM] * [cscfg_file_header.nr_features]

• •               - optional - file valid with config only.
    

• • Invalid file if no config or features.
• • File structure for [CONFIG_ELEM]:
• • [cscfg_file_elem_header] - header length value to end of feature strings.
• • [cscfg_file_elem_str] - name of the configuration
• • [cscfg_file_elem_str] - description of configuration
• • [u16 value - nr_presets]
• • [u32 value - nr_total_params]
• • [u16 value - nr_feat_refs]
• • [u64 values] * (nr_presets * nr_total_params)
• • [cscfg_file_elem_str] * nr_feat_refs
• • Only one configuration per file.
• • File structure for a [FEATURE_ELEM]
• • [cscfg_file_elem_header] - header length is total bytes to end of param structures.
• • [cscfg_file_elem_str] - feature name.
• • [cscfg_file_elem_str] - feature description.
• • [u32 value: match_flags]
• • [u16 value: nr_regs] - number of registers.
• • [u16 value: nr_params] - number of parameters.
• • [cscfg_regval_desc struct] * nr_regs
• • [PARAM_ELEM] * nr_params
• • File structure for [PARAM_ELEM]
• • [cscfg_file_elem_str] - parameter name.
• • [u64 value: param_value] - initial value.
• */

+/* major element types - configurations and features */

+#define CSCFG_FILE_ELEM_TYPE_FEAT 0x1 +#define CSCFG_FILE_ELEM_TYPE_CFG 0x2

+#define CSCFG_FILE_MAGIC_VERSION 0xC5CF0001

+#define CSCFG_FILE_U32_TO_REG_DESC_INFO(val32, p_desc) \

• { \
  

• p_desc->type = (val32 >> 24) & 0xFF; \
  

• p_desc->offset = (val32 >> 12) & 0xFFF; \
  

• p_desc->hw_info = val32 & 0xFFF; \
  

• }
  

+#define CSCFG_FILE_REG_DESC_INFO_TO_U32(val32, p_desc) \

• { \
  

• val32 = p_desc->hw_info & 0xFFF; \
  

• val32 |= ((p_desc->offset & 0xFFF) << 12); \
  

• val32 |= ((p_desc->type & 0xFF) << 24); \
  

• }
  

+/* binary attributes in configfs need a max size - declare a value for this. */ +#define CSCFG_FILE_MAXSIZE 16384

s/16384/SZ_16K

Also, please enhance the comment to explain the 16K limit.

...

+/* limit string sizes */ +#define CSCFG_FILE_STR_MAXSIZE 1024

s/1024/SZ_1K

Thanks, Mathieu

Done all the above.

Thanks

Mike

...

+/**

• • file header.
• • @magic_version: magic number / version for file/buffer format.
• • @length : total length of all data in the buffer.
• • @nr_features : total number of features in the buffer.
• */

+struct cscfg_file_header {

• u32 magic_version;
  

• u16 length;
  

• u16 nr_features;
  

+};

+/**

• • element header
• • @elem_length: total length of this element
• • @elem_type : type of this element - one of CSCFG_FILE_ELEM_TYPE.. defines.
• */

+struct cscfg_file_elem_header {

• u16 elem_length;
  

• u8 elem_type;
  

+};

+/**

• • string file element.
• • @str_len: length of string buffer including 0 terminator
• • @str : string buffer - 0 terminated.
• */

+struct cscfg_file_elem_str {

• u16 str_len;
  

• char *str;
  

+};

+#endif /* _CORESIGHT_CORESIGHT_CONFIG_FILE_H */ diff --git a/drivers/hwtracing/coresight/coresight-config.h b/drivers/hwtracing/coresight/coresight-config.h index 2e1670523461..9cd3c26ce023 100644 --- a/drivers/hwtracing/coresight/coresight-config.h +++ b/drivers/hwtracing/coresight/coresight-config.h @@ -85,6 +85,21 @@ struct cscfg_regval_desc { }; };

+/**

• • Dynamically loaded descriptor arrays loaded via configfs.
• • For builtin or module loaded configurations / features these are
• • statically defined at compile time. For configfs we create the arrays
• • dynamically so need a structure to handle this.
• • @config_descs: array of config descriptor pointers.
• • @feat_descs: array of feature descriptor pointers.
• */

+struct cscfg_fs_load_descs {

• struct cscfg_config_desc **config_descs;
  

• struct cscfg_feature_desc **feat_descs;
  

+};

/**

• Device feature descriptor - combination of registers and parameters to
• program a device to implement a specific complex function.

diff --git a/drivers/hwtracing/coresight/coresight-syscfg.h b/drivers/hwtracing/coresight/coresight-syscfg.h index 9106ffab4833..6a6e33585be9 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg.h +++ b/drivers/hwtracing/coresight/coresight-syscfg.h @@ -66,6 +66,7 @@ struct cscfg_registered_csdev { enum cscfg_load_owner_type { CSCFG_OWNER_PRELOAD, CSCFG_OWNER_MODULE,

• CSCFG_OWNER_CONFIGFS,
  

};

/**

2.17.1

-- Mike Leach Principal Engineer, ARM Ltd. Manchester Design Centre. UK

On Thu, Apr 14, 2022 at 07:44:54AM +0100, Mike Leach wrote:

Add in functionality and binary attribute to load configurations as binary data.

Reads the incoming attribute, which must be formatted correctly as defined in the file reader code - and will create a configuration and/or features and load them into the system.

These will then appear in configfs ready for use.

Unload functionality is also provided.

Signed-off-by: Mike Leach mike.leach@linaro.org

.../coresight/coresight-config-file.h | 9 ++ .../coresight/coresight-syscfg-configfs.c | 91 +++++++++++++++++++ .../hwtracing/coresight/coresight-syscfg.c | 37 ++++++++ .../hwtracing/coresight/coresight-syscfg.h | 1 + 4 files changed, 138 insertions(+)

diff --git a/drivers/hwtracing/coresight/coresight-config-file.h b/drivers/hwtracing/coresight/coresight-config-file.h index 591f4c2c4be9..f85cf1aabf56 100644 --- a/drivers/hwtracing/coresight/coresight-config-file.h +++ b/drivers/hwtracing/coresight/coresight-config-file.h @@ -7,6 +7,8 @@ #ifndef _CORESIGHT_CORESIGHT_CONFIG_FILE_H #define _CORESIGHT_CORESIGHT_CONFIG_FILE_H +#include "coresight-config.h"

/*

• Structures to represent configuration descriptors in a memory buffer
• to serialise to and from files

@@ -114,4 +116,11 @@ struct cscfg_file_elem_str { char *str; }; +/* kernel configfs needs to read the incoming file buffers to load. */ +int cscfg_file_read_buffer(const u8 *buffer, const int buflen,

• 	   struct cscfg_fs_load_descs *desc_arrays);
  

+/* to unload we just need the first name - config or first feature */ +int cscfg_file_read_buffer_first_name(const u8 *buffer, const int buflen,

• 		      const char **name);
  

#endif /* _CORESIGHT_CORESIGHT_CONFIG_FILE_H */ diff --git a/drivers/hwtracing/coresight/coresight-syscfg-configfs.c b/drivers/hwtracing/coresight/coresight-syscfg-configfs.c index 433ede94dd63..d1ddcba10ad8 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg-configfs.c +++ b/drivers/hwtracing/coresight/coresight-syscfg-configfs.c @@ -7,6 +7,7 @@ #include <linux/configfs.h> #include "coresight-config.h" +#include "coresight-config-file.h" #include "coresight-syscfg-configfs.h" /* create a default ci_type. */ @@ -380,10 +381,100 @@ static struct config_group *cscfg_create_feature_group(struct cscfg_feature_desc return &feat_view->group; } +/* Attributes in configfs that allow load and unload of configuration binary files */

+/* load "buffer" as a configuration binary file */ +static ssize_t cscfg_cfg_load_write(struct config_item *item, const void *buffer, size_t size) +{

• struct cscfg_fs_load_descs *load_descs = 0;
• struct cscfg_load_owner_info *owner_info = 0;
• int err = 0;
• if (size > CSCFG_FILE_MAXSIZE) {

• pr_err("cscfg: Load error - Input file too large.\n");
  

• return -EINVAL;
  

• }
• load_descs = kzalloc(sizeof(struct cscfg_fs_load_descs), GFP_KERNEL);
• owner_info = kzalloc(sizeof(struct cscfg_load_owner_info), GFP_KERNEL);
• if (!load_descs || !owner_info) {

• err = -ENOMEM;
  

• goto exit_memfree;
  

• }
• owner_info->owner_handle = load_descs;
• owner_info->type = CSCFG_OWNER_CONFIGFS;
• err = cscfg_file_read_buffer(buffer, size, load_descs);
• if (err) {

• pr_err("cscfg: Load error - Failed to read input file.\n");
  

• goto exit_memfree;
  

• }
• err = cscfg_load_config_sets(load_descs->config_descs, load_descs->feat_descs, owner_info);
• if (err) {

• pr_err("cscfg: Load error - Failed to load configuaration file.\n");
  

• goto exit_memfree;
  

• }
• return size;

+exit_memfree:

• kfree(load_descs);
• kfree(owner_info);
• return err;

+} +CONFIGFS_BIN_ATTR_WO(cscfg_cfg_, load, NULL, CSCFG_FILE_MAXSIZE);

+/* read "buffer" and unload configuration */ +static ssize_t cscfg_cfg_unload_write(struct config_item *item, const void *buffer, size_t size) +{

• struct cscfg_load_owner_info *owner_info = 0;
• const char *name;
• int err;
• if (size > CSCFG_FILE_MAXSIZE) {

• pr_err("cscfg: Unload error - Input file too large\n");
  

• return -EINVAL;
  

• }
• err = cscfg_file_read_buffer_first_name(buffer, size, &name);
• if (err) {

• pr_err("cscfg: Unload error - Failed to read input file\n");
  

• return err;
  

• }
• owner_info = cscfg_find_fs_owned_cfg_by_name(name);
• if (!owner_info) {

• pr_err("cscfg: Unload error: Failed to find configuration %s from input file\n",
  

•        name);
  

• return err;
  

Since cscfg_find_fs_owned_cfg_by_name() reads a configuration of feature name, I think the error message should be:

pr_err("cscfg: Unload error: Failed to find %s from input file\n", name);

• }
• err = cscfg_unload_config_sets(owner_info);
• if (err) {

• pr_err("cscfg: Unload error: Cannot unload configuration %s\n",
  

•        name);
  

• return err;
  

• }
• kfree(owner_info);
• kfree((struct cscfg_fs_load_descs *)(owner_info->owner_handle));

I think the internal memory for the arrays contained in the cscfg_fs_load_descs structure should be freed explicitly here, especially if they can be up to 16K.

More comments to come later or tomorrow.

Thanks, Mathieu

• return size;

+} +CONFIGFS_BIN_ATTR_WO(cscfg_cfg_, unload, NULL, CSCFG_FILE_MAXSIZE);

+static struct configfs_bin_attribute *cscfg_config_configfs_bin_attrs[] = {

• &cscfg_cfg_attr_load,
• &cscfg_cfg_attr_unload,
• NULL,

+};

static struct config_item_type cscfg_configs_type = { .ct_owner = THIS_MODULE,

• .ct_bin_attrs = cscfg_config_configfs_bin_attrs,

}; +/* group for configurations dir, with load and unload attribs */ static struct config_group cscfg_configs_grp = { .cg_item = { .ci_namebuf = "configurations", diff --git a/drivers/hwtracing/coresight/coresight-syscfg.c b/drivers/hwtracing/coresight/coresight-syscfg.c index 11850fd8c3b5..2e478b3e8c8d 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg.c +++ b/drivers/hwtracing/coresight/coresight-syscfg.c @@ -587,6 +587,43 @@ int cscfg_unload_config_sets(struct cscfg_load_owner_info *owner_info) } EXPORT_SYMBOL_GPL(cscfg_unload_config_sets); +/* find a configuration owned by configfs by name of config / first feature */ +struct cscfg_load_owner_info *cscfg_find_fs_owned_cfg_by_name(const char *name) +{

• struct cscfg_load_owner_info *owner_info = NULL;
• struct cscfg_fs_load_descs *fs_load_cfg;
• struct cscfg_config_desc *config_desc;
• struct cscfg_feature_desc *feat_desc;
• mutex_lock(&cscfg_mutex);
• /* search the load_owner list for CONFIGFS loaded types */
• list_for_each_entry(owner_info, &cscfg_mgr->load_order_list, item) {

• /* if this is a config fs owned item, then try to match */
  

• if (owner_info->type == CSCFG_OWNER_CONFIGFS) {
  

• 	fs_load_cfg = owner_info->owner_handle;
  

• 	/* first try to match the name against the config if it exists */
  

• 	if (fs_load_cfg->config_descs[0]) {
  

• 		config_desc = fs_load_cfg->config_descs[0];
  

• 		if (!strcmp(config_desc->name, name))
  

• 			goto exit_unlock;
  

• 	/* no config - match against first feature name */
  

• 	} else {
  

• 		feat_desc = fs_load_cfg->feat_descs[0];
  

• 		if (!strcmp(feat_desc->name, name))
  

• 			goto exit_unlock;
  

• 	}
  

• }
  

• }
• /* not found */
• owner_info = NULL;

+exit_unlock:

• mutex_unlock(&cscfg_mutex);
• return owner_info;

+}

/* Handle coresight device registration and add configs and features to devices */ /* iterate through config lists and load matching configs to device */ diff --git a/drivers/hwtracing/coresight/coresight-syscfg.h b/drivers/hwtracing/coresight/coresight-syscfg.h index 6a6e33585be9..487d872d931a 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg.h +++ b/drivers/hwtracing/coresight/coresight-syscfg.h @@ -95,6 +95,7 @@ int cscfg_update_feat_param_val(struct cscfg_feature_desc *feat_desc, int param_idx, u64 value); int cscfg_config_sysfs_activate(struct cscfg_config_desc *cfg_desc, bool activate); void cscfg_config_sysfs_set_preset(int preset); +struct cscfg_load_owner_info *cscfg_find_fs_owned_cfg_by_name(const char *name); /* syscfg manager external API */ int cscfg_load_config_sets(struct cscfg_config_desc **cfg_descs, -- 2.17.1

Hi,

previous comments re: freeing up memory actioned.

On Wed, 25 May 2022 at 20:30, Mathieu Poirier mathieu.poirier@linaro.org wrote:

On Thu, Apr 14, 2022 at 07:44:54AM +0100, Mike Leach wrote:

...

Add in functionality and binary attribute to load configurations as binary data.

Reads the incoming attribute, which must be formatted correctly as defined in the file reader code - and will create a configuration and/or features and load them into the system.

These will then appear in configfs ready for use.

Unload functionality is also provided.

Signed-off-by: Mike Leach mike.leach@linaro.org

.../coresight/coresight-config-file.h | 9 ++ .../coresight/coresight-syscfg-configfs.c | 91 +++++++++++++++++++ .../hwtracing/coresight/coresight-syscfg.c | 37 ++++++++ .../hwtracing/coresight/coresight-syscfg.h | 1 + 4 files changed, 138 insertions(+)

diff --git a/drivers/hwtracing/coresight/coresight-config-file.h b/drivers/hwtracing/coresight/coresight-config-file.h index 591f4c2c4be9..f85cf1aabf56 100644 --- a/drivers/hwtracing/coresight/coresight-config-file.h +++ b/drivers/hwtracing/coresight/coresight-config-file.h @@ -7,6 +7,8 @@ #ifndef _CORESIGHT_CORESIGHT_CONFIG_FILE_H #define _CORESIGHT_CORESIGHT_CONFIG_FILE_H

+#include "coresight-config.h"

/*

• Structures to represent configuration descriptors in a memory buffer
• to serialise to and from files

@@ -114,4 +116,11 @@ struct cscfg_file_elem_str { char *str; };

+/* kernel configfs needs to read the incoming file buffers to load. */ +int cscfg_file_read_buffer(const u8 *buffer, const int buflen,

•                    struct cscfg_fs_load_descs *desc_arrays);
  

+/* to unload we just need the first name - config or first feature */ +int cscfg_file_read_buffer_first_name(const u8 *buffer, const int buflen,

•                               const char **name);
  

#endif /* _CORESIGHT_CORESIGHT_CONFIG_FILE_H */ diff --git a/drivers/hwtracing/coresight/coresight-syscfg-configfs.c b/drivers/hwtracing/coresight/coresight-syscfg-configfs.c index 433ede94dd63..d1ddcba10ad8 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg-configfs.c +++ b/drivers/hwtracing/coresight/coresight-syscfg-configfs.c @@ -7,6 +7,7 @@ #include <linux/configfs.h>

#include "coresight-config.h" +#include "coresight-config-file.h" #include "coresight-syscfg-configfs.h"

/* create a default ci_type. */ @@ -380,10 +381,100 @@ static struct config_group *cscfg_create_feature_group(struct cscfg_feature_desc return &feat_view->group; }

+/* Attributes in configfs that allow load and unload of configuration binary files */

+/* load "buffer" as a configuration binary file */ +static ssize_t cscfg_cfg_load_write(struct config_item *item, const void *buffer, size_t size) +{

• struct cscfg_fs_load_descs *load_descs = 0;
  

• struct cscfg_load_owner_info *owner_info = 0;
  

• int err = 0;
  

• if (size > CSCFG_FILE_MAXSIZE) {
  

•         pr_err("cscfg: Load error - Input file too large.\n");
  

•         return -EINVAL;
  

• }
  

• load_descs = kzalloc(sizeof(struct cscfg_fs_load_descs), GFP_KERNEL);
  

• owner_info = kzalloc(sizeof(struct cscfg_load_owner_info), GFP_KERNEL);
  

• if (!load_descs || !owner_info) {
  

•         err = -ENOMEM;
  

•         goto exit_memfree;
  

• }
  

• owner_info->owner_handle = load_descs;
  

• owner_info->type = CSCFG_OWNER_CONFIGFS;
  

• err = cscfg_file_read_buffer(buffer, size, load_descs);
  

• if (err) {
  

•         pr_err("cscfg: Load error - Failed to read input file.\n");
  

•         goto exit_memfree;
  

• }
  

• err = cscfg_load_config_sets(load_descs->config_descs, load_descs->feat_descs, owner_info);
  

• if (err) {
  

•         pr_err("cscfg: Load error - Failed to load configuaration file.\n");
  

•         goto exit_memfree;
  

• }
  

• return size;
  

+exit_memfree:

• kfree(load_descs);
  

• kfree(owner_info);
  

• return err;
  

+} +CONFIGFS_BIN_ATTR_WO(cscfg_cfg_, load, NULL, CSCFG_FILE_MAXSIZE);

+/* read "buffer" and unload configuration */ +static ssize_t cscfg_cfg_unload_write(struct config_item *item, const void *buffer, size_t size) +{

• struct cscfg_load_owner_info *owner_info = 0;
  

• const char *name;
  

• int err;
  

• if (size > CSCFG_FILE_MAXSIZE) {
  

•         pr_err("cscfg: Unload error - Input file too large\n");
  

•         return -EINVAL;
  

• }
  

• err = cscfg_file_read_buffer_first_name(buffer, size, &name);
  

• if (err) {
  

•         pr_err("cscfg: Unload error - Failed to read input file\n");
  

•         return err;
  

• }
  

• owner_info = cscfg_find_fs_owned_cfg_by_name(name);
  

• if (!owner_info) {
  

•         pr_err("cscfg: Unload error: Failed to find configuration %s from input file\n",
  

•                name);
  

•         return err;
  

• }
  

• err = cscfg_unload_config_sets(owner_info);
  

• if (err) {
  

•         pr_err("cscfg: Unload error: Cannot unload configuration %s\n",
  

•                name);
  

•         return err;
  

• }
  

• kfree(owner_info);
  

• kfree((struct cscfg_fs_load_descs *)(owner_info->owner_handle));
  

• return size;
  

+} +CONFIGFS_BIN_ATTR_WO(cscfg_cfg_, unload, NULL, CSCFG_FILE_MAXSIZE);

+static struct configfs_bin_attribute *cscfg_config_configfs_bin_attrs[] = {

• &cscfg_cfg_attr_load,
  

• &cscfg_cfg_attr_unload,
  

• NULL,
  

+};

static struct config_item_type cscfg_configs_type = { .ct_owner = THIS_MODULE,

• .ct_bin_attrs = cscfg_config_configfs_bin_attrs,
  

I was thinking... Because it is possible to have a configuration file that only has features, wouldn't it make more sense to add the load and unload entries under cs-syscfg rather than cs-syscfg/configuration?

That is a possibility - though the docs refer to "configuration files" irrespective of what they actually contain, so I think having these in configurations is not too bad.

cs-syscfg is regarded as our subsystem root so treated slightly differently in terms of registration etc in the configfs API. We know we can hang groups (directories) off it, so presumably attributes (files) would be fine too.

Shouldn't be too difficult to try out, and I can easily back out if issues arise.

Thanks

Mike

...

};

+/* group for configurations dir, with load and unload attribs */ static struct config_group cscfg_configs_grp = { .cg_item = { .ci_namebuf = "configurations", diff --git a/drivers/hwtracing/coresight/coresight-syscfg.c b/drivers/hwtracing/coresight/coresight-syscfg.c index 11850fd8c3b5..2e478b3e8c8d 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg.c +++ b/drivers/hwtracing/coresight/coresight-syscfg.c @@ -587,6 +587,43 @@ int cscfg_unload_config_sets(struct cscfg_load_owner_info *owner_info) } EXPORT_SYMBOL_GPL(cscfg_unload_config_sets);

+/* find a configuration owned by configfs by name of config / first feature */ +struct cscfg_load_owner_info *cscfg_find_fs_owned_cfg_by_name(const char *name) +{

• struct cscfg_load_owner_info *owner_info = NULL;
  

• struct cscfg_fs_load_descs *fs_load_cfg;
  

• struct cscfg_config_desc *config_desc;
  

• struct cscfg_feature_desc *feat_desc;
  

• mutex_lock(&cscfg_mutex);
  

• /* search the load_owner list for CONFIGFS loaded types */
  

• list_for_each_entry(owner_info, &cscfg_mgr->load_order_list, item) {
  

•         /* if this is a config fs owned item, then try to match */
  

•         if (owner_info->type == CSCFG_OWNER_CONFIGFS) {
  

•                 fs_load_cfg = owner_info->owner_handle;
  

•                 /* first try to match the name against the config if it exists */
  

•                 if (fs_load_cfg->config_descs[0]) {
  

•                         config_desc = fs_load_cfg->config_descs[0];
  

•                         if (!strcmp(config_desc->name, name))
  

•                                 goto exit_unlock;
  

•                 /* no config - match against first feature name */
  

•                 } else {
  

•                         feat_desc = fs_load_cfg->feat_descs[0];
  

•                         if (!strcmp(feat_desc->name, name))
  

•                                 goto exit_unlock;
  

•                 }
  

•         }
  

• }
  

• /* not found */
  

• owner_info = NULL;
  

+exit_unlock:

• mutex_unlock(&cscfg_mutex);
  

• return owner_info;
  

+}

/* Handle coresight device registration and add configs and features to devices */

/* iterate through config lists and load matching configs to device */ diff --git a/drivers/hwtracing/coresight/coresight-syscfg.h b/drivers/hwtracing/coresight/coresight-syscfg.h index 6a6e33585be9..487d872d931a 100644 --- a/drivers/hwtracing/coresight/coresight-syscfg.h +++ b/drivers/hwtracing/coresight/coresight-syscfg.h @@ -95,6 +95,7 @@ int cscfg_update_feat_param_val(struct cscfg_feature_desc *feat_desc, int param_idx, u64 value); int cscfg_config_sysfs_activate(struct cscfg_config_desc *cfg_desc, bool activate); void cscfg_config_sysfs_set_preset(int preset); +struct cscfg_load_owner_info *cscfg_find_fs_owned_cfg_by_name(const char *name);

/* syscfg manager external API */ int cscfg_load_config_sets(struct cscfg_config_desc **cfg_descs, -- 2.17.1

-- Mike Leach Principal Engineer, ARM Ltd. Manchester Design Centre. UK

On Thu, Apr 14, 2022 at 07:44:55AM +0100, Mike Leach wrote:

Update coresight-config.h and the coresight-config-file.c & .h to allow use in userspace programs.

Use __KERNEL__ defines to filter out driver only structures and elements so that user space programs can use the descriptor structures.

Abstract memory allocation in coresight-config-file.c to allow read file functions to be run in userspace and kernel drivers.

Signed-off-by: Mike Leach mike.leach@linaro.org

.../coresight/coresight-config-file.c | 95 +++++++++++++------ .../hwtracing/coresight/coresight-config.h | 12 +++ 2 files changed, 80 insertions(+), 27 deletions(-)

diff --git a/drivers/hwtracing/coresight/coresight-config-file.c b/drivers/hwtracing/coresight/coresight-config-file.c index 3fd001938324..5b8f635ac50e 100644 --- a/drivers/hwtracing/coresight/coresight-config-file.c +++ b/drivers/hwtracing/coresight/coresight-config-file.c @@ -6,8 +6,57 @@ #include "coresight-config.h" #include "coresight-config-file.h"

+/*

• • To allow reuse of this source in tools, define memory allocation fns according
• • to build environment.
• */

+#ifdef __KERNEL__ #include "coresight-syscfg.h" +static void *cscfg_calloc(size_t num, size_t size) +{

• return devm_kcalloc(cscfg_device(), num, size, GFP_KERNEL);

+}

+static char *cscfg_strdup(const char *str) +{

• return devm_kstrdup(cscfg_device(), str, GFP_KERNEL);

+}

+static void *cscfg_zalloc(size_t size) +{

• return devm_kzalloc(cscfg_device(), size, GFP_KERNEL);

+}

+#else

+#include <stddef.h> +#include <string.h> +#include <stdlib.h>

+static void *cscfg_calloc(size_t num, size_t size) +{

• return calloc(num, size);

+}

+static char *cscfg_strdup(const char *str) +{

• return strdup(str);

+}

+static void *cscfg_zalloc(size_t size) +{

• void *ptr = malloc(size);
• if (ptr)

• memset(ptr, 0, size);
  

• return ptr;

+}

+#endif

#define cscfg_extract_u64(val64) { \ val64 = *(u64 *)(buffer + used); \ used += sizeof(u64); \ @@ -80,6 +129,7 @@ static int cscfg_file_read_elem_str(const u8 *buffer, const int buflen, int *buf struct cscfg_file_elem_str *elem_str) { int used = *buf_used;

• const u8 *str;

if ((buflen - used) < sizeof(u16)) return -EINVAL; @@ -89,11 +139,13 @@ static int cscfg_file_read_elem_str(const u8 *buffer, const int buflen, int *buf if ((buflen - used) < elem_str->str_len) return -EINVAL;

• str = buffer + used;
• /* check for 0 termination */

• if (buffer[elem_str->str_len - 1] != 0)

• if (str[elem_str->str_len - 1] != 0) return -EINVAL;

Now it makes sense.

• elem_str->str = devm_kstrdup(cscfg_device(), (char *)buffer, GFP_KERNEL);

• elem_str->str = cscfg_strdup((char *)str); used += elem_str->str_len;

*buf_used = used; @@ -104,14 +156,12 @@ static int cscfg_file_alloc_desc_arrays(struct cscfg_fs_load_descs *desc_arrays, int nr_features) { /* arrays are 0 terminated - max of 1 config & nr_features features */

• desc_arrays->config_descs = devm_kcalloc(cscfg_device(), 2,

• 				 sizeof(struct cscfg_config_desc *),
  

• 				 GFP_KERNEL);
  

• desc_arrays->config_descs = cscfg_calloc(2, sizeof(struct cscfg_config_desc *)); if (!desc_arrays->config_descs) return -ENOMEM;

• desc_arrays->feat_descs = devm_kcalloc(cscfg_device(), nr_features + 1,

• 			       sizeof(struct cscfg_feature_desc *),
  

• 			       GFP_KERNEL);
  

• desc_arrays->feat_descs = cscfg_calloc(nr_features + 1,

• 			       sizeof(struct cscfg_feature_desc *));
  

  if (!desc_arrays->feat_descs) return -ENOMEM; return 0;

@@ -138,8 +188,7 @@ static int cscfg_file_read_elem_config(const u8 *buffer, const int buflen, int * return 0; /* we have a config - allocate the descriptor */

• config_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_config_desc),

• 		   GFP_KERNEL);
  

• config_desc = cscfg_zalloc(sizeof(struct cscfg_config_desc)); if (!config_desc) return -ENOMEM;

@@ -165,8 +214,7 @@ static int cscfg_file_read_elem_config(const u8 *buffer, const int buflen, int * /* read the array of 64bit presets if present */ nr_preset_vals = config_desc->nr_total_params * config_desc->nr_presets; if (nr_preset_vals) {

• presets = devm_kcalloc(cscfg_device(), nr_preset_vals,
  

• 		       sizeof(u64), GFP_KERNEL);
  

• presets = cscfg_calloc(nr_preset_vals, sizeof(u64));
  

  if (!presets) return -ENOMEM;

@@ -181,10 +229,8 @@ static int cscfg_file_read_elem_config(const u8 *buffer, const int buflen, int * /* read the array of feature names referenced by the config */ if (config_desc->nr_feat_refs) {

• config_desc->feat_ref_names = devm_kcalloc(cscfg_device(),
  

• 					   config_desc->nr_feat_refs,
  

• 					   sizeof(char *),
  

• 					   GFP_KERNEL);
  

• config_desc->feat_ref_names = cscfg_calloc(config_desc->nr_feat_refs,
  

• 					   sizeof(char *));
  

  if (!config_desc->feat_ref_names) return -ENOMEM;

@@ -262,8 +308,7 @@ static int cscfg_file_read_elem_feature(const u8 *buffer, const int buflen, int u32 val32; /* allocate the feature descriptor object */

• feat_desc = devm_kzalloc(cscfg_device(), sizeof(struct cscfg_feature_desc),

• 		 GFP_KERNEL);
  

• feat_desc = cscfg_zalloc(sizeof(struct cscfg_feature_desc)); if (!feat_desc) return -ENOMEM;

@@ -302,10 +347,8 @@ static int cscfg_file_read_elem_feature(const u8 *buffer, const int buflen, int nr_regs_bytes = ((sizeof(u32) + sizeof(u64)) * feat_desc->nr_regs); if ((buflen - used) < nr_regs_bytes) return -EINVAL;

• feat_desc->regs_desc = devm_kcalloc(cscfg_device(),
  

• 				    feat_desc->nr_regs,
  

• 				    sizeof(struct cscfg_regval_desc),
  

• 				    GFP_KERNEL);
  

• feat_desc->regs_desc = cscfg_calloc(feat_desc->nr_regs,
  

• 				    sizeof(struct cscfg_regval_desc));
  

  if (!feat_desc->regs_desc) return -ENOMEM;

@@ -319,10 +362,8 @@ static int cscfg_file_read_elem_feature(const u8 *buffer, const int buflen, int /* parameter descriptors - string + 64 bit value */ if (feat_desc->nr_params) {

• feat_desc->params_desc = devm_kcalloc(cscfg_device(),
  

• 				      feat_desc->nr_params,
  

• 				      sizeof(struct cscfg_parameter_desc),
  

• 				      GFP_KERNEL);
  

• feat_desc->params_desc = cscfg_calloc(feat_desc->nr_params,
  

• 				      sizeof(struct cscfg_parameter_desc));
  

  if (!feat_desc->params_desc) return -ENOMEM; for (i = 0; i < feat_desc->nr_params; i++) {

@@ -399,7 +440,7 @@ int cscfg_file_read_buffer(const u8 *buffer, const int buflen, if (err) return err; }

• return used;

• return 0;

This belongs in patch 1.

} int cscfg_file_read_buffer_first_name(const u8 *buffer, const int buflen, diff --git a/drivers/hwtracing/coresight/coresight-config.h b/drivers/hwtracing/coresight/coresight-config.h index 9cd3c26ce023..fce74e2fbd0c 100644 --- a/drivers/hwtracing/coresight/coresight-config.h +++ b/drivers/hwtracing/coresight/coresight-config.h @@ -7,7 +7,14 @@ #ifndef _CORESIGHT_CORESIGHT_CONFIG_H #define _CORESIGHT_CORESIGHT_CONFIG_H +/*

• • Filter out kernel only portions of the file to allow user space programs
• • to use the descriptor definitions.
• */

+#ifdef __KERNEL__ #include <linux/coresight.h> +#endif

#include <linux/types.h> /* CoreSight Configuration Management - component and system wide configuration */ @@ -100,6 +107,10 @@ struct cscfg_fs_load_descs { struct cscfg_feature_desc **feat_descs; };

+/* remainder of header is used by the kernel drivers only */ +#ifdef __KERNEL__

/**

• Device feature descriptor - combination of registers and parameters to
• program a device to implement a specific complex function.

@@ -272,4 +283,5 @@ void cscfg_csdev_disable_config(struct cscfg_config_csdev *config_csdev); /* reset a feature to default values */ void cscfg_reset_feat(struct cscfg_feature_csdev *feat_csdev); +#endif /* __KERNEL__ */

#endif /* _CORESIGHT_CORESIGHT_CONFIG_H */

2.17.1

On Thu, Apr 14, 2022 at 07:44:56AM +0100, Mike Leach wrote:

Add an example file generator to test loading configurations via a binary attribute in configfs.

Provides a file buffer writer function that can be re-used in other userspace programs.

Buffer write format matches that expected by the corresponding reader in the configfs driver code.

Add a config file reader and printer. Takes in config files and prints the contents. Uses file reader source from kernel driver.

Signed-off-by: Mike Leach mike.leach@linaro.org

MAINTAINERS | 2 + .../coresight/coresight-config-file.c | 2 + tools/coresight/Makefile | 51 +++ tools/coresight/coresight-cfg-bufw.c | 303 ++++++++++++++++++ tools/coresight/coresight-cfg-bufw.h | 26 ++ tools/coresight/coresight-cfg-example1.c | 65 ++++ tools/coresight/coresight-cfg-examples.h | 27 ++ tools/coresight/coresight-cfg-file-read.c | 197 ++++++++++++ tools/coresight/coresight-cfg-filegen.c | 58 ++++ tools/include/uapi/coresight-config-uapi.h | 76 +++++ 10 files changed, 807 insertions(+) create mode 100644 tools/coresight/Makefile create mode 100644 tools/coresight/coresight-cfg-bufw.c create mode 100644 tools/coresight/coresight-cfg-bufw.h create mode 100644 tools/coresight/coresight-cfg-example1.c create mode 100644 tools/coresight/coresight-cfg-examples.h create mode 100644 tools/coresight/coresight-cfg-file-read.c create mode 100644 tools/coresight/coresight-cfg-filegen.c create mode 100644 tools/include/uapi/coresight-config-uapi.h

diff --git a/MAINTAINERS b/MAINTAINERS index 61d9f114c37f..4e59486e75b5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1985,6 +1985,8 @@ F: drivers/hwtracing/coresight/* F: include/dt-bindings/arm/coresight-cti-dt.h F: include/linux/coresight* F: samples/coresight/* +F: tools/coresight/* +F: tools/include/uapi/coresight-config-uapi.h F: tools/perf/arch/arm/util/auxtrace.c F: tools/perf/arch/arm/util/cs-etm.c F: tools/perf/arch/arm/util/cs-etm.h diff --git a/drivers/hwtracing/coresight/coresight-config-file.c b/drivers/hwtracing/coresight/coresight-config-file.c index 5b8f635ac50e..4a8b64405d84 100644 --- a/drivers/hwtracing/coresight/coresight-config-file.c +++ b/drivers/hwtracing/coresight/coresight-config-file.c @@ -36,6 +36,8 @@ static void *cscfg_zalloc(size_t size) #include <string.h> #include <stdlib.h> +#include "uapi/coresight-config-uapi.h"

static void *cscfg_calloc(size_t num, size_t size) { return calloc(num, size); diff --git a/tools/coresight/Makefile b/tools/coresight/Makefile new file mode 100644 index 000000000000..4004c315d65c --- /dev/null +++ b/tools/coresight/Makefile @@ -0,0 +1,51 @@ +# SPDX-License-Identifier: GPL-2.0-only +include ../scripts/Makefile.include +include ../scripts/Makefile.arch

+# Makefile to build the coresight configuration file reader and generator tools

+this-makefile := $(lastword $(MAKEFILE_LIST)) +tools-src := $(realpath $(dir $(this-makefile))) +srctree := $(realpath $(dir $(tools-src)/../../.))

+# ensure we use all as the default - skip anything in included Makefile +.DEFAULT_GOAL = all +# MAKECMDGOALS isn't set if there's no explicit goal in the +# command line, so set the default. +MAKECMDGOALS ?= $(.DEFAULT_GOAL)

+# compile flags +CFLAGS += $(CPPFLAGS) -c -Wall -DLINUX -Wno-switch -Wlogical-op -fPIC -I$(srctree)/drivers/hwtracing/coresight -I$(srctree)/tools/include/ -I$(srctree)/tools/include/uapi

+# object files +coresight-cfg-file-gen-objs := coresight-cfg-filegen.o coresight-cfg-bufw.o coresight-cfg-example1.o +coresight-cfg-file-read-objs := coresight-cfg-file-read.o coresight-config-file.o

+# debug variant +ifdef DEBUG +CFLAGS += -g -O0 -DDEBUG +else +CFLAGS += -O2 -DNDEBUG +endif

+.PHONY: all +all: coresight-cfg-file-gen coresight-cfg-file-read

+coresight-config-file.o: src_copy

• $(CC) $(CFLAGS) coresight-config-file.c -o coresight-config-file.o

+.PHONY: src_copy +src_copy:

• @cp $(srctree)/drivers/hwtracing/coresight/coresight-config-file.c $(srctree)/tools/coresight/.

+coresight-cfg-file-gen: $(coresight-cfg-file-gen-objs)

• $(CC) $(LDFLAGS) $(coresight-cfg-file-gen-objs) -o coresight-cfg-file-gen

+coresight-cfg-file-read: $(coresight-cfg-file-read-objs)

• $(CC) $(LDFLAGS) $(coresight-cfg-file-read-objs) -o coresight-cfg-file-read

+clean:

• rm -f coresight-cfg-file-gen coresight-cfg-file-read
• rm -f *.o
• rm -f coresight-config-file.c
• rm -f *.cscfg

diff --git a/tools/coresight/coresight-cfg-bufw.c b/tools/coresight/coresight-cfg-bufw.c new file mode 100644 index 000000000000..73223de2b7e0 --- /dev/null +++ b/tools/coresight/coresight-cfg-bufw.c @@ -0,0 +1,303 @@ +// SPDX-License-Identifier: GPL-2.0 +/*

• • Copyright (c) 2020 Linaro Limited, All rights reserved.
• • Author: Mike Leach mike.leach@linaro.org
• */

+#include <string.h>

+#include "coresight-cfg-bufw.h" +#include "uapi/coresight-config-uapi.h"

+/*

• • Set of macros to make writing the buffer code easier.
• *.
• • Uses naming convention as 'buffer' for the buffer pointer and
• • 'used' as the current bytes used by the encosing function.
• */

+#define cscfg_write_u64(val64) { \

• *(u64 *)(buffer + used) = val64; \
• used += sizeof(u64); \
• }

+#define cscfg_write_u32(val32) { \

• *(u32 *)(buffer + used) = val32; \
• used += sizeof(u32); \
• }

+#define cscfg_write_u16(val16) { \

• *(u16 *)(buffer + used) = val16; \
• used += sizeof(u16); \
• }

+#define cscfg_write_u8(val8) { \

• *(buffer + used) = val8; \
• used++; \
• }

+#define CHECK_WRET(rval) { \

• if (rval < 0) \

• return rval;	   \
  

• used += rval; \
• }