dppi: Add NRF_DPPI.h, NRF_DPPI.c and nrf_dppi.c files

Add DPPI in order to be able to model the NRF53 HW.

Signed-off-by: Sletnes Bjørlo, Aurora <[email protected]>

Author: auroraslb

src/HW_models/NRF_DPPI.c

@@ -0,0 +1,224 @@
+/*
+ * Copyright (c) 2020 Oticon A/S
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include "NRF_DPPI.h"
+#include <stdlib.h>
+#include "bs_tracing.h"
+#include <string.h>
+
+/*
+ * DPPI — Distributed programmable peripheral interconnect
+ * https://infocenter.nordicsemi.com/index.jsp?topic=%2Fps_nrf52840%2Fkeyfeatures_html5.html&cp=4_0_0
+ *
+ */
+
+NRF_DPPIC_Type NRF_DPPI_regs; ///< The DPPI registers
+
+/**
+ * DPPI module own TASKs handlers
+ */
+void nrf_dppi_TASK_CHG_ENDIS( int groupnbr, bool enable /*false=disable task*/ )
+{
+  if ( enable )
+  {
+    bs_trace_raw_time(9, "dppi: Channel group %i enabled\n", groupnbr);
+    NRF_DPPI_regs.CHEN |= NRF_DPPI_regs.CHG[groupnbr];
+  } else
+  {
+    bs_trace_raw_time(9 ,"dppi: Channel group %i disable\n", groupnbr);
+    NRF_DPPI_regs.CHEN &= ~NRF_DPPI_regs.CHG[groupnbr];
+  }
+  //Note of the author: From the spec I cannot guess if these tasks will affect
+  //CHEN or a separate hidden register
+}
+
+void nrf_dppi_TASK_CHG0_EN() { nrf_dppi_TASK_CHG_ENDIS(0,true); }
+void nrf_dppi_TASK_CHG1_EN() { nrf_dppi_TASK_CHG_ENDIS(1,true); }
+void nrf_dppi_TASK_CHG2_EN() { nrf_dppi_TASK_CHG_ENDIS(2,true); }
+void nrf_dppi_TASK_CHG3_EN() { nrf_dppi_TASK_CHG_ENDIS(3,true); }
+void nrf_dppi_TASK_CHG4_EN() { nrf_dppi_TASK_CHG_ENDIS(4,true); }
+void nrf_dppi_TASK_CHG5_EN() { nrf_dppi_TASK_CHG_ENDIS(5,true); }
+void nrf_dppi_TASK_CHG0_DIS(){ nrf_dppi_TASK_CHG_ENDIS(0,false); }
+void nrf_dppi_TASK_CHG1_DIS(){ nrf_dppi_TASK_CHG_ENDIS(1,false); }
+void nrf_dppi_TASK_CHG2_DIS(){ nrf_dppi_TASK_CHG_ENDIS(2,false); }
+void nrf_dppi_TASK_CHG3_DIS(){ nrf_dppi_TASK_CHG_ENDIS(3,false); }
+void nrf_dppi_TASK_CHG4_DIS(){ nrf_dppi_TASK_CHG_ENDIS(4,false); }
+void nrf_dppi_TASK_CHG5_DIS(){ nrf_dppi_TASK_CHG_ENDIS(5,false); }
+
+/*Forward declaration*/
+struct subscr_list_elem;
+
+//Element of linked list of subscribers
+typedef struct subscr_list_elem
+{
+  dest_f_t task_function;
+  struct subscr_list_elem * p_next;
+} subscr_list_elem_t;
+
+//Table with TASKs subscribing to all channels
+static subscr_list_elem_t* dppi_subscriber_list[NUMBER_DPPI_CHANNELS];
+
+//Function for checking if an element is in the subscriber linked list
+static bool subscriber_list_check(dest_f_t task_function, subscr_list_elem_t ** pp_head)
+{
+  if (*pp_head == NULL)
+  {
+    return false;
+  }
+
+  subscr_list_elem_t *p_last_elem = *pp_head;
+  bool in_list = (p_last_elem->task_function == task_function);
+
+  while (p_last_elem->p_next != NULL)
+  {
+    if (p_last_elem->task_function == task_function)
+    {
+      in_list = true;
+    }
+    p_last_elem = p_last_elem->p_next;
+  }
+
+  return in_list;
+}
+
+//Function for appending an element to the subscriber linked list
+static void subscriber_list_append(subscr_list_elem_t ** pp_head, dest_f_t task_function)
+{
+  if (!subscriber_list_check(task_function, pp_head))
+  {
+    struct subscr_list_elem* p_elem = (struct subscr_list_elem*) malloc(sizeof(struct subscr_list_elem));
+    p_elem->task_function = task_function;
+    p_elem->p_next = (*pp_head);
+    *pp_head = p_elem;
+  }
+}
+
+//Function for removing an element from the subscriber linked list
+static void subscriber_list_remove(subscr_list_elem_t ** pp_head, dest_f_t task_function)
+{
+  if(subscriber_list_check(task_function, pp_head))
+  {
+    struct subscr_list_elem* temp = (struct subscr_list_elem*) malloc(sizeof(struct subscr_list_elem));
+    temp = *pp_head;
+    subscr_list_elem_t *prev;
+
+    if (temp != NULL && temp->task_function == task_function)
+    {
+      *pp_head = temp->p_next;
+      free(temp);
+      return;
+    }
+
+    while (temp != NULL && temp->task_function != task_function)
+    {
+      prev = temp;
+      temp = temp->p_next;
+    }
+
+    if (temp == NULL)
+    {
+      free(temp);
+      return;
+    }
+
+    prev->p_next = temp->p_next;
+    free(temp);
+  }
+}
+
+/**
+ * Update the subscriber list by adding the task to the specified channel
+ */
+void nrf_dppi_subscriber_add(uint8_t channel, dest_f_t function)
+{
+  subscriber_list_append(&dppi_subscriber_list[channel], function);
+}
+
+/**
+ * Update the subscriber list by removing the task from all channels
+ */
+void nrf_dppi_subscriber_remove(dest_f_t function)
+{
+  for(int i=0; i < NUMBER_DPPI_CHANNELS; i++)
+  {
+    subscriber_list_remove(&dppi_subscriber_list[i], function);
+  }
+}
+
+/**
+ * Publish to a channel by triggering all tasks subscribing to the channel
+ */
+void nrf_dppi_publish(uint8_t channel)
+{
+  struct subscr_list_elem* temp = (struct subscr_list_elem*) malloc(sizeof(struct subscr_list_elem));
+  temp = dppi_subscriber_list[channel];
+  subscr_list_elem_t *prev;
+
+  while (temp != NULL)
+  {
+    temp->task_function();
+    prev = temp;
+    temp = temp->p_next;
+  }
+
+  free(temp);
+}
+
+
+/**
+ * Initialize the DPPI model
+ */
+void nrf_dppi_init()
+{
+  memset(&NRF_DPPI_regs, 0, sizeof(NRF_DPPI_regs));
+  memset(dppi_subscriber_list, 0, sizeof(dppi_subscriber_list));
+}
+
+/**
+ * Cleanup the DPPI model before exiting the program
+ */
+void nrf_dppi_clean_up()
+{
+  for(int i=0; i < NUMBER_DPPI_CHANNELS; i++)
+  {
+    struct subscr_list_elem* current = dppi_subscriber_list[i];
+    struct subscr_list_elem* next;
+
+    while (current != NULL)
+    {
+      next = current->p_next;
+      free(current);
+      current = next;
+    }
+    dppi_subscriber_list[i] = NULL;
+  }
+}
+
+
+/**
+ * Update DPPI CHEN mask after a write to CHENSET
+ * (writes to CHEN do not need sideeffects)
+ */
+void nrf_dppi_regw_sideeffects_CHENSET()
+{
+  if ( NRF_DPPI_regs.CHENSET != 0 )
+  {
+    NRF_DPPI_regs.CHEN |= NRF_DPPI_regs.CHENSET;
+    NRF_DPPI_regs.CHENSET = 0;
+  }
+}
+
+/**
+ * Update DPPI CHEN mask after a write to CHENCLR
+ * (writes to CHEN do not need sideeffects)
+ */
+void nrf_dppi_regw_sideeffects_CHENCLR()
+{
+  if ( NRF_DPPI_regs.CHENCLR != 0 )
+  {
+    NRF_DPPI_regs.CHEN &= ~NRF_DPPI_regs.CHENCLR;
+    NRF_DPPI_regs.CHENCLR = 0;
+  }
+}

