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 /* Bring in externs for caller checking code. */ 33 34 NX_CALLER_CHECKING_EXTERNS 35 36 /**************************************************************************/ 37 /* */ 38 /* FUNCTION RELEASE */ 39 /* */ 40 /* _nxe_ip_gateway_address_set PORTABLE C */ 41 /* 6.1 */ 42 /* AUTHOR */ 43 /* */ 44 /* Yuxin Zhou, Microsoft Corporation */ 45 /* */ 46 /* DESCRIPTION */ 47 /* */ 48 /* This function checks for errors in the IP gateway address set */ 49 /* function call. */ 50 /* */ 51 /* INPUT */ 52 /* */ 53 /* ip_ptr IP control block pointer */ 54 /* ip_address Gateway IP address */ 55 /* */ 56 /* OUTPUT */ 57 /* */ 58 /* status Completion status */ 59 /* */ 60 /* CALLS */ 61 /* */ 62 /* _nx_ip_gateway_address_set Actual IP gateway address */ 63 /* set function call */ 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_gateway_address_set(NX_IP * ip_ptr,ULONG ip_address)78UINT _nxe_ip_gateway_address_set(NX_IP *ip_ptr, ULONG ip_address) 79 { 80 81 #ifndef NX_DISABLE_IPV4 82 UINT status; 83 84 /* Check for invalid input pointers. */ 85 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID)) 86 { 87 return(NX_PTR_ERROR); 88 } 89 90 /* Determine if this is a valid gateway address. */ 91 /*lint -e{835} -e{845} suppress operating on zero. */ 92 if (ip_address == IP_ADDRESS(0, 0, 0, 0)) 93 { 94 return(NX_IP_ADDRESS_ERROR); 95 } 96 97 /* Check for appropriate caller. */ 98 NX_INIT_AND_THREADS_CALLER_CHECKING 99 100 /* Call actual IP gateway address set function. */ 101 status = _nx_ip_gateway_address_set(ip_ptr, ip_address); 102 103 /* Return completion status. */ 104 return(status); 105 #else /* NX_DISABLE_IPV4 */ 106 NX_PARAMETER_NOT_USED(ip_ptr); 107 NX_PARAMETER_NOT_USED(ip_address); 108 109 return(NX_NOT_SUPPORTED); 110 #endif /* !NX_DISABLE_IPV4 */ 111 } 112 113
