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 
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _nx_ip_interface_capability_get                     PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Yuxin Zhou, Microsoft Corporation                                   */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This function gets the capability flag of interface.                */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    ip_ptr                                IP control block pointer      */
50 /*    interface_index                       Index to the interface        */
51 /*    interface_capability_flag             Interface capability flag for */
52 /*                                             output                     */
53 /*                                                                        */
54 /*  OUTPUT                                                                */
55 /*                                                                        */
56 /*    status                                Completion status             */
57 /*                                                                        */
58 /*  CALLS                                                                 */
59 /*                                                                        */
60 /*    tx_mutex_get                          Get protection mutex          */
61 /*    tx_mutex_put                          Put protection mutex          */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    Application Code                                                    */
66 /*                                                                        */
67 /*  RELEASE HISTORY                                                       */
68 /*                                                                        */
69 /*    DATE              NAME                      DESCRIPTION             */
70 /*                                                                        */
71 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
72 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
73 /*                                            resulting in version 6.1    */
74 /*                                                                        */
75 /**************************************************************************/
_nx_ip_interface_capability_get(NX_IP * ip_ptr,UINT interface_index,ULONG * interface_capability_flag)76 UINT  _nx_ip_interface_capability_get(NX_IP *ip_ptr, UINT interface_index, ULONG *interface_capability_flag)
77 {
78 #ifdef NX_ENABLE_INTERFACE_CAPABILITY
79 
80     /* Get mutex protection.  */
81     tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
82 
83     /* Get the HW capability flag. */
84     *interface_capability_flag = ip_ptr -> nx_ip_interface[interface_index].nx_interface_capability_flag;
85 
86     /* Release mutex protection.  */
87     tx_mutex_put(&(ip_ptr -> nx_ip_protection));
88 
89     /* Return completion status.  */
90     return(NX_SUCCESS);
91 
92 #else /* NX_ENABLE_INTERFACE_CAPABILITY */
93     NX_PARAMETER_NOT_USED(ip_ptr);
94     NX_PARAMETER_NOT_USED(interface_index);
95     NX_PARAMETER_NOT_USED(interface_capability_flag);
96 
97     return(NX_NOT_SUPPORTED);
98 #endif /* NX_ENABLE_INTERFACE_CAPABILITY */
99 }
100 
101