freebsd-nq/sys/contrib/ncsw/inc/enet_ext.h
Justin Hibbits 0aeed3e993 Add support for the Freescale dTSEC DPAA-based ethernet controller.
Freescale's QorIQ line includes a new ethernet controller, based on their
Datapath Acceleration Architecture (DPAA).  This uses a combination of a Frame
manager, Buffer manager, and Queue manager to improve performance across all
interfaces by being able to pass data directly between hardware acceleration
interfaces.

As part of this import, Freescale's Netcomm Software (ncsw) driver is imported.
This was an attempt by Freescale to create an OS-agnostic sub-driver for
managing the hardware, using shims to interface to the OS-specific APIs.  This
work was abandoned, and Freescale's primary work is in the Linux driver (dual
BSD/GPL license).  Hence, this was imported directly to sys/contrib, rather than
going through the vendor area.  Going forward, FreeBSD-specific changes may be
made to the ncsw code, diverging from the upstream in potentially incompatible
ways.  An alternative could be to import the Linux driver itself, using the
linuxKPI layer, as that would maintain parity with the vendor-maintained driver.
However, the Linux driver has not been evaluated for reliability yet, and may
have issues with the import, whereas the ncsw-based driver in this commit was
completed by Semihalf 4 years ago, and is very stable.

Other SoC modules based on DPAA, which could be added in the future:
* Security and Encryption engine (SEC4.x, SEC5.x)
* RAID engine

Additional work to be done:
* Implement polling mode
* Test vlan support
* Add support for the Pattern Matching Engine, which can do regular expression
  matching on packets.

This driver has been tested on the P5020 QorIQ SoC.  Others listed in the
dtsec(4) manual page are expected to work as the same DPAA engine is included in
all.

Obtained from:	Semihalf
Relnotes:	Yes
Sponsored by:	Alex Perez/Inertial Computing
2016-02-29 03:38:00 +00:00

155 lines
7.7 KiB
C

