app: Add build version to #XSMVER

Add Git describe string as the <build_version> parameter in
AT#XSMVER response.

Signed-off-by: Markus Lassila <markus.lassila@nordicsemi.no>

Author: MarkusLassila

app/src/sm_at_commands.c

@@ -75,12 +75,13 @@ STATIC int handle_at_smver(enum at_parser_cmd_type cmd_type, struct at_parser *,
 
 	if (cmd_type == AT_PARSER_CMD_TYPE_SET) {
 		if (strlen(CONFIG_SM_CUSTOMER_VERSION) > 0) {
-			rsp_send("\r\n#XSMVER: \"%s\",\"%s\",\"%s\"\r\n",
+			rsp_send("\r\n#XSMVER: \"%s\",\"%s\",\"%s\",\"%s\"\r\n",
 				 APP_VERSION_TWEAK_STRING, NCS_VERSION_STRING,
-				 CONFIG_SM_CUSTOMER_VERSION);
+				 CONFIG_SM_CUSTOMER_VERSION, STRINGIFY(APP_BUILD_VERSION));
 		} else {
-			rsp_send("\r\n#XSMVER: \"%s\",\"%s\"\r\n",
-				 APP_VERSION_TWEAK_STRING, NCS_VERSION_STRING);
+			rsp_send("\r\n#XSMVER: \"%s\",\"%s\",\"%s\"\r\n",
+				 APP_VERSION_TWEAK_STRING, NCS_VERSION_STRING,
+				 STRINGIFY(APP_BUILD_VERSION));
 		}
 		ret = 0;
 	}

doc/app/at_generic.rst

@@ -179,7 +179,7 @@ Response syntax
 
 ::
 
-   #XSMVER: "<sm_version>","<ncs_version>"[,"<customer_version>"]
+   #XSMVER: "<sm_version>","<ncs_version>"[,"<customer_version>"],"<build_version>"
 
 The ``<sm_version>`` parameter is the version of the |SM| application.
 It comes from :file:`app/VERSION` (``APP_VERSION_TWEAK_STRING``) and matches the MCUboot sign version.
@@ -189,6 +189,8 @@ The ``<ncs_version>`` parameter is a string containing the version of the |NCS|.
 
 The ``<customer_version>`` parameter is the :ref:`CONFIG_SM_CUSTOMER_VERSION <CONFIG_SM_CUSTOMER_VERSION>` string, if defined.
 
+The ``<build_version>`` parameter is the Git describe string from the application tree (``APP_BUILD_VERSION``).
+
 Example
 ~~~~~~~
 
@@ -198,22 +200,22 @@ The following command example reads the versions:
 
    // First shipped 2.0 pre-release
    AT#XSMVER
-   #XSMVER: "1.99.0+1","3.3.99"
+   #XSMVER: "1.99.0+1","3.3.99","v2.0.0-preview1-67-ga9e396bc3d58"
    OK
 
    // Next shipped pre-release
    AT#XSMVER
-   #XSMVER: "1.99.0+2","3.3.99"
+   #XSMVER: "1.99.0+2","3.3.99","v2.0.0-preview2-102-gace23a3d582"
    OK
 
    // 2.0.0 release
    AT#XSMVER
-   #XSMVER: "2.0.0+0","3.4.0"
+   #XSMVER: "2.0.0+0","3.4.0","v2.0.0"
    OK
 
    // Shipped pre-release with customer version
    AT#XSMVER
-   #XSMVER: "1.99.0+2","3.1.99","Onomondo 2.1.0"
+   #XSMVER: "1.99.0+1","3.3.99","Onomondo 2.1.0","v2.0.0-preview1-67-ga9e396bc3d58"
    OK
 
 Read command

doc/app/sm_releasing.rst

@@ -9,7 +9,7 @@ Each published image must carry a higher value than the previous one on the same
 Application — :file:`app/VERSION`
 =================================
 
-Sets ``AT#XSMVER`` and the MCUboot application sign version (``CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION``), which is used for application downgrade prevention.
+Sets the ``<sm_version>`` field in ``AT#XSMVER`` and the MCUboot application sign version (``CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION``), which is used for application downgrade prevention.
 Format: ``major.minor.patchlevel+VERSION_TWEAK``. See `Zephyr application VERSION`_.
 
 Pre-releases
@@ -25,6 +25,10 @@ Example for 2.0.0 GA — line ``1.99.0``, images ``1.99.0+1``, ``1.99.0+2``, …
    PATCHLEVEL = 0
    VERSION_TWEAK = 1
 
+.. note::
+
+  The ``VERSION_TWEAK`` is not taken into account for downgrade prevention, so pre-release images which differ only in ``VERSION_TWEAK`` are interchangeable in terms of downgrade prevention.
+
 General Availability (GA)
 -------------------------
 

doc/app/sm_testing.rst

@@ -26,7 +26,7 @@ Complete the following steps to test the functionality provided by the :ref:`SM_
       :class: highlight
 
       **AT#XSMVER**
-      #XSMVER: "1.99.0+0","3.1.99"
+      #XSMVER: "1.99.0+0","3.3.99","v2.0.0-preview1-67-ga9e396bc3d58"
       OK
 
 #. Retrieve a list of all supported proprietary AT commands.

doc/releases/migration_notes_v2.0.0.rst

@@ -28,9 +28,11 @@ Informational changes
 
 The following changes are listed for informational purposes, and many hosts will work without any changes.
 
-* ``AT#XSMVER`` response format — In v1.x.x, the first field was a Git describe string (for example ``"v1.0.0"`` or ``"v1.0.0-3-g1a2b3c4"``).
-  From v2.0.0, it is the numeric version from :file:`app/VERSION` in the form ``"major.minor.patch+tweak"`` (for example ``"2.0.0+0"``).
+* ``AT#XSMVER`` response format — In v1.x.x, the first field (``<sm_version>``) was a Git describe string (for example ``"v1.0.0"`` or ``"v1.0.0-3-g1a2b3c4"``).
+  From v2.0.0, the first field  is the numeric version from :file:`app/VERSION` in the form ``"major.minor.patch+tweak"`` (for example ``"2.0.0+0"``).
   It is aligned with the MCUboot application sign version which is used for application rollback prevention.
+  A Git describe string is appended as the last field (``<build_version>``).
+  See :ref:`sm_releasing` for how to set :file:`app/VERSION`.
 
 * Ring Indication (RI) - Change RI from pulse (100 ms) to level triggered, meaning RI stays asserted until the host asserts DTR.
   After the Serial Modem has enabled UART, RI will be deasserted.