diff --git a/README.md b/README.md index f8bef5b8..7365460f 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ To ensure you have the necessary dependencies for building the CAmkES VM project To build an application with this project we use CMake. This repo provides a series of CMake helper functions (found in `camkes_vm_helpers.cmake`) to assit you with defining your CAmkES VM application. Importing this file into your applications CMake configuration gives you access to the following helper functions: - `DeclareCAmkESVM(init_component [SOURCES INCLUDES LIBS LD_FLAGS C_FLAGS])`: Function for declaring a CAmkESVM. This is called for each Init component in the defined in the applications `.camkes` file. The user can also pass in extra compilation sources, includes, libs and flags to be compiled with the component through additional arguments (`SOURCES`, `INCLUDES`, `LIBS`, `LD_FLAGS` and `C_FLAGS`) -- `DeclareCAmkESVMRootServer(camkes_config)`: Declares the CAmkESVM root server. This function takes the applications `.camkes` file as an argument (`camkes_config`). - `DefineCAmkESVMFileServer([TYPE ] [INSTANCE ] [FILES [ [...]] [DEPENDS [ [...]])`: Function for explicitly creating a file server with the given files. This takes into account any files that have been added before via calls to `AddToFileServer()`. This is called internally from `DeclareCAmkESVMRootServer()`. - `DecompressLinuxKernel(decompress_target decompressed_kernel_image compressed_kernel_image [DEPENDS])`: Function for decompressing/extracting a vmlinux file from a given kernel image. The caller specifies a target name (`decompress_target`) for decompressing the kernel, the kernel image to decompress (`compressed_kernel_image`) and additional dependencies to the compressed image through the optional `DEPENDS` parameter. The location of the decompressed image is populated in the `decompressed_kernel_image` parameter passed by the caller. +- `DeclareCAmkESRootserver()`. Declare the the CAmkES Root Server that sets up the system. ## Items diff --git a/camkes_vm_helpers.cmake b/camkes_vm_helpers.cmake index 20b49ea7..afa3dc14 100644 --- a/camkes_vm_helpers.cmake +++ b/camkes_vm_helpers.cmake @@ -200,29 +200,6 @@ function(DefineCAmkESVMFileServer) endfunction(DefineCAmkESVMFileServer) -# Function for declaring the CAmkESVM root server. Taking the camkes application -# config file we declare a CAmkES Root server and the VM File Server. It is -# expected the caller has declared the file server images before using this -# function. -# camkes_config: The applications .camkes file -# In addition the user can pass in extra CPP compilation includes and flags through -# the CPP_INCLUDES and CPP_FLAGS arguments. -function(DeclareCAmkESVMRootServer camkes_config) - cmake_parse_arguments(PARSE_ARGV 1 CAMKES_ROOT_VM "" "" "CPP_INCLUDES;CPP_FLAGS") - # Initialise the CAmKES VM fileserver - DefineCAmkESVMFileServer() - get_absolute_source_or_binary(config_file "${camkes_config}") - # Declare CAmkES root server - DeclareCAmkESRootserver( - ${config_file} - CPP_FLAGS - ${CAMKES_ROOT_VM_CPP_FLAGS} - CPP_INCLUDES - "${VM_PROJECT_DIR}/components/VM" - ${CAMKES_ROOT_VM_CPP_INCLUDES} - ) -endfunction(DeclareCAmkESVMRootServer) - # Function for decompressing/extracting a vmlinux file from a given kernel image # decompress_target: The target name the caller wishes to use to generate the decompressed kernel # image