#ifndef __doxygen_HIDE  /* This file is not part of the API *//** * @file IxEthNpe.h *  * @par * IXP400 SW Release version 2.0 *  * -- Copyright Notice -- *  * @par * Copyright 2001-2005, Intel Corporation. * All rights reserved. *  * @par * 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 of the Intel Corporation nor the names of its contributors *    may be used to endorse or promote products derived from this software *    without specific prior written permission. *  * @par * 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. *  * @par * -- End of Copyright Notice --*//** * @defgroup IxEthNpe IXP400 Ethernet NPE (IxEthNpe) API * * @brief Contains the API for Ethernet NPE. *  * All messages given to NPE, get back an acknowledgment. The acknowledgment  * is identical to the message sent to the NPE (except for NPE_GETSTATUS message). * * @{ *//*-------------------------------------------------------------------------- * APB Message IDs - XScale->NPE *------------------------------------------------------------------------*//** * @def IX_ETHNPE_NPE_GETSTATUS * * @brief Request from the XScale client for the NPE to return the firmware * version of the currently executing image. * * Acknowledgment message id is same as the request message id.  * NPE returns the firmware version ID to XScale. */#define IX_ETHNPE_NPE_GETSTATUS                 0x00/** * @def IX_ETHNPE_EDB_SETPORTADDRESS * * @brief Request from the XScale client for the NPE to set the Ethernet  * port's port ID and MAC address.  */#define IX_ETHNPE_EDB_SETPORTADDRESS            0x01/** * @def IX_ETHNPE_EDB_GETMACADDRESSDATABASE * * @brief Request from XScale client to the NPE requesting upload of  * Ethernet Filtering Database or Header Conversion Database from NPE's  * data memory to XScale accessible SDRAM. */#define IX_ETHNPE_EDB_GETMACADDRESSDATABASE     0x02/** * @def IX_ETHNPE_EDB_SETMACADDRESSSDATABASE * * @brief Request from XScale client to the NPE requesting download of  * Ethernet Filtering Database or Header Conversion Database from SDRAM * to the NPE's datamemory. */#define IX_ETHNPE_EDB_SETMACADDRESSSDATABASE    0x03/** * @def IX_ETHNPE_GETSTATS * * @brief Request from the XScale client for the current MAC port statistics  * data to be written to the (empty) statistics structure and the specified * location in externa memory. */#define IX_ETHNPE_GETSTATS                      0x04/** * @def IX_ETHNPE_RESETSTATS * * @brief Request from the XScale client to the NPE to reset all of its internal  * MAC port statistics state variables.  * * As a side effect, this message entails an implicit request that the NPE *  write the current MAC port statistics into the MAC statistics structure  * at the specified location in external memory. */#define IX_ETHNPE_RESETSTATS                    0x05/** * @def IX_ETHNPE_SETMAXFRAMELENGTHS * * @brief Request from the XScale client to the NPE to configure maximum framelengths * and block sizes in receive and transmit direction. */#define IX_ETHNPE_SETMAXFRAMELENGTHS            0x06/** * @def IX_ETHNPE_VLAN_SETRXTAGMODE * * @brief Request from the XScale client to the NPE to configure VLAN frame type * filtering and VLAN the tagging mode for the receiver. */#define IX_ETHNPE_VLAN_SETRXTAGMODE             0x07/** * @def IX_ETHNPE_VLAN_SETDEFAULTRXVID * * @brief Request from the XScale client to the NPE to set receiver's default  * VLAN tag (PVID)and internal traffic class. */#define IX_ETHNPE_VLAN_SETDEFAULTRXVID          0x08/** * @def IX_ETHNPE_VLAN_SETPORTVLANTABLEENTRY * * @brief Request from the XScale client to the NPE to configure VLAN Port  * membership and Tx tagging for 8 consecutive VLANID's. */#define IX_ETHNPE_VLAN_SETPORTVLANTABLEENTRY    0x09/** * @def IX_ETHNPE_VLAN_SETPORTVLANTABLERANGE * * @brief Request from the XScale client to the NPE to configure VLAN Port * membership and Tx tagging for a range of VLANID's. */#define IX_ETHNPE_VLAN_SETPORTVLANTABLERANGE    0x0A/** * @def IX_ETHNPE_VLAN_SETRXQOSENTRY * * @brief Request from the XScale client to the NPE to map a user priority * to QoS class and an AQM queue number. */#define IX_ETHNPE_VLAN_SETRXQOSENTRY            0x0B/** * @def IX_ETHNPE_VLAN_SETPORTIDEXTRACTIONMODE * * @brief Request from the XScale client to the NPE to enable or disable * portID extraction from VLAN-tagged frames for the specified port. */#define IX_ETHNPE_VLAN_SETPORTIDEXTRACTIONMODE  0x0C/** * @def IX_ETHNPE_STP_SETBLOCKINGSTATE * * @brief Request from the XScale client to the NPE to block or unblock * forwarding for spanning tree BPDUs. */#define IX_ETHNPE_STP_SETBLOCKINGSTATE          0x0D/** * @def IX_ETHNPE_FW_SETFIREWALLMODE * * @brief Request from the XScale client to the NPE to configure firewall * services modes of operation and/or download Ethernet Firewall Database from * SDRAM to NPE. */#define IX_ETHNPE_FW_SETFIREWALLMODE            0x0E/** * @def IX_ETHNPE_PC_SETFRAMECONTROLDURATIONID  * * @brief Request from the XScale client to the NPE to set global frame control * and duration/ID field for the 802.3 to 802.11 protocol header conversion * service. */#define IX_ETHNPE_PC_SETFRAMECONTROLDURATIONID  0x0F/** * @def IX_ETHNPE_PC_SETBBSID * * @brief Request from the XScale client to the NPE to set global BBSID field * value for the 802.3 to 802.11 protocol header conversion service.  */#define IX_ETHNPE_PC_SETBBSID                   0x10/** * @def IX_ETHNPE_PC_SETAPMACTABLE * * @brief Request from the XScale client to the NPE to update a block/section/ * range of the AP MAC Address Table. */#define IX_ETHNPE_PC_SETAPMACTABLE              0x11/** * @def IX_ETHNPE_SETLOOPBACK_MODE * * @brief Turn on or off the NPE frame loopback. */#define IX_ETHNPE_SETLOOPBACK_MODE              (0x12)/*-------------------------------------------------------------------------- * APB Message IDs - NPE->XScale *------------------------------------------------------------------------*//** * @def IX_ETHNPE_NPE_GETSTATUS_ACK * * @brief Acknowledgment to IX_ETHNPE_NPE_GETSTATUS message. NPE firmware version  * id is returned in the message. */#define IX_ETHNPE_NPE_GETSTATUS_ACK                 0x00/** * @def IX_ETHNPE_EDB_SETPORTADDRESS_ACK * * @brief Acknowledgment to IX_ETHNPE_EDB_SETPORTADDRESS message. */#define IX_ETHNPE_EDB_SETPORTADDRESS_ACK            0x01/** * @def IX_ETHNPE_EDB_GETMACADDRESSDATABASE_ACK * * @brief Acknowledgment to IX_ETHNPE_EDB_GETMACADDRESSDATABASE message */#define IX_ETHNPE_EDB_GETMACADDRESSDATABASE_ACK     0x02/** * @def IX_ETHNPE_EDB_SETMACADDRESSSDATABASE_ACK * * @brief Acknowledgment to IX_ETHNPE_EDB_SETMACADDRESSSDATABASE message. */#define IX_ETHNPE_EDB_SETMACADDRESSSDATABASE_ACK    0x03/** * @def IX_ETHNPE_GETSTATS_ACK * * @brief Acknowledgment to IX_ETHNPE_GETSTATS message. */#define IX_ETHNPE_GETSTATS_ACK                      0x04/** * @def IX_ETHNPE_RESETSTATS_ACK * * @brief Acknowledgment to IX_ETHNPE_RESETSTATS message. */#define IX_ETHNPE_RESETSTATS_ACK                    0x05/** * @def IX_ETHNPE_SETMAXFRAMELENGTHS_ACK * * @brief Acknowledgment to IX_ETHNPE_SETMAXFRAMELENGTHS message. */#define IX_ETHNPE_SETMAXFRAMELENGTHS_ACK            0x06/** * @def IX_ETHNPE_VLAN_SETRXTAGMODE_ACK * * @brief Acknowledgment to IX_ETHNPE_VLAN_SETRXTAGMODE message. */#define IX_ETHNPE_VLAN_SETRXTAGMODE_ACK             0x07/** * @def IX_ETHNPE_VLAN_SETDEFAULTRXVID_ACK * * @brief Acknowledgment to IX_ETHNPE_VLAN_SETDEFAULTRXVID  message. */#define IX_ETHNPE_VLAN_SETDEFAULTRXVID_ACK          0x08/** * @def IX_ETHNPE_VLAN_SETPORTVLANTABLEENTRY_ACK * * @brief Acknowledgment to IX_ETHNPE_VLAN_SETPORTVLANTABLEENTRY message. */#define IX_ETHNPE_VLAN_SETPORTVLANTABLEENTRY_ACK    0x09/** * @def IX_ETHNPE_VLAN_SETPORTVLANTABLERANGE_ACK * * @brief Acknowledgment to IX_ETHNPE_VLAN_SETPORTVLANTABLERANGE message. */#define IX_ETHNPE_VLAN_SETPORTVLANTABLERANGE_ACK    0x0A/** * @def IX_ETHNPE_VLAN_SETRXQOSENTRY_ACK * * @brief Acknowledgment to IX_ETHNPE_VLAN_SETRXQOSENTRY message. */#define IX_ETHNPE_VLAN_SETRXQOSENTRY_ACK            0x0B/** * @def IX_ETHNPE_VLAN_SETPORTIDEXTRACTIONMODE_ACK * * @brief Acknowledgment to IX_ETHNPE_VLAN_SETPORTIDEXTRACTIONMODE message. */#define IX_ETHNPE_VLAN_SETPORTIDEXTRACTIONMODE_ACK  0x0C/** * @def IX_ETHNPE_STP_SETBLOCKINGSTATE_ACK * * @brief Acknowledgment to IX_ETHNPE_STP_SETBLOCKINGSTATE message. */#define IX_ETHNPE_STP_SETBLOCKINGSTATE_ACK          0x0D/** * @def IX_ETHNPE_FW_SETFIREWALLMODE_ACK * * @brief Acknowledgment to IX_ETHNPE_FW_SETFIREWALLMODE message.  */#define IX_ETHNPE_FW_SETFIREWALLMODE_ACK            0x0E/** * @def IX_ETHNPE_PC_SETFRAMECONTROLDURATIONID_ACK * * @brief Acknowledgment to IX_ETHNPE_PC_SETFRAMECONTROLDURATIONID message. */#define IX_ETHNPE_PC_SETFRAMECONTROLDURATIONID_ACK  0x0F/** * @def IX_ETHNPE_PC_SETBBSID_ACK * * @brief Acknowledgment to IX_ETHNPE_PC_SETBBSID message. */#define IX_ETHNPE_PC_SETBBSID_ACK                   0x10/**