From 7b11bd87b38c10458eb6cd6d39fc2ca61caeb90f Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Thu, 11 Jan 2024 18:40:15 +1100 Subject: [PATCH 1/9] manual: remove ZCU102 note The wording is a bit weird and probably unecessary. If someone does not follow the instructions, it will be pretty clear that they have not since the system will crash. Signed-off-by: Ivan Velickovic --- docs/manual.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/manual.md b/docs/manual.md index 9e137cb6..5b7991f4 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -625,8 +625,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 \ From f475084987fa0d3d15ba83b03bdbf4ec0f3fe790 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Thu, 11 Jan 2024 18:42:44 +1100 Subject: [PATCH 2/9] manual: fix function declaration Signed-off-by: Ivan Velickovic --- docs/manual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manual.md b/docs/manual.md index 5b7991f4..d8bc967d 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -425,7 +425,7 @@ 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. From f0c1c45e37f8926eda4a0b49ff18fd5f3d5d04fc Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Thu, 11 Jan 2024 18:46:02 +1100 Subject: [PATCH 3/9] manual: rename System Description Format System Description File (SDF) is better when referring to the system description of a Microkit system. It's easier to say SDF format than SDF file. Signed-off-by: Ivan Velickovic --- docs/manual.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/manual.md b/docs/manual.md index d8bc967d..4d4b25cc 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. @@ -430,12 +430,12 @@ Get a message register. 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`. From a5f8957d15ede2729bcbed98f992715449284222 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Thu, 11 Jan 2024 18:56:29 +1100 Subject: [PATCH 4/9] README: SDK layout fixes Signed-off-by: Ivan Velickovic --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d2d2a2e..0c3a0bf9 100644 --- a/README.md +++ b/README.md @@ -150,14 +150,17 @@ 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/monitor.elf From 65cdd3fbf95de979c5eb529eaf80689ba6d7b3f9 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Thu, 11 Jan 2024 18:56:44 +1100 Subject: [PATCH 5/9] README: changes to supported boards listed There is little benefit to duplicating the information for each board supported in the README. Listing the supported boards is sufficient. Signed-off-by: Ivan Velickovic --- README.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 0c3a0bf9..89cd821e 100644 --- a/README.md +++ b/README.md @@ -166,9 +166,10 @@ board/$board/$config/elf/kernel.elf board/$board/$config/elf/monitor.elf ``` -The currently supported boards: +The currently supported boards are: * tqma8xqp1gb +* zcu102 The currently supported configurations are: @@ -177,18 +178,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 From 3456c3998efad8bb62cfdb4bb9a6d9602ae30149 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Tue, 13 Feb 2024 20:35:55 +1100 Subject: [PATCH 6/9] README: update list of supported boards Signed-off-by: Ivan Velickovic --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 89cd821e..77141765 100644 --- a/README.md +++ b/README.md @@ -168,6 +168,10 @@ board/$board/$config/elf/monitor.elf The currently supported boards are: +* imx8mm_evk +* imx8mq_evk +* odroidc2 +* odroidc4 * tqma8xqp1gb * zcu102 From 303309af4c30fbe970c1e77216552a95d4bc4e58 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Tue, 13 Feb 2024 20:36:07 +1100 Subject: [PATCH 7/9] README style fix Signed-off-by: Ivan Velickovic --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 77141765..06ddc689 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 From cb8f6441155c7f4946037297adb02a46cbbfa1b8 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Wed, 28 Feb 2024 12:47:13 +1100 Subject: [PATCH 8/9] manual: make a note about TQMa8XQP support Signed-off-by: Ivan Velickovic --- docs/manual.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/manual.md b/docs/manual.md index 4d4b25cc..b8a0c8e4 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -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. From 2c283c5b8bf64e9a803e5e0366ef6b5c825c48f0 Mon Sep 17 00:00:00 2001 From: Ivan Velickovic Date: Wed, 28 Feb 2024 12:48:40 +1100 Subject: [PATCH 9/9] README: fix in SDK layout Signed-off-by: Ivan Velickovic --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 06ddc689..54c0580e 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,7 @@ board/$board/$config/lib/libmicrokit.a board/$board/$config/lib/microkit.ld 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 ```