env: add a version number to check API
authorStefano Babic <sbabic@denx.de>
Wed, 5 Apr 2017 16:08:02 +0000 (18:08 +0200)
committerTom Rini <trini@konsulko.com>
Wed, 12 Apr 2017 17:28:29 +0000 (13:28 -0400)
Changes in the environment library are difficult to tracked by programs
using the library. Add simply an API version number that must be
increased each time when the API is changed.

This can be detected and a program can work with different versions of
the library.

Signed-off-by: Stefano Babic <sbabic@denx.de>
tools/env/fw_env.h

index 3e5539d7f3dcae328075d7ff22c0ae0e167c1db0..cf346b3bab559abd81d16edf270b4af9dec5e892 100644 (file)
@@ -8,6 +8,13 @@
 #include <stdint.h>
 #include <uboot_aes.h>
 
+/*
+ * Programs using the library must check which API is available,
+ * that varies depending on the U-Boot version.
+ * This can be changed in future
+ */
+#define FW_ENV_API_VERSION     1
+
 struct env_opts {
 #ifdef CONFIG_FILE
        char *config_file;
@@ -140,4 +147,12 @@ int fw_env_write(char *name, char *value);
  */
 int fw_env_close(struct env_opts *opts);
 
+/**
+ * fw_env_version - return the current version of the library
+ *
+ * Return:
+ *  version string of the library
+ */
+char *fw_env_version(void);
+
 unsigned long crc32(unsigned long, const unsigned char *, unsigned);