diff --git a/README.md b/README.md index 0d2d2a2e..54c0580e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The purpose of the seL4 Microkit is to enable system designers to create static The seL4 Microkit consists of three parts: - * Microkit Library + * Microkit library * Microkit initial task * Microkit tool @@ -150,22 +150,30 @@ The SDK top-level directory is `microkit-sdk-$VERSION`. The directory layout underneath the top-level directory is: ``` +doc/ +doc/microkit_user_manual.pdf bin/ bin/microkit +board/ board/$board/$config/include/ board/$board/$config/include/microkit.h board/$board/$config/lib/ board/$board/$config/lib/libmicrokit.a board/$board/$config/lib/microkit.ld -board/$board/$config/elf +board/$board/$config/elf/ board/$board/$config/elf/loader.elf -board/$board/$config/elf/kernel.elf +board/$board/$config/elf/sel4.elf board/$board/$config/elf/monitor.elf ``` -The currently supported boards: +The currently supported boards are: +* imx8mm_evk +* imx8mq_evk +* odroidc2 +* odroidc4 * tqma8xqp1gb +* zcu102 The currently supported configurations are: @@ -174,18 +182,7 @@ The currently supported configurations are: ## Supported Boards -### tqma8xqp-1gb - -The TQMa8Xx Embedded Module from TQ Group configured with the NXP i.MX8QXP SoC and 1GiB of DDR3 ECC memory. - -https://www.tq-group.com/en/products/tq-embedded/arm-architecture/tqma8xx/ - -All testing has been performed with the module on the MBa8Xx carrier board which is included in the starter kit. - -The provided board support should be at the module level and does not make any assumptions about the carrier board. - -Note: There are different configured of the TQMa8Xx board which include different NXP SoCs and different memory configurations. -Such modules are not supported. +For documentation on each supported board see the [manual](https://github.com/seL4/microkit/blob/main/docs/manual.md#board-support-packages-bsps). ## Supported Configurations diff --git a/docs/manual.md b/docs/manual.md index 9e137cb6..b8a0c8e4 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -82,7 +82,7 @@ The [Microkit tool](#tool) chapter describes the host system tool used for gener The [libmicrokit](#libmicrokit) chapter describes the interfaces to the Microkit library. -The [System Description Format](#sysdesc) chapter describes the format of the system description XML file. +The [System Description File](#sysdesc) chapter describes the format of the system description XML file. The [Board Support Packages](#bsps) chapter describes each of the board support packages included in the SDK. @@ -425,17 +425,17 @@ Returns the label from a message. Get a message register. -## `void microkit_mr_set(uint8_t mr, uint64_t)` +## `void microkit_mr_set(uint8_t mr, uint64_t value)` Set a message register. -# System Description Format {#sysdesc} +# System Description File {#sysdesc} -This section describes the format of the system description file. -This file is provided as the input to the `microkit` tool. +This section describes the format of the System Description File (SDF). -The system description file is an XML file. +The system description file is an XML file that is provided as input to the +`microkit` tool. The root element of the XML file is `system`. @@ -562,6 +562,9 @@ TQ-Systems provide the MBa8Xx carrier board for development purposes. The instructions provided assume the use of the MBa8Xx carrier board. If you are using a different carrier board please refer to the appropriate documentation. +Note: There are different configured of the TQMa8Xx board which include different NXP SoCs +and different memory configurations. Such modules are not supported. + The MBa8Xx provides access to the TQMa8XQP UART via UART-USB bridge. To access the UART connect a USB micro cable to port **X13**. The UART-USB bridge supports 4 individual UARTs; the UART is connected to the 2nd port. @@ -625,8 +628,6 @@ Microkit produces a raw binary file, so when using U-Boot you must execute the i => go 0x40000000 -Note that the loading address must be `0x40000000`. - For simulating the ZCU102 using QEMU, use the following command: $ qemu-system-aarch64 \