Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #336 #364

Merged
merged 3 commits into from
Sep 19, 2023
Merged

Fix #336 #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e305ae
Added the possibility of including an external_crt0.S
JuanSapriza Aug 10, 2023
5e3baaa
Added comments to separate sections
JuanSapriza Aug 10, 2023
f90408b
Updated the eXtendingHEEP documentation
JuanSapriza Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions eXtendingHEEP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,10 @@ The following is an example repository folder structure.
│ │ ├── your_copro.h
│ │ └── your_copro_defs.h -> ../../../../hw/vendor/your_copro/sw/your_copro_defs.h
│ └── extensions
│ └── your_copro_x_heep.h
│ │ └── your_copro_x_heep.h
│ └── lib
│ └── crt
│ └── external_crt0.S
├── hw
│ └── vendor
│ ├── your_copro
Expand Down Expand Up @@ -276,8 +279,9 @@ In the `external` folder you can add whatever is necessary for software to work

* Sources and header files
* Soft links to folders or files.
* A `lib/crt/` directory with and `exteral_crt0.S` file (will be included inside `BASW/sw/device/lib/crt/crt0.S`).

The external folder or any of its subdirectories cannot contain neither a `device` nor a `applications` folder as it would collide with the respective folders inside `BASE/sw/`. It should also not contain a `main.c` file.
The external folder or any of its subdirectories cannot contain neither a `device` nor an `applications` folder as it would collide with the respective folders inside `BASE/sw/`. It should also not contain a `main.c` file.

### The BASE/Makefile
The `BASE/Makefile` is your own custom Makefile. You can use it as a bridge to access the Makefile from `X-HEEP`.
Expand Down
107 changes: 95 additions & 12 deletions sw/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ set(CMAKE_CXX_STANDARD 14)
SET(MAINFILE "main")


#######################################################################
# FIND HEADER FILES TO BE INCLUDED
#######################################################################

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Preliminary list of header files inside the source path

# Make a list of the header files that need to be included
FILE(GLOB_RECURSE new_list FOLLOW_SYMLINKS ${SOURCE_PATH}*.h)
SET(dir_list_str "")
Expand All @@ -72,6 +79,9 @@ FOREACH(file_path ${new_list})
SET(add 1)
endif()

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Prune list

if( add EQUAL 1 ) # If the file path mathced one of the criterion, add it to the list
# Get the path of the obtained directory
GET_FILENAME_COMPONENT(dir_path ${file_path} PATH)
Expand All @@ -90,7 +100,8 @@ ENDFOREACH()
LIST(REMOVE_DUPLICATES dir_list_str)
LIST(REMOVE_DUPLICATES h_dir_list_)

message(STATUS "[INFO] ${dir_list_str}")
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Add list to the directories to be included

