[PATCH v2 0/2] brcmfmac: support parse country code map from DT

[PATCH v2 0/2] brcmfmac: support parse country code map from DT

[Shawn Guo]

This is a couple of patches adding optional brcm,ccode-map bindings for
brcmfmac driver to parse country code map from DT.

Changes for v2:
 - Rebase bindings patch on top of yaml conversion patch [1].
 - Improve commit log with Arend's explanation on why this data could
   be put in device tree.
 - Use pattern to define mapping string as suggested by Rob.
 - Use brcmf_err() instead of dev_warn() and print error code.
 - Use sscanf() to validate mapping string.
 - Use brcmf_dbg(INFO, ...) to print country code entry.
 - Separate BRCMF_BUSTYPE_SDIO bus_type check from general DT validation.

[1] https://patchwork.kernel.org/project/linux-wireless/patch/20210315105911.138553-1-linus.walleij@linaro.org/


Shawn Guo (2):
  dt-bindings: bcm4329-fmac: add optional brcm,ccode-map
  brcmfmac: support parse country code map from DT

 .../net/wireless/brcm,bcm4329-fmac.yaml       |  8 +++
 .../wireless/broadcom/brcm80211/brcmfmac/of.c | 57 ++++++++++++++++++-
 2 files changed, 63 insertions(+), 2 deletions(-)

-- 
2.17.1

[PATCH v2 1/2] dt-bindings: bcm4329-fmac: add optional brcm,ccode-map

[Shawn Guo]

Add optional brcm,ccode-map property to support translation from ISO3166
country code to brcmfmac firmware country code and revision.

The country revision is needed because the RF parameters that provide
regulatory compliance are tweaked per platform/customer.  So depending
on the RF path tight to the chip, certain country revision needs to be
specified.  As such they could be seen as device specific calibration
data which is a good fit into device tree.

Signed-off-by: Shawn Guo <shawn.guo@linaro.org>
Reviewed-by: Arend van Spriel <arend.vanspriel@broadcom.com>
---
 .../bindings/net/wireless/brcm,bcm4329-fmac.yaml          | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/devicetree/bindings/net/wireless/brcm,bcm4329-fmac.yaml b/Documentation/devicetree/bindings/net/wireless/brcm,bcm4329-fmac.yaml
index b5fcc73ce6be..c11f23b20c4c 100644
--- a/Documentation/devicetree/bindings/net/wireless/brcm,bcm4329-fmac.yaml
+++ b/Documentation/devicetree/bindings/net/wireless/brcm,bcm4329-fmac.yaml
@@ -68,6 +68,13 @@ properties:
     description: A GPIO line connected to the WL_RST line, if present
       this shall be flagged as active low.
 
+  brcm,ccode-map:
+    $ref: /schemas/types.yaml#/definitions/string-array
+    description: Multiple strings for translating ISO3166 country code to
+      brcmfmac firmware country code and revision.
+    items:
+      pattern: '^[A-Z][A-Z]-[A-Z][0-9A-Z]-[0-9]+$'
+
 required:
   - compatible
   - reg
@@ -97,5 +104,6 @@ examples:
         interrupts = <24 IRQ_TYPE_EDGE_FALLING>;
         interrupt-names = "host-wake";
         reset-gpios = <&gpio 23 GPIO_ACTIVE_LOW>;
+        brcm,ccode-map = "JP-JP-78", "US-Q2-86";
       };
     };
-- 
2.17.1

[PATCH v2 2/2] brcmfmac: support parse country code map from DT

[Shawn Guo]

With any regulatory domain requests coming from either user space or
802.11 IE (Information Element), the country is coded in ISO3166
standard.  It needs to be translated to firmware country code and
revision with the mapping info in settings->country_codes table.
Support populate country_codes table by parsing the mapping from DT.

The BRCMF_BUSTYPE_SDIO bus_type check gets separated from general DT
validation, so that country code can be handled as general part rather
than SDIO bus specific one.

