hw/drivers: Add support for IPC ICBMsg transport

Tested with nRF5340.
apache · Nov 14, 2024 · 9c45740 · 9c45740
1 parent 7c8d6f0
commit 9c45740
Show file tree

Hide file tree

Showing 27 changed files with 1,700 additions and 1,368 deletions.
diff --git a/hw/bsp/nordic_pca10095/boot-nrf5340.ld b/hw/bsp/nordic_pca10095/boot-nrf5340.ld
@@ -20,6 +20,8 @@ MEMORY
 {
   FLASH (rx) : ORIGIN = 0x00000000, LENGTH = 0x8000
   RAM (rwx) : ORIGIN = 0x20000000, LENGTH = 0x80000
+  sram_ipc0_tx (rw)  : ORIGIN = 0x20070000, LENGTH = 0x4000
+  sram_ipc0_rx (rw)  : ORIGIN = 0x20074000, LENGTH = 0x4000
 }
 
 /* The bootloader does not contain an image header */

diff --git a/hw/bsp/nordic_pca10095/nrf5340.ld b/hw/bsp/nordic_pca10095/nrf5340.ld
@@ -20,6 +20,8 @@ MEMORY
 {
   FLASH (rx) : ORIGIN = 0x0000c000, LENGTH = 0x76000
   RAM (rwx) : ORIGIN = 0x20000000, LENGTH = 0x80000
+  sram_ipc0_tx (rw)  : ORIGIN = 0x20070000, LENGTH = 0x4000
+  sram_ipc0_rx (rw)  : ORIGIN = 0x20074000, LENGTH = 0x4000
 }
 
 /* This linker script is used for images and thus contains an image header */

diff --git a/hw/bsp/nordic_pca10095/syscfg.yml b/hw/bsp/nordic_pca10095/syscfg.yml
@@ -108,15 +108,30 @@ syscfg.vals.BLE_TRANSPORT:
     BLE_TRANSPORT_LL: nrf5340
 
 syscfg.vals.BSP_NRF5340_NET_ENABLE:
-    BSP_NRF5340_NET_FLASH_ENABLE: 1
     BLE_HCI_VS: 1
 
+syscfg.vals.'BSP_NRF5340_NET_ENABLE && BLE_TRANSPORT_LL != "ipc"':
+    BSP_NRF5340_NET_FLASH_ENABLE: 1
+
 syscfg.vals.BSP_NRF5340_NET_FLASH_ENABLE:
     IPC_NRF5340_CHANNELS: 4
 
 syscfg.vals.IPC_NRF5340_FLASH_CLIENT:
     HAL_FLASH_MAX_DEVICE_COUNT: 3
 
+syscfg.vals.'BLE_TRANSPORT_LL=="ipc" || BLE_TRANSPORT_IPC_BACKEND=="icbmsg"':
+    # The APP core have the same values but switched directions
+    BLE_TRANSPORT_IPC_TX_CHANNEL: 0
+    BLE_TRANSPORT_IPC_RX_CHANNEL: 1
+    IPC_SYNC_TX_CHANNEL: 0
+    IPC_SYNC_RX_CHANNEL: 1
+    IPC_ICBMSG_TX_REGION_NAME: "\".ipc0_tx\""
+    IPC_ICBMSG_RX_REGION_NAME: "\".ipc0_rx\""
+    IPC_ICBMSG_NUM_TX_BLOCKS: 16
+    IPC_ICBMSG_NUM_RX_BLOCKS: 24
+    IPC_ICBMSG_TX_REGION_SIZE: 0x4000
+    IPC_ICBMSG_RX_REGION_SIZE: 0x4000
+
 syscfg.restrictions.BSP_NRF5340_NET_FLASH_ENABLE:
     - 'IPC_NRF5340_CHANNELS >= 4'
 

diff --git a/hw/bsp/nordic_pca10095_net/boot-nrf5340_net.ld b/hw/bsp/nordic_pca10095_net/boot-nrf5340_net.ld
@@ -21,6 +21,8 @@ MEMORY
   FLASH (rx) : ORIGIN = 0x01000000, LENGTH = 0x4000
   RAM (rwx) : ORIGIN = 0x21000000, LENGTH = 0x10000
   IPC (rw)  : ORIGIN = 0x20000400, LENGTH = 0x400
+  sram_ipc0_tx (rw)  : ORIGIN = 0x20070000, LENGTH = 0x4000
+  sram_ipc0_rx (rw)  : ORIGIN = 0x20074000, LENGTH = 0x4000
 }
 
 /* The bootloader does not contain an image header */

