/*
 * Copyright (c) 2013, Cisco Systems, Inc. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * BSD license below:
 *
 *     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.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */


#ifndef USNIC_ABI_H
#define USNIC_ABI_H

/* ABI between userspace and kernel */
#define USNIC_UVERBS_ABI_VERSION        4

#define USNIC_QP_GRP_MAX_WQS            8
#define USNIC_QP_GRP_MAX_RQS            8
#define USNIC_QP_GRP_MAX_CQS            16

enum usnic_transport_type {
        USNIC_TRANSPORT_UNKNOWN         = 0,
        USNIC_TRANSPORT_ROCE_CUSTOM     = 1,
        USNIC_TRANSPORT_IPV4_UDP        = 2,
        USNIC_TRANSPORT_MAX             = 3,
};

struct usnic_transport_spec {
        enum usnic_transport_type       trans_type;
        union {
                struct {
                        uint16_t        port_num;
                } usnic_roce;
                struct {
                        uint32_t        sock_fd;
                } udp;
        };
};

struct usnic_ib_create_qp_cmd {
        struct usnic_transport_spec     spec;
};

/*TODO: Future - usnic_modify_qp needs to pass in generic filters */
struct usnic_ib_create_qp_resp {
        u32                             vfid;
        u32                             qp_grp_id;
        u64                             bar_bus_addr;
        u32                             bar_len;
/*
 * WQ, RQ, CQ are explicitly specified bc exposing a generic resources inteface
 * expands the scope of ABI to many files.
 */
        u32                             wq_cnt;
        u32                             rq_cnt;
        u32                             cq_cnt;
        u32                             wq_idx[USNIC_QP_GRP_MAX_WQS];
        u32                             rq_idx[USNIC_QP_GRP_MAX_RQS];
        u32                             cq_idx[USNIC_QP_GRP_MAX_CQS];
        u32                             transport;
        u32                             reserved[9];
};

#endif /* USNIC_ABI_H */