Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-09-06 00:52:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
nuttx/include/net/if.h
Jacob Dahl eb40eed248 arch/arm/src/imxrt: Unify FlexCAN TX work and add SIOCGCANERRORS. 
TX-complete and the deadline watchdog each queued their own callback on
the same work_s, and work_queue() cancels whatever is pending when a
work_s is reused, so whichever ran second was dropped: deadlines were
left set, the TX interrupt mask stayed off, or expired frames were never
aborted. Both now queue imxrt_tx_work(), which retires completions
before it aborts expired mailboxes.

Add SIOCGCANERRORS so a socket can read fault confinement, TEC/REC, a
monotonic bus error count and the RX mailbox overrun count. SIOCGCANSTATE
reports sleep/operational, not fault confinement, hence a new command.
The error count is sampled from the clear-on-read ESR1 error flags at
every driver entry rather than from ERRINT, which fires per error frame
and storms at bus rate once the bus is dead. Frames the CAN socket layer
drops for want of an IOB now count as rx_dropped in the netdev
statistics as well as in the global CAN statistics.

Tested on an i.MX RT1176 (ARK FMU-v6XRT) running PX4 with two DroneCAN
nodes: unplugging one node the ioctl reports error-passive, TEC 128,
REC 0 and a monotonic error count, matching ECR/ESR1 read over SWD at
20 Hz, while the other interface stays error-active with zero errors.

Assisted-by: Claude:claude-fable-5
Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com>
2026-09-01 17:40:47 +08:00

484 lines
20 KiB
C
Raw Blame History

