linux/drivers/scsi/bnx2fc/bnx2fc_constants.h

/* bnx2fc_constants.h: QLogic Linux FCoE offload driver.
 * Handles operations such as session offload/upload etc, and manages
 * session resources such as connection id and qp resources.
 *
 * Copyright (c) 2008-2013 Broadcom Corporation
 * Copyright (c) 2014-2016 QLogic Corporation
 * Copyright (c) 2016-2017 Cavium Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation.
 *
 */

#ifndef __BNX2FC_CONSTANTS_H_
#define __BNX2FC_CONSTANTS_H_

/**
 * This file defines HSI constants for the FCoE flows
 */

/* Current FCoE HSI version number composed of two fields (16 bit) */
/* Implies on a change broken previous HSI */
#define FCOE_HSI_MAJOR_VERSION
/* Implies on a change which does not broken previous HSI */
#define FCOE_HSI_MINOR_VERSION

/* KWQ/KCQ FCoE layer code */
#define FCOE_KWQE_LAYER_CODE

/* KWQ (kernel work queue) request op codes */
#define FCOE_KWQE_OPCODE_INIT1
#define FCOE_KWQE_OPCODE_INIT2
#define FCOE_KWQE_OPCODE_INIT3
#define FCOE_KWQE_OPCODE_OFFLOAD_CONN1
#define FCOE_KWQE_OPCODE_OFFLOAD_CONN2
#define FCOE_KWQE_OPCODE_OFFLOAD_CONN3
#define FCOE_KWQE_OPCODE_OFFLOAD_CONN4
#define FCOE_KWQE_OPCODE_ENABLE_CONN
#define FCOE_KWQE_OPCODE_DISABLE_CONN
#define FCOE_KWQE_OPCODE_DESTROY_CONN
#define FCOE_KWQE_OPCODE_DESTROY
#define FCOE_KWQE_OPCODE_STAT

/* KCQ (kernel completion queue) response op codes */
#define FCOE_KCQE_OPCODE_INIT_FUNC
#define FCOE_KCQE_OPCODE_DESTROY_FUNC
#define FCOE_KCQE_OPCODE_STAT_FUNC
#define FCOE_KCQE_OPCODE_OFFLOAD_CONN
#define FCOE_KCQE_OPCODE_ENABLE_CONN
#define FCOE_KCQE_OPCODE_DISABLE_CONN
#define FCOE_KCQE_OPCODE_DESTROY_CONN
#define FCOE_KCQE_OPCODE_CQ_EVENT_NOTIFICATION
#define FCOE_KCQE_OPCODE_FCOE_ERROR

/* KCQ (kernel completion queue) completion status */
#define FCOE_KCQE_COMPLETION_STATUS_SUCCESS
#define FCOE_KCQE_COMPLETION_STATUS_ERROR
#define FCOE_KCQE_COMPLETION_STATUS_INVALID_OPCODE
#define FCOE_KCQE_COMPLETION_STATUS_CTX_ALLOC_FAILURE
#define FCOE_KCQE_COMPLETION_STATUS_CTX_FREE_FAILURE
#define FCOE_KCQE_COMPLETION_STATUS_NIC_ERROR
#define FCOE_KCQE_COMPLETION_STATUS_WRONG_HSI_VERSION
#define FCOE_KCQE_COMPLETION_STATUS_PARITY_ERROR

/* CQE type */
#define FCOE_PENDING_CQE_TYPE
#define FCOE_UNSOLIC_CQE_TYPE

/* Unsolicited CQE type */
#define FCOE_UNSOLICITED_FRAME_CQE_TYPE
#define FCOE_ERROR_DETECTION_CQE_TYPE
#define FCOE_WARNING_DETECTION_CQE_TYPE

/* E_D_TOV timer resolution in ms */
#define FCOE_E_D_TOV_TIMER_RESOLUTION_MS

/* E_D_TOV timer resolution for SDM (4 micro) */
#define FCOE_E_D_TOV_SDM_TIMER_RESOLUTION

