QSPIF: options to preset reset sequence for legacy SFDP #13399

LDong-Arm · 2020-08-07T15:36:27Z

Summary of changes

Fixes: #13129
(Special thanks to @keithmwheeler for the analysis, which I confirm.)

The first revision (1.0) of SFDP (ref: JESD216) does not include a field to indicate software reset support. The currently available document JESD216D from JEDEC has a change log at the end, and the first revision of the Basic Parameters Table has fewer entries than the location indicating software reset.

Some Mbed OS targets such as DISCO_F746NG include flashes with legacy SFDP, thus we add an option to preset the reset mode. Users of custom targets can utilise this option too.

To use, set options to your application's mbed_app.json:

If your QSPI flash has an enable + reset sequence (0x66 followed by 0x99)

    "target_overrides": {
        "<YOUR_TARGET>": {
            "enable-and-reset": true
        }
    }

If your QSPI flash requires a single reset command (0xF0)

    "target_overrides": {
        "<YOUR_TARGET>": {
            "direct-reset": true
        }
    }

Don't set either option if your device's SFDP is the second revision (1.5 as SFDP reports) or newer - the reset sequence should be automatically determined at run time.

Please consult your flash device's data sheet to determine the reset sequence.

Impact of changes

No impact on existing applications
Fixes QSPIF on DISCO_F746NG (which I have one)
Users of other flash devices (e.g. custom targets, shields, etc.) with legacy SFDP can use the added options to fix initialisation issues

Migration actions required

None for targets that already work properly with QSPIF. See PR description for how to use the added options.

Documentation

See the PR description, or mbed_lib.json for QSPIF.

Pull request type

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[] No Tests required for this change (E.g docs only update)
[x] Covered by existing mbed-os tests (Greentea or Unittest)
[x] Tests / results supplied as part of this PR

Fixes the issue on my local DISCO_F746NG.

Reviewers

@ARMmbed/mbed-os-core, @geky, @ARMmbed/mbed-os-storage

ciarmcom · 2020-08-07T17:00:29Z

@LDong-Arm, thank you for your changes.
@geky @ARMmbed/mbed-os-maintainers please review.

storage/blockdevice/COMPONENT_QSPIF/mbed_lib.json

jeromecoutant

NB: no test done

adbridge · 2020-08-12T11:53:45Z

@LDong-Arm why have you marked this as a feature PR?

LDong-Arm · 2020-08-12T11:56:56Z

@LDong-Arm why have you marked this as a feature PR?

It's a new configuration to enable support for some legacy flashes, rather than fixing an error in our code. Since it fixes the support for an existing flash controller in Mbed OS, would you prefer marking it as a fix instead?

adbridge · 2020-08-12T12:34:29Z

@LDong-Arm why have you marked this as a feature PR?

It's a new configuration to enable support for some legacy flashes, rather than fixing an error in our code. Since it fixes the support for an existing flash controller in Mbed OS, would you prefer marking it as a fix instead?

Unless it does one of these things "New feature / Functionality change / New API" then it is a patch (I'm ruling out major as that's way more significant)

LDong-Arm · 2020-08-12T12:52:06Z

Unless it does one of these things "New feature / Functionality change / New API" then it is a patch (I'm ruling out major as that's way more significant)

Fair enough, I've changed it.

evedon

Excellent work @LDong-Arm !

evedon · 2020-08-18T14:23:42Z

Unless it does one of these things "New feature / Functionality change / New API" then it is a patch (I'm ruling out major as that's way more significant)

Fair enough, I've changed it.

@adbridge Note that label should be updated.

0xc0170 · 2020-08-19T13:37:18Z

CI started

mbed-ci · 2020-08-19T14:31:46Z

Jenkins CI Test : ❌ FAILED

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs	Status
jenkins-ci/mbed-os-ci_unittests	✔️
jenkins-ci/mbed-os-ci_build-ARM	✔️
jenkins-ci/mbed-os-ci_build-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_dynamic-memory-usage	✔️
jenkins-ci/mbed-os-ci_greentea-test	✔️
jenkins-ci/mbed-os-ci_cloud-client-pytest	❌

LDong-Arm · 2020-08-20T11:58:57Z

@adbridge @0xc0170 The client test failed with

timeout_error_msg = "Didn't find client registered in 300 s"

Doesn't look related to this change?

adbridge · 2020-08-20T12:08:25Z

@LDong-Arm will try re-running ci

mbed-ci · 2020-08-20T12:55:01Z

Jenkins CI Test : ✔️ SUCCESS

Build Number: 2 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs	Status
jenkins-ci/mbed-os-ci_unittests	✔️
jenkins-ci/mbed-os-ci_build-ARM	✔️
jenkins-ci/mbed-os-ci_build-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_greentea-test	✔️
jenkins-ci/mbed-os-ci_dynamic-memory-usage	✔️
jenkins-ci/mbed-os-ci_cloud-client-pytest	✔️