# Get all the folders to include when linking
SET(INCLUDE_FOLDERS "-I ${RISCV}/${COMPILER_PREFIX}elf/include \
Expand All @@ -100,6 +111,13 @@ SET(INCLUDE_FOLDERS "-I ${RISCV}/${COMPILER_PREFIX}elf/include \
${dir_list_str}")


#######################################################################
# FIND SOURCE FILES TO BE INCLUDED
#######################################################################

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Preliminary list of source files inside the source path

# Make a list of the source files that need to be linked
FILE(GLOB_RECURSE new_list FOLLOW_SYMLINKS ${SOURCE_PATH}*.c)
SET( c_dir_list "" )
Expand All @@ -124,7 +142,9 @@ FOREACH(file_path IN LISTS new_list)

ENDFOREACH()

# If the app did not exist in the provided path, try with the root project
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# If the app was not found, look into the root project

if( app_found EQUAL 0 )
SET(SOURCE_PATH ${ROOT_PROJECT})

Expand All @@ -150,6 +170,10 @@ endif()

LIST(REMOVE_DUPLICATES c_dir_list)

#######################################################################
# DETERMINE IF APP IS EXTERNAL
#######################################################################

# Determine whether the target app is located in the root project or in an external folder
if( ${SOURCE_PATH} STREQUAL ${ROOT_PROJECT} )
SET( internal_app 1 )
Expand All @@ -159,6 +183,47 @@ else()
message( "${Magenta}External application${ColourReset}")
endif()

#######################################################################
# FIND CRT FILES TO BE INCLUDED
#######################################################################

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Set the default CRT directories

SET(LIB_CRT_P "${ROOT_PROJECT}device/lib/crt/crt0.S")
SET(LIB_VCTR_P "${ROOT_PROJECT}device/lib/crt/vectors.S")

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Look for external CRT files

SET(CRTO "INTERNAL_CRTO")
SET( LIB_CRT_EXT_P "" )
if( internal_app EQUAL 0 )
FILE(GLOB_RECURSE new_list FOLLOW_SYMLINKS "${SOURCE_PATH}/external/lib/crt/*.S")
FOREACH(file_path IN LISTS new_list)
if(${file_path} MATCHES "external_crt0.S")
SET( CRTO "EXTERNAL_CRTO" )
SET( LIB_CRT_EXT_P "${file_path}" )
GET_FILENAME_COMPONENT(dir_path ${file_path} PATH)
SET(INCLUDE_FOLDERS "${INCLUDE_FOLDERS} -I ${dir_path}")
SET(h_dir_list_ ${h_dir_list_} "${dir_path}")
endif()
ENDFOREACH()
endif()

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# In case of a freertos based app

if(${PROJECT} MATCHES "freertos")
#SET(LIB_CRT_P "${SOURCE_PATH}device/lib/crt_freertos/")
SET(LIB_VCTR_P "${SOURCE_PATH}device/lib/crt/vectors_freertos.S")
endif()


#######################################################################
# SET CRT AND LINKER TYPE
#######################################################################

# Get the correct path for the crt files and linker file
if (${LINKER} STREQUAL "on_chip")
#SET(LIB_CRT_P "${SOURCE_PATH}device/lib/crt/")
Expand All @@ -175,16 +240,11 @@ elseif(${LINKER} STREQUAL "flash_exec")
else()
message( FATAL_ERROR "Linker specification is not correct" )
endif()
SET(LIB_CRT_P "${SOURCE_PATH}device/lib/crt/")
SET(LIB_VCTR_P "${LIB_CRT_P}vectors.S")

# Just in case it is a freertos based app
if(${PROJECT} MATCHES "freertos")
#SET(LIB_CRT_P "${SOURCE_PATH}device/lib/crt_freertos/")
SET(LIB_VCTR_P "${SOURCE_PATH}device/lib/crt/vectors_freertos.S")
endif()
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Debug messages to check the paths

# messages to check the paths
message(STATUS "[INFO] ${INCLUDE_FOLDERS}")
message( "${Magenta}Current project: ${PROJECT}${ColourReset}")
message( "${Magenta}Root project: ${ROOT_PROJECT}${ColourReset}")
message( "${Magenta}Source path: ${SOURCE_PATH}${ColourReset}")
Expand All @@ -195,13 +255,24 @@ message( "${Magenta}Targetting folder: ${INC_FOLDERS}${ColourReset}")
message( "${Magenta}Target: ${TARGET}${ColourReset}")


#######################################################################
# SET LINKER PROPERTIES
#######################################################################

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Set linked files

# Get all the files to include when linking
SET(LINKED_FILES "${LIB_CRT_P}crt0.S \
SET(LINKED_FILES "${LIB_CRT_P} \
${LIB_VCTR_P} \
${LIB_CRT_EXT_P} \
${c_dir_list}")

message( "${Magenta}Linked files: ${LINKED_FILES}${ColourReset}")

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Free-RTOS configurations

# fetch content from freertos kernel repository
FetchContent_Declare( freertos_kernel
GIT_REPOSITORY https://github.com/FreeRTOS/FreeRTOS-Kernel.git
Expand All @@ -228,12 +299,16 @@ if(${PROJECT} MATCHES "freertos")
FetchContent_MakeAvailable(freertos_kernel)
endif()

# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# Set CMAKE flags

# specify the C standard
set(COMPILER_LINKER_FLAGS "\
-march=${CMAKE_SYSTEM_PROCESSOR} \
-w -Os -g -nostdlib \
-DHOST_BUILD \
-D${CRT_TYPE} \
-D${CRTO} \
-DportasmHANDLE_INTERRUPT=vSystemIrqHandler\
")
set(CMAKE_C_FLAGS ${COMPILER_LINKER_FLAGS})
Expand All @@ -256,6 +331,10 @@ endif()
#add_subdirectory(device/lib/drivers)
#add_subdirectory(device/lib/runtime)

#######################################################################
# SET TARGETS
#######################################################################

set(SOURCES ${SOURCE_PATH}applications/${PROJECT}/${MAINFILE}.c)

# add the executable
Expand Down Expand Up @@ -316,6 +395,10 @@ if (${COMPILER} MATCHES "clang")
endif()
endif()

#######################################################################
# SET CUSTOM COMMANDS
#######################################################################

# Post processing command to create a disassembly file
add_custom_command(TARGET ${MAINFILE}.elf POST_BUILD
COMMAND ${CMAKE_OBJDUMP} -S ${MAINFILE}.elf > ${MAINFILE}.disasm
Expand Down Expand Up @@ -351,4 +434,4 @@ endforeach()

SET(DCMAKE_EXPORT_COMPILE_COMMANDS ON)

#message( FATAL_ERROR "You can not do this at all, CMake will exit." )
#message( FATAL_ERROR "You can not do this at all, CMake will exit." )