From 906fe0dffc6f57fa0ef6813223ace2fb09af380d Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Mon, 11 Mar 2019 21:28:04 -0700 Subject: [PATCH] [spinel] add spinel definition guideline (#3663) --- src/ncp/spinel.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/ncp/spinel.h b/src/ncp/spinel.h index 8a4af9e5b..3c0404405 100644 --- a/src/ncp/spinel.h +++ b/src/ncp/spinel.h @@ -33,6 +33,17 @@ #ifndef SPINEL_HEADER_INCLUDED #define SPINEL_HEADER_INCLUDED 1 +/* + * Spinel definition guideline: + * + * New NCP firmware should work with an older host driver, i.e., NCP implementation should remain backward compatible. + * + * - Existing fields in the format of an already implemented spinel property or command cannot change. + * - New fields may be appended at the end of the format (or the end of a struct) as long as the NCP implementation + * treats the new fields as optional (i.e., a driver not aware of and therefore not using the new fields should + * continue to function as before). + */ + #ifdef SPINEL_PLATFORM_HEADER #include SPINEL_PLATFORM_HEADER #else // ifdef SPINEL_PLATFORM_HEADER