Commit e86c6569 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

net: phy: remove kernel-doc duplication 



Sphinx 3 now checks for duplicated function declarations:

	.../Documentation/networking/kapi:143: ../include/linux/phy.h:163: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
	Declaration is 'unsigned int phy_supported_speeds (struct phy_device *phy, unsigned int *speeds, unsigned int size)'.
	.../Documentation/networking/kapi:143: ../include/linux/phy.h:1034: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
	Declaration is 'int phy_read_mmd (struct phy_device *phydev, int devad, u32 regnum)'.
	.../Documentation/networking/kapi:143: ../include/linux/phy.h:1076: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
	Declaration is 'int __phy_read_mmd (struct phy_device *phydev, int devad, u32 regnum)'.
	.../Documentation/networking/kapi:143: ../include/linux/phy.h:1088: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
	Declaration is 'int phy_write_mmd (struct phy_device *phydev, int devad, u32 regnum, u16 val)'.
	.../Documentation/networking/kapi:143: ../include/linux/phy.h:1100: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
	Declaration is 'int __phy_write_mmd (struct phy_device *phydev, int devad, u32 regnum, u16 val)'.

It turns that both the C and the H files have the same
kernel-doc markup for the same functions. Let's drop the
at the header file, keeping the one closer to the code.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: default avatarAndrew Lunn <andrew@lunn.ch>
Link: https://lore.kernel.org/r/75e9a357f9a716833d2094b04898754876365e68.1603791716.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 89b42235

include/linux/phy.h

+5 −35
Original line number Diff line number Diff line
@@ -147,16 +147,8 @@ typedef enum { 
	PHY_INTERFACE_MODE_MAX,

} phy_interface_t;



/**

/*

 * phy_supported_speeds - return all speeds currently supported by a PHY device

 * @phy: The PHY device to return supported speeds of.

 * @speeds: buffer to store supported speeds in.

 * @size: size of speeds buffer.

 *

 * Description: Returns the number of supported speeds, and fills

 * the speeds buffer with the supported speeds. If speeds buffer is

 * too small to contain all currently supported speeds, will return as

 * many speeds as can fit.

 */

unsigned int phy_supported_speeds(struct phy_device *phy,

				      unsigned int *speeds,
@@ -1022,14 +1014,9 @@ static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum, 
					regnum, mask, set);

}



/**

/*

 * phy_read_mmd - Convenience function for reading a register

 * from an MMD on a given PHY.

 * @phydev: The phy_device struct

 * @devad: The MMD to read from

 * @regnum: The register on the MMD to read

 *

 * Same rules as for phy_read();

 */

int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
@@ -1064,38 +1051,21 @@ int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum); 
	__ret; \

})



/**

/*

 * __phy_read_mmd - Convenience function for reading a register

 * from an MMD on a given PHY.

 * @phydev: The phy_device struct

 * @devad: The MMD to read from

 * @regnum: The register on the MMD to read

 *

 * Same rules as for __phy_read();

 */

int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);



/**

/*

 * phy_write_mmd - Convenience function for writing a register

 * on an MMD on a given PHY.

 * @phydev: The phy_device struct

 * @devad: The MMD to write to

 * @regnum: The register on the MMD to read

 * @val: value to write to @regnum

 *

 * Same rules as for phy_write();

 */

int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);



/**

/*

 * __phy_write_mmd - Convenience function for writing a register

 * on an MMD on a given PHY.

 * @phydev: The phy_device struct

 * @devad: The MMD to write to

 * @regnum: The register on the MMD to read

 * @val: value to write to @regnum

 *

 * Same rules as for __phy_write();

 */

int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);

CRA Git | Maintained and supported by SUSTech CRA and CCSE