Upload mqtt 4.0.0.1482 [999]

RELEASE.md

@@ -4,34 +4,56 @@
 
 See the [README.md](./README.md) for a complete description of the MQTT client library.
 
+
 ## Known issues
+
 | Problem | Workaround |
 | ------- | ---------- |
-| IAR 9.30 toolchain throws build errors on Debug mode, if application explicitly includes iar_dlmalloc.h file | Add '--advance-heap' to LDFLAGS in application Makefile. |
+| IAR 9.30 toolchain throws build errors on Debug mode if the application explicitly includes the *iar_dlmalloc.h* file | Add `--advance-heap` to LDFLAGS in the application Makefile. |
 
 ## Changelog
 
+### v4.0.0
+
+- Updated FreeRTOS-specific code to make it generic
+- Added new APIs and updated signature of some of the old APIs to support multicore virtualization
+- Enabled multi-core, virtual API support for the following MQTT APIs:
+ - `cy_mqtt_get_handle`
+ - `cy_mqtt_register_event_callback`
+ - `cy_mqtt_deregister_event_callback`
+ - `cy_mqtt_publish`
+ - `cy_mqtt_subscribe`
+ - `cy_mqtt_unsubscribe`
+- Updated documentation
+
+This version of the library is not backward-compatible with pervious library versions.
+
+
 ### v3.4.2
 
 - Removed unwanted dependencies from the deps folder
 - Added support for CM0P core
-- Minor Documentation updates
+- Minor documentation updates
+
 
 ### v3.4.1
 
-- Documentation update
+- Documentation updates
+
 
 ### v3.4.0
 
 - Added support for CY8CEVAL-062S2-MUR-43439M2 kit
 
+
 ### v3.3.0
 
 - Added support for CYW943907AEVAL1F and CYW954907AEVAL1F kits
 
+
 ### v3.2.0
 
-- Added support for secured kit (for example: CY8CKIT-064S0S2-4343W)
+- Added support for secured kits (for example: CY8CKIT-064S0S2-4343W)
 
 - Integrated with secure sockets PKCS support
 
@@ -45,9 +67,9 @@ See the [README.md](./README.md) for a complete description of the MQTT client l
 ### v3.1.1
 - Documentation updates
 
-- Upgraded the library to integrate the with wifi-mw-core 3.x library version for AnyCloud
+- Upgraded the library to integrate the with wifi-mw-core 3.x library version for any cloud
 
-- Introduced ARMC6 compiler support for AnyCloud build
+- Introduced ARMC6 compiler support for any cloud build
 
 
 ### v3.1.0
@@ -76,7 +98,7 @@ See the [README.md](./README.md) for a complete description of the MQTT client l
 
 ### v2.0.0
 
-- Changes to adapt to ModusToolbox™ 2.2.0 flow and AnyCloud's support for multiple Wi-Fi interfaces - STA, softAP, and concurrent STA+softAP mode
+- Changes to adapt to ModusToolbox™ 2.2.0 flow and any cloud's support for multiple Wi-Fi interfaces - STA, softAP, and concurrent STA+softAP mode
 
 
 ### v1.0.1

docs/api_reference_manual/html/group__mqtt__api__functions.js

