broadband_adapter.h

Go to the documentation of this file.

/* KallistiOS ##version##

   dc/net/broadband_adapter.h
   Copyright (C) 2001-2002 Dan Potter

*/

/** \file   dc/net/broadband_adapter.h
    \brief  Broadband Adapter support.

    This file contains declarations related to support for the HIT-0400
    "Broadband Adapter". There's not really anything that users will generally
    have to deal with in here.

    \author Dan Potter
*/

#ifndef __DC_NET_BROADBAND_ADAPTER_H
#define __DC_NET_BROADBAND_ADAPTER_H

#include <sys/cdefs.h>
__BEGIN_DECLS

/** \defgroup bba_regs  RTL8139C Register Definitions
    @{
*/
#define RT_IDR0             0x00    /**< \brief MAC address */
#define RT_MAR0             0x08    /**< \brief Multicast filter */
#define RT_TXSTATUS0        0x10    /**< \brief Transmit status (4 32bit regs) */
#define RT_TXADDR0          0x20    /**< \brief Tx descriptors (also 4 32bit) */
#define RT_RXBUF            0x30    /**< \brief Receive buffer start address */
#define RT_RXEARLYCNT       0x34    /**< \brief Early Rx byte count */
#define RT_RXEARLYSTATUS    0x36    /**< \brief Early Rx status */
#define RT_CHIPCMD          0x37    /**< \brief Command register */
#define RT_RXBUFTAIL        0x38    /**< \brief Current address of packet read (queue tail) */
#define RT_RXBUFHEAD        0x3A    /**< \brief Current buffer address (queue head) */
#define RT_INTRMASK         0x3C    /**< \brief Interrupt mask */
#define RT_INTRSTATUS       0x3E    /**< \brief Interrupt status */
#define RT_TXCONFIG         0x40    /**< \brief Tx config */
#define RT_RXCONFIG         0x44    /**< \brief Rx config */
#define RT_TIMER            0x48    /**< \brief A general purpose counter */
#define RT_RXMISSED         0x4C    /**< \brief 24 bits valid, write clears */
#define RT_CFG9346          0x50    /**< \brief 93C46 command register */
#define RT_CONFIG0          0x51    /**< \brief Configuration reg 0 */
#define RT_CONFIG1          0x52    /**< \brief Configuration reg 1 */
#define RT_TIMERINT         0x54    /**< \brief Timer interrupt register (32 bits) */
#define RT_MEDIASTATUS      0x58    /**< \brief Media status register */
#define RT_CONFIG3          0x59    /**< \brief Config register 3 */
#define RT_CONFIG4          0x5A    /**< \brief Config register 4 */
#define RT_MULTIINTR        0x5C    /**< \brief Multiple interrupt select */
#define RT_MII_TSAD         0x60    /**< \brief Transmit status of all descriptors (16 bits) */
#define RT_MII_BMCR         0x62    /**< \brief Basic Mode Control Register (16 bits) */
#define RT_MII_BMSR         0x64    /**< \brief Basic Mode Status Register (16 bits) */
#define RT_AS_ADVERT        0x66    /**< \brief Auto-negotiation advertisement reg (16 bits) */
#define RT_AS_LPAR          0x68    /**< \brief Auto-negotiation link partner reg (16 bits) */
#define RT_AS_EXPANSION     0x6A    /**< \brief Auto-negotiation expansion reg (16 bits) */
/** @} */

/** \defgroup bba_miicb RTL8139C MII (media independent interface) control bits
    @{
*/
#define RT_MII_AN_START     0x0200  /**< \brief Start auto-negotiation */
#define RT_MII_AN_ENABLE    0x1000  /**< \brief Enable auto-negotiation */
#define RT_MII_RESET        0x8000  /**< \brief Reset the MII chip */
/** @} */

/** \defgroup bba_miisb RTL8139C MII (media independent interface) status bits
    @{
*/
#define RT_MII_LINK         0x0004  /**< \brief Link is present */
#define RT_MII_AN_CAPABLE   0x0008  /**< \brief Can do auto negotiation */
#define RT_MII_AN_COMPLETE  0x0020  /**< \brief Auto-negotiation complete */
#define RT_MII_10_HALF      0x0800  /**< \brief Can do 10Mbit half duplex */
#define RT_MII_10_FULL      0x1000  /**< \brief Can do 10Mbit full */
#define RT_MII_100_HALF     0x2000  /**< \brief Can do 100Mbit half */
#define RT_MII_100_FULL     0x4000  /**< \brief Can do 100Mbit full */
/** @} */

/** \defgroup bba_cbits RTL8139C Command Bits

    OR appropriate bit values together and write into the RT_CHIPCMD register to
    execute the command.

    @{
*/
#define RT_CMD_RESET        0x10 /**< \brief Reset the RTL8139C */
#define RT_CMD_RX_ENABLE    0x08 /**< \brief Enable Rx */
#define RT_CMD_TX_ENABLE    0x04 /**< \brief Enable Tx */
#define RT_CMD_RX_BUF_EMPTY 0x01 /**< \brief Empty the Rx buffer */
/** @} */

