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 #ifdef NX_ENABLE_INTERFACE_CAPABILITY
31 /* Bring in externs for caller checking code.  */
32 NX_CALLER_CHECKING_EXTERNS
33 
34 #endif /* NX_ENABLE_INTERFACE_CAPABILITY */
35 
36 /**************************************************************************/
37 /*                                                                        */
38 /*  FUNCTION                                               RELEASE        */
39 /*                                                                        */
40 /*    _nxe_ip_interface_capability_set                    PORTABLE C      */
41 /*                                                           6.1          */
42 /*  AUTHOR                                                                */
43 /*                                                                        */
44 /*    Yuxin Zhou, Microsoft Corporation                                   */
45 /*                                                                        */
46 /*  DESCRIPTION                                                           */
47 /*                                                                        */
48 /*    This function checks errors in the IP interface capability flag set */
49 /*    function call.                                                      */
50 /*                                                                        */
51 /*  INPUT                                                                 */
52 /*                                                                        */
53 /*    ip_ptr                                IP control block pointer      */
54 /*    interface_index                       Index to the network interface*/
55 /*    interface_capability_flag             Interface capability flag     */
56 /*                                                                        */
57 /*  OUTPUT                                                                */
58 /*                                                                        */
59 /*    status                                Completion status             */
60 /*                                                                        */
61 /*  CALLS                                                                 */
62 /*                                                                        */
63 /*    _nx_ip_interface_capability_set                                     */
64 /*                                                                        */
65 /*  CALLED BY                                                             */
66 /*                                                                        */
67 /*    Application Code                                                    */
68 /*                                                                        */
69 /*  RELEASE HISTORY                                                       */
70 /*                                                                        */
71 /*    DATE              NAME                      DESCRIPTION             */
72 /*                                                                        */
73 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
74 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
75 /*                                            resulting in version 6.1    */
76 /*                                                                        */
77 /**************************************************************************/
_nxe_ip_interface_capability_set(NX_IP * ip_ptr,UINT interface_index,ULONG interface_capability_flag)78 UINT  _nxe_ip_interface_capability_set(NX_IP *ip_ptr, UINT interface_index, ULONG interface_capability_flag)
79 {
80 #ifdef NX_ENABLE_INTERFACE_CAPABILITY
81 
82 UINT status;
83 
84     /* Check for invalid input pointers.  */
85     if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
86     {
87         return(NX_PTR_ERROR);
88     }
89 
90     /* Check for invalid interface index. */
91     if (interface_index >= NX_MAX_PHYSICAL_INTERFACES)
92     {
93         return(NX_INVALID_INTERFACE);
94     }
95 
96     /* Check for appropriate caller.  */
97     NX_INIT_AND_THREADS_CALLER_CHECKING
98 
99     status = _nx_ip_interface_capability_set(ip_ptr, interface_index, interface_capability_flag);
100 
101     /* Return completion status.  */
102     return(status);
103 #else /* NX_ENABLE_INTERFACE_CAPABILITY */
104     NX_PARAMETER_NOT_USED(ip_ptr);
105     NX_PARAMETER_NOT_USED(interface_index);
106     NX_PARAMETER_NOT_USED(interface_capability_flag);
107 
108     return(NX_NOT_SUPPORTED);
109 #endif /* NX_ENABLE_INTERFACE_CAPABILITY */
110 }
111 
112