@@ -2,10 +2,13 @@ var group__mqtt__api__functions =
 [
  [ "cy_mqtt_callback_t", "group__mqtt__api__functions.html#ga127e0c74fd6f6025f4866d581256df96", null ],
  [ "cy_mqtt_init", "group__mqtt__api__functions.html#ga5386e4d0061fd77c3f68ba29553b3414", null ],
- [ "cy_mqtt_create", "group__mqtt__api__functions.html#ga6637e2df9ebc12dfb98841fc38c88ce9", null ],
+ [ "cy_mqtt_create", "group__mqtt__api__functions.html#gad4f1eac224ba410c02ea0cdf578925bf", null ],
  [ "cy_mqtt_connect", "group__mqtt__api__functions.html#ga2ffecf6ed7940d97c2c6fbc83783417b", null ],
+ [ "cy_mqtt_get_handle", "group__mqtt__api__functions.html#gaf2d7978d33447f0a8487aba62e0d2c51", null ],
  [ "cy_mqtt_publish", "group__mqtt__api__functions.html#ga2b565253902a622a2c275c61ef1fd84f", null ],
  [ "cy_mqtt_subscribe", "group__mqtt__api__functions.html#gac9e1748d2425be6923069fa6f7125fb5", null ],
+ [ "cy_mqtt_register_event_callback", "group__mqtt__api__functions.html#gac621b7231a64b4c251d66b7c931d754b", null ],
+ [ "cy_mqtt_deregister_event_callback", "group__mqtt__api__functions.html#ga113a34e6cf7f98b39891e9d751831d97", null ],
  [ "cy_mqtt_unsubscribe", "group__mqtt__api__functions.html#ga5bf4f13c41463bd239f2940a02401121", null ],
  [ "cy_mqtt_disconnect", "group__mqtt__api__functions.html#gab7be772e82d3f8a80e1cbb1da156be17", null ],
  [ "cy_mqtt_delete", "group__mqtt__api__functions.html#gacdd40da0ad0e6bfb55fbf14c2aca0577", null ],

docs/api_reference_manual/html/group__mqtt__defines.html

@@ -104,7 +104,7 @@
 
 See the macro section of this document for library-specific error codes.
 </pre><p >The data structure cy_rslt_t is part of cy_result.h. In Mbed OS, the PSoC 6 MCU target platform is located in &lt;mbed-os/targets/TARGET_Cypress/TARGET_PSOC6/psoc6csp/core_lib/include&gt;. In ModusToolbox environment, PSoC 6 MCU target platform is located in &lt;core_lib/include&gt;.</p>
-<p >Module base: This base is derived from CY_RSLT_MODULE_MIDDLEWARE_BASE (defined in cy_result.h) and is an offset of CY_RSLT_MODULE_MIDDLEWARE_BASE. Details of the offset and the middleware base are defined in cy_result_mw.h, which is part of <a href="https:/cypresssemiconductorco/connectivity-utilities">Github connectivity-utilities</a>.</p>
+<p >Module base: This base is derived from CY_RSLT_MODULE_MIDDLEWARE_BASE (defined in cy_result.h) and is an offset of CY_RSLT_MODULE_MIDDLEWARE_BASE. Details of the offset and the middleware base are defined in cy_result_mw.h, which is part of <a href="https:/Infineon/connectivity-utilities">Github connectivity-utilities</a>.</p>
 <p >Type: This type is defined in cy_result.h and can be one of CY_RSLT_TYPE_FATAL, CY_RSLT_TYPE_ERROR, CY_RSLT_TYPE_WARNING, or CY_RSLT_TYPE_INFO. MQTT library error codes are of type CY_RSLT_TYPE_ERROR which is 0x2.</p>
 <p >Library-specific error codes: These error codes are library-specific and defined in the macro section.</p>
 <p >Helper macros used for creating library-specific results are provided as part of cy_result.h.</p>
@@ -144,10 +144,10 @@
 #define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_DELETE_FAIL</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 7 )</td></tr>
 <tr class="memdesc:ga6055d6f4a5ecb44cdd5e8b1ab7276e5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT library Delete failure. <br /></td></tr>
 <tr class="separator:ga6055d6f4a5ecb44cdd5e8b1ab7276e5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gaeb26fc6b7ea6b945bfcead259bfb657e"><td class="memItemLeft" align="right" valign="top"><a id="gaeb26fc6b7ea6b945bfcead259bfb657e" name="gaeb26fc6b7ea6b945bfcead259bfb657e"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_OBJ_NOT_INITIALIZED</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 8 )</td></tr>
-<tr class="memdesc:gaeb26fc6b7ea6b945bfcead259bfb657e"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT object not initialized failure. <br /></td></tr>
-<tr class="separator:gaeb26fc6b7ea6b945bfcead259bfb657e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga8623258e998c680750feee55e9cb61b3"><td class="memItemLeft" align="right" valign="top"><a id="ga8623258e998c680750feee55e9cb61b3" name="ga8623258e998c680750feee55e9cb61b3"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_INVALID_HANDLE</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 8 )</td></tr>
+<tr class="memdesc:ga8623258e998c680750feee55e9cb61b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid MQTT handle. <br /></td></tr>
+<tr class="separator:ga8623258e998c680750feee55e9cb61b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga35bf3a60d03dcdb67b8a7d1a34d04e89"><td class="memItemLeft" align="right" valign="top"><a id="ga35bf3a60d03dcdb67b8a7d1a34d04e89" name="ga35bf3a60d03dcdb67b8a7d1a34d04e89"></a>
 #define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_CONNECT_FAIL</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 9 )</td></tr>
 <tr class="memdesc:ga35bf3a60d03dcdb67b8a7d1a34d04e89"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT library Connect failure. <br /></td></tr>
@@ -192,6 +192,18 @@
 #define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_HANDSHAKE_FAILED</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 19 )</td></tr>
 <tr class="memdesc:ga942f5d32db669e7db58068d658e5ca68"><td class="mdescLeft">&#160;</td><td class="mdescRight">TLS handshake failed. <br /></td></tr>
 <tr class="separator:ga942f5d32db669e7db58068d658e5ca68"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga1244fc08713b0c35012c3b9b2dbeb864"><td class="memItemLeft" align="right" valign="top"><a id="ga1244fc08713b0c35012c3b9b2dbeb864" name="ga1244fc08713b0c35012c3b9b2dbeb864"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_HANDLE_NOT_FOUND</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 20 )</td></tr>
