nuttx/arch/arm/src/samv7/sam_ethernet.h

269 lines
9.5 KiB
C

/************************************************************************************
* arch/arm/src/samv7/sam_ethernet.h
*
* Copyright (C) 2015 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* 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 NuttX 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 COPYRIGHT HOLDERS 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
* COPYRIGHT OWNER 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 __ARCH_ARM_SRC_SAMV7_SAM_ETHERNET_H
#define __ARCH_ARM_SRC_SAMV7_SAM_ETHERNET_H
/************************************************************************************
* Included Files
************************************************************************************/
#include <nuttx/config.h>
#include <arch/samv7/chip.h>
#include "chip/sam_emac.h"
/************************************************************************************
* Pre-processor Definitions
************************************************************************************/
/* Understood PHY types */
#define SAMV7_PHY_DM9161 0
#define SAMV7_PHY_LAN8700 1
#define SAMV7_PHY_KSZ8051 2
#define SAMV7_PHY_KSZ8061 3
#define SAMV7_PHY_KSZ8081 4
#define SAMV7_PHY_KSZ90x1 5
/* Definitions for use with sam_phy_boardinitialize */
#define EMAC0_INTF 0
#define EMAC1_INTF 1
/* Which is ETH0 and which is ETH1? */
#ifndef CONFIG_SAMV7_EMAC
# undef CONFIG_SAMV7_EMAC0_ISETH0
# undef CONFIG_SAMV7_EMAC1_ISETH0
#endif
#if defined(CONFIG_SAMV7_EMAC0_ISETH0) && defined(CONFIG_SAMV7_EMAC1_ISETH0)
# error EMAC0 and EMAC2 cannot both be ETH0
#endif
#if defined(CONFIG_SAMV7_EMAC0_ISETH0)
# if defined(CONFIG_ETH0_PHY_DM9161)
# define SAMV7_EMAC0_PHY_DM9161 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_DM9161
# elif defined(CONFIG_ETH0_PHY_LAN8700)
# define SAMV7_EMAC0_PHY_LAN8700 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_LAN8700
# elif defined(CONFIG_ETH0_PHY_KSZ8051)
# define SAMV7_EMAC0_PHY_KSZ8051 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ8051
# elif defined(CONFIG_ETH0_PHY_KSZ8061)
# define SAMV7_EMAC0_PHY_KSZ8061 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ8061
# elif defined(CONFIG_ETH0_PHY_KSZ8081)
# define SAMV7_EMAC0_PHY_KSZ8081 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ8081
# elif defined(CONFIG_ETH0_PHY_KSZ90x1)
# define SAMV7_EMAC0_PHY_KSZ90x1 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ90x1
# else
# error ETH0 PHY unrecognized
# endif
#elif defined(CONFIG_SAMV7_EMAC0)
# if defined(CONFIG_ETH1_PHY_DM9161)
# define SAMV7_EMAC0_PHY_DM9161 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_DM9161
# elif defined(CONFIG_ETH1_PHY_LAN8700)
# define SAMV7_EMAC0_PHY_LAN8700 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_LAN8700
# elif defined(CONFIG_ETH1_PHY_KSZ8051)
# define SAMV7_EMAC0_PHY_KSZ8051 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ8051
# elif defined(CONFIG_ETH1_PHY_KSZ8061)
# define SAMV7_EMAC0_PHY_KSZ8061 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ8061
# elif defined(CONFIG_ETH0_PHY_KSZ8081)
# define SAMV7_EMAC0_PHY_KSZ8081 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ8081
# elif defined(CONFIG_ETH1_PHY_KSZ90x1)
# define SAMV7_EMAC0_PHY_KSZ90x1 1
# define SAMV7_EMAC0_PHY_TYPE SAMV7_PHY_KSZ90x1
# else
# error ETH1 PHY unrecognized
# endif
#endif
#if defined(CONFIG_SAMV7_EMAC1_ISETH0)
# if defined(CONFIG_ETH0_PHY_DM9161)
# define SAMV7_EMAC1_PHY_DM9161 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_DM9161
# elif defined(CONFIG_ETH0_PHY_LAN8700)
# define SAMV7_EMAC1_PHY_LAN8700 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_LAN8700
# elif defined(CONFIG_ETH0_PHY_KSZ8051)
# define SAMV7_EMAC1_PHY_KSZ8051 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ8051
# elif defined(CONFIG_ETH0_PHY_KSZ8061)
# define SAMV7_EMAC1_PHY_KSZ8061 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ8061
# elif defined(CONFIG_ETH0_PHY_KSZ8081)
# define SAMV7_EMAC1_PHY_KSZ8081 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ8081
# elif defined(CONFIG_ETH0_PHY_KSZ90x1)
# define SAMV7_EMAC1_PHY_KSZ90x1 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ90x1
# else
# error ETH0 PHY unrecognized
# endif
#elif defined(CONFIG_SAMV7_EMAC1)
# if defined(CONFIG_ETH1_PHY_DM9161)
# define SAMV7_EMAC1_PHY_DM9161 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_DM9161
# elif defined(CONFIG_ETH1_PHY_LAN8700)
# define SAMV7_EMAC1_PHY_LAN8700 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_LAN8700
# elif defined(CONFIG_ETH1_PHY_KSZ8051)
# define SAMV7_EMAC1_PHY_KSZ8051 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ8051
# elif defined(CONFIG_ETH1_PHY_KSZ8061)
# define SAMV7_EMAC1_PHY_KSZ8061 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ8061
# elif defined(CONFIG_ETH0_PHY_KSZ8081)
# define SAMV7_EMAC1_PHY_KSZ8081 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ8081
# elif defined(CONFIG_ETH1_PHY_KSZ90x1)
# define SAMV7_EMAC1_PHY_KSZ90x1 1
# define SAMV7_EMAC1_PHY_TYPE SAMV7_PHY_KSZ90x1
# else
# error ETH1 PHY unrecognized
# endif
#endif
/************************************************************************************
* Public Functions
************************************************************************************/
#ifndef __ASSEMBLY__
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Function: sam_emac_initialize
*
* Description:
* Initialize the EMAC driver.
*
* Input Parameters:
* intf - If multiple EMAC peripherals are supported, this identifies the
* the EMAC peripheral being initialized.
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
* Called very early in the initialization sequence.
*
****************************************************************************/
#ifdef CONFIG_SAMV7_EMAC
int sam_emac_initialize(int intf);
#endif
/****************************************************************************
* Function: sam_emac_setmacaddr
*
* Description:
* There are two ways that the Ethernet MAC address can be set:
*
* 1) Application level code can set the Ethernet MAC address using a
* netdev ioctl. The application level code have gotten the MAC
* address from some configuration parameter or by accessing some
* non-volatile storage containing the address. This is the
* "cannonically correct" way to set the MAC address.
* 2) Alterntively, the board logic may support some other less obvious
* non-volatile storage and the board-level boot-up code may access
* this and use this interface to set the Ethernet MAC address more
* directly. This is mostly a kludge for the case where you just don't
* want to expose a application level storage interface.
*
* Input Parameters:
* intf - If multiple EMAC peripherals are supported, this identifies the
* the EMAC peripheral being initialized.
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
* Called very early in the initialization sequence.
*
****************************************************************************/
#ifdef CONFIG_SAMV7_EMAC
int sam_emac_setmacaddr(int intf, uint8_t mac[6]);
#endif
/************************************************************************************
* Function: sam_phy_boardinitialize
*
* Description:
* Some boards require specialized initialization of the PHY before it can be used.
* This may include such things as configuring GPIOs, resetting the PHY, etc. If
* CONFIG_SAMV7_PHYINIT is defined in the configuration then the board specific
* logic must provide sam_phyinitialize(); The SAMV7 Ethernet driver will call
* this function one time before it first uses the PHY.
*
* Parameters:
* intf - Always zero for now.
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
************************************************************************************/
#ifdef CONFIG_SAMV7_PHYINIT
int sam_phy_boardinitialize(int intf);
#endif
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __ARCH_ARM_SRC_SAMV7_SAM_ETHERNET_H */