/** \defgroup bba_ibits RTL8139C Interrupt Status bits
    @{
*/
#define RT_INT_PCIERR           0x8000  /**< \brief PCI Bus error */
#define RT_INT_TIMEOUT          0x4000  /**< \brief Set when TCTR reaches TimerInt value */
#define RT_INT_RXFIFO_OVERFLOW  0x0040  /**< \brief Rx FIFO overflow */
#define RT_INT_RXFIFO_UNDERRUN  0x0020  /**< \brief Packet underrun / link change */
#define RT_INT_LINK_CHANGE      0x0020  /**< \brief Packet underrun / link change */
#define RT_INT_RXBUF_OVERFLOW   0x0010  /**< \brief Rx BUFFER overflow */
#define RT_INT_TX_ERR           0x0008  /**< \brief Tx error */
#define RT_INT_TX_OK            0x0004  /**< \brief Tx OK */
#define RT_INT_RX_ERR           0x0002  /**< \brief Rx error */
#define RT_INT_RX_OK            0x0001  /**< \brief Rx OK */

/** \brief  Composite RX bits we check for while doing an RX interrupt. */
#define RT_INT_RX_ACK (RT_INT_RXFIFO_OVERFLOW | RT_INT_RXBUF_OVERFLOW | RT_INT_RX_OK)
/** @} */

/** \defgroup bba_tbits RTL8139C transmit status bits
    @{
*/
#define RT_TX_CARRIER_LOST  0x80000000  /**< \brief Carrier sense lost */
#define RT_TX_ABORTED       0x40000000  /**< \brief Transmission aborted */
#define RT_TX_OUT_OF_WINDOW 0x20000000  /**< \brief Out of window collision */
#define RT_TX_STATUS_OK     0x00008000  /**< \brief Status ok: a good packet was transmitted */
#define RT_TX_UNDERRUN      0x00004000  /**< \brief Transmit FIFO underrun */
#define RT_TX_HOST_OWNS     0x00002000  /**< \brief Set to 1 when DMA operation is completed */
#define RT_TX_SIZE_MASK     0x00001fff  /**< \brief Descriptor size mask */
/** @} */

/** \defgroup bba_rbits RTL8139C receive status bits
    @{
*/
#define RT_RX_MULTICAST     0x00008000  /**< \brief Multicast packet */
#define RT_RX_PAM           0x00004000  /**< \brief Physical address matched */
#define RT_RX_BROADCAST     0x00002000  /**< \brief Broadcast address matched */
#define RT_RX_BAD_SYMBOL    0x00000020  /**< \brief Invalid symbol in 100TX packet */
#define RT_RX_RUNT          0x00000010  /**< \brief Packet size is <64 bytes */
#define RT_RX_TOO_LONG      0x00000008  /**< \brief Packet size is >4K bytes */
#define RT_RX_CRC_ERR       0x00000004  /**< \brief CRC error */
#define RT_RX_FRAME_ALIGN   0x00000002  /**< \brief Frame alignment error */
#define RT_RX_STATUS_OK     0x00000001  /**< \brief Status ok: a good packet was received */
/** @} */

/** \brief  Retrieve the MAC Address of the attached BBA.

    This function reads the MAC Address of the BBA and places it in the buffer
    passed in. The resulting data is undefined if no BBA is connected.

    \param  arr             The array to read the MAC into.
*/
void bba_get_mac(uint8 *arr);

/** \brief  Receive packet callback function type.

    When a packet is received by the BBA, the callback function will be called
    to handle it.

    \param  pkt             A pointer to the packet in question.
    \param  len             The length, in bytes, of the packet.
*/
typedef void (*eth_rx_callback_t)(uint8 *pkt, int len);

/** \brief  Set the ethernet packet receive callback.

    This function sets the function called when a packet is received by the BBA.
    Generally, this inputs into the network layer.

    \param  cb              A pointer to the new callback function.
*/
void bba_set_rx_callback(eth_rx_callback_t cb);

/** \defgroup bba_txrv  Return values from bba_tx().
    @{
*/
#define BBA_TX_OK       0   /**< \brief Transmit success */
#define BBA_TX_ERROR    -1  /**< \brief Transmit error */
#define BBA_TX_AGAIN    -2  /**< \brief Retry transmit again */
/** @} */

#define BBA_TX_NOWAIT   0   /**< \brief Don't block waiting for the transfer. */
#define BBA_TX_WAIT     1   /**< \brief Wait, if needed on transfer. */

/** \brief  Transmit a single packet.

    This function transmits a single packet on the bba, waiting for the link to
    become stable, if requested.

    \param  pkt             The packet to transmit.
    \param  len             The length of the packet, in bytes.
    \param  wait            BBA_TX_WAIT if you don't mind blocking for the
                            all clear to transmit, BBA_TX_NOWAIT otherwise.

    \retval BBA_TX_OK       On success.
    \retval BBA_TX_ERROR    If there was an error transmitting the packet.
    \retval BBA_TX_AGAIN    If BBA_TX_NOWAIT was specified and it is not ok to
                            transmit right now.
*/
int bba_tx(const uint8 *pkt, int len, int wait);

/* \cond */
/* Initialize */
int bba_init();

/* Shutdown */
int bba_shutdown();
/* \endcond */

__END_DECLS

#endif  /* __DC_NET_BROADBAND_ADAPTER_H */