Signed-off-by: Shawn Guo <shawn.guo@linaro.org>
Reviewed-by: Arend van Spriel <arend.vanspriel@broadcom.com>
---
 .../wireless/broadcom/brcm80211/brcmfmac/of.c | 57 ++++++++++++++++++-
 1 file changed, 55 insertions(+), 2 deletions(-)

diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
index a7554265f95f..dd99ac3410e3 100644
--- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
+++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
@@ -12,12 +12,59 @@
 #include "common.h"
 #include "of.h"
 
+static int brcmf_of_get_country_codes(struct device *dev,
+				      struct brcmf_mp_device *settings)
+{
+	struct device_node *np = dev->of_node;
+	struct brcmfmac_pd_cc_entry *cce;
+	struct brcmfmac_pd_cc *cc;
+	int count;
+	int i;
+
+	count = of_property_count_strings(np, "brcm,ccode-map");
+	if (count < 0) {
+		/* The property is optional, so return success if it doesn't
+		 * exist. Otherwise propagate the error code.
+		 */
+		return (count == -EINVAL) ? 0 : count;
+	}
+
+	cc = devm_kzalloc(dev, sizeof(*cc) + count * sizeof(*cce), GFP_KERNEL);
+	if (!cc)
+		return -ENOMEM;
+
+	cc->table_size = count;
+
+	for (i = 0; i < count; i++) {
+		const char *map;
+
+		cce = &cc->table[i];
+
+		if (of_property_read_string_index(np, "brcm,ccode-map",
+						  i, &map))
+			continue;
+
+		/* String format e.g. US-Q2-86 */
+		if (sscanf(map, "%2c-%2c-%d", cce->iso3166, cce->cc,
+			   &cce->rev) != 3)
+			brcmf_err("failed to read country map %s\n", map);
+		else
+			brcmf_dbg(INFO, "%s-%s-%d", cce->iso3166, cce->cc,
+				  cce->rev);
+	}
+
+	settings->country_codes = cc;
+
+	return 0;
+}
+
 void brcmf_of_probe(struct device *dev, enum brcmf_bus_type bus_type,
 		    struct brcmf_mp_device *settings)
 {
 	struct brcmfmac_sdio_pd *sdio = &settings->bus.sdio;
 	struct device_node *root, *np = dev->of_node;
 	int irq;
+	int err;
 	u32 irqf;
 	u32 val;
 
@@ -43,8 +90,14 @@ void brcmf_of_probe(struct device *dev, enum brcmf_bus_type bus_type,
 		of_node_put(root);
 	}
 
-	if (!np || bus_type != BRCMF_BUSTYPE_SDIO ||
-	    !of_device_is_compatible(np, "brcm,bcm4329-fmac"))
+	if (!np || !of_device_is_compatible(np, "brcm,bcm4329-fmac"))
+		return;
+
+	err = brcmf_of_get_country_codes(dev, settings);
+	if (err)
+		brcmf_err("failed to get OF country code map (err=%d)\n", err);
+
+	if (bus_type != BRCMF_BUSTYPE_SDIO)
 		return;
 
 	if (of_property_read_u32(np, "brcm,drive-strength", &val) == 0)
-- 
2.17.1

Re: [PATCH v2 0/2] brcmfmac: support parse country code map from DT

[Rob Herring]

On Thu, Apr 15, 2021 at 06:47:26PM +0800, Shawn Guo wrote:
> This is a couple of patches adding optional brcm,ccode-map bindings for
> brcmfmac driver to parse country code map from DT.
> 
> Changes for v2:
>  - Rebase bindings patch on top of yaml conversion patch [1].
>  - Improve commit log with Arend's explanation on why this data could
>    be put in device tree.
>  - Use pattern to define mapping string as suggested by Rob.
>  - Use brcmf_err() instead of dev_warn() and print error code.
>  - Use sscanf() to validate mapping string.
>  - Use brcmf_dbg(INFO, ...) to print country code entry.
>  - Separate BRCMF_BUSTYPE_SDIO bus_type check from general DT validation.
> 
> [1] https://patchwork.kernel.org/project/linux-wireless/patch/20210315105911.138553-1-linus.walleij@linaro.org/

As that's in my tree, I'm applying patch 1. Patch 2 should go via the 
wireless tree.

Rob

Re: [PATCH v2 1/2] dt-bindings: bcm4329-fmac: add optional brcm,ccode-map

[Rob Herring]

On Thu, 15 Apr 2021 18:47:27 +0800, Shawn Guo wrote:
> Add optional brcm,ccode-map property to support translation from ISO3166
> country code to brcmfmac firmware country code and revision.
> 
> The country revision is needed because the RF parameters that provide
> regulatory compliance are tweaked per platform/customer.  So depending
> on the RF path tight to the chip, certain country revision needs to be
> specified.  As such they could be seen as device specific calibration
> data which is a good fit into device tree.
> 
> Signed-off-by: Shawn Guo <shawn.guo@linaro.org>
> Reviewed-by: Arend van Spriel <arend.vanspriel@broadcom.com>
> ---
>  .../bindings/net/wireless/brcm,bcm4329-fmac.yaml          | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 

Applied, thanks!

Re: [PATCH v2 2/2] brcmfmac: support parse country code map from DT

[Arend Van Spriel]

[-- Attachment #1: Type: text/plain, Size: 3257 bytes --]

On 4/15/2021 12:47 PM, Shawn Guo wrote:
> With any regulatory domain requests coming from either user space or
> 802.11 IE (Information Element), the country is coded in ISO3166
> standard.  It needs to be translated to firmware country code and
> revision with the mapping info in settings->country_codes table.
> Support populate country_codes table by parsing the mapping from DT.
> 
> The BRCMF_BUSTYPE_SDIO bus_type check gets separated from general DT
> validation, so that country code can be handled as general part rather
> than SDIO bus specific one.

Had another look....

> Signed-off-by: Shawn Guo <shawn.guo@linaro.org>
> Reviewed-by: Arend van Spriel <arend.vanspriel@broadcom.com>
> ---
>   .../wireless/broadcom/brcm80211/brcmfmac/of.c | 57 ++++++++++++++++++-
>   1 file changed, 55 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
> index a7554265f95f..dd99ac3410e3 100644
> --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
> +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
> @@ -12,12 +12,59 @@
>   #include "common.h"
>   #include "of.h"
>   
> +static int brcmf_of_get_country_codes(struct device *dev,
> +				      struct brcmf_mp_device *settings)
> +{
> +	struct device_node *np = dev->of_node;
> +	struct brcmfmac_pd_cc_entry *cce;
> +	struct brcmfmac_pd_cc *cc;
> +	int count;
> +	int i;
> +
> +	count = of_property_count_strings(np, "brcm,ccode-map");
> +	if (count < 0) {
> +		/* The property is optional, so return success if it doesn't
> +		 * exist. Otherwise propagate the error code.
> +		 */
> +		return (count == -EINVAL) ? 0 : count;
> +	}
> +
> +	cc = devm_kzalloc(dev, sizeof(*cc) + count * sizeof(*cce), GFP_KERNEL);
> +	if (!cc)
> +		return -ENOMEM;
> +
> +	cc->table_size = count;
> +
> +	for (i = 0; i < count; i++) {
> +		const char *map;
> +
> +		cce = &cc->table[i];
> +
> +		if (of_property_read_string_index(np, "brcm,ccode-map",
> +						  i, &map))
> +			continue;
> +
> +		/* String format e.g. US-Q2-86 */
> +		if (sscanf(map, "%2c-%2c-%d", cce->iso3166, cce->cc,
> +			   &cce->rev) != 3)
> +			brcmf_err("failed to read country map %s\n", map);
> +		else
> +			brcmf_dbg(INFO, "%s-%s-%d", cce->iso3166, cce->cc,
> +				  cce->rev);

... and here you are missing terminating '\n' in format string.

Regards,
Arend

> +	}
> +
> +	settings->country_codes = cc;
> +
> +	return 0;
> +}
> +

-- 
This electronic communication and the information and any files transmitted 
with it, or attached to it, are confidential and are intended solely for 
the use of the individual or entity to whom it is addressed and may contain 
information that is confidential, legally privileged, protected by privacy 
laws, or otherwise restricted from disclosure to anyone else. If you are 
not the intended recipient or the person responsible for delivering the 
e-mail to the intended recipient, you are hereby notified that any use, 
copying, distributing, dissemination, forwarding, printing, or copying of 
this e-mail is strictly prohibited. If you received this e-mail in error, 
please return the e-mail to the sender, delete it from your computer, and 
destroy any printed copy of it.

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4219 bytes --]

Re: [PATCH v2 2/2] brcmfmac: support parse country code map from DT

[Shawn Guo]

On Fri, Apr 16, 2021 at 2:00 PM Arend Van Spriel
<arend.vanspriel@broadcom.com> wrote:
>
> On 4/15/2021 12:47 PM, Shawn Guo wrote:
> > With any regulatory domain requests coming from either user space or
> > 802.11 IE (Information Element), the country is coded in ISO3166
> > standard.  It needs to be translated to firmware country code and
> > revision with the mapping info in settings->country_codes table.
> > Support populate country_codes table by parsing the mapping from DT.
> >
> > The BRCMF_BUSTYPE_SDIO bus_type check gets separated from general DT
> > validation, so that country code can be handled as general part rather
> > than SDIO bus specific one.
>
> Had another look....
>
> > Signed-off-by: Shawn Guo <shawn.guo@linaro.org>
> > Reviewed-by: Arend van Spriel <arend.vanspriel@broadcom.com>
> > ---
> >   .../wireless/broadcom/brcm80211/brcmfmac/of.c | 57 ++++++++++++++++++-
> >   1 file changed, 55 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
> > index a7554265f95f..dd99ac3410e3 100644
> > --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
> > +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/of.c
> > @@ -12,12 +12,59 @@
> >   #include "common.h"
> >   #include "of.h"
> >
> > +static int brcmf_of_get_country_codes(struct device *dev,
> > +                                   struct brcmf_mp_device *settings)
> > +{
> > +     struct device_node *np = dev->of_node;
> > +     struct brcmfmac_pd_cc_entry *cce;
> > +     struct brcmfmac_pd_cc *cc;
> > +     int count;
> > +     int i;
> > +
> > +     count = of_property_count_strings(np, "brcm,ccode-map");
> > +     if (count < 0) {
> > +             /* The property is optional, so return success if it doesn't
> > +              * exist. Otherwise propagate the error code.
> > +              */
> > +             return (count == -EINVAL) ? 0 : count;
> > +     }
> > +
> > +     cc = devm_kzalloc(dev, sizeof(*cc) + count * sizeof(*cce), GFP_KERNEL);
> > +     if (!cc)
> > +             return -ENOMEM;
> > +
> > +     cc->table_size = count;
> > +
> > +     for (i = 0; i < count; i++) {
> > +             const char *map;
> > +
> > +             cce = &cc->table[i];
> > +
> > +             if (of_property_read_string_index(np, "brcm,ccode-map",
> > +                                               i, &map))
> > +                     continue;
> > +
> > +             /* String format e.g. US-Q2-86 */
> > +             if (sscanf(map, "%2c-%2c-%d", cce->iso3166, cce->cc,
> > +                        &cce->rev) != 3)
> > +                     brcmf_err("failed to read country map %s\n", map);
> > +             else
> > +                     brcmf_dbg(INFO, "%s-%s-%d", cce->iso3166, cce->cc,
> > +                               cce->rev);
>
> ... and here you are missing terminating '\n' in format string.

Oops!  Will fix it with v3.

Shawn