+<tr class="memdesc:ga1244fc08713b0c35012c3b9b2dbeb864"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT library handle not found. <br /></td></tr>
+<tr class="separator:ga1244fc08713b0c35012c3b9b2dbeb864"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaa9204df02d616c302ced4f6e004c347e"><td class="memItemLeft" align="right" valign="top"><a id="gaa9204df02d616c302ced4f6e004c347e" name="gaa9204df02d616c302ced4f6e004c347e"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_VCM_ERROR</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 21 )</td></tr>
+<tr class="memdesc:gaa9204df02d616c302ced4f6e004c347e"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT virtual API failure due to VCM error. <br /></td></tr>
+<tr class="separator:gaa9204df02d616c302ced4f6e004c347e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga2fac53ccad6a41107796bb1c2c4cfdf9"><td class="memItemLeft" align="right" valign="top"><a id="ga2fac53ccad6a41107796bb1c2c4cfdf9" name="ga2fac53ccad6a41107796bb1c2c4cfdf9"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_RSLT_MODULE_MQTT_NOT_INITIALIZED</b>&#160;&#160;&#160;( <a class="el" href="group__mqtt__defines.html#ga6466ed92857c93aa0aca275c3d5c65c2">CY_RSLT_MQTT_ERR_BASE</a> + 22 )</td></tr>
+<tr class="memdesc:ga2fac53ccad6a41107796bb1c2c4cfdf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT library not initialized. <br /></td></tr>
+<tr class="separator:ga2fac53ccad6a41107796bb1c2c4cfdf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga7f0d2ff66197d6152c70d692d4c87216"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mqtt__defines.html#ga7f0d2ff66197d6152c70d692d4c87216">CY_MQTT_EVENT_TYPE_PUBLISH_RECEIVE</a>&#160;&#160;&#160;<a class="el" href="group__mqtt__struct.html#gga1cefedb516ade340c9a829ec7b998fbaac017ae74a362a60128e4bc0482a085de">CY_MQTT_EVENT_TYPE_SUBSCRIPTION_MESSAGE_RECEIVE</a></td></tr>
 <tr class="memdesc:ga7f0d2ff66197d6152c70d692d4c87216"><td class="mdescLeft">&#160;</td><td class="mdescRight">MQTT event type for subscribed message receive event. <a href="group__mqtt__defines.html#ga7f0d2ff66197d6152c70d692d4c87216">More...</a><br /></td></tr>
 <tr class="separator:ga7f0d2ff66197d6152c70d692d4c87216"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -222,6 +234,14 @@
 #define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_MQTT_MAX_OUTGOING_SUBSCRIBES</b>&#160;&#160;&#160;( 5U )</td></tr>
 <tr class="memdesc:gacce957bd0962c40b85a0a53124f9a7f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure value of maximum number of outgoing subscription topics maintained in MQTT library until an ack is received from the broker. <br /></td></tr>
 <tr class="separator:gacce957bd0962c40b85a0a53124f9a7f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga335009dcf9f7b814b3596387af7ea0c2"><td class="memItemLeft" align="right" valign="top"><a id="ga335009dcf9f7b814b3596387af7ea0c2" name="ga335009dcf9f7b814b3596387af7ea0c2"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_MQTT_DESCP_MAX_LEN</b>&#160;&#160;&#160;( 20 )</td></tr>
+<tr class="memdesc:ga335009dcf9f7b814b3596387af7ea0c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum length of descriptor supported. <br /></td></tr>
+<tr class="separator:ga335009dcf9f7b814b3596387af7ea0c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7b4847a5bffe86eda959c1223e0c84db"><td class="memItemLeft" align="right" valign="top"><a id="ga7b4847a5bffe86eda959c1223e0c84db" name="ga7b4847a5bffe86eda959c1223e0c84db"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>CY_MQTT_EVENT_THREAD_STACK_SIZE</b>&#160;&#160;&#160;( 1024 * 3 )</td></tr>
+<tr class="memdesc:ga7b4847a5bffe86eda959c1223e0c84db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stack size for MQTT Event processing thread. <br /></td></tr>
+<tr class="separator:ga7b4847a5bffe86eda959c1223e0c84db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Macro Definition Documentation</h2>
 <a id="ga7f0d2ff66197d6152c70d692d4c87216" name="ga7f0d2ff66197d6152c70d692d4c87216"></a>

docs/api_reference_manual/html/group__mqtt__defines.js

