ATTO Celerity 8Gb Host Adapter Linux ReadMe

  1. Supported Adapters
  2. Supported Operating Systems
  3. Installation Instructions
  4. Loading the Driver
  5. Advanced - Manually Building Drivers
  6. Advanced - Optional Module Parameters
  7. Advanced - (Multipath Director Only) SCSI Device Timeouts
  8. The SM-HBA API library
  9. Contact Information

  1. Supported Adapters

    • ATTO Celerity FC-81EN
    • ATTO Celerity FC-82EN
    • ATTO Celerity FC-84EN


  2. Supported Operating Systems

    • CentOS 7, 8
    • RHEL 7, 8
    • Fedora 28, 29
    • openSUSE LEAP 42.4, 15.1
    • SLES 12.4, 15.1
    • Ubuntu 16.04, 18.04


  3. Installation Instructions

    NOTE: The kernel header files, make, and gcc must be installed. It is highly recommended to use DKMS to install the driver with the install script. For closed systems that cannot install DKMS an option is provided in the install script to install without the need for DKMS.

    1. Unzip and untar the driver files with tar xfz lnx_drv_celerity8_XXX.tgz
    2. Enter the lnx_drv_celerity8_XXX directory and run the install script install.sh.
    3. After the driver is installed, it can be loaded automatically if desired.
    4. The install script also provides the ability to install ATTO Command Line Tools appropriate for your adapter.

    NOTE: If downgrading the driver to a version prior to 2.17.0, the uninstall script from the most recent driver must be executed to remove all existing installations before proceeding to install the older version.

    NOTE: By default, CLI tools are installed to the user's path at /usr/local/sbin.
    More information can be found by executing a tool with the -h option.

    Included tools:
    • atinfo
    • atflash
    • atdevinfo
    • atfcnvr
    • atfcinfo
    • atlocate
    Multipath Director Only:
    • atmpinfo
    • atmpcfg


  4. Loading the Driver

    Type the following to manually load the module:

    $ modprobe celerity8fc

    You may receive a warning that the module will taint the kernel.

    On SLES, you may also receive an error message about "unsupported" drivers:

    $ modprobe celerity8fc
    FATAL: module '/lib/modules/2.6.27.19-5-default/kernel/drivers/scsi/celerity8fc.ko' is unsupported
    Use --allow-unsupported or set allow_unsupported_modules to 1 in
    /etc/modprobe.d/unsupported-modules

    You can fix this problem by loading the driver with modprobe --allow-unsupported celerity8fc or editing the file /etc/modprobe.d/unsupported-modules as described.


  5. Advanced - Manually Building Drivers

    Unzip and untar the driver files:

    $ tar xfz lnx_drv_celerity8_XXX.tgz

    NOTE: Make sure there are no spaces in the path in which you extract the archive. The Linux kernel Makefile may fail if the path name contains a space character.

    Make and install the modules (must be done as root):

    $ cd lnx_drv_celerity8_XXX.tgz/src
    $ make install

    If you would like to install the ATTO SM-HBA library:

    $ make api_install

    NOTE: You need the kernel header files installed to build this driver. If the header files are in a non-standard location, you may need to modify the KDIR variable on the make command line, e.g. make install KDIR=/path/to/kernel

    The modules will now be installed and ready to use.

  6. Advanced - Optional Module Parameters

    The following module parameters are supported by this driver:

    • target_mode (default 0) 0 disables target mode function, 1 enables FCP target mode. For a sample module for the ATTO target mode interface, please contact ATTO Technical Support.
    • event_log_mask (default 0) Logs error and informative messages to the kernel ring buffer. This value is a bit-mask of message categories; set to 0xFFFFFFFF to log all possible messages. This feature is mostly for debugging purposes and is not recommended for normal use.
    • quick_init (default 0) Normally, each Celerity adapter port may take up to 9 seconds to initialize. When this option is non-zero, each port will take only about 4 seconds to initialize. However, it is possible that the driver will fail to detect some connected devices before completing this accelerated initialization, so this option should be used with caution.

    There are also several other parameters available for tweaking. For documentation on these settings, read the file oswrap.c (look for "Module parameter definitions") or the output of the command modinfo celerity8fc.

  7. Advanced - (Multipath Director Only) SCSI Device Timeouts

    When multipathing is in use, the following settings are recommended to ensure path recovery when failover occurs.

    HBA Link Down Timeout Set the Link Down Timeout in the NVRAM of the ATTO Celerity FC Adapter to 90 seconds. This can be done from the command line using the supplied ATTO CLI tool:

      atfcnvr -w 90

    SCSI Device Timeout Set the SCSI Device timeout for all multipathed devices to 90 seconds. Establishing the set of paths for a multipathed SCSI device can easily exceed the default timeout value, especially during path failover.

    The SCSI Device timeout can be found in /sys/block/device-name/device/timeout. The value is in seconds. Create a new udev rule for your specific array: create a new file /etc/udev/rules.d/99-vendor.rules, and add the following to it:

    SUBSYSTEM=="block", ACTION=="add", ENV{ID_VENDOR}=="vendor name", ENV{ID_MODEL}=="model name", RUN+="/bin/sh -c 'echo 90 > /sys/block/%k/device/timeout'"

    The "vendor name" and "model name" values can be found by running one of the following commands on one of the multipathed devices (e.g. /sys/block/sdd). Look for the ID_VENDOR and ID_MODEL values.

      udevinfo -q all -p /sys/block/device-name

      udevadm info -q all -p /sys/block/device-name

    See your Operating System documentation for more information about udev.



  8. The SM-HBA API library

    A vendor-specific library for the SM-HBA API is included and installed automatically with this driver.

  9. Contact Information
    ATTO Technology, Inc.
    155 CrossPoint Parkway
    Amherst, New York 14068
    Phone: (716) 691-1999
    Fax: (716) 691-9353
    www.atto.com

    ATTO Technology can also be reached via e-mail at the following addresses:

    Sales Support: sls@atto.com
    Technical Support: techsupp@atto.com