****************************************
                                   README

                    ****************************************

                     Chelsio Co-processor Driver for Linux                 
           

                             Version : 1.0.0.0 (Alpha)
                             Date    : 04/27/2017 



Overview
================================================================================

Chelsio Crypto Accelerator is a co-processor designed specifically to perform 
computationally intensive cryptographic operations more efficiently than 
general-purpose CPUs. Servers with system load, comprising of cryptographic 
operations, see great performance improvement by offloading crypto operations on
to the Chelsio Unified Wire adapter. Chelsio’s solution uses the standard crypto
API framework provided by the operating system and enables the offloading of 
crypto operations to the adapter. 



================================================================================
  CONTENTS
================================================================================

- 1. Requirements
- 2. Supported Operating Systems
- 3. Supported Cards
- 4. How to Use
- 5. Support Documentation
- 6. Customer Support



1. Requirements
================================================================================

- Chelsio adapter and system with supported platforms mentioned in section 2. 
- It is recommended to disable selinux and firewall. 



2. Supported Operating Systems
================================================================================

The Chelsio Co-processor driver has been developed to run on Linux based 
platforms. Following is the list of supported version(s).

- Kernel.org linux-4.9.13 compiled on RHEL 7.3

Other versions have not been tested and are not guaranteed to work.
 


 3. Supported Cards
================================================================================

Following is the list of supported Chelsio adapters:

- T62100-CR
- T62100-LP-CR
- T6225-CR


4. How to Use
================================================================================

Installation
============

a) Download Co-processor driver package from Chelsio Download Center, 
   service.chelsio.com

b) Extract the package

   [root@host~]# tar zxvf <driver_package>.tar.gz
   [root@host~]# cd <driver_package>

c) Install 4.9.13 kernel with Crypto components enabled.

   [root@host~]# ./install.sh -i

d) Reboot the machine into the newly installed kernel.

e) Install the Co-processor drivers

   [root@host~]# ./install.sh -d

NOTE: The above command will install openSSL with Chelsio Co-processor engine.


Driver Loading
==============

NOTE: Ensure that all inbox drivers are unloaded before proceeding:

   [root@host~]# rmmod iw_cxgb4
   [root@host~]# rmmod cxgb4
   [root@host~]# rmmod csiostor

a) To load Co-processor driver, run the following commands:

   [root@host~]# modprobe cxgb4
   [root@host~]# modprobe chcr

b) Bring up the Chelsio network interface:

   [root@host~]# ifconfig ethX up

Where ethX is the Chelsio interface.


Firmware Update
===============

The firmware (v1.16.43.0) is installed on the system, 
typically in /lib/firmware/cxgb4, and the network driver(cxgb4) will auto-load 
the firmware if an update is required. The kernel must be configured to enable 
userspace firmware loading support:

Device Drivers -> Generic Driver Options -> Userspace firmware loading support

The firmware version can be verified using ethtool:

   [root@host~]# ethtool -i <iface>


Configuration
=============

The following applications can be offloaded by Chelsio Co-processor: 

- Apache
- Dmcrypt
- SFTP
- OpenVPN
- Strongswan

To verify if Chelsio Co-processor is used by the above applications, run 
the following command:

   [root@host~]# cat /sys/kernel/debug/cxgb4/<PF4_id>/crypto
   Chelsio Crypto Co-processor Stats
   aes_ops: 1016
   digest_ops: 323
   aead_ops: 2739611
   comp: 2740950
   error: 0
   Fallback: 9


Driver Unloading
===================

To unload Co-processor driver, run the following command:

   [root@host~]# rmmod chcr


Uninstallation
==============

To uninstall Co-processor drivers:

   [root@host~]# ./install.sh -u



5. Customer Support
================================================================================

Please contact Chelsio support at support@chelsio.com for any issues regarding 
the product.








********************************************************************************
Copyright (C) 2017 Chelsio Communications. All Rights Reserved.

The information in this document is furnished for informational use only, is
subject to change without notice, and should not be construed as a commitment by
Chelsio Communications. Chelsio Communications assumes no responsibility or
liability for any errors or inaccuracies that may appear in this document or any
software that may be provided in association with this document. Except as
permitted by such license, no part of this document may be reproduced, stored in
a retrieval system,or transmitted in any form or by any means without the
express written consent of Chelsio Communications.