xen/io/xnb.h

	xnb.h revision 843e19887f64dde75055cf8842fc4db2171eff45
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 *
 * xnb.h - definitions for Xen dom0 network driver
 */

#ifndef _SYS_XNB_H
#define _SYS_XNB_H

#pragma ident   "%Z%%M% %I% %E% SMI"

#include <sys/types.h>
#include <sys/kstat.h>
#include <sys/stream.h>
#include <sys/ethernet.h>
#include <sys/hypervisor.h>
#include <xen/public/io/netif.h>

#ifdef __cplusplus
extern "C" {
#endif

#define NET_TX_RING_SIZE  __RING_SIZE((netif_tx_sring_t *)0, PAGESIZE)
#define NET_RX_RING_SIZE  __RING_SIZE((netif_rx_sring_t *)0, PAGESIZE)

#define XNBMAXPKT   1500        /* MTU size */

/* DEBUG flags */
#define XNBDDI      0x01
#define XNBTRACE    0x02
#define XNBSEND     0x04
#define XNBRECV     0x08
#define XNBINTR     0x10
#define XNBRING     0x20
#define XNBCKSUM    0x40

typedef struct xnb xnb_t;

/*
 * The xnb module provides core inter-domain network protocol functionality.
 * It is connected to the rest of Solaris in two ways:
 * - as a GLDv3 driver (with xnbu),
 * - as a GLDv3 consumer (with xnbo).
 *
 * The different modes of operation are termed "flavours" and each
 * instance of an xnb based driver operates in one and only one mode.
 * The common xnb driver exports a set of functions to these drivers
 * (declarations at the foot of this file) and calls back into the
 * drivers via the xnb_flavour_t structure.
 */
typedef struct xnb_flavour {
    void        (*xf_recv)(xnb_t *, mblk_t *);
    void        (*xf_peer_connected)(xnb_t *);
    void        (*xf_peer_disconnected)(xnb_t *);
    boolean_t   (*xf_hotplug_connected)(xnb_t *);
    mblk_t      *(*xf_cksum_from_peer)(xnb_t *, mblk_t *, uint16_t);
    uint16_t    (*xf_cksum_to_peer)(xnb_t *, mblk_t *);
} xnb_flavour_t;

typedef struct xnb_rxbuf {
    frtn_t          xr_free_rtn;
    xnb_t           *xr_xnbp;
    gnttab_map_grant_ref_t  xr_mop;
    RING_IDX        xr_id;
    uint16_t        xr_status;
    unsigned int        xr_flags;

#define XNB_RXBUF_INUSE 0x01

} xnb_rxbuf_t;

/* Per network-interface-controller driver private structure */
struct xnb {
    /* most interesting stuff first to assist debugging */
    dev_info_t      *x_devinfo; /* System per-device info. */

    xnb_flavour_t       *x_flavour;
    void            *x_flavour_data;

    boolean_t       x_irq;
    unsigned char       x_mac_addr[ETHERADDRL];

    uint64_t        x_stat_ipackets;
    uint64_t        x_stat_opackets;
    uint64_t        x_stat_rbytes;
    uint64_t        x_stat_obytes;

    uint64_t        x_stat_intr;
    uint64_t        x_stat_xmit_defer;

    uint64_t        x_stat_tx_cksum_deferred;
    uint64_t        x_stat_rx_cksum_no_need;

    uint64_t        x_stat_tx_notify_sent;
    uint64_t        x_stat_tx_notify_deferred;

    uint64_t        x_stat_rx_notify_sent;
    uint64_t        x_stat_rx_notify_deferred;

    uint64_t        x_stat_tx_too_early;
    uint64_t        x_stat_rx_too_early;
    uint64_t        x_stat_rx_allocb_failed;
    uint64_t        x_stat_mac_full;
    uint64_t        x_stat_spurious_intr;
    uint64_t        x_stat_allocation_success;
    uint64_t        x_stat_allocation_failure;
    uint64_t        x_stat_small_allocation_success;
    uint64_t        x_stat_small_allocation_failure;

    uint64_t        x_stat_csum_hardware;
    uint64_t        x_stat_csum_software;

    kstat_t         *x_kstat_aux;

    boolean_t       x_cksum_offload;

    ddi_iblock_cookie_t x_icookie;

    kmutex_t        x_rx_lock;
    kmutex_t        x_tx_lock;

    int         x_rx_unmop_count;
    int         x_rx_buf_count;
    boolean_t       x_rx_pages_writable;

    netif_rx_back_ring_t    x_rx_ring;  /* rx interface struct ptr */
    void            *x_rx_ring_addr;
    grant_ref_t     x_rx_ring_ref;
    grant_handle_t      x_rx_ring_handle;

    netif_tx_back_ring_t    x_tx_ring;  /* tx interface struct ptr */
    void            *x_tx_ring_addr;
    grant_ref_t     x_tx_ring_ref;
    grant_handle_t      x_tx_ring_handle;

    boolean_t       x_connected;
    boolean_t       x_hotplugged;
    boolean_t       x_detachable;
    int         x_evtchn;   /* channel to front end */
    domid_t         x_peer;

    xnb_rxbuf_t         *x_rx_bufp[NET_TX_RING_SIZE];
    gnttab_map_grant_ref_t      x_rx_mop[NET_TX_RING_SIZE];
    gnttab_unmap_grant_ref_t    x_rx_unmop[NET_TX_RING_SIZE];

    caddr_t         x_tx_va;
    gnttab_transfer_t   x_tx_top[NET_RX_RING_SIZE];
};

extern int xnb_attach(dev_info_t *, xnb_flavour_t *, void *);
extern void xnb_detach(dev_info_t *);
extern mblk_t *xnb_to_peer(xnb_t *, mblk_t *);
extern mblk_t *xnb_process_cksum_flags(xnb_t *, mblk_t *, uint32_t);

#ifdef __cplusplus
}
#endif

#endif  /* _SYS_XNB_H */