/* REC timer resolution in ms */
#define FCOE_REC_TIMER_RESOLUTION_MS

/* REC timer resolution for SDM (4 micro) */
#define FCOE_REC_SDM_TIMER_RESOLUTION

/* E_D_TOV timer default wraparound value (2 sec) in 20 ms resolution */
#define FCOE_E_D_TOV_DEFAULT_WRAPAROUND_VAL

/* REC_TOV timer default wraparound value (3 sec) in 20 ms resolution */
#define FCOE_REC_TOV_DEFAULT_WRAPAROUND_VAL

#define FCOE_NUM_OF_TIMER_TASKS

#define FCOE_NUM_OF_CACHED_TASKS_TIMER

/* Task context constants */
/******** Remove FCP_CMD write tce sleep ***********************/
/* In case timer services are required then shall be updated by Xstorm after
 * start processing the task. In case no timer facilities are required then the
 * driver would initialize the state to this value
 *
#define	FCOE_TASK_TX_STATE_NORMAL				0
 * After driver has initialize the task in case timer services required *
#define	FCOE_TASK_TX_STATE_INIT					1
******** Remove FCP_CMD write tce sleep ***********************/
/* After driver has initialize the task in case timer services required */
#define FCOE_TASK_TX_STATE_INIT
/* In case timer services are required then shall be updated by Xstorm after
 * start processing the task. In case no timer facilities are required then the
 * driver would initialize the state to this value
 */
#define FCOE_TASK_TX_STATE_NORMAL
/* Task is under abort procedure. Updated in order to stop processing of
 * pending WQEs on this task
 */
#define FCOE_TASK_TX_STATE_ABORT
/* For E_D_T_TOV timer expiration in Xstorm (Class 2 only) */
#define FCOE_TASK_TX_STATE_ERROR
/* For REC_TOV timer expiration indication received from Xstorm */
#define FCOE_TASK_TX_STATE_WARNING
/* For completed unsolicited task */
#define FCOE_TASK_TX_STATE_UNSOLICITED_COMPLETED
/* For exchange cleanup request task */
#define FCOE_TASK_TX_STATE_EXCHANGE_CLEANUP
/* For sequence cleanup request task */
#define FCOE_TASK_TX_STATE_SEQUENCE_CLEANUP
/* For completion the ABTS task. */
#define FCOE_TASK_TX_STATE_ABTS_TX

#define FCOE_TASK_RX_STATE_NORMAL
#define FCOE_TASK_RX_STATE_COMPLETED
/* Obsolete: Intermediate completion (middle path with local completion) */
#define FCOE_TASK_RX_STATE_INTER_COMP
/* For REC_TOV timer expiration indication received from Xstorm */
#define FCOE_TASK_RX_STATE_WARNING
/* For E_D_T_TOV timer expiration in Ustorm */
#define FCOE_TASK_RX_STATE_ERROR
/* FW only: First visit at rx-path, part of the abts round trip */
#define FCOE_TASK_RX_STATE_ABTS_IN_PROCESS
/* FW only: Second visit at rx-path, after ABTS frame transmitted */
#define FCOE_TASK_RX_STATE_ABTS_TRANSMITTED
/* Special completion indication in case of task was aborted. */
#define FCOE_TASK_RX_STATE_ABTS_COMPLETED
/* FW only: First visit at rx-path, part of the cleanup round trip */
#define FCOE_TASK_RX_STATE_EXCHANGE_CLEANUP_IN_PROCESS
/* FW only: Special completion indication in case of task was cleaned. */
#define FCOE_TASK_RX_STATE_EXCHANGE_CLEANUP_COMPLETED
/* Not in used: Special completion indication (in task requested the exchange
 * cleanup) in case cleaned task is in non-valid.
 */
#define FCOE_TASK_RX_STATE_ABORT_CLEANUP_COMPLETED
/* Special completion indication (in task requested the sequence cleanup) in
 * case cleaned task was already returned to normal.
 */
