net: wwan: t7xx: fw flashing & coredump support

From: Haijun Liu <[email protected]>

The t7xx device contains two Cross Layer DMA (CLDMA) interfaces to communicate with AP and Modem processors respectively. So far only MD-CLDMA was being used, this patch enables AP-CLDMA.

Rename small Application Processor (sAP) to AP.

Signed-off-by Haijun Liu <[email protected]>

Co-developed-by Madhusmita Sahu <[email protected]>

Signed-off-by Madhusmita Sahu <[email protected]>

Signed-off-by Moises Veleta <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

Signed-off-by M Chetan Kumar <[email protected]>

Reviewed-by Ilpo Järvinen <[email protected]>

Reviewed-by Sergey Ryazanov <[email protected]>

--
v3:
* No Change.
v2:
* Reuse handshake_wq for AP work.
* Remove AP trace port tx/rx channel id.
* Rename t7xx_md_port_conf to t7xx_port_conf.

From: M Chetan Kumar <[email protected]>

To support cases such as FW update or Core dump, the t7xx device is capable of signaling the host that a special port needs to be created before the handshake phase.

This patch adds the infrastructure required to create the early ports which also requires a different configuration of CLDMA queues.

Signed-off-by Haijun Liu <[email protected]>

Co-developed-by Madhusmita Sahu <[email protected]>

Signed-off-by Madhusmita Sahu <[email protected]>

Signed-off-by Ricardo Martinez <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

Signed-off-by M Chetan Kumar <[email protected]>

--
v3:
* No Change.
v2:
* Move recv_skb handler to cldma_queue.
* Drop cldma_queue_type.
* Restore prototype of t7xx_port_send_raw_skb().
* Remove PORT_CFG_ID_INVALID check in t7xx_port_proxy_set_cfg().
* Add space before */.
* Drop unnecessary logs.
* Use WARN_ON on early port.
* Use new MISC_DEV_STATUS_INVALID instead of MISC_DEV_STATUS.
* Use macros instead of const identifiers.
* Change ports member type from pointer to array type.
* Prefix LK_EVENT_XX with MISC prefix.
* Use t7xx prefix for device_stage enums.
* Correct log messages.
* Don’t override pkt_size for non-download port under dedicated Queue.
* Drop cldma_txq_rxq_ids.
* Use macro for txq/rxq index.
* Use warn_on for rxq_idx comparison.
* Drop t7xx_port_proxy_get_port_by_name().
* Replace fsm poll with read_poll_timeout().
* Use "\n" consistently across log message.
* Remove local var _dev prefixes in fsm_routine_start().
* Use max_t.

drivers/net/wwan/t7xx/t7xx_reg.h +0 -0

index c41d7d094c08..44352cd02460 100644

drivers/net/wwan/t7xx/t7xx_reg.h +18 -0

+#define MISC_LK_EVENT_MASK			GENMASK(11, 8)
+
+enum lk_event_id {
+	LK_EVENT_NORMAL = 0,
+	LK_EVENT_CREATE_PD_PORT = 1,
+	LK_EVENT_CREATE_POST_DL_PORT = 2,
+	LK_EVENT_RESET = 7,
+};
+
+#define MISC_STAGE_MASK				GENMASK(2, 0)
+
+enum t7xx_device_stage {
+	T7XX_DEV_STAGE_INIT = 0,
+	T7XX_DEV_STAGE_BROM_PRE = 1,
+	T7XX_DEV_STAGE_BROM_POST = 2,
+	T7XX_DEV_STAGE_LK = 3,
+	T7XX_DEV_STAGE_LINUX = 4,
+};
 
  #define T7XX_PCIE_RESOURCE_STATUS		0x0d28
  #define T7XX_PCIE_RESOURCE_STS_MSK		GENMASK(4, 0)

drivers/net/wwan/t7xx/t7xx_state_monitor.c +38 -6

index 80edb8e75a6a..76fb5d57d4d7 100644
@@ -206,6 +206,34 @@ static void fsm_routine_exception(struct t7xx_fsm_ctl *ctl, struct t7xx_fsm_comm
  		fsm_finish_command(ctl, cmd, 0);
  }
 
+static void t7xx_lk_stage_event_handling(struct t7xx_fsm_ctl *ctl, unsigned int status)
+{
+	struct t7xx_modem *md = ctl->md;
+	struct cldma_ctrl *md_ctrl;
+	enum lk_event_id lk_event;
+	struct device *dev;
+
+	dev = &md->t7xx_dev->pdev->dev;
+	lk_event = FIELD_GET(MISC_LK_EVENT_MASK, status);
+	switch (lk_event) {
+	case LK_EVENT_NORMAL:
+	case LK_EVENT_RESET:
+		break;
+
+	case LK_EVENT_CREATE_PD_PORT:
+		md_ctrl = md->md_ctrl[CLDMA_ID_AP];
+		t7xx_cldma_hif_hw_init(md_ctrl);
+		t7xx_cldma_stop(md_ctrl);
+		t7xx_cldma_switch_cfg(md_ctrl, CLDMA_DEDICATED_Q_CFG);
+		t7xx_cldma_start(md_ctrl);
+		break;
+
+	default:
+		dev_err(dev, "Invalid LK event %d\n", lk_event);
+		break;
+	}
+}
+
  static int fsm_stopped_handler(struct t7xx_fsm_ctl *ctl)
  {
  	ctl->curr_state = FSM_STATE_STOPPED;

@@ -317,8 +345,9 @@ static int fsm_routine_starting(struct t7xx_fsm_ctl *ctl)
  static void fsm_routine_start(struct t7xx_fsm_ctl *ctl, struct t7xx_fsm_command *cmd)
  {
  	struct t7xx_modem *md = ctl->md;
-	u32 dev_status;
-	int ret;
+	struct device *dev;
+	u32 status, stage;
+	int ret = 0;
 
  	if (!md)
  		return;

@@ -329,23 +358,55 @@ static void fsm_routine_start(struct t7xx_fsm_ctl *ctl, struct t7xx_fsm_command
  		return;
  	}
 
+	dev = &md->t7xx_dev->pdev->dev;
  	ctl->curr_state = FSM_STATE_PRE_START;
  	t7xx_md_event_notify(md, FSM_PRE_START);
 
-	ret = read_poll_timeout(ioread32, dev_status,
-				(dev_status & MISC_STAGE_MASK) == LINUX_STAGE, 20000, 2000000,
-				false, IREG_BASE(md->t7xx_dev) + T7XX_PCIE_MISC_DEV_STATUS);
+	ret = read_poll_timeout(ioread32, status,
+				((status & MISC_STAGE_MASK) == T7XX_DEV_STAGE_LINUX) ||
+				((status & MISC_STAGE_MASK) == T7XX_DEV_STAGE_LK), 100000,
+				20000000, false, IREG_BASE(md->t7xx_dev) +
+				T7XX_PCIE_MISC_DEV_STATUS);
+
  	if (ret) {
-		struct device *dev = &md->t7xx_dev->pdev->dev;

drivers/net/wwan/t7xx/t7xx_state_monitor.c +30 -3

+		switch (stage) {
+		case T7XX_DEV_STAGE_INIT:
+		case T7XX_DEV_STAGE_BROM_PRE:
+		case T7XX_DEV_STAGE_BROM_POST:
+			dev_info(dev, "BROM_STAGE Entered\n");
+			ret = t7xx_fsm_append_cmd(ctl, FSM_CMD_START, 0);
+			break;
+
+		case T7XX_DEV_STAGE_LK:
+			dev_info(dev, "LK_STAGE Entered\n");
+			t7xx_lk_stage_event_handling(ctl, status);
+			break;
+
+		case T7XX_DEV_STAGE_LINUX:
+			dev_info(dev, "LINUX_STAGE Entered\n");
+			t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_AP]);
+			t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_MD]);
+			t7xx_mhccif_mask_clr(md->t7xx_dev, D2H_INT_PORT_ENUM |
+					     D2H_INT_ASYNC_MD_HK | D2H_INT_ASYNC_AP_HK);
+			t7xx_port_proxy_set_cfg(md, PORT_CFG_ID_NORMAL);
+			ret = fsm_routine_starting(ctl);
+			break;
+
+		default:
+			break;
+		}
+		ctl->prev_status = status;
  	}
 
-	t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_AP]);
-	t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_MD]);
-	fsm_finish_command(ctl, cmd, fsm_routine_starting(ctl));
+finish_command:
+	fsm_finish_command(ctl, cmd, ret);
  }
 
  static int fsm_main_thread(void *data)

