summaryrefslogtreecommitdiff
path: root/common/src/nxd_ipv6_default_router_entry_get.c
blob: ee5f7f436bd86f29a2990305c4c4f0f03f54f17b (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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/***************************************************************************
 * 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 version 6 Default Router Table (IPv6 router)      */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_ipv6.h"
#ifdef FEATURE_NX_IPV6
#include "nx_nd_cache.h"
#endif /* FEATURE_NX_IPV6 */


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nxd_ipv6_default_router_entry_get                   PORTABLE C     */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function gets a router entry from the default IPv6 routing     */
/*    table.                                                              */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                IP instance pointer           */
/*    interface_index                       Index to the interface        */
/*    entry_index                           Entry Index                   */
/*    router_addr                           Router IPv6 Address           */
/*    router_lifetime                       Pointer to router life time   */
/*    prefix_length                         Pointer to prefix length      */
/*    configuration_method                  Pointer to the information    */
/*                                            on how the entry was        */
/*                                            configured                  */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Obtain protection mutex       */
/*    tx_mutex_put                          Release protection mutex      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application code                                                    */
/*    _nxd_ipv6_default_router_get                                        */
/*                                                                        */
/*  NOTE                                                                  */
/*                                                                        */
/*                                                                        */
/*    This function cannot be called from ISR.                            */
/*                                                                        */
/**************************************************************************/
UINT  _nxd_ipv6_default_router_entry_get(NX_IP *ip_ptr, UINT interface_index, UINT entry_index,
                                         NXD_ADDRESS *router_addr, ULONG *router_lifetime,
                                         ULONG *prefix_length, ULONG *configuration_method)
{
#ifdef FEATURE_NX_IPV6

UINT                          status;
UINT                          i;
NX_IPV6_DEFAULT_ROUTER_ENTRY *rt_entry;


    /* Obtain protection on this IP instance for access into the router table. */

    tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);

    /* Initialize the return value to be NX_NOT_FOUND.  Once the router address is set,
       the return value is set to NX_SUCCESS. */
    status = NX_NOT_FOUND;

    for (i = 0; i < NX_IPV6_DEFAULT_ROUTER_TABLE_SIZE; i++)
    {

        rt_entry = &ip_ptr -> nx_ipv6_default_router_table[i];
        /* Skip invalid entries. */
        if (rt_entry -> nx_ipv6_default_router_entry_flag == 0)
        {
            continue;
        }

        /* Match the interface. */
        if (rt_entry -> nx_ipv6_default_router_entry_interface_ptr -> nx_interface_index != (UCHAR)interface_index)
        {
            continue;
        }

        /* Match the entry index */
        if (entry_index > 0)
        {
            entry_index--;
        }
        else
        {

            if (router_addr)
            {
                router_addr -> nxd_ip_version = NX_IP_VERSION_V6;

                COPY_IPV6_ADDRESS(&(rt_entry -> nx_ipv6_default_router_entry_router_address[0]),
                                  &router_addr -> nxd_ip_address.v6[0]);
            }


            if (router_lifetime)
            {
                *router_lifetime = rt_entry -> nx_ipv6_default_router_entry_life_time;
            }

            if (prefix_length)
            {
                if ((rt_entry -> nx_ipv6_default_router_entry_router_address[0] & (UINT)0xFFC00000) == (UINT)0xFE800000)
                {
                    *prefix_length = 10;
                }
                else
                {
                    *prefix_length = 64;
                }
            }

            if (configuration_method)
            {
                *configuration_method = (rt_entry -> nx_ipv6_default_router_entry_flag &
                                         (UCHAR)(~NX_IPV6_ROUTE_TYPE_VALID));
            }

            status = NX_SUCCESS;

            break;
        }
    }

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

    return(status);

#else /* !FEATURE_NX_IPV6 */
    NX_PARAMETER_NOT_USED(ip_ptr);
    NX_PARAMETER_NOT_USED(interface_index);
    NX_PARAMETER_NOT_USED(entry_index);
    NX_PARAMETER_NOT_USED(router_addr);
    NX_PARAMETER_NOT_USED(router_lifetime);
    NX_PARAMETER_NOT_USED(prefix_length);
    NX_PARAMETER_NOT_USED(configuration_method);

    return(NX_NOT_SUPPORTED);

#endif /* FEATURE_NX_IPV6 */
}