mergify · 2020-08-21T09:43:37Z

This PR cannot be merged due to conflicts. Please rebase to resolve them.

The first revision (1.0) of SFDP (ref: JESD216) does not include fields for software reset support. It's only been added in the second revision (1.5) (ref: JESD216A). Some Mbed OS targets such as DISCO_F746NG include flashes with legacy SFDP, thus we add an option to preset the reset mode.

LDong-Arm · 2020-08-21T10:39:01Z

Rebased

Pull request has been modified.

0xc0170 · 2020-08-21T12:38:47Z

CI started

mbed-ci · 2020-08-21T13:22:49Z

Jenkins CI Test : ✔️ SUCCESS

Build Number: 3 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs	Status
jenkins-ci/mbed-os-ci_unittests	✔️
jenkins-ci/mbed-os-ci_build-ARM	✔️
jenkins-ci/mbed-os-ci_build-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_dynamic-memory-usage	✔️
jenkins-ci/mbed-os-ci_greentea-test	✔️
jenkins-ci/mbed-os-ci_cloud-client-pytest	✔️

LDong-Arm mentioned this pull request Aug 7, 2020

Error with mbed 6.0, gcc 9.2 and GD25Q16 QSPI Flash -- incorrect SFDP parsing from QSPIFBlock #13129

Closed

ciarmcom added the release-type: feature label Aug 7, 2020

ciarmcom requested review from geky and a team August 7, 2020 17:00

ciarmcom added the needs: review label Aug 7, 2020

jeromecoutant suggested changes Aug 10, 2020

View reviewed changes

storage/blockdevice/COMPONENT_QSPIF/mbed_lib.json Outdated Show resolved Hide resolved

LDong-Arm force-pushed the sfdp_legacy branch from e2cd581 to 0745706 Compare August 10, 2020 09:43

LDong-Arm requested a review from jeromecoutant August 10, 2020 09:44

jeromecoutant approved these changes Aug 10, 2020

View reviewed changes

evedon previously approved these changes Aug 18, 2020

View reviewed changes

mergify bot added needs: CI and removed needs: review labels Aug 18, 2020

adbridge added release-type: patch Indentifies a PR as containing just a patch and removed release-type: feature labels Aug 18, 2020

mergify bot added needs: work and removed needs: CI labels Aug 19, 2020

adbridge added needs: CI and removed needs: work labels Aug 20, 2020

mergify bot added the ready for merge label Aug 20, 2020

mergify bot added needs: work and removed needs: CI labels Aug 20, 2020

LDong-Arm force-pushed the sfdp_legacy branch from 0745706 to 61fd872 Compare August 21, 2020 10:38

0xc0170 added needs: CI and removed needs: work ready for merge labels Aug 21, 2020

0xc0170 approved these changes Aug 21, 2020

View reviewed changes

0xc0170 removed the needs: CI label Aug 21, 2020

mergify bot added the ready for merge label Aug 21, 2020

0xc0170 merged commit 1c0318c into ARMmbed:master Aug 21, 2020

mergify bot removed the ready for merge label Aug 21, 2020

mbedmain added release-version: 6.3.0 Release-pending and removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Sep 14, 2020

QSPIF: options to preset reset sequence for legacy SFDP #13399

QSPIF: options to preset reset sequence for legacy SFDP #13399

Uh oh!

Conversation

LDong-Arm commented Aug 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Impact of changes

Migration actions required

Documentation

Pull request type

Test results

Reviewers

Uh oh!

ciarmcom commented Aug 7, 2020

Uh oh!

Uh oh!

jeromecoutant left a comment

Choose a reason for hiding this comment

Uh oh!

adbridge commented Aug 12, 2020

Uh oh!

LDong-Arm commented Aug 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adbridge commented Aug 12, 2020

Uh oh!

LDong-Arm commented Aug 12, 2020

Uh oh!

evedon left a comment

Choose a reason for hiding this comment

Uh oh!

evedon commented Aug 18, 2020

Uh oh!

0xc0170 commented Aug 19, 2020

Uh oh!

mbed-ci commented Aug 19, 2020

Jenkins CI Test : ❌ FAILED

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

Uh oh!

LDong-Arm commented Aug 20, 2020

Uh oh!

adbridge commented Aug 20, 2020

Uh oh!

mbed-ci commented Aug 20, 2020

Jenkins CI Test : ✔️ SUCCESS

Build Number: 2 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

Uh oh!

mergify bot commented Aug 21, 2020

Uh oh!

LDong-Arm commented Aug 21, 2020

Uh oh!

0xc0170 commented Aug 21, 2020

Uh oh!

mbed-ci commented Aug 21, 2020

Jenkins CI Test : ✔️ SUCCESS

Build Number: 3 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

Uh oh!

Uh oh!

LDong-Arm commented Aug 7, 2020 •

edited

Loading

LDong-Arm commented Aug 12, 2020 •

edited

Loading