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 33 NX_CALLER_CHECKING_EXTERNS 34 #endif /* NX_ENABLE_INTERFACE_CAPABILITY */ 35 36 /**************************************************************************/ 37 /* */ 38 /* FUNCTION RELEASE */ 39 /* */ 40 /* _nxe_ip_interface_capability_get 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 get */ 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 Pointer to the interface */ 56 /* capability flag */ 57 /* */ 58 /* OUTPUT */ 59 /* */ 60 /* status Completion status */ 61 /* */ 62 /* CALLS */ 63 /* */ 64 /* _nx_ip_interface_capability_get */ 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_get(NX_IP * ip_ptr,UINT interface_index,ULONG * interface_capability_flag)79UINT _nxe_ip_interface_capability_get(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 invalid pointer to the interface capability flag. */ 98 if (interface_capability_flag == NX_NULL) 99 { 100 return(NX_PTR_ERROR); 101 } 102 103 /* Check for appropriate caller. */ 104 NX_INIT_AND_THREADS_CALLER_CHECKING 105 106 status = _nx_ip_interface_capability_get(ip_ptr, interface_index, interface_capability_flag); 107 108 /* Return completion status. */ 109 return(status); 110 111 #else /* NX_ENABLE_INTERFACE_CAPABILITY */ 112 NX_PARAMETER_NOT_USED(ip_ptr); 113 NX_PARAMETER_NOT_USED(interface_index); 114 NX_PARAMETER_NOT_USED(interface_capability_flag); 115 116 return(NX_NOT_SUPPORTED); 117 #endif /* NX_ENABLE_INTERFACE_CAPABILITY */ 118 } 119 120
