/* $NetBSD: if_skvar.h,v 1.20 2019/09/13 07:55:07 msaitoh Exp $ */

/*-
* Copyright (c) 2003 The NetBSD Foundation, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*      $OpenBSD: if_skreg.h,v 1.10 2003/08/12 05:23:06 nate Exp $      */

/*
* Copyright (c) 1997, 1998, 1999, 2000
*      Bill Paul <[email protected]>.  All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. All advertising materials mentioning features or use of this software
*    must display the following acknowledgement:
*      This product includes software developed by Bill Paul.
* 4. Neither the name of the author nor the names of any co-contributors
*    may be used to endorse or promote products derived from this software
*    without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD: /c/ncvs/src/sys/pci/if_skreg.h,v 1.9 2000/04/22 02:16:37 wpaul Exp $
*/

/*
* Copyright (c) 2003 Nathan L. Binkert <[email protected]>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

#ifndef _DEV_PCI_IF_SKVAR_H_
#define _DEV_PCI_IF_SKVAR_H_

#include <sys/rndsource.h>

struct sk_jpool_entry {
       int                             slot;
       LIST_ENTRY(sk_jpool_entry)      jpool_entries;
};

struct sk_chain {
       void                    *sk_desc;
       struct mbuf             *sk_mbuf;
       struct sk_chain         *sk_next;
};

/*
* Number of DMA segments in a TxCB. Note that this is carefully
* chosen to make the total struct size an even power of two. It's
* critical that no TxCB be split across a page boundary since
* no attempt is made to allocate physically contiguous memory.
*
*/
#define SK_NTXSEG      30

struct sk_txmap_entry {
       bus_dmamap_t                    dmamap;
       SIMPLEQ_ENTRY(sk_txmap_entry)   link;
};

struct sk_chain_data {
       struct sk_chain         sk_tx_chain[SK_TX_RING_CNT];
       struct sk_chain         sk_rx_chain[SK_RX_RING_CNT];
       struct sk_txmap_entry   *sk_tx_map[SK_TX_RING_CNT];
       bus_dmamap_t            sk_rx_map[SK_RX_RING_CNT];
       bus_dmamap_t            sk_rx_jumbo_map;
       int                     sk_tx_prod;
       int                     sk_tx_cons;
       int                     sk_tx_cnt;
       int                     sk_rx_prod;
       int                     sk_rx_cons;
       int                     sk_rx_cnt;
       /* Stick the jumbo mem management stuff here too. */
       void *                  sk_jslots[SK_JSLOTS];
       void                    *sk_jumbo_buf;

};

struct sk_ring_data {
       struct sk_tx_desc       sk_tx_ring[SK_TX_RING_CNT];
       struct sk_rx_desc       sk_rx_ring[SK_RX_RING_CNT];
};

#define SK_TX_RING_ADDR(sc, i) \
   ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
    offsetof(struct sk_ring_data, sk_tx_ring[(i)]))

#define SK_RX_RING_ADDR(sc, i) \
   ((sc)->sk_ring_map->dm_segs[0].ds_addr + \
    offsetof(struct sk_ring_data, sk_rx_ring[(i)]))

#define SK_CDOFF(x)     offsetof(struct sk_ring_data, x)
#define SK_CDTXOFF(x)   SK_CDOFF(sk_tx_ring[(x)])
#define SK_CDRXOFF(x)   SK_CDOFF(sk_rx_ring[(x)])

#define SK_CDTXSYNC(sc, x, n, ops)                                      \
do {                                                                    \
       int __x, __n;                                                   \
                                                                       \
       __x = (x);                                                      \
       __n = (n);                                                      \
                                                                       \
       /* If it will wrap around, sync to the end of the ring. */      \
       if ((__x + __n) > SK_TX_RING_CNT) {                             \
               bus_dmamap_sync((sc)->sk_softc->sc_dmatag,              \
                   (sc)->sk_ring_map, SK_CDTXOFF(__x),                 \
                   sizeof(struct sk_tx_desc) *  (SK_TX_RING_CNT - __x),\
                   (ops));                                             \
               __n -= (SK_TX_RING_CNT - __x);                          \
               __x = 0;                                                \
       }                                                               \
                                                                       \
       /* Now sync whatever is left. */                                \
       bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map,   \
           SK_CDTXOFF((__x)), sizeof(struct sk_tx_desc) * __n, (ops)); \
} while (/*CONSTCOND*/0)

#define SK_CDRXSYNC(sc, x, ops)                                         \
do {                                                                    \
       bus_dmamap_sync((sc)->sk_softc->sc_dmatag, (sc)->sk_ring_map,   \
           SK_CDRXOFF((x)), sizeof(struct sk_rx_desc), (ops));         \
} while (/*CONSTCOND*/0)

struct sk_bcom_hack {
       int                     reg;
       int                     val;
};

#define SK_INC(x, y)    (x) = (x + 1) % y

/* Forward decl. */
struct sk_if_softc;

/* Softc for the GEnesis controller. */
struct sk_softc {
       device_t                sk_dev;         /* generic device */
       bus_space_handle_t      sk_bhandle;     /* bus space handle */
       bus_space_tag_t         sk_btag;        /* bus space tag */
       void                    *sk_intrhand;   /* irq handler handle */
       u_int8_t                sk_type;
       u_int8_t                sk_rev;
       const char              *sk_name;
       char                    *sk_vpd_prodname;
       char                    *sk_vpd_readonly;
       u_int32_t               sk_rboff;       /* RAMbuffer offset */
       u_int32_t               sk_ramsize;     /* amount of RAM on NIC */
       u_int32_t               sk_pmd;         /* physical media type */
       u_int32_t               sk_intrmask;
       struct sysctllog        *sk_clog;
       int                     sk_int_mod;
       int                     sk_int_mod_pending;
       bus_dma_tag_t           sc_dmatag;
       struct sk_if_softc      *sk_if[2];
       u_int8_t                rnd_attached;
       krndsource_t            rnd_source;
};

/* Softc for each logical interface */
struct sk_if_softc {
       device_t                sk_dev;         /* generic device */
       struct ethercom         sk_ethercom;    /* interface info */
       struct mii_data         sk_mii;
       u_int8_t                sk_enaddr[ETHER_ADDR_LEN]; /* station addr */
       u_int8_t                sk_port;        /* port # on controller */
       u_int8_t                sk_xmac_rev;    /* XMAC chip rev (B2 or C1) */
       u_int32_t               sk_rx_ramstart;
       u_int32_t               sk_rx_ramend;
       u_int32_t               sk_tx_ramstart;
       u_int32_t               sk_tx_ramend;
       int                     sk_phytype;
       int                     sk_phyaddr;
       int                     sk_cnt;
       int                     sk_link;
       struct callout          sk_tick_ch;
       struct sk_chain_data    sk_cdata;
       struct sk_ring_data     *sk_rdata;
       bus_dmamap_t            sk_ring_map;
       struct sk_softc         *sk_softc;      /* parent controller */
       int                     sk_tx_bmu;      /* TX BMU register */
       u_short                 sk_if_flags;
       kmutex_t                sk_jpool_mtx;
       LIST_HEAD(__sk_jfreehead, sk_jpool_entry)       sk_jfree_listhead;
       LIST_HEAD(__sk_jinusehead, sk_jpool_entry)      sk_jinuse_listhead;
       SIMPLEQ_HEAD(__sk_txmaphead, sk_txmap_entry) sk_txmap_head;
};

struct skc_attach_args {
       u_int16_t       skc_port;
};

#endif /* _DEV_PCI_IF_SKVAR_H_ */