diff options
author | Marek Vasut <marex@denx.de> | 2012-07-21 05:02:26 +0000 |
---|---|---|
committer | Joe Hershberger <joe.hershberger@ni.com> | 2012-09-24 13:17:24 -0500 |
commit | 61e129885a8fd6d36c25301e537d46e66b6c6e6a (patch) | |
tree | b67d4a7ed39e74c9618ad3775209454b8e2e781d /drivers/net/npe/include/IxNpeMhReceive_p.h | |
parent | 1389f98fced3651ece415a6011ccbdfac3a52286 (diff) | |
download | u-boot-imx-61e129885a8fd6d36c25301e537d46e66b6c6e6a.zip u-boot-imx-61e129885a8fd6d36c25301e537d46e66b6c6e6a.tar.gz u-boot-imx-61e129885a8fd6d36c25301e537d46e66b6c6e6a.tar.bz2 |
dm: net: Move IXP NPE to drivers/net/
Signed-off-by: Marek Vasut <marex@denx.de>
Cc: Bryan Hundven <bryanhundven@gmail.com>
Cc: Michael Schwingen <rincewind@discworld.dascon.de>
Cc: Wolfgang Denk <wd@denx.de>
Cc: Albert Aribaud <albert.u.boot@aribaud.net>
Cc: U-Boot DM <u-boot-dm@lists.denx.de>
Cc: Joe Hershberger <joe.hershberger@ni.com>
Diffstat (limited to 'drivers/net/npe/include/IxNpeMhReceive_p.h')
-rw-r--r-- | drivers/net/npe/include/IxNpeMhReceive_p.h | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/drivers/net/npe/include/IxNpeMhReceive_p.h b/drivers/net/npe/include/IxNpeMhReceive_p.h new file mode 100644 index 0000000..6416bed --- /dev/null +++ b/drivers/net/npe/include/IxNpeMhReceive_p.h @@ -0,0 +1,139 @@ +/** + * @file IxNpeMhReceive_p.h + * + * @author Intel Corporation + * @date 18 Jan 2002 + * + * @brief This file contains the private API for the Receive module. + * + * + * @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 IxNpeMhReceive_p IxNpeMhReceive_p + * + * @brief The private API for the Receive module. + * + * @{ + */ + +#ifndef IXNPEMHRECEIVE_P_H +#define IXNPEMHRECEIVE_P_H + +#include "IxNpeMh.h" +#include "IxOsalTypes.h" + +/* + * #defines for function return types, etc. + */ + +/* + * Prototypes for interface functions. + */ + +/** + * @fn void ixNpeMhReceiveInitialize (void) + * + * @brief This function registers an internal ISR to handle the NPEs' + * "outFIFO not empty" interrupts and receive messages from the NPEs when + * they become available. + * + * @return No return value. + */ + +void ixNpeMhReceiveInitialize (void); + +/** + * @fn IX_STATUS ixNpeMhReceiveMessagesReceive ( + IxNpeMhNpeId npeId) + * + * @brief This function reads messages from a particular NPE's outFIFO + * until the outFIFO is empty, and for each message looks first for an + * unsolicited callback, then a solicited callback, to pass the message + * back to the client. If no callback can be found the message is + * discarded and an error reported. This function will return TIMEOUT + * status if NPE hang / halt. + * + * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to receive + * messages from. + * + * @return The function returns a status indicating success, failure or timeout. + */ + +IX_STATUS ixNpeMhReceiveMessagesReceive ( + IxNpeMhNpeId npeId); + +/** + * @fn void ixNpeMhReceiveShow ( + IxNpeMhNpeId npeId) + * + * @brief This function will display the current state of the Receive + * module. + * + * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state + * information for. + * + * @return No return status. + */ + +void ixNpeMhReceiveShow ( + IxNpeMhNpeId npeId); + +/** + * @fn void ixNpeMhReceiveShowReset ( + IxNpeMhNpeId npeId) + * + * @brief This function will reset the current state of the Receive + * module. + * + * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state + * information for. + * + * @return No return status. + */ + +void ixNpeMhReceiveShowReset ( + IxNpeMhNpeId npeId); + +#endif /* IXNPEMHRECEIVE_P_H */ + +/** + * @} defgroup IxNpeMhReceive_p + */ |