Merge pull request #12 from JetsonHacksNano/dev

Update scripts

Author: JetsonHacksNano

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Issue report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the issue**
+Please describe the issue
+
+**Which version of Ubuntu on the Host machine**
+Ubuntu version:
+
+**What version of L4T/JetPack**
+L4T/JetPack version:
+
+**Which Jetson**
+Jetson:
+
+**To Reproduce**
+Steps to reproduce the behavior:
+For example, what command line did you run?
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 JetsonHacksNano
+Copyright (c) 2016-2021 Jetsonhacks
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,21 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+For the jetson_variables script
+
+This file is part of the jetson_stats package (https://github.com/rbonghi/jetson_stats or http://rnext.it).
+# Copyright (c) 2020 Raffaello Bonghi.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.

README.md

@@ -1,86 +1,126 @@
-# buildKernelAndModules
-Build the Linux Kernel and Modules on board the NVIDIA Jetson Nano Developer Kit
+## jetson-linux-build
+Tools to build the Linux kernel and modules on board Jetson Developer Kits
 
-These scripts are for JetPack 4.3, L4T 32.3.1
+This tool is meant for intermediate+ users. Please read this entire document before proceeding.
 
-Scripts to help build the 4.9.140 kernel and modules onboard the Jetson Nano Developer Kit Previous versions may be available in releases.
+Supports L4T Releases 32.4.2 through 32.6.1
 
-<em><strong>Note:</strong> The kernel source version must match the version of firmware flashed on the Jetson. For example, the source for the 4.9.140 kernel here is matched with L4T 32.3.1. This kernel compiled using this source tree may not work with newer versions or older versions of L4T</em>
+This repository contains convenience scripts to:
+* Download Kernel and Module sources (**B**oard **S**upport **P**ackage - **BSP**) 
+* Edit the kernel configuration
+* Build the kernel image
+* Build all of the kernel modules
+* Copy the Kernel Image to the /boot directory - This may not supported for newer versions of L4T - see below _**copyImage.sh deprecation (mostly)**_ 
+* An example to build a single kernel module (most useful)
 
-As of this writing, the "official" way to build the Jetson Nano kernel is to use a cross compiler on a Linux PC. This is an alternative which builds the kernel onboard the Jetson itself. These scripts will download the kernel source to the Jetson Nano, and then compile the kernel and selected modules. The newly compiled kernel can then be installed. We recommend a SD card size of 32GB, 64GB preferred.
+## Scripts
 
-The scripts should be run directly after flashing the Jetson, or copying the SD card image from a host PC. There are several scripts:
+### getKernelSources.sh
 
-<strong>getKernelSources.sh</strong>
+Downloads the kernel sources for L4T from the NVIDIA website and decompresses them into _/usr/src/_ . Note that this also sets the .config file to that of the current system, and sets the LOCALVERSION to the current local version, i.e., **-tegra**
 
-Downloads the kernel sources for L4T from the NVIDIA website, decompresses them and opens a graphical editor on the .config file. Note that this also sets the .config file to the current system, and also sets the local version to the current local version, i.e., -tegra
+### makeKernel.sh
 
+Please read the notes below about installing the kernel using copyImage.sh. Compiles the kernel using make. The script commands builds the kernel Image file. Installing the Image file on to the system is a separate step. 
 
-<strong>makeKernel.sh</strong>
+This and other parts of the kernel build, such as building the device tree, may require that the result be 'signed' and flashed from the the NVIDIA tools on a host PC.
 
-Compiles the kernel using make. The script commands make the kernel Image file. Installing the Image file on to the system is a separate step. Note that the make is limited to the Image and modules.
+### makeModules.sh
 
-The other parts of the kernel build, such as building the device tree, require that the result be 'signed' and flashed from the the NVIDIA tools on a host PC.
+Compiles all of the the modules on the system using make and then installs them. You more than likely not want to do this. Instead, look at the script **build-module.sh** in the _example_ directory for an outline on how to build a single module.
 
-<strong>makeModules.sh</strong>
+### copyImage.sh
 
-Compiles the modules using make and then installs them.
+Please read the notes below under _**Background Notes**_ about installing the kernel image. This script copies the Image file created by compiling the kernel to the _**/boot**_ directory. Note that while developing you will want to be more conservative than this: You will probably want to copy the new kernel Image to a different name in the boot directory, and modify _**/boot/extlinux/extlinux.conf**_ to have entry points at the old image, or the new image. This way, if things go sideways you can still boot the machine using the serial console.
 
-<strong>copyImage.sh</strong>
+You will want to make a copy of the original Image before the copy, something like:
+```
+$ cp /boot/Image $INSTALL_DIR/Image.orig
+$ ./copyImage.sh
+$ echo "New Image created and placed in /boot"
+```
+You may need to modify the _/boot/extlinux/extlinux.conf_ to reflect the changes. 
 
-Copies the Image file created by compiling the kernel to the /boot directory. Note that while developing you will want to be more conservative than this: You will probably want to copy the new kernel Image to a different name in the boot directory, and modify /boot/extlinux/extlinux.conf to have entry points at the old image, or the new image. This way, if things go sideways you can still boot the machine using the serial console.
+### editConfig.sh 
+Edit the .config file located in _**/usr/src/kernel/kernel-4.9**_ This file must be present (from the getKernelSources.sh script) before launching the file. Note that if you change the local version, you will need to make both the kernel and modules and install them.
 
-You will want to make a copy of the original Image before the copy, something like:
+### removeAllKernelSources.sh
 
-$ cp /boot/Image $INSTALL_DIR/Image.orig<br>
-$ ./copyImage.sh<br>
-$ echo "New Image created and placed in /boot"<br>
+Removes all of the kernel sources and compressed source files. You may want to make a backup of the files before deletion.
 
+### Example - build-module.sh
+The most likely use for these scripts is to build kernel module(s). In the example folder, there is a script named _**build-module.sh**_
+You should open the script, read through it, and modify to meet your needs. The script builds a module for the Logitech F710 game controller. The module name is **hid-logitech.ko**
 
-<strong>editConfig.sh</strong>
-Edit the .config file located in /usr/src/kernel/kernel-4.9 This file must be present (from the getKernelSources.sh script) before launching the file. Note that if you change the local version, you will need to make both the kernel and modules and install them.
+You will need to know the module flag to use this method, in this case it is: **LOGITECH_FF** 
 
-<strong>removeAllKernelSources.sh</strong>
-Removes all of the kernel sources and compressed source files. You may want to make a backup of the files before deletion.
 
-<h2>Notes:</h2> 
-<h3>Make sure to update the micro SD card</h3>
+## Background Notes
+Over the years, we have been maintaining several different repositories here and on https://github.com/jetsonhacks to build the Linux kernel and modules for the various NVIDIA Jetson models:
 
-The copyImage.sh script copies the Image to the current device. If you are building the kernel on an external device, for example a USB drive, you will probably want to copy the Image file over to the micro SD card in the micro SD's /boot directory. 
-Special thanks to Raffaello Bonghi (https://github.com/rbonghi) for jetson_easy scripts.
-Special thanks to Shreeyak (https://github.com/Shreeyak) for discussing alternatives to get source directly from NVIDIA git repositories.
-Special thanks to Dustin Franklin (https://github.com/dusty-nv/) for how to correctly determine the correct L4T version. (https://github.com/dusty-nv/jetson-inference/blob/7e81381a96c1ac5f57f1728afbfdec7f1bfeffc2/tools/install-pytorch.sh#L296) 
+* Jetson Nano
+* Jetson Nano 2GB
+* Jetson TX1
+* Jetson TX2
+* Jetson AGX Xavier
+* Jetson Xavier NX
+
+The main difficulty of this approach is that there are several different repositories to maintain across NVIDIA L4T releases.
+
+There are two different versions of BSP source code for each NVIDIA L4T release. One version is for the Jetson Nano, Nano 2GB and TX1 named **T210**. The other version is for the Jetson TX2, AGX Xavier, and Xavier NX named **T186**. The only difference in building the kernel from machine to machine is where to download the BSP sources from for a given release. The idea of this repository is to place these URLs into an associative array to lookup given the L4T release version.
+
+The other procedures have remained the same over the years, except for placing items in the _**/boot**_ directory. The placement of the Linux kernel image, device tree and extlinux.conf may be different based on the Jetson model and L4T release.
+
+### copyImage.sh deprecation (mostly)
+There has been an architectural shift on different Jetson models to provide better security. These changes are implemented differently on each model, depending on hardware capabilities and bootloaders of the Jetson module in question. Several system files, such as but not limited to the Linux kernel and device tree, may now be signed. 
 
-Sometimes it is useful to log the builds:
+For example, on the Jetson Xaviers the kernel is PKC Signed and has SBK encryption in the newer releases. Currently, the NVIDIA approved application to sign these files is an x86 app running on the host machine.
 
-$ command 2>&1 | tee log.txt
+Additionally, there are Jetsons which place the **/boot** folder into the onboard QSPI-NOR flash memory to be read at boot time, rather than reading it from the **APP** partition. Consequently the developer needs to know where/how to place a newly created kernel and support code. 
 
-so you can go back and catch errors.
+The copyImage.sh script may be helpful depending on the Jetson model and L4T release it is being used with. However, on some releases or Jetson models it may not work, or give a false sense of hope of actually doing something. 
 
-<h4>Intended Use</h4>
-The intended use of this repository is to help automate building known configurations of the kernel and build modules. You should use the kernel-4.9/scripts/config script to set the kernel configuration that you desire. See the 'rootOnUSB' repository on the JetsonHacksNano Github account for an example.
+### So what good are these scripts?
+One thing that the scripts are useful for is building external kernel modules. People can build the modules on the device without having to go through the steps of setting up a development environment on the host, building the module, and transferring it to the Jetson. Instead, build the module on the Jetson and then install it.
 
-### Release Notes
-<b>December, 2019</b>
+## Release Notes
+
+### September, 2021
+* v1.0
+* Initial Release - Build 32.4.2 through 32.6.1
+* Unification of build methods across Jetson platform
+  * Jetson Nano, Nano 2GB, TX1, TX2, AGX Xavier, Xavier NX
+* Associative lookup of BSP source code via L4T Release name
+* L4T Releases 32.4.2 through 32.6.1
+* Tested on Jetson Nano, Jetson Xavier NX
+
+### December, 2019
 * vL4T32.3.1
 * L4T 32.3.1 (JetPack 4.3)
 * Minor version update
 
-<b>November, 2019</b>
+### November, 2019
 * vL4T32.2.3
 * L4T 32.2.3 (JetPack 4.2.2)
 * Minor version update
 
-<b>October, 2019</b>
+### October, 2019
+
 * vL4T32.2.1
 * L4T 32.2.1 (JetPack 4.2.1)
 * Better release version parsing
 
-<b>July, 2019</b>
+### July, 2019
 * vL4T32.2
 * L4T 32.2 (JetPack 4.2.1)
 
-<b>June, 2019</b>
+### June, 2019
 * vL4T32.1
 * L4T 32.1 (JetPack 4.2)
-* Initial Release 
+* Initial Release
+
+Special thanks to Raffaello Bonghi (https://github.com/rbonghi) for jetson_easy scripts.
+
+Special thanks to Shreeyak (https://github.com/Shreeyak) for discussing alternatives to get source directly from NVIDIA git repositories.
+
+

copyImage.sh

@@ -1,50 +1,10 @@
 #!/bin/bash
-# Copy the kernel image to /boot for NVIDIA Jetson Nano Developer Kit, L4T
-# Copyright (c) 2016-19 Jetsonhacks 
+# Copy the kernel image on NVIDIA Jetson Developer Kit
+# Copyright (c) 2016-21 Jetsonhacks 
 # MIT License
 
-SOURCE_TARGET="/usr/src"
-BOOT_TARGET="/boot/"
-KERNEL_RELEASE="4.9"
-
-function usage
-{
-    echo "usage: ./makeKernel.sh [[-d directory ]  | [-h]]"
-    echo "-d | --directory Directory path to parent of kernel"
-    echo "-b | --boot  Directory path to boot"
-    echo "-h | --help  This message"
-}
-
-# Iterate through command line inputs
-while [ "$1" != "" ]; do
-    case $1 in
-        -d | --directory )      shift
-				SOURCE_TARGET=$1
-                                ;;
-        -b | --boot )           shift
-				BOOT_TARGET=$1
-                                ;;
-        -h | --help )           usage
-                                exit
-                                ;;
-        * )                     usage
-                                exit 1
-    esac
-    shift
-done
-
-LAST="${SOURCE_TARGET: -1}"
-if [ $LAST != '/' ] ; then
-   SOURCE_TARGET="$SOURCE_TARGET""/"
-fi
-LAST="${BOOT_TARGET: -1}"
-if [ $LAST != '/' ] ; then
-   BOOT_TARGET="$BOOT_TARGET""/"
-fi
-
+SOURCE_TARGET="/usr/src/"
+KERNEL_RELEASE=$( uname -r | cut -d. -f1-2) # e.g. 4.9
 export SOURCE_TARGET
-export BOOT_TARGET
 export KERNEL_RELEASE
-
-# E Option carries over environment variables
 sudo -E ./scripts/copyImage.sh

editConfig.sh

@@ -1,10 +1,10 @@
 #!/bin/bash
-# Edit the kernel configuration for NVIDIA Jetson Nano Developer Kit, L4T
-# Copyright (c) 2016-19 Jetsonhacks 
+# Edit the kernel configuration for NVIDIA Jetson Developer Kit
+# Copyright (c) 2016-21 Jetsonhacks 
 # MIT License
 
 SOURCE_TARGET="/usr/src"
-KERNEL_RELEASE="4.9"
+KERNEL_RELEASE=$( uname -r | cut -d. -f1-2) # e.g. 4.9
 
 function usage
 {

example/build-module.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+# Example to build Logitech F710 module on NVIDIA Jetson Developer Kit
+# Copyright (c) 2016-21 Jetsonhacks 
+# MIT License
+# build the hid-logitech.ko module with Logitech F710 support
+# We need the kernel sources installed
+
+SOURCE_TARGET="/usr/src/"
+KERNEL_RELEASE=$( uname -r | cut -d. -f1-2)
+KERNEL_URI=$SOURCE_TARGET"kernel/kernel-"$KERNEL_RELEASE
+if [ ! -d "$KERNEL_URI" ] ; then
+  echo "Cannot find kernel source in $SOURCE_TARGET."
+  echo "You will need to install the kernel source before proceeding."
+  exit 1
+fi
+
+cd "$KERNEL_URI"
+
+sudo bash scripts/config --file .config \
+	--set-val LOGITECH_FF y
+sudo make modules_prepare
+sudo make drivers/hid/hid-logitech.ko
+
+echo "Build complete."
+echo "The module is here: ${KERNEL_URI}/drivers/hid/hid-logitech.ko"
+echo "To install the module:"
+echo " "
+
+INSTALL_DIRECTORY=/lib/modules/$(uname -r)/kernel/drivers/hid
+echo "$ sudo cp -v ${KERNEL_URI}/drivers/hid/hid-logitech.ko $INSTALL_DIRECTORY"
+echo "$ sudo depmod -a"
+
+echo ""
+echo "You may need to reboot for the changes to take effect."
+
+
+
+