/****************************************************************************
* include/net/if.h
*
* 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.
*
****************************************************************************/
#ifndef __INCLUDE_NET_IF_H
#define __INCLUDE_NET_IF_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <signal.h>
#include <sys/socket.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* If CONFIG_NETDEV_IFINDEX is enabled then there is limit to the number of
* devices that can be registered due to the nature of some static data.
*/
#define MAX_IFINDEX 32
/* Sizing parameters */
#define IFNAMSIZ 16 /* Older naming standard */
#define IF_NAMESIZE 16 /* Newer naming standard */
#define IFHWADDRLEN 6
/* Interface flag bits */
#define IFF_UP (1 << 1) /* Interface is up */
#define IFF_RUNNING (1 << 2) /* Carrier is available */
#define IFF_IPv6 (1 << 3) /* Configured for IPv6 packet (vs ARP or IPv4) */
#define IFF_LOOPBACK (1 << 5) /* Is a loopback net */
#define IFF_POINTOPOINT (1 << 6) /* Is point-to-point link */
#define IFF_NOARP (1 << 7) /* ARP is not required for this interface */
#define IFF_NAT (1 << 8) /* NAT is enabled for this interface */
#define IFF_SLAVE (1 << 11) /* Slave of a load balancer. */
#define IFF_MULTICAST (1 << 12) /* Supports multicast. */
#define IFF_BROADCAST (1 << 13) /* Broadcast address valid. */
#define IFF_DYNAMIC (1 << 15) /* Dialup device with changing addresses. */
#define IFF_DEBUG (1 << 16) /* Turn on debugging. */
#define IFF_NOTRAILERS (1 << 17) /* Avoid use of trailers. */
#define IFF_PROMISC (1 << 18) /* Receive all packets. */
#define IFF_ALLMULTI (1 << 19) /* Receive all multicast packets. */
#define IFF_NOSRC_FORWARD (1 << 20) /* Device prohibits forwarding packets inputs */
#define IFF_NODST_FORWARD (1 << 21) /* Device prohibits forwarding packets outputs */
/* Interface flag helpers */
#define IFF_SET_UP(f) do { (f) |= IFF_UP; } while (0)
#define IFF_SET_RUNNING(f) do { (f) |= IFF_RUNNING; } while (0)
#define IFF_SET_NOARP(f) do { (f) |= IFF_NOARP; } while (0)
#define IFF_SET_NAT(f) do { (f) |= IFF_NAT; } while (0)
#define IFF_SET_LOOPBACK(f) do { (f) |= IFF_LOOPBACK; } while (0)
#define IFF_SET_POINTOPOINT(f) do { (f) |= IFF_POINTOPOINT; } while (0)
#define IFF_SET_MULTICAST(f) do { (f) |= IFF_MULTICAST; } while (0)
#define IFF_SET_BROADCAST(f) do { (f) |= IFF_BROADCAST; } while (0)
#define IFF_SET_SLAVE(f) do { (f) |= IFF_SLAVE; } while (0)
#define IFF_SET_DYNAMIC(f) do { (f) |= IFF_DYNAMIC; } while (0)
#define IFF_SET_NOSRC_FORWARD(f) do { (f) |= IFF_NOSRC_FORWARD; } while (0)
#define IFF_SET_NODST_FORWARD(f) do { (f) |= IFF_NODST_FORWARD; } while (0)
#define IFF_CLR_UP(f) do { (f) &= ~IFF_UP; } while (0)
#define IFF_CLR_RUNNING(f) do { (f) &= ~IFF_RUNNING; } while (0)
#define IFF_CLR_NOARP(f) do { (f) &= ~IFF_NOARP; } while (0)
#define IFF_CLR_NAT(f) do { (f) &= ~IFF_NAT; } while (0)
#define IFF_CLR_LOOPBACK(f) do { (f) &= ~IFF_LOOPBACK; } while (0)
#define IFF_CLR_POINTOPOINT(f) do { (f) &= ~IFF_POINTOPOINT; } while (0)
#define IFF_CLR_MULTICAST(f) do { (f) &= ~IFF_MULTICAST; } while (0)
#define IFF_CLR_BROADCAST(f) do { (f) &= ~IFF_BROADCAST; } while (0)
#define IFF_CLR_SLAVE(f) do { (f) &= ~IFF_SLAVE; } while (0)
#define IFF_CLR_DYNAMIC(f) do { (f) &= ~IFF_DYNAMIC; } while (0)
#define IFF_CLR_NOSRC_FORWARD(f) do { (f) &= ~IFF_NOSRC_FORWARD; } while (0)
#define IFF_CLR_NODST_FORWARD(f) do { (f) &= ~IFF_NODST_FORWARD; } while (0)
#define IFF_IS_UP(f) (((f) & IFF_UP) != 0)
#define IFF_IS_RUNNING(f) (((f) & IFF_RUNNING) != 0)
#define IFF_IS_NOARP(f) (((f) & IFF_NOARP) != 0)
#define IFF_IS_NAT(f) (((f) & IFF_NAT) != 0)
#define IFF_IS_LOOPBACK(f) (((f) & IFF_LOOPBACK) != 0)
#define IFF_IS_POINTOPOINT(f) (((f) & IFF_POINTOPOINT) != 0)
#define IFF_IS_MULTICAST(f) (((f) & IFF_MULTICAST) != 0)
#define IFF_IS_BROADCAST(f) (((f) & IFF_BROADCAST) != 0)
#define IFF_IS_SLAVE(f) (((f) & IFF_SLAVE) != 0)
#define IFF_IS_DYNAMIC(f) (((f) & IFF_DYNAMIC) != 0)
#define IFF_IS_NOSRC_FORWARD(f) (((f) & IFF_NOSRC_FORWARD) != 0)
#define IFF_IS_NODST_FORWARD(f) (((f) & IFF_NODST_FORWARD) != 0)
/* We only need to manage the IPv6 bit if both IPv6 and IPv4 are supported.
* Otherwise, we can save a few bytes by ignoring it.
*/
#if defined(CONFIG_NET_IPv4) && defined(CONFIG_NET_IPv6)
# define IFF_SET_IPv6(f) do { (f) |= IFF_IPv6; } while (0)
# define IFF_CLR_IPv6(f) do { (f) &= ~IFF_IPv6; } while (0)
# define IFF_IS_IPv6(f) (((f) & IFF_IPv6) != 0)
# define IFF_SET_IPv4(f) IFF_CLR_IPv6(f)
# define IFF_CLR_IPv4(f) IFF_SET_IPv6(f)
# define IFF_IS_IPv4(f) (!IFF_IS_IPv6(f))
#elif defined(CONFIG_NET_IPv6)
# define IFF_SET_IPv6(f)
# define IFF_CLR_IPv6(f)
# define IFF_IS_IPv6(f) (1)
# define IFF_SET_IPv4(f)
# define IFF_CLR_IPv4(f)
# define IFF_IS_IPv4(f) (0)
#else /* if defined(CONFIG_NET_IPv4) */
# define IFF_SET_IPv6(f)
# define IFF_CLR_IPv6(f)
# define IFF_IS_IPv6(f) (0)
# define IFF_SET_IPv4(f)
# define IFF_CLR_IPv4(f)
# define IFF_IS_IPv4(f) (1)
#endif
/* MDIO Manageable Device (MMD) support with SIOCxMIIREG ioctl commands */
#define MDIO_PHY_ID_C45 0x8000
#define MDIO_PHY_ID_PRTAD 0x03E0
#define MDIO_PHY_ID_DEVAD 0x001F
#define MDIO_PHY_ID_C45_MASK \
(MDIO_PHY_ID_C45 | MDIO_PHY_ID_PRTAD | MDIO_PHY_ID_DEVAD)
#define mdio_phy_id_c45(prtad, devad) \
((uint16_t)(MDIO_PHY_ID_C45 | ((prtad) << 5) | (devad)))
/* RFC 2863 operational status */
enum
{
IF_OPER_UNKNOWN,
IF_OPER_NOTPRESENT,
IF_OPER_DOWN,
IF_OPER_LOWERLAYERDOWN,
IF_OPER_TESTING,
IF_OPER_DORMANT,
IF_OPER_UP,
};
/****************************************************************************
* Public Type Definitions
****************************************************************************/
struct if_nameindex
{
unsigned int if_index; /* 1, 2, ... */
FAR char *if_name; /* null terminated name: "eth0", ... */
};
/* Structure passed with the SIOCMIINOTIFY ioctl command to enable
* notification of of PHY state changes.
*/
struct mii_ioctl_notify_s
{
pid_t pid; /* PID of the task to receive the signal. Zero means "this task" */
struct sigevent event; /* Describe the way a task is to be notified */
};
/* Structure passed to read from or write to the MII/PHY management
* interface via the SIOCxMIIREG ioctl commands.
*/
struct mii_ioctl_data_s
{
uint16_t phy_id; /* PHY device address */
uint16_t reg_num; /* PHY register address */
uint16_t val_in; /* PHY input data */
uint16_t val_out; /* PHY output data */
};
/* Structure passed to get or set the CAN bitrate
* SIOCxCANBITRATE ioctl commands.
*/
struct can_ioctl_data_s
{
uint32_t arbi_bitrate; /* Classic CAN / Arbitration phase bitrate bit/s */
uint16_t arbi_samplep; /* Classic CAN / Arbitration phase input % */
uint32_t data_bitrate; /* Data phase bitrate bit/s */
uint16_t data_samplep; /* Data phase sample point % */
};
/* Structure passed to add or remove hardware-level CAN ID filters
* SIOCxCANSTDFILTER / SIOCxCANEXTFILTER ioctl commands.
*/
struct can_ioctl_filter_s
{
uint32_t fid1; /* 11- or 29-bit ID (context dependent). For dual match or
* for the lower address in a range of addresses */
uint32_t fid2; /* 11- or 29-bit ID. For dual match, address mask or for
* upper address in address range */
uint8_t ftype; /* See CAN_FILTER_* definitions */
uint8_t fprio; /* See CAN_MSGPRIO_* definitions */
};
/* Define an struct type that describes the CAN/LIN state */
enum can_ioctl_state_e
{
CAN_STATE_OPERATIONAL = 1, /* The can/lin controller is in the awake state */
CAN_STATE_SLEEP, /* The can/lin controller is in the sleep state */
CAN_STATE_SPENDING, /* The can/lin controller is preparing to enter sleep state */
CAN_STATE_BUSY /* The can/lin bus is busy */
};
struct can_ioctl_state_s
{
uintptr_t priv; /* This is private data. */
enum can_ioctl_state_e state;
};
/* Fault confinement and error counters, SIOCGCANERRORS ioctl command.
* WARNING is error-active with either error counter at or above 96;
* PASSIVE and BUSOFF follow the controller's own state.
*/
#define CAN_ERRSTATE_ACTIVE 0
#define CAN_ERRSTATE_WARNING 1
#define CAN_ERRSTATE_PASSIVE 2
#define CAN_ERRSTATE_BUSOFF 3
struct can_ioctl_errors_s
{
uint8_t state; /* CAN_ERRSTATE_* */
uint8_t txerr; /* Transmit error counter (TEC) */
uint8_t rxerr; /* Receive error counter (REC) */
uint32_t errors; /* Bus errors observed since ifup, monotonic */
uint32_t rx_overruns; /* RX frames the controller overwrote unread */
};
/* There are two forms of the I/F request structure.
* One for IPv6 and one for IPv4.
* Notice that they are (and must be) cast compatible and really different
* only in the size of the structure allocation.
*
* This is the I/F request that should be used with IPv6.
*/
struct lifreq
{
char lifr_name[IFNAMSIZ]; /* Network device name (e.g. "eth0") */
union
{
struct sockaddr_storage lifru_addr; /* IP Address */
struct sockaddr_storage lifru_dstaddr; /* P-to-P Address */
struct sockaddr_storage lifru_broadaddr; /* Broadcast address */
struct sockaddr_storage lifru_netmask; /* Netmask */
struct sockaddr lifru_hwaddr; /* MAC address */
int lifru_count; /* Number of devices */
int lifru_ivalue; /* Value for ifindex/metric/bandwidth and so on */
int lifru_mtu; /* MTU size */
uint32_t lifru_flags; /* Interface flags */
struct mii_ioctl_notify_s llfru_mii_notify; /* PHY event notification */
struct mii_ioctl_data_s lifru_mii_data; /* MII request data */
struct can_ioctl_data_s lifru_can_data; /* CAN bitrate request data */
struct can_ioctl_filter_s lifru_can_filter; /* CAN filter request data */
struct can_ioctl_state_s lifru_can_state; /* CAN/LIN controller state */
struct can_ioctl_errors_s lifru_can_errors; /* CAN error counters */
} lifr_ifru;
};
#define lifr_addr lifr_ifru.lifru_addr /* IP address */
#define lifr_dstaddr lifr_ifru.lifru_dstaddr /* P-to-P Address */
#define lifr_broadaddr lifr_ifru.lifru_broadaddr /* Broadcast address */
#define lifr_netmask lifr_ifru.lifru_netmask /* Interface net mask */
#define lifr_hwaddr lifr_ifru.lifru_hwaddr /* MAC address */
#define lifr_ifindex lifr_ifru.lifru_ivalue /* Interface index */
#define lifr_metric lifr_ifru.lifru_ivalue /* metric */
#define lifr_bandwidth lifr_ifru.lifru_ivalue /* link bandwidth */
#define lifr_qlen lifr_ifru.lifru_ivalue /* Queue length */
#define lifr_mtu lifr_ifru.lifru_mtu /* MTU */
#define lifr_count lifr_ifru.lifru_count /* Number of devices */
#define lifr_flags lifr_ifru.lifru_flags /* interface flags */
#define lifr_mii_notify_pid lifr_ifru.llfru_mii_notify.pid /* PID to be notified */
#define lifr_mii_notify_event lifr_ifru.llfru_mii_notify.event /* Describes notification */
#define lifr_mii_phy_id lifr_ifru.lifru_mii_data.phy_id /* PHY device address */
#define lifr_mii_reg_num lifr_ifru.lifru_mii_data.reg_num /* PHY register address */
#define lifr_mii_val_in lifr_ifru.lifru_mii_data.val_in /* PHY input data */
#define lifr_mii_val_out lifr_ifru.lifru_mii_data.val_out /* PHY output data */
/* Used only with the SIOCGLIFCONF IOCTL command */
struct lifconf
{
size_t lifc_len; /* Size of buffer */
union
{
FAR char *lifcu_buf; /* Buffer address */
FAR struct lifreq *lifcu_req; /* Array of ifreq structures */
} lifc_ifcu;
};
#define lifc_buf lifc_ifcu.lifcu_buf /* Buffer address */
#define lifc_req lifc_ifcu.lifcu_req /* Array of ifreq structures */
/* This is the I/F request that should be used with IPv4. */
struct ifreq
{
char ifr_name[IFNAMSIZ]; /* Network device name (e.g. "eth0") */
union
{
struct sockaddr ifru_addr; /* IP Address */
struct sockaddr ifru_dstaddr; /* P-to-P Address */
struct sockaddr ifru_broadaddr; /* Broadcast address */
struct sockaddr ifru_netmask; /* Netmask */
struct sockaddr ifru_hwaddr; /* MAC address */
int ifru_count; /* Number of devices */
int ifru_ivalue; /* Value for ifindex/metric/bandwidth and so on */
int ifru_mtu; /* MTU size */
uint32_t ifru_flags; /* Interface flags */
struct mii_ioctl_notify_s ifru_mii_notify; /* PHY event notification */
struct mii_ioctl_data_s ifru_mii_data; /* MII request data */
struct can_ioctl_data_s ifru_can_data; /* CAN bitrate request data */
struct can_ioctl_filter_s ifru_can_filter; /* CAN filter request data */
struct can_ioctl_state_s ifru_can_state; /* CAN/LIN controller state */
struct can_ioctl_errors_s ifru_can_errors; /* CAN error counters */
FAR void *ifru_data; /* For use by interface */
} ifr_ifru;
};
#define ifr_addr ifr_ifru.ifru_addr /* IP address */
#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* P-to-P Address */
#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* Broadcast address */
#define ifr_netmask ifr_ifru.ifru_netmask /* Interface net mask */
#define ifr_hwaddr ifr_ifru.ifru_hwaddr /* MAC address */
#define ifr_ifindex ifr_ifru.ifru_ivalue /* Interface index */
#define ifr_metric ifr_ifru.ifru_ivalue /* metric */
#define ifr_bandwidth ifr_ifru.ifru_ivalue /* link bandwidth */
#define ifr_qlen ifr_ifru.ifru_ivalue /* Queue length */
#define ifr_mtu ifr_ifru.ifru_mtu /* MTU */
#define ifr_count ifr_ifru.ifru_count /* Number of devices */
#define ifr_flags ifr_ifru.ifru_flags /* interface flags */
#define ifr_mii_notify_pid ifr_ifru.ifru_mii_notify.pid /* PID to be notified */
#define ifr_mii_notify_event ifr_ifru.ifru_mii_notify.event /* Describes notification */
#define ifr_mii_phy_id ifr_ifru.ifru_mii_data.phy_id /* PHY device address */
#define ifr_mii_reg_num ifr_ifru.ifru_mii_data.reg_num /* PHY register address */
#define ifr_mii_val_in ifr_ifru.ifru_mii_data.val_in /* PHY input data */
#define ifr_mii_val_out ifr_ifru.ifru_mii_data.val_out /* PHY output data */
#define ifr_data ifr_ifru.ifru_data /* for use by interface */
/* Used only with the SIOCGIFCONF IOCTL command */
struct ifconf
{
size_t ifc_len; /* Size of buffer */
union
{
FAR char *ifcu_buf; /* Buffer address */
FAR struct ifreq *ifcu_req; /* Array of ifreq structures */
} ifc_ifcu;
};
#define ifc_buf ifc_ifcu.ifcu_buf /* Buffer address */
#define ifc_req ifc_ifcu.ifcu_req /* Array of ifreq structures */
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Name: if_nametoindex
*
* Description:
* The if_nametoindex() function returns the interface index corresponding
* to name ifname.
*
* Input Parameters:
* ifname - The interface name
*
* Returned Value:
* The corresponding index if ifname is the name of an interface;
* otherwise, zero.
*
****************************************************************************/
unsigned int if_nametoindex(FAR const char *ifname);
/****************************************************************************
* Name: if_indextoname
*
* Description:
* The if_indextoname() function maps an interface index to its
* corresponding name.
*
* Input Parameters:
* ifname - Points to a buffer of at least IF_NAMESIZE bytes.
* if_indextoname() will place in this buffer the name
* of the interface with index ifindex.
*
* Returned Value:
* If ifindex is an interface index, then the function will return the
* value supplied by ifname.
* Otherwise, the function returns a NULL pointer and sets errno to
* indicate the error.
*
****************************************************************************/
FAR char *if_indextoname(unsigned int ifindex, FAR char *ifname);
/****************************************************************************
* Name: if_nameindex
*
* Description:
* The if_nameindex() function returns an array of if_nameindex structures,
* each containing information about one of the network interfaces on the
* local system. The if_nameindex structure contains at least the following
* entries:
* unsigned int if_index;
* FAR char *if_name;
* The if_index field contains the interface index. The if_name field
* points to the null-terminated interface name. The end of the array
* is indicated by entry with if_index set to zero and if_name set to NULL.
*
* Input Parameters:
* None
*
* Returned Value:
* On success, if_nameindex() returns pointer to the array; on error, NULL
* is returned, and errno is set to indicate the error.
*
****************************************************************************/
FAR struct if_nameindex *if_nameindex(void);
/****************************************************************************
* Name: if_freenameindex
*
* Description:
* The if_freenameindex() function free the data structure returned by
* if_nameindex().
*
* Input Parameters:
* ifn - The data structure to free
*
* Returned Value:
* None
*
****************************************************************************/
void if_freenameindex(FAR struct if_nameindex *ifn);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_NET_IF_H */
Reference in a new issue View git blame Copy permalink