@@ -8,7 +8,7 @@ var group__mqtt__defines =
  [ "CY_RSLT_MODULE_MQTT_DEINIT_FAIL", "group__mqtt__defines.html#ga1780bbae147be5f9357556499d004be4", null ],
  [ "CY_RSLT_MODULE_MQTT_CREATE_FAIL", "group__mqtt__defines.html#ga060854e20fc06a84e4f5991224c3dc6e", null ],
  [ "CY_RSLT_MODULE_MQTT_DELETE_FAIL", "group__mqtt__defines.html#ga6055d6f4a5ecb44cdd5e8b1ab7276e5b", null ],
- [ "CY_RSLT_MODULE_MQTT_OBJ_NOT_INITIALIZED", "group__mqtt__defines.html#gaeb26fc6b7ea6b945bfcead259bfb657e", null ],
+ [ "CY_RSLT_MODULE_MQTT_INVALID_HANDLE", "group__mqtt__defines.html#ga8623258e998c680750feee55e9cb61b3", null ],
  [ "CY_RSLT_MODULE_MQTT_CONNECT_FAIL", "group__mqtt__defines.html#ga35bf3a60d03dcdb67b8a7d1a34d04e89", null ],
  [ "CY_RSLT_MODULE_MQTT_DISCONNECT_FAIL", "group__mqtt__defines.html#ga17d9701defa7a206f5009c2dc1b14c2d", null ],
  [ "CY_RSLT_MODULE_MQTT_PUBLISH_FAIL", "group__mqtt__defines.html#ga35b3dae15cf819b309003d85a4d0f1a0", null ],
@@ -20,6 +20,9 @@ var group__mqtt__defines =
  [ "CY_RSLT_MODULE_MQTT_PROTOCOL_NOT_SUPPORTED", "group__mqtt__defines.html#ga6bc561976bd19b7e32a9a9ce31ba41ed", null ],
  [ "CY_RSLT_MODULE_MQTT_INVALID_CREDENTIALS", "group__mqtt__defines.html#ga776346921fe160011df453dca9a94550", null ],
  [ "CY_RSLT_MODULE_MQTT_HANDSHAKE_FAILED", "group__mqtt__defines.html#ga942f5d32db669e7db58068d658e5ca68", null ],
+ [ "CY_RSLT_MODULE_MQTT_HANDLE_NOT_FOUND", "group__mqtt__defines.html#ga1244fc08713b0c35012c3b9b2dbeb864", null ],
+ [ "CY_RSLT_MODULE_MQTT_VCM_ERROR", "group__mqtt__defines.html#gaa9204df02d616c302ced4f6e004c347e", null ],
+ [ "CY_RSLT_MODULE_MQTT_NOT_INITIALIZED", "group__mqtt__defines.html#ga2fac53ccad6a41107796bb1c2c4cfdf9", null ],
  [ "CY_MQTT_EVENT_TYPE_PUBLISH_RECEIVE", "group__mqtt__defines.html#ga7f0d2ff66197d6152c70d692d4c87216", null ],
  [ "CY_MQTT_MIN_NETWORK_BUFFER_SIZE", "group__mqtt__defines.html#ga18d0c836b0120b44ea0066d20a741d81", null ],
  [ "CY_MQTT_ACK_RECEIVE_TIMEOUT_MS", "group__mqtt__defines.html#ga7840d8ac595e18a481833643bafdb21b", null ],
@@ -28,5 +31,7 @@ var group__mqtt__defines =
  [ "CY_MQTT_MAX_RETRY_VALUE", "group__mqtt__defines.html#gaa2cdd709ec4d91cb8f8522b606ce82c9", null ],
  [ "CY_MQTT_MAX_HANDLE", "group__mqtt__defines.html#ga2740e7ac82d5f4e6227c31e780cb5eea", null ],
  [ "CY_MQTT_MAX_OUTGOING_PUBLISHES", "group__mqtt__defines.html#gab7e064d14b782a9509cddcb4c909784c", null ],
- [ "CY_MQTT_MAX_OUTGOING_SUBSCRIBES", "group__mqtt__defines.html#gacce957bd0962c40b85a0a53124f9a7f4", null ]
+ [ "CY_MQTT_MAX_OUTGOING_SUBSCRIBES", "group__mqtt__defines.html#gacce957bd0962c40b85a0a53124f9a7f4", null ],
+ [ "CY_MQTT_DESCP_MAX_LEN", "group__mqtt__defines.html#ga335009dcf9f7b814b3596387af7ea0c2", null ],
+ [ "CY_MQTT_EVENT_THREAD_STACK_SIZE", "group__mqtt__defines.html#ga7b4847a5bffe86eda959c1223e0c84db", null ]
 ];