/* Copyright (c) 2008-2011 Freescale Semiconductor, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Freescale Semiconductor nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
*
* ALTERNATIVELY, this software may be distributed under the terms of the
* GNU General Public License ("GPL") as published by the Free Software
* Foundation, either version 2 of that License or (at your option) any
* later version.
*
* THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``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 Freescale Semiconductor 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.
*/
/**************************************************************************//**
@File enet_ext.h
@Description Ethernet generic definitions and enums.
*//***************************************************************************/
#ifndef __ENET_EXT_H
#define __ENET_EXT_H
#define ENET_NUM_OCTETS_PER_ADDRESS 6 /**< Number of octets (8-bit bytes) in an ethernet address */
#define ENET_GROUP_ADDR 0x01 /**< Group address mask for ethernet addresses */
/**************************************************************************//**
@Description Ethernet Address
*//***************************************************************************/
typedef uint8_t t_EnetAddr[ENET_NUM_OCTETS_PER_ADDRESS];
/**************************************************************************//**
@Description Ethernet Address Type.
*//***************************************************************************/
typedef enum e_EnetAddrType
{
e_ENET_ADDR_TYPE_INDIVIDUAL, /**< Individual (unicast) address */
e_ENET_ADDR_TYPE_GROUP, /**< Group (multicast) address */
e_ENET_ADDR_TYPE_BROADCAST /**< Broadcast address */
} e_EnetAddrType;
/**************************************************************************//**
@Description Ethernet MAC-PHY Interface
*//***************************************************************************/
typedef enum e_EnetInterface
{
e_ENET_IF_MII = 0x00010000, /**< MII interface */
e_ENET_IF_RMII = 0x00020000, /**< RMII interface */
e_ENET_IF_SMII = 0x00030000, /**< SMII interface */
e_ENET_IF_GMII = 0x00040000, /**< GMII interface */
e_ENET_IF_RGMII = 0x00050000, /**< RGMII interface */
e_ENET_IF_TBI = 0x00060000, /**< TBI interface */
e_ENET_IF_RTBI = 0x00070000, /**< RTBI interface */
e_ENET_IF_SGMII = 0x00080000, /**< SGMII interface */
e_ENET_IF_XGMII = 0x00090000, /**< XGMII interface */
e_ENET_IF_QSGMII= 0x000a0000 /**< QSGMII interface */
} e_EnetInterface;
/**************************************************************************//**
@Description Ethernet Duplex Mode
*//***************************************************************************/
typedef enum e_EnetDuplexMode
{
e_ENET_HALF_DUPLEX, /**< Half-Duplex mode */
e_ENET_FULL_DUPLEX /**< Full-Duplex mode */
} e_EnetDuplexMode;
/**************************************************************************//**
@Description Ethernet Speed (nominal data rate)
*//***************************************************************************/
typedef enum e_EnetSpeed
{
e_ENET_SPEED_10 = 10, /**< 10 Mbps */
e_ENET_SPEED_100 = 100, /**< 100 Mbps */
e_ENET_SPEED_1000 = 1000, /**< 1000 Mbps = 1 Gbps */
e_ENET_SPEED_10000 = 10000 /**< 10000 Mbps = 10 Gbps */
} e_EnetSpeed;
/**************************************************************************//**
@Description Ethernet mode (combination of MAC-PHY interface and speed)
*//***************************************************************************/
typedef enum e_EnetMode
{
e_ENET_MODE_INVALID = 0, /**< Invalid Ethernet mode */
e_ENET_MODE_MII_10 = (e_ENET_IF_MII | e_ENET_SPEED_10), /**< 10 Mbps MII */
e_ENET_MODE_MII_100 = (e_ENET_IF_MII | e_ENET_SPEED_100), /**< 100 Mbps MII */
e_ENET_MODE_RMII_10 = (e_ENET_IF_RMII | e_ENET_SPEED_10), /**< 10 Mbps RMII */
e_ENET_MODE_RMII_100 = (e_ENET_IF_RMII | e_ENET_SPEED_100), /**< 100 Mbps RMII */
e_ENET_MODE_SMII_10 = (e_ENET_IF_SMII | e_ENET_SPEED_10), /**< 10 Mbps SMII */
e_ENET_MODE_SMII_100 = (e_ENET_IF_SMII | e_ENET_SPEED_100), /**< 100 Mbps SMII */
e_ENET_MODE_GMII_1000 = (e_ENET_IF_GMII | e_ENET_SPEED_1000), /**< 1000 Mbps GMII */
e_ENET_MODE_RGMII_10 = (e_ENET_IF_RGMII | e_ENET_SPEED_10), /**< 10 Mbps RGMII */
e_ENET_MODE_RGMII_100 = (e_ENET_IF_RGMII | e_ENET_SPEED_100), /**< 100 Mbps RGMII */
e_ENET_MODE_RGMII_1000 = (e_ENET_IF_RGMII | e_ENET_SPEED_1000), /**< 1000 Mbps RGMII */
e_ENET_MODE_TBI_1000 = (e_ENET_IF_TBI | e_ENET_SPEED_1000), /**< 1000 Mbps TBI */
e_ENET_MODE_RTBI_1000 = (e_ENET_IF_RTBI | e_ENET_SPEED_1000), /**< 1000 Mbps RTBI */
e_ENET_MODE_SGMII_10 = (e_ENET_IF_SGMII | e_ENET_SPEED_10), /**< 10 Mbps SGMII */
e_ENET_MODE_SGMII_100 = (e_ENET_IF_SGMII | e_ENET_SPEED_100), /**< 100 Mbps SGMII */
e_ENET_MODE_SGMII_1000 = (e_ENET_IF_SGMII | e_ENET_SPEED_1000), /**< 1000 Mbps SGMII */
e_ENET_MODE_XGMII_10000 = (e_ENET_IF_XGMII | e_ENET_SPEED_10000), /**< 10000 Mbps XGMII */
e_ENET_MODE_QSGMII_1000 = (e_ENET_IF_QSGMII| e_ENET_SPEED_1000) /**< 1000 Mbps QSGMII */
} e_EnetMode;
#define IS_ENET_MODE_VALID(mode) \
(((mode) == e_ENET_MODE_MII_10 ) || \
((mode) == e_ENET_MODE_MII_100 ) || \
((mode) == e_ENET_MODE_RMII_10 ) || \
((mode) == e_ENET_MODE_RMII_100 ) || \
((mode) == e_ENET_MODE_SMII_10 ) || \
((mode) == e_ENET_MODE_SMII_100 ) || \
((mode) == e_ENET_MODE_GMII_1000 ) || \
((mode) == e_ENET_MODE_RGMII_10 ) || \
((mode) == e_ENET_MODE_RGMII_100 ) || \
((mode) == e_ENET_MODE_RGMII_1000 ) || \
((mode) == e_ENET_MODE_TBI_1000 ) || \
((mode) == e_ENET_MODE_RTBI_1000 ) || \
((mode) == e_ENET_MODE_SGMII_10 ) || \
((mode) == e_ENET_MODE_SGMII_100 ) || \
((mode) == e_ENET_MODE_SGMII_1000 ) || \
((mode) == e_ENET_MODE_XGMII_10000) || \
((mode) == e_ENET_MODE_QSGMII_1000))
#define MAKE_ENET_MODE(_interface, _speed) (e_EnetMode)((_interface) | (_speed))
#define ENET_INTERFACE_FROM_MODE(mode) (e_EnetInterface)((mode) & 0xFFFF0000)
#define ENET_SPEED_FROM_MODE(mode) (e_EnetSpeed)((mode) & 0x0000FFFF)
#endif /* __ENET_EXT_H */