@@ -516,6 +577,7 @@ void t7xx_fsm_reset(struct t7xx_modem *md)
  	fsm_flush_event_cmd_qs(ctl);
  	ctl->curr_state = FSM_STATE_STOPPED;
  	ctl->exp_flg = false;
+	ctl->prev_status = 0;
  }
 
  int t7xx_fsm_init(struct t7xx_modem *md)

drivers/net/wwan/t7xx/t7xx_state_monitor.h +1 -0

index b6e76f3903c8..5e8012567ba1 100644
@@ -96,6 +96,7 @@ struct t7xx_fsm_ctl {
  	bool			exp_flg;
  	spinlock_t		notifier_lock;		/* Protects notifier list */
  	struct list_head	notifier_list;
+	u32                     prev_status;
  };
 
  struct t7xx_fsm_event {

Quoted 6 lines · On 1/6/2023 8:26 AM, [email protected] wrote:

From: M Chetan Kumar <[email protected]>

To support cases such as FW update or Core dump, the t7xx device is capable of signaling the host that a special port needs to be created before the handshake phase.

Quoted 3 lines

This patch adds the infrastructure required to create the early ports which also requires a different configuration of CLDMA queues.

nit: use imperative voice in your commit messages: no "this patch". instead:
"Add the infrastructure..."

Quoted 34 lines

Signed-off-by Haijun Liu <[email protected]>

Co-developed-by Madhusmita Sahu <[email protected]>

Signed-off-by Madhusmita Sahu <[email protected]>

Signed-off-by Ricardo Martinez <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

Signed-off-by M Chetan Kumar <[email protected]>

Signature · 25 lines

v3:
  * No Change.
v2:
  * Move recv_skb handler to cldma_queue.
  * Drop cldma_queue_type.
  * Restore prototype of t7xx_port_send_raw_skb().
  * Remove PORT_CFG_ID_INVALID check in t7xx_port_proxy_set_cfg().
  * Add space before */.
  * Drop unnecessary logs.
  * Use WARN_ON on early port.
  * Use new MISC_DEV_STATUS_INVALID instead of MISC_DEV_STATUS.
  * Use macros instead of const identifiers.
  * Change ports member type from pointer to array type.
  * Prefix LK_EVENT_XX with MISC prefix.
  * Use t7xx prefix for device_stage enums.
  * Correct log messages.
  * Don’t override pkt_size for non-download port under dedicated Queue.
  * Drop cldma_txq_rxq_ids.
  * Use macro for txq/rxq index.
  * Use warn_on for rxq_idx comparison.
  * Drop t7xx_port_proxy_get_port_by_name().
  * Replace fsm poll with read_poll_timeout().
  * Use "\n" consistently across log message.
  * Remove local var _dev prefixes in fsm_routine_start().
  * Use max_t.

...

Quoted 5 lines

drivers/net/wwan/t7xx/t7xx_reg.h +0 -0

index c41d7d094c08..44352cd02460 100644

drivers/net/wwan/t7xx/t7xx_reg.h enum t7xx_pm_resume_state { · line 107

Quoted 9 lines

drivers/net/wwan/t7xx/t7xx_reg.h +3 -3

@@ -102,10 +102,28 @@ enum t7xx_pm_resume_state {
   };
   #define T7XX_PCIE_MISC_DEV_STATUS        0x0d1c
-#define MISC_STAGE_MASK                GENMASK(2, 0)
-#define MISC_RESET_TYPE_PLDR            BIT(26)
   #define MISC_RESET_TYPE_FLDR            BIT(27)
-#define LINUX_STAGE                4
+#define MISC_RESET_TYPE_PLDR            BIT(26)
+#define MISC_DEV_STATUS_MASK            GENMASK(15, 0)
+#define MISC_DEV_STATUS_INVALID            GENMASK(15, 0)

I don't see any uses of this, even though it's mentioned in the commit message. The only reason I looked was because it was weird to have DEV_STATUS_MASK and STATUS_INVALID be the same values, is that correct?

Quoted 99 lines

drivers/net/wwan/t7xx/t7xx_reg.h +18 -0

+#define MISC_LK_EVENT_MASK            GENMASK(11, 8)
+
+enum lk_event_id {
+    LK_EVENT_NORMAL = 0,
+    LK_EVENT_CREATE_PD_PORT = 1,
+    LK_EVENT_CREATE_POST_DL_PORT = 2,
+    LK_EVENT_RESET = 7,
+};
+
+#define MISC_STAGE_MASK                GENMASK(2, 0)
+
+enum t7xx_device_stage {
+    T7XX_DEV_STAGE_INIT = 0,
+    T7XX_DEV_STAGE_BROM_PRE = 1,
+    T7XX_DEV_STAGE_BROM_POST = 2,
+    T7XX_DEV_STAGE_LK = 3,
+    T7XX_DEV_STAGE_LINUX = 4,
+};
   #define T7XX_PCIE_RESOURCE_STATUS        0x0d28
   #define T7XX_PCIE_RESOURCE_STS_MSK        GENMASK(4, 0)

drivers/net/wwan/t7xx/t7xx_state_monitor.c +0 -0

index 80edb8e75a6a..76fb5d57d4d7 100644
@@ -206,6 +206,34 @@ static void fsm_routine_exception(struct 

t7xx_fsm_ctl *ctl, struct t7xx_fsm_comm fsm_finish_command(ctl, cmd, 0);
  }
+static void t7xx_lk_stage_event_handling(struct t7xx_fsm_ctl *ctl, unsigned int status)

drivers/net/wwan/t7xx/t7xx_state_monitor.c +27 -0

+{
+    struct t7xx_modem *md = ctl->md;
+    struct cldma_ctrl *md_ctrl;
+    enum lk_event_id lk_event;
+    struct device *dev;
+
+    dev = &md->t7xx_dev->pdev->dev;
+    lk_event = FIELD_GET(MISC_LK_EVENT_MASK, status);
+    switch (lk_event) {
+    case LK_EVENT_NORMAL:
+    case LK_EVENT_RESET:
+        break;
+
+    case LK_EVENT_CREATE_PD_PORT:
+        md_ctrl = md->md_ctrl[CLDMA_ID_AP];
+        t7xx_cldma_hif_hw_init(md_ctrl);
+        t7xx_cldma_stop(md_ctrl);
+        t7xx_cldma_switch_cfg(md_ctrl, CLDMA_DEDICATED_Q_CFG);
+        t7xx_cldma_start(md_ctrl);
+        break;
+
+    default:
+        dev_err(dev, "Invalid LK event %d\n", lk_event);
+        break;
+    }
+}
+

  static int fsm_stopped_handler(struct t7xx_fsm_ctl *ctl) {
      ctl->curr_state = FSM_STATE_STOPPED;

drivers/net/wwan/t7xx/t7xx_state_monitor.c +3 -2

@@ -317,8 +345,9 @@ static int fsm_routine_starting(struct 
 t7xx_fsm_ctl *ctl)
   static void fsm_routine_start(struct t7xx_fsm_ctl *ctl, struct t7xx_fsm_command *cmd)
   {
       struct t7xx_modem *md = ctl->md;
-    u32 dev_status;
-    int ret;
+    struct device *dev;
+    u32 status, stage;
+    int ret = 0;
       if (!md)
           return;

@@ -329,23 +358,55 @@ static void fsm_routine_start(struct 

t7xx_fsm_ctl *ctl, struct t7xx_fsm_command
          return;
      }
+    dev = &md->t7xx_dev->pdev->dev;
      ctl->curr_state = FSM_STATE_PRE_START; t7xx_md_event_notify(md, FSM_PRE_START);
-    ret = read_poll_timeout(ioread32, dev_status,
-                (dev_status & MISC_STAGE_MASK) == LINUX_STAGE, 20000, 2000000,
-                false, IREG_BASE(md->t7xx_dev) + T7XX_PCIE_MISC_DEV_STATUS);
+    ret = read_poll_timeout(ioread32, status,
+                ((status & MISC_STAGE_MASK) == T7XX_DEV_STAGE_LINUX) || +                ((status & MISC_STAGE_MASK) == T7XX_DEV_STAGE_LK), 100000,
+                20000000, false, IREG_BASE(md->t7xx_dev) + +                T7XX_PCIE_MISC_DEV_STATUS);
+
      if (ret) {
-        struct device *dev = &md->t7xx_dev->pdev->dev;
+        ret = -ETIMEDOUT;
+        dev_err(dev, "read poll %d\n", ret);
+        goto finish_command;
+    }

Quoted 6 lines

-        fsm_finish_command(ctl, cmd, -ETIMEDOUT);
-        dev_err(dev, "Invalid device status 0x%lx\n", dev_status & MISC_STAGE_MASK);
-        return;
+    if (status != ctl->prev_status) {
+        stage = FIELD_GET(MISC_STAGE_MASK, status);

if stage is only used down here you can declare it locally. cppcheck has a check that will find these for you.

Quoted 54 lines

+        switch (stage) {
+        case T7XX_DEV_STAGE_INIT:
+        case T7XX_DEV_STAGE_BROM_PRE:
+        case T7XX_DEV_STAGE_BROM_POST:
+            dev_info(dev, "BROM_STAGE Entered\n"); +            ret = t7xx_fsm_append_cmd(ctl, FSM_CMD_START, 0); +            break;

drivers/net/wwan/t7xx/t7xx_state_monitor.c +20 -0

+
+        case T7XX_DEV_STAGE_LK:
+            dev_info(dev, "LK_STAGE Entered\n");
+            t7xx_lk_stage_event_handling(ctl, status);
+            break;
+
+        case T7XX_DEV_STAGE_LINUX:
+            dev_info(dev, "LINUX_STAGE Entered\n");
+            t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_AP]);
+            t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_MD]);
+            t7xx_mhccif_mask_clr(md->t7xx_dev, D2H_INT_PORT_ENUM |
+                         D2H_INT_ASYNC_MD_HK | D2H_INT_ASYNC_AP_HK);
+            t7xx_port_proxy_set_cfg(md, PORT_CFG_ID_NORMAL);
+            ret = fsm_routine_starting(ctl);
+            break;
+
+        default:
+            break;
+        }
+        ctl->prev_status = status;

      }
