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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
|
/****************************************************************************
* net/netdev/netdev_ioctl.c
*
* Copyright (C) 2007-2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#if defined(CONFIG_NET) && CONFIG_NSOCKET_DESCRIPTORS > 0
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/net/net.h>
#include <nuttx/net/ip.h>
#include <net/if.h>
#include <net/route.h>
#include <net/ethernet.h>
#include <netinet/in.h>
#include <nuttx/net/netdev.h>
#ifdef CONFIG_NET_IGMP
# include "sys/sockio.h"
# include "nuttx/net/igmp.h"
#endif
#include "socket/socket.h"
#include "netdev/netdev.h"
#include "igmp/igmp.h"
#include "route/route.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#ifdef CONFIG_NET_IPv6
# define AF_INETX AF_INET6
#else
# define AF_INETX AF_INET
#endif
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: ioctl_getipaddr
*
* Description:
* Copy IP addresses from device structure to user memory.
*
* Input Parameters:
* outaddr - Pointer to the user-provided memory to receive the address.
* Actual type may be either 'struct sockaddr' (IPv4 only) or type
* 'struct sockaddr_storage' (both IPv4 and IPv6).
* inaddr - The source IP adress in the device structure.
*
****************************************************************************/
static void ioctl_getipaddr(FAR void *outaddr, FAR const net_ipaddr_t *inaddr)
{
#ifdef CONFIG_NET_IPv6
FAR struct sockaddr_in6 *dest = (FAR struct sockaddr_in6 *)outaddr;
dest->sin_family = AF_INET6;
dest->sin_port = 0;
memcpy(dest->sin6_addr.in6_u.u6_addr8, inaddr, 16);
#else
FAR struct sockaddr_in *dest = (FAR struct sockaddr_in *)outaddr;
dest->sin_family = AF_INET;
dest->sin_port = 0;
dest->sin_addr.s_addr = *inaddr;
#endif
}
/****************************************************************************
* Name: ioctl_setipaddr
*
* Description:
* Copy IP addresses from user memory into the device structure
*
* Input Parameters:
* outaddr - Pointer to the source IP address in the device structure.
* inaddr - Pointer to the user-provided memory to containing the new IP
* address. Actual type may be either 'struct sockaddr' (IPv4 only) or
* type 'struct sockaddr_storage' (both IPv4 and IPv6).
*
****************************************************************************/
static void ioctl_setipaddr(FAR net_ipaddr_t *outaddr, FAR const void *inaddr)
{
#ifdef CONFIG_NET_IPv6
FAR const struct sockaddr_in6 *src = (FAR const struct sockaddr_in6 *)inaddr;
memcpy(outaddr, src->sin6_addr.in6_u.u6_addr8, 16);
#else
FAR const struct sockaddr_in *src = (FAR const struct sockaddr_in *)inaddr;
*outaddr = src->sin_addr.s_addr;
#endif
}
/****************************************************************************
* Name: ioctl_ifup / ioctl_ifdown
*
* Description:
* Bring the interface up/down
*
****************************************************************************/
static void ioctl_ifup(FAR struct net_driver_s *dev)
{
/* Make sure that the device supports the d_ifup() method */
if (dev->d_ifup)
{
/* Is the interface already up? */
if ((dev->d_flags & IFF_UP) == 0)
{
/* No, bring the interface up now */
if (dev->d_ifup(dev) == OK)
{
/* Mark the interface as up */
dev->d_flags |= IFF_UP;
}
}
}
}
static void ioctl_ifdown(FAR struct net_driver_s *dev)
{
/* Make sure that the device supports the d_ifdown() method */
if (dev->d_ifdown)
{
/* Is the interface already down? */
if ((dev->d_flags & IFF_UP) != 0)
{
/* No, take the interface down now */
if (dev->d_ifdown(dev) == OK)
{
/* Mark the interface as down */
dev->d_flags &= ~IFF_UP;
}
}
}
}
/****************************************************************************
* Name: netdev_ifrdev
*
* Description:
* Verify the struct ifreq and get the Ethernet device.
*
* Parameters:
* req - The argument of the ioctl cmd
*
* Return:
* A pointer to the driver structure on success; NULL on failure.
*
****************************************************************************/
static FAR struct net_driver_s *netdev_ifrdev(FAR struct ifreq *req)
{
if (!req)
{
return NULL;
}
/* Find the network device associated with the device name
* in the request data.
*/
return netdev_findbyname(req->ifr_name);
}
/****************************************************************************
* Name: netdev_ifrioctl
*
* Description:
* Perform network device specific operations.
*
* Parameters:
* psock Socket structure
* dev Ethernet driver device structure
* cmd The ioctl command
* req The argument of the ioctl cmd
*
* Return:
* >=0 on success (positive non-zero values are cmd-specific)
* Negated errno returned on failure.
*
****************************************************************************/
static int netdev_ifrioctl(FAR struct socket *psock, int cmd,
FAR struct ifreq *req)
{
FAR struct net_driver_s *dev;
int ret = -EINVAL;
nvdbg("cmd: %d\n", cmd);
/* Execute the command */
switch (cmd)
{
case SIOCGIFADDR: /* Get IP address */
{
dev = netdev_ifrdev(req);
if (dev)
{
ioctl_getipaddr(&req->ifr_addr, &dev->d_ipaddr);
ret = OK;
}
}
break;
case SIOCSIFADDR: /* Set IP address */
{
dev = netdev_ifrdev(req);
if (dev)
{
ioctl_ifdown(dev);
ioctl_setipaddr(&dev->d_ipaddr, &req->ifr_addr);
ioctl_ifup(dev);
ret = OK;
}
}
break;
case SIOCGIFDSTADDR: /* Get P-to-P address */
{
dev = netdev_ifrdev(req);
if (dev)
{
ioctl_getipaddr(&req->ifr_dstaddr, &dev->d_draddr);
ret = OK;
}
}
break;
case SIOCSIFDSTADDR: /* Set P-to-P address */
{
dev = netdev_ifrdev(req);
if (dev)
{
ioctl_setipaddr(&dev->d_draddr, &req->ifr_dstaddr);
ret = OK;
}
}
break;
case SIOCGIFNETMASK: /* Get network mask */
{
dev = netdev_ifrdev(req);
if (dev)
{
ioctl_getipaddr(&req->ifr_addr, &dev->d_netmask);
ret = OK;
}
}
break;
case SIOCSIFNETMASK: /* Set network mask */
{
dev = netdev_ifrdev(req);
if (dev)
{
ioctl_setipaddr(&dev->d_netmask, &req->ifr_addr);
ret = OK;
}
}
break;
case SIOCGIFMTU: /* Get MTU size */
{
req->ifr_mtu = CONFIG_NET_BUFSIZE;
ret = OK;
}
break;
case SIOCSIFFLAGS: /* Sets the interface flags */
{
/* Is this a request to bring the interface up? */
dev = netdev_ifrdev(req);
if (dev)
{
if (req->ifr_flags & IFF_UP)
{
/* Yes.. bring the interface up */
ioctl_ifup(dev);
}
/* Is this a request to take the interface down? */
else if (req->ifr_flags & IFF_DOWN)
{
/* Yes.. take the interface down */
ioctl_ifdown(dev);
}
}
ret = OK;
}
break;
case SIOCGIFFLAGS: /* Gets the interface flags */
{
dev = netdev_ifrdev(req);
if (dev)
{
req->ifr_flags = dev->d_flags;
}
ret = OK;
}
break;
/* MAC address operations only make sense if Ethernet is supported */
#ifdef CONFIG_NET_ETHERNET
case SIOCGIFHWADDR: /* Get hardware address */
{
dev = netdev_ifrdev(req);
if (dev)
{
req->ifr_hwaddr.sa_family = AF_INETX;
memcpy(req->ifr_hwaddr.sa_data,
dev->d_mac.ether_addr_octet, IFHWADDRLEN);
ret = OK;
}
}
break;
case SIOCSIFHWADDR: /* Set hardware address -- will not take effect until ifup */
{
dev = netdev_ifrdev(req);
if (dev)
{
req->ifr_hwaddr.sa_family = AF_INETX;
memcpy(dev->d_mac.ether_addr_octet,
req->ifr_hwaddr.sa_data, IFHWADDRLEN);
ret = OK;
}
}
break;
#endif
case SIOCDIFADDR: /* Delete IP address */
{
dev = netdev_ifrdev(req);
if (dev)
{
ioctl_ifdown(dev);
memset(&dev->d_ipaddr, 0, sizeof(net_ipaddr_t));
ret = OK;
}
}
break;
case SIOCGIFCOUNT: /* Get number of devices */
{
req->ifr_count = netdev_count();
ret = -ENOSYS;
}
break;
case SIOCGIFBRDADDR: /* Get broadcast IP address */
case SIOCSIFBRDADDR: /* Set broadcast IP address */
{
ret = -ENOSYS;
}
break;
#ifdef CONFIG_NET_ARPIOCTLS
case SIOCSARP: /* Set a ARP mapping */
case SIOCDARP: /* Delete an ARP mapping */
case SIOCGARP: /* Get an ARP mapping */
# error "IOCTL Commands not implemented"
#endif
#ifdef CONFIG_NETDEV_PHY_IOCTL
case SIOCGMIIPHY: /* Get address of MII PHY in use */
case SIOCGMIIREG: /* Get MII register via MDIO */
case SIOCSMIIREG: /* Set MII register via MDIO */
{
dev = netdev_ifrdev(req);
if (dev && dev->d_ioctl)
{
struct mii_ioctl_data_s *mii_data = &req->ifr_ifru.ifru_mii_data;
ret = dev->d_ioctl(dev, cmd, ((long)(uintptr_t)mii_data);
}
}
break;
#endif
default:
{
ret = -ENOTTY;
}
break;;
}
return ret;
}
/****************************************************************************
* Name: netdev_imsfdev
*
* Description:
* Verify the struct ip_msfilter and get the Ethernet device.
*
* Parameters:
* req - The argument of the ioctl cmd
*
* Return:
* A pointer to the driver structure on success; NULL on failure.
*
****************************************************************************/
#ifdef CONFIG_NET_IGMP
static FAR struct net_driver_s *netdev_imsfdev(FAR struct ip_msfilter *imsf)
{
if (!imsf)
{
return NULL;
}
/* Find the network device associated with the device name
* in the request data.
*/
return netdev_findbyname(imsf->imsf_name);
}
#endif
/****************************************************************************
* Name: netdev_imsfioctl
*
* Description:
* Perform network device specific operations.
*
* Parameters:
* psock Socket structure
* dev Ethernet driver device structure
* cmd The ioctl command
* imsf The argument of the ioctl cmd
*
* Return:
* >=0 on success (positive non-zero values are cmd-specific)
* Negated errno returned on failure.
*
****************************************************************************/
#ifdef CONFIG_NET_IGMP
static int netdev_imsfioctl(FAR struct socket *psock, int cmd,
FAR struct ip_msfilter *imsf)
{
FAR struct net_driver_s *dev;
int ret = -EINVAL;
nvdbg("cmd: %d\n", cmd);
/* Execute the command */
switch (cmd)
{
case SIOCSIPMSFILTER: /* Set source filter content */
{
dev = netdev_imsfdev(imsf);
if (dev)
{
if (imsf->imsf_fmode == MCAST_INCLUDE)
{
ret = igmp_joingroup(dev, &imsf->imsf_multiaddr);
}
else
{
DEBUGASSERT(imsf->imsf_fmode == MCAST_EXCLUDE);
ret = igmp_leavegroup(dev, &imsf->imsf_multiaddr);
}
}
}
break;
case SIOCGIPMSFILTER: /* Retrieve source filter addresses */
default:
ret = -ENOTTY;
break;
}
return ret;
}
#endif
/****************************************************************************
* Name: netdev_rtioctl
*
* Description:
* Perform routing table specific operations.
*
* Parameters:
* psock Socket structure
* dev Ethernet driver device structure
* cmd The ioctl command
* rtentry The argument of the ioctl cmd
*
* Return:
* >=0 on success (positive non-zero values are cmd-specific)
* Negated errno returned on failure.
*
****************************************************************************/
#ifdef CONFIG_NET_ROUTE
static int netdev_rtioctl(FAR struct socket *psock, int cmd,
FAR struct rtentry *rtentry)
{
int ret = -EINVAL;
/* Execute the command */
switch (cmd)
{
case SIOCADDRT: /* Add an entry to the routing table */
{
if (rtentry)
{
net_ipaddr_t target;
net_ipaddr_t netmask;
net_ipaddr_t router;
#ifdef CONFIG_NET_IPv6
FAR struct sockaddr_in6 *addr;
#else
FAR struct sockaddr_in *addr;
#endif
/* The target address and the netmask are required value */
if (!rtentry->rt_target || !rtentry->rt_netmask)
{
return -EINVAL;
}
#ifdef CONFIG_NET_IPv6
addr = (FAR struct sockaddr_in6 *)rtentry->rt_target;
target = (net_ipaddr_t)addr->sin6_addr.u6_addr16;
addr = (FAR struct sockaddr_in6 *)rtentry->rt_netmask;
netmask = (net_ipaddr_t)addr->sin6_addr.u6_addr16;
/* The router is an optional argument */
if (rtentry->rt_router)
{
addr = (FAR struct sockaddr_in6 *)rtentry->rt_router;
router = (net_ipaddr_t)addr->sin6_addr.u6_addr16;
}
else
{
router = NULL;
}
#else
addr = (FAR struct sockaddr_in *)rtentry->rt_target;
target = (net_ipaddr_t)addr->sin_addr.s_addr;
addr = (FAR struct sockaddr_in *)rtentry->rt_netmask;
netmask = (net_ipaddr_t)addr->sin_addr.s_addr;
/* The router is an optional argument */
if (rtentry->rt_router)
{
addr = (FAR struct sockaddr_in *)rtentry->rt_router;
router = (net_ipaddr_t)addr->sin_addr.s_addr;
}
else
{
router = 0;
}
#endif
ret = net_addroute(target, netmask, router);
}
}
break;
case SIOCDELRT: /* Delete an entry from the routing table */
{
if (rtentry)
{
net_ipaddr_t target;
net_ipaddr_t netmask;
#ifdef CONFIG_NET_IPv6
FAR struct sockaddr_in6 *addr;
#else
FAR struct sockaddr_in *addr;
#endif
/* The target address and the netmask are required value */
if (!rtentry->rt_target || !rtentry->rt_netmask)
{
return -EINVAL;
}
#ifdef CONFIG_NET_IPv6
addr = (FAR struct sockaddr_in6 *)rtentry->rt_target;
target = (net_ipaddr_t)addr->sin6_addr.u6_addr16;
addr = (FAR struct sockaddr_in6 *)rtentry->rt_netmask;
netmask = (net_ipaddr_t)addr->sin6_addr.u6_addr16;
#else
addr = (FAR struct sockaddr_in *)rtentry->rt_target;
target = (net_ipaddr_t)addr->sin_addr.s_addr;
addr = (FAR struct sockaddr_in *)rtentry->rt_netmask;
netmask = (net_ipaddr_t)addr->sin_addr.s_addr;
#endif
ret = net_delroute(target, netmask);
}
}
break;
default:
ret = -ENOTTY;
break;
}
return ret;
}
#endif
/****************************************************************************
* Global Functions
****************************************************************************/
/****************************************************************************
* Name: netdev_ioctl
*
* Description:
* Perform network device specific operations.
*
* Parameters:
* sockfd Socket descriptor of device
* cmd The ioctl command
* arg The argument of the ioctl cmd
*
* Return:
* >=0 on success (positive non-zero values are cmd-specific)
* On a failure, -1 is returned with errno set appropriately
*
* EBADF
* 'sockfd' is not a valid descriptor.
* EFAULT
* 'arg' references an inaccessible memory area.
* ENOTTY
* 'cmd' not valid.
* EINVAL
* 'arg' is not valid.
* ENOTTY
* 'sockfd' is not associated with a network device.
* ENOTTY
* The specified request does not apply to the kind of object that the
* descriptor 'sockfd' references.
*
****************************************************************************/
int netdev_ioctl(int sockfd, int cmd, unsigned long arg)
{
FAR struct socket *psock = sockfd_socket(sockfd);
int ret;
/* Check if this is a valid command. In all cases, arg is a pointer that has
* been cast to unsigned long. Verify that the value of the to-be-pointer is
* non-NULL.
*/
if (!_SIOCVALID(cmd))
{
ret = -ENOTTY;
goto errout;
}
/* Verify that the sockfd corresponds to valid, allocated socket */
if (!psock || psock->s_crefs <= 0)
{
ret = -EBADF;
goto errout;
}
/* Execute the command */
ret = netdev_ifrioctl(psock, cmd, (FAR struct ifreq*)((uintptr_t)arg));
#ifdef CONFIG_NET_IGMP
if (ret == -ENOTTY)
{
ret = netdev_imsfioctl(psock, cmd, (FAR struct ip_msfilter*)((uintptr_t)arg));
}
#endif
#ifdef CONFIG_NET_ROUTE
if (ret == -ENOTTY)
{
ret = netdev_rtioctl(psock, cmd, (FAR struct rtentry*)((uintptr_t)arg));
}
#endif
/* Check for success or failure */
if (ret >= 0)
{
return ret;
}
/* On failure, set the errno and return -1 */
errout:
errno = -ret;
return ERROR;
}
#endif /* CONFIG_NET && CONFIG_NSOCKET_DESCRIPTORS */
|