linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jerome Pouiller <Jerome.Pouiller@silabs.com>
To: devel@driverdev.osuosl.org, linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Kalle Valo" <kvalo@codeaurora.org>,
	"David S . Miller" <davem@davemloft.net>,
	"Jérôme Pouiller" <jerome.pouiller@silabs.com>
Subject: [PATCH v2 30/33] staging: wfx: explain the purpose of wfx_send_pds()
Date: Mon, 13 Sep 2021 10:30:42 +0200	[thread overview]
Message-ID: <20210913083045.1881321-31-Jerome.Pouiller@silabs.com> (raw)
In-Reply-To: <20210913083045.1881321-1-Jerome.Pouiller@silabs.com>

From: Jérôme Pouiller <jerome.pouiller@silabs.com>

On first look, the goal of wfx_send_pds() is not obvious. A small
explanation is welcomed.

Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com>
---
 drivers/staging/wfx/main.c | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/wfx/main.c b/drivers/staging/wfx/main.c
index 83292544b10a..4386e9957ee6 100644
--- a/drivers/staging/wfx/main.c
+++ b/drivers/staging/wfx/main.c
@@ -163,7 +163,20 @@ bool wfx_api_older_than(struct wfx_dev *wdev, int major, int minor)
 	return false;
 }
 
-/* NOTE: wfx_send_pds() destroy buf */
+/* The device needs data about the antenna configuration. This information in
+ * provided by PDS (Platform Data Set, this is the wording used in WF200
+ * documentation) files. For hardware integrators, the full process to create
+ * PDS files is described here:
+ *   https:github.com/SiliconLabs/wfx-firmware/blob/master/PDS/README.md
+ *
+ * So this function aims to send PDS to the device. However, the PDS file is
+ * often bigger than Rx buffers of the chip, so it has to be sent in multiple
+ * parts.
+ *
+ * In add, the PDS data cannot be split anywhere. The PDS files contains tree
+ * structures. Braces are used to enter/leave a level of the tree (in a JSON
+ * fashion). PDS files can only been split between root nodes.
+ */
 int wfx_send_pds(struct wfx_dev *wdev, u8 *buf, size_t len)
 {
 	int ret;
-- 
2.33.0


  parent reply	other threads:[~2021-09-13  8:34 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-13  8:30 [PATCH v2 00/33] staging/wfx: usual maintenance Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 01/33] staging: wfx: use abbreviated message for "incorrect sequence" Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 02/33] staging: wfx: do not send CAB while scanning Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 03/33] staging: wfx: ignore PS when STA/AP share same channel Jerome Pouiller
2021-09-13  9:33   ` Dan Carpenter
2021-09-13 10:36     ` Jérôme Pouiller
2021-09-13 10:42       ` Dan Carpenter
2021-09-13  8:30 ` [PATCH v2 04/33] staging: wfx: wait for SCAN_CMPL after a SCAN_STOP Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 05/33] staging: wfx: avoid possible lock-up during scan Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 06/33] staging: wfx: drop unused argument from hif_scan() Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 07/33] staging: wfx: fix atomic accesses in wfx_tx_queue_empty() Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 08/33] staging: wfx: take advantage of wfx_tx_queue_empty() Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 09/33] staging: wfx: declare support for TDLS Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 10/33] staging: wfx: fix support for CSA Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 11/33] staging: wfx: relax the PDS existence constraint Jerome Pouiller
2021-09-13  9:58   ` Dan Carpenter
2021-09-13  8:30 ` [PATCH v2 12/33] staging: wfx: simplify API coherency check Jerome Pouiller
2021-09-13 10:02   ` Dan Carpenter
2021-09-13  8:30 ` [PATCH v2 13/33] staging: wfx: update with the firmware API 3.8 Jerome Pouiller
2021-09-13 10:06   ` Dan Carpenter
2021-09-13  8:30 ` [PATCH v2 14/33] staging: wfx: uniformize counter names Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 15/33] staging: wfx: fix misleading 'rate_id' usage Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 16/33] staging: wfx: declare variables at beginning of functions Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 17/33] staging: wfx: simplify hif_join() Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 18/33] staging: wfx: reorder function for slightly better eye candy Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 19/33] staging: wfx: fix error names Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 20/33] staging: wfx: apply naming rules in hif_tx_mib.c Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 21/33] staging: wfx: remove unused definition Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 22/33] staging: wfx: remove useless debug statement Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 23/33] staging: wfx: fix space after cast operator Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 24/33] staging: wfx: remove references to WFxxx in comments Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 25/33] staging: wfx: update files descriptions Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 26/33] staging: wfx: reformat comment Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 27/33] staging: wfx: avoid c99 comments Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 28/33] staging: wfx: fix comments styles Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 29/33] staging: wfx: remove useless comments after #endif Jerome Pouiller
2021-09-13  8:30 ` Jerome Pouiller [this message]
2021-09-13  8:30 ` [PATCH v2 31/33] staging: wfx: indent functions arguments Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 32/33] staging: wfx: ensure IRQ is ready before enabling it Jerome Pouiller
2021-09-13  8:30 ` [PATCH v2 33/33] staging: wfx: early exit of PDS is not correct Jerome Pouiller

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=20210913083045.1881321-31-Jerome.Pouiller@silabs.com \
    --to=jerome.pouiller@silabs.com \
    --cc=davem@davemloft.net \
    --cc=devel@driverdev.osuosl.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=kvalo@codeaurora.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    /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).