summaryrefslogtreecommitdiff
path: root/cpu/ixp/npe/include/IxEthDBMessages_p.h
blob: ff18160c1fd13f27596b2faffb37352cc207962c (plain)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/**
 * @file IxEthDBMessages_p.h
 *
 * @brief Definitions of NPE messages
 *
 * @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 --
 */

#ifndef IxEthDBMessages_p_H
#define IxEthDBMessages_p_H

#include <IxEthNpe.h>
#include <IxOsCacheMMU.h>
#include "IxEthDB_p.h"

/* events watched by the Eth event processor */
#define IX_ETH_DB_MIN_EVENT_ID        (IX_ETHNPE_EDB_GETMACADDRESSDATABASE)
#define IX_ETH_DB_MAX_EVENT_ID        (IX_ETHNPE_PC_SETAPMACTABLE)

/* macros to fill and extract data from NPE messages - place any endian conversions here */
#define RESET_ELT_MESSAGE(message) { memset((void *) &(message), 0, sizeof((message))); }
#define NPE_MSG_ID(msg) ((msg).data[0] >> 24)

#define FILL_SETPORTVLANTABLEENTRY_MSG(message, portID, setOffset, vlanMembershipSet, ttiSet) \
    do { \
        message.data[0] = (IX_ETHNPE_VLAN_SETPORTVLANTABLEENTRY << 24) | (portID << 16) | (setOffset * 2); \
        message.data[1] = (vlanMembershipSet << 8) | ttiSet; \
    } while (0);

#define FILL_SETPORTVLANTABLERANGE_MSG(message, portID, offset, length, zone) \
    do { \
        message.data[0] = IX_ETHNPE_VLAN_SETPORTVLANTABLERANGE << 24 | portID << 16 | offset << 9 | length << 1; \
        message.data[1] = (UINT32) zone; \
    } while (0);

#define FILL_SETDEFAULTRXVID_MSG(message, portID, tpid, vlanTag) \
    do { \
        message.data[0] = (IX_ETHNPE_VLAN_SETDEFAULTRXVID << 24) \
            | (portID << 16); \
        \
        message.data[1] = (tpid << 16) | vlanTag; \
    } while (0);

#define FILL_SETRXTAGMODE_MSG(message, portID, filterMode, tagMode) \
    do { \
        message.data[0] = IX_ETHNPE_VLAN_SETRXTAGMODE << 24 \
            | portID << 16 \
            | filterMode << 2 \
            | tagMode; \
        \
        message.data[1] = 0; \
    } while (0);

#define FILL_SETRXQOSENTRY(message, portID, classIndex, trafficClass, aqmQueue) \
    do { \
        message.data[0] = IX_ETHNPE_VLAN_SETRXQOSENTRY << 24 \
            | portID << 16 \
            | classIndex; \
        \
        message.data[1] = trafficClass << 24 \
            | 0x1 << 23 \
            | aqmQueue << 16 \
            | aqmQueue << 4; \
    } while (0);

#define FILL_SETPORTIDEXTRACTIONMODE(message, portID, enable) \
    do { \
        message.data[0] = IX_ETHNPE_VLAN_SETPORTIDEXTRACTIONMODE << 24 \
            | portID << 16 \
            | (enable ? 0x1 : 0x0); \
        \
        message.data[1] = 0; \
    } while (0);


#define FILL_SETBLOCKINGSTATE_MSG(message, portID, blocked) \
    do { \
        message.data[0] = IX_ETHNPE_STP_SETBLOCKINGSTATE << 24 \
            | portID << 16 \
            | (blocked ? 0x1 : 0x0); \
        \
        message.data[1] = 0; \
    } while (0);

#define FILL_SETBBSID_MSG(message, portID, bbsid) \
    do { \
        message.data[0] = IX_ETHNPE_PC_SETBBSID << 24 \
            | portID << 16 \
            | bbsid->macAddress[0] << 8 \
            | bbsid->macAddress[1]; \
        \
        message.data[1] = bbsid->macAddress[2] << 24 \
            | bbsid->macAddress[3] << 16 \
            | bbsid->macAddress[4] << 8 \
            | bbsid->macAddress[5]; \
    } while (0);

#define FILL_SETFRAMECONTROLDURATIONID(message, portID, frameControlDurationID) \
    do { \
        message.data[0] = (IX_ETHNPE_PC_SETFRAMECONTROLDURATIONID << 24) | (portID << 16); \
        message.data[1] = frameControlDurationID; \
    } while (0);

#define FILL_SETAPMACTABLE_MSG(message, zone) \
    do { \
        message.data[0] = IX_ETHNPE_PC_SETAPMACTABLE << 24 \
            | 0 << 8      /* always use index 0 */ \
            | 64;         /* 32 entries, 8 bytes each, 4 bytes in a word */ \
        message.data[1] = (UINT32) zone; \
    } while (0);

#define FILL_SETFIREWALLMODE_MSG(message, portID, epDelta, mode, address) \
    do { \
        message.data[0] = IX_ETHNPE_FW_SETFIREWALLMODE << 24 \
            | portID << 16 \
            | (epDelta & 0xFF) << 8 \
            | mode; \
        \
        message.data[1] = (UINT32) address; \
    } while (0);

#define FILL_SETMACADDRESSDATABASE_MSG(message, portID, epDelta, blockCount, address) \
    do { \
        message.data[0] = IX_ETHNPE_EDB_SETMACADDRESSSDATABASE << 24 \
                | (epDelta & 0xFF) << 8 \
                | (blockCount & 0xFF); \
        \
        message.data[1] = (UINT32) address; \
    } while (0);

