summaryrefslogtreecommitdiff
path: root/common/src/nxd_ipv6_address_get.c
blob: d35c19c1f1acb2de6b83808662da985dfd95b85c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2025-present Eclipse ThreadX Contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** NetX Component                                                        */
/**                                                                       */
/**   Internet Protocol (IP)                                              */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_ip.h"
#include "nx_ipv6.h"

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nxd_ipv6_address_get                               PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*   This function retrieves the IP address at the specified address list */
/*  index of the physical host interface specified by the interface index.*/
/*  Returns an IPv6 address and prefix length into the specified pointers.*/
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                IP control block pointer      */
/*    address_index                         Index to the IPv6 address     */
/*                                            table                       */
/*    ip_address                            Pointer to IP address         */
/*                                            structure to be filled      */
/*    prefix_length                         Pointer to prefix length      */
/*                                            to return                   */
/*    interface_index                       The index to the physical     */
/*                                            interface this address      */
/*                                            belongs to                  */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Get protection mutex          */
/*    tx_mutex_put                          Put protection mutex          */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/*  NOTE                                                                  */
/*    Application needs to fill in the ip_address.nxd_ip_version field.   */
/*                                                                        */
/**************************************************************************/
UINT  _nxd_ipv6_address_get(NX_IP *ip_ptr, UINT address_index, NXD_ADDRESS *ip_address,
                            ULONG *prefix_length, UINT *interface_index)
{
#ifdef FEATURE_NX_IPV6

TX_INTERRUPT_SAVE_AREA

UINT              status;
NXD_IPV6_ADDRESS *interface_ipv6_address_next;
#ifdef TX_ENABLE_EVENT_TRACE
ULONG             ip_address_lsw;
#endif /* TX_ENABLE_EVENT_TRACE */


    status = NX_SUCCESS;

    /* Get mutex protection.  */
    tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
    /* Disable interrupts.  */
    TX_DISABLE

    /* Get the ip address.  */
    interface_ipv6_address_next = &ip_ptr -> nx_ipv6_address[address_index];

    /* Check if this is a valid IP address. */
    if (interface_ipv6_address_next -> nxd_ipv6_address_state != NX_IPV6_ADDR_STATE_VALID)
    {

        /* No, the address is not validated yet. */

        /* Zero out the return values. */
        *prefix_length = 0;
        SET_UNSPECIFIED_ADDRESS(ip_address -> nxd_ip_address.v6);

        /* Return the error status. */
        status = NX_NO_INTERFACE_ADDRESS;
    }
    else
    {

        /* Record the interface index.  */
        *interface_index = (UINT)ip_ptr -> nx_ipv6_address[address_index].nxd_ipv6_address_attached -> nx_interface_index;

        /* We have a valid address. Mark with the IPv6 stamp. */
        ip_address -> nxd_ip_version = NX_IP_VERSION_V6;

        /* Copy interface IP address from the address entry in the IP address table into the return address structure. */
        COPY_IPV6_ADDRESS(interface_ipv6_address_next -> nxd_ipv6_address,
                          ip_address -> nxd_ip_address.v6);

        /* Copy interface IP address prefix length from the address entry in the IP address table into the return prefix length. */
        *prefix_length = interface_ipv6_address_next -> nxd_ipv6_address_prefix_length;
    }

    /* Restore interrupts.  */
    TX_RESTORE

    /* Release mutex protection.  */
    tx_mutex_put(&(ip_ptr -> nx_ip_protection));

#ifdef TX_ENABLE_EVENT_TRACE
    ip_address_lsw = ip_address -> nxd_ip_address.v6[3];

    /* If trace is enabled, insert this info into the trace buffer.  */
    NX_TRACE_IN_LINE_INSERT(NXD_TRACE_IPV6_INTERFACE_ADDRESS_GET, ip_ptr, ip_address_lsw, *prefix_length, address_index, NX_TRACE_IP_EVENTS, 0, 0);
#endif /* TX_ENABLE_EVENT_TRACE */

    /* Return completion status.  */
    return(status);

#else /* !FEATURE_NX_IPV6 */
    NX_PARAMETER_NOT_USED(ip_ptr);
    NX_PARAMETER_NOT_USED(address_index);
    NX_PARAMETER_NOT_USED(ip_address);
    NX_PARAMETER_NOT_USED(prefix_length);
    NX_PARAMETER_NOT_USED(interface_index);

    return(NX_NOT_SUPPORTED);

#endif /* FEATURE_NX_IPV6 */
}