Outline ![]()
Files ![]()
loading...
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
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Packet Pool Management (Packet) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_packet.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_packet_pool_create PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function creates a pool of fixed-size packets within the */
/* specified memory area. */
/* */
/* INPUT */
/* */
/* pool_ptr Packet Pool control block */
/* name_ptr Packet Pool string pointer */
/* payload_size Size of packet payload */
/* pool_start Starting address of pool */
/* pool_size Number of bytes in pool */
/* */
/* OUTPUT */
/* */
/* status Return status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_packet_pool_create(NX_PACKET_POOL *pool_ptr, CHAR *name_ptr, ULONG payload_size,
VOID *pool_start, ULONG pool_size)
{
TX_INTERRUPT_SAVE_AREA
NX_PACKET_POOL *tail_ptr; /* Working packet pool pointer */
ULONG packets; /* Number of packets in pool */
ULONG original_payload_size; /* Original payload size */
ULONG header_size; /* Rounded header size */
CHAR *packet_ptr; /* Working packet pointer */
CHAR *next_packet_ptr; /* Next packet pointer */
CHAR *end_of_pool; /* End of pool area */
CHAR *payload_address; /* Address of the first payload*/
VOID *rounded_pool_start; /* Rounded stating address */
/* Save the original payload size. */
original_payload_size = payload_size;
/* Align the starting address to four bytes. */
/*lint -e{923} suppress cast between ULONG and pointer. */
rounded_pool_start = (VOID *)((((ALIGN_TYPE)pool_start + NX_PACKET_ALIGNMENT - 1) / NX_PACKET_ALIGNMENT) * NX_PACKET_ALIGNMENT);
/* Round the pool size down to something that is evenly divisible by alignment. */
/*lint -e{923} suppress cast between ULONG and pointer. */
pool_size = (ULONG)(((pool_size - ((ALIGN_TYPE)rounded_pool_start - (ALIGN_TYPE)pool_start)) / NX_PACKET_ALIGNMENT) * NX_PACKET_ALIGNMENT);
/* Set the pool starting address. */
pool_start = rounded_pool_start;
/* Calculate the address of payload. */
/*lint -e{923} suppress cast between ULONG and pointer. */
payload_address = (CHAR *)((ALIGN_TYPE)rounded_pool_start + sizeof(NX_PACKET));
/* Align the address of payload. */
/*lint -e{923} suppress cast between ULONG and pointer. */
payload_address = (CHAR *)((((ALIGN_TYPE)payload_address + NX_PACKET_ALIGNMENT - 1) / NX_PACKET_ALIGNMENT) * NX_PACKET_ALIGNMENT);
/* Calculate the header size. */
/*lint -e{923} suppress cast between ULONG and pointer. */
header_size = (ULONG)((ALIGN_TYPE)payload_address - (ALIGN_TYPE)rounded_pool_start);
/* Round the packet size up to something that helps guarantee proper alignment for header and payload. */
payload_size = (ULONG)(((header_size + payload_size + NX_PACKET_ALIGNMENT - 1) / NX_PACKET_ALIGNMENT) * NX_PACKET_ALIGNMENT - header_size);
/* Clear pool fields. */
memset(pool_ptr, 0, sizeof(NX_PACKET_POOL));
/* Setup the basic packet pool fields. */
pool_ptr -> nx_packet_pool_name = name_ptr;
pool_ptr -> nx_packet_pool_suspension_list = TX_NULL;
pool_ptr -> nx_packet_pool_suspended_count = 0;
pool_ptr -> nx_packet_pool_start = (CHAR *)pool_start;
pool_ptr -> nx_packet_pool_size = pool_size;
pool_ptr -> nx_packet_pool_payload_size = original_payload_size;
/* Calculate the end of the pool's memory area. */
end_of_pool = ((CHAR *)pool_start) + pool_size;
/* Walk through the pool area, setting up the available packet list. */
packets = 0;
packet_ptr = (CHAR *)rounded_pool_start;
next_packet_ptr = packet_ptr + (payload_size + header_size);
/*lint -e{946} suppress pointer subtraction, since it is necessary. */
while (next_packet_ptr <= end_of_pool)
{
/* Yes, we have another packet. Increment the packet count. */
packets++;
/* Setup the link to the next packet. */
/*lint -e{929} -e{740} -e{826} suppress cast of pointer to pointer, since it is necessary */
((NX_PACKET *)packet_ptr) -> nx_packet_queue_next = (NX_PACKET *)next_packet_ptr;
/* Remember that this packet pool is the owner. */
/*lint -e{929} -e{740} -e{826} suppress cast of pointer to pointer, since it is necessary */
((NX_PACKET *)packet_ptr) -> nx_packet_pool_owner = pool_ptr;
#ifndef NX_DISABLE_PACKET_CHAIN
/* Clear the next packet pointer. */
/*lint -e{929} -e{740} -e{826} suppress cast of pointer to pointer, since it is necessary */
((NX_PACKET *)packet_ptr) -> nx_packet_next = (NX_PACKET *)NX_NULL;
#endif /* NX_DISABLE_PACKET_CHAIN */
/* Mark the packet as free. */
/*lint -e{929} -e{923} -e{740} -e{826} suppress cast of pointer to pointer, since it is necessary */
((NX_PACKET *)packet_ptr) -> nx_packet_union_next.nx_packet_tcp_queue_next = (NX_PACKET *)NX_PACKET_FREE;
/* Setup the packet data pointers. */
/*lint -e{929} -e{928} -e{740} -e{826} suppress cast of pointer to pointer, since it is necessary */
((NX_PACKET *)packet_ptr) -> nx_packet_data_start = (UCHAR *)(packet_ptr + header_size);
/*lint -e{929} -e{928} -e{740} -e{826} suppress cast of pointer to pointer, since it is necessary */
((NX_PACKET *)packet_ptr) -> nx_packet_data_end = (UCHAR *)(packet_ptr + header_size + original_payload_size);
/* Add debug information. */
NX_PACKET_DEBUG(__FILE__, __LINE__, (NX_PACKET *)packet_ptr);
/* Advance to the next packet. */
packet_ptr = next_packet_ptr;
/* Update the next packet pointer. */
next_packet_ptr = packet_ptr + (payload_size + header_size);
}
/* Backup to the last packet in the pool. */
packet_ptr = packet_ptr - (payload_size + header_size);
/* Set the last packet's forward pointer to NULL. */
/*lint -e{929} -e{740} -e{826} suppress cast of pointer to pointer, since it is necessary */
((NX_PACKET *)packet_ptr) -> nx_packet_queue_next = NX_NULL;
/* Save the remaining information in the pool control packet. */
pool_ptr -> nx_packet_pool_available = packets;
pool_ptr -> nx_packet_pool_total = packets;
/* Set the packet pool available list. */
pool_ptr -> nx_packet_pool_available_list = (NX_PACKET *)pool_start;
/* If trace is enabled, register this object. */
NX_TRACE_OBJECT_REGISTER(NX_TRACE_OBJECT_TYPE_PACKET_POOL, pool_ptr, name_ptr, payload_size, packets);
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NX_TRACE_PACKET_POOL_CREATE, pool_ptr, payload_size, pool_start, pool_size, NX_TRACE_PACKET_EVENTS, 0, 0);
/* Disable interrupts to place the packet pool on the created list. */
TX_DISABLE
/* Setup the packet pool ID to make it valid. */
pool_ptr -> nx_packet_pool_id = NX_PACKET_POOL_ID;
/* Place the packet pool on the list of created packet pools. First,
check for an empty list. */
if (_nx_packet_pool_created_ptr)
{
/* Pickup tail pointer. */
tail_ptr = _nx_packet_pool_created_ptr -> nx_packet_pool_created_previous;
/* Place the new packet pool in the list. */
_nx_packet_pool_created_ptr -> nx_packet_pool_created_previous = pool_ptr;
tail_ptr -> nx_packet_pool_created_next = pool_ptr;
/* Setup this packet pool's created links. */
pool_ptr -> nx_packet_pool_created_previous = tail_ptr;
pool_ptr -> nx_packet_pool_created_next = _nx_packet_pool_created_ptr;
}
else
{
/* The created packet pool list is empty. Add packet pool to empty list. */
_nx_packet_pool_created_ptr = pool_ptr;
pool_ptr -> nx_packet_pool_created_next = pool_ptr;
pool_ptr -> nx_packet_pool_created_previous = pool_ptr;
}
/* Increment the number of packet pools created. */
_nx_packet_pool_created_count++;
/* Restore interrupts. */
TX_RESTORE
/* Return NX_SUCCESS. */
return(NX_SUCCESS);
}