#!/bin/bash
#################################################################
#
#   BSD LICENSE
# 
#   Copyright(c) 2007-2024 Intel Corporation. All rights reserved.
#   All rights reserved.
# 
#   Redistribution and use in source and binary forms, with or without
#   modification, are permitted provided that the following conditions
#   are met:
# 
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in
#       the documentation and/or other materials provided with the
#       distribution.
#     * Neither the name of Intel Corporation nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
# 
#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
#   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
#   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
#   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
#   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
#   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# 
#  version: QAT.L.4.28.0-00004
#
#################################################################
#
### BEGIN INIT INFO
# Provides: QAT
# Required-Start: $ALL
# Required-Stop:
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Description:  Intel QAT service
### END INIT INFO
#
# qat_service          Start/Stop the Intel QAT.
#
# chkconfig: 345 99 99
# description: modprobe the QAT modules, which loads dependent \
#       modules, before calling the user space \
#       utility to pass configuration parameters

test -f /etc/default/qat && . /etc/default/qat
SRIOV_ENABLE=${SRIOV_ENABLE-0}
DO_ENABLE_SRIOV=${DO_ENABLE_SRIOV-0}
ENABLE_KAPI=${ENABLE_KAPI-0}

# to protect parallel qat-service run instances
for pid in $(pidof -x qat_service); do
    if [ $pid != $$ ]; then
        echo "[$(date)] : qat_service : Process is already running with PID $pid"
        exit 1
    fi
done

INTEL_VENDORID="8086"
DH895_DEVICE_PCI_ID="0435"
DH895_DEVICE_PCI_ID_VM="0443"
C62X_DEVICE_PCI_ID="37c8"
C62X_DEVICE_PCI_ID_VM="37c9"
C3XX_DEVICE_PCI_ID="19e2"
C3XX_DEVICE_PCI_ID_VM="19e3"
QAT_200XX_DEVICE_PCI_ID="18ee"
QAT_200XX_DEVICE_PCI_ID_VM="18ef"
D15XX_DEVICE_PCI_ID="6f54"
D15XX_DEVICE_PCI_ID_VM="6f55"
C4XX_DEVICE_PCI_ID="18a0"
C4XX_DEVICE_PCI_ID_VM="18a1"

usage()
{
    echo
    echo --------------------------------------------------------
    echo USAGE:
    echo --------------------------------------------------------
    echo "#  $0 start||stop||status||restart||shutdown"
    echo --------------------------------------------------------
    echo " Note: If there is more devices in the system"
    echo " you can start, stop or restart separate device by "
    echo " passing the dev to be restarted or stopped as a"
    echo " parameter for instance: "
    echo " $0 stop qat_dev<N>"
    echo " where N is device number."
    echo " To see all devices in the system use:"
    echo " $0 status"
    echo --------------------------------------------------------
    exit 1
}

ADF_CTL=/usr/sbin/adf_ctl
ADF_CTL_BIN=$ADF_CTL
ADF_CTL_SUPPORT=:

# store the total number of each type of device
numDh895xDevicesPF=$(lspci -n | grep -c "$INTEL_VENDORID:$DH895_DEVICE_PCI_ID")
numDh895xDevicesVF=$(lspci -n | grep -c "$INTEL_VENDORID:$DH895_DEVICE_PCI_ID_VM")
numC62xDevicesPF=$(lspci -n | grep -c "$INTEL_VENDORID:$C62X_DEVICE_PCI_ID")
numC62xDevicesVF=$(lspci -n | grep -c "$INTEL_VENDORID:$C62X_DEVICE_PCI_ID_VM")
numC3xxDevicesPF=$(lspci -n | grep -c "$INTEL_VENDORID:$C3XX_DEVICE_PCI_ID")
numC3xxDevicesVF=$(lspci -n | grep -c "$INTEL_VENDORID:$C3XX_DEVICE_PCI_ID_VM")
num200xxDevicesPF=$(lspci -n | grep -c "$INTEL_VENDORID:$QAT_200XX_DEVICE_PCI_ID")
num200xxDevicesVF=$(lspci -n | grep -c "$INTEL_VENDORID:$QAT_200XX_DEVICE_PCI_ID_VM")
numD15xxDevicesPF=$(lspci -n | grep -c "$INTEL_VENDORID:$D15XX_DEVICE_PCI_ID")
numD15xxDevicesVF=$(lspci -n | grep -c "$INTEL_VENDORID:$D15XX_DEVICE_PCI_ID_VM")
numC4xxDevicesPF=$(lspci -n | grep -c "$INTEL_VENDORID:$C4XX_DEVICE_PCI_ID")
numC4xxDevicesVF=$(lspci -n | grep -c "$INTEL_VENDORID:$C4XX_DEVICE_PCI_ID_VM")

