Driver Disk Installation Guide for ARC-11XX/ARC12XX/ARC16XX/18XX RAID Controller 
on openmediavault 5.6.12 amd64(kernel 5.10.0-0.bpo.7-amd64)
=================================================================================
=================================================================================
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 openmediavault
arcmsr_1.50.0X.06-2-OMV5.6.12-k5.10.0-0.bpo.7-amd64.deb  - driver for kernel 5.10.0-0.bpo.7-amd64
arcmsr-1.50.0X.06-20210705.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                                 	    **
**********************************************************************

    openmediavault 5.6.12 kernel default driver has support Areca all Raid controllers except ARC-1886.
    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 (currently ARC-1886 does not support),
    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.


**********************************************************************
3. Installing raid driver for System	
**********************************************************************
NOTE!!! *******
	This updated driver supports kernel version 5.10.0-0.bpo.7-amd64 only.
	Before you install this driver, make sure you have upgraded linux-image-amd64 to
	kernel 5.10.0-0.bpo.7-amd64.

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

	============= For UEFI Secure Boot Only ==========================================
	Enroll public_key.der to MOK database as state in below section 7.
	If you had ever added areca public key to MOK list on this PC, do not do it again.
	# mokutil --import public_key.der
	# reboot
	==================================================================================

	# dpkg -i arcmsr_1.50.0X.06-2-OMV5.6.12-k5.10.0-0.bpo.7-amd64.deb
	# depmod -a $(TARGET_KERNEL_VERSION)
	# update-initramfs -u -k $(TARGET_KERNEL_VERSION)

	Reboot your system to make arcmsr driver take effect.

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

	Before you make driver module, you must have installed linux-headers.
	# su
	# apt-get install linux-headers-$(uname -r) gcc make
	
	Unzip arcmsr-1.50.0X.06-20210705.zip to a directory and change to.
	# make KVER=/lib/modules/$(uname -r)/build

	============================ For UEFI Secure Boot Only =================================================
	For "UEFI Secure Boot" was Enabled in M/B BIOS, you have to generate a pair of public and private key by yourself.
	If you had EVER generated key pair and added public key to MOK list once, DO NOT do it again.

	Copy genkey.cfg to current directory, run following to generate key pair and add public key to MOK list.
	# openssl req -x509 -new -nodes -utf8 -sha256 -days 36500 -batch -config genkey.cfg -outform DER -out public_key.der -keyout private_key.priv

	Enroll public_key.der to MOK database as state in below section 6.
	# mokutil --import public_key.der

	Signing driver module with the Private Key and public key for each time you build new driver.
	# /usr/src/kernels/$(uname -r)/scripts/sign-file sha256 ./private_key.priv ./public_key.der ./arcmsr.ko
	========================================================================================================

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

	Reboot your system to make arcmsr driver take effect.

**********************************************************************************
5. To support thunderbolt cable hotplug
**********************************************************************************

	openmediavault 5.6.12 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.

	0. Install bolt package
	   # apt-get install bolt

	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.

**********************************************************************************
6. To Enroll driver's public key to the MOK database
**********************************************************************************

    =============================================================
    1. Enroll public_key.der to MOK database by mmx64.efi
    =============================================================
	Copy Areca public_key.der and mmx64.efi to an USB flash drive with label name ARECA.
	a. Insert the USB flash drive to the target system.
	b. Insert Installation DVD disc to DVD drive.
	c. Booting from UEFI: CD/DVD drive.
	d. When grub2 boot menu show up, type c to get into grub CLI.
	   At grub console, input following command.

		grub> chainloader (hdx,1)/mmx64.efi
		      where hdx may be hd1, hd2, or, .... It represents USB flash device.
		grub> boot

	e. When "shim EFI key management" page show up, press Enter.
	f. When "Perform MOK management" menu show up, move cursor to "Enroll key from disk", then press Enter.
	g. When "Seclect Key" menu show up, move cursor to "ARECA", then press Enter.
	   Move cursor to "publick_key.der", then press Enter.
	h. When "[Enroll MOK]" menu show up, move cursour to "continue", then press Enter.
	i. When "Enroll the key(s)?" menu show up, move cursor to "Yes", then press Enter.
	j. When "Perform MOK management" menu show up again, move cursor to "continue to boot", then press Enter.
	k. When back to grub CLI, press Esc.

	The public key is added to the MOK list now, which is persistent.
	Once a key is on the MOK list, it is propagated automatically to the system key ring for this and subsequent 
	reboots, when uEFI Secure Boot is enabled.

    ======================================================
    2. Enroll public_key.der to MOK database by "mokutil"
    ======================================================
	Copy Areca public_key.der to home directory.
	a. In installed OS, open a terminal console.
	   # sudo mokutil --import public_key.der
	   
	   When prompted, enter a password of your choice. 
	   This password will be used when enrolling the key into the MOK list(at step g.).

	b. Reboot your system.

	c. Upon rebooting, the "Shim UEFI key management" screen appears. 
	   Press Enter to proceed.

	d. Perform MOK management
	   Select: Enroll MOK

	e. [Enroll MOK]
	   Select: View key 0
	   Select: Continue

	f. Enroll the key(s)?
	   Select: Yes

	g. Enroll the key(s)?
	   Password:      <------ give the password that previously requested by mokutil(at step a.)

	h. Reboot the system?
	   Select: OK

	The key is now enrolled.


**********************************************************************************
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.0-7..... ... ... quiet 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.0-7..... ... ... quiet 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, ...
