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 /* Bring in externs for caller checking code. */ 32 NX_CALLER_CHECKING_EXTERNS 33 34 /**************************************************************************/ 35 /* */ 36 /* FUNCTION RELEASE */ 37 /* */ 38 /* _nxe_ip_interface_address_mapping_configure PORTABLE C */ 39 /* 6.1 */ 40 /* AUTHOR */ 41 /* */ 42 /* Yuxin Zhou, Microsoft Corporation */ 43 /* */ 44 /* DESCRIPTION */ 45 /* */ 46 /* This function checks errors in the IP address mapping configure */ 47 /* function call. */ 48 /* */ 49 /* INPUT */ 50 /* */ 51 /* ip_ptr IP control block pointer */ 52 /* interface_index Index to the network interface*/ 53 /* mapping_needed Whether or not IP address to */ 54 /* MAC address mapping needed */ 55 /* */ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Completion status */ 60 /* */ 61 /* CALLS */ 62 /* */ 63 /* _nx_ip_interface_address_mapping_configure */ 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_address_mapping_configure(NX_IP * ip_ptr,UINT interface_index,UINT mapping_needed)78UINT _nxe_ip_interface_address_mapping_configure(NX_IP *ip_ptr, UINT interface_index, UINT mapping_needed) 79 { 80 81 UINT status; 82 83 /* Check for invalid input pointers. */ 84 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID)) 85 { 86 return(NX_PTR_ERROR); 87 } 88 89 /* Check for invalid interface index */ 90 if (interface_index >= NX_MAX_PHYSICAL_INTERFACES) 91 { 92 return(NX_INVALID_INTERFACE); 93 } 94 95 /* Check for appropriate caller. */ 96 NX_INIT_AND_THREADS_CALLER_CHECKING 97 98 status = _nx_ip_interface_address_mapping_configure(ip_ptr, interface_index, mapping_needed); 99 100 /* Return completion status. */ 101 return(status); 102 } 103 104