-    t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_AP]); -    t7xx_cldma_hif_hw_init(md->md_ctrl[CLDMA_ID_MD]); -    fsm_finish_command(ctl, cmd, fsm_routine_starting(ctl)); +finish_command:
+    fsm_finish_command(ctl, cmd, ret);
  }
  static int fsm_main_thread(void *data)

drivers/net/wwan/t7xx/t7xx_state_monitor.c +1 -0

@@ -516,6 +577,7 @@ void t7xx_fsm_reset(struct t7xx_modem *md)
       fsm_flush_event_cmd_qs(ctl);
       ctl->curr_state = FSM_STATE_STOPPED;
       ctl->exp_flg = false;
+    ctl->prev_status = 0;
   }
   int t7xx_fsm_init(struct t7xx_modem *md)

drivers/net/wwan/t7xx/t7xx_state_monitor.h +0 -0

index b6e76f3903c8..5e8012567ba1 100644
@@ -96,6 +96,7 @@ struct t7xx_fsm_ctl {
       bool            exp_flg;

      spinlock_t        notifier_lock;        /* Protects notifier list */ struct list_head    notifier_list;
+    u32                     prev_status;
  };
  struct t7xx_fsm_event {

From: M Chetan Kumar <[email protected]>

PCI rescan module implements "rescan work queue". In firmware flashing or coredump collection procedure WWAN device is programmed to boot in fastboot mode and a work item is scheduled for removal & detection.

The WWAN device is reset using APCI call as part driver removal flow. Work queue rescans pci bus at fixed interval for device detection, later when device is detect work queue exits.

Signed-off-by Haijun Liu <[email protected]>

Co-developed-by Madhusmita Sahu <[email protected]>

Signed-off-by Madhusmita Sahu <[email protected]>

Signed-off-by Ricardo Martinez <[email protected]>

Signed-off-by M Chetan Kumar <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

--
v3:
* No Change.
v2:
* Drop empty line inside critical sections.
* Correct log message.
* Correct logic inside t7xx_always_match().
* Drop hp_enable changes.
* Drop g_ prefix from t7xx_rescan_ctx.
* Use tab before comment in struct decl.
* Remove extra white space.
* Drop modem exception state check.
* Crit section newlines.
* Remove unnecessary header files inclusion.
* Drop spinlock around reset and rescan flow.

---
  drivers/net/wwan/t7xx/Makefile          |  3 +-
  drivers/net/wwan/t7xx/t7xx_modem_ops.c  |  3 +
  drivers/net/wwan/t7xx/t7xx_pci.c        | 56 ++++++++++++++-
  drivers/net/wwan/t7xx/t7xx_pci_rescan.c | 96 +++++++++++++++++++++++++
  drivers/net/wwan/t7xx/t7xx_pci_rescan.h | 28 ++++++++
  5 files changed, 184 insertions(+), 2 deletions(-)

create mode 100644 drivers/net/wwan/t7xx/t7xx_pci_rescan.c create mode 100644 drivers/net/wwan/t7xx/t7xx_pci_rescan.h

drivers/net/wwan/t7xx/Makefile +2 -1

index 268ff9e87e5b..ba5c607404a4 100644
@@ -17,7 +17,8 @@ mtk_t7xx-y:=	t7xx_pci.o \
  		t7xx_hif_dpmaif_tx.o \
  		t7xx_hif_dpmaif_rx.o  \
  		t7xx_dpmaif.o \
-		t7xx_netdev.o
+		t7xx_netdev.o \
+		t7xx_pci_rescan.o
 
  mtk_t7xx-$(CONFIG_WWAN_DEBUGFS) += \
  		t7xx_port_trace.o \

drivers/net/wwan/t7xx/t7xx_modem_ops.c +3 -0

index cbd65aa48721..2fcaea4694ba 100644
@@ -37,6 +37,7 @@
  #include "t7xx_modem_ops.h"
  #include "t7xx_netdev.h"
  #include "t7xx_pci.h"
+#include "t7xx_pci_rescan.h"
  #include "t7xx_pcie_mac.h"
  #include "t7xx_port.h"
  #include "t7xx_port_proxy.h"

@@ -194,6 +195,8 @@ static irqreturn_t t7xx_rgu_isr_thread(int irq, void *data)
 
  	msleep(RGU_RESET_DELAY_MS);
  	t7xx_reset_device_via_pmic(t7xx_dev);
+	t7xx_rescan_queue_work(t7xx_dev->pdev);
+
  	return IRQ_HANDLED;
  }
 

drivers/net/wwan/t7xx/t7xx_pci.c +27 -1

index 871f2a27a398..1e953ec7dd00 100644
@@ -38,6 +38,7 @@
  #include "t7xx_mhccif.h"
  #include "t7xx_modem_ops.h"
  #include "t7xx_pci.h"
+#include "t7xx_pci_rescan.h"
  #include "t7xx_pcie_mac.h"
  #include "t7xx_reg.h"
  #include "t7xx_state_monitor.h"

@@ -715,6 +716,7 @@ static int t7xx_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
  		return ret;
  	}
 
+	t7xx_rescan_done();
  	t7xx_pcie_mac_set_int(t7xx_dev, MHCCIF_INT);
  	t7xx_pcie_mac_interrupts_en(t7xx_dev);
 

@@ -754,7 +756,59 @@ static struct pci_driver t7xx_pci_driver = {
  	.shutdown = t7xx_pci_shutdown,
  };
 
-module_pci_driver(t7xx_pci_driver);
+static int __init t7xx_pci_init(void)
+{
+	int ret;
+
+	t7xx_pci_dev_rescan();
+	ret = t7xx_rescan_init();
+	if (ret) {
+		pr_err("Failed to init t7xx rescan work\n");
+		return ret;
+	}
+
+	return pci_register_driver(&t7xx_pci_driver);
+}
+module_init(t7xx_pci_init);
+
+static int t7xx_always_match(struct device *dev, const void *data)
+{
+	struct pci_dev *pdev = to_pci_dev(dev);
+	const struct pci_device_id *id = data;
+
+	if (pci_match_id(id, pdev))
+		return 1;
+
+	return 0;
+}

drivers/net/wwan/t7xx/t7xx_pci.c +18 -0

+		put_device(dev);
+		remove_flag = 1;
+	} else {
+		pr_debug("no t7xx PCIe driver found.\n");
+	}
+
+	pci_lock_rescan_remove();
+	pci_unregister_driver(&t7xx_pci_driver);
+	pci_unlock_rescan_remove();
+
+	t7xx_rescan_deinit();
+	if (remove_flag) {
+		pr_debug("remove t7xx PCI device\n");
+		pci_stop_and_remove_bus_device_locked(to_pci_dev(dev));
+	}
+}
+
+module_exit(t7xx_pci_cleanup);
 
  MODULE_AUTHOR("MediaTek Inc");
  MODULE_DESCRIPTION("MediaTek PCIe 5G WWAN modem T7xx driver");

