Created mmc_driver_client file and moved sDDF data structures into it.

Author: ptrk8

Diff for: mmc/CMakeLists.txt

@@ -489,9 +489,7 @@ target_include_directories(mmc_rpi3b_lib_diskio PUBLIC src/lib_fatfs/)
 target_link_libraries(
         mmc_rpi3b_lib_diskio
         mmc_rpi3b_lib_ff
-        mmc_rpi3b_lib_blk_request_queue
-        mmc_rpi3b_lib_blk_response_queue
-        mmc_rpi3b_lib_blk_shared_data_queue
+        mmc_rpi3b_lib_mmc_driver_client
 )
 
 add_library(mmc_rpi3b_lib_diskio_test src/lib_fatfs/diskio_test.c)
@@ -552,4 +550,21 @@ target_link_libraries(
         mmc_rpi3b_lib_blk_shared_data_buf
         mmc_rpi3b_lib_fatfs_e2e
         mmc_rpi3b_lib_diskio
+        mmc_rpi3b_lib_mmc_driver_client
+)
+
+add_library(mmc_rpi3b_lib_mmc_driver_client src/mmc_driver_client/mmc_driver_client.c)
+target_include_directories(mmc_rpi3b_lib_mmc_driver_client PUBLIC include/)
+target_link_libraries(
+        mmc_rpi3b_lib_mmc_driver_client
+        mmc_rpi3b_lib_sel4cp_facade
+        mmc_rpi3b_lib_blk_request_queue
+        mmc_rpi3b_lib_blk_response_queue
+        mmc_rpi3b_lib_blk_shared_data_queue
+        mmc_rpi3b_lib_blk_request
+        mmc_rpi3b_lib_blk_response
+        mmc_rpi3b_lib_blk_shared_data_buf
+        mmc_rpi3b_lib_result
 )
+
+

Diff for: mmc/Makefile

@@ -159,6 +159,7 @@ FATFS_OBJS := \
 	lib_fatfs/diskio_test.o \
 	lib_fatfs/ffunicode.o \
 	fatfs_e2e.o \
+	mmc_driver_client/mmc_driver_client.o \
 
 IMAGES := \
 	serial_driver.elf \
@@ -183,6 +184,7 @@ directories:
 	mkdir -p $(BUILD_DIR)/lib_sddf_blk
 	mkdir -p $(BUILD_DIR)/common
 	mkdir -p $(BUILD_DIR)/mmc_driver
+	mkdir -p $(BUILD_DIR)/mmc_driver_client
 	mkdir -p $(BUILD_DIR)/mmc_driver/sdhci
 	mkdir -p $(BUILD_DIR)/mmc_driver/bcm_emmc_regs
 	mkdir -p $(BUILD_DIR)/mmc_driver/bcm_emmc_regs/cmdtm

Diff for: mmc/include/fatfs.h

@@ -9,7 +9,10 @@
 #include "blk_shared_data_queue.h"
 #include "fatfs_e2e.h"
 #include "diskio.h"
+#include "mmc_driver_client.h"
 
 #define FATFS_TO_SERIAL_CLIENT_PUTCHAR_CHANNEL (13)
+#define FATFS_TO_MMC_DRIVER_REQUEST_CHANNEL (15)
+
 #define FAT_CLUSTER_SIZE (0x10000)
 

Diff for: mmc/include/mmc_driver.h

@@ -15,6 +15,7 @@
 
 #define MMC_DRIVER_TO_SERIAL_CLIENT_PUTCHAR_CHANNEL (7)
 #define MMC_DRIVER_TO_TIMER_DRIVER_GET_NUM_TICKS_CHANNEL (11)
