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