src/HW_models/NRF_DPPI.h

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2020 Oticon A/S
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#ifndef _NRF_HW_MODEL_DPPI_H
+#define _NRF_HW_MODEL_DPPI_H
+
+#include "nrfx.h"
+
+#ifdef __cplusplus
+extern "C"{
+#endif
+
+extern NRF_DPPIC_Type NRF_DPPI_regs;
+#define NUMBER_DPPI_CHANNELS 32
+
+typedef void (*dest_f_t)(void); //typedef for function pointer
+
+void nrf_dppi_subscriber_add(uint8_t channel, dest_f_t function);
+void nrf_dppi_subscriber_remove(dest_f_t function);
+void nrf_dppi_publish(uint8_t channel);
+
+void nrf_dppi_init();
+void nrf_dppi_clean_up();
+
+void nrf_dppi_TASK_CHG0_EN();
+void nrf_dppi_TASK_CHG1_EN();
+void nrf_dppi_TASK_CHG2_EN();
+void nrf_dppi_TASK_CHG3_EN();
+void nrf_dppi_TASK_CHG4_EN();
+void nrf_dppi_TASK_CHG5_EN();
+void nrf_dppi_TASK_CHG0_DIS();
+void nrf_dppi_TASK_CHG1_DIS();
+void nrf_dppi_TASK_CHG2_DIS();
+void nrf_dppi_TASK_CHG3_DIS();
+void nrf_dppi_TASK_CHG4_DIS();
+void nrf_dppi_TASK_CHG5_DIS();
+
+void nrf_dppi_regw_sideeffects_CHENSET();
+void nrf_dppi_regw_sideeffects_CHENCLR();
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif