esb: Implement workaround for HMPAN-216

Added workaround for the hardware errata HMPAN-216 for the nRF54H20 SoC.

Ref: NCSDK-32717

Signed-off-by: Marcin Jelinski <[email protected]>

Author: maje-emb

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

@@ -202,7 +202,10 @@ DECT NR+
 Enhanced ShockBurst (ESB)
 -------------------------
 
-* Added loading of radio trims and a fix of a hardware errata for the nRF54H20 SoC to improve the RF performance.
+* Added:
+
+  * Loading of radio trims and a fix of a hardware errata for the nRF54H20 SoC to improve the RF performance.
+  * Workaround for the hardware errata HMPAN-216 for the nRF54H20 SoC.
 
 Gazell
 ------

samples/esb/esb_prx/boards/nrf54h20dk_nrf54h20_cpurad.overlay

@@ -39,6 +39,13 @@
 	chosen {
 		zephyr,console = &uart136;
 	};
+
+	cpurad_cpusys_errata216_mboxes: errata216_mboxes {
+		compatible = "zephyr,mbox-ipm";
+		status = "okay";
+		mboxes = < &cpusys_vevif 0x14 >, < &cpusys_vevif 0x15 >;
+		mbox-names = "on_req", "off_req";
+	};
 };
 
 &gpio9 {

samples/esb/esb_ptx/boards/nrf54h20dk_nrf54h20_cpurad.overlay

@@ -39,6 +39,13 @@
 	chosen {
 		zephyr,console = &uart136;
 	};
+
+	cpurad_cpusys_errata216_mboxes: errata216_mboxes {
+		compatible = "zephyr,mbox-ipm";
+		status = "okay";
+		mboxes = < &cpusys_vevif 0x14 >, < &cpusys_vevif 0x15 >;
+		mbox-names = "on_req", "off_req";
+	};
 };
 
 &gpio9 {

subsys/esb/esb.c

@@ -23,6 +23,7 @@
 #include <zephyr/kernel.h>
 #include <zephyr/sys/byteorder.h>
 #include <zephyr/drivers/gpio.h>
+#include <zephyr/drivers/mbox.h>
 
 #include <mpsl_fem_protocol_api.h>
 
@@ -113,6 +114,10 @@ LOG_MODULE_REGISTER(esb, CONFIG_ESB_LOG_LEVEL);
 /* Empty trim value */
 #define TRIM_VALUE_EMPTY 0xFFFFFFFF
 
+#define ERRATA_216_PRESENT DT_NODE_HAS_STATUS(DT_NODELABEL(cpurad_cpusys_errata216_mboxes), okay)
+#define ERRATA_216_RADIO_ENABLE_DELAY_US	40
+#define ERRATA_216_MIN_TIME_TO_DISABLE_US	100
+
 /* Internal Enhanced ShockBurst module state. */
 enum esb_state {
 	ESB_STATE_IDLE,		/* Idle. */
@@ -250,6 +255,20 @@ static struct esb_address esb_addr = {
 	.rx_pipes_enabled = 0xFF
 };
 
+enum {
+	ERRATA_216_DISABLED,
+	ERRATA_216_ENABLED,
+};
+static atomic_t errata_216_status = ATOMIC_INIT(ERRATA_216_DISABLED);
+static uint32_t errata_216_timer_shorts;
+
+#if ERRATA_216_PRESENT
+static const struct mbox_dt_spec on_channel =
+			MBOX_DT_SPEC_GET(DT_NODELABEL(cpurad_cpusys_errata216_mboxes), on_req);
+static const struct mbox_dt_spec off_channel =
+			MBOX_DT_SPEC_GET(DT_NODELABEL(cpurad_cpusys_errata216_mboxes), off_req);
+#endif /* ERRATA_216_PRESENT */
+
 static esb_event_handler event_handler;
 static struct esb_payload *current_payload;
 
@@ -392,6 +411,32 @@ static inline void apply_errata143_workaround(void)
 	}
 }
 
+static void errata216_on(void)
+{
+#if ERRATA_216_PRESENT
+	if (mbox_send_dt(&on_channel, NULL) != 0) {
+		LOG_ERR("Failed to enable Errata 216");
+		/* Should not happen. */
+		__ASSERT_NO_MSG(false);
+	} else {
+		atomic_set(&errata_216_status, ERRATA_216_ENABLED);
+	}
+#endif /* ERRATA_216_PRESENT */
+}
+
+static void errata216_off(void)
+{
+#if ERRATA_216_PRESENT
+	if (mbox_send_dt(&off_channel, NULL) != 0) {
+		LOG_ERR("Failed to disable Errata 216");
+		/* Should not happen. */
+		__ASSERT_NO_MSG(false);
+	} else {
+		atomic_set(&errata_216_status, ERRATA_216_DISABLED);
+	}
+#endif /* ERRATA_216_PRESENT */
+}
+
 static void esb_fem_for_tx_set(bool ack)
 {
 	uint32_t timer_shorts;
@@ -545,8 +590,23 @@ void esb_fem_for_tx_retry_clear(void)
 
 static void radio_start(void)
 {
-	/* Event generator unit is used to start radio and protocol timer if needed. */
-	nrf_egu_task_trigger(ESB_EGU, ESB_EGU_TASK);
+	if (IS_ENABLED(ERRATA_216_PRESENT) &&
+					   atomic_get(&errata_216_status) == ERRATA_216_DISABLED) {
+		errata216_on();
+
+		nrfx_timer_compare(&esb_timer, NRF_TIMER_CC_CHANNEL3,
+			nrfx_timer_us_to_ticks(&esb_timer, ERRATA_216_RADIO_ENABLE_DELAY_US), true);
+
+		errata_216_timer_shorts = esb_timer.p_reg->SHORTS;
+		nrf_timer_shorts_set(esb_timer.p_reg,
+						(NRF_TIMER_SHORT_COMPARE3_STOP_MASK |
+						NRF_TIMER_SHORT_COMPARE3_CLEAR_MASK));
+		nrfx_timer_clear(&esb_timer);
+		nrf_timer_task_trigger(ESB_NRF_TIMER_INSTANCE, NRF_TIMER_TASK_START);
+	} else {
+		/* Event generator unit is used to start radio and protocol timer if needed. */
+		nrf_egu_task_trigger(ESB_EGU, ESB_EGU_TASK);
+	}
 }
 
 static void update_rf_payload_format_esb_dpl(uint32_t payload_length)
@@ -1031,6 +1091,22 @@ static void esb_timer_handler(nrf_timer_event_t event_type, void *context)
 			on_timer_compare1();
 		}
 	}
