Merge pull request #52 from ucb-bar/freertos

ADD: port FreeRTOS

Author: iansseijelly

.gitignore

@@ -2,4 +2,3 @@
 build/
 *.log
 *.afdo
-*.txt

CMakeLists.txt

@@ -35,6 +35,8 @@ option(PROF_COV                     "Build with profiling and coverage"       OF
 option(GCNO_ONLY                    "Only build gcno files"                   OFF )
 option(USE_PGO                      "Build with profile guided optimization"  OFF )
 option(OPT_INFO                     "Build with optimization information"      OFF )
+
+option(USE_FREERTOS                 "Build with FreeRTOS"                     OFF )
 # Define the variable with a default empty value
 set(AFDO_PATH "" CACHE STRING "Path to autofdo profile data")
 #################################
@@ -132,10 +134,6 @@ add_executable(app
 
 target_include_directories(app PUBLIC app/include)
 
-# add std lib path
-include_directories(/scratch/iansseijelly/chipyard/.conda-env/riscv-tools/riscv64-unknown-elf/include)
-link_directories(/scratch/iansseijelly/chipyard/.conda-env/riscv-tools/riscv64-unknown-elf/lib)
-
 #################################
 # Dependencies
 #################################

driver/rocket-chip/l_trace_encoder/l_trace_encoder.c

@@ -7,7 +7,7 @@ void l_trace_sink_dma_configure_addr(LTraceSinkDmaType *sink_dma, uint64_t dma_a
 void l_trace_sink_dma_read(LTraceSinkDmaType *sink_dma, uint8_t *buffer) {
   sink_dma->TR_SK_DMA_FLUSH = 1;
   while (sink_dma->TR_SK_DMA_FLUSH_DONE == 0) {
-    ;
+    // printf("waiting for flush done\n");
   }
   // printf("[l_trace_sink_dma_read] flush done\n");
   uint64_t count = sink_dma->TR_SK_DMA_COUNT;

driver/rocket-chip/l_trace_encoder/l_trace_encoder.h

@@ -7,17 +7,19 @@
 #include "rocketcore.h"
 
 typedef struct {
-  uint32_t TR_TE_CTRL;
-  uint32_t TR_TE_TARGET;
-  uint32_t TR_TE_HPM_COUNTER;
-  uint32_t TR_TE_HPM_TIME;
+  __IO uint32_t TR_TE_CTRL; //0x00
+  __I uint32_t TR_TE_INFO; //0x04
+  __IO uint32_t TR_TE_BUBBLE[6]; //0x08-0x1C
+  __IO uint32_t TR_TE_TARGET; //0x20
+  __IO uint32_t TR_TE_HPM_COUNTER; //0x24
+  __IO uint32_t TR_TE_HPM_TIME; //0x28
 } LTraceEncoderType;
 
 typedef struct {
-  uint32_t TR_SK_DMA_FLUSH;
-  uint32_t TR_SK_DMA_FLUSH_DONE;
-  uint64_t TR_SK_DMA_ADDR;
-  uint64_t TR_SK_DMA_COUNT;
+  __IO uint32_t TR_SK_DMA_FLUSH;
+  __I uint32_t TR_SK_DMA_FLUSH_DONE;
+  __IO uint64_t TR_SK_DMA_ADDR;
+  __I uint64_t TR_SK_DMA_COUNT;
 } LTraceSinkDmaType;
 
 #define TARGET_PRINT 0x0

examples/CMakeLists.txt

@@ -1,3 +1,4 @@
 add_subdirectory(blinky)
 add_subdirectory(embench)
-add_subdirectory(pmu-tests)
+add_subdirectory(pmu-tests)
+add_subdirectory(freertos)

examples/freertos/CMakeLists.txt

@@ -0,0 +1,45 @@
+if (USE_FREERTOS)
+
+  include(FetchContent)
+
+  FetchContent_Declare( freertos_kernel
+    GIT_REPOSITORY https://github.com/FreeRTOS/FreeRTOS-Kernel.git
+    GIT_TAG        V11.1.0
+  )
+
+  add_library(freertos_config INTERFACE)
+
+  target_include_directories(freertos_config SYSTEM
+  INTERFACE
+      include
+  )
+
+  target_compile_definitions(freertos_config
+    INTERFACE
+      projCOVERAGE_TEST=0
+  )
+
+  set( FREERTOS_HEAP "4" CACHE STRING "" FORCE)
+  # Select the native compile PORT
+  set( FREERTOS_PORT "GCC_RISC_V" CACHE STRING "" FORCE)
+
+  FetchContent_MakeAvailable(freertos_kernel)
+
+  add_executable(freertos_demo src/main.c src/main_blinky.c src/riscv-virt.c)
+
+  target_include_directories(freertos_demo PRIVATE
+    ${freertos_kernel_SOURCE_DIR}/include
+    ${CMAKE_CURRENT_SOURCE_DIR}/config  # For FreeRTOSConfig.h
+  )
+
+  target_link_libraries(freertos_demo
+    PUBLIC freertos_kernel freertos_config
+    PUBLIC chip-config
+    PUBLIC l_trace_encoder
+  )
+
+  target_link_libraries(freertos_demo PRIVATE 
+    -L${CMAKE_BINARY_DIR}/glossy -Wl,--whole-archive glossy -Wl,--no-whole-archive
+  )
+  
+endif()

examples/freertos/include/FreeRTOSConfig.h

@@ -0,0 +1,103 @@
+/*
+ * FreeRTOS V202212.00
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * https://www.FreeRTOS.org
+ * https://github.com/FreeRTOS
+ *
+ */
+
+#ifndef FREERTOS_CONFIG_H
+#define FREERTOS_CONFIG_H
+
+#include "riscv-virt.h"
+
+/*-----------------------------------------------------------
+ * Application specific definitions.
+ *
+ * These definitions should be adjusted for your particular hardware and
+ * application requirements.
+ *
+ * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
+ * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
+ *
+ * See http://www.freertos.org/a00110.html.
+ *----------------------------------------------------------*/
+
+/* See https://www.freertos.org/Using-FreeRTOS-on-RISC-V.html */
+#define configMTIME_BASE_ADDRESS		( CLINT_ADDR + CLINT_MTIME )
+#define configMTIMECMP_BASE_ADDRESS		( CLINT_ADDR + CLINT_MTIMECMP )
+
+#define configUSE_PREEMPTION			1
+#define configUSE_IDLE_HOOK				0
+#define configUSE_TICK_HOOK				1
+#define configCPU_CLOCK_HZ				( 1000000000 )
+#define configTICK_RATE_HZ				( ( TickType_t ) 100000 )
+#define configMAX_PRIORITIES			( 7 )
+#define configMINIMAL_STACK_SIZE		( ( unsigned short ) 512 )
+#define configTOTAL_HEAP_SIZE			( ( size_t ) 64500 )
+#define configMAX_TASK_NAME_LEN			( 16 )
+#define configUSE_TRACE_FACILITY		0
+#define configUSE_16_BIT_TICKS			0
+#define configIDLE_SHOULD_YIELD			0
+#define configUSE_MUTEXES				1
+#define configQUEUE_REGISTRY_SIZE		8
+#define configCHECK_FOR_STACK_OVERFLOW	2
+#define configUSE_RECURSIVE_MUTEXES		1
+#define configUSE_MALLOC_FAILED_HOOK	1
+#define configUSE_APPLICATION_TASK_TAG	0
+#define configUSE_COUNTING_SEMAPHORES	1
+#define configGENERATE_RUN_TIME_STATS	0
+#define configUSE_PORT_OPTIMISED_TASK_SELECTION 1
+
+/* Co-routine definitions. */
+#define configUSE_CO_ROUTINES 			0
+#define configMAX_CO_ROUTINE_PRIORITIES ( 2 )
+
+/* Software timer definitions. */
+#define configUSE_TIMERS				1
+#define configTIMER_TASK_PRIORITY		( configMAX_PRIORITIES - 1 )
+#define configTIMER_QUEUE_LENGTH		6
+#define configTIMER_TASK_STACK_DEPTH	( 110 )
+
+/* RISC-V definitions. */
+#define configISR_STACK_SIZE_WORDS		2048
+
+/* Task priorities.  Allow these to be overridden. */
+#ifndef uartPRIMARY_PRIORITY
+	#define uartPRIMARY_PRIORITY		( configMAX_PRIORITIES - 3 )
+#endif
+
+/* Set the following definitions to 1 to include the API function, or zero
+to exclude the API function. */
+#define INCLUDE_vTaskPrioritySet			1
+#define INCLUDE_uxTaskPriorityGet			1
+#define INCLUDE_vTaskDelete					1
+#define INCLUDE_vTaskCleanUpResources		1
+#define INCLUDE_vTaskSuspend				1
+#define INCLUDE_vTaskDelayUntil				1
+#define INCLUDE_vTaskDelay					1
+#define INCLUDE_eTaskGetState				1
+#define INCLUDE_xTimerPendFunctionCall		1
+#define INCLUDE_xTaskAbortDelay				1
+#define INCLUDE_xTaskGetHandle				1
+#define INCLUDE_xSemaphoreGetMutexHolder	1
+
+#endif /* FREERTOS_CONFIG_H */

examples/freertos/include/riscv-reg.h

@@ -0,0 +1,36 @@
+/*
+ * FreeRTOS V202212.00
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * https://www.FreeRTOS.org
+ * https://github.com/FreeRTOS
+ *
+ */
+
+#ifndef RISCV_REG_H_
+#define RISCV_REG_H_
+
+// we only target 64-bit riscv
+#define REGSIZE		8
+#define REGSHIFT	3
+#define LOAD		ld
+#define STOR		sd
+
+#endif /* RISCV_REG_H_ */

examples/freertos/include/riscv-virt.h

@@ -0,0 +1,52 @@
+/*
+ * FreeRTOS V202212.00
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * https://www.FreeRTOS.org
+ * https://github.com/FreeRTOS
+ *
+ */
+
+#ifndef RISCV_VIRT_H_
+#define RISCV_VIRT_H_
+
+#include "riscv-reg.h"
+
+#ifdef __ASSEMBLER__
+#define CONS(NUM, TYPE)NUM
+#else
+#define CONS(NUM, TYPE)NUM##TYPE
+#endif /* __ASSEMBLER__ */
+
+#define PRIM_HART			0
+
+#define CLINT_ADDR			CONS(0x02000000, UL)
+#define CLINT_MSIP			CONS(0x0000, UL)
+#define CLINT_MTIMECMP		CONS(0x4000, UL)
+#define CLINT_MTIME			CONS(0xbff8, UL)
+
+#ifndef __ASSEMBLER__
+
+int xGetCoreID( void );
+void vSendString( const char * s );
+
+#endif /* __ASSEMBLER__ */
+
+#endif /* RISCV_VIRT_H_ */