drivers/crypto/qat/qat_common/adf_accel_devices.h

   1 /*
   2   This file is provided under a dual BSD/GPLv2 license.  When using or
   3   redistributing this file, you may do so under either license.
   4
   5   GPL LICENSE SUMMARY
   6   Copyright(c) 2014 Intel Corporation.
   7   This program is free software; you can redistribute it and/or modify
   8   it under the terms of version 2 of the GNU General Public License as
   9   published by the Free Software Foundation.
  10
  11   This program is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14   General Public License for more details.
  15
  16   Contact Information:
  17   qat-linux@intel.com
  18
  19   BSD LICENSE
  20   Copyright(c) 2014 Intel Corporation.
  21   Redistribution and use in source and binary forms, with or without
  22   modification, are permitted provided that the following conditions
  23   are met:
  24
  25     * Redistributions of source code must retain the above copyright
  26       notice, this list of conditions and the following disclaimer.
  27     * Redistributions in binary form must reproduce the above copyright
  28       notice, this list of conditions and the following disclaimer in
  29       the documentation and/or other materials provided with the
  30       distribution.
  31     * Neither the name of Intel Corporation nor the names of its
  32       contributors may be used to endorse or promote products derived
  33       from this software without specific prior written permission.
  34
  35   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  36   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  38   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  39   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  42   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  43   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  44   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  45   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  46 */
  47 #ifndef ADF_ACCEL_DEVICES_H_
  48 #define ADF_ACCEL_DEVICES_H_
  49 #include <linux/module.h>
  50 #include <linux/list.h>
  51 #include <linux/io.h>
  52 #include "adf_cfg_common.h"
  53
  54 #define ADF_DH895XCC_DEVICE_NAME "dh895xcc"
  55 #define ADF_DH895XCC_PCI_DEVICE_ID 0x435
  56 #define ADF_PCI_MAX_BARS 3
  57 #define ADF_DEVICE_NAME_LENGTH 32
  58 #define ADF_ETR_MAX_RINGS_PER_BANK 16
  59 #define ADF_MAX_MSIX_VECTOR_NAME 16
  60 #define ADF_DEVICE_NAME_PREFIX "qat_"
  61
  62 enum adf_accel_capabilities {
  63         ADF_ACCEL_CAPABILITIES_NULL = 0,
  64         ADF_ACCEL_CAPABILITIES_CRYPTO_SYMMETRIC = 1,
  65         ADF_ACCEL_CAPABILITIES_CRYPTO_ASYMMETRIC = 2,
  66         ADF_ACCEL_CAPABILITIES_CIPHER = 4,
  67         ADF_ACCEL_CAPABILITIES_AUTHENTICATION = 8,
  68         ADF_ACCEL_CAPABILITIES_COMPRESSION = 32,
  69         ADF_ACCEL_CAPABILITIES_LZS_COMPRESSION = 64,
  70         ADF_ACCEL_CAPABILITIES_RANDOM_NUMBER = 128
  71 };
  72
  73 struct adf_bar {
  74         resource_size_t base_addr;
  75         void __iomem *virt_addr;
  76         resource_size_t size;
  77 } __packed;
  78
  79 struct adf_accel_msix {
  80         struct msix_entry *entries;
  81         char **names;
  82 } __packed;
  83
  84 struct adf_accel_pci {
  85         struct pci_dev *pci_dev;
  86         struct adf_accel_msix msix_entries;
  87         struct adf_bar pci_bars[ADF_PCI_MAX_BARS];
  88         uint8_t revid;
  89         uint8_t sku;
  90 } __packed;
  91
  92 enum dev_state {
  93         DEV_DOWN = 0,
  94         DEV_UP
  95 };
  96
  97 enum dev_sku_info {
  98         DEV_SKU_1 = 0,
  99         DEV_SKU_2,
 100         DEV_SKU_3,
 101         DEV_SKU_4,
 102         DEV_SKU_UNKNOWN,
 103 };
 104
 105 static inline const char *get_sku_info(enum dev_sku_info info)
 106 {
 107         switch (info) {
 108         case DEV_SKU_1:
 109                 return "SKU1";
 110         case DEV_SKU_2:
 111                 return "SKU2";
 112         case DEV_SKU_3:
 113                 return "SKU3";
 114         case DEV_SKU_4:
 115                 return "SKU4";
 116         case DEV_SKU_UNKNOWN:
 117         default:
 118                 break;
 119         }
 120         return "Unknown SKU";
 121 }
 122
 123 struct adf_hw_device_class {
 124         const char *name;
 125         const enum adf_device_type type;
 126         uint32_t instances;
 127 } __packed;
 128
 129 struct adf_cfg_device_data;
 130 struct adf_accel_dev;
 131 struct adf_etr_data;
 132 struct adf_etr_ring_data;
 133
 134 struct adf_hw_device_data {
 135         struct adf_hw_device_class *dev_class;
 136         uint32_t (*get_accel_mask)(uint32_t fuse);
 137         uint32_t (*get_ae_mask)(uint32_t fuse);
 138         uint32_t (*get_sram_bar_id)(struct adf_hw_device_data *self);
 139         uint32_t (*get_misc_bar_id)(struct adf_hw_device_data *self);
 140         uint32_t (*get_etr_bar_id)(struct adf_hw_device_data *self);
 141         uint32_t (*get_num_aes)(struct adf_hw_device_data *self);
 142         uint32_t (*get_num_accels)(struct adf_hw_device_data *self);
 143         enum dev_sku_info (*get_sku)(struct adf_hw_device_data *self);
 144         void (*hw_arb_ring_enable)(struct adf_etr_ring_data *ring);
 145         void (*hw_arb_ring_disable)(struct adf_etr_ring_data *ring);
 146         int (*alloc_irq)(struct adf_accel_dev *accel_dev);
 147         void (*free_irq)(struct adf_accel_dev *accel_dev);
 148         void (*enable_error_correction)(struct adf_accel_dev *accel_dev);
 149         int (*init_admin_comms)(struct adf_accel_dev *accel_dev);
 150         void (*exit_admin_comms)(struct adf_accel_dev *accel_dev);
 151         int (*init_arb)(struct adf_accel_dev *accel_dev);
 152         void (*exit_arb)(struct adf_accel_dev *accel_dev);
 153         void (*enable_ints)(struct adf_accel_dev *accel_dev);
 154         const char *fw_name;
 155         uint32_t pci_dev_id;
 156         uint32_t fuses;
 157         uint32_t accel_capabilities_mask;
 158         uint16_t accel_mask;
 159         uint16_t ae_mask;
 160         uint16_t tx_rings_mask;
 161         uint8_t tx_rx_gap;
 162         uint8_t instance_id;
 163         uint8_t num_banks;
 164         uint8_t num_accel;
 165         uint8_t num_logical_accel;
 166         uint8_t num_engines;
 167 } __packed;
 168
 169 /* CSR write macro */
 170 #define ADF_CSR_WR(csr_base, csr_offset, val) \
 171         __raw_writel(val, csr_base + csr_offset)
 172
 173 /* CSR read macro */
 174 #define ADF_CSR_RD(csr_base, csr_offset) __raw_readl(csr_base + csr_offset)
 175
 176 #define GET_DEV(accel_dev) ((accel_dev)->accel_pci_dev.pci_dev->dev)
 177 #define GET_BARS(accel_dev) ((accel_dev)->accel_pci_dev.pci_bars)
 178 #define GET_HW_DATA(accel_dev) (accel_dev->hw_device)
 179 #define GET_MAX_BANKS(accel_dev) (GET_HW_DATA(accel_dev)->num_banks)
 180 #define GET_MAX_ACCELENGINES(accel_dev) (GET_HW_DATA(accel_dev)->num_engines)
 181 #define accel_to_pci_dev(accel_ptr) accel_ptr->accel_pci_dev.pci_dev
 182
 183 struct adf_admin_comms;
 184 struct icp_qat_fw_loader_handle;
 185 struct adf_fw_loader_data {
 186         struct icp_qat_fw_loader_handle *fw_loader;
 187         const struct firmware *uof_fw;
 188 };
 189
 190 struct adf_accel_dev {
 191         struct adf_etr_data *transport;
 192         struct adf_hw_device_data *hw_device;
 193         struct adf_cfg_device_data *cfg;
 194         struct adf_fw_loader_data *fw_loader;
 195         struct adf_admin_comms *admin;
 196         struct list_head crypto_list;
 197         unsigned long status;
 198         atomic_t ref_count;
 199         struct dentry *debugfs_dir;
 200         struct list_head list;
 201         struct module *owner;
 202         struct adf_accel_pci accel_pci_dev;
 203         uint8_t accel_id;
 204 } __packed;
 205 #endif