ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#define _wear_levelling_H_
#include "esp_log.h"
#include "esp_partition.h"
wl_handle_t
#define WL_INVALID_HANDLE
wl_mount(const esp_partition_t *, wl_handle_t *);
wl_unmount(wl_handle_t);
wl_erase_range(wl_handle_t, size_t, size_t);
wl_write(wl_handle_t, size_t, const void *, size_t);
wl_read(wl_handle_t, size_t, void *, size_t);
wl_size(wl_handle_t);
wl_sector_size(wl_handle_t);
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/wear_levelling/include/wear_levelling.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #ifndef _wear_levelling_H_ #define _wear_levelling_H_ #include "esp_log.h" #include "esp_partition.h" #ifdef __cplusplus extern "C" { #endif /** * @brief wear levelling handle *//* ... */ typedef int32_t wl_handle_t; #define WL_INVALID_HANDLE -1 /** * @brief Mount WL for defined partition * * @param partition that will be used for access * @param out_handle handle of the WL instance * * @return * - ESP_OK, if the WL allocation is successful; * - ESP_ERR_INVALID_ARG, if the arguments for WL configuration are not valid; * - ESP_ERR_NO_MEM, if the WL allocation fails because of insufficient memory; *//* ... */ esp_err_t wl_mount(const esp_partition_t *partition, wl_handle_t *out_handle); /** * @brief Unmount WL for defined partition * * @param handle WL partition handle * * @return * - ESP_OK, if the operation is successful; * - or one of error codes from lower-level flash driver. *//* ... */ esp_err_t wl_unmount(wl_handle_t handle); /** * @brief Erase part of the WL storage * * @param handle WL handle that are related to the partition * @param start_addr Address from where erase operation should start. Must be aligned * to the result of function wl_sector_size(...). * @param size Size of the range which should be erased, in bytes. * Must be divisible by the result of function wl_sector_size(...).. * * @return * - ESP_OK, if the given range was erased successfully; * - ESP_ERR_INVALID_ARG, if iterator or dst are NULL; * - ESP_ERR_INVALID_SIZE, if erase would go out of bounds of the partition; * - or one of error codes from lower-level flash driver. *//* ... */ esp_err_t wl_erase_range(wl_handle_t handle, size_t start_addr, size_t size); /** * @brief Write data to the WL storage * * Before writing data to flash, corresponding region of flash needs to be erased. * This can be done using wl_erase_range function. * * @param handle WL handle corresponding to the WL partition * @param dest_addr Address where the data should be written, relative to the * beginning of the partition. * @param src Pointer to the source buffer. Pointer must be non-NULL and * buffer must be at least 'size' bytes long. * @param size Size of data to be written, in bytes. * * @note Prior to writing to WL storage, make sure it has been erased with * wl_erase_range call. * * @return * - ESP_OK, if data was written successfully; * - ESP_ERR_INVALID_ARG, if dst_offset exceeds partition size; * - ESP_ERR_INVALID_SIZE, if write would go out of bounds of the partition; * - or one of error codes from lower-level flash driver. *//* ... */ esp_err_t wl_write(wl_handle_t handle, size_t dest_addr, const void *src, size_t size); /** * @brief Read data from the WL storage * * @param handle WL module instance that was initialized before * @param dest Pointer to the buffer where data should be stored. * The Pointer must be non-NULL and the buffer must be at least 'size' bytes long. * @param src_addr Address of the data to be read, relative to the * beginning of the partition. * @param size Size of data to be read, in bytes. * * @return * - ESP_OK, if data was read successfully; * - ESP_ERR_INVALID_ARG, if src_offset exceeds partition size; * - ESP_ERR_INVALID_SIZE, if read would go out of bounds of the partition; * - or one of error codes from lower-level flash driver. *//* ... */ esp_err_t wl_read(wl_handle_t handle, size_t src_addr, void *dest, size_t size); /** * @brief Get the actual flash size in use for the WL storage partition * * @param handle WL module handle that was initialized before * @return usable size, in bytes *//* ... */ size_t wl_size(wl_handle_t handle); /** * @brief Get sector size of the WL instance * * @param handle WL module handle that was initialized before * @return sector size, in bytes *//* ... */ size_t wl_sector_size(wl_handle_t handle); #ifdef __cplusplus }{...} // extern "C" #endif /* ... */ #endif // _wear_levelling_H_
Details
Show:
from
Types: Columns: