diff mbox series

[v4,13/21] remoterproc: qcom: refactor to leverage exported minidump symbol

Message ID 1687955688-20809-14-git-send-email-quic_mojha@quicinc.com
State New
Headers show
Series [v4,01/21] docs: qcom: Add qualcomm minidump guide | expand

Commit Message

Mukesh Ojha June 28, 2023, 12:34 p.m. UTC
There is no need remoteproc code(driver/remoteproc/qcom_common.c)
to know about minidump data structure layout instead it should
better use the minidump exported symbol to get the required
information.

Refactor the qcom_minidump() function and remove the minidump
related data structure from driver/remoteproc/qcom_common.c .

Signed-off-by: Mukesh Ojha <quic_mojha@quicinc.com>
---
 drivers/remoteproc/qcom_common.c | 142 +++++++--------------------------------
 1 file changed, 25 insertions(+), 117 deletions(-)

Comments

Mukesh Ojha June 29, 2023, 9:20 a.m. UTC | #1
On 6/28/2023 9:21 PM, Pavan Kondeti wrote:
> On Wed, Jun 28, 2023 at 06:04:40PM +0530, Mukesh Ojha wrote:
>> -static int qcom_add_minidump_segments(struct rproc *rproc, struct minidump_subsystem *subsystem,
>> -			void (*rproc_dumpfn_t)(struct rproc *rproc, struct rproc_dump_segment *segment,
>> -				void *dest, size_t offset, size_t size))
>> +void qcom_minidump(struct rproc *rproc, unsigned int minidump_id,
>> +		void (*rproc_dumpfn_t)(struct rproc *rproc,
>> +		struct rproc_dump_segment *segment, void *dest, size_t offset,
>> +		size_t size))
>>   {
>> -	struct minidump_region __iomem *ptr;
>> -	struct minidump_region region;
>> -	int seg_cnt, i;
>>   	dma_addr_t da;
>>   	size_t size;
>> +	int seg_cnt;
>>   	char *name;
>> +	void *ptr;
>> +	int ret;
>> +	int i;
>>   
>>   	if (WARN_ON(!list_empty(&rproc->dump_segments))) {
>>   		dev_err(&rproc->dev, "dump segment list already populated\n");
>> -		return -EUCLEAN;
>> +		return;
>>   	}
>>   
>> -	seg_cnt = le32_to_cpu(subsystem->region_count);
>> -	ptr = ioremap((unsigned long)le64_to_cpu(subsystem->regions_baseptr),
>> -		      seg_cnt * sizeof(struct minidump_region));
>> +	ptr = qcom_ss_md_mapped_base(minidump_id, &seg_cnt);
>>   	if (!ptr)
>> -		return -EFAULT;
>> +		return;
>>   
>>   	for (i = 0; i < seg_cnt; i++) {
>> -		memcpy_fromio(&region, ptr + i, sizeof(region));
>> -		if (le32_to_cpu(region.valid) == MINIDUMP_REGION_VALID) {
>> -			name = kstrndup(region.name, MAX_REGION_NAME_LENGTH - 1, GFP_KERNEL);
>> -			if (!name) {
>> -				iounmap(ptr);
>> -				return -ENOMEM;
>> -			}
>> -			da = le64_to_cpu(region.address);
>> -			size = le64_to_cpu(region.size);
>> -			rproc_coredump_add_custom_segment(rproc, da, size, rproc_dumpfn_t, name);
>> +		ret = qcom_ss_valid_segment_info(ptr, i, &name, &da, &size);
>> +		if (ret < 0) {
>> +			iounmap(ptr);
>> +			dev_err(&rproc->dev,
>> +				"Failed with error: %d while adding minidump entries\n",
>> +				ret);
>> +			goto clean_minidump;
>>   		}
>> -	}
>> -
>> -	iounmap(ptr);
>> -	return 0;
>> -}
>> -
>> -void qcom_minidump(struct rproc *rproc, unsigned int minidump_id,
>> -		void (*rproc_dumpfn_t)(struct rproc *rproc,
>> -		struct rproc_dump_segment *segment, void *dest, size_t offset,
>> -		size_t size))
>> -{
>> -	int ret;
>> -	struct minidump_subsystem *subsystem;
>> -	struct minidump_global_toc *toc;
>> -
>> -	/* Get Global minidump ToC*/
>> -	toc = qcom_smem_get(QCOM_SMEM_HOST_ANY, SBL_MINIDUMP_SMEM_ID, NULL);
>> -
>> -	/* check if global table pointer exists and init is set */
>> -	if (IS_ERR(toc) || !toc->status) {
>> -		dev_err(&rproc->dev, "Minidump TOC not found in SMEM\n");
>> -		return;
>> -	}
>>   
>> -	/* Get subsystem table of contents using the minidump id */
>> -	subsystem = &toc->subsystems[minidump_id];
>> -
>> -	/**
>> -	 * Collect minidump if SS ToC is valid and segment table
>> -	 * is initialized in memory and encryption status is set.
>> -	 */
>> -	if (subsystem->regions_baseptr == 0 ||
>> -	    le32_to_cpu(subsystem->status) != 1 ||
>> -	    le32_to_cpu(subsystem->enabled) != MINIDUMP_SS_ENABLED ||
>> -	    le32_to_cpu(subsystem->encryption_status) != MINIDUMP_SS_ENCR_DONE) {
>> -		dev_err(&rproc->dev, "Minidump not ready, skipping\n");
>> -		return;
>> +		/* if it is a valid segment */
>> +		if (!ret)
>> +			rproc_coredump_add_custom_segment(rproc, da, size,
>> +							  rproc_dumpfn_t, name);
>>   	}
>>   
>> -	ret = qcom_add_minidump_segments(rproc, subsystem, rproc_dumpfn_t);
>> -	if (ret) {
>> -		dev_err(&rproc->dev, "Failed with error: %d while adding minidump entries\n", ret);
>> -		goto clean_minidump;
>> -	}
>> +	iounmap(ptr);
>>   	rproc_coredump_using_sections(rproc);
>> +
>>   clean_minidump:
>>   	qcom_minidump_cleanup(rproc);
>>   }
> 
> I like the idea of moving minidump pieces to drivers/soc/qcom/*minidump*.
> 
> Is it possible to accept one function callback from remoteproc and do
> all of this in one function exported by minidump?
> 
> qcom_ss_valid_segment_info() seems a low level function to be exported..

It was ending up with circular dependency due to
rproc_coredump_add_custom_segment()


rproc_coredump => qcom_common => qcom_minidump_smem => rproc_coredump

-Mukesh

> 
> Thanks,
> Pavan
>
Pavan Kondeti June 30, 2023, 3:41 a.m. UTC | #2
On Thu, Jun 29, 2023 at 02:50:34PM +0530, Mukesh Ojha wrote:
> 
> 
> On 6/28/2023 9:21 PM, Pavan Kondeti wrote:
> > On Wed, Jun 28, 2023 at 06:04:40PM +0530, Mukesh Ojha wrote:
> > > -static int qcom_add_minidump_segments(struct rproc *rproc, struct minidump_subsystem *subsystem,
> > > -			void (*rproc_dumpfn_t)(struct rproc *rproc, struct rproc_dump_segment *segment,
> > > -				void *dest, size_t offset, size_t size))
> > > +void qcom_minidump(struct rproc *rproc, unsigned int minidump_id,
> > > +		void (*rproc_dumpfn_t)(struct rproc *rproc,
> > > +		struct rproc_dump_segment *segment, void *dest, size_t offset,
> > > +		size_t size))
> > >   {
> > > -	struct minidump_region __iomem *ptr;
> > > -	struct minidump_region region;
> > > -	int seg_cnt, i;
> > >   	dma_addr_t da;
> > >   	size_t size;
> > > +	int seg_cnt;
> > >   	char *name;
> > > +	void *ptr;
> > > +	int ret;
> > > +	int i;
> > >   	if (WARN_ON(!list_empty(&rproc->dump_segments))) {
> > >   		dev_err(&rproc->dev, "dump segment list already populated\n");
> > > -		return -EUCLEAN;
> > > +		return;
> > >   	}
> > > -	seg_cnt = le32_to_cpu(subsystem->region_count);
> > > -	ptr = ioremap((unsigned long)le64_to_cpu(subsystem->regions_baseptr),
> > > -		      seg_cnt * sizeof(struct minidump_region));
> > > +	ptr = qcom_ss_md_mapped_base(minidump_id, &seg_cnt);
> > >   	if (!ptr)
> > > -		return -EFAULT;
> > > +		return;
> > >   	for (i = 0; i < seg_cnt; i++) {
> > > -		memcpy_fromio(&region, ptr + i, sizeof(region));
> > > -		if (le32_to_cpu(region.valid) == MINIDUMP_REGION_VALID) {
> > > -			name = kstrndup(region.name, MAX_REGION_NAME_LENGTH - 1, GFP_KERNEL);
> > > -			if (!name) {
> > > -				iounmap(ptr);
> > > -				return -ENOMEM;
> > > -			}
> > > -			da = le64_to_cpu(region.address);
> > > -			size = le64_to_cpu(region.size);
> > > -			rproc_coredump_add_custom_segment(rproc, da, size, rproc_dumpfn_t, name);
> > > +		ret = qcom_ss_valid_segment_info(ptr, i, &name, &da, &size);
> > > +		if (ret < 0) {
> > > +			iounmap(ptr);
> > > +			dev_err(&rproc->dev,
> > > +				"Failed with error: %d while adding minidump entries\n",
> > > +				ret);
> > > +			goto clean_minidump;
> > >   		}
> > > -	}
> > > -
> > > -	iounmap(ptr);
> > > -	return 0;
> > > -}
> > > -
> > > -void qcom_minidump(struct rproc *rproc, unsigned int minidump_id,
> > > -		void (*rproc_dumpfn_t)(struct rproc *rproc,
> > > -		struct rproc_dump_segment *segment, void *dest, size_t offset,
> > > -		size_t size))
> > > -{
> > > -	int ret;
> > > -	struct minidump_subsystem *subsystem;
> > > -	struct minidump_global_toc *toc;
> > > -
> > > -	/* Get Global minidump ToC*/
> > > -	toc = qcom_smem_get(QCOM_SMEM_HOST_ANY, SBL_MINIDUMP_SMEM_ID, NULL);
> > > -
> > > -	/* check if global table pointer exists and init is set */
> > > -	if (IS_ERR(toc) || !toc->status) {
> > > -		dev_err(&rproc->dev, "Minidump TOC not found in SMEM\n");
> > > -		return;
> > > -	}
> > > -	/* Get subsystem table of contents using the minidump id */
> > > -	subsystem = &toc->subsystems[minidump_id];
> > > -
> > > -	/**
> > > -	 * Collect minidump if SS ToC is valid and segment table
> > > -	 * is initialized in memory and encryption status is set.
> > > -	 */
> > > -	if (subsystem->regions_baseptr == 0 ||
> > > -	    le32_to_cpu(subsystem->status) != 1 ||
> > > -	    le32_to_cpu(subsystem->enabled) != MINIDUMP_SS_ENABLED ||
> > > -	    le32_to_cpu(subsystem->encryption_status) != MINIDUMP_SS_ENCR_DONE) {
> > > -		dev_err(&rproc->dev, "Minidump not ready, skipping\n");
> > > -		return;
> > > +		/* if it is a valid segment */
> > > +		if (!ret)
> > > +			rproc_coredump_add_custom_segment(rproc, da, size,
> > > +							  rproc_dumpfn_t, name);
> > >   	}
> > > -	ret = qcom_add_minidump_segments(rproc, subsystem, rproc_dumpfn_t);
> > > -	if (ret) {
> > > -		dev_err(&rproc->dev, "Failed with error: %d while adding minidump entries\n", ret);
> > > -		goto clean_minidump;
> > > -	}
> > > +	iounmap(ptr);
> > >   	rproc_coredump_using_sections(rproc);
> > > +
> > >   clean_minidump:
> > >   	qcom_minidump_cleanup(rproc);
> > >   }
> > 
> > I like the idea of moving minidump pieces to drivers/soc/qcom/*minidump*.
> > 
> > Is it possible to accept one function callback from remoteproc and do
> > all of this in one function exported by minidump?
> > 
> > qcom_ss_valid_segment_info() seems a low level function to be exported..
> 
> It was ending up with circular dependency due to
> rproc_coredump_add_custom_segment()
> 
> 
> rproc_coredump => qcom_common => qcom_minidump_smem => rproc_coredump
> 

Where is the circular dependency here? Any API accepting callback would
end up like below

caller -> API(callback) -> (*callback) -> [in caller code ...]

May be I am missing something here.

AFAICS, the minidump could do everything except it does not know how to
create a segment and add it to rproc::dump_segments list. Is it not
possible to write a minidump API that accepts a callback and a list
head? we may not probably re-use rproc_coredump_add_custom_segment() as
is, but some refactoring allows/covers both cases..Pls give it a
thought.

This way we don't need to create an internal API like below

int qcom_ss_valid_segment_info(void *ptr, int i, char **name, dma_addr_t
*da, size_t *size)

Thanks,
Pavan
diff mbox series

Patch

diff --git a/drivers/remoteproc/qcom_common.c b/drivers/remoteproc/qcom_common.c
index 805e525df3b5..24e8b692cd2c 100644
--- a/drivers/remoteproc/qcom_common.c
+++ b/drivers/remoteproc/qcom_common.c
@@ -18,6 +18,7 @@ 
 #include <linux/slab.h>
 #include <linux/soc/qcom/mdt_loader.h>
 #include <linux/soc/qcom/smem.h>
+#include <soc/qcom/qcom_minidump.h>
 
 #include "remoteproc_internal.h"
 #include "qcom_common.h"
@@ -26,61 +27,6 @@ 
 #define to_smd_subdev(d) container_of(d, struct qcom_rproc_subdev, subdev)
 #define to_ssr_subdev(d) container_of(d, struct qcom_rproc_ssr, subdev)
 
-#define MAX_NUM_OF_SS           10
-#define MAX_REGION_NAME_LENGTH  16
-#define SBL_MINIDUMP_SMEM_ID	602
-#define MINIDUMP_REGION_VALID		('V' << 24 | 'A' << 16 | 'L' << 8 | 'I' << 0)
-#define MINIDUMP_SS_ENCR_DONE		('D' << 24 | 'O' << 16 | 'N' << 8 | 'E' << 0)
-#define MINIDUMP_SS_ENABLED		('E' << 24 | 'N' << 16 | 'B' << 8 | 'L' << 0)
-
-/**
- * struct minidump_region - Minidump region
- * @name		: Name of the region to be dumped
- * @seq_num:		: Use to differentiate regions with same name.
- * @valid		: This entry to be dumped (if set to 1)
- * @address		: Physical address of region to be dumped
- * @size		: Size of the region
- */
-struct minidump_region {
-	char	name[MAX_REGION_NAME_LENGTH];
-	__le32	seq_num;
-	__le32	valid;
-	__le64	address;
-	__le64	size;
-};
-
-/**
- * struct minidump_subsystem - Subsystem's SMEM Table of content
- * @status : Subsystem toc init status
- * @enabled : if set to 1, this region would be copied during coredump
- * @encryption_status: Encryption status for this subsystem
- * @encryption_required : Decides to encrypt the subsystem regions or not
- * @region_count : Number of regions added in this subsystem toc
- * @regions_baseptr : regions base pointer of the subsystem
- */
-struct minidump_subsystem {
-	__le32	status;
-	__le32	enabled;
-	__le32	encryption_status;
-	__le32	encryption_required;
-	__le32	region_count;
-	__le64	regions_baseptr;
-};
-
-/**
- * struct minidump_global_toc - Global Table of Content
- * @status : Global Minidump init status
- * @md_revision : Minidump revision
- * @enabled : Minidump enable status
- * @subsystems : Array of subsystems toc
- */
-struct minidump_global_toc {
-	__le32				status;
-	__le32				md_revision;
-	__le32				enabled;
-	struct minidump_subsystem	subsystems[MAX_NUM_OF_SS];
-};
-
 struct qcom_ssr_subsystem {
 	const char *name;
 	struct srcu_notifier_head notifier_list;
@@ -101,85 +47,47 @@  static void qcom_minidump_cleanup(struct rproc *rproc)
 	}
 }
 