diff --git a/hw/bsp/nordic_pca10095_net/nrf5340_net.ld b/hw/bsp/nordic_pca10095_net/nrf5340_net.ld
@@ -21,6 +21,8 @@ MEMORY
   FLASH (rx) : ORIGIN = 0x01008000, LENGTH = 0x30000
   RAM (rwx) : ORIGIN = 0x21000000, LENGTH = 0x10000
   IPC (rw)  : ORIGIN = 0x20000400, LENGTH = 0x400
+  sram_ipc0_tx (rw)  : ORIGIN = 0x20070000, LENGTH = 0x4000
+  sram_ipc0_rx (rw)  : ORIGIN = 0x20074000, LENGTH = 0x4000
 }
 
 /* This linker script is used for images and thus contains an image header */

diff --git a/hw/bsp/nordic_pca10095_net/pkg.yml b/hw/bsp/nordic_pca10095_net/pkg.yml
@@ -34,5 +34,7 @@ pkg.deps:
     - "@apache-mynewt-core/hw/scripts"
     - "@apache-mynewt-core/hw/mcu/nordic/nrf5340_net"
     - "@apache-mynewt-core/libc"
+
+pkg.deps.'BLE_TRANSPORT_HS != "ipc"':
     - "@apache-mynewt-core/sys/flash_map"
     - "@apache-mynewt-core/hw/drivers/flash/ipc_nrf5340_flash"
diff --git a/hw/bsp/nordic_pca10095_net/syscfg.yml b/hw/bsp/nordic_pca10095_net/syscfg.yml
@@ -79,3 +79,16 @@ syscfg.vals.BLE_CONTROLLER:
 
 syscfg.vals.BLE_TRANSPORT:
     BLE_TRANSPORT_HS: nrf5340
+
+syscfg.vals.'BLE_TRANSPORT_HS=="ipc" || BLE_TRANSPORT_IPC_BACKEND=="icbmsg"':
+    # The APP core have the same values but switched directions
+    BLE_TRANSPORT_IPC_TX_CHANNEL: 1
+    BLE_TRANSPORT_IPC_RX_CHANNEL: 0
+    IPC_SYNC_TX_CHANNEL: 1
+    IPC_SYNC_RX_CHANNEL: 0
+    IPC_ICBMSG_TX_REGION_NAME: "\".ipc0_rx\""
+    IPC_ICBMSG_RX_REGION_NAME: "\".ipc0_tx\""
+    IPC_ICBMSG_NUM_TX_BLOCKS: 24
+    IPC_ICBMSG_NUM_RX_BLOCKS: 16
+    IPC_ICBMSG_TX_REGION_SIZE: 0x4000
+    IPC_ICBMSG_RX_REGION_SIZE: 0x4000
diff --git a/hw/drivers/ipc/icbmsg/include/icbmsg/icbmsg.h b/hw/drivers/ipc/icbmsg/include/icbmsg/icbmsg.h
@@ -0,0 +1,65 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+#ifndef _HW_DRIVERS_IPC_ICBMSG_H
+#define _HW_DRIVERS_IPC_ICBMSG_H
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <os/os.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct ipc_service_cb {
+    void (*received)(const void *data, size_t len, void *user_data);
+};
+
+struct ipc_ept_cfg {
+    const char *name;
+    struct ipc_service_cb cb;
+    void *user_data;
+    uint8_t tx_channel;
+    uint8_t rx_channel;
+};
+
+struct ipc_icmsg_buf {
+    size_t block_id;
+    uint8_t *data;
+    uint16_t len;
+};
+
+typedef void (*ipc_icbmsg_recv_cb)(uint8_t ipc_id, void *user_data);
+
+uint8_t ipc_icmsg_register_ept(uint8_t ipc_id, struct ipc_ept_cfg *cfg);
+
+int ipc_icbmsg_send(uint8_t ipc_id, uint8_t ept_addr, const void *data, uint16_t len);
+
+int ipc_icbmsg_send_buf(uint8_t ipc_id, uint8_t ept_addr, struct ipc_icmsg_buf *buf);
+
+int ipc_icbmsg_alloc_tx_buf(uint8_t ipc_id, struct ipc_icmsg_buf *buf, uint32_t size);
+
+uint8_t ipc_icsmsg_ept_ready(uint8_t ipc_id, uint8_t ept_addr);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _HW_DRIVERS_IPC_ICBMSG_H */
diff --git a/hw/drivers/ipc/icbmsg/pkg.yml b/hw/drivers/ipc/icbmsg/pkg.yml
@@ -0,0 +1,29 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+pkg.name: hw/drivers/ipc/icbmsg
+pkg.description: IPC driver with icbmsg backend
+pkg.author: "Apache Mynewt <dev@mynewt.apache.org>"
+pkg.homepage: "http://mynewt.apache.org/"
+pkg.keywords:
+    - ipc
+
+pkg.deps:
+    - "@apache-mynewt-core/hw/mcu/nordic"
+    - "@apache-mynewt-core/kernel/os"