drivers/net/ionic/ionic_dev.h

   1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
   2  * Copyright(c) 2018-2019 Pensando Systems, Inc. All rights reserved.
   3  */
   4
   5 #ifndef _IONIC_DEV_H_
   6 #define _IONIC_DEV_H_
   7
   8 #include <stdbool.h>
   9
  10 #include "ionic_osdep.h"
  11 #include "ionic_if.h"
  12 #include "ionic_regs.h"
  13
  14 #define IONIC_MIN_MTU                   RTE_ETHER_MIN_MTU
  15 #define IONIC_MAX_MTU                   9194
  16
  17 #define IONIC_MAX_RING_DESC             32768
  18 #define IONIC_MIN_RING_DESC             16
  19 #define IONIC_DEF_TXRX_DESC             4096
  20
  21 #define IONIC_LIFS_MAX                  1024
  22
  23 #define IONIC_DEVCMD_TIMEOUT            5       /* devcmd_timeout */
  24 #define IONIC_DEVCMD_CHECK_PERIOD_US    10      /* devcmd status chk period */
  25
  26 #define IONIC_ALIGN             4096
  27
  28 struct ionic_adapter;
  29
  30 struct ionic_dev_bar {
  31         void __iomem *vaddr;
  32         rte_iova_t bus_addr;
  33         unsigned long len;
  34 };
  35
  36 static inline void ionic_struct_size_checks(void)
  37 {
  38         RTE_BUILD_BUG_ON(sizeof(struct ionic_doorbell) != 8);
  39         RTE_BUILD_BUG_ON(sizeof(struct ionic_intr) != 32);
  40         RTE_BUILD_BUG_ON(sizeof(struct ionic_intr_status) != 8);
  41
  42         RTE_BUILD_BUG_ON(sizeof(union ionic_dev_regs) != 4096);
  43         RTE_BUILD_BUG_ON(sizeof(union ionic_dev_info_regs) != 2048);
  44         RTE_BUILD_BUG_ON(sizeof(union ionic_dev_cmd_regs) != 2048);
  45
  46         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_stats) != 1024);
  47
  48         RTE_BUILD_BUG_ON(sizeof(struct ionic_admin_cmd) != 64);
  49         RTE_BUILD_BUG_ON(sizeof(struct ionic_admin_comp) != 16);
  50         RTE_BUILD_BUG_ON(sizeof(struct ionic_nop_cmd) != 64);
  51         RTE_BUILD_BUG_ON(sizeof(struct ionic_nop_comp) != 16);
  52
  53         /* Device commands */
  54         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_identify_cmd) != 64);
  55         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_identify_comp) != 16);
  56         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_init_cmd) != 64);
  57         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_init_comp) != 16);
  58         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_reset_cmd) != 64);
  59         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_reset_comp) != 16);
  60         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_getattr_cmd) != 64);
  61         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_getattr_comp) != 16);
  62         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_setattr_cmd) != 64);
  63         RTE_BUILD_BUG_ON(sizeof(struct ionic_dev_setattr_comp) != 16);
  64
  65         /* Port commands */
  66         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_identify_cmd) != 64);
  67         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_identify_comp) != 16);
  68         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_init_cmd) != 64);
  69         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_init_comp) != 16);
  70         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_reset_cmd) != 64);
  71         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_reset_comp) != 16);
  72         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_getattr_cmd) != 64);
  73         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_getattr_comp) != 16);
  74         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_setattr_cmd) != 64);
  75         RTE_BUILD_BUG_ON(sizeof(struct ionic_port_setattr_comp) != 16);
  76
  77         /* LIF commands */
  78         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_init_cmd) != 64);
  79         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_init_comp) != 16);
  80         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_reset_cmd) != 64);
  81         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_getattr_cmd) != 64);
  82         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_getattr_comp) != 16);
  83         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_setattr_cmd) != 64);
  84         RTE_BUILD_BUG_ON(sizeof(struct ionic_lif_setattr_comp) != 16);
  85
  86         RTE_BUILD_BUG_ON(sizeof(struct ionic_q_init_cmd) != 64);
  87         RTE_BUILD_BUG_ON(sizeof(struct ionic_q_init_comp) != 16);
  88         RTE_BUILD_BUG_ON(sizeof(struct ionic_q_control_cmd) != 64);
  89
  90         RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_mode_set_cmd) != 64);
  91         RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_filter_add_cmd) != 64);
  92         RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_filter_add_comp) != 16);
  93         RTE_BUILD_BUG_ON(sizeof(struct ionic_rx_filter_del_cmd) != 64);
  94
  95         /* RDMA commands */
  96         RTE_BUILD_BUG_ON(sizeof(struct ionic_rdma_reset_cmd) != 64);
  97         RTE_BUILD_BUG_ON(sizeof(struct ionic_rdma_queue_cmd) != 64);
  98
  99         /* Events */
 100         RTE_BUILD_BUG_ON(sizeof(struct ionic_notifyq_cmd) != 4);
 101         RTE_BUILD_BUG_ON(sizeof(union ionic_notifyq_comp) != 64);
 102         RTE_BUILD_BUG_ON(sizeof(struct ionic_notifyq_event) != 64);
 103         RTE_BUILD_BUG_ON(sizeof(struct ionic_link_change_event) != 64);
 104         RTE_BUILD_BUG_ON(sizeof(struct ionic_reset_event) != 64);
 105         RTE_BUILD_BUG_ON(sizeof(struct ionic_heartbeat_event) != 64);
 106         RTE_BUILD_BUG_ON(sizeof(struct ionic_log_event) != 64);
 107
 108         /* I/O */
 109         RTE_BUILD_BUG_ON(sizeof(struct ionic_txq_desc) != 16);
 110         RTE_BUILD_BUG_ON(sizeof(struct ionic_txq_sg_desc) != 128);
 111         RTE_BUILD_BUG_ON(sizeof(struct ionic_txq_comp) != 16);
 112
 113         RTE_BUILD_BUG_ON(sizeof(struct ionic_rxq_desc) != 16);
 114         RTE_BUILD_BUG_ON(sizeof(struct ionic_rxq_sg_desc) != 128);
 115         RTE_BUILD_BUG_ON(sizeof(struct ionic_rxq_comp) != 16);
 116 }
 117
 118 struct ionic_dev {
 119         union ionic_dev_info_regs __iomem *dev_info;
 120         union ionic_dev_cmd_regs __iomem *dev_cmd;
 121
 122         struct ionic_doorbell __iomem *db_pages;
 123         rte_iova_t phy_db_pages;
 124
 125         struct ionic_intr __iomem *intr_ctrl;
 126
 127         struct ionic_intr_status __iomem *intr_status;
 128
 129         struct ionic_port_info *port_info;
 130         const struct rte_memzone *port_info_z;
 131         rte_iova_t port_info_pa;
 132         uint32_t port_info_sz;
 133 };
 134
 135 struct ionic_queue;
 136 struct ionic_desc_info;
 137
 138 typedef void (*desc_cb)(struct ionic_queue *q,
 139         uint32_t q_desc_index,
 140         uint32_t cq_desc_index,
 141         void *cb_arg, void *service_cb_arg);
 142
 143 struct ionic_desc_info {
 144         desc_cb cb;
 145         void *cb_arg;
 146 };
 147
 148 struct ionic_queue {
 149         struct ionic_dev *idev;
 150         struct ionic_lif *lif;
 151         struct ionic_cq *bound_cq;
 152         uint32_t index;
 153         uint32_t type;
 154         uint32_t hw_index;
 155         uint32_t hw_type;
 156         void *base;
 157         void *sg_base;
 158         rte_iova_t base_pa;
 159         rte_iova_t sg_base_pa;
 160         struct ionic_desc_info *info;
 161         uint32_t tail_idx;
 162         uint32_t head_idx;
 163         uint32_t num_descs;
 164         uint32_t desc_size;
 165         uint32_t sg_desc_size;
 166         uint32_t pid;
 167         uint32_t qid;
 168         uint32_t qtype;
 169         struct ionic_doorbell __iomem *db;
 170         void *nop_desc;
 171 };
 172
 173 #define IONIC_INTR_INDEX_NOT_ASSIGNED   (-1)
 174 #define IONIC_INTR_NAME_MAX_SZ          (32)
 175
 176 struct ionic_intr_info {
 177         char name[IONIC_INTR_NAME_MAX_SZ];
 178         int index;
 179         uint32_t vector;
 180         struct ionic_intr __iomem *ctrl;
 181 };
 182
 183 struct ionic_cq {
 184         struct ionic_lif *lif;
 185         struct ionic_queue *bound_q;
 186         uint32_t tail_idx;
 187         uint32_t num_descs;
 188         uint32_t desc_size;
 189         bool done_color;
 190         void *base;
 191         rte_iova_t base_pa;
 192         struct ionic_intr_info *bound_intr;
 193 };
 194
 195 /** ionic_admin_ctx - Admin command context.
 196  * @pending_work:       Flag that indicates a completion.
 197  * @cmd:                Admin command (64B) to be copied to the queue.
 198  * @comp:               Admin completion (16B) copied from the queue.
 199  */
 200 struct ionic_admin_ctx {
 201         bool pending_work;
 202         union ionic_adminq_cmd cmd;
 203         union ionic_adminq_comp comp;
 204 };
 205
 206 struct ionic_lif;
 207 struct ionic_adapter;
 208 struct ionic_qcq;
 209
 210 void ionic_intr_init(struct ionic_dev *idev, struct ionic_intr_info *intr,
 211         unsigned long index);
 212
 213 int ionic_dev_setup(struct ionic_adapter *adapter);
 214
 215 void ionic_dev_cmd_go(struct ionic_dev *idev, union ionic_dev_cmd *cmd);
 216 uint8_t ionic_dev_cmd_status(struct ionic_dev *idev);
 217 bool ionic_dev_cmd_done(struct ionic_dev *idev);
 218 void ionic_dev_cmd_comp(struct ionic_dev *idev, void *mem);
 219
 220 void ionic_dev_cmd_identify(struct ionic_dev *idev, uint8_t ver);
 221 void ionic_dev_cmd_init(struct ionic_dev *idev);
 222 void ionic_dev_cmd_reset(struct ionic_dev *idev);
 223
 224 void ionic_dev_cmd_port_identify(struct ionic_dev *idev);
 225 void ionic_dev_cmd_port_init(struct ionic_dev *idev);
 226 void ionic_dev_cmd_port_reset(struct ionic_dev *idev);
 227 void ionic_dev_cmd_port_state(struct ionic_dev *idev, uint8_t state);
 228 void ionic_dev_cmd_port_speed(struct ionic_dev *idev, uint32_t speed);
 229 void ionic_dev_cmd_port_mtu(struct ionic_dev *idev, uint32_t mtu);
 230 void ionic_dev_cmd_port_autoneg(struct ionic_dev *idev, uint8_t an_enable);
 231 void ionic_dev_cmd_port_fec(struct ionic_dev *idev, uint8_t fec_type);
 232 void ionic_dev_cmd_port_pause(struct ionic_dev *idev, uint8_t pause_type);
 233 void ionic_dev_cmd_port_loopback(struct ionic_dev *idev,
 234         uint8_t loopback_mode);
 235
 236 void ionic_dev_cmd_lif_identify(struct ionic_dev *idev, uint8_t type,
 237         uint8_t ver);
 238 void ionic_dev_cmd_lif_init(struct ionic_dev *idev, uint16_t lif_index,
 239         rte_iova_t addr);
 240 void ionic_dev_cmd_lif_reset(struct ionic_dev *idev, uint16_t lif_index);
 241 void ionic_dev_cmd_adminq_init(struct ionic_dev *idev, struct ionic_qcq *qcq,
 242         uint16_t lif_index, uint16_t intr_index);
 243
 244 struct ionic_doorbell __iomem *ionic_db_map(struct ionic_lif *lif,
 245         struct ionic_queue *q);
 246 int ionic_db_page_num(struct ionic_lif *lif, int pid);
 247
 248 int ionic_cq_init(struct ionic_lif *lif, struct ionic_cq *cq,
 249         struct ionic_intr_info *intr, uint32_t num_descs,
 250         size_t desc_size);
 251 void ionic_cq_map(struct ionic_cq *cq, void *base, rte_iova_t base_pa);
 252 void ionic_cq_bind(struct ionic_cq *cq, struct ionic_queue *q);
 253 typedef bool (*ionic_cq_cb)(struct ionic_cq *cq, uint32_t cq_desc_index,
 254                 void *cb_arg);
 255 uint32_t ionic_cq_service(struct ionic_cq *cq, uint32_t work_to_do,
 256         ionic_cq_cb cb, void *cb_arg);
 257
 258 int ionic_q_init(struct ionic_lif *lif, struct ionic_dev *idev,
 259         struct ionic_queue *q, uint32_t index, uint32_t num_descs,
 260         size_t desc_size, size_t sg_desc_size, uint32_t pid);
 261 void ionic_q_map(struct ionic_queue *q, void *base, rte_iova_t base_pa);
 262 void ionic_q_sg_map(struct ionic_queue *q, void *base, rte_iova_t base_pa);
 263 void ionic_q_flush(struct ionic_queue *q);
 264 void ionic_q_post(struct ionic_queue *q, bool ring_doorbell, desc_cb cb,
 265         void *cb_arg);
 266 uint32_t ionic_q_space_avail(struct ionic_queue *q);
 267 bool ionic_q_has_space(struct ionic_queue *q, uint32_t want);
 268 void ionic_q_service(struct ionic_queue *q, uint32_t cq_desc_index,
 269         uint32_t stop_index, void *service_cb_arg);
 270
 271 int ionic_adminq_post(struct ionic_lif *lif, struct ionic_admin_ctx *ctx);
 272
 273 #endif /* _IONIC_DEV_H_ */