Skip to content
This repository was archived by the owner on Aug 23, 2024. It is now read-only.

Commit b5cf5d6

Browse files
loborisloboris
committed
Added support for LittleFS as internal file system
Updated esp-idf
1 parent 8c5b384 commit b5cf5d6

45 files changed

Lines changed: 6355 additions & 59 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎MicroPython_BUILD/BUILD.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545

4646

4747
#=======================
48-
TOOLS_VER=ver20180315.id
48+
TOOLS_VER=ver20180321.id
4949
#=======================
5050

5151
# -----------------------------

‎MicroPython_BUILD/build_func.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ get_bin_size() {
7474

7575
#----------------------
7676
get_config_flash_sz() {
77-
local cfg_fsfat=$(grep -e CONFIG_MICROPY_USE_SPIFFS=y sdkconfig)
77+
local cfg_fsfat=$(grep -e CONFIG_MICROPY_FILESYSTEM_TYPE=0 sdkconfig)
7878
if [ "${cfg_fsfat}" == "" ]; then
7979
fs_type_fat="yes"
8080
cfg_fsfat=$(grep -e CONFIG_WL_SECTOR_SIZE_512=y sdkconfig)

‎MicroPython_BUILD/components/littlefs/DESIGN.md‎

Lines changed: 1226 additions & 0 deletions
Large diffs are not rendered by default.

‎MicroPython_BUILD/components/littlefs/LICENSE.md‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction, and
10+
distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
13+
owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all other entities
16+
that control, are controlled by, or are under common control with that entity.
17+
For the purposes of this definition, "control" means (i) the power, direct or
18+
indirect, to cause the direction or management of such entity, whether by
19+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity exercising
23+
permissions granted by this License.
24+
25+
"Source" form shall mean the preferred form for making modifications, including
26+
but not limited to software source code, documentation source, and configuration
27+
files.
28+
29+
"Object" form shall mean any form resulting from mechanical transformation or
30+
translation of a Source form, including but not limited to compiled object code,
31+
generated documentation, and conversions to other media types.
32+
33+
"Work" shall mean the work of authorship, whether in Source or Object form, made
34+
available under the License, as indicated by a copyright notice that is included
35+
in or attached to the work (an example is provided in the Appendix below).
36+
37+
"Derivative Works" shall mean any work, whether in Source or Object form, that
38+
is based on (or derived from) the Work and for which the editorial revisions,
39+
annotations, elaborations, or other modifications represent, as a whole, an
40+
original work of authorship. For the purposes of this License, Derivative Works
41+
shall not include works that remain separable from, or merely link (or bind by
42+
name) to the interfaces of, the Work and Derivative Works thereof.
43+
44+
"Contribution" shall mean any work of authorship, including the original version
45+
of the Work and any modifications or additions to that Work or Derivative Works
46+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
47+
by the copyright owner or by an individual or Legal Entity authorized to submit
48+
on behalf of the copyright owner. For the purposes of this definition,
49+
"submitted" means any form of electronic, verbal, or written communication sent
50+
to the Licensor or its representatives, including but not limited to
51+
communication on electronic mailing lists, source code control systems, and
52+
issue tracking systems that are managed by, or on behalf of, the Licensor for
53+
the purpose of discussing and improving the Work, but excluding communication
54+
that is conspicuously marked or otherwise designated in writing by the copyright
55+
owner as "Not a Contribution."
56+
57+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
58+
of whom a Contribution has been received by Licensor and subsequently
59+
incorporated within the Work.
60+
61+
2. Grant of Copyright License.
62+
63+
Subject to the terms and conditions of this License, each Contributor hereby
64+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
65+
irrevocable copyright license to reproduce, prepare Derivative Works of,
66+
publicly display, publicly perform, sublicense, and distribute the Work and such
67+
Derivative Works in Source or Object form.
68+
69+
3. Grant of Patent License.
70+
71+
Subject to the terms and conditions of this License, each Contributor hereby
72+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
73+
irrevocable (except as stated in this section) patent license to make, have
74+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
75+
such license applies only to those patent claims licensable by such Contributor
76+
that are necessarily infringed by their Contribution(s) alone or by combination
77+
of their Contribution(s) with the Work to which such Contribution(s) was
78+
submitted. If You institute patent litigation against any entity (including a
79+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
80+
Contribution incorporated within the Work constitutes direct or contributory
81+
patent infringement, then any patent licenses granted to You under this License
82+
for that Work shall terminate as of the date such litigation is filed.
83+
84+
4. Redistribution.
85+
86+
You may reproduce and distribute copies of the Work or Derivative Works thereof
87+
in any medium, with or without modifications, and in Source or Object form,
88+
provided that You meet the following conditions:
89+
90+
You must give any other recipients of the Work or Derivative Works a copy of
91+
this License; and
92+
You must cause any modified files to carry prominent notices stating that You
93+
changed the files; and
94+
You must retain, in the Source form of any Derivative Works that You distribute,
95+
all copyright, patent, trademark, and attribution notices from the Source form
96+
of the Work, excluding those notices that do not pertain to any part of the
97+
Derivative Works; and
98+
If the Work includes a "NOTICE" text file as part of its distribution, then any
99+
Derivative Works that You distribute must include a readable copy of the
100+
attribution notices contained within such NOTICE file, excluding those notices
101+
that do not pertain to any part of the Derivative Works, in at least one of the
102+
following places: within a NOTICE text file distributed as part of the
103+
Derivative Works; within the Source form or documentation, if provided along
104+
with the Derivative Works; or, within a display generated by the Derivative
105+
Works, if and wherever such third-party notices normally appear. The contents of
106+
the NOTICE file are for informational purposes only and do not modify the
107+
License. You may add Your own attribution notices within Derivative Works that
108+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
109+
provided that such additional attribution notices cannot be construed as
110+
modifying the License.
111+
You may add Your own copyright statement to Your modifications and may provide
112+
additional or different license terms and conditions for use, reproduction, or
113+
distribution of Your modifications, or for any such Derivative Works as a whole,
114+
provided Your use, reproduction, and distribution of the Work otherwise complies
115+
with the conditions stated in this License.
116+
117+
5. Submission of Contributions.
118+
119+
Unless You explicitly state otherwise, any Contribution intentionally submitted
120+
for inclusion in the Work by You to the Licensor shall be under the terms and
121+
conditions of this License, without any additional terms or conditions.
122+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
123+
any separate license agreement you may have executed with Licensor regarding
124+
such Contributions.
125+
126+
6. Trademarks.
127+
128+
This License does not grant permission to use the trade names, trademarks,
129+
service marks, or product names of the Licensor, except as required for
130+
reasonable and customary use in describing the origin of the Work and
131+
reproducing the content of the NOTICE file.
132+
133+
7. Disclaimer of Warranty.
134+
135+
Unless required by applicable law or agreed to in writing, Licensor provides the
136+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
137+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
138+
including, without limitation, any warranties or conditions of TITLE,
139+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
140+
solely responsible for determining the appropriateness of using or
141+
redistributing the Work and assume any risks associated with Your exercise of
142+
permissions under this License.
143+
144+
8. Limitation of Liability.
145+
146+
In no event and under no legal theory, whether in tort (including negligence),
147+
contract, or otherwise, unless required by applicable law (such as deliberate
148+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
149+
liable to You for damages, including any direct, indirect, special, incidental,
150+
or consequential damages of any character arising as a result of this License or
151+
out of the use or inability to use the Work (including but not limited to
152+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
153+
any and all other commercial damages or losses), even if such Contributor has
154+
been advised of the possibility of such damages.
155+
156+
9. Accepting Warranty or Additional Liability.
157+
158+
While redistributing the Work or Derivative Works thereof, You may choose to
159+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
160+
other liability obligations and/or rights consistent with this License. However,
161+
in accepting such obligations, You may act only on Your own behalf and on Your
162+
sole responsibility, not on behalf of any other Contributor, and only if You
163+
agree to indemnify, defend, and hold each Contributor harmless for any liability
164+
incurred by, or claims asserted against, such Contributor by reason of your
165+
accepting any such warranty or additional liability.

‎MicroPython_BUILD/components/littlefs/README.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
## The little filesystem
2+
3+
A little fail-safe filesystem designed for embedded systems.
4+
5+
```
6+
| | | .---._____
7+
.-----. | |
8+
--|o |---| littlefs |
9+
--| |---| |
10+
'-----' '----------'
11+
| | |
12+
```
13+
14+
**Bounded RAM/ROM** - The littlefs is designed to work with a limited amount
15+
of memory. Recursion is avoided and dynamic memory is limited to configurable
16+
buffers that can be provided statically.
17+
18+
**Power-loss resilient** - The littlefs is designed for systems that may have
19+
random power failures. The littlefs has strong copy-on-write guarantees and
20+
storage on disk is always kept in a valid state.
21+
22+
**Wear leveling** - Since the most common form of embedded storage is erodible
23+
flash memories, littlefs provides a form of dynamic wear leveling for systems
24+
that can not fit a full flash translation layer.
25+
26+
## Example
27+
28+
Here's a simple example that updates a file named `boot_count` every time
29+
main runs. The program can be interrupted at any time without losing track
30+
of how many times it has been booted and without corrupting the filesystem:
31+
32+
``` c
33+
#include "lfs.h"
34+
35+
// variables used by the filesystem
36+
lfs_t lfs;
37+
lfs_file_t file;
38+
39+
// configuration of the filesystem is provided by this struct
40+
const struct lfs_config cfg = {
41+
// block device operations
42+
.read = user_provided_block_device_read,
43+
.prog = user_provided_block_device_prog,
44+
.erase = user_provided_block_device_erase,
45+
.sync = user_provided_block_device_sync,
46+
47+
// block device configuration
48+
.read_size = 16,
49+
.prog_size = 16,
50+
.block_size = 4096,
51+
.block_count = 128,
52+
.lookahead = 128,
53+
};
54+
55+
// entry point
56+
int main(void) {
57+
// mount the filesystem
58+
int err = lfs_mount(&lfs, &cfg);
59+
60+
// reformat if we can't mount the filesystem
61+
// this should only happen on the first boot
62+
if (err) {
63+
lfs_format(&lfs, &cfg);
64+
lfs_mount(&lfs, &cfg);
65+
}
66+
67+
// read current count
68+
uint32_t boot_count = 0;
69+
lfs_file_open(&lfs, &file, "boot_count", LFS_O_RDWR | LFS_O_CREAT);
70+
lfs_file_read(&lfs, &file, &boot_count, sizeof(boot_count));
71+
72+
// update boot count
73+
boot_count += 1;
74+
lfs_file_rewind(&lfs, &file);
75+
lfs_file_write(&lfs, &file, &boot_count, sizeof(boot_count));
76+
77+
// remember the storage is not updated until the file is closed successfully
78+
lfs_file_close(&lfs, &file);
79+
80+
// release any resources we were using
81+
lfs_unmount(&lfs);
82+
83+
// print the boot count
84+
printf("boot_count: %d\n", boot_count);
85+
}
86+
```
87+
88+
## Usage
89+
90+
Detailed documentation (or at least as much detail as is currently available)
91+
can be found in the comments in [lfs.h](lfs.h).
92+
93+
As you may have noticed, littlefs takes in a configuration structure that
94+
defines how the filesystem operates. The configuration struct provides the
95+
filesystem with the block device operations and dimensions, tweakable
96+
parameters that tradeoff memory usage for performance, and optional
97+
static buffers if the user wants to avoid dynamic memory.
98+
99+
The state of the littlefs is stored in the `lfs_t` type which is left up
100+
to the user to allocate, allowing multiple filesystems to be in use
101+
simultaneously. With the `lfs_t` and configuration struct, a user can
102+
format a block device or mount the filesystem.
103+
104+
Once mounted, the littlefs provides a full set of POSIX-like file and
105+
directory functions, with the deviation that the allocation of filesystem
106+
structures must be provided by the user.
107+
108+
All POSIX operations, such as remove and rename, are atomic, even in event
109+
of power-loss. Additionally, no file updates are actually committed to the
110+
filesystem until sync or close is called on the file.
111+
112+
## Other notes
113+
114+
All littlefs have the potential to return a negative error code. The errors
115+
can be either one of those found in the `enum lfs_error` in [lfs.h](lfs.h),
116+
or an error returned by the user's block device operations.
117+
118+
In the configuration struct, the `prog` and `erase` function provided by the
119+
user may return a `LFS_ERR_CORRUPT` error if the implementation already can
120+
detect corrupt blocks. However, the wear leveling does not depend on the return
121+
code of these functions, instead all data is read back and checked for
122+
integrity.
123+
124+
If your storage caches writes, make sure that the provided `sync` function
125+
flushes all the data to memory and ensures that the next read fetches the data
126+
from memory, otherwise data integrity can not be guaranteed. If the `write`
127+
function does not perform caching, and therefore each `read` or `write` call
128+
hits the memory, the `sync` function can simply return 0.
129+
130+
## Reference material
131+
132+
[DESIGN.md](DESIGN.md) - DESIGN.md contains a fully detailed dive into how
133+
littlefs actually works. I would encourage you to read it since the
134+
solutions and tradeoffs at work here are quite interesting.
135+
136+
[SPEC.md](SPEC.md) - SPEC.md contains the on-disk specification of littlefs
137+
with all the nitty-gritty details. Can be useful for developing tooling.
138+
139+
## Testing
140+
141+
The littlefs comes with a test suite designed to run on a PC using the
142+
[emulated block device](emubd/lfs_emubd.h) found in the emubd directory.
143+
The tests assume a Linux environment and can be started with make:
144+
145+
``` bash
146+
make test
147+
```
148+
149+
## Related projects
150+
151+
[Mbed OS](https://github.com/ARMmbed/mbed-os/tree/master/features/filesystem/littlefs) -
152+
The easiest way to get started with littlefs is to jump into [Mbed](https://os.mbed.com/),
153+
which already has block device drivers for most forms of embedded storage. The
154+
littlefs is available in Mbed OS as the [LittleFileSystem](https://os.mbed.com/docs/latest/reference/littlefilesystem.html)
155+
class.
156+
157+
[littlefs-fuse](https://github.com/geky/littlefs-fuse) - A [FUSE](https://github.com/libfuse/libfuse)
158+
wrapper for littlefs. The project allows you to mount littlefs directly on a
159+
Linux machine. Can be useful for debugging littlefs if you have an SD card
160+
handy.
161+
162+
[littlefs-js](https://github.com/geky/littlefs-js) - A javascript wrapper for
163+
littlefs. I'm not sure why you would want this, but it is handy for demos.
164+
You can see it in action [here](http://littlefs.geky.net/demo.html).

0 commit comments

Comments
 (0)