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