applications: nrf_desktop: switch to 64bit timestamp in eventq

Switch to 64bit timestamp using
k_uptime_get API to calculate timestamp
differences in eventq utility.
We do it in order to prevent overflows.

Jira: NCSDK-34009

Signed-off-by: Jan Zyczkowski <[email protected]>

Author: zycz

applications/nrf_desktop/src/modules/hid_state.c

@@ -765,10 +765,10 @@ static void connect(const void *subscriber_id, uint8_t report_id)
 
 		if (!hid_eventq_is_empty(&rd->eventq)) {
 			/* Remove all stale events from the queue. */
-			uint32_t uptime = k_uptime_get_32();
+			int64_t uptime = k_uptime_get();
 
 			if (uptime > CONFIG_DESKTOP_HID_REPORT_EXPIRATION) {
-				uint32_t min_ts = uptime - CONFIG_DESKTOP_HID_REPORT_EXPIRATION;
+				int64_t min_ts = uptime - CONFIG_DESKTOP_HID_REPORT_EXPIRATION;
 
 				hid_eventq_cleanup(&rd->eventq, min_ts);
 			}
@@ -911,10 +911,10 @@ static void update_key(const struct hid_keymap *map, bool pressed)
 			__ASSERT_NO_MSG(hid_eventq_is_full(&rd->eventq));
 
 			/* Queue is full. If not yet connected, try to drop old events and retry. */
-			uint32_t uptime = k_uptime_get_32();
+			int64_t uptime = k_uptime_get();
 
 			if (uptime > CONFIG_DESKTOP_HID_REPORT_EXPIRATION) {
-				uint32_t min_ts = uptime - CONFIG_DESKTOP_HID_REPORT_EXPIRATION;
+				int64_t min_ts = uptime - CONFIG_DESKTOP_HID_REPORT_EXPIRATION;
 
 				hid_eventq_cleanup(&rd->eventq, min_ts);
 			}

applications/nrf_desktop/src/util/hid_eventq.c

@@ -21,7 +21,7 @@ struct hid_eventq_data {
 struct hid_eventq_event {
 	sys_snode_t node;
 	struct hid_eventq_data data;
-	uint32_t timestamp;
+	int64_t timestamp;
 };
 
 
@@ -73,7 +73,7 @@ static void drop_oldest_hid_events(struct hid_eventq *q)
 		/* Try to remove events but only if key release was generated for each removed key
 		 * press.
 		 */
-		uint32_t node_timestamp = CONTAINER_OF(i, struct hid_eventq_event, node)->timestamp;
+		int64_t node_timestamp = CONTAINER_OF(i, struct hid_eventq_event, node)->timestamp;
 
 		/* Use incremented event timestamp to drop the event. */
 		hid_eventq_cleanup(q, node_timestamp + 1);
@@ -107,11 +107,11 @@ int hid_eventq_keypress_enqueue(struct hid_eventq *q, uint16_t id, bool pressed,
 		return -ENOMEM;
 	}
 
-	evt->timestamp = k_uptime_get_32();
+	evt->timestamp = k_uptime_get();
 	evt->data.key_id = id;
 	evt->data.pressed = pressed;
 
-	LOG_DBG("q:%p, ts:%u, id:%" PRIu16 ", %s",
+	LOG_DBG("q:%p, ts:%" PRId64 ", id:%" PRIu16 ", %s",
 		(void *)q, evt->timestamp, id, pressed ? "press" : "release");
 
 	/* Add a new event to the queue. */
@@ -138,7 +138,7 @@ int hid_eventq_keypress_dequeue(struct hid_eventq *q, uint16_t *id, bool *presse
 	*id = evt->data.key_id;
 	*pressed = evt->data.pressed;
 
-	LOG_DBG("q:%p, ts:%u, id:%" PRIu16 ", %s",
+	LOG_DBG("q:%p, ts:%" PRId64 ", id:%" PRIu16 ", %s",
 		(void *)q, evt->timestamp, *id, *pressed ? "press" : "release");
 
 	k_free(evt);
@@ -185,7 +185,7 @@ void hid_eventq_reset(struct hid_eventq *q)
 	__ASSERT_NO_MSG(sys_slist_is_empty(&q->root));
 }
 
-static sys_snode_t *get_first_valid_node(struct hid_eventq *q, uint32_t min_timestamp)
+static sys_snode_t *get_first_valid_node(struct hid_eventq *q, int64_t min_timestamp)
 {
 	sys_snode_t *i;
 
@@ -234,11 +234,11 @@ static sys_snode_t *get_keypress_release_node(struct hid_eventq *q, struct hid_e
 	return NULL;
 }
 
-void hid_eventq_cleanup(struct hid_eventq *q, uint32_t min_timestamp)
+void hid_eventq_cleanup(struct hid_eventq *q, int64_t min_timestamp)
 {
 	__ASSERT_NO_MSG(hid_eventq_is_initialized(q));
 
-	LOG_DBG("q:%p, min_timestamp:%" PRIu32, (void *)q, min_timestamp);
+	LOG_DBG("q:%p, min_timestamp:%" PRId64, (void *)q, min_timestamp);
 
 	sys_snode_t *first_valid = get_first_valid_node(q, min_timestamp);
 

applications/nrf_desktop/src/util/hid_eventq.h

@@ -119,7 +119,7 @@ void hid_eventq_reset(struct hid_eventq *q);
  * @param[in] q			HID event queue object.
  * @param[in] min_timestamp	Minimal valid timestamp.
  */
-void hid_eventq_cleanup(struct hid_eventq *q, uint32_t min_timestamp);
+void hid_eventq_cleanup(struct hid_eventq *q, int64_t min_timestamp);
 
 #ifdef __cplusplus
 }

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -261,6 +261,7 @@ nRF Desktop
 
   * The :ref:`nrf_desktop_hid_eventq`.
     The utility can be used by an application module to temporarily queue HID events related to keypresses (button press or release) to handle them later.
+    The utility uses 64-bit timestamps to prevent overflow issues.
   * The :ref:`nrf_desktop_hid_keymap`.
     The utility can be used by an application module to map an application-specific key ID to a HID report ID and HID usage ID pair according to statically defined user configuration.
     The :file:`hid_keymap.h` file was moved from the :file:`configuration/common` directory to the :file:`src/util` directory.