Driver Disk Installation Guide for ARC-11XX/ARC12XX/ARC16XX/18XX RAID Controller 
on TrueNAS-SCALE 22.02.4 amd64(kernel 5.10.142+truenas)
=================================================================================
=================================================================================
Linux SCSI driver technical support 
Mail address: support@areca.com.tw
Web site: www.areca.com.tw
==================================================================================
==================================================================================

**********************************************************************************   
1. Contents
**********************************************************************************
readme.txt	- the installation guide of ARC-11XX/12XX/16XX/18XX driver for TrueNAS-SCALE
arcmsr-TrueNAS-SCALE-22.02.4.zip	  - Areca RAID driver disk for system installation
arcmsr_1.50.0X.12-TNS22.02.4_amd64.deb    - driver for x86_64
arcmsr-1.50.0X.12-20220804.zip		  - driver source code
arcmsr-1.50.00.12-source-only.dkms.tar.gz - DKMS enabled driver source code
genkey.cfg	- configuration file for generating public and private key pair
public_key.der	- public key for pre-compiled driver arcmsr in .rpm and .iso first time installation

**********************************************************************
2. System Installation                                 	    **
**********************************************************************

    TrueNAS-SCALE 22.02.4 kernel default driver has support Areca all Raid controllers.
    So just following the installation guide to install system to on-board hard drive or Areca Raid volume.
    In case of installation to Areca Raid volume, 
    you should first create a Raid volume by reference to Areca Raid controllers user's manual.

    If you would like system boots with UEFI Secure Boot, following condition must be satisfied in BIOS setup.
    Or system may not boot properly.
	1. Set "Secure Boot" to "Enabled".
	2. Set "Secure Boot Mode" to "Custom".
	3. Set "Csm support" to "Disabled".
	4. Install all manufacture defaults to Platform Key(PK), Key Exchange Key(KEK), Authorized Signatures(DB), 
	   Forbidden Signatures(DBX).
	5. Set "CPU slot PCI-E Device OPROM (Option ROM)" to "EFI" or "UEFI", if any.
	6. Areca Raid controller System controls->Advanced configuration->BISO selection set to UEFI or AUTO. 
	  (This can be done by web browser through Raid controller Ethernet port. Please refer to areca Raid controller user manual.)
	7. OS is 64 bits version, CPU is 64 bits, and both support UEFI specification.


    For install TrueNAS-SCALE 22.02.4 onto Areca Raid volume and update driver, following below steps.

	0) Extract arcmsr-TrueNAS-SCALE-22.02.4.zip to an USB flash drive.
	1) Insert the Areca driver USB flash disk to target system.
	2) Start TrueNAS-SCALE installation by booting from TrueNAS-SCALE installation disc.
	3) On the TrueNAS XX.XX Console Setup, select "2 Shell" then press Enter.
	4) Type the following commands: (here we assume USB drivr disk is sda5 device)
	   # mkdir /arcmsr /tmp/arcmsr
	   # mount /dev/sda5 /arcmsr
	   # cp -f /arcmsr/* /tmp/arcmsr
	   # umount /arcmsr
	5) Remove the USB flash drive from USB port.
	   # rmmod arcmsr
	   # cd /tmp/arcmsr
	   # sh ./pre-install.sh
	   # exit
	6) On "TrueNAS-SCALE Console Setup", continue the installation process. 
	7) When TrueNAS installation succeeded, and ready to reboot. press "Ctrl+Alt+F2" to
	   switch to terminal console and move cursor to '2 Shell', then press Enter.
	   # zpool import boot-pool
	   Find the ROOT directory
	   # zfs list
	   # zfs set mountpoint=/arcmsr boot-pool/ROOT/22.02.4
	   # mkdir /arcmsr/tmp/arcmsr
	   # cp /tmp/arcmsr/* /arcmsr/tmp/arcmsr
	   # chroot /arcmsr
	   # cd /tmp/arcmsr
	   # sh ./post-install.sh
	   # exit
	   # zfs set mountpoint=legacy boot-pool/ROOT/22.02.4
	press "Ctrl+Alt+F1" to back to reboot page and 'OK' to reboot.

**********************************************************************
3. Installing raid driver on an Existing System	
**********************************************************************

	Install right package for your target kernel version and enter the real kernel version for
	following $(TARGET_KERNEL_VERSION).

	# dpkg -i arcmsr_1.50.0X.12-TNS22.02.4_amd64.deb
	# depmod -a $(TARGET_KERNEL_VERSION)

	If you are boot from areca Raid volume
	# update-initramfs -u -k $(TARGET_KERNEL_VERSION)

	Reboot your system to make arcmsr driver take effect.

