From 33b9f8d90f5b53f4b5069db38b62e2ccf3fec9cb Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Tue, 10 Oct 2023 15:32:28 +1100 Subject: [PATCH] docs: remove old README Most of this information is out-of-date and no longer applies. Signed-off-by: Ivan Velickovic --- docs/README.md | 44 -------------------------------------------- 1 file changed, 44 deletions(-) delete mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 0121c031..00000000 --- a/docs/README.md +++ /dev/null @@ -1,44 +0,0 @@ - - - -## Building the example - - $ cd example - $ make - -The output will be `hello.sysbin` which is, eventually, intended to by a file that can be directly loaded onto a board using the board's regular bootloader. - - -## Bootstrapping memory - -In a perfect world, the newly propose [boot interface](https://sel4.discourse.group/t/pre-rfc-boot-interface/295/8) would already be in place. -This would allow for all the memory regions to be directly initialized by the loader. -However, pushing those changes will require significant time (and possibly reverification). -As such an alternative approach is required. -The initial images will need to be packed into the initial tasks image, and then the initial task (i.e. the platform runtime) will need to move memory about appropriately. - -The root server ELF image will need to be manipulated appropriately to include a packed memory image (as well as other data structures). - -## Microkit Library - -The header and source files for the library are in the `libmicrokit` directory. - -To compile against the library you need flags such as: - - -I$(LIBMICROKIT)/include -L$(LIBMICROKIT) -llibmicrokit - -Where LIBSELCP variable refers to the `libmicrokit` directory. - -Note: current state is that this is used in place. -Ftuture state is that this shall be merged with an seL4 SDK to simplify distribution and configuration. - -### Functions - -This section provides a brief summary of the functions made available in the Microkit Library. - -* `void microkit_dbg_putc(int c)`: Output a single character to the debug console. -* `void microkit_dbg_puts(const char *s)`: Output a string to the debug console. -