#define FILL_GETMACADDRESSDATABASE(message, npeId, zone) \
    do { \
        message.data[0] = IX_ETHNPE_EDB_GETMACADDRESSDATABASE << 24; \
        message.data[1] = (UINT32) zone; \
    } while (0);

#define FILL_SETMAXFRAMELENGTHS_MSG(message, portID, maxRxFrameSize, maxTxFrameSize) \
    do { \
        message.data[0] = IX_ETHNPE_SETMAXFRAMELENGTHS << 24 \
            | portID << 16 \
            | ((maxRxFrameSize + 63) / 64) << 8  /* max Rx 64-byte blocks */ \
            | (maxTxFrameSize + 63) / 64; /* max Tx 64-byte blocks */ \
        \
        message.data[1] = maxRxFrameSize << 16 | maxTxFrameSize; \
    } while (0);

#define FILL_SETPORTADDRESS_MSG(message, portID, macAddress) \
    do { \
        message.data[0] = IX_ETHNPE_EDB_SETPORTADDRESS << 24 \
            | portID << 16 \
            | macAddress[0] << 8 \
            | macAddress[1]; \
        \
        message.data[1] = macAddress[2] << 24 \
            | macAddress[3] << 16 \
            | macAddress[4] << 8 \
            | macAddress[5]; \
    } while (0);

/* access to a MAC node in the NPE tree */
#define NPE_NODE_BYTE(eltNodeAddr, offset)      (((UINT8 *) (eltNodeAddr))[offset])

/* browsing of the implicit linear binary tree structure of the NPE tree */
#define LEFT_CHILD_OFFSET(offset)   ((offset) << 1)
#define RIGHT_CHILD_OFFSET(offset)  (((offset) << 1) + 1)

#define IX_EDB_FLAGS_ACTIVE         (0x2)
#define IX_EDB_FLAGS_VALID          (0x1)
#define IX_EDB_FLAGS_RESERVED       (0xfc)
#define IX_EDB_FLAGS_INACTIVE_VALID (0x1)

#define IX_EDB_NPE_NODE_ELT_PORT_ID_OFFSET (6)
#define IX_EDB_NPE_NODE_ELT_FLAGS_OFFSET   (7)
#define IX_EDB_NPE_NODE_WIFI_INDEX_OFFSET  (6)
#define IX_EDB_NPE_NODE_WIFI_FLAGS_OFFSET  (7)
#define IX_EDB_NPE_NODE_FW_FLAGS_OFFSET    (1)
#define IX_EDB_NPE_NODE_FW_RESERVED_OFFSET (6)
#define IX_EDB_NPE_NODE_FW_ADDR_OFFSET     (2)

#define IX_EDB_NPE_NODE_VALID(address)     ((NPE_NODE_BYTE(address, IX_EDB_NPE_NODE_ELT_FLAGS_OFFSET) & IX_EDB_FLAGS_VALID) != 0)
#define IX_EDB_NPE_NODE_ACTIVE(address)    ((NPE_NODE_BYTE(address, IX_EDB_NPE_NODE_ELT_FLAGS_OFFSET) & IX_EDB_FLAGS_ACTIVE) != 0)
#define IX_EDB_NPE_NODE_PORT_ID(address)   (NPE_NODE_BYTE(address, IX_EDB_NPE_NODE_ELT_PORT_ID_OFFSET))

/* macros to send messages to the NPEs */
#define IX_ETHDB_ASYNC_SEND_NPE_MSG(npeId, msg, result) \
    do { \
        result = ixNpeMhMessageSend(npeId, msg, IX_NPEMH_SEND_RETRIES_DEFAULT); \
        \
        if (result != IX_SUCCESS) \
        { \
            ERROR_LOG("DB: Failed to send NPE message\n"); \
        } \
    } while (0);

#define IX_ETHDB_SYNC_SEND_NPE_MSG(npeId, msg, result) \
    do { \
        result = ixNpeMhMessageWithResponseSend(npeId, msg, msg.data[0] >> 24, ixEthDBNpeMsgAck, IX_NPEMH_SEND_RETRIES_DEFAULT); \
        \
        if (result == IX_SUCCESS) \
        { \
            result = ixOsalMutexLock(&ixEthDBPortInfo[IX_ETH_DB_NPE_TO_PORT_ID(npeId)].npeAckLock, IX_ETH_DB_NPE_TIMEOUT); \
            \
            if (result != IX_SUCCESS) \
            { \
                ERROR_LOG("DB: NPE failed to respond within %dms\n", IX_ETH_DB_NPE_TIMEOUT); \
            } \
        } \
        else \
        { \
            ERROR_LOG("DB: Failed to send NPE message\n"); \
        } \
    } while (0);

#ifndef IX_NDEBUG
#define IX_ETH_DB_NPE_MSG_HISTORY_DEPTH (100)
extern IX_ETH_DB_PUBLIC UINT32 npeMsgHistory[IX_ETH_DB_NPE_MSG_HISTORY_DEPTH][2];
extern IX_ETH_DB_PUBLIC UINT32 npeMsgHistoryLen;
#endif

#define IX_ETHDB_SEND_NPE_MSG(npeId, msg, result) { LOG_NPE_MSG(msg); IX_ETHDB_SYNC_SEND_NPE_MSG(npeId, msg, result); }

#endif /* IxEthDBMessages_p_H */