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 /** Address Resolution Protocol (ARP) */ 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 #include "nx_arp.h" 31 32 /* Bring in externs for caller checking code. */ 33 34 NX_CALLER_CHECKING_EXTERNS 35 36 37 /**************************************************************************/ 38 /* */ 39 /* FUNCTION RELEASE */ 40 /* */ 41 /* _nxe_arp_enable PORTABLE C */ 42 /* 6.1 */ 43 /* AUTHOR */ 44 /* */ 45 /* Yuxin Zhou, Microsoft Corporation */ 46 /* */ 47 /* DESCRIPTION */ 48 /* */ 49 /* This function checks for errors in the ARP enable function */ 50 /* call. */ 51 /* */ 52 /* INPUT */ 53 /* */ 54 /* ip_ptr IP instance pointer */ 55 /* arp_cache_memory Start of ARP cache memory */ 56 /* arp_cache_size Size in bytes of cache memory */ 57 /* */ 58 /* OUTPUT */ 59 /* */ 60 /* status Completion status */ 61 /* */ 62 /* CALLS */ 63 /* */ 64 /* _nx_arp_enable Actual ARP enable function */ 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_arp_enable(NX_IP * ip_ptr,VOID * arp_cache_memory,ULONG arp_cache_size)79UINT _nxe_arp_enable(NX_IP *ip_ptr, VOID *arp_cache_memory, ULONG arp_cache_size) 80 { 81 82 #ifndef NX_DISABLE_IPV4 83 UINT status; 84 85 86 /* Check for invalid input pointers. */ 87 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID) || (arp_cache_memory == NX_NULL)) 88 { 89 return(NX_PTR_ERROR); 90 } 91 92 /* Check to see if ARP is already enabled. */ 93 if (ip_ptr -> nx_ip_arp_allocate) 94 { 95 return(NX_ALREADY_ENABLED); 96 } 97 98 /* Check for invalid ARP cache size. */ 99 if (arp_cache_size < sizeof(NX_ARP)) 100 { 101 return(NX_SIZE_ERROR); 102 } 103 104 /* Check for appropriate caller. */ 105 NX_INIT_AND_THREADS_CALLER_CHECKING 106 107 /* Call actual ARP enable function. */ 108 status = _nx_arp_enable(ip_ptr, arp_cache_memory, arp_cache_size); 109 110 /* Return completion status. */ 111 return(status); 112 #else /* NX_DISABLE_IPV4 */ 113 NX_PARAMETER_NOT_USED(ip_ptr); 114 NX_PARAMETER_NOT_USED(arp_cache_memory); 115 NX_PARAMETER_NOT_USED(arp_cache_size); 116 117 return(NX_NOT_SUPPORTED); 118 #endif /* !NX_DISABLE_IPV4 */ 119 } 120 121
