LG-83 CDD API support for listing optional endpoints

Author: sgunes-wirepas

lib/api/wpc.h

@@ -960,6 +960,21 @@ app_res_e WPC_get_config_data_item(const uint16_t endpoint,
                                    const size_t payload_capacity,
                                    uint8_t *const size);
 
+/**
+ * \brief   Get a list of endpoints of existing optional config data items
+ * \param   endpoints
+ *          Pointer to read config data item endpoints into
+ * \param   endpoints_capacity
+ *          Allocated size of the given endpoints buffer (bytes). If received
+ *          endpoints list is larger, the function fails.
+ * \param   endpoints_count
+ *          Number of endpoints written to the given endpoints buffer
+ * \return  Return code of the operation
+ */
+app_res_e WPC_get_config_data_item_list(uint16_t *const endpoints,
+                                        const size_t endpoints_capacity,
+                                        uint8_t *const endpoints_count);
+
 /**
  * \brief   Callback definition to register for received data
  * \param   bytes

lib/wpc/include/msap.h

@@ -211,6 +211,18 @@ typedef struct __attribute__((__packed__))
     uint8_t payload[MAXIMUM_CDC_ITEM_PAYLOAD_SIZE];
 } msap_config_data_item_get_conf_pl_t;
 
+typedef struct __attribute__((__packed__))
+{
+    uint8_t command;
+} msap_config_data_item_list_items_req_pl_t;
+
+typedef struct __attribute__((__packed__))
+{
+    uint8_t result;
+    uint8_t amount_endpoints;
+    uint8_t endpoints_list[MAXIMUM_CDC_ITEM_LIST_BYTE_COUNT];
+} msap_config_data_item_list_items_conf_pl_t;
+
 typedef struct __attribute__((__packed__))
 {
     uint8_t indication_status;
@@ -509,6 +521,18 @@ int msap_config_data_item_get_request(const uint16_t endpoint,
                                       const size_t payload_capacity,
                                       uint8_t *const payload_size);
 
+/**
+ * \brief    Request to get config data item list
+ * \param    command
+ *           Reserved for future use. Currently only value 0 is used.
+ * \param    response
+ *           Pointer to the read response.
+ * \return   Negative value upon internal error, otherwise result code returned
+ *           by the DualMCU API
+ */
+int msap_config_data_item_list_items_request(const uint8_t command,
+                                             msap_config_data_item_list_items_conf_pl_t *const response);
+
 /**
  * \brief   Handler for stack state indication
  * \param   payload

lib/wpc/include/wpc_constants.h

@@ -92,6 +92,8 @@
 #define MSAP_CONFIG_DATA_ITEM_GET_CONFIRM      (SAP_CONFIRM_OFFSET + MSAP_CONFIG_DATA_ITEM_GET_REQUEST)
 #define MSAP_CONFIG_DATA_ITEM_RX_INDICATION    0x31
 #define MSAP_CONFIG_DATA_ITEM_RX_RESPONSE      (SAP_RESPONSE_OFFSET + MSAP_CONFIG_DATA_ITEM_RX_INDICATION)
+#define MSAP_CONFIG_DATA_ITEM_LIST_ITEMS_REQUEST 0x32
+#define MSAP_CONFIG_DATA_ITEM_LIST_ITEMS_CONFIRM (SAP_RESPONSE_OFFSET + MSAP_CONFIG_DATA_ITEM_LIST_ITEMS_REQUEST)
 
 /*
  * Configuration Service Access Points

lib/wpc/include/wpc_types.h

@@ -67,6 +67,7 @@ typedef struct __attribute__((__packed__))
         msap_image_block_read_req_pl_t msap_image_block_read_request_payload;
         msap_config_data_item_set_req_pl_t msap_config_data_item_set_request_payload;
         msap_config_data_item_get_req_pl_t msap_config_data_item_get_request_payload;
+        msap_config_data_item_list_items_req_pl_t msap_config_data_item_list_items_request_payload;
         // Indication
         dsap_data_tx_ind_pl_t dsap_data_tx_indication_payload;
         dsap_data_rx_ind_pl_t dsap_data_rx_indication_payload;
@@ -88,6 +89,7 @@ typedef struct __attribute__((__packed__))
         msap_scratchpad_target_read_conf_pl_t msap_scratchpad_target_read_confirm_payload;
         msap_image_block_read_conf_pl_t msap_image_block_read_confirm_payload;
         msap_config_data_item_get_conf_pl_t msap_config_data_item_get_confirm_payload;
+        msap_config_data_item_list_items_conf_pl_t msap_config_data_item_list_items_confirm_payload;
         // Response
         sap_resp_pl_t sap_response_payload;
     } payload;

lib/wpc/msap.c

@@ -532,6 +532,36 @@ int msap_config_data_item_get_request(const uint16_t endpoint,
     return confirm.payload.sap_generic_confirm_payload.result;
 }
 
+int msap_config_data_item_list_items_request(const uint8_t command,
+                                             msap_config_data_item_list_items_conf_pl_t *const response)
+{
+    wpc_frame_t request = {
+        .primitive_id = MSAP_CONFIG_DATA_ITEM_LIST_ITEMS_REQUEST,
+        .payload_length = sizeof(msap_config_data_item_list_items_req_pl_t),
+        .payload = {
+            .msap_config_data_item_list_items_request_payload = {
+                .command = command
+            }
+        }
+    };
+
+    wpc_frame_t confirm;
+    const int res = WPC_Int_send_request(&request, &confirm);
+    if (res < 0)
+    {
+        return res;
+    }
+
+    if (confirm.payload.sap_generic_confirm_payload.result == 0)
+    {
+        memcpy(response,
+               &confirm.payload.msap_config_data_item_list_items_confirm_payload,
+               sizeof(msap_config_data_item_list_items_conf_pl_t));
+    }
+
+    return confirm.payload.sap_generic_confirm_payload.result;
+}
+
 void msap_stack_state_indication_handler(msap_stack_state_ind_pl_t * payload)
 {
     LOGI("Status is 0x%02x\n", payload->status);

lib/wpc/wpc.c

@@ -1218,6 +1218,46 @@ app_res_e WPC_get_config_data_item(const uint16_t endpoint,
     return convert_error_code(CDC_ITEM_GET_ERROR_CODE_LUT, res);
 }
 
+static const app_res_e CDC_GET_ITEM_LIST_ERROR_CODE_LUT[] = {
+    APP_RES_OK, // 0
+};
+
+app_res_e WPC_get_config_data_item_list(uint16_t *const endpoints,
+                                        const size_t endpoints_capacity,
+                                        uint8_t *const endpoints_count)
+{
+    msap_config_data_item_list_items_conf_pl_t response = { 0 };
+    const int msap_res = msap_config_data_item_list_items_request(0, &response);
+    if (msap_res < 0)
+    {
+        LOGE("Error getting config data item list: %d\n", msap_res);
+        return APP_RES_INTERNAL_ERROR;
+    }
+
+    const app_res_e res = convert_error_code(CDC_GET_ITEM_LIST_ERROR_CODE_LUT, msap_res);
+    if (res == APP_RES_OK)
+    {
+        if (response.amount_endpoints * 2 > endpoints_capacity)
+        {
+            LOGE("Endpoints list buffer size is too small: %d\n", endpoints_capacity);
+            return APP_RES_INTERNAL_ERROR;
+        }
+        if (response.amount_endpoints * 2 > sizeof(response.endpoints_list))
+        {
+            LOGE("Invalid amount of endpoints received: %d\n", response.amount_endpoints);
+            return APP_RES_INTERNAL_ERROR;
+        }
+
+        _Static_assert(__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__, "");
+        memcpy(endpoints,
+               &response.endpoints_list,
+               response.amount_endpoints * 2);
+        *endpoints_count = response.amount_endpoints;
+    }
+
+    return res;
+}
+
 #ifdef REGISTER_DATA_PER_ENDPOINT
 app_res_e WPC_register_for_data(uint8_t dst_ep, onDataReceived_cb_f onDataReceived)
 {

test/cdd_tests.cpp

@@ -313,3 +313,43 @@ TEST_F(WpcCddApiTest, settingTooManyOptionalItemsShouldFail)
     ASSERT_GT(detected_max_item_count, 0);
 }
 
+TEST_F(WpcCddApiTest, gettingEndpointsListShouldFailIfBufferIsTooSmall)
+{
+    const uint8_t TEST_PAYLOAD[] = { 0x10 };
+    ASSERT_EQ(APP_RES_OK, WPC_set_config_data_item(100, TEST_PAYLOAD, sizeof(TEST_PAYLOAD)));
+    ASSERT_EQ(APP_RES_OK, WPC_set_config_data_item(200, TEST_PAYLOAD, sizeof(TEST_PAYLOAD)));
+
+    uint16_t endpoints_list[1] = { 0 };
+    uint8_t endpoints_count = 0xFF;
+    ASSERT_EQ(APP_RES_INTERNAL_ERROR,
+              WPC_get_config_data_item_list(endpoints_list, sizeof(endpoints_list), &endpoints_count));
+}
+
+TEST_F(WpcCddApiTest, shouldReturnEmptyListIfNoOptionalItemIsSet)
+{
+    uint16_t endpoints_list[10] = { 0 };
+    uint8_t endpoints_count = 0xFF;
+    ASSERT_EQ(APP_RES_OK,
+              WPC_get_config_data_item_list(endpoints_list, sizeof(endpoints_list), &endpoints_count));
+    ASSERT_EQ(0, endpoints_count);
+}
+
+TEST_F(WpcCddApiTest, gettingListOfOptionalEndpointsShouldWork)
+{
+    const std::set<uint16_t> endpoints = { 0xAABB, 0x1234, 0xD0B0 };
+    for (const auto& endpoint : endpoints) {
+        const uint8_t TEST_PAYLOAD[] = { 0x10 };
+        ASSERT_EQ(APP_RES_OK, WPC_set_config_data_item(endpoint, TEST_PAYLOAD, sizeof(TEST_PAYLOAD)));
+    }
+
+    uint16_t endpoints_list[3] = { 0 };
+    uint8_t endpoints_count = 0xFF;
+    ASSERT_EQ(APP_RES_OK,
+              WPC_get_config_data_item_list(endpoints_list, sizeof(endpoints_list), &endpoints_count));
+
+    ASSERT_EQ(endpoints.size(), endpoints_count);
+    for (uint8_t i = 0; i < endpoints_count; i++){
+        ASSERT_EQ(1, endpoints.count(endpoints_list[i]));
+    }
+}
+