Skip to content

Commit 58041a2

Browse files
committed
Deprecate config store and related libraries
Deprecate configuration-store, flash-journal and storage-volume-manager for the 5.5 release. Also disable the storage tests.
1 parent 88c398b commit 58041a2

File tree

6 files changed

+28
-0
lines changed

6 files changed

+28
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*

features/storage/FEATURE_STORAGE/cfstore/configuration-store/configuration_store.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ extern "C" {
8282
#include <stdint.h>
8383
#include <string.h> /* requierd for memset() in ARM_CFSTORE_HANDLE_INIT() */
8484

85+
#include "mbed_toolchain.h" /* required for MBED_DEPRECATED_SINCE */
86+
8587
#define DEVICE_STORAGE 1 /* enable storage */
8688
/// @cond CFSTORE_DOXYGEN_DISABLE
8789
#include <Driver_Storage.h>
@@ -873,6 +875,7 @@ typedef struct _ARM_DRIVER_CFSTORE
873875

874876

875877

878+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "CFSTORE replace by FATFileSystem.")
876879
extern ARM_CFSTORE_DRIVER cfstore_driver;
877880

878881
#ifdef __cplusplus

features/storage/FEATURE_STORAGE/flash-journal/flash_journal.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ extern "C" {
2323
#endif // __cplusplus
2424

2525
#include "storage_abstraction/Driver_Storage.h"
26+
#include "mbed_toolchain.h" /* required for MBED_DEPRECATED_SINCE */
2627

2728
/**
2829
* General return codes. All Flash-Journal APIs return an int32_t to allow for
@@ -288,6 +289,8 @@ typedef struct FlashJournal_t {
288289
* }
289290
* \endcode
290291
*/
292+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "FlashJournal is deprecated. "
293+
"Use a BlockDevice or filesystem instead")
291294
static inline int32_t FlashJournal_initialize(FlashJournal_t *journal,
292295
ARM_DRIVER_STORAGE *mtd,
293296
const FlashJournal_Ops_t *ops,
@@ -332,6 +335,8 @@ static inline int32_t FlashJournal_initialize(FlashJournal_t *journal,
332335
* }
333336
* \endcode
334337
*/
338+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "FlashJournal is deprecated. "
339+
"Use a BlockDevice or filesystem instead")
335340
static inline FlashJournal_Status_t FlashJournal_getInfo(FlashJournal_t *journal, FlashJournal_Info_t *info)
336341
{
337342
return journal->ops.getInfo(journal, info);
@@ -411,6 +416,8 @@ static inline FlashJournal_Status_t FlashJournal_getInfo(FlashJournal_t *journal
411416
* }
412417
* \endcode
413418
*/
419+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "FlashJournal is deprecated. "
420+
"Use a BlockDevice or filesystem instead")
414421
static inline int32_t FlashJournal_read(FlashJournal_t *journal, void *blob, size_t n)
415422
{
416423
return journal->ops.read(journal, blob, n);
@@ -493,6 +500,8 @@ static inline int32_t FlashJournal_read(FlashJournal_t *journal, void *blob, siz
493500
* }
494501
* \endcode
495502
*/
503+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "FlashJournal is deprecated. "
504+
"Use a BlockDevice or filesystem instead")
496505
static inline int32_t FlashJournal_readFrom(struct FlashJournal_t *journal, size_t offset, void *blob, size_t n)
497506
{
498507
return journal->ops.readFrom(journal, offset, blob, n);
@@ -605,6 +614,8 @@ static inline int32_t FlashJournal_readFrom(struct FlashJournal_t *journal, size
605614
* }
606615
* \endcode
607616
*/
617+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "FlashJournal is deprecated. "
618+
"Use a BlockDevice or filesystem instead")
608619
static inline int32_t FlashJournal_log(FlashJournal_t *journal, const void *blob, size_t n)
609620
{
610621
return journal->ops.log(journal, blob, n);
@@ -669,6 +680,8 @@ static inline int32_t FlashJournal_log(FlashJournal_t *journal, const void *blob
669680
* by an operation other than a commit, that operation will very likely
670681
* return an error code.
671682
*/
683+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "FlashJournal is deprecated. "
684+
"Use a BlockDevice or filesystem instead")
672685
static inline int32_t FlashJournal_commit(FlashJournal_t *journal)
673686
{
674687
return journal->ops.commit(journal);
@@ -728,6 +741,8 @@ static inline int32_t FlashJournal_commit(FlashJournal_t *journal)
728741
* }
729742
* \endcode
730743
*/
744+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "FlashJournal is deprecated. "
745+
"Use a BlockDevice or filesystem instead")
731746
static inline int32_t FlashJournal_reset(FlashJournal_t *journal)
732747
{
733748
return journal->ops.reset(journal);

features/storage/FEATURE_STORAGE/storage-volume-manager/storage-volume-manager/storage_volume_manager.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
#endif // __cplusplus
2424

2525
#include "storage_abstraction/Driver_Storage.h"
26+
#include "mbed_toolchain.h" /* required for MBED_DEPRECATED_SINCE */
2627

2728
#if !defined(YOTTA_CFG_STORAGE_VOLUME_MANAGER_MAX_VOLUMES)
2829
#define MAX_VOLUMES 4
@@ -88,6 +89,8 @@ class StorageVolumeManager; /* forward declaration */
8889

8990
class StorageVolume {
9091
public:
92+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "StorageVolume is deprecated. "
93+
"Use MBRBlockDevice for volumes instead")
9194
StorageVolume() : allocated(false) { /* empty */ }
9295

9396
public:
@@ -161,6 +164,8 @@ class StorageVolume {
161164

162165
class StorageVolumeManager {
163166
public:
167+
MBED_DEPRECATED_SINCE("mbed-os-5.5", "StorageVolumeManager is deprecated. "
168+
"Use MBRBlockDevice to manage volumes instead")
164169
StorageVolumeManager() { /* empty */ }
165170
~StorageVolumeManager() { /* empty */ }
166171

hal/storage_abstraction/Driver_Common.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
#include <stdint.h>
2626
#include <stdbool.h>
2727

28+
/****** This file has been deprecated since mbed-os-5.5 *****/
29+
2830
#define ARM_DRIVER_VERSION_MAJOR_MINOR(major,minor) (((major) << 8) | (minor))
2931

3032
/**

hal/storage_abstraction/Driver_Storage.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323

2424
#include <stdint.h>
2525

26+
/****** This file has been deprecated since mbed-os-5.5 *****/
27+
2628
#ifdef __cplusplus
2729
extern "C" {
2830
#endif // __cplusplus

0 commit comments

Comments
 (0)