#define FCOE_TASK_RX_STATE_IGNORED_SEQUENCE_CLEANUP


#define FCOE_TASK_TYPE_WRITE
#define FCOE_TASK_TYPE_READ
#define FCOE_TASK_TYPE_MIDPATH
#define FCOE_TASK_TYPE_UNSOLICITED
#define FCOE_TASK_TYPE_ABTS
#define FCOE_TASK_TYPE_EXCHANGE_CLEANUP
#define FCOE_TASK_TYPE_SEQUENCE_CLEANUP

#define FCOE_TASK_DEV_TYPE_DISK
#define FCOE_TASK_DEV_TYPE_TAPE

#define FCOE_TASK_CLASS_TYPE_3
#define FCOE_TASK_CLASS_TYPE_2

/* FCoE/FC packet fields  */
#define FCOE_ETH_TYPE

/* FCoE maximum elements in hash table */
#define FCOE_MAX_ELEMENTS_IN_HASH_TABLE_ROW

/* FCoE half of the elements in hash table */
#define FCOE_HALF_ELEMENTS_IN_HASH_TABLE_ROW

/* FcoE number of cached T2 entries */
#define T_FCOE_NUMBER_OF_CACHED_T2_ENTRIES

/* FCoE maximum elements in hash table */
#define FCOE_HASH_TBL_CHUNK_SIZE

/* Everest FCoE connection type */
#define B577XX_FCOE_CONNECTION_TYPE

/* FCoE number of rows (in log). This number derives
 * from the maximum connections supported which is 2048.
 * TBA: Need a different constant for E2
 */
#define FCOE_MAX_NUM_SESSIONS_LOG

#define FC_ABTS_REPLY_MAX_PAYLOAD_LEN

/* Error codes for Error Reporting in slow path flows */
#define FCOE_SLOW_PATH_ERROR_CODE_TOO_MANY_FUNCS
#define FCOE_SLOW_PATH_ERROR_CODE_NO_LICENSE

/* Error codes for Error Reporting in fast path flows
 * XFER error codes
 */
#define FCOE_ERROR_CODE_XFER_OOO_RO
#define FCOE_ERROR_CODE_XFER_RO_NOT_ALIGNED
#define FCOE_ERROR_CODE_XFER_NULL_BURST_LEN
#define FCOE_ERROR_CODE_XFER_RO_GREATER_THAN_DATA2TRNS
#define FCOE_ERROR_CODE_XFER_INVALID_PAYLOAD_SIZE
#define FCOE_ERROR_CODE_XFER_TASK_TYPE_NOT_WRITE
#define FCOE_ERROR_CODE_XFER_PEND_XFER_SET
#define FCOE_ERROR_CODE_XFER_OPENED_SEQ
#define FCOE_ERROR_CODE_XFER_FCTL

/* FCP RSP error codes */
#define FCOE_ERROR_CODE_FCP_RSP_BIDI_FLAGS_SET
#define FCOE_ERROR_CODE_FCP_RSP_UNDERFLOW
#define FCOE_ERROR_CODE_FCP_RSP_OVERFLOW
#define FCOE_ERROR_CODE_FCP_RSP_INVALID_LENGTH_FIELD
#define FCOE_ERROR_CODE_FCP_RSP_INVALID_SNS_FIELD
#define FCOE_ERROR_CODE_FCP_RSP_INVALID_PAYLOAD_SIZE
#define FCOE_ERROR_CODE_FCP_RSP_PEND_XFER_SET
#define FCOE_ERROR_CODE_FCP_RSP_OPENED_SEQ
#define FCOE_ERROR_CODE_FCP_RSP_FCTL
#define FCOE_ERROR_CODE_FCP_RSP_LAST_SEQ_RESET
#define FCOE_ERROR_CODE_FCP_RSP_CONF_REQ_NOT_SUPPORTED_YET

