1*10465441SEvalZero /**
2*10465441SEvalZero * @file
3*10465441SEvalZero * Interface Identification APIs from:
4*10465441SEvalZero * RFC 3493: Basic Socket Interface Extensions for IPv6
5*10465441SEvalZero * Section 4: Interface Identification
6*10465441SEvalZero *
7*10465441SEvalZero * @defgroup if_api Interface Identification API
8*10465441SEvalZero * @ingroup socket
9*10465441SEvalZero */
10*10465441SEvalZero
11*10465441SEvalZero /*
12*10465441SEvalZero * Copyright (c) 2017 Joel Cunningham, Garmin International, Inc. <[email protected]>
13*10465441SEvalZero * All rights reserved.
14*10465441SEvalZero *
15*10465441SEvalZero * Redistribution and use in source and binary forms, with or without modification,
16*10465441SEvalZero * are permitted provided that the following conditions are met:
17*10465441SEvalZero *
18*10465441SEvalZero * 1. Redistributions of source code must retain the above copyright notice,
19*10465441SEvalZero * this list of conditions and the following disclaimer.
20*10465441SEvalZero * 2. Redistributions in binary form must reproduce the above copyright notice,
21*10465441SEvalZero * this list of conditions and the following disclaimer in the documentation
22*10465441SEvalZero * and/or other materials provided with the distribution.
23*10465441SEvalZero * 3. The name of the author may not be used to endorse or promote products
24*10465441SEvalZero * derived from this software without specific prior written permission.
25*10465441SEvalZero *
26*10465441SEvalZero * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
27*10465441SEvalZero * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
28*10465441SEvalZero * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
29*10465441SEvalZero * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30*10465441SEvalZero * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
31*10465441SEvalZero * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32*10465441SEvalZero * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33*10465441SEvalZero * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
34*10465441SEvalZero * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
35*10465441SEvalZero * OF SUCH DAMAGE.
36*10465441SEvalZero *
37*10465441SEvalZero * This file is part of the lwIP TCP/IP stack.
38*10465441SEvalZero *
39*10465441SEvalZero * Author: Joel Cunningham <[email protected]>
40*10465441SEvalZero *
41*10465441SEvalZero */
42*10465441SEvalZero #include "lwip/opt.h"
43*10465441SEvalZero
44*10465441SEvalZero #if LWIP_SOCKET
45*10465441SEvalZero
46*10465441SEvalZero #include "lwip/errno.h"
47*10465441SEvalZero #include "lwip/if_api.h"
48*10465441SEvalZero #include "lwip/netifapi.h"
49*10465441SEvalZero #include "lwip/priv/sockets_priv.h"
50*10465441SEvalZero
51*10465441SEvalZero /**
52*10465441SEvalZero * @ingroup if_api
53*10465441SEvalZero * Maps an interface index to its corresponding name.
54*10465441SEvalZero * @param ifindex interface index
55*10465441SEvalZero * @param ifname shall point to a buffer of at least {IF_NAMESIZE} bytes
56*10465441SEvalZero * @return If ifindex is an interface index, then the function shall return the
57*10465441SEvalZero * value supplied in ifname, which points to a buffer now containing the interface name.
58*10465441SEvalZero * Otherwise, the function shall return a NULL pointer.
59*10465441SEvalZero */
60*10465441SEvalZero char *
lwip_if_indextoname(unsigned int ifindex,char * ifname)61*10465441SEvalZero lwip_if_indextoname(unsigned int ifindex, char *ifname)
62*10465441SEvalZero {
63*10465441SEvalZero #if LWIP_NETIF_API
64*10465441SEvalZero if (ifindex <= 0xff) {
65*10465441SEvalZero err_t err = netifapi_netif_index_to_name((u8_t)ifindex, ifname);
66*10465441SEvalZero if (!err && ifname[0] != '\0') {
67*10465441SEvalZero return ifname;
68*10465441SEvalZero }
69*10465441SEvalZero }
70*10465441SEvalZero #else /* LWIP_NETIF_API */
71*10465441SEvalZero LWIP_UNUSED_ARG(ifindex);
72*10465441SEvalZero LWIP_UNUSED_ARG(ifname);
73*10465441SEvalZero #endif /* LWIP_NETIF_API */
74*10465441SEvalZero set_errno(ENXIO);
75*10465441SEvalZero return NULL;
76*10465441SEvalZero }
77*10465441SEvalZero
78*10465441SEvalZero /**
79*10465441SEvalZero * @ingroup if_api
80*10465441SEvalZero * Returs the interface index corresponding to name ifname.
81*10465441SEvalZero * @param ifname Interface name
82*10465441SEvalZero * @return The corresponding index if ifname is the name of an interface;
83*10465441SEvalZero * otherwise, zero.
84*10465441SEvalZero */
85*10465441SEvalZero unsigned int
lwip_if_nametoindex(const char * ifname)86*10465441SEvalZero lwip_if_nametoindex(const char *ifname)
87*10465441SEvalZero {
88*10465441SEvalZero #if LWIP_NETIF_API
89*10465441SEvalZero err_t err;
90*10465441SEvalZero u8_t idx;
91*10465441SEvalZero
92*10465441SEvalZero err = netifapi_netif_name_to_index(ifname, &idx);
93*10465441SEvalZero if (!err) {
94*10465441SEvalZero return idx;
95*10465441SEvalZero }
96*10465441SEvalZero #else /* LWIP_NETIF_API */
97*10465441SEvalZero LWIP_UNUSED_ARG(ifname);
98*10465441SEvalZero #endif /* LWIP_NETIF_API */
99*10465441SEvalZero return 0; /* invalid index */
100*10465441SEvalZero }
101*10465441SEvalZero
102*10465441SEvalZero #endif /* LWIP_SOCKET */
103