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 /** Reverse Address Resolution Protocol (RARP) */
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 #include "nx_rarp.h"
30
31 /* Bring in externs for caller checking code. */
32
33 NX_CALLER_CHECKING_EXTERNS
34
35 /**************************************************************************/
36 /* */
37 /* FUNCTION RELEASE */
38 /* */
39 /* _nxe_rarp_disable 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 RARP disable function call. */
48 /* */
49 /* INPUT */
50 /* */
51 /* ip_ptr IP instance pointer */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _nx_rarp_disable Actual RARP disable function */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
70 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_nxe_rarp_disable(NX_IP * ip_ptr)74 UINT _nxe_rarp_disable(NX_IP *ip_ptr)
75 {
76
77 #ifndef NX_DISABLE_IPV4
78 UINT status;
79
80
81 /* Check for invalid input pointers. */
82 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
83 {
84 return(NX_PTR_ERROR);
85 }
86
87 /* Check for appropriate caller. */
88 NX_INIT_AND_THREADS_CALLER_CHECKING
89
90 /* Call actual RARP disable function. */
91 status = _nx_rarp_disable(ip_ptr);
92
93 /* Return completion status. */
94 return(status);
95 #else /* NX_DISABLE_IPV4 */
96 NX_PARAMETER_NOT_USED(ip_ptr);
97
98 return(NX_NOT_SUPPORTED);
99 #endif /* !NX_DISABLE_IPV4 */
100 }
101
102
