Driver Disk Installation Guide for ARC-11XX/ARC12XX/ARC16XX/18XX RAID Controller 
on openSUSE 42.2(kernel 4.4.27-2)
=================================================================================
=================================================================================
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 arcsas driver for openSUSE 42.2
arcmsr-opensuse42.2.zip  - Areca Raid driver for system installation
arcmsr-1.50.0X.05-20210429.zip  - arcms driver source code(arcmsr.c, arcmsr.h, Makefile)
arcmsr-1.50.00.05-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 .ko first time installation

**********************************************************************************
2. SLES system Installation
**********************************************************************************

A. Before Installation
=========================

    Extract arcmsr-opensuse42.2.zip to the top(/) directory of an USB flash drive.
    Copy public_key.der to top(/) directory of the same USB flash drive .
    Give a label to this USB flash drive, said ARECA.

    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. Add Areca Linux driver's public key to Authorized signature database(DB) or Machine Owner Key(MOK) database.
	8. OS is 64 bits version, CPU is 64 bits, and both support UEFI specification.

	 
    You must add Areca Linux driver's public key to the MOK or DB before installing operation system. 
    If Areca Linux driver's public key has been in the DB or MOK of system NVRAM, it is not necessary to do it again.

    To add Areca Linux driver's public key to the DB or MOK database, select one of three ways to do.

    ============================================================
    1. Append public_key.der to DB database from M/B BIOS setup
    ============================================================
	Copy Areca public_key.der to an USB flash drive with label name ARECA.
	Enter M/B BIOS setup, in secure boot menu -> Key Management -> Append DB(or "Append db from file", or "Append Var to DB")
	
	a. Append the addition db?( or update 'db' with factory defaults?)
	   Select: No

	b. Select File system( or press ESC to skip)
	   Select: ...\USB(x,0)\....

	c. Select File
	   Select: public_key.der

	d. Select key file type
	   Select: key Certificate blob

	e. Update 'db' from selected file 'public_key.der'?
	   Select: Yes

	f. Set "Set New DB (DataBase)" to "Yes", if any.

    =============================================================
    2. Enroll public_key.der to MOK database by "MokManager.efi"
    =============================================================
	Copy Areca public_key.der 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 /EFI/BOOT/MokManager.efi
		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.

    ======================================================
    3. Enroll public_key.der to MOK database by "mokutil"
    ======================================================
	Copy Areca public_key.der to home directory.
	a. In OS, open a terminal console.
	   # 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.

	b. Reboot your system.

	c. Upon rebooting, the "Shim UEFI key management" screen appears. 
	   Press any key withing 10 seconds 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

	h. Reboot the system?
	   Select: OK

	The key is now enrolled.


B. Start installation
========================

        a. Insert the USB flash drive to the target system.
	
        b. Boot from openSUSE 42.2 DVD installation disc.
	
    For choice legacy DVD drive to install:
    =======================================
        c. Press "F6" select "Yes".

           Move cursor to hightlight "Installation", then press ENTER to install openSUSE

    For choice UEFI DVD drive to install:
    =======================================
	c. When grub boot menu show up, move cursor to "Installation"
	   type e to edit kernel boot option.

	   At the end of line that include "linuxefi /boot/x86_64/loader/linux" append " dud=1"
	   (double quotation mark are not include).

	   Press F10 to start system installation.


        d. When the message: "Driver Updates Added" show-up, and you can see "arcmsr Driver Update Disk 1",
           press Enter to continue.
	   
        e. When the message: "Please choose the driver update medium" show-up, if 
           you can see all your raid volumes appear on the medium list,
           move cursor to "Back" and press Enter to continue system installation.

           If you can't see the Areca RAID controller or raid volumes, move cursor to
           driver update media and press OK to update driver.

**********************************************************************************
3. Installing arcmsr driver on an Existing System
**********************************************************************************
	============= For UEFI Secure Boot Only ==========================================
	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
	==================================================================================

        Extract arcmsr-opensuse42.2.zip to current directory.
        # cd linux/suse/x86_64-leap42.2/install

        Install driver package.
        # rpm -ivh arcmsr-kmp-default-1.50.0X.05_opensuse42.2_k4.4.27_2-1.x86_64.rpm
        # insmod /lib/modules/$(uname -r)/updates/arcmsr.ko
	# depmod -a

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

	You must have your Linux system with developmental environment and kernel source,
	in other words you should select the adequate packages on the menu list during installation.
	If you do not have installed these packages during system installation, you can install 
	kernel develope rpm package from openSUSE installation disc /suse/x86_64.

	# rpm -ivh kernel-default-devel-4.4.27-2.1.x86_64.rpm

	Unzip arcmsr-1.50.0X.05-20210429.zip to a new directory
	# make KDIR=/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
	# mokutil --import public_key.der

	Signing driver module with the Private Key by perl for each time you build new driver.
	# perl /usr/src/linux/scripts/sign-file sha256 ./private_key.priv ./public_key.der ./arcmsr.ko
	==================================================================================================================

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

	To build new kernel ramdisk for load arcmsr driver during boot-up automatically.
	# cd /boot
	# mv initrd-$(uname -r) initrd-$(uname -r).old				
	# mkinitrd initrd-$(uname -r) $(uname -r)

**********************************************************************************
5. To install DKMS enabled tarball of arcmsr driver on an Existing System.
**********************************************************************************
	You must have your Linux system with developmental environment and kernel source,
	in other words you should select the adequate packages on the menu list during installation.
	If you do not have installed these packages during system installation, you can install 
	kernel-default-devel rpm package from openSUSE 42.2 installation disc /suse/x86_64.

	Login as root.
	# rpm -ivh kernel-default-devel-$(uname -r).rpm

	Download DKMS package dkms-<dkmsversion>.noarch.rpm from http://software.opensuse.org/package/dkms or http://linux.dell.com/dkms
	Before using DKMS, you must install DKMS package. You can install dkms as following.
	# rpm -ivh dkms-<dkmsversion>.noarch.rpm
	where <moduleversion> is dkms version could be, e.g., 2.2.0.3_git20141020-2.1

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

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


	If you are upgrading linux kernel, then you have to install the corresponding kernel-devel-<kernelver>.noarch.rpm before
	reboot your system. 
	# rpm -ivh kernel-devel-<kernelver>.noarch.rpm
	where <kernelver> is kernel version could be, e.g., 4.4.27-2.1
	
	After installed kernel devel files, DKMS service will build and install arcmsr driver for new kernel automatically.
