include/linux/qed/qed_iscsi_if.h

   1 /* QLogic qed NIC Driver
   2  * Copyright (c) 2015-2017  QLogic Corporation
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and /or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef _QED_ISCSI_IF_H
  34 #define _QED_ISCSI_IF_H
  35 #include <linux/types.h>
  36 #include <linux/qed/qed_if.h>
  37
  38 typedef int (*iscsi_event_cb_t) (void *context,
  39                                  u8 fw_event_code, void *fw_handle);
  40 struct qed_iscsi_stats {
  41         u64 iscsi_rx_bytes_cnt;
  42         u64 iscsi_rx_packet_cnt;
  43         u64 iscsi_rx_new_ooo_isle_events_cnt;
  44         u32 iscsi_cmdq_threshold_cnt;
  45         u32 iscsi_rq_threshold_cnt;
  46         u32 iscsi_immq_threshold_cnt;
  47
  48         u64 iscsi_rx_dropped_pdus_task_not_valid;
  49
  50         u64 iscsi_rx_data_pdu_cnt;
  51         u64 iscsi_rx_r2t_pdu_cnt;
  52         u64 iscsi_rx_total_pdu_cnt;
  53
  54         u64 iscsi_tx_go_to_slow_start_event_cnt;
  55         u64 iscsi_tx_fast_retransmit_event_cnt;
  56
  57         u64 iscsi_tx_data_pdu_cnt;
  58         u64 iscsi_tx_r2t_pdu_cnt;
  59         u64 iscsi_tx_total_pdu_cnt;
  60
  61         u64 iscsi_tx_bytes_cnt;
  62         u64 iscsi_tx_packet_cnt;
  63 };
  64
  65 struct qed_dev_iscsi_info {
  66         struct qed_dev_info common;
  67
  68         void __iomem *primary_dbq_rq_addr;
  69         void __iomem *secondary_bdq_rq_addr;
  70
  71         u8 num_cqs;
  72 };
  73
  74 struct qed_iscsi_id_params {
  75         u8 mac[ETH_ALEN];
  76         u32 ip[4];
  77         u16 port;
  78 };
  79
  80 struct qed_iscsi_params_offload {
  81         u8 layer_code;
  82         dma_addr_t sq_pbl_addr;
  83         u32 initial_ack;
  84
  85         struct qed_iscsi_id_params src;
  86         struct qed_iscsi_id_params dst;
  87         u16 vlan_id;
  88         u8 tcp_flags;
  89         u8 ip_version;
  90         u8 default_cq;
  91
  92         u8 ka_max_probe_cnt;
  93         u8 dup_ack_theshold;
  94         u32 rcv_next;
  95         u32 snd_una;
  96         u32 snd_next;
  97         u32 snd_max;
  98         u32 snd_wnd;
  99         u32 rcv_wnd;
 100         u32 snd_wl1;
 101         u32 cwnd;
 102         u32 ss_thresh;
 103         u16 srtt;
 104         u16 rtt_var;
 105         u32 ts_time;
 106         u32 ts_recent;
 107         u32 ts_recent_age;
 108         u32 total_rt;
 109         u32 ka_timeout_delta;
 110         u32 rt_timeout_delta;
 111         u8 dup_ack_cnt;
 112         u8 snd_wnd_probe_cnt;
 113         u8 ka_probe_cnt;
 114         u8 rt_cnt;
 115         u32 flow_label;
 116         u32 ka_timeout;
 117         u32 ka_interval;
 118         u32 max_rt_time;
 119         u32 initial_rcv_wnd;
 120         u8 ttl;
 121         u8 tos_or_tc;
 122         u16 remote_port;
 123         u16 local_port;
 124         u16 mss;
 125         u8 snd_wnd_scale;
 126         u8 rcv_wnd_scale;
 127         u32 ts_ticks_per_second;
 128         u16 da_timeout_value;
 129         u8 ack_frequency;
 130 };
 131
 132 struct qed_iscsi_params_update {
 133         u8 update_flag;
 134 #define QED_ISCSI_CONN_HD_EN            BIT(0)
 135 #define QED_ISCSI_CONN_DD_EN            BIT(1)
 136 #define QED_ISCSI_CONN_INITIAL_R2T      BIT(2)
 137 #define QED_ISCSI_CONN_IMMEDIATE_DATA   BIT(3)
 138
 139         u32 max_seq_size;
 140         u32 max_recv_pdu_length;
 141         u32 max_send_pdu_length;
 142         u32 first_seq_length;
 143         u32 exp_stat_sn;
 144 };
 145
 146 #define MAX_TID_BLOCKS_ISCSI (512)
 147 struct qed_iscsi_tid {
 148         u32 size;               /* In bytes per task */
 149         u32 num_tids_per_block;
 150         u8 *blocks[MAX_TID_BLOCKS_ISCSI];
 151 };
 152
 153 struct qed_iscsi_cb_ops {
 154         struct qed_common_cb_ops common;
 155 };
 156
 157 /**
 158  * struct qed_iscsi_ops - qed iSCSI operations.
 159  * @common:             common operations pointer
 160  * @ll2:                light L2 operations pointer
 161  * @fill_dev_info:      fills iSCSI specific information
 162  *                      @param cdev
 163  *                      @param info
 164  *                      @return 0 on sucesss, otherwise error value.
 165  * @register_ops:       register iscsi operations
 166  *                      @param cdev
 167  *                      @param ops - specified using qed_iscsi_cb_ops
 168  *                      @param cookie - driver private
 169  * @start:              iscsi in FW
 170  *                      @param cdev
 171  *                      @param tasks - qed will fill information about tasks
 172  *                      return 0 on success, otherwise error value.
 173  * @stop:               iscsi in FW
 174  *                      @param cdev
 175  *                      return 0 on success, otherwise error value.
 176  * @acquire_conn:       acquire a new iscsi connection
 177  *                      @param cdev
 178  *                      @param handle - qed will fill handle that should be
 179  *                              used henceforth as identifier of the
 180  *                              connection.
 181  *                      @param p_doorbell - qed will fill the address of the
 182  *                              doorbell.
 183  *                      @return 0 on sucesss, otherwise error value.
 184  * @release_conn:       release a previously acquired iscsi connection
 185  *                      @param cdev
 186  *                      @param handle - the connection handle.
 187  *                      @return 0 on success, otherwise error value.
 188  * @offload_conn:       configures an offloaded connection
 189  *                      @param cdev
 190  *                      @param handle - the connection handle.
 191  *                      @param conn_info - the configuration to use for the
 192  *                              offload.
 193  *                      @return 0 on success, otherwise error value.
 194  * @update_conn:        updates an offloaded connection
 195  *                      @param cdev
 196  *                      @param handle - the connection handle.
 197  *                      @param conn_info - the configuration to use for the
 198  *                              offload.
 199  *                      @return 0 on success, otherwise error value.
 200  * @destroy_conn:       stops an offloaded connection
 201  *                      @param cdev
 202  *                      @param handle - the connection handle.
 203  *                      @return 0 on success, otherwise error value.
 204  * @clear_sq:           clear all task in sq
 205  *                      @param cdev
 206  *                      @param handle - the connection handle.
 207  *                      @return 0 on success, otherwise error value.
 208  * @get_stats:          iSCSI related statistics
 209  *                      @param cdev
 210  *                      @param stats - pointer to struck that would be filled
 211  *                              we stats
 212  *                      @return 0 on success, error otherwise.
 213  * @change_mac          Change MAC of interface
 214  *                      @param cdev
 215  *                      @param handle - the connection handle.
 216  *                      @param mac - new MAC to configure.
 217  *                      @return 0 on success, otherwise error value.
 218  */
 219 struct qed_iscsi_ops {
 220         const struct qed_common_ops *common;
 221
 222         const struct qed_ll2_ops *ll2;
 223
 224         int (*fill_dev_info)(struct qed_dev *cdev,
 225                              struct qed_dev_iscsi_info *info);
 226
 227         void (*register_ops)(struct qed_dev *cdev,
 228                              struct qed_iscsi_cb_ops *ops, void *cookie);
 229
 230         int (*start)(struct qed_dev *cdev,
 231                      struct qed_iscsi_tid *tasks,
 232                      void *event_context, iscsi_event_cb_t async_event_cb);
 233
 234         int (*stop)(struct qed_dev *cdev);
 235
 236         int (*acquire_conn)(struct qed_dev *cdev,
 237                             u32 *handle,
 238                             u32 *fw_cid, void __iomem **p_doorbell);
 239
 240         int (*release_conn)(struct qed_dev *cdev, u32 handle);
 241
 242         int (*offload_conn)(struct qed_dev *cdev,
 243                             u32 handle,
 244                             struct qed_iscsi_params_offload *conn_info);
 245
 246         int (*update_conn)(struct qed_dev *cdev,
 247                            u32 handle,
 248                            struct qed_iscsi_params_update *conn_info);
 249
 250         int (*destroy_conn)(struct qed_dev *cdev, u32 handle, u8 abrt_conn);
 251
 252         int (*clear_sq)(struct qed_dev *cdev, u32 handle);
 253
 254         int (*get_stats)(struct qed_dev *cdev,
 255                          struct qed_iscsi_stats *stats);
 256
 257         int (*change_mac)(struct qed_dev *cdev, u32 handle, const u8 *mac);
 258 };
 259
 260 const struct qed_iscsi_ops *qed_get_iscsi_ops(void);
 261 void qed_put_iscsi_ops(void);
 262 #endif