**********************************************************************************
4. To compile arcmsr driver on an Existing System.
**********************************************************************************
        if your target kernel version is not (uname -r), then replace following
        $(uname -r) by real target kernel version

	# chmod +x /usr/bin/apt*
	# apt-get update
	Unzip arcmsr-1.50.0X.12-20220804.zip to a directory and change to.
	# make KVER=/lib/modules/$(uname -r)/build

	# cp -f arcmsr.ko /lib/modules/$(uname -r)/kernel/drivers/scsi/arcmsr/
	# depmod -a $(uname -r)

	If you are boot from areca Raid volume
	# update-initramfs -u -k $(uname -r)

	Reboot your system to make arcmsr driver take effect.

**********************************************************************************
5. To install DKMS enabled tarball of arcmsr driver on an existed System.
**********************************************************************************
	Before using DKMS, you must install DKMS package. You can install dkms as following.
	# sudo apt-get install dkms

	Copy arcmsr DKMS enabled tarball to home directory.
	In order to load tarball into the DKMS tree, you must use the following command:

	# sudo dkms ldtarball --archive=./arcmsr-<module version>-source-only.dkms.tar.gz
	where <module version> could be, e.g., 1.50.00.12
	arcmsr source code will be added to DKMS tree.
	
	To build arcmsr driver module
	# sudo dkms build -m arcmsr -v <module version>
	
	To install arcmsr driver module
	# sudo dkms install -m arcmsr -v <module version>

	If you are upgrading linux kernel, then you have to install the corresponding linux-headers-<kernelver> before
	reboot your system. New kernel image can be find in /boot, corresponding new linux header can be find in /usr/src.
	If you can not find new linux header in /usr/src, you can install it as following.
	# sudo apt-get install linux-headers-<kernelver>
	where <kernelver> could be, e.g., 5.10.142+truenas.
	
	After installed linux header files, DKMS service will build and install arcmsr driver for new kernel automatically.

**********************************************************************************
6. To support thunderbolt cable hotplug
**********************************************************************************

	TrueNAS-SCALE 22.02.4 has native support Areca thunderbolt 2 & 3 devices, ARC-8050T2/T3 series.
	The first time of connection thunderbolt device to system, it may need to authorize the device to system.

	1. Find the thunderbolt deivce's UUID.
	   # chmod +x /usr/bin/apt*
	   # sudo apt-get update
	   # sudo apt-get install bolt
	   # boltctl list

	2. Give an authorised permission to thunderbolt devices
	   # boltctl authorize UUID
	   	where UUID is thunderbolt device's UUID, like 00000000-0000-0008-0015-5f0b2012a051
	   Now detecting devices start, just a moment you will can access thunderbolt devices.


**********************************************************************************
7. To set driver parameters value
**********************************************************************************
    arcmsr provided driver parameters setting since v1.30.0X.25.
    Multiple Driver parameters can be set at a time.
    e.g. # insmod arcmsr.ko host_can_queue=72 cmd_per_lun=16

    Setting parameter value out of range will be ignored, parameter remain default value.

    a. To list what driver parameter can be set, parameter default value and value range.
       # modinfo arcmsr

    b. To set driver parameter when you manually install driver.
       (This method will be infeasible if your system was boot from areca Raid volume.)
       e.g. to set parameter host_can_queue value to 64
       # sudo rmmod arcmsr
       # sudo insmod /lib/modules/$(uname -r)/kernel/drivers/scsi/arcmsr/arcmsr.ko host_can_queue=64

    c. To set driver parameter during booting from grub menu.
       When grub menu display, use UP and DOWN arrow key to move cursor to booting target.
       Type e to edit, move cursor to end of line that include "linux   /boot/vmlinuz-x.xx.xx ....."
       Append driver parameter to there.(e.g. to set parameter host_can_queue value to 64)

       linux  .../boot/vmlinuz-5.10.142+truenas..... ... ... zfsforce=1 arcmsr.host_can_queue=64

    d. To set driver parameter for every boot up.
       e.g. to set parameter host_can_queue value to 64
       # sudo gedit /boot/grub/grub.cfg
       Append driver parameter setting to end of line that include "linux   /boot/vmlinuz-x.xx.xx ....."

       linux  .../boot/vmlinuz-5.10.142+truenas..... ... ... zfsforce=1 arcmsr.host_can_queue=64

    e. To verify parameter setting is correct.
       1. To locate adapter parameter directory
          Find Areca host number:
          # dmesg | grep 'scsi host'
          # cat /sys/class/scsi_host/hostX/proc_name
                where hostX could be host0, host1, ...
          The correct output should be 'arcmsr'. If output is (null), check host_fw_model and host_driver_version.
          # cat /sys/class/scsi_host/hostX/host_fw_model
          # cat /sys/class/scsi_host/hostX/host_driver_version

       2. List host_can_queue value
          #  cat /sys/class/scsi_host/hostX/can_queue

       3. List cmd_per_lun value
          #  cat /sys/class/scsi_host/hostX/cmd_per_lun

       4. List cmd_timeout value
          #  cat /sys/block/sdX/device/cmd_timeout
             where sdX could be sda, sdb, ...
