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 34 NX_CALLER_CHECKING_EXTERNS 35 #endif /* NX_ENABLE_INTERFACE_CAPABILITY */ 36 37 /**************************************************************************/ 38 /* */ 39 /* FUNCTION RELEASE */ 40 /* */ 41 /* _nxe_ip_interface_capability_get 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 get */ 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 Pointer to the interface */ 57 /* capability flag */ 58 /* */ 59 /* OUTPUT */ 60 /* */ 61 /* status Completion status */ 62 /* */ 63 /* CALLS */ 64 /* */ 65 /* _nx_ip_interface_capability_get */ 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_interface_capability_get(NX_IP * ip_ptr,UINT interface_index,ULONG * interface_capability_flag)80UINT _nxe_ip_interface_capability_get(NX_IP *ip_ptr, UINT interface_index, ULONG *interface_capability_flag) 81 { 82 #ifdef NX_ENABLE_INTERFACE_CAPABILITY 83 84 UINT status; 85 86 /* Check for invalid input pointers. */ 87 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID)) 88 { 89 return(NX_PTR_ERROR); 90 } 91 92 /* Check for invalid interface index. */ 93 if (interface_index >= NX_MAX_PHYSICAL_INTERFACES) 94 { 95 return(NX_INVALID_INTERFACE); 96 } 97 98 /* Check for invalid pointer to the interface capability flag. */ 99 if (interface_capability_flag == NX_NULL) 100 { 101 return(NX_PTR_ERROR); 102 } 103 104 /* Check for appropriate caller. */ 105 NX_INIT_AND_THREADS_CALLER_CHECKING 106 107 status = _nx_ip_interface_capability_get(ip_ptr, interface_index, interface_capability_flag); 108 109 /* Return completion status. */ 110 return(status); 111 112 #else /* NX_ENABLE_INTERFACE_CAPABILITY */ 113 NX_PARAMETER_NOT_USED(ip_ptr); 114 NX_PARAMETER_NOT_USED(interface_index); 115 NX_PARAMETER_NOT_USED(interface_capability_flag); 116 117 return(NX_NOT_SUPPORTED); 118 #endif /* NX_ENABLE_INTERFACE_CAPABILITY */ 119 } 120 121