+#define MMC_DRIVER_TO_FATFS_REQUEST_CHANNEL (16)
 
 /**
  * Returns the number of blocks on the SD card.

Diff for: mmc/include/mmc_driver_client.h

@@ -0,0 +1,50 @@
+#pragma once
+
+#include <stddef.h>
+
+#include "sel4cp_facade.h"
+#include "blk_request_queue.h"
+#include "blk_response_queue.h"
+#include "blk_shared_data_queue.h"
+#include "blk_request.h"
+#include "blk_response.h"
+#include "blk_shared_data_buf.h"
+#include "result.h"
+
+typedef struct mmc_driver_client mmc_driver_client_t;
+struct mmc_driver_client {
+    /* sel4cp channel ID to send Request notifications to `mmc_driver`. */
+    size_t sel4cp_channel_id_request;
+    blk_request_queue_t *request_queue;
+    blk_response_queue_t *response_queue;
+    blk_shared_data_queue_t shared_data_queue;
+};
+
+/**
+ * Initialise our `mmc_driver_client`.
+ * @param mmc_driver_client
+ * @param sel4cp_channel_id_request
+ * @param request_queue
+ * @param response_queue
+ * @param shared_data_queue
+ * @return
+ */
+result_t mmc_driver_client_init(
+        mmc_driver_client_t *mmc_driver_client,
+        size_t sel4cp_channel_id_request,
+        blk_request_queue_t *request_queue,
+        blk_response_queue_t *response_queue,
+        blk_shared_data_queue_t *shared_data_queue
+);
+
+/**
+ * Services the `GET_SECTOR_COUNT` FatFs request.
+ * @param mmc_driver_client
+ * @param ret_val
+ * @return
+ */
+result_t mmc_driver_client_get_num_blocks(
+        mmc_driver_client_t *mmc_driver_client,
+        uint64_t *ret_val
+);
+

Diff for: mmc/mmc.system

@@ -418,8 +418,12 @@
                 setvar_vaddr="mmc_driver_shared_data" />
     </protection_domain>
     <channel>
-        <end pd="fatfs" id="13" />
-        <end pd="serial_client" id="14" />
+        <end pd="fatfs" id="13"/>
+        <end pd="serial_client" id="14"/>
+    </channel>
+    <channel>
+        <end pd="fatfs" id="15"/>
+        <end pd="mmc_driver" id="16"/>
     </channel>
 </system>
 

Diff for: mmc/src/fatfs.c

@@ -12,9 +12,9 @@ uintptr_t mmc_driver_response_queue;
 /* Shared memory region for passing data between `mmc_driver` and `fatfs`. */
 uintptr_t mmc_driver_shared_data;
 