drivers/net/wwan/t7xx/t7xx_pci_rescan.c new file +96 -0

new file mode 100644
index 000000000000..67f13c035846
@@ -0,0 +1,96 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright (c) 2021, MediaTek Inc.
+ * Copyright (c) 2021-2023, Intel Corporation.
+ */
+
+#define pr_fmt(fmt) KBUILD_MODNAME ":t7xx:%s: " fmt, __func__
+#define dev_fmt(fmt) "t7xx: " fmt
+
+#include <linux/delay.h>
+#include <linux/pci.h>
+#include <linux/spinlock.h>
+#include <linux/workqueue.h>
+
+#include "t7xx_pci.h"
+#include "t7xx_pci_rescan.h"
+
+static struct remove_rescan_context t7xx_rescan_ctx;
+
+void t7xx_pci_dev_rescan(void)
+{
+	struct pci_bus *b = NULL;
+
+	pci_lock_rescan_remove();
+	while ((b = pci_find_next_bus(b)))
+		pci_rescan_bus(b);
+	pci_unlock_rescan_remove();
+}
+
+void t7xx_rescan_done(void)
+{
+	if (!atomic_read(&t7xx_rescan_ctx.rescan_done)) {
+		atomic_set(&t7xx_rescan_ctx.rescan_done, 1);
+		pr_debug("Rescan probe\n");
+	} else {
+		pr_debug("Init probe\n");
+	}
+}
+
+static void t7xx_remove_rescan(struct work_struct *work)
+{
+	int num_retries = RESCAN_RETRIES;
+	struct pci_dev *pdev;
+
+	atomic_set(&t7xx_rescan_ctx.rescan_done, 0);
+	pdev = t7xx_rescan_ctx.dev;
+
+	if (pdev) {
+		pci_stop_and_remove_bus_device_locked(pdev);
+		pr_debug("start remove and rescan flow\n");
+	}
+
+	do {
+		t7xx_pci_dev_rescan();
+
+		if (atomic_read(&t7xx_rescan_ctx.rescan_done))
+			break;
+
+		msleep(DELAY_RESCAN_MTIME);
+	} while (num_retries--);
+}
+
+void t7xx_rescan_queue_work(struct pci_dev *pdev)
+{
+	if (!atomic_read(&t7xx_rescan_ctx.rescan_done)) {
+		dev_err(&pdev->dev, "Rescan failed\n");
+		return;
+	}
+
+	t7xx_rescan_ctx.dev = pdev;
+	queue_work(t7xx_rescan_ctx.pcie_rescan_wq, &t7xx_rescan_ctx.service_task);
+}
+
+int t7xx_rescan_init(void)
+{
+	atomic_set(&t7xx_rescan_ctx.rescan_done, 1);
+	t7xx_rescan_ctx.dev = NULL;
+
+	t7xx_rescan_ctx.pcie_rescan_wq = create_singlethread_workqueue(MTK_RESCAN_WQ);
+	if (!t7xx_rescan_ctx.pcie_rescan_wq) {
+		pr_err("Failed to create workqueue: %s\n", MTK_RESCAN_WQ);
+		return -ENOMEM;
+	}
+
+	INIT_WORK(&t7xx_rescan_ctx.service_task, t7xx_remove_rescan);
+
+	return 0;
+}
+
+void t7xx_rescan_deinit(void)
+{
+	t7xx_rescan_ctx.dev = NULL;
+	atomic_set(&t7xx_rescan_ctx.rescan_done, 0);
+	cancel_work_sync(&t7xx_rescan_ctx.service_task);
+	destroy_workqueue(t7xx_rescan_ctx.pcie_rescan_wq);
+}

drivers/net/wwan/t7xx/t7xx_pci_rescan.h new file +28 -0

new file mode 100644
index 000000000000..80b25c44151c
@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: GPL-2.0-only
+ *
+ * Copyright (c) 2021, MediaTek Inc.
+ * Copyright (c) 2021-2023, Intel Corporation.
+ */
+
+#ifndef __T7XX_PCI_RESCAN_H__
+#define __T7XX_PCI_RESCAN_H__
+
+#define MTK_RESCAN_WQ "mtk_rescan_wq"
+
+#define DELAY_RESCAN_MTIME 1000
+#define RESCAN_RETRIES 35
+
+struct remove_rescan_context {
+	struct work_struct service_task;
+	struct workqueue_struct *pcie_rescan_wq;
+	struct pci_dev *dev;
+	atomic_t rescan_done;
+};
+
+void t7xx_pci_dev_rescan(void);
+void t7xx_rescan_queue_work(struct pci_dev *pdev);
+int t7xx_rescan_init(void);
+void t7xx_rescan_deinit(void);
+void t7xx_rescan_done(void);
+
+#endif	/* __T7XX_PCI_RESCAN_H__ */

Quoted 130 lines · On 1/6/2023 8:27 AM, [email protected] wrote:

From: M Chetan Kumar <[email protected]>

PCI rescan module implements "rescan work queue". In firmware flashing or coredump collection procedure WWAN device is programmed to boot in fastboot mode and a work item is scheduled for removal & detection.

The WWAN device is reset using APCI call as part driver removal flow. Work queue rescans pci bus at fixed interval for device detection, later when device is detect work queue exits.

Signed-off-by Haijun Liu <[email protected]>

Co-developed-by Madhusmita Sahu <[email protected]>

Signed-off-by Madhusmita Sahu <[email protected]>

Signed-off-by Ricardo Martinez <[email protected]>

Signed-off-by M Chetan Kumar <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

Signature · 23 lines

v3:
  * No Change.
v2:
  * Drop empty line inside critical sections.
  * Correct log message.
  * Correct logic inside t7xx_always_match().
  * Drop hp_enable changes.
  * Drop g_ prefix from t7xx_rescan_ctx.
  * Use tab before comment in struct decl.
  * Remove extra white space.
  * Drop modem exception state check.
  * Crit section newlines.
  * Remove unnecessary header files inclusion.
  * Drop spinlock around reset and rescan flow.
---
  drivers/net/wwan/t7xx/Makefile          |  3 +-
  drivers/net/wwan/t7xx/t7xx_modem_ops.c  |  3 +
  drivers/net/wwan/t7xx/t7xx_pci.c        | 56 ++++++++++++++-
  drivers/net/wwan/t7xx/t7xx_pci_rescan.c | 96 +++++++++++++++++++++++++
  drivers/net/wwan/t7xx/t7xx_pci_rescan.h | 28 ++++++++
  5 files changed, 184 insertions(+), 2 deletions(-)
  create mode 100644 drivers/net/wwan/t7xx/t7xx_pci_rescan.c
  create mode 100644 drivers/net/wwan/t7xx/t7xx_pci_rescan.h

drivers/net/wwan/t7xx/Makefile +2 -1

index 268ff9e87e5b..ba5c607404a4 100644
@@ -17,7 +17,8 @@ mtk_t7xx-y:=    t7xx_pci.o \
           t7xx_hif_dpmaif_tx.o \
           t7xx_hif_dpmaif_rx.o  \
           t7xx_dpmaif.o \
-        t7xx_netdev.o
+        t7xx_netdev.o \
+        t7xx_pci_rescan.o
   mtk_t7xx-$(CONFIG_WWAN_DEBUGFS) += \
           t7xx_port_trace.o \

drivers/net/wwan/t7xx/t7xx_modem_ops.c +3 -0

index cbd65aa48721..2fcaea4694ba 100644
@@ -37,6 +37,7 @@
   #include "t7xx_modem_ops.h"
   #include "t7xx_netdev.h"
   #include "t7xx_pci.h"
+#include "t7xx_pci_rescan.h"
   #include "t7xx_pcie_mac.h"
   #include "t7xx_port.h"
   #include "t7xx_port_proxy.h"

@@ -194,6 +195,8 @@ static irqreturn_t t7xx_rgu_isr_thread(int irq, 
 void *data)
       msleep(RGU_RESET_DELAY_MS);
       t7xx_reset_device_via_pmic(t7xx_dev);
+    t7xx_rescan_queue_work(t7xx_dev->pdev);
+
       return IRQ_HANDLED;
   }

drivers/net/wwan/t7xx/t7xx_pci.c +33 -1

