317 lines
11 KiB
C
317 lines
11 KiB
C
/*
|
|
This file is provided under a dual BSD/GPLv2 license. When using or
|
|
redistributing this file, you may do so under either license.
|
|
|
|
GPL LICENSE SUMMARY
|
|
Copyright(c) 2014 Intel Corporation.
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of version 2 of the GNU General Public License as
|
|
published by the Free Software Foundation.
|
|
|
|
This program is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
Contact Information:
|
|
qat-linux@intel.com
|
|
|
|
BSD LICENSE
|
|
Copyright(c) 2014 Intel Corporation.
|
|
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.
|
|
*/
|
|
#ifndef _ICP_QAT_FW_H_
|
|
#define _ICP_QAT_FW_H_
|
|
#include <linux/types.h>
|
|
#include "icp_qat_hw.h"
|
|
|
|
#define QAT_FIELD_SET(flags, val, bitpos, mask) \
|
|
{ (flags) = (((flags) & (~((mask) << (bitpos)))) | \
|
|
(((val) & (mask)) << (bitpos))) ; }
|
|
|
|
#define QAT_FIELD_GET(flags, bitpos, mask) \
|
|
(((flags) >> (bitpos)) & (mask))
|
|
|
|
#define ICP_QAT_FW_REQ_DEFAULT_SZ 128
|
|
#define ICP_QAT_FW_RESP_DEFAULT_SZ 32
|
|
#define ICP_QAT_FW_COMN_ONE_BYTE_SHIFT 8
|
|
#define ICP_QAT_FW_COMN_SINGLE_BYTE_MASK 0xFF
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_1 1
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_2 2
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_3 3
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_4 4
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_5 5
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_6 6
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_7 7
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_10 10
|
|
#define ICP_QAT_FW_NUM_LONGWORDS_13 13
|
|
#define ICP_QAT_FW_NULL_REQ_SERV_ID 1
|
|
|
|
enum icp_qat_fw_comn_resp_serv_id {
|
|
ICP_QAT_FW_COMN_RESP_SERV_NULL,
|
|
ICP_QAT_FW_COMN_RESP_SERV_CPM_FW,
|
|
ICP_QAT_FW_COMN_RESP_SERV_DELIMITER
|
|
};
|
|
|
|
enum icp_qat_fw_comn_request_id {
|
|
ICP_QAT_FW_COMN_REQ_NULL = 0,
|
|
ICP_QAT_FW_COMN_REQ_CPM_FW_PKE = 3,
|
|
ICP_QAT_FW_COMN_REQ_CPM_FW_LA = 4,
|
|
ICP_QAT_FW_COMN_REQ_CPM_FW_DMA = 7,
|
|
ICP_QAT_FW_COMN_REQ_CPM_FW_COMP = 9,
|
|
ICP_QAT_FW_COMN_REQ_DELIMITER
|
|
};
|
|
|
|
struct icp_qat_fw_comn_req_hdr_cd_pars {
|
|
union {
|
|
struct {
|
|
uint64_t content_desc_addr;
|
|
uint16_t content_desc_resrvd1;
|
|
uint8_t content_desc_params_sz;
|
|
uint8_t content_desc_hdr_resrvd2;
|
|
uint32_t content_desc_resrvd3;
|
|
} s;
|
|
struct {
|
|
uint32_t serv_specif_fields[4];
|
|
} s1;
|
|
} u;
|
|
};
|
|
|
|
struct icp_qat_fw_comn_req_mid {
|
|
uint64_t opaque_data;
|
|
uint64_t src_data_addr;
|
|
uint64_t dest_data_addr;
|
|
uint32_t src_length;
|
|
uint32_t dst_length;
|
|
};
|
|
|
|
struct icp_qat_fw_comn_req_cd_ctrl {
|
|
uint32_t content_desc_ctrl_lw[ICP_QAT_FW_NUM_LONGWORDS_5];
|
|
};
|
|
|
|
struct icp_qat_fw_comn_req_hdr {
|
|
uint8_t resrvd1;
|
|
uint8_t service_cmd_id;
|
|
uint8_t service_type;
|
|
uint8_t hdr_flags;
|
|
uint16_t serv_specif_flags;
|
|
uint16_t comn_req_flags;
|
|
};
|
|
|
|
struct icp_qat_fw_comn_req_rqpars {
|
|
uint32_t serv_specif_rqpars_lw[ICP_QAT_FW_NUM_LONGWORDS_13];
|
|
};
|
|
|
|
struct icp_qat_fw_comn_req {
|
|
struct icp_qat_fw_comn_req_hdr comn_hdr;
|
|
struct icp_qat_fw_comn_req_hdr_cd_pars cd_pars;
|
|
struct icp_qat_fw_comn_req_mid comn_mid;
|
|
struct icp_qat_fw_comn_req_rqpars serv_specif_rqpars;
|
|
struct icp_qat_fw_comn_req_cd_ctrl cd_ctrl;
|
|
};
|
|
|
|
struct icp_qat_fw_comn_error {
|
|
uint8_t xlat_err_code;
|
|
uint8_t cmp_err_code;
|
|
};
|
|
|
|
struct icp_qat_fw_comn_resp_hdr {
|
|
uint8_t resrvd1;
|
|
uint8_t service_id;
|
|
uint8_t response_type;
|
|
uint8_t hdr_flags;
|
|
struct icp_qat_fw_comn_error comn_error;
|
|
uint8_t comn_status;
|
|
uint8_t cmd_id;
|
|
};
|
|
|
|
struct icp_qat_fw_comn_resp {
|
|
struct icp_qat_fw_comn_resp_hdr comn_hdr;
|
|
uint64_t opaque_data;
|
|
uint32_t resrvd[ICP_QAT_FW_NUM_LONGWORDS_4];
|
|
};
|
|
|
|
#define ICP_QAT_FW_COMN_REQ_FLAG_SET 1
|
|
#define ICP_QAT_FW_COMN_REQ_FLAG_CLR 0
|
|
#define ICP_QAT_FW_COMN_VALID_FLAG_BITPOS 7
|
|
#define ICP_QAT_FW_COMN_VALID_FLAG_MASK 0x1
|
|
#define ICP_QAT_FW_COMN_HDR_RESRVD_FLD_MASK 0x7F
|
|
|
|
#define ICP_QAT_FW_COMN_OV_SRV_TYPE_GET(icp_qat_fw_comn_req_hdr_t) \
|
|
icp_qat_fw_comn_req_hdr_t.service_type
|
|
|
|
#define ICP_QAT_FW_COMN_OV_SRV_TYPE_SET(icp_qat_fw_comn_req_hdr_t, val) \
|
|
icp_qat_fw_comn_req_hdr_t.service_type = val
|
|
|
|
#define ICP_QAT_FW_COMN_OV_SRV_CMD_ID_GET(icp_qat_fw_comn_req_hdr_t) \
|
|
icp_qat_fw_comn_req_hdr_t.service_cmd_id
|
|
|
|
#define ICP_QAT_FW_COMN_OV_SRV_CMD_ID_SET(icp_qat_fw_comn_req_hdr_t, val) \
|
|
icp_qat_fw_comn_req_hdr_t.service_cmd_id = val
|
|
|
|
#define ICP_QAT_FW_COMN_HDR_VALID_FLAG_GET(hdr_t) \
|
|
ICP_QAT_FW_COMN_VALID_FLAG_GET(hdr_t.hdr_flags)
|
|
|
|
#define ICP_QAT_FW_COMN_HDR_VALID_FLAG_SET(hdr_t, val) \
|
|
ICP_QAT_FW_COMN_VALID_FLAG_SET(hdr_t, val)
|
|
|
|
#define ICP_QAT_FW_COMN_VALID_FLAG_GET(hdr_flags) \
|
|
QAT_FIELD_GET(hdr_flags, \
|
|
ICP_QAT_FW_COMN_VALID_FLAG_BITPOS, \
|
|
ICP_QAT_FW_COMN_VALID_FLAG_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_HDR_RESRVD_FLD_GET(hdr_flags) \
|
|
(hdr_flags & ICP_QAT_FW_COMN_HDR_RESRVD_FLD_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_VALID_FLAG_SET(hdr_t, val) \
|
|
QAT_FIELD_SET((hdr_t.hdr_flags), (val), \
|
|
ICP_QAT_FW_COMN_VALID_FLAG_BITPOS, \
|
|
ICP_QAT_FW_COMN_VALID_FLAG_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_HDR_FLAGS_BUILD(valid) \
|
|
(((valid) & ICP_QAT_FW_COMN_VALID_FLAG_MASK) << \
|
|
ICP_QAT_FW_COMN_VALID_FLAG_BITPOS)
|
|
|
|
#define QAT_COMN_PTR_TYPE_BITPOS 0
|
|
#define QAT_COMN_PTR_TYPE_MASK 0x1
|
|
#define QAT_COMN_CD_FLD_TYPE_BITPOS 1
|
|
#define QAT_COMN_CD_FLD_TYPE_MASK 0x1
|
|
#define QAT_COMN_PTR_TYPE_FLAT 0x0
|
|
#define QAT_COMN_PTR_TYPE_SGL 0x1
|
|
#define QAT_COMN_CD_FLD_TYPE_64BIT_ADR 0x0
|
|
#define QAT_COMN_CD_FLD_TYPE_16BYTE_DATA 0x1
|
|
|
|
#define ICP_QAT_FW_COMN_FLAGS_BUILD(cdt, ptr) \
|
|
((((cdt) & QAT_COMN_CD_FLD_TYPE_MASK) << QAT_COMN_CD_FLD_TYPE_BITPOS) \
|
|
| (((ptr) & QAT_COMN_PTR_TYPE_MASK) << QAT_COMN_PTR_TYPE_BITPOS))
|
|
|
|
#define ICP_QAT_FW_COMN_PTR_TYPE_GET(flags) \
|
|
QAT_FIELD_GET(flags, QAT_COMN_PTR_TYPE_BITPOS, QAT_COMN_PTR_TYPE_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_CD_FLD_TYPE_GET(flags) \
|
|
QAT_FIELD_GET(flags, QAT_COMN_CD_FLD_TYPE_BITPOS, \
|
|
QAT_COMN_CD_FLD_TYPE_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_PTR_TYPE_SET(flags, val) \
|
|
QAT_FIELD_SET(flags, val, QAT_COMN_PTR_TYPE_BITPOS, \
|
|
QAT_COMN_PTR_TYPE_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_CD_FLD_TYPE_SET(flags, val) \
|
|
QAT_FIELD_SET(flags, val, QAT_COMN_CD_FLD_TYPE_BITPOS, \
|
|
QAT_COMN_CD_FLD_TYPE_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_NEXT_ID_BITPOS 4
|
|
#define ICP_QAT_FW_COMN_NEXT_ID_MASK 0xF0
|
|
#define ICP_QAT_FW_COMN_CURR_ID_BITPOS 0
|
|
#define ICP_QAT_FW_COMN_CURR_ID_MASK 0x0F
|
|
|
|
#define ICP_QAT_FW_COMN_NEXT_ID_GET(cd_ctrl_hdr_t) \
|
|
((((cd_ctrl_hdr_t)->next_curr_id) & ICP_QAT_FW_COMN_NEXT_ID_MASK) \
|
|
>> (ICP_QAT_FW_COMN_NEXT_ID_BITPOS))
|
|
|
|
#define ICP_QAT_FW_COMN_NEXT_ID_SET(cd_ctrl_hdr_t, val) \
|
|
{ ((cd_ctrl_hdr_t)->next_curr_id) = ((((cd_ctrl_hdr_t)->next_curr_id) \
|
|
& ICP_QAT_FW_COMN_CURR_ID_MASK) | \
|
|
((val << ICP_QAT_FW_COMN_NEXT_ID_BITPOS) \
|
|
& ICP_QAT_FW_COMN_NEXT_ID_MASK)); }
|
|
|
|
#define ICP_QAT_FW_COMN_CURR_ID_GET(cd_ctrl_hdr_t) \
|
|
(((cd_ctrl_hdr_t)->next_curr_id) & ICP_QAT_FW_COMN_CURR_ID_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_CURR_ID_SET(cd_ctrl_hdr_t, val) \
|
|
{ ((cd_ctrl_hdr_t)->next_curr_id) = ((((cd_ctrl_hdr_t)->next_curr_id) \
|
|
& ICP_QAT_FW_COMN_NEXT_ID_MASK) | \
|
|
((val) & ICP_QAT_FW_COMN_CURR_ID_MASK)); }
|
|
|
|
#define QAT_COMN_RESP_CRYPTO_STATUS_BITPOS 7
|
|
#define QAT_COMN_RESP_CRYPTO_STATUS_MASK 0x1
|
|
#define QAT_COMN_RESP_CMP_STATUS_BITPOS 5
|
|
#define QAT_COMN_RESP_CMP_STATUS_MASK 0x1
|
|
#define QAT_COMN_RESP_XLAT_STATUS_BITPOS 4
|
|
#define QAT_COMN_RESP_XLAT_STATUS_MASK 0x1
|
|
#define QAT_COMN_RESP_CMP_END_OF_LAST_BLK_BITPOS 3
|
|
#define QAT_COMN_RESP_CMP_END_OF_LAST_BLK_MASK 0x1
|
|
|
|
#define ICP_QAT_FW_COMN_RESP_STATUS_BUILD(crypto, comp, xlat, eolb) \
|
|
((((crypto) & QAT_COMN_RESP_CRYPTO_STATUS_MASK) << \
|
|
QAT_COMN_RESP_CRYPTO_STATUS_BITPOS) | \
|
|
(((comp) & QAT_COMN_RESP_CMP_STATUS_MASK) << \
|
|
QAT_COMN_RESP_CMP_STATUS_BITPOS) | \
|
|
(((xlat) & QAT_COMN_RESP_XLAT_STATUS_MASK) << \
|
|
QAT_COMN_RESP_XLAT_STATUS_BITPOS) | \
|
|
(((eolb) & QAT_COMN_RESP_CMP_END_OF_LAST_BLK_MASK) << \
|
|
QAT_COMN_RESP_CMP_END_OF_LAST_BLK_BITPOS))
|
|
|
|
#define ICP_QAT_FW_COMN_RESP_CRYPTO_STAT_GET(status) \
|
|
QAT_FIELD_GET(status, QAT_COMN_RESP_CRYPTO_STATUS_BITPOS, \
|
|
QAT_COMN_RESP_CRYPTO_STATUS_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_RESP_CMP_STAT_GET(status) \
|
|
QAT_FIELD_GET(status, QAT_COMN_RESP_CMP_STATUS_BITPOS, \
|
|
QAT_COMN_RESP_CMP_STATUS_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_RESP_XLAT_STAT_GET(status) \
|
|
QAT_FIELD_GET(status, QAT_COMN_RESP_XLAT_STATUS_BITPOS, \
|
|
QAT_COMN_RESP_XLAT_STATUS_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_RESP_CMP_END_OF_LAST_BLK_FLAG_GET(status) \
|
|
QAT_FIELD_GET(status, QAT_COMN_RESP_CMP_END_OF_LAST_BLK_BITPOS, \
|
|
QAT_COMN_RESP_CMP_END_OF_LAST_BLK_MASK)
|
|
|
|
#define ICP_QAT_FW_COMN_STATUS_FLAG_OK 0
|
|
#define ICP_QAT_FW_COMN_STATUS_FLAG_ERROR 1
|
|
#define ICP_QAT_FW_COMN_STATUS_CMP_END_OF_LAST_BLK_FLAG_CLR 0
|
|
#define ICP_QAT_FW_COMN_STATUS_CMP_END_OF_LAST_BLK_FLAG_SET 1
|
|
#define ERR_CODE_NO_ERROR 0
|
|
#define ERR_CODE_INVALID_BLOCK_TYPE -1
|
|
#define ERR_CODE_NO_MATCH_ONES_COMP -2
|
|
#define ERR_CODE_TOO_MANY_LEN_OR_DIS -3
|
|
#define ERR_CODE_INCOMPLETE_LEN -4
|
|
#define ERR_CODE_RPT_LEN_NO_FIRST_LEN -5
|
|
#define ERR_CODE_RPT_GT_SPEC_LEN -6
|
|
#define ERR_CODE_INV_LIT_LEN_CODE_LEN -7
|
|
#define ERR_CODE_INV_DIS_CODE_LEN -8
|
|
#define ERR_CODE_INV_LIT_LEN_DIS_IN_BLK -9
|
|
#define ERR_CODE_DIS_TOO_FAR_BACK -10
|
|
#define ERR_CODE_OVERFLOW_ERROR -11
|
|
#define ERR_CODE_SOFT_ERROR -12
|
|
#define ERR_CODE_FATAL_ERROR -13
|
|
#define ERR_CODE_SSM_ERROR -14
|
|
#define ERR_CODE_ENDPOINT_ERROR -15
|
|
|
|
enum icp_qat_fw_slice {
|
|
ICP_QAT_FW_SLICE_NULL = 0,
|
|
ICP_QAT_FW_SLICE_CIPHER = 1,
|
|
ICP_QAT_FW_SLICE_AUTH = 2,
|
|
ICP_QAT_FW_SLICE_DRAM_RD = 3,
|
|
ICP_QAT_FW_SLICE_DRAM_WR = 4,
|
|
ICP_QAT_FW_SLICE_COMP = 5,
|
|
ICP_QAT_FW_SLICE_XLAT = 6,
|
|
ICP_QAT_FW_SLICE_DELIMITER
|
|
};
|
|
#endif
|