nuttx/arch/arm/src/samd5e5/sam_ethernet.h
jjlange 084f81e76e Author: Gregory Nutt <gnutt@nuttx.org>
Run all .c and .h files in last PR through nxstyle.

Author: macman88 <jjlange91@gmail.com>

    SAME5x Ethernet Support (#25)

     boards/arm/samd5e5/same54-xplained-pro/:  Adds basic support for Microchip SAM E54 Xplained Pro board.
    arch/arm/src/samd5e5/:   Adds an Ethernet driver for the SAME5x family (based on the SAMA5 GMAC driver).
2020-01-02 12:35:45 -06:00

150 lines
5.0 KiB
C

/****************************************************************************
* arch/arm/src/samd5e5/sam_ethernet.h
*
* Copyright (C) 2013-2014 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_SAMD5E5_SAM_ETHERNET_H
#define __ARCH_ARM_SRC_SAMD5E5_SAM_ETHERNET_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include "chip.h"
#include "hardware/sam_gmac.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Understood PHY types */
#define SAMD5E5_PHY_DM9161 0
#define SAMD5E5_PHY_LAN8700 1
#define SAMD5E5_PHY_KSZ8051 2
#define SAMD5E5_PHY_KSZ8081 3
#define SAMD5E5_PHY_KSZ90x1 4
/* Definitions for use with sam_phy_boardinitialize */
# if defined(CONFIG_ETH0_PHY_DM9161)
# define SAMD5E5_GMAC_PHY_DM9161 1
# define SAMD5E5_GMAC_PHY_TYPE SAMD5E5_PHY_DM9161
# elif defined(CONFIG_ETH0_PHY_LAN8700)
# define SAMD5E5_GMAC_PHY_LAN8700 1
# define SAMD5E5_GMAC_PHY_TYPE SAMD5E5_PHY_LAN8700
# elif defined(CONFIG_ETH0_PHY_KSZ8051)
# define SAMD5E5_GMAC_PHY_KSZ8051 1
# define SAMD5E5_GMAC_PHY_TYPE SAMD5E5_PHY_KSZ8051
# elif defined(CONFIG_ETH0_PHY_KSZ8081)
# define SAMD5E5_GMAC_PHY_KSZ8081 1
# define SAMD5E5_GMAC_PHY_TYPE SAMD5E5_PHY_KSZ8081
# elif defined(CONFIG_ETH0_PHY_KSZ90x1)
# define SAMD5E5_GMAC_PHY_KSZ90x1 1
# define SAMD5E5_GMAC_PHY_TYPE SAMD5E5_PHY_KSZ90x1
# else
# error ETH0 PHY unrecognized
# endif
/****************************************************************************
* Public Functions
****************************************************************************/
#ifndef __ASSEMBLY__
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Function: sam_gmac_initialize
*
* Description:
* Initialize the GMAC driver.
*
* Input Parameters:
* None
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
* Called very early in the initialization sequence.
*
****************************************************************************/
#ifdef CONFIG_SAMD5E5_GMAC
int sam_gmac_initialize(void);
#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_SAMD5E5_GMAC_PHYINIT is defined in the
* configuration then the board specific logic must provide
* sam_phyinitialize(); The SAMD5E5 Ethernet driver will call this
* function one time before it first uses the PHY.
*
* Input Parameters:
* intf - Always zero for now.
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
************************************************************************************/
#ifdef CONFIG_SAMD5E5_GMAC_PHYINIT
int sam_phy_boardinitialize(int intf);
#endif
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __ARCH_ARM_SRC_SAMD5E5_SAM_ETHERNET_H */