fnet_eth.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community.
*
***************************************************************************
*
*  Licensed under the Apache License, Version 2.0 (the "License"); you may
*  not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*  http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
*  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***************************************************************************
*
* Ethernet platform independent API definitions.
*
***************************************************************************/

#ifndef _FNET_ETH_H_

#define _FNET_ETH_H_

/**************************************************************************
*     Definitions
***************************************************************************/

/**************************************************************************/ 
#define FNET_MAC_ADDR_STR_SIZE       (18)

/**************************************************************************/ 
#define FNET_ETH_MTU                (1500u)

/**************************************************************************/ 
typedef fnet_uint8_t fnet_mac_addr_t[6]; /* MAC address type.*/

/**************************************************************************/ 
#define FNET_MAC_ADDR_INIT(a, b, c, d, e, f)   { (a), (b), (c), (d), (e), (f) }

/* MAC address is multicast. */
#define FNET_MAC_ADDR_IS_MULTICAST(a)   ((((a)[0]) == 0x01U)?FNET_TRUE:FNET_FALSE)

/* MAC address is broadcast. */
#define FNET_MAC_ADDR_IS_BROADCAST(a)   (((((a)[0]) == 0xFFU) && \
        (((a)[1]) == 0xFFU)&& \
        (((a)[1]) == 0xFFU)&& \
        (((a)[1]) == 0xFFU)&& \
        (((a)[1]) == 0xFFU)&& \
        (((a)[1]) == 0xFFU))? FNET_TRUE:FNET_FALSE)
/* Copying address. */
#define FNET_MAC_ADDR_COPY(from_addr, to_addr)  \
    (fnet_memcpy(&to_addr[0], &from_addr[0], sizeof(fnet_mac_addr_t)))

/* Useful mac addresses */
extern const fnet_mac_addr_t fnet_eth_null_addr;
extern const fnet_mac_addr_t fnet_eth_broadcast;

/************************************************************************
*  IEEE802.3 PHY MII management register set
*************************************************************************/
#define FNET_ETH_MII_REG_CR             (0x0000U)   /* Control Register */
#define FNET_ETH_MII_REG_SR             (0x0001U)   /* Status Register */
#define FNET_ETH_MII_REG_IDR1           (0x0002U)   /* Identification Register #1 */
#define FNET_ETH_MII_REG_IDR2           (0x0003U)   /* Identification Register #2 */
#define FNET_ETH_MII_REG_ANAR           (0x0004U)   /* Auto-Negotiation Advertisement Register */
#define FNET_ETH_MII_REG_ANLPAR         (0x0005U)   /* Auto-Negotiation Link Partner Ability Register */
#define FNET_ETH_MII_REG_ANER           (0x0006U)   /* Auto-Negotiation Expansion Register */
#define FNET_ETH_MII_REG_ANNPTR         (0x0007U)   /* Auto-Negotiation Next Page TX Register */

/* Status Register flags*/
#define FNET_ETH_MII_REG_SR_LINK_STATUS (0x0004U)
#define FNET_ETH_MII_REG_SR_AN_ABILITY  (0x0008U)
#define FNET_ETH_MII_REG_SR_AN_COMPLETE (0x0020U)

/* Control Register flags*/
#define FNET_ETH_MII_REG_CR_RESET       (0x8000U)    /* Resetting a port is accomplished by setting this bit to 1.*/
#define FNET_ETH_MII_REG_CR_LOOPBACK    (0x4000U)    /* Determines Digital Loopback Mode. */
#define FNET_ETH_MII_REG_CR_DATARATE    (0x2000U)    /* Speed Selection bit.*/
#define FNET_ETH_MII_REG_CR_ANE         (0x1000U)    /* Auto-Negotiation Enable bit. */
#define FNET_ETH_MII_REG_CR_PDWN        (0x0800U)    /* Power Down bit. */
#define FNET_ETH_MII_REG_CR_ISOL        (0x0400U)    /* Isolate bit.*/
#define FNET_ETH_MII_REG_CR_ANE_RESTART (0x0200U)    /* Restart Auto-Negotiation bit.*/
#define FNET_ETH_MII_REG_CR_DPLX        (0x0100U)    /* Duplex Mode bit.*/

/*  Auto-Negotiation Advertisement Register flags*/
#define FNET_ETH_MII_REG_ANAR_100_FULLDUPLEX    (0x0100U)   /* 100 Mbps full-duplex capable.*/
#define FNET_ETH_MII_REG_ANAR_100_HALFDUPLEX    (0x0080U)   /* 100 Mbps half-duplex capable.*/
#define FNET_ETH_MII_REG_ANAR_10_FULLDUPLEX     (0x0040U)   /* 10 Mbps full-duplex capable.*/
#define FNET_ETH_MII_REG_ANAR_10_HALFDUPLEX     (0x0020U)   /* 10 Mbps half-duplex capable.*/
#define FNET_ETH_MII_REG_ANAR_IEEE8023          (0x0001U)   /* IEEE 802.3 */


/******************************************************************************
*     Function Prototypes
*******************************************************************************/

#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_char_t *fnet_mac_to_str( const fnet_mac_addr_t addr, fnet_char_t *str_mac );

/***************************************************************************/ 
fnet_return_t fnet_str_to_mac( const fnet_char_t *str_mac, fnet_mac_addr_t addr );

/***************************************************************************/ 
fnet_return_t  fnet_eth_phy_read(fnet_netif_desc_t netif_desc, fnet_uint32_t reg_addr, fnet_uint16_t *reg_data);

/***************************************************************************/ 
fnet_return_t  fnet_eth_phy_write(fnet_netif_desc_t netif_desc, fnet_uint32_t reg_addr, fnet_uint16_t reg_data);

/***************************************************************************/ 
fnet_uint8_t fnet_eth_phy_get_addr(fnet_netif_desc_t netif_desc);

/***************************************************************************/ 
fnet_return_t  fnet_eth_phy_set_addr(fnet_netif_desc_t netif_desc, fnet_uint8_t phy_addr );

#if defined(__cplusplus)
}
#endif

#endif /* _FNET_ETH_H_ */