mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-21 08:19:28 +00:00
![Greg Kroah-Hartman](/assets/img/avatar_default.png)
Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of the kernel, which is GPL version 2. Update the files which contain no license information with the 'GPL-2.0' SPDX license identifier. The SPDX identifier is a legally binding shorthand, which can be used instead of the full boiler plate text. This patch is based on work done by Thomas Gleixner and Kate Stewart and Philippe Ombredanne. How this work was done: Patches were generated and checked against linux-4.14-rc6 for a subset of the use cases: - file had no licensing information it it. - file was a */uapi/* one with no licensing information in it, - file was a */uapi/* one with existing licensing information, Further patches will be generated in subsequent months to fix up cases where non-standard license headers were used, and references to license had to be inferred by heuristics based on keywords. The analysis to determine which SPDX License Identifier to be applied to a file was done in a spreadsheet of side by side results from of the output of two independent scanners (ScanCode & Windriver) producing SPDX tag:value files created by Philippe Ombredanne. Philippe prepared the base worksheet, and did an initial spot review of a few 1000 files. The 4.13 kernel was the starting point of the analysis with 60,537 files assessed. Kate Stewart did a file by file comparison of the scanner results in the spreadsheet to determine which SPDX license identifier(s) to be applied to the file. She confirmed any determination that was not immediately clear with lawyers working with the Linux Foundation. Criteria used to select files for SPDX license identifier tagging was: - Files considered eligible had to be source code files. - Make and config files were included as candidates if they contained >5 lines of source - File already had some variant of a license header in it (even if <5 lines). All documentation files were explicitly excluded. The following heuristics were used to determine which SPDX license identifiers to apply. - when both scanners couldn't find any license traces, file was considered to have no license information in it, and the top level COPYING file license applied. For non */uapi/* files that summary was: SPDX license identifier # files ---------------------------------------------------|------- GPL-2.0 11139 and resulted in the first patch in this series. If that file was a */uapi/* path one, it was "GPL-2.0 WITH Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was: SPDX license identifier # files ---------------------------------------------------|------- GPL-2.0 WITH Linux-syscall-note 930 and resulted in the second patch in this series. - if a file had some form of licensing information in it, and was one of the */uapi/* ones, it was denoted with the Linux-syscall-note if any GPL family license was found in the file or had no licensing in it (per prior point). Results summary: SPDX license identifier # files ---------------------------------------------------|------ GPL-2.0 WITH Linux-syscall-note 270 GPL-2.0+ WITH Linux-syscall-note 169 ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21 ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17 LGPL-2.1+ WITH Linux-syscall-note 15 GPL-1.0+ WITH Linux-syscall-note 14 ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5 LGPL-2.0+ WITH Linux-syscall-note 4 LGPL-2.1 WITH Linux-syscall-note 3 ((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3 ((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1 and that resulted in the third patch in this series. - when the two scanners agreed on the detected license(s), that became the concluded license(s). - when there was disagreement between the two scanners (one detected a license but the other didn't, or they both detected different licenses) a manual inspection of the file occurred. - In most cases a manual inspection of the information in the file resulted in a clear resolution of the license that should apply (and which scanner probably needed to revisit its heuristics). - When it was not immediately clear, the license identifier was confirmed with lawyers working with the Linux Foundation. - If there was any question as to the appropriate license identifier, the file was flagged for further research and to be revisited later in time. In total, over 70 hours of logged manual review was done on the spreadsheet to determine the SPDX license identifiers to apply to the source files by Kate, Philippe, Thomas and, in some cases, confirmation by lawyers working with the Linux Foundation. Kate also obtained a third independent scan of the 4.13 code base from FOSSology, and compared selected files where the other two scanners disagreed against that SPDX file, to see if there was new insights. The Windriver scanner is based on an older version of FOSSology in part, so they are related. Thomas did random spot checks in about 500 files from the spreadsheets for the uapi headers and agreed with SPDX license identifier in the files he inspected. For the non-uapi files Thomas did random spot checks in about 15000 files. In initial set of patches against 4.14-rc6, 3 files were found to have copy/paste license identifier errors, and have been fixed to reflect the correct identifier. Additionally Philippe spent 10 hours this week doing a detailed manual inspection and review of the 12,461 patched files from the initial patch version early this week with: - a full scancode scan run, collecting the matched texts, detected license ids and scores - reviewing anything where there was a license detected (about 500+ files) to ensure that the applied SPDX license was correct - reviewing anything where there was no detection but the patch license was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied SPDX license was correct This produced a worksheet with 20 files needing minor correction. This worksheet was then exported into 3 different .csv files for the different types of files to be modified. These .csv files were then reviewed by Greg. Thomas wrote a script to parse the csv files and add the proper SPDX tag to the file, in the format that the file expected. This script was further refined by Greg based on the output to detect more types of files automatically and to distinguish between header and source .c files (which need different comment types.) Finally Greg ran the script using the .csv files to generate the patches. Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org> Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com> Reviewed-by: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
344 lines
8.7 KiB
C
344 lines
8.7 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/*
|
|
* linux/mii.h: definitions for MII-compatible transceivers
|
|
* Originally drivers/net/sunhme.h.
|
|
*
|
|
* Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
|
|
*/
|
|
#ifndef __LINUX_MII_H__
|
|
#define __LINUX_MII_H__
|
|
|
|
|
|
#include <linux/if.h>
|
|
#include <uapi/linux/mii.h>
|
|
|
|
struct ethtool_cmd;
|
|
|
|
struct mii_if_info {
|
|
int phy_id;
|
|
int advertising;
|
|
int phy_id_mask;
|
|
int reg_num_mask;
|
|
|
|
unsigned int full_duplex : 1; /* is full duplex? */
|
|
unsigned int force_media : 1; /* is autoneg. disabled? */
|
|
unsigned int supports_gmii : 1; /* are GMII registers supported? */
|
|
|
|
struct net_device *dev;
|
|
int (*mdio_read) (struct net_device *dev, int phy_id, int location);
|
|
void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
|
|
};
|
|
|
|
extern int mii_link_ok (struct mii_if_info *mii);
|
|
extern int mii_nway_restart (struct mii_if_info *mii);
|
|
extern int mii_ethtool_gset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
|
|
extern void mii_ethtool_get_link_ksettings(
|
|
struct mii_if_info *mii, struct ethtool_link_ksettings *cmd);
|
|
extern int mii_ethtool_sset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
|
|
extern int mii_ethtool_set_link_ksettings(
|
|
struct mii_if_info *mii, const struct ethtool_link_ksettings *cmd);
|
|
extern int mii_check_gmii_support(struct mii_if_info *mii);
|
|
extern void mii_check_link (struct mii_if_info *mii);
|
|
extern unsigned int mii_check_media (struct mii_if_info *mii,
|
|
unsigned int ok_to_print,
|
|
unsigned int init_media);
|
|
extern int generic_mii_ioctl(struct mii_if_info *mii_if,
|
|
struct mii_ioctl_data *mii_data, int cmd,
|
|
unsigned int *duplex_changed);
|
|
|
|
|
|
static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
|
|
{
|
|
return (struct mii_ioctl_data *) &rq->ifr_ifru;
|
|
}
|
|
|
|
/**
|
|
* mii_nway_result
|
|
* @negotiated: value of MII ANAR and'd with ANLPAR
|
|
*
|
|
* Given a set of MII abilities, check each bit and returns the
|
|
* currently supported media, in the priority order defined by
|
|
* IEEE 802.3u. We use LPA_xxx constants but note this is not the
|
|
* value of LPA solely, as described above.
|
|
*
|
|
* The one exception to IEEE 802.3u is that 100baseT4 is placed
|
|
* between 100T-full and 100T-half. If your phy does not support
|
|
* 100T4 this is fine. If your phy places 100T4 elsewhere in the
|
|
* priority order, you will need to roll your own function.
|
|
*/
|
|
static inline unsigned int mii_nway_result (unsigned int negotiated)
|
|
{
|
|
unsigned int ret;
|
|
|
|
if (negotiated & LPA_100FULL)
|
|
ret = LPA_100FULL;
|
|
else if (negotiated & LPA_100BASE4)
|
|
ret = LPA_100BASE4;
|
|
else if (negotiated & LPA_100HALF)
|
|
ret = LPA_100HALF;
|
|
else if (negotiated & LPA_10FULL)
|
|
ret = LPA_10FULL;
|
|
else
|
|
ret = LPA_10HALF;
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* mii_duplex
|
|
* @duplex_lock: Non-zero if duplex is locked at full
|
|
* @negotiated: value of MII ANAR and'd with ANLPAR
|
|
*
|
|
* A small helper function for a common case. Returns one
|
|
* if the media is operating or locked at full duplex, and
|
|
* returns zero otherwise.
|
|
*/
|
|
static inline unsigned int mii_duplex (unsigned int duplex_lock,
|
|
unsigned int negotiated)
|
|
{
|
|
if (duplex_lock)
|
|
return 1;
|
|
if (mii_nway_result(negotiated) & LPA_DUPLEX)
|
|
return 1;
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* ethtool_adv_to_mii_adv_t
|
|
* @ethadv: the ethtool advertisement settings
|
|
*
|
|
* A small helper function that translates ethtool advertisement
|
|
* settings to phy autonegotiation advertisements for the
|
|
* MII_ADVERTISE register.
|
|
*/
|
|
static inline u32 ethtool_adv_to_mii_adv_t(u32 ethadv)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (ethadv & ADVERTISED_10baseT_Half)
|
|
result |= ADVERTISE_10HALF;
|
|
if (ethadv & ADVERTISED_10baseT_Full)
|
|
result |= ADVERTISE_10FULL;
|
|
if (ethadv & ADVERTISED_100baseT_Half)
|
|
result |= ADVERTISE_100HALF;
|
|
if (ethadv & ADVERTISED_100baseT_Full)
|
|
result |= ADVERTISE_100FULL;
|
|
if (ethadv & ADVERTISED_Pause)
|
|
result |= ADVERTISE_PAUSE_CAP;
|
|
if (ethadv & ADVERTISED_Asym_Pause)
|
|
result |= ADVERTISE_PAUSE_ASYM;
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* mii_adv_to_ethtool_adv_t
|
|
* @adv: value of the MII_ADVERTISE register
|
|
*
|
|
* A small helper function that translates MII_ADVERTISE bits
|
|
* to ethtool advertisement settings.
|
|
*/
|
|
static inline u32 mii_adv_to_ethtool_adv_t(u32 adv)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (adv & ADVERTISE_10HALF)
|
|
result |= ADVERTISED_10baseT_Half;
|
|
if (adv & ADVERTISE_10FULL)
|
|
result |= ADVERTISED_10baseT_Full;
|
|
if (adv & ADVERTISE_100HALF)
|
|
result |= ADVERTISED_100baseT_Half;
|
|
if (adv & ADVERTISE_100FULL)
|
|
result |= ADVERTISED_100baseT_Full;
|
|
if (adv & ADVERTISE_PAUSE_CAP)
|
|
result |= ADVERTISED_Pause;
|
|
if (adv & ADVERTISE_PAUSE_ASYM)
|
|
result |= ADVERTISED_Asym_Pause;
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* ethtool_adv_to_mii_ctrl1000_t
|
|
* @ethadv: the ethtool advertisement settings
|
|
*
|
|
* A small helper function that translates ethtool advertisement
|
|
* settings to phy autonegotiation advertisements for the
|
|
* MII_CTRL1000 register when in 1000T mode.
|
|
*/
|
|
static inline u32 ethtool_adv_to_mii_ctrl1000_t(u32 ethadv)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (ethadv & ADVERTISED_1000baseT_Half)
|
|
result |= ADVERTISE_1000HALF;
|
|
if (ethadv & ADVERTISED_1000baseT_Full)
|
|
result |= ADVERTISE_1000FULL;
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* mii_ctrl1000_to_ethtool_adv_t
|
|
* @adv: value of the MII_CTRL1000 register
|
|
*
|
|
* A small helper function that translates MII_CTRL1000
|
|
* bits, when in 1000Base-T mode, to ethtool
|
|
* advertisement settings.
|
|
*/
|
|
static inline u32 mii_ctrl1000_to_ethtool_adv_t(u32 adv)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (adv & ADVERTISE_1000HALF)
|
|
result |= ADVERTISED_1000baseT_Half;
|
|
if (adv & ADVERTISE_1000FULL)
|
|
result |= ADVERTISED_1000baseT_Full;
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* mii_lpa_to_ethtool_lpa_t
|
|
* @adv: value of the MII_LPA register
|
|
*
|
|
* A small helper function that translates MII_LPA
|
|
* bits, when in 1000Base-T mode, to ethtool
|
|
* LP advertisement settings.
|
|
*/
|
|
static inline u32 mii_lpa_to_ethtool_lpa_t(u32 lpa)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (lpa & LPA_LPACK)
|
|
result |= ADVERTISED_Autoneg;
|
|
|
|
return result | mii_adv_to_ethtool_adv_t(lpa);
|
|
}
|
|
|
|
/**
|
|
* mii_stat1000_to_ethtool_lpa_t
|
|
* @adv: value of the MII_STAT1000 register
|
|
*
|
|
* A small helper function that translates MII_STAT1000
|
|
* bits, when in 1000Base-T mode, to ethtool
|
|
* advertisement settings.
|
|
*/
|
|
static inline u32 mii_stat1000_to_ethtool_lpa_t(u32 lpa)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (lpa & LPA_1000HALF)
|
|
result |= ADVERTISED_1000baseT_Half;
|
|
if (lpa & LPA_1000FULL)
|
|
result |= ADVERTISED_1000baseT_Full;
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* ethtool_adv_to_mii_adv_x
|
|
* @ethadv: the ethtool advertisement settings
|
|
*
|
|
* A small helper function that translates ethtool advertisement
|
|
* settings to phy autonegotiation advertisements for the
|
|
* MII_CTRL1000 register when in 1000Base-X mode.
|
|
*/
|
|
static inline u32 ethtool_adv_to_mii_adv_x(u32 ethadv)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (ethadv & ADVERTISED_1000baseT_Half)
|
|
result |= ADVERTISE_1000XHALF;
|
|
if (ethadv & ADVERTISED_1000baseT_Full)
|
|
result |= ADVERTISE_1000XFULL;
|
|
if (ethadv & ADVERTISED_Pause)
|
|
result |= ADVERTISE_1000XPAUSE;
|
|
if (ethadv & ADVERTISED_Asym_Pause)
|
|
result |= ADVERTISE_1000XPSE_ASYM;
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* mii_adv_to_ethtool_adv_x
|
|
* @adv: value of the MII_CTRL1000 register
|
|
*
|
|
* A small helper function that translates MII_CTRL1000
|
|
* bits, when in 1000Base-X mode, to ethtool
|
|
* advertisement settings.
|
|
*/
|
|
static inline u32 mii_adv_to_ethtool_adv_x(u32 adv)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (adv & ADVERTISE_1000XHALF)
|
|
result |= ADVERTISED_1000baseT_Half;
|
|
if (adv & ADVERTISE_1000XFULL)
|
|
result |= ADVERTISED_1000baseT_Full;
|
|
if (adv & ADVERTISE_1000XPAUSE)
|
|
result |= ADVERTISED_Pause;
|
|
if (adv & ADVERTISE_1000XPSE_ASYM)
|
|
result |= ADVERTISED_Asym_Pause;
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* mii_lpa_to_ethtool_lpa_x
|
|
* @adv: value of the MII_LPA register
|
|
*
|
|
* A small helper function that translates MII_LPA
|
|
* bits, when in 1000Base-X mode, to ethtool
|
|
* LP advertisement settings.
|
|
*/
|
|
static inline u32 mii_lpa_to_ethtool_lpa_x(u32 lpa)
|
|
{
|
|
u32 result = 0;
|
|
|
|
if (lpa & LPA_LPACK)
|
|
result |= ADVERTISED_Autoneg;
|
|
|
|
return result | mii_adv_to_ethtool_adv_x(lpa);
|
|
}
|
|
|
|
/**
|
|
* mii_advertise_flowctrl - get flow control advertisement flags
|
|
* @cap: Flow control capabilities (FLOW_CTRL_RX, FLOW_CTRL_TX or both)
|
|
*/
|
|
static inline u16 mii_advertise_flowctrl(int cap)
|
|
{
|
|
u16 adv = 0;
|
|
|
|
if (cap & FLOW_CTRL_RX)
|
|
adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
|
|
if (cap & FLOW_CTRL_TX)
|
|
adv ^= ADVERTISE_PAUSE_ASYM;
|
|
|
|
return adv;
|
|
}
|
|
|
|
/**
|
|
* mii_resolve_flowctrl_fdx
|
|
* @lcladv: value of MII ADVERTISE register
|
|
* @rmtadv: value of MII LPA register
|
|
*
|
|
* Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
|
|
*/
|
|
static inline u8 mii_resolve_flowctrl_fdx(u16 lcladv, u16 rmtadv)
|
|
{
|
|
u8 cap = 0;
|
|
|
|
if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
|
|
cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
|
|
} else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
|
|
if (lcladv & ADVERTISE_PAUSE_CAP)
|
|
cap = FLOW_CTRL_RX;
|
|
else if (rmtadv & ADVERTISE_PAUSE_CAP)
|
|
cap = FLOW_CTRL_TX;
|
|
}
|
|
|
|
return cap;
|
|
}
|
|
|
|
#endif /* __LINUX_MII_H__ */
|