1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/**
* @file IxNpeMhSend_p.h
*
* @author Intel Corporation
* @date 18 Jan 2002
*
* @brief This file contains the private API for the Send module.
*
*
* @par
* IXP400 SW Release version 2.0
*
* -- Copyright Notice --
*
* @par
* Copyright 2001-2005, Intel Corporation.
* All rights reserved.
*
* @par
* SPDX-License-Identifier: BSD-3-Clause
* @par
* -- End of Copyright Notice --
*/
/**
* @defgroup IxNpeMhSend_p IxNpeMhSend_p
*
* @brief The private API for the Send module.
*
* @{
*/
#ifndef IXNPEMHSEND_P_H
#define IXNPEMHSEND_P_H
#include "IxNpeMh.h"
#include "IxOsalTypes.h"
/*
* #defines for function return types, etc.
*/
/*
* Prototypes for interface functions.
*/
/**
* @fn IX_STATUS ixNpeMhSendMessageSend (
IxNpeMhNpeId npeId,
IxNpeMhMessage message,
UINT32 maxSendRetries)
*
* @brief This function writes a message to the specified NPE's inFIFO,
* and must be used when the message being sent does not solicit a response
* from the NPE. This function will return TIMEOUT status if NPE hang / halt.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message
* to.
* @param IxNpeMhMessage message (in) - The message to send.
* @param UINT32 maxSendRetries (in) - Max num. of retries to perform
* if the NPE's inFIFO is full.
*
* @return The function returns a status indicating success, failure or timeout.
*/
IX_STATUS ixNpeMhSendMessageSend (
IxNpeMhNpeId npeId,
IxNpeMhMessage message,
UINT32 maxSendRetries);
/**
* @fn IX_STATUS ixNpeMhSendMessageWithResponseSend (
IxNpeMhNpeId npeId,
IxNpeMhMessage message,
IxNpeMhMessageId solicitedMessageId,
IxNpeMhCallback solicitedCallback,
UINT32 maxSendRetries)
*
* @brief This function writes a message to the specified NPE's inFIFO,
* and must be used when the message being sent solicits a response from
* the NPE. The ID of the solicited response must be specified so that it
* can be recognised, and a callback provided to pass the response back to
* the client. This function will return TIMEOUT status if NPE hang / halt.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message
* to.
* @param IxNpeMhMessage message (in) - The message to send.
* @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the
* solicited response.
* @param IxNpeMhCallback solicitedCallback (in) - The callback to pass the
* solicited response back to the client.
* @param UINT32 maxSendRetries (in) - Max num. of retries to perform
* if the NPE's inFIFO is full.
*
* @return The function returns a status indicating success, failure or timeout.
*/
IX_STATUS ixNpeMhSendMessageWithResponseSend (
IxNpeMhNpeId npeId,
IxNpeMhMessage message,
IxNpeMhMessageId solicitedMessageId,
IxNpeMhCallback solicitedCallback,
UINT32 maxSendRetries);
/**
* @fn void ixNpeMhSendShow (
IxNpeMhNpeId npeId)
*
* @brief This function will display the current state of the Send module.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
* information for.
*
* @return No return value.
*/
void ixNpeMhSendShow (
IxNpeMhNpeId npeId);
/**
* @fn void ixNpeMhSendShowReset (
IxNpeMhNpeId npeId)
*
* @brief This function will reset the current state of the Send module.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
* information for.
*
* @return No return value.
*/
void ixNpeMhSendShowReset (
IxNpeMhNpeId npeId);
#endif /* IXNPEMHSEND_P_H */
/**
* @} defgroup IxNpeMhSend_p
*/
|