/* FCP DATA error codes */
#define FCOE_ERROR_CODE_DATA_OOO_RO
#define FCOE_ERROR_CODE_DATA_EXCEEDS_DEFINED_MAX_FRAME_SIZE
#define FCOE_ERROR_CODE_DATA_EXCEEDS_DATA2TRNS
#define FCOE_ERROR_CODE_DATA_SOFI3_SEQ_ACTIVE_SET
#define FCOE_ERROR_CODE_DATA_SOFN_SEQ_ACTIVE_RESET
#define FCOE_ERROR_CODE_DATA_EOFN_END_SEQ_SET
#define FCOE_ERROR_CODE_DATA_EOFT_END_SEQ_RESET
#define FCOE_ERROR_CODE_DATA_TASK_TYPE_NOT_READ
#define FCOE_ERROR_CODE_DATA_FCTL

/* Middle path error codes */
#define FCOE_ERROR_CODE_MIDPATH_INVALID_TYPE
#define FCOE_ERROR_CODE_MIDPATH_SOFI3_SEQ_ACTIVE_SET
#define FCOE_ERROR_CODE_MIDPATH_SOFN_SEQ_ACTIVE_RESET
#define FCOE_ERROR_CODE_MIDPATH_EOFN_END_SEQ_SET
#define FCOE_ERROR_CODE_MIDPATH_EOFT_END_SEQ_RESET
#define FCOE_ERROR_CODE_MIDPATH_REPLY_FCTL
#define FCOE_ERROR_CODE_MIDPATH_INVALID_REPLY
#define FCOE_ERROR_CODE_MIDPATH_ELS_REPLY_RCTL

/* ABTS error codes */
#define FCOE_ERROR_CODE_ABTS_REPLY_F_CTL
#define FCOE_ERROR_CODE_ABTS_REPLY_DDF_RCTL_FIELD
#define FCOE_ERROR_CODE_ABTS_REPLY_INVALID_BLS_RCTL
#define FCOE_ERROR_CODE_ABTS_REPLY_INVALID_RCTL
#define FCOE_ERROR_CODE_ABTS_REPLY_RCTL_GENERAL_MISMATCH

/* Common error codes */
#define FCOE_ERROR_CODE_COMMON_MIDDLE_FRAME_WITH_PAD
#define FCOE_ERROR_CODE_COMMON_SEQ_INIT_IN_TCE
#define FCOE_ERROR_CODE_COMMON_FC_HDR_RX_ID_MISMATCH
#define FCOE_ERROR_CODE_COMMON_INCORRECT_SEQ_CNT
#define FCOE_ERROR_CODE_COMMON_DATA_FC_HDR_FCP_TYPE_MISMATCH
#define FCOE_ERROR_CODE_COMMON_DATA_NO_MORE_SGES
#define FCOE_ERROR_CODE_COMMON_OPTIONAL_FC_HDR
#define FCOE_ERROR_CODE_COMMON_READ_TCE_OX_ID_TOO_BIG
#define FCOE_ERROR_CODE_COMMON_DATA_WAS_NOT_TRANSMITTED

/* Unsolicited Rx error codes */
#define FCOE_ERROR_CODE_UNSOLICITED_TYPE_NOT_ELS
#define FCOE_ERROR_CODE_UNSOLICITED_TYPE_NOT_BLS
#define FCOE_ERROR_CODE_UNSOLICITED_FCTL_ELS
#define FCOE_ERROR_CODE_UNSOLICITED_FCTL_BLS
#define FCOE_ERROR_CODE_UNSOLICITED_R_CTL

#define FCOE_ERROR_CODE_RW_TASK_DDF_RCTL_INFO_FIELD
#define FCOE_ERROR_CODE_RW_TASK_INVALID_RCTL
#define FCOE_ERROR_CODE_RW_TASK_RCTL_GENERAL_MISMATCH

/* Timer error codes */
#define FCOE_ERROR_CODE_E_D_TOV_TIMER_EXPIRATION
#define FCOE_ERROR_CODE_REC_TOV_TIMER_EXPIRATION


#endif /* BNX2FC_CONSTANTS_H_ */