Driver Disk Installation Guide for ARC-11XX/ARC12XX/ARC16XX/18XX RAID Controller 
on Ubuntu 22.04.4 x86_64(kernel 5.15.0-94, 6.5.0-18)
=================================================================================
=================================================================================
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 Ubuntu
arcmsr-ubuntu-22.04.4.zip	- Areca RAID driver disk for system installation
arcmsr-1.51.0X.16-ubuntu22.04.4-k5.15.0-94-generic.x86_64.deb - driver for Ubuntu kernel 5.15.0-94
arcmsr-1.51.0X.16-ubuntu22.04.4-k5.15.0-97-generic.x86_64.deb - driver for Ubuntu kernel 5.15.0-97
arcmsr-1.51.0X.16-ubuntu22.04.4-k6.5.0-18-generic.x86_64.deb  - driver for Ubuntu kernel 6.5.0-18
arcmsr-1.51.0X.16-ubuntu22.04.4-k6.5.0-21-generic.x86_64.deb  - driver for Ubuntu kernel 6.5.0-21
arcmsr-1.51.00.16-source-only.dkms.tar.gz - DKMS enabled driver source code
arcmsr-1.51.0X.16-20231226.zip	- 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. New System Installation
**********************************************************************

   Ubuntu 22.04.4 kernel built-in arcmsr driver has supported all Areca Raid controllers except ARC-1688.
   So just following the Ubuntu 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 refer to
   Areca Raid controllers user's manual.

   For installation Ubuntu onto ARC-1688 Raid volume, following below steps.
    A. Extract arcmsr-ubuntu-22.04.4.zip to an USB flash drive with label OEMDRV.

    B. Install ubuntu server

	1) Start Ubuntu installation by booting from Ubuntu installation media.
	2) On the GRUB menu, select "Try or Install Ubuntu Server" or
	   "Ubuntu Server with the HWE kernel", then press Enter.
	3) On Welcome "Select your language" screen, press Ctrl+Alt+F2 to enter Shell, then press Enter.
	4) Insert the Areca driver USB flash drive to your system.
	5) Type the following commands:
	   # sudo rmmod arcmsr
	   # sudo mkdir /arcmsr /tmp/arcmsr
	   Find the USB device, here we assume it is sdd
	   # ls /dev/sd*
	   # sudo mount /dev/sdd1 /arcmsr
	   # sudo cp -f /arcmsr/* /tmp/arcmsr
	   # sudo umount /arcmsr
	6) Remove the USB flash drive from the USB port and then type:
	   # cd /tmp/arcmsr
	   # sudo ./pre-install.sh
	   press Ctrl+Alt+F1 to back to installation screen.
	7) Continue the installation process. 
	8) After the installation is complete and before rebooting. press "Ctrl+Alt+F2" to
	   switch to console tty2 and type the following commands:
	   # sudo mkdir /target/tmp/arcmsr
	   # sudo cp /tmp/arcmsr/* /target/tmp/arcmsr
	   # sudo chroot /target
	   # cd /tmp/arcmsr
	   # sh ./post-install.sh
	   # exit
	9) Press "Alt+F1" to continue. 

    C. Install ubuntu Desktop

	1) Start Ubuntu installation by booting from Ubuntu installation media.
	2) On Ubuntu desktop, press right click of mouse to open a terminal console.
	3) Insert the Areca driver USB flash disk to target system.
	4) Type the following commands:
	   # sudo rmmod arcmsr
	   # mount | grep sd
	   Find the driver USB device mount point, assume it was mounted on /media/ubuntu/OEMDRV.
	   # sudo mkdir /tmp/arcmsr
	   # sudo cp -f /media/ubuntu/OEMDRV/* /tmp/arcmsr
	   # sudo umount /media/ubuntu/OEMDRV
	5) Remove the USB flash drive from the USB port and then type:
	   # cd /tmp/arcmsr
	   # sudo chmod +x *.sh
	   # sudo ./pre-install.sh
	6) Click th "Install Ubuntu 22.04.4 LTS" icon, to start Ubuntu system installation.
	7) Do not reboot after the installation is complete.
	   Switch to terminal console and type the following commands:
	   # sudo mkdir /target/tmp/arcmsr
	   # sudo cp /tmp/arcmsr/* /target/tmp/arcmsr
	   # sudo chroot /target
	   # cd /tmp/arcmsr
	   # sh ./post-install.sh
	   # exit
	8) Now you can restart the system. 

**********************************************************************
3. Installing raid driver on an installed System	
**********************************************************************
	On the very first booting of new installation system, we strongly recommend you to update the
	arcmsr Raid driver.
	login as root or use su command.

	Depends on your current kernel version.
	# sudo dpkg -i arcmsr-1.51.0X.16-ubuntu22.04.4-k5.15.0-xx-generic.x86_64.deb
		or
	# sudo dpkg -i arcmsr-1.51.0X.16-ubuntu22.04.4-k6.5.0-xx-generic.x86_64.deb

	# sudo depmod -a
	# sudo update-initramfs -u

	# sudo modprobe arcmsr
		or
	Reboot your system to make arcmsr driver take effect.

**********************************************************************************
4. To install DKMS enabled tarball of arcmsr driver on an installed 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.51.00.16
	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.15.0-94-generic.
	
	After installed linux header files, DKMS service will build and install arcmsr driver for new kernel automatically.

**********************************************************************************
5. To compile arcmsr driver on an installed System.
**********************************************************************************
   If your Linux system can use Areca Raid volume normally, you need not to compile driver for it.
   If areca pre-build driver(arcmsr...deb) can not fit for your kernel, then you need compile
   driver for it by yourself.

        if your target kernel version is not (uname -r), then replace following
        $(uname -r) by target kernel version

	# sudo apt-get install linux-headers-$(uname -r) gcc make

	To compile arcmsr driver, extract driver source code to a new directory.
	# sudo make KDIR=/lib/modules/$(uname -r)/build

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

	Reboot your system to make arcmsr driver take effect.

**********************************************************************************
6. To support Areca thunderbolt device and cable hotplug
**********************************************************************************
Ubuntu Desktop:
===============
	Ubuntu 22.04.4 has native support Areca thunderbolt 2 & 3 devices, ARC-8050T2/T3 series.
	But it needs root user to authorised permission after connect the thunderbolt cable.

	The first time of connection thunderbolt device to system, it may need to authorize the device to system.
	From GNOME Settings->Privacy->Thunderbolt, click the 'connected' but not yet authorized device,
	confirm the 'authorize and connect' to make it 'authorized'.

Ubuntu Server:
==============
	Ubuntu 22.04.4 Server also has native support Areca thunderbolt 2 & 3 devices, ARC-8050T2/T3 series.
	But it needs root user to authorise permission after connect the thunderbolt devices.

	1. Find the thunderbolt deivce's UUID.
	   # 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.15.0-97..... ... ...  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.15.0-97..... ... ...  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, ...
