Index: uspace/lib/c/generic/device/nic.c =================================================================== --- uspace/lib/c/generic/device/nic.c (revision 8d7ec69d8e6ebbc57c70b70b6ed09ed1b8ceba0c) +++ uspace/lib/c/generic/device/nic.c (revision 49ec568b8a2a21ef10f2fe3d4fd9ebe753f318ee) @@ -345,5 +345,5 @@ * it can never force the NIC to advertise unsupported modes. * - * The allowed modes are defined in "net/eth_phys.h" in the C library. + * The allowed modes are defined in "nic/eth_phys.h" in the C library. * * @param[in] dev_sess @@ -382,5 +382,5 @@ /** Probe current state of auto-negotiation. * - * Modes are defined in the "net/eth_phys.h" in the C library. + * Modes are defined in the "nic/eth_phys.h" in the C library. * * @param[in] dev_sess Index: uspace/lib/c/include/device/nic.h =================================================================== --- uspace/lib/c/include/device/nic.h (revision 8d7ec69d8e6ebbc57c70b70b6ed09ed1b8ceba0c) +++ uspace/lib/c/include/device/nic.h (revision 49ec568b8a2a21ef10f2fe3d4fd9ebe753f318ee) @@ -37,8 +37,6 @@ #include -#include -#include +#include #include -#include typedef enum { Index: uspace/lib/c/include/net/device.h =================================================================== --- uspace/lib/c/include/net/device.h (revision 8d7ec69d8e6ebbc57c70b70b6ed09ed1b8ceba0c) +++ uspace/lib/c/include/net/device.h (revision 49ec568b8a2a21ef10f2fe3d4fd9ebe753f318ee) @@ -1,5 +1,4 @@ /* * Copyright (c) 2009 Lukas Mejdrech - * Copyright (c) 2011 Radim Vansa * All rights reserved. * @@ -33,31 +32,12 @@ /** @file - * Device identifier, state and usage statistics. + * Network device. */ -#ifndef LIBC_DEVICE_ID_TYPE_H_ -#define LIBC_DEVICE_ID_TYPE_H_ +#ifndef LIBC_NET_DEVICE_H_ +#define LIBC_NET_DEVICE_H_ #include -#include -#include - -/** Ethernet address length. */ -#define ETH_ADDR 6 - -/** MAC printing format */ -#define PRIMAC "%02x:%02x:%02x:%02x:%02x:%02x" - -/** MAC arguments */ -#define ARGSMAC(__a) \ - (__a)[0], (__a)[1], (__a)[2], (__a)[3], (__a)[4], (__a)[5] - -/* Compare MAC address with specific value */ -#define MAC_EQUALS_VALUE(__a, __a0, __a1, __a2, __a3, __a4, __a5) \ - ((__a)[0] == (__a0) && (__a)[1] == (__a1) && (__a)[2] == (__a2) \ - && (__a)[3] == (__a3) && (__a)[4] == (__a4) && (__a)[5] == (__a5)) - -#define MAC_IS_ZERO(__x) \ - MAC_EQUALS_VALUE(__x, 0, 0, 0, 0, 0, 0) +#include /** Device identifier to generic type map declaration. */ @@ -67,420 +47,4 @@ #define DEVICE_MAP_IMPLEMENT INT_MAP_IMPLEMENT -/** Max length of any hw nic address (currently only eth) */ -#define NIC_MAX_ADDRESS_LENGTH 16 - -/** Invalid device identifier. */ -#define NIC_DEVICE_INVALID_ID (-1) - -#define NIC_VENDOR_MAX_LENGTH 64 -#define NIC_MODEL_MAX_LENGTH 64 -#define NIC_PART_NUMBER_MAX_LENGTH 64 -#define NIC_SERIAL_NUMBER_MAX_LENGTH 64 - -#define NIC_DEFECTIVE_LONG 0x0001 -#define NIC_DEFECTIVE_SHORT 0x0002 -#define NIC_DEFECTIVE_BAD_CRC 0x0010 -#define NIC_DEFECTIVE_BAD_IPV4_CHECKSUM 0x0020 -#define NIC_DEFECTIVE_BAD_IPV6_CHECKSUM 0x0040 -#define NIC_DEFECTIVE_BAD_TCP_CHECKSUM 0x0080 -#define NIC_DEFECTIVE_BAD_UDP_CHECKSUM 0x0100 - -/** - * The bitmap uses single bit for each of the 2^12 = 4096 possible VLAN tags. - * This means its size is 4096/8 = 512 bytes. - */ -#define NIC_VLAN_BITMAP_SIZE 512 - -#define NIC_DEVICE_PRINT_FMT "%x" - -/** Device identifier type. */ -typedef int nic_device_id_t; - -/** - * Structure covering the MAC address. - */ -typedef struct nic_address { - uint8_t address[ETH_ADDR]; -} nic_address_t; - -/** Device state. */ -typedef enum nic_device_state { - /** - * Device present and stopped. Moving device to this state means to discard - * all settings and WOL virtues, rebooting the NIC to state as if the - * computer just booted (or the NIC was just inserted in case of removable - * NIC). - */ - NIC_STATE_STOPPED, - /** - * If the NIC is in this state no packets (frames) are transmitted nor - * received. However, the settings are not restarted. You can use this state - * to temporarily disable transmition/reception or atomically (with respect - * to incoming/outcoming packets) change frames acceptance etc. - */ - NIC_STATE_DOWN, - /** Device is normally operating. */ - NIC_STATE_ACTIVE, - /** Just a constant to limit the state numbers */ - NIC_STATE_MAX, -} nic_device_state_t; - -/** - * Channel operating mode used on the medium. - */ -typedef enum { - NIC_CM_UNKNOWN, - NIC_CM_FULL_DUPLEX, - NIC_CM_HALF_DUPLEX, - NIC_CM_SIMPLEX -} nic_channel_mode_t; - -/** - * Role for the device (used e.g. for 1000Gb ethernet) - */ -typedef enum { - NIC_ROLE_UNKNOWN, - NIC_ROLE_AUTO, - NIC_ROLE_MASTER, - NIC_ROLE_SLAVE -} nic_role_t; - -/** - * Current state of the cable in the device - */ -typedef enum { - NIC_CS_UNKNOWN, - NIC_CS_PLUGGED, - NIC_CS_UNPLUGGED -} nic_cable_state_t; - -/** - * Result of the requested operation - */ -typedef enum { - /** Successfully disabled */ - NIC_RESULT_DISABLED, - /** Successfully enabled */ - NIC_RESULT_ENABLED, - /** Not supported at all */ - NIC_RESULT_NOT_SUPPORTED, - /** Temporarily not available */ - NIC_RESULT_NOT_AVAILABLE, - /** Result extensions */ - NIC_RESULT_FIRST_EXTENSION -} nic_result_t; - -/** Device usage statistics. */ -typedef struct nic_device_stats { - /** Total packets received (accepted). */ - unsigned long receive_packets; - /** Total packets transmitted. */ - unsigned long send_packets; - /** Total bytes received (accepted). */ - unsigned long receive_bytes; - /** Total bytes transmitted. */ - unsigned long send_bytes; - /** Bad packets received counter. */ - unsigned long receive_errors; - /** Packet transmition problems counter. */ - unsigned long send_errors; - /** Number of frames dropped due to insufficient space in RX buffers */ - unsigned long receive_dropped; - /** Number of frames dropped due to insufficient space in TX buffers */ - unsigned long send_dropped; - /** Total multicast packets received (accepted). */ - unsigned long receive_multicast; - /** Total broadcast packets received (accepted). */ - unsigned long receive_broadcast; - /** The number of collisions due to congestion on the medium. */ - unsigned long collisions; - /** Unicast packets received but not accepted (filtered) */ - unsigned long receive_filtered_unicast; - /** Multicast packets received but not accepted (filtered) */ - unsigned long receive_filtered_multicast; - /** Broadcast packets received but not accepted (filtered) */ - unsigned long receive_filtered_broadcast; - - /* detailed receive_errors */ - - /** Received packet length error counter. */ - unsigned long receive_length_errors; - /** Receiver buffer overflow counter. */ - unsigned long receive_over_errors; - /** Received packet with crc error counter. */ - unsigned long receive_crc_errors; - /** Received frame alignment error counter. */ - unsigned long receive_frame_errors; - /** Receiver fifo overrun counter. */ - unsigned long receive_fifo_errors; - /** Receiver missed packet counter. */ - unsigned long receive_missed_errors; - - /* detailed send_errors */ - - /** Transmitter aborted counter. */ - unsigned long send_aborted_errors; - /** Transmitter carrier errors counter. */ - unsigned long send_carrier_errors; - /** Transmitter fifo overrun counter. */ - unsigned long send_fifo_errors; - /** Transmitter carrier errors counter. */ - unsigned long send_heartbeat_errors; - /** Transmitter window errors counter. */ - unsigned long send_window_errors; - - /* for cslip etc */ - - /** Total compressed packets received. */ - unsigned long receive_compressed; - /** Total compressed packet transmitted. */ - unsigned long send_compressed; -} nic_device_stats_t; - -/** Errors corresponding to those in the nic_device_stats_t */ -typedef enum { - NIC_SEC_BUFFER_FULL, - NIC_SEC_ABORTED, - NIC_SEC_CARRIER_LOST, - NIC_SEC_FIFO_OVERRUN, - NIC_SEC_HEARTBEAT, - NIC_SEC_WINDOW_ERROR, - /* Error encountered during TX but with other type of error */ - NIC_SEC_OTHER -} nic_send_error_cause_t; - -/** Errors corresponding to those in the nic_device_stats_t */ -typedef enum { - NIC_REC_BUFFER_FULL, - NIC_REC_LENGTH, - NIC_REC_BUFFER_OVERFLOW, - NIC_REC_CRC, - NIC_REC_FRAME_ALIGNMENT, - NIC_REC_FIFO_OVERRUN, - NIC_REC_MISSED, - /* Error encountered during RX but with other type of error */ - NIC_REC_OTHER -} nic_receive_error_cause_t; - -/** - * Information about the NIC that never changes - name, vendor, model, - * capabilites and so on. - */ -typedef struct nic_device_info { - /* Device identification */ - char vendor_name[NIC_VENDOR_MAX_LENGTH]; - char model_name[NIC_MODEL_MAX_LENGTH]; - char part_number[NIC_PART_NUMBER_MAX_LENGTH]; - char serial_number[NIC_SERIAL_NUMBER_MAX_LENGTH]; - uint16_t vendor_id; - uint16_t device_id; - uint16_t subsystem_vendor_id; - uint16_t subsystem_id; - /* Device capabilities */ - uint16_t ethernet_support[ETH_PHYS_LAYERS]; - - /** The mask of all modes which the device can advertise - * - * see ETH_AUTONEG_ macros in net/eth_phys.h of libc - */ - uint32_t autoneg_support; -} nic_device_info_t; - -/** - * Type of the ethernet frame - */ -typedef enum nic_frame_type { - NIC_FRAME_UNICAST, - NIC_FRAME_MULTICAST, - NIC_FRAME_BROADCAST -} nic_frame_type_t; - -/** - * Specifies which unicast frames is the NIC receiving. - */ -typedef enum nic_unicast_mode { - NIC_UNICAST_UNKNOWN, - /** No unicast frames are received */ - NIC_UNICAST_BLOCKED, - /** Only the frames with this NIC's MAC as destination are received */ - NIC_UNICAST_DEFAULT, - /** - * Both frames with this NIC's MAC and those specified in the list are - * received - */ - NIC_UNICAST_LIST, - /** All unicast frames are received */ - NIC_UNICAST_PROMISC -} nic_unicast_mode_t; - -typedef enum nic_multicast_mode { - NIC_MULTICAST_UNKNOWN, - /** No multicast frames are received */ - NIC_MULTICAST_BLOCKED, - /** Frames with multicast addresses specified in this list are received */ - NIC_MULTICAST_LIST, - /** All multicast frames are received */ - NIC_MULTICAST_PROMISC -} nic_multicast_mode_t; - -typedef enum nic_broadcast_mode { - NIC_BROADCAST_UNKNOWN, - /** Broadcast frames are dropped */ - NIC_BROADCAST_BLOCKED, - /** Broadcast frames are received */ - NIC_BROADCAST_ACCEPTED -} nic_broadcast_mode_t; - -/** - * Structure covering the bitmap with VLAN tags. - */ -typedef struct nic_vlan_mask { - uint8_t bitmap[NIC_VLAN_BITMAP_SIZE]; -} nic_vlan_mask_t; - -/* WOL virtue identifier */ -typedef unsigned int nic_wv_id_t; - -/** - * Structure passed as argument for virtue NIC_WV_MAGIC_PACKET. - */ -typedef struct nic_wv_magic_packet_data { - uint8_t password[6]; -} nic_wv_magic_packet_data_t; - -/** - * Structure passed as argument for virtue NIC_WV_DIRECTED_IPV4 - */ -typedef struct nic_wv_ipv4_data { - uint8_t address[4]; -} nic_wv_ipv4_data_t; - -/** - * Structure passed as argument for virtue NIC_WV_DIRECTED_IPV6 - */ -typedef struct nic_wv_ipv6_data { - uint8_t address[16]; -} nic_wv_ipv6_data_t; - -/** - * WOL virtue types defining the interpretation of data passed to the virtue. - * Those tagged with S can have only single virtue active at one moment, those - * tagged with M can have multiple ones. - */ -typedef enum nic_wv_type { - /** - * Used for deletion of the virtue - in this case the mask, data and length - * arguments are ignored. - */ - NIC_WV_NONE, - /** S - * Enabled <=> wakeup upon link change - */ - NIC_WV_LINK_CHANGE, - /** S - * If this virtue is set up, wakeup can be issued by a magic packet frame. - * If the data argument is not NULL, it must contain - * nic_wv_magic_packet_data structure with the SecureOn password. - */ - NIC_WV_MAGIC_PACKET, - /** M - * If the virtue is set up, wakeup can be issued by a frame targeted to - * device with MAC address specified in data. The data must contain - * nic_address_t structure. - */ - NIC_WV_DESTINATION, - /** S - * Enabled <=> wakeup upon receiving broadcast frame - */ - NIC_WV_BROADCAST, - /** S - * Enabled <=> wakeup upon receiving ARP Request - */ - NIC_WV_ARP_REQUEST, - /** M - * If enabled, the wakeup is issued upon receiving frame with an IPv4 packet - * with IPv4 address specified in data. The data must contain - * nic_wv_ipv4_data structure. - */ - NIC_WV_DIRECTED_IPV4, - /** M - * If enabled, the wakeup is issued upon receiving frame with an IPv4 packet - * with IPv6 address specified in data. The data must contain - * nic_wv_ipv6_data structure. - */ - NIC_WV_DIRECTED_IPV6, - /** M - * First length/2 bytes in the argument are interpreted as mask, second - * length/2 bytes are interpreted as content. - * If enabled, the wakeup is issued upon receiving frame where the bytes - * with non-zero value in the mask equal to those in the content. - */ - NIC_WV_FULL_MATCH, - /** - * Dummy value, do not use. - */ - NIC_WV_MAX -} nic_wv_type_t; - -/** - * Specifies the interrupt/polling mode used by the driver and NIC - */ -typedef enum nic_poll_mode { - /** - * NIC issues interrupts upon events. - */ - NIC_POLL_IMMEDIATE, - /** - * Some uspace app calls nic_poll_now(...) in order to check the NIC state - * - no interrupts are received from the NIC. - */ - NIC_POLL_ON_DEMAND, - /** - * The driver itself issues a poll request in a periodic manner. It is - * allowed to use hardware timer if the NIC supports it. - */ - NIC_POLL_PERIODIC, - /** - * The driver itself issued a poll request in a periodic manner. The driver - * must create software timer, internal hardware timer of NIC must not be - * used even if the NIC supports it. - */ - NIC_POLL_SOFTWARE_PERIODIC -} nic_poll_mode_t; - -/** - * Says if this virtue type is a multi-virtue (there can be multiple virtues of - * this type at once). - * - * @param type - * - * @return true or false - */ -static inline int nic_wv_is_multi(nic_wv_type_t type) { - switch (type) { - case NIC_WV_FULL_MATCH: - case NIC_WV_DESTINATION: - case NIC_WV_DIRECTED_IPV4: - case NIC_WV_DIRECTED_IPV6: - return true; - default: - return false; - } -} - -static inline const char *nic_device_state_to_string(nic_device_state_t state) -{ - switch (state) { - case NIC_STATE_STOPPED: - return "stopped"; - case NIC_STATE_DOWN: - return "down"; - case NIC_STATE_ACTIVE: - return "active"; - default: - return "undefined"; - } -} - #endif Index: uspace/lib/c/include/net/eth_phys.h =================================================================== --- uspace/lib/c/include/net/eth_phys.h (revision 8d7ec69d8e6ebbc57c70b70b6ed09ed1b8ceba0c) +++ (revision ) @@ -1,142 +1,0 @@ -/* - * Copyright (c) 2011 Radim Vansa - * Copyright (c) 2011 Jiri Michalec - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - 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. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. - */ - -#ifndef LIBC_NET_ETH_PHYS_H_ -#define LIBC_NET_ETH_PHYS_H_ - -#include - -/*****************************************************/ -/* Definitions of possible supported physical layers */ -/*****************************************************/ - -/* Ethernet physical layers */ -#define ETH_OLD 0 -#define ETH_10M 1 -#define ETH_100M 2 -#define ETH_1000M 3 -#define ETH_10G 4 -#define ETH_40G_100G 5 -/* 6, 7 reserved for future use */ -#define ETH_PHYS_LAYERS 8 - -/* < 10Mbs ethernets */ -#define ETH_EXPERIMENTAL 0x0001 -#define ETH_1BASE5 0x0002 -/* 10Mbs ethernets */ -#define ETH_10BASE5 0x0001 -#define ETH_10BASE2 0x0002 -#define ETH_10BROAD36 0x0004 -#define ETH_STARLAN_10 0x0008 -#define ETH_LATTISNET 0x0010 -#define ETH_10BASE_T 0x0020 -#define ETH_FOIRL 0x0040 -#define ETH_10BASE_FL 0x0080 -#define ETH_10BASE_FB 0x0100 -#define ETH_10BASE_FP 0x0200 -/* 100Mbs (fast) ethernets */ -#define ETH_100BASE_TX 0x0001 -#define ETH_100BASE_T4 0x0002 -#define ETH_100BASE_T2 0x0004 -#define ETH_100BASE_FX 0x0008 -#define ETH_100BASE_SX 0x0010 -#define ETH_100BASE_BX10 0x0020 -#define ETH_100BASE_LX10 0x0040 -#define ETH_100BASE_VG 0x0080 -/* 1000Mbs (gigabit) ethernets */ -#define ETH_1000BASE_T 0x0001 -#define ETH_1000BASE_TX 0x0002 -#define ETH_1000BASE_SX 0x0004 -#define ETH_1000BASE_LX 0x0008 -#define ETH_1000BASE_LH 0x0010 -#define ETH_1000BASE_CX 0x0020 -#define ETH_1000BASE_BX10 0x0040 -#define ETH_1000BASE_LX10 0x0080 -#define ETH_1000BASE_PX10_D 0x0100 -#define ETH_1000BASE_PX10_U 0x0200 -#define ETH_1000BASE_PX20_D 0x0400 -#define ETH_1000BASE_PX20_U 0x0800 -#define ETH_1000BASE_ZX 0x1000 -#define ETH_1000BASE_KX 0x2000 -/* 10Gbs ethernets */ -#define ETH_10GBASE_SR 0x0001 -#define ETH_10GBASE_LX4 0x0002 -#define ETH_10GBASE_LR 0x0004 -#define ETH_10GBASE_ER 0x0008 -#define ETH_10GBASE_SW 0x0010 -#define ETH_10GBASE_LW 0x0020 -#define ETH_10GBASE_EW 0x0040 -#define ETH_10GBASE_CX4 0x0080 -#define ETH_10GBASE_T 0x0100 -#define ETH_10GBASE_LRM 0x0200 -#define ETH_10GBASE_KX4 0x0400 -#define ETH_10GBASE_KR 0x0800 -/* 40Gbs and 100Gbs ethernets */ -#define ETH_40GBASE_SR4 0x0001 -#define ETH_40GBASE_LR4 0x0002 -#define ETH_40GBASE_CR4 0x0004 -#define ETH_40GBASE_KR4 0x0008 -#define ETH_100GBASE_SR10 0x0010 -#define ETH_100GBASE_LR4 0x0020 -#define ETH_100GBASE_ER4 0x0040 -#define ETH_100GBASE_CR10 0x0080 - -/******************************************/ -/* Auto-negotiation advertisement options */ -/******************************************/ - -#define ETH_AUTONEG_10BASE_T_HALF UINT32_C(0x00000001) -#define ETH_AUTONEG_10BASE_T_FULL UINT32_C(0x00000002) -#define ETH_AUTONEG_100BASE_TX_HALF UINT32_C(0x00000004) -#define ETH_AUTONEG_100BASE_T4_HALF UINT32_C(0x00000008) -#define ETH_AUTONEG_100BASE_T2_HALF UINT32_C(0x00000010) -#define ETH_AUTONEG_100BASE_TX_FULL UINT32_C(0x00000020) -#define ETH_AUTONEG_100BASE_T2_FULL UINT32_C(0x00000040) -#define ETH_AUTONEG_1000BASE_T_HALF UINT32_C(0x00000080) -#define ETH_AUTONEG_1000BASE_T_FULL UINT32_C(0x00000100) - -/** Symetric pause packet (802.3x standard) */ -#define ETH_AUTONEG_PAUSE_SYMETRIC UINT32_C(0x10000000) -/** Asymetric pause packet (802.3z standard, gigabit ethernet) */ -#define ETH_AUTONEG_PAUSE_ASYMETRIC UINT32_C(0x20000000) - -#define ETH_AUTONEG_MODE_MASK UINT32_C(0x0FFFFFFF) -#define ETH_AUTONEG_FEATURES_MASK UINT32_C(~(ETH_AUTONEG_MODE_MASK)) - -#define ETH_AUTONEG_MODES 9 - -struct eth_autoneg_map { - uint32_t value; - const char *name; -}; - -extern const char *ethernet_names[8][17]; -extern const struct eth_autoneg_map ethernet_autoneg_mapping[ETH_AUTONEG_MODES]; - -#endif Index: uspace/lib/c/include/nic/eth_phys.h =================================================================== --- uspace/lib/c/include/nic/eth_phys.h (revision 49ec568b8a2a21ef10f2fe3d4fd9ebe753f318ee) +++ uspace/lib/c/include/nic/eth_phys.h (revision 49ec568b8a2a21ef10f2fe3d4fd9ebe753f318ee) @@ -0,0 +1,142 @@ +/* + * Copyright (c) 2011 Radim Vansa + * Copyright (c) 2011 Jiri Michalec + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - 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. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. + */ + +#ifndef LIBC_NIC_ETH_PHYS_H_ +#define LIBC_NIC_ETH_PHYS_H_ + +#include + +/*****************************************************/ +/* Definitions of possible supported physical layers */ +/*****************************************************/ + +/* Ethernet physical layers */ +#define ETH_OLD 0 +#define ETH_10M 1 +#define ETH_100M 2 +#define ETH_1000M 3 +#define ETH_10G 4 +#define ETH_40G_100G 5 +/* 6, 7 reserved for future use */ +#define ETH_PHYS_LAYERS 8 + +/* < 10Mbs ethernets */ +#define ETH_EXPERIMENTAL 0x0001 +#define ETH_1BASE5 0x0002 +/* 10Mbs ethernets */ +#define ETH_10BASE5 0x0001 +#define ETH_10BASE2 0x0002 +#define ETH_10BROAD36 0x0004 +#define ETH_STARLAN_10 0x0008 +#define ETH_LATTISNET 0x0010 +#define ETH_10BASE_T 0x0020 +#define ETH_FOIRL 0x0040 +#define ETH_10BASE_FL 0x0080 +#define ETH_10BASE_FB 0x0100 +#define ETH_10BASE_FP 0x0200 +/* 100Mbs (fast) ethernets */ +#define ETH_100BASE_TX 0x0001 +#define ETH_100BASE_T4 0x0002 +#define ETH_100BASE_T2 0x0004 +#define ETH_100BASE_FX 0x0008 +#define ETH_100BASE_SX 0x0010 +#define ETH_100BASE_BX10 0x0020 +#define ETH_100BASE_LX10 0x0040 +#define ETH_100BASE_VG 0x0080 +/* 1000Mbs (gigabit) ethernets */ +#define ETH_1000BASE_T 0x0001 +#define ETH_1000BASE_TX 0x0002 +#define ETH_1000BASE_SX 0x0004 +#define ETH_1000BASE_LX 0x0008 +#define ETH_1000BASE_LH 0x0010 +#define ETH_1000BASE_CX 0x0020 +#define ETH_1000BASE_BX10 0x0040 +#define ETH_1000BASE_LX10 0x0080 +#define ETH_1000BASE_PX10_D 0x0100 +#define ETH_1000BASE_PX10_U 0x0200 +#define ETH_1000BASE_PX20_D 0x0400 +#define ETH_1000BASE_PX20_U 0x0800 +#define ETH_1000BASE_ZX 0x1000 +#define ETH_1000BASE_KX 0x2000 +/* 10Gbs ethernets */ +#define ETH_10GBASE_SR 0x0001 +#define ETH_10GBASE_LX4 0x0002 +#define ETH_10GBASE_LR 0x0004 +#define ETH_10GBASE_ER 0x0008 +#define ETH_10GBASE_SW 0x0010 +#define ETH_10GBASE_LW 0x0020 +#define ETH_10GBASE_EW 0x0040 +#define ETH_10GBASE_CX4 0x0080 +#define ETH_10GBASE_T 0x0100 +#define ETH_10GBASE_LRM 0x0200 +#define ETH_10GBASE_KX4 0x0400 +#define ETH_10GBASE_KR 0x0800 +/* 40Gbs and 100Gbs ethernets */ +#define ETH_40GBASE_SR4 0x0001 +#define ETH_40GBASE_LR4 0x0002 +#define ETH_40GBASE_CR4 0x0004 +#define ETH_40GBASE_KR4 0x0008 +#define ETH_100GBASE_SR10 0x0010 +#define ETH_100GBASE_LR4 0x0020 +#define ETH_100GBASE_ER4 0x0040 +#define ETH_100GBASE_CR10 0x0080 + +/******************************************/ +/* Auto-negotiation advertisement options */ +/******************************************/ + +#define ETH_AUTONEG_10BASE_T_HALF UINT32_C(0x00000001) +#define ETH_AUTONEG_10BASE_T_FULL UINT32_C(0x00000002) +#define ETH_AUTONEG_100BASE_TX_HALF UINT32_C(0x00000004) +#define ETH_AUTONEG_100BASE_T4_HALF UINT32_C(0x00000008) +#define ETH_AUTONEG_100BASE_T2_HALF UINT32_C(0x00000010) +#define ETH_AUTONEG_100BASE_TX_FULL UINT32_C(0x00000020) +#define ETH_AUTONEG_100BASE_T2_FULL UINT32_C(0x00000040) +#define ETH_AUTONEG_1000BASE_T_HALF UINT32_C(0x00000080) +#define ETH_AUTONEG_1000BASE_T_FULL UINT32_C(0x00000100) + +/** Symetric pause packet (802.3x standard) */ +#define ETH_AUTONEG_PAUSE_SYMETRIC UINT32_C(0x10000000) +/** Asymetric pause packet (802.3z standard, gigabit ethernet) */ +#define ETH_AUTONEG_PAUSE_ASYMETRIC UINT32_C(0x20000000) + +#define ETH_AUTONEG_MODE_MASK UINT32_C(0x0FFFFFFF) +#define ETH_AUTONEG_FEATURES_MASK UINT32_C(~(ETH_AUTONEG_MODE_MASK)) + +#define ETH_AUTONEG_MODES 9 + +struct eth_autoneg_map { + uint32_t value; + const char *name; +}; + +extern const char *ethernet_names[8][17]; +extern const struct eth_autoneg_map ethernet_autoneg_mapping[ETH_AUTONEG_MODES]; + +#endif Index: uspace/lib/c/include/nic/nic.h =================================================================== --- uspace/lib/c/include/nic/nic.h (revision 49ec568b8a2a21ef10f2fe3d4fd9ebe753f318ee) +++ uspace/lib/c/include/nic/nic.h (revision 49ec568b8a2a21ef10f2fe3d4fd9ebe753f318ee) @@ -0,0 +1,481 @@ +/* + * Copyright (c) 2009 Lukas Mejdrech + * Copyright (c) 2011 Radim Vansa + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - 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. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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. + */ + +/** @addtogroup libc + * @{ + */ + +/** @file + * NIC interface definitions. + */ + +#ifndef LIBC_NIC_H_ +#define LIBC_NIC_H_ + +#include +#include + +/** Ethernet address length. */ +#define ETH_ADDR 6 + +/** MAC printing format */ +#define PRIMAC "%02x:%02x:%02x:%02x:%02x:%02x" + +/** MAC arguments */ +#define ARGSMAC(__a) \ + (__a)[0], (__a)[1], (__a)[2], (__a)[3], (__a)[4], (__a)[5] + +/* Compare MAC address with specific value */ +#define MAC_EQUALS_VALUE(__a, __a0, __a1, __a2, __a3, __a4, __a5) \ + ((__a)[0] == (__a0) && (__a)[1] == (__a1) && (__a)[2] == (__a2) \ + && (__a)[3] == (__a3) && (__a)[4] == (__a4) && (__a)[5] == (__a5)) + +#define MAC_IS_ZERO(__x) \ + MAC_EQUALS_VALUE(__x, 0, 0, 0, 0, 0, 0) + +/** Max length of any hw nic address (currently only eth) */ +#define NIC_MAX_ADDRESS_LENGTH 16 + +/** Invalid device identifier. */ +#define NIC_DEVICE_INVALID_ID (-1) + +#define NIC_VENDOR_MAX_LENGTH 64 +#define NIC_MODEL_MAX_LENGTH 64 +#define NIC_PART_NUMBER_MAX_LENGTH 64 +#define NIC_SERIAL_NUMBER_MAX_LENGTH 64 + +#define NIC_DEFECTIVE_LONG 0x0001 +#define NIC_DEFECTIVE_SHORT 0x0002 +#define NIC_DEFECTIVE_BAD_CRC 0x0010 +#define NIC_DEFECTIVE_BAD_IPV4_CHECKSUM 0x0020 +#define NIC_DEFECTIVE_BAD_IPV6_CHECKSUM 0x0040 +#define NIC_DEFECTIVE_BAD_TCP_CHECKSUM 0x0080 +#define NIC_DEFECTIVE_BAD_UDP_CHECKSUM 0x0100 + +/** + * The bitmap uses single bit for each of the 2^12 = 4096 possible VLAN tags. + * This means its size is 4096/8 = 512 bytes. + */ +#define NIC_VLAN_BITMAP_SIZE 512 + +#define NIC_DEVICE_PRINT_FMT "%x" + +/** Device identifier type. */ +typedef int nic_device_id_t; + +/** + * Structure covering the MAC address. + */ +typedef struct nic_address { + uint8_t address[ETH_ADDR]; +} nic_address_t; + +/** Device state. */ +typedef enum nic_device_state { + /** + * Device present and stopped. Moving device to this state means to discard + * all settings and WOL virtues, rebooting the NIC to state as if the + * computer just booted (or the NIC was just inserted in case of removable + * NIC). + */ + NIC_STATE_STOPPED, + /** + * If the NIC is in this state no packets (frames) are transmitted nor + * received. However, the settings are not restarted. You can use this state + * to temporarily disable transmition/reception or atomically (with respect + * to incoming/outcoming packets) change frames acceptance etc. + */ + NIC_STATE_DOWN, + /** Device is normally operating. */ + NIC_STATE_ACTIVE, + /** Just a constant to limit the state numbers */ + NIC_STATE_MAX, +} nic_device_state_t; + +/** + * Channel operating mode used on the medium. + */ +typedef enum { + NIC_CM_UNKNOWN, + NIC_CM_FULL_DUPLEX, + NIC_CM_HALF_DUPLEX, + NIC_CM_SIMPLEX +} nic_channel_mode_t; + +/** + * Role for the device (used e.g. for 1000Gb ethernet) + */ +typedef enum { + NIC_ROLE_UNKNOWN, + NIC_ROLE_AUTO, + NIC_ROLE_MASTER, + NIC_ROLE_SLAVE +} nic_role_t; + +/** + * Current state of the cable in the device + */ +typedef enum { + NIC_CS_UNKNOWN, + NIC_CS_PLUGGED, + NIC_CS_UNPLUGGED +} nic_cable_state_t; + +/** + * Result of the requested operation + */ +typedef enum { + /** Successfully disabled */ + NIC_RESULT_DISABLED, + /** Successfully enabled */ + NIC_RESULT_ENABLED, + /** Not supported at all */ + NIC_RESULT_NOT_SUPPORTED, + /** Temporarily not available */ + NIC_RESULT_NOT_AVAILABLE, + /** Result extensions */ + NIC_RESULT_FIRST_EXTENSION +} nic_result_t; + +/** Device usage statistics. */ +typedef struct nic_device_stats { + /** Total packets received (accepted). */ + unsigned long receive_packets; + /** Total packets transmitted. */ + unsigned long send_packets; + /** Total bytes received (accepted). */ + unsigned long receive_bytes; + /** Total bytes transmitted. */ + unsigned long send_bytes; + /** Bad packets received counter. */ + unsigned long receive_errors; + /** Packet transmition problems counter. */ + unsigned long send_errors; + /** Number of frames dropped due to insufficient space in RX buffers */ + unsigned long receive_dropped; + /** Number of frames dropped due to insufficient space in TX buffers */ + unsigned long send_dropped; + /** Total multicast packets received (accepted). */ + unsigned long receive_multicast; + /** Total broadcast packets received (accepted). */ + unsigned long receive_broadcast; + /** The number of collisions due to congestion on the medium. */ + unsigned long collisions; + /** Unicast packets received but not accepted (filtered) */ + unsigned long receive_filtered_unicast; + /** Multicast packets received but not accepted (filtered) */ + unsigned long receive_filtered_multicast; + /** Broadcast packets received but not accepted (filtered) */ + unsigned long receive_filtered_broadcast; + + /* detailed receive_errors */ + + /** Received packet length error counter. */ + unsigned long receive_length_errors; + /** Receiver buffer overflow counter. */ + unsigned long receive_over_errors; + /** Received packet with crc error counter. */ + unsigned long receive_crc_errors; + /** Received frame alignment error counter. */ + unsigned long receive_frame_errors; + /** Receiver fifo overrun counter. */ + unsigned long receive_fifo_errors; + /** Receiver missed packet counter. */ + unsigned long receive_missed_errors; + + /* detailed send_errors */ + + /** Transmitter aborted counter. */ + unsigned long send_aborted_errors; + /** Transmitter carrier errors counter. */ + unsigned long send_carrier_errors; + /** Transmitter fifo overrun counter. */ + unsigned long send_fifo_errors; + /** Transmitter carrier errors counter. */ + unsigned long send_heartbeat_errors; + /** Transmitter window errors counter. */ + unsigned long send_window_errors; + + /* for cslip etc */ + + /** Total compressed packets received. */ + unsigned long receive_compressed; + /** Total compressed packet transmitted. */ + unsigned long send_compressed; +} nic_device_stats_t; + +/** Errors corresponding to those in the nic_device_stats_t */ +typedef enum { + NIC_SEC_BUFFER_FULL, + NIC_SEC_ABORTED, + NIC_SEC_CARRIER_LOST, + NIC_SEC_FIFO_OVERRUN, + NIC_SEC_HEARTBEAT, + NIC_SEC_WINDOW_ERROR, + /* Error encountered during TX but with other type of error */ + NIC_SEC_OTHER +} nic_send_error_cause_t; + +/** Errors corresponding to those in the nic_device_stats_t */ +typedef enum { + NIC_REC_BUFFER_FULL, + NIC_REC_LENGTH, + NIC_REC_BUFFER_OVERFLOW, + NIC_REC_CRC, + NIC_REC_FRAME_ALIGNMENT, + NIC_REC_FIFO_OVERRUN, + NIC_REC_MISSED, + /* Error encountered during RX but with other type of error */ + NIC_REC_OTHER +} nic_receive_error_cause_t; + +/** + * Information about the NIC that never changes - name, vendor, model, + * capabilites and so on. + */ +typedef struct nic_device_info { + /* Device identification */ + char vendor_name[NIC_VENDOR_MAX_LENGTH]; + char model_name[NIC_MODEL_MAX_LENGTH]; + char part_number[NIC_PART_NUMBER_MAX_LENGTH]; + char serial_number[NIC_SERIAL_NUMBER_MAX_LENGTH]; + uint16_t vendor_id; + uint16_t device_id; + uint16_t subsystem_vendor_id; + uint16_t subsystem_id; + /* Device capabilities */ + uint16_t ethernet_support[ETH_PHYS_LAYERS]; + + /** The mask of all modes which the device can advertise + * + * see ETH_AUTONEG_ macros in nic/eth_phys.h of libc + */ + uint32_t autoneg_support; +} nic_device_info_t; + +/** + * Type of the ethernet frame + */ +typedef enum nic_frame_type { + NIC_FRAME_UNICAST, + NIC_FRAME_MULTICAST, + NIC_FRAME_BROADCAST +} nic_frame_type_t; + +/** + * Specifies which unicast frames is the NIC receiving. + */ +typedef enum nic_unicast_mode { + NIC_UNICAST_UNKNOWN, + /** No unicast frames are received */ + NIC_UNICAST_BLOCKED, + /** Only the frames with this NIC's MAC as destination are received */ + NIC_UNICAST_DEFAULT, + /** + * Both frames with this NIC's MAC and those specified in the list are + * received + */ + NIC_UNICAST_LIST, + /** All unicast frames are received */ + NIC_UNICAST_PROMISC +} nic_unicast_mode_t; + +typedef enum nic_multicast_mode { + NIC_MULTICAST_UNKNOWN, + /** No multicast frames are received */ + NIC_MULTICAST_BLOCKED, + /** Frames with multicast addresses specified in this list are received */ + NIC_MULTICAST_LIST, + /** All multicast frames are received */ + NIC_MULTICAST_PROMISC +} nic_multicast_mode_t; + +typedef enum nic_broadcast_mode { + NIC_BROADCAST_UNKNOWN, + /** Broadcast frames are dropped */ + NIC_BROADCAST_BLOCKED, + /** Broadcast frames are received */ + NIC_BROADCAST_ACCEPTED +} nic_broadcast_mode_t; + +/** + * Structure covering the bitmap with VLAN tags. + */ +typedef struct nic_vlan_mask { + uint8_t bitmap[NIC_VLAN_BITMAP_SIZE]; +} nic_vlan_mask_t; + +/* WOL virtue identifier */ +typedef unsigned int nic_wv_id_t; + +/** + * Structure passed as argument for virtue NIC_WV_MAGIC_PACKET. + */ +typedef struct nic_wv_magic_packet_data { + uint8_t password[6]; +} nic_wv_magic_packet_data_t; + +/** + * Structure passed as argument for virtue NIC_WV_DIRECTED_IPV4 + */ +typedef struct nic_wv_ipv4_data { + uint8_t address[4]; +} nic_wv_ipv4_data_t; + +/** + * Structure passed as argument for virtue NIC_WV_DIRECTED_IPV6 + */ +typedef struct nic_wv_ipv6_data { + uint8_t address[16]; +} nic_wv_ipv6_data_t; + +/** + * WOL virtue types defining the interpretation of data passed to the virtue. + * Those tagged with S can have only single virtue active at one moment, those + * tagged with M can have multiple ones. + */ +typedef enum nic_wv_type { + /** + * Used for deletion of the virtue - in this case the mask, data and length + * arguments are ignored. + */ + NIC_WV_NONE, + /** S + * Enabled <=> wakeup upon link change + */ + NIC_WV_LINK_CHANGE, + /** S + * If this virtue is set up, wakeup can be issued by a magic packet frame. + * If the data argument is not NULL, it must contain + * nic_wv_magic_packet_data structure with the SecureOn password. + */ + NIC_WV_MAGIC_PACKET, + /** M + * If the virtue is set up, wakeup can be issued by a frame targeted to + * device with MAC address specified in data. The data must contain + * nic_address_t structure. + */ + NIC_WV_DESTINATION, + /** S + * Enabled <=> wakeup upon receiving broadcast frame + */ + NIC_WV_BROADCAST, + /** S + * Enabled <=> wakeup upon receiving ARP Request + */ + NIC_WV_ARP_REQUEST, + /** M + * If enabled, the wakeup is issued upon receiving frame with an IPv4 packet + * with IPv4 address specified in data. The data must contain + * nic_wv_ipv4_data structure. + */ + NIC_WV_DIRECTED_IPV4, + /** M + * If enabled, the wakeup is issued upon receiving frame with an IPv4 packet + * with IPv6 address specified in data. The data must contain + * nic_wv_ipv6_data structure. + */ + NIC_WV_DIRECTED_IPV6, + /** M + * First length/2 bytes in the argument are interpreted as mask, second + * length/2 bytes are interpreted as content. + * If enabled, the wakeup is issued upon receiving frame where the bytes + * with non-zero value in the mask equal to those in the content. + */ + NIC_WV_FULL_MATCH, + /** + * Dummy value, do not use. + */ + NIC_WV_MAX +} nic_wv_type_t; + +/** + * Specifies the interrupt/polling mode used by the driver and NIC + */ +typedef enum nic_poll_mode { + /** + * NIC issues interrupts upon events. + */ + NIC_POLL_IMMEDIATE, + /** + * Some uspace app calls nic_poll_now(...) in order to check the NIC state + * - no interrupts are received from the NIC. + */ + NIC_POLL_ON_DEMAND, + /** + * The driver itself issues a poll request in a periodic manner. It is + * allowed to use hardware timer if the NIC supports it. + */ + NIC_POLL_PERIODIC, + /** + * The driver itself issued a poll request in a periodic manner. The driver + * must create software timer, internal hardware timer of NIC must not be + * used even if the NIC supports it. + */ + NIC_POLL_SOFTWARE_PERIODIC +} nic_poll_mode_t; + +/** + * Says if this virtue type is a multi-virtue (there can be multiple virtues of + * this type at once). + * + * @param type + * + * @return true or false + */ +static inline int nic_wv_is_multi(nic_wv_type_t type) { + switch (type) { + case NIC_WV_FULL_MATCH: + case NIC_WV_DESTINATION: + case NIC_WV_DIRECTED_IPV4: + case NIC_WV_DIRECTED_IPV6: + return true; + default: + return false; + } +} + +static inline const char *nic_device_state_to_string(nic_device_state_t state) +{ + switch (state) { + case NIC_STATE_STOPPED: + return "stopped"; + case NIC_STATE_DOWN: + return "down"; + case NIC_STATE_ACTIVE: + return "active"; + default: + return "undefined"; + } +} + +#endif + +/** @} + */