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 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _nx_ip_interface_address_mapping_configure PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Yuxin Zhou, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function configures whether address mapping is needed for */
45 /* specified interface. This routine is typically called from the */
46 /* interface device driver to notify the IP stack whether the */
47 /* underlying interface requires IP address to layer two (MAC) address */
48 /* mapping. */
49 /* */
50 /* INPUT */
51 /* */
52 /* ip_ptr IP control block pointer */
53 /* interface_index Index to the interface */
54 /* mapping_needed Need mapping or not */
55 /* */
56 /* OUTPUT */
57 /* */
58 /* status Completion status */
59 /* */
60 /* CALLS */
61 /* */
62 /* tx_mutex_get Get protection mutex */
63 /* tx_mutex_put Put protection mutex */
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 /**************************************************************************/
_nx_ip_interface_address_mapping_configure(NX_IP * ip_ptr,UINT interface_index,UINT mapping_needed)78 UINT _nx_ip_interface_address_mapping_configure(NX_IP *ip_ptr, UINT interface_index, UINT mapping_needed)
79 {
80
81 /* Get mutex protection. */
82 tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
83
84 /* Set mapping needed. */
85 ip_ptr -> nx_ip_interface[interface_index].nx_interface_address_mapping_needed = (UCHAR)mapping_needed;
86
87 /* Release mutex protection. */
88 tx_mutex_put(&(ip_ptr -> nx_ip_protection));
89
90 /* Return completion status. */
91 return(NX_SUCCESS);
92 }
93
94