-static int qcom_add_minidump_segments(struct rproc *rproc, struct minidump_subsystem *subsystem,
-			void (*rproc_dumpfn_t)(struct rproc *rproc, struct rproc_dump_segment *segment,
-				void *dest, size_t offset, size_t size))
+void qcom_minidump(struct rproc *rproc, unsigned int minidump_id,
+		void (*rproc_dumpfn_t)(struct rproc *rproc,
+		struct rproc_dump_segment *segment, void *dest, size_t offset,
+		size_t size))
 {
-	struct minidump_region __iomem *ptr;
-	struct minidump_region region;
-	int seg_cnt, i;
 	dma_addr_t da;
 	size_t size;
+	int seg_cnt;
 	char *name;
+	void *ptr;
+	int ret;
+	int i;
 
 	if (WARN_ON(!list_empty(&rproc->dump_segments))) {
 		dev_err(&rproc->dev, "dump segment list already populated\n");
-		return -EUCLEAN;
+		return;
 	}
 
-	seg_cnt = le32_to_cpu(subsystem->region_count);
-	ptr = ioremap((unsigned long)le64_to_cpu(subsystem->regions_baseptr),
-		      seg_cnt * sizeof(struct minidump_region));
+	ptr = qcom_ss_md_mapped_base(minidump_id, &seg_cnt);
 	if (!ptr)
-		return -EFAULT;
+		return;
 
 	for (i = 0; i < seg_cnt; i++) {
-		memcpy_fromio(&region, ptr + i, sizeof(region));
-		if (le32_to_cpu(region.valid) == MINIDUMP_REGION_VALID) {
-			name = kstrndup(region.name, MAX_REGION_NAME_LENGTH - 1, GFP_KERNEL);
-			if (!name) {
-				iounmap(ptr);
-				return -ENOMEM;
-			}
-			da = le64_to_cpu(region.address);
-			size = le64_to_cpu(region.size);
-			rproc_coredump_add_custom_segment(rproc, da, size, rproc_dumpfn_t, name);
+		ret = qcom_ss_valid_segment_info(ptr, i, &name, &da, &size);
+		if (ret < 0) {
+			iounmap(ptr);
+			dev_err(&rproc->dev,
+				"Failed with error: %d while adding minidump entries\n",
+				ret);
+			goto clean_minidump;
 		}
-	}
-
-	iounmap(ptr);
-	return 0;
-}
-
-void qcom_minidump(struct rproc *rproc, unsigned int minidump_id,
-		void (*rproc_dumpfn_t)(struct rproc *rproc,
-		struct rproc_dump_segment *segment, void *dest, size_t offset,
-		size_t size))
-{
-	int ret;
-	struct minidump_subsystem *subsystem;
-	struct minidump_global_toc *toc;
-
-	/* Get Global minidump ToC*/
-	toc = qcom_smem_get(QCOM_SMEM_HOST_ANY, SBL_MINIDUMP_SMEM_ID, NULL);
-
-	/* check if global table pointer exists and init is set */
-	if (IS_ERR(toc) || !toc->status) {
-		dev_err(&rproc->dev, "Minidump TOC not found in SMEM\n");
-		return;
-	}
 
-	/* Get subsystem table of contents using the minidump id */
-	subsystem = &toc->subsystems[minidump_id];
-
-	/**
-	 * Collect minidump if SS ToC is valid and segment table
-	 * is initialized in memory and encryption status is set.
-	 */
-	if (subsystem->regions_baseptr == 0 ||
-	    le32_to_cpu(subsystem->status) != 1 ||
-	    le32_to_cpu(subsystem->enabled) != MINIDUMP_SS_ENABLED ||
-	    le32_to_cpu(subsystem->encryption_status) != MINIDUMP_SS_ENCR_DONE) {
-		dev_err(&rproc->dev, "Minidump not ready, skipping\n");
-		return;
+		/* if it is a valid segment */
+		if (!ret)
+			rproc_coredump_add_custom_segment(rproc, da, size,
+							  rproc_dumpfn_t, name);
 	}
 
-	ret = qcom_add_minidump_segments(rproc, subsystem, rproc_dumpfn_t);
-	if (ret) {
-		dev_err(&rproc->dev, "Failed with error: %d while adding minidump entries\n", ret);
-		goto clean_minidump;
-	}
+	iounmap(ptr);
 	rproc_coredump_using_sections(rproc);
+
 clean_minidump:
 	qcom_minidump_cleanup(rproc);
 }