1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** NetX Component */
17 /** */
18 /** Internet Protocol (IP) */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define NX_SOURCE_CODE
24
25
26 /* Include necessary system files. */
27
28 #include "nx_api.h"
29 #include "nx_ip.h"
30
31 /* Bring in externs for caller checking code. */
32
33 NX_CALLER_CHECKING_EXTERNS
34
35
36 /**************************************************************************/
37 /* */
38 /* FUNCTION RELEASE */
39 /* */
40 /* _nxe_ip_raw_packet_receive PORTABLE C */
41 /* 6.1 */
42 /* AUTHOR */
43 /* */
44 /* Yuxin Zhou, Microsoft Corporation */
45 /* */
46 /* DESCRIPTION */
47 /* */
48 /* This function checks for errors in the IP raw packet receive */
49 /* function call. */
50 /* */
51 /* INPUT */
52 /* */
53 /* ip_ptr IP control block pointer */
54 /* packet_ptr Pointer to place allocated packet */
55 /* in */
56 /* wait_option Suspension option */
57 /* */
58 /* OUTPUT */
59 /* */
60 /* status Completion status */
61 /* */
62 /* CALLS */
63 /* */
64 /* _nx_packet_release Release invalid packet */
65 /* _nx_ip_raw_packet_receive Actual IP raw packet receive */
66 /* function */
67 /* */
68 /* CALLED BY */
69 /* */
70 /* Application Code */
71 /* */
72 /* RELEASE HISTORY */
73 /* */
74 /* DATE NAME DESCRIPTION */
75 /* */
76 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
77 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
78 /* resulting in version 6.1 */
79 /* */
80 /**************************************************************************/
_nxe_ip_raw_packet_receive(NX_IP * ip_ptr,NX_PACKET ** packet_ptr,ULONG wait_option)81 UINT _nxe_ip_raw_packet_receive(NX_IP *ip_ptr, NX_PACKET **packet_ptr, ULONG wait_option)
82 {
83
84 UINT status;
85
86
87 /* Check for invalid input pointers. */
88 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID) || (packet_ptr == NX_NULL))
89 {
90 return(NX_PTR_ERROR);
91 }
92
93 /* Check to see if IP raw packet processing is enabled. */
94 if (!ip_ptr -> nx_ip_raw_ip_processing)
95 {
96 return(NX_NOT_ENABLED);
97 }
98
99 /* Check for appropriate caller. */
100 NX_THREADS_ONLY_CALLER_CHECKING
101
102 /* Call actual IP raw packet receive function. */
103 status = _nx_ip_raw_packet_receive(ip_ptr, packet_ptr, wait_option);
104
105 /* Return completion status. */
106 return(status);
107 }
108
109
