Commit bc6632b1 authored by Jerry Snitselaar's avatar Jerry Snitselaar Committed by Xiaochen Shen
Browse files

crypto: iaa - Fix some errors in IAA documentation 

mainline inclusion
from mainline-v6.10-rc1
commit 616ce45c150fa65683c8c1b1f2e2ac930462868d
category: bugfix
bugzilla: https://gitee.com/openeuler/intel-kernel/issues/I9TA1S
CVE: NA

Reference: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=616ce45c150fa65683c8c1b1f2e2ac930462868d



--------------------------------

This cleans up the following issues I ran into when trying to use the
scripts and commands in the iaa-crypto.rst document.

- Fix incorrect arguments being passed to accel-config
  config-wq.
    - Replace --device_name with --driver-name.
    - Replace --driver_name with --driver-name.
    - Replace --size with --wq-size.
    - Add missing --priority argument.
- Add missing accel-config config-engine command after the
  config-wq commands.
- Fix wq name passed to accel-config config-wq.
- Add rmmod/modprobe of iaa_crypto to script that disables,
  then enables all devices and workqueues to avoid enable-wq
  failing with -EEXIST when trying to register to compression
  algorithm.
- Fix device name in cases where iaa was used instead of iax.

Intel-SIG: commit 616ce45c150f crypto: iaa - Fix some errors in IAA documentation.
Backporting patches for Intel IAA crypto driver on Intel Xeon platform.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-crypto@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Signed-off-by: default avatarJerry Snitselaar <jsnitsel@redhat.com>
Reviewed-by: default avatarTom Zanussi <tom.zanussi@linux.intel.com>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
Signed-off-by: default avatarXiaochen Shen <xiaochen.shen@intel.com>
parent 2af2061b

Documentation/driver-api/crypto/iaa/iaa-crypto.rst

+16 −6
Original line number Diff line number Diff line
@@ -179,7 +179,9 @@ has the old 'iax' device naming in place) :: 


  # configure wq1.0



  accel-config config-wq --group-id=0 --mode=dedicated --type=kernel --name="iaa_crypto" --device_name="crypto" iax1/wq1.0

  accel-config config-wq --group-id=0 --mode=dedicated --type=kernel --priority=10 --name="iaa_crypto" --driver-name="crypto" iax1/wq1.0



  accel-config config-engine iax1/engine1.0 --group-id=0



  # enable IAA device iax1
@@ -548,12 +550,20 @@ The below script automatically does that:: 


  echo "End Disable IAA"



  echo "Reload iaa_crypto module"



  rmmod iaa_crypto

  modprobe iaa_crypto



  echo "End Reload iaa_crypto module"



  #

  # configure iaa wqs and devices

  #

  echo "Configure IAA"

  for ((i = 1; i < ${num_iaa} * 2; i += 2)); do

      accel-config config-wq --group-id=0 --mode=dedicated --size=128 --priority=10 --type=kernel --name="iaa_crypto" --driver_name="crypto" iax${i}/wq${i}

      accel-config config-wq --group-id=0 --mode=dedicated --wq-size=128 --priority=10 --type=kernel --name="iaa_crypto" --driver-name="crypto" iax${i}/wq${i}.0

      accel-config config-engine iax${i}/engine${i}.0 --group-id=0

  done



  echo "End Configure IAA"
@@ -564,10 +574,10 @@ The below script automatically does that:: 
  echo "Enable IAA"



  for ((i = 1; i < ${num_iaa} * 2; i += 2)); do

      echo enable iaa iaa${i}

      accel-config enable-device iaa${i}

      echo enable wq iaa${i}/wq${i}.0

      accel-config enable-wq iaa${i}/wq${i}.0

      echo enable iaa iax${i}

      accel-config enable-device iax${i}

      echo enable wq iax${i}/wq${i}.0

      accel-config enable-wq iax${i}/wq${i}.0

  done



  echo "End Enable IAA"