netxduo
Select one of the symbols to view example projects that use it.
 
Outline
...
...
...
...
#define NX_SOURCE_CODE
#include "nx_api.h"
#include "nx_packet.h"
...
...
_nx_packet_data_retrieve(NX_PACKET *, void *, ULONG *)
Files
loading...
SourceVuSTM32 Libraries and Samplesnetxduocommon/src/nx_packet_data_retrieve.c
 
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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/**************************************************************************/ /* */ /* 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_data_retrieve PORTABLE C */ /* 6.1 */ /* AUTHOR */ /* */ /* Yuxin Zhou, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function copies data from a NetX packet (or packet chain) into */ /* the supplied user buffer. */ /* */ /* INPUT */ /* */ /* packet_ptr Pointer to the source packet */ /* buffer_start Pointer to destination area */ /* bytes_copied Number of bytes copied */ /* */ /* OUTPUT */ /* */ /* status Completion 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), and */ /* verified memcpy use cases, */ /* resulting in version 6.1 */ /* */... /**************************************************************************/ UINT _nx_packet_data_retrieve(NX_PACKET *packet_ptr, VOID *buffer_start, ULONG *bytes_copied) { ULONG remaining_bytes; UCHAR *destination_ptr; ULONG bytes_to_copy; /* If trace is enabled, insert this event into the trace buffer. */ NX_TRACE_IN_LINE_INSERT(NX_TRACE_PACKET_DATA_RETRIEVE, packet_ptr, buffer_start, bytes_copied, 0, NX_TRACE_PACKET_EVENTS, 0, 0); /* Setup the destination pointer. */ destination_ptr = buffer_start; /* Pickup the amount of bytes to copy. */ *bytes_copied = packet_ptr -> nx_packet_length; /* Setup the remaining bytes. */ remaining_bytes = packet_ptr -> nx_packet_length; #ifndef NX_DISABLE_PACKET_CHAIN /* Loop to copy bytes from packet(s). */ while (packet_ptr) { #endif /* NX_DISABLE_PACKET_CHAIN */ /* Calculate the bytes to copy in this packet. */ /*lint -e{946} -e{947} suppress pointer subtraction, since it is necessary. */ bytes_to_copy = (ULONG)(packet_ptr -> nx_packet_append_ptr - packet_ptr -> nx_packet_prepend_ptr); /* Copy data to destination. */ /* Note: The buffer size must be not less than packet_ptr -> nx_packet_length. */ memcpy(destination_ptr, packet_ptr -> nx_packet_prepend_ptr, bytes_to_copy); /* Use case of memcpy is verified. The buffer is provided by user. */ remaining_bytes -= bytes_to_copy; destination_ptr += bytes_to_copy; #ifndef NX_DISABLE_PACKET_CHAIN /* Move to next packet. */ packet_ptr = packet_ptr -> nx_packet_next; }/* ... */ while (packet_ptr) { ... }#endif /* NX_DISABLE_PACKET_CHAIN */ /* Determine if the packet chain was valid. */ if (remaining_bytes) { /* Invalid packet chain. Calculate the actual number of bytes copied. *//* ... */ *bytes_copied = *bytes_copied - remaining_bytes; /* Return an error. */ return(NX_INVALID_PACKET); }if (remaining_bytes) { ... } /* Return successful completion. */ return(NX_SUCCESS); }{ ... }
Details
Show:
from
Types: Columns: