Hey,Agree this is OS related stuff. I was trying to make it more clean by explaining how it is implemented in linux. And if we were to implement the driver for another OS, there will be at least a default value for wp_on. I will remove any mention of module parameter from this doc.
On Tue, Jan 23, 2024 at 07:04:49PM -0800, David Regan wrote:
From: William Zhang <william.zhang@xxxxxxxxxxxx>
Update the descriptions to reflect different families of broadband SoC and
use the general name bcmbca for ARM based SoC.
Add brcm,nand-use-wp property to have an option for disabling this
feature on broadband board design that does not use write protection.
Add brcm,nand-ecc-use-strap to get ecc setting from board boot strap for
broadband board designs because they do not specify ecc setting in dts
but rather using the strap setting.
Remove the requirement of interrupts property to reflect the driver
code. Also add myself to the list of maintainers.
Signed-off-by: William Zhang <william.zhang@xxxxxxxxxxxx>
Reviewed-by: David Regan <dregan@xxxxxxxxxxxx>
---
Changes in v3:
- Update brcm,nand-use-wp description
- Revert the description change to BCM63168 SoC-specific NAND controller
---
Changes in v2:
- Revert the new compatible string nand-bcmbca
- Drop the BCM63168 compatible fix to avoid any potential ABI
incompatibility issue
- Simplify the explanation for brcm,nand-use-wp
- Keep the interrupt name requirement when interrupt number is specified
---
.../bindings/mtd/brcm,brcmnand.yaml | 37 ++++++++++++++++---
1 file changed, 32 insertions(+), 5 deletions(-)
diff --git a/Documentation/devicetree/bindings/mtd/brcm,brcmnand.yaml b/Documentation/devicetree/bindings/mtd/brcm,brcmnand.yaml
index f57e96374e67..752c6ee98a7d 100644
--- a/Documentation/devicetree/bindings/mtd/brcm,brcmnand.yaml
+++ b/Documentation/devicetree/bindings/mtd/brcm,brcmnand.yaml
@@ -9,6 +9,7 @@ title: Broadcom STB NAND Controller
maintainers:
- Brian Norris <computersforpeace@xxxxxxxxx>
- Kamal Dasu <kdasu.kdev@xxxxxxxxx>
+ - William Zhang <william.zhang@xxxxxxxxxxxx>
description: |
The Broadcom Set-Top Box NAND controller supports low-level access to raw NAND
@@ -18,9 +19,10 @@ description: |
supports basic PROGRAM and READ functions, among other features.
This controller was originally designed for STB SoCs (BCM7xxx) but is now
- available on a variety of Broadcom SoCs, including some BCM3xxx, BCM63xx, and
- iProc/Cygnus. Its history includes several similar (but not fully register
- compatible) versions.
+ available on a variety of Broadcom SoCs, including some BCM3xxx, MIPS based
+ Broadband SoC (BCM63xx), ARM based Broadband SoC (BCMBCA) and iProc/Cygnus.
+ Its history includes several similar (but not fully register compatible)
+ versions.
-- Additional SoC-specific NAND controller properties --
@@ -53,7 +55,7 @@ properties:
- brcm,brcmnand-v7.2
- brcm,brcmnand-v7.3
- const: brcm,brcmnand
- - description: BCM63138 SoC-specific NAND controller
+ - description: BCMBCA SoC-specific NAND controller
items:
- const: brcm,nand-bcm63138
- enum:
@@ -111,6 +113,20 @@ properties:
earlier versions of this core that include WP
type: boolean
+ brcm,nand-use-wp:
+ description:
+ Use this property to indicate if board design uses
+ controller's write protection feature and connects its
+ NAND_WPb pin to nand chip's WP_L pin.
By default the driver
+ uses a module parameter with default value set to enable to
+ control this feature for all boards. Use this dts property to
+ override the default behavior and enable/disable this feature
+ through board dts on a per board basis.
None of this information about module parameters is relevant in the
binding, as it should be independent of the implementation of one
particular operating system.
If the module parameter is not provided, what does the driver do?If I were to implement this from day one, I certainly will choose the same approach as you suggested here. But there is existing brcm,nand-has-wp property for other purpose and now if we have brcm,no-wp, it will be more confusing with that property IMHO. I prefer to keep use the "has" for feature availability and "use" for feature being used or not.
If "wp_on" is the module parameter, then the default is to enable the
write protection feature. If that's correct, it seems to me that the
property should be called something like "brcm,no-wp". This property
would be a boolean that indicates that the NAND_WPb and WP_L pins are
not connected & nothing more. Clearly if the module param tries to
enable WP and the DT property indicates that it is not supported you
can decline to enable the feature, but that is up to the drivers in
the OS to decide.
I don't understand why this is a software policy. This is the board design choice although it does override the driver default value. But it is still board or device setting and describe the hardware. OS has to follow this hardware configuration and set up accordingly.
+ Set to 0 if WP pins are not connected and feature is not
+ used. Set to 1 if WP pins are connected and feature is used.
As it stands, this property is firmly in the "software policy" side
of things, as it is being used as an override for a module parameter,
particularly given you have properties for each direction. Whether or
not the feature is to be used by the operating system is not relevant to
the binding.
use the auto detected ecc strength from the NAND chip ONFI parameter which is okay. But for BCABCM SoC and our reference board design, we don't use nand-ecc-strength and don't want to use the auto detected value(as they are typically minimum requirement) but rather use strap setting so I need a third choice.+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+
patternProperties:
"^nand@[a-f0-9]$":
type: object
@@ -137,6 +153,16 @@ patternProperties:
layout.
$ref: /schemas/types.yaml#/definitions/uint32
+ brcm,nand-ecc-use-strap:
+ description:
+ This flag is used by the driver to get the ecc strength and
+ spare area size from the SoC NAND boot strap setting. This
+ is commonly used by the BCMBCA SoC board design.
Quoting from v1, as I didn't get to it in time:
| > This property I'm not all that sure about either. If the specific
| > properties that you mention here are not set in the DT what happens at
| > the moment?
| >
| In that case, the ecc strength and oob size come from ONFI or nand id
| decoding. But that is usually the minimum requirement and user can
| choose to use stronger ecc as long as there is enough oob spare area in
| the nand chip.
|
| > I suppose what I am getting at is why are the bootstrap settings not
| > always used in the absence of specific values provided in the DT?
| >
| This is because the STB, iProc and other chip and their board design may
| not have or use the strap setting. But for BCMBCA SoC and board
| reference design, we always use the strap setting.
My main question here I suppose is why would you need this property at
all? If the specific properties are provided (nand-ecc-strength etc)
then use them, and if they are not use the strap settings?If nand-ecc-strength does not exist, the current driver implementation
If there's no properties and no strap settings, the this property doesTrue but manually setting nand-ecc-strength can be error prone like copy/paste error. The hardware strap setting does not involve such edit in the dts file so no error can happen.
not help. If there's properties and strap settings, but properties are
wrong, then you just have some devicetrees that incorrectly describe the
hardware and need to be fixed.
Again this is just for historic reason and BCMBCA as late player does not want to break any existing dts setting. So I thought it is useful to explain here. I can remove this text if you don't think it should be in the binding document.If ecc
+ strength and spare area size are set by nand-ecc-strength
+ and brcm,nand-oob-sector-size in the dts, these settings
+ have precedence and override this flag.
Again, IMO, this is not for the binding to decide. That is a decision
for the operating system to make.
I am confused!
+ $ref: /schemas/types.yaml#/definitions/flag
+
unevaluatedProperties: false
allOf:
@@ -177,6 +203,8 @@ allOf:
- const: iproc-idm
- const: iproc-ext
- if:
+ required:
+ - interrupts
properties:
interrupts:
minItems: 2
@@ -189,7 +217,6 @@ unevaluatedProperties: false
required:
- reg
- reg-names
- - interrupts
examples:
- |
--
2.37.3
Attachment:
smime.p7s
Description: S/MIME Cryptographic Signature