U-Boot

Download

u-boot@lists2.denx.biz

January 2022

197 participants
699 discussions

[PATCH] doc: replace @return by Return:
by Heinrich Schuchardt 26 Jan '22

26 Jan '22

Sphinx expects Return: and not @return to indicate a return value. This is how the patch was created: find . -name '*.c' -exec \ sed -i 's/^$\s$\*$\s*$@return$\s$/\1*\2Return:\3/' {} \; find . -name '*.h' -exec \ sed -i 's/^$\s$\*$\s*$@return$\s$/\1*\2Return:\3/' {} \; In resulting diffs additionally replace: %s/Return: :/Return:/g Remove symlink changes from patch. The patch gives results in some checkpatch warnings. But these should fixed in separate patches corrected separately to facilitate review. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt(a)canonical.com> --- arch/arm/cpu/armv7/s5p-common/timer.c | 2 +- .../arm/include/asm/arch-aspeed/scu_ast2500.h | 4 +- arch/arm/include/asm/arch-aspeed/wdt.h | 4 +- arch/arm/include/asm/arch-hi6220/pinmux.h | 2 +- arch/arm/include/asm/arch-rockchip/clock.h | 8 +- arch/arm/include/asm/arch-tegra/ap.h | 6 +- arch/arm/include/asm/arch-tegra/clock.h | 30 +++--- arch/arm/include/asm/arch-tegra/funcmux.h | 2 +- arch/arm/include/asm/arch-tegra/ivc.h | 12 +-- arch/arm/include/asm/arch-tegra/sys_proto.h | 6 +- arch/arm/include/asm/arch-tegra/tegra_i2c.h | 2 +- arch/arm/include/asm/arch-tegra/warmboot.h | 2 +- arch/arm/include/asm/arch-tegra124/display.h | 4 +- arch/arm/include/asm/arch-tegra20/emc.h | 4 +- arch/arm/include/asm/omap_gpio.h | 2 +- arch/arm/mach-bcm283x/include/mach/msg.h | 10 +- arch/arm/mach-exynos/clock.c | 2 +- arch/arm/mach-exynos/clock_init.h | 2 +- arch/arm/mach-exynos/common_setup.h | 2 +- arch/arm/mach-exynos/dmc_init_ddr3.c | 4 +- arch/arm/mach-exynos/exynos5_setup.h | 4 +- arch/arm/mach-exynos/include/mach/clk.h | 2 +- arch/arm/mach-exynos/include/mach/pinmux.h | 4 +- arch/arm/mach-exynos/include/mach/spl.h | 2 +- arch/arm/mach-imx/ddrmc-vf610-calibration.h | 2 +- arch/arm/mach-s5pc1xx/include/mach/pinmux.h | 4 +- .../cmd_stm32prog/stm32prog_serial.c | 4 +- arch/arm/mach-tegra/clock.c | 10 +- arch/arm/mach-tegra/tegra114/clock.c | 4 +- arch/arm/mach-tegra/tegra124/clock.c | 6 +- arch/arm/mach-tegra/tegra20/clock.c | 4 +- arch/arm/mach-tegra/tegra20/emc.c | 4 +- arch/arm/mach-tegra/tegra210/clock.c | 4 +- arch/arm/mach-tegra/tegra30/clock.c | 4 +- arch/microblaze/include/asm/microblaze_intc.h | 2 +- arch/mips/mach-octeon/bootoctlinux.c | 6 +- arch/mips/mach-octeon/cpu.c | 2 +- arch/mips/mach-octeon/cvmx-bootmem.c | 8 +- arch/mips/mach-octeon/cvmx-coremask.c | 6 +- arch/mips/mach-octeon/cvmx-helper-cfg.c | 32 +++---- arch/mips/mach-octeon/cvmx-helper-fdt.c | 32 +++---- arch/mips/mach-octeon/cvmx-helper-jtag.c | 2 +- arch/mips/mach-octeon/cvmx-helper-util.c | 12 +-- arch/mips/mach-octeon/cvmx-helper.c | 42 ++++----- arch/mips/mach-octeon/cvmx-pcie.c | 40 ++++---- arch/mips/mach-octeon/cvmx-qlm.c | 30 +++--- .../mach-octeon/include/mach/bootoct_cmd.h | 2 +- .../mach-octeon/include/mach/cvmx-bootmem.h | 42 ++++----- .../mach-octeon/include/mach/cvmx-cmd-queue.h | 18 ++-- .../mach-octeon/include/mach/cvmx-coremask.h | 40 ++++---- .../mach-octeon/include/mach/cvmx-error.h | 54 +++++------ arch/mips/mach-octeon/include/mach/cvmx-fpa.h | 10 +- .../mips/mach-octeon/include/mach/cvmx-fpa1.h | 6 +- .../mips/mach-octeon/include/mach/cvmx-fpa3.h | 10 +- .../mips/mach-octeon/include/mach/cvmx-fuse.h | 8 +- .../include/mach/cvmx-global-resources.h | 12 +-- .../include/mach/cvmx-helper-agl.h | 8 +- .../include/mach/cvmx-helper-bgx.h | 30 +++--- .../include/mach/cvmx-helper-board.h | 28 +++--- .../include/mach/cvmx-helper-cfg.h | 70 +++++++------- .../include/mach/cvmx-helper-errata.h | 4 +- .../include/mach/cvmx-helper-fdt.h | 64 ++++++------- .../include/mach/cvmx-helper-fpa.h | 2 +- .../include/mach/cvmx-helper-gpio.h | 22 ++--- .../include/mach/cvmx-helper-ilk.h | 8 +- .../include/mach/cvmx-helper-jtag.h | 2 +- .../include/mach/cvmx-helper-loop.h | 4 +- .../include/mach/cvmx-helper-npi.h | 4 +- .../include/mach/cvmx-helper-pki.h | 4 +- .../include/mach/cvmx-helper-pko3.h | 4 +- .../include/mach/cvmx-helper-rgmii.h | 12 +-- .../include/mach/cvmx-helper-sfp.h | 30 +++--- .../include/mach/cvmx-helper-sgmii.h | 10 +- .../include/mach/cvmx-helper-spi.h | 8 +- .../include/mach/cvmx-helper-srio.h | 10 +- .../include/mach/cvmx-helper-util.h | 26 ++--- .../include/mach/cvmx-helper-xaui.h | 14 +-- .../mach-octeon/include/mach/cvmx-helper.h | 62 ++++++------ .../mach-octeon/include/mach/cvmx-hwfau.h | 48 +++++----- .../mach-octeon/include/mach/cvmx-hwpko.h | 24 ++--- arch/mips/mach-octeon/include/mach/cvmx-ipd.h | 4 +- .../mips/mach-octeon/include/mach/cvmx-pcie.h | 26 ++--- arch/mips/mach-octeon/include/mach/cvmx-pip.h | 2 +- .../include/mach/cvmx-pki-resources.h | 26 ++--- .../mach/cvmx-pko-internal-ports-range.h | 4 +- .../include/mach/cvmx-pko3-queue.h | 2 +- arch/mips/mach-octeon/include/mach/cvmx-pow.h | 32 +++---- arch/mips/mach-octeon/include/mach/cvmx-qlm.h | 22 ++--- .../mips/mach-octeon/include/mach/cvmx-regs.h | 14 +-- .../mach-octeon/include/mach/cvmx-scratch.h | 8 +- arch/mips/mach-octeon/include/mach/cvmx-wqe.h | 10 +- .../mach-octeon/include/mach/octeon-feature.h | 2 +- .../mach-octeon/include/mach/octeon-model.h | 2 +- .../mach-octeon/include/mach/octeon_eth.h | 2 +- .../mach-octeon/include/mach/octeon_fdt.h | 24 ++--- .../mach-octeon/include/mach/octeon_pci.h | 2 +- .../mach-octeon/include/mach/octeon_qlm.h | 2 +- arch/mips/mach-octeon/octeon_fdt.c | 22 ++--- arch/mips/mach-octeon/octeon_qlm.c | 18 ++-- arch/powerpc/cpu/mpc8xxx/fsl_pamu.c | 2 +- arch/riscv/include/asm/smp.h | 10 +- arch/riscv/include/asm/spl.h | 2 +- arch/sandbox/cpu/cpu.c | 2 +- arch/sandbox/cpu/os.c | 4 +- arch/sandbox/cpu/state.c | 4 +- arch/sandbox/include/asm/eth.h | 8 +- arch/sandbox/include/asm/gpio.h | 12 +-- arch/sandbox/include/asm/sdl.h | 14 +-- arch/sandbox/include/asm/state.h | 12 +-- arch/sandbox/include/asm/test.h | 30 +++--- arch/sandbox/include/asm/u-boot-sandbox.h | 4 +- arch/x86/cpu/apollolake/fsp_bindings.c | 4 +- arch/x86/cpu/broadwell/pch.c | 2 +- arch/x86/cpu/broadwell/refcode.c | 2 +- arch/x86/cpu/intel_common/lpc.c | 2 +- arch/x86/cpu/intel_common/p2sb.c | 2 +- arch/x86/cpu/ivybridge/bd82x6x.c | 4 +- arch/x86/cpu/mp_init.c | 10 +- arch/x86/cpu/mtrr.c | 2 +- arch/x86/cpu/slimbootloader/sdram.c | 2 +- arch/x86/include/asm/acpi_table.h | 16 ++-- .../asm/arch-apollolake/fsp_bindings.h | 4 +- arch/x86/include/asm/arch-apollolake/lpc.h | 2 +- .../include/asm/arch-apollolake/systemagent.h | 6 +- .../x86/include/asm/arch-coreboot/timestamp.h | 2 +- arch/x86/include/asm/arch-ivybridge/pch.h | 2 +- .../include/asm/arch-ivybridge/sandybridge.h | 2 +- arch/x86/include/asm/bootm.h | 2 +- arch/x86/include/asm/cb_sysinfo.h | 4 +- arch/x86/include/asm/coreboot_tables.h | 2 +- arch/x86/include/asm/cpu.h | 10 +- arch/x86/include/asm/cpu_common.h | 26 ++--- arch/x86/include/asm/cpu_x86.h | 2 +- arch/x86/include/asm/e820.h | 2 +- arch/x86/include/asm/fast_spi.h | 4 +- arch/x86/include/asm/fsp/fsp_support.h | 34 +++---- arch/x86/include/asm/fsp1/fsp_support.h | 8 +- arch/x86/include/asm/fsp2/fsp_api.h | 4 +- arch/x86/include/asm/fsp2/fsp_internal.h | 8 +- arch/x86/include/asm/hob.h | 18 ++-- arch/x86/include/asm/i8254.h | 2 +- arch/x86/include/asm/intel_acpi.h | 2 +- arch/x86/include/asm/intel_opregion.h | 2 +- arch/x86/include/asm/intel_pinctrl.h | 22 ++--- arch/x86/include/asm/lpc_common.h | 2 +- arch/x86/include/asm/me_common.h | 6 +- arch/x86/include/asm/microcode.h | 4 +- arch/x86/include/asm/mp.h | 8 +- arch/x86/include/asm/mrc_common.h | 2 +- arch/x86/include/asm/mrccache.h | 10 +- arch/x86/include/asm/mtrr.h | 8 +- arch/x86/include/asm/pch_common.h | 2 +- arch/x86/include/asm/pci.h | 6 +- arch/x86/include/asm/sfi.h | 2 +- arch/x86/include/asm/tables.h | 2 +- arch/x86/include/asm/u-boot-x86.h | 4 +- arch/x86/include/asm/zimage.h | 4 +- arch/x86/lib/hob.c | 8 +- arch/x86/lib/mrccache.c | 4 +- board/Marvell/octeontx/board-fdt.c | 2 +- board/Marvell/octeontx2/board-fdt.c | 2 +- board/emulation/qemu-ppce500/qemu-ppce500.c | 2 +- board/gdsys/a38x/hre.c | 14 +-- board/google/chromebook_coral/coral.c | 2 +- board/ti/dra7xx/evm.c | 2 +- board/ti/omap5_uevm/evm.c | 6 +- board/ti/panda/panda.c | 4 +- board/ti/sdp4430/sdp.c | 4 +- boot/android_ab.c | 10 +- boot/bootm.c | 10 +- boot/fdt_region.c | 2 +- boot/image-android-dt.c | 4 +- boot/image-board.c | 2 +- boot/image-fdt.c | 2 +- boot/image-fit-sig.c | 2 +- boot/image-fit.c | 4 +- boot/image.c | 6 +- boot/pxe_utils.c | 2 +- cmd/acpi.c | 2 +- cmd/cramfs.c | 4 +- cmd/cros_ec.c | 4 +- cmd/gpt.c | 10 +- cmd/jffs2.c | 16 ++-- cmd/mtdparts.c | 58 ++++++------ cmd/pci.c | 2 +- cmd/pinmux.c | 2 +- cmd/setexpr.c | 2 +- cmd/sf.c | 8 +- cmd/tpm-common.c | 14 +-- common/autoboot.c | 8 +- common/board_r.c | 2 +- common/bootstage.c | 4 +- common/cli.c | 4 +- common/command.c | 2 +- common/console.c | 2 +- common/edid.c | 4 +- common/fdt_support.c | 2 +- common/hash.c | 2 +- common/log.c | 4 +- common/spl/spl.c | 6 +- common/stdio.c | 2 +- disk/part.c | 2 +- disk/part_efi.c | 2 +- drivers/block/blk-uclass.c | 2 +- drivers/block/blk_legacy.c | 2 +- drivers/clk/aspeed/clk_ast2500.c | 4 +- drivers/clk/aspeed/clk_ast2600.c | 2 +- drivers/clk/microchip/mpfs_clk.h | 6 +- drivers/core/acpi.c | 4 +- drivers/core/device-remove.c | 2 +- drivers/core/device.c | 2 +- drivers/core/lists.c | 2 +- drivers/core/of_access.c | 2 +- drivers/core/root.c | 2 +- drivers/core/uclass.c | 2 +- drivers/crypto/ace_sha.h | 2 +- drivers/crypto/fsl/fsl_hash.c | 6 +- drivers/crypto/fsl/jobdesc.c | 4 +- drivers/fastboot/fb_getvar.c | 2 +- drivers/fastboot/fb_mmc.c | 4 +- drivers/gpio/gpio-uclass.c | 4 +- drivers/gpio/iproc_gpio.c | 2 +- drivers/gpio/sunxi_gpio.c | 2 +- drivers/gpio/tegra_gpio.c | 2 +- drivers/i2c/designware_i2c.c | 8 +- drivers/i2c/designware_i2c.h | 2 +- drivers/i2c/i2c-uclass.c | 4 +- drivers/i2c/mvtwsi.c | 30 +++--- drivers/i2c/octeon_i2c.c | 30 +++--- drivers/i2c/s3c24x0_i2c.c | 2 +- drivers/input/cros_ec_keyb.c | 6 +- drivers/input/i8042.c | 6 +- drivers/input/input.c | 10 +- drivers/input/key_matrix.c | 4 +- drivers/input/tegra-kbc.c | 6 +- drivers/misc/cros_ec.c | 20 ++-- drivers/misc/cros_ec_lpc.c | 2 +- drivers/misc/cros_ec_sandbox.c | 8 +- drivers/misc/cros_ec_spi.c | 2 +- drivers/mmc/mmc.c | 4 +- drivers/mmc/mmc_private.h | 6 +- drivers/mmc/mmc_spi.c | 6 +- drivers/mmc/octeontx_hsmmc.c | 36 +++---- drivers/mmc/sdhci-adma.c | 2 +- drivers/mtd/mtd_uboot.c | 2 +- drivers/mtd/mtdcore.c | 2 +- drivers/mtd/mtdpart.c | 4 +- drivers/mtd/nand/raw/cortina_nand.c | 20 ++-- drivers/mtd/nand/raw/nand_util.c | 22 ++--- drivers/mtd/nand/raw/octeontx_bch.c | 4 +- drivers/mtd/nand/raw/octeontx_bch.h | 6 +- drivers/mtd/nand/raw/octeontx_nand.c | 2 +- drivers/mtd/nand/raw/omap_gpmc.c | 4 +- drivers/mtd/nand/raw/tegra_nand.c | 16 ++-- drivers/mtd/onenand/onenand_base.c | 14 +-- drivers/net/fec_mxc.c | 6 +- drivers/net/octeontx2/cgx.c | 2 +- drivers/net/octeontx2/cgx.h | 2 +- drivers/net/octeontx2/lmt.h | 2 +- drivers/net/octeontx2/nix.c | 2 +- drivers/net/octeontx2/nix_af.c | 4 +- drivers/net/octeontx2/rvu.h | 2 +- drivers/net/octeontx2/rvu_common.c | 2 +- drivers/net/pfe_eth/pfe_driver.c | 8 +- drivers/net/pfe_eth/pfe_eth.c | 2 +- drivers/net/pfe_eth/pfe_firmware.c | 8 +- drivers/net/pfe_eth/pfe_hw.c | 6 +- drivers/pci/pci-uclass.c | 6 +- drivers/pci/pci_common.c | 2 +- drivers/pci/pci_internal.h | 4 +- drivers/pci/pci_rom.c | 2 +- drivers/pinctrl/intel/pinctrl.c | 8 +- drivers/power/exynos-tmu.c | 8 +- drivers/power/palmas.c | 2 +- drivers/power/regulator/tps65090_regulator.c | 2 +- drivers/power/tps6586x.c | 2 +- drivers/remoteproc/sandbox_testproc.c | 2 +- drivers/remoteproc/stm32_copro.c | 14 +-- drivers/serial/serial_bcm283x_mu.c | 2 +- drivers/serial/serial_bcm283x_pl011.c | 2 +- drivers/sound/hda_codec.c | 12 +-- drivers/sound/max98088.c | 12 +-- drivers/sound/max98090.c | 10 +- drivers/sound/max98095.c | 12 +-- drivers/sound/maxim_codec.c | 6 +- drivers/sound/maxim_codec.h | 6 +- drivers/sound/samsung-i2s.c | 6 +- drivers/sound/tegra_ahub.c | 2 +- drivers/sound/tegra_i2s_priv.h | 2 +- drivers/sound/wm8994.c | 14 +-- drivers/spi/ich.c | 4 +- drivers/spi/octeon_spi.c | 4 +- drivers/tpm/cr50_i2c.c | 2 +- drivers/tpm/sandbox_common.h | 2 +- drivers/tpm/tpm2_tis_spi.c | 2 +- drivers/tpm/tpm_atmel_twi.c | 2 +- drivers/usb/host/ehci.h | 2 +- drivers/usb/host/xhci-mem.c | 46 ++++----- drivers/usb/host/xhci-ring.c | 26 ++--- drivers/usb/host/xhci.c | 34 +++---- drivers/usb/musb-new/musb_gadget.c | 2 +- drivers/usb/musb-new/musb_gadget_ep0.c | 2 +- drivers/usb/musb-new/usb-compat.h | 2 +- drivers/video/bridge/ps862x.c | 2 +- drivers/video/console_truetype.c | 6 +- drivers/video/imx/ipu_common.c | 10 +- drivers/video/imx/ipu_disp.c | 6 +- drivers/video/imx/mxc_ipuv3_fb.c | 4 +- drivers/video/meson/simplefb_common.h | 2 +- drivers/video/panel-uclass.c | 2 +- drivers/video/rockchip/rk_hdmi.h | 6 +- drivers/video/rockchip/rk_vop.c | 2 +- drivers/video/rockchip/rk_vop.h | 4 +- drivers/video/sunxi/simplefb_common.h | 2 +- drivers/video/tegra.c | 2 +- drivers/video/ti/am335x-fb.c | 4 +- drivers/video/video_bmp.c | 2 +- drivers/video/videomodes.c | 2 +- drivers/virtio/virtio_pci_modern.c | 4 +- env/common.c | 6 +- fs/cbfs/cbfs.c | 10 +- fs/fat/fat.c | 8 +- include/abuf.h | 4 +- include/acpi/acpi_device.h | 22 ++--- include/acpi/acpi_dp.h | 26 ++--- include/acpi/acpi_s3.h | 2 +- include/acpi/acpi_table.h | 6 +- include/acpi/acpigen.h | 4 +- include/ahci.h | 12 +-- include/android_ab.h | 2 +- include/asm-generic/gpio.h | 56 +++++------ include/audio_codec.h | 2 +- include/autoboot.h | 6 +- include/backlight.h | 4 +- include/binman.h | 10 +- include/blk.h | 48 +++++----- include/boot_fit.h | 2 +- include/bootcount.h | 6 +- include/bootm.h | 6 +- include/bootretry.h | 2 +- include/bootstage.h | 16 ++-- include/button.h | 4 +- include/cache.h | 6 +- include/cbfs.h | 30 +++--- include/cli.h | 14 +-- include/clk.h | 46 ++++----- include/clk/sunxi.h | 2 +- include/command.h | 12 +-- include/compiler.h | 2 +- include/console.h | 14 +-- include/cpu_func.h | 2 +- include/cros_ec.h | 82 ++++++++-------- include/crypt.h | 2 +- include/display.h | 6 +- include/display_options.h | 4 +- include/dm/acpi.h | 14 +-- include/dm/device-internal.h | 22 ++--- include/dm/pci.h | 4 +- include/dm/test.h | 6 +- include/dm/uclass-internal.h | 26 ++--- include/dm/util.h | 2 +- include/dma.h | 24 ++--- include/dsi_host.h | 4 +- include/dwmmc.h | 4 +- include/edid.h | 10 +- include/efi_loader.h | 6 +- include/env.h | 50 +++++----- include/env_internal.h | 6 +- include/extension_board.h | 2 +- include/fdt_region.h | 8 +- include/fdt_support.h | 30 +++--- include/fdtdec.h | 94 +++++++++---------- include/fs.h | 16 ++-- include/fsl_ddr_sdram.h | 2 +- include/generic-phy.h | 40 ++++---- include/gzip.h | 10 +- include/handoff.h | 2 +- include/hash.h | 8 +- include/hda_codec.h | 18 ++-- include/hw_sha.h | 6 +- include/hwspinlock.h | 2 +- include/i2c.h | 42 ++++----- include/i2c_eeprom.h | 6 +- include/i2s.h | 4 +- include/ide.h | 2 +- include/image.h | 56 +++++------ include/input.h | 16 ++-- include/iotrace.h | 4 +- include/irq.h | 22 ++--- include/key_matrix.h | 4 +- include/lcd.h | 12 +-- include/led.h | 8 +- include/linux/clk-provider.h | 10 +- include/linux/string.h | 6 +- include/linux/zstd.h | 2 +- include/log.h | 2 +- include/mailbox-uclass.h | 4 +- include/mailbox.h | 10 +- include/memalign.h | 2 +- include/membuff.h | 30 +++--- include/menu.h | 2 +- include/miiphy.h | 4 +- include/mmc.h | 22 ++--- include/net.h | 14 +-- include/net/dsa.h | 8 +- include/net/pcap.h | 12 +-- include/ns16550.h | 4 +- include/of_live.h | 2 +- include/p2sb.h | 10 +- include/panel.h | 6 +- include/part.h | 38 ++++---- include/pch.h | 10 +- include/pci.h | 58 ++++++------ include/pci_ep.h | 28 +++--- include/pci_rom.h | 2 +- include/phy-sun4i-usb.h | 4 +- include/physmem.h | 2 +- include/power-domain.h | 14 +-- include/power/acpi_pmc.h | 10 +- include/power/pmic.h | 14 +-- include/power/regulator.h | 38 ++++---- include/pwm.h | 6 +- include/pxe_utils.h | 4 +- include/ram.h | 2 +- include/reboot-mode/reboot-mode.h | 2 +- include/relocate.h | 8 +- include/remoteproc.h | 34 +++---- include/reset.h | 28 +++--- include/rtc.h | 34 +++---- include/scmi_agent.h | 4 +- include/scsi.h | 4 +- include/sdhci.h | 4 +- include/search.h | 2 +- include/serial.h | 8 +- include/smbios.h | 4 +- include/smem.h | 6 +- include/sort.h | 2 +- include/sound.h | 6 +- include/spi.h | 14 +-- include/spi_flash.h | 10 +- include/spl.h | 24 ++--- include/spl_gpio.h | 6 +- include/spmi/spmi.h | 4 +- include/syscon.h | 10 +- include/test/suites.h | 2 +- include/test/ut.h | 20 ++-- include/time.h | 10 +- include/tmu.h | 4 +- include/tpm-common.h | 10 +- include/tpm-v1.h | 58 ++++++------ include/tpm-v2.h | 36 +++---- include/tpm_api.h | 58 ++++++------ include/tps6586x.h | 6 +- include/trace.h | 2 +- include/u-boot/crc.h | 10 +- include/u-boot/ecdsa.h | 2 +- include/u-boot/fdt-libcrypto.h | 2 +- include/u-boot/hash-checksum.h | 2 +- include/u-boot/lz4.h | 2 +- include/u-boot/rsa.h | 4 +- include/ufs.h | 6 +- include/usb.h | 26 ++--- include/usb/xhci.h | 4 +- include/usb_ether.h | 8 +- include/video.h | 24 ++--- include/video_bridge.h | 8 +- include/video_console.h | 18 ++-- include/video_osd.h | 8 +- include/virtio.h | 26 ++--- include/vsprintf.h | 24 ++--- include/wait_bit.h | 2 +- include/wdt.h | 2 +- lib/acpi/acpi_device.c | 8 +- lib/binman.c | 2 +- lib/efi/efi_app.c | 2 +- lib/efi/efi_stub.c | 2 +- lib/efi_loader/efi_acpi.c | 2 +- lib/efi_loader/efi_device_path.c | 6 +- lib/efi_loader/efi_device_path_to_text.c | 8 +- lib/efi_loader/efi_device_path_utilities.c | 16 ++-- lib/efi_loader/efi_memory.c | 4 +- lib/efi_loader/efi_smbios.c | 2 +- lib/efi_selftest/dtbdump.c | 2 +- lib/efi_selftest/efi_selftest.c | 6 +- lib/efi_selftest/efi_selftest_block_device.c | 12 +-- lib/efi_selftest/efi_selftest_controllers.c | 10 +- lib/efi_selftest/efi_selftest_exception.c | 2 +- lib/efi_selftest/efi_selftest_fdt.c | 2 +- lib/efi_selftest/efi_selftest_load_file.c | 2 +- lib/efi_selftest/efi_selftest_loadimage.c | 2 +- .../efi_selftest_miniapp_exception.c | 2 +- .../efi_selftest_miniapp_return.c | 2 +- .../efi_selftest_startimage_exit.c | 2 +- .../efi_selftest_startimage_return.c | 2 +- lib/efi_selftest/efi_selftest_tcg2.c | 18 ++-- lib/fdtdec.c | 4 +- lib/of_live.c | 2 +- lib/rsa/rsa-mod-exp.c | 4 +- lib/rsa/rsa-sign.c | 12 +-- lib/rsa/rsa-verify.c | 8 +- lib/strto.c | 2 +- lib/tpm-utils.h | 10 +- lib/zstd/bitstream.h | 8 +- lib/zstd/decompress.c | 6 +- net/eth_internal.h | 2 +- net/tftp.c | 2 +- scripts/dtc/libfdt/fdt_rw.c | 2 +- scripts/dtc/libfdt/libfdt.h | 4 +- scripts/dtc/srcpos.c | 4 +- scripts/dtc/srcpos.h | 2 +- scripts/dtc/util.h | 12 +-- test/compression.c | 2 +- test/dm/acpi.h | 4 +- test/dm/core.c | 2 +- test/dm/of_platdata.c | 2 +- test/dm/test-dm.c | 2 +- test/dm/video.c | 6 +- test/log/syslog_test.h | 4 +- test/test-main.c | 18 ++-- tools/fit_common.h | 4 +- tools/ifdtool.c | 18 ++-- tools/image-host.c | 4 +- tools/imagetool.h | 8 +- tools/rkcommon.h | 8 +- 524 files changed, 2505 insertions(+), 2505 deletions(-) diff --git a/arch/arm/cpu/armv7/s5p-common/timer.c b/arch/arm/cpu/armv7/s5p-common/timer.c index 8141f40d5c..8533d04878 100644 --- a/arch/arm/cpu/armv7/s5p-common/timer.c +++ b/arch/arm/cpu/armv7/s5p-common/timer.c @@ -37,7 +37,7 @@ static inline struct s5p_timer *s5p_get_base_timer(void) * This operates at 1MHz and counts downwards. It will wrap about every * hour (2^32 microseconds). * - * @return current value of timer + * Return: current value of timer */ static unsigned long timer_get_us_down(void) { diff --git a/arch/arm/include/asm/arch-aspeed/scu_ast2500.h b/arch/arm/include/asm/arch-aspeed/scu_ast2500.h index 8db4901cc9..50d6a6bc76 100644 --- a/arch/arm/include/asm/arch-aspeed/scu_ast2500.h +++ b/arch/arm/include/asm/arch-aspeed/scu_ast2500.h @@ -217,14 +217,14 @@ struct ast2500_scu { * ast_get_clk() - get a pointer to Clock Driver * * @devp, OUT - pointer to Clock Driver - * @return zero on success, error code (< 0) otherwise. + * Return: zero on success, error code (< 0) otherwise. */ int ast_get_clk(struct udevice **devp); /** * ast_get_scu() - get a pointer to SCU registers * - * @return pointer to struct ast2500_scu on success, ERR_PTR otherwise + * Return: pointer to struct ast2500_scu on success, ERR_PTR otherwise */ void *ast_get_scu(void); diff --git a/arch/arm/include/asm/arch-aspeed/wdt.h b/arch/arm/include/asm/arch-aspeed/wdt.h index fb04d41d3c..6fac7ffc1d 100644 --- a/arch/arm/include/asm/arch-aspeed/wdt.h +++ b/arch/arm/include/asm/arch-aspeed/wdt.h @@ -84,7 +84,7 @@ struct ast_wdt { * gets Reset Mode value from it. * * @flags: flags parameter passed into wdt_reset or wdt_start - * @return Reset Mode value + * Return: Reset Mode value */ u32 ast_reset_mode_from_flags(ulong flags); @@ -93,7 +93,7 @@ u32 ast_reset_mode_from_flags(ulong flags); * gets Reset Mask value from it. Reset Mask is only supported on ast2500 * * @flags: flags parameter passed into wdt_reset or wdt_start - * @return Reset Mask value + * Return: Reset Mask value */ u32 ast_reset_mask_from_flags(ulong flags); diff --git a/arch/arm/include/asm/arch-hi6220/pinmux.h b/arch/arm/include/asm/arch-hi6220/pinmux.h index b4a9957e80..d18d2142f6 100644 --- a/arch/arm/include/asm/arch-hi6220/pinmux.h +++ b/arch/arm/include/asm/arch-hi6220/pinmux.h @@ -74,7 +74,7 @@ struct hi6220_pinmux1_regs { * pull-up/down and drive strength. * * @param peripheral peripheral to be configured - * @return 0 if ok, -1 on error (e.g. unsupported peripheral) + * Return: 0 if ok, -1 on error (e.g. unsupported peripheral) */ int hi6220_pinmux_config(int peripheral); diff --git a/arch/arm/include/asm/arch-rockchip/clock.h b/arch/arm/include/asm/arch-rockchip/clock.h index 5108180ea7..566bdcc4fa 100644 --- a/arch/arm/include/asm/arch-rockchip/clock.h +++ b/arch/arm/include/asm/arch-rockchip/clock.h @@ -129,7 +129,7 @@ struct sysreset_reg { * * @input_rate: Input clock rate in Hz * @output_rate: Output clock rate in Hz - * @return divisor register value to use + * Return: divisor register value to use */ static inline u32 clk_get_divisor(ulong input_rate, uint output_rate) { @@ -144,14 +144,14 @@ static inline u32 clk_get_divisor(ulong input_rate, uint output_rate) /** * rockchip_get_cru() - get a pointer to the clock/reset unit registers * - * @return pointer to registers, or -ve error on error + * Return: pointer to registers, or -ve error on error */ void *rockchip_get_cru(void); /** * rockchip_get_pmucru() - get a pointer to the clock/reset unit registers * - * @return pointer to registers, or -ve error on error + * Return: pointer to registers, or -ve error on error */ void *rockchip_get_pmucru(void); @@ -168,7 +168,7 @@ int rockchip_get_clk(struct udevice **devp); * @pdev: clock udevice * @reg_offset: the first offset in cru for softreset registers * @reg_number: the reg numbers of softreset registers - * @return 0 success, or error value + * Return: 0 success, or error value */ int rockchip_reset_bind(struct udevice *pdev, u32 reg_offset, u32 reg_number); diff --git a/arch/arm/include/asm/arch-tegra/ap.h b/arch/arm/include/asm/arch-tegra/ap.h index de21dffa55..78aeb25ac7 100644 --- a/arch/arm/include/asm/arch-tegra/ap.h +++ b/arch/arm/include/asm/arch-tegra/ap.h @@ -42,21 +42,21 @@ extern void _start(void); /** * Works out the SOC/SKU type used for clocks settings * - * @return SOC type - see TEGRA_SOC... + * Return: SOC type - see TEGRA_SOC... */ int tegra_get_chip_sku(void); /** * Returns the pure SOC (chip ID) from the HIDREV register * - * @return SOC ID - see CHIPID_TEGRAxx... + * Return: SOC ID - see CHIPID_TEGRAxx... */ int tegra_get_chip(void); /** * Returns the SKU ID from the sku_info register * - * @return SKU ID - see SKU_ID_Txx... + * Return: SKU ID - see SKU_ID_Txx... */ int tegra_get_sku_info(void); diff --git a/arch/arm/include/asm/arch-tegra/clock.h b/arch/arm/include/asm/arch-tegra/clock.h index 1d80d9e946..6586015fd2 100644 --- a/arch/arm/include/asm/arch-tegra/clock.h +++ b/arch/arm/include/asm/arch-tegra/clock.h @@ -70,7 +70,7 @@ unsigned long clock_start_pll(enum clock_id id, u32 divm, u32 divn, * @param pllout pll output id * @param rate desired output rate * - * @return 0 if ok, -1 on error (invalid clock id or no suitable divider) + * Return: 0 if ok, -1 on error (invalid clock id or no suitable divider) */ int clock_set_pllout(enum clock_id clkid, enum pll_out_id pllout, unsigned rate); @@ -193,7 +193,7 @@ void clock_ll_set_source_divisor(enum periph_id periph_id, unsigned source, * specific knowledge of system-level clock tree structure. * * @param periph_id peripheral to query - * @return clock ID of the peripheral's current parent clock + * Return: clock ID of the peripheral's current parent clock */ enum clock_id clock_get_periph_parent(enum periph_id periph_id); @@ -204,7 +204,7 @@ enum clock_id clock_get_periph_parent(enum periph_id periph_id); * @param periph_id peripheral to start * @param parent PLL id of required parent clock * @param rate Required clock rate in Hz - * @return rate selected in Hz, or -1U if something went wrong + * Return: rate selected in Hz, or -1U if something went wrong */ unsigned clock_start_periph_pll(enum periph_id periph_id, enum clock_id parent, unsigned rate); @@ -217,7 +217,7 @@ unsigned clock_start_periph_pll(enum periph_id periph_id, * @param periph_id peripheral to start * @param parent PLL id of parent clock (used to calculate rate, you * must know this!) - * @return clock rate of peripheral in Hz + * Return: clock rate of peripheral in Hz */ unsigned long clock_get_periph_rate(enum periph_id periph_id, enum clock_id parent); @@ -233,7 +233,7 @@ unsigned long clock_get_periph_rate(enum periph_id periph_id, * @param rate Required clock rate in Hz * @param extra_div value for the second-stage divisor (NULL if one is not available) - * @return rate selected in Hz, or -1U if something went wrong + * Return: rate selected in Hz, or -1U if something went wrong */ unsigned clock_adjust_periph_pll_div(enum periph_id periph_id, enum clock_id parent, unsigned rate, int *extra_div); @@ -242,7 +242,7 @@ unsigned clock_adjust_periph_pll_div(enum periph_id periph_id, * Returns the clock rate of a specified clock, in Hz. * * @param parent PLL id of clock to check - * @return rate of clock in Hz + * Return: rate of clock in Hz */ unsigned clock_get_rate(enum clock_id clkid); @@ -265,21 +265,21 @@ void clock_ll_start_uart(enum periph_id periph_id); * * @param blob FDT blob to use * @param node Node to look at - * @return peripheral ID, or PERIPH_ID_NONE if none + * Return: peripheral ID, or PERIPH_ID_NONE if none */ int clock_decode_periph_id(struct udevice *dev); /** * Checks if the oscillator bypass is enabled (XOBP bit) * - * @return 1 if bypass is enabled, 0 if not + * Return: 1 if bypass is enabled, 0 if not */ int clock_get_osc_bypass(void); /* * Checks that clocks are valid and prints a warning if not * - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int clock_verify(void); @@ -310,7 +310,7 @@ struct clk_pll_simple *clock_get_simple_pll(enum clock_id clkid); * @param mux_bits Set to number of bits in mux register * @param divider_bits Set to the relevant MASK_BITS_* value * @param type Set to the SoC-specific clock type - * @return 0 on success, -1 on error + * Return: 0 on success, -1 on error */ int get_periph_clock_info(enum periph_id periph_id, int *mux_bits, int *divider_bits, int *type); @@ -324,7 +324,7 @@ int get_periph_clock_info(enum periph_id periph_id, int *mux_bits, * * @param periph_id peripheral to query * @param source raw clock source mux value - * @return the CLOCK_ID_* value @source represents + * Return: the CLOCK_ID_* value @source represents */ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source); @@ -338,7 +338,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source); * @param source PLL id of required parent clock * @param mux_bits Set to number of bits in mux register: 2 or 4 * @param divider_bits Set to number of divider bits (8 or 16) - * @return mux value (0-4, or -1 if not found) + * Return: mux value (0-4, or -1 if not found) */ int get_periph_clock_source(enum periph_id periph_id, enum clock_id parent, int *mux_bits, int *divider_bits); @@ -349,7 +349,7 @@ int get_periph_clock_source(enum periph_id periph_id, * provided. * * @param clk_id Clock ID according to tegra30 device tree binding - * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid + * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid */ enum periph_id clk_id_to_periph_id(int clk_id); @@ -367,7 +367,7 @@ enum periph_id clk_id_to_periph_id(int clk_id); * @param m PLL input divider(DIVN) * @param p post divider(DIVP) * @param cpcon base PLL charge pump(CPCON) - * @return 0 if ok, -1 on error (the requested PLL is incorrect and cannot + * Return: 0 if ok, -1 on error (the requested PLL is incorrect and cannot * be overridden), 1 if PLL is already correct */ int clock_set_rate(enum clock_id clkid, u32 n, u32 m, u32 p, u32 cpcon); @@ -416,7 +416,7 @@ extern struct periph_clk_init periph_clk_init_table[]; * Enable output clock for external peripherals * * @param clk_id Clock ID to output (1, 2 or 3) - * @return 0 if OK. -ve on error + * Return: 0 if OK. -ve on error */ int clock_external_output(int clk_id); diff --git a/arch/arm/include/asm/arch-tegra/funcmux.h b/arch/arm/include/asm/arch-tegra/funcmux.h index cf3ce3b411..ebef6ea1e8 100644 --- a/arch/arm/include/asm/arch-tegra/funcmux.h +++ b/arch/arm/include/asm/arch-tegra/funcmux.h @@ -21,7 +21,7 @@ * * @param id Peripheral id * @param config Configuration to use (FUNCMUX_...), 0 for default - * @return 0 if ok, -1 on error (e.g. incorrect id or config) + * Return: 0 if ok, -1 on error (e.g. incorrect id or config) */ int funcmux_select(enum periph_id id, int config); diff --git a/arch/arm/include/asm/arch-tegra/ivc.h b/arch/arm/include/asm/arch-tegra/ivc.h index 52c10b8fab..fef8b16845 100644 --- a/arch/arm/include/asm/arch-tegra/ivc.h +++ b/arch/arm/include/asm/arch-tegra/ivc.h @@ -88,7 +88,7 @@ struct tegra_ivc { * @ivc The IVC channel. * @frame Pointer to be filled with the address of the frame to receive. * - * @return 0 if a frame is available, else a negative error code. + * Return: 0 if a frame is available, else a negative error code. */ int tegra_ivc_read_get_next_frame(struct tegra_ivc *ivc, void **frame); @@ -102,7 +102,7 @@ int tegra_ivc_read_get_next_frame(struct tegra_ivc *ivc, void **frame); * * @ivc The IVC channel. * - * @return 0 if OK, else a negative error code. + * Return: 0 if OK, else a negative error code. */ int tegra_ivc_read_advance(struct tegra_ivc *ivc); @@ -116,7 +116,7 @@ int tegra_ivc_read_advance(struct tegra_ivc *ivc); * @ivc The IVC channel. * @frame Pointer to be filled with the address of the frame to fill. * - * @return 0 if a frame is available, else a negative error code. + * Return: 0 if a frame is available, else a negative error code. */ int tegra_ivc_write_get_next_frame(struct tegra_ivc *ivc, void **frame); @@ -130,7 +130,7 @@ int tegra_ivc_write_get_next_frame(struct tegra_ivc *ivc, void **frame); * * @ivc The IVC channel. * - * @return 0 if OK, else a negative error code. + * Return: 0 if OK, else a negative error code. */ int tegra_ivc_write_advance(struct tegra_ivc *ivc); @@ -141,7 +141,7 @@ int tegra_ivc_write_advance(struct tegra_ivc *ivc); * * @ivc The IVC channel. * - * @return 0 if the channel is ready for communication, or -EAGAIN if a + * Return: 0 if the channel is ready for communication, or -EAGAIN if a * channel reset is in progress. */ int tegra_ivc_channel_notified(struct tegra_ivc *ivc); @@ -167,7 +167,7 @@ void tegra_ivc_channel_reset(struct tegra_ivc *ivc); * @nframes Number of frames in each shared memory buffer. * @frame_size Size of each frame. * - * @return 0 if OK, else a negative error code. + * Return: 0 if OK, else a negative error code. */ int tegra_ivc_init(struct tegra_ivc *ivc, ulong rx_base, ulong tx_base, uint32_t nframes, uint32_t frame_size, diff --git a/arch/arm/include/asm/arch-tegra/sys_proto.h b/arch/arm/include/asm/arch-tegra/sys_proto.h index 62e1c7bcd1..c3a2673e6c 100644 --- a/arch/arm/include/asm/arch-tegra/sys_proto.h +++ b/arch/arm/include/asm/arch-tegra/sys_proto.h @@ -12,7 +12,7 @@ void invalidate_dcache(void); /** * tegra_board_id() - Get the board iD * - * @return a board ID, or -ve on error + * Return: a board ID, or -ve on error */ int tegra_board_id(void); @@ -20,14 +20,14 @@ int tegra_board_id(void); * tegra_lcd_pmic_init() - Set up the PMIC for a board * * @board_id: Board ID which may be used to select LCD type - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int tegra_lcd_pmic_init(int board_id); /** * nvidia_board_init() - perform any board-specific init * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int nvidia_board_init(void); diff --git a/arch/arm/include/asm/arch-tegra/tegra_i2c.h b/arch/arm/include/asm/arch-tegra/tegra_i2c.h index e57b9ef9c4..c49f43251d 100644 --- a/arch/arm/include/asm/arch-tegra/tegra_i2c.h +++ b/arch/arm/include/asm/arch-tegra/tegra_i2c.h @@ -150,7 +150,7 @@ struct i2c_ctlr { /** * Returns the bus number of the DVC controller * - * @return number of bus, or -1 if there is no DVC active + * Return: number of bus, or -1 if there is no DVC active */ int tegra_i2c_get_dvc_bus(struct udevice **busp); diff --git a/arch/arm/include/asm/arch-tegra/warmboot.h b/arch/arm/include/asm/arch-tegra/warmboot.h index 3f02073ee4..bfde4c30ac 100644 --- a/arch/arm/include/asm/arch-tegra/warmboot.h +++ b/arch/arm/include/asm/arch-tegra/warmboot.h @@ -121,7 +121,7 @@ union scratch3_reg { /** * Save warmboot memory settings for a later resume * - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int warmboot_save_sdram_params(void); diff --git a/arch/arm/include/asm/arch-tegra124/display.h b/arch/arm/include/asm/arch-tegra124/display.h index 47e0056dd6..ca3d57579e 100644 --- a/arch/arm/include/asm/arch-tegra124/display.h +++ b/arch/arm/include/asm/arch-tegra124/display.h @@ -16,14 +16,14 @@ * * @param blob Device tree blob * @param default_lcd_base Default address of LCD frame buffer - * @return 0 if ok, -1 on error (unsupported bits per pixel) + * Return: 0 if ok, -1 on error (unsupported bits per pixel) */ int tegra_display_probe(const void *blob, void *default_lcd_base); /** * Return the current display configuration * - * @return pointer to display configuration, or NULL if there is no valid + * Return: pointer to display configuration, or NULL if there is no valid * config */ struct fdt_disp_config *tegra_display_get_config(void); diff --git a/arch/arm/include/asm/arch-tegra20/emc.h b/arch/arm/include/asm/arch-tegra20/emc.h index 58ee08c9fe..65d0e34f41 100644 --- a/arch/arm/include/asm/arch-tegra20/emc.h +++ b/arch/arm/include/asm/arch-tegra20/emc.h @@ -81,7 +81,7 @@ struct emc_ctlr { * * @param blob Device tree blob * @param rate Clock speed of memory controller in Hz (=2x memory bus rate) - * @return 0 if ok, else -ve error code (look in emc.c to decode it) + * Return: 0 if ok, else -ve error code (look in emc.c to decode it) */ int tegra_set_emc(const void *blob, unsigned rate); @@ -89,7 +89,7 @@ int tegra_set_emc(const void *blob, unsigned rate); * Get a pointer to the EMC controller from the device tree. * * @param blob Device tree blob - * @return pointer to EMC controller + * Return: pointer to EMC controller */ struct emc_ctlr *emc_get_controller(const void *blob); diff --git a/arch/arm/include/asm/omap_gpio.h b/arch/arm/include/asm/omap_gpio.h index 4084210021..590a93761c 100644 --- a/arch/arm/include/asm/omap_gpio.h +++ b/arch/arm/include/asm/omap_gpio.h @@ -43,7 +43,7 @@ extern const struct gpio_bank *const omap_gpio_bank; * Check if gpio is valid. * * @param gpio GPIO number - * @return 1 if ok, 0 on error + * Return: 1 if ok, 0 on error */ int gpio_is_valid(int gpio); #endif diff --git a/arch/arm/mach-bcm283x/include/mach/msg.h b/arch/arm/mach-bcm283x/include/mach/msg.h index e45c1bf010..eb3da93cc2 100644 --- a/arch/arm/mach-bcm283x/include/mach/msg.h +++ b/arch/arm/mach-bcm283x/include/mach/msg.h @@ -10,7 +10,7 @@ * bcm2835_power_on_module() - power on an SoC module * * @module: ID of module to power on (BCM2835_MBOX_POWER_DEVID_...) - * @return 0 if OK, -EIO on error + * Return: 0 if OK, -EIO on error */ int bcm2835_power_on_module(u32 module); @@ -18,7 +18,7 @@ int bcm2835_power_on_module(u32 module); * bcm2835_get_mmc_clock() - get the frequency of the MMC clock * * @clock_id: ID of clock to get frequency for - * @return clock frequency, or -ve on error + * Return: clock frequency, or -ve on error */ int bcm2835_get_mmc_clock(u32 clock_id); @@ -27,7 +27,7 @@ int bcm2835_get_mmc_clock(u32 clock_id); * * @widthp: Returns the width in pixels * @heightp: Returns the height in pixels - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int bcm2835_get_video_size(int *widthp, int *heightp); @@ -42,7 +42,7 @@ int bcm2835_get_video_size(int *widthp, int *heightp); * @fb_basep: Returns base address of frame buffer * @fb_sizep: Returns size of frame buffer * @pitchp: Returns number of bytes in each frame buffer line - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int bcm2835_set_video_params(int *widthp, int *heightp, int depth_bpp, int pixel_order, int alpha_mode, ulong *fb_basep, @@ -51,7 +51,7 @@ int bcm2835_set_video_params(int *widthp, int *heightp, int depth_bpp, /** * bcm2711_load_vl805_firmware() - get vl805's firmware loaded * - * @return 0 if OK, -EIO on error + * Return: 0 if OK, -EIO on error */ int bcm2711_notify_vl805_reset(void); diff --git a/arch/arm/mach-exynos/clock.c b/arch/arm/mach-exynos/clock.c index 99bca549b6..f91f2ee862 100644 --- a/arch/arm/mach-exynos/clock.c +++ b/arch/arm/mach-exynos/clock.c @@ -1403,7 +1403,7 @@ int exynos5_set_i2s_clk_prescaler(unsigned int src_frq, * @param target_freq Desired clock frequency in Hz * @param best_fine_scalar Pointer to store the fine stage divisor * - * @return best_main_scalar Main scalar for desired frequency or -1 if none + * Return: best_main_scalar Main scalar for desired frequency or -1 if none * found */ static int clock_calc_best_scalar(unsigned int main_scaler_bits, diff --git a/arch/arm/mach-exynos/clock_init.h b/arch/arm/mach-exynos/clock_init.h index a4d3fdae85..8664f10df4 100644 --- a/arch/arm/mach-exynos/clock_init.h +++ b/arch/arm/mach-exynos/clock_init.h @@ -141,7 +141,7 @@ struct mem_timings { * * This function can be called from SPL or the main U-Boot. * - * @return pointer to the memory timings that we should use + * Return: pointer to the memory timings that we should use */ struct mem_timings *clock_get_mem_timings(void); diff --git a/arch/arm/mach-exynos/common_setup.h b/arch/arm/mach-exynos/common_setup.h index 4e3702b928..d7f02231fd 100644 --- a/arch/arm/mach-exynos/common_setup.h +++ b/arch/arm/mach-exynos/common_setup.h @@ -40,7 +40,7 @@ void system_clock_init(void); /* * Init subsystems according to the reset status * - * @return 0 for a normal boot, non-zero for a resume + * Return: 0 for a normal boot, non-zero for a resume */ int do_lowlevel_init(void); diff --git a/arch/arm/mach-exynos/dmc_init_ddr3.c b/arch/arm/mach-exynos/dmc_init_ddr3.c index 18c558f92a..fa867f27f3 100644 --- a/arch/arm/mach-exynos/dmc_init_ddr3.c +++ b/arch/arm/mach-exynos/dmc_init_ddr3.c @@ -253,7 +253,7 @@ static const unsigned int test_pattern[] = { * @param ch DMC channel number * @param byte_lane which DQS byte offset, * possible values are 0,1,2,3 - * @return TRUE if memory was good, FALSE if not. + * Return: TRUE if memory was good, FALSE if not. */ static bool dmc_valid_window_test_vector(int ch, int byte_lane) { @@ -323,7 +323,7 @@ static void dmc_set_read_offset_value(struct exynos5420_phy_control *phy_ctrl, * representations of 0. * * @param b The byte to convert in two's complement. - * @return The 7-bit value + sign bit. + * Return: The 7-bit value + sign bit. */ unsigned char make_signed_byte(signed char b) diff --git a/arch/arm/mach-exynos/exynos5_setup.h b/arch/arm/mach-exynos/exynos5_setup.h index bf4cca9e19..af7a5afb03 100644 --- a/arch/arm/mach-exynos/exynos5_setup.h +++ b/arch/arm/mach-exynos/exynos5_setup.h @@ -898,7 +898,7 @@ enum { * * @param mem Memory timings for this memory type. * @param reset Reset DDR PHY during initialization. - * @return 0 if ok, SETUP_ERR_... if there is a problem + * Return: 0 if ok, SETUP_ERR_... if there is a problem */ int ddr3_mem_ctrl_init(struct mem_timings *mem, int reset); @@ -913,7 +913,7 @@ void lpddr3_mem_ctrl_init(void); * @param phy1_con16 Register address for dmc_phy1->phy_con16 * @param phy0_con17 Register address for dmc_phy0->phy_con17 * @param phy1_con17 Register address for dmc_phy1->phy_con17 - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int dmc_config_zq(struct mem_timings *mem, uint32_t *phy0_con16, uint32_t *phy1_con16, uint32_t *phy0_con17, diff --git a/arch/arm/mach-exynos/include/mach/clk.h b/arch/arm/mach-exynos/include/mach/clk.h index 298535dc86..cf8db2109c 100644 --- a/arch/arm/mach-exynos/include/mach/clk.h +++ b/arch/arm/mach-exynos/include/mach/clk.h @@ -55,7 +55,7 @@ int set_spi_clk(int periph_id, unsigned int rate); * * @param peripheral Peripheral id * - * @return frequency of the peripheral clk + * Return: frequency of the peripheral clk */ unsigned long clock_get_periph_rate(int peripheral); diff --git a/arch/arm/mach-exynos/include/mach/pinmux.h b/arch/arm/mach-exynos/include/mach/pinmux.h index bd1ad5f1a1..5ef04e711e 100644 --- a/arch/arm/mach-exynos/include/mach/pinmux.h +++ b/arch/arm/mach-exynos/include/mach/pinmux.h @@ -37,7 +37,7 @@ enum { * * @param peripheral peripheral to be configured * @param flags configure flags - * @return 0 if ok, -1 on error (e.g. unsupported peripheral) + * Return: 0 if ok, -1 on error (e.g. unsupported peripheral) */ int exynos_pinmux_config(int peripheral, int flags); @@ -46,7 +46,7 @@ int exynos_pinmux_config(int peripheral, int flags); * * @param blob Device tree blob * @param node FDT I2C node to find - * @return peripheral id if ok, PERIPH_ID_NONE on error + * Return: peripheral id if ok, PERIPH_ID_NONE on error */ int pinmux_decode_periph_id(const void *blob, int node); #endif diff --git a/arch/arm/mach-exynos/include/mach/spl.h b/arch/arm/mach-exynos/include/mach/spl.h index 9d642461bd..816c85217e 100644 --- a/arch/arm/mach-exynos/include/mach/spl.h +++ b/arch/arm/mach-exynos/include/mach/spl.h @@ -62,7 +62,7 @@ struct spl_machine_param { * Validate signature and return a pointer to the parameter table. If the * signature is invalid, call panic() and never return. * - * @return pointer to the parameter table if signature matched or never return. + * Return: pointer to the parameter table if signature matched or never return. */ struct spl_machine_param *spl_get_machine_params(void); diff --git a/arch/arm/mach-imx/ddrmc-vf610-calibration.h b/arch/arm/mach-imx/ddrmc-vf610-calibration.h index e82e217ab3..56fffe1534 100644 --- a/arch/arm/mach-imx/ddrmc-vf610-calibration.h +++ b/arch/arm/mach-imx/ddrmc-vf610-calibration.h @@ -38,7 +38,7 @@ enum edge { * * @param ddrmr_regs - memory controller registers * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ int ddrmc_calibration(struct ddrmr_regs *ddrmr); diff --git a/arch/arm/mach-s5pc1xx/include/mach/pinmux.h b/arch/arm/mach-s5pc1xx/include/mach/pinmux.h index 075cdce3c1..9447a4950b 100644 --- a/arch/arm/mach-s5pc1xx/include/mach/pinmux.h +++ b/arch/arm/mach-s5pc1xx/include/mach/pinmux.h @@ -34,7 +34,7 @@ enum { * * @param peripheral peripheral to be configured * @param flags configure flags - * @return 0 if ok, -1 on error (e.g. unsupported peripheral) + * Return: 0 if ok, -1 on error (e.g. unsupported peripheral) */ int exynos_pinmux_config(int peripheral, int flags); @@ -43,7 +43,7 @@ int exynos_pinmux_config(int peripheral, int flags); * * @param blob Device tree blob * @param node FDT I2C node to find - * @return peripheral id if ok, PERIPH_ID_NONE on error + * Return: peripheral id if ok, PERIPH_ID_NONE on error */ int pinmux_decode_periph_id(const void *blob, int node); #endif diff --git a/arch/arm/mach-stm32mp/cmd_stm32prog/stm32prog_serial.c b/arch/arm/mach-stm32mp/cmd_stm32prog/stm32prog_serial.c index 7de62668fe..2932eae757 100644 --- a/arch/arm/mach-stm32mp/cmd_stm32prog/stm32prog_serial.c +++ b/arch/arm/mach-stm32mp/cmd_stm32prog/stm32prog_serial.c @@ -366,7 +366,7 @@ static u8 stm32prog_start(struct stm32prog_data *data, u32 address) * get_address() - Get address if it is valid * * @tmp_xor: Current xor value to update - * @return The address area + * Return: The address area */ static u32 get_address(u8 *tmp_xor) { @@ -791,7 +791,7 @@ error: * stm32prog_serial_loop() - USART bootloader Loop routine * * @data: Current command context - * @return true if reset is needed after loop + * Return: true if reset is needed after loop */ bool stm32prog_serial_loop(struct stm32prog_data *data) { diff --git a/arch/arm/mach-tegra/clock.c b/arch/arm/mach-tegra/clock.c index 18c19dbf60..77c8ad978e 100644 --- a/arch/arm/mach-tegra/clock.c +++ b/arch/arm/mach-tegra/clock.c @@ -243,7 +243,7 @@ void clock_ll_set_source(enum periph_id periph_id, unsigned source) * @param divider_bits number of divider bits (8 or 16) * @param parent_rate clock rate of parent clock in Hz * @param rate required clock rate for this clock - * @return divider which should be used + * Return: divider which should be used */ static int clk_get_divider(unsigned divider_bits, unsigned long parent_rate, unsigned long rate) @@ -297,7 +297,7 @@ int clock_set_pllout(enum clock_id clkid, enum pll_out_id pllout, unsigned rate) * * @param parent_rate clock rate of parent clock in Hz * @param divider which should be used in 7.1 format - * @return effective clock rate of peripheral + * Return: effective clock rate of peripheral */ static unsigned long get_rate_from_divider(unsigned long parent_rate, int divider) @@ -365,7 +365,7 @@ unsigned long clock_get_periph_rate(enum periph_id periph_id, * @param rate required clock rate for this clock * @param extra_div value for the second-stage divisor (not set if this * function returns -1. - * @return divider which should be used, or -1 if nothing is valid + * Return: divider which should be used, or -1 if nothing is valid * */ static int find_best_divider(unsigned divider_bits, unsigned long parent_rate, @@ -403,7 +403,7 @@ static int find_best_divider(unsigned divider_bits, unsigned long parent_rate, * @param source Source number (0-3 or 0-7) * @param mux_bits Number of mux bits (2 or 4) * @param divider Required divider in 7.1 or 15.1 format - * @return 0 if ok, -1 on error (requesting a parent clock which is not valid + * Return: 0 if ok, -1 on error (requesting a parent clock which is not valid * for this peripheral) */ static int adjust_periph_pll(enum periph_id periph_id, int source, @@ -586,7 +586,7 @@ unsigned clock_get_rate(enum clock_id clkid) * @param m PLL input divider(DIVN) * @param p post divider(DIVP) * @param cpcon base PLL charge pump(CPCON) - * @return 0 if ok, -1 on error (the requested PLL is incorrect and cannot + * Return: 0 if ok, -1 on error (the requested PLL is incorrect and cannot * be overridden), 1 if PLL is already correct */ int clock_set_rate(enum clock_id clkid, u32 n, u32 m, u32 p, u32 cpcon) diff --git a/arch/arm/mach-tegra/tegra114/clock.c b/arch/arm/mach-tegra/tegra114/clock.c index 167589d1bb..703a2314e7 100644 --- a/arch/arm/mach-tegra/tegra114/clock.c +++ b/arch/arm/mach-tegra/tegra114/clock.c @@ -553,7 +553,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source) * @param source PLL id of required parent clock * @param mux_bits Set to number of bits in mux register: 2 or 4 * @param divider_bits Set to number of divider bits (8 or 16) - * @return mux value (0-4, or -1 if not found) + * Return: mux value (0-4, or -1 if not found) */ int get_periph_clock_source(enum periph_id periph_id, enum clock_id parent, int *mux_bits, int *divider_bits) @@ -623,7 +623,7 @@ void reset_set_enable(enum periph_id periph_id, int enable) * provided. * * @param clk_id Clock ID according to tegra114 device tree binding - * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid + * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid */ enum periph_id clk_id_to_periph_id(int clk_id) { diff --git a/arch/arm/mach-tegra/tegra124/clock.c b/arch/arm/mach-tegra/tegra124/clock.c index 79e67f5194..bbfe184652 100644 --- a/arch/arm/mach-tegra/tegra124/clock.c +++ b/arch/arm/mach-tegra/tegra124/clock.c @@ -699,7 +699,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source) * @param source PLL id of required parent clock * @param mux_bits Set to number of bits in mux register: 2 or 4 * @param divider_bits Set to number of divider bits (8 or 16) - * @return mux value (0-4, or -1 if not found) + * Return: mux value (0-4, or -1 if not found) */ int get_periph_clock_source(enum periph_id periph_id, enum clock_id parent, int *mux_bits, int *divider_bits) @@ -773,7 +773,7 @@ void reset_set_enable(enum periph_id periph_id, int enable) * provided. * * @param clk_id Clock ID according to tegra124 device tree binding - * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid + * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid */ enum periph_id clk_id_to_periph_id(int clk_id) { @@ -899,7 +899,7 @@ void clock_early_init(void) * Check a register that we set up to see if clock_early_init() has already * been called. * - * @return true if clock_early_init() was called, false if not + * Return: true if clock_early_init() was called, false if not */ bool clock_early_init_done(void) { diff --git a/arch/arm/mach-tegra/tegra20/clock.c b/arch/arm/mach-tegra/tegra20/clock.c index 24e8a13b1f..3b50a81194 100644 --- a/arch/arm/mach-tegra/tegra20/clock.c +++ b/arch/arm/mach-tegra/tegra20/clock.c @@ -476,7 +476,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source) * @param source PLL id of required parent clock * @param mux_bits Set to number of bits in mux register: 2 or 4 * @param divider_bits Set to number of divider bits (8 or 16) - * @return mux value (0-4, or -1 if not found) + * Return: mux value (0-4, or -1 if not found) */ int get_periph_clock_source(enum periph_id periph_id, enum clock_id parent, int *mux_bits, int *divider_bits) @@ -548,7 +548,7 @@ void reset_set_enable(enum periph_id periph_id, int enable) * provided. * * @param clk_id Clock ID according to tegra20 device tree binding - * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid + * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid */ enum periph_id clk_id_to_periph_id(int clk_id) { diff --git a/arch/arm/mach-tegra/tegra20/emc.c b/arch/arm/mach-tegra/tegra20/emc.c index d55b09b4ac..fb5e699c94 100644 --- a/arch/arm/mach-tegra/tegra20/emc.c +++ b/arch/arm/mach-tegra/tegra20/emc.c @@ -113,7 +113,7 @@ enum { * @param blob Device tree blob * @param node EMC node (nvidia,tegra20-emc compatible string) * @param ram_code RAM code to select (0-3, or -1 if unknown) - * @return 0 if ok, otherwise a -ve ERR_ code (see enum above) + * Return: 0 if ok, otherwise a -ve ERR_ code (see enum above) */ static int find_emc_tables(const void *blob, int node, int ram_code) { @@ -167,7 +167,7 @@ static int find_emc_tables(const void *blob, int node, int ram_code) * @param tablep Returns pointer to table to program into EMC. There are * TEGRA_EMC_NUM_REGS entries, destined for offsets as per the * emc_reg_addr array. - * @return 0 if ok, otherwise a -ve error code which will allow someone to + * Return: 0 if ok, otherwise a -ve error code which will allow someone to * figure out roughly what went wrong by looking at this code. */ static int decode_emc(const void *blob, unsigned rate, struct emc_ctlr **emcp, diff --git a/arch/arm/mach-tegra/tegra210/clock.c b/arch/arm/mach-tegra/tegra210/clock.c index ccc64eb77b..10c2478df7 100644 --- a/arch/arm/mach-tegra/tegra210/clock.c +++ b/arch/arm/mach-tegra/tegra210/clock.c @@ -791,7 +791,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source) * @param source PLL id of required parent clock * @param mux_bits Set to number of bits in mux register: 2 or 4 * @param divider_bits Set to number of divider bits (8 or 16) - * @return mux value (0-4, or -1 if not found) + * Return: mux value (0-4, or -1 if not found) */ int get_periph_clock_source(enum periph_id periph_id, enum clock_id parent, int *mux_bits, int *divider_bits) @@ -871,7 +871,7 @@ void reset_set_enable(enum periph_id periph_id, int enable) * provided. * * @param clk_id Clock ID according to tegra210 device tree binding - * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid + * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid */ enum periph_id clk_id_to_periph_id(int clk_id) { diff --git a/arch/arm/mach-tegra/tegra30/clock.c b/arch/arm/mach-tegra/tegra30/clock.c index b0641c6a41..c835cd0d47 100644 --- a/arch/arm/mach-tegra/tegra30/clock.c +++ b/arch/arm/mach-tegra/tegra30/clock.c @@ -533,7 +533,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source) * @param source PLL id of required parent clock * @param mux_bits Set to number of bits in mux register: 2 or 4 * @param divider_bits Set to number of divider bits (8 or 16) - * @return mux value (0-4, or -1 if not found) + * Return: mux value (0-4, or -1 if not found) */ int get_periph_clock_source(enum periph_id periph_id, enum clock_id parent, int *mux_bits, int *divider_bits) @@ -603,7 +603,7 @@ void reset_set_enable(enum periph_id periph_id, int enable) * provided. * * @param clk_id Clock ID according to tegra30 device tree binding - * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid + * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid */ enum periph_id clk_id_to_periph_id(int clk_id) { diff --git a/arch/microblaze/include/asm/microblaze_intc.h b/arch/microblaze/include/asm/microblaze_intc.h index 1434be8756..a7e8715851 100644 --- a/arch/microblaze/include/asm/microblaze_intc.h +++ b/arch/microblaze/include/asm/microblaze_intc.h @@ -30,7 +30,7 @@ struct irq_action { * @param irq IRQ number * @param hdlr Interrupt handler rutine * @param arg Pointer to argument which is passed to int. handler rutine - * @return 0 if registration pass, 1 if unregistration pass, + * Return: 0 if registration pass, 1 if unregistration pass, * or an error code < 0 otherwise */ int install_interrupt_handler(int irq, interrupt_handler_t *hdlr, diff --git a/arch/mips/mach-octeon/bootoctlinux.c b/arch/mips/mach-octeon/bootoctlinux.c index 349da08da6..2c583b8b83 100644 --- a/arch/mips/mach-octeon/bootoctlinux.c +++ b/arch/mips/mach-octeon/bootoctlinux.c @@ -154,7 +154,7 @@ static struct cvmx_bootinfo cvmx_bootinfo_array[CVMX_MIPS_MAX_CORES]; * 16 dwords. * @param num_words Number of data dwords (up to 32) * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ static int octeon_set_moveable_region(u32 base, int region_num, bool enable, const u64 *data, @@ -219,7 +219,7 @@ static int octeon_set_moveable_region(u32 base, int region_num, * @param[in] str string to parse * @param base 0 for auto, otherwise 8, 10 or 16 for the number base * - * @return number of values read. + * Return: number of values read. */ static int octeon_parse_nodes(u64 values[CVMX_MAX_NODES], const char *str, int base) @@ -246,7 +246,7 @@ static int octeon_parse_nodes(u64 values[CVMX_MAX_NODES], * @param cmd command type * @param[out] boot_args parsed values * - * @return number of arguments parsed + * Return: number of arguments parsed */ int octeon_parse_bootopts(int argc, char *const argv[], enum octeon_boot_cmd_type cmd, diff --git a/arch/mips/mach-octeon/cpu.c b/arch/mips/mach-octeon/cpu.c index f56beb8964..6cfcc3eae0 100644 --- a/arch/mips/mach-octeon/cpu.c +++ b/arch/mips/mach-octeon/cpu.c @@ -89,7 +89,7 @@ int mach_cpu_init(void) /** * Returns number of cores * - * @return number of CPU cores for the specified node + * Return: number of CPU cores for the specified node */ static int cavm_octeon_num_cores(void) { diff --git a/arch/mips/mach-octeon/cvmx-bootmem.c b/arch/mips/mach-octeon/cvmx-bootmem.c index 12695df9bc..9bd644d68b 100644 --- a/arch/mips/mach-octeon/cvmx-bootmem.c +++ b/arch/mips/mach-octeon/cvmx-bootmem.c @@ -107,7 +107,7 @@ static u64 cvmx_bootmem_desc_addr; * accessed. * @param size Size of the structure member. * - * @return Value of the structure member promoted into a u64. + * Return: Value of the structure member promoted into a u64. */ static inline u64 __cvmx_bootmem_desc_get(u64 base, int offset, int size) @@ -153,7 +153,7 @@ static inline void __cvmx_bootmem_desc_set(u64 base, int offset, int size, /** * This function returns the address of the bootmem descriptor lock. * - * @return 64-bit address in KSEG0 of the bootmem descriptor block + * Return: 64-bit address in KSEG0 of the bootmem descriptor block */ static inline u64 __cvmx_bootmem_get_lock_addr(void) { @@ -275,7 +275,7 @@ static u64 cvmx_bootmem_phy_get_next(u64 addr) * Exact major version to check against. A zero means * check that the version supports named blocks. * - * @return Zero if the version is correct. Negative if the version is + * Return: Zero if the version is correct. Negative if the version is * incorrect. Failures also cause a message to be displayed. */ static int __cvmx_bootmem_check_version(int exact_match) @@ -525,7 +525,7 @@ int cvmx_bootmem_free_named(const char *name) * * @param name is the block name * @param flags indicates the need to use locking during search - * @return pointer to named block descriptor + * Return: pointer to named block descriptor * * Note: this function returns a pointer to a static structure, * and is therefore not re-entrant. diff --git a/arch/mips/mach-octeon/cvmx-coremask.c b/arch/mips/mach-octeon/cvmx-coremask.c index ed673e4993..c3d6f7e0d1 100644 --- a/arch/mips/mach-octeon/cvmx-coremask.c +++ b/arch/mips/mach-octeon/cvmx-coremask.c @@ -96,7 +96,7 @@ static int convert_ciu_fuse_to_physical_core(int core, int max_cores) * @param num_tads number of tads * @param max_cores maximum number of cores * - * @return void + * Return: void */ void fill_tad_corecount(u64 coremask, int tad_blown_count[], int num_tads, int max_cores) @@ -132,7 +132,7 @@ u64 get_core_pattern(int num_tads, int max_cores) * CIU_FUSE register value. For other models there is no difference. * * @param ciu_fuse_value fuse value from CIU_FUSE register - * @return logical coremask of CIU_FUSE value. + * Return: logical coremask of CIU_FUSE value. */ u64 get_logical_coremask(u64 ciu_fuse_value) { @@ -173,7 +173,7 @@ u64 get_logical_coremask(u64 ciu_fuse_value) * If the fuses are blown and locked, they are the definitive coremask. * * @param pcm pointer to coremask to fill in - * @return pointer to coremask + * Return: pointer to coremask */ struct cvmx_coremask *octeon_get_available_coremask(struct cvmx_coremask *pcm) { diff --git a/arch/mips/mach-octeon/cvmx-helper-cfg.c b/arch/mips/mach-octeon/cvmx-helper-cfg.c index 6b7dd8ac4d..494108f0cd 100644 --- a/arch/mips/mach-octeon/cvmx-helper-cfg.c +++ b/arch/mips/mach-octeon/cvmx-helper-cfg.c @@ -206,7 +206,7 @@ uint64_t cvmx_helper_cfg_opt_get(cvmx_helper_cfg_option_t opt) * initialize the queue allocation list. the existing static allocation result * is used as a starting point to ensure backward compatibility. * - * @return 0 on success + * Return: 0 on success * -1 on failure */ int cvmx_pko_queue_grp_alloc(u64 start, uint64_t end, uint64_t count) @@ -333,7 +333,7 @@ int init_cvmx_pko_que_range(void) * @param port the port for which the queues are requested * @param count the number of queues requested * - * @return 0 on success + * Return: 0 on success * -1 on failure */ static int cvmx_pko_queue_alloc(u64 port, int count) @@ -381,7 +381,7 @@ static int cvmx_pko_queue_alloc(u64 port, int count) * * @param port the port for which the queues are returned * - * @return 0 on success + * Return: 0 on success * -1 on failure */ int cvmx_pko_queue_free(uint64_t port) @@ -730,7 +730,7 @@ int cvmx_helper_cfg_ipd2pko_port_num(int ipd_port) * Return the number of queues to be assigned to this pko_port * * @param pko_port - * @return the number of queues for this pko_port + * Return: the number of queues for this pko_port * */ static int cvmx_helper_cfg_dft_nqueues(int pko_port) @@ -815,7 +815,7 @@ static int cvmx_helper_cfg_init_pko_iports_and_queues_using_static_config(void) * @param xiface interface to check * @param index port index in the interface * - * @return status of the port present or not. + * Return: status of the port present or not. */ int cvmx_helper_is_port_valid(int xiface, int index) { @@ -1325,7 +1325,7 @@ void cvmx_helper_set_port_fdt_node_offset(int xiface, int index, int node_offset * * @param xiface node and interface * @param index port index - * @return node offset of port or -1 if invalid + * Return: node offset of port or -1 if invalid */ int cvmx_helper_get_port_fdt_node_offset(int xiface, int index) { @@ -1343,7 +1343,7 @@ int cvmx_helper_get_port_fdt_node_offset(int xiface, int index) * @param[out] xiface xinterface of match * @param[out] index port index of match * - * @return 0 if found, -1 if not found + * Return: 0 if found, -1 if not found */ int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xiface, int *index) { @@ -1392,7 +1392,7 @@ void cvmx_helper_set_phy_fdt_node_offset(int xiface, int index, int node_offset) * * @param xiface node and interface * @param index port index - * @return node offset of phy or -1 if invalid + * Return: node offset of phy or -1 if invalid */ int cvmx_helper_get_phy_fdt_node_offset(int xiface, int index) { @@ -1428,7 +1428,7 @@ void cvmx_helper_set_port_autonegotiation(int xiface, int index, bool enable) * @param xiface node and interface * @param index port index * - * @return 0 if autonegotiation is disabled, 1 if enabled. + * Return: 0 if autonegotiation is disabled, 1 if enabled. */ bool cvmx_helper_get_port_autonegotiation(int xiface, int index) { @@ -1463,7 +1463,7 @@ void cvmx_helper_set_port_fec(int xiface, int index, bool enable) * @param xiface node and interface * @param index port index * - * @return false if fec is disabled, true if enabled. + * Return: false if fec is disabled, true if enabled. */ bool cvmx_helper_get_port_fec(int xiface, int index) { @@ -1653,7 +1653,7 @@ void cvmx_helper_set_port_phy_info(int xiface, int index, struct cvmx_phy_info * * @param xiface node and interface * @param index port index * - * @return pointer to PHY information data structure or NULL if not set + * Return: pointer to PHY information data structure or NULL if not set */ struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index) { @@ -1671,7 +1671,7 @@ struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index) * @param xiface node and interface * @param index portindex * - * @return pointer to the PHY LED information data structure or NULL if not + * Return: pointer to the PHY LED information data structure or NULL if not * present */ struct cvmx_phy_gpio_leds *cvmx_helper_get_port_phy_leds(int xiface, int index) @@ -1750,7 +1750,7 @@ void cvmx_helper_cfg_get_rgmii_tx_clk_delay(int xiface, int index, bool *bypass, * @param xiface node and interface * @param index port index * - * @return offset in device tree or -1 if error or not defined. + * Return: offset in device tree or -1 if error or not defined. */ int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index) { @@ -1785,7 +1785,7 @@ void cvmx_helper_cfg_set_sfp_fdt_offset(int xiface, int index, int sfp_of_offset * @param xiface node and interface * @param index port index * - * @return pointer to vsc7224 data structure or NULL if not present + * Return: pointer to vsc7224 data structure or NULL if not present */ struct cvmx_vsc7224_chan *cvmx_helper_cfg_get_vsc7224_chan_info(int xiface, int index) { @@ -1820,7 +1820,7 @@ void cvmx_helper_cfg_set_vsc7224_chan_info(int xiface, int index, * @param xiface node and interface * @param index port index * - * @return pointer to avsp5410 data structure or NULL if not present + * Return: pointer to avsp5410 data structure or NULL if not present */ struct cvmx_avsp5410 *cvmx_helper_cfg_get_avsp5410_info(int xiface, int index) { @@ -1853,7 +1853,7 @@ void cvmx_helper_cfg_set_avsp5410_info(int xiface, int index, struct cvmx_avsp54 * @param xiface node and interface * @param index port index * - * @return pointer to SFP data structure or NULL if none + * Return: pointer to SFP data structure or NULL if none */ struct cvmx_fdt_sfp_info *cvmx_helper_cfg_get_sfp_info(int xiface, int index) { diff --git a/arch/mips/mach-octeon/cvmx-helper-fdt.c b/arch/mips/mach-octeon/cvmx-helper-fdt.c index 87bc6d2adc..3177dfb6e5 100644 --- a/arch/mips/mach-octeon/cvmx-helper-fdt.c +++ b/arch/mips/mach-octeon/cvmx-helper-fdt.c @@ -54,7 +54,7 @@ struct mux_compat { * * @param size number of bytes to allocate * - * @return pointer to allocated memory or NULL if out of memory. + * Return: pointer to allocated memory or NULL if out of memory. * Alignment is set to 8-bytes. */ void *__cvmx_fdt_alloc(size_t size) @@ -85,7 +85,7 @@ void __cvmx_fdt_free(void *ptr, size_t size) * @param[in,out] lenp Number of phandles, input max number * @param[out] nodes Array of phandle nodes * - * @return -ve error code on error or 0 for success + * Return: -ve error code on error or 0 for success */ int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, const char *prop_name, int *lenp, @@ -116,7 +116,7 @@ int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, * @param[in] fdt_addr Address of FDT * @param node FDT node number * - * @return CPU node number or error if negative + * Return: CPU node number or error if negative */ int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node) { @@ -147,7 +147,7 @@ int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node) * * @param[in] fdt_addr Address of FDT * - * @return Size of flat device tree in bytes or error if negative. + * Return: Size of flat device tree in bytes or error if negative. */ int cvmx_fdt_get_fdt_size(const void *fdt_addr) { @@ -167,7 +167,7 @@ int cvmx_fdt_get_fdt_size(const void *fdt_addr) * @param[in] strlist Array of FDT device compatibility strings, * must end with NULL or empty string. * - * @return 0 if at least one item matches, 1 if no matches + * Return: 0 if at least one item matches, 1 if no matches */ int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const char *const *strlist) { @@ -187,7 +187,7 @@ int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const ch * @param strlist Array of FDT device compatibility strings, must * end with NULL or empty string. * - * @return next matching node or -1 if no more matches. + * Return: next matching node or -1 if no more matches. */ int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffset, const char *const *strlist) @@ -221,7 +221,7 @@ void cvmx_sfp_attach_phy(struct cvmx_fdt_sfp_info *sfp, struct cvmx_phy_info *ph * @param sfp Handle to SFP data structure * @param ipd_port Port to assign it to * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port) { @@ -269,7 +269,7 @@ int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port) * @param of_offset Offset of vsc7224 node * @param[in,out] vsc7224 Data structure to hold the data * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ static int cvmx_fdt_parse_vsc7224_channels(const void *fdt_addr, int of_offset, struct cvmx_vsc7224 *vsc7224) @@ -437,7 +437,7 @@ static int cvmx_fdt_parse_vsc7224_channels(const void *fdt_addr, int of_offset, * * @param[in] fdt_addr Address of flat device tree * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ int __cvmx_fdt_parse_vsc7224(const void *fdt_addr) { @@ -530,7 +530,7 @@ int __cvmx_fdt_parse_vsc7224(const void *fdt_addr) * * @param[in] fdt_addr Address of flat device tree * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ int __cvmx_fdt_parse_avsp5410(const void *fdt_addr) { @@ -665,7 +665,7 @@ int __cvmx_fdt_parse_avsp5410(const void *fdt_addr) * @param of_offset Offset of QSFP node * @param[out] sfp_info Pointer to sfp info to fill in * - * @return 0 for success + * Return: 0 for success */ static int cvmx_parse_qsfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_sfp_info *sfp_info) { @@ -684,7 +684,7 @@ static int cvmx_parse_qsfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_ * @param of_offset Offset of SFP node * @param[out] sfp_info Pointer to sfp info to fill in * - * @return 0 for success + * Return: 0 for success */ static int cvmx_parse_sfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_sfp_info *sfp_info) { @@ -702,7 +702,7 @@ static int cvmx_parse_sfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_s * @param of_offset Offset of SFP node * @param[out] sfp_info Pointer to sfp info to fill in * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ static int cvmx_parse_sfp_eeprom(const void *fdt_addr, int of_offset, struct cvmx_fdt_sfp_info *sfp_info) @@ -741,7 +741,7 @@ static int cvmx_parse_sfp_eeprom(const void *fdt_addr, int of_offset, * * @param[in] fdt_addr Address of flat device tree * - * @return pointer to sfp info or NULL if error + * Return: pointer to sfp info or NULL if error */ struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, int of_offset) { @@ -806,7 +806,7 @@ error_exit: * @param of_offset fdt offset of slice * @param phy_info phy_info data structure * - * @return slice number if non-negative, otherwise error + * Return: slice number if non-negative, otherwise error */ static int cvmx_fdt_parse_cs4343_slice(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info) @@ -905,7 +905,7 @@ static int cvmx_fdt_parse_cs4343_slice(const void *fdt_addr, int of_offset, * @param of_offset offset of slice or phy in device tree * @param phy_info phy_info data structure to fill in * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int cvmx_fdt_parse_cs4343(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info) { diff --git a/arch/mips/mach-octeon/cvmx-helper-jtag.c b/arch/mips/mach-octeon/cvmx-helper-jtag.c index a6fa69b4c5..bb773ff8e6 100644 --- a/arch/mips/mach-octeon/cvmx-helper-jtag.c +++ b/arch/mips/mach-octeon/cvmx-helper-jtag.c @@ -71,7 +71,7 @@ void cvmx_helper_qlm_jtag_init(void) * @param data Data to shift in. Bit 0 enters the chain first, followed by * bit 1, etc. * - * @return The low order bits of the JTAG chain that shifted out of the + * Return: The low order bits of the JTAG chain that shifted out of the * circle. */ uint32_t cvmx_helper_qlm_jtag_shift(int qlm, int bits, uint32_t data) diff --git a/arch/mips/mach-octeon/cvmx-helper-util.c b/arch/mips/mach-octeon/cvmx-helper-util.c index 4625b4591b..92298fd8d1 100644 --- a/arch/mips/mach-octeon/cvmx-helper-util.c +++ b/arch/mips/mach-octeon/cvmx-helper-util.c @@ -132,7 +132,7 @@ static const struct ipd_port_map ipd_port_map_75xx[CVMX_HELPER_MAX_IFACE] = { * * @param mode Mode to convert * - * @return String + * Return: String */ const char *cvmx_helper_interface_mode_to_string(cvmx_helper_interface_mode_t mode) { @@ -729,7 +729,7 @@ void cvmx_helper_setup_legacy_red(int pass_thresh, int drop_thresh) * @param drop_thresh * All incoming packets will be dropped when there are less * than this many free packet buffers in FPA 0. - * @return Zero on success. Negative on failure + * Return: Zero on success. Negative on failure */ int cvmx_helper_setup_red(int pass_thresh, int drop_thresh) { @@ -749,7 +749,7 @@ int cvmx_helper_setup_red(int pass_thresh, int drop_thresh) * @param xiface Interface to configure * @param num_ports Number of ports on the interface * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_setup_gmx(int xiface, int num_ports) { @@ -984,7 +984,7 @@ int cvmx_helper_get_bpid(int interface, int port) * * @param port IPD/PKO port number * - * @return none + * Return: none */ void cvmx_helper_show_stats(int port) { @@ -1013,7 +1013,7 @@ void cvmx_helper_show_stats(int port) * * @param ipd_port IPD/PKO port number * - * @return Interface number + * Return: Interface number */ int cvmx_helper_get_interface_num(int ipd_port) { @@ -1096,7 +1096,7 @@ int cvmx_helper_get_interface_num(int ipd_port) * * @param ipd_port IPD/PKO port number * - * @return Interface index number + * Return: Interface index number */ int cvmx_helper_get_interface_index_num(int ipd_port) { diff --git a/arch/mips/mach-octeon/cvmx-helper.c b/arch/mips/mach-octeon/cvmx-helper.c index 529e03a147..d0620d6cda 100644 --- a/arch/mips/mach-octeon/cvmx-helper.c +++ b/arch/mips/mach-octeon/cvmx-helper.c @@ -512,7 +512,7 @@ cvmx_helper_link_info_t __cvmx_helper_get_link_info(int xiface, int port) * * @param xiface - interface to check * - * @return zero if FCS is not used, otherwise FCS is used. + * Return: zero if FCS is not used, otherwise FCS is used. */ int __cvmx_helper_get_has_fcs(int xiface) { @@ -562,7 +562,7 @@ void (*cvmx_override_ipd_port_setup)(int ipd_port) = NULL; * but the CNX0XX and CNX1XX are exceptions. These only support * one interface. * - * @return Number of interfaces on chip + * Return: Number of interfaces on chip */ int cvmx_helper_get_number_of_interfaces(void) { @@ -609,7 +609,7 @@ int __cvmx_helper_early_ports_on_interface(int interface) * * @param xiface xiface to get the port count for * - * @return Number of ports on interface. Can be Zero. + * Return: Number of ports on interface. Can be Zero. */ int cvmx_helper_ports_on_interface(int xiface) { @@ -1158,7 +1158,7 @@ static cvmx_helper_interface_mode_t __cvmx_get_mode_octeon2(int interface) * * @param xiface Interface to probe * - * @return Mode of the interface. Unknown or unsupported interfaces return + * Return: Mode of the interface. Unknown or unsupported interfaces return * DISABLED. */ cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface) @@ -1239,7 +1239,7 @@ cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface) * * @param xiface Interface to enumerate * - * @return The number of ports on the interface, negative on failure + * Return: The number of ports on the interface, negative on failure */ int cvmx_helper_interface_enumerate(int xiface) { @@ -1262,7 +1262,7 @@ int cvmx_helper_interface_enumerate(int xiface) * * @param xiface Interface to probe * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_interface_probe(int xiface) { @@ -1365,7 +1365,7 @@ int cvmx_helper_interface_probe(int xiface) * @INTERNAL * Setup backpressure. * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ static int __cvmx_helper_global_setup_backpressure(int node) { @@ -1441,7 +1441,7 @@ static int __cvmx_helper_global_setup_backpressure(int node) /** * @INTERNAL * Verify the per port IPD backpressure is aligned properly. - * @return Zero if working, non zero if misaligned + * Return: Zero if working, non zero if misaligned */ int __cvmx_helper_backpressure_is_misaligned(void) { @@ -1458,7 +1458,7 @@ int __cvmx_helper_backpressure_is_misaligned(void) * * @param xiface Interface to enable * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_packet_hardware_enable(int xiface) { @@ -1480,7 +1480,7 @@ int cvmx_helper_ipd_and_packet_input_enable(void) * Called after all internal packet IO paths are setup. This * function enables IPD/PIP and begins packet input and output. * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_ipd_and_packet_input_enable_node(int node) { @@ -1526,7 +1526,7 @@ int cvmx_helper_ipd_and_packet_input_enable_node(int node) * on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower * priority than the previous. * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_initialize_packet_io_node(unsigned int node) { @@ -1645,7 +1645,7 @@ int cvmx_helper_initialize_packet_io_node(unsigned int node) * on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower * priority than the previous. * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_initialize_packet_io_global(void) { @@ -1657,7 +1657,7 @@ int cvmx_helper_initialize_packet_io_global(void) /** * Does core local initialization for packet io * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_initialize_packet_io_local(void) { @@ -1681,7 +1681,7 @@ struct cvmx_buffer_list { * 1 => disable backpressure * 0 => enable backpressure * - * @return 0 on success + * Return: 0 on success * -1 on error */ int cvmx_gmx_set_backpressure_override(u32 interface, uint32_t port_mask) @@ -1710,7 +1710,7 @@ int cvmx_gmx_set_backpressure_override(u32 interface, uint32_t port_mask) * 1 => disable backpressure * 0 => enable backpressure * - * @return 0 on success + * Return: 0 on success * -1 on error */ int cvmx_agl_set_backpressure_override(u32 interface, uint32_t port_mask) @@ -1852,7 +1852,7 @@ int cvmx_helper_shutdown_packet_io_global_cn78xx(int node) * buffers used by the packet IO hardware to the FPA so a function emptying the * FPA after shutdown should find all packet buffers in the FPA. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_helper_shutdown_packet_io_global(void) { @@ -2158,7 +2158,7 @@ int cvmx_helper_shutdown_packet_io_global(void) /** * Does core local shutdown of packet io * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_shutdown_packet_io_local(void) { @@ -2176,7 +2176,7 @@ int cvmx_helper_shutdown_packet_io_local(void) * * @param xipd_port IPD/PKO port to auto configure * - * @return Link state after configure + * Return: Link state after configure */ cvmx_helper_link_info_t cvmx_helper_link_autoconf(int xipd_port) { @@ -2215,7 +2215,7 @@ cvmx_helper_link_info_t cvmx_helper_link_autoconf(int xipd_port) * * @param xipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t cvmx_helper_link_get(int xipd_port) { @@ -2264,7 +2264,7 @@ cvmx_helper_link_info_t cvmx_helper_link_get(int xipd_port) * @param xipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_link_set(int xipd_port, cvmx_helper_link_info_t link_info) { @@ -2301,7 +2301,7 @@ int cvmx_helper_link_set(int xipd_port, cvmx_helper_link_info_t link_info) * @param enable_external * Non zero if you want external loopback * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_helper_configure_loopback(int xipd_port, int enable_internal, int enable_external) { diff --git a/arch/mips/mach-octeon/cvmx-pcie.c b/arch/mips/mach-octeon/cvmx-pcie.c index f42d44cbec..c2a2018a1f 100644 --- a/arch/mips/mach-octeon/cvmx-pcie.c +++ b/arch/mips/mach-octeon/cvmx-pcie.c @@ -84,7 +84,7 @@ static uint32_t __cvmx_pcie_config_read32(int node, int pcie_port, int bus, int * * @param pcie_port PCIe port the IO is for * - * @return 64bit Octeon IO base address for read/write + * Return: 64bit Octeon IO base address for read/write */ uint64_t cvmx_pcie_get_io_base_address(int pcie_port) { @@ -107,7 +107,7 @@ uint64_t cvmx_pcie_get_io_base_address(int pcie_port) * * @param pcie_port PCIe port the IO is for * - * @return Size of the IO window + * Return: Size of the IO window */ uint64_t cvmx_pcie_get_io_size(int pcie_port) { @@ -120,7 +120,7 @@ uint64_t cvmx_pcie_get_io_size(int pcie_port) * * @param pcie_port PCIe port the IO is for * - * @return 64bit Octeon IO base address for read/write + * Return: 64bit Octeon IO base address for read/write */ uint64_t cvmx_pcie_get_mem_base_address(int pcie_port) { @@ -141,7 +141,7 @@ uint64_t cvmx_pcie_get_mem_base_address(int pcie_port) * * @param pcie_port PCIe port the IO is for * - * @return Size of the Mem window + * Return: Size of the Mem window */ uint64_t cvmx_pcie_get_mem_size(int pcie_port) { @@ -154,7 +154,7 @@ uint64_t cvmx_pcie_get_mem_size(int pcie_port) * * @param pcie_port QLM number to return for. * - * @return QLM number. + * Return: QLM number. */ static int __cvmx_pcie_get_qlm(int node, int pcie_port) { @@ -751,7 +751,7 @@ static void __cvmx_pcie_gser_phy_config(int node, int pcie_port, int qlm) * @param node Node to query * @param pcie_port PEM to query * - * @return LTSSM state + * Return: LTSSM state */ static int __cvmx_pcie_rc_get_ltssm_state(int node, int pcie_port) { @@ -794,7 +794,7 @@ static int __cvmx_pcie_rc_get_ltssm_state(int node, int pcie_port) * @param node Node to query * @param pcie_port PEM to query * - * @return LTSSM state + * Return: LTSSM state */ static const char *cvmx_pcie_get_ltssm_string(int ltssm) { @@ -890,7 +890,7 @@ static const char *cvmx_pcie_get_ltssm_string(int ltssm) * @param func PCIe function on the device * @param reg Register to read * - * @return Config register value, or all ones on failure + * Return: Config register value, or all ones on failure */ static uint32_t cvmx_pcie_config_read32_retry(int node, int pcie_port, int bus, int dev, int func, int reg) @@ -928,7 +928,7 @@ static uint32_t cvmx_pcie_config_read32_retry(int node, int pcie_port, int bus, * @param node node * @param pcie_port PCIe port to initialize * - * @return Zero on success + * Return: Zero on success */ static int __cvmx_pcie_rc_initialize_link_gen2(int node, int pcie_port) { @@ -1185,7 +1185,7 @@ static void __cvmx_pcie_sli_config(int node, int pcie_port) * * @param pcie_port PCIe port to initialize * - * @return Zero on success + * Return: Zero on success */ static int __cvmx_pcie_rc_initialize_gen2(int pcie_port) { @@ -1393,7 +1393,7 @@ static int __cvmx_pcie_rc_initialize_gen2(int pcie_port) * @param node node * @param pcie_port PCIe port to initialize * - * @return Zero on success + * Return: Zero on success */ static int __cvmx_pcie_rc_initialize_link_gen2_v3(int node, int pcie_port) { @@ -2008,7 +2008,7 @@ static int __cvmx_pcie_rc_initialize_gen2_v3(int pcie_port) * * @param pcie_port PCIe port to initialize for a node * - * @return Zero on success + * Return: Zero on success */ int cvmx_pcie_rc_initialize(int pcie_port) { @@ -2029,7 +2029,7 @@ int cvmx_pcie_rc_initialize(int pcie_port) * * @param pcie_port PCIe port to shutdown for a node * - * @return Zero on success + * Return: Zero on success */ int cvmx_pcie_rc_shutdown(int pcie_port) { @@ -2076,7 +2076,7 @@ int cvmx_pcie_rc_shutdown(int pcie_port) * @param fn Device sub function * @param reg Register to access * - * @return 64bit Octeon IO address + * Return: 64bit Octeon IO address */ static uint64_t __cvmx_pcie_build_config_addr(int node, int port, int bus, int dev, int fn, int reg) { @@ -2117,7 +2117,7 @@ static uint64_t __cvmx_pcie_build_config_addr(int node, int port, int bus, int d * @param fn Device sub function * @param reg Register to access * - * @return Result of the read + * Return: Result of the read */ uint8_t cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg) { @@ -2141,7 +2141,7 @@ uint8_t cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg) * @param fn Device sub function * @param reg Register to access * - * @return Result of the read + * Return: Result of the read */ uint16_t cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg) { @@ -2183,7 +2183,7 @@ static uint32_t __cvmx_pcie_config_read32(int node, int pcie_port, int bus, int * @param fn Device sub function * @param reg Register to access * - * @return Result of the read + * Return: Result of the read */ uint32_t cvmx_pcie_config_read32(int pcie_port, int bus, int dev, int fn, int reg) { @@ -2264,7 +2264,7 @@ void cvmx_pcie_config_write32(int pcie_port, int bus, int dev, int fn, int reg, * @param pcie_port PCIe port to read from * @param cfg_offset Address to read * - * @return Value read + * Return: Value read */ uint32_t cvmx_pcie_cfgx_read(int pcie_port, uint32_t cfg_offset) { @@ -2313,7 +2313,7 @@ extern int cvmx_pcie_is_host_mode(int pcie_port); * * @param pcie_port PCIe port to initialize for a node * - * @return Zero on success + * Return: Zero on success */ int cvmx_pcie_ep_initialize(int pcie_port) { @@ -2459,7 +2459,7 @@ void cvmx_pcie_wait_for_pending(int pcie_port) * * @param pcie_port PCIe port number (PEM number) * - * @return 0 if PCIe port is in target mode, !0 if in host mode. + * Return: 0 if PCIe port is in target mode, !0 if in host mode. */ int cvmx_pcie_is_host_mode(int pcie_port) { diff --git a/arch/mips/mach-octeon/cvmx-qlm.c b/arch/mips/mach-octeon/cvmx-qlm.c index 970e34aaff..01051788b8 100644 --- a/arch/mips/mach-octeon/cvmx-qlm.c +++ b/arch/mips/mach-octeon/cvmx-qlm.c @@ -64,7 +64,7 @@ static qlm_jtag_uint32_t *__cvmx_qlm_jtag_xor_ref; /** * Return the number of QLMs supported by the chip * - * @return Number of QLMs + * Return: Number of QLMs */ int cvmx_qlm_get_num(void) { @@ -92,7 +92,7 @@ int cvmx_qlm_get_num(void) * * @param xiface interface to look up * - * @return the qlm number based on the xiface + * Return: the qlm number based on the xiface */ int cvmx_qlm_interface(int xiface) { @@ -130,7 +130,7 @@ int cvmx_qlm_interface(int xiface) * @param xiface interface to look up * @param index index in an interface * - * @return the qlm number based on the xiface + * Return: the qlm number based on the xiface */ int cvmx_qlm_lmac(int xiface, int index) { @@ -281,7 +281,7 @@ int cvmx_qlm_lmac(int xiface, int index) * * @param BGX BGX to search for. * - * @return muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6. + * Return: muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6. */ int cvmx_qlm_mux_interface(int bgx) { @@ -322,7 +322,7 @@ int cvmx_qlm_mux_interface(int bgx) * * @param qlm QLM to examine * - * @return Number of lanes + * Return: Number of lanes */ int cvmx_qlm_get_lanes(int qlm) { @@ -340,7 +340,7 @@ int cvmx_qlm_get_lanes(int qlm) /** * Get the QLM JTAG fields based on Octeon model on the supported chips. * - * @return qlm_jtag_field_t structure + * Return: qlm_jtag_field_t structure */ const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void) { @@ -361,7 +361,7 @@ const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void) * Get the QLM JTAG length by going through qlm_jtag_field for each * Octeon model that is supported * - * @return return the length. + * Return: return the length. */ int cvmx_qlm_jtag_get_length(void) { @@ -394,7 +394,7 @@ void cvmx_qlm_init(void) * * @param name Name to lookup * - * @return Field info, or NULL on failure + * Return: Field info, or NULL on failure */ static const __cvmx_qlm_jtag_field_t *__cvmx_qlm_lookup_field(const char *name) { @@ -417,7 +417,7 @@ static const __cvmx_qlm_jtag_field_t *__cvmx_qlm_lookup_field(const char *name) * @param lane Lane in QLM to get * @param name String name of field * - * @return JTAG field value + * Return: JTAG field value */ uint64_t cvmx_qlm_jtag_get(int qlm, int lane, const char *name) { @@ -620,7 +620,7 @@ void __cvmx_qlm_pcie_cfg_rxd_set_tweak(int qlm, int lane) * @param node node of the QLM * @param qlm QLM to examine * - * @return Speed in Mhz + * Return: Speed in Mhz */ int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm) { @@ -723,7 +723,7 @@ int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm) * * @param qlm QLM to examine * - * @return Speed in Mhz + * Return: Speed in Mhz */ int cvmx_qlm_get_gbaud_mhz(int qlm) { @@ -1021,7 +1021,7 @@ static enum cvmx_qlm_mode __cvmx_qlm_get_mode_cn70xx(int qlm) * 1 - PCIe * 2 - SATA * @param interface interface to use - * @return the qlm mode the interface is + * Return: the qlm mode the interface is */ enum cvmx_qlm_mode cvmx_qlm_get_dlm_mode(int interface_type, int interface) { @@ -1875,7 +1875,7 @@ int cvmx_qlm_measure_clock_cn7xxx(int node, int qlm) * @param node node to measure * @param qlm QLM to measure * - * @return Clock rate in Hz + * Return: Clock rate in Hz */ int cvmx_qlm_measure_clock_node(int node, int qlm) { @@ -1890,7 +1890,7 @@ int cvmx_qlm_measure_clock_node(int node, int qlm) * * @param qlm QLM to measure * - * @return Clock rate in Hz + * Return: Clock rate in Hz */ int cvmx_qlm_measure_clock(int qlm) { @@ -1972,7 +1972,7 @@ int cvmx_qlm_measure_clock(int qlm) * @param qlm QLM to perform RX equalization on * @param lane Lane to use, or -1 for all lanes * - * @return Zero on success, negative if any lane failed RX equalization + * Return: Zero on success, negative if any lane failed RX equalization */ int __cvmx_qlm_rx_equalization(int node, int qlm, int lane) { diff --git a/arch/mips/mach-octeon/include/mach/bootoct_cmd.h b/arch/mips/mach-octeon/include/mach/bootoct_cmd.h index 657698ba54..0e21b3a8d3 100644 --- a/arch/mips/mach-octeon/include/mach/bootoct_cmd.h +++ b/arch/mips/mach-octeon/include/mach/bootoct_cmd.h @@ -42,7 +42,7 @@ struct octeon_boot_args { * @param cmd command type * @param[out] boot_args parsed values * - * @return number of arguments parsed + * Return: number of arguments parsed */ int octeon_parse_bootopts(int argc, char *const argv[], enum octeon_boot_cmd_type cmd, diff --git a/arch/mips/mach-octeon/include/mach/cvmx-bootmem.h b/arch/mips/mach-octeon/include/mach/cvmx-bootmem.h index d60668c9ad..283ac5c6bb 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-bootmem.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-bootmem.h @@ -128,7 +128,7 @@ int cvmx_bootmem_init(u64 mem_desc_addr); * @param size Size in bytes of block to allocate * @param alignment Alignment required - must be power of 2 * - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc(u64 size, u64 alignment); @@ -141,7 +141,7 @@ void *cvmx_bootmem_alloc(u64 size, u64 alignment); * @param size Size in bytes of block to allocate * @param alignment Alignment required - must be power of 2 * - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_node(u64 node, u64 size, u64 alignment); @@ -156,7 +156,7 @@ void *cvmx_bootmem_alloc_node(u64 node, u64 size, u64 alignment); * @param address Physical address to allocate memory at. If this * memory is not available, the allocation fails. * @param alignment Alignment required - must be power of 2 - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_address(u64 size, u64 address, u64 alignment); @@ -172,7 +172,7 @@ void *cvmx_bootmem_alloc_address(u64 size, u64 address, * @param min_addr defines the minimum address of the range * @param max_addr defines the maximum address of the range * @param alignment Alignment required - must be power of 2 - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_range(u64 size, u64 alignment, u64 min_addr, u64 max_addr); @@ -187,7 +187,7 @@ void *cvmx_bootmem_alloc_range(u64 size, u64 alignment, * @param alignment Alignment required - must be power of 2 * @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes * - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_named(u64 size, u64 alignment, const char *name); @@ -203,7 +203,7 @@ void *cvmx_bootmem_alloc_named(u64 size, u64 alignment, * @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes * @param flags Flags to control options for the allocation. * - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_named_flags(u64 size, u64 alignment, const char *name, u32 flags); @@ -219,7 +219,7 @@ void *cvmx_bootmem_alloc_named_flags(u64 size, u64 alignment, * memory is not available, the allocation fails. * @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes * - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_named_address(u64 size, u64 address, const char *name); @@ -238,7 +238,7 @@ void *cvmx_bootmem_alloc_named_address(u64 size, u64 address, * @param align Alignment of memory to be allocated. (must be a power of 2) * @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes * - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_named_range(u64 size, u64 min_addr, u64 max_addr, u64 align, @@ -263,7 +263,7 @@ void *cvmx_bootmem_alloc_named_range(u64 size, u64 min_addr, * The initialization function is optional, if omitted the named block * is initialized to all zeros when it is created, i.e. once. * - * @return pointer to block of memory, NULL on error + * Return: pointer to block of memory, NULL on error */ void *cvmx_bootmem_alloc_named_range_once(u64 size, u64 min_addr, @@ -282,7 +282,7 @@ void *cvmx_bootmem_alloc_named_range_once(u64 size, * @param name Name to assign to reserved blocks * @param flags Flags to use when reserving memory * - * @return 0 on failure, + * Return: 0 on failure, * !0 on success */ int cvmx_bootmem_reserve_memory(u64 start_addr, u64 size, @@ -293,7 +293,7 @@ int cvmx_bootmem_reserve_memory(u64 start_addr, u64 size, * * @param name name of block to free * - * @return 0 on failure, + * Return: 0 on failure, * !0 on success */ int cvmx_bootmem_free_named(const char *name); @@ -303,7 +303,7 @@ int cvmx_bootmem_free_named(const char *name); * * @param name name of block to free * - * @return pointer to named block descriptor on success + * Return: pointer to named block descriptor on success * 0 on failure */ const struct cvmx_bootmem_named_block_desc * @@ -317,7 +317,7 @@ cvmx_bootmem_find_named_block(const char *name); * @param min_block_size * Minimum block size to count in total. * - * @return Number of bytes available for allocation that meet the + * Return: Number of bytes available for allocation that meet the * block size requirement */ u64 cvmx_bootmem_available_mem(u64 min_block_size); @@ -350,7 +350,7 @@ void cvmx_bootmem_print_named(void); * CVMX_BOOTMEM_ALIGNMENT_SIZE.) * @param flags Flags to control options for the allocation. * - * @return physical address of block allocated, or -1 on failure + * Return: physical address of block allocated, or -1 on failure */ s64 cvmx_bootmem_phy_alloc(u64 req_size, u64 address_min, u64 address_max, u64 alignment, u32 flags); @@ -379,7 +379,7 @@ s64 cvmx_bootmem_phy_alloc(u64 req_size, u64 address_min, u64 address_max, * * @param flags Flags to control options for the allocation. * - * @return physical address of block allocated, or -1 on failure + * Return: physical address of block allocated, or -1 on failure */ s64 cvmx_bootmem_phy_named_block_alloc(u64 size, u64 min_addr, u64 max_addr, u64 alignment, const char *name, @@ -394,7 +394,7 @@ s64 cvmx_bootmem_phy_named_block_alloc(u64 size, u64 min_addr, u64 max_addr, * * @param flags Flags to control options for the allocation. * - * @return Physical address of the memory block descriptor, zero if not + * Return: Physical address of the memory block descriptor, zero if not * found. If zero returned when name parameter is NULL, then no * memory block descriptors are available. */ @@ -408,7 +408,7 @@ u64 cvmx_bootmem_phy_named_block_find(const char *name, u32 flags); * @param min_block_size * Minimum block size to count in total. * - * @return Number of bytes available for allocation that meet the + * Return: Number of bytes available for allocation that meet the * block size requirement */ u64 cvmx_bootmem_phy_available_mem(u64 min_block_size); @@ -419,7 +419,7 @@ u64 cvmx_bootmem_phy_available_mem(u64 min_block_size); * @param name name of block to free * @param flags flags for passing options * - * @return 0 on failure + * Return: 0 on failure * 1 on success */ int cvmx_bootmem_phy_named_block_free(const char *name, u32 flags); @@ -438,7 +438,7 @@ int cvmx_bootmem_phy_named_block_free(const char *name, u32 flags); * @param size size of block in bytes. * @param flags flags for passing options * - * @return 1 on success, + * Return: 1 on success, * 0 on failure */ int __cvmx_bootmem_phy_free(u64 phy_addr, u64 size, u32 flags); @@ -467,7 +467,7 @@ void cvmx_bootmem_phy_list_print(void); * @param desc_buffer Buffer for the bootmem descriptor. This must be * a 32 bit addressable address. * - * @return 1 on success + * Return: 1 on success * 0 on failure */ s64 cvmx_bootmem_phy_mem_list_init(u64 mem_size, u32 low_reserved_bytes, @@ -487,7 +487,7 @@ s64 cvmx_bootmem_phy_mem_list_init(u64 mem_size, u32 low_reserved_bytes, * @param desc_buffer Buffer for the bootmem descriptor. This must be * a 32 bit addressable address. * - * @return 1 on success + * Return: 1 on success * 0 on failure */ s64 cvmx_bootmem_phy_mem_list_init_multi(u8 nodemask, u32 mem_size[], diff --git a/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h b/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h index ddc294348c..c83d09c9dd 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h @@ -154,7 +154,7 @@ cvmx_cmd_queue_result_t __cvmx_cmd_queue_write_raw(cvmx_cmd_queue_id_t queue_id, * @param fpa_pool FPA pool the command queues should come from. * @param pool_size Size of each buffer in the FPA pool (bytes) * - * @return CVMX_CMD_QUEUE_SUCCESS or a failure code + * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code */ cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id, int max_depth, int fpa_pool, int pool_size); @@ -166,7 +166,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id, * * @param queue_id Queue to shutdown * - * @return CVMX_CMD_QUEUE_SUCCESS or a failure code + * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code */ cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id); @@ -176,7 +176,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id); * * @param queue_id Hardware command queue to query * - * @return Number of outstanding commands + * Return: Number of outstanding commands */ int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id); @@ -188,7 +188,7 @@ int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id); * * @param queue_id Command queue to query * - * @return Command buffer or NULL on failure + * Return: Command buffer or NULL on failure */ void *cvmx_cmd_queue_buffer(cvmx_cmd_queue_id_t queue_id); @@ -204,7 +204,7 @@ cvmx_cmd_queue_result_t __cvmx_cmd_queue_init_state_ptr(unsigned int node); * * @param queue_id Queue ID to get an index for * - * @return Index into the state arrays + * Return: Index into the state arrays */ static inline unsigned int __cvmx_cmd_queue_get_index(cvmx_cmd_queue_id_t queue_id) { @@ -270,7 +270,7 @@ static inline void __cvmx_cmd_queue_lock_init(cvmx_cmd_queue_id_t queue_id) * * @param queue_id Queue id to get * - * @return Queue structure or NULL on failure + * Return: Queue structure or NULL on failure */ static inline __cvmx_cmd_queue_state_t *__cvmx_cmd_queue_get_state(cvmx_cmd_queue_id_t queue_id) { @@ -301,7 +301,7 @@ static inline __cvmx_cmd_queue_state_t *__cvmx_cmd_queue_get_state(cvmx_cmd_queu * @param cmd_count Number of command words to write * @param cmds Array of commands to write * - * @return CVMX_CMD_QUEUE_SUCCESS or a failure code + * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code */ static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write(cvmx_cmd_queue_id_t queue_id, bool use_locking, int cmd_count, const u64 *cmds) @@ -348,7 +348,7 @@ cvmx_cmd_queue_write(cvmx_cmd_queue_id_t queue_id, bool use_locking, int cmd_cou * @param cmd1 Command * @param cmd2 Command * - * @return CVMX_CMD_QUEUE_SUCCESS or a failure code + * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code */ static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write2(cvmx_cmd_queue_id_t queue_id, bool use_locking, u64 cmd1, u64 cmd2) @@ -399,7 +399,7 @@ static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write2(cvmx_cmd_queue_id_t * @param cmd2 Command * @param cmd3 Command * - * @return CVMX_CMD_QUEUE_SUCCESS or a failure code + * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code */ static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write3(cvmx_cmd_queue_id_t queue_id, bool use_locking, u64 cmd1, u64 cmd2, u64 cmd3) diff --git a/arch/mips/mach-octeon/include/mach/cvmx-coremask.h b/arch/mips/mach-octeon/include/mach/cvmx-coremask.h index 314b6d9789..915e870929 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-coremask.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-coremask.h @@ -101,7 +101,7 @@ struct cvmx_coremask { * @param node starting node number * @param node_mask node mask to use to find the next node * - * @return next node number or -1 if no more nodes are available + * Return: next node number or -1 if no more nodes are available */ static inline int cvmx_coremask_next_node(int node, u8 node_mask) { @@ -132,7 +132,7 @@ static inline int cvmx_coremask_next_node(int node, u8 node_mask) * * @param pcm is the pointer to the coremask. * @param core - * @return 1 if core is set and 0 if not. + * Return: 1 if core is set and 0 if not. */ static inline int cvmx_coremask_is_core_set(const struct cvmx_coremask *pcm, int core) @@ -149,7 +149,7 @@ static inline int cvmx_coremask_is_core_set(const struct cvmx_coremask *pcm, * Is ``current core'' set in the coremask? * * @param pcm is the pointer to the coremask. - * @return 1 if core is set and 0 if not. + * Return: 1 if core is set and 0 if not. */ static inline int cvmx_coremask_is_self_set(const struct cvmx_coremask *pcm) { @@ -159,7 +159,7 @@ static inline int cvmx_coremask_is_self_set(const struct cvmx_coremask *pcm) /** * Is coremask empty? * @param pcm is the pointer to the coremask. - * @return 1 if *pcm is empty (all zeros), 0 if not empty. + * Return: 1 if *pcm is empty (all zeros), 0 if not empty. */ static inline int cvmx_coremask_is_empty(const struct cvmx_coremask *pcm) { @@ -177,7 +177,7 @@ static inline int cvmx_coremask_is_empty(const struct cvmx_coremask *pcm) * * @param pcm is the pointer to the coremask. * @param core - * @return 0. + * Return: 0. */ static inline int cvmx_coremask_set_core(struct cvmx_coremask *pcm, int core) { @@ -194,7 +194,7 @@ static inline int cvmx_coremask_set_core(struct cvmx_coremask *pcm, int core) * Set ``current core'' in the coremask. * * @param pcm is the pointer to the coremask. - * @return 0. + * Return: 0. */ static inline int cvmx_coremask_set_self(struct cvmx_coremask *pcm) { @@ -206,7 +206,7 @@ static inline int cvmx_coremask_set_self(struct cvmx_coremask *pcm) * * @param pcm is the pointer to the coremask. * @param core - * @return 0. + * Return: 0. */ static inline int cvmx_coremask_clear_core(struct cvmx_coremask *pcm, int core) { @@ -223,7 +223,7 @@ static inline int cvmx_coremask_clear_core(struct cvmx_coremask *pcm, int core) * Clear ``current core'' from the coremask. * * @param pcm is the pointer to the coremask. - * @return 0. + * Return: 0. */ static inline int cvmx_coremask_clear_self(struct cvmx_coremask *pcm) { @@ -235,7 +235,7 @@ static inline int cvmx_coremask_clear_self(struct cvmx_coremask *pcm) * * @param pcm is the pointer to the coremask. * @param core - * @return 0. + * Return: 0. */ static inline int cvmx_coremask_toggle_core(struct cvmx_coremask *pcm, int core) { @@ -252,7 +252,7 @@ static inline int cvmx_coremask_toggle_core(struct cvmx_coremask *pcm, int core) * Toggle ``current core'' in the coremask. * * @param pcm is the pointer to the coremask. - * @return 0. + * Return: 0. */ static inline int cvmx_coremask_toggle_self(struct cvmx_coremask *pcm) { @@ -288,7 +288,7 @@ static inline void cvmx_coremask_set64_node(struct cvmx_coremask *pcm, * Gets the lower 64-bits of the coremask * * @param[in] pcm - pointer to coremask - * @return 64-bit coremask for the first node + * Return: 64-bit coremask for the first node */ static inline u64 cvmx_coremask_get64(const struct cvmx_coremask *pcm) { @@ -300,7 +300,7 @@ static inline u64 cvmx_coremask_get64(const struct cvmx_coremask *pcm) * * @param[in] pcm - pointer to coremask * @param node - node to get coremask for - * @return 64-bit coremask for the first node + * Return: 64-bit coremask for the first node */ static inline u64 cvmx_coremask_get64_node(const struct cvmx_coremask *pcm, u8 node) @@ -312,7 +312,7 @@ static inline u64 cvmx_coremask_get64_node(const struct cvmx_coremask *pcm, * Gets the lower 32-bits of the coremask for compatibility * * @param[in] pcm - pointer to coremask - * @return 32-bit coremask for the first node + * Return: 32-bit coremask for the first node * @deprecated This function is to maintain compatibility with older * SDK applications and may disappear at some point. * This function is not compatible with the CN78XX or any other @@ -515,7 +515,7 @@ static inline int cvmx_coremask_get_first_core(const struct cvmx_coremask *pcm) * @param core - starting core to check (can be -1 for core 0) * @param pcm - pointer to coremask to check for the next core. * - * @return next core following the core parameter or -1 if no more cores. + * Return: next core following the core parameter or -1 if no more cores. */ static inline int cvmx_coremask_next_core(int core, const struct cvmx_coremask *pcm) @@ -597,7 +597,7 @@ static inline void cvmx_coremask_copy(struct cvmx_coremask *dest, * @param[in] pcm pointer to the coremask to test against * @param[in] core core to check * - * @return 1 if the core is first core in the coremask, 0 otherwise + * Return: 1 if the core is first core in the coremask, 0 otherwise * */ static inline int cvmx_coremask_is_core_first_core(const struct cvmx_coremask *pcm, @@ -634,7 +634,7 @@ static inline int cvmx_coremask_is_core_first_core(const struct cvmx_coremask *p * * @param[in] pcm - pointer to core mask * - * @return number of bits set in the coremask + * Return: number of bits set in the coremask */ static inline int cvmx_coremask_get_core_count(const struct cvmx_coremask *pcm) { @@ -652,7 +652,7 @@ static inline int cvmx_coremask_get_core_count(const struct cvmx_coremask *pcm) * * @param core - core number (0-1023) * - * @return node number core belongs to + * Return: node number core belongs to */ static inline int cvmx_coremask_core_to_node(int core) { @@ -678,7 +678,7 @@ static inline int cvmx_coremask_core_on_node(int core) * @param main - main coremask to test * @param subset - subset coremask to test * - * @return 0 if the subset contains cores not in the main coremask or 1 if + * Return: 0 if the subset contains cores not in the main coremask or 1 if * the subset is fully contained in the main coremask. */ static inline int cvmx_coremask_is_subset(const struct cvmx_coremask *main, @@ -699,7 +699,7 @@ static inline int cvmx_coremask_is_subset(const struct cvmx_coremask *main, * @param c1 - main coremask to test * @param c2 - subset coremask to test * - * @return 1 if coremask c1 intersects coremask c2, 0 if they are exclusive + * Return: 1 if coremask c1 intersects coremask c2, 0 if they are exclusive */ static inline int cvmx_coremask_intersects(const struct cvmx_coremask *c1, const struct cvmx_coremask *c2) @@ -735,7 +735,7 @@ static inline void cvmx_coremask_mask_node(struct cvmx_coremask *pcm, int node) * * @param[in] pcm - pointer to core mask * - * @return nothing + * Return: nothing */ void cvmx_coremask_print(const struct cvmx_coremask *pcm); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-error.h b/arch/mips/mach-octeon/include/mach/cvmx-error.h index 9a13ed4224..216d32e726 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-error.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-error.h @@ -90,7 +90,7 @@ typedef struct cvmx_error_info { * * @param flags Optional flags. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_initialize(void); @@ -99,7 +99,7 @@ int cvmx_error_initialize(void); * handlers. This should be called in the RSL interrupt handler * for your application or operating system. * - * @return Number of error handlers called. Zero means this call + * Return: Number of error handlers called. Zero means this call * found no errors and was spurious. */ int cvmx_error_poll(void); @@ -116,7 +116,7 @@ int cvmx_error_poll(void); * call. All members of the structure must be populated, even the * parent information. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_add(const cvmx_error_info_t *new_info); @@ -136,7 +136,7 @@ int cvmx_error_add(const cvmx_error_info_t *new_info); * @param old_info If not NULL, this is filled with information about the handler * that was removed. * - * @return Zero on success, negative on failure (not found). + * Return: Zero on success, negative on failure (not found). */ int cvmx_error_remove(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask, cvmx_error_info_t *old_info); @@ -160,7 +160,7 @@ int cvmx_error_remove(cvmx_error_register_t reg_type, u64 status_addr, u64 statu * @param old_user_info * If not NULL, the old user info parameter. * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_error_change_handler(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask, cvmx_error_func_t new_func, u64 new_user_info, @@ -175,7 +175,7 @@ int cvmx_error_change_handler(cvmx_error_register_t reg_type, u64 status_addr, u * Index for the group as defined in the cvmx_error_group_t * comments. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ /* * Rather than conditionalize the calls throughout the executive to not enable @@ -197,7 +197,7 @@ static inline int cvmx_error_enable_group(cvmx_error_group_t group, int group_in * Index for the group as defined in the cvmx_error_group_t * comments. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ /* * Rather than conditionalize the calls throughout the executive to not disable @@ -218,7 +218,7 @@ static inline int cvmx_error_disable_group(cvmx_error_group_t group, int group_i * All handlers for this status register with this mask will be * enabled. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_enable(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask); @@ -232,7 +232,7 @@ int cvmx_error_enable(cvmx_error_register_t reg_type, u64 status_addr, u64 statu * All handlers for this status register with this mask will be * disabled. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_disable(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask); @@ -244,7 +244,7 @@ int cvmx_error_disable(cvmx_error_register_t reg_type, u64 status_addr, u64 stat * * @param info Error register to check * - * @return Number of error status bits found or zero if no bits were set. + * Return: Number of error status bits found or zero if no bits were set. */ int __cvmx_error_decode(const cvmx_error_info_t *info); @@ -264,7 +264,7 @@ int __cvmx_error_display(const cvmx_error_info_t *info); * @param status_addr * Status register address * - * @return Return the handler on success or null on failure. + * Return: Return the handler on success or null on failure. */ cvmx_error_info_t *cvmx_error_get_index(u64 status_addr); @@ -279,7 +279,7 @@ void __cvmx_install_gmx_error_handler_for_xaui(void); * @param key INTSN value to search for * @param data current entry from the searched array * - * @return Negative, 0 or positive when respectively key is less than, + * Return: Negative, 0 or positive when respectively key is less than, * equal or greater than data. */ int cvmx_error_intsn_cmp(const void *key, const void *data); @@ -291,7 +291,7 @@ int cvmx_error_intsn_cmp(const void *key, const void *data); * * @param node Node number * - * @return Zero on success, -1 on error + * Return: Zero on success, -1 on error */ int cvmx_error_intsn_display_v3(int node, u32 intsn); @@ -302,7 +302,7 @@ int cvmx_error_intsn_display_v3(int node, u32 intsn); * * @param node Node number * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_initialize_cn78xx(int node); @@ -312,7 +312,7 @@ int cvmx_error_initialize_cn78xx(int node); * @param node Node number * @param intsn Interrupt source number * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_intsn_enable_v3(int node, u32 intsn); @@ -322,7 +322,7 @@ int cvmx_error_intsn_enable_v3(int node, u32 intsn); * @param node Node number * @param intsn Interrupt source number * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_intsn_disable_v3(int node, u32 intsn); @@ -331,7 +331,7 @@ int cvmx_error_intsn_disable_v3(int node, u32 intsn); * * @param intsn Interrupt source number * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_intsn_clear_v3(int node, u32 intsn); @@ -341,7 +341,7 @@ int cvmx_error_intsn_clear_v3(int node, u32 intsn); * @param node Node number * @param csr_address CSR address * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_error_csr_enable_v3(int node, u64 csr_address); @@ -351,7 +351,7 @@ int cvmx_error_csr_enable_v3(int node, u64 csr_address); * @param node Node number * @param csr_address CSR address * - * @return Zero + * Return: Zero */ int cvmx_error_csr_disable_v3(int node, u64 csr_address); @@ -362,7 +362,7 @@ int cvmx_error_csr_disable_v3(int node, u64 csr_address); * @param group Logical group to enable * @param xipd_port The IPD port value * - * @return Zero. + * Return: Zero. */ int cvmx_error_enable_group_v3(cvmx_error_group_t group, int xipd_port); @@ -372,7 +372,7 @@ int cvmx_error_enable_group_v3(cvmx_error_group_t group, int xipd_port); * @param group Logical group to enable * @param xipd_port The IPD port value * - * @return Zero. + * Return: Zero. */ int cvmx_error_disable_group_v3(cvmx_error_group_t group, int xipd_port); @@ -384,7 +384,7 @@ int cvmx_error_disable_group_v3(cvmx_error_group_t group, int xipd_port); * @param type Category in a logical group to enable * @param xipd_port The IPD port value * - * @return Zero. + * Return: Zero. */ int cvmx_error_enable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t type, int xipd_port); @@ -397,7 +397,7 @@ int cvmx_error_enable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t * @param type Category in a logical group to disable * @param xipd_port The IPD port value * - * @return Zero. + * Return: Zero. */ int cvmx_error_disable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t type, int xipd_port); @@ -408,7 +408,7 @@ int cvmx_error_disable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t * @param group Logical group to disable * @param xipd_port The IPD port value * - * @return Zero. + * Return: Zero. */ int cvmx_error_clear_group_v3(cvmx_error_group_t group, int xipd_port); @@ -418,7 +418,7 @@ int cvmx_error_clear_group_v3(cvmx_error_group_t group, int xipd_port); * @param node CCPI node * @param type category to enable * - *@return Zero. + *Return: Zero. */ int cvmx_error_enable_type_v3(int node, cvmx_error_type_t type); @@ -428,7 +428,7 @@ int cvmx_error_enable_type_v3(int node, cvmx_error_type_t type); * @param node CCPI node * @param type category to disable * - *@return Zero. + *Return: Zero. */ int cvmx_error_disable_type_v3(int node, cvmx_error_type_t type); @@ -449,7 +449,7 @@ int __cvmx_cn7xxx_l2c_l2d_ecc_error_display(int node, int intsn); * @param intsn intsn from error array. * @param remote true for remote node (cn78xx only) * - * @return 1 if handled, 0 if not handled + * Return: 1 if handled, 0 if not handled */ int __cvmx_cn7xxx_l2c_tag_error_display(int node, int intsn, bool remote); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-fpa.h b/arch/mips/mach-octeon/include/mach/cvmx-fpa.h index 297fb3f4a2..aa238a8850 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-fpa.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-fpa.h @@ -36,7 +36,7 @@ typedef struct cvmx_fpa_pool_config cvmx_fpa_pool_config_t; * Return the name of the pool * * @param pool_num Pool to get the name of - * @return The name + * Return: The name */ const char *cvmx_fpa_get_name(int pool_num); @@ -97,7 +97,7 @@ static inline cvmx_fpa3_gaura_t cvmx_fpa1_pool_to_fpa3_aura(cvmx_fpa1_pool_t poo * Get a new block from the FPA * * @param pool Pool to get the block from - * @return Pointer to the block or NULL on failure + * Return: Pointer to the block or NULL on failure */ static inline void *cvmx_fpa_alloc(u64 pool) { @@ -135,7 +135,7 @@ static inline void cvmx_fpa_async_alloc(u64 scr_addr, u64 pool) * @param pool Pool the block came from. Must be the same value * passed to cvmx_fpa_async_alloc. * - * @return Pointer to the block or NULL on failure + * Return: Pointer to the block or NULL on failure */ static inline void *cvmx_fpa_async_alloc_finish(u64 scr_addr, u64 pool) { @@ -194,7 +194,7 @@ static inline void cvmx_fpa_free(void *ptr, u64 pool, u64 num_cache_lines) * @param block_size Size for each block controlled by the FPA * @param num_blocks Number of blocks * - * @return the pool number on Success, + * Return: the pool number on Success, * -1 on failure */ int cvmx_fpa_setup_pool(int pool, const char *name, void *buffer, u64 block_size, u64 num_blocks); @@ -204,7 +204,7 @@ int cvmx_fpa_shutdown_pool(int pool); /** * Gets the block size of buffer in specified pool * @param pool Pool to get the block size from - * @return Size of buffer in specified pool + * Return: Size of buffer in specified pool */ unsigned int cvmx_fpa_get_block_size(int pool); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-fpa1.h b/arch/mips/mach-octeon/include/mach/cvmx-fpa1.h index 6985083a5d..a896d5a46f 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-fpa1.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-fpa1.h @@ -38,7 +38,7 @@ typedef union { * * @param pool FPA pool to allocate/reserve. If -1 it * finds an empty pool to allocate. - * @return Alloctaed pool number or CVMX_FPA1_POOL_INVALID + * Return: Alloctaed pool number or CVMX_FPA1_POOL_INVALID * if fails to allocate the pool */ cvmx_fpa1_pool_t cvmx_fpa1_reserve_pool(cvmx_fpa1_pool_t pool); @@ -46,7 +46,7 @@ cvmx_fpa1_pool_t cvmx_fpa1_reserve_pool(cvmx_fpa1_pool_t pool); /** * Free the specified fpa pool. * @param pool Pool to free - * @return 0 for success -1 failure + * Return: 0 for success -1 failure */ int cvmx_fpa1_release_pool(cvmx_fpa1_pool_t pool); @@ -173,7 +173,7 @@ static inline void cvmx_fpa1_async_alloc(u64 scr_addr, cvmx_fpa1_pool_t pool) * @param pool Pool the block came from. Must be the same value * passed to cvmx_fpa_async_alloc. * - * @return Pointer to the block or NULL on failure + * Return: Pointer to the block or NULL on failure */ static inline void *cvmx_fpa1_async_alloc_finish(u64 scr_addr, cvmx_fpa1_pool_t pool) { diff --git a/arch/mips/mach-octeon/include/mach/cvmx-fpa3.h b/arch/mips/mach-octeon/include/mach/cvmx-fpa3.h index 229982b831..b3e04d7f02 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-fpa3.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-fpa3.h @@ -206,7 +206,7 @@ static inline cvmx_fpa3_pool_t cvmx_fpa3_aura_to_pool(cvmx_fpa3_gaura_t aura) * Get a new block from the FPA pool * * @param aura - aura number - * @return pointer to the block or NULL on failure + * Return: pointer to the block or NULL on failure */ static inline void *cvmx_fpa3_alloc(cvmx_fpa3_gaura_t aura) { @@ -267,7 +267,7 @@ static inline void cvmx_fpa3_async_alloc(u64 scr_addr, cvmx_fpa3_gaura_t aura) * @param aura Global aura the block came from. Must be the same value * passed to cvmx_fpa_async_alloc. * - * @return Pointer to the block or NULL on failure + * Return: Pointer to the block or NULL on failure */ static inline void *cvmx_fpa3_async_alloc_finish(u64 scr_addr, cvmx_fpa3_gaura_t aura) { @@ -376,7 +376,7 @@ static inline int cvmx_fpa3_config_red_params(unsigned int node, int qos_avg_en, * Gets the buffer size of the specified pool, * * @param aura Global aura number - * @return Returns size of the buffers in the specified pool. + * Return: Returns size of the buffers in the specified pool. */ static inline int cvmx_fpa3_get_aura_buf_size(cvmx_fpa3_gaura_t aura) { @@ -395,7 +395,7 @@ static inline int cvmx_fpa3_get_aura_buf_size(cvmx_fpa3_gaura_t aura) * Return the number of available buffers in an AURA * * @param aura to receive count for - * @return available buffer count + * Return: available buffer count */ static inline long long cvmx_fpa3_get_available(cvmx_fpa3_gaura_t aura) { @@ -500,7 +500,7 @@ cvmx_fpa3_pool_t cvmx_fpa3_setup_fill_pool(int node, int desired_pool, const cha * @param block_size - size of buffers to use * @param num_blocks - number of blocks to allocate * - * @return configured gaura on success, CVMX_FPA3_INVALID_GAURA on failure + * Return: configured gaura on success, CVMX_FPA3_INVALID_GAURA on failure */ cvmx_fpa3_gaura_t cvmx_fpa3_set_aura_for_pool(cvmx_fpa3_pool_t pool, int desired_aura, const char *name, unsigned int block_size, diff --git a/arch/mips/mach-octeon/include/mach/cvmx-fuse.h b/arch/mips/mach-octeon/include/mach/cvmx-fuse.h index a06a1326cb..3c248b0310 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-fuse.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-fuse.h @@ -11,7 +11,7 @@ * @param node node to read from * @param byte_addr address to read * - * @return fuse value: 0 or 1 + * Return: fuse value: 0 or 1 */ static inline u8 cvmx_fuse_read_byte_node(u8 node, int byte_addr) { @@ -31,7 +31,7 @@ static inline u8 cvmx_fuse_read_byte_node(u8 node, int byte_addr) * Read a byte of fuse data * @param byte_addr address to read * - * @return fuse value: 0 or 1 + * Return: fuse value: 0 or 1 */ static inline u8 cvmx_fuse_read_byte(int byte_addr) { @@ -44,7 +44,7 @@ static inline u8 cvmx_fuse_read_byte(int byte_addr) * @param node Node number * @param fuse Fuse number (0-1024) * - * @return fuse value: 0 or 1 + * Return: fuse value: 0 or 1 */ static inline int cvmx_fuse_read_node(u8 node, int fuse) { @@ -56,7 +56,7 @@ static inline int cvmx_fuse_read_node(u8 node, int fuse) * * @param fuse Fuse number (0-1024) * - * @return fuse value: 0 or 1 + * Return: fuse value: 0 or 1 */ static inline int cvmx_fuse_read(int fuse) { diff --git a/arch/mips/mach-octeon/include/mach/cvmx-global-resources.h b/arch/mips/mach-octeon/include/mach/cvmx-global-resources.h index 28c32ddbe1..e742868360 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-global-resources.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-global-resources.h @@ -116,7 +116,7 @@ int cvmx_create_global_resource_range(struct global_resource_tag tag, int neleme * @param nelements is the number of elements to be allocated. * @param owner is a 64 bit number that identifes the owner of this range. * @aligment specifes the required alignment of the returned base number. - * @return returns the base of the allocated range. -1 return value indicates + * Return: returns the base of the allocated range. -1 return value indicates * failure. */ int cvmx_allocate_global_resource_range(struct global_resource_tag tag, u64 owner, int nelements, @@ -133,7 +133,7 @@ int cvmx_allocate_global_resource_range(struct global_resource_tag tag, u64 owne * @param owner is a 64 bit number that identifes the owner of the allocated * elements. * @param allocated_elements returns indexs of the allocated entries. - * @return returns 0 on success and -1 on failure. + * Return: returns 0 on success and -1 on failure. */ int cvmx_resource_alloc_many(struct global_resource_tag tag, u64 owner, int nelements, int allocated_elements[]); @@ -148,7 +148,7 @@ int cvmx_resource_alloc_reverse(struct global_resource_tag, u64 owner); * @param nelements is the number of elements to be allocated. * @param owner is a 64 bit number that identifes the owner of this range. * @base specifies the base start of nelements. - * @return returns the base of the allocated range. -1 return value indicates + * Return: returns the base of the allocated range. -1 return value indicates * failure. */ int cvmx_reserve_global_resource_range(struct global_resource_tag tag, u64 owner, int base, @@ -160,7 +160,7 @@ int cvmx_reserve_global_resource_range(struct global_resource_tag tag, u64 owner * @param tag is the tag of the global resource range. * @param base is the base number * @param nelements is the number of elements that are to be freed. - * @return returns 0 if successful and -1 on failure. + * Return: returns 0 if successful and -1 on failure. */ int cvmx_free_global_resource_range_with_base(struct global_resource_tag tag, int base, int nelements); @@ -172,7 +172,7 @@ int cvmx_free_global_resource_range_with_base(struct global_resource_tag tag, in * @param tag is the tag of the global resource range. * @param bases is an array containing the bases to be freed. * @param nelements is the number of elements that are to be freed. - * @return returns 0 if successful and -1 on failure. + * Return: returns 0 if successful and -1 on failure. */ int cvmx_free_global_resource_range_multiple(struct global_resource_tag tag, int bases[], int nelements); @@ -182,7 +182,7 @@ int cvmx_free_global_resource_range_multiple(struct global_resource_tag tag, int * specified tag. * @param tag is the tag of the global resource range. * @param owner is the owner of resources that are to be freed. - * @return returns 0 if successful and -1 on failure. + * Return: returns 0 if successful and -1 on failure. */ int cvmx_free_global_resource_range_with_owner(struct global_resource_tag tag, int owner); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-agl.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-agl.h index 7a5e4d89d3..68a3079c0c 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-agl.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-agl.h @@ -21,7 +21,7 @@ int cvmx_helper_agl_get_port(int xiface); * * @param interface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_agl_probe(int interface); @@ -33,7 +33,7 @@ int __cvmx_helper_agl_probe(int interface); * * @param interface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_agl_enable(int interface); @@ -46,7 +46,7 @@ int __cvmx_helper_agl_enable(int interface); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_agl_link_get(int ipd_port); @@ -61,7 +61,7 @@ cvmx_helper_link_info_t __cvmx_helper_agl_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_agl_link_set(int ipd_port, cvmx_helper_link_info_t link_info); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-bgx.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-bgx.h index ead6193ec0..4edfdf9cc2 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-bgx.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-bgx.h @@ -29,7 +29,7 @@ void cvmx_helper_bgx_disable(int xipd_port); * * @param xiface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_bgx_probe(int xiface); @@ -42,7 +42,7 @@ int __cvmx_helper_bgx_probe(int xiface); * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_bgx_sgmii_enable(int xiface); @@ -56,7 +56,7 @@ int __cvmx_helper_bgx_sgmii_enable(int xiface); * * @param xipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_bgx_sgmii_link_get(int xipd_port); @@ -72,7 +72,7 @@ cvmx_helper_link_info_t __cvmx_helper_bgx_sgmii_link_get(int xipd_port); * @param xipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_bgx_sgmii_link_set(int xipd_port, cvmx_helper_link_info_t link_info); @@ -89,7 +89,7 @@ int __cvmx_helper_bgx_sgmii_link_set(int xipd_port, cvmx_helper_link_info_t link * @param enable_external * Non zero if you want external loopback * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int __cvmx_helper_bgx_sgmii_configure_loopback(int xipd_port, int enable_internal, int enable_external); @@ -103,7 +103,7 @@ int __cvmx_helper_bgx_sgmii_configure_loopback(int xipd_port, int enable_interna * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_bgx_xaui_enable(int xiface); @@ -117,7 +117,7 @@ int __cvmx_helper_bgx_xaui_enable(int xiface); * * @param xipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_bgx_xaui_link_get(int xipd_port); @@ -133,7 +133,7 @@ cvmx_helper_link_info_t __cvmx_helper_bgx_xaui_link_get(int xipd_port); * @param xipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_bgx_xaui_link_set(int xipd_port, cvmx_helper_link_info_t link_info); @@ -150,7 +150,7 @@ int __cvmx_helper_bgx_xaui_link_set(int xipd_port, cvmx_helper_link_info_t link_ * @param enable_external * Non zero if you want external loopback * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int __cvmx_helper_bgx_xaui_configure_loopback(int xipd_port, int enable_internal, int enable_external); @@ -239,7 +239,7 @@ int __cvmx_helper_bgx_fifo_size(int xiface, unsigned int lmac); * @param xiface xinterface to check * @param index port index (must be 0 for rgmii) * - * @return true if RGMII, false otherwise + * Return: true if RGMII, false otherwise */ static inline bool cvmx_helper_bgx_is_rgmii(int xiface, int index) { @@ -257,7 +257,7 @@ static inline bool cvmx_helper_bgx_is_rgmii(int xiface, int index) * @param xiface global interface number * @param index interface index * - * @return true, if Super-MAC/PCS mode, false -- otherwise + * Return: true, if Super-MAC/PCS mode, false -- otherwise */ bool cvmx_helper_bgx_is_smu(int xiface, int index); @@ -271,7 +271,7 @@ bool cvmx_helper_bgx_is_smu(int xiface, int index); * @param type PAUSE packet type. * @param time Pause time for PAUSE packets (number of 512 bit-times). * @param interval Interval between PAUSE packets (number of 512 bit-times). - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_bgx_set_pause_pkt_param(int xipd_port, u64 smac, u64 dmac, unsigned int type, unsigned int time, unsigned int interval); @@ -283,7 +283,7 @@ int cvmx_bgx_set_pause_pkt_param(int xipd_port, u64 smac, u64 dmac, unsigned int * @param xipd_port Global IPD port (node + IPD port). * @param type Flow-control type/protocol. * @param mode Flow-control mode. - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_bgx_set_flowctl_mode(int xipd_port, cvmx_qos_proto_t qos, cvmx_qos_pkt_mode_t mode); @@ -294,7 +294,7 @@ int cvmx_bgx_set_flowctl_mode(int xipd_port, cvmx_qos_proto_t qos, cvmx_qos_pkt_ * @param index port index * @param enable true to enable autonegotiation, false to disable it * - * @return 0 for success, -1 on error. + * Return: 0 for success, -1 on error. */ int cvmx_helper_set_autonegotiation(int xiface, int index, bool enable); @@ -305,7 +305,7 @@ int cvmx_helper_set_autonegotiation(int xiface, int index, bool enable); * @param index port index * @param enable set to true to enable FEC, false to disable * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error * * @NOTE: If autonegotiation is enabled then autonegotiation will be * restarted for negotiating FEC. diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-board.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-board.h index d7a7b7d227..5837592d21 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-board.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-board.h @@ -329,7 +329,7 @@ typedef struct cvmx_phy_info { * * @param ipd_port Octeon IPD port to get the MII address for. * - * @return MII PHY address and bus number or -1. + * Return: MII PHY address and bus number or -1. */ int cvmx_helper_board_get_mii_address(int ipd_port); @@ -346,7 +346,7 @@ int cvmx_helper_board_get_mii_address(int ipd_port); * @param link_info Link speed to program. If the speed is zero and autonegotiation * is enabled, all possible negotiation speeds are advertised. * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_board_link_set_phy(int phy_addr, cvmx_helper_board_set_phy_link_flags_types_t link_flags, @@ -368,7 +368,7 @@ int cvmx_helper_board_link_set_phy(int phy_addr, * @param ipd_port IPD input port associated with the port we want to get link * status for. * - * @return The ports link status. If the link isn't fully resolved, this must + * Return: The ports link status. If the link isn't fully resolved, this must * return zero. */ cvmx_helper_link_info_t __cvmx_helper_board_link_get(int ipd_port); @@ -392,7 +392,7 @@ cvmx_helper_link_info_t __cvmx_helper_board_link_get(int ipd_port); * @param supported_ports * Number of ports Octeon supports. * - * @return Number of ports the actual board supports. Many times this will + * Return: Number of ports the actual board supports. Many times this will * simple be "support_ports". */ int __cvmx_helper_board_interface_probe(int interface, int supported_ports); @@ -406,7 +406,7 @@ int __cvmx_helper_board_interface_probe(int interface, int supported_ports); * * @param interface Interface to enable * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_board_hardware_enable(int interface); @@ -415,7 +415,7 @@ int __cvmx_helper_board_hardware_enable(int interface); * Gets the clock type used for the USB block based on board type. * Used by the USB code for auto configuration of clock type. * - * @return USB clock type enumeration + * Return: USB clock type enumeration */ cvmx_helper_board_usb_clock_types_t __cvmx_helper_board_usb_get_clock_type(void); @@ -427,7 +427,7 @@ cvmx_helper_board_usb_clock_types_t __cvmx_helper_board_usb_get_clock_type(void) * @param supported_ports expected number of ports based on chip type; * * - * @return number of available usb ports, based on board specifics. + * Return: number of available usb ports, based on board specifics. * Return value is supported_ports if function does not * override. */ @@ -440,7 +440,7 @@ int __cvmx_helper_board_usb_get_num_ports(int supported_ports); * @param fdt_addr - address fo flat device tree * @param ipd_port - IPD port number * - * @return 1 if port is present, 0 if not present, -1 if error + * Return: 1 if port is present, 0 if not present, -1 if error */ int __cvmx_helper_board_get_port_from_dt(void *fdt_addr, int ipd_port); @@ -450,7 +450,7 @@ int __cvmx_helper_board_get_port_from_dt(void *fdt_addr, int ipd_port); * * @param ipd_port - ipd port number to get the host mode for * - * @return host mode for phy + * Return: host mode for phy */ cvmx_phy_host_mode_t cvmx_helper_board_get_phy_host_mode(int ipd_port); @@ -462,7 +462,7 @@ cvmx_phy_host_mode_t cvmx_helper_board_get_phy_host_mode(int ipd_port); * @param[out] - phy_info - phy info data structure * @param ipd_port - port to get phy info for * - * @return 0 for success, -1 if info not available + * Return: 0 for success, -1 if info not available * * NOTE: The phy_info data structure is subject to change. */ @@ -474,7 +474,7 @@ int cvmx_helper_board_get_phy_info(cvmx_phy_info_t *phy_info, int ipd_port); * * @param fdt_addr Pointer to device tree * - * @return 0 for success, -1 on error. + * Return: 0 for success, -1 on error. */ int __cvmx_helper_parse_bgx_dt(const void *fdt_addr); @@ -484,7 +484,7 @@ int __cvmx_helper_parse_bgx_dt(const void *fdt_addr); * * @param fdt_addr Pointer to device tree * - * @return 0 for success, -1 on error. + * Return: 0 for success, -1 on error. */ int __cvmx_helper_parse_bgx_rgmii_dt(const void *fdt_addr); @@ -513,7 +513,7 @@ void cvmx_update_rx_activity_led(int xiface, int index, bool check_time); * @param xiface xinterface number * @param index port index on interface * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error * * This function figures out the proper mod_abs_changed function to use and * registers the appropriate function. This should be called after the device @@ -529,7 +529,7 @@ int cvmx_helper_phy_register_mod_abs_changed(int xiface, int index); * @param xiface xinterface number * @param index port index on interface * - * @return 0 if signal present, 1 if loss of signal. + * Return: 0 if signal present, 1 if loss of signal. * * @NOTE: A result of 0 is possible in some cases where the signal is * not present. diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-cfg.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-cfg.h index d4bd910b01..39260d8649 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-cfg.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-cfg.h @@ -193,7 +193,7 @@ extern int cvmx_enable_helper_flag; * * @param interface the interface number * @param index the port's index number - * @return the pknd + * Return: the pknd */ int __cvmx_helper_cfg_pknd(int interface, int index); @@ -203,7 +203,7 @@ int __cvmx_helper_cfg_pknd(int interface, int index); * * @param interface the interface number * @param index the port's index number - * @return the bpid + * Return: the bpid */ int __cvmx_helper_cfg_bpid(int interface, int index); @@ -213,7 +213,7 @@ int __cvmx_helper_cfg_bpid(int interface, int index); * * @param interface the interface number * @param index the port's index number - * @return the pko_port base + * Return: the pko_port base */ int __cvmx_helper_cfg_pko_port_base(int interface, int index); @@ -223,7 +223,7 @@ int __cvmx_helper_cfg_pko_port_base(int interface, int index); * * @param interface the interface number * @param index the port's index number - * @return the number of pko_ports + * Return: the number of pko_ports */ int __cvmx_helper_cfg_pko_port_num(int interface, int index); @@ -232,7 +232,7 @@ int __cvmx_helper_cfg_pko_port_num(int interface, int index); * Return the configured pko_queue base for the pko_port * * @param pko_port - * @return the pko_queue base + * Return: the pko_queue base */ int __cvmx_helper_cfg_pko_queue_base(int pko_port); @@ -241,7 +241,7 @@ int __cvmx_helper_cfg_pko_queue_base(int pko_port); * Return the configured number of pko_queues for the pko_port * * @param pko_port - * @return the number of pko_queues + * Return: the number of pko_queues */ int __cvmx_helper_cfg_pko_queue_num(int pko_port); @@ -250,7 +250,7 @@ int __cvmx_helper_cfg_pko_queue_num(int pko_port); * Return the interface the pko_port is configured for * * @param pko_port - * @return the interface for the pko_port + * Return: the interface for the pko_port */ int __cvmx_helper_cfg_pko_port_interface(int pko_port); @@ -259,7 +259,7 @@ int __cvmx_helper_cfg_pko_port_interface(int pko_port); * Return the index of the port the pko_port is configured for * * @param pko_port - * @return the index of the port + * Return: the index of the port */ int __cvmx_helper_cfg_pko_port_index(int pko_port); @@ -268,7 +268,7 @@ int __cvmx_helper_cfg_pko_port_index(int pko_port); * Return the pko_eid of the pko_port * * @param pko_port - * @return the pko_eid + * Return: the pko_eid */ int __cvmx_helper_cfg_pko_port_eid(int pko_port); @@ -276,7 +276,7 @@ int __cvmx_helper_cfg_pko_port_eid(int pko_port); * @INTERNAL * Return the max# of pko queues allocated. * - * @return the max# of pko queues + * Return: the max# of pko queues * * Note: there might be holes in the queue space depending on user * configuration. The function returns the highest queue's index in @@ -288,7 +288,7 @@ int __cvmx_helper_cfg_pko_max_queue(void); * @INTERNAL * Return the max# of PKO DMA engines allocated. * - * @return the max# of DMA engines + * Return: the max# of DMA engines * * NOTE: the DMA engines are allocated contiguously and starting from * 0. @@ -299,7 +299,7 @@ int __cvmx_helper_cfg_pko_max_engine(void); * Get the value set for the config option ``opt''. * * @param opt is the config option. - * @return the value set for the option + * Return: the value set for the option * * LR: only used for DWB in NPI, POW, PKO1 */ @@ -310,7 +310,7 @@ u64 cvmx_helper_cfg_opt_get(cvmx_helper_cfg_option_t opt); * * @param opt is the config option. * @param val is the value to set for the opt. - * @return 0 for success and -1 on error + * Return: 0 for success and -1 on error * * Note an option here is a config-time parameter and this means that * it has to be set before calling the corresponding setup functions @@ -324,7 +324,7 @@ int cvmx_helper_cfg_opt_set(cvmx_helper_cfg_option_t opt, u64 val); * Retrieve the pko_port base given ipd_port. * * @param ipd_port is the IPD eport - * @return the corresponding PKO port base for the physical port + * Return: the corresponding PKO port base for the physical port * represented by the IPD eport or CVMX_HELPER_CFG_INVALID_VALUE. */ int cvmx_helper_cfg_ipd2pko_port_base(int ipd_port); @@ -333,7 +333,7 @@ int cvmx_helper_cfg_ipd2pko_port_base(int ipd_port); * Retrieve the number of pko_ports given ipd_port. * * @param ipd_port is the IPD eport - * @return the corresponding number of PKO ports for the physical port + * Return: the corresponding number of PKO ports for the physical port * represented by IPD eport or CVMX_HELPER_CFG_INVALID_VALUE. */ int cvmx_helper_cfg_ipd2pko_port_num(int ipd_port); @@ -343,7 +343,7 @@ int cvmx_helper_cfg_ipd2pko_port_num(int ipd_port); * The init function * * @param node - * @return 0 for success. + * Return: 0 for success. * * Note: this function is meant to be called to set the ``configured * parameters,'' e.g., pknd, bpid, etc. and therefore should be before @@ -357,7 +357,7 @@ int __cvmx_helper_init_port_config_data(int node); * The local init function * * @param none - * @return 0 for success. + * Return: 0 for success. * * Note: this function is meant to be called to set the ``configured * parameters locally,'' e.g., pknd, bpid, etc. and therefore should be before @@ -390,7 +390,7 @@ void cvmx_helper_cfg_store_short_packets_in_wqe(void); * port. This call will allocate a total of * (port_cnt * queue_cnt) queues * - * @return 0 on success + * Return: 0 on success * -1 on failure * * LR: Called ONLY from comfig-parse! @@ -402,14 +402,14 @@ int cvmx_pko_alloc_iport_and_queues(int interface, int port, int port_cnt, int q * * @param port the internal port for which the queues are freed. * - * @return 0 on success + * Return: 0 on success * -1 on failure */ int cvmx_pko_queue_free(u64 port); /* * Initializes the pko queue range data structure. - * @return 0 on success + * Return: 0 on success * -1 on failure */ int init_cvmx_pko_que_range(void); @@ -425,7 +425,7 @@ void cvmx_pko_queue_free_all(void); * @param xiface interface to check * @param index port index in the interface * - * @return status of the port present or not. + * Return: status of the port present or not. */ int cvmx_helper_is_port_valid(int xiface, int index); @@ -445,7 +445,7 @@ void cvmx_helper_set_port_valid(int interface, int index, bool valid); * @param interface the interface number * @param index the port's index number * - * @return 1 if port is in PHY mode, 0 if port is in MAC mode + * Return: 1 if port is in PHY mode, 0 if port is in MAC mode */ bool cvmx_helper_get_mac_phy_mode(int interface, int index); void cvmx_helper_set_mac_phy_mode(int interface, int index, bool valid); @@ -457,7 +457,7 @@ void cvmx_helper_set_mac_phy_mode(int interface, int index, bool valid); * @param interface the interface number * @param index the port's index number * - * @return 1 if port is in 1000Base X mode, 0 if port is in SGMII mode + * Return: 1 if port is in 1000Base X mode, 0 if port is in SGMII mode */ bool cvmx_helper_get_1000x_mode(int interface, int index); void cvmx_helper_set_1000x_mode(int interface, int index, bool valid); @@ -521,7 +521,7 @@ void cvmx_helper_set_port_fdt_node_offset(int xiface, int index, int node_offset * * @param xiface node and interface * @param index port index - * @return node offset of port or -1 if invalid + * Return: node offset of port or -1 if invalid */ int cvmx_helper_get_port_fdt_node_offset(int xiface, int index); @@ -541,7 +541,7 @@ void cvmx_helper_set_phy_fdt_node_offset(int xiface, int index, int node_offset) * * @param xiface node and interface * @param index port index - * @return node offset of phy or -1 if invalid + * Return: node offset of phy or -1 if invalid */ int cvmx_helper_get_phy_fdt_node_offset(int xiface, int index); @@ -563,7 +563,7 @@ void cvmx_helper_set_port_autonegotiation(int xiface, int index, bool enable); * @param xiface node and interface * @param index port index * - * @return 0 if autonegotiation is disabled, 1 if enabled. + * Return: 0 if autonegotiation is disabled, 1 if enabled. */ bool cvmx_helper_get_port_autonegotiation(int xiface, int index); @@ -574,7 +574,7 @@ bool cvmx_helper_get_port_autonegotiation(int xiface, int index); * @param xiface node and interface * @param index port index * - * @return 0 if fec is disabled, 1 if enabled. + * Return: 0 if fec is disabled, 1 if enabled. */ bool cvmx_helper_get_port_fec(int xiface, int index); @@ -683,7 +683,7 @@ void cvmx_helper_set_port_phy_info(int xiface, int index, struct cvmx_phy_info * * @param xiface node and interface * @param index port index * - * @return pointer to PHY information data structure or NULL if not set + * Return: pointer to PHY information data structure or NULL if not set */ struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index); @@ -694,7 +694,7 @@ struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index); * @param xiface node and interface * @param index portindex * - * @return pointer to the PHY LED information data structure or NULL if not + * Return: pointer to the PHY LED information data structure or NULL if not * present */ struct cvmx_phy_gpio_leds *cvmx_helper_get_port_phy_leds(int xiface, int index); @@ -760,7 +760,7 @@ int cvmx_helper_pko_queue_config_set(int node, cvmx_user_static_pko_queue_config * @param xiface node and interface * @param index port index * - * @return offset in device tree or -1 if error or not defined. + * Return: offset in device tree or -1 if error or not defined. */ int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index); @@ -769,7 +769,7 @@ int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index); * * @param of_offset Node offset of port to search for * - * @return ipd_port or -1 if not found + * Return: ipd_port or -1 if not found */ int cvmx_helper_cfg_get_ipd_port_by_fdt_node_offset(int of_offset); @@ -790,7 +790,7 @@ void cvmx_helper_cfg_set_sfp_fdt_offset(int xiface, int index, int sfp_of_offset * @param[out] xiface xinterface of match * @param[out] index port index of match * - * @return 0 if found, -1 if not found + * Return: 0 if found, -1 if not found */ int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xiface, int *index); @@ -801,7 +801,7 @@ int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xifa * @param xiface node and interface * @param index port index * - * @return pointer to vsc7224 data structure or NULL if not present + * Return: pointer to vsc7224 data structure or NULL if not present */ struct cvmx_vsc7224_chan *cvmx_helper_cfg_get_vsc7224_chan_info(int xiface, int index); @@ -822,7 +822,7 @@ void cvmx_helper_cfg_set_vsc7224_chan_info(int xiface, int index, * @param xiface node and interface * @param index port index * - * @return pointer to avsp5410 data structure or NULL if not present + * Return: pointer to avsp5410 data structure or NULL if not present */ struct cvmx_avsp5410 *cvmx_helper_cfg_get_avsp5410_info(int xiface, int index); @@ -841,7 +841,7 @@ void cvmx_helper_cfg_set_avsp5410_info(int xiface, int index, struct cvmx_avsp54 * @param xiface node and interface * @param index port index * - * @return pointer to SFP data structure or NULL if none + * Return: pointer to SFP data structure or NULL if none */ struct cvmx_fdt_sfp_info *cvmx_helper_cfg_get_sfp_info(int xiface, int index); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-errata.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-errata.h index 9ed13c1626..697a6f04b8 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-errata.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-errata.h @@ -17,7 +17,7 @@ * @INTERNAL * Function to adjust internal IPD pointer alignments * - * @return 0 on success + * Return: 0 on success * !0 on failure */ int __cvmx_helper_errata_fix_ipd_ptr_alignment(void); @@ -35,7 +35,7 @@ int __cvmx_helper_errata_fix_ipd_ptr_alignment(void); * in each buffer). * * @param work Work queue entry to fix - * @return Zero on success. Negative on failure + * Return: Zero on success. Negative on failure */ int cvmx_helper_fix_ipd_packet_chain(cvmx_wqe_t *work); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h index d3809aec29..3328845570 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h @@ -141,7 +141,7 @@ struct cvmx_fdt_sfp_info { * @param[in,out] lenp Number of phandles, input max number * @param[out] nodes Array of phandle nodes * - * @return -ve error code on error or 0 for success + * Return: -ve error code on error or 0 for success */ int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, const char *prop_name, int *lenp, int *nodes); @@ -153,7 +153,7 @@ int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, const char *prop_na * @param node node to read address from * @param prop_name property name to read * - * @return address of property or FDT_ADDR_T_NONE if not found + * Return: address of property or FDT_ADDR_T_NONE if not found */ static inline fdt_addr_t cvmx_fdt_get_addr(const void *fdt_addr, int node, const char *prop_name) { @@ -168,7 +168,7 @@ static inline fdt_addr_t cvmx_fdt_get_addr(const void *fdt_addr, int node, const * @param[in] prop_name property name to read * @param default_val default value to return if property doesn't exist * - * @return integer value of property or default_val if it doesn't exist. + * Return: integer value of property or default_val if it doesn't exist. */ static inline int cvmx_fdt_get_int(const void *fdt_addr, int node, const char *prop_name, int default_val) @@ -195,7 +195,7 @@ static inline u64 cvmx_fdt_get_uint64(const void *fdt_addr, int node, const char * @param node node to read phandle from * @param[in] prop_name name of property to find * - * @return node offset if found, -ve error code on error + * Return: node offset if found, -ve error code on error */ static inline int cvmx_fdt_lookup_phandle(const void *fdt_addr, int node, const char *prop_name) { @@ -214,7 +214,7 @@ static inline int cvmx_fdt_lookup_phandle(const void *fdt_addr, int node, const * NOTE: in_addr must be in the native ENDIAN * format. * - * @return Translated address or FDT_ADDR_T_NONE if address cannot be + * Return: Translated address or FDT_ADDR_T_NONE if address cannot be * translated. */ static inline u64 cvmx_fdt_translate_address(const void *fdt_addr, int node, const u32 *in_addr) @@ -228,7 +228,7 @@ static inline u64 cvmx_fdt_translate_address(const void *fdt_addr, int node, con * @param[in] s1 First string to compare * @param[in] sw Second string to compare * - * @return 0 if no match + * Return: 0 if no match * 1 if only the part number matches and not the manufacturer * 2 if both the part number and manufacturer match */ @@ -241,7 +241,7 @@ int cvmx_fdt_compat_match(const char *s1, const char *s2); * @param llen string list total length * @param[in] str string to search for * - * @return 1 if string list contains string, 0 if it does not. + * Return: 1 if string list contains string, 0 if it does not. */ int cvmx_fdt_compat_list_contains(const char *slist, int llen, const char *str); @@ -252,7 +252,7 @@ int cvmx_fdt_compat_list_contains(const char *slist, int llen, const char *str); * @param node node offset to check * @param[in] compat compatible string to check * - * @return 0 if compatible, 1 if not compatible, error if negative + * Return: 0 if compatible, 1 if not compatible, error if negative */ int cvmx_fdt_node_check_compatible(const void *fdt_addr, int node, const char *compat); @@ -263,7 +263,7 @@ int cvmx_fdt_node_check_compatible(const void *fdt_addr, int node, const char *c * @param[in] compat compatible string * @param[in] str string to check * - * @return 0 if not compatible, 1 if manufacturer compatible, 2 if + * Return: 0 if not compatible, 1 if manufacturer compatible, 2 if * part is compatible, 3 if both part and manufacturer are * compatible. */ @@ -276,7 +276,7 @@ int __cvmx_fdt_compat_match(const char *compat, const char *str); * @param phandle phandle to GPIO * @param[out] size Number of pins (optional, may be NULL) * - * @return Type of GPIO device or PIN_ERROR if error + * Return: Type of GPIO device or PIN_ERROR if error */ enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, int *size); @@ -289,7 +289,7 @@ enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, in * NULL for none. * @param[out] addr TWSI address number, can be NULL for none * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ int cvmx_fdt_get_twsi_gpio_bus_addr(const void *fdt_addr, int phandle, int *bus, int *addr); @@ -299,7 +299,7 @@ int cvmx_fdt_get_twsi_gpio_bus_addr(const void *fdt_addr, int phandle, int *bus, * @param[in] fdt_addr Address of FDT * @param node FDT node number * - * @return CPU node number or error if negative + * Return: CPU node number or error if negative */ int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node); @@ -308,7 +308,7 @@ int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node); * * @param[in] fdt_addr Address of FDT * - * @return Size of flat device tree in bytes or -1 if error. + * Return: Size of flat device tree in bytes or -1 if error. */ int cvmx_fdt_get_fdt_size(const void *fdt_addr); @@ -320,7 +320,7 @@ int cvmx_fdt_get_fdt_size(const void *fdt_addr); * @param[in] strlist Array of FDT device compatibility strings, * must end with NULL or empty string. * - * @return 0 if at least one item matches, 1 if no matches + * Return: 0 if at least one item matches, 1 if no matches */ int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const char *const *strlist); @@ -332,7 +332,7 @@ int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const ch * @param strlist Array of FDT device compatibility strings, must * end with NULL or empty string. * - * @return next matching node or -1 if no more matches. + * Return: next matching node or -1 if no more matches. */ int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffset, const char *const *strlist); @@ -345,7 +345,7 @@ int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffse * @param of_offset Offset of the parent node of a GPIO device in * the device tree. * - * @return pointer to list of i2c devices starting from the root which + * Return: pointer to list of i2c devices starting from the root which * can include i2c muxes and switches or NULL if error. Note that * all entries are allocated on the heap. * @@ -358,7 +358,7 @@ struct cvmx_fdt_i2c_bus_info *cvmx_fdt_get_i2c_bus(const void *fdt_addr, int of_ * * @param[in] bus bus descriptor * - * @return Octeon twsi bus number or -1 on error + * Return: Octeon twsi bus number or -1 on error */ int cvmx_fdt_i2c_get_root_bus(const struct cvmx_fdt_i2c_bus_info *bus); @@ -367,7 +367,7 @@ int cvmx_fdt_i2c_get_root_bus(const struct cvmx_fdt_i2c_bus_info *bus); * * @param bus bus to free * - * @return 0 + * Return: 0 */ int cvmx_fdt_free_i2c_bus(struct cvmx_fdt_i2c_bus_info *bus); @@ -377,7 +377,7 @@ int cvmx_fdt_free_i2c_bus(struct cvmx_fdt_i2c_bus_info *bus); * @param[in] bus i2c bus descriptor to enable or disable * @param enable set to true to enable, false to disable * - * @return 0 for success or -1 for invalid bus + * Return: 0 for success or -1 for invalid bus * * This enables the entire bus including muxes and switches in the path. */ @@ -390,7 +390,7 @@ int cvmx_fdt_enable_i2c_bus(const struct cvmx_fdt_i2c_bus_info *bus, bool enable * @param of_offset node offset for property * @param prop_name name of property * - * @return pointer to GPIO handle or NULL if error + * Return: pointer to GPIO handle or NULL if error */ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, int of_offset, const char *prop_name); @@ -401,7 +401,7 @@ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, * @param pin GPIO pin descriptor * @param value value to set it to, 0 or 1 * - * @return 0 on success, -1 on error. + * Return: 0 on success, -1 on error. * * NOTE: If the CVMX_GPIO_ACTIVE_LOW flag is set then the output value will be * inverted. @@ -413,7 +413,7 @@ int cvmx_fdt_gpio_set(struct cvmx_fdt_gpio_info *pin, int value); * * @param pin GPIO pin descriptor * - * @return 0 if low, 1 if high, -1 on error. Note that the input will be + * Return: 0 if low, 1 if high, -1 on error. Note that the input will be * inverted if the CVMX_GPIO_ACTIVE_LOW flag bit is set. */ int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin); @@ -424,7 +424,7 @@ int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin); * @param sfp Handle to SFP data structure * @param ipd_port Port to assign it to * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port); @@ -433,7 +433,7 @@ int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port); * * @param[in] sfp Handle to SFP data structure * - * @return IPD port number for SFP slot + * Return: IPD port number for SFP slot */ static inline int cvmx_sfp_get_ipd_port(const struct cvmx_fdt_sfp_info *sfp) { @@ -469,7 +469,7 @@ void cvmx_sfp_attach_phy(struct cvmx_fdt_sfp_info *sfp, struct cvmx_phy_info *ph * * @param[in] sfp SFP to get phy info from * - * @return phy descriptor or NULL if none. + * Return: phy descriptor or NULL if none. */ static inline struct cvmx_phy_info *cvmx_sfp_get_phy_info(const struct cvmx_fdt_sfp_info *sfp) { @@ -482,7 +482,7 @@ static inline struct cvmx_phy_info *cvmx_sfp_get_phy_info(const struct cvmx_fdt_ * * @param[in] fdt_addr Address of flat device tree * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ int __cvmx_fdt_parse_vsc7224(const void *fdt_addr); @@ -492,7 +492,7 @@ int __cvmx_fdt_parse_vsc7224(const void *fdt_addr); * * @param[in] fdt_addr Address of flat device tree * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ int __cvmx_fdt_parse_avsp5410(const void *fdt_addr); @@ -501,7 +501,7 @@ int __cvmx_fdt_parse_avsp5410(const void *fdt_addr); * * @param[in] fdt_addr Address of flat device tree * - * @return pointer to sfp info or NULL if error + * Return: pointer to sfp info or NULL if error */ struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, int of_offset); @@ -512,7 +512,7 @@ struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, i * @param of_offset offset of slice or phy in device tree * @param phy_info phy_info data structure to fill in * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int cvmx_fdt_parse_cs4343(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info); @@ -533,7 +533,7 @@ void cvmx_fdt_i2c_reg_write(int bus, int addr, u8 val); * @param bus i2c bus number * @param addr i2c device address (7 bits) * - * @return 8-bit value or error if negative + * Return: 8-bit value or error if negative */ int cvmx_fdt_i2c_reg_read(int bus, int addr); @@ -545,7 +545,7 @@ int cvmx_fdt_i2c_reg_read(int bus, int addr); * @param reg i2c 8-bit register address * @param val 8-bit value to write * - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ int cvmx_fdt_i2c_write8(int bus, int addr, int reg, u8 val); @@ -556,7 +556,7 @@ int cvmx_fdt_i2c_write8(int bus, int addr, int reg, u8 val); * @param addr i2c device address (7 bits) * @param reg i2c 8-bit register address * - * @return value or error if negative + * Return: value or error if negative */ int cvmx_fdt_i2c_read8(int bus, int addr, int reg); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-fpa.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-fpa.h index 8b3a89bce4..766cb074a5 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-fpa.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-fpa.h @@ -29,7 +29,7 @@ * @param dfa_buffers * DFA command buffer. A relatively small (32 for example) * number should work. - * @return Zero on success, non-zero if out of memory + * Return: Zero on success, non-zero if out of memory */ int cvmx_helper_initialize_fpa(int packet_buffers, int work_queue_entries, int pko_buffers, int tim_buffers, int dfa_buffers); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-gpio.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-gpio.h index 787eccf4aa..b63f654eda 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-gpio.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-gpio.h @@ -272,7 +272,7 @@ struct cvmx_fdt_gpio_led { * @param[in] fdt_addr Pointer to FDT * @param phandle phandle of GPIO entry * - * @return Pointer to op function or NULL if not found. + * Return: Pointer to op function or NULL if not found. */ cvmx_fdt_gpio_op_func_t cvmx_fdt_gpio_get_op_func(const void *fdt_addr, int phandle); @@ -283,7 +283,7 @@ cvmx_fdt_gpio_op_func_t cvmx_fdt_gpio_get_op_func(const void *fdt_addr, int phan * @param phandle phandle to GPIO * @param[out] size Number of pins (optional, may be NULL) * - * @return Type of GPIO device or PIN_ERROR if error + * Return: Type of GPIO device or PIN_ERROR if error */ enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, int *size); @@ -294,7 +294,7 @@ enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, in * @param of_offset node offset of GPIO device * @param prop_name name of property * - * @return pointer to GPIO handle or NULL if error + * Return: pointer to GPIO handle or NULL if error */ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info(const void *fdt_addr, int of_offset, const char *prop_name); @@ -306,7 +306,7 @@ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info(const void *fdt_addr, int of_o * @param of_offset node offset for property * @param prop_name name of property * - * @return pointer to GPIO handle or NULL if error + * Return: pointer to GPIO handle or NULL if error */ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, int of_offset, const char *prop_name); @@ -320,7 +320,7 @@ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, * @param flags flags set (1 = invert) * @param[out] gpio GPIO info data structure * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int cvmx_fdt_parse_gpio(const void *fdt_addr, int phandle, int pin, u32 flags, struct cvmx_fdt_gpio_info *gpio); @@ -336,7 +336,7 @@ void cvmx_fdt_gpio_set_timer(struct cvmx_fdt_gpio_info *gpio, int timer); * * @param pin GPIO pin descriptor * - * @return 0 if low, 1 if high, -1 on error. Note that the input will be + * Return: 0 if low, 1 if high, -1 on error. Note that the input will be * inverted if the CVMX_GPIO_ACTIVE_LOW flag bit is set. */ int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin); @@ -347,7 +347,7 @@ int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin); * @param gpio GPIO pin descriptor * @param value value to set it to, 0 or 1 * - * @return 0 on success, -1 on error. + * Return: 0 on success, -1 on error. * * NOTE: If the CVMX_GPIO_ACTIVE_LOW flag is set then the output value will be * inverted. @@ -368,7 +368,7 @@ void cvmx_fdt_gpio_set_freq(struct cvmx_fdt_gpio_info *gpio, int freq); * @param gpio GPIO handle * @param blink True to start blinking, false to stop * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error * NOTE: Not all GPIO types support blinking. */ int cvmx_fdt_gpio_set_blink(struct cvmx_fdt_gpio_info *gpio, bool blink); @@ -379,7 +379,7 @@ int cvmx_fdt_gpio_set_blink(struct cvmx_fdt_gpio_info *gpio, bool blink); * @param gpio GPIO handle * @param blink True to start blinking, false to use link status * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error * NOTE: Not all GPIO types support this. */ int cvmx_fdt_gpio_set_link_blink(struct cvmx_fdt_gpio_info *gpio, bool blink); @@ -404,7 +404,7 @@ void cvmx_fdt_gpio_set_output(struct cvmx_fdt_gpio_info *gpio, bool output); * @param gpio GPIO assigned to LED (can be NULL) * @param last Previous LED to build a list * - * @return pointer to LED data structure or NULL if out of memory + * Return: pointer to LED data structure or NULL if out of memory */ struct cvmx_fdt_gpio_led *cvmx_alloc_led(const char *name, int of_offset, struct cvmx_fdt_gpio_info *gpio, @@ -418,7 +418,7 @@ struct cvmx_fdt_gpio_led *cvmx_alloc_led(const char *name, int of_offset, * @param gpio GPIO data structure to use (can be NULL) * @param last Previous LED if this is a group of LEDs * - * @return Pointer to LED data structure or NULL if error + * Return: Pointer to LED data structure or NULL if error */ struct cvmx_fdt_gpio_led *cvmx_fdt_parse_led(const void *fdt_addr, int led_of_offset, struct cvmx_fdt_gpio_info *gpio, diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-ilk.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-ilk.h index 29af48e7a1..500b5d5409 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-ilk.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-ilk.h @@ -48,7 +48,7 @@ void __cvmx_ilk_write_rx_cal_entry(int interface, int channel, unsigned char pip * * @param xiface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_ilk_probe(int xiface); @@ -60,7 +60,7 @@ int __cvmx_helper_ilk_probe(int xiface); * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_ilk_enable(int xiface); @@ -70,7 +70,7 @@ int __cvmx_helper_ilk_enable(int xiface); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_ilk_link_get(int ipd_port); @@ -85,7 +85,7 @@ cvmx_helper_link_info_t __cvmx_helper_ilk_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_ilk_link_set(int ipd_port, cvmx_helper_link_info_t link_info); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-jtag.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-jtag.h index fa379eaf55..d379d11c5f 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-jtag.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-jtag.h @@ -48,7 +48,7 @@ void cvmx_helper_qlm_jtag_init(void); * @param data Data to shift in. Bit 0 enters the chain first, followed by * bit 1, etc. * - * @return The low order bits of the JTAG chain that shifted out of the + * Return: The low order bits of the JTAG chain that shifted out of the * circle. */ u32 cvmx_helper_qlm_jtag_shift(int qlm, int bits, u32 data); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-loop.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-loop.h index defd95551a..4370738fe2 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-loop.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-loop.h @@ -17,7 +17,7 @@ * * @param xiface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_loop_probe(int xiface); int __cvmx_helper_loop_enumerate(int xiface); @@ -30,7 +30,7 @@ int __cvmx_helper_loop_enumerate(int xiface); * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_loop_enable(int xiface); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-npi.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-npi.h index 6a600a017c..fe257c912a 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-npi.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-npi.h @@ -17,7 +17,7 @@ * * @param interface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_npi_probe(int interface); @@ -29,7 +29,7 @@ int __cvmx_helper_npi_probe(int interface); * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_npi_enable(int xiface); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-pki.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-pki.h index f5933f24fa..ff32dab67b 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-pki.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-pki.h @@ -163,7 +163,7 @@ int cvmx_helper_pki_set_qpg_entry(int node, struct cvmx_pki_qpg_config *qpg_cfg) * @param bp_thresh backpressure threshold. * @param ena_drop enable tail drop. * 1:enable 0:disable - * @return Zero on success. Negative on failure + * Return: Zero on success. Negative on failure */ int cvmx_helper_setup_aura_qos(int node, int aura, bool ena_red, bool ena_drop, u64 pass_thresh, u64 drop_thresh, bool ena_bp, u64 bp_thresh); @@ -177,7 +177,7 @@ int cvmx_helper_setup_aura_qos(int node, int aura, bool ena_red, bool ena_drop, * @param bpid bpid to map. * @param chl_map array of channels to map to that bpid. * @param chl_cnt number of channel/ports to map to that bpid. - * @return Zero on success. Negative on failure + * Return: Zero on success. Negative on failure */ int cvmx_helper_pki_map_aura_chl_bpid(int node, u16 aura, u16 bpid, u16 chl_map[], u16 chl_cnt); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-pko3.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-pko3.h index ca8d848bd1..f985ce2c24 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-pko3.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-pko3.h @@ -12,7 +12,7 @@ * Covers the common hardware, memory and global configuration. * Per-interface initialization is performed separately. * - * @return 0 on success. + * Return: 0 on success. * */ int cvmx_helper_pko3_init_global(unsigned int node); @@ -29,7 +29,7 @@ int __cvmx_pko3_config_gen_interface(int xiface, u8 subif, u8 num_queues, bool p * Configure and initialize PKO3 for an interface * * @param interface is the interface number to configure - * @return 0 on success. + * Return: 0 on success. * */ int cvmx_helper_pko3_init_interface(int xiface); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-rgmii.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-rgmii.h index 2a206a8827..89301362a9 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-rgmii.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-rgmii.h @@ -15,7 +15,7 @@ * * @param xiface Interface to probe * - * @return Number of RGMII/GMII/MII ports (0-4). + * Return: Number of RGMII/GMII/MII ports (0-4). */ int __cvmx_helper_rgmii_probe(int xiface); @@ -35,7 +35,7 @@ void cvmx_helper_rgmii_internal_loopback(int port); * * @param xiface PKO Interface to configure (0 or 1) * - * @return Zero on success + * Return: Zero on success */ int __cvmx_helper_rgmii_enable(int xiface); @@ -48,7 +48,7 @@ int __cvmx_helper_rgmii_enable(int xiface); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_gmii_link_get(int ipd_port); @@ -61,7 +61,7 @@ cvmx_helper_link_info_t __cvmx_helper_gmii_link_get(int ipd_port); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_rgmii_link_get(int ipd_port); @@ -76,7 +76,7 @@ cvmx_helper_link_info_t __cvmx_helper_rgmii_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_rgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info); @@ -92,7 +92,7 @@ int __cvmx_helper_rgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info * @param enable_external * Non zero if you want external loopback * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int __cvmx_helper_rgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-sfp.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-sfp.h index 6fe55093b2..655bb106cc 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-sfp.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-sfp.h @@ -264,7 +264,7 @@ struct cvmx_sfp_mod_info { * @param i2c_bus i2c bus number to read from for SFP port * @param i2c_addr i2c address to use, 0 for default * - * @return -1 if invalid bus or i2c read error, 0 for success + * Return: -1 if invalid bus or i2c read error, 0 for success */ int cvmx_phy_sfp_read_i2c_eeprom(u8 *buffer, int i2c_bus, int i2c_addr); @@ -275,7 +275,7 @@ int cvmx_phy_sfp_read_i2c_eeprom(u8 *buffer, int i2c_bus, int i2c_addr); * @param[out] sfp_info Info about SFP module * @param[in] buffer SFP EEPROM buffer to parse * - * @return 0 on success, -1 if error reading EEPROM or if EEPROM corrupt + * Return: 0 on success, -1 if error reading EEPROM or if EEPROM corrupt */ int cvmx_phy_sfp_parse_eeprom(struct cvmx_sfp_mod_info *sfp_info, const u8 *buffer); @@ -291,7 +291,7 @@ void cvmx_phy_sfp_print_info(const struct cvmx_sfp_mod_info *sfp_info); * * @param sfp sfp handle to read * - * @return 0 for success, -1 on error. + * Return: 0 for success, -1 on error. */ int cvmx_sfp_read_i2c_eeprom(struct cvmx_fdt_sfp_info *sfp); @@ -300,7 +300,7 @@ int cvmx_sfp_read_i2c_eeprom(struct cvmx_fdt_sfp_info *sfp); * * @param sfp sfp handle * - * @return sfp_info Pointer sfp mod info data structure + * Return: sfp_info Pointer sfp mod info data structure */ const struct cvmx_sfp_mod_info *cvmx_phy_get_sfp_mod_info(const struct cvmx_fdt_sfp_info *sfp); @@ -311,7 +311,7 @@ const struct cvmx_sfp_mod_info *cvmx_phy_get_sfp_mod_info(const struct cvmx_fdt_ * @param sfp Handle to SFP information. * @param data User-defined data passed to the function * - * @return 0 if absent, 1 if present, -1 on error + * Return: 0 if absent, 1 if present, -1 on error */ int cvmx_sfp_check_mod_abs(struct cvmx_fdt_sfp_info *sfp, void *data); @@ -323,7 +323,7 @@ int cvmx_sfp_check_mod_abs(struct cvmx_fdt_sfp_info *sfp, void *data); * @param check_mod_abs Function to be called or NULL to remove * @param mod_abs_data User-defined data to be passed to check_mod_abs * - * @return 0 for success + * Return: 0 for success */ int cvmx_sfp_register_check_mod_abs(struct cvmx_fdt_sfp_info *sfp, int (*check_mod_abs)(struct cvmx_fdt_sfp_info *sfp, void *data), @@ -339,7 +339,7 @@ int cvmx_sfp_register_check_mod_abs(struct cvmx_fdt_sfp_info *sfp, * @param mod_abs_changed_data User-defined data passed to * mod_abs_changed * - * @return 0 for success + * Return: 0 for success */ int cvmx_sfp_register_mod_abs_changed(struct cvmx_fdt_sfp_info *sfp, int (*mod_abs_changed)(struct cvmx_fdt_sfp_info *sfp, int val, @@ -352,7 +352,7 @@ int cvmx_sfp_register_mod_abs_changed(struct cvmx_fdt_sfp_info *sfp, * @param sfp Handle to SFP information. * @param data User-defined data passed to the function * - * @return 0 if signal present, 1 if signal absent, -1 on error + * Return: 0 if signal present, 1 if signal absent, -1 on error */ int cvmx_sfp_check_tx_fault(struct cvmx_fdt_sfp_info *sfp, void *data); @@ -362,7 +362,7 @@ int cvmx_sfp_check_tx_fault(struct cvmx_fdt_sfp_info *sfp, void *data); * @param sfp Handle to SFP information. * @param data User-defined data passed to the function * - * @return 0 if signal present, 1 if signal absent, -1 on error + * Return: 0 if signal present, 1 if signal absent, -1 on error */ int cvmx_sfp_check_rx_los(struct cvmx_fdt_sfp_info *sfp, void *data); @@ -375,7 +375,7 @@ int cvmx_sfp_check_rx_los(struct cvmx_fdt_sfp_info *sfp, void *data); * @param rx_los_changed_data User-defined data passed to * rx_los_changed * - * @return 0 for success + * Return: 0 for success */ int cvmx_sfp_register_rx_los_changed(struct cvmx_fdt_sfp_info *sfp, int (*rx_los_changed)(struct cvmx_fdt_sfp_info *sfp, int val, @@ -387,7 +387,7 @@ int cvmx_sfp_register_rx_los_changed(struct cvmx_fdt_sfp_info *sfp, * * @param fdt_addr Address of flat device-tree * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int cvmx_sfp_parse_device_tree(const void *fdt_addr); @@ -396,7 +396,7 @@ int cvmx_sfp_parse_device_tree(const void *fdt_addr); * * @param ipd_port IPD port number to search for * - * @return pointer to SFP data structure or NULL if not found + * Return: pointer to SFP data structure or NULL if not found */ struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_port(int ipd_port); @@ -405,14 +405,14 @@ struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_port(int ipd_port); * * @param of_offset flat device tree node offset * - * @return pointer to SFP data structure or NULL if not found + * Return: pointer to SFP data structure or NULL if not found */ struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_fdt_node(int of_offset); /** * Reads the EEPROMs of all SFP modules. * - * @return 0 for success + * Return: 0 for success */ int cvmx_sfp_read_all_modules(void); @@ -422,7 +422,7 @@ int cvmx_sfp_read_all_modules(void); * @param[in] sfp SFP port to check * @param mode interface mode * - * @return true if module is valid, false if invalid + * Return: true if module is valid, false if invalid * NOTE: This will also toggle the error LED, if present */ bool cvmx_sfp_validate_module(struct cvmx_fdt_sfp_info *sfp, int mode); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-sgmii.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-sgmii.h index c5110c9513..0b32a732e3 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-sgmii.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-sgmii.h @@ -17,7 +17,7 @@ * * @param xiface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_sgmii_probe(int xiface); int __cvmx_helper_sgmii_enumerate(int xiface); @@ -30,7 +30,7 @@ int __cvmx_helper_sgmii_enumerate(int xiface); * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_sgmii_enable(int xiface); @@ -43,7 +43,7 @@ int __cvmx_helper_sgmii_enable(int xiface); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_sgmii_link_get(int ipd_port); @@ -58,7 +58,7 @@ cvmx_helper_link_info_t __cvmx_helper_sgmii_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_sgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info); @@ -74,7 +74,7 @@ int __cvmx_helper_sgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info * @param enable_external * Non zero if you want external loopback * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int __cvmx_helper_sgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-spi.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-spi.h index cae72f2172..1adc6f7066 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-spi.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-spi.h @@ -19,7 +19,7 @@ * * @param interface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_spi_probe(int interface); int __cvmx_helper_spi_enumerate(int interface); @@ -32,7 +32,7 @@ int __cvmx_helper_spi_enumerate(int interface); * * @param interface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_spi_enable(int interface); @@ -45,7 +45,7 @@ int __cvmx_helper_spi_enable(int interface); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port); @@ -60,7 +60,7 @@ cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-srio.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-srio.h index 2b7571dced..47db709b69 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-srio.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-srio.h @@ -16,7 +16,7 @@ * * @param xiface Interface to convert * - * @return Srio link number + * Return: Srio link number */ int __cvmx_helper_srio_port(int xiface); @@ -28,7 +28,7 @@ int __cvmx_helper_srio_port(int xiface); * * @param xiface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_srio_probe(int xiface); @@ -40,7 +40,7 @@ int __cvmx_helper_srio_probe(int xiface); * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_srio_enable(int xiface); @@ -50,7 +50,7 @@ int __cvmx_helper_srio_enable(int xiface); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_srio_link_get(int ipd_port); @@ -65,7 +65,7 @@ cvmx_helper_link_info_t __cvmx_helper_srio_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_srio_link_set(int ipd_port, cvmx_helper_link_info_t link_info); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-util.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-util.h index cf98eaeba4..ffdd8d03e0 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-util.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-util.h @@ -82,7 +82,7 @@ typedef struct cvmx_xiface cvmx_xiface_t; * * @param xiface interface with node information * - * @return struct that contains node and interface number. + * Return: struct that contains node and interface number. */ static inline struct cvmx_xiface cvmx_helper_xiface_to_node_interface(int xiface) { @@ -237,7 +237,7 @@ static inline void cvmx_wqe_pki_free(cvmx_wqe_t *work) * * @param mode Mode to convert * - * @return String + * Return: String */ const char *cvmx_helper_interface_mode_to_string(cvmx_helper_interface_mode_t mode); @@ -252,7 +252,7 @@ int cvmx_helper_dump_packet(cvmx_wqe_t *work); /** * Get the version of the CVMX libraries. * - * @return Version string. Note this buffer is allocated statically + * Return: Version string. Note this buffer is allocated statically * and will be shared by all callers. */ const char *cvmx_helper_get_version(void); @@ -266,7 +266,7 @@ const char *cvmx_helper_get_version(void); * @param xiface Interface to configure * @param num_ports Number of ports on the interface * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_setup_gmx(int xiface, int num_ports); @@ -276,7 +276,7 @@ int __cvmx_helper_setup_gmx(int xiface, int num_ports); * * @param interface * - * @return the number of pko_ports on the interface. + * Return: the number of pko_ports on the interface. */ int __cvmx_helper_get_num_pko_ports(int interface); @@ -287,7 +287,7 @@ int __cvmx_helper_get_num_pko_ports(int interface); * @param interface Interface to use * @param port Port on the interface * - * @return IPD port number + * Return: IPD port number */ int cvmx_helper_get_ipd_port(int interface, int port); @@ -298,7 +298,7 @@ int cvmx_helper_get_ipd_port(int interface, int port); * @param interface Interface to use * @param port Port on the interface * - * @return PKO port number and -1 on error. + * Return: PKO port number and -1 on error. */ int cvmx_helper_get_pko_port(int interface, int port); @@ -308,7 +308,7 @@ int cvmx_helper_get_pko_port(int interface, int port); * * @param interface Interface to use * - * @return IPD/PKO port number + * Return: IPD/PKO port number */ static inline int cvmx_helper_get_first_ipd_port(int interface) { @@ -323,7 +323,7 @@ int cvmx_helper_ports_on_interface(int interface); * * @param interface Interface to use * - * @return IPD/PKO port number + * Return: IPD/PKO port number * * Note: for o68, the last ipd port on an interface does not always equal to * the first plus the number of ports as the ipd ports are not contiguous in @@ -354,7 +354,7 @@ void cvmx_helper_free_packet_data(cvmx_wqe_t *work); * * @param ipd_port IPD/PKO port number * - * @return Interface number + * Return: Interface number */ int cvmx_helper_get_interface_num(int ipd_port); @@ -364,7 +364,7 @@ int cvmx_helper_get_interface_num(int ipd_port); * * @param ipd_port IPD/PKO port number * - * @return Interface index number + * Return: Interface index number */ int cvmx_helper_get_interface_index_num(int ipd_port); @@ -374,7 +374,7 @@ int cvmx_helper_get_interface_index_num(int ipd_port); * @param xiface Interface * @param index index of the port in the interface * - * @return port kind on sucicess and -1 on failure + * Return: port kind on sucicess and -1 on failure */ int cvmx_helper_get_pknd(int xiface, int index); @@ -384,7 +384,7 @@ int cvmx_helper_get_pknd(int xiface, int index); * @param interface Interface * @param port index of the port in the interface * - * @return port kind on sucicess and -1 on failure + * Return: port kind on sucicess and -1 on failure */ int cvmx_helper_get_bpid(int interface, int port); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-xaui.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-xaui.h index 6ff4576f23..2d9b0bea42 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper-xaui.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-xaui.h @@ -17,7 +17,7 @@ * * @param xiface Interface to probe * - * @return Number of ports on the interface. Zero to disable. + * Return: Number of ports on the interface. Zero to disable. */ int __cvmx_helper_xaui_probe(int xiface); int __cvmx_helper_xaui_enumerate(int xiface); @@ -30,7 +30,7 @@ int __cvmx_helper_xaui_enumerate(int xiface); * * @param xiface Interface to bring up * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_xaui_enable(int xiface); @@ -47,7 +47,7 @@ int __cvmx_helper_xaui_enable(int xiface); * * @param interface Interface to retrain * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_xaui_link_retrain(int interface); @@ -57,7 +57,7 @@ int cvmx_helper_xaui_link_retrain(int interface); * * @param interface Interface to reinitialize * - * @return 0 on success, negative on failure + * Return: 0 on success, negative on failure */ int cvmx_helper_xaui_link_reinit(int interface); @@ -70,7 +70,7 @@ int cvmx_helper_xaui_link_reinit(int interface); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t __cvmx_helper_xaui_link_get(int ipd_port); @@ -85,7 +85,7 @@ cvmx_helper_link_info_t __cvmx_helper_xaui_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_xaui_link_set(int ipd_port, cvmx_helper_link_info_t link_info); @@ -101,7 +101,7 @@ int __cvmx_helper_xaui_link_set(int ipd_port, cvmx_helper_link_info_t link_info) * @param enable_external * Non zero if you want external loopback * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int __cvmx_helper_xaui_configure_loopback(int ipd_port, int enable_internal, int enable_external); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper.h b/arch/mips/mach-octeon/include/mach/cvmx-helper.h index b82e201269..caa0c69fc0 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-helper.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-helper.h @@ -134,7 +134,7 @@ enum cvmx_pko_padding { * IPD configuration changes are made if CVMX_HELPER_ENABLE_IPD * is not set in the executive-config.h file. * - * @return 0 on success + * Return: 0 on success * -1 on failure */ int cvmx_helper_ipd_and_packet_input_enable_node(int node); @@ -146,7 +146,7 @@ int cvmx_helper_ipd_and_packet_input_enable(void); * @param wqe_entries The maximum number of work queue entries to be * supported. * - * @return Zero on success, non-zero on failure. + * Return: Zero on success, non-zero on failure. */ int cvmx_helper_initialize_sso(int wqe_entries); @@ -157,14 +157,14 @@ int cvmx_helper_initialize_sso(int wqe_entries); * @param wqe_entries The maximum number of work queue entries to be * supported. * - * @return Zero on success, non-zero on failure. + * Return: Zero on success, non-zero on failure. */ int cvmx_helper_initialize_sso_node(unsigned int node, int wqe_entries); /** * Undo the effect of cvmx_helper_initialize_sso(). * - * @return Zero on success, non-zero on failure. + * Return: Zero on success, non-zero on failure. */ int cvmx_helper_uninitialize_sso(void); @@ -173,7 +173,7 @@ int cvmx_helper_uninitialize_sso(void); * * @param node Node SSO to initialize * - * @return Zero on success, non-zero on failure. + * Return: Zero on success, non-zero on failure. */ int cvmx_helper_uninitialize_sso_node(unsigned int node); @@ -184,7 +184,7 @@ int cvmx_helper_uninitialize_sso_node(unsigned int node); * on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower * priority than the previous. * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_initialize_packet_io_global(void); /** @@ -196,14 +196,14 @@ int cvmx_helper_initialize_packet_io_global(void); * * @param node Node on which to initialize packet io hardware * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_initialize_packet_io_node(unsigned int node); /** * Does core local initialization for packet io * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_initialize_packet_io_local(void); @@ -216,7 +216,7 @@ int cvmx_helper_initialize_packet_io_local(void); * buffers used by the packet IO hardware to the FPA so a function emptying the * FPA after shutdown should find all packet buffers in the FPA. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_helper_shutdown_packet_io_global(void); @@ -228,7 +228,7 @@ int cvmx_helper_shutdown_packet_io_global_cn78xx(int node); /** * Does core local shutdown of packet io * - * @return Zero on success, non-zero on failure + * Return: Zero on success, non-zero on failure */ int cvmx_helper_shutdown_packet_io_local(void); @@ -239,7 +239,7 @@ int cvmx_helper_shutdown_packet_io_local(void); * * @param interface Which interface to return port count for. * - * @return Port count for interface + * Return: Port count for interface * -1 for uninitialized interface */ int cvmx_helper_ports_on_interface(int interface); @@ -250,7 +250,7 @@ int cvmx_helper_ports_on_interface(int interface); * but the CNX0XX and CNX1XX are exceptions. These only support * one interface. * - * @return Number of interfaces on chip + * Return: Number of interfaces on chip */ int cvmx_helper_get_number_of_interfaces(void); @@ -261,7 +261,7 @@ int cvmx_helper_get_number_of_interfaces(void); * * @param xiface Interface to probe * - * @return Mode of the interface. Unknown or unsupported interfaces return + * Return: Mode of the interface. Unknown or unsupported interfaces return * DISABLED. */ cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface); @@ -273,7 +273,7 @@ cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface); * * @param ipd_port IPD/PKO port to auto configure * - * @return Link state after configure + * Return: Link state after configure */ cvmx_helper_link_info_t cvmx_helper_link_autoconf(int ipd_port); @@ -285,7 +285,7 @@ cvmx_helper_link_info_t cvmx_helper_link_autoconf(int ipd_port); * * @param ipd_port IPD/PKO port to query * - * @return Link state + * Return: Link state */ cvmx_helper_link_info_t cvmx_helper_link_get(int ipd_port); @@ -299,7 +299,7 @@ cvmx_helper_link_info_t cvmx_helper_link_get(int ipd_port); * @param ipd_port IPD/PKO port to configure * @param link_info The new link state * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_link_set(int ipd_port, cvmx_helper_link_info_t link_info); @@ -312,7 +312,7 @@ int cvmx_helper_link_set(int ipd_port, cvmx_helper_link_info_t link_info); * * @param xiface Interface to probe * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_interface_probe(int xiface); @@ -322,7 +322,7 @@ int cvmx_helper_interface_probe(int xiface); * * @param xiface Interface to enumerate * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_helper_interface_enumerate(int xiface); @@ -337,7 +337,7 @@ int cvmx_helper_interface_enumerate(int xiface); * @param enable_external * Non zero if you want external loopback * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int cvmx_helper_configure_loopback(int ipd_port, int enable_internal, int enable_external); @@ -346,7 +346,7 @@ int cvmx_helper_configure_loopback(int ipd_port, int enable_internal, int enable * * @param interface Which interface to return port count for. * - * @return Port count for interface + * Return: Port count for interface * -1 for uninitialized interface */ int __cvmx_helper_early_ports_on_interface(int interface); @@ -404,7 +404,7 @@ static inline u8 cvmx_helper_prio2qos(u8 prio) * * @param xiface * - * @return the number of ipd_ports on the interface and -1 for error. + * Return: the number of ipd_ports on the interface and -1 for error. */ int __cvmx_helper_get_num_ipd_ports(int xiface); @@ -419,7 +419,7 @@ enum cvmx_pko_padding __cvmx_helper_get_pko_padding(int xiface); * @param pad The padding that PKO should apply. * interface. * - * @return 0 for success and -1 for failure + * Return: 0 for success and -1 for failure */ int __cvmx_helper_init_interface(int xiface, int num_ipd_ports, int has_fcs, enum cvmx_pko_padding pad); @@ -434,14 +434,14 @@ void __cvmx_helper_shutdown_interfaces(void); * hardware ports. PKO should still be disabled to make sure packets * aren't sent out partially setup hardware. * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int __cvmx_helper_packet_hardware_enable(int xiface); /* * @INTERNAL * - * @return 0 for success and -1 for failure + * Return: 0 for success and -1 for failure */ int __cvmx_helper_set_link_info(int xiface, int index, cvmx_helper_link_info_t link_info); @@ -451,7 +451,7 @@ int __cvmx_helper_set_link_info(int xiface, int index, cvmx_helper_link_info_t l * @param xiface * @param port * - * @return valid link_info on success or -1 on failure + * Return: valid link_info on success or -1 on failure */ cvmx_helper_link_info_t __cvmx_helper_get_link_info(int xiface, int port); @@ -460,7 +460,7 @@ cvmx_helper_link_info_t __cvmx_helper_get_link_info(int xiface, int port); * * @param xiface * - * @return 0 if PKO does not do FCS and 1 otherwise. + * Return: 0 if PKO does not do FCS and 1 otherwise. */ int __cvmx_helper_get_has_fcs(int xiface); @@ -513,7 +513,7 @@ typedef struct cvmx_qos_config { * Initialize QoS configuraiton with the SDK defaults. * * @param qos_cfg User QOS configuration parameters. - * @return Zero on success, negative number otherwise. + * Return: Zero on success, negative number otherwise. */ int cvmx_helper_qos_config_init(cvmx_qos_proto_t qos_proto, cvmx_qos_config_t *qos_cfg); @@ -523,7 +523,7 @@ int cvmx_helper_qos_config_init(cvmx_qos_proto_t qos_proto, cvmx_qos_config_t *q * * @param xipdport Global IPD port * @param qos_cfg User QOS configuration parameters. - * @return Zero on success, negative number otherwise. + * Return: Zero on success, negative number otherwise. */ int cvmx_helper_qos_port_config_update(int xipdport, cvmx_qos_config_t *qos_cfg); @@ -534,7 +534,7 @@ int cvmx_helper_qos_port_config_update(int xipdport, cvmx_qos_config_t *qos_cfg) * * @param xipdport Global IPD port * @param qos_cfg User QOS configuration parameters. - * @return Zero on success, negative number otherwise. + * Return: Zero on success, negative number otherwise. */ int cvmx_helper_qos_port_setup(int xipdport, cvmx_qos_config_t *qos_cfg); @@ -545,7 +545,7 @@ int cvmx_helper_qos_port_setup(int xipdport, cvmx_qos_config_t *qos_cfg); * * @param node OCTEON3 node number. * @param qos_cfg User QOS configuration parameters. - * @return Zero on success, negative number otherwise. + * Return: Zero on success, negative number otherwise. */ int cvmx_helper_qos_sso_setup(int node, cvmx_qos_config_t *qos_cfg); @@ -554,7 +554,7 @@ int cvmx_helper_qos_sso_setup(int node, cvmx_qos_config_t *qos_cfg); * @param chan Channel index. * @param namebuf Name buffer (output). * @param buflen Name maximum length. - * @return Length of name (in bytes) on success, negative number otherwise. + * Return: Length of name (in bytes) on success, negative number otherwise. */ int cvmx_helper_get_chan_e_name(int chan, char *namebuf, int buflen); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-hwfau.h b/arch/mips/mach-octeon/include/mach/cvmx-hwfau.h index 59772190aa..967d6ee5ca 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-hwfau.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-hwfau.h @@ -111,7 +111,7 @@ typedef union { * - Step by 2 for 16 bit access. * - Step by 4 for 32 bit access. * - Step by 8 for 64 bit access. - * @return Address to store for atomic update + * Return: Address to store for atomic update */ static inline u64 __cvmx_hwfau_store_address(u64 noadd, u64 reg) { @@ -135,7 +135,7 @@ static inline u64 __cvmx_hwfau_store_address(u64 noadd, u64 reg) * @param value Signed value to add. * Note: When performing 32 and 64 bit access, only the low * 22 bits are available. - * @return Address to read from for atomic update + * Return: Address to read from for atomic update */ static inline u64 __cvmx_hwfau_atomic_address(u64 tagwait, u64 reg, s64 value) { @@ -152,7 +152,7 @@ static inline u64 __cvmx_hwfau_atomic_address(u64 tagwait, u64 reg, s64 value) * - Step by 8 for 64 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return Value of the register before the update + * Return: Value of the register before the update */ static inline s64 cvmx_hwfau_fetch_and_add64(cvmx_fau_reg64_t reg, s64 value) { @@ -166,7 +166,7 @@ static inline s64 cvmx_hwfau_fetch_and_add64(cvmx_fau_reg64_t reg, s64 value) * - Step by 4 for 32 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return Value of the register before the update + * Return: Value of the register before the update */ static inline s32 cvmx_hwfau_fetch_and_add32(cvmx_fau_reg32_t reg, s32 value) { @@ -180,7 +180,7 @@ static inline s32 cvmx_hwfau_fetch_and_add32(cvmx_fau_reg32_t reg, s32 value) * @param reg FAU atomic register to access. 0 <= reg < 2048. * - Step by 2 for 16 bit access. * @param value Signed value to add. - * @return Value of the register before the update + * Return: Value of the register before the update */ static inline s16 cvmx_hwfau_fetch_and_add16(cvmx_fau_reg16_t reg, s16 value) { @@ -193,7 +193,7 @@ static inline s16 cvmx_hwfau_fetch_and_add16(cvmx_fau_reg16_t reg, s16 value) * * @param reg FAU atomic register to access. 0 <= reg < 2048. * @param value Signed value to add. - * @return Value of the register before the update + * Return: Value of the register before the update */ static inline int8_t cvmx_hwfau_fetch_and_add8(cvmx_fau_reg8_t reg, int8_t value) { @@ -209,7 +209,7 @@ static inline int8_t cvmx_hwfau_fetch_and_add8(cvmx_fau_reg8_t reg, int8_t value * - Step by 8 for 64 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return If a timeout occurs, the error bit will be set. Otherwise + * Return: If a timeout occurs, the error bit will be set. Otherwise * the value of the register before the update will be * returned */ @@ -232,7 +232,7 @@ static inline cvmx_fau_tagwait64_t cvmx_hwfau_tagwait_fetch_and_add64(cvmx_fau_r * - Step by 4 for 32 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return If a timeout occurs, the error bit will be set. Otherwise + * Return: If a timeout occurs, the error bit will be set. Otherwise * the value of the register before the update will be * returned */ @@ -255,7 +255,7 @@ static inline cvmx_fau_tagwait32_t cvmx_hwfau_tagwait_fetch_and_add32(cvmx_fau_r * @param reg FAU atomic register to access. 0 <= reg < 2048. * - Step by 2 for 16 bit access. * @param value Signed value to add. - * @return If a timeout occurs, the error bit will be set. Otherwise + * Return: If a timeout occurs, the error bit will be set. Otherwise * the value of the register before the update will be * returned */ @@ -277,7 +277,7 @@ static inline cvmx_fau_tagwait16_t cvmx_hwfau_tagwait_fetch_and_add16(cvmx_fau_r * * @param reg FAU atomic register to access. 0 <= reg < 2048. * @param value Signed value to add. - * @return If a timeout occurs, the error bit will be set. Otherwise + * Return: If a timeout occurs, the error bit will be set. Otherwise * the value of the register before the update will be * returned */ @@ -314,7 +314,7 @@ static inline cvmx_fau_tagwait8_t cvmx_hwfau_tagwait_fetch_and_add8(cvmx_fau_reg * - Step by 2 for 16 bit access. * - Step by 4 for 32 bit access. * - Step by 8 for 64 bit access. - * @return Data to write using cvmx_send_single + * Return: Data to write using cvmx_send_single */ static inline u64 __cvmx_fau_iobdma_data(u64 scraddr, s64 value, u64 tagwait, cvmx_fau_op_size_t size, u64 reg) @@ -337,7 +337,7 @@ static inline u64 __cvmx_fau_iobdma_data(u64 scraddr, s64 value, u64 tagwait, * - Step by 8 for 64 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_t reg, s64 value) { @@ -354,7 +354,7 @@ static inline void cvmx_hwfau_async_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_ * - Step by 4 for 32 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_t reg, s32 value) { @@ -370,7 +370,7 @@ static inline void cvmx_hwfau_async_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_ * @param reg FAU atomic register to access. 0 <= reg < 2048. * - Step by 2 for 16 bit access. * @param value Signed value to add. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_t reg, s16 value) { @@ -385,7 +385,7 @@ static inline void cvmx_hwfau_async_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_ * Must be 8 byte aligned. * @param reg FAU atomic register to access. 0 <= reg < 2048. * @param value Signed value to add. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t reg, int8_t value) { @@ -405,7 +405,7 @@ static inline void cvmx_hwfau_async_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t * - Step by 8 for 64 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_tagwait_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_t reg, s64 value) @@ -426,7 +426,7 @@ static inline void cvmx_hwfau_async_tagwait_fetch_and_add64(u64 scraddr, cvmx_fa * - Step by 4 for 32 bit access. * @param value Signed value to add. * Note: Only the low 22 bits are available. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_tagwait_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_t reg, s32 value) @@ -446,7 +446,7 @@ static inline void cvmx_hwfau_async_tagwait_fetch_and_add32(u64 scraddr, cvmx_fa * @param reg FAU atomic register to access. 0 <= reg < 2048. * - Step by 2 for 16 bit access. * @param value Signed value to add. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_tagwait_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_t reg, s16 value) @@ -465,7 +465,7 @@ static inline void cvmx_hwfau_async_tagwait_fetch_and_add16(u64 scraddr, cvmx_fa * returned * @param reg FAU atomic register to access. 0 <= reg < 2048. * @param value Signed value to add. - * @return Placed in the scratch pad register + * Return: Placed in the scratch pad register */ static inline void cvmx_hwfau_async_tagwait_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t reg, int8_t value) @@ -574,28 +574,28 @@ static inline void cvmx_hwfau_atomic_write8(cvmx_fau_reg8_t reg, int8_t value) } /** Allocates 64bit FAU register. - * @return value is the base address of allocated FAU register + * Return: value is the base address of allocated FAU register */ int cvmx_fau64_alloc(int reserve); /** Allocates 32bit FAU register. - * @return value is the base address of allocated FAU register + * Return: value is the base address of allocated FAU register */ int cvmx_fau32_alloc(int reserve); /** Allocates 16bit FAU register. - * @return value is the base address of allocated FAU register + * Return: value is the base address of allocated FAU register */ int cvmx_fau16_alloc(int reserve); /** Allocates 8bit FAU register. - * @return value is the base address of allocated FAU register + * Return: value is the base address of allocated FAU register */ int cvmx_fau8_alloc(int reserve); /** Frees the specified FAU register. * @param address Base address of register to release. - * @return 0 on success; -1 on failure + * Return: 0 on success; -1 on failure */ int cvmx_fau_free(int address); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-hwpko.h b/arch/mips/mach-octeon/include/mach/cvmx-hwpko.h index 459c19bbc0..fe0296653a 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-hwpko.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-hwpko.h @@ -270,7 +270,7 @@ static inline void cvmx_pko_send_packet_prepare(u64 port __attribute__((unused)) * @param use_locking * CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE * - * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output + * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output */ static inline cvmx_pko_return_value_t cvmx_hwpko_send_packet_finish(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t pko_command, @@ -313,7 +313,7 @@ cvmx_hwpko_send_packet_finish(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t * @param use_locking * CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE * - * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output + * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output */ static inline cvmx_pko_return_value_t cvmx_hwpko_send_packet_finish3(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t pko_command, @@ -358,7 +358,7 @@ int cvmx_pko_get_num_pko_ports(int interface, int index); * for the port. * * @param port IPD port number - * @return Base output queue + * Return: Base output queue */ int cvmx_pko_get_base_queue(int port); @@ -366,7 +366,7 @@ int cvmx_pko_get_base_queue(int port); * For a given port number, return the number of pko output queues. * * @param port IPD port number - * @return Number of output queues + * Return: Number of output queues */ int cvmx_pko_get_num_queues(int port); @@ -407,7 +407,7 @@ void cvmx_pko_get_port_status(u64 ipd_port, u64 clear, cvmx_pko_port_status_t *s * @param burst Maximum number of packets to burst in a row before rate * limiting cuts in. * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_pko_rate_limit_packets(int port, int packets_s, int burst); @@ -420,7 +420,7 @@ int cvmx_pko_rate_limit_packets(int port, int packets_s, int burst); * @param burst Maximum number of bits to burst before rate * limiting cuts in. * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_pko_rate_limit_bits(int port, u64 bits_s, int burst); @@ -432,7 +432,7 @@ int cvmx_pko_rate_limit_bits(int port, u64 bits_s, int burst); * @param interface * @param index * - * @return negative on error. + * Return: negative on error. * * This applies only to the non-loopback interfaces. * @@ -444,7 +444,7 @@ int __cvmx_pko_get_pipe(int interface, int index); * for the port. * * @param pko_port PKO port number - * @return Base output queue + * Return: Base output queue */ int cvmx_pko_get_base_queue_pkoid(int pko_port); @@ -453,7 +453,7 @@ int cvmx_pko_get_base_queue_pkoid(int pko_port); * for the port. * * @param pko_port PKO port number - * @return the number of output queues + * Return: the number of output queues */ int cvmx_pko_get_num_queues_pkoid(int pko_port); @@ -495,7 +495,7 @@ static inline void cvmx_pko_doorbell_pkoid(u64 pko_port, u64 queue, u64 len) * @param use_locking * CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE * - * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output + * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output */ static inline cvmx_pko_return_value_t cvmx_hwpko_send_packet_finish_pkoid(int pko_port, u64 queue, cvmx_pko_command_word0_t pko_command, @@ -533,7 +533,7 @@ cvmx_hwpko_send_packet_finish_pkoid(int pko_port, u64 queue, cvmx_pko_command_wo * @param use_locking * CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE * - * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output + * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output */ static inline cvmx_pko_return_value_t cvmx_hwpko_send_packet_finish3_pkoid(u64 pko_port, u64 queue, cvmx_pko_command_word0_t pko_command, @@ -561,7 +561,7 @@ cvmx_hwpko_send_packet_finish3_pkoid(u64 pko_port, u64 queue, cvmx_pko_command_w * Obtain the number of PKO commands pending in a queue * * @param queue is the queue identifier to be queried - * @return the number of commands pending transmission or -1 on error + * Return: the number of commands pending transmission or -1 on error */ int cvmx_pko_queue_pend_count(cvmx_cmd_queue_id_t queue); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-ipd.h b/arch/mips/mach-octeon/include/mach/cvmx-ipd.h index cdff36fffb..f4a008f41a 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-ipd.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-ipd.h @@ -213,7 +213,7 @@ void cvmx_ipd_set_wqe_pool_buffer_count(u64 buffer_count); * @param drop_thresh * All incoming packets will be dropped when there are less * than this many free packet buffers in FPA 0. - * @return Zero on success. Negative on failure + * Return: Zero on success. Negative on failure */ int cvmx_ipd_setup_red_queue(int queue, int pass_thresh, int drop_thresh); @@ -226,7 +226,7 @@ int cvmx_ipd_setup_red_queue(int queue, int pass_thresh, int drop_thresh); * @param drop_thresh * All incoming packets will be dropped when there are less * than this many free packet buffers in FPA 0. - * @return Zero on success. Negative on failure + * Return: Zero on success. Negative on failure */ int cvmx_ipd_setup_red(int pass_thresh, int drop_thresh); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-pcie.h b/arch/mips/mach-octeon/include/mach/cvmx-pcie.h index a819196c02..95ac7f2c93 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-pcie.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-pcie.h @@ -74,7 +74,7 @@ typedef union { * * @param pcie_port PCIe port the IO is for * - * @return 64bit Octeon IO base address for read/write + * Return: 64bit Octeon IO base address for read/write */ u64 cvmx_pcie_get_io_base_address(int pcie_port); @@ -84,7 +84,7 @@ u64 cvmx_pcie_get_io_base_address(int pcie_port); * * @param pcie_port PCIe port the IO is for * - * @return Size of the IO window + * Return: Size of the IO window */ u64 cvmx_pcie_get_io_size(int pcie_port); @@ -94,7 +94,7 @@ u64 cvmx_pcie_get_io_size(int pcie_port); * * @param pcie_port PCIe port the IO is for * - * @return 64bit Octeon IO base address for read/write + * Return: 64bit Octeon IO base address for read/write */ u64 cvmx_pcie_get_mem_base_address(int pcie_port); @@ -104,7 +104,7 @@ u64 cvmx_pcie_get_mem_base_address(int pcie_port); * * @param pcie_port PCIe port the IO is for * - * @return Size of the Mem window + * Return: Size of the Mem window */ u64 cvmx_pcie_get_mem_size(int pcie_port); @@ -113,7 +113,7 @@ u64 cvmx_pcie_get_mem_size(int pcie_port); * * @param pcie_port PCIe port to initialize * - * @return Zero on success + * Return: Zero on success */ int cvmx_pcie_rc_initialize(int pcie_port); @@ -122,7 +122,7 @@ int cvmx_pcie_rc_initialize(int pcie_port); * * @param pcie_port PCIe port to shutdown * - * @return Zero on success + * Return: Zero on success */ int cvmx_pcie_rc_shutdown(int pcie_port); @@ -135,7 +135,7 @@ int cvmx_pcie_rc_shutdown(int pcie_port); * @param fn Device sub function * @param reg Register to access * - * @return Result of the read + * Return: Result of the read */ u8 cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg); @@ -148,7 +148,7 @@ u8 cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg); * @param fn Device sub function * @param reg Register to access * - * @return Result of the read + * Return: Result of the read */ u16 cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg); @@ -161,7 +161,7 @@ u16 cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg); * @param fn Device sub function * @param reg Register to access * - * @return Result of the read + * Return: Result of the read */ u32 cvmx_pcie_config_read32(int pcie_port, int bus, int dev, int fn, int reg); @@ -208,7 +208,7 @@ void cvmx_pcie_config_write32(int pcie_port, int bus, int dev, int fn, int reg, * @param pcie_port PCIe port to read from * @param cfg_offset Address to read * - * @return Value read + * Return: Value read */ u32 cvmx_pcie_cfgx_read(int pcie_port, u32 cfg_offset); u32 cvmx_pcie_cfgx_read_node(int node, int pcie_port, u32 cfg_offset); @@ -240,7 +240,7 @@ static inline void cvmx_pcie_npei_write32(u64 address, u32 val) * Read a 32bit value from the Octeon NPEI register space * * @param address Address to read - * @return The result + * Return: The result */ static inline u32 cvmx_pcie_npei_read32(u64 address) { @@ -252,7 +252,7 @@ static inline u32 cvmx_pcie_npei_read32(u64 address) * * @param pcie_port PCIe port to initialize * - * @return Zero on success + * Return: Zero on success */ int cvmx_pcie_ep_initialize(int pcie_port); @@ -272,7 +272,7 @@ void cvmx_pcie_wait_for_pending(int pcie_port); * * @param pcie_port PCIe port number (PEM number) * - * @return 0 if PCIe port is in target mode, !0 if in host mode. + * Return: 0 if PCIe port is in target mode, !0 if in host mode. */ int cvmx_pcie_is_host_mode(int pcie_port); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-pip.h b/arch/mips/mach-octeon/include/mach/cvmx-pip.h index 013f533fb7..828604aa7b 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-pip.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-pip.h @@ -946,7 +946,7 @@ static inline void cvmx_pip_bsel_config(int bit, int offset, int skip) /** * Get the entry for the Bit Select Extractor Table. * @param work pointer to work queue entry - * @return Index of the Bit Select Extractor Table + * Return: Index of the Bit Select Extractor Table */ static inline int cvmx_pip_get_bsel_table_index(cvmx_wqe_t *work) { diff --git a/arch/mips/mach-octeon/include/mach/cvmx-pki-resources.h b/arch/mips/mach-octeon/include/mach/cvmx-pki-resources.h index 79b99b0bd7..3c60166b99 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-pki-resources.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-pki-resources.h @@ -14,7 +14,7 @@ * @param style style to allocate, if -1 it will be allocated first available style from style resource. If index is positive number and in range, it will try to allocate specified style. - * @return style number on success, -1 on failure. + * Return: style number on success, -1 on failure. */ int cvmx_pki_style_alloc(int node, int style); @@ -24,7 +24,7 @@ int cvmx_pki_style_alloc(int node, int style); * @param node node to allocate cluster group from. @param cl_grp cluster group to allocate/reserve, if -1 , allocate any available cluster group. - * @return cluster group number or -1 on failure + * Return: cluster group number or -1 on failure */ int cvmx_pki_cluster_grp_alloc(int node, int cl_grp); @@ -45,7 +45,7 @@ int cvmx_pki_cluster_alloc(int node, int num_clusters, u64 *cluster_mask); allocate any available pcam entry. * @param bank pcam bank where to allocate/reserve pcan entry from * @param cluster_mask mask of clusters from which pcam entry is needed. - * @return pcam entry of -1 on failure + * Return: pcam entry of -1 on failure */ int cvmx_pki_pcam_entry_alloc(int node, int index, int bank, u64 cluster_mask); @@ -57,7 +57,7 @@ int cvmx_pki_pcam_entry_alloc(int node, int index, int bank, u64 cluster_mask); number and in range, it will try to allocate specified base_offset. @param count number of consecutive qpg entries to allocate. They will be consecutive from base offset. - * @return qpg table base offset number on success, -1 on failure. + * Return: qpg table base offset number on success, -1 on failure. */ int cvmx_pki_qpg_entry_alloc(int node, int base_offset, int count); @@ -65,7 +65,7 @@ int cvmx_pki_qpg_entry_alloc(int node, int base_offset, int count); * This function frees a style from pool of global styles per node. * @param node node to free style from. * @param style style to free - * @return 0 on success, -1 on failure. + * Return: 0 on success, -1 on failure. */ int cvmx_pki_style_free(int node, int style); @@ -74,7 +74,7 @@ int cvmx_pki_style_free(int node, int style); cluster group resources. * @param node node to free cluster group from. @param cl_grp cluster group to free - * @return 0 on success or -1 on failure + * Return: 0 on success or -1 on failure */ int cvmx_pki_cluster_grp_free(int node, int cl_grp); @@ -86,7 +86,7 @@ int cvmx_pki_cluster_grp_free(int node, int cl_grp); * number and in range, it will try to allocate specified base_offset. * @param count number of consecutive qpg entries to allocate. They will be consecutive * from base offset. - * @return qpg table base offset number on success, -1 on failure. + * Return: qpg table base offset number on success, -1 on failure. */ int cvmx_pki_qpg_entry_free(int node, int base_offset, int count); @@ -95,7 +95,7 @@ int cvmx_pki_qpg_entry_free(int node, int base_offset, int count); clusters resources. * @param node node to free clusters from. * @param cluster_mask mask of clusters need freeing - * @return 0 on success or -1 on failure + * Return: 0 on success or -1 on failure */ int cvmx_pki_cluster_free(int node, u64 cluster_mask); @@ -105,7 +105,7 @@ int cvmx_pki_cluster_free(int node, u64 cluster_mask); @param index index of pacm entry (0-191) needs to be freed. * @param bank pcam bank where to free pcam entry from * @param cluster_mask mask of clusters from which pcam entry is freed. - * @return 0 on success OR -1 on failure + * Return: 0 on success OR -1 on failure */ int cvmx_pki_pcam_entry_free(int node, int index, int bank, u64 cluster_mask); @@ -115,7 +115,7 @@ int cvmx_pki_pcam_entry_free(int node, int index, int bank, u64 cluster_mask); * @param bpid bpid to allocate, if -1 it will be allocated * first available boid from bpid resource. If index is positive * number and in range, it will try to allocate specified bpid. - * @return bpid number on success, + * Return: bpid number on success, * -1 on alloc failure. * -2 on resource already reserved. */ @@ -125,7 +125,7 @@ int cvmx_pki_bpid_alloc(int node, int bpid); * This function frees a bpid from pool of global bpid per node. * @param node node to free bpid from. * @param bpid bpid to free - * @return 0 on success, -1 on failure or + * Return: 0 on success, -1 on failure or */ int cvmx_pki_bpid_free(int node, int bpid); @@ -138,7 +138,7 @@ int cvmx_pki_bpid_free(int node, int bpid); * This function allocates/reserves an index from pool of global MTAG-IDX per node. * @param node node to allocate index from. * @param idx index to allocate, if -1 it will be allocated - * @return MTAG index number on success, + * Return: MTAG index number on success, * -1 on alloc failure. * -2 on resource already reserved. */ @@ -148,7 +148,7 @@ int cvmx_pki_mtag_idx_alloc(int node, int idx); * This function frees an index from pool of global MTAG-IDX per node. * @param node node to free bpid from. * @param bpid bpid to free - * @return 0 on success, -1 on failure or + * Return: 0 on success, -1 on failure or */ int cvmx_pki_mtag_idx_free(int node, int idx); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-pko-internal-ports-range.h b/arch/mips/mach-octeon/include/mach/cvmx-pko-internal-ports-range.h index 1fb49b3fb6..77dd33c1d8 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-pko-internal-ports-range.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-pko-internal-ports-range.h @@ -14,7 +14,7 @@ * are requested. * @param count the number of internal ports requested * - * @return 0 on success + * Return: 0 on success * -1 on failure */ int cvmx_pko_internal_ports_alloc(int interface, int port, u64 count); @@ -26,7 +26,7 @@ int cvmx_pko_internal_ports_alloc(int interface, int port, u64 count); * @param port the index of the port within in the interface for which the internal ports * are requested. * - * @return 0 on success + * Return: 0 on success * -1 on failure */ int cvmx_pko_internal_ports_free(int interface, int port); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-pko3-queue.h b/arch/mips/mach-octeon/include/mach/cvmx-pko3-queue.h index 5f83989049..b3f61d75f2 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-pko3-queue.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-pko3-queue.h @@ -113,7 +113,7 @@ int __cvmx_pko3_ipd_dq_unregister(int xiface, int index); * The channel assignment applies to L2 or L3 Shaper Queues depending * on the setting of channel credit level. * - * @return returns none. + * Return: returns none. */ void cvmx_pko3_map_channel(unsigned int node, unsigned int pq_num, unsigned int l2_l3_q_num, u16 channel); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-pow.h b/arch/mips/mach-octeon/include/mach/cvmx-pow.h index 0680ca258f..ed9b45fd7a 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-pow.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-pow.h @@ -906,7 +906,7 @@ static inline unsigned int cvmx_sso_num_maskset(void) * If a tag switch is pending this routine returns the tag before * the tag switch, not after. * - * @return Current tag + * Return: Current tag */ static inline cvmx_pow_tag_info_t cvmx_pow_get_current_tag(void) { @@ -967,7 +967,7 @@ static inline cvmx_pow_tag_info_t cvmx_pow_get_current_tag(void) * Get the POW WQE for this core. This returns the work queue * entry currently associated with this core. * - * @return WQE pointer + * Return: WQE pointer */ static inline cvmx_wqe_t *cvmx_pow_get_current_wqp(void) { @@ -1059,7 +1059,7 @@ static inline void cvmx_pow_tag_sw_wait(void) * @param wait When set, call stalls until work becomes available, or * times out. If not set, returns immediately. * - * @return Returns the WQE pointer from POW. Returns NULL if no work was + * Return: Returns the WQE pointer from POW. Returns NULL if no work was * available. */ static inline cvmx_wqe_t *cvmx_pow_work_request_sync_nocheck(cvmx_pow_wait_t wait) @@ -1099,7 +1099,7 @@ static inline cvmx_wqe_t *cvmx_pow_work_request_sync_nocheck(cvmx_pow_wait_t wai * @param wait When set, call stalls until work becomes available, or * times out. If not set, returns immediately. * - * @return Returns the WQE pointer from POW. Returns NULL if no work was + * Return: Returns the WQE pointer from POW. Returns NULL if no work was * available. */ static inline cvmx_wqe_t *cvmx_pow_work_request_sync(cvmx_pow_wait_t wait) @@ -1114,7 +1114,7 @@ static inline cvmx_wqe_t *cvmx_pow_work_request_sync(cvmx_pow_wait_t wait) * This function waits for any previous tag switch to complete before * requesting the null_rd. * - * @return Returns the POW state of type cvmx_pow_tag_type_t. + * Return: Returns the POW state of type cvmx_pow_tag_type_t. */ static inline cvmx_pow_tag_type_t cvmx_pow_work_request_null_rd(void) { @@ -1204,7 +1204,7 @@ static inline void cvmx_pow_work_request_async(int scr_addr, cvmx_pow_wait_t wai * * @param scr_addr Scratch memory address to get result from * Byte address, must be 8 byte aligned. - * @return Returns the WQE from the scratch register, or NULL if no work was + * Return: Returns the WQE from the scratch register, or NULL if no work was * available. */ static inline cvmx_wqe_t *cvmx_pow_work_response_async(int scr_addr) @@ -1226,7 +1226,7 @@ static inline cvmx_wqe_t *cvmx_pow_work_response_async(int scr_addr) * * @param wqe_ptr pointer to a work queue entry returned by the POW * - * @return 0 if pointer is valid + * Return: 0 if pointer is valid * 1 if invalid (no work was returned) */ static inline u64 cvmx_pow_work_invalid(cvmx_wqe_t *wqe_ptr) @@ -1735,7 +1735,7 @@ static inline void cvmx_pow_set_group_mask(u64 core_num, u64 mask) * indicates which groups each core will accept work from. * * @param core_num core to apply mask to - * @return Group mask, one bit for up to 64 groups. + * Return: Group mask, one bit for up to 64 groups. * Each 1 bit in the mask enables the core to accept work from * the corresponding group. * The CN68XX supports 64 groups, earlier models only support @@ -2364,7 +2364,7 @@ static inline void cvmx_sso_work_request_grp_async_nocheck(int scr_addr, cvmx_xg * @param wait When set, call stalls until work becomes available, or times out. * If not set, returns immediately. * - * @return Returns the WQE pointer from SSO. + * Return: Returns the WQE pointer from SSO. * Returns NULL if no work was available. */ static inline void *cvmx_sso_work_request_grp_sync_nocheck(unsigned int lgrp, cvmx_pow_wait_t wait) @@ -2403,7 +2403,7 @@ static inline void *cvmx_sso_work_request_grp_sync_nocheck(unsigned int lgrp, cv * @param wait When set, call stalls until work becomes available, or times out. * If not set, returns immediately. * - * @return The WQE pointer or NULL, if work is not available. + * Return: The WQE pointer or NULL, if work is not available. */ static inline void *cvmx_sso_work_request_grp_sync(unsigned int lgrp, cvmx_pow_wait_t wait) { @@ -2829,7 +2829,7 @@ static inline void cvmx_sso_update_wqp_group(cvmx_wqe_t *wqp, u8 xgrp) * @param hw_bits The lower bits (number depends on configuration) are set * to this value. The remainder of bits are set by the sw_bits parameter. * - * @return 32 bit value of the combined hw and sw bits. + * Return: 32 bit value of the combined hw and sw bits. */ static inline u32 cvmx_pow_tag_compose(u64 sw_bits, u64 hw_bits) { @@ -2842,7 +2842,7 @@ static inline u32 cvmx_pow_tag_compose(u64 sw_bits, u64 hw_bits) * * @param tag 32 bit tag value * - * @return N bit software tag value, where N is configurable with + * Return: N bit software tag value, where N is configurable with * the CVMX_TAG_SW_BITS define */ static inline u32 cvmx_pow_tag_get_sw_bits(u64 tag) @@ -2856,7 +2856,7 @@ static inline u32 cvmx_pow_tag_get_sw_bits(u64 tag) * * @param tag 32 bit tag value * - * @return (32 - N) bit software tag value, where N is configurable with + * Return: (32 - N) bit software tag value, where N is configurable with * the CVMX_TAG_SW_BITS define */ static inline u32 cvmx_pow_tag_get_hw_bits(u64 tag) @@ -2905,7 +2905,7 @@ static inline u64 cvmx_sso_get_total_wqe_count(void) * @param buffer Buffer to store capture into * @param buffer_size The size of the supplied buffer * - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int cvmx_pow_capture(void *buffer, int buffer_size); @@ -2920,7 +2920,7 @@ void cvmx_pow_display(void *buffer, int buffer_size); /** * Return the number of POW entries supported by this chip * - * @return Number of POW entries + * Return: Number of POW entries */ int cvmx_pow_get_num_entries(void); int cvmx_pow_get_dump_size(void); @@ -2932,7 +2932,7 @@ int cvmx_pow_get_dump_size(void); * @param node The numa node for the allocation. * @param base_group Pointer to the initial group, -1 to allocate anywhere. * @param count The number of consecutive groups to allocate. - * @return 0 on success and -1 on failure. + * Return: 0 on success and -1 on failure. */ int cvmx_sso_reserve_group_range(int node, int *base_group, int count); #define cvmx_sso_allocate_group_range cvmx_sso_reserve_group_range diff --git a/arch/mips/mach-octeon/include/mach/cvmx-qlm.h b/arch/mips/mach-octeon/include/mach/cvmx-qlm.h index 19915eb82c..7695b69b98 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-qlm.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-qlm.h @@ -32,7 +32,7 @@ typedef struct { /** * Return the number of QLMs supported by the chip * - * @return Number of QLMs + * Return: Number of QLMs */ int cvmx_qlm_get_num(void); @@ -49,7 +49,7 @@ int cvmx_qlm_interface(int xiface); * @param xiface interface to look up * @param index index in an interface * - * @return the qlm number based on the xiface + * Return: the qlm number based on the xiface */ int cvmx_qlm_lmac(int xiface, int index); @@ -58,7 +58,7 @@ int cvmx_qlm_lmac(int xiface, int index); * * @param BGX BGX to search for. * - * @return muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6. + * Return: muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6. */ int cvmx_qlm_mux_interface(int bgx); @@ -67,14 +67,14 @@ int cvmx_qlm_mux_interface(int bgx); * * @param qlm QLM block to query * - * @return Number of lanes + * Return: Number of lanes */ int cvmx_qlm_get_lanes(int qlm); /** * Get the QLM JTAG fields based on Octeon model on the supported chips. * - * @return qlm_jtag_field_t structure + * Return: qlm_jtag_field_t structure */ const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void); @@ -82,7 +82,7 @@ const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void); * Get the QLM JTAG length by going through qlm_jtag_field for each * Octeon model that is supported * - * @return return the length. + * Return: return the length. */ int cvmx_qlm_jtag_get_length(void); @@ -98,7 +98,7 @@ void cvmx_qlm_init(void); * @param lane Lane in QLM to get * @param name String name of field * - * @return JTAG field value + * Return: JTAG field value */ u64 cvmx_qlm_jtag_get(int qlm, int lane, const char *name); @@ -133,7 +133,7 @@ void __cvmx_qlm_pcie_cfg_rxd_set_tweak(int qlm, int lane); * * @param qlm QLM to examine * - * @return Speed in Mhz + * Return: Speed in Mhz */ int cvmx_qlm_get_gbaud_mhz(int qlm); /** @@ -142,7 +142,7 @@ int cvmx_qlm_get_gbaud_mhz(int qlm); * @param node Target QLM node * @param qlm QLM to examine * - * @return Speed in Mhz + * Return: Speed in Mhz */ int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm); @@ -250,7 +250,7 @@ int cvmx_qlm_measure_clock(int qlm); * @param node node to measure * @param qlm QLM to measure * - * @return Clock rate in Hz + * Return: Clock rate in Hz */ int cvmx_qlm_measure_clock_node(int node, int qlm); @@ -261,7 +261,7 @@ int cvmx_qlm_measure_clock_node(int node, int qlm); * @param qlm QLM to perform RX equalization on * @param lane Lane to use, or -1 for all lanes * - * @return Zero on success, negative if any lane failed RX equalization + * Return: Zero on success, negative if any lane failed RX equalization */ int __cvmx_qlm_rx_equalization(int node, int qlm, int lane); diff --git a/arch/mips/mach-octeon/include/mach/cvmx-regs.h b/arch/mips/mach-octeon/include/mach/cvmx-regs.h index 9e86be8f63..dbb77232e2 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-regs.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-regs.h @@ -295,7 +295,7 @@ static inline void cvmx_write_io(u64 io_addr, u64 val) * * @param major_did 5 bit major did * @param sub_did 3 bit sub did - * @return I/O base address + * Return: I/O base address */ static inline u64 cvmx_build_io_address(u64 major_did, u64 sub_did) { @@ -306,7 +306,7 @@ static inline u64 cvmx_build_io_address(u64 major_did, u64 sub_did) * Builds a bit mask given the required size in bits. * * @param bits Number of bits in the mask - * @return The mask + * Return: The mask */ static inline u64 cvmx_build_mask(u64 bits) { @@ -323,7 +323,7 @@ static inline u64 cvmx_build_mask(u64 bits) * @param lsb Starting bit, least significant (0-63) * @param width Width in bits (1-64) * - * @return Extracted number + * Return: Extracted number */ static inline u64 cvmx_bit_extract(u64 input, int lsb, int width) { @@ -349,7 +349,7 @@ static inline u64 cvmx_bit_extract(u64 input, int lsb, int width) * @param high_bit Highest bit value can occupy (inclusive) 0-63 * @param low_bit Lowest bit value can occupy inclusive 0-high_bit * @param value Value to use - * @return Value masked and shifted + * Return: Value masked and shifted */ static inline u64 cvmx_build_bits(u64 high_bit, u64 low_bit, u64 value) { @@ -379,7 +379,7 @@ static inline u64 cvmx_ptr_to_phys(void *ptr) /** * Number of the Core on which the program is currently running. * - * @return core number + * Return: core number */ static inline unsigned int cvmx_get_core_num(void) { @@ -392,7 +392,7 @@ static inline unsigned int cvmx_get_core_num(void) /** * Node-local number of the core on which the program is currently running. * - * @return core number on local node + * Return: core number on local node */ static inline unsigned int cvmx_get_local_core_num(void) { @@ -411,7 +411,7 @@ static inline unsigned int cvmx_get_local_core_num(void) * * @param val 32 bit value to count set bits in * - * @return Number of bits set + * Return: Number of bits set */ static inline u32 cvmx_pop(u32 val) { diff --git a/arch/mips/mach-octeon/include/mach/cvmx-scratch.h b/arch/mips/mach-octeon/include/mach/cvmx-scratch.h index d567a8453b..960381f987 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-scratch.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-scratch.h @@ -23,7 +23,7 @@ * * @param address byte address to read from * - * @return value read + * Return: value read */ static inline u8 cvmx_scratch_read8(u64 address) { @@ -35,7 +35,7 @@ static inline u8 cvmx_scratch_read8(u64 address) * * @param address byte address to read from * - * @return value read + * Return: value read */ static inline u16 cvmx_scratch_read16(u64 address) { @@ -47,7 +47,7 @@ static inline u16 cvmx_scratch_read16(u64 address) * * @param address byte address to read from * - * @return value read + * Return: value read */ static inline u32 cvmx_scratch_read32(u64 address) { @@ -59,7 +59,7 @@ static inline u32 cvmx_scratch_read32(u64 address) * * @param address byte address to read from * - * @return value read + * Return: value read */ static inline u64 cvmx_scratch_read64(u64 address) { diff --git a/arch/mips/mach-octeon/include/mach/cvmx-wqe.h b/arch/mips/mach-octeon/include/mach/cvmx-wqe.h index c9e3c8312a..7244d5d29c 100644 --- a/arch/mips/mach-octeon/include/mach/cvmx-wqe.h +++ b/arch/mips/mach-octeon/include/mach/cvmx-wqe.h @@ -763,7 +763,7 @@ static inline void cvmx_wqe_set_len(cvmx_wqe_t *work, int len) * * @param work pointer to work queue entry * - * @return 0 if packet had no error, non-zero to indicate error code. + * Return: 0 if packet had no error, non-zero to indicate error code. * * Please refer to HRM for the specific model for full enumaration of error codes. * With Octeon1/Octeon2 models, the returned code indicates L1/L2 errors. @@ -1042,7 +1042,7 @@ static inline int cvmx_wqe_is_l3_mcast(cvmx_wqe_t *work) * For older chips if PIP_GBL_CTL was proviosned to flag ip4_otions and * ipv6 extension, it will be flag them. * @param work pointer to work queue entry - * @return 1 -- If IP error was found in packet + * Return: 1 -- If IP error was found in packet * 0 -- If no IP error was found in packet. */ static inline int cvmx_wqe_is_ip_exception(cvmx_wqe_t *work) @@ -1221,7 +1221,7 @@ static inline cvmx_buf_ptr_pki_t cvmx_wqe_get_pki_pkt_ptr(cvmx_wqe_t *work) /** * Set the buffer segment count for a packet. * - * @return Returns the actual resulting value in the WQE fielda + * Return: Returns the actual resulting value in the WQE fielda * */ static inline unsigned int cvmx_wqe_set_bufs(cvmx_wqe_t *work, unsigned int bufs) @@ -1239,7 +1239,7 @@ static inline unsigned int cvmx_wqe_set_bufs(cvmx_wqe_t *work, unsigned int bufs * Get the offset of Layer-3 header, * only supported when Layer-3 protocol is IPv4 or IPv6. * - * @return Returns the offset, or 0 if the offset is not known or unsupported. + * Return: Returns the offset, or 0 if the offset is not known or unsupported. * * FIXME: Assuming word4 is present. */ @@ -1263,7 +1263,7 @@ static inline unsigned int cvmx_wqe_get_l3_offset(cvmx_wqe_t *work) * or when the Layer-2 header length is modified, and * a subsequent recalculation of checksums is anticipated. * - * @return Returns the actual value of the work entry offset field. + * Return: Returns the actual value of the work entry offset field. * * FIXME: Assuming word4 is present. */ diff --git a/arch/mips/mach-octeon/include/mach/octeon-feature.h b/arch/mips/mach-octeon/include/mach/octeon-feature.h index 2eb1714e90..44eadecf03 100644 --- a/arch/mips/mach-octeon/include/mach/octeon-feature.h +++ b/arch/mips/mach-octeon/include/mach/octeon-feature.h @@ -437,7 +437,7 @@ static inline int octeon_has_feature_OCTEON_FEATURE_PTP(void) /* * Answer ``Is the bit for feature set in the bitmap?'' * @param feature - * @return 1 when the feature is present and 0 otherwise, -1 in case of error. + * Return: 1 when the feature is present and 0 otherwise, -1 in case of error. */ #define octeon_has_feature(feature_x) octeon_has_feature_##feature_x() diff --git a/arch/mips/mach-octeon/include/mach/octeon-model.h b/arch/mips/mach-octeon/include/mach/octeon-model.h index 9164a4cfd6..c05178f45c 100644 --- a/arch/mips/mach-octeon/include/mach/octeon-model.h +++ b/arch/mips/mach-octeon/include/mach/octeon-model.h @@ -307,7 +307,7 @@ const char *octeon_model_get_string_buffer(u32 chip_id, char *buffer); /** * Return the octeon family, i.e., ProcessorID of the PrID register. * - * @return the octeon family on success, ((u32)-1) on error. + * Return: the octeon family on success, ((u32)-1) on error. */ static inline u32 cvmx_get_octeon_family(void) { diff --git a/arch/mips/mach-octeon/include/mach/octeon_eth.h b/arch/mips/mach-octeon/include/mach/octeon_eth.h index bfef0a6e9f..096fcfbfcf 100644 --- a/arch/mips/mach-octeon/include/mach/octeon_eth.h +++ b/arch/mips/mach-octeon/include/mach/octeon_eth.h @@ -115,7 +115,7 @@ void octeon_eth_register_phy_port_check(struct eth_device *dev, * * @param dev Ethernet device for phy * - * @return 0 to continue, or -1 for error to stop setting up the phy + * Return: 0 to continue, or -1 for error to stop setting up the phy */ int octeon_eth_board_post_setup_phy(struct eth_device *dev); diff --git a/arch/mips/mach-octeon/include/mach/octeon_fdt.h b/arch/mips/mach-octeon/include/mach/octeon_fdt.h index 31878cb233..db0e28b6dd 100644 --- a/arch/mips/mach-octeon/include/mach/octeon_fdt.h +++ b/arch/mips/mach-octeon/include/mach/octeon_fdt.h @@ -52,7 +52,7 @@ enum octeon_gpio_type { * reg = <0> then the interface will be renamed after this function to * interface@0. * - * @return 0 for success. + * Return: 0 for success. */ int octeon_fdt_patch_rename(void *fdt, const char *fdt_key, const char *trim_name, bool rename, void (*callback)(void *fdt, int offset, void *arg), void *cbarg); @@ -85,7 +85,7 @@ int octeon_fdt_patch_rename(void *fdt, const char *fdt_key, const char *trim_nam * reg = <0> then the interface will be renamed after this function to * interface@0. * - * @return 0 for success. + * Return: 0 for success. */ int octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name); @@ -150,7 +150,7 @@ int octeon_fdt_compat_vendor(const void *fdt, int nodeoffset, const char *vendor * @param fdt pointer to flat device tree * @param nodeoffset node offset to get OCX node for * - * @return the Octeon OCX node number + * Return: the Octeon OCX node number */ int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset); @@ -161,7 +161,7 @@ int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset); * @param node_offset Node offset in device tree * @param[in] strlist Array of FDT devices to check, end must be NULL * - * @return 0 if at least one device is compatible, 1 if not compatible. + * Return: 0 if at least one device is compatible, 1 if not compatible. */ int octeon_fdt_node_check_compatible(const void *fdt, int node_offset, const char *const *strlist); /** @@ -170,7 +170,7 @@ int octeon_fdt_node_check_compatible(const void *fdt, int node_offset, const cha * @param[in] fdt Pointer to flat device tree * @param node_offset Node offset in device tree * - * @return i2c bus number or -1 if error + * Return: i2c bus number or -1 if error */ int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset); @@ -182,7 +182,7 @@ int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset); * @param[out] bus i2c bus number of device * @param[out] addr address of device on i2c bus * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr); @@ -194,7 +194,7 @@ int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr); * @param phandle phandle of GPIO node * @param pin pin number to read * - * @return 0 = pin is low, 1 = pin is high, -1 = error + * Return: 0 = pin is low, 1 = pin is high, -1 = error */ int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin); @@ -207,7 +207,7 @@ int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin); * @param pin pin number to read * @param val value to write (1 = high, 0 = low) * - * @return 0 = success, -1 = error + * Return: 0 = success, -1 = error */ int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val); @@ -221,7 +221,7 @@ int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val); * @param[out] addr i2c address of SFP EEPROM * @param[out] mod_abs Set true if module is absent, false if present * - * @return 0 for success, -1 if there are problems with the device tree + * Return: 0 for success, -1 if there are problems with the device tree */ int octeon_fdt_get_sfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr, bool *mod_abs); @@ -235,7 +235,7 @@ int octeon_fdt_get_sfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr * @param[out] addr i2c address of SFP eeprom * @param[out] mod_abs Set true if module is absent, false if present * - * @return 0 for success, -1 if there are problems with the device tree + * Return: 0 for success, -1 if there are problems with the device tree */ int octeon_fdt_get_qsfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr, bool *mod_abs); @@ -249,7 +249,7 @@ int octeon_fdt_get_qsfp_eeprom(const void *fdt, int mac_node, int *bus, int *add * @param[out] i2c_bus For i2c GPIO expanders, the i2c bus number * @param[out] i2c_addr For i2c GPIO expanders, the i2c address * - * @return 0 for success, -1 for errors + * Return: 0 for success, -1 for errors * * NOTE: It is up to the caller to determine the pin number. */ @@ -262,7 +262,7 @@ int octeon_fdt_get_gpio_info(int fdt_node, enum octeon_gpio_type *type, int *i2c * @param fdt_node FDT node of phy * @param[out] type Type of GPIO * - * @return pointer to phy device or NULL if no match found. + * Return: pointer to phy device or NULL if no match found. */ struct phy_device *octeon_fdt_get_phy_gpio_info(int fdt_node, enum octeon_gpio_type *type); #endif /* __OCTEON_FDT_H__ */ diff --git a/arch/mips/mach-octeon/include/mach/octeon_pci.h b/arch/mips/mach-octeon/include/mach/octeon_pci.h index 3034f23dc6..e28f5f9ee3 100644 --- a/arch/mips/mach-octeon/include/mach/octeon_pci.h +++ b/arch/mips/mach-octeon/include/mach/octeon_pci.h @@ -61,7 +61,7 @@ u32 octeon_pci_bus_to_phys(u32 bus); * @param pf - PCIe config space pf num * @param[out] id - override device and vendor ID * - * @return 0 if override found, 1 if not found. + * Return: 0 if override found, 1 if not found. */ int octeon_find_pcie_id_override(unsigned int address, unsigned int pf, u32 *id); diff --git a/arch/mips/mach-octeon/include/mach/octeon_qlm.h b/arch/mips/mach-octeon/include/mach/octeon_qlm.h index 219625b256..e51343636f 100644 --- a/arch/mips/mach-octeon/include/mach/octeon_qlm.h +++ b/arch/mips/mach-octeon/include/mach/octeon_qlm.h @@ -36,7 +36,7 @@ * 1: QLMC_REF_CLK0 * 2: QLMC_REF_CLK1 * - * @return Return 0 on success or -1. + * Return: Return 0 on success or -1. * * @note When the 161MHz clock is used it can only be used for * XLAUI mode with a 6316 speed or XFI mode with a 103125 speed. diff --git a/arch/mips/mach-octeon/octeon_fdt.c b/arch/mips/mach-octeon/octeon_fdt.c index 199f692516..9b16104ba7 100644 --- a/arch/mips/mach-octeon/octeon_fdt.c +++ b/arch/mips/mach-octeon/octeon_fdt.c @@ -121,7 +121,7 @@ static const char * const octeon_gpio_list[] = { * reg = <0> then the interface will be renamed after this function to * interface@0. * - * @return 0 for success. + * Return: 0 for success. */ int __octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name) { @@ -164,7 +164,7 @@ int octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name) * reg = <0> then the interface will be renamed after this function to * interface@0. * - * @return 0 for success. + * Return: 0 for success. */ int octeon_fdt_patch_rename(void *fdt, const char *fdt_key, const char *trim_name, bool rename, @@ -648,7 +648,7 @@ int octeon_fdt_compat_vendor(const void *fdt, int nodeoffset, const char *vendor * @param fdt pointer to flat device tree * @param nodeoffset node offset to get OCX node for * - * @return the Octeon OCX node number + * Return: the Octeon OCX node number */ int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset) { @@ -662,7 +662,7 @@ int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset) * @param node_offset Node offset in device tree * @param[in] strlist Array of FDT devices to check, end must be NULL * - * @return 0 if at least one device is compatible, 1 if not compatible. + * Return: 0 if at least one device is compatible, 1 if not compatible. */ int octeon_fdt_node_check_compatible(const void *fdt, int node_offset, const char *const *strlist) @@ -685,7 +685,7 @@ int octeon_fdt_node_check_compatible(const void *fdt, int node_offset, * @param[in] fdt Pointer to flat device tree * @param node_offset Node offset in device tree * - * @return i2c bus number or -1 if error + * Return: i2c bus number or -1 if error */ int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset) { @@ -742,7 +742,7 @@ int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset) * @param[out] bus i2c bus number of device * @param[out] addr address of device on i2c bus * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr) { @@ -765,7 +765,7 @@ int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr) * @param phandle phandle of GPIO node * @param pin pin number to read * - * @return 0 = pin is low, 1 = pin is high, -1 = error + * Return: 0 = pin is low, 1 = pin is high, -1 = error */ int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin) { @@ -847,7 +847,7 @@ int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin) * @param pin pin number to read * @param val value to write (1 = high, 0 = low) * - * @return 0 = success, -1 = error + * Return: 0 = success, -1 = error */ int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val) { @@ -918,7 +918,7 @@ int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val) * @param[out] i2c_bus For i2c GPIO expanders, the i2c bus number * @param[out] i2c_addr For i2c GPIO expanders, the i2c address * - * @return 0 for success, -1 for errors + * Return: 0 for success, -1 for errors * * NOTE: It is up to the caller to determine the pin number. */ @@ -988,7 +988,7 @@ int octeon_fdt_get_gpio_info(int fdt_node, enum octeon_gpio_type *type, * * @param fdt_node FDT node in device tree * - * @return pointer to PHY device or NULL if none found. + * Return: pointer to PHY device or NULL if none found. */ static struct phy_device *octeon_fdt_get_phy_device_from_node(int fdt_node) { @@ -1014,7 +1014,7 @@ static struct phy_device *octeon_fdt_get_phy_device_from_node(int fdt_node) * @param fdt_node FDT node of phy * @param[out] type Type of GPIO * - * @return pointer to phy device or NULL if no match found. + * Return: pointer to phy device or NULL if no match found. */ struct phy_device *octeon_fdt_get_phy_gpio_info(int fdt_node, enum octeon_gpio_type *type) { diff --git a/arch/mips/mach-octeon/octeon_qlm.c b/arch/mips/mach-octeon/octeon_qlm.c index 763692781d..1be7434e78 100644 --- a/arch/mips/mach-octeon/octeon_qlm.c +++ b/arch/mips/mach-octeon/octeon_qlm.c @@ -176,7 +176,7 @@ static void __set_qlm_pcie_mode_61xx(int pcie_port, int root_complex) * SPEED value is ignored in this mode. QLM_SPD is set based on * pcie2x1 value in this mode. * - * @return Return 0 on success or -1. + * Return: Return 0 on success or -1. */ static int octeon_configure_qlm_cn61xx(int qlm, int speed, int mode, int rc, int pcie2x1) { @@ -1882,7 +1882,7 @@ static int __dlmx_setup_pcie_cn70xx(int qlm, enum cvmx_qlm_mode mode, int gen2, * @param ref_clk_input The reference-clock input to use to configure QLM * @param ref_clk_sel The reference-clock selection to use to configure QLM * - * @return Return 0 on success or -1. + * Return: Return 0 on success or -1. */ static int octeon_configure_qlm_cn70xx(int qlm, int speed, int mode, int rc, int gen2, int ref_clk_sel, int ref_clk_input) @@ -2168,7 +2168,7 @@ void octeon_qlm_dfe_disable(int node, int qlm, int lane, int baud_mhz, int mode) * @param ctle_zero Equalizer Peaking control * @param agc_pre_ctle Pre-CTLE gain * @param agc_post_ctle Post-CTLE gain - * @return Zero on success, negative on failure + * Return: Zero on success, negative on failure */ int octeon_qlm_dfe_disable_ctle_agc(int node, int qlm, int lane, int baud_mhz, int mode, @@ -3278,7 +3278,7 @@ static const struct refclk_settings_cn78xx refclk_settings_cn78xx[R_NUM_LANE_MOD * @param ref_clk_sel 0 = 100MHz, 1 = 125MHz, 2 = 156.25MHz, * 3 = 161.1328125MHz * - * @return 0 for success or -1 if the reference clock selector is not supported + * Return: 0 for success or -1 if the reference clock selector is not supported * * NOTE: This must be called before __qlm_setup_pll_cn78xx. */ @@ -3624,7 +3624,7 @@ static void __qlm_setup_pll_cn78xx(int node, int qlm) * @param[out] alt_pll_settings If non-NULL this will be set if non-default PLL * settings are required for the mode. * - * @return lane mode to use or -1 on error + * Return: lane mode to use or -1 on error * * NOTE: In some modes */ @@ -4103,7 +4103,7 @@ static void __setup_pem_reset(int node, int pem, int is_endpoint) * 3 = REF_161MHZ * @param ref_clk_input The reference-clock input to use to configure QLM * - * @return Return 0 on success or -1. + * Return: Return 0 on success or -1. */ int octeon_configure_qlm_cn78xx(int node, int qlm, int baud_mhz, int mode, int rc, int gen3, int ref_clk_sel, int ref_clk_input) @@ -4629,7 +4629,7 @@ static int __is_qlm_valid_bgx_cn73xx(int qlm) * 1 = common reference clock input 0 * 2 = common reference clock input 1 * - * @return Return 0 on success or -1. + * Return: Return 0 on success or -1. */ static int octeon_configure_qlm_cn73xx(int qlm, int baud_mhz, int mode, int rc, int gen3, int ref_clk_sel, int ref_clk_input) @@ -5339,7 +5339,7 @@ static int __rmac_pll_config(int baud_mhz, int qlm, int mode) * 3 = REF_122MHZ * @param ref_clk_input The reference-clock input to use to configure QLM * - * @return Return 0 on success or -1. + * Return: Return 0 on success or -1. */ static int octeon_configure_qlm_cnf75xx(int qlm, int baud_mhz, int mode, int rc, int gen3, int ref_clk_sel, int ref_clk_input) @@ -5788,7 +5788,7 @@ static int octeon_configure_qlm_cnf75xx(int qlm, int baud_mhz, int mode, int rc, * 1: QLMC_REF_CLK0 * 2: QLMC_REF_CLK1 * - * @return Return 0 on success or -1. + * Return: Return 0 on success or -1. */ int octeon_configure_qlm(int qlm, int speed, int mode, int rc, int pcie_mode, int ref_clk_sel, int ref_clk_input) diff --git a/arch/powerpc/cpu/mpc8xxx/fsl_pamu.c b/arch/powerpc/cpu/mpc8xxx/fsl_pamu.c index 5229949951..1101b9138f 100644 --- a/arch/powerpc/cpu/mpc8xxx/fsl_pamu.c +++ b/arch/powerpc/cpu/mpc8xxx/fsl_pamu.c @@ -70,7 +70,7 @@ static void pamu_setup_default_xfer_to_host_spaace(struct paace *spaace) then snoopid not defined * @param[in] subwin_cnt number of sub-windows * - * @return Returns 0 upon success else error code < 0 returned + * Return: Returns 0 upon success else error code < 0 returned */ static int pamu_config_ppaace(uint32_t liodn, uint64_t win_addr, uint64_t win_size, uint32_t omi, diff --git a/arch/riscv/include/asm/smp.h b/arch/riscv/include/asm/smp.h index 2dae0800ce..4284a332e9 100644 --- a/arch/riscv/include/asm/smp.h +++ b/arch/riscv/include/asm/smp.h @@ -54,7 +54,7 @@ void handle_ipi(ulong hart); * @arg0: First argument of function * @arg1: Second argument of function * @wait: Wait for harts to acknowledge request - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int smp_call_function(ulong addr, ulong arg0, ulong arg1, int wait); @@ -65,7 +65,7 @@ int smp_call_function(ulong addr, ulong arg0, ulong arg1, int wait); * the cpu driver is initialized. No other riscv_*_ipi() calls will be made * before this function is called. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int riscv_init_ipi(void); @@ -75,7 +75,7 @@ int riscv_init_ipi(void); * Platform code must provide this function. * * @hart: Hart ID of receiving hart - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int riscv_send_ipi(int hart); @@ -85,7 +85,7 @@ int riscv_send_ipi(int hart); * Platform code must provide this function. * * @hart: Hart ID of hart to be cleared - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int riscv_clear_ipi(int hart); @@ -97,7 +97,7 @@ int riscv_clear_ipi(int hart); * @hart: Hart ID of hart to be checked * @pending: Pointer to variable with result of the check, * 1 if IPI is pending, 0 otherwise - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int riscv_get_ipi(int hart, int *pending); diff --git a/arch/riscv/include/asm/spl.h b/arch/riscv/include/asm/spl.h index 1487f2d910..e8a94fcb1f 100644 --- a/arch/riscv/include/asm/spl.h +++ b/arch/riscv/include/asm/spl.h @@ -31,7 +31,7 @@ enum { /** * spl_board_init_f() - initialize board in the SPL phase * - * @return 0 if succeeded, -ve on error + * Return: 0 if succeeded, -ve on error */ int spl_board_init_f(void); diff --git a/arch/sandbox/cpu/cpu.c b/arch/sandbox/cpu/cpu.c index 9887d09272..ff0fa8a685 100644 --- a/arch/sandbox/cpu/cpu.c +++ b/arch/sandbox/cpu/cpu.c @@ -73,7 +73,7 @@ int cleanup_before_linux_select(int flags) * which we can use to map back to the pointer later. * * @ptr: Pointer to check - * @return true if this is within sandbox emulated DRAM, false if not + * Return: true if this is within sandbox emulated DRAM, false if not */ static bool is_in_sandbox_mem(const void *ptr) { diff --git a/arch/sandbox/cpu/os.c b/arch/sandbox/cpu/os.c index 40ebe322ae..d83c862182 100644 --- a/arch/sandbox/cpu/os.c +++ b/arch/sandbox/cpu/os.c @@ -718,7 +718,7 @@ static int make_exec(char *fname, const void *data, int size) * @argvp: Returns newly allocated args list * @add_args: Arguments to add, each a string * @count: Number of arguments in @add_args - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ static int add_args(char ***argvp, char *add_args[], int count) { @@ -764,7 +764,7 @@ static int add_args(char ***argvp, char *add_args[], int count) * execs it. * * @fname: Filename to exec - * @return does not return on success, any return value is an error + * Return: does not return on success, any return value is an error */ static int os_jump_to_file(const char *fname, bool delete_it) { diff --git a/arch/sandbox/cpu/state.c b/arch/sandbox/cpu/state.c index 4e822538ba..ce904b1740 100644 --- a/arch/sandbox/cpu/state.c +++ b/arch/sandbox/cpu/state.c @@ -101,7 +101,7 @@ err_open: * @state: Sandbox state * @io: Method to use for reading state * @blob: FDT containing state - * @return 0 if OK, -EINVAL if the read function returned failure + * Return: 0 if OK, -EINVAL if the read function returned failure */ int sandbox_read_state_nodes(struct sandbox_state *state, struct sandbox_state_io *io, const void *blob) @@ -190,7 +190,7 @@ int sandbox_read_state(struct sandbox_state *state, const char *fname) * * @state: Sandbox state * @io: Method to use for writing state - * @return 0 if OK, -EIO if there is a fatal error (such as out of space + * Return: 0 if OK, -EIO if there is a fatal error (such as out of space * for adding the data), -EINVAL if the write function failed. */ int sandbox_write_state_node(struct sandbox_state *state, diff --git a/arch/sandbox/include/asm/eth.h b/arch/sandbox/include/asm/eth.h index b313bf57c6..f042a5f3b9 100644 --- a/arch/sandbox/include/asm/eth.h +++ b/arch/sandbox/include/asm/eth.h @@ -23,7 +23,7 @@ void sandbox_eth_skip_timeout(void); * @dev: device that received the packet * @packet: pointer to the received pacaket buffer * @len: length of received packet - * @return 0 if injected, -EAGAIN if not + * Return: 0 if injected, -EAGAIN if not */ int sandbox_eth_arp_req_to_reply(struct udevice *dev, void *packet, unsigned int len); @@ -36,7 +36,7 @@ int sandbox_eth_arp_req_to_reply(struct udevice *dev, void *packet, * @dev: device that received the packet * @packet: pointer to the received pacaket buffer * @len: length of received packet - * @return 0 if injected, -EAGAIN if not + * Return: 0 if injected, -EAGAIN if not */ int sandbox_eth_ping_req_to_reply(struct udevice *dev, void *packet, unsigned int len); @@ -47,7 +47,7 @@ int sandbox_eth_ping_req_to_reply(struct udevice *dev, void *packet, * Inject an ARP request for this target * * @dev: device that received the packet - * @return 0 if injected, -EOVERFLOW if not + * Return: 0 if injected, -EOVERFLOW if not */ int sandbox_eth_recv_arp_req(struct udevice *dev); @@ -57,7 +57,7 @@ int sandbox_eth_recv_arp_req(struct udevice *dev); * Inject a ping request for this target * * @dev: device that received the packet - * @return 0 if injected, -EOVERFLOW if not + * Return: 0 if injected, -EOVERFLOW if not */ int sandbox_eth_recv_ping_req(struct udevice *dev); diff --git a/arch/sandbox/include/asm/gpio.h b/arch/sandbox/include/asm/gpio.h index 9542fdee67..0dd4c7bf60 100644 --- a/arch/sandbox/include/asm/gpio.h +++ b/arch/sandbox/include/asm/gpio.h @@ -37,7 +37,7 @@ * * @param dev device to use * @param offset GPIO offset within bank - * @return -1 on error, 0 if GPIO is low, >0 if high + * Return: -1 on error, 0 if GPIO is low, >0 if high */ int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset); @@ -47,7 +47,7 @@ int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset); * @param dev device to use * @param offset GPIO offset within bank * @param value value to set (0 for low, non-zero for high) - * @return -1 on error, 0 if ok + * Return: -1 on error, 0 if ok */ int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value); @@ -56,7 +56,7 @@ int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value); * * @param dev device to use * @param offset GPIO offset within bank - * @return -1 on error, 0 if GPIO is input, >0 if output + * Return: -1 on error, 0 if GPIO is input, >0 if output */ int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset); @@ -66,7 +66,7 @@ int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset); * @param dev device to use * @param offset GPIO offset within bank * @param output 0 to set as input, 1 to set as output - * @return -1 on error, 0 if ok + * Return: -1 on error, 0 if ok */ int sandbox_gpio_set_direction(struct udevice *dev, unsigned int offset, int output); @@ -76,7 +76,7 @@ int sandbox_gpio_set_direction(struct udevice *dev, unsigned int offset, * * @param dev device to use * @param offset GPIO offset within bank - * @return dir_flags: bitfield accesses by GPIOD_ defines + * Return: dir_flags: bitfield accesses by GPIOD_ defines */ ulong sandbox_gpio_get_flags(struct udevice *dev, unsigned int offset); @@ -86,7 +86,7 @@ ulong sandbox_gpio_get_flags(struct udevice *dev, unsigned int offset); * @param dev device to use * @param offset GPIO offset within bank * @param flags bitfield accesses by GPIOD_ defines - * @return -1 on error, 0 if ok + * Return: -1 on error, 0 if ok */ int sandbox_gpio_set_flags(struct udevice *dev, unsigned int offset, ulong flags); diff --git a/arch/sandbox/include/asm/sdl.h b/arch/sandbox/include/asm/sdl.h index 25dbdb5944..e271a849af 100644 --- a/arch/sandbox/include/asm/sdl.h +++ b/arch/sandbox/include/asm/sdl.h @@ -19,7 +19,7 @@ * display will pass 5, since 2*5 = 32 * @double_size: true to double the visible size in each direction for high-DPI * displays - * @return 0 if OK, -ENODEV if no device, -EIO if SDL failed to initialize + * Return: 0 if OK, -ENODEV if no device, -EIO if SDL failed to initialize * and -EPERM if the video failed to come up. */ int sandbox_sdl_init_display(int width, int height, int log2_bpp, @@ -28,7 +28,7 @@ int sandbox_sdl_init_display(int width, int height, int log2_bpp, /** * sandbox_sdl_remove_display() - Remove the SDL screen * - * @return 0 if OK, -ENOENT if the SDL had not been inited. + * Return: 0 if OK, -ENOENT if the SDL had not been inited. */ int sandbox_sdl_remove_display(void); @@ -39,7 +39,7 @@ int sandbox_sdl_remove_display(void); * user can see it. * * @lcd_base: Base of frame buffer - * @return 0 if screen was updated, -ENODEV is there is no screen. + * Return: 0 if screen was updated, -ENODEV is there is no screen. */ int sandbox_sdl_sync(void *lcd_base); @@ -50,7 +50,7 @@ int sandbox_sdl_sync(void *lcd_base); * * @key: Array to receive keycodes * @max_keys: Size of array - * @return number of keycodes found, 0 if none, -ENODEV if no keyboard + * Return: number of keycodes found, 0 if none, -ENODEV if no keyboard */ int sandbox_sdl_scan_keys(int key[], int max_keys); @@ -58,7 +58,7 @@ int sandbox_sdl_scan_keys(int key[], int max_keys); * sandbox_sdl_key_pressed() - check if a particular key is pressed * * @keycode: Keycode to check (KEY_... - see include/linux/input.h - * @return 0 if pressed, -ENOENT if not pressed. -ENODEV if keybord not + * Return: 0 if pressed, -ENOENT if not pressed. -ENODEV if keybord not * available, */ int sandbox_sdl_key_pressed(int keycode); @@ -74,7 +74,7 @@ int sandbox_sdl_sound_play(const void *data, uint count); /** * sandbox_sdl_sound_stop() - stop playing a sound * - * @return 0 if OK, -ENODEV if no sound is available + * Return: 0 if OK, -ENODEV if no sound is available */ int sandbox_sdl_sound_stop(void); @@ -83,7 +83,7 @@ int sandbox_sdl_sound_stop(void); * * @rate: Sample rate to use * @channels: Number of channels to use (1=mono, 2=stereo) - * @return 0 if OK, -ENODEV if no sound is available + * Return: 0 if OK, -ENODEV if no sound is available */ int sandbox_sdl_sound_init(int rate, int channels); diff --git a/arch/sandbox/include/asm/state.h b/arch/sandbox/include/asm/state.h index 10352a587e..07c768ae5d 100644 --- a/arch/sandbox/include/asm/state.h +++ b/arch/sandbox/include/asm/state.h @@ -134,7 +134,7 @@ struct sandbox_state { * data set for start-of-day. * @param blob: Pointer to device tree blob, or NULL if no data to read * @param node: Node offset to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error * * @write: Function to write state to FDT * The caller will ensure that there is a node ready for the state. The @@ -186,7 +186,7 @@ struct sandbox_state_io { /** * Gets a pointer to the current state. * - * @return pointer to state + * Return: pointer to state */ struct sandbox_state *state_get_current(void); @@ -198,7 +198,7 @@ struct sandbox_state *state_get_current(void); * * @param state Sandbox state to update * @param fname Filename of device tree file to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sandbox_read_state(struct sandbox_state *state, const char *fname); @@ -212,7 +212,7 @@ int sandbox_read_state(struct sandbox_state *state, const char *fname); * * @param state Sandbox state to update * @param fname Filename of device tree file to write to - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sandbox_write_state(struct sandbox_state *state, const char *fname); @@ -247,7 +247,7 @@ void state_set_skip_delays(bool skip_delays); /** * See if delays should be skipped * - * @return true if delays should be skipped, false if they should be honoured + * Return: true if delays should be skipped, false if they should be honoured */ bool state_get_skip_delays(void); @@ -274,7 +274,7 @@ int state_init(void); * Uninitialize the test system state, writing out state if configured to * do so. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int state_uninit(void); diff --git a/arch/sandbox/include/asm/test.h b/arch/sandbox/include/asm/test.h index 0aad827e9c..0d83f4dc1b 100644 --- a/arch/sandbox/include/asm/test.h +++ b/arch/sandbox/include/asm/test.h @@ -101,7 +101,7 @@ uint sanbox_i2c_eeprom_get_prev_offset(struct udevice *dev); * @use_system_time: true to use system time, false to use @base_time * @offset: RTC offset from current system/base time (-1 for no * change) - * @return old value of RTC offset + * Return: old value of RTC offset */ long sandbox_i2c_rtc_set_offset(struct udevice *dev, bool use_system_time, int offset); @@ -111,7 +111,7 @@ long sandbox_i2c_rtc_set_offset(struct udevice *dev, bool use_system_time, * * @dev: RTC device to adjust * @base_time: New base system time (set to -1 for no change) - * @return old base time + * Return: old base time */ long sandbox_i2c_rtc_get_set_base_time(struct udevice *dev, long base_time); @@ -135,7 +135,7 @@ int sandbox_osd_get_mem(struct udevice *dev, u8 *buf, size_t buflen); * @duty_ns: Current duty cycle of the PWM in nanoseconds * @enable: true if the PWM is enabled * @polarity: true if the PWM polarity is active high - * @return 0 if OK, -ENOSPC if the PWM number is invalid + * Return: 0 if OK, -ENOSPC if the PWM number is invalid */ int sandbox_pwm_get_config(struct udevice *dev, uint channel, uint *period_nsp, uint *duty_nsp, bool *enablep, bool *polarityp); @@ -164,7 +164,7 @@ void sandbox_get_codec_params(struct udevice *dev, int *interfacep, int *ratep, * This data is provided to the sandbox driver by the I2S tx_data() method. * * @dev: Device to check - * @return sum of audio data + * Return: sum of audio data */ int sandbox_get_i2s_sum(struct udevice *dev); @@ -174,14 +174,14 @@ int sandbox_get_i2s_sum(struct udevice *dev); * This is used in the sound test * * @dev: Device to check - * @return call count for the setup() method + * Return: call count for the setup() method */ int sandbox_get_setup_called(struct udevice *dev); /** * sandbox_get_sound_active() - Returns whether sound play is in progress * - * @return true if active, false if not + * Return: true if active, false if not */ int sandbox_get_sound_active(struct udevice *dev); @@ -191,7 +191,7 @@ int sandbox_get_sound_active(struct udevice *dev); * This data is provided to the sandbox driver by the sound play() method. * * @dev: Device to check - * @return sum of audio data + * Return: sum of audio data */ int sandbox_get_sound_sum(struct udevice *dev); @@ -207,7 +207,7 @@ void sandbox_set_allow_beep(struct udevice *dev, bool allow); * sandbox_get_beep_frequency() - Get the frequency of the current beep * * @dev: Device to check - * @return frequency of beep, if there is an active beep, else 0 + * Return: frequency of beep, if there is an active beep, else 0 */ int sandbox_get_beep_frequency(struct udevice *dev); @@ -215,7 +215,7 @@ int sandbox_get_beep_frequency(struct udevice *dev); * sandbox_spi_get_speed() - Get current speed setting of a sandbox spi bus * * @dev: Device to check - * @return current bus speed + * Return: current bus speed */ uint sandbox_spi_get_speed(struct udevice *dev); @@ -223,7 +223,7 @@ uint sandbox_spi_get_speed(struct udevice *dev); * sandbox_spi_get_mode() - Get current mode setting of a sandbox spi bus * * @dev: Device to check - * @return current mode + * Return: current mode */ uint sandbox_spi_get_mode(struct udevice *dev); @@ -231,7 +231,7 @@ uint sandbox_spi_get_mode(struct udevice *dev); * sandbox_get_pch_spi_protect() - Get the PCI SPI protection status * * @dev: Device to check - * @return 0 if not protected, 1 if protected + * Return: 0 if not protected, 1 if protected */ int sandbox_get_pch_spi_protect(struct udevice *dev); @@ -239,7 +239,7 @@ int sandbox_get_pch_spi_protect(struct udevice *dev); * sandbox_get_pci_ep_irq_count() - Get the PCI EP IRQ count * * @dev: Device to check - * @return irq count + * Return: irq count */ int sandbox_get_pci_ep_irq_count(struct udevice *dev); @@ -254,7 +254,7 @@ int sandbox_get_pci_ep_irq_count(struct udevice *dev); * @type: Type of BAR (PCI_BASE_ADDRESS_SPACE_IO or * PCI_BASE_ADDRESS_MEM_TYPE_32) * @size: Size of BAR in bytes - * @return BAR value to return from emulator + * Return: BAR value to return from emulator */ uint sandbox_pci_read_bar(u32 barval, int type, uint size); @@ -283,7 +283,7 @@ void sandbox_cros_ec_set_test_flags(struct udevice *dev, uint flags); * @dev: Device to check * @index: PWM channel index * @duty: Current duty cycle in 0..EC_PWM_MAX_DUTY range. - * @return 0 if OK, -ENOSPC if the PWM number is invalid + * Return: 0 if OK, -ENOSPC if the PWM number is invalid */ int sandbox_cros_ec_get_pwm_duty(struct udevice *dev, uint index, uint *duty); @@ -298,7 +298,7 @@ int sandbox_cros_ec_get_pwm_duty(struct udevice *dev, uint index, uint *duty); * * @dev: Device to adjust * @l2bpp: depth to set - * @return 0 if the device was already active, other error if it fails to probe + * Return: 0 if the device was already active, other error if it fails to probe * after the change */ int sandbox_sdl_set_bpp(struct udevice *dev, enum video_log2_bpp l2bpp); diff --git a/arch/sandbox/include/asm/u-boot-sandbox.h b/arch/sandbox/include/asm/u-boot-sandbox.h index 56dc13c3eb..9eb19323ec 100644 --- a/arch/sandbox/include/asm/u-boot-sandbox.h +++ b/arch/sandbox/include/asm/u-boot-sandbox.h @@ -44,7 +44,7 @@ struct udevice; * @devp: Returns the device which mapped into this space * @ptrp: Returns a pointer to the mapped address. The device's space * can be accessed as @lenp bytes starting here - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_map_physmem(phys_addr_t paddr, unsigned long *lenp, struct udevice **devp, void **ptrp); @@ -57,7 +57,7 @@ int pci_map_physmem(phys_addr_t paddr, unsigned long *lenp, * @paddr: Physical memory address, as passed to pci_map_physmem() * @len: Size of area mapped, as returned by pci_map_physmem() * @dev: Device to unmap, as returned by pci_map_physmem() - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_unmap_physmem(const void *addr, unsigned long len, struct udevice *dev); diff --git a/arch/x86/cpu/apollolake/fsp_bindings.c b/arch/x86/cpu/apollolake/fsp_bindings.c index 319c78b95a..fb75e1f709 100644 --- a/arch/x86/cpu/apollolake/fsp_bindings.c +++ b/arch/x86/cpu/apollolake/fsp_bindings.c @@ -44,7 +44,7 @@ static void read_u8_prop(ofnode node, char *name, size_t count, u8 *dst) * Set to 0 if the property is expected to be a scalar * @dst: Pointer to destination of where to save the value(s) read * from devicetree - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ static int read_u16_prop(ofnode node, char *name, size_t count, u16 *dst) { @@ -196,7 +196,7 @@ static void read_swizzle_prop(ofnode node, char *name, size_t count, u8 *dst) * @fsp_bindings: Binding describing which devicetree properties should * be stored where in the FSP configuration structure * The end of the list is declared by a NULL pointer in propname - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error * * This function reads the configuration for FSP from the provided * devicetree node and saves it in the FSP configuration structure. diff --git a/arch/x86/cpu/broadwell/pch.c b/arch/x86/cpu/broadwell/pch.c index f012db9deb..37fcddbb9b 100644 --- a/arch/x86/cpu/broadwell/pch.c +++ b/arch/x86/cpu/broadwell/pch.c @@ -522,7 +522,7 @@ static void serialio_init_once(bool acpi_mode) /** * pch_serialio_init() - set up serial I/O devices * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int pch_serialio_init(void) { diff --git a/arch/x86/cpu/broadwell/refcode.c b/arch/x86/cpu/broadwell/refcode.c index 6c04dde992..aced3e5e26 100644 --- a/arch/x86/cpu/broadwell/refcode.c +++ b/arch/x86/cpu/broadwell/refcode.c @@ -65,7 +65,7 @@ struct rmodule_header { * platform controller hub (PCH). This function should be implemented by the * CPU-specific code. * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ static int cpu_run_reference_code(void) { diff --git a/arch/x86/cpu/intel_common/lpc.c b/arch/x86/cpu/intel_common/lpc.c index f31fddb6fa..af68c0f079 100644 --- a/arch/x86/cpu/intel_common/lpc.c +++ b/arch/x86/cpu/intel_common/lpc.c @@ -39,7 +39,7 @@ static void enable_port80_on_lpc(struct udevice *pch) * lpc_early_init() - set up LPC serial ports and other early things * * @dev: LPC device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int lpc_common_early_init(struct udevice *dev) { diff --git a/arch/x86/cpu/intel_common/p2sb.c b/arch/x86/cpu/intel_common/p2sb.c index 5a7b30d94a..e4e53f73c0 100644 --- a/arch/x86/cpu/intel_common/p2sb.c +++ b/arch/x86/cpu/intel_common/p2sb.c @@ -46,7 +46,7 @@ * This is needed by FSP-M which uses the High Precision Event Timer. * * @dev: P2SB device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int p2sb_early_init(struct udevice *dev) { diff --git a/arch/x86/cpu/ivybridge/bd82x6x.c b/arch/x86/cpu/ivybridge/bd82x6x.c index 0540b02161..89312a8634 100644 --- a/arch/x86/cpu/ivybridge/bd82x6x.c +++ b/arch/x86/cpu/ivybridge/bd82x6x.c @@ -39,7 +39,7 @@ static int pch_type = -1; * pch_silicon_revision() - Read silicon revision ID from the PCH * * @dev: PCH device - * @return silicon revision ID + * Return: silicon revision ID */ static int pch_silicon_revision(struct udevice *dev) { @@ -71,7 +71,7 @@ int pch_silicon_type(struct udevice *dev) * @dev: PCH device * @type: PCH type * @rev: Minimum required resion - * @return 0 if not supported, 1 if supported + * Return: 0 if not supported, 1 if supported */ static int pch_silicon_supported(struct udevice *dev, int type, int rev) { diff --git a/arch/x86/cpu/mp_init.c b/arch/x86/cpu/mp_init.c index c09762aee6..7637c9b07d 100644 --- a/arch/x86/cpu/mp_init.c +++ b/arch/x86/cpu/mp_init.c @@ -423,7 +423,7 @@ static int apic_wait_timeout(int total_delay, const char *msg) * * @num_aps: Number of APs we expect to find * @ap_count: Initially zero. Incremented by this function for each AP found - * @return 0 if all APs were set up correctly or there are none to set up, + * Return: 0 if all APs were set up correctly or there are none to set up, * -ENOSPC if the SIPI vector is too high in memory, * -ETIMEDOUT if the ICR is busy or the second SIPI fails to complete * -EIO if not all APs check in correctly @@ -536,7 +536,7 @@ static int bsp_do_flight_plan(struct udevice *cpu, struct mp_flight_plan *plan, * * @devp: If non-NULL, returns CPU device corresponding to the BSP * @cpu_countp: If non-NULL, returns the total number of CPUs - * @return CPU number of the BSP, or -ve on error. If multiprocessing is not + * Return: CPU number of the BSP, or -ve on error. If multiprocessing is not * enabled, returns 0 */ static int get_bsp(struct udevice **devp, int *cpu_countp) @@ -573,7 +573,7 @@ static int get_bsp(struct udevice **devp, int *cpu_countp) * pointer to new instructions * * @slot: Pointer to the AP's callback slot - * @return value of that pointer + * Return: value of that pointer */ static struct mp_callback *read_callback(struct mp_callback **slot) { @@ -610,7 +610,7 @@ static void store_callback(struct mp_callback **slot, struct mp_callback *val) * @num_cpus: The number of CPUs in the system (= number of APs + 1) * @expire_ms: Timeout to wait for all APs to finish, in milliseconds, or 0 for * no timeout - * @return 0 if OK, -ETIMEDOUT if one or more APs failed to respond in time + * Return: 0 if OK, -ETIMEDOUT if one or more APs failed to respond in time */ static int run_ap_work(struct mp_callback *callback, struct udevice *bsp, int num_cpus, uint expire_ms) @@ -670,7 +670,7 @@ static int run_ap_work(struct mp_callback *callback, struct udevice *bsp, * * @cpu: CPU that is waiting * @unused: Optional argument provided by struct mp_flight_record, not used here - * @return Does not return + * Return: Does not return */ static int ap_wait_for_instruction(struct udevice *cpu, void *unused) { diff --git a/arch/x86/cpu/mtrr.c b/arch/x86/cpu/mtrr.c index 260a008093..e69dfb552b 100644 --- a/arch/x86/cpu/mtrr.c +++ b/arch/x86/cpu/mtrr.c @@ -109,7 +109,7 @@ static void read_mtrrs(void *arg) /** * mtrr_copy_to_aps() - Copy the MTRRs from the boot CPU to other CPUs * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ static int mtrr_copy_to_aps(void) { diff --git a/arch/x86/cpu/slimbootloader/sdram.c b/arch/x86/cpu/slimbootloader/sdram.c index 36d0d4da55..c6f10e22e3 100644 --- a/arch/x86/cpu/slimbootloader/sdram.c +++ b/arch/x86/cpu/slimbootloader/sdram.c @@ -46,7 +46,7 @@ static struct sbl_memory_map_info *get_memory_map_info(void) * The memory map entries from Slim Bootloader hob are already sorted. * * @total_size: The memory size that u-boot occupies - * @return : The top available memory address lower than 4GB + * Return: : The top available memory address lower than 4GB */ ulong board_get_usable_ram_top(ulong total_size) { diff --git a/arch/x86/include/asm/acpi_table.h b/arch/x86/include/asm/acpi_table.h index d5c8805df3..55b1a3d3f1 100644 --- a/arch/x86/include/asm/acpi_table.h +++ b/arch/x86/include/asm/acpi_table.h @@ -46,7 +46,7 @@ u32 acpi_fill_csrt(u32 current); * Write out the table for High-Precision Event Timers * * @ctx: Current ACPI context - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_write_hpet(struct acpi_ctx *ctx); @@ -56,7 +56,7 @@ int acpi_write_hpet(struct acpi_ctx *ctx); * @ctx: Current ACPI context * @dev: Debug UART device to describe * @access_size: Access size for UART (e.g. ACPI_ACCESS_SIZE_DWORD_ACCESS) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_write_dbg2_pci_uart(struct acpi_ctx *ctx, struct udevice *dev, uint access_size); @@ -65,7 +65,7 @@ int acpi_write_dbg2_pci_uart(struct acpi_ctx *ctx, struct udevice *dev, * acpi_create_gnvs() - Create a GNVS (Global Non Volatile Storage) table * * @gnvs: Table to fill in - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_create_gnvs(struct acpi_global_nvs *gnvs); @@ -98,7 +98,7 @@ int arch_write_sci_irq_select(uint scis); * arch_madt_sci_irq_polarity() - Return the priority to use for the MADT * * @sci: System-control interrupt number - * @return priority to use (MP_IRQ_POLARITY_...) + * Return: priority to use (MP_IRQ_POLARITY_...) */ int arch_madt_sci_irq_polarity(int sci); @@ -155,7 +155,7 @@ void acpi_dmar_rmrr_fixup(struct acpi_ctx *ctx, void *base); * * @ctx: ACPI context pointer * @bdf: PCI device to add - * @return length of mapping in bytes + * Return: length of mapping in bytes */ int acpi_create_dmar_ds_pci(struct acpi_ctx *ctx, pci_dev_t bdf); @@ -166,7 +166,7 @@ int acpi_create_dmar_ds_pci(struct acpi_ctx *ctx, pci_dev_t bdf); * * @ctx: ACPI context pointer * @bdf: PCI device to add - * @return length of mapping in bytes + * Return: length of mapping in bytes */ int acpi_create_dmar_ds_pci_br(struct acpi_ctx *ctx, pci_dev_t bdf); @@ -176,7 +176,7 @@ int acpi_create_dmar_ds_pci_br(struct acpi_ctx *ctx, pci_dev_t bdf); * @ctx: ACPI context pointer * @enumeration_id: Enumeration ID (typically 2) * @bdf: PCI device to add - * @return length of mapping in bytes + * Return: length of mapping in bytes */ int acpi_create_dmar_ds_ioapic(struct acpi_ctx *ctx, uint enumeration_id, pci_dev_t bdf); @@ -190,7 +190,7 @@ int acpi_create_dmar_ds_ioapic(struct acpi_ctx *ctx, uint enumeration_id, * @ctx: ACPI context pointer * @enumeration_id: Enumeration ID (typically 0) * @bdf: PCI device to add - * @return length of mapping in bytes + * Return: length of mapping in bytes */ int acpi_create_dmar_ds_msi_hpet(struct acpi_ctx *ctx, uint enumeration_id, pci_dev_t bdf); diff --git a/arch/x86/include/asm/arch-apollolake/fsp_bindings.h b/arch/x86/include/asm/arch-apollolake/fsp_bindings.h index a80e66bbfa..ae1f1b7a43 100644 --- a/arch/x86/include/asm/arch-apollolake/fsp_bindings.h +++ b/arch/x86/include/asm/arch-apollolake/fsp_bindings.h @@ -86,7 +86,7 @@ struct lpddr4_swizzle_cfg { * fsp_m_update_config_from_dtb() - Read FSP-M config from devicetree node * @node: Valid node reference to read property from * @cfg: Pointer to FSP-M config structure - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error * * This function reads the configuration for FSP-M from the provided * devicetree node and saves it in the FSP-M configuration structure. @@ -99,7 +99,7 @@ int fsp_m_update_config_from_dtb(ofnode node, struct fsp_m_config *cfg); * fsp_s_update_config_from_dtb() - Read FSP-S config from devicetree node * @node: Valid node reference to read property from * @cfg: Pointer to FSP-S config structure - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error * * This function reads the configuration for FSP-S from the provided * devicetree node and saves it in the FSP-S configuration structure. diff --git a/arch/x86/include/asm/arch-apollolake/lpc.h b/arch/x86/include/asm/arch-apollolake/lpc.h index 977b7eccd8..51d478ff80 100644 --- a/arch/x86/include/asm/arch-apollolake/lpc.h +++ b/arch/x86/include/asm/arch-apollolake/lpc.h @@ -67,7 +67,7 @@ void lpc_enable_fixed_io_ranges(uint io_enables); * * @base: Base I/O address (e.g. 0x800) * @size: Size of window (e.g. 0x100) - * @return 0 if OK, -ENOSPC if there are no more windows available, -EALREADY + * Return: 0 if OK, -ENOSPC if there are no more windows available, -EALREADY * if already set up */ int lpc_open_pmio_window(uint base, uint size); diff --git a/arch/x86/include/asm/arch-apollolake/systemagent.h b/arch/x86/include/asm/arch-apollolake/systemagent.h index 48e76c2bb0..25dbc9c281 100644 --- a/arch/x86/include/asm/arch-apollolake/systemagent.h +++ b/arch/x86/include/asm/arch-apollolake/systemagent.h @@ -45,7 +45,7 @@ void enable_bios_reset_cpl(void); * below 4GB * * @dev: hostbridge device - * @return TOLUD address + * Return: TOLUD address */ ulong sa_get_tolud_base(struct udevice *dev); @@ -56,7 +56,7 @@ ulong sa_get_tolud_base(struct udevice *dev); * for Graphics Translation Tables. * * @dev: hostbridge device - * @return GSM address + * Return: GSM address */ ulong sa_get_gsm_base(struct udevice *dev); @@ -65,7 +65,7 @@ ulong sa_get_gsm_base(struct udevice *dev); * * This returns the top address of DRAM available below 4GB * - * @return TSEG base + * Return: TSEG base */ ulong sa_get_tseg_base(struct udevice *dev); diff --git a/arch/x86/include/asm/arch-coreboot/timestamp.h b/arch/x86/include/asm/arch-coreboot/timestamp.h index 531526b314..bbf89447dd 100644 --- a/arch/x86/include/asm/arch-coreboot/timestamp.h +++ b/arch/x86/include/asm/arch-coreboot/timestamp.h @@ -17,7 +17,7 @@ void timestamp_add_now(enum timestamp_id id); /** * timestamp_add_to_bootstage - Add important coreboot timestamps to bootstage * - * @return 0 if ok, -1 if no timestamps were found + * Return: 0 if ok, -1 if no timestamps were found */ int timestamp_add_to_bootstage(void); diff --git a/arch/x86/include/asm/arch-ivybridge/pch.h b/arch/x86/include/asm/arch-ivybridge/pch.h index 8018bc097d..0c980e547f 100644 --- a/arch/x86/include/asm/arch-ivybridge/pch.h +++ b/arch/x86/include/asm/arch-ivybridge/pch.h @@ -380,7 +380,7 @@ * pch_silicon_revision() - Read silicon device ID from the PCH * * @dev: PCH device - * @return silicon device ID + * Return: silicon device ID */ int pch_silicon_type(struct udevice *dev); diff --git a/arch/x86/include/asm/arch-ivybridge/sandybridge.h b/arch/x86/include/asm/arch-ivybridge/sandybridge.h index a3a507f2b3..4f2971ccab 100644 --- a/arch/x86/include/asm/arch-ivybridge/sandybridge.h +++ b/arch/x86/include/asm/arch-ivybridge/sandybridge.h @@ -111,7 +111,7 @@ * bridge_silicon_revision() - Get the Northbridge revision * * @dev: Northbridge device - * @return revision ID (bits 3:0) and bridge ID (bits 7:4) + * Return: revision ID (bits 3:0) and bridge ID (bits 7:4) */ int bridge_silicon_revision(struct udevice *dev); diff --git a/arch/x86/include/asm/bootm.h b/arch/x86/include/asm/bootm.h index bd8ce55729..109f686f74 100644 --- a/arch/x86/include/asm/bootm.h +++ b/arch/x86/include/asm/bootm.h @@ -19,7 +19,7 @@ void bootm_announce_and_cleanup(void); * @image_64bit: true if the image is a raw 64-bit kernel, false if it * is raw 32-bit or any type of self-extracting kernel * such as a bzImage. - * @return -ve error code. This function does not return if the kernel was + * Return: -ve error code. This function does not return if the kernel was * booted successfully. */ int boot_linux_kernel(ulong setup_base, ulong load_address, bool image_64bit); diff --git a/arch/x86/include/asm/cb_sysinfo.h b/arch/x86/include/asm/cb_sysinfo.h index 75901359f9..0201ac6b03 100644 --- a/arch/x86/include/asm/cb_sysinfo.h +++ b/arch/x86/include/asm/cb_sysinfo.h @@ -222,14 +222,14 @@ extern struct sysinfo_t lib_sysinfo; * so. * * @info: Place to put the parsed information - * @return 0 if OK, -ENOENT if no table found + * Return: 0 if OK, -ENOENT if no table found */ int get_coreboot_info(struct sysinfo_t *info); /** * cb_get_sysinfo() - get a pointer to the parsed coreboot sysinfo * - * @return pointer to sysinfo, or NULL if not available + * Return: pointer to sysinfo, or NULL if not available */ const struct sysinfo_t *cb_get_sysinfo(void); diff --git a/arch/x86/include/asm/coreboot_tables.h b/arch/x86/include/asm/coreboot_tables.h index a74654bbe3..f131de56a4 100644 --- a/arch/x86/include/asm/coreboot_tables.h +++ b/arch/x86/include/asm/coreboot_tables.h @@ -554,7 +554,7 @@ void write_coreboot_table(u32 addr, struct memory_area *cfg_tables); /** * locate_coreboot_table() - Try to find coreboot tables at standard locations * - * @return address of table that was found, or -ve error number + * Return: address of table that was found, or -ve error number */ long locate_coreboot_table(void); diff --git a/arch/x86/include/asm/cpu.h b/arch/x86/include/asm/cpu.h index 5b001bbee2..3346012d33 100644 --- a/arch/x86/include/asm/cpu.h +++ b/arch/x86/include/asm/cpu.h @@ -205,7 +205,7 @@ void cpu_disable_paging_pae(void); /** * cpu_has_64bit() - Check if the CPU has 64-bit support * - * @return 1 if this CPU supports long mode (64-bit), 0 if not + * Return: 1 if this CPU supports long mode (64-bit), 0 if not */ int cpu_has_64bit(void); @@ -224,7 +224,7 @@ const char *cpu_vendor_name(int vendor); * cpu_get_name() - Get the name of the current cpu * * @name: Place to put name, which must be CPU_MAX_NAME_LEN bytes including - * @return pointer to name, which will likely be a few bytes after the start + * Return: pointer to name, which will likely be a few bytes after the start * of @name * \0 terminator */ @@ -277,14 +277,14 @@ int cpu_jump_to_64bit_uboot(ulong target); /** * cpu_get_family_model() - Get the family and model for the CPU * - * @return the CPU ID masked with 0x0fff0ff0 + * Return: the CPU ID masked with 0x0fff0ff0 */ u32 cpu_get_family_model(void); /** * cpu_get_stepping() - Get the stepping value for the CPU * - * @return the CPU ID masked with 0xf + * Return: the CPU ID masked with 0xf */ u32 cpu_get_stepping(void); @@ -293,7 +293,7 @@ u32 cpu_get_stepping(void); * * This is 32 for older CPUs but newer ones may support 36. * - * @return address size (typically 32 or 36) + * Return: address size (typically 32 or 36) */ int cpu_phys_address_size(void); diff --git a/arch/x86/include/asm/cpu_common.h b/arch/x86/include/asm/cpu_common.h index e41ceda73a..dd4cf15aed 100644 --- a/arch/x86/include/asm/cpu_common.h +++ b/arch/x86/include/asm/cpu_common.h @@ -22,7 +22,7 @@ struct udevice; * This reports BIST failure, enables the LAPIC, updates microcode, enables * the upper 128-bytes of CROM RAM, probes the northbridge, PCH, LPC and SATA. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cpu_common_init(void); @@ -35,7 +35,7 @@ int cpu_common_init(void); * Some details are available here: * http://forum.hwbot.org/showthread.php?t=76092 * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cpu_set_flex_ratio_to_tdp_nominal(void); @@ -49,7 +49,7 @@ int cpu_set_flex_ratio_to_tdp_nominal(void); * @info: cpu_info struct to fill in * @bclk_mz: the base clock in MHz * - * @return 0 always + * Return: 0 always */ int cpu_intel_get_info(struct cpu_info *info, int bclk_mz); @@ -60,7 +60,7 @@ int cpu_intel_get_info(struct cpu_info *info, int bclk_mz); * MSR_TEMPERATURE_TARGET value. * * @dev: CPU device - * @return 0 if OK, -ENOENT if no target is given in device tree + * Return: 0 if OK, -ENOENT if no target is given in device tree */ int cpu_configure_thermal_target(struct udevice *dev); @@ -76,7 +76,7 @@ void cpu_set_perf_control(uint clk_ratio); /** * cpu_config_tdp_levels() - Check for configurable TDP option * - * @return true if the CPU has configurable TDP (Thermal-design power) + * Return: true if the CPU has configurable TDP (Thermal-design power) */ bool cpu_config_tdp_levels(void); @@ -95,7 +95,7 @@ enum burst_mode_t { * Bit 38 - TURBO_MODE_DISABLE Bit to get state ENABLED / DISABLED. * Also checks cpuid 0x6 to see whether burst mode is supported. * - * @return current burst mode status + * Return: current burst mode status */ enum burst_mode_t cpu_get_burst_mode_state(void); @@ -134,14 +134,14 @@ void cpu_set_p_state_to_turbo_ratio(void); * * See ACPI spec v6.3 section 8.4.6.5 _PSD (P-State Dependency) * - * @return HW_ALL (always) + * Return: HW_ALL (always) */ int cpu_get_coord_type(void); /** * cpu_get_min_ratio() - get minimum support frequency ratio for CPU * - * @return minimum ratio + * Return: minimum ratio */ int cpu_get_min_ratio(void); @@ -151,7 +151,7 @@ int cpu_get_min_ratio(void); * If a nominal TDP ratio is available, it is returned. Otherwise this returns * the maximum non-turbo frequency ratio for this processor * - * @return max ratio + * Return: max ratio */ int cpu_get_max_ratio(void); @@ -160,28 +160,28 @@ int cpu_get_max_ratio(void); * * This is the value the clock ratio is multiplied with * - * @return bus-block frequency in KHz + * Return: bus-block frequency in KHz */ int cpu_get_bus_clock_khz(void); /** * cpu_get_power_max() - Get maximum CPU TDP * - * @return maximum CPU TDP (Thermal-design power) in mW + * Return: maximum CPU TDP (Thermal-design power) in mW */ int cpu_get_power_max(void); /** * cpu_get_max_turbo_ratio() - Get maximum turbo ratio * - * @return maximum ratio + * Return: maximum ratio */ int cpu_get_max_turbo_ratio(void); /** * cpu_get_cores_per_package() - Get the number of CPU cores in each package * - * @return number of cores + * Return: number of cores */ int cpu_get_cores_per_package(void); diff --git a/arch/x86/include/asm/cpu_x86.h b/arch/x86/include/asm/cpu_x86.h index 4fd5f03fdc..7d04977996 100644 --- a/arch/x86/include/asm/cpu_x86.h +++ b/arch/x86/include/asm/cpu_x86.h @@ -13,7 +13,7 @@ * like the processor local apic id. * * @dev: Device to check (UCLASS_CPU) - * @return 0 always + * Return: 0 always */ int cpu_x86_bind(struct udevice *dev); diff --git a/arch/x86/include/asm/e820.h b/arch/x86/include/asm/e820.h index 850a0a7a89..1ab709abfc 100644 --- a/arch/x86/include/asm/e820.h +++ b/arch/x86/include/asm/e820.h @@ -34,7 +34,7 @@ unsigned int install_e820_map(unsigned int max_entries, * * @max_entries: Maximum number of entries to write * @entries: Place to put entires - * @return number of entries written + * Return: number of entries written */ unsigned int cb_install_e820_map(unsigned int max_entries, struct e820_entry *entries); diff --git a/arch/x86/include/asm/fast_spi.h b/arch/x86/include/asm/fast_spi.h index 82e3d8f63e..998847b82c 100644 --- a/arch/x86/include/asm/fast_spi.h +++ b/arch/x86/include/asm/fast_spi.h @@ -61,7 +61,7 @@ check_member(fast_spi_regs, ptdata, 0xd0); * @map_sizep: Returns size of mapped SPI * @offsetp: Returns start offset of SPI flash where the map works * correctly (offsets before this are not visible) - * @return 0 (always) + * Return: 0 (always) */ int fast_spi_get_bios_mmap(pci_dev_t pdev, ulong *map_basep, uint *map_sizep, uint *offsetp); @@ -74,7 +74,7 @@ int fast_spi_get_bios_mmap(pci_dev_t pdev, ulong *map_basep, uint *map_sizep, * @map_sizep: Returns size of mapped SPI * @offsetp: Returns start offset of SPI flash where the map works * correctly (offsets before this are not visible) - * @return 0 (always) + * Return: 0 (always) */ int fast_spi_get_bios_mmap_regs(struct fast_spi_regs *regs, ulong *map_basep, uint *map_sizep, uint *offsetp); diff --git a/arch/x86/include/asm/fsp/fsp_support.h b/arch/x86/include/asm/fsp/fsp_support.h index 3cd3e4fcf5..68331ebf6d 100644 --- a/arch/x86/include/asm/fsp/fsp_support.h +++ b/arch/x86/include/asm/fsp/fsp_support.h @@ -23,7 +23,7 @@ /** * fsp_find_header() - Find FSP header offset in FSP image * - * @return the offset of FSP header. If signature is invalid, returns 0. + * Return: the offset of FSP header. If signature is invalid, returns 0. */ struct fsp_header *fsp_find_header(void); @@ -33,7 +33,7 @@ struct fsp_header *fsp_find_header(void); * @fsp_hdr: Pointer to FSP information header * @phase: FSP initialization phase defined in enum fsp_phase * - * @return compatible status code with EFI_STATUS defined in PI spec + * Return: compatible status code with EFI_STATUS defined in PI spec */ u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase); @@ -42,7 +42,7 @@ u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase); * * @hob_list: A HOB list pointer. * - * @return Usable low memory top. + * Return: Usable low memory top. */ u32 fsp_get_usable_lowmem_top(const void *hob_list); @@ -51,7 +51,7 @@ u32 fsp_get_usable_lowmem_top(const void *hob_list); * * @hob_list: A HOB list pointer. * - * @return Usable high memory top. + * Return: Usable high memory top. */ u64 fsp_get_usable_highmem_top(const void *hob_list); @@ -63,7 +63,7 @@ u64 fsp_get_usable_highmem_top(const void *hob_list); * If the GUID HOB is located, the length will be updated. * @guid: A pointer to the owner guild. * - * @return Reserved region start address. + * Return: Reserved region start address. * 0 if this region does not exist. */ u64 fsp_get_reserved_mem_from_guid(const void *hob_list, @@ -75,7 +75,7 @@ u64 fsp_get_reserved_mem_from_guid(const void *hob_list, * @hob_list: A HOB list pointer. * @len: A pointer to the FSP reserved memory length buffer. * If the GUID HOB is located, the length will be updated. - * @return FSP reserved memory base + * Return: FSP reserved memory base * 0 if this region does not exist. */ u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len); @@ -87,8 +87,8 @@ u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len); * @len: A pointer to the TSEG reserved memory length buffer. * If the GUID HOB is located, the length will be updated. * - * @return NULL: Failed to find the TSEG reserved memory. - * @return others: TSEG reserved memory base. + * Return: NULL: Failed to find the TSEG reserved memory. + * Return: others: TSEG reserved memory base. */ u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len); @@ -99,8 +99,8 @@ u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len); * @len: A pointer to the NVS data buffer length. * If the HOB is located, the length will be updated. * - * @return NULL: Failed to find the NVS HOB. - * @return others: FSP NVS data buffer pointer. + * Return: NULL: Failed to find the NVS HOB. + * Return: others: FSP NVS data buffer pointer. */ void *fsp_get_nvs_data(const void *hob_list, u32 *len); @@ -111,8 +111,8 @@ void *fsp_get_nvs_data(const void *hob_list, u32 *len); * @len: A pointer to the NVS data buffer length. * If the HOB is located, the length will be updated. * - * @return NULL: Failed to find the NVS HOB. - * @return others: FSP NVS data buffer pointer. + * Return: NULL: Failed to find the NVS HOB. + * Return: others: FSP NVS data buffer pointer. */ void *fsp_get_var_nvs_data(const void *hob_list, u32 *len); @@ -123,15 +123,15 @@ void *fsp_get_var_nvs_data(const void *hob_list, u32 *len); * @len: A pointer to the graphics info HOB length. * If the HOB is located, the length will be updated. * - * @return NULL: Failed to find the graphics info HOB. - * @return others: A pointer to struct hob_graphics_info. + * Return: NULL: Failed to find the graphics info HOB. + * Return: others: A pointer to struct hob_graphics_info. */ void *fsp_get_graphics_info(const void *hob_list, u32 *len); /** * fsp_init_phase_pci() - Tell the FSP that we have completed PCI init * - * @return 0 if OK, -EPERM if the FSP gave an error. + * Return: 0 if OK, -EPERM if the FSP gave an error. */ int fsp_init_phase_pci(void); @@ -140,7 +140,7 @@ int fsp_init_phase_pci(void); * * This sets gd->ram_size based on what it finds. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fsp_scan_for_ram_size(void); @@ -150,7 +150,7 @@ int fsp_scan_for_ram_size(void); * @fsp_hdr: Pointer to FSP information header * @phase: FSP initialization phase defined in enum fsp_phase * - * @return compatible status code with EFI_STATUS defined in PI spec + * Return: compatible status code with EFI_STATUS defined in PI spec */ u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase); diff --git a/arch/x86/include/asm/fsp1/fsp_support.h b/arch/x86/include/asm/fsp1/fsp_support.h index a44a5504a4..b5d0f6dfa7 100644 --- a/arch/x86/include/asm/fsp1/fsp_support.h +++ b/arch/x86/include/asm/fsp1/fsp_support.h @@ -33,7 +33,7 @@ void fsp_init_done(void *hob_list); * @status: Always 0 * @hob_list: HOB list pointer * - * @return Never returns + * Return: Never returns */ void fsp_continue(u32 status, void *hob_list); @@ -53,8 +53,8 @@ void fsp_init(u32 stack_top, u32 boot_mode, void *nvs_buf); * @len: A pointer to the bootloader temporary stack length. * If the HOB is located, the length will be updated. * - * @return NULL: Failed to find the bootloader temporary stack HOB. - * @return others: Bootloader temporary stackbuffer pointer. + * Return: NULL: Failed to find the bootloader temporary stack HOB. + * Return: others: Bootloader temporary stackbuffer pointer. */ void *fsp_get_bootloader_tmp_mem(const void *hob_list, u32 *len); @@ -64,7 +64,7 @@ void *fsp_get_bootloader_tmp_mem(const void *hob_list, u32 *len); * @config: A pointer to the FSP configuration data structure * @rt_buf: A pointer to the FSP runtime buffer data structure * - * @return None + * Return: None */ void fsp_update_configs(struct fsp_config_data *config, struct fspinit_rtbuf *rt_buf); diff --git a/arch/x86/include/asm/fsp2/fsp_api.h b/arch/x86/include/asm/fsp2/fsp_api.h index af1e8857b9..dccbfa45a1 100644 --- a/arch/x86/include/asm/fsp2/fsp_api.h +++ b/arch/x86/include/asm/fsp2/fsp_api.h @@ -38,7 +38,7 @@ struct __packed fsp_upd_header { * from scatch since we will lose its contents * @use_spi_flash: true to use the fast SPI driver to read FSP, otherwise use * mapped SPI - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fsp_memory_init(bool s3wake, bool use_spi_flash); @@ -54,7 +54,7 @@ typedef asmlinkage int (*fsp_memory_init_func)(struct fspm_upd *params, * from scatch since we will lose its contents * @use_spi_flash: true to use the fast SPI driver to read FSP, otherwise use * mapped SPI - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fsp_silicon_init(bool s3wake, bool use_spi_flash); diff --git a/arch/x86/include/asm/fsp2/fsp_internal.h b/arch/x86/include/asm/fsp2/fsp_internal.h index b4a4fbbd84..836660d59d 100644 --- a/arch/x86/include/asm/fsp2/fsp_internal.h +++ b/arch/x86/include/asm/fsp2/fsp_internal.h @@ -57,7 +57,7 @@ int arch_fsps_preinit(void); * * @dev: Hostbridge device containing config * @upd: Config data to fill in - * @return 0 if OK, -ENOENT if OK but no MRC-cache data was found, other -ve on + * Return: 0 if OK, -ENOENT if OK but no MRC-cache data was found, other -ve on * error */ int fspm_update_config(struct udevice *dev, struct fspm_upd *upd); @@ -69,7 +69,7 @@ int fspm_update_config(struct udevice *dev, struct fspm_upd *upd); * continue. * * @dev: Hostbridge device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fspm_done(struct udevice *dev); @@ -79,7 +79,7 @@ int fspm_done(struct udevice *dev); * @dev: Hostbridge device containing config * @rom_offset: Value to add to convert from ROM offset to memory-mapped address * @upd: Config data to fill in - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fsps_update_config(struct udevice *dev, ulong rom_offset, struct fsps_upd *upd); @@ -90,7 +90,7 @@ int fsps_update_config(struct udevice *dev, ulong rom_offset, * This looks for cached Memory-reference code (MRC) data and stores it into * @upd for use by the FSP-M binary. * - * @return 0 if OK, -ENOENT if no data (whereupon the caller can continue and + * Return: 0 if OK, -ENOENT if no data (whereupon the caller can continue and * expect a slower boot), other -ve value on other error */ int prepare_mrc_cache(struct fspm_upd *upd); diff --git a/arch/x86/include/asm/hob.h b/arch/x86/include/asm/hob.h index 2f5b6e24c2..224bc08c43 100644 --- a/arch/x86/include/asm/hob.h +++ b/arch/x86/include/asm/hob.h @@ -135,7 +135,7 @@ struct hob_guid { * * @hdr: A pointer to a HOB. * - * @return A pointer to the next HOB in the HOB list. + * Return: A pointer to the next HOB in the HOB list. */ static inline const struct hob_header *get_next_hob(const struct hob_header *hdr) @@ -152,8 +152,8 @@ static inline const struct hob_header *get_next_hob(const struct hob_header * * @hdr: A pointer to a HOB. * - * @return true: The HOB specified by hdr is the last HOB in the HOB list. - * @return false: The HOB specified by hdr is not the last HOB in the HOB list. + * Return: true: The HOB specified by hdr is the last HOB in the HOB list. + * Return: false: The HOB specified by hdr is not the last HOB in the HOB list. */ static inline bool end_of_hob(const struct hob_header *hdr) { @@ -169,7 +169,7 @@ static inline bool end_of_hob(const struct hob_header *hdr) * * @hdr: A pointer to a HOB. * - * @return A pointer to the data buffer in a HOB. + * Return: A pointer to the data buffer in a HOB. */ static inline void *get_guid_hob_data(const struct hob_header *hdr) { @@ -185,7 +185,7 @@ static inline void *get_guid_hob_data(const struct hob_header *hdr) * * @hdr: A pointer to a HOB. * - * @return The size of the data buffer. + * Return: The size of the data buffer. */ static inline u16 get_guid_hob_data_size(const struct hob_header *hdr) { @@ -198,7 +198,7 @@ static inline u16 get_guid_hob_data_size(const struct hob_header *hdr) * @type: HOB type to search * @hob_list: A pointer to the HOB list * - * @return A HOB object with matching type; Otherwise NULL. + * Return: A HOB object with matching type; Otherwise NULL. */ const struct hob_header *hob_get_next_hob(uint type, const void *hob_list); @@ -208,7 +208,7 @@ const struct hob_header *hob_get_next_hob(uint type, const void *hob_list); * @guid: GUID to search * @hob_list: A pointer to the HOB list * - * @return A HOB object with matching GUID; Otherwise NULL. + * Return: A HOB object with matching GUID; Otherwise NULL. */ const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, const void *hob_list); @@ -221,8 +221,8 @@ const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, * If the GUID HOB is located, the length will be updated. * @guid A pointer to HOB GUID. * - * @return NULL: Failed to find the GUID HOB. - * @return others: GUID HOB data buffer pointer. + * Return: NULL: Failed to find the GUID HOB. + * Return: others: GUID HOB data buffer pointer. */ void *hob_get_guid_hob_data(const void *hob_list, u32 *len, const efi_guid_t *guid); diff --git a/arch/x86/include/asm/i8254.h b/arch/x86/include/asm/i8254.h index 4069b9a2b8..0b999a1d31 100644 --- a/arch/x86/include/asm/i8254.h +++ b/arch/x86/include/asm/i8254.h @@ -42,7 +42,7 @@ * after a delay with i8254_disable_beep(). * * @frequency_hz: Frequency of beep in Hz - * @return 0 if OK, -EINVAL if frequency_hz is 0 + * Return: 0 if OK, -EINVAL if frequency_hz is 0 */ int i8254_enable_beep(uint frequency_hz); diff --git a/arch/x86/include/asm/intel_acpi.h b/arch/x86/include/asm/intel_acpi.h index a5781f1af4..c1f5048ce6 100644 --- a/arch/x86/include/asm/intel_acpi.h +++ b/arch/x86/include/asm/intel_acpi.h @@ -22,7 +22,7 @@ struct udevice; * @core_id: CPU core number, as numbered by the SoC * @c_state_map: Information about each C state * @num_cstates: Number of entries in @c_state_map - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_generate_cpu_header(struct acpi_ctx *ctx, int core_id, const struct acpi_cstate *c_state_map, diff --git a/arch/x86/include/asm/intel_opregion.h b/arch/x86/include/asm/intel_opregion.h index fb3e38617e..182398a7db 100644 --- a/arch/x86/include/asm/intel_opregion.h +++ b/arch/x86/include/asm/intel_opregion.h @@ -239,7 +239,7 @@ struct __packed optionrom_vbt { * * This is called from ACPI code and OS drivers * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int intel_gma_init_igd_opregion(struct udevice *dev, struct igd_opregion *opregion); diff --git a/arch/x86/include/asm/intel_pinctrl.h b/arch/x86/include/asm/intel_pinctrl.h index 44eedc205c..b0ff470568 100644 --- a/arch/x86/include/asm/intel_pinctrl.h +++ b/arch/x86/include/asm/intel_pinctrl.h @@ -167,7 +167,7 @@ int intel_pinctrl_probe(struct udevice *dev); * @dev: Pinctrl device * @comm: Pad community for this device * @num_cfgs: Number of configuration words for each pad - * @return 0 if OK, -EDOM if @comm is NULL, other -ve value on other error + * Return: 0 if OK, -EDOM if @comm is NULL, other -ve value on other error */ int intel_pinctrl_of_to_plat(struct udevice *dev, const struct pad_community *comm, int num_cfgs); @@ -185,7 +185,7 @@ int intel_pinctrl_of_to_plat(struct udevice *dev, * @gpe0b: Value for GPE0B * @gpe0c: Value for GPE0C * @gpe0d: Value for GPE0D - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pinctrl_route_gpe(struct udevice *dev, uint gpe0b, uint gpe0c, uint gpe0d); @@ -198,7 +198,7 @@ int pinctrl_route_gpe(struct udevice *dev, uint gpe0b, uint gpe0c, uint gpe0d); * @pads: Pad data, consisting of a pad number followed by num_cfgs entries * containing the data for that pad (num_cfgs is set by the pinctrl device) * @pads_count: Number of pads to configure - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pinctrl_config_pads(struct udevice *dev, u32 *pads, int pads_count); @@ -207,7 +207,7 @@ int pinctrl_config_pads(struct udevice *dev, u32 *pads, int pads_count); * * This enables the interrupt inputs and clears the status register bits * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pinctrl_gpi_clear_int_cfg(void); @@ -218,7 +218,7 @@ int pinctrl_gpi_clear_int_cfg(void); * * @dev: pinctrl device (any will do) * @node: Node containing the 'pads' property with the data in it - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pinctrl_config_pads_for_node(struct udevice *dev, ofnode node); @@ -255,7 +255,7 @@ int pinctrl_read_pads(struct udevice *dev, ofnode node, const char *prop, * @dev: pinctrl device (any will do) * @pads: Array of pad data * @size: Size of pad data in bytes - * @return number of pads represented by the data + * Return: number of pads represented by the data */ int pinctrl_count_pads(struct udevice *dev, u32 *pads, int size); @@ -266,7 +266,7 @@ int pinctrl_count_pads(struct udevice *dev, u32 *pads, int size); * * @dev: Pinctrl device * @offset: GPIO offset within this device - * @return register offset of first register within the GPIO p2sb region + * Return: register offset of first register within the GPIO p2sb region */ u32 intel_pinctrl_get_config_reg_offset(struct udevice *dev, uint offset); @@ -276,7 +276,7 @@ u32 intel_pinctrl_get_config_reg_offset(struct udevice *dev, uint offset); * This works out the absolute address of the registers for a pin * @dev: Pinctrl device * @offset: GPIO offset within this device - * @return register address of first register within the GPIO p2sb region + * Return: register address of first register within the GPIO p2sb region */ u32 intel_pinctrl_get_config_reg_addr(struct udevice *dev, uint offset); @@ -285,7 +285,7 @@ u32 intel_pinctrl_get_config_reg_addr(struct udevice *dev, uint offset); * * @dev: Pinctrl device * @offset: GPIO offset within this device - * @return register value within the GPIO p2sb region + * Return: register value within the GPIO p2sb region */ u32 intel_pinctrl_get_config_reg(struct udevice *dev, uint offset); @@ -297,7 +297,7 @@ u32 intel_pinctrl_get_config_reg(struct udevice *dev, uint offset); * @pad: Pad to check * @devp: Returns pinctrl device containing that pad * @offsetp: Returns offset of pad within that pinctrl device - * @return 0 if OK, -ENOTBLK if pad number is invalid + * Return: 0 if OK, -ENOTBLK if pad number is invalid */ int intel_pinctrl_get_pad(uint pad, struct udevice **devp, uint *offsetp); @@ -309,7 +309,7 @@ int intel_pinctrl_get_pad(uint pad, struct udevice **devp, uint *offsetp); * * @dev: Pinctrl device to check * @offset: Offset of pin within that device (0 = first) - * @return associated ACPI GPIO pin-table entry, or standard pin number if the + * Return: associated ACPI GPIO pin-table entry, or standard pin number if the * ACPI pad base is not set */ int intel_pinctrl_get_acpi_pin(struct udevice *dev, uint offset); diff --git a/arch/x86/include/asm/lpc_common.h b/arch/x86/include/asm/lpc_common.h index d462c2ec61..aa3ac626b4 100644 --- a/arch/x86/include/asm/lpc_common.h +++ b/arch/x86/include/asm/lpc_common.h @@ -49,7 +49,7 @@ * also puts the RCB in the correct place so that RCB_REG() works. * * @dev: LPC device (a child of the PCH) - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int lpc_common_early_init(struct udevice *dev); diff --git a/arch/x86/include/asm/me_common.h b/arch/x86/include/asm/me_common.h index 49d88623ed..8570368314 100644 --- a/arch/x86/include/asm/me_common.h +++ b/arch/x86/include/asm/me_common.h @@ -325,7 +325,7 @@ void intel_me_status(struct udevice *me_dev); * intel_early_me_init() - Early Intel Management Engine init * * @me_dev: Management engine PCI device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int intel_early_me_init(struct udevice *me_dev); @@ -333,7 +333,7 @@ int intel_early_me_init(struct udevice *me_dev); * intel_early_me_uma_size() - Get UMA size from the Intel Management Engine * * @me_dev: Management engine PCI device - * @return UMA size if OK, -EINVAL on error + * Return: UMA size if OK, -EINVAL on error */ int intel_early_me_uma_size(struct udevice *me_dev); @@ -343,7 +343,7 @@ int intel_early_me_uma_size(struct udevice *me_dev); * @dev: Northbridge device * @me_dev: Management engine PCI device * @status: Status result (ME_INIT_...) - * @return 0 to continue to boot, -EINVAL on unknown result data, -ETIMEDOUT + * Return: 0 to continue to boot, -EINVAL on unknown result data, -ETIMEDOUT * if ME did not respond */ int intel_early_me_init_done(struct udevice *dev, struct udevice *me_dev, diff --git a/arch/x86/include/asm/microcode.h b/arch/x86/include/asm/microcode.h index 4ab7504931..09652b95a3 100644 --- a/arch/x86/include/asm/microcode.h +++ b/arch/x86/include/asm/microcode.h @@ -17,7 +17,7 @@ extern u32 ucode_size; * * Applies any microcode updates in the device tree. * - * @return 0 if OK, -EEXIST if the updates were already applied, -ENOENT if + * Return: 0 if OK, -EEXIST if the updates were already applied, -ENOENT if * not updates were found, -EINVAL if an update was invalid */ int microcode_update_intel(void); @@ -27,7 +27,7 @@ int microcode_update_intel(void); * * This reads the microcode version of the currently running CPU * - * @return microcode version number + * Return: microcode version number */ int microcode_read_rev(void); #endif /* __ASSEMBLY__ */ diff --git a/arch/x86/include/asm/mp.h b/arch/x86/include/asm/mp.h index e48ba051d9..f4c4d6c257 100644 --- a/arch/x86/include/asm/mp.h +++ b/arch/x86/include/asm/mp.h @@ -124,7 +124,7 @@ typedef void (*mp_run_func)(void *arg); * all, or MP_SELECT_BSP for BSP * @func: Function to run * @arg: Argument to pass to the function - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int mp_run_on_cpus(int cpu_select, mp_run_func func, void *arg); @@ -133,7 +133,7 @@ int mp_run_on_cpus(int cpu_select, mp_run_func func, void *arg); * * This halts all CPUs except the main one, ready for the OS to use them * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mp_park_aps(void); @@ -145,7 +145,7 @@ int mp_park_aps(void); * -EFBIG. * * @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...) - * @return next CPU number to run on (e.g. 0) + * Return: next CPU number to run on (e.g. 0) */ int mp_first_cpu(int cpu_select); @@ -160,7 +160,7 @@ int mp_first_cpu(int cpu_select); * * @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...) * @prev_cpu: Previous value returned by mp_first_cpu()/mp_next_cpu() - * @return next CPU number to run on (e.g. 0) + * Return: next CPU number to run on (e.g. 0) */ int mp_next_cpu(int cpu_select, int prev_cpu); #else diff --git a/arch/x86/include/asm/mrc_common.h b/arch/x86/include/asm/mrc_common.h index d4e56bf37c..3d7f00c9f9 100644 --- a/arch/x86/include/asm/mrc_common.h +++ b/arch/x86/include/asm/mrc_common.h @@ -17,7 +17,7 @@ * @pei_data: Platform-specific data required by the MRC * @use_asm_linkage: true if the call to MRC requires asmlinkage, false if it * uses normal U-Boot calling - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mrc_common_init(struct udevice *dev, void *pei_data, bool use_asm_linkage); diff --git a/arch/x86/include/asm/mrccache.h b/arch/x86/include/asm/mrccache.h index 8b104a2f0b..8ed6e0e9d6 100644 --- a/arch/x86/include/asm/mrccache.h +++ b/arch/x86/include/asm/mrccache.h @@ -46,7 +46,7 @@ struct udevice; * for setting up SDRAM * * @entry: Position and size of MRC cache in SPI flash - * @return pointer to latest record, or NULL if none + * Return: pointer to latest record, or NULL if none */ struct mrc_data_container *mrccache_find_current(struct mrc_region *entry); @@ -60,7 +60,7 @@ struct mrc_data_container *mrccache_find_current(struct mrc_region *entry); * This routine should be called by reserve_arch() before U-Boot is relocated * when MRC cache is enabled. * - * @return 0 always + * Return: 0 always */ int mrccache_reserve(void); @@ -75,7 +75,7 @@ int mrccache_reserve(void); * @type: Type of MRC data to use * @devp: Returns pointer to the SPI flash device, if found * @entry: Position and size of MRC cache in SPI flash - * @return 0 if success, -ENOENT if SPI flash node does not exist in the + * Return: 0 if success, -ENOENT if SPI flash node does not exist in the * device tree, -EPERM if MRC region subnode does not exist in the device * tree, -EINVAL if MRC region properties format is incorrect, other error * if SPI flash probe failed. @@ -89,7 +89,7 @@ int mrccache_get_region(enum mrc_type_t type, struct udevice **devp, * This saves MRC data stored previously by gd->arch.mrc_output to a proper * place within the MRC region on the SPI flash. * - * @return 0 if saved to SPI flash successfully, other error if failed + * Return: 0 if saved to SPI flash successfully, other error if failed */ int mrccache_save(void); @@ -100,7 +100,7 @@ int mrccache_save(void); * data in SPL to avoid needing to pass it up to U-Boot proper to save. This * function handles that. * - * @return 0 if saved to SPI flash successfully, other error if failed + * Return: 0 if saved to SPI flash successfully, other error if failed */ int mrccache_spl_save(void); diff --git a/arch/x86/include/asm/mtrr.h b/arch/x86/include/asm/mtrr.h index d1aa86bf1d..ca2edc7878 100644 --- a/arch/x86/include/asm/mtrr.h +++ b/arch/x86/include/asm/mtrr.h @@ -145,7 +145,7 @@ int mtrr_commit(bool do_caches); * @type: Requested type (MTRR_TYPE_) * @start: Start address * @size: Size, must be power of 2 - * @return 0 on success, -EINVAL if size is not power of 2, + * Return: 0 on success, -EINVAL if size is not power of 2, * -ENOSPC if there are no more MTRRs */ int mtrr_set_next_var(uint type, uint64_t base, uint64_t size); @@ -166,7 +166,7 @@ void mtrr_read_all(struct mtrr_info *info); * @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...) * @reg: MTRR register to write (0-7) * @valid: Valid flag to write - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int mtrr_set_valid(int cpu_select, int reg, bool valid); @@ -177,7 +177,7 @@ int mtrr_set_valid(int cpu_select, int reg, bool valid); * @reg: MTRR register to write (0-7) * @base: Base address and MTRR_BASE_TYPE_MASK * @mask: Mask and MTRR_PHYS_MASK_VALID - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int mtrr_set(int cpu_select, int reg, u64 base, u64 mask); @@ -186,7 +186,7 @@ int mtrr_set(int cpu_select, int reg, u64 base, u64 mask); * * Some CPUs have more than 8 MTRRs. This function returns the actual number * - * @return number of variable MTRRs + * Return: number of variable MTRRs */ int mtrr_get_var_count(void); diff --git a/arch/x86/include/asm/pch_common.h b/arch/x86/include/asm/pch_common.h index c4614d3f42..5b8d19ff61 100644 --- a/arch/x86/include/asm/pch_common.h +++ b/arch/x86/include/asm/pch_common.h @@ -39,7 +39,7 @@ * * @dev: SATA device * @idx: Register index to read - * @return value read from register + * Return: value read from register */ u32 pch_common_sir_read(struct udevice *dev, int idx); diff --git a/arch/x86/include/asm/pci.h b/arch/x86/include/asm/pci.h index 2a72073572..1c30b32d46 100644 --- a/arch/x86/include/asm/pci.h +++ b/arch/x86/include/asm/pci.h @@ -26,7 +26,7 @@ * @offset: Register offset to read * @valuep: Place to put the returned value * @size: Access size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_x86_read_config(pci_dev_t bdf, uint offset, ulong *valuep, enum pci_size_t size); @@ -40,7 +40,7 @@ int pci_x86_read_config(pci_dev_t bdf, uint offset, ulong *valuep, * @offset: Register offset to write * @value: Value to write * @size: Access size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_x86_write_config(pci_dev_t bdf, uint offset, ulong value, enum pci_size_t size); @@ -55,7 +55,7 @@ int pci_x86_write_config(pci_dev_t bdf, uint offset, ulong value, * @offset: Register offset to update * @clr: Bits to clear * @set: Bits to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_x86_clrset_config(pci_dev_t bdf, uint offset, ulong clr, ulong set, enum pci_size_t size); diff --git a/arch/x86/include/asm/sfi.h b/arch/x86/include/asm/sfi.h index 09d4700812..10bd1c56a3 100644 --- a/arch/x86/include/asm/sfi.h +++ b/arch/x86/include/asm/sfi.h @@ -148,7 +148,7 @@ typedef int (*sfi_table_handler) (struct sfi_table_header *table); * write_sfi_table() - Write Simple Firmware Interface tables * * @base: Address to write table to - * @return address to use for the next table + * Return: address to use for the next table */ ulong write_sfi_table(ulong base); diff --git a/arch/x86/include/asm/tables.h b/arch/x86/include/asm/tables.h index bf66e79018..aa938837b6 100644 --- a/arch/x86/include/asm/tables.h +++ b/arch/x86/include/asm/tables.h @@ -50,7 +50,7 @@ void table_fill_string(char *dest, const char *src, size_t n, char pad); * Multi-Processor table and ACPI table. Whether a specific type of * configuration table is written is controlled by a Kconfig option. * - * @return 0 if OK, -ENOSPC if table too large + * Return: 0 if OK, -ENOSPC if table too large */ int write_tables(void); diff --git a/arch/x86/include/asm/u-boot-x86.h b/arch/x86/include/asm/u-boot-x86.h index d732661f6d..a1655e1cea 100644 --- a/arch/x86/include/asm/u-boot-x86.h +++ b/arch/x86/include/asm/u-boot-x86.h @@ -30,7 +30,7 @@ int x86_cpu_init_f(void); * identify so that CPU functions can be used correctly, but does not change * anything. * - * @return 0 (indicating success, to mimic cpu_init_f()) + * Return: 0 (indicating success, to mimic cpu_init_f()) */ int x86_cpu_reinit_f(void); @@ -39,7 +39,7 @@ int x86_cpu_reinit_f(void); * * This just sets up the CPU features and figured out the identity * - * @return 0 (indicating success, to mimic cpu_init_f()) + * Return: 0 (indicating success, to mimic cpu_init_f()) */ int x86_cpu_init_tpl(void); diff --git a/arch/x86/include/asm/zimage.h b/arch/x86/include/asm/zimage.h index fa6e7f76e0..000b38ea89 100644 --- a/arch/x86/include/asm/zimage.h +++ b/arch/x86/include/asm/zimage.h @@ -39,7 +39,7 @@ * @kernel_size: Size of kernel including setup block (or 0 if the kernel is * new enough to have a 'syssize' value) * @load_addressp: Returns the address where the kernel has been loaded - * @return address of setup block, or NULL if something went wrong + * Return: address of setup block, or NULL if something went wrong */ struct boot_params *load_zimage(char *image, unsigned long kernel_size, ulong *load_addressp); @@ -57,7 +57,7 @@ struct boot_params *load_zimage(char *image, unsigned long kernel_size, * BZIMAGE_LOAD_ADDR or ZIMAGE_LOAD_ADDR * @cmdline_force: Address of 'override' command line, or 0 to use the one in * the * setup block - * @return 0 (always) + * Return: 0 (always) */ int setup_zimage(struct boot_params *setup_base, char *cmd_line, int auto_boot, ulong initrd_addr, ulong initrd_size, ulong cmdline_force); diff --git a/arch/x86/lib/hob.c b/arch/x86/lib/hob.c index f2c47240ee..b35248e5fd 100644 --- a/arch/x86/lib/hob.c +++ b/arch/x86/lib/hob.c @@ -13,7 +13,7 @@ * @type: HOB type to search * @hob_list: A pointer to the HOB list * - * @return A HOB object with matching type; Otherwise NULL. + * Return: A HOB object with matching type; Otherwise NULL. */ const struct hob_header *hob_get_next_hob(uint type, const void *hob_list) { @@ -38,7 +38,7 @@ const struct hob_header *hob_get_next_hob(uint type, const void *hob_list) * @guid: GUID to search * @hob_list: A pointer to the HOB list * - * @return A HOB object with matching GUID; Otherwise NULL. + * Return: A HOB object with matching GUID; Otherwise NULL. */ const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, const void *hob_list) @@ -65,8 +65,8 @@ const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid, * If the GUID HOB is located, the length will be updated. * @guid A pointer to HOB GUID. * - * @return NULL: Failed to find the GUID HOB. - * @return others: GUID HOB data buffer pointer. + * Return: NULL: Failed to find the GUID HOB. + * Return: others: GUID HOB data buffer pointer. */ void *hob_get_guid_hob_data(const void *hob_list, u32 *len, const efi_guid_t *guid) diff --git a/arch/x86/lib/mrccache.c b/arch/x86/lib/mrccache.c index b526915680..38632e513f 100644 --- a/arch/x86/lib/mrccache.c +++ b/arch/x86/lib/mrccache.c @@ -93,7 +93,7 @@ struct mrc_data_container *mrccache_find_current(struct mrc_region *entry) * @data_size: Required data size of the new entry. Note that we assume that * all cache entries are the same size * - * @return next cache entry if found, NULL if we got to the end + * Return: next cache entry if found, NULL if we got to the end */ static struct mrc_data_container *find_next_mrc_cache(struct mrc_region *entry, struct mrc_data_container *prev, int data_size) @@ -130,7 +130,7 @@ static struct mrc_data_container *find_next_mrc_cache(struct mrc_region *entry, * @sf: SPI flash to write to * @entry: Position and size of MRC cache in SPI flash * @cur: Record to write - * @return 0 if updated, -EEXIST if the record is the same as the latest + * Return: 0 if updated, -EEXIST if the record is the same as the latest * record, -EINVAL if the record is not valid, other error if SPI write failed */ static int mrccache_update(struct udevice *sf, struct mrc_region *entry, diff --git a/board/Marvell/octeontx/board-fdt.c b/board/Marvell/octeontx/board-fdt.c index e989c374f2..6642b167e1 100644 --- a/board/Marvell/octeontx/board-fdt.c +++ b/board/Marvell/octeontx/board-fdt.c @@ -299,7 +299,7 @@ int ft_board_setup(void *blob, struct bd_info *bd) /** * Return the FDT base address that was passed by ATF * - * @return FDT base address received from ATF in x1 register + * Return: FDT base address received from ATF in x1 register */ void *board_fdt_blob_setup(int *err) { diff --git a/board/Marvell/octeontx2/board-fdt.c b/board/Marvell/octeontx2/board-fdt.c index e2cfe017e8..04be9fb0a9 100644 --- a/board/Marvell/octeontx2/board-fdt.c +++ b/board/Marvell/octeontx2/board-fdt.c @@ -213,7 +213,7 @@ int ft_board_setup(void *blob, struct bd_info *bd) /** * Return the FDT base address that was passed by ATF * - * @return FDT base address received from ATF in x1 register + * Return: FDT base address received from ATF in x1 register */ void *board_fdt_blob_setup(int *err) { diff --git a/board/emulation/qemu-ppce500/qemu-ppce500.c b/board/emulation/qemu-ppce500/qemu-ppce500.c index 7d8ba34b25..348fcf3bb0 100644 --- a/board/emulation/qemu-ppce500/qemu-ppce500.c +++ b/board/emulation/qemu-ppce500/qemu-ppce500.c @@ -331,7 +331,7 @@ u32 cpu_mask(void) /** * Return the virtual address of FDT that was passed by QEMU * - * @return virtual address of FDT received from QEMU in r3 register + * Return: virtual address of FDT received from QEMU in r3 register */ void *board_fdt_blob_setup(int *err) { diff --git a/board/gdsys/a38x/hre.c b/board/gdsys/a38x/hre.c index de5411a6b9..2f16a4d3e1 100644 --- a/board/gdsys/a38x/hre.c +++ b/board/gdsys/a38x/hre.c @@ -98,7 +98,7 @@ static const uint8_t vendor[] = "Guntermann & Drunck"; * @param tpm TPM device * @param index NV index of the area to get size for * @param size pointer to the size - * @return 0 on success, != 0 on error + * Return: 0 on success, != 0 on error */ static int get_tpm_nv_size(struct udevice *tpm, uint32_t index, uint32_t *size) { @@ -135,7 +135,7 @@ static int get_tpm_nv_size(struct udevice *tpm, uint32_t index, uint32_t *size) * @param auth usage auth of the key to search for * @param pubkey_digest (SHA1) hash of the pub key structure of the key * @param[out] handle the handle of the key iff found - * @return 0 if key was found in TPM; != 0 if not. + * Return: 0 if key was found in TPM; != 0 if not. */ static int find_key(struct udevice *tpm, const uint8_t auth[20], const uint8_t pubkey_digest[20], uint32_t *handle) @@ -180,7 +180,7 @@ static int find_key(struct udevice *tpm, const uint8_t auth[20], /** * @brief read CCDM common data from TPM NV * @param tpm TPM device - * @return 0 if CCDM common data was found and read, !=0 if something failed. + * Return: 0 if CCDM common data was found and read, !=0 if something failed. */ static int read_common_data(struct udevice *tpm) { @@ -216,7 +216,7 @@ static int read_common_data(struct udevice *tpm) /** * @brief get pointer to hash register by specification * @param spec specification of a hash register - * @return pointer to hash register or NULL if @a spec does not qualify a + * Return: pointer to hash register or NULL if @a spec does not qualify a * valid hash register; NULL else. */ static struct h_reg *get_hreg(uint8_t spec) @@ -245,7 +245,7 @@ static struct h_reg *get_hreg(uint8_t spec) * @param tpm TPM device * @param spec specification of a hash register * @param mode access mode (read or write or read/write) - * @return pointer to hash register if found and valid; NULL else. + * Return: pointer to hash register if found and valid; NULL else. * * This func uses @a get_reg() to determine the hash register for a given spec. * If a register is found it is validated according to the desired access mode. @@ -372,7 +372,7 @@ static int hre_op_loadkey(struct udevice *tpm, struct h_reg *src_reg, * @param tpm TPM device * @param[in,out] ip pointer to the opcode (instruction pointer) * @param[in,out] code_size (remaining) size of the code - * @return new instruction pointer on success, NULL on error. + * Return: new instruction pointer on success, NULL on error. */ static const uint8_t *hre_execute_op(struct udevice *tpm, const uint8_t **ip, size_t *code_size) @@ -497,7 +497,7 @@ end: * @param tpm TPM device * @param code pointer to the (HRE) code. * @param code_size size of the code (in bytes). - * @return 0 on success, != 0 on failure. + * Return: 0 on success, != 0 on failure. */ int hre_run_program(struct udevice *tpm, const uint8_t *code, size_t code_size) { diff --git a/board/google/chromebook_coral/coral.c b/board/google/chromebook_coral/coral.c index 53c5171d02..182cf7517a 100644 --- a/board/google/chromebook_coral/coral.c +++ b/board/google/chromebook_coral/coral.c @@ -98,7 +98,7 @@ static int get_memconfig(struct udevice *dev) * EC - reading from the EC (backup) * * @dev: sysinfo device to use - * @return SKU ID, or -ve error if not found + * Return: SKU ID, or -ve error if not found */ static int get_skuconfig(struct udevice *dev) { diff --git a/board/ti/dra7xx/evm.c b/board/ti/dra7xx/evm.c index 23e8005991..a854d615c1 100644 --- a/board/ti/dra7xx/evm.c +++ b/board/ti/dra7xx/evm.c @@ -628,7 +628,7 @@ int get_voltrail_opp(int rail_offset) /** * @brief board_init * - * @return 0 + * Return: 0 */ int board_init(void) { diff --git a/board/ti/omap5_uevm/evm.c b/board/ti/omap5_uevm/evm.c index 4777622156..929668ebaa 100644 --- a/board/ti/omap5_uevm/evm.c +++ b/board/ti/omap5_uevm/evm.c @@ -138,7 +138,7 @@ int usb_gadget_handle_interrupts(int index) /** * @brief board_init * - * @return 0 + * Return: 0 */ int board_init(void) { @@ -172,7 +172,7 @@ int board_eth_init(struct bd_info *bis) * such as power configurations, ethernet initialization as phase2 of * boot sequence * - * @return 0 + * Return: 0 */ int misc_init_r(void) { @@ -212,7 +212,7 @@ int board_mmc_init(struct bd_info *bis) * @brief board_usb_init - Configure EVM board specific configurations * for the LDO's and clocks for the USB blocks. * - * @return 0 + * Return: 0 */ int board_usb_init(int index, enum usb_init_type init) { diff --git a/board/ti/panda/panda.c b/board/ti/panda/panda.c index d8062997e5..2209318601 100644 --- a/board/ti/panda/panda.c +++ b/board/ti/panda/panda.c @@ -39,7 +39,7 @@ struct omap4_scrm_regs *const scrm = (struct omap4_scrm_regs *)0x4a30a000; /** * @brief board_init * - * @return 0 + * Return: 0 */ int board_init(void) { @@ -215,7 +215,7 @@ void emif_get_dmm_regs(const struct dmm_lisa_map_regs * such as power configurations, ethernet initialization as phase2 of * boot sequence * - * @return 0 + * Return: 0 */ int misc_init_r(void) { diff --git a/board/ti/sdp4430/sdp.c b/board/ti/sdp4430/sdp.c index 69726eb9ce..2c9ae794fd 100644 --- a/board/ti/sdp4430/sdp.c +++ b/board/ti/sdp4430/sdp.c @@ -25,7 +25,7 @@ const struct omap_sysinfo sysinfo = { /** * @brief board_init * - * @return 0 + * Return: 0 */ int board_init(void) { @@ -46,7 +46,7 @@ int board_eth_init(struct bd_info *bis) * such as power configurations, ethernet initialization as phase2 of * boot sequence * - * @return 0 + * Return: 0 */ int misc_init_r(void) { diff --git a/boot/android_ab.c b/boot/android_ab.c index 4943f26d53..2d7b392666 100644 --- a/boot/android_ab.c +++ b/boot/android_ab.c @@ -22,7 +22,7 @@ * * @param[in] abc bootloader control block * - * @return crc32 sum + * Return: crc32 sum */ static uint32_t ab_control_compute_crc(struct bootloader_control *abc) { @@ -38,7 +38,7 @@ static uint32_t ab_control_compute_crc(struct bootloader_control *abc) * * @param[in] abc bootloader control block * - * @return 0 on success and a negative on error + * Return: 0 on success and a negative on error */ static int ab_control_default(struct bootloader_control *abc) { @@ -81,7 +81,7 @@ static int ab_control_default(struct bootloader_control *abc) * @param[in] part_info Partition in 'dev_desc' where to read from, normally * the "misc" partition should be used * @param[out] pointer to pointer to bootloader_control data - * @return 0 on success and a negative on error + * Return: 0 on success and a negative on error */ static int ab_control_create_from_disk(struct blk_desc *dev_desc, const struct disk_partition *part_info, @@ -131,7 +131,7 @@ static int ab_control_create_from_disk(struct blk_desc *dev_desc, * @param[in] part_info Partition on the 'dev_desc' where to write * @param[in] abc Pointer to the boot control struct and the extra bytes after * it up to the nearest block boundary - * @return 0 on success and a negative on error + * Return: 0 on success and a negative on error */ static int ab_control_store(struct blk_desc *dev_desc, const struct disk_partition *part_info, @@ -160,7 +160,7 @@ static int ab_control_store(struct blk_desc *dev_desc, * * @param[in] a The first bootable slot metadata * @param[in] b The second bootable slot metadata - * @return Negative if the slot "a" is better, positive of the slot "b" is + * Return: Negative if the slot "a" is better, positive of the slot "b" is * better or 0 if they are equally good. */ static int ab_compare_slots(const struct slot_metadata *a, diff --git a/boot/bootm.c b/boot/bootm.c index 4482f84b40..00c00aef84 100644 --- a/boot/bootm.c +++ b/boot/bootm.c @@ -343,7 +343,7 @@ static int bootm_find_other(struct cmd_tbl *cmdtp, int flag, int argc, * @comp_type: Compression type being used (IH_COMP_...) * @uncomp_size: Number of bytes uncompressed * @ret: errno error code received from compression library - * @return Appropriate BOOTM_ERR_ error code + * Return: Appropriate BOOTM_ERR_ error code */ static int handle_decomp_error(int comp_type, size_t uncomp_size, int ret) { @@ -434,7 +434,7 @@ static int bootm_load_os(bootm_headers_t *images, int boot_progress) /** * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot * - * @return interrupt flag (0 if interrupts were disabled, non-zero if they were + * Return: interrupt flag (0 if interrupts were disabled, non-zero if they were * enabled) */ ulong bootm_disable_interrupts(void) @@ -481,7 +481,7 @@ ulong bootm_disable_interrupts(void) * * @buf: Buffer containing the string to process * @maxlen: Maximum length of buffer - * @return 0 if OK, -ENOSPC if @maxlen is too small + * Return: 0 if OK, -ENOSPC if @maxlen is too small */ static int fixup_silent_linux(char *buf, int maxlen) { @@ -551,7 +551,7 @@ static int fixup_silent_linux(char *buf, int maxlen) * * @buf: Buffer containing the string to process * @maxlen: Maximum length of buffer - * @return 0 if OK, -ENOSPC if @maxlen is too small + * Return: 0 if OK, -ENOSPC if @maxlen is too small */ static int process_subst(char *buf, int maxlen) { @@ -655,7 +655,7 @@ int bootm_process_cmdline_env(int flags) * @param states Mask containing states to run (BOOTM_STATE_...) * @param images Image header information * @param boot_progress 1 to show boot progress, 0 to not do this - * @return 0 if ok, something else on error. Some errors will cause this + * Return: 0 if ok, something else on error. Some errors will cause this * function to perform a reboot! If states contains BOOTM_STATE_OS_GO * then the intent is to boot an OS, so this function will not return * unless the image type is standalone. diff --git a/boot/fdt_region.c b/boot/fdt_region.c index bac5559329..295ea08ac9 100644 --- a/boot/fdt_region.c +++ b/boot/fdt_region.c @@ -231,7 +231,7 @@ static int region_list_contains_offset(struct fdt_region_state *info, * function) * @max_regions: Maximum number of regions in @region list * @info: Place to put the region state - * @return number of regions after processing, or -FDT_ERR_NOSPACE if we did + * Return: number of regions after processing, or -FDT_ERR_NOSPACE if we did * not have enough room in the regions table for the regions we wanted to add. */ int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count, diff --git a/boot/image-android-dt.c b/boot/image-android-dt.c index a2d52df4a2..fb014190d4 100644 --- a/boot/image-android-dt.c +++ b/boot/image-android-dt.c @@ -14,7 +14,7 @@ * Check if image header is correct. * * @param hdr_addr Start address of DT image - * @return true if header is correct or false if header is incorrect + * Return: true if header is correct or false if header is incorrect */ bool android_dt_check_header(ulong hdr_addr) { @@ -36,7 +36,7 @@ bool android_dt_check_header(ulong hdr_addr) * @param[out] addr If not NULL, will contain address to specified FDT * @param[out] size If not NULL, will contain size of specified FDT * - * @return true on success or false on error + * Return: true on success or false on error */ bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr, u32 *size) diff --git a/boot/image-board.c b/boot/image-board.c index 251885c903..0d2e0fc969 100644 --- a/boot/image-board.c +++ b/boot/image-board.c @@ -321,7 +321,7 @@ int genimg_has_config(bootm_headers_t *images) * @arch: expected ramdisk architecture * @rd_datap: pointer to a ulong variable, will hold ramdisk pointer * @rd_lenp: pointer to a ulong variable, will hold ramdisk length - * @return 0 if OK, -ENOPKG if no ramdisk (but an error should not be reported), + * Return: 0 if OK, -ENOPKG if no ramdisk (but an error should not be reported), * other -ve value on other error */ static int select_ramdisk(bootm_headers_t *images, const char *select, u8 arch, diff --git a/boot/image-fdt.c b/boot/image-fdt.c index 7aad6d57b8..692a9ad3e4 100644 --- a/boot/image-fdt.c +++ b/boot/image-fdt.c @@ -258,7 +258,7 @@ error: * @select: name of FDT to select, or NULL for any * @arch: expected FDT architecture * @fdt_addrp: pointer to a ulong variable, will hold FDT pointer - * @return 0 if OK, -ENOPKG if no FDT (but an error should not be reported), + * Return: 0 if OK, -ENOPKG if no FDT (but an error should not be reported), * other -ve value on other error */ diff --git a/boot/image-fit-sig.c b/boot/image-fit-sig.c index 63e5423c92..9b1d38b20a 100644 --- a/boot/image-fit-sig.c +++ b/boot/image-fit-sig.c @@ -236,7 +236,7 @@ int fit_image_verify_required_sigs(const void *fit, int image_noffset, * /configurations/conf-1/kernel) * @err_msgp: In the event of an error, this will be pointed to a * help error string to display to the user. - * @return 0 if all verified ok, <0 on error + * Return: 0 if all verified ok, <0 on error */ static int fit_config_check_sig(const void *fit, int noffset, int required_keynode, int conf_noffset, diff --git a/boot/image-fit.c b/boot/image-fit.c index b629339f4e..f6594e065c 100644 --- a/boot/image-fit.c +++ b/boot/image-fit.c @@ -1595,7 +1595,7 @@ int fit_image_check_comp(const void *fit, int noffset, uint8_t comp) * * @fit: FIT to check * @parent: Parent node to check - * @return 0 if OK, -EADDRNOTAVAIL is a node has a name containing '@' + * Return: 0 if OK, -EADDRNOTAVAIL is a node has a name containing '@' */ static int fdt_check_no_at(const void *fit, int parent) { @@ -1961,7 +1961,7 @@ int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name, /** * fit_get_image_type_property() - get property name for IH_TYPE_... * - * @return the properly name where we expect to find the image in the + * Return: the properly name where we expect to find the image in the * config node */ static const char *fit_get_image_type_property(int type) diff --git a/boot/image.c b/boot/image.c index c7ab034e08..07fa2d3160 100644 --- a/boot/image.c +++ b/boot/image.c @@ -550,7 +550,7 @@ static const char *unknown_msg(enum ih_category category) * This will scan the translation table trying to find the entry that matches * the given id. * - * @return long entry name if translation succeeds; error string on failure + * Return: long entry name if translation succeeds; error string on failure */ const char *genimg_get_cat_name(enum ih_category category, uint id) { @@ -570,7 +570,7 @@ const char *genimg_get_cat_name(enum ih_category category, uint id) * This will scan the translation table trying to find the entry that matches * the given id. * - * @return short entry name if translation succeeds; error string on failure + * Return: short entry name if translation succeeds; error string on failure */ const char *genimg_get_cat_short_name(enum ih_category category, uint id) { @@ -600,7 +600,7 @@ const char *genimg_get_cat_desc(enum ih_category category) * This will scan the translation table trying to find the entry that matches * the given id. * - * @return true if category has entry id; false if not + * Return: true if category has entry id; false if not */ bool genimg_cat_has_id(enum ih_category category, uint id) { diff --git a/boot/pxe_utils.c b/boot/pxe_utils.c index fcfee5e8b9..bb231b11a2 100644 --- a/boot/pxe_utils.c +++ b/boot/pxe_utils.c @@ -56,7 +56,7 @@ int pxe_get_file_size(ulong *sizep) * * @outbuf: Buffer to write string to * @outbuf_len: length of buffer - * @return 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no + * Return: 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no * current ethernet device */ int format_mac_pxe(char *outbuf, size_t outbuf_len) diff --git a/cmd/acpi.c b/cmd/acpi.c index e5b9a1752b..9c3462b411 100644 --- a/cmd/acpi.c +++ b/cmd/acpi.c @@ -39,7 +39,7 @@ static void dump_hdr(struct acpi_table_header *hdr) * find_table() - Look up an ACPI table * * @sig: Signature of table (4 characters, upper case) - * @return pointer to table header, or NULL if not found + * Return: pointer to table header, or NULL if not found */ struct acpi_table_header *find_table(const char *sig) { diff --git a/cmd/cramfs.c b/cmd/cramfs.c index d79292bad5..2aad50c672 100644 --- a/cmd/cramfs.c +++ b/cmd/cramfs.c @@ -92,7 +92,7 @@ extern int cramfs_info (struct part_info *info); * @param flag command flag * @param argc number of arguments supplied to the command * @param argv arguments list - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int do_cramfs_load(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) @@ -161,7 +161,7 @@ int do_cramfs_load(struct cmd_tbl *cmdtp, int flag, int argc, * @param flag command flag * @param argc number of arguments supplied to the command * @param argv arguments list - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int do_cramfs_ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { diff --git a/cmd/cros_ec.c b/cmd/cros_ec.c index a40f5898b5..ad49905d67 100644 --- a/cmd/cros_ec.c +++ b/cmd/cros_ec.c @@ -23,7 +23,7 @@ static const char * const ec_current_image_name[] = {"unknown", "RO", "RW"}; * * @param argc Number of params remaining * @param argv List of remaining parameters - * @return flash region (EC_FLASH_REGION_...) or -1 on error + * Return: flash region (EC_FLASH_REGION_...) or -1 on error */ static int cros_ec_decode_region(int argc, char *const argv[]) { @@ -48,7 +48,7 @@ static int cros_ec_decode_region(int argc, char *const argv[]) * @param is_write 1 do to a write, 0 to do a read * @param argc Number of arguments * @param argv Arguments (2 is region, 3 is address) - * @return 0 for ok, 1 for a usage error or -ve for ec command error + * Return: 0 for ok, 1 for a usage error or -ve for ec command error * (negative EC_RES_...) */ static int do_read_write(struct udevice *dev, int is_write, int argc, diff --git a/cmd/gpt.c b/cmd/gpt.c index f818fbb71f..1c0525fbf6 100644 --- a/cmd/gpt.c +++ b/cmd/gpt.c @@ -38,7 +38,7 @@ static LIST_HEAD(disk_partitions); * @param str - pointer to string * @param env - pointer to pointer to extracted env * - * @return - zero on successful expand and env is set + * Return: - zero on successful expand and env is set */ static int extract_env(const char *str, char **env) { @@ -97,7 +97,7 @@ static int extract_env(const char *str, char **env) * @param str - pointer to string with key=values pairs * @param key - pointer to the key to search for * - * @return - pointer to allocated string with the value + * Return: - pointer to allocated string with the value */ static char *extract_val(const char *str, const char *key) { @@ -134,7 +134,7 @@ static char *extract_val(const char *str, const char *key) * @param str - pointer to string with key * @param key - pointer to the key to search for * - * @return - true on found key + * Return: - true on found key */ static bool found_key(const char *str, const char *key) { @@ -403,7 +403,7 @@ static int do_get_gpt_info(struct blk_desc *dev_desc, char * const namestr) * @param partitions - pointer to pointer to allocated partitions array * @param parts_count - number of partitions * - * @return - zero on success, otherwise error + * Return: - zero on success, otherwise error * */ static int set_gpt_info(struct blk_desc *dev_desc, @@ -969,7 +969,7 @@ static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm, * @param argc * @param argv * - * @return zero on success; otherwise error + * Return: zero on success; otherwise error */ static int do_gpt(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { diff --git a/cmd/jffs2.c b/cmd/jffs2.c index 6f15b57b6a..914a7beeed 100644 --- a/cmd/jffs2.c +++ b/cmd/jffs2.c @@ -149,7 +149,7 @@ extern int cramfs_info (struct part_info *info); * Check device number to be within valid range for given device type. * * @param dev device to validate - * @return 0 if device is valid, 1 otherwise + * Return: 0 if device is valid, 1 otherwise */ static int mtd_device_validate(u8 type, u8 num, u32 *size) { @@ -201,7 +201,7 @@ static int mtd_device_validate(u8 type, u8 num, u32 *size) * @param ret_id output pointer to next char after parse completes (output) * @param dev_type parsed device type (output) * @param dev_num parsed device number (output) - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num) { @@ -241,7 +241,7 @@ static int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *d /** * Calculate sector size. * - * @return sector size + * Return: sector size */ static inline u32 get_part_sector_size_nand(struct mtdids *id) { @@ -329,7 +329,7 @@ static inline u32 get_part_sector_size(struct mtdids *id, struct part_info *part * 'Static' version of command line mtdparts_init() routine. Single partition on * a single device configuration. * - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int mtdparts_init(void) { @@ -412,7 +412,7 @@ int mtdparts_init(void) * * @param dev device that is to be searched for a partition * @param part_num requested partition number - * @return pointer to the part_info, NULL otherwise + * Return: pointer to the part_info, NULL otherwise */ static struct part_info* jffs2_part_info(struct mtd_device *dev, unsigned int part_num) { @@ -459,7 +459,7 @@ static struct part_info* jffs2_part_info(struct mtd_device *dev, unsigned int pa * @param flag command flag * @param argc number of arguments supplied to the command * @param argv arguments list - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int do_jffs2_fsload(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) @@ -522,7 +522,7 @@ int do_jffs2_fsload(struct cmd_tbl *cmdtp, int flag, int argc, * @param flag command flag * @param argc number of arguments supplied to the command * @param argv arguments list - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int do_jffs2_ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { @@ -560,7 +560,7 @@ int do_jffs2_ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) * @param flag command flag * @param argc number of arguments supplied to the command * @param argv arguments list - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int do_jffs2_fsinfo(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) diff --git a/cmd/mtdparts.c b/cmd/mtdparts.c index 3048700778..bab75a262f 100644 --- a/cmd/mtdparts.c +++ b/cmd/mtdparts.c @@ -170,7 +170,7 @@ static int device_del(struct mtd_device *dev); * * @param ptr where parse begins * @param retptr output pointer to next char after parse completes (output) - * @return resulting unsigned int + * Return: resulting unsigned int */ static u64 memsize_parse (const char *const ptr, const char **retptr) { @@ -302,7 +302,7 @@ static void current_save(void) * @param type mtd type * @param num mtd number * @param mtd a pointer to an mtd_info instance (output) - * @return 0 if device is valid, 1 otherwise + * Return: 0 if device is valid, 1 otherwise */ static int get_mtd_info(u8 type, u8 num, struct mtd_info **mtd) { @@ -326,7 +326,7 @@ static int get_mtd_info(u8 type, u8 num, struct mtd_info **mtd) * * @param id of the parent device * @param part partition to validate - * @return 0 if partition is valid, 1 otherwise + * Return: 0 if partition is valid, 1 otherwise */ static int part_validate_eraseblock(struct mtdids *id, struct part_info *part) { @@ -413,7 +413,7 @@ static int part_validate_eraseblock(struct mtdids *id, struct part_info *part) * * @param id of the parent device * @param part partition to validate - * @return 0 if partition is valid, 1 otherwise + * Return: 0 if partition is valid, 1 otherwise */ static int part_validate(struct mtdids *id, struct part_info *part) { @@ -449,7 +449,7 @@ static int part_validate(struct mtdids *id, struct part_info *part) * * @param dev device to delete partition from * @param part partition to delete - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int part_del(struct mtd_device *dev, struct part_info *part) { @@ -577,7 +577,7 @@ static int part_sort_add(struct mtd_device *dev, struct part_info *part) * * @param dev device to which partition is added * @param part partition to be added - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int part_add(struct mtd_device *dev, struct part_info *part) { @@ -599,7 +599,7 @@ static int part_add(struct mtd_device *dev, struct part_info *part) * @param partdef pointer to the partition definition string i.e. <part-def> * @param ret output pointer to next char after parse completes (output) * @param retpart pointer to the allocated partition (output) - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int part_parse(const char *const partdef, const char **ret, struct part_info **retpart) { @@ -717,7 +717,7 @@ static int part_parse(const char *const partdef, const char **ret, struct part_i * @param type mtd type * @param num mtd number * @param size a pointer to the size of the mtd device (output) - * @return 0 if device is valid, 1 otherwise + * Return: 0 if device is valid, 1 otherwise */ static int mtd_device_validate(u8 type, u8 num, u64 *size) { @@ -735,7 +735,7 @@ static int mtd_device_validate(u8 type, u8 num, u64 *size) * Delete all mtd devices from a supplied devices list, free memory allocated for * each device and delete all device partitions. * - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int device_delall(struct list_head *head) { @@ -759,7 +759,7 @@ static int device_delall(struct list_head *head) * from device list and device memory is freed. * * @param dev device to be deleted - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int device_del(struct mtd_device *dev) { @@ -791,7 +791,7 @@ static int device_del(struct mtd_device *dev) * * @param type device type * @param num device number - * @return NULL if requested device does not exist + * Return: NULL if requested device does not exist */ struct mtd_device *device_find(u8 type, u8 num) { @@ -838,7 +838,7 @@ static void device_add(struct mtd_device *dev) * @param mtd_dev pointer to the device definition string i.e. <mtd-dev> * @param ret output pointer to next char after parse completes (output) * @param retdev pointer to the allocated device (output) - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int device_parse(const char *const mtd_dev, const char **ret, struct mtd_device **retdev) { @@ -969,7 +969,7 @@ static int device_parse(const char *const mtd_dev, const char **ret, struct mtd_ /** * Initialize global device list. * - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int mtd_devices_init(void) { @@ -983,7 +983,7 @@ static int mtd_devices_init(void) /* * Search global mtdids list and find id of requested type and number. * - * @return pointer to the id if it exists, NULL otherwise + * Return: pointer to the id if it exists, NULL otherwise */ static struct mtdids* id_find(u8 type, u8 num) { @@ -1007,7 +1007,7 @@ static struct mtdids* id_find(u8 type, u8 num) * * @param mtd_id string containing requested mtd_id * @param mtd_id_len length of supplied mtd_id - * @return pointer to the id if it exists, NULL otherwise + * Return: pointer to the id if it exists, NULL otherwise */ static struct mtdids* id_find_by_mtd_id(const char *mtd_id, unsigned int mtd_id_len) { @@ -1040,7 +1040,7 @@ static struct mtdids* id_find_by_mtd_id(const char *mtd_id, unsigned int mtd_id_ * @param ret_id output pointer to next char after parse completes (output) * @param dev_type parsed device type (output) * @param dev_num parsed device number (output) - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num) @@ -1082,7 +1082,7 @@ int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, * * @param buf output buffer holding generated mtdparts string (output) * @param buflen buffer size - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int generate_mtdparts(char *buf, u32 buflen) { @@ -1207,7 +1207,7 @@ cleanup: * * @param buf output buffer holding generated mtdparts string (output) * @param buflen buffer size - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int generate_mtdparts_save(char *buf, u32 buflen) { @@ -1229,7 +1229,7 @@ static int generate_mtdparts_save(char *buf, u32 buflen) * * @param mtd the mtd info * @param part the partition - * @return the calculated net size of this partition + * Return: the calculated net size of this partition */ static uint64_t net_part_size(struct mtd_info *mtd, struct part_info *part) { @@ -1345,7 +1345,7 @@ static void list_partitions(void) * @param dev pointer to the requested device (output) * @param part_num verified partition number (output) * @param part pointer to requested partition (output) - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int find_dev_and_part(const char *id, struct mtd_device **dev, u8 *part_num, struct part_info **part) @@ -1405,7 +1405,7 @@ int find_dev_and_part(const char *id, struct mtd_device **dev, * Find and delete partition. For partition id format see find_dev_and_part(). * * @param id string describing device and partition - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int delete_partition(const char *id) { @@ -1481,7 +1481,7 @@ static void spread_partition(struct mtd_info *mtd, struct part_info *part, * as big as their mtdparts environment variable sizes and they each start * on a good block. * - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int spread_partitions(void) { @@ -1534,7 +1534,7 @@ static int spread_partitions(void) * buffer. gd->env_buf will be too small. * * @param buf temporary buffer pointer MTDPARTS_MAXLEN long - * @return mtdparts variable string, NULL if not found + * Return: mtdparts variable string, NULL if not found */ static const char *env_get_mtdparts(char *buf) { @@ -1550,7 +1550,7 @@ static const char *env_get_mtdparts(char *buf) * for each entry. Add created devices to the global devices list. * * @param mtdparts string specifing mtd partitions - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int parse_mtdparts(const char *const mtdparts) { @@ -1608,7 +1608,7 @@ static int parse_mtdparts(const char *const mtdparts) * to the global mtdids list. * * @param ids mapping string - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int parse_mtdids(const char *const ids) { @@ -1718,7 +1718,7 @@ static int parse_mtdids(const char *const ids) * Parse and initialize global mtdids mapping and create global * device/partition list. * - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ int mtdparts_init(void) { @@ -1868,7 +1868,7 @@ int mtdparts_init(void) * * @param dev device that is to be searched for a partition * @param part_num requested partition number - * @return pointer to the part_info, NULL otherwise + * Return: pointer to the part_info, NULL otherwise */ static struct part_info* mtd_part_info(struct mtd_device *dev, unsigned int part_num) { @@ -1915,7 +1915,7 @@ static struct part_info* mtd_part_info(struct mtd_device *dev, unsigned int part * @param flag command flag * @param argc number of arguments supplied to the command * @param argv arguments list - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int do_chpart(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) @@ -1954,7 +1954,7 @@ static int do_chpart(struct cmd_tbl *cmdtp, int flag, int argc, * @param flag command flag * @param argc number of arguments supplied to the command * @param argv arguments list - * @return 0 on success, 1 otherwise + * Return: 0 on success, 1 otherwise */ static int do_mtdparts(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) diff --git a/cmd/pci.c b/cmd/pci.c index 3b1863f139..389b41ccc3 100644 --- a/cmd/pci.c +++ b/cmd/pci.c @@ -317,7 +317,7 @@ static void pciinfo(struct udevice *bus, bool short_listing) * get_pci_dev() - Convert the "bus.device.function" identifier into a number * * @name: Device string in the form "bus.device.function" where each is in hex - * @return encoded pci_dev_t or -1 if the string was invalid + * Return: encoded pci_dev_t or -1 if the string was invalid */ static pci_dev_t get_pci_dev(char *name) { diff --git a/cmd/pinmux.c b/cmd/pinmux.c index 2d23357526..f17cf4110d 100644 --- a/cmd/pinmux.c +++ b/cmd/pinmux.c @@ -47,7 +47,7 @@ static int do_dev(struct cmd_tbl *cmdtp, int flag, int argc, * @param dev pinctrl device * @param name NULL to display all the pins * or name of the pin to display - * @return 0 on success, non-0 on error + * Return: 0 on success, non-0 on error */ static int show_pinmux(struct udevice *dev, char *name) { diff --git a/cmd/setexpr.c b/cmd/setexpr.c index 05d655809b..4d671e7ef1 100644 --- a/cmd/setexpr.c +++ b/cmd/setexpr.c @@ -140,7 +140,7 @@ static char *memstr(const char *s1, int l1, const char *s2, int l2) * @olen: Length of @old excluding terminator * @new: New string to replace @old with * @nlen: Length of @new excluding terminator - * @return pointer to immediately after the copied @new in @string, or NULL if + * Return: pointer to immediately after the copied @new in @string, or NULL if * no replacement took place */ static char *substitute(char *string, int *slen, int ssize, diff --git a/cmd/sf.c b/cmd/sf.c index 72246d912f..8bdebd9fd8 100644 --- a/cmd/sf.c +++ b/cmd/sf.c @@ -72,7 +72,7 @@ static int sf_parse_len_arg(char *arg, ulong *len) * * @param len amount of bytes currently processed * @param start_ms start time of processing in ms - * @return bytes per second if OK, 0 on error + * Return: bytes per second if OK, 0 on error */ static ulong bytes_per_second(unsigned int len, ulong start_ms) { @@ -166,7 +166,7 @@ static int do_spi_flash_probe(int argc, char *const argv[]) * @param buf buffer to write from * @param cmp_buf read buffer to use to compare data * @param skipped Count of skipped data (incremented by this function) - * @return NULL if OK, else a string containing the stage which failed + * Return: NULL if OK, else a string containing the stage which failed */ static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset, size_t len, const char *buf, char *cmp_buf, size_t *skipped) @@ -208,7 +208,7 @@ static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset, * @param offset flash offset to write * @param len number of bytes to write * @param buf buffer to write from - * @return 0 if ok, 1 on error + * Return: 0 if ok, 1 on error */ static int spi_flash_update(struct spi_flash *flash, u32 offset, size_t len, const char *buf) @@ -438,7 +438,7 @@ static void spi_test_next_stage(struct test_info *test) * @param len Size of data to read/write * @param offset Offset within flash to check * @param vbuf Verification buffer - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len, ulong offset, uint8_t *vbuf) diff --git a/cmd/tpm-common.c b/cmd/tpm-common.c index 1d5442c06f..47adaffd18 100644 --- a/cmd/tpm-common.c +++ b/cmd/tpm-common.c @@ -46,7 +46,7 @@ void print_byte_string(u8 *data, size_t count) * NULL is passed, a large enough buffer will be allocated, * and the caller must free it. * @param count_ptr output variable for the length of byte string - * @return pointer to output buffer + * Return: pointer to output buffer */ void *parse_byte_string(char *bytes, u8 *data, size_t *count_ptr) { @@ -81,7 +81,7 @@ void *parse_byte_string(char *bytes, u8 *data, size_t *count_ptr) * report_return_code() - Report any error and return failure or success * * @param return_code TPM command return code - * @return value of enum command_ret_t + * Return: value of enum command_ret_t */ int report_return_code(int return_code) { @@ -97,7 +97,7 @@ int report_return_code(int return_code) * Return number of values defined by a type string. * * @param type_str type string - * @return number of values of type string + * Return: number of values of type string */ int type_string_get_num_values(const char *type_str) { @@ -108,7 +108,7 @@ int type_string_get_num_values(const char *type_str) * Return total size of values defined by a type string. * * @param type_str type string - * @return total size of values of type string, or 0 if type string + * Return: total size of values of type string, or 0 if type string * contains illegal type character. */ size_t type_string_get_space_size(const char *type_str) @@ -140,7 +140,7 @@ size_t type_string_get_space_size(const char *type_str) * * @param type_str type string * @param count pointer for storing size of buffer - * @return pointer to buffer or NULL on error + * Return: pointer to buffer or NULL on error */ void *type_string_alloc(const char *type_str, u32 *count) { @@ -164,7 +164,7 @@ void *type_string_alloc(const char *type_str, u32 *count) * @param type_str type string * @param values text strings of values to be packed * @param data output buffer of values - * @return 0 on success, non-0 on error + * Return: 0 on success, non-0 on error */ int type_string_pack(const char *type_str, char * const values[], u8 *data) @@ -202,7 +202,7 @@ int type_string_pack(const char *type_str, char * const values[], * @param type_str type string * @param data input buffer of values * @param vars names of environment variables - * @return 0 on success, non-0 on error + * Return: 0 on success, non-0 on error */ int type_string_write_vars(const char *type_str, u8 *data, char * const vars[]) diff --git a/common/autoboot.c b/common/autoboot.c index 6251c68310..b8861d5621 100644 --- a/common/autoboot.c +++ b/common/autoboot.c @@ -69,7 +69,7 @@ static int menukey; * before starting to enter the password. * * @etime: Timeout value ticks (stop when get_ticks() reachs this) - * @return 0 if autoboot should continue, 1 if it should stop + * Return: 0 if autoboot should continue, 1 if it should stop */ static int passwd_abort_crypt(uint64_t etime) { @@ -143,7 +143,7 @@ static int slow_equals(u8 *a, u8 *b, int len) * This checks for the user entering a SHA256 hash within a given time. * * @etime: Timeout value ticks (stop when get_ticks() reachs this) - * @return 0 if autoboot should continue, 1 if it should stop + * Return: 0 if autoboot should continue, 1 if it should stop */ static int passwd_abort_sha256(uint64_t etime) { @@ -219,7 +219,7 @@ static int passwd_abort_sha256(uint64_t etime) * This checks for the user entering a string within a given time. * * @etime: Timeout value ticks (stop when get_ticks() reachs this) - * @return 0 if autoboot should continue, 1 if it should stop + * Return: 0 if autoboot should continue, 1 if it should stop */ static int passwd_abort_key(uint64_t etime) { @@ -315,7 +315,7 @@ static void flush_stdin(void) * sha256-fallback has been enabled via the config setting * `AUTOBOOT_SHA256_FALLBACK`. * - * @return `false` if we must not fall-back, `true` if plain sha256 should be tried + * Return: `false` if we must not fall-back, `true` if plain sha256 should be tried */ static bool fallback_to_sha256(void) { diff --git a/common/board_r.c b/common/board_r.c index 60eced6f7f..c24d9b4e22 100644 --- a/common/board_r.c +++ b/common/board_r.c @@ -418,7 +418,7 @@ static int initr_pvblock(void) * NOTE: Loading the environment early can be a bad idea if security is * important, since no verification is done on the environment. * - * @return 0 if environment should not be loaded, !=0 if it is ok to load + * Return: 0 if environment should not be loaded, !=0 if it is ok to load */ static int should_load_env(void) { diff --git a/common/bootstage.c b/common/bootstage.c index 4621105682..0fd33be97e 100644 --- a/common/bootstage.c +++ b/common/bootstage.c @@ -230,7 +230,7 @@ uint32_t bootstage_accum(enum bootstage_id id) * @param buf Buffer to put name if needed * @param len Length of buffer * @param rec Boot stage record to get the name from - * @return pointer to name, either from the record or pointing to buf. + * Return: pointer to name, either from the record or pointing to buf. */ static const char *get_record_name(char *buf, int len, const struct bootstage_record *rec) @@ -273,7 +273,7 @@ static int h_compare_record(const void *r1, const void *r2) * Add all bootstage timings to a device tree. * * @param blob Device tree blob - * @return 0 on success, != 0 on failure. + * Return: 0 on success, != 0 on failure. */ static int add_bootstages_devicetree(struct fdt_header *blob) { diff --git a/common/cli.c b/common/cli.c index d86046a728..a7e3d84b68 100644 --- a/common/cli.c +++ b/common/cli.c @@ -27,7 +27,7 @@ * * @param cmd Command to run * @param flag Execution flags (CMD_FLAG_...) - * @return 0 on success, or != 0 on error. + * Return: 0 on success, or != 0 on error. */ int run_command(const char *cmd, int flag) { @@ -54,7 +54,7 @@ int run_command(const char *cmd, int flag) * * @param cmd Command to run * @param flag Execution flags (CMD_FLAG_...) - * @return 0 (not repeatable) or 1 (repeatable) on success, -1 on error. + * Return: 0 (not repeatable) or 1 (repeatable) on success, -1 on error. */ int run_command_repeatable(const char *cmd, int flag) { diff --git a/common/command.c b/common/command.c index 95af73f17b..41c91c6d8c 100644 --- a/common/command.c +++ b/common/command.c @@ -570,7 +570,7 @@ int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc, * @param argc Number of arguments (arg 0 must be the command text) * @param argv Arguments * @param repeatable Can the command be repeated - * @return 0 if command succeeded, else non-zero (CMD_RET_...) + * Return: 0 if command succeeded, else non-zero (CMD_RET_...) */ static int cmd_call(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[], int *repeatable) diff --git a/common/console.c b/common/console.c index 2bccc8ab10..92b1c93be1 100644 --- a/common/console.c +++ b/common/console.c @@ -213,7 +213,7 @@ static int console_setfile(int file, struct stdio_dev * dev) * console_dev_is_serial() - Check if a stdio device is a serial device * * @sdev: Device to check - * @return true if this device is in the serial uclass (or for pre-driver-model, + * Return: true if this device is in the serial uclass (or for pre-driver-model, * whether it is called "serial". */ static bool console_dev_is_serial(struct stdio_dev *sdev) diff --git a/common/edid.c b/common/edid.c index fa85bcd6a1..556c4e3434 100644 --- a/common/edid.c +++ b/common/edid.c @@ -139,7 +139,7 @@ static void decode_timing(u8 *buf, struct display_timing *timing) /** * Check if HDMI vendor specific data block is present in CEA block * @param info CEA extension block - * @return true if block is found + * Return: true if block is found */ static bool cea_is_hdmi_vsdb_present(struct edid_cea861_info *info) { @@ -274,7 +274,7 @@ int edid_get_timing(u8 *buf, int buf_size, struct display_timing *timing, * Snip the tailing whitespace/return of a string. * * @param string The string to be snipped - * @return the snipped string + * Return: the snipped string */ static char *snip(char *string) { diff --git a/common/fdt_support.c b/common/fdt_support.c index c6b93e7889..efbd900e1f 100644 --- a/common/fdt_support.c +++ b/common/fdt_support.c @@ -2049,7 +2049,7 @@ int fdt_overlay_apply_verbose(void *fdt, void *fdto) * fdt_valid() - Check if an FDT is valid. If not, change it to NULL * * @blobp: Pointer to FDT pointer - * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL) + * Return: 1 if OK, 0 if bad (in which case *blobp is set to NULL) */ int fdt_valid(struct fdt_header **blobp) { diff --git a/common/hash.c b/common/hash.c index 79202e18a2..9e53545dbd 100644 --- a/common/hash.c +++ b/common/hash.c @@ -500,7 +500,7 @@ static void store_result(struct hash_algo *algo, const uint8_t *sum, * @allow_env_vars: non-zero to permit storing the result to an environment * variable. If 0 then verify_str is assumed to be an * address, and the * prefix is not expected. - * @return 0 if ok, non-zero on error + * Return: 0 if ok, non-zero on error */ static int parse_verify_sum(struct hash_algo *algo, char *verify_str, uint8_t *vsum, int allow_env_vars) diff --git a/common/log.c b/common/log.c index 1aaa6c1527..f7e0c0fbf5 100644 --- a/common/log.c +++ b/common/log.c @@ -147,7 +147,7 @@ bool log_has_file(const char *file_list, const char *file) * * @ldev: Log device to check * @rec: Log record to check - * @return true if @rec is not blocked by the filters in @ldev, false if it is + * Return: true if @rec is not blocked by the filters in @ldev, false if it is */ static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec) { @@ -390,7 +390,7 @@ int log_remove_filter(const char *drv_name, int filter_num) * log_find_device_by_drv() - Find a device by its driver * * @drv: Log driver - * @return Device associated with that driver, or NULL if not found + * Return: Device associated with that driver, or NULL if not found */ static struct log_device *log_find_device_by_drv(struct log_driver *drv) { diff --git a/common/spl/spl.c b/common/spl/spl.c index c5360f30ae..4bb9455efb 100644 --- a/common/spl/spl.c +++ b/common/spl/spl.c @@ -446,7 +446,7 @@ static inline int write_spl_handoff(void) { return 0; } * get_bootstage_id() - Get the bootstage ID to emit * * @start: true if this is for starting SPL, false for ending it - * @return bootstage ID to use + * Return: bootstage ID to use */ static enum bootstage_id get_bootstage_id(bool start) { @@ -617,7 +617,7 @@ static int spl_load_image(struct spl_image_info *spl_image, * @spl_image: Place to put the image details if successful * @spl_boot_list: List of boot devices to try * @count: Number of elements in spl_boot_list - * @return 0 if OK, -ENODEV if there were no boot devices + * Return: 0 if OK, -ENODEV if there were no boot devices * if CONFIG_SHOW_ERRORS is enabled, returns -ENXIO if there were * devices but none worked */ @@ -883,7 +883,7 @@ __weak void spl_relocate_stack_check(void) * All of this is done using the same layout and alignments as done in * board_init_f_init_reserve() / board_init_f_alloc_reserve(). * - * @return new stack location, or 0 to use the same stack + * Return: new stack location, or 0 to use the same stack */ ulong spl_relocate_stack_gd(void) { diff --git a/common/stdio.c b/common/stdio.c index 0f2eb6f0d6..976f51c252 100644 --- a/common/stdio.c +++ b/common/stdio.c @@ -144,7 +144,7 @@ struct list_head* stdio_get_list(void) * @name: stdio device name (e.g. "vidconsole") * id: Uclass ID of device to look for (e.g. UCLASS_VIDEO) * @sdevp: Returns stdout device, if found, else NULL - * @return 0 if found, -ENOENT if no device found with that name, other -ve + * Return: 0 if found, -ENOENT if no device found with that name, other -ve * on other error */ static int stdio_probe_device(const char *name, enum uclass_id id, diff --git a/disk/part.c b/disk/part.c index 99f592d96c..49e39a24e8 100644 --- a/disk/part.c +++ b/disk/part.c @@ -713,7 +713,7 @@ int part_get_info_by_name(struct blk_desc *dev_desc, const char *name, * @param[in] dev_part_str Input string argument, like "0.1#misc" * @param[out] dev_desc Place to store the device description pointer * @param[out] part_info Place to store the partition information - * @return 0 on success, or a negative on error + * Return: 0 on success, or a negative on error */ static int part_get_info_by_dev_and_name(const char *dev_iface, const char *dev_part_str, diff --git a/disk/part_efi.c b/disk/part_efi.c index 3809333078..611654fa18 100644 --- a/disk/part_efi.c +++ b/disk/part_efi.c @@ -331,7 +331,7 @@ static int part_test_efi(struct blk_desc *dev_desc) * set_protective_mbr(): Set the EFI protective MBR * @param dev_desc - block device descriptor * - * @return - zero on success, otherwise error + * Return: - zero on success, otherwise error */ static int set_protective_mbr(struct blk_desc *dev_desc) { diff --git a/drivers/block/blk-uclass.c b/drivers/block/blk-uclass.c index a055387570..bee1cd6f0d 100644 --- a/drivers/block/blk-uclass.c +++ b/drivers/block/blk-uclass.c @@ -172,7 +172,7 @@ struct blk_desc *blk_get_by_device(struct udevice *dev) * @if_type: Interface type * @devnum: Device number (0 = first) * @descp: Returns block device descriptor on success - * @return 0 on success, -ENODEV if there is no such device and no device + * Return: 0 on success, -ENODEV if there is no such device and no device * with a higher device number, -ENOENT if there is no such device but there * is one with a higher number, or other -ve on other error. */ diff --git a/drivers/block/blk_legacy.c b/drivers/block/blk_legacy.c index e3ee778c29..df9a359754 100644 --- a/drivers/block/blk_legacy.c +++ b/drivers/block/blk_legacy.c @@ -52,7 +52,7 @@ const char *blk_get_if_type_name(enum if_type if_type) * @drv: Legacy block driver * @devnum: Device number (0 = first) * @descp: Returns block device descriptor on success - * @return 0 on success, -ENODEV if there is no such device, -ENOSYS if the + * Return: 0 on success, -ENODEV if there is no such device, -ENOSYS if the * driver does not provide a way to find a device, or other -ve on other * error. */ diff --git a/drivers/clk/aspeed/clk_ast2500.c b/drivers/clk/aspeed/clk_ast2500.c index 97f00f505d..a1b4496ca2 100644 --- a/drivers/clk/aspeed/clk_ast2500.c +++ b/drivers/clk/aspeed/clk_ast2500.c @@ -91,7 +91,7 @@ static ulong ast2500_get_clkin(struct ast2500_scu *scu) * @scu SCU registers * @uart_index UART index, 1-5 * - * @return current setting for uart clock rate + * Return: current setting for uart clock rate */ static ulong ast2500_get_uart_clk_rate(struct ast2500_scu *scu, int uart_index) { @@ -216,7 +216,7 @@ static bool ast2500_get_clock_config_default(ulong input_rate, * The result (the best config we could find), would also be returned * in this structure. * - * @return The clock rate, when the resulting div_config is used. + * Return: The clock rate, when the resulting div_config is used. */ static ulong ast2500_calc_clock_config(ulong input_rate, ulong requested_rate, struct ast2500_div_config *cfg) diff --git a/drivers/clk/aspeed/clk_ast2600.c b/drivers/clk/aspeed/clk_ast2600.c index 3fb8d68d64..f191b0f317 100644 --- a/drivers/clk/aspeed/clk_ast2600.c +++ b/drivers/clk/aspeed/clk_ast2600.c @@ -481,7 +481,7 @@ static ulong ast2600_clk_get_rate(struct clk *clk) /** * @brief lookup PLL divider config by input/output rate * @param[in] *pll - PLL descriptor - * @return true - if PLL divider config is found, false - else + * Return: true - if PLL divider config is found, false - else * The function caller shall fill "pll->in" and "pll->out", * then this function will search the lookup table * to find a valid PLL divider configuration. diff --git a/drivers/clk/microchip/mpfs_clk.h b/drivers/clk/microchip/mpfs_clk.h index 8e3fc55ae3..442562a5e7 100644 --- a/drivers/clk/microchip/mpfs_clk.h +++ b/drivers/clk/microchip/mpfs_clk.h @@ -13,7 +13,7 @@ * @base: base address of the mpfs system register. * @clk_rate: the mpfs pll clock rate. * @parent_name: a pointer to parent clock name. - * @return zero on success, or a negative error code. + * Return: zero on success, or a negative error code. */ int mpfs_clk_register_cfgs(void __iomem *base, u32 clk_rate, const char *parent_name); @@ -23,7 +23,7 @@ int mpfs_clk_register_cfgs(void __iomem *base, u32 clk_rate, * @base: base address of the mpfs system register. * @clk_rate: the mpfs pll clock rate. * @parent_name: a pointer to parent clock name. - * @return zero on success, or a negative error code. + * Return: zero on success, or a negative error code. */ int mpfs_clk_register_periphs(void __iomem *base, u32 clk_rate, const char *parent_name); @@ -35,7 +35,7 @@ int mpfs_clk_register_periphs(void __iomem *base, u32 clk_rate, * @table: a pointer to clock divider table. * @width: width of the divider bit field. * @flags: common clock framework flags. - * @return divider value on success, or a negative error code. + * Return: divider value on success, or a negative error code. */ int divider_get_val(unsigned long rate, unsigned long parent_rate, const struct clk_div_table *table, diff --git a/drivers/core/acpi.c b/drivers/core/acpi.c index 2176d8b836..e988a65ec5 100644 --- a/drivers/core/acpi.c +++ b/drivers/core/acpi.c @@ -109,7 +109,7 @@ int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen) * @dev: Device that generated the data * @type: Table type it refers to * @start: The start of the data (the end is obtained from ctx->current) - * @return 0 if OK, -ENOSPC if too many items, -ENOMEM if out of memory + * Return: 0 if OK, -ENOSPC if too many items, -ENOMEM if out of memory */ static int acpi_add_item(struct acpi_ctx *ctx, struct udevice *dev, enum gen_type_t type, void *start) @@ -179,7 +179,7 @@ static struct acpi_item *find_acpi_item(const char *devname) * @start: Start position to put the sorted items. The items will follow each * other in sorted order * @type: Type of items to sort - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int sort_acpi_item_type(struct acpi_ctx *ctx, void *start, enum gen_type_t type) diff --git a/drivers/core/device-remove.c b/drivers/core/device-remove.c index 69c50da44a..e6ec6ff421 100644 --- a/drivers/core/device-remove.c +++ b/drivers/core/device-remove.c @@ -170,7 +170,7 @@ void device_free(struct udevice *dev) * * @flags: Flags passed to device_remove() * @drv_flags: Driver flags - * @return 0 if the device should be removed, + * Return: 0 if the device should be removed, * -EKEYREJECTED if @flags includes a flag in DM_REMOVE_ACTIVE_ALL but * @drv_flags does not (indicates that this device has nothing to do for * DMA shutdown or OS prepare) diff --git a/drivers/core/device.c b/drivers/core/device.c index d917d4e82d..901c1e2f7d 100644 --- a/drivers/core/device.c +++ b/drivers/core/device.c @@ -346,7 +346,7 @@ static void *alloc_priv(int size, uint flags) * device_alloc_priv() - Allocate priv/plat data required by the device * * @dev: Device to process - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ static int device_alloc_priv(struct udevice *dev) { diff --git a/drivers/core/lists.c b/drivers/core/lists.c index d2e9dc5719..22ccd9faaa 100644 --- a/drivers/core/lists.c +++ b/drivers/core/lists.c @@ -161,7 +161,7 @@ int device_bind_driver_to_node(struct udevice *parent, const char *drv_name, * @param of_match: List of compatible strings to match * @param of_idp: Returns the match that was found * @param compat: The compatible string to search for - * @return 0 if there is a match, -ENOENT if no match + * Return: 0 if there is a match, -ENOENT if no match */ static int driver_check_compatible(const struct udevice_id *of_match, const struct udevice_id **of_idp, diff --git a/drivers/core/of_access.c b/drivers/core/of_access.c index 3707143ae6..c20b19cb50 100644 --- a/drivers/core/of_access.c +++ b/drivers/core/of_access.c @@ -463,7 +463,7 @@ struct device_node *of_find_node_by_phandle(phandle handle) * @propname: name of the property to be searched. * @len: requested length of property value * - * @return the property value on success, -EINVAL if the property does not + * Return: the property value on success, -EINVAL if the property does not * exist, -ENODATA if property does not have a value, and -EOVERFLOW if the * property data isn't large enough. */ diff --git a/drivers/core/root.c b/drivers/core/root.c index 815173f86e..e3f87956d8 100644 --- a/drivers/core/root.c +++ b/drivers/core/root.c @@ -257,7 +257,7 @@ int dm_scan_plat(bool pre_reloc_only) * @node: Node to scan * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC * flag. If false bind all drivers. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int dm_scan_fdt_node(struct udevice *parent, ofnode parent_node, bool pre_reloc_only) diff --git a/drivers/core/uclass.c b/drivers/core/uclass.c index 336ea8d243..2578803b7a 100644 --- a/drivers/core/uclass.c +++ b/drivers/core/uclass.c @@ -46,7 +46,7 @@ struct uclass *uclass_find(enum uclass_id key) * uclass_add() - Create new uclass in list * @id: Id number to create * @ucp: Returns pointer to uclass, or NULL on error - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error * * The new uclass is added to the list. There must be only one uclass for * each id. diff --git a/drivers/crypto/ace_sha.h b/drivers/crypto/ace_sha.h index a671b925b6..ad9e81a586 100644 --- a/drivers/crypto/ace_sha.h +++ b/drivers/crypto/ace_sha.h @@ -306,7 +306,7 @@ struct exynos_ace_sfr { * should allocate at least 32 bytes at pOut in advance. * @param hash_type SHA1 or SHA256 * - * @return 0 on Success, -1 on Failure (Timeout) + * Return: 0 on Success, -1 on Failure (Timeout) */ int ace_sha_hash_digest(const uchar * in_addr, uint buflen, uchar * out_addr, uint hash_type); diff --git a/drivers/crypto/fsl/fsl_hash.c b/drivers/crypto/fsl/fsl_hash.c index 8039473012..2379b70c2d 100644 --- a/drivers/crypto/fsl/fsl_hash.c +++ b/drivers/crypto/fsl/fsl_hash.c @@ -57,7 +57,7 @@ static enum caam_hash_algos get_hash_type(struct hash_algo *algo) * * @ctxp: Pointer to the pointer of the context for hashing * @caam_algo: Enum for SHA1 or SHA256 - * @return 0 if ok, -ENOMEM on error + * Return: 0 if ok, -ENOMEM on error */ static int caam_hash_init(void **ctxp, enum caam_hash_algos caam_algo) { @@ -80,7 +80,7 @@ static int caam_hash_init(void **ctxp, enum caam_hash_algos caam_algo) * @size: Size of the buffer being hashed * @is_last: 1 if this is the last update; 0 otherwise * @caam_algo: Enum for SHA1 or SHA256 - * @return 0 if ok, -EINVAL on error + * Return: 0 if ok, -EINVAL on error */ static int caam_hash_update(void *hash_ctx, const void *buf, unsigned int size, int is_last, @@ -126,7 +126,7 @@ static int caam_hash_update(void *hash_ctx, const void *buf, * @dest_buf: Pointer to the destination buffer where hash is to be copied * @size: Size of the buffer being hashed * @caam_algo: Enum for SHA1 or SHA256 - * @return 0 if ok, -EINVAL on error + * Return: 0 if ok, -EINVAL on error */ static int caam_hash_finish(void *hash_ctx, void *dest_buf, int size, enum caam_hash_algos caam_algo) diff --git a/drivers/crypto/fsl/jobdesc.c b/drivers/crypto/fsl/jobdesc.c index c350b32856..542b1652d8 100644 --- a/drivers/crypto/fsl/jobdesc.c +++ b/drivers/crypto/fsl/jobdesc.c @@ -22,7 +22,7 @@ * Secure memory run command * * @param sec_mem_cmd Secure memory command register - * @return cmd_status Secure memory command status register + * Return: cmd_status Secure memory command status register */ uint32_t secmem_set_cmd(uint32_t sec_mem_cmd) { @@ -52,7 +52,7 @@ uint32_t secmem_set_cmd(uint32_t sec_mem_cmd) * * @param page Number of the page to allocate. * @param partition Number of the partition to allocate. - * @return 0 on success, ERROR_IN_PAGE_ALLOC otherwise + * Return: 0 on success, ERROR_IN_PAGE_ALLOC otherwise */ int caam_page_alloc(uint8_t page_num, uint8_t partition_num) { diff --git a/drivers/fastboot/fb_getvar.c b/drivers/fastboot/fb_getvar.c index d43f2cfee6..018989dd16 100644 --- a/drivers/fastboot/fb_getvar.c +++ b/drivers/fastboot/fb_getvar.c @@ -96,7 +96,7 @@ static const struct { * @param[in] part_name Info for which partition name to look for * @param[in,out] response Pointer to fastboot response buffer * @param[out] size If not NULL, will contain partition size - * @return Partition number or negative value on error + * Return: Partition number or negative value on error */ static int getvar_get_part_info(const char *part_name, char *response, size_t *size) diff --git a/drivers/fastboot/fb_mmc.c b/drivers/fastboot/fb_mmc.c index 2738dc836e..2710879812 100644 --- a/drivers/fastboot/fb_mmc.c +++ b/drivers/fastboot/fb_mmc.c @@ -289,7 +289,7 @@ static void fb_mmc_boot_ops(struct blk_desc *dev_desc, void *buffer, * @param[in] info Boot partition info * @param[out] hdr Where to store read boot image header * - * @return Boot image header sectors count or 0 on error + * Return: Boot image header sectors count or 0 on error */ static lbaint_t fb_mmc_get_boot_header(struct blk_desc *dev_desc, struct disk_partition *info, @@ -336,7 +336,7 @@ static lbaint_t fb_mmc_get_boot_header(struct blk_desc *dev_desc, * @param download_buffer Address to fastboot buffer with zImage in it * @param download_bytes Size of fastboot buffer, in bytes * - * @return 0 on success or -1 on error + * Return: 0 on success or -1 on error */ static int fb_mmc_update_zimage(struct blk_desc *dev_desc, void *download_buffer, diff --git a/drivers/gpio/gpio-uclass.c b/drivers/gpio/gpio-uclass.c index 1c5e2e7976..125ae53d61 100644 --- a/drivers/gpio/gpio-uclass.c +++ b/drivers/gpio/gpio-uclass.c @@ -53,7 +53,7 @@ static void gpio_desc_init(struct gpio_desc *desc, * * @gpio: The numeric representation of the GPIO * @desc: Returns description (desc->flags will always be 0) - * @return 0 if found, -ENOENT if not found + * Return: 0 if found, -ENOENT if not found */ static int gpio_to_device(unsigned int gpio, struct gpio_desc *desc) { @@ -659,7 +659,7 @@ static int check_dir_flags(ulong flags) * * @desc: GPIO description * @flags: flags value to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int _dm_gpio_set_flags(struct gpio_desc *desc, ulong flags) { diff --git a/drivers/gpio/iproc_gpio.c b/drivers/gpio/iproc_gpio.c index 8c143e9b75..7187d3257b 100644 --- a/drivers/gpio/iproc_gpio.c +++ b/drivers/gpio/iproc_gpio.c @@ -123,7 +123,7 @@ static u32 iproc_get_pctrl_from_gpio(struct iproc_gpio_plat *plat, u32 gpio) * in private data structure to use it later while enabling gpio. * * @dev: pointer to GPIO device - * @return 0 on success and -ENOMEM on failure + * Return: 0 on success and -ENOMEM on failure */ static int iproc_get_gpio_pctrl_mapping(struct udevice *dev) { diff --git a/drivers/gpio/sunxi_gpio.c b/drivers/gpio/sunxi_gpio.c index cdbc40d48f..caefb1447c 100644 --- a/drivers/gpio/sunxi_gpio.c +++ b/drivers/gpio/sunxi_gpio.c @@ -225,7 +225,7 @@ static const struct dm_gpio_ops gpio_sunxi_ops = { * GPIO banks are named A, B, C, ... * * @bank: Bank number (0, 1..n-1) - * @return allocated string containing the name + * Return: allocated string containing the name */ static char *gpio_bank_name(int bank) { diff --git a/drivers/gpio/tegra_gpio.c b/drivers/gpio/tegra_gpio.c index e00f104b9f..4291e496fa 100644 --- a/drivers/gpio/tegra_gpio.c +++ b/drivers/gpio/tegra_gpio.c @@ -264,7 +264,7 @@ static const struct dm_gpio_ops gpio_tegra_ops = { * GPIOs are named A, B, C, ..., Z, AA, BB, CC, ... * * @base_port: Base port number (0, 1..n-1) - * @return allocated string containing the name + * Return: allocated string containing the name */ static char *gpio_port_name(int base_port) { diff --git a/drivers/i2c/designware_i2c.c b/drivers/i2c/designware_i2c.c index d95f77649e..1aae6b64ba 100644 --- a/drivers/i2c/designware_i2c.c +++ b/drivers/i2c/designware_i2c.c @@ -57,7 +57,7 @@ enum { * * @ic_clk: Input clock in Hz * @period_ns: Period to represent, in ns - * @return calculated count + * Return: calculated count */ static uint calc_counts(uint ic_clk, uint period_ns) { @@ -123,7 +123,7 @@ static const struct i2c_mode_info info_for_mode[] = { * @ic_clk: IC clock speed in Hz * @spk_cnt: Spike-suppression count * @config: Returns value to use - * @return 0 if OK, -EINVAL if the calculation failed due to invalid data + * Return: 0 if OK, -EINVAL if the calculation failed due to invalid data */ static int dw_i2c_calc_timing(struct dw_i2c *priv, enum i2c_speed_mode mode, int ic_clk, int spk_cnt, @@ -202,7 +202,7 @@ static int dw_i2c_calc_timing(struct dw_i2c *priv, enum i2c_speed_mode mode, * @speed: Required i2c speed in Hz * @bus_clk: Input clock to the I2C controller in Hz (e.g. IC_CLK) * @config: Returns the config to use for this speed - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int calc_bus_speed(struct dw_i2c *priv, struct i2c_regs *regs, int speed, ulong bus_clk, struct dw_i2c_speed_config *config) @@ -271,7 +271,7 @@ static int calc_bus_speed(struct dw_i2c *priv, struct i2c_regs *regs, int speed, * @i2c_base: Registers for the I2C controller * @speed: Required i2c speed in Hz * @bus_clk: Input clock to the I2C controller in Hz (e.g. IC_CLK) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int _dw_i2c_set_bus_speed(struct dw_i2c *priv, struct i2c_regs *i2c_base, unsigned int speed, unsigned int bus_clk) diff --git a/drivers/i2c/designware_i2c.h b/drivers/i2c/designware_i2c.h index b56d7dd22f..a9c50c90ac 100644 --- a/drivers/i2c/designware_i2c.h +++ b/drivers/i2c/designware_i2c.h @@ -223,7 +223,7 @@ int designware_i2c_of_to_plat(struct udevice *bus); * @dev: I2C bus to check * @speed_hz: Requested speed in Hz * @config: Returns config to use for that speed - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dw_i2c_gen_speed_config(const struct udevice *dev, int speed_hz, struct dw_i2c_speed_config *config); diff --git a/drivers/i2c/i2c-uclass.c b/drivers/i2c/i2c-uclass.c index 71bc2b5b8a..5539becc19 100644 --- a/drivers/i2c/i2c-uclass.c +++ b/drivers/i2c/i2c-uclass.c @@ -53,7 +53,7 @@ void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs) * @offset: Byte offset within chip * @offset_buf: Place to put byte offset * @msg: Message buffer - * @return 0 if OK, -EADDRNOTAVAIL if the offset length is 0. In that case the + * Return: 0 if OK, -EADDRNOTAVAIL if the offset length is 0. In that case the * message is still set up but will not contain an offset. */ static int i2c_setup_offset(struct dm_i2c_chip *chip, uint offset, @@ -268,7 +268,7 @@ int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set) * @bus: Bus to probe * @chip_addr: Chip address to probe * @flags: Flags for the chip - * @return 0 if found, -ENOSYS if the driver is invalid, -EREMOTEIO if the chip + * Return: 0 if found, -ENOSYS if the driver is invalid, -EREMOTEIO if the chip * does not respond to probe */ static int i2c_probe_chip(struct udevice *bus, uint chip_addr, diff --git a/drivers/i2c/mvtwsi.c b/drivers/i2c/mvtwsi.c index ff21e3c52b..bad4b1484f 100644 --- a/drivers/i2c/mvtwsi.c +++ b/drivers/i2c/mvtwsi.c @@ -177,7 +177,7 @@ enum mvtwsi_ack_flags { * calc_tick() - Calculate the duration of a clock cycle from the I2C speed * * @speed: The speed in Hz to calculate the clock cycle duration for. - * @return The duration of a clock cycle in ns. + * Return: The duration of a clock cycle in ns. */ inline uint calc_tick(uint speed) { @@ -192,7 +192,7 @@ inline uint calc_tick(uint speed) * twsi_get_base() - Get controller register base for specified adapter * * @adap: Adapter to get the register base for. - * @return Register base for the specified adapter. + * Return: Register base for the specified adapter. */ static struct mvtwsi_registers *twsi_get_base(struct i2c_adapter *adap) { @@ -251,7 +251,7 @@ enum mvtwsi_error_class { * @lc: The last value of the control register. * @ls: The last value of the status register. * @es: The expected value of the status register. - * @return The generated error code. + * Return: The generated error code. */ inline uint mvtwsi_error(uint ec, uint lc, uint ls, uint es) { @@ -264,7 +264,7 @@ inline uint mvtwsi_error(uint ec, uint lc, uint ls, uint es) /* * twsi_wait() - Wait for I2C bus interrupt flag and check status, or time out. * - * @return Zero if status is as expected, or a non-zero code if either a time + * Return: Zero if status is as expected, or a non-zero code if either a time * out occurred, or the status was not the expected one. */ static int twsi_wait(struct mvtwsi_registers *twsi, int expected_status, @@ -312,7 +312,7 @@ static int twsi_wait(struct mvtwsi_registers *twsi, int expected_status, * @expected_status: The I2C bus status expected to be asserted after the * operation completion. * @tick: The duration of a clock cycle at the current I2C speed. - * @return Zero if status is as expected, or a non-zero code if either a time + * Return: Zero if status is as expected, or a non-zero code if either a time * out occurred or the status was not the expected one. */ static int twsi_start(struct mvtwsi_registers *twsi, int expected_status, @@ -335,7 +335,7 @@ static int twsi_start(struct mvtwsi_registers *twsi, int expected_status, * @expected_status: The I2C bus status expected to be asserted after the * operation completion. * @tick: The duration of a clock cycle at the current I2C speed. - * @return Zero if status is as expected, or a non-zero code if either a time + * Return: Zero if status is as expected, or a non-zero code if either a time * out occurred or the status was not the expected one. */ static int twsi_send(struct mvtwsi_registers *twsi, u8 byte, @@ -360,7 +360,7 @@ static int twsi_send(struct mvtwsi_registers *twsi, u8 byte, * @ack_flag: Flag that determines whether the received byte should * be acknowledged by the controller or not (sent ACK/NAK). * @tick: The duration of a clock cycle at the current I2C speed. - * @return Zero if status is as expected, or a non-zero code if either a time + * Return: Zero if status is as expected, or a non-zero code if either a time * out occurred or the status was not the expected one. */ static int twsi_recv(struct mvtwsi_registers *twsi, u8 *byte, int ack_flag, @@ -391,7 +391,7 @@ static int twsi_recv(struct mvtwsi_registers *twsi, u8 *byte, int ack_flag, * * @twsi: The MVTWSI register structure to use. * @tick: The duration of a clock cycle at the current I2C speed. - * @return Zero if the operation succeeded, or a non-zero code if a time out + * Return: Zero if the operation succeeded, or a non-zero code if a time out * occurred. */ static int twsi_stop(struct mvtwsi_registers *twsi, uint tick) @@ -422,7 +422,7 @@ static int twsi_stop(struct mvtwsi_registers *twsi, uint tick) * * @n: Parameter 'n' for the frequency calculation algorithm. * @m: Parameter 'm' for the frequency calculation algorithm. - * @return The I2C frequency corresponding to the passed m and n parameters. + * Return: The I2C frequency corresponding to the passed m and n parameters. */ static uint twsi_calc_freq(const int n, const int m) { @@ -458,7 +458,7 @@ static void twsi_reset(struct mvtwsi_registers *twsi) * @twsi: The MVTWSI register structure to use. * @requested_speed: The desired frequency the controller should run at * in Hz. - * @return The actual frequency the controller was configured to. + * Return: The actual frequency the controller was configured to. */ static uint __twsi_i2c_set_bus_speed(struct mvtwsi_registers *twsi, uint requested_speed) @@ -500,7 +500,7 @@ static uint __twsi_i2c_set_bus_speed(struct mvtwsi_registers *twsi, * @slaveadd: The I2C address to be set for the I2C master. * @actual_speed: A output parameter that receives the actual frequency * in Hz the controller was set to by the function. - * @return Zero if the operation succeeded, or a non-zero code if a time out + * Return: Zero if the operation succeeded, or a non-zero code if a time out * occurred. */ static void __twsi_i2c_init(struct mvtwsi_registers *twsi, int speed, @@ -539,7 +539,7 @@ static void __twsi_i2c_init(struct mvtwsi_registers *twsi, int speed, * @addr: The address byte to be sent. * @tick: The duration of a clock cycle at the current * I2C speed. - * @return Zero if the operation succeeded, or a non-zero code if a time out or + * Return: Zero if the operation succeeded, or a non-zero code if a time out or * unexpected I2C status occurred. */ static int i2c_begin(struct mvtwsi_registers *twsi, int expected_start_status, @@ -571,7 +571,7 @@ static int i2c_begin(struct mvtwsi_registers *twsi, int expected_start_status, * @twsi: The MVTWSI register structure to use. * @chip: The chip address to probe. * @tick: The duration of a clock cycle at the current I2C speed. - * @return Zero if the operation succeeded, or a non-zero code if a time out or + * Return: Zero if the operation succeeded, or a non-zero code if a time out or * unexpected I2C status occurred. */ static int __twsi_i2c_probe_chip(struct mvtwsi_registers *twsi, uchar chip, @@ -610,7 +610,7 @@ static int __twsi_i2c_probe_chip(struct mvtwsi_registers *twsi, uchar chip, * a size of at least 'length' bytes). * @length: The amount of data to be read from the chip in bytes. * @tick: The duration of a clock cycle at the current I2C speed. - * @return Zero if the operation succeeded, or a non-zero code if a time out or + * Return: Zero if the operation succeeded, or a non-zero code if a time out or * unexpected I2C status occurred. */ static int __twsi_i2c_read(struct mvtwsi_registers *twsi, uchar chip, @@ -659,7 +659,7 @@ static int __twsi_i2c_read(struct mvtwsi_registers *twsi, uchar chip, * @data: The buffer containing the data to be sent to the chip. * @length: The length of data to be sent to the chip in bytes. * @tick: The duration of a clock cycle at the current I2C speed. - * @return Zero if the operation succeeded, or a non-zero code if a time out or + * Return: Zero if the operation succeeded, or a non-zero code if a time out or * unexpected I2C status occurred. */ static int __twsi_i2c_write(struct mvtwsi_registers *twsi, uchar chip, diff --git a/drivers/i2c/octeon_i2c.c b/drivers/i2c/octeon_i2c.c index ea2cc33f9d..50199ff46e 100644 --- a/drivers/i2c/octeon_i2c.c +++ b/drivers/i2c/octeon_i2c.c @@ -193,7 +193,7 @@ static int twsi_stop(void *base); * * @code status code * @final_read true if this is the final read operation - * @return true if arbitration has been lost, false if it hasn't been lost. + * Return: true if arbitration has been lost, false if it hasn't been lost. */ static int twsi_i2c_lost_arb(u8 code, int final_read) { @@ -249,7 +249,7 @@ static int twsi_i2c_lost_arb(u8 code, int final_read) * * @base Base address of i2c registers * @val value to write - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static u64 twsi_write_sw(void __iomem *base, u64 val) { @@ -274,7 +274,7 @@ static u64 twsi_write_sw(void __iomem *base, u64 val) * * @base Base address of i2c registers * @val value for eia and op, etc. to read - * @return value of the register + * Return: value of the register */ static u64 twsi_read_sw(void __iomem *base, u64 val) { @@ -316,7 +316,7 @@ static void twsi_write_ctl(void __iomem *base, u8 data) * Reads the TWSI Control Register * * @base Base address for i2c - * @return 8-bit TWSI control register + * Return: 8-bit TWSI control register */ static u8 twsi_read_ctl(void __iomem *base) { @@ -334,7 +334,7 @@ static u8 twsi_read_ctl(void __iomem *base) * Read i2c status register * * @base Base address of i2c registers - * @return value of status register + * Return: value of status register */ static u8 twsi_read_status(void __iomem *base) { @@ -350,7 +350,7 @@ static u8 twsi_read_status(void __iomem *base) * Waits for an i2c operation to complete * * @param base Base address of registers - * @return 0 for success, 1 if timeout + * Return: 0 for success, 1 if timeout */ static int twsi_wait(void __iomem *base) { @@ -384,7 +384,7 @@ static int twsi_start_unstick(void __iomem *base) * Sends an i2c start condition * * @base base address of registers - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int twsi_start(void __iomem *base) { @@ -415,7 +415,7 @@ static int twsi_start(void __iomem *base) * Sends an i2c stop condition * * @base register base address - * @return 0 for success, -1 if error + * Return: 0 for success, -1 if error */ static int twsi_stop(void __iomem *base) { @@ -439,7 +439,7 @@ static int twsi_stop(void __iomem *base) * @slave_addr address of slave to write to * @buffer Pointer to buffer to write * @length Number of bytes in buffer to write - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int twsi_write_data(void __iomem *base, u8 slave_addr, u8 *buffer, unsigned int length) @@ -537,7 +537,7 @@ static void twsi_unblock(void __iomem *base) * @slave_addr i2c bus address to read from * @buffer buffer to read into * @length number of bytes to read - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int twsi_read_data(void __iomem *base, u8 slave_addr, u8 *buffer, unsigned int length) @@ -605,7 +605,7 @@ static int twsi_read_data(void __iomem *base, u8 slave_addr, * @speed Speed to set * @m_div Pointer to M divisor * @n_div Pointer to N divisor - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static void twsi_calc_div(struct udevice *bus, ulong sclk, unsigned int speed, int *m_div, int *n_div) @@ -651,7 +651,7 @@ static void twsi_calc_div(struct udevice *bus, ulong sclk, unsigned int speed, * * @base Base address of twsi registers * @slave_addr I2C slave address to configure this controller to - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int twsi_init(void __iomem *base, int slaveaddr) { @@ -681,7 +681,7 @@ static int twsi_init(void __iomem *base, int slaveaddr) * @bus i2c bus to transfer data over * @msg Array of i2c messages * @nmsgs Number of messages to send/receive - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int octeon_i2c_xfer(struct udevice *bus, struct i2c_msg *msg, int nmsgs) @@ -718,7 +718,7 @@ static int octeon_i2c_xfer(struct udevice *bus, struct i2c_msg *msg, * * @bus i2c bus to transfer data over * @speed Speed in Hz to set - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int octeon_i2c_set_bus_speed(struct udevice *bus, unsigned int speed) { @@ -773,7 +773,7 @@ static const struct octeon_i2c_data i2c_octeontx2_data = { * Driver probe function * * @dev I2C device to probe - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int octeon_i2c_probe(struct udevice *dev) { diff --git a/drivers/i2c/s3c24x0_i2c.c b/drivers/i2c/s3c24x0_i2c.c index e0f499d759..aaccb3aa22 100644 --- a/drivers/i2c/s3c24x0_i2c.c +++ b/drivers/i2c/s3c24x0_i2c.c @@ -27,7 +27,7 @@ DECLARE_GLOBAL_DATA_PTR; * Wait til the byte transfer is completed. * * @param i2c- pointer to the appropriate i2c register bank. - * @return I2C_OK, if transmission was ACKED + * Return: I2C_OK, if transmission was ACKED * I2C_NACK, if transmission was NACKED * I2C_NOK_TIMEOUT, if transaction did not complete in I2C_TIMEOUT_MS */ diff --git a/drivers/input/cros_ec_keyb.c b/drivers/input/cros_ec_keyb.c index dc3b08c0f6..c485346373 100644 --- a/drivers/input/cros_ec_keyb.c +++ b/drivers/input/cros_ec_keyb.c @@ -38,7 +38,7 @@ struct cros_ec_keyb_priv { * @param keys List of keys that we have detected * @param max_count Maximum number of keys to return * @param samep Set to true if this scan repeats the last, else false - * @return number of pressed keys, 0 for none, -EIO on error + * Return: number of pressed keys, 0 for none, -EIO on error */ static int check_for_keys(struct udevice *dev, struct key_matrix_key *keys, int max_count, bool *samep) @@ -112,7 +112,7 @@ static int check_for_keys(struct udevice *dev, struct key_matrix_key *keys, * characters * * @param input Input configuration - * @return 1, to indicate that we have something to look at + * Return: 1, to indicate that we have something to look at */ int cros_ec_kbc_check(struct input_config *input) { @@ -176,7 +176,7 @@ int cros_ec_kbc_check(struct input_config *input) * @param blob Device tree blob * @param node Node to decode from * @param config Configuration data read from fdt - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int cros_ec_keyb_decode_fdt(struct udevice *dev, struct cros_ec_keyb_priv *config) diff --git a/drivers/input/i8042.c b/drivers/input/i8042.c index d3743dc37f..3563dc9883 100644 --- a/drivers/input/i8042.c +++ b/drivers/input/i8042.c @@ -78,7 +78,7 @@ static int kbd_output_full(void) * check_leds() - Check the keyboard LEDs and update them it needed * * @ret: Value to return - * @return value of @ret + * Return: value of @ret */ static int i8042_kbd_update_leds(struct udevice *dev, int leds) { @@ -199,7 +199,7 @@ static void i8042_flush(void) * Disables the keyboard so that key strokes no longer generate scancodes to * the host. * - * @return 0 if ok, -1 if keyboard input was found while disabling + * Return: 0 if ok, -1 if keyboard input was found while disabling */ static int i8042_disable(void) { @@ -312,7 +312,7 @@ static int i8042_kbd_remove(struct udevice *dev) * wait for the keyboard to init. We do this only when a key is first * read - see kbd_wait_for_fifo_init(). * - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ static int i8042_kbd_probe(struct udevice *dev) { diff --git a/drivers/input/input.c b/drivers/input/input.c index c1c5e428dc..a4341e8c7c 100644 --- a/drivers/input/input.c +++ b/drivers/input/input.c @@ -253,7 +253,7 @@ int input_getc(struct input_config *config) * @param config Input state * @param key Key code to process * @param release 0 if a press, 1 if a release - * @return pointer to keycode->ascii translation table that should be used + * Return: pointer to keycode->ascii translation table that should be used */ static struct input_key_xlate *process_modifier(struct input_config *config, int key, int release) @@ -322,7 +322,7 @@ static struct input_key_xlate *process_modifier(struct input_config *config, * @param array Array to search * @param count Number of elements in array * @param key Key value to find - * @return element where value was first found, -1 if none + * Return: element where value was first found, -1 if none */ static int array_search(int *array, int count, int key) { @@ -347,7 +347,7 @@ static int array_search(int *array, int count, int key) * @param count Number of elements to sort * @param order Array containing ordering elements * @param ocount Number of ordering elements - * @return number of elements in dest that are in order (these will be at the + * Return: number of elements in dest that are in order (these will be at the * start of dest). */ static int sort_array_by_ordering(int *dest, int count, int *order, @@ -417,7 +417,7 @@ static int input_check_keycodes(struct input_config *config, * be at least ANSI_CHAR_MAX bytes long, to allow for * an ANSI sequence. * @param max_chars Maximum number of characters to add to output_ch - * @return number of characters output, if the key was converted, otherwise 0. + * Return: number of characters output, if the key was converted, otherwise 0. * This may be larger than max_chars, in which case the overflow * characters are not output. */ @@ -462,7 +462,7 @@ static int input_keycode_to_ansi364(struct input_config *config, * ANSI sequences. * @param max_chars Maximum number of characters to add to output_ch * @param same Number of key codes which are the same - * @return number of characters written into output_ch, or -1 if we would + * Return: number of characters written into output_ch, or -1 if we would * exceed max_chars chars. */ static int input_keycodes_to_ascii(struct input_config *config, diff --git a/drivers/input/key_matrix.c b/drivers/input/key_matrix.c index 4631728b8b..e2fb2e1707 100644 --- a/drivers/input/key_matrix.c +++ b/drivers/input/key_matrix.c @@ -22,7 +22,7 @@ * @param config Keyboard matrix config * @param keys List of keys to check * @param valid Number of valid keypresses to check - * @return 0 if no ghosting is possible, 1 if it is + * Return: 0 if no ghosting is possible, 1 if it is */ static int has_ghosting(struct key_matrix *config, struct key_matrix_key *keys, int valid) @@ -103,7 +103,7 @@ int key_matrix_decode(struct key_matrix *config, struct key_matrix_key keys[], * @param len Number of entries in keycode table * @param map_keycode Key code to find in the map * @param pos Returns position of map_keycode, if found, else -1 - * @return map Pointer to allocated map + * Return: map Pointer to allocated map */ static uchar *create_keymap(struct key_matrix *config, const u32 *data, int len, int map_keycode, int *pos) diff --git a/drivers/input/tegra-kbc.c b/drivers/input/tegra-kbc.c index 5113041d3e..d4741a7666 100644 --- a/drivers/input/tegra-kbc.c +++ b/drivers/input/tegra-kbc.c @@ -66,7 +66,7 @@ struct tegra_kbd_priv { * @param priv Keyboard private data * @param fifo Place to put fifo results * @param max_keycodes Maximum number of key codes to put in the fifo - * @return number of items put into fifo + * Return: number of items put into fifo */ static int tegra_kbc_find_keys(struct tegra_kbd_priv *priv, int *fifo, int max_keycodes) @@ -179,7 +179,7 @@ static void kbd_wait_for_fifo_init(struct tegra_kbd_priv *priv) * characters * * @param input Input configuration - * @return 1, to indicate that we have something to look at + * Return: 1, to indicate that we have something to look at */ static int tegra_kbc_check(struct input_config *input) { @@ -281,7 +281,7 @@ static int tegra_kbd_start(struct udevice *dev) * wait for the keyboard to init. We do this only when a key is first * read - see kbd_wait_for_fifo_init(). * - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ static int tegra_kbd_probe(struct udevice *dev) { diff --git a/drivers/misc/cros_ec.c b/drivers/misc/cros_ec.c index c627c1df6c..e131eccd28 100644 --- a/drivers/misc/cros_ec.c +++ b/drivers/misc/cros_ec.c @@ -117,7 +117,7 @@ void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len) * * @param data Data block to checksum * @param size Size of data block in bytes - * @return checksum value (0 to 255) + * Return: checksum value (0 to 255) */ int cros_ec_calc_checksum(const uint8_t *data, int size) { @@ -138,7 +138,7 @@ int cros_ec_calc_checksum(const uint8_t *data, int size) * @param cmd_version Version of command to send (EC_VER_...) * @param dout Output data (may be NULL If dout_len=0) * @param dout_len Size of output data in bytes - * @return packet size in bytes, or <0 if error. + * Return: packet size in bytes, or <0 if error. */ static int create_proto3_request(struct cros_ec_dev *cdev, int cmd, int cmd_version, @@ -178,7 +178,7 @@ static int create_proto3_request(struct cros_ec_dev *cdev, * * @param dev CROS-EC device * @param din_len Maximum size of response in bytes - * @return maximum expected number of bytes in response, or <0 if error. + * Return: maximum expected number of bytes in response, or <0 if error. */ static int prepare_proto3_response_buffer(struct cros_ec_dev *cdev, int din_len) { @@ -202,7 +202,7 @@ static int prepare_proto3_response_buffer(struct cros_ec_dev *cdev, int din_len) * @param dev CROS-EC device * @param dinp Returns pointer to response data * @param din_len Maximum size of response in bytes - * @return number of bytes of response data, or <0 if error. Note that error + * Return: number of bytes of response data, or <0 if error. Note that error * codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they * overlap!) */ @@ -318,7 +318,7 @@ static int send_command(struct cros_ec_dev *dev, uint cmd, int cmd_version, * If not NULL, it will be updated to point to the data * and will always be double word aligned (64-bits) * @param din_len Maximum size of response in bytes - * @return number of bytes in response, or -ve on error + * Return: number of bytes in response, or -ve on error */ static int ec_command_inptr(struct udevice *dev, uint cmd, int cmd_version, const void *dout, int dout_len, @@ -385,7 +385,7 @@ static int ec_command_inptr(struct udevice *dev, uint cmd, * It not NULL, it is a place for ec_command() to copy the * data to. * @param din_len Maximum size of response in bytes - * @return number of bytes in response, or -ve on error + * Return: number of bytes in response, or -ve on error */ static int ec_command(struct udevice *dev, uint cmd, int cmd_version, const void *dout, int dout_len, @@ -872,7 +872,7 @@ int cros_ec_flash_erase(struct udevice *dev, uint32_t offset, uint32_t size) * @param data Pointer to data buffer to write * @param offset Offset within flash to write to. * @param size Number of bytes to write - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int cros_ec_flash_write_block(struct udevice *dev, const uint8_t *data, uint32_t offset, uint32_t size) @@ -913,7 +913,7 @@ static int cros_ec_flash_write_burst_size(struct udevice *dev) * * @param data Pointer to data to check (must be word-aligned) * @param size Number of bytes to check (must be word-aligned) - * @return 0 if erased, non-zero if any word is not erased + * Return: 0 if erased, non-zero if any word is not erased */ static int cros_ec_data_is_erased(const uint32_t *data, int size) { @@ -985,7 +985,7 @@ int cros_ec_flash_write(struct udevice *dev, const uint8_t *data, * * @param me CrosEc instance * @param region Region to run verification on - * @return 0 if success or not applicable. Non-zero if verification failed. + * Return: 0 if success or not applicable. Non-zero if verification failed. */ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region) { @@ -1022,7 +1022,7 @@ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region) * @param data Pointer to data buffer to read into * @param offset Offset within flash to read from * @param size Number of bytes to read - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int cros_ec_flash_read_block(struct udevice *dev, uint8_t *data, uint32_t offset, uint32_t size) diff --git a/drivers/misc/cros_ec_lpc.c b/drivers/misc/cros_ec_lpc.c index f40375978d..1a8a81349c 100644 --- a/drivers/misc/cros_ec_lpc.c +++ b/drivers/misc/cros_ec_lpc.c @@ -186,7 +186,7 @@ int cros_ec_lpc_command(struct udevice *udev, uint8_t cmd, int cmd_version, * * @param dev CROS_EC device * @param blob Device tree blob - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_lpc_init(struct cros_ec_dev *dev, const void *blob) { diff --git a/drivers/misc/cros_ec_sandbox.c b/drivers/misc/cros_ec_sandbox.c index 2173517cff..8dbe0b188a 100644 --- a/drivers/misc/cros_ec_sandbox.c +++ b/drivers/misc/cros_ec_sandbox.c @@ -186,7 +186,7 @@ SANDBOX_STATE_IO(cros_ec, "google,cros-ec", cros_ec_read_state, * * @param ec Current emulated EC state * @param entry Flash map entry containing the image to check - * @return actual image size in bytes, 0 if the image contains no content or + * Return: actual image size in bytes, 0 if the image contains no content or * error. */ static int get_image_used(struct ec_state *ec, struct fmap_entry *entry) @@ -214,7 +214,7 @@ static int get_image_used(struct ec_state *ec, struct fmap_entry *entry) * * @param ec Current emulated EC state * @param node Keyboard node of device tree containing keyscan information - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int keyscan_read_fdt_matrix(struct ec_state *ec, ofnode node) { @@ -263,7 +263,7 @@ static int keyscan_read_fdt_matrix(struct ec_state *ec, ofnode node) * @param ec Current emulated EC state * @param scan Place to put keyscan bytes for the keyscan message (must hold * enough space for a full keyscan) - * @return number of bytes of valid scan data + * Return: number of bytes of valid scan data */ static int cros_ec_keyscan(struct ec_state *ec, uint8_t *scan) { @@ -305,7 +305,7 @@ static int cros_ec_keyscan(struct ec_state *ec, uint8_t *scan) * @param req_data Pointer to body of request * @param resp_hdr Pointer to place to put response header * @param resp_data Pointer to place to put response data, if any - * @return length of response data, or 0 for no response data, or -1 on error + * Return: length of response data, or 0 for no response data, or -1 on error */ static int process_cmd(struct ec_state *ec, struct ec_host_request *req_hdr, const void *req_data, diff --git a/drivers/misc/cros_ec_spi.c b/drivers/misc/cros_ec_spi.c index bbc96301ae..001f0a85ca 100644 --- a/drivers/misc/cros_ec_spi.c +++ b/drivers/misc/cros_ec_spi.c @@ -75,7 +75,7 @@ done: * @param dinp Returns pointer to response data. This will be * untouched unless we return a value > 0. * @param din_len Maximum size of response in bytes - * @return number of bytes in response, or -1 on error + * Return: number of bytes in response, or -1 on error */ int cros_ec_spi_command(struct udevice *udev, uint8_t cmd, int cmd_version, const uint8_t *dout, int dout_len, diff --git a/drivers/mmc/mmc.c b/drivers/mmc/mmc.c index 4d9871d69f..f6ccd837aa 100644 --- a/drivers/mmc/mmc.c +++ b/drivers/mmc/mmc.c @@ -215,7 +215,7 @@ int mmc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data) * @data: additional data to send/receive * @retries: how many times to retry; mmc_send_cmd is always called at least * once - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ static int mmc_send_cmd_retry(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data, uint retries) @@ -239,7 +239,7 @@ static int mmc_send_cmd_retry(struct mmc *mmc, struct mmc_cmd *cmd, * @quirk: retry only if this quirk is enabled * @retries: how many times to retry; mmc_send_cmd is always called at least * once - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ static int mmc_send_cmd_quirks(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data, u32 quirk, uint retries) diff --git a/drivers/mmc/mmc_private.h b/drivers/mmc/mmc_private.h index a6cd250d29..b32123758e 100644 --- a/drivers/mmc/mmc_private.h +++ b/drivers/mmc/mmc_private.h @@ -91,7 +91,7 @@ static inline void mmc_trace_state(struct mmc *mmc, struct mmc_cmd *cmd) /** * mmc_get_next_devnum() - Get the next available MMC device number * - * @return next available device number (0 = first), or -ve on error + * Return: next available device number (0 = first), or -ve on error */ int mmc_get_next_devnum(void); @@ -117,7 +117,7 @@ void mmc_list_add(struct mmc *mmc); * * @mmc: MMC device * @part_num: Hardware partition number - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_switch_part(struct mmc *mmc, unsigned int part_num); @@ -128,7 +128,7 @@ int mmc_switch_part(struct mmc *mmc, unsigned int part_num); * @set: Unused * @index: Cmdarg index * @value: Cmdarg value - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_switch(struct mmc *mmc, u8 set, u8 index, u8 value); diff --git a/drivers/mmc/mmc_spi.c b/drivers/mmc/mmc_spi.c index e2d78794f2..bcea800e5f 100644 --- a/drivers/mmc/mmc_spi.c +++ b/drivers/mmc/mmc_spi.c @@ -83,7 +83,7 @@ struct mmc_spi_priv { * @resp_match: if true, compare each of received bytes with @resp_match_value * @resp_match_value: a value to be compared with each of received bytes * @r1b: if true, receive additional bytes for busy signal token - * @return 0 if OK, -ETIMEDOUT if no card response is received, -ve on error + * Return: 0 if OK, -ETIMEDOUT if no card response is received, -ve on error */ static int mmc_spi_sendcmd(struct udevice *dev, ushort cmdidx, u32 cmdarg, u32 resp_type, @@ -181,7 +181,7 @@ static int mmc_spi_sendcmd(struct udevice *dev, * @xbuf: buffer of the actual data (excluding token and crc) to read * @bcnt: number of data blocks to transfer * @bsize: size of the actual data (excluding token and crc) in bytes - * @return 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors + * Return: 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors */ static int mmc_spi_readdata(struct udevice *dev, void *xbuf, u32 bcnt, u32 bsize) @@ -239,7 +239,7 @@ static int mmc_spi_readdata(struct udevice *dev, * @bcnt: number of data blocks to transfer * @bsize: size of actual data (excluding token and crc) in bytes * @multi: indicate a transfer by multiple block write command (CMD25) - * @return 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors + * Return: 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors */ static int mmc_spi_writedata(struct udevice *dev, const void *xbuf, u32 bcnt, u32 bsize, int multi) diff --git a/drivers/mmc/octeontx_hsmmc.c b/drivers/mmc/octeontx_hsmmc.c index 2e569a9e0f..f0519f0cf8 100644 --- a/drivers/mmc/octeontx_hsmmc.c +++ b/drivers/mmc/octeontx_hsmmc.c @@ -780,7 +780,7 @@ static const struct octeontx_sd_mods octeontx_cr_types[] = { * @param mmc mmc device * @param cmd command information * - * @return octeontx_mmc_cr_mods data structure with various quirks and flags + * Return: octeontx_mmc_cr_mods data structure with various quirks and flags */ static struct octeontx_mmc_cr_mods octeontx_mmc_get_cr_mods(struct mmc *mmc, const struct mmc_cmd *cmd, @@ -993,7 +993,7 @@ static void octeontx_mmc_start_dma(struct mmc *mmc, bool write, * @param mmc mmc device * @param timeout timeout in ms * - * @return 0 for success (could be DMA errors), -ETIMEDOUT on timeout + * Return: 0 for success (could be DMA errors), -ETIMEDOUT on timeout */ /** @@ -1042,7 +1042,7 @@ static void octeontx_mmc_cleanup_dma(struct mmc *mmc, * @param timeout timeout in ms * @param verbose true to print out error information * - * @return 0 for success (could be DMA errors), -ETIMEDOUT on timeout + * Return: 0 for success (could be DMA errors), -ETIMEDOUT on timeout * or -EIO if IO error. */ static int octeontx_mmc_wait_dma(struct mmc *mmc, bool write, ulong timeout, @@ -1140,7 +1140,7 @@ static int octeontx_mmc_wait_dma(struct mmc *mmc, bool write, ulong timeout, * @param data data for read * @param verbose true to print out error information * - * @return number of blocks read or 0 if error + * Return: number of blocks read or 0 if error */ static int octeontx_mmc_read_blocks(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data, bool verbose) @@ -1342,7 +1342,7 @@ static ulong octeontx_mmc_write_blocks(struct mmc *mmc, struct mmc_cmd *cmd, * @param cmd cmd to send and response * @param data additional data * @param flags - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ static int octeontx_mmc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data) @@ -2021,7 +2021,7 @@ struct adj adj[] = { * @param adj parameter to tune * @param opcode command opcode to use * - * @return 0 for success, -1 if tuning failed + * Return: 0 for success, -1 if tuning failed */ static int octeontx_mmc_adjust_tuning(struct mmc *mmc, struct adj *adj, u32 opcode) @@ -2426,7 +2426,7 @@ static void octeontx_mmc_set_emm_timing(struct mmc *mmc, * Calculate the clock period with rounding up * * @param mmc mmc device - * @return clock period in system clocks for clk_lo + clk_hi + * Return: clock period in system clocks for clk_lo + clk_hi */ static u32 octeontx_mmc_calc_clk_period(struct mmc *mmc) { @@ -2916,7 +2916,7 @@ static void do_switch(struct mmc *mmc, union mio_emm_switch emm_switch) * * @param mmc Pointer to mmc data structure * - * @return 0 for success or -ETIMEDOUT on error + * Return: 0 for success or -ETIMEDOUT on error * * NOTE: On error a default value will be calculated. */ @@ -2942,7 +2942,7 @@ static int octeontx_mmc_calibrate_delay(struct mmc *mmc) * @param mmc mmc data structure * @param delay delay in picoseconds * - * @return Number of tap cycles or error if -1 + * Return: Number of tap cycles or error if -1 */ static int octeontx2_mmc_calc_delay(struct mmc *mmc, int delay) { @@ -3136,7 +3136,7 @@ static int octeontx_mmc_set_input_bus_timing(struct mmc *mmc) * * @param mmc mmc data structure * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ static int octeontx_mmc_set_output_bus_timing(struct mmc *mmc) { @@ -3369,7 +3369,7 @@ static void octeontx_mmc_switch_to(struct mmc *mmc) * * @param mmc mmc device * - * @return 0 for success + * Return: 0 for success * * NOTE: This will need to be updated when new silicon comes out */ @@ -3395,7 +3395,7 @@ static int octeontx_mmc_init_timing(struct mmc *mmc) * * @param mmc mmc device * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ static int octeontx_mmc_init_lowlevel(struct mmc *mmc) { @@ -3453,7 +3453,7 @@ static int octeontx_mmc_init_lowlevel(struct mmc *mmc) * * @param voltage voltage in microvolts * - * @return MMC register value for voltage + * Return: MMC register value for voltage */ static u32 xlate_voltage(u32 voltage) { @@ -3506,7 +3506,7 @@ static u32 xlate_voltage(u32 voltage) * * @param dev slot device to check * - * @return true if status reports "ok" or "okay" or if no status, + * Return: true if status reports "ok" or "okay" or if no status, * false otherwise. */ static bool octeontx_mmc_get_valid(struct udevice *dev) @@ -3524,7 +3524,7 @@ static bool octeontx_mmc_get_valid(struct udevice *dev) * * @param dev slot device * - * @return 0 on success, otherwise error + * Return: 0 on success, otherwise error */ static int octeontx_mmc_get_config(struct udevice *dev) { @@ -3705,7 +3705,7 @@ static int octeontx_mmc_get_config(struct udevice *dev) * * @param dev mmc device * - * @return 0 for success, error otherwise + * Return: 0 for success, error otherwise */ static int octeontx_mmc_slot_probe(struct udevice *dev) { @@ -3802,7 +3802,7 @@ U_BOOT_DRIVER(octeontx_hsmmc_slot) = { * * @param dev mmc host controller device * - * @return 0 for success, -1 on error + * Return: 0 for success, -1 on error */ static int octeontx_mmc_host_probe(struct udevice *dev) { @@ -3910,7 +3910,7 @@ static int octeontx_mmc_host_probe(struct udevice *dev) * * @param dev: MMC slot device * - * @return 0 for success, -1 on failure + * Return: 0 for success, -1 on failure * * Do some pre-initialization before probing a slot. */ diff --git a/drivers/mmc/sdhci-adma.c b/drivers/mmc/sdhci-adma.c index 2ec057fbb1..8213223d3f 100644 --- a/drivers/mmc/sdhci-adma.c +++ b/drivers/mmc/sdhci-adma.c @@ -64,7 +64,7 @@ void sdhci_prepare_adma_table(struct sdhci_adma_desc *table, /** * sdhci_adma_init() - initialize the ADMA descriptor table * - * @return pointer to the allocated descriptor table or NULL in case of an + * Return: pointer to the allocated descriptor table or NULL in case of an * error. */ struct sdhci_adma_desc *sdhci_adma_init(void) diff --git a/drivers/mtd/mtd_uboot.c b/drivers/mtd/mtd_uboot.c index 90767ec417..dd0b0242f9 100644 --- a/drivers/mtd/mtd_uboot.c +++ b/drivers/mtd/mtd_uboot.c @@ -54,7 +54,7 @@ static const char *get_mtdids(void) * @altname: Alternate name to return * @max_len: Length of the alternate name buffer * - * @return 0 on success, an error otherwise. + * Return: 0 on success, an error otherwise. */ int mtd_search_alternate_name(const char *mtdname, char *altname, unsigned int max_len) diff --git a/drivers/mtd/mtdcore.c b/drivers/mtd/mtdcore.c index 1d45fb55c7..aa78d41a55 100644 --- a/drivers/mtd/mtdcore.c +++ b/drivers/mtd/mtdcore.c @@ -850,7 +850,7 @@ EXPORT_SYMBOL_GPL(get_mtd_device_nm); * @param mtd an MTD device * @param offset offset in flash * @param length image length - * @return image length including bad blocks in *len_incl_bad and whether or not + * Return: image length including bad blocks in *len_incl_bad and whether or not * the length returned was truncated in *truncated */ void mtd_get_len_incl_bad(struct mtd_info *mtd, uint64_t offset, diff --git a/drivers/mtd/mtdpart.c b/drivers/mtd/mtdpart.c index a435ce6d07..4119ea4ff6 100644 --- a/drivers/mtd/mtdpart.c +++ b/drivers/mtd/mtdpart.c @@ -89,7 +89,7 @@ bool mtd_partitions_used(struct mtd_info *master) * @mtdparts: String describing the partition with mtdparts command syntax * @partition: MTD partition structure to fill * - * @return 0 on success, an error otherwise. + * Return: 0 on success, an error otherwise. */ static int mtd_parse_partition(const char **_mtdparts, struct mtd_partition *partition) @@ -200,7 +200,7 @@ static int mtd_parse_partition(const char **_mtdparts, * caller. * @_nparts: Size of @_parts array. * - * @return 0 on success, an error otherwise. + * Return: 0 on success, an error otherwise. */ int mtd_parse_partitions(struct mtd_info *parent, const char **_mtdparts, struct mtd_partition **_parts, int *_nparts) diff --git a/drivers/mtd/nand/raw/cortina_nand.c b/drivers/mtd/nand/raw/cortina_nand.c index c5e97da5e0..88798f233e 100644 --- a/drivers/mtd/nand/raw/cortina_nand.c +++ b/drivers/mtd/nand/raw/cortina_nand.c @@ -83,7 +83,7 @@ static int nand_waitfor_cmd_completion(struct nand_ctlr *reg, unsigned int mask) * Read one byte from the chip * * @param mtd MTD device structure - * @return data byte + * Return: data byte * * Read function for 8bit bus-width */ @@ -504,7 +504,7 @@ static void ca_nand_command(struct mtd_info *mtd, unsigned int command, * Set up NAND bus width and page size * * @param info nand_info structure - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int set_bus_width_page_size(struct mtd_info *mtd) { @@ -724,7 +724,7 @@ static int ca_do_bch_encode(struct mtd_info *mtd, struct nand_chip *chip, * @param page page number * @param with_ecc 1 to enable ECC, 0 to disable ECC * @param is_writing 0 for read, 1 for write - * @return 0 when successfully completed + * Return: 0 when successfully completed * -ETIMEDOUT when command timeout */ static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip, @@ -952,7 +952,7 @@ static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip, * @param chip nand chip info structure * @param buf buffer to store read data * @param page page number to read - * @return 0 when successfully completed + * Return: 0 when successfully completed * -ETIMEDOUT when command timeout */ static int nand_read_page_hwecc(struct mtd_info *mtd, @@ -980,7 +980,7 @@ static int nand_read_page_hwecc(struct mtd_info *mtd, * @param mtd mtd info structure * @param chip nand chip info structure * @param buf data buffer - * @return 0 when successfully completed + * Return: 0 when successfully completed * -ETIMEDOUT when command timeout */ static int nand_write_page_hwecc(struct mtd_info *mtd, @@ -1009,7 +1009,7 @@ static int nand_write_page_hwecc(struct mtd_info *mtd, * @param chip nand chip info structure * @param buf buffer to store read data * @param page page number to read - * @return 0 when successfully completed + * Return: 0 when successfully completed * -ETIMEDOUT when command timeout */ static int nand_read_page_raw(struct mtd_info *mtd, @@ -1037,7 +1037,7 @@ static int nand_read_page_raw(struct mtd_info *mtd, * @param mtd mtd info structure * @param chip nand chip info structure * @param buf data buffer - * @return 0 when successfully completed + * Return: 0 when successfully completed * -ETIMEDOUT when command timeout */ static int nand_write_page_raw(struct mtd_info *mtd, @@ -1067,7 +1067,7 @@ static int nand_write_page_raw(struct mtd_info *mtd, * @param page page number to read * @param with_ecc 1 to enable ECC, 0 to disable ECC * @param is_writing 0 for read, 1 for write - * @return 0 when successfully completed + * Return: 0 when successfully completed * -ETIMEDOUT when command timeout */ static int nand_rw_oob(struct mtd_info *mtd, struct nand_chip *chip, @@ -1137,7 +1137,7 @@ static int nand_read_oob(struct mtd_info *mtd, struct nand_chip *chip, int page) * @param mtd mtd info structure * @param chip nand chip info structure * @param page page number to write - * @return 0 when successfully completed + * Return: 0 when successfully completed * -ETIMEDOUT when command timeout */ static int nand_write_oob(struct mtd_info *mtd, struct nand_chip *chip, @@ -1239,7 +1239,7 @@ static void nand_config_flash_type(struct nand_chip *nand) * config oob layout * * @param chip nand chip info structure - * @return 0 when successfully completed + * Return: 0 when successfully completed * -EINVAL when ECC bytes exceed OOB size */ static int nand_config_oob_layout(struct nand_chip *nand) diff --git a/drivers/mtd/nand/raw/nand_util.c b/drivers/mtd/nand/raw/nand_util.c index 5409c9f322..5150607d8a 100644 --- a/drivers/mtd/nand/raw/nand_util.c +++ b/drivers/mtd/nand/raw/nand_util.c @@ -47,7 +47,7 @@ typedef struct mtd_info mtd_info_t; * * @param mtd nand mtd instance to erase * @param opts options, @see struct nand_erase_options - * @return 0 in case of success + * Return: 0 in case of success * * This code is ported from flash_eraseall.c from Linux mtd utils by * Arcom Control System Ltd. @@ -202,7 +202,7 @@ int nand_erase_opts(struct mtd_info *mtd, * @param mtd nand mtd instance * @param tight bring device in lock tight mode * - * @return 0 on success, -1 in case of error + * Return: 0 on success, -1 in case of error * * The lock / lock-tight command only applies to the whole chip. To get some * parts of the chip lock and others unlocked use the following sequence: @@ -258,7 +258,7 @@ int nand_lock(struct mtd_info *mtd, int tight) * @param mtd nand mtd instance * @param offset page address to query (must be page-aligned!) * - * @return -1 in case of error + * Return: -1 in case of error * >0 lock status: * bitfield with the following combinations: * NAND_LOCK_STATUS_TIGHT: page in tight state @@ -308,7 +308,7 @@ int nand_get_lock_status(struct mtd_info *mtd, loff_t offset) * page size mtd->writesize) * @param allexcept if set, unlock everything not selected * - * @return 0 on success, -1 in case of error + * Return: 0 on success, -1 in case of error */ int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length, int allexcept) @@ -405,7 +405,7 @@ int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length, * @param offset offset in flash * @param length image length * @param used length of flash needed for the requested length - * @return 0 if the image fits and there are no bad blocks + * Return: 0 if the image fits and there are no bad blocks * 1 if the image fits, but there are bad blocks * -1 if the image does not fit */ @@ -476,7 +476,7 @@ static size_t drop_ffs(const struct mtd_info *mtd, const u_char *buf, * @param mtd nand mtd instance * @param ops MTD operations, including data to verify * @param ofs offset in flash - * @return 0 in case of success + * Return: 0 in case of success */ int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops, loff_t ofs) @@ -517,7 +517,7 @@ int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops, * @param ofs offset in flash * @param len buffer length * @param buf buffer to read from - * @return 0 in case of success + * Return: 0 in case of success */ int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf) { @@ -568,7 +568,7 @@ int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf) * exceed the buffer * @param buffer buffer to read from * @param flags flags modifying the behaviour of the write to NAND - * @return 0 in case of success + * Return: 0 in case of success */ int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length, size_t *actual, loff_t lim, u_char *buffer, int flags) @@ -702,7 +702,7 @@ int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length, * @param lim maximum size that actual may be in order to not exceed the * buffer * @param buffer buffer to write to - * @return 0 in case of success + * Return: 0 in case of success */ int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length, size_t *actual, loff_t lim, u_char *buffer) @@ -793,7 +793,7 @@ int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length, * @param buf buffer to check * @param patt the pattern to check * @param size buffer size in bytes - * @return 1 if there are only patt bytes in buf + * Return: 1 if there are only patt bytes in buf * 0 if something else was found */ static int check_pattern(const u_char *buf, u_char patt, int size) @@ -815,7 +815,7 @@ static int check_pattern(const u_char *buf, u_char patt, int size) * * @param mtd nand mtd instance * @param offset offset in flash - * @return 0 if the block is still good + * Return: 0 if the block is still good */ int nand_torture(struct mtd_info *mtd, loff_t offset) { diff --git a/drivers/mtd/nand/raw/octeontx_bch.c b/drivers/mtd/nand/raw/octeontx_bch.c index a41772880f..24ffa5105f 100644 --- a/drivers/mtd/nand/raw/octeontx_bch.c +++ b/drivers/mtd/nand/raw/octeontx_bch.c @@ -218,7 +218,7 @@ static const struct pci_device_id octeontx_bchvf_pci_id_table[] = { * @param[out] ecc 8-byte aligned pointer to where ecc data should go * @param[in] resp pointer to where responses will be written. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size, u8 bch_level, dma_addr_t ecc, dma_addr_t resp) @@ -259,7 +259,7 @@ int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size, * This should not be the same as block_ecc_in. * @param[in] resp pointer to where responses will be written. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int octeontx_bch_decode(struct bch_vf *vf, dma_addr_t block_ecc_in, diff --git a/drivers/mtd/nand/raw/octeontx_bch.h b/drivers/mtd/nand/raw/octeontx_bch.h index 3aaa52c264..95a9b7126f 100644 --- a/drivers/mtd/nand/raw/octeontx_bch.h +++ b/drivers/mtd/nand/raw/octeontx_bch.h @@ -75,7 +75,7 @@ int octeontx_bch_wait(struct bch_vf *vf, union bch_resp *resp, * @param[out] ecc 8-byte aligned pointer to where ecc data should go * @param[in] resp pointer to where responses will be written. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size, u8 bch_level, dma_addr_t ecc, dma_addr_t resp); @@ -95,7 +95,7 @@ int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size, * This should not be the same as block_ecc_in. * @param[in] resp pointer to where responses will be written. * - * @return Zero on success, negative on failure. + * Return: Zero on success, negative on failure. */ int octeontx_bch_decode(struct bch_vf *vf, dma_addr_t block_ecc_in, @@ -124,7 +124,7 @@ static inline void octeontx_bch_write_doorbell(u64 num_commands, * In this case, the initial probe returns success but the actual probing * is deferred until the BCH VF has been probed. * - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ int octeontx_pci_nand_deferred_probe(void); diff --git a/drivers/mtd/nand/raw/octeontx_nand.c b/drivers/mtd/nand/raw/octeontx_nand.c index 75476c098f..ff363a56b5 100644 --- a/drivers/mtd/nand/raw/octeontx_nand.c +++ b/drivers/mtd/nand/raw/octeontx_nand.c @@ -2179,7 +2179,7 @@ int octeontx_pci_nand_disable(struct udevice *dev) * In this case, the initial probe returns success but the actual probing * is deferred until the BCH VF has been probed. * - * @return 0 for success, otherwise error + * Return: 0 for success, otherwise error */ int octeontx_pci_nand_deferred_probe(void) { diff --git a/drivers/mtd/nand/raw/omap_gpmc.c b/drivers/mtd/nand/raw/omap_gpmc.c index 107447f9df..8b9ff4de18 100644 --- a/drivers/mtd/nand/raw/omap_gpmc.c +++ b/drivers/mtd/nand/raw/omap_gpmc.c @@ -117,7 +117,7 @@ static uint32_t gen_true_ecc(uint8_t *ecc_buf) * @read_ecc: ecc read from nand flash * @calc_ecc: ecc read from ECC registers * - * @return 0 if data is OK or corrected, else returns -1 + * Return: 0 if data is OK or corrected, else returns -1 */ static int __maybe_unused omap_correct_data(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc, uint8_t *calc_ecc) @@ -488,7 +488,7 @@ static void omap_reverse_list(u8 *list, unsigned int length) * @read_ecc: ecc read from nand flash (ignored) * @calc_ecc: ecc read from ECC registers * - * @return 0 if data is OK or corrected, else returns -1 + * Return: 0 if data is OK or corrected, else returns -1 */ static int omap_correct_data_bch(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc, uint8_t *calc_ecc) diff --git a/drivers/mtd/nand/raw/tegra_nand.c b/drivers/mtd/nand/raw/tegra_nand.c index 8e70c8e73b..d2801d48a3 100644 --- a/drivers/mtd/nand/raw/tegra_nand.c +++ b/drivers/mtd/nand/raw/tegra_nand.c @@ -152,7 +152,7 @@ static int nand_waitfor_cmd_completion(struct nand_ctlr *reg) * Read one byte from the chip * * @param mtd MTD device structure - * @return data byte + * Return: data byte * * Read function for 8bit bus-width */ @@ -466,7 +466,7 @@ static void stop_command(struct nand_ctlr *reg) * * @param info nand_info structure * @param *reg_val address of reg_val - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int set_bus_width_page_size(struct mtd_info *our_mtd, struct fdt_nand *config, u32 *reg_val) @@ -505,7 +505,7 @@ static int set_bus_width_page_size(struct mtd_info *our_mtd, * @param page page number * @param with_ecc 1 to enable ECC, 0 to disable ECC * @param is_writing 0 for read, 1 for write - * @return 0 when successfully completed + * Return: 0 when successfully completed * -EIO when command timeout */ static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip, @@ -655,7 +655,7 @@ static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip, * @param chip nand chip info structure * @param buf buffer to store read data * @param page page number to read - * @return 0 when successfully completed + * Return: 0 when successfully completed * -EIO when command timeout */ static int nand_read_page_hwecc(struct mtd_info *mtd, @@ -687,7 +687,7 @@ static int nand_write_page_hwecc(struct mtd_info *mtd, * @param chip nand chip info structure * @param buf buffer to store read data * @param page page number to read - * @return 0 when successfully completed + * Return: 0 when successfully completed * -EINVAL when chip->oob_poi is not double-word aligned * -EIO when command timeout */ @@ -720,7 +720,7 @@ static int nand_write_page_raw(struct mtd_info *mtd, * @param page page number to read * @param with_ecc 1 to enable ECC, 0 to disable ECC * @param is_writing 0 for read, 1 for write - * @return 0 when successfully completed + * Return: 0 when successfully completed * -EINVAL when chip->oob_poi is not double-word aligned * -EIO when command timeout */ @@ -838,7 +838,7 @@ static int nand_read_oob(struct mtd_info *mtd, struct nand_chip *chip, * @param mtd mtd info structure * @param chip nand chip info structure * @param page page number to write - * @return 0 when successfully completed + * Return: 0 when successfully completed * -EINVAL when chip->oob_poi is not double-word aligned * -EIO when command timeout */ @@ -900,7 +900,7 @@ static void setup_timing(unsigned timing[FDT_NAND_TIMING_COUNT], * * @param dev Driver model device * @param config Device tree NAND configuration - * @return 0 if ok, -ve on error (FDT_ERR_...) + * Return: 0 if ok, -ve on error (FDT_ERR_...) */ static int fdt_decode_nand(struct udevice *dev, struct fdt_nand *config) { diff --git a/drivers/mtd/onenand/onenand_base.c b/drivers/mtd/onenand/onenand_base.c index 56e1858de4..f94597c061 100644 --- a/drivers/mtd/onenand/onenand_base.c +++ b/drivers/mtd/onenand/onenand_base.c @@ -148,7 +148,7 @@ static void onenand_writew(unsigned short value, void __iomem * addr) * onenand_block_address - [DEFAULT] Get block address * @param device the device id * @param block the block - * @return translated block address if DDP, otherwise same + * Return: translated block address if DDP, otherwise same * * Setup Start Address 1 Register (F100h) */ @@ -165,7 +165,7 @@ static int onenand_block_address(struct onenand_chip *this, int block) * onenand_bufferram_address - [DEFAULT] Get bufferram address * @param device the device id * @param block the block - * @return set DBS value if DDP, otherwise 0 + * Return: set DBS value if DDP, otherwise 0 * * Setup Start Address 2 Register (F101h) for DDP */ @@ -182,7 +182,7 @@ static int onenand_bufferram_address(struct onenand_chip *this, int block) * onenand_page_address - [DEFAULT] Get page address * @param page the page address * @param sector the sector address - * @return combined page and sector address + * Return: combined page and sector address * * Setup Start Address 8 Register (F107h) */ @@ -202,7 +202,7 @@ static int onenand_page_address(int page, int sector) * @param dataram1 DataRAM index * @param sectors the sector address * @param count the number of sectors - * @return the start buffer value + * Return: the start buffer value * * Setup Start Buffer Register (F200h) */ @@ -511,7 +511,7 @@ static int onenand_wait(struct mtd_info *mtd, int state) * onenand_bufferram_offset - [DEFAULT] BufferRAM offset * @param mtd MTD data structure * @param area BufferRAM area - * @return offset given area + * Return: offset given area * * Return BufferRAM offset given area */ @@ -612,7 +612,7 @@ static int onenand_write_bufferram(struct mtd_info *mtd, loff_t addr, int area, * onenand_get_2x_blockpage - [GENERIC] Get blockpage at 2x program mode * @param mtd MTD data structure * @param addr address to check - * @return blockpage address + * Return: blockpage address * * Get blockpage address at 2x program mode */ @@ -636,7 +636,7 @@ static int onenand_get_2x_blockpage(struct mtd_info *mtd, loff_t addr) * onenand_check_bufferram - [GENERIC] Check BufferRAM information * @param mtd MTD data structure * @param addr address to check - * @return 1 if there are valid data, otherwise 0 + * Return: 1 if there are valid data, otherwise 0 * * Check bufferram if there is data we required */ diff --git a/drivers/net/fec_mxc.c b/drivers/net/fec_mxc.c index 811bc275c1..985b038447 100644 --- a/drivers/net/fec_mxc.c +++ b/drivers/net/fec_mxc.c @@ -331,7 +331,7 @@ static int fec_tx_task_disable(struct fec_priv *fec) * @param[in] fec all we know about the device yet * @param[in] count receive buffer count to be allocated * @param[in] dsize desired size of each receive buffer - * @return 0 on success + * Return: 0 on success * * Init all RX descriptors to default values. */ @@ -703,7 +703,7 @@ static void fec_halt(struct eth_device *dev) * @param[in] dev Our ethernet device to handle * @param[in] packet Pointer to the data to be transmitted * @param[in] length Data count in bytes - * @return 0 on success + * Return: 0 on success */ #ifdef CONFIG_DM_ETH static int fecmxc_send(struct udevice *dev, void *packet, int length) @@ -854,7 +854,7 @@ out: /** * Pull one frame from the card * @param[in] dev Our ethernet device to handle - * @return Length of packet read + * Return: Length of packet read */ #ifdef CONFIG_DM_ETH static int fecmxc_recv(struct udevice *dev, int flags, uchar **packetp) diff --git a/drivers/net/octeontx2/cgx.c b/drivers/net/octeontx2/cgx.c index 189fe7c631..d139029f4e 100644 --- a/drivers/net/octeontx2/cgx.c +++ b/drivers/net/octeontx2/cgx.c @@ -52,7 +52,7 @@ char lmac_speed_to_str[][8] = { * * @param instance instance to find * - * @return pointer to lmac data structure or NULL if not found + * Return: pointer to lmac data structure or NULL if not found */ struct lmac *nix_get_cgx_lmac(int lmac_instance) { diff --git a/drivers/net/octeontx2/cgx.h b/drivers/net/octeontx2/cgx.h index f287692712..b1f6f067bf 100644 --- a/drivers/net/octeontx2/cgx.h +++ b/drivers/net/octeontx2/cgx.h @@ -82,7 +82,7 @@ static inline u64 cgx_read(struct cgx *cgx, u8 lmac, u64 offset) * * @param instance instance to find * - * @return pointer to lmac data structure or NULL if not found + * Return: pointer to lmac data structure or NULL if not found */ struct lmac *nix_get_cgx_lmac(int lmac_instance); diff --git a/drivers/net/octeontx2/lmt.h b/drivers/net/octeontx2/lmt.h index 84a7eab814..3b30992cb6 100644 --- a/drivers/net/octeontx2/lmt.h +++ b/drivers/net/octeontx2/lmt.h @@ -15,7 +15,7 @@ * @param ptr address in memory to add incr to * @param incr amount to increment memory location by (signed) * - * @return Value of memory location before increment + * Return: Value of memory location before increment */ static inline s64 atomic_fetch_and_add64_nosync(s64 *ptr, s64 incr) { diff --git a/drivers/net/octeontx2/nix.c b/drivers/net/octeontx2/nix.c index 5954737b5c..a5665a25f2 100644 --- a/drivers/net/octeontx2/nix.c +++ b/drivers/net/octeontx2/nix.c @@ -36,7 +36,7 @@ * @param elem_size Size of each element * @param msg Text string to show when allocation fails * - * @return A valid memory location or NULL on failure + * Return: A valid memory location or NULL on failure */ static void *nix_memalloc(int num_elements, size_t elem_size, const char *msg) { diff --git a/drivers/net/octeontx2/nix_af.c b/drivers/net/octeontx2/nix_af.c index d513917ee7..cd098d6cd6 100644 --- a/drivers/net/octeontx2/nix_af.c +++ b/drivers/net/octeontx2/nix_af.c @@ -336,7 +336,7 @@ int npa_af_shutdown(struct npa_af *npa_af) * * @param nix Handle to setup * - * @return 0, or negative on failure + * Return: 0, or negative on failure */ static int nix_af_setup_sq(struct nix *nix) { @@ -445,7 +445,7 @@ static int nix_af_setup_sq(struct nix *nix) * @param cindex Context index * @param resp Result pointer * - * @return 0 for success, -EBUSY on failure + * Return: 0 for success, -EBUSY on failure */ static int nix_aq_issue_command(struct nix_af *nix_af, int lf, diff --git a/drivers/net/octeontx2/rvu.h b/drivers/net/octeontx2/rvu.h index c0a834b89a..62bc7a644a 100644 --- a/drivers/net/octeontx2/rvu.h +++ b/drivers/net/octeontx2/rvu.h @@ -101,7 +101,7 @@ int qmem_alloc(struct qmem *q, u32 qsize, size_t entry_sz); * @param inst_size Size of each instruction * @param res_size Size of each result * - * @return -ENOMEM on error, 0 on success + * Return: -ENOMEM on error, 0 on success */ int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize, size_t inst_size, size_t res_size); diff --git a/drivers/net/octeontx2/rvu_common.c b/drivers/net/octeontx2/rvu_common.c index 173b28ba4b..4d8173f5ba 100644 --- a/drivers/net/octeontx2/rvu_common.c +++ b/drivers/net/octeontx2/rvu_common.c @@ -41,7 +41,7 @@ void qmem_free(struct qmem *q) * @param inst_size Size of each instruction * @param res_size Size of each result * - * @return -ENOMEM on error, 0 on success + * Return: -ENOMEM on error, 0 on success */ int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize, size_t inst_size, size_t res_size) diff --git a/drivers/net/pfe_eth/pfe_driver.c b/drivers/net/pfe_eth/pfe_driver.c index 6f443b4ea8..5e14f82de5 100644 --- a/drivers/net/pfe_eth/pfe_driver.c +++ b/drivers/net/pfe_eth/pfe_driver.c @@ -25,7 +25,7 @@ static struct rx_desc_s *g_rx_desc; * @param[out] pkt_ptr - Pointer to store rx packet * @param[out] phy_port - Pointer to store recv phy port * - * @return -1 if no packet, else return length of packet. + * Return: -1 if no packet, else return length of packet. */ int pfe_recv(uchar **pkt_ptr, int *phy_port) { @@ -121,7 +121,7 @@ int pfe_eth_free_pkt(struct udevice *dev, uchar *packet, int length) * @param[in] data Pointer to the data * @param[in] length Length of the ethernet packet to be transferred. * - * @return -1 if tx Q is full, else returns the tx location where the pkt is + * Return: -1 if tx Q is full, else returns the tx location where the pkt is * placed. */ int pfe_send(int phy_port, void *data, int length) @@ -190,7 +190,7 @@ int pfe_send(int phy_port, void *data, int length) * locations * if success, moves the tx_to_send to next location. * - * @return -1 if TX ownership bit is not cleared by hw. + * Return: -1 if TX ownership bit is not cleared by hw. * else on success (tx done completion) return zero. */ int pfe_tx_done(void) @@ -557,7 +557,7 @@ static int pfe_hif_init(struct pfe_ddr_address *pfe_addr) * * @param[in] edev Pointer to eth device structure. * - * @return 0, on success. + * Return: 0, on success. */ static int pfe_hw_init(struct pfe_ddr_address *pfe_addr) { diff --git a/drivers/net/pfe_eth/pfe_eth.c b/drivers/net/pfe_eth/pfe_eth.c index 0c27a668b5..d338b363d5 100644 --- a/drivers/net/pfe_eth/pfe_eth.c +++ b/drivers/net/pfe_eth/pfe_eth.c @@ -101,7 +101,7 @@ static int pfe_eth_write_hwaddr(struct udevice *dev) * * @param[in] edev Pointer to eth device structure. * - * @return none + * Return: none */ static inline void pfe_eth_stop(struct udevice *dev) { diff --git a/drivers/net/pfe_eth/pfe_firmware.c b/drivers/net/pfe_eth/pfe_firmware.c index 93e5ea55c7..6669048181 100644 --- a/drivers/net/pfe_eth/pfe_firmware.c +++ b/drivers/net/pfe_eth/pfe_firmware.c @@ -37,7 +37,7 @@ static const void *pfe_esbc_hdr_addr; * @param pe_mask Mask of PE id's to load firmware to * @param pfe_firmware Pointer to the firmware image * - * @return 0 on success, a negative value on error + * Return: 0 on success, a negative value on error */ static int pfe_load_elf(int pe_mask, uint8_t *pfe_firmware) { @@ -99,7 +99,7 @@ err: * @param size pointer to size of the firmware * @param fw_name pfe firmware name, either class or tmu * - * @return 0 on success, a negative value on error + * Return: 0 on success, a negative value on error */ static int pfe_get_fw(const void **data, size_t *size, char *fw_name) @@ -148,7 +148,7 @@ static int pfe_get_fw(const void **data, /* * Check PFE FIT image * - * @return 0 on success, a negative value on error + * Return: 0 on success, a negative value on error */ static int pfe_fit_check(void) { @@ -248,7 +248,7 @@ int pfe_spi_flash_init(void) * firmware files * Takes PE's out of reset * - * @return 0 on success, a negative value on error + * Return: 0 on success, a negative value on error */ int pfe_firmware_init(void) { diff --git a/drivers/net/pfe_eth/pfe_hw.c b/drivers/net/pfe_eth/pfe_hw.c index 722f5c238f..4db6f3158c 100644 --- a/drivers/net/pfe_eth/pfe_hw.c +++ b/drivers/net/pfe_eth/pfe_hw.c @@ -128,7 +128,7 @@ static void pe_pmem_memcpy_to32(int id, u32 dst, const void *src, * @param[in] addr PMEM read address (must be aligned on size) * @param[in] size Number of bytes to read (maximum 4, must not * cross 32bit boundaries) - * @return the data read (in PE endianness, i.e BE). + * Return: the data read (in PE endianness, i.e BE). */ u32 pe_pmem_read(int id, u32 addr, u8 size) { @@ -176,7 +176,7 @@ void pe_dmem_write(int id, u32 val, u32 addr, u8 size) * @param[in] addr DMEM read address (must be aligned on size) * @param[in] size Number of bytes to read (maximum 4, must not * cross 32bit boundaries) - * @return the data read (in PE endianness, i.e BE). + * Return: the data read (in PE endianness, i.e BE). */ u32 pe_dmem_read(int id, u32 addr, u8 size) { @@ -222,7 +222,7 @@ static void class_bus_write(u32 val, u32 addr, u8 size) * through indirect access registers. * @param[in] addr Address to read from (must be aligned on size) * @param[in] size Number of bytes to read (1, 2 or 4) - * @return the read data + * Return: the read data */ static u32 class_bus_read(u32 addr, u8 size) { diff --git a/drivers/pci/pci-uclass.c b/drivers/pci/pci-uclass.c index 5da3515f5f..c66cd756d9 100644 --- a/drivers/pci/pci-uclass.c +++ b/drivers/pci/pci-uclass.c @@ -76,7 +76,7 @@ pci_dev_t dm_pci_get_bdf(const struct udevice *dev) /** * pci_get_bus_max() - returns the bus number of the last active bus * - * @return last bus number, or -1 if no active buses + * Return: last bus number, or -1 if no active buses */ static int pci_get_bus_max(void) { @@ -700,7 +700,7 @@ static bool pci_match_one_id(const struct pci_device_id *id, * @bus: Bus to check * @vendor: Vendor ID to check * @device: Device ID to check - * @return true if the vendor/device is in the list, false if not + * Return: true if the vendor/device is in the list, false if not */ static bool pci_need_device_pre_reloc(struct udevice *bus, uint vendor, uint device) @@ -728,7 +728,7 @@ static bool pci_need_device_pre_reloc(struct udevice *bus, uint vendor, * @find_id: Specification of the driver to find * @bdf: Bus/device/function addreess - see PCI_BDF() * @devp: Returns a pointer to the device created - * @return 0 if OK, -EPERM if the device is not needed before relocation and + * Return: 0 if OK, -EPERM if the device is not needed before relocation and * therefore was not created, other -ve value on error */ static int pci_find_and_bind_driver(struct udevice *parent, diff --git a/drivers/pci/pci_common.c b/drivers/pci/pci_common.c index 02a71da30f..a18251297f 100644 --- a/drivers/pci/pci_common.c +++ b/drivers/pci/pci_common.c @@ -236,7 +236,7 @@ int __pci_hose_phys_to_bus(struct pci_controller *hose, * @hose: PCI hose of the root PCI controller * @phys_addr: physical address to convert * @flags: flags of pci regions - * @return bus address if OK, 0 on error + * Return: bus address if OK, 0 on error */ pci_addr_t pci_hose_phys_to_bus(struct pci_controller *hose, phys_addr_t phys_addr, diff --git a/drivers/pci/pci_internal.h b/drivers/pci/pci_internal.h index 8b842f6fb4..5a4c90e619 100644 --- a/drivers/pci/pci_internal.h +++ b/drivers/pci/pci_internal.h @@ -39,7 +39,7 @@ void dm_pciauto_postscan_setup_bridge(struct udevice *dev, int sub_bus); * If the device is a bridge, downstream devices will be probed. * * @dev: Device to configure - * @return the maximum PCI bus number found by this device. If there are no + * Return: the maximum PCI bus number found by this device. If there are no * bridges, this just returns the device's bus number. If the device is a * bridge then it will return a larger number, depending on the devices on * that bridge. On error, returns a -ve error number. @@ -54,7 +54,7 @@ int dm_pciauto_config_device(struct udevice *dev); * * @busnum: PCI bus number to look up * @busp: Returns PCI bus on success - * @return 0 on success, or -ve error + * Return: 0 on success, or -ve error */ int pci_get_bus(int busnum, struct udevice **busp); diff --git a/drivers/pci/pci_rom.c b/drivers/pci/pci_rom.c index 7bad4c82c0..f8b193058a 100644 --- a/drivers/pci/pci_rom.c +++ b/drivers/pci/pci_rom.c @@ -149,7 +149,7 @@ static int pci_rom_probe(struct udevice *dev, struct pci_rom_header **hdrp) * @ram_headerp: Returns a pointer to the image in RAM * @allocedp: Returns true if @ram_headerp was allocated and needs * to be freed - * @return 0 if OK, -ve on error. Note that @allocedp is set up regardless of + * Return: 0 if OK, -ve on error. Note that @allocedp is set up regardless of * the error state. Even if this function returns an error, it may have * allocated memory. */ diff --git a/drivers/pinctrl/intel/pinctrl.c b/drivers/pinctrl/intel/pinctrl.c index 987a56b715..1607000ded 100644 --- a/drivers/pinctrl/intel/pinctrl.c +++ b/drivers/pinctrl/intel/pinctrl.c @@ -60,7 +60,7 @@ * * @comm: Community to search * @gpio: Pad number to look up (assumed to be valid) - * @return offset, 0 for first GPIO in community + * Return: offset, 0 for first GPIO in community */ static size_t relative_pad_in_comm(const struct pad_community *comm, uint gpio) @@ -75,7 +75,7 @@ static size_t relative_pad_in_comm(const struct pad_community *comm, * * @comm: Community to search * @relative_pad: Pad to look up - * @return group number if found (see community_n_groups, etc.), or + * Return: group number if found (see community_n_groups, etc.), or * -ESPIPE if no groups, or -ENOENT if not found */ static int pinctrl_group_index(const struct pad_community *comm, @@ -135,7 +135,7 @@ static u32 pinctrl_bitmask_within_group(const struct pad_community *comm, * * @pad: Pad to check * @devp: Returns the device for that pad - * @return 0 if OK, -ENOTBLK if no device was found for the given pin + * Return: 0 if OK, -ENOTBLK if no device was found for the given pin */ static int pinctrl_get_device(uint pad, struct udevice **devp) { @@ -346,7 +346,7 @@ static const int mask[4] = { * * @dev: Pinctrl device containing the pad (see pinctrl_get_device()) * @cfg: Configuration to apply - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int pinctrl_configure_pad(struct udevice *dev, const struct pad_config *cfg) diff --git a/drivers/power/exynos-tmu.c b/drivers/power/exynos-tmu.c index 4fba7b527c..6d62f6cae4 100644 --- a/drivers/power/exynos-tmu.c +++ b/drivers/power/exynos-tmu.c @@ -102,7 +102,7 @@ static struct tmu_info gbl_info; * then calculate and calibrate it's value * in degree celsius. * - * @return current temperature of the chip as sensed by TMU + * Return: current temperature of the chip as sensed by TMU */ static int get_cur_temp(struct tmu_info *info) { @@ -135,7 +135,7 @@ static int get_cur_temp(struct tmu_info *info) * Monitors status of the TMU device and exynos temperature * * @param temp pointer to the current temperature value - * @return enum tmu_status_t value, code indicating event to execute + * Return: enum tmu_status_t value, code indicating event to execute */ enum tmu_status_t tmu_monitor(int *temp) { @@ -177,7 +177,7 @@ enum tmu_status_t tmu_monitor(int *temp) * * @param info pointer to the tmu_info struct * @param blob FDT blob - * @return int value, 0 for success + * Return: int value, 0 for success */ static int get_tmu_fdt_values(struct tmu_info *info, const void *blob) { @@ -332,7 +332,7 @@ static void tmu_setup_parameters(struct tmu_info *info) * Initialize TMU device * * @param blob FDT blob - * @return int value, 0 for success + * Return: int value, 0 for success */ int tmu_init(const void *blob) { diff --git a/drivers/power/palmas.c b/drivers/power/palmas.c index bf9173949c..0959445364 100644 --- a/drivers/power/palmas.c +++ b/drivers/power/palmas.c @@ -149,7 +149,7 @@ int twl603x_audio_power(u8 on) * @brief palmas_enable_ss_ldo - Configure EVM board specific configurations * for the USB Super speed SMPS10 regulator. * - * @return 0 + * Return: 0 */ int palmas_enable_ss_ldo(void) { diff --git a/drivers/power/regulator/tps65090_regulator.c b/drivers/power/regulator/tps65090_regulator.c index 174ee58d03..fa15e61a10 100644 --- a/drivers/power/regulator/tps65090_regulator.c +++ b/drivers/power/regulator/tps65090_regulator.c @@ -45,7 +45,7 @@ static int tps65090_fet_get_enable(struct udevice *dev) * @param pmic pmic structure for the tps65090 * @param fet_id FET number to set (1..MAX_FET_NUM) * @param set 1 to power on FET, 0 to power off - * @return -EIO if we got a comms error, -EAGAIN if the FET failed to + * Return: -EIO if we got a comms error, -EAGAIN if the FET failed to * change state. If all is ok, returns 0. */ static int tps65090_fet_set(struct udevice *pmic, int fet_id, bool set) diff --git a/drivers/power/tps6586x.c b/drivers/power/tps6586x.c index 49b28a5e6b..37f1c459a6 100644 --- a/drivers/power/tps6586x.c +++ b/drivers/power/tps6586x.c @@ -84,7 +84,7 @@ exit: * * @param sm0 Place to put SM0 voltage * @param sm1 Place to put SM1 voltage - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int read_voltages(int *sm0, int *sm1) { diff --git a/drivers/remoteproc/sandbox_testproc.c b/drivers/remoteproc/sandbox_testproc.c index 6836eca4c5..78b108184b 100644 --- a/drivers/remoteproc/sandbox_testproc.c +++ b/drivers/remoteproc/sandbox_testproc.c @@ -308,7 +308,7 @@ static int sandbox_testproc_ping(struct udevice *dev) * @dev: device to operate upon * @da: device address * @size: Size of the memory region @da is pointing to - * @return converted virtual address + * Return: converted virtual address */ static void *sandbox_testproc_device_to_virt(struct udevice *dev, ulong da, ulong size) diff --git a/drivers/remoteproc/stm32_copro.c b/drivers/remoteproc/stm32_copro.c index 4c5f24857e..5271f83bc0 100644 --- a/drivers/remoteproc/stm32_copro.c +++ b/drivers/remoteproc/stm32_copro.c @@ -30,7 +30,7 @@ struct stm32_copro_privdata { /** * stm32_copro_probe() - Basic probe * @dev: corresponding STM32 remote processor device - * @return 0 if all went ok, else corresponding -ve error + * Return: 0 if all went ok, else corresponding -ve error */ static int stm32_copro_probe(struct udevice *dev) { @@ -61,7 +61,7 @@ static int stm32_copro_probe(struct udevice *dev) * @dev: corresponding STM32 remote processor device * @da: device address * @size: Size of the memory region @da is pointing to - * @return converted virtual address + * Return: converted virtual address */ static void *stm32_copro_device_to_virt(struct udevice *dev, ulong da, ulong size) @@ -89,7 +89,7 @@ static void *stm32_copro_device_to_virt(struct udevice *dev, ulong da, * @dev: corresponding STM32 remote processor device * @addr: Address in memory where image is stored * @size: Size in bytes of the image - * @return 0 if all went ok, else corresponding -ve error + * Return: 0 if all went ok, else corresponding -ve error */ static int stm32_copro_load(struct udevice *dev, ulong addr, ulong size) { @@ -123,7 +123,7 @@ static int stm32_copro_load(struct udevice *dev, ulong addr, ulong size) /** * stm32_copro_start() - Start the STM32 remote processor * @dev: corresponding STM32 remote processor device - * @return 0 if all went ok, else corresponding -ve error + * Return: 0 if all went ok, else corresponding -ve error */ static int stm32_copro_start(struct udevice *dev) { @@ -157,7 +157,7 @@ static int stm32_copro_start(struct udevice *dev) /** * stm32_copro_reset() - Reset the STM32 remote processor * @dev: corresponding STM32 remote processor device - * @return 0 if all went ok, else corresponding -ve error + * Return: 0 if all went ok, else corresponding -ve error */ static int stm32_copro_reset(struct udevice *dev) { @@ -186,7 +186,7 @@ static int stm32_copro_reset(struct udevice *dev) /** * stm32_copro_stop() - Stop the STM32 remote processor * @dev: corresponding STM32 remote processor device - * @return 0 if all went ok, else corresponding -ve error + * Return: 0 if all went ok, else corresponding -ve error */ static int stm32_copro_stop(struct udevice *dev) { @@ -196,7 +196,7 @@ static int stm32_copro_stop(struct udevice *dev) /** * stm32_copro_is_running() - Is the STM32 remote processor running * @dev: corresponding STM32 remote processor device - * @return 0 if the remote processor is running, 1 otherwise + * Return: 0 if the remote processor is running, 1 otherwise */ static int stm32_copro_is_running(struct udevice *dev) { diff --git a/drivers/serial/serial_bcm283x_mu.c b/drivers/serial/serial_bcm283x_mu.c index 58fa722b4b..f0756c37c8 100644 --- a/drivers/serial/serial_bcm283x_mu.c +++ b/drivers/serial/serial_bcm283x_mu.c @@ -140,7 +140,7 @@ static const struct udevice_id bcm283x_mu_serial_id[] = { * The serial device will only work properly if it has been muxed to the serial * pins by firmware. Check whether that happened here. * - * @return true if serial device is muxed, false if not + * Return: true if serial device is muxed, false if not */ static bool bcm283x_is_serial_muxed(void) { diff --git a/drivers/serial/serial_bcm283x_pl011.c b/drivers/serial/serial_bcm283x_pl011.c index 2d2e970316..fe746294cd 100644 --- a/drivers/serial/serial_bcm283x_pl011.c +++ b/drivers/serial/serial_bcm283x_pl011.c @@ -17,7 +17,7 @@ * The serial device will only work properly if it has been muxed to the serial * pins by firmware. Check whether that happened here. * - * @return true if serial device is muxed, false if not + * Return: true if serial device is muxed, false if not */ static bool bcm283x_is_serial_muxed(void) { diff --git a/drivers/sound/hda_codec.c b/drivers/sound/hda_codec.c index eb92830ad9..af6148ef72 100644 --- a/drivers/sound/hda_codec.c +++ b/drivers/sound/hda_codec.c @@ -302,7 +302,7 @@ int hda_codecs_init(struct udevice *dev, struct hda_regs *regs, u32 codec_mask) * @regs: HDA registers * @val: Command to write * @response: Set to response from codec - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int exec_verb(struct hda_regs *regs, uint val, uint *response) { @@ -324,7 +324,7 @@ static int exec_verb(struct hda_regs *regs, uint val, uint *response) * @nid: Parent node ID to check * @num_sub_nodesp: Returns number of subnodes * @start_sub_node_nidp: Returns start subnode number - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int get_subnode_info(struct hda_regs *regs, uint nid, uint *num_sub_nodesp, uint *start_sub_node_nidp) @@ -354,7 +354,7 @@ static int get_subnode_info(struct hda_regs *regs, uint nid, * * @regs: HDA registers * @group_nid: Group node ID to check - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static uint find_beep_node_in_group(struct hda_regs *regs, uint group_nid) { @@ -395,7 +395,7 @@ static uint find_beep_node_in_group(struct hda_regs *regs, uint group_nid) * Checks if the given audio group contains a beep generator * @regs: HDA registers * @nid: Node ID to check - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int audio_group_has_beep_node(struct hda_regs *regs, uint nid) { @@ -424,7 +424,7 @@ static int audio_group_has_beep_node(struct hda_regs *regs, uint nid) * instead. * * @dev: Sound device - * @return Node ID >0 if found, -ve error code otherwise + * Return: Node ID >0 if found, -ve error code otherwise */ static int get_hda_beep_nid(struct udevice *dev) { @@ -461,7 +461,7 @@ static int get_hda_beep_nid(struct udevice *dev) * * @priv: Device's private data * @divider: Divider value (0 to disable the beep) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int set_beep_divisor(struct hda_codec_priv *priv, uint divider) { diff --git a/drivers/sound/max98088.c b/drivers/sound/max98088.c index 4bcb7482b2..c0463b8e8a 100644 --- a/drivers/sound/max98088.c +++ b/drivers/sound/max98088.c @@ -30,7 +30,7 @@ static const int rate_table[] = {0, 8000, 11025, 16000, 22050, 24000, 32000, * @param rate sampling rate * @param value address of indexvalue to be stored * - * @return 0 for success or negative error code. + * Return: 0 for success or negative error code. */ static int rate_value(int rate, u8 *value) { @@ -54,7 +54,7 @@ static int rate_value(int rate, u8 *value) * @rate: Sampling rate * @bits_per_sample: Bits per sample * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ int max98088_hw_params(struct maxim_priv *priv, unsigned int rate, unsigned int bits_per_sample) @@ -115,7 +115,7 @@ int max98088_hw_params(struct maxim_priv *priv, unsigned int rate, * @priv: max98088 information * @freq: Sampling frequency in Hz * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ int max98088_set_sysclk(struct maxim_priv *priv, unsigned int freq) { @@ -163,7 +163,7 @@ int max98088_set_sysclk(struct maxim_priv *priv, unsigned int freq) * @priv: max98088 information * @fmt: i2S format - supports a subset of the options defined in i2s.h. * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ int max98088_set_fmt(struct maxim_priv *priv, int fmt) { @@ -241,7 +241,7 @@ int max98088_set_fmt(struct maxim_priv *priv, int fmt) * max98088_reset() - reset the audio codec * * @priv: max98088 information - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ static int max98088_reset(struct maxim_priv *priv) { @@ -278,7 +278,7 @@ static int max98088_reset(struct maxim_priv *priv) * * @priv: max98088 information * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ static int max98088_device_init(struct maxim_priv *priv) { diff --git a/drivers/sound/max98090.c b/drivers/sound/max98090.c index c77a732277..a798762f1e 100644 --- a/drivers/sound/max98090.c +++ b/drivers/sound/max98090.c @@ -25,7 +25,7 @@ * @rate: Sampling rate * @bits_per_sample: Bits per sample * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ int max98090_hw_params(struct maxim_priv *priv, unsigned int rate, unsigned int bits_per_sample) @@ -77,7 +77,7 @@ int max98090_hw_params(struct maxim_priv *priv, unsigned int rate, * @priv: max98090 information * @freq: Sampling frequency in Hz * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ int max98090_set_sysclk(struct maxim_priv *priv, unsigned int freq) { @@ -122,7 +122,7 @@ int max98090_set_sysclk(struct maxim_priv *priv, unsigned int freq) * @priv: max98090 information * @fmt: i2S format - supports a subset of the options defined in i2s.h. * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ int max98090_set_fmt(struct maxim_priv *priv, int fmt) { @@ -205,7 +205,7 @@ int max98090_set_fmt(struct maxim_priv *priv, int fmt) * resets the audio codec * * @priv: max98090 information - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ static int max98090_reset(struct maxim_priv *priv) { @@ -231,7 +231,7 @@ static int max98090_reset(struct maxim_priv *priv) * * @priv: max98090 information * - * @return -EIO for error, 0 for success. + * Return: -EIO for error, 0 for success. */ int max98090_device_init(struct maxim_priv *priv) { diff --git a/drivers/sound/max98095.c b/drivers/sound/max98095.c index 002dab437f..d0f701aaf1 100644 --- a/drivers/sound/max98095.c +++ b/drivers/sound/max98095.c @@ -29,7 +29,7 @@ int rate_table[] = {0, 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, * @param rate sampling rate * @param value address of indexvalue to be stored * - * @return 0 for success or negative error code. + * Return: 0 for success or negative error code. */ static int rate_value(int rate, u8 *value) { @@ -53,7 +53,7 @@ static int rate_value(int rate, u8 *value) * @param rate Sampling rate * @param bits_per_sample Bits per sample * - * @return 0 for success or negative error code. + * Return: 0 for success or negative error code. */ static int max98095_hw_params(struct maxim_priv *priv, enum en_max_audio_interface aif_id, @@ -121,7 +121,7 @@ static int max98095_hw_params(struct maxim_priv *priv, * @param priv max98095 information * @param freq Sampling frequency in Hz * - * @return 0 for success or negative error code. + * Return: 0 for success or negative error code. */ static int max98095_set_sysclk(struct maxim_priv *priv, unsigned int freq) { @@ -163,7 +163,7 @@ static int max98095_set_sysclk(struct maxim_priv *priv, unsigned int freq) * @param fmt i2S format - supports a subset of the options defined * in i2s.h. * - * @return 0 for success or negative error code. + * Return: 0 for success or negative error code. */ static int max98095_set_fmt(struct maxim_priv *priv, int fmt, enum en_max_audio_interface aif_id) @@ -255,7 +255,7 @@ static int max98095_set_fmt(struct maxim_priv *priv, int fmt, * resets the audio codec * * @param priv Private data for driver - * @return 0 for success or negative error code. + * Return: 0 for success or negative error code. */ static int max98095_reset(struct maxim_priv *priv) { @@ -296,7 +296,7 @@ static int max98095_reset(struct maxim_priv *priv) * Intialise max98095 codec device * * @param priv max98095 information - * @return 0 for success or negative error code. + * Return: 0 for success or negative error code. */ static int max98095_device_init(struct maxim_priv *priv) { diff --git a/drivers/sound/maxim_codec.c b/drivers/sound/maxim_codec.c index 31e67ee672..6553d95904 100644 --- a/drivers/sound/maxim_codec.c +++ b/drivers/sound/maxim_codec.c @@ -22,7 +22,7 @@ * @param reg reg number to be write * @param data data to be writen to the above registor * - * @return int value 1 for change, 0 for no change or negative error code. + * Return: int value 1 for change, 0 for no change or negative error code. */ int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg, unsigned char data) @@ -39,7 +39,7 @@ int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg, * @param reg reg number to be read * @param data address of read data to be stored * - * @return int value 0 for success, -1 in case of error. + * Return: int value 0 for success, -1 in case of error. */ unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg, unsigned char *data) @@ -64,7 +64,7 @@ unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg, * @param mask register mask * @param value new value * - * @return int value 0 for success, non-zero error code. + * Return: int value 0 for success, non-zero error code. */ int maxim_bic_or(struct maxim_priv *priv, unsigned int reg, unsigned char mask, unsigned char value) diff --git a/drivers/sound/maxim_codec.h b/drivers/sound/maxim_codec.h index a3128e0bb7..deaefd93eb 100644 --- a/drivers/sound/maxim_codec.h +++ b/drivers/sound/maxim_codec.h @@ -34,7 +34,7 @@ struct maxim_priv { * @param reg reg number to be write * @param data data to be writen to the above registor * - * @return int value 1 for change, 0 for no change or negative error code. + * Return: int value 1 for change, 0 for no change or negative error code. */ int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg, unsigned char data); @@ -46,7 +46,7 @@ int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg, * @param reg reg number to be read * @param data address of read data to be stored * - * @return int value 0 for success, -1 in case of error. + * Return: int value 0 for success, -1 in case of error. */ unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg, unsigned char *data); @@ -59,7 +59,7 @@ unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg, * @param mask register mask * @param value new value * - * @return int value 0 for success, non-zero error code. + * Return: int value 0 for success, non-zero error code. */ int maxim_bic_or(struct maxim_priv *priv, unsigned int reg, unsigned char mask, unsigned char value); diff --git a/drivers/sound/samsung-i2s.c b/drivers/sound/samsung-i2s.c index d3d75c046e..dc5a2789ae 100644 --- a/drivers/sound/samsung-i2s.c +++ b/drivers/sound/samsung-i2s.c @@ -126,7 +126,7 @@ static void i2s_fifo(struct i2s_reg *i2s_reg, unsigned int flush) * @param i2s_reg i2s register address * @param dir Clock direction * - * @return int value 0 for success, -1 in case of error + * Return: int value 0 for success, -1 in case of error */ static int i2s_set_sysclk_dir(struct i2s_reg *i2s_reg, int dir) { @@ -148,7 +148,7 @@ static int i2s_set_sysclk_dir(struct i2s_reg *i2s_reg, int dir) * @param fmt i2s clock properties * @param i2s_reg i2s register address * - * @return int value 0 for success, -1 in case of error + * Return: int value 0 for success, -1 in case of error */ static int i2s_set_fmt(struct i2s_reg *i2s_reg, unsigned int fmt) { @@ -225,7 +225,7 @@ static int i2s_set_fmt(struct i2s_reg *i2s_reg, unsigned int fmt) * @param blc samplewidth (size of sample in bits) * @param i2s_reg i2s register address * - * @return int value 0 for success, -1 in case of error + * Return: int value 0 for success, -1 in case of error */ static int i2s_set_samplesize(struct i2s_reg *i2s_reg, unsigned int blc) { diff --git a/drivers/sound/tegra_ahub.c b/drivers/sound/tegra_ahub.c index 8708fc44a9..495a29c513 100644 --- a/drivers/sound/tegra_ahub.c +++ b/drivers/sound/tegra_ahub.c @@ -70,7 +70,7 @@ static int tegra_ahub_apbif_is_full(struct udevice *dev) /** * tegra_ahub_wait_for_space() - Wait for space in the FIFO * - * @return 0 if OK, -ETIMEDOUT if no space was available in time + * Return: 0 if OK, -ETIMEDOUT if no space was available in time */ static int tegra_ahub_wait_for_space(struct udevice *dev) { diff --git a/drivers/sound/tegra_i2s_priv.h b/drivers/sound/tegra_i2s_priv.h index 7cd3fc808c..65a3623ad9 100644 --- a/drivers/sound/tegra_i2s_priv.h +++ b/drivers/sound/tegra_i2s_priv.h @@ -22,7 +22,7 @@ enum { * * @dev: I2S device * @value: Value to write to CIF_TX_CTRL register - * @return 0 + * Return: 0 */ int tegra_i2s_set_cif_tx_ctrl(struct udevice *dev, u32 value); diff --git a/drivers/sound/wm8994.c b/drivers/sound/wm8994.c index cb1e97d7a5..fd646479b3 100644 --- a/drivers/sound/wm8994.c +++ b/drivers/sound/wm8994.c @@ -71,7 +71,7 @@ static int bclk_divs[] = { * @param reg reg number to be write * @param data data to be writen to the above registor * - * @return int value 1 for change, 0 for no change or negative error code. + * Return: int value 1 for change, 0 for no change or negative error code. */ static int wm8994_i2c_write(struct wm8994_priv *priv, unsigned int reg, unsigned short data) @@ -92,7 +92,7 @@ static int wm8994_i2c_write(struct wm8994_priv *priv, unsigned int reg, * @param reg reg number to be read * @param data address of read data to be stored * - * @return int value 0 for success, -1 in case of error. + * Return: int value 0 for success, -1 in case of error. */ static unsigned int wm8994_i2c_read(struct wm8994_priv *priv, unsigned int reg, unsigned short *data) @@ -122,7 +122,7 @@ static unsigned int wm8994_i2c_read(struct wm8994_priv *priv, unsigned int reg, * @param mask register mask * @param value new value * - * @return int value 1 if change in the register value, + * Return: int value 1 if change in the register value, * 0 for no change or negative error code. */ static int wm8994_bic_or(struct wm8994_priv *priv, unsigned int reg, @@ -150,7 +150,7 @@ static int wm8994_bic_or(struct wm8994_priv *priv, unsigned int reg, * @param aif_id Interface ID * @param fmt i2S format * - * @return -1 for error and 0 Success. + * Return: -1 for error and 0 Success. */ static int wm8994_set_fmt(struct wm8994_priv *priv, int aif_id, uint fmt) { @@ -274,7 +274,7 @@ static int wm8994_set_fmt(struct wm8994_priv *priv, int aif_id, uint fmt) * @param bits_per_sample Bits per sample * @param Channels Channels in the given audio input * - * @return -1 for error and 0 Success. + * Return: -1 for error and 0 Success. */ static int wm8994_hw_params(struct wm8994_priv *priv, int aif_id, uint sampling_rate, uint bits_per_sample, @@ -417,7 +417,7 @@ static int wm8994_hw_params(struct wm8994_priv *priv, int aif_id, * @param priv wm8994 information pointer * @param aif Audio Interface ID * - * @return -1 for error and 0 Success. + * Return: -1 for error and 0 Success. */ static int configure_aif_clock(struct wm8994_priv *priv, int aif) { @@ -497,7 +497,7 @@ static int configure_aif_clock(struct wm8994_priv *priv, int aif) * @param clk_id Input Clock ID * @param freq Sampling frequency in Hz * - * @return -1 for error and 0 success. + * Return: -1 for error and 0 success. */ static int wm8994_set_sysclk(struct wm8994_priv *priv, int aif_id, int clk_id, unsigned int freq) diff --git a/drivers/spi/ich.c b/drivers/spi/ich.c index 42071bb70c..9142ffd238 100644 --- a/drivers/spi/ich.c +++ b/drivers/spi/ich.c @@ -504,7 +504,7 @@ static int wait_for_hwseq_xfer(struct fast_spi_regs *regs, uint offset) * @hsfsts_cycle: Cycle type (enum hsfsts_cycle_t) * @offset: Offset to access * @len: Number of bytes to transfer (can be 0) - * @return 0 if OK, -EIO on flash-cycle error (FCERR), -EPERM on access error + * Return: 0 if OK, -EIO on flash-cycle error (FCERR), -EPERM on access error * (AEL), -ETIMEDOUT on timeout */ static int exec_sync_hwseq_xfer(struct fast_spi_regs *regs, uint hsfsts_cycle, @@ -615,7 +615,7 @@ static int ich_spi_exec_op(struct spi_slave *slave, const struct spi_mem_op *op) * @pchp: Returns a pointer to the pch, or NULL if not found * @ich_versionp: Returns ICH version detected on success * @mmio_basep: Returns the address of the SPI registers on success - * @return 0 if OK, -EPROTOTYPE if the PCH could not be found, -EAGAIN if + * Return: 0 if OK, -EPROTOTYPE if the PCH could not be found, -EAGAIN if * the function cannot success without probing, possible another error if * pch_get_spi_base() fails */ diff --git a/drivers/spi/octeon_spi.c b/drivers/spi/octeon_spi.c index 6ac66d2f9a..fcabc112d2 100644 --- a/drivers/spi/octeon_spi.c +++ b/drivers/spi/octeon_spi.c @@ -137,7 +137,7 @@ static void octeon_spi_wait_ready(struct udevice *dev) * * @param dev SPI bus * - * @return 0 for success, -EINVAL if chip select is invalid + * Return: 0 for success, -EINVAL if chip select is invalid */ static int octeon_spi_claim_bus(struct udevice *dev) { @@ -168,7 +168,7 @@ static int octeon_spi_claim_bus(struct udevice *dev) * * @param dev SPI bus * - * @return 0 for success, -EINVAL if chip select is invalid + * Return: 0 for success, -EINVAL if chip select is invalid */ static int octeon_spi_release_bus(struct udevice *dev) { diff --git a/drivers/tpm/cr50_i2c.c b/drivers/tpm/cr50_i2c.c index 7a2b5a4faa..f8c3087894 100644 --- a/drivers/tpm/cr50_i2c.c +++ b/drivers/tpm/cr50_i2c.c @@ -467,7 +467,7 @@ out_err: * TPM finished reset processing. * * @dev: Cr50 device - * @return 0 if OK, -EPERM if locality could not be taken + * Return: 0 if OK, -EPERM if locality could not be taken */ static int process_reset(struct udevice *dev) { diff --git a/drivers/tpm/sandbox_common.h b/drivers/tpm/sandbox_common.h index e822a200fd..f423c50ec5 100644 --- a/drivers/tpm/sandbox_common.h +++ b/drivers/tpm/sandbox_common.h @@ -57,7 +57,7 @@ struct nvdata_state { * number used by the sandbox emulation. * * @index: Index to use (FIRMWARE_NV_INDEX, etc.) - * @return associated space (enum sandbox_nv_space) + * Return: associated space (enum sandbox_nv_space) */ int sb_tpm_index_to_seq(uint index); diff --git a/drivers/tpm/tpm2_tis_spi.c b/drivers/tpm/tpm2_tis_spi.c index 58b6f33510..de9cf8f21e 100644 --- a/drivers/tpm/tpm2_tis_spi.c +++ b/drivers/tpm/tpm2_tis_spi.c @@ -60,7 +60,7 @@ struct tpm_tis_chip_data { * NOTE: TPM is big-endian for multi-byte values. Multi-byte * values have to be swapped. * - * @return -EIO on error, 0 on success. + * Return: -EIO on error, 0 on success. */ static int tpm_tis_spi_xfer(struct udevice *dev, u32 addr, const u8 *out, u8 *in, u16 len) diff --git a/drivers/tpm/tpm_atmel_twi.c b/drivers/tpm/tpm_atmel_twi.c index fa4fbec6bb..c059ea4cfe 100644 --- a/drivers/tpm/tpm_atmel_twi.c +++ b/drivers/tpm/tpm_atmel_twi.c @@ -48,7 +48,7 @@ static int tpm_atmel_twi_close(struct udevice *dev) * @dev: Device to check * @buf: Buffer to put the string * @size: Maximum size of buffer - * @return length of string, or -ENOSPC it no space + * Return: length of string, or -ENOSPC it no space */ static int tpm_atmel_twi_get_desc(struct udevice *dev, char *buf, int size) { diff --git a/drivers/usb/host/ehci.h b/drivers/usb/host/ehci.h index e9e6f2a551..5170044a3a 100644 --- a/drivers/usb/host/ehci.h +++ b/drivers/usb/host/ehci.h @@ -280,7 +280,7 @@ void ehci_set_controller_priv(int index, void *priv, * ehci_get_controller_priv() - Get controller private data * * @index Controller number to get - * @return controller pointer for this index + * Return: controller pointer for this index */ void *ehci_get_controller_priv(int index); diff --git a/drivers/usb/host/xhci-mem.c b/drivers/usb/host/xhci-mem.c index 0d9da62bab..21cd03b662 100644 --- a/drivers/usb/host/xhci-mem.c +++ b/drivers/usb/host/xhci-mem.c @@ -32,7 +32,7 @@ * * @param addr pointer to memory region to be flushed * @param len the length of the cache line to be flushed - * @return none + * Return: none */ void xhci_flush_cache(uintptr_t addr, u32 len) { @@ -47,7 +47,7 @@ void xhci_flush_cache(uintptr_t addr, u32 len) * * @param addr pointer to memory region to be invalidates * @param len the length of the cache line to be invalidated - * @return none + * Return: none */ void xhci_inval_cache(uintptr_t addr, u32 len) { @@ -62,7 +62,7 @@ void xhci_inval_cache(uintptr_t addr, u32 len) * frees the "segment" pointer passed * * @param ptr pointer to "segement" to be freed - * @return none + * Return: none */ static void xhci_segment_free(struct xhci_segment *seg) { @@ -76,7 +76,7 @@ static void xhci_segment_free(struct xhci_segment *seg) * frees the "ring" pointer passed * * @param ptr pointer to "ring" to be freed - * @return none + * Return: none */ static void xhci_ring_free(struct xhci_ring *ring) { @@ -101,7 +101,7 @@ static void xhci_ring_free(struct xhci_ring *ring) * Free the scratchpad buffer array and scratchpad buffers * * @ctrl host controller data structure - * @return none + * Return: none */ static void xhci_scratchpad_free(struct xhci_ctrl *ctrl) { @@ -120,7 +120,7 @@ static void xhci_scratchpad_free(struct xhci_ctrl *ctrl) * frees the "xhci_container_ctx" pointer passed * * @param ptr pointer to "xhci_container_ctx" to be freed - * @return none + * Return: none */ static void xhci_free_container_ctx(struct xhci_container_ctx *ctx) { @@ -132,7 +132,7 @@ static void xhci_free_container_ctx(struct xhci_container_ctx *ctx) * frees the virtual devices for "xhci_ctrl" pointer passed * * @param ptr pointer to "xhci_ctrl" whose virtual devices are to be freed - * @return none + * Return: none */ static void xhci_free_virt_devices(struct xhci_ctrl *ctrl) { @@ -170,7 +170,7 @@ static void xhci_free_virt_devices(struct xhci_ctrl *ctrl) * frees all the memory allocated * * @param ptr pointer to "xhci_ctrl" to be cleaned up - * @return none + * Return: none */ void xhci_cleanup(struct xhci_ctrl *ctrl) { @@ -187,7 +187,7 @@ void xhci_cleanup(struct xhci_ctrl *ctrl) * Malloc the aligned memory * * @param size size of memory to be allocated - * @return allocates the memory and returns the aligned pointer + * Return: allocates the memory and returns the aligned pointer */ static void *xhci_malloc(unsigned int size) { @@ -212,7 +212,7 @@ static void *xhci_malloc(unsigned int size) * @param prev pointer to the previous segment * @param next pointer to the next segment * @param link_trbs flag to indicate whether to link the trbs or NOT - * @return none + * Return: none */ static void xhci_link_segments(struct xhci_ctrl *ctrl, struct xhci_segment *prev, struct xhci_segment *next, bool link_trbs) @@ -243,7 +243,7 @@ static void xhci_link_segments(struct xhci_ctrl *ctrl, struct xhci_segment *prev * Initialises the Ring's enqueue,dequeue,enq_seg pointers * * @param ring pointer to the RING to be intialised - * @return none + * Return: none */ static void xhci_initialize_ring_info(struct xhci_ring *ring) { @@ -271,7 +271,7 @@ static void xhci_initialize_ring_info(struct xhci_ring *ring) * "All components of all Command and Transfer TRBs shall be initialized to '0'" * * @param none - * @return pointer to the newly allocated SEGMENT + * Return: pointer to the newly allocated SEGMENT */ static struct xhci_segment *xhci_segment_alloc(void) { @@ -300,7 +300,7 @@ static struct xhci_segment *xhci_segment_alloc(void) * * @param num_segs number of segments in the ring * @param link_trbs flag to indicate whether to link the trbs or NOT - * @return pointer to the newly created RING + * Return: pointer to the newly created RING */ struct xhci_ring *xhci_ring_alloc(struct xhci_ctrl *ctrl, unsigned int num_segs, bool link_trbs) @@ -346,7 +346,7 @@ struct xhci_ring *xhci_ring_alloc(struct xhci_ctrl *ctrl, unsigned int num_segs, * Set up the scratchpad buffer array and scratchpad buffers * * @ctrl host controller data structure - * @return -ENOMEM if buffer allocation fails, 0 on success + * Return: -ENOMEM if buffer allocation fails, 0 on success */ static int xhci_scratchpad_alloc(struct xhci_ctrl *ctrl) { @@ -419,7 +419,7 @@ fail_sp: * * @param ctrl Host controller data structure * @param type type of XHCI Container Context - * @return NULL if failed else pointer to the context on success + * Return: NULL if failed else pointer to the context on success */ static struct xhci_container_ctx *xhci_alloc_container_ctx(struct xhci_ctrl *ctrl, int type) @@ -445,7 +445,7 @@ static struct xhci_container_ctx * Allocating virtual device * * @param udev pointer to USB deivce structure - * @return 0 on success else -1 on failure + * Return: 0 on success else -1 on failure */ int xhci_alloc_virt_device(struct xhci_ctrl *ctrl, unsigned int slot_id) { @@ -504,7 +504,7 @@ int xhci_alloc_virt_device(struct xhci_ctrl *ctrl, unsigned int slot_id) * @param ctrl Host controller data structure * @param hccr pointer to HOST Controller Control Registers * @param hcor pointer to HOST Controller Operational Registers - * @return 0 if successful else -1 on failure + * Return: 0 if successful else -1 on failure */ int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr, struct xhci_hcor *hcor) @@ -611,7 +611,7 @@ int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr, * Give the input control context for the passed container context * * @param ctx pointer to the context - * @return pointer to the Input control context data + * Return: pointer to the Input control context data */ struct xhci_input_control_ctx *xhci_get_input_control_ctx(struct xhci_container_ctx *ctx) @@ -625,7 +625,7 @@ struct xhci_input_control_ctx * * @param ctrl Host controller data structure * @param ctx pointer to the context - * @return pointer to the slot control context data + * Return: pointer to the slot control context data */ struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_ctrl *ctrl, struct xhci_container_ctx *ctx) @@ -643,7 +643,7 @@ struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_ctrl *ctrl, * @param ctrl Host controller data structure * @param ctx context container * @param ep_index index of the endpoint - * @return pointer to the End point context + * Return: pointer to the End point context */ struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_ctrl *ctrl, struct xhci_container_ctx *ctx, @@ -668,7 +668,7 @@ struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_ctrl *ctrl, * @param in_ctx contains the input context * @param out_ctx contains the input context * @param ep_index index of the end point - * @return none + * Return: none */ void xhci_endpoint_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx, @@ -697,7 +697,7 @@ void xhci_endpoint_copy(struct xhci_ctrl *ctrl, * @param ctrl Host controller data structure * @param in_ctx contains the inpout context * @param out_ctx contains the inpout context - * @return none + * Return: none */ void xhci_slot_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx, struct xhci_container_ctx *out_ctx) @@ -718,7 +718,7 @@ void xhci_slot_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx, * Setup an xHCI virtual device for a Set Address command * * @param udev pointer to the Device Data Structure - * @return returns negative value on failure else 0 on success + * Return: returns negative value on failure else 0 on success */ void xhci_setup_addressable_virt_dev(struct xhci_ctrl *ctrl, struct usb_device *udev, int hop_portnr) diff --git a/drivers/usb/host/xhci-ring.c b/drivers/usb/host/xhci-ring.c index 35bd5cd29e..0b3e7a2f55 100644 --- a/drivers/usb/host/xhci-ring.c +++ b/drivers/usb/host/xhci-ring.c @@ -33,7 +33,7 @@ * @param ring pointer to the ring * @param seg poniter to the segment to which TRB belongs * @param trb poniter to the ring trb - * @return 1 if this TRB a link TRB else 0 + * Return: 1 if this TRB a link TRB else 0 */ static int last_trb(struct xhci_ctrl *ctrl, struct xhci_ring *ring, struct xhci_segment *seg, union xhci_trb *trb) @@ -52,7 +52,7 @@ static int last_trb(struct xhci_ctrl *ctrl, struct xhci_ring *ring, * @param ring pointer to the ring * @param seg poniter to the segment to which TRB belongs * @param trb poniter to the ring trb - * @return 1 if this TRB is the last TRB on the last segment else 0 + * Return: 1 if this TRB is the last TRB on the last segment else 0 */ static bool last_trb_on_last_seg(struct xhci_ctrl *ctrl, struct xhci_ring *ring, @@ -86,7 +86,7 @@ static bool last_trb_on_last_seg(struct xhci_ctrl *ctrl, * are expected or NOT. * Will you enqueue more TRBs before calling * prepare_ring()? - * @return none + * Return: none */ static void inc_enq(struct xhci_ctrl *ctrl, struct xhci_ring *ring, bool more_trbs_coming) @@ -178,7 +178,7 @@ static void inc_deq(struct xhci_ctrl *ctrl, struct xhci_ring *ring) * @param ring pointer to the ring * @param more_trbs_coming flag to indicate whether more trbs * @param trb_fields pointer to trb field array containing TRB contents - * @return pointer to the enqueued trb + * Return: pointer to the enqueued trb */ static struct xhci_generic_trb *queue_trb(struct xhci_ctrl *ctrl, struct xhci_ring *ring, @@ -207,7 +207,7 @@ static struct xhci_generic_trb *queue_trb(struct xhci_ctrl *ctrl, * @param ctrl Host controller data structure * @param ep_ring pointer to the EP Transfer Ring * @param ep_state State of the End Point - * @return error code in case of invalid ep_state, 0 on success + * Return: error code in case of invalid ep_state, 0 on success */ static int prepare_ring(struct xhci_ctrl *ctrl, struct xhci_ring *ep_ring, u32 ep_state) @@ -269,7 +269,7 @@ static int prepare_ring(struct xhci_ctrl *ctrl, struct xhci_ring *ep_ring, * @param slot_id Slot ID to encode in the flags field (opt.) * @param ep_index Endpoint index to encode in the flags field (opt.) * @param cmd Command type to enqueue - * @return none + * Return: none */ void xhci_queue_command(struct xhci_ctrl *ctrl, u8 *ptr, u32 slot_id, u32 ep_index, trb_type cmd) @@ -327,7 +327,7 @@ void xhci_queue_command(struct xhci_ctrl *ctrl, u8 *ptr, u32 slot_id, * @param td_total_len total packet count * @param maxp max packet size of current pipe * @param more_trbs_coming indicate last trb in TD - * @return remainder + * Return: remainder */ static u32 xhci_td_remainder(struct xhci_ctrl *ctrl, int transferred, int trb_buff_len, unsigned int td_total_len, @@ -361,7 +361,7 @@ static u32 xhci_td_remainder(struct xhci_ctrl *ctrl, int transferred, * @param ep_index index of the endpoint * @param start_cycle cycle flag of the first TRB * @param start_trb pionter to the first TRB - * @return none + * Return: none */ static void giveback_first_trb(struct usb_device *udev, int ep_index, int start_cycle, @@ -395,7 +395,7 @@ static void giveback_first_trb(struct usb_device *udev, int ep_index, * the end of each event handler, and not touch the TRB again afterwards. * * @param ctrl Host controller data structure - * @return none + * Return: none */ void xhci_acknowledge_event(struct xhci_ctrl *ctrl) { @@ -411,7 +411,7 @@ void xhci_acknowledge_event(struct xhci_ctrl *ctrl) * Checks if there is a new event to handle on the event ring. * * @param ctrl Host controller data structure - * @return 0 if failure else 1 on success + * Return: 0 if failure else 1 on success */ static int event_ready(struct xhci_ctrl *ctrl) { @@ -437,7 +437,7 @@ static int event_ready(struct xhci_ctrl *ctrl) * * @param ctrl Host controller data structure * @param expected TRB type expected from Event TRB - * @return pointer to event trb + * Return: pointer to event trb */ union xhci_trb *xhci_wait_for_event(struct xhci_ctrl *ctrl, trb_type expected) { @@ -557,7 +557,7 @@ static void record_transfer_result(struct usb_device *udev, * @param pipe contains the DIR_IN or OUT , devnum * @param length length of the buffer * @param buffer buffer to be read/written based on the request - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ int xhci_bulk_tx(struct usb_device *udev, unsigned long pipe, int length, void *buffer) @@ -753,7 +753,7 @@ again: * @param req request type * @param length length of the buffer * @param buffer buffer to be read/written based on the request - * @return returns 0 if successful else error code on failure + * Return: returns 0 if successful else error code on failure */ int xhci_ctrl_tx(struct usb_device *udev, unsigned long pipe, struct devrequest *req, int length, diff --git a/drivers/usb/host/xhci.c b/drivers/usb/host/xhci.c index 452dacc0af..ad73ba12e2 100644 --- a/drivers/usb/host/xhci.c +++ b/drivers/usb/host/xhci.c @@ -143,7 +143,7 @@ struct xhci_ctrl *xhci_get_ctrl(struct usb_device *udev) * @param mask mask for the value read * @param done value to be campared with result * @param usec time to wait till - * @return 0 if handshake is success else < 0 on failure + * Return: 0 if handshake is success else < 0 on failure */ static int handshake(uint32_t volatile *ptr, uint32_t mask, uint32_t done, int usec) @@ -164,7 +164,7 @@ handshake(uint32_t volatile *ptr, uint32_t mask, uint32_t done, int usec) * Set the run bit and wait for the host to be running. * * @param hcor pointer to host controller operation registers - * @return status of the Handshake + * Return: status of the Handshake */ static int xhci_start(struct xhci_hcor *hcor) { @@ -192,7 +192,7 @@ static int xhci_start(struct xhci_hcor *hcor) * Resets the XHCI Controller * * @param hcor pointer to host controller operation registers - * @return -EBUSY if XHCI Controller is not halted else status of handshake + * Return: -EBUSY if XHCI Controller is not halted else status of handshake */ static int xhci_reset(struct xhci_hcor *hcor) { @@ -244,7 +244,7 @@ static int xhci_reset(struct xhci_hcor *hcor) * index = (epnum * 2) + direction - 1 = (epnum * 2) + 1 - 1 = (epnum * 2) * * @param desc USB enpdoint Descriptor - * @return index of the Endpoint + * Return: index of the Endpoint */ static unsigned int xhci_get_ep_index(struct usb_endpoint_descriptor *desc) { @@ -447,7 +447,7 @@ static u32 xhci_get_max_esit_payload(struct usb_device *udev, * * @param udev pointer to the Device Data Structure * @param ctx_change flag to indicate the Context has changed or NOT - * @return 0 on success, -1 on failure + * Return: 0 on success, -1 on failure */ static int xhci_configure_endpoints(struct usb_device *udev, bool ctx_change) { @@ -487,7 +487,7 @@ static int xhci_configure_endpoints(struct usb_device *udev, bool ctx_change) * Configure the endpoint, programming the device contexts. * * @param udev pointer to the USB device structure - * @return returns the status of the xhci_configure_endpoints + * Return: returns the status of the xhci_configure_endpoints */ static int xhci_set_configuration(struct usb_device *udev) { @@ -630,7 +630,7 @@ static int xhci_set_configuration(struct usb_device *udev) * the device). * * @param udev pointer to the Device Data Structure - * @return 0 if successful else error code on failure + * Return: 0 if successful else error code on failure */ static int xhci_address_device(struct usb_device *udev, int root_portnr) { @@ -712,7 +712,7 @@ static int xhci_address_device(struct usb_device *udev, int root_portnr) * or allocating memory failed. * * @param udev pointer to the Device Data Structure - * @return Returns 0 on succes else return error code on failure + * Return: Returns 0 on succes else return error code on failure */ static int _xhci_alloc_device(struct usb_device *udev) { @@ -766,7 +766,7 @@ int usb_alloc_device(struct usb_device *udev) * we need to issue an evaluate context command and wait on it. * * @param udev pointer to the Device Data Structure - * @return returns the status of the xhci_configure_endpoints + * Return: returns the status of the xhci_configure_endpoints */ int xhci_check_maxpacket(struct usb_device *udev) { @@ -822,7 +822,7 @@ int xhci_check_maxpacket(struct usb_device *udev) * @param wIndex request index * @param addr address of posrt status register * @param port_status state of port status register - * @return none + * Return: none */ static void xhci_clear_port_change_bit(u16 wValue, u16 wIndex, volatile uint32_t *addr, u32 port_status) @@ -870,7 +870,7 @@ static void xhci_clear_port_change_bit(u16 wValue, * For all other types (RW1S, RW1CS, RW, and RZ), writing a '0' has no effect. * * @param state state of the Port Status and Control Regsiter - * @return a value that would result in the port being in the + * Return: a value that would result in the port being in the * same state, if the value was written to the port * status control register. */ @@ -886,7 +886,7 @@ static u32 xhci_port_state_to_neutral(u32 state) * @param udev pointer to the USB device structure * @param pipe contains the DIR_IN or OUT , devnum * @param buffer buffer to be read/written based on the request - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ static int xhci_submit_root(struct usb_device *udev, unsigned long pipe, void *buffer, struct devrequest *req) @@ -1116,7 +1116,7 @@ unknown: * @param buffer buffer to be read/written based on the request * @param length length of the buffer * @param interval interval of the interrupt - * @return 0 + * Return: 0 */ static int _xhci_submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer, int length, int interval, @@ -1143,7 +1143,7 @@ static int _xhci_submit_int_msg(struct usb_device *udev, unsigned long pipe, * @param pipe contains the DIR_IN or OUT , devnum * @param buffer buffer to be read/written based on the request * @param length length of the buffer - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ static int _xhci_submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer, int length) @@ -1165,7 +1165,7 @@ static int _xhci_submit_bulk_msg(struct usb_device *udev, unsigned long pipe, * @param length length of the buffer * @param setup Request type * @param root_portnr Root port number that this device is on - * @return returns 0 if successful else -1 on failure + * Return: returns 0 if successful else -1 on failure */ static int _xhci_submit_control_msg(struct usb_device *udev, unsigned long pipe, void *buffer, int length, @@ -1299,7 +1299,7 @@ int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer, * and allocates the necessary data structures * * @param index index to the host controller data structure - * @return pointer to the intialised controller + * Return: pointer to the intialised controller */ int usb_lowlevel_init(int index, enum usb_init_type init, void **controller) { @@ -1338,7 +1338,7 @@ int usb_lowlevel_init(int index, enum usb_init_type init, void **controller) * and cleans up all the related data structures * * @param index index to the host controller data structure - * @return none + * Return: none */ int usb_lowlevel_stop(int index) { diff --git a/drivers/usb/musb-new/musb_gadget.c b/drivers/usb/musb-new/musb_gadget.c index 7cca92b970..05bd948785 100644 --- a/drivers/usb/musb-new/musb_gadget.c +++ b/drivers/usb/musb-new/musb_gadget.c @@ -1966,7 +1966,7 @@ void musb_gadget_cleanup(struct musb *musb) * -ENOMEM no memory to perform the operation * * @param driver the gadget driver - * @return <0 if error, 0 if everything is fine + * Return: <0 if error, 0 if everything is fine */ #ifndef __UBOOT__ static int musb_gadget_start(struct usb_gadget *g, diff --git a/drivers/usb/musb-new/musb_gadget_ep0.c b/drivers/usb/musb-new/musb_gadget_ep0.c index cbd92fca6b..7fdd24005e 100644 --- a/drivers/usb/musb-new/musb_gadget_ep0.c +++ b/drivers/usb/musb-new/musb_gadget_ep0.c @@ -147,7 +147,7 @@ static int service_tx_status_request( * that is supposed to be a standard control request. Assumes the fifo to * be at least 2 bytes long. * - * @return 0 if the request was NOT HANDLED, + * Return: 0 if the request was NOT HANDLED, * < 0 when error * > 0 when the request is processed * diff --git a/drivers/usb/musb-new/usb-compat.h b/drivers/usb/musb-new/usb-compat.h index 1c66c4fe36..df68c9220a 100644 --- a/drivers/usb/musb-new/usb-compat.h +++ b/drivers/usb/musb-new/usb-compat.h @@ -72,7 +72,7 @@ static inline int usb_hcd_unmap_urb_for_dma(struct usb_hcd *hcd, * usb_dev_get_parent() - Get the parent of a USB device * * @udev: USB struct containing information about the device - * @return associated device for which udev == dev_get_parent_priv(dev) + * Return: associated device for which udev == dev_get_parent_priv(dev) */ struct usb_device *usb_dev_get_parent(struct usb_device *udev); diff --git a/drivers/video/bridge/ps862x.c b/drivers/video/bridge/ps862x.c index c8e105857f..d1d22a6e23 100644 --- a/drivers/video/bridge/ps862x.c +++ b/drivers/video/bridge/ps862x.c @@ -33,7 +33,7 @@ DECLARE_GLOBAL_DATA_PTR; * @param addr_off offset from the i2c base address for ps8622 * @param reg_addr register address to write * @param value value to be written - * @return 0 on success, non-0 on failure + * Return: 0 on success, non-0 on failure */ static int ps8622_write(struct udevice *dev, unsigned addr_off, unsigned char reg_addr, unsigned char value) diff --git a/drivers/video/console_truetype.c b/drivers/video/console_truetype.c index de8b86bbac..c04b449a6d 100644 --- a/drivers/video/console_truetype.c +++ b/drivers/video/console_truetype.c @@ -368,7 +368,7 @@ static int console_truetype_putc_xy(struct udevice *dev, uint x, uint y, * @xend: X end position in pixels from the left * @yend: Y end position in pixels from the top * @clr: Value to write - * @return 0 if OK, -ENOSYS if the display depth is not supported + * Return: 0 if OK, -ENOSYS if the display depth is not supported */ static int console_truetype_erase(struct udevice *dev, int xstart, int ystart, int xend, int yend, int clr) @@ -429,7 +429,7 @@ static int console_truetype_erase(struct udevice *dev, int xstart, int ystart, * not been entered. * * @dev: Device to update - * @return 0 if OK, -ENOSYS if not supported + * Return: 0 if OK, -ENOSYS if not supported */ static int console_truetype_backspace(struct udevice *dev) { @@ -535,7 +535,7 @@ static struct font_info font_table[] = { * * This searched for the first available font. * - * @return pointer to the font, or NULL if none is found + * Return: pointer to the font, or NULL if none is found */ static u8 *console_truetype_find_font(void) { diff --git a/drivers/video/imx/ipu_common.c b/drivers/video/imx/ipu_common.c index 5908b23acc..54d1efc8f5 100644 --- a/drivers/video/imx/ipu_common.c +++ b/drivers/video/imx/ipu_common.c @@ -457,7 +457,7 @@ static void ipu_reset(void) * @param dev The device structure for the IPU passed in by the * driver framework. * - * @return Returns 0 on success or negative error code on error + * Return: Returns 0 on success or negative error code on error */ int ipu_probe(void) { @@ -574,7 +574,7 @@ void ipu_dump_registers(void) * @param params Input parameter containing union of channel * initialization parameters. * - * @return Returns 0 on success or negative error code on fail + * Return: Returns 0 on success or negative error code on fail */ int32_t ipu_init_channel(ipu_channel_t channel, ipu_channel_params_t *params) { @@ -1006,7 +1006,7 @@ static void ipu_ch_param_init(int ch, * @param v private v offset for additional cropping, * zero if not used. * - * @return Returns 0 on success or negative error code on fail + * Return: Returns 0 on success or negative error code on fail */ int32_t ipu_init_channel_buffer(ipu_channel_t channel, ipu_buffer_t type, uint32_t pixel_fmt, @@ -1061,7 +1061,7 @@ int32_t ipu_init_channel_buffer(ipu_channel_t channel, ipu_buffer_t type, * * @param channel Input parameter for the logical channel ID. * - * @return This function returns 0 on success or negative error code on + * Return: This function returns 0 on success or negative error code on * fail. */ int32_t ipu_enable_channel(ipu_channel_t channel) @@ -1139,7 +1139,7 @@ void ipu_clear_buffer_ready(ipu_channel_t channel, ipu_buffer_t type, * @param wait_for_stop Flag to set whether to wait for channel end * of frame or return immediately. * - * @return This function returns 0 on success or negative error code on + * Return: This function returns 0 on success or negative error code on * fail. */ int32_t ipu_disable_channel(ipu_channel_t channel) diff --git a/drivers/video/imx/ipu_disp.c b/drivers/video/imx/ipu_disp.c index 45069897fa..144322e4e2 100644 --- a/drivers/video/imx/ipu_disp.c +++ b/drivers/video/imx/ipu_disp.c @@ -822,7 +822,7 @@ static int ipu_pixfmt_to_map(uint32_t fmt) * * @param sig Bitfield of signal polarities for LCD interface. * - * @return This function returns 0 on success or negative error code on + * Return: This function returns 0 on success or negative error code on * fail. */ @@ -1171,7 +1171,7 @@ int32_t ipu_init_sync_panel(int disp, uint32_t pixel_clk, * * @param alpha Global alpha value. * - * @return Returns 0 on success or negative error code on fail + * Return: Returns 0 on success or negative error code on fail */ int32_t ipu_disp_set_global_alpha(ipu_channel_t channel, unsigned char enable, uint8_t alpha) @@ -1226,7 +1226,7 @@ int32_t ipu_disp_set_global_alpha(ipu_channel_t channel, unsigned char enable, * * @param colorKey 24-bit RGB color for transparent color key. * - * @return Returns 0 on success or negative error code on fail + * Return: Returns 0 on success or negative error code on fail */ int32_t ipu_disp_set_color_key(ipu_channel_t channel, unsigned char enable, uint32_t color_key) diff --git a/drivers/video/imx/mxc_ipuv3_fb.c b/drivers/video/imx/mxc_ipuv3_fb.c index 6cdbbafafb..98228f2ad6 100644 --- a/drivers/video/imx/mxc_ipuv3_fb.c +++ b/drivers/video/imx/mxc_ipuv3_fb.c @@ -428,7 +428,7 @@ static int mxcfb_unmap_video_memory(struct fb_info *fbi) * structures. This includes information such as bits per pixel, * color maps, screen width/height and RGBA offsets. * - * @return Framebuffer structure initialized with our information + * Return: Framebuffer structure initialized with our information */ static struct fb_info *mxcfb_init_fbinfo(void) { @@ -479,7 +479,7 @@ extern struct clk *g_ipu_clk; * this routine: Framebuffer initialization, Memory allocation and * mapping, Framebuffer registration, IPU initialization. * - * @return Appropriate error code to the kernel common code + * Return: Appropriate error code to the kernel common code */ static int mxcfb_probe(struct udevice *dev, u32 interface_pix_fmt, uint8_t disp, struct fb_videomode const *mode) diff --git a/drivers/video/meson/simplefb_common.h b/drivers/video/meson/simplefb_common.h index 9ea7b0486c..d0cc1b401f 100644 --- a/drivers/video/meson/simplefb_common.h +++ b/drivers/video/meson/simplefb_common.h @@ -14,7 +14,7 @@ * * @blob: device tree blob * @pipeline: display pipeline - * @return device node offset in blob, or negative values if failed + * Return: device node offset in blob, or negative values if failed */ int meson_simplefb_fdt_match(void *blob, const char *pipeline); diff --git a/drivers/video/panel-uclass.c b/drivers/video/panel-uclass.c index bb2eaae2e9..1f7e20e0b5 100644 --- a/drivers/video/panel-uclass.c +++ b/drivers/video/panel-uclass.c @@ -26,7 +26,7 @@ int panel_enable_backlight(struct udevice *dev) * @dev: Panel device containing the backlight to update * @percent: Brightness value (0=off, 1=min brightness, * 100=full brightness) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int panel_set_backlight(struct udevice *dev, int percent) { diff --git a/drivers/video/rockchip/rk_hdmi.h b/drivers/video/rockchip/rk_hdmi.h index 859a0b9ff3..200dbaea74 100644 --- a/drivers/video/rockchip/rk_hdmi.h +++ b/drivers/video/rockchip/rk_hdmi.h @@ -33,7 +33,7 @@ struct rk_hdmi_priv { * @dev: device * @buf: output buffer for the EDID * @buf_size: number of bytes in the buffer - * @return number of bytes read if OK, -ve if something went wrong + * Return: number of bytes read if OK, -ve if something went wrong */ int rk_hdmi_read_edid(struct udevice *dev, u8 *buf, int buf_size); @@ -55,7 +55,7 @@ void rk_hdmi_probe_regulators(struct udevice *dev, * rk_hdmi_of_to_plat() - common of_to_plat implementation * * @dev: device - * @return 0 if OK, -ve if something went wrong + * Return: 0 if OK, -ve if something went wrong */ int rk_hdmi_of_to_plat(struct udevice *dev); @@ -68,7 +68,7 @@ int rk_hdmi_of_to_plat(struct udevice *dev); * 3. initialises the Designware HDMI PHY * * @dev: device - * @return 0 if OK, -ve if something went wrong + * Return: 0 if OK, -ve if something went wrong */ int rk_hdmi_probe(struct udevice *dev); diff --git a/drivers/video/rockchip/rk_vop.c b/drivers/video/rockchip/rk_vop.c index fe0574870f..bc98ab6875 100644 --- a/drivers/video/rockchip/rk_vop.c +++ b/drivers/video/rockchip/rk_vop.c @@ -238,7 +238,7 @@ static void rkvop_mode_set(struct udevice *dev, * @fbbase: Frame buffer address * @ep_node: Device tree node to process - this is the offset of an endpoint * node within the VOP's 'port' list. - * @return 0 if OK, -ve if something went wrong + * Return: 0 if OK, -ve if something went wrong */ static int rk_display_init(struct udevice *dev, ulong fbbase, ofnode ep_node) { diff --git a/drivers/video/rockchip/rk_vop.h b/drivers/video/rockchip/rk_vop.h index 53a79c04b5..0528fb23f5 100644 --- a/drivers/video/rockchip/rk_vop.h +++ b/drivers/video/rockchip/rk_vop.h @@ -32,7 +32,7 @@ struct rkvop_driverdata { * successfully initialised). * * @dev: device - * @return 0 if OK, -ve if something went wrong + * Return: 0 if OK, -ve if something went wrong */ int rk_vop_probe(struct udevice *dev); @@ -44,7 +44,7 @@ int rk_vop_probe(struct udevice *dev); * (32 BPP) x VIDEO_ROCKCHIP_MAX_XRES x VIDEO_ROCKCHIP_MAX_YRES * * @dev: device - * @return 0 (always OK) + * Return: 0 (always OK) */ int rk_vop_bind(struct udevice *dev); diff --git a/drivers/video/sunxi/simplefb_common.h b/drivers/video/sunxi/simplefb_common.h index f4c5e745c6..10292a095a 100644 --- a/drivers/video/sunxi/simplefb_common.h +++ b/drivers/video/sunxi/simplefb_common.h @@ -14,7 +14,7 @@ * * @blob: device tree blob * @pipeline: display pipeline - * @return device node offset in blob, or negative values if failed + * Return: device node offset in blob, or negative values if failed */ int sunxi_simplefb_fdt_match(void *blob, const char *pipeline); diff --git a/drivers/video/tegra.c b/drivers/video/tegra.c index d60132eb77..3f9fcd0403 100644 --- a/drivers/video/tegra.c +++ b/drivers/video/tegra.c @@ -262,7 +262,7 @@ static int setup_window(struct disp_ctl_win *win, * @param blob Device tree blob * @param priv Driver's private data * @param default_lcd_base Default address of LCD frame buffer - * @return 0 if ok, -1 on error (unsupported bits per pixel) + * Return: 0 if ok, -1 on error (unsupported bits per pixel) */ static int tegra_display_probe(const void *blob, struct tegra_lcd_priv *priv, void *default_lcd_base) diff --git a/drivers/video/ti/am335x-fb.c b/drivers/video/ti/am335x-fb.c index 8b41dac66d..680ea47998 100644 --- a/drivers/video/ti/am335x-fb.c +++ b/drivers/video/ti/am335x-fb.c @@ -139,7 +139,7 @@ struct dpll_data { * * @dpll_data: struct dpll_data pointer for the DPLL * @rate: New DPLL clock rate - * @return rounded rate and the computed m, n and div values in the dpll_data + * Return: rounded rate and the computed m, n and div values in the dpll_data * structure, or -ve error code. */ static ulong am335x_dpll_round_rate(struct dpll_data *dd, ulong rate) @@ -189,7 +189,7 @@ static ulong am335x_dpll_round_rate(struct dpll_data *dd, ulong rate) * * @am335x_lcdhw: Base address of the LCD controller registers. * @rate: New clock rate in Hz. - * @return new rate, or -ve error code. + * Return: new rate, or -ve error code. */ static ulong am335x_fb_set_pixel_clk_rate(struct am335x_lcdhw *regs, ulong rate) { diff --git a/drivers/video/video_bmp.c b/drivers/video/video_bmp.c index e8600b2def..c8c3fd3549 100644 --- a/drivers/video/video_bmp.c +++ b/drivers/video/video_bmp.c @@ -21,7 +21,7 @@ /** * get_bmp_col_16bpp() - Convert a colour-table entry into a 16bpp pixel value * - * @return value to write to the 16bpp frame buffer for this palette entry + * Return: value to write to the 16bpp frame buffer for this palette entry */ static uint get_bmp_col_16bpp(struct bmp_color_table_entry cte) { diff --git a/drivers/video/videomodes.c b/drivers/video/videomodes.c index ed7373eac8..69ef736d4c 100644 --- a/drivers/video/videomodes.c +++ b/drivers/video/videomodes.c @@ -384,7 +384,7 @@ int video_get_option_int(const char *options, const char *name, int def) * @param t The EDID detailed timing to be converted * @param mode Returns the converted timing * - * @return 0 on success, or a negative errno on error + * Return: 0 on success, or a negative errno on error */ int video_edid_dtd_to_ctfb_res_modes(struct edid_detailed_timing *t, struct ctfb_res_modes *mode) diff --git a/drivers/virtio/virtio_pci_modern.c b/drivers/virtio/virtio_pci_modern.c index dfbbf8a625..fd8a1f3fec 100644 --- a/drivers/virtio/virtio_pci_modern.c +++ b/drivers/virtio/virtio_pci_modern.c @@ -380,7 +380,7 @@ static int virtio_pci_notify(struct udevice *udev, struct virtqueue *vq) * @udev: the transport device * @cfg_type: the VIRTIO_PCI_CAP_* value we seek * - * @return offset of the configuration structure + * Return: offset of the configuration structure */ static int virtio_pci_find_capability(struct udevice *udev, u8 cfg_type) { @@ -413,7 +413,7 @@ static int virtio_pci_find_capability(struct udevice *udev, u8 cfg_type) * @udev: the transport device * @off: offset of the configuration structure * - * @return base address of the capability + * Return: base address of the capability */ static void __iomem *virtio_pci_map_capability(struct udevice *udev, int off) { diff --git a/env/common.c b/env/common.c index ee957c0a8c..f9226e0690 100644 --- a/env/common.c +++ b/env/common.c @@ -47,7 +47,7 @@ struct hsearch_data env_htab = { * * @param varname Environment variable to set * @param value Value to set it to - * @return 0 if ok, 1 on error + * Return: 0 if ok, 1 on error */ int env_set_ulong(const char *varname, ulong value) { @@ -62,7 +62,7 @@ int env_set_ulong(const char *varname, ulong value) * * @param varname Environment variable to set * @param value Value to set it to - * @return 0 if ok, 1 on error + * Return: 0 if ok, 1 on error */ int env_set_hex(const char *varname, ulong value) { @@ -208,7 +208,7 @@ int env_get_f(const char *name, char *buf, unsigned len) * @param base Number base to use (normally 10, or 16 for hex) * @param default_val Default value to return if the variable is not * found - * @return the decoded value, or default_val if not found + * Return: the decoded value, or default_val if not found */ ulong env_get_ulong(const char *name, int base, ulong default_val) { diff --git a/fs/cbfs/cbfs.c b/fs/cbfs/cbfs.c index 3e905c74e5..714f4baafc 100644 --- a/fs/cbfs/cbfs.c +++ b/fs/cbfs/cbfs.c @@ -85,7 +85,7 @@ static void swap_file_header(struct cbfs_fileheader *dest, * @node: Node to fill * @start: Pointer to the start of the CBFS file in memory * @header: Pointer to the header information (in our enddianess) - * @return 0 if OK, -EBADF if the header is too small + * Return: 0 if OK, -EBADF if the header is too small */ static int fill_node(struct cbfs_cachenode *node, void *start, struct cbfs_fileheader *header) @@ -142,7 +142,7 @@ static int fill_node(struct cbfs_cachenode *node, void *start, * @param used A pointer to the count of of bytes scanned through, * including the file if one is found. * - * @return 0 if a file is found, -ENOENT if one isn't, -EBADF if a bad header + * Return: 0 if a file is found, -ENOENT if one isn't, -EBADF if a bad header * is found. */ static int file_cbfs_next_file(struct cbfs_priv *priv, void *start, int size, @@ -234,7 +234,7 @@ static int file_cbfs_fill_cache(struct cbfs_priv *priv, int size, int align) * * @priv: Private data, which is inited by this function * @addr: Address of CBFS header in memory-mapped SPI flash - * @return 0 if OK, -ENXIO if the header is bad + * Return: 0 if OK, -ENXIO if the header is bad */ static int load_header(struct cbfs_priv *priv, ulong addr) { @@ -259,7 +259,7 @@ static int load_header(struct cbfs_priv *priv, ulong addr) * * @priv: Private data, which is inited by this function * @end_of_rom: Address of the last byte of the ROM (typically 0xffffffff) - * @return 0 if OK, -ENXIO if the header is bad + * Return: 0 if OK, -ENXIO if the header is bad */ static int file_cbfs_load_header(struct cbfs_priv *priv, ulong end_of_rom) { @@ -279,7 +279,7 @@ static int file_cbfs_load_header(struct cbfs_priv *priv, ulong end_of_rom) * * @priv: Private data, which is inited by this function * @base: Address of the first byte of the ROM (e.g. 0xff000000) - * @return 0 if OK, -ENXIO if the header is bad + * Return: 0 if OK, -ENXIO if the header is bad */ static int cbfs_load_header_ptr(struct cbfs_priv *priv, ulong base) { diff --git a/fs/fat/fat.c b/fs/fat/fat.c index 65f77c4f75..df9ea2c028 100644 --- a/fs/fat/fat.c +++ b/fs/fat/fat.c @@ -735,7 +735,7 @@ static int fat_itr_isdir(fat_itr *itr); * * @itr: iterator to initialize * @fsdata: filesystem data for the partition - * @return 0 on success, else -errno + * Return: 0 on success, else -errno */ static int fat_itr_root(fat_itr *itr, fsdata *fsdata) { @@ -954,7 +954,7 @@ static dir_entry *extract_vfat_name(fat_itr *itr) * Must be called once on a new iterator before the cursor is valid. * * @itr: the iterator to iterate - * @return boolean, 1 if success or 0 if no more entries in the + * Return: boolean, 1 if success or 0 if no more entries in the * current directory */ static int fat_itr_next(fat_itr *itr) @@ -1024,7 +1024,7 @@ static int fat_itr_next(fat_itr *itr) * fat_itr_isdir() - is current cursor position pointing to a directory * * @itr: the iterator - * @return true if cursor is at a directory + * Return: true if cursor is at a directory */ static int fat_itr_isdir(fat_itr *itr) { @@ -1052,7 +1052,7 @@ static int fat_itr_isdir(fat_itr *itr) * @itr: iterator initialized to root * @path: the requested path * @type: bitmask of allowable file types - * @return 0 on success or -errno + * Return: 0 on success or -errno */ static int fat_itr_resolve(fat_itr *itr, const char *path, unsigned type) { diff --git a/include/abuf.h b/include/abuf.h index d230f72806..9badda64e4 100644 --- a/include/abuf.h +++ b/include/abuf.h @@ -86,7 +86,7 @@ void abuf_map_sysmem(struct abuf *abuf, ulong addr, size_t size); * if less than the current size, the abuf is contracted and the data at * the end is lost. If @new_size is 0, this sets the alloced member to * false - * @return true if OK, false if out of memory + * Return: true if OK, false if out of memory */ bool abuf_realloc(struct abuf *abuf, size_t new_size); @@ -109,7 +109,7 @@ bool abuf_realloc(struct abuf *abuf, size_t new_size); * * @abuf: abuf to uninit * @sizep: if non-NULL, returns the size of the returned data - * @return data contents, allocated with malloc(), or NULL if the data could not + * Return: data contents, allocated with malloc(), or NULL if the data could not * be allocated, or the data size is 0 */ void *abuf_uninit_move(struct abuf *abuf, size_t *sizep); diff --git a/include/acpi/acpi_device.h b/include/acpi/acpi_device.h index 2c8846250b..16bcf3c6f8 100644 --- a/include/acpi/acpi_device.h +++ b/include/acpi/acpi_device.h @@ -322,7 +322,7 @@ struct acpi_i2c_priv { * @dev: Device to check * @buf: Buffer to place the path in (should be ACPI_PATH_MAX long) * @maxlen: Size of buffer (typically ACPI_PATH_MAX) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_device_path(const struct udevice *dev, char *buf, int maxlen); @@ -335,7 +335,7 @@ int acpi_device_path(const struct udevice *dev, char *buf, int maxlen); * @dev: Device to check * @buf: Buffer to place the path in (should be ACPI_PATH_MAX long) * @maxlen: Size of buffer (typically ACPI_PATH_MAX) - * @return 0 if OK, -EINVAL if the device has no parent, other -ve on other + * Return: 0 if OK, -EINVAL if the device has no parent, other -ve on other * error */ int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen); @@ -347,7 +347,7 @@ int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen); * inactive or hidden devices. * * @dev: Device to check - * @return device status, as ACPI_DSTATUS_... + * Return: device status, as ACPI_DSTATUS_... */ enum acpi_dev_status acpi_device_status(const struct udevice *dev); @@ -359,7 +359,7 @@ enum acpi_dev_status acpi_device_status(const struct udevice *dev); * * @ctx: ACPI context pointer * @req_irq: Interrupt to output - * @return IRQ pin number if OK, -ve on error + * Return: IRQ pin number if OK, -ve on error */ int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx, const struct irq *req_irq); @@ -368,7 +368,7 @@ int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx, * acpi_device_write_gpio() - Write GpioIo() or GpioInt() descriptor * * @gpio: GPIO information to write - * @return GPIO pin number of first GPIO if OK, -ve on error + * Return: GPIO pin number of first GPIO if OK, -ve on error */ int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio); @@ -380,7 +380,7 @@ int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio); * * @ctx: ACPI context pointer * @desc: GPIO to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_device_write_gpio_desc(struct acpi_ctx *ctx, const struct gpio_desc *desc); @@ -394,7 +394,7 @@ int acpi_device_write_gpio_desc(struct acpi_ctx *ctx, * If an interrupt is found, an ACPI interrupt descriptor is written to the ACPI * output. If not, but if a GPIO is found, a GPIO descriptor is written. * - * @return irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO + * Return: irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO * could be found, or some other error occurred */ int acpi_device_write_interrupt_or_gpio(struct acpi_ctx *ctx, @@ -419,7 +419,7 @@ int acpi_device_write_dsm_i2c_hid(struct acpi_ctx *ctx, * * @ctx: ACPI context pointer * @dev: I2C device to write - * @return I2C address of device if OK, -ve on error + * Return: I2C address of device if OK, -ve on error */ int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev); @@ -431,7 +431,7 @@ int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev); * * @ctx: ACPI context pointer * @dev: SPI device to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_device_write_spi_dev(struct acpi_ctx *ctx, const struct udevice *dev); @@ -466,7 +466,7 @@ int acpi_device_write_spi_dev(struct acpi_ctx *ctx, const struct udevice *dev); * @stop_off_delay_ms: Delay to be inserted after enabling stop. * (_OFF method delay) * - * @return 0 if OK, -ve if at least one GPIO is not provided + * Return: 0 if OK, -ve if at least one GPIO is not provided */ int acpi_device_add_power_res(struct acpi_ctx *ctx, u32 tx_state_val, const char *dw0_read, const char *dw0_write, @@ -490,7 +490,7 @@ int acpi_device_add_power_res(struct acpi_ctx *ctx, u32 tx_state_val, * * @dev: Device to check * @out_name: Place to put the name (must hold ACPI_NAME_MAX bytes) - * @return 0 if a name was found, -ENOENT if not found, -ENXIO if the device + * Return: 0 if a name was found, -ENOENT if not found, -ENXIO if the device * sequence number could not be determined */ int acpi_device_infer_name(const struct udevice *dev, char *out_name); diff --git a/include/acpi/acpi_dp.h b/include/acpi/acpi_dp.h index 5e539b1d21..be02cc3495 100644 --- a/include/acpi/acpi_dp.h +++ b/include/acpi/acpi_dp.h @@ -124,7 +124,7 @@ struct acpi_dp { * acpi_dp_new_table() - Start a new Device Property table * * @ref: ACPI reference (e.g. "_DSD") - * @return pointer to table, or NULL if out of memory + * Return: pointer to table, or NULL if out of memory */ struct acpi_dp *acpi_dp_new_table(const char *ref); @@ -136,7 +136,7 @@ struct acpi_dp *acpi_dp_new_table(const char *ref); * @dp: Table to add this property to * @name: Name of property, or NULL for none * @value: Integer value - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name, u64 value); @@ -149,7 +149,7 @@ struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name, * @dp: Table to add this property to * @name: Name of property, or NULL for none * @string: String value - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name, const char *string); @@ -162,7 +162,7 @@ struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name, * @dp: Table to add this property to * @name: Name of property, or NULL for none * @reference: Reference value - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name, const char *reference); @@ -175,7 +175,7 @@ struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name, * * @dp: Table to add this property to * @name: Name of property, or NULL for none - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array); @@ -187,7 +187,7 @@ struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array); * * @dp: Table to add this property to * @name: Name of property, or NULL for none - * @return pointer to new array node, or NULL if out of memory + * Return: pointer to new array node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name, u64 *array, int len); @@ -200,7 +200,7 @@ struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name, * @dp: Table to add this child to * @name: Name of child, or NULL for none * @child: Child node to add - * @return pointer to new child node, or NULL if out of memory + * Return: pointer to new child node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name, struct acpi_dp *child); @@ -217,7 +217,7 @@ struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name, * @index: Index of the GPIO resource in _CRS starting from zero * @pin: Pin in the GPIO resource, typically zero * @polarity: GPIO polarity. Note that ACPI_IRQ_ACTIVE_BOTH is not supported - * @return pointer to new node, or NULL if out of memory + * Return: pointer to new node, or NULL if out of memory */ struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name, const char *ref, int index, int pin, @@ -230,7 +230,7 @@ struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name, * * @ctx: ACPI context * @table: Table to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_write(struct acpi_ctx *ctx, struct acpi_dp *table); @@ -242,7 +242,7 @@ int acpi_dp_write(struct acpi_ctx *ctx, struct acpi_dp *table); * @node: Node to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_ofnode_copy_int(ofnode node, struct acpi_dp *dp, const char *prop); @@ -254,7 +254,7 @@ int acpi_dp_ofnode_copy_int(ofnode node, struct acpi_dp *dp, const char *prop); * @node: Node to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_ofnode_copy_str(ofnode node, struct acpi_dp *dp, const char *prop); @@ -266,7 +266,7 @@ int acpi_dp_ofnode_copy_str(ofnode node, struct acpi_dp *dp, const char *prop); * @dev: Device to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_dev_copy_int(const struct udevice *dev, struct acpi_dp *dp, const char *prop); @@ -279,7 +279,7 @@ int acpi_dp_dev_copy_int(const struct udevice *dev, struct acpi_dp *dp, * @dev: Device to copy from * @dp: DP to copy to * @prop: Property name to copy - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_dp_dev_copy_str(const struct udevice *dev, struct acpi_dp *dp, const char *prop); diff --git a/include/acpi/acpi_s3.h b/include/acpi/acpi_s3.h index 847139baa0..d3f271f948 100644 --- a/include/acpi/acpi_s3.h +++ b/include/acpi/acpi_s3.h @@ -93,7 +93,7 @@ static inline enum acpi_sleep_state acpi_sleep_from_pm1(u32 pm1_cnt) * This returns chipset previous sleep state from ACPI registers. * Platform codes must supply this routine in order to support ACPI S3. * - * @return ACPI_S0/S1/S2/S3/S4/S5. + * Return: ACPI_S0/S1/S2/S3/S4/S5. */ enum acpi_sleep_state chipset_prev_sleep_state(void); diff --git a/include/acpi/acpi_table.h b/include/acpi/acpi_table.h index a28eb71f4d..dbfea3be70 100644 --- a/include/acpi/acpi_table.h +++ b/include/acpi/acpi_table.h @@ -595,7 +595,7 @@ enum acpi_tables { * This keeps the version-number information in one place * * @table: ACPI table to check - * @return version number that U-Boot generates + * Return: version number that U-Boot generates */ int acpi_get_table_revision(enum acpi_tables table); @@ -604,7 +604,7 @@ int acpi_get_table_revision(enum acpi_tables table); * * @dmar: Place to put the table * @flags: DMAR flags to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags); @@ -674,7 +674,7 @@ void acpi_inc_align(struct acpi_ctx *ctx, uint amount); * * @ctx: ACPI context * @table: Table to add - * @return 0 if OK, -E2BIG if too many tables + * Return: 0 if OK, -E2BIG if too many tables */ int acpi_add_table(struct acpi_ctx *ctx, void *table); diff --git a/include/acpi/acpigen.h b/include/acpi/acpigen.h index 976f4dbb9a..2c269ed662 100644 --- a/include/acpi/acpigen.h +++ b/include/acpi/acpigen.h @@ -140,7 +140,7 @@ struct acpi_tstate { * acpigen_get_current() - Get the current ACPI code output pointer * * @ctx: ACPI context pointer - * @return output pointer + * Return: output pointer */ u8 *acpigen_get_current(struct acpi_ctx *ctx); @@ -428,7 +428,7 @@ void acpigen_write_scope(struct acpi_ctx *ctx, const char *scope); * * @ctx: ACPI context pointer * @uuid: UUID to write in the form aabbccdd-eeff-gghh-iijj-kkllmmnnoopp - * @return 0 if OK, -EINVAL if the format is incorrect + * Return: 0 if OK, -EINVAL if the format is incorrect */ int acpigen_write_uuid(struct acpi_ctx *ctx, const char *uuid); diff --git a/include/ahci.h b/include/ahci.h index d5453042d1..d7f951c388 100644 --- a/include/ahci.h +++ b/include/ahci.h @@ -202,7 +202,7 @@ struct ahci_ops { * sata_reset() - reset the controller * * @dev: Controller to reset - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sata_reset(struct udevice *dev); @@ -211,7 +211,7 @@ int sata_reset(struct udevice *dev); * * @dev: Controller to reset * @port: Port number to check (0 for first) - * @return 0 if detected, -ENXIO if nothin on port, other -ve on error + * Return: 0 if detected, -ENXIO if nothin on port, other -ve on error */ int sata_dm_port_status(struct udevice *dev, int port); @@ -219,7 +219,7 @@ int sata_dm_port_status(struct udevice *dev, int port); * sata_scan() - scan SATA ports * * @dev: Controller to scan - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sata_scan(struct udevice *dev); @@ -254,7 +254,7 @@ int ahci_init_dm(struct udevice *dev, void __iomem *base); * * @ahci_dev: AHCI parent device * @devp: Returns new SCSI bus device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp); @@ -266,7 +266,7 @@ int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp); * * @ahci_dev: AHCI parent device * @base: Base address of AHCI port - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ahci_probe_scsi(struct udevice *ahci_dev, ulong base); @@ -277,7 +277,7 @@ int ahci_probe_scsi(struct udevice *ahci_dev, ulong base); * devices it finds. * * @ahci_dev: AHCI parent device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ahci_probe_scsi_pci(struct udevice *ahci_dev); diff --git a/include/android_ab.h b/include/android_ab.h index 0941eb6b9c..3eb61125c6 100644 --- a/include/android_ab.h +++ b/include/android_ab.h @@ -28,7 +28,7 @@ struct disk_partition; * * @param[in] dev_desc Place to store the device description pointer * @param[in] part_info Place to store the partition information - * @return The slot number (>= 0) on success, or a negative on error + * Return: The slot number (>= 0) on success, or a negative on error */ int ab_select_slot(struct blk_desc *dev_desc, struct disk_partition *part_info); diff --git a/include/asm-generic/gpio.h b/include/asm-generic/gpio.h index fa9b80722e..adc19e9765 100644 --- a/include/asm-generic/gpio.h +++ b/include/asm-generic/gpio.h @@ -50,7 +50,7 @@ struct ofnode_phandle_args; * * @param gpio GPIO number * @param label User label for this GPIO - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int gpio_request(unsigned gpio, const char *label); @@ -59,7 +59,7 @@ int gpio_request(unsigned gpio, const char *label); * Stop using the GPIO. This function should not alter pin configuration. * * @param gpio GPIO number - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int gpio_free(unsigned gpio); @@ -68,7 +68,7 @@ int gpio_free(unsigned gpio); * Make a GPIO an input. * * @param gpio GPIO number - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int gpio_direction_input(unsigned gpio); @@ -78,7 +78,7 @@ int gpio_direction_input(unsigned gpio); * * @param gpio GPIO number * @param value GPIO value (0 for low or 1 for high) - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int gpio_direction_output(unsigned gpio, int value); @@ -88,7 +88,7 @@ int gpio_direction_output(unsigned gpio, int value); * or an output. * * @param gpio GPIO number - * @return 0 if low, 1 if high, -1 on error + * Return: 0 if low, 1 if high, -1 on error */ int gpio_get_value(unsigned gpio); @@ -99,7 +99,7 @@ int gpio_get_value(unsigned gpio); * * @param gpio GPIO number * @param value GPIO value (0 for low or 1 for high) - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int gpio_set_value(unsigned gpio, int value); @@ -146,7 +146,7 @@ struct gpio_desc { * * @desc: GPIO description containing device, offset and flags, * previously returned by gpio_request_by_name() - * @return true if valid, false if not + * Return: true if valid, false if not */ static inline bool dm_gpio_is_valid(const struct gpio_desc *desc) { @@ -184,7 +184,7 @@ int gpio_get_status(struct udevice *dev, int offset, char *buf, int buffsize); * @offset: Offset of device GPIO to check * @namep: If non-NULL, this is set to the name given when the GPIO * was requested, or -1 if it has not been requested - * @return -ENODATA if the driver returned an unknown function, + * Return: -ENODATA if the driver returned an unknown function, * -ENODEV if the device is not active, -EINVAL if the offset is invalid. * GPIOF_UNUSED if the GPIO has not been requested. Otherwise returns the * function from enum gpio_func_t. @@ -203,7 +203,7 @@ int gpio_get_function(struct udevice *dev, int offset, const char **namep); * @offset: Offset of device GPIO to check * @namep: If non-NULL, this is set to the name given when the GPIO * was requested, or -1 if it has not been requested - * @return -ENODATA if the driver returned an unknown function, + * Return: -ENODATA if the driver returned an unknown function, * -ENODEV if the device is not active, -EINVAL if the offset is invalid. * Otherwise returns the function from enum gpio_func_t. */ @@ -434,7 +434,7 @@ struct gpio_dev_priv { * * @dev: Device to look up * @offset_count: Returns number of GPIOs within this bank - * @return bank name of this device + * Return: bank name of this device */ const char *gpio_get_bank_info(struct udevice *dev, int *offset_count); @@ -447,7 +447,7 @@ const char *gpio_get_bank_info(struct udevice *dev, int *offset_count); * * @name: Name to look up * @desc: Returns description, on success - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc); @@ -489,7 +489,7 @@ int gpio_lookup_name(const char *name, struct udevice **devp, * etc. then returns the resulting integer. * * @gpio_list: List of GPIOs to collect - * @return resulting integer value, or -ve on error + * Return: resulting integer value, or -ve on error */ int gpio_get_values_as_int(const int *gpio_list); @@ -501,7 +501,7 @@ int gpio_get_values_as_int(const int *gpio_list); * * @desc_list: List of GPIOs to collect * @count: Number of GPIOs - * @return resulting integer value, or -ve on error + * Return: resulting integer value, or -ve on error */ int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count); @@ -525,7 +525,7 @@ int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count); * * @desc_list: List of GPIOs to collect * @count: Number of GPIOs - * @return resulting integer value, or -ve on error + * Return: resulting integer value, or -ve on error */ int dm_gpio_get_values_as_int_base3(struct gpio_desc *desc_list, int count); @@ -535,7 +535,7 @@ int dm_gpio_get_values_as_int_base3(struct gpio_desc *desc_list, * * @gpio_num_array: array of gpios to claim, terminated by -1 * @fmt: format string for GPIO names, e.g. "board_id%d" - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int gpio_claim_vector(const int *gpio_num_array, const char *fmt); @@ -572,7 +572,7 @@ int gpio_claim_vector(const int *gpio_num_array, const char *fmt); * @desc: Returns GPIO description information. If there is no such * GPIO, @desc->dev will be NULL. * @flags: Indicates the GPIO input/output settings (GPIOD_...) - * @return 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is + * Return: 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is * something wrong with the list, or other -ve for another error (e.g. * -EBUSY if a GPIO was already requested) */ @@ -598,7 +598,7 @@ int gpio_request_by_name(struct udevice *dev, const char *list_name, * @max_count: Maximum number of GPIOs to return (@desc_list must be at least * this big) * @flags: Indicates the GPIO input/output settings (GPIOD_...) - * @return number of GPIOs requested, or -ve on error + * Return: number of GPIOs requested, or -ve on error */ int gpio_request_list_by_name(struct udevice *dev, const char *list_name, struct gpio_desc *desc_list, int max_count, @@ -612,7 +612,7 @@ int gpio_request_list_by_name(struct udevice *dev, const char *list_name, * * @desc: GPIO description of GPIO to request (see dm_gpio_lookup_name()) * @label: Label to attach to the GPIO while claimed - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_gpio_request(struct gpio_desc *desc, const char *label); @@ -629,7 +629,7 @@ int gpio_request_by_phandle(struct udevice *dev, * * @dev: Device requesting the GPIO * @list_name: Name of GPIO list (e.g. "board-id-gpios") - * @return number of GPIOs (0 for an empty property) or -ENOENT if the list + * Return: number of GPIOs (0 for an empty property) or -ENOENT if the list * does not exist */ int gpio_get_list_count(struct udevice *dev, const char *list_name); @@ -677,7 +677,7 @@ int gpio_dev_request_index(struct udevice *dev, const char *nodename, * * @dev: Device which requested the GPIO * @desc: GPIO to free - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc); @@ -690,7 +690,7 @@ int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc); * @dev: Device which requested the GPIOs * @desc: List of GPIOs to free * @count: Number of GPIOs in the list - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count); @@ -713,7 +713,7 @@ int gpio_free_list_nodev(struct gpio_desc *desc, int count); * * @desc: GPIO description containing device, offset and flags, * previously returned by gpio_request_by_name() - * @return GPIO value (0 for inactive, 1 for active) or -ve on error + * Return: GPIO value (0 for inactive, 1 for active) or -ve on error */ int dm_gpio_get_value(const struct gpio_desc *desc); @@ -732,7 +732,7 @@ int dm_gpio_set_value(const struct gpio_desc *desc, int value); * previously returned by gpio_request_by_name() * @clr: Flags to clear (GPIOD_...) * @set: Flags to set (GPIOD_...) - * @return 0 if OK, -EINVAL if the flags had obvious conflicts, + * Return: 0 if OK, -EINVAL if the flags had obvious conflicts, * -ERECALLCONFLICT if there was a non-obvious hardware conflict when attempting * to set the flags */ @@ -748,7 +748,7 @@ int dm_gpio_clrset_flags(struct gpio_desc *desc, ulong clr, ulong set); * @desc: GPIO description containing device, offset and flags, * previously returned by gpio_request_by_name() * @flags: New flags to use - * @return 0 if OK, -ve on error, in which case desc->flags is not updated + * Return: 0 if OK, -ve on error, in which case desc->flags is not updated */ int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags); @@ -762,7 +762,7 @@ int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags); * @clr: Flags to clear (GPIOD_...), e.g. GPIOD_MASK_DIR if you are * changing the direction * @set: Flags to set (GPIOD_...) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_gpios_clrset_flags(struct gpio_desc *desc, int count, ulong clr, ulong set); @@ -775,7 +775,7 @@ int dm_gpios_clrset_flags(struct gpio_desc *desc, int count, ulong clr, * @desc: GPIO description containing device, offset and flags, * previously returned by gpio_request_by_name() * @flags: place to put the used flags - * @return 0 if OK, -ve on error, in which case desc->flags is not updated + * Return: 0 if OK, -ve on error, in which case desc->flags is not updated */ int dm_gpio_get_flags(struct gpio_desc *desc, ulong *flags); @@ -787,7 +787,7 @@ int dm_gpio_get_flags(struct gpio_desc *desc, ulong *flags); * * @desc: GPIO description containing device, offset and flags, * previously returned by gpio_request_by_name() - * @return GPIO number, or -ve if not found + * Return: GPIO number, or -ve if not found */ int gpio_get_number(const struct gpio_desc *desc); @@ -799,7 +799,7 @@ int gpio_get_number(const struct gpio_desc *desc); * * @desc: GPIO description to convert * @gpio: Output ACPI GPIO information - * @return ACPI pin number or -ve on error + * Return: ACPI pin number or -ve on error */ int gpio_get_acpi(const struct gpio_desc *desc, struct acpi_gpio *gpio); diff --git a/include/audio_codec.h b/include/audio_codec.h index 2ea4ff096e..a81a315157 100644 --- a/include/audio_codec.h +++ b/include/audio_codec.h @@ -42,7 +42,7 @@ struct audio_codec_ops { * @mclk_freq: Codec clock frequency in Hz * @bits_per_sample: Must be 16 or 24 * @channels: Number of channels to use (1=mono, 2=stereo) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int audio_codec_set_params(struct udevice *dev, int interface, int rate, int mclk_freq, int bits_per_sample, uint channels); diff --git a/include/autoboot.h b/include/autoboot.h index d6915dd0cc..eb204995d0 100644 --- a/include/autoboot.h +++ b/include/autoboot.h @@ -21,7 +21,7 @@ * This is only implemented for sandbox since other platforms don't have a way * of controlling the feature at runtime. * - * @return true if enabled, false if not + * Return: true if enabled, false if not */ bool autoboot_keyed(void); @@ -29,7 +29,7 @@ bool autoboot_keyed(void); * autoboot_set_keyed() - set whether keyed autoboot should be used * * @autoboot_keyed: true to enable the feature, false to disable - * @return old value of the flag + * Return: old value of the flag */ bool autoboot_set_keyed(bool autoboot_keyed); #else @@ -55,7 +55,7 @@ static inline bool autoboot_set_keyed(bool autoboot_keyed) * bootcmd, failbootcmd or altbootcmd depending on the current state. * Return this command so it can be executed. * - * @return command to executed + * Return: command to executed */ const char *bootdelay_process(void); diff --git a/include/backlight.h b/include/backlight.h index b44da50bc3..c8418828d1 100644 --- a/include/backlight.h +++ b/include/backlight.h @@ -41,7 +41,7 @@ struct backlight_ops { * backlight_enable() - Enable a backlight * * @dev: Backlight device to enable - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int backlight_enable(struct udevice *dev); @@ -50,7 +50,7 @@ int backlight_enable(struct udevice *dev); * * @dev: Backlight device to update * @percent: Brightness value (0 to 100, or BACKLIGHT_... value) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int backlight_set_brightness(struct udevice *dev, int percent); diff --git a/include/binman.h b/include/binman.h index 5958dfb448..62a522eac3 100644 --- a/include/binman.h +++ b/include/binman.h @@ -29,7 +29,7 @@ struct binman_entry { * @name: Name of entry * @bufp: Returns a pointer to the entry * @sizep: Returns the size of the entry - * @return 0 on success, -EPERM if the ROM offset is not set, -ENOENT if the + * Return: 0 on success, -EPERM if the ROM offset is not set, -ENOENT if the * entry cannot be found, other error code other error */ int binman_entry_map(ofnode parent, const char *name, void **bufp, int *sizep); @@ -57,7 +57,7 @@ int binman_get_rom_offset(void); * * @name: Path to entry to examine (e.g. "/read-only/u-boot") * @entry: Returns information about the entry - * @return 0 if OK, -ENOENT if the path is not found, other -ve value if the + * Return: 0 if OK, -ENOENT if the path is not found, other -ve value if the * binman information is invalid (missing image-pos or size) */ int binman_entry_find(const char *name, struct binman_entry *entry); @@ -66,7 +66,7 @@ int binman_entry_find(const char *name, struct binman_entry *entry); * binman_section_find_node() - Find a binman node * * @name: Name of node to look for - * @return Node that was found, ofnode_null() if not found + * Return: Node that was found, ofnode_null() if not found */ ofnode binman_section_find_node(const char *name); @@ -78,7 +78,7 @@ ofnode binman_section_find_node(const char *name); * * @name: Name of subnode, typically a section. This must be in the top-level * binman node - * @return 0 if OK, -EINVAL if there is no /binman node, -ECHILD if multiple + * Return: 0 if OK, -EINVAL if there is no /binman node, -ECHILD if multiple * images are being used but the first image is not available, -ENOENT if * the requested subnode cannot be found */ @@ -89,7 +89,7 @@ int binman_select_subnode(const char *name); * * This locates the binary symbol information in the device tree ready for use * - * @return 0 if OK, -ENOMEM if out of memory, -EINVAL if there is no binman node + * Return: 0 if OK, -ENOMEM if out of memory, -EINVAL if there is no binman node */ int binman_init(void); diff --git a/include/blk.h b/include/blk.h index 133204a82e..d06098bc13 100644 --- a/include/blk.h +++ b/include/blk.h @@ -136,7 +136,7 @@ int blkcache_init(void); * @param blksz - size in bytes of each block * @param buf - buffer to contain cached data * - * @return - 1 if block returned from cache, 0 otherwise. + * Return: - 1 if block returned from cache, 0 otherwise. */ int blkcache_read(int iftype, int dev, lbaint_t start, lbaint_t blkcnt, @@ -297,7 +297,7 @@ unsigned long blk_derase(struct blk_desc *block_dev, lbaint_t start, * @if_type: Interface type (enum if_type_t) * @devnum: Device number (specific to each interface type) * @devp: the device, if found - * @return 0 if found, -ENODEV if no device found, or other -ve error value + * Return: 0 if found, -ENODEV if no device found, or other -ve error value */ int blk_find_device(int if_type, int devnum, struct udevice **devp); @@ -307,7 +307,7 @@ int blk_find_device(int if_type, int devnum, struct udevice **devp); * @if_type: Interface type (enum if_type_t) * @devnum: Device number (specific to each interface type) * @devp: the device, if found - * @return 0 if found, -ENODEV if no device found, or other -ve error value + * Return: 0 if found, -ENODEV if no device found, or other -ve error value */ int blk_get_device(int if_type, int devnum, struct udevice **devp); @@ -318,7 +318,7 @@ int blk_get_device(int if_type, int devnum, struct udevice **devp); * * @devnum: Device number (specific to each interface type) * @devp: the device, if found - * @return 0 if found, -ENODEV if no device, or other -ve error value + * Return: 0 if found, -ENODEV if no device, or other -ve error value */ int blk_first_device(int if_type, struct udevice **devp); @@ -332,7 +332,7 @@ int blk_first_device(int if_type, struct udevice **devp); * * @devp: On entry, the previous device returned. On exit, the next * device, if found - * @return 0 if found, -ENODEV if no device, or other -ve error value + * Return: 0 if found, -ENODEV if no device, or other -ve error value */ int blk_next_device(struct udevice **devp); @@ -388,7 +388,7 @@ int blk_probe_or_unbind(struct udevice *dev); * The devices are removed and then unbound. * * @if_type: Interface type to unbind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_unbind_all(int if_type); @@ -399,7 +399,7 @@ int blk_unbind_all(int if_type); * next number is safe to use for a newly allocated device. * * @if_type: Interface type to scan - * @return maximum device number found, or -ENODEV if none, or other -ve on + * Return: maximum device number found, or -ENODEV if none, or other -ve on * error */ int blk_find_max_devnum(enum if_type if_type); @@ -411,7 +411,7 @@ int blk_find_max_devnum(enum if_type if_type); * an interface type @if_type. * * @if_type: Interface type to scan - * @return next device number safe to use, or -ve on error + * Return: next device number safe to use, or -ve on error */ int blk_next_free_devnum(enum if_type if_type); @@ -422,7 +422,7 @@ int blk_next_free_devnum(enum if_type if_type); * * @dev: Device to update * @hwpart: Partition number to select - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_select_hwpart(struct udevice *dev, int hwpart); @@ -559,7 +559,7 @@ struct blk_driver *blk_driver_lookup_type(int if_type); * * @if_type: Block device type * @devnum: Device number - * @return point to block device descriptor, or NULL if not found + * Return: point to block device descriptor, or NULL if not found */ struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum); @@ -571,7 +571,7 @@ struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum); * * @if_typename: Block device type name * @devnum: Device number - * @return point to block device descriptor, or NULL if not found + * Return: point to block device descriptor, or NULL if not found */ struct blk_desc *blk_get_devnum_by_typename(const char *if_typename, int devnum); @@ -585,7 +585,7 @@ struct blk_desc *blk_get_devnum_by_typename(const char *if_typename, * * @desc: Block device descriptor for the device to select * @hwpart: Partition number to select - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_dselect_hwpart(struct blk_desc *desc, int hwpart); @@ -596,7 +596,7 @@ int blk_dselect_hwpart(struct blk_desc *desc, int hwpart); * then displays a list of partitions. * * @if_type: Block device type - * @return 0 if OK, -ENODEV if there is none of that type + * Return: 0 if OK, -ENODEV if there is none of that type */ int blk_list_part(enum if_type if_type); @@ -617,7 +617,7 @@ void blk_list_devices(enum if_type if_type); * * @if_type: Block device type * @devnum: Device number - * @return 0 if OK, -ENODEV for invalid device number + * Return: 0 if OK, -ENODEV for invalid device number */ int blk_show_device(enum if_type if_type, int devnum); @@ -629,7 +629,7 @@ int blk_show_device(enum if_type if_type, int devnum); * * @if_type: Block device type * @devnum: Device number - * @return 0 if OK, -ENODEV for invalid device number, -ENOENT if the block + * Return: 0 if OK, -ENODEV for invalid device number, -ENOENT if the block * device is not connected */ int blk_print_device_num(enum if_type if_type, int devnum); @@ -639,7 +639,7 @@ int blk_print_device_num(enum if_type if_type, int devnum); * * @if_type: Block device type * @devnum: Device number - * @return 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if + * Return: 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if * the interface type is not supported, other -ve on other error */ int blk_print_part_devnum(enum if_type if_type, int devnum); @@ -651,7 +651,7 @@ int blk_print_part_devnum(enum if_type if_type, int devnum); * @devnum: Device number * @blkcnt: Number of blocks to read * @buffer: Address to write data to - * @return number of blocks read, or -ve error number on error + * Return: number of blocks read, or -ve error number on error */ ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start, lbaint_t blkcnt, void *buffer); @@ -663,7 +663,7 @@ ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start, * @devnum: Device number * @blkcnt: Number of blocks to write * @buffer: Address to read data from - * @return number of blocks written, or -ve error number on error + * Return: number of blocks written, or -ve error number on error */ ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start, lbaint_t blkcnt, const void *buffer); @@ -677,7 +677,7 @@ ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start, * @if_type: Block device type * @devnum: Device number * @hwpart: Partition number to select - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart); @@ -685,7 +685,7 @@ int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart); * blk_get_if_type_name() - Get the name of an interface type * * @if_type: Interface type to check - * @return name of interface, or NULL if none + * Return: name of interface, or NULL if none */ const char *blk_get_if_type_name(enum if_type if_type); @@ -696,7 +696,7 @@ const char *blk_get_if_type_name(enum if_type if_type); * @argv: Command arguments * @if_type: Interface type * @cur_devnump: Current device number for this interface type - * @return 0 if OK, CMD_RET_ERROR on error + * Return: 0 if OK, CMD_RET_ERROR on error */ int blk_common_cmd(int argc, char *const argv[], enum if_type if_type, int *cur_devnump); @@ -714,7 +714,7 @@ enum blk_flag_t { * * @flags: Indicates type of device to return * @devp: Returns pointer to the first device in that uclass, or NULL if none - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp); @@ -727,7 +727,7 @@ int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp); * @devp: On entry, pointer to device to lookup. On exit, returns pointer * to the next device in the uclass if no error occurred, or -ENODEV if * there is no next device. - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp); @@ -751,7 +751,7 @@ int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp); * blk_count_devices() - count the number of devices of a particular type * * @flags: Indicates type of device to find - * @return number of devices matching those flags + * Return: number of devices matching those flags */ int blk_count_devices(enum blk_flag_t flag); diff --git a/include/boot_fit.h b/include/boot_fit.h index f75fed66bc..092cfb0b7f 100644 --- a/include/boot_fit.h +++ b/include/boot_fit.h @@ -8,6 +8,6 @@ * locate_dtb_in_fit - Find a DTB matching the board in a FIT image * @fit: pointer to the FIT image * - * @return a pointer to a matching DTB blob if found, NULL otherwise + * Return: a pointer to a matching DTB blob if found, NULL otherwise */ void *locate_dtb_in_fit(const void *fit); diff --git a/include/bootcount.h b/include/bootcount.h index 796b237c8f..fccee7e15b 100644 --- a/include/bootcount.h +++ b/include/bootcount.h @@ -45,7 +45,7 @@ struct bootcount_ops { * * @dev: Device to read from * @bootcount: Place to put the current bootcount - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_bootcount_get(struct udevice *dev, u32 *bootcount); @@ -54,7 +54,7 @@ int dm_bootcount_get(struct udevice *dev, u32 *bootcount); * * @dev: Device to read from * @bootcount: Value to be written to the backing storage - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_bootcount_set(struct udevice *dev, u32 bootcount); @@ -66,7 +66,7 @@ void bootcount_store(ulong); /** * bootcount_load() - load the current bootcount * - * @return bootcount, read from the appropriate location + * Return: bootcount, read from the appropriate location */ ulong bootcount_load(void); diff --git a/include/bootm.h b/include/bootm.h index 48fc668cf3..7ed5650fca 100644 --- a/include/bootm.h +++ b/include/bootm.h @@ -29,7 +29,7 @@ struct cmd_tbl; * argc is adjusted accordingly. This avoids confusion as to how * many arguments are available for the OS. * @images: Pointers to os/initrd/fdt - * @return 1 on error. On success the OS boots so this function does + * Return: 1 on error. On success the OS boots so this function does * not return. */ typedef int boot_os_fn(int flag, int argc, char *const argv[], @@ -106,7 +106,7 @@ void board_preboot_os(void); * @buf: buffer holding commandline string to adjust * @maxlen: Maximum length of buffer at @buf (including \0) * @flags: Flags to control what happens (see bootm_cmdline_t) - * @return 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too + * Return: 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too * long */ int bootm_process_cmdline(char *buf, int maxlen, int flags); @@ -120,7 +120,7 @@ int bootm_process_cmdline(char *buf, int maxlen, int flags); * - performing substitutions in the command line ('bootargs_subst' envvar) * * @flags: Flags to control what happens (see bootm_cmdline_t) - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ int bootm_process_cmdline_env(int flags); diff --git a/include/bootretry.h b/include/bootretry.h index 0cedd300c3..1e8aa83a5b 100644 --- a/include/bootretry.h +++ b/include/bootretry.h @@ -14,7 +14,7 @@ * Check for a keypress repeatedly, resetting the watchdog each time. If a * keypress is not received within the command timeout, return an error. * - * @return 0 if a key is received in time, -ETIMEDOUT if not + * Return: 0 if a key is received in time, -ETIMEDOUT if not */ int bootretry_tstc_timeout(void); diff --git a/include/bootstage.h b/include/bootstage.h index 8d1989ac0e..99a334ad54 100644 --- a/include/bootstage.h +++ b/include/bootstage.h @@ -248,7 +248,7 @@ void show_boot_progress(int val); * Call this after relocation has happened and after malloc has been initted. * We need to copy any pointers in bootstage records that were added pre- * relocation, since memory can be overwritten later. - * @return Always returns 0, to indicate success + * Return: Always returns 0, to indicate success */ int bootstage_relocate(void); @@ -280,7 +280,7 @@ ulong bootstage_mark_name(enum bootstage_id id, const char *name); * @param file Filename to record (NULL if none) * @param func Function name to record * @param linenum Line number to record - * @return recorded time stamp + * Return: recorded time stamp */ ulong bootstage_mark_code(const char *file, const char *func, int linenum); @@ -294,7 +294,7 @@ ulong bootstage_mark_code(const char *file, const char *func, * * @param id Bootstage id to record this timestamp against * @param name Textual name to display for this id in the report (maybe NULL) - * @return start timestamp in microseconds + * Return: start timestamp in microseconds */ uint32_t bootstage_start(enum bootstage_id id, const char *name); @@ -306,7 +306,7 @@ uint32_t bootstage_start(enum bootstage_id id, const char *name); * as many times as you like. * * @param id Bootstage id to record this timestamp against - * @return time spent in this iteration of the activity (i.e. the time now + * Return: time spent in this iteration of the activity (i.e. the time now * less the start time recorded in the last bootstage_start() call * with this id. */ @@ -318,7 +318,7 @@ void bootstage_report(void); /** * Add bootstage information to the device tree * - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int bootstage_fdt_add_report(void); @@ -327,7 +327,7 @@ int bootstage_fdt_add_report(void); * * @param base Base address of memory buffer * @param size Size of memory buffer - * @return 0 if stashed ok, -1 if out of space + * Return: 0 if stashed ok, -1 if out of space */ int bootstage_stash(void *base, int size); @@ -339,7 +339,7 @@ int bootstage_stash(void *base, int size); * * @param base Base address of memory buffer * @param size Size of memory buffer (-1 if unknown) - * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if + * Return: 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if * there is not space for read the stashed data, or other error if * something else went wrong */ @@ -348,7 +348,7 @@ int bootstage_unstash(const void *base, int size); /** * bootstage_get_size() - Get the size of the bootstage data * - * @return size of boostage data in bytes + * Return: size of boostage data in bytes */ int bootstage_get_size(void); diff --git a/include/button.h b/include/button.h index ee14fadf0c..96e6b1901f 100644 --- a/include/button.h +++ b/include/button.h @@ -46,7 +46,7 @@ struct button_ops { * * @label: button label to look up * @devp: Returns the associated device, if found - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int button_get_by_label(const char *label, struct udevice **devp); @@ -54,7 +54,7 @@ int button_get_by_label(const char *label, struct udevice **devp); * button_get_state() - get the state of a button * * @dev: button device to change - * @return button state button_state_t, or -ve on error + * Return: button state button_state_t, or -ve on error */ enum button_state_t button_get_state(struct udevice *dev); diff --git a/include/cache.h b/include/cache.h index ecb7956efd..b12fec2591 100644 --- a/include/cache.h +++ b/include/cache.h @@ -49,7 +49,7 @@ struct cache_ops { * * @dev: Device to check (UCLASS_CACHE) * @info: Returns cache info - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cache_get_info(struct udevice *dev, struct cache_info *info); @@ -57,7 +57,7 @@ int cache_get_info(struct udevice *dev, struct cache_info *info); * cache_enable() - Enable cache * * @dev: Device to check (UCLASS_CACHE) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cache_enable(struct udevice *dev); @@ -65,7 +65,7 @@ int cache_enable(struct udevice *dev); * cache_disable() - Flush and disable cache * * @dev: Device to check (UCLASS_CACHE) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cache_disable(struct udevice *dev); #endif diff --git a/include/cbfs.h b/include/cbfs.h index ae94f1dcdf..7449873b49 100644 --- a/include/cbfs.h +++ b/include/cbfs.h @@ -136,14 +136,14 @@ struct cbfs_cachenode { * file_cbfs_error() - Return a string describing the most recent error * condition. * - * @return A pointer to the constant string. + * Return: A pointer to the constant string. */ const char *file_cbfs_error(void); /** * cbfs_get_result() - Get the result of the last CBFS operation * - *@return last result + *Return: last result */ enum cbfs_result cbfs_get_result(void); @@ -151,21 +151,21 @@ enum cbfs_result cbfs_get_result(void); * file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM. * * @end_of_rom: Points to the end of the ROM the CBFS should be read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int file_cbfs_init(ulong end_of_rom); /** * file_cbfs_get_header() - Get the header structure for the current CBFS. * - * @return A pointer to the constant structure, or NULL if there is none. + * Return: A pointer to the constant structure, or NULL if there is none. */ const struct cbfs_header *file_cbfs_get_header(void); /** * cbfs_get_first() - Get the first file in a CBFS * - * @return pointer to first file, or NULL if it is empty + * Return: pointer to first file, or NULL if it is empty */ const struct cbfs_cachenode *cbfs_get_first(const struct cbfs_priv *priv); @@ -180,7 +180,7 @@ void cbfs_get_next(const struct cbfs_cachenode **filep); /** * file_cbfs_get_first() - Get a handle for the first file in CBFS. * - * @return A handle for the first file in CBFS, NULL on error. + * Return: A handle for the first file in CBFS, NULL on error. */ const struct cbfs_cachenode *file_cbfs_get_first(void); @@ -196,7 +196,7 @@ void file_cbfs_get_next(const struct cbfs_cachenode **file); * * @name: The name to search for. * - * @return A handle to the file, or NULL on error. + * Return: A handle to the file, or NULL on error. */ const struct cbfs_cachenode *file_cbfs_find(const char *name); @@ -205,7 +205,7 @@ const struct cbfs_cachenode *file_cbfs_find(const char *name); * * @cbfs: CBFS to look in (use cbfs_init_mem() to set it up) * @name: Filename to look for - * @return pointer to CBFS node if found, else NULL + * Return: pointer to CBFS node if found, else NULL */ const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs, const char *name); @@ -217,7 +217,7 @@ const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs, * @size: Size of CBFS if known, else CBFS_SIZE_UNKNOWN * @require_header: true to read a header at the start, false to not require one * @cbfsp: Returns a pointer to CBFS on success - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cbfs_init_mem(ulong base, ulong size, bool require_hdr, struct cbfs_priv **privp); @@ -235,7 +235,7 @@ int cbfs_init_mem(ulong base, ulong size, bool require_hdr, * @end_of_rom: Points to the end of the ROM the CBFS should be read from * @name: The name to search for * @node: Returns the contents of the node if found (i.e. copied into *node) - * @return 0 on success, -ENOENT if not found, -EFAULT on bad header + * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header */ int file_cbfs_find_uncached(ulong end_of_rom, const char *name, struct cbfs_cachenode *node); @@ -249,7 +249,7 @@ int file_cbfs_find_uncached(ulong end_of_rom, const char *name, * @base: Points to the base of the CBFS * @name: The name to search for * @node: Returns the contents of the node if found (i.e. copied into *node) - * @return 0 on success, -ENOENT if not found, -EFAULT on bad header + * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header */ int file_cbfs_find_uncached_base(ulong base, const char *name, struct cbfs_cachenode *node); @@ -259,7 +259,7 @@ int file_cbfs_find_uncached_base(ulong base, const char *name, * * @file: The handle to the file. * - * @return The name of the file, NULL on error. + * Return: The name of the file, NULL on error. */ const char *file_cbfs_name(const struct cbfs_cachenode *file); @@ -268,7 +268,7 @@ const char *file_cbfs_name(const struct cbfs_cachenode *file); * * @file: The handle to the file. * - * @return The size of the file, zero on error. + * Return: The size of the file, zero on error. */ u32 file_cbfs_size(const struct cbfs_cachenode *file); @@ -277,7 +277,7 @@ u32 file_cbfs_size(const struct cbfs_cachenode *file); * * @file: The handle to the file. * - * @return The type of the file, zero on error. + * Return: The type of the file, zero on error. */ u32 file_cbfs_type(const struct cbfs_cachenode *file); @@ -288,7 +288,7 @@ u32 file_cbfs_type(const struct cbfs_cachenode *file); * @buffer: Where to read it into memory. * @maxsize: Maximum number of bytes to read * - * @return If positive or zero, the number of characters read. If negative, an + * Return: If positive or zero, the number of characters read. If negative, an * error occurred. */ long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer, diff --git a/include/cli.h b/include/cli.h index 3449fa6ae7..ba5b8ebd36 100644 --- a/include/cli.h +++ b/include/cli.h @@ -20,7 +20,7 @@ void cli_simple_loop(void); * * @cmd: String containing the command to execute * @flag Flag value - see CMD_FLAG_... - * @return 1 - command executed, repeatable + * Return: 1 - command executed, repeatable * 0 - command executed but not repeatable, interrupted commands are * always considered not repeatable * -1 - not executed (unrecognized, bootd recursion or too many args) @@ -35,7 +35,7 @@ int cli_simple_run_command(const char *cmd, int flag); * @param input Input string possible containing $() / ${} vars * @param output Output string with $() / ${} vars expanded * @param max_size Maximum size of @output (including terminator) - * @return 0 if OK, -ENOSPC if we ran out of space in @output + * Return: 0 if OK, -ENOSPC if we ran out of space in @output */ int cli_simple_process_macros(const char *input, char *output, int max_size); @@ -50,7 +50,7 @@ int cli_simple_process_macros(const char *input, char *output, int max_size); * * @param cmd String containing list of commands * @param flag Execution flags (CMD_FLAG_...) - * @return 0 on success, or != 0 on error. + * Return: 0 on success, or != 0 on error. */ int cli_simple_run_command_list(char *cmd, int flag); @@ -60,7 +60,7 @@ int cli_simple_run_command_list(char *cmd, int flag); * This is a convenience function which calls cli_readline_into_buffer(). * * @prompt: Prompt to display - * @return command line length excluding terminator, or -ve on error + * Return: command line length excluding terminator, or -ve on error */ int cli_readline(const char *const prompt); @@ -82,7 +82,7 @@ int cli_readline(const char *const prompt); * @prompt: Prompt to display * @buffer: Place to put the line that is entered * @timeout: Timeout in milliseconds, 0 if none - * @return command line length excluding terminator, or -ve on error: of the + * Return: command line length excluding terminator, or -ve on error: of the * timeout is exceeded (either CONFIG_BOOT_RETRY_TIME or the timeout * parameter), then -2 is returned. If a break is detected (Ctrl-C) then * -1 is returned. @@ -105,7 +105,7 @@ int cli_readline_into_buffer(const char *const prompt, char *buffer, * * @line: Command line to parse * @args: Array to hold arguments - * @return number of arguments + * Return: number of arguments */ int cli_simple_parse_line(char *line, char *argv[]); @@ -121,7 +121,7 @@ int cli_simple_parse_line(char *line, char *argv[]); * @cmdp: On entry, the command that will be executed if the FDT does * not have a command. Returns the command to execute after * checking the FDT. - * @return true to execute securely, else false + * Return: true to execute securely, else false */ bool cli_process_fdt(const char **cmdp); diff --git a/include/clk.h b/include/clk.h index df5255e510..040d2d60f7 100644 --- a/include/clk.h +++ b/include/clk.h @@ -112,7 +112,7 @@ struct phandle_1_arg; * @dev: Device containing the phandle * @cells: Phandle info * @clock: A pointer to a clock struct to initialise - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells, struct clk *clk); @@ -130,7 +130,7 @@ int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells, * @index: The index of the clock to request, within the client's list of * clocks. * @clock A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_index(struct udevice *dev, int index, struct clk *clk); @@ -144,7 +144,7 @@ int clk_get_by_index(struct udevice *dev, int index, struct clk *clk); * @index: The index of the clock to request, within the client's list of * clocks. * @clock A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk); @@ -159,7 +159,7 @@ int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk); * * @dev: The client device. * @bulk A pointer to a clock bulk struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk); @@ -176,7 +176,7 @@ int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk); * @name: The name of the clock to request, within the client's list of * clocks. * @clock: A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk); @@ -189,7 +189,7 @@ int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk); * @name: The name of the clock to request, within the client's list of * clocks. * @clock: A pointer to a clock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk); @@ -249,7 +249,7 @@ struct clk *devm_clk_get_optional(struct udevice *dev, const char *id); * @clk: A clock struct array that was previously successfully * requested by clk_request/get_by_*(). * @count Number of clock contained in the array - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_release_all(struct clk *clk, int count); @@ -351,7 +351,7 @@ static inline int clk_set_defaults(struct udevice *dev, int stage) * * @clk: A clock bulk struct that was previously successfully * requested by clk_get_bulk(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ static inline int clk_release_bulk(struct clk_bulk *bulk) { @@ -371,7 +371,7 @@ static inline int clk_release_bulk(struct clk_bulk *bulk) * @clock: A pointer to a clock struct to initialize. The caller must * have already initialized any field in this struct which the * clock provider uses to identify the clock. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_request(struct udevice *dev, struct clk *clk); @@ -380,7 +380,7 @@ int clk_request(struct udevice *dev, struct clk *clk); * * @clock: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int clk_free(struct clk *clk); @@ -389,7 +389,7 @@ int clk_free(struct clk *clk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return clock rate in Hz on success, 0 for invalid clock, or -ve error code + * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code * for other errors. */ ulong clk_get_rate(struct clk *clk); @@ -399,7 +399,7 @@ ulong clk_get_rate(struct clk *clk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return pointer to parent's struct clk, or error code passed as pointer + * Return: pointer to parent's struct clk, or error code passed as pointer */ struct clk *clk_get_parent(struct clk *clk); @@ -408,7 +408,7 @@ struct clk *clk_get_parent(struct clk *clk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return clock rate in Hz, or -ve error code. + * Return: clock rate in Hz, or -ve error code. */ long long clk_get_parent_rate(struct clk *clk); @@ -431,7 +431,7 @@ long long clk_get_parent_rate(struct clk *clk); * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @rate: desired clock rate in Hz. - * @return rounded rate in Hz, or -ve error code. + * Return: rounded rate in Hz, or -ve error code. */ ulong clk_round_rate(struct clk *clk, ulong rate); @@ -441,7 +441,7 @@ ulong clk_round_rate(struct clk *clk, ulong rate); * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). * @rate: New clock rate in Hz. - * @return new rate, or -ve error code. + * Return: new rate, or -ve error code. */ ulong clk_set_rate(struct clk *clk, ulong rate); @@ -452,7 +452,7 @@ ulong clk_set_rate(struct clk *clk, ulong rate); * clk_request/get_by_*(). * @parent: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return new rate, or -ve error code. + * Return: new rate, or -ve error code. */ int clk_set_parent(struct clk *clk, struct clk *parent); @@ -461,7 +461,7 @@ int clk_set_parent(struct clk *clk, struct clk *parent); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_enable(struct clk *clk); @@ -470,7 +470,7 @@ int clk_enable(struct clk *clk); * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_enable_bulk(struct clk_bulk *bulk); @@ -479,7 +479,7 @@ int clk_enable_bulk(struct clk_bulk *bulk); * * @clk: A clock struct that was previously successfully requested by * clk_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_disable(struct clk *clk); @@ -488,7 +488,7 @@ int clk_disable(struct clk *clk); * * @bulk: A clock bulk struct that was previously successfully requested * by clk_get_bulk(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int clk_disable_bulk(struct clk_bulk *bulk); @@ -511,7 +511,7 @@ bool clk_is_match(const struct clk *p, const struct clk *q); * * @clkp: A pointer to clock struct that has been found among added clocks * to UCLASS_CLK - * @return zero on success, or -ENOENT on error + * Return: zero on success, or -ENOENT on error */ int clk_get_by_id(ulong id, struct clk **clkp); @@ -520,7 +520,7 @@ int clk_get_by_id(ulong id, struct clk **clkp); * * @clk A pointer to the clk * - * @return true on binded, or false on no + * Return: true on binded, or false on no */ bool clk_dev_binded(struct clk *clk); @@ -606,7 +606,7 @@ static inline bool clk_dev_binded(struct clk *clk) * clk_valid() - check if clk is valid * * @clk: the clock to check - * @return true if valid, or false + * Return: true if valid, or false */ static inline bool clk_valid(struct clk *clk) { diff --git a/include/clk/sunxi.h b/include/clk/sunxi.h index d4ad5fd0ba..a2239b990b 100644 --- a/include/clk/sunxi.h +++ b/include/clk/sunxi.h @@ -91,7 +91,7 @@ extern struct clk_ops sunxi_clk_ops; * * @dev: reset device * @count: reset count - * @return 0 success, or error value + * Return: 0 success, or error value */ int sunxi_reset_bind(struct udevice *dev, ulong count); diff --git a/include/command.h b/include/command.h index f8e07a591c..0cf12fde39 100644 --- a/include/command.h +++ b/include/command.h @@ -96,7 +96,7 @@ int cmd_auto_complete(const char *const prompt, char *buf, int *np, * * @cmdtp: Command which caused the error * @err: Error code (0 if none, -ve for error, like -EIO) - * @return 0 (CMD_RET_SUCCESS) if there is not error, + * Return: 0 (CMD_RET_SUCCESS) if there is not error, * 1 (CMD_RET_FAILURE) if an error is found * -1 (CMD_RET_USAGE) if 'usage' error is found */ @@ -138,7 +138,7 @@ int cmd_process_error(struct cmd_tbl *cmdtp, int err); * @arg: Pointers to the command to check. If a valid specifier is present it * will be the last character of the string, following a '.' * @default_size: Default size to return if there is no specifier - * @return data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid + * Return: data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid * character, or CMD_DATA_SIZE_STR for a string */ int cmd_get_data_size(char *arg, int default_size); @@ -198,7 +198,7 @@ int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc, * @s: String to replace with * @global: true to replace all matches in @data, false to replace just the * first - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int setexpr_regex_sub(char *data, uint data_size, char *nbuf, uint nbuf_size, const char *r, const char *s, bool global); @@ -229,7 +229,7 @@ enum command_ret_t { * is left unchanged. * @param ticks If ticks is not null, this function set it to the * number of ticks the command took to complete. - * @return 0 if the command succeeded, 1 if it failed + * Return: 0 if the command succeeded, 1 if it failed */ int cmd_process(int flag, int argc, char *const argv[], int *repeatable, unsigned long *ticks); @@ -250,7 +250,7 @@ void fixup_cmdtable(struct cmd_tbl *cmdtp, int size); * simply hang. * * @cmdline: Command line string to execute - * @return 0 if OK, 1 for error + * Return: 0 if OK, 1 for error */ int board_run_command(const char *cmdline); @@ -266,7 +266,7 @@ int run_command_repeatable(const char *cmd, int flag); * @param cmd List of commands to run, each separated bu semicolon * @param len Length of commands excluding terminator if known (-1 if not) * @param flag Execution flags (CMD_FLAG_...) - * @return 0 on success, or != 0 on error. + * Return: 0 on success, or != 0 on error. */ int run_command_list(const char *cmd, int len, int flag); #endif /* __ASSEMBLY__ */ diff --git a/include/compiler.h b/include/compiler.h index 8cf11792e2..ef7b2cb1f7 100644 --- a/include/compiler.h +++ b/include/compiler.h @@ -157,7 +157,7 @@ typedef unsigned long int uintptr_t; /** * tools_build() - check if we are building host tools * - * @return true if building for the host, false if for a target + * Return: true if building for the host, false if for a target */ static inline bool tools_build(void) { diff --git a/include/console.h b/include/console.h index b182440fcd..ceb733b5cb 100644 --- a/include/console.h +++ b/include/console.h @@ -33,7 +33,7 @@ int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */ * Iterates over registered STDIO devices and match them with given @flags * and @name. * - * @return pointer to the &struct stdio_dev if found, or NULL otherwise + * Return: pointer to the &struct stdio_dev if found, or NULL otherwise */ struct stdio_dev *console_search_dev(int flags, const char *name); @@ -44,7 +44,7 @@ struct stdio_dev *console_search_dev(int flags, const char *name); * This should be called as soon as malloc() is available so that the maximum * amount of console output can be recorded. * - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ int console_record_init(void); @@ -60,7 +60,7 @@ void console_record_reset(void); * * This should be called to enable the console buffer. * - * @return 0 (always) + * Return: 0 (always) */ int console_record_reset_enable(void); @@ -72,7 +72,7 @@ int console_record_reset_enable(void); * * @str: Place to put string * @maxlen: Maximum length of @str including nul terminator - * @return length of string returned, or -ENOSPC if the console buffer was + * Return: length of string returned, or -ENOSPC if the console buffer was * overflowed by the output */ int console_record_readline(char *str, int maxlen); @@ -80,7 +80,7 @@ int console_record_readline(char *str, int maxlen); /** * console_record_avail() - Get the number of available bytes in console output * - * @return available bytes (0 if empty) + * Return: available bytes (0 if empty) */ int console_record_avail(void); @@ -91,7 +91,7 @@ int console_record_avail(void); * returned if a function calls e.g. `getc()` * * @str: the string to write - * @return the number of bytes added + * Return: the number of bytes added */ int console_in_puts(const char *str); #else @@ -141,7 +141,7 @@ static inline int console_in_puts(const char *str) * This function prints a banner on devices which (we assume) did not receive * it before relocation. * - * @return 0 (meaning no errors) + * Return: 0 (meaning no errors) */ int console_announce_r(void); diff --git a/include/cpu_func.h b/include/cpu_func.h index 23cd5eca39..45e8a0a057 100644 --- a/include/cpu_func.h +++ b/include/cpu_func.h @@ -45,7 +45,7 @@ int is_core_valid(unsigned int core); * This is used on PowerPC, SH and X86 machines as a CPU init mechanism. It is * called during the pre-relocation init sequence in board_init_f(). * - * @return 0 if oK, -ve on error + * Return: 0 if oK, -ve on error */ int checkcpu(void); diff --git a/include/cros_ec.h b/include/cros_ec.h index ef89deff76..2a7728622c 100644 --- a/include/cros_ec.h +++ b/include/cros_ec.h @@ -67,7 +67,7 @@ struct fdt_cros_ec { * @param dev CROS-EC device * @param id Place to put the ID * @param maxlen Maximum length of the ID field - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_id(struct udevice *dev, char *id, int maxlen); @@ -78,7 +78,7 @@ int cros_ec_read_id(struct udevice *dev, char *id, int maxlen); * * @param dev CROS-EC device * @param scan Place to put the scan results - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan); @@ -88,7 +88,7 @@ int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan); * Send a message requesting the next event and return the result. * * @param event Place to put the event. - * @return 0 if ok, <0 on error. + * Return: 0 if ok, <0 on error. */ int cros_ec_get_next_event(struct udevice *dev, struct ec_response_get_next_event *event); @@ -98,7 +98,7 @@ int cros_ec_get_next_event(struct udevice *dev, * * @param dev CROS-EC device * @param image Destination for image identifier - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_read_current_image(struct udevice *dev, enum ec_current_image *image); @@ -109,7 +109,7 @@ int cros_ec_read_current_image(struct udevice *dev, * @param dev CROS-EC device * @param hash_offset Offset in flash to read from * @param hash Destination for hash information - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_read_hash(struct udevice *dev, uint hash_offset, struct ec_response_vboot_hash *hash); @@ -122,7 +122,7 @@ int cros_ec_read_hash(struct udevice *dev, uint hash_offset, * @param dev CROS-EC device * @param cmd Reboot command * @param flags Flags for reboot command (EC_REBOOT_FLAG_*) - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_reboot(struct udevice *dev, enum ec_reboot_cmd cmd, uint8_t flags); @@ -133,7 +133,7 @@ int cros_ec_reboot(struct udevice *dev, enum ec_reboot_cmd cmd, uint8_t flags); * If no external interrupt is configured, this always returns 1. * * @param dev CROS-EC device - * @return 0 if no interrupt is pending + * Return: 0 if no interrupt is pending */ int cros_ec_interrupt_pending(struct udevice *dev); @@ -151,7 +151,7 @@ enum { * * @param blob Device tree blob containing setup information * @param cros_ecp Returns pointer to the cros_ec device, or NULL if none - * @return 0 if we got an cros_ec device and all is well (or no cros_ec is + * Return: 0 if we got an cros_ec device and all is well (or no cros_ec is * expected), -ve if we should have an cros_ec device but failed to find * one, or init failed (-CROS_EC_ERR_...). */ @@ -170,7 +170,7 @@ int cros_ec_info(struct udevice *dev, struct ec_response_mkbp_info *info); * * @param dev CROS-EC device * @param events_ptr Destination for event flags. Not changed on error. - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_get_host_events(struct udevice *dev, uint32_t *events_ptr); @@ -179,7 +179,7 @@ int cros_ec_get_host_events(struct udevice *dev, uint32_t *events_ptr); * * @param dev CROS-EC device * @param events Event flags to clear - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_clear_host_events(struct udevice *dev, uint32_t events); @@ -192,7 +192,7 @@ int cros_ec_clear_host_events(struct udevice *dev, uint32_t events); * @param set_flags New flag values; only bits in set_mask are applied; * ignored if set_mask=0. * @param prot Destination for updated protection state from EC. - * @return 0 if ok, <0 on error + * Return: 0 if ok, <0 on error */ int cros_ec_flash_protect(struct udevice *dev, uint32_t set_mask, uint32_t set_flags, @@ -202,7 +202,7 @@ int cros_ec_flash_protect(struct udevice *dev, uint32_t set_mask, * Run internal tests on the cros_ec interface. * * @param dev CROS-EC device - * @return 0 if ok, <0 if the test failed + * Return: 0 if ok, <0 if the test failed */ int cros_ec_test(struct udevice *dev); @@ -212,7 +212,7 @@ int cros_ec_test(struct udevice *dev); * @param dev CROS-EC device * @param image the content to write * @param imafge_size content length - * @return 0 if ok, <0 if the test failed + * Return: 0 if ok, <0 if the test failed */ int cros_ec_flash_update_rw(struct udevice *dev, const uint8_t *image, int image_size); @@ -220,7 +220,7 @@ int cros_ec_flash_update_rw(struct udevice *dev, const uint8_t *image, /** * Return a pointer to the board's CROS-EC device * - * @return pointer to CROS-EC device, or NULL if none is available + * Return: pointer to CROS-EC device, or NULL if none is available */ struct udevice *board_get_cros_ec_dev(void); @@ -302,7 +302,7 @@ void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len); * * @param data Data block to checksum * @param size Size of data block in bytes - * @return checksum value (0 to 255) + * Return: checksum value (0 to 255) */ int cros_ec_calc_checksum(const uint8_t *data, int size); @@ -321,7 +321,7 @@ int cros_ec_flash_erase(struct udevice *dev, uint32_t offset, uint32_t size); * @param data Pointer to data buffer to read into * @param offset Offset within flash to read from * @param size Number of bytes to read - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_flash_read(struct udevice *dev, uint8_t *data, uint32_t offset, uint32_t size); @@ -353,7 +353,7 @@ int cros_ec_read_flashinfo(struct udevice *dev, * @param data Pointer to data buffer to write * @param offset Offset within flash to write to. * @param size Number of bytes to write - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_flash_write(struct udevice *dev, const uint8_t *data, uint32_t offset, uint32_t size); @@ -365,7 +365,7 @@ int cros_ec_flash_write(struct udevice *dev, const uint8_t *data, * @param region Flash region to query * @param offset Returns offset of flash region in EC flash * @param size Returns size of flash region - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_flash_offset(struct udevice *dev, enum ec_flash_region region, uint32_t *offset, uint32_t *size); @@ -383,7 +383,7 @@ int cros_ec_get_sku_id(struct udevice *dev); * * @param dev CROS-EC device * @param block Buffer of VbNvContext to be read/write - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_nvdata(struct udevice *dev, uint8_t *block, int size); int cros_ec_write_nvdata(struct udevice *dev, const uint8_t *block, int size); @@ -393,7 +393,7 @@ int cros_ec_write_nvdata(struct udevice *dev, const uint8_t *block, int size); * * @param dev CROS-EC device * @param versionp This is set to point to the version information - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_version(struct udevice *dev, struct ec_response_get_version **versionp); @@ -403,7 +403,7 @@ int cros_ec_read_version(struct udevice *dev, * * @param dev CROS-EC device * @param versionp This is set to point to the build string - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_read_build_info(struct udevice *dev, char **strp); @@ -413,7 +413,7 @@ int cros_ec_read_build_info(struct udevice *dev, char **strp); * @param dev CROS-EC device * @param index index of the LDO/FET to switch * @param state new state of the LDO/FET : EC_LDO_STATE_ON|OFF - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state); @@ -423,7 +423,7 @@ int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state); * @param dev CROS-EC device * @param index index of the LDO/FET to switch * @param state current state of the LDO/FET : EC_LDO_STATE_ON|OFF - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state); @@ -433,7 +433,7 @@ int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state); * This permits delayed reporting of the EC error if it failed during * early init. * - * @return error (0 if there was no error, -ve if there was an error) + * Return: error (0 if there was no error, -ve if there was an error) */ int cros_ec_get_error(void); @@ -468,7 +468,7 @@ int cros_ec_i2c_tunnel(struct udevice *dev, int port, struct i2c_msg *msg, /** * cros_ec_get_events_b() - Get event mask B * - * @return value of event mask, default value of 0 if it could not be read + * Return: value of event mask, default value of 0 if it could not be read */ uint64_t cros_ec_get_events_b(struct udevice *dev); @@ -477,7 +477,7 @@ uint64_t cros_ec_get_events_b(struct udevice *dev); * * Any pending events in the B range are cleared * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_clear_events_b(struct udevice *dev, uint64_t mask); @@ -486,7 +486,7 @@ int cros_ec_clear_events_b(struct udevice *dev, uint64_t mask); * * @param dev CROS-EC device * @param region Flash region to query - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region); @@ -499,7 +499,7 @@ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region); * * @param dev CROS-EC device * @param flags Flags to use (EC_BATTERY_CUTOFF_FLAG_...) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_battery_cutoff(struct udevice *dev, uint8_t flags); @@ -512,7 +512,7 @@ int cros_ec_battery_cutoff(struct udevice *dev, uint8_t flags); * @param dev CROS-EC device * @param index Index of the pwm * @param duty Desired duty cycle, in 0..EC_PWM_MAX_DUTY range. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_set_pwm_duty(struct udevice *dev, uint8_t index, uint16_t duty); @@ -524,7 +524,7 @@ int cros_ec_set_pwm_duty(struct udevice *dev, uint8_t index, uint16_t duty); * * @param dev CROS-EC device * @param limit_powerp Returns whether power is limited (0 or 1) - * @return 0 if OK, -ENOSYS if the EC does not support this comment, -EINVAL + * Return: 0 if OK, -ENOSYS if the EC does not support this comment, -EINVAL * if the EC returned an invalid response */ int cros_ec_read_limit_power(struct udevice *dev, int *limit_powerp); @@ -534,7 +534,7 @@ int cros_ec_read_limit_power(struct udevice *dev, int *limit_powerp); * * @param dev CROS-EC device * @param flags Flags to use (EC_POWER_BUTTON_...) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_config_powerbtn(struct udevice *dev, uint32_t flags); @@ -544,7 +544,7 @@ int cros_ec_config_powerbtn(struct udevice *dev, uint32_t flags); * Determines whether a lid close event is reported * * @param dev CROS-EC device - * @return shufdown mas if OK, -ve on error + * Return: shufdown mas if OK, -ve on error */ int cros_ec_get_lid_shutdown_mask(struct udevice *dev); @@ -555,7 +555,7 @@ int cros_ec_get_lid_shutdown_mask(struct udevice *dev); * * @param dev CROS-EC device * @param enable true to enable reporting, false to disable - * @return shufdown mas if OK, -ve on error + * Return: shufdown mas if OK, -ve on error */ int cros_ec_set_lid_shutdown_mask(struct udevice *dev, int enable); @@ -567,7 +567,7 @@ int cros_ec_set_lid_shutdown_mask(struct udevice *dev, int enable); * * @dev: CROS-EC device * @handshakep: If non-NULL, returns received handshake value on error - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_hello(struct udevice *dev, uint *handshakep); @@ -578,7 +578,7 @@ int cros_ec_hello(struct udevice *dev, uint *handshakep); * * @dev: CROS-EC device * @featuresp: Returns a bitmask of supported features - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_get_features(struct udevice *dev, u64 *featuresp); @@ -587,7 +587,7 @@ int cros_ec_get_features(struct udevice *dev, u64 *featuresp); * * @dev: CROS-EC device * @feature: Feature number to check (enum ec_feature_code) - * @return true if supported, false if not, -ve on error + * Return: true if supported, false if not, -ve on error */ int cros_ec_check_feature(struct udevice *dev, uint feature); @@ -595,7 +595,7 @@ int cros_ec_check_feature(struct udevice *dev, uint feature); * cros_ec_get_switches() - Get switches value * * @dev: CROS-EC device - * @return switches value, or -ENOSYS if not supported, or other -ve value on + * Return: switches value, or -ENOSYS if not supported, or other -ve value on * other error */ int cros_ec_get_switches(struct udevice *dev); @@ -604,7 +604,7 @@ int cros_ec_get_switches(struct udevice *dev); * cros_ec_vstore_supported() - Check if vstore is supported * * @dev: CROS-EC device - * @return false if not supported, true if supported, -ve on error + * Return: false if not supported, true if supported, -ve on error */ int cros_ec_vstore_supported(struct udevice *dev); @@ -613,7 +613,7 @@ int cros_ec_vstore_supported(struct udevice *dev); * * @dev: CROS-EC device * @lockedp: mask of locked slots - * @return number of vstore slots supported by the EC,, -ve on error + * Return: number of vstore slots supported by the EC,, -ve on error */ int cros_ec_vstore_info(struct udevice *dev, u32 *lockedp); @@ -623,7 +623,7 @@ int cros_ec_vstore_info(struct udevice *dev, u32 *lockedp); * @dev: CROS-EC device * @slot: vstore slot to read from * @data: buffer to store read data, must be EC_VSTORE_SLOT_SIZE bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_vstore_read(struct udevice *dev, int slot, uint8_t *data); @@ -638,7 +638,7 @@ int cros_ec_vstore_read(struct udevice *dev, int slot, uint8_t *data); * @slot: vstore slot to write into * @data: data to write * @size: size of data in bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int cros_ec_vstore_write(struct udevice *dev, int slot, const uint8_t *data, size_t size); diff --git a/include/crypt.h b/include/crypt.h index f18a1705d4..3301f3b769 100644 --- a/include/crypt.h +++ b/include/crypt.h @@ -9,6 +9,6 @@ * @equal Pointer to an int where the result is stored * '0' = unequal * '1' = equal - * @return 0 on success, error code of errno else + * Return: 0 on success, error code of errno else */ int crypt_compare(const char *should, const char *passphrase, int *equal); diff --git a/include/display.h b/include/display.h index 66294616ea..3d01217644 100644 --- a/include/display.h +++ b/include/display.h @@ -27,7 +27,7 @@ struct display_plat { * display_read_timing() - Read timing information * * @dev: Device to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int display_read_timing(struct udevice *dev, struct display_timing *timing); @@ -37,7 +37,7 @@ int display_read_timing(struct udevice *dev, struct display_timing *timing); * @dev: Device to enable * @panel_bpp: Number of bits per pixel for panel * @timing: Display timings - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int display_enable(struct udevice *dev, int panel_bpp, const struct display_timing *timing); @@ -45,7 +45,7 @@ int display_enable(struct udevice *dev, int panel_bpp, /** * display_in_use() - Check if a display is in use by any device * - * @return true if the device is in use (display_enable() has been called + * Return: true if the device is in use (display_enable() has been called * successfully), else false */ bool display_in_use(struct udevice *dev); diff --git a/include/display_options.h b/include/display_options.h index 43810cbe22..33fcbb8533 100644 --- a/include/display_options.h +++ b/include/display_options.h @@ -66,7 +66,7 @@ int print_buffer(ulong addr, const void *data, uint width, uint count, * @linelen: Number of values to print per line; specify 0 for default length * @out: Output buffer to hold the dump * @size: Size of output buffer in bytes - * @return number of bytes processed, if OK, -ENOSPC if buffer too small + * Return: number of bytes processed, if OK, -ENOSPC if buffer too small * */ int hexdump_line(ulong addr, const void *data, uint width, uint count, @@ -91,7 +91,7 @@ int display_options(void); * @newlines: true to include two newlines at the start * @buf: place to put string * @size: Size of buf (string is truncated to fit) - * @return buf + * Return: buf */ char *display_options_get_banner(bool newlines, char *buf, int size); diff --git a/include/dm/acpi.h b/include/dm/acpi.h index 7f1f2ef2cb..0fa239eb3a 100644 --- a/include/dm/acpi.h +++ b/include/dm/acpi.h @@ -139,7 +139,7 @@ struct acpi_ops { * @dev: Device to check * @out_name: Place to put the name, must hold at least ACPI_NAME_MAX * bytes - * @return 0 if OK, -ENOENT if no name is available, other -ve value on + * Return: 0 if OK, -ENOENT if no name is available, other -ve value on * other error */ int acpi_get_name(const struct udevice *dev, char *out_name); @@ -159,7 +159,7 @@ int acpi_get_name(const struct udevice *dev, char *out_name); * * @out_name: Place to put the name * @name: Name to copy - * @return 0 (always) + * Return: 0 (always) */ int acpi_copy_name(char *out_name, const char *name); @@ -169,7 +169,7 @@ int acpi_copy_name(char *out_name, const char *name); * This scans through all devices and tells them to write any tables they want * to write. * - * @return 0 if OK, -ve if any device returned an error + * Return: 0 if OK, -ve if any device returned an error */ int acpi_write_dev_tables(struct acpi_ctx *ctx); @@ -179,7 +179,7 @@ int acpi_write_dev_tables(struct acpi_ctx *ctx); * This is called to create the SSDT code for all devices. * * @ctx: ACPI context to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_fill_ssdt(struct acpi_ctx *ctx); @@ -189,7 +189,7 @@ int acpi_fill_ssdt(struct acpi_ctx *ctx); * This is called to create the DSDT code for all devices. * * @ctx: ACPI context to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_inject_dsdt(struct acpi_ctx *ctx); @@ -200,7 +200,7 @@ int acpi_inject_dsdt(struct acpi_ctx *ctx); * * @ctx: ACPI context to use * @nhlt: Pointer to nhlt information to add to - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_setup_nhlt(struct acpi_ctx *ctx, struct nhlt *nhlt); @@ -223,7 +223,7 @@ void acpi_dump_items(enum acpi_dump_option option); * @dev: Device to check * @out_path: Buffer to place the path in (should be ACPI_PATH_MAX long) * @maxlen: Size of buffer (typically ACPI_PATH_MAX) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen); diff --git a/include/dm/device-internal.h b/include/dm/device-internal.h index e6b71cbfd2..02002acb78 100644 --- a/include/dm/device-internal.h +++ b/include/dm/device-internal.h @@ -109,7 +109,7 @@ struct udevice; * @ofnode: Devicetree node for this device. This is ofnode_null() for * devices which don't use devicetree or don't have a node. * @devp: if non-NULL, returns a pointer to the bound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_bind(struct udevice *parent, const struct driver *drv, const char *name, void *plat, ofnode node, @@ -132,7 +132,7 @@ int device_bind(struct udevice *parent, const struct driver *drv, * @node: Device tree node for this device. This is invalid for devices which * don't use device tree. * @devp: if non-NULL, returns a pointer to the bound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_bind_with_driver_data(struct udevice *parent, const struct driver *drv, const char *name, @@ -149,7 +149,7 @@ int device_bind_with_driver_data(struct udevice *parent, * is set. If false bind the driver always. * @info: Name and plat for this device * @devp: if non-NULL, returns a pointer to the bound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_bind_by_name(struct udevice *parent, bool pre_reloc_only, const struct driver_info *info, struct udevice **devp); @@ -159,7 +159,7 @@ int device_bind_by_name(struct udevice *parent, bool pre_reloc_only, * * @dev: pointer to device to be reparented * @new_parent: pointer to new parent device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_reparent(struct udevice *dev, struct udevice *new_parent); @@ -175,7 +175,7 @@ int device_reparent(struct udevice *dev, struct udevice *new_parent); * All private data associated with the device is allocated. * * @dev: Pointer to device to process - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_of_to_plat(struct udevice *dev); @@ -186,7 +186,7 @@ int device_of_to_plat(struct udevice *dev); * first. * * @dev: Pointer to device to probe - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int device_probe(struct udevice *dev); @@ -198,7 +198,7 @@ int device_probe(struct udevice *dev); * * @dev: Pointer to device to remove * @flags: Flags for selective device removal (DM_REMOVE_...) - * @return 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if + * Return: 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if * this is a vital device and flags is DM_REMOVE_NON_VITAL, other -ve on * error (such an error here is normally a very bad thing) */ @@ -214,7 +214,7 @@ static inline int device_remove(struct udevice *dev, uint flags) { return 0; } * Unbind a device and remove all memory used by it * * @dev: Pointer to device to unbind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) int device_unbind(struct udevice *dev); @@ -237,7 +237,7 @@ static inline void device_free(struct udevice *dev) {} * * @dev: The device that is to be stripped of its children * @drv: The targeted driver - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) int device_chld_unbind(struct udevice *dev, struct driver *drv); @@ -261,7 +261,7 @@ static inline int device_chld_unbind(struct udevice *dev, struct driver *drv) * @dev: The device whose children are to be removed * @drv: The targeted driver * @flags: Flag, if this functions is called in the pre-OS stage - * @return 0 on success, -EPROBE_DEFER if any child failed to remove, other + * Return: 0 on success, -EPROBE_DEFER if any child failed to remove, other * -ve on error */ #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE) @@ -385,7 +385,7 @@ void dev_set_uclass_plat(struct udevice *dev, void *uclass_plat); * * @dev: Simple bus device (parent of target device) * @addr: Address to translate - * @return new address + * Return: new address */ fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr); diff --git a/include/dm/pci.h b/include/dm/pci.h index bddacbf599..d35d24d959 100644 --- a/include/dm/pci.h +++ b/include/dm/pci.h @@ -16,7 +16,7 @@ struct udevice; * This returns an int to avoid a dependency on pci.h * * @dev: PCI device - * @return devfn in bits 15...8 if found (pci_dev_t format), or -ENODEV if not + * Return: devfn in bits 15...8 if found (pci_dev_t format), or -ENODEV if not * found */ int pci_get_devfn(struct udevice *dev); @@ -33,7 +33,7 @@ int pci_get_devfn(struct udevice *dev); * @reg: reg value from dt-plat.c array (first member). This is not a * pointer type, since the caller may use fdt32_t or fdt64_t depending on * the address sizes. - * @return device/function for that device (pci_dev_t format) + * Return: device/function for that device (pci_dev_t format) */ static inline int pci_ofplat_get_devfn(u32 reg) { diff --git a/include/dm/test.h b/include/dm/test.h index a9562b2bfc..4919064cc0 100644 --- a/include/dm/test.h +++ b/include/dm/test.h @@ -26,7 +26,7 @@ struct dm_test_pdata { * @dev: Device to operate on * @pingval: Value to ping the device with * @pingret: Returns resulting value from driver - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ struct test_ops { int (*ping)(struct udevice *dev, int pingval, int *pingret); @@ -189,7 +189,7 @@ int testfdt_ping(struct udevice *dev, int pingval, int *pingret); * @dev: Device to test * @base: Base address, used to check ping return value * @priv: Pointer to private test information - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, uint32_t base, struct dm_test_priv *priv); @@ -199,7 +199,7 @@ int dm_check_operations(struct unit_test_state *uts, struct udevice *dev, * * @dms: Overall test state * @num_devices: Number of test devices to check - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_check_devices(struct unit_test_state *uts, int num_devices); diff --git a/include/dm/uclass-internal.h b/include/dm/uclass-internal.h index fb0edcc296..e71b86a973 100644 --- a/include/dm/uclass-internal.h +++ b/include/dm/uclass-internal.h @@ -89,7 +89,7 @@ void uclass_set_priv(struct uclass *uc, void *priv); * This allows assigning the sequence number in the binding order. * * @uc: uclass to check - * @return The next free sequence number + * Return: The next free sequence number */ int uclass_find_next_free_seq(struct uclass *uc); @@ -101,7 +101,7 @@ int uclass_find_next_free_seq(struct uclass *uc); * @dev: Device that needs to be probed * @ret: Error to return. If non-zero then the device is not probed * @devp: Returns the value of 'dev' if there is no error - * @return ret, if non-zero, else the result of the device_probe() call + * Return: ret, if non-zero, else the result of the device_probe() call */ int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp); @@ -112,7 +112,7 @@ int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp); * * The device is not prepared for use - this is an internal function. * - * @return the index of the device in the uclass list or -ENODEV if not found. + * Return: the index of the device in the uclass list or -ENODEV if not found. */ int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp); @@ -125,7 +125,7 @@ int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp); * The device is not prepared for use - this is an internal function. * The function uclass_get_device_tail() can be used to probe the device. * - * @return the uclass pointer of a child at the given index or + * Return: the uclass pointer of a child at the given index or * return NULL on error. */ int uclass_find_device(enum uclass_id id, int index, struct udevice **devp); @@ -138,7 +138,7 @@ int uclass_find_device(enum uclass_id id, int index, struct udevice **devp); * The device is not prepared for use - this is an internal function. * The function uclass_get_device_tail() can be used to probe the device. * - * @return 0 if OK (found or not found), -ve on error + * Return: 0 if OK (found or not found), -ve on error */ int uclass_find_first_device(enum uclass_id id, struct udevice **devp); @@ -150,7 +150,7 @@ int uclass_find_first_device(enum uclass_id id, struct udevice **devp); * The device is not prepared for use - this is an internal function. * The function uclass_get_device_tail() can be used to probe the device. * - * @return 0 if OK (found or not found), -ve on error + * Return: 0 if OK (found or not found), -ve on error */ int uclass_find_next_device(struct udevice **devp); @@ -164,7 +164,7 @@ int uclass_find_next_device(struct udevice **devp); * @id: ID to look up * @name: name of a device to find * @devp: Returns pointer to device (the first one with the name) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int uclass_find_device_by_name(enum uclass_id id, const char *name, struct udevice **devp); @@ -179,7 +179,7 @@ int uclass_find_device_by_name(enum uclass_id id, const char *name, * @id: ID to look up * @seq: Sequence number to find (0=first) * @devp: Returns pointer to device (there is only one per for each seq) - * @return 0 if OK, -ENODEV if not found + * Return: 0 if OK, -ENODEV if not found */ int uclass_find_device_by_seq(enum uclass_id id, int seq, struct udevice **devp); @@ -195,7 +195,7 @@ int uclass_find_device_by_seq(enum uclass_id id, int seq, * @id: ID to look up * @node: Device tree offset to search for (if -ve then -ENODEV is returned) * @devp: Returns pointer to device (there is only one for each node) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int uclass_find_device_by_of_offset(enum uclass_id id, int node, struct udevice **devp); @@ -211,7 +211,7 @@ int uclass_find_device_by_of_offset(enum uclass_id id, int node, * @id: ID to look up * @node: Device tree offset to search for (if NULL then -ENODEV is returned) * @devp: Returns pointer to device (there is only one for each node) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node, struct udevice **devp); @@ -227,7 +227,7 @@ int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node, * @parent: Parent device containing the phandle pointer * @name: Name of property in the parent device node * @devp: Returns pointer to device (there is only one for each node) - * @return 0 if OK, -ENOENT if there is no @name present in the node, other + * Return: 0 if OK, -ENOENT if there is no @name present in the node, other * -ve on error */ int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent, @@ -317,7 +317,7 @@ int uclass_get_count(void); * uclass_find() - Find uclass by its id * * @id: Id to serach for - * @return pointer to uclass, or NULL if not found + * Return: pointer to uclass, or NULL if not found */ struct uclass *uclass_find(enum uclass_id key); @@ -327,7 +327,7 @@ struct uclass *uclass_find(enum uclass_id key); * Destroy a uclass and all its devices * * @uc: uclass to destroy - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int uclass_destroy(struct uclass *uc); diff --git a/include/dm/util.h b/include/dm/util.h index 17baf55c25..4428f045b7 100644 --- a/include/dm/util.h +++ b/include/dm/util.h @@ -20,7 +20,7 @@ struct list_head; * list_count_items() - Count number of items in a list * * @param head: Head of list - * @return number of items, or 0 if empty + * Return: number of items, or 0 if empty */ int list_count_items(struct list_head *head); diff --git a/include/dma.h b/include/dma.h index a64580a61f..9b39221227 100644 --- a/include/dma.h +++ b/include/dma.h @@ -179,7 +179,7 @@ struct dma { * @index: The index of the DMA to request, within the client's list of * DMA channels. * @dma: A pointer to a DMA struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_get_by_index(struct udevice *dev, int index, struct dma *dma); @@ -196,7 +196,7 @@ int dma_get_by_index(struct udevice *dev, int index, struct dma *dma); * @name: The name of the DMA to request, within the client's list of * DMA channels. * @dma: A pointer to a DMA struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_get_by_name(struct udevice *dev, const char *name, struct dma *dma); # else @@ -225,7 +225,7 @@ static inline int dma_get_by_name(struct udevice *dev, const char *name, * @dma: A pointer to a DMA struct to initialize. The caller must * have already initialized any field in this struct which the * DMA provider uses to identify the DMA channel. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_request(struct udevice *dev, struct dma *dma); @@ -234,7 +234,7 @@ int dma_request(struct udevice *dev, struct dma *dma); * * @dma: A DMA struct that was previously successfully requested by * dma_request/get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int dma_free(struct dma *dma); @@ -243,7 +243,7 @@ int dma_free(struct dma *dma); * * @dma: A DMA struct that was previously successfully requested by * dma_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_enable(struct dma *dma); @@ -252,7 +252,7 @@ int dma_enable(struct dma *dma); * * @dma: A DMA struct that was previously successfully requested by * dma_request/get_by_*(). - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_disable(struct dma *dma); @@ -266,7 +266,7 @@ int dma_disable(struct dma *dma); * dma_request/get_by_*(). * @dst: The receive buffer pointer. * @size: The receive buffer size - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_prepare_rcv_buf(struct dma *dma, void *dst, size_t size); @@ -277,7 +277,7 @@ int dma_prepare_rcv_buf(struct dma *dma, void *dst, size_t size); * dma_request/get_by_*(). * @dst: The destination pointer. * @metadata: DMA driver's channel specific data - * @return length of received data on success, or zero - no data, + * Return: length of received data on success, or zero - no data, * or -ve error code. */ int dma_receive(struct dma *dma, void **dst, void *metadata); @@ -290,7 +290,7 @@ int dma_receive(struct dma *dma, void **dst, void *metadata); * @src: The source pointer. * @len: Length of the data to be sent (number of bytes). * @metadata: DMA driver's channel specific data - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_send(struct dma *dma, void *src, size_t len, void *metadata); @@ -302,7 +302,7 @@ int dma_send(struct dma *dma, void *src, size_t len, void *metadata); * configuration data client needs * @cfg_data: Pointer to store pointer to DMA driver specific * configuration data for the given cfg_id (output param) - * @return zero on success, or -ve error code. + * Return: zero on success, or -ve error code. */ int dma_get_cfg(struct dma *dma, u32 cfg_id, void **cfg_data); #endif /* CONFIG_DMA_CHANNELS */ @@ -315,7 +315,7 @@ int dma_get_cfg(struct dma *dma, u32 cfg_id, void **cfg_data); * @transfer_type - transfer type should be one/multiple of * DMA_SUPPORTS_* * @devp - udevice pointer to return the found device - * @return - will return on success and devp will hold the + * Return: - will return on success and devp will hold the * pointer to the device */ int dma_get_device(u32 transfer_type, struct udevice **devp); @@ -327,7 +327,7 @@ int dma_get_device(u32 transfer_type, struct udevice **devp); * @dst - destination pointer * @src - souce pointer * @len - data length to be copied - * @return - on successful transfer returns no of bytes + * Return: - on successful transfer returns no of bytes transferred and on failure return error code. */ int dma_memcpy(void *dst, void *src, size_t len); diff --git a/include/dsi_host.h b/include/dsi_host.h index 9dfc7b3687..83f8839db6 100644 --- a/include/dsi_host.h +++ b/include/dsi_host.h @@ -54,7 +54,7 @@ struct dsi_host_ops { * @timing: Display timings * @max_data_lanes: maximum number of data lines * @phy_ops: set of function pointers for performing physical operations - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dsi_host_init(struct udevice *dev, struct mipi_dsi_device *device, @@ -66,7 +66,7 @@ int dsi_host_init(struct udevice *dev, * dsi_host_enable * * @dev: dsi host device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dsi_host_enable(struct udevice *dev); diff --git a/include/dwmmc.h b/include/dwmmc.h index 5fc8ed8395..136a95b8cd 100644 --- a/include/dwmmc.h +++ b/include/dwmmc.h @@ -284,7 +284,7 @@ void dwmci_setup_cfg(struct mmc_config *cfg, struct dwmci_host *host, * @cfg: Empty configuration structure (generally &plat->cfg). This is * normally all zeroes at this point. The only purpose of passing * this in is to set mmc->cfg to it. - * @return 0 if OK, -ve if the block device could not be created + * Return: 0 if OK, -ve if the block device could not be created */ int dwmci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); @@ -297,7 +297,7 @@ int dwmci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); * @host: DWMMC host structure * @max_clk: Maximum supported clock speed in HZ (e.g. 150000000) * @min_clk: Minimum supported clock speed in HZ (e.g. 400000) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int add_dwmci(struct dwmci_host *host, u32 max_clk, u32 min_clk); #endif /* !CONFIG_BLK */ diff --git a/include/edid.h b/include/edid.h index 2562733061..cee7c4c763 100644 --- a/include/edid.h +++ b/include/edid.h @@ -277,7 +277,7 @@ void edid_print_info(struct edid1_info *edid_info); * Check the EDID info. * * @param info The EDID info to be checked - * @return 0 on valid, or -1 on invalid + * Return: 0 on valid, or -1 on invalid */ int edid_check_info(struct edid1_info *info); @@ -286,7 +286,7 @@ int edid_check_info(struct edid1_info *info); * * @param edid_block EDID block data * - * @return 0 on success, or a negative errno on error + * Return: 0 on success, or a negative errno on error */ int edid_check_checksum(u8 *edid_block); @@ -298,7 +298,7 @@ int edid_check_checksum(u8 *edid_block); * @param hmax Returns the maxium horizontal rate * @param vmin Returns the minimum vertical rate * @param vmax Returns the maxium vertical rate - * @return 0 on success, or -1 on error + * Return: 0 on success, or -1 on error */ int edid_get_ranges(struct edid1_info *edid, unsigned int *hmin, unsigned int *hmax, unsigned int *vmin, @@ -319,7 +319,7 @@ struct display_timing; * @param mode_valid Callback validating mode, returning true is mode is * supported, false otherwise. * @parem valid_priv Pointer to private data for mode_valid callback - * @return 0 if timings are OK, -ve on error + * Return: 0 if timings are OK, -ve on error */ int edid_get_timing_validate(u8 *buf, int buf_size, struct display_timing *timing, @@ -337,7 +337,7 @@ int edid_get_timing_validate(u8 *buf, int buf_size, * @param panel_bits_per_colourp Place to put the number of bits per * colour supported by the panel. This will be set to * -1 if not available - * @return 0 if timings are OK, -ve on error + * Return: 0 if timings are OK, -ve on error */ int edid_get_timing(u8 *buf, int buf_size, struct display_timing *timing, int *panel_bits_per_colourp); diff --git a/include/efi_loader.h b/include/efi_loader.h index f20d361876..701efcd2b6 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -553,7 +553,7 @@ void efi_initrd_deregister(void); * * Called by bootefi to make ACPI tables available * - * @return 0 if OK, -ENOMEM if no memory is available for the tables + * Return: 0 if OK, -ENOMEM if no memory is available for the tables */ efi_status_t efi_acpi_register(void); /** @@ -561,7 +561,7 @@ efi_status_t efi_acpi_register(void); * * Called by bootefi to make SMBIOS tables available * - * @return 0 if OK, -ENOMEM if no memory is available for the tables + * Return: 0 if OK, -ENOMEM if no memory is available for the tables */ efi_status_t efi_smbios_register(void); @@ -976,7 +976,7 @@ efi_status_t efi_capsule_authenticate(const void *capsule, /** * Install the ESRT system table. * - * @return status code + * Return: status code */ efi_status_t efi_esrt_register(void); diff --git a/include/env.h b/include/env.h index ff8943ed96..60acb5454e 100644 --- a/include/env.h +++ b/include/env.h @@ -68,7 +68,7 @@ enum env_redund_flags { * This value increments every time the environment changes, so can be used an * an indication of this * - * @return environment ID + * Return: environment ID */ int env_get_id(void); @@ -78,7 +78,7 @@ int env_get_id(void); * This locates the environment or uses the default if nothing is available. * This must be called before env_get() will work. * - * @return 0 if OK, -ENODEV if no environment drivers are enabled + * Return: 0 if OK, -ENODEV if no environment drivers are enabled */ int env_init(void); @@ -98,7 +98,7 @@ void env_relocate(void); * case this function calls env_get_f(). * * @varname: Variable to look up - * @return value of variable, or NULL if not found + * Return: value of variable, or NULL if not found */ char *env_get(const char *varname); @@ -108,7 +108,7 @@ char *env_get(const char *varname); * place of env_get without changing error handling otherwise. * * @varname: Variable to look up - * @return value of variable, or NULL if not found + * Return: value of variable, or NULL if not found */ char *from_env(const char *envvar); @@ -120,7 +120,7 @@ char *from_env(const char *envvar); * support reading the value (slowly) and some will not. * * @varname: Variable to look up - * @return actual length of the variable value excluding the terminating + * Return: actual length of the variable value excluding the terminating * NULL-byte, or -1 if the variable is not found */ int env_get_f(const char *name, char *buf, unsigned int len); @@ -128,7 +128,7 @@ int env_get_f(const char *name, char *buf, unsigned int len); /** * env_get_yesno() - Read an environment variable as a boolean * - * @return 1 if yes/true (Y/y/T/t), -1 if variable does not exist (i.e. default + * Return: 1 if yes/true (Y/y/T/t), -1 if variable does not exist (i.e. default * to true), 0 if otherwise */ int env_get_yesno(const char *var); @@ -136,7 +136,7 @@ int env_get_yesno(const char *var); /** * env_get_autostart() - Check if autostart is enabled * - * @return true if the "autostart" env var exists and is set to "yes" + * Return: true if the "autostart" env var exists and is set to "yes" */ bool env_get_autostart(void); @@ -148,7 +148,7 @@ bool env_get_autostart(void); * * @varname: Variable to adjust * @value: Value to set for the variable, or NULL or "" to delete the variable - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_set(const char *varname, const char *value); @@ -161,7 +161,7 @@ int env_set(const char *varname, const char *value); * @name: Variable to look up * @base: Base to use (e.g. 10 for base 10, 2 for binary) * @default_val: Default value to return if no value is found - * @return the value found, or @default_val if none + * Return: the value found, or @default_val if none */ ulong env_get_ulong(const char *name, int base, ulong default_val); @@ -170,7 +170,7 @@ ulong env_get_ulong(const char *name, int base, ulong default_val); * * @varname: Variable to adjust * @value: Value to set for the variable (will be converted to a string) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_set_ulong(const char *varname, ulong value); @@ -191,7 +191,7 @@ ulong env_get_hex(const char *varname, ulong default_val); * * @varname: Variable to adjust * @value: Value to set for the variable (will be converted to a hex string) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_set_hex(const char *varname, ulong value); @@ -200,7 +200,7 @@ int env_set_hex(const char *varname, ulong value); * * @varname: Environment variable to set * @addr: Value to set it to - * @return 0 if ok, 1 on error + * Return: 0 if ok, 1 on error */ static inline int env_set_addr(const char *varname, const void *addr) { @@ -216,7 +216,7 @@ static inline int env_set_addr(const char *varname, const void *addr) * @maxsz: Size of buffer to use for matches * @buf: Buffer to use for matches * @dollar_comp: non-zero to wrap each match in ${...} - * @return number of matches found (in @cmdv) + * Return: number of matches found (in @cmdv) */ int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf, bool dollar_comp); @@ -226,7 +226,7 @@ int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf, * * @name: Environment variable to get (e.g. "ethaddr") * @enetaddr: Place to put MAC address (6 bytes) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr); @@ -235,7 +235,7 @@ int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr); * * @name: Environment variable to set (e.g. "ethaddr") * @enetaddr: Pointer to MAC address to put into the variable (6 bytes) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr); @@ -258,35 +258,35 @@ int env_set_default_vars(int nvars, char *const vars[], int flags); /** * env_load() - Load the environment from storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_load(void); /** * env_reload() - Re-Load the environment from current storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_reload(void); /** * env_save() - Save the environment to storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_save(void); /** * env_erase() - Erase the environment on storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_erase(void); /** * env_select() - Select the environment storage * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int env_select(const char *name); @@ -300,7 +300,7 @@ int env_select(const char *name); * @check: non-zero to check the CRC at the start of the environment, 0 to * ignore it * @flags: Flags controlling matching (H_... - see search.h) - * @return 0 if imported successfully, -ENOMSG if the CRC was bad, -EIO if + * Return: 0 if imported successfully, -ENOMSG if the CRC was bad, -EIO if * something else went wrong */ int env_import(const char *buf, int check, int flags); @@ -311,7 +311,7 @@ int env_import(const char *buf, int check, int flags); * Export from hash table into binary representation * * @env_out: Buffer to contain the environment (must be large enough!) - * @return 0 if OK, 1 on error + * Return: 0 if OK, 1 on error */ int env_export(struct environment_s *env_out); @@ -323,7 +323,7 @@ int env_export(struct environment_s *env_out); * @buf1_read_fail: 0 if buf1 is valid, non-zero if invalid * @buf2: Second environment (struct environemnt_s *) * @buf2_read_fail: 0 if buf2 is valid, non-zero if invalid - * @return 0 if OK, + * Return: 0 if OK, * -EIO if no environment is valid, * -ENOMSG if the CRC was bad */ @@ -339,7 +339,7 @@ int env_check_redund(const char *buf1, int buf1_read_fail, * @buf2: Second environment (struct environemnt_s *) * @buf2_read_fail: 0 if buf2 is valid, non-zero if invalid * @flags: Flags controlling matching (H_... - see search.h) - * @return 0 if OK, -EIO if no environment is valid, -ENOMSG if the CRC was bad + * Return: 0 if OK, -EIO if no environment is valid, -ENOMSG if the CRC was bad */ int env_import_redund(const char *buf1, int buf1_read_fail, const char *buf2, int buf2_read_fail, @@ -349,7 +349,7 @@ int env_import_redund(const char *buf1, int buf1_read_fail, * env_get_default() - Look up a variable from the default environment * * @name: Variable to look up - * @return value if found, NULL if not found in default environment + * Return: value if found, NULL if not found in default environment */ char *env_get_default(const char *name); diff --git a/include/env_internal.h b/include/env_internal.h index 174c3b1a79..07c227ecc0 100644 --- a/include/env_internal.h +++ b/include/env_internal.h @@ -220,7 +220,7 @@ extern struct hsearch_data env_htab; * It is a weak function allowing board to overidde the default interface for * U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE * - * @return string of interface, empty if not supported + * Return: string of interface, empty if not supported */ const char *env_ext4_get_intf(void); @@ -230,7 +230,7 @@ const char *env_ext4_get_intf(void); * It is a weak function allowing board to overidde the default device and * partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART * - * @return string of device and partition + * Return: string of device and partition */ const char *env_ext4_get_dev_part(void); @@ -242,7 +242,7 @@ const char *env_ext4_get_dev_part(void); * @op: operations performed on the environment * @prio: priority between the multiple environments, 0 being the * highest priority - * @return an enum env_location value on success, or -ve error code. + * Return: an enum env_location value on success, or -ve error code. */ enum env_location env_get_location(enum env_operation op, int prio); #endif /* DO_DEPS_ONLY */ diff --git a/include/extension_board.h b/include/extension_board.h index c530a0ad8a..3b75b5ba9f 100644 --- a/include/extension_board.h +++ b/include/extension_board.h @@ -19,7 +19,7 @@ struct extension { /** * extension_board_scan - Add system-specific function to scan extension board. * @param extension_list List of extension board information to update. - * @return the number of extension. + * Return: the number of extension. * * This function is called if CONFIG_CMD_EXTENSION is defined. * Needs to fill the list extension_list with elements. diff --git a/include/fdt_region.h b/include/fdt_region.h index d0c68760f7..b4930df22e 100644 --- a/include/fdt_region.h +++ b/include/fdt_region.h @@ -131,7 +131,7 @@ struct fdt_region_state { * @path_len: Length of path, must be large enough to hold the longest * path in the tree * @add_string_tab: 1 to add a region for the string table - * @return number of regions in list. If this is >max_regions then the + * Return: number of regions in list. If this is >max_regions then the * region array was exhausted. You should increase max_regions and try * the call again. */ @@ -232,7 +232,7 @@ int fdt_find_regions(const void *fdt, char * const inc[], int inc_count, * @data: Pointer to data (node name, property name, compatible * string, value (not yet supported) * @size: Size of data, or 0 if none - * @return 0 to exclude, 1 to include, -1 if no information is + * Return: 0 to exclude, 1 to include, -1 if no information is * available * @priv: Private pointer passed to h_include * @region: Returns list of regions, sorted by offset @@ -243,7 +243,7 @@ int fdt_find_regions(const void *fdt, char * const inc[], int inc_count, * path in the tree * @flags: Various flags that control the region algortihm, see * FDT_REG_... - * @return number of regions in list. If this is >max_regions then the + * Return: number of regions in list. If this is >max_regions then the * region array was exhausted. You should increase max_regions and try * the call again. Only the first max_regions elements are available in the * array. @@ -295,7 +295,7 @@ int fdt_next_region(const void *fdt, * @count: Number of regions * @max_regions: Number of entries that can fit in @region * @info: Region state as returned from fdt_next_region() - * @return new number of regions in @region (i.e. count + the number added) + * Return: new number of regions in @region (i.e. count + the number added) * or -FDT_ERR_NOSPACE if there was not enough space. */ int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count, diff --git a/include/fdt_support.h b/include/fdt_support.h index 8ec461af6c..e7cd4aa548 100644 --- a/include/fdt_support.h +++ b/include/fdt_support.h @@ -18,7 +18,7 @@ * Defined in arch/$(ARCH)/lib/bootm-fdt.c * * @blob: FDT blob to write to - * @return 0 if ok, or -ve FDT_ERR_... on failure + * Return: 0 if ok, or -ve FDT_ERR_... on failure */ int arch_fixup_fdt(void *blob); @@ -37,7 +37,7 @@ u32 fdt_getprop_u32_default(const void *fdt, const char *path, * See doc/device-tree-bindings/root.txt * * @param fdt FDT address in memory - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_root(void *fdt); @@ -47,7 +47,7 @@ int fdt_root(void *fdt); * In particular, this adds the kernel command line (bootargs) to the FDT. * * @param fdt FDT address in memory - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_chosen(void *fdt); @@ -55,7 +55,7 @@ int fdt_chosen(void *fdt); * Add initrd information to the FDT before booting the OS. * * @param fdt FDT address in memory - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end); @@ -89,7 +89,7 @@ void do_fixup_by_compat_u32(void *fdt, const char *compat, * @param blob FDT blob to update * @param start Begin of DRAM mapping in physical memory * @param size Size of the single memory bank - * @return 0 if ok, or -1 or -FDT_ERR_... on error + * Return: 0 if ok, or -1 or -FDT_ERR_... on error */ int fdt_fixup_memory(void *blob, u64 start, u64 size); @@ -105,7 +105,7 @@ int fdt_fixup_memory(void *blob, u64 start, u64 size); * @param size Array of size <banks> to hold the size of each region. * @param banks Number of memory banks to create. If 0, the reg * property will be left untouched. - * @return 0 if ok, or -1 or -FDT_ERR_... on error + * Return: 0 if ok, or -1 or -FDT_ERR_... on error */ #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks); @@ -132,7 +132,7 @@ void fdt_fixup_qe_firmware(void *fdt); * @param blob FDT blob to update * @param path path within dt * @param display name of display timing to match - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_fixup_display(void *blob, const char *path, const char *display); @@ -161,7 +161,7 @@ static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {} * @param type type (if specified, otherwise pass NULL) * @param os os-type (if specified, otherwise pass NULL) * @param arch architecture (if specified, otherwise pass NULL) - * @return 0 if ok, or -1 or -FDT_ERR_... on error + * Return: 0 if ok, or -1 or -FDT_ERR_... on error */ int fdt_record_loadable(void *blob, u32 index, const char *name, uintptr_t load_addr, u32 size, uintptr_t entry_point, @@ -182,7 +182,7 @@ int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name); * * @param blob FDT blob to update * @param bd Pointer to board data - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int ft_board_setup(void *blob, struct bd_info *bd); @@ -212,7 +212,7 @@ void ft_board_setup_ex(void *blob, struct bd_info *bd); * * @param blob FDT blob to update * @param bd Pointer to board data - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int ft_system_setup(void *blob, struct bd_info *bd); @@ -223,7 +223,7 @@ void set_working_fdt_addr(ulong addr); * * @param blob FDT blob to update * @param extrasize additional bytes needed - * @return 0 if ok, or -FDT_ERR_... on error + * Return: 0 if ok, or -FDT_ERR_... on error */ int fdt_shrink_to_minimum(void *blob, uint extrasize); int fdt_increase_size(void *fdt, int add_len); @@ -254,7 +254,7 @@ void fdt_del_node_and_alias(void *blob, const char *alias); * @param blob Pointer to device tree blob * @param node_offset Node DT offset * @param in_addr Pointer to the address to translate - * @return translated address or OF_BAD_ADDR on error + * Return: translated address or OF_BAD_ADDR on error */ u64 fdt_translate_address(const void *blob, int node_offset, const __be32 *in_addr); @@ -266,7 +266,7 @@ u64 fdt_translate_address(const void *blob, int node_offset, * @param blob Pointer to device tree blob * @param node_offset Node DT offset * @param in_addr Pointer to the DMA address to translate - * @return translated DMA address or OF_BAD_ADDR on error + * Return: translated DMA address or OF_BAD_ADDR on error */ u64 fdt_translate_dma_address(const void *blob, int node_offset, const __be32 *in_addr); @@ -280,7 +280,7 @@ u64 fdt_translate_dma_address(const void *blob, int node_offset, * @param cpu Pointer to variable storing the range's cpu address * @param bus Pointer to variable storing the range's bus address * @param size Pointer to variable storing the range's size - * @return translated DMA address or OF_BAD_ADDR on error + * Return: translated DMA address or OF_BAD_ADDR on error */ int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu, dma_addr_t *bus, u64 *size); @@ -403,7 +403,7 @@ int fdtdec_get_int(const void *blob, int node, const char *prop_name, * * @param blob FDT blob * @param node parent node - * @return number of child node; 0 if there is not child node + * Return: number of child node; 0 if there is not child node */ int fdtdec_get_child_count(const void *blob, int node); #endif diff --git a/include/fdtdec.h b/include/fdtdec.h index 15f2d2bbba..9a7b6a7ee1 100644 --- a/include/fdtdec.h +++ b/include/fdtdec.h @@ -148,7 +148,7 @@ static inline u8 *dtb_dt_embedded(void) * Compute the size of a resource. * * @param res the resource to operate on - * @return the size of the resource + * Return: the size of the resource */ static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res) { @@ -241,7 +241,7 @@ struct fdtdec_phandle_args { * @cells_count: Cell count to use if @cells_name is NULL * @index: index of a phandle to parse out * @out_args: optional pointer to output arguments structure (will be filled) - * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if + * Return: 0 on success (with @out_args filled out if not NULL), -ENOENT if * @list_name does not exist, a phandle was not found, @cells_name * could not be found, the arguments were truncated or there were too * many arguments. @@ -268,7 +268,7 @@ int fdtdec_parse_phandle_with_args(const void *blob, int src_node, * @param blob FDT blob to use * @param name Root name of alias to search for * @param id Compatible ID to look for - * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more + * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more */ int fdtdec_next_alias(const void *blob, const char *name, enum fdt_compat_id id, int *upto); @@ -282,7 +282,7 @@ int fdtdec_next_alias(const void *blob, const char *name, * * @param blob FDT blob to use * @param node Node containing compatible string to find - * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match + * Return: compatible ID, or COMPAT_UNKNOWN if we cannot find a match */ enum fdt_compat_id fdtdec_lookup(const void *blob, int node); @@ -296,7 +296,7 @@ enum fdt_compat_id fdtdec_lookup(const void *blob, int node); * @param blob FDT blob to use * @param node Start node for search * @param id Compatible ID to look for (enum fdt_compat_id) - * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more + * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more */ int fdtdec_next_compatible(const void *blob, int node, enum fdt_compat_id id); @@ -313,7 +313,7 @@ int fdtdec_next_compatible(const void *blob, int node, * @param node Start node for search * @param id Compatible ID to look for (enum fdt_compat_id) * @param depthp Current depth (set to 0 before first call) - * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more + * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more */ int fdtdec_next_compatible_subnode(const void *blob, int node, enum fdt_compat_id id, int *depthp); @@ -339,7 +339,7 @@ int fdtdec_next_compatible_subnode(const void *blob, int node, * @param sizep a pointer to store the size into. Use NULL if not required * @param translate Indicates whether to translate the returned value * using the parent node's ranges property. - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node, const char *prop_name, int index, int na, int ns, @@ -361,7 +361,7 @@ fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node, * @param sizep a pointer to store the size into. Use NULL if not required * @param translate Indicates whether to translate the returned value * using the parent node's ranges property. - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent, int node, const char *prop_name, int index, fdt_size_t *sizep, @@ -387,7 +387,7 @@ fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent, * @param sizep a pointer to store the size into. Use NULL if not required * @param translate Indicates whether to translate the returned value * using the parent node's ranges property. - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node, const char *prop_name, int index, fdt_size_t *sizep, @@ -414,7 +414,7 @@ fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node, * @param blob FDT blob * @param node node to examine * @param prop_name name of property to find - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr(const void *blob, int node, const char *prop_name); @@ -442,7 +442,7 @@ fdt_addr_t fdtdec_get_addr(const void *blob, int node, * @param node node to examine * @param prop_name name of property to find * @param sizep a pointer to store the size into. Use NULL if not required - * @return address, if found, or FDT_ADDR_T_NONE if not + * Return: address, if found, or FDT_ADDR_T_NONE if not */ fdt_addr_t fdtdec_get_addr_size(const void *blob, int node, const char *prop_name, fdt_size_t *sizep); @@ -455,7 +455,7 @@ fdt_addr_t fdtdec_get_addr_size(const void *blob, int node, * @param node node to examine * @param vendor vendor id of the pci device * @param device device id of the pci device - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device); @@ -467,7 +467,7 @@ int fdtdec_get_pci_vendev(const void *blob, int node, * @param dev device to examine * @param addr pci address in the form of fdt_pci_addr * @param bar returns base address of the pci device's registers - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdtdec_get_pci_bar32(const struct udevice *dev, struct fdt_pci_addr *addr, u32 *bar); @@ -479,7 +479,7 @@ int fdtdec_get_pci_bar32(const struct udevice *dev, struct fdt_pci_addr *addr, * @param blob FDT blob * @param node node to examine * @param res the resource structure to return the bus range - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdtdec_get_pci_bus_range(const void *blob, int node, @@ -494,7 +494,7 @@ int fdtdec_get_pci_bus_range(const void *blob, int node, * @param node node to examine * @param prop_name name of property to find * @param default_val default value to return if the property is not found - * @return integer value, if found, or default_val if not + * Return: integer value, if found, or default_val if not */ s32 fdtdec_get_int(const void *blob, int node, const char *prop_name, s32 default_val); @@ -507,7 +507,7 @@ s32 fdtdec_get_int(const void *blob, int node, const char *prop_name, * @param node node to examine * @param prop_name name of property to find * @param default_val default value to return if the property is not found - * @return unsigned integer value, if found, or default_val if not + * Return: unsigned integer value, if found, or default_val if not */ unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name, unsigned int default_val); @@ -519,7 +519,7 @@ unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name, * * @param ptr Pointer to property * @param cells Number of cells containing the number - * @return the value in the cells + * Return: the value in the cells */ u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells); @@ -533,7 +533,7 @@ u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells); * @param node node to examine * @param prop_name name of property to find * @param default_val default value to return if the property is not found - * @return integer value, if found, or default_val if not + * Return: integer value, if found, or default_val if not */ uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name, uint64_t default_val); @@ -547,7 +547,7 @@ uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name, * * @param blob FDT blob * @param node node to examine - * @return integer value 0 (not enabled) or 1 (enabled) + * Return: integer value 0 (not enabled) or 1 (enabled) */ int fdtdec_get_is_enabled(const void *blob, int node); @@ -556,7 +556,7 @@ int fdtdec_get_is_enabled(const void *blob, int node); * * If not, a message is printed to the console if the console is ready. * - * @return 0 if all ok, -1 if not + * Return: 0 if all ok, -1 if not */ int fdtdec_prepare_fdt(void); @@ -604,7 +604,7 @@ int fdtdec_check_fdt(void); * @param id Compatible ID to look for * @param node_list Place to put list of found nodes * @param maxcount Maximum number of nodes to find - * @return number of nodes found on success, FDT_ERR_... on error + * Return: number of nodes found on success, FDT_ERR_... on error */ int fdtdec_find_aliases_for_id(const void *blob, const char *name, enum fdt_compat_id id, int *node_list, int maxcount); @@ -645,7 +645,7 @@ int fdtdec_add_aliases_for_id(const void *blob, const char *name, * @param node Node to look up * @param seqp This is set to the sequence number if one is found, * but otherwise the value is left alone - * @return 0 if a sequence was found, -ve if not + * Return: 0 if a sequence was found, -ve if not */ int fdtdec_get_alias_seq(const void *blob, const char *base, int node, int *seqp); @@ -659,7 +659,7 @@ int fdtdec_get_alias_seq(const void *blob, const char *base, int node, * @param blob Device tree blob (if NULL, then error is returned) * @param base Base name for alias susbystem (before the number) * - * @return 0 highest alias ID, -1 if not found + * Return: 0 highest alias ID, -1 if not found */ int fdtdec_get_alias_highest_id(const void *blob, const char *base); @@ -668,7 +668,7 @@ int fdtdec_get_alias_highest_id(const void *blob, const char *base); * * @param blob Device tree blob (if NULL, then NULL is returned) * @param name Property name to look up - * @return Value of property, or NULL if it does not exist + * Return: Value of property, or NULL if it does not exist */ const char *fdtdec_get_chosen_prop(const void *blob, const char *name); @@ -680,7 +680,7 @@ const char *fdtdec_get_chosen_prop(const void *blob, const char *name); * * @param blob Device tree blob (if NULL, then error is returned) * @param name Property name, e.g. "stdout-path" - * @return Node offset referred to by that chosen node, or -ve FDT_ERR_... + * Return: Node offset referred to by that chosen node, or -ve FDT_ERR_... */ int fdtdec_get_chosen_node(const void *blob, const char *name); @@ -688,7 +688,7 @@ int fdtdec_get_chosen_node(const void *blob, const char *name); * Get the name for a compatible ID * * @param id Compatible ID to look for - * @return compatible string for that id + * Return: compatible string for that id */ const char *fdtdec_get_compatible(enum fdt_compat_id id); @@ -698,7 +698,7 @@ const char *fdtdec_get_compatible(enum fdt_compat_id id); * @param blob FDT blob * @param node node to examine * @param prop_name name of property to find - * @return node offset if found, -ve error code on error + * Return: node offset if found, -ve error code on error */ int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name); @@ -712,7 +712,7 @@ int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name); * @param prop_name name of property to find * @param array array to fill with data * @param count number of array elements - * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, + * Return: 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, * or -FDT_ERR_BADLAYOUT if not enough data */ int fdtdec_get_int_array(const void *blob, int node, const char *prop_name, @@ -728,7 +728,7 @@ int fdtdec_get_int_array(const void *blob, int node, const char *prop_name, * @param prop_name name of property to find * @param array array to fill with data * @param count number of array elements - * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the + * Return: number of array elements if ok, or -FDT_ERR_NOTFOUND if the * property is not found */ int fdtdec_get_int_array_count(const void *blob, int node, @@ -747,7 +747,7 @@ int fdtdec_get_int_array_count(const void *blob, int node, * @param node node to examine * @param prop_name name of property to find * @param count number of array elements - * @return pointer to array if found, or NULL if the property is not + * Return: pointer to array if found, or NULL if the property is not * found or there is not enough data */ const u32 *fdtdec_locate_array(const void *blob, int node, @@ -762,7 +762,7 @@ const u32 *fdtdec_locate_array(const void *blob, int node, * @param blob FDT blob * @param node node to examine * @param prop_name name of property to find - * @return 1 if the properly is present; 0 if it isn't present + * Return: 1 if the properly is present; 0 if it isn't present */ int fdtdec_get_bool(const void *blob, int node, const char *prop_name); @@ -771,7 +771,7 @@ int fdtdec_get_bool(const void *blob, int node, const char *prop_name); * * @param blob FDT blob * @param node parent node - * @return number of child node; 0 if there is not child node + * Return: number of child node; 0 if there is not child node */ int fdtdec_get_child_count(const void *blob, int node); @@ -785,7 +785,7 @@ int fdtdec_get_child_count(const void *blob, int node); * @param prop_name name of property to find * @param array array to fill with data * @param count number of array elements - * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found, + * Return: 0 if ok, or -FDT_ERR_MISSING if the property is not found, * or -FDT_ERR_BADLAYOUT if not enough data */ int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name, @@ -801,7 +801,7 @@ int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name, * @param node node to examine * @param prop_name name of property to find * @param count number of array elements - * @return pointer to byte array if found, or NULL if the property is not + * Return: pointer to byte array if found, or NULL if the property is not * found or there is not enough data */ const u8 *fdtdec_locate_byte_array(const void *blob, int node, @@ -815,7 +815,7 @@ const u8 *fdtdec_locate_byte_array(const void *blob, int node, * @param property name of the property to parse * @param index index of the resource to retrieve * @param res returns the resource - * @return 0 if ok, negative on error + * Return: 0 if ok, negative on error */ int fdt_get_resource(const void *fdt, int node, const char *property, unsigned int index, struct fdt_resource *res); @@ -911,7 +911,7 @@ struct display_timing { * @param node 'display-timing' node containing the timing subnodes * @param index Index number to read (0=first timing subnode) * @param config Place to put timings - * @return 0 if OK, -FDT_ERR_NOTFOUND if not found + * Return: 0 if OK, -FDT_ERR_NOTFOUND if not found */ int fdtdec_decode_display_timing(const void *blob, int node, int index, struct display_timing *config); @@ -929,7 +929,7 @@ int fdtdec_decode_display_timing(const void *blob, int node, int index, * address instead of hard coding the value in the case where the memory size * and start address cannot be detected automatically. * - * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or + * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or * invalid */ int fdtdec_setup_mem_size_base(void); @@ -946,7 +946,7 @@ int fdtdec_setup_mem_size_base(void); * address instead of hard coding the value in the case where the memory size * and start address cannot be detected automatically. * - * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or + * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or * invalid */ int fdtdec_setup_mem_size_base_lowest(void); @@ -963,7 +963,7 @@ int fdtdec_setup_mem_size_base_lowest(void); * information instead of hard coding the information in cases where it cannot * be detected automatically. * - * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or + * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or * invalid */ int fdtdec_setup_memory_banksize(void); @@ -988,7 +988,7 @@ int fdtdec_setup_memory_banksize(void); * @param fdt FDT blob * @param mac buffer containing the MAC address to set * @param size size of MAC address - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size); @@ -999,7 +999,7 @@ int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size); * @param node offset in the FDT blob of the node whose phandle is to * be set * @param phandle phandle to set for the given node - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ static inline int fdtdec_set_phandle(void *blob, int node, uint32_t phandle) { @@ -1058,7 +1058,7 @@ static inline int fdtdec_set_phandle(void *blob, int node, uint32_t phandle) * @param phandlep return location for the phandle of the carveout region * can be NULL if no phandle should be added * @param flags bitmask of flags to set for the carveout region - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_add_reserved_memory(void *blob, const char *basename, const struct fdt_memory *carveout, @@ -1082,7 +1082,7 @@ int fdtdec_add_reserved_memory(void *blob, const char *basename, * @param compatiblesp return location for compatible strings * @param countp return location for the number of compatible strings * @param flags return location for the flags of the carveout - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_get_carveout(const void *blob, const char *node, const char *prop_name, unsigned int index, @@ -1149,7 +1149,7 @@ int fdtdec_get_carveout(const void *blob, const char *node, * @param compatibles compatible strings to set for the carveout * @param count number of compatible strings * @param flags bitmask of flags to set for the carveout - * @return 0 on success or a negative error code on failure + * Return: 0 on success or a negative error code on failure */ int fdtdec_set_carveout(void *blob, const char *node, const char *prop_name, unsigned int index, const struct fdt_memory *carveout, @@ -1182,7 +1182,7 @@ int fdtdec_board_setup(const void *fdt_blob); * @param rescan Returns a flag indicating that fdt has changed and rescanning * the fdt is required * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fdtdec_resetup(int *rescan); #endif @@ -1228,7 +1228,7 @@ void *board_fdt_blob_setup(int *err); * ignore) * @param sizep Returns total memory size (NULL to ignore) * @param bd Updated with the memory bank information (NULL to skip) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id, phys_addr_t *basep, phys_size_t *sizep, @@ -1237,7 +1237,7 @@ int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id, /** * fdtdec_get_srcname() - Get the name of where the devicetree comes from * - * @return source name + * Return: source name */ const char *fdtdec_get_srcname(void); diff --git a/include/fs.h b/include/fs.h index 1c79e299fd..c8df3886ac 100644 --- a/include/fs.h +++ b/include/fs.h @@ -27,7 +27,7 @@ struct blk_desc; * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_fat_fsload(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -39,7 +39,7 @@ int do_fat_fsload(struct cmd_tbl *cmdtp, int flag, int argc, * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_ext2load(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -118,7 +118,7 @@ int fs_exists(const char *filename); * * @filename: Name of the file * @size: Size of file - * @return 0 if ok with valid *size, negative on error + * Return: 0 if ok with valid *size, negative on error */ int fs_size(const char *filename, loff_t *size); @@ -195,7 +195,7 @@ struct fs_dir_stream { * fs_opendir - Open a directory * * @filename: the path to directory to open - * @return a pointer to the directory stream or NULL on error and errno + * Return: a pointer to the directory stream or NULL on error and errno * set appropriately */ struct fs_dir_stream *fs_opendir(const char *filename); @@ -209,7 +209,7 @@ struct fs_dir_stream *fs_opendir(const char *filename); * longer valid. * * @dirs: the directory stream - * @return the next directory entry (only valid until next fs_readdir() or + * Return: the next directory entry (only valid until next fs_readdir() or * fs_closedir() call, do not attempt to free()) or NULL if the end of * the directory is reached. */ @@ -228,7 +228,7 @@ void fs_closedir(struct fs_dir_stream *dirs); * If a given name is a directory, it will be deleted only if it's empty * * @filename: Name of file or directory to delete - * @return 0 on success, -1 on error conditions + * Return: 0 on success, -1 on error conditions */ int fs_unlink(const char *filename); @@ -236,7 +236,7 @@ int fs_unlink(const char *filename); * fs_mkdir - Create a directory * * @filename: Name of directory to create - * @return 0 on success, -1 on error conditions + * Return: 0 on success, -1 on error conditions */ int fs_mkdir(const char *filename); @@ -281,7 +281,7 @@ int do_fs_type(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_fs_types(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[]); diff --git a/include/fsl_ddr_sdram.h b/include/fsl_ddr_sdram.h index 56c9db2594..a7272e4be7 100644 --- a/include/fsl_ddr_sdram.h +++ b/include/fsl_ddr_sdram.h @@ -483,7 +483,7 @@ typedef struct fixed_ddr_parm{ /** * fsl_initdram() - Set up the SDRAM * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int fsl_initdram(void); diff --git a/include/generic-phy.h b/include/generic-phy.h index 9a11659640..ff48b37081 100644 --- a/include/generic-phy.h +++ b/include/generic-phy.h @@ -79,7 +79,7 @@ struct phy_ops { * If power_off() is not implemented, it must power down the phy. * * @phy: PHY port to be de-initialized - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*exit)(struct phy *phy); @@ -91,7 +91,7 @@ struct phy_ops { * During runtime, the PHY may need to be reset in order to * re-establish connection etc without being shut down or exit. * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*reset)(struct phy *phy); @@ -105,7 +105,7 @@ struct phy_ops { * setup done in init(). If init() is not implemented, it must take care * of setting up the context (PLLs, ...) * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*power_on)(struct phy *phy); @@ -119,7 +119,7 @@ struct phy_ops { * init()/deinit() are not implemented, it must not de-initialize * everything. * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*power_off)(struct phy *phy); @@ -133,7 +133,7 @@ struct phy_ops { * This function configures the PHY for it's main function following * power_on/off() after beeing initialized. * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int (*configure)(struct phy *phy, void *params); }; @@ -161,7 +161,7 @@ struct phy_bulk { * generic_phy_init() - initialize the PHY port * * @phy: the PHY port to initialize - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_init(struct phy *phy); @@ -169,7 +169,7 @@ int generic_phy_init(struct phy *phy); * generic_phy_init() - de-initialize the PHY device * * @phy: PHY port to be de-initialized - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_exit(struct phy *phy); @@ -177,7 +177,7 @@ int generic_phy_exit(struct phy *phy); * generic_phy_reset() - resets a PHY device without shutting down * * @phy: PHY port to be reset - *@return 0 if OK, or a negative error code + *Return: 0 if OK, or a negative error code */ int generic_phy_reset(struct phy *phy); @@ -185,7 +185,7 @@ int generic_phy_reset(struct phy *phy); * generic_phy_power_on() - power on a PHY device * * @phy: PHY port to be powered on - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_power_on(struct phy *phy); @@ -193,7 +193,7 @@ int generic_phy_power_on(struct phy *phy); * generic_phy_power_off() - power off a PHY device * * @phy: PHY port to be powered off - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_power_off(struct phy *phy); @@ -202,7 +202,7 @@ int generic_phy_power_off(struct phy *phy); * * @phy: PHY port to be configured * @params: PHY Parameters, underlying data is specific to the PHY function - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_configure(struct phy *phy, void *params); @@ -230,7 +230,7 @@ int generic_phy_configure(struct phy *phy, void *params); * the USB2 phy can be accessed by passing index '0' and the USB3 phy can * be accessed by passing index '1' * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_get_by_index(struct udevice *user, int index, struct phy *phy); @@ -261,7 +261,7 @@ int generic_phy_get_by_index(struct udevice *user, int index, * the USB2 phy can be accessed by passing index '0' and the USB3 phy can * be accessed by passing index '1' * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_get_by_index_nodev(ofnode node, int index, struct phy *phy); @@ -288,7 +288,7 @@ int generic_phy_get_by_index_nodev(ofnode node, int index, struct phy *phy); * }; * the USB3 phy can be accessed using "usb3phy", and USB2 by using "usb2phy" * - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int generic_phy_get_by_name(struct udevice *user, const char *phy_name, struct phy *phy); @@ -302,7 +302,7 @@ int generic_phy_get_by_name(struct udevice *user, const char *phy_name, * * @dev: The consumer device. * @bulk A pointer to a phy bulk struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int generic_phy_get_bulk(struct udevice *dev, struct phy_bulk *bulk); @@ -311,7 +311,7 @@ int generic_phy_get_bulk(struct udevice *dev, struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_init_bulk(struct phy_bulk *bulk); @@ -320,7 +320,7 @@ int generic_phy_init_bulk(struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_exit_bulk(struct phy_bulk *bulk); @@ -329,7 +329,7 @@ int generic_phy_exit_bulk(struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_power_on_bulk(struct phy_bulk *bulk); @@ -338,7 +338,7 @@ int generic_phy_power_on_bulk(struct phy_bulk *bulk); * * @bulk: A phy bulk struct that was previously successfully requested * by generic_phy_get_bulk(). - * @return 0 if OK, or negative error code. + * Return: 0 if OK, or negative error code. */ int generic_phy_power_off_bulk(struct phy_bulk *bulk); @@ -413,7 +413,7 @@ static inline int generic_phy_power_off_bulk(struct phy_bulk *bulk) * generic_phy_valid() - check if PHY port is valid * * @phy: the PHY port to check - * @return TRUE if valid, or FALSE + * Return: TRUE if valid, or FALSE */ static inline bool generic_phy_valid(struct phy *phy) { diff --git a/include/gzip.h b/include/gzip.h index cb4db3d70f..e578b283ed 100644 --- a/include/gzip.h +++ b/include/gzip.h @@ -16,7 +16,7 @@ struct blk_desc; * * @src: Pointer to gzip file * @len: Length of data - * @return length of header in bytes, or -1 if not enough data + * Return: length of header in bytes, or -1 if not enough data */ int gzip_parse_header(const unsigned char *src, unsigned long len); @@ -27,7 +27,7 @@ int gzip_parse_header(const unsigned char *src, unsigned long len); * @dstlen: Size of destination buffer * @src: Source data to decompress * @lenp: Returns length of uncompressed data - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp); @@ -40,7 +40,7 @@ int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp); * @lenp: On entry, length data at @src. On exit, number of bytes used from @src * @stoponerr: 0 to continue when a decode error is found, 1 to stop * @offset: start offset within the src buffer - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp, int stoponerr, int offset); @@ -71,7 +71,7 @@ void gzwrite_progress_finish(int retcode, ulong totalwritten, ulong totalsize, * @startoffs: offset in bytes of first write * @szexpected: expected uncompressed length, may be zero to use gzip trailer * for files under 4GiB - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int gzwrite(unsigned char *src, int len, struct blk_desc *dev, ulong szwritebuf, ulong startoffs, ulong szexpected); @@ -84,7 +84,7 @@ int gzwrite(unsigned char *src, int len, struct blk_desc *dev, ulong szwritebuf, * number of bytes used in the buffer * @src: Source data to compress * @srclen: Size of source data - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int gzip(void *dst, unsigned long *lenp, unsigned char *src, ulong srclen); diff --git a/include/handoff.h b/include/handoff.h index 070a79c1b9..0104b834f2 100644 --- a/include/handoff.h +++ b/include/handoff.h @@ -38,7 +38,7 @@ void handoff_load_dram_banks(struct spl_handoff *ho); * write_spl_handoff(). * * @ho: Handoff area to fill in - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int handoff_arch_save(struct spl_handoff *ho); diff --git a/include/hash.h b/include/hash.h index cfafbe7006..8b3f79ec47 100644 --- a/include/hash.h +++ b/include/hash.h @@ -114,7 +114,7 @@ int hash_command(const char *algo_name, int flags, struct cmd_tbl *cmdtp, * If NULL, then it is assumed that the caller has * allocated enough space for the hash. This is possible * since the caller is selecting the algorithm. - * @return 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm, + * Return: 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm, * -ENOSPC if the output buffer is not large enough. */ int hash_block(const char *algo_name, const void *data, unsigned int len, @@ -131,7 +131,7 @@ int hash_block(const char *algo_name, const void *data, unsigned int len, * @algo_name: Hash algorithm to look up * @algop: Pointer to the hash_algo struct if found * - * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. + * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. */ int hash_lookup_algo(const char *algo_name, struct hash_algo **algop); @@ -144,7 +144,7 @@ int hash_lookup_algo(const char *algo_name, struct hash_algo **algop); * @algo_name: Hash algorithm to look up * @algop: Pointer to the hash_algo struct if found * - * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. + * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. */ int hash_progressive_lookup_algo(const char *algo_name, struct hash_algo **algop); @@ -159,7 +159,7 @@ int hash_progressive_lookup_algo(const char *algo_name, * @str: Hash string to get parsed * @result: Binary array of the parsed hash string * - * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. + * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm. */ int hash_parse_string(const char *algo_name, const char *str, uint8_t *result); diff --git a/include/hda_codec.h b/include/hda_codec.h index 56de571f0f..247eafe66e 100644 --- a/include/hda_codec.h +++ b/include/hda_codec.h @@ -27,7 +27,7 @@ struct hda_codec_priv { * hda_wait_for_ready() - Wait for the codec to indicate it is ready * * @regs: HDA registers - * @return 0 if OK -ETIMEDOUT if codec did not respond in time + * Return: 0 if OK -ETIMEDOUT if codec did not respond in time */ int hda_wait_for_ready(struct hda_regs *regs); @@ -35,7 +35,7 @@ int hda_wait_for_ready(struct hda_regs *regs); * hda_wait_for_valid() - Wait for the codec to accept the last command * * @regs: HDA registers - * @return 0 if OK -ETIMEDOUT if codec did not respond in time + * Return: 0 if OK -ETIMEDOUT if codec did not respond in time */ int hda_wait_for_valid(struct hda_regs *regs); @@ -43,8 +43,8 @@ int hda_wait_for_valid(struct hda_regs *regs); * hda_codec_detect() - Detect which codecs are present * * @regs: HDA registers - * @return bit mask of active codecs (0 if none) - * @return 0 if OK, -ve on error + * Return: bit mask of active codecs (0 if none) + * Return: 0 if OK, -ve on error */ int hda_codec_detect(struct hda_regs *regs); @@ -54,7 +54,7 @@ int hda_codec_detect(struct hda_regs *regs); * @dev: Sound device * @regs: HDA registers * @codec_mask: Mask of codecs to init (bits 3:0) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int hda_codecs_init(struct udevice *dev, struct hda_regs *regs, u32 codec_mask); @@ -66,7 +66,7 @@ int hda_codecs_init(struct udevice *dev, struct hda_regs *regs, u32 codec_mask); * * @dev: Sound device * @frequency_hz: Beep frequency in hertz - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int hda_codec_start_beep(struct udevice *dev, int frequency_hz); @@ -76,7 +76,7 @@ int hda_codec_start_beep(struct udevice *dev, int frequency_hz); * This tells the sound hardware to stop a previously started beep. * * @dev: Sound device - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int hda_codec_stop_beep(struct udevice *dev); @@ -86,7 +86,7 @@ int hda_codec_stop_beep(struct udevice *dev); * This should be called at the start of the probe() method. * * @dev: Sound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int hda_codec_init(struct udevice *dev); @@ -96,7 +96,7 @@ int hda_codec_init(struct udevice *dev); * This should be called at the end of the probe() method. * * @dev: Sound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int hda_codec_finish_init(struct udevice *dev); diff --git a/include/hw_sha.h b/include/hw_sha.h index d4f3471c43..b9bb583810 100644 --- a/include/hw_sha.h +++ b/include/hw_sha.h @@ -65,7 +65,7 @@ void hw_sha1(const uchar *in_addr, uint buflen, uchar *out_addr, * * @algo: Pointer to the hash_algo struct * @ctxp: Pointer to the pointer of the context for hashing - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_init(struct hash_algo *algo, void **ctxp); @@ -79,7 +79,7 @@ int hw_sha_init(struct hash_algo *algo, void **ctxp); * @buf: Pointer to the buffer being hashed * @size: Size of the buffer being hashed * @is_last: 1 if this is the last update; 0 otherwise - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_update(struct hash_algo *algo, void *ctx, const void *buf, unsigned int size, int is_last); @@ -93,7 +93,7 @@ int hw_sha_update(struct hash_algo *algo, void *ctx, const void *buf, * @ctx: Pointer to the context for hashing * @dest_buf: Pointer to the destination buffer where hash is to be copied * @size: Size of the buffer being hashed - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_finish(struct hash_algo *algo, void *ctx, void *dest_buf, int size); diff --git a/include/hwspinlock.h b/include/hwspinlock.h index 99389c13c2..d8556c0b4b 100644 --- a/include/hwspinlock.h +++ b/include/hwspinlock.h @@ -39,7 +39,7 @@ struct hwspinlock { * @index: The index of the hardware spinlock to request, within the * client's list of hardware spinlock. * @hws: A pointer to a hardware spinlock struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int hwspinlock_get_by_index(struct udevice *dev, int index, struct hwspinlock *hws); diff --git a/include/i2c.h b/include/i2c.h index a35e99bf87..22add0b528 100644 --- a/include/i2c.h +++ b/include/i2c.h @@ -184,7 +184,7 @@ struct i2c_msg_list { * @buffer: Place to put data * @len: Number of bytes to read * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); @@ -198,7 +198,7 @@ int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len); * @buffer: Buffer containing data to write * @len: Number of bytes to write * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, int len); @@ -214,7 +214,7 @@ int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer, * @chip_addr: 7-bit address to probe (10-bit and others are not supported) * @chip_flags: Flags for the probe (see enum dm_i2c_chip_flags) * @devp: Returns the device found, or NULL if none - * @return 0 if a chip was found at that address, -ve if not + * Return: 0 if a chip was found at that address, -ve if not */ int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, struct udevice **devp); @@ -226,7 +226,7 @@ int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags, * * @dev: Device to use for transfer * @addr: Address to read from - * @return value read, or -ve on error + * Return: value read, or -ve on error */ int dm_i2c_reg_read(struct udevice *dev, uint offset); @@ -238,7 +238,7 @@ int dm_i2c_reg_read(struct udevice *dev, uint offset); * @dev: Device to use for transfer * @addr: Address to write to * @val: Value to write (normally a byte) - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val); @@ -252,7 +252,7 @@ int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val); * @offset: Address for the R/W operation * @clr: Bitmask of bits that should be cleared * @set: Bitmask of bits that should be set - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set); @@ -265,7 +265,7 @@ int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set); * @dev: Device to use for transfer * @msg: List of messages to transfer * @nmsgs: Number of messages to transfer - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs); @@ -274,7 +274,7 @@ int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs); * * @bus: Bus to adjust * @speed: Requested speed in Hz - * @return 0 if OK, -EINVAL for invalid values + * Return: 0 if OK, -EINVAL for invalid values */ int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); @@ -282,7 +282,7 @@ int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed); * dm_i2c_get_bus_speed() - get the speed of a bus * * @bus: Bus to check - * @return speed of selected I2C bus in Hz, -ve on error + * Return: speed of selected I2C bus in Hz, -ve on error */ int dm_i2c_get_bus_speed(struct udevice *bus); @@ -294,7 +294,7 @@ int dm_i2c_get_bus_speed(struct udevice *bus); * * @dev: Chip to adjust * @flags: New flags - * @return 0 if OK, -EINVAL if value is unsupported, other -ve value on error + * Return: 0 if OK, -EINVAL if value is unsupported, other -ve value on error */ int i2c_set_chip_flags(struct udevice *dev, uint flags); @@ -303,7 +303,7 @@ int i2c_set_chip_flags(struct udevice *dev, uint flags); * * @dev: Chip to check * @flagsp: Place to put flags - * @return 0 if OK, other -ve value on error + * Return: 0 if OK, other -ve value on error */ int i2c_get_chip_flags(struct udevice *dev, uint *flagsp); @@ -334,14 +334,14 @@ int i2c_get_chip_offset_len(struct udevice *dev); * function to set the bits that are valid to be used for offset overflow. * * @mask: The mask to be used for high offset bits within address - * @return 0 if OK, other -ve value on error + * Return: 0 if OK, other -ve value on error */ int i2c_set_chip_addr_offset_mask(struct udevice *dev, uint mask); /* * i2c_get_chip_addr_offset_mask() - get mask of address bits usable by offset * - * @return current chip addr offset mask + * Return: current chip addr offset mask */ uint i2c_get_chip_addr_offset_mask(struct udevice *dev); @@ -351,7 +351,7 @@ uint i2c_get_chip_addr_offset_mask(struct udevice *dev); * See the deblock() method in 'struct dm_i2c_ops' for full information * * @bus: Bus to recover - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int i2c_deblock(struct udevice *bus); @@ -366,7 +366,7 @@ int i2c_deblock(struct udevice *bus); * @scl_count: Number of SCL clock cycles generated to deblock SDA * @start_count:Number of I2C start conditions sent after deblocking SDA * @delay: Delay between SCL clock line changes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ struct gpio_desc; int i2c_deblock_gpio_loop(struct gpio_desc *sda_pin, struct gpio_desc *scl_pin, @@ -567,7 +567,7 @@ void i2c_dump_msgs(struct i2c_msg *msg, int nmsgs); * * @dev: Device to find an emulator for * @emulp: Returns the associated emulator, if found * - * @return 0 if OK, -ENOENT or -ENODEV if not found + * Return: 0 if OK, -ENOENT or -ENODEV if not found */ int i2c_emul_find(struct udevice *dev, struct udevice **emulp); @@ -589,7 +589,7 @@ void i2c_emul_set_idx(struct udevice *dev, int emul_idx); * Given an emulator this returns the associated device * * @emul: Emulator for the device - * @return device that @emul is emulating + * Return: device that @emul is emulating */ struct udevice *i2c_emul_get_device(struct udevice *emul); @@ -606,7 +606,7 @@ extern struct acpi_ops i2c_acpi_ops; * properties. * * @dev: I2C device to process - * @return 0 if OK, -EINVAL if acpi,hid is not present + * Return: 0 if OK, -EINVAL if acpi,hid is not present */ int acpi_i2c_of_to_plat(struct udevice *dev); @@ -967,7 +967,7 @@ enum { * Get FDT values for i2c bus. * * @param blob Device tree blbo - * @return the number of I2C bus + * Return: the number of I2C bus */ void board_i2c_init(const void *blob); @@ -976,7 +976,7 @@ void board_i2c_init(const void *blob); * * @param blob Device tree blbo * @param node FDT I2C node to find - * @return the number of I2C bus (zero based), or -1 on error + * Return: the number of I2C bus (zero based), or -1 on error */ int i2c_get_bus_num_fdt(int node); @@ -985,7 +985,7 @@ int i2c_get_bus_num_fdt(int node); * * @param blob Device tree blbo * @param node FDT I2C node to find - * @return 0 if port was reset, -1 if not found + * Return: 0 if port was reset, -1 if not found */ int i2c_reset_port_fdt(const void *blob, int node); diff --git a/include/i2c_eeprom.h b/include/i2c_eeprom.h index cd620d519f..3ad565684f 100644 --- a/include/i2c_eeprom.h +++ b/include/i2c_eeprom.h @@ -28,7 +28,7 @@ struct i2c_eeprom { * @buf: Place to put data * @size: Number of bytes to read * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int i2c_eeprom_read(struct udevice *dev, int offset, uint8_t *buf, int size); @@ -40,7 +40,7 @@ int i2c_eeprom_read(struct udevice *dev, int offset, uint8_t *buf, int size); * @buf: Buffer containing data to write * @size: Number of bytes to write * - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ int i2c_eeprom_write(struct udevice *dev, int offset, uint8_t *buf, int size); @@ -49,7 +49,7 @@ int i2c_eeprom_write(struct udevice *dev, int offset, uint8_t *buf, int size); * * @dev: Chip to query * - * @return +ve size in bytes on success, -ve on failure + * Return: +ve size in bytes on success, -ve on failure */ int i2c_eeprom_size(struct udevice *dev); diff --git a/include/i2s.h b/include/i2s.h index 7760aab7c4..c9fbeb5d8a 100644 --- a/include/i2s.h +++ b/include/i2s.h @@ -108,7 +108,7 @@ struct i2s_ops { * @dev: I2C device * @data: Data buffer to play * @data_size: Size of data buffer in bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int i2s_tx_data(struct udevice *dev, void *data, uint data_size); @@ -118,7 +118,7 @@ int i2s_tx_data(struct udevice *dev, void *data, uint data_size); * @param pi2s_tx pointer of i2s transmitter parameter structure. * @param data address of the data buffer * @param data_size size of the data (in bytes) - * @return int value 0 for success, -1 in case of error + * Return: int value 0 for success, -1 in case of error */ int i2s_transfer_tx_data(struct i2s_uc_priv *pi2s_tx, void *data, uint data_size); diff --git a/include/ide.h b/include/ide.h index 1b37d67992..60739436e9 100644 --- a/include/ide.h +++ b/include/ide.h @@ -64,7 +64,7 @@ void ide_led(uchar led, uchar status); /** * board_start_ide() - Start up the board IDE interfac * - * @return 0 if ok + * Return: 0 if ok */ int board_start_ide(void); diff --git a/include/image.h b/include/image.h index fd662e74b4..1cdc70faee 100644 --- a/include/image.h +++ b/include/image.h @@ -422,7 +422,7 @@ const char *genimg_get_os_name(uint8_t os); * genimg_get_os_short_name() - get the short name for an OS * * @param os OS (IH_OS_...) - * @return OS short name, or "unknown" if unknown + * Return: OS short name, or "unknown" if unknown */ const char *genimg_get_os_short_name(uint8_t comp); @@ -432,7 +432,7 @@ const char *genimg_get_arch_name(uint8_t arch); * genimg_get_arch_short_name() - get the short name for an architecture * * @param arch Architecture type (IH_ARCH_...) - * @return architecture short name, or "unknown" if unknown + * Return: architecture short name, or "unknown" if unknown */ const char *genimg_get_arch_short_name(uint8_t arch); @@ -442,7 +442,7 @@ const char *genimg_get_type_name(uint8_t type); * genimg_get_type_short_name() - get the short name for an image type * * @param type Image type (IH_TYPE_...) - * @return image short name, or "unknown" if unknown + * Return: image short name, or "unknown" if unknown */ const char *genimg_get_type_short_name(uint8_t type); @@ -452,7 +452,7 @@ const char *genimg_get_comp_name(uint8_t comp); * genimg_get_comp_short_name() - get the short name for a compression method * * @param comp compression method (IH_COMP_...) - * @return compression method short name, or "unknown" if unknown + * Return: compression method short name, or "unknown" if unknown */ const char *genimg_get_comp_short_name(uint8_t comp); @@ -461,7 +461,7 @@ const char *genimg_get_comp_short_name(uint8_t comp); * * @category: Category of item * @id: Item ID - * @return name of item, or "Unknown ..." if unknown + * Return: name of item, or "Unknown ..." if unknown */ const char *genimg_get_cat_name(enum ih_category category, uint id); @@ -470,7 +470,7 @@ const char *genimg_get_cat_name(enum ih_category category, uint id); * * @category: Category of item * @id: Item ID - * @return short name of item, or "Unknown ..." if unknown + * Return: short name of item, or "Unknown ..." if unknown */ const char *genimg_get_cat_short_name(enum ih_category category, uint id); @@ -478,7 +478,7 @@ const char *genimg_get_cat_short_name(enum ih_category category, uint id); * genimg_get_cat_count() - Get the number of items in a category * * @category: Category to check - * @return the number of items in the category (IH_xxx_COUNT) + * Return: the number of items in the category (IH_xxx_COUNT) */ int genimg_get_cat_count(enum ih_category category); @@ -486,7 +486,7 @@ int genimg_get_cat_count(enum ih_category category); * genimg_get_cat_desc() - Get the description of a category * * @category: Category to check - * @return the description of a category, e.g. "architecture". This + * Return: the description of a category, e.g. "architecture". This * effectively converts the enum to a string. */ const char *genimg_get_cat_desc(enum ih_category category); @@ -496,7 +496,7 @@ const char *genimg_get_cat_desc(enum ih_category category); * * @category: Category to check * @id: Item ID - * @return true or false as to whether a category has an item + * Return: true or false as to whether a category has an item */ bool genimg_cat_has_id(enum ih_category category, uint id); @@ -588,7 +588,7 @@ int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch, * @param datap Returns address of loaded image * @param lenp Returns length of loaded image * - * @return node offset of base image, or -ve error code on error + * Return: node offset of base image, or -ve error code on error */ int boot_get_fdt_fit(bootm_headers_t *images, ulong addr, const char **fit_unamep, const char **fit_uname_configp, @@ -622,7 +622,7 @@ int boot_get_fdt_fit(bootm_headers_t *images, ulong addr, * @param load_op Decribes what to do with the load address * @param datap Returns address of loaded image * @param lenp Returns length of loaded image - * @return node offset of image, or -ve error code on error + * Return: node offset of image, or -ve error code on error */ int fit_image_load(bootm_headers_t *images, ulong addr, const char **fit_unamep, const char **fit_uname_configp, @@ -637,7 +637,7 @@ int fit_image_load(bootm_headers_t *images, ulong addr, * * @addr: Address of script * @fit_uname: FIT subimage name - * @return result code (enum command_ret_t) + * Return: result code (enum command_ret_t) */ int image_source_script(ulong addr, const char *fit_uname); @@ -827,7 +827,7 @@ static inline int image_check_target_arch(const image_header_t *hdr) * * @buf: Address in U-Boot memory where image is loaded. * @len: Length of the compressed image. - * @return compression type or IH_COMP_NONE if not compressed. + * Return: compression type or IH_COMP_NONE if not compressed. * * Note: Only following compression types are supported now. * lzo, lzma, gzip, bzip2 @@ -845,7 +845,7 @@ int image_decomp_type(const unsigned char *buf, ulong len); * @image_buf: Address to decompress from * @image_len: Number of bytes in @image_buf to decompress * @unc_len: Available space for decompression - * @return 0 if OK, -ve on error (BOOTM_ERR_...) + * Return: 0 if OK, -ve on error (BOOTM_ERR_...) */ int image_decomp(int comp, ulong load, ulong image_start, int type, void *load_buf, void *image_buf, ulong image_len, @@ -860,7 +860,7 @@ int image_decomp(int comp, ulong load, ulong image_start, int type, * @blob: FDT to update * @of_size: Size of the FDT * @lmb: Points to logical memory block structure - * @return 0 if ok, <0 on failure + * Return: 0 if ok, <0 on failure */ int image_setup_libfdt(bootm_headers_t *images, void *blob, int of_size, struct lmb *lmb); @@ -872,7 +872,7 @@ int image_setup_libfdt(bootm_headers_t *images, void *blob, * paramters to the FDT if libfdt is available. * * @param images Images information - * @return 0 if ok, <0 on failure + * Return: 0 if ok, <0 on failure */ int image_setup_linux(bootm_headers_t *images); @@ -882,7 +882,7 @@ int image_setup_linux(bootm_headers_t *images); * @image: Address of image * @start: Returns start address of image * @end : Returns end address of image - * @return 0 if OK, 1 if the image was not recognised + * Return: 0 if OK, 1 if the image was not recognised */ int bootz_setup(ulong image, ulong *start, ulong *end); @@ -893,7 +893,7 @@ int bootz_setup(ulong image, ulong *start, ulong *end); * @start: Returns start address of image * @size : Returns size image * @force_reloc: Ignore image->ep field, always place image to RAM start - * @return 0 if OK, 1 if the image was not recognised + * Return: 0 if OK, 1 if the image was not recognised */ int booti_setup(ulong image, ulong *relocated_addr, ulong *size, bool force_reloc); @@ -1068,7 +1068,7 @@ int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); * sure that there are no strange tags or broken nodes in the FIT. * * @fit: pointer to the FIT format image header - * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check + * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check * failed (e.g. due to bad structure), -ENOMSG if the description is * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images * path is missing @@ -1269,7 +1269,7 @@ ll_entry_declare(struct padding_algo, __name, paddings) * image_get_checksum_algo() - Look up a checksum algorithm * * @param full_name Name of algorithm in the form "checksum,crypto" - * @return pointer to algorithm information, or NULL if not found + * Return: pointer to algorithm information, or NULL if not found */ struct checksum_algo *image_get_checksum_algo(const char *full_name); @@ -1277,7 +1277,7 @@ struct checksum_algo *image_get_checksum_algo(const char *full_name); * image_get_crypto_algo() - Look up a cryptosystem algorithm * * @param full_name Name of algorithm in the form "checksum,crypto" - * @return pointer to algorithm information, or NULL if not found + * Return: pointer to algorithm information, or NULL if not found */ struct crypto_algo *image_get_crypto_algo(const char *full_name); @@ -1285,7 +1285,7 @@ struct crypto_algo *image_get_crypto_algo(const char *full_name); * image_get_padding_algo() - Look up a padding algorithm * * @param name Name of padding algorithm - * @return pointer to algorithm information, or NULL if not found + * Return: pointer to algorithm information, or NULL if not found */ struct padding_algo *image_get_padding_algo(const char *name); @@ -1301,7 +1301,7 @@ struct padding_algo *image_get_padding_algo(const char *name); * therefore nothing was checked. The caller may wish * to fall back to other mechanisms, or refuse to * boot. - * @return 0 if all verified ok, <0 on error + * Return: 0 if all verified ok, <0 on error */ int fit_image_verify_required_sigs(const void *fit, int image_noffset, const char *data, size_t size, const void *sig_blob, @@ -1320,7 +1320,7 @@ int fit_image_verify_required_sigs(const void *fit, int image_noffset, * -1 then any signature will do. * @err_msgp: In the event of an error, this will be pointed to a * help error string to display to the user. - * @return 0 if all verified ok, <0 on error + * Return: 0 if all verified ok, <0 on error */ int fit_image_check_sig(const void *fit, int noffset, const void *data, size_t size, int required_keynode, char **err_msgp); @@ -1341,7 +1341,7 @@ int fit_image_decrypt_data(const void *fit, * @fdt_regions: Regions as returned by libfdt * @count: Number of regions returned by libfdt * @region: Place to put list of regions (NULL to allocate it) - * @return pointer to list of regions, or NULL if out of memory + * Return: pointer to list of regions, or NULL if out of memory */ struct image_region *fit_region_make_list(const void *fit, struct fdt_region *fdt_regions, int count, @@ -1440,7 +1440,7 @@ bool android_image_print_dtb_contents(ulong hdr_addr); * in each (FDT) image node. * * @name: Device tree description - * @return 0 if this device tree should be used, non-zero to try the next + * Return: 0 if this device tree should be used, non-zero to try the next */ int board_fit_config_name_match(const char *name); @@ -1457,7 +1457,7 @@ int board_fit_config_name_match(const char *name); * @node: offset of image node * @image: pointer to the image start pointer * @size: pointer to the image size - * @return no return value (failure should be handled internally) + * Return: no return value (failure should be handled internally) */ void board_fit_image_post_process(const void *fit, int node, void **p_image, size_t *p_size); @@ -1476,7 +1476,7 @@ ulong fdt_getprop_u32(const void *fdt, int node, const char *prop); * the node described by the default configuration if it exists. * * @fdt: pointer to flat device tree - * @return the node if found, -ve otherwise + * Return: the node if found, -ve otherwise */ int fit_find_config_node(const void *fdt); diff --git a/include/input.h b/include/input.h index 3285a3ffa2..e99dbb0d33 100644 --- a/include/input.h +++ b/include/input.h @@ -71,7 +71,7 @@ struct stdio_dev; * @param config Input state * @param keycode List of key codes to examine * @param num_keycodes Number of key codes - * @return number of ascii characters sent, or 0 if none, or -1 for an + * Return: number of ascii characters sent, or 0 if none, or -1 for an * internal error */ int input_send_keycodes(struct input_config *config, int keycode[], int count); @@ -90,7 +90,7 @@ int input_send_keycodes(struct input_config *config, int keycode[], int count); * @param config Input state * @param new_keycode New keycode to add/remove * @param release true if this key was released, false if depressed - * @return number of ascii characters sent, or 0 if none, or -1 for an + * Return: number of ascii characters sent, or 0 if none, or -1 for an * internal error */ int input_add_keycode(struct input_config *config, int new_keycode, @@ -112,7 +112,7 @@ int input_add_table(struct input_config *config, int left_keycode, * Test if keys are available to be read * * @param config Input state - * @return 0 if no keys available, 1 if keys are available + * Return: 0 if no keys available, 1 if keys are available */ int input_tstc(struct input_config *config); @@ -122,7 +122,7 @@ int input_tstc(struct input_config *config); * TODO: U-Boot wants 0 for no key, but Ctrl-@ is a valid key... * * @param config Input state - * @return key, or 0 if no key, or -1 if error + * Return: key, or 0 if no key, or -1 if error */ int input_getc(struct input_config *config); @@ -130,7 +130,7 @@ int input_getc(struct input_config *config); * Register a new device with stdio and switch to it if wanted * * @param dev Pointer to device - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int input_stdio_register(struct stdio_dev *dev); @@ -168,7 +168,7 @@ void input_allow_repeats(struct input_config *config, bool allow_repeats); * updating. * * @param config Input state - * @return -1 if no LEDs need updating, other value if they do + * Return: -1 if no LEDs need updating, other value if they do */ int input_leds_changed(struct input_config *config); @@ -179,7 +179,7 @@ int input_leds_changed(struct input_config *config); * * @param config Input state * @param german true to use German keyboard layout, false for US - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int input_add_tables(struct input_config *config, bool german); @@ -188,7 +188,7 @@ int input_add_tables(struct input_config *config, bool german); * * @param config Input state * @param leds Initial LED value (INPUT_LED_ mask), 0 suggested - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int input_init(struct input_config *config, int leds); diff --git a/include/iotrace.h b/include/iotrace.h index 380da1fbc2..7ff2e8332b 100644 --- a/include/iotrace.h +++ b/include/iotrace.h @@ -81,7 +81,7 @@ void iotrace_reset_checksum(void); /** * iotrace_get_checksum() - Get the current checksum value * - * @return currect checksum value + * Return: currect checksum value */ u32 iotrace_get_checksum(void); @@ -122,7 +122,7 @@ void iotrace_set_enabled(int enable); /** * iotrace_get_enabled() - Get whether iotracing is enabled or not * - * @return true if enabled, false if disabled + * Return: true if enabled, false if disabled */ int iotrace_get_enabled(void); diff --git a/include/irq.h b/include/irq.h index a0965e4420..1d08cb858d 100644 --- a/include/irq.h +++ b/include/irq.h @@ -147,7 +147,7 @@ struct irq_ops { * * @irq: IRQ description containing device and ID, e.g. previously * returned by irq_get_by_index() - * @return true if valid, false if not + * Return: true if valid, false if not */ static inline bool irq_is_valid(const struct irq *irq) { @@ -169,7 +169,7 @@ int irq_route_pmc_gpio_gpe(struct udevice *dev, uint pmc_gpe_num); * @dev: IRQ device * @irq: Interrupt number to set * @active_low: true if active low, false for active high - * @return 0 if OK, -EINVAL if @irq is invalid + * Return: 0 if OK, -EINVAL if @irq is invalid */ int irq_set_polarity(struct udevice *dev, uint irq, bool active_low); @@ -177,7 +177,7 @@ int irq_set_polarity(struct udevice *dev, uint irq, bool active_low); * irq_snapshot_polarities() - record IRQ polarities for later restore * * @dev: IRQ device - * @return 0 + * Return: 0 */ int irq_snapshot_polarities(struct udevice *dev); @@ -185,7 +185,7 @@ int irq_snapshot_polarities(struct udevice *dev); * irq_restore_polarities() - restore IRQ polarities * * @dev: IRQ device - * @return 0 + * Return: 0 */ int irq_restore_polarities(struct udevice *dev); @@ -195,7 +195,7 @@ int irq_restore_polarities(struct udevice *dev); * Clears the interrupt if pending * * @dev: IRQ device - * @return 0 if interrupt is not pending, 1 if it was (and so has been + * Return: 0 if interrupt is not pending, 1 if it was (and so has been * cleared), -ve on error */ int irq_read_and_clear(struct irq *irq); @@ -224,7 +224,7 @@ struct phandle_2_arg; * @dev: Device containing the phandle * @cells: Phandle info * @irq: A pointer to a irq struct to initialise - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int irq_get_by_phandle(struct udevice *dev, const struct phandle_2_arg *cells, struct irq *irq); @@ -242,7 +242,7 @@ int irq_get_by_phandle(struct udevice *dev, const struct phandle_2_arg *cells, * @index: The index of the irq to request, within the client's list of * irqs. * @irq: A pointer to a irq struct to initialise. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int irq_get_by_index(struct udevice *dev, int index, struct irq *irq); @@ -258,7 +258,7 @@ int irq_get_by_index(struct udevice *dev, int index, struct irq *irq); * @irq: A pointer to a irq struct to initialise. The caller must * have already initialised any field in this struct which the * irq provider uses to identify the irq. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int irq_request(struct udevice *dev, struct irq *irq); @@ -267,7 +267,7 @@ int irq_request(struct udevice *dev, struct irq *irq); * * @irq: A irq struct that was previously successfully requested by * irq_request/get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int irq_free(struct irq *irq); @@ -278,7 +278,7 @@ int irq_free(struct irq *irq); * * @type: Type to find * @devp: Returns the device, if found - * @return 0 if OK, -ENODEV if not found, other -ve error if uclass failed to + * Return: 0 if OK, -ENODEV if not found, other -ve error if uclass failed to * probe */ int irq_first_device_type(enum irq_dev_t type, struct udevice **devp); @@ -291,7 +291,7 @@ int irq_first_device_type(enum irq_dev_t type, struct udevice **devp); * * @irq: irq to convert * @acpi_irq: Output ACPI interrupt information - * @return ACPI pin number or -ve on error + * Return: ACPI pin number or -ve on error */ int irq_get_acpi(const struct irq *irq, struct acpi_irq *acpi_irq); diff --git a/include/key_matrix.h b/include/key_matrix.h index 519722f2d8..e7420b9d79 100644 --- a/include/key_matrix.h +++ b/include/key_matrix.h @@ -66,7 +66,7 @@ int key_matrix_decode(struct key_matrix *config, struct key_matrix_key *keys, * @param config Keyboard matrix config * @param blob FDT blob * @param node Node containing compatible data - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int key_matrix_decode_fdt(struct udevice *dev, struct key_matrix *config); @@ -77,7 +77,7 @@ int key_matrix_decode_fdt(struct udevice *dev, struct key_matrix *config); * @param rows Number of rows in key matrix * @param cols Number of columns in key matrix * @param ghost_filter Non-zero to enable ghost filtering - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int key_matrix_init(struct key_matrix *config, int rows, int cols, int ghost_filter); diff --git a/include/lcd.h b/include/lcd.h index 9a4c0da5ba..51a79317bb 100644 --- a/include/lcd.h +++ b/include/lcd.h @@ -76,42 +76,42 @@ int lcd_display_bitmap(ulong bmp_image, int x, int y); /** * Get the width of the LCD in pixels * - * @return width of LCD in pixels + * Return: width of LCD in pixels */ int lcd_get_pixel_width(void); /** * Get the height of the LCD in pixels * - * @return height of LCD in pixels + * Return: height of LCD in pixels */ int lcd_get_pixel_height(void); /** * Get the number of text lines/rows on the LCD * - * @return number of rows + * Return: number of rows */ int lcd_get_screen_rows(void); /** * Get the number of text columns on the LCD * - * @return number of columns + * Return: number of columns */ int lcd_get_screen_columns(void); /** * Get the background color of the LCD * - * @return background color value + * Return: background color value */ int lcd_getbgcolor(void); /** * Get the foreground color of the LCD * - * @return foreground color value + * Return: foreground color value */ int lcd_getfgcolor(void); diff --git a/include/led.h b/include/led.h index 02766fa56f..8eeb5a7c6d 100644 --- a/include/led.h +++ b/include/led.h @@ -78,7 +78,7 @@ struct led_ops { * * @label: LED label to look up * @devp: Returns the associated device, if found - * @return 0 if found, -ENODEV if not found, other -ve on error + * Return: 0 if found, -ENODEV if not found, other -ve on error */ int led_get_by_label(const char *label, struct udevice **devp); @@ -87,7 +87,7 @@ int led_get_by_label(const char *label, struct udevice **devp); * * @dev: LED device to change * @state: LED state to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int led_set_state(struct udevice *dev, enum led_state_t state); @@ -95,7 +95,7 @@ int led_set_state(struct udevice *dev, enum led_state_t state); * led_get_state() - get the state of an LED * * @dev: LED device to change - * @return LED state led_state_t, or -ve on error + * Return: LED state led_state_t, or -ve on error */ enum led_state_t led_get_state(struct udevice *dev); @@ -104,7 +104,7 @@ enum led_state_t led_get_state(struct udevice *dev); * * @dev: LED device to change * @period_ms: LED blink period in milliseconds - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int led_set_period(struct udevice *dev, int period_ms); diff --git a/include/linux/clk-provider.h b/include/linux/clk-provider.h index 9d296f240a..9a6116646d 100644 --- a/include/linux/clk-provider.h +++ b/include/linux/clk-provider.h @@ -84,7 +84,7 @@ u8 clk_mux_get_parent(struct clk *clk); * @table: array of register values corresponding to the parent index (optional) * @flags: hardware-specific flags * @index: parent clock index - * @return the register value + * Return: the register value */ unsigned int clk_mux_index_to_val(u32 *table, unsigned int flags, u8 index); @@ -143,7 +143,7 @@ extern const struct clk_ops clk_divider_ops; * * @table: array of register values corresponding to valid dividers * @val: value to convert - * @return the divider + * Return: the divider */ unsigned int clk_divider_get_table_div(const struct clk_div_table *table, unsigned int val); @@ -156,7 +156,7 @@ unsigned int clk_divider_get_table_div(const struct clk_div_table *table, * * @table: array of register values corresponding to valid dividers * @div: requested divider - * @return the register value + * Return: the register value */ unsigned int clk_divider_get_table_val(const struct clk_div_table *table, unsigned int div); @@ -167,7 +167,7 @@ unsigned int clk_divider_get_table_val(const struct clk_div_table *table, * @table: array of valid dividers (optional) * @div: divider to check * @flags: hardware-specific flags - * @return true if the divider is valid, false otherwise + * Return: true if the divider is valid, false otherwise */ bool clk_divider_is_valid_div(const struct clk_div_table *table, unsigned int div, unsigned long flags); @@ -177,7 +177,7 @@ bool clk_divider_is_valid_div(const struct clk_div_table *table, * * @table: array of valid dividers * @div: divider to check - * @return true if the divider is found in the @table array, false otherwise + * Return: true if the divider is found in the @table array, false otherwise */ bool clk_divider_is_valid_table_div(const struct clk_div_table *table, unsigned int div); diff --git a/include/linux/string.h b/include/linux/string.h index 3169c93796..df1c1c5669 100644 --- a/include/linux/string.h +++ b/include/linux/string.h @@ -62,7 +62,7 @@ extern char * strchr(const char *,int); * NULL * @s: string to search * @c: character to search for - * @return position of @c in @s, or end of @s if not found + * Return: position of @c in @s, or end of @s if not found */ const char *strchrnul(const char *s, int c); @@ -89,7 +89,7 @@ extern __kernel_size_t strnlen(const char *,__kernel_size_t); * * @s: string to search * @reject: strings which cause the search to halt - * @return number of characters at the start of @s which are not in @reject + * Return: number of characters at the start of @s which are not in @reject */ size_t strcspn(const char *s, const char *reject); #endif @@ -136,7 +136,7 @@ void *memchr_inv(const void *, int, size_t); * * @src: data to copy in * @len: number of bytes to copy - * @return allocated buffer with the copied contents, or NULL if not enough + * Return: allocated buffer with the copied contents, or NULL if not enough * memory is available * */ diff --git a/include/linux/zstd.h b/include/linux/zstd.h index 35ba4c90aa..aed20fc3bd 100644 --- a/include/linux/zstd.h +++ b/include/linux/zstd.h @@ -1151,7 +1151,7 @@ struct abuf; * * @in: Input buffer to decompress * @out: Output buffer to hold the results (must be large enough) - * @return size of the decompressed data, or -ve on error + * Return: size of the decompressed data, or -ve on error */ int zstd_decompress(struct abuf *in, struct abuf *out); diff --git a/include/log.h b/include/log.h index e0e12ce194..ce48d51446 100644 --- a/include/log.h +++ b/include/log.h @@ -660,7 +660,7 @@ int log_remove_filter(const char *drv_name, int filter_num); * * @drv: Driver of device to enable * @enable: true to enable, false to disable - * @return 0 if OK, -ENOENT if the driver was not found + * Return: 0 if OK, -ENOENT if the driver was not found */ int log_device_set_enable(struct log_driver *drv, bool enable); diff --git a/include/mailbox-uclass.h b/include/mailbox-uclass.h index 3c60c76506..866ca0aa8d 100644 --- a/include/mailbox-uclass.h +++ b/include/mailbox-uclass.h @@ -62,7 +62,7 @@ struct mbox_ops { * * @chan: The channel to send to the message to. * @data: A pointer to the message to send. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int (*send)(struct mbox_chan *chan, const void *data); /** @@ -73,7 +73,7 @@ struct mbox_ops { * * @chan: The channel to receive to the message from. * @data: A pointer to the buffer to hold the received message. - * @return 0 if OK, -ENODATA if no message was available, or a negative + * Return: 0 if OK, -ENODATA if no message was available, or a negative * error code. */ int (*recv)(struct mbox_chan *chan, void *data); diff --git a/include/mailbox.h b/include/mailbox.h index 93f4715e16..323b6c2bc5 100644 --- a/include/mailbox.h +++ b/include/mailbox.h @@ -76,7 +76,7 @@ struct mbox_chan { * @index: The index of the mailbox channel to request, within the * client's list of channels. * @chan A pointer to a channel object to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan); @@ -94,7 +94,7 @@ int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan); * @name: The name of the mailbox channel to request, within the client's * list of channels. * @chan A pointer to a channel object to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_get_by_name(struct udevice *dev, const char *name, struct mbox_chan *chan); @@ -104,7 +104,7 @@ int mbox_get_by_name(struct udevice *dev, const char *name, * * @chan: A channel object that was previously successfully requested by * calling mbox_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_free(struct mbox_chan *chan); @@ -120,7 +120,7 @@ int mbox_free(struct mbox_chan *chan); * the memory region pointed at by @data is determined by the * mailbox provider. Providers that solely transfer notifications * will ignore this parameter. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int mbox_send(struct mbox_chan *chan, const void *data); @@ -139,7 +139,7 @@ int mbox_send(struct mbox_chan *chan, const void *data); * notifications will ignore this parameter. * @timeout_us: The maximum time to wait for a message to be available, in * micro-seconds. A value of 0 does not wait at all. - * @return 0 if OK, -ENODATA if no message was available, or a negative error + * Return: 0 if OK, -ENODATA if no message was available, or a negative error * code. */ int mbox_recv(struct mbox_chan *chan, void *data, ulong timeout_us); diff --git a/include/memalign.h b/include/memalign.h index 44f4a86241..f67f0a74f2 100644 --- a/include/memalign.h +++ b/include/memalign.h @@ -103,7 +103,7 @@ * * @size: Minimum number of bytes to allocate * - * @return pointer to new memory region, or NULL if there is no more memory + * Return: pointer to new memory region, or NULL if there is no more memory * available. */ static inline void *malloc_cache_aligned(size_t size) diff --git a/include/membuff.h b/include/membuff.h index c992067133..21051b0c54 100644 --- a/include/membuff.h +++ b/include/membuff.h @@ -62,7 +62,7 @@ void membuff_purge(struct membuff *mb); * @maxlen: the number of bytes we want to write * @update: true to update the membuff as if the write happened, false to not * @data: the address data can be written to - * @return number of bytes which can be written + * Return: number of bytes which can be written */ int membuff_putraw(struct membuff *mb, int maxlen, bool update, char **data); @@ -80,7 +80,7 @@ int membuff_putraw(struct membuff *mb, int maxlen, bool update, char **data); * @update: true to update the membuff as if the bytes have been read (use * false to check bytes without reading them) * @data: returns address of data in input membuff - * @return the number of bytes available at *@data + * Return: the number of bytes available at *@data */ int membuff_getraw(struct membuff *mb, int maxlen, bool update, char **data); @@ -89,14 +89,14 @@ int membuff_getraw(struct membuff *mb, int maxlen, bool update, char **data); * * @mb: membuff to adjust * @ch: byte to write - * @return true on success, false if membuff is full + * Return: true on success, false if membuff is full */ bool membuff_putbyte(struct membuff *mb, int ch); /** * @mb: membuff to adjust * membuff_getbyte() - Read a byte from the membuff - * @return the byte read, or -1 if the membuff is empty + * Return: the byte read, or -1 if the membuff is empty */ int membuff_getbyte(struct membuff *mb); @@ -107,7 +107,7 @@ int membuff_getbyte(struct membuff *mb); * removing it from the membuff. * * @mb: membuff to adjust - * @return the byte peeked, or -1 if the membuff is empty + * Return: the byte peeked, or -1 if the membuff is empty */ int membuff_peekbyte(struct membuff *mb); @@ -120,7 +120,7 @@ int membuff_peekbyte(struct membuff *mb); * @mb: membuff to adjust * @Buff: address of membuff to transfer bytes to * @maxlen: maximum number of bytes to read - * @return the number of bytes read + * Return: the number of bytes read */ int membuff_get(struct membuff *mb, char *buff, int maxlen); @@ -133,7 +133,7 @@ int membuff_get(struct membuff *mb, char *buff, int maxlen); * @mb: membuff to adjust * @data: the data to write * @length: number of bytes to write from 'data' - * @return the number of bytes added + * Return: the number of bytes added */ int membuff_put(struct membuff *mb, const char *buff, int length); @@ -141,7 +141,7 @@ int membuff_put(struct membuff *mb, const char *buff, int length); * membuff_isempty() - check if a membuff is empty * * @mb: membuff to check - * @return true if empty, else false + * Return: true if empty, else false */ bool membuff_isempty(struct membuff *mb); @@ -149,7 +149,7 @@ bool membuff_isempty(struct membuff *mb); * membuff_avail() - check available data in a membuff * * @mb: membuff to check - * @return number of bytes of data available + * Return: number of bytes of data available */ int membuff_avail(struct membuff *mb); @@ -159,7 +159,7 @@ int membuff_avail(struct membuff *mb); * Note that a membuff can only old data up to one byte less than its size. * * @mb: membuff to check - * @return total size + * Return: total size */ int membuff_size(struct membuff *mb); @@ -170,7 +170,7 @@ int membuff_size(struct membuff *mb); * possible * * @mb: membuff to adjust - * @return true on success + * Return: true on success */ bool membuff_makecontig(struct membuff *mb); @@ -178,7 +178,7 @@ bool membuff_makecontig(struct membuff *mb); * membuff_free() - find the number of bytes that can be written to a membuff * * @mb: membuff to check - * @return returns the number of bytes free in a membuff + * Return: returns the number of bytes free in a membuff */ int membuff_free(struct membuff *mb); @@ -192,7 +192,7 @@ int membuff_free(struct membuff *mb); * @mb: membuff to adjust * @str: Place to put the line * @maxlen: Maximum line length (excluding terminator) - * @return number of bytes read (including terminator) if a line has been + * Return: number of bytes read (including terminator) if a line has been * read, 0 if nothing was there */ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch); @@ -205,7 +205,7 @@ int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch); * @mb: membuff to adjust * @by: Number of bytes to increase the size by * @max: Maximum size to allow - * @return 0 if the expand succeeded, -ENOMEM if not enough memory, -E2BIG + * Return: 0 if the expand succeeded, -ENOMEM if not enough memory, -E2BIG * if the the size would exceed @max */ int membuff_extend_by(struct membuff *mb, int by, int max); @@ -231,7 +231,7 @@ void membuff_uninit(struct membuff *mb); * * @mb: membuff to init * @size: size of membuff to create - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ int membuff_new(struct membuff *mb, int size); diff --git a/include/menu.h b/include/menu.h index 9ab9b21ebb..ad5859437e 100644 --- a/include/menu.h +++ b/include/menu.h @@ -30,7 +30,7 @@ int menu_default_choice(struct menu *m, void **choice); * * @bootdelay: Delay to wait before running the default menu option (0 to run * the entry immediately) - * @return If it returns, it always returns -1 to indicate that the boot should + * Return: If it returns, it always returns -1 to indicate that the boot should * be aborted and the command prompt should be provided */ int menu_show(int bootdelay); diff --git a/include/miiphy.h b/include/miiphy.h index 77a0035958..235ae066dd 100644 --- a/include/miiphy.h +++ b/include/miiphy.h @@ -165,7 +165,7 @@ void dm_mdio_probe_devices(void); * @ethdev: ethernet device to connect to the PHY * @interface: MAC-PHY protocol * - * @return pointer to phy_device, or 0 on error + * Return: pointer to phy_device, or 0 on error */ struct phy_device *dm_mdio_phy_connect(struct udevice *mdiodev, int phyaddr, struct udevice *ethdev, @@ -179,7 +179,7 @@ struct phy_device *dm_mdio_phy_connect(struct udevice *mdiodev, int phyaddr, * * @ethdev: ethernet device * - * @return pointer to phy_device, or 0 on error + * Return: pointer to phy_device, or 0 on error */ struct phy_device *dm_eth_phy_connect(struct udevice *ethdev); diff --git a/include/mmc.h b/include/mmc.h index 244d2dc592..6bdcce881d 100644 --- a/include/mmc.h +++ b/include/mmc.h @@ -390,7 +390,7 @@ struct mmc_uclass_priv { * will be available. * * @dev: Device - * @return associated mmc struct pointer if available, else NULL + * Return: associated mmc struct pointer if available, else NULL */ struct mmc *mmc_get_mmc_dev(const struct udevice *dev); @@ -768,7 +768,7 @@ struct mmc *mmc_create(const struct mmc_config *cfg, void *priv); * @dev: MMC device to set up * @mmc: MMC struct * @cfg: MMC configuration - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_bind(struct udevice *dev, struct mmc *mmc, const struct mmc_config *cfg); @@ -778,7 +778,7 @@ void mmc_destroy(struct mmc *mmc); * mmc_unbind() - Unbind a MMC device's child block device * * @dev: MMC device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_unbind(struct udevice *dev); int mmc_initialize(struct bd_info *bis); @@ -793,7 +793,7 @@ int mmc_deinit(struct mmc *mmc); * * @dev: MMC device * @cfg: MMC configuration - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg); @@ -803,7 +803,7 @@ int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg); * * @dev: MMC device * @cfg: MMC configuration - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_pwrseq_get_power(struct udevice *dev, struct mmc_config *cfg); #endif @@ -814,7 +814,7 @@ int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size); * mmc_voltage_to_mv() - Convert a mmc_voltage in mV * * @voltage: The mmc_voltage to convert - * @return the value in mV if OK, -EINVAL on error (invalid mmc_voltage value) + * Return: the value in mV if OK, -EINVAL on error (invalid mmc_voltage value) */ int mmc_voltage_to_mv(enum mmc_voltage voltage); @@ -823,7 +823,7 @@ int mmc_voltage_to_mv(enum mmc_voltage voltage); * @mmc: MMC struct * @clock: bus frequency in Hz * @disable: flag indicating if the clock must on or off - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mmc_set_clock(struct mmc *mmc, uint clock, bool disable); @@ -837,7 +837,7 @@ void print_mmc_devices(char separator); /** * get_mmc_num() - get the total MMC device number * - * @return 0 if there is no MMC device, else the number of devices + * Return: 0 if there is no MMC device, else the number of devices */ int get_mmc_num(void); int mmc_switch_part(struct mmc *mmc, unsigned int part_num); @@ -898,7 +898,7 @@ int mmc_set_bkops_enable(struct mmc *mmc); * * @param mmc Pointer to a MMC device struct * @param quiet Be quiet, do not print error messages when card is not detected. - * @return 0 on success, <0 on error. + * Return: 0 on success, <0 on error. */ int mmc_get_op_cond(struct mmc *mmc, bool quiet); @@ -909,7 +909,7 @@ int mmc_get_op_cond(struct mmc *mmc, bool quiet); * initializatin. * * @param mmc Pointer to a MMC device struct - * @return 0 on success, <0 on error. + * Return: 0 on success, <0 on error. */ int mmc_start_init(struct mmc *mmc); @@ -956,7 +956,7 @@ int mmc_get_env_dev(void); * mmc_get_blk_desc() - Get the block descriptor for an MMC device * * @mmc: MMC device - * @return block device if found, else NULL + * Return: block device if found, else NULL */ struct blk_desc *mmc_get_blk_desc(struct mmc *mmc); diff --git a/include/net.h b/include/net.h index cec8c98618..b02e4f630c 100644 --- a/include/net.h +++ b/include/net.h @@ -67,7 +67,7 @@ struct in_addr { * @flag: Command flags (CMD_FLAG_...) * @argc: Number of arguments * @argv: List of arguments - * @return result (see enum command_ret_t) + * Return: result (see enum command_ret_t) */ int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); @@ -274,7 +274,7 @@ int eth_get_dev_index(void); /* get the device index */ * @base_name: Base name for variable, typically "eth" * @index: Index of interface being updated (>=0) * @enetaddr: Pointer to MAC address to put into the variable - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int eth_env_set_enetaddr_by_index(const char *base_name, int index, uchar *enetaddr); @@ -628,7 +628,7 @@ void net_set_udp_header(uchar *pkt, struct in_addr dest, int dport, * * @addr: Address to check (must be 16-bit aligned) * @nbytes: Number of bytes to check (normally a multiple of 2) - * @return 16-bit IP checksum + * Return: 16-bit IP checksum */ unsigned compute_ip_checksum(const void *addr, unsigned nbytes); @@ -638,7 +638,7 @@ unsigned compute_ip_checksum(const void *addr, unsigned nbytes); * @offset: Offset of first sum (if odd we do a byte-swap) * @sum: First checksum * @new_sum: New checksum to add - * @return updated 16-bit IP checksum + * Return: updated 16-bit IP checksum */ unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); @@ -649,7 +649,7 @@ unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum); * * @addr: Address to check (must be 16-bit aligned) * @nbytes: Number of bytes to check (normally a multiple of 2) - * @return true if the checksum matches, false if not + * Return: true if the checksum matches, false if not */ int ip_checksum_ok(const void *addr, unsigned nbytes); @@ -917,7 +917,7 @@ int net_parse_bootfile(struct in_addr *ipaddr, char *filename, int max_len); * @param interface - the DFU medium name - e.g. "mmc" * @param devstring - the DFU medium number - e.g. "1" * - * @return - 0 on success, other value on failure + * Return: - 0 on success, other value on failure */ int update_tftp(ulong addr, char *interface, char *devstring); @@ -927,7 +927,7 @@ int update_tftp(ulong addr, char *interface, char *devstring); * @var: Environment variable to convert. The value of this variable must be * in the format format a.b.c.d, where each value is a decimal number from * 0 to 255 - * @return IP address, or 0 if invalid + * Return: IP address, or 0 if invalid */ static inline struct in_addr env_get_ip(char *var) { diff --git a/include/net/dsa.h b/include/net/dsa.h index 1b1068cd88..9fa9d4e785 100644 --- a/include/net/dsa.h +++ b/include/net/dsa.h @@ -130,7 +130,7 @@ struct dsa_pdata { * @tailroom: Size, in bytes, of tailroom needed for the DSA tag. * Total headroom and tailroom size should not exceed * DSA_MAX_OVR. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom); @@ -142,7 +142,7 @@ int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom); * Can be called at driver probe time or later. * * @dev: DSA device pointer - * @return Master Eth 'udevice' pointer if OK, NULL on error + * Return: Master Eth 'udevice' pointer if OK, NULL on error */ struct udevice *dsa_get_master(struct udevice *dev); @@ -153,7 +153,7 @@ struct udevice *dsa_get_master(struct udevice *dev); * * @dev: DSA switch udevice pointer * @port: Port index - * @return OF node reference if OK, NULL on error + * Return: OF node reference if OK, NULL on error */ ofnode dsa_port_get_ofnode(struct udevice *dev, int port); @@ -164,7 +164,7 @@ ofnode dsa_port_get_ofnode(struct udevice *dev, int port); * Can be called at driver probe time or later. * * @pdev: DSA port device pointer - * @return 'dsa_port_pdata' pointer if OK, NULL on error + * Return: 'dsa_port_pdata' pointer if OK, NULL on error */ static inline struct dsa_port_pdata * dsa_port_get_pdata(struct udevice *pdev) diff --git a/include/net/pcap.h b/include/net/pcap.h index 512ba982f1..6184bf53a8 100644 --- a/include/net/pcap.h +++ b/include/net/pcap.h @@ -10,7 +10,7 @@ * @paddr physicaly memory address to store buffer * @size maximum size of capture file in memory * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_init(phys_addr_t paddr, unsigned long size); @@ -19,28 +19,28 @@ int pcap_init(phys_addr_t paddr, unsigned long size); * * @start if true, start capture if false stop capture * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_start_stop(bool start); /** * pcap_clear() - clear pcap capture buffer and statistics * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_clear(void); /** * pcap_print_status() - print status of pcap capture * - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_print_status(void); /** * pcap_active() - check if pcap is enabled * - * @return TRUE if active, FALSE if not. + * Return: TRUE if active, FALSE if not. */ bool pcap_active(void); @@ -50,6 +50,6 @@ bool pcap_active(void); * @packet: packet to post * @len: packet length in bytes * @outgoing packet direction (outgoing/incoming) - * @return 0 on success, -ERROR on error + * Return: 0 on success, -ERROR on error */ int pcap_post(const void *packet, size_t len, bool outgoing); diff --git a/include/ns16550.h b/include/ns16550.h index bef2071998..3d9002d9f1 100644 --- a/include/ns16550.h +++ b/include/ns16550.h @@ -237,7 +237,7 @@ void ns16550_reinit(struct ns16550 *com_port, int baud_divisor); * @port: UART port * @clock: UART input clock speed in Hz * @baudrate: Required baud rate - * @return baud rate divisor that should be used + * Return: baud rate divisor that should be used */ int ns16550_calc_divisor(struct ns16550 *port, int clock, int baudrate); @@ -257,7 +257,7 @@ int ns16550_serial_of_to_plat(struct udevice *dev); * ns16550_serial_probe() - probe a serial port * * This sets up the serial port ready for use, except for the baud rate - * @return 0, or -ve on error + * Return: 0, or -ve on error */ int ns16550_serial_probe(struct udevice *dev); diff --git a/include/of_live.h b/include/of_live.h index b8561f5b1f..b2b9679ae8 100644 --- a/include/of_live.h +++ b/include/of_live.h @@ -16,7 +16,7 @@ struct device_node; * * @fdt_blob: Input tree to convert * @rootp: Returns live tree that was created - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int of_live_build(const void *fdt_blob, struct device_node **rootp); diff --git a/include/p2sb.h b/include/p2sb.h index ddbc8d5e14..00acc8d935 100644 --- a/include/p2sb.h +++ b/include/p2sb.h @@ -63,7 +63,7 @@ struct p2sb_ops { * * @dev: P2SB device * @hide: true to hide the device, false to show it - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int p2sb_set_hide(struct udevice *dev, bool hide); @@ -74,7 +74,7 @@ int p2sb_set_hide(struct udevice *dev, bool hide); * * @dev: Device to read from * @offset: Offset within device to read - * @return value read + * Return: value read */ uint pcr_read32(struct udevice *dev, uint offset); uint pcr_read16(struct udevice *dev, uint offset); @@ -149,7 +149,7 @@ static inline void pcr_clrbits8(struct udevice *dev, uint offset, uint clr) * * @dev: Child device (whose parent is UCLASS_P2SB) * @portid: Port ID of child device - * @return 0 if OK, -ENODEV is the p2sb device could not be found + * Return: 0 if OK, -ENODEV is the p2sb device could not be found */ int p2sb_set_port_id(struct udevice *dev, int portid); @@ -157,7 +157,7 @@ int p2sb_set_port_id(struct udevice *dev, int portid); * p2sb_get_port_id() - Get the port ID for a p2sb child device * * @dev: Child device (whose parent is UCLASS_P2SB) - * @return Port ID of that child + * Return: Port ID of that child */ int p2sb_get_port_id(struct udevice *dev); @@ -166,7 +166,7 @@ int p2sb_get_port_id(struct udevice *dev); * * @dev: Child device (whose parent is UCLASS_P2SB) * @offset: Offset within that child's address space - * @return pointer to that offset within the child's address space + * Return: pointer to that offset within the child's address space */ void *pcr_reg_address(struct udevice *dev, uint offset); diff --git a/include/panel.h b/include/panel.h index cd596d48c0..ab417bc91e 100644 --- a/include/panel.h +++ b/include/panel.h @@ -43,7 +43,7 @@ struct panel_ops { * * @dev: Panel device containing the backlight to enable * @enable: true to enable the backlight, false to dis - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int panel_enable_backlight(struct udevice *dev); @@ -52,7 +52,7 @@ int panel_enable_backlight(struct udevice *dev); * * @dev: Panel device containing the backlight to update * @percent: Brightness value (0 to 100, or BACKLIGHT_... value) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int panel_set_backlight(struct udevice *dev, int percent); @@ -60,7 +60,7 @@ int panel_set_backlight(struct udevice *dev, int percent); * panel_get_display_timing() - Get display timings from panel. * * @dev: Panel device containing the display timings - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int panel_get_display_timing(struct udevice *dev, struct display_timing *timing); diff --git a/include/part.h b/include/part.h index b8d8e1ff0d..53cfbdd876 100644 --- a/include/part.h +++ b/include/part.h @@ -97,7 +97,7 @@ struct disk_part { * @ifname: Interface name (e.g. "ide", "scsi") * @dev: Device number (0 for first device on that interface, 1 for * second, etc. - * @return pointer to the block device, or NULL if not available, or an + * Return: pointer to the block device, or NULL if not available, or an * error occurred. */ struct blk_desc *blk_get_dev(const char *ifname, int dev); @@ -142,7 +142,7 @@ void dev_print(struct blk_desc *dev_desc); * and hardware partition number (e.g. "2.4") for devices that * support it (currently only MMC). * @dev_desc: Returns a pointer to the block device on success - * @return block device number (local to the interface), or -1 on error + * Return: block device number (local to the interface), or -1 on error */ int blk_get_device_by_str(const char *ifname, const char *dev_str, struct blk_desc **dev_desc); @@ -177,7 +177,7 @@ int blk_get_device_by_str(const char *ifname, const char *dev_str, * @allow_whole_dev: true to allow the user to select partition 0 * (which means the whole device), false to require a valid * partition number >= 1 - * @return partition number, or -1 on error + * Return: partition number, or -1 on error * */ int blk_get_device_part_str(const char *ifname, const char *dev_part_str, @@ -193,7 +193,7 @@ int blk_get_device_part_str(const char *ifname, const char *dev_part_str, * @param info - returns the disk partition info * @param part_type - only search in partitions of this type * - * @return - the partition number on match (starting on 1), -1 on no match, + * Return: - the partition number on match (starting on 1), -1 on no match, * otherwise error */ int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name, @@ -207,7 +207,7 @@ int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name, * @param gpt_name - the specified table entry name * @param info - returns the disk partition info * - * @return - the partition number on match (starting on 1), -1 on no match, + * Return: - the partition number on match (starting on 1), -1 on no match, * otherwise error */ int part_get_info_by_name(struct blk_desc *dev_desc, @@ -230,7 +230,7 @@ int part_get_info_by_name(struct blk_desc *dev_desc, * @param[in] allow_whole_dev true to allow the user to select partition 0 * (which means the whole device), false to require a valid * partition number >= 1 - * @return the partition number on success, or negative errno on error + * Return: the partition number on success, or negative errno on error */ int part_get_info_by_dev_and_name_or_num(const char *dev_iface, const char *dev_part_str, @@ -352,7 +352,7 @@ struct part_driver { * @param gpt_h - pointer to GPT header representation * @param gpt_e - pointer to GPT partition table entries * - * @return - zero on success, otherwise error + * Return: - zero on success, otherwise error */ int write_gpt_table(struct blk_desc *dev_desc, gpt_header *gpt_h, gpt_entry *gpt_e); @@ -366,7 +366,7 @@ int write_gpt_table(struct blk_desc *dev_desc, * @param partitions - list of partitions * @param parts - number of partitions * - * @return zero on success + * Return: zero on success */ int gpt_fill_pte(struct blk_desc *dev_desc, gpt_header *gpt_h, gpt_entry *gpt_e, @@ -380,7 +380,7 @@ int gpt_fill_pte(struct blk_desc *dev_desc, * @param str_guid - disk guid string representation * @param parts_count - number of partitions * - * @return - error on str_guid conversion error + * Return: - error on str_guid conversion error */ int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h, char *str_guid, int parts_count); @@ -393,7 +393,7 @@ int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h, * @param partitions - list of partitions * @param parts - number of partitions * - * @return zero on success + * Return: zero on success */ int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid, struct disk_partition *partitions, const int parts_count); @@ -404,7 +404,7 @@ int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid, * @param dev_desc - block device descriptor * @param buf - buffer which contains the MBR and Primary GPT info * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf); @@ -414,7 +414,7 @@ int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf); * @param dev_desc - block device descriptor * @param buf - buffer which contains the MBR and Primary GPT info * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf); @@ -428,7 +428,7 @@ int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf); * @param gpt_head - pointer to GPT header data read from medium * @param gpt_pte - pointer to GPT partition table enties read from medium * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head, gpt_entry **gpt_pte); @@ -447,7 +447,7 @@ int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head, * @param gpt_head - pointer to GPT header data read from medium * @param gpt_pte - pointer to GPT partition table enties read from medium * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int gpt_verify_partitions(struct blk_desc *dev_desc, struct disk_partition *partitions, int parts, @@ -463,7 +463,7 @@ int gpt_verify_partitions(struct blk_desc *dev_desc, * @param dev_desc - block device descriptor * @param guid - pre-allocated string in which to return the GUID * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int get_disk_guid(struct blk_desc *dev_desc, char *guid); @@ -475,7 +475,7 @@ int get_disk_guid(struct blk_desc *dev_desc, char *guid); * * @param buf - buffer which contains the MBR * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int is_valid_dos_buf(void *buf); @@ -485,7 +485,7 @@ int is_valid_dos_buf(void *buf); * @param dev_desc - block device descriptor * @param buf - buffer which contains the MBR * - * @return - '0' on success, otherwise error + * Return: - '0' on success, otherwise error */ int write_mbr_sector(struct blk_desc *dev_desc, void *buf); @@ -500,7 +500,7 @@ int layout_mbr_partitions(struct disk_partition *p, int count, /** * part_driver_get_count() - get partition driver count * - * @return - number of partition drivers + * Return: - number of partition drivers */ static inline int part_driver_get_count(void) { @@ -510,7 +510,7 @@ static inline int part_driver_get_count(void) /** * part_driver_get_first() - get first partition driver * - * @return - pointer to first partition driver on success, otherwise NULL + * Return: - pointer to first partition driver on success, otherwise NULL */ static inline struct part_driver *part_driver_get_first(void) { diff --git a/include/pch.h b/include/pch.h index 620566819c..d2b6862037 100644 --- a/include/pch.h +++ b/include/pch.h @@ -110,7 +110,7 @@ struct pch_ops { * * @dev: PCH device to check * @sbasep: Returns address of SPI base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no SPI base) + * Return: 0 if OK, -ve on error (e.g. there is no SPI base) */ int pch_get_spi_base(struct udevice *dev, ulong *sbasep); @@ -120,7 +120,7 @@ int pch_get_spi_base(struct udevice *dev, ulong *sbasep); * @dev: PCH device to adjust * @protect: true to protect, false to unprotect * - * @return 0 on success, -ENOSYS if not implemented + * Return: 0 on success, -ENOSYS if not implemented */ int pch_set_spi_protect(struct udevice *dev, bool protect); @@ -129,7 +129,7 @@ int pch_set_spi_protect(struct udevice *dev, bool protect); * * @dev: PCH device to check * @gbasep: Returns address of GPIO base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no GPIO base) + * Return: 0 if OK, -ve on error (e.g. there is no GPIO base) */ int pch_get_gpio_base(struct udevice *dev, u32 *gbasep); @@ -138,7 +138,7 @@ int pch_get_gpio_base(struct udevice *dev, u32 *gbasep); * * @dev: PCH device to check * @iobasep: Returns address of IO base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no IO base) + * Return: 0 if OK, -ve on error (e.g. there is no IO base) */ int pch_get_io_base(struct udevice *dev, u32 *iobasep); @@ -154,7 +154,7 @@ int pch_get_io_base(struct udevice *dev, u32 *iobasep); * @req: PCH request ID * @data: Input/output data * @size: Size of input data (and maximum size of output data) - * @return size of output data on sucesss, -ve on error + * Return: size of output data on sucesss, -ve on error */ int pch_ioctl(struct udevice *dev, ulong req, void *data, int size); diff --git a/include/pci.h b/include/pci.h index ad1171b0a2..9e7910b271 100644 --- a/include/pci.h +++ b/include/pci.h @@ -812,7 +812,7 @@ void pciauto_config_init(struct pci_controller *hose); * @size: Amount of bytes to allocate * @bar: Returns the PCI bus address of the allocated resource * @supports_64bit: Whether to allow allocations above the 32-bit boundary - * @return 0 if successful, -1 on failure + * Return: 0 if successful, -1 on failure */ int pciauto_region_allocate(struct pci_region *res, pci_size_t size, pci_addr_t *bar, bool supports_64bit); @@ -898,7 +898,7 @@ void pci_write_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum, * @hose: PCI hose to use * @dev: PCI device to inspect * @barnum: BAR number (0-5) - * @return address of the bar, masking out any control bits + * Return: address of the bar, masking out any control bits * */ u32 pci_read_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum); @@ -998,7 +998,7 @@ struct dm_pci_ops { * dm_pci_get_bdf() - Get the BDF value for a device * * @dev: Device to check - * @return bus/device/function value (see PCI_BDF()) + * Return: bus/device/function value (see PCI_BDF()) */ pci_dev_t dm_pci_get_bdf(const struct udevice *dev); @@ -1015,7 +1015,7 @@ pci_dev_t dm_pci_get_bdf(const struct udevice *dev); * driver interface. * * @bus: Bus containing devices to bind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bind_bus_devices(struct udevice *bus); @@ -1030,7 +1030,7 @@ int pci_bind_bus_devices(struct udevice *bus); * devices are mapped into memory and I/O space ready for use. * * @bus: Bus containing devices to bind - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_auto_config_devices(struct udevice *bus); @@ -1039,7 +1039,7 @@ int pci_auto_config_devices(struct udevice *bus); * * @bdf: PCI device address: bus, device and function -see PCI_BDF() * @devp: Returns the device for this address, if found - * @return 0 if OK, -ENODEV if not found + * Return: 0 if OK, -ENODEV if not found */ int dm_pci_bus_find_bdf(pci_dev_t bdf, struct udevice **devp); @@ -1048,7 +1048,7 @@ int dm_pci_bus_find_bdf(pci_dev_t bdf, struct udevice **devp); * * @find_devfn: PCI device address (device and function only) * @devp: Returns the device for this address, if found - * @return 0 if OK, -ENODEV if not found + * Return: 0 if OK, -ENODEV if not found */ int pci_bus_find_devfn(const struct udevice *bus, pci_dev_t find_devfn, struct udevice **devp); @@ -1062,7 +1062,7 @@ int pci_bus_find_devfn(const struct udevice *bus, pci_dev_t find_devfn, * * @devp: Set to the first available device, or NULL if no more are left * or we got an error - * @return 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) + * Return: 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) */ int pci_find_first_device(struct udevice **devp); @@ -1074,7 +1074,7 @@ int pci_find_first_device(struct udevice **devp); * * @devp: On entry, the last device returned. Set to the next available * device, or NULL if no more are left or we got an error - * @return 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) + * Return: 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe) */ int pci_find_next_device(struct udevice **devp); @@ -1082,7 +1082,7 @@ int pci_find_next_device(struct udevice **devp); * pci_get_ff() - Returns a mask for the given access size * * @size: Access size - * @return 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for + * Return: 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for * PCI_SIZE_32 */ int pci_get_ff(enum pci_size_t size); @@ -1097,7 +1097,7 @@ int pci_get_ff(enum pci_size_t size); * parameter is decremented for each non-matching device so * can be called repeatedly. * @devp: Returns matching device if found - * @return 0 if found, -ENODEV if not + * Return: 0 if found, -ENODEV if not */ int pci_bus_find_devices(struct udevice *bus, const struct pci_device_id *ids, int *indexp, struct udevice **devp); @@ -1109,7 +1109,7 @@ int pci_bus_find_devices(struct udevice *bus, const struct pci_device_id *ids, * @index: Index number of device to find, 0 for the first match, 1 for * the second, etc. * @devp: Returns matching device if found - * @return 0 if found, -ENODEV if not + * Return: 0 if found, -ENODEV if not */ int pci_find_device_id(const struct pci_device_id *ids, int index, struct udevice **devp); @@ -1126,7 +1126,7 @@ int pci_find_device_id(const struct pci_device_id *ids, int index, * * @hose: PCI hose to scan * @bdf: PCI bus address to scan (PCI_BUS(bdf) is the bus number) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_pci_hose_probe_bus(struct udevice *bus); @@ -1141,7 +1141,7 @@ int dm_pci_hose_probe_bus(struct udevice *bus); * @offset: Register offset to read * @valuep: Place to put the returned value * @size: Access size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bus_read_config(const struct udevice *bus, pci_dev_t bdf, int offset, unsigned long *valuep, enum pci_size_t size); @@ -1154,7 +1154,7 @@ int pci_bus_read_config(const struct udevice *bus, pci_dev_t bdf, int offset, * @offset: Register offset to write * @value: Value to write * @size: Access size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bus_write_config(struct udevice *bus, pci_dev_t bdf, int offset, unsigned long value, enum pci_size_t size); @@ -1169,7 +1169,7 @@ int pci_bus_write_config(struct udevice *bus, pci_dev_t bdf, int offset, * @offset: Register offset to update * @clr: Bits to clear * @set: Bits to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_bus_clrset_config32(struct udevice *bus, pci_dev_t bdf, int offset, u32 clr, u32 set); @@ -1271,7 +1271,7 @@ int pci_generic_mmap_read_config( * * @pdev: Physical Function udevice handle * @vf_en: Number of Virtual Function devices to enable - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int pci_sriov_init(struct udevice *pdev, int vf_en); @@ -1279,7 +1279,7 @@ int pci_sriov_init(struct udevice *pdev, int vf_en); * pci_sriov_get_totalvfs() - Get total available Virtual Function devices * * @pdev: Physical Function udevice handle - * @return count on success, -ve on error + * Return: count on success, -ve on error */ int pci_sriov_get_totalvfs(struct udevice *pdev); #endif @@ -1335,7 +1335,7 @@ static inline int pci_read_config_byte(pci_dev_t pcidev, int offset, * devices are mapped into memory and I/O space ready for use. * * @dev: Device to configure - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_pciauto_config_device(struct udevice *dev); @@ -1349,7 +1349,7 @@ int dm_pciauto_config_device(struct udevice *dev); * @value: Value to transform (32-bit value read from @offset & ~3) * @offset: Register offset that was read * @size: Required size of the result - * @return the value that would have been obtained if the read had been + * Return: the value that would have been obtained if the read had been * performed at the given offset with the correct size */ ulong pci_conv_32_to_size(ulong value, uint offset, enum pci_size_t size); @@ -1365,7 +1365,7 @@ ulong pci_conv_32_to_size(ulong value, uint offset, enum pci_size_t size); * @value: Value to transform (32-bit value read from @offset & ~3) * @offset: Register offset that should be written * @size: Required size of the write - * @return the value that should be written as a 32-bit access to @offset & ~3. + * Return: the value that should be written as a 32-bit access to @offset & ~3. */ ulong pci_conv_size_to_32(ulong old, ulong value, uint offset, enum pci_size_t size); @@ -1374,7 +1374,7 @@ ulong pci_conv_size_to_32(ulong old, ulong value, uint offset, * pci_get_controller() - obtain the controller to use for a bus * * @dev: Device to check - * @return pointer to the controller device for this bus + * Return: pointer to the controller device for this bus */ struct udevice *pci_get_controller(struct udevice *dev); @@ -1385,7 +1385,7 @@ struct udevice *pci_get_controller(struct udevice *dev); * @iop: Returns a pointer to the I/O region, or NULL if none * @memp: Returns a pointer to the memory region, or NULL if none * @prefp: Returns a pointer to the pre-fetch region, or NULL if none - * @return the number of non-NULL regions returned, normally 3 + * Return: the number of non-NULL regions returned, normally 3 */ int pci_get_regions(struct udevice *dev, struct pci_region **iop, struct pci_region **memp, struct pci_region **prefp); @@ -1417,7 +1417,7 @@ u32 dm_pci_read_bar32(const struct udevice *dev, int barnum); * @dev: Device containing the PCI address * @addr: PCI address to convert * @flags: Flags for the region type (PCI_REGION_...) - * @return physical address corresponding to that PCI bus address + * Return: physical address corresponding to that PCI bus address */ phys_addr_t dm_pci_bus_to_phys(struct udevice *dev, pci_addr_t addr, unsigned long flags); @@ -1428,7 +1428,7 @@ phys_addr_t dm_pci_bus_to_phys(struct udevice *dev, pci_addr_t addr, * @dev: Device containing the bus address * @addr: Physical address to convert * @flags: Flags for the region type (PCI_REGION_...) - * @return PCI bus address corresponding to that physical address + * Return: PCI bus address corresponding to that physical address */ pci_addr_t dm_pci_phys_to_bus(struct udevice *dev, phys_addr_t addr, unsigned long flags); @@ -1582,7 +1582,7 @@ int dm_pci_flr(struct udevice *dev); * @device: Device ID * @index: 0 to find the first match, 1 for second, etc. * @devp: Returns pointer to the device, if found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int dm_pci_find_device(unsigned int vendor, unsigned int device, int index, struct udevice **devp); @@ -1593,7 +1593,7 @@ int dm_pci_find_device(unsigned int vendor, unsigned int device, int index, * @find_class: 3-byte (24-bit) class value to find * @index: 0 to find the first match, 1 for second, etc. * @devp: Returns pointer to the device, if found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int dm_pci_find_class(uint find_class, int index, struct udevice **devp); @@ -1705,7 +1705,7 @@ struct dm_pci_emul_ops { * @find_devfn: PCI device and function address (PCI_DEVFN()) * @containerp: Returns container device if found * @emulp: Returns emulated device if found - * @return 0 if found, -ENODEV if not found + * Return: 0 if found, -ENODEV if not found */ int sandbox_pci_get_emul(const struct udevice *bus, pci_dev_t find_devfn, struct udevice **containerp, struct udevice **emulp); @@ -1715,7 +1715,7 @@ int sandbox_pci_get_emul(const struct udevice *bus, pci_dev_t find_devfn, * * @emul: Emulation device to check * @devp: Returns the client device emulated by this device - * @return 0 if OK, -ENOENT if the device has no client yet + * Return: 0 if OK, -ENOENT if the device has no client yet */ int sandbox_pci_get_client(struct udevice *emul, struct udevice **devp); diff --git a/include/pci_ep.h b/include/pci_ep.h index 00e8c6d8ab..e8e5800096 100644 --- a/include/pci_ep.h +++ b/include/pci_ep.h @@ -255,7 +255,7 @@ struct pci_ep_ops { * @dev: device to write to * @func_num: EP function to fill * @hdr: header to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_write_header(struct udevice *dev, uint func_num, struct pci_ep_header *hdr); @@ -266,7 +266,7 @@ int pci_ep_write_header(struct udevice *dev, uint func_num, * @dev: device to write to * @func_num: EP function to fill * @hdr: header to read to - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_read_header(struct udevice *dev, uint func_num, struct pci_ep_header *hdr); @@ -276,7 +276,7 @@ int pci_ep_read_header(struct udevice *dev, uint func_num, * @dev: device to set * @func_num: EP function to set * @bar: bar data - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_set_bar(struct udevice *dev, uint func_num, struct pci_bar *bar); @@ -287,7 +287,7 @@ int pci_ep_set_bar(struct udevice *dev, uint func_num, struct pci_bar *bar); * @func_num: EP function to read * @bar: struct to copy data to * @barno: bar number to read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_read_bar(struct udevice *dev, uint func_no, struct pci_bar *ep_bar, enum pci_barno barno); @@ -298,7 +298,7 @@ int pci_ep_read_bar(struct udevice *dev, uint func_no, struct pci_bar *ep_bar, * @dev: device to clear * @func_num: EP function to clear * @bar: bar number - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_clear_bar(struct udevice *dev, uint func_num, enum pci_barno bar); /** @@ -312,7 +312,7 @@ int pci_ep_clear_bar(struct udevice *dev, uint func_num, enum pci_barno bar); * @addr: local physical address base * @pci_addr: pci address to translate to * @size: region size - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_map_addr(struct udevice *dev, uint func_num, phys_addr_t addr, u64 pci_addr, size_t size); @@ -324,7 +324,7 @@ int pci_ep_map_addr(struct udevice *dev, uint func_num, phys_addr_t addr, * @dev: device to set * @func_num: EP function to set * @addr: local physical address base - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_unmap_addr(struct udevice *dev, uint func_num, phys_addr_t addr); @@ -337,7 +337,7 @@ int pci_ep_unmap_addr(struct udevice *dev, uint func_num, phys_addr_t addr); * @dev: device to set * @func_num: EP function to set * @interrupts: required interrupts count - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_set_msi(struct udevice *dev, uint func_num, uint interrupts); @@ -349,7 +349,7 @@ int pci_ep_set_msi(struct udevice *dev, uint func_num, uint interrupts); * * @dev: device to use * @func_num: EP function to use - * @return msi count if OK, -EINVAL if msi were not enabled at host. + * Return: msi count if OK, -EINVAL if msi were not enabled at host. */ int pci_ep_get_msi(struct udevice *dev, uint func_num); @@ -362,7 +362,7 @@ int pci_ep_get_msi(struct udevice *dev, uint func_num); * @dev: device to set * @func_num: EP function to set * @interrupts: required interrupts count - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_set_msix(struct udevice *dev, uint func_num, uint interrupts); @@ -374,7 +374,7 @@ int pci_ep_set_msix(struct udevice *dev, uint func_num, uint interrupts); * * @dev: device to use * @func_num: EP function to use - * @return msi count if OK, -EINVAL if msi were not enabled at host. + * Return: msi count if OK, -EINVAL if msi were not enabled at host. */ int pci_ep_get_msix(struct udevice *dev, uint func_num); @@ -385,7 +385,7 @@ int pci_ep_get_msix(struct udevice *dev, uint func_num); * @func_num: EP function to set * @type: type of irq to send * @interrupt_num: interrupt vector to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_raise_irq(struct udevice *dev, uint func_num, enum pci_ep_irq_type type, uint interrupt_num); @@ -396,7 +396,7 @@ int pci_ep_raise_irq(struct udevice *dev, uint func_num, * process. * * @dev: device to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_start(struct udevice *dev); @@ -407,7 +407,7 @@ int pci_ep_start(struct udevice *dev); * link. * * @dev: device to set - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pci_ep_stop(struct udevice *dev); diff --git a/include/pci_rom.h b/include/pci_rom.h index 895c9627f4..1cc61c387b 100644 --- a/include/pci_rom.h +++ b/include/pci_rom.h @@ -60,7 +60,7 @@ int dm_pci_run_vga_bios(struct udevice *dev, int (*int15_handler)(void), * the mapping ourselves. * * @vendev: Vendor and device for the video device - * @return standard vendor and device expected by the ROM + * Return: standard vendor and device expected by the ROM */ uint32_t board_map_oprom_vendev(uint32_t vendev); diff --git a/include/phy-sun4i-usb.h b/include/phy-sun4i-usb.h index b0a45b2058..c37c59379f 100644 --- a/include/phy-sun4i-usb.h +++ b/include/phy-sun4i-usb.h @@ -11,7 +11,7 @@ * sun4i_usb_phy_id_detect - detect ID pin of USB PHY * * @phy: USB PHY port to detect ID pin - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int sun4i_usb_phy_id_detect(struct phy *phy); @@ -19,7 +19,7 @@ int sun4i_usb_phy_id_detect(struct phy *phy); * sun4i_usb_phy_vbus_detect - detect VBUS pin of USB PHY * * @phy: USB PHY port to detect VBUS pin - * @return 0 if OK, or a negative error code + * Return: 0 if OK, or a negative error code */ int sun4i_usb_phy_vbus_detect(struct phy *phy); diff --git a/include/physmem.h b/include/physmem.h index 03d3a78b74..c88ae9653f 100644 --- a/include/physmem.h +++ b/include/physmem.h @@ -16,6 +16,6 @@ * @param c The character to set each byte of the region to. * @param n The number of bytes to set. * - * @return The physical address of the memory which was set. + * Return: The physical address of the memory which was set. */ phys_addr_t arch_phys_memset(phys_addr_t s, int c, phys_size_t n); diff --git a/include/power-domain.h b/include/power-domain.h index 62ff19948f..113276b511 100644 --- a/include/power-domain.h +++ b/include/power-domain.h @@ -74,7 +74,7 @@ struct power_domain { * * @dev: The client device. * @power_domain A pointer to a power domain struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_get(struct udevice *dev, struct power_domain *power_domain); @@ -93,7 +93,7 @@ int power_domain_get(struct udevice *dev, struct power_domain *power_domain) * @power_domain: A pointer to a power domain struct to initialize. * @index: Power domain index to be powered on. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_get_by_index(struct udevice *dev, @@ -112,7 +112,7 @@ int power_domain_get_by_index(struct udevice *dev, * * @power_domain: A power domain struct that was previously successfully * requested by power_domain_get(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_free(struct power_domain *power_domain); @@ -128,7 +128,7 @@ static inline int power_domain_free(struct power_domain *power_domain) * * @power_domain: A power domain struct that was previously successfully * requested by power_domain_get(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_on(struct power_domain *power_domain); @@ -144,7 +144,7 @@ static inline int power_domain_on(struct power_domain *power_domain) * * @power_domain: A power domain struct that was previously successfully * requested by power_domain_get(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(POWER_DOMAIN) int power_domain_off(struct power_domain *power_domain); @@ -160,7 +160,7 @@ static inline int power_domain_off(struct power_domain *power_domain) * * @dev: The client device. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN) int dev_power_domain_on(struct udevice *dev); @@ -176,7 +176,7 @@ static inline int dev_power_domain_on(struct udevice *dev) * * @dev: The client device. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ #if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN) int dev_power_domain_off(struct udevice *dev); diff --git a/include/power/acpi_pmc.h b/include/power/acpi_pmc.h index 64176d79bc..62c4dcbd97 100644 --- a/include/power/acpi_pmc.h +++ b/include/power/acpi_pmc.h @@ -141,7 +141,7 @@ struct acpi_pmc_ops { * This reads the current state of the PMC. This reads in the common registers, * then calls the device's init() method to read the SoC-specific registers. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pmc_init(struct udevice *dev); @@ -151,7 +151,7 @@ int pmc_init(struct udevice *dev); * This reads various state registers and returns the sleep state from * which the system woke. * - * @return enum acpi_sleep_state indicating the previous sleep state + * Return: enum acpi_sleep_state indicating the previous sleep state * (ACPI_S0, ACPI_S3 or ACPI_S5), or -ve on error */ int pmc_prev_sleep_state(struct udevice *dev); @@ -162,7 +162,7 @@ int pmc_prev_sleep_state(struct udevice *dev); * Disables the timer/counter in the PMC * * @dev: PMC device to use - * @return 0 + * Return: 0 */ int pmc_disable_tco(struct udevice *dev); @@ -176,7 +176,7 @@ int pmc_disable_tco(struct udevice *dev); * * @dev: PMC device to use * @enable: true to enable global reset, false to disable - * @return 0 + * Return: 0 */ int pmc_global_reset_set_enable(struct udevice *dev, bool enable); @@ -190,7 +190,7 @@ void pmc_dump_info(struct udevice *dev); * pmc_gpe_init() - Set up general-purpose events * * @dev: PMC device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pmc_gpe_init(struct udevice *dev); diff --git a/include/power/pmic.h b/include/power/pmic.h index 97f855ce39..70f2709bd0 100644 --- a/include/power/pmic.h +++ b/include/power/pmic.h @@ -201,7 +201,7 @@ struct pmic_child_info { * * @pmic - pmic device - the parent of found child's * @child_info - N-childs info array - * @return a positive number of childs, or 0 if no child found (error) + * Return: a positive number of childs, or 0 if no child found (error) * * Note: For N-childs the child_info array should have N+1 entries and the last * entry prefix should be NULL - the same as for drivers compatible. @@ -236,7 +236,7 @@ int pmic_bind_children(struct udevice *pmic, ofnode parent, * * @name - device name * @devp - returned pointer to the pmic device - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. * * The returned devp device can be used with pmic_read/write calls */ @@ -248,7 +248,7 @@ int pmic_get(const char *name, struct udevice **devp); * The required pmic device can be obtained by 'pmic_get()' * * @dev - pointer to the UCLASS_PMIC device - * @return register count value on success or negative value of errno. + * Return: register count value on success or negative value of errno. */ int pmic_reg_count(struct udevice *dev); @@ -261,7 +261,7 @@ int pmic_reg_count(struct udevice *dev); * @reg - device register offset * @buffer - pointer to read/write buffer * @len - byte count for read/write - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int pmic_read(struct udevice *dev, uint reg, uint8_t *buffer, int len); int pmic_write(struct udevice *dev, uint reg, const uint8_t *buffer, int len); @@ -271,7 +271,7 @@ int pmic_write(struct udevice *dev, uint reg, const uint8_t *buffer, int len); * * @dev: PMIC device to read * @reg: Register to read - * @return value read on success or negative value of errno. + * Return: value read on success or negative value of errno. */ int pmic_reg_read(struct udevice *dev, uint reg); @@ -281,7 +281,7 @@ int pmic_reg_read(struct udevice *dev, uint reg); * @dev: PMIC device to write * @reg: Register to write * @value: Value to write - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int pmic_reg_write(struct udevice *dev, uint reg, uint value); @@ -295,7 +295,7 @@ int pmic_reg_write(struct udevice *dev, uint reg, uint value); * @reg: Register to update * @clr: Bit mask to clear (set those bits that you want cleared) * @set: Bit mask to set (set those bits that you want set) - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int pmic_clrsetbits(struct udevice *dev, uint reg, uint clr, uint set); diff --git a/include/power/regulator.h b/include/power/regulator.h index fad87c99e5..ff1bfc2435 100644 --- a/include/power/regulator.h +++ b/include/power/regulator.h @@ -274,7 +274,7 @@ struct dm_regulator_ops { * * @dev - pointer to the regulator device * @modep - pointer to the returned mode info array - * @return - count of modep entries on success or negative errno if fail. + * Return: - count of modep entries on success or negative errno if fail. */ int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep); @@ -282,7 +282,7 @@ int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep); * regulator_get_value: get microvoltage voltage value of a given regulator * * @dev - pointer to the regulator device - * @return - positive output value [uV] on success or negative errno if fail. + * Return: - positive output value [uV] on success or negative errno if fail. */ int regulator_get_value(struct udevice *dev); @@ -291,7 +291,7 @@ int regulator_get_value(struct udevice *dev); * * @dev - pointer to the regulator device * @uV - the output value to set [micro Volts] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_value(struct udevice *dev, int uV); @@ -300,7 +300,7 @@ int regulator_set_value(struct udevice *dev, int uV); * * @dev - pointer to the regulator device * @uV - the output suspend value to set [micro Volts] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_suspend_value(struct udevice *dev, int uV); @@ -308,7 +308,7 @@ int regulator_set_suspend_value(struct udevice *dev, int uV); * regulator_get_suspend_value: get the suspend microvoltage value of a given regulator. * * @dev - pointer to the regulator device - * @return - positive output value [uV] on success or negative errno if fail. + * Return: - positive output value [uV] on success or negative errno if fail. */ int regulator_get_suspend_value(struct udevice *dev); @@ -318,7 +318,7 @@ int regulator_get_suspend_value(struct udevice *dev); * * @dev - pointer to the regulator device * @uV - the output value to set [micro Volts] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_value_force(struct udevice *dev, int uV); @@ -326,7 +326,7 @@ int regulator_set_value_force(struct udevice *dev, int uV); * regulator_get_current: get microampere value of a given regulator * * @dev - pointer to the regulator device - * @return - positive output current [uA] on success or negative errno if fail. + * Return: - positive output current [uA] on success or negative errno if fail. */ int regulator_get_current(struct udevice *dev); @@ -335,7 +335,7 @@ int regulator_get_current(struct udevice *dev); * * @dev - pointer to the regulator device * @uA - set the output current [micro Amps] - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_current(struct udevice *dev, int uA); @@ -343,7 +343,7 @@ int regulator_set_current(struct udevice *dev, int uA); * regulator_get_enable: get regulator device enable state. * * @dev - pointer to the regulator device - * @return - true/false of enable state or -errno val if fails + * Return: - true/false of enable state or -errno val if fails */ int regulator_get_enable(struct udevice *dev); @@ -352,7 +352,7 @@ int regulator_get_enable(struct udevice *dev); * * @dev - pointer to the regulator device * @enable - set true or false - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_enable(struct udevice *dev, bool enable); @@ -362,7 +362,7 @@ int regulator_set_enable(struct udevice *dev, bool enable); * * @dev - pointer to the regulator device * @enable - set true or false - * @return - 0 on success or if enabling is not supported + * Return: - 0 on success or if enabling is not supported * -errno val if fails. */ int regulator_set_enable_if_allowed(struct udevice *dev, bool enable); @@ -372,7 +372,7 @@ int regulator_set_enable_if_allowed(struct udevice *dev, bool enable); * * @dev - pointer to the regulator device * @enable - set true or false - * @return - 0 on success or -errno val if fails + * Return: - 0 on success or -errno val if fails */ int regulator_set_suspend_enable(struct udevice *dev, bool enable); @@ -380,7 +380,7 @@ int regulator_set_suspend_enable(struct udevice *dev, bool enable); * regulator_get_suspend_enable: get regulator suspend enable state * * @dev - pointer to the regulator device - * @return - true/false of enable state or -errno val if fails + * Return: - true/false of enable state or -errno val if fails */ int regulator_get_suspend_enable(struct udevice *dev); @@ -388,7 +388,7 @@ int regulator_get_suspend_enable(struct udevice *dev); * regulator_get_mode: get active operation mode id of a given regulator * * @dev - pointer to the regulator device - * @return - positive mode 'id' number on success or -errno val if fails + * Return: - positive mode 'id' number on success or -errno val if fails * Note: * The device can provide an array of operating modes, which is type of struct * dm_regulator_mode. Each mode has it's own 'id', which should be unique inside @@ -402,7 +402,7 @@ int regulator_get_mode(struct udevice *dev); * * @dev - pointer to the regulator device * @mode_id - mode id to set ('id' field of struct type dm_regulator_mode) - * @return - 0 on success or -errno value if fails + * Return: - 0 on success or -errno value if fails * Note: * The device can provide an array of operating modes, which is type of struct * dm_regulator_mode. Each mode has it's own 'id', which should be unique inside @@ -493,7 +493,7 @@ int regulator_autoset_by_name(const char *platname, struct udevice **devp); * @list_devp - an array of returned pointers to the successfully setup * regulator devices if non-NULL passed * @verbose - (true/false) print each regulator setup info, or be quiet - * @return 0 on successfully setup of all list entries, otherwise first error. + * Return: 0 on successfully setup of all list entries, otherwise first error. * * The returned 'regulator' devices can be used with: * - regulator_get/set_* @@ -515,7 +515,7 @@ int regulator_list_autoset(const char *list_platname[], * * @devname - expected string for 'dev->name' of regulator device * @devp - returned pointer to the regulator device - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. * * The returned 'regulator' device is probed and can be used with: * - regulator_get/set_* @@ -528,7 +528,7 @@ int regulator_get_by_devname(const char *devname, struct udevice **devp); * * @platname - expected string for uc_pdata->name of regulator uclass plat * @devp - returns pointer to the regulator device or NULL on error - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. * * The returned 'regulator' device is probed and can be used with: * - regulator_get/set_* @@ -546,7 +546,7 @@ int regulator_get_by_platname(const char *platname, struct udevice **devp); * @dev - device with supply phandle * @supply_name - phandle name of regulator * @devp - returned pointer to the supply device - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int device_get_supply_regulator(struct udevice *dev, const char *supply_name, struct udevice **devp); diff --git a/include/pwm.h b/include/pwm.h index 668551e4b8..bfdc1e3f30 100644 --- a/include/pwm.h +++ b/include/pwm.h @@ -63,7 +63,7 @@ struct pwm_ops { * @channel: PWM channel to update * @period_ns: PWM period in nanoseconds * @duty_ns: PWM duty period in nanoseconds - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pwm_set_config(struct udevice *dev, uint channel, uint period_ns, uint duty_ns); @@ -74,7 +74,7 @@ int pwm_set_config(struct udevice *dev, uint channel, uint period_ns, * @dev: PWM device to update * @channel: PWM channel to update * @enable: true to enable, false to disable - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pwm_set_enable(struct udevice *dev, uint channel, bool enable); @@ -84,7 +84,7 @@ int pwm_set_enable(struct udevice *dev, uint channel, bool enable); * @dev: PWM device to update * @channel: PWM channel to update * @polarity: true to invert, false to keep normal polarity - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int pwm_set_invert(struct udevice *dev, uint channel, bool polarity); diff --git a/include/pxe_utils.h b/include/pxe_utils.h index b7037f841a..dad2668818 100644 --- a/include/pxe_utils.h +++ b/include/pxe_utils.h @@ -205,7 +205,7 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len); * @allow_abs_path: true to allow absolute paths * @bootfile: Bootfile whose directory loaded files are relative to, NULL if * none - * @return 0 if OK, -ENOMEM if out of memory, -E2BIG if bootfile is larger than + * Return: 0 if OK, -ENOMEM if out of memory, -E2BIG if bootfile is larger than * MAX_TFTP_PATH_LEN bytes */ int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, @@ -232,7 +232,7 @@ int pxe_process(struct pxe_context *ctx, ulong pxefile_addr_r, bool prompt); * pxe_get_file_size() - Read the value of the 'filesize' environment variable * * @sizep: Place to put the value - * @return 0 if OK, -ENOENT if no such variable, -EINVAL if format is invalid + * Return: 0 if OK, -ENOENT if no such variable, -EINVAL if format is invalid */ int pxe_get_file_size(ulong *sizep); diff --git a/include/ram.h b/include/ram.h index 273d415394..2fc971df46 100644 --- a/include/ram.h +++ b/include/ram.h @@ -32,7 +32,7 @@ struct ram_ops { * * @dev: Device to check (UCLASS_RAM) * @info: Returns RAM info - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int ram_get_info(struct udevice *dev, struct ram_info *info); diff --git a/include/reboot-mode/reboot-mode.h b/include/reboot-mode/reboot-mode.h index 86b51f881c..5fbd7c801a 100644 --- a/include/reboot-mode/reboot-mode.h +++ b/include/reboot-mode/reboot-mode.h @@ -49,7 +49,7 @@ struct reboot_mode_ops { * dm_reboot_mode_update() - Update the reboot mode env variable. * * @dev: Device to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_reboot_mode_update(struct udevice *dev); diff --git a/include/relocate.h b/include/relocate.h index 26682da955..2dbfd901e4 100644 --- a/include/relocate.h +++ b/include/relocate.h @@ -16,7 +16,7 @@ DECLARE_GLOBAL_DATA_PTR; /** * copy_uboot_to_ram() - Copy U-Boot to its new relocated position * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int copy_uboot_to_ram(void); @@ -25,7 +25,7 @@ int copy_uboot_to_ram(void); * * This clears the memory used by global variables * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int clear_bss(void); @@ -35,7 +35,7 @@ int clear_bss(void); * This processes the relocation tables to ensure that the code can run in its * new location. * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int do_elf_reloc_fixups(void); @@ -46,7 +46,7 @@ int do_elf_reloc_fixups(void); * which need to manually relocate some things. * * @ptr: Pointer to relocate - * @return new pointer value + * Return: new pointer value */ static inline void *manual_reloc(void *ptr) { diff --git a/include/remoteproc.h b/include/remoteproc.h index 089131f65f..a8e654674e 100644 --- a/include/remoteproc.h +++ b/include/remoteproc.h @@ -134,20 +134,20 @@ struct dm_rproc_ops { #if CONFIG_IS_ENABLED(REMOTEPROC) /** * rproc_init() - Initialize all bound remote proc devices - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_init(void); /** * rproc_dev_init() - Initialize a remote proc device based on id * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_dev_init(int id); /** * rproc_is_initialized() - check to see if remoteproc devices are initialized - * @return true if all devices are initialized, false otherwise. + * Return: true if all devices are initialized, false otherwise. */ bool rproc_is_initialized(void); @@ -156,35 +156,35 @@ bool rproc_is_initialized(void); * @id: id of the remote processor * @addr: address in memory where the image is located * @size: size of the image - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_load(int id, ulong addr, ulong size); /** * rproc_start() - Start a remote processor * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_start(int id); /** * rproc_stop() - Stop a remote processor * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_stop(int id); /** * rproc_reset() - reset a remote processor * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. */ int rproc_reset(int id); /** * rproc_ping() - ping a remote processor to check if it can communicate * @id: id of the remote processor - * @return 0 if all ok, else appropriate error value. + * Return: 0 if all ok, else appropriate error value. * * NOTE: this might need communication path available, which is not implemented * as part of remoteproc framework - hook on to appropriate bus architecture to @@ -195,7 +195,7 @@ int rproc_ping(int id); /** * rproc_is_running() - check to see if remote processor is running * @id: id of the remote processor - * @return 0 if running, 1 if not running, -ve on error. + * Return: 0 if running, 1 if not running, -ve on error. * * NOTE: this may not involve actual communication capability of the remote * processor, but just ensures that it is out of reset and executing code. @@ -210,7 +210,7 @@ int rproc_is_running(int id); * * @addr: address of the image to verify * @size: size of the image - * @return 0 if the image looks good, else appropriate error value. + * Return: 0 if the image looks good, else appropriate error value. */ int rproc_elf32_sanity_check(ulong addr, ulong size); @@ -222,7 +222,7 @@ int rproc_elf32_sanity_check(ulong addr, ulong size); * * @addr: address of the image to verify * @size: size of the image - * @return 0 if the image looks good, else appropriate error value. + * Return: 0 if the image looks good, else appropriate error value. */ int rproc_elf64_sanity_check(ulong addr, ulong size); @@ -231,7 +231,7 @@ int rproc_elf64_sanity_check(ulong addr, ulong size); * @dev: device loading the ELF32 image * @addr: valid ELF32 image address * @size: size of the image - * @return 0 if the image is successfully loaded, else appropriate error value. + * Return: 0 if the image is successfully loaded, else appropriate error value. */ int rproc_elf32_load_image(struct udevice *dev, unsigned long addr, ulong size); @@ -240,7 +240,7 @@ int rproc_elf32_load_image(struct udevice *dev, unsigned long addr, ulong size); * @dev: device loading the ELF64 image * @addr: valid ELF64 image address * @size: size of the image - * @return 0 if the image is successfully loaded, else appropriate error value. + * Return: 0 if the image is successfully loaded, else appropriate error value. */ int rproc_elf64_load_image(struct udevice *dev, ulong addr, ulong size); @@ -251,7 +251,7 @@ int rproc_elf64_load_image(struct udevice *dev, ulong addr, ulong size); * @size: size of the image * * Auto detects if the image is ELF32 or ELF64 image and load accordingly. - * @return 0 if the image is successfully loaded, else appropriate error value. + * Return: 0 if the image is successfully loaded, else appropriate error value. */ int rproc_elf_load_image(struct udevice *dev, unsigned long addr, ulong size); @@ -279,7 +279,7 @@ ulong rproc_elf_get_boot_addr(struct udevice *dev, ulong addr); * @rsc_size: pointer to the found resource table size. Updated on operation * success * - * @return 0 if a valid resource table is successfully loaded, -ENODATA if there + * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there * is no resource table (which is optional), or another appropriate error value. */ int rproc_elf32_load_rsc_table(struct udevice *dev, ulong fw_addr, @@ -298,7 +298,7 @@ int rproc_elf32_load_rsc_table(struct udevice *dev, ulong fw_addr, * @rsc_size: pointer to the found resource table size. Updated on operation * success * - * @return 0 if a valid resource table is successfully loaded, -ENODATA if there + * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there * is no resource table (which is optional), or another appropriate error value. */ int rproc_elf64_load_rsc_table(struct udevice *dev, ulong fw_addr, @@ -317,7 +317,7 @@ int rproc_elf64_load_rsc_table(struct udevice *dev, ulong fw_addr, * @rsc_size: pointer to the found resource table size. Updated on operation * success * - * @return 0 if a valid resource table is successfully loaded, -ENODATA if there + * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there * is no resource table (which is optional), or another appropriate error value. */ int rproc_elf_load_rsc_table(struct udevice *dev, ulong fw_addr, diff --git a/include/reset.h b/include/reset.h index cde2c4b4a8..965f02e0ce 100644 --- a/include/reset.h +++ b/include/reset.h @@ -190,7 +190,7 @@ struct reset_ctl_bulk *devm_reset_bulk_get_optional_by_node(struct udevice *dev, * @index: The index of the reset signal to request, within the client's * list of reset signals. * @reset_ctl A pointer to a reset control struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_by_index(struct udevice *dev, int index, struct reset_ctl *reset_ctl); @@ -205,7 +205,7 @@ int reset_get_by_index(struct udevice *dev, int index, * @index: The index of the reset signal to request, within the client's * list of reset signals. * @reset_ctl A pointer to a reset control struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_by_index_nodev(ofnode node, int index, struct reset_ctl *reset_ctl); @@ -222,7 +222,7 @@ int reset_get_by_index_nodev(ofnode node, int index, * * @dev: The client device. * @bulk A pointer to a reset control bulk struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk); @@ -240,7 +240,7 @@ int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk); * @name: The name of the reset signal to request, within the client's * list of reset signals. * @reset_ctl: A pointer to a reset control struct to initialize. - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_get_by_name(struct udevice *dev, const char *name, struct reset_ctl *reset_ctl); @@ -250,7 +250,7 @@ int reset_get_by_name(struct udevice *dev, const char *name, * * @reset_ctl: A reset control struct. * - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_request(struct reset_ctl *reset_ctl); @@ -259,7 +259,7 @@ int reset_request(struct reset_ctl *reset_ctl); * * @reset_ctl: A reset control struct that was previously successfully * requested by reset_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_free(struct reset_ctl *reset_ctl); @@ -273,7 +273,7 @@ int reset_free(struct reset_ctl *reset_ctl); * * @reset_ctl: A reset control struct that was previously successfully * requested by reset_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_assert(struct reset_ctl *reset_ctl); @@ -288,7 +288,7 @@ int reset_assert(struct reset_ctl *reset_ctl); * * @bulk: A reset control bulk struct that was previously successfully * requested by reset_get_bulk(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_assert_bulk(struct reset_ctl_bulk *bulk); @@ -301,7 +301,7 @@ int reset_assert_bulk(struct reset_ctl_bulk *bulk); * * @reset_ctl: A reset control struct that was previously successfully * requested by reset_get_by_*(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_deassert(struct reset_ctl *reset_ctl); @@ -315,7 +315,7 @@ int reset_deassert(struct reset_ctl *reset_ctl); * * @bulk: A reset control bulk struct that was previously successfully * requested by reset_get_bulk(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_deassert_bulk(struct reset_ctl_bulk *bulk); @@ -323,7 +323,7 @@ int reset_deassert_bulk(struct reset_ctl_bulk *bulk); * rst_status - Check reset signal status. * * @reset_ctl: The reset signal to check. - * @return 0 if deasserted, positive if asserted, or a negative + * Return: 0 if deasserted, positive if asserted, or a negative * error code. */ int reset_status(struct reset_ctl *reset_ctl); @@ -337,7 +337,7 @@ int reset_status(struct reset_ctl *reset_ctl); * @reset_ctl: A reset struct array that was previously successfully * requested by reset_get_by_*(). * @count Number of reset contained in the array - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ int reset_release_all(struct reset_ctl *reset_ctl, int count); @@ -351,7 +351,7 @@ int reset_release_all(struct reset_ctl *reset_ctl, int count); * * @bulk: A reset control bulk struct that was previously successfully * requested by reset_get_bulk(). - * @return 0 if OK, or a negative error code. + * Return: 0 if OK, or a negative error code. */ static inline int reset_release_bulk(struct reset_ctl_bulk *bulk) { @@ -462,7 +462,7 @@ static inline int reset_release_bulk(struct reset_ctl_bulk *bulk) * reset_valid() - check if reset is valid * * @reset_ctl: the reset to check - * @return TRUE if valid, or FALSE + * Return: TRUE if valid, or FALSE */ static inline bool reset_valid(struct reset_ctl *reset_ctl) { diff --git a/include/rtc.h b/include/rtc.h index 1efc0db3de..6c7fcadd48 100644 --- a/include/rtc.h +++ b/include/rtc.h @@ -94,7 +94,7 @@ struct rtc_ops { * @dev: Device to write to * @reg: Register to write * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int (*write8)(struct udevice *dev, unsigned int reg, int val); }; @@ -107,7 +107,7 @@ struct rtc_ops { * * @dev: Device to read from * @time: Place to put the current time - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_get(struct udevice *dev, struct rtc_time *time); @@ -116,7 +116,7 @@ int dm_rtc_get(struct udevice *dev, struct rtc_time *time); * * @dev: Device to read from * @time: Time to write into the RTC - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_set(struct udevice *dev, struct rtc_time *time); @@ -129,7 +129,7 @@ int dm_rtc_set(struct udevice *dev, struct rtc_time *time); * the caller. * * @dev: Device to read from - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_reset(struct udevice *dev); @@ -140,7 +140,7 @@ int dm_rtc_reset(struct udevice *dev); * @reg: First register to read * @buf: Output buffer * @len: Number of registers to read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_read(struct udevice *dev, unsigned int reg, u8 *buf, unsigned int len); @@ -151,7 +151,7 @@ int dm_rtc_read(struct udevice *dev, unsigned int reg, u8 *buf, unsigned int len * @reg: First register to write * @buf: Input buffer * @len: Number of registers to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int dm_rtc_write(struct udevice *dev, unsigned int reg, const u8 *buf, unsigned int len); @@ -161,7 +161,7 @@ int dm_rtc_write(struct udevice *dev, unsigned int reg, * * @dev: Device to read from * @reg: Register to read - * @return value read, or -ve on error + * Return: value read, or -ve on error */ int rtc_read8(struct udevice *dev, unsigned int reg); @@ -171,7 +171,7 @@ int rtc_read8(struct udevice *dev, unsigned int reg); * @dev: Device to write to * @reg: Register to write * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_write8(struct udevice *dev, unsigned int reg, int val); @@ -181,7 +181,7 @@ int rtc_write8(struct udevice *dev, unsigned int reg, int val); * @dev: Device to read from * @reg: Offset to start reading from * @valuep: Place to put the value that is read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_read16(struct udevice *dev, unsigned int reg, u16 *valuep); @@ -191,7 +191,7 @@ int rtc_read16(struct udevice *dev, unsigned int reg, u16 *valuep); * @dev: Device to write to * @reg: Register to start writing to * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_write16(struct udevice *dev, unsigned int reg, u16 value); @@ -201,7 +201,7 @@ int rtc_write16(struct udevice *dev, unsigned int reg, u16 value); * @dev: Device to read from * @reg: Offset to start reading from * @valuep: Place to put the value that is read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_read32(struct udevice *dev, unsigned int reg, u32 *valuep); @@ -211,7 +211,7 @@ int rtc_read32(struct udevice *dev, unsigned int reg, u32 *valuep); * @dev: Device to write to * @reg: Register to start writing to * @value: Value to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int rtc_write32(struct udevice *dev, unsigned int reg, u32 value); @@ -231,7 +231,7 @@ void rtc_enable_32khz_output(void); * rtc_read8() - Read an 8-bit register * * @reg: Register to read - * @return value read + * Return: value read */ int rtc_read8(int reg); @@ -247,7 +247,7 @@ void rtc_write8(int reg, uchar val); * rtc_read32() - Read a 32-bit value from the RTC * * @reg: Offset to start reading from - * @return value read + * Return: value read */ u32 rtc_read32(int reg); @@ -269,7 +269,7 @@ void rtc_init(void); * is_leap_year - Check if year is a leap year * * @year Year - * @return 1 if leap year + * Return: 1 if leap year */ static inline bool is_leap_year(unsigned int year) { @@ -283,7 +283,7 @@ static inline bool is_leap_year(unsigned int year) * It sets time->tm_wdaay to the correct day of the week. * * @time: Time to inspect. tm_wday is updated - * @return 0 if OK, -EINVAL if the weekday could not be determined + * Return: 0 if OK, -EINVAL if the weekday could not be determined */ int rtc_calc_weekday(struct rtc_time *time); @@ -309,7 +309,7 @@ void rtc_to_tm(u64 time_t, struct rtc_time *time); * Note that tm_wday and tm_yday are ignored. * * @time: Broken-out time to convert - * @return corresponding time_t value, seconds since 1970-01-01 00:00:00 + * Return: corresponding time_t value, seconds since 1970-01-01 00:00:00 */ unsigned long rtc_mktime(const struct rtc_time *time); diff --git a/include/scmi_agent.h b/include/scmi_agent.h index ed40c7360a..5015c06be9 100644 --- a/include/scmi_agent.h +++ b/include/scmi_agent.h @@ -53,7 +53,7 @@ struct scmi_msg { * * @dev: SCMI agent device * @msg: Message structure reference - * @return 0 on success and a negative errno on failure + * Return: 0 on success and a negative errno on failure */ int devm_scmi_process_msg(struct udevice *dev, struct scmi_msg *msg); @@ -61,7 +61,7 @@ int devm_scmi_process_msg(struct udevice *dev, struct scmi_msg *msg); * scmi_to_linux_errno() - Convert an SCMI error code into a Linux errno code * * @scmi_errno: SCMI error code value - * @return 0 for successful status and a negative errno otherwise + * Return: 0 for successful status and a negative errno otherwise */ int scmi_to_linux_errno(s32 scmi_errno); diff --git a/include/scsi.h b/include/scsi.h index 0a475a8ca4..66a2caa26e 100644 --- a/include/scsi.h +++ b/include/scsi.h @@ -207,7 +207,7 @@ extern struct scsi_ops scsi_ops; * * @dev: SCSI bus * @cmd: Command to execute - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int scsi_exec(struct udevice *dev, struct scsi_cmd *cmd); @@ -215,7 +215,7 @@ int scsi_exec(struct udevice *dev, struct scsi_cmd *cmd); * scsi_bus_reset() - reset the bus * * @dev: SCSI bus to reset - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int scsi_bus_reset(struct udevice *dev); diff --git a/include/sdhci.h b/include/sdhci.h index c718dd7206..c8d69f5a63 100644 --- a/include/sdhci.h +++ b/include/sdhci.h @@ -470,7 +470,7 @@ int sdhci_setup_cfg(struct mmc_config *cfg, struct sdhci_host *host, * @cfg: Empty configuration structure (generally &plat->cfg). This is * normally all zeroes at this point. The only purpose of passing * this in is to set mmc->cfg to it. - * @return 0 if OK, -ve if the block device could not be created + * Return: 0 if OK, -ve if the block device could not be created */ int sdhci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); #else @@ -483,7 +483,7 @@ int sdhci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg); * @host: SDHCI host structure * @f_max: Maximum supported clock frequency in HZ (0 for default) * @f_min: Minimum supported clock frequency in HZ (0 for default) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int add_sdhci(struct sdhci_host *host, u32 f_max, u32 f_min); #endif /* !CONFIG_BLK */ diff --git a/include/search.h b/include/search.h index d0bb44388e..7faf23f4ac 100644 --- a/include/search.h +++ b/include/search.h @@ -86,7 +86,7 @@ int hmatch_r(const char *match, int last_idx, struct env_entry **retval, * @key: Name of entry to delete * @htab: Hash table * @flag: Flags to use (H_...) - * @return 0 on success, -ENOENT if not found, -EPERM if the hash table callback + * Return: 0 on success, -ENOENT if not found, -EPERM if the hash table callback * rejected changing the variable, -EINVAL if the hash table refused to * delete the variable */ diff --git a/include/serial.h b/include/serial.h index 6d1e62c677..19a8c0c67d 100644 --- a/include/serial.h +++ b/include/serial.h @@ -293,7 +293,7 @@ struct serial_dev_priv { * * @dev: Device pointer * @serial_config: Returns config information (see SERIAL_... above) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int serial_getconfig(struct udevice *dev, uint *config); @@ -305,7 +305,7 @@ int serial_getconfig(struct udevice *dev, uint *config); * * @dev: Device pointer * @serial_config: number of bits, parity and number of stopbits to use - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int serial_setconfig(struct udevice *dev, uint config); @@ -314,7 +314,7 @@ int serial_setconfig(struct udevice *dev, uint config); * * @dev: Device pointer * @info: struct serial_device_info to fill - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int serial_getinfo(struct udevice *dev, struct serial_device_info *info); @@ -333,7 +333,7 @@ void sh_serial_initialize(void); * The total size of the output must be less than CONFIG_SYS_PBSIZE. * * @fmt: Printf format string, followed by format arguments - * @return number of characters written + * Return: number of characters written */ int serial_printf(const char *fmt, ...) __attribute__ ((format (__printf__, 1, 2))); diff --git a/include/smbios.h b/include/smbios.h index acfcbfe2ca..c9df2706f5 100644 --- a/include/smbios.h +++ b/include/smbios.h @@ -271,7 +271,7 @@ char *smbios_string(const struct smbios_header *header, int index); * main loop has started) to update the BIOS version string (SMBIOS table 0). * * @version: New version string to use - * @return 0 if OK, -ENOENT if no version string was previously written, + * Return: 0 if OK, -ENOENT if no version string was previously written, * -ENOSPC if the new string is too large to fit */ int smbios_update_version(const char *version); @@ -287,7 +287,7 @@ int smbios_update_version(const char *version); * * @smbios_tab: Start of SMBIOS tables * @version: New version string to use - * @return 0 if OK, -ENOENT if no version string was previously written, + * Return: 0 if OK, -ENOENT if no version string was previously written, * -ENOSPC if the new string is too large to fit */ int smbios_update_version_full(void *smbios_tab, const char *version); diff --git a/include/smem.h b/include/smem.h index 83da9e177e..b19c534ebc 100644 --- a/include/smem.h +++ b/include/smem.h @@ -57,7 +57,7 @@ struct smem_ops { * @host: remote processor id, or -1 * @item: smem item handle * @size: number of bytes to be allocated - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error * * Allocate space for a given smem item of size @size, given that the item is * not yet allocated. @@ -69,7 +69,7 @@ int smem_alloc(struct udevice *dev, unsigned int host, unsigned int item, size_t * @host: the remote processor, or -1 for all processors. * @item: smem item handle * @size: pointer to be filled out with size of the item - * @return pointer on success, NULL on error + * Return: pointer on success, NULL on error * * Looks up smem item and returns pointer to it. Size of smem * item is returned in @size. @@ -80,7 +80,7 @@ void *smem_get(struct udevice *dev, unsigned int host, unsigned int item, size_t * smem_get_free_space() - retrieve amount of free space in a partition * @host: the remote processor identifying a partition, or -1 * for all processors. - * @return size in bytes, -ve on error + * Return: size in bytes, -ve on error * * To be used by smem clients as a quick way to determine if any new * allocations has been made. diff --git a/include/sort.h b/include/sort.h index 0c6b588fcb..76483cff33 100644 --- a/include/sort.h +++ b/include/sort.h @@ -27,7 +27,7 @@ void qsort(void *base, size_t nmemb, size_t size, * * @s1: First string to compare * @s2: Second string to compare - * @return comparison value (less than, equal to, or greater than 0) + * Return: comparison value (less than, equal to, or greater than 0) */ int strcmp_compar(const void *s1, const void *s2); diff --git a/include/sound.h b/include/sound.h index 71bd850652..dab9ea186e 100644 --- a/include/sound.h +++ b/include/sound.h @@ -116,7 +116,7 @@ int sound_setup(struct udevice *dev); * @dev: Sound device * @msecs: Duration of beep in milliseconds * @frequency_hz: Frequency of the beep in Hertz - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sound_beep(struct udevice *dev, int msecs, int frequency_hz); @@ -128,7 +128,7 @@ int sound_beep(struct udevice *dev, int msecs, int frequency_hz); * * @dev: Sound device * @frequency_hz: Beep frequency in hertz - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int sound_start_beep(struct udevice *dev, int frequency_hz); @@ -138,7 +138,7 @@ int sound_start_beep(struct udevice *dev, int frequency_hz); * This tells the sound hardware to stop a previously started beep. * * @dev: Sound device - * @return if OK, -ve on error + * Return: if OK, -ve on error */ int sound_stop_beep(struct udevice *dev); diff --git a/include/spi.h b/include/spi.h index dc3b21132a..fa9ab12dbe 100644 --- a/include/spi.h +++ b/include/spi.h @@ -561,7 +561,7 @@ struct dm_spi_emul_ops { * @cs: Chip select to look for * @busp: Returns bus device * @devp: Return slave device - * @return 0 if found, -ENODEV on error + * Return: 0 if found, -ENODEV on error */ int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp, struct udevice **devp); @@ -586,7 +586,7 @@ int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp, * @dev_name: Name of the new device thus created * @busp: Returns bus device * @devp: Return slave device - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode, const char *drv_name, const char *dev_name, @@ -595,7 +595,7 @@ int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode, /** * spi_chip_select() - Get the chip select for a slave * - * @return the chip select this slave is attached to + * Return: the chip select this slave is attached to */ int spi_chip_select(struct udevice *slave); @@ -605,7 +605,7 @@ int spi_chip_select(struct udevice *slave); * @bus: SPI bus to search * @cs: Chip select to look for * @devp: Returns the slave device if found - * @return 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached, + * Return: 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached, * other -ve value on error */ int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp); @@ -630,7 +630,7 @@ int spi_slave_of_to_plat(struct udevice *dev, struct dm_spi_slave_plat *plat); * @bus: The SPI bus * @cs: The chip select (0..n-1) * @info: Returns information about the chip select, if valid - * @return 0 if OK (and @info is set up), -ENODEV if the chip select + * Return: 0 if OK (and @info is set up), -ENODEV if the chip select * is invalid, other -ve value on error */ int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info); @@ -649,7 +649,7 @@ struct sandbox_state; * @bus: SPI bus requesting the emulator * @slave: SPI slave device requesting the emulator * @emuip: Returns pointer to emulator - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int sandbox_spi_get_emul(struct sandbox_state *state, struct udevice *bus, struct udevice *slave, @@ -715,7 +715,7 @@ int dm_spi_xfer(struct udevice *dev, unsigned int bitlen, * @map_sizep: Returns size of mapped SPI * @offsetp: Returns start offset of SPI flash where the map works * correctly (offsets before this are not visible) - * @return 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not + * Return: 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not * available */ int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep, diff --git a/include/spi_flash.h b/include/spi_flash.h index 4566feab63..d33d0dd46a 100644 --- a/include/spi_flash.h +++ b/include/spi_flash.h @@ -47,7 +47,7 @@ struct dm_spi_flash_ops { * @offset: Offset into device in bytes to read from * @len: Number of bytes to read * @buf: Buffer to put the data that is read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); @@ -58,7 +58,7 @@ int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); * @offset: Offset into device in bytes to write to * @len: Number of bytes to write * @buf: Buffer containing bytes to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, const void *buf); @@ -71,7 +71,7 @@ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, * @dev: SPI flash device * @offset: Offset into device in bytes to start erasing * @len: Number of bytes to erase - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); @@ -83,7 +83,7 @@ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); * defined. * * @dev: SPI flash device - * @return 0 if no region is write-protected, 1 if a region is + * Return: 0 if no region is write-protected, 1 if a region is * write-protected, -ENOSYS if the driver does not implement this, * other -ve value on error */ @@ -97,7 +97,7 @@ int spl_flash_get_sw_write_prot(struct udevice *dev); * do this, typically with of-platdata * * @dev: SPI-flash device to probe - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_std_probe(struct udevice *dev); diff --git a/include/spl.h b/include/spl.h index 0af0ee3003..9fc5ac61f8 100644 --- a/include/spl.h +++ b/include/spl.h @@ -106,7 +106,7 @@ enum u_boot_phase { * ... * } * - * @return U-Boot phase + * Return: U-Boot phase */ static inline enum u_boot_phase spl_phase(void) { @@ -127,7 +127,7 @@ static inline enum u_boot_phase spl_phase(void) /** * spl_prev_phase() - Figure out the previous U-Boot phase * - * @return the previous phase from this one, e.g. if called in SPL this returns + * Return: the previous phase from this one, e.g. if called in SPL this returns * PHASE_TPL, if TPL is enabled */ static inline enum u_boot_phase spl_prev_phase(void) @@ -144,7 +144,7 @@ static inline enum u_boot_phase spl_prev_phase(void) /** * spl_next_phase() - Figure out the next U-Boot phase * - * @return the next phase from this one, e.g. if called in TPL this returns + * Return: the next phase from this one, e.g. if called in TPL this returns * PHASE_SPL */ static inline enum u_boot_phase spl_next_phase(void) @@ -159,7 +159,7 @@ static inline enum u_boot_phase spl_next_phase(void) /** * spl_phase_name() - Get the name of the current phase * - * @return phase name + * Return: phase name */ static inline const char *spl_phase_name(enum u_boot_phase phase) { @@ -180,7 +180,7 @@ static inline const char *spl_phase_name(enum u_boot_phase phase) * spl_phase_prefix() - Get the prefix of the current phase * * @phase: Phase to look up - * @return phase prefix ("spl", "tpl", etc.) + * Return: phase prefix ("spl", "tpl", etc.) */ static inline const char *spl_phase_prefix(enum u_boot_phase phase) { @@ -291,7 +291,7 @@ ulong spl_get_image_size(void); * This returns the address that the next stage is linked to run at, i.e. * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE * - * @return text-base address + * Return: text-base address */ ulong spl_get_image_text_base(void); @@ -435,7 +435,7 @@ void spl_set_header_raw_uboot(struct spl_image_info *spl_image); * * @spl_image: Image description to set up * @header image header to parse - * @return 0 if a header was correctly parsed, -ve on error + * Return: 0 if a header was correctly parsed, -ve on error */ int spl_parse_image_header(struct spl_image_info *spl_image, const struct image_header *header); @@ -484,7 +484,7 @@ void __noreturn jump_to_image_optee(struct spl_image_info *spl_image); * wants to load the kernel or U-Boot. This function should be provided by * the board. * - * @return 0 if SPL should start the kernel, 1 if U-Boot must be started + * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started */ int spl_start_uboot(void); @@ -628,7 +628,7 @@ void spl_board_init(void); * This will normally be true, but if U-Boot jumps to second U-Boot, it will * be false. This should be implemented by board-specific code. * - * @return true if U-Boot booted from SPL, else false + * Return: true if U-Boot booted from SPL, else false */ bool spl_was_boot_source(void); @@ -637,7 +637,7 @@ bool spl_was_boot_source(void); * @param usb_index - usb controller number * @param mmc_dev - mmc device nubmer * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr); @@ -653,7 +653,7 @@ int spl_mmc_load_image(struct spl_image_info *spl_image, * @param raw_part Partition to load from (in RAW mode) * @param raw_sect Sector to load from (in RAW mode) * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ int spl_mmc_load(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, @@ -669,7 +669,7 @@ int spl_mmc_load(struct spl_image_info *spl_image, * @param raw_part Fat partition to load from * @param filename Name of file to load * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ int spl_usb_load(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, diff --git a/include/spl_gpio.h b/include/spl_gpio.h index e410e62914..e39ac3f624 100644 --- a/include/spl_gpio.h +++ b/include/spl_gpio.h @@ -36,7 +36,7 @@ * @regs: Pointer to GPIO registers * @gpio: GPIO to adjust (SoC-specific) * @pull: Pull value (SoC-specific) - * @return return 0 if OK, -ve on error + * Return: return 0 if OK, -ve on error */ int spl_gpio_set_pull(void *regs, uint gpio, int pull); @@ -46,7 +46,7 @@ int spl_gpio_set_pull(void *regs, uint gpio, int pull); * @regs: Pointer to GPIO registers * @gpio: GPIO to adjust (SoC-specific) * @value: 0 to set the output low, 1 to set it high - * @return return 0 if OK, -ve on error + * Return: return 0 if OK, -ve on error */ int spl_gpio_output(void *regs, uint gpio, int value); @@ -55,7 +55,7 @@ int spl_gpio_output(void *regs, uint gpio, int value); * * @regs: Pointer to GPIO registers * @gpio: GPIO to adjust (SoC-specific) - * @return return 0 if OK, -ve on error + * Return: return 0 if OK, -ve on error */ int spl_gpio_input(void *regs, uint gpio); diff --git a/include/spmi/spmi.h b/include/spmi/spmi.h index 3242e6bbd0..3f8bba1284 100644 --- a/include/spmi/spmi.h +++ b/include/spmi/spmi.h @@ -26,7 +26,7 @@ struct dm_spmi_ops { * @usid SlaveID * @pid Peripheral ID * @reg: Register to read - * @return value read on success or negative value of errno. + * Return: value read on success or negative value of errno. */ int spmi_reg_read(struct udevice *dev, int usid, int pid, int reg); @@ -38,7 +38,7 @@ int spmi_reg_read(struct udevice *dev, int usid, int pid, int reg); * @pid Peripheral ID * @reg: Register to write * @value: Value to write - * @return 0 on success or negative value of errno. + * Return: 0 on success or negative value of errno. */ int spmi_reg_write(struct udevice *dev, int usid, int pid, int reg, uint8_t value); diff --git a/include/syscon.h b/include/syscon.h index 2e02199c05..f5e6cc1a4b 100644 --- a/include/syscon.h +++ b/include/syscon.h @@ -43,7 +43,7 @@ struct syscon_base_plat { * * @dev: Device to check (UCLASS_SCON) * @info: Returns regmap for the device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ struct regmap *syscon_get_regmap(struct udevice *dev); @@ -56,7 +56,7 @@ struct regmap *syscon_get_regmap(struct udevice *dev); * * @driver_data: Driver data value to look up * @devp: Returns the controller correponding to @driver_data - * @return 0 on success, -ENODEV if the ID was not found, or other -ve error + * Return: 0 on success, -ENODEV if the ID was not found, or other -ve error * code */ int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp); @@ -69,7 +69,7 @@ int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp); * are in use. This function looks up the regmap given this driver data. * * @driver_data: Driver data value to look up - * @return register map correponding to @driver_data, or -ve error code + * Return: register map correponding to @driver_data, or -ve error code */ struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data); @@ -81,7 +81,7 @@ struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data); * * @dev: Device using the system controller * @name: Name of property referring to the system controller - * @return A pointer to the regmap if found, ERR_PTR(-ve) on error + * Return: A pointer to the regmap if found, ERR_PTR(-ve) on error */ struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev, const char *name); @@ -90,7 +90,7 @@ struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev, * syscon_get_first_range() - get the first memory range from a syscon regmap * * @driver_data: Driver data value to look up - * @return first region of register map correponding to @driver_data, or + * Return: first region of register map correponding to @driver_data, or * -ve error code */ void *syscon_get_first_range(ulong driver_data); diff --git a/include/test/suites.h b/include/test/suites.h index d35cd83a4e..6553a765c6 100644 --- a/include/test/suites.h +++ b/include/test/suites.h @@ -20,7 +20,7 @@ struct unit_test; * @argc: Argument count provided. Must be >= 1. If this is 1 then all * tests are run, otherwise only the one named @argv[1] is run. * @argv: Arguments: argv[1] is the test to run (if @argc >= 2) - * @return 0 if OK, CMD_RET_FAILURE on failure + * Return: 0 if OK, CMD_RET_FAILURE on failure */ int cmd_ut_category(const char *name, const char *prefix, struct unit_test *tests, int n_ents, diff --git a/include/test/ut.h b/include/test/ut.h index fb2e5fcff2..18740f5807 100644 --- a/include/test/ut.h +++ b/include/test/ut.h @@ -52,7 +52,7 @@ void ut_failf(struct unit_test_state *uts, const char *fname, int line, * * @uts: Test state * @fmt: printf() format string for the error, followed by args - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...) __attribute__ ((format (__printf__, 2, 3))); @@ -69,7 +69,7 @@ int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...) * * @uts: Test state * @fmt: printf() format string for the error, followed by args - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...) __attribute__ ((format (__printf__, 2, 3))); @@ -78,7 +78,7 @@ int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...) * ut_check_skipline() - Check that the next console line exists and skip it * * @uts: Test state - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int ut_check_skipline(struct unit_test_state *uts); @@ -93,7 +93,7 @@ int ut_check_skipline(struct unit_test_state *uts); * * @uts: Test state * @fmt: printf() format string to look for, followed by args - * @return 0 if OK, -ENOENT if not found, other value on error + * Return: 0 if OK, -ENOENT if not found, other value on error */ int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...); @@ -104,7 +104,7 @@ int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...); * from the console * * @uts: Test state - * @return 0 if OK (console has no output), other value on error + * Return: 0 if OK (console has no output), other value on error */ int ut_check_console_end(struct unit_test_state *uts); @@ -114,7 +114,7 @@ int ut_check_console_end(struct unit_test_state *uts); * This only supports a byte dump. * * @total_bytes: Size of the expected dump in bytes` - * @return 0 if OK (looks like a dump and the length matches), other value on + * Return: 0 if OK (looks like a dump and the length matches), other value on * error */ int ut_check_console_dump(struct unit_test_state *uts, int total_bytes); @@ -332,7 +332,7 @@ int ut_check_console_dump(struct unit_test_state *uts, int total_bytes); /** * ut_check_free() - Return the number of bytes free in the malloc() pool * - * @return bytes free + * Return: bytes free */ ulong ut_check_free(void); @@ -340,7 +340,7 @@ ulong ut_check_free(void); * ut_check_delta() - Return the number of bytes allocated/freed * * @last: Last value from ut_check_free - * @return free memory delta from @last; positive means more memory has been + * Return: free memory delta from @last; positive means more memory has been * allocated, negative means less has been allocated (i.e. some is freed) */ long ut_check_delta(ulong last); @@ -377,7 +377,7 @@ void ut_set_skip_delays(struct unit_test_state *uts, bool skip_delays); /** * test_get_state() - Get the active test state * - * @return the currently active test state, or NULL if none + * Return: the currently active test state, or NULL if none */ struct unit_test_state *test_get_state(void); @@ -403,7 +403,7 @@ void test_set_state(struct unit_test_state *uts); * @count: Number of tests to run * @select_name: Name of a single test to run (from the list provided). If NULL * then all tests are run - * @return 0 if all tests passed, -1 if any failed + * Return: 0 if all tests passed, -1 if any failed */ int ut_run_list(const char *name, const char *prefix, struct unit_test *tests, int count, const char *select_name); diff --git a/include/time.h b/include/time.h index 3f00e68713..9deb2cf61c 100644 --- a/include/time.h +++ b/include/time.h @@ -24,7 +24,7 @@ uint64_t get_timer_us(uint64_t base); * delays of over an hour. For 64-bit machines it uses a 64-bit value. * *@base: Base time to consider - *@return elapsed time since @base + *Return: elapsed time since @base */ unsigned long get_timer_us_long(unsigned long base); @@ -87,7 +87,7 @@ uint64_t usec_to_tick(unsigned long usec); * usec2ticks() - Convert microseconds to internal ticks * * @usec: Value of microseconds to convert - * @return Corresponding internal ticks value, calculated using get_tbclk() + * Return: Corresponding internal ticks value, calculated using get_tbclk() */ ulong usec2ticks(unsigned long usec); @@ -95,7 +95,7 @@ ulong usec2ticks(unsigned long usec); * ticks2usec() - Convert internal ticks to microseconds * * @ticks: Value of ticks to convert - * @return Corresponding microseconds value, calculated using get_tbclk() + * Return: Corresponding microseconds value, calculated using get_tbclk() */ ulong ticks2usec(unsigned long ticks); @@ -112,7 +112,7 @@ void wait_ticks(unsigned long ticks); /** * timer_get_us() - Get monotonic microsecond timer * - * @return value of monotonic microsecond timer + * Return: value of monotonic microsecond timer */ unsigned long timer_get_us(void); @@ -122,7 +122,7 @@ unsigned long timer_get_us(void); * This is an internal value used by the timer on the system. Ticks increase * monotonically at the rate given by get_tbclk(). * - * @return current tick value + * Return: current tick value */ uint64_t get_ticks(void); diff --git a/include/tmu.h b/include/tmu.h index da07a2211e..f4389f81da 100644 --- a/include/tmu.h +++ b/include/tmu.h @@ -31,7 +31,7 @@ enum tmu_status_t { * Monitors status of the TMU device and exynos temperature * * @param temp pointer to the current temperature value - * @return enum tmu_status_t value, code indicating event to execute + * Return: enum tmu_status_t value, code indicating event to execute * and -1 on error */ enum tmu_status_t tmu_monitor(int *temp); @@ -40,7 +40,7 @@ enum tmu_status_t tmu_monitor(int *temp); * Initialize TMU device * * @param blob FDT blob - * @return int value, 0 for success + * Return: int value, 0 for success */ int tmu_init(const void *blob); #endif /* _THERMAL_H_ */ diff --git a/include/tpm-common.h b/include/tpm-common.h index 998b4fbb41..a28629e701 100644 --- a/include/tpm-common.h +++ b/include/tpm-common.h @@ -220,7 +220,7 @@ int tpm_close(struct udevice *dev); * tpm_clear_and_reenable() - Force clear the TPM and reenable it * * @dev: TPM device - * @return 0 on success, -ve on failure + * Return: 0 on success, -ve on failure */ u32 tpm_clear_and_reenable(struct udevice *dev); @@ -230,7 +230,7 @@ u32 tpm_clear_and_reenable(struct udevice *dev); * @dev: Device to check * @buf: Buffer to put the string * @size: Maximum size of buffer - * @return length of string, or -ENOSPC it no space + * Return: length of string, or -ENOSPC it no space */ int tpm_get_desc(struct udevice *dev, char *buf, int size); @@ -263,14 +263,14 @@ int tpm_xfer(struct udevice *dev, const u8 *sendbuf, size_t send_size, * Initialize TPM device. It must be called before any TPM commands. * * @dev - TPM device - * @return 0 on success, non-0 on error. + * Return: 0 on success, non-0 on error. */ int tpm_init(struct udevice *dev); /** * Retrieve the array containing all the v1 (resp. v2) commands. * - * @return a struct cmd_tbl array. + * Return: a struct cmd_tbl array. */ #if defined(CONFIG_TPM_V1) struct cmd_tbl *get_tpm1_commands(unsigned int *size); @@ -296,7 +296,7 @@ static inline struct cmd_tbl *get_tpm2_commands(unsigned int *size) * it supports. * * @dev: TPM device - * @return version number (TPM_V1 or TPMV2) + * Return: version number (TPM_V1 or TPMV2) */ enum tpm_version tpm_get_version(struct udevice *dev); diff --git a/include/tpm-v1.h b/include/tpm-v1.h index fcfe1f054f..33d53fb695 100644 --- a/include/tpm-v1.h +++ b/include/tpm-v1.h @@ -287,7 +287,7 @@ struct __packed tpm_nv_data_public { * * @param dev TPM device * @param mode TPM startup mode - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_startup(struct udevice *dev, enum tpm_startup_type mode); @@ -295,7 +295,7 @@ u32 tpm1_startup(struct udevice *dev, enum tpm_startup_type mode); * Issue a TPM_SelfTestFull command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_self_test_full(struct udevice *dev); @@ -303,7 +303,7 @@ u32 tpm1_self_test_full(struct udevice *dev); * Issue a TPM_ContinueSelfTest command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_continue_self_test(struct udevice *dev); @@ -316,7 +316,7 @@ u32 tpm1_continue_self_test(struct udevice *dev); * @param index index of the area * @param perm TPM_NV_ATTRIBUTES of the area * @param size size of the area - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); @@ -329,7 +329,7 @@ u32 tpm1_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); * @param index index of the area * @param data output buffer of the area contents * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); @@ -342,7 +342,7 @@ u32 tpm1_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); * @param index index of the area * @param data input buffer to be wrote to the area * @param length length of data bytes of input buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_nv_write_value(struct udevice *dev, u32 index, const void *data, u32 length); @@ -356,7 +356,7 @@ u32 tpm1_nv_write_value(struct udevice *dev, u32 index, const void *data, * recorded * @param out_digest 160-bit PCR value after execution of the * command - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_extend(struct udevice *dev, u32 index, const void *in_digest, void *out_digest); @@ -368,7 +368,7 @@ u32 tpm1_extend(struct udevice *dev, u32 index, const void *in_digest, * @param index index of the PCR * @param data output buffer for contents of the named PCR * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); @@ -378,7 +378,7 @@ u32 tpm1_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); * * @param dev TPM device * @param presence TPM physical presence flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_tsc_physical_presence(struct udevice *dev, u16 presence); @@ -388,7 +388,7 @@ u32 tpm1_tsc_physical_presence(struct udevice *dev, u16 presence); * @param dev TPM device * @param data output buffer for the public endorsement key * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_read_pubek(struct udevice *dev, void *data, size_t count); @@ -396,7 +396,7 @@ u32 tpm1_read_pubek(struct udevice *dev, void *data, size_t count); * Issue a TPM_ForceClear command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_force_clear(struct udevice *dev); @@ -404,7 +404,7 @@ u32 tpm1_force_clear(struct udevice *dev); * Issue a TPM_PhysicalEnable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_physical_enable(struct udevice *dev); @@ -412,7 +412,7 @@ u32 tpm1_physical_enable(struct udevice *dev); * Issue a TPM_PhysicalDisable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_physical_disable(struct udevice *dev); @@ -421,7 +421,7 @@ u32 tpm1_physical_disable(struct udevice *dev); * * @param dev TPM device * @param state boolean state of the deactivated flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_physical_set_deactivated(struct udevice *dev, u8 state); @@ -435,7 +435,7 @@ u32 tpm1_physical_set_deactivated(struct udevice *dev, u8 state); * limited to be 4-byte wide * @param cap output buffer for capability information * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, void *cap, size_t count); @@ -445,7 +445,7 @@ u32 tpm1_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, * * @param dev TPM device * @param auth_handle handle of the auth session - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_terminate_auth_session(struct udevice *dev, u32 auth_handle); @@ -458,7 +458,7 @@ u32 tpm1_terminate_auth_session(struct udevice *dev, u32 auth_handle); * * @param dev TPM device * @param auth_handle pointer to the (new) auth handle or NULL. - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_oiap(struct udevice *dev, u32 *auth_handle); @@ -466,7 +466,7 @@ u32 tpm1_oiap(struct udevice *dev, u32 *auth_handle); * Ends an active OIAP session. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_end_oiap(struct udevice *dev); @@ -480,7 +480,7 @@ u32 tpm1_end_oiap(struct udevice *dev); * @param key_length size of the key structure * @param parent_key_usage_auth usage auth for the parent key * @param key_handle pointer to the key handle - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, size_t key_length, const void *parent_key_usage_auth, @@ -498,7 +498,7 @@ u32 tpm1_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, * @param pubkey_len pointer to the pub key buffer len. On entry: the size of * the provided pubkey buffer. On successful exit: the size * of the stored TPM_PUBKEY structure (iff pubkey != NULL). - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_pub_key_oiap(struct udevice *dev, u32 key_handle, const void *usage_auth, void *pubkey, @@ -509,7 +509,7 @@ u32 tpm1_get_pub_key_oiap(struct udevice *dev, u32 key_handle, * * @param dev TPM device * @param pflags Place to put permanent flags - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_permanent_flags(struct udevice *dev, struct tpm_permanent_flags *pflags); @@ -519,7 +519,7 @@ u32 tpm1_get_permanent_flags(struct udevice *dev, * * @param dev TPM device * @param perm Returns permissions value - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_permissions(struct udevice *dev, u32 index, u32 *perm); @@ -529,7 +529,7 @@ u32 tpm1_get_permissions(struct udevice *dev, u32 index, u32 *perm); * @param dev TPM device * @param key_handle handle of the resource * @param resource_type type of the resource - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); @@ -541,7 +541,7 @@ u32 tpm1_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); * @param auth Usage auth of the key to search for * @param pubkey_digest SHA1 hash of the pub key structure of the key * @param[out] handle The handle of the key (Non-null iff found) - * @return 0 if key was found in TPM; != 0 if not. + * Return: 0 if key was found in TPM; != 0 if not. */ u32 tpm1_find_key_sha1(struct udevice *dev, const u8 auth[20], const u8 pubkey_digest[20], u32 *handle); @@ -555,7 +555,7 @@ u32 tpm1_find_key_sha1(struct udevice *dev, const u8 auth[20], * @param dev TPM device * @param data output buffer for the random bytes * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm1_get_random(struct udevice *dev, void *data, u32 count); @@ -563,7 +563,7 @@ u32 tpm1_get_random(struct udevice *dev, void *data, u32 count); * tpm_finalise_physical_presence() - Finalise physical presence * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm1_finalise_physical_presence(struct udevice *dev); @@ -571,7 +571,7 @@ u32 tpm1_finalise_physical_presence(struct udevice *dev); * tpm_nv_enable_locking() - lock the non-volatile space * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm1_nv_set_locked(struct udevice *dev); @@ -579,7 +579,7 @@ u32 tpm1_nv_set_locked(struct udevice *dev); * tpm_set_global_lock() - set the global lock * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_set_global_lock(struct udevice *dev); @@ -587,7 +587,7 @@ u32 tpm_set_global_lock(struct udevice *dev); * tpm_resume() - start up the TPM from resume (after suspend) * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm1_resume(struct udevice *dev); diff --git a/include/tpm-v2.h b/include/tpm-v2.h index 4e9dd52cb6..e79c90b939 100644 --- a/include/tpm-v2.h +++ b/include/tpm-v2.h @@ -425,7 +425,7 @@ enum { * @dev TPM device * @mode TPM startup mode * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_startup(struct udevice *dev, enum tpm2_startup_types mode); @@ -435,7 +435,7 @@ u32 tpm2_startup(struct udevice *dev, enum tpm2_startup_types mode); * @dev TPM device * @full_test Asking to perform all tests or only the untested ones * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_self_test(struct udevice *dev, enum tpm2_yes_no full_test); @@ -447,7 +447,7 @@ u32 tpm2_self_test(struct udevice *dev, enum tpm2_yes_no full_test); * @pw Password * @pw_sz Length of the password * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw, const ssize_t pw_sz); @@ -463,7 +463,7 @@ u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw, * @nv_attributes TPM_NV_ATTRIBUTES of the area * @nv_policy policy to use * @nv_policy_size size of the policy - * @return return code of the operation + * Return: return code of the operation */ u32 tpm2_nv_define_space(struct udevice *dev, u32 space_index, size_t space_size, u32 nv_attributes, @@ -478,7 +478,7 @@ u32 tpm2_nv_define_space(struct udevice *dev, u32 space_index, * @digest Value representing the event to be recorded * @digest_len len of the hash * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_extend(struct udevice *dev, u32 index, u32 algorithm, const u8 *digest, u32 digest_len); @@ -490,7 +490,7 @@ u32 tpm2_pcr_extend(struct udevice *dev, u32 index, u32 algorithm, * @index Index of data to read * @data Place to put data * @count Number of bytes of data - * @return code of the operation + * Return: code of the operation */ u32 tpm2_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); @@ -501,7 +501,7 @@ u32 tpm2_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); * @index Index of data to write * @data Data to write * @count Number of bytes of data - * @return code of the operation + * Return: code of the operation */ u32 tpm2_nv_write_value(struct udevice *dev, u32 index, const void *data, u32 count); @@ -517,7 +517,7 @@ u32 tpm2_nv_write_value(struct udevice *dev, u32 index, const void *data, * @digest_len len of the data * @updates Optional out parameter: number of updates for this PCR * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_read(struct udevice *dev, u32 idx, unsigned int idx_min_sz, u16 algorithm, void *data, u32 digest_len, @@ -533,7 +533,7 @@ u32 tpm2_pcr_read(struct udevice *dev, u32 idx, unsigned int idx_min_sz, * @buf Output buffer for capability information * @prop_count Size of output buffer * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_get_capability(struct udevice *dev, u32 capability, u32 property, void *buf, size_t prop_count); @@ -545,7 +545,7 @@ u32 tpm2_get_capability(struct udevice *dev, u32 capability, u32 property, * @pw Password * @pw_sz Length of the password * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_dam_reset(struct udevice *dev, const char *pw, const ssize_t pw_sz); @@ -559,7 +559,7 @@ u32 tpm2_dam_reset(struct udevice *dev, const char *pw, const ssize_t pw_sz); * @recovery_time Time before decrementation of the failure count * @lockout_recovery Time to wait after a lockout * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_dam_parameters(struct udevice *dev, const char *pw, const ssize_t pw_sz, unsigned int max_tries, @@ -576,7 +576,7 @@ u32 tpm2_dam_parameters(struct udevice *dev, const char *pw, * @oldpw Old password * @oldpw_sz Length of the old password * - * @return code of the operation + * Return: code of the operation */ int tpm2_change_auth(struct udevice *dev, u32 handle, const char *newpw, const ssize_t newpw_sz, const char *oldpw, @@ -591,7 +591,7 @@ int tpm2_change_auth(struct udevice *dev, u32 handle, const char *newpw, * @index Index of the PCR * @digest New key to access the PCR * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_setauthpolicy(struct udevice *dev, const char *pw, const ssize_t pw_sz, u32 index, const char *key); @@ -606,7 +606,7 @@ u32 tpm2_pcr_setauthpolicy(struct udevice *dev, const char *pw, * @digest New key to access the PCR * @key_sz Length of the new key * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_pcr_setauthvalue(struct udevice *dev, const char *pw, const ssize_t pw_sz, u32 index, const char *key, @@ -619,7 +619,7 @@ u32 tpm2_pcr_setauthvalue(struct udevice *dev, const char *pw, * @param data output buffer for the random bytes * @param count size of output buffer * - * @return return code of the operation + * Return: return code of the operation */ u32 tpm2_get_random(struct udevice *dev, void *data, u32 count); @@ -630,7 +630,7 @@ u32 tpm2_get_random(struct udevice *dev, void *data, u32 count); * * @dev TPM device * @index Index of data to lock - * @return code of the operation + * Return: code of the operation */ u32 tpm2_write_lock(struct udevice *dev, u32 index); @@ -641,7 +641,7 @@ u32 tpm2_write_lock(struct udevice *dev, u32 index); * before calling the kernel. * * @dev TPM device - * @return code of the operation + * Return: code of the operation */ u32 tpm2_disable_platform_hierarchy(struct udevice *dev); @@ -653,7 +653,7 @@ u32 tpm2_disable_platform_hierarchy(struct udevice *dev); * @recvbuf: Buffer to save the response to * @recv_size: Pointer to the size of the response buffer * - * @return code of the operation + * Return: code of the operation */ u32 tpm2_submit_command(struct udevice *dev, const u8 *sendbuf, u8 *recvbuf, size_t *recv_size); diff --git a/include/tpm_api.h b/include/tpm_api.h index f13d98cae4..ef45b43a8f 100644 --- a/include/tpm_api.h +++ b/include/tpm_api.h @@ -16,7 +16,7 @@ * * @param dev TPM device * @param mode TPM startup mode - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode); @@ -24,7 +24,7 @@ u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode); * Issue a TPM_SelfTestFull command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_self_test_full(struct udevice *dev); @@ -32,7 +32,7 @@ u32 tpm_self_test_full(struct udevice *dev); * Issue a TPM_ContinueSelfTest command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_continue_self_test(struct udevice *dev); @@ -45,7 +45,7 @@ u32 tpm_continue_self_test(struct udevice *dev); * @param index index of the area * @param perm TPM_NV_ATTRIBUTES of the area * @param size size of the area - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); @@ -58,7 +58,7 @@ u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); * @param index index of the area * @param data output buffer of the area contents * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); @@ -71,7 +71,7 @@ u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); * @param index index of the area * @param data input buffer to be wrote to the area * @param length length of data bytes of input buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data, u32 length); @@ -85,7 +85,7 @@ u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data, * recorded * @param out_digest 160-bit PCR value after execution of the * command - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_pcr_extend(struct udevice *dev, u32 index, const void *in_digest, void *out_digest); @@ -97,7 +97,7 @@ u32 tpm_pcr_extend(struct udevice *dev, u32 index, const void *in_digest, * @param index index of the PCR * @param data output buffer for contents of the named PCR * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); @@ -107,7 +107,7 @@ u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); * * @param dev TPM device * @param presence TPM physical presence flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence); @@ -117,7 +117,7 @@ u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence); * @param dev TPM device * @param data output buffer for the public endorsement key * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_read_pubek(struct udevice *dev, void *data, size_t count); @@ -125,7 +125,7 @@ u32 tpm_read_pubek(struct udevice *dev, void *data, size_t count); * Issue a TPM_ForceClear command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_force_clear(struct udevice *dev); @@ -133,7 +133,7 @@ u32 tpm_force_clear(struct udevice *dev); * Issue a TPM_PhysicalEnable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_physical_enable(struct udevice *dev); @@ -141,7 +141,7 @@ u32 tpm_physical_enable(struct udevice *dev); * Issue a TPM_PhysicalDisable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_physical_disable(struct udevice *dev); @@ -150,7 +150,7 @@ u32 tpm_physical_disable(struct udevice *dev); * * @param dev TPM device * @param state boolean state of the deactivated flag - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state); @@ -164,7 +164,7 @@ u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state); * limited to be 4-byte wide * @param cap output buffer for capability information * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, void *cap, size_t count); @@ -174,7 +174,7 @@ u32 tpm_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, * * @param dev TPM device * @param auth_handle handle of the auth session - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle); @@ -187,7 +187,7 @@ u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle); * * @param dev TPM device * @param auth_handle pointer to the (new) auth handle or NULL. - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_oiap(struct udevice *dev, u32 *auth_handle); @@ -195,7 +195,7 @@ u32 tpm_oiap(struct udevice *dev, u32 *auth_handle); * Ends an active OIAP session. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_end_oiap(struct udevice *dev); @@ -209,7 +209,7 @@ u32 tpm_end_oiap(struct udevice *dev); * @param key_length size of the key structure * @param parent_key_usage_auth usage auth for the parent key * @param key_handle pointer to the key handle - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, size_t key_length, const void *parent_key_usage_auth, @@ -227,7 +227,7 @@ u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, * @param pubkey_len pointer to the pub key buffer len. On entry: the size of * the provided pubkey buffer. On successful exit: the size * of the stored TPM_PUBKEY structure (iff pubkey != NULL). - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_pub_key_oiap(struct udevice *dev, u32 key_handle, const void *usage_auth, void *pubkey, @@ -238,7 +238,7 @@ u32 tpm_get_pub_key_oiap(struct udevice *dev, u32 key_handle, * * @param dev TPM device * @param perm Returns permissions value - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm); @@ -248,7 +248,7 @@ u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm); * @param dev TPM device * @param key_handle handle of the resource * @param resource_type type of the resource - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); @@ -260,7 +260,7 @@ u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); * @param auth Usage auth of the key to search for * @param pubkey_digest SHA1 hash of the pub key structure of the key * @param[out] handle The handle of the key (Non-null iff found) - * @return 0 if key was found in TPM; != 0 if not. + * Return: 0 if key was found in TPM; != 0 if not. */ u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20], const u8 pubkey_digest[20], u32 *handle); @@ -274,7 +274,7 @@ u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20], * @param dev TPM device * @param data output buffer for the random bytes * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ u32 tpm_get_random(struct udevice *dev, void *data, u32 count); @@ -282,7 +282,7 @@ u32 tpm_get_random(struct udevice *dev, void *data, u32 count); * tpm_finalise_physical_presence() - Finalise physical presence * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_finalise_physical_presence(struct udevice *dev); @@ -290,7 +290,7 @@ u32 tpm_finalise_physical_presence(struct udevice *dev); * tpm_nv_enable_locking() - lock the non-volatile space * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_nv_enable_locking(struct udevice *dev); @@ -298,7 +298,7 @@ u32 tpm_nv_enable_locking(struct udevice *dev); * tpm_set_global_lock() - set the global lock * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_set_global_lock(struct udevice *dev); @@ -307,7 +307,7 @@ u32 tpm_set_global_lock(struct udevice *dev); * * @param dev TPM device * @param index Index of space to lock - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_write_lock(struct udevice *dev, u32 index); @@ -315,7 +315,7 @@ u32 tpm_write_lock(struct udevice *dev, u32 index); * tpm_resume() - start up the TPM from resume (after suspend) * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_resume(struct udevice *dev); diff --git a/include/tps6586x.h b/include/tps6586x.h index aa4270c65e..b89074b8ac 100644 --- a/include/tps6586x.h +++ b/include/tps6586x.h @@ -20,7 +20,7 @@ enum { * Enable PWM mode for selected SM0-2 * * @param mask Mask of synchronous converter to enable (TPS6586X_PWM_...) - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int tps6586x_set_pwm_mode(int mask); @@ -36,7 +36,7 @@ int tps6586x_set_pwm_mode(int mask); * If this condition is not met, no adjustment will be * done and an error will be reported. Use -1 to skip * this check. - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int tps6586x_adjust_sm0_sm1(int sm0_target, int sm1_target, int step, int rate, int min_sm0_over_sm1); @@ -46,7 +46,7 @@ int tps6586x_adjust_sm0_sm1(int sm0_target, int sm1_target, int step, int rate, * on the device. This function must be called before using other functions. * * @param bus I2C bus containing the TPS6586X chip - * @return 0 (always succeeds) + * Return: 0 (always succeeds) */ int tps6586x_init(struct udevice *bus); diff --git a/include/trace.h b/include/trace.h index 606dba9768..e7aee024f0 100644 --- a/include/trace.h +++ b/include/trace.h @@ -55,7 +55,7 @@ void trace_print_stats(void); * @param buff Buffer in which to place data, or NULL to count size * @param buff_size Size of buffer * @param needed Returns number of bytes used / needed - * @return 0 if ok, -1 on error (buffer exhausted) + * Return: 0 if ok, -1 on error (buffer exhausted) */ int trace_list_functions(void *buff, size_t buff_size, size_t *needed); diff --git a/include/u-boot/crc.h b/include/u-boot/crc.h index bfd477f31d..52ec6a9e2d 100644 --- a/include/u-boot/crc.h +++ b/include/u-boot/crc.h @@ -21,7 +21,7 @@ * @crc_start: CRC8 start value * @vptr: Buffer to checksum * @len: Length of buffer in bytes - * @return CRC8 checksum + * Return: CRC8 checksum */ unsigned int crc8(unsigned int crc_start, const unsigned char *vptr, int len); @@ -48,7 +48,7 @@ void crc16_ccitt_wd_buf(const uint8_t *in, uint len, * calculation) * @buf: Bytes to checksum * @len: Number of bytes to checksum - * @return checksum value + * Return: checksum value */ uint32_t crc32(uint32_t crc, const unsigned char *buf, uint len); @@ -63,7 +63,7 @@ uint32_t crc32(uint32_t crc, const unsigned char *buf, uint len); * @buf: Bytes to checksum * @len: Number of bytes to checksum * @chunk_sz: Chunk size to use between watchdog resets - * @return checksum + * Return: checksum */ uint32_t crc32_wd(uint32_t crc, const unsigned char *buf, uint len, uint chunk_sz); @@ -78,7 +78,7 @@ uint32_t crc32_wd(uint32_t crc, const unsigned char *buf, uint len, * calculation) * @buf: Bytes to checksum * @len: Number of bytes to checksum - * @return checksum value + * Return: checksum value */ uint32_t crc32_no_comp(uint32_t crc, const unsigned char *buf, uint len); @@ -115,7 +115,7 @@ void crc32c_init(uint32_t *crc32c_table, uint32_t pol); * @data: Data bytes to checksum * @length: Number of bytes to process * @crc32c_table:: CRC table - * @return checksum value + * Return: checksum value */ uint32_t crc32c_cal(uint32_t crc, const char *data, int length, uint32_t *crc32c_table); diff --git a/include/u-boot/ecdsa.h b/include/u-boot/ecdsa.h index f6951c7346..0ceb0c1a08 100644 --- a/include/u-boot/ecdsa.h +++ b/include/u-boot/ecdsa.h @@ -57,7 +57,7 @@ int ecdsa_add_verify_data(struct image_sign_info *info, void *keydest); * @data_len: Data length * @sig: Signature * @sig_len: Number of bytes in signature - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ int ecdsa_verify(struct image_sign_info *info, const struct image_region region[], int region_count, diff --git a/include/u-boot/fdt-libcrypto.h b/include/u-boot/fdt-libcrypto.h index 5142f37039..b15d8a1eaf 100644 --- a/include/u-boot/fdt-libcrypto.h +++ b/include/u-boot/fdt-libcrypto.h @@ -19,7 +19,7 @@ * @prop_name: What to call the property in the FDT * @num: pointer to a libcrypto big number * @num_bits: How big is 'num' in bits? - * @return 0 if all good all working, -ve on horror + * Return: 0 if all good all working, -ve on horror */ int fdt_add_bignum(void *blob, int noffset, const char *prop_name, BIGNUM *num, int num_bits); diff --git a/include/u-boot/hash-checksum.h b/include/u-boot/hash-checksum.h index 7f16b37a9a..bcc6ba48fc 100644 --- a/include/u-boot/hash-checksum.h +++ b/include/u-boot/hash-checksum.h @@ -21,7 +21,7 @@ struct image_region; * @region_count: Number of regions in the region array * @checksum: Buffer contanining the output hash * - * @return 0 if OK, < 0 if error + * Return: 0 if OK, < 0 if error */ int hash_calculate(const char *name, const struct image_region *region, int region_count, diff --git a/include/u-boot/lz4.h b/include/u-boot/lz4.h index 1276fb98a3..e18b39a5dc 100644 --- a/include/u-boot/lz4.h +++ b/include/u-boot/lz4.h @@ -13,7 +13,7 @@ * @srcn: Length of source data * @dst: Destination for uncompressed data * @dstn: Returns length of uncompressed data - * @return 0 if OK, -EPROTONOSUPPORT if the magic number or version number are + * Return: 0 if OK, -EPROTONOSUPPORT if the magic number or version number are * not recognised or independent blocks are used, -EINVAL if the reserved * fields are non-zero, or input is overrun, -EENOBUFS if the destination * buffer is overrun, -EEPROTO if the compressed data causes an error in diff --git a/include/u-boot/rsa.h b/include/u-boot/rsa.h index 7556aa5b4b..2ed2ac7e53 100644 --- a/include/u-boot/rsa.h +++ b/include/u-boot/rsa.h @@ -75,7 +75,7 @@ int rsa_add_verify_data(struct image_sign_info *info, void *keydest); * @hash: Hash according to algorithm specified in @info * @sig: Signature * @sig_len: Number of bytes in signature - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ int rsa_verify_hash(struct image_sign_info *info, const uint8_t *hash, uint8_t *sig, uint sig_len); @@ -90,7 +90,7 @@ int rsa_verify_hash(struct image_sign_info *info, * @data_len: Data length * @sig: Signature * @sig_len: Number of bytes in signature - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ int rsa_verify(struct image_sign_info *info, const struct image_region region[], int region_count, diff --git a/include/ufs.h b/include/ufs.h index bda135cf18..702b8359db 100644 --- a/include/ufs.h +++ b/include/ufs.h @@ -7,7 +7,7 @@ struct udevice; /** * ufs_probe() - initialize all devices in the UFS uclass * - * @return 0 if Ok, -ve on error + * Return: 0 if Ok, -ve on error */ int ufs_probe(void); @@ -16,7 +16,7 @@ int ufs_probe(void); * * @index: index in the uclass sequence * - * @return 0 if successfully probed, -ve on error + * Return: 0 if successfully probed, -ve on error */ int ufs_probe_dev(int index); @@ -26,7 +26,7 @@ int ufs_probe_dev(int index); * @ufs_dev: UFS device * @scsi_devp: Pointer to scsi device * - * @return 0 if Ok, -ve on error + * Return: 0 if Ok, -ve on error */ int ufs_scsi_bind(struct udevice *ufs_dev, struct udevice **scsi_devp); #endif diff --git a/include/usb.h b/include/usb.h index b3851fdb4f..f032de8af9 100644 --- a/include/usb.h +++ b/include/usb.h @@ -832,7 +832,7 @@ struct usb_device *usb_get_dev_index(struct udevice *bus, int index); * @do_read: true to read the device descriptor before an address is set * (should be false for XHCI buses, true otherwise) * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB) - * @return 0 if OK, -ve on error */ + * Return: 0 if OK, -ve on error */ int usb_setup_device(struct usb_device *dev, bool do_read, struct usb_device *parent); @@ -862,7 +862,7 @@ int usb_hub_scan(struct udevice *hub); * @port: Hub port number (numbered from 1) * @speed: USB speed to use for this device * @devp: Returns pointer to device if all is well - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_scan_device(struct udevice *parent, int port, enum usb_device_speed speed, struct udevice **devp); @@ -874,7 +874,7 @@ int usb_scan_device(struct udevice *parent, int port, * will be a device with uclass UCLASS_USB. * * @dev: Device to check - * @return The bus, or NULL if not found (this indicates a critical error in + * Return: The bus, or NULL if not found (this indicates a critical error in * the USB stack */ struct udevice *usb_get_bus(struct udevice *dev); @@ -967,7 +967,7 @@ void usb_find_usb2_hub_address_port(struct usb_device *udev, * @devp: returns a pointer of a new device structure. With driver model this * is a device pointer, but with legacy USB this pointer is * driver-specific. - * @return 0 if OK, -ENOSPC if we have found out of room for new devices + * Return: 0 if OK, -ENOSPC if we have found out of room for new devices */ int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp); @@ -990,7 +990,7 @@ int usb_alloc_device(struct usb_device *dev); * representation of this hub can be updated. * * @dev: Hub device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_update_hub_device(struct usb_device *dev); @@ -1002,7 +1002,7 @@ int usb_update_hub_device(struct usb_device *dev); * * @dev: USB device * @size: maximum transfer bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_get_max_xfer_size(struct usb_device *dev, size_t *size); @@ -1018,7 +1018,7 @@ int usb_get_max_xfer_size(struct usb_device *dev, size_t *size); * @desc_list: List of points or USB descriptors, terminated by NULL. * The first entry must be struct usb_device_descriptor, * and others follow on after that. - * @return 0 if OK, -ENOSYS if not implemented, other -ve on error + * Return: 0 if OK, -ENOSYS if not implemented, other -ve on error */ int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings, void **desc_list); @@ -1029,7 +1029,7 @@ int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings, * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_emul_control(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length, @@ -1041,7 +1041,7 @@ int usb_emul_control(struct udevice *emul, struct usb_device *udev, * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_emul_bulk(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length); @@ -1052,7 +1052,7 @@ int usb_emul_bulk(struct udevice *emul, struct usb_device *udev, * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_emul_int(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length, int interval, @@ -1067,7 +1067,7 @@ int usb_emul_int(struct udevice *emul, struct usb_device *udev, * @pipe: Describes pipe being used, and includes the device number * @port1: Describes port number on the parent hub * @emulp: Returns pointer to emulator, or NULL if not found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int usb_emul_find(struct udevice *bus, ulong pipe, int port1, struct udevice **emulp); @@ -1077,7 +1077,7 @@ int usb_emul_find(struct udevice *bus, ulong pipe, int port1, * * @dev: USB device to check * @emulp: Returns pointer to emulator, or NULL if not found - * @return 0 if found, -ve on error + * Return: 0 if found, -ve on error */ int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp); @@ -1087,7 +1087,7 @@ int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp); * @ptr: a pointer to a list of USB descriptor pointers * @type: type of USB descriptor to find * @index: if @type is USB_DT_CONFIG, this is the configuration value - * @return a pointer to the USB descriptor found, NULL if not found + * Return: a pointer to the USB descriptor found, NULL if not found */ struct usb_generic_descriptor **usb_emul_find_descriptor( struct usb_generic_descriptor **ptr, int type, int index); diff --git a/include/usb/xhci.h b/include/usb/xhci.h index 01e63cf0fc..ea4cf3f52b 100644 --- a/include/usb/xhci.h +++ b/include/usb/xhci.h @@ -1265,7 +1265,7 @@ int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr, * xhci_deregister() - Unregister an XHCI controller * * @dev: Controller device - * @return 0 if registered, -ve on error + * Return: 0 if registered, -ve on error */ int xhci_deregister(struct udevice *dev); @@ -1275,7 +1275,7 @@ int xhci_deregister(struct udevice *dev); * @dev: Controller device * @hccr: Host controller control registers * @hcor: Not sure what this means - * @return 0 if registered, -ve on error + * Return: 0 if registered, -ve on error */ int xhci_register(struct udevice *dev, struct xhci_hccr *hccr, struct xhci_hcor *hcor); diff --git a/include/usb_ether.h b/include/usb_ether.h index e85acadb7f..8c7bd06906 100644 --- a/include/usb_ether.h +++ b/include/usb_ether.h @@ -43,7 +43,7 @@ struct ueth_data { * @dev: USB device * @ss: Place to put USB ethernet data * @rxsize: Maximum size to allocate for the receive buffer - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize); @@ -51,7 +51,7 @@ int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize); * usb_ether_deregister() - deregister a USB ethernet device * * @ueth: USB Ethernet device - * @return 0 + * Return: 0 */ int usb_ether_deregister(struct ueth_data *ueth); @@ -62,7 +62,7 @@ int usb_ether_deregister(struct ueth_data *ueth); * * @ueth: USB Ethernet device * @rxsize: Maximum size to receive - * @return 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is + * Return: 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is * larger than the size passed ot usb_ether_register(), other -ve on error */ int usb_ether_receive(struct ueth_data *ueth, int rxsize); @@ -77,7 +77,7 @@ int usb_ether_receive(struct ueth_data *ueth, int rxsize); * @ueth: USB Ethernet device * @ptrp: Returns a pointer to the start of the next packet if there is * one available - * @return number of bytes available, or 0 if none + * Return: number of bytes available, or 0 if none */ int usb_ether_get_rx_bytes(struct ueth_data *ueth, uint8_t **ptrp); diff --git a/include/video.h b/include/video.h index 1d75a90510..48a71dc237 100644 --- a/include/video.h +++ b/include/video.h @@ -151,7 +151,7 @@ struct video_ops { * * @addrp: On entry, the top of available memory. On exit, the new top, * after allocating the required memory. - * @return 0 + * Return: 0 */ int video_reserve(ulong *addrp); @@ -160,7 +160,7 @@ int video_reserve(ulong *addrp); * video_clear() - Clear a device's frame buffer to background color. * * @dev: Device to clear - * @return 0 + * Return: 0 */ int video_clear(struct udevice *dev); #endif /* CONFIG_DM_VIDEO */ @@ -202,7 +202,7 @@ void video_sync_all(void); * - if a coordinate is -ve then it will be offset to the * left/top of the centre by that many pixels * - if a coordinate is positive it will be used unchnaged. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y, bool align); @@ -211,7 +211,7 @@ int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y, * video_get_xsize() - Get the width of the display in pixels * * @dev: Device to check - * @return device frame buffer width in pixels + * Return: device frame buffer width in pixels */ int video_get_xsize(struct udevice *dev); @@ -219,7 +219,7 @@ int video_get_xsize(struct udevice *dev); * video_get_ysize() - Get the height of the display in pixels * * @dev: Device to check - * @return device frame buffer height in pixels + * Return: device frame buffer height in pixels */ int video_get_ysize(struct udevice *dev); @@ -251,7 +251,7 @@ void video_set_default_colors(struct udevice *dev, bool invert); * @dev: Vidconsole device being updated * @from: Start/end address within the framebuffer (->fb) * @to: Other address within the frame buffer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int video_sync_copy(struct udevice *dev, void *from, void *to); @@ -260,7 +260,7 @@ int video_sync_copy(struct udevice *dev, void *from, void *to); * video_sync_copy_all() - Sync the entire framebuffer to the copy * * @dev: Vidconsole device being updated - * @return 0 (always) + * Return: 0 (always) */ int video_sync_copy_all(struct udevice *dev); #else @@ -279,7 +279,7 @@ static inline int video_sync_copy_all(struct udevice *dev) /** * video_is_active() - Test if one video device it active * - * @return true if at least one video device is active, else false. + * Return: true if at least one video device is active, else false. */ bool video_is_active(void); @@ -299,28 +299,28 @@ int video_display_bitmap(ulong bmp_image, int x, int y); /** * Get the width of the screen in pixels * - * @return width of screen in pixels + * Return: width of screen in pixels */ int video_get_pixel_width(void); /** * Get the height of the screen in pixels * - * @return height of screen in pixels + * Return: height of screen in pixels */ int video_get_pixel_height(void); /** * Get the number of text lines/rows on the screen * - * @return number of rows + * Return: number of rows */ int video_get_screen_rows(void); /** * Get the number of text columns on the screen * - * @return number of columns + * Return: number of columns */ int video_get_screen_columns(void); diff --git a/include/video_bridge.h b/include/video_bridge.h index 22e93dbb53..3b429eac57 100644 --- a/include/video_bridge.h +++ b/include/video_bridge.h @@ -70,7 +70,7 @@ struct video_bridge_ops { /** * video_bridge_attach() - attach a video bridge * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bridge_attach(struct udevice *dev); @@ -78,7 +78,7 @@ int video_bridge_attach(struct udevice *dev); * video_bridge_set_backlight() - Set the backlight brightness * * @percent: brightness percentage (0=off, 100=full brightness) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int video_bridge_set_backlight(struct udevice *dev, int percent); @@ -94,7 +94,7 @@ int video_bridge_set_active(struct udevice *dev, bool active); * check_attached() - check if a bridge is correctly attached * * @dev: Device to check - * @return 0 if attached, -EENOTCONN if not, or other -ve error + * Return: 0 if attached, -EENOTCONN if not, or other -ve error */ int video_bridge_check_attached(struct udevice *dev); @@ -104,7 +104,7 @@ int video_bridge_check_attached(struct udevice *dev); * @dev: Device to read from * @buf: Buffer to read into * @buf_size: Buffer size - * @return number of bytes read, <=0 for error + * Return: number of bytes read, <=0 for error */ int video_bridge_read_edid(struct udevice *dev, u8 *buf, int buf_size); diff --git a/include/video_console.h b/include/video_console.h index 06b798ef10..5921767fbf 100644 --- a/include/video_console.h +++ b/include/video_console.h @@ -170,7 +170,7 @@ struct vidconsole_ops { * is the X position multipled by VID_FRAC_DIV. * @y: Pixel Y position (0=top-most pixel) * @ch: Character to write - * @return number of fractional pixels that the cursor should move, + * Return: number of fractional pixels that the cursor should move, * if all is OK, -EAGAIN if we ran out of space on this line, other -ve * on error */ @@ -183,7 +183,7 @@ int vidconsole_putc_xy(struct udevice *dev, uint x, uint y, char ch); * @rowdst: Destination text row (0=top) * @rowsrc: Source start text row * @count: Number of text rows to move - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc, uint count); @@ -196,7 +196,7 @@ int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc, * @dev: Device to adjust * @row: Text row to adjust (0=top) * @clr: Raw colour (pixel value) to write to each pixel - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_set_row(struct udevice *dev, uint row, int clr); @@ -212,7 +212,7 @@ int vidconsole_set_row(struct udevice *dev, uint row, int clr); * * @dev: Device to adjust * @ch: Character to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_put_char(struct udevice *dev, char ch); @@ -228,7 +228,7 @@ int vidconsole_put_char(struct udevice *dev, char ch); * * @dev: Device to adjust * @str: String to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int vidconsole_put_string(struct udevice *dev, const char *str); @@ -238,7 +238,7 @@ int vidconsole_put_string(struct udevice *dev, const char *str); * @dev: Device to adjust * @col: New cursor text column * @row: New cursor text row - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ void vidconsole_position_cursor(struct udevice *dev, unsigned col, unsigned row); @@ -252,7 +252,7 @@ void vidconsole_position_cursor(struct udevice *dev, unsigned col, * * @priv private data of the console device * @idx color index - * @return color value + * Return: color value */ u32 vid_console_color(struct video_priv *priv, unsigned int idx); @@ -268,7 +268,7 @@ u32 vid_console_color(struct video_priv *priv, unsigned int idx); * @dev: Vidconsole device being updated * @from: Start/end address within the framebuffer (->fb) * @to: Other address within the frame buffer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int vidconsole_sync_copy(struct udevice *dev, void *from, void *to); @@ -283,7 +283,7 @@ int vidconsole_sync_copy(struct udevice *dev, void *from, void *to); * @dst: Destination address within the framebuffer (->fb) * @src: Source address within the framebuffer (->fb) * @size: Number of bytes to transfer - * @return 0 if OK, -EFAULT if the start address is before the start of the + * Return: 0 if OK, -EFAULT if the start address is before the start of the * frame buffer start */ int vidconsole_memmove(struct udevice *dev, void *dst, const void *src, diff --git a/include/video_osd.h b/include/video_osd.h index 01ac94b425..dc60bafa8a 100644 --- a/include/video_osd.h +++ b/include/video_osd.h @@ -125,7 +125,7 @@ struct video_osd_ops { * @dev: OSD instance to query. * @info: Pointer to a structure that takes the information read from the * OSD instance. - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_get_info(struct udevice *dev, struct video_osd_info *info); @@ -155,7 +155,7 @@ int video_osd_get_info(struct udevice *dev, struct video_osd_info *info); * coordinate on the OSD screen. * @buflen: Length of the data in the passed buffer (in byte). * @count: Write count many repetitions of the given text data - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_set_mem(struct udevice *dev, uint col, uint row, u8 *buf, size_t buflen, uint count); @@ -167,7 +167,7 @@ int video_osd_set_mem(struct udevice *dev, uint col, uint row, u8 *buf, * @dev: OSD instance to write to. * @col The number of characters in the window's columns * @row The number of characters in the window's rows - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_set_size(struct udevice *dev, uint col, uint row); @@ -184,7 +184,7 @@ int video_osd_set_size(struct udevice *dev, uint col, uint row); * interpretation of the value is driver-specific, and possible * values should be defined e.g. in a driver include file. * @text: The string data that should be printed on the OSD - * @return 0 if OK, -ve on error. + * Return: 0 if OK, -ve on error. */ int video_osd_print(struct udevice *dev, uint col, uint row, ulong color, char *text); diff --git a/include/virtio.h b/include/virtio.h index 34e2bfdcdd..062a24630c 100644 --- a/include/virtio.h +++ b/include/virtio.h @@ -228,7 +228,7 @@ struct virtio_dev_priv { * @offset: the offset of the configuration field * @buf: the buffer to write the field value into * @len: the length of the buffer - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_get_config(struct udevice *vdev, unsigned int offset, void *buf, unsigned int len); @@ -240,7 +240,7 @@ int virtio_get_config(struct udevice *vdev, unsigned int offset, * @offset: the offset of the configuration field * @buf: the buffer to read the field value from * @len: the length of the buffer - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_set_config(struct udevice *vdev, unsigned int offset, void *buf, unsigned int len); @@ -250,7 +250,7 @@ int virtio_set_config(struct udevice *vdev, unsigned int offset, * * @vdev: the real virtio device * @counter: the returned config generation counter - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_generation(struct udevice *vdev, u32 *counter); @@ -259,7 +259,7 @@ int virtio_generation(struct udevice *vdev, u32 *counter); * * @vdev: the real virtio device * @status: the returned status byte - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_get_status(struct udevice *vdev, u8 *status); @@ -268,7 +268,7 @@ int virtio_get_status(struct udevice *vdev, u8 *status); * * @vdev: the real virtio device * @status: the new status byte - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_set_status(struct udevice *vdev, u8 status); @@ -276,7 +276,7 @@ int virtio_set_status(struct udevice *vdev, u8 status); * virtio_reset() - reset the device * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_reset(struct udevice *vdev); @@ -285,7 +285,7 @@ int virtio_reset(struct udevice *vdev); * * @vdev: the real virtio device * @features: the first 32 feature bits (all we currently need) - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_get_features(struct udevice *vdev, u64 *features); @@ -293,7 +293,7 @@ int virtio_get_features(struct udevice *vdev, u64 *features); * virtio_set_features() - confirm what device features we'll be using * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_set_features(struct udevice *vdev); @@ -303,7 +303,7 @@ int virtio_set_features(struct udevice *vdev); * @vdev: the real virtio device * @nvqs: the number of virtqueues to find * @vqs: on success, includes new virtqueues - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs, struct virtqueue *vqs[]); @@ -312,7 +312,7 @@ int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs, * virtio_del_vqs() - free virtqueues found by find_vqs() * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_del_vqs(struct udevice *vdev); @@ -321,7 +321,7 @@ int virtio_del_vqs(struct udevice *vdev); * * @vdev: the real virtio device * @vq: virtqueue to process - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_notify(struct udevice *vdev, struct virtqueue *vq); @@ -337,7 +337,7 @@ void virtio_add_status(struct udevice *vdev, u8 status); * virtio_finalize_features() - helper to finalize features * * @vdev: the real virtio device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_finalize_features(struct udevice *vdev); @@ -366,7 +366,7 @@ void virtio_driver_features_init(struct virtio_dev_priv *priv, /** * virtio_init() - helper to enumerate all known virtio devices * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int virtio_init(void); diff --git a/include/vsprintf.h b/include/vsprintf.h index 8bfafa0d33..532ef3650b 100644 --- a/include/vsprintf.h +++ b/include/vsprintf.h @@ -16,7 +16,7 @@ * @param cp The string to be converted * @param endp Updated to point to the first character not converted * @param base The number base to use (0 for the default) - * @return value decoded from string (0 if invalid) + * Return: value decoded from string (0 if invalid) * * Converts a string to an unsigned long. If there are invalid characters at * the end these are ignored. In the worst case, if all characters are invalid, @@ -36,7 +36,7 @@ ulong simple_strtoul(const char *cp, char **endp, unsigned int base); * * @param cp The string to be converted * @param endp Updated to point to the first character not converted - * @return value decoded from string (0 if invalid) + * Return: value decoded from string (0 if invalid) * * Converts a hex string to an unsigned long. If there are invalid characters at * the end these are ignored. In the worst case, if all characters are invalid, @@ -49,7 +49,7 @@ unsigned long hextoul(const char *cp, char **endp); * * @param cp The string to be converted * @param endp Updated to point to the first character not converted - * @return value decoded from string (0 if invalid) + * Return: value decoded from string (0 if invalid) * * Converts a decimal string to an unsigned long. If there are invalid * characters at the end these are ignored. In the worst case, if all characters @@ -62,7 +62,7 @@ unsigned long dectoul(const char *cp, char **endp); * @param cp The string to be converted * @param base The number base to use (0 for the default) * @param res The converted result value - * @return 0 if conversion is successful and *res is set to the converted + * Return: 0 if conversion is successful and *res is set to the converted * value, otherwise it returns -EINVAL and *res is set to 0. * * strict_strtoul converts a string to an unsigned long only if the @@ -99,7 +99,7 @@ long long simple_strtoll(const char *cp, char **endp, unsigned int base); * For example, "abc123" would return 123. * * @str: String to exxamine - * @return training number if found, else -1 + * Return: training number if found, else -1 */ long trailing_strtol(const char *str); @@ -114,7 +114,7 @@ long trailing_strtol(const char *str); * @str: String to exxamine * @end: Pointer to end of string to examine, or NULL to use the * whole string - * @return training number if found, else -1 + * Return: training number if found, else -1 */ long trailing_strtoln(const char *str, const char *end); @@ -164,7 +164,7 @@ int sprintf(char *buf, const char *fmt, ...) * @param buf The buffer to place the result into * @param fmt The format string to use * @param args Arguments for the format string - * @return the number of characters which have been written into + * Return: the number of characters which have been written into * the @buf not including the trailing '\0'. * * If you're not already dealing with a va_list consider using scnprintf(). @@ -181,7 +181,7 @@ int vsprintf(char *buf, const char *fmt, va_list args); * simple_... functions, so should be used immediately * * @val: Value to convert - * @return string containing the decimal representation of @val + * Return: string containing the decimal representation of @val */ char *simple_itoa(ulong val); @@ -193,7 +193,7 @@ char *simple_itoa(ulong val); * simple_... functions, so should be used immediately * * @val: Value to convert - * @return string containing the hexecimal representation of @val + * Return: string containing the hexecimal representation of @val */ char *simple_xtoa(ulong num); @@ -204,7 +204,7 @@ char *simple_xtoa(ulong num); * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param ... Arguments for the format string - * @return the number of characters which would be + * Return: the number of characters which would be * generated for the given input, excluding the trailing null, * as per ISO C99. If the return is greater than or equal to * @size, the resulting string is truncated. @@ -237,7 +237,7 @@ int scnprintf(char *buf, size_t size, const char *fmt, ...) * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param args Arguments for the format string - * @return The number characters which would be generated for the given + * Return: The number characters which would be generated for the given * input, excluding the trailing '\0', as per ISO C99. Note that fewer * characters may be written if this number of characters is >= size. * @@ -262,7 +262,7 @@ int vsnprintf(char *buf, size_t size, const char *fmt, va_list args); * @param size The size of the buffer, including the trailing null space * @param fmt The format string to use * @param args Arguments for the format string - * @return the number of characters which have been written into + * Return: the number of characters which have been written into * the @buf not including the trailing '\0'. If @size is == 0 the function * returns 0. * diff --git a/include/wait_bit.h b/include/wait_bit.h index dc2ffeb2c2..dcc5c4fd39 100644 --- a/include/wait_bit.h +++ b/include/wait_bit.h @@ -31,7 +31,7 @@ * @param set Selects wait condition (bit set or clear) * @param timeout_ms Timeout (in milliseconds) * @param breakable Enables CTRL-C interruption - * @return 0 on success, -ETIMEDOUT or -EINTR on failure + * Return: 0 on success, -ETIMEDOUT or -EINTR on failure */ #define BUILD_WAIT_FOR_BIT(sfx, type, read) \ diff --git a/include/wdt.h b/include/wdt.h index baaa9db08a..5026f5a6db 100644 --- a/include/wdt.h +++ b/include/wdt.h @@ -60,7 +60,7 @@ int wdt_reset(struct udevice *dev); * * @dev: WDT Device * @flags: Driver specific flags - * @return 0 if OK -ve on error. If wdt action is system reset, + * Return: 0 if OK -ve on error. If wdt action is system reset, * this function may never return. */ int wdt_expire_now(struct udevice *dev, ulong flags); diff --git a/lib/acpi/acpi_device.c b/lib/acpi/acpi_device.c index b5f2cebbde..1b838fdbd6 100644 --- a/lib/acpi/acpi_device.c +++ b/lib/acpi/acpi_device.c @@ -27,7 +27,7 @@ * @buf: Buffer to hold the path * @buf_len: Length of buffer * @cur: Current position in the buffer - * @return new position in buffer after adding @dev, or -ve on error + * Return: new position in buffer after adding @dev, or -ve on error */ static int acpi_device_path_fill(const struct udevice *dev, char *buf, size_t buf_len, int cur) @@ -97,7 +97,7 @@ enum acpi_dev_status acpi_device_status(const struct udevice *dev) * * Write a forward length for a large resource (2 bytes) * - * @return pointer to the zero word (for fixing up later) + * Return: pointer to the zero word (for fixing up later) */ static void *largeres_write_len_f(struct acpi_ctx *ctx) { @@ -597,7 +597,7 @@ static void acpi_device_write_i2c(struct acpi_ctx *ctx, * @dev: I2C device to convert * @i2c: Place to put the new structure * @scope: Scope of the I2C device (this is the controller path) - * @return chip address of device + * Return: chip address of device */ static int acpi_device_set_i2c(const struct udevice *dev, struct acpi_i2c *i2c, const char *scope) @@ -719,7 +719,7 @@ static void acpi_device_write_spi(struct acpi_ctx *ctx, const struct acpi_spi *s * @dev: SPI device to convert * @spi: Place to put the new structure * @scope: Scope of the SPI device (this is the controller path) - * @return 0 (always) + * Return: 0 (always) */ static int acpi_device_set_spi(const struct udevice *dev, struct acpi_spi *spi, const char *scope) diff --git a/lib/binman.c b/lib/binman.c index 530df6a4b4..cfe1e5f807 100644 --- a/lib/binman.c +++ b/lib/binman.c @@ -37,7 +37,7 @@ static struct binman_info *binman; * depends on whether multiple-images is in use. * * @nodep: Returns the node found, on success - * @return 0 if OK, , -EINVAL if there is no /binman node, -ECHILD if multiple + * Return: 0 if OK, , -EINVAL if there is no /binman node, -ECHILD if multiple * images are being used but the first image is not available */ static int find_image_node(ofnode *nodep) diff --git a/lib/efi/efi_app.c b/lib/efi/efi_app.c index 6980933d7e..1e5606c7b8 100644 --- a/lib/efi/efi_app.c +++ b/lib/efi/efi_app.c @@ -79,7 +79,7 @@ int efi_get_mmap(struct efi_mem_desc **descp, int *sizep, uint *keyp, * @device_path: EFI device path structure for this * @len: Length of @device_path in bytes * @devp: Returns the bound device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int efi_bind_block(efi_handle_t handle, struct efi_block_io *blkio, struct efi_device_path *device_path, int len, diff --git a/lib/efi/efi_stub.c b/lib/efi/efi_stub.c index 646cde3214..a35fce1385 100644 --- a/lib/efi/efi_stub.c +++ b/lib/efi/efi_stub.c @@ -152,7 +152,7 @@ static inline unsigned long read_cr3(void) * EFI we must first change to 32-bit mode. To do this we need to find the * correct code segment to use (an entry in the Global Descriptor Table). * - * @return code segment GDT offset, or 0 for 32-bit EFI, -ENOENT if not found + * Return: code segment GDT offset, or 0 for 32-bit EFI, -ENOENT if not found */ static int get_codeseg32(void) { diff --git a/lib/efi_loader/efi_acpi.c b/lib/efi_loader/efi_acpi.c index a62c34009c..83f025e1ca 100644 --- a/lib/efi_loader/efi_acpi.c +++ b/lib/efi_loader/efi_acpi.c @@ -15,7 +15,7 @@ static const efi_guid_t acpi_guid = EFI_ACPI_TABLE_GUID; /* * Install the ACPI table as a configuration table. * - * @return status code + * Return: status code */ efi_status_t efi_acpi_register(void) { diff --git a/lib/efi_loader/efi_device_path.c b/lib/efi_loader/efi_device_path.c index 735ed0bd0f..c61f485933 100644 --- a/lib/efi_loader/efi_device_path.c +++ b/lib/efi_loader/efi_device_path.c @@ -51,7 +51,7 @@ static const struct efi_device_path_vendor ROOT = { * Determine if an MMC device is an SD card. * * @desc block device descriptor - * @return true if the device is an SD card + * Return: true if the device is an SD card */ static bool is_sd(struct blk_desc *desc) { @@ -223,7 +223,7 @@ struct efi_object *efi_dp_find_obj(struct efi_device_path *dp, * Determine the last device path node that is not the end node. * * @dp device path - * @return last node before the end node if it exists + * Return: last node before the end node if it exists * otherwise NULL */ const struct efi_device_path *efi_dp_last_node(const struct efi_device_path *dp) @@ -572,7 +572,7 @@ __maybe_unused static unsigned int dp_size(struct udevice *dev) * * @buf pointer to the end of the device path * @dev device - * @return pointer to the end of the device path + * Return: pointer to the end of the device path */ __maybe_unused static void *dp_fill(void *buf, struct udevice *dev) { diff --git a/lib/efi_loader/efi_device_path_to_text.c b/lib/efi_loader/efi_device_path_to_text.c index 57fa9d97f7..d8a83c8849 100644 --- a/lib/efi_loader/efi_device_path_to_text.c +++ b/lib/efi_loader/efi_device_path_to_text.c @@ -225,7 +225,7 @@ static char *dp_msging(char *s, struct efi_device_path *dp) * * @s output buffer * @dp device path node - * @return next unused buffer address + * Return: next unused buffer address */ static char *dp_media(char *s, struct efi_device_path *dp) { @@ -310,7 +310,7 @@ static char *dp_media(char *s, struct efi_device_path *dp) * * @buffer output buffer * @dp device path or node - * @return end of string + * Return: end of string */ static char *efi_convert_single_device_node_to_text( char *buffer, @@ -350,7 +350,7 @@ static char *efi_convert_single_device_node_to_text( * device_node device node to be converted * display_only true if the shorter text representation shall be used * allow_shortcuts true if shortcut forms may be used - * @return text representation of the device path + * Return: text representation of the device path * NULL if out of memory of device_path is NULL */ static uint16_t EFIAPI *efi_convert_device_node_to_text( @@ -383,7 +383,7 @@ out: * device_path device path to be converted * display_only true if the shorter text representation shall be used * allow_shortcuts true if shortcut forms may be used - * @return text representation of the device path + * Return: text representation of the device path * NULL if out of memory of device_path is NULL */ static uint16_t EFIAPI *efi_convert_device_path_to_text( diff --git a/lib/efi_loader/efi_device_path_utilities.c b/lib/efi_loader/efi_device_path_utilities.c index 94015329c8..a07d9bab3a 100644 --- a/lib/efi_loader/efi_device_path_utilities.c +++ b/lib/efi_loader/efi_device_path_utilities.c @@ -22,7 +22,7 @@ const efi_guid_t efi_guid_device_path_utilities_protocol = * for details. * * @device_path device path - * @return size in bytes + * Return: size in bytes */ static efi_uintn_t EFIAPI get_device_path_size( const struct efi_device_path *device_path) @@ -50,7 +50,7 @@ static efi_uintn_t EFIAPI get_device_path_size( * for details. * * @device_path device path - * @return copy of the device path + * Return: copy of the device path */ static struct efi_device_path * EFIAPI duplicate_device_path( const struct efi_device_path *device_path) @@ -70,7 +70,7 @@ static struct efi_device_path * EFIAPI duplicate_device_path( * * @src1 1st device path * @src2 2nd device path - * @return concatenated device path + * Return: concatenated device path */ static struct efi_device_path * EFIAPI append_device_path( const struct efi_device_path *src1, @@ -91,7 +91,7 @@ static struct efi_device_path * EFIAPI append_device_path( * * @device_path device path * @device_node device node - * @return concatenated device path + * Return: concatenated device path */ static struct efi_device_path * EFIAPI append_device_node( const struct efi_device_path *device_path, @@ -112,7 +112,7 @@ static struct efi_device_path * EFIAPI append_device_node( * * @device_path 1st device path * @device_path_instance 2nd device path - * @return concatenated device path + * Return: concatenated device path */ static struct efi_device_path * EFIAPI append_device_path_instance( const struct efi_device_path *device_path, @@ -134,7 +134,7 @@ static struct efi_device_path * EFIAPI append_device_path_instance( * * @device_path_instance next device path instance * @device_path_instance_size size of the device path instance - * @return concatenated device path + * Return: concatenated device path */ static struct efi_device_path * EFIAPI get_next_device_path_instance( struct efi_device_path **device_path_instance, @@ -156,7 +156,7 @@ static struct efi_device_path * EFIAPI get_next_device_path_instance( * * @device_path device path * @device_node device node - * @return concatenated device path + * Return: concatenated device path */ static bool EFIAPI is_device_path_multi_instance( const struct efi_device_path *device_path) @@ -177,7 +177,7 @@ static bool EFIAPI is_device_path_multi_instance( * @node_type node type * @node_sub_type node sub type * @node_length node length - * @return device path node + * Return: device path node */ static struct efi_device_path * EFIAPI create_device_node( uint8_t node_type, uint8_t node_sub_type, uint16_t node_length) diff --git a/lib/efi_loader/efi_memory.c b/lib/efi_loader/efi_memory.c index 7f0b507281..1c51a3fc45 100644 --- a/lib/efi_loader/efi_memory.c +++ b/lib/efi_loader/efi_memory.c @@ -452,7 +452,7 @@ static uint64_t efi_find_free_memory(uint64_t len, uint64_t max_addr) * @memory_type usage type of the allocated memory * @pages number of pages to be allocated * @memory allocated memory - * @return status code + * Return: status code */ efi_status_t efi_allocate_pages(enum efi_allocate_type type, enum efi_memory_type memory_type, @@ -680,7 +680,7 @@ efi_status_t efi_free_pool(void *buffer) * @map_key key for the memory map * @descriptor_size size of an individual memory descriptor * @descriptor_version version number of the memory descriptor structure - * @return status code + * Return: status code */ efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size, struct efi_mem_desc *memory_map, diff --git a/lib/efi_loader/efi_smbios.c b/lib/efi_loader/efi_smbios.c index fc0b23397c..306c0bc54f 100644 --- a/lib/efi_loader/efi_smbios.c +++ b/lib/efi_loader/efi_smbios.c @@ -16,7 +16,7 @@ /* * Install the SMBIOS table as a configuration table. * - * @return status code + * Return: status code */ efi_status_t efi_smbios_register(void) { diff --git a/lib/efi_selftest/dtbdump.c b/lib/efi_selftest/dtbdump.c index f6ddaa3072..ed3b985cab 100644 --- a/lib/efi_selftest/dtbdump.c +++ b/lib/efi_selftest/dtbdump.c @@ -160,7 +160,7 @@ static efi_status_t efi_input(u16 *buffer, efi_uintn_t buffer_size) * Convert FDT value to host endianness. * * @val FDT value - * @return converted value + * Return: converted value */ static u32 f2h(fdt32_t val) { diff --git a/lib/efi_selftest/efi_selftest.c b/lib/efi_selftest/efi_selftest.c index 39ee2edf5d..3da34b1d46 100644 --- a/lib/efi_selftest/efi_selftest.c +++ b/lib/efi_selftest/efi_selftest.c @@ -75,7 +75,7 @@ void efi_st_exit_boot_services(void) * * @test the test to be executed * @failures counter that will be incremented if a failure occurs - * @return EFI_ST_SUCCESS for success + * Return: EFI_ST_SUCCESS for success */ static int setup(struct efi_unit_test *test, unsigned int *failures) { @@ -100,7 +100,7 @@ static int setup(struct efi_unit_test *test, unsigned int *failures) * * @test the test to be executed * @failures counter that will be incremented if a failure occurs - * @return EFI_ST_SUCCESS for success + * Return: EFI_ST_SUCCESS for success */ static int execute(struct efi_unit_test *test, unsigned int *failures) { @@ -125,7 +125,7 @@ static int execute(struct efi_unit_test *test, unsigned int *failures) * * @test the test to be torn down * @failures counter that will be incremented if a failure occurs - * @return EFI_ST_SUCCESS for success + * Return: EFI_ST_SUCCESS for success */ static int teardown(struct efi_unit_test *test, unsigned int *failures) { diff --git a/lib/efi_selftest/efi_selftest_block_device.c b/lib/efi_selftest/efi_selftest_block_device.c index 15f03751ac..ad53dac796 100644 --- a/lib/efi_selftest/efi_selftest_block_device.c +++ b/lib/efi_selftest/efi_selftest_block_device.c @@ -57,7 +57,7 @@ static u8 *image; * Reset service of the block IO protocol. * * @this block IO protocol - * @return status code + * Return: status code */ static efi_status_t EFIAPI reset( struct efi_block_io *this, @@ -74,7 +74,7 @@ static efi_status_t EFIAPI reset( * @lba start of the read in logical blocks * @buffer_size number of bytes to read * @buffer target buffer - * @return status code + * Return: status code */ static efi_status_t EFIAPI read_blocks( struct efi_block_io *this, u32 media_id, u64 lba, @@ -99,7 +99,7 @@ static efi_status_t EFIAPI read_blocks( * @lba start of the write in logical blocks * @buffer_size number of bytes to read * @buffer source buffer - * @return status code + * Return: status code */ static efi_status_t EFIAPI write_blocks( struct efi_block_io *this, u32 media_id, u64 lba, @@ -120,7 +120,7 @@ static efi_status_t EFIAPI write_blocks( * Flush service of the block IO protocol. * * @this block IO protocol - * @return status code + * Return: status code */ static efi_status_t EFIAPI flush_blocks(struct efi_block_io *this) { @@ -131,7 +131,7 @@ static efi_status_t EFIAPI flush_blocks(struct efi_block_io *this) * Decompress the disk image. * * @image decompressed disk image - * @return status code + * Return: status code */ static efi_status_t decompress(u8 **image) { @@ -278,7 +278,7 @@ static int teardown(void) * Get length of device path without end tag. * * @dp device path - * @return length of device path in bytes + * Return: length of device path in bytes */ static efi_uintn_t dp_size(struct efi_device_path *dp) { diff --git a/lib/efi_selftest/efi_selftest_controllers.c b/lib/efi_selftest/efi_selftest_controllers.c index 38720bb63d..d2bbd1c4f6 100644 --- a/lib/efi_selftest/efi_selftest_controllers.c +++ b/lib/efi_selftest/efi_selftest_controllers.c @@ -35,7 +35,7 @@ static efi_handle_t handle_driver; * @handle handle on which child controllers are installed * @protocol protocol for which the child controllers were installed * @count number of child controllers - * @return status code + * Return: status code */ static efi_status_t count_child_controllers(efi_handle_t handle, efi_guid_t *protocol, @@ -69,7 +69,7 @@ static efi_status_t count_child_controllers(efi_handle_t handle, * @this driver binding protocol * @controller_handle handle of the controller * @remaining_device_path path specifying the child controller - * @return status code + * Return: status code */ static efi_status_t EFIAPI supported( struct efi_driver_binding_protocol *this, @@ -106,7 +106,7 @@ static efi_status_t EFIAPI supported( * @this driver binding protocol * @controller_handle handle of the controller * @remaining_device_path path specifying the child controller - * @return status code + * Return: status code */ static efi_status_t EFIAPI start( struct efi_driver_binding_protocol *this, @@ -161,7 +161,7 @@ static efi_status_t EFIAPI start( * * @controller_handle parent controller * @child_handle child controller - * @return status code + * Return: status code */ static efi_status_t disconnect_child(efi_handle_t controller_handle, efi_handle_t child_handle) @@ -191,7 +191,7 @@ static efi_status_t disconnect_child(efi_handle_t controller_handle, * @controller_handle handle of the controller * @number_of_children number of child controllers to remove * @child_handle_buffer handles of the child controllers to remove - * @return status code + * Return: status code */ static efi_status_t EFIAPI stop( struct efi_driver_binding_protocol *this, diff --git a/lib/efi_selftest/efi_selftest_exception.c b/lib/efi_selftest/efi_selftest_exception.c index 6e900a35dc..d86228a892 100644 --- a/lib/efi_selftest/efi_selftest_exception.c +++ b/lib/efi_selftest/efi_selftest_exception.c @@ -63,7 +63,7 @@ static u8 *image; * Decompress the disk image. * * @image decompressed disk image - * @return status code + * Return: status code */ static efi_status_t decompress(u8 **image) { diff --git a/lib/efi_selftest/efi_selftest_fdt.c b/lib/efi_selftest/efi_selftest_fdt.c index 412ba286ea..739f029b8c 100644 --- a/lib/efi_selftest/efi_selftest_fdt.c +++ b/lib/efi_selftest/efi_selftest_fdt.c @@ -51,7 +51,7 @@ static uint32_t f2h(fdt32_t val) * * @property name of the property * @node name of the node or NULL for root node - * @return value of the property + * Return: value of the property */ static char *get_property(const u16 *property, const u16 *node) { diff --git a/lib/efi_selftest/efi_selftest_load_file.c b/lib/efi_selftest/efi_selftest_load_file.c index 4473e7c36e..bf955cbf66 100644 --- a/lib/efi_selftest/efi_selftest_load_file.c +++ b/lib/efi_selftest/efi_selftest_load_file.c @@ -166,7 +166,7 @@ struct efi_device_path *dp_lf2_file_remainder = &dp_lf2_file.f.dp; * Decompress the disk image. * * @image decompressed disk image - * @return status code + * Return: status code */ static efi_status_t decompress(u8 **image) { diff --git a/lib/efi_selftest/efi_selftest_loadimage.c b/lib/efi_selftest/efi_selftest_loadimage.c index 06a87df862..4975d80ff1 100644 --- a/lib/efi_selftest/efi_selftest_loadimage.c +++ b/lib/efi_selftest/efi_selftest_loadimage.c @@ -370,7 +370,7 @@ static efi_status_t EFIAPI flush(struct efi_file_handle *this) * Decompress the disk image. * * @image decompressed disk image - * @return status code + * Return: status code */ static efi_status_t decompress(u8 **image) { diff --git a/lib/efi_selftest/efi_selftest_miniapp_exception.c b/lib/efi_selftest/efi_selftest_miniapp_exception.c index 59b7e5100a..9be0e7e3eb 100644 --- a/lib/efi_selftest/efi_selftest_miniapp_exception.c +++ b/lib/efi_selftest/efi_selftest_miniapp_exception.c @@ -15,7 +15,7 @@ * * @handle handle of the loaded image * @systable system table - * @return status code + * Return: status code */ efi_status_t EFIAPI efi_main(efi_handle_t handle, struct efi_system_table *systable) diff --git a/lib/efi_selftest/efi_selftest_miniapp_return.c b/lib/efi_selftest/efi_selftest_miniapp_return.c index 5709e39cac..25a2bd1637 100644 --- a/lib/efi_selftest/efi_selftest_miniapp_return.c +++ b/lib/efi_selftest/efi_selftest_miniapp_return.c @@ -16,7 +16,7 @@ * * @handle handle of the loaded image * @systable system table - * @return status code + * Return: status code */ efi_status_t EFIAPI efi_main(efi_handle_t handle, struct efi_system_table *systable) diff --git a/lib/efi_selftest/efi_selftest_startimage_exit.c b/lib/efi_selftest/efi_selftest_startimage_exit.c index 11207b8162..5d4c0a6972 100644 --- a/lib/efi_selftest/efi_selftest_startimage_exit.c +++ b/lib/efi_selftest/efi_selftest_startimage_exit.c @@ -43,7 +43,7 @@ static u8 *image; * Decompress the disk image. * * @image decompressed disk image - * @return status code + * Return: status code */ static efi_status_t decompress(u8 **image) { diff --git a/lib/efi_selftest/efi_selftest_startimage_return.c b/lib/efi_selftest/efi_selftest_startimage_return.c index fabf53d983..44c23644ea 100644 --- a/lib/efi_selftest/efi_selftest_startimage_return.c +++ b/lib/efi_selftest/efi_selftest_startimage_return.c @@ -43,7 +43,7 @@ static u8 *image; * Decompress the disk image. * * @image decompressed disk image - * @return status code + * Return: status code */ static efi_status_t decompress(u8 **image) { diff --git a/lib/efi_selftest/efi_selftest_tcg2.c b/lib/efi_selftest/efi_selftest_tcg2.c index c5b0b7dd02..2eed588eea 100644 --- a/lib/efi_selftest/efi_selftest_tcg2.c +++ b/lib/efi_selftest/efi_selftest_tcg2.c @@ -401,7 +401,7 @@ static struct boot_variable boot_variable_test[] = { * efi_status_t decompress() - Decompress the disk image. * * @image decompressed disk image - * @return status code + * Return: status code */ static efi_status_t decompress(u8 **image) { @@ -438,7 +438,7 @@ static efi_status_t decompress(u8 **image) * Preexisting variable values are saved and will be restored by * calling restore_boot_variable(). * - * @return status code + * Return: status code */ static efi_status_t setup_boot_variable(void) { @@ -494,7 +494,7 @@ static efi_status_t setup_boot_variable(void) * * Restore the variable values saved in setup_boot_variable(). * - * @return status code + * Return: status code */ static efi_status_t restore_boot_variable(void) { @@ -536,7 +536,7 @@ static efi_status_t restore_boot_variable(void) * void *find_smbios_table() - Find smbios table * * @systable system table - * @return status code + * Return: status code */ static void *find_smbios_table(const struct efi_system_table *systable) { @@ -554,7 +554,7 @@ static void *find_smbios_table(const struct efi_system_table *systable) * efi_status_t setup_smbios_table() - Prepare the dummy SMBIOS table * * @systable system table - * @return status code + * Return: status code */ static efi_status_t setup_smbios_table(const struct efi_system_table *systable) { @@ -676,7 +676,7 @@ static int efi_st_tcg2_setup(const efi_handle_t img_handle, * * @tcg2 tcg2 protocol * @manufacturer_id pointer to the manufacturer_id - * @return status code + * Return: status code */ static efi_status_t get_manufacturer_id(struct efi_tcg2_protocol *tcg2, u32 *manufacturer_id) { @@ -716,7 +716,7 @@ static efi_status_t get_manufacturer_id(struct efi_tcg2_protocol *tcg2, u32 *man * * @tcg2 tcg2 protocol * @manufacturer_id pointer to the manufacturer_id - * @return status code + * Return: status code */ static efi_status_t get_manufacturer_id_buffer_small(struct efi_tcg2_protocol *tcg2) { @@ -742,7 +742,7 @@ static efi_status_t get_manufacturer_id_buffer_small(struct efi_tcg2_protocol *t * * @tcg2 tcg2 protocol * @idx pcr index to read - * @return status code + * Return: status code */ static efi_status_t read_pcr(struct efi_tcg2_protocol *tcg2, u32 idx) { @@ -779,7 +779,7 @@ static efi_status_t read_pcr(struct efi_tcg2_protocol *tcg2, u32 idx) /** * int validate_pcrs() - Compare the expected and actual pcrs * - * @return status code + * Return: status code */ static int validate_pcrs(void) { diff --git a/lib/fdtdec.c b/lib/fdtdec.c index 280cda61a7..87aa677a4a 100644 --- a/lib/fdtdec.c +++ b/lib/fdtdec.c @@ -656,7 +656,7 @@ int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name) * @param min_len minimum property length in bytes * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found, or -FDT_ERR_BADLAYOUT if not enough data - * @return pointer to cell, which is only valid if err == 0 + * Return: pointer to cell, which is only valid if err == 0 */ static const void *get_prop_check_min_len(const void *blob, int node, const char *prop_name, int min_len, @@ -1219,7 +1219,7 @@ static int uncompress_blob(const void *src, ulong sz_src, void **dstp) /** * fdt_find_separate() - Find a devicetree at the end of the image * - * @return pointer to FDT blob + * Return: pointer to FDT blob */ static void *fdt_find_separate(void) { diff --git a/lib/of_live.c b/lib/of_live.c index 05a45ed34a..2cb0dd9c07 100644 --- a/lib/of_live.c +++ b/lib/of_live.c @@ -257,7 +257,7 @@ static void *unflatten_dt_node(const void *blob, void *mem, int *poffset, * can be used. * @blob: The blob to expand * @mynodes: The device_node tree created by the call - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int unflatten_device_tree(const void *blob, struct device_node **mynodes) diff --git a/lib/rsa/rsa-mod-exp.c b/lib/rsa/rsa-mod-exp.c index 74f9eb16cc..d259b2aedf 100644 --- a/lib/rsa/rsa-mod-exp.c +++ b/lib/rsa/rsa-mod-exp.c @@ -59,7 +59,7 @@ static void subtract_modulus(const struct rsa_public_key *key, uint32_t num[]) * * @key: Key containing modulus to check * @num: Number to check against modulus, as little endian word array - * @return 0 if num < modulus, 1 if num >= modulus + * Return: 0 if num < modulus, 1 if num >= modulus */ static int greater_equal_modulus(const struct rsa_public_key *key, uint32_t num[]) @@ -315,7 +315,7 @@ int rsa_mod_exp_sw(const uint8_t *sig, uint32_t sig_len, * * @keyptr: RSA key * @inout: Big-endian word array containing value and result - * @return 0 on successful calculation, otherwise failure error code + * Return: 0 on successful calculation, otherwise failure error code * * FIXME: Use pow_mod() instead of zynq_pow_mod() * pow_mod calculation required for zynq is bit different from diff --git a/lib/rsa/rsa-sign.c b/lib/rsa/rsa-sign.c index 3b6e5f0f86..a95a3d2748 100644 --- a/lib/rsa/rsa-sign.c +++ b/lib/rsa/rsa-sign.c @@ -38,7 +38,7 @@ static int rsa_err(const char *msg) * @keydir: Directory containins the key * @name Name of key file (will have a .crt extension) * @evpp Returns EVP_PKEY object, or NULL on failure - * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL) + * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL) */ static int rsa_pem_get_pub_key(const char *keydir, const char *name, EVP_PKEY **evpp) { @@ -96,7 +96,7 @@ err_cert: * @name Name of key * @engine Engine to use * @evpp Returns EVP_PKEY object, or NULL on failure - * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL) + * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL) */ static int rsa_engine_get_pub_key(const char *keydir, const char *name, ENGINE *engine, EVP_PKEY **evpp) @@ -156,7 +156,7 @@ static int rsa_engine_get_pub_key(const char *keydir, const char *name, * @name Name of key file (will have a .crt extension) * @engine Engine to use * @evpp Returns EVP_PKEY object, or NULL on failure - * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL) + * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL) */ static int rsa_get_pub_key(const char *keydir, const char *name, ENGINE *engine, EVP_PKEY **evpp) @@ -172,7 +172,7 @@ static int rsa_get_pub_key(const char *keydir, const char *name, * @keydir: Directory containing the key * @name Name of key file (will have a .key extension) * @evpp Returns EVP_PKEY object, or NULL on failure - * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL) + * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL) */ static int rsa_pem_get_priv_key(const char *keydir, const char *name, const char *keyfile, EVP_PKEY **evpp) @@ -215,7 +215,7 @@ static int rsa_pem_get_priv_key(const char *keydir, const char *name, * @name Name of key * @engine Engine to use * @evpp Returns EVP_PKEY object, or NULL on failure - * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL) + * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL) */ static int rsa_engine_get_priv_key(const char *keydir, const char *name, const char *keyfile, @@ -283,7 +283,7 @@ static int rsa_engine_get_priv_key(const char *keydir, const char *name, * @name Name of key * @engine Engine to use for signing * @evpp Returns EVP_PKEY object, or NULL on failure - * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL) + * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL) */ static int rsa_get_priv_key(const char *keydir, const char *name, const char *keyfile, ENGINE *engine, EVP_PKEY **evpp) diff --git a/lib/rsa/rsa-verify.c b/lib/rsa/rsa-verify.c index 83f7564101..fbb2d35a7d 100644 --- a/lib/rsa/rsa-verify.c +++ b/lib/rsa/rsa-verify.c @@ -47,7 +47,7 @@ * @msg: Padded message * @pad_len: Number of expected padding bytes * @algo: Checksum algo structure having information on DER encoding etc. - * @return 0 on success, != 0 on failure + * Return: 0 on success, != 0 on failure */ static int rsa_verify_padding(const uint8_t *msg, const int pad_len, struct checksum_algo *algo) @@ -122,7 +122,7 @@ static void u32_i2osp(uint32_t val, uint8_t *buf) * @seed_len: Size of the input octet string * @output: Specifies the output octet string * @output_len: Size of the output octet string - * @return 0 if the octet string was correctly generated, others on error + * Return: 0 if the octet string was correctly generated, others on error */ static int mask_generation_function1(struct checksum_algo *checksum, uint8_t *seed, int seed_len, @@ -325,7 +325,7 @@ U_BOOT_PADDING_ALGO(pss) = { * @sig_len: Number of bytes in signature * @hash: Pointer to the expected hash * @key_len: Number of bytes in rsa key - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ static int rsa_verify_key(struct image_sign_info *info, struct key_prop *prop, const uint8_t *sig, @@ -437,7 +437,7 @@ int rsa_verify_with_pkey(struct image_sign_info *info, * @sig: Signature * @sig_len: Number of bytes in signature * @node: Node having the RSA Key properties - * @return 0 if verified, -ve on error + * Return: 0 if verified, -ve on error */ static int rsa_verify_with_keynode(struct image_sign_info *info, const void *hash, uint8_t *sig, diff --git a/lib/strto.c b/lib/strto.c index 7bba1e3e54..f191884376 100644 --- a/lib/strto.c +++ b/lib/strto.c @@ -42,7 +42,7 @@ static const char *_parse_integer_fixup_radix(const char *s, uint *basep) * This ignore case * * @ch: Character to convert (expects '0'..'9', 'a'..'f' or 'A'..'F') - * @return value of digit (0..0xf) or 255 if the character is invalid + * Return: value of digit (0..0xf) or 255 if the character is invalid */ static uint decode_digit(int ch) { diff --git a/lib/tpm-utils.h b/lib/tpm-utils.h index d680d14088..a519e18235 100644 --- a/lib/tpm-utils.h +++ b/lib/tpm-utils.h @@ -31,7 +31,7 @@ * @param size size of output string * @param format format string * @param ... data points - * @return 0 on success, non-0 on error + * Return: 0 on success, non-0 on error */ int pack_byte_string(u8 *str, size_t size, const char *format, ...); @@ -46,7 +46,7 @@ int pack_byte_string(u8 *str, size_t size, const char *format, ...); * @param size size of output string * @param format format string * @param ... data points - * @return 0 on success, non-0 on error + * Return: 0 on success, non-0 on error */ int unpack_byte_string(const u8 *str, size_t size, const char *format, ...); @@ -54,7 +54,7 @@ int unpack_byte_string(const u8 *str, size_t size, const char *format, ...); * Get TPM command size. * * @param command byte string of TPM command - * @return command size of the TPM command + * Return: command size of the TPM command */ u32 tpm_command_size(const void *command); @@ -62,7 +62,7 @@ u32 tpm_command_size(const void *command); * Get TPM response return code, which is one of TPM_RESULT values. * * @param response byte string of TPM response - * @return return code of the TPM response + * Return: return code of the TPM response */ u32 tpm_return_code(const void *response); @@ -76,7 +76,7 @@ u32 tpm_return_code(const void *response); * @param size_ptr output buffer size (input parameter) and TPM * response length (output parameter); this parameter * is a bidirectional - * @return return code of the TPM response + * Return: return code of the TPM response */ u32 tpm_sendrecv_command(struct udevice *dev, const void *command, void *response, size_t *size_ptr); diff --git a/lib/zstd/bitstream.h b/lib/zstd/bitstream.h index 73aacc97f4..44abfd5eb2 100644 --- a/lib/zstd/bitstream.h +++ b/lib/zstd/bitstream.h @@ -127,7 +127,7 @@ static const unsigned BIT_mask[] = {0, 1, 3, 7, 0xF, 0x1F ****************************************************************/ /*! BIT_initCStream() : * `dstCapacity` must be > sizeof(void*) - * @return : 0 if success, + * Return: 0 if success, otherwise an error code (can be tested using ERR_isError() ) */ ZSTD_STATIC size_t BIT_initCStream(BIT_CStream_t *bitC, void *startPtr, size_t dstCapacity) { @@ -184,7 +184,7 @@ ZSTD_STATIC void BIT_flushBits(BIT_CStream_t *bitC) } /*! BIT_closeCStream() : - * @return : size of CStream, in bytes, + * Return: size of CStream, in bytes, or 0 if it could not fit into dstBuffer */ ZSTD_STATIC size_t BIT_closeCStream(BIT_CStream_t *bitC) { @@ -259,7 +259,7 @@ ZSTD_STATIC size_t BIT_getLowerBits(size_t bitContainer, U32 const nbBits) { ret * local register is not modified. * On 32-bits, maxNbBits==24. * On 64-bits, maxNbBits==56. - * @return : value extracted + * Return: value extracted */ ZSTD_STATIC size_t BIT_lookBits(const BIT_DStream_t *bitD, U32 nbBits) { @@ -280,7 +280,7 @@ ZSTD_STATIC void BIT_skipBits(BIT_DStream_t *bitD, U32 nbBits) { bitD->bitsConsu /*! BIT_readBits() : * Read (consume) next n bits from local register and update. * Pay attention to not read more than nbBits contained into local register. - * @return : extracted value. + * Return: extracted value. */ ZSTD_STATIC size_t BIT_readBits(BIT_DStream_t *bitD, U32 nbBits) { diff --git a/lib/zstd/decompress.c b/lib/zstd/decompress.c index ae3be3f02a..edfddd817e 100644 --- a/lib/zstd/decompress.c +++ b/lib/zstd/decompress.c @@ -306,7 +306,7 @@ unsigned long long ZSTD_getFrameContentSize(const void *src, size_t srcSize) * compatible with legacy mode * `srcSize` must be the exact length of some number of ZSTD compressed and/or * skippable frames - * @return : decompressed size of the frames contained */ + * Return: decompressed size of the frames contained */ unsigned long long ZSTD_findDecompressedSize(const void *src, size_t srcSize) { { @@ -1497,7 +1497,7 @@ size_t ZSTD_generateNxBytes(void *dst, size_t dstCapacity, BYTE byte, size_t len * compatible with legacy mode * `src` must point to the start of a ZSTD frame, ZSTD legacy frame, or skippable frame * `srcSize` must be at least as large as the frame contained - * @return : the compressed size of the frame starting at `src` */ + * Return: the compressed size of the frame starting at `src` */ size_t ZSTD_findFrameCompressedSize(const void *src, size_t srcSize) { if (srcSize >= ZSTD_skippableHeaderSize && (ZSTD_readLE32(src) & 0xFFFFFFF0U) == ZSTD_MAGIC_SKIPPABLE_START) { @@ -1860,7 +1860,7 @@ static size_t ZSTD_refDictContent(ZSTD_DCtx *dctx, const void *dict, size_t dict /* ZSTD_loadEntropy() : * dict : must point at beginning of a valid zstd dictionary - * @return : size of entropy tables read */ + * Return: size of entropy tables read */ static size_t ZSTD_loadEntropy(ZSTD_entropyTables_t *entropy, const void *const dict, size_t const dictSize) { const BYTE *dictPtr = (const BYTE *)dict; diff --git a/net/eth_internal.h b/net/eth_internal.h index faff0ef866..042e58a99a 100644 --- a/net/eth_internal.h +++ b/net/eth_internal.h @@ -22,7 +22,7 @@ void eth_common_init(void); * @base_name: Base name for variable, typically "eth" * @index: Index of interface being updated (>=0) * @enetaddr: Pointer to MAC address to put into the variable - * @return 0 if OK, other value on error + * Return: 0 if OK, other value on error */ int eth_env_set_enetaddr_by_index(const char *base_name, int index, uchar *enetaddr); diff --git a/net/tftp.c b/net/tftp.c index 87392014d5..62a9648474 100644 --- a/net/tftp.c +++ b/net/tftp.c @@ -230,7 +230,7 @@ static void new_transfer(void) * @param block Block number to send * @param dst Destination buffer for data * @param len Number of bytes in block (this one and every other) - * @return number of bytes loaded + * Return: number of bytes loaded */ static int load_block(unsigned block, uchar *dst, unsigned len) { diff --git a/scripts/dtc/libfdt/fdt_rw.c b/scripts/dtc/libfdt/fdt_rw.c index 08e2981a44..2eb2b38703 100644 --- a/scripts/dtc/libfdt/fdt_rw.c +++ b/scripts/dtc/libfdt/fdt_rw.c @@ -123,7 +123,7 @@ static int fdt_splice_string_(void *fdt, int newlen) * @s: string to find/add * @allocated: Set to 0 if the string was found, 1 if not found and so * allocated. Ignored if !fdt_chk_basic() - * @return offset of string in the string table (whether found or added) + * Return: offset of string in the string table (whether found or added) */ static int fdt_find_add_string_(void *fdt, const char *s, int *allocated) { diff --git a/scripts/dtc/libfdt/libfdt.h b/scripts/dtc/libfdt/libfdt.h index 421f90ad93..d706f85962 100644 --- a/scripts/dtc/libfdt/libfdt.h +++ b/scripts/dtc/libfdt/libfdt.h @@ -152,7 +152,7 @@ int fdt_next_node(const void *fdt, int offset, int *depth); * * @fdt: FDT blob * @offset: Offset of node to check - * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none + * Return: offset of first subnode, or -FDT_ERR_NOTFOUND if there is none */ int fdt_first_subnode(const void *fdt, int offset); @@ -164,7 +164,7 @@ int fdt_first_subnode(const void *fdt, int offset); * * @fdt: FDT blob * @offset: Offset of previous subnode - * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more + * Return: offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more * subnodes */ int fdt_next_subnode(const void *fdt, int offset); diff --git a/scripts/dtc/srcpos.c b/scripts/dtc/srcpos.c index cb6ed0e3e5..c297861145 100644 --- a/scripts/dtc/srcpos.c +++ b/scripts/dtc/srcpos.c @@ -66,7 +66,7 @@ static int srcfile_depth; /* = 0 */ * @param dirname Directory to look in, or NULL for none * @param fname Filename to look for * @param fp Set to NULL if file did not open - * @return allocated filename on success (caller must free), NULL on failure + * Return: allocated filename on success (caller must free), NULL on failure */ static char *try_open(const char *dirname, const char *fname, FILE **fp) { @@ -93,7 +93,7 @@ static char *try_open(const char *dirname, const char *fname, FILE **fp) * * @param fname Filename to open * @param fp Returns pointer to opened FILE, or NULL on failure - * @return pointer to allocated filename, which caller must free + * Return: pointer to allocated filename, which caller must free */ static char *fopen_any_on_path(const char *fname, FILE **fp) { diff --git a/scripts/dtc/srcpos.h b/scripts/dtc/srcpos.h index 9ded12a383..5db32a723e 100644 --- a/scripts/dtc/srcpos.h +++ b/scripts/dtc/srcpos.h @@ -52,7 +52,7 @@ extern struct srcfile_state *current_srcfile; /* = NULL */ * @param fullnamep If non-NULL, it is set to the allocated filename of the * file that was opened. The caller is then responsible * for freeing the pointer. - * @return pointer to opened FILE + * Return: pointer to opened FILE */ FILE *srcfile_relative_open(const char *fname, char **fullnamep); diff --git a/scripts/dtc/util.h b/scripts/dtc/util.h index 66fba8ea70..211d584435 100644 --- a/scripts/dtc/util.h +++ b/scripts/dtc/util.h @@ -81,7 +81,7 @@ extern char *join_path(const char *path, const char *name); * * @param data The string to check * @param len The string length including terminator - * @return 1 if a valid printable string, 0 if not + * Return: 1 if a valid printable string, 0 if not */ bool util_is_printable_string(const void *data, int len); @@ -98,7 +98,7 @@ char get_escape_char(const char *s, int *i); * stderr. * * @param filename The filename to read, or - for stdin - * @return Pointer to allocated buffer containing fdt, or NULL on error + * Return: Pointer to allocated buffer containing fdt, or NULL on error */ char *utilfdt_read(const char *filename); @@ -116,7 +116,7 @@ char *utilfdt_read_len(const char *filename, off_t *len); * * @param filename The filename to read, or - for stdin * @param buffp Returns pointer to buffer containing fdt - * @return 0 if ok, else an errno value representing the error + * Return: 0 if ok, else an errno value representing the error */ int utilfdt_read_err(const char *filename, char **buffp); @@ -133,7 +133,7 @@ int utilfdt_read_err_len(const char *filename, char **buffp, off_t *len); * * @param filename The filename to write, or - for stdout * @param blob Poiner to buffer containing fdt - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int utilfdt_write(const char *filename, const void *blob); @@ -144,7 +144,7 @@ int utilfdt_write(const char *filename, const void *blob); * * @param filename The filename to write, or - for stdout * @param blob Poiner to buffer containing fdt - * @return 0 if ok, else an errno value representing the error + * Return: 0 if ok, else an errno value representing the error */ int utilfdt_write_err(const char *filename, const void *blob); @@ -169,7 +169,7 @@ int utilfdt_write_err(const char *filename, const void *blob); * @param fmt Format string to process * @param type Returns type found(s/d/u/x), or 0 if none * @param size Returns size found(1,2,4,8) or 4 if none - * @return 0 if ok, -1 on error (no type given, or other invalid format) + * Return: 0 if ok, -1 on error (no type given, or other invalid format) */ int utilfdt_decode_type(const char *fmt, int *type, int *size); diff --git a/test/compression.c b/test/compression.c index 26d3c80fb5..82e29c9b86 100644 --- a/test/compression.c +++ b/test/compression.c @@ -457,7 +457,7 @@ static int compress_using_none(struct unit_test_state *uts, * * @comp_type: Compression type to test * @compress: Our function to compress data - * @return 0 if OK, non-zero on failure + * Return: 0 if OK, non-zero on failure */ static int run_bootm_test(struct unit_test_state *uts, int comp_type, mutate_func compress) diff --git a/test/dm/acpi.h b/test/dm/acpi.h index 535db56b51..c6636b8824 100644 --- a/test/dm/acpi.h +++ b/test/dm/acpi.h @@ -17,7 +17,7 @@ * * @ctxp: Returns allocated context * @size: Size to allocate in bytes - * @return 0 if OK, -ENOMEM if out of memory + * Return: 0 if OK, -ENOMEM if out of memory */ int acpi_test_alloc_context_size(struct acpi_ctx **ctxp, int size); @@ -25,7 +25,7 @@ int acpi_test_alloc_context_size(struct acpi_ctx **ctxp, int size); * acpi_test_get_length() - decode a three-byte length field * * @ptr: Length encoded as per ACPI - * @return decoded length, or -EINVAL on error + * Return: decoded length, or -EINVAL on error */ int acpi_test_get_length(u8 *ptr); diff --git a/test/dm/core.c b/test/dm/core.c index c76dfdb165..0ce0b3c4a2 100644 --- a/test/dm/core.c +++ b/test/dm/core.c @@ -579,7 +579,7 @@ DM_TEST(dm_test_uclass, 0); * receive an incrementing value * @child: If not NULL, then the child device pointers are written into * this array. - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int create_children(struct unit_test_state *uts, struct udevice *parent, int count, int key, struct udevice *child[]) diff --git a/test/dm/of_platdata.c b/test/dm/of_platdata.c index ec41087a55..7af798b8d3 100644 --- a/test/dm/of_platdata.c +++ b/test/dm/of_platdata.c @@ -103,7 +103,7 @@ DM_TEST(dm_test_of_plat_props, UT_TESTF_SCAN_PDATA); * @uts: Test state * @parent: Parent to search * @found: bool array to update - * @return 0 if OK, non-zero on error + * Return: 0 if OK, non-zero on error */ static int find_driver_info(struct unit_test_state *uts, struct udevice *parent, bool found[]) diff --git a/test/dm/test-dm.c b/test/dm/test-dm.c index 9ba2ba23d5..f5cda81bbf 100644 --- a/test/dm/test-dm.c +++ b/test/dm/test-dm.c @@ -27,7 +27,7 @@ DECLARE_GLOBAL_DATA_PTR; * * @test_name: Name of single test to run (e.g. "dm_test_fdt_pre_reloc" or just * "fdt_pre_reloc"), or NULL to run all - * @return 0 if all tests passed, 1 if not + * Return: 0 if all tests passed, 1 if not */ static int dm_test_run(const char *test_name) { diff --git a/test/dm/video.c b/test/dm/video.c index d4a3c9c6c1..17a33cc7af 100644 --- a/test/dm/video.c +++ b/test/dm/video.c @@ -59,7 +59,7 @@ DM_TEST(dm_test_video_base, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT); * * @uts: Test state * @dev: Video device - * @return compressed size of the frame buffer, or -ve on error + * Return: compressed size of the frame buffer, or -ve on error */ static int compress_frame_buffer(struct unit_test_state *uts, struct udevice *dev) @@ -120,7 +120,7 @@ static int select_vidconsole(struct unit_test_state *uts, const char *drv_name) * * @uts: Test state * @devp: Returns video device - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int video_get_nologo(struct unit_test_state *uts, struct udevice **devp) { @@ -233,7 +233,7 @@ DM_TEST(dm_test_video_ansi, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT); * 2=upside down, 3=90 degree counterclockwise) * @wrap_size: Expected size of compressed frame buffer for the wrap test * @scroll_size: Same for the scroll test - * @return 0 on success + * Return: 0 on success */ static int check_vidconsole_output(struct unit_test_state *uts, int rot, int wrap_size, int scroll_size) diff --git a/test/log/syslog_test.h b/test/log/syslog_test.h index bfaa6daef8..39cce4ed49 100644 --- a/test/log/syslog_test.h +++ b/test/log/syslog_test.h @@ -49,7 +49,7 @@ int sb_log_tx_handler(struct udevice *dev, void *packet, unsigned int len); * syslog_test_setup() - Enable syslog logging ready for tests * * @uts: Test state - * @return 0 if OK, -ENOENT if the syslog log driver is not found + * Return: 0 if OK, -ENOENT if the syslog log driver is not found */ int syslog_test_setup(struct unit_test_state *uts); @@ -57,7 +57,7 @@ int syslog_test_setup(struct unit_test_state *uts); * syslog_test_finish() - Disable syslog logging after tests * * @uts: Test state - * @return 0 if OK, -ENOENT if the syslog log driver is not found + * Return: 0 if OK, -ENOENT if the syslog log driver is not found */ int syslog_test_finish(struct unit_test_state *uts); diff --git a/test/test-main.c b/test/test-main.c index 3cdf6849c5..8fcb02ecea 100644 --- a/test/test-main.c +++ b/test/test-main.c @@ -106,7 +106,7 @@ static int do_autoprobe(struct unit_test_state *uts) * This skips long/slow tests where there is not much value in running a flat * DT test in addition to a live DT test. * - * @return true to run the given test on the flat device tree + * Return: true to run the given test on the flat device tree */ static bool ut_test_run_on_flattree(struct unit_test *test) { @@ -130,7 +130,7 @@ static bool ut_test_run_on_flattree(struct unit_test *test) * a prefix. * @test_name: Name of current test * @select_name: Name of test to run (or NULL for all) - * @return true to run this test, false to skip it + * Return: true to run this test, false to skip it */ static bool test_matches(const char *prefix, const char *test_name, const char *select_name) @@ -171,7 +171,7 @@ static bool test_matches(const char *prefix, const char *test_name, * * @tests: List of tests to run * @count: Number of tests to ru - * @return true if any of the tests have the UT_TESTF_DM flag + * Return: true if any of the tests have the UT_TESTF_DM flag */ static bool ut_list_has_dm_tests(struct unit_test *tests, int count) { @@ -189,7 +189,7 @@ static bool ut_list_has_dm_tests(struct unit_test *tests, int count) * dm_test_restore() Put things back to normal so sandbox works as expected * * @of_root: Value to set for of_root - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int dm_test_restore(struct device_node *of_root) { @@ -212,7 +212,7 @@ static int dm_test_restore(struct device_node *of_root) * * @uts: Test state * @test: Test to prepare for - * @return 0 if OK, -EAGAIN to skip this test since some required feature is not + * Return: 0 if OK, -EAGAIN to skip this test since some required feature is not * available, other -ve on error (meaning that testing cannot likely * continue) */ @@ -253,7 +253,7 @@ static int test_pre_run(struct unit_test_state *uts, struct unit_test *test) * * @uts: Test state * @test: Test to clean up after - * @return 0 if OK, -ve on error (meaning that testing cannot likely continue) + * Return: 0 if OK, -ve on error (meaning that testing cannot likely continue) */ static int test_post_run(struct unit_test_state *uts, struct unit_test *test) { @@ -275,7 +275,7 @@ static int test_post_run(struct unit_test_state *uts, struct unit_test *test) * incremented by the number of failures (0, one hopes) * @test_name: Test to run * @name: Name of test, possibly skipping a prefix that should not be displayed - * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if + * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if * any failed */ static int ut_run_test(struct unit_test_state *uts, struct unit_test *test, @@ -323,7 +323,7 @@ static int ut_run_test(struct unit_test_state *uts, struct unit_test *test, * incremented by the number of failures (0, one hopes) * @test: Test to run * @name: Name of test, possibly skipping a prefix that should not be displayed - * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if + * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if * any failed */ static int ut_run_test_live_flat(struct unit_test_state *uts, @@ -371,7 +371,7 @@ static int ut_run_test_live_flat(struct unit_test_state *uts, * @count: Number of tests to run * @select_name: Name of a single test to run (from the list provided). If NULL * then all tests are run - * @return 0 if all tests passed, -ENOENT if test @select_name was not found, + * Return: 0 if all tests passed, -ENOENT if test @select_name was not found, * -EBADF if any failed */ static int ut_run_tests(struct unit_test_state *uts, const char *prefix, diff --git a/tools/fit_common.h b/tools/fit_common.h index 1e81d4c68b..0e8ee79115 100644 --- a/tools/fit_common.h +++ b/tools/fit_common.h @@ -16,7 +16,7 @@ * @ptr: image header to be verified * @image_size: size of while image * @params: mkimage parameters - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int fit_verify_header(unsigned char *ptr, int image_size, struct image_tool_params *params); @@ -33,7 +33,7 @@ int fit_check_image_types(uint8_t type); * @sbuf: File status information is stored here * @delete_on_error: true to delete the file if we get an error * @read_only: true to open in read-only mode - * @return 0 if OK, -1 on error. + * Return: 0 if OK, -1 on error. */ int mmap_fdt(const char *cmdname, const char *fname, size_t size_inc, void **blobp, struct stat *sbuf, bool delete_on_error, diff --git a/tools/ifdtool.c b/tools/ifdtool.c index 3a39b7bc70..b70570361f 100644 --- a/tools/ifdtool.c +++ b/tools/ifdtool.c @@ -43,7 +43,7 @@ struct input_file { * * @image: Pointer to image * @size: Size of image in bytes - * @return pointer to structure, or NULL if not found + * Return: pointer to structure, or NULL if not found */ static struct fdbar_t *find_fd(char *image, int size) { @@ -72,7 +72,7 @@ static struct fdbar_t *find_fd(char *image, int size) * @frba: Flash region list * @region_type: Type of region (0..MAX_REGIONS-1) * @region: Region information is written here - * @return 0 if OK, else -ve + * Return: 0 if OK, else -ve */ static int get_region(struct frba_t *frba, int region_type, struct region_t *region) @@ -380,7 +380,7 @@ static void dump_oem(uint8_t *oem) * * @image: Pointer to image * @size: Size of image in bytes - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ static int dump_fd(char *image, int size) { @@ -432,7 +432,7 @@ static int dump_fd(char *image, int size) * * @image: Pointer to image * @size: Size of image in bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int write_regions(char *image, int size) { @@ -487,7 +487,7 @@ static int perror_fname(const char *fmt, const char *fname) * @filename: Filename to use for the image * @image: Pointer to image * @size: Size of image in bytes - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ static int write_image(char *filename, char *image, int size) { @@ -595,7 +595,7 @@ static void unlock_descriptor(char *image, int size) * * @fname: Filename to open * @sizep: Returns file size in bytes - * @return 0 if OK, -1 on error + * Return: 0 if OK, -1 on error */ int open_for_read(const char *fname, int *sizep) { @@ -622,7 +622,7 @@ int open_for_read(const char *fname, int *sizep) * @size: Size of image in bytes * @region_type: Region where the file should be added * @region_fname: Filename to add to the image - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int inject_region(char *image, int size, int region_type, char *region_fname) { @@ -701,7 +701,7 @@ int inject_region(char *image, int size, int region_type, char *region_fname) * @write_fname: Filename to add to the image * @offset_uboot_top: Offset of the top of U-Boot * @offset_uboot_start: Offset of the start of U-Boot - * @return number of bytes written if OK, -ve on error + * Return: number of bytes written if OK, -ve on error */ static int write_data(char *image, int size, unsigned int addr, const char *write_fname, int offset_uboot_top, @@ -792,7 +792,7 @@ static void print_usage(const char *name) * @str: String to split * @firstp: Returns first string * @secondp: Returns second string - * @return 0 if OK, -ve if @str does not have a : + * Return: 0 if OK, -ve if @str does not have a : */ static int get_two_words(const char *str, char **firstp, char **secondp) { diff --git a/tools/image-host.c b/tools/image-host.c index a6b0a94420..945571f584 100644 --- a/tools/image-host.c +++ b/tools/image-host.c @@ -55,7 +55,7 @@ static int fit_set_hash_value(void *fit, int noffset, uint8_t *value, * @noffset: subnode offset * @data: data to process * @size: size of data in bytes - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int fit_image_process_hash(void *fit, const char *image_name, int noffset, const void *data, size_t size) @@ -209,7 +209,7 @@ static int fit_image_setup_sig(struct image_sign_info *info, * @comment: Comment to add to signature nodes * @require_keys: Mark all keys as 'required' * @engine_id: Engine to use for signing - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int fit_image_process_sig(const char *keydir, const char *keyfile, void *keydest, void *fit, const char *image_name, diff --git a/tools/imagetool.h b/tools/imagetool.h index e229a34ffc..3546f7a671 100644 --- a/tools/imagetool.h +++ b/tools/imagetool.h @@ -176,7 +176,7 @@ struct image_type_params *imagetool_get_type(int type); * supported image type. If verification is successful, this prints * the respective header. * - * @return 0 on success, negative if input image format does not match with + * Return: 0 on success, negative if input image format does not match with * any of supported image types */ int imagetool_verify_print_header( @@ -195,7 +195,7 @@ int imagetool_verify_print_header( * @tparams: image type parameters * @params: mkimage parameters * - * @return 0 on success, negative if input image format does not match with + * Return: 0 on success, negative if input image format does not match with * the given image type */ int imagetool_verify_print_header_by_type( @@ -229,7 +229,7 @@ int imagetool_save_subimage( * * @params: mkimage parameters * @fname: filename to check - * @return size of file, or -ve value on error + * Return: size of file, or -ve value on error */ int imagetool_get_filesize(struct image_tool_params *params, const char *fname); @@ -243,7 +243,7 @@ int imagetool_get_filesize(struct image_tool_params *params, const char *fname); * * @cmdname: command name * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set - * @return timestamp based on SOURCE_DATE_EPOCH + * Return: timestamp based on SOURCE_DATE_EPOCH */ time_t imagetool_get_source_date( const char *cmdname, diff --git a/tools/rkcommon.h b/tools/rkcommon.h index 93518824a5..49b6df3185 100644 --- a/tools/rkcommon.h +++ b/tools/rkcommon.h @@ -19,7 +19,7 @@ enum { /** * rkcommon_check_params() - check params * - * @return 0 if OK, -1 if ERROR. + * Return: 0 if OK, -1 if ERROR. */ int rkcommon_check_params(struct image_tool_params *params); @@ -56,7 +56,7 @@ void rkcommon_set_header(void *buf, struct stat *sbuf, int ifd, * * @buf: Pointer to the image file * @file_size: Size of entire bootable image file (incl. all padding) - * @return 0 if OK + * Return: 0 if OK */ int rkcommon_verify_header(unsigned char *buf, int size, struct image_tool_params *params); @@ -76,7 +76,7 @@ void rkcommon_print_header(const void *buf); * Some socs cannot disable the rc4-encryption of the spl binary. * rc4 encryption is disabled normally except on socs that cannot * handle unencrypted binaries. - * @return true or false depending on rc4 being required. + * Return: true or false depending on rc4 being required. */ bool rkcommon_need_rc4_spl(struct image_tool_params *params); @@ -99,7 +99,7 @@ void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size); * @tparams: Pointer tot the image type structure (for setting * the header and header_size) * - * @return 0 (always) + * Return: 0 (always) */ int rkcommon_vrec_header(struct image_tool_params *params, struct image_type_params *tparams); -- 2.33.1

2 1

[PATCH] usb: Use the first available device for ehci_gadget
by Sean Anderson 26 Jan '22

26 Jan '22

For whatever reason, usb_setup_ehci_gadget removes and probes USB device 0. However, not all systems have a device 0. Use the first device instead. The device probed should probably have something to do with the controller (as specified by e.g. ums <controller> or fastboot <controller>). In fact, I find it odd that we probe the USB device in the first place, because this is just to set up the gadget itself. Presumably, the controller should be probed by usb_gadget_initialize somehow. Signed-off-by: Sean Anderson <sean.anderson(a)seco.com> --- drivers/usb/host/usb-uclass.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/usb/host/usb-uclass.c b/drivers/usb/host/usb-uclass.c index fd39c3345c..27e2fc6fcd 100644 --- a/drivers/usb/host/usb-uclass.c +++ b/drivers/usb/host/usb-uclass.c @@ -396,7 +396,7 @@ int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp) int ret; /* Find the old device and remove it */ - ret = uclass_find_device_by_seq(UCLASS_USB, 0, &dev); + ret = uclass_find_first_device(UCLASS_USB, &dev); if (ret) return ret; ret = device_remove(dev, DM_REMOVE_NORMAL); @@ -419,7 +419,7 @@ int usb_remove_ehci_gadget(struct ehci_ctrl **ctlrp) int ret; /* Find the old device and remove it */ - ret = uclass_find_device_by_seq(UCLASS_USB, 0, &dev); + ret = uclass_find_first_device(UCLASS_USB, &dev); if (ret) return ret; ret = device_remove(dev, DM_REMOVE_NORMAL); -- 2.25.1

2 2

[PATCH] introduce CONFIG_DEVICE_TREE_INCLUDES
by Rasmus Villemoes 26 Jan '22

26 Jan '22

The build system already automatically looks for and includes an in-tree *-u-boot.dtsi when building the control .dtb. However, there are some things that are awkward to maintain in such an in-tree file, most notably the metadata associated to public keys used for verified boot. The only "official" API to get that metadata into the .dtb is via mkimage, as a side effect of building an actual signed image. But there are multiple problems with that. First of all, the final U-Boot (be it U-Boot proper or an SPL) image is built based on a binary image, the .dtb, and possibly some other binary artifacts. So modifying the .dtb after the build requires the meta-buildsystem (Yocto, buildroot, whatnot) to know about and repeat some of the steps that are already known to and handled by U-Boot's build system, resulting in needless duplication of code. It's also somewhat annoying and inconsistent to have a .dtb file in the build folder which is not generated by the command listed in the corresponding .cmd file (that of course applies to any generated file). So the contents of the /signature node really needs to be baked into the .dtb file when it is first created, which means providing the relevant data in the form of a .dtsi file. One could in theory put that data into the *-u-boot.dtsi file, but it's more convenient to be able to provide it externally: For example, when developing for a customer, it's common to use a set of dummy keys for development, while the consultants do not (and should not) have access to the actual keys used in production. For such a setup, it's easier if the keys used are chosen via the meta-buildsystem and the path(s) patched in during the configure step. And of course, nothing prevents anybody from having DEVICE_TREE_INCLUDES point at files maintained in git, or for that matter from including the public key metadata in the *-u-boot.dtsi directly and ignore this feature. There are other uses for this, e.g. in combination with ENV_IMPORT_FDT it can be used for providing the contents of the /config/environment node, so I don't want to tie this exclusively to use for verified boot. Signed-off-by: Rasmus Villemoes <rasmus.villemoes(a)prevas.dk> --- Getting the public key metadata into .dtsi form can be done with a little scripting (roughly 'mkimage -K' of a dummy image followed by 'dtc -I dtb -O dts'). I have a script that does that, along with options to set 'required' and 'required-mode' properties, include u-boot,dm-spl properties in case one wants to check U-Boot proper from SPL with the verified boot mechanism, etc. I'm happy to share that script if this gets accepted, but it's moot if this is rejected. I have previously tried to get an fdt_add_pubkey tool accepted [1,2] to disentangle the kernel and u-boot builds (or u-boot and SPL builds for that matter!), but as I've since realized, that isn't quite enough - the above points re modifying the .dtb after it is created but before that is used to create further build artifacts still stand. However, such a tool could still be useful for creating the .dtsi info without the private keys being present, and my key2dtsi.sh script could easily be modified to use a tool like that should it ever appear. [1] https://lore.kernel.org/u-boot/20200211094818.14219-3-rasmus.villemoes@prev… [2] https://lore.kernel.org/u-boot/2184f1e6dd6247e48133c76205feeabe@kaspersky.c… dts/Kconfig | 9 +++++++++ scripts/Makefile.lib | 2 ++ 2 files changed, 11 insertions(+) diff --git a/dts/Kconfig b/dts/Kconfig index dabe0080c1..593dddbaf0 100644 --- a/dts/Kconfig +++ b/dts/Kconfig @@ -139,6 +139,15 @@ config DEFAULT_DEVICE_TREE It can be overridden from the command line: $ make DEVICE_TREE=<device-tree-name> +config DEVICE_TREE_INCLUDES + string "Extra .dtsi files to include when building DT control" + depends on OF_CONTROL + help + U-Boot's control .dtb is usually built from an in-tree .dts + file, plus (if available) an in-tree U-Boot-specific .dtsi + file. This option specifies a space-separated list of extra + .dtsi files that will also be used. + config OF_LIST string "List of device tree files to include for DT control" depends on SPL_LOAD_FIT || MULTI_DTB_FIT diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib index 78bbebe7e9..a2accba940 100644 --- a/scripts/Makefile.lib +++ b/scripts/Makefile.lib @@ -320,6 +320,8 @@ quiet_cmd_dtc = DTC $@ # Bring in any U-Boot-specific include at the end of the file cmd_dtc = mkdir -p $(dir ${dtc-tmp}) ; \ (cat $<; $(if $(u_boot_dtsi),echo '$(pound)include "$(u_boot_dtsi)"')) > $(pre-tmp); \ + $(foreach f,$(subst $(quote),,$(CONFIG_DEVICE_TREE_INCLUDES)), \ + echo '$(pound)include "$(f)"' >> $(pre-tmp);) \ $(CPP) $(dtc_cpp_flags) -x assembler-with-cpp -o $(dtc-tmp) $(pre-tmp) ; \ $(DTC) -O dtb -o $@ -b 0 \ -i $(dir $<) $(DTC_FLAGS) \ -- 2.31.1

5 23

[PATCH 1/1] sandbox: eth-raw: fix building with musl library
by Heinrich Schuchardt 26 Jan '22

26 Jan '22

The definition of struct udphdr in include netinet/udp.h in the musl library differs from the definition in the glibc library. To use the same definition with musl the symbol _GNU_SOURCE has to be defined. Reported-by: Milan P. Stanić <mps(a)arvanta.net> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt(a)canonical.com> --- arch/sandbox/cpu/eth-raw-os.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/arch/sandbox/cpu/eth-raw-os.c b/arch/sandbox/cpu/eth-raw-os.c index 6a8d809756..e59b96be5f 100644 --- a/arch/sandbox/cpu/eth-raw-os.c +++ b/arch/sandbox/cpu/eth-raw-os.c @@ -4,6 +4,8 @@ * Copyright (c) 2015-2018 Joe Hershberger <joe.hershberger(a)ni.com> */ +#define _GNU_SOURCE + #include <asm/eth-raw-os.h> #include <errno.h> #include <fcntl.h> -- 2.33.1

3 2

[PATCH 1/1] sandbox: sandbox_serial_pending depends on DM_VIDEO
by Heinrich Schuchardt 26 Jan '22

26 Jan '22

When building sandbox_defconfig with CONFIG_DM_VIDEO=n a link time error occurs: in function `sandbox_serial_pending': drivers/serial/sandbox.c:101: undefined reference to `video_sync_all' video_sync_all() is only defined if we have CONFIG_DM_VIDEO=y. Calling this function in a serial driver looks quite hackish but at least let's add the missing build constraint. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt(a)canonical.com> --- drivers/serial/sandbox.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/serial/sandbox.c b/drivers/serial/sandbox.c index dbbcea5bb4..0b1756f5c0 100644 --- a/drivers/serial/sandbox.c +++ b/drivers/serial/sandbox.c @@ -97,7 +97,7 @@ static int sandbox_serial_pending(struct udevice *dev, bool input) return 0; os_usleep(100); - if (!IS_ENABLED(CONFIG_SPL_BUILD)) + if (IS_ENABLED(CONFIG_DM_VIDEO) && !IS_ENABLED(CONFIG_SPL_BUILD)) video_sync_all(); avail = membuff_putraw(&priv->buf, 100, false, &data); if (!avail) -- 2.33.1

2 2

[PATCH] binman: Document the __bss_size symbol error
by Simon Glass 26 Jan '22

26 Jan '22

Add a note about the message so it is clear why it occurs. Signed-off-by: Simon Glass <sjg(a)chromium.org> --- tools/binman/binman.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst index db2234bd8ff..eb2c9d4bdcc 100644 --- a/tools/binman/binman.rst +++ b/tools/binman/binman.rst @@ -1232,6 +1232,35 @@ To enable Python test coverage on Debian-type distributions (e.g. Ubuntu):: $ sudo apt-get install python-coverage python3-coverage python-pytest +Error messages +-------------- + +This section provides some guidance for some of the less obvious error messages +produced by binman. + + +Expected __bss_size symbol +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Example:: + + binman: Node '/binman/u-boot-spl-ddr/u-boot-spl/u-boot-spl-bss-pad': + Expected __bss_size symbol in spl/u-boot-spl + +This indicates that binman needs the `__bss_size` symbol to be defined in the +SPL binary, where `spl/u-boot-spl` is the ELF file containing the symbols. The +symbol tells binman the size of the BSS region, in bytes. It needs this to be +able to pad the image so that the following entries do not overlap the BSS, +which would cause them to be overwritte by variable access in SPL. + +This symbols is normally defined in the linker script, immediately after +_bss_start and __bss_end are defined, like this:: + + __bss_size = __bss_end - __bss_start; + +You may need to add it to your linker script if you get this error. + + Concurrent tests ---------------- -- 2.35.0.rc0.227.g00780c9af4-goog

1 1

[PATCH] binman: doc: fix typo for u-boot-tpl
by Heiko Thiery 26 Jan '22

26 Jan '22

Cc: Simon Glass <sjg(a)chromium.org> Signed-off-by: Heiko Thiery <heiko.thiery(a)gmail.com> --- tools/binman/binman.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst index 3e063d1f86..3eedfdfe78 100644 --- a/tools/binman/binman.rst +++ b/tools/binman/binman.rst @@ -707,7 +707,7 @@ The above feature ensures that the devicetree is clearly separated from the U-Boot executable and can be updated separately by binman as needed. It can be disabled with the --no-expanded flag if required. -The same applies for u-boot-spl and u-boot-spl. In those cases, the expansion +The same applies for u-boot-spl and u-boot-tpl. In those cases, the expansion includes the BSS padding, so for example:: spl { -- 2.30.2

2 2

Compile only changed files when doing 'make'?
by Grant Edwards 26 Jan '22

26 Jan '22

I'm working on a Renesas supplied port of U-Boot, and it seems that 'make' always compiles every single (configured) source file instead compiling only the source files that have been changed since the previous 'make'. I've never run into this before on projects that use 'make', and it makes development of U-Boot rather grueling. Is that due to something Renesas broke? Or is that a "feature" of the standard U-Boot Makefile? -- Grant

2 2

[RFC] imx: imx8qm-rom7720: switch to binman
by Oliver Graute 26 Jan '22

26 Jan '22

Switch to use binman to pack images --- Run into this issue on the first try to get binman working: make[1]: Nothing to be done for 'SPL'. BINMAN flash.bin MKIMAGE flash.bin Error: spl/u-boot-spl.cfgout[16] - Invalid command (LOADER) arch/arm/mach-imx/Makefile:190: recipe for target 'flash.bin' failed make[1]: *** [flash.bin] Error 1 make[1]: *** Deleting file 'flash.bin' Makefile:1519: recipe for target 'flash.bin' failed make: *** [flash.bin] Error 2 Some clue howto fix that? arch/arm/dts/imx8qm-rom7720-a1.dts | 1 + arch/arm/dts/imx8qm-u-boot.dtsi | 95 +++++++++++++++++++ arch/arm/mach-imx/imx8/Kconfig | 1 + .../advantech/imx8qm_rom7720_a1/imximage.cfg | 16 +--- configs/imx8qm_rom7720_a1_4G_defconfig | 2 +- 5 files changed, 100 insertions(+), 15 deletions(-) create mode 100644 arch/arm/dts/imx8qm-u-boot.dtsi diff --git a/arch/arm/dts/imx8qm-rom7720-a1.dts b/arch/arm/dts/imx8qm-rom7720-a1.dts index d1f2fff869..332d441c6d 100644 --- a/arch/arm/dts/imx8qm-rom7720-a1.dts +++ b/arch/arm/dts/imx8qm-rom7720-a1.dts @@ -10,6 +10,7 @@ /memreserve/ 0x80000000 0x00020000; #include "fsl-imx8qm.dtsi" +#include "imx8qm-u-boot.dtsi" / { model = "Advantech iMX8QM Qseven series"; diff --git a/arch/arm/dts/imx8qm-u-boot.dtsi b/arch/arm/dts/imx8qm-u-boot.dtsi new file mode 100644 index 0000000000..77e5cd6989 --- /dev/null +++ b/arch/arm/dts/imx8qm-u-boot.dtsi @@ -0,0 +1,95 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright 2021 NXP + */ + +/ { + binman: binman { + multiple-images; + }; + +}; + +&binman { + u-boot-nodtb { + filename = "u-boot-nodtb.bin"; + pad-byte = <0xff>; + align-size = <4>; + align = <4>; + + u-boot-spl { + align-end = <4>; + }; + + }; + + flash { + mkimage { + args = "-n spl/u-boot-spl.cfgout -T imx8mimage -e 0x100000"; + + blob { + filename = "u-boot-nodtb.bin"; + }; + + }; + + }; + + itb { + filename = "u-boot.itb"; + + fit { + description = "Configuration to load ATF before U-Boot"; + #address-cells = <1>; + fit,external-offset = <CONFIG_FIT_EXTERNAL_OFFSET>; + + images { + uboot { + description = "U-Boot (64-bit)"; + type = "standalone"; + arch = "arm64"; + compression = "none"; + load = <CONFIG_SYS_TEXT_BASE>; + + uboot_blob: blob-ext { + filename = "u-boot-nodtb.bin"; + }; + }; + + atf { + description = "ARM Trusted Firmware"; + type = "firmware"; + arch = "arm64"; + compression = "none"; + load = <0x80000000>; + entry = <0x80000000>; + + atf_blob: blob-ext { + filename = "bl31.bin"; + }; + }; + + fdt { + description = "imx8qm-rom7720-a1"; + type = "flat_dt"; + compression = "none"; + + uboot_fdt_blob: blob-ext { + filename = "u-boot.dtb"; + }; + }; + }; + + configurations { + default = "conf"; + + conf { + description = "imx8qm-rom7720-a1"; + firmware = "uboot"; + loadables = "atf"; + fdt = "fdt"; + }; + }; + }; + }; +}; diff --git a/arch/arm/mach-imx/imx8/Kconfig b/arch/arm/mach-imx/imx8/Kconfig index b43739e5c6..b42b985cdf 100644 --- a/arch/arm/mach-imx/imx8/Kconfig +++ b/arch/arm/mach-imx/imx8/Kconfig @@ -81,6 +81,7 @@ config TARGET_CONGA_QMX8 config TARGET_IMX8QM_ROM7720_A1 bool "Support i.MX8QM ROM-7720-A1" + select BINMAN select BOARD_LATE_INIT select SUPPORT_SPL select IMX8QM diff --git a/board/advantech/imx8qm_rom7720_a1/imximage.cfg b/board/advantech/imx8qm_rom7720_a1/imximage.cfg index e324c7ca37..30556ff9d7 100644 --- a/board/advantech/imx8qm_rom7720_a1/imximage.cfg +++ b/board/advantech/imx8qm_rom7720_a1/imximage.cfg @@ -5,17 +5,5 @@ #define __ASSEMBLY__ -/* Boot from SD, sector size 0x400 */ -BOOT_FROM SD 0x400 -/* SoC type IMX8QM */ -SOC_TYPE IMX8QM -/* Append seco container image */ -APPEND mx8qm-ahab-container.img -/* Create the 2nd container */ -CONTAINER -/* Add scfw image with exec attribute */ -IMAGE SCU mx8qm-val-scfw-tcm.bin -/* Add ATF image with exec attribute */ -IMAGE A35 bl31.bin 0x80000000 -/* Add U-Boot image with load attribute */ -DATA A35 u-boot-dtb.bin 0x80020000 +BOOT_FROM sd +LOADER u-boot-dtb.bin 0x10000 diff --git a/configs/imx8qm_rom7720_a1_4G_defconfig b/configs/imx8qm_rom7720_a1_4G_defconfig index fb43fa1962..07ea6e191d 100644 --- a/configs/imx8qm_rom7720_a1_4G_defconfig +++ b/configs/imx8qm_rom7720_a1_4G_defconfig @@ -18,7 +18,7 @@ CONFIG_SPL=y CONFIG_SYS_LOAD_ADDR=0x80280000 CONFIG_FIT=y CONFIG_SPL_LOAD_FIT=y -CONFIG_SPL_FIT_GENERATOR="arch/arm/mach-imx/mkimage_fit_atf.sh" +# CONFIG_SPL_FIT_GENERATOR is not set CONFIG_BOOTDELAY=3 CONFIG_LOG=y CONFIG_BOARD_EARLY_INIT_F=y -- 2.17.1

5 7

Re: Bug#1003490: u-boot: FTBFS on arch:all with qemu-ppce500 target
by Vagrant Cascadian 26 Jan '22

26 Jan '22

A bug in Debian is causing a build failure of the qemu-ppce500 target: https://bugs.debian.org/1003490 I've CCed u-boot in case they're not aware of the issue. Some background follows... On 2022-01-15, Aurelien Jarno wrote: > On 2022-01-11 16:40, Vagrant Cascadian wrote: >> On 2022-01-11, Lennart Sorensen wrote: >> > On Mon, Jan 10, 2022 at 05:10:04PM -0800, Vagrant Cascadian wrote: >> >> Something in the toolchain recently changed which causes u-boot arch:all >> >> build to FTBFS... I suspect binutils, as building in "bookworm" still >> >> works fine where binutils hasn't yet migrated. >> >> >> >> On arch:all builds the qemu-ppce500 target is cross-compiled. >> >> >> >> Full log: >> >> >> >> https://buildd.debian.org/status/fetch.php?pkg=u-boot&arch=all&ver=2022.01%… >> >> >> >> The hopefully relevent lines from the build log: >> >> >> >> powerpc-linux-gnu-gcc -Wp,-MD,arch/powerpc/cpu/mpc85xx/.tlb.o.d -nostdinc -isystem /usr/lib/gcc-cross/powerpc-linux-gnu/11/include -Iinclude -I/<<PKGBUILDDIR>>/include -I/<<PKGBUILDDIR>>/arch/powerpc/include -include /<<PKGBUILDDIR>>/include/linux/kconfig.h -I/<<PKGBUILDDIR>>/arch/powerpc/cpu/mpc85xx -Iarch/powerpc/cpu/mpc85xx -D__KERNEL__ -D__UBOOT__ -Wall -Wstrict-prototypes -Wno-format-security -fno-builtin -ffreestanding -std=gnu11 -fshort-wchar -fno-strict-aliasing -fno-PIE -Os -fno-stack-protector -fno-delete-null-pointer-checks -Wno-pointer-sign -Wno-stringop-truncation -Wno-zero-length-bounds -Wno-array-bounds -Wno-stringop-overflow -Wno-maybe-uninitialized -fmacro-prefix-map=/<<PKGBUILDDIR>>/= -g -fstack-usage -Wno-format-nonliteral -Wno-address-of-packed-member -Wno-unused-but-set-variable -Werror=date-time -Wno-packed-not-aligned -D__powerpc__ -ffixed-r2 -m32 -fno-ira-hoist-pressure -Wa,-me500 -msoft-float -mno-string -fpic -mrelocatable -ffunction-sections -fdata-sections -mcall-linux -msingle-pic-base -fno-jump-tables -pipe -DKBUILD_BASENAME='"tlb"' -DKBUILD_MODNAME='"tlb"' -c -o arch/powerpc/cpu/mpc85xx/tlb.o /<<PKGBUILDDIR>>/arch/powerpc/cpu/mpc85xx/tlb.c >> >> ... >> >> {standard input}: Assembler messages: >> >> {standard input}:127: Error: unrecognized opcode: `tlbre' >> >> {standard input}:418: Error: unrecognized opcode: `tlbre' >> >> {standard input}:821: Error: unrecognized opcode: `msync' >> >> {standard input}:821: Error: unrecognized opcode: `tlbwe' >> >> {standard input}:884: Error: unrecognized opcode: `tlbsx' >> >> make[4]: *** [/<<PKGBUILDDIR>>/scripts/Makefile.build:253: arch/powerpc/cpu/mpc85xx/tlb.o] Error 1 >> >> make[3]: *** [/<<PKGBUILDDIR>>/Makefile:1810: arch/powerpc/cpu/mpc85xx] Error 2 >> >> make[3]: *** Waiting for unfinished jobs.... >> >> powerpc-linux-gnu-gcc -Wp,-MD,arch/powerpc/lib/.traps.o.d -nost ... >> The binutils versions appear to be: >> >> succeeding, bookworm 2.37-10.1 >> failing, sid 2.37.50.20220106-2 >> > > Yep, this is due to commit b25f942e18d6ecd7ec3e2d2e9930eb4f996c258a on > the binutils side [1], which changes the behavior of `.machine` > directives to override, rather than augment, the base CPU. GCC is called > with -Wa,-me500 to enable PowerPC e500 instructions on the assembler > side, but as the default GCC machine is ppc, a `.set machine ppc` is > emitted at the beginning of the assembly code. > > One option would be to force the CPU to e500 on the GCC side, however > support for it has been removed. The options is therefore to force the > machine in the assembly code. This is what the attached patch does. Somehow I missed that you had attached a patch! I will try to get this tested and uploaded to Debian soon... live well, vagrant > --- u-boot-2022.01+dfsg.orig/arch/powerpc/cpu/mpc85xx/tlb.c > +++ u-boot-2022.01+dfsg/arch/powerpc/cpu/mpc85xx/tlb.c > @@ -50,7 +50,10 @@ void read_tlbcam_entry(int idx, u32 *val > u32 _mas1; > > mtspr(MAS0, FSL_BOOKE_MAS0(1, idx, 0)); > - asm volatile("tlbre;isync"); > + asm volatile(".machine push;\n" > + ".machine e500;\n" > + "tlbre;isync;\n" > + ".machine pop;\n"); > _mas1 = mfspr(MAS1); > > *valid = (_mas1 & MAS1_VALID); > @@ -109,7 +112,10 @@ void init_used_tlb_cams(void) > /* walk all the entries */ > for (i = 0; i < num_cam; i++) { > mtspr(MAS0, FSL_BOOKE_MAS0(1, i, 0)); > - asm volatile("tlbre;isync"); > + asm volatile(".machine push;\n" > + ".machine e500;\n" > + "tlbre;isync;\n" > + ".machine pop;"); > if (mfspr(MAS1) & MAS1_VALID) > use_tlb_cam(i); > } > @@ -183,7 +189,10 @@ void disable_tlb(u8 esel) > #ifdef CONFIG_ENABLE_36BIT_PHYS > mtspr(MAS7, 0); > #endif > - asm volatile("isync;msync;tlbwe;isync"); > + asm volatile(".machine push;\n" > + ".machine e500;\n" > + "isync;msync;tlbwe;isync;\n" > + ".machine pop;\n"); > > #ifdef CONFIG_ADDR_MAP > if (gd->flags & GD_FLG_RELOC) > @@ -193,7 +202,11 @@ void disable_tlb(u8 esel) > > static void tlbsx (const volatile unsigned *addr) > { > - __asm__ __volatile__ ("tlbsx 0,%0" : : "r" (addr), "m" (*addr)); > + __asm__ __volatile__ (".machine push;\n" > + ".machine e500;\n" > + "tlbsx 0,%0;\n" > + ".machine pop;\n" > + : : "r" (addr), "m" (*addr)); > } > > /* return -1 if we didn't find anything */

2 2

← Newer
1
...
31
32
33
34
35
36
37
...
70
Older →

Jump to page: