source: SVN/cambria/redboot/packages/devs/eth/intel/npe/npeMh/current/include/IxNpeMhReceive_p.h @ 1

Last change on this file since 1 was 1, checked in by Tim Harvey, 2 years ago

restored latest version of files from server backup

Signed-off-by: Tim Harvey <tharvey@…>

File size: 4.1 KB
Line 
1/**
2 * @file IxNpeMhReceive_p.h
3 *
4 * @author Intel Corporation
5 * @date 18 Jan 2002
6 *
7 * @brief This file contains the private API for the Receive module.
8 *
9 *
10 * @par
11 * IXP400 SW Release version 2.3
12 *
13 * -- Copyright Notice --
14 *
15 * @par
16 * Copyright (c) 2001-2005, Intel Corporation.
17 * All rights reserved.
18 *
19 * @par
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
22 * are met:
23 * 1. Redistributions of source code must retain the above copyright
24 *    notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 *    notice, this list of conditions and the following disclaimer in the
27 *    documentation and/or other materials provided with the distribution.
28 * 3. Neither the name of the Intel Corporation nor the names of its contributors
29 *    may be used to endorse or promote products derived from this software
30 *    without specific prior written permission.
31 *
32 *
33 * @par
34 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
35 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
38 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44 * SUCH DAMAGE.
45 *
46 *
47 * @par
48 * -- End of Copyright Notice --
49*/
50
51/**
52 * @defgroup IxNpeMhReceive_p IxNpeMhReceive_p
53 *
54 * @brief The private API for the Receive module.
55 *
56 * @{
57 */
58
59#ifndef IXNPEMHRECEIVE_P_H
60#define IXNPEMHRECEIVE_P_H
61
62#include "IxNpeMh.h"
63#include "IxOsalTypes.h"
64
65/*
66 * #defines for function return types, etc.
67 */
68
69/*
70 * Prototypes for interface functions.
71 */
72
73/**
74 * @fn void ixNpeMhReceiveInitialize (void)
75 *
76 * @brief This function registers an internal ISR to handle the NPEs'
77 * "outFIFO not empty" interrupts and receive messages from the NPEs when
78 * they become available.
79 *
80 * @return No return value.
81 */
82
83void ixNpeMhReceiveInitialize (void);
84
85/**
86 * @fn void ixNpeMhReceiveUninitialize (void)
87 *
88 * @brief This function unregisters the internal ISR to handle the NPEs'
89 * "outFIFO not empty" interrupt.
90 *
91 * @return No return value.
92 */
93
94void ixNpeMhReceiveUninitialize (void);
95
96
97/**
98 * @fn void ixNpeMhReceiveMessagesReceive (
99           IxNpeMhNpeId npeId)
100 *
101 * @brief This function reads messages from a particular NPE's outFIFO
102 * until the outFIFO is empty, and for each message looks first for an
103 * unsolicited callback, then a solicited callback, to pass the message
104 * back to the client.  If no callback can be found the message is
105 * discarded and an error reported. This function will return TIMEOUT
106 * status if NPE hang / halt.
107 *
108 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to receive
109 * messages from.
110 *
111 * @return The function returns a status indicating success, failure or timeout.
112 */
113
114IX_STATUS ixNpeMhReceiveMessagesReceive (
115    IxNpeMhNpeId npeId);
116
117/**
118 * @fn void ixNpeMhReceiveShow (
119           IxNpeMhNpeId npeId)
120 *
121 * @brief This function will display the current state of the Receive
122 * module.
123 *
124 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
125 * information for.
126 *
127 * @return No return status.
128 */
129
130void ixNpeMhReceiveShow (
131    IxNpeMhNpeId npeId);
132
133/**
134 * @fn void ixNpeMhReceiveShowReset (
135           IxNpeMhNpeId npeId)
136 *
137 * @brief This function will reset the current state of the Receive
138 * module.
139 *
140 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
141 * information for.
142 *
143 * @return No return status.
144 */
145
146void ixNpeMhReceiveShowReset (
147    IxNpeMhNpeId npeId);
148
149#endif /* IXNPEMHRECEIVE_P_H */
150
151/**
152 * @} defgroup IxNpeMhReceive_p
153 */
Note: See TracBrowser for help on using the repository browser.