net: mdio: eliminate kdoc warnings in mdio_device.c and mdio_bus.c

+55 -7

2 changed files

expand all

drivers

net

phy

mdio_bus.c

mdio_device.c

+49 -7

drivers/net/phy/mdio_bus.c

··· 339 339 * mdio_find_bus - Given the name of a mdiobus, find the mii_bus. 340 340 * @mdio_name: The name of a mdiobus. 341 341 * 342 - * Returns a reference to the mii_bus, or NULL if none found. The 342 + * Return: a reference to the mii_bus, or NULL if none found. The 343 343 * embedded struct device will have its reference count incremented, 344 344 * and this must be put_deviced'ed once the bus is finished with. 345 345 */ ··· 357 357 * of_mdio_find_bus - Given an mii_bus node, find the mii_bus. 358 358 * @mdio_bus_np: Pointer to the mii_bus. 359 359 * 360 - * Returns a reference to the mii_bus, or NULL if none found. The 360 + * Return: a reference to the mii_bus, or NULL if none found. The 361 361 * embedded struct device will have its reference count incremented, 362 362 * and this must be put once the bus is finished with. 363 363 * ··· 405 405 * @addr: the phy address 406 406 * @regnum: register number to read 407 407 * 408 + * Return: The register value if successful, negative error code on failure 409 + * 408 410 * Read a MDIO bus register. Caller must hold the mdio bus lock. 409 411 * 410 412 * NOTE: MUST NOT be called from interrupt context. ··· 438 436 * @addr: the phy address 439 437 * @regnum: register number to write 440 438 * @val: value to write to @regnum 439 + * 440 + * Return: Zero if successful, negative error code on failure 441 441 * 442 442 * Write a MDIO bus register. Caller must hold the mdio bus lock. 443 443 * ··· 474 470 * @mask: bit mask of bits to clear 475 471 * @set: bit mask of bits to set 476 472 * 473 + * Return: 1 if the register was modified, 0 if no change was needed, 474 + * negative on any error condition 475 + * 477 476 * Read, modify, and if any change, write the register value back to the 478 - * device. Any error returns a negative number. 477 + * device. 479 478 * 480 479 * NOTE: MUST NOT be called from interrupt context. 481 480 */ ··· 507 500 * @addr: the phy address 508 501 * @devad: device address to read 509 502 * @regnum: register number to read 503 + * 504 + * Return: The register value if successful, negative error code on failure 510 505 * 511 506 * Read a MDIO bus register. Caller must hold the mdio bus lock. 512 507 * ··· 542 533 * @devad: device address to read 543 534 * @regnum: register number to write 544 535 * @val: value to write to @regnum 536 + * 537 + * Return: Zero if successful, negative error code on failure 545 538 * 546 539 * Write a MDIO bus register. Caller must hold the mdio bus lock. 547 540 * ··· 580 569 * @mask: bit mask of bits to clear 581 570 * @set: bit mask of bits to set 582 571 * 572 + * Return: 1 if the register was modified, 0 if no change was needed, 573 + * negative on any error condition 574 + * 583 575 * Read, modify, and if any change, write the register value back to the 584 576 * device. Any error returns a negative number. 585 577 * ··· 613 599 * @addr: the phy address 614 600 * @regnum: register number to read 615 601 * 602 + * Return: The register value if successful, negative error code on failure 603 + * 616 604 * In case of nested MDIO bus access avoid lockdep false positives by 617 605 * using mutex_lock_nested(). 618 606 * ··· 640 624 * @addr: the phy address 641 625 * @regnum: register number to read 642 626 * 627 + * Return: The register value if successful, negative error code on failure 628 + * 643 629 * NOTE: MUST NOT be called from interrupt context, 644 630 * because the bus read/write functions may wait for an interrupt 645 631 * to conclude the operation. ··· 665 647 * @devad: device address to read 666 648 * @regnum: register number to read 667 649 * 650 + * Return: The register value if successful, negative error code on failure 651 + * 668 652 * NOTE: MUST NOT be called from interrupt context, 669 653 * because the bus read/write functions may wait for an interrupt 670 654 * to conclude the operation. ··· 689 669 * @addr: the phy address 690 670 * @devad: device address to read 691 671 * @regnum: register number to read 672 + * 673 + * Return: The register value if successful, negative error code on failure 692 674 * 693 675 * In case of nested MDIO bus access avoid lockdep false positives by 694 676 * using mutex_lock_nested(). ··· 719 697 * @regnum: register number to write 720 698 * @val: value to write to @regnum 721 699 * 700 + * Return: Zero if successful, negative error code on failure 701 + * 722 702 * In case of nested MDIO bus access avoid lockdep false positives by 723 703 * using mutex_lock_nested(). 724 704 * ··· 747 723 * @regnum: register number to write 748 724 * @val: value to write to @regnum 749 725 * 726 + * Return: Zero if successful, negative error code on failure 727 + * 750 728 * NOTE: MUST NOT be called from interrupt context, 751 729 * because the bus read/write functions may wait for an interrupt 752 730 * to conclude the operation. ··· 772 746 * @devad: device address to read 773 747 * @regnum: register number to write 774 748 * @val: value to write to @regnum 749 + * 750 + * Return: Zero if successful, negative error code on failure 775 751 * 776 752 * NOTE: MUST NOT be called from interrupt context, 777 753 * because the bus read/write functions may wait for an interrupt ··· 799 771 * @devad: device address to read 800 772 * @regnum: register number to write 801 773 * @val: value to write to @regnum 774 + * 775 + * Return: Zero if successful, negative error code on failure 802 776 * 803 777 * In case of nested MDIO bus access avoid lockdep false positives by 804 778 * using mutex_lock_nested(). ··· 830 800 * @regnum: register number to write 831 801 * @mask: bit mask of bits to clear 832 802 * @set: bit mask of bits to set 803 + * 804 + * Return: 0 on success, negative on any error condition 833 805 */ 834 806 int __mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask, 835 807 u16 set) ··· 852 820 * @regnum: register number to write 853 821 * @mask: bit mask of bits to clear 854 822 * @set: bit mask of bits to set 823 + * 824 + * Return: 0 on success, negative on any error condition 855 825 */ 856 826 int mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask, u16 set) 857 827 { ··· 876 842 * @regnum: register number to write 877 843 * @mask: bit mask of bits to clear 878 844 * @set: bit mask of bits to set 845 + * 846 + * Return: 0 on success, negative on any error condition 879 847 */ 880 848 int mdiobus_c45_modify(struct mii_bus *bus, int addr, int devad, u32 regnum, 881 849 u16 mask, u16 set) ··· 901 865 * @regnum: register number to write 902 866 * @mask: bit mask of bits to clear 903 867 * @set: bit mask of bits to set 868 + * 869 + * Return: 1 if the register was modified, 0 if no change was needed, 870 + * negative on any error condition 904 871 */ 905 872 int mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum, 906 873 u16 mask, u16 set) ··· 927 888 * @regnum: register number to write 928 889 * @mask: bit mask of bits to clear 929 890 * @set: bit mask of bits to set 891 + * 892 + * Return: 1 if the register was modified, 0 if no change was needed, 893 + * negative on any error condition 930 894 */ 931 895 int mdiobus_c45_modify_changed(struct mii_bus *bus, int addr, int devad, 932 896 u32 regnum, u16 mask, u16 set) ··· 950 908 * @dev: target MDIO device 951 909 * @drv: given MDIO driver 952 910 * 953 - * Description: Given a MDIO device, and a MDIO driver, return 1 if 954 - * the driver supports the device. Otherwise, return 0. This may 955 - * require calling the devices own match function, since different classes 956 - * of MDIO devices have different match criteria. 911 + * Return: 1 if the driver supports the device, 0 otherwise 912 + * 913 + * Description: This may require calling the devices own match function, 914 + * since different classes of MDIO devices have different match criteria. 957 915 */ 958 916 static int mdio_bus_match(struct device *dev, const struct device_driver *drv) 959 917 {

drivers/net/phy/mdio_device.c

··· 78 78 /** 79 79 * mdio_device_register - Register the mdio device on the MDIO bus 80 80 * @mdiodev: mdio_device structure to be added to the MDIO bus 81 + * 82 + * Return: Zero if successful, negative error code on failure 81 83 */ 82 84 int mdio_device_register(struct mdio_device *mdiodev) 83 85 { ··· 208 206 * 209 207 * Description: Take care of setting up the mdio_device structure 210 208 * and calling the driver to probe the device. 209 + * 210 + * Return: Zero if successful, negative error code on failure 211 211 */ 212 212 static int mdio_probe(struct device *dev) 213 213 { ··· 260 256 /** 261 257 * mdio_driver_register - register an mdio_driver with the MDIO layer 262 258 * @drv: new mdio_driver to register 259 + * 260 + * Return: Zero if successful, negative error code on failure 263 261 */ 264 262 int mdio_driver_register(struct mdio_driver *drv) 265 263 {

Configure Feed

Configure Feed