59 Commits
Author SHA1 Message Date
Frédéric Desbiens 9f1cfdc181 Merge pull request #80 from fdesbiens/update/security-policy
Updated security policy
2026-06-30 17:34:47 -04:00
Frédéric DesbiensandCodex 37dd169031 Updated security policy
Co-authored-by: Codex <codex@openai.com>
2026-06-30 17:29:08 -04:00
Frédéric Desbiens 4005a425b7 Merging changes for the v.6.5.1.202602 release (#75) 2026-06-08 10:16:43 +02:00
Frédéric DesbiensandCopilot 123218cc51 Added copyright headers to files missing them
Applied the standard MIT license header to all project-owned C, header,
assembly, shell, and Python files that were missing a copyright notice.
Third-party, toolchain startup, and auto-generated files were excluded.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-06 21:48:12 +02:00
Frédéric DesbiensandCopilot b9f54b87bb Updated version number constants (#74)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-04 17:12:31 -04:00
Frédéric DesbiensandCopilot 2e061ba319 Added a release preparation script (#73)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-04 17:11:35 -04:00
Frédéric DesbiensandCopilot bfb39676df Added opt-in lazy sector release to reduce O(N²) deletion (issue #70) (#71)
WARNING: This feature is brand new and has not been tested beyond the
existing regression suite.  It should be thoroughly tested — including
stress, power-loss, and wear-levelling scenarios — before being used in
any production system.

When LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE is defined and free blocks
exceed LX_NAND_FLASH_SECTOR_RELEASE_LAZY_THRESHOLD (default 10), releasing
a sector from a full block defers the copy+erase.  A tombstone page is
written to a freshly-allocated block; the old full block is flagged
COMPACTION_PENDING in its block status and recorded in a new per-LG
compaction table.  Compaction (merge + erase) is triggered lazily:

  * sector_write: before writing to a full block with a pending source
  * block_data_move: intercepts wear-levelling moves for pending LGs
  * defragment: iterates all pending LGs (now actually implemented)
  * block_allocate: emergency compaction when the free list is empty

Reads transparently fall back to the compaction-pending block when the
primary block does not contain the requested sector.

Crash recovery is handled in open_extended:
  - Phase 1: detects COMPACTION_PENDING blocks and either clears the flag
    (crash before mapping update — abort) or rebuilds compaction_table
    (crash after mapping update — resume deferred compaction).
  - Phase 2: erases orphaned ALLOCATED blocks not present in any mapping.

Without the flag, all paths remain unchanged and defragment returns
LX_NOT_SUPPORTED as before.

Fixes: https://github.com/eclipse-threadx/levelx/issues/70

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-02 11:25:12 -04:00
Frédéric Desbiens a46b74fb8a Merge pull request #69 from eclipse-threadx/dev
Merge changes ahead of the v6.5.0.202601 release
2026-03-06 19:43:03 +01:00
Frédéric Desbiens b80f28e0e6 Merge pull request #68 from fdesbiens/dev
Updated copyright headers and version number constants
2026-03-05 09:39:50 +01:00
Frédéric Desbiens f98a5c4eb8 Updated version number constants. 2026-03-05 09:23:24 +01:00
Frédéric Desbiens b9ba4a97bf Updated copyright headers and removed trailing whitespace 2026-03-05 09:17:20 +01:00
Frédéric Desbiens fa1a8e5ff4 Merge pull request #65 from borlandong/fix-performance-issue
Updated the logic to skip unnecessary main data read in _lx_nand_flash_sector_read
2026-02-17 11:38:13 -05:00
Frédéric Desbiens 89c745fcf5 Merge pull request #66 from rahmanih/update_nand_simulator
Updated the nand flash simulator
2026-02-17 11:36:36 -05:00
Haithem Rahmani 4782f22568 update nand flash simulator
align the nand flash simulator against the PR #65

Tests:
Total Test time (real) =   6.33 sec
~/work/git_repos/github/eclipse/levelx_rahmanih/test/cmake
3/3 Test #1: default_build_coverage::levelx_nand_flash_test ........   Passed   44.06 sec

100% tests passed, 0 tests failed out of 3
2026-02-10 09:28:48 +01:00
borlandong 58dc81e83c perf: skip unnecessary main data read in _lx_nand_flash_sector_read 2026-01-22 12:09:25 +08:00
Frédéric Desbiens 1751446fb0 Merge pull request #63 from eclipse-threadx/dev
Merge changes ahead of the 202504 release
2026-01-12 18:05:43 -05:00
Frédéric Desbiens c27eb52bd2 Updated version number constants 2026-01-12 18:01:37 -05:00
Frédéric Desbiens c03223909a Merge pull request #62 from rahmanih/fix_nor_flash_format
Fix: force initial erase count to 1
2026-01-12 17:55:06 -05:00
Haithem Rahmani 9bf1c24243 fix: force initial erase count to 1
for each erased block write the word (1 | LX_NOR_ERASED) at the
first word. this is actually equivalent to 0x80000001.
When the lx_nor_flash_open_extended() is called, only the erase count will remain
valid.

Remove the LX_DISABLE/LX_RESTORE sequence.
2026-01-08 10:36:43 +01:00
Frédéric Desbiens 6a534bed34 Update minimal CMake version in CMakeLists.txt to 3.13 2025-11-25 10:48:08 -05:00
Frédéric Desbiens 4585b92f15 Update minimal CMake version in CMakeLists.txt to 3.13 2025-11-25 10:45:08 -05:00
Frédéric Desbiens 63ed12cfd6 Merge pull request #60 from rahmanih/add_new_level_apis_pr
New APIs:
- lx_nor_flash_format(): setup the NOR Flash for a new and fresh filesystem.
- lx_nor_flash_open_extended(): adds a user data pointer that could be passed to the underlying low-level NOR driver.
-  lx_nand_flash_open_extended(): adds a user data pointer that could be passed to the underlying low-level NAND driver.

Updated APIs:
- lx_nor_flash_open(): call the lx_nor_flash_open_extended() with a NULL as user data pointer.
- lx_nand_flash_open(): call the lx_nand_flash_open_extended() with a NULL as user data pointer.
2025-11-25 10:40:13 -05:00
Frédéric Desbiens a1761869fd Merge pull request #59 from rahmanih/fix_issue_58
fix: "array out of bounds" error leading to memory corruption
2025-11-25 10:09:17 -05:00
Frédéric Desbiens 5783f64fe1 Merge pull request #61 from rahmanih/fix_issue_53
fix: Wrong out-of-range check in lx_nand_flash_block_find.
2025-11-25 09:59:41 -05:00
Haithem Rahmani 47b2a17d4b Add new levelx APIs
New APIs
--------
- lx_nor_flash_format(): erases nor flash blocks and setup block metadata
- lx_nor_flash_open_extended(): same as lx_nor_flash_open() with
  user data pointer a last argument.
- lx_nand_flash_open_extended(): same as lx_nand_flash_open() with
  user data pointer a last argument.

Updates
-------
- lx_nor_flash_open(): calls lx_nor_flash_open_extended() with a NULL as
  last argument
- lx_nand_flash_open(): calls lx_nand_flash_open_extended() with a NULL as
  last argument
- regression tests: to call the lx_nor_flash_format()

Test results
-------------
100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.27 sec
3/3 Test #1: standalone_free_sector_verify_build::levelx_nand_flash_test ........   Passed    6.29 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.29 sec
3/3 Test #1: nor_obsolete_mapping_cache_build::levelx_nand_flash_test ........   Passed    6.58 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.58 sec
3/3 Test #1: nor_obsolete_cache_build::levelx_nand_flash_test ........   Passed    6.67 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.67 sec
3/3 Test #1: nor_mapping_cache_build::levelx_nand_flash_test ........   Passed    6.77 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.78 sec
3/3 Test #1: full_build::levelx_nand_flash_test ........   Passed    6.91 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.91 sec
3/3 Test #1: free_sector_verify_build::levelx_nand_flash_test ........   Passed    7.14 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   7.14 sec
3/3 Test #1: standalone_full_build::levelx_nand_flash_test ........   Passed    7.21 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   7.21 sec
3/3 Test #1: standalone_build::levelx_nand_flash_test ........   Passed   12.05 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =  12.06 sec
3/3 Test #1: default_build_coverage::levelx_nand_flash_test ........   Passed   48.78 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =  48.81 sec

Add new levelx APIs

New APIs
--------
- lx_nor_flash_format(): erases nor flash blocks and setup block metadata
- lx_nor_flash_open_extended(): same as lx_nor_flash_open() with
  user data pointer a last argument.
- lx_nand_flash_open_extended(): same as lx_nand_flash_open() with
  user data pointer a last argument.

Updates
-------
- lx_nor_flash_open(): calls lx_nor_flash_open_extended() with a NULL as
  last argument
- lx_nand_flash_open(): calls lx_nand_flash_open_extended() with a NULL as
  last argument
- regression tests: to call the lx_nor_flash_format()

Test results
-------------
100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.27 sec
3/3 Test #1: standalone_free_sector_verify_build::levelx_nand_flash_test ........   Passed    6.29 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.29 sec
3/3 Test #1: nor_obsolete_mapping_cache_build::levelx_nand_flash_test ........   Passed    6.58 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.58 sec
3/3 Test #1: nor_obsolete_cache_build::levelx_nand_flash_test ........   Passed    6.67 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.67 sec
3/3 Test #1: nor_mapping_cache_build::levelx_nand_flash_test ........   Passed    6.77 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.78 sec
3/3 Test #1: full_build::levelx_nand_flash_test ........   Passed    6.91 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   6.91 sec
3/3 Test #1: free_sector_verify_build::levelx_nand_flash_test ........   Passed    7.14 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   7.14 sec
3/3 Test #1: standalone_full_build::levelx_nand_flash_test ........   Passed    7.21 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   7.21 sec
3/3 Test #1: standalone_build::levelx_nand_flash_test ........   Passed   12.05 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =  12.06 sec
3/3 Test #1: default_build_coverage::levelx_nand_flash_test ........   Passed   48.78 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =  48.81 sec

fix: Write the correct meta data on the block after erase

add missing nand_flash_format_extended API
2025-11-14 18:24:59 +01:00
Haithem Rahmani 0f7dd521e5 fix: Wrong out of range check in lx_nand_flash_block_find
Fix issue 53

Signed-off-by: Haithem Rahmani <haithem.rahmani@st.com>
2025-11-04 16:51:46 +01:00
Haithem Rahmani b5dcbff38c fix: "array out of bounds" error leading to memory corruption
Fix description
----------------
add missing checks on the index of nor_flash -> lx_nor_flash_extended_cache[i]

Fixes Issue#58

Signed-off-by: Haithem Rahmani <haithem.rahmani@st.com>
2025-11-04 08:51:41 +01:00
Haithem Rahmani 7d1ef20acf fix: "array out of bounds" error leading to memory corruption
Fix description
----------------
add missing checks on the index of nor_flash -> lx_nor_flash_extended_cache[i]

Fixes Issue#58

Signed-off-by: Haithem Rahmani <haithem.rahmani@st.com>
2025-10-22 16:14:04 +01:00
Frédéric Desbiens 04e385f3d5 Merge pull request #50 from ayedm1/fix_levelx_github_action_job
fix github levelx regression test action issue
2024-12-12 17:31:11 +01:00
Mohamed AYED 7c5d83d794 update regression_test.yml
fix github levelx regression test action issue

update regression_test.yml

uses: azure-rtos/threadx/.github/workflows/regression_template.yml@master
==>
uses: eclipse-threadx/threadx/.github/workflows/regression_template.yml@master
2024-11-29 21:54:31 +01:00
Stefan Wick 24eb7d8692 Merge pull request #40 from eclipse-threadx/wickste-patch-6
Update branding in issues templates
2024-03-10 22:18:15 -07:00
Stefan Wick 058b242a9a Update hardware-or-architecture-support.md 2024-03-10 22:04:45 -07:00
Stefan Wick a3c9691d89 Update feature_request.md 2024-03-10 22:04:18 -07:00
Stefan Wick f5a55077ad Update bug_report.md 2024-03-10 22:03:35 -07:00
Stefan Wick 656d1490f4 Merge pull request #39 from eclipse-threadx/wickste-patch-5
Update README.md
2024-03-07 07:20:23 -08:00
Stefan Wick 8e1d00b591 Update README.md 2024-03-06 16:56:23 -08:00
Stefan Wick f8899e5d6d Merge pull request #38 from eclipse-threadx/bo-ms/add_revision_history
Add revision history file.
2024-02-27 17:24:08 -08:00
Stefan Wick acc5190739 Merge branch 'master' into bo-ms/add_revision_history 2024-02-27 17:14:01 -08:00
Stefan Wick 79cbf4019f Merge branch 'master' into bo-ms/add_revision_history 2024-02-27 17:11:51 -08:00
Stefan Wick 2a963969bc Merge pull request #37 from eclipse-threadx/tizho/update_version
Update version number to 6.4.1
2024-02-27 17:07:24 -08:00
Bo Chen (from Dev Box) 1317123fdc Add revision history file. 2024-02-27 16:58:07 +08:00
TiejunZhou 814a8a346c Update version number to 6.4.1 2024-02-27 06:37:17 +00:00
Stefan Wick 34616e26e7 Merge pull request #35 from eclipse-threadx/wickste-patch-4
Update README.md
2024-02-21 07:09:23 -08:00
Stefan Wick f840cf4ce6 Update README.md 2024-02-20 22:51:45 -08:00
Stefan Wick ec683ddf14 Merge pull request #33 from eclipse-threadx/wickste-patch-3
Update LICENSE.txt and Delete LICENSED-HARDWARE.txt
2024-02-13 12:23:50 -08:00
Stefan Wick 1d6706dfa9 Merge branch 'master' into wickste-patch-3 2024-02-12 09:04:40 -08:00
Stefan Wick 6809f87fdd Merge pull request #32 from eclipse-threadx/wickste-patch-2
Update CONTRIBUTING.md
2024-02-12 08:20:24 -08:00
Stefan Wick 9b766d144f Merge branch 'master' into wickste-patch-2 2024-02-12 08:20:12 -08:00
Stefan Wick fb4b913dc2 Merge pull request #31 from eclipse-threadx/wickste-patch-1
Create SECURITY.md
2024-02-09 10:48:15 -08:00
Stefan Wick 01517ad256 Delete LICENSED-HARDWARE.txt 2024-02-06 21:41:48 -08:00
Stefan Wick 9f85e68bd1 Update LICENSE.txt 2024-02-06 21:41:28 -08:00
Stefan Wick bc8f7f3623 Update CONTRIBUTING.md 2024-02-06 21:15:04 -08:00
Stefan Wick 3ca016c042 Create SECURITY.md 2024-02-06 18:34:50 -08:00
Stefan Wick 4e747beb15 Merge pull request #30 from eclipse-threadx/bo-ms/copyright
Update copyright.
2024-01-28 22:20:07 -08:00
Bo Chen (from Dev Box) 151863ad7c Update copyright. 2024-01-29 14:15:48 +08:00
Stefan Wick d7b2a72452 Merge pull request #29 from ericwol-msft/SECURITY.md-update
Delete SECURITY.md
2024-01-18 17:53:20 -08:00
Eric Wolz e432e2cfa2 Delete SECURITY.md 2024-01-18 11:38:21 -08:00
Stefan Wick 0ea87a458d Merge pull request #28 from eclipse-threadx/tizho/update_script
Update links in run.sh script
2024-01-12 14:03:10 -08:00
TiejunZhou f8ab75e3ee Update links in run.sh script 2024-01-12 05:58:52 +00:00
92 changed files with 6968 additions and 5935 deletions
+2 -2
View File
@@ -1,6 +1,6 @@
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve Azure RTOS. about: Create a report to help us improve Eclipse ThreadX.
title: '' title: ''
labels: bug labels: bug
assignees: '' assignees: ''
@@ -13,7 +13,7 @@ A clear and concise description of what the bug is.
Please also mention any information which could help others to understand Please also mention any information which could help others to understand
the problem you're facing: the problem you're facing:
- What target device are you using? - What target device are you using?
- Which version of Azure RTOS? - Which version of Eclipse ThreadX?
- What toolchain and environment? - What toolchain and environment?
- What have you tried to diagnose or workaround this issue? - What have you tried to diagnose or workaround this issue?
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: Feature request name: Feature request
about: Suggest an idea or enhancement to existing feature for Azure RTOS. about: Suggest an idea or enhancement to existing feature for Eclipse ThreadX.
title: '' title: ''
labels: feature labels: feature
assignees: '' assignees: ''
@@ -8,12 +8,12 @@ assignees: ''
--- ---
**Is this request related to a particular hardware platform, SoC, board? Please describe.** **Is this request related to a particular hardware platform, SoC, board? Please describe.**
Describe in details the hardware support being requested and why this support benefits Azure RTOS. Describe in details the hardware support being requested and why this support benefits Eclipse ThreadX.
**Describe why you are asking for this support?** **Describe why you are asking for this support?**
Describe why you are asking for this support. Describe why you are asking for this support.
If this is a new board or SoC, please state whether you are willing to maintain the Azure RTOS support together with you. If this is a new board or SoC, please state whether you are willing to maintain the Eclipse ThreadX support together with you.
**Additional context** **Additional context**
Add any other context or graphics (drag-and-drop an image) about the hardware here. Add any other context or graphics (drag-and-drop an image) about the hardware here.
+1 -1
View File
@@ -22,4 +22,4 @@ jobs:
pull-requests: write pull-requests: write
pages: write pages: write
id-token: write id-token: write
uses: azure-rtos/threadx/.github/workflows/regression_template.yml@master uses: eclipse-threadx/threadx/.github/workflows/regression_template.yml@master
+1 -1
View File
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 3.0.0 FATAL_ERROR) cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
# Set up the project # Set up the project
project(levelx project(levelx
+69 -11
View File
@@ -1,14 +1,72 @@
# Contributing # Contributing to Eclipse ThreadX
This project welcomes contributions and suggestions. Most contributions require you to Thanks for your interest in this project.
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
and actually do, grant us the rights to use your contribution. For details, visit
https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need ## Project description
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). Eclipse ThreadX provides a vendor-neutral, open source, safety certified OS for
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) real-time applications published on under a permissive license. The Eclipse
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. ThreadX suite encompasses:
* ThreadX - advanced real-time operating system (RTOS) designed specifically for deeply embedded applications
* NetX Duo - advanced, industrial-grade TCP/IP network stack designed specifically for deeply embedded real-time and IoT applications
* FileX - high-performance, FAT-compatible file system thats fully integrated with ThreadX kernel
* GUIX - provides a complete, embedded graphical user interface (GUI) library
* USBX - high-performance USB host, device, and on-the-go (OTG) embedded stack, that is fully integrated with ThreadX kernel
* LevelX - Flash Wear Leveling for FileX and stand-alone purposes
* GuiX Studio - design environment, facilitating the creation and maintenance of all graphical elements for GUIX
* TraceX - analysis tool that provides a graphical view of real-time system events to better understand the behavior of real-time systems
Project site: https://projects.eclipse.org/projects/iot.threadx
## Terms of Use
This repository is subject to the Terms of Use of the Eclipse Foundation
https://www.eclipse.org/legal/termsofuse.php
## Developer resources
Information regarding source code management, builds, coding standards, and more.
https://projects.eclipse.org/projects/iot.threadx/developer
The project maintains the following source code repositories
* https://github.com/eclipse-threadx/.github
* https://github.com/eclipse-threadx/cmsis-packs
* https://github.com/eclipse-threadx/filex
* https://github.com/eclipse-threadx/getting-started
* https://github.com/eclipse-threadx/guix
* https://github.com/eclipse-threadx/levelx
* https://github.com/eclipse-threadx/netxduo
* https://github.com/eclipse-threadx/rtos-docs
* https://github.com/eclipse-threadx/samples
* https://github.com/eclipse-threadx/threadx
* https://github.com/eclipse-threadx/threadx-learn-samples
* https://github.com/eclipse-threadx/tracex
* https://github.com/eclipse-threadx/usbx
## Eclipse Development Process
This Eclipse Foundation open project is governed by the Eclipse Foundation
Development Process and operates under the terms of the Eclipse IP Policy.
* https://eclipse.org/projects/dev_process
* https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf
## Eclipse Contributor Agreement
In order to be able to contribute to Eclipse Foundation projects you must electronically sign the Eclipse Contributor Agreement (ECA).
https://www.eclipse.org/legal/ECA.php
The ECA provides the Eclipse Foundation with a permanent record that you agree
that each of your contributions will comply with the commitments documented in
the Developer Certificate of Origin (DCO). Having an ECA on file associated with
the email address matching the "Author" field of your contribution's Git commits
fulfills the DCO's requirement that you sign-off on your contributions.
For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit
## Contact
Contact the project developers via the project's "dev" list.
https://accounts.eclipse.org/mailing-list/threadx-dev
+17 -245
View File
@@ -1,249 +1,21 @@
MICROSOFT SOFTWARE LICENSE TERMS MIT License
MICROSOFT AZURE RTOS Copyright (c) 2024 - present Microsoft Corporation
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
These license terms are an agreement between you and Microsoft Corporation (or The above copyright notice and this permission notice shall be included in all
one of its affiliates). They apply to the software named above and any Microsoft copies or substantial portions of the Software.
services or software updates (except to the extent such services or updates are
accompanied by new or additional terms, in which case those different terms
apply prospectively and do not alter your or Microsofts rights relating to
pre-updated software or services). IF YOU COMPLY WITH THESE LICENSE TERMS, YOU
HAVE THE RIGHTS BELOW. BY USING THE SOFTWARE, YOU ACCEPT THESE TERMS.
1. INSTALLATION AND USE RIGHTS. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
a) General. You may (I) install, use and modify the software and (ii) install and use the included Microsoft FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Applications (if any), each solely for internal development, testing and evaluation purposes. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Distribution or production use is governed by the license terms set forth in LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Section 2. You may also obtain distribution or production use rights through a separate agreement with OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
Microsoft. SOFTWARE.
b) Contributions. Microsoft welcomes contributions to this software. In the event
that you make a contribution to this software you will be required to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and
actually do, grant Microsoft the rights to use your contribution. For details,
visit https://cla.microsoft.com.
c) Included Microsoft Applications. The software may include other Microsoft
applications which are governed by the licenses embedded in or made available
with those applications.
d) Third Party Components. The software may include third party components with
separate legal notices or governed by other agreements, as may be described
within the software or in the ThirdPartyNotices file(s) accompanying the
software.
e) Competitive Benchmarking. If you are a direct competitor, and you access or use
the software for purposes of competitive benchmarking, analysis, or intelligence
gathering, you waive as against Microsoft, its subsidiaries, and its affiliated
companies (including prospectively) any competitive use, access, and
benchmarking test restrictions in the terms governing your software to the
extent your terms of use are, or purport to be, more restrictive than
Microsofts terms. If you do not waive any such purported restrictions in the
terms governing your software, you are not allowed to access or use this
software, and will not do so.
2. DISTRIBUTION AND PRODUCTION USE. If you have obtained and/or are developing on
microprocessor(s) and/or microcontroller(s) (“hardware”) listed in the file
named “LICENSED-HARDWARE.txt” included in the repository and/or distributed with
the software you have the following rights in and to the software solely when
used in combination with the hardware. In the event hardware is not listed in
the LICENSED-HARDWARE.txt file, you do not have the rights in this Section 2.
a) Distribution and Production Use Rights.
i. You may use the software in production (e.g. program the modified or unmodified
software to devices you own or control) and distribute (i.e. make available to
third parties) the modified or unmodified binary image produced from this code.
ii. You may permit your device distributors or developers to copy and distribute the
binary image as programmed or to be programmed to your devices.
iii. You may redistribute the unmodified or modified source to your device
distributors or developers. Modifications must be clearly marked. Any
redistribution in source code form must contain this license and any other
licenses that accompany the software.
b) Requirements. For any code you distribute, you must:
i. when distributed in binary form, except as embedded in a device, include with
such distribution the terms of this agreement;
ii. when distributed in source code form to distributors or developers of your
devices, include with such distribution the terms of this agreement; and
iii. indemnify, defend and hold harmless Microsoft from any claims, including claims arising from any High Risk Uses, and inclusive of attorneys fees, related to the distribution or use of your devices that include the software, except to the extent that any intellectual property claim is based solely on the unmodified software.
c) Restrictions. You may not:
i. use or modify the software to create competing real time operating system
software;
ii. remove any copyright notices or licenses contained in the software;
iii. use Microsofts trademarks or trade dress in your application in any way that
suggests your device or application comes from or is endorsed by Microsoft;
iv. transfer individual components, specific libraries, classes, functions or code
fragments of the software separately for purposes unrelated to the software; or
v. use or distribute the software in any way that would subject the software or
Microsofts intellectual property or technology to any other license terms.
3. SCOPE OF LICENSE. The software is licensed, not sold. Microsoft reserves all
other rights. Unless applicable law gives you more rights despite this
limitation, you will not (and have no right to):
a) remove, minimize, block, or modify any notices of Microsoft or its suppliers in
the software;
b) use the software in any way that is against the law or to create or propagate
malware; or
c) share, publish, distribute, or lease the software (except as permitted in
Section 2 above), or provide the software as a stand-alone offering for others
to use.
4. DATA. This software may interact with other Microsoft products that collect data
that is transmitted to Microsoft. To learn more about how Microsoft processes
personal data we collect, please see the Microsoft Privacy Statement at
https://go.microsoft.com/fwlink/?LinkId=248681.
5. EXPORT RESTRICTIONS. You must comply with all domestic and international export
laws and regulations that apply to the software, which include restrictions on
destinations, end users, and end use. For further information on export
restrictions, visit https://aka.ms/exporting.
6. SUPPORT SERVICES. Microsoft is not obligated under this agreement to provide any
support services for the software. Any support provided is “as is”, “with all
faults”, and without warranty of any kind.
7. UPDATES. Microsoft may periodically update the software. You may obtain updates
only from Microsoft or Microsoft-authorized sources. Updates may not include or
support all existing software features, services, or peripheral devices.
8. TERMINATION. Without prejudice to any other rights, Microsoft may terminate this
agreement if you fail to comply with any of its terms or conditions. In such
event, you must destroy all copies of the software and all of its component
parts.
9. ENTIRE AGREEMENT. This agreement, and any other terms Microsoft may provide for
supplements, updates, or third-party applications, is the entire agreement for
the software. To the extent you have entered into a separate agreement with
Microsoft relating specifically to the software, the terms in such agreement
shall control.
10. APPLICABLE LAW AND PLACE TO RESOLVE DISPUTES. If you acquired the software in
the United States or Canada, the laws of the state or province where you live
(or, if a business, where your principal place of business is located) govern
the interpretation of this agreement, claims for its breach, and all other
claims (including consumer protection, unfair competition, and tort claims),
regardless of conflict of laws principles. If you acquired the software in any
other country, its laws apply. If U.S. federal jurisdiction exists, you and
Microsoft consent to exclusive jurisdiction and venue in the federal court in
King County, Washington for all disputes heard in court. If not, you and
Microsoft consent to exclusive jurisdiction and venue in the Superior Court of
King County, Washington for all disputes heard in court.
11. CONSUMER RIGHTS; REGIONAL VARIATIONS. This agreement describes certain legal
rights. You may have other rights, including consumer rights, under the laws of
your state or country. Separate and apart from your relationship with Microsoft,
you may also have rights with respect to the party from which you acquired the
software. This agreement does not change those other rights if the laws of your
state or country do not permit it to do so. For example, if you acquired the
software in one of the below regions, or mandatory country law applies, then the
following provisions apply to you:
a) Australia. You have statutory guarantees under the Australian Consumer Law and
nothing in this agreement is intended to affect those rights.
b) Germany and Austria.
i. Warranty. The properly licensed software will perform substantially as
described in any Microsoft materials that accompany the software. However,
Microsoft gives no contractual guarantee in relation to the licensed software.
ii. Limitation of Liability. In case of intentional conduct, gross negligence,
claims based on the Product Liability Act, as well as, in case of death or
personal or physical injury, Microsoft is liable according to the statutory law.
Subject to the foregoing clause ii., Microsoft will only be liable for slight
negligence if Microsoft is in breach of such material contractual obligations,
the fulfillment of which facilitate the due performance of this agreement, the
breach of which would endanger the purpose of this agreement and the compliance
with which a party may constantly trust in (so-called "cardinal obligations").
In other cases of slight negligence, Microsoft will not be liable for slight
negligence.
12. DISCLAIMER OF WARRANTY.
a) THE SOFTWARE IS LICENSED “AS IS.” YOU BEAR THE RISK OF
USING IT. MICROSOFT GIVES NO EXPRESS WARRANTIES, GUARANTEES, OR CONDITIONS. TO
THE EXTENT PERMITTED UNDER APPLICABLE LAWS, MICROSOFT EXCLUDES ALL IMPLIED
WARRANTIES, INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
NON-INFRINGEMENT.
b) HIGH RISK USE DISCLAIMER. WARNING: THE SOFTWARE IS NOT DESIGNED OR INTENDED FOR USE WHERE FAILURE OR FAULT OF ANY KIND OF THE SOFTWARE COULD RESULT IN DEATH OR SERIOUS BODILY INJURY, OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (“collectively High Risk Use”). Accordingly, You must design and implement your hardware and software such that, in the event of any interruption, defect, error, or other failure of the software, the safety of people, property, and the environment are not reduced below a level that is reasonable, appropriate, and legal, whether in general or for a specific industry. Your High Risk Use of the software is at Your own risk.
13. LIMITATION ON AND EXCLUSION OF DAMAGES. IF YOU HAVE ANY BASIS FOR RECOVERING
DAMAGES DESPITE THE PRECEDING DISCLAIMER OF WARRANTY, YOU CAN RECOVER FROM
MICROSOFT AND ITS SUPPLIERS ONLY DIRECT DAMAGES UP TO U.S. $5.00. YOU CANNOT
RECOVER ANY OTHER DAMAGES, INCLUDING CONSEQUENTIAL, LOST PROFITS, SPECIAL,
INDIRECT, OR INCIDENTAL DAMAGES.
This limitation applies to (a) anything related to the software, services,
content (including code) on third party Internet sites, or third party
applications; and (b) claims for breach of contract, warranty, guarantee, or
condition; strict liability, negligence, or other tort; or any other claim; in
each case to the extent permitted by applicable law.
It also applies even if Microsoft knew or should have known about the
possibility of the damages. The above limitation or exclusion may not apply to
you because your state, province, or country may not allow the exclusion or
limitation of incidental, consequential, or other damages.
Please note: As this software is distributed in Canada, some of the clauses in
this agreement are provided below in French.
Remarque: Ce logiciel étant distribué au Canada, certaines des clauses dans ce
contrat sont fournies ci-dessous en français.
EXONÉRATION DE GARANTIE.
a) Le logiciel visé par une licence est offert « tel quel
». Toute utilisation de ce logiciel est à votre seule risque et péril. Microsoft
naccorde aucune autre garantie expresse. Vous pouvez bénéficier de droits
additionnels en vertu du droit local sur la protection des consommateurs, que ce
contrat ne peut modifier. La ou elles sont permises par le droit locale, les
garanties implicites de qualité marchande, dadéquation à un usage particulier
et dabsence de contrefaçon sont exclues.
b) CLAUSE DEXCLUSION DE RESPONSABILITÉ RELATIVE À LUTILISATION À HAUT RISQUE.
AVERTISSEMENT: LE LOGICIEL NEST PAS CONÇU OU DESTINÉ À ÊTRE UTILISÉ LORSQUUNE
DÉFAILLANCE OU UN DÉFAUT DE QUELQUE NATURE QUE CE SOIT POURRAIT ENTRAÎNER LA
MORT OU DES BLESSURES CORPORELLES GRAVES, OU DES DOMMAGES PHYSIQUES OU
ENVIRONNEMENTAUX (« Utilisation à haut risque »). Par conséquent, vous devez concevoir et mettre en
œuvre votre équipement et votre logiciel de manière à ce que, en cas dinterruption, de défaut, derreur
ou de toute autre défaillance du logiciel, la sécurité des personnes, des biens et de lenvironnement ne
soit pas réduite en dessous dun niveau raisonnable, approprié et légal, que ce soit en général ou pour
un secteur spécifique. Votre utilisation à haut risque du logiciel est à vos propres risques.
LIMITATION DES DOMMAGES-INTÉRÊTS ET EXCLUSION DE RESPONSABILITÉ POUR LES
DOMMAGES. Vous pouvez obtenir de Microsoft et de ses fournisseurs une
indemnisation en cas de dommages directs uniquement à hauteur de 5,00 $ US. Vous
ne pouvez prétendre à aucune indemnisation pour les autres dommages, y compris
les dommages spéciaux, indirects ou accessoires et pertes de bénéfices.
Cette limitation concerne:
•tout ce qui est relié au logiciel, aux services ou au contenu (y compris le
code) figurant sur des sites Internet tiers ou dans des programmes tiers; et
•les réclamations au titre de violation de contrat ou de garantie, ou au titre
de responsabilité stricte, de négligence ou dune autre faute dans la limite
autorisée par la loi en vigueur.
Elle sapplique également, même si Microsoft connaissait ou devrait connaître
l’éventualité dun tel dommage. Si votre pays nautorise pas lexclusion ou la
limitation de responsabilité pour les dommages indirects, accessoires ou de
quelque nature que ce soit, il se peut que la limitation ou lexclusion
ci-dessus ne sappliquera pas à votre égard.
EFFET JURIDIQUE. Le présent contrat décrit certains droits juridiques. Vous
pourriez avoir dautres droits prévus par les lois de votre pays. Le présent
contrat ne modifie pas les droits que vous confèrent les lois de votre pays si
celles-ci ne le permettent pas.
-45
View File
@@ -1,45 +0,0 @@
LICENSED HARDWARE LIST
Last Updated: 2023-02-10
Microsoft has entered into OEM Agreements with manufacturers of the following
microprocessors and microcontrollers (the “hardware”) to enable those
manufacturers to include and distribute Azure RTOS in certain hardware. If you
have obtained and/or are developing on microprocessor(s) and/or
microcontroller(s) (“hardware”) listed below you inherit the “Distribution and
Production Use” rights in Section 2 of the Microsoft Software License Terms for
Microsoft Azure RTOS. If hardware is not listed below, you do not have those
rights.
STMicroelectronics:
STM32 MCUs
STM32 MPUs
MediaTek:
MT3620 MCU (Azure Sphere)
Microchip:
PIC 32-bit MCUs
SAM 32-bit MCUs
SAM 32-bit MPUs
NXP:
i.MX RT10xx and RT116x/7x series crossover MCUs
LPC5500 series
MCX N series
Renesas:
Synergy Platform
RX Family of MCUs
RA Family of MCUs
RZ Family of MPUs
--------------------------------------------------------------------------------
More coming soon. Please check back frequently for updates.
+15 -23
View File
@@ -1,12 +1,12 @@
# Azure RTOS LevelX # Eclipse ThreadX LevelX
LevelX provides NAND and NOR flash wear leveling facilities to embedded applications. Since both NAND and NOR flash memory can only be erased a finite number of times, its critical to distribute the flash memory use evenly. This is typically called **wear leveling** and is the purpose behind LevelX. LevelX presents to the user an array of logical sectors that are mapped to physical flash memory inside of LevelX. Applications may use LevelX in conjunction with FileX or may read/write logical sectors directly. LevelX is designed for fault tolerance. Flash updates are performed in a multiple-step process that can be interrupted in each step. LevelX automatically recovers to the optimal state during the next operation. LevelX provides NAND and NOR flash wear leveling facilities to embedded applications. Since both NAND and NOR flash memory can only be erased a finite number of times, its critical to distribute the flash memory use evenly. This is typically called **wear leveling** and is the purpose behind LevelX. LevelX presents to the user an array of logical sectors that are mapped to physical flash memory inside of LevelX. Applications may use LevelX in conjunction with FileX or may read/write logical sectors directly. LevelX is designed for fault tolerance. Flash updates are performed in a multiple-step process that can be interrupted in each step. LevelX automatically recovers to the optimal state during the next operation.
## Getting Started ## Getting Started
Azure RTOS LevelX as part of Azure RTOS has been integrated to the semiconductor's SDKs and development environment. You can develop using the tools of choice from [STMicroelectronics](https://www.st.com/content/st_com/en/campaigns/x-cube-azrtos-azure-rtos-stm32.html), [NXP](https://www.nxp.com/design/software/embedded-software/azure-rtos-for-nxp-microcontrollers:AZURE-RTOS), [Renesas](https://github.com/renesas/azure-rtos) and [Microchip](https://mu.microchip.com/get-started-simplifying-your-iot-design-with-azure-rtos). LevelX as part of Eclipse ThreadX has been integrated to the semiconductor's SDKs and development environment. You can develop using the tools of choice from [STMicroelectronics](https://www.st.com/content/st_com/en/campaigns/x-cube-azrtos-azure-rtos-stm32.html), [NXP](https://www.nxp.com/design/software/embedded-software/azure-rtos-for-nxp-microcontrollers:AZURE-RTOS), [Renesas](https://github.com/renesas/azure-rtos) and [Microchip](https://mu.microchip.com/get-started-simplifying-your-iot-design-with-azure-rtos).
See [Overview of Azure RTOS LevelX](https://learn.microsoft.com/azure/rtos/levelx/overview-levelx) for the high-level overview, and all documentation and APIs can be found in: [Azure RTOS LevelX documentation](https://learn.microsoft.com/azure/rtos/levelx/). See [Overview of Eclipse ThreadX LevelX](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/levelx/index.md) for the high-level overview.
## Repository Structure and Usage ## Repository Structure and Usage
@@ -19,7 +19,7 @@ See [Overview of Azure RTOS LevelX](https://learn.microsoft.com/azure/rtos/level
├── LICENSE.txt # License terms ├── LICENSE.txt # License terms
├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors
├── CONTRIBUTING.md # Contribution guidance ├── CONTRIBUTING.md # Contribution guidance
└── SECURITY.md # Microsoft repo security guidance └── SECURITY.md # Repo security guidance
### Branches & Releases ### Branches & Releases
@@ -74,7 +74,7 @@ The master branch has the most recent code with all new features and bug fixes.
## Component dependencies ## Component dependencies
The main components of Azure RTOS are each provided in their own repository, but there are dependencies between them, as shown in the following graph. This is important to understand when setting up your builds. The main components of Eclipse ThreadX are each provided in their own repository, but there are dependencies between them, as shown in the following graph. This is important to understand when setting up your builds.
![dependency graph](docs/deps.png) ![dependency graph](docs/deps.png)
@@ -82,7 +82,7 @@ The main components of Azure RTOS are each provided in their own repository, but
### Building and using the library ### Building and using the library
Instruction for building the LevelX as static library using Arm GNU Toolchain and CMake. If you are using toolchain and IDE from semiconductor, you might follow its own instructions to use Azure RTOS components as explained in the [Getting Started](#getting-started) section. Instruction for building the LevelX as static library using Arm GNU Toolchain and CMake. If you are using toolchain and IDE from semiconductor, you might follow its own instructions to use Eclipse ThreadX components as explained in the [Getting Started](#getting-started) section.
1. Install the following tools: 1. Install the following tools:
@@ -95,14 +95,14 @@ Instruction for building the LevelX as static library using Arm GNU Toolchain an
1. Cloning the repo. 1. Cloning the repo.
```bash ```bash
$ git clone --recursive https://github.com/azure-rtos/levelx.git $ git clone --recursive https://github.com/eclipse-threadx/levelx.git
``` ```
1. Define the features and addons you need in `lx_user.h` and build together with the component source code. You can refer to [`lx_user_sample.h`](https://github.com/azure-rtos/levelx/blob/master/common/inc/lx_user_sample.h) as an example. 1. Define the features and addons you need in `lx_user.h` and build together with the component source code. You can refer to [`lx_user_sample.h`](https://github.com/azure-rtos/levelx/blob/master/common/inc/lx_user_sample.h) as an example.
1. Building as a static library 1. Building as a static library
Each component of Azure RTOS comes with a composable CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake `add_subdirectory()`. Each component of Eclipse ThreadX comes with a composable CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake `add_subdirectory()`.
While the typical usage pattern is to include LevelX into your device code source tree to be built & linked with your code, you can compile this project as a standalone static library to confirm your build is set up correctly. While the typical usage pattern is to include LevelX into your device code source tree to be built & linked with your code, you can compile this project as a standalone static library to confirm your build is set up correctly.
@@ -114,31 +114,23 @@ Instruction for building the LevelX as static library using Arm GNU Toolchain an
$ cmake --build ./build $ cmake --build ./build
``` ```
## Professional support
[Professional support plans](https://azure.microsoft.com/support/options/) are available from Microsoft. For community support and others, see the [Resources](#resources) section below.
## Licensing ## Licensing
License terms for using Azure RTOS are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information. No additional license fees are required for deploying Azure RTOS on hardware defined in the [LICENSED-HARDWARE.txt](./LICENSED-HARDWARE.txt) file. If you are using hardware not listed in the file or having licensing questions in general, please contact Microsoft directly at https://aka.ms/azrtos-license. License terms for using Eclipse ThreadX are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information for all content, incl. the history of this repo.
## Resources ## Resources
The following are references to additional Azure RTOS resources: The following are references to additional Eclipse ThreadX resources:
- **Product introduction and white papers**: https://azure.com/rtos - **Product introduction**: https://github.com/eclipse-threadx/rtos-docs
- **General technical questions**: https://aka.ms/QnA/azure-rtos - **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/levelx/issues
- **Product issues and bugs, or feature requests**: https://github.com/azure-rtos/levelx/issues - **TraceX Installer**: https://aka.ms/azrtos-tracex-installer
- **Licensing and sales questions**: https://aka.ms/azrtos-license
- **Product roadmap and support policy**: https://aka.ms/azrtos/lts
- **Blogs and videos**: http://msiotblog.com and https://aka.ms/iotshow
- **Azure RTOS TraceX Installer**: https://aka.ms/azrtos-tracex-installer
You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+levelx) or ask new ones on StackOverflow using the `azure-rtos` and `levelx` tags. You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+levelx) or ask new ones on StackOverflow using the `threadx` and `levelx` tags.
## Security ## Security
Azure RTOS provides OEMs with components to secure communication and to create code and data isolation using underlying MCU/MPU hardware protection mechanisms. It is ultimately the responsibility of the device builder to ensure the device fully meets the evolving security requirements associated with its specific use case. Eclipse ThreadX provides OEMs with components to secure communication and to create code and data isolation using underlying MCU/MPU hardware protection mechanisms. It is ultimately the responsibility of the device builder to ensure the device fully meets the evolving security requirements associated with its specific use case.
## Contribution ## Contribution
+25 -21
View File
@@ -1,35 +1,39 @@
## Security # Security Policy
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). This Eclipse Foundation Project adheres to the [Eclipse Foundation Vulnerability Reporting Policy](https://www.eclipse.org/security/policy/).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. ## How To Report a Vulnerability
## Reporting Security Issues If you think you have found a vulnerability in this repository, please report it to us through coordinated disclosure.
**Please do not report security vulnerabilities through public GitHub issues.** **Please do not report security vulnerabilities through public issues, discussions, or change requests.**
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). Instead, [report it privately here](https://github.com/eclipse-threadx/levelx/security/advisories/new) on GitHub
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). You can find more information about reporting and disclosure at the [Eclipse Foundation Security page](https://www.eclipse.org/security/).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). Please include as much of the information listed below as you can to help us better understand and resolve the issue:
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: * The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
* Affected version(s)
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) * Impact of the issue, including how an attacker might exploit the issue
* Full paths of source file(s) related to the manifestation of the issue * Step-by-step instructions to reproduce the issue
* The location of the affected source code (tag/branch/commit or direct URL) * The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue * Full paths of source file(s) related to the manifestation of the issue
* Step-by-step instructions to reproduce the issue * Configuration required to reproduce the issue
* Proof-of-concept or exploit code (if possible) * Log files that are related to this issue (if possible)
* Impact of the issue, including how an attacker might exploit the issue * Proof-of-concept or exploit code (if possible)
This information will help us triage your report more quickly. This information will help us triage your report more quickly.
## Preferred Languages ## Supported Versions
We prefer all communications to be in English. | Version | Supported |
| ------- | ------------------ |
| 6.5.x | :white_check_mark: |
## Policy Eclipse ThreadX publishes a release every quarter. There are no long-term support branches or backports to older releases.
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). Normally, fixes for non-critical vulnerabilities will ship in a regularly scheduled quarterly release. If fixes for an urgent or critical vulnerability must ship quickly, then the project will publish a hotfix release of the affected component(s) without waiting for the next quarterly release.
You can learn more about the [project's release cadence in this blog post](https://blogs.eclipse.org/post/fr%C3%A9d%C3%A9ric-desbiens/eclipse-threadx-more-predictable-more-open).
+5
View File
@@ -20,8 +20,10 @@ target_sources(${PROJECT_NAME} PRIVATE
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_erase_count_set.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_erase_count_set.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_extended_cache_enable.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_extended_cache_enable.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_format.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_format.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_format_extended.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_free_block_list_add.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_free_block_list_add.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_initialize.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_initialize.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_logical_group_compact.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_mapped_block_list_add.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_mapped_block_list_add.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_mapped_block_list_get.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_mapped_block_list_get.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_mapped_block_list_remove.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_mapped_block_list_remove.c
@@ -30,6 +32,7 @@ target_sources(${PROJECT_NAME} PRIVATE
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_metadata_build.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_metadata_build.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_metadata_write.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_metadata_write.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_open.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_open.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_open_extended.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_page_ecc_check.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_page_ecc_check.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_page_ecc_compute.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_page_ecc_compute.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_partial_defragment.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nand_flash_partial_defragment.c
@@ -52,6 +55,8 @@ target_sources(${PROJECT_NAME} PRIVATE
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_logical_sector_find.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_logical_sector_find.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_next_block_to_erase_find.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_next_block_to_erase_find.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_open.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_open.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_open_extended.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_format.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_partial_defragment.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_partial_defragment.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_physical_sector_allocate.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_physical_sector_allocate.c
${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_sector_mapping_cache_invalidate.c ${CMAKE_CURRENT_LIST_DIR}/src/lx_nor_flash_sector_mapping_cache_invalidate.c
+57 -68
View File
@@ -1,13 +1,14 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ * Portion Copyright (c) 2025 STMicroelectronics
/* This software is licensed under the Microsoft Software License */ *
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * This program and the accompanying materials are made available under the
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * terms of the MIT License which is available at
/* and in the root directory of this software. */ * https://opensource.org/licenses/MIT.
/* */ *
/**************************************************************************/ * SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -26,7 +27,7 @@
/* APPLICATION INTERFACE DEFINITION RELEASE */ /* APPLICATION INTERFACE DEFINITION RELEASE */
/* */ /* */
/* lx_api.h PORTABLE C */ /* lx_api.h PORTABLE C */
/* 6.4.0 */ /* 6.4.1 */
/* AUTHOR */ /* AUTHOR */
/* */ /* */
/* William E. Lamie, Microsoft Corporation */ /* William E. Lamie, Microsoft Corporation */
@@ -37,59 +38,6 @@
/* high-performance LevelX. All service prototypes and data structure */ /* high-performance LevelX. All service prototypes and data structure */
/* definitions are defined in this file. */ /* definitions are defined in this file. */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), and */
/* updated product constants, */
/* resulting in version 6.1 */
/* 11-09-2020 William E. Lamie Modified comment(s), and */
/* added support for lx_user.h */
/* so user can specify values, */
/* resulting in version 6.1.2 */
/* 12-31-2020 William E. Lamie Modified comment(s), and */
/* updated product constants, */
/* resulting in version 6.1.3 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* added standalone support, */
/* resulting in version 6.1.7 */
/* 08-02-2021 William E. Lamie Modified comment(s), and */
/* updated product constants, */
/* resulting in version 6.1.8 */
/* 10-15-2021 Bhupendra Naphade Modified comment(s), */
/* updated configuration for */
/* nand flash */
/* resulting in version 6.1.9 */
/* 01-31-2022 Bhupendra Naphade Modified comment(s), */
/* updated include order for */
/* standalone mode, */
/* resulting in version 6.1.10 */
/* 04-25-2022 William E. Lamie Modified comment(s), and */
/* updated product constants, */
/* resulting in version 6.1.11 */
/* 07-29-2022 William E. Lamie Modified comment(s), and */
/* updated product constants, */
/* resulting in version 6.1.12 */
/* 10-31-2022 Xiuwen Cai Modified comment(s), and */
/* updated product constants, */
/* resulting in version 6.2.0 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* modified NAND logic, */
/* added new driver interface */
/* and user extension, */
/* resulting in version 6.2.1 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* made LX_NOR_SECTOR_SIZE */
/* configurable, added mapping */
/* bitmap and obsolete count */
/* cache for NOR flash, */
/* resulting in version 6.3.0 */
/* 12-31-2023 Xiuwen Cai Modified comment(s), */
/* added configuration checks, */
/* resulting in version 6.4.0 */
/* */
/**************************************************************************/ /**************************************************************************/
#ifndef LX_API_H #ifndef LX_API_H
@@ -200,8 +148,10 @@ typedef unsigned long long ULONG64;
/* Define basic constants for the LevelX Stack. */ /* Define basic constants for the LevelX Stack. */
#define AZURE_RTOS_LEVELX #define AZURE_RTOS_LEVELX
#define LEVELX_MAJOR_VERSION 6 #define LEVELX_MAJOR_VERSION 6
#define LEVELX_MINOR_VERSION 4 #define LEVELX_MINOR_VERSION 5
#define LEVELX_PATCH_VERSION 0 #define LEVELX_PATCH_VERSION 1
#define LEVELX_BUILD_VERSION 202602
#define LEVELX_HOTFIX_VERSION ' '
/* Define general LevelX Constants. */ /* Define general LevelX Constants. */
@@ -324,6 +274,17 @@ typedef unsigned long long ULONG64;
#define LX_NAND_FLASH_MAX_METADATA_BLOCKS 4 #define LX_NAND_FLASH_MAX_METADATA_BLOCKS 4
#endif #endif
/* When LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE is defined, sector releases from full blocks
are deferred when free block count exceeds the threshold below (opt-in, default: off).
Requires pages_per_block <= 4095 (bit 12 is reserved for COMPACTION_PENDING flag). */
/* #define LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
#ifndef LX_NAND_FLASH_SECTOR_RELEASE_LAZY_THRESHOLD
#define LX_NAND_FLASH_SECTOR_RELEASE_LAZY_THRESHOLD 10u
#endif
#endif
#ifndef LX_UTILITY_SHORT_SET #ifndef LX_UTILITY_SHORT_SET
#define LX_UTILITY_SHORT_SET(address, value) *((USHORT*)(address)) = (USHORT)(value) #define LX_UTILITY_SHORT_SET(address, value) *((USHORT*)(address)) = (USHORT)(value)
#endif #endif
@@ -378,6 +339,11 @@ typedef unsigned long long ULONG64;
#define LX_NAND_BLOCK_STATUS_FULL 0x4000u #define LX_NAND_BLOCK_STATUS_FULL 0x4000u
#define LX_NAND_BLOCK_STATUS_NON_SEQUENTIAL 0x2000u #define LX_NAND_BLOCK_STATUS_NON_SEQUENTIAL 0x2000u
#define LX_NAND_BLOCK_STATUS_MAPPING_PRESENT 0x1000u #define LX_NAND_BLOCK_STATUS_MAPPING_PRESENT 0x1000u
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
/* Repurpose the otherwise-unused MAPPING_PRESENT bit to signal a block whose compaction
has been deferred. Only valid when pages_per_block <= 4095. */
#define LX_NAND_BLOCK_STATUS_COMPACTION_PENDING LX_NAND_BLOCK_STATUS_MAPPING_PRESENT
#endif
#define LX_NAND_BLOCK_STATUS_PAGE_NUMBER_MASK 0x0FFFu #define LX_NAND_BLOCK_STATUS_PAGE_NUMBER_MASK 0x0FFFu
#define LX_NAND_BLOCK_STATUS_FREE 0xFFFFu #define LX_NAND_BLOCK_STATUS_FREE 0xFFFFu
#define LX_NAND_BLOCK_STATUS_BAD 0xFF00u #define LX_NAND_BLOCK_STATUS_BAD 0xFF00u
@@ -452,6 +418,12 @@ typedef struct LX_NAND_FLASH_STRUCT
USHORT *lx_nand_flash_block_list; USHORT *lx_nand_flash_block_list;
ULONG lx_nand_flash_block_list_size; ULONG lx_nand_flash_block_list_size;
ULONG lx_nand_flash_free_block_list_tail; ULONG lx_nand_flash_free_block_list_tail;
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
/* Parallel to block_mapping_table: physical block with pending compaction for a group,
or LX_NAND_BLOCK_UNMAPPED when no compaction is pending. */
USHORT *lx_nand_flash_block_compaction_table;
ULONG lx_nand_flash_block_compaction_table_size;
#endif
ULONG lx_nand_flash_mapped_block_list_head; ULONG lx_nand_flash_mapped_block_list_head;
ULONG lx_nand_flash_metadata_block_number; ULONG lx_nand_flash_metadata_block_number;
@@ -526,7 +498,6 @@ typedef struct LX_NAND_FLASH_STRUCT
#endif #endif
UCHAR *lx_nand_flash_page_buffer; UCHAR *lx_nand_flash_page_buffer;
UINT lx_nand_flash_page_buffer_size; UINT lx_nand_flash_page_buffer_size;
#ifdef LX_THREAD_SAFE_ENABLE #ifdef LX_THREAD_SAFE_ENABLE
/* When this conditional is used, the LevelX code utilizes a ThreadX mutex for thread /* When this conditional is used, the LevelX code utilizes a ThreadX mutex for thread
@@ -535,6 +506,8 @@ typedef struct LX_NAND_FLASH_STRUCT
TX_MUTEX lx_nand_flash_mutex; TX_MUTEX lx_nand_flash_mutex;
#endif #endif
/* user data pointer optionally passed by the application to the driver via the lx_nand_flash_open_extended */
VOID *lx_nand_flash_driver_info_ptr;
/* Define the NAND flash control block open next/previous pointers. */ /* Define the NAND flash control block open next/previous pointers. */
struct LX_NAND_FLASH_STRUCT *lx_nand_flash_open_next, struct LX_NAND_FLASH_STRUCT *lx_nand_flash_open_next,
*lx_nand_flash_open_previous; *lx_nand_flash_open_previous;
@@ -664,7 +637,8 @@ typedef struct LX_NOR_FLASH_STRUCT
a higher layer. */ a higher layer. */
TX_MUTEX lx_nor_flash_mutex; TX_MUTEX lx_nor_flash_mutex;
#endif #endif
/* user data pointer optionally passed by the application to the driver via the lx_nor_flash_open_extended */
VOID *lx_nor_flash_driver_info_ptr;
/* Define the NOR flash control block open next/previous pointers. */ /* Define the NOR flash control block open next/previous pointers. */
struct LX_NOR_FLASH_STRUCT *lx_nor_flash_open_next, struct LX_NOR_FLASH_STRUCT *lx_nor_flash_open_next,
*lx_nor_flash_open_previous; *lx_nor_flash_open_previous;
@@ -723,8 +697,10 @@ extern ULONG _lx_nor_flash_opened_cou
#define lx_nand_flash_partial_defragment _lx_nand_flash_partial_defragment #define lx_nand_flash_partial_defragment _lx_nand_flash_partial_defragment
#define lx_nand_flash_extended_cache_enable _lx_nand_flash_extended_cache_enable #define lx_nand_flash_extended_cache_enable _lx_nand_flash_extended_cache_enable
#define lx_nand_flash_format _lx_nand_flash_format #define lx_nand_flash_format _lx_nand_flash_format
#define lx_nand_flash_format_extended _lx_nand_flash_format_extended
#define lx_nand_flash_initialize _lx_nand_flash_initialize #define lx_nand_flash_initialize _lx_nand_flash_initialize
#define lx_nand_flash_open _lx_nand_flash_open #define lx_nand_flash_open _lx_nand_flash_open
#define lx_nand_flash_open_extended _lx_nand_flash_open_extended
#define lx_nand_flash_page_ecc_check _lx_nand_flash_page_ecc_check #define lx_nand_flash_page_ecc_check _lx_nand_flash_page_ecc_check
#define lx_nand_flash_page_ecc_compute _lx_nand_flash_page_ecc_compute #define lx_nand_flash_page_ecc_compute _lx_nand_flash_page_ecc_compute
#define lx_nand_flash_sector_read _lx_nand_flash_sector_read #define lx_nand_flash_sector_read _lx_nand_flash_sector_read
@@ -741,7 +717,9 @@ extern ULONG _lx_nor_flash_opened_cou
#define lx_nor_flash_partial_defragment _lx_nor_flash_partial_defragment #define lx_nor_flash_partial_defragment _lx_nor_flash_partial_defragment
#define lx_nor_flash_extended_cache_enable _lx_nor_flash_extended_cache_enable #define lx_nor_flash_extended_cache_enable _lx_nor_flash_extended_cache_enable
#define lx_nor_flash_initialize _lx_nor_flash_initialize #define lx_nor_flash_initialize _lx_nor_flash_initialize
#define lx_nor_flash_format _lx_nor_flash_format
#define lx_nor_flash_open _lx_nor_flash_open #define lx_nor_flash_open _lx_nor_flash_open
#define lx_nor_flash_open_extended _lx_nor_flash_open_extended
#define lx_nor_flash_sector_read _lx_nor_flash_sector_read #define lx_nor_flash_sector_read _lx_nor_flash_sector_read
#define lx_nor_flash_sector_release _lx_nor_flash_sector_release #define lx_nor_flash_sector_release _lx_nor_flash_sector_release
#define lx_nor_flash_sector_write _lx_nor_flash_sector_write #define lx_nor_flash_sector_write _lx_nor_flash_sector_write
@@ -757,7 +735,13 @@ UINT _lx_nand_flash_extended_cache_enable(LX_NAND_FLASH *nand_flash, VOID *m
UINT _lx_nand_flash_format(LX_NAND_FLASH* nand_flash, CHAR* name, UINT _lx_nand_flash_format(LX_NAND_FLASH* nand_flash, CHAR* name,
UINT(*nand_driver_initialize)(LX_NAND_FLASH*), UINT(*nand_driver_initialize)(LX_NAND_FLASH*),
ULONG* memory_ptr, UINT memory_size); ULONG* memory_ptr, UINT memory_size);
UINT _lx_nand_flash_format_extended(LX_NAND_FLASH* nand_flash, CHAR* name,
UINT(*nand_driver_initialize)(LX_NAND_FLASH*), VOID *nand_driver_info_ptr,
ULONG* memory_ptr, UINT memory_size);
UINT _lx_nand_flash_open(LX_NAND_FLASH *nand_flash, CHAR *name, UINT (*nand_driver_initialize)(LX_NAND_FLASH *), ULONG* memory_ptr, UINT memory_size); UINT _lx_nand_flash_open(LX_NAND_FLASH *nand_flash, CHAR *name, UINT (*nand_driver_initialize)(LX_NAND_FLASH *), ULONG* memory_ptr, UINT memory_size);
UINT _lx_nand_flash_open_extended(LX_NAND_FLASH *nand_flash, CHAR *name,
UINT (*nand_driver_initialize)(LX_NAND_FLASH *), VOID *nand_driver_info_ptr,
ULONG* memory_ptr, UINT memory_size);
UINT _lx_nand_flash_page_ecc_check(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer); UINT _lx_nand_flash_page_ecc_check(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer);
UINT _lx_nand_flash_page_ecc_compute(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer); UINT _lx_nand_flash_page_ecc_compute(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer);
UINT _lx_nand_flash_partial_defragment(LX_NAND_FLASH *nand_flash, UINT max_blocks); UINT _lx_nand_flash_partial_defragment(LX_NAND_FLASH *nand_flash, UINT max_blocks);
@@ -772,7 +756,9 @@ UINT _lx_nor_flash_close(LX_NOR_FLASH *nor_flash);
UINT _lx_nor_flash_defragment(LX_NOR_FLASH *nor_flash); UINT _lx_nor_flash_defragment(LX_NOR_FLASH *nor_flash);
UINT _lx_nor_flash_extended_cache_enable(LX_NOR_FLASH *nor_flash, VOID *memory, ULONG size); UINT _lx_nor_flash_extended_cache_enable(LX_NOR_FLASH *nor_flash, VOID *memory, ULONG size);
UINT _lx_nor_flash_initialize(void); UINT _lx_nor_flash_initialize(void);
UINT _lx_nor_flash_format(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *), VOID *nor_driver_info_ptr);
UINT _lx_nor_flash_open(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *)); UINT _lx_nor_flash_open(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *));
UINT _lx_nor_flash_open_extended(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *), VOID *nor_driver_info_ptr);
UINT _lx_nor_flash_partial_defragment(LX_NOR_FLASH *nor_flash, UINT max_blocks); UINT _lx_nor_flash_partial_defragment(LX_NOR_FLASH *nor_flash, UINT max_blocks);
UINT _lx_nor_flash_sector_read(LX_NOR_FLASH *nor_flash, ULONG logical_sector, VOID *buffer); UINT _lx_nor_flash_sector_read(LX_NOR_FLASH *nor_flash, ULONG logical_sector, VOID *buffer);
UINT _lx_nor_flash_sector_release(LX_NOR_FLASH *nor_flash, ULONG logical_sector); UINT _lx_nor_flash_sector_release(LX_NOR_FLASH *nor_flash, ULONG logical_sector);
@@ -807,6 +793,9 @@ UINT _lx_nand_flash_metadata_write(LX_NAND_FLASH *nand_flash, UCHAR* main_buf
VOID _lx_nand_flash_system_error(LX_NAND_FLASH *nand_flash, UINT error_code, ULONG block, ULONG page); VOID _lx_nand_flash_system_error(LX_NAND_FLASH *nand_flash, UINT error_code, ULONG block, ULONG page);
UINT _lx_nand_flash_256byte_ecc_check(UCHAR *page_buffer, UCHAR *ecc_buffer); UINT _lx_nand_flash_256byte_ecc_check(UCHAR *page_buffer, UCHAR *ecc_buffer);
UINT _lx_nand_flash_256byte_ecc_compute(UCHAR *page_buffer, UCHAR *ecc_buffer); UINT _lx_nand_flash_256byte_ecc_compute(UCHAR *page_buffer, UCHAR *ecc_buffer);
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
UINT _lx_nand_flash_logical_group_compact(LX_NAND_FLASH *nand_flash, ULONG logical_group);
#endif
UINT _lx_nor_flash_block_reclaim(LX_NOR_FLASH *nor_flash); UINT _lx_nor_flash_block_reclaim(LX_NOR_FLASH *nor_flash);
UINT _lx_nor_flash_driver_block_erase(LX_NOR_FLASH *nor_flash, ULONG block, ULONG erase_count); UINT _lx_nor_flash_driver_block_erase(LX_NOR_FLASH *nor_flash, ULONG block, ULONG erase_count);
+10 -27
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -40,23 +40,6 @@
/* Note that all the defines in this file may also be made on the */ /* Note that all the defines in this file may also be made on the */
/* command line when building LevelX library and application objects. */ /* command line when building LevelX library and application objects. */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 11-09-2020 William E. Lamie Initial Version 6.1.2 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), and */
/* added standalone support, */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), and */
/* added new NAND options, */
/* resulting in version 6.2.1 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added options for mapping , */
/* bitmap cache and obsolete */
/* count cache, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
#ifndef LX_USER_H #ifndef LX_USER_H
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -117,19 +117,6 @@ VOID _fx_nand_flash_simulator_driver(FX_MEDIA *media_ptr);
/* */ /* */
/* FileX System Functions */ /* FileX System Functions */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* changed to use new API, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
VOID _fx_nand_flash_simulator_driver(FX_MEDIA *media_ptr) VOID _fx_nand_flash_simulator_driver(FX_MEDIA *media_ptr)
{ {
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -110,16 +110,6 @@ VOID _fx_nor_flash_simulator_driver(FX_MEDIA *media_ptr);
/* */ /* */
/* FileX System Functions */ /* FileX System Functions */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
VOID _fx_nor_flash_simulator_driver(FX_MEDIA *media_ptr) VOID _fx_nor_flash_simulator_driver(FX_MEDIA *media_ptr)
{ {
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,16 +67,6 @@
/* */ /* */
/* _lx_nand_flash_page_ecc_check NAND page check */ /* _lx_nand_flash_page_ecc_check NAND page check */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_256byte_ecc_check(UCHAR *page_buffer, UCHAR *ecc_buffer) UINT _lx_nand_flash_256byte_ecc_check(UCHAR *page_buffer, UCHAR *ecc_buffer)
{ {
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,19 +68,6 @@
/* _lx_nand_flash_page_ecc_compute NAND page ECC compute */ /* _lx_nand_flash_page_ecc_compute NAND page ECC compute */
/* _lx_nand_flash_256byte_ecc_check Check 256 bytes and ECC */ /* _lx_nand_flash_256byte_ecc_check Check 256 bytes and ECC */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* inverted output, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_256byte_ecc_compute(UCHAR *page_buffer, UCHAR *ecc_buffer) UINT _lx_nand_flash_256byte_ecc_compute(UCHAR *page_buffer, UCHAR *ecc_buffer)
{ {
+48 -16
View File
@@ -1,14 +1,15 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/ /**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -66,12 +67,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_block_allocate(LX_NAND_FLASH* nand_flash, ULONG* block) UINT _lx_nand_flash_block_allocate(LX_NAND_FLASH* nand_flash, ULONG* block)
{ {
@@ -81,6 +76,43 @@ UINT _lx_nand_flash_block_allocate(LX_NAND_FLASH* nand_flash, ULONG* block)
if (nand_flash -> lx_nand_flash_free_block_list_tail == 0) if (nand_flash -> lx_nand_flash_free_block_list_tail == 0)
{ {
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
{
ULONG lg;
UINT compact_status;
/* Emergency compaction: find any pending compaction and execute it to
reclaim the old full block. */
for (lg = 0; lg < nand_flash -> lx_nand_flash_total_blocks; lg++)
{
if (nand_flash -> lx_nand_flash_block_compaction_table[lg] != (USHORT)LX_NAND_BLOCK_UNMAPPED)
{
compact_status = _lx_nand_flash_logical_group_compact(nand_flash, lg);
if (compact_status == LX_SUCCESS)
{
/* Retry the allocation after compaction freed a block. */
if (nand_flash -> lx_nand_flash_free_block_list_tail > 0)
{
nand_flash -> lx_nand_flash_free_block_list_tail--;
*block = nand_flash -> lx_nand_flash_block_list[nand_flash -> lx_nand_flash_free_block_list_tail];
return(LX_SUCCESS);
}
}
/* Attempt only one compaction per allocate call. */
break;
}
}
}
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
/* Empty list, return error. */ /* Empty list, return error. */
return(LX_NO_BLOCKS); return(LX_NO_BLOCKS);
} }
+38 -16
View File
@@ -1,14 +1,15 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/ /**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -79,12 +80,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_block_data_move(LX_NAND_FLASH *nand_flash, ULONG new_block) UINT _lx_nand_flash_block_data_move(LX_NAND_FLASH *nand_flash, ULONG new_block)
{ {
@@ -117,6 +112,33 @@ ULONG block_mapping_index;
return(LX_ERROR); return(LX_ERROR);
} }
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
/* If this logical group has a pending compaction source, redirect the
data move to a full logical-group compact to correctly merge data from
both source blocks. */
if (nand_flash -> lx_nand_flash_block_compaction_table[block_mapping_index] != (USHORT)LX_NAND_BLOCK_UNMAPPED)
{
/* Return the pre-allocated new_block to the free list. */
status = _lx_nand_flash_block_status_set(nand_flash, new_block, LX_NAND_BLOCK_STATUS_FREE);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, new_block, 0);
return(LX_ERROR);
}
_lx_nand_flash_free_block_list_add(nand_flash, new_block);
/* Restore block_mapping_index to the mapped list; mapped_block_list_get
already removed it before this function was called. */
_lx_nand_flash_mapped_block_list_add(nand_flash, block_mapping_index);
/* Perform full compaction merge of both source blocks. */
return(_lx_nand_flash_logical_group_compact(nand_flash, block_mapping_index));
}
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
/* Set new block status to allocated for now. */ /* Set new block status to allocated for now. */
new_block_status = LX_NAND_BLOCK_STATUS_ALLOCATED; new_block_status = LX_NAND_BLOCK_STATUS_ALLOCATED;
+11 -17
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -73,12 +73,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_block_find(LX_NAND_FLASH *nand_flash, ULONG logical_sector, ULONG *block, USHORT *block_status) UINT _lx_nand_flash_block_find(LX_NAND_FLASH *nand_flash, ULONG logical_sector, ULONG *block, USHORT *block_status)
{ {
@@ -91,7 +85,7 @@ UINT _lx_nand_flash_block_find(LX_NAND_FLASH *nand_flash, ULONG logical_sector,
block_mapping_index = logical_sector / nand_flash -> lx_nand_flash_pages_per_block; block_mapping_index = logical_sector / nand_flash -> lx_nand_flash_pages_per_block;
/* Check the address range. */ /* Check the address range. */
if (block_mapping_index > nand_flash -> lx_nand_flash_block_mapping_table_size / sizeof(*nand_flash -> lx_nand_flash_block_mapping_table)) if (block_mapping_index >= nand_flash -> lx_nand_flash_block_mapping_table_size / sizeof(*nand_flash -> lx_nand_flash_block_mapping_table))
{ {
/* Out of range, return an error. */ /* Out of range, return an error. */
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,12 +67,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_block_mapping_set(LX_NAND_FLASH *nand_flash, ULONG logical_sector, ULONG block) UINT _lx_nand_flash_block_mapping_set(LX_NAND_FLASH *nand_flash, ULONG logical_sector, ULONG block)
{ {
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,12 +67,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_block_status_set(LX_NAND_FLASH *nand_flash, ULONG block, ULONG block_status) UINT _lx_nand_flash_block_status_set(LX_NAND_FLASH *nand_flash, ULONG block, ULONG block_status)
{ {
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -65,16 +65,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_close(LX_NAND_FLASH *nand_flash) UINT _lx_nand_flash_close(LX_NAND_FLASH *nand_flash)
{ {
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -74,16 +74,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* 12-31-2023 Xiuwen Cai Modified comment(s), */
/* fixed sequential checking */
/* logic, */
/* resulting in version 6.4.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_data_page_copy(LX_NAND_FLASH* nand_flash, ULONG logical_sector, ULONG source_block, USHORT src_block_status, UINT _lx_nand_flash_data_page_copy(LX_NAND_FLASH* nand_flash, ULONG logical_sector, ULONG source_block, USHORT src_block_status,
ULONG destination_block, USHORT* dest_block_status_ptr, ULONG sectors) ULONG destination_block, USHORT* dest_block_status_ptr, ULONG sectors)
+39 -23
View File
@@ -1,14 +1,15 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/ /**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,27 +69,42 @@
/* Application Code */ /* Application Code */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* deprecated this API, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_defragment(LX_NAND_FLASH *nand_flash) UINT _lx_nand_flash_defragment(LX_NAND_FLASH *nand_flash)
{ {
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
UINT status;
ULONG lg;
/* Compact every logical group that has a deferred compaction pending. */
for (lg = 0; lg < nand_flash -> lx_nand_flash_total_blocks; lg++)
{
if (nand_flash -> lx_nand_flash_block_compaction_table[lg] != (USHORT)LX_NAND_BLOCK_UNMAPPED)
{
status = _lx_nand_flash_logical_group_compact(nand_flash, lg);
/* On error, continue to compact remaining groups. */
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, lg, 0);
}
}
}
return(LX_SUCCESS);
#else
LX_PARAMETER_NOT_USED(nand_flash); LX_PARAMETER_NOT_USED(nand_flash);
/* Return not supported. */ /* Return not supported. */
return(LX_NOT_SUPPORTED); return(LX_NOT_SUPPORTED);
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
} }
+10 -24
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,20 +67,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* removed cache support, */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_driver_block_erase(LX_NAND_FLASH *nand_flash, ULONG block, ULONG erase_count) UINT _lx_nand_flash_driver_block_erase(LX_NAND_FLASH *nand_flash, ULONG block, ULONG erase_count)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,19 +68,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_driver_block_erased_verify(LX_NAND_FLASH *nand_flash, ULONG block) UINT _lx_nand_flash_driver_block_erased_verify(LX_NAND_FLASH *nand_flash, ULONG block)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -69,20 +69,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* removed cache support, */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_driver_block_status_get(LX_NAND_FLASH *nand_flash, ULONG block, UCHAR *bad_block_flag) UINT _lx_nand_flash_driver_block_status_get(LX_NAND_FLASH *nand_flash, ULONG block, UCHAR *bad_block_flag)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -69,20 +69,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* removed cache support, */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_driver_block_status_set(LX_NAND_FLASH *nand_flash, ULONG block, UCHAR bad_block_flag) UINT _lx_nand_flash_driver_block_status_set(LX_NAND_FLASH *nand_flash, ULONG block, UCHAR bad_block_flag)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,19 +68,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_driver_page_erased_verify(LX_NAND_FLASH *nand_flash, ULONG block, ULONG page) UINT _lx_nand_flash_driver_page_erased_verify(LX_NAND_FLASH *nand_flash, ULONG block, ULONG page)
{ {
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,12 +67,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_erase_count_set(LX_NAND_FLASH *nand_flash, ULONG block, UCHAR erase_count) UINT _lx_nand_flash_erase_count_set(LX_NAND_FLASH *nand_flash, ULONG block, UCHAR erase_count)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -70,19 +70,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* deprecated this API, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_extended_cache_enable(LX_NAND_FLASH *nand_flash, VOID *memory, ULONG size) UINT _lx_nand_flash_extended_cache_enable(LX_NAND_FLASH *nand_flash, VOID *memory, ULONG size)
{ {
+16 -218
View File
@@ -1,13 +1,14 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ * Copyright (c) 2025 STMicroelectronics
/* This software is licensed under the Microsoft Software License */ *
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * This program and the accompanying materials are made available under the
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * terms of the MIT License which is available at
/* and in the root directory of this software. */ * https://opensource.org/licenses/MIT.
/* */ *
/**************************************************************************/ * SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -40,7 +41,7 @@
/* FUNCTION RELEASE */ /* FUNCTION RELEASE */
/* */ /* */
/* _lx_nand_flash_format PORTABLE C */ /* _lx_nand_flash_format PORTABLE C */
/* 6.3.0 */ /* */
/* AUTHOR */ /* AUTHOR */
/* */ /* */
/* Xiuwen Cai, Microsoft Corporation */ /* Xiuwen Cai, Microsoft Corporation */
@@ -65,224 +66,21 @@
/* return status */ /* return status */
/* */ /* */
/* CALLS */ /* CALLS */
/* */ /* _lx_nand_flash_format_extended */
/* (nand_driver_initialize) Driver initialize */
/* LX_MEMSET Initialize memory */
/* _lx_nand_flash_memory_initialize Initialize buffer */
/* _lx_nand_flash_driver_block_status_get */
/* Driver block status get */
/* _lx_nand_flash_driver_block_status_set */
/* Driver block status set */
/* _lx_nand_flash_metadata_build Build metadata */
/* _lx_nand_flash_metadata_write Write metadata */
/* _lx_nand_flash_driver_block_erase Driver block erase */
/* _lx_nand_flash_system_error System error handler */
/* tx_mutex_create Create thread-safe mutex */
/* */ /* */
/* CALLED BY */ /* CALLED BY */
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* avoided clearing user */
/* extension in flash control */
/* block, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_format(LX_NAND_FLASH* nand_flash, CHAR* name, UINT _lx_nand_flash_format(LX_NAND_FLASH* nand_flash, CHAR* name,
UINT(*nand_driver_initialize)(LX_NAND_FLASH*), UINT(*nand_driver_initialize)(LX_NAND_FLASH*),
ULONG* memory_ptr, UINT memory_size) ULONG* memory_ptr, UINT memory_size)
{ {
ULONG block; UINT status;
UCHAR block_status;
UINT status;
UCHAR *page_buffer_ptr;
LX_PARAMETER_NOT_USED(name); status = _lx_nand_flash_format_extended(nand_flash, name, nand_driver_initialize, NULL, memory_ptr, memory_size);
/* Clear the NAND flash control block. User extension is not cleared. */ return status;
LX_MEMSET(nand_flash, 0, (ULONG)((UCHAR*)&(nand_flash -> lx_nand_flash_open_previous) - (UCHAR*)nand_flash) + sizeof(nand_flash -> lx_nand_flash_open_previous));
/* Call the flash driver's initialization function. */
(nand_driver_initialize)(nand_flash);
/* Determine if we can support this NAND flash size. */
if (nand_flash -> lx_nand_flash_pages_per_block > LX_NAND_MAX_PAGE_PER_BLOCK || nand_flash -> lx_nand_flash_total_blocks > LX_NAND_MAX_BLOCK_COUNT)
{
return(LX_ERROR);
}
/* Check if it is new LevelX NAND driver. */
if (nand_flash -> lx_nand_flash_driver_pages_read == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_write == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_copy == LX_NULL)
{
return(LX_ERROR);
}
/* Check the spare data length. */
if (nand_flash -> lx_nand_flash_spare_data1_length < sizeof(ULONG))
{
return(LX_ERROR);
}
/* Calculate the number of words per block and per page. */
nand_flash -> lx_nand_flash_words_per_page = (nand_flash -> lx_nand_flash_bytes_per_page / sizeof(ULONG));
nand_flash -> lx_nand_flash_words_per_block = (nand_flash -> lx_nand_flash_words_per_page * nand_flash -> lx_nand_flash_pages_per_block);
/* Calculate the total pages. */
nand_flash -> lx_nand_flash_total_pages = nand_flash -> lx_nand_flash_total_blocks * nand_flash -> lx_nand_flash_pages_per_block;
/* Initialize memory buffer. */
status = _lx_nand_flash_memory_initialize(nand_flash, memory_ptr, memory_size);
if (status != LX_SUCCESS)
{
return(status);
}
/* Initialize block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
/* Initialize the block status buffer. */
LX_MEMSET(nand_flash -> lx_nand_flash_block_status_table, 0xFF, nand_flash -> lx_nand_flash_block_status_table_size);
/* Loop through the blocks to check for bad blocks and determine the minimum and maximum erase count for each good block. */
for (block = 0; block < nand_flash -> lx_nand_flash_total_blocks; block++)
{
/* First, check to make sure this block is good. */
status = _lx_nand_flash_driver_block_status_get(nand_flash, block, &block_status);
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Return an error. */
return(LX_ERROR);
}
/* Is this block bad? */
if (block_status != LX_NAND_GOOD_BLOCK)
{
/* Yes, this block is bad. */
/* Increment the number of bad blocks. */
nand_flash -> lx_nand_flash_bad_blocks++;
/* Save the block status. */
nand_flash -> lx_nand_flash_block_status_table[block] = LX_NAND_BLOCK_STATUS_BAD;
/* Continue to the next block. */
continue;
}
/* Erase the block. */
status = _lx_nand_flash_driver_block_erase(nand_flash, block, 0);
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Attempt to mark this block as bad. */
status = _lx_nand_flash_driver_block_status_set(nand_flash, block, LX_NAND_BAD_BLOCK);
/* Check for error in setting the block status. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
}
/* Increment the bad block count. */
nand_flash -> lx_nand_flash_bad_blocks++;
/* Save the block status. */
nand_flash -> lx_nand_flash_block_status_table[block] = LX_NAND_BLOCK_STATUS_BAD;
}
else
{
/* Allocate blocks for metadata. */
if (nand_flash -> lx_nand_flash_metadata_block_number == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_metadata_block_number = block;
nand_flash -> lx_nand_flash_metadata_block_number_current = block;
}
else if (nand_flash -> lx_nand_flash_backup_metadata_block_number == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_backup_metadata_block_number = block;
nand_flash -> lx_nand_flash_backup_metadata_block_number_current = block;
}
else if (nand_flash -> lx_nand_flash_metadata_block_number_next == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_metadata_block_number_next = block;
}
else if (nand_flash -> lx_nand_flash_backup_metadata_block_number_next == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = block;
}
}
}
/* There should be enough blocks for metadata. */
if (nand_flash -> lx_nand_flash_backup_metadata_block_number_next == LX_NAND_BLOCK_UNMAPPED)
{
return (LX_NO_BLOCKS);
}
/* Save the block status for metadata. */
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_backup_metadata_block_number_next] = LX_NAND_BLOCK_STATUS_ALLOCATED;
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_metadata_block_number_next] = LX_NAND_BLOCK_STATUS_ALLOCATED;
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_backup_metadata_block_number] = (USHORT)nand_flash -> lx_nand_flash_backup_metadata_block_number_next;
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_metadata_block_number] = (USHORT)nand_flash -> lx_nand_flash_metadata_block_number_next;
/* Initialize the mapping table. */
LX_MEMSET(nand_flash -> lx_nand_flash_block_mapping_table, 0xFF, nand_flash -> lx_nand_flash_block_mapping_table_size);
/* Build initial metadata. */
status = _lx_nand_flash_metadata_build(nand_flash);
if (status != LX_SUCCESS)
{
/* Return error status. */
return(status);
}
/* Get buffer for page data. */
page_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer;
/* Initialize the page buffer. */
LX_MEMSET(page_buffer_ptr, 0xFF, nand_flash -> lx_nand_flash_bytes_per_page);
/* Set the next block numbers. */
LX_UTILITY_LONG_SET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_MAIN_METADATA_OFFSET], nand_flash -> lx_nand_flash_metadata_block_number_next);
LX_UTILITY_LONG_SET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_BACKUP_METADATA_OFFSET], nand_flash -> lx_nand_flash_backup_metadata_block_number_next);
/* Save the next block numbers to metadata block. */
status = _lx_nand_flash_metadata_write(nand_flash, page_buffer_ptr, LX_NAND_PAGE_TYPE_BLOCK_LINK);
if (status != LX_SUCCESS)
{
/* Return error status. */
return(status);
}
/* Return a successful completion. */
return(LX_SUCCESS);
} }
+280
View File
@@ -0,0 +1,280 @@
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
* Copyright (c) 2025 STMicroelectronics
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** LevelX Component */
/** */
/** NAND Flash */
/** */
/**************************************************************************/
/**************************************************************************/
#define LX_SOURCE_CODE
/* Disable ThreadX error checking. */
#ifndef LX_DISABLE_ERROR_CHECKING
#define LX_DISABLE_ERROR_CHECKING
#endif
/* Include necessary system files. */
#include "lx_api.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nand_flash_format_extended PORTABLE C */
/* */
/* AUTHOR */
/* */
/* Xiuwen Cai, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function erases and formats a NAND flash. */
/* */
/* INPUT */
/* */
/* nand_flash NAND flash instance */
/* name Name of NAND flash instance */
/* nand_driver_initialize Driver initialize */
/* nand_driver_info_ptr Driver user data pointer */
/* memory_ptr Pointer to memory used by the */
/* LevelX for this NAND. */
/* memory_size Size of memory - must at least*/
/* 7 * total block count + */
/* 2 * page size */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* */
/* (nand_driver_initialize) Driver initialize */
/* LX_MEMSET Initialize memory */
/* _lx_nand_flash_memory_initialize Initialize buffer */
/* _lx_nand_flash_driver_block_status_get */
/* Driver block status get */
/* _lx_nand_flash_driver_block_status_set */
/* Driver block status set */
/* _lx_nand_flash_metadata_build Build metadata */
/* _lx_nand_flash_metadata_write Write metadata */
/* _lx_nand_flash_driver_block_erase Driver block erase */
/* _lx_nand_flash_system_error System error handler */
/* tx_mutex_create Create thread-safe mutex */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/**************************************************************************/
UINT _lx_nand_flash_format_extended(LX_NAND_FLASH* nand_flash, CHAR* name,
UINT(*nand_driver_initialize)(LX_NAND_FLASH*),VOID* nand_driver_info_ptr,
ULONG* memory_ptr, UINT memory_size)
{
ULONG block;
UCHAR block_status;
UINT status;
UCHAR *page_buffer_ptr;
LX_PARAMETER_NOT_USED(name);
/* Clear the NAND flash control block. User extension is not cleared. */
LX_MEMSET(nand_flash, 0, (ULONG)((UCHAR*)&(nand_flash -> lx_nand_flash_open_previous) - (UCHAR*)nand_flash) + sizeof(nand_flash -> lx_nand_flash_open_previous));
nand_flash -> lx_nand_flash_driver_info_ptr = nand_driver_info_ptr;
/* Call the flash driver's initialization function. */
(nand_driver_initialize)(nand_flash);
/* Determine if we can support this NAND flash size. */
if (nand_flash -> lx_nand_flash_pages_per_block > LX_NAND_MAX_PAGE_PER_BLOCK || nand_flash -> lx_nand_flash_total_blocks > LX_NAND_MAX_BLOCK_COUNT)
{
return(LX_ERROR);
}
/* Check if it is new LevelX NAND driver. */
if (nand_flash -> lx_nand_flash_driver_pages_read == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_write == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_copy == LX_NULL)
{
return(LX_ERROR);
}
/* Check the spare data length. */
if (nand_flash -> lx_nand_flash_spare_data1_length < sizeof(ULONG))
{
return(LX_ERROR);
}
/* Calculate the number of words per block and per page. */
nand_flash -> lx_nand_flash_words_per_page = (nand_flash -> lx_nand_flash_bytes_per_page / sizeof(ULONG));
nand_flash -> lx_nand_flash_words_per_block = (nand_flash -> lx_nand_flash_words_per_page * nand_flash -> lx_nand_flash_pages_per_block);
/* Calculate the total pages. */
nand_flash -> lx_nand_flash_total_pages = nand_flash -> lx_nand_flash_total_blocks * nand_flash -> lx_nand_flash_pages_per_block;
/* Initialize memory buffer. */
status = _lx_nand_flash_memory_initialize(nand_flash, memory_ptr, memory_size);
if (status != LX_SUCCESS)
{
return(status);
}
/* Initialize block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
/* Initialize the block status buffer. */
LX_MEMSET(nand_flash -> lx_nand_flash_block_status_table, 0xFF, nand_flash -> lx_nand_flash_block_status_table_size);
/* Loop through the blocks to check for bad blocks and determine the minimum and maximum erase count for each good block. */
for (block = 0; block < nand_flash -> lx_nand_flash_total_blocks; block++)
{
/* First, check to make sure this block is good. */
status = _lx_nand_flash_driver_block_status_get(nand_flash, block, &block_status);
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Return an error. */
return(LX_ERROR);
}
/* Is this block bad? */
if (block_status != LX_NAND_GOOD_BLOCK)
{
/* Yes, this block is bad. */
/* Increment the number of bad blocks. */
nand_flash -> lx_nand_flash_bad_blocks++;
/* Save the block status. */
nand_flash -> lx_nand_flash_block_status_table[block] = LX_NAND_BLOCK_STATUS_BAD;
/* Continue to the next block. */
continue;
}
/* Erase the block. */
status = _lx_nand_flash_driver_block_erase(nand_flash, block, 0);
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Attempt to mark this block as bad. */
status = _lx_nand_flash_driver_block_status_set(nand_flash, block, LX_NAND_BAD_BLOCK);
/* Check for error in setting the block status. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
}
/* Increment the bad block count. */
nand_flash -> lx_nand_flash_bad_blocks++;
/* Save the block status. */
nand_flash -> lx_nand_flash_block_status_table[block] = LX_NAND_BLOCK_STATUS_BAD;
}
else
{
/* Allocate blocks for metadata. */
if (nand_flash -> lx_nand_flash_metadata_block_number == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_metadata_block_number = block;
nand_flash -> lx_nand_flash_metadata_block_number_current = block;
}
else if (nand_flash -> lx_nand_flash_backup_metadata_block_number == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_backup_metadata_block_number = block;
nand_flash -> lx_nand_flash_backup_metadata_block_number_current = block;
}
else if (nand_flash -> lx_nand_flash_metadata_block_number_next == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_metadata_block_number_next = block;
}
else if (nand_flash -> lx_nand_flash_backup_metadata_block_number_next == LX_NAND_BLOCK_UNMAPPED)
{
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = block;
}
}
}
/* There should be enough blocks for metadata. */
if (nand_flash -> lx_nand_flash_backup_metadata_block_number_next == LX_NAND_BLOCK_UNMAPPED)
{
return (LX_NO_BLOCKS);
}
/* Save the block status for metadata. */
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_backup_metadata_block_number_next] = LX_NAND_BLOCK_STATUS_ALLOCATED;
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_metadata_block_number_next] = LX_NAND_BLOCK_STATUS_ALLOCATED;
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_backup_metadata_block_number] = (USHORT)nand_flash -> lx_nand_flash_backup_metadata_block_number_next;
nand_flash -> lx_nand_flash_block_status_table[nand_flash -> lx_nand_flash_metadata_block_number] = (USHORT)nand_flash -> lx_nand_flash_metadata_block_number_next;
/* Initialize the mapping table. */
LX_MEMSET(nand_flash -> lx_nand_flash_block_mapping_table, 0xFF, nand_flash -> lx_nand_flash_block_mapping_table_size);
/* Build initial metadata. */
status = _lx_nand_flash_metadata_build(nand_flash);
if (status != LX_SUCCESS)
{
/* Return error status. */
return(status);
}
/* Get buffer for page data. */
page_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer;
/* Initialize the page buffer. */
LX_MEMSET(page_buffer_ptr, 0xFF, nand_flash -> lx_nand_flash_bytes_per_page);
/* Set the next block numbers. */
LX_UTILITY_LONG_SET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_MAIN_METADATA_OFFSET], nand_flash -> lx_nand_flash_metadata_block_number_next);
LX_UTILITY_LONG_SET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_BACKUP_METADATA_OFFSET], nand_flash -> lx_nand_flash_backup_metadata_block_number_next);
/* Save the next block numbers to metadata block. */
status = _lx_nand_flash_metadata_write(nand_flash, page_buffer_ptr, LX_NAND_PAGE_TYPE_BLOCK_LINK);
if (status != LX_SUCCESS)
{
/* Return error status. */
return(status);
}
/* Return a successful completion. */
return(LX_SUCCESS);
}
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -66,12 +66,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_free_block_list_add(LX_NAND_FLASH* nand_flash, ULONG block) UINT _lx_nand_flash_free_block_list_add(LX_NAND_FLASH* nand_flash, ULONG block)
{ {
+10 -18
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -64,14 +64,6 @@ ULONG _lx_nand_flash_opened_count;
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_initialize(void) UINT _lx_nand_flash_initialize(void)
{ {
@@ -0,0 +1,447 @@
/***************************************************************************
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/
/**************************************************************************/
/** */
/** LevelX Component */
/** */
/** NAND Flash */
/** */
/**************************************************************************/
/**************************************************************************/
#define LX_SOURCE_CODE
/* Disable ThreadX error checking. */
#ifndef LX_DISABLE_ERROR_CHECKING
#define LX_DISABLE_ERROR_CHECKING
#endif
/* Include necessary system files. */
#include "lx_api.h"
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nand_sector_find_in_block PORTABLE C */
/* 6.5.0 */
/* AUTHOR */
/* */
/* Eclipse ThreadX contributors */
/* */
/* DESCRIPTION */
/* */
/* This helper scans a block for a specific logical sector and returns */
/* the page number and kind (data / released / not found). */
/* */
/* INPUT */
/* */
/* nand_flash NAND flash instance */
/* block Physical block number */
/* block_status Block status word */
/* logical_sector Logical sector to search for */
/* found_page Destination: page index found */
/* sector_kind Destination: kind (see below) */
/* */
/* OUTPUT */
/* */
/* LX_SUCCESS Sector found; outputs set */
/* LX_NO_BLOCKS Sector not present in block */
/* LX_ERROR Driver error */
/* */
/* SECTOR KIND VALUES (written to *sector_kind) */
/* */
/* LX_NAND_PAGE_TYPE_USER_DATA Sector contains live data */
/* LX_NAND_PAGE_TYPE_USER_DATA_RELEASED Sector is tombstoned */
/* */
/**************************************************************************/
static UINT _lx_nand_sector_find_in_block(LX_NAND_FLASH *nand_flash,
ULONG block,
USHORT block_status,
ULONG logical_sector,
LONG *found_page,
ULONG *sector_kind)
{
ULONG available_pages;
LONG page;
ULONG spare_data1;
UINT status;
UCHAR *spare_buffer_ptr;
/* Use page buffer as scratch for spare-only reads (per existing LevelX convention). */
spare_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer;
/* Determine page count. */
available_pages = (block_status & LX_NAND_BLOCK_STATUS_FULL) ?
nand_flash -> lx_nand_flash_pages_per_block :
(block_status & LX_NAND_BLOCK_STATUS_PAGE_NUMBER_MASK);
if (block_status & LX_NAND_BLOCK_STATUS_NON_SEQUENTIAL)
{
/* Scan newest-to-oldest so the first match is the authoritative version. */
for (page = (LONG)available_pages - 1; page >= 0; page--)
{
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, (ULONG)page, LX_NULL, spare_buffer_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, (ULONG)page, LX_NULL, spare_buffer_ptr, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, block, 0);
return(LX_ERROR);
}
spare_data1 = LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]);
if ((spare_data1 & LX_NAND_PAGE_TYPE_USER_DATA_MASK) == logical_sector)
{
/* Sector found; return its page index and kind. */
*found_page = page;
*sector_kind = spare_data1 & (~LX_NAND_PAGE_TYPE_USER_DATA_MASK);
return(LX_SUCCESS);
}
}
}
else
{
/* Sequential block: page index == sector offset within group. */
page = (LONG)(logical_sector % nand_flash -> lx_nand_flash_pages_per_block);
if ((ULONG)page < available_pages)
{
*found_page = page;
*sector_kind = LX_NAND_PAGE_TYPE_USER_DATA;
return(LX_SUCCESS);
}
}
*found_page = -1L;
return(LX_NO_BLOCKS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nand_flash_logical_group_compact PORTABLE C */
/* 6.5.0 */
/* AUTHOR */
/* */
/* Eclipse ThreadX contributors */
/* */
/* DESCRIPTION */
/* */
/* This function completes a deferred full-block compaction created by */
/* the lazy sector-release path. It merges the tombstone block */
/* (current mapping) and the compaction-pending old block into a fresh */
/* destination block, then erases both source blocks. */
/* */
/* The tombstone block takes priority: if a sector appears in both */
/* blocks the tombstone block's version is used (newer). */
/* */
/* INPUT */
/* */
/* nand_flash NAND flash instance */
/* logical_group Logical group index */
/* */
/* OUTPUT */
/* */
/* LX_SUCCESS Compaction completed */
/* LX_ERROR / LX_NO_BLOCKS Error during compaction */
/* */
/* CALLS */
/* */
/* _lx_nand_sector_find_in_block Find sector in a block */
/* _lx_nand_flash_block_allocate Allocate a free block */
/* _lx_nand_flash_block_status_set Set block status */
/* _lx_nand_flash_block_mapping_set Update logical-to-physical map*/
/* _lx_nand_flash_mapped_block_list_remove Remove from mapped list */
/* _lx_nand_flash_mapped_block_list_add Add to mapped list */
/* _lx_nand_flash_free_block_list_add Return block to free list */
/* _lx_nand_flash_driver_block_erase Erase a block */
/* _lx_nand_flash_erase_count_set Record new erase count */
/* _lx_nand_flash_block_data_move Wear-level an over-erased blk */
/* _lx_nand_flash_system_error Internal system error handler */
/* lx_nand_flash_driver_pages_copy Copy a page between blocks */
/* */
/* CALLED BY */
/* */
/* _lx_nand_flash_sector_release Lazy release pre-compact */
/* _lx_nand_flash_sector_write Pre-compact before block copy */
/* _lx_nand_flash_block_data_move Wear-level with pending compact*/
/* _lx_nand_flash_defragment Explicit defragment pass */
/* _lx_nand_flash_block_allocate Emergency compaction */
/* */
/**************************************************************************/
UINT _lx_nand_flash_logical_group_compact(LX_NAND_FLASH *nand_flash, ULONG logical_group)
{
UINT status;
ULONG tombstone_block;
ULONG compaction_block;
ULONG dest_block;
USHORT tombstone_block_status;
USHORT compaction_block_status;
USHORT dest_block_status;
ULONG sector;
ULONG base_sector;
LONG source_page;
ULONG dest_page;
ULONG sector_kind;
UINT find_status;
/* Retrieve the two source blocks. */
tombstone_block = nand_flash -> lx_nand_flash_block_mapping_table[logical_group];
compaction_block = nand_flash -> lx_nand_flash_block_compaction_table[logical_group];
tombstone_block_status = nand_flash -> lx_nand_flash_block_status_table[tombstone_block];
compaction_block_status = nand_flash -> lx_nand_flash_block_status_table[compaction_block];
/* Allocate a fresh destination block. */
status = _lx_nand_flash_block_allocate(nand_flash, &dest_block);
if (status != LX_SUCCESS)
{
return(status);
}
dest_block_status = LX_NAND_BLOCK_STATUS_ALLOCATED;
dest_page = 0;
base_sector = logical_group * nand_flash -> lx_nand_flash_pages_per_block;
/* Merge loop: iterate every sector in the logical group.
The tombstone block (current mapping) supersedes the compaction block. */
for (sector = base_sector;
sector < base_sector + nand_flash -> lx_nand_flash_pages_per_block;
sector++)
{
source_page = -1L;
sector_kind = 0;
/* Search the tombstone block first (newer data). */
find_status = _lx_nand_sector_find_in_block(nand_flash, tombstone_block,
tombstone_block_status, sector,
&source_page, &sector_kind);
if (find_status == LX_ERROR)
{
return(LX_ERROR);
}
if (find_status == LX_NO_BLOCKS)
{
/* Not in tombstone block; try the compaction block (older data). */
find_status = _lx_nand_sector_find_in_block(nand_flash, compaction_block,
compaction_block_status, sector,
&source_page, &sector_kind);
if (find_status == LX_ERROR)
{
return(LX_ERROR);
}
if ((find_status == LX_SUCCESS) && (sector_kind == LX_NAND_PAGE_TYPE_USER_DATA))
{
/* Copy live data from compaction block to destination. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_copy)(nand_flash, compaction_block, (ULONG)source_page, dest_block, dest_page, 1, nand_flash -> lx_nand_flash_page_buffer);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_copy)(compaction_block, (ULONG)source_page, dest_block, dest_page, 1, nand_flash -> lx_nand_flash_page_buffer);
#endif
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, dest_block, 0);
return(LX_ERROR);
}
if (dest_page != (sector % nand_flash -> lx_nand_flash_pages_per_block))
{
dest_block_status |= LX_NAND_BLOCK_STATUS_NON_SEQUENTIAL;
}
dest_page++;
}
/* RELEASED or NOT_FOUND in compaction block: sector no longer exists, skip. */
}
else if ((find_status == LX_SUCCESS) && (sector_kind == LX_NAND_PAGE_TYPE_USER_DATA))
{
/* Copy live data from tombstone block to destination. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_copy)(nand_flash, tombstone_block, (ULONG)source_page, dest_block, dest_page, 1, nand_flash -> lx_nand_flash_page_buffer);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_copy)(tombstone_block, (ULONG)source_page, dest_block, dest_page, 1, nand_flash -> lx_nand_flash_page_buffer);
#endif
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, dest_block, 0);
return(LX_ERROR);
}
if (dest_page != (sector % nand_flash -> lx_nand_flash_pages_per_block))
{
dest_block_status |= LX_NAND_BLOCK_STATUS_NON_SEQUENTIAL;
}
dest_page++;
}
/* RELEASED (tombstone found in tombstone block): sector is gone, skip. */
}
/* Encode page count into dest_block_status. */
dest_block_status = (USHORT)((dest_block_status & ~(USHORT)LX_NAND_BLOCK_STATUS_PAGE_NUMBER_MASK) |
(dest_page & LX_NAND_BLOCK_STATUS_PAGE_NUMBER_MASK));
/* Commit destination block or discard it if the entire group was released. */
if (dest_page == 0)
{
/* All sectors released; destination block is unused. */
status = _lx_nand_flash_block_status_set(nand_flash, dest_block, LX_NAND_BLOCK_STATUS_FREE);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, dest_block, 0);
return(LX_ERROR);
}
_lx_nand_flash_free_block_list_add(nand_flash, dest_block);
dest_block = (ULONG)LX_NAND_BLOCK_UNMAPPED;
}
else
{
status = _lx_nand_flash_block_status_set(nand_flash, dest_block, dest_block_status);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, dest_block, 0);
return(LX_ERROR);
}
}
/* Remove tombstone block from the mapped list. */
_lx_nand_flash_mapped_block_list_remove(nand_flash, logical_group);
/* Persist the new mapping (or UNMAPPED if all sectors were released). */
_lx_nand_flash_block_mapping_set(nand_flash, logical_group * nand_flash -> lx_nand_flash_pages_per_block, dest_block);
/* Clear the in-RAM compaction table entry. */
nand_flash -> lx_nand_flash_block_compaction_table[logical_group] = (USHORT)LX_NAND_BLOCK_UNMAPPED;
/* Add destination block to the mapped list if it holds data. */
if (dest_block != (ULONG)LX_NAND_BLOCK_UNMAPPED)
{
_lx_nand_flash_mapped_block_list_add(nand_flash, logical_group);
}
/* ---- Erase tombstone block ---- */
status = _lx_nand_flash_driver_block_erase(nand_flash, tombstone_block,
nand_flash -> lx_nand_flash_base_erase_count +
nand_flash -> lx_nand_flash_erase_count_table[tombstone_block] + 1);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, tombstone_block, 0);
return(LX_ERROR);
}
status = _lx_nand_flash_erase_count_set(nand_flash, tombstone_block,
(UCHAR)(nand_flash -> lx_nand_flash_erase_count_table[tombstone_block] + 1));
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, tombstone_block, 0);
return(LX_ERROR);
}
if (nand_flash -> lx_nand_flash_erase_count_table[tombstone_block] > LX_NAND_FLASH_MAX_ERASE_COUNT_DELTA)
{
status = _lx_nand_flash_block_data_move(nand_flash, tombstone_block);
}
else
{
status = _lx_nand_flash_block_status_set(nand_flash, tombstone_block, LX_NAND_BLOCK_STATUS_FREE);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, tombstone_block, 0);
return(LX_ERROR);
}
status = _lx_nand_flash_free_block_list_add(nand_flash, tombstone_block);
}
if (status)
{
return(LX_ERROR);
}
/* ---- Clear COMPACTION_PENDING flag on the old block, then erase it ---- */
status = _lx_nand_flash_block_status_set(nand_flash, compaction_block,
(USHORT)(nand_flash -> lx_nand_flash_block_status_table[compaction_block] &
~(USHORT)LX_NAND_BLOCK_STATUS_COMPACTION_PENDING));
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, compaction_block, 0);
return(LX_ERROR);
}
status = _lx_nand_flash_driver_block_erase(nand_flash, compaction_block,
nand_flash -> lx_nand_flash_base_erase_count +
nand_flash -> lx_nand_flash_erase_count_table[compaction_block] + 1);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, compaction_block, 0);
return(LX_ERROR);
}
status = _lx_nand_flash_erase_count_set(nand_flash, compaction_block,
(UCHAR)(nand_flash -> lx_nand_flash_erase_count_table[compaction_block] + 1));
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, compaction_block, 0);
return(LX_ERROR);
}
if (nand_flash -> lx_nand_flash_erase_count_table[compaction_block] > LX_NAND_FLASH_MAX_ERASE_COUNT_DELTA)
{
status = _lx_nand_flash_block_data_move(nand_flash, compaction_block);
}
else
{
status = _lx_nand_flash_block_status_set(nand_flash, compaction_block, LX_NAND_BLOCK_STATUS_FREE);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, compaction_block, 0);
return(LX_ERROR);
}
status = _lx_nand_flash_free_block_list_add(nand_flash, compaction_block);
}
return(status);
}
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -66,12 +66,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_mapped_block_list_add(LX_NAND_FLASH* nand_flash, ULONG block_mapping_index) UINT _lx_nand_flash_mapped_block_list_add(LX_NAND_FLASH* nand_flash, ULONG block_mapping_index)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,12 +67,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_mapped_block_list_get(LX_NAND_FLASH* nand_flash, ULONG *block_mapping_index) UINT _lx_nand_flash_mapped_block_list_get(LX_NAND_FLASH* nand_flash, ULONG *block_mapping_index)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -66,12 +66,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_mapped_block_list_remove(LX_NAND_FLASH* nand_flash, ULONG block_mapping_index) UINT _lx_nand_flash_mapped_block_list_remove(LX_NAND_FLASH* nand_flash, ULONG block_mapping_index)
{ {
+53 -16
View File
@@ -1,14 +1,15 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/ /**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,12 +69,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_memory_initialize(LX_NAND_FLASH *nand_flash, ULONG* memory_ptr, UINT memory_size) UINT _lx_nand_flash_memory_initialize(LX_NAND_FLASH *nand_flash, ULONG* memory_ptr, UINT memory_size)
{ {
@@ -187,6 +182,48 @@ UINT buffer_size;
return(LX_NO_MEMORY); return(LX_NO_MEMORY);
} }
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
{
ULONG i;
ULONG compaction_table_entries;
/* Set memory size for block compaction table. Same element type as block_mapping_table. */
buffer_size = nand_flash -> lx_nand_flash_total_blocks * sizeof(*nand_flash -> lx_nand_flash_block_compaction_table);
/* Make sure the size is at least one page size. */
if (buffer_size < nand_flash -> lx_nand_flash_bytes_per_page)
{
buffer_size = nand_flash -> lx_nand_flash_bytes_per_page;
}
/* Assign memory for block compaction table. */
nand_flash -> lx_nand_flash_block_compaction_table = (USHORT*)(((UCHAR*)memory_ptr) + memory_offset);
/* Update block compaction table size. */
nand_flash -> lx_nand_flash_block_compaction_table_size = buffer_size;
/* Update memory offset. */
memory_offset += buffer_size;
/* Check if there is enough memory. */
if (memory_offset > memory_size)
{
/* No enough memory, return error. */
return(LX_NO_MEMORY);
}
/* Initialize all compaction table entries to unmapped. (LX_MEMSET zero-fills the buffer
above, but LX_NAND_BLOCK_UNMAPPED is 0xFFFF, so explicit initialisation is required.) */
compaction_table_entries = buffer_size / sizeof(*nand_flash -> lx_nand_flash_block_compaction_table);
for (i = 0; i < compaction_table_entries; i++)
{
nand_flash -> lx_nand_flash_block_compaction_table[i] = (USHORT)LX_NAND_BLOCK_UNMAPPED;
}
}
#endif
/* Assign memory for page buffer. */ /* Assign memory for page buffer. */
nand_flash -> lx_nand_flash_page_buffer = ((UCHAR*)memory_ptr) + memory_offset; nand_flash -> lx_nand_flash_page_buffer = ((UCHAR*)memory_ptr) + memory_offset;
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -74,12 +74,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_metadata_allocate(LX_NAND_FLASH *nand_flash) UINT _lx_nand_flash_metadata_allocate(LX_NAND_FLASH *nand_flash)
{ {
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -65,12 +65,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_metadata_build(LX_NAND_FLASH *nand_flash) UINT _lx_nand_flash_metadata_build(LX_NAND_FLASH *nand_flash)
{ {
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -70,12 +70,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_metadata_write(LX_NAND_FLASH *nand_flash, UCHAR* main_buffer, ULONG spare_value) UINT _lx_nand_flash_metadata_write(LX_NAND_FLASH *nand_flash, UCHAR* main_buffer, ULONG spare_value)
{ {
+15 -462
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -55,6 +55,7 @@
/* nand_flash NAND flash instance */ /* nand_flash NAND flash instance */
/* name Name of NAND flash instance */ /* name Name of NAND flash instance */
/* nand_driver_initialize Driver initialize */ /* nand_driver_initialize Driver initialize */
/* nand_driver_info_ptr User data pointer */
/* memory_ptr Pointer to memory used by the */ /* memory_ptr Pointer to memory used by the */
/* LevelX for this NAND. */ /* LevelX for this NAND. */
/* memory_size Size of memory - must at least*/ /* memory_size Size of memory - must at least*/
@@ -67,467 +68,19 @@
/* */ /* */
/* CALLS */ /* CALLS */
/* */ /* */
/* (nand_driver_initialize) Driver initialize */ /* lx_nand_flash_open_extended Pass NULL as driver_info_ptr */
/* _lx_nand_flash_memory_initialize Initialize buffer */
/* _lx_nand_flash_driver_block_status_get */
/* Get block status */
/* lx_nand_flash_driver_pages_read Read pages */
/* _lx_nand_flash_free_block_list_add Add free block to list */
/* _lx_nand_flash_mapped_block_list_add Add mapped block to list */
/* _lx_nand_flash_system_error System error handler */
/* tx_mutex_create Create thread-safe mutex */
/* */ /* */
/* CALLED BY */ /* CALLED BY */
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* avoided clearing user */
/* extension in flash control */
/* block, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_open(LX_NAND_FLASH *nand_flash, CHAR *name, UINT (*nand_driver_initialize)(LX_NAND_FLASH *), UINT _lx_nand_flash_open(LX_NAND_FLASH *nand_flash, CHAR *name, UINT (*nand_driver_initialize)(LX_NAND_FLASH *),
ULONG* memory_ptr, UINT memory_size) ULONG* memory_ptr, UINT memory_size)
{ {
UINT status = LX_ERROR;
ULONG block; status = _lx_nand_flash_open_extended(nand_flash, name, nand_driver_initialize, NULL, memory_ptr, memory_size);
ULONG page;
UCHAR block_status;
ULONG block_count;
UINT status;
LX_NAND_FLASH *tail_ptr;
LX_NAND_DEVICE_INFO *nand_device_info_page;
UCHAR *spare_buffer_ptr;
UCHAR *page_buffer_ptr;
ULONG page_type;
UCHAR page_index;
LX_INTERRUPT_SAVE_AREA
LX_PARAMETER_NOT_USED(name); return status;
/* Clear the NAND flash control block. User extension is not cleared. */
LX_MEMSET(nand_flash, 0, (ULONG)((UCHAR*)&(nand_flash -> lx_nand_flash_open_previous) - (UCHAR*)nand_flash) + sizeof(nand_flash -> lx_nand_flash_open_previous));
/* Call the flash driver's initialization function. */
(nand_driver_initialize)(nand_flash);
/* Determine if we can support this NAND flash size. */
if (nand_flash -> lx_nand_flash_pages_per_block > LX_NAND_MAX_PAGE_PER_BLOCK || nand_flash -> lx_nand_flash_total_blocks > LX_NAND_MAX_BLOCK_COUNT)
{
/* Return an error. */
return(LX_ERROR);
}
/* Check if it is new LevelX NAND driver. */
if (nand_flash -> lx_nand_flash_driver_pages_read == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_write == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_copy == LX_NULL)
{
/* Return an error. */
return(LX_ERROR);
}
/* Check the spare data length. */
if (nand_flash -> lx_nand_flash_spare_data1_length < sizeof(ULONG))
{
/* Return an error. */
return(LX_ERROR);
}
/* Calculate the number of words per block and per page. */
nand_flash -> lx_nand_flash_words_per_page = (nand_flash -> lx_nand_flash_bytes_per_page / sizeof(ULONG));
nand_flash -> lx_nand_flash_words_per_block = (nand_flash -> lx_nand_flash_words_per_page * nand_flash -> lx_nand_flash_pages_per_block);
/* Calculate the total pages. */
nand_flash -> lx_nand_flash_total_pages = nand_flash -> lx_nand_flash_total_blocks * nand_flash -> lx_nand_flash_pages_per_block;
/* Initialize memory buffer. */
status = _lx_nand_flash_memory_initialize(nand_flash, memory_ptr, memory_size);
if (status != LX_SUCCESS)
{
return(status);
}
/* Initialize block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
/* Setup page buffer and spare buffer pointers. */
page_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer;
spare_buffer_ptr = page_buffer_ptr + nand_flash -> lx_nand_flash_bytes_per_page;
/* Loop through the blocks to check for bad blocks and determine the minimum and maximum erase count for each good block. */
for (block = 0; block < nand_flash -> lx_nand_flash_total_blocks; block++)
{
/* First, check to make sure this block is good. */
status = _lx_nand_flash_driver_block_status_get(nand_flash, block, &block_status);
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Return an error. */
return(LX_ERROR);
}
/* Is this block bad? */
if (block_status != LX_NAND_GOOD_BLOCK)
{
/* Yes, this block is bad. */
/* Increment the number of bad blocks. */
nand_flash -> lx_nand_flash_bad_blocks++;
/* Save the block status. */
nand_flash -> lx_nand_flash_block_status_table[block] = LX_NAND_BLOCK_STATUS_BAD;
/* Continue to the next block. */
continue;
}
/* Call driver read function to read page 0. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, 0, page_buffer_ptr, spare_buffer_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, 0, page_buffer_ptr, spare_buffer_ptr, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Determine if the error is fatal. */
if (status != LX_NAND_ERROR_CORRECTED)
{
/* Return an error. */
return(LX_ERROR);
}
}
/* Get the page type. */
page_type = LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]);
/* Check if the type is device info. */
if (page_type == LX_NAND_PAGE_TYPE_DEVICE_INFO)
{
/* Get the device info page. */
nand_device_info_page = (LX_NAND_DEVICE_INFO*)page_buffer_ptr;
/* Check signature. */
if (nand_device_info_page -> lx_nand_device_info_signature1 == LX_NAND_DEVICE_INFO_SIGNATURE1 &&
nand_device_info_page -> lx_nand_device_info_signature2 == LX_NAND_DEVICE_INFO_SIGNATURE2)
{
/* Save the block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number = nand_device_info_page -> lx_nand_device_info_metadata_block_number;
nand_flash -> lx_nand_flash_backup_metadata_block_number = nand_device_info_page -> lx_nand_device_info_backup_metadata_block_number;
break;
}
}
}
/* Check if we have found the metadata block. */
if (nand_flash -> lx_nand_flash_metadata_block_number == LX_NAND_BLOCK_UNMAPPED)
{
/* Not found, return an error. */
return (LX_ERROR);
}
/* Initialize metadata block numbers and lists. */
nand_flash -> lx_nand_flash_metadata_block_number_current = nand_flash -> lx_nand_flash_metadata_block_number;
nand_flash -> lx_nand_flash_backup_metadata_block_number_current = nand_flash -> lx_nand_flash_backup_metadata_block_number;
nand_flash -> lx_nand_flash_metadata_block[0] = (USHORT)nand_flash -> lx_nand_flash_metadata_block_number;
nand_flash -> lx_nand_flash_backup_metadata_block[0] = (USHORT)nand_flash -> lx_nand_flash_backup_metadata_block_number;
/* Found one metadata block. */
nand_flash -> lx_nand_flash_metadata_block_count = 1;
/* Clear searched block count. */
block_count = 0;
do
{
/* Initialize next block to unmapped. */
nand_flash -> lx_nand_flash_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
/* Loop to read pages in the metadata block. */
for (page = 0; page < nand_flash -> lx_nand_flash_pages_per_block ; page++)
{
/* Call driver read function to read page. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, page, page_buffer_ptr, spare_buffer_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, page, page_buffer_ptr, spare_buffer_ptr, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Determine if the error is fatal. */
if (status != LX_NAND_ERROR_CORRECTED)
{
/* Return an error. */
return(LX_ERROR);
}
}
/* Get page type and page index. */
page_type = LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]) & (~LX_NAND_PAGE_TYPE_PAGE_NUMBER_MASK);
page_index = LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]) & LX_NAND_PAGE_TYPE_PAGE_NUMBER_MASK;
/* Process metadata page by type. */
switch (page_type)
{
case LX_NAND_PAGE_TYPE_DEVICE_INFO:
/* This page is for device info. */
nand_device_info_page = (LX_NAND_DEVICE_INFO*)page_buffer_ptr;
/* Get the base erase count. */
nand_flash -> lx_nand_flash_base_erase_count = nand_device_info_page -> lx_nand_device_info_base_erase_count;
break;
case LX_NAND_PAGE_TYPE_ERASE_COUNT_TABLE:
/* Check if page index is valid. */
if (((ULONG)page_index + 1) * nand_flash -> lx_nand_flash_bytes_per_page > nand_flash -> lx_nand_flash_erase_count_table_size)
{
/* Invalid page index. Return an error. */
status = LX_ERROR;
break;
}
/* Copy page data to erase count table. */
LX_MEMCPY(nand_flash -> lx_nand_flash_erase_count_table + page_index * nand_flash -> lx_nand_flash_bytes_per_page, /* Use case of memcpy is verified. */
page_buffer_ptr, nand_flash -> lx_nand_flash_bytes_per_page);
break;
case LX_NAND_PAGE_TYPE_BLOCK_MAPPING_TABLE:
/* Check if page index is valid. */
if (((ULONG)page_index + 1) * nand_flash -> lx_nand_flash_bytes_per_page > nand_flash -> lx_nand_flash_block_mapping_table_size)
{
/* Invalid page index. Return an error. */
status = LX_ERROR;
break;
}
/* Copy page data to block mapping table. */
LX_MEMCPY(nand_flash -> lx_nand_flash_block_mapping_table + page_index * nand_flash -> lx_nand_flash_bytes_per_page / sizeof(*nand_flash -> lx_nand_flash_block_mapping_table), /* Use case of memcpy is verified. */
page_buffer_ptr, nand_flash -> lx_nand_flash_bytes_per_page);
break;
case LX_NAND_PAGE_TYPE_BLOCK_STATUS_TABLE:
/* Check if page index is valid. */
if (((ULONG)page_index + 1) * nand_flash -> lx_nand_flash_bytes_per_page > nand_flash -> lx_nand_flash_block_status_table_size)
{
/* Invalid page index. Return an error. */
status = LX_ERROR;
break;
}
/* Copy page data to block status table. */
LX_MEMCPY(nand_flash -> lx_nand_flash_block_status_table + page_index * nand_flash -> lx_nand_flash_bytes_per_page / sizeof(*nand_flash -> lx_nand_flash_block_status_table), /* Use case of memcpy is verified. */
page_buffer_ptr, nand_flash -> lx_nand_flash_bytes_per_page);
break;
case LX_NAND_PAGE_TYPE_FREE_PAGE:
/* Found a free page. Update current page. */
nand_flash -> lx_nand_flash_metadata_block_current_page = page;
nand_flash -> lx_nand_flash_backup_metadata_block_current_page = page;
/* Skip all the remaining pages. */
page = nand_flash -> lx_nand_flash_pages_per_block;
break;
case LX_NAND_PAGE_TYPE_BLOCK_LINK:
/* Found next blocks. Update next block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number_next = LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_MAIN_METADATA_OFFSET]);
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_BACKUP_METADATA_OFFSET]);
/* Save block numbers in metadata block lists. */
nand_flash -> lx_nand_flash_metadata_block[nand_flash -> lx_nand_flash_metadata_block_count] = (USHORT)LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_MAIN_METADATA_OFFSET]);
nand_flash -> lx_nand_flash_backup_metadata_block[nand_flash -> lx_nand_flash_metadata_block_count] = (USHORT)LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_BACKUP_METADATA_OFFSET]);
/* Increase metadata block count. */
nand_flash -> lx_nand_flash_metadata_block_count++;
break;
default:
/* Unknown type, return error. */
status = LX_ERROR;
}
/* Check status. */
if (status == LX_ERROR)
{
/* Error, break the loop. */
break;
}
}
/* Check if we have reached the last page. */
if (page == nand_flash -> lx_nand_flash_pages_per_block)
{
/* Move to next block. */
nand_flash -> lx_nand_flash_metadata_block_number_current = nand_flash -> lx_nand_flash_metadata_block_number_next;
nand_flash -> lx_nand_flash_backup_metadata_block_number_current = nand_flash -> lx_nand_flash_backup_metadata_block_number_next;
/* Make sure the block is valid. */
if (nand_flash -> lx_nand_flash_metadata_block_number_current == LX_NAND_BLOCK_UNMAPPED)
{
/* Error, break the loop. */
break;
}
/* Get the block to process. */
block = nand_flash -> lx_nand_flash_metadata_block_number_current;
}
/* Increase the processed block number. */
block_count++;
/* If block count is larger than total blocks, there is an error. */
if (block_count >= nand_flash -> lx_nand_flash_total_blocks)
{
/* Break the loop. */
break;
}
} while (nand_flash -> lx_nand_flash_metadata_block_current_page == 0 && status != LX_ERROR);
/* Check if metadata page is processed correctly. */
if (nand_flash -> lx_nand_flash_metadata_block_current_page == 0 || status == LX_ERROR)
{
/* Return an error. */
return(LX_ERROR);
}
/* Loop to build free and mapped block lists. */
for (block = 0; block < nand_flash -> lx_nand_flash_total_blocks; block++)
{
/* Check for free blocks. */
if (nand_flash -> lx_nand_flash_block_status_table[block] == LX_NAND_BLOCK_STATUS_FREE)
{
/* Add the block to free block list. */
_lx_nand_flash_free_block_list_add(nand_flash, block);
}
/* Check for mapped blocks. */
if (nand_flash -> lx_nand_flash_block_mapping_table[block] != LX_NAND_BLOCK_UNMAPPED)
{
/* Add the block to free block list. */
_lx_nand_flash_mapped_block_list_add(nand_flash, block);
}
}
#ifdef LX_THREAD_SAFE_ENABLE
/* If the thread safe option is enabled, create a ThreadX mutex that will be used in all external APIs
in order to provide thread-safe operation. */
status = tx_mutex_create(&nand_flash -> lx_nand_flash_mutex, "NAND Flash Mutex", TX_NO_INHERIT);
/* Determine if the mutex creation encountered an error. */
if (status != LX_SUCCESS)
{
/* Call system error handler, since this should not happen. */
_lx_nand_flash_system_error(nand_flash, LX_SYSTEM_MUTEX_CREATE_FAILED, 0, 0);
/* Return error to caller. */
return(LX_ERROR);
}
#endif
/* Lockout interrupts. */
LX_DISABLE
/* At this point, the NAND flash has been opened successfully. Place the
NAND flash control block on the linked list of currently opened NAND flashes. */
/* Set the NAND flash state to open. */
nand_flash -> lx_nand_flash_state = LX_NAND_FLASH_OPENED;
/* Place the NAND flash control block on the list of opened NAND flashes. First,
check for an empty list. */
if (_lx_nand_flash_opened_count)
{
/* List is not empty - other NAND flashes are open. */
/* Pickup tail pointer. */
tail_ptr = _lx_nand_flash_opened_ptr -> lx_nand_flash_open_previous;
/* Place the new NAND flash control block in the list. */
_lx_nand_flash_opened_ptr -> lx_nand_flash_open_previous = nand_flash;
tail_ptr -> lx_nand_flash_open_next = nand_flash;
/* Setup this NAND flash's opened links. */
nand_flash -> lx_nand_flash_open_previous = tail_ptr;
nand_flash -> lx_nand_flash_open_next = _lx_nand_flash_opened_ptr;
}
else
{
/* The opened NAND flash list is empty. Add the NAND flash to empty list. */
_lx_nand_flash_opened_ptr = nand_flash;
nand_flash -> lx_nand_flash_open_next = nand_flash;
nand_flash -> lx_nand_flash_open_previous = nand_flash;
}
/* Increment the opened NAND flash counter. */
_lx_nand_flash_opened_count++;
/* Restore interrupts. */
LX_RESTORE
/* Return a successful completion. */
return(LX_SUCCESS);
} }
+682
View File
@@ -0,0 +1,682 @@
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/
/**************************************************************************/
/** */
/** LevelX Component */
/** */
/** NAND Flash */
/** */
/**************************************************************************/
/**************************************************************************/
#define LX_SOURCE_CODE
/* Disable ThreadX error checking. */
#ifndef LX_DISABLE_ERROR_CHECKING
#define LX_DISABLE_ERROR_CHECKING
#endif
/* Include necessary system files. */
#include "lx_api.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nand_flash_open PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Xiuwen Cai, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function opens a NAND flash instance and ensures the */
/* NAND flash is in a coherent state. */
/* */
/* INPUT */
/* */
/* nand_flash NAND flash instance */
/* name Name of NAND flash instance */
/* nand_driver_initialize Driver initialize */
/* memory_ptr Pointer to memory used by the */
/* LevelX for this NAND. */
/* memory_size Size of memory - must at least*/
/* 7 * total block count + */
/* 2 * page size */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* */
/* (nand_driver_initialize) Driver initialize */
/* _lx_nand_flash_memory_initialize Initialize buffer */
/* _lx_nand_flash_driver_block_status_get */
/* Get block status */
/* lx_nand_flash_driver_pages_read Read pages */
/* _lx_nand_flash_free_block_list_add Add free block to list */
/* _lx_nand_flash_mapped_block_list_add Add mapped block to list */
/* _lx_nand_flash_system_error System error handler */
/* tx_mutex_create Create thread-safe mutex */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/**************************************************************************/
UINT _lx_nand_flash_open_extended(LX_NAND_FLASH *nand_flash, CHAR *name, UINT (*nand_driver_initialize)(LX_NAND_FLASH *),
VOID *nand_driver_info_ptr, ULONG* memory_ptr, UINT memory_size)
{
ULONG block;
ULONG page;
UCHAR block_status;
ULONG block_count;
UINT status;
LX_NAND_FLASH *tail_ptr;
LX_NAND_DEVICE_INFO *nand_device_info_page;
UCHAR *spare_buffer_ptr;
UCHAR *page_buffer_ptr;
ULONG page_type;
UCHAR page_index;
LX_INTERRUPT_SAVE_AREA
LX_PARAMETER_NOT_USED(name);
/* Clear the NAND flash control block. User extension is not cleared. */
LX_MEMSET(nand_flash, 0, (ULONG)((UCHAR*)&(nand_flash -> lx_nand_flash_open_previous) - (UCHAR*)nand_flash) + sizeof(nand_flash -> lx_nand_flash_open_previous));
/* Pass the driver_info_ptr */
nand_flash -> lx_nand_flash_driver_info_ptr = nand_driver_info_ptr;
/* Call the flash driver's initialization function. */
(nand_driver_initialize)(nand_flash);
/* Determine if we can support this NAND flash size. */
if (nand_flash -> lx_nand_flash_pages_per_block > LX_NAND_MAX_PAGE_PER_BLOCK || nand_flash -> lx_nand_flash_total_blocks > LX_NAND_MAX_BLOCK_COUNT)
{
/* Return an error. */
return(LX_ERROR);
}
/* Check if it is new LevelX NAND driver. */
if (nand_flash -> lx_nand_flash_driver_pages_read == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_write == LX_NULL || nand_flash -> lx_nand_flash_driver_pages_copy == LX_NULL)
{
/* Return an error. */
return(LX_ERROR);
}
/* Check the spare data length. */
if (nand_flash -> lx_nand_flash_spare_data1_length < sizeof(ULONG))
{
/* Return an error. */
return(LX_ERROR);
}
/* Calculate the number of words per block and per page. */
nand_flash -> lx_nand_flash_words_per_page = (nand_flash -> lx_nand_flash_bytes_per_page / sizeof(ULONG));
nand_flash -> lx_nand_flash_words_per_block = (nand_flash -> lx_nand_flash_words_per_page * nand_flash -> lx_nand_flash_pages_per_block);
/* Calculate the total pages. */
nand_flash -> lx_nand_flash_total_pages = nand_flash -> lx_nand_flash_total_blocks * nand_flash -> lx_nand_flash_pages_per_block;
/* Initialize memory buffer. */
status = _lx_nand_flash_memory_initialize(nand_flash, memory_ptr, memory_size);
if (status != LX_SUCCESS)
{
return(status);
}
/* Initialize block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number = LX_NAND_BLOCK_UNMAPPED;
/* Setup page buffer and spare buffer pointers. */
page_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer;
spare_buffer_ptr = page_buffer_ptr + nand_flash -> lx_nand_flash_bytes_per_page;
/* Loop through the blocks to check for bad blocks and determine the minimum and maximum erase count for each good block. */
for (block = 0; block < nand_flash -> lx_nand_flash_total_blocks; block++)
{
/* First, check to make sure this block is good. */
status = _lx_nand_flash_driver_block_status_get(nand_flash, block, &block_status);
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Return an error. */
return(LX_ERROR);
}
/* Is this block bad? */
if (block_status != LX_NAND_GOOD_BLOCK)
{
/* Yes, this block is bad. */
/* Increment the number of bad blocks. */
nand_flash -> lx_nand_flash_bad_blocks++;
/* Save the block status. */
nand_flash -> lx_nand_flash_block_status_table[block] = LX_NAND_BLOCK_STATUS_BAD;
/* Continue to the next block. */
continue;
}
/* Call driver read function to read page 0. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, 0, page_buffer_ptr, spare_buffer_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, 0, page_buffer_ptr, spare_buffer_ptr, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Determine if the error is fatal. */
if (status != LX_NAND_ERROR_CORRECTED)
{
/* Return an error. */
return(LX_ERROR);
}
}
/* Get the page type. */
page_type = LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]);
/* Check if the type is device info. */
if (page_type == LX_NAND_PAGE_TYPE_DEVICE_INFO)
{
/* Get the device info page. */
nand_device_info_page = (LX_NAND_DEVICE_INFO*)page_buffer_ptr;
/* Check signature. */
if (nand_device_info_page -> lx_nand_device_info_signature1 == LX_NAND_DEVICE_INFO_SIGNATURE1 &&
nand_device_info_page -> lx_nand_device_info_signature2 == LX_NAND_DEVICE_INFO_SIGNATURE2)
{
/* Save the block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number = nand_device_info_page -> lx_nand_device_info_metadata_block_number;
nand_flash -> lx_nand_flash_backup_metadata_block_number = nand_device_info_page -> lx_nand_device_info_backup_metadata_block_number;
break;
}
}
}
/* Check if we have found the metadata block. */
if (nand_flash -> lx_nand_flash_metadata_block_number == LX_NAND_BLOCK_UNMAPPED)
{
/* Not found, return an error. */
return (LX_ERROR);
}
/* Initialize metadata block numbers and lists. */
nand_flash -> lx_nand_flash_metadata_block_number_current = nand_flash -> lx_nand_flash_metadata_block_number;
nand_flash -> lx_nand_flash_backup_metadata_block_number_current = nand_flash -> lx_nand_flash_backup_metadata_block_number;
nand_flash -> lx_nand_flash_metadata_block[0] = (USHORT)nand_flash -> lx_nand_flash_metadata_block_number;
nand_flash -> lx_nand_flash_backup_metadata_block[0] = (USHORT)nand_flash -> lx_nand_flash_backup_metadata_block_number;
/* Found one metadata block. */
nand_flash -> lx_nand_flash_metadata_block_count = 1;
/* Clear searched block count. */
block_count = 0;
do
{
/* Initialize next block to unmapped. */
nand_flash -> lx_nand_flash_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = LX_NAND_BLOCK_UNMAPPED;
/* Loop to read pages in the metadata block. */
for (page = 0; page < nand_flash -> lx_nand_flash_pages_per_block ; page++)
{
/* Call driver read function to read page. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, page, page_buffer_ptr, spare_buffer_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, page, page_buffer_ptr, spare_buffer_ptr, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
/* Determine if the error is fatal. */
if (status != LX_NAND_ERROR_CORRECTED)
{
/* Return an error. */
return(LX_ERROR);
}
}
/* Get page type and page index. */
page_type = LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]) & (~LX_NAND_PAGE_TYPE_PAGE_NUMBER_MASK);
page_index = LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]) & LX_NAND_PAGE_TYPE_PAGE_NUMBER_MASK;
/* Process metadata page by type. */
switch (page_type)
{
case LX_NAND_PAGE_TYPE_DEVICE_INFO:
/* This page is for device info. */
nand_device_info_page = (LX_NAND_DEVICE_INFO*)page_buffer_ptr;
/* Get the base erase count. */
nand_flash -> lx_nand_flash_base_erase_count = nand_device_info_page -> lx_nand_device_info_base_erase_count;
break;
case LX_NAND_PAGE_TYPE_ERASE_COUNT_TABLE:
/* Check if page index is valid. */
if (((ULONG)page_index + 1) * nand_flash -> lx_nand_flash_bytes_per_page > nand_flash -> lx_nand_flash_erase_count_table_size)
{
/* Invalid page index. Return an error. */
status = LX_ERROR;
break;
}
/* Copy page data to erase count table. */
LX_MEMCPY(nand_flash -> lx_nand_flash_erase_count_table + page_index * nand_flash -> lx_nand_flash_bytes_per_page, /* Use case of memcpy is verified. */
page_buffer_ptr, nand_flash -> lx_nand_flash_bytes_per_page);
break;
case LX_NAND_PAGE_TYPE_BLOCK_MAPPING_TABLE:
/* Check if page index is valid. */
if (((ULONG)page_index + 1) * nand_flash -> lx_nand_flash_bytes_per_page > nand_flash -> lx_nand_flash_block_mapping_table_size)
{
/* Invalid page index. Return an error. */
status = LX_ERROR;
break;
}
/* Copy page data to block mapping table. */
LX_MEMCPY(nand_flash -> lx_nand_flash_block_mapping_table + page_index * nand_flash -> lx_nand_flash_bytes_per_page / sizeof(*nand_flash -> lx_nand_flash_block_mapping_table), /* Use case of memcpy is verified. */
page_buffer_ptr, nand_flash -> lx_nand_flash_bytes_per_page);
break;
case LX_NAND_PAGE_TYPE_BLOCK_STATUS_TABLE:
/* Check if page index is valid. */
if (((ULONG)page_index + 1) * nand_flash -> lx_nand_flash_bytes_per_page > nand_flash -> lx_nand_flash_block_status_table_size)
{
/* Invalid page index. Return an error. */
status = LX_ERROR;
break;
}
/* Copy page data to block status table. */
LX_MEMCPY(nand_flash -> lx_nand_flash_block_status_table + page_index * nand_flash -> lx_nand_flash_bytes_per_page / sizeof(*nand_flash -> lx_nand_flash_block_status_table), /* Use case of memcpy is verified. */
page_buffer_ptr, nand_flash -> lx_nand_flash_bytes_per_page);
break;
case LX_NAND_PAGE_TYPE_FREE_PAGE:
/* Found a free page. Update current page. */
nand_flash -> lx_nand_flash_metadata_block_current_page = page;
nand_flash -> lx_nand_flash_backup_metadata_block_current_page = page;
/* Skip all the remaining pages. */
page = nand_flash -> lx_nand_flash_pages_per_block;
break;
case LX_NAND_PAGE_TYPE_BLOCK_LINK:
/* Found next blocks. Update next block numbers. */
nand_flash -> lx_nand_flash_metadata_block_number_next = LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_MAIN_METADATA_OFFSET]);
nand_flash -> lx_nand_flash_backup_metadata_block_number_next = LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_BACKUP_METADATA_OFFSET]);
/* Save block numbers in metadata block lists. */
nand_flash -> lx_nand_flash_metadata_block[nand_flash -> lx_nand_flash_metadata_block_count] = (USHORT)LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_MAIN_METADATA_OFFSET]);
nand_flash -> lx_nand_flash_backup_metadata_block[nand_flash -> lx_nand_flash_metadata_block_count] = (USHORT)LX_UTILITY_LONG_GET(&page_buffer_ptr[LX_NAND_BLOCK_LINK_BACKUP_METADATA_OFFSET]);
/* Increase metadata block count. */
nand_flash -> lx_nand_flash_metadata_block_count++;
break;
default:
/* Unknown type, return error. */
status = LX_ERROR;
}
/* Check status. */
if (status == LX_ERROR)
{
/* Error, break the loop. */
break;
}
}
/* Check if we have reached the last page. */
if (page == nand_flash -> lx_nand_flash_pages_per_block)
{
/* Move to next block. */
nand_flash -> lx_nand_flash_metadata_block_number_current = nand_flash -> lx_nand_flash_metadata_block_number_next;
nand_flash -> lx_nand_flash_backup_metadata_block_number_current = nand_flash -> lx_nand_flash_backup_metadata_block_number_next;
/* Make sure the block is valid. */
if (nand_flash -> lx_nand_flash_metadata_block_number_current == LX_NAND_BLOCK_UNMAPPED)
{
/* Error, break the loop. */
break;
}
/* Get the block to process. */
block = nand_flash -> lx_nand_flash_metadata_block_number_current;
}
/* Increase the processed block number. */
block_count++;
/* If block count is larger than total blocks, there is an error. */
if (block_count >= nand_flash -> lx_nand_flash_total_blocks)
{
/* Break the loop. */
break;
}
} while (nand_flash -> lx_nand_flash_metadata_block_current_page == 0 && status != LX_ERROR);
/* Check if metadata page is processed correctly. */
if (nand_flash -> lx_nand_flash_metadata_block_current_page == 0 || status == LX_ERROR)
{
/* Return an error. */
return(LX_ERROR);
}
/* Loop to build free and mapped block lists. */
for (block = 0; block < nand_flash -> lx_nand_flash_total_blocks; block++)
{
/* Check for free blocks. */
if (nand_flash -> lx_nand_flash_block_status_table[block] == LX_NAND_BLOCK_STATUS_FREE)
{
/* Add the block to free block list. */
_lx_nand_flash_free_block_list_add(nand_flash, block);
}
/* Check for mapped blocks. */
if (nand_flash -> lx_nand_flash_block_mapping_table[block] != LX_NAND_BLOCK_UNMAPPED)
{
/* Add the block to free block list. */
_lx_nand_flash_mapped_block_list_add(nand_flash, block);
}
}
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
{
ULONG blk;
ULONG lg;
USHORT blk_status;
/* Phase 1: Rebuild compaction table and recover from mid-release crashes.
Scan all blocks for COMPACTION_PENDING. */
for (blk = 0; blk < nand_flash -> lx_nand_flash_total_blocks; blk++)
{
blk_status = nand_flash -> lx_nand_flash_block_status_table[blk];
/* FREE (0xFFFF) and BAD (0xFF00) both have COMPACTION_PENDING bit set; skip them. */
if ((blk_status == LX_NAND_BLOCK_STATUS_FREE) || (blk_status == LX_NAND_BLOCK_STATUS_BAD))
{
continue;
}
if (blk_status & LX_NAND_BLOCK_STATUS_COMPACTION_PENDING)
{
/* Check if any logical group still maps to this physical block.
If so, the mapping update didn't happen — abort the lazy release. */
lg = nand_flash -> lx_nand_flash_total_blocks;
{
ULONG search_lg;
for (search_lg = 0; search_lg < nand_flash -> lx_nand_flash_total_blocks; search_lg++)
{
if (nand_flash -> lx_nand_flash_block_mapping_table[search_lg] == (USHORT)blk)
{
lg = search_lg;
break;
}
}
}
if (lg != nand_flash -> lx_nand_flash_total_blocks)
{
/* Scenario A: crash after COMPACTION_PENDING set, before mapping updated.
Clear COMPACTION_PENDING to restore the block to its normal state. */
blk_status = (USHORT)(blk_status & (USHORT)(~LX_NAND_BLOCK_STATUS_COMPACTION_PENDING));
(void)_lx_nand_flash_block_status_set(nand_flash, blk, blk_status);
}
else
{
/* Scenario B: deferred compaction — scan block pages to find the LG. */
ULONG page;
ULONG spare_word;
ULONG found_lg;
UCHAR *spare_ptr;
spare_ptr = (UCHAR*)nand_flash -> lx_nand_flash_page_buffer;
found_lg = nand_flash -> lx_nand_flash_total_blocks;
for (page = 0; page < nand_flash -> lx_nand_flash_pages_per_block; page++)
{
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, blk, page, (UCHAR*)NULL, spare_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(blk, page, (UCHAR*)NULL, spare_ptr, 1);
#endif
if (status)
{
break;
}
spare_word = LX_UTILITY_LONG_GET(&spare_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]);
if ((spare_word & (~LX_NAND_PAGE_TYPE_USER_DATA_MASK)) == LX_NAND_PAGE_TYPE_USER_DATA)
{
found_lg = (spare_word & LX_NAND_PAGE_TYPE_USER_DATA_MASK) /
nand_flash -> lx_nand_flash_pages_per_block;
break;
}
}
if ((found_lg != nand_flash -> lx_nand_flash_total_blocks) &&
(found_lg < nand_flash -> lx_nand_flash_total_blocks))
{
nand_flash -> lx_nand_flash_block_compaction_table[found_lg] = (USHORT)blk;
}
}
}
}
/* Phase 2: Orphan block recovery — erase ALLOCATED blocks not referenced
by any mapping entry and not marked COMPACTION_PENDING. */
for (blk = 0; blk < nand_flash -> lx_nand_flash_total_blocks; blk++)
{
ULONG found;
blk_status = nand_flash -> lx_nand_flash_block_status_table[blk];
if ((blk_status == LX_NAND_BLOCK_STATUS_FREE) || (blk_status == LX_NAND_BLOCK_STATUS_BAD))
{
continue;
}
if (blk_status & LX_NAND_BLOCK_STATUS_COMPACTION_PENDING)
{
continue;
}
if (!(blk_status & LX_NAND_BLOCK_STATUS_ALLOCATED))
{
continue;
}
/* Search for this block in the mapping table. */
found = LX_FALSE;
for (lg = 0; lg < nand_flash -> lx_nand_flash_total_blocks; lg++)
{
if (nand_flash -> lx_nand_flash_block_mapping_table[lg] == (USHORT)blk)
{
found = LX_TRUE;
break;
}
}
if (!found)
{
/* Orphan block: erase and reclaim. */
status = _lx_nand_flash_driver_block_erase(nand_flash, blk,
nand_flash -> lx_nand_flash_base_erase_count +
nand_flash -> lx_nand_flash_erase_count_table[blk] + 1);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, blk, 0);
continue;
}
status = _lx_nand_flash_erase_count_set(nand_flash, blk,
(UCHAR)(nand_flash -> lx_nand_flash_erase_count_table[blk] + 1));
if (!status)
{
(void)_lx_nand_flash_block_status_set(nand_flash, blk, LX_NAND_BLOCK_STATUS_FREE);
_lx_nand_flash_free_block_list_add(nand_flash, blk);
}
}
}
}
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
#ifdef LX_THREAD_SAFE_ENABLE
/* If the thread safe option is enabled, create a ThreadX mutex that will be used in all external APIs
in order to provide thread-safe operation. */
status = tx_mutex_create(&nand_flash -> lx_nand_flash_mutex, "NAND Flash Mutex", TX_NO_INHERIT);
/* Determine if the mutex creation encountered an error. */
if (status != LX_SUCCESS)
{
/* Call system error handler, since this should not happen. */
_lx_nand_flash_system_error(nand_flash, LX_SYSTEM_MUTEX_CREATE_FAILED, 0, 0);
/* Return error to caller. */
return(LX_ERROR);
}
#endif
/* Lockout interrupts. */
LX_DISABLE
/* At this point, the NAND flash has been opened successfully. Place the
NAND flash control block on the linked list of currently opened NAND flashes. */
/* Set the NAND flash state to open. */
nand_flash -> lx_nand_flash_state = LX_NAND_FLASH_OPENED;
/* Place the NAND flash control block on the list of opened NAND flashes. First,
check for an empty list. */
if (_lx_nand_flash_opened_count)
{
/* List is not empty - other NAND flashes are open. */
/* Pickup tail pointer. */
tail_ptr = _lx_nand_flash_opened_ptr -> lx_nand_flash_open_previous;
/* Place the new NAND flash control block in the list. */
_lx_nand_flash_opened_ptr -> lx_nand_flash_open_previous = nand_flash;
tail_ptr -> lx_nand_flash_open_next = nand_flash;
/* Setup this NAND flash's opened links. */
nand_flash -> lx_nand_flash_open_previous = tail_ptr;
nand_flash -> lx_nand_flash_open_next = _lx_nand_flash_opened_ptr;
}
else
{
/* The opened NAND flash list is empty. Add the NAND flash to empty list. */
_lx_nand_flash_opened_ptr = nand_flash;
nand_flash -> lx_nand_flash_open_next = nand_flash;
nand_flash -> lx_nand_flash_open_previous = nand_flash;
}
/* Increment the opened NAND flash counter. */
_lx_nand_flash_opened_count++;
/* Restore interrupts. */
LX_RESTORE
/* Return a successful completion. */
return(LX_SUCCESS);
}
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,16 +68,6 @@
/* */ /* */
/* NAND flash driver */ /* NAND flash driver */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_page_ecc_check(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer) UINT _lx_nand_flash_page_ecc_check(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer)
{ {
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,16 +67,6 @@
/* */ /* */
/* NAND flash driver */ /* NAND flash driver */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_page_ecc_compute(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer) UINT _lx_nand_flash_page_ecc_compute(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer)
{ {
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -69,19 +69,6 @@
/* Application Code */ /* Application Code */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* deprecated this API, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_partial_defragment(LX_NAND_FLASH *nand_flash, UINT max_blocks) UINT _lx_nand_flash_partial_defragment(LX_NAND_FLASH *nand_flash, UINT max_blocks)
{ {
+103 -18
View File
@@ -1,14 +1,15 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/ /**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -73,12 +74,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_sector_read(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer) UINT _lx_nand_flash_sector_read(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer)
{ {
@@ -144,9 +139,9 @@ LONG page;
/* Read a page. */ /* Read a page. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE #ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, (ULONG)page, (UCHAR*)buffer, spare_buffer_ptr, 1); status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, (ULONG)page, (UCHAR*)NULL, spare_buffer_ptr, 1);
#else #else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, (ULONG)page, (UCHAR*)buffer, spare_buffer_ptr, 1); status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, (ULONG)page, (UCHAR*)NULL, spare_buffer_ptr, 1);
#endif #endif
/* Check for an error from flash driver. */ /* Check for an error from flash driver. */
@@ -167,6 +162,26 @@ LONG page;
/* Get the logical sector number from spare bytes, and check if it matches the addressed sector number. */ /* Get the logical sector number from spare bytes, and check if it matches the addressed sector number. */
if ((LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]) & LX_NAND_PAGE_TYPE_USER_DATA_MASK) == logical_sector) if ((LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]) & LX_NAND_PAGE_TYPE_USER_DATA_MASK) == logical_sector)
{ {
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, block, (ULONG)page, (UCHAR*)buffer, NULL, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(block, (ULONG)page, (UCHAR*)buffer, NULL, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
/* Release the thread safe mutex. */
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
/* Return an error. */
return(LX_ERROR);
}
#ifdef LX_THREAD_SAFE_ENABLE #ifdef LX_THREAD_SAFE_ENABLE
/* Release the thread safe mutex. */ /* Release the thread safe mutex. */
@@ -217,6 +232,76 @@ LONG page;
} }
} }
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
{
ULONG logical_group;
ULONG old_block;
/* Check the compaction table for a deferred source block that might hold
the requested sector. The primary block (tombstone block) was already
scanned above; fall back to the old full block here. */
logical_group = logical_sector / nand_flash -> lx_nand_flash_pages_per_block;
if (nand_flash -> lx_nand_flash_block_compaction_table[logical_group] != (USHORT)LX_NAND_BLOCK_UNMAPPED)
{
old_block = nand_flash -> lx_nand_flash_block_compaction_table[logical_group];
/* Set spare buffer pointer. */
spare_buffer_ptr = (UCHAR*)nand_flash -> lx_nand_flash_page_buffer;
/* The compaction-pending block is always FULL; scan all pages in reverse. */
for (page = (LONG)nand_flash -> lx_nand_flash_pages_per_block - 1; page >= 0; page--)
{
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, old_block, (ULONG)page, (UCHAR*)NULL, spare_buffer_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(old_block, (ULONG)page, (UCHAR*)NULL, spare_buffer_ptr, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, old_block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_ERROR);
}
/* Check if this page matches the requested sector. */
if ((LX_UTILITY_LONG_GET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset]) & LX_NAND_PAGE_TYPE_USER_DATA_MASK) == logical_sector)
{
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_read)(nand_flash, old_block, (ULONG)page, (UCHAR*)buffer, NULL, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_read)(old_block, (ULONG)page, (UCHAR*)buffer, NULL, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, old_block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_ERROR);
}
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_SUCCESS);
}
}
}
}
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
/* Sector hasn't been written. Simply fill the destination buffer with ones and return success. */ /* Sector hasn't been written. Simply fill the destination buffer with ones and return success. */
/* Setup pointer to users buffer. */ /* Setup pointer to users buffer. */
+125 -16
View File
@@ -1,14 +1,15 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/ /**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -82,12 +83,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_sector_release(LX_NAND_FLASH *nand_flash, ULONG logical_sector) UINT _lx_nand_flash_sector_release(LX_NAND_FLASH *nand_flash, ULONG logical_sector)
{ {
@@ -211,6 +206,119 @@ USHORT new_block_status;
if (block_status & LX_NAND_BLOCK_STATUS_FULL) if (block_status & LX_NAND_BLOCK_STATUS_FULL)
{ {
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
/* Lazy path: defer the copy+erase when enough free blocks are available.
The old block is kept as a compaction source; a new block holds only
the tombstone for the released sector. */
if (nand_flash -> lx_nand_flash_free_block_list_tail >
(ULONG)LX_NAND_FLASH_SECTOR_RELEASE_LAZY_THRESHOLD)
{
/* Allocate a new block for the tombstone. */
status = _lx_nand_flash_block_allocate(nand_flash, &new_block);
/* Check return status. */
if (status != LX_SUCCESS)
{
/* Call system error handler. */
_lx_nand_flash_system_error(nand_flash, status, new_block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
/* Release the thread safe mutex. */
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
/* Return an error. */
return(LX_ERROR);
}
/* Set page buffer to all 0xFF (data = erased, sector is released). */
LX_MEMSET(nand_flash -> lx_nand_flash_page_buffer, 0xFF,
nand_flash -> lx_nand_flash_bytes_per_page +
nand_flash -> lx_nand_flash_spare_total_length);
/* Setup spare buffer pointer. */
spare_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer +
nand_flash -> lx_nand_flash_bytes_per_page;
/* Save metadata block number in spare bytes if space allows. */
if (nand_flash -> lx_nand_flash_spare_data2_length >= sizeof(USHORT))
{
LX_UTILITY_SHORT_SET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data2_offset],
nand_flash -> lx_nand_flash_metadata_block_number);
}
/* Set page type to USER_DATA_RELEASED. */
LX_UTILITY_LONG_SET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset],
LX_NAND_PAGE_TYPE_USER_DATA_RELEASED | logical_sector);
/* Write the tombstone page to page 0 of the new block. */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nand_flash -> lx_nand_flash_driver_pages_write)(nand_flash, new_block, 0,
(UCHAR*)nand_flash -> lx_nand_flash_page_buffer, spare_buffer_ptr, 1);
#else
status = (nand_flash -> lx_nand_flash_driver_pages_write)(new_block, 0,
(UCHAR*)nand_flash -> lx_nand_flash_page_buffer, spare_buffer_ptr, 1);
#endif
/* Check for an error from flash driver. */
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, new_block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_ERROR);
}
/* Set new block status: allocated, non-sequential, 1 page written. */
new_block_status = (USHORT)(LX_NAND_BLOCK_STATUS_ALLOCATED |
LX_NAND_BLOCK_STATUS_NON_SEQUENTIAL | 1u);
status = _lx_nand_flash_block_status_set(nand_flash, new_block, new_block_status);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, new_block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_ERROR);
}
/* Mark old block as compaction-pending (persisted to flash).
Write order: tombstone written → new_block status set →
COMPACTION_PENDING set → mapping updated.
This ordering ensures safe crash recovery at open time. */
status = _lx_nand_flash_block_status_set(nand_flash, block,
(USHORT)(block_status | LX_NAND_BLOCK_STATUS_COMPACTION_PENDING));
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_ERROR);
}
/* Remove old mapping before updating to new block. */
_lx_nand_flash_mapped_block_list_remove(nand_flash,
logical_sector / nand_flash -> lx_nand_flash_pages_per_block);
/* Update logical-to-physical mapping to the new tombstone block. */
_lx_nand_flash_block_mapping_set(nand_flash, logical_sector, new_block);
/* Record the old block as the compaction source (RAM only; rebuilt at open). */
nand_flash -> lx_nand_flash_block_compaction_table[logical_sector / nand_flash -> lx_nand_flash_pages_per_block] = (USHORT)block;
/* Add new tombstone block to the mapped list. */
_lx_nand_flash_mapped_block_list_add(nand_flash,
logical_sector / nand_flash -> lx_nand_flash_pages_per_block);
}
else
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
{
/* Eager path (existing): allocate a new block and copy + erase immediately. */
/* Allocate a new block. */ /* Allocate a new block. */
status = _lx_nand_flash_block_allocate(nand_flash, &new_block); status = _lx_nand_flash_block_allocate(nand_flash, &new_block);
@@ -393,6 +501,7 @@ USHORT new_block_status;
/* Add the new block to mapped block list. */ /* Add the new block to mapped block list. */
_lx_nand_flash_mapped_block_list_add(nand_flash, logical_sector / nand_flash -> lx_nand_flash_pages_per_block); _lx_nand_flash_mapped_block_list_add(nand_flash, logical_sector / nand_flash -> lx_nand_flash_pages_per_block);
} }
} /* end eager path else block */
} }
else else
{ {
+47 -16
View File
@@ -1,14 +1,15 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
// Some portions generated by Copilot (Sonnet 4.6).
/**************************************************************************/ /**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -84,12 +85,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_sector_write(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer) UINT _lx_nand_flash_sector_write(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer)
{ {
@@ -137,6 +132,42 @@ UINT copy_block = LX_FALSE;
} }
} }
#ifdef LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE
/* If the block is full and has a pending compaction source, compact it now
before writing so the new data merges correctly with a single source block. */
if ((block != LX_NAND_BLOCK_UNMAPPED) && (block_status & LX_NAND_BLOCK_STATUS_FULL) &&
(nand_flash -> lx_nand_flash_block_compaction_table[logical_sector / nand_flash -> lx_nand_flash_pages_per_block] != (USHORT)LX_NAND_BLOCK_UNMAPPED))
{
status = _lx_nand_flash_logical_group_compact(nand_flash,
logical_sector / nand_flash -> lx_nand_flash_pages_per_block);
if (status)
{
_lx_nand_flash_system_error(nand_flash, status, block, 0);
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_ERROR);
}
/* Refresh block and block_status after compaction. */
status = _lx_nand_flash_block_find(nand_flash, logical_sector, &block, &block_status);
if (status != LX_SUCCESS)
{
if (status != LX_NAND_ERROR_CORRECTED)
{
#ifdef LX_THREAD_SAFE_ENABLE
tx_mutex_put(&nand_flash -> lx_nand_flash_mutex);
#endif
return(LX_ERROR);
}
}
}
#endif /* LX_NAND_FLASH_ENABLE_LAZY_SECTOR_RELEASE */
/* Check if block is unmapped or block is full. */ /* Check if block is unmapped or block is full. */
if (block == LX_NAND_BLOCK_UNMAPPED || block_status & LX_NAND_BLOCK_STATUS_FULL) if (block == LX_NAND_BLOCK_UNMAPPED || block_status & LX_NAND_BLOCK_STATUS_FULL)
{ {
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -70,12 +70,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_sectors_read(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer, ULONG sector_count) UINT _lx_nand_flash_sectors_read(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer, ULONG sector_count)
{ {
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,12 +68,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_sectors_release(LX_NAND_FLASH *nand_flash, ULONG logical_sector, ULONG sector_count) UINT _lx_nand_flash_sectors_release(LX_NAND_FLASH *nand_flash, ULONG logical_sector, ULONG sector_count)
{ {
+10 -16
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -70,12 +70,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nand_flash_sectors_write(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer, ULONG sector_count) UINT _lx_nand_flash_sectors_write(LX_NAND_FLASH *nand_flash, ULONG logical_sector, VOID *buffer, ULONG sector_count)
{ {
+17 -12
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -279,11 +279,16 @@ UINT ecc_status = LX_SUCCESS;
break; break;
} }
} }
if (spare_buffer)
{
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE #ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = _lx_nand_flash_simulator_extra_bytes_get(nand_flash, block, page + i, spare_buffer + i * SPARE_BYTES_PER_PAGE, SPARE_BYTES_PER_PAGE); status = _lx_nand_flash_simulator_extra_bytes_get(nand_flash, block, page + i, spare_buffer + i * SPARE_BYTES_PER_PAGE, SPARE_BYTES_PER_PAGE);
#else #else
status = _lx_nand_flash_simulator_extra_bytes_get(block, page + i, spare_buffer + i * SPARE_BYTES_PER_PAGE, SPARE_BYTES_PER_PAGE); status = _lx_nand_flash_simulator_extra_bytes_get(block, page + i, spare_buffer + i * SPARE_BYTES_PER_PAGE, SPARE_BYTES_PER_PAGE);
#endif #endif
}
} }
return (ecc_status); return (ecc_status);
} }
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,19 +68,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
VOID _lx_nand_flash_system_error(LX_NAND_FLASH *nand_flash, UINT error_code, ULONG block, ULONG page) VOID _lx_nand_flash_system_error(LX_NAND_FLASH *nand_flash, UINT error_code, ULONG block, ULONG page)
{ {
+10 -25
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -74,21 +74,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added count for minimum */
/* erased blocks, added */
/* obsolete count cache, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_block_reclaim(LX_NOR_FLASH *nor_flash) UINT _lx_nor_flash_block_reclaim(LX_NOR_FLASH *nor_flash)
{ {
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -65,16 +65,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_close(LX_NOR_FLASH *nor_flash) UINT _lx_nor_flash_close(LX_NOR_FLASH *nor_flash)
{ {
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,16 +68,6 @@
/* Application Code */ /* Application Code */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_defragment(LX_NOR_FLASH *nor_flash) UINT _lx_nor_flash_defragment(LX_NOR_FLASH *nor_flash)
{ {
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,19 +67,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_driver_block_erase(LX_NOR_FLASH *nor_flash, ULONG block, ULONG erase_count) UINT _lx_nor_flash_driver_block_erase(LX_NOR_FLASH *nor_flash, ULONG block, ULONG erase_count)
{ {
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,19 +68,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_driver_read(LX_NOR_FLASH *nor_flash, ULONG *flash_address, ULONG *destination, ULONG words) UINT _lx_nor_flash_driver_read(LX_NOR_FLASH *nor_flash, ULONG *flash_address, ULONG *destination, ULONG words)
{ {
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -68,19 +68,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_driver_write(LX_NOR_FLASH *nor_flash, ULONG *flash_address, ULONG *source, ULONG words) UINT _lx_nor_flash_driver_write(LX_NOR_FLASH *nor_flash, ULONG *flash_address, ULONG *source, ULONG words)
{ {
+12 -34
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,28 +67,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 12-31-2020 William E. Lamie Modified comment(s), */
/* fixed compiler warnings, */
/* resulting in version 6.1.3 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), and */
/* updated product constants */
/* resulting in version 6.1.7 */
/* 10-15-2021 Bhupendra Naphade Modified comment(s), and */
/* added check for out of */
/* bound memory access, */
/* resulting in version 6.1.9 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added mapping bitmap cache, */
/* added obsolete count cache, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_extended_cache_enable(LX_NOR_FLASH *nor_flash, VOID *memory, ULONG size) UINT _lx_nor_flash_extended_cache_enable(LX_NOR_FLASH *nor_flash, VOID *memory, ULONG size)
{ {
@@ -291,7 +269,7 @@ ULONG block_word;
/* Loop through the memory supplied and assign to cache entries. */ /* Loop through the memory supplied and assign to cache entries. */
i = 0; i = 0;
while (cache_size >= LX_NOR_SECTOR_SIZE) while ((cache_size >= LX_NOR_SECTOR_SIZE) && (i < LX_NOR_EXTENDED_CACHE_SIZE))
{ {
/* Setup this cache entry. */ /* Setup this cache entry. */
@@ -310,7 +288,7 @@ ULONG block_word;
} }
/* Save the number of cache entries. */ /* Save the number of cache entries. */
if(i > LX_NOR_EXTENDED_CACHE_SIZE) if(i == LX_NOR_EXTENDED_CACHE_SIZE)
{ {
nor_flash -> lx_nor_flash_extended_cache_entries = LX_NOR_EXTENDED_CACHE_SIZE; nor_flash -> lx_nor_flash_extended_cache_entries = LX_NOR_EXTENDED_CACHE_SIZE;
+167
View File
@@ -0,0 +1,167 @@
/***************************************************************************
* Copyright (c) 2025 Microsoft Corporation
* Copyright (c) 2025 STmicroelectronics
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** LevelX Component */
/** */
/** NOR Flash */
/** */
/**************************************************************************/
/**************************************************************************/
#define LX_SOURCE_CODE
/* Disable ThreadX error checking. */
#ifndef LX_DISABLE_ERROR_CHECKING
#define LX_DISABLE_ERROR_CHECKING
#endif
/* Include necessary system files. */
#include "lx_api.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nor_flash_format PORTABLE C */
/* */
/* DESCRIPTION */
/* */
/* This function opens a NOR flash instance then erases all the non */
/* erased blocks, then writes the erase count */
/* */
/* INPUT */
/* */
/* nor_flash NOR flash instance */
/* name Name of NOR flash instance */
/* nor_driver_initialize Driver initialize */
/* nor_driver_info_ptr Drivier user data pointer */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* */
/* (nor_driver_initialize) Driver initialize */
/* _lx_nor_flash_driver_read Driver read */
/* _lx_nor_flash_driver_write Driver write */
/* (lx_nor_flash_driver_block_erased_verify) */
/* NOR flash verify block erased */
/* _lx_nor_flash_driver_block_erase Driver block erase */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/**************************************************************************/
UINT _lx_nor_flash_format(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *), VOID *nor_driver_info_ptr)
{
ULONG l;
UINT status;
ULONG block_word;
ULONG *block_word_ptr;
LX_PARAMETER_NOT_USED(name);
/* Clear the NOR flash control block. User extension is not cleared. */
LX_MEMSET(nor_flash, 0, (ULONG)((UCHAR*)&(nor_flash -> lx_nor_flash_open_previous) - (UCHAR*)nor_flash) + sizeof(nor_flash -> lx_nor_flash_open_previous));
nor_flash -> lx_nor_flash_driver_info_ptr = nor_driver_info_ptr;
/* Call the flash driver's initialization function. */
(nor_driver_initialize)(nor_flash);
#ifndef LX_DIRECT_READ
/* Determine if the driver supplied a RAM buffer for reading the NOR sector if direct read is not
supported. */
if (nor_flash -> lx_nor_flash_sector_buffer == LX_NULL)
{
/* Return an error. */
return(LX_NO_MEMORY);
}
#endif
for (l = 0; l < nor_flash -> lx_nor_flash_total_blocks; l++)
{
#ifdef LX_NOR_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
/* Check that the block is already erased */
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(nor_flash, l);
#else
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(l);
#endif
/* the block is not erased, thus make sure to erase it */
if (status)
{
/* the max erase count is not needed just pass the value 0 */
status = _lx_nor_flash_driver_block_erase(nor_flash, l, 0);
/* Check for an error from flash driver */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* check that the sector was correctly erased */
#ifdef LX_NOR_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(nor_flash, l);
#else
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(l);
#endif
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
/* Setup the block word pointer to the first word of the first block */
block_word_ptr = nor_flash -> lx_nor_flash_base_address + l * nor_flash -> lx_nor_flash_words_per_block;
/* Setup the initial erase_count to 1 and mark the block as erased.
* When the lx_nor_flash_open() gets called only the erase count will be kept.
*/
block_word = ((ULONG)1 | LX_BLOCK_ERASED);
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr, &block_word, 1);
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
return(LX_SUCCESS);
}
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -64,16 +64,6 @@ ULONG _lx_nor_flash_opened_count;
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_initialize(void) UINT _lx_nor_flash_initialize(void)
{ {
+10 -26
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -77,22 +77,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added mapping bitmap cache, */
/* added obsolete count cache, */
/* optimized full obsoleted */
/* block searching logic, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_logical_sector_find(LX_NOR_FLASH *nor_flash, ULONG logical_sector, ULONG superceded_check, ULONG **physical_sector_map_entry, ULONG **physical_sector_address) UINT _lx_nor_flash_logical_sector_find(LX_NOR_FLASH *nor_flash, ULONG logical_sector, ULONG superceded_check, ULONG **physical_sector_map_entry, ULONG **physical_sector_address)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -72,22 +72,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added mapping bitmap cache, */
/* added obsolete count cache, */
/* optimized full obsoleted */
/* block searching logic, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_next_block_to_erase_find(LX_NOR_FLASH *nor_flash, ULONG *return_erase_block, ULONG *return_erase_count, ULONG *return_mapped_sectors, ULONG *return_obsolete_sectors) UINT _lx_nor_flash_next_block_to_erase_find(LX_NOR_FLASH *nor_flash, ULONG *return_erase_block, ULONG *return_erase_count, ULONG *return_mapped_sectors, ULONG *return_obsolete_sectors)
{ {
+76 -880
View File
@@ -1,13 +1,14 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ * Portion Copyright (c) 2025 STMicroelectronics
/* This software is licensed under the Microsoft Software License */ *
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * This program and the accompanying materials are made available under the
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * terms of the MIT License which is available at
/* and in the root directory of this software. */ * https://opensource.org/licenses/MIT.
/* */ *
/**************************************************************************/ * SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -34,879 +35,74 @@
#include "lx_api.h" #include "lx_api.h"
/***************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nor_flash_open PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function opens a NOR flash instance and ensures the NOR flash */
/* is in a coherent state. */
/* */
/* INPUT */
/* */
/* nor_flash NOR flash instance */
/* name Name of NOR flash instance */
/* nor_driver_initialize Driver initialize */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* lx_nor_flash_open_extended() */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 11-09-2020 William E. Lamie Modified comment(s), */
/* fixed compiler warnings, */
/* resulting in version 6.1.2 */
/* 12-30-2020 William E. Lamie Modified comment(s), */
/* fixed compiler warnings, */
/* resulting in version 6.1.3 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), and */
/* updated product constants */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added count for minimum */
/* erased blocks, added */
/* obsolete count cache, */
/* avoided clearing user */
/* extension in flash control */
/* block, */
/* resulting in version 6.3.0 */
/* 10-21-2025 Modified comment(s) */
/* call the extended equivalent */
/* API */
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nor_flash_open PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function opens a NOR flash instance and ensures the NOR flash */
/* is in a coherent state. */
/* */
/* INPUT */
/* */
/* nor_flash NOR flash instance */
/* name Name of NOR flash instance */
/* nor_driver_initialize Driver initialize */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* */
/* (nor_driver_initialize) Driver initialize */
/* _lx_nor_flash_driver_read Driver read */
/* _lx_nor_flash_driver_write Driver write */
/* (lx_nor_flash_driver_block_erased_verify) */
/* NOR flash verify block erased */
/* _lx_nor_flash_driver_block_erase Driver block erase */
/* _lx_nor_flash_logical_sector_find Find logical sector */
/* _lx_nor_flash_system_error System error handler */
/* tx_mutex_create Create thread-safe mutex */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 11-09-2020 William E. Lamie Modified comment(s), */
/* fixed compiler warnings, */
/* resulting in version 6.1.2 */
/* 12-30-2020 William E. Lamie Modified comment(s), */
/* fixed compiler warnings, */
/* resulting in version 6.1.3 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), and */
/* updated product constants */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added count for minimum */
/* erased blocks, added */
/* obsolete count cache, */
/* avoided clearing user */
/* extension in flash control */
/* block, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/
UINT _lx_nor_flash_open(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *)) UINT _lx_nor_flash_open(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *))
{ {
ULONG sectors_per_block; UINT status = LX_ERROR;
ULONG sector_map_words;
ULONG bit_map_words;
ULONG bit_map_mask;
ULONG total_header_words;
ULONG header_sectors;
ULONG *block_word_ptr;
ULONG block_word;
ULONG temp;
ULONG free_sectors;
ULONG used_sectors;
ULONG *new_map_entry;
ULONG *new_sector_address;
ULONG erased_count, min_erased_count, max_erased_count, temp_erased_count, min_erased_blocks;
ULONG j, k, l;
UINT status;
#ifdef LX_FREE_SECTOR_DATA_VERIFY
ULONG *sector_word_ptr;
ULONG sector_word;
#endif
LX_NOR_FLASH *tail_ptr;
LX_INTERRUPT_SAVE_AREA
LX_PARAMETER_NOT_USED(name); status = _lx_nor_flash_open_extended(nor_flash, name, nor_driver_initialize, NULL);
/* Clear the NOR flash control block. User extension is not cleared. */ return status;
LX_MEMSET(nor_flash, 0, (ULONG)((UCHAR*)&(nor_flash -> lx_nor_flash_open_previous) - (UCHAR*)nor_flash) + sizeof(nor_flash -> lx_nor_flash_open_previous));
/* Call the flash driver's initialization function. */
(nor_driver_initialize)(nor_flash);
#ifndef LX_DIRECT_READ
/* Determine if the driver supplied a RAM buffer for reading the NOR sector if direct read is not
supported. */
if (nor_flash -> lx_nor_flash_sector_buffer == LX_NULL)
{
/* Return an error. */
return(LX_NO_MEMORY);
}
#endif
/* Setup the offset to the free bit map. */
nor_flash -> lx_nor_flash_block_free_bit_map_offset = sizeof(LX_NOR_FLASH_BLOCK_HEADER)/sizeof(ULONG);
/* Calculate the number of bits we need in the free physical sector bit map. Subtract 1 to account for the
flash block header itself. The case where multiple physical sectors are needed for certain sized flash
devices is handled below. */
sectors_per_block = (nor_flash -> lx_nor_flash_words_per_block / LX_NOR_SECTOR_SIZE) - 1;
/* Calculate the number of words required for the sector map array. */
sector_map_words = sectors_per_block;
/* Calculate the number of words we need for the free physical sector bit map. */
bit_map_words = (sectors_per_block + 31)/ 32;
/* Save the number of bit map words. */
nor_flash -> lx_nor_flash_block_bit_map_words = bit_map_words;
/* Setup the offset (in words) to the array of physical sector mapping. */
nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset = nor_flash -> lx_nor_flash_block_free_bit_map_offset + bit_map_words;
/* Calculate the total number of words required for the flash block header. */
total_header_words = sizeof(LX_NOR_FLASH_BLOCK_HEADER)/sizeof(ULONG) + bit_map_words + sector_map_words;
/* Determine if more physical sectors are needed, which can happen on large devices. */
if (total_header_words <= LX_NOR_SECTOR_SIZE)
{
/* Round up to the size of 1 physical sector. */
total_header_words = LX_NOR_SECTOR_SIZE;
}
else
{
/* Otherwise calculate how many header sectors are necessary. */
header_sectors = (total_header_words-1)/LX_NOR_SECTOR_SIZE;
/* Round up to the next sector. */
header_sectors++;
/* Compute the total header words, rounding to the next sector. */
total_header_words = header_sectors * LX_NOR_SECTOR_SIZE;
/* Adjust the number of sectors per block. */
sectors_per_block = sectors_per_block - (header_sectors - 1);
}
/* Save the offset to the sector area. */
nor_flash -> lx_nor_flash_block_physical_sector_offset = total_header_words;
/* Save the physical sectors per block and total physical sectors. */
nor_flash -> lx_nor_flash_physical_sectors_per_block = sectors_per_block;
nor_flash -> lx_nor_flash_total_physical_sectors = nor_flash -> lx_nor_flash_total_blocks * sectors_per_block;
/* Build the free bit map mask, for the portion of the bit map that is less than 32 bits. */
if ((sectors_per_block % 32) != 0)
{
bit_map_mask = (ULONG)(1 << (sectors_per_block % 32));
bit_map_mask = bit_map_mask - 1;
}
else
{
/* Exactly 32 sectors for the bit map mask. */
bit_map_mask = LX_ALL_ONES;
}
/* Save the free bit map mask in the control block. */
nor_flash -> lx_nor_flash_block_bit_map_mask = bit_map_mask;
/* Setup default values for the max/min erased counts. */
min_erased_count = LX_ALL_ONES;
min_erased_blocks = 0;
max_erased_count = 0;
/* Setup the block word pointer to the first word of the first block, which is effectively the
flash base address. */
block_word_ptr = nor_flash -> lx_nor_flash_base_address;
/* Loop through the blocks to determine the minimum and maximum erase count. */
for (l = 0; l < nor_flash -> lx_nor_flash_total_blocks; l++)
{
/* Pickup the first word of the block. If the flash manager has executed before, this word contains the
erase count for the block. Otherwise, if the word is 0xFFFFFFFF, this flash block was either erased
or this is the first time it was used. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *block_word_ptr;
#else
status = _lx_nor_flash_driver_read(nor_flash, block_word_ptr, &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Is the block erased? */
if (((block_word & LX_BLOCK_ERASED) != LX_BLOCK_ERASED) && (block_word != LX_BLOCK_ERASE_STARTED))
{
/* No, valid block. Isolate the erased count. */
erased_count = (block_word & LX_BLOCK_ERASE_COUNT_MASK);
/* Is the erased count the minimum? */
if (erased_count == min_erased_count)
{
/* Yes, increment the minimum erased block count. */
min_erased_blocks++;
}
/* Is this the new minimum? */
if (erased_count < min_erased_count)
{
/* Yes, remember the new minimum. */
min_erased_count = erased_count;
/* Reset the minimum erased block count. */
min_erased_blocks = 1;
}
/* Is this the new maximum? */
if (erased_count > max_erased_count)
{
/* Yes, remember the new maximum. */
max_erased_count = erased_count;
}
}
/* Move to the next flash block. */
block_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_words_per_block);
}
/* If we haven't found any erased counts, we can assume the flash is completely erased and needs to
be setup for the first time. */
if (min_erased_count == LX_ALL_ONES)
{
/* Indicate that this is the initial format. */
nor_flash -> lx_nor_flash_diagnostic_initial_format = LX_TRUE;
/* Setup the block word pointer to the first word of the first block, which is effectively the
flash base address. */
block_word_ptr = nor_flash -> lx_nor_flash_base_address;
/* Loop through the blocks to setup the flash the fist time. */
for (l = 0; l < nor_flash -> lx_nor_flash_total_blocks; l++)
{
/* Setup the free bit map that corresponds to the free physical sectors in this
block. Note that we only need to setup the portion of the free bit map that doesn't
have sectors associated with it. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr+(nor_flash -> lx_nor_flash_block_free_bit_map_offset + (bit_map_words-1)) , &bit_map_mask, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Setup the initial erase count to 1. */
block_word = ((ULONG) 1);
/* Write the initial erase count for the block. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr, &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Update the overall minimum and maximum erase count. */
nor_flash -> lx_nor_flash_minimum_erase_count = 1;
nor_flash -> lx_nor_flash_minimum_erased_blocks = nor_flash -> lx_nor_flash_total_blocks;
nor_flash -> lx_nor_flash_maximum_erase_count = 1;
/* Update the number of free physical sectors. */
nor_flash -> lx_nor_flash_free_physical_sectors = nor_flash -> lx_nor_flash_free_physical_sectors + sectors_per_block;
/* Move to the next flash block. */
block_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_words_per_block);
}
}
else
{
/* At this point, we have a previously managed flash structure. This needs to be traversed to prepare for the
current flash operation. */
/* Default the flash free sector search to an invalid value. */
nor_flash -> lx_nor_flash_free_block_search = nor_flash -> lx_nor_flash_total_blocks;
/* Setup the block word pointer to the first word of the first block, which is effectively the
flash base address. */
block_word_ptr = nor_flash -> lx_nor_flash_base_address;
/* Loop through the blocks. */
for (l = 0; l < nor_flash -> lx_nor_flash_total_blocks; l++)
{
/* First, determine if this block has a valid erase count. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *block_word_ptr;
#else
status = _lx_nor_flash_driver_read(nor_flash, block_word_ptr, &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Is the block erased? */
if (((block_word & LX_BLOCK_ERASED) == LX_BLOCK_ERASED) || (block_word == LX_BLOCK_ERASE_STARTED))
{
/* This can happen if we were previously in the process of erasing the flash block and a
power interruption occurs. It should only occur once though. */
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_erased_block)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_BLOCK);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the erased block diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_erased_block++;
/* Check to see if the block is erased. */
#ifdef LX_NOR_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(nor_flash, l);
#else
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(l);
#endif
/* Is the block completely erased? */
if (status != LX_SUCCESS)
{
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_re_erase_block)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_BLOCK);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the erased block diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_re_erase_block++;
/* No, the block is not fully erased, erase it again. */
status = _lx_nor_flash_driver_block_erase(nor_flash, l, max_erased_count);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
/* Setup the free bit map that corresponds to the free physical sectors in this
block. Note that we only need to setup the portion of the free bit map that doesn't
have sectors associated with it. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr+(nor_flash -> lx_nor_flash_block_free_bit_map_offset + (bit_map_words-1)) , &bit_map_mask, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Write the initial erase count for the block with upper bit set. */
temp_erased_count = (max_erased_count | LX_BLOCK_ERASED);
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr, &temp_erased_count, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Write the final initial erase count for the block. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr, &max_erased_count, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Update the number of free physical sectors. */
nor_flash -> lx_nor_flash_free_physical_sectors = nor_flash -> lx_nor_flash_free_physical_sectors + sectors_per_block;
}
else
{
/* Calculate the number of free sectors from the free sector bit map. */
free_sectors = 0;
for (j = 0; j < bit_map_words; j++)
{
/* Read this word of the free sector bit map. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *(block_word_ptr + nor_flash -> lx_nor_flash_block_free_bit_map_offset + j);
#else
status = _lx_nor_flash_driver_read(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_free_bit_map_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Count the number of set bits (free sectors). */
for (k = 0; k < 32; k++)
{
/* Is this sector free? */
if (block_word & 1)
{
/* Yes, this sector is free, increment the free sectors count. */
free_sectors++;
/* Determine if we need to update the search pointer. */
if (nor_flash -> lx_nor_flash_free_block_search == nor_flash -> lx_nor_flash_total_blocks)
{
/* Remember the block with free sectors. */
nor_flash -> lx_nor_flash_free_block_search = l;
}
}
/* Shift down the free sector. */
block_word = block_word >> 1;
}
}
/* Update the number of free physical sectors. */
nor_flash -> lx_nor_flash_free_physical_sectors = nor_flash -> lx_nor_flash_free_physical_sectors + free_sectors;
/* We need to now examine the mapping list. */
/* Calculate how many non-free sectors there are - this includes valid and obsolete sectors. */
used_sectors = sectors_per_block - free_sectors;
/* Now walk the list of logical-physical sector mapping. */
for (j = 0; j < sectors_per_block; j++)
{
/* Read this word of the sector mapping list. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *(block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j);
#else
status = _lx_nor_flash_driver_read(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Determine if we are expecting to find a used sector. */
if (used_sectors)
{
/* Yes, we expect this entry to be used. */
/* Is this sector in-use? */
if ((block_word & LX_NOR_LOGICAL_SECTOR_MASK) != LX_NOR_LOGICAL_SECTOR_MASK)
{
/* Determine if the valid bit is set and the superceded bit is clear. This indicates the block was
about to become obsolete. */
if ((block_word & LX_NOR_PHYSICAL_SECTOR_VALID) && ((block_word & LX_NOR_PHYSICAL_SECTOR_SUPERCEDED) == 0))
{
/* Increment the being obsoleted count. */
nor_flash -> lx_nor_flash_diagnostic_sector_being_obsoleted++;
/* Save the currently mapped physical sectors. */
temp = nor_flash -> lx_nor_flash_mapped_physical_sectors;
/* Indicate all the physical sectors are mapped for the purpose of this search. */
nor_flash -> lx_nor_flash_mapped_physical_sectors = nor_flash -> lx_nor_flash_total_physical_sectors;
/* Yes, this block was about to become obsolete. Perform a search for a logical sector entry that
has both of these bits set. */
_lx_nor_flash_logical_sector_find(nor_flash, (block_word & LX_NOR_LOGICAL_SECTOR_MASK), LX_TRUE, &new_map_entry, &new_sector_address);
/* Restore the number of mapped physical sectors. */
nor_flash -> lx_nor_flash_mapped_physical_sectors = temp;
/* Determine if the new logical sector entry is present. */
if (new_map_entry)
{
/* Yes, make the current entry obsolete in favor of the new entry. */
block_word = block_word & ~((ULONG) LX_NOR_PHYSICAL_SECTOR_VALID);
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_sector_obsoleted)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_FORMAT);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the obsoleted count. */
nor_flash -> lx_nor_flash_diagnostic_sector_obsoleted++;
}
}
}
/* Determine if the sector is free. */
else if (block_word == LX_NOR_PHYSICAL_SECTOR_FREE)
{
/* A free entry when there are still used sectors implies that the sector was allocated and a power interruption
took place prior to writing the new logical sector number into the list. */
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_mapping_invalidated)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_FORMAT);
/* Return an error. */
return(LX_ERROR);
}
/* Write 0s out to this entry to invalidate the sector entry. */
block_word = 0;
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the number of mapping invalidates. */
nor_flash -> lx_nor_flash_diagnostic_mapping_invalidated++;
}
/* Yes, now determine if the sector is obsolete. */
if ((block_word & LX_NOR_PHYSICAL_SECTOR_VALID) == 0)
{
/* Increment the number of obsolete sectors. */
nor_flash -> lx_nor_flash_obsolete_physical_sectors++;
}
/* Determine if the mapping for this sector isn't yet valid. */
else if (block_word & LX_NOR_PHYSICAL_SECTOR_MAPPING_NOT_VALID)
{
/* Yes, a power interruption or reset occurred while the sector mapping entry was being written. */
/* Increment the number of obsolete sectors. */
nor_flash -> lx_nor_flash_obsolete_physical_sectors++;
/* Increment the interrupted mapping counter. */
nor_flash -> lx_nor_flash_diagnostic_mapping_write_interrupted++;
/* Invalidate this entry - clearing valid bit, superceded bit and logical sector. */
block_word = 0;
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
else
{
/* Increment the number of mapped physical sectors. */
nor_flash -> lx_nor_flash_mapped_physical_sectors++;
}
/* Decrease the number of used sectors. */
used_sectors--;
}
else
{
/* No more used sectors in this flash block. */
/* In this case the entry must be free or there is a serious NOR flash format error present. */
if (block_word != LX_NOR_PHYSICAL_SECTOR_FREE)
{
/* Increment the sector not free diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_sector_not_free++;
/* NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_FORMAT);
/* Write 0s out to this entry to invalidate the sector entry. */
block_word = 0;
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
#ifdef LX_FREE_SECTOR_DATA_VERIFY
/* Pickup address of the free sector data area. */
sector_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_block_physical_sector_offset) + (j * LX_NOR_SECTOR_SIZE);
/* Determine if the data for this sector is free. */
for (k = 0; k < LX_NOR_SECTOR_SIZE; k++)
{
#ifdef LX_DIRECT_READ
/* Read the word directly. */
sector_word = *(sector_word_ptr);
#else
status = _lx_nor_flash_driver_read(nor_flash, (sector_word_ptr), &sector_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Determine if this word is not available. */
if (sector_word != LX_NOR_PHYSICAL_SECTOR_FREE)
{
/* Increment the sector data not free diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_sector_data_not_free++;
/* This is a format error. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_BLOCK);
/* Return an error. */
return(LX_ERROR);
}
/* Move to the next word in the sector. */
sector_word_ptr++;
}
#endif
}
}
}
/* Move to the next flash block. */
block_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_words_per_block);
}
/* Update the overall minimum and maximum erase count. */
nor_flash -> lx_nor_flash_minimum_erase_count = min_erased_count;
nor_flash -> lx_nor_flash_minimum_erased_blocks = min_erased_blocks;
nor_flash -> lx_nor_flash_maximum_erase_count = max_erased_count;
/* Determine if we need to update the free sector search pointer. */
if (nor_flash -> lx_nor_flash_free_block_search == nor_flash -> lx_nor_flash_total_blocks)
{
/* Just start at the beginning. */
nor_flash -> lx_nor_flash_free_block_search = 0;
}
}
#ifdef LX_THREAD_SAFE_ENABLE
/* If the thread safe option is enabled, create a ThreadX mutex that will be used in all external APIs
in order to provide thread-safe operation. */
status = tx_mutex_create(&nor_flash -> lx_nor_flash_mutex, "NOR Flash Mutex", TX_NO_INHERIT);
/* Determine if the mutex creation encountered an error. */
if (status != LX_SUCCESS)
{
/* Call system error handler, since this should not happen. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_MUTEX_CREATE_FAILED);
/* Return error to caller. */
return(LX_ERROR);
}
#endif
/* Enable the sector mapping cache. */
nor_flash -> lx_nor_flash_sector_mapping_cache_enabled = LX_TRUE;
/* Initialize the last found block and sector markers. */
nor_flash -> lx_nor_flash_found_block_search = 0;
nor_flash -> lx_nor_flash_found_sector_search = 0;
/* Lockout interrupts. */
LX_DISABLE
/* At this point, the NOR flash has been opened successfully. Place the
NOR flash control block on the linked list of currently opened NOR flashes. */
/* Set the NOR flash state to open. */
nor_flash -> lx_nor_flash_state = LX_NOR_FLASH_OPENED;
/* Place the NOR flash control block on the list of opened NOR flashes. First,
check for an empty list. */
if (_lx_nor_flash_opened_count)
{
/* List is not empty - other NOR flashes are open. */
/* Pickup tail pointer. */
tail_ptr = _lx_nor_flash_opened_ptr -> lx_nor_flash_open_previous;
/* Place the new NOR flash control block in the list. */
_lx_nor_flash_opened_ptr -> lx_nor_flash_open_previous = nor_flash;
tail_ptr -> lx_nor_flash_open_next = nor_flash;
/* Setup this NOR flash's opened links. */
nor_flash -> lx_nor_flash_open_previous = tail_ptr;
nor_flash -> lx_nor_flash_open_next = _lx_nor_flash_opened_ptr;
}
else
{
/* The opened NOR flash list is empty. Add the NOR flash to empty list. */
_lx_nor_flash_opened_ptr = nor_flash;
nor_flash -> lx_nor_flash_open_next = nor_flash;
nor_flash -> lx_nor_flash_open_previous = nor_flash;
}
/* Increment the opened NOR flash counter. */
_lx_nor_flash_opened_count++;
/* Restore interrupts. */
LX_RESTORE
/* Return a successful completion. */
return(LX_SUCCESS);
} }
+886
View File
@@ -0,0 +1,886 @@
/***************************************************************************
* Copyright (c) 2025 Microsoft Corporation
* Portion Copyright (c) 2025 STMicroelectronics
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** LevelX Component */
/** */
/** NOR Flash */
/** */
/**************************************************************************/
/**************************************************************************/
#define LX_SOURCE_CODE
/* Disable ThreadX error checking. */
#ifndef LX_DISABLE_ERROR_CHECKING
#define LX_DISABLE_ERROR_CHECKING
#endif
/* Include necessary system files. */
#include "lx_api.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _lx_nor_flash_open_extended PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function opens a NOR flash instance and ensures the NOR flash */
/* is in a coherent state. */
/* */
/* INPUT */
/* */
/* nor_flash NOR flash instance */
/* name Name of NOR flash instance */
/* nor_driver_initialize Driver initialize */
/* nor_driver_info_ptr Driver user data pointer */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* */
/* (nor_driver_initialize) Driver initialize */
/* _lx_nor_flash_driver_read Driver read */
/* _lx_nor_flash_driver_write Driver write */
/* (lx_nor_flash_driver_block_erased_verify) */
/* NOR flash verify block erased */
/* _lx_nor_flash_driver_block_erase Driver block erase */
/* _lx_nor_flash_logical_sector_find Find logical sector */
/* _lx_nor_flash_system_error System error handler */
/* tx_mutex_create Create thread-safe mutex */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/**************************************************************************/
UINT _lx_nor_flash_open_extended(LX_NOR_FLASH *nor_flash, CHAR *name, UINT (*nor_driver_initialize)(LX_NOR_FLASH *), VOID *nor_driver_info_ptr)
{
ULONG sectors_per_block;
ULONG sector_map_words;
ULONG bit_map_words;
ULONG bit_map_mask;
ULONG total_header_words;
ULONG header_sectors;
ULONG *block_word_ptr;
ULONG block_word;
ULONG temp;
ULONG free_sectors;
ULONG used_sectors;
ULONG *new_map_entry;
ULONG *new_sector_address;
ULONG erased_count, min_erased_count, max_erased_count, temp_erased_count, min_erased_blocks;
ULONG j, k, l;
UINT status;
#ifdef LX_FREE_SECTOR_DATA_VERIFY
ULONG *sector_word_ptr;
ULONG sector_word;
#endif
LX_NOR_FLASH *tail_ptr;
LX_INTERRUPT_SAVE_AREA
LX_PARAMETER_NOT_USED(name);
/* Clear the NOR flash control block. User extension is not cleared. */
LX_MEMSET(nor_flash, 0, (ULONG)((UCHAR*)&(nor_flash -> lx_nor_flash_open_previous) - (UCHAR*)nor_flash) + sizeof(nor_flash -> lx_nor_flash_open_previous));
/* Pass the driver info ptr */
nor_flash -> lx_nor_flash_driver_info_ptr = nor_driver_info_ptr;
/* Call the flash driver's initialization function. */
(nor_driver_initialize)(nor_flash);
#ifndef LX_DIRECT_READ
/* Determine if the driver supplied a RAM buffer for reading the NOR sector if direct read is not
supported. */
if (nor_flash -> lx_nor_flash_sector_buffer == LX_NULL)
{
/* Return an error. */
return(LX_NO_MEMORY);
}
#endif
/* Setup the offset to the free bit map. */
nor_flash -> lx_nor_flash_block_free_bit_map_offset = sizeof(LX_NOR_FLASH_BLOCK_HEADER)/sizeof(ULONG);
/* Calculate the number of bits we need in the free physical sector bit map. Subtract 1 to account for the
flash block header itself. The case where multiple physical sectors are needed for certain sized flash
devices is handled below. */
sectors_per_block = (nor_flash -> lx_nor_flash_words_per_block / LX_NOR_SECTOR_SIZE) - 1;
/* Calculate the number of words required for the sector map array. */
sector_map_words = sectors_per_block;
/* Calculate the number of words we need for the free physical sector bit map. */
bit_map_words = (sectors_per_block + 31)/ 32;
/* Save the number of bit map words. */
nor_flash -> lx_nor_flash_block_bit_map_words = bit_map_words;
/* Setup the offset (in words) to the array of physical sector mapping. */
nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset = nor_flash -> lx_nor_flash_block_free_bit_map_offset + bit_map_words;
/* Calculate the total number of words required for the flash block header. */
total_header_words = sizeof(LX_NOR_FLASH_BLOCK_HEADER)/sizeof(ULONG) + bit_map_words + sector_map_words;
/* Determine if more physical sectors are needed, which can happen on large devices. */
if (total_header_words <= LX_NOR_SECTOR_SIZE)
{
/* Round up to the size of 1 physical sector. */
total_header_words = LX_NOR_SECTOR_SIZE;
}
else
{
/* Otherwise calculate how many header sectors are necessary. */
header_sectors = (total_header_words-1)/LX_NOR_SECTOR_SIZE;
/* Round up to the next sector. */
header_sectors++;
/* Compute the total header words, rounding to the next sector. */
total_header_words = header_sectors * LX_NOR_SECTOR_SIZE;
/* Adjust the number of sectors per block. */
sectors_per_block = sectors_per_block - (header_sectors - 1);
}
/* Save the offset to the sector area. */
nor_flash -> lx_nor_flash_block_physical_sector_offset = total_header_words;
/* Save the physical sectors per block and total physical sectors. */
nor_flash -> lx_nor_flash_physical_sectors_per_block = sectors_per_block;
nor_flash -> lx_nor_flash_total_physical_sectors = nor_flash -> lx_nor_flash_total_blocks * sectors_per_block;
/* Build the free bit map mask, for the portion of the bit map that is less than 32 bits. */
if ((sectors_per_block % 32) != 0)
{
bit_map_mask = (ULONG)(1 << (sectors_per_block % 32));
bit_map_mask = bit_map_mask - 1;
}
else
{
/* Exactly 32 sectors for the bit map mask. */
bit_map_mask = LX_ALL_ONES;
}
/* Save the free bit map mask in the control block. */
nor_flash -> lx_nor_flash_block_bit_map_mask = bit_map_mask;
/* Setup default values for the max/min erased counts. */
min_erased_count = LX_ALL_ONES;
min_erased_blocks = 0;
max_erased_count = 0;
/* Setup the block word pointer to the first word of the first block, which is effectively the
flash base address. */
block_word_ptr = nor_flash -> lx_nor_flash_base_address;
/* Loop through the blocks to determine the minimum and maximum erase count. */
for (l = 0; l < nor_flash -> lx_nor_flash_total_blocks; l++)
{
/* Pickup the first word of the block. If the flash manager has executed before, this word contains the
erase count for the block. Otherwise, if the word is 0xFFFFFFFF, this flash block was either erased
or this is the first time it was used. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *block_word_ptr;
#else
status = _lx_nor_flash_driver_read(nor_flash, block_word_ptr, &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Is the block erased? */
if (((block_word & LX_BLOCK_ERASED) != LX_BLOCK_ERASED) && (block_word != LX_BLOCK_ERASE_STARTED))
{
/* No, valid block. Isolate the erased count. */
erased_count = (block_word & LX_BLOCK_ERASE_COUNT_MASK);
/* Is the erased count the minimum? */
if (erased_count == min_erased_count)
{
/* Yes, increment the minimum erased block count. */
min_erased_blocks++;
}
/* Is this the new minimum? */
if (erased_count < min_erased_count)
{
/* Yes, remember the new minimum. */
min_erased_count = erased_count;
/* Reset the minimum erased block count. */
min_erased_blocks = 1;
}
/* Is this the new maximum? */
if (erased_count > max_erased_count)
{
/* Yes, remember the new maximum. */
max_erased_count = erased_count;
}
}
/* Move to the next flash block. */
block_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_words_per_block);
}
/* If we haven't found any erased counts, we can assume the flash is completely erased and needs to
be setup for the first time. */
if (min_erased_count == LX_ALL_ONES)
{
/* Indicate that this is the initial format. */
nor_flash -> lx_nor_flash_diagnostic_initial_format = LX_TRUE;
/* Setup the block word pointer to the first word of the first block, which is effectively the
flash base address. */
block_word_ptr = nor_flash -> lx_nor_flash_base_address;
/* Loop through the blocks to setup the flash the fist time. */
for (l = 0; l < nor_flash -> lx_nor_flash_total_blocks; l++)
{
/* Setup the free bit map that corresponds to the free physical sectors in this
block. Note that we only need to setup the portion of the free bit map that doesn't
have sectors associated with it. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr+(nor_flash -> lx_nor_flash_block_free_bit_map_offset + (bit_map_words-1)) , &bit_map_mask, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Setup the initial erase count to 1. */
block_word = ((ULONG) 1);
/* Write the initial erase count for the block. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr, &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Update the overall minimum and maximum erase count. */
nor_flash -> lx_nor_flash_minimum_erase_count = 1;
nor_flash -> lx_nor_flash_minimum_erased_blocks = nor_flash -> lx_nor_flash_total_blocks;
nor_flash -> lx_nor_flash_maximum_erase_count = 1;
/* Update the number of free physical sectors. */
nor_flash -> lx_nor_flash_free_physical_sectors = nor_flash -> lx_nor_flash_free_physical_sectors + sectors_per_block;
/* Move to the next flash block. */
block_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_words_per_block);
}
}
else
{
/* At this point, we have a previously managed flash structure. This needs to be traversed to prepare for the
current flash operation. */
/* Default the flash free sector search to an invalid value. */
nor_flash -> lx_nor_flash_free_block_search = nor_flash -> lx_nor_flash_total_blocks;
/* Setup the block word pointer to the first word of the first block, which is effectively the
flash base address. */
block_word_ptr = nor_flash -> lx_nor_flash_base_address;
/* Loop through the blocks. */
for (l = 0; l < nor_flash -> lx_nor_flash_total_blocks; l++)
{
/* First, determine if this block has a valid erase count. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *block_word_ptr;
#else
status = _lx_nor_flash_driver_read(nor_flash, block_word_ptr, &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Is the block erased? */
if (((block_word & LX_BLOCK_ERASED) == LX_BLOCK_ERASED) || (block_word == LX_BLOCK_ERASE_STARTED))
{
/* This can happen if we were previously in the process of erasing the flash block and a
power interruption occurs. It should only occur once though. */
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_erased_block)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_BLOCK);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the erased block diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_erased_block++;
/* Check to see if the block is erased. */
#ifdef LX_NOR_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(nor_flash, l);
#else
status = (nor_flash -> lx_nor_flash_driver_block_erased_verify)(l);
#endif
/* Is the block completely erased? */
if (status != LX_SUCCESS)
{
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_re_erase_block)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_BLOCK);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the erased block diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_re_erase_block++;
/* No, the block is not fully erased, erase it again. */
status = _lx_nor_flash_driver_block_erase(nor_flash, l, max_erased_count);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
/* Setup the free bit map that corresponds to the free physical sectors in this
block. Note that we only need to setup the portion of the free bit map that doesn't
have sectors associated with it. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr+(nor_flash -> lx_nor_flash_block_free_bit_map_offset + (bit_map_words-1)) , &bit_map_mask, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Write the initial erase count for the block with upper bit set. */
temp_erased_count = (max_erased_count | LX_BLOCK_ERASED);
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr, &temp_erased_count, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Write the final initial erase count for the block. */
status = _lx_nor_flash_driver_write(nor_flash, block_word_ptr, &max_erased_count, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Update the number of free physical sectors. */
nor_flash -> lx_nor_flash_free_physical_sectors = nor_flash -> lx_nor_flash_free_physical_sectors + sectors_per_block;
}
else
{
/* Calculate the number of free sectors from the free sector bit map. */
free_sectors = 0;
for (j = 0; j < bit_map_words; j++)
{
/* Read this word of the free sector bit map. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *(block_word_ptr + nor_flash -> lx_nor_flash_block_free_bit_map_offset + j);
#else
status = _lx_nor_flash_driver_read(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_free_bit_map_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Count the number of set bits (free sectors). */
for (k = 0; k < 32; k++)
{
/* Is this sector free? */
if (block_word & 1)
{
/* Yes, this sector is free, increment the free sectors count. */
free_sectors++;
/* Determine if we need to update the search pointer. */
if (nor_flash -> lx_nor_flash_free_block_search == nor_flash -> lx_nor_flash_total_blocks)
{
/* Remember the block with free sectors. */
nor_flash -> lx_nor_flash_free_block_search = l;
}
}
/* Shift down the free sector. */
block_word = block_word >> 1;
}
}
/* Update the number of free physical sectors. */
nor_flash -> lx_nor_flash_free_physical_sectors = nor_flash -> lx_nor_flash_free_physical_sectors + free_sectors;
/* We need to now examine the mapping list. */
/* Calculate how many non-free sectors there are - this includes valid and obsolete sectors. */
used_sectors = sectors_per_block - free_sectors;
/* Now walk the list of logical-physical sector mapping. */
for (j = 0; j < sectors_per_block; j++)
{
/* Read this word of the sector mapping list. */
#ifdef LX_DIRECT_READ
/* Read the word directly. */
block_word = *(block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j);
#else
status = _lx_nor_flash_driver_read(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Determine if we are expecting to find a used sector. */
if (used_sectors)
{
/* Yes, we expect this entry to be used. */
/* Is this sector in-use? */
if ((block_word & LX_NOR_LOGICAL_SECTOR_MASK) != LX_NOR_LOGICAL_SECTOR_MASK)
{
/* Determine if the valid bit is set and the superceded bit is clear. This indicates the block was
about to become obsolete. */
if ((block_word & LX_NOR_PHYSICAL_SECTOR_VALID) && ((block_word & LX_NOR_PHYSICAL_SECTOR_SUPERCEDED) == 0))
{
/* Increment the being obsoleted count. */
nor_flash -> lx_nor_flash_diagnostic_sector_being_obsoleted++;
/* Save the currently mapped physical sectors. */
temp = nor_flash -> lx_nor_flash_mapped_physical_sectors;
/* Indicate all the physical sectors are mapped for the purpose of this search. */
nor_flash -> lx_nor_flash_mapped_physical_sectors = nor_flash -> lx_nor_flash_total_physical_sectors;
/* Yes, this block was about to become obsolete. Perform a search for a logical sector entry that
has both of these bits set. */
_lx_nor_flash_logical_sector_find(nor_flash, (block_word & LX_NOR_LOGICAL_SECTOR_MASK), LX_TRUE, &new_map_entry, &new_sector_address);
/* Restore the number of mapped physical sectors. */
nor_flash -> lx_nor_flash_mapped_physical_sectors = temp;
/* Determine if the new logical sector entry is present. */
if (new_map_entry)
{
/* Yes, make the current entry obsolete in favor of the new entry. */
block_word = block_word & ~((ULONG) LX_NOR_PHYSICAL_SECTOR_VALID);
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_sector_obsoleted)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_FORMAT);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the obsoleted count. */
nor_flash -> lx_nor_flash_diagnostic_sector_obsoleted++;
}
}
}
/* Determine if the sector is free. */
else if (block_word == LX_NOR_PHYSICAL_SECTOR_FREE)
{
/* A free entry when there are still used sectors implies that the sector was allocated and a power interruption
took place prior to writing the new logical sector number into the list. */
/* Is this the first time? */
if (nor_flash -> lx_nor_flash_diagnostic_mapping_invalidated)
{
/* No, this is a potential format error, since this should only happen once in a given
NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_FORMAT);
/* Return an error. */
return(LX_ERROR);
}
/* Write 0s out to this entry to invalidate the sector entry. */
block_word = 0;
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
/* Increment the number of mapping invalidates. */
nor_flash -> lx_nor_flash_diagnostic_mapping_invalidated++;
}
/* Yes, now determine if the sector is obsolete. */
if ((block_word & LX_NOR_PHYSICAL_SECTOR_VALID) == 0)
{
/* Increment the number of obsolete sectors. */
nor_flash -> lx_nor_flash_obsolete_physical_sectors++;
}
/* Determine if the mapping for this sector isn't yet valid. */
else if (block_word & LX_NOR_PHYSICAL_SECTOR_MAPPING_NOT_VALID)
{
/* Yes, a power interruption or reset occurred while the sector mapping entry was being written. */
/* Increment the number of obsolete sectors. */
nor_flash -> lx_nor_flash_obsolete_physical_sectors++;
/* Increment the interrupted mapping counter. */
nor_flash -> lx_nor_flash_diagnostic_mapping_write_interrupted++;
/* Invalidate this entry - clearing valid bit, superceded bit and logical sector. */
block_word = 0;
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
else
{
/* Increment the number of mapped physical sectors. */
nor_flash -> lx_nor_flash_mapped_physical_sectors++;
}
/* Decrease the number of used sectors. */
used_sectors--;
}
else
{
/* No more used sectors in this flash block. */
/* In this case the entry must be free or there is a serious NOR flash format error present. */
if (block_word != LX_NOR_PHYSICAL_SECTOR_FREE)
{
/* Increment the sector not free diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_sector_not_free++;
/* NOR flash format. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_FORMAT);
/* Write 0s out to this entry to invalidate the sector entry. */
block_word = 0;
status = _lx_nor_flash_driver_write(nor_flash, (block_word_ptr + nor_flash -> lx_nor_flash_block_physical_sector_mapping_offset + j), &block_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
}
#ifdef LX_FREE_SECTOR_DATA_VERIFY
/* Pickup address of the free sector data area. */
sector_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_block_physical_sector_offset) + (j * LX_NOR_SECTOR_SIZE);
/* Determine if the data for this sector is free. */
for (k = 0; k < LX_NOR_SECTOR_SIZE; k++)
{
#ifdef LX_DIRECT_READ
/* Read the word directly. */
sector_word = *(sector_word_ptr);
#else
status = _lx_nor_flash_driver_read(nor_flash, (sector_word_ptr), &sector_word, 1);
/* Check for an error from flash driver. Drivers should never return an error.. */
if (status)
{
/* Call system error handler. */
_lx_nor_flash_system_error(nor_flash, status);
/* Return an error. */
return(LX_ERROR);
}
#endif
/* Determine if this word is not available. */
if (sector_word != LX_NOR_PHYSICAL_SECTOR_FREE)
{
/* Increment the sector data not free diagnostic. */
nor_flash -> lx_nor_flash_diagnostic_sector_data_not_free++;
/* This is a format error. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_INVALID_BLOCK);
/* Return an error. */
return(LX_ERROR);
}
/* Move to the next word in the sector. */
sector_word_ptr++;
}
#endif
}
}
}
/* Move to the next flash block. */
block_word_ptr = block_word_ptr + (nor_flash -> lx_nor_flash_words_per_block);
}
/* Update the overall minimum and maximum erase count. */
nor_flash -> lx_nor_flash_minimum_erase_count = min_erased_count;
nor_flash -> lx_nor_flash_minimum_erased_blocks = min_erased_blocks;
nor_flash -> lx_nor_flash_maximum_erase_count = max_erased_count;
/* Determine if we need to update the free sector search pointer. */
if (nor_flash -> lx_nor_flash_free_block_search == nor_flash -> lx_nor_flash_total_blocks)
{
/* Just start at the beginning. */
nor_flash -> lx_nor_flash_free_block_search = 0;
}
}
#ifdef LX_THREAD_SAFE_ENABLE
/* If the thread safe option is enabled, create a ThreadX mutex that will be used in all external APIs
in order to provide thread-safe operation. */
status = tx_mutex_create(&nor_flash -> lx_nor_flash_mutex, "NOR Flash Mutex", TX_NO_INHERIT);
/* Determine if the mutex creation encountered an error. */
if (status != LX_SUCCESS)
{
/* Call system error handler, since this should not happen. */
_lx_nor_flash_system_error(nor_flash, LX_SYSTEM_MUTEX_CREATE_FAILED);
/* Return error to caller. */
return(LX_ERROR);
}
#endif
/* Enable the sector mapping cache. */
nor_flash -> lx_nor_flash_sector_mapping_cache_enabled = LX_TRUE;
/* Initialize the last found block and sector markers. */
nor_flash -> lx_nor_flash_found_block_search = 0;
nor_flash -> lx_nor_flash_found_sector_search = 0;
/* Lockout interrupts. */
LX_DISABLE
/* At this point, the NOR flash has been opened successfully. Place the
NOR flash control block on the linked list of currently opened NOR flashes. */
/* Set the NOR flash state to open. */
nor_flash -> lx_nor_flash_state = LX_NOR_FLASH_OPENED;
/* Place the NOR flash control block on the list of opened NOR flashes. First,
check for an empty list. */
if (_lx_nor_flash_opened_count)
{
/* List is not empty - other NOR flashes are open. */
/* Pickup tail pointer. */
tail_ptr = _lx_nor_flash_opened_ptr -> lx_nor_flash_open_previous;
/* Place the new NOR flash control block in the list. */
_lx_nor_flash_opened_ptr -> lx_nor_flash_open_previous = nor_flash;
tail_ptr -> lx_nor_flash_open_next = nor_flash;
/* Setup this NOR flash's opened links. */
nor_flash -> lx_nor_flash_open_previous = tail_ptr;
nor_flash -> lx_nor_flash_open_next = _lx_nor_flash_opened_ptr;
}
else
{
/* The opened NOR flash list is empty. Add the NOR flash to empty list. */
_lx_nor_flash_opened_ptr = nor_flash;
nor_flash -> lx_nor_flash_open_next = nor_flash;
nor_flash -> lx_nor_flash_open_previous = nor_flash;
}
/* Increment the opened NOR flash counter. */
_lx_nor_flash_opened_count++;
/* Restore interrupts. */
LX_RESTORE
/* Return a successful completion. */
return(LX_SUCCESS);
}
+10 -20
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -71,16 +71,6 @@
/* Application Code */ /* Application Code */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_partial_defragment(LX_NOR_FLASH *nor_flash, UINT max_blocks) UINT _lx_nor_flash_partial_defragment(LX_NOR_FLASH *nor_flash, UINT max_blocks)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -71,16 +71,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_physical_sector_allocate(LX_NOR_FLASH *nor_flash, ULONG logical_sector, ULONG **physical_sector_map_entry, ULONG **physical_sector_address) UINT _lx_nor_flash_physical_sector_allocate(LX_NOR_FLASH *nor_flash, ULONG logical_sector, ULONG **physical_sector_map_entry, ULONG **physical_sector_address)
{ {
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -67,16 +67,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* */
/**************************************************************************/ /**************************************************************************/
VOID _lx_nor_flash_sector_mapping_cache_invalidate(LX_NOR_FLASH *nor_flash, ULONG logical_sector) VOID _lx_nor_flash_sector_mapping_cache_invalidate(LX_NOR_FLASH *nor_flash, ULONG logical_sector)
{ {
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -75,19 +75,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added mapping bitmap cache, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_sector_read(LX_NOR_FLASH *nor_flash, ULONG logical_sector, VOID *buffer) UINT _lx_nor_flash_sector_read(LX_NOR_FLASH *nor_flash, ULONG logical_sector, VOID *buffer)
{ {
+10 -24
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -75,20 +75,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added mapping bitmap cache, */
/* added obsolete count cache, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_sector_release(LX_NOR_FLASH *nor_flash, ULONG logical_sector) UINT _lx_nor_flash_sector_release(LX_NOR_FLASH *nor_flash, ULONG logical_sector)
{ {
+10 -24
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -78,20 +78,6 @@
/* */ /* */
/* Application Code */ /* Application Code */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
/* added mapping bitmap cache, */
/* added obsolete count cache, */
/* resulting in version 6.3.0 */
/* */
/**************************************************************************/ /**************************************************************************/
UINT _lx_nor_flash_sector_write(LX_NOR_FLASH *nor_flash, ULONG logical_sector, VOID *buffer) UINT _lx_nor_flash_sector_write(LX_NOR_FLASH *nor_flash, ULONG logical_sector, VOID *buffer)
{ {
+10 -10
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
+10 -23
View File
@@ -1,13 +1,13 @@
/**************************************************************************/ /***************************************************************************
/* */ * Copyright (c) 2024 Microsoft Corporation
/* Copyright (c) Microsoft Corporation. All rights reserved. */ * Copyright (c) 2026-present Eclipse ThreadX contributors
/* */ *
/* This software is licensed under the Microsoft Software License */ * This program and the accompanying materials are made available under the
/* Terms for Microsoft Azure RTOS. Full text of the license can be */ * terms of the MIT License which is available at
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ * https://opensource.org/licenses/MIT.
/* and in the root directory of this software. */ *
/* */ * SPDX-License-Identifier: MIT
/**************************************************************************/ **************************************************************************/
/**************************************************************************/ /**************************************************************************/
@@ -66,19 +66,6 @@
/* */ /* */
/* Internal LevelX */ /* Internal LevelX */
/* */ /* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* resulting in version 6.1.7 */
/* 03-08-2023 Xiuwen Cai Modified comment(s), */
/* added new driver interface, */
/* resulting in version 6.2.1 */
/* */
/**************************************************************************/ /**************************************************************************/
VOID _lx_nor_flash_system_error(LX_NOR_FLASH *nor_flash, UINT error_code) VOID _lx_nor_flash_system_error(LX_NOR_FLASH *nor_flash, UINT error_code)
{ {
+197
View File
@@ -0,0 +1,197 @@
LevelX
For version 6 and higher, please refer to the release notes on GitHub at https://github.com/eclipse-threadx/levelx/releases.
Below is the revision history for 5.x.
08/15/2019 LevelX generic code version 5.6. This release includes the
following major features:
Files are modified to fix compiler warnings:
demo_filex_nand_flash.c
demo_filex_nor_flash.c
lx_nand_flash_256byte_ecc_check.c
lx_nand_flash_256byte_ecc_compute.c
10/10/2018 LevelX generic code version 5.5. This release includes the following
modifications:
lx_api.h Removed compiler warnings, added extended NOR cache
support, new APIs, and new constants.
lx_nand_flash_256byte_ecc_check.c Removed compiler warnings.
lx_nand_flash_256byte_ecc_compute.c Removed compiler warnings.
lx_nand_flash_block_obsoleted_check.c Added logic to mark the beginning of block erase.
lx_nand_flash_block_reclaim.c Removed compiler warnings, and added logic to mark
the beginning of block erase.
lx_nand_flash_logical_sector_find.c Removed compiler warnings, and added logic to use
and maintain the last found page.
lx_nand_flash_next_block_to_erase_find.c Removed compiler warnings.
lx_nand_flash_open.c Added logic to detect start of a block erase that
was interrupted, removed system error call for more
than one page being obsoleted since this can happen
normally, removed compiler warnings, and added logic
to initialize the last found page.
lx_nand_flash_partial_defragment.c Added file in this release.
lx_nand_flash_sector_release.c Removed compiler warnings.
lx_nand_flash_sector_write.c Removed compiler warnings.
lx_nor_flash_block_reclaim.c Removed direct driver access for erases/reads/writes,
removed compiler warnings, and added logic to mark
the beginning of block erase.
lx_nor_flash_driver_block_erase.c Added file in this release.
lx_nor_flash_driver_read.c Added file in this release.
lx_nor_flash_driver_write.c Added file in this release.
lx_nor_flash_extended_cache_enable.c Added file in this release.
lx_nor_flash_logical_sector_find.c Removed direct driver access for reads, removed compiler
warnings, and added logic to use and maintain the last
found sector/block.
lx_nor_flash_next_block_to_erase_find.c Removed compiler warnings, and removed direct driver
access for reads.
lx_nor_flash_open.c Removed direct driver access for erases/reads/writes,
added logic to detect start of a block erase that was
interrupted, removed system error call for more than
one page being obsoleted since this can happen normally,
removed compiler warnings, and added logic to initialize
the last found sector/block.
lx_nor_flash_partial_defragment.c Added file in this release.
lx_nor_flash_physical_sector_allocate.c Removed direct driver access for reads/writes.
lx_nor_flash_sector_read.c Removed direct driver access for reads/writes.
lx_nor_flash_sector_release.c Removed direct driver access for reads/writes.
lx_nor_flash_sector_write.c Removed direct driver access for reads/writes.
lx_nor_flash_simulator.c Removed compiler warnings.
lx*.c Changed comments and copyright header, and added
conditional around disabling ThreadX error checking.
lx*.h Changed comments and copyright header.
05/01/2018 LevelX generic code version 5.4. This release includes the following
modifications:
lx_api.h Added NOR flash RAM buffer, added bit constant
for both NOR and NAND flash to indicate when
mapping write is valid, added diagnostic counter
for tracking when incomplete mapping is detected
on open, add added new error code when driver
does not supply a sector/page RAM buffer.
fx_nand_flash_simulated_driver.c Added error checking, and corrected sector
read/write processing.
fx_nor_flash_simulator_driver.c Added error checking.
lx_nand_flash_block_reclaim.c Added clearing of additional bit to indicate when
mapping is valid, and corrected logic that could
cause a newly mapped sector to be erased.
lx_nand_flash_logical_sector_find.c Added logic to make sure the sector mapping is valid.
lx_nand_flash_next_block_to_erase_find.c Added logic to improve search for free sectors.
lx_nand_flash_open.c Added logic to detect and handle a mapping entry
interrupted before completion, and added logic to
ensure there is a page buffer supplied by the
driver.
lx_nand_flash_sector_release.c Added reclaim logic to help increase free sectors.
lx_nand_flash_sector_write.c Added clearing of additional bit to indicate when
mapping is valid.
lx_nor_flash_block_reclaim.c Added clearing of additional bit to indicate when
mapping is valid, added logic to read NOR sector
into RAM buffer if direct NOR access is not possible,
and corrected logic that could cause a newly mapped
sector to be erased.
lx_nor_flash_logical_sector_find.c Added logic to make sure the sector mapping is valid.
lx_nor_flash_next_block_to_erase_find.c Added logic to improve search for free sectors.
lx_nor_flash_open.c Added logic to detect and handle a mapping entry
interrupted before completion, and added logic to
ensure there is a sector buffer supplied by the
driver if LX_DIRECT_READ is not specified.
lx_nor_flash_sector_release.c Added reclaim logic to help increase free sectors.
lx_nor_flash_sector_write.c Added clearing of additional bit to indicate when
mapping is valid, and removed optimization to ensure
atomic sector write.
lx_nor_flash_simulator.c Added logic to supply RAM buffer for reading
sector when LX_DIRECT_READ is not specified,
and removed write attempt to already written
sector, since this is no longer required.
fx*.c Changed comments and copyright header.
lx*.c Changed comments and copyright header.
lx*.h Changed comments and copyright header.
11/01/2017 LevelX generic code version 5.3. This release includes the following
modifications:
lx_nand_flash_block_full_update.c Added check to make sure the block is
actually full.
lx_nand_flash_block_reclaim.c Added support for direct logical sector
cache.
lx_nand_flash_logical_sector_find.c Added adjustment of mapped sectors when
examining the mapped list, added support
for direct logical sector cache.
lx_nand_flash_open.c Added support for direct logical sector cache,
and updated diagnostics.
lx_nand_flash_physical_page_allocate.c Added adjustment of the search pointer for
next allocate request.
lx_nand_flash_sector_mapping_cache_invalidate.c Added support for direct logical sector cache.
lx_nand_flash_sector_release.c Added logic to update the page 0 mapping list
if present.
lx_nand_flash_sector_write.c Added logic to update the page 0 mapping list
if present, and added check to make sure the
new mapping wasn't moved, added direct logical
sector cache.
fx*.c Changed comments and copyright header.
lx*.c Changed comments and copyright header.
lx*.h Changed comments and copyright header.
03/01/2017 LevelX generic code version 5.2. This release includes the following
modifications:
lx_nand_flash_block_full_update.c Reduced the number of words accessed in
page 0, added driver interface layer,
and modified the extra bytes usage in
page 0 to support block valid-full-empty.
lx_nand_flash_block_obsoleted_check.c Added file in this release.
lx_nand_flash_block_reclaim.c Added logic to update page 0 on a full
block update, added driver interface layer,
and added additional diagnostic information.
lx_nand_flash_driver_block_erase.c Added file in this release.
lx_nand_flash_driver_block_erased_verify.c Added file in this release.
lx_nand_flash_driver_block_status_get.c Added file in this release.
lx_nand_flash_driver_block_status_set.c Added file in this release.
lx_nand_flash_driver_extra_bytes_get.c Added file in this release.
lx_nand_flash_driver_extra_bytes_set.c Added file in this release.
lx_nand_flash_driver_page_erased_verify.c Added file in this release.
lx_nand_flash_driver_read.c Added file in this release.
lx_nand_flash_driver_write.c Added file in this release.
lx_nand_flash_extended_cache_enable.c Added file in this release.
lx_nand_flash_logical_sector_find.c Reduced the number of words accessed in
page 0, corrected check for valid sector
mapping list, added max mapped sector logic,
added driver interface layer, and added logic
to use and maintain the last found sector block.
lx_nand_flash_next_block_to_erase_find.c Reduced the number of words accessed in page 0,
and added driver interface layer.
lx_nand_flash_open.c Reduced the number of words accessed in page 0,
added driver interface layer, added additional
diagnostic information, added logic to initialize
the maximum mapped logical sector, and added
initialization of the last found sector block.
lx_nand_flash_physical_page_allocate.c Reduced the number of words accessed in page 0,
added driver interface layer, and added logic
to use page 0's extra bytes to determine if
block has available pages.
lx_nand_flash_sector_read.c Added driver interface layer.
lx_nand_flash_sector_release.c Added logic to maintain the maximum mapped
sector, and added driver interface layer.
lx_nand_flash_sector_write.c Added call to see if the block is completely
obsoleted, added logic to remember the maximum
mapped sector, and added driver interface layer.
fx_nand_flash_simulator_driver.c Removed sector packing by requiring sector and
cluster size to match, and added release sector
support.
fx*.c Changed comments and copyright header.
lx*.c Changed comments and copyright header.
lx*.h Changed comments and copyright header.
08/01/2016 LevelX generic code version 5.1. This release includes the following
modifications:
lx_nor_flash_physical_sector_allocate.c Corrected problem with more than 32 sectors per
flash block.
fx*.c Changed comments and copyright header.
lx*.c Changed comments and copyright header.
lx*.h Changed comments and copyright header.
01/22/2015 Initial LevelX generic code version 5.0.
+11
View File
@@ -1,3 +1,14 @@
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 Eclipse ThreadX contributors */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the MIT License which is available at */
/* https://opensource.org/licenses/MIT. */
/* */
/* SPDX-License-Identifier: MIT */
/***************************************************************************/
/* This is a small demo of the high-performance FileX FAT file system with LevelX /* This is a small demo of the high-performance FileX FAT file system with LevelX
and the NAND simulated driver. */ and the NAND simulated driver. */
+11
View File
@@ -1,3 +1,14 @@
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 Eclipse ThreadX contributors */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the MIT License which is available at */
/* https://opensource.org/licenses/MIT. */
/* */
/* SPDX-License-Identifier: MIT */
/***************************************************************************/
/* This is a small demo of the high-performance FileX FAT file system with LevelX /* This is a small demo of the high-performance FileX FAT file system with LevelX
and the NOR simulated driver. */ and the NOR simulated driver. */
+11
View File
@@ -1,2 +1,13 @@
#!/bin/bash #!/bin/bash
##############################################################################
# Copyright (c) 2024 Microsoft Corporation
# Copyright (c) 2026 Eclipse ThreadX contributors
#
# This program and the accompanying materials are made available under the
# terms of the MIT License which is available at
# https://opensource.org/licenses/MIT.
#
# SPDX-License-Identifier: MIT
##############################################################################
$(dirname `realpath $0`)/../test/cmake/run.sh build all $(dirname `realpath $0`)/../test/cmake/run.sh build all
+11
View File
@@ -1,4 +1,15 @@
#!/bin/bash #!/bin/bash
##############################################################################
# Copyright (c) 2024 Microsoft Corporation
# Copyright (c) 2026 Eclipse ThreadX contributors
#
# This program and the accompanying materials are made available under the
# terms of the MIT License which is available at
# https://opensource.org/licenses/MIT.
#
# SPDX-License-Identifier: MIT
##############################################################################
# #
# Remove large folder # Remove large folder
+132
View File
@@ -0,0 +1,132 @@
#!/usr/bin/env bash
# prepare_release.sh
# Prepares a LevelX release by updating version constants.
#
# Usage: prepare_release.sh <version>
# Example: prepare_release.sh 6.5.1.202602
# Hotfix: prepare_release.sh 6.5.1.202602a
#
# This script:
# 1. Creates branch release-<version>-preparation from dev
# 2. Updates version constants in common/inc/lx_api.h
# (commit: "Updated version number constants")
# (No port-specific version strings in this repository)
#
# Copyright (C) 2026 Eclipse ThreadX contributors
# SPDX-License-Identifier: MIT
set -eu
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
REPO_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd)"
API_HEADER="${REPO_ROOT}/common/inc/lx_api.h"
# --------------------------------------------------------------------------
# Argument validation
# --------------------------------------------------------------------------
if [ "$#" -ne 1 ]; then
printf "Usage: %s <version>\n" "$(basename "$0")" >&2
printf "Example: %s 6.5.1.202602\n" "$(basename "$0")" >&2
exit 1
fi
VERSION="$1"
if ! printf "%s" "${VERSION}" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+[a-z]?$'; then
printf "Error: Invalid version format '%s'.\n" "${VERSION}" >&2
printf "Expected: MAJOR.MINOR.PATCH.BUILD[hotfix_letter]\n" >&2
exit 1
fi
# --------------------------------------------------------------------------
# Parse version components
# --------------------------------------------------------------------------
MAJOR=$(printf "%s" "${VERSION}" | cut -d. -f1)
MINOR=$(printf "%s" "${VERSION}" | cut -d. -f2)
PATCH=$(printf "%s" "${VERSION}" | cut -d. -f3)
BUILD_AND_HOTFIX=$(printf "%s" "${VERSION}" | cut -d. -f4)
BUILD=$(printf "%s" "${BUILD_AND_HOTFIX}" | sed -E 's/[a-z]+$//')
HOTFIX=$(printf "%s" "${BUILD_AND_HOTFIX}" | sed -E 's/^[0-9]+//')
if [ -z "${HOTFIX}" ]; then
HOTFIX_DEFINE="' '"
else
HOTFIX_DEFINE="'${HOTFIX}'"
fi
# --------------------------------------------------------------------------
# Read and display current version
# --------------------------------------------------------------------------
CURR_MAJOR=$(grep -E "^#define LEVELX_MAJOR_VERSION" "${API_HEADER}" | awk '{print $NF}')
CURR_MINOR=$(grep -E "^#define LEVELX_MINOR_VERSION" "${API_HEADER}" | awk '{print $NF}')
CURR_PATCH=$(grep -E "^#define LEVELX_PATCH_VERSION" "${API_HEADER}" | awk '{print $NF}')
CURR_BUILD=$(grep -E "^#define LEVELX_BUILD_VERSION" "${API_HEADER}" | awk '{print $NF}')
CURR_HOTFIX=$(grep -E "^#define LEVELX_HOTFIX_VERSION" "${API_HEADER}" | \
sed -E "s/.*'([^']*)'.*/\1/" | tr -d ' ')
if [ -z "${CURR_HOTFIX}" ]; then
CURR_VER="${CURR_MAJOR}.${CURR_MINOR}.${CURR_PATCH}.${CURR_BUILD}"
else
CURR_VER="${CURR_MAJOR}.${CURR_MINOR}.${CURR_PATCH}.${CURR_BUILD}${CURR_HOTFIX}"
fi
printf "\nLevelX release preparation\n"
printf " Repository : %s\n" "${REPO_ROOT}"
printf " Current version : %s\n" "${CURR_VER}"
printf " Target version : %s\n\n" "${VERSION}"
printf "Proceed with update? [y/N] "
read -r CONFIRM
case "${CONFIRM}" in
y|Y) ;;
*)
printf "Aborted.\n"
exit 0
;;
esac
# --------------------------------------------------------------------------
# Pre-flight checks
# --------------------------------------------------------------------------
if ! git -C "${REPO_ROOT}" diff --quiet HEAD 2>/dev/null; then
printf "Error: Working tree has uncommitted changes. Commit or stash first.\n" >&2
exit 1
fi
# --------------------------------------------------------------------------
# Create feature branch from dev
# --------------------------------------------------------------------------
BRANCH_NAME="release-${VERSION}-preparation"
printf "\nChecking out dev and pulling latest changes...\n"
git -C "${REPO_ROOT}" checkout dev
git -C "${REPO_ROOT}" pull origin dev
printf "Creating branch '%s'...\n" "${BRANCH_NAME}"
git -C "${REPO_ROOT}" checkout -b "${BRANCH_NAME}"
# --------------------------------------------------------------------------
# Update version constants
# --------------------------------------------------------------------------
printf "\nUpdating version constants in %s...\n" "${API_HEADER}"
sed -i -E "s|(#define LEVELX_MAJOR_VERSION[[:space:]]+)[0-9]+|\1${MAJOR}|" "${API_HEADER}"
sed -i -E "s|(#define LEVELX_MINOR_VERSION[[:space:]]+)[0-9]+|\1${MINOR}|" "${API_HEADER}"
sed -i -E "s|(#define LEVELX_PATCH_VERSION[[:space:]]+)[0-9]+|\1${PATCH}|" "${API_HEADER}"
sed -i -E "s|(#define LEVELX_BUILD_VERSION[[:space:]]+)[0-9]+|\1${BUILD}|" "${API_HEADER}"
sed -i -E "s|(#define LEVELX_HOTFIX_VERSION[[:space:]]+)'[^']*'|\1${HOTFIX_DEFINE}|" "${API_HEADER}"
git -C "${REPO_ROOT}" add "${API_HEADER}"
git -C "${REPO_ROOT}" commit -F - <<'COMMIT_EOF'
Updated version number constants
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
COMMIT_EOF
printf "Committed version constant updates.\n"
# --------------------------------------------------------------------------
# Port version strings
# --------------------------------------------------------------------------
printf "\nNo port-specific version strings in this repository. Skipping port commit.\n"
printf "\nRelease preparation complete.\n"
printf "Branch '%s' is ready for review.\n" "${BRANCH_NAME}"
+11
View File
@@ -1,2 +1,13 @@
#!/bin/bash #!/bin/bash
##############################################################################
# Copyright (c) 2024 Microsoft Corporation
# Copyright (c) 2026 Eclipse ThreadX contributors
#
# This program and the accompanying materials are made available under the
# terms of the MIT License which is available at
# https://opensource.org/licenses/MIT.
#
# SPDX-License-Identifier: MIT
##############################################################################
$(dirname `realpath $0`)/../test/cmake/run.sh test all $(dirname `realpath $0`)/../test/cmake/run.sh test all
+11
View File
@@ -1,4 +1,15 @@
#!/bin/bash #!/bin/bash
##############################################################################
# Copyright (c) 2024 Microsoft Corporation
# Copyright (c) 2026 Eclipse ThreadX contributors
#
# This program and the accompanying materials are made available under the
# terms of the MIT License which is available at
# https://opensource.org/licenses/MIT.
#
# SPDX-License-Identifier: MIT
##############################################################################
set -e set -e
+1 -1
View File
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 3.0.0 FATAL_ERROR) cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
cmake_policy(SET CMP0057 NEW) cmake_policy(SET CMP0057 NEW)
project(regression_test LANGUAGES C) project(regression_test LANGUAGES C)
+13 -2
View File
@@ -1,9 +1,20 @@
#!/bin/bash #!/bin/bash
##############################################################################
# Copyright (c) 2024 Microsoft Corporation
# Copyright (c) 2026 Eclipse ThreadX contributors
#
# This program and the accompanying materials are made available under the
# terms of the MIT License which is available at
# https://opensource.org/licenses/MIT.
#
# SPDX-License-Identifier: MIT
##############################################################################
cd $(dirname $0) cd $(dirname $0)
# if threadx repo does not exist, clone it # if threadx repo does not exist, clone it
[ -d threadx ] || git clone https://github.com/azure-rtos/threadx.git --depth 1 [ -d threadx ] || git clone https://github.com/eclipse-threadx/threadx.git --depth 1
[ -d filex ] || git clone https://github.com/azure-rtos/filex.git --depth 1 [ -d filex ] || git clone https://github.com/eclipse-threadx/filex.git --depth 1
[ -f .run.sh ] || ln -sf threadx/scripts/cmake_bootstrap.sh .run.sh [ -f .run.sh ] || ln -sf threadx/scripts/cmake_bootstrap.sh .run.sh
./.run.sh $* ./.run.sh $*
+1 -1
View File
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 3.0.0 FATAL_ERROR) cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
cmake_policy(SET CMP0057 NEW) cmake_policy(SET CMP0057 NEW)
project(samples LANGUAGES C) project(samples LANGUAGES C)
+11
View File
@@ -1,3 +1,14 @@
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 Eclipse ThreadX contributors */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the MIT License which is available at */
/* https://opensource.org/licenses/MIT. */
/* */
/* SPDX-License-Identifier: MIT */
/***************************************************************************/
/* Basic NOR flash tests... */ /* Basic NOR flash tests... */
#include <stdio.h> #include <stdio.h>
+18 -7
View File
@@ -1,3 +1,14 @@
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 Eclipse ThreadX contributors */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the MIT License which is available at */
/* https://opensource.org/licenses/MIT. */
/* */
/* SPDX-License-Identifier: MIT */
/***************************************************************************/
/* Basic NOR flash tests... */ /* Basic NOR flash tests... */
#include <stdio.h> #include <stdio.h>
@@ -21,7 +32,6 @@ ULONG readbuffer[128];
/* Define LevelX NOR flash simulator prototoypes. */ /* Define LevelX NOR flash simulator prototoypes. */
UINT _lx_nor_flash_simulator_erase_all(VOID);
UINT _lx_nor_flash_simulator_initialize(LX_NOR_FLASH *nor_flash); UINT _lx_nor_flash_simulator_initialize(LX_NOR_FLASH *nor_flash);
@@ -70,12 +80,13 @@ UINT status;
ULONG *word_ptr; ULONG *word_ptr;
/* Erase the simulated NOR flash. */ /* format the simulated NOR flash. */
_lx_nor_flash_simulator_erase_all();
/* Initialize LevelX. */ /* Initialize LevelX. */
_lx_nor_flash_initialize(); _lx_nor_flash_initialize();
lx_nor_flash_format(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize, NULL);
/* Test 1: Simple write 100 sectors and read 100 sectors. */ /* Test 1: Simple write 100 sectors and read 100 sectors. */
printf("Test 1: Simple write-read 100 sectors..........."); printf("Test 1: Simple write-read 100 sectors...........");
@@ -141,10 +152,10 @@ ULONG *word_ptr;
printf("Test 2: Write same sector 120 times............."); printf("Test 2: Write same sector 120 times.............");
/* Reinitialize... */ /* Reinitialize... */
_lx_nor_flash_simulator_erase_all();
lx_nor_flash_initialize(); lx_nor_flash_initialize();
lx_nor_flash_format(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize, NULL);
lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize); lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize);
for (j = 0; j < 128; j++) for (j = 0; j < 128; j++)
@@ -1283,9 +1294,9 @@ ULONG *word_ptr;
printf("Test 5: Randow write/read sector................"); printf("Test 5: Randow write/read sector................");
/* Erase the simulated NOR flash. */ /* format the simulated NOR flash. */
_lx_nor_flash_simulator_erase_all();
lx_nor_flash_format(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize, NULL);
/* Open the flash. */ /* Open the flash. */
status = lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize); status = lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize);
+18 -10
View File
@@ -1,3 +1,14 @@
/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 Eclipse ThreadX contributors */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the MIT License which is available at */
/* https://opensource.org/licenses/MIT. */
/* */
/* SPDX-License-Identifier: MIT */
/***************************************************************************/
/* Basic NOR flash tests... */ /* Basic NOR flash tests... */
#include <stdio.h> #include <stdio.h>
@@ -24,7 +35,6 @@ UCHAR nor_cache_memory2[8192];
/* Define LevelX NOR flash simulator prototoypes. */ /* Define LevelX NOR flash simulator prototoypes. */
UINT _lx_nor_flash_simulator_erase_all(VOID);
UINT _lx_nor_flash_simulator_initialize(LX_NOR_FLASH *nor_flash); UINT _lx_nor_flash_simulator_initialize(LX_NOR_FLASH *nor_flash);
@@ -74,15 +84,13 @@ UINT status;
ULONG *word_ptr; ULONG *word_ptr;
/* Erase the simulated NOR flash. */
_lx_nor_flash_simulator_erase_all();
/* Initialize LevelX. */ /* Initialize LevelX. */
_lx_nor_flash_initialize(); _lx_nor_flash_initialize();
/* Test 1: Simple write 100 sectors and read 100 sectors. */ /* Test 1: Simple write 100 sectors and read 100 sectors. */
printf("Test 1: Simple write-read 100 sectors..........."); printf("Test 1: Simple write-read 100 sectors...........");
lx_nor_flash_format(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize, NULL);
lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize); lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize);
#ifndef LX_NOR_DISABLE_EXTENDED_CACHE #ifndef LX_NOR_DISABLE_EXTENDED_CACHE
lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, sizeof(nor_cache_memory)); lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, sizeof(nor_cache_memory));
@@ -267,10 +275,9 @@ lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, sizeof(nor_
printf("Test 2: Write same sector 120 times............."); printf("Test 2: Write same sector 120 times.............");
/* Reinitialize... */ /* Reinitialize... */
_lx_nor_flash_simulator_erase_all();
lx_nor_flash_initialize(); lx_nor_flash_initialize();
lx_nor_flash_format(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize, NULL);
lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize); lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize);
#ifndef LX_NOR_DISABLE_EXTENDED_CACHE #ifndef LX_NOR_DISABLE_EXTENDED_CACHE
lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, sizeof(nor_cache_memory)); lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, sizeof(nor_cache_memory));
@@ -1430,10 +1437,11 @@ status += lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, s
printf("Test 5: Randow write/read sector................"); printf("Test 5: Randow write/read sector................");
/* Erase the simulated NOR flash. */ /*format the simulated NOR flash. */
_lx_nor_flash_simulator_erase_all();
/* Open the flash. */ /* Open the flash. */
status = lx_nor_flash_format(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize, NULL);
status = lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize); status = lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize);
#ifndef LX_NOR_DISABLE_EXTENDED_CACHE #ifndef LX_NOR_DISABLE_EXTENDED_CACHE
status += lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, sizeof(nor_cache_memory)); status += lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, sizeof(nor_cache_memory));
@@ -1578,8 +1586,8 @@ status += lx_nor_flash_extended_cache_enable(&nor_sim_flash, nor_cache_memory, s
printf("Test 6: Check lx_nor_flash_extended_cache_entries size................"); printf("Test 6: Check lx_nor_flash_extended_cache_entries size................");
/* Erase the simulated NOR flash. */ /* Format the simulated NOR flash. */
_lx_nor_flash_simulator_erase_all(); status = lx_nor_flash_format(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize, NULL);
/* Open the flash. */ /* Open the flash. */
status = lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize); status = lx_nor_flash_open(&nor_sim_flash, "sim nor flash", _lx_nor_flash_simulator_initialize);