root/src/add-ons/kernel/drivers/network/ether/pcnet/dev/le/am79900reg.h
/*      $NetBSD: am79900reg.h,v 1.8 2005/12/11 12:21:25 christos Exp $  */

/*-
 * SPDX-License-Identifier: BSD-2-Clause AND BSD-3-Clause
 *
 * Copyright (c) 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Charles M. Hannum.
 *
 * 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.
 */

/*-
 * Copyright (c) 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Ralph Campbell and Rick Macklem.
 *
 * 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. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
 */


#ifndef _DEV_LE_AM79900REG_H_
#define _DEV_LE_AM79900REG_H_

/*
 * Receive message descriptor
 */
struct lermd {
        uint32_t        rmd0;
        uint32_t        rmd1;
        uint32_t        rmd2;
        int32_t         rmd3;
};

/*
 * Transmit message descriptor
 */
struct letmd {
        uint32_t        tmd0;
        uint32_t        tmd1;
        uint32_t        tmd2;
        int32_t         tmd3;
};

/*
 * Initialization block
 */
struct leinit {
        uint32_t        init_mode;      /* +0x0000 */
        uint32_t        init_padr[2];   /* +0x0002 */
        uint16_t        init_ladrf[4];  /* +0x0008 */
        uint32_t        init_rdra;      /* +0x0010 */
        uint32_t        init_tdra;      /* +0x0014 */
        int32_t         pad;            /* Pad to 8 ints. */
};

/* Receive message descriptor 1 (rmd1_bits) */
#define LE_R1_OWN       (1U << 31)      /* LANCE owns the packet */
#define LE_R1_ERR       (1U << 30)      /* error summary */
#define LE_R1_FRAM      (1U << 29)      /* framing error */
#define LE_R1_OFLO      (1U << 28)      /* overflow error */
#define LE_R1_CRC       (1U << 27)      /* CRC error */
#define LE_R1_BUFF      (1U << 26)      /* buffer error */
#define LE_R1_STP       (1U << 25)      /* start of packet */
#define LE_R1_ENP       (1U << 24)      /* end of packet */
#define LE_R1_ONES      (0xfU << 12)    /* must be ones */
#define LE_R1_BCNT_MASK (0xfff)         /* byte count mask */

#define LE_R1_BITS \
    "\20\40OWN\37ERR\36FRAM\35OFLO\34CRC\33BUFF\32STP\31ENP"

/* Transmit message descriptor 1 (tmd1_bits) */
#define LE_T1_OWN       (1U << 31)      /* LANCE owns the packet */
#define LE_T1_ERR       (1U << 30)      /* error summary */
#define LE_T1_ADD_FCS   (1U << 29)      /* add FCS (PCnet-PCI) */
#define LE_T1_NO_FCS    (1U << 29)      /* no FCS (ILACC) */
#define LE_T1_MORE      (1U << 28)      /* multiple collisions */
#define LE_T1_LTINT     (1U << 28)      /* transmit interrupt (if LTINTEN) */
#define LE_T1_ONE       (1U << 27)      /* single collision */
#define LE_T1_DEF       (1U << 26)      /* deferred transmit */
#define LE_T1_STP       (1U << 25)      /* start of packet */
#define LE_T1_ENP       (1U << 24)      /* end of packet */
#define LE_T1_ONES      (0xfU << 12)    /* must be ones */
#define LE_T1_BCNT_MASK (0xfff)         /* byte count mask */

#define LE_T1_BITS \
    "\20\40OWN\37ERR\36RES\35MORE\34ONE\33DEF\32STP\31ENP"

/* Transmit message descriptor 3 (tmd3) */
#define LE_T2_BUFF      (1U << 31)      /* buffer error */
#define LE_T2_UFLO      (1U << 30)      /* underflow error */
#define LE_T2_EXDEF     (1U << 29)      /* excessive defferral */
#define LE_T2_LCOL      (1U << 28)      /* late collision */
#define LE_T2_LCAR      (1U << 27)      /* loss of carrier */
#define LE_T2_RTRY      (1U << 26)      /* retry error */
#if 0
#define LE_T3_TDR_MASK  0x03ff          /* time domain reflectometry counter */
#endif

#define LE_T3_BITS \
    "\12\40BUFF\37UFLO\35LCOL\34LCAR\33RTRY"

#endif /* !_DEV_LE_AM7990REG_H_ */