Initial Commit

Author: jetsonhacks

LICENSE

@@ -19,3 +19,5 @@ 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.
+
+

README.md

@@ -1,2 +1,20 @@
 # installACMModule
+MIT License
+
+Copyright (c) 2017 Jetsonhacks
+
 Install the CDC ACM Module for the Jetson TX1 or Jetson TX2 Development Kit
+
+On the NVIDIA Jetson TX2 and Jetson TX1 Development Kits running L4T 28.1, this script adds a module for USB Host functions to support Communication Device Class (CDC) Abstract Control Module (ACM) USB Devices.
+
+Typically these USB devices report as ttyACM* (where * is an integer). ACM devices have a lineage that goes back to modems and other network types of devices. However, many USB devices (such as an Arduino) are implemented using this simple USB protocol. The stock L4T 28.1 kernel does not have a CDC ACM module built in to the kernel, or as a separate module. This script adds cdc-acm.ko as a module so that such devices can be accessed through ttyACM*.
+
+To install:
+
+$ sudo ./installCDCACM.sh
+
+The script checks the version magic of the module and compares it to the kernel version running on the machine. If the two do not match, the user is asked if they still want to continue the installation. If the two match, the module is installed.
+
+Note that on a version mismatch, the user can still install the module. However, some extra steps may be needed after the installation to get the module installed fully. The steps are not covered here, but should be readily available elsewhere.
+
+ 

cdc-acm.ko

@@ -0,0 +1,32 @@
+#!/bin/bash
+# Install the cdc-acm module
+# First, does the module version magic match the current kernel version?
+
+MAGICVERSION=$(modinfo cdc-acm.ko | grep vermagic)
+MODULEVERSION=$(echo $MAGICVERSION | cut -d " " -f 2)
+KERNELVERSION=$(uname -r)
+if [ "$MODULEVERSION" == "$KERNELVERSION" ]
+then
+  echo "Kernel and Module Versions Match"
+else 
+  echo "The Kernel version does not match the Module Version"
+  echo "Kernel Version: " $KERNELVERSION
+  echo "Module Version: " $MODULEVERSION
+  while true; do
+  read -p "Would you still like to install the module? [Y/n] " response
+  case $response in
+    [Yy]* ) break ;;
+    [Nn]* ) exit;;
+    * ) echo "Please answer Yes or no. " ;;
+  esac
+  done
+  # The module version did not match the kernel version, but user selected to install anyway
+  echo "You may have to force the module to be inserted, i.e.  "
+  echo "$ sudo modprobe -f cdc-acm"
+fi
+# Install the cdc-acm module
+sudo cp -v cdc-acm.ko /lib/modules/$(uname -r)/kernel/drivers/usb/class
+sudo depmod -a
+echo "Installed cdc-acm Module"
+
+