disable_sriov()
{
    SUPPORT=$($ADF_CTL_SUPPORT stop)
    PF_LIST=$($ADF_CTL_BIN $1 status | grep -e "^ *qat_dev" | grep -v "vf," | awk '{print $1}')

    for PF_DEV in $PF_LIST; do
        # Extract the BSF to build the path to /sys/bus/.../sriov)_numvfs
        BSF=$($ADF_CTL_BIN $PF_DEV status | tail -1 | awk '{print $10}' | awk 'BEGIN{FS=","}{print $1}')
        D=$(echo $BSF | awk 'BEGIN{FS=":"}{print $1}')
        B=$(echo $BSF | awk 'BEGIN{FS=":"}{print $2}')

        # Get a list of all the VFs for this PF and bring them down
        VF_LIST=$($ADF_CTL_BIN status | grep "bsf: $D:$B" | grep "vf," | awk '{print $1}')
        for VF_DEV in $VF_LIST; do
            $ADF_CTL_BIN $VF_DEV down
        done
    done
}

enable_sriov()
{
    PF_LIST=$($ADF_CTL_BIN $1 status | grep -e "^ *qat_dev" | grep -v "vf,\|down" | awk '{print $1}')

    for PF_DEV in $PF_LIST; do
        # Extract the BSF to build the path to /sys/bus/.../sriov)_numvfs
        BSF=$($ADF_CTL_BIN $PF_DEV status | tail -1 | awk '{print $10}' | awk 'BEGIN{FS=","}{print $1}')
        D=$(echo $BSF | awk 'BEGIN{FS=":"}{print $1}')
        B=$(echo $BSF | awk 'BEGIN{FS=":"}{print $2}')
        SF=$(echo $BSF | awk 'BEGIN{FS=":"}{print $3}')
        S=$(echo $SF | awk 'BEGIN{FS="."}{print $1}')
        F=$(echo $SF | awk 'BEGIN{FS="."}{print $2}')
        SYSFS_DIR=/sys/bus/pci/devices/${D}:${B}:${S}.${F}

        if [ ! -e ${SYSFS_DIR}/sriov_numvfs ]; then
            echo "Cannot enable SRIOV for $PF_DEV. No sriov_numvs file"
            exit 1
        fi

        NUMVFS=$(cat ${SYSFS_DIR}/sriov_numvfs)
        if [ $NUMVFS != 0 ]; then
            echo "SRIOV is already enabled for $PF_DEV"
            exit 1
        fi

        cat ${SYSFS_DIR}/sriov_totalvfs > ${SYSFS_DIR}/sriov_numvfs
        if [ $? != 0 ]; then
            echo "Could not enable SRIOV for $PF_DEV"
            exit 1
        fi

        # Get a list of all the VFs for this PF and bring then down
        VF_LIST=$($ADF_CTL_BIN status | grep "bsf: $D:$B" | grep "vf," | awk '{print $1}')
        for VF_DEV in $VF_LIST; do
            $ADF_CTL_BIN $VF_DEV restart
        done
    done

    SUPPORT=$($ADF_CTL_SUPPORT start)
}

check_sriov()
{
    # Check if sriov should be enabled.
    if [ $SRIOV_ENABLE == 1 ]; then
        # If a specific device ($2), or any (empty $2) is specified that is a pf, then enable sriov.
        $ADF_CTL_BIN $1 status | grep -e "^ *qat_dev" | grep -v vf > /dev/null
        if [ $? == 0 ]; then
            DO_ENABLE_SRIOV=1
        else
            DO_ENABLE_SRIOV=0
        fi
    else
        DO_ENABLE_SRIOV=0
    fi
}