+
+	if (IS_ENABLED(ERRATA_216_PRESENT) && event_type == NRF_TIMER_EVENT_COMPARE3) {
+		nrf_timer_int_disable(esb_timer.p_reg, NRF_TIMER_INT_COMPARE3_MASK);
+
+		if (atomic_get(&errata_216_status) == ERRATA_216_ENABLED) {
+			/* This case is triggered after calling the radio_start() function */
+
+			/* Restore timer shorts */
+			nrf_timer_shorts_set(esb_timer.p_reg, errata_216_timer_shorts);
+
+			nrf_egu_task_trigger(ESB_EGU, ESB_EGU_TASK);
+		} else {
+			/* This case is triggered during retransmission. */
+			errata216_on();
+		}
+	}
 }
 
 static int sys_timer_init(void)
@@ -1217,6 +1293,7 @@ static void on_radio_disabled_tx_noack(void)
 
 	if (tx_fifo.count == 0) {
 		esb_state = ESB_STATE_IDLE;
+		errata216_off();
 		set_evt_interrupt();
 	} else {
 		set_evt_interrupt();
@@ -1249,6 +1326,16 @@ static void on_radio_disabled_tx(void)
 	nrfx_timer_compare(&esb_timer, NRF_TIMER_CC_CHANNEL1,
 			   (esb_cfg.retransmit_delay - ramp_up), false);
 
+	if (IS_ENABLED(ERRATA_216_PRESENT)) {
+		int32_t min_time = esb_cfg.retransmit_delay - wait_for_ack_timeout_us -
+							      ramp_up - ADDR_EVENT_LATENCY_US;
+		if (min_time > ERRATA_216_MIN_TIME_TO_DISABLE_US) {
+			uint32_t cc_value = esb_cfg.retransmit_delay - ramp_up -
+								 ERRATA_216_RADIO_ENABLE_DELAY_US;
+			nrfx_timer_compare(&esb_timer, NRF_TIMER_CC_CHANNEL3, cc_value, true);
+		}
+	}
+
 	nrf_timer_shorts_set(esb_timer.p_reg,
 		(NRF_TIMER_SHORT_COMPARE1_STOP_MASK | NRF_TIMER_SHORT_COMPARE1_CLEAR_MASK));
 
@@ -1303,6 +1390,7 @@ static void on_radio_disabled_tx_wait_for_ack(void)
 
 		if ((tx_fifo.count == 0) || (esb_cfg.tx_mode == ESB_TXMODE_MANUAL)) {
 			esb_state = ESB_STATE_IDLE;
+			errata216_off();
 			set_evt_interrupt();
 		} else {
 			set_evt_interrupt();
@@ -1320,6 +1408,7 @@ static void on_radio_disabled_tx_wait_for_ack(void)
 			interrupt_flags |= INT_TX_FAILED_MSK;
 
 			esb_state = ESB_STATE_IDLE;
+			errata216_off();
 			set_evt_interrupt();
 		} else {
 			bool radio_started = true;
@@ -1371,6 +1460,14 @@ static void on_radio_disabled_tx_wait_for_ack(void)
 				esb_fem_for_tx_set(true);
 
 				radio_start();
+			} else if (IS_ENABLED(ERRATA_216_PRESENT)) {
+				uint16_t ramp_up = esb_cfg.use_fast_ramp_up ?
+						       TX_FAST_RAMP_UP_TIME_US : TX_RAMP_UP_TIME_US;
+				int32_t min_time = esb_cfg.retransmit_delay - ramp_up -
+						    wait_for_ack_timeout_us - ADDR_EVENT_LATENCY_US;
+				if (min_time > ERRATA_216_MIN_TIME_TO_DISABLE_US) {
+					errata216_off();
+				}
 			}
 		}
 	}
@@ -1874,6 +1971,7 @@ int esb_suspend(void)
 	esb_ppi_disable_all();
 
 	esb_state = ESB_STATE_IDLE;
+	errata216_off();
 
 	return 0;
 }
@@ -1890,6 +1988,7 @@ void esb_disable(void)
 	nrf_radio_fast_ramp_up_enable_set(NRF_RADIO, false);
 
 	esb_state = ESB_STATE_IDLE;
+	errata216_off();
 	esb_initialized = false;
 
 	reset_fifos();
@@ -2107,6 +2206,7 @@ int esb_stop_rx(void)
 	nrf_radio_event_clear(NRF_RADIO, NRF_RADIO_EVENT_DISABLED);
 
 	esb_state = ESB_STATE_IDLE;
+	errata216_off();
 
 	return 0;
 }