diff mbox

[U-Boot,v1,3/4] env: add a version number to check API

Message ID 1491408483-13228-4-git-send-email-sbabic@denx.de
State Accepted
Commit 00c234f38fccaa24b052691913cb3a7e8bc2b3a1
Delegated to: Tom Rini
Headers show

Commit Message

Stefano Babic April 5, 2017, 4:08 p.m. UTC
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 | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Tom Rini April 14, 2017, 9:09 p.m. UTC | #1
On Wed, Apr 05, 2017 at 06:08:02PM +0200, Stefano Babic wrote:

> 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>

Applied to u-boot/master, thanks!
diff mbox

Patch

diff --git a/tools/env/fw_env.h b/tools/env/fw_env.h
index 3e5539d..cf346b3 100644
--- a/tools/env/fw_env.h
+++ b/tools/env/fw_env.h
@@ -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);