-/* The global shared data queue that manages the buffers within the
- * `mmc_driver_shared_data` shared memory region. */
-blk_shared_data_queue_t global_shared_data_queue = {0};
+/* The global MMC driver client that uses the sDDF data structures (above) to
+ * interact with the `mmc_driver`. */
+mmc_driver_client_t global_mmc_driver_client = {0};
 
 void init(void) {
     /* Initialise `printf`. The `log.h` library depends on `printf` being
@@ -49,8 +49,9 @@ void init(void) {
         return;
     }
 
+    blk_shared_data_queue_t shared_data_queue = {0};
     blk_shared_data_queue_result_t shared_data_queue_init_result = blk_shared_data_queue_init(
-            &global_shared_data_queue,
+            &shared_data_queue,
             mmc_driver_shared_data,
             SEL4CP_MAX_PAGE_SIZE,
             FAT_CLUSTER_SIZE /* TODO: Figure out how to obtain this info dynamically. */
@@ -60,22 +61,31 @@ void init(void) {
         return;
     }
 
-    /* Initialises FatFs by passing it the data structures it requires access to
-     * for low-level disk I/O functions. */
-    disk_init(
+    /* Initialise the `mmc_driver_client` library that FatFs relies on. */
+    result_t res;
+    res = mmc_driver_client_init(
+            &global_mmc_driver_client,
+            FATFS_TO_MMC_DRIVER_REQUEST_CHANNEL,
             request_queue,
             response_queue,
-            &global_shared_data_queue
+            &shared_data_queue
     );
+    if (result_is_err(res)) {
+        result_printf(res);
+        return;
+    }
+
+    /* Initialises FatFs by passing it the `mmc_driver_client`, which uses sDDF
+     * data structures to interact with the `mmc_driver`. */
+    disk_init(&global_mmc_driver_client);
 
     /* TODO: E2E test the state of the above data structures. */
-//    result_t res;
-//    res = fatfs_e2e_diskio_test();
-//    if (result_is_err(res)) {
-//        result_printf(res);
-//        return;
-//    }
-//
+    res = fatfs_e2e_diskio_test();
+    if (result_is_err(res)) {
+        result_printf(res);
+        return;
+    }
+
 //    res = fatfs_e2e_write_close_read_simple();
 //    if (result_is_err(res)) {
 //        result_printf(res);

Diff for: mmc/src/lib_fatfs/diskio.c

@@ -15,18 +15,12 @@
 #define DEV_RAM        1    /* Example: Map Ramdisk to physical drive 1 */
 #define DEV_USB        2    /* Example: Map USB MSD to physical drive 2 */
 
-blk_request_queue_t *disk_request_queue = NULL;
-blk_response_queue_t *disk_response_queue = NULL;
-blk_shared_data_queue_t *disk_shared_data_queue = NULL;
+mmc_driver_client_t *fatfs_mmc_driver_client = NULL;
 
 void disk_init(
-        blk_request_queue_t *request_queue,
-        blk_response_queue_t *response_queue,
-        blk_shared_data_queue_t *shared_data_queue
+        mmc_driver_client_t *mmc_driver_client
 ) {
-    disk_request_queue = request_queue;
-    disk_response_queue = response_queue;
-    disk_shared_data_queue = shared_data_queue;
+    fatfs_mmc_driver_client = mmc_driver_client;
 }
 
 /*-----------------------------------------------------------------------*/
@@ -243,7 +237,16 @@ DRESULT disk_ioctl(
         case DEV_MMC :
             switch (cmd) {
                 case GET_SECTOR_COUNT: {
-//                    uint64_t *num_blocks = (uint64_t *) buff;
+                    uint64_t *num_blocks = (uint64_t *) buff;
+                    if (result_is_err(
+                            mmc_driver_client_get_num_blocks(
+                                    fatfs_mmc_driver_client,
+                                    num_blocks
+                            )
+                    )) {
+                        res = RES_ERROR;
+                        break;
+                    }
 //                    result_t res_mmc = mmc_driver_get_num_blocks(num_blocks);
 //                    if (result_is_err(res_mmc)) {
 //                        res = RES_ERROR;

Diff for: mmc/src/lib_fatfs/diskio.h

@@ -5,19 +5,12 @@
 #ifndef _DISKIO_DEFINED
 #define _DISKIO_DEFINED
 
-#include "blk_request_queue.h"
-#include "blk_response_queue.h"
-#include "blk_shared_data_queue.h"
-#include "blk_request.h"
-#include "blk_response.h"
-#include "blk_shared_data_buf.h"
-
-/* Initialises FatFs by passing it the data structures it requires access to for
- * low-level disk I/O functions. */
+#include "mmc_driver_client.h"
+
+/* Initialises FatFs by passing it the `mmc_driver_client`, which uses sDDF data
+ * structures to interact with the `mmc_driver`. */
 void disk_init(
-        blk_request_queue_t *request_queue,
-        blk_response_queue_t *response_queue,
-        blk_shared_data_queue_t *shared_data_queue
+    mmc_driver_client_t *mmc_driver_client
 );
 
 #ifdef __cplusplus

Diff for: mmc/src/lib_sddf_blk/blk_request.c

@@ -30,25 +30,14 @@ static inline blk_request_result_t blk_request_init_no_args(
     return OK_BLK_REQUEST;
 }
 
-blk_request_result_t blk_request_init_get_sector_count(
+blk_request_result_t blk_request_init_get_num_blocks(
         blk_request_t *request,
         blk_shared_data_buf_t *shared_data_buf
 ) {
     return blk_request_init_no_args(
             request,
             shared_data_buf,
-            GET_SECTOR_COUNT
-    );
-}
-
-blk_request_result_t blk_request_init_get_sector_size(
-        blk_request_t *request,
-        blk_shared_data_buf_t *shared_data_buf
-) {
-    return blk_request_init_no_args(
-            request,
-            shared_data_buf,
-            GET_SECTOR_SIZE
+            GET_NUM_BLOCKS
     );
 }
 

Diff for: mmc/src/lib_sddf_blk/blk_request.h

@@ -9,8 +9,7 @@
 #include "blk_shared_data_buf.h"
 
 enum blk_request_operation {
-    GET_SECTOR_COUNT,
-    GET_SECTOR_SIZE,
+    GET_NUM_BLOCKS,
     GET_BLOCK_SIZE,
     CTRL_SYNC,
     READ,
@@ -38,23 +37,12 @@ enum blk_request_result {
 typedef enum blk_request_result blk_request_result_t;
 
 /**
- * Initialises a `GET_SECTOR_COUNT` request.
+ * Initialises a `GET_NUM_BLOCKS` request.
  * @param request
  * @param shared_data_buf
  * @return
  */
-blk_request_result_t blk_request_init_get_sector_count(
-        blk_request_t *request,
-        blk_shared_data_buf_t *shared_data_buf
-);
-
-/**
- * Initialises a `GET_SECTOR_SIZE` request.
- * @param request
- * @param shared_data_buf
- * @return
- */
-blk_request_result_t blk_request_init_get_sector_size(
+blk_request_result_t blk_request_init_get_num_blocks(
         blk_request_t *request,
         blk_shared_data_buf_t *shared_data_buf
 );

Diff for: mmc/src/lib_sddf_blk/blk_shared_data_queue.c

@@ -142,6 +142,7 @@ blk_shared_data_queue_result_t blk_shared_data_queue_enqueue(
         return ERR_BLK_SHARED_DATA_QUEUE_FULL;
     }
     /* Copy everything from `val` into `queue->data_bufs[queue->tail_idx]`. */
+    /* TODO: Encapsulate into a function call. */
     memcpy(&queue->data_bufs[queue->tail_idx], val, sizeof(*val));
     /* We place a memory barrier here to ensure that the instructions that
      * update the tail index are guaranteed to occur after the buffer has been
@@ -173,6 +174,7 @@ blk_shared_data_queue_result_t blk_shared_data_queue_dequeue(
         return ERR_BLK_SHARED_DATA_QUEUE_EMPTY;
     }
     /* Copy everything from `queue->data_bufs[queue->head_idx]` into `ret_val`. */
+    /* TODO: Encapsulate into a function call. */
     memcpy(ret_val, &queue->data_bufs[queue->head_idx], sizeof(*ret_val));
     /* We place a memory barrier here to ensure that the instructions that
      * update the head index are guaranteed to occur after the buffer has been
@@ -183,5 +185,14 @@ blk_shared_data_queue_result_t blk_shared_data_queue_dequeue(
     return OK_BLK_SHARED_DATA_QUEUE;
 }
 
-
+blk_shared_data_queue_result_t blk_shared_data_queue_copy(
+        blk_shared_data_queue_t *dst_queue,
+        blk_shared_data_queue_t *src_queue
+) {
+    if (dst_queue == NULL || src_queue == NULL) {
+        return ERR_NULL_BLK_SHARED_DATA_QUEUE;
+    }
+    memcpy(dst_queue, src_queue, sizeof(*dst_queue));
+    return OK_BLK_SHARED_DATA_QUEUE;
+}
 

Diff for: mmc/src/lib_sddf_blk/blk_shared_data_queue.h

@@ -129,3 +129,12 @@ blk_shared_data_queue_result_t blk_shared_data_queue_dequeue(
         blk_shared_data_buf_t *ret_val
 );
 
+/**
+ * Copies the contents of `src_queue` into `dst_queue`.
+ * @param dst_queue
+ * @param src_queue
+ */
+blk_shared_data_queue_result_t blk_shared_data_queue_copy(
+        blk_shared_data_queue_t *dst_queue,
+        blk_shared_data_queue_t *src_queue
+);

Diff for: mmc/src/mmc_driver.c

@@ -208,5 +208,13 @@ result_t mmc_driver_read_blocks(
 }
 
 void notified(sel4cp_channel ch) {
-
+    switch(ch) {
+        case MMC_DRIVER_TO_FATFS_REQUEST_CHANNEL: {
+            printf("Received something on MMC_DRIVER_TO_FATFS_REQUEST_CHANNEL\n");
+            break;
+        }
+        default:
+            printf("MMC Driver: received notification on unexpected channel\n");
+            break;
+    }
 }