index 871f2a27a398..1e953ec7dd00 100644
@@ -38,6 +38,7 @@
   #include "t7xx_mhccif.h"
   #include "t7xx_modem_ops.h"
   #include "t7xx_pci.h"
+#include "t7xx_pci_rescan.h"
   #include "t7xx_pcie_mac.h"
   #include "t7xx_reg.h"
   #include "t7xx_state_monitor.h"

@@ -715,6 +716,7 @@ static int t7xx_pci_probe(struct pci_dev *pdev, 
 const struct pci_device_id *id)
           return ret;
       }
+    t7xx_rescan_done();
       t7xx_pcie_mac_set_int(t7xx_dev, MHCCIF_INT);
       t7xx_pcie_mac_interrupts_en(t7xx_dev);

@@ -754,7 +756,59 @@ static struct pci_driver t7xx_pci_driver = {
       .shutdown = t7xx_pci_shutdown,
   };
-module_pci_driver(t7xx_pci_driver);
+static int __init t7xx_pci_init(void)
+{
+    int ret;
+
+    t7xx_pci_dev_rescan();
+    ret = t7xx_rescan_init();
+    if (ret) {
+        pr_err("Failed to init t7xx rescan work\n");
+        return ret;
+    }
+
+    return pci_register_driver(&t7xx_pci_driver);
+}
+module_init(t7xx_pci_init);
+
+static int t7xx_always_match(struct device *dev, const void *data)
+{
+    struct pci_dev *pdev = to_pci_dev(dev);
+    const struct pci_device_id *id = data;
+
+    if (pci_match_id(id, pdev))
+        return 1;
+
+    return 0;
+}
+
+static void __exit t7xx_pci_cleanup(void)
+{
+    int remove_flag = 0;
+    struct device *dev;
+

drivers/net/wwan/t7xx/t7xx_pci.c static struct pci_driver t7xx_pci_driver = { · line 794

Quoted 6 lines

drivers/net/wwan/t7xx/t7xx_pci.c +4 -0

+    dev = driver_find_device(&t7xx_pci_driver.driver, NULL, 
 &t7xx_pci_table[0],
+                 t7xx_always_match);
+    if (dev) {
+        pr_debug("unregister t7xx PCIe driver while device is still 
 exist.\n");

nit: s/is still exist/still exists/

Quoted 159 lines

drivers/net/wwan/t7xx/t7xx_pci.c +18 -0

+        put_device(dev);
+        remove_flag = 1;
+    } else {
+        pr_debug("no t7xx PCIe driver found.\n");
+    }
+
+    pci_lock_rescan_remove();
+    pci_unregister_driver(&t7xx_pci_driver);
+    pci_unlock_rescan_remove();
+
+    t7xx_rescan_deinit();
+    if (remove_flag) {
+        pr_debug("remove t7xx PCI device\n");
+        pci_stop_and_remove_bus_device_locked(to_pci_dev(dev));
+    }
+}
+
+module_exit(t7xx_pci_cleanup);
   MODULE_AUTHOR("MediaTek Inc");
   MODULE_DESCRIPTION("MediaTek PCIe 5G WWAN modem T7xx driver");

drivers/net/wwan/t7xx/t7xx_pci_rescan.c new file +71 -0

new file mode 100644
index 000000000000..67f13c035846
@@ -0,0 +1,96 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright (c) 2021, MediaTek Inc.
+ * Copyright (c) 2021-2023, Intel Corporation.
+ */
+
+#define pr_fmt(fmt) KBUILD_MODNAME ":t7xx:%s: " fmt, __func__
+#define dev_fmt(fmt) "t7xx: " fmt
+
+#include <linux/delay.h>
+#include <linux/pci.h>
+#include <linux/spinlock.h>
+#include <linux/workqueue.h>
+
+#include "t7xx_pci.h"
+#include "t7xx_pci_rescan.h"
+
+static struct remove_rescan_context t7xx_rescan_ctx;
+
+void t7xx_pci_dev_rescan(void)
+{
+    struct pci_bus *b = NULL;
+
+    pci_lock_rescan_remove();
+    while ((b = pci_find_next_bus(b)))
+        pci_rescan_bus(b);
+    pci_unlock_rescan_remove();
+}
+
+void t7xx_rescan_done(void)
+{
+    if (!atomic_read(&t7xx_rescan_ctx.rescan_done)) {
+        atomic_set(&t7xx_rescan_ctx.rescan_done, 1);
+        pr_debug("Rescan probe\n");
+    } else {
+        pr_debug("Init probe\n");
+    }
+}
+
+static void t7xx_remove_rescan(struct work_struct *work)
+{
+    int num_retries = RESCAN_RETRIES;
+    struct pci_dev *pdev;
+
+    atomic_set(&t7xx_rescan_ctx.rescan_done, 0);
+    pdev = t7xx_rescan_ctx.dev;
+
+    if (pdev) {
+        pci_stop_and_remove_bus_device_locked(pdev);
+        pr_debug("start remove and rescan flow\n");
+    }
+
+    do {
+        t7xx_pci_dev_rescan();
+
+        if (atomic_read(&t7xx_rescan_ctx.rescan_done))
+            break;
+
+        msleep(DELAY_RESCAN_MTIME);
+    } while (num_retries--);
+}
+
+void t7xx_rescan_queue_work(struct pci_dev *pdev)
+{
+    if (!atomic_read(&t7xx_rescan_ctx.rescan_done)) {
+        dev_err(&pdev->dev, "Rescan failed\n");
+        return;
+    }
+
+    t7xx_rescan_ctx.dev = pdev;
+    queue_work(t7xx_rescan_ctx.pcie_rescan_wq, 

&t7xx_rescan_ctx.service_task);

drivers/net/wwan/t7xx/t7xx_pci_rescan.c new file +8 -0

+}
+
+int t7xx_rescan_init(void)
+{
+    atomic_set(&t7xx_rescan_ctx.rescan_done, 1);
+    t7xx_rescan_ctx.dev = NULL;
+
+    t7xx_rescan_ctx.pcie_rescan_wq = 

create_singlethread_workqueue(MTK_RESCAN_WQ);
+    if (!t7xx_rescan_ctx.pcie_rescan_wq) {
+        pr_err("Failed to create workqueue: %s\n", MTK_RESCAN_WQ); +        return -ENOMEM;
+    }

drivers/net/wwan/t7xx/t7xx_pci_rescan.c new file +13 -0

+
+    INIT_WORK(&t7xx_rescan_ctx.service_task, t7xx_remove_rescan);
+
+    return 0;
+}
+
+void t7xx_rescan_deinit(void)
+{
+    t7xx_rescan_ctx.dev = NULL;
+    atomic_set(&t7xx_rescan_ctx.rescan_done, 0);
+    cancel_work_sync(&t7xx_rescan_ctx.service_task);
+    destroy_workqueue(t7xx_rescan_ctx.pcie_rescan_wq);
+}

drivers/net/wwan/t7xx/t7xx_pci_rescan.h new file +28 -0

new file mode 100644
index 000000000000..80b25c44151c
@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: GPL-2.0-only
+ *
+ * Copyright (c) 2021, MediaTek Inc.
+ * Copyright (c) 2021-2023, Intel Corporation.
+ */
+
+#ifndef __T7XX_PCI_RESCAN_H__
+#define __T7XX_PCI_RESCAN_H__
+
+#define MTK_RESCAN_WQ "mtk_rescan_wq"
+
+#define DELAY_RESCAN_MTIME 1000
+#define RESCAN_RETRIES 35
+
+struct remove_rescan_context {
+    struct work_struct service_task;
+    struct workqueue_struct *pcie_rescan_wq;
+    struct pci_dev *dev;
+    atomic_t rescan_done;
+};
+
+void t7xx_pci_dev_rescan(void);
+void t7xx_rescan_queue_work(struct pci_dev *pdev);
+int t7xx_rescan_init(void);
+void t7xx_rescan_deinit(void);
+void t7xx_rescan_done(void);
+
+#endif    /* __T7XX_PCI_RESCAN_H__ */

From: M Chetan Kumar <[email protected]>

Adds support for t7xx wwan device firmware flashing & coredump collection using devlink.

1> Driver Registers with Devlink framework.
2> Implements devlink ops flash_update callback that programs modem fw. 3> Creates region & snapshot required for device coredump log collection.

On early detection of wwan device in fastboot mode driver sets up CLDMA0 HW tx/rx queues for raw data transfer and then registers to devlink framework. On user space application issuing command for firmware update the driver sends fastboot flash command & firmware to program NAND.

In flashing procedure the fastboot command & response are exchanged between driver and device. Once firmware flashing is success completion status is reported to user space application.

Below is the devlink command usage for firmware flashing

$devlink dev flash pci/$BDF file ABC.img component ABC

Note: ABC.img is the firmware to be programmed to "ABC" partition.

In case of coredump collection when wwan device encounters an exception it reboots & stays in fastboot mode for coredump collection by host driver. On detecting exception state driver collects the core dump, creates the devlink region & reports an event to user space application for dump collection. The user space application invokes devlink region read command for dump collection.

Below are the devlink commands used for coredump collection.

devlink region new pci/$BDF/mr_dump
devlink region read pci/$BDF/mr_dump snapshot $ID address $ADD length $LEN devlink region del pci/$BDF/mr_dump snapshot $ID

Signed-off-by M Chetan Kumar <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

Signed-off-by Mishra Soumya Prakash <[email protected]>

--
v3:
* No Change.
v2:
* Remove devlink pointer inside the port state container.
* Rename t7xx_devlink_region_list to t7xx_devlink_region_infos & use region index in initialization.
* Change t7xx_devlink_region_infos to const.
* Handle remaining packet data if the buffer is less than the skb data.
* Drop t7xx_devlink_fb_send_buffer(), push fragmentation logic to

    t7xx_devlink_port_write().

* Add "\n" to log message.
* Move mrdump_region allocation to devlink initialization.
* Drop snprintf for CTS command fill.
* Drop intermediate mdata buffer & zipsize.
* For mcmd use strcmp instead of strncmp.
* Drop set_fastboot_dl instead use devlink param for fastboot operational mode.
* Drop unnecessary logs.
* Change t7xx_devlink_create_region to t7xx_devlink_create_regions.
* Use BUILD_BUG_ON on array size checks.
* Use ARRAY_SIZE inside loop.
* Correct indentation.
* Drop odd empty line.
* Push common devlink initialization code to t7xx_devlink_init.
* Use skb_queue_purge instead of running loop to free skbs.
* Change t7xx_regions index to enums.
* Remove dev in devlink container.
* Refactor struct to separate out devlink static and dynamic data structs.
* Use min_t.
* Drop unnecessary var assginment during initialization.
* Change while() to for().
* Correct size check.
* Rename result to ret.
* Clean-up error handling path in t7xx_devlink_fb_get_core & t7xx_devlink_fb_dump_log.
* Drop __func__ in log message.
* Change NOTY to NOTIFY.
* Push channel enable or disable cb to port proxy.
* Use array index in t7xx_devlink_region_list initialization.
* Drop t7xx_port_proxy_get_port_by_name() instead access port name directly via port_prox.
* Drop udev based event reporting logic.

* Drop get_core prefix in goto label.
* Remove unnessary header files.
* Allocate memory for mrdump_region->buf inside get_core.
* Remove 'region->buf' in t7xx_devlink_region_snapshot.
* Destroy workqueue on following error case in 'devlink_init'.
* Remove useless checks(dl->mode) and condition(dl->wq).
* Support devlink component versioning.
* Kconfig changes to select devlink.

From: M Chetan Kumar <[email protected]>

Document the t7xx devlink commands usage for fw flashing &

coredump collection.

Refer to t7xx.rst file for details.

Signed-off-by M Chetan Kumar <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

--
v3:
* No Change.
v2:
* Documentation correction.
* Add param details.

---
  Documentation/networking/devlink/index.rst |   1 +
  Documentation/networking/devlink/t7xx.rst  | 161 +++++++++++++++++++++
  2 files changed, 162 insertions(+)

create mode 100644 Documentation/networking/devlink/t7xx.rst

Documentation/networking/devlink/index.rst +1 -0

index fee4d3968309..0c4f5961e78f 100644
@@ -66,3 +66,4 @@ parameters, info versions, and other features it supports.
     prestera
     iosm
     octeontx2
+   t7xx

Documentation/networking/devlink/t7xx.rst new file +63 -0

new file mode 100644
index 000000000000..de220878ad76
@@ -0,0 +1,161 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
+t7xx devlink support
+====================
+
+This document describes the devlink features implemented by the ``t7xx``
+device driver.
+
+Parameters
+==========
+The ``t7xx_driver`` driver implements the following driver-specific parameters.
+
+.. list-table:: Driver-specific parameters implemented
+   :widths: 5 5 5 85
+
+   * - Name
+     - Type
+     - Mode
+     - Description
+   * - ``fastboot``
+     - boolean
+     - driverinit
+     - Set this param to enter fastboot mode.
+
+Flash Update
+============
+
+The ``t7xx`` driver implements the flash update using the ``devlink-flash``
+interface.
+
+The driver uses DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT to identify the type of
+firmware image that need to be programmed upon the request by user space application.
+
+The supported list of firmware image types is described below.
+
+.. list-table:: Firmware Image types
+    :widths: 15 85
+
+    * - Name
+      - Description
+    * - ``preloader``
+      - The first-stage bootloader image
+    * - ``loader_ext1``
+      - Preloader extension image
+    * - ``tee1``
+      - ARM trusted firmware and TEE (Trusted Execution Environment) image
+    * - ``lk``
+      - The second-stage bootloader image
+    * - ``spmfw``
+      - MediaTek in-house ASIC for power management image
+    * - ``sspm_1``
+      - MediaTek in-house ASIC for power management under secure world image
+    * - ``mcupm_1``
+      - MediaTek in-house ASIC for cpu power management image
+    * - ``dpm_1``
+      - MediaTek in-house ASIC for dram power management image
+    * - ``boot``
+      - The kernel and dtb image
+    * - ``rootfs``
+      - Root filesystem image
+    * - ``md1img``
+      - Modem image

Documentation/networking/devlink/t7xx.rst new file +88 -0

+procedure, fastboot command & response are exchanged between driver and wwan
+device.
+
+The wwan device is put into fastboot mode via devlink reload command, by
+passing "driver_reinit" action.
+
+$ devlink dev reload pci/0000:$bdf action driver_reinit
+
+Upon completion of fw flashing or coredump collection the wwan device is
+reset to normal mode using devlink reload command, by passing "fw_activate"
+action.
+
+$ devlink dev reload pci/0000:$bdf action fw_activate
+
+Flash Commands:
+===============
+
+$ devlink dev flash pci/0000:$bdf file preloader_k6880v1_mdot2_datacard.bin component "preloader"
+
+$ devlink dev flash pci/0000:$bdf file loader_ext-verified.img component "loader_ext1"
+
+$ devlink dev flash pci/0000:$bdf file tee-verified.img component "tee1"
+
+$ devlink dev flash pci/0000:$bdf file lk-verified.img component "lk"
+
+$ devlink dev flash pci/0000:$bdf file spmfw-verified.img component "spmfw"
+
+$ devlink dev flash pci/0000:$bdf file sspm-verified.img component "sspm_1"
+
+$ devlink dev flash pci/0000:$bdf file mcupm-verified.img component "mcupm_1"
+
+$ devlink dev flash pci/0000:$bdf file dpm-verified.img component "dpm_1"
+
+$ devlink dev flash pci/0000:$bdf file boot-verified.img component "boot"
+
+$ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
+
+$ devlink dev flash pci/0000:$bdf file modem-verified.img component "md1img"
+
+$ devlink dev flash pci/0000:$bdf file dsp-verified.bin component "md1dsp"
+
+$ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
+
+$ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
+
+$ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
+
+Note: Component selects the partition type to be programmed.
+
+Regions
+=======
+
+The ``t7xx`` driver supports core dump collection when device encounters
+an exception. When wwan device encounters an exception, a snapshot of device
+internal data will be taken by the driver using fastboot commands.
+
+Following regions are accessed for device internal data.
+
+.. list-table:: Regions implemented
+    :widths: 15 85
+
+    * - Name
+      - Description
+    * - ``mr_dump``
+      - The detailed modem component logs are captured in this region
+    * - ``lk_dump``
+      - This region dumps the current snapshot of lk
+
+
+Region commands
+===============
+
+$ devlink region show
+
+
+$ devlink region new mr_dump
+
+$ devlink region read mr_dump snapshot 0 address 0 length $len
+
+$ devlink region del mr_dump snapshot 0
+
+$ devlink region new lk_dump
+
+$ devlink region read lk_dump snapshot 0 address 0 length $len
+
+$ devlink region del lk_dump snapshot 0
+
+Note: $len is actual len to be dumped.

Quoted 3 lines · On 1/6/2023 8:28 AM, [email protected] wrote:

From: M Chetan Kumar <[email protected]>

Document the t7xx devlink commands usage for fw flashing &

it would make the documentation easier and faster to read if you just spelled out fw as firmware.

Quoted 107 lines

coredump collection.

Refer to t7xx.rst file for details.

Signed-off-by M Chetan Kumar <[email protected]>

Signed-off-by Devegowda Chandrashekar <[email protected]>

Signature · 10 lines

v3:
  * No Change.
v2:
  * Documentation correction.
  * Add param details.
---
  Documentation/networking/devlink/index.rst |   1 +
  Documentation/networking/devlink/t7xx.rst  | 161 +++++++++++++++++++++
  2 files changed, 162 insertions(+)
  create mode 100644 Documentation/networking/devlink/t7xx.rst

Documentation/networking/devlink/index.rst +0 -0

index fee4d3968309..0c4f5961e78f 100644
@@ -66,3 +66,4 @@ parameters, info versions, and other features it 

supports.
     prestera
     iosm
     octeontx2
+   t7xx

Documentation/networking/devlink/t7xx.rst new file +12 -0

new file mode 100644
index 000000000000..de220878ad76
@@ -0,0 +1,161 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
+t7xx devlink support
+====================
+
+This document describes the devlink features implemented by the ``t7xx``
+device driver.
+
+Parameters
+==========
+The ``t7xx_driver`` driver implements the following driver-specific 

parameters.

Documentation/networking/devlink/t7xx.rst new file +17 -0

+
+.. list-table:: Driver-specific parameters implemented
+   :widths: 5 5 5 85
+
+   * - Name
+     - Type
+     - Mode
+     - Description
+   * - ``fastboot``
+     - boolean
+     - driverinit
+     - Set this param to enter fastboot mode.
+
+Flash Update
+============
+
+The ``t7xx`` driver implements the flash update using the 

``devlink-flash``

Documentation/networking/devlink/t7xx.rst new file +3 -0

+interface.
+
+The driver uses DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT to identify 

the type of
+firmware image that need to be programmed upon the request by user space application.

Documentation/networking/devlink/t7xx.rst new file +14 -0

+
+The supported list of firmware image types is described below.
+
+.. list-table:: Firmware Image types
+    :widths: 15 85
+
+    * - Name
+      - Description
+    * - ``preloader``
+      - The first-stage bootloader image
+    * - ``loader_ext1``
+      - Preloader extension image
+    * - ``tee1``
+      - ARM trusted firmware and TEE (Trusted Execution Environment) 

image
+    * - ``lk``
+      - The second-stage bootloader image
+    * - ``spmfw``
+      - MediaTek in-house ASIC for power management image +    * - ``sspm_1``
+      - MediaTek in-house ASIC for power management under secure world image
+    * - ``mcupm_1``
+      - MediaTek in-house ASIC for cpu power management image +    * - ``dpm_1``
+      - MediaTek in-house ASIC for dram power management image +    * - ``boot``
+      - The kernel and dtb image
+    * - ``rootfs``
+      - Root filesystem image
+    * - ``md1img``
+      - Modem image
+    * - ``md1dsp``
+      - Modem DSP image
+    * - ``mcf1``

Quoted 8 lines

+      - Modem OTA image (Modem Configuration Framework) for operators +    * - ``mcf2``
+      - Modem OTA image (Modem Configuration Framework) for OEM vendors +    * - ``mcf3``
+      - Modem OTA image (other usage) for OEM configurations +
+``t7xx`` driver uses fastboot protocol for fw flashing. In the fw flashing

it would make the documentation easier and faster to read if you just spelled out fw as firmware.

Quoted 100 lines

+procedure, fastboot command & response are exchanged between driver and wwan

Documentation/networking/devlink/t7xx.rst new file +9 -0

+device.
+
+The wwan device is put into fastboot mode via devlink reload command, by
+passing "driver_reinit" action.
+
+$ devlink dev reload pci/0000:$bdf action driver_reinit
+
+Upon completion of fw flashing or coredump collection the wwan device is
+reset to normal mode using devlink reload command, by passing 

"fw_activate"

Documentation/networking/devlink/t7xx.rst new file +8 -0

+action.
+
+$ devlink dev reload pci/0000:$bdf action fw_activate
+
+Flash Commands:
+===============
+
+$ devlink dev flash pci/0000:$bdf file 

preloader_k6880v1_mdot2_datacard.bin component "preloader" +
+$ devlink dev flash pci/0000:$bdf file loader_ext-verified.img component "loader_ext1"

Documentation/networking/devlink/t7xx.rst new file +6 -0

+
+$ devlink dev flash pci/0000:$bdf file tee-verified.img component "tee1"
+
+$ devlink dev flash pci/0000:$bdf file lk-verified.img component "lk"
+
+$ devlink dev flash pci/0000:$bdf file spmfw-verified.img component 

"spmfw"
+
+$ devlink dev flash pci/0000:$bdf file sspm-verified.img component "sspm_1"
+
+$ devlink dev flash pci/0000:$bdf file mcupm-verified.img component "mcupm_1"
+
+$ devlink dev flash pci/0000:$bdf file dpm-verified.img component "dpm_1"
+
+$ devlink dev flash pci/0000:$bdf file boot-verified.img component "boot"

Documentation/networking/devlink/t7xx.rst new file +4 -0

+
+$ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
+
+$ devlink dev flash pci/0000:$bdf file modem-verified.img component 

"md1img"
+
+$ devlink dev flash pci/0000:$bdf file dsp-verified.bin component "md1dsp"

Documentation/networking/devlink/t7xx.rst new file +14 -0

+
+$ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
+
+$ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
+
+$ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
+
+Note: Component selects the partition type to be programmed.
+
+Regions
+=======
+
+The ``t7xx`` driver supports core dump collection when device encounters
+an exception. When wwan device encounters an exception, a snapshot of 

device

Documentation/networking/devlink/t7xx.rst new file +34 -0

+internal data will be taken by the driver using fastboot commands.
+
+Following regions are accessed for device internal data.
+
+.. list-table:: Regions implemented
+    :widths: 15 85
+
+    * - Name
+      - Description
+    * - ``mr_dump``
+      - The detailed modem component logs are captured in this region
+    * - ``lk_dump``
+      - This region dumps the current snapshot of lk
+
+
+Region commands
+===============
+
+$ devlink region show
+
+
+$ devlink region new mr_dump
+
+$ devlink region read mr_dump snapshot 0 address 0 length $len
+
+$ devlink region del mr_dump snapshot 0
+
+$ devlink region new lk_dump
+
+$ devlink region read lk_dump snapshot 0 address 0 length $len
+
+$ devlink region del lk_dump snapshot 0
+
+Note: $len is actual len to be dumped.

Refer to t7xx.rst file for details.

(quoted diff) +31 -0

+
+$ devlink dev flash pci/0000:$bdf file preloader_k6880v1_mdot2_datacard.bin component "preloader"
+
+$ devlink dev flash pci/0000:$bdf file loader_ext-verified.img component "loader_ext1"
+
+$ devlink dev flash pci/0000:$bdf file tee-verified.img component "tee1"
+
+$ devlink dev flash pci/0000:$bdf file lk-verified.img component "lk"
+
+$ devlink dev flash pci/0000:$bdf file spmfw-verified.img component "spmfw"
+
+$ devlink dev flash pci/0000:$bdf file sspm-verified.img component "sspm_1"
+
+$ devlink dev flash pci/0000:$bdf file mcupm-verified.img component "mcupm_1"
+
+$ devlink dev flash pci/0000:$bdf file dpm-verified.img component "dpm_1"
+
+$ devlink dev flash pci/0000:$bdf file boot-verified.img component "boot"
+
+$ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
+
+$ devlink dev flash pci/0000:$bdf file modem-verified.img component "md1img"
+
+$ devlink dev flash pci/0000:$bdf file dsp-verified.bin component "md1dsp"
+
+$ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
+
+$ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
+
+$ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
+

<snipped>...

(quoted diff) +9 -0

+Region commands
+===============
+
+$ devlink region show
+
+
+$ devlink region new mr_dump
+
+$ devlink region read mr_dump snapshot 0 address 0 length $len

Quoted 1 line · On Fri, Jan 06, 2023 at 09:58:06PM +0530, [email protected] wrote:

Refer to t7xx.rst file for details.

Above line is unnecessary.

Documentation/networking/devlink/t7xx.rst The supported list of firmware image types is described below. · line 86

Quoted 11 lines

Documentation/networking/devlink/t7xx.rst +10 -0

+The wwan device is put into fastboot mode via devlink reload command, by
+passing "driver_reinit" action.
+
+$ devlink dev reload pci/0000:$bdf action driver_reinit
+
+Upon completion of fw flashing or coredump collection the wwan device is
+reset to normal mode using devlink reload command, by passing "fw_activate"
+action.
+
+$ devlink dev reload pci/0000:$bdf action fw_activate

Personally I prefer to put command-line explanations below the actual command:

---- >8 ----

Documentation/networking/devlink/t7xx.rst +7 -3

index de220878ad7649..24f9e0ee69bffb 100644
@@ -74,17 +74,21 @@ The supported list of firmware image types is described below.
  procedure, fastboot command & response are exchanged between driver and wwan
  device.
 
+::
+
+  $ devlink dev reload pci/0000:$bdf action driver_reinit
+
  The wwan device is put into fastboot mode via devlink reload command, by
  passing "driver_reinit" action.
 
-$ devlink dev reload pci/0000:$bdf action driver_reinit
+::
+
+  $ devlink dev reload pci/0000:$bdf action fw_activate
 
  Upon completion of fw flashing or coredump collection the wwan device is
  reset to normal mode using devlink reload command, by passing "fw_activate"
  action.
 
-$ devlink dev reload pci/0000:$bdf action fw_activate
-
  Flash Commands:
  ===============
 

However, I find it's odd to jump from firmware image type list directly to devlink usage. Perhaps the latter should be put into the following section below?

I also find that there is minor inconsistency of keyword formatting, so I have to inline-code the uninlined remainings:

---- >8 ----

Documentation/networking/devlink/t7xx.rst +3 -3

index 24f9e0ee69bffb..d8feefe116c978 100644
@@ -29,7 +29,7 @@ Flash Update
  The ``t7xx`` driver implements the flash update using the ``devlink-flash``
  interface.
 
-The driver uses DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT to identify the type of
+The driver uses ``DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT`` to identify the type of
  firmware image that need to be programmed upon the request by user space application.
 
  The supported list of firmware image types is described below.

@@ -79,14 +79,14 @@ device.
    $ devlink dev reload pci/0000:$bdf action driver_reinit
 
  The wwan device is put into fastboot mode via devlink reload command, by
-passing "driver_reinit" action.
+passing ``driver_reinit`` action.
 
  ::
 
    $ devlink dev reload pci/0000:$bdf action fw_activate
 
  Upon completion of fw flashing or coredump collection the wwan device is
-reset to normal mode using devlink reload command, by passing "fw_activate"
+reset to normal mode using devlink reload command, by passing ``fw_activate``
  action.
 
  Flash Commands:

Review

Quoted 3 lines

(quoted diff) +3 -0

+
+Flash Commands:
+===============

Trim the unneeded trailing colon on the section title.

Quoted 46 lines

Documentation/networking/devlink/t7xx.rst +31 -0

+
+$ devlink dev flash pci/0000:$bdf file preloader_k6880v1_mdot2_datacard.bin component "preloader"
+
+$ devlink dev flash pci/0000:$bdf file loader_ext-verified.img component "loader_ext1"
+
+$ devlink dev flash pci/0000:$bdf file tee-verified.img component "tee1"
+
+$ devlink dev flash pci/0000:$bdf file lk-verified.img component "lk"
+
+$ devlink dev flash pci/0000:$bdf file spmfw-verified.img component "spmfw"
+
+$ devlink dev flash pci/0000:$bdf file sspm-verified.img component "sspm_1"
+
+$ devlink dev flash pci/0000:$bdf file mcupm-verified.img component "mcupm_1"
+
+$ devlink dev flash pci/0000:$bdf file dpm-verified.img component "dpm_1"
+
+$ devlink dev flash pci/0000:$bdf file boot-verified.img component "boot"
+
+$ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
+
+$ devlink dev flash pci/0000:$bdf file modem-verified.img component "md1img"
+
+$ devlink dev flash pci/0000:$bdf file dsp-verified.bin component "md1dsp"
+
+$ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
+
+$ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
+
+$ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
+

<snipped>...

(quoted diff) +13 -0

+Region commands
+===============
+
+$ devlink region show
+
+
+$ devlink region new mr_dump
+
+$ devlink region read mr_dump snapshot 0 address 0 length $len
+
+$ devlink region del mr_dump snapshot 0
+
+$ devlink region new lk_dump

Documentation/networking/devlink/t7xx.rst Following regions are accessed for device internal data.

Quoted 6 lines

Documentation/networking/devlink/t7xx.rst +6 -0

+
+$ devlink region read lk_dump snapshot 0 address 0 length $len
+
+$ devlink region del lk_dump snapshot 0
+
+Note: $len is actual len to be dumped.

Please briefly describe these devlink commands.

Also, wrap them in literal code blocks:

---- >8 ----

Documentation/networking/devlink/t7xx.rst +64 -22

index d8feefe116c978..1ba3ba4680e721 100644
@@ -92,35 +92,65 @@ action.
  Flash Commands:
  ===============
 
-$ devlink dev flash pci/0000:$bdf file preloader_k6880v1_mdot2_datacard.bin component "preloader"
+::
 
-$ devlink dev flash pci/0000:$bdf file loader_ext-verified.img component "loader_ext1"
+  $ devlink dev flash pci/0000:$bdf file preloader_k6880v1_mdot2_datacard.bin component "preloader"
 
-$ devlink dev flash pci/0000:$bdf file tee-verified.img component "tee1"
+::
 
-$ devlink dev flash pci/0000:$bdf file lk-verified.img component "lk"
+  $ devlink dev flash pci/0000:$bdf file loader_ext-verified.img component "loader_ext1"
 
-$ devlink dev flash pci/0000:$bdf file spmfw-verified.img component "spmfw"
+::
 
-$ devlink dev flash pci/0000:$bdf file sspm-verified.img component "sspm_1"
+  $ devlink dev flash pci/0000:$bdf file tee-verified.img component "tee1"
 
-$ devlink dev flash pci/0000:$bdf file mcupm-verified.img component "mcupm_1"
+::
 
-$ devlink dev flash pci/0000:$bdf file dpm-verified.img component "dpm_1"
+  $ devlink dev flash pci/0000:$bdf file lk-verified.img component "lk"
 
-$ devlink dev flash pci/0000:$bdf file boot-verified.img component "boot"
+::
 
-$ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
+  $ devlink dev flash pci/0000:$bdf file spmfw-verified.img component "spmfw"
 
-$ devlink dev flash pci/0000:$bdf file modem-verified.img component "md1img"
+::
 
-$ devlink dev flash pci/0000:$bdf file dsp-verified.bin component "md1dsp"
+  $ devlink dev flash pci/0000:$bdf file sspm-verified.img component "sspm_1"
 
-$ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
+::
 
-$ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
+  $ devlink dev flash pci/0000:$bdf file mcupm-verified.img component "mcupm_1"
 
-$ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
+::
+
+  $ devlink dev flash pci/0000:$bdf file dpm-verified.img component "dpm_1"
+
+::
+
+  $ devlink dev flash pci/0000:$bdf file boot-verified.img component "boot"
+
+::
+
+  $ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
+
+::
+
+  $ devlink dev flash pci/0000:$bdf file modem-verified.img component "md1img"
+
+::
+
+  $ devlink dev flash pci/0000:$bdf file dsp-verified.bin component "md1dsp"
+
+::
+
+  $ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
+
+::
+
+  $ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
+
+::
+
+  $ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
 
  Note: Component selects the partition type to be programmed.
 

@@ -147,19 +177,31 @@ Following regions are accessed for device internal data.
  Region commands
  ===============
 
-$ devlink region show
+::
+  $ devlink region show
 
+::
 
-$ devlink region new mr_dump
+  $ devlink region new mr_dump
 
-$ devlink region read mr_dump snapshot 0 address 0 length $len
+::
 
-$ devlink region del mr_dump snapshot 0
+  $ devlink region read mr_dump snapshot 0 address 0 length $len
 
-$ devlink region new lk_dump
+::
 
-$ devlink region read lk_dump snapshot 0 address 0 length $len
+  $ devlink region del mr_dump snapshot 0
 
-$ devlink region del lk_dump snapshot 0
+::
+
+  $ devlink region new lk_dump
+
+::
+
+  $ devlink region read lk_dump snapshot 0 address 0 length $len
+
+::
+
+  $ devlink region del lk_dump snapshot 0
 
  Note: $len is actual len to be dumped.

Thanks.