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 33 NX_CALLER_CHECKING_EXTERNS 34 35 /**************************************************************************/ 36 /* */ 37 /* FUNCTION RELEASE */ 38 /* */ 39 /* _nxe_ip_address_get PORTABLE C */ 40 /* 6.1 */ 41 /* AUTHOR */ 42 /* */ 43 /* Yuxin Zhou, Microsoft Corporation */ 44 /* */ 45 /* DESCRIPTION */ 46 /* */ 47 /* This function checks for errors in the IP address get function */ 48 /* call. */ 49 /* */ 50 /* INPUT */ 51 /* */ 52 /* ip_ptr IP control block pointer */ 53 /* ip_address Pointer to IP address destination */ 54 /* network_mask Pointer to network mask */ 55 /* destination */ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Completion status */ 60 /* */ 61 /* CALLS */ 62 /* */ 63 /* _nx_ip_address_get Actual IP address get function */ 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_address_get(NX_IP * ip_ptr,ULONG * ip_address,ULONG * network_mask)78UINT _nxe_ip_address_get(NX_IP *ip_ptr, ULONG *ip_address, ULONG *network_mask) 79 { 80 81 #ifndef NX_DISABLE_IPV4 82 UINT status; 83 84 85 /* Check for invalid input pointers. */ 86 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID) || (ip_address == NX_NULL) || (network_mask == NX_NULL)) 87 { 88 return(NX_PTR_ERROR); 89 } 90 91 /* Check for appropriate caller. */ 92 NX_INIT_AND_THREADS_CALLER_CHECKING 93 94 /* Call actual IP address get function. */ 95 status = _nx_ip_address_get(ip_ptr, ip_address, network_mask); 96 97 /* Return completion status. */ 98 return(status); 99 #else /* NX_DISABLE_IPV4 */ 100 NX_PARAMETER_NOT_USED(ip_ptr); 101 NX_PARAMETER_NOT_USED(ip_address); 102 NX_PARAMETER_NOT_USED(network_mask); 103 104 return(NX_NOT_SUPPORTED); 105 #endif /* !NX_DISABLE_IPV4 */ 106 } 107 108
