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, linuxwwan@intel.com,
linuxwwan_5g@intel.com, chandrashekar.devegowda@intel.com,
matthias.bgg@gmail.com, linux-arm-kernel@lists.infradead.org,
linux-mediatek@lists.infradead.org, linux-doc@vger.kernel.org,
jiri@nvidia.com, corbet@lwn.net
Subject: Re: [PATCH v3 net-next 5/5] net: wwan: t7xx: Devlink documentation
Date: Mon, 9 Jan 2023 21:37:30 +0530 [thread overview]
Message-ID: <c7bd8511-7d4f-526a-28b9-215edc6e7c7f@linux.intel.com> (raw)
In-Reply-To: <Y7uOcBRN0Awn5xAb@debian.me>
Hi Bagas,
Thank you for the feedback.
On 1/9/2023 9:18 AM, Bagas Sanjaya wrote:
> On Fri, Jan 06, 2023 at 09:58:06PM +0530, m.chetan.kumar@linux.intel.com wrote:
>> Refer to t7xx.rst file for details.
>
> Above line is unnecessary.
Ok. Will drop it.
>
>> +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:
Sure. Will keep explanation under the command.
>
> ---- >8 ----
>
> diff --git a/Documentation/networking/devlink/t7xx.rst b/Documentation/networking/devlink/t7xx.rst
> index de220878ad7649..24f9e0ee69bffb 100644
> --- a/Documentation/networking/devlink/t7xx.rst
> +++ b/Documentation/networking/devlink/t7xx.rst
> @@ -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?
Ok. Will move image type list under Flash Commands.
>
> I also find that there is minor inconsistency of keyword formatting, so I
> have to inline-code the uninlined remainings:
Ok. Will correct it.
>
> ---- >8 ----
>
> diff --git a/Documentation/networking/devlink/t7xx.rst b/Documentation/networking/devlink/t7xx.rst
> index 24f9e0ee69bffb..d8feefe116c978 100644
> --- a/Documentation/networking/devlink/t7xx.rst
> +++ b/Documentation/networking/devlink/t7xx.rst
> @@ -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:
>
>> +
>> +Flash Commands:
>> +===============
>
> Trim the unneeded trailing colon on the section title.
Ok. will drop it.
>
>> +
>> +$ 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>...
>> +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.
>
> Please briefly describe these devlink commands.
Ok. Will add some explanations.
>
> Also, wrap them in literal code blocks:
>
> ---- >8 ----
>
> diff --git a/Documentation/networking/devlink/t7xx.rst b/Documentation/networking/devlink/t7xx.rst
> index d8feefe116c978..1ba3ba4680e721 100644
> --- a/Documentation/networking/devlink/t7xx.rst
> +++ b/Documentation/networking/devlink/t7xx.rst
> @@ -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.
>
Thanks for the inline-code. Will follow the suggested format for
documentation.
--
Chetan
prev parent reply other threads:[~2023-01-09 16:08 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-06 16:26 [PATCH v3 net-next 0/5] net: wwan: t7xx: fw flashing & coredump support m.chetan.kumar
2023-01-06 16:26 ` [PATCH v3 net-next 1/5] net: wwan: t7xx: Add AP CLDMA m.chetan.kumar
2023-01-06 17:56 ` Jesse Brandeburg
2023-01-06 16:26 ` [PATCH v3 net-next 2/5] net: wwan: t7xx: Infrastructure for early port configuration m.chetan.kumar
2023-01-06 18:31 ` Jesse Brandeburg
2023-01-08 14:07 ` Kumar, M Chetan
2023-01-06 16:27 ` [PATCH v3 net-next 3/5] net: wwan: t7xx: PCIe reset rescan m.chetan.kumar
2023-01-06 18:42 ` Jesse Brandeburg
2023-01-08 14:14 ` Kumar, M Chetan
2023-01-06 16:27 ` [PATCH v3 net-next 4/5] net: wwan: t7xx: Enable devlink based fw flashing and coredump collection m.chetan.kumar
2023-01-06 18:50 ` Jesse Brandeburg
2023-01-06 16:28 ` [PATCH v3 net-next 5/5] net: wwan: t7xx: Devlink documentation m.chetan.kumar
2023-01-06 18:37 ` Jesse Brandeburg
2023-01-08 14:20 ` Kumar, M Chetan
2023-01-09 3:48 ` Bagas Sanjaya
2023-01-09 16:07 ` Kumar, M Chetan [this message]
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=c7bd8511-7d4f-526a-28b9-215edc6e7c7f@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-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-mediatek@lists.infradead.org \
--cc=linuxwwan@intel.com \
--cc=linuxwwan_5g@intel.com \
--cc=loic.poulain@linaro.org \
--cc=matthias.bgg@gmail.com \
--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).