* drivers/net/netdev_upperhalf.c
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <debug.h>
#include <errno.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <nuttx/kmalloc.h>
#include <nuttx/kthread.h>
#include <nuttx/mutex.h>
#include <nuttx/mm/iob.h>
#include <nuttx/net/can.h>
#include <nuttx/net/net.h>
#include <nuttx/net/netdev_lowerhalf.h>
#include <nuttx/net/pkt.h>
#include <nuttx/net/vlan.h>
#include <nuttx/semaphore.h>
#include <nuttx/spinlock.h>
* Pre-processor Definitions
****************************************************************************/
#define NETDEV_TX_CONTINUE 1
#define NETDEV_THREAD_NAME_FMT "netdev-%s"
* Private Types
****************************************************************************/
#ifdef CONFIG_NET_VLAN
struct netdev_vlan_entry_s
{
FAR struct netdev_lowerhalf_s *dev;
uint16_t vid;
};
#endif
struct netdev_thread_s
{
pid_t tid;
sem_t sem;
sem_t sem_exit;
};
struct netdev_upperhalf_s
{
FAR struct netdev_lowerhalf_s *lower;
#if CONFIG_IOB_NCHAINS > 0
struct iob_queue_s txq;
#endif
#ifdef CONFIG_NET_VLAN
struct netdev_vlan_entry_s vlan[CONFIG_NET_VLAN_COUNT];
#endif
int txing;
union
{
struct netdev_thread_s thread[0];
struct work_s work[0];
};
};
* Private Function Prototypes
****************************************************************************/
static int netdev_upper_txavail(FAR struct net_driver_s *dev);
* Private Functions
****************************************************************************/
* Name: quota_is_valid
*
* Description:
* Check if the quota of the lower half is not too big.
*
****************************************************************************/
static bool quota_is_valid(FAR struct netdev_lowerhalf_s *lower)
{
int total = 0;
enum netpkt_type_e type;
for (type = NETPKT_TX; type < NETPKT_TYPENUM; type++)
{
total += netdev_lower_quota_load(lower, type);
}
if (total > NETPKT_BUFNUM)
{
nerr("ERROR: Too big quota when registering device: %d\n", total);
return false;
}
if (total > NETPKT_BUFNUM / 2)
{
nwarn("WARNING: The quota of the registering device may consume more "
"than half of the network buffers, which may hurt performance. "
"Please consider decreasing driver quota or increasing nIOB.\n");
}
return true;
}
* Name: netpkt_get
*
* Description:
* Wraps the d_iob of dev to a netpkt.
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
static FAR netpkt_t *netpkt_get(FAR struct net_driver_s *dev,
enum netpkt_type_e type)
{
FAR struct netdev_upperhalf_s *upper;
FAR netpkt_t *pkt;
DEBUGASSERT(dev && dev->d_iob);
upper = (FAR struct netdev_upperhalf_s *)dev->d_private;
pkt = dev->d_iob;
netdev_iob_clear(dev);
* cases will be limited by netdev_upper_can_tx and seldom reaches here.
*/
if (atomic_sub(&upper->lower->quota_ptr[type], 1) <= 0)
{
nwarn("WARNING: Allowing temperarily exceeding quota of %s.\n",
dev->d_ifname);
}
return pkt;
}
* Name: netpkt_put
*
* Description:
* Relay IOB to dev.
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
static void netpkt_put(FAR struct net_driver_s *dev, FAR netpkt_t *pkt,
enum netpkt_type_e type)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
DEBUGASSERT(dev && pkt);
atomic_add(&upper->lower->quota_ptr[type], 1);
netdev_iob_replace_l2(dev, pkt);
}
* Name: netdev_upper_alloc
*
* Description:
* Get the upper half of lower half structure, create one if not present.
*
****************************************************************************/
static FAR struct netdev_upperhalf_s *
netdev_upper_alloc(FAR struct netdev_lowerhalf_s *dev, size_t extra_size)
{
FAR struct netdev_upperhalf_s *upper;
DEBUGASSERT(dev != NULL && dev->netdev.d_private == NULL);
upper = kmm_zalloc(sizeof(struct netdev_upperhalf_s) + extra_size);
if (upper == NULL)
{
nerr("ERROR: Allocation failed\n");
return NULL;
}
upper->lower = dev;
dev->netdev.d_private = upper;
return upper;
}
* Name: netdev_upper_can_tx
*
* Description:
* Check if we allow tx on this device.
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
static inline bool netdev_upper_can_tx(FAR struct netdev_upperhalf_s *upper)
{
FAR struct netdev_lowerhalf_s *lower = upper->lower;
int quota = netdev_lower_quota_load(lower, NETPKT_TX);
if (quota <= 0 && lower->ops->reclaim)
{
lower->ops->reclaim(lower);
quota = netdev_lower_quota_load(lower, NETPKT_TX);
}
return quota > 0;
}
* Name: netdev_upper_txpoll
*
* Description:
* The transmitter is available, check if the network has any outgoing
* packets ready to send. This is a callback from devif_poll().
* devif_poll() may be called:
*
* 1. When the preceding TX packet send is complete
* 2. When the preceding TX packet send times out and the interface is
* reset
* 3. During normal TX polling
*
* Input Parameters:
* dev - Reference to the NuttX driver state structure
*
* Returned Value:
* Negated errno value - Error number that occurs.
* NETDEV_TX_CONTINUE - Driver can send more, continue the poll.
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
static int netdev_upper_txpoll(FAR struct net_driver_s *dev)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
FAR struct netdev_lowerhalf_s *lower = upper->lower;
FAR netpkt_t *pkt;
int ret;
DEBUGASSERT(dev->d_len > 0);
NETDEV_TXPACKETS(dev);
#ifdef CONFIG_NET_PKT
* who has protocl type of ETH_P_ALL
*/
pkt_loopback(dev);
#endif
pkt = netpkt_get(dev, NETPKT_TX);
if (netpkt_getdatalen(lower, pkt) > NETDEV_PKTSIZE(dev))
{
nerr("ERROR: Packet too long to send!\n");
ret = -EMSGSIZE;
}
else
{
ret = lower->ops->transmit(lower, pkt);
}
if (ret != OK)
{
* REVISIT: maybe store the pkt in upper half and retry later?
*/
NETDEV_TXERRORS(dev);
nerr("ERROR: Transmit failed: %d\n", ret);
netpkt_put(dev, pkt, NETPKT_TX);
return ret;
}
return NETDEV_TX_CONTINUE;
}
* Name: netdev_upper_tx
*
* Description:
* Do the actual transmission of packets, including pre-queued packets and
* packets from the network stack.
*
* Input Parameters:
* dev - Reference to the NuttX driver state structure
*
* Returned Value:
* Negated errno value - Error number that occurs.
* NETDEV_TX_CONTINUE - Driver can send more, continue the poll.
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
static int netdev_upper_tx(FAR struct net_driver_s *dev)
{
#if CONFIG_IOB_NCHAINS > 0
FAR struct netdev_upperhalf_s *upper = dev->d_private;
if (!IOB_QEMPTY(&upper->txq))
{
netdev_iob_replace_l2(dev, iob_remove_queue(&upper->txq));
return netdev_upper_txpoll(dev);
}
#endif
return devif_poll(dev, netdev_upper_txpoll);
}
* Name: netdev_upper_txavail_work
*
* Description:
* Perform an out-of-cycle tx poll on the worker thread.
*
* Input Parameters:
* upper - Reference to the upper half driver structure
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
static void netdev_upper_txavail_work(FAR struct netdev_upperhalf_s *upper)
{
FAR struct net_driver_s *dev = &upper->lower->netdev;
netdev_lock(dev);
if (IFF_IS_UP(dev->d_flags) && !upper->txing)
{
DEBUGASSERT(dev->d_buf == NULL);
upper->txing = true;
while (netdev_upper_can_tx(upper) &&
netdev_upper_tx(dev) == NETDEV_TX_CONTINUE);
upper->txing = false;
}
netdev_unlock(dev);
}
* Name: netdev_upper_queue_tx
*
* Description:
* Queue a TX packet to the upper half for sending later.
*
* Input Parameters:
* dev - Reference to the NuttX driver state structure
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
#if defined(CONFIG_NET_LOOPBACK) || defined(CONFIG_NET_ETHERNET) || \
defined(CONFIG_DRIVERS_IEEE80211) || defined(CONFIG_NET_MBIM)
static void netdev_upper_queue_tx(FAR struct net_driver_s *dev)
{
#if CONFIG_IOB_NCHAINS > 0
FAR struct netdev_upperhalf_s *upper = dev->d_private;
int ret;
if ((ret = iob_tryadd_queue(dev->d_iob, &upper->txq)) >= 0)
{
netdev_iob_clear(dev);
netdev_upper_txavail(dev);
}
else
{
nwarn("WARNING: Failed to queue TX packet, dropping: %d\n", ret);
}
#else
netdev_upper_txpoll(dev);
#endif
}
#endif
* Name: netdev_upper_vlan_dev
*
* Description:
* Get the VLAN device for the VID.
*
* Input Parameters:
* upper - Reference to the upper half driver structure
* vid - VLAN ID
*
* Returned Value:
* Reference to the network device structure, or NULL if not found.
*
****************************************************************************/
#ifdef CONFIG_NET_VLAN
static FAR struct netdev_lowerhalf_s *
netdev_upper_vlan_dev(FAR struct netdev_upperhalf_s *upper, uint16_t vid)
{
int i;
for (i = 0; i < CONFIG_NET_VLAN_COUNT; i++)
{
if (upper->vlan[i].vid == vid)
{
return upper->vlan[i].dev;
}
}
return NULL;
}
* Name: netdev_upper_vlan_foreach
*
* Description:
* Call the callback for each VLAN device.
*
* Input Parameters:
* upper - Reference to the upper half driver structure
* cb - The callback function
*
****************************************************************************/
static void
netdev_upper_vlan_foreach(FAR struct netdev_upperhalf_s *upper,
CODE void (*cb)(FAR struct netdev_lowerhalf_s *))
{
int i;
netdev_lock(&upper->lower->netdev);
for (i = 0; i < CONFIG_NET_VLAN_COUNT; i++)
{
if (upper->vlan[i].dev)
{
cb(upper->vlan[i].dev);
}
}
netdev_unlock(&upper->lower->netdev);
}
#endif
* Name: eth_input
*
* Description:
* Handle L2 packet input.
*
* Input Parameters:
* dev - Reference to the NuttX network driver state structure
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
#if defined(CONFIG_NET_LOOPBACK) || defined(CONFIG_NET_ETHERNET) || \
defined(CONFIG_DRIVERS_IEEE80211)
static void eth_input(FAR struct net_driver_s *dev)
{
FAR struct eth_hdr_s *eth_hdr = (FAR struct eth_hdr_s *)NETLLBUF;
#ifdef CONFIG_NET_VLAN
if (eth_hdr->type == HTONS(ETHERTYPE_VLAN))
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
FAR struct netdev_lowerhalf_s *vlan;
FAR struct eth_8021qhdr_s *vlan_hdr = NETLLBUF;
uint16_t vid = NTOHS(vlan_hdr->tci) & VLAN_VID_MASK;
vlan = netdev_upper_vlan_dev(upper, vid);
if (vlan)
{
* addresses 4 octets to the right, and then read the actual
* ethertype.
*/
netdev_lock(&vlan->netdev);
memmove((FAR uint8_t *)eth_hdr + 4, eth_hdr,
offsetof(struct eth_hdr_s, type));
netdev_iob_release(&vlan->netdev);
vlan->netdev.d_iob = iob_trimhead(dev->d_iob, 4);
vlan->netdev.d_len = dev->d_len - 4;
netdev_iob_clear(dev);
#ifdef CONFIG_NET_PKT
pkt_input(&vlan->netdev);
#endif
eth_input(&vlan->netdev);
netdev_unlock(&vlan->netdev);
}
else
{
ninfo("INFO: Dropped, unknown vlan id: %d\n", vid);
NETDEV_RXDROPPED(dev);
dev->d_len = 0;
}
}
else
#endif
#ifdef CONFIG_NET_IPv4
if (eth_hdr->type == HTONS(ETHTYPE_IP))
{
ninfo("IPv4 frame\n");
NETDEV_RXIPV4(dev);
ipv4_input(dev);
}
else
#endif
#ifdef CONFIG_NET_IPv6
if (eth_hdr->type == HTONS(ETHTYPE_IP6))
{
ninfo("IPv6 frame\n");
NETDEV_RXIPV6(dev);
ipv6_input(dev);
}
else
#endif
#ifdef CONFIG_NET_ARP
if (eth_hdr->type == HTONS(ETHTYPE_ARP))
{
ninfo("ARP frame\n");
NETDEV_RXARP(dev);
arp_input(dev);
}
else
#endif
{
ninfo("INFO: Dropped, Unknown type: %04x\n", eth_hdr->type);
NETDEV_RXDROPPED(dev);
dev->d_len = 0;
netdev_iob_release(dev);
}
* that should be sent out on the network,
* the field d_len will set to a value > 0.
*/
if (dev->d_len > 0)
{
* Note: RX is tried before TX, so we don't need to call txavail here.
*/
netdev_upper_queue_tx(dev);
}
}
#endif
* Name: ip_input
*
* Description:
* Handle L3 packet input.
*
* Input Parameters:
* dev - Reference to the NuttX network driver state structure
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
#ifdef CONFIG_NET_MBIM
static void ip_input(FAR struct net_driver_s *dev)
{
#ifdef CONFIG_NET_IPv4
if ((IPv4BUF->vhl & IP_VERSION_MASK) == IPv4_VERSION)
{
ninfo("IPv4 frame\n");
NETDEV_RXIPV4(dev);
ipv4_input(dev);
}
else
#endif
#ifdef CONFIG_NET_IPv6
if ((IPv6BUF->vtc & IP_VERSION_MASK) == IPv6_VERSION)
{
ninfo("IPv6 frame\n");
NETDEV_RXIPV6(dev);
ipv6_input(dev);
}
else
#endif
{
ninfo("INFO: Dropped, Unknown type\n");
NETDEV_RXDROPPED(dev);
dev->d_len = 0;
}
* that should be sent out on the network,
* the field d_len will set to a value > 0.
*/
if (dev->d_len > 0)
{
* Note: RX is tried before TX, so we don't need to call txavail here.
*/
netdev_upper_queue_tx(dev);
}
}
#endif
* Function: netdev_upper_rxpoll_work
*
* Description:
* Try to receive packets from device and pass packets into IP
* stack and send packets which is from IP stack if necessary.
*
* Input Parameters:
* upper - Reference to the upper half driver structure
*
* Assumptions:
* Called with the network locked.
*
****************************************************************************/
static void netdev_upper_rxpoll_work(FAR struct netdev_upperhalf_s *upper)
{
FAR struct netdev_lowerhalf_s *lower = upper->lower;
FAR struct net_driver_s *dev = &lower->netdev;
FAR netpkt_t *pkt;
netdev_lock(dev);
while ((pkt = lower->ops->receive(lower)) != NULL)
{
if (!IFF_IS_UP(dev->d_flags))
{
NETDEV_RXDROPPED(dev);
netpkt_free(lower, pkt, NETPKT_RX);
nerr("ERROR: Dropped frame due to lower dev not up\n");
continue;
}
netpkt_put(dev, pkt, NETPKT_RX);
NETDEV_RXPACKETS(dev);
#ifdef CONFIG_NET_PKT
pkt_input(dev);
#endif
switch (dev->d_lltype)
{
#ifdef CONFIG_NET_LOOPBACK
case NET_LL_LOOPBACK:
#endif
#ifdef CONFIG_NET_ETHERNET
case NET_LL_ETHERNET:
#endif
#ifdef CONFIG_DRIVERS_IEEE80211
case NET_LL_IEEE80211:
#endif
#if defined(CONFIG_NET_LOOPBACK) || defined(CONFIG_NET_ETHERNET) || \
defined(CONFIG_DRIVERS_IEEE80211)
eth_input(dev);
break;
#endif
#ifdef CONFIG_NET_MBIM
case NET_LL_MBIM:
ip_input(dev);
break;
#endif
#ifdef CONFIG_NET_CAN
case NET_LL_CAN:
ninfo("CAN frame");
can_input(dev);
break;
#endif
default:
nerr("Unknown link type %d\n", dev->d_lltype);
break;
}
}
netdev_unlock(dev);
}
* Name: netdev_upper_work
*
* Description:
* Perform an out-of-cycle poll on a dedicated thread or the worker thread.
*
* Input Parameters:
* arg - Reference to the upper half driver structure (cast to void *)
*
****************************************************************************/
static void netdev_upper_work(FAR void *arg)
{
FAR struct netdev_upperhalf_s *upper = arg;
#ifdef CONFIG_NET_VLAN
netdev_upper_vlan_foreach(upper, netdev_lower_txdone);
#endif
netdev_upper_rxpoll_work(upper);
netdev_upper_txavail_work(upper);
}
* Name: netdev_upper_loop
*
* Description:
* The loop for dedicated thread.
*
****************************************************************************/
static int netdev_upper_loop(int argc, FAR char *argv[])
{
FAR struct netdev_upperhalf_s *upper =
(FAR struct netdev_upperhalf_s *)((uintptr_t)strtoul(argv[1], NULL, 16));
int cpu = atoi(argv[2]);
FAR struct netdev_thread_s *t = &upper->thread[cpu];
if (upper->lower->rxtype == NETDEV_RX_THREAD_RSS)
{
cpu_set_t cpuset;
CPU_ZERO(&cpuset);
CPU_SET(cpu, &cpuset);
sched_setaffinity(t->tid, sizeof(cpu_set_t), &cpuset);
}
while (nxsem_wait(&t->sem) == OK && t->tid != INVALID_PROCESS_ID)
{
netdev_upper_work(upper);
}
nwarn("WARNING: Netdev work thread quitting.");
nxsem_post(&t->sem_exit);
return 0;
}
* Name: netdev_upper_queue_work
*
* Description:
* Called when there is any work to do.
*
* Input Parameters:
* dev - Reference to the NuttX driver state structure
*
****************************************************************************/
static inline void netdev_upper_queue_work(FAR struct net_driver_s *dev)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
int cpu = 0;
switch (upper->lower->rxtype)
{
case NETDEV_RX_WORK:
{
FAR struct work_s *work = upper->work;
if (work_available(work))
{
work_queue(upper->lower->priority, work, netdev_upper_work,
upper, 0);
}
}
break;
case NETDEV_RX_THREAD_RSS:
cpu = this_cpu();
case NETDEV_RX_THREAD:
{
FAR struct netdev_thread_s *t = &upper->thread[cpu];
int semcount;
if (nxsem_get_value(&t->sem, &semcount) == OK && semcount <= 0)
{
nxsem_post(&t->sem);
}
}
break;
}
}
* Name: netdev_upper_txavail
*
* Description:
* Called when new TX data is available.
*
* Input Parameters:
* dev - Reference to the NuttX driver state structure
*
****************************************************************************/
static int netdev_upper_txavail(FAR struct net_driver_s *dev)
{
netdev_upper_txavail_work(dev->d_private);
return OK;
}
* Name: netdev_upper_ethtool_ioctl
*
* Description:
* Handle upper layer ethtool IOCTL commands for a network device.
* This function processes ethtool-related IOCTL requests that are handled
* at the upper network layer, interacting with the specified network
* device.
*
* Input Parameters:
* dev - Pointer to the network driver structure (struct net_driver_s)
* representing the network device to operate on.
* arg - IOCTL command argument. The specific type and interpretation
* depend on the ethtool command being processed (e.g., may point to
* an struct ethtool_cmd or other ethtool-related data structure).
*
* Returned Value:
* On success, returns 0.
* On failure, returns a negative error code.
****************************************************************************/
#ifdef CONFIG_NETDEV_ETHTOOL_IOCTL
static int netdev_upper_ethtool_ioctl(FAR struct net_driver_s *dev,
unsigned long arg)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
FAR struct netdev_lowerhalf_s *lower = upper->lower;
uint32_t cmd = *(FAR const uint32_t *)arg;
int ret = -EOPNOTSUPP;
switch (cmd)
{
case ETHTOOL_GCHANNELS:
if (lower->eth_ops->get_channels)
{
ret = lower->eth_ops->get_channels(lower,
(FAR struct ethtool_chns *)arg);
}
break;
case ETHTOOL_SCHANNELS:
if (lower->eth_ops->set_channels)
{
ret = lower->eth_ops->set_channels(lower,
(FAR struct ethtool_chns *)arg);
}
break;
case ETHTOOL_GCHANNELS2:
if (lower->eth_ops->get_channels2)
{
ret = lower->eth_ops->get_channels2(lower,
(FAR struct ethtool_chns2 *)arg);
}
break;
case ETHTOOL_SCHANNELS2:
if (lower->eth_ops->set_channels2)
{
ret = lower->eth_ops->set_channels2(lower,
(FAR struct ethtool_chns2 *)arg);
}
break;
default:
ret = -ENOTTY;
nerr("ERROR: No such cmd in ethtool opt!");
break;
}
return ret;
}
#endif
* Name: netdev_upper_wireless_ioctl
*
* Description:
* Support for wireless handlers in ioctl.
*
****************************************************************************/
#ifdef CONFIG_NETDEV_WIRELESS_HANDLER
int netdev_upper_wireless_ioctl(FAR struct netdev_lowerhalf_s *lower,
int cmd, unsigned long arg)
{
int ret = -ENOTTY;
FAR struct iwreq *iwr = (FAR struct iwreq *)arg;
FAR const struct wireless_ops_s *ops = lower->iw_ops;
struct ether_addr zero;
switch (cmd)
{
case SIOCSIWENCODEEXT:
if (ops->passwd)
{
ret = ops->passwd(lower, iwr, true);
}
break;
case SIOCGIWENCODEEXT:
if (ops->passwd)
{
ret = ops->passwd(lower, iwr, false);
}
break;
case SIOCSIWESSID:
if (ops->essid)
{
if ((iwr->u.essid.flags == IW_ESSID_ON) ||
(iwr->u.essid.flags == IW_ESSID_DELAY_ON))
{
ret = ops->essid(lower, iwr, true);
if (ret < 0)
{
break;
}
if (iwr->u.essid.flags == IW_ESSID_ON)
{
ret = ops->connect(lower);
if (ret < 0)
{
nerr("ERROR: Failed to connect\n");
break;
}
}
}
else
{
ret = ops->disconnect(lower);
if (ret < 0)
{
nerr("ERROR: Failed to disconnect\n");
break;
}
}
}
break;
case SIOCGIWESSID:
if (ops->essid)
{
ret = ops->essid(lower, iwr, false);
}
break;
case SIOCSIWAP:
if (ops->bssid)
{
memset(&zero, 0, sizeof(zero));
if (memcmp(iwr->u.ap_addr.sa_data, &zero, sizeof(zero)) != 0)
{
ret = ops->bssid(lower, iwr, true);
if (ret < 0)
{
nerr("ERROR: Failed to set BSSID\n");
break;
}
ret = ops->connect(lower);
if (ret < 0)
{
nerr("ERROR: Failed to connect\n");
break;
}
}
else
{
ret = ops->disconnect(lower);
if (ret < 0)
{
nerr("ERROR: Failed to disconnect\n");
break;
}
}
}
break;
case SIOCGIWAP:
if (ops->bssid)
{
ret = ops->bssid(lower, iwr, false);
}
break;
case SIOCSIWSCAN:
if (ops->scan)
{
ret = ops->scan(lower, iwr, true);
}
break;
case SIOCGIWSCAN:
if (ops->scan)
{
ret = ops->scan(lower, iwr, false);
}
break;
case SIOCSIWCOUNTRY:
if (ops->country)
{
ret = ops->country(lower, iwr, true);
}
break;
case SIOCGIWCOUNTRY:
if (ops->country)
{
ret = ops->country(lower, iwr, false);
}
break;
case SIOCSIWSENS:
if (ops->sensitivity)
{
ret = ops->sensitivity(lower, iwr, true);
}
break;
case SIOCGIWSENS:
if (ops->sensitivity)
{
ret = ops->sensitivity(lower, iwr, false);
}
break;
case SIOCSIWMODE:
if (ops->mode)
{
ret = ops->mode(lower, iwr, true);
}
break;
case SIOCGIWMODE:
if (ops->mode)
{
ret = ops->mode(lower, iwr, false);
}
break;
case SIOCSIWAUTH:
if (ops->auth)
{
ret = ops->auth(lower, iwr, true);
}
break;
case SIOCGIWAUTH:
if (ops->auth)
{
ret = ops->auth(lower, iwr, false);
}
break;
case SIOCSIWFREQ:
if (ops->freq)
{
ret = ops->freq(lower, iwr, true);
}
break;
case SIOCGIWFREQ:
if (ops->freq)
{
ret = ops->freq(lower, iwr, false);
}
break;
case SIOCSIWRATE:
if (ops->bitrate)
{
ret = ops->bitrate(lower, iwr, true);
}
break;
case SIOCGIWRATE:
if (ops->bitrate)
{
ret = ops->bitrate(lower, iwr, false);
}
break;
case SIOCSIWTXPOW:
if (ops->txpower)
{
ret = ops->txpower(lower, iwr, true);
}
break;
case SIOCGIWTXPOW:
if (ops->txpower)
{
ret = ops->txpower(lower, iwr, false);
}
break;
case SIOCGIWRANGE:
if (ops->range)
{
ret = ops->range(lower, iwr);
}
break;
default:
nerr("ERROR: Unrecognized IOCTL command: %d\n", cmd);
break;
}
return ret;
}
#endif
* Name: netdev_upper_vlan_ioctl
*
* Description:
* Support for VLAN handlers in ioctl.
*
****************************************************************************/
#ifdef CONFIG_NET_VLAN
int netdev_upper_vlan_ioctl(FAR struct netdev_lowerhalf_s *lower,
int cmd, unsigned long arg)
{
FAR struct vlan_ioctl_args *args =
(FAR struct vlan_ioctl_args *)(uintptr_t)arg;
if (cmd != SIOCSIFVLAN && cmd != SIOCGIFVLAN)
{
return -ENOTTY;
}
switch (args->cmd)
{
case ADD_VLAN_CMD:
return vlan_register(lower, args->u.VID, args->vlan_qos);
case DEL_VLAN_CMD:
vlan_unregister(lower);
return OK;
}
return -ENOSYS;
}
#endif
* Name: netdev_upper_exit_thread
*
* Description:
* Exit the dedicated thread
*
****************************************************************************/
static void netdev_upper_exit_thread(FAR struct netdev_upperhalf_s *upper)
{
int cpu = 1;
switch (upper->lower->rxtype)
{
case NETDEV_RX_THREAD_RSS:
cpu = CONFIG_SMP_NCPUS;
case NETDEV_RX_THREAD:
while (--cpu >= 0)
{
FAR struct netdev_thread_s *t = &upper->thread[cpu];
if (t->tid >= 0)
{
t->tid = INVALID_PROCESS_ID;
nxsem_post(&t->sem);
nxsem_wait(&t->sem_exit);
}
}
break;
}
}
* Name: netdev_upper_ifup/ifdown/addmac/rmmac/ioctl
*
* Description:
* Called by net stack and relayed to lower half driver.
*
****************************************************************************/
static int netdev_upper_ifup(FAR struct net_driver_s *dev)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
int cpu = 1;
switch (upper->lower->rxtype)
{
case NETDEV_RX_THREAD_RSS:
cpu = CONFIG_SMP_NCPUS;
case NETDEV_RX_THREAD:
while (--cpu >= 0)
{
FAR struct netdev_thread_s *t = &upper->thread[cpu];
FAR char *argv[3];
char arg1[32];
char arg2[32];
char name[32];
snprintf(arg1, sizeof(arg1), "%p", upper);
argv[0] = arg1;
snprintf(arg2, sizeof(arg2), "%d", cpu);
argv[1] = arg2;
argv[2] = NULL;
snprintf(name, sizeof(name), NETDEV_THREAD_NAME_FMT,
dev->d_ifname);
t->tid = kthread_create(name, upper->lower->priority,
CONFIG_DEFAULT_TASK_STACKSIZE,
netdev_upper_loop, argv);
if (t->tid < 0)
{
netdev_upper_exit_thread(upper);
return t->tid;
}
}
break;
}
if (upper->lower->ops->ifup)
{
return upper->lower->ops->ifup(upper->lower);
}
return -ENOSYS;
}
static int netdev_upper_ifdown(FAR struct net_driver_s *dev)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
switch (upper->lower->rxtype)
{
case NETDEV_RX_WORK:
work_cancel_sync(upper->lower->priority, upper->work);
break;
case NETDEV_RX_THREAD:
case NETDEV_RX_THREAD_RSS:
netdev_upper_exit_thread(upper);
break;
}
if (upper->lower->ops->ifdown)
{
return upper->lower->ops->ifdown(upper->lower);
}
return -ENOSYS;
}
#ifdef CONFIG_NET_MCASTGROUP
static int netdev_upper_addmac(FAR struct net_driver_s *dev,
FAR const uint8_t *mac)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
if (upper->lower->ops->addmac)
{
return upper->lower->ops->addmac(upper->lower, mac);
}
return -ENOSYS;
}
#endif
#ifdef CONFIG_NET_MCASTGROUP
static int netdev_upper_rmmac(FAR struct net_driver_s *dev,
FAR const uint8_t *mac)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
if (upper->lower->ops->rmmac)
{
return upper->lower->ops->rmmac(upper->lower, mac);
}
return -ENOSYS;
}
#endif
#ifdef CONFIG_NETDEV_IOCTL
static int netdev_upper_ioctl(FAR struct net_driver_s *dev, int cmd,
unsigned long arg)
{
FAR struct netdev_upperhalf_s *upper = dev->d_private;
FAR struct netdev_lowerhalf_s *lower = upper->lower;
int ret = -ENOTTY;
#ifdef CONFIG_NETDEV_ETHTOOL_IOCTL
if (cmd == SIOCETHTOOL && lower->eth_ops)
{
return netdev_upper_ethtool_ioctl(dev, arg);
}
#endif
#ifdef CONFIG_NETDEV_WIRELESS_HANDLER
if (lower->iw_ops)
{
ret = netdev_upper_wireless_ioctl(lower, cmd, arg);
if (ret != -ENOTTY)
{
return ret;
}
}
#endif
#ifdef CONFIG_NET_VLAN
ret = netdev_upper_vlan_ioctl(lower, cmd, arg);
if (ret != -ENOTTY)
{
return ret;
}
#endif
if (lower->ops->ioctl)
{
return lower->ops->ioctl(lower, cmd, arg);
}
return ret;
}
#endif
* Public Functions
****************************************************************************/
* Name: netdev_lower_register
*
* Description:
* Register a network device driver and assign a name to it so that it can
* be found in subsequent network ioctl operations on the device.
*
* Input Parameters:
* dev - The lower half device driver structure to be registered.
* lltype - Link level protocol used by the driver (Ethernet, SLIP, TUN,
* ...
*
* Returned Value:
* 0:Success; negated errno on failure.
*
****************************************************************************/
int netdev_lower_register(FAR struct netdev_lowerhalf_s *dev,
enum net_lltype_e lltype)
{
FAR struct netdev_upperhalf_s *upper;
size_t extra_size;
int cpu = 0;
int ret;
if (dev == NULL || dev->ops == NULL ||
dev->ops->transmit == NULL || dev->ops->receive == NULL)
{
nerr("ERROR: Invalid lower half device\n");
return -EINVAL;
}
if (dev->quota_ptr == NULL)
{
dev->quota_ptr = dev->quota;
}
if (quota_is_valid(dev) == false)
{
return -EINVAL;
}
switch (dev->rxtype)
{
case NETDEV_RX_WORK:
extra_size = sizeof(struct work_s);
break;
case NETDEV_RX_DIRECT:
extra_size = 0;
break;
case NETDEV_RX_THREAD:
extra_size = sizeof(struct netdev_thread_s);
cpu = 1;
break;
case NETDEV_RX_THREAD_RSS:
extra_size = sizeof(struct netdev_thread_s) * CONFIG_SMP_NCPUS;
cpu = CONFIG_SMP_NCPUS;
break;
default:
nerr("ERROR: Unrecognized device rxtype: %d\n", dev->rxtype);
return -EINVAL;
}
if ((upper = netdev_upper_alloc(dev, extra_size)) == NULL)
{
return -ENOMEM;
}
upper->txing = false;
dev->netdev.d_ifup = netdev_upper_ifup;
dev->netdev.d_ifdown = netdev_upper_ifdown;
dev->netdev.d_txavail = netdev_upper_txavail;
#ifdef CONFIG_NET_MCASTGROUP
dev->netdev.d_addmac = netdev_upper_addmac;
dev->netdev.d_rmmac = netdev_upper_rmmac;
#endif
#ifdef CONFIG_NETDEV_IOCTL
dev->netdev.d_ioctl = netdev_upper_ioctl;
#endif
dev->netdev.d_private = upper;
ret = netdev_register(&dev->netdev, lltype);
if (ret < 0)
{
nerr("ERROR: Netdev_register failed: %d\n", ret);
kmm_free(upper);
dev->netdev.d_private = NULL;
}
while (--cpu >= 0)
{
FAR struct netdev_thread_s *t = &upper->thread[cpu];
t->tid = INVALID_PROCESS_ID;
nxsem_init(&t->sem, 0, 0);
nxsem_init(&t->sem_exit, 0, 0);
}
return ret;
}
* Name: netdev_lower_unregister
*
* Description:
* Unregister a network device driver.
*
* Input Parameters:
* dev - The lower half device driver structure to un-register
*
* Returned Value:
* 0:Success; negated errno on failure
*
****************************************************************************/
int netdev_lower_unregister(FAR struct netdev_lowerhalf_s *dev)
{
FAR struct netdev_upperhalf_s *upper;
int cpu = 1;
int ret;
if (dev == NULL || dev->netdev.d_private == NULL)
{
nerr("ERROR: Invalid lower half device\n");
return -EINVAL;
}
upper = (FAR struct netdev_upperhalf_s *)dev->netdev.d_private;
#ifdef CONFIG_NET_VLAN
netdev_upper_vlan_foreach(upper, vlan_unregister);
#endif
ret = netdev_unregister(&dev->netdev);
if (ret < 0)
{
return ret;
}
switch (dev->rxtype)
{
case NETDEV_RX_THREAD_RSS:
cpu = CONFIG_SMP_NCPUS;
case NETDEV_RX_THREAD:
netdev_upper_exit_thread(upper);
while (--cpu >= 0)
{
FAR struct netdev_thread_s *t = &upper->thread[cpu];
nxsem_destroy(&t->sem);
nxsem_destroy(&t->sem_exit);
}
break;
}
#if CONFIG_IOB_NCHAINS > 0
iob_free_queue(&upper->txq);
#endif
kmm_free(upper);
dev->netdev.d_private = NULL;
return OK;
}
* Name: netdev_lower_carrier_on
*
* Description:
* Notifies the networking layer about an available carrier.
* (e.g. a cable was plugged in)
*
* Input Parameters:
* dev - The lower half device driver structure
*
****************************************************************************/
void netdev_lower_carrier_on(FAR struct netdev_lowerhalf_s *dev)
{
#ifdef CONFIG_NET_VLAN
FAR struct netdev_upperhalf_s *upper = dev->netdev.d_private;
netdev_upper_vlan_foreach(upper, netdev_lower_carrier_on);
#endif
netdev_lock(&dev->netdev);
netdev_carrier_on(&dev->netdev);
netdev_unlock(&dev->netdev);
}
* Name: netdev_lower_carrier_off
*
* Description:
* Notifies the networking layer about an disappeared carrier.
* (e.g. a cable was unplugged)
*
* Input Parameters:
* dev - The lower half device driver structure
*
****************************************************************************/
void netdev_lower_carrier_off(FAR struct netdev_lowerhalf_s *dev)
{
#ifdef CONFIG_NET_VLAN
FAR struct netdev_upperhalf_s *upper = dev->netdev.d_private;
netdev_upper_vlan_foreach(upper, netdev_lower_carrier_off);
#endif
netdev_lock(&dev->netdev);
netdev_carrier_off(&dev->netdev);
netdev_unlock(&dev->netdev);
}
* Name: netdev_lower_rxready
*
* Description:
* Notifies the networking layer about an RX packet is ready to read.
*
* Input Parameters:
* dev - The lower half device driver structure
*
****************************************************************************/
void netdev_lower_rxready(FAR struct netdev_lowerhalf_s *dev)
{
* in eth_input.
*/
if (dev->rxtype == NETDEV_RX_DIRECT)
{
netdev_upper_rxpoll_work(dev->netdev.d_private);
}
else
{
netdev_upper_queue_work(&dev->netdev);
}
}
* Name: netdev_lower_txdone
*
* Description:
* Notifies the networking layer about a TX packet is sent.
*
* Input Parameters:
* dev - The lower half device driver structure
*
****************************************************************************/
void netdev_lower_txdone(FAR struct netdev_lowerhalf_s *dev)
{
if (dev->rxtype == NETDEV_RX_DIRECT)
{
#ifdef CONFIG_NET_VLAN
FAR struct netdev_upperhalf_s *upper = dev->netdev.d_private;
netdev_upper_vlan_foreach(upper, netdev_lower_txdone);
#endif
netdev_upper_txavail_work(dev->netdev.d_private);
}
else
{
netdev_upper_queue_work(&dev->netdev);
}
NETDEV_TXDONE(&dev->netdev);
}
* Name: netdev_lower_quota_load
*
* Description:
* Fetch the quota, works like atomic_read.
*
* Input Parameters:
* dev - The lower half device driver structure
* type - Whether get quota for TX or RX
*
****************************************************************************/
int netdev_lower_quota_load(FAR struct netdev_lowerhalf_s *dev,
enum netpkt_type_e type)
{
return atomic_read(&dev->quota_ptr[type]);
}
* Name: netdev_lower_vlan_add
*
* Description:
* Add a VLAN device to the network device.
*
* Input Parameters:
* dev - The lower half device driver structure
* vid - VLAN ID
* vlan - The VLAN device to add
*
* Returned Value:
* 0:Success; negated errno on failure
*
****************************************************************************/
#ifdef CONFIG_NET_VLAN
int netdev_lower_vlan_add(FAR struct netdev_lowerhalf_s *dev, uint16_t vid,
FAR struct netdev_lowerhalf_s *vlan)
{
FAR struct netdev_upperhalf_s *upper = dev->netdev.d_private;
FAR struct netdev_vlan_entry_s *entry = NULL;
int i;
for (i = 0; i < CONFIG_NET_VLAN_COUNT; i++)
{
if (upper->vlan[i].vid == vid)
{
return -EEXIST;
}
if (upper->vlan[i].vid == 0 && entry == NULL)
{
entry = &upper->vlan[i];
}
}
if (entry)
{
entry->vid = vid;
entry->dev = vlan;
return OK;
}
return -ENOMEM;
}
* Name: netdev_lower_vlan_del
*
* Description:
* Delete a VLAN device from the network device.
*
* Input Parameters:
* dev - The lower half device driver structure
* vid - VLAN ID
*
* Returned Value:
* 0:Success; negated errno on failure
*
****************************************************************************/
int netdev_lower_vlan_del(FAR struct netdev_lowerhalf_s *dev, uint16_t vid)
{
FAR struct netdev_upperhalf_s *upper = dev->netdev.d_private;
int i;
for (i = 0; i < CONFIG_NET_VLAN_COUNT; i++)
{
if (upper->vlan[i].vid == vid)
{
upper->vlan[i].vid = 0;
upper->vlan[i].dev = NULL;
return OK;
}
}
return -ENOENT;
}
#endif
* Name: netpkt_alloc
*
* Description:
* Allocate a netpkt structure.
*
* Input Parameters:
* dev - The lower half device driver structure
* type - Whether used for TX or RX
*
* Returned Value:
* Pointer to the packet, NULL on failure
*
****************************************************************************/
FAR netpkt_t *netpkt_alloc(FAR struct netdev_lowerhalf_s *dev,
enum netpkt_type_e type)
{
FAR netpkt_t *pkt;
if (atomic_sub(&dev->quota_ptr[type], 1) <= 0)
{
atomic_add(&dev->quota_ptr[type], 1);
return NULL;
}
#ifdef CONFIG_NET_CAN
if (dev->netdev.d_lltype == NET_LL_CAN)
{
pkt = can_iob_timedalloc(0);
}
else
#endif
{
pkt = iob_tryalloc(false);
}
if (pkt == NULL)
{
atomic_add(&dev->quota_ptr[type], 1);
return NULL;
}
iob_reserve(pkt, CONFIG_NET_LL_GUARDSIZE);
return pkt;
}
* Name: netpkt_free
*
* Description:
* Release a netpkt structure.
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The packet to release
* type - Whether used for TX or RX
*
****************************************************************************/
void netpkt_free(FAR struct netdev_lowerhalf_s *dev, FAR netpkt_t *pkt,
enum netpkt_type_e type)
{
atomic_add(&dev->quota_ptr[type], 1);
iob_free_chain(pkt);
}
* Name: netpkt_copyin
*
* Description:
* Copy 'len' bytes of data from a buffer into the netpkt, starting at
* 'offset' of netpkt.
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The net packet
* src - The source buffer
* len - How many bytes to copy
* offset - The offset of netpkt to put the data
*
* Returned Value:
* 0:Success; negated errno on failure
*
****************************************************************************/
int netpkt_copyin(FAR struct netdev_lowerhalf_s *dev, FAR netpkt_t *pkt,
FAR const uint8_t *src, unsigned int len, int offset)
{
return iob_trycopyin(pkt, src, len,
offset - NET_LL_HDRLEN(&dev->netdev), false);
}
* Name: netpkt_copyout
*
* Description:
* Copy 'len' bytes of data from netpkt into a buffer, starting at
* 'offset' of netpkt.
*
* Input Parameters:
* dev - The lower half device driver structure
* dest - The destination buffer
* pkt - The net packet
* len - How many bytes to copy
* offset - The offset of netpkt to get the data
*
* Returned Value:
* 0:Success; negated errno on failure
*
****************************************************************************/
int netpkt_copyout(FAR struct netdev_lowerhalf_s *dev, FAR uint8_t *dest,
FAR const netpkt_t *pkt, unsigned int len, int offset)
{
return iob_copyout(dest, pkt, len, offset - NET_LL_HDRLEN(&dev->netdev));
}
* Name: netpkt_getdata/getbase
*
* Description:
* Get the pointer of data/base in a netpkt, used when NETPKT_BUFLEN is
* big enough to fit a full packet in.
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The net packet
*
* Returned Value:
* Pointer data/base, NULL on failure.
*
****************************************************************************/
FAR uint8_t *netpkt_getdata(FAR struct netdev_lowerhalf_s *dev,
FAR netpkt_t *pkt)
{
return IOB_DATA(pkt) - NET_LL_HDRLEN(&dev->netdev);
}
FAR uint8_t *netpkt_getbase(FAR netpkt_t *pkt)
{
return pkt->io_data;
}
* Name: netpkt_setdatalen
*
* Description:
* Set the length of data in netpkt, used when data is written into
* netpkt by data/base pointer, no need to set this length after
* copyin.
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The net packet
* len - The length of data in netpkt
*
* Returned Value:
* The new effective data length, or a negated errno value on error.
*
****************************************************************************/
int netpkt_setdatalen(FAR struct netdev_lowerhalf_s *dev,
FAR netpkt_t *pkt, unsigned int len)
{
uint8_t llhdrlen = NET_LL_HDRLEN(&dev->netdev);
int ret = iob_update_pktlen(pkt, len - llhdrlen, false);
return ret >= 0 ? ret + llhdrlen : ret;
}
* Name: netpkt_getdatalen
*
* Description:
* Get the length of data in netpkt.
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The net packet
*
* Returned Value:
* The length of data in netpkt.
*
****************************************************************************/
unsigned int netpkt_getdatalen(FAR struct netdev_lowerhalf_s *dev,
FAR netpkt_t *pkt)
{
return pkt->io_pktlen + NET_LL_HDRLEN(&dev->netdev);
}
* Name: netpkt_reset_reserved
*
* Description:
* Reset the reserved length (the starting point of data) of netpkt
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The net packet
* len - The reserved length
*
****************************************************************************/
void netpkt_reset_reserved(FAR struct netdev_lowerhalf_s *dev,
FAR netpkt_t *pkt, unsigned int len)
{
iob_reserve(pkt, len + NET_LL_HDRLEN(&dev->netdev));
}
* Name: netpkt_realloc_reserved
*
* Description:
* Reallocate the reserved length of netpkt
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The net packet
* len - The reserved length
*
* Returned Value:
* Pointer to the new netpkt, NULL on failure
*
****************************************************************************/
FAR netpkt_t *netpkt_realloc_reserved(FAR struct netdev_lowerhalf_s *dev,
FAR netpkt_t *pkt, unsigned int len)
{
FAR netpkt_t *newpkt = iob_tryalloc(false);
int llhdrlen = NET_LL_HDRLEN(&dev->netdev);
int reserved = MAX(CONFIG_NET_LL_GUARDSIZE, len + llhdrlen);
if (newpkt == NULL)
{
return NULL;
}
iob_reserve(newpkt, reserved);
if (iob_clone_partial(pkt, pkt->io_pktlen + llhdrlen, -llhdrlen,
newpkt, -llhdrlen, false, false) < 0)
{
iob_free_chain(newpkt);
return NULL;
}
iob_free_chain(pkt);
return newpkt;
}
* Name: netpkt_is_fragmented
*
* Description:
* Returns whether the netpkt is fragmented into different blocks.
* In other words, NETPKT_BUFLEN < reserved + total data
*
* Input Parameters:
* pkt - The net packet
*
****************************************************************************/
bool netpkt_is_fragmented(FAR netpkt_t *pkt)
{
return pkt->io_flink != NULL;
}
* Name: netpkt_to_iov
*
* Description:
* Write each piece of data/len into iov array.
*
* Input Parameters:
* dev - The lower half device driver structure
* pkt - The net packet
* iov - The iov array to write
* iovcnt - The number of elements in the iov array
*
* Returned Value:
* The actual written count of iov entries.
*
****************************************************************************/
int netpkt_to_iov(FAR struct netdev_lowerhalf_s *dev, FAR netpkt_t *pkt,
FAR struct iovec *iov, int iovcnt)
{
int i;
for (i = 0; pkt != NULL && i < iovcnt; pkt = pkt->io_flink, i++)
{
if (i == 0)
{
iov[i].iov_base = IOB_DATA(pkt) - NET_LL_HDRLEN(&dev->netdev);
iov[i].iov_len = pkt->io_len + NET_LL_HDRLEN(&dev->netdev);
}
else
{
iov[i].iov_base = IOB_DATA(pkt);
iov[i].iov_len = pkt->io_len;
}
}
return i;
}