diff --git a/Documentation/platforms/misco/lm32/boards/misoc/README.txt b/Documentation/platforms/misco/lm32/boards/misoc/README.txt deleted file mode 100644 index d1aa014393..0000000000 --- a/Documentation/platforms/misco/lm32/boards/misoc/README.txt +++ /dev/null @@ -1,77 +0,0 @@ -Misoc README -============ - - This README applies to a port to NuttX running on a Qemu LM32 system. You - can find the Qemu setup at https://bitbucket.org/key2/qemu - - This initial release supports two UARTs, but does not have a system timer - or other peripherals. More to come. - -Buildroot Toolchain -=================== - - A GNU GCC-based toolchain is assumed. The PATH environment variable should - be modified to point to the correct path to the LM32 GCC toolchain (if - different from the default in your PATH variable). - - If you have no LM32 toolchain, one can be cloned from the NuttX - Bitbucket GIT repository (https://bitbucket.org/nuttx/buildroot). - This GNU toolchain builds and executes in the Linux or Cygwin environment. - - 1. You must have already configured NuttX in /nuttx. - - tools/configure.sh misoc: - make oldconfig context - - 2. Clone the latest buildroot package into /buildroot - - git clone git@bitbucket.org:nuttx/buildroot.git /buildroot - - or - - git clone https://patacongo@bitbucket.org/nuttx/buildroot.git /buildroot - - 3. cd /buildroot - - 4. cp lm32-elf-defconfig-6.1.0 .config - - 5. make oldconfig - - 6. make - - 7. By default, the tools will be at the absolute path: - - /buildroot/build_lm32/staging_dir/bin - - Or the NuttX relative path: - - ../buildroot/build_lm32/staging_dir/bin - - Make sure that he PATH variable includes the path to the newly built - binaries. - - See the file boards/README.txt in the buildroot source tree. That has more - detailed PLUS some special instructions that you will need to follow if you - are building a LM32 toolchain for Cygwin under Windows. Also included in - that README file is a FAQ of frequent build issues that their work-arounds. - - In order to use the buildroot toolchain, you also must set the following - in your .config file: - - CONFIG_LM3S_TOOLCHAIN_BUILDROOT=y - -boards/misoc/lm32/misoc/include/generated -=============================== - - In order to build this configuration, you must provide the - boards/misoc/lm32/misoc/include/generated directory. It contains the generated - Misoc files and may be a symbolic link. The base configuration will NOT - build without this directory! - - There is a sample generated directory at boards/misoc/include/generated-sample. - If you want to do a test build without generating the architecture, then - you can simply link this sample directory like: - - $ ln -s boards/misoc/lm32/misoc/include/generated-sample boards/misoc/lm32/misoc/include/generated - - That should permit a test build. diff --git a/Documentation/platforms/misco/lm32/boards/misoc/index.rst b/Documentation/platforms/misco/lm32/boards/misoc/index.rst index 0315364dee..f6c4b0db75 100644 --- a/Documentation/platforms/misco/lm32/boards/misoc/index.rst +++ b/Documentation/platforms/misco/lm32/boards/misoc/index.rst @@ -1,7 +1,81 @@ ===== -misoc +Misoc ===== -.. include:: README.txt - :literal: +This README applies to a port to NuttX running on a Qemu LM32 system. You can +find the Qemu setup at https://bitbucket.org/key2/qemu +This initial release supports two UARTs, but does not have a system timer or +other peripherals. More to come. + +Buildroot Toolchain +=================== + +A GNU GCC-based toolchain is assumed. The ``PATH`` environment variable should +be modified to point to the correct path to the LM32 GCC toolchain (if different +from the default in your ``PATH`` variable). + +If you have no LM32 toolchain, one can be cloned from the NuttX Bitbucket GIT +repository (https://bitbucket.org/nuttx/buildroot). This GNU toolchain builds +and executes in the Linux or Cygwin environment. + +1. You must have already configured NuttX in ``/nuttx``. + +.. code:: console + + $ tools/configure.sh misoc: + $ make oldconfig context + +2. Clone the latest buildroot package into /buildroot + +.. code:: console + + $ git clone git@bitbucket.org:nuttx/buildroot.git /buildroot + +or + +.. code:: console + + $ git clone https://patacongo@bitbucket.org/nuttx/buildroot.git /buildroot + +3. + +.. code:: console + + $ cd /buildroot + $ cp lm32-elf-defconfig-6.1.0 .config + $ make oldconfig + $ make + +4. By default, the tools will be at the absolute path: ``/buildroot/build_lm32/staging_dir/bin`` + + Or the NuttX relative path: ``../buildroot/build_lm32/staging_dir/bin`` + + Make sure that the PATH variable includes the path to the newly built binaries. + +See the file ``boards/README.txt`` in the buildroot source tree. That has more +detailed PLUS some special instructions that you will need to follow if you are +building a LM32 toolchain for Cygwin under Windows. Also included in that +README file is a FAQ of frequent build issues that their work-arounds. + +In order to use the buildroot toolchain, you also must set the following +in your ``.config`` file: ``CONFIG_LM3S_TOOLCHAIN_BUILDROOT=y`` + +``boards/misoc/lm32/misoc/include/generated`` +============================================= + +In order to build this configuration, you must provide the +``boards/misoc/lm32/misoc/include/generated`` directory. It contains the generated +Misoc files and may be a symbolic link. The base configuration will NOT build +without this directory! + +There is a sample generated directory at +``boards/misoc/include/generated-sample``. If you want to do a test build +without generating the architecture, then you can simply link this sample +directory like: + +.. code:: console + + $ ln -s boards/misoc/lm32/misoc/include/generated-sample boards/misoc/lm32/misoc/include/generated + +That should permit a test build.