case $1 in
    Start | start)
        # First check if the modules are already installed
        # install them as necessary
        if [ $numDh895xDevicesPF != 0 ]; then
            modprobe qat_dh895xcc
        fi
        if [ $numC62xDevicesPF != 0 ]; then
            modprobe qat_c62x
        fi
        if [ $numC3xxDevicesPF != 0 ]; then
            modprobe qat_c3xxx
        fi
        if [ $num200xxDevicesPF != 0 ]; then
            modprobe qat_200xx
        fi
        if [ $numD15xxDevicesPF != 0 ]; then
            modprobe qat_d15xx
        fi
        if [ $numC4xxDevicesPF != 0 ]; then
            modprobe qat_c4xxx
        fi
        if [ $(lsmod | grep "usdm_drv" | wc -l) == "0" ]; then
            modprobe usdm_drv
        fi

        # Loading VF drivers as necessary
        # Load only for guest, where VFs are present but not PFs.
        if [ $SRIOV_ENABLE == 1 ]; then
            if [ $numDh895xDevicesPF == 0 -a $numDh895xDevicesVF != 0 ]; then
                modprobe qat_dh895xccvf
            fi
            if [ $numC62xDevicesPF == 0 -a $numC62xDevicesVF != 0 ]; then
                modprobe qat_c62xvf
            fi
            if [ $numC3xxDevicesPF == 0 -a $numC3xxDevicesVF != 0 ]; then
                modprobe qat_c3xxxvf
            fi
            if [ $num200xxDevicesPF == 0 -a $num200xxDevicesVF != 0 ]; then
                modprobe qat_200xxvf
            fi
            if [ $numD15xxDevicesPF == 0 -a $numD15xxDevicesVF != 0 ]; then
                modprobe qat_d15xxvf
            fi
            if [ $numC4xxDevicesPF == 0 -a $numC4xxDevicesVF != 0 ]; then
                modprobe qat_c4xxxvf
            fi
        fi

        if [ $(lsmod | grep "qat_api" | wc -l) == "0" ] && [ $ENABLE_KAPI == 1 ]; then
            modprobe qat_api
        fi

        $ADF_CTL $2 restart

        check_sriov $2
        if [ $DO_ENABLE_SRIOV == 1 ]; then
            echo enable sriov
            enable_sriov $2
        fi

        # Show device status
        $ADF_CTL $2 status
        ;;

    Shutdown | shutdown)
        check_sriov $2
        if [ $DO_ENABLE_SRIOV == 1 ]; then
            echo disable sriov
            disable_sriov $2
        fi

        $ADF_CTL down &> /dev/null
        modprobe -q -r qat_api
        modprobe -q -r usdm_drv
        modprobe -q -r qat_dh895xccvf
        modprobe -q -r qat_c62xvf
        modprobe -q -r qat_c3xxxvf
        modprobe -q -r qat_d15xxvf
        modprobe -q -r qat_200xxvf
        modprobe -q -r qat_c4xxxvf
        modprobe -q -r qat_dh895xcc
        modprobe -q -r qat_c62x
        modprobe -q -r qat_c3xxx
        modprobe -q -r qat_d15xx
        modprobe -q -r qat_200xx
        modprobe -q -r qat_c4xxx
        modprobe -q -r intel_qat
        ;;

    Stop | stop)
        check_sriov $2
        if [ $DO_ENABLE_SRIOV == 1 ]; then
            echo disable sriov
            disable_sriov $2
        fi
        $ADF_CTL $2 down
        ;;

    Restart | restart)
        $ADF_CTL $2 restart
        ;;

    Status | status)
        $ADF_CTL status
        if [ "$?" -ne 0 ]; then
            echo "No devices found. Please start the driver using:"
            echo "$0 start"
        fi
        ;;

    *)
        usage
        ;;

esac
exit 0
