From: "Kumar, M Chetan" <m.chetan.kumar@linux.intel.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>, netdev@vger.kernel.org
Cc: kuba@kernel.org, davem@davemloft.net, johannes@sipsolutions.net,
ryazanov.s.a@gmail.com, loic.poulain@linaro.org,
ilpo.jarvinen@linux.intel.com, ricardo.martinez@linux.intel.com,
chiranjeevi.rapolu@linux.intel.com, haijun.liu@mediatek.com,
edumazet@google.com, pabeni@redhat.com,
chandrashekar.devegowda@intel.com, linuxwwan@intel.com,
linuxwwan_5g@intel.com, corbet@lwn.net,
linux-doc@vger.kernel.org, jiri@nvidia.com
Subject: Re: [PATCH v5 net-next 5/5] net: wwan: t7xx: Devlink documentation
Date: Tue, 24 Jan 2023 20:00:59 +0530 [thread overview]
Message-ID: <29f470c1-4b93-e7d2-88ec-5cce716c128d@linux.intel.com> (raw)
In-Reply-To: <Y8yb2AKf9mDHP0zu@debian.me>
On 1/22/2023 7:43 AM, Bagas Sanjaya wrote:
> On Sat, Jan 21, 2023 at 07:03:58PM +0530, m.chetan.kumar@linux.intel.com wrote:
>> +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"
>
> It seems like you didn't describe what ``devlink dev flash`` commands above
> are doing, as I had requested from v3 review [1].
>
>> +Coredump Collection
>> +~~~~~~~~~~~~~~~~~~~
>> +
>> +::
>> +
>> + $ devlink region new mr_dump
>> +
>> +::
>> +
>> + $ devlink region read mr_dump snapshot 0 address 0 length $len
>> +
>> +::
>> +
>> + $ devlink region del mr_dump snapshot 0
>> +
>> +Note: $len is actual len to be dumped.
>> +
>> +The userspace application uses these commands for obtaining the modem component
>> +logs when device encounters an exception.
>
> Individual command explanation please?
>
>> +
>> +Second Stage Bootloader dump
>> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> +
>> +::
>> +
>> + $ 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.
>> +
>> +In fastboot mode the userspace application uses these commands for obtaining the
>> +current snapshot of second stage bootloader.
>
> Individual command explanation please?
>
> Hint: see any manpages to get sense of how to write the explanations.
>
> Thanks.
>
> [1]: https://lore.kernel.org/linux-doc/Y7uOcBRN0Awn5xAb@debian.me/
I have added the explanation for each of those commands and also have
changed the format a bit.
Could you please take a look and suggest on below changes.
--- a/Documentation/networking/devlink/t7xx.rst
+++ b/Documentation/networking/devlink/t7xx.rst
@@ -54,65 +54,52 @@ 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 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"
+.. code:: shell
-::
+ # Update device Preloader image
+ $ devlink dev flash pci/0000:$bdf file
preloader_k6880v1_mdot2_datacard.bin component "preloader"
- $ devlink dev flash pci/0000:$bdf file dpm-verified.img component "dpm_1"
+ # Update device Preloader extension image
+ $ devlink dev flash pci/0000:$bdf file loader_ext-verified.img
component "loader_ext1"
-::
+ # Update device TEE (Trusted Execution Environment) image
+ $ devlink dev flash pci/0000:$bdf file tee-verified.img component
"tee1"
- $ devlink dev flash pci/0000:$bdf file boot-verified.img component "boot"
+ # Update device Second stage bootloader image
+ $ devlink dev flash pci/0000:$bdf file lk-verified.img component "lk"
-::
+ # Update device PM (Power Management) image
+ $ devlink dev flash pci/0000:$bdf file spmfw-verified.img component
"spmfw"
- $ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
-
-::
+ # Update device Secure PM image
+ $ devlink dev flash pci/0000:$bdf file sspm-verified.img component
"sspm_1"
- $ devlink dev flash pci/0000:$bdf file modem-verified.img component
"md1img"
+ # Update device CPU PM image
+ $ devlink dev flash pci/0000:$bdf file mcupm-verified.img component
"mcupm_1"
-::
+ # Update device DRAM PM image
+ $ devlink dev flash pci/0000:$bdf file dpm-verified.img component
"dpm_1"
- $ devlink dev flash pci/0000:$bdf file dsp-verified.bin component
"md1dsp"
+ # Update Kernel image
+ $ devlink dev flash pci/0000:$bdf file boot-verified.img component
"boot"
-::
+ # Update Root filesystem image
+ $ devlink dev flash pci/0000:$bdf file root.squashfs component "rootfs"
- $ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
+ # Update Modem image
+ $ devlink dev flash pci/0000:$bdf file modem-verified.img component
"md1img"
-::
+ # Update DSP image
+ $ devlink dev flash pci/0000:$bdf file dsp-verified.bin component
"md1dsp"
- $ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
+ # Update Modem OTA image (operator specific)
+ $ devlink dev flash pci/0000:$bdf file OP_OTA.img component "mcf1"
-::
+ # Update Modem OTA image (vendor specific)
+ $ devlink dev flash pci/0000:$bdf file OEM_OTA.img component "mcf2"
- $ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
+ # Update Modem OTA image (vendor configurtions)
+ $ devlink dev flash pci/0000:$bdf file DEV_OTA.img component "mcf3"
Note: Component selects the partition type to be programmed.
@@ -166,12 +153,13 @@ the driver using fastboot commands.
Region commands
---------------
-::
+.. code:: shell
- $ devlink region show
+ # Show all the regions supported by driver.
+ $ devlink region show
-This command list the regions implemented by driver. These regions are
accessed
-for device internal data. Below table describes the regions.
+Regions are used for accessing device internal data for debugging
purpose. Below table
+describes the regions.
.. list-table:: Regions
:widths: 15 85
@@ -186,17 +174,16 @@ for device internal data. Below table describes
the regions.
Coredump Collection
~~~~~~~~~~~~~~~~~~~
-::
-
- $ devlink region new mr_dump
+.. code:: shell
-::
+ # Create a modem region snapshot using:
+ $ devlink region new mr_dump
- $ devlink region read mr_dump snapshot 0 address 0 length $len
-
-::
+ # Read a specific part of modem region snapshot using:
+ $ devlink region read mr_dump snapshot 0 address 0 length $len
- $ devlink region del mr_dump snapshot 0
+ # Delete a modem region snapshot using:
+ $ devlink region del mr_dump snapshot 0
Note: $len is actual len to be dumped.
@@ -206,17 +193,16 @@ logs when device encounters an exception.
Second Stage Bootloader dump
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-::
-
- $ devlink region new lk_dump
+.. code:: shell
-::
+ # Create a second stage bootloader snapshot using:
+ $ devlink region new lk_dump
- $ devlink region read lk_dump snapshot 0 address 0 length $len
-
-::
+ # Read a specific part of second stage booloader snapshot using:
+ $ devlink region read lk_dump snapshot 0 address 0 length $len
- $ devlink region del lk_dump snapshot 0
+ # Delete a second stage bootloader snapshot using:
+ $ devlink region del lk_dump snapshot 0
Note: $len is actual len to be dumped.
--
Chetan
next prev parent reply other threads:[~2023-01-24 14:31 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1674307425.git.m.chetan.kumar@linux.intel.com>
2023-01-21 13:33 ` [PATCH v5 net-next 5/5] net: wwan: t7xx: Devlink documentation m.chetan.kumar
2023-01-22 2:13 ` Bagas Sanjaya
2023-01-24 14:30 ` Kumar, M Chetan [this message]
2023-01-25 4:51 ` Jakub Kicinski
2023-01-25 10:33 ` Kumar, M Chetan
2023-01-25 11:34 ` Ilpo Järvinen
2023-01-25 18:08 ` Jakub Kicinski
2023-01-26 10:55 ` Kumar, M Chetan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=29f470c1-4b93-e7d2-88ec-5cce716c128d@linux.intel.com \
--to=m.chetan.kumar@linux.intel.com \
--cc=bagasdotme@gmail.com \
--cc=chandrashekar.devegowda@intel.com \
--cc=chiranjeevi.rapolu@linux.intel.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=haijun.liu@mediatek.com \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=jiri@nvidia.com \
--cc=johannes@sipsolutions.net \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linuxwwan@intel.com \
--cc=linuxwwan_5g@intel.com \
--cc=loic.poulain@linaro.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=ricardo.martinez@linux.intel.com \
--cc=ryazanov.s.a@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).