From 7cf88d7dbdc8277f0c9ffb282bcc7a890a04c697 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Thu, 1 Feb 2018 10:00:02 -0600 Subject: [PATCH] Make sure that labeling is used consistently in all function headers. --- arch/arm/src/arm/pg_macros.h | 6 +- arch/arm/src/arm/up_blocktask.c | 2 +- arch/arm/src/arm/up_dataabort.c | 2 +- arch/arm/src/arm/up_reprioritizertr.c | 2 +- arch/arm/src/arm/up_unblocktask.c | 2 +- arch/arm/src/arm/vfork.S | 4 +- arch/arm/src/armv6-m/up_blocktask.c | 2 +- arch/arm/src/armv6-m/up_fullcontextrestore.S | 2 +- arch/arm/src/armv6-m/up_reprioritizertr.c | 2 +- arch/arm/src/armv6-m/up_saveusercontext.S | 2 +- arch/arm/src/armv6-m/up_signal_dispatch.c | 4 +- arch/arm/src/armv6-m/up_signal_handler.S | 4 +- arch/arm/src/armv6-m/up_switchcontext.S | 2 +- arch/arm/src/armv6-m/up_unblocktask.c | 2 +- arch/arm/src/armv6-m/vfork.S | 4 +- arch/arm/src/armv7-a/arm_blocktask.c | 2 +- arch/arm/src/armv7-a/arm_cpuhead.S | 2 +- arch/arm/src/armv7-a/arm_cpuidlestack.c | 2 +- arch/arm/src/armv7-a/arm_dataabort.c | 2 +- arch/arm/src/armv7-a/arm_fullcontextrestore.S | 2 +- arch/arm/src/armv7-a/arm_gicv2.c | 4 +- arch/arm/src/armv7-a/arm_reprioritizertr.c | 2 +- arch/arm/src/armv7-a/arm_signal_dispatch.c | 4 +- arch/arm/src/armv7-a/arm_unblocktask.c | 2 +- arch/arm/src/armv7-a/arm_vfork.S | 4 +- arch/arm/src/armv7-a/crt0.c | 4 +- arch/arm/src/armv7-a/gic.h | 6 +- arch/arm/src/armv7-a/mmu.h | 26 ++-- arch/arm/src/armv7-a/smp.h | 4 +- .../src/armv7-m/gnu/up_fullcontextrestore.S | 2 +- arch/arm/src/armv7-m/gnu/up_saveusercontext.S | 2 +- arch/arm/src/armv7-m/gnu/up_signal_handler.S | 4 +- arch/arm/src/armv7-m/gnu/up_switchcontext.S | 2 +- arch/arm/src/armv7-m/gnu/vfork.S | 4 +- .../src/armv7-m/iar/up_fullcontextrestore.S | 2 +- arch/arm/src/armv7-m/iar/up_saveusercontext.S | 2 +- arch/arm/src/armv7-m/iar/up_switchcontext.S | 2 +- arch/arm/src/armv7-m/iar/vfork.S | 4 +- arch/arm/src/armv7-m/up_blocktask.c | 2 +- arch/arm/src/armv7-m/up_reprioritizertr.c | 2 +- arch/arm/src/armv7-m/up_signal_dispatch.c | 4 +- arch/arm/src/armv7-m/up_unblocktask.c | 2 +- arch/arm/src/armv7-r/arm_blocktask.c | 2 +- arch/arm/src/armv7-r/arm_dataabort.c | 2 +- arch/arm/src/armv7-r/arm_fullcontextrestore.S | 2 +- arch/arm/src/armv7-r/arm_reprioritizertr.c | 2 +- arch/arm/src/armv7-r/arm_signal_dispatch.c | 4 +- arch/arm/src/armv7-r/arm_signal_handler.S | 4 +- arch/arm/src/armv7-r/arm_unblocktask.c | 2 +- arch/arm/src/armv7-r/arm_vfork.S | 4 +- arch/arm/src/bcm2708/bcm_miniuart.c | 2 +- arch/arm/src/common/up_checkstack.c | 4 +- arch/arm/src/common/up_createstack.c | 2 +- arch/arm/src/common/up_releasestack.c | 2 +- arch/arm/src/common/up_stackframe.c | 2 +- arch/arm/src/common/up_usestack.c | 2 +- arch/arm/src/common/up_vfork.c | 2 +- arch/arm/src/dm320/dm320_framebuffer.c | 4 +- arch/arm/src/efm32/efm32_adc.c | 2 +- arch/arm/src/efm32/efm32_bitband.c | 8 +- arch/arm/src/efm32/efm32_dma.c | 2 +- arch/arm/src/efm32/efm32_dma.h | 2 +- arch/arm/src/efm32/efm32_i2c.h | 4 +- arch/arm/src/efm32/efm32_pm.h | 2 +- arch/arm/src/efm32/efm32_pwm.c | 18 +-- arch/arm/src/efm32/efm32_rmu.c | 2 +- arch/arm/src/efm32/efm32_rmu.h | 2 +- arch/arm/src/efm32/efm32_spi.c | 4 +- arch/arm/src/efm32/efm32_spi.h | 2 +- arch/arm/src/efm32/efm32_timer.c | 6 +- arch/arm/src/efm32/efm32_usbhost.c | 34 ++--- arch/arm/src/imx1/imx_cspi.h | 2 +- arch/arm/src/imx1/imx_spi.c | 2 +- arch/arm/src/imx6/imx_cpuboot.c | 2 +- arch/arm/src/imx6/imx_ecspi.c | 2 +- arch/arm/src/imx6/imx_ecspi.h | 2 +- arch/arm/src/kinetis/kinetis.h | 14 +- arch/arm/src/kinetis/kinetis_i2c.h | 4 +- arch/arm/src/kinetis/kinetis_lpserial.c | 4 +- arch/arm/src/kinetis/kinetis_pin.c | 2 +- arch/arm/src/kinetis/kinetis_pinirq.c | 2 +- arch/arm/src/kinetis/kinetis_pwm.c | 14 +- arch/arm/src/kinetis/kinetis_sdhc.c | 6 +- arch/arm/src/kinetis/kinetis_serial.c | 4 +- arch/arm/src/kinetis/kinetis_spi.c | 2 +- arch/arm/src/kinetis/kinetis_spi.h | 2 +- arch/arm/src/kl/kl_gpio.h | 2 +- arch/arm/src/kl/kl_gpioirq.c | 4 +- arch/arm/src/kl/kl_pwm.c | 14 +- arch/arm/src/kl/kl_spi.c | 2 +- arch/arm/src/kl/kl_spi.h | 2 +- arch/arm/src/lc823450/lc823450_cpuidlestack.c | 2 +- arch/arm/src/lc823450/lc823450_sdc.c | 4 +- arch/arm/src/lc823450/lc823450_spi.c | 2 +- arch/arm/src/lc823450/lc823450_syscontrol.c | 2 +- arch/arm/src/lc823450/lc823450_wdt.c | 18 +-- arch/arm/src/lpc11xx/lpc11_i2c.h | 4 +- arch/arm/src/lpc11xx/lpc11_spi.c | 2 +- arch/arm/src/lpc11xx/lpc11_spi.h | 2 +- arch/arm/src/lpc11xx/lpc11_ssp.c | 8 +- arch/arm/src/lpc11xx/lpc11_ssp.h | 2 +- arch/arm/src/lpc11xx/lpc11_timer.c | 18 +-- arch/arm/src/lpc17xx/lpc17_can.c | 4 +- arch/arm/src/lpc17xx/lpc17_can.h | 2 +- arch/arm/src/lpc17xx/lpc17_i2c.h | 4 +- arch/arm/src/lpc17xx/lpc17_lcd.c | 4 +- arch/arm/src/lpc17xx/lpc17_mcpwm.c | 20 +-- arch/arm/src/lpc17xx/lpc17_pwm.c | 20 +-- arch/arm/src/lpc17xx/lpc17_sdcard.c | 6 +- arch/arm/src/lpc17xx/lpc17_sdcard.h | 6 +- arch/arm/src/lpc17xx/lpc17_spi.c | 2 +- arch/arm/src/lpc17xx/lpc17_spi.h | 2 +- arch/arm/src/lpc17xx/lpc17_ssp.c | 8 +- arch/arm/src/lpc17xx/lpc17_ssp.h | 2 +- arch/arm/src/lpc17xx/lpc17_timer.c | 18 +-- arch/arm/src/lpc17xx/lpc17_usbhost.c | 40 +++--- arch/arm/src/lpc214x/lpc214x_spi.h | 2 +- arch/arm/src/lpc2378/lpc23xx_i2c.h | 4 +- arch/arm/src/lpc2378/lpc23xx_spi.c | 2 +- arch/arm/src/lpc2378/lpc23xx_spi.h | 2 +- arch/arm/src/lpc31xx/lpc31.h | 8 +- arch/arm/src/lpc31xx/lpc31_ehci.c | 40 +++--- arch/arm/src/lpc31xx/lpc31_i2c.h | 4 +- arch/arm/src/lpc31xx/lpc31_spi.c | 2 +- arch/arm/src/lpc43xx/lpc43_can.c | 4 +- arch/arm/src/lpc43xx/lpc43_can.h | 2 +- arch/arm/src/lpc43xx/lpc43_ehci.c | 40 +++--- arch/arm/src/lpc43xx/lpc43_i2c.h | 4 +- arch/arm/src/lpc43xx/lpc43_pinconfig.c | 2 +- arch/arm/src/lpc43xx/lpc43_pinconfig.h | 2 +- arch/arm/src/lpc43xx/lpc43_sdmmc.c | 2 +- arch/arm/src/lpc43xx/lpc43_sdmmc.h | 2 +- arch/arm/src/lpc43xx/lpc43_spi.c | 4 +- arch/arm/src/lpc43xx/lpc43_spi.h | 2 +- arch/arm/src/lpc43xx/lpc43_spifi.c | 4 +- arch/arm/src/lpc43xx/lpc43_spifi.h | 2 +- arch/arm/src/lpc43xx/lpc43_ssp.c | 6 +- arch/arm/src/lpc43xx/lpc43_ssp.h | 2 +- arch/arm/src/lpc43xx/lpc43_timer.c | 16 +-- arch/arm/src/lpc43xx/lpc43_timer.h | 2 +- arch/arm/src/lpc43xx/lpc43_wdt.h | 2 +- arch/arm/src/lpc43xx/lpc43_wwdt.c | 18 +-- arch/arm/src/lpc54xx/lpc54_i2c_master.h | 4 +- arch/arm/src/lpc54xx/lpc54_lcd.c | 4 +- arch/arm/src/lpc54xx/lpc54_sdmmc.c | 2 +- arch/arm/src/lpc54xx/lpc54_sdmmc.h | 2 +- arch/arm/src/lpc54xx/lpc54_serial.c | 2 +- arch/arm/src/lpc54xx/lpc54_spi_master.c | 2 +- arch/arm/src/lpc54xx/lpc54_spi_master.h | 2 +- arch/arm/src/lpc54xx/lpc54_wwdt.c | 18 +-- arch/arm/src/lpc54xx/lpc54_wwdt.h | 2 +- arch/arm/src/nuc1xx/nuc_gpio.c | 2 +- arch/arm/src/nuc1xx/nuc_gpio.h | 2 +- arch/arm/src/sam34/sam4cm_cpuidlestack.c | 2 +- arch/arm/src/sam34/sam_hsmci.c | 6 +- arch/arm/src/sam34/sam_hsmci.h | 6 +- arch/arm/src/sam34/sam_rtt.c | 16 +-- arch/arm/src/sam34/sam_rtt.h | 2 +- arch/arm/src/sam34/sam_spi.c | 2 +- arch/arm/src/sam34/sam_spi.h | 8 +- arch/arm/src/sam34/sam_tc.c | 16 +-- arch/arm/src/sam34/sam_tc.h | 2 +- arch/arm/src/sam34/sam_twi.h | 4 +- arch/arm/src/sam34/sam_wdt.c | 18 +-- arch/arm/src/sam34/sam_wdt.h | 2 +- arch/arm/src/sama5/sam_adc.c | 4 +- arch/arm/src/sama5/sam_can.c | 14 +- arch/arm/src/sama5/sam_can.h | 2 +- arch/arm/src/sama5/sam_ehci.c | 40 +++--- arch/arm/src/sama5/sam_hsmci.c | 6 +- arch/arm/src/sama5/sam_hsmci.h | 8 +- arch/arm/src/sama5/sam_hsmci_clkdiv.c | 2 +- arch/arm/src/sama5/sam_irq.c | 4 +- arch/arm/src/sama5/sam_lcd.c | 4 +- arch/arm/src/sama5/sam_nand.c | 124 +++++++++--------- arch/arm/src/sama5/sam_nand.h | 10 +- arch/arm/src/sama5/sam_ohci.c | 38 +++--- arch/arm/src/sama5/sam_pwm.c | 22 ++-- arch/arm/src/sama5/sam_spi.c | 2 +- arch/arm/src/sama5/sam_spi.h | 8 +- arch/arm/src/sama5/sam_ssc.c | 6 +- arch/arm/src/sama5/sam_ssc.h | 2 +- arch/arm/src/sama5/sam_tsd.c | 6 +- arch/arm/src/sama5/sam_tsd.h | 2 +- arch/arm/src/sama5/sam_twi.h | 4 +- arch/arm/src/sama5/sam_wdt.c | 18 +-- arch/arm/src/sama5/sam_wdt.h | 2 +- arch/arm/src/samdl/sam_port.h | 2 +- arch/arm/src/samdl/sam_spi.c | 2 +- arch/arm/src/samdl/sam_spi.h | 8 +- arch/arm/src/samv7/sam_hsmci.c | 6 +- arch/arm/src/samv7/sam_hsmci.h | 8 +- arch/arm/src/samv7/sam_hsmci_clkdiv.c | 2 +- arch/arm/src/samv7/sam_mcan.c | 8 +- arch/arm/src/samv7/sam_mcan.h | 2 +- arch/arm/src/samv7/sam_qspi.c | 2 +- arch/arm/src/samv7/sam_qspi.h | 2 +- arch/arm/src/samv7/sam_rswdt.c | 18 +-- arch/arm/src/samv7/sam_spi.c | 2 +- arch/arm/src/samv7/sam_spi.h | 10 +- arch/arm/src/samv7/sam_spi_slave.c | 2 +- arch/arm/src/samv7/sam_ssc.c | 6 +- arch/arm/src/samv7/sam_ssc.h | 2 +- arch/arm/src/samv7/sam_twihs.h | 4 +- arch/arm/src/samv7/sam_wdt.c | 18 +-- arch/arm/src/samv7/sam_wdt.h | 4 +- arch/arm/src/stm32/stm32_1wire.c | 6 +- arch/arm/src/stm32/stm32_1wire.h | 4 +- arch/arm/src/stm32/stm32_adc.c | 2 +- arch/arm/src/stm32/stm32_can.c | 26 ++-- arch/arm/src/stm32/stm32_can.h | 2 +- arch/arm/src/stm32/stm32_dma.h | 4 +- arch/arm/src/stm32/stm32_dma2d.c | 54 ++++---- arch/arm/src/stm32/stm32_dma2d.h | 34 ++--- arch/arm/src/stm32/stm32_exti.h | 2 +- arch/arm/src/stm32/stm32_exti_alarm.c | 2 +- arch/arm/src/stm32/stm32_exti_pwr.c | 2 +- arch/arm/src/stm32/stm32_exti_pwr.h | 2 +- arch/arm/src/stm32/stm32_exti_wakeup.c | 2 +- arch/arm/src/stm32/stm32_flash.h | 8 +- arch/arm/src/stm32/stm32_gpio.c | 4 +- arch/arm/src/stm32/stm32_hrtim.c | 20 +-- arch/arm/src/stm32/stm32_i2c.h | 4 +- arch/arm/src/stm32/stm32_i2s.c | 4 +- arch/arm/src/stm32/stm32_i2s.h | 2 +- arch/arm/src/stm32/stm32_iwdg.c | 12 +- arch/arm/src/stm32/stm32_ltdc.c | 62 ++++----- arch/arm/src/stm32/stm32_ltdc.h | 42 +++--- arch/arm/src/stm32/stm32_otgfshost.c | 34 ++--- arch/arm/src/stm32/stm32_otghshost.c | 34 ++--- arch/arm/src/stm32/stm32_pm.h | 2 +- arch/arm/src/stm32/stm32_pminitialize.c | 4 +- arch/arm/src/stm32/stm32_pmstandby.c | 2 +- arch/arm/src/stm32/stm32_pwm.c | 24 ++-- arch/arm/src/stm32/stm32_pwr.c | 8 +- arch/arm/src/stm32/stm32_pwr.h | 8 +- arch/arm/src/stm32/stm32_qencoder.c | 4 +- arch/arm/src/stm32/stm32_qencoder.h | 2 +- arch/arm/src/stm32/stm32_sdadc.c | 2 +- arch/arm/src/stm32/stm32_sdio.c | 6 +- arch/arm/src/stm32/stm32_sdio.h | 6 +- arch/arm/src/stm32/stm32_serial.c | 4 +- arch/arm/src/stm32/stm32_spi.c | 4 +- arch/arm/src/stm32/stm32_spi.h | 2 +- arch/arm/src/stm32/stm32_tim.h | 2 +- arch/arm/src/stm32/stm32_tim_lowerhalf.c | 12 +- arch/arm/src/stm32/stm32_wdg.h | 4 +- arch/arm/src/stm32/stm32_wwdg.c | 18 +-- arch/arm/src/stm32/stm32f10xxx_dma.c | 4 +- arch/arm/src/stm32/stm32f20xxx_dma.c | 4 +- arch/arm/src/stm32/stm32f33xxx_adc.c | 2 +- arch/arm/src/stm32/stm32f33xxx_dma.c | 4 +- arch/arm/src/stm32/stm32f40xxx_dma.c | 4 +- arch/arm/src/stm32f0/stm32f0_gpio.c | 4 +- arch/arm/src/stm32f0/stm32f0_gpio.h | 4 +- arch/arm/src/stm32f0/stm32f0_i2c.h | 4 +- arch/arm/src/stm32f0/stm32f0_serial.c | 4 +- arch/arm/src/stm32f7/stm32_adc.c | 2 +- arch/arm/src/stm32f7/stm32_dma.c | 4 +- arch/arm/src/stm32f7/stm32_dma.h | 4 +- arch/arm/src/stm32f7/stm32_dma2d.c | 54 ++++---- arch/arm/src/stm32f7/stm32_dma2d.h | 34 ++--- arch/arm/src/stm32f7/stm32_exti_alarm.c | 2 +- arch/arm/src/stm32f7/stm32_exti_pwr.c | 2 +- arch/arm/src/stm32f7/stm32_exti_pwr.h | 2 +- arch/arm/src/stm32f7/stm32_gpio.c | 4 +- arch/arm/src/stm32f7/stm32_i2c.h | 4 +- arch/arm/src/stm32f7/stm32_ltdc.c | 62 ++++----- arch/arm/src/stm32f7/stm32_ltdc.h | 42 +++--- arch/arm/src/stm32f7/stm32_otghost.c | 34 ++--- arch/arm/src/stm32f7/stm32_pwr.c | 6 +- arch/arm/src/stm32f7/stm32_pwr.h | 2 +- arch/arm/src/stm32f7/stm32_sdmmc.c | 6 +- arch/arm/src/stm32f7/stm32_sdmmc.h | 6 +- arch/arm/src/stm32f7/stm32_serial.c | 4 +- arch/arm/src/stm32f7/stm32_spi.c | 4 +- arch/arm/src/stm32f7/stm32_spi.h | 2 +- arch/arm/src/stm32f7/stm32_tim.h | 2 +- arch/arm/src/stm32l4/stm32l4_adc.c | 2 +- arch/arm/src/stm32l4/stm32l4_can.c | 20 +-- arch/arm/src/stm32l4/stm32l4_can.h | 2 +- arch/arm/src/stm32l4/stm32l4_comp.c | 2 +- arch/arm/src/stm32l4/stm32l4_dfsdm.c | 2 +- arch/arm/src/stm32l4/stm32l4_dma.h | 4 +- arch/arm/src/stm32l4/stm32l4_exti.h | 6 +- arch/arm/src/stm32l4/stm32l4_exti_alarm.c | 2 +- arch/arm/src/stm32l4/stm32l4_exti_comp.c | 2 +- arch/arm/src/stm32l4/stm32l4_exti_pwr.c | 2 +- arch/arm/src/stm32l4/stm32l4_exti_pwr.h | 2 +- arch/arm/src/stm32l4/stm32l4_exti_wakeup.c | 2 +- arch/arm/src/stm32l4/stm32l4_gpio.c | 4 +- arch/arm/src/stm32l4/stm32l4_gpio.h | 4 +- arch/arm/src/stm32l4/stm32l4_i2c.h | 4 +- arch/arm/src/stm32l4/stm32l4_iwdg.c | 12 +- arch/arm/src/stm32l4/stm32l4_otgfshost.c | 34 ++--- arch/arm/src/stm32l4/stm32l4_pm.h | 2 +- arch/arm/src/stm32l4/stm32l4_pminitialize.c | 4 +- arch/arm/src/stm32l4/stm32l4_pmstandby.c | 2 +- arch/arm/src/stm32l4/stm32l4_pwm.c | 24 ++-- arch/arm/src/stm32l4/stm32l4_qencoder.c | 4 +- arch/arm/src/stm32l4/stm32l4_qencoder.h | 2 +- arch/arm/src/stm32l4/stm32l4_qspi.c | 6 +- arch/arm/src/stm32l4/stm32l4_qspi.h | 6 +- arch/arm/src/stm32l4/stm32l4_sai.c | 6 +- arch/arm/src/stm32l4/stm32l4_sdmmc.c | 6 +- arch/arm/src/stm32l4/stm32l4_sdmmc.h | 6 +- arch/arm/src/stm32l4/stm32l4_serial.c | 4 +- arch/arm/src/stm32l4/stm32l4_spi.c | 4 +- arch/arm/src/stm32l4/stm32l4_spi.h | 2 +- arch/arm/src/stm32l4/stm32l4_tim.h | 2 +- arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c | 12 +- arch/arm/src/stm32l4/stm32l4_wdg.h | 4 +- arch/arm/src/stm32l4/stm32l4x6xx_dma.c | 4 +- arch/arm/src/str71x/str71x.h | 2 +- arch/arm/src/tiva/tiva_adc.h | 34 ++--- arch/arm/src/tiva/tiva_adclib.c | 34 ++--- arch/arm/src/tiva/tiva_adclow.c | 2 +- arch/arm/src/tiva/tiva_gpioirq.c | 2 +- arch/arm/src/tiva/tiva_i2c.h | 4 +- arch/arm/src/tiva/tiva_pwm.c | 12 +- arch/arm/src/tiva/tiva_qencoder.c | 16 +-- arch/arm/src/tiva/tiva_ssi.c | 2 +- arch/arm/src/tiva/tiva_ssi.h | 2 +- arch/arm/src/tiva/tiva_timer.h | 2 +- arch/arm/src/tiva/tiva_timerlow32.c | 22 ++-- arch/arm/src/tms570/tms570_irq.c | 4 +- arch/arm/src/tms570/tms570_selftest.h | 2 +- arch/arm/src/xmc4/xmc4_i2c.h | 4 +- arch/arm/src/xmc4/xmc4_serial.c | 2 +- arch/arm/src/xmc4/xmc4_spi.h | 2 +- arch/avr/src/at32uc3/at32uc3_gpioirq.c | 4 +- arch/avr/src/avr/avr.h | 2 +- arch/avr/src/avr/up_blocktask.c | 2 +- arch/avr/src/avr/up_checkstack.c | 4 +- arch/avr/src/avr/up_createstack.c | 2 +- arch/avr/src/avr/up_reprioritizertr.c | 2 +- arch/avr/src/avr/up_spi.c | 2 +- arch/avr/src/avr/up_stackframe.c | 2 +- arch/avr/src/avr/up_switchcontext.S | 2 +- arch/avr/src/avr/up_unblocktask.c | 2 +- arch/avr/src/avr/up_usestack.c | 2 +- arch/avr/src/avr32/up_blocktask.c | 2 +- arch/avr/src/avr32/up_createstack.c | 2 +- arch/avr/src/avr32/up_reprioritizertr.c | 2 +- arch/avr/src/avr32/up_stackframe.c | 2 +- arch/avr/src/avr32/up_switchcontext.S | 2 +- arch/avr/src/avr32/up_unblocktask.c | 2 +- arch/avr/src/avr32/up_usestack.c | 2 +- arch/avr/src/common/up_releasestack.c | 2 +- arch/hc/src/common/up_blocktask.c | 2 +- arch/hc/src/common/up_createstack.c | 2 +- arch/hc/src/common/up_releasestack.c | 2 +- arch/hc/src/common/up_reprioritizertr.c | 2 +- arch/hc/src/common/up_stackframe.c | 2 +- arch/hc/src/common/up_unblocktask.c | 2 +- arch/hc/src/common/up_usestack.c | 2 +- arch/hc/src/m9s12/m9s12.h | 2 +- arch/mips/src/common/up_createstack.c | 2 +- arch/mips/src/common/up_releasestack.c | 2 +- arch/mips/src/common/up_stackframe.c | 2 +- arch/mips/src/common/up_usestack.c | 2 +- arch/mips/src/mips32/up_blocktask.c | 2 +- arch/mips/src/mips32/up_reprioritizertr.c | 2 +- arch/mips/src/mips32/up_unblocktask.c | 2 +- arch/mips/src/mips32/up_vfork.c | 4 +- arch/mips/src/mips32/vfork.S | 4 +- arch/mips/src/pic32mx/pic32mx-spi.c | 2 +- arch/mips/src/pic32mx/pic32mx.h | 2 +- arch/mips/src/pic32mz/pic32mz-spi.c | 2 +- arch/mips/src/pic32mz/pic32mz-spi.h | 2 +- arch/misoc/src/lm32/lm32_blocktask.c | 2 +- arch/misoc/src/lm32/lm32_createstack.c | 2 +- arch/misoc/src/lm32/lm32_releasestack.c | 2 +- arch/misoc/src/lm32/lm32_reprioritizertr.c | 2 +- arch/misoc/src/lm32/lm32_stackframe.c | 2 +- arch/misoc/src/lm32/lm32_unblocktask.c | 2 +- arch/renesas/src/common/up_blocktask.c | 2 +- arch/renesas/src/common/up_createstack.c | 2 +- arch/renesas/src/common/up_releasestack.c | 2 +- arch/renesas/src/common/up_reprioritizertr.c | 2 +- arch/renesas/src/common/up_stackframe.c | 2 +- arch/renesas/src/common/up_unblocktask.c | 2 +- arch/renesas/src/common/up_usestack.c | 2 +- arch/risc-v/src/common/up_createstack.c | 2 +- arch/risc-v/src/common/up_releasestack.c | 2 +- arch/risc-v/src/common/up_stackframe.c | 2 +- arch/risc-v/src/common/up_usestack.c | 2 +- arch/risc-v/src/nr5m100/nr5_timer.h | 2 +- arch/risc-v/src/rv32im/up_blocktask.c | 2 +- arch/risc-v/src/rv32im/up_reprioritizertr.c | 2 +- arch/risc-v/src/rv32im/up_unblocktask.c | 2 +- arch/risc-v/src/rv32im/up_vfork.c | 4 +- arch/sim/src/up_blocktask.c | 2 +- arch/sim/src/up_cpuidlestack.c | 2 +- arch/sim/src/up_createstack.c | 2 +- arch/sim/src/up_framebuffer.c | 4 +- arch/sim/src/up_qspiflash.c | 2 +- arch/sim/src/up_releasestack.c | 2 +- arch/sim/src/up_reprioritizertr.c | 2 +- arch/sim/src/up_spiflash.c | 2 +- arch/sim/src/up_stackframe.c | 2 +- arch/sim/src/up_unblocktask.c | 2 +- arch/sim/src/up_usestack.c | 2 +- arch/x86/src/common/up_blocktask.c | 2 +- arch/x86/src/common/up_reprioritizertr.c | 2 +- arch/x86/src/common/up_unblocktask.c | 2 +- arch/x86/src/i486/up_createstack.c | 2 +- arch/x86/src/i486/up_releasestack.c | 2 +- arch/x86/src/i486/up_stackframe.c | 2 +- arch/x86/src/i486/up_usestack.c | 2 +- arch/x86/src/qemu/qemu.h | 2 +- arch/x86/src/qemu/qemu_vga.c | 3 +- arch/xtensa/src/common/xtensa_assert.c | 4 +- arch/xtensa/src/common/xtensa_blocktask.c | 2 +- arch/xtensa/src/common/xtensa_checkstack.c | 4 +- arch/xtensa/src/common/xtensa_createstack.c | 2 +- arch/xtensa/src/common/xtensa_releasestack.c | 2 +- .../src/common/xtensa_reprioritizertr.c | 2 +- arch/xtensa/src/common/xtensa_stackframe.c | 2 +- arch/xtensa/src/common/xtensa_unblocktask.c | 2 +- arch/xtensa/src/common/xtensa_usestack.c | 2 +- arch/xtensa/src/esp32/esp32_cpuidlestack.c | 2 +- arch/z16/src/common/up_blocktask.c | 2 +- arch/z16/src/common/up_createstack.c | 2 +- arch/z16/src/common/up_releasestack.c | 2 +- arch/z16/src/common/up_reprioritizertr.c | 2 +- arch/z16/src/common/up_stackframe.c | 2 +- arch/z16/src/common/up_unblocktask.c | 2 +- arch/z16/src/common/up_usestack.c | 2 +- arch/z16/src/z16f/z16f_espi.c | 2 +- arch/z16/src/z16f/z16f_lowuart.S | 4 +- arch/z80/src/common/up_blocktask.c | 2 +- arch/z80/src/common/up_createstack.c | 2 +- arch/z80/src/common/up_releasestack.c | 2 +- arch/z80/src/common/up_reprioritizertr.c | 2 +- arch/z80/src/common/up_stackframe.c | 2 +- arch/z80/src/common/up_unblocktask.c | 2 +- arch/z80/src/common/up_usestack.c | 2 +- arch/z80/src/ez80/ez80_i2c.c | 2 +- arch/z80/src/ez80/ez80_spi.c | 2 +- arch/z80/src/ez80/ez80f91_i2c.h | 4 +- arch/z80/src/ez80/ez80f91_spi.h | 2 +- arch/z80/src/z8/z8_i2c.c | 2 +- audio/audio.c | 6 +- binfmt/binfmt.h | 6 +- binfmt/binfmt_copyargv.c | 4 +- binfmt/binfmt_schedunload.c | 8 +- configs/cloudctrl/src/stm32_usb.c | 4 +- configs/dk-tm4c129x/include/board.h | 2 +- configs/dk-tm4c129x/src/tm4c_tmp100.c | 2 +- configs/ea3131/src/lpc31_usbhost.c | 4 +- configs/freedom-kl25z/src/kl_cc3000.c | 2 +- configs/freedom-kl25z/src/kl_spi.c | 6 +- configs/freedom-kl26z/src/kl_spi.c | 6 +- configs/indium-f7/src/stm32_usb.c | 4 +- configs/mcu123-lpc214x/src/lpc2148_spi1.c | 2 +- configs/mikroe-stm32f4/src/stm32_pm.c | 4 +- configs/mikroe-stm32f4/src/stm32_usb.c | 4 +- configs/nucleo-144/src/stm32_usb.c | 4 +- configs/nucleo-f303re/src/nucleo-f303re.h | 2 +- configs/nucleo-f303re/src/stm32_timer.c | 2 +- configs/nucleo-f334r8/src/nucleo-f334r8.h | 2 +- configs/nucleo-l432kc/src/stm32_timer.c | 2 +- configs/nucleo-l476rg/src/stm32_timer.c | 2 +- configs/nucleo-l496zg/src/stm32_usb.c | 4 +- configs/olimex-lpc-h3131/include/board.h | 4 +- configs/olimex-lpc-h3131/src/lpc31_usbhost.c | 4 +- configs/olimex-stm32-e407/src/stm32_usb.c | 4 +- configs/olimex-stm32-h407/src/stm32_usb.c | 2 +- configs/olimex-stm32-p207/src/stm32_usb.c | 4 +- configs/olimex-stm32-p407/src/stm32_usb.c | 4 +- configs/olimex-strp711/src/str71_spi.c | 2 +- configs/olimexino-stm32/src/olimexino-stm32.h | 2 +- configs/olimexino-stm32/src/stm32_usbdev.c | 2 +- configs/photon/src/photon.h | 4 +- configs/sam3u-ek/src/sam_spi.c | 4 +- configs/sam4e-ek/src/sam_spi.c | 4 +- configs/sam4l-xplained/src/sam_spi.c | 6 +- .../src/sam4s-xplained-pro.h | 2 +- configs/sama5d3-xplained/src/sam_nandflash.c | 2 +- configs/sama5d3-xplained/src/sam_spi.c | 4 +- configs/sama5d3-xplained/src/sam_usb.c | 4 +- configs/sama5d3x-ek/src/sam_nandflash.c | 2 +- configs/sama5d3x-ek/src/sam_spi.c | 4 +- configs/sama5d3x-ek/src/sam_usb.c | 4 +- configs/sama5d4-ek/src/sam_nandflash.c | 2 +- configs/sama5d4-ek/src/sam_spi.c | 4 +- configs/sama5d4-ek/src/sam_usb.c | 2 +- configs/samd20-xplained/src/sam_spi.c | 6 +- configs/samd21-xplained/src/sam_spi.c | 6 +- configs/same70-xplained/src/sam_spi.c | 4 +- configs/saml21-xplained/src/sam_spi.c | 6 +- configs/samv71-xult/src/sam_spi.c | 4 +- configs/shenzhou/src/stm32_usb.c | 4 +- configs/spark/src/stm32_cc3000.c | 2 +- configs/stm3210e-eval/include/board.h | 4 +- configs/stm3210e-eval/src/stm32_lm75.c | 4 +- configs/stm3210e-eval/src/stm32_pm.c | 4 +- configs/stm3220g-eval/src/stm32_usb.c | 4 +- configs/stm3240g-eval/src/stm32_usb.c | 4 +- configs/stm32butterfly2/src/stm32_boot.c | 2 +- configs/stm32butterfly2/src/stm32_leds.c | 8 +- configs/stm32f103-minimum/src/stm32_apa102.c | 2 +- .../stm32f103-minimum/src/stm32_apds9960.c | 2 +- configs/stm32f103-minimum/src/stm32_lm75.c | 4 +- configs/stm32f103-minimum/src/stm32_mcp2515.c | 2 +- configs/stm32f103-minimum/src/stm32_mfrc522.c | 2 +- .../stm32f103-minimum/src/stm32_nrf24l01.c | 2 +- .../stm32f103-minimum/src/stm32_veml6070.c | 2 +- .../stm32f103-minimum/src/stm32f103_minimum.h | 2 +- configs/stm32f334-disco/src/stm32f334-disco.h | 2 +- configs/stm32f411e-disco/src/stm32_usb.c | 4 +- configs/stm32f429i-disco/src/stm32_l3gd20.c | 2 +- configs/stm32f429i-disco/src/stm32_lcd.c | 10 +- configs/stm32f429i-disco/src/stm32_spi.c | 2 +- configs/stm32f429i-disco/src/stm32_usb.c | 2 +- .../stm32f429i-disco/src/stm32f429i-disco.h | 4 +- .../stm32f4discovery/src/stm32_bh1750fvi.c | 2 +- configs/stm32f4discovery/src/stm32_bmp180.c | 2 +- configs/stm32f4discovery/src/stm32_lis3dsh.c | 4 +- configs/stm32f4discovery/src/stm32_max31855.c | 2 +- configs/stm32f4discovery/src/stm32_max6675.c | 2 +- configs/stm32f4discovery/src/stm32_pm.c | 4 +- configs/stm32f4discovery/src/stm32_timer.c | 2 +- configs/stm32f4discovery/src/stm32_usb.c | 4 +- .../stm32f4discovery/src/stm32f4discovery.h | 2 +- configs/stm32f746-ws/src/stm32_usb.c | 4 +- configs/stm32l476vg-disco/src/stm32_usb.c | 4 +- configs/teensy-lc/src/kl_spi.c | 6 +- configs/u-blox-c027/src/lpc17_ubxmdm.c | 2 +- .../viewtool-stm32f107/src/stm32_mpl115a.c | 2 +- .../src/viewtool_stm32f107.h | 2 +- configs/zp214xpa/src/lpc2148_spi1.c | 2 +- crypto/aes.c | 4 +- drivers/analog/ad5410.c | 2 +- drivers/analog/ads1255.c | 2 +- drivers/analog/dac.c | 2 +- drivers/audio/tone.c | 2 +- drivers/can/can.c | 4 +- drivers/can/mcp2515.c | 6 +- drivers/contactless/pn532.c | 4 +- drivers/input/ajoystick.c | 2 +- drivers/input/button_upper.c | 2 +- drivers/input/djoystick.c | 2 +- drivers/input/nunchuck.c | 2 +- drivers/lcd/ili9341.c | 4 +- drivers/lcd/lcd_framebuffer.c | 4 +- drivers/leds/rgbled.c | 2 +- drivers/leds/userled_upper.c | 2 +- drivers/mtd/hamming.c | 12 +- drivers/mtd/mtd_config.c | 8 +- drivers/mtd/mtd_nand.c | 14 +- drivers/mtd/mtd_nandecc.c | 8 +- drivers/mtd/mtd_nandmodel.c | 6 +- drivers/mtd/mtd_nandscheme.c | 14 +- drivers/mtd/mtd_partition.c | 2 +- drivers/net/telnet.c | 6 +- drivers/pipes/fifo.c | 4 +- drivers/pipes/pipe.c | 4 +- drivers/power/battery_charger.c | 4 +- drivers/power/battery_gauge.c | 4 +- drivers/power/pm_initialize.c | 4 +- drivers/power/pm_register.c | 4 +- drivers/pwm.c | 4 +- drivers/ramdisk.c | 4 +- drivers/syslog/syslog_emergstream.c | 2 +- drivers/syslog/syslog_stream.c | 4 +- drivers/timers/rtc.c | 2 +- drivers/timers/timer.c | 6 +- drivers/timers/watchdog.c | 4 +- drivers/usbdev/cdcacm.c | 6 +- drivers/usbdev/composite.c | 2 +- drivers/usbdev/rndis.c | 2 +- drivers/usbdev/usbmsc.c | 2 +- drivers/usbdev/usbmsc.h | 2 +- drivers/usbdev/usbmsc_scsi.c | 12 +- drivers/usbhost/hid_parser.c | 4 +- drivers/usbhost/usbhost_cdcacm.c | 2 +- drivers/usbhost/usbhost_enumerate.c | 2 +- drivers/usbhost/usbhost_findclass.c | 4 +- drivers/usbhost/usbhost_hidkbd.c | 40 +++--- drivers/usbhost/usbhost_hidmouse.c | 34 ++--- drivers/usbhost/usbhost_hub.c | 28 ++-- drivers/usbhost/usbhost_registerclass.c | 2 +- drivers/usbhost/usbhost_skeleton.c | 30 ++--- drivers/usbhost/usbhost_storage.c | 46 +++---- drivers/usbhost/usbhost_xboxcontroller.c | 34 ++--- drivers/usbmonitor/usbmonitor.c | 4 +- drivers/wireless/cc1101.c | 2 +- drivers/wireless/cc3000/wlan.c | 4 +- drivers/wireless/ieee802154/xbee/xbee.c | 4 +- .../wireless/ieee802154/xbee/xbee_netdev.c | 12 +- .../wireless/spirit/drivers/spirit_netdev.c | 6 +- .../wireless/spirit/include/spirit_general.h | 2 +- drivers/wireless/spirit/include/spirit_spi.h | 12 +- drivers/wireless/spirit/lib/spirit_spi.c | 12 +- fs/dirent/fs_closedir.c | 4 +- fs/dirent/fs_opendir.c | 16 +-- fs/dirent/fs_readdir.c | 4 +- fs/dirent/fs_rewinddir.c | 4 +- fs/dirent/fs_seekdir.c | 4 +- fs/driver/driver.h | 6 +- fs/driver/fs_blockproxy.c | 4 +- fs/driver/fs_closeblockdriver.c | 4 +- fs/driver/fs_findblockdriver.c | 4 +- fs/driver/fs_openblockdriver.c | 4 +- fs/driver/fs_registerblockdriver.c | 2 +- fs/driver/fs_registerdriver.c | 2 +- fs/fat/fs_fat32dirent.c | 10 +- fs/fat/fs_fat32util.c | 5 +- fs/inode/fs_inodereserve.c | 2 +- fs/inode/inode.h | 2 +- fs/mount/fs_mount.c | 2 +- fs/mount/fs_umount2.c | 2 +- fs/mqueue/mq_close.c | 6 +- fs/mqueue/mq_open.c | 2 +- fs/mqueue/mq_unlink.c | 2 +- fs/mqueue/mqueue.h | 2 +- fs/nfs/nfs_util.c | 8 +- fs/nxffs/nxffs.h | 20 +-- fs/nxffs/nxffs_block.c | 2 +- fs/nxffs/nxffs_inode.c | 2 +- fs/nxffs/nxffs_open.c | 6 +- fs/nxffs/nxffs_pack.c | 26 ++-- fs/nxffs/nxffs_util.c | 2 +- fs/nxffs/nxffs_write.c | 2 +- fs/semaphore/sem_close.c | 2 +- fs/semaphore/sem_open.c | 2 +- fs/semaphore/sem_unlink.c | 2 +- fs/unionfs/fs_unionfs.c | 2 +- fs/vfs/fs_fstatfs.c | 3 +- fs/vfs/fs_ioctl.c | 4 +- fs/vfs/fs_lseek.c | 4 +- fs/vfs/fs_poll.c | 4 +- fs/vfs/fs_pread.c | 2 +- fs/vfs/fs_pwrite.c | 2 +- fs/vfs/fs_select.c | 4 +- fs/vfs/fs_sendfile.c | 2 +- fs/vfs/fs_statfs.c | 3 +- graphics/nxbe/nxbe.h | 14 +- graphics/nxbe/nxbe_bitmap.c | 2 +- graphics/nxbe/nxbe_closewindow.c | 2 +- graphics/nxbe/nxbe_fill.c | 2 +- graphics/nxbe/nxbe_filltrapezoid.c | 2 +- graphics/nxbe/nxbe_getrectangle.c | 2 +- graphics/nxbe/nxbe_move.c | 2 +- graphics/nxbe/nxbe_setpixel.c | 2 +- graphics/nxmu/nxfe.h | 10 +- graphics/nxmu/nxmu_openwindow.c | 2 +- graphics/nxmu/nxmu_releasebkgd.c | 2 +- graphics/nxmu/nxmu_requestbkgd.c | 2 +- graphics/nxmu/nxmu_sendclient.c | 2 +- graphics/nxmu/nxmu_sendclientwindow.c | 2 +- graphics/nxmu/nxmu_server.c | 2 +- graphics/nxterm/nx_register.c | 8 +- graphics/nxterm/nxtk_register.c | 8 +- graphics/nxterm/nxtool_register.c | 8 +- graphics/vnc/server/vnc_fbdev.c | 10 +- include/hex2bin.h | 10 +- include/nuttx/analog/adc.h | 2 +- include/nuttx/analog/dac.h | 2 +- include/nuttx/arch.h | 30 ++--- include/nuttx/audio/audio.h | 4 +- include/nuttx/audio/tone.h | 2 +- include/nuttx/binfmt/binfmt.h | 2 +- include/nuttx/binfmt/builtin.h | 6 +- include/nuttx/cancelpt.h | 6 +- include/nuttx/clock.h | 10 +- include/nuttx/crypto/aes.h | 4 +- include/nuttx/drivers/drivers.h | 8 +- include/nuttx/drivers/pwm.h | 4 +- include/nuttx/drivers/ramdisk.h | 4 +- include/nuttx/fs/fs.h | 6 +- include/nuttx/fs/unionfs.h | 2 +- include/nuttx/fs/userfs.h | 4 +- include/nuttx/input/ajoystick.h | 2 +- include/nuttx/input/buttons.h | 2 +- include/nuttx/input/djoystick.h | 2 +- include/nuttx/input/nunchuck.h | 2 +- include/nuttx/kthread.h | 4 +- include/nuttx/leds/rgbled.h | 2 +- include/nuttx/leds/userled.h | 2 +- include/nuttx/mqueue.h | 2 +- include/nuttx/mtd/configdata.h | 2 +- include/nuttx/mtd/hamming.h | 4 +- include/nuttx/mtd/mtd.h | 2 +- include/nuttx/mtd/nand.h | 4 +- include/nuttx/mtd/nand_ecc.h | 8 +- include/nuttx/mtd/nand_model.h | 30 ++--- include/nuttx/mtd/nand_raw.h | 20 +-- include/nuttx/mtd/nand_scheme.h | 22 ++-- include/nuttx/net/ieee802154.h | 2 +- include/nuttx/net/net.h | 12 +- include/nuttx/net/pkt.h | 2 +- include/nuttx/net/radiodev.h | 6 +- include/nuttx/net/telnet.h | 2 +- include/nuttx/nx/nx.h | 56 ++++---- include/nuttx/nx/nxfonts.h | 6 +- include/nuttx/nx/nxglib.h | 12 +- include/nuttx/nx/nxmu.h | 8 +- include/nuttx/nx/nxterm.h | 6 +- include/nuttx/nx/nxtk.h | 58 ++++---- include/nuttx/power/battery_charger.h | 4 +- include/nuttx/power/battery_gauge.h | 4 +- include/nuttx/power/pm.h | 8 +- include/nuttx/sched.h | 20 +-- include/nuttx/semaphore.h | 26 ++-- include/nuttx/signal.h | 8 +- include/nuttx/streams.h | 20 +-- include/nuttx/syslog/syslog.h | 2 +- include/nuttx/time.h | 2 +- include/nuttx/timers/timer.h | 6 +- include/nuttx/timers/watchdog.h | 4 +- include/nuttx/usb/cdcacm.h | 4 +- include/nuttx/usb/composite.h | 2 +- include/nuttx/usb/hid_parser.h | 6 +- include/nuttx/usb/usbhost.h | 56 ++++---- include/nuttx/usb/usbmonitor.h | 2 +- include/nuttx/userspace.h | 8 +- include/nuttx/video/fb.h | 4 +- include/nuttx/wdog.h | 10 +- include/nuttx/wireless/cc3000/evnt_handler.h | 6 +- include/nuttx/wireless/cc3000/wlan.h | 4 +- .../wireless/ieee802154/ieee802154_mac.h | 16 +-- include/nuttx/wireless/nrf24l01.h | 38 +++--- include/nuttx/wireless/pktradio.h | 12 +- include/nuttx/wqueue.h | 14 +- include/sys/ioctl.h | 2 +- include/sys/sendfile.h | 2 +- include/sys/time.h | 4 +- libc/dirent/lib_readdirr.c | 4 +- libc/dirent/lib_telldir.c | 4 +- libc/hex2bin/lib_fhex2mem.c | 2 +- libc/hex2bin/lib_hex2bin.c | 2 +- libc/hex2bin/lib_hex2mem.c | 2 +- libc/inttypes/lib_strtoimax.c | 2 +- libc/inttypes/lib_strtoumax.c | 2 +- libc/libgen/lib_basename.c | 2 +- libc/libgen/lib_dirname.c | 2 +- libc/misc/lib_ioctl.c | 2 +- libc/misc/lib_mkfifo.c | 4 +- libc/misc/lib_sendfile.c | 2 +- libc/net/lib_shutdown.c | 6 +- libc/pthread/pthread_attr_destroy.c | 2 +- libc/pthread/pthread_attr_getaffinity.c | 2 +- libc/pthread/pthread_attr_getinheritsched.c | 2 +- libc/pthread/pthread_attr_getschedparam.c | 2 +- libc/pthread/pthread_attr_getschedpolicy.c | 2 +- libc/pthread/pthread_attr_getstacksize.c | 2 +- libc/pthread/pthread_attr_init.c | 2 +- libc/pthread/pthread_attr_setaffinity.c | 2 +- libc/pthread/pthread_attr_setinheritsched.c | 2 +- libc/pthread/pthread_attr_setschedparam.c | 2 +- libc/pthread/pthread_attr_setschedpolicy.c | 2 +- libc/pthread/pthread_attr_setstacksize.c | 2 +- libc/pthread/pthread_barrierattr_destroy.c | 2 +- libc/pthread/pthread_barrierattr_getpshared.c | 2 +- libc/pthread/pthread_barrierattr_init.c | 2 +- libc/pthread/pthread_barrierattr_setpshared.c | 2 +- libc/pthread/pthread_barrierdestroy.c | 2 +- libc/pthread/pthread_barrierinit.c | 2 +- libc/pthread/pthread_barrierwait.c | 2 +- libc/pthread/pthread_condattr_destroy.c | 2 +- libc/pthread/pthread_condattr_init.c | 2 +- libc/pthread/pthread_conddestroy.c | 2 +- libc/pthread/pthread_condinit.c | 2 +- libc/pthread/pthread_mutexattr_destroy.c | 2 +- libc/pthread/pthread_mutexattr_getprotocol.c | 2 +- libc/pthread/pthread_mutexattr_getpshared.c | 2 +- libc/pthread/pthread_mutexattr_getrobust.c | 2 +- libc/pthread/pthread_mutexattr_gettype.c | 2 +- libc/pthread/pthread_mutexattr_init.c | 2 +- libc/pthread/pthread_mutexattr_setprotocol.c | 2 +- libc/pthread/pthread_mutexattr_setpshared.c | 2 +- libc/pthread/pthread_mutexattr_setrobust.c | 2 +- libc/pthread/pthread_mutexattr_settype.c | 2 +- libc/pthread/pthread_once.c | 2 +- libc/pthread/pthread_rwlock_rdlock.c | 2 +- libc/pthread/pthread_rwlock_wrlock.c | 2 +- libc/pthread/pthread_startup.c | 4 +- libc/pthread/pthread_yield.c | 2 +- libc/sched/sched_cpucount.c | 4 +- libc/sched/sched_getprioritymax.c | 4 +- libc/sched/sched_getprioritymin.c | 4 +- libc/sched/task_startup.c | 4 +- libc/semaphore/sem_getprotocol.c | 2 +- libc/semaphore/sem_getvalue.c | 2 +- libc/semaphore/sem_init.c | 4 +- libc/semaphore/sem_setprotocol.c | 4 +- libc/signal/sig_addset.c | 2 +- libc/signal/sig_delset.c | 2 +- libc/signal/sig_emptyset.c | 2 +- libc/signal/sig_fillset.c | 2 +- libc/signal/sig_ismember.c | 2 +- libc/stdio/lib_ferror.c | 2 +- libc/stdio/lib_fflush.c | 2 +- libc/stdio/lib_freopen.c | 2 +- libc/stdio/lib_libfflush.c | 2 +- libc/stdio/lib_libnoflush.c | 2 +- libc/stdio/lib_libsnoflush.c | 2 +- libc/stdio/lib_lowoutstream.c | 2 +- libc/stdio/lib_meminstream.c | 2 +- libc/stdio/lib_memoutstream.c | 2 +- libc/stdio/lib_memsistream.c | 2 +- libc/stdio/lib_memsostream.c | 2 +- libc/stdio/lib_nullinstream.c | 2 +- libc/stdio/lib_nulloutstream.c | 2 +- libc/stdio/lib_rawinstream.c | 2 +- libc/stdio/lib_rawoutstream.c | 2 +- libc/stdio/lib_rawsistream.c | 2 +- libc/stdio/lib_rawsostream.c | 2 +- libc/stdio/lib_remove.c | 2 +- libc/stdio/lib_stdinstream.c | 2 +- libc/stdio/lib_stdoutstream.c | 2 +- libc/stdio/lib_stdsistream.c | 2 +- libc/stdio/lib_stdsostream.c | 2 +- libc/stdio/lib_zeroinstream.c | 2 +- libc/stdlib/lib_abort.c | 2 +- libc/stdlib/lib_checkbase.c | 2 +- libc/stdlib/lib_ptsname.c | 2 +- libc/stdlib/lib_ptsnamer.c | 2 +- libc/stdlib/lib_strtol.c | 2 +- libc/stdlib/lib_strtoll.c | 2 +- libc/stdlib/lib_strtoul.c | 2 +- libc/stdlib/lib_strtoull.c | 2 +- libc/stdlib/lib_unlockpt.c | 2 +- libc/string/lib_stpcpy.c | 2 +- libc/string/lib_strcpy.c | 2 +- libc/string/lib_strtok.c | 2 +- libc/string/lib_strtokr.c | 2 +- libc/time/lib_asctime.c | 2 +- libc/time/lib_asctimer.c | 2 +- libc/time/lib_ctime.c | 2 +- libc/time/lib_ctimer.c | 2 +- libc/time/lib_dayofweek.c | 2 +- libc/time/lib_gettimeofday.c | 2 +- libc/time/lib_settimeofday.c | 2 +- libc/time/lib_time.c | 2 +- libc/unistd/lib_chdir.c | 2 +- libc/unistd/lib_getcwd.c | 2 +- libc/unistd/lib_getopt.c | 15 ++- libc/unistd/lib_pipe.c | 4 +- libc/userfs/lib_userfs.c | 2 +- libc/wqueue/work_cancel.c | 4 +- libc/wqueue/work_lock.c | 4 +- libc/wqueue/work_queue.c | 4 +- libc/wqueue/work_signal.c | 2 +- libc/wqueue/work_usrthread.c | 6 +- libc/wqueue/wqueue.h | 4 +- libnx/nx/nx_drawcircle.c | 2 +- libnx/nx/nx_drawline.c | 2 +- libnx/nx/nx_fillcircle.c | 2 +- libnx/nxfonts/nxfonts_cache.c | 6 +- libnx/nxglib/nxglib_circlepts.c | 4 +- libnx/nxglib/nxglib_circletraps.c | 4 +- libnx/nxglib/nxglib_splitline.c | 4 +- libnx/nxmu/nx_bitmap.c | 2 +- libnx/nxmu/nx_block.c | 2 +- libnx/nxmu/nx_closewindow.c | 2 +- libnx/nxmu/nx_connect.c | 2 +- libnx/nxmu/nx_constructwindow.c | 2 +- libnx/nxmu/nx_disconnect.c | 2 +- libnx/nxmu/nx_eventhandler.c | 2 +- libnx/nxmu/nx_eventnotify.c | 2 +- libnx/nxmu/nx_fill.c | 2 +- libnx/nxmu/nx_filltrapezoid.c | 2 +- libnx/nxmu/nx_getposition.c | 2 +- libnx/nxmu/nx_getrectangle.c | 2 +- libnx/nxmu/nx_lower.c | 4 +- libnx/nxmu/nx_move.c | 2 +- libnx/nxmu/nx_openwindow.c | 2 +- libnx/nxmu/nx_raise.c | 4 +- libnx/nxmu/nx_releasebkgd.c | 2 +- libnx/nxmu/nx_requestbkgd.c | 2 +- libnx/nxmu/nx_setbgcolor.c | 2 +- libnx/nxmu/nx_setpixel.c | 2 +- libnx/nxmu/nx_setposition.c | 2 +- libnx/nxmu/nx_setsize.c | 2 +- libnx/nxmu/nxmu_sendserver.c | 2 +- libnx/nxmu/nxmu_sendwindow.c | 2 +- libnx/nxtk/nxtk.h | 14 +- libnx/nxtk/nxtk_bitmaptoolbar.c | 2 +- libnx/nxtk/nxtk_bitmapwindow.c | 2 +- libnx/nxtk/nxtk_block.c | 2 +- libnx/nxtk/nxtk_closetoolbar.c | 2 +- libnx/nxtk/nxtk_closewindow.c | 2 +- libnx/nxtk/nxtk_containerclip.c | 4 +- libnx/nxtk/nxtk_drawcircletoolbar.c | 2 +- libnx/nxtk/nxtk_drawcirclewindow.c | 2 +- libnx/nxtk/nxtk_drawframe.c | 4 +- libnx/nxtk/nxtk_drawlinetoolbar.c | 2 +- libnx/nxtk/nxtk_drawlinewindow.c | 2 +- libnx/nxtk/nxtk_fillcircletoolbar.c | 2 +- libnx/nxtk/nxtk_fillcirclewindow.c | 2 +- libnx/nxtk/nxtk_filltoolbar.c | 2 +- libnx/nxtk/nxtk_filltraptoolbar.c | 2 +- libnx/nxtk/nxtk_filltrapwindow.c | 2 +- libnx/nxtk/nxtk_fillwindow.c | 2 +- libnx/nxtk/nxtk_getposition.c | 2 +- libnx/nxtk/nxtk_gettoolbar.c | 2 +- libnx/nxtk/nxtk_getwindow.c | 2 +- libnx/nxtk/nxtk_lower.c | 4 +- libnx/nxtk/nxtk_movetoolbar.c | 2 +- libnx/nxtk/nxtk_movewindow.c | 2 +- libnx/nxtk/nxtk_opentoolbar.c | 2 +- libnx/nxtk/nxtk_openwindow.c | 2 +- libnx/nxtk/nxtk_raise.c | 4 +- libnx/nxtk/nxtk_setposition.c | 2 +- libnx/nxtk/nxtk_setsize.c | 2 +- libnx/nxtk/nxtk_subwindowclip.c | 4 +- libnx/nxtk/nxtk_subwindowmove.c | 2 +- libnx/nxtk/nxtk_toolbarbounds.c | 2 +- mm/kmm_heap/kmm_addregion.c | 2 +- mm/kmm_heap/kmm_free.c | 2 +- mm/kmm_heap/kmm_heapmember.c | 2 +- mm/kmm_heap/kmm_initialize.c | 2 +- mm/kmm_heap/kmm_kernel.c | 2 +- mm/kmm_heap/kmm_malloc.c | 2 +- mm/kmm_heap/kmm_memalign.c | 2 +- mm/kmm_heap/kmm_realloc.c | 2 +- mm/kmm_heap/kmm_sem.c | 4 +- mm/kmm_heap/kmm_zalloc.c | 2 +- mm/mm_heap/mm_initialize.c | 4 +- mm/shm/shmget.c | 16 +-- mm/umm_heap/umm_addregion.c | 2 +- mm/umm_heap/umm_initialize.c | 2 +- mm/umm_heap/umm_malloc.c | 2 +- mm/umm_heap/umm_realloc.c | 2 +- mm/umm_heap/umm_sem.c | 4 +- mm/umm_heap/umm_zalloc.c | 2 +- net/arp/arp.h | 8 +- net/arp/arp_table.c | 6 +- net/devif/devif.h | 10 +- net/devif/devif_callback.c | 10 +- net/devif/devif_initialize.c | 2 +- net/icmp/icmp.h | 4 +- net/icmp/icmp_input.c | 4 +- net/icmp/icmp_poll.c | 2 +- net/icmp/icmp_sendto.c | 2 +- net/icmpv6/icmpv6.h | 14 +- net/icmpv6/icmpv6_advertise.c | 2 +- net/icmpv6/icmpv6_autoconfig.c | 2 +- net/icmpv6/icmpv6_input.c | 4 +- net/icmpv6/icmpv6_poll.c | 2 +- net/icmpv6/icmpv6_rsolicit.c | 2 +- net/icmpv6/icmpv6_sendto.c | 2 +- net/icmpv6/icmpv6_solicit.c | 2 +- net/ieee802154/ieee802154.h | 16 +-- net/ieee802154/ieee802154_container.c | 12 +- net/ieee802154/ieee802154_input.c | 6 +- net/ieee802154/ieee802154_poll.c | 2 +- net/ieee802154/ieee802154_recvfrom.c | 6 +- net/ieee802154/ieee802154_sendto.c | 6 +- net/igmp/igmp.h | 2 +- net/igmp/igmp_send.c | 2 +- net/ipforward/ipv6_forward.c | 2 +- net/local/local.h | 10 +- net/local/local_connect.c | 4 +- net/local/local_recvutils.c | 6 +- net/local/local_send.c | 2 +- net/local/local_sendpacket.c | 4 +- net/netdev/netdev_ioctl.c | 22 ++-- net/pkt/pkt.h | 4 +- net/pkt/pkt_input.c | 2 +- net/pkt/pkt_poll.c | 2 +- net/pkt/pkt_recvfrom.c | 4 +- net/sixlowpan/sixlowpan.h | 12 +- net/sixlowpan/sixlowpan_framelist.c | 4 +- net/sixlowpan/sixlowpan_framer.c | 10 +- net/sixlowpan/sixlowpan_hc06.c | 2 +- net/sixlowpan/sixlowpan_hc1.c | 2 +- net/sixlowpan/sixlowpan_icmpv6send.c | 2 +- net/sixlowpan/sixlowpan_input.c | 2 +- net/sixlowpan/sixlowpan_internal.h | 32 ++--- net/sixlowpan/sixlowpan_reassbuf.c | 24 ++-- net/sixlowpan/sixlowpan_send.c | 2 +- net/sixlowpan/sixlowpan_tcpsend.c | 8 +- net/sixlowpan/sixlowpan_udpsend.c | 6 +- net/sixlowpan/sixlowpan_utils.c | 8 +- net/tcp/tcp.h | 24 ++-- net/tcp/tcp_appsend.c | 4 +- net/tcp/tcp_callback.c | 2 +- net/tcp/tcp_conn.c | 8 +- net/tcp/tcp_devpoll.c | 2 +- net/tcp/tcp_input.c | 6 +- net/tcp/tcp_send.c | 16 +-- net/tcp/tcp_timer.c | 2 +- net/tcp/tcp_wrbuffer.c | 2 +- net/udp/udp.h | 10 +- net/udp/udp_conn.c | 2 +- net/udp/udp_devpoll.c | 2 +- net/udp/udp_input.c | 6 +- net/udp/udp_send.c | 2 +- net/udp/udp_wrbuffer.c | 2 +- net/utils/net_ipv6_mask2pref.c | 2 +- net/utils/net_lock.c | 8 +- net/utils/utils.h | 2 +- sched/clock/clock_abstime2ticks.c | 2 +- sched/clock/clock_dow.c | 2 +- sched/clock/clock_initialize.c | 4 +- sched/clock/clock_systimer.c | 2 +- sched/clock/clock_systimespec.c | 2 +- sched/clock/clock_ticks2time.c | 2 +- sched/clock/clock_time2ticks.c | 2 +- sched/clock/clock_timespec_add.c | 4 +- sched/clock/clock_timespec_subtract.c | 4 +- sched/environ/env_clearenv.c | 2 +- sched/environ/env_dup.c | 2 +- sched/environ/env_findvar.c | 2 +- sched/environ/env_getenv.c | 2 +- sched/environ/env_getenvironptr.c | 2 +- sched/environ/env_putenv.c | 2 +- sched/environ/env_release.c | 2 +- sched/environ/env_removevar.c | 2 +- sched/environ/env_setenv.c | 2 +- sched/environ/env_unsetenv.c | 2 +- sched/errno/errno_get.c | 2 +- sched/errno/errno_getptr.c | 2 +- sched/errno/errno_set.c | 2 +- sched/group/group_addrenv.c | 2 +- sched/group/group_childstatus.c | 18 +-- sched/group/group_create.c | 6 +- sched/group/group_find.c | 4 +- sched/group/group_foreachchild.c | 2 +- sched/group/group_join.c | 6 +- sched/group/group_killchildren.c | 4 +- sched/group/group_leave.c | 8 +- sched/group/group_setupidlefiles.c | 2 +- sched/group/group_setuptaskfiles.c | 6 +- sched/group/group_signal.c | 4 +- sched/init/init.h | 2 +- sched/init/os_start.c | 2 +- sched/irq/irq.h | 4 +- sched/irq/irq_csection.c | 4 +- sched/mqueue/mq_desclose.c | 4 +- sched/mqueue/mq_descreate.c | 8 +- sched/mqueue/mq_getattr.c | 2 +- sched/mqueue/mq_initialize.c | 10 +- sched/mqueue/mq_msgfree.c | 4 +- sched/mqueue/mq_msgqalloc.c | 2 +- sched/mqueue/mq_msgqfree.c | 4 +- sched/mqueue/mq_notify.c | 2 +- sched/mqueue/mq_recover.c | 4 +- sched/mqueue/mq_release.c | 4 +- sched/mqueue/mq_setattr.c | 2 +- sched/mqueue/mq_sndinternal.c | 2 +- sched/mqueue/mq_waitirq.c | 2 +- sched/paging/paging.h | 2 +- sched/paging/pg_worker.c | 12 +- sched/pthread/pthread_cleanup.c | 2 +- sched/pthread/pthread_completejoin.c | 2 +- sched/pthread/pthread_condbroadcast.c | 2 +- sched/pthread/pthread_condsignal.c | 2 +- sched/pthread/pthread_condtimedwait.c | 4 +- sched/pthread/pthread_condwait.c | 2 +- sched/pthread/pthread_create.c | 6 +- sched/pthread/pthread_detach.c | 2 +- sched/pthread/pthread_findjoininfo.c | 2 +- sched/pthread/pthread_getaffinity.c | 2 +- sched/pthread/pthread_getschedparam.c | 2 +- sched/pthread/pthread_getspecific.c | 2 +- sched/pthread/pthread_initialize.c | 4 +- sched/pthread/pthread_join.c | 2 +- sched/pthread/pthread_keycreate.c | 2 +- sched/pthread/pthread_keydelete.c | 2 +- sched/pthread/pthread_kill.c | 2 +- sched/pthread/pthread_mutex.c | 10 +- sched/pthread/pthread_mutexdestroy.c | 2 +- sched/pthread/pthread_mutexinit.c | 2 +- sched/pthread/pthread_mutexlock.c | 2 +- sched/pthread/pthread_mutextrylock.c | 2 +- sched/pthread/pthread_mutexunlock.c | 4 +- sched/pthread/pthread_release.c | 2 +- sched/pthread/pthread_setaffinity.c | 2 +- sched/pthread/pthread_setschedparam.c | 2 +- sched/pthread/pthread_setschedprio.c | 4 +- sched/pthread/pthread_setspecific.c | 2 +- sched/pthread/pthread_sigmask.c | 2 +- sched/sched/sched_addblocked.c | 4 +- sched/sched/sched_addprioritized.c | 4 +- sched/sched/sched_addreadytorun.c | 8 +- sched/sched/sched_cpuload.c | 10 +- sched/sched/sched_cpuselect.c | 4 +- sched/sched/sched_foreach.c | 2 +- sched/sched/sched_garbage.c | 12 +- sched/sched/sched_getfiles.c | 2 +- sched/sched/sched_getparam.c | 8 +- sched/sched/sched_getscheduler.c | 8 +- sched/sched/sched_getsockets.c | 2 +- sched/sched/sched_getstreams.c | 2 +- sched/sched/sched_lock.c | 4 +- sched/sched/sched_lockcount.c | 4 +- sched/sched/sched_mergepending.c | 8 +- sched/sched/sched_mergeprioritized.c | 4 +- sched/sched/sched_releasetcb.c | 2 +- sched/sched/sched_removeblocked.c | 4 +- sched/sched/sched_removereadytorun.c | 8 +- sched/sched/sched_reprioritize.c | 4 +- sched/sched/sched_roundrobin.c | 4 +- sched/sched/sched_rrgetinterval.c | 4 +- sched/sched/sched_setaffinity.c | 8 +- sched/sched/sched_setparam.c | 8 +- sched/sched/sched_setpriority.c | 20 +-- sched/sched/sched_timerexpiration.c | 8 +- sched/sched/sched_waitpid.c | 2 +- sched/sched/sched_yield.c | 4 +- sched/semaphore/sem_destroy.c | 4 +- sched/semaphore/sem_holder.c | 24 ++-- sched/semaphore/sem_initialize.c | 2 +- sched/semaphore/sem_post.c | 4 +- sched/semaphore/sem_recover.c | 4 +- sched/semaphore/sem_reset.c | 2 +- sched/semaphore/sem_setprotocol.c | 4 +- sched/semaphore/sem_tickwait.c | 2 +- sched/semaphore/sem_timedwait.c | 4 +- sched/semaphore/sem_timeout.c | 2 +- sched/semaphore/sem_trywait.c | 4 +- sched/semaphore/sem_wait.c | 4 +- sched/semaphore/sem_waitirq.c | 2 +- sched/signal/sig_action.c | 2 +- sched/signal/sig_pending.c | 2 +- sched/signal/sig_procmask.c | 4 +- sched/signal/sig_queue.c | 4 +- sched/signal/sig_suspend.c | 2 +- sched/signal/sig_timedwait.c | 4 +- sched/signal/sig_waitinfo.c | 2 +- sched/task/task_activate.c | 2 +- sched/task/task_atexit.c | 2 +- sched/task/task_cancelpt.c | 6 +- sched/task/task_create.c | 8 +- sched/task/task_exit.c | 4 +- sched/task/task_getgroup.c | 2 +- sched/task/task_init.c | 2 +- sched/task/task_onexit.c | 2 +- sched/task/task_recover.c | 4 +- sched/task/task_reparent.c | 2 +- sched/task/task_restart.c | 4 +- sched/task/task_setup.c | 16 +-- sched/task/task_start.c | 4 +- sched/task/task_starthook.c | 4 +- sched/task/task_terminate.c | 4 +- sched/task/task_vfork.c | 6 +- sched/timer/timer_create.c | 2 +- sched/timer/timer_delete.c | 2 +- sched/timer/timer_getoverrun.c | 2 +- sched/timer/timer_gettime.c | 2 +- sched/timer/timer_initialize.c | 4 +- sched/timer/timer_release.c | 2 +- sched/timer/timer_settime.c | 8 +- sched/wdog/wd_cancel.c | 2 +- sched/wdog/wd_create.c | 2 +- sched/wdog/wd_delete.c | 2 +- sched/wdog/wd_gettime.c | 2 +- sched/wdog/wd_initialize.c | 2 +- sched/wdog/wd_recover.c | 4 +- sched/wdog/wd_start.c | 6 +- sched/wdog/wdog.h | 8 +- sched/wqueue/kwork_cancel.c | 4 +- sched/wqueue/kwork_hpthread.c | 4 +- sched/wqueue/kwork_inherit.c | 8 +- sched/wqueue/kwork_lpthread.c | 4 +- sched/wqueue/kwork_process.c | 2 +- sched/wqueue/kwork_queue.c | 4 +- sched/wqueue/kwork_signal.c | 2 +- sched/wqueue/wqueue.h | 6 +- wireless/ieee802154/ieee802154_primitive.c | 12 +- wireless/ieee802154/mac802154_device.c | 2 +- wireless/ieee802154/mac802154_loopback.c | 6 +- wireless/ieee802154/mac802154_netdev.c | 12 +- wireless/pktradio/pktradio_loopback.c | 6 +- wireless/pktradio/pktradio_metadata.c | 12 +- 1171 files changed, 3042 insertions(+), 3039 deletions(-) diff --git a/arch/arm/src/arm/pg_macros.h b/arch/arm/src/arm/pg_macros.h index 47616b426a..94263c7eb5 100644 --- a/arch/arm/src/arm/pg_macros.h +++ b/arch/arm/src/arm/pg_macros.h @@ -377,7 +377,7 @@ * ldr r3, =MMUFLAGS <-- L2 MMU flags * pg_l2map r0, r1, r2, r3, r4 * - * Inputs: + * Input Parameters: * l2 - Physical or virtual start address in the L2 page table, depending * upon the context. (modified) * ppage - The physical address of the start of the region to span. Must @@ -448,7 +448,7 @@ * ldr r4, =MMU_L1_PGTABFLAGS <-- L1 MMU flags * pg_l1span r0, r1, r2, r3, r4, r4 * - * Inputs (unmodified unless noted): + * Input Parameters (unmodified unless noted): * l1 - Physical or virtual address in the L1 table to begin writing (modified) * l2 - Physical start address in the L2 page table (modified) * npages - Number of pages to required to span that memory region (modified) @@ -462,7 +462,7 @@ * ppage - After the first page, this will be the full number of pages. * tmp - scratch * - * Return: + * Returned Value: * Nothing of interest. * * Assumptions: diff --git a/arch/arm/src/arm/up_blocktask.c b/arch/arm/src/arm/up_blocktask.c index 7169667145..97d1838d8a 100644 --- a/arch/arm/src/arm/up_blocktask.c +++ b/arch/arm/src/arm/up_blocktask.c @@ -62,7 +62,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/arm/src/arm/up_dataabort.c b/arch/arm/src/arm/up_dataabort.c index 318c59232c..2a348b401e 100644 --- a/arch/arm/src/arm/up_dataabort.c +++ b/arch/arm/src/arm/up_dataabort.c @@ -59,7 +59,7 @@ /**************************************************************************** * Name: up_dataabort * - * Input parameters: + * Input Parameters: * regs - The standard, ARM register save array. * * If CONFIG_PAGING is selected in the NuttX configuration file, then these diff --git a/arch/arm/src/arm/up_reprioritizertr.c b/arch/arm/src/arm/up_reprioritizertr.c index 95679e31dd..10175b0df5 100644 --- a/arch/arm/src/arm/up_reprioritizertr.c +++ b/arch/arm/src/arm/up_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/arm/src/arm/up_unblocktask.c b/arch/arm/src/arm/up_unblocktask.c index 12cb984d83..e94c81de0c 100644 --- a/arch/arm/src/arm/up_unblocktask.c +++ b/arch/arm/src/arm/up_unblocktask.c @@ -61,7 +61,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/arm/src/arm/vfork.S b/arch/arm/src/arm/vfork.S index 161315466f..661546daab 100644 --- a/arch/arm/src/arm/vfork.S +++ b/arch/arm/src/arm/vfork.S @@ -86,10 +86,10 @@ * 5) up_vfork() then calls task_vforkstart() * 6) task_vforkstart() then executes the child thread. * - * Input Paremeters: + * Input Parameters: * None * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and returns * the process ID of the child process to the parent process. Otherwise, -1 is * returned to the parent, no child process is created, and errno is set to diff --git a/arch/arm/src/armv6-m/up_blocktask.c b/arch/arm/src/armv6-m/up_blocktask.c index 2a95163cca..c01894715a 100644 --- a/arch/arm/src/armv6-m/up_blocktask.c +++ b/arch/arm/src/armv6-m/up_blocktask.c @@ -61,7 +61,7 @@ * be stopped. Save its context and move it to the inactive list specified * by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally the task at * the head of the list). It most be stopped, its context saved and * moved into one of the waiting task lists. It it was the task at the diff --git a/arch/arm/src/armv6-m/up_fullcontextrestore.S b/arch/arm/src/armv6-m/up_fullcontextrestore.S index 048c468749..4ec6a32a7e 100644 --- a/arch/arm/src/armv6-m/up_fullcontextrestore.S +++ b/arch/arm/src/armv6-m/up_fullcontextrestore.S @@ -70,7 +70,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv6-m/up_reprioritizertr.c b/arch/arm/src/armv6-m/up_reprioritizertr.c index 41f0c8700d..0f99b91740 100644 --- a/arch/arm/src/armv6-m/up_reprioritizertr.c +++ b/arch/arm/src/armv6-m/up_reprioritizertr.c @@ -67,7 +67,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/arm/src/armv6-m/up_saveusercontext.S b/arch/arm/src/armv6-m/up_saveusercontext.S index bfc9a70ea8..55e6461b2b 100644 --- a/arch/arm/src/armv6-m/up_saveusercontext.S +++ b/arch/arm/src/armv6-m/up_saveusercontext.S @@ -70,7 +70,7 @@ * * int up_saveusercontext(uint32_t *saveregs); * - * Return: + * Returned Value: * 0: Normal return * 1: Context switch return * diff --git a/arch/arm/src/armv6-m/up_signal_dispatch.c b/arch/arm/src/armv6-m/up_signal_dispatch.c index fa3cea6222..45446a2b5e 100644 --- a/arch/arm/src/armv6-m/up_signal_dispatch.c +++ b/arch/arm/src/armv6-m/up_signal_dispatch.c @@ -78,12 +78,12 @@ * user-space, signal handler trampoline function. It is called from * up_signal_dispatch() in user-mode. * - * Inputs: + * Input Parameters: * sighand - The address user-space signal handling function * signo, info, and ucontext - Standard arguments to be passed to the * signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via an architecture specific system call made by up_signal_handler(). * However, this will look like a normal return by the caller of diff --git a/arch/arm/src/armv6-m/up_signal_handler.S b/arch/arm/src/armv6-m/up_signal_handler.S index f294db9fc8..9ad7ec8133 100644 --- a/arch/arm/src/armv6-m/up_signal_handler.S +++ b/arch/arm/src/armv6-m/up_signal_handler.S @@ -65,13 +65,13 @@ * This function is the user-space, signal handler trampoline function. It * is called from up_signal_dispatch() in user-mode. * - * Inputs: + * Input Parameters: * R0 = sighand * The address user-space signal handling function * R1-R3 = signo, info, and ucontext * Standard arguments to be passed to the signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via the SYS_signal_handler_return (see svcall.h) * diff --git a/arch/arm/src/armv6-m/up_switchcontext.S b/arch/arm/src/armv6-m/up_switchcontext.S index c24f501fc2..dc5aca9169 100644 --- a/arch/arm/src/armv6-m/up_switchcontext.S +++ b/arch/arm/src/armv6-m/up_switchcontext.S @@ -71,7 +71,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv6-m/up_unblocktask.c b/arch/arm/src/armv6-m/up_unblocktask.c index 62ec07d90a..1fbae12950 100644 --- a/arch/arm/src/armv6-m/up_unblocktask.c +++ b/arch/arm/src/armv6-m/up_unblocktask.c @@ -60,7 +60,7 @@ * execute. Move the TCB to the ready-to-run list, restore its context, * and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is in one of the * waiting tasks lists. It must be moved to the ready-to-run list and, * if it is the highest priority ready to run taks, executed. diff --git a/arch/arm/src/armv6-m/vfork.S b/arch/arm/src/armv6-m/vfork.S index 20c003d3ea..c64e96e22c 100644 --- a/arch/arm/src/armv6-m/vfork.S +++ b/arch/arm/src/armv6-m/vfork.S @@ -87,10 +87,10 @@ * 5) up_vfork() then calls task_vforkstart() * 6) task_vforkstart() then executes the child thread. * - * Input Paremeters: + * Input Parameters: * None * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and returns * the process ID of the child process to the parent process. Otherwise, -1 is * returned to the parent, no child process is created, and errno is set to diff --git a/arch/arm/src/armv7-a/arm_blocktask.c b/arch/arm/src/armv7-a/arm_blocktask.c index 3f02e46b36..61cce48de2 100644 --- a/arch/arm/src/armv7-a/arm_blocktask.c +++ b/arch/arm/src/armv7-a/arm_blocktask.c @@ -62,7 +62,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/arm/src/armv7-a/arm_cpuhead.S b/arch/arm/src/armv7-a/arm_cpuhead.S index 02735e36d5..3ed001656d 100644 --- a/arch/arm/src/armv7-a/arm_cpuhead.S +++ b/arch/arm/src/armv7-a/arm_cpuhead.S @@ -93,7 +93,7 @@ * * These functions are provided by the common ARMv7-A logic. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/armv7-a/arm_cpuidlestack.c b/arch/arm/src/armv7-a/arm_cpuidlestack.c index dd264d25c1..1648de2fdb 100644 --- a/arch/arm/src/armv7-a/arm_cpuidlestack.c +++ b/arch/arm/src/armv7-a/arm_cpuidlestack.c @@ -112,7 +112,7 @@ static FAR const uint32_t *g_cpu_stackalloc[CONFIG_SMP_NCPUS] = * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - cpu: CPU index that indicates which CPU the IDLE task is * being created for. * - tcb: The TCB of new CPU IDLE task diff --git a/arch/arm/src/armv7-a/arm_dataabort.c b/arch/arm/src/armv7-a/arm_dataabort.c index 50c95a2018..17073a925e 100644 --- a/arch/arm/src/armv7-a/arm_dataabort.c +++ b/arch/arm/src/armv7-a/arm_dataabort.c @@ -59,7 +59,7 @@ /**************************************************************************** * Name: arm_dataabort * - * Input parameters: + * Input Parameters: * regs - The standard, ARM register save array. * * If CONFIG_PAGING is selected in the NuttX configuration file, then these diff --git a/arch/arm/src/armv7-a/arm_fullcontextrestore.S b/arch/arm/src/armv7-a/arm_fullcontextrestore.S index 64f74c8a98..f65adbfadb 100644 --- a/arch/arm/src/armv7-a/arm_fullcontextrestore.S +++ b/arch/arm/src/armv7-a/arm_fullcontextrestore.S @@ -62,7 +62,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/armv7-a/arm_gicv2.c b/arch/arm/src/armv7-a/arm_gicv2.c index 0232685dc8..8c6eee1509 100644 --- a/arch/arm/src/armv7-a/arm_gicv2.c +++ b/arch/arm/src/armv7-a/arm_gicv2.c @@ -372,7 +372,7 @@ void arm_gic_initialize(void) * the irq number of the interrupt and then to call arm_doirq to dispatch * the interrupt. * - * Input parameters: + * Input Parameters: * regs - A pointer to the register save area on the stack. * ****************************************************************************/ @@ -532,7 +532,7 @@ int up_prioritize_irq(int irq, int priority) * Since this API is not supported on all architectures, it should be * avoided in common implementations where possible. * - * Input Paramters: + * Input Parameters: * irq - The interrupt request to modify. * edge - False: Active HIGH level sensitive, True: Rising edge sensitive * diff --git a/arch/arm/src/armv7-a/arm_reprioritizertr.c b/arch/arm/src/armv7-a/arm_reprioritizertr.c index 4381178e05..eb1a4d2e6a 100644 --- a/arch/arm/src/armv7-a/arm_reprioritizertr.c +++ b/arch/arm/src/armv7-a/arm_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/arm/src/armv7-a/arm_signal_dispatch.c b/arch/arm/src/armv7-a/arm_signal_dispatch.c index 5925923760..1b461f5cb9 100644 --- a/arch/arm/src/armv7-a/arm_signal_dispatch.c +++ b/arch/arm/src/armv7-a/arm_signal_dispatch.c @@ -67,12 +67,12 @@ * user-space, signal handler trampoline function. It is called from * up_signal_dispatch() in user-mode. * - * Inputs: + * Input Parameters: * sighand - The address user-space signal handling function * signo, info, and ucontext - Standard arguments to be passed to the * signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via an architecture specific system call made by up_signal_handler(). * However, this will look like a normal return by the caller of diff --git a/arch/arm/src/armv7-a/arm_unblocktask.c b/arch/arm/src/armv7-a/arm_unblocktask.c index e3d2fa3fc7..a9b0da6d2f 100644 --- a/arch/arm/src/armv7-a/arm_unblocktask.c +++ b/arch/arm/src/armv7-a/arm_unblocktask.c @@ -61,7 +61,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/arm/src/armv7-a/arm_vfork.S b/arch/arm/src/armv7-a/arm_vfork.S index b7abc1c0f2..2e10c95099 100644 --- a/arch/arm/src/armv7-a/arm_vfork.S +++ b/arch/arm/src/armv7-a/arm_vfork.S @@ -88,10 +88,10 @@ * 5) up_vfork() then calls task_vforkstart() * 6) task_vforkstart() then executes the child thread. * - * Input Paremeters: + * Input Parameters: * None * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and * returns the process ID of the child process to the parent process. * Otherwise, -1 is returned to the parent, no child process is created, diff --git a/arch/arm/src/armv7-a/crt0.c b/arch/arm/src/armv7-a/crt0.c index a06e3f858e..f13148aa9b 100644 --- a/arch/arm/src/armv7-a/crt0.c +++ b/arch/arm/src/armv7-a/crt0.c @@ -67,13 +67,13 @@ int main(int argc, char *argv[]); * R4-R10 - static registers must be preserved * R12-R14 - LR and SP must be preserved * - * Inputs: + * Input Parameters: * R0 = sighand * The address user-space signal handling function * R1-R3 = signo, info, and ucontext * Standard arguments to be passed to the signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via the SYS_signal_handler_return (see svcall.h) * diff --git a/arch/arm/src/armv7-a/gic.h b/arch/arm/src/armv7-a/gic.h index 8c882ad6dd..0281abae67 100644 --- a/arch/arm/src/armv7-a/gic.h +++ b/arch/arm/src/armv7-a/gic.h @@ -634,7 +634,7 @@ static inline unsigned int arm_gic_nlines(void) * If CONFIG_SMP is not selected, the cpuset is ignored and SGI is sent * only to the current CPU. * - * Input Paramters + * Input Parameters: * sgi - The SGI interrupt ID (0-15) * cpuset - The set of CPUs to receive the SGI * @@ -714,7 +714,7 @@ void arm_gic_initialize(void); * Since this API is not supported on all architectures, it should be * avoided in common implementations where possible. * - * Input Paramters: + * Input Parameters: * irq - The interrupt request to modify. * edge - False: Active HIGH level sensitive, True: Rising edge sensitive * @@ -735,7 +735,7 @@ int arm_gic_irq_trigger(int irq, bool edge); * the irq number of the interrupt and then to call arm_doirq to dispatch * the interrupt. * - * Input parameters: + * Input Parameters: * regs - A pointer to the register save area on the stack. * ****************************************************************************/ diff --git a/arch/arm/src/armv7-a/mmu.h b/arch/arm/src/armv7-a/mmu.h index c6338d3337..ba0870c235 100644 --- a/arch/arm/src/armv7-a/mmu.h +++ b/arch/arm/src/armv7-a/mmu.h @@ -897,7 +897,7 @@ struct section_mapping_s * Description: * Disable the MMU * - * Inputs: + * Input Parameters: * None * ************************************************************************************/ @@ -919,7 +919,7 @@ struct section_mapping_s * instruction that performs the operation. Software does not have to write a * value to the register before issuing the MCR instruction. * - * Inputs: + * Input Parameters: * None * ************************************************************************************/ @@ -934,7 +934,7 @@ struct section_mapping_s * Description: * Invalidate unified TLB entry by MVA all ASID Inner Shareable * - * Inputs: + * Input Parameters: * vaddr - The virtual address to be invalidated * ************************************************************************************/ @@ -952,7 +952,7 @@ struct section_mapping_s * Description: * Write the Domain Access Control Register (DACR) * - * Inputs: + * Input Parameters: * dacr - The new value of the DACR * ************************************************************************************/ @@ -979,7 +979,7 @@ struct section_mapping_s * Table Base Register 0 (TTBR0). Then it clears the TTB control * register (TTBCR), indicating that we are using TTBR0. * - * Inputs: + * Input Parameters: * ttb - The new value of the TTBR0 register * ************************************************************************************/ @@ -1012,7 +1012,7 @@ struct section_mapping_s * ldr r3, =MMUFLAGS <-- L2 MMU flags * pg_l2map r0, r1, r2, r3, r4 * - * Inputs: + * Input Parameters: * l2 - Physical or virtual start address in the L2 page table, depending * upon the context. (modified) * ppage - The physical address of the start of the region to span. Must @@ -1083,7 +1083,7 @@ struct section_mapping_s * ldr r4, =MMU_L1_PGTABFLAGS <-- L1 MMU flags * pg_l1span r0, r1, r2, r3, r4, r4 * - * Inputs (unmodified unless noted): + * Input Parameters (unmodified unless noted): * l1 - Physical or virtual address in the L1 table to begin writing (modified) * l2 - Physical start address in the L2 page table (modified) * npages - Number of pages to required to span that memory region (modified) @@ -1097,7 +1097,7 @@ struct section_mapping_s * ppage - After the first page, this will be the full number of pages. * tmp - scratch * - * Return: + * Returned Value: * Nothing of interest. * * Assumptions: @@ -1159,7 +1159,7 @@ struct section_mapping_s * Description: * Disable the MMU * - * Inputs: + * Input Parameters: * None * ************************************************************************************/ @@ -1188,7 +1188,7 @@ static inline void cp15_disable_mmu(void) * instruction that performs the operation. Software does not have to write a * value to the register before issuing the MCR instruction. * - * Inputs: + * Input Parameters: * None * ************************************************************************************/ @@ -1210,7 +1210,7 @@ static inline void cp15_invalidate_tlbs(void) * Description: * Invalidate unified TLB entry by MVA all ASID Inner Shareable * - * Inputs: + * Input Parameters: * vaddr - The virtual address to be invalidated * ************************************************************************************/ @@ -1235,7 +1235,7 @@ static inline void cp15_invalidate_tlb_bymva(uint32_t vaddr) * Description: * Write the Domain Access Control Register (DACR) * - * Inputs: + * Input Parameters: * dacr - The new value of the DACR * ************************************************************************************/ @@ -1269,7 +1269,7 @@ static inline void cp15_wrdacr(unsigned int dacr) * Table Base Register 0 (TTBR0). Then it clears the TTB control * register (TTBCR), indicating that we are using TTBR0. * - * Inputs: + * Input Parameters: * ttb - The new value of the TTBR0 register * ************************************************************************************/ diff --git a/arch/arm/src/armv7-a/smp.h b/arch/arm/src/armv7-a/smp.h index 7c9d1cc72a..1ae2bbfad8 100644 --- a/arch/arm/src/armv7-a/smp.h +++ b/arch/arm/src/armv7-a/smp.h @@ -93,7 +93,7 @@ extern uint32_t g_cpu3_idlestack[SMP_STACK_WORDS]; * * These functions are provided by the common ARMv7-A logic. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -129,7 +129,7 @@ void __cpu3_start(void); * This function must be provided by the each ARMv7-A MCU and implement * MCU-specific initialization logic. * - * Input parameters: + * Input Parameters: * cpu - The CPU index. This is the same value that would be obtained by * calling up_cpu_index(); * diff --git a/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S b/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S index a9ccb0d572..7b5171a449 100644 --- a/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S +++ b/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S @@ -71,7 +71,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/gnu/up_saveusercontext.S b/arch/arm/src/armv7-m/gnu/up_saveusercontext.S index 7ebd2e4836..a4d96ef8fa 100644 --- a/arch/arm/src/armv7-m/gnu/up_saveusercontext.S +++ b/arch/arm/src/armv7-m/gnu/up_saveusercontext.S @@ -71,7 +71,7 @@ * * int up_saveusercontext(uint32_t *saveregs); * - * Return: + * Returned Value: * 0: Normal return * 1: Context switch return * diff --git a/arch/arm/src/armv7-m/gnu/up_signal_handler.S b/arch/arm/src/armv7-m/gnu/up_signal_handler.S index 2cc31da4d1..daf9448c14 100644 --- a/arch/arm/src/armv7-m/gnu/up_signal_handler.S +++ b/arch/arm/src/armv7-m/gnu/up_signal_handler.S @@ -71,13 +71,13 @@ * R4-R10 - static registers must be preserved * R12-R14 - LR and SP must be preserved * - * Inputs: + * Input Parameters: * R0 = sighand * The address user-space signal handling function * R1-R3 = signo, info, and ucontext * Standard arguments to be passed to the signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via the SYS_signal_handler_return (see svcall.h) * diff --git a/arch/arm/src/armv7-m/gnu/up_switchcontext.S b/arch/arm/src/armv7-m/gnu/up_switchcontext.S index c0ddf15162..7c72411d3e 100644 --- a/arch/arm/src/armv7-m/gnu/up_switchcontext.S +++ b/arch/arm/src/armv7-m/gnu/up_switchcontext.S @@ -72,7 +72,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/gnu/vfork.S b/arch/arm/src/armv7-m/gnu/vfork.S index 784ab83ce7..fa3cfc1bea 100644 --- a/arch/arm/src/armv7-m/gnu/vfork.S +++ b/arch/arm/src/armv7-m/gnu/vfork.S @@ -88,10 +88,10 @@ * 5) up_vfork() then calls task_vforkstart() * 6) task_vforkstart() then executes the child thread. * - * Input Paremeters: + * Input Parameters: * None * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and returns * the process ID of the child process to the parent process. Otherwise, -1 is * returned to the parent, no child process is created, and errno is set to diff --git a/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S b/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S index 045c903a32..034bbfc8e8 100644 --- a/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S +++ b/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S @@ -72,7 +72,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/iar/up_saveusercontext.S b/arch/arm/src/armv7-m/iar/up_saveusercontext.S index b8f27a7772..07a82c620a 100644 --- a/arch/arm/src/armv7-m/iar/up_saveusercontext.S +++ b/arch/arm/src/armv7-m/iar/up_saveusercontext.S @@ -72,7 +72,7 @@ * * int up_saveusercontext(uint32_t *saveregs); * - * Return: + * Returned Value: * 0: Normal return * 1: Context switch return * diff --git a/arch/arm/src/armv7-m/iar/up_switchcontext.S b/arch/arm/src/armv7-m/iar/up_switchcontext.S index 5936503d73..a115a498bf 100644 --- a/arch/arm/src/armv7-m/iar/up_switchcontext.S +++ b/arch/arm/src/armv7-m/iar/up_switchcontext.S @@ -73,7 +73,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/iar/vfork.S b/arch/arm/src/armv7-m/iar/vfork.S index 6018a28a00..e7352aee1e 100644 --- a/arch/arm/src/armv7-m/iar/vfork.S +++ b/arch/arm/src/armv7-m/iar/vfork.S @@ -89,10 +89,10 @@ * 5) up_vfork() then calls task_vforkstart() * 6) task_vforkstart() then executes the child thread. * - * Input Paremeters: + * Input Parameters: * None * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and returns * the process ID of the child process to the parent process. Otherwise, -1 is * returned to the parent, no child process is created, and errno is set to diff --git a/arch/arm/src/armv7-m/up_blocktask.c b/arch/arm/src/armv7-m/up_blocktask.c index 5e62e0fb9f..68151cb09b 100644 --- a/arch/arm/src/armv7-m/up_blocktask.c +++ b/arch/arm/src/armv7-m/up_blocktask.c @@ -61,7 +61,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/arm/src/armv7-m/up_reprioritizertr.c b/arch/arm/src/armv7-m/up_reprioritizertr.c index 5e65a3d338..22c80ed298 100644 --- a/arch/arm/src/armv7-m/up_reprioritizertr.c +++ b/arch/arm/src/armv7-m/up_reprioritizertr.c @@ -67,7 +67,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/arm/src/armv7-m/up_signal_dispatch.c b/arch/arm/src/armv7-m/up_signal_dispatch.c index 9ec7d15152..c29d9c769a 100644 --- a/arch/arm/src/armv7-m/up_signal_dispatch.c +++ b/arch/arm/src/armv7-m/up_signal_dispatch.c @@ -66,12 +66,12 @@ * user-space, signal handler trampoline function. It is called from * up_signal_dispatch() in user-mode. * - * Inputs: + * Input Parameters: * sighand - The address user-space signal handling function * signo, info, and ucontext - Standard arguments to be passed to the * signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via an architecture specific system call made by up_signal_handler(). * However, this will look like a normal return by the caller of diff --git a/arch/arm/src/armv7-m/up_unblocktask.c b/arch/arm/src/armv7-m/up_unblocktask.c index 3c9ae8df14..7ecbbd0e57 100644 --- a/arch/arm/src/armv7-m/up_unblocktask.c +++ b/arch/arm/src/armv7-m/up_unblocktask.c @@ -60,7 +60,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/arm/src/armv7-r/arm_blocktask.c b/arch/arm/src/armv7-r/arm_blocktask.c index 58cefee3cf..c35093df07 100644 --- a/arch/arm/src/armv7-r/arm_blocktask.c +++ b/arch/arm/src/armv7-r/arm_blocktask.c @@ -62,7 +62,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/arm/src/armv7-r/arm_dataabort.c b/arch/arm/src/armv7-r/arm_dataabort.c index 52f5d12436..f5939f80e5 100644 --- a/arch/arm/src/armv7-r/arm_dataabort.c +++ b/arch/arm/src/armv7-r/arm_dataabort.c @@ -54,7 +54,7 @@ /**************************************************************************** * Name: arm_dataabort * - * Input parameters: + * Input Parameters: * regs - The standard, ARM register save array. * dfar - Fault address register. * dfsr - Fault status register. diff --git a/arch/arm/src/armv7-r/arm_fullcontextrestore.S b/arch/arm/src/armv7-r/arm_fullcontextrestore.S index 06daa22182..9de8e405b7 100644 --- a/arch/arm/src/armv7-r/arm_fullcontextrestore.S +++ b/arch/arm/src/armv7-r/arm_fullcontextrestore.S @@ -75,7 +75,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/armv7-r/arm_reprioritizertr.c b/arch/arm/src/armv7-r/arm_reprioritizertr.c index db96424eb2..85b8ee22c0 100644 --- a/arch/arm/src/armv7-r/arm_reprioritizertr.c +++ b/arch/arm/src/armv7-r/arm_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/arm/src/armv7-r/arm_signal_dispatch.c b/arch/arm/src/armv7-r/arm_signal_dispatch.c index 5fa1b3a647..c09c1481b6 100644 --- a/arch/arm/src/armv7-r/arm_signal_dispatch.c +++ b/arch/arm/src/armv7-r/arm_signal_dispatch.c @@ -79,12 +79,12 @@ * user-space, signal handler trampoline function. It is called from * up_signal_dispatch() in user-mode. * - * Inputs: + * Input Parameters: * sighand - The address user-space signal handling function * signo, info, and ucontext - Standard arguments to be passed to the * signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via an architecture specific system call made by up_signal_handler(). * However, this will look like a normal return by the caller of diff --git a/arch/arm/src/armv7-r/arm_signal_handler.S b/arch/arm/src/armv7-r/arm_signal_handler.S index 43f629a3ba..f2812a934f 100644 --- a/arch/arm/src/armv7-r/arm_signal_handler.S +++ b/arch/arm/src/armv7-r/arm_signal_handler.S @@ -76,13 +76,13 @@ * R4-R10 - static registers must be preserved * R12-R14 - LR and SP must be preserved * - * Inputs: + * Input Parameters: * R0 = sighand * The address user-space signal handling function * R1-R3 = signo, info, and ucontext * Standard arguments to be passed to the signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via the SYS_signal_handler_return (see svcall.h) * diff --git a/arch/arm/src/armv7-r/arm_unblocktask.c b/arch/arm/src/armv7-r/arm_unblocktask.c index 0361c1cc81..10188aac10 100644 --- a/arch/arm/src/armv7-r/arm_unblocktask.c +++ b/arch/arm/src/armv7-r/arm_unblocktask.c @@ -73,7 +73,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/arm/src/armv7-r/arm_vfork.S b/arch/arm/src/armv7-r/arm_vfork.S index 635a5759c4..5b9a49588f 100644 --- a/arch/arm/src/armv7-r/arm_vfork.S +++ b/arch/arm/src/armv7-r/arm_vfork.S @@ -88,10 +88,10 @@ * 5) up_vfork() then calls task_vforkstart() * 6) task_vforkstart() then executes the child thread. * - * Input Paremeters: + * Input Parameters: * None * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and * returns the process ID of the child process to the parent process. * Otherwise, -1 is returned to the parent, no child process is created, diff --git a/arch/arm/src/bcm2708/bcm_miniuart.c b/arch/arm/src/bcm2708/bcm_miniuart.c index dc17851f61..a035bd1213 100644 --- a/arch/arm/src/bcm2708/bcm_miniuart.c +++ b/arch/arm/src/bcm2708/bcm_miniuart.c @@ -640,7 +640,7 @@ static bool bcm_rxavailable(struct uart_dev_s *dev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/arch/arm/src/common/up_checkstack.c b/arch/arm/src/common/up_checkstack.c index 03423fd426..fe75ed99cd 100644 --- a/arch/arm/src/common/up_checkstack.c +++ b/arch/arm/src/common/up_checkstack.c @@ -72,7 +72,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size, bool int_stack); * alloc - Allocation base address of the stack * size - The size of the stack in bytes * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ @@ -182,7 +182,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size, bool int_stack) * Input Parameters: * None * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ diff --git a/arch/arm/src/common/up_createstack.c b/arch/arm/src/common/up_createstack.c index 6643f94def..2f3bd3b4d4 100644 --- a/arch/arm/src/common/up_createstack.c +++ b/arch/arm/src/common/up_createstack.c @@ -97,7 +97,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/arm/src/common/up_releasestack.c b/arch/arm/src/common/up_releasestack.c index 9be9740a5b..7090916dde 100644 --- a/arch/arm/src/common/up_releasestack.c +++ b/arch/arm/src/common/up_releasestack.c @@ -69,7 +69,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/arm/src/common/up_stackframe.c b/arch/arm/src/common/up_stackframe.c index dace2e9239..c3a1f055eb 100644 --- a/arch/arm/src/common/up_stackframe.c +++ b/arch/arm/src/common/up_stackframe.c @@ -98,7 +98,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/arm/src/common/up_usestack.c b/arch/arm/src/common/up_usestack.c index 55c6a0526f..7748fbd652 100644 --- a/arch/arm/src/common/up_usestack.c +++ b/arch/arm/src/common/up_usestack.c @@ -89,7 +89,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/arm/src/common/up_vfork.c b/arch/arm/src/common/up_vfork.c index 5a69e310e3..ff43c9cc97 100644 --- a/arch/arm/src/common/up_vfork.c +++ b/arch/arm/src/common/up_vfork.c @@ -101,7 +101,7 @@ * Input Parameters: * context - Caller context information saved by vfork() * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and * returns the process ID of the child process to the parent process. * Otherwise, -1 is returned to the parent, no child process is created, diff --git a/arch/arm/src/dm320/dm320_framebuffer.c b/arch/arm/src/dm320/dm320_framebuffer.c index dcedcb62e5..94b69e65d3 100644 --- a/arch/arm/src/dm320/dm320_framebuffer.c +++ b/arch/arm/src/dm320/dm320_framebuffer.c @@ -1367,7 +1367,7 @@ static int dm320_setcursor(FAR struct fb_vtable_s *vtable, FAR struct fb_setcurs * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -1403,7 +1403,7 @@ int up_fbinitialize(int display) * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/arch/arm/src/efm32/efm32_adc.c b/arch/arm/src/efm32/efm32_adc.c index e79c2a61ef..a1224e2d75 100644 --- a/arch/arm/src/efm32/efm32_adc.c +++ b/arch/arm/src/efm32/efm32_adc.c @@ -705,7 +705,7 @@ endif /* defined(ADC_COUNT) && (ADC_COUNT > 0) */ * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/efm32/efm32_bitband.c b/arch/arm/src/efm32/efm32_bitband.c index fa45b660b8..a4810705c3 100644 --- a/arch/arm/src/efm32/efm32_bitband.c +++ b/arch/arm/src/efm32/efm32_bitband.c @@ -86,7 +86,7 @@ * Note * This function is only atomic on cores which fully support bitbanding. * - * Input Parmeters: + * Input Parameters: * addr Peripheral address location to modify bit in. * bit Bit position to modify, 0-31. * val Value to set bit to, 0 or 1. @@ -115,7 +115,7 @@ inline void bitband_set_peripheral(uint32_t addr, uint32_t bit, uint32_t val) * Note * This function is only atomic on cores which fully support bitbanding. * - * Input Parmeters: + * Input Parameters: * addr Peripheral address location to read. * bit Bit position to modify, 0-31. * @@ -145,7 +145,7 @@ inline uint32_t bitband_get_peripheral(uint32_t addr, uint32_t bit) * Note * This function is only atomic on cores which fully support bitbanding. * - * Input Parmeters: + * Input Parameters: * addr SRAM address location to modify bit in. * bit Bit position to modify, 0-31. * val Value to set bit to, 0 or 1. @@ -174,7 +174,7 @@ inline void bitband_set_sram(uint32_t addr, uint32_t bit, uint32_t val) * Note * This function is only atomic on cores which fully support bitbanding. * - * Input Parmeters: + * Input Parameters: * addr Peripheral address location to read. * bit Bit position to modify, 0-31. * diff --git a/arch/arm/src/efm32/efm32_dma.c b/arch/arm/src/efm32/efm32_dma.c index ef97e08d6c..f93497b4d3 100644 --- a/arch/arm/src/efm32/efm32_dma.c +++ b/arch/arm/src/efm32/efm32_dma.c @@ -319,7 +319,7 @@ void weak_function up_dmainitialize(void) * until the holder of a channel relinquishes the channel by calling * efm32_dmafree(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/efm32/efm32_dma.h b/arch/arm/src/efm32/efm32_dma.h index 813b30bf70..19eec8b0e9 100644 --- a/arch/arm/src/efm32/efm32_dma.h +++ b/arch/arm/src/efm32/efm32_dma.h @@ -173,7 +173,7 @@ extern "C" * If no DMA channel is available, then efm32_dmachannel() will wait until the * holder of a channel relinquishes the channel by calling efm32_dmafree(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/efm32/efm32_i2c.h b/arch/arm/src/efm32/efm32_i2c.h index 16e51434be..6218da8435 100644 --- a/arch/arm/src/efm32/efm32_i2c.h +++ b/arch/arm/src/efm32/efm32_i2c.h @@ -56,7 +56,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -72,7 +72,7 @@ FAR struct i2c_master_s *efm32_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the efm32_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/efm32/efm32_pm.h b/arch/arm/src/efm32/efm32_pm.h index 6846de31a3..413eda45c1 100644 --- a/arch/arm/src/efm32/efm32_pm.h +++ b/arch/arm/src/efm32/efm32_pm.h @@ -110,7 +110,7 @@ int efm32_pmstop(bool lpds); * Input Parameters: * None * - * Returned Value. + * Returned Value: * On success, this function will not return (STANDBY mode can only be * terminated with a reset event). Otherwise, STANDBY mode did not occur * and a negated errno value is returned to indicate the cause of the diff --git a/arch/arm/src/efm32/efm32_pwm.c b/arch/arm/src/efm32/efm32_pwm.c index b9c7bd0271..ec0ac79555 100644 --- a/arch/arm/src/efm32/efm32_pwm.c +++ b/arch/arm/src/efm32/efm32_pwm.c @@ -284,7 +284,7 @@ static void pwm_putreg(struct efm32_pwmtimer_s *priv, int offset, uint32_t value * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -345,7 +345,7 @@ static void pwm_dumpregs(struct efm32_pwmtimer_s *priv, FAR const char *msg) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -433,7 +433,7 @@ static int pwm_timer(FAR struct efm32_pwmtimer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * Standard interrupt handler arguments. * * Returned Value: @@ -529,7 +529,7 @@ static int pwm_interrupt(int irq, void *context, FAR void *arg) * Description: * Pick an optimal pulse count to program the RCR. * - * Input parameters: + * Input Parameters: * count - The total count remaining * * Returned Value: @@ -583,7 +583,7 @@ static uint8_t pwm_pulsecount(uint32_t count) * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -643,7 +643,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -678,7 +678,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -717,7 +717,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -761,7 +761,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/efm32/efm32_rmu.c b/arch/arm/src/efm32/efm32_rmu.c index 57d7b0e02b..fbed325339 100644 --- a/arch/arm/src/efm32/efm32_rmu.c +++ b/arch/arm/src/efm32/efm32_rmu.c @@ -184,7 +184,7 @@ uint32_t g_efm32_rstcause; * Description: * Return next reset cause string, NULL if no more reset cause. * - * Input Parmeters: + * Input Parameters: * reg: reset cause register to decode (like g_efm32_rstcause) * idx: Use to keep in maind reset cause decoding position. * set *idx to zero before first call. diff --git a/arch/arm/src/efm32/efm32_rmu.h b/arch/arm/src/efm32/efm32_rmu.h index 1bcfec2d33..9a7a32dbdc 100644 --- a/arch/arm/src/efm32/efm32_rmu.h +++ b/arch/arm/src/efm32/efm32_rmu.h @@ -90,7 +90,7 @@ const char* efm32_reset_cause_list_str(uint32_t reg, unsigned int *idx); * Description: * Return next reset cause string, NULL if no more reset cause. * - * Input Parmeters: + * Input Parameters: * reg: reset cause register to decode (like g_efm32_rstcause) * idx: Use to keep in maind reset cause decoding position. * set *idx to zero before first call. diff --git a/arch/arm/src/efm32/efm32_spi.c b/arch/arm/src/efm32/efm32_spi.c index d7821a553e..7fe5139666 100644 --- a/arch/arm/src/efm32/efm32_spi.c +++ b/arch/arm/src/efm32/efm32_spi.c @@ -1570,7 +1570,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *rxbuffer, * Initialize the selected SPI port in its default state (Master, 8-bit, * mode 0, etc.) * - * Input Parameter: + * Input Parameters: * priv - private SPI device structure * * Returned Value: @@ -1695,7 +1695,7 @@ errout: * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * port - SPI port number to initialize. One of {0,1,2} * * Returned Value: diff --git a/arch/arm/src/efm32/efm32_spi.h b/arch/arm/src/efm32/efm32_spi.h index 9e84fb68dc..bcaff84e13 100644 --- a/arch/arm/src/efm32/efm32_spi.h +++ b/arch/arm/src/efm32/efm32_spi.h @@ -59,7 +59,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * port - SPI port number to initialize. One of {0,1,2} * * Returned Value: diff --git a/arch/arm/src/efm32/efm32_timer.c b/arch/arm/src/efm32/efm32_timer.c index 6264c3a378..f8c1b1eaaf 100644 --- a/arch/arm/src/efm32/efm32_timer.c +++ b/arch/arm/src/efm32/efm32_timer.c @@ -77,7 +77,7 @@ * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * base - A base address of timer * * Returned Value: @@ -132,7 +132,7 @@ void efm32_timer_dumpregs(uintptr_t base, FAR const char *msg) * Description: * reset timer into reset state * - * Input parameters: + * Input Parameters: * base - A base address of timer * * Returned Value: @@ -192,7 +192,7 @@ void efm32_timer_reset(uintptr_t base) * Description: * set prescaler and top timer with best value to have "freq" * - * Input parameters: + * Input Parameters: * base - A base address of timer * clk_freq - Clock soure of timer. * freq - Wanted freqency. diff --git a/arch/arm/src/efm32/efm32_usbhost.c b/arch/arm/src/efm32/efm32_usbhost.c index cce11725fd..8c1866a797 100644 --- a/arch/arm/src/efm32/efm32_usbhost.c +++ b/arch/arm/src/efm32/efm32_usbhost.c @@ -1340,7 +1340,7 @@ static int efm32_ctrlchan_alloc(FAR struct efm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1402,7 +1402,7 @@ static int efm32_ctrlep_alloc(FAR struct efm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3791,7 +3791,7 @@ static void efm32_txfe_enable(FAR struct efm32_usbhost_s *priv, int chidx) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3882,7 +3882,7 @@ static int efm32_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4010,7 +4010,7 @@ static int efm32_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4069,7 +4069,7 @@ static int efm32_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4126,7 +4126,7 @@ static int efm32_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpoint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4194,7 +4194,7 @@ static int efm32_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4240,7 +4240,7 @@ static int efm32_alloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4276,7 +4276,7 @@ static int efm32_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4320,7 +4320,7 @@ static int efm32_ioalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4363,7 +4363,7 @@ static int efm32_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4566,7 +4566,7 @@ static int efm32_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4638,7 +4638,7 @@ static ssize_t efm32_transfer(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4694,7 +4694,7 @@ static int efm32_asynch(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep, * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4783,7 +4783,7 @@ static int efm32_cancel(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4834,7 +4834,7 @@ static int efm32_connect(FAR struct usbhost_driver_s *drvr, * drvr - The USB host driver instance obtained as a parameter from the call to * the class create() method. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/imx1/imx_cspi.h b/arch/arm/src/imx1/imx_cspi.h index f15872c49b..3d80a3d540 100644 --- a/arch/arm/src/imx1/imx_cspi.h +++ b/arch/arm/src/imx1/imx_cspi.h @@ -193,7 +193,7 @@ struct spi_dev_s; /* Forward reference */ * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/imx1/imx_spi.c b/arch/arm/src/imx1/imx_spi.c index 92208b78be..682805fdb7 100644 --- a/arch/arm/src/imx1/imx_spi.c +++ b/arch/arm/src/imx1/imx_spi.c @@ -1024,7 +1024,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/imx6/imx_cpuboot.c b/arch/arm/src/imx6/imx_cpuboot.c index 818b327a4b..e747b701cf 100644 --- a/arch/arm/src/imx6/imx_cpuboot.c +++ b/arch/arm/src/imx6/imx_cpuboot.c @@ -249,7 +249,7 @@ void imx_cpu_enable(void) * This function must be provided by the each ARMv7-A MCU and implement * MCU-specific initialization logic. * - * Input parameters: + * Input Parameters: * cpu - The CPU index. This is the same value that would be obtained by * calling up_cpu_index(); * diff --git a/arch/arm/src/imx6/imx_ecspi.c b/arch/arm/src/imx6/imx_ecspi.c index 42c8017fc0..0a20c514b9 100644 --- a/arch/arm/src/imx6/imx_ecspi.c +++ b/arch/arm/src/imx6/imx_ecspi.c @@ -1209,7 +1209,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/imx6/imx_ecspi.h b/arch/arm/src/imx6/imx_ecspi.h index ac30d2291f..4e3f8b977e 100644 --- a/arch/arm/src/imx6/imx_ecspi.h +++ b/arch/arm/src/imx6/imx_ecspi.h @@ -85,7 +85,7 @@ struct spi_dev_s; /* Forward reference */ * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/kinetis/kinetis.h b/arch/arm/src/kinetis/kinetis.h index a1558179fd..ef91886626 100644 --- a/arch/arm/src/kinetis/kinetis.h +++ b/arch/arm/src/kinetis/kinetis.h @@ -418,7 +418,7 @@ void kinetis_lowsetup(void); * Input Parameters: * first: - First TTY number to assign * - * Returns Value: + * Returned Value: * The next TTY number available for assignment * ****************************************************************************/ @@ -437,7 +437,7 @@ unsigned int kinetis_uart_serialinit(unsigned int first); * Input Parameters: * first: - First TTY number to assign * - * Returns Value: + * Returned Value: * The next TTY number available for assignment * ****************************************************************************/ @@ -587,7 +587,7 @@ void kinetis_pinirqinitialize(void); * pinisr - Pin interrupt service routine * arg - An argument that will be provided to the interrupt service routine. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on any * failure to indicate the nature of the failure. * @@ -678,10 +678,10 @@ void kinetis_clrpend(int irq); * Description: * Initialize SDIO for operation. * - * Input parameters: + * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -705,7 +705,7 @@ FAR struct sdio_dev_s *sdhc_initialize(int slotno); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -725,7 +725,7 @@ void sdhc_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_i2c.h b/arch/arm/src/kinetis/kinetis_i2c.h index 098e4d39ad..8cb4246a17 100644 --- a/arch/arm/src/kinetis/kinetis_i2c.h +++ b/arch/arm/src/kinetis/kinetis_i2c.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *kinetis_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc43_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/kinetis/kinetis_lpserial.c b/arch/arm/src/kinetis/kinetis_lpserial.c index 262bda4a8a..3de8f6e3a6 100644 --- a/arch/arm/src/kinetis/kinetis_lpserial.c +++ b/arch/arm/src/kinetis/kinetis_lpserial.c @@ -965,7 +965,7 @@ static bool kinetis_rxavailable(struct uart_dev_s *dev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is @@ -1145,7 +1145,7 @@ void kinetis_lpuart_earlyserialinit(void) * Input Parameters: * first: - First TTY number to assign * - * Returns Value: + * Returned Value: * The next TTY number available for assignment * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_pin.c b/arch/arm/src/kinetis/kinetis_pin.c index 8a2e329432..4a084f6c27 100644 --- a/arch/arm/src/kinetis/kinetis_pin.c +++ b/arch/arm/src/kinetis/kinetis_pin.c @@ -214,7 +214,7 @@ int kinetis_pinconfig(uint32_t cfgset) * Configure the digital filter associated with a port. The digital filter * capabilities of the PORT module are available in all digital pin muxing modes. * - * Input parmeters: + * Input Parameters: * port - Port number. See KINETIS_PORTn definitions in kinetis_port.h * lpo - true: Digital Filters are clocked by the bus clock * false: Digital Filters are clocked by the 1 kHz LPO clock diff --git a/arch/arm/src/kinetis/kinetis_pinirq.c b/arch/arm/src/kinetis/kinetis_pinirq.c index f40be80a8e..0a015b6ad4 100644 --- a/arch/arm/src/kinetis/kinetis_pinirq.c +++ b/arch/arm/src/kinetis/kinetis_pinirq.c @@ -267,7 +267,7 @@ void kinetis_pinirqinitialize(void) * pinisr - Pin interrupt service routine * arg - An argument that will be provided to the interrupt service routine. * - * Returns: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on any * failure to indicate the nature of the failure. * diff --git a/arch/arm/src/kinetis/kinetis_pwm.c b/arch/arm/src/kinetis/kinetis_pwm.c index 83f6c76699..b4dd646c9a 100644 --- a/arch/arm/src/kinetis/kinetis_pwm.c +++ b/arch/arm/src/kinetis/kinetis_pwm.c @@ -248,7 +248,7 @@ static void pwm_putreg(struct kinetis_pwmtimer_s *priv, int offset, uint32_t val * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -347,7 +347,7 @@ static void pwm_dumpregs(struct kinetis_pwmtimer_s *priv, FAR const char *msg) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -541,7 +541,7 @@ static int pwm_timer(FAR struct kinetis_pwmtimer_s *priv, * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -589,7 +589,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -622,7 +622,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -644,7 +644,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -728,7 +728,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/kinetis/kinetis_sdhc.c b/arch/arm/src/kinetis/kinetis_sdhc.c index ef59c16fe0..816a4ee18b 100644 --- a/arch/arm/src/kinetis/kinetis_sdhc.c +++ b/arch/arm/src/kinetis/kinetis_sdhc.c @@ -2795,7 +2795,7 @@ static void kinetis_callback(void *arg) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -2909,7 +2909,7 @@ FAR struct sdio_dev_s *sdhc_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -2956,7 +2956,7 @@ void sdhc_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_serial.c b/arch/arm/src/kinetis/kinetis_serial.c index 0f2a4b2ee4..23d327ec09 100644 --- a/arch/arm/src/kinetis/kinetis_serial.c +++ b/arch/arm/src/kinetis/kinetis_serial.c @@ -1334,7 +1334,7 @@ static bool up_rxavailable(struct uart_dev_s *dev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is @@ -1561,7 +1561,7 @@ void kinetis_uart_earlyserialinit(void) * Input Parameters: * first: - First TTY number to assign * - * Returns Value: + * Returned Value: * The next TTY number available for assignment * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_spi.c b/arch/arm/src/kinetis/kinetis_spi.c index 3fc63b901e..ce3971518e 100644 --- a/arch/arm/src/kinetis/kinetis_spi.c +++ b/arch/arm/src/kinetis/kinetis_spi.c @@ -1109,7 +1109,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/kinetis/kinetis_spi.h b/arch/arm/src/kinetis/kinetis_spi.h index 8222af4424..4d3ce60ce2 100644 --- a/arch/arm/src/kinetis/kinetis_spi.h +++ b/arch/arm/src/kinetis/kinetis_spi.h @@ -75,7 +75,7 @@ struct spi_dev_s; * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * bus number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/kl/kl_gpio.h b/arch/arm/src/kl/kl_gpio.h index 4a81acd27e..78f7fdc122 100644 --- a/arch/arm/src/kl/kl_gpio.h +++ b/arch/arm/src/kl/kl_gpio.h @@ -370,7 +370,7 @@ bool kl_gpioread(uint32_t pinset); * - pinisr: Pin interrupt service routine * - pinarg: The argument that will accompany the pin interrupt * - * Returns: + * Returned Value: * Zero (OK) is returned on success; On any failure, a negated errno value is * returned to indicate the nature of the failure. * diff --git a/arch/arm/src/kl/kl_gpioirq.c b/arch/arm/src/kl/kl_gpioirq.c index 38f30c0870..a42be056ab 100644 --- a/arch/arm/src/kl/kl_gpioirq.c +++ b/arch/arm/src/kl/kl_gpioirq.c @@ -230,8 +230,8 @@ void kl_gpioirqinitialize(void) * - pinisr: Pin interrupt service routine * - pinarg: The argument that will accompany the pin interrupt * - * Returns: - * Returns: + * Returned Value: + * Returned Value: * Zero (OK) is returned on success; On any failure, a negated errno value is * returned to indicate the nature of the failure. * diff --git a/arch/arm/src/kl/kl_pwm.c b/arch/arm/src/kl/kl_pwm.c index a34aa0f817..cfa024b477 100644 --- a/arch/arm/src/kl/kl_pwm.c +++ b/arch/arm/src/kl/kl_pwm.c @@ -226,7 +226,7 @@ static void pwm_putreg(struct kl_pwmtimer_s *priv, int offset, uint32_t value) * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -307,7 +307,7 @@ static void pwm_dumpregs(struct kl_pwmtimer_s *priv, FAR const char *msg) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -488,7 +488,7 @@ static int pwm_timer(FAR struct kl_pwmtimer_s *priv, * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -529,7 +529,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -562,7 +562,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -584,7 +584,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -660,7 +660,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/kl/kl_spi.c b/arch/arm/src/kl/kl_spi.c index 81cda9c9da..187ae75e9e 100644 --- a/arch/arm/src/kl/kl_spi.c +++ b/arch/arm/src/kl/kl_spi.c @@ -612,7 +612,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/kl/kl_spi.h b/arch/arm/src/kl/kl_spi.h index fd621858a6..968cf6abef 100644 --- a/arch/arm/src/kl/kl_spi.h +++ b/arch/arm/src/kl/kl_spi.h @@ -71,7 +71,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lc823450/lc823450_cpuidlestack.c b/arch/arm/src/lc823450/lc823450_cpuidlestack.c index e9418abfcc..3c7a6e58fd 100644 --- a/arch/arm/src/lc823450/lc823450_cpuidlestack.c +++ b/arch/arm/src/lc823450/lc823450_cpuidlestack.c @@ -82,7 +82,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - cpu: CPU index that indicates which CPU the IDLE task is * being created for. * - tcb: The TCB of new CPU IDLE task diff --git a/arch/arm/src/lc823450/lc823450_sdc.c b/arch/arm/src/lc823450/lc823450_sdc.c index b0f0a357e2..e47ab04dcb 100644 --- a/arch/arm/src/lc823450/lc823450_sdc.c +++ b/arch/arm/src/lc823450/lc823450_sdc.c @@ -355,7 +355,9 @@ int lc823450_sdc_setclock(uint32_t ch, uint32_t limitclk, uint32_t sysclk) /**************************************************************************** * Name: lc823450_sdc_refmediatype * - * Return Values: 0(sd), 1(emmc) + * Returned Value: + * 0(sd), 1(emmc) + * ****************************************************************************/ int lc823450_sdc_refmediatype(uint32_t ch) diff --git a/arch/arm/src/lc823450/lc823450_spi.c b/arch/arm/src/lc823450/lc823450_spi.c index 038351d79a..51451b6001 100644 --- a/arch/arm/src/lc823450/lc823450_spi.c +++ b/arch/arm/src/lc823450/lc823450_spi.c @@ -512,7 +512,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lc823450/lc823450_syscontrol.c b/arch/arm/src/lc823450/lc823450_syscontrol.c index 82e6c2ee01..cd5458729b 100644 --- a/arch/arm/src/lc823450/lc823450_syscontrol.c +++ b/arch/arm/src/lc823450/lc823450_syscontrol.c @@ -102,7 +102,7 @@ uint32_t get_cpu_ver(void) /**************************************************************************** * Name: mod_stby_regs * - * Input parameters: + * Input Parameters: * enabits : specify regions to be enabled * disbits : specify regions to be disabled * diff --git a/arch/arm/src/lc823450/lc823450_wdt.c b/arch/arm/src/lc823450/lc823450_wdt.c index 80f7b49c21..cdd351c095 100644 --- a/arch/arm/src/lc823450/lc823450_wdt.c +++ b/arch/arm/src/lc823450/lc823450_wdt.c @@ -182,7 +182,7 @@ static void wdg_work_func(void *arg) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -223,7 +223,7 @@ static int lc823450_wdt_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -246,7 +246,7 @@ static int lc823450_wdt_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -271,7 +271,7 @@ static int lc823450_wdt_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -299,7 +299,7 @@ static int lc823450_wdt_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * stawtus - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -362,7 +362,7 @@ static int lc823450_wdt_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in millisecnds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -430,7 +430,7 @@ static int lc823450_wdt_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -496,7 +496,7 @@ static xcpt_t lc823450_wdt_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -526,7 +526,7 @@ static int lc823450_wdt_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * Input Parameters: * None * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc11xx/lpc11_i2c.h b/arch/arm/src/lpc11xx/lpc11_i2c.h index a9bc6fa3f7..cd739be1a3 100644 --- a/arch/arm/src/lpc11xx/lpc11_i2c.h +++ b/arch/arm/src/lpc11xx/lpc11_i2c.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *lpc11_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc11_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc11xx/lpc11_spi.c b/arch/arm/src/lpc11xx/lpc11_spi.c index 363cd6466a..e1bb8e0d6c 100644 --- a/arch/arm/src/lpc11xx/lpc11_spi.c +++ b/arch/arm/src/lpc11xx/lpc11_spi.c @@ -526,7 +526,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc11xx/lpc11_spi.h b/arch/arm/src/lpc11xx/lpc11_spi.h index 1a6786d218..30ee2bbecf 100644 --- a/arch/arm/src/lpc11xx/lpc11_spi.h +++ b/arch/arm/src/lpc11xx/lpc11_spi.h @@ -76,7 +76,7 @@ extern "C" * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc11xx/lpc11_ssp.c b/arch/arm/src/lpc11xx/lpc11_ssp.c index 32cccc29f3..c0c1498f7e 100644 --- a/arch/arm/src/lpc11xx/lpc11_ssp.c +++ b/arch/arm/src/lpc11xx/lpc11_ssp.c @@ -776,7 +776,7 @@ static void ssp_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * Description: * Initialize the SSP0 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -830,7 +830,7 @@ static inline FAR struct lpc11_sspdev_s *lpc11_ssp0initialize(void) * Description: * Initialize the SSP1 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -884,7 +884,7 @@ static inline FAR struct lpc11_sspdev_s *lpc11_ssp1initialize(void) * Description: * Initialize the SSP2 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -941,7 +941,7 @@ static inline FAR struct lpc11_sspdev_s *lpc11_ssp2initialize(void) * Description: * Initialize the selected SSP port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc11xx/lpc11_ssp.h b/arch/arm/src/lpc11xx/lpc11_ssp.h index f117b1cf03..825c67faa3 100644 --- a/arch/arm/src/lpc11xx/lpc11_ssp.h +++ b/arch/arm/src/lpc11xx/lpc11_ssp.h @@ -76,7 +76,7 @@ extern "C" * Description: * Initialize the selected SSP port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc11xx/lpc11_timer.c b/arch/arm/src/lpc11xx/lpc11_timer.c index a9ce65a073..75d3d334a4 100644 --- a/arch/arm/src/lpc11xx/lpc11_timer.c +++ b/arch/arm/src/lpc11xx/lpc11_timer.c @@ -214,7 +214,7 @@ static void timer_putreg(struct lpc11_timer_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -256,7 +256,7 @@ static void timer_dumpregs(struct lpc11_timer_s *priv, FAR const char *msg) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -291,7 +291,7 @@ static int timer_timer(FAR struct lpc11_timer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -325,7 +325,7 @@ static int timer_interrupt(struct lpc11_timer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -348,7 +348,7 @@ static int timer_tim1interrupt(int irq, void *context) * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -436,7 +436,7 @@ static int timer_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * * Returned Value: @@ -462,7 +462,7 @@ static int timer_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * info - A reference to the characteristics of the pulsed output * @@ -484,7 +484,7 @@ static int timer_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * * Returned Value: @@ -542,7 +542,7 @@ static int timer_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/lpc17xx/lpc17_can.c b/arch/arm/src/lpc17xx/lpc17_can.c index 94f1987280..d7e8fcc461 100644 --- a/arch/arm/src/lpc17xx/lpc17_can.c +++ b/arch/arm/src/lpc17xx/lpc17_can.c @@ -1109,7 +1109,7 @@ static int can12_interrupt(int irq, void *context, FAR void *arg) * Where: * Tcan is the period of the APB clock (PCLK = CCLK / CONFIG_CAN1_DIVISOR). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1210,7 +1210,7 @@ static int can_bittiming(struct up_dev_s *priv) * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_can.h b/arch/arm/src/lpc17xx/lpc17_can.h index e15eaced5a..2cbb8014a9 100644 --- a/arch/arm/src/lpc17xx/lpc17_can.h +++ b/arch/arm/src/lpc17xx/lpc17_can.h @@ -71,7 +71,7 @@ extern "C" * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_i2c.h b/arch/arm/src/lpc17xx/lpc17_i2c.h index a7a6322461..044f0560c7 100644 --- a/arch/arm/src/lpc17xx/lpc17_i2c.h +++ b/arch/arm/src/lpc17xx/lpc17_i2c.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *lpc17_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc17_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_lcd.c b/arch/arm/src/lpc17xx/lpc17_lcd.c index 90332fc12e..e7aebe109f 100644 --- a/arch/arm/src/lpc17xx/lpc17_lcd.c +++ b/arch/arm/src/lpc17xx/lpc17_lcd.c @@ -458,7 +458,7 @@ static int lpc17_setcursor(FAR struct fb_vtable_s *vtable, * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -717,7 +717,7 @@ int up_fbinitialize(int display) * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/arch/arm/src/lpc17xx/lpc17_mcpwm.c b/arch/arm/src/lpc17xx/lpc17_mcpwm.c index db0d1a9d67..c076a10ce5 100644 --- a/arch/arm/src/lpc17xx/lpc17_mcpwm.c +++ b/arch/arm/src/lpc17xx/lpc17_mcpwm.c @@ -215,7 +215,7 @@ static void mcpwm_putreg(struct lpc17_mcpwmtimer_s *priv, int offset, uint32_t v * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -258,7 +258,7 @@ static void mcpwm_dumpregs(FAR struct lpc17_mcpwmtimer_s *priv, * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -290,7 +290,7 @@ static int mcpwm_timer(FAR struct lpc17_mcpwmtimer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -324,7 +324,7 @@ static int mcpwm_interrupt(struct lpc17_mcpwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -343,7 +343,7 @@ static int mcpwm_tim1interrupt(int irq, void *context) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -387,7 +387,7 @@ static void mcpwm_set_apb_clock(FAR struct lpc17_mcpwmtimer_s *priv, bool on) * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -488,7 +488,7 @@ static int mcpwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -514,7 +514,7 @@ static int mcpwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -536,7 +536,7 @@ static int mcpwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -594,7 +594,7 @@ static int mcpwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/lpc17xx/lpc17_pwm.c b/arch/arm/src/lpc17xx/lpc17_pwm.c index df3be30a74..f28c099626 100644 --- a/arch/arm/src/lpc17xx/lpc17_pwm.c +++ b/arch/arm/src/lpc17xx/lpc17_pwm.c @@ -231,7 +231,7 @@ static void pwm_putreg(struct lpc17_pwmtimer_s *priv, int offset, uint32_t value * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -273,7 +273,7 @@ static void pwm_dumpregs(struct lpc17_pwmtimer_s *priv, FAR const char *msg) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -308,7 +308,7 @@ static int pwm_timer(FAR struct lpc17_pwmtimer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -342,7 +342,7 @@ static int pwm_interrupt(struct lpc17_pwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -361,7 +361,7 @@ static int pwm_tim1interrupt(int irq, void *context, FAR void *arg) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -405,7 +405,7 @@ static void pwm_set_apb_clock(FAR struct lpc17_pwmtimer_s *priv, bool on) * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -459,7 +459,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -485,7 +485,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -507,7 +507,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -565,7 +565,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/lpc17xx/lpc17_sdcard.c b/arch/arm/src/lpc17xx/lpc17_sdcard.c index 96cdb510f9..1d21e582c5 100644 --- a/arch/arm/src/lpc17xx/lpc17_sdcard.c +++ b/arch/arm/src/lpc17xx/lpc17_sdcard.c @@ -2701,7 +2701,7 @@ static void lpc17_default(void) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SD card interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -2787,7 +2787,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -2833,7 +2833,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SD card driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc17xx/lpc17_sdcard.h b/arch/arm/src/lpc17xx/lpc17_sdcard.h index 520175ec25..82f94264c7 100644 --- a/arch/arm/src/lpc17xx/lpc17_sdcard.h +++ b/arch/arm/src/lpc17xx/lpc17_sdcard.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -93,7 +93,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -111,7 +111,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc17xx/lpc17_spi.c b/arch/arm/src/lpc17xx/lpc17_spi.c index 60deac4fb5..f653df2d36 100644 --- a/arch/arm/src/lpc17xx/lpc17_spi.c +++ b/arch/arm/src/lpc17xx/lpc17_spi.c @@ -518,7 +518,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_spi.h b/arch/arm/src/lpc17xx/lpc17_spi.h index 27d9ba8bb9..f0be0e9978 100644 --- a/arch/arm/src/lpc17xx/lpc17_spi.h +++ b/arch/arm/src/lpc17xx/lpc17_spi.h @@ -78,7 +78,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_ssp.c b/arch/arm/src/lpc17xx/lpc17_ssp.c index 98220105dc..af8fb4bc42 100644 --- a/arch/arm/src/lpc17xx/lpc17_ssp.c +++ b/arch/arm/src/lpc17xx/lpc17_ssp.c @@ -765,7 +765,7 @@ static void ssp_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the SSP0 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -819,7 +819,7 @@ static inline FAR struct lpc17_sspdev_s *lpc17_ssp0initialize(void) * Description: * Initialize the SSP1 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -873,7 +873,7 @@ static inline FAR struct lpc17_sspdev_s *lpc17_ssp1initialize(void) * Description: * Initialize the SSP2 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -930,7 +930,7 @@ static inline FAR struct lpc17_sspdev_s *lpc17_ssp2initialize(void) * Description: * Initialize the selected SSP port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_ssp.h b/arch/arm/src/lpc17xx/lpc17_ssp.h index c679206ca1..dd8ba3c766 100644 --- a/arch/arm/src/lpc17xx/lpc17_ssp.h +++ b/arch/arm/src/lpc17xx/lpc17_ssp.h @@ -76,7 +76,7 @@ extern "C" * Description: * Initialize the selected SSP port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_timer.c b/arch/arm/src/lpc17xx/lpc17_timer.c index 434f416021..8540d1b386 100644 --- a/arch/arm/src/lpc17xx/lpc17_timer.c +++ b/arch/arm/src/lpc17xx/lpc17_timer.c @@ -215,7 +215,7 @@ static void timer_putreg(struct lpc17_timer_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -257,7 +257,7 @@ static void timer_dumpregs(struct lpc17_timer_s *priv, FAR const char *msg) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -292,7 +292,7 @@ static int timer_timer(FAR struct lpc17_timer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -326,7 +326,7 @@ static int timer_interrupt(struct lpc17_timer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -349,7 +349,7 @@ static int timer_tim1interrupt(int irq, void *context) * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -437,7 +437,7 @@ static int timer_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * * Returned Value: @@ -463,7 +463,7 @@ static int timer_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * info - A reference to the characteristics of the pulsed output * @@ -485,7 +485,7 @@ static int timer_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * * Returned Value: @@ -543,7 +543,7 @@ static int timer_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half TIMER driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/lpc17xx/lpc17_usbhost.c b/arch/arm/src/lpc17xx/lpc17_usbhost.c index fd51d9df2c..fb8abb6467 100644 --- a/arch/arm/src/lpc17xx/lpc17_usbhost.c +++ b/arch/arm/src/lpc17xx/lpc17_usbhost.c @@ -1933,7 +1933,7 @@ static int lpc17_usbinterrupt(int irq, void *context, FAR void *arg) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -2029,7 +2029,7 @@ static int lpc17_wait(struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2128,7 +2128,7 @@ static int lpc17_enumerate(FAR struct usbhost_connection_s *conn, * mps (maxpacketsize) - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2183,7 +2183,7 @@ static int lpc17_ep0configure(struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2339,7 +2339,7 @@ static int lpc17_epalloc(struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2422,7 +2422,7 @@ static int lpc17_epfree(struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2468,7 +2468,7 @@ static int lpc17_alloc(struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2508,7 +2508,7 @@ static int lpc17_free(struct usbhost_driver_s *drvr, uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2553,7 +2553,7 @@ static int lpc17_ioalloc(struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2600,7 +2600,7 @@ static int lpc17_iofree(struct usbhost_driver_s *drvr, uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2701,7 +2701,7 @@ static int lpc17_ctrlout(struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -2779,7 +2779,7 @@ static int lpc17_transfer_common(struct lpc17_usbhost_s *priv, * buflen - The length of the data to be sent or received. * alloc - The location to return the allocated DMA buffer. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -2851,7 +2851,7 @@ static int lpc17_dma_alloc(struct lpc17_usbhost_s *priv, * buflen - The length of the data to be sent or received. * alloc - The allocated DMA buffer to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -2913,7 +2913,7 @@ static void lpc17_dma_free(struct lpc17_usbhost_s *priv, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -3087,7 +3087,7 @@ errout_with_sem: * ep - The IN or OUT endpoint descriptor for the device endpoint on which the * transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3189,7 +3189,7 @@ static void lpc17_asynch_completion(struct lpc17_usbhost_s *priv, * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3306,7 +3306,7 @@ errout_with_sem: * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -3451,7 +3451,7 @@ static int lpc17_cancel(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -3502,7 +3502,7 @@ static int lpc17_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3531,7 +3531,7 @@ static void lpc17_disconnect(struct usbhost_driver_s *drvr, * Input Parameters: * priv - private driver state instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc214x/lpc214x_spi.h b/arch/arm/src/lpc214x/lpc214x_spi.h index 69c94d89c0..e4934d9d38 100644 --- a/arch/arm/src/lpc214x/lpc214x_spi.h +++ b/arch/arm/src/lpc214x/lpc214x_spi.h @@ -171,7 +171,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc2378/lpc23xx_i2c.h b/arch/arm/src/lpc2378/lpc23xx_i2c.h index 5658269f20..1ae069c5f7 100644 --- a/arch/arm/src/lpc2378/lpc23xx_i2c.h +++ b/arch/arm/src/lpc2378/lpc23xx_i2c.h @@ -163,7 +163,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -179,7 +179,7 @@ FAR struct i2c_master_s *lpc2378_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc2378_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc2378/lpc23xx_spi.c b/arch/arm/src/lpc2378/lpc23xx_spi.c index bc7f46cf07..b9006f4e5c 100644 --- a/arch/arm/src/lpc2378/lpc23xx_spi.c +++ b/arch/arm/src/lpc2378/lpc23xx_spi.c @@ -525,7 +525,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc2378/lpc23xx_spi.h b/arch/arm/src/lpc2378/lpc23xx_spi.h index 8b5fbda37c..280c2f44e2 100644 --- a/arch/arm/src/lpc2378/lpc23xx_spi.h +++ b/arch/arm/src/lpc2378/lpc23xx_spi.h @@ -161,7 +161,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc31xx/lpc31.h b/arch/arm/src/lpc31xx/lpc31.h index 00ce6b8e35..ca3c0ad8fb 100644 --- a/arch/arm/src/lpc31xx/lpc31.h +++ b/arch/arm/src/lpc31xx/lpc31.h @@ -176,7 +176,7 @@ void lpc31_clockconfig(void); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: @@ -315,7 +315,7 @@ void lpc31_usbhost_vbusdrive(int rhport, bool enable); * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -337,7 +337,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -355,7 +355,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc31xx/lpc31_ehci.c b/arch/arm/src/lpc31xx/lpc31_ehci.c index 26772ea81a..6b90a1b2eb 100644 --- a/arch/arm/src/lpc31xx/lpc31_ehci.c +++ b/arch/arm/src/lpc31xx/lpc31_ehci.c @@ -2087,7 +2087,7 @@ static struct lpc31_qtd_s *lpc31_qtd_statusphase(uint32_t tokenbits) * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2368,7 +2368,7 @@ errout_with_qh: * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2475,7 +2475,7 @@ errout_with_qh: * complete, but will be re-acquired when before returning. The state of * EHCI resources could be very different upon return. * - * Returned value: + * Returned Value: * On success, this function returns the number of bytes actually transferred. * For control transfers, this size includes the size of the control request * plus the size of the data (which could be short); For bulk transfers, this @@ -2555,7 +2555,7 @@ static ssize_t lpc31_transfer_wait(struct lpc31_epinfo_s *epinfo) * callback - The function to be called when the completes * arg - An arbitrary argument that will be provided with the callback. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -2608,7 +2608,7 @@ static inline int lpc31_ioc_async_setup(struct lpc31_rhport_s *rhport, * epinfo - The IN or OUT endpoint descriptor for the device endpoint on * which the transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3428,7 +3428,7 @@ static int lpc31_ehci_interrupt(int irq, FAR void *context, FAR void *arg) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3530,7 +3530,7 @@ static int lpc31_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3839,7 +3839,7 @@ static int lpc31_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3882,7 +3882,7 @@ static int lpc31_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3965,7 +3965,7 @@ static int lpc31_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4010,7 +4010,7 @@ static int lpc31_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which * to return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4055,7 +4055,7 @@ static int lpc31_alloc(FAR struct usbhost_driver_s *drvr, * to the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4092,7 +4092,7 @@ static int lpc31_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4131,7 +4131,7 @@ static int lpc31_ioalloc(FAR struct usbhost_driver_s *drvr, FAR uint8_t **buffer * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4176,7 +4176,7 @@ static int lpc31_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4277,7 +4277,7 @@ static int lpc31_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4387,7 +4387,7 @@ errout_with_sem: * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4480,7 +4480,7 @@ errout_with_sem: * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4677,7 +4677,7 @@ errout_with_sem: * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4728,7 +4728,7 @@ static int lpc31_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/lpc31xx/lpc31_i2c.h b/arch/arm/src/lpc31xx/lpc31_i2c.h index 10280a5773..ac14998d22 100644 --- a/arch/arm/src/lpc31xx/lpc31_i2c.h +++ b/arch/arm/src/lpc31xx/lpc31_i2c.h @@ -206,7 +206,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -222,7 +222,7 @@ FAR struct i2c_master_s *lpc31_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc31_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc31xx/lpc31_spi.c b/arch/arm/src/lpc31xx/lpc31_spi.c index d0275a502d..c4e1851163 100644 --- a/arch/arm/src/lpc31xx/lpc31_spi.c +++ b/arch/arm/src/lpc31xx/lpc31_spi.c @@ -903,7 +903,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_can.c b/arch/arm/src/lpc43xx/lpc43_can.c index 415a7b28ef..7013ffd6dd 100644 --- a/arch/arm/src/lpc43xx/lpc43_can.c +++ b/arch/arm/src/lpc43xx/lpc43_can.c @@ -1152,7 +1152,7 @@ static void can_setuprxobj(struct up_dev_s *priv) * Where: * Tcan is the period of the APB clock (PCLK = CCLK / CONFIG_CAN1_DIVISOR). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1210,7 +1210,7 @@ static int can_bittiming(struct up_dev_s *priv) * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_can.h b/arch/arm/src/lpc43xx/lpc43_can.h index f321c9b72f..37074c6df3 100644 --- a/arch/arm/src/lpc43xx/lpc43_can.h +++ b/arch/arm/src/lpc43xx/lpc43_can.h @@ -64,7 +64,7 @@ extern "C" * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_ehci.c b/arch/arm/src/lpc43xx/lpc43_ehci.c index 3b24b4f282..3908fb1a8e 100644 --- a/arch/arm/src/lpc43xx/lpc43_ehci.c +++ b/arch/arm/src/lpc43xx/lpc43_ehci.c @@ -1971,7 +1971,7 @@ static struct lpc43_qtd_s *lpc43_qtd_statusphase(uint32_t tokenbits) * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2251,7 +2251,7 @@ errout_with_qh: * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2358,7 +2358,7 @@ errout_with_qh: * complete, but will be re-acquired when before returning. The state of * EHCI resources could be very different upon return. * - * Returned value: + * Returned Value: * On success, this function returns the number of bytes actually transferred. * For control transfers, this size includes the size of the control request * plus the size of the data (which could be short); For bulk transfers, this @@ -2420,7 +2420,7 @@ static ssize_t lpc43_transfer_wait(struct lpc43_epinfo_s *epinfo) * callback - The function to be called when the completes * arg - An arbitrary argument that will be provided with the callback. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -2473,7 +2473,7 @@ static inline int lpc43_ioc_async_setup(struct lpc43_rhport_s *rhport, * epinfo - The IN or OUT endpoint descriptor for the device endpoint on * which the transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3265,7 +3265,7 @@ static int lpc43_ehci_interrupt(int irq, FAR void *context, FAR void *arg) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3367,7 +3367,7 @@ static int lpc43_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3676,7 +3676,7 @@ static int lpc43_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3719,7 +3719,7 @@ static int lpc43_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3802,7 +3802,7 @@ static int lpc43_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3847,7 +3847,7 @@ static int lpc43_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which * to return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3889,7 +3889,7 @@ static int lpc43_alloc(FAR struct usbhost_driver_s *drvr, * to the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3926,7 +3926,7 @@ static int lpc43_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3962,7 +3962,7 @@ static int lpc43_ioalloc(FAR struct usbhost_driver_s *drvr, FAR uint8_t **buffer * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4007,7 +4007,7 @@ static int lpc43_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4108,7 +4108,7 @@ static int lpc43_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4218,7 +4218,7 @@ errout_with_sem: * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4311,7 +4311,7 @@ errout_with_sem: * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4508,7 +4508,7 @@ errout_with_sem: * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4559,7 +4559,7 @@ static int lpc43_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/lpc43xx/lpc43_i2c.h b/arch/arm/src/lpc43xx/lpc43_i2c.h index ae8d94a7f8..224fbaa593 100644 --- a/arch/arm/src/lpc43xx/lpc43_i2c.h +++ b/arch/arm/src/lpc43xx/lpc43_i2c.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *lpc43_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc43_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_pinconfig.c b/arch/arm/src/lpc43xx/lpc43_pinconfig.c index 0a274dd6a8..738b4b8daf 100644 --- a/arch/arm/src/lpc43xx/lpc43_pinconfig.c +++ b/arch/arm/src/lpc43xx/lpc43_pinconfig.c @@ -68,7 +68,7 @@ * Description: * Configure a pin based on bit-encoded description of the pin. * - * Input Value: + * Input Parameters: * 20-bit encoded value describing the pin. * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_pinconfig.h b/arch/arm/src/lpc43xx/lpc43_pinconfig.h index d3a8a822a6..6b82878981 100644 --- a/arch/arm/src/lpc43xx/lpc43_pinconfig.h +++ b/arch/arm/src/lpc43xx/lpc43_pinconfig.h @@ -262,7 +262,7 @@ extern "C" * Description: * Configure a pin based on bit-encoded description of the pin. * - * Input Value: + * Input Parameters: * 20-bit encoded value describing the pin. * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_sdmmc.c b/arch/arm/src/lpc43xx/lpc43_sdmmc.c index c3504e7a15..a84c6b8de9 100644 --- a/arch/arm/src/lpc43xx/lpc43_sdmmc.c +++ b/arch/arm/src/lpc43xx/lpc43_sdmmc.c @@ -2709,7 +2709,7 @@ static void lpc43_callback(struct lpc43_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SD card interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_sdmmc.h b/arch/arm/src/lpc43xx/lpc43_sdmmc.h index 7a27088415..449ee0f7a5 100644 --- a/arch/arm/src/lpc43xx/lpc43_sdmmc.h +++ b/arch/arm/src/lpc43xx/lpc43_sdmmc.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_spi.c b/arch/arm/src/lpc43xx/lpc43_spi.c index a77996513b..2181b4fa2f 100644 --- a/arch/arm/src/lpc43xx/lpc43_spi.c +++ b/arch/arm/src/lpc43xx/lpc43_spi.c @@ -505,7 +505,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the SPI port * - * Input Parameter: + * Input Parameters: * port Port number (must be zero) * * Returned Value: @@ -564,7 +564,7 @@ static FAR struct spi_dev_s *lpc43_spiport_initialize(int port) * 1 - SSP0 * 2 - SSP1 * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_spi.h b/arch/arm/src/lpc43xx/lpc43_spi.h index d0414f9af6..b642f9c490 100644 --- a/arch/arm/src/lpc43xx/lpc43_spi.h +++ b/arch/arm/src/lpc43xx/lpc43_spi.h @@ -98,7 +98,7 @@ extern "C" * 1 - SSP0 * 2 - SSP1 * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_spifi.c b/arch/arm/src/lpc43xx/lpc43_spifi.c index 57349370c0..ed2f01f2c9 100644 --- a/arch/arm/src/lpc43xx/lpc43_spifi.c +++ b/arch/arm/src/lpc43xx/lpc43_spifi.c @@ -1132,7 +1132,7 @@ static inline int lpc43_rominit(FAR struct lpc43_dev_s *priv) * Input Parameters: * None * - * Returned value: + * Returned Value: * One success, a reference to the initialized MTD device instance is * returned; NULL is returned on any failure. * @@ -1220,7 +1220,7 @@ FAR struct mtd_dev_s *lpc43_spifi_initialize(void) * Input Parameters: * high * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_spifi.h b/arch/arm/src/lpc43xx/lpc43_spifi.h index 4445919259..30f85b8328 100644 --- a/arch/arm/src/lpc43xx/lpc43_spifi.h +++ b/arch/arm/src/lpc43xx/lpc43_spifi.h @@ -118,7 +118,7 @@ extern "C" * Input Parameters: * None * - * Returned value: + * Returned Value: * One success, a reference to the initialized MTD device instance is * returned; NULL is returned on any failure. * diff --git a/arch/arm/src/lpc43xx/lpc43_ssp.c b/arch/arm/src/lpc43xx/lpc43_ssp.c index 2660b00654..a9816b9366 100644 --- a/arch/arm/src/lpc43xx/lpc43_ssp.c +++ b/arch/arm/src/lpc43xx/lpc43_ssp.c @@ -664,7 +664,7 @@ static void ssp_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * Description: * Initialize the SSP0 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -717,7 +717,7 @@ static inline FAR struct lpc43_sspdev_s *lpc43_ssp0initialize(void) * Description: * Initialize the SSP1 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -777,7 +777,7 @@ static inline FAR struct lpc43_sspdev_s *lpc43_ssp1initialize(void) * Description: * Initialize the selected SSP port (0=SSP0, 1=SSP1) * - * Input Parameter: + * Input Parameters: * port - Port number (0=SSP0, 1=SSP1) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_ssp.h b/arch/arm/src/lpc43xx/lpc43_ssp.h index 5bf708859e..27be5a5130 100644 --- a/arch/arm/src/lpc43xx/lpc43_ssp.h +++ b/arch/arm/src/lpc43xx/lpc43_ssp.h @@ -95,7 +95,7 @@ extern "C" * Description: * Initialize the selected SSP port (0=SSP0, 1=SSP1) * - * Input Parameter: + * Input Parameters: * port - Port number (0=SSP0, 1=SSP1) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_timer.c b/arch/arm/src/lpc43xx/lpc43_timer.c index decc110dd4..7c68ffd449 100644 --- a/arch/arm/src/lpc43xx/lpc43_timer.c +++ b/arch/arm/src/lpc43xx/lpc43_timer.c @@ -331,7 +331,7 @@ void tmr_clk_disable(uint16_t tmrid) * Input Parameters: * Usual interrupt callback arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -401,7 +401,7 @@ static int lpc43_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -465,7 +465,7 @@ static int lpc43_start(FAR struct timer_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -509,7 +509,7 @@ static int lpc43_stop(FAR struct timer_lowerhalf_s *lower) * half" driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -564,7 +564,7 @@ static int lpc43_getstatus(FAR struct timer_lowerhalf_s *lower, * half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -627,7 +627,7 @@ static int lpc43_settimeout(FAR struct timer_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -667,7 +667,7 @@ static void lpc43_setcallback(FAR struct timer_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -700,7 +700,7 @@ static int lpc43_ioctl(FAR struct timer_lowerhalf_s *lower, int cmd, * devpath - The full path to the timer. This should be of the form * /dev/tmr0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_timer.h b/arch/arm/src/lpc43xx/lpc43_timer.h index 194d917c31..7eed9b2dcd 100644 --- a/arch/arm/src/lpc43xx/lpc43_timer.h +++ b/arch/arm/src/lpc43xx/lpc43_timer.h @@ -80,7 +80,7 @@ extern "C" * devpath - The full path to the timer. This should be of the form * /dev/timer0 * irq - irq associated with the timer - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_wdt.h b/arch/arm/src/lpc43xx/lpc43_wdt.h index af427504e4..c1d88a01e6 100644 --- a/arch/arm/src/lpc43xx/lpc43_wdt.h +++ b/arch/arm/src/lpc43xx/lpc43_wdt.h @@ -78,7 +78,7 @@ extern "C" * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_wwdt.c b/arch/arm/src/lpc43xx/lpc43_wwdt.c index 872e8d5f3f..fb60102d42 100644 --- a/arch/arm/src/lpc43xx/lpc43_wwdt.c +++ b/arch/arm/src/lpc43xx/lpc43_wwdt.c @@ -206,7 +206,7 @@ static void lpc43_setwarning(uint32_t warning) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -254,7 +254,7 @@ static int lpc43_interrupt(int irq, FAR void *context) * lower - A pointer the publicly visible representation of the * "lower-half" driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -295,7 +295,7 @@ static int lpc43_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -329,7 +329,7 @@ static int lpc43_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -361,7 +361,7 @@ static int lpc43_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -419,7 +419,7 @@ static int lpc43_getstatus(FAR struct watchdog_lowerhalf_s *lower, * "lower-half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -494,7 +494,7 @@ static int lpc43_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -563,7 +563,7 @@ static xcpt_t lpc43_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -620,7 +620,7 @@ static int lpc43_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_i2c_master.h b/arch/arm/src/lpc54xx/lpc54_i2c_master.h index 1655d0fec5..fc9e80f662 100644 --- a/arch/arm/src/lpc54xx/lpc54_i2c_master.h +++ b/arch/arm/src/lpc54xx/lpc54_i2c_master.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *lpc54_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc54_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc54xx/lpc54_lcd.c b/arch/arm/src/lpc54xx/lpc54_lcd.c index 25cb80fc33..2b8b5aa262 100644 --- a/arch/arm/src/lpc54xx/lpc54_lcd.c +++ b/arch/arm/src/lpc54xx/lpc54_lcd.c @@ -441,7 +441,7 @@ static int lpc54_setcursor(FAR struct fb_vtable_s *vtable, * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -802,7 +802,7 @@ int up_fbinitialize(int display) * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/arch/arm/src/lpc54xx/lpc54_sdmmc.c b/arch/arm/src/lpc54xx/lpc54_sdmmc.c index 626db2654f..292732040d 100644 --- a/arch/arm/src/lpc54xx/lpc54_sdmmc.c +++ b/arch/arm/src/lpc54xx/lpc54_sdmmc.c @@ -2709,7 +2709,7 @@ static void lpc54_callback(struct lpc54_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SD card interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_sdmmc.h b/arch/arm/src/lpc54xx/lpc54_sdmmc.h index 7eb00403c5..a56fe2095b 100644 --- a/arch/arm/src/lpc54xx/lpc54_sdmmc.h +++ b/arch/arm/src/lpc54xx/lpc54_sdmmc.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_serial.c b/arch/arm/src/lpc54xx/lpc54_serial.c index 7c74dec93b..996affee4c 100644 --- a/arch/arm/src/lpc54xx/lpc54_serial.c +++ b/arch/arm/src/lpc54xx/lpc54_serial.c @@ -1421,7 +1421,7 @@ void lpc54_earlyserialinit(void) * Input Parameters: * None * - * Returns Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_spi_master.c b/arch/arm/src/lpc54xx/lpc54_spi_master.c index 35dd60ed8f..443bcb3333 100644 --- a/arch/arm/src/lpc54xx/lpc54_spi_master.c +++ b/arch/arm/src/lpc54xx/lpc54_spi_master.c @@ -1665,7 +1665,7 @@ static void lpc54_spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * ... * 9 - SSP9 * - * Input Parameter: + * Input Parameters: * port - SPI peripheral number. 0..9 * * Returned Value: diff --git a/arch/arm/src/lpc54xx/lpc54_spi_master.h b/arch/arm/src/lpc54xx/lpc54_spi_master.h index aba9a30e72..9205dd66f4 100644 --- a/arch/arm/src/lpc54xx/lpc54_spi_master.h +++ b/arch/arm/src/lpc54xx/lpc54_spi_master.h @@ -98,7 +98,7 @@ extern "C" * ... * 9 - SPI9 * - * Input Parameter: + * Input Parameters: * port - SPI peripheral number, 0.. 9. * * Returned Value: diff --git a/arch/arm/src/lpc54xx/lpc54_wwdt.c b/arch/arm/src/lpc54xx/lpc54_wwdt.c index a664d2ba99..c442ee318e 100644 --- a/arch/arm/src/lpc54xx/lpc54_wwdt.c +++ b/arch/arm/src/lpc54xx/lpc54_wwdt.c @@ -207,7 +207,7 @@ static void lpc54_setwarning(uint32_t warning) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -255,7 +255,7 @@ static int lpc54_wwdt_interrupt(int irq, FAR void *context) * lower - A pointer the publicly visible representation of the * "lower-half" driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -296,7 +296,7 @@ static int lpc54_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -330,7 +330,7 @@ static int lpc54_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -362,7 +362,7 @@ static int lpc54_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -420,7 +420,7 @@ static int lpc54_getstatus(FAR struct watchdog_lowerhalf_s *lower, * "lower-half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -495,7 +495,7 @@ static int lpc54_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -564,7 +564,7 @@ static xcpt_t lpc54_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -621,7 +621,7 @@ static int lpc54_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_wwdt.h b/arch/arm/src/lpc54xx/lpc54_wwdt.h index db0822a48e..baffd8c167 100644 --- a/arch/arm/src/lpc54xx/lpc54_wwdt.h +++ b/arch/arm/src/lpc54xx/lpc54_wwdt.h @@ -78,7 +78,7 @@ extern "C" * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/nuc1xx/nuc_gpio.c b/arch/arm/src/nuc1xx/nuc_gpio.c index 0e2b11d54c..e5c86c2934 100644 --- a/arch/arm/src/nuc1xx/nuc_gpio.c +++ b/arch/arm/src/nuc1xx/nuc_gpio.c @@ -74,7 +74,7 @@ * function, it must be unconfigured with nuc_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * diff --git a/arch/arm/src/nuc1xx/nuc_gpio.h b/arch/arm/src/nuc1xx/nuc_gpio.h index 1fca1dc0e5..9d08dbac1a 100644 --- a/arch/arm/src/nuc1xx/nuc_gpio.h +++ b/arch/arm/src/nuc1xx/nuc_gpio.h @@ -208,7 +208,7 @@ extern "C" * function, it must be unconfigured with nuc_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * diff --git a/arch/arm/src/sam34/sam4cm_cpuidlestack.c b/arch/arm/src/sam34/sam4cm_cpuidlestack.c index 411ebfaad7..1f3dd7fad8 100644 --- a/arch/arm/src/sam34/sam4cm_cpuidlestack.c +++ b/arch/arm/src/sam34/sam4cm_cpuidlestack.c @@ -115,7 +115,7 @@ void up_idle(void) * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - cpu: CPU index that indicates which CPU the IDLE task is * being created for. * - tcb: The TCB of new CPU IDLE task diff --git a/arch/arm/src/sam34/sam_hsmci.c b/arch/arm/src/sam34/sam_hsmci.c index 25006b7f19..0a1f1c2d32 100644 --- a/arch/arm/src/sam34/sam_hsmci.c +++ b/arch/arm/src/sam34/sam_hsmci.c @@ -2670,7 +2670,7 @@ static void sam_callback(void *arg) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -2745,7 +2745,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -2792,7 +2792,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_hsmci.h b/arch/arm/src/sam34/sam_hsmci.h index 3339c2d295..78dc02069c 100644 --- a/arch/arm/src/sam34/sam_hsmci.h +++ b/arch/arm/src/sam34/sam_hsmci.h @@ -87,7 +87,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -109,7 +109,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -127,7 +127,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_rtt.c b/arch/arm/src/sam34/sam_rtt.c index 7978b01bf3..1b945e42e8 100644 --- a/arch/arm/src/sam34/sam_rtt.c +++ b/arch/arm/src/sam34/sam_rtt.c @@ -270,7 +270,7 @@ static void sam34_putreg(uint32_t val, uint32_t addr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -354,7 +354,7 @@ static int sam34_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -417,7 +417,7 @@ static int sam34_start(FAR struct timer_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -456,7 +456,7 @@ static int sam34_stop(FAR struct timer_lowerhalf_s *lower) * driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -507,7 +507,7 @@ static int sam34_getstatus(FAR struct timer_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -559,7 +559,7 @@ static int sam34_settimeout(FAR struct timer_lowerhalf_s *lower, * behavior is restored, * arg - Argument that will be provided in the callback * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -599,7 +599,7 @@ static void sam34_setcallback(FAR struct timer_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -632,7 +632,7 @@ static int sam34_ioctl(FAR struct timer_lowerhalf_s *lower, int cmd, * devpath - The full path to the timer. This should be of the form * /dev/rtt0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_rtt.h b/arch/arm/src/sam34/sam_rtt.h index f300747efb..3a00c17fbd 100644 --- a/arch/arm/src/sam34/sam_rtt.h +++ b/arch/arm/src/sam34/sam_rtt.h @@ -80,7 +80,7 @@ extern "C" * devpath - The full path to the timer. This should be of the form * /dev/rtt0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_spi.c b/arch/arm/src/sam34/sam_spi.c index 79bc6ca9ea..212293b26d 100644 --- a/arch/arm/src/sam34/sam_spi.c +++ b/arch/arm/src/sam34/sam_spi.c @@ -1711,7 +1711,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *buffer, size_t nwords) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: diff --git a/arch/arm/src/sam34/sam_spi.h b/arch/arm/src/sam34/sam_spi.h index 8cebb2f121..b9cbcce76d 100644 --- a/arch/arm/src/sam34/sam_spi.h +++ b/arch/arm/src/sam34/sam_spi.h @@ -117,7 +117,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: @@ -182,7 +182,7 @@ struct spi_dev_s *sam_spibus_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -204,7 +204,7 @@ void sam_spi1select(uint32_t devid, bool selected); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -235,7 +235,7 @@ uint8_t sam_spi1status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_tc.c b/arch/arm/src/sam34/sam_tc.c index 1faab8b159..3212174623 100644 --- a/arch/arm/src/sam34/sam_tc.c +++ b/arch/arm/src/sam34/sam_tc.c @@ -250,7 +250,7 @@ static void sam34_putreg(uint32_t val, uint32_t addr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -309,7 +309,7 @@ static int sam34_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -365,7 +365,7 @@ static int sam34_start(FAR struct timer_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -401,7 +401,7 @@ static int sam34_stop(FAR struct timer_lowerhalf_s *lower) * driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -454,7 +454,7 @@ static int sam34_getstatus(FAR struct timer_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -507,7 +507,7 @@ static int sam34_settimeout(FAR struct timer_lowerhalf_s *lower, * behavior is restored, * arg - Argument to be provided with the callback. * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -547,7 +547,7 @@ static void sam34_setcallback(FAR struct timer_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -580,7 +580,7 @@ static int sam34_ioctl(FAR struct timer_lowerhalf_s *lower, int cmd, * devpath - The full path to the timer. This should be of the form * /dev/tc0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_tc.h b/arch/arm/src/sam34/sam_tc.h index df7b3caf29..3667213d75 100644 --- a/arch/arm/src/sam34/sam_tc.h +++ b/arch/arm/src/sam34/sam_tc.h @@ -79,7 +79,7 @@ extern "C" * devpath - The full path to the timer. This should be of the form * /dev/tc0 * irq - irq associated with the timer - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_twi.h b/arch/arm/src/sam34/sam_twi.h index 87c31b3032..06868044b2 100644 --- a/arch/arm/src/sam34/sam_twi.h +++ b/arch/arm/src/sam34/sam_twi.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *sam_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the sam_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/sam34/sam_wdt.c b/arch/arm/src/sam34/sam_wdt.c index cf88b37fec..4e902f46b5 100644 --- a/arch/arm/src/sam34/sam_wdt.c +++ b/arch/arm/src/sam34/sam_wdt.c @@ -251,7 +251,7 @@ static void sam34_putreg(uint32_t val, uint32_t addr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -294,7 +294,7 @@ static int sam34_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -338,7 +338,7 @@ static int sam34_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -369,7 +369,7 @@ static int sam34_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -393,7 +393,7 @@ static int sam34_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -449,7 +449,7 @@ static int sam34_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in millisecnds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -516,7 +516,7 @@ static int sam34_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -589,7 +589,7 @@ static xcpt_t sam34_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -649,7 +649,7 @@ static int sam34_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_wdt.h b/arch/arm/src/sam34/sam_wdt.h index 77a1fbab40..3330cc01e7 100644 --- a/arch/arm/src/sam34/sam_wdt.h +++ b/arch/arm/src/sam34/sam_wdt.h @@ -79,7 +79,7 @@ extern "C" * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_adc.c b/arch/arm/src/sama5/sam_adc.c index c61f44a3df..d6975391a4 100644 --- a/arch/arm/src/sama5/sam_adc.c +++ b/arch/arm/src/sama5/sam_adc.c @@ -591,7 +591,7 @@ static bool sam_adc_checkreg(struct sam_adc_s *priv, bool wr, * thread sets ready when it has completed processing the last sample * data. * - * Input Parameters + * Input Parameters: * arg - The ADC private data structure cast to (void *) * * Returned Value: @@ -838,7 +838,7 @@ static int sam_adc_dmasetup(FAR struct sam_adc_s *priv, FAR uint8_t *buffer, * sam_adc_endconversion will re-enable EOC interrupts when it completes * processing all pending EOC events. * - * Input Parameters + * Input Parameters: * arg - The ADC private data structure cast to (void *) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_can.c b/arch/arm/src/sama5/sam_can.c index 956ae680e8..960c2e5346 100644 --- a/arch/arm/src/sama5/sam_can.c +++ b/arch/arm/src/sama5/sam_can.c @@ -579,7 +579,7 @@ static void can_semtake(FAR struct sam_can_s *priv) * Description: * Allocate one mailbox * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * * Returned Value: @@ -626,7 +626,7 @@ static int can_mballoc(FAR struct sam_can_s *priv) * Description: * Free one mailbox * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * mbndx - Index of the mailbox to be freed * @@ -670,7 +670,7 @@ static void can_mbfree(FAR struct sam_can_s *priv, int mbndx) * Description: * Configure and enable mailbox(es) for reception * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * * Returned Value: @@ -1592,7 +1592,7 @@ static void can_interrupt(int irq, void *context, FAR void *arg) * Tphs1 = Tq * (PHASE1 + 1) * Tphs2 = Tq * (PHASE2 + 1) * - * Input Parameter: + * Input Parameters: * config - A reference to the CAN constant configuration * * Returned Value: @@ -1706,7 +1706,7 @@ static int can_bittiming(struct sam_can_s *priv) * Description: * Use the SAMA5 auto-baud feature to correct the initial timing * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1776,7 +1776,7 @@ static int can_autobaud(struct sam_can_s *priv) * Description: * CAN cell initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * * Returned Value: @@ -1889,7 +1889,7 @@ static int can_hwinitialize(struct sam_can_s *priv) * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_can.h b/arch/arm/src/sama5/sam_can.h index 83a08f756b..bff7c1efbf 100644 --- a/arch/arm/src/sama5/sam_can.h +++ b/arch/arm/src/sama5/sam_can.h @@ -125,7 +125,7 @@ extern "C" * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number: 0=CAN0, 1=CAN1 * * Returned Value: diff --git a/arch/arm/src/sama5/sam_ehci.c b/arch/arm/src/sama5/sam_ehci.c index 9b25316272..bd87be9f93 100644 --- a/arch/arm/src/sama5/sam_ehci.c +++ b/arch/arm/src/sama5/sam_ehci.c @@ -1903,7 +1903,7 @@ static struct sam_qtd_s *sam_qtd_statusphase(uint32_t tokenbits) * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2183,7 +2183,7 @@ errout_with_qh: * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2290,7 +2290,7 @@ errout_with_qh: * complete, but will be re-acquired when before returning. The state of * EHCI resources could be very different upon return. * - * Returned value: + * Returned Value: * On success, this function returns the number of bytes actually transferred. * For control transfers, this size includes the size of the control request * plus the size of the data (which could be short); For bulk transfers, this @@ -2370,7 +2370,7 @@ static ssize_t sam_transfer_wait(struct sam_epinfo_s *epinfo) * callback - The function to be called when the completes * arg - An arbitrary argument that will be provided with the callback. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -2423,7 +2423,7 @@ static inline int sam_ioc_async_setup(struct sam_rhport_s *rhport, * epinfo - The IN or OUT endpoint descriptor for the device endpoint on * which the transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3265,7 +3265,7 @@ static int sam_uhphs_interrupt(int irq, FAR void *context, FAR void *arg) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3367,7 +3367,7 @@ static int sam_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3659,7 +3659,7 @@ static int sam_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3703,7 +3703,7 @@ static int sam_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3786,7 +3786,7 @@ static int sam_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3831,7 +3831,7 @@ static int sam_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which * to return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3876,7 +3876,7 @@ static int sam_alloc(FAR struct usbhost_driver_s *drvr, * to the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3913,7 +3913,7 @@ static int sam_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3952,7 +3952,7 @@ static int sam_ioalloc(FAR struct usbhost_driver_s *drvr, FAR uint8_t **buffer, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3996,7 +3996,7 @@ static int sam_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4097,7 +4097,7 @@ static int sam_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4208,7 +4208,7 @@ errout_with_sem: * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4301,7 +4301,7 @@ errout_with_sem: * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4490,7 +4490,7 @@ errout_with_sem: * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4541,7 +4541,7 @@ static int sam_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/sama5/sam_hsmci.c b/arch/arm/src/sama5/sam_hsmci.c index e47248e2eb..3b8e48610e 100644 --- a/arch/arm/src/sama5/sam_hsmci.c +++ b/arch/arm/src/sama5/sam_hsmci.c @@ -3160,7 +3160,7 @@ static void sam_callback(void *arg) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3353,7 +3353,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3406,7 +3406,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is write protected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_hsmci.h b/arch/arm/src/sama5/sam_hsmci.h index c28bf89594..a3257e7d58 100644 --- a/arch/arm/src/sama5/sam_hsmci.h +++ b/arch/arm/src/sama5/sam_hsmci.h @@ -87,7 +87,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -118,7 +118,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: @@ -143,7 +143,7 @@ uint32_t sam_hsmci_clkdiv(uint32_t target); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -161,7 +161,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_hsmci_clkdiv.c b/arch/arm/src/sama5/sam_hsmci_clkdiv.c index 4ddba13e82..4a56bed140 100644 --- a/arch/arm/src/sama5/sam_hsmci_clkdiv.c +++ b/arch/arm/src/sama5/sam_hsmci_clkdiv.c @@ -97,7 +97,7 @@ * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: diff --git a/arch/arm/src/sama5/sam_irq.c b/arch/arm/src/sama5/sam_irq.c index fd4dfd8c5c..fbdc1eda5c 100644 --- a/arch/arm/src/sama5/sam_irq.c +++ b/arch/arm/src/sama5/sam_irq.c @@ -261,7 +261,7 @@ static uint32_t *sam_fiqhandler(int irq, uint32_t *regs) * Description: * Return true if the peripheral secure. * - * Input Parameter: + * Input Parameters: * PID = IRQ number * ****************************************************************************/ @@ -576,7 +576,7 @@ void up_irqinitialize(void) * the irq number of the interrupt and then to call arm_doirq to dispatch * the interrupt. * - * Input parameters: + * Input Parameters: * regs - A pointer to the register save area on the stack. * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_lcd.c b/arch/arm/src/sama5/sam_lcd.c index 4e27e1ef2a..67f1ac0628 100644 --- a/arch/arm/src/sama5/sam_lcd.c +++ b/arch/arm/src/sama5/sam_lcd.c @@ -2901,7 +2901,7 @@ static void sam_show_hcr(void) * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -3001,7 +3001,7 @@ int up_fbinitialize(int display) * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/arch/arm/src/sama5/sam_nand.c b/arch/arm/src/sama5/sam_nand.c index ae0c22936d..a0fb369ce1 100644 --- a/arch/arm/src/sama5/sam_nand.c +++ b/arch/arm/src/sama5/sam_nand.c @@ -353,10 +353,10 @@ void nand_unlock(void) * Waiting for the completion of a page program, erase and random read * completion. * - * Input parameters: + * Input Parameters: * priv Pointer to a sam_nandcs_s instance. * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -376,13 +376,13 @@ static void nand_wait_ready(struct sam_nandcs_s *priv) * Description: * Use the HOST NAND FLASH controller to send a command to the NFC. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * cmd - command to send * acycle - address cycle when command access id decoded * cycle0 - address at first cycle * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -414,10 +414,10 @@ static void nand_nfc_cmdsend(struct sam_nandcs_s *priv, uint32_t cmd, * Description: * Check if a program or erase operation completed successfully * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * - * Returned value. + * Returned Value: * OK on success, a negated errnor value on failure * ****************************************************************************/ @@ -451,7 +451,7 @@ static int nand_operation_complete(struct sam_nandcs_s *priv) * address cycles. The resulting values are stored in the provided * variables if they are not null. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * coladdr - Column address to translate. * rowaddr - Row address to translate. @@ -459,7 +459,7 @@ static int nand_operation_complete(struct sam_nandcs_s *priv) * acycle1234 - Four address cycles. * rowonly - True:Only ROW address is used. * - * Returned value. + * Returned Value: * Number of address cycles converted. * ****************************************************************************/ @@ -565,10 +565,10 @@ static int nand_translate_address(struct sam_nandcs_s *priv, * Description: * Map the number of address cycles the bit setting for the NFC command * - * Input parameters: + * Input Parameters: * ncycles - Number of address cycles * - * Returned value. + * Returned Value: * NFC command value * ****************************************************************************/ @@ -602,7 +602,7 @@ static uint32_t nand_get_acycle(int ncycles) * Description: * Sends NAND CLE/ALE command. * - * Input parameters: + * Input Parameters: * priv - Pointer to a sam_nandcs_s instance. * mode - SMC ALE CLE mode parameter. * cmd1 - First command to be sent. @@ -610,7 +610,7 @@ static uint32_t nand_get_acycle(int ncycles) * coladdr - Column address. * rowaddr - Row address. * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -670,10 +670,10 @@ static void nand_nfc_cleale(struct sam_nandcs_s *priv, uint8_t mode, * Description: * Wait for NFC command done * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -716,10 +716,10 @@ static void nand_wait_cmddone(struct sam_nandcs_s *priv) * Description: * Setup to wait for CMDDONE event * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -758,10 +758,10 @@ static void nand_setup_cmddone(struct sam_nandcs_s *priv) * Description: * Wait for a transfer to complete * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -804,10 +804,10 @@ static void nand_wait_xfrdone(struct sam_nandcs_s *priv) * Description: * Setup to wait for XFDONE event * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -846,10 +846,10 @@ static void nand_setup_xfrdone(struct sam_nandcs_s *priv) * Description: * Wait for read/busy edge detection * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -892,10 +892,10 @@ static void nand_wait_rbedge(struct sam_nandcs_s *priv) * Description: * Setup to wait for RBEDGE0 event * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -934,10 +934,10 @@ static void nand_setup_rbedge(struct sam_nandcs_s *priv) * Description: * Wait for NFC not busy * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -965,10 +965,10 @@ static void nand_wait_nfcbusy(struct sam_nandcs_s *priv) * This latching capability function is needed to prevent loss of pending * status when sampling the HSMC_SR register. * - * Input parameters: + * Input Parameters: * None * - * Returned value. + * Returned Value: * Current HSMC_SR register value; * ****************************************************************************/ @@ -1041,10 +1041,10 @@ static uint32_t nand_nfc_poll(void) * Description: * HSMC interrupt handler * - * Input parameters: + * Input Parameters: * Standard interrupt arguments * - * Returned value. + * Returned Value: * Always returns OK * ****************************************************************************/ @@ -1203,10 +1203,10 @@ static void nand_dma_sampledone(struct sam_nandcs_s *priv, int result) * Description: * Wait for the completion of a DMA transfer * - * Input parameters: + * Input Parameters: * Wait for read/busy edge detection * - * Returned value. + * Returned Value: * The result of the DMA. OK on success; a negated ernno value on failure. * ****************************************************************************/ @@ -1266,7 +1266,7 @@ static void nand_dmacallback(DMA_HANDLE handle, void *arg, int result) * nbytes - The number of bytes to transfer * dmaflags - Describes the DMA configuration * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1355,7 +1355,7 @@ static int nand_dma_read(struct sam_nandcs_s *priv, * nbytes - The number of bytes to transfer * dmaflags - Describes the DMA configuration * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1440,7 +1440,7 @@ static int nand_dma_write(struct sam_nandcs_s *priv, * offset - If reading from NFC SRAM, this is the offset into * the SRAM. * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1506,7 +1506,7 @@ static int nand_nfcsram_read(struct sam_nandcs_s *priv, uint8_t *buffer, * nfcsram - True: Use NFC Host SRAM * buffer - Buffer that provides the data for the write * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1590,13 +1590,13 @@ static int nand_read(struct sam_nandcs_s *priv, uint8_t *buffer, * Description: * Reads the data area of a page of a NAND FLASH into the provided buffer. * - * Input parameters: + * Input Parameters: * priv - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -1743,7 +1743,7 @@ static int nand_read_pmecc(struct sam_nandcs_s *priv, off_t block, * buffer - Buffer that provides the data for the write * offset - Data offset in bytes * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1806,7 +1806,7 @@ static int nand_nfcsram_write(struct sam_nandcs_s *priv, uint8_t *buffer, * buffer - Buffer that provides the data for the write * offset - Data offset in bytes * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1891,14 +1891,14 @@ static int nand_write(struct sam_nandcs_s *priv, uint8_t *buffer, * provided buffers. The raw NAND contents are returned with no ECC * corrections. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2007,13 +2007,13 @@ static int nand_readpage_noecc(struct sam_nandcs_s *priv, off_t block, * Reads the data and/or the spare areas of a page of a NAND FLASH into the * provided buffers. PMECC is used * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2127,14 +2127,14 @@ errout: * Writes the data and/or the spare area of a page on a NAND FLASH chip. * No ECC calculations are performed. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer conatining the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2281,13 +2281,13 @@ static int nand_writepage_noecc(struct sam_nandcs_s *priv, off_t block, * performed. The redundancy is appended to the page and written in the * spare area. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2495,11 +2495,11 @@ errout: * Description: * Erases the specified block of the device. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the physical block to erase. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2575,14 +2575,14 @@ static int nand_eraseblock(struct nand_raw_s *raw, off_t block) * Reads the data and/or the spare areas of a page of a NAND FLASH into the * provided buffers. This is a raw read of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2612,14 +2612,14 @@ static int nand_rawread(struct nand_raw_s *raw, off_t block, * Writes the data and/or the spare area of a page on a NAND FLASH chip. * This is a raw write of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2651,14 +2651,14 @@ static int nand_rawwrite(struct nand_raw_s *raw, off_t block, * provided buffers. Hardware ECC checking will be performed if so * configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2713,14 +2713,14 @@ static int nand_readpage(struct nand_raw_s *raw, off_t block, * Writes the data and/or the spare area of a page on a NAND FLASH chip. * Hardware ECC checking will be performed if so configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer conatining the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2775,10 +2775,10 @@ static int nand_writepage(struct nand_raw_s *raw, off_t block, * Description: * Resets a NAND FLASH device * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -2803,11 +2803,11 @@ static void nand_reset(struct sam_nandcs_s *priv) * performed here. Those necessary NAND features are provided by common, * higher level NAND MTD layers found in drivers/mtd. * - * Input parameters: + * Input Parameters: * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned value. + * Returned Value: * On success a non-NULL pointer to an MTD device structure is returned; * NULL is returned on a failure. * diff --git a/arch/arm/src/sama5/sam_nand.h b/arch/arm/src/sama5/sam_nand.h index 808b719aa5..69c6b729e9 100644 --- a/arch/arm/src/sama5/sam_nand.h +++ b/arch/arm/src/sama5/sam_nand.h @@ -397,11 +397,11 @@ EXTERN struct sam_nand_s g_nand; * performed here. Those necessary NAND features are provided by common, * higher level NAND MTD layers found in drivers/mtd. * - * Input parameters: + * Input Parameters: * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned value. + * Returned Value: * On success a non-NULL pointer to an MTD device structure is returned; * NULL is returned on a failure. * @@ -428,7 +428,7 @@ struct mtd_dev_s *sam_nand_initialize(int cs); * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested @@ -449,7 +449,7 @@ int board_nandflash_config(int cs); * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * True: NAND is busy, False: NAND is ready * ****************************************************************************/ @@ -470,7 +470,7 @@ bool board_nand_busy(int cs); * are connected on-board). * enable - True: enable Chip Select, False: Disable Chip select * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/arch/arm/src/sama5/sam_ohci.c b/arch/arm/src/sama5/sam_ohci.c index 7b87c382c6..fac941d686 100644 --- a/arch/arm/src/sama5/sam_ohci.c +++ b/arch/arm/src/sama5/sam_ohci.c @@ -1543,7 +1543,7 @@ static int sam_enqueuetd(struct sam_rhport_s *rhport, struct sam_eplist_s *eplis * Input Parameters: * rhpndx - Root hub port index. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1629,7 +1629,7 @@ static int sam_ep0enqueue(struct sam_rhport_s *rhport) * ep0 - The control endpoint to be released. May be the control endpoint for * an attached hub. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -2319,7 +2319,7 @@ static void sam_ohci_bottomhalf(void *arg) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -2437,7 +2437,7 @@ static int sam_wait(struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2564,7 +2564,7 @@ static int sam_enumerate(struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2627,7 +2627,7 @@ static int sam_ep0configure(struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2832,7 +2832,7 @@ errout: * the class create() method. * ep - The endpoint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2924,7 +2924,7 @@ static int sam_epfree(struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2969,7 +2969,7 @@ static int sam_alloc(struct usbhost_driver_s *drvr, * to the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3008,7 +3008,7 @@ static int sam_free(struct usbhost_driver_s *drvr, uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3042,7 +3042,7 @@ static int sam_ioalloc(struct usbhost_driver_s *drvr, uint8_t **buffer, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3087,7 +3087,7 @@ static int sam_iofree(struct usbhost_driver_s *drvr, uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3206,7 +3206,7 @@ static int sam_ctrlout(struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -3296,7 +3296,7 @@ static int sam_transfer_common(struct sam_rhport_s *rhport, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure: * @@ -3445,7 +3445,7 @@ errout: * eplist - The internal representation of the device endpoint on which * to perform the transfer. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3555,7 +3555,7 @@ static void sam_asynch_completion(struct sam_eplist_s *eplist) * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3635,7 +3635,7 @@ errout: * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -3780,7 +3780,7 @@ static int sam_cancel(struct usbhost_driver_s *drvr, usbhost_ep_t ep) * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -3831,7 +3831,7 @@ static int sam_connect(struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/sama5/sam_pwm.c b/arch/arm/src/sama5/sam_pwm.c index 90b204eac3..1758bee1a7 100644 --- a/arch/arm/src/sama5/sam_pwm.c +++ b/arch/arm/src/sama5/sam_pwm.c @@ -754,7 +754,7 @@ static void pwm_chan_putreg(struct sam_pwm_chan_s *chan, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * chan - A reference to the PWM channel instance * * Returned Value: @@ -827,7 +827,7 @@ static void pwm_dumpregs(struct sam_pwm_chan_s *chan, FAR const char *msg) * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * Standard interrupt handler inputs * * Returned Value: @@ -854,7 +854,7 @@ static int pwm_interrupt(int irq, void *context, FAR void *arg) * use. It will not, however, output pulses until the start method is * called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -897,7 +897,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -927,7 +927,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -1049,7 +1049,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -1086,7 +1086,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command @@ -1145,7 +1145,7 @@ static int pwm_ioctl(FAR struct pwm_lowerhalf_s *dev, int cmd, unsigned long arg * regbits = PWM_CLK_PREB_DIV(prelog2); * prescaler = (1 << prelog2) * - * Input parameters: + * Input Parameters: * mck - The main clock frequency * fclk - The desired clock A or B frequency * @@ -1193,7 +1193,7 @@ static unsigned int pwm_clk_prescaler_log2(uint32_t mck, uint32_t fclk) * * div = MCK / prescaler / frequency * - * Input parameters: + * Input Parameters: * mck - The main clock frequency * fclk - The desired clock A or B frequency * prelog2 - The log2(prescaler) value previously selected by @@ -1231,7 +1231,7 @@ static unsigned int pwm_clk_divider(uint32_t mck, uint32_t fclk, * * frequency = MCK / prescaler / div * - * Input parameters: + * Input Parameters: * mck - The main clock frequency * prelog2 - The log2(prescaler) value previously selected by * pwm_prescale_log2(). @@ -1255,7 +1255,7 @@ static uint32_t pwm_clk_frequency(uint32_t mck, unsigned int prelog2, * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * chan - A reference to the PWM channel instance * * Returned Value: diff --git a/arch/arm/src/sama5/sam_spi.c b/arch/arm/src/sama5/sam_spi.c index 457aa04f19..eaf5882020 100644 --- a/arch/arm/src/sama5/sam_spi.c +++ b/arch/arm/src/sama5/sam_spi.c @@ -1638,7 +1638,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *buffer, size_t nwords) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_spi.h b/arch/arm/src/sama5/sam_spi.h index 705f2248e7..4a8697f25a 100644 --- a/arch/arm/src/sama5/sam_spi.h +++ b/arch/arm/src/sama5/sam_spi.h @@ -111,7 +111,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: @@ -175,7 +175,7 @@ struct spi_dev_s *sam_spibus_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -197,7 +197,7 @@ void sam_spi1select(uint32_t devid, bool selected); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -228,7 +228,7 @@ uint8_t sam_spi1status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_ssc.c b/arch/arm/src/sama5/sam_ssc.c index 0c86991030..176b2235cc 100644 --- a/arch/arm/src/sama5/sam_ssc.c +++ b/arch/arm/src/sama5/sam_ssc.c @@ -2786,7 +2786,7 @@ static int ssc_tx_configure(struct sam_ssc_s *priv) * Setup the MCK/2 divider based on the currently selected data width and * the sample rate * - * Input Parameter: + * Input Parameters: * priv - I2C device structure (only the sample rate and data length is * needed at this point). * @@ -2843,7 +2843,7 @@ static uint32_t ssc_mck2divider(struct sam_ssc_s *priv) * Description: * Enable and configure clocking to the SSC * - * Input Parameter: + * Input Parameters: * priv - Partially initialized I2C device structure (only the PID is * needed at this point). * @@ -3394,7 +3394,7 @@ static void ssc1_configure(struct sam_ssc_s *priv) * Description: * Initialize the selected SSC port * - * Input Parameter: + * Input Parameters: * port - I2S "port" number (identifying the "logical" SSC port) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_ssc.h b/arch/arm/src/sama5/sam_ssc.h index b7ecafe5a4..7ae4dafe07 100644 --- a/arch/arm/src/sama5/sam_ssc.h +++ b/arch/arm/src/sama5/sam_ssc.h @@ -83,7 +83,7 @@ extern "C" * Description: * Initialize the selected I2S port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_tsd.c b/arch/arm/src/sama5/sam_tsd.c index 36fc9e6d00..875091a878 100644 --- a/arch/arm/src/sama5/sam_tsd.c +++ b/arch/arm/src/sama5/sam_tsd.c @@ -432,7 +432,7 @@ errout: * The ADC hardware can filter the touchscreen samples by averaging. The * function selects (or de-selects) that filtering. * - * Input Parameters + * Input Parameters: * priv - The touchscreen private data structure * tsav - The new (shifted) value of the TSAV field of the ADC TSMR regsiter. * @@ -494,7 +494,7 @@ static void sam_tsd_setaverage(struct sam_tsd_s *priv, uint32_t tsav) * will re-enable TSD interrupts when it completes processing all pending * TSD events. * - * Input Parameters + * Input Parameters: * arg - The touchscreen private data structure cast to (void *) * * Returned Value: @@ -1707,7 +1707,7 @@ errout_with_priv: * Description: * Handles ADC interrupts associated with touchscreen channels * - * Input parmeters: + * Input Parameters: * pending - Current set of pending interrupts being handled * * Returned Value: diff --git a/arch/arm/src/sama5/sam_tsd.h b/arch/arm/src/sama5/sam_tsd.h index 3ae36434b7..ff0d6a5ead 100644 --- a/arch/arm/src/sama5/sam_tsd.h +++ b/arch/arm/src/sama5/sam_tsd.h @@ -119,7 +119,7 @@ int sam_tsd_register(FAR struct sam_adc_s *adc, int minor); * Description: * Handles ADC interrupts associated with touchscreen channels * - * Input parmeters: + * Input Parameters: * pending - Current set of pending interrupts being handled * * Returned Value: diff --git a/arch/arm/src/sama5/sam_twi.h b/arch/arm/src/sama5/sam_twi.h index e8d75e1335..f966bec8f8 100644 --- a/arch/arm/src/sama5/sam_twi.h +++ b/arch/arm/src/sama5/sam_twi.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *sam_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the sam_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/sama5/sam_wdt.c b/arch/arm/src/sama5/sam_wdt.c index 9d3f7dd61e..0fd0fa21ee 100644 --- a/arch/arm/src/sama5/sam_wdt.c +++ b/arch/arm/src/sama5/sam_wdt.c @@ -254,7 +254,7 @@ static void sam_putreg(uint32_t regval, uintptr_t regaddr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -290,7 +290,7 @@ static int sam_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -320,7 +320,7 @@ static int sam_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -350,7 +350,7 @@ static int sam_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -378,7 +378,7 @@ static int sam_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * stawtus - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int sam_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in millisecnds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -554,7 +554,7 @@ static int sam_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -619,7 +619,7 @@ static xcpt_t sam_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -649,7 +649,7 @@ static int sam_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * Input Parameters: * None * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_wdt.h b/arch/arm/src/sama5/sam_wdt.h index 0f9eab7b75..ba3a067b1d 100644 --- a/arch/arm/src/sama5/sam_wdt.h +++ b/arch/arm/src/sama5/sam_wdt.h @@ -76,7 +76,7 @@ extern "C" * * At a minimum, this function should call watchdog_register(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/samdl/sam_port.h b/arch/arm/src/samdl/sam_port.h index c03edcbcb5..3227c54803 100644 --- a/arch/arm/src/samdl/sam_port.h +++ b/arch/arm/src/samdl/sam_port.h @@ -343,7 +343,7 @@ extern "C" * Description: * Configure a PORT pin based on bit-encoded description of the pin. * - * Returns: + * Returned Value: * OK (always) * ****************************************************************************/ diff --git a/arch/arm/src/samdl/sam_spi.c b/arch/arm/src/samdl/sam_spi.c index dbecb7e09b..9f398fd9e9 100644 --- a/arch/arm/src/samdl/sam_spi.c +++ b/arch/arm/src/samdl/sam_spi.c @@ -1322,7 +1322,7 @@ static void spi_pad_configure(struct sam_spidev_s *priv) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * port - SPI "port" number (i.e., SERCOM number) * * Returned Value: diff --git a/arch/arm/src/samdl/sam_spi.h b/arch/arm/src/samdl/sam_spi.h index 7e0cbfa9e0..d4044ab19c 100644 --- a/arch/arm/src/samdl/sam_spi.h +++ b/arch/arm/src/samdl/sam_spi.h @@ -94,7 +94,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * port - SPI "port" number (i.e., SERCOM number) * * Returned Value: @@ -161,7 +161,7 @@ struct spi_dev_s *sam_spibus_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -206,7 +206,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -254,7 +254,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_hsmci.c b/arch/arm/src/samv7/sam_hsmci.c index 4f5e0d87d9..213be4f878 100644 --- a/arch/arm/src/samv7/sam_hsmci.c +++ b/arch/arm/src/samv7/sam_hsmci.c @@ -3234,7 +3234,7 @@ static void sam_callback(void *arg) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3385,7 +3385,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3438,7 +3438,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is write protected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_hsmci.h b/arch/arm/src/samv7/sam_hsmci.h index fa5992082d..990ce462d5 100644 --- a/arch/arm/src/samv7/sam_hsmci.h +++ b/arch/arm/src/samv7/sam_hsmci.h @@ -85,7 +85,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -116,7 +116,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: @@ -141,7 +141,7 @@ uint32_t sam_hsmci_clkdiv(uint32_t target); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -159,7 +159,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_hsmci_clkdiv.c b/arch/arm/src/samv7/sam_hsmci_clkdiv.c index 83b85b6cb6..0da3872621 100644 --- a/arch/arm/src/samv7/sam_hsmci_clkdiv.c +++ b/arch/arm/src/samv7/sam_hsmci_clkdiv.c @@ -96,7 +96,7 @@ * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: diff --git a/arch/arm/src/samv7/sam_mcan.c b/arch/arm/src/samv7/sam_mcan.c index e72d089dc7..5be48501d1 100644 --- a/arch/arm/src/samv7/sam_mcan.c +++ b/arch/arm/src/samv7/sam_mcan.c @@ -1609,7 +1609,7 @@ static void mcan_buffer_release(FAR struct sam_mcan_s *priv) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * dlc - the DLC value to convert to a byte count * * Returned Value: @@ -1665,7 +1665,7 @@ static uint8_t mcan_dlc2bytes(FAR struct sam_mcan_s *priv, uint8_t dlc) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * nbytes - the byte count to convert to a DLC value * * Returned Value: @@ -3649,7 +3649,7 @@ static int mcan_interrupt(int irq, void *context, FAR void *arg) * Description: * MCAN hardware initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this MCAN peripheral * * Returned Value: @@ -3924,7 +3924,7 @@ static int mcan_hw_initialize(struct sam_mcan_s *priv) * Description: * Initialize the selected MCAN port * - * Input Parameter: + * Input Parameters: * port - Port number (for hardware that has multiple MCAN interfaces), * 0=MCAN0, 1=MCAN1 * diff --git a/arch/arm/src/samv7/sam_mcan.h b/arch/arm/src/samv7/sam_mcan.h index 3672547788..0c5dc6c726 100644 --- a/arch/arm/src/samv7/sam_mcan.h +++ b/arch/arm/src/samv7/sam_mcan.h @@ -88,7 +88,7 @@ extern "C" * Description: * Initialize the selected MCAN port * - * Input Parameter: + * Input Parameters: * port - Port number (for hardware that has multiple CAN interfaces), * 0=MCAN0, 1=NCAN1 * diff --git a/arch/arm/src/samv7/sam_qspi.c b/arch/arm/src/samv7/sam_qspi.c index 7e47c6caf9..6e39c7f8e3 100644 --- a/arch/arm/src/samv7/sam_qspi.c +++ b/arch/arm/src/samv7/sam_qspi.c @@ -1714,7 +1714,7 @@ static int qspi_hw_initialize(struct sam_qspidev_s *priv) * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_qspi.h b/arch/arm/src/samv7/sam_qspi.h index 85d2e57d65..9b64f0531c 100644 --- a/arch/arm/src/samv7/sam_qspi.h +++ b/arch/arm/src/samv7/sam_qspi.h @@ -87,7 +87,7 @@ extern "C" * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_rswdt.c b/arch/arm/src/samv7/sam_rswdt.c index 6d5add03a2..5651e612ee 100644 --- a/arch/arm/src/samv7/sam_rswdt.c +++ b/arch/arm/src/samv7/sam_rswdt.c @@ -254,7 +254,7 @@ static void sam_putreg(uint32_t regval, uintptr_t regaddr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -290,7 +290,7 @@ static int sam_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -320,7 +320,7 @@ static int sam_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -350,7 +350,7 @@ static int sam_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -378,7 +378,7 @@ static int sam_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * stawtus - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int sam_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in millisecnds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -554,7 +554,7 @@ static int sam_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -619,7 +619,7 @@ static xcpt_t sam_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -649,7 +649,7 @@ static int sam_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * Input Parameters: * None * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_spi.c b/arch/arm/src/samv7/sam_spi.c index 0ae37af28b..0f4a52c904 100644 --- a/arch/arm/src/samv7/sam_spi.c +++ b/arch/arm/src/samv7/sam_spi.c @@ -1985,7 +1985,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *buffer, size_t nwords) * Description: * Initialize the selected SPI port in master mode * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_spi.h b/arch/arm/src/samv7/sam_spi.h index 6e5a76e9ef..e7e715fd38 100644 --- a/arch/arm/src/samv7/sam_spi.h +++ b/arch/arm/src/samv7/sam_spi.h @@ -166,7 +166,7 @@ struct spi_sctrlr_s; /* Forward reference */ * Description: * Initialize the selected SPI port in master mode * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: @@ -182,7 +182,7 @@ FAR struct spi_dev_s *sam_spibus_initialize(int port); * Description: * Initialize the selected SPI port in slave mode. * - * Input Parameter: + * Input Parameters: * port - Chip select number identifying the "logical" SPI port. Includes * encoded port and chip select information. * @@ -248,7 +248,7 @@ FAR struct spi_sctrlr_s *sam_spi_slave_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -270,7 +270,7 @@ void sam_spi1select(uint32_t devid, bool selected); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -301,7 +301,7 @@ uint8_t sam_spi1status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_spi_slave.c b/arch/arm/src/samv7/sam_spi_slave.c index 19473aa05c..77a2cf6732 100644 --- a/arch/arm/src/samv7/sam_spi_slave.c +++ b/arch/arm/src/samv7/sam_spi_slave.c @@ -1059,7 +1059,7 @@ static void spi_qflush(struct spi_sctrlr_s *sctrlr) * Description: * Initialize the selected SPI port in slave mode. * - * Input Parameter: + * Input Parameters: * port - Chip select number identifying the "logical" SPI port. Includes * encoded port and chip select information. * diff --git a/arch/arm/src/samv7/sam_ssc.c b/arch/arm/src/samv7/sam_ssc.c index bb1114c444..8d56ff8f38 100644 --- a/arch/arm/src/samv7/sam_ssc.c +++ b/arch/arm/src/samv7/sam_ssc.c @@ -2765,7 +2765,7 @@ static int ssc_tx_configure(struct sam_ssc_s *priv) * Setup the MCK/2 divider based on the currently selected data width and * the sample rate * - * Input Parameter: + * Input Parameters: * priv - I2C device structure (only the sample rate and data length is * needed at this point). * @@ -2822,7 +2822,7 @@ static uint32_t ssc_mck2divider(struct sam_ssc_s *priv) * Description: * Enable and configure clocking to the SSC * - * Input Parameter: + * Input Parameters: * priv - Partially initialized I2C device structure (only the PID is * needed at this point). * @@ -3370,7 +3370,7 @@ static void ssc1_configure(struct sam_ssc_s *priv) * Description: * Initialize the selected SSC port * - * Input Parameter: + * Input Parameters: * port - I2S "port" number (identifying the "logical" SSC port) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_ssc.h b/arch/arm/src/samv7/sam_ssc.h index 567b655c36..0db57fe361 100644 --- a/arch/arm/src/samv7/sam_ssc.h +++ b/arch/arm/src/samv7/sam_ssc.h @@ -82,7 +82,7 @@ extern "C" * Description: * Initialize the selected I2S port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_twihs.h b/arch/arm/src/samv7/sam_twihs.h index 79f85a70e3..abcaba9b7d 100644 --- a/arch/arm/src/samv7/sam_twihs.h +++ b/arch/arm/src/samv7/sam_twihs.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *sam_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the sam_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/samv7/sam_wdt.c b/arch/arm/src/samv7/sam_wdt.c index 4ce21303c3..b6990b9370 100644 --- a/arch/arm/src/samv7/sam_wdt.c +++ b/arch/arm/src/samv7/sam_wdt.c @@ -254,7 +254,7 @@ static void sam_putreg(uint32_t regval, uintptr_t regaddr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -290,7 +290,7 @@ static int sam_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -320,7 +320,7 @@ static int sam_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -350,7 +350,7 @@ static int sam_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -378,7 +378,7 @@ static int sam_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * stawtus - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int sam_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in millisecnds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -567,7 +567,7 @@ static int sam_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -632,7 +632,7 @@ static xcpt_t sam_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -662,7 +662,7 @@ static int sam_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * Input Parameters: * None * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_wdt.h b/arch/arm/src/samv7/sam_wdt.h index f5ee97a247..3fe31686ca 100644 --- a/arch/arm/src/samv7/sam_wdt.h +++ b/arch/arm/src/samv7/sam_wdt.h @@ -76,7 +76,7 @@ extern "C" * * At a minimum, this function should call watchdog_register(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -96,7 +96,7 @@ int sam_wdt_initialize(void); * * At a minimum, this function should call watchdog_register(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_1wire.c b/arch/arm/src/stm32/stm32_1wire.c index a4157006a6..93ab8000ee 100644 --- a/arch/arm/src/stm32/stm32_1wire.c +++ b/arch/arm/src/stm32/stm32_1wire.c @@ -500,7 +500,7 @@ static void stm32_1wire_set_baud(struct stm32_1wire_priv_s *priv) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * priv - A reference to the 1-Wire driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -1149,7 +1149,7 @@ static int stm32_1wire_exchange(FAR struct onewire_dev_s *dev, bool reset, * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple 1-Wire interfaces) * * Returned Value: @@ -1245,7 +1245,7 @@ FAR struct onewire_dev_s *stm32_1wireinitialize(int port) * Description: * De-initialize the selected 1-Wire port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32_1wireinitialize() * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_1wire.h b/arch/arm/src/stm32/stm32_1wire.h index 24cfe45592..7606c8f461 100644 --- a/arch/arm/src/stm32/stm32_1wire.h +++ b/arch/arm/src/stm32/stm32_1wire.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple 1-Wire interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct onewire_dev_s *stm32_1wireinitialize(int port); * Description: * De-initialize the selected 1-Wire port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32_1wireinitialize() * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_adc.c b/arch/arm/src/stm32/stm32_adc.c index 7ec37927bd..89e826f6f0 100644 --- a/arch/arm/src/stm32/stm32_adc.c +++ b/arch/arm/src/stm32/stm32_adc.c @@ -757,7 +757,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_can.c b/arch/arm/src/stm32/stm32_can.c index a2fc3fac1d..2625c9123c 100644 --- a/arch/arm/src/stm32/stm32_can.c +++ b/arch/arm/src/stm32/stm32_can.c @@ -1644,7 +1644,7 @@ static int stm32can_txinterrupt(int irq, FAR void *context, FAR void *arg) * Where: * Tpclk1 is the period of the APB1 clock (PCLK1). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1743,7 +1743,7 @@ static int stm32can_bittiming(FAR struct stm32_can_s *priv) * peripheral, no registers are changed. The initialization mode is * required to change the baud rate. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1794,7 +1794,7 @@ static int stm32can_enterinitmode(FAR struct stm32_can_s *priv) * Description: * Put the CAN cell out of the Initialization mode (to Normal mode) * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1844,7 +1844,7 @@ static int stm32can_exitinitmode(FAR struct stm32_can_s *priv) * Description: * CAN cell initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1927,7 +1927,7 @@ static int stm32can_cellinit(FAR struct stm32_can_s *priv) * are set to zero thus supressing all filtering because anything masked * with zero matches zero. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -2014,7 +2014,7 @@ static int stm32can_filterinit(FAR struct stm32_can_s *priv) * Description: * Add a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2039,7 +2039,7 @@ static int stm32can_addextfilter(FAR struct stm32_can_s *priv, * Description: * Remove a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_EXTFILTER command @@ -2064,7 +2064,7 @@ static int stm32can_delextfilter(FAR struct stm32_can_s *priv, int arg) * Description: * Add a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2087,7 +2087,7 @@ static int stm32can_addstdfilter(FAR struct stm32_can_s *priv, * Description: * Remove a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_STDFILTER command @@ -2107,7 +2107,7 @@ static int stm32can_delstdfilter(FAR struct stm32_can_s *priv, int arg) /**************************************************************************** * Name: stm32can_txmb0empty * - * Input Parameter: + * Input Parameters: * tsr_regval - value of CAN transmit status register * * Returned Value: @@ -2124,7 +2124,7 @@ static bool stm32can_txmb0empty(uint32_t tsr_regval) /**************************************************************************** * Name: stm32can_txmb1empty * - * Input Parameter: + * Input Parameters: * tsr_regval - value of CAN transmit status register * * Returned Value: @@ -2141,7 +2141,7 @@ static bool stm32can_txmb1empty(uint32_t tsr_regval) /**************************************************************************** * Name: stm32can_txmb2empty * - * Input Parameter: + * Input Parameters: * tsr_regval - value of CAN transmit status register * * Returned Value: @@ -2165,7 +2165,7 @@ static bool stm32can_txmb2empty(uint32_t tsr_regval) * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_can.h b/arch/arm/src/stm32/stm32_can.h index f06231ab60..078e6b2a12 100644 --- a/arch/arm/src/stm32/stm32_can.h +++ b/arch/arm/src/stm32/stm32_can.h @@ -125,7 +125,7 @@ extern "C" * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_dma.h b/arch/arm/src/stm32/stm32_dma.h index 965fd6f30f..e9878d1157 100644 --- a/arch/arm/src/stm32/stm32_dma.h +++ b/arch/arm/src/stm32/stm32_dma.h @@ -175,7 +175,7 @@ extern "C" * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * For the STM32 F1, this is simply the channel number as provided by * the DMACHAN_* definitions in chip/stm32f10xxx_dma.h. @@ -281,7 +281,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle); * only applies to memory addresses, it will return false for any peripheral * address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_dma2d.c b/arch/arm/src/stm32/stm32_dma2d.c index a70ed75085..c9e2a0e54c 100644 --- a/arch/arm/src/stm32/stm32_dma2d.c +++ b/arch/arm/src/stm32/stm32_dma2d.c @@ -486,7 +486,7 @@ static int stm32_dma2dirq(int irq, void *context, FAR void *arg) * loading or dma transfer was completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * On success OK otherwise ERROR * ****************************************************************************/ @@ -532,7 +532,7 @@ static int stm32_dma2d_waitforirq(void) * Parameter: * pfcreg - PFC control Register * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -620,7 +620,7 @@ static int stm32_dma2d_start(void) * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * memory address * ****************************************************************************/ @@ -646,7 +646,7 @@ static uint32_t stm32_dma2d_memaddress(FAR const struct stm32_dma2d_s *layer, * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * line offset * ****************************************************************************/ @@ -670,7 +670,7 @@ static fb_coord_t stm32_dma2d_lineoffset(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the common layer state structure * fmt - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -729,7 +729,7 @@ static int stm32_dma2d_pixelformat(uint8_t fmt, uint8_t *fmtmap) * layer - Reference to the common layer state structure * bpp - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -770,7 +770,7 @@ static int stm32_dma2d_bpp(uint8_t fmt, uint8_t *bpp) * Description: * Get a free layer id * - * Return: + * Returned Value: * The number of the free layer * -1 if no free layer is available * @@ -797,7 +797,7 @@ static int stm32_dma2d_lfreelid(void) * Description: * Allocate a new layer structure * - * Return: + * Returned Value: * A new allocated layer structure or NULL on error. * ****************************************************************************/ @@ -886,7 +886,7 @@ static void stm32_dma2d_llayerscleanup(void) * Description: * Helper to validate if the layer is valid * - * Return: + * Returned Value: * true if validates otherwise false * ****************************************************************************/ @@ -908,7 +908,7 @@ static inline bool stm32_dma2d_lvalidate(FAR const struct stm32_dma2d_s *layer) * ypos - The y position inside the whole layer * area - the area inside the whole layer * - * Return: + * Returned Value: * true if area is inside the whole layer otherwise false * ****************************************************************************/ @@ -1162,7 +1162,7 @@ static void stm32_dma2d_lpfc(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1199,7 +1199,7 @@ static int stm32_dma2dgetvideoinfo(FAR struct dma2d_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1235,7 +1235,7 @@ static int stm32_dma2dgetplaneinfo(FAR struct dma2d_layer_s *layer, int planeno, * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1271,7 +1271,7 @@ static int stm32_dma2dgetlid(FAR struct dma2d_layer_s *layer, int *lid) * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1390,7 +1390,7 @@ static int stm32_dma2dsetclut(FAR struct dma2d_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1482,7 +1482,7 @@ static int stm32_dma2dgetclut(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1517,7 +1517,7 @@ static int stm32_dma2dsetalpha(FAR struct dma2d_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1554,7 +1554,7 @@ static int stm32_dma2dgetalpha(FAR struct dma2d_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1603,7 +1603,7 @@ static int stm32_dma2dsetblendmode(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1643,7 +1643,7 @@ static int stm32_dma2dgetblendmode(FAR struct dma2d_layer_s *layer, * src - Valid reference to the source layer * srcarea - Valid reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1752,7 +1752,7 @@ static int stm32_dma2dblit(FAR struct dma2d_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1859,7 +1859,7 @@ static int stm32_dma2dblend(FAR struct dma2d_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -1935,7 +1935,7 @@ static int stm32_dma2dfillarea(FAR struct dma2d_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -1968,7 +1968,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid) * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * @@ -2090,7 +2090,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2132,7 +2132,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer) * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * @@ -2248,7 +2248,7 @@ void up_dma2duninitialize(void) * layer - a valid reference to the low level ltdc layer structure * clut - a pointer to a valid memory region to hold 256 clut colors * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * diff --git a/arch/arm/src/stm32/stm32_dma2d.h b/arch/arm/src/stm32/stm32_dma2d.h index a62d16f7af..258ae69531 100644 --- a/arch/arm/src/stm32/stm32_dma2d.h +++ b/arch/arm/src/stm32/stm32_dma2d.h @@ -74,7 +74,7 @@ struct dma2d_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -92,7 +92,7 @@ struct dma2d_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -109,7 +109,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -127,7 +127,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -145,7 +145,7 @@ struct dma2d_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -167,7 +167,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -183,7 +183,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -201,7 +201,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -230,7 +230,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -250,7 +250,7 @@ struct dma2d_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -281,7 +281,7 @@ struct dma2d_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -308,7 +308,7 @@ struct dma2d_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected area outside the visible area of the layer. @@ -340,7 +340,7 @@ struct stm32_ltdc_s; /* Forward declaration */ * Parameter: * layer - a valid reference to the low level ltdc layer structure * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -358,7 +358,7 @@ FAR struct dma2d_layer_s *stm32_dma2dinitltdc(FAR struct stm32_ltdc_s *layer); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -377,7 +377,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid); * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -399,7 +399,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -413,7 +413,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer); * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * diff --git a/arch/arm/src/stm32/stm32_exti.h b/arch/arm/src/stm32/stm32_exti.h index 8e46e239da..376d65f774 100644 --- a/arch/arm/src/stm32/stm32_exti.h +++ b/arch/arm/src/stm32/stm32_exti.h @@ -123,7 +123,7 @@ int stm32_exti_alarm(bool risingedge, bool fallingedge, bool event, xcpt_t func, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32/stm32_exti_alarm.c b/arch/arm/src/stm32/stm32_exti_alarm.c index 414817a6b8..77de848e9f 100644 --- a/arch/arm/src/stm32/stm32_exti_alarm.c +++ b/arch/arm/src/stm32/stm32_exti_alarm.c @@ -108,7 +108,7 @@ static int stm32_exti_alarm_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32/stm32_exti_pwr.c b/arch/arm/src/stm32/stm32_exti_pwr.c index 5ab6138ac4..36d2167283 100644 --- a/arch/arm/src/stm32/stm32_exti_pwr.c +++ b/arch/arm/src/stm32/stm32_exti_pwr.c @@ -114,7 +114,7 @@ static int stm32_exti_pvd_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32/stm32_exti_pwr.h b/arch/arm/src/stm32/stm32_exti_pwr.h index c4841dffeb..e48ca3f2ee 100644 --- a/arch/arm/src/stm32/stm32_exti_pwr.h +++ b/arch/arm/src/stm32/stm32_exti_pwr.h @@ -59,7 +59,7 @@ * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32/stm32_exti_wakeup.c b/arch/arm/src/stm32/stm32_exti_wakeup.c index 9dd9ad7d99..d265361f87 100644 --- a/arch/arm/src/stm32/stm32_exti_wakeup.c +++ b/arch/arm/src/stm32/stm32_exti_wakeup.c @@ -107,7 +107,7 @@ static int stm32_exti_wakeup_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32/stm32_flash.h b/arch/arm/src/stm32/stm32_flash.h index 6da1b0b703..4d5003b056 100644 --- a/arch/arm/src/stm32/stm32_flash.h +++ b/arch/arm/src/stm32/stm32_flash.h @@ -56,7 +56,7 @@ * Description: * Get EEPROM data memory size * - * Returns: + * Returned Value: * Length of EEPROM memory region * ************************************************************************************/ @@ -69,7 +69,7 @@ size_t stm32_eeprom_size(void); * Description: * Get EEPROM data memory address * - * Returns: + * Returned Value: * Address of EEPROM memory region * ************************************************************************************/ @@ -82,7 +82,7 @@ size_t stm32_eeprom_getaddress(void); * Description: * Write buffer to EEPROM data memory address * - * Returns: + * Returned Value: * Number of written bytes or error code. * ************************************************************************************/ @@ -95,7 +95,7 @@ ssize_t stm32_eeprom_write(size_t addr, const void *buf, size_t buflen); * Description: * Erase memory on EEPROM data memory address * - * Returns: + * Returned Value: * Number of erased bytes or error code. * ************************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_gpio.c b/arch/arm/src/stm32/stm32_gpio.c index 727f0c943a..7a1d7800c4 100644 --- a/arch/arm/src/stm32/stm32_gpio.c +++ b/arch/arm/src/stm32/stm32_gpio.c @@ -261,7 +261,7 @@ void stm32_gpioinit(void) * function, it must be unconfigured with stm32_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono valu on invalid port, or when pin is locked as ALT * function. @@ -667,7 +667,7 @@ int stm32_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32/stm32_hrtim.c b/arch/arm/src/stm32/stm32_hrtim.c index 09da49edf9..a8069194bb 100644 --- a/arch/arm/src/stm32/stm32_hrtim.c +++ b/arch/arm/src/stm32/stm32_hrtim.c @@ -2560,7 +2560,7 @@ static int hrtim_gpios_config(FAR struct stm32_hrtim_s *priv) * Description: * Configure HRTIM Captures * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * capture - capture trigers configuration @@ -2618,7 +2618,7 @@ errout: * Description: * Configure HRTIM Captures * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * * Returned Value: @@ -2669,7 +2669,7 @@ static int hrtim_capture_config(FAR struct stm32_hrtim_s *priv) * Description: * Get HRTIM Timer Capture register * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * index - Capture register index @@ -4516,7 +4516,7 @@ void hrtim_irq_ack(FAR struct hrtim_dev_s *dev, uint8_t timer, int source); * Description: * Set HRTIM Timer mode * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * mode - Timer mode configuration @@ -4685,7 +4685,7 @@ errout: * Description: * Try update HRTIM Timer compare register. * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * index - Compare register timer @@ -4759,7 +4759,7 @@ errout: * Description: * Try update HRTIM Timer period register. * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * per - New period register value @@ -4784,7 +4784,7 @@ static int hrtim_per_update(FAR struct hrtim_dev_s *dev, uint8_t timer, * Description: * Get HRTIM Timer period value * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * @@ -4806,7 +4806,7 @@ static uint16_t hrtim_per_get(FAR struct hrtim_dev_s *dev, uint8_t timer) * Description: * Get HRTIM Timer compare register * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * index - Compare register timer @@ -4868,7 +4868,7 @@ errout: * Description: * Get HRTIM Timer clock value * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * @@ -4904,7 +4904,7 @@ errout: * Description: * Set HRTIM Timer Reset events * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * reset - Reset configuration diff --git a/arch/arm/src/stm32/stm32_i2c.h b/arch/arm/src/stm32/stm32_i2c.h index f36ee952f5..c61f17332b 100644 --- a/arch/arm/src/stm32/stm32_i2c.h +++ b/arch/arm/src/stm32/stm32_i2c.h @@ -79,7 +79,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -95,7 +95,7 @@ FAR struct i2c_master_s *stm32_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_i2s.c b/arch/arm/src/stm32/stm32_i2s.c index 46ac8f6eec..f68eb8683d 100644 --- a/arch/arm/src/stm32/stm32_i2s.c +++ b/arch/arm/src/stm32/stm32_i2s.c @@ -2160,7 +2160,7 @@ errout_with_exclsem: * Setup the MCK divider based on the currently selected data width and * the sample rate * - * Input Parameter: + * Input Parameters: * priv - I2C device structure (only the sample rate and data length is * needed at this point). * @@ -2562,7 +2562,7 @@ static void i2s3_configure(struct stm32_i2s_s *priv) * Description: * Initialize the selected i2S port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_i2s.h b/arch/arm/src/stm32/stm32_i2s.h index 5e6d51b817..fc7a702b7e 100644 --- a/arch/arm/src/stm32/stm32_i2s.h +++ b/arch/arm/src/stm32/stm32_i2s.h @@ -71,7 +71,7 @@ extern "C" * Description: * Initialize the selected I2S port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_iwdg.c b/arch/arm/src/stm32/stm32_iwdg.c index d26ec9f71a..2ceaf9bd4b 100644 --- a/arch/arm/src/stm32/stm32_iwdg.c +++ b/arch/arm/src/stm32/stm32_iwdg.c @@ -315,7 +315,7 @@ static inline void stm32_setprescaler(FAR struct stm32_lowerhalf_s *priv) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -371,7 +371,7 @@ static int stm32_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -396,7 +396,7 @@ static int stm32_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -429,7 +429,7 @@ static int stm32_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -488,7 +488,7 @@ static int stm32_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -639,7 +639,7 @@ static int stm32_settimeout(FAR struct watchdog_lowerhalf_s *lower, * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_ltdc.c b/arch/arm/src/stm32/stm32_ltdc.c index 5b794d17dd..25644116de 100644 --- a/arch/arm/src/stm32/stm32_ltdc.c +++ b/arch/arm/src/stm32/stm32_ltdc.c @@ -1162,7 +1162,7 @@ static int stm32_ltdcirq(int irq, void *context, FAR void *arg) * that a register reload was been completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * OK - On success otherwise ERROR * ****************************************************************************/ @@ -1457,7 +1457,7 @@ static inline uint8_t stm32_ltdc_lgetopac(FAR struct stm32_layer_s *layer) * Parameter: * layer - Reference to the layer control structure * - * Return: + * Returned Value: * true - layer valid * false - layer invalid * @@ -1487,7 +1487,7 @@ static inline bool stm32_ltdc_lvalidate(FAR const struct stm32_layer_s *layer) * srcxpos - Top left x position from where data visible in the active area * srcypos - Top left y position from where data visible in the active area * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1958,7 +1958,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer) * layer - Reference to the layer control structure * color - The color to clear * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * @@ -2172,7 +2172,7 @@ static void stm32_ltdc_linit(int lid) * vtable - The framebuffer driver object * vinfo - the videoinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2207,7 +2207,7 @@ static int stm32_getvideoinfo(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * pinfo - the planeinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2242,7 +2242,7 @@ static int stm32_getplaneinfo(struct fb_vtable_s *vtable, int planeno, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2269,7 +2269,7 @@ static int stm32_getcmap(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2296,7 +2296,7 @@ static int stm32_putcmap(struct fb_vtable_s *vtable, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2330,7 +2330,7 @@ static int stm32_lgetvideoinfo(struct ltdc_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2364,7 +2364,7 @@ static int stm32_lgetplaneinfo(struct ltdc_layer_s *layer, int planeno, * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2424,7 +2424,7 @@ static int stm32_setclut(struct ltdc_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2523,7 +2523,7 @@ static int stm32_getclut(struct ltdc_layer_s *layer, * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * OK - On success * Null if invalid flag * @@ -2600,7 +2600,7 @@ static int stm32_getlid(FAR struct ltdc_layer_s *layer, int *lid, * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2636,7 +2636,7 @@ static int stm32_setcolor(FAR struct ltdc_layer_s *layer, uint32_t argb) * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2673,7 +2673,7 @@ static int stm32_getcolor(FAR struct ltdc_layer_s *layer, uint32_t *argb) * layer - Reference to the layer structure * rgb - RGB888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2709,7 +2709,7 @@ static int stm32_setcolorkey(FAR struct ltdc_layer_s *layer, uint32_t rgb) * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2750,7 +2750,7 @@ static int stm32_getcolorkey(FAR struct ltdc_layer_s *layer, uint32_t *rgb) * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2786,7 +2786,7 @@ static int stm32_setalpha(FAR struct ltdc_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2823,7 +2823,7 @@ static int stm32_getalpha(FAR struct ltdc_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2955,7 +2955,7 @@ static int stm32_setblendmode(FAR struct ltdc_layer_s *layer, uint32_t mode) * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL ****************************************************************************/ @@ -2994,7 +2994,7 @@ static int stm32_getblendmode(FAR struct ltdc_layer_s *layer, uint32_t *mode) * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3056,7 +3056,7 @@ static int stm32_setarea(FAR struct ltdc_layer_s *layer, * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3096,7 +3096,7 @@ static int stm32_getarea(FAR struct ltdc_layer_s *layer, * layer - Reference to the layer structure * mode - operation mode * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -3259,7 +3259,7 @@ static int stm32_update(FAR struct ltdc_layer_s *layer, uint32_t mode) * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3310,7 +3310,7 @@ static int stm32_blit(FAR struct ltdc_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3360,7 +3360,7 @@ static int stm32_blend(FAR struct ltdc_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -3402,7 +3402,7 @@ static int stm32_fillarea(FAR struct ltdc_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if lid * is invalid. * @@ -3428,7 +3428,7 @@ FAR struct ltdc_layer_s *stm32_ltdcgetlayer(int lid) * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ****************************************************************************/ @@ -3517,10 +3517,10 @@ int stm32_ltdcinitialize(void) * Return a a reference to the framebuffer object for the specified video * plane. * - * Input parameters: + * Input Parameters: * None * - * Returned value: + * Returned Value: * Reference to the framebuffer object (NULL on failure) * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_ltdc.h b/arch/arm/src/stm32/stm32_ltdc.h index 33ebc3e558..7c73de31fe 100644 --- a/arch/arm/src/stm32/stm32_ltdc.h +++ b/arch/arm/src/stm32/stm32_ltdc.h @@ -133,7 +133,7 @@ struct ltdc_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -151,7 +151,7 @@ struct ltdc_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -171,7 +171,7 @@ struct ltdc_layer_s * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -192,7 +192,7 @@ struct ltdc_layer_s * enable - Enable or disable clut support (if false cmap is ignored and can * be NULL) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -210,7 +210,7 @@ struct ltdc_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -229,7 +229,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -245,7 +245,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -263,7 +263,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -279,7 +279,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -301,7 +301,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -317,7 +317,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -335,7 +335,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -373,7 +373,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -400,7 +400,7 @@ struct ltdc_layer_s * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -426,7 +426,7 @@ struct ltdc_layer_s * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -445,7 +445,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - operation mode (see LTDC_UPDATE_*) * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -489,7 +489,7 @@ struct ltdc_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -518,7 +518,7 @@ struct ltdc_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -543,7 +543,7 @@ struct ltdc_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -607,7 +607,7 @@ struct stm32_ltdc_s * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ************************************************************************************/ @@ -625,7 +625,7 @@ void stm32_ltdcuninitialize(void); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if parameter * invalid. * diff --git a/arch/arm/src/stm32/stm32_otgfshost.c b/arch/arm/src/stm32/stm32_otgfshost.c index 8a6382d345..1b29ae09e5 100644 --- a/arch/arm/src/stm32/stm32_otgfshost.c +++ b/arch/arm/src/stm32/stm32_otgfshost.c @@ -1265,7 +1265,7 @@ static int stm32_ctrlchan_alloc(FAR struct stm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1327,7 +1327,7 @@ static int stm32_ctrlep_alloc(FAR struct stm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3820,7 +3820,7 @@ static void stm32_txfe_enable(FAR struct stm32_usbhost_s *priv, int chidx) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3911,7 +3911,7 @@ static int stm32_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4041,7 +4041,7 @@ static int stm32_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4100,7 +4100,7 @@ static int stm32_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4156,7 +4156,7 @@ static int stm32_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpoint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4224,7 +4224,7 @@ static int stm32_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4270,7 +4270,7 @@ static int stm32_alloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4306,7 +4306,7 @@ static int stm32_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4350,7 +4350,7 @@ static int stm32_ioalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4393,7 +4393,7 @@ static int stm32_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4596,7 +4596,7 @@ static int stm32_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4668,7 +4668,7 @@ static ssize_t stm32_transfer(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4724,7 +4724,7 @@ static int stm32_asynch(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep, * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4813,7 +4813,7 @@ static int stm32_cancel(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4865,7 +4865,7 @@ static int stm32_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_otghshost.c b/arch/arm/src/stm32/stm32_otghshost.c index ad1091d02f..c276742ab7 100644 --- a/arch/arm/src/stm32/stm32_otghshost.c +++ b/arch/arm/src/stm32/stm32_otghshost.c @@ -1270,7 +1270,7 @@ static int stm32_ctrlchan_alloc(FAR struct stm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1332,7 +1332,7 @@ static int stm32_ctrlep_alloc(FAR struct stm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3825,7 +3825,7 @@ static void stm32_txfe_enable(FAR struct stm32_usbhost_s *priv, int chidx) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3916,7 +3916,7 @@ static int stm32_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4046,7 +4046,7 @@ static int stm32_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4105,7 +4105,7 @@ static int stm32_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4161,7 +4161,7 @@ static int stm32_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpoint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4229,7 +4229,7 @@ static int stm32_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4275,7 +4275,7 @@ static int stm32_alloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4311,7 +4311,7 @@ static int stm32_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4355,7 +4355,7 @@ static int stm32_ioalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4398,7 +4398,7 @@ static int stm32_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4601,7 +4601,7 @@ static int stm32_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4673,7 +4673,7 @@ static ssize_t stm32_transfer(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4729,7 +4729,7 @@ static int stm32_asynch(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep, * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4818,7 +4818,7 @@ static int stm32_cancel(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4870,7 +4870,7 @@ static int stm32_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_pm.h b/arch/arm/src/stm32/stm32_pm.h index 7fc93ba688..8feee1f566 100644 --- a/arch/arm/src/stm32/stm32_pm.h +++ b/arch/arm/src/stm32/stm32_pm.h @@ -102,7 +102,7 @@ int stm32_pmstop(bool lpds); * Input Parameters: * None * - * Returned Value. + * Returned Value: * On success, this function will not return (STANDBY mode can only be * terminated with a reset event). Otherwise, STANDBY mode did not occur * and a negated errno value is returned to indicate the cause of the diff --git a/arch/arm/src/stm32/stm32_pminitialize.c b/arch/arm/src/stm32/stm32_pminitialize.c index e9b6d4780c..243bc53aa4 100644 --- a/arch/arm/src/stm32/stm32_pminitialize.c +++ b/arch/arm/src/stm32/stm32_pminitialize.c @@ -76,10 +76,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_pmstandby.c b/arch/arm/src/stm32/stm32_pmstandby.c index 2b4de6a6f0..952e14317f 100644 --- a/arch/arm/src/stm32/stm32_pmstandby.c +++ b/arch/arm/src/stm32/stm32_pmstandby.c @@ -71,7 +71,7 @@ * Input Parameters: * None * - * Returned Value. + * Returned Value: * On success, this function will not return (STANDBY mode can only be * terminated with a reset event). Otherwise, STANDBY mode did not occur * and a negated errno value is returned to indicate the cause of the diff --git a/arch/arm/src/stm32/stm32_pwm.c b/arch/arm/src/stm32/stm32_pwm.c index 0e9db50059..7aadb98ae7 100644 --- a/arch/arm/src/stm32/stm32_pwm.c +++ b/arch/arm/src/stm32/stm32_pwm.c @@ -1095,7 +1095,7 @@ static void pwm_putreg(struct stm32_pwmtimer_s *priv, int offset, uint16_t value * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -1182,7 +1182,7 @@ static void pwm_dumpregs(struct stm32_pwmtimer_s *priv, FAR const char *msg) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -1815,7 +1815,7 @@ static int pwm_timer(FAR struct stm32_pwmtimer_s *priv, * Description: * Try to change only channel duty. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * channel - Channel to by updated * duty - New duty. @@ -1897,7 +1897,7 @@ static int pwm_update_duty(FAR struct stm32_pwmtimer_s *priv, uint8_t channel, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -1980,7 +1980,7 @@ static int pwm_interrupt(struct stm32_pwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -2008,7 +2008,7 @@ static int pwm_tim8interrupt(int irq, void *context, FAR void *arg) * Description: * Pick an optimal pulse count to program the RCR. * - * Input parameters: + * Input Parameters: * count - The total count remaining * * Returned Value: @@ -2055,7 +2055,7 @@ static uint8_t pwm_pulsecount(uint32_t count) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2188,7 +2188,7 @@ static void pwm_set_apb_clock(FAR struct stm32_pwmtimer_s *priv, bool on) * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -2241,7 +2241,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -2303,7 +2303,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -2390,7 +2390,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -2549,7 +2549,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/stm32/stm32_pwr.c b/arch/arm/src/stm32/stm32_pwr.c index 04cf7e9387..5a4b863b55 100644 --- a/arch/arm/src/stm32/stm32_pwr.c +++ b/arch/arm/src/stm32/stm32_pwr.c @@ -263,7 +263,7 @@ void stm32_pwr_enablebkp(bool writable) * wupin - Selects the WKUP pin to enable/disable * wupon - state to set it to * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on any * failure. The only cause of failure is if the selected MCU does not support * the requested wakeup pin. @@ -359,7 +359,7 @@ bool stm32_pwr_getwuf(void) * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ @@ -390,7 +390,7 @@ void stm32_pwr_enablebreg(bool regon) * Input Parameters: * vos - Properly aligned voltage scaling select bits for the PWR_CR register. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -432,7 +432,7 @@ void stm32_pwr_setvos(uint16_t vos) * Input Parameters: * pls - PVD level * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_pwr.h b/arch/arm/src/stm32/stm32_pwr.h index b93b34108c..ee56a40d18 100644 --- a/arch/arm/src/stm32/stm32_pwr.h +++ b/arch/arm/src/stm32/stm32_pwr.h @@ -152,7 +152,7 @@ void stm32_pwr_enablebkp(bool writable); * wupin - Selects the WKUP pin to enable/disable * wupon - state to set it to * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on any * failure. The only cause of failure is if the selected MCU does not support * the requested wakeup pin. @@ -195,7 +195,7 @@ bool stm32_pwr_getwuf(void); * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ @@ -215,7 +215,7 @@ void stm32_pwr_enablebreg(bool regon); * Input Parameters: * vos - Properly aligned voltage scaling select bits for the PWR_CR register. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -237,7 +237,7 @@ void stm32_pwr_setvos(uint16_t vos); * Input Parameters: * pls - PVD level * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_qencoder.c b/arch/arm/src/stm32/stm32_qencoder.c index 5bc98ad322..661e737f8a 100644 --- a/arch/arm/src/stm32/stm32_qencoder.c +++ b/arch/arm/src/stm32/stm32_qencoder.c @@ -574,7 +574,7 @@ static void stm32_putreg32(FAR struct stm32_lowerhalf_s *priv, int offset, uint3 * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the QENCODER block status * * Returned Value: @@ -1173,7 +1173,7 @@ static int stm32_ioctl(FAR struct qe_lowerhalf_s *lower, int cmd, unsigned long * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_qencoder.h b/arch/arm/src/stm32/stm32_qencoder.h index bea28531b6..98c5b25f11 100644 --- a/arch/arm/src/stm32/stm32_qencoder.h +++ b/arch/arm/src/stm32/stm32_qencoder.h @@ -130,7 +130,7 @@ * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_sdadc.c b/arch/arm/src/stm32/stm32_sdadc.c index e8236a05f9..eaaf486e9d 100644 --- a/arch/arm/src/stm32/stm32_sdadc.c +++ b/arch/arm/src/stm32/stm32_sdadc.c @@ -456,7 +456,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the SDADC block state * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_sdio.c b/arch/arm/src/stm32/stm32_sdio.c index 1413334419..1d9f99e72b 100644 --- a/arch/arm/src/stm32/stm32_sdio.c +++ b/arch/arm/src/stm32/stm32_sdio.c @@ -2954,7 +2954,7 @@ static void stm32_default(void) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3028,7 +3028,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -3075,7 +3075,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_sdio.h b/arch/arm/src/stm32/stm32_sdio.h index 04c65ba00f..4fc477a0e4 100644 --- a/arch/arm/src/stm32/stm32_sdio.h +++ b/arch/arm/src/stm32/stm32_sdio.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -93,7 +93,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -111,7 +111,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_serial.c b/arch/arm/src/stm32/stm32_serial.c index 74b70ffd06..a14404835b 100644 --- a/arch/arm/src/stm32/stm32_serial.c +++ b/arch/arm/src/stm32/stm32_serial.c @@ -1381,7 +1381,7 @@ static void up_set_format(struct uart_dev_s *dev) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the UART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2274,7 +2274,7 @@ static bool up_rxavailable(struct uart_dev_s *dev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/arch/arm/src/stm32/stm32_spi.c b/arch/arm/src/stm32/stm32_spi.c index 1be51d49c2..585a3e9231 100644 --- a/arch/arm/src/stm32/stm32_spi.c +++ b/arch/arm/src/stm32/stm32_spi.c @@ -1670,7 +1670,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI bus in its default state (Master, 8-bit, mode 0, etc.) * - * Input Parameter: + * Input Parameters: * priv - private SPI device structure * * Returned Value: @@ -1775,7 +1775,7 @@ static void spi_bus_initialize(FAR struct stm32_spidev_s *priv) * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_spi.h b/arch/arm/src/stm32/stm32_spi.h index ee99808c6a..bcc2f0e14b 100644 --- a/arch/arm/src/stm32/stm32_spi.h +++ b/arch/arm/src/stm32/stm32_spi.h @@ -78,7 +78,7 @@ struct spi_dev_s; * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * bus number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_tim.h b/arch/arm/src/stm32/stm32_tim.h index bc6ef090c6..2e0828fafa 100644 --- a/arch/arm/src/stm32/stm32_tim.h +++ b/arch/arm/src/stm32/stm32_tim.h @@ -208,7 +208,7 @@ int stm32_tim_deinit(FAR struct stm32_tim_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32/stm32_tim_lowerhalf.c b/arch/arm/src/stm32/stm32_tim_lowerhalf.c index d8415ac040..d0a9619517 100644 --- a/arch/arm/src/stm32/stm32_tim_lowerhalf.c +++ b/arch/arm/src/stm32/stm32_tim_lowerhalf.c @@ -261,7 +261,7 @@ static struct stm32_lowerhalf_s g_tim14_lowerhalf = * * Input Parameters: * - * Returned Values: + * Returned Value: * ****************************************************************************/ @@ -297,7 +297,7 @@ static int stm32_timer_handler(int irq, void * context, void * arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -335,7 +335,7 @@ static int stm32_start(FAR struct timer_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -369,7 +369,7 @@ static int stm32_stop(struct timer_lowerhalf_s *lower) * driver state structure. * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -414,7 +414,7 @@ static int stm32_settimeout(FAR struct timer_lowerhalf_s *lower, uint32_t timeou * behavior is restored, * arg - Argument that will be provided in the callback * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -462,7 +462,7 @@ static void stm32_setcallback(FAR struct timer_lowerhalf_s *lower, * form /dev/timer0 * timer - the timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32/stm32_wdg.h b/arch/arm/src/stm32/stm32_wdg.h index 64815bfe90..264734b9f5 100644 --- a/arch/arm/src/stm32/stm32_wdg.h +++ b/arch/arm/src/stm32/stm32_wdg.h @@ -79,7 +79,7 @@ extern "C" * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -100,7 +100,7 @@ void stm32_iwdginitialize(FAR const char *devpath, uint32_t lsifreq); * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_wwdg.c b/arch/arm/src/stm32/stm32_wwdg.c index 79d34656da..ba2b994fa4 100644 --- a/arch/arm/src/stm32/stm32_wwdg.c +++ b/arch/arm/src/stm32/stm32_wwdg.c @@ -281,7 +281,7 @@ static void stm32_setwindow(FAR struct stm32_lowerhalf_s *priv, uint8_t window) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -329,7 +329,7 @@ static int stm32_interrupt(int irq, FAR void *context, FAR void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -361,7 +361,7 @@ static int stm32_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -395,7 +395,7 @@ static int stm32_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -426,7 +426,7 @@ static int stm32_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -482,7 +482,7 @@ static int stm32_getstatus(FAR struct watchdog_lowerhalf_s *lower, * "lower-half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -618,7 +618,7 @@ static int stm32_settimeout(FAR struct watchdog_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous watchdog expiration function pointer or NULL is there was * no previous function pointer, i.e., if the previous behavior was * reset-on-expiration (NULL is also returned if an error occurs). @@ -686,7 +686,7 @@ static xcpt_t stm32_capture(FAR struct watchdog_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -742,7 +742,7 @@ static int stm32_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f10xxx_dma.c b/arch/arm/src/stm32/stm32f10xxx_dma.c index c3c666e937..72da836ad1 100644 --- a/arch/arm/src/stm32/stm32f10xxx_dma.c +++ b/arch/arm/src/stm32/stm32f10xxx_dma.c @@ -395,7 +395,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chndx - Identifies the stream/channel resource. For the STM32 F1, this * is simply the channel number as provided by the DMACHAN_* definitions * in chip/stm32f10xxx_dma.h. @@ -626,7 +626,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f20xxx_dma.c b/arch/arm/src/stm32/stm32f20xxx_dma.c index 8c06819f7a..86b95f7f13 100644 --- a/arch/arm/src/stm32/stm32f20xxx_dma.c +++ b/arch/arm/src/stm32/stm32f20xxx_dma.c @@ -525,7 +525,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * dmamap - Identifies the stream/channel resource. For the STM32 F2, this * is a bit-encoded value as provided by the DMAMAP_* definitions * in chip/stm32f20xxx_dma.h @@ -856,7 +856,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f33xxx_adc.c b/arch/arm/src/stm32/stm32f33xxx_adc.c index 4eb887e148..412c3453d7 100644 --- a/arch/arm/src/stm32/stm32f33xxx_adc.c +++ b/arch/arm/src/stm32/stm32f33xxx_adc.c @@ -804,7 +804,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32/stm32f33xxx_dma.c b/arch/arm/src/stm32/stm32f33xxx_dma.c index af091e2fec..1c0c626e60 100644 --- a/arch/arm/src/stm32/stm32f33xxx_dma.c +++ b/arch/arm/src/stm32/stm32f33xxx_dma.c @@ -343,7 +343,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chndx - Identifies the stream/channel resource. For the STM32 F1, this * is simply the channel number as provided by the DMACHAN_* definitions * in chip/stm32f10xxx_dma.h. @@ -574,7 +574,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f40xxx_dma.c b/arch/arm/src/stm32/stm32f40xxx_dma.c index 6dedd5a337..7f528f1a33 100644 --- a/arch/arm/src/stm32/stm32f40xxx_dma.c +++ b/arch/arm/src/stm32/stm32f40xxx_dma.c @@ -524,7 +524,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * dmamap - Identifies the stream/channel resource. For the STM32 F4, this * is a bit-encoded value as provided by the DMAMAP_* definitions * in chip/stm32f40xxx_dma.h @@ -863,7 +863,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f0/stm32f0_gpio.c b/arch/arm/src/stm32f0/stm32f0_gpio.c index ffa77a43ec..d6ee49b6e9 100644 --- a/arch/arm/src/stm32f0/stm32f0_gpio.c +++ b/arch/arm/src/stm32f0/stm32f0_gpio.c @@ -115,7 +115,7 @@ void stm32f0_gpioinit(void) * function, it must be unconfigured with stm32f0_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono valu on invalid port, or when pin is locked as ALT * function. @@ -336,7 +336,7 @@ int stm32f0_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32f0/stm32f0_gpio.h b/arch/arm/src/stm32f0/stm32f0_gpio.h index 4cbe0a40df..14c95cce3f 100644 --- a/arch/arm/src/stm32f0/stm32f0_gpio.h +++ b/arch/arm/src/stm32f0/stm32f0_gpio.h @@ -256,7 +256,7 @@ EXTERN const uint32_t g_gpiobase[STM32F0_NPORTS]; * function, it must be unconfigured with stm32f0_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * @@ -277,7 +277,7 @@ int stm32f0_configgpio(uint32_t cfgset); * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port * diff --git a/arch/arm/src/stm32f0/stm32f0_i2c.h b/arch/arm/src/stm32f0/stm32f0_i2c.h index 29bcbdccd1..dd127b788a 100644 --- a/arch/arm/src/stm32f0/stm32f0_i2c.h +++ b/arch/arm/src/stm32f0/stm32f0_i2c.h @@ -74,7 +74,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -90,7 +90,7 @@ FAR struct i2c_master_s *stm32f0_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32f0_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32f0/stm32f0_serial.c b/arch/arm/src/stm32f0/stm32f0_serial.c index 91d6cc9828..3231ebdf6d 100644 --- a/arch/arm/src/stm32f0/stm32f0_serial.c +++ b/arch/arm/src/stm32f0/stm32f0_serial.c @@ -1033,7 +1033,7 @@ static void stm32f0serial_setformat(FAR struct uart_dev_s *dev) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the USART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -1907,7 +1907,7 @@ static bool stm32f0serial_rxavailable(FAR struct uart_dev_s *dev) * Return true if USART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - USART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/arch/arm/src/stm32f7/stm32_adc.c b/arch/arm/src/stm32f7/stm32_adc.c index 0d226ab46a..587983c40a 100644 --- a/arch/arm/src/stm32f7/stm32_adc.c +++ b/arch/arm/src/stm32f7/stm32_adc.c @@ -568,7 +568,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_dma.c b/arch/arm/src/stm32f7/stm32_dma.c index a5d185944d..7a083e3239 100644 --- a/arch/arm/src/stm32f7/stm32_dma.c +++ b/arch/arm/src/stm32f7/stm32_dma.c @@ -527,7 +527,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * dmamap - Identifies the stream/channel resource. For the STM32 F7, this * is a bit-encoded value as provided by the DMAMAP_* definitions * in chip/stm32f7xxxxxxx_dma.h @@ -874,7 +874,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * ccr. * ccr - DMA stream configuration register * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_dma.h b/arch/arm/src/stm32f7/stm32_dma.h index e0494d5381..567e233064 100644 --- a/arch/arm/src/stm32f7/stm32_dma.h +++ b/arch/arm/src/stm32f7/stm32_dma.h @@ -135,7 +135,7 @@ extern "C" * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * For the STM32 F7, this is a bit encoded value as provided by the * the DMAMAP_* definitions in chip/stm32f7xxxxxxx_dma.h @@ -248,7 +248,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle); * ccr. * ccr - DMA stream configuration register * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_dma2d.c b/arch/arm/src/stm32f7/stm32_dma2d.c index 8e6276484e..9e952d2ead 100644 --- a/arch/arm/src/stm32f7/stm32_dma2d.c +++ b/arch/arm/src/stm32f7/stm32_dma2d.c @@ -481,7 +481,7 @@ static int stm32_dma2dirq(int irq, void *context, FAR void *arg) * loading or dma transfer was completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * On success OK otherwise ERROR * ****************************************************************************/ @@ -526,7 +526,7 @@ static int stm32_dma2d_waitforirq(void) * Parameter: * pfcreg - PFC control Register * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -614,7 +614,7 @@ static int stm32_dma2d_start(void) * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * memory address * ****************************************************************************/ @@ -640,7 +640,7 @@ static uint32_t stm32_dma2d_memaddress(FAR const struct stm32_dma2d_s *layer, * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * line offset * ****************************************************************************/ @@ -664,7 +664,7 @@ static fb_coord_t stm32_dma2d_lineoffset(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the common layer state structure * fmt - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -723,7 +723,7 @@ static int stm32_dma2d_pixelformat(uint8_t fmt, uint8_t *fmtmap) * layer - Reference to the common layer state structure * bpp - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -764,7 +764,7 @@ static int stm32_dma2d_bpp(uint8_t fmt, uint8_t *bpp) * Description: * Get a free layer id * - * Return: + * Returned Value: * The number of the free layer * -1 if no free layer is available * @@ -791,7 +791,7 @@ static int stm32_dma2d_lfreelid(void) * Description: * Allocate a new layer structure * - * Return: + * Returned Value: * A new allocated layer structure or NULL on error. * ****************************************************************************/ @@ -880,7 +880,7 @@ static void stm32_dma2d_llayerscleanup(void) * Description: * Helper to validate if the layer is valid * - * Return: + * Returned Value: * true if validates otherwise false * ****************************************************************************/ @@ -902,7 +902,7 @@ static inline bool stm32_dma2d_lvalidate(FAR const struct stm32_dma2d_s *layer) * ypos - The y position inside the whole layer * area - the area inside the whole layer * - * Return: + * Returned Value: * true if area is inside the whole layer otherwise false * ****************************************************************************/ @@ -1156,7 +1156,7 @@ static void stm32_dma2d_lpfc(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1193,7 +1193,7 @@ static int stm32_dma2dgetvideoinfo(FAR struct dma2d_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1229,7 +1229,7 @@ static int stm32_dma2dgetplaneinfo(FAR struct dma2d_layer_s *layer, int planeno, * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1265,7 +1265,7 @@ static int stm32_dma2dgetlid(FAR struct dma2d_layer_s *layer, int *lid) * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1384,7 +1384,7 @@ static int stm32_dma2dsetclut(FAR struct dma2d_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1476,7 +1476,7 @@ static int stm32_dma2dgetclut(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1511,7 +1511,7 @@ static int stm32_dma2dsetalpha(FAR struct dma2d_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1548,7 +1548,7 @@ static int stm32_dma2dgetalpha(FAR struct dma2d_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1597,7 +1597,7 @@ static int stm32_dma2dsetblendmode(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1637,7 +1637,7 @@ static int stm32_dma2dgetblendmode(FAR struct dma2d_layer_s *layer, * src - Valid reference to the source layer * srcarea - Valid reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1746,7 +1746,7 @@ static int stm32_dma2dblit(FAR struct dma2d_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1853,7 +1853,7 @@ static int stm32_dma2dblend(FAR struct dma2d_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -1929,7 +1929,7 @@ static int stm32_dma2dfillarea(FAR struct dma2d_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -1962,7 +1962,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid) * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * @@ -2082,7 +2082,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2124,7 +2124,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer) * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * @@ -2240,7 +2240,7 @@ void up_dma2duninitialize(void) * layer - a valid reference to the low level ltdc layer structure * clut - a pointer to a valid memory region to hold 256 clut colors * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * diff --git a/arch/arm/src/stm32f7/stm32_dma2d.h b/arch/arm/src/stm32f7/stm32_dma2d.h index 26d9f0faa8..9ffc8289cd 100644 --- a/arch/arm/src/stm32f7/stm32_dma2d.h +++ b/arch/arm/src/stm32f7/stm32_dma2d.h @@ -74,7 +74,7 @@ struct dma2d_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -92,7 +92,7 @@ struct dma2d_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -109,7 +109,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -127,7 +127,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -145,7 +145,7 @@ struct dma2d_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -167,7 +167,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -183,7 +183,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -201,7 +201,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -230,7 +230,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -250,7 +250,7 @@ struct dma2d_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -281,7 +281,7 @@ struct dma2d_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -308,7 +308,7 @@ struct dma2d_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected area outside the visible area of the layer. @@ -340,7 +340,7 @@ struct stm32_ltdc_s; /* Forward declaration */ * Parameter: * layer - a valid reference to the low level ltdc layer structure * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -358,7 +358,7 @@ FAR struct dma2d_layer_s *stm32_dma2dinitltdc(FAR struct stm32_ltdc_s *layer); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -377,7 +377,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid); * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -399,7 +399,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -413,7 +413,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer); * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * diff --git a/arch/arm/src/stm32f7/stm32_exti_alarm.c b/arch/arm/src/stm32f7/stm32_exti_alarm.c index 8fba01b53a..552241b490 100644 --- a/arch/arm/src/stm32f7/stm32_exti_alarm.c +++ b/arch/arm/src/stm32f7/stm32_exti_alarm.c @@ -116,7 +116,7 @@ static int stm32_exti_alarm_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32f7/stm32_exti_pwr.c b/arch/arm/src/stm32f7/stm32_exti_pwr.c index 3c4f2d07a3..f521aaff24 100644 --- a/arch/arm/src/stm32f7/stm32_exti_pwr.c +++ b/arch/arm/src/stm32f7/stm32_exti_pwr.c @@ -122,7 +122,7 @@ static int stm32_exti_pvd_isr(int irq, void *context, void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32f7/stm32_exti_pwr.h b/arch/arm/src/stm32f7/stm32_exti_pwr.h index 67e22d05ff..90b0185d59 100644 --- a/arch/arm/src/stm32f7/stm32_exti_pwr.h +++ b/arch/arm/src/stm32f7/stm32_exti_pwr.h @@ -60,7 +60,7 @@ * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32f7/stm32_gpio.c b/arch/arm/src/stm32f7/stm32_gpio.c index e9b3f0d8a9..cf153dd482 100644 --- a/arch/arm/src/stm32f7/stm32_gpio.c +++ b/arch/arm/src/stm32f7/stm32_gpio.c @@ -136,7 +136,7 @@ void stm32_gpioinit(void) * function, it must be unconfigured with stm32_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono value on invalid port, or when pin is locked as ALT * function. @@ -359,7 +359,7 @@ int stm32_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32f7/stm32_i2c.h b/arch/arm/src/stm32f7/stm32_i2c.h index c560817638..e2223f53c8 100644 --- a/arch/arm/src/stm32f7/stm32_i2c.h +++ b/arch/arm/src/stm32f7/stm32_i2c.h @@ -74,7 +74,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -90,7 +90,7 @@ FAR struct i2c_master_s *stm32_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_ltdc.c b/arch/arm/src/stm32f7/stm32_ltdc.c index 3a992d928f..c84b766fa2 100644 --- a/arch/arm/src/stm32f7/stm32_ltdc.c +++ b/arch/arm/src/stm32f7/stm32_ltdc.c @@ -1168,7 +1168,7 @@ static int stm32_ltdcirq(int irq, void *context, FAR void *arg) * that a register reload was been completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * OK - On success otherwise ERROR * ****************************************************************************/ @@ -1467,7 +1467,7 @@ static inline uint8_t stm32_ltdc_lgetopac(FAR struct stm32_layer_s *layer) * Parameter: * layer - Reference to the layer control structure * - * Return: + * Returned Value: * true - layer valid * false - layer invalid * @@ -1497,7 +1497,7 @@ static inline bool stm32_ltdc_lvalidate(FAR const struct stm32_layer_s *layer) * srcxpos - Top left x position from where data visible in the active area * srcypos - Top left y position from where data visible in the active area * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1968,7 +1968,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer) * layer - Reference to the layer control structure * color - The color to clear * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * @@ -2182,7 +2182,7 @@ static void stm32_ltdc_linit(int lid) * vtable - The framebuffer driver object * vinfo - the videoinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2217,7 +2217,7 @@ static int stm32_getvideoinfo(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * pinfo - the planeinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2252,7 +2252,7 @@ static int stm32_getplaneinfo(struct fb_vtable_s *vtable, int planeno, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2279,7 +2279,7 @@ static int stm32_getcmap(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2306,7 +2306,7 @@ static int stm32_putcmap(struct fb_vtable_s *vtable, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2340,7 +2340,7 @@ static int stm32_lgetvideoinfo(struct ltdc_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2374,7 +2374,7 @@ static int stm32_lgetplaneinfo(struct ltdc_layer_s *layer, int planeno, * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2434,7 +2434,7 @@ static int stm32_setclut(struct ltdc_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2533,7 +2533,7 @@ static int stm32_getclut(struct ltdc_layer_s *layer, * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * OK - On success * Null if invalid flag * @@ -2610,7 +2610,7 @@ static int stm32_getlid(FAR struct ltdc_layer_s *layer, int *lid, * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2646,7 +2646,7 @@ static int stm32_setcolor(FAR struct ltdc_layer_s *layer, uint32_t argb) * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2683,7 +2683,7 @@ static int stm32_getcolor(FAR struct ltdc_layer_s *layer, uint32_t *argb) * layer - Reference to the layer structure * rgb - RGB888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2719,7 +2719,7 @@ static int stm32_setcolorkey(FAR struct ltdc_layer_s *layer, uint32_t rgb) * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2760,7 +2760,7 @@ static int stm32_getcolorkey(FAR struct ltdc_layer_s *layer, uint32_t *rgb) * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2796,7 +2796,7 @@ static int stm32_setalpha(FAR struct ltdc_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2833,7 +2833,7 @@ static int stm32_getalpha(FAR struct ltdc_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2965,7 +2965,7 @@ static int stm32_setblendmode(FAR struct ltdc_layer_s *layer, uint32_t mode) * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL ****************************************************************************/ @@ -3004,7 +3004,7 @@ static int stm32_getblendmode(FAR struct ltdc_layer_s *layer, uint32_t *mode) * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3066,7 +3066,7 @@ static int stm32_setarea(FAR struct ltdc_layer_s *layer, * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3106,7 +3106,7 @@ static int stm32_getarea(FAR struct ltdc_layer_s *layer, * layer - Reference to the layer structure * mode - operation mode * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -3269,7 +3269,7 @@ static int stm32_update(FAR struct ltdc_layer_s *layer, uint32_t mode) * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3320,7 +3320,7 @@ static int stm32_blit(FAR struct ltdc_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3370,7 +3370,7 @@ static int stm32_blend(FAR struct ltdc_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -3412,7 +3412,7 @@ static int stm32_fillarea(FAR struct ltdc_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if lid * is invalid. * @@ -3452,7 +3452,7 @@ void stm32_ltdcreset(void) * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ****************************************************************************/ @@ -3541,10 +3541,10 @@ int stm32_ltdcinitialize(void) * Return a a reference to the framebuffer object for the specified video * plane. * - * Input parameters: + * Input Parameters: * None * - * Returned value: + * Returned Value: * Reference to the framebuffer object (NULL on failure) * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_ltdc.h b/arch/arm/src/stm32f7/stm32_ltdc.h index 8b3593e86d..c2226ec43e 100644 --- a/arch/arm/src/stm32f7/stm32_ltdc.h +++ b/arch/arm/src/stm32f7/stm32_ltdc.h @@ -125,7 +125,7 @@ struct ltdc_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -143,7 +143,7 @@ struct ltdc_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -163,7 +163,7 @@ struct ltdc_layer_s * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -184,7 +184,7 @@ struct ltdc_layer_s * enable - Enable or disable clut support (if false cmap is ignored and can * be NULL) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -202,7 +202,7 @@ struct ltdc_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -221,7 +221,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -237,7 +237,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -255,7 +255,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -271,7 +271,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -293,7 +293,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -309,7 +309,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -327,7 +327,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -365,7 +365,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -392,7 +392,7 @@ struct ltdc_layer_s * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -418,7 +418,7 @@ struct ltdc_layer_s * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -437,7 +437,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - operation mode (see LTDC_UPDATE_*) * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -481,7 +481,7 @@ struct ltdc_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -510,7 +510,7 @@ struct ltdc_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -535,7 +535,7 @@ struct ltdc_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -609,7 +609,7 @@ struct stm32_ltdc_s * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ************************************************************************************/ @@ -627,7 +627,7 @@ void stm32_ltdcuninitialize(void); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if parameter * invalid. * diff --git a/arch/arm/src/stm32f7/stm32_otghost.c b/arch/arm/src/stm32f7/stm32_otghost.c index 548a6f393d..1a9b8c1fea 100644 --- a/arch/arm/src/stm32f7/stm32_otghost.c +++ b/arch/arm/src/stm32f7/stm32_otghost.c @@ -1265,7 +1265,7 @@ static int stm32_ctrlchan_alloc(FAR struct stm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -1327,7 +1327,7 @@ static int stm32_ctrlep_alloc(FAR struct stm32_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -3819,7 +3819,7 @@ static void stm32_txfe_enable(FAR struct stm32_usbhost_s *priv, int chidx) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3910,7 +3910,7 @@ static int stm32_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4040,7 +4040,7 @@ static int stm32_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4099,7 +4099,7 @@ static int stm32_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4155,7 +4155,7 @@ static int stm32_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpoint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4223,7 +4223,7 @@ static int stm32_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4269,7 +4269,7 @@ static int stm32_alloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4305,7 +4305,7 @@ static int stm32_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4349,7 +4349,7 @@ static int stm32_ioalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4392,7 +4392,7 @@ static int stm32_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4595,7 +4595,7 @@ static int stm32_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4667,7 +4667,7 @@ static ssize_t stm32_transfer(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4723,7 +4723,7 @@ static int stm32_asynch(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep, * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4812,7 +4812,7 @@ static int stm32_cancel(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4864,7 +4864,7 @@ static int stm32_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32f7/stm32_pwr.c b/arch/arm/src/stm32f7/stm32_pwr.c index c9d2d5dae4..573796a788 100644 --- a/arch/arm/src/stm32f7/stm32_pwr.c +++ b/arch/arm/src/stm32f7/stm32_pwr.c @@ -200,7 +200,7 @@ void stm32_pwr_enablebkp(bool writable) * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ @@ -229,7 +229,7 @@ void stm32_pwr_enablebreg(bool regon) * Input Parameters: * vos - Properly aligned voltage scaling select bits for the PWR_CR register. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -264,7 +264,7 @@ void stm32_pwr_setvos(uint16_t vos) * Input Parameters: * pls - PVD level * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32f7/stm32_pwr.h b/arch/arm/src/stm32f7/stm32_pwr.h index c80de12ae1..b332e424a0 100644 --- a/arch/arm/src/stm32f7/stm32_pwr.h +++ b/arch/arm/src/stm32f7/stm32_pwr.h @@ -119,7 +119,7 @@ void stm32_pwr_enablebkp(bool writable); * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_sdmmc.c b/arch/arm/src/stm32f7/stm32_sdmmc.c index c3530fc3fe..86481dd42f 100644 --- a/arch/arm/src/stm32f7/stm32_sdmmc.c +++ b/arch/arm/src/stm32f7/stm32_sdmmc.c @@ -3157,7 +3157,7 @@ static void stm32_default(struct stm32_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3293,7 +3293,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -3340,7 +3340,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_sdmmc.h b/arch/arm/src/stm32f7/stm32_sdmmc.h index 8e722497c5..095af54805 100644 --- a/arch/arm/src/stm32f7/stm32_sdmmc.h +++ b/arch/arm/src/stm32f7/stm32_sdmmc.h @@ -72,7 +72,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -94,7 +94,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -112,7 +112,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_serial.c b/arch/arm/src/stm32f7/stm32_serial.c index 3f639e178e..ba6edead30 100644 --- a/arch/arm/src/stm32f7/stm32_serial.c +++ b/arch/arm/src/stm32f7/stm32_serial.c @@ -1369,7 +1369,7 @@ static void up_set_format(struct uart_dev_s *dev) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the UART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2235,7 +2235,7 @@ static bool up_rxavailable(struct uart_dev_s *dev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/arch/arm/src/stm32f7/stm32_spi.c b/arch/arm/src/stm32f7/stm32_spi.c index 9278ebaad7..cd1dc67989 100644 --- a/arch/arm/src/stm32f7/stm32_spi.c +++ b/arch/arm/src/stm32f7/stm32_spi.c @@ -1699,7 +1699,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI bus in its default state (Master, 8-bit, mode 0, etc.) * - * Input Parameter: + * Input Parameters: * priv - private SPI device structure * * Returned Value: @@ -1788,7 +1788,7 @@ static void spi_bus_initialize(FAR struct stm32_spidev_s *priv) * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_spi.h b/arch/arm/src/stm32f7/stm32_spi.h index 2775107356..f8c1ee9a1f 100644 --- a/arch/arm/src/stm32f7/stm32_spi.h +++ b/arch/arm/src/stm32f7/stm32_spi.h @@ -71,7 +71,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * bus number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_tim.h b/arch/arm/src/stm32f7/stm32_tim.h index 5f3bf82c10..06d7fe8e84 100644 --- a/arch/arm/src/stm32f7/stm32_tim.h +++ b/arch/arm/src/stm32f7/stm32_tim.h @@ -196,7 +196,7 @@ int stm32_tim_deinit(FAR struct stm32_tim_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_adc.c b/arch/arm/src/stm32l4/stm32l4_adc.c index 56a9ae81d7..2576ec182e 100644 --- a/arch/arm/src/stm32l4/stm32l4_adc.c +++ b/arch/arm/src/stm32l4/stm32l4_adc.c @@ -592,7 +592,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_can.c b/arch/arm/src/stm32l4/stm32l4_can.c index 7667481c6c..2bc5dcd2e6 100644 --- a/arch/arm/src/stm32l4/stm32l4_can.c +++ b/arch/arm/src/stm32l4/stm32l4_can.c @@ -1627,7 +1627,7 @@ static int stm32l4can_txinterrupt(int irq, FAR void *context, FAR void *arg) * Where: * Tpclk1 is the period of the APB1 clock (PCLK1). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1726,7 +1726,7 @@ static int stm32l4can_bittiming(FAR struct stm32l4_can_s *priv) * peripheral, no registers are changed. The initialization mode is * required to change the baud rate. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1777,7 +1777,7 @@ static int stm32l4can_enterinitmode(FAR struct stm32l4_can_s *priv) * Description: * Put the CAN cell out of the Initialization mode (to Normal mode) * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1827,7 +1827,7 @@ static int stm32l4can_exitinitmode(FAR struct stm32l4_can_s *priv) * Description: * CAN cell initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1905,7 +1905,7 @@ static int stm32l4can_cellinit(FAR struct stm32l4_can_s *priv) * are set to zero thus supressing all filtering because anything masked * with zero matches zero. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1981,7 +1981,7 @@ static int stm32l4can_filterinit(FAR struct stm32l4_can_s *priv) * Description: * Add a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2006,7 +2006,7 @@ static int stm32l4can_addextfilter(FAR struct stm32l4_can_s *priv, * Description: * Remove a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_EXTFILTER command @@ -2031,7 +2031,7 @@ static int stm32l4can_delextfilter(FAR struct stm32l4_can_s *priv, int arg) * Description: * Add a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2054,7 +2054,7 @@ static int stm32l4can_addstdfilter(FAR struct stm32l4_can_s *priv, * Description: * Remove a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_STDFILTER command @@ -2081,7 +2081,7 @@ static int stm32l4can_delstdfilter(FAR struct stm32l4_can_s *priv, int arg) * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_can.h b/arch/arm/src/stm32l4/stm32l4_can.h index ded35c173b..c7ff34733d 100644 --- a/arch/arm/src/stm32l4/stm32l4_can.h +++ b/arch/arm/src/stm32l4/stm32l4_can.h @@ -122,7 +122,7 @@ extern "C" * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_comp.c b/arch/arm/src/stm32l4/stm32l4_comp.c index 8e2f4ff908..0c954c7c8b 100644 --- a/arch/arm/src/stm32l4/stm32l4_comp.c +++ b/arch/arm/src/stm32l4/stm32l4_comp.c @@ -342,7 +342,7 @@ static int stm32l4_exti_comp_isr(int irq, void *context, FAR void *arg) * Parameters: * cfg - configuration * - * Returns: + * Returned Value: * 0 on success, a negated errno value on failure * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_dfsdm.c b/arch/arm/src/stm32l4/stm32l4_dfsdm.c index 89a57ea86e..4e54b77c51 100644 --- a/arch/arm/src/stm32l4/stm32l4_dfsdm.c +++ b/arch/arm/src/stm32l4/stm32l4_dfsdm.c @@ -545,7 +545,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the DFSDM block status * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_dma.h b/arch/arm/src/stm32l4/stm32l4_dma.h index 5eb679be70..c312465267 100644 --- a/arch/arm/src/stm32l4/stm32l4_dma.h +++ b/arch/arm/src/stm32l4/stm32l4_dma.h @@ -145,7 +145,7 @@ extern "C" * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * This is a bit encoded value as provided by the DMACHAN_* definitions * in chip/stm32l4x6xx_dma.h @@ -249,7 +249,7 @@ size_t stm32l4_dmaresidual(DMA_HANDLE handle); * only applies to memory addresses, it will return false for any peripheral * address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_exti.h b/arch/arm/src/stm32l4/stm32l4_exti.h index 14d2e7100a..098ac6e720 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti.h +++ b/arch/arm/src/stm32l4/stm32l4_exti.h @@ -101,7 +101,7 @@ int stm32l4_gpiosetevent(uint32_t pinset, bool risingedge, bool fallingedge, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * @@ -124,7 +124,7 @@ int stm32l4_exti_alarm(bool risingedge, bool fallingedge, bool event, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * @@ -148,7 +148,7 @@ int stm32l4_exti_wakeup(bool risingedge, bool fallingedge, bool event, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_alarm.c b/arch/arm/src/stm32l4/stm32l4_exti_alarm.c index 2a0b3fbb0e..e0016e0637 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_alarm.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_alarm.c @@ -108,7 +108,7 @@ static int stm32l4_exti_alarm_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_comp.c b/arch/arm/src/stm32l4/stm32l4_exti_comp.c index 147eb3f4b4..44d029e0b3 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_comp.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_comp.c @@ -129,7 +129,7 @@ static int stm32l4_exti_comp_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_pwr.c b/arch/arm/src/stm32l4/stm32l4_exti_pwr.c index ab19f6f3cb..7d5df67098 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_pwr.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_pwr.c @@ -113,7 +113,7 @@ static int stm32l4_exti_pvd_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_pwr.h b/arch/arm/src/stm32l4/stm32l4_exti_pwr.h index 27e584779b..c6e10a0fa7 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_pwr.h +++ b/arch/arm/src/stm32l4/stm32l4_exti_pwr.h @@ -59,7 +59,7 @@ * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c b/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c index 195cf2c1ac..ddac94add3 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c @@ -107,7 +107,7 @@ static int stm32l4_exti_wakeup_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_gpio.c b/arch/arm/src/stm32l4/stm32l4_gpio.c index f46f341662..a33b88c08f 100644 --- a/arch/arm/src/stm32l4/stm32l4_gpio.c +++ b/arch/arm/src/stm32l4/stm32l4_gpio.c @@ -129,7 +129,7 @@ void stm32l4_gpioinit(void) * function, it must be unconfigured with stm32l4_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono valu on invalid port, or when pin is locked as ALT * function. @@ -351,7 +351,7 @@ int stm32l4_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32l4/stm32l4_gpio.h b/arch/arm/src/stm32l4/stm32l4_gpio.h index 3c7b615c4e..56fb77a6bb 100644 --- a/arch/arm/src/stm32l4/stm32l4_gpio.h +++ b/arch/arm/src/stm32l4/stm32l4_gpio.h @@ -273,7 +273,7 @@ EXTERN const uint32_t g_gpiobase[STM32L4_NPORTS]; * function, it must be unconfigured with stm32l4_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * @@ -294,7 +294,7 @@ int stm32l4_configgpio(uint32_t cfgset); * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port * diff --git a/arch/arm/src/stm32l4/stm32l4_i2c.h b/arch/arm/src/stm32l4/stm32l4_i2c.h index 267ee1d664..3a38cc14bd 100644 --- a/arch/arm/src/stm32l4/stm32l4_i2c.h +++ b/arch/arm/src/stm32l4/stm32l4_i2c.h @@ -74,7 +74,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -90,7 +90,7 @@ FAR struct i2c_master_s *stm32l4_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32l4_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_iwdg.c b/arch/arm/src/stm32l4/stm32l4_iwdg.c index 9977e4d727..bf0b1392bb 100644 --- a/arch/arm/src/stm32l4/stm32l4_iwdg.c +++ b/arch/arm/src/stm32l4/stm32l4_iwdg.c @@ -312,7 +312,7 @@ static inline void stm32l4_setprescaler(FAR struct stm32l4_lowerhalf_s *priv) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -360,7 +360,7 @@ static int stm32l4_start(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -385,7 +385,7 @@ static int stm32l4_stop(FAR struct watchdog_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -418,7 +418,7 @@ static int stm32l4_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -477,7 +477,7 @@ static int stm32l4_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -602,7 +602,7 @@ static int stm32l4_settimeout(FAR struct watchdog_lowerhalf_s *lower, * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_otgfshost.c b/arch/arm/src/stm32l4/stm32l4_otgfshost.c index b7e952d231..e676d9504f 100644 --- a/arch/arm/src/stm32l4/stm32l4_otgfshost.c +++ b/arch/arm/src/stm32l4/stm32l4_otgfshost.c @@ -1267,7 +1267,7 @@ static int stm32l4_ctrlchan_alloc(FAR struct stm32l4_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1329,7 +1329,7 @@ static int stm32l4_ctrlep_alloc(FAR struct stm32l4_usbhost_s *priv, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -3825,7 +3825,7 @@ static void stm32l4_txfe_enable(FAR struct stm32l4_usbhost_s *priv, int chidx) * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -3916,7 +3916,7 @@ static int stm32l4_wait(FAR struct usbhost_connection_s *conn, * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4046,7 +4046,7 @@ static int stm32l4_enumerate(FAR struct usbhost_connection_s *conn, * maxpacketsize - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4105,7 +4105,7 @@ static int stm32l4_ep0configure(FAR struct usbhost_driver_s *drvr, * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4161,7 +4161,7 @@ static int stm32l4_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpoint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4229,7 +4229,7 @@ static int stm32l4_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4275,7 +4275,7 @@ static int stm32l4_alloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4311,7 +4311,7 @@ static int stm32l4_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer) * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4355,7 +4355,7 @@ static int stm32l4_ioalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4398,7 +4398,7 @@ static int stm32l4_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4601,7 +4601,7 @@ static int stm32l4_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -4673,7 +4673,7 @@ static ssize_t stm32l4_transfer(FAR struct usbhost_driver_s *drvr, usbhost_ep_t * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -4729,7 +4729,7 @@ static int stm32l4_asynch(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep, * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4818,7 +4818,7 @@ static int stm32l4_cancel(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep) * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -4870,7 +4870,7 @@ static int stm32l4_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32l4/stm32l4_pm.h b/arch/arm/src/stm32l4/stm32l4_pm.h index fd94299389..530be06fcb 100644 --- a/arch/arm/src/stm32l4/stm32l4_pm.h +++ b/arch/arm/src/stm32l4/stm32l4_pm.h @@ -108,7 +108,7 @@ int stm32l4_pmstop2(void); * Input Parameters: * None * - * Returned Value. + * Returned Value: * On success, this function will not return (STANDBY mode can only be * terminated with a reset event). Otherwise, STANDBY mode did not occur * and a negated errno value is returned to indicate the cause of the diff --git a/arch/arm/src/stm32l4/stm32l4_pminitialize.c b/arch/arm/src/stm32l4/stm32l4_pminitialize.c index 05988f21bf..89a8547a58 100644 --- a/arch/arm/src/stm32l4/stm32l4_pminitialize.c +++ b/arch/arm/src/stm32l4/stm32l4_pminitialize.c @@ -60,10 +60,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_pmstandby.c b/arch/arm/src/stm32l4/stm32l4_pmstandby.c index c8730c14f9..331d8446f3 100644 --- a/arch/arm/src/stm32l4/stm32l4_pmstandby.c +++ b/arch/arm/src/stm32l4/stm32l4_pmstandby.c @@ -60,7 +60,7 @@ * Input Parameters: * None * - * Returned Value. + * Returned Value: * On success, this function will not return (STANDBY mode can only be * terminated with a reset event). Otherwise, STANDBY mode did not occur * and a negated errno value is returned to indicate the cause of the diff --git a/arch/arm/src/stm32l4/stm32l4_pwm.c b/arch/arm/src/stm32l4/stm32l4_pwm.c index 10531d20a8..0363944584 100644 --- a/arch/arm/src/stm32l4/stm32l4_pwm.c +++ b/arch/arm/src/stm32l4/stm32l4_pwm.c @@ -676,7 +676,7 @@ static void stm32l4pwm_putreg(struct stm32l4_pwmtimer_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -734,7 +734,7 @@ static void stm32l4pwm_dumpregs(struct stm32l4_pwmtimer_s *priv, * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -1360,7 +1360,7 @@ static int stm32l4pwm_timer(FAR struct stm32l4_pwmtimer_s *priv, * Description: * Try to change only channel duty. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * channel - Channel to by updated * duty - New duty. @@ -1442,7 +1442,7 @@ static int stm32l4pwm_update_duty(FAR struct stm32l4_pwmtimer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -1525,7 +1525,7 @@ static int stm32l4pwm_interrupt(struct stm32l4_pwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -1553,7 +1553,7 @@ static int stm32l4pwm_tim8interrupt(int irq, void *context, FAR void *arg) * Description: * Pick an optimal pulse count to program the RCR. * - * Input parameters: + * Input Parameters: * count - The total count remaining * * Returned Value: @@ -1600,7 +1600,7 @@ static uint8_t stm32l4pwm_pulsecount(uint32_t count) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -1693,7 +1693,7 @@ static void stm32l4pwm_setapbclock(FAR struct stm32l4_pwmtimer_s *priv, bool on) * should configure and initialize the device so that it is ready for use. * It should not, however, output pulses until the start method is called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -1755,7 +1755,7 @@ static int stm32l4pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -1816,7 +1816,7 @@ static int stm32l4pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -1903,7 +1903,7 @@ static int stm32l4pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -2020,7 +2020,7 @@ static int stm32l4pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/stm32l4/stm32l4_qencoder.c b/arch/arm/src/stm32l4/stm32l4_qencoder.c index 9f8a20fc9f..683b2f6263 100644 --- a/arch/arm/src/stm32l4/stm32l4_qencoder.c +++ b/arch/arm/src/stm32l4/stm32l4_qencoder.c @@ -504,7 +504,7 @@ static void stm32l4_putreg32(FAR struct stm32l4_lowerhalf_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the QENCODER block status * * Returned Value: @@ -1108,7 +1108,7 @@ static int stm32l4_ioctl(FAR struct qe_lowerhalf_s *lower, int cmd, unsigned lon * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_qencoder.h b/arch/arm/src/stm32l4/stm32l4_qencoder.h index 7fccca772b..b2d2b445c6 100644 --- a/arch/arm/src/stm32l4/stm32l4_qencoder.h +++ b/arch/arm/src/stm32l4/stm32l4_qencoder.h @@ -129,7 +129,7 @@ * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_qspi.c b/arch/arm/src/stm32l4/stm32l4_qspi.c index 025e71f6d1..cf303e71b4 100644 --- a/arch/arm/src/stm32l4/stm32l4_qspi.c +++ b/arch/arm/src/stm32l4/stm32l4_qspi.c @@ -2421,7 +2421,7 @@ static int qspi_hw_initialize(struct stm32l4_qspidev_s *priv) * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: @@ -2594,7 +2594,7 @@ errout_with_dmahandles: * Description: * Put the QSPI device into memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * meminfo - parameters like for a memory transfer used for reading * @@ -2686,7 +2686,7 @@ void stm32l4_qspi_enter_memorymapped(struct qspi_dev_s* dev, * Description: * Take the QSPI device out of memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_qspi.h b/arch/arm/src/stm32l4/stm32l4_qspi.h index ed65850fc5..c9c87638ee 100644 --- a/arch/arm/src/stm32l4/stm32l4_qspi.h +++ b/arch/arm/src/stm32l4/stm32l4_qspi.h @@ -86,7 +86,7 @@ extern "C" * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: @@ -103,7 +103,7 @@ FAR struct qspi_dev_s *stm32l4_qspi_initialize(int intf); * Description: * Put the QSPI device into memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * meminfo - parameters like for a memory transfer used for reading * lpto - number of cycles to wait to automatically de-assert CS @@ -123,7 +123,7 @@ void stm32l4_qspi_enter_memorymapped(struct qspi_dev_s* dev, * Description: * Take the QSPI device out of memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_sai.c b/arch/arm/src/stm32l4/stm32l4_sai.c index 80d07f024f..21892409d5 100644 --- a/arch/arm/src/stm32l4/stm32l4_sai.c +++ b/arch/arm/src/stm32l4/stm32l4_sai.c @@ -479,7 +479,7 @@ static void sai_exclsem_take(struct stm32l4_sai_s *priv) * Setup the master clock divider based on the currently selected data width * and the sample rate * - * Input Parameter: + * Input Parameters: * priv - SAI device structure (only the sample rate and frequency are * needed at this point). * @@ -1288,7 +1288,7 @@ static void sai_buf_initialize(struct stm32l4_sai_s *priv) * Description: * Initialize the selected SAI port in its default state * - * Input Parameter: + * Input Parameters: * priv - private SAI device structure * * Returned Value: @@ -1353,7 +1353,7 @@ static void sai_portinitialize(struct stm32l4_sai_s *priv) * Description: * Initialize the selected SAI block * - * Input Parameter: + * Input Parameters: * intf - I2S interface number (identifying the "logical" SAI interface) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_sdmmc.c b/arch/arm/src/stm32l4/stm32l4_sdmmc.c index 2078c16258..38a7077d07 100644 --- a/arch/arm/src/stm32l4/stm32l4_sdmmc.c +++ b/arch/arm/src/stm32l4/stm32l4_sdmmc.c @@ -3099,7 +3099,7 @@ static void stm32_default(struct stm32_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3234,7 +3234,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno) * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -3281,7 +3281,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_sdmmc.h b/arch/arm/src/stm32l4/stm32l4_sdmmc.h index 155cf209f1..0882acbb74 100644 --- a/arch/arm/src/stm32l4/stm32l4_sdmmc.h +++ b/arch/arm/src/stm32l4/stm32l4_sdmmc.h @@ -73,7 +73,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -95,7 +95,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -113,7 +113,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_serial.c b/arch/arm/src/stm32l4/stm32l4_serial.c index 67602e3c16..1cc67bb148 100644 --- a/arch/arm/src/stm32l4/stm32l4_serial.c +++ b/arch/arm/src/stm32l4/stm32l4_serial.c @@ -1218,7 +1218,7 @@ void stm32l4serial_pm_setsuspend(bool suspend) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the UART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2100,7 +2100,7 @@ static bool stm32l4serial_rxavailable(FAR struct uart_dev_s *dev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/arch/arm/src/stm32l4/stm32l4_spi.c b/arch/arm/src/stm32l4/stm32l4_spi.c index 7f5d1543a1..b98bd793e2 100644 --- a/arch/arm/src/stm32l4/stm32l4_spi.c +++ b/arch/arm/src/stm32l4/stm32l4_spi.c @@ -1481,7 +1481,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI bus in its default state (Master, 8-bit, mode 0, etc.) * - * Input Parameter: + * Input Parameters: * priv - private SPI device structure * * Returned Value: @@ -1571,7 +1571,7 @@ static void spi_bus_initialize(FAR struct stm32l4_spidev_s *priv) * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_spi.h b/arch/arm/src/stm32l4/stm32l4_spi.h index 7f5390f347..5d9f74db70 100644 --- a/arch/arm/src/stm32l4/stm32l4_spi.h +++ b/arch/arm/src/stm32l4/stm32l4_spi.h @@ -76,7 +76,7 @@ struct spi_dev_s; * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * bus number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_tim.h b/arch/arm/src/stm32l4/stm32l4_tim.h index 8362ef1387..fa88892d3a 100644 --- a/arch/arm/src/stm32l4/stm32l4_tim.h +++ b/arch/arm/src/stm32l4/stm32l4_tim.h @@ -204,7 +204,7 @@ int stm32l4_tim_deinit(FAR struct stm32l4_tim_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c b/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c index 59918c81ba..76f5bff364 100644 --- a/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c +++ b/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c @@ -231,7 +231,7 @@ static struct stm32l4_lowerhalf_s g_tim17_lowerhalf = * * Input Parameters: * - * Returned Values: + * Returned Value: * ****************************************************************************/ @@ -267,7 +267,7 @@ static int stm32l4_timer_handler(int irq, void *context, void *arg) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -305,7 +305,7 @@ static int stm32l4_start(FAR struct timer_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -339,7 +339,7 @@ static int stm32l4_stop(FAR struct timer_lowerhalf_s *lower) * driver state structure. * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -385,7 +385,7 @@ static int stm32l4_settimeout(FAR struct timer_lowerhalf_s *lower, * behavior is restored, * arg - Argument that will be provided in the callback * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -432,7 +432,7 @@ static void stm32l4_setcallback(FAR struct timer_lowerhalf_s *lower, * form /dev/timer0 * timer - the timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_wdg.h b/arch/arm/src/stm32l4/stm32l4_wdg.h index 794c5e2aef..0d2b003253 100644 --- a/arch/arm/src/stm32l4/stm32l4_wdg.h +++ b/arch/arm/src/stm32l4/stm32l4_wdg.h @@ -79,7 +79,7 @@ extern "C" * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -100,7 +100,7 @@ void stm32l4_iwdginitialize(FAR const char *devpath, uint32_t lsifreq); * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4x6xx_dma.c b/arch/arm/src/stm32l4/stm32l4x6xx_dma.c index cd194b2cba..d727be752b 100644 --- a/arch/arm/src/stm32l4/stm32l4x6xx_dma.c +++ b/arch/arm/src/stm32l4/stm32l4x6xx_dma.c @@ -394,7 +394,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * This is a bit encoded value as provided by the DMACHAN_* definitions * in chip/stm32l4x6xx_dma.h @@ -642,7 +642,7 @@ size_t stm32l4_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/str71x/str71x.h b/arch/arm/src/str71x/str71x.h index 7b3bedf1df..aea504fe89 100644 --- a/arch/arm/src/str71x/str71x.h +++ b/arch/arm/src/str71x/str71x.h @@ -162,7 +162,7 @@ struct spi_dev_s; /* Forward reference */ * Initialize the selected SPI port. This function could get called * multiple times for each STR7 devices that needs an SPI reference. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_adc.h b/arch/arm/src/tiva/tiva_adc.h index 7f6edd4f9d..a717ad72f1 100644 --- a/arch/arm/src/tiva/tiva_adc.h +++ b/arch/arm/src/tiva/tiva_adc.h @@ -405,7 +405,7 @@ void tiva_adc_sample_rate(uint8_t rate); * to the FIFO. This is only required when the trigger source is set to the * processor. * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' sample sequencers to trigger * sse_mask - sample sequencer bitmask, each sse is 1 shifted by the sse * number. e.g. @@ -424,7 +424,7 @@ void tiva_adc_proc_trig(uint8_t adc, uint8_t sse_mask); * Description: * Returns raw interrupt status for the input ADC * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * ****************************************************************************/ @@ -440,12 +440,12 @@ uint32_t tiva_adc_int_status(uint8_t adc); * Sets the operation state of an ADC's sample sequencer (SSE). SSEs must * be configured before being enabled. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable state * - * Return value: + * Returned Value: * Actual state of the ACTSS register. * ****************************************************************************/ @@ -466,7 +466,7 @@ uint8_t tiva_adc_sse_enable(uint8_t adc, uint8_t sse, bool state); * - Always * - !!UNSUPPORTED: Comparators * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * trigger - interrupt trigger @@ -482,7 +482,7 @@ void tiva_adc_sse_trigger(uint8_t adc, uint8_t sse, uint32_t trigger); * Additional triggering configuration for PWM. Sets which PWM and which * generator. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * cfg - which PWM modulator and generator to use, use TIVA_ADC_PWM_TRIG @@ -501,7 +501,7 @@ void tiva_adc_sse_pwm_trig(uint8_t adc, uint8_t sse, uint32_t cfg); * Sets the interrupt state of an ADC's sample sequencer (SSE). SSEs must * be enabled before setting interrupt state. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable interrupt state @@ -516,7 +516,7 @@ void tiva_adc_sse_int_enable(uint8_t adc, uint8_t sse, bool state); * Description: * Returns interrupt status for the specificed SSE * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * sse - which SSE interrupt status to retrieve * @@ -530,7 +530,7 @@ bool tiva_adc_sse_int_status(uint8_t adc, uint8_t sse); * Description: * Clears the interrupt bit for the SSE. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer @@ -547,11 +547,11 @@ void tiva_adc_sse_clear_int(uint8_t adc, uint8_t sse); * The input data buffer MUST be as large or larger than the sample sequencer. * otherwise * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * - * Return value: + * Returned Value: * number of steps read from FIFO. * ****************************************************************************/ @@ -566,7 +566,7 @@ uint8_t tiva_adc_sse_data(uint8_t adc, uint8_t sse, int32_t *buf); * priority value ranges from 0 to 3, 0 being the highest priority, 3 being * the lowest. There can be no duplicate values. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * priority - conversion priority @@ -585,7 +585,7 @@ void tiva_adc_sse_priority(uint8_t adc, uint8_t sse, uint8_t priority); * * *SSEMUX only supported on TM4C129 devices * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer step @@ -601,7 +601,7 @@ void tiva_adc_sse_register_chn(uint8_t adc, uint8_t sse, uint8_t chn, uint32_t a * Description: * Sets the differential capability for a SSE. !! UNSUPPORTED * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -620,7 +620,7 @@ void tiva_adc_sse_differential(uint8_t adc, uint8_t sse, uint8_t chn, uint32_t d * This is not available on all devices, however on devices that do not * support this feature these reserved bits are ignored on write access. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -652,7 +652,7 @@ void tiva_adc_sse_sample_hold_time(uint8_t adc, uint8_t sse, uint8_t chn, uint32 * * *Comparator/Differential functionality is unsupported and ignored. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -669,7 +669,7 @@ void tiva_adc_sse_step_cfg(uint8_t adc, uint8_t sse, uint8_t chn, uint8_t cfg); * Dump all configured registers for the given ADC and SSE. This should * only be used to verify that configuration routines were accurate. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * diff --git a/arch/arm/src/tiva/tiva_adclib.c b/arch/arm/src/tiva/tiva_adclib.c index dc2768fc16..8d55333a02 100644 --- a/arch/arm/src/tiva/tiva_adclib.c +++ b/arch/arm/src/tiva/tiva_adclib.c @@ -624,7 +624,7 @@ void tiva_adc_sample_rate(uint8_t rate) * to the FIFO. This is only required when the trigger source is set to the * processor. * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' sample sequencers to trigger * sse_mask - sample sequencer bitmask, each sse is 1 shifted by the sse * number. e.g. @@ -650,7 +650,7 @@ void tiva_adc_proc_trig(uint8_t adc, uint8_t sse_mask) * Description: * Returns raw interrupt status for the input ADC * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * ****************************************************************************/ @@ -670,12 +670,12 @@ uint32_t tiva_adc_int_status(uint8_t adc) * Sets the operation state of an ADC's sample sequencer (SSE). SSEs must * be configured before being enabled. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable state * - * Return value: + * Returned Value: * Actual state of the ACTSS register. * ****************************************************************************/ @@ -711,7 +711,7 @@ uint8_t tiva_adc_sse_enable(uint8_t adc, uint8_t sse, bool state) * - Always * - !!UNSUPPORTED: Comparators * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * trigger - interrupt trigger @@ -736,7 +736,7 @@ void tiva_adc_sse_trigger(uint8_t adc, uint8_t sse, uint32_t trigger) * Additional triggering configuration for PWM. Sets which PWM and which * generator. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * cfg - which PWM modulator and generator to use, use TIVA_ADC_PWM_TRIG @@ -762,7 +762,7 @@ void tiva_adc_sse_pwm_trig(uint8_t adc, uint8_t sse, uint32_t cfg) * Sets the interrupt state of an ADC's sample sequencer (SSE). SSEs must * be enabled before setting interrupt state. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable interrupt state @@ -799,7 +799,7 @@ void tiva_adc_sse_int_enable(uint8_t adc, uint8_t sse, bool state) * Description: * Returns interrupt status for the specificed SSE * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * sse - which SSE interrupt status to retrieve * @@ -818,7 +818,7 @@ bool tiva_adc_sse_int_status(uint8_t adc, uint8_t sse) * Description: * Clears the interrupt bit for the SSE. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer @@ -839,11 +839,11 @@ void tiva_adc_sse_clear_int(uint8_t adc, uint8_t sse) * The input data buffer MUST be as large or larger than the sample sequencer. * otherwise * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * - * Return value: + * Returned Value: * number of steps read from FIFO. * ****************************************************************************/ @@ -880,7 +880,7 @@ uint8_t tiva_adc_sse_data(uint8_t adc, uint8_t sse, int32_t *buf) * priority value ranges from 0 to 3, 0 being the highest priority, 3 being * the lowest. There can be no duplicate values. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * priority - conversion priority @@ -906,7 +906,7 @@ void tiva_adc_sse_priority(uint8_t adc, uint8_t sse, uint8_t priority) * * *SSEMUX only supported on TM4C129 devices * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer step @@ -940,7 +940,7 @@ void tiva_adc_sse_register_chn(uint8_t adc, uint8_t sse, uint8_t chn, * Description: * Sets the differential capability for a SSE. !! UNSUPPORTED * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -970,7 +970,7 @@ void tiva_adc_sse_differential(uint8_t adc, uint8_t sse, uint8_t chn, uint32_t d * This is not available on all devices, however on devices that do not * support this feature these reserved bits are ignored on write access. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -1007,7 +1007,7 @@ void tiva_adc_sse_sample_hold_time(uint8_t adc, uint8_t sse, * * *Comparator/Differential functionality is unsupported and ignored. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -1029,7 +1029,7 @@ void tiva_adc_sse_step_cfg(uint8_t adc, uint8_t sse, uint8_t chn, uint8_t cfg) * Dump all configured registers for the given ADC and SSE. This should * only be used to verify that configuration routines were accurate. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * diff --git a/arch/arm/src/tiva/tiva_adclow.c b/arch/arm/src/tiva/tiva_adclow.c index 577a430d2f..3d7262b015 100644 --- a/arch/arm/src/tiva/tiva_adclow.c +++ b/arch/arm/src/tiva/tiva_adclow.c @@ -655,7 +655,7 @@ static int tiva_adc_ioctl(struct adc_dev_s *dev, int cmd, unsigned long arg) * are disabled when this function runs. tiva_adc_read will * re-enable interrupts when it completes processing all pending events. * - * Input Parameters + * Input Parameters: * arg - The ADC SSE data structure cast to (void *) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_gpioirq.c b/arch/arm/src/tiva/tiva_gpioirq.c index 112887f8bf..a5d0e3dbe3 100644 --- a/arch/arm/src/tiva/tiva_gpioirq.c +++ b/arch/arm/src/tiva/tiva_gpioirq.c @@ -672,7 +672,7 @@ int tiva_gpioirqinitialize(void) * disabled to stop further interrupts. Otherwise, the new isr is linked * and the pin's interrupt mask is set. * - * Returns: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * return to indicate the nature of the failure. * diff --git a/arch/arm/src/tiva/tiva_i2c.h b/arch/arm/src/tiva/tiva_i2c.h index 33acca1116..c43e167f86 100644 --- a/arch/arm/src/tiva/tiva_i2c.h +++ b/arch/arm/src/tiva/tiva_i2c.h @@ -59,7 +59,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -75,7 +75,7 @@ FAR struct i2c_master_s *tiva_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the tiva_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_pwm.c b/arch/arm/src/tiva/tiva_pwm.c index 0e882f0f7c..b25e272255 100644 --- a/arch/arm/src/tiva/tiva_pwm.c +++ b/arch/arm/src/tiva/tiva_pwm.c @@ -421,7 +421,7 @@ static inline void tiva_pwm_putreg(struct tiva_pwm_chan_s *chan, * use. It will not, however, output pulses until the start method is * called. * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -457,7 +457,7 @@ static int tiva_pwm_setup(FAR struct pwm_lowerhalf_s *dev) * stop pulsed output, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -487,7 +487,7 @@ static int tiva_pwm_shutdown(FAR struct pwm_lowerhalf_s *dev) * Description: * (Re-)initialize the timer resources and start the pulsed output * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * handle - This is the handle that was provided to the lower-half @@ -569,7 +569,7 @@ static int tiva_pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Configure PWM registers and start the PWM timer * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * info - A reference to the characteristics of the pulsed output * @@ -659,7 +659,7 @@ static inline int tiva_pwm_timer(FAR struct tiva_pwm_chan_s *chan, * Description: * Stop the pulsed output and reset the timer resources * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * * Returned Value: @@ -692,7 +692,7 @@ static int tiva_pwm_stop(FAR struct pwm_lowerhalf_s *dev) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/tiva/tiva_qencoder.c b/arch/arm/src/tiva/tiva_qencoder.c index b25f6dce18..a10eb6577d 100644 --- a/arch/arm/src/tiva/tiva_qencoder.c +++ b/arch/arm/src/tiva/tiva_qencoder.c @@ -177,7 +177,7 @@ static inline void tiva_qe_putreg(struct tiva_qe_s *qe, unsigned int offset, * use. It will not, however, output pulses until the start method is * called. * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * * Returned Value: @@ -260,7 +260,7 @@ static int tiva_qe_setup(FAR struct qe_lowerhalf_s *lower) * stop data collection, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * * Returned Value: @@ -287,7 +287,7 @@ static int tiva_qe_shutdown(FAR struct qe_lowerhalf_s *lower) * Description: * Reset the position measurement to zero. * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * * Returned Value: @@ -312,7 +312,7 @@ static int tiva_qe_reset(FAR struct qe_lowerhalf_s *lower) * Description: * Return the position mesaured by QEI. * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * pos - pointer to the position returned * @@ -338,7 +338,7 @@ static int tiva_qe_position(FAR struct qe_lowerhalf_s *lower, FAR int32_t *pos) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command @@ -383,7 +383,7 @@ static int tiva_qe_ioctl(FAR struct qe_lowerhalf_s *lower, int cmd, * Description: * Return the direction mesaured by QEI. * - * Input parameters: + * Input Parameters: * qe - A reference to the TIVA QEI structure * dir - pointer to the direction returned * @@ -414,7 +414,7 @@ static int tiva_qe_direction(FAR struct tiva_qe_s *qe, unsigned long *dir) * Description: * Return the velocity (A/B pulses per second) mesaured by QEI. * - * Input parameters: + * Input Parameters: * qe - A reference to the TIVA QEI structure * * Returned Value: @@ -437,7 +437,7 @@ static int tiva_qe_velocity(FAR struct tiva_qe_s *qe, unsigned long *vel) * Description: * Set reset mode as MAXPOS and also set maxpos value * - * Input parameters: + * Input Parameters: * qe - A reference to the TIVA QEI structure * ppr - pulses per round of encoder * diff --git a/arch/arm/src/tiva/tiva_ssi.c b/arch/arm/src/tiva/tiva_ssi.c index bd224363b0..d64e4dccdd 100644 --- a/arch/arm/src/tiva/tiva_ssi.c +++ b/arch/arm/src/tiva/tiva_ssi.c @@ -1495,7 +1495,7 @@ static void ssi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SSI interfaces) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_ssi.h b/arch/arm/src/tiva/tiva_ssi.h index d0976c2aee..8027ae3366 100644 --- a/arch/arm/src/tiva/tiva_ssi.h +++ b/arch/arm/src/tiva/tiva_ssi.h @@ -70,7 +70,7 @@ extern "C" * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SSI interfaces) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_timer.h b/arch/arm/src/tiva/tiva_timer.h index 547cd11704..f5d9c6f9fe 100644 --- a/arch/arm/src/tiva/tiva_timer.h +++ b/arch/arm/src/tiva/tiva_timer.h @@ -835,7 +835,7 @@ static inline void tiva_gptm0_synchronize(uint32_t sync) * form /dev/timer0 * config - 32-bit timer configuration values. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/tiva/tiva_timerlow32.c b/arch/arm/src/tiva/tiva_timerlow32.c index 91f44618b0..9807588ec2 100644 --- a/arch/arm/src/tiva/tiva_timerlow32.c +++ b/arch/arm/src/tiva/tiva_timerlow32.c @@ -133,7 +133,7 @@ static const struct timer_ops_s g_timer_ops = * priv - A pointer to a private timer driver lower half instance * usecs - The number of usecs to convert * - * Returned Values: + * Returned Value: * The time converted to clock ticks. * ****************************************************************************/ @@ -161,7 +161,7 @@ static uint32_t tiva_usec2ticks(struct tiva_lowerhalf_s *priv, uint32_t usecs) * priv - A pointer to a private timer driver lower half instance * usecs - The number of ticks to convert * - * Returned Values: + * Returned Value: * The time converted to microseconds. * ****************************************************************************/ @@ -189,7 +189,7 @@ static uint32_t tiva_ticks2usec(struct tiva_lowerhalf_s *priv, uint32_t ticks) * priv - A pointer to a private timer driver lower half instance * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -224,7 +224,7 @@ static void tiva_timeout(struct tiva_lowerhalf_s *priv, uint32_t timeout) * Input Parameters: * Usual 32-bit timer interrupt handler arguments. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -287,7 +287,7 @@ static void tiva_timer_handler(TIMER_HANDLE handle, void *arg, uint32_t status) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -324,7 +324,7 @@ static int tiva_start(struct timer_lowerhalf_s *lower) * lower - A pointer the publicly visible representation of the "lower-half" * driver state structure. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -362,7 +362,7 @@ static int tiva_stop(struct timer_lowerhalf_s *lower) * driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -415,7 +415,7 @@ static int tiva_getstatus(struct timer_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -456,7 +456,7 @@ static int tiva_settimeout(struct timer_lowerhalf_s *lower, uint32_t timeout) * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -496,7 +496,7 @@ static void tiva_setcallback(struct timer_lowerhalf_s *lower, * interpretation of this argument depends on the particular * command. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -535,7 +535,7 @@ static int tiva_ioctl(struct timer_lowerhalf_s *lower, int cmd, * form /dev/timer0 * config - 32-bit timer configuration values. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/tms570/tms570_irq.c b/arch/arm/src/tms570/tms570_irq.c index 11d606d637..33f2890b74 100644 --- a/arch/arm/src/tms570/tms570_irq.c +++ b/arch/arm/src/tms570/tms570_irq.c @@ -198,7 +198,7 @@ void up_irqinitialize(void) * the irq number of the interrupt and then to call arm_doirq to dispatch * the interrupt. * - * Input parameters: + * Input Parameters: * regs - A pointer to the register save area on the stack. * ****************************************************************************/ @@ -240,7 +240,7 @@ uint32_t *arm_decodeirq(uint32_t *regs) * the irq number of the interrupt and then to call arm_doirq to dispatch * the interrupt. * - * Input parameters: + * Input Parameters: * regs - A pointer to the register save area on the stack. * ****************************************************************************/ diff --git a/arch/arm/src/tms570/tms570_selftest.h b/arch/arm/src/tms570/tms570_selftest.h index 696bc54fe3..727510fe32 100644 --- a/arch/arm/src/tms570/tms570_selftest.h +++ b/arch/arm/src/tms570/tms570_selftest.h @@ -90,7 +90,7 @@ void tms570_memtest_selftest(void); * Description: * Start the memory test on the selected set of RAMs. * - * Input Paramters: + * Input Parameters: * rinfol - The OR of each RAM grouping bit. See the PBIST_RINFOL* * definitions in chip/tms570_pbist.h * diff --git a/arch/arm/src/xmc4/xmc4_i2c.h b/arch/arm/src/xmc4/xmc4_i2c.h index f4a167b713..74f8acb168 100644 --- a/arch/arm/src/xmc4/xmc4_i2c.h +++ b/arch/arm/src/xmc4/xmc4_i2c.h @@ -57,7 +57,7 @@ * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct i2c_master_s *xmc4_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the lpc43_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/xmc4/xmc4_serial.c b/arch/arm/src/xmc4/xmc4_serial.c index fef3ac0773..36a23e91d7 100644 --- a/arch/arm/src/xmc4/xmc4_serial.c +++ b/arch/arm/src/xmc4/xmc4_serial.c @@ -1073,7 +1073,7 @@ void xmc4_earlyserialinit(void) * Input Parameters: * None * - * Returns Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/xmc4/xmc4_spi.h b/arch/arm/src/xmc4/xmc4_spi.h index 5113665eda..73f4d69d4d 100644 --- a/arch/arm/src/xmc4/xmc4_spi.h +++ b/arch/arm/src/xmc4/xmc4_spi.h @@ -75,7 +75,7 @@ struct spi_dev_s; * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * bus number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/avr/src/at32uc3/at32uc3_gpioirq.c b/arch/avr/src/at32uc3/at32uc3_gpioirq.c index 66e8247655..03b704e08a 100644 --- a/arch/avr/src/at32uc3/at32uc3_gpioirq.c +++ b/arch/avr/src/at32uc3/at32uc3_gpioirq.c @@ -81,7 +81,7 @@ static struct g_gpiohandler_s g_gpiohandler[NR_GPIO_IRQS]; /**************************************************************************** * Name: gpio_baseaddress * - * Input: + * Input Parameters: * irq - A IRQ number in the range of 0 to NR_GPIO_IRQS. * * Description: @@ -114,7 +114,7 @@ static inline uint32_t gpio_baseaddress(unsigned int irq) /**************************************************************************** * Name: gpio_pin * - * Input: + * Input Parameters: * irq - A IRQ number in the range of 0 to NR_GPIO_IRQS. * * Description: diff --git a/arch/avr/src/avr/avr.h b/arch/avr/src/avr/avr.h index 0326d6d848..2e0c72ee38 100644 --- a/arch/avr/src/avr/avr.h +++ b/arch/avr/src/avr/avr.h @@ -144,7 +144,7 @@ uint8_t *up_doirq(uint8_t irq, uint8_t *regs); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/avr/src/avr/up_blocktask.c b/arch/avr/src/avr/up_blocktask.c index b03b967bad..868a517b40 100644 --- a/arch/avr/src/avr/up_blocktask.c +++ b/arch/avr/src/avr/up_blocktask.c @@ -61,7 +61,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/avr/src/avr/up_checkstack.c b/arch/avr/src/avr/up_checkstack.c index 725a234d1a..96152af0d6 100644 --- a/arch/avr/src/avr/up_checkstack.c +++ b/arch/avr/src/avr/up_checkstack.c @@ -74,7 +74,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size); * alloc - Allocation base address of the stack * size - The size of the stack in bytes * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ @@ -154,7 +154,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size) * Input Parameters: * None * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ diff --git a/arch/avr/src/avr/up_createstack.c b/arch/avr/src/avr/up_createstack.c index 54efb1a3fb..d54b2049fe 100644 --- a/arch/avr/src/avr/up_createstack.c +++ b/arch/avr/src/avr/up_createstack.c @@ -81,7 +81,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/avr/src/avr/up_reprioritizertr.c b/arch/avr/src/avr/up_reprioritizertr.c index 846b59becf..28323ffbb7 100644 --- a/arch/avr/src/avr/up_reprioritizertr.c +++ b/arch/avr/src/avr/up_reprioritizertr.c @@ -67,7 +67,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/avr/src/avr/up_spi.c b/arch/avr/src/avr/up_spi.c index 24a4f377cb..98742cf4e2 100644 --- a/arch/avr/src/avr/up_spi.c +++ b/arch/avr/src/avr/up_spi.c @@ -440,7 +440,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/avr/src/avr/up_stackframe.c b/arch/avr/src/avr/up_stackframe.c index 0f7d3a8746..71c38c8aa4 100644 --- a/arch/avr/src/avr/up_stackframe.c +++ b/arch/avr/src/avr/up_stackframe.c @@ -86,7 +86,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/avr/src/avr/up_switchcontext.S b/arch/avr/src/avr/up_switchcontext.S index 3fc1b6ae42..c6ab3f8c08 100644 --- a/arch/avr/src/avr/up_switchcontext.S +++ b/arch/avr/src/avr/up_switchcontext.S @@ -74,7 +74,7 @@ * r24-r25: savregs * r22-r23: restoreregs * - * Return: + * Returned Value: * up_switchcontext forces a context switch to the task "canned" in restoreregs. * It does not 'return' in the normal sense, rather, it will context switch back * to the function point. When it does 'return,' it is because the blocked diff --git a/arch/avr/src/avr/up_unblocktask.c b/arch/avr/src/avr/up_unblocktask.c index d70b65405c..cea4c6df79 100644 --- a/arch/avr/src/avr/up_unblocktask.c +++ b/arch/avr/src/avr/up_unblocktask.c @@ -60,7 +60,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/avr/src/avr/up_usestack.c b/arch/avr/src/avr/up_usestack.c index 0546d8c770..1e451d883c 100644 --- a/arch/avr/src/avr/up_usestack.c +++ b/arch/avr/src/avr/up_usestack.c @@ -79,7 +79,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/avr/src/avr32/up_blocktask.c b/arch/avr/src/avr32/up_blocktask.c index 8449d82cbe..3e9304be28 100644 --- a/arch/avr/src/avr32/up_blocktask.c +++ b/arch/avr/src/avr32/up_blocktask.c @@ -62,7 +62,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/avr/src/avr32/up_createstack.c b/arch/avr/src/avr32/up_createstack.c index 6bc17519bc..2244e9ba4e 100644 --- a/arch/avr/src/avr32/up_createstack.c +++ b/arch/avr/src/avr32/up_createstack.c @@ -81,7 +81,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/avr/src/avr32/up_reprioritizertr.c b/arch/avr/src/avr32/up_reprioritizertr.c index 1ce7a4c406..eb8023d720 100644 --- a/arch/avr/src/avr32/up_reprioritizertr.c +++ b/arch/avr/src/avr32/up_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/avr/src/avr32/up_stackframe.c b/arch/avr/src/avr32/up_stackframe.c index acd10d9216..dfcf128001 100644 --- a/arch/avr/src/avr32/up_stackframe.c +++ b/arch/avr/src/avr32/up_stackframe.c @@ -98,7 +98,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/avr/src/avr32/up_switchcontext.S b/arch/avr/src/avr32/up_switchcontext.S index 8820427e69..1542a64578 100644 --- a/arch/avr/src/avr32/up_switchcontext.S +++ b/arch/avr/src/avr32/up_switchcontext.S @@ -68,7 +68,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * up_switchcontext forces a context switch to the task "canned" in restoreregs. * It does not 'return' in the normal sense, rather, it will context switch back * to the function point. When it does 'return,' it is because the blocked diff --git a/arch/avr/src/avr32/up_unblocktask.c b/arch/avr/src/avr32/up_unblocktask.c index d8181344fd..c77c5dbdbb 100644 --- a/arch/avr/src/avr32/up_unblocktask.c +++ b/arch/avr/src/avr32/up_unblocktask.c @@ -61,7 +61,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/avr/src/avr32/up_usestack.c b/arch/avr/src/avr32/up_usestack.c index 533c82a16c..4e6de52de8 100644 --- a/arch/avr/src/avr32/up_usestack.c +++ b/arch/avr/src/avr32/up_usestack.c @@ -78,7 +78,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/avr/src/common/up_releasestack.c b/arch/avr/src/common/up_releasestack.c index 9cda128cab..f1abcd15d9 100644 --- a/arch/avr/src/common/up_releasestack.c +++ b/arch/avr/src/common/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/hc/src/common/up_blocktask.c b/arch/hc/src/common/up_blocktask.c index f6308cb729..9c69ac43db 100644 --- a/arch/hc/src/common/up_blocktask.c +++ b/arch/hc/src/common/up_blocktask.c @@ -62,7 +62,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/hc/src/common/up_createstack.c b/arch/hc/src/common/up_createstack.c index f09b98a87a..5f954588f3 100644 --- a/arch/hc/src/common/up_createstack.c +++ b/arch/hc/src/common/up_createstack.c @@ -78,7 +78,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/hc/src/common/up_releasestack.c b/arch/hc/src/common/up_releasestack.c index 03d50098e1..5280674c99 100644 --- a/arch/hc/src/common/up_releasestack.c +++ b/arch/hc/src/common/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/hc/src/common/up_reprioritizertr.c b/arch/hc/src/common/up_reprioritizertr.c index 0b0d400d9a..757f2ad05c 100644 --- a/arch/hc/src/common/up_reprioritizertr.c +++ b/arch/hc/src/common/up_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/hc/src/common/up_stackframe.c b/arch/hc/src/common/up_stackframe.c index d712bb7d3b..57d899f08e 100644 --- a/arch/hc/src/common/up_stackframe.c +++ b/arch/hc/src/common/up_stackframe.c @@ -98,7 +98,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/hc/src/common/up_unblocktask.c b/arch/hc/src/common/up_unblocktask.c index c2ed818ac3..6ab177ecf1 100644 --- a/arch/hc/src/common/up_unblocktask.c +++ b/arch/hc/src/common/up_unblocktask.c @@ -61,7 +61,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/hc/src/common/up_usestack.c b/arch/hc/src/common/up_usestack.c index 6160e92b5e..4ecf5351f7 100644 --- a/arch/hc/src/common/up_usestack.c +++ b/arch/hc/src/common/up_usestack.c @@ -77,7 +77,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/hc/src/m9s12/m9s12.h b/arch/hc/src/m9s12/m9s12.h index 53da6a7726..48a09dde88 100644 --- a/arch/hc/src/m9s12/m9s12.h +++ b/arch/hc/src/m9s12/m9s12.h @@ -329,7 +329,7 @@ int hcs12_ethinitialize(int intf); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/mips/src/common/up_createstack.c b/arch/mips/src/common/up_createstack.c index 69d5ff0486..715bf8151e 100644 --- a/arch/mips/src/common/up_createstack.c +++ b/arch/mips/src/common/up_createstack.c @@ -99,7 +99,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/mips/src/common/up_releasestack.c b/arch/mips/src/common/up_releasestack.c index a322f4c24c..d08bc2e6d9 100644 --- a/arch/mips/src/common/up_releasestack.c +++ b/arch/mips/src/common/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/mips/src/common/up_stackframe.c b/arch/mips/src/common/up_stackframe.c index 6c631f3e1f..45c8c05908 100644 --- a/arch/mips/src/common/up_stackframe.c +++ b/arch/mips/src/common/up_stackframe.c @@ -100,7 +100,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/mips/src/common/up_usestack.c b/arch/mips/src/common/up_usestack.c index b4e3098fc4..041057a40e 100644 --- a/arch/mips/src/common/up_usestack.c +++ b/arch/mips/src/common/up_usestack.c @@ -98,7 +98,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/mips/src/mips32/up_blocktask.c b/arch/mips/src/mips32/up_blocktask.c index 1ad66ce9db..6ee466611d 100644 --- a/arch/mips/src/mips32/up_blocktask.c +++ b/arch/mips/src/mips32/up_blocktask.c @@ -63,7 +63,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/mips/src/mips32/up_reprioritizertr.c b/arch/mips/src/mips32/up_reprioritizertr.c index 22a204d58b..cae6ed3af5 100644 --- a/arch/mips/src/mips32/up_reprioritizertr.c +++ b/arch/mips/src/mips32/up_reprioritizertr.c @@ -70,7 +70,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/mips/src/mips32/up_unblocktask.c b/arch/mips/src/mips32/up_unblocktask.c index 9e72ef17a6..8400b1f7cf 100644 --- a/arch/mips/src/mips32/up_unblocktask.c +++ b/arch/mips/src/mips32/up_unblocktask.c @@ -63,7 +63,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/mips/src/mips32/up_vfork.c b/arch/mips/src/mips32/up_vfork.c index 06b79f7bb1..d62c2dd623 100644 --- a/arch/mips/src/mips32/up_vfork.c +++ b/arch/mips/src/mips32/up_vfork.c @@ -100,10 +100,10 @@ * * task_vforkabort() may be called if an error occurs between steps 3 and 6. * - * Input Paremeters: + * Input Parameters: * context - Caller context information saved by vfork() * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and * returns the process ID of the child process to the parent process. * Otherwise, -1 is returned to the parent, no child process is created, diff --git a/arch/mips/src/mips32/vfork.S b/arch/mips/src/mips32/vfork.S index 7012b45a41..bfcd9e51f4 100644 --- a/arch/mips/src/mips32/vfork.S +++ b/arch/mips/src/mips32/vfork.S @@ -86,10 +86,10 @@ * 5) up_vfork() then calls task_vforkstart() * 6) task_vforkstart() then executes the child thread. * - * Input Paremeters: + * Input Parameters: * None * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and returns * the process ID of the child process to the parent process. Otherwise, -1 is * returned to the parent, no child process is created, and errno is set to diff --git a/arch/mips/src/pic32mx/pic32mx-spi.c b/arch/mips/src/pic32mx/pic32mx-spi.c index e09688e42c..ed3e8bae41 100644 --- a/arch/mips/src/pic32mx/pic32mx-spi.c +++ b/arch/mips/src/pic32mx/pic32mx-spi.c @@ -842,7 +842,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/mips/src/pic32mx/pic32mx.h b/arch/mips/src/pic32mx/pic32mx.h index 480ff80fb8..e76f02c871 100644 --- a/arch/mips/src/pic32mx/pic32mx.h +++ b/arch/mips/src/pic32mx/pic32mx.h @@ -391,7 +391,7 @@ void pic32mx_dumpgpio(uint32_t pinset, const char *msg); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/mips/src/pic32mz/pic32mz-spi.c b/arch/mips/src/pic32mz/pic32mz-spi.c index 287c538b7d..ea2f906cb9 100644 --- a/arch/mips/src/pic32mz/pic32mz-spi.c +++ b/arch/mips/src/pic32mz/pic32mz-spi.c @@ -1199,7 +1199,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/mips/src/pic32mz/pic32mz-spi.h b/arch/mips/src/pic32mz/pic32mz-spi.h index ce4d772e0a..4770661d3f 100644 --- a/arch/mips/src/pic32mz/pic32mz-spi.h +++ b/arch/mips/src/pic32mz/pic32mz-spi.h @@ -78,7 +78,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/misoc/src/lm32/lm32_blocktask.c b/arch/misoc/src/lm32/lm32_blocktask.c index f313da11cc..7bc951cfbf 100644 --- a/arch/misoc/src/lm32/lm32_blocktask.c +++ b/arch/misoc/src/lm32/lm32_blocktask.c @@ -64,7 +64,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/misoc/src/lm32/lm32_createstack.c b/arch/misoc/src/lm32/lm32_createstack.c index 31c7f24226..a9aa3143a1 100644 --- a/arch/misoc/src/lm32/lm32_createstack.c +++ b/arch/misoc/src/lm32/lm32_createstack.c @@ -99,7 +99,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/misoc/src/lm32/lm32_releasestack.c b/arch/misoc/src/lm32/lm32_releasestack.c index fa88500bf9..63f4ab8f99 100644 --- a/arch/misoc/src/lm32/lm32_releasestack.c +++ b/arch/misoc/src/lm32/lm32_releasestack.c @@ -59,7 +59,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/misoc/src/lm32/lm32_reprioritizertr.c b/arch/misoc/src/lm32/lm32_reprioritizertr.c index e6b4261101..735b69ced7 100644 --- a/arch/misoc/src/lm32/lm32_reprioritizertr.c +++ b/arch/misoc/src/lm32/lm32_reprioritizertr.c @@ -70,7 +70,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/misoc/src/lm32/lm32_stackframe.c b/arch/misoc/src/lm32/lm32_stackframe.c index 981c655f81..0791201b4e 100644 --- a/arch/misoc/src/lm32/lm32_stackframe.c +++ b/arch/misoc/src/lm32/lm32_stackframe.c @@ -94,7 +94,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/misoc/src/lm32/lm32_unblocktask.c b/arch/misoc/src/lm32/lm32_unblocktask.c index 74b1d92472..8dedd52993 100644 --- a/arch/misoc/src/lm32/lm32_unblocktask.c +++ b/arch/misoc/src/lm32/lm32_unblocktask.c @@ -64,7 +64,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/renesas/src/common/up_blocktask.c b/arch/renesas/src/common/up_blocktask.c index 9e8ba57db7..9ceda2e1e2 100644 --- a/arch/renesas/src/common/up_blocktask.c +++ b/arch/renesas/src/common/up_blocktask.c @@ -61,7 +61,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/renesas/src/common/up_createstack.c b/arch/renesas/src/common/up_createstack.c index 1bbf3cc8e0..f4461a08b3 100644 --- a/arch/renesas/src/common/up_createstack.c +++ b/arch/renesas/src/common/up_createstack.c @@ -78,7 +78,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/renesas/src/common/up_releasestack.c b/arch/renesas/src/common/up_releasestack.c index e2b5948b14..5b309bde16 100644 --- a/arch/renesas/src/common/up_releasestack.c +++ b/arch/renesas/src/common/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/renesas/src/common/up_reprioritizertr.c b/arch/renesas/src/common/up_reprioritizertr.c index c476dbad37..2733ecb8d9 100644 --- a/arch/renesas/src/common/up_reprioritizertr.c +++ b/arch/renesas/src/common/up_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/renesas/src/common/up_stackframe.c b/arch/renesas/src/common/up_stackframe.c index 811fcd4aad..d3512ec9c9 100644 --- a/arch/renesas/src/common/up_stackframe.c +++ b/arch/renesas/src/common/up_stackframe.c @@ -96,7 +96,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/renesas/src/common/up_unblocktask.c b/arch/renesas/src/common/up_unblocktask.c index de3008f98a..30a9b4af9c 100644 --- a/arch/renesas/src/common/up_unblocktask.c +++ b/arch/renesas/src/common/up_unblocktask.c @@ -61,7 +61,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/renesas/src/common/up_usestack.c b/arch/renesas/src/common/up_usestack.c index de4c4aca95..9fce7d5965 100644 --- a/arch/renesas/src/common/up_usestack.c +++ b/arch/renesas/src/common/up_usestack.c @@ -78,7 +78,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/risc-v/src/common/up_createstack.c b/arch/risc-v/src/common/up_createstack.c index 494d54e4ab..1861707685 100644 --- a/arch/risc-v/src/common/up_createstack.c +++ b/arch/risc-v/src/common/up_createstack.c @@ -99,7 +99,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/risc-v/src/common/up_releasestack.c b/arch/risc-v/src/common/up_releasestack.c index 15301c49d2..dac7cea0d6 100644 --- a/arch/risc-v/src/common/up_releasestack.c +++ b/arch/risc-v/src/common/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/risc-v/src/common/up_stackframe.c b/arch/risc-v/src/common/up_stackframe.c index b3cb9801d4..be7b797d2c 100644 --- a/arch/risc-v/src/common/up_stackframe.c +++ b/arch/risc-v/src/common/up_stackframe.c @@ -100,7 +100,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/risc-v/src/common/up_usestack.c b/arch/risc-v/src/common/up_usestack.c index 605bb79b04..49333a5a12 100644 --- a/arch/risc-v/src/common/up_usestack.c +++ b/arch/risc-v/src/common/up_usestack.c @@ -98,7 +98,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/risc-v/src/nr5m100/nr5_timer.h b/arch/risc-v/src/nr5m100/nr5_timer.h index 2a6d15c3e3..5994df9bee 100644 --- a/arch/risc-v/src/nr5m100/nr5_timer.h +++ b/arch/risc-v/src/nr5m100/nr5_timer.h @@ -148,7 +148,7 @@ int nr5_timer_deinit(FAR struct nr5_timer_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/risc-v/src/rv32im/up_blocktask.c b/arch/risc-v/src/rv32im/up_blocktask.c index 530797da2b..0ac7327e12 100644 --- a/arch/risc-v/src/rv32im/up_blocktask.c +++ b/arch/risc-v/src/rv32im/up_blocktask.c @@ -63,7 +63,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/risc-v/src/rv32im/up_reprioritizertr.c b/arch/risc-v/src/rv32im/up_reprioritizertr.c index 26ed4ab2d1..e286d5026e 100644 --- a/arch/risc-v/src/rv32im/up_reprioritizertr.c +++ b/arch/risc-v/src/rv32im/up_reprioritizertr.c @@ -70,7 +70,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/risc-v/src/rv32im/up_unblocktask.c b/arch/risc-v/src/rv32im/up_unblocktask.c index 1b7350e05b..3bb71380dd 100644 --- a/arch/risc-v/src/rv32im/up_unblocktask.c +++ b/arch/risc-v/src/rv32im/up_unblocktask.c @@ -63,7 +63,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/risc-v/src/rv32im/up_vfork.c b/arch/risc-v/src/rv32im/up_vfork.c index f2f5332bec..d38d29c158 100644 --- a/arch/risc-v/src/rv32im/up_vfork.c +++ b/arch/risc-v/src/rv32im/up_vfork.c @@ -100,10 +100,10 @@ * * task_vforkabort() may be called if an error occurs between steps 3 and 6. * - * Input Paremeters: + * Input Parameters: * context - Caller context information saved by vfork() * - * Return: + * Returned Value: * Upon successful completion, vfork() returns 0 to the child process and * returns the process ID of the child process to the parent process. * Otherwise, -1 is returned to the parent, no child process is created, diff --git a/arch/sim/src/up_blocktask.c b/arch/sim/src/up_blocktask.c index 27223b19c3..86a46453ec 100644 --- a/arch/sim/src/up_blocktask.c +++ b/arch/sim/src/up_blocktask.c @@ -61,7 +61,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/sim/src/up_cpuidlestack.c b/arch/sim/src/up_cpuidlestack.c index c11d14e4a9..4a237c1b6b 100644 --- a/arch/sim/src/up_cpuidlestack.c +++ b/arch/sim/src/up_cpuidlestack.c @@ -85,7 +85,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - cpu: CPU index that indicates which CPU the IDLE task is * being created for. * - tcb: The TCB of new CPU IDLE task diff --git a/arch/sim/src/up_createstack.c b/arch/sim/src/up_createstack.c index 96a4097a23..2d511ba6c5 100644 --- a/arch/sim/src/up_createstack.c +++ b/arch/sim/src/up_createstack.c @@ -84,7 +84,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/sim/src/up_framebuffer.c b/arch/sim/src/up_framebuffer.c index 195eadd6a4..8e374a2781 100644 --- a/arch/sim/src/up_framebuffer.c +++ b/arch/sim/src/up_framebuffer.c @@ -356,7 +356,7 @@ static int up_setcursor(FAR struct fb_vtable_s *vtable, * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -384,7 +384,7 @@ int up_fbinitialize(int display) * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/arch/sim/src/up_qspiflash.c b/arch/sim/src/up_qspiflash.c index c94986b3d3..f01002d7fe 100644 --- a/arch/sim/src/up_qspiflash.c +++ b/arch/sim/src/up_qspiflash.c @@ -577,7 +577,7 @@ static int qspiflash_command(FAR struct qspi_dev_s *dev, FAR struct qspi_cmdinfo * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/sim/src/up_releasestack.c b/arch/sim/src/up_releasestack.c index e62cf2adf8..87a3026126 100644 --- a/arch/sim/src/up_releasestack.c +++ b/arch/sim/src/up_releasestack.c @@ -57,7 +57,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/sim/src/up_reprioritizertr.c b/arch/sim/src/up_reprioritizertr.c index 048c311559..36e3423047 100644 --- a/arch/sim/src/up_reprioritizertr.c +++ b/arch/sim/src/up_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/sim/src/up_spiflash.c b/arch/sim/src/up_spiflash.c index 677bdafd96..a75cb82948 100644 --- a/arch/sim/src/up_spiflash.c +++ b/arch/sim/src/up_spiflash.c @@ -897,7 +897,7 @@ static uint16_t spiflash_readword(FAR struct sim_spiflashdev_s *priv) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/sim/src/up_stackframe.c b/arch/sim/src/up_stackframe.c index 3e5b8a089d..624520dc20 100644 --- a/arch/sim/src/up_stackframe.c +++ b/arch/sim/src/up_stackframe.c @@ -90,7 +90,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/sim/src/up_unblocktask.c b/arch/sim/src/up_unblocktask.c index 5217efeb8f..03e8e847f9 100644 --- a/arch/sim/src/up_unblocktask.c +++ b/arch/sim/src/up_unblocktask.c @@ -60,7 +60,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/sim/src/up_usestack.c b/arch/sim/src/up_usestack.c index 3b428d8222..f31ed5aae3 100644 --- a/arch/sim/src/up_usestack.c +++ b/arch/sim/src/up_usestack.c @@ -85,7 +85,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/x86/src/common/up_blocktask.c b/arch/x86/src/common/up_blocktask.c index e5a4845e24..34f7f9fa26 100644 --- a/arch/x86/src/common/up_blocktask.c +++ b/arch/x86/src/common/up_blocktask.c @@ -62,7 +62,7 @@ * be stopped. Save its context and move it to the inactive list specified * by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally the task at the * head of the list). It most be stopped, its context saved and moved * into one of the waiting task lists. It it was the task at the head diff --git a/arch/x86/src/common/up_reprioritizertr.c b/arch/x86/src/common/up_reprioritizertr.c index 110d26a671..75428b84c9 100644 --- a/arch/x86/src/common/up_reprioritizertr.c +++ b/arch/x86/src/common/up_reprioritizertr.c @@ -68,7 +68,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/x86/src/common/up_unblocktask.c b/arch/x86/src/common/up_unblocktask.c index 706d36808c..8b3b4b3f24 100644 --- a/arch/x86/src/common/up_unblocktask.c +++ b/arch/x86/src/common/up_unblocktask.c @@ -61,7 +61,7 @@ * execute. Move the TCB to the ready-to-run list, restore its context, * and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is in one of the * waiting tasks lists. It must be moved to the ready-to-run list and, * if it is the highest priority ready to run task, executed. diff --git a/arch/x86/src/i486/up_createstack.c b/arch/x86/src/i486/up_createstack.c index f51d6f2ca2..8173457e80 100644 --- a/arch/x86/src/i486/up_createstack.c +++ b/arch/x86/src/i486/up_createstack.c @@ -80,7 +80,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/x86/src/i486/up_releasestack.c b/arch/x86/src/i486/up_releasestack.c index 0f23cd3fb7..e83434024e 100644 --- a/arch/x86/src/i486/up_releasestack.c +++ b/arch/x86/src/i486/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/x86/src/i486/up_stackframe.c b/arch/x86/src/i486/up_stackframe.c index fab05bff9c..62bd968a0f 100644 --- a/arch/x86/src/i486/up_stackframe.c +++ b/arch/x86/src/i486/up_stackframe.c @@ -99,7 +99,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/x86/src/i486/up_usestack.c b/arch/x86/src/i486/up_usestack.c index b2005fe2de..59221bedd6 100644 --- a/arch/x86/src/i486/up_usestack.c +++ b/arch/x86/src/i486/up_usestack.c @@ -78,7 +78,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/x86/src/qemu/qemu.h b/arch/x86/src/qemu/qemu.h index 561c68da44..80eceb18b3 100644 --- a/arch/x86/src/qemu/qemu.h +++ b/arch/x86/src/qemu/qemu.h @@ -201,7 +201,7 @@ int i486_dumpgpio(uint16_t pinset, const char *msg); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/x86/src/qemu/qemu_vga.c b/arch/x86/src/qemu/qemu_vga.c index 1513339332..f29b74abc4 100644 --- a/arch/x86/src/qemu/qemu_vga.c +++ b/arch/x86/src/qemu/qemu_vga.c @@ -183,7 +183,8 @@ static const struct file_operations g_vgaops = * you'll need to switch planes to access the whole screen but * that allows you using any resolution, up to 400x600 * - * Returns 0=ok, -n=fail + * Returned Value: + * 0=ok, -n=fail */ static int init_graph_vga(int width, int height,int chain4) diff --git a/arch/xtensa/src/common/xtensa_assert.c b/arch/xtensa/src/common/xtensa_assert.c index 24b7fd7e23..e290be637f 100644 --- a/arch/xtensa/src/common/xtensa_assert.c +++ b/arch/xtensa/src/common/xtensa_assert.c @@ -180,7 +180,7 @@ void up_assert(const uint8_t *filename, int lineno) * - Co-processor exception * - High priority level2-6 Exception. * - * Input parameters: + * Input Parameters: * xcptcode - Identifies the unhandled exception (see include/esp32/irq.h) * regs - The register save are at the time of the interrupt. * @@ -280,7 +280,7 @@ void xtensa_panic(int xptcode, uint32_t *regs) * cause varies 32..39. * 40..63 Reserved * - * Input parameters: + * Input Parameters: * exccause - Identifies the EXCCAUSE of the user exception * regs - The register save are at the time of the interrupt. * diff --git a/arch/xtensa/src/common/xtensa_blocktask.c b/arch/xtensa/src/common/xtensa_blocktask.c index fb1c0f910b..592da9a3f7 100644 --- a/arch/xtensa/src/common/xtensa_blocktask.c +++ b/arch/xtensa/src/common/xtensa_blocktask.c @@ -63,7 +63,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/xtensa/src/common/xtensa_checkstack.c b/arch/xtensa/src/common/xtensa_checkstack.c index 4853513905..bcfbece0d4 100644 --- a/arch/xtensa/src/common/xtensa_checkstack.c +++ b/arch/xtensa/src/common/xtensa_checkstack.c @@ -72,7 +72,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size); * alloc - Allocation base address of the stack * size - The size of the stack in bytes * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ @@ -174,7 +174,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size) * Input Parameters: * None * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ diff --git a/arch/xtensa/src/common/xtensa_createstack.c b/arch/xtensa/src/common/xtensa_createstack.c index 68308fb527..1632ac445f 100644 --- a/arch/xtensa/src/common/xtensa_createstack.c +++ b/arch/xtensa/src/common/xtensa_createstack.c @@ -91,7 +91,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/xtensa/src/common/xtensa_releasestack.c b/arch/xtensa/src/common/xtensa_releasestack.c index 94bb2d8cd8..738da79284 100644 --- a/arch/xtensa/src/common/xtensa_releasestack.c +++ b/arch/xtensa/src/common/xtensa_releasestack.c @@ -58,7 +58,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/xtensa/src/common/xtensa_reprioritizertr.c b/arch/xtensa/src/common/xtensa_reprioritizertr.c index 0226d18f72..617bb50c61 100644 --- a/arch/xtensa/src/common/xtensa_reprioritizertr.c +++ b/arch/xtensa/src/common/xtensa_reprioritizertr.c @@ -70,7 +70,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/xtensa/src/common/xtensa_stackframe.c b/arch/xtensa/src/common/xtensa_stackframe.c index 388238d8de..884225d69a 100644 --- a/arch/xtensa/src/common/xtensa_stackframe.c +++ b/arch/xtensa/src/common/xtensa_stackframe.c @@ -92,7 +92,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/xtensa/src/common/xtensa_unblocktask.c b/arch/xtensa/src/common/xtensa_unblocktask.c index 40ecf73c56..e7fb168ba7 100644 --- a/arch/xtensa/src/common/xtensa_unblocktask.c +++ b/arch/xtensa/src/common/xtensa_unblocktask.c @@ -63,7 +63,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/xtensa/src/common/xtensa_usestack.c b/arch/xtensa/src/common/xtensa_usestack.c index 0b5db031e9..4faff7341b 100644 --- a/arch/xtensa/src/common/xtensa_usestack.c +++ b/arch/xtensa/src/common/xtensa_usestack.c @@ -90,7 +90,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/xtensa/src/esp32/esp32_cpuidlestack.c b/arch/xtensa/src/esp32/esp32_cpuidlestack.c index ea475b79b3..8239acb96d 100644 --- a/arch/xtensa/src/esp32/esp32_cpuidlestack.c +++ b/arch/xtensa/src/esp32/esp32_cpuidlestack.c @@ -83,7 +83,7 @@ uint32_t g_cpu1_idlestack[CPU1_IDLETHREAD_STACKWORDS] * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - cpu: CPU index that indicates which CPU the IDLE task is * being created for. * - tcb: The TCB of new CPU IDLE task diff --git a/arch/z16/src/common/up_blocktask.c b/arch/z16/src/common/up_blocktask.c index 8328086de6..0893c933e6 100644 --- a/arch/z16/src/common/up_blocktask.c +++ b/arch/z16/src/common/up_blocktask.c @@ -61,7 +61,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/z16/src/common/up_createstack.c b/arch/z16/src/common/up_createstack.c index 2c35e68aef..0bab2d3ab3 100644 --- a/arch/z16/src/common/up_createstack.c +++ b/arch/z16/src/common/up_createstack.c @@ -79,7 +79,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/z16/src/common/up_releasestack.c b/arch/z16/src/common/up_releasestack.c index e0f4c4b27f..8d0698ecfd 100644 --- a/arch/z16/src/common/up_releasestack.c +++ b/arch/z16/src/common/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/z16/src/common/up_reprioritizertr.c b/arch/z16/src/common/up_reprioritizertr.c index d4fde47f31..588ec4d68f 100644 --- a/arch/z16/src/common/up_reprioritizertr.c +++ b/arch/z16/src/common/up_reprioritizertr.c @@ -69,7 +69,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/z16/src/common/up_stackframe.c b/arch/z16/src/common/up_stackframe.c index 6a2fe6d347..1bed013d99 100644 --- a/arch/z16/src/common/up_stackframe.c +++ b/arch/z16/src/common/up_stackframe.c @@ -97,7 +97,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/z16/src/common/up_unblocktask.c b/arch/z16/src/common/up_unblocktask.c index d9de4e43b9..2b09dbc301 100644 --- a/arch/z16/src/common/up_unblocktask.c +++ b/arch/z16/src/common/up_unblocktask.c @@ -62,7 +62,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/z16/src/common/up_usestack.c b/arch/z16/src/common/up_usestack.c index d65609a67d..044ecdc347 100644 --- a/arch/z16/src/common/up_usestack.c +++ b/arch/z16/src/common/up_usestack.c @@ -78,7 +78,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/z16/src/z16f/z16f_espi.c b/arch/z16/src/z16f/z16f_espi.c index da5b88611e..2a590d9613 100644 --- a/arch/z16/src/z16f/z16f_espi.c +++ b/arch/z16/src/z16f/z16f_espi.c @@ -788,7 +788,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * port - Identifies the "logical" SPI port. Must be zero in this case. * * Returned Value: diff --git a/arch/z16/src/z16f/z16f_lowuart.S b/arch/z16/src/z16f/z16f_lowuart.S index ef7c31a6ca..0a893d7585 100644 --- a/arch/z16/src/z16f/z16f_lowuart.S +++ b/arch/z16/src/z16f/z16f_lowuart.S @@ -191,7 +191,7 @@ _up_lowputc: * Parameters: * r1 = character * - * Return: + * Returned Value: * None * * Modifies r0 @@ -230,7 +230,7 @@ _z16f_xmitc1: * Parmeters: * None * - * Return + * Returned Value: * R0 = Character read * *************************************************************************/ diff --git a/arch/z80/src/common/up_blocktask.c b/arch/z80/src/common/up_blocktask.c index a4aa7b8ed5..6910c87b08 100644 --- a/arch/z80/src/common/up_blocktask.c +++ b/arch/z80/src/common/up_blocktask.c @@ -63,7 +63,7 @@ * the ready to run list must be stopped. Save its context * and move it to the inactive list specified by task_state. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the diff --git a/arch/z80/src/common/up_createstack.c b/arch/z80/src/common/up_createstack.c index a0a2bc2507..388cfb184d 100644 --- a/arch/z80/src/common/up_createstack.c +++ b/arch/z80/src/common/up_createstack.c @@ -78,7 +78,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. diff --git a/arch/z80/src/common/up_releasestack.c b/arch/z80/src/common/up_releasestack.c index 31237a3ee6..5862240d1f 100644 --- a/arch/z80/src/common/up_releasestack.c +++ b/arch/z80/src/common/up_releasestack.c @@ -66,7 +66,7 @@ * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): diff --git a/arch/z80/src/common/up_reprioritizertr.c b/arch/z80/src/common/up_reprioritizertr.c index 04675918fd..118ed179c5 100644 --- a/arch/z80/src/common/up_reprioritizertr.c +++ b/arch/z80/src/common/up_reprioritizertr.c @@ -71,7 +71,7 @@ * the priority of the current, running task and it now has the * priority. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * diff --git a/arch/z80/src/common/up_stackframe.c b/arch/z80/src/common/up_stackframe.c index 8f4a0f1806..60ad0851ce 100644 --- a/arch/z80/src/common/up_stackframe.c +++ b/arch/z80/src/common/up_stackframe.c @@ -88,7 +88,7 @@ * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * diff --git a/arch/z80/src/common/up_unblocktask.c b/arch/z80/src/common/up_unblocktask.c index a27a8e1ddd..66f7337dc6 100644 --- a/arch/z80/src/common/up_unblocktask.c +++ b/arch/z80/src/common/up_unblocktask.c @@ -64,7 +64,7 @@ * but has been prepped to execute. Move the TCB to the * ready-to-run list, restore its context, and start execution. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority diff --git a/arch/z80/src/common/up_usestack.c b/arch/z80/src/common/up_usestack.c index dd82424d33..7c75a14419 100644 --- a/arch/z80/src/common/up_usestack.c +++ b/arch/z80/src/common/up_usestack.c @@ -77,7 +77,7 @@ * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The allocated stack size. * diff --git a/arch/z80/src/ez80/ez80_i2c.c b/arch/z80/src/ez80/ez80_i2c.c index 6413a39d4b..a7b7403e67 100644 --- a/arch/z80/src/ez80/ez80_i2c.c +++ b/arch/z80/src/ez80/ez80_i2c.c @@ -929,7 +929,7 @@ static int ez80_i2c_transfer(FAR struct i2c_master_s *dev, * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2C interfaces) * * Returned Value: diff --git a/arch/z80/src/ez80/ez80_spi.c b/arch/z80/src/ez80/ez80_spi.c index d7f14c7e01..5f337d441a 100644 --- a/arch/z80/src/ez80/ez80_spi.c +++ b/arch/z80/src/ez80/ez80_spi.c @@ -438,7 +438,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t bu * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/z80/src/ez80/ez80f91_i2c.h b/arch/z80/src/ez80/ez80f91_i2c.h index b59d4ffc7b..a296eeab70 100644 --- a/arch/z80/src/ez80/ez80f91_i2c.h +++ b/arch/z80/src/ez80/ez80f91_i2c.h @@ -150,7 +150,7 @@ extern "C" * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: @@ -166,7 +166,7 @@ FAR struct i2c_master_s *ez80_i2cbus_initialize(int port); * Description: * De-initialize the selected I2C port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the ez80_i2cbus_initialize() * * Returned Value: diff --git a/arch/z80/src/ez80/ez80f91_spi.h b/arch/z80/src/ez80/ez80f91_spi.h index fe7c34bb7e..0c49cad1d7 100644 --- a/arch/z80/src/ez80/ez80f91_spi.h +++ b/arch/z80/src/ez80/ez80f91_spi.h @@ -114,7 +114,7 @@ extern "C" * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/z80/src/z8/z8_i2c.c b/arch/z80/src/z8/z8_i2c.c index 465debc403..599e6adb32 100644 --- a/arch/z80/src/z8/z8_i2c.c +++ b/arch/z80/src/z8/z8_i2c.c @@ -638,7 +638,7 @@ static int z8_i2c_reset(FAR struct i2c_master_s * dev) * instances of the interface, each of which may be set up with a * different frequency and slave address. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2C interfaces) * * Returned Value: diff --git a/audio/audio.c b/audio/audio.c index e4acb10b89..6149eb592b 100644 --- a/audio/audio.c +++ b/audio/audio.c @@ -680,7 +680,7 @@ static int audio_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * to enqueue additional buffers and "wake them up" for further * processing. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was provided to the lower-half * start() method. * apb - A pointer to the previsously enqueued ap_buffer_s @@ -767,7 +767,7 @@ static inline void audio_complete(FAR struct audio_upperhalf_s *upper, * Provides a callback interface for lower-half drivers to call to the * upper-half for buffer dequeueing, error reporting, etc. * - * Input parameters: + * Input Parameters: * priv - Private context data owned by the upper-half * reason - The reason code for the callback * apb - A pointer to the previsously enqueued ap_buffer_s @@ -854,7 +854,7 @@ static void audio_callback(FAR void *handle, uint16_t reason, * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name Audio drivers * based on the function they provide, such as "/dev/pcm0", "/dev/mp31", diff --git a/binfmt/binfmt.h b/binfmt/binfmt.h index cfde554d4e..84775cfbd9 100644 --- a/binfmt/binfmt.h +++ b/binfmt/binfmt.h @@ -78,7 +78,7 @@ EXTERN FAR struct binfmt_s *g_binfmts; * Description: * Dump the contents of struct binary_s. * - * Input Parameter: + * Input Parameters: * bin - Load structure * * Returned Value: @@ -101,7 +101,7 @@ int dump_module(FAR const struct binary_s *bin); * address environment of the new process address environment. So we * do not have any real option other than to copy the callers argv[] list. * - * Input Parameter: + * Input Parameters: * bin - Load structure * argv - Argument list * @@ -118,7 +118,7 @@ int binfmt_copyargv(FAR struct binary_s *bin, FAR char * const *argv); * Description: * Release the copied argv[] list. * - * Input Parameter: + * Input Parameters: * bin - Load structure * * Returned Value: diff --git a/binfmt/binfmt_copyargv.c b/binfmt/binfmt_copyargv.c index f0a594f5a6..c3f3dbcc08 100644 --- a/binfmt/binfmt_copyargv.c +++ b/binfmt/binfmt_copyargv.c @@ -72,7 +72,7 @@ * address environment of the new process address environment. So we * do not have any real option other than to copy the callers argv[] list. * - * Input Parameter: + * Input Parameters: * bin - Load structure * argv - Argument list * @@ -167,7 +167,7 @@ int binfmt_copyargv(FAR struct binary_s *bin, FAR char * const *argv) * Description: * Release the copied argv[] list. * - * Input Parameter: + * Input Parameters: * binp - Load structure * * Returned Value: diff --git a/binfmt/binfmt_schedunload.c b/binfmt/binfmt_schedunload.c index e7b981d2fe..1996acd107 100644 --- a/binfmt/binfmt_schedunload.c +++ b/binfmt/binfmt_schedunload.c @@ -74,7 +74,7 @@ FAR struct binary_s *g_unloadhead; * * This function will add one structure to the linked list * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * bin - This structure must have been allocated with kmm_malloc() and must * persist until the task unloads @@ -117,7 +117,7 @@ static void unload_list_add(pid_t pid, FAR struct binary_s *bin) * * This function will remove one structure to the linked list * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * * Returned Value: @@ -184,7 +184,7 @@ static FAR struct binary_s *unload_list_remove(pid_t pid) * bin was allocated with kmm_malloc() or friends and will also automatically * free the structure with kmm_free() when the task exists. * - * Input Parameter: + * Input Parameters: * pid - The ID of the task that just exited * arg - A reference to the load structure cast to FAR void * * @@ -243,7 +243,7 @@ static void unload_callback(int signo, siginfo_t *info, void *ucontext) * or friends. It will also automatically free the structure with kmm_free() * after unloading the module. * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * bin - This structure must have been allocated with kmm_malloc() and must * persist until the task unloads diff --git a/configs/cloudctrl/src/stm32_usb.c b/configs/cloudctrl/src/stm32_usb.c index 7d7ea1732f..bf13400a5b 100644 --- a/configs/cloudctrl/src/stm32_usb.c +++ b/configs/cloudctrl/src/stm32_usb.c @@ -273,11 +273,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/dk-tm4c129x/include/board.h b/configs/dk-tm4c129x/include/board.h index 5279f43cf3..c52a8f3b3e 100644 --- a/configs/dk-tm4c129x/include/board.h +++ b/configs/dk-tm4c129x/include/board.h @@ -255,7 +255,7 @@ * Description: * Initialize and register the TMP-100 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/dk-tm4c129x/src/tm4c_tmp100.c b/configs/dk-tm4c129x/src/tm4c_tmp100.c index 29ab1a9aeb..0238c62bb5 100644 --- a/configs/dk-tm4c129x/src/tm4c_tmp100.c +++ b/configs/dk-tm4c129x/src/tm4c_tmp100.c @@ -68,7 +68,7 @@ * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/ea3131/src/lpc31_usbhost.c b/configs/ea3131/src/lpc31_usbhost.c index 81c8cfa866..eee4f004de 100644 --- a/configs/ea3131/src/lpc31_usbhost.c +++ b/configs/ea3131/src/lpc31_usbhost.c @@ -286,11 +286,11 @@ void lpc31_usbhost_vbusdrive(int rhport, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument that will accompany the interrupt * - * Returned value: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on failure. * ************************************************************************************/ diff --git a/configs/freedom-kl25z/src/kl_cc3000.c b/configs/freedom-kl25z/src/kl_cc3000.c index e233a64d06..c446ff870b 100644 --- a/configs/freedom-kl25z/src/kl_cc3000.c +++ b/configs/freedom-kl25z/src/kl_cc3000.c @@ -334,7 +334,7 @@ int wireless_archinitialize(size_t max_rx_size) * Warning: This function must be called before ANY other wlan driver * function * - * Input Parmeters: + * Input Parameters: * sWlanCB Asynchronous events callback. * 0 no event call back. * - Call back parameters: diff --git a/configs/freedom-kl25z/src/kl_spi.c b/configs/freedom-kl25z/src/kl_spi.c index e952963d1b..566af53909 100644 --- a/configs/freedom-kl25z/src/kl_spi.c +++ b/configs/freedom-kl25z/src/kl_spi.c @@ -133,7 +133,7 @@ void weak_function kl_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -182,7 +182,7 @@ void kl_spi1select(FAR struct spi_dev_s *dev, uint32_t devid, * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -213,7 +213,7 @@ uint8_t kl_spi1status(FAR struct spi_dev_s *dev, uint32_t devid) * devid - Identifies the (logical) device * cmd - Determines where command or data should be selected. * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/freedom-kl26z/src/kl_spi.c b/configs/freedom-kl26z/src/kl_spi.c index 4c94db9fa3..01cb52fc91 100644 --- a/configs/freedom-kl26z/src/kl_spi.c +++ b/configs/freedom-kl26z/src/kl_spi.c @@ -124,7 +124,7 @@ void weak_function kl_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -156,7 +156,7 @@ void kl_spi1select(FAR struct spi_dev_s *dev, uint32_t devid, * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -187,7 +187,7 @@ uint8_t kl_spi1status(FAR struct spi_dev_s *dev, uint32_t devid) * devid - Identifies the (logical) device * cmd - Determines where command or data should be selected. * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/indium-f7/src/stm32_usb.c b/configs/indium-f7/src/stm32_usb.c index 63d3d5530b..9089232cec 100644 --- a/configs/indium-f7/src/stm32_usb.c +++ b/configs/indium-f7/src/stm32_usb.c @@ -295,11 +295,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/mcu123-lpc214x/src/lpc2148_spi1.c b/configs/mcu123-lpc214x/src/lpc2148_spi1.c index a5001a5a0c..8a4675fc9c 100644 --- a/configs/mcu123-lpc214x/src/lpc2148_spi1.c +++ b/configs/mcu123-lpc214x/src/lpc2148_spi1.c @@ -525,7 +525,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/configs/mikroe-stm32f4/src/stm32_pm.c b/configs/mikroe-stm32f4/src/stm32_pm.c index c5f89f50ab..4ff3d14bad 100644 --- a/configs/mikroe-stm32f4/src/stm32_pm.c +++ b/configs/mikroe-stm32f4/src/stm32_pm.c @@ -78,10 +78,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/configs/mikroe-stm32f4/src/stm32_usb.c b/configs/mikroe-stm32f4/src/stm32_usb.c index f6114e62b7..e242c69060 100644 --- a/configs/mikroe-stm32f4/src/stm32_usb.c +++ b/configs/mikroe-stm32f4/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/nucleo-144/src/stm32_usb.c b/configs/nucleo-144/src/stm32_usb.c index 00fdaa9415..82118d87fa 100644 --- a/configs/nucleo-144/src/stm32_usb.c +++ b/configs/nucleo-144/src/stm32_usb.c @@ -294,11 +294,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/nucleo-f303re/src/nucleo-f303re.h b/configs/nucleo-f303re/src/nucleo-f303re.h index e11495f5f1..f5ee979d7a 100644 --- a/configs/nucleo-f303re/src/nucleo-f303re.h +++ b/configs/nucleo-f303re/src/nucleo-f303re.h @@ -145,7 +145,7 @@ void weak_function stm32_spidev_initialize(void); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-f303re/src/stm32_timer.c b/configs/nucleo-f303re/src/stm32_timer.c index fd82bb6d4f..a13edd2943 100644 --- a/configs/nucleo-f303re/src/stm32_timer.c +++ b/configs/nucleo-f303re/src/stm32_timer.c @@ -68,7 +68,7 @@ * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-f334r8/src/nucleo-f334r8.h b/configs/nucleo-f334r8/src/nucleo-f334r8.h index 4b2929f8aa..463f20cb24 100644 --- a/configs/nucleo-f334r8/src/nucleo-f334r8.h +++ b/configs/nucleo-f334r8/src/nucleo-f334r8.h @@ -132,7 +132,7 @@ void weak_function stm32_spidev_initialize(void); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-l432kc/src/stm32_timer.c b/configs/nucleo-l432kc/src/stm32_timer.c index 8750ba76b9..f7183936d6 100644 --- a/configs/nucleo-l432kc/src/stm32_timer.c +++ b/configs/nucleo-l432kc/src/stm32_timer.c @@ -68,7 +68,7 @@ * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-l476rg/src/stm32_timer.c b/configs/nucleo-l476rg/src/stm32_timer.c index 2d6f83835e..9f578b5bc6 100644 --- a/configs/nucleo-l476rg/src/stm32_timer.c +++ b/configs/nucleo-l476rg/src/stm32_timer.c @@ -68,7 +68,7 @@ * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-l496zg/src/stm32_usb.c b/configs/nucleo-l496zg/src/stm32_usb.c index 50ecd74de4..a5a0937b05 100644 --- a/configs/nucleo-l496zg/src/stm32_usb.c +++ b/configs/nucleo-l496zg/src/stm32_usb.c @@ -294,11 +294,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-lpc-h3131/include/board.h b/configs/olimex-lpc-h3131/include/board.h index a411461668..2b9ace582b 100644 --- a/configs/olimex-lpc-h3131/include/board.h +++ b/configs/olimex-lpc-h3131/include/board.h @@ -174,11 +174,11 @@ extern "C" * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument that will accompany the interrupt * - * Returned value: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on failure. * ************************************************************************************/ diff --git a/configs/olimex-lpc-h3131/src/lpc31_usbhost.c b/configs/olimex-lpc-h3131/src/lpc31_usbhost.c index 37c08d5c43..f267b235e7 100644 --- a/configs/olimex-lpc-h3131/src/lpc31_usbhost.c +++ b/configs/olimex-lpc-h3131/src/lpc31_usbhost.c @@ -293,11 +293,11 @@ void lpc31_usbhost_vbusdrive(int rhport, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument that will accompany the interrupt * - * Returned value: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on failure. * ************************************************************************************/ diff --git a/configs/olimex-stm32-e407/src/stm32_usb.c b/configs/olimex-stm32-e407/src/stm32_usb.c index fc0b45a4db..5e28e17faa 100644 --- a/configs/olimex-stm32-e407/src/stm32_usb.c +++ b/configs/olimex-stm32-e407/src/stm32_usb.c @@ -301,11 +301,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-stm32-h407/src/stm32_usb.c b/configs/olimex-stm32-h407/src/stm32_usb.c index 6c2cf52e5d..584e8c0a4e 100644 --- a/configs/olimex-stm32-h407/src/stm32_usb.c +++ b/configs/olimex-stm32-h407/src/stm32_usb.c @@ -283,7 +283,7 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-stm32-p207/src/stm32_usb.c b/configs/olimex-stm32-p207/src/stm32_usb.c index da898fd74d..8195a326d2 100644 --- a/configs/olimex-stm32-p207/src/stm32_usb.c +++ b/configs/olimex-stm32-p207/src/stm32_usb.c @@ -237,11 +237,11 @@ int stm32_usbhost_initialize(void) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-stm32-p407/src/stm32_usb.c b/configs/olimex-stm32-p407/src/stm32_usb.c index 2f0c652f0a..428b44af62 100644 --- a/configs/olimex-stm32-p407/src/stm32_usb.c +++ b/configs/olimex-stm32-p407/src/stm32_usb.c @@ -300,11 +300,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-strp711/src/str71_spi.c b/configs/olimex-strp711/src/str71_spi.c index 1c18a4e553..f73dc744d5 100644 --- a/configs/olimex-strp711/src/str71_spi.c +++ b/configs/olimex-strp711/src/str71_spi.c @@ -952,7 +952,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t bu * Initialize the selected SPI port. This function could get called * multiple times for each STR7 devices that needs an SPI reference. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/configs/olimexino-stm32/src/olimexino-stm32.h b/configs/olimexino-stm32/src/olimexino-stm32.h index 987c55c00f..c3383eb8a2 100644 --- a/configs/olimexino-stm32/src/olimexino-stm32.h +++ b/configs/olimexino-stm32/src/olimexino-stm32.h @@ -163,7 +163,7 @@ void stm32_usbinitialize(void); * Description: * Called to setup set a call back for USB power state changes. * - * Inputs: + * Input Parameters: * pwr_changed_handler: An interrupt handler that will be called on VBUS power * state changes. * diff --git a/configs/olimexino-stm32/src/stm32_usbdev.c b/configs/olimexino-stm32/src/stm32_usbdev.c index 148ae44312..a2814fc361 100644 --- a/configs/olimexino-stm32/src/stm32_usbdev.c +++ b/configs/olimexino-stm32/src/stm32_usbdev.c @@ -69,7 +69,7 @@ * Name: stm32_usb_set_pwr_callback() * * Description: - * Inputs: + * Input Parameters: * pwr_changed_handler: An interrupt handler that will be called on VBUS power * state changes. * diff --git a/configs/photon/src/photon.h b/configs/photon/src/photon.h index f98c223341..5b2412f7e0 100644 --- a/configs/photon/src/photon.h +++ b/configs/photon/src/photon.h @@ -120,7 +120,7 @@ void weak_function stm32_spidev_initialize(void); * Description: * Perform architecture-specific initialization of the Watchdog hardware. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -138,7 +138,7 @@ int photon_watchdog_initialize(void); * Description: * Initialize wlan hardware and driver for Photon board. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/sam3u-ek/src/sam_spi.c b/configs/sam3u-ek/src/sam_spi.c index a6a08e7090..7813f8da7a 100644 --- a/configs/sam3u-ek/src/sam_spi.c +++ b/configs/sam3u-ek/src/sam_spi.c @@ -133,7 +133,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -165,7 +165,7 @@ void sam_spi0select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sam4e-ek/src/sam_spi.c b/configs/sam4e-ek/src/sam_spi.c index 340210ec8c..715f97ce73 100644 --- a/configs/sam4e-ek/src/sam_spi.c +++ b/configs/sam4e-ek/src/sam_spi.c @@ -135,7 +135,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -180,7 +180,7 @@ void sam_spi0select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sam4l-xplained/src/sam_spi.c b/configs/sam4l-xplained/src/sam_spi.c index a6eeee18a2..70787cc011 100644 --- a/configs/sam4l-xplained/src/sam_spi.c +++ b/configs/sam4l-xplained/src/sam_spi.c @@ -135,7 +135,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -178,7 +178,7 @@ void sam_spi0select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -225,7 +225,7 @@ uint8_t sam_spi0status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h b/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h index a20eb969de..e6baf02f1d 100644 --- a/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h +++ b/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h @@ -221,7 +221,7 @@ bool sam_writeprotected(int slotno); * Description: * Perform architecture-specific initialization of the Watchdog hardware. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/sama5d3-xplained/src/sam_nandflash.c b/configs/sama5d3-xplained/src/sam_nandflash.c index 69157cc3fa..f53fa352d9 100644 --- a/configs/sama5d3-xplained/src/sam_nandflash.c +++ b/configs/sama5d3-xplained/src/sam_nandflash.c @@ -91,7 +91,7 @@ * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/configs/sama5d3-xplained/src/sam_spi.c b/configs/sama5d3-xplained/src/sam_spi.c index a4e1b3d95d..ce4bfb6403 100644 --- a/configs/sama5d3-xplained/src/sam_spi.c +++ b/configs/sama5d3-xplained/src/sam_spi.c @@ -134,7 +134,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -168,7 +168,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sama5d3-xplained/src/sam_usb.c b/configs/sama5d3-xplained/src/sam_usb.c index 3189e94774..8abe5f5493 100644 --- a/configs/sama5d3-xplained/src/sam_usb.c +++ b/configs/sama5d3-xplained/src/sam_usb.c @@ -487,10 +487,10 @@ void sam_usbhost_vbusdrive(int rhport, bool enable) * REVISIT: Since this is a common signal, we will need to come up with some way * to inform both EHCI and OHCI drivers when this error occurs. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * - * Returned value: + * Returned Value: * Old overcurrent interrupt handler * ************************************************************************************/ diff --git a/configs/sama5d3x-ek/src/sam_nandflash.c b/configs/sama5d3x-ek/src/sam_nandflash.c index 50c327e9f3..e212a7f274 100644 --- a/configs/sama5d3x-ek/src/sam_nandflash.c +++ b/configs/sama5d3x-ek/src/sam_nandflash.c @@ -91,7 +91,7 @@ * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/configs/sama5d3x-ek/src/sam_spi.c b/configs/sama5d3x-ek/src/sam_spi.c index c9827f9a77..be4c0e322b 100644 --- a/configs/sama5d3x-ek/src/sam_spi.c +++ b/configs/sama5d3x-ek/src/sam_spi.c @@ -134,7 +134,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -168,7 +168,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sama5d3x-ek/src/sam_usb.c b/configs/sama5d3x-ek/src/sam_usb.c index 4607f641fe..614b6c31e2 100644 --- a/configs/sama5d3x-ek/src/sam_usb.c +++ b/configs/sama5d3x-ek/src/sam_usb.c @@ -479,10 +479,10 @@ void sam_usbhost_vbusdrive(int rhport, bool enable) * REVISIT: Since this is a common signal, we will need to come up with some way * to inform both EHCI and OHCI drivers when this error occurs. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * - * Returned value: + * Returned Value: * Old overcurrent interrupt handler * ************************************************************************************/ diff --git a/configs/sama5d4-ek/src/sam_nandflash.c b/configs/sama5d4-ek/src/sam_nandflash.c index 6a5c90db28..467ac8b106 100644 --- a/configs/sama5d4-ek/src/sam_nandflash.c +++ b/configs/sama5d4-ek/src/sam_nandflash.c @@ -91,7 +91,7 @@ * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/configs/sama5d4-ek/src/sam_spi.c b/configs/sama5d4-ek/src/sam_spi.c index 7534e373b1..611378c462 100644 --- a/configs/sama5d4-ek/src/sam_spi.c +++ b/configs/sama5d4-ek/src/sam_spi.c @@ -134,7 +134,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -168,7 +168,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sama5d4-ek/src/sam_usb.c b/configs/sama5d4-ek/src/sam_usb.c index d6923ea70a..081197a7fa 100644 --- a/configs/sama5d4-ek/src/sam_usb.c +++ b/configs/sama5d4-ek/src/sam_usb.c @@ -483,7 +483,7 @@ void sam_usbhost_vbusdrive(int rhport, bool enable) * Input Parameters: * handler - New over-current interrupt handler * - * Returned value: + * Returned Value: * Old over-current interrupt handler * ************************************************************************************/ diff --git a/configs/samd20-xplained/src/sam_spi.c b/configs/samd20-xplained/src/sam_spi.c index 2367243fe5..0a15fa4d35 100644 --- a/configs/samd20-xplained/src/sam_spi.c +++ b/configs/samd20-xplained/src/sam_spi.c @@ -142,7 +142,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -241,7 +241,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -340,7 +340,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/samd21-xplained/src/sam_spi.c b/configs/samd21-xplained/src/sam_spi.c index 32dbdb62bb..624fc59bba 100644 --- a/configs/samd21-xplained/src/sam_spi.c +++ b/configs/samd21-xplained/src/sam_spi.c @@ -142,7 +142,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -241,7 +241,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -340,7 +340,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/same70-xplained/src/sam_spi.c b/configs/same70-xplained/src/sam_spi.c index a9095c462d..57bde8904d 100644 --- a/configs/same70-xplained/src/sam_spi.c +++ b/configs/same70-xplained/src/sam_spi.c @@ -146,7 +146,7 @@ void sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -204,7 +204,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/saml21-xplained/src/sam_spi.c b/configs/saml21-xplained/src/sam_spi.c index 576444508d..ff654a2d30 100644 --- a/configs/saml21-xplained/src/sam_spi.c +++ b/configs/saml21-xplained/src/sam_spi.c @@ -142,7 +142,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -241,7 +241,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -340,7 +340,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/samv71-xult/src/sam_spi.c b/configs/samv71-xult/src/sam_spi.c index 563c03965c..e7e2271f9f 100644 --- a/configs/samv71-xult/src/sam_spi.c +++ b/configs/samv71-xult/src/sam_spi.c @@ -151,7 +151,7 @@ void sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -197,7 +197,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/shenzhou/src/stm32_usb.c b/configs/shenzhou/src/stm32_usb.c index 91bbe8d846..a45f43a83f 100644 --- a/configs/shenzhou/src/stm32_usb.c +++ b/configs/shenzhou/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/spark/src/stm32_cc3000.c b/configs/spark/src/stm32_cc3000.c index 92d255d6d9..8cda9fb602 100644 --- a/configs/spark/src/stm32_cc3000.c +++ b/configs/spark/src/stm32_cc3000.c @@ -327,7 +327,7 @@ int wireless_archinitialize(size_t max_rx_size) * Warning: This function must be called before ANY other wlan driver * function * - * Input Parmeters: + * Input Parameters: * sWlanCB Asynchronous events callback. * 0 no event call back. * - Call back parameters: diff --git a/configs/stm3210e-eval/include/board.h b/configs/stm3210e-eval/include/board.h index f76389222b..d03816b439 100644 --- a/configs/stm3210e-eval/include/board.h +++ b/configs/stm3210e-eval/include/board.h @@ -261,7 +261,7 @@ void stm3210e_lcdclear(uint16_t color); * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: @@ -279,7 +279,7 @@ int stm32_lm75initialize(FAR const char *devpath); * Description: * Attach the LM-75 interrupt handler * - * Input parameters: + * Input Parameters: * irqhandler - the LM-75 interrupt handler * arg - The argument that will accompany the interrupt * diff --git a/configs/stm3210e-eval/src/stm32_lm75.c b/configs/stm3210e-eval/src/stm32_lm75.c index a083b78383..52b04c495b 100644 --- a/configs/stm3210e-eval/src/stm32_lm75.c +++ b/configs/stm3210e-eval/src/stm32_lm75.c @@ -60,7 +60,7 @@ * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: @@ -104,7 +104,7 @@ int stm32_lm75initialize(FAR const char *devpath) * Description: * Attach the LM-75 interrupt handler * - * Input parameters: + * Input Parameters: * irqhandler - the LM-75 interrupt handler * arg - The argument that will accompany the interrupt * diff --git a/configs/stm3210e-eval/src/stm32_pm.c b/configs/stm3210e-eval/src/stm32_pm.c index 1da3078a9c..7c7b13f4b9 100644 --- a/configs/stm3210e-eval/src/stm32_pm.c +++ b/configs/stm3210e-eval/src/stm32_pm.c @@ -78,10 +78,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/configs/stm3220g-eval/src/stm32_usb.c b/configs/stm3220g-eval/src/stm32_usb.c index 328aad2471..71474fa5ce 100644 --- a/configs/stm3220g-eval/src/stm32_usb.c +++ b/configs/stm3220g-eval/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm3240g-eval/src/stm32_usb.c b/configs/stm3240g-eval/src/stm32_usb.c index e89cf8116f..eb1e60d951 100644 --- a/configs/stm3240g-eval/src/stm32_usb.c +++ b/configs/stm3240g-eval/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32butterfly2/src/stm32_boot.c b/configs/stm32butterfly2/src/stm32_boot.c index f42e7a7fd7..928b558633 100644 --- a/configs/stm32butterfly2/src/stm32_boot.c +++ b/configs/stm32butterfly2/src/stm32_boot.c @@ -66,7 +66,7 @@ void stm32_boardinitialize(void) * Description: * Initializes upper half drivers with board specific settings * - * Returned value: + * Returned Value: * 0 on sucess or errno value of failed init function. ****************************************************************************/ diff --git a/configs/stm32butterfly2/src/stm32_leds.c b/configs/stm32butterfly2/src/stm32_leds.c index dae6352fa7..4fced6d597 100644 --- a/configs/stm32butterfly2/src/stm32_leds.c +++ b/configs/stm32butterfly2/src/stm32_leds.c @@ -130,7 +130,7 @@ void stm32_led_initialize(void) * Description: * Drives board leds when specific RTOS state led occurs. * - * Input parameters: + * Input Parameters: * led - This is actually an RTOS state not led number of anything like that ****************************************************************************/ @@ -173,7 +173,7 @@ void board_autoled_on(int led) * Description: * Drives board leds when specific RTOS state led ends * - * Input parameters: + * Input Parameters: * led - This is actually an RTOS state not led number of anything like that ****************************************************************************/ @@ -225,7 +225,7 @@ void board_userled_initialize(void) * Description: * Sets led to ledon state. * - * Input parameters: + * Input Parameters: * led - Led to be set, indexed from 0 * ledon - new state for the led. ****************************************************************************/ @@ -251,7 +251,7 @@ void board_userled(int led, bool ledon) * Description: * Sets whole ledset to given state. * - * Input parameters: + * Input Parameters: * ledset - Led bits to be set on or off ****************************************************************************/ diff --git a/configs/stm32f103-minimum/src/stm32_apa102.c b/configs/stm32f103-minimum/src/stm32_apa102.c index 32717b212b..88c5a5ae49 100644 --- a/configs/stm32f103-minimum/src/stm32_apa102.c +++ b/configs/stm32f103-minimum/src/stm32_apa102.c @@ -68,7 +68,7 @@ * Description: * Initialize and register the APA102 LED Strip driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/leddrv0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_apds9960.c b/configs/stm32f103-minimum/src/stm32_apds9960.c index 14045df518..614cbcf45d 100644 --- a/configs/stm32f103-minimum/src/stm32_apds9960.c +++ b/configs/stm32f103-minimum/src/stm32_apds9960.c @@ -136,7 +136,7 @@ static int apds9960_irq_attach(FAR struct apds9960_config_s *state, xcpt_t isr, * Description: * Initialize and register the APDS9960 gesture sensor. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/gest0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_lm75.c b/configs/stm32f103-minimum/src/stm32_lm75.c index 7cd9b2422e..75e193354f 100644 --- a/configs/stm32f103-minimum/src/stm32_lm75.c +++ b/configs/stm32f103-minimum/src/stm32_lm75.c @@ -60,7 +60,7 @@ * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: @@ -104,7 +104,7 @@ int stm32_lm75initialize(FAR const char *devpath) * Description: * Attach the LM-75 interrupt handler * - * Input parameters: + * Input Parameters: * irqhandler - the LM-75 interrupt handler * arg - The argument that will accompany the interrupt * diff --git a/configs/stm32f103-minimum/src/stm32_mcp2515.c b/configs/stm32f103-minimum/src/stm32_mcp2515.c index 739cfe884a..a7794603fd 100644 --- a/configs/stm32f103-minimum/src/stm32_mcp2515.c +++ b/configs/stm32f103-minimum/src/stm32_mcp2515.c @@ -173,7 +173,7 @@ static int mcp2515_attach(FAR struct mcp2515_config_s *state, * Description: * Initialize and register the MCP2515 RFID driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/rfid0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_mfrc522.c b/configs/stm32f103-minimum/src/stm32_mfrc522.c index 441bc5a6fa..5fc1db4b4b 100644 --- a/configs/stm32f103-minimum/src/stm32_mfrc522.c +++ b/configs/stm32f103-minimum/src/stm32_mfrc522.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MFRC522 RFID driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/rfid0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_nrf24l01.c b/configs/stm32f103-minimum/src/stm32_nrf24l01.c index 6edecba0e0..34bf775091 100644 --- a/configs/stm32f103-minimum/src/stm32_nrf24l01.c +++ b/configs/stm32f103-minimum/src/stm32_nrf24l01.c @@ -105,7 +105,7 @@ static void stm32tiny_wl_chip_enable(bool enable) * Description: * Initialize the NRF24L01 wireless module * - * Input Parmeters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_veml6070.c b/configs/stm32f103-minimum/src/stm32_veml6070.c index 5e8765e9e7..8a84517f2f 100644 --- a/configs/stm32f103-minimum/src/stm32_veml6070.c +++ b/configs/stm32f103-minimum/src/stm32_veml6070.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the VEML6070 UV-A Light sensor. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/uvlight0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32f103_minimum.h b/configs/stm32f103-minimum/src/stm32f103_minimum.h index f3159c7eac..18b6a5e41b 100644 --- a/configs/stm32f103-minimum/src/stm32f103_minimum.h +++ b/configs/stm32f103-minimum/src/stm32f103_minimum.h @@ -402,7 +402,7 @@ int stm32_pwm_setup(void); * Description: * Initialize the NRF24L01 wireless module * - * Input Parmeters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/stm32f334-disco/src/stm32f334-disco.h b/configs/stm32f334-disco/src/stm32f334-disco.h index 904c8acc10..085d5abe14 100644 --- a/configs/stm32f334-disco/src/stm32f334-disco.h +++ b/configs/stm32f334-disco/src/stm32f334-disco.h @@ -113,7 +113,7 @@ void weak_function stm32_spidev_initialize(void); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/stm32f411e-disco/src/stm32_usb.c b/configs/stm32f411e-disco/src/stm32_usb.c index 223fb94932..2e2861a4cf 100644 --- a/configs/stm32f411e-disco/src/stm32_usb.c +++ b/configs/stm32f411e-disco/src/stm32_usb.c @@ -312,11 +312,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32f429i-disco/src/stm32_l3gd20.c b/configs/stm32f429i-disco/src/stm32_l3gd20.c index 7a8c449c62..1dcd99c1b3 100644 --- a/configs/stm32f429i-disco/src/stm32_l3gd20.c +++ b/configs/stm32f429i-disco/src/stm32_l3gd20.c @@ -100,7 +100,7 @@ static int l3gd20_attach(FAR struct l3gd20_config_s *cfg, xcpt_t irq) * Description: * Initialize and register the L3GD20 3 axis gyroscope sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/gyro0" * * Returned Value: diff --git a/configs/stm32f429i-disco/src/stm32_lcd.c b/configs/stm32f429i-disco/src/stm32_lcd.c index ab4d43ae38..e327c53b5f 100644 --- a/configs/stm32f429i-disco/src/stm32_lcd.c +++ b/configs/stm32f429i-disco/src/stm32_lcd.c @@ -420,7 +420,7 @@ static int stm32_ili9341_initialize(void) * * Parameter: * - * Return: + * Returned Value: * ************************************************************************************/ @@ -444,7 +444,7 @@ void board_lcd_uninitialize(void) * Parameter: * lcddev - Number of the LDC Device. * - * Return: + * Returned Value: * Reference to the LCD object if exist otherwise NULL * ************************************************************************************/ @@ -469,7 +469,7 @@ FAR struct lcd_dev_s *board_lcd_getdev(int lcddev) * * Parameter: * - * Return: + * Returned Value: * On success - Ok * On error - Error Code * @@ -515,7 +515,7 @@ int board_lcd_initialize(void) * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -555,7 +555,7 @@ int up_fbinitialize(int display) * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/configs/stm32f429i-disco/src/stm32_spi.c b/configs/stm32f429i-disco/src/stm32_spi.c index 16a23cc564..3aaecc60d1 100644 --- a/configs/stm32f429i-disco/src/stm32_spi.c +++ b/configs/stm32f429i-disco/src/stm32_spi.c @@ -279,7 +279,7 @@ int stm32_spi5cmddata(FAR struct spi_dev_s *dev, uint32_t devid, bool cmd) * device after the first initializing and should be used by each driver who * shares the spi5 bus. * - * Input Parameter: + * Input Parameters: * * Returned Value: * Valid SPI device structure reference on success; a NULL on failure diff --git a/configs/stm32f429i-disco/src/stm32_usb.c b/configs/stm32f429i-disco/src/stm32_usb.c index 3d597eff7c..b178650480 100644 --- a/configs/stm32f429i-disco/src/stm32_usb.c +++ b/configs/stm32f429i-disco/src/stm32_usb.c @@ -282,7 +282,7 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32f429i-disco/src/stm32f429i-disco.h b/configs/stm32f429i-disco/src/stm32f429i-disco.h index d324060876..18063a5391 100644 --- a/configs/stm32f429i-disco/src/stm32f429i-disco.h +++ b/configs/stm32f429i-disco/src/stm32f429i-disco.h @@ -361,7 +361,7 @@ FAR struct ili9341_lcd_s *stm32_ili93414ws_initialize(void); * the initialized state of the spi device after the first initializing * and should be used by each driver who shares the spi5 bus. * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -379,7 +379,7 @@ FAR struct spi_dev_s *stm32_spi5initialize(void); * Description: * Initialize and register the L3GD20 3 axis gyroscope sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/gyro0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_bh1750fvi.c b/configs/stm32f4discovery/src/stm32_bh1750fvi.c index 8ac3fe6846..2012762d17 100644 --- a/configs/stm32f4discovery/src/stm32_bh1750fvi.c +++ b/configs/stm32f4discovery/src/stm32_bh1750fvi.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/light0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_bmp180.c b/configs/stm32f4discovery/src/stm32_bmp180.c index b7ea5f568d..41553e1af7 100644 --- a/configs/stm32f4discovery/src/stm32_bmp180.c +++ b/configs/stm32f4discovery/src/stm32_bmp180.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/press0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_lis3dsh.c b/configs/stm32f4discovery/src/stm32_lis3dsh.c index b48a5614fa..600621786f 100644 --- a/configs/stm32f4discovery/src/stm32_lis3dsh.c +++ b/configs/stm32f4discovery/src/stm32_lis3dsh.c @@ -68,7 +68,7 @@ * Attach the lis3dsh interrupt handler to PE0/EXT0 on the STM32F4 as wired * on STM32F4Discovery * - * Input parameters: + * Input Parameters: * *config - The lis3dsh instance configuration data containing the IRQ number, * device ID and interrupt handler * interrupt_handler - The interrupt handler to attach @@ -98,7 +98,7 @@ int attach_disc_lis3dsh(FAR struct lis3dsh_config_s *config, xcpt_t interrupt_ha * Description: * Initialize and register the LIS3DSH 3-axis accelerometer. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/acc0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_max31855.c b/configs/stm32f4discovery/src/stm32_max31855.c index 2a03d70d7f..388fcf585d 100644 --- a/configs/stm32f4discovery/src/stm32_max31855.c +++ b/configs/stm32f4discovery/src/stm32_max31855.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MAX31855 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_max6675.c b/configs/stm32f4discovery/src/stm32_max6675.c index 759565c6e2..d0360c5f33 100644 --- a/configs/stm32f4discovery/src/stm32_max6675.c +++ b/configs/stm32f4discovery/src/stm32_max6675.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MAX6675 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_pm.c b/configs/stm32f4discovery/src/stm32_pm.c index c012e397c3..0bce85cc54 100644 --- a/configs/stm32f4discovery/src/stm32_pm.c +++ b/configs/stm32f4discovery/src/stm32_pm.c @@ -79,10 +79,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/configs/stm32f4discovery/src/stm32_timer.c b/configs/stm32f4discovery/src/stm32_timer.c index 326f2f25c0..3586a181aa 100644 --- a/configs/stm32f4discovery/src/stm32_timer.c +++ b/configs/stm32f4discovery/src/stm32_timer.c @@ -67,7 +67,7 @@ * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/stm32f4discovery/src/stm32_usb.c b/configs/stm32f4discovery/src/stm32_usb.c index 6386b566ac..e5fa78951e 100644 --- a/configs/stm32f4discovery/src/stm32_usb.c +++ b/configs/stm32f4discovery/src/stm32_usb.c @@ -312,11 +312,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32f4discovery/src/stm32f4discovery.h b/configs/stm32f4discovery/src/stm32f4discovery.h index 51936d9485..7a711fc3f1 100644 --- a/configs/stm32f4discovery/src/stm32f4discovery.h +++ b/configs/stm32f4discovery/src/stm32f4discovery.h @@ -750,7 +750,7 @@ int stm32_rgbled_setup(void); * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/stm32f746-ws/src/stm32_usb.c b/configs/stm32f746-ws/src/stm32_usb.c index 8fa3f1e827..46877033ba 100644 --- a/configs/stm32f746-ws/src/stm32_usb.c +++ b/configs/stm32f746-ws/src/stm32_usb.c @@ -304,11 +304,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32l476vg-disco/src/stm32_usb.c b/configs/stm32l476vg-disco/src/stm32_usb.c index a2c7ddadfa..60858f581a 100644 --- a/configs/stm32l476vg-disco/src/stm32_usb.c +++ b/configs/stm32l476vg-disco/src/stm32_usb.c @@ -301,10 +301,10 @@ void stm32l4_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an over current condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New over current interrupt handler * - * Returned value: + * Returned Value: * Old over current interrupt handler * ************************************************************************************/ diff --git a/configs/teensy-lc/src/kl_spi.c b/configs/teensy-lc/src/kl_spi.c index efd1c96ce3..17193881f4 100644 --- a/configs/teensy-lc/src/kl_spi.c +++ b/configs/teensy-lc/src/kl_spi.c @@ -124,7 +124,7 @@ void weak_function kl_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -156,7 +156,7 @@ void kl_spi1select(FAR struct spi_dev_s *dev, uint32_t devid, * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -187,7 +187,7 @@ uint8_t kl_spi1status(FAR struct spi_dev_s *dev, uint32_t devid) * devid - Identifies the (logical) device * cmd - Determines where command or data should be selected. * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/u-blox-c027/src/lpc17_ubxmdm.c b/configs/u-blox-c027/src/lpc17_ubxmdm.c index bd165b96d2..2e333a8fcb 100644 --- a/configs/u-blox-c027/src/lpc17_ubxmdm.c +++ b/configs/u-blox-c027/src/lpc17_ubxmdm.c @@ -281,7 +281,7 @@ static int lpc17_ioctl(FAR struct ubxmdm_lower* lower, * Input Parameters: * usb_used - enables the USB sense pin if 'true' * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/configs/viewtool-stm32f107/src/stm32_mpl115a.c b/configs/viewtool-stm32f107/src/stm32_mpl115a.c index c6a1b9e634..2e78e2e5ac 100644 --- a/configs/viewtool-stm32f107/src/stm32_mpl115a.c +++ b/configs/viewtool-stm32f107/src/stm32_mpl115a.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/press0" * * Returned Value: diff --git a/configs/viewtool-stm32f107/src/viewtool_stm32f107.h b/configs/viewtool-stm32f107/src/viewtool_stm32f107.h index 8a196108c5..7aaa0f0114 100644 --- a/configs/viewtool-stm32f107/src/viewtool_stm32f107.h +++ b/configs/viewtool-stm32f107/src/viewtool_stm32f107.h @@ -407,7 +407,7 @@ int stm32_can_setup(void); * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/press0" * * Returned Value: diff --git a/configs/zp214xpa/src/lpc2148_spi1.c b/configs/zp214xpa/src/lpc2148_spi1.c index a7b479082b..f9c1cc2693 100644 --- a/configs/zp214xpa/src/lpc2148_spi1.c +++ b/configs/zp214xpa/src/lpc2148_spi1.c @@ -569,7 +569,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/crypto/aes.c b/crypto/aes.c index e7c638f718..3927a28360 100644 --- a/crypto/aes.c +++ b/crypto/aes.c @@ -555,7 +555,7 @@ static void aes_decr(FAR uint8_t *state, FAR const uint8_t *expanded_key) * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -580,7 +580,7 @@ void aes_encrypt(FAR uint8_t *state, FAR const uint8_t *key) * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ diff --git a/drivers/analog/ad5410.c b/drivers/analog/ad5410.c index 679edf2c5f..ab8609480e 100644 --- a/drivers/analog/ad5410.c +++ b/drivers/analog/ad5410.c @@ -270,7 +270,7 @@ static int dac_ioctl(FAR struct dac_dev_s *dev, int cmd, unsigned long arg) * Description: * Initialize the selected DAC port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple DAC interfaces) * * Returned Value: diff --git a/drivers/analog/ads1255.c b/drivers/analog/ads1255.c index 408dd92a29..460f35e380 100644 --- a/drivers/analog/ads1255.c +++ b/drivers/analog/ads1255.c @@ -502,7 +502,7 @@ static int adc_interrupt(int irq, void *context, FAR void *arg) * Description: * Initialize the selected adc port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple adc interfaces) * * Returned Value: diff --git a/drivers/analog/dac.c b/drivers/analog/dac.c index 7e028e26f5..bfc2468463 100644 --- a/drivers/analog/dac.c +++ b/drivers/analog/dac.c @@ -465,7 +465,7 @@ static int dac_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * Description: * Called from the DAC interrupt handler at the completion of a send operation. * - * Return: + * Returned Value: * OK on success; a negated errno on failure. * ************************************************************************************/ diff --git a/drivers/audio/tone.c b/drivers/audio/tone.c index bc5e5740c1..d0dfb4d33b 100644 --- a/drivers/audio/tone.c +++ b/drivers/audio/tone.c @@ -922,7 +922,7 @@ static ssize_t tone_write(FAR struct file *filep, FAR const char *buffer, * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name of PWM driver * as "/dev/tone0". diff --git a/drivers/can/can.c b/drivers/can/can.c index 7a590d5a73..6232f70ee8 100644 --- a/drivers/can/can.c +++ b/drivers/can/can.c @@ -239,7 +239,7 @@ static void can_pollnotify(FAR struct can_dev_s *dev, pollevent_t eventset) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * dlc - the DLC value to convert to a byte count * * Returned Value: @@ -288,7 +288,7 @@ static uint8_t can_dlc2bytes(uint8_t dlc) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * nbytes - the byte count to convert to a DLC value * * Returned Value: diff --git a/drivers/can/mcp2515.c b/drivers/can/mcp2515.c index 3b68c4d43b..b8ce91bfeb 100644 --- a/drivers/can/mcp2515.c +++ b/drivers/can/mcp2515.c @@ -2369,7 +2369,7 @@ static int mcp2515_interrupt(FAR struct mcp2515_config_s *config, FAR void *arg) * Description: * MCP2515 hardware initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this MCP2515 peripheral * * Returned Value: @@ -2483,7 +2483,7 @@ static int mcp2515_hw_initialize(struct mcp2515_can_s *priv) * Description: * Initialize the selected MCP2515 CAN Bus Controller over SPI * - * Input Parameter: + * Input Parameters: * config - The configuration structure passed by the board. * * Returned Value: @@ -2554,7 +2554,7 @@ FAR struct mcp2515_can_s *mcp2515_instantiate(FAR struct mcp2515_config_s *confi * Description: * Initialize the selected MCP2515 CAN Bus Controller over SPI * - * Input Parameter: + * Input Parameters: * config - The configuration structure passed by the board. * * Returned Value: diff --git a/drivers/contactless/pn532.c b/drivers/contactless/pn532.c index 6f1d8fb531..b62e5fa9f2 100644 --- a/drivers/contactless/pn532.c +++ b/drivers/contactless/pn532.c @@ -927,8 +927,8 @@ static int _close(FAR struct file *filep) * Description: * This routine is called when the device is read. * - * Returns TAG id as string to buffer. - * or -EIO if no TAG found + * Returned Value: + * TAG id as string to buffer or -EIO if no TAG found * ****************************************************************************/ diff --git a/drivers/input/ajoystick.c b/drivers/input/ajoystick.c index bed67d1890..233807ddd0 100644 --- a/drivers/input/ajoystick.c +++ b/drivers/input/ajoystick.c @@ -842,7 +842,7 @@ errout_with_dusem: * lower - An instance of the platform-specific analog joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/input/button_upper.c b/drivers/input/button_upper.c index c172ecfa1d..b60e77f60d 100644 --- a/drivers/input/button_upper.c +++ b/drivers/input/button_upper.c @@ -823,7 +823,7 @@ errout_with_dusem: * minor device number. * lower - An instance of the platform-specific button lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/input/djoystick.c b/drivers/input/djoystick.c index 6ada3f76e1..3854e22c93 100644 --- a/drivers/input/djoystick.c +++ b/drivers/input/djoystick.c @@ -837,7 +837,7 @@ errout_with_dusem: * lower - An instance of the platform-specific discrete joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/input/nunchuck.c b/drivers/input/nunchuck.c index ccd591802a..b1b2df93f3 100644 --- a/drivers/input/nunchuck.c +++ b/drivers/input/nunchuck.c @@ -567,7 +567,7 @@ static int nunchuck_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * minor device number. * i2c - An instance of the platform-specific I2C connected to Nunchuck. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/lcd/ili9341.c b/drivers/lcd/ili9341.c index ad31db450e..b55404fb2c 100644 --- a/drivers/lcd/ili9341.c +++ b/drivers/lcd/ili9341.c @@ -532,7 +532,7 @@ static struct ili9341_dev_s g_lcddev[CONFIG_LCD_ILI9341_NINTERFACES] = * Parameters: * dev - Reference to private driver structure * - * Return Value: + * Returned Value: * * Horicontal resolution * @@ -560,7 +560,7 @@ static inline uint16_t ili9341_getxres(FAR struct ili9341_dev_s *dev) * Parameter: * dev - Reference to private driver structure * - * Return Value: + * Returned Value: * * Vertical resolution * diff --git a/drivers/lcd/lcd_framebuffer.c b/drivers/lcd/lcd_framebuffer.c index 369d774a21..db9c27ffaa 100644 --- a/drivers/lcd/lcd_framebuffer.c +++ b/drivers/lcd/lcd_framebuffer.c @@ -451,7 +451,7 @@ static int lcdfb_setcursor(FAR struct fb_vtable_s *vtable, * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -598,7 +598,7 @@ errout_with_state: * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/drivers/leds/rgbled.c b/drivers/leds/rgbled.c index 0ba2229bdb..1bb4e89f72 100644 --- a/drivers/leds/rgbled.c +++ b/drivers/leds/rgbled.c @@ -420,7 +420,7 @@ static ssize_t rgbled_write(FAR struct file *filep, FAR const char *buffer, * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/rgdbled0", "/dev/rgbled1", etc. where the driver path diff --git a/drivers/leds/userled_upper.c b/drivers/leds/userled_upper.c index f851f33cce..ef414cda81 100644 --- a/drivers/leds/userled_upper.c +++ b/drivers/leds/userled_upper.c @@ -527,7 +527,7 @@ static int userled_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * minor device number. * lower - An instance of the platform-specific LED lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/mtd/hamming.c b/drivers/mtd/hamming.c index 95d192db11..7628e9d4d0 100644 --- a/drivers/mtd/hamming.c +++ b/drivers/mtd/hamming.c @@ -65,7 +65,7 @@ * Input Parameters: * bytes - The byte to use. * - * Returned Values: + * Returned Value: * Returns the number of bits set to '1' in the given byte. * ****************************************************************************/ @@ -95,7 +95,7 @@ static unsigned int hamming_bitsinbyte(uint8_t byte) * Input Parameters: * code - Hamming code * - * Returned Values: + * Returned Value: * Returns the number of bits set to '1' in the given hamming code. * ****************************************************************************/ @@ -117,7 +117,7 @@ static uint8_t hamming_bitsincode256(FAR uint8_t *code) * data - Data buffer to calculate code * code - Pointer to a buffer where the code should be stored * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -272,7 +272,7 @@ static void hamming_compute256(FAR const uint8_t *data, FAR uint8_t *code) * data - Data buffer to check * original - Hamming code to use for verifying the data * - * Returned Values: + * Returned Value: * Zero on success, otherwise returns a HAMMING_ERROR_ code. * ****************************************************************************/ @@ -372,7 +372,7 @@ static int hamming_verify256(FAR uint8_t *data, FAR const uint8_t *original) * size - Data size in bytes * code - Codes buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -408,7 +408,7 @@ void hamming_compute256x(FAR const uint8_t *data, size_t size, uint8_t *code) * size - Size of the data in bytes * code - Original codes * - * Returned Values: + * Returned Value: * Return 0 if the data is correct, HAMMING_ERROR_SINGLEBIT if one or more * block(s) have had a single bit corrected, or either HAMMING_ERROR_ECC * or HAMMING_ERROR_MULTIPLEBITS. diff --git a/drivers/mtd/mtd_config.c b/drivers/mtd/mtd_config.c index 9a0d4077c1..32a2a72e59 100644 --- a/drivers/mtd/mtd_config.c +++ b/drivers/mtd/mtd_config.c @@ -336,7 +336,7 @@ errout: * * Locates the first config entry, even if it is empty. * - * Returns: + * Returned Value: * offset to the start of the entry. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int mtdconfig_findfirstentry(FAR struct mtdconfig_struct_s *dev, * * Locates the next config entry starting at offset, even if it is empty. * - * Returns: + * Returned Value: * offset to the start of the next entry. * ****************************************************************************/ @@ -562,7 +562,7 @@ read_next: * method of consolidation is used when only a single erase * block is available in the partition. * - * Returns: + * Returned Value: * offset to the next available entry (after consolidation).. * ****************************************************************************/ @@ -719,7 +719,7 @@ errout: * erased block. It erases all blocks to the end of the * partition as it goes. * - * Returns: + * Returned Value: * offset to the next available entry (after consolidation).. * ****************************************************************************/ diff --git a/drivers/mtd/mtd_nand.c b/drivers/mtd/mtd_nand.c index 8394af67de..09586f7e1c 100644 --- a/drivers/mtd/mtd_nand.c +++ b/drivers/mtd/mtd_nand.c @@ -372,7 +372,7 @@ static uint32_t nand_chipid(struct nand_raw_s *raw) * block Number of block to erase * scrub True: Erase bad blocks * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -438,13 +438,13 @@ static int nand_eraseblock(FAR struct nand_dev_s *nand, off_t block, * Reads the data area (only) of a page of a NAND FLASH into the * provided buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -493,13 +493,13 @@ static int nand_readpage(FAR struct nand_dev_s *nand, off_t block, * Writes the data area (only) of a page into NAND FLASH from the * provided buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -836,7 +836,7 @@ static int nand_ioctl(struct mtd_dev_s *dev, int cmd, unsigned long arg) * Description: * Probe and initialize NAND. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * cmdaddr - NAND command address base * addraddr - NAND address address base @@ -844,7 +844,7 @@ static int nand_ioctl(struct mtd_dev_s *dev, int cmd, unsigned long arg) * model - A pointer to the model data (probably in the raw MTD * driver instance. * - * Returned value. + * Returned Value: * A non-NULL MTD driver intstance is returned on success. NULL is * returned on any failaure. * diff --git a/drivers/mtd/mtd_nandecc.c b/drivers/mtd/mtd_nandecc.c index e22bc23175..47fb3b31be 100644 --- a/drivers/mtd/mtd_nandecc.c +++ b/drivers/mtd/mtd_nandecc.c @@ -75,14 +75,14 @@ * the spare area. If a buffer pointer is NULL, then the corresponding area * is not saved. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -166,14 +166,14 @@ int nandecc_readpage(FAR struct nand_dev_s *nand, off_t block, * If no spare buffer is provided, the spare area is still written with the * ECC information calculated on the data buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ diff --git a/drivers/mtd/mtd_nandmodel.c b/drivers/mtd/mtd_nandmodel.c index cd3c324c9c..2b9c09472b 100644 --- a/drivers/mtd/mtd_nandmodel.c +++ b/drivers/mtd/mtd_nandmodel.c @@ -76,7 +76,7 @@ * chipid Identifier returned by the Nand(id1|(id2<<8)|(id3<<16)|(id4<<24)). * model nand_model_s instance to update with the model parameters. * - * Returned Values: + * Returned Value: * OK is returned on success; -ENODEV is returned on failure. * ****************************************************************************/ @@ -186,7 +186,7 @@ int nandmodel_find(FAR const struct nand_model_s *modeltab, size_t size, * page Stores the first accessed page number inside the first block. * offset Stores the byte offset inside the first accessed page. * - * Returned Values: + * Returned Value: * OK on success; -EPIPE on failure. * ****************************************************************************/ @@ -252,7 +252,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * size of spare area in bytes * ****************************************************************************/ diff --git a/drivers/mtd/mtd_nandscheme.c b/drivers/mtd/mtd_nandscheme.c index cf0557f22a..17269bb09d 100644 --- a/drivers/mtd/mtd_nandscheme.c +++ b/drivers/mtd/mtd_nandscheme.c @@ -182,7 +182,7 @@ const struct nand_scheme_s g_nand_sparescheme4096 = * spare Spare area buffer. * marker Pointer to the variable to store the bad block marker. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -206,7 +206,7 @@ void nandscheme_readbadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * marker Bad block marker to write. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -228,7 +228,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -255,7 +255,7 @@ void nandscheme_readecc(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -285,7 +285,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to read. * offset Index where to read the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -318,7 +318,7 @@ void nandscheme_readextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -349,7 +349,7 @@ void nandscheme_writeextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/mtd/mtd_partition.c b/drivers/mtd/mtd_partition.c index f8438cdd97..54c88e9816 100644 --- a/drivers/mtd/mtd_partition.c +++ b/drivers/mtd/mtd_partition.c @@ -767,7 +767,7 @@ static int part_procfs_stat(const char *relpath, struct stat *buf) * partitions, that mutual exclusion would be provided by the file system * above the FLASH driver. * - * Input parameters: + * Input Parameters: * mtd - The MTD device to be partitioned * firstblock - The offset in bytes to the first block * nblocks - The number of blocks in the partition diff --git a/drivers/net/telnet.c b/drivers/net/telnet.c index 6c849826ef..db5419125d 100644 --- a/drivers/net/telnet.c +++ b/drivers/net/telnet.c @@ -690,7 +690,7 @@ static ssize_t telnet_read(FAR struct file *filep, FAR char *buffer, size_t len) } while (ret == 0); - /* Return: + /* Returned Value: * * ret > 0: The number of characters copied into the user buffer by * telnet_receive(). @@ -783,7 +783,7 @@ static ssize_t telnet_write(FAR struct file *filep, FAR const char *buffer, size * session - On input, contains the socket descriptor that represents the * new telnet connection. On output, it holds the path to the new Telnet driver. * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -978,7 +978,7 @@ static int common_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * Parameters: * None * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/pipes/fifo.c b/drivers/pipes/fifo.c index 43afa5556f..6a8905a6a2 100644 --- a/drivers/pipes/fifo.c +++ b/drivers/pipes/fifo.c @@ -97,13 +97,13 @@ static const struct file_operations fifo_fops = * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * pathname - The full path to the FIFO instance to attach to or to create * (if not already created). * mode - Ignored for now * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/drivers/pipes/pipe.c b/drivers/pipes/pipe.c index b32ef965e9..f3a98e6351 100644 --- a/drivers/pipes/pipe.c +++ b/drivers/pipes/pipe.c @@ -177,12 +177,12 @@ static int pipe_close(FAR struct file *filep) * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * fd[2] - The user provided array in which to catch the pipe file * descriptors * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/drivers/power/battery_charger.c b/drivers/power/battery_charger.c index 0bacbd90e3..5467f49093 100644 --- a/drivers/power/battery_charger.c +++ b/drivers/power/battery_charger.c @@ -270,12 +270,12 @@ static int bat_charger_ioctl(FAR struct file *filep, int cmd, * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/power/battery_gauge.c b/drivers/power/battery_gauge.c index ab97489188..9936147be1 100644 --- a/drivers/power/battery_gauge.c +++ b/drivers/power/battery_gauge.c @@ -233,12 +233,12 @@ static int bat_gauge_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/power/pm_initialize.c b/drivers/power/pm_initialize.c index 83b67645f7..bb777f9865 100644 --- a/drivers/power/pm_initialize.c +++ b/drivers/power/pm_initialize.c @@ -70,10 +70,10 @@ struct pm_global_s g_pmglobals; * other device drivers are initialize (since they may attempt to register * with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/drivers/power/pm_register.c b/drivers/power/pm_register.c index b33dab6962..0604631358 100644 --- a/drivers/power/pm_register.c +++ b/drivers/power/pm_register.c @@ -59,11 +59,11 @@ * This function is called by a device driver in order to register to * receive power management event callbacks. * - * Input parameters: + * Input Parameters: * callbacks - An instance of struct pm_callback_s providing the driver * callback functions. * - * Returned value: + * Returned Value: * Zero (OK) on success; otherwise a negater errno value is returned. * ****************************************************************************/ diff --git a/drivers/pwm.c b/drivers/pwm.c index 44d644cc64..085c3065e9 100644 --- a/drivers/pwm.c +++ b/drivers/pwm.c @@ -568,7 +568,7 @@ static int pwm_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registered in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/pwm0", "/dev/pwm1", etc. where the driver path differs only @@ -641,7 +641,7 @@ int pwm_register(FAR const char *path, FAR struct pwm_lowerhalf_s *dev) * interface using the handle that was previously passed to the * start() method * - * Input parameters: + * Input Parameters: * handle - This is the handle that was provided to the lower-half * start() method. * diff --git a/drivers/ramdisk.c b/drivers/ramdisk.c index b31e1f0dd9..842c36cd9d 100644 --- a/drivers/ramdisk.c +++ b/drivers/ramdisk.c @@ -428,14 +428,14 @@ static int rd_unlink(FAR struct inode *inode) * Description: * Non-standard function to register a ramdisk or a romdisk * - * Input Parmeters: + * Input Parameters: * minor: Selects suffix of device named /dev/ramN, N={1,2,3...} * nsectors: Number of sectors on device * sectize: The size of one sector * rdflags: See RDFLAG_* definitions * buffer: RAM disk backup memory * - * Returned Valued: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/syslog/syslog_emergstream.c b/drivers/syslog/syslog_emergstream.c index 8347c15a8e..e7aef97e23 100644 --- a/drivers/syslog/syslog_emergstream.c +++ b/drivers/syslog/syslog_emergstream.c @@ -97,7 +97,7 @@ static void emergstream_putc(FAR struct lib_outstream_s *this, int ch) * Initializes a stream for use with the configured emergency syslog * interface. Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_outstream_s to be initialized. * diff --git a/drivers/syslog/syslog_stream.c b/drivers/syslog/syslog_stream.c index a71bd933d7..e3e2b1b57d 100644 --- a/drivers/syslog/syslog_stream.c +++ b/drivers/syslog/syslog_stream.c @@ -199,7 +199,7 @@ static void syslogstream_putc(FAR struct lib_outstream_s *this, int ch) * Initializes a stream for use with the configured syslog interface. * Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -245,7 +245,7 @@ void syslogstream_create(FAR struct lib_syslogstream_s *stream) * Description: * Free resources held by the syslog stream. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * diff --git a/drivers/timers/rtc.c b/drivers/timers/rtc.c index f38979ee50..380bb35419 100644 --- a/drivers/timers/rtc.c +++ b/drivers/timers/rtc.c @@ -784,7 +784,7 @@ static int rtc_unlink(FAR struct inode *inode) * provided to this function. The resulting RTC driver will be registered * at /dev/rtcN where N is the minor number provided to this function. * - * Input parameters: + * Input Parameters: * minor - The minor number of the RTC device. The N in /dev/rtcN * lower - The lower half driver instance. * diff --git a/drivers/timers/timer.c b/drivers/timers/timer.c index d760a2c4c6..6bb4edeb19 100644 --- a/drivers/timers/timer.c +++ b/drivers/timers/timer.c @@ -431,7 +431,7 @@ static int timer_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * When this function is called, the "lower half" driver should be in the * disabled state (as if the stop() method had already been called). * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all timer * drivers as "/dev/tc0", "/dev/tc1", etc. where the driver @@ -508,7 +508,7 @@ errout: * This function can be called to disable and unregister the timer * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * * Returned Value: @@ -552,7 +552,7 @@ void timer_unregister(FAR void *handle) * to handle timer expirations. This is a strictly OS internal interface * and may NOT be used by appliction code. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * callback - The new timer interrupt callback * arg - Argument to be provided with the callback diff --git a/drivers/timers/watchdog.c b/drivers/timers/watchdog.c index 06208e49dd..a1a29fbaf4 100644 --- a/drivers/timers/watchdog.c +++ b/drivers/timers/watchdog.c @@ -439,7 +439,7 @@ static int wdog_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * When this function is called, the "lower half" driver should be in the * disabled state (as if the stop() method had already been called). * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all watchdog * drivers as "/dev/watchdog0", "/dev/watchdog1", etc. where the driver @@ -518,7 +518,7 @@ errout: * This function can be called to disable and unregister the watchdog * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by watchdog_register() * * Returned Value: diff --git a/drivers/usbdev/cdcacm.c b/drivers/usbdev/cdcacm.c index 7593156a91..4cd4256f16 100644 --- a/drivers/usbdev/cdcacm.c +++ b/drivers/usbdev/cdcacm.c @@ -2638,7 +2638,7 @@ static void cdcuart_rxint(FAR struct uart_dev_s *dev, bool enable) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is @@ -2869,7 +2869,7 @@ static bool cdcuart_txempty(FAR struct uart_dev_s *dev) * Register USB serial port (and USB serial console if so configured) and * return the class object. * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * classdev - The location to return the CDC serial class' device @@ -3004,7 +3004,7 @@ errout_with_class: * Description: * Register USB serial port (and USB serial console if so configured). * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * handle - An optional opaque reference to the CDC/ACM class object that diff --git a/drivers/usbdev/composite.c b/drivers/usbdev/composite.c index 17204d7f81..6800cd95db 100644 --- a/drivers/usbdev/composite.c +++ b/drivers/usbdev/composite.c @@ -786,7 +786,7 @@ static void composite_resume(FAR struct usbdevclass_driver_s *driver, * board-specific implementations in order to obtain the class objects for * each of the members of the composite. * - * Input Parameter: + * Input Parameters: * None * * Returned Value: diff --git a/drivers/usbdev/rndis.c b/drivers/usbdev/rndis.c index 3e1baf2e08..bc70bc1036 100644 --- a/drivers/usbdev/rndis.c +++ b/drivers/usbdev/rndis.c @@ -775,7 +775,7 @@ static void rndis_giverxreq(FAR struct rndis_dev_s *priv) * priv: pointer to RNDIS device driver structure * req: the request whose buffer we should fill * - * Returned value: + * Returned Value: * The total length of the request data * * Assumptions: diff --git a/drivers/usbdev/usbmsc.c b/drivers/usbdev/usbmsc.c index 7fdfcbfc88..14b735301f 100644 --- a/drivers/usbdev/usbmsc.c +++ b/drivers/usbdev/usbmsc.c @@ -1231,7 +1231,7 @@ void usbmsc_rdcomplete(FAR struct usbdev_ep_s *ep, * In all cases, the success reponse is a zero-length packet; the failure * response is an EP0 stall. * - * Input parameters: + * Input Parameters: * priv - Private state structure for this USB storage instance * stall - true is the action failed and a stall is required * diff --git a/drivers/usbdev/usbmsc.h b/drivers/usbdev/usbmsc.h index 79d26778e8..d0d93d3489 100644 --- a/drivers/usbdev/usbmsc.h +++ b/drivers/usbdev/usbmsc.h @@ -679,7 +679,7 @@ void usbmsc_rdcomplete(FAR struct usbdev_ep_s *ep, * In all cases, the success reponse is a zero-length packet; the failure * response is an EP0 stall. * - * Input parameters: + * Input Parameters: * priv - Private state structure for this USB storage instance * stall - true is the action failed and a stall is required * diff --git a/drivers/usbdev/usbmsc_scsi.c b/drivers/usbdev/usbmsc_scsi.c index 8b20a008c4..369d926be1 100644 --- a/drivers/usbdev/usbmsc_scsi.c +++ b/drivers/usbdev/usbmsc_scsi.c @@ -1636,7 +1636,7 @@ static int inline usbmsc_setupcmd(FAR struct usbmsc_dev_s *priv, * Called from the worker thread in the USBMSC_STATE_IDLE state. Checks * for the receipt of a bulk CBW. * - * Returned value: + * Returned Value: * If no new, valid CBW is available, this function returns a negated errno. * Otherwise, when a new CBW is successfully parsed, this function sets * priv->thstate to USBMSC_STATE_CMDPARSE and returns OK. @@ -1781,7 +1781,7 @@ static int usbmsc_idlestate(FAR struct usbmsc_dev_s *priv) * This state is entered when usbmsc_idlestate obtains a valid CBW * containing SCSI commands. This function processes those SCSI commands. * - * Returned value: + * Returned Value: * If no write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDPARSE * state. Otherwise, when the new CBW is successfully process, this @@ -2097,7 +2097,7 @@ static int usbmsc_cmdparsestate(FAR struct usbmsc_dev_s *priv) * of the USBMSC_STATE_CMDPARSE state that handles extended SCSI read * command handling. * - * Returned value: + * Returned Value: * If no USBDEV write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDREAD * state. Otherwise, when the new SCSI read command is fully processed, @@ -2244,7 +2244,7 @@ static int usbmsc_cmdreadstate(FAR struct usbmsc_dev_s *priv) * of the USBMSC_STATE_CMDPARSE state that handles extended SCSI write * command handling. * - * Returned value: + * Returned Value: * If no USBDEV write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDWRITE * state. Otherwise, when the new SCSI write command is fully processed, @@ -2384,7 +2384,7 @@ errout: * The USBMSC_STATE_CMDFINISH state is entered when processing of a * command has finished but before status has been returned. * - * Returned value: + * Returned Value: * If no USBDEV write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDFINISH * state. Otherwise, when the command is fully processed, this function @@ -2527,7 +2527,7 @@ static int usbmsc_cmdfinishstate(FAR struct usbmsc_dev_s *priv) * That state is after a CBW has been fully processed. This function sends * the concluding CSW. * - * Returned value: + * Returned Value: * If no write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDSTATUS * state. Otherwise, when the SCSI statis is successfully returned, this diff --git a/drivers/usbhost/hid_parser.c b/drivers/usbhost/hid_parser.c index 59198faa93..88a167beac 100644 --- a/drivers/usbhost/hid_parser.c +++ b/drivers/usbhost/hid_parser.c @@ -398,7 +398,7 @@ int hid_parsereport(FAR const uint8_t *report, int rptlen, * report. If the given item does not exist in the report, the function * does not modify the report item's data. * - * Input Parameters + * Input Parameters: * report Buffer containing an IN or FEATURE report from an attached * device. * item Pointer to the report item of interest in a struct hid_rptinfo_s @@ -500,7 +500,7 @@ void hid_putitem(FAR uint8_t *report, struct hid_rptitem_s *item) * Description: * Retrieves the size of a given HID report in bytes from it's Report ID. * - * InputParameters: + * Input Parameters: * rptinfo Pointer to a struct hid_rptinfo_s instance containing the parser output. * id Report ID of the report whose size is to be retrieved. * rpttype Type of the report whose size is to be determined, a valued from the diff --git a/drivers/usbhost/usbhost_cdcacm.c b/drivers/usbhost/usbhost_cdcacm.c index 250e561e23..7353af369e 100644 --- a/drivers/usbhost/usbhost_cdcacm.c +++ b/drivers/usbhost/usbhost_cdcacm.c @@ -2623,7 +2623,7 @@ static bool usbhost_rxavailable(FAR struct uart_dev_s *uartdev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * uartdev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/drivers/usbhost/usbhost_enumerate.c b/drivers/usbhost/usbhost_enumerate.c index a6cbddc9ed..cb45a191da 100644 --- a/drivers/usbhost/usbhost_enumerate.c +++ b/drivers/usbhost/usbhost_enumerate.c @@ -280,7 +280,7 @@ static inline int usbhost_classbind(FAR struct usbhost_hubport_s *hport, * and bound to the hub port, the allocated class instance is returned * into this caller-provided memory location. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * diff --git a/drivers/usbhost/usbhost_findclass.c b/drivers/usbhost/usbhost_findclass.c index 7ae1cad4dc..f92534fd1f 100644 --- a/drivers/usbhost/usbhost_findclass.c +++ b/drivers/usbhost/usbhost_findclass.c @@ -64,7 +64,7 @@ * classid - ID info for the class under consideration. * devid - ID info reported by the device. * - * Returned Values: + * Returned Value: * TRUE - the class will support this device. * ****************************************************************************/ @@ -127,7 +127,7 @@ static bool usbhost_idmatch(const struct usbhost_id_s *classid, * Input Parameters: * id - Identifies the USB device class that has connect to the USB host. * - * Returned Values: + * Returned Value: * On success this function will return a non-NULL instance of struct * usbhost_registry_s. NULL will be returned on failure. This function * can only fail if (1) id is NULL, or (2) no USB host class is registered diff --git a/drivers/usbhost/usbhost_hidkbd.c b/drivers/usbhost/usbhost_hidkbd.c index e3a9f19207..3a0e07afaf 100644 --- a/drivers/usbhost/usbhost_hidkbd.c +++ b/drivers/usbhost/usbhost_hidkbd.c @@ -653,7 +653,7 @@ static void usbhost_pollnotify(FAR struct usbhost_state_s *priv) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -680,7 +680,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -753,7 +753,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, char *dev * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -824,7 +824,7 @@ static void usbhost_destroy(FAR void *arg) * priv - Driver internal state * keycode - The value to add to the user buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -880,7 +880,7 @@ static void usbhost_putbuffer(FAR struct usbhost_state_s *priv, * stream - The struct lib_outstream_s reference * ch - The character to add to the user buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -908,7 +908,7 @@ static void usbhost_putstream(FAR struct lib_outstream_s *stream, int ch) * scancode - Scan code to be mapped. * modifier - Ctrl,Alt,Shift,GUI modifier bits * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -950,7 +950,7 @@ static inline uint8_t usbhost_mapscancode(uint8_t scancode, uint8_t modifier) * scancode - Scan code to be mapped. * modifier - Ctrl, Alt, Shift, GUI modifier bits * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -999,7 +999,7 @@ static inline void usbhost_encodescancode(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1326,7 +1326,7 @@ static int usbhost_kbdpoll(int argc, char *argv[]) * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1578,7 +1578,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1669,7 +1669,7 @@ errout: * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1689,7 +1689,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1710,7 +1710,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1732,7 +1732,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1756,7 +1756,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1782,7 +1782,7 @@ static inline int usbhost_tdalloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1827,7 +1827,7 @@ static inline int usbhost_tdfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1912,7 +1912,7 @@ static FAR struct usbhost_class_s * * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1981,7 +1981,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -2424,7 +2424,7 @@ errout: * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_hidmouse.c b/drivers/usbhost/usbhost_hidmouse.c index 944b939f89..4648c3bdb3 100644 --- a/drivers/usbhost/usbhost_hidmouse.c +++ b/drivers/usbhost/usbhost_hidmouse.c @@ -513,7 +513,7 @@ static void usbhost_pollnotify(FAR struct usbhost_state_s *priv) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -540,7 +540,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -614,7 +614,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -676,7 +676,7 @@ static void usbhost_destroy(FAR void *arg) * Description: * Wake any threads waiting for mouse data * - * Input Paramters: + * Input Parameters: * priv - A reference to the mouse state structure. * * Returned Value: @@ -1038,7 +1038,7 @@ static bool usbhost_threshold(FAR struct usbhost_state_s *priv) * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1448,7 +1448,7 @@ errout: * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1648,7 +1648,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1739,7 +1739,7 @@ errout: * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1759,7 +1759,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1780,7 +1780,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1802,7 +1802,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1826,7 +1826,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1852,7 +1852,7 @@ static inline int usbhost_tdalloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1896,7 +1896,7 @@ static inline int usbhost_tdfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1982,7 +1982,7 @@ static FAR struct usbhost_class_s * * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -2050,7 +2050,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -2553,7 +2553,7 @@ errout: * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_hub.c b/drivers/usbhost/usbhost_hub.c index 58d7c64a2d..b3fecd6617 100644 --- a/drivers/usbhost/usbhost_hub.c +++ b/drivers/usbhost/usbhost_hub.c @@ -222,7 +222,7 @@ static struct usbhost_registry_s g_hub = * Input Parameters: * hport - A reference to the hub port instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -264,7 +264,7 @@ static void usbhost_hport_deactivate(FAR struct usbhost_hubport_s *hport) * Input Parameters: * hport - The hub port to be activated. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned * on any failure. * @@ -308,7 +308,7 @@ static int usbhost_hport_activate(FAR struct usbhost_hubport_s *hport) * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -496,7 +496,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_class_s *hubclass, * Input Parameters: * hubclass - The USB host class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -598,7 +598,7 @@ static inline int usbhost_hubdesc(FAR struct usbhost_class_s *hubclass) * hport - The port on the parent hub where the this hub is connected. * on - True: enable power; false: Disable power * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -661,7 +661,7 @@ static int usbhost_hubpwr(FAR struct usbhost_hubpriv_s *priv, * Input Parameters: * xfer - The USB host class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -1010,7 +1010,7 @@ static void usbhost_hub_event(FAR void *arg) * class - The USB host class entry previously obtained from a call to * create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -1112,7 +1112,7 @@ static void usbhost_disconnect_event(FAR void *arg) * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1132,7 +1132,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1154,7 +1154,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * nbytes - The number of bytes actually transferred (or a negated errno * value; * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -1244,7 +1244,7 @@ static void usbhost_callback(FAR void *arg, ssize_t nbytes) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1351,7 +1351,7 @@ errout_with_hub: * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1439,7 +1439,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *hubclass, * class - The USB host class entry previously obtained from a call to * create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -1497,7 +1497,7 @@ static int usbhost_disconnected(struct usbhost_class_s *hubclass) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_registerclass.c b/drivers/usbhost/usbhost_registerclass.c index a795b88d02..8cd52dd02d 100644 --- a/drivers/usbhost/usbhost_registerclass.c +++ b/drivers/usbhost/usbhost_registerclass.c @@ -86,7 +86,7 @@ * usbclass - An write-able instance of struct usbhost_registry_s that * will be maintained in a registry. * - * Returned Values: + * Returned Value: * On success, this function will return zero (OK). Otherwise, a negated * errno value is returned. * diff --git a/drivers/usbhost/usbhost_skeleton.c b/drivers/usbhost/usbhost_skeleton.c index 651f99fb52..c79d2498ae 100644 --- a/drivers/usbhost/usbhost_skeleton.c +++ b/drivers/usbhost/usbhost_skeleton.c @@ -242,7 +242,7 @@ static void usbhost_takesem(sem_t *sem) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -269,7 +269,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -345,7 +345,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -409,7 +409,7 @@ static void usbhost_destroy(FAR void *arg) * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -623,7 +623,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -700,7 +700,7 @@ static inline int usbhost_devinit(FAR struct usbhost_state_s *priv) * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -720,7 +720,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -741,7 +741,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -763,7 +763,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -785,7 +785,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -811,7 +811,7 @@ static inline int usbhost_talloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -855,7 +855,7 @@ static inline int usbhost_tfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -930,7 +930,7 @@ static FAR struct usbhost_class_s *usbhost_create(FAR struct usbhost_hubport_s * * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -989,7 +989,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -1061,7 +1061,7 @@ static int usbhost_disconnected(struct usbhost_class_s *usbclass) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_storage.c b/drivers/usbhost/usbhost_storage.c index f78a58ce54..89ff54cac7 100644 --- a/drivers/usbhost/usbhost_storage.c +++ b/drivers/usbhost/usbhost_storage.c @@ -357,7 +357,7 @@ static void usbhost_takesem(sem_t *sem) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -411,7 +411,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -502,7 +502,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, char *dev * Input Parameters: * cbw/csw - A reference to the CBW/CSW to dump. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -548,7 +548,7 @@ static void usbhost_dumpcsw(FAR struct usbmsc_csw_s *csw) * Input Parameters: * cbw - A reference to allocated and initialized CBW to be built. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -674,7 +674,7 @@ usbhost_writecbw(size_t startsector, uint16_t blocksize, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -912,7 +912,7 @@ static inline int usbhost_inquiry(FAR struct usbhost_state_s *priv) * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -986,7 +986,7 @@ static void usbhost_destroy(FAR void *arg) * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1209,7 +1209,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1400,7 +1400,7 @@ static inline int usbhost_initvolume(FAR struct usbhost_state_s *priv) * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1419,7 +1419,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * Input Parameters: * val - A pointer to the first byte of the big endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1439,7 +1439,7 @@ static inline uint16_t usbhost_getbe16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1460,7 +1460,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1481,7 +1481,7 @@ static void usbhost_putbe16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1503,7 +1503,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1525,7 +1525,7 @@ static inline uint32_t usbhost_getbe32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1548,7 +1548,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1570,7 +1570,7 @@ static void usbhost_putbe32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1596,7 +1596,7 @@ static inline int usbhost_talloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1630,7 +1630,7 @@ static inline int usbhost_tfree(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1669,7 +1669,7 @@ static FAR struct usbmsc_cbw_s *usbhost_cbwalloc(FAR struct usbhost_state_s *pri * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1748,7 +1748,7 @@ usbhost_create(FAR struct usbhost_hubport_s *hport, * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1807,7 +1807,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -2286,7 +2286,7 @@ static int usbhost_ioctl(FAR struct inode *inode, int cmd, unsigned long arg) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_xboxcontroller.c b/drivers/usbhost/usbhost_xboxcontroller.c index 3ba40c204f..91b0b5093c 100644 --- a/drivers/usbhost/usbhost_xboxcontroller.c +++ b/drivers/usbhost/usbhost_xboxcontroller.c @@ -365,7 +365,7 @@ static void usbhost_takesem(sem_t *sem) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -392,7 +392,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -468,7 +468,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -534,7 +534,7 @@ static void usbhost_destroy(FAR void *arg) * Description: * Wake any threads waiting for controller data * - * Input Paramters: + * Input Parameters: * priv - A reference to the controller state structure. * * Returned Value: @@ -586,7 +586,7 @@ static void usbhost_notify(FAR struct usbhost_state_s *priv) * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1060,7 +1060,7 @@ errout: * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1291,7 +1291,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1384,7 +1384,7 @@ errout: * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1404,7 +1404,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1425,7 +1425,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1447,7 +1447,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1471,7 +1471,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1497,7 +1497,7 @@ static inline int usbhost_talloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1541,7 +1541,7 @@ static inline int usbhost_tfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1624,7 +1624,7 @@ static FAR struct usbhost_class_s *usbhost_create(FAR struct usbhost_hubport_s * * descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -1683,7 +1683,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value * is returned indicating the nature of the failure * @@ -2208,7 +2208,7 @@ errout: * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbmonitor/usbmonitor.c b/drivers/usbmonitor/usbmonitor.c index e3ccb1e821..548c39b749 100644 --- a/drivers/usbmonitor/usbmonitor.c +++ b/drivers/usbmonitor/usbmonitor.c @@ -197,7 +197,7 @@ static int usbmonitor_daemon(int argc, char **argv) * Input Parameters: * None * - * Returned values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -259,7 +259,7 @@ int usbmonitor_start(void) * Input Parameters: * None * - * Returned values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * diff --git a/drivers/wireless/cc1101.c b/drivers/wireless/cc1101.c index 9c008f798d..e31a6e2a1d 100644 --- a/drivers/wireless/cc1101.c +++ b/drivers/wireless/cc1101.c @@ -326,7 +326,7 @@ void cc1101_access_end(FAR struct cc1101_dev_s *dev) /* CC1101 Access with Range Check * - * Input Paramters: + * Input Parameters: * dev CC1101 Private Structure * addr CC1101 Address * buf Pointer to buffer, either for read or write access diff --git a/drivers/wireless/cc3000/wlan.c b/drivers/wireless/cc3000/wlan.c index c77488bcf4..2e23343935 100644 --- a/drivers/wireless/cc3000/wlan.c +++ b/drivers/wireless/cc3000/wlan.c @@ -1216,7 +1216,7 @@ long wlan_smart_config_set_prefix(FAR char *cNewPrefix) * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ @@ -1242,7 +1242,7 @@ signed long aes_read_key(uint8_t *key) * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ diff --git a/drivers/wireless/ieee802154/xbee/xbee.c b/drivers/wireless/ieee802154/xbee/xbee.c index c0a7fd0ca0..3cd82479df 100644 --- a/drivers/wireless/ieee802154/xbee/xbee.c +++ b/drivers/wireless/ieee802154/xbee/xbee.c @@ -386,7 +386,7 @@ static void xbee_attnworker(FAR void *arg) * datalen - The size of the data section of the frame. This is the value * included as the second and third byte of the frame. * - * Returns: + * Returned Value: * true - Frame type is known and length is logical * false - Frame type is unknown or length is invalid for frame type * @@ -453,7 +453,7 @@ static bool xbee_validate_apiframe(uint8_t frametype, uint16_t datalen) * frame - pointer to the frame data * framelen - size of the overall frame. NOT the data length field * - * Returns: + * Returned Value: * true - Checksum is valid * false - Checksum is invalid * diff --git a/drivers/wireless/ieee802154/xbee/xbee_netdev.c b/drivers/wireless/ieee802154/xbee/xbee_netdev.c index 1c0c682057..ea7db25986 100644 --- a/drivers/wireless/ieee802154/xbee/xbee_netdev.c +++ b/drivers/wireless/ieee802154/xbee/xbee_netdev.c @@ -665,7 +665,7 @@ static void xbeenet_txpoll_expiry(int argc, wdparm_t arg, ...) * Description: * Get the extended address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * eaddr - The location in which to return the extended address. * @@ -702,7 +702,7 @@ static int xbeenet_coord_eaddr(FAR struct radio_driver_s *radio, * Description: * Get the short address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * saddr - The location in which to return the short address. * @@ -1168,7 +1168,7 @@ static int xbeenet_ioctl(FAR struct net_driver_s *dev, int cmd, * Description * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1200,7 +1200,7 @@ static int xbeenet_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the XBee MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1272,7 +1272,7 @@ static int xbeenet_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * @@ -1349,7 +1349,7 @@ static int xbeenet_properties(FAR struct radio_driver_s *netdev, * Input Parameters: * mac - Pointer to the mac layer struct to be registered. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/wireless/spirit/drivers/spirit_netdev.c b/drivers/wireless/spirit/drivers/spirit_netdev.c index e951f3fe0a..4a9ef1e54e 100644 --- a/drivers/wireless/spirit/drivers/spirit_netdev.c +++ b/drivers/wireless/spirit/drivers/spirit_netdev.c @@ -2262,7 +2262,7 @@ static int spirit_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -2294,7 +2294,7 @@ static int spirit_get_mhrlen(FAR struct radio_driver_s *netdev, * indirectly as a consequence of a TX poll that generates a series of * 6LoWPAN radio packets. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -2407,7 +2407,7 @@ static int spirit_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/drivers/wireless/spirit/include/spirit_general.h b/drivers/wireless/spirit/include/spirit_general.h index 204b3dfcee..aa0b7f4c6d 100644 --- a/drivers/wireless/spirit/include/spirit_general.h +++ b/drivers/wireless/spirit/include/spirit_general.h @@ -128,7 +128,7 @@ enum spirit_version_e * * Description: * - * Input parameters: + * Input Parameters: * * Returned Value: * diff --git a/drivers/wireless/spirit/include/spirit_spi.h b/drivers/wireless/spirit/include/spirit_spi.h index 7cc891d603..6fbdff33d8 100644 --- a/drivers/wireless/spirit/include/spirit_spi.h +++ b/drivers/wireless/spirit/include/spirit_spi.h @@ -86,7 +86,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Read single or multiple SPIRIT1 register * - * Input parameters: + * Input Parameters: * regaddr: Base register's address to be read * buffer: Pointer to the buffer of registers' values to be read * buflen: Number of register values to be read @@ -106,7 +106,7 @@ int spirit_reg_read(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Read single or multiple SPIRIT1 register. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * buffer - Pointer to the buffer of register values to write @@ -129,7 +129,7 @@ int spirit_reg_write(FAR struct spirit_library_s *spirit, uint8_t regaddr, * atomic only in the sense that other accesses to the SPI bus are * prohibited throughout the operation. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * clrbits - Bits to clear in the register @@ -150,7 +150,7 @@ int spirit_reg_modify(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Send a command * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * cmd - Command code to be sent * @@ -168,7 +168,7 @@ int spirit_command(FAR struct spirit_library_s *spirit, uint8_t cmd); * Description: * Read data from RX FIFO * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of bytes to be written @@ -188,7 +188,7 @@ int spirit_fifo_read(FAR struct spirit_library_s *spirit, FAR uint8_t *buffer, * Description: * Write data into TX FIFO. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of data values to be written. diff --git a/drivers/wireless/spirit/lib/spirit_spi.c b/drivers/wireless/spirit/lib/spirit_spi.c index 752dc78650..3433dfcafe 100644 --- a/drivers/wireless/spirit/lib/spirit_spi.c +++ b/drivers/wireless/spirit/lib/spirit_spi.c @@ -254,7 +254,7 @@ static void spirit_unlock(FAR struct spi_dev_s *spi) * Description: * Read single or multiple SPIRIT1 register * - * Input parameters: + * Input Parameters: * * regaddr: Base register's address to be read * buffer: Pointer to the buffer of registers' values to be read @@ -309,7 +309,7 @@ int spirit_reg_read(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Read single or multiple SPIRIT1 register. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * buffer - Pointer to the buffer of register values to write @@ -363,7 +363,7 @@ int spirit_reg_write(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Perform atomic read/modify/write on a single SPIRIT1 register. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * clrbits - Bits to clear in the register @@ -442,7 +442,7 @@ int spirit_reg_modify(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Send a command * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * cmd - Command code to be sent * @@ -489,7 +489,7 @@ int spirit_command(FAR struct spirit_library_s *spirit, uint8_t cmd) * Description: * Read data from RX FIFO * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of bytes to be written @@ -543,7 +543,7 @@ int spirit_fifo_read(FAR struct spirit_library_s *spirit, FAR uint8_t *buffer, * Description: * Write data into TX FIFO. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of data values to be written. diff --git a/fs/dirent/fs_closedir.c b/fs/dirent/fs_closedir.c index 6b74bbdf19..5ab991c309 100644 --- a/fs/dirent/fs_closedir.c +++ b/fs/dirent/fs_closedir.c @@ -64,10 +64,10 @@ * 'dirp'. The directory stream descriptor 'dirp' is not available after * this call. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous call to opendir(); * - * Return: + * Returned Value: * The closedir() function returns 0 on success. On error, -1 is * returned, and errno is set appropriately. * diff --git a/fs/dirent/fs_opendir.c b/fs/dirent/fs_opendir.c index 43b62b9c87..e8bedefff7 100644 --- a/fs/dirent/fs_opendir.c +++ b/fs/dirent/fs_opendir.c @@ -61,12 +61,12 @@ * Description: * Handle the case where the inode to be opened is within a mountpoint. * - * Inputs: + * Input Parameters: * inode -- the inode of the mountpoint to open * relpath -- the relative path within the mountpoint to open * dir -- the dirent structure to be initialized * - * Return: + * Returned Value: * On success, OK is returned; Otherwise, a positive errno is returned. * ****************************************************************************/ @@ -127,11 +127,11 @@ static inline int open_mountpoint(FAR struct inode *inode, * Handle the case where the inode to be opened is within the top-level * pseudo-file system. * - * Inputs: + * Input Parameters: * inode -- the inode of the mountpoint to open * dir -- the dirent structure to be initialized * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -164,10 +164,10 @@ static void open_pseudodir(FAR struct inode *inode, FAR struct fs_dirent_s *dir) * and, therefore, it must be a directory node. But is has no children * to be enumerated either. * - * Inputs: + * Input Parameters: * dir -- the dirent structure to be initialized * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -204,10 +204,10 @@ static inline void open_emptydir(FAR struct fs_dirent_s *dir) * directory name, and returns a pointer to the directory stream. The * stream is positioned at the first entry in the directory. * - * Inputs: + * Input Parameters: * path -- the directory to open * - * Return: + * Returned Value: * The opendir() function returns a pointer to the directory stream. On * error, NULL is returned, and errno is set appropriately. * diff --git a/fs/dirent/fs_readdir.c b/fs/dirent/fs_readdir.c index 93b2f654fd..f7cc4a69e6 100644 --- a/fs/dirent/fs_readdir.c +++ b/fs/dirent/fs_readdir.c @@ -153,10 +153,10 @@ static inline int readpseudodir(struct fs_dirent_s *idir) * to by dir. It returns NULL on reaching the end-of-file or if an error * occurred. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous call to opendir(); * - * Return: + * Returned Value: * The readdir() function returns a pointer to a dirent structure, or NULL * if an error occurs or end-of-file is reached. On error, errno is set * appropriately. diff --git a/fs/dirent/fs_rewinddir.c b/fs/dirent/fs_rewinddir.c index 7ad252d8aa..6450a5859f 100644 --- a/fs/dirent/fs_rewinddir.c +++ b/fs/dirent/fs_rewinddir.c @@ -93,11 +93,11 @@ static inline void rewindpseudodir(struct fs_dirent_s *idir) * The rewinddir() function resets the position of the * directory stream dir to the beginning of the directory. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/dirent/fs_seekdir.c b/fs/dirent/fs_seekdir.c index 761dba33cd..896658b690 100644 --- a/fs/dirent/fs_seekdir.c +++ b/fs/dirent/fs_seekdir.c @@ -188,12 +188,12 @@ static inline void seekmountptdir(struct fs_dirent_s *idir, off_t offset) * which the next readdir() call will start. seekdir() should be used with * an offset returned by telldir(). * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * offset -- offset to seek to * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/driver/driver.h b/fs/driver/driver.h index bbe605602e..dd15fb33bb 100644 --- a/fs/driver/driver.h +++ b/fs/driver/driver.h @@ -69,13 +69,13 @@ extern "C" * Description: * Return the inode of the block driver specified by 'pathname' * - * Inputs: + * Input Parameters: * pathname - the full path to the block driver to be located * mountflags - if MS_RDONLY is not set, then driver must support write * operations (see include/sys/mount.h) * ppinode - address of the location to return the inode reference * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - pathname or pinode is NULL @@ -98,7 +98,7 @@ int find_blockdriver(FAR const char *pathname, int mountflags, * Create a temporary char driver using drivers/bch to mediate character * oriented accessed to the block driver. * - * Input parameters: + * Input Parameters: * blkdev - The path to the block driver * oflags - Character driver open flags * diff --git a/fs/driver/fs_blockproxy.c b/fs/driver/fs_blockproxy.c index 1f15370bcd..74d9b75c89 100644 --- a/fs/driver/fs_blockproxy.c +++ b/fs/driver/fs_blockproxy.c @@ -77,7 +77,7 @@ static sem_t g_devno_sem = SEM_INITIALIZER(1); * psuedo-file system. We cannot use mktemp for this because it will * attempt to open() the file. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -146,7 +146,7 @@ static FAR char *unique_chardev(void) * Create a temporary char driver using drivers/bch to mediate character * oriented accessed to the block driver. * - * Input parameters: + * Input Parameters: * blkdev - The path to the block driver * oflags - Character driver open flags * diff --git a/fs/driver/fs_closeblockdriver.c b/fs/driver/fs_closeblockdriver.c index 7c9c60244d..9ce13df6fd 100644 --- a/fs/driver/fs_closeblockdriver.c +++ b/fs/driver/fs_closeblockdriver.c @@ -55,10 +55,10 @@ * Description: * Call the close method and release the inode * - * Inputs: + * Input Parameters: * inode - reference to the inode of a block driver opened by open_blockdriver * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - inode is NULL diff --git a/fs/driver/fs_findblockdriver.c b/fs/driver/fs_findblockdriver.c index 0615a474b2..f85bff032f 100644 --- a/fs/driver/fs_findblockdriver.c +++ b/fs/driver/fs_findblockdriver.c @@ -61,13 +61,13 @@ * Description: * Return the inode of the block driver specified by 'pathname' * - * Inputs: + * Input Parameters: * pathname - the full path to the block driver to be located * mountflags - if MS_RDONLY is not set, then driver must support write * operations (see include/sys/mount.h) * ppinode - address of the location to return the inode reference * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - pathname or pinode is NULL diff --git a/fs/driver/fs_openblockdriver.c b/fs/driver/fs_openblockdriver.c index 9a42020bf7..e88d05d752 100644 --- a/fs/driver/fs_openblockdriver.c +++ b/fs/driver/fs_openblockdriver.c @@ -56,13 +56,13 @@ * Description: * Return the inode of the block driver specified by 'pathname' * - * Inputs: + * Input Parameters: * pathname - the full path to the block driver to be opened * mountflags - if MS_RDONLY is not set, then driver must support write * operations (see include/sys/mount.h) * ppinode - address of the location to return the inode reference * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - pathname or pinode is NULL diff --git a/fs/driver/fs_registerblockdriver.c b/fs/driver/fs_registerblockdriver.c index 6909619071..f1da64c9f1 100644 --- a/fs/driver/fs_registerblockdriver.c +++ b/fs/driver/fs_registerblockdriver.c @@ -58,7 +58,7 @@ * Description: * Register a block driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * bops - The block driver operations structure * mode - inmode priviledges (not used) diff --git a/fs/driver/fs_registerdriver.c b/fs/driver/fs_registerdriver.c index 501bf93f66..85f32e48a9 100644 --- a/fs/driver/fs_registerdriver.c +++ b/fs/driver/fs_registerdriver.c @@ -56,7 +56,7 @@ * Description: * Register a character driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * fops - The file operations structure * mode - inmode priviledges (not used) diff --git a/fs/fat/fs_fat32dirent.c b/fs/fat/fs_fat32dirent.c index 7ea497b62a..bc2f79801f 100644 --- a/fs/fat/fs_fat32dirent.c +++ b/fs/fat/fs_fat32dirent.c @@ -213,7 +213,7 @@ static uint8_t fat_lfnchecksum(const uint8_t *sfname) * code pages". The logic below does not, at present, support any other * character sets. * - * Returned value: + * Returned Value: * OK - The path refers to a valid 8.3 FAT file name and has been properly * converted and stored in dirinfo. * <0 - Otherwise an negated error is returned meaning that the string is @@ -468,7 +468,7 @@ errout: * 2. '.' (dot) can occur more than once in a filename. Extension is * the substring after the last dot. * - * Returned value: + * Returned Value: * OK - The path refers to a valid long file name and has been properly * stored in dirinfo. * <0 - Otherwise an negated error is returned meaning that the string is @@ -562,7 +562,7 @@ errout: * * This function is called only from fat_putlfname() * - * Returned value: + * Returned Value: * OK - The alias was created correctly. * <0 - Otherwise an negated error is returned. * @@ -767,7 +767,7 @@ static inline int fat_createalias(struct fat_dirinfo_s *dirinfo) * NOTE: This function does not restore the directory entry that was in the * sector cache * - * Returned value: + * Returned Value: * OK - The alias is unique. * <0 - Otherwise an negated error is returned. * @@ -807,7 +807,7 @@ static inline int fat_findalias(struct fat_mountpt_s *fs, * sector cache * * information upon return. - * Returned value: + * Returned Value: * OK - The alias is unique. * <0 - Otherwise an negated error is returned. * diff --git a/fs/fat/fs_fat32util.c b/fs/fat/fs_fat32util.c index cdbfc2d4cb..47a12574fa 100644 --- a/fs/fat/fs_fat32util.c +++ b/fs/fat/fs_fat32util.c @@ -813,7 +813,8 @@ off_t fat_cluster2sector(FAR struct fat_mountpt_s *fs, uint32_t cluster) * Description: * Get the next cluster start from the FAT. * - * Return: <0: error, 0:cluster unassigned, >=0: start sector of cluster + * Returned Value: + * <0: error, 0:cluster unassigned, >=0: start sector of cluster * ****************************************************************************/ @@ -1161,7 +1162,7 @@ int fat_removechain(struct fat_mountpt_s *fs, uint32_t cluster) * Add a new cluster to the chain following cluster (if cluster is non- * NULL). if cluster is zero, then a new chain is created. * - * Return: + * Returned Value: * <0:error, 0: no free cluster, >=2: new cluster number * ****************************************************************************/ diff --git a/fs/inode/fs_inodereserve.c b/fs/inode/fs_inodereserve.c index 1c08b05567..f1b0bc685f 100644 --- a/fs/inode/fs_inodereserve.c +++ b/fs/inode/fs_inodereserve.c @@ -144,7 +144,7 @@ static void inode_insert(FAR struct inode *node, * Reserve an (initialized) inode the pseudo file system. The initial * reference count on the new inode is zero. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * inode - The location to return the inode pointer * diff --git a/fs/inode/inode.h b/fs/inode/inode.h index 71b1af8e92..ae1ef0ce48 100644 --- a/fs/inode/inode.h +++ b/fs/inode/inode.h @@ -293,7 +293,7 @@ const char *inode_nextname(FAR const char *name); * * NOTE: Caller must hold the inode semaphore * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * inode - The location to return the inode pointer * diff --git a/fs/mount/fs_mount.c b/fs/mount/fs_mount.c index 62a982b40e..404b700fce 100644 --- a/fs/mount/fs_mount.c +++ b/fs/mount/fs_mount.c @@ -214,7 +214,7 @@ mount_findfs(FAR const struct fsmap_t *fstab, FAR const char *filesystemtype) * mount() attaches the filesystem specified by the 'source' block device * name into the root file system at the path specified by 'target.' * - * Return: + * Returned Value: * Zero is returned on success; -1 is returned on an error and errno is * set appropriately: * diff --git a/fs/mount/fs_umount2.c b/fs/mount/fs_umount2.c index e342ae2e16..598cb7b196 100644 --- a/fs/mount/fs_umount2.c +++ b/fs/mount/fs_umount2.c @@ -59,7 +59,7 @@ * umount() detaches the filesystem mounted at the path specified by * 'target.' * - * Return: + * Returned Value: * Zero is returned on success; -1 is returned on an error and errno is * set appropriately: * diff --git a/fs/mqueue/mq_close.c b/fs/mqueue/mq_close.c index 4578c1cc08..adbe025350 100644 --- a/fs/mqueue/mq_close.c +++ b/fs/mqueue/mq_close.c @@ -67,7 +67,7 @@ * mqdes - Message queue descriptor. * group - Group that has the open descriptor. * - * Return Value: + * Returned Value: * Zero (OK) if the message queue is closed successfully. Otherwise, a * negated errno value is returned. * @@ -125,7 +125,7 @@ int nxmq_close_group(mqd_t mqdes, FAR struct task_group_s *group) * Parameters: * mqdes - Message queue descriptor. * - * Return Value: + * Returned Value: * 0 (OK) if the message queue is closed successfully, * otherwise, -1 (ERROR). * @@ -176,7 +176,7 @@ int mq_close(mqd_t mqdes) * Parameters: * inode - The message queue inode * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/mqueue/mq_open.c b/fs/mqueue/mq_open.c index 5c372a50d5..2f9a338fda 100644 --- a/fs/mqueue/mq_open.c +++ b/fs/mqueue/mq_open.c @@ -79,7 +79,7 @@ * created to determine the maximum number of * messages that may be placed in the message queue. * - * Return Value: + * Returned Value: * A message queue descriptor or (mqd_t)-1 (ERROR) * * Assumptions: diff --git a/fs/mqueue/mq_unlink.c b/fs/mqueue/mq_unlink.c index 9705a0ef8b..7610eee43c 100644 --- a/fs/mqueue/mq_unlink.c +++ b/fs/mqueue/mq_unlink.c @@ -66,7 +66,7 @@ * Parameters: * mq_name - Name of the message queue * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/fs/mqueue/mqueue.h b/fs/mqueue/mqueue.h index 4edc08ece1..b8cdb36d20 100644 --- a/fs/mqueue/mqueue.h +++ b/fs/mqueue/mqueue.h @@ -80,7 +80,7 @@ extern "C" * Parameters: * inode - The message queue inode * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/nfs/nfs_util.c b/fs/nfs/nfs_util.c index 8a6967cbbe..7170970892 100644 --- a/fs/nfs/nfs_util.c +++ b/fs/nfs/nfs_util.c @@ -194,7 +194,7 @@ int nfs_checkmount(struct nfsmount *nmp) * Perform the NFS request. On successful receipt, it verifies the NFS level of the * returned values. * - * Return Value: + * Returned Value: * Zero on success; a positive errno value on failure. * ****************************************************************************/ @@ -380,7 +380,7 @@ int nfs_lookup(struct nfsmount *nmp, FAR const char *filename, * Given a path to something that may or may not be in the file system, * return the handle of the directory entry of the requested object. * - * Return Value: + * Returned Value: * Zero on success; a positive errno value on failure. * ****************************************************************************/ @@ -488,7 +488,7 @@ int nfs_findnode(struct nfsmount *nmp, FAR const char *relpath, * return the handle of the entry of the directory containing the requested * object. * - * Return Value: + * Returned Value: * Zero on success; a positive errno value on failure. * ****************************************************************************/ @@ -577,7 +577,7 @@ int nfs_finddir(struct nfsmount *nmp, FAR const char *relpath, * Desciption: * Update file attributes on write or after the file is modified. * - * Return Value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/fs/nxffs/nxffs.h b/fs/nxffs/nxffs.h index bc979a3050..c6ae19bed1 100644 --- a/fs/nxffs/nxffs.h +++ b/fs/nxffs/nxffs.h @@ -386,7 +386,7 @@ int nxffs_limits(FAR struct nxffs_volume_s *volume); * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * * Defined in nxffs_util.c @@ -405,7 +405,7 @@ uint16_t nxffs_rdle16(FAR const uint8_t *val); * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * * Defined in nxffs_util.c @@ -423,7 +423,7 @@ void nxffs_wrle16(uint8_t *dest, uint16_t val); * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint32_t representing the whole 32-bit integer value * * Defined in nxffs_util.c @@ -461,7 +461,7 @@ void nxffs_wrle32(uint8_t *dest, uint32_t val); * buffer - Address of the start of the memory to check. * buflen - The number of bytes to check. * - * Returned Values: + * Returned Value: * The number of erased bytes found at the beginning of the memory region. * * Defined in nxffs_util.c @@ -581,7 +581,7 @@ int nxffs_getc(FAR struct nxffs_volume_s *volume, uint16_t reserve); * caller may call kmm_free upon return of this function if necessary to * free the entry container. * - * Input parameters: + * Input Parameters: * entry - The entry to be freed. * * Returned Value: @@ -679,7 +679,7 @@ off_t nxffs_inodeend(FAR struct nxffs_volume_s *volume, * volume - Describes the NXFFS volume * block - The (logical) block number to load and verify. * - * Returned Values: + * Returned Value: * OK (zero( is returned on success. Otherwise, a negated errno value is * returned indicating the nature of the failure: * @@ -836,7 +836,7 @@ FAR struct nxffs_wrfile_s *nxffs_findwriter(FAR struct nxffs_volume_s *volume); * Note that in either case, the inode name has already been written to * FLASH. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the inode header to write * @@ -858,7 +858,7 @@ int nxffs_wrinode(FAR struct nxffs_volume_s *volume, * The packing logic has moved an inode. Check if any open files are using * this inode and, if so, move the data in the open file structure as well. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * @@ -877,7 +877,7 @@ int nxffs_updateinode(FAR struct nxffs_volume_s *volume, * Description: * Zero-extend a file. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * length - The new, extended length of the file @@ -1074,7 +1074,7 @@ int nxffs_rminode(FAR struct nxffs_volume_s *volume, FAR const char *name); * Input Parameters: * volume - The volume to be packed. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * diff --git a/fs/nxffs/nxffs_block.c b/fs/nxffs/nxffs_block.c index c1cad2afe4..06d5174949 100644 --- a/fs/nxffs/nxffs_block.c +++ b/fs/nxffs/nxffs_block.c @@ -66,7 +66,7 @@ * volume - Describes the NXFFS volume * block - The (logical) block number to load and verify. * - * Returned Values: + * Returned Value: * OK (zero( is returned on success. Otherwise, a negated errno value is * returned indicating the nature of the failure: * diff --git a/fs/nxffs/nxffs_inode.c b/fs/nxffs/nxffs_inode.c index 2240c18313..e3c52421a3 100644 --- a/fs/nxffs/nxffs_inode.c +++ b/fs/nxffs/nxffs_inode.c @@ -213,7 +213,7 @@ errout: * caller may call kmm_free upon return of this function if necessary to * free the entry container. * - * Input parameters: + * Input Parameters: * entry - The entry to be freed. * * Returned Value: diff --git a/fs/nxffs/nxffs_open.c b/fs/nxffs/nxffs_open.c index f5a65e10d2..8276a399a6 100644 --- a/fs/nxffs/nxffs_open.c +++ b/fs/nxffs/nxffs_open.c @@ -855,7 +855,7 @@ static inline void nxffs_freeofile(FAR struct nxffs_volume_s *volume, * file was open for writing, and finally, * 3. Write the new file inode. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * wrfile - Describes the state of the open file * @@ -1200,7 +1200,7 @@ errout: * Note that in either case, the inode name has already been written to * FLASH. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the inode header to write * @@ -1283,7 +1283,7 @@ errout: * The packing logic has moved an inode. Check if any open files are using * this inode and, if so, move the data in the open file structure as well. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * diff --git a/fs/nxffs/nxffs_pack.c b/fs/nxffs/nxffs_pack.c index 134ee430a6..0c6819a465 100644 --- a/fs/nxffs/nxffs_pack.c +++ b/fs/nxffs/nxffs_pack.c @@ -164,7 +164,7 @@ static off_t nxffs_packtell(FAR struct nxffs_volume_s *volume, * Input Parameters: * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -191,7 +191,7 @@ static inline bool nxffs_packvalid(FAR struct nxffs_pack_s *pack) * volume - The volume to be packed. * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * The offset to the data area on the first valid block. Zero is return * if there are no valid blocks or if there are no valid inode headers * after the first valid block. @@ -261,7 +261,7 @@ static inline off_t nxffs_mediacheck(FAR struct nxffs_volume_s *volume, * -- then no packing can be performed. In this case, then the free * flash offset is returned through this location. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. If -ENOSPC is returned then the * free FLASH offset is also returned. @@ -398,7 +398,7 @@ static inline int nxffs_startpos(FAR struct nxffs_volume_s *volume, * offset - FLASH offset to the data block header (will be zero for zero- * files. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -441,7 +441,7 @@ static int nxffs_srcsetup(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -618,7 +618,7 @@ errout: * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure (not used). * @@ -727,7 +727,7 @@ static int nxffs_wrinodehdr(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -782,7 +782,7 @@ static void nxffs_wrdathdr(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * None. * ****************************************************************************/ @@ -830,7 +830,7 @@ static void nxffs_packtransfer(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -872,7 +872,7 @@ static int nxffs_endsrcblock(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -1057,7 +1057,7 @@ static inline int nxffs_packblock(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * If there is an active writer of the volume, its open file instance is * returned. NULL is returned otherwise. * @@ -1125,7 +1125,7 @@ nxffs_setupwriter(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -1257,7 +1257,7 @@ static inline int nxffs_packwriter(FAR struct nxffs_volume_s *volume, * Input Parameters: * volume - The volume to be packed. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * diff --git a/fs/nxffs/nxffs_util.c b/fs/nxffs/nxffs_util.c index ac51140fa3..7893798ade 100644 --- a/fs/nxffs/nxffs_util.c +++ b/fs/nxffs/nxffs_util.c @@ -143,7 +143,7 @@ void nxffs_wrle32(uint8_t *dest, uint32_t val) * buffer - Address of the start of the memory to check. * buflen - The number of bytes to check. * - * Returned Values: + * Returned Value: * The number of erased bytes found at the beginning of the memory region. * ****************************************************************************/ diff --git a/fs/nxffs/nxffs_write.c b/fs/nxffs/nxffs_write.c index 1fd761e440..c788947d83 100644 --- a/fs/nxffs/nxffs_write.c +++ b/fs/nxffs/nxffs_write.c @@ -633,7 +633,7 @@ errout: * Description: * Zero-extend a file. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * length - The new, extended length of the file diff --git a/fs/semaphore/sem_close.c b/fs/semaphore/sem_close.c index ffe687bec8..bd5ab99205 100644 --- a/fs/semaphore/sem_close.c +++ b/fs/semaphore/sem_close.c @@ -71,7 +71,7 @@ * Parameters: * sem - semaphore descriptor * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if unsuccessful. * * Assumptions: diff --git a/fs/semaphore/sem_open.c b/fs/semaphore/sem_open.c index 4bc91daeb0..c09f962798 100644 --- a/fs/semaphore/sem_open.c +++ b/fs/semaphore/sem_open.c @@ -93,7 +93,7 @@ * initial values of the semaphore must be less than or equal to * SEM_VALUE_MAX. * - * Return Value: + * Returned Value: * A pointer to sem_t or SEM_FAILED if unsuccessful. * * Assumptions: diff --git a/fs/semaphore/sem_unlink.c b/fs/semaphore/sem_unlink.c index ca73a80041..647e3cba5c 100644 --- a/fs/semaphore/sem_unlink.c +++ b/fs/semaphore/sem_unlink.c @@ -70,7 +70,7 @@ * Parameters: * name - Semaphore name * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if unsuccessful. * * Assumptions: diff --git a/fs/unionfs/fs_unionfs.c b/fs/unionfs/fs_unionfs.c index 0c61c2e7a0..27bd733e6e 100644 --- a/fs/unionfs/fs_unionfs.c +++ b/fs/unionfs/fs_unionfs.c @@ -2617,7 +2617,7 @@ errout_with_search: * file system appear a some path below the unionfs mountpoint, * mountpt - The full path to the mountpoint for the union file system * - * Returned value: + * Returned Value: * Zero (OK) is returned if the union file system was correctly created and * mounted. On any failure, a negated error value will be returned to * indicate the nature of the failure. diff --git a/fs/vfs/fs_fstatfs.c b/fs/vfs/fs_fstatfs.c index 80c0d1d7dd..7e4ddb3879 100644 --- a/fs/vfs/fs_fstatfs.c +++ b/fs/vfs/fs_fstatfs.c @@ -54,7 +54,8 @@ /**************************************************************************** * Name: fstatfs * - * Return: Zero on success; -1 on failure with errno set: + * Returned Value: + * Zero on success; -1 on failure with errno set: * * EACCES Search permission is denied for one of the directories in the * path prefix of path. diff --git a/fs/vfs/fs_ioctl.c b/fs/vfs/fs_ioctl.c index a68dc43ce5..3127647869 100644 --- a/fs/vfs/fs_ioctl.c +++ b/fs/vfs/fs_ioctl.c @@ -68,7 +68,7 @@ * req The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * Returns a non-negative number on success; A negated errno value is * returned on any failure (see comments ioctl() for a list of appropriate * errno values). @@ -114,7 +114,7 @@ int file_ioctl(FAR struct file *filep, int req, unsigned long arg) * req The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * -1 on failure with errno set properly: * diff --git a/fs/vfs/fs_lseek.c b/fs/vfs/fs_lseek.c index 6827d931d1..fcdbb85664 100644 --- a/fs/vfs/fs_lseek.c +++ b/fs/vfs/fs_lseek.c @@ -65,7 +65,7 @@ * offset Defines the offset to position to * whence Defines how to use offset * - * Return: + * Returned Value: * The resulting offset on success. A negated errno value is returned on * any failure (see lseek comments). * @@ -146,7 +146,7 @@ off_t file_seek(FAR struct file *filep, off_t offset, int whence) * offset Defines the offset to position to * whence Defines how to use offset * - * Return: + * Returned Value: * The resulting offset on success. -1 on failure withi errno set properly: * * EBADF fd is not an open file descriptor. diff --git a/fs/vfs/fs_poll.c b/fs/vfs/fs_poll.c index 825f8d16d8..d6b32974b4 100644 --- a/fs/vfs/fs_poll.c +++ b/fs/vfs/fs_poll.c @@ -357,14 +357,14 @@ int fdesc_poll(int fd, FAR struct pollfd *fds, bool setup) * occurred for any of the file descriptors, then poll() blocks until * one of the events occurs. * - * Inputs: + * Input Parameters: * fds - List of structures describing file descriptors to be monitored * nfds - The number of entries in the list * timeout - Specifies an upper limit on the time for which poll() will * block in milliseconds. A negative value of timeout means an infinite * timeout. * - * Return: + * Returned Value: * On success, the number of structures that have non-zero revents fields. * A value of 0 indicates that the call timed out and no file descriptors * were ready. On error, -1 is returned, and errno is set appropriately: diff --git a/fs/vfs/fs_pread.c b/fs/vfs/fs_pread.c index 782c7448fb..9c7eb79461 100644 --- a/fs/vfs/fs_pread.c +++ b/fs/vfs/fs_pread.c @@ -129,7 +129,7 @@ ssize_t file_pread(FAR struct file *filep, FAR void *buf, size_t nbytes, * nbytes The maximum size of the user-provided buffer * offset The file offset * - * Return: + * Returned Value: * The positive non-zero number of bytes read on success, 0 on if an * end-of-file condition, or -1 on failure with errno set appropriately. * See read() return values diff --git a/fs/vfs/fs_pwrite.c b/fs/vfs/fs_pwrite.c index 1a67d915f8..698b6d9eb8 100644 --- a/fs/vfs/fs_pwrite.c +++ b/fs/vfs/fs_pwrite.c @@ -126,7 +126,7 @@ ssize_t file_pwrite(FAR struct file *filep, FAR const void *buf, * buf Data to write * nbytes Length of data to write * - * Return: + * Returned Value: * The positive non-zero number of bytes read on success, 0 on if an * end-of-file condition, or -1 on failure with errno set appropriately. * See write() return values diff --git a/fs/vfs/fs_select.c b/fs/vfs/fs_select.c index b3ba38bf42..e7fb11cc4f 100644 --- a/fs/vfs/fs_select.c +++ b/fs/vfs/fs_select.c @@ -84,7 +84,7 @@ * is more wasteful of resources and poll() is the recommended API to be * used. * - * Input parameters: + * Input Parameters: * nfds - the maximum fd number (+1) of any descriptor in any of the * three sets. * readfds - the set of descriptions to monitor for read-ready events @@ -93,7 +93,7 @@ * timeout - Return at this time if none of these events of interest * occur. * - * Return: + * Returned Value: * 0: Timer expired * >0: The number of bits set in the three sets of descriptors * -1: An error occurred (errno will be set appropriately) diff --git a/fs/vfs/fs_sendfile.c b/fs/vfs/fs_sendfile.c index a71dbcdf9b..b1ef4ffb2a 100644 --- a/fs/vfs/fs_sendfile.c +++ b/fs/vfs/fs_sendfile.c @@ -74,7 +74,7 @@ * different semantics and prototypes. sendfile() should not be used * in portable programs. * - * Input Parmeters: + * Input Parameters: * infd - A file (or socket) descriptor opened for reading * outfd - A descriptor opened for writing. * offset - If 'offset' is not NULL, then it points to a variable diff --git a/fs/vfs/fs_statfs.c b/fs/vfs/fs_statfs.c index 0f33c10aba..4a8f6af7e1 100644 --- a/fs/vfs/fs_statfs.c +++ b/fs/vfs/fs_statfs.c @@ -70,7 +70,8 @@ static int statpseudofs(FAR struct inode *inode, FAR struct statfs *buf) /**************************************************************************** * Name: statfs * - * Return: Zero on success; -1 on failure with errno set: + * Returned Value: + * Zero on success; -1 on failure with errno set: * * EACCES Search permission is denied for one of the directories in the * path prefix of path. diff --git a/graphics/nxbe/nxbe.h b/graphics/nxbe/nxbe.h index 5b0743c0d8..2f9ce9a3f8 100644 --- a/graphics/nxbe/nxbe.h +++ b/graphics/nxbe/nxbe.h @@ -198,7 +198,7 @@ int nxbe_configure(FAR NX_DRIVERTYPE *dev, FAR struct nxbe_state_s *be); * Input Parameters: * wnd - The window to be closed (and deallocated) * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -261,7 +261,7 @@ void nxbe_lower(FAR struct nxbe_window_s *wnd); * pos - The pixel location to be set * col - The color to use in the set * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -281,7 +281,7 @@ void nxbe_setpixel(FAR struct nxbe_window_s *wnd, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -302,7 +302,7 @@ void nxbe_fill(FAR struct nxbe_window_s *wnd, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -328,7 +328,7 @@ void nxbe_filltrapezoid(FAR struct nxbe_window_s *wnd, * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -349,7 +349,7 @@ void nxbe_getrectangle(FAR struct nxbe_window_s *wnd, * rect - Describes the rectangular region to move * offset - The offset to move the region * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -375,7 +375,7 @@ void nxbe_move(FAR struct nxbe_window_s *wnd, * may lie outside of the display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_bitmap.c b/graphics/nxbe/nxbe_bitmap.c index 61a380ca10..772b08e46a 100644 --- a/graphics/nxbe/nxbe_bitmap.c +++ b/graphics/nxbe/nxbe_bitmap.c @@ -109,7 +109,7 @@ static void nxs_clipcopy(FAR struct nxbe_clipops_s *cops, * may lie outside of the display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_closewindow.c b/graphics/nxbe/nxbe_closewindow.c index 44520da22c..cec2c5ae9e 100644 --- a/graphics/nxbe/nxbe_closewindow.c +++ b/graphics/nxbe/nxbe_closewindow.c @@ -61,7 +61,7 @@ * wnd - The window to be closed (and deallocated using the user-space * allocator) * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_fill.c b/graphics/nxbe/nxbe_fill.c index e2b45fbc96..48567ccdcf 100644 --- a/graphics/nxbe/nxbe_fill.c +++ b/graphics/nxbe/nxbe_fill.c @@ -99,7 +99,7 @@ static void nxbe_clipfill(FAR struct nxbe_clipops_s *cops, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_filltrapezoid.c b/graphics/nxbe/nxbe_filltrapezoid.c index 1936a6c4d6..51fde5728b 100644 --- a/graphics/nxbe/nxbe_filltrapezoid.c +++ b/graphics/nxbe/nxbe_filltrapezoid.c @@ -123,7 +123,7 @@ static void nxbe_clipfilltrapezoid(FAR struct nxbe_clipops_s *cops, * rect - The location to be filled (in relative window coordinates) * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_getrectangle.c b/graphics/nxbe/nxbe_getrectangle.c index 2e707a816c..72073537e6 100644 --- a/graphics/nxbe/nxbe_getrectangle.c +++ b/graphics/nxbe/nxbe_getrectangle.c @@ -76,7 +76,7 @@ struct nxbe_fill_s * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_move.c b/graphics/nxbe/nxbe_move.c index e2eee9f01b..747b4e5a76 100644 --- a/graphics/nxbe/nxbe_move.c +++ b/graphics/nxbe/nxbe_move.c @@ -197,7 +197,7 @@ static void nxbe_clipmovedest(FAR struct nxbe_clipops_s *cops, * rect - Describes the rectangular region to move * offset - The offset to move the region * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_setpixel.c b/graphics/nxbe/nxbe_setpixel.c index 574a4ee3de..409b11c442 100644 --- a/graphics/nxbe/nxbe_setpixel.c +++ b/graphics/nxbe/nxbe_setpixel.c @@ -99,7 +99,7 @@ static void nxbe_clipfill(FAR struct nxbe_clipops_s *cops, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxfe.h b/graphics/nxmu/nxfe.h index 62ae235fed..c1e02b769d 100644 --- a/graphics/nxmu/nxfe.h +++ b/graphics/nxmu/nxfe.h @@ -106,7 +106,7 @@ extern "C" * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -125,7 +125,7 @@ int nxmu_sendclient(FAR struct nxfe_conn_s *conn, * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -143,7 +143,7 @@ int nxmu_sendclientwindow(FAR struct nxbe_window_s *wnd, FAR const void *msg, * be - The back-end status structure * wnd - The pre-allocated window structure to be initialized [IN/OUT] * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -164,7 +164,7 @@ void nxmu_openwindow(FAR struct nxbe_state_s *be, * cb - Callbacks used to process window events * arg - User provided argument (see nx_openwindow, nx_constructwindow) * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -184,7 +184,7 @@ void nxmu_requestbkgd(FAR struct nxfe_conn_s *conn, * Input Parameters: * fe - The front-end state structure * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_openwindow.c b/graphics/nxmu/nxmu_openwindow.c index 01ed612a5b..0d05ac3700 100644 --- a/graphics/nxmu/nxmu_openwindow.c +++ b/graphics/nxmu/nxmu_openwindow.c @@ -76,7 +76,7 @@ * be - The back-end status structure * wnd - The pre-allocated window structure to be initialized [IN/OUT] * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_releasebkgd.c b/graphics/nxmu/nxmu_releasebkgd.c index 7f8d293507..35c6593072 100644 --- a/graphics/nxmu/nxmu_releasebkgd.c +++ b/graphics/nxmu/nxmu_releasebkgd.c @@ -79,7 +79,7 @@ * Input Parameters: * fe - The front-end state structure * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_requestbkgd.c b/graphics/nxmu/nxmu_requestbkgd.c index 72485b6aaa..fa12750fee 100644 --- a/graphics/nxmu/nxmu_requestbkgd.c +++ b/graphics/nxmu/nxmu_requestbkgd.c @@ -63,7 +63,7 @@ * cb - Callbacks used to process window events * arg - User provided argument (see nx_openwindow, nx_constructwindow) * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_sendclient.c b/graphics/nxmu/nxmu_sendclient.c index a26a6d3e96..21588fbbd2 100644 --- a/graphics/nxmu/nxmu_sendclient.c +++ b/graphics/nxmu/nxmu_sendclient.c @@ -62,7 +62,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_sendclientwindow.c b/graphics/nxmu/nxmu_sendclientwindow.c index e8ce5276a1..32d42a3d48 100644 --- a/graphics/nxmu/nxmu_sendclientwindow.c +++ b/graphics/nxmu/nxmu_sendclientwindow.c @@ -80,7 +80,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_server.c b/graphics/nxmu/nxmu_server.c index a2a2999abd..5593c57dd6 100644 --- a/graphics/nxmu/nxmu_server.c +++ b/graphics/nxmu/nxmu_server.c @@ -270,7 +270,7 @@ static inline int nxmu_setup(FAR const char *mqname, FAR NX_DRIVERTYPE *dev, * mqname - The name for the server incoming message queue * dev - Vtable "object" of the framebuffer/LCD "driver" to use * - * Return: + * Returned Value: * This function usually does not return. If it does return, it will * return ERROR and errno will be set appropriately. * diff --git a/graphics/nxterm/nx_register.c b/graphics/nxterm/nx_register.c index 3da6fd8a65..8c1e0a8018 100644 --- a/graphics/nxterm/nx_register.c +++ b/graphics/nxterm/nx_register.c @@ -90,7 +90,7 @@ static const struct nxterm_operations_s g_nxops = * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -114,7 +114,7 @@ static int nxterm_fill(FAR struct nxterm_state_s *priv, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -146,7 +146,7 @@ static int nxterm_move(FAR struct nxterm_state_s *priv, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -177,7 +177,7 @@ static int nxterm_bitmap(FAR struct nxterm_state_s *priv, * wndo - Describes the window and font to be used * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/graphics/nxterm/nxtk_register.c b/graphics/nxterm/nxtk_register.c index ae4e861246..d89f31cd3f 100644 --- a/graphics/nxterm/nxtk_register.c +++ b/graphics/nxterm/nxtk_register.c @@ -90,7 +90,7 @@ static const struct nxterm_operations_s g_nxtkops = * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -114,7 +114,7 @@ static int nxtkcon_fill(FAR struct nxterm_state_s *priv, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -146,7 +146,7 @@ static int nxtkcon_move(FAR struct nxterm_state_s *priv, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -177,7 +177,7 @@ static int nxtkcon_bitmap(FAR struct nxterm_state_s *priv, * wndo - Describes the window and font to be used * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/graphics/nxterm/nxtool_register.c b/graphics/nxterm/nxtool_register.c index 2a9de5d559..04849692f3 100644 --- a/graphics/nxterm/nxtool_register.c +++ b/graphics/nxterm/nxtool_register.c @@ -90,7 +90,7 @@ static const struct nxterm_operations_s g_nxtoolops = * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -114,7 +114,7 @@ static int nxtool_fill(FAR struct nxterm_state_s *priv, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -146,7 +146,7 @@ static int nxtool_move(FAR struct nxterm_state_s *priv, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -179,7 +179,7 @@ static int nxtool_bitmap(FAR struct nxterm_state_s *priv, * wndo - Describes the window and font to be used * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/graphics/vnc/server/vnc_fbdev.c b/graphics/vnc/server/vnc_fbdev.c index e599599654..47badee8f0 100644 --- a/graphics/vnc/server/vnc_fbdev.c +++ b/graphics/vnc/server/vnc_fbdev.c @@ -412,7 +412,7 @@ static int up_setcursor(FAR struct fb_vtable_s *vtable, * Description: * Start the VNC server. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -470,7 +470,7 @@ static int vnc_start_server(int display) * Description: * Wait for the server to be started. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -525,7 +525,7 @@ static inline int vnc_wait_start(int display) * Wait for the server to be connected to the VNC client. We can do * nothing until that connection is established. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -612,7 +612,7 @@ static inline int vnc_wait_connect(int display) * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -746,7 +746,7 @@ int vnc_fbinitialize(int display, vnc_kbdout_t kbdout, * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/include/hex2bin.h b/include/hex2bin.h index 3217c54560..3ee8e42dd4 100644 --- a/include/hex2bin.h +++ b/include/hex2bin.h @@ -133,7 +133,7 @@ extern "C" * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * @@ -163,7 +163,7 @@ int hex2bin(FAR struct lib_instream_s *instream, * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * @@ -190,7 +190,7 @@ int hex2mem(int fd, uint32_t baseaddr, uint32_t endpaddr, * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * @@ -208,7 +208,7 @@ int fhex2mem(FAR FILE *instream, uint32_t baseaddr, uint32_t endpaddr, * Input Parameters: * Standard task inputs * - * Returned Value + * Returned Value: * EXIT_SUCESS on success; EXIT_FAILURE on failure * ****************************************************************************/ @@ -226,7 +226,7 @@ int hex2bin_main(int argc, char **argv); * Input Parameters: * Standard task inputs * - * Returned Value + * Returned Value: * EXIT_SUCESS on success; EXIT_FAILURE on failure * ****************************************************************************/ diff --git a/include/nuttx/analog/adc.h b/include/nuttx/analog/adc.h index 524773e729..7ce2577fe4 100644 --- a/include/nuttx/analog/adc.h +++ b/include/nuttx/analog/adc.h @@ -227,7 +227,7 @@ extern "C" * driver with the "upper half" ADC device and registers that device so that can * be used by application code. * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/adc", "/dev/adc1", etc. where the driver path differs only diff --git a/include/nuttx/analog/dac.h b/include/nuttx/analog/dac.h index 93f1282ef5..5f9fce131c 100644 --- a/include/nuttx/analog/dac.h +++ b/include/nuttx/analog/dac.h @@ -190,7 +190,7 @@ int dac_register(FAR const char *path, FAR struct dac_dev_s *dev); * Input Parameters: * dev - An instance of the device-specific DAC interface * - * Return: + * Returned Value: * OK on success; a negated errno on failure. * ************************************************************************************/ diff --git a/include/nuttx/arch.h b/include/nuttx/arch.h index 6bbdf758b4..9e52a6b019 100644 --- a/include/nuttx/arch.h +++ b/include/nuttx/arch.h @@ -247,7 +247,7 @@ void up_initial_state(FAR struct tcb_s *tcb); * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack_size: The requested stack size. At least this much * must be allocated. @@ -289,7 +289,7 @@ int up_create_stack(FAR struct tcb_s *tcb, size_t stack_size, uint8_t ttype); * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The * initial value of the stack pointer. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - stack: The new stack to be used. * - stack_size: The allocated stack size. @@ -324,7 +324,7 @@ int up_use_stack(FAR struct tcb_s *tcb, FAR void *stack, size_t stack_size); * been removed from the stack. This will still be the initial value * of the stack pointer when the task is started. * - * Inputs: + * Input Parameters: * - tcb: The TCB of new task * - frame_size: The size of the stack frame to allocate. * @@ -344,7 +344,7 @@ FAR void *up_stack_frame(FAR struct tcb_s *tcb, size_t frame_size); * A task has been stopped. Free all stack related resources retained in * the defunct TCB. * - * Input Parmeters + * Input Parameters: * - dtcb: The TCB containing information about the stack to be released * - ttype: The thread type. This may be one of following (defined in * include/nuttx/sched.h): @@ -382,7 +382,7 @@ void up_release_stack(FAR struct tcb_s *dtcb, uint8_t ttype); * logic. Interrupts will always be disabled when this * function is called. * - * Inputs: + * Input Parameters: * tcb: Refers to the tcb to be unblocked. This tcb is * in one of the waiting tasks lists. It must be moved to * the ready-to-run list and, if it is the highest priority @@ -404,7 +404,7 @@ void up_unblock_task(FAR struct tcb_s *tcb); * logic. Interrupts will always be disabled when this * function is called. * - * Inputs: + * Input Parameters: * tcb: Refers to a task in the ready-to-run list (normally * the task at the head of the list). It most be * stopped, its context saved and moved into one of the @@ -455,7 +455,7 @@ void up_release_pending(void); * logic. Interrupts will always be disabled when this * function is called. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * @@ -601,12 +601,12 @@ void up_pthread_start(pthread_startroutine_t entrypt, pthread_addr_t arg) * function is the user-space, signal handler trampoline function. It is * called from up_signal_dispatch() in user-mode. * - * Inputs: + * Input Parameters: * sighand - The address user-space signal handling function * signo, info, and ucontext - Standard arguments to be passed to the * signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via an architecture specific system call made by up_signal_handler() * (see below). However, this will look like a normal return by the @@ -628,12 +628,12 @@ void up_signal_dispatch(_sa_sigaction_t sighand, int signo, * must be provided by architecture-specific logic. It is called from * up_signal_dispatch() in user-mode. * - * Inputs: + * Input Parameters: * sighand - The address user-space signal handling function * signo, info, and ucontext - Standard arguments to be passed to the * signal handling function. * - * Return: + * Returned Value: * None. This function does not return in the normal sense. It returns * via an architecture specific system call. * @@ -1741,7 +1741,7 @@ int up_cpu_index(void); * - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of * the stack pointer. * - * Inputs: + * Input Parameters: * - cpu: CPU index that indicates which CPU the IDLE task is * being created for. * - tcb: The TCB of new CPU IDLE task @@ -2015,10 +2015,10 @@ void sched_alarm_expiration(FAR const struct timespec *ts); * Description: * Collect data that can be used for CPU load measurements. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions/Limitations: @@ -2054,7 +2054,7 @@ void irq_dispatch(int irq, FAR void *context); * Input Parameters: * None * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ diff --git a/include/nuttx/audio/audio.h b/include/nuttx/audio/audio.h index 1bdb9fe7ef..1395873622 100644 --- a/include/nuttx/audio/audio.h +++ b/include/nuttx/audio/audio.h @@ -670,7 +670,7 @@ extern "C" * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * name - The name of the audio device. This name will be used to generate * a full path to the driver in the format "/dev/audio/[name]" in the NuttX * filesystem (i.e. the path "/dev/audio" will be prepended to the supplied @@ -695,7 +695,7 @@ int audio_register(FAR const char *name, FAR struct audio_lowerhalf_s *dev); * Allocated an AP Buffer and prepares it for use. This allocates a dynamically * allocated buffer that has no special DMA capabilities. * - * Input parameters: + * Input Parameters: * bufdesc: Pointer to a buffer descriptor * * Returned Value: diff --git a/include/nuttx/audio/tone.h b/include/nuttx/audio/tone.h index e9a9c0059a..f5087ae743 100644 --- a/include/nuttx/audio/tone.h +++ b/include/nuttx/audio/tone.h @@ -71,7 +71,7 @@ extern "C" * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/tone0", "/dev/tone1", etc. where the driver path diff --git a/include/nuttx/binfmt/binfmt.h b/include/nuttx/binfmt/binfmt.h index 4ca74f5a01..ab238a2d6c 100644 --- a/include/nuttx/binfmt/binfmt.h +++ b/include/nuttx/binfmt/binfmt.h @@ -271,7 +271,7 @@ int exec_module(FAR const struct binary_s *bin); * or friends. It will also automatically free the structure with * kmm_free() after unloading the module. * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * bin - This structure must have been allocated with kmm_malloc() and must * persist until the task unloads diff --git a/include/nuttx/binfmt/builtin.h b/include/nuttx/binfmt/builtin.h index 6f4a87be24..bb4594bb9a 100644 --- a/include/nuttx/binfmt/builtin.h +++ b/include/nuttx/binfmt/builtin.h @@ -117,7 +117,7 @@ void builtin_uninitialize(void); * Description: * Checks for availabiliy of application registerred during compile time. * - * Input Parameter: + * Input Parameters: * filename - Name of the linked-in binary to be started. * * Returned Value: @@ -136,7 +136,7 @@ int builtin_isavail(FAR const char *appname); * Returns pointer to a name of built-in application pointed by the * index. * - * Input Parameter: + * Input Parameters: * index, from 0 and on ... * * Returned Value: @@ -158,7 +158,7 @@ FAR const char *builtin_getname(int index); * If support for builtin functions is enabled in the NuttX configuration, * then this function must be provided by the application code. * - * Input Parameter: + * Input Parameters: * index, from 0 and on... * * Returned Value: diff --git a/include/nuttx/cancelpt.h b/include/nuttx/cancelpt.h index 87b560fd92..10cd20bfaf 100644 --- a/include/nuttx/cancelpt.h +++ b/include/nuttx/cancelpt.h @@ -103,7 +103,7 @@ extern "C" * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * @@ -133,7 +133,7 @@ bool enter_cancellation_point(void); * Input Parameters: * None * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -157,7 +157,7 @@ void leave_cancellation_point(void); * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * diff --git a/include/nuttx/clock.h b/include/nuttx/clock.h index d05d49a50e..0892615e3c 100644 --- a/include/nuttx/clock.h +++ b/include/nuttx/clock.h @@ -272,7 +272,7 @@ EXTERN volatile systime_t g_system_timer; * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -302,7 +302,7 @@ void clock_synchronize(void); * Parameters: * diff: amount of time system-time is adjusted forward with RTC * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -329,7 +329,7 @@ void clock_resynchronize(FAR struct timespec *rtc_diff); * Parameters: * None * - * Return Value: + * Returned Value: * The current value of the system timer counter * * Assumptions: @@ -350,7 +350,7 @@ systime_t clock_systimer(void); * Parameters: * ts - Location to return the time * - * Return Value: + * Returned Value: * Current version always returns OK * * Assumptions: @@ -369,7 +369,7 @@ int clock_systimespec(FAR struct timespec *ts); * pid - The task ID of the thread of interest. pid == 0 is the IDLE thread. * cpuload - The location to return the CPU load * - * Return Value: + * Returned Value: * OK (0) on success; a negated errno value on failure. The only reason * that this function can fail is if 'pid' no longer refers to a valid * thread. diff --git a/include/nuttx/crypto/aes.h b/include/nuttx/crypto/aes.h index 5c4d3e8050..af97032e50 100644 --- a/include/nuttx/crypto/aes.h +++ b/include/nuttx/crypto/aes.h @@ -75,7 +75,7 @@ extern "C" * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -94,7 +94,7 @@ void aes_encrypt(FAR uint8_t *state, FAR const uint8_t *key); * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/drivers/drivers.h b/include/nuttx/drivers/drivers.h index 612434d15b..b2f1bbf79e 100644 --- a/include/nuttx/drivers/drivers.h +++ b/include/nuttx/drivers/drivers.h @@ -227,12 +227,12 @@ ssize_t bchlib_write(FAR void *handle, FAR const char *buffer, size_t offset, * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * fd[2] - The user provided array in which to catch the pipe file * descriptors * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * @@ -264,13 +264,13 @@ int pipe2(int fd[2], size_t bufsize); * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * pathname - The full path to the FIFO instance to attach to or to create * (if not already created). * mode - Ignored for now * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/include/nuttx/drivers/pwm.h b/include/nuttx/drivers/pwm.h index eddea5804e..2d0a5d2c7d 100644 --- a/include/nuttx/drivers/pwm.h +++ b/include/nuttx/drivers/pwm.h @@ -260,7 +260,7 @@ extern "C" * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/pwm0", "/dev/pwm1", etc. where the driver path differs only @@ -301,7 +301,7 @@ int pwm_register(FAR const char *path, FAR struct pwm_lowerhalf_s *dev); * interface using the handle that was previously passed to the * start() method * - * Input parameters: + * Input Parameters: * handle - This is the handle that was provided to the lower-half * start() method. * diff --git a/include/nuttx/drivers/ramdisk.h b/include/nuttx/drivers/ramdisk.h index 27cfb4e992..86bb5f4eff 100644 --- a/include/nuttx/drivers/ramdisk.h +++ b/include/nuttx/drivers/ramdisk.h @@ -79,14 +79,14 @@ extern "C" * Description: * Non-standard function to register a ramdisk or a romdisk * - * Input Parmeters: + * Input Parameters: * minor: Selects suffix of device named /dev/ramN, N={1,2,3...} * nsectors: Number of sectors on device * sectize: The size of one sector * rdflags: See RDFLAG_* definitions * buffer: RAM disk backup memory * - * Returned Valued: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/fs/fs.h b/include/nuttx/fs/fs.h index bb3b989ab4..424b8b4477 100644 --- a/include/nuttx/fs/fs.h +++ b/include/nuttx/fs/fs.h @@ -496,7 +496,7 @@ void fs_initialize(void); * Description: * Register a character driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * fops - The file operations structure * mode - inmode privileges (not used) @@ -523,7 +523,7 @@ int register_driver(FAR const char *path, * Description: * Register a block driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * bops - The block driver operations structure * mode - inmode privileges (not used) @@ -1051,7 +1051,7 @@ int file_truncate(FAR struct file *filep, off_t length); * req The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * Returns a non-negative number on success; A negated errno value is * returned on any failure (see comments ioctl() for a list of appropriate * errno values). diff --git a/include/nuttx/fs/unionfs.h b/include/nuttx/fs/unionfs.h index 35815de8c3..485197e129 100644 --- a/include/nuttx/fs/unionfs.h +++ b/include/nuttx/fs/unionfs.h @@ -83,7 +83,7 @@ extern "C" * file system appear a some path below the unionfs mountpoint, * mountpt - The full path to the mountpoint for the union file system * - * Returned value: + * Returned Value: * Zero (OK) is returned if the union file system was correctly created and * mounted. On any failure, a negated error value will be returned to * indicate the nature of the failure. diff --git a/include/nuttx/fs/userfs.h b/include/nuttx/fs/userfs.h index 29ad9d3d91..a1b96938ee 100644 --- a/include/nuttx/fs/userfs.h +++ b/include/nuttx/fs/userfs.h @@ -549,7 +549,7 @@ extern "C" * NOTE: This is an OS internal function that should not be called from * appliation logic. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -584,7 +584,7 @@ int userfs_register(void); * NOTE: This is a user function that is implemented as part of the * NuttX C library and is intended to be called by appliation logic. * - * Input parameters: + * Input Parameters: * mountpt - Mountpoint path * userops - The caller operations that implement the file system * interface. diff --git a/include/nuttx/input/ajoystick.h b/include/nuttx/input/ajoystick.h index 7cc7d384b0..9e7d6a0cd0 100644 --- a/include/nuttx/input/ajoystick.h +++ b/include/nuttx/input/ajoystick.h @@ -283,7 +283,7 @@ extern "C" * lower - An instance of the platform-specific analog joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/input/buttons.h b/include/nuttx/input/buttons.h index dbaaec45e1..601979b462 100644 --- a/include/nuttx/input/buttons.h +++ b/include/nuttx/input/buttons.h @@ -191,7 +191,7 @@ extern "C" * minor device number. * lower - An instance of the platform-specific button lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/input/djoystick.h b/include/nuttx/input/djoystick.h index 3f0f1e0aa9..21def3909b 100644 --- a/include/nuttx/input/djoystick.h +++ b/include/nuttx/input/djoystick.h @@ -260,7 +260,7 @@ extern "C" * lower - An instance of the platform-specific discrete joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/input/nunchuck.h b/include/nuttx/input/nunchuck.h index 844b66abc2..cc0a3b8fca 100644 --- a/include/nuttx/input/nunchuck.h +++ b/include/nuttx/input/nunchuck.h @@ -169,7 +169,7 @@ extern "C" * minor device number. * i2c - An instance of the platform-specific I2C connected to Nunchuck. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/kthread.h b/include/nuttx/kthread.h index 254ce87098..c9f2ffaf70 100644 --- a/include/nuttx/kthread.h +++ b/include/nuttx/kthread.h @@ -97,7 +97,7 @@ extern "C" * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. @@ -126,7 +126,7 @@ int nxtask_create(FAR const char *name, int priority, * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. diff --git a/include/nuttx/leds/rgbled.h b/include/nuttx/leds/rgbled.h index 554f0719ff..4fb192dc33 100644 --- a/include/nuttx/leds/rgbled.h +++ b/include/nuttx/leds/rgbled.h @@ -71,7 +71,7 @@ extern "C" * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/rgdbled0", "/dev/rgbled1", etc. where the driver path diff --git a/include/nuttx/leds/userled.h b/include/nuttx/leds/userled.h index 0b9f8b0e25..f0a027808a 100644 --- a/include/nuttx/leds/userled.h +++ b/include/nuttx/leds/userled.h @@ -170,7 +170,7 @@ extern "C" * minor device number. * lower - An instance of the platform-specific LED lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/mqueue.h b/include/nuttx/mqueue.h index b7276a6ff5..9c6a650c28 100644 --- a/include/nuttx/mqueue.h +++ b/include/nuttx/mqueue.h @@ -306,7 +306,7 @@ ssize_t nxmq_timedreceive(mqd_t mqdes, FAR char *msg, size_t msglen, * closed so that no thread will attempt access it while it is being * deleted. * - * Inputs: + * Input Parameters: * msgq - Named essage queue to be freed * * Returned Value: diff --git a/include/nuttx/mtd/configdata.h b/include/nuttx/mtd/configdata.h index 65965c6195..1dff77f0f2 100644 --- a/include/nuttx/mtd/configdata.h +++ b/include/nuttx/mtd/configdata.h @@ -117,7 +117,7 @@ extern "C" * When this function is called, the MTD device pass in should already * be initialized appropriately to access the physical device or partition. * - * Input parameters: + * Input Parameters: * mtd - Pointer to the MTD device to bind with the /dev/config device * * Returned Value: diff --git a/include/nuttx/mtd/hamming.h b/include/nuttx/mtd/hamming.h index 99358e10dc..706cb125f1 100644 --- a/include/nuttx/mtd/hamming.h +++ b/include/nuttx/mtd/hamming.h @@ -108,7 +108,7 @@ extern "C" * size - Data size in bytes * code - Codes buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -127,7 +127,7 @@ void hamming_compute256x(FAR const uint8_t *data, size_t size, uint8_t *code); * size - Size of the data in bytes * code - Original codes * - * Returned Values: + * Returned Value: * Return 0 if the data is correct, HAMMING_ERROR_SINGLEBIT if one or more * block(s) have had a single bit corrected, or either HAMMING_ERROR_ECC * or HAMMING_ERROR_MULTIPLEBITS. diff --git a/include/nuttx/mtd/mtd.h b/include/nuttx/mtd/mtd.h index e834469866..f201e9ebbd 100644 --- a/include/nuttx/mtd/mtd.h +++ b/include/nuttx/mtd/mtd.h @@ -243,7 +243,7 @@ extern "C" * partitions, that mutual exclusion would be provided by the file system * above the FLASH driver. * - * Input parameters: + * Input Parameters: * mtd - The MTD device to be partitioned * firstblock - The offset in bytes to the first block * nblocks - The number of blocks in the partition diff --git a/include/nuttx/mtd/nand.h b/include/nuttx/mtd/nand.h index b19c6cb79a..ab3b73771f 100644 --- a/include/nuttx/mtd/nand.h +++ b/include/nuttx/mtd/nand.h @@ -99,10 +99,10 @@ extern "C" * Description: * Probe and initialize NAND. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * - * Returned value. + * Returned Value: * A non-NULL MTD driver intstance is returned on success. NULL is * returned on any failaure. * diff --git a/include/nuttx/mtd/nand_ecc.h b/include/nuttx/mtd/nand_ecc.h index 7e94d4c373..a86b0f2aab 100644 --- a/include/nuttx/mtd/nand_ecc.h +++ b/include/nuttx/mtd/nand_ecc.h @@ -86,14 +86,14 @@ extern "C" * the spare area. If a buffer pointer is NULL, then the corresponding area * is not saved. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -111,14 +111,14 @@ int nandecc_readpage(FAR struct nand_dev_s *nand, off_t block, * If no spare buffer is provided, the spare area is still written with the * ECC information calculated on the data buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ diff --git a/include/nuttx/mtd/nand_model.h b/include/nuttx/mtd/nand_model.h index bd1363cfdd..0012e339bf 100644 --- a/include/nuttx/mtd/nand_model.h +++ b/include/nuttx/mtd/nand_model.h @@ -127,7 +127,7 @@ EXTERN const struct nand_model_s g_nandmodels[NAND_NMODELS]; * chipid Identifier returned by the Nand(id1|(id2<<8)|(id3<<16)|(id4<<24)). * model nand_model_s instance to update with the model parameters. * - * Returned Values: + * Returned Value: * OK is returned on success; -ENODEV is returned on failure. * ****************************************************************************/ @@ -151,7 +151,7 @@ int nandmodel_find(FAR const struct nand_model_s *modeltab, size_t size, * page Stores the first accessed page number inside the first block. * offset Stores the byte offset inside the first accessed page. * - * Returned Values: + * Returned Value: * OK on success; -EPIPE on failure. * ****************************************************************************/ @@ -170,7 +170,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Spare placement scheme * ****************************************************************************/ @@ -186,7 +186,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Device ID * ****************************************************************************/ @@ -202,7 +202,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Number of blocks in the device * ****************************************************************************/ @@ -220,7 +220,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Size of the device in bytes * ****************************************************************************/ @@ -237,7 +237,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * size of the device in MB. * ****************************************************************************/ @@ -253,7 +253,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Block size in pages * ****************************************************************************/ @@ -270,7 +270,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Number of pages in the device * ****************************************************************************/ @@ -288,7 +288,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Block size in bytes * ****************************************************************************/ @@ -304,7 +304,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Size of data area in bytes * ****************************************************************************/ @@ -320,7 +320,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * size of spare area in bytes * ****************************************************************************/ @@ -336,7 +336,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model); * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * data width * ****************************************************************************/ @@ -354,7 +354,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model); * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Returns true if the given NAND FLASH model uses the "small blocks/pages" * command set; otherwise returns false. * @@ -372,7 +372,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model); * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Returns true if the device supports the copy-back operation. Otherwise * returns false. * diff --git a/include/nuttx/mtd/nand_raw.h b/include/nuttx/mtd/nand_raw.h index f2edd3821e..44cc069000 100644 --- a/include/nuttx/mtd/nand_raw.h +++ b/include/nuttx/mtd/nand_raw.h @@ -128,11 +128,11 @@ * Description: * Erases the specified block of the device. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the physical block to erase. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -146,14 +146,14 @@ * Reads the data and/or the spare areas of a page of a NAND FLASH into the * provided buffers. This is a raw read of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -167,14 +167,14 @@ * Writes the data and/or the spare area of a page on a NAND FLASH chip. * This is a raw write of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -189,14 +189,14 @@ * provided buffers. Hardware ECC checking will be performed if so * configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -214,14 +214,14 @@ * Writes the data and/or the spare area of a page on a NAND FLASH chip. * Hardware ECC checking will be performed if so configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ diff --git a/include/nuttx/mtd/nand_scheme.h b/include/nuttx/mtd/nand_scheme.h index acc4b56f11..a30caae165 100644 --- a/include/nuttx/mtd/nand_scheme.h +++ b/include/nuttx/mtd/nand_scheme.h @@ -109,7 +109,7 @@ EXTERN const struct nand_scheme_s g_nand_sparescheme4096; * spare Spare area buffer. * marker Pointer to the variable to store the bad block marker. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -130,7 +130,7 @@ void nandscheme_readbadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * marker Bad block marker to write. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -150,7 +150,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Offset in the spare area to the first ECC byte * ****************************************************************************/ @@ -166,7 +166,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Size of the ECC information in the spare area. * ****************************************************************************/ @@ -184,7 +184,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -203,7 +203,7 @@ void nandscheme_readecc(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -223,7 +223,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Offset in the spare area to the first extra byte * ****************************************************************************/ @@ -239,7 +239,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Size of the extra information in the spare area. * ****************************************************************************/ @@ -260,7 +260,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to read. * offset Index where to read the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -283,7 +283,7 @@ void nandscheme_readextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -305,7 +305,7 @@ void nandscheme_writeextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/net/ieee802154.h b/include/nuttx/net/ieee802154.h index 20ff457593..5f938f3290 100644 --- a/include/nuttx/net/ieee802154.h +++ b/include/nuttx/net/ieee802154.h @@ -71,7 +71,7 @@ * If there are multilple frames in the list, this metadata * must apply to all of the frames in the list. * - * Return: + * Returned Value: * OK The IEEE 802.15.4 has been processed and can be deleted * ERROR Hold the IEEE 802.15.4 and try again later. There is a listening * socket but no recv in place to catch the IEEE 802.15.4 yet. diff --git a/include/nuttx/net/net.h b/include/nuttx/net/net.h index 9e1eec09db..c24b4245e1 100644 --- a/include/nuttx/net/net.h +++ b/include/nuttx/net/net.h @@ -306,7 +306,7 @@ void net_initialize(void); * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -322,7 +322,7 @@ void net_lock(void); * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -340,7 +340,7 @@ void net_unlock(void); * sem - A reference to the semaphore to be taken. * abstime - The absolute time to wait until a timeout is declared. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * @@ -358,7 +358,7 @@ int net_timedwait(sem_t *sem, FAR const struct timespec *abstime); * Input Parameters: * sem - A reference to the semaphore to be taken. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * @@ -1037,7 +1037,7 @@ int psock_setsockopt(FAR struct socket *psock, int level, int option, * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * @@ -1070,7 +1070,7 @@ int psock_ioctl(FAR struct socket *psock, int cmd, unsigned long arg); * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * diff --git a/include/nuttx/net/pkt.h b/include/nuttx/net/pkt.h index 03e4a0d22a..fc2d9bd5a2 100644 --- a/include/nuttx/net/pkt.h +++ b/include/nuttx/net/pkt.h @@ -73,7 +73,7 @@ * Parameters: * dev - The device driver structure containing the received packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR There is a matching connection, but could not dispatch the packet * yet. Useful when a packet arrives before a recv call is in diff --git a/include/nuttx/net/radiodev.h b/include/nuttx/net/radiodev.h index 91cebd35b6..b2e95e7272 100644 --- a/include/nuttx/net/radiodev.h +++ b/include/nuttx/net/radiodev.h @@ -189,7 +189,7 @@ struct radio_driver_s * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to recreate the * radio MAC header @@ -209,7 +209,7 @@ struct radio_driver_s * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -233,7 +233,7 @@ struct radio_driver_s * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/include/nuttx/net/telnet.h b/include/nuttx/net/telnet.h index c7184c6d6b..16668f1d24 100644 --- a/include/nuttx/net/telnet.h +++ b/include/nuttx/net/telnet.h @@ -85,7 +85,7 @@ struct telnet_session_s * Parameters: * None * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/nx/nx.h b/include/nuttx/nx/nx.h index aec345ac60..4287497017 100644 --- a/include/nuttx/nx/nx.h +++ b/include/nuttx/nx/nx.h @@ -260,7 +260,7 @@ extern "C" * mqname - The name for the server incoming message queue * dev - Vtable "object" of the framebuffer "driver" to use * - * Return: + * Returned Value: * This function usually does not return. If it does return, it will * return ERROR and errno will be set appropriately. * @@ -315,7 +315,7 @@ int nx_start(void); * Input Parameters: * svrmqname - The name for the server incoming message queue * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * @@ -334,7 +334,7 @@ NXHANDLE nx_connectinstance(FAR const char *svrmqname); * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -358,7 +358,7 @@ void nx_disconnect(NXHANDLE handle); * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then * one or more server messages were processed. * ERROR: An error occurred and errno has been set appropriately. Of @@ -385,7 +385,7 @@ int nx_eventhandler(NXHANDLE handle); * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -407,7 +407,7 @@ int nx_eventnotify(NXHANDLE handle, int signo); * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * @@ -425,7 +425,7 @@ NXWINDOW nx_openwindow(NXHANDLE handle, FAR const struct nx_callback_s *cb, * Input Parameters: * wnd - The window to be destroyed * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -456,7 +456,7 @@ int nx_closewindow(NXWINDOW hwnd); * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -497,7 +497,7 @@ int nx_block(NXWINDOW hwnd, FAR void *arg); * cb - Callbacks to use for processing background window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -515,7 +515,7 @@ int nx_requestbkgd(NXHANDLE handle, FAR const struct nx_callback_s *cb, * Input Parameters: * hwnd - The handle returned (indirectly) by nx_requestbkgd * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -533,7 +533,7 @@ int nx_releasebkgd(NXWINDOW hwnd); * Input Parameters: * hwnd - The window handle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -550,7 +550,7 @@ int nx_getposition(NXWINDOW hwnd); * hwnd - The window handle * pos - The new position of the window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -567,7 +567,7 @@ int nx_setposition(NXWINDOW hwnd, FAR const struct nxgl_point_s *pos); * hwnd - The window handle * size - The new size of the window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -580,10 +580,10 @@ int nx_setsize(NXWINDOW hwnd, FAR const struct nxgl_size_s *size); * Description: * Bring the specified window to the top of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be raised * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -596,10 +596,10 @@ int nx_raise(NXWINDOW hwnd); * Description: * Lower the specified window to the bottom of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be lowered * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -618,7 +618,7 @@ int nx_lower(NXWINDOW hwnd); * pos - The pixel location to be set * col - The color to use in the set * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -637,7 +637,7 @@ int nx_setpixel(NXWINDOW hwnd, FAR const struct nxgl_point_s *pos, * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -666,7 +666,7 @@ int nx_fill(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect, * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -687,7 +687,7 @@ int nx_getrectangle(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect, * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -712,7 +712,7 @@ int nx_filltrapezoid(NXWINDOW hwnd, FAR const struct nxgl_rect_s *clip, * caps - Draw a circular on the both ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -734,7 +734,7 @@ int nx_drawline(NXWINDOW hwnd, FAR struct nxgl_vector_s *vector, * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -755,7 +755,7 @@ int nx_drawcircle(NXWINDOW hwnd, FAR const struct nxgl_point_s *center, * radius - The radius of the circle in pixels. * color - The color to use to fill the circle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -774,7 +774,7 @@ int nx_fillcircle(NXWINDOW hwnd, FAR const struct nxgl_point_s *center, * handle - The connection handle * color - The color to use in the background * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -793,7 +793,7 @@ int nx_setbgcolor(NXHANDLE handle, nxgl_mxpixel_t color[CONFIG_NX_NPLANES]); * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -819,7 +819,7 @@ int nx_move(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -936,7 +936,7 @@ void nx_redrawreq(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect); * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. In the * case of ERROR, NX will have deallocated the pre-allocated window. * diff --git a/include/nuttx/nx/nxfonts.h b/include/nuttx/nx/nxfonts.h index 525a5f56a2..47e53aa2cf 100644 --- a/include/nuttx/nx/nxfonts.h +++ b/include/nuttx/nx/nxfonts.h @@ -603,7 +603,7 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height, * bpp - Bits per pixel * maxglyphs - Maximum number of glyphs permitted in the cache * - * Returned value: + * Returned Value: * On success a non-NULL handle is returned that then may sequently be * used with nxf_getglyph() to extract fonts from the font cache. NULL * returned on any failure with the errno value set to indicate the nature @@ -626,7 +626,7 @@ FCACHE nxf_cache_connect(enum nx_fontid_e fontid, * Input Parameters: * fhandle - A font cache handler previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -643,7 +643,7 @@ void nxf_cache_disconnect(FCACHE fhandle); * Input Parameters: * fhandle - A font cache handle previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * Zero (OK) is returned if the metrics were * * Returned Value: diff --git a/include/nuttx/nx/nxglib.h b/include/nuttx/nx/nxglib.h index e0d3f6b846..89530cac25 100644 --- a/include/nuttx/nx/nxglib.h +++ b/include/nuttx/nx/nxglib.h @@ -679,12 +679,12 @@ bool nxgl_colorcmp(const nxgl_mxpixel_t color1[CONFIG_NX_NPLANES], * this case, 3 trapezoids will be returned, but traps[1] will be * degenerate. * - * Input parameters: + * Input Parameters: * vector - A pointer to the vector described the line to be drawn. * traps - A pointer to a array of trapezoids (size 3). * rect - A pointer to a rectangle. * - * Returned value: + * Returned Value: * 0: Line successfully broken up into three trapezoids. Values in * traps[0], traps[1], and traps[2] are valid. * 1: Line successfully represented by one trapezoid. Value in traps[1] @@ -708,13 +708,13 @@ int nxgl_splitline(FAR struct nxgl_vector_s *vector, * circumference of the circle. These points may then be used by * nx_drawcircle() or related APIs to draw a circle outline. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 16 points where the * circle points will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -730,13 +730,13 @@ void nxgl_circlepts(FAR const struct nxgl_point_s *center, * Given a description of a a circle, return 8 trapezoids that can be * used to fill the circle by nx_fillcircle() and other interfaces. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 8 trapezoids where * the circle description will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/nx/nxmu.h b/include/nuttx/nx/nxmu.h index fe8253bd74..fb6cd68d34 100644 --- a/include/nuttx/nx/nxmu.h +++ b/include/nuttx/nx/nxmu.h @@ -495,7 +495,7 @@ extern "C" * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. In the * case of ERROR, NX will have deallocated the pre-allocated window. * @@ -515,7 +515,7 @@ int nxfe_constructwindow(NXHANDLE handle, * Input Parameters: * sem - the semaphore to be taken. * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -533,7 +533,7 @@ void nxmu_semtake(sem_t *sem); * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -553,7 +553,7 @@ int nxmu_sendserver(FAR struct nxfe_conn_s *conn, * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/include/nuttx/nx/nxterm.h b/include/nuttx/nx/nxterm.h index 48347c1fad..dc11a9d106 100644 --- a/include/nuttx/nx/nxterm.h +++ b/include/nuttx/nx/nxterm.h @@ -229,7 +229,7 @@ extern "C" * nxtool_register() returns. * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ @@ -252,7 +252,7 @@ NXTERM nx_register(NXWINDOW hwnd, FAR struct nxterm_window_s *wndo, * nxtool_register() returns. * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ @@ -277,7 +277,7 @@ NXTERM nxtk_register(NXTKWINDOW hfwnd, FAR struct nxterm_window_s *wndo, * nxtool_register() returns. * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/include/nuttx/nx/nxtk.h b/include/nuttx/nx/nxtk.h index 6cd00f01b8..75b31c2164 100644 --- a/include/nuttx/nx/nxtk.h +++ b/include/nuttx/nx/nxtk.h @@ -125,7 +125,7 @@ extern "C" * cb - Callbacks used to process window events * arg - User provided value that will be returned with NXTK callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NXTK window accesses * Failure: NULL is returned and errno is set appropriately * @@ -143,7 +143,7 @@ NXTKWINDOW nxtk_openwindow(NXHANDLE handle, * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -176,7 +176,7 @@ int nxtk_closewindow(NXTKWINDOW hfwnd); * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -194,7 +194,7 @@ int nxtk_block(NXTKWINDOW hfwnd, FAR void *arg); * Input Parameters: * hfwnd - The window handle returned by nxtk_openwindow. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -213,7 +213,7 @@ int nxtk_getposition(NXTKWINDOW hfwnd); * hfwnd - The window handle returned by nxtk_openwindow * pos - The new position of the client sub-window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -232,7 +232,7 @@ int nxtk_setposition(NXTKWINDOW hfwnd, FAR const struct nxgl_point_s *pos); * hfwnd - The window handle returned by nxtk_openwindow * size - The new size of the client sub-window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -246,11 +246,11 @@ int nxtk_setsize(NXTKWINDOW hfwnd, FAR const struct nxgl_size_s *size); * Bring the window containing the specified client sub-window to the top * of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be raised. This must have been previously created * by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -264,11 +264,11 @@ int nxtk_raise(NXTKWINDOW hfwnd); * Lower the window containing the specified client sub-window to the * bottom of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be lowered. This must have been previously created * by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -286,7 +286,7 @@ int nxtk_lower(NXTKWINDOW hfwnd); * rect - The location within the client window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -310,7 +310,7 @@ int nxtk_fillwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -330,7 +330,7 @@ int nxtk_getwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -355,7 +355,7 @@ int nxtk_filltrapwindow(NXTKWINDOW hfwnd, * caps - Draw a circular cap the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -377,7 +377,7 @@ int nxtk_drawlinewindow(NXTKWINDOW hfwnd, FAR struct nxgl_vector_s *vector, * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -399,7 +399,7 @@ int nxtk_drawcirclewindow(NXTKWINDOW hfwnd, * radius - The radius of the circle in pixels. * color - The color to use to fill the circle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -423,7 +423,7 @@ int nxtk_fillcirclewindow(NXWINDOW hfwnd, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -449,7 +449,7 @@ int nxtk_movewindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * origin may lie outside of the sub-window display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -471,7 +471,7 @@ int nxtk_bitmapwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *dest, * cb - Callbacks used to process toolbar events * arg - User provided value that will be returned with toolbar callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -488,7 +488,7 @@ int nxtk_opentoolbar(NXTKWINDOW hfwnd, nxgl_coord_t height, * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -511,7 +511,7 @@ int nxtk_closetoolbar(NXTKWINDOW hfwnd); * hfwnd - The handle returned by nxtk_openwindow * bounds - User provided location in which to return the bounding box. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -529,7 +529,7 @@ int nxtk_toolbarbounds(NXTKWINDOW hfwnd, FAR struct nxgl_rect_s *bounds); * rect - The location within the toolbar window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -553,7 +553,7 @@ int nxtk_filltoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -573,7 +573,7 @@ int nxtk_gettoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -599,7 +599,7 @@ int nxtk_filltraptoolbar(NXTKWINDOW hfwnd, * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -621,7 +621,7 @@ int nxtk_drawlinetoolbar(NXTKWINDOW hfwnd, FAR struct nxgl_vector_s *vector, * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -643,7 +643,7 @@ int nxtk_drawcircletoolbar(NXTKWINDOW hfwnd, * radius - The radius of the circle in pixels. * color - The color to use to fill the circle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -668,7 +668,7 @@ int nxtk_fillcircletoolbar(NXWINDOW hfwnd, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -693,7 +693,7 @@ int nxtk_movetoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * origin may lie outside of the sub-window display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/include/nuttx/power/battery_charger.h b/include/nuttx/power/battery_charger.h index 997e0fa5c3..e17618b293 100644 --- a/include/nuttx/power/battery_charger.h +++ b/include/nuttx/power/battery_charger.h @@ -196,12 +196,12 @@ extern "C" * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/power/battery_gauge.h b/include/nuttx/power/battery_gauge.h index 24a8eb5055..d6bd280cf7 100644 --- a/include/nuttx/power/battery_gauge.h +++ b/include/nuttx/power/battery_gauge.h @@ -158,12 +158,12 @@ extern "C" * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/power/pm.h b/include/nuttx/power/pm.h index 482131911f..92df1c7749 100644 --- a/include/nuttx/power/pm.h +++ b/include/nuttx/power/pm.h @@ -364,10 +364,10 @@ extern "C" * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ @@ -381,11 +381,11 @@ void pm_initialize(void); * This function is called by a device driver in order to register to * receive power management event callbacks. * - * Input parameters: + * Input Parameters: * callbacks - An instance of struct pm_callback_s providing the driver * callback functions. * - * Returned value: + * Returned Value: * Zero (OK) on success; otherwise a negater errno value is returned. * ****************************************************************************/ diff --git a/include/nuttx/sched.h b/include/nuttx/sched.h index 3810962c8b..8f80165d76 100644 --- a/include/nuttx/sched.h +++ b/include/nuttx/sched.h @@ -823,12 +823,12 @@ FAR struct socketlist *sched_getsockets(void); * The start hook is useful, for example, for setting up automatic * configuration of C++ constructors. * - * Inputs: + * Input Parameters: * tcb - The new, unstarted task task that needs the start hook * starthook - The pointer to the start hook function * arg - The argument to pass to the start hook function. * - * Return: + * Returned Value: * None * ********************************************************************************/ @@ -923,14 +923,14 @@ void sched_suspend_scheduler(FAR struct tcb_s *tcb); * use by application logic. Applications should use the standard * sched_getparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority * of the calling task is returned. * param - A structure whose member sched_priority is the integer * priority. The task's priority is copied to the sched_priority * element of this structure. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -958,14 +958,14 @@ int nxsched_getparam (pid_t pid, FAR struct sched_param *param); * use by application logic. Applications should use the standard * sched_setparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to reprioritize. If pid is zero, the * priority of the calling task is changed. * param - A structure whose member sched_priority is the integer priority. * The range of valid priority numbers is from SCHED_PRIORITY_MIN * through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -995,11 +995,11 @@ int nxsched_setparam(pid_t pid, FAR const struct sched_param *param); * use by application logic. Applications should use the standard * sched_getscheduler(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to query. If pid is zero, the * calling task is queried. * - * Return Value: + * Returned Value: * On success, sched_getscheduler() returns the policy for the task * (either SCHED_FIFO or SCHED_RR). On error, a negated errno value * returned: @@ -1100,12 +1100,12 @@ int nxsched_getaffinity(pid_t pid, size_t cpusetsize, FAR cpu_set_t *mask); * is not intended for use by application logic. Applications should * use the standard sched_setparam(). * - * Inputs: + * Input Parameters: * pid - The ID of thread whose affinity set will be modified. * cpusetsize - Size of mask. MUST be sizeofcpu_set_t(). * mask - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * Zero (OK) if successful. Otherwise, a negated errno value is returned: * * ESRCH The task whose ID is pid could not be found. diff --git a/include/nuttx/semaphore.h b/include/nuttx/semaphore.h index 6e525f6e1c..850e3c7718 100644 --- a/include/nuttx/semaphore.h +++ b/include/nuttx/semaphore.h @@ -159,7 +159,7 @@ extern "C" * pshared - Process sharing (not used) * value - Semaphore initialization value * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -185,7 +185,7 @@ int nxsem_init(FAR sem_t *sem, int pshared, unsigned int value); * Parameters: * sem - Semaphore to be destroyed. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -211,7 +211,7 @@ int nxsem_destroy (FAR sem_t *sem); * Parameters: * sem - Semaphore descriptor. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -235,7 +235,7 @@ int nxsem_wait(FAR sem_t *sem); * Parameters: * sem - the semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -276,7 +276,7 @@ int nxsem_trywait(FAR sem_t *sem); * sem - Semaphore object * abstime - The absolute time to wait until a timeout is declared. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -313,7 +313,7 @@ int nxsem_timedwait(FAR sem_t *sem, FAR const struct timespec *abstime); * posted. If ticks is zero, then this function is equivalent * to sem_trywait(). * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -342,7 +342,7 @@ int nxsem_tickwait(FAR sem_t *sem, systime_t start, uint32_t delay); * Parameters: * sem - Semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -373,7 +373,7 @@ int nxsem_post(FAR sem_t *sem); * sem - Semaphore descriptor * sval - Buffer by which the value is returned * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -395,7 +395,7 @@ int nxsem_getvalue(FAR sem_t *sem, FAR int *sval); * sem - Semaphore descriptor to be reset * count - The requested semaphore count * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -416,7 +416,7 @@ int nxsem_reset(FAR sem_t *sem, int16_t count); * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -437,7 +437,7 @@ int nxsem_reset(FAR sem_t *sem, int16_t count); * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. @@ -476,7 +476,7 @@ int sem_getprotocol(FAR sem_t *sem, FAR int *protocol); * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -515,7 +515,7 @@ int nxsem_setprotocol(FAR sem_t *sem, int protocol); * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/include/nuttx/signal.h b/include/nuttx/signal.h index 0c9e410712..51a5dbe0e5 100644 --- a/include/nuttx/signal.h +++ b/include/nuttx/signal.h @@ -127,7 +127,7 @@ struct timespec; /* Forward reference */ * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -160,7 +160,7 @@ int nxsig_procmask(int how, FAR const sigset_t *set, FAR sigset_t *oset); * signo - Signal number * value - Value to pass to task with signal * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -232,7 +232,7 @@ int nxsig_kill(pid_t pid, int signo); * set - The pending signal set * info - The returned value * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -270,7 +270,7 @@ int nxsig_kill(pid_t pid, int signo); * info - The returned value (may be NULL). * timeout - The amount of time to wait (may be NULL) * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/include/nuttx/streams.h b/include/nuttx/streams.h index ccb7054f7f..d615c85609 100644 --- a/include/nuttx/streams.h +++ b/include/nuttx/streams.h @@ -230,7 +230,7 @@ extern "C" * Seekable versions are defined in lib/stdio/lib_memsistream.c and * lib/stdio/lib_memsostream.c. * - * Input parameters: + * Input Parameters: * memstream - User allocated, uninitialized instance of struct * lib_meminstream_s to be initialized. * memstream - User allocated, uninitialized instance of struct @@ -259,7 +259,7 @@ void lib_memsostream(FAR struct lib_memsostream_s *outstream, * Initializes a stream for use with a FILE instance. * Defined in lib/stdio/lib_stdinstream.c and lib/stdio/lib_stdoutstream.c * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_stdinstream_s to be initialized. * outstream - User allocated, uninitialized instance of struct @@ -291,7 +291,7 @@ void lib_stdsostream(FAR struct lib_stdsostream_s *outstream, * Seekable versions are defined in lib/stdio/lib_rawsistream.c and * lib/stdio/lib_rawsostream.c * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_rawinstream_s to be initialized. * outstream - User allocated, uninitialized instance of struct @@ -316,7 +316,7 @@ void lib_rawsostream(FAR struct lib_rawsostream_s *outstream, int fd); * Initializes a stream for use with low-level, architecture-specific output. * Defined in ib/stdio/lib_lowoutstream.c * - * Input parameters: + * Input Parameters: * lowoutstream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -342,7 +342,7 @@ void lib_lowoutstream(FAR struct lib_outstream_s *lowoutstream); * o The stream created by lib_nulloutstream will write all data to the * bit-bucket. Defined in lib/stdio/lib_nulloutstream.c * - * Input parameters: + * Input Parameters: * zeroinstream - User allocated, uninitialized instance of struct * lib_instream_s to be initialized. * nullinstream - User allocated, uninitialized instance of struct @@ -366,7 +366,7 @@ void lib_nulloutstream(FAR struct lib_outstream_s *nulloutstream); * Initializes a stream for use with the configured syslog interface. * Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -383,7 +383,7 @@ void syslogstream_create(FAR struct lib_syslogstream_s *stream); * Description: * Free resources held by the syslog stream. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -405,7 +405,7 @@ void syslogstream_destroy(FAR struct lib_syslogstream_s *stream); * Initializes a stream for use with the configured emergency syslog * interface. Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -423,7 +423,7 @@ void emergstream(FAR struct lib_outstream_s *stream); * lib_noflush() provides a common, dummy flush method for output streams * that are not flushable. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ @@ -438,7 +438,7 @@ int lib_noflush(FAR struct lib_outstream_s *stream); * streams that are not flushable. * is selected. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/include/nuttx/syslog/syslog.h b/include/nuttx/syslog/syslog.h index bce437d7a7..1ea41be2ef 100644 --- a/include/nuttx/syslog/syslog.h +++ b/include/nuttx/syslog/syslog.h @@ -149,7 +149,7 @@ extern "C" * Configure the SYSLOGging function to use the provided channel to * generate SYSLOG output. * - * Input buffer: + * Input Parameters: * channel - Provides the interface to the channel to be used. * * Returned Value: diff --git a/include/nuttx/time.h b/include/nuttx/time.h index 2a6c596978..ee4705ba30 100644 --- a/include/nuttx/time.h +++ b/include/nuttx/time.h @@ -111,7 +111,7 @@ int clock_daysbeforemonth(int month, bool leapyear); * month - The month of the year 1 - 12 * year - the year including the 1900 * - * Returned value: + * Returned Value: * Zero based day of the week 0-6, 0 = Sunday, 1 = Monday... 6 = Saturday * ****************************************************************************/ diff --git a/include/nuttx/timers/timer.h b/include/nuttx/timers/timer.h index ab78f5ea97..db59e81819 100644 --- a/include/nuttx/timers/timer.h +++ b/include/nuttx/timers/timer.h @@ -225,7 +225,7 @@ extern "C" * Rather it is called indirectly through the architecture-specific * initialization. * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all timer * drivers as "/dev/timer0", "/dev/timer1", etc. where the driver @@ -250,7 +250,7 @@ FAR void *timer_register(FAR const char *path, * This function can be called to disable and unregister the timer * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * * Returned Value: @@ -272,7 +272,7 @@ void timer_unregister(FAR void *handle); * to handle timer expirations. This is a strictly OS internal interface * and may NOT be used by appliction code. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * callback - The new timer interrupt callback * arg - Argument provided when the callback is called. diff --git a/include/nuttx/timers/watchdog.h b/include/nuttx/timers/watchdog.h index 9c7d9001fa..4759556e81 100644 --- a/include/nuttx/timers/watchdog.h +++ b/include/nuttx/timers/watchdog.h @@ -217,7 +217,7 @@ extern "C" * NOTE: This function would not be called by application code. Rather it is * called indirectly through the architecture-specific interfaces. * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all watchdog * drivers as "/dev/watchdog0", "/dev/watchdog1", etc. where the driver @@ -242,7 +242,7 @@ FAR void *watchdog_register(FAR const char *path, * This function can be called to disable and unregister the watchdog * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by watchdog_register() * * Returned Value: diff --git a/include/nuttx/usb/cdcacm.h b/include/nuttx/usb/cdcacm.h index d490adc098..24109a98a0 100644 --- a/include/nuttx/usb/cdcacm.h +++ b/include/nuttx/usb/cdcacm.h @@ -336,7 +336,7 @@ typedef FAR void (*cdcacm_callback_t)(enum cdcacm_event_e event); * Register USB serial port (and USB serial console if so configured) and * return the class object. * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * classdev - The location to return the CDC serial class' device @@ -360,7 +360,7 @@ int cdcacm_classobject(int minor, FAR struct usbdev_devinfo_s *devinfo, * Description: * Register USB serial port (and USB serial console if so configured). * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * handle - An optional opaque reference to the CDC/ACM class object that diff --git a/include/nuttx/usb/composite.h b/include/nuttx/usb/composite.h index 7d5f90c01d..38d0122fa4 100644 --- a/include/nuttx/usb/composite.h +++ b/include/nuttx/usb/composite.h @@ -88,7 +88,7 @@ extern "C" * board-specific implementations in order to obtain the class objects for * each of the members of the composite. * - * Input Parameter: + * Input Parameters: * None * * Returned Value: diff --git a/include/nuttx/usb/hid_parser.h b/include/nuttx/usb/hid_parser.h index 809a8fb0ca..08fd4b053c 100644 --- a/include/nuttx/usb/hid_parser.h +++ b/include/nuttx/usb/hid_parser.h @@ -227,7 +227,7 @@ struct hid_rptinfo_s * Input Parameters: * item Pointer to the current report item for user checking. * - * Returned value: + * Returned Value: * Boolean true if the item should be stored into the struct hid_rptinfo_s * structure, false if it should be ignored. */ @@ -283,7 +283,7 @@ int hid_parsereport(FAR const uint8_t *report, int rptlen, * report. If the given item does not exist in the report, the function * does not modify the report item's data. * - * Input Parameters + * Input Parameters: * report Buffer containing an IN or FEATURE report from an attached * device. * item Pointer to the report item of interest in a struct hid_rptinfo_s @@ -330,7 +330,7 @@ void hid_putitem(FAR uint8_t *report, FAR struct hid_rptitem_s *item); * Description: * Retrieves the size of a given HID report in bytes from it's Report ID. * - * InputParameters: + * Input Parameters: * rptinfo Pointer to a struct hid_rptinfo_s instance containing the parser * output. * id Report ID of the report whose size is to be retrieved. diff --git a/include/nuttx/usb/usbhost.h b/include/nuttx/usb/usbhost.h index 7f95b1d5b3..9dc98450da 100644 --- a/include/nuttx/usb/usbhost.h +++ b/include/nuttx/usb/usbhost.h @@ -91,7 +91,7 @@ * id - In the case where the device supports multiple base classes, subclasses, or * protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate with the * USB host class. NULL is returned on failure; this function will fail only if @@ -121,7 +121,7 @@ * configdesc - A pointer to a uint8_t buffer container the configuration descriptor. * desclen - The length in bytes of the configuration descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -152,7 +152,7 @@ * Input Parameters: * devclass - The USB host class entry previously obtained from a call to create(). * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -175,7 +175,7 @@ * hport - The location to return the hub port descriptor that detected the * connection related event. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success when a device in connected or * disconnected. This function will not return until either (1) a device is * connected or disconnect to/from any hub port or until (2) some failure @@ -209,7 +209,7 @@ * hport - The descriptor of the hub port that has the newly connected * device. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -238,7 +238,7 @@ * mps (maxpacketsize) - The maximum number of bytes that can be sent to or * received from the endpoint in a single data packet * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -262,7 +262,7 @@ * devinfo - A pointer to memory provided by the caller in which to return the * device information. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -286,7 +286,7 @@ * ep - A memory location provided by the caller in which to receive the * allocated endpoint descriptor. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -308,7 +308,7 @@ * the class create() method. * ep - The endpoint to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -341,7 +341,7 @@ * maxlen - The address of a memory location provided by the caller in which to * return the maximum size of the allocated buffer memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -366,7 +366,7 @@ * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -395,7 +395,7 @@ * return the allocated buffer memory address. * buflen - The size of the buffer required. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -420,7 +420,7 @@ * the class create() method. * buffer - The address of the allocated buffer memory to be freed. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -456,7 +456,7 @@ * NOTE: On an IN transaction, req and buffer may refer to the same allocated * memory. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * @@ -489,7 +489,7 @@ * (IN endpoint). buffer must have been allocated using DRVR_ALLOC * buflen - The length of the data to be sent or received. * - * Returned Values: + * Returned Value: * On success, a non-negative value is returned that indicates the number * of bytes successfully transferred. On a failure, a negated errno value is * returned that indicates the nature of the failure: @@ -534,7 +534,7 @@ * arg - The arbitrary parameter that will be passed to the callback function * when the transfer completes. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -561,7 +561,7 @@ * ep - The IN or OUT endpoint descriptor for the device endpoint on which an * asynchronous transfer should be transferred. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -584,7 +584,7 @@ * related event * connected - True: device connected; false: device disconnected * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -611,7 +611,7 @@ * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -949,7 +949,7 @@ extern "C" * devclass - An write-able instance of struct usbhost_registry_s that will be * maintained in a registry. * - * Returned Values: + * Returned Value: * On success, this function will return zero (OK). Otherwise, a negated errno * value is returned. * @@ -969,7 +969,7 @@ int usbhost_registerclass(struct usbhost_registry_s *devclass); * Input Parameters: * id - Identifies the USB device class that has connect to the USB host. * - * Returned Values: + * Returned Value: * On success this function will return a non-NULL instance of struct * usbhost_registry_s. NULL will be returned on failure. This function can only * fail if (1) id is NULL, or (2) no USB host class is registered that matches the @@ -991,7 +991,7 @@ const struct usbhost_registry_s *usbhost_findclass(const struct usbhost_id_s *id * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1012,7 +1012,7 @@ int usbhost_hub_initialize(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1054,7 +1054,7 @@ int usbhost_cdcacm_initialize(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1075,7 +1075,7 @@ int usbhost_kbdinit(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1096,7 +1096,7 @@ int usbhost_mouse_init(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1116,7 +1116,7 @@ int usbhost_xboxcontroller_init(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1147,7 +1147,7 @@ int usbhost_wlaninit(void); * and bound to the hub, the allocated class instance is returned into * this caller-provided memory location. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure * diff --git a/include/nuttx/usb/usbmonitor.h b/include/nuttx/usb/usbmonitor.h index d5be243e05..fe360c0cc2 100644 --- a/include/nuttx/usb/usbmonitor.h +++ b/include/nuttx/usb/usbmonitor.h @@ -72,7 +72,7 @@ extern "C" * Input Parameters: * None * - * Returned values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * diff --git a/include/nuttx/userspace.h b/include/nuttx/userspace.h index 6e1afc2aa1..b7bb1cf65c 100644 --- a/include/nuttx/userspace.h +++ b/include/nuttx/userspace.h @@ -157,11 +157,11 @@ extern "C" * This function is the user-space, task startup function. It is called * from up_task_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the task entry point * argc and argv - Standard arguments for the task entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ @@ -177,11 +177,11 @@ void task_startup(main_t entrypt, int argc, FAR char *argv[]) noreturn_function; * This function is the user-space, pthread startup function. It is called * from up_pthread_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the pthread entry point * arg - Standard argument for the pthread entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ diff --git a/include/nuttx/video/fb.h b/include/nuttx/video/fb.h index 4d6c7f1d49..83857ebc83 100644 --- a/include/nuttx/video/fb.h +++ b/include/nuttx/video/fb.h @@ -410,7 +410,7 @@ extern "C" * Description: * Initialize the framebuffer video hardware associated with the display. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -429,7 +429,7 @@ int up_fbinitialize(int display); * Return a a reference to the framebuffer object for the specified video * plane of the specified plane. Many OSDs support multiple planes of video. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * vplane - Identifies the plane being queried. diff --git a/include/nuttx/wdog.h b/include/nuttx/wdog.h index 720d2b961c..a57d50e6ae 100644 --- a/include/nuttx/wdog.h +++ b/include/nuttx/wdog.h @@ -176,7 +176,7 @@ extern "C" * Parameters: * None * - * Return Value: + * Returned Value: * Pointer to watchdog (i.e., the watchdog ID), or NULL if insufficient * watchdogs are available. * @@ -196,7 +196,7 @@ WDOG_ID wd_create(void); * wdog - The watchdog ID to delete. This is actually a pointer to a * watchdog structure. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * @@ -231,7 +231,7 @@ int wd_delete(WDOG_ID wdog); * wdentry - function to call on timeout * parm1..4 - parameters to pass to wdentry * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * @@ -253,7 +253,7 @@ int wd_start(WDOG_ID wdog, int32_t delay, wdentry_t wdentry, int argc, ...); * Parameters: * wdog - ID of the watchdog to cancel. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned to * indicate the nature of any failure. * @@ -271,7 +271,7 @@ int wd_cancel(WDOG_ID wdog); * Parameters: * wdog - watchdog ID * - * Return Value: + * Returned Value: * The time in system ticks remaining until the watchdog time expires. * Zero means either that wdog is not valid or that the wdog has already * expired. diff --git a/include/nuttx/wireless/cc3000/evnt_handler.h b/include/nuttx/wireless/cc3000/evnt_handler.h index fe5f4ecdad..a720a04de9 100644 --- a/include/nuttx/wireless/cc3000/evnt_handler.h +++ b/include/nuttx/wireless/cc3000/evnt_handler.h @@ -131,7 +131,7 @@ extern unsigned long socket_active_status; * from from information (in case of data received) * fromlen from information length (in case of data received) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -147,7 +147,7 @@ uint8_t *hci_event_handler(void *pRetParams, uint8_t *from, uint8_t *fromlen); * Input Parameters: * event_hdr event header * - * Returned Values: + * Returned Value: * 1 if event supported and handled; 0 if event is not supported * ****************************************************************************/ @@ -164,7 +164,7 @@ long hci_unsol_event_handler(char *event_hdr); * Input Parameters: * None * - * Returned Values: + * Returned Value: * ESUCCESS if successful, EFAIL if an error occurred * ****************************************************************************/ diff --git a/include/nuttx/wireless/cc3000/wlan.h b/include/nuttx/wireless/cc3000/wlan.h index b0a07c67d8..70f2601ab3 100644 --- a/include/nuttx/wireless/cc3000/wlan.h +++ b/include/nuttx/wireless/cc3000/wlan.h @@ -499,7 +499,7 @@ long wlan_smart_config_set_prefix(char* cNewPrefix); * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ @@ -516,7 +516,7 @@ signed long aes_read_key(FAR uint8_t *key); * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ diff --git a/include/nuttx/wireless/ieee802154/ieee802154_mac.h b/include/nuttx/wireless/ieee802154/ieee802154_mac.h index 1064763848..398134b696 100644 --- a/include/nuttx/wireless/ieee802154/ieee802154_mac.h +++ b/include/nuttx/wireless/ieee802154/ieee802154_mac.h @@ -1783,7 +1783,7 @@ MACHANDLE mac802154_create(FAR struct ieee802154_radio_s *radiodev); * minor - The device minor number. The IEEE802.15.4 MAC character device * will be registered as /dev/ieeeN where N is the minor number * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * @@ -1801,7 +1801,7 @@ int mac802154dev_register(MACHANDLE mac, int minor); * Input Parameters: * mac - Pointer to the mac layer struct to be registered. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * @@ -1819,10 +1819,10 @@ int mac802154netdev_register(MACHANDLE mac); * be called early in the initialization sequence before any radios * begin operation. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -1845,10 +1845,10 @@ void ieee802154_primitivepool_initialize(void); * list. If that the list is empty, then the primitive structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated primitive structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -1865,10 +1865,10 @@ FAR struct ieee802154_primitive_s *ieee802154_primitive_allocate(void); * the free pool if it was a pre-allocated primitive structure. If the primitive * was allocated dynamically it will be deallocated. * - * Inputs: + * Input Parameters: * prim - primitive structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/wireless/nrf24l01.h b/include/nuttx/wireless/nrf24l01.h index 123eb93503..7cff670dc1 100644 --- a/include/nuttx/wireless/nrf24l01.h +++ b/include/nuttx/wireless/nrf24l01.h @@ -196,7 +196,7 @@ struct nrf24l01_config_s /************************************************************************************ * Register the nRF24L01+ device. * - * Input Parmeters: + * Input Parameters: * spi - SPI Device structure * cfg Board specific configuration info * @@ -214,7 +214,7 @@ int nrf24l01_register(FAR struct spi_dev_s *spi, FAR struct nrf24l01_config_s *c /************************************************************************************ * Initialize the nRF24L01+ chip to a default initial state. * - * Input Parmeters: + * Input Parameters: * dev Pointer to a registered nRF24L01 device structure * ************************************************************************************/ @@ -224,7 +224,7 @@ int nrf24l01_init(FAR struct nrf24l01_dev_s *dev); /************************************************************************************ * Set the default TX address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * addr TX address (LSByte first) * @@ -238,7 +238,7 @@ int nrf24l01_settxaddr(FAR struct nrf24l01_dev_s *dev, FAR const uint8_t *addr); /************************************************************************************ * Get the default TX address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * addr TX address (LSByte first) * @@ -252,7 +252,7 @@ int nrf24l01_gettxaddr(FAR struct nrf24l01_dev_s *dev, FAR uint8_t *addr); /************************************************************************************ * Configure auto-retransmit * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * retrdelay Auto-retransmit delay * retrcount Auto-retransmit count (0 - 15) @@ -268,7 +268,7 @@ int nrf24l01_setretransmit(FAR struct nrf24l01_dev_s *dev, /************************************************************************************ * Configure a RX pipe. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * pipeno Pipe number to configure * pipecfg Pointer to configuration data @@ -284,7 +284,7 @@ int nrf24l01_setpipeconfig(FAR struct nrf24l01_dev_s *dev, unsigned int pipeno, /************************************************************************************ * Get pipe configuration. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * pipeno Pipe number to configure * pipecfg Pointer to configuration data used to store the config @@ -300,7 +300,7 @@ int nrf24l01_getpipeconfig(FAR struct nrf24l01_dev_s *dev, unsigned int pipeno, /************************************************************************************ * Enable a RX pipe. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * pipeno Pipe number * enable true to enable the pipe, false to disable it @@ -316,7 +316,7 @@ int nrf24l01_enablepipe(FAR struct nrf24l01_dev_s *dev, unsigned int pipeno, /************************************************************************************ * Configure RF. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * datarate Datarate * outpower Output power @@ -334,7 +334,7 @@ int nrf24l01_setuprf(FAR struct nrf24l01_dev_s *dev, nrf24l01_datarate_t datarat * * Note that hardware supports only -18, -12, -6 and 0 dBm values. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * outpower Output power (in dBm). * @@ -350,7 +350,7 @@ int nrf24l01_settxpower(FAR struct nrf24l01_dev_s *dev, int outpower); * * Note that hardware supports only -18, -12, -6 and 0 dBm values. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: @@ -363,7 +363,7 @@ int nrf24l01_gettxpower(FAR struct nrf24l01_dev_s *dev); /************************************************************************************ * Set transmission data rate * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: @@ -377,7 +377,7 @@ int nrf24l01_setdatarate(FAR struct nrf24l01_dev_s *dev, /************************************************************************************ * Set radio frequency. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * freq New frequency value (in Mhz: 2400 to 2525) * @@ -391,7 +391,7 @@ int nrf24l01_setradiofreq(FAR struct nrf24l01_dev_s *dev, uint32_t freq); /************************************************************************************ * Get current radio frequency. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: @@ -404,7 +404,7 @@ uint32_t nrf24l01_getradiofreq(FAR struct nrf24l01_dev_s *dev); /************************************************************************************ * Configure address length. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * width Address width to use (3-5) * @@ -418,7 +418,7 @@ int nrf24l01_setaddrwidth(FAR struct nrf24l01_dev_s *dev, uint32_t width); /************************************************************************************ * Change the current lifecycle state of the nRF24L01+ chip. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * state New state to put the nRF24L01 module into * @@ -429,7 +429,7 @@ int nrf24l01_changestate(FAR struct nrf24l01_dev_s *dev, nrf24l01_state_t state) /************************************************************************************ * Send data to the default address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * data Pointer on the data buffer * datalen Length of the buffer (in bytes) @@ -444,7 +444,7 @@ int nrf24l01_send(FAR struct nrf24l01_dev_s *dev, FAR const uint8_t *data, /************************************************************************************ * Send data to the specified address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * data Pointer on the data buffer * datalen Length of the buffer (in bytes) @@ -461,7 +461,7 @@ int nrf24l01_sendto(FAR struct nrf24l01_dev_s *dev, FAR const uint8_t *data, * Get the retransmits count of the last transmission. * This value is meaningful only if auto-acknowledge is enabled. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: diff --git a/include/nuttx/wireless/pktradio.h b/include/nuttx/wireless/pktradio.h index d4f405b414..829de17909 100644 --- a/include/nuttx/wireless/pktradio.h +++ b/include/nuttx/wireless/pktradio.h @@ -181,10 +181,10 @@ struct pktradio_metadata_s * called. Therefore, it may be called during packet radio driver * initialization, even if there are multiple packet radio drivers. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -202,10 +202,10 @@ void pktradio_metadata_initialize(void); * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated metadata structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -223,10 +223,10 @@ FAR struct pktradio_metadata_s *pktradio_metadata_allocate(void); * structure. If the metadata structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * metadata - metadata structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/wqueue.h b/include/nuttx/wqueue.h index b5ee23e022..8fe684a9a5 100644 --- a/include/nuttx/wqueue.h +++ b/include/nuttx/wqueue.h @@ -318,7 +318,7 @@ extern "C" * Description: * Start the user mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -345,7 +345,7 @@ int work_usrstart(void); * previous work as been performed and removed from the queue, then any * pending work will be canceled and lost. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked @@ -371,7 +371,7 @@ int work_queue(int qid, FAR struct work_s *work, worker_t worker, * After work has been cancelled, it may be re-queue by calling work_queue() * again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The previously queue work structure to cancel * @@ -393,7 +393,7 @@ int work_cancel(int qid, FAR struct work_s *work); * is used internally by the work logic but could also be used by the * user to force an immediate re-assessment of pending work. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * * Returned Value: @@ -409,7 +409,7 @@ int work_signal(int qid); * Description: * Check if the work structure is available. * - * Input parameters: + * Input Parameters: * work - The work queue structure to check. * None * @@ -431,7 +431,7 @@ int work_signal(int qid); * Parameters: * reqprio - Requested minimum worker thread priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -453,7 +453,7 @@ void lpwork_boostpriority(uint8_t reqprio); * reqprio - Previously requested minimum worker thread priority to be * "unboosted" * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/sys/ioctl.h b/include/sys/ioctl.h index cc697c040a..d8da7a121b 100644 --- a/include/sys/ioctl.h +++ b/include/sys/ioctl.h @@ -110,7 +110,7 @@ extern "C" * arg The argument of the ioctl cmd, OR * ... A third argument of type unsigned long is still expected. * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * -1 on failure with errno set properly: * diff --git a/include/sys/sendfile.h b/include/sys/sendfile.h index 22cb8271ef..c414532671 100644 --- a/include/sys/sendfile.h +++ b/include/sys/sendfile.h @@ -87,7 +87,7 @@ extern "C" * different semantics and prototypes. sendfile() should not be used * in portable programs. * - * Input Parmeters: + * Input Parameters: * infd - A file (or socket) descriptor opened for reading * outfd - A descriptor opened for writing. * offset - If 'offset' is not NULL, then it points to a variable diff --git a/include/sys/time.h b/include/sys/time.h index ece75bc10f..36ba9822be 100644 --- a/include/sys/time.h +++ b/include/sys/time.h @@ -160,7 +160,7 @@ extern "C" * tv - The location to return the current time * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * @@ -183,7 +183,7 @@ int gettimeofday(FAR struct timeval *tv, FAR struct timezone *tz); * tv - The net to time to be set * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * diff --git a/libc/dirent/lib_readdirr.c b/libc/dirent/lib_readdirr.c index ffbe91056a..d383651c63 100644 --- a/libc/dirent/lib_readdirr.c +++ b/libc/dirent/lib_readdirr.c @@ -62,7 +62,7 @@ * directory stream pointed to by dir. It returns NULL on * reaching the end-of-file or if an error occurred. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * entry -- The storage pointed to by entry must be large @@ -73,7 +73,7 @@ * argument entry. Upon reaching the end of the directory * stream, this pointer shall have the value NULL. * - * Return: + * Returned Value: * If successful, the readdir_r() function return s zero; * otherwise, an error number is returned to indicate the * error. diff --git a/libc/dirent/lib_telldir.c b/libc/dirent/lib_telldir.c index f77a4a1c21..af12ff902b 100644 --- a/libc/dirent/lib_telldir.c +++ b/libc/dirent/lib_telldir.c @@ -61,11 +61,11 @@ * The telldir() function returns the current location * associated with the directory stream dirp. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * - * Return: + * Returned Value: * On success, the telldir() function returns the current * location in the directory stream. On error, -1 is * returned, and errno is set appropriately. diff --git a/libc/hex2bin/lib_fhex2mem.c b/libc/hex2bin/lib_fhex2mem.c index 1967dd1ade..b6bc91aa9f 100644 --- a/libc/hex2bin/lib_fhex2mem.c +++ b/libc/hex2bin/lib_fhex2mem.c @@ -69,7 +69,7 @@ * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * diff --git a/libc/hex2bin/lib_hex2bin.c b/libc/hex2bin/lib_hex2bin.c index 2dc5d32d97..3815eb0627 100644 --- a/libc/hex2bin/lib_hex2bin.c +++ b/libc/hex2bin/lib_hex2bin.c @@ -403,7 +403,7 @@ static inline void writedata(FAR struct lib_sostream_s *outstream, * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * diff --git a/libc/hex2bin/lib_hex2mem.c b/libc/hex2bin/lib_hex2mem.c index 12c284cf54..24b25b011d 100644 --- a/libc/hex2bin/lib_hex2mem.c +++ b/libc/hex2bin/lib_hex2mem.c @@ -69,7 +69,7 @@ * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * diff --git a/libc/inttypes/lib_strtoimax.c b/libc/inttypes/lib_strtoimax.c index 0acaca3155..d4eff8232f 100644 --- a/libc/inttypes/lib_strtoimax.c +++ b/libc/inttypes/lib_strtoimax.c @@ -64,7 +64,7 @@ * nptr to a intmax_t integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/inttypes/lib_strtoumax.c b/libc/inttypes/lib_strtoumax.c index 9440908c93..90cf6005ff 100644 --- a/libc/inttypes/lib_strtoumax.c +++ b/libc/inttypes/lib_strtoumax.c @@ -57,7 +57,7 @@ * nptr to a long unsigned integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/libgen/lib_basename.c b/libc/libgen/lib_basename.c index 18b2168fad..c837938209 100644 --- a/libc/libgen/lib_basename.c +++ b/libc/libgen/lib_basename.c @@ -73,7 +73,7 @@ static char g_retchar[2]; * Parameter: * path The null-terminated string referring to the path to be decomposed * - * Return: + * Returned Value: * On success the filename component of the path is returned. * ****************************************************************************/ diff --git a/libc/libgen/lib_dirname.c b/libc/libgen/lib_dirname.c index 0acd03c71f..ce260e2a4f 100644 --- a/libc/libgen/lib_dirname.c +++ b/libc/libgen/lib_dirname.c @@ -73,7 +73,7 @@ static char g_retchar[2]; * Parameter: * path The null-terminated string referring to the path to be decomposed * - * Return: + * Returned Value: * On success the directory component of the path is returned. * ****************************************************************************/ diff --git a/libc/misc/lib_ioctl.c b/libc/misc/lib_ioctl.c index 0e7ca015d3..f9acafba8a 100644 --- a/libc/misc/lib_ioctl.c +++ b/libc/misc/lib_ioctl.c @@ -65,7 +65,7 @@ * req The ioctl command * ... A third argument of type unsigned long is expected * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * -1 on failure with errno set properly: * diff --git a/libc/misc/lib_mkfifo.c b/libc/misc/lib_mkfifo.c index deb919aad1..4bcd412096 100644 --- a/libc/misc/lib_mkfifo.c +++ b/libc/misc/lib_mkfifo.c @@ -68,12 +68,12 @@ * If all threads that write to the FIFO have closed, subsequent calls to * read() on the FIFO will return 0 (end-of-file). * - * Inputs: + * Input Parameters: * pathname - The full path to the FIFO instance to attach to or to create * (if not already created). * mode - Ignored for now * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/libc/misc/lib_sendfile.c b/libc/misc/lib_sendfile.c index be6fa94c01..e3eaf54838 100644 --- a/libc/misc/lib_sendfile.c +++ b/libc/misc/lib_sendfile.c @@ -72,7 +72,7 @@ * different semantics and prototypes. sendfile() should not be used * in portable programs. * - * Input Parmeters: + * Input Parameters: * infd - A file (or socket) descriptor opened for reading * outfd - A descriptor opened for writing. * offset - If 'offset' is not NULL, then it points to a variable diff --git a/libc/net/lib_shutdown.c b/libc/net/lib_shutdown.c index a2c733dec2..b6cdaecdea 100644 --- a/libc/net/lib_shutdown.c +++ b/libc/net/lib_shutdown.c @@ -41,10 +41,6 @@ #ifdef CONFIG_NET -/**************************************************************************** - * Pre-processor Definitions - ****************************************************************************/ - /**************************************************************************** * Public Functions ****************************************************************************/ @@ -60,7 +56,7 @@ * The shutdown() function disables subsequent send and/or receive * operations on a socket, depending on the value of the how argument. * - * Input Paramteers: + * Input Parameters: * sockfd - Specifies the file descriptor of the socket. * how - Specifies the type of shutdown. The values are as follows: * diff --git a/libc/pthread/pthread_attr_destroy.c b/libc/pthread/pthread_attr_destroy.c index 16dd2cc50e..d91530841b 100644 --- a/libc/pthread/pthread_attr_destroy.c +++ b/libc/pthread/pthread_attr_destroy.c @@ -57,7 +57,7 @@ * Parameters: * attr * - * Return Value: + * Returned Value: * 0 meaning success * * Assumptions: diff --git a/libc/pthread/pthread_attr_getaffinity.c b/libc/pthread/pthread_attr_getaffinity.c index 1371ceff37..e74dafc553 100644 --- a/libc/pthread/pthread_attr_getaffinity.c +++ b/libc/pthread/pthread_attr_getaffinity.c @@ -56,7 +56,7 @@ * attr * cpuset * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getinheritsched.c b/libc/pthread/pthread_attr_getinheritsched.c index d8e6515fa8..546e52a652 100644 --- a/libc/pthread/pthread_attr_getinheritsched.c +++ b/libc/pthread/pthread_attr_getinheritsched.c @@ -60,7 +60,7 @@ * attr * inheritsched * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getschedparam.c b/libc/pthread/pthread_attr_getschedparam.c index 3de2a3b7a2..408fa93894 100644 --- a/libc/pthread/pthread_attr_getschedparam.c +++ b/libc/pthread/pthread_attr_getschedparam.c @@ -58,7 +58,7 @@ * attr * param * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getschedpolicy.c b/libc/pthread/pthread_attr_getschedpolicy.c index ca819b8ffa..f3c06455b4 100644 --- a/libc/pthread/pthread_attr_getschedpolicy.c +++ b/libc/pthread/pthread_attr_getschedpolicy.c @@ -57,7 +57,7 @@ * attr * policy * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getstacksize.c b/libc/pthread/pthread_attr_getstacksize.c index 858cf88c9d..ba64db6578 100644 --- a/libc/pthread/pthread_attr_getstacksize.c +++ b/libc/pthread/pthread_attr_getstacksize.c @@ -56,7 +56,7 @@ * attr * stacksize * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_init.c b/libc/pthread/pthread_attr_init.c index 256be4b235..60af413b87 100644 --- a/libc/pthread/pthread_attr_init.c +++ b/libc/pthread/pthread_attr_init.c @@ -76,7 +76,7 @@ const pthread_attr_t g_default_pthread_attr = PTHREAD_ATTR_INITIALIZER; * Parameters: * attr * - * Return Value: + * Returned Value: * 0 on success, otherwise an error number * * Assumptions: diff --git a/libc/pthread/pthread_attr_setaffinity.c b/libc/pthread/pthread_attr_setaffinity.c index 83f8e337cf..ce2029f609 100644 --- a/libc/pthread/pthread_attr_setaffinity.c +++ b/libc/pthread/pthread_attr_setaffinity.c @@ -57,7 +57,7 @@ * attr * stacksize * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setinheritsched.c b/libc/pthread/pthread_attr_setinheritsched.c index 36b1d1dba1..c202c9dbab 100644 --- a/libc/pthread/pthread_attr_setinheritsched.c +++ b/libc/pthread/pthread_attr_setinheritsched.c @@ -61,7 +61,7 @@ * attr * policy * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setschedparam.c b/libc/pthread/pthread_attr_setschedparam.c index 812ebee859..c6972ced3f 100644 --- a/libc/pthread/pthread_attr_setschedparam.c +++ b/libc/pthread/pthread_attr_setschedparam.c @@ -58,7 +58,7 @@ * attr * param * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setschedpolicy.c b/libc/pthread/pthread_attr_setschedpolicy.c index 9d7ce10fff..724c442e06 100644 --- a/libc/pthread/pthread_attr_setschedpolicy.c +++ b/libc/pthread/pthread_attr_setschedpolicy.c @@ -59,7 +59,7 @@ * attr * policy * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setstacksize.c b/libc/pthread/pthread_attr_setstacksize.c index f69fc7df9c..6a0b8d4aeb 100644 --- a/libc/pthread/pthread_attr_setstacksize.c +++ b/libc/pthread/pthread_attr_setstacksize.c @@ -57,7 +57,7 @@ * attr * stacksize * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_destroy.c b/libc/pthread/pthread_barrierattr_destroy.c index 663f449981..ca7dcd9e64 100644 --- a/libc/pthread/pthread_barrierattr_destroy.c +++ b/libc/pthread/pthread_barrierattr_destroy.c @@ -59,7 +59,7 @@ * Parameters: * attr - barrier attributes to be destroyed. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if attr is invalid. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_getpshared.c b/libc/pthread/pthread_barrierattr_getpshared.c index 3964a801ca..2f4fd22533 100644 --- a/libc/pthread/pthread_barrierattr_getpshared.c +++ b/libc/pthread/pthread_barrierattr_getpshared.c @@ -58,7 +58,7 @@ * attr - barrier attributes to be queried. * pshared - the location to stored the current value of the pshared attribute. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if either attr or pshared is invalid. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_init.c b/libc/pthread/pthread_barrierattr_init.c index e8270f6b98..f2a5527da7 100644 --- a/libc/pthread/pthread_barrierattr_init.c +++ b/libc/pthread/pthread_barrierattr_init.c @@ -58,7 +58,7 @@ * Parameters: * attr - barrier attributes to be initialized. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if attr is invalid. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_setpshared.c b/libc/pthread/pthread_barrierattr_setpshared.c index 76109ac08c..b26ef1746e 100644 --- a/libc/pthread/pthread_barrierattr_setpshared.c +++ b/libc/pthread/pthread_barrierattr_setpshared.c @@ -87,7 +87,7 @@ * attr - barrier attributes to be modified. * pshared - the new value of the pshared attribute. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if either attr is invalid or pshared is not one * of PTHREAD_PROCESS_SHARED or PTHREAD_PROCESS_PRIVATE. * diff --git a/libc/pthread/pthread_barrierdestroy.c b/libc/pthread/pthread_barrierdestroy.c index 3f74e06c49..19a007b02a 100644 --- a/libc/pthread/pthread_barrierdestroy.c +++ b/libc/pthread/pthread_barrierdestroy.c @@ -63,7 +63,7 @@ * Parameters: * barrier - barrier to be destroyed. * - * Return Value: + * Returned Value: * 0 (OK) on success or on of the following error numbers: * * EBUSY The implementation has detected an attempt to destroy a barrier diff --git a/libc/pthread/pthread_barrierinit.c b/libc/pthread/pthread_barrierinit.c index 6f8d427dfe..c9c60cefaa 100644 --- a/libc/pthread/pthread_barrierinit.c +++ b/libc/pthread/pthread_barrierinit.c @@ -69,7 +69,7 @@ * pthread_barrier_wait() before any of them successfully return from * the call. The value specified by count must be greater than zero. * - * Return Value: + * Returned Value: * 0 (OK) on success or on of the following error numbers: * * EAGAIN The system lacks the necessary resources to initialize another diff --git a/libc/pthread/pthread_barrierwait.c b/libc/pthread/pthread_barrierwait.c index 8ba29d1d94..ed51b62c01 100644 --- a/libc/pthread/pthread_barrierwait.c +++ b/libc/pthread/pthread_barrierwait.c @@ -86,7 +86,7 @@ * Parameters: * barrier - the barrier to wait on * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if the barrier is not valid. * * Assumptions: diff --git a/libc/pthread/pthread_condattr_destroy.c b/libc/pthread/pthread_condattr_destroy.c index 12bee245dc..2f97ffbd6f 100644 --- a/libc/pthread/pthread_condattr_destroy.c +++ b/libc/pthread/pthread_condattr_destroy.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_condattr_init.c b/libc/pthread/pthread_condattr_init.c index 8865868b81..9f23736233 100644 --- a/libc/pthread/pthread_condattr_init.c +++ b/libc/pthread/pthread_condattr_init.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_conddestroy.c b/libc/pthread/pthread_conddestroy.c index a691b60d7d..44e6e4cab5 100644 --- a/libc/pthread/pthread_conddestroy.c +++ b/libc/pthread/pthread_conddestroy.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_condinit.c b/libc/pthread/pthread_condinit.c index 81a31ea57f..d19601f196 100644 --- a/libc/pthread/pthread_condinit.c +++ b/libc/pthread/pthread_condinit.c @@ -59,7 +59,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_destroy.c b/libc/pthread/pthread_mutexattr_destroy.c index 01c8a6589a..f8fe9e057e 100644 --- a/libc/pthread/pthread_mutexattr_destroy.c +++ b/libc/pthread/pthread_mutexattr_destroy.c @@ -56,7 +56,7 @@ * Parameters: * attr * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_getprotocol.c b/libc/pthread/pthread_mutexattr_getprotocol.c index 7cc6065d36..b83e289f42 100644 --- a/libc/pthread/pthread_mutexattr_getprotocol.c +++ b/libc/pthread/pthread_mutexattr_getprotocol.c @@ -58,7 +58,7 @@ * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * ****************************************************************************/ diff --git a/libc/pthread/pthread_mutexattr_getpshared.c b/libc/pthread/pthread_mutexattr_getpshared.c index 6d219fb085..ea398bed6c 100644 --- a/libc/pthread/pthread_mutexattr_getpshared.c +++ b/libc/pthread/pthread_mutexattr_getpshared.c @@ -57,7 +57,7 @@ * attr * pshared * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_getrobust.c b/libc/pthread/pthread_mutexattr_getrobust.c index 4db30f6b75..4bf88ff7ea 100644 --- a/libc/pthread/pthread_mutexattr_getrobust.c +++ b/libc/pthread/pthread_mutexattr_getrobust.c @@ -55,7 +55,7 @@ * attr - The mutex attributes to query * robust - Location to return the robustness indication * - * Return Value: + * Returned Value: * 0, if the robustness was successfully return in 'robust', or * EINVAL, if any NULL pointers provided. * diff --git a/libc/pthread/pthread_mutexattr_gettype.c b/libc/pthread/pthread_mutexattr_gettype.c index c45008f8d4..46e7076233 100644 --- a/libc/pthread/pthread_mutexattr_gettype.c +++ b/libc/pthread/pthread_mutexattr_gettype.c @@ -55,7 +55,7 @@ * attr - The mutex attributes to query * type - Location to return the mutex type * - * Return Value: + * Returned Value: * 0, if the mutex type was successfully return in 'type', or * EINVAL, if any NULL pointers provided. * diff --git a/libc/pthread/pthread_mutexattr_init.c b/libc/pthread/pthread_mutexattr_init.c index 6f24188152..c0441c7ed2 100644 --- a/libc/pthread/pthread_mutexattr_init.c +++ b/libc/pthread/pthread_mutexattr_init.c @@ -56,7 +56,7 @@ * Parameters: * attr * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_setprotocol.c b/libc/pthread/pthread_mutexattr_setprotocol.c index e2a8a45ac5..117c626248 100644 --- a/libc/pthread/pthread_mutexattr_setprotocol.c +++ b/libc/pthread/pthread_mutexattr_setprotocol.c @@ -58,7 +58,7 @@ * attr - A pointer to the mutex attributes to be modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * ****************************************************************************/ diff --git a/libc/pthread/pthread_mutexattr_setpshared.c b/libc/pthread/pthread_mutexattr_setpshared.c index 054c4db07e..575e38036e 100644 --- a/libc/pthread/pthread_mutexattr_setpshared.c +++ b/libc/pthread/pthread_mutexattr_setpshared.c @@ -57,7 +57,7 @@ * attr * pshared * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_setrobust.c b/libc/pthread/pthread_mutexattr_setrobust.c index aeb2714e93..6a231bd2ed 100644 --- a/libc/pthread/pthread_mutexattr_setrobust.c +++ b/libc/pthread/pthread_mutexattr_setrobust.c @@ -55,7 +55,7 @@ * attr - The mutex attributes in which to set the mutex type. * robust - The mutex type value to set. * - * Return Value: + * Returned Value: * 0, if the mutex robustness was successfully set in 'attr', or * EINVAL, if 'attr' is NULL or 'robust' unrecognized. * diff --git a/libc/pthread/pthread_mutexattr_settype.c b/libc/pthread/pthread_mutexattr_settype.c index 02e1832cd6..7c501b6221 100644 --- a/libc/pthread/pthread_mutexattr_settype.c +++ b/libc/pthread/pthread_mutexattr_settype.c @@ -55,7 +55,7 @@ * attr - The mutex attributes in which to set the mutex type. * type - The mutex type value to set. * - * Return Value: + * Returned Value: * 0, if the mutex type was successfully set in 'attr', or * EINVAL, if 'attr' is NULL or 'type' unrecognized. * diff --git a/libc/pthread/pthread_once.c b/libc/pthread/pthread_once.c index d73dde966f..2f067decbb 100644 --- a/libc/pthread/pthread_once.c +++ b/libc/pthread/pthread_once.c @@ -67,7 +67,7 @@ * PTHREAD_ONCE_INIT is defined in pthread.h * init_routine - The initialization routine that will be called once. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if either once_control or init_routine are * invalid * diff --git a/libc/pthread/pthread_rwlock_rdlock.c b/libc/pthread/pthread_rwlock_rdlock.c index 4eadfedccb..1b23abcc92 100644 --- a/libc/pthread/pthread_rwlock_rdlock.c +++ b/libc/pthread/pthread_rwlock_rdlock.c @@ -93,7 +93,7 @@ static int tryrdlock(FAR pthread_rwlock_t *rw_lock) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_rwlock_wrlock.c b/libc/pthread/pthread_rwlock_wrlock.c index c9f4f3a7c5..73b1ce2762 100644 --- a/libc/pthread/pthread_rwlock_wrlock.c +++ b/libc/pthread/pthread_rwlock_wrlock.c @@ -73,7 +73,7 @@ static void wrlock_cleanup(FAR void *arg) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_startup.c b/libc/pthread/pthread_startup.c index 3d2b76ce8f..a1f8e64f5e 100644 --- a/libc/pthread/pthread_startup.c +++ b/libc/pthread/pthread_startup.c @@ -82,11 +82,11 @@ * This function is the user-space, pthread startup function. It is called * from up_pthread_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the pthread entry point * arg - Standard argument for the pthread entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ diff --git a/libc/pthread/pthread_yield.c b/libc/pthread/pthread_yield.c index 2af7ea2b93..78ee5a7bb7 100644 --- a/libc/pthread/pthread_yield.c +++ b/libc/pthread/pthread_yield.c @@ -54,7 +54,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/sched/sched_cpucount.c b/libc/sched/sched_cpucount.c index 6bdac11117..5f7f151ec0 100644 --- a/libc/sched/sched_cpucount.c +++ b/libc/sched/sched_cpucount.c @@ -54,10 +54,10 @@ * Return the number of bits set in the 'set'. This could be improved by * using CPU-specific bit counting instructions. * - * Inputs: + * Input Parameters: * set - The set of CPUs to be counted. * - * Return Value: + * Returned Value: * The number of CPUs in 'set' * ****************************************************************************/ diff --git a/libc/sched/sched_getprioritymax.c b/libc/sched/sched_getprioritymax.c index 03660cbb8d..4ca6bf6119 100644 --- a/libc/sched/sched_getprioritymax.c +++ b/libc/sched/sched_getprioritymax.c @@ -54,10 +54,10 @@ * This function returns the value of the highest possible * task priority for a specified scheduling policy. * - * Inputs: + * Input Parameters: * policy - Scheduling policy requested. * - * Return Value: + * Returned Value: * The maximum priority value or -1 (ERROR) * (errno is not set) * diff --git a/libc/sched/sched_getprioritymin.c b/libc/sched/sched_getprioritymin.c index 660677f8ca..4a39350107 100644 --- a/libc/sched/sched_getprioritymin.c +++ b/libc/sched/sched_getprioritymin.c @@ -54,10 +54,10 @@ * This function returns the value of the lowest possible * task priority for a specified scheduling policy. * - * Inputs: + * Input Parameters: * policy - Scheduling policy requested. * - * Return Value: + * Returned Value: * The minimum priority value or -1 (ERROR) * (errno is not set) * diff --git a/libc/sched/task_startup.c b/libc/sched/task_startup.c index c0895a16b8..2d14b47fa1 100644 --- a/libc/sched/task_startup.c +++ b/libc/sched/task_startup.c @@ -57,11 +57,11 @@ * This function is the user-space, task startup function. It is called * from up_task_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the task entry point * argc and argv - Standard arguments for the task entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ diff --git a/libc/semaphore/sem_getprotocol.c b/libc/semaphore/sem_getprotocol.c index 308f1ea520..436113b015 100644 --- a/libc/semaphore/sem_getprotocol.c +++ b/libc/semaphore/sem_getprotocol.c @@ -59,7 +59,7 @@ * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/libc/semaphore/sem_getvalue.c b/libc/semaphore/sem_getvalue.c index 120dae1372..d6da1ba4bf 100644 --- a/libc/semaphore/sem_getvalue.c +++ b/libc/semaphore/sem_getvalue.c @@ -68,7 +68,7 @@ * sem - Semaphore descriptor * sval - Buffer by which the value is returned * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/libc/semaphore/sem_init.c b/libc/semaphore/sem_init.c index 99b77317f6..b26b0b5937 100644 --- a/libc/semaphore/sem_init.c +++ b/libc/semaphore/sem_init.c @@ -68,7 +68,7 @@ * pshared - Process sharing (not used) * value - Semaphore initialization value * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -124,7 +124,7 @@ int nxsem_init(FAR sem_t *sem, int pshared, unsigned int value) * pshared - Process sharing (not used) * value - Semaphore initialization value * - * Return Value: + * Returned Value: * This returns zero (OK) if successful. Otherwise, -1 (ERROR) is * returned and the errno value is set appropriately. * diff --git a/libc/semaphore/sem_setprotocol.c b/libc/semaphore/sem_setprotocol.c index ac82cf719a..b64f466546 100644 --- a/libc/semaphore/sem_setprotocol.c +++ b/libc/semaphore/sem_setprotocol.c @@ -80,7 +80,7 @@ * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. @@ -138,7 +138,7 @@ int nxsem_setprotocol(FAR sem_t *sem, int protocol) * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/libc/signal/sig_addset.c b/libc/signal/sig_addset.c index 392be1ca69..6205ef98c6 100644 --- a/libc/signal/sig_addset.c +++ b/libc/signal/sig_addset.c @@ -55,7 +55,7 @@ * set - Signal set to add signal to * signo - Signal to add * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal number is invalid. * * Assumptions: diff --git a/libc/signal/sig_delset.c b/libc/signal/sig_delset.c index 9c6c608a2d..c38685fd72 100644 --- a/libc/signal/sig_delset.c +++ b/libc/signal/sig_delset.c @@ -55,7 +55,7 @@ * set - Signal set to delete the signal from * signo - Signal to delete * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal number is invalid. * * Assumptions: diff --git a/libc/signal/sig_emptyset.c b/libc/signal/sig_emptyset.c index 01b398ad08..7614e6ec6e 100644 --- a/libc/signal/sig_emptyset.c +++ b/libc/signal/sig_emptyset.c @@ -53,7 +53,7 @@ * Parameters: * set - Signal set to initialize * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal set cannot be initialized. * * Assumptions: diff --git a/libc/signal/sig_fillset.c b/libc/signal/sig_fillset.c index 2586646e37..a9344abb10 100644 --- a/libc/signal/sig_fillset.c +++ b/libc/signal/sig_fillset.c @@ -53,7 +53,7 @@ * Parameters: * set - Signal set to initalize * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal set cannot be initialized. * * Assumptions: diff --git a/libc/signal/sig_ismember.c b/libc/signal/sig_ismember.c index 2fbac5f6c8..5624174e0e 100644 --- a/libc/signal/sig_ismember.c +++ b/libc/signal/sig_ismember.c @@ -54,7 +54,7 @@ * set - Signal set to test * signo - Signal to test for * - * Return Value: + * Returned Value: * 1 (true), if the specified signal is a member of the set, * 0 (OK or FALSE), if it is not, or * -1 (ERROR) if the signal number is invalid. diff --git a/libc/stdio/lib_ferror.c b/libc/stdio/lib_ferror.c index 4d324c8081..3bec087b6d 100644 --- a/libc/stdio/lib_ferror.c +++ b/libc/stdio/lib_ferror.c @@ -57,7 +57,7 @@ * This function will test if the last operation resulted in an eror. This * is used to disambiguate EOF and error conditions. * - * Return Value: + * Returned Value: * A non-zero value is returned to indicate the error condition. * ****************************************************************************/ diff --git a/libc/stdio/lib_fflush.c b/libc/stdio/lib_fflush.c index dd3e178316..032ee023f4 100644 --- a/libc/stdio/lib_fflush.c +++ b/libc/stdio/lib_fflush.c @@ -62,7 +62,7 @@ * * If the stream argument is NULL, fflush() flushes all open output streams. * - * Return: + * Returned Value: * OK on success EOF on failure (with errno set appropriately) * ****************************************************************************/ diff --git a/libc/stdio/lib_freopen.c b/libc/stdio/lib_freopen.c index 0fffc1bd96..950be9ce05 100644 --- a/libc/stdio/lib_freopen.c +++ b/libc/stdio/lib_freopen.c @@ -70,7 +70,7 @@ * The error indicator and eof indicator are automatically cleared (as if * clearerr was called). * - * Input Paramters: + * Input Parameters: * path - If non-NULL, refers to the name of the file to be opened. * mode - String describing the new file access mode * stream - Pointer to the type FILE to be reopened. diff --git a/libc/stdio/lib_libfflush.c b/libc/stdio/lib_libfflush.c index 29a44cfe22..22482eb879 100644 --- a/libc/stdio/lib_libfflush.c +++ b/libc/stdio/lib_libfflush.c @@ -65,7 +65,7 @@ * stream - the stream to flush * bforce - flush must be complete. * - * Return: + * Returned Value: * A negated errno value on failure, otherwise the number of bytes remaining * in the buffer. * diff --git a/libc/stdio/lib_libnoflush.c b/libc/stdio/lib_libnoflush.c index f862cd6874..b7daabb2d7 100644 --- a/libc/stdio/lib_libnoflush.c +++ b/libc/stdio/lib_libnoflush.c @@ -60,7 +60,7 @@ * lib_noflush() provides a common, dummy flush method for output streams * that are not flushable. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/libc/stdio/lib_libsnoflush.c b/libc/stdio/lib_libsnoflush.c index 652b977cf6..8d95fad48c 100644 --- a/libc/stdio/lib_libsnoflush.c +++ b/libc/stdio/lib_libsnoflush.c @@ -59,7 +59,7 @@ * lib_snoflush() provides a common, dummy flush method for seekable output * streams that are not flushable. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/libc/stdio/lib_lowoutstream.c b/libc/stdio/lib_lowoutstream.c index 8447051d39..1896660d35 100644 --- a/libc/stdio/lib_lowoutstream.c +++ b/libc/stdio/lib_lowoutstream.c @@ -76,7 +76,7 @@ static void lowoutstream_putc(FAR struct lib_outstream_s *this, int ch) * Description: * Initializes a stream for use with low-level, architecture-specific I/O. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * diff --git a/libc/stdio/lib_meminstream.c b/libc/stdio/lib_meminstream.c index 0fdcd8f92f..ef888d9e7d 100644 --- a/libc/stdio/lib_meminstream.c +++ b/libc/stdio/lib_meminstream.c @@ -81,7 +81,7 @@ static int meminstream_getc(FAR struct lib_instream_s *this) * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_meminstream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_memoutstream.c b/libc/stdio/lib_memoutstream.c index 28137d07ed..80b8a36609 100644 --- a/libc/stdio/lib_memoutstream.c +++ b/libc/stdio/lib_memoutstream.c @@ -78,7 +78,7 @@ static void memoutstream_putc(FAR struct lib_outstream_s *this, int ch) * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_memoutstream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_memsistream.c b/libc/stdio/lib_memsistream.c index af241b4c2e..1bfda9ea2f 100644 --- a/libc/stdio/lib_memsistream.c +++ b/libc/stdio/lib_memsistream.c @@ -125,7 +125,7 @@ static off_t memsistream_seek(FAR struct lib_sistream_s *this, off_t offset, * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_memsistream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_memsostream.c b/libc/stdio/lib_memsostream.c index 93c19facad..93536a3406 100644 --- a/libc/stdio/lib_memsostream.c +++ b/libc/stdio/lib_memsostream.c @@ -122,7 +122,7 @@ static off_t memsostream_seek(FAR struct lib_sostream_s *this, off_t offset, * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_memsostream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_nullinstream.c b/libc/stdio/lib_nullinstream.c index 9ca50d6379..67d930b8d8 100644 --- a/libc/stdio/lib_nullinstream.c +++ b/libc/stdio/lib_nullinstream.c @@ -62,7 +62,7 @@ static int nullinstream_getc(FAR struct lib_instream_s *this) * Initializes a NULL stream. The initialized stream will will return only * EOF. * - * Input parameters: + * Input Parameters: * nullinstream - User allocated, uninitialized instance of struct * lib_instream_s to be initialized. * diff --git a/libc/stdio/lib_nulloutstream.c b/libc/stdio/lib_nulloutstream.c index 47f2acd58a..1f92028e3c 100644 --- a/libc/stdio/lib_nulloutstream.c +++ b/libc/stdio/lib_nulloutstream.c @@ -64,7 +64,7 @@ static void nulloutstream_putc(FAR struct lib_outstream_s *this, int ch) * Initializes a NULL streams. The initialized stream will write all data * to the bit-bucket. * - * Input parameters: + * Input Parameters: * nulloutstream - User allocated, uninitialized instance of struct * lib_outstream_s to be initialized. * diff --git a/libc/stdio/lib_rawinstream.c b/libc/stdio/lib_rawinstream.c index e37f3630fd..a0e4919c27 100644 --- a/libc/stdio/lib_rawinstream.c +++ b/libc/stdio/lib_rawinstream.c @@ -104,7 +104,7 @@ static off_t rawsistream_seek(FAR struct lib_sistream_s *this, off_t offset, * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_rawsistream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_rawoutstream.c b/libc/stdio/lib_rawoutstream.c index 69155fc15c..20e19e44a5 100644 --- a/libc/stdio/lib_rawoutstream.c +++ b/libc/stdio/lib_rawoutstream.c @@ -111,7 +111,7 @@ static off_t rawsostream_seek(FAR struct lib_sostream_s *this, off_t offset, * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_rawsostream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_rawsistream.c b/libc/stdio/lib_rawsistream.c index d332728c07..3d8d4fd1fe 100644 --- a/libc/stdio/lib_rawsistream.c +++ b/libc/stdio/lib_rawsistream.c @@ -91,7 +91,7 @@ static int rawinstream_getc(FAR struct lib_instream_s *this) * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_rawinstream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_rawsostream.c b/libc/stdio/lib_rawsostream.c index 1579e1db6d..4f05a0bf74 100644 --- a/libc/stdio/lib_rawsostream.c +++ b/libc/stdio/lib_rawsostream.c @@ -98,7 +98,7 @@ static void rawoutstream_putc(FAR struct lib_outstream_s *this, int ch) * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_rawoutstream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_remove.c b/libc/stdio/lib_remove.c index 3c2c8e6d3f..4e3e4765d5 100644 --- a/libc/stdio/lib_remove.c +++ b/libc/stdio/lib_remove.c @@ -53,7 +53,7 @@ * The remove() function causes the object denoted by path to be removed. * The function is equivalent to unlink() or rmdir(). * - * Input Parmeters: + * Input Parameters: * path - A pointer to a file or directory to be removed. * * Returned Value: diff --git a/libc/stdio/lib_stdinstream.c b/libc/stdio/lib_stdinstream.c index f1b5f3da99..da57759530 100644 --- a/libc/stdio/lib_stdinstream.c +++ b/libc/stdio/lib_stdinstream.c @@ -77,7 +77,7 @@ static int stdinstream_getc(FAR struct lib_instream_s *this) * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_stdinstream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_stdoutstream.c b/libc/stdio/lib_stdoutstream.c index 4c77c745fc..10fd58b4fb 100644 --- a/libc/stdio/lib_stdoutstream.c +++ b/libc/stdio/lib_stdoutstream.c @@ -102,7 +102,7 @@ static int stdoutstream_flush(FAR struct lib_outstream_s *this) * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_stdoutstream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_stdsistream.c b/libc/stdio/lib_stdsistream.c index b569bb4122..5fd2544729 100644 --- a/libc/stdio/lib_stdsistream.c +++ b/libc/stdio/lib_stdsistream.c @@ -90,7 +90,7 @@ static off_t stdsistream_seek(FAR struct lib_sistream_s *this, off_t offset, * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_stdsistream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_stdsostream.c b/libc/stdio/lib_stdsostream.c index 8654b63562..c7891f0e8c 100644 --- a/libc/stdio/lib_stdsostream.c +++ b/libc/stdio/lib_stdsostream.c @@ -115,7 +115,7 @@ static off_t stdsostream_seek(FAR struct lib_sostream_s *this, off_t offset, * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_stdsostream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_zeroinstream.c b/libc/stdio/lib_zeroinstream.c index 506d005871..a9d543f4df 100644 --- a/libc/stdio/lib_zeroinstream.c +++ b/libc/stdio/lib_zeroinstream.c @@ -62,7 +62,7 @@ static int zeroinstream_getc(FAR struct lib_instream_s *this) * Initializes a NULL stream. The initialized stream will return an * infinitely long stream of zeroes. * - * Input parameters: + * Input Parameters: * zeroinstream - User allocated, uninitialized instance of struct * lib_instream_s to be initialized. * diff --git a/libc/stdlib/lib_abort.c b/libc/stdlib/lib_abort.c index f037e8d8cc..87751c5a45 100644 --- a/libc/stdlib/lib_abort.c +++ b/libc/stdlib/lib_abort.c @@ -87,7 +87,7 @@ * It does this by restoring the default disposition for SIGABRT and * then raising the signal for a second time. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libc/stdlib/lib_checkbase.c b/libc/stdlib/lib_checkbase.c index a94140e81e..9d11a1d536 100644 --- a/libc/stdlib/lib_checkbase.c +++ b/libc/stdlib/lib_checkbase.c @@ -59,7 +59,7 @@ * Assumptions: * *ptr points to the first, non-whitespace character in the string. * - * Returns: + * Returned Value: * - if base is valid, the actual base to use, and pptr is updated to point * at the first digit. * - if base is invalid (<2 or >36), return -1. diff --git a/libc/stdlib/lib_ptsname.c b/libc/stdlib/lib_ptsname.c index 54cdabd69e..af08e494de 100644 --- a/libc/stdlib/lib_ptsname.c +++ b/libc/stdlib/lib_ptsname.c @@ -54,7 +54,7 @@ * The ptsname() function returns the name of the slave pseudoterminal * device corresponding to the master referred to by fd. * - * Returned Values: + * Returned Value: * On success, ptsname() returns a pointer to a string in static storage * which will be overwritten by subsequent calls. This pointer must not * be freed. On failure, NULL is returned. diff --git a/libc/stdlib/lib_ptsnamer.c b/libc/stdlib/lib_ptsnamer.c index e5df9c0ec7..17a1ad4b3c 100644 --- a/libc/stdlib/lib_ptsnamer.c +++ b/libc/stdlib/lib_ptsnamer.c @@ -59,7 +59,7 @@ * terminated string in the buffer pointed to by buf. The buflen * argument specifies the number of bytes available in buf. * - * Returned Values: + * Returned Value: * On success, ptsname_r() returns 0. On failure, a nonzero value is * returned and errno is set to indicate the error. * diff --git a/libc/stdlib/lib_strtol.c b/libc/stdlib/lib_strtol.c index 2c6c6a24de..411f7d6d41 100644 --- a/libc/stdlib/lib_strtol.c +++ b/libc/stdlib/lib_strtol.c @@ -61,7 +61,7 @@ * nptr to a long integer value according to the given base, which must be * between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_strtoll.c b/libc/stdlib/lib_strtoll.c index a5f8b2cdc3..865af86a21 100644 --- a/libc/stdlib/lib_strtoll.c +++ b/libc/stdlib/lib_strtoll.c @@ -63,7 +63,7 @@ * nptr to a long long integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_strtoul.c b/libc/stdlib/lib_strtoul.c index 8828aa830c..82ea183d73 100644 --- a/libc/stdlib/lib_strtoul.c +++ b/libc/stdlib/lib_strtoul.c @@ -56,7 +56,7 @@ * nptr to a long unsigned integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_strtoull.c b/libc/stdlib/lib_strtoull.c index fe13b63249..1896aec570 100644 --- a/libc/stdlib/lib_strtoull.c +++ b/libc/stdlib/lib_strtoull.c @@ -59,7 +59,7 @@ * nptr to a long unsigned integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_unlockpt.c b/libc/stdlib/lib_unlockpt.c index 8ea6e4c7ef..0626d86571 100644 --- a/libc/stdlib/lib_unlockpt.c +++ b/libc/stdlib/lib_unlockpt.c @@ -57,7 +57,7 @@ * unlockpt() must be called before opening the slave side of a * pseudoterminal. * - * Returned Values: + * Returned Value: * When successful, unlockpt() returns 0. Otherwise, it returns -1 and * sets errno appropriately. * diff --git a/libc/string/lib_stpcpy.c b/libc/string/lib_stpcpy.c index dd2917f7bc..edfdd4ca00 100644 --- a/libc/string/lib_stpcpy.c +++ b/libc/string/lib_stpcpy.c @@ -52,7 +52,7 @@ * Copies the string pointed to by 'src' (including the terminating NUL * character) into the array pointed to by 'dest'. * - * Returned value: + * Returned Value: * The stpcpy() function returns a pointer to the terminating NUL * character copied into the 'dest' buffer * diff --git a/libc/string/lib_strcpy.c b/libc/string/lib_strcpy.c index a329dc2925..9c1b197a61 100644 --- a/libc/string/lib_strcpy.c +++ b/libc/string/lib_strcpy.c @@ -52,7 +52,7 @@ * Copies the string pointed to by 'src' (including the terminating NUL * character) into the array pointed to by 'des'. * - * Returned value: + * Returned Value: * The strcpy() function returns the 'dest' pointer * ****************************************************************************/ diff --git a/libc/string/lib_strtok.c b/libc/string/lib_strtok.c index 9373265558..8821a7d7ea 100644 --- a/libc/string/lib_strtok.c +++ b/libc/string/lib_strtok.c @@ -75,7 +75,7 @@ static char *g_saveptr = NULL; * end of the string are ignored. The tokens returned by * strtok() are always non-empty strings. * - * Return + * Returned Value: * strtok() returns a pointer to the next token, or NULL * if there are no more tokens. * diff --git a/libc/string/lib_strtokr.c b/libc/string/lib_strtokr.c index 22579f91ee..c179521961 100644 --- a/libc/string/lib_strtokr.c +++ b/libc/string/lib_strtokr.c @@ -84,7 +84,7 @@ * end of the string are ignored. The tokens returned by * strtok() are always non-empty strings. * - * Return + * Returned Value: * strtok_r() returns a pointer to the next token, or NULL * if there are no more tokens. * diff --git a/libc/time/lib_asctime.c b/libc/time/lib_asctime.c index af633ebd73..3ddf1074f8 100644 --- a/libc/time/lib_asctime.c +++ b/libc/time/lib_asctime.c @@ -58,7 +58,7 @@ * Parameters: * tp - Pointer to the time to be converted. * - * Return Value: + * Returned Value: * One success a pointer to the string is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_asctimer.c b/libc/time/lib_asctimer.c index 11b25974fa..bebbd21a12 100644 --- a/libc/time/lib_asctimer.c +++ b/libc/time/lib_asctimer.c @@ -78,7 +78,7 @@ static const char * const g_mon_name[12] = * tp - Pointer to the time to be converted. * buf - A user provided buffer to receive the 26 character time string. * - * Return Value: + * Returned Value: * One success, the pointer to the 'buf' is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_ctime.c b/libc/time/lib_ctime.c index 4072663fb8..1151382816 100644 --- a/libc/time/lib_ctime.c +++ b/libc/time/lib_ctime.c @@ -58,7 +58,7 @@ * Parameters: * timep - The current time represented as seconds since the epoch. * - * Return Value: + * Returned Value: * One success a pointer to the string is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_ctimer.c b/libc/time/lib_ctimer.c index ccc9c8f928..1286976c6d 100644 --- a/libc/time/lib_ctimer.c +++ b/libc/time/lib_ctimer.c @@ -63,7 +63,7 @@ * timep - The current time represented as seconds since the epoch. * buf - A user provided buffer to receive the 26 character time string. * - * Return Value: + * Returned Value: * One success, the pointer to the 'buf' is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_dayofweek.c b/libc/time/lib_dayofweek.c index 981e027025..9549dc3e44 100644 --- a/libc/time/lib_dayofweek.c +++ b/libc/time/lib_dayofweek.c @@ -90,7 +90,7 @@ * month - The month of the year 1 - 12 * year - the year including the 1900 * - * Returned value: + * Returned Value: * Zero based day of the week 0-6, 0 = Sunday, 1 = Monday... 6 = Saturday * ****************************************************************************/ diff --git a/libc/time/lib_gettimeofday.c b/libc/time/lib_gettimeofday.c index 6a1f01d16e..89a8caefd8 100644 --- a/libc/time/lib_gettimeofday.c +++ b/libc/time/lib_gettimeofday.c @@ -64,7 +64,7 @@ * tv - The location to return the current time * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * diff --git a/libc/time/lib_settimeofday.c b/libc/time/lib_settimeofday.c index a36f32911b..1fc96d5ec7 100644 --- a/libc/time/lib_settimeofday.c +++ b/libc/time/lib_settimeofday.c @@ -63,7 +63,7 @@ * tv - The net to time to be set * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * diff --git a/libc/time/lib_time.c b/libc/time/lib_time.c index 504f7795f9..683d8a71b9 100644 --- a/libc/time/lib_time.c +++ b/libc/time/lib_time.c @@ -63,7 +63,7 @@ * parameter is not used, but a time_t object is still returned by the * function. * - * Return Value: + * Returned Value: * The current calendar time as a time_t object. If the argument is not * a null pointer, the return value is the same as the one stored in the * location pointed by the argument. diff --git a/libc/unistd/lib_chdir.c b/libc/unistd/lib_chdir.c index 16786a0f31..b87a3ebb82 100644 --- a/libc/unistd/lib_chdir.c +++ b/libc/unistd/lib_chdir.c @@ -90,7 +90,7 @@ static inline void _trimdir(char *path) * is, the starting point for path searches for pathnames not beginning * with '/'. * - * Input Parmeters: + * Input Parameters: * path - A pointer to a directory to use as the new current working * directory * diff --git a/libc/unistd/lib_getcwd.c b/libc/unistd/lib_getcwd.c index 55587a599e..9a04de995c 100644 --- a/libc/unistd/lib_getcwd.c +++ b/libc/unistd/lib_getcwd.c @@ -71,7 +71,7 @@ * symbolic links. The 'size' argument is the size in bytes of the * character array pointed to by the 'buf' argument. * - * Input Parmeters: + * Input Parameters: * buf - a pointer to the location in which the current working directory * pathaname is returned. * size - The size in bytes avaiable at 'buf' diff --git a/libc/unistd/lib_getopt.c b/libc/unistd/lib_getopt.c index 47ac085509..8826588eca 100644 --- a/libc/unistd/lib_getopt.c +++ b/libc/unistd/lib_getopt.c @@ -101,13 +101,14 @@ static bool g_binitialized = false; * errors are returned ('?' or ':') until getopt() finally returns -1. * (You can also set optind to -1 to force a reset). * - * Return: If an option was successfully found, then getopt() returns the - * option character. If all command-line options have been parsed, then - * getopt() returns -1. If getopt() encounters an option character that - * was not in optstring, then '?' is returned. If getopt() encounters an - * option with a missing argument, then the return value depends on the - * first character in optstring: if it is ':', then ':' is returned; - * otherwise '?' is returned. + * Return Value: + * If an option was successfully found, then getopt() returns the option + * haracter. If all command-line options have been parsed, then getopt() + * returns -1. If getopt() encounters an option character that was not + * in optstring, then '?' is returned. If getopt() encounters an option + * with a missing argument, then the return value depends on the first + * character in optstring: if it is ':', then ':' is returned; otherwise + * '?' is returned. * ****************************************************************************/ diff --git a/libc/unistd/lib_pipe.c b/libc/unistd/lib_pipe.c index 469dd5a1d5..dc251b33c8 100644 --- a/libc/unistd/lib_pipe.c +++ b/libc/unistd/lib_pipe.c @@ -57,11 +57,11 @@ * and places them in the array pointed to by 'fd'. fd[0] is for reading, * fd[1] is for writing. * - * Inputs: + * Input Parameters: * fd[2] - The user provided array in which to catch the pipe file * descriptors * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/libc/userfs/lib_userfs.c b/libc/userfs/lib_userfs.c index 8f04c21f1d..f08b936375 100644 --- a/libc/userfs/lib_userfs.c +++ b/libc/userfs/lib_userfs.c @@ -901,7 +901,7 @@ static inline int userfs_destroy_dispatch(FAR struct userfs_info_s *info, * NOTE: This is a user function that is implemented as part of the * NuttX C library and is intended to be called by appliation logic. * - * Input parameters: + * Input Parameters: * mountpt - Mountpoint path * userops - The caller operations that implement the file system * interface. diff --git a/libc/wqueue/work_cancel.c b/libc/wqueue/work_cancel.c index 31ccbf68d3..c035307056 100644 --- a/libc/wqueue/work_cancel.c +++ b/libc/wqueue/work_cancel.c @@ -62,7 +62,7 @@ * After work has been cancelled, it may be re-queue by calling work_queue() * again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The previously queue work structure to cancel * @@ -124,7 +124,7 @@ static int work_qcancel(FAR struct usr_wqueue_s *wqueue, FAR struct work_s *work * user mode work queue. After work has been cancelled, it may be re-queue * by calling work_queue() again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (must be USRWORK) * work - The previously queue work structure to cancel * diff --git a/libc/wqueue/work_lock.c b/libc/wqueue/work_lock.c index eec61847ac..8b8a5682c0 100644 --- a/libc/wqueue/work_lock.c +++ b/libc/wqueue/work_lock.c @@ -58,7 +58,7 @@ * Description: * Lock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -98,7 +98,7 @@ int work_lock(void) * Description: * Unlock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libc/wqueue/work_queue.c b/libc/wqueue/work_queue.c index 5b9a0ac3e4..40cbdf5635 100644 --- a/libc/wqueue/work_queue.c +++ b/libc/wqueue/work_queue.c @@ -70,7 +70,7 @@ * from the queue, or (2) work_cancel() has been called to cancel the work * and remove it from the work queue. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked @@ -141,7 +141,7 @@ static int work_qqueue(FAR struct usr_wqueue_s *wqueue, * previous work as been performed and removed from the queue, then any * pending work will be canceled and lost. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked diff --git a/libc/wqueue/work_signal.c b/libc/wqueue/work_signal.c index 53fc8f829d..1854210cc5 100644 --- a/libc/wqueue/work_signal.c +++ b/libc/wqueue/work_signal.c @@ -79,7 +79,7 @@ * is used internally by the work logic but could also be used by the * user to force an immediate re-assessment of pending work. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * * Returned Value: diff --git a/libc/wqueue/work_usrthread.c b/libc/wqueue/work_usrthread.c index 5e919d8e0a..bb62a8d645 100644 --- a/libc/wqueue/work_usrthread.c +++ b/libc/wqueue/work_usrthread.c @@ -106,7 +106,7 @@ pthread_mutex_t g_usrmutex; * part of the internal implementation of each work queue; it should not * be called from application level logic. * - * Input parameters: + * Input Parameters: * wqueue - Describes the work queue to be processed * * Returned Value: @@ -285,7 +285,7 @@ void work_process(FAR struct usr_wqueue_s *wqueue) * miscellaneous operations. The user work thread must be started by * application start-up logic by calling work_usrstart(). * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: @@ -327,7 +327,7 @@ static pthread_addr_t work_usrthread(pthread_addr_t arg) * Description: * Start the user mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libc/wqueue/wqueue.h b/libc/wqueue/wqueue.h index 6075ea00e8..f16574e663 100644 --- a/libc/wqueue/wqueue.h +++ b/libc/wqueue/wqueue.h @@ -92,7 +92,7 @@ extern pthread_mutex_t g_usrmutex; * Description: * Lock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -111,7 +111,7 @@ int work_lock(void); * Description: * Unlock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libnx/nx/nx_drawcircle.c b/libnx/nx/nx_drawcircle.c index c06413b458..0502747971 100644 --- a/libnx/nx/nx_drawcircle.c +++ b/libnx/nx/nx_drawcircle.c @@ -102,7 +102,7 @@ * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nx/nx_drawline.c b/libnx/nx/nx_drawline.c index 6ca0ade436..ecd0df074f 100644 --- a/libnx/nx/nx_drawline.c +++ b/libnx/nx/nx_drawline.c @@ -86,7 +86,7 @@ * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nx/nx_fillcircle.c b/libnx/nx/nx_fillcircle.c index 7bfa1551f5..adec60a406 100644 --- a/libnx/nx/nx_fillcircle.c +++ b/libnx/nx/nx_fillcircle.c @@ -84,7 +84,7 @@ * radius - The radius of the circle in pixels. * color - The color to use to fill the circle. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxfonts/nxfonts_cache.c b/libnx/nxfonts/nxfonts_cache.c index fbf99eca87..6276b91dc7 100644 --- a/libnx/nxfonts/nxfonts_cache.c +++ b/libnx/nxfonts/nxfonts_cache.c @@ -639,7 +639,7 @@ nxf_findcache(enum nx_fontid_e fontid, nxgl_mxpixel_t fgcolor, * bpp - Bits per pixel * maxglyphs - Maximum number of glyphs permitted in the cache * - * Returned value: + * Returned Value: * On success a non-NULL handle is returned that then may sequently be * used with nxf_getglyph() to extract fonts from the font cache. NULL * returned on any failure with the errno value set to indicate the nature @@ -798,7 +798,7 @@ errout_with_lock: * Input Parameters: * fhandle - A font cache handle previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -876,7 +876,7 @@ void nxf_cache_disconnect(FCACHE fhandle) * Input Parameters: * fhandle - A font cache handle previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * Zero (OK) is returned if the metrics were * * Returned Value: diff --git a/libnx/nxglib/nxglib_circlepts.c b/libnx/nxglib/nxglib_circlepts.c index 21d2340a71..a7132ce5f5 100644 --- a/libnx/nxglib/nxglib_circlepts.c +++ b/libnx/nxglib/nxglib_circlepts.c @@ -89,13 +89,13 @@ * circumference of the circle. These points may then be used by * nx_drawcircle() or related APIs to draw a circle outline. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 16 points where the * circle points will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxglib/nxglib_circletraps.c b/libnx/nxglib/nxglib_circletraps.c index f7038703ba..158c044e4e 100644 --- a/libnx/nxglib/nxglib_circletraps.c +++ b/libnx/nxglib/nxglib_circletraps.c @@ -68,13 +68,13 @@ * Given a description of a a circle, return 8 trapezoids that can be * used to fill the circle by nx_fillcircle() and other interfaces. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 8 trapezoids where * the circle description will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxglib/nxglib_splitline.c b/libnx/nxglib/nxglib_splitline.c index 31b5d914bd..10bffa257b 100644 --- a/libnx/nxglib/nxglib_splitline.c +++ b/libnx/nxglib/nxglib_splitline.c @@ -104,12 +104,12 @@ static b16_t nxgl_interpolate(b16_t x, b16_t dy, b16_t dxdy) * this case, 3 trapezoids will be returned, but traps[1] will be * degenerate. * - * Input parameters: + * Input Parameters: * vector - A pointer to the vector described the line to be drawn. * traps - A pointer to a array of trapezoids (size 3). * rect - A pointer to a rectangle. * - * Returned value: + * Returned Value: * 0: Line successfully broken up into three trapezoids. Values in * traps[0], traps[1], and traps[2] are valid. * 1: Line successfully represented by one trapezoid. Value in traps[1] diff --git a/libnx/nxmu/nx_bitmap.c b/libnx/nxmu/nx_bitmap.c index 2c455d424b..e1fcb8451b 100644 --- a/libnx/nxmu/nx_bitmap.c +++ b/libnx/nxmu/nx_bitmap.c @@ -69,7 +69,7 @@ * may lie outside of the display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_block.c b/libnx/nxmu/nx_block.c index 4569a195ad..2bf8efa64c 100644 --- a/libnx/nxmu/nx_block.c +++ b/libnx/nxmu/nx_block.c @@ -74,7 +74,7 @@ * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_closewindow.c b/libnx/nxmu/nx_closewindow.c index 6e5661f6b4..b0aac838b7 100644 --- a/libnx/nxmu/nx_closewindow.c +++ b/libnx/nxmu/nx_closewindow.c @@ -60,7 +60,7 @@ * Input Parameters: * wnd - The window to be destroyed * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_connect.c b/libnx/nxmu/nx_connect.c index e69580bce8..d600666e8a 100644 --- a/libnx/nxmu/nx_connect.c +++ b/libnx/nxmu/nx_connect.c @@ -93,7 +93,7 @@ static uint32_t g_nxcid = 1; * Input Parameters: * svrmqname - The name for the server incoming message queue * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * diff --git a/libnx/nxmu/nx_constructwindow.c b/libnx/nxmu/nx_constructwindow.c index cc8b1656b1..3cfd88c12e 100644 --- a/libnx/nxmu/nx_constructwindow.c +++ b/libnx/nxmu/nx_constructwindow.c @@ -75,7 +75,7 @@ * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. In the * case of ERROR, NX will have deallocated the pre-allocated window. * diff --git a/libnx/nxmu/nx_disconnect.c b/libnx/nxmu/nx_disconnect.c index 6b1877efc3..2b6a9638e9 100644 --- a/libnx/nxmu/nx_disconnect.c +++ b/libnx/nxmu/nx_disconnect.c @@ -61,7 +61,7 @@ * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK on success; ERROR on failure with the errno set appropriately. * NOTE that handle will no long be valid upon return. * diff --git a/libnx/nxmu/nx_eventhandler.c b/libnx/nxmu/nx_eventhandler.c index a82b10839a..bc6a746850 100644 --- a/libnx/nxmu/nx_eventhandler.c +++ b/libnx/nxmu/nx_eventhandler.c @@ -108,7 +108,7 @@ static inline void nx_disconnected(FAR struct nxfe_conn_s *conn) * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then * one or more server message was processed. * ERROR: An error occurred and errno has been set appropriately. Of diff --git a/libnx/nxmu/nx_eventnotify.c b/libnx/nxmu/nx_eventnotify.c index 70653f62e2..a136774349 100644 --- a/libnx/nxmu/nx_eventnotify.c +++ b/libnx/nxmu/nx_eventnotify.c @@ -69,7 +69,7 @@ * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then * one or more server message was processed. * ERROR: An error occurred and errno has been set appropriately diff --git a/libnx/nxmu/nx_fill.c b/libnx/nxmu/nx_fill.c index bb59f6b281..d8a6231caf 100644 --- a/libnx/nxmu/nx_fill.c +++ b/libnx/nxmu/nx_fill.c @@ -63,7 +63,7 @@ * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_filltrapezoid.c b/libnx/nxmu/nx_filltrapezoid.c index 6dbdf27ab3..a9c8508429 100644 --- a/libnx/nxmu/nx_filltrapezoid.c +++ b/libnx/nxmu/nx_filltrapezoid.c @@ -64,7 +64,7 @@ * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_getposition.c b/libnx/nxmu/nx_getposition.c index d18d1d3a59..757c1621c5 100644 --- a/libnx/nxmu/nx_getposition.c +++ b/libnx/nxmu/nx_getposition.c @@ -61,7 +61,7 @@ * Input Parameters: * hwnd - The window handle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_getrectangle.c b/libnx/nxmu/nx_getrectangle.c index 958a1e05e8..fb1843b52d 100644 --- a/libnx/nxmu/nx_getrectangle.c +++ b/libnx/nxmu/nx_getrectangle.c @@ -68,7 +68,7 @@ * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_lower.c b/libnx/nxmu/nx_lower.c index 06952d17f7..8d0ceca40d 100644 --- a/libnx/nxmu/nx_lower.c +++ b/libnx/nxmu/nx_lower.c @@ -56,10 +56,10 @@ * Description: * Lower the specified window to the bottom of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be lowered * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_move.c b/libnx/nxmu/nx_move.c index 144e9e588b..71a4ca7f44 100644 --- a/libnx/nxmu/nx_move.c +++ b/libnx/nxmu/nx_move.c @@ -61,7 +61,7 @@ * rect - Describes the rectangular region to move * offset - The offset to move the region * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_openwindow.c b/libnx/nxmu/nx_openwindow.c index 3280ee4225..d5152192b7 100644 --- a/libnx/nxmu/nx_openwindow.c +++ b/libnx/nxmu/nx_openwindow.c @@ -63,7 +63,7 @@ * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * diff --git a/libnx/nxmu/nx_raise.c b/libnx/nxmu/nx_raise.c index a149acdb28..92f82d456d 100644 --- a/libnx/nxmu/nx_raise.c +++ b/libnx/nxmu/nx_raise.c @@ -56,10 +56,10 @@ * Description: * Bring the specified window to the top of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be raised * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_releasebkgd.c b/libnx/nxmu/nx_releasebkgd.c index 9fe9a44c71..22620193ce 100644 --- a/libnx/nxmu/nx_releasebkgd.c +++ b/libnx/nxmu/nx_releasebkgd.c @@ -60,7 +60,7 @@ * Input Parameters: * hwnd - The handle returned (indirectly) by nx_requestbkgd * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_requestbkgd.c b/libnx/nxmu/nx_requestbkgd.c index 77a4ae8ed5..d3eff5c553 100644 --- a/libnx/nxmu/nx_requestbkgd.c +++ b/libnx/nxmu/nx_requestbkgd.c @@ -84,7 +84,7 @@ * cb - Callbacks to use for processing background window events * arg - User provided argument (see nx_openwindow, nx_constructwindow) * - * Return: + * Returned Value: * OK: Success; ERROR of failure with errno set appropriately. * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setbgcolor.c b/libnx/nxmu/nx_setbgcolor.c index 74c683acf3..43d74187a8 100644 --- a/libnx/nxmu/nx_setbgcolor.c +++ b/libnx/nxmu/nx_setbgcolor.c @@ -59,7 +59,7 @@ * handle - The connection handle * color - The color to use in the background * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setpixel.c b/libnx/nxmu/nx_setpixel.c index 376f85b04c..bef3768073 100644 --- a/libnx/nxmu/nx_setpixel.c +++ b/libnx/nxmu/nx_setpixel.c @@ -64,7 +64,7 @@ * pos - The pixel location to be set * col - The color to use in the set * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setposition.c b/libnx/nxmu/nx_setposition.c index a537d1b79a..e8d6887271 100644 --- a/libnx/nxmu/nx_setposition.c +++ b/libnx/nxmu/nx_setposition.c @@ -60,7 +60,7 @@ * hwnd - The window handle * pos - The new position of the window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setsize.c b/libnx/nxmu/nx_setsize.c index dd2ee119ff..7a73710d9e 100644 --- a/libnx/nxmu/nx_setsize.c +++ b/libnx/nxmu/nx_setsize.c @@ -60,7 +60,7 @@ * hwnd - The window handle * size - The new size of the window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nxmu_sendserver.c b/libnx/nxmu/nxmu_sendserver.c index 2072ad2894..833d03f9d9 100644 --- a/libnx/nxmu/nxmu_sendserver.c +++ b/libnx/nxmu/nxmu_sendserver.c @@ -61,7 +61,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nxmu_sendwindow.c b/libnx/nxmu/nxmu_sendwindow.c index 350fecd41d..aa59204249 100644 --- a/libnx/nxmu/nxmu_sendwindow.c +++ b/libnx/nxmu/nxmu_sendwindow.c @@ -62,7 +62,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk.h b/libnx/nxtk/nxtk.h index 44d507ee01..97f5b486ec 100644 --- a/libnx/nxtk/nxtk.h +++ b/libnx/nxtk/nxtk.h @@ -125,13 +125,13 @@ void nxtk_setsubwindows(FAR struct nxtk_framedwindow_s *fwnd); * then move the rectangle to that it is relative to the containing * window. * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The locaton to put the result * src - The src rectangle in relative sub-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -152,13 +152,13 @@ void nxtk_subwindowclip(FAR struct nxtk_framedwindow_s *fwnd, * relative to the sub-window (i.e., (0,0) is the top left corner of the * sub-window). * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The location to put the result * src - The src rectangle in relative container-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -185,7 +185,7 @@ void nxtk_containerclip(FAR struct nxtk_framedwindow_s *fwnd, * srcoffset - The offset to move the region * bounds - The subwindow bounds in absolute screen coordinates. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -203,13 +203,13 @@ void nxtk_subwindowmove(FAR struct nxtk_framedwindow_s *fwnd, * Description: * Redraw the window frame. * - * Input parameters: + * Input Parameters: * fwnd - the framed window whose frame needs to be re-drawn. This must * have been previously created by nxtk_openwindow(). * bounds - Only draw the ports of the frame within this bounding box. * (window relative coordinates). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_bitmaptoolbar.c b/libnx/nxtk/nxtk_bitmaptoolbar.c index 6f31d93009..6ba5d383c9 100644 --- a/libnx/nxtk/nxtk_bitmaptoolbar.c +++ b/libnx/nxtk/nxtk_bitmaptoolbar.c @@ -89,7 +89,7 @@ * origin may lie outside of the sub-window display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_bitmapwindow.c b/libnx/nxtk/nxtk_bitmapwindow.c index 0371715ba7..8ba53f9485 100644 --- a/libnx/nxtk/nxtk_bitmapwindow.c +++ b/libnx/nxtk/nxtk_bitmapwindow.c @@ -89,7 +89,7 @@ * origin may lie outside of the sub-window display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_block.c b/libnx/nxtk/nxtk_block.c index d68dbe8fc2..625e862d17 100644 --- a/libnx/nxtk/nxtk_block.c +++ b/libnx/nxtk/nxtk_block.c @@ -71,7 +71,7 @@ * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_closetoolbar.c b/libnx/nxtk/nxtk_closetoolbar.c index 7be217d18d..ed4cbb190a 100644 --- a/libnx/nxtk/nxtk_closetoolbar.c +++ b/libnx/nxtk/nxtk_closetoolbar.c @@ -81,7 +81,7 @@ * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_closewindow.c b/libnx/nxtk/nxtk_closewindow.c index 5485752130..cf2e6ad90b 100644 --- a/libnx/nxtk/nxtk_closewindow.c +++ b/libnx/nxtk/nxtk_closewindow.c @@ -82,7 +82,7 @@ * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_containerclip.c b/libnx/nxtk/nxtk_containerclip.c index 67ed6cb17b..42951f470b 100644 --- a/libnx/nxtk/nxtk_containerclip.c +++ b/libnx/nxtk/nxtk_containerclip.c @@ -83,13 +83,13 @@ * relative to the sub-window (i.e., (0,0) is the top left corner of the * sub-window). * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The locaton to put the result * src - The src rectangle in relative container-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawcircletoolbar.c b/libnx/nxtk/nxtk_drawcircletoolbar.c index 37998b70f8..69ea9a67ca 100644 --- a/libnx/nxtk/nxtk_drawcircletoolbar.c +++ b/libnx/nxtk/nxtk_drawcircletoolbar.c @@ -102,7 +102,7 @@ * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawcirclewindow.c b/libnx/nxtk/nxtk_drawcirclewindow.c index 3f6cdd2882..1ba7717085 100644 --- a/libnx/nxtk/nxtk_drawcirclewindow.c +++ b/libnx/nxtk/nxtk_drawcirclewindow.c @@ -102,7 +102,7 @@ * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawframe.c b/libnx/nxtk/nxtk_drawframe.c index adafccc574..2e1ea68b17 100644 --- a/libnx/nxtk/nxtk_drawframe.c +++ b/libnx/nxtk/nxtk_drawframe.c @@ -98,13 +98,13 @@ static void nxtk_drawframeside(FAR struct nxtk_framedwindow_s *fwnd, * Description: * Redraw the window frame. * - * Input parameters: + * Input Parameters: * fwnd - the framed window whose frame needs to be re-drawn. This must * have been previously created by nxtk_openwindow(). * bounds - Only draw the ports of the frame within this bounding box. * (window relative coordinates). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawlinetoolbar.c b/libnx/nxtk/nxtk_drawlinetoolbar.c index 84d25ad83c..51820a47f8 100644 --- a/libnx/nxtk/nxtk_drawlinetoolbar.c +++ b/libnx/nxtk/nxtk_drawlinetoolbar.c @@ -88,7 +88,7 @@ * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawlinewindow.c b/libnx/nxtk/nxtk_drawlinewindow.c index 231842b882..970ce40e60 100644 --- a/libnx/nxtk/nxtk_drawlinewindow.c +++ b/libnx/nxtk/nxtk_drawlinewindow.c @@ -87,7 +87,7 @@ * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_fillcircletoolbar.c b/libnx/nxtk/nxtk_fillcircletoolbar.c index af502c7660..0772d8c75e 100644 --- a/libnx/nxtk/nxtk_fillcircletoolbar.c +++ b/libnx/nxtk/nxtk_fillcircletoolbar.c @@ -84,7 +84,7 @@ * radius - The radius of the circle in pixels. * color - The color to use to fill the circle. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_fillcirclewindow.c b/libnx/nxtk/nxtk_fillcirclewindow.c index b155e85ff9..20273be3a5 100644 --- a/libnx/nxtk/nxtk_fillcirclewindow.c +++ b/libnx/nxtk/nxtk_fillcirclewindow.c @@ -84,7 +84,7 @@ * radius - The radius of the circle in pixels. * color - The color to use to fill the circle. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_filltoolbar.c b/libnx/nxtk/nxtk_filltoolbar.c index 25eb6a8e8e..146fc59ad2 100644 --- a/libnx/nxtk/nxtk_filltoolbar.c +++ b/libnx/nxtk/nxtk_filltoolbar.c @@ -83,7 +83,7 @@ * rect - The location within the toolbar window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_filltraptoolbar.c b/libnx/nxtk/nxtk_filltraptoolbar.c index 3ca0b38ad2..afbc11be3e 100644 --- a/libnx/nxtk/nxtk_filltraptoolbar.c +++ b/libnx/nxtk/nxtk_filltraptoolbar.c @@ -83,7 +83,7 @@ * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_filltrapwindow.c b/libnx/nxtk/nxtk_filltrapwindow.c index 88c3077223..886ab81b8b 100644 --- a/libnx/nxtk/nxtk_filltrapwindow.c +++ b/libnx/nxtk/nxtk_filltrapwindow.c @@ -83,7 +83,7 @@ * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_fillwindow.c b/libnx/nxtk/nxtk_fillwindow.c index 9ff1caca57..103fdc2795 100644 --- a/libnx/nxtk/nxtk_fillwindow.c +++ b/libnx/nxtk/nxtk_fillwindow.c @@ -83,7 +83,7 @@ * rect - The location within the client window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_getposition.c b/libnx/nxtk/nxtk_getposition.c index 1f0bdceeef..dafbe01139 100644 --- a/libnx/nxtk/nxtk_getposition.c +++ b/libnx/nxtk/nxtk_getposition.c @@ -83,7 +83,7 @@ * Input Parameters: * hfwnd - The window handle returned by nxtk_openwindow. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_gettoolbar.c b/libnx/nxtk/nxtk_gettoolbar.c index bc05cbce94..ab404d1231 100644 --- a/libnx/nxtk/nxtk_gettoolbar.c +++ b/libnx/nxtk/nxtk_gettoolbar.c @@ -88,7 +88,7 @@ * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_getwindow.c b/libnx/nxtk/nxtk_getwindow.c index 4106267fb0..6f7e15e131 100644 --- a/libnx/nxtk/nxtk_getwindow.c +++ b/libnx/nxtk/nxtk_getwindow.c @@ -88,7 +88,7 @@ * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_lower.c b/libnx/nxtk/nxtk_lower.c index 08a588897d..fee5fd075d 100644 --- a/libnx/nxtk/nxtk_lower.c +++ b/libnx/nxtk/nxtk_lower.c @@ -79,11 +79,11 @@ * Lower the window containing the specified client sub-window to the * bottom of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be lowered. This must have been previously * created by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_movetoolbar.c b/libnx/nxtk/nxtk_movetoolbar.c index 913142a0d4..08a1e3beb3 100644 --- a/libnx/nxtk/nxtk_movetoolbar.c +++ b/libnx/nxtk/nxtk_movetoolbar.c @@ -87,7 +87,7 @@ * sub-window to move * offset - The offset to move the region * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_movewindow.c b/libnx/nxtk/nxtk_movewindow.c index 302cff98d1..e0064ba795 100644 --- a/libnx/nxtk/nxtk_movewindow.c +++ b/libnx/nxtk/nxtk_movewindow.c @@ -86,7 +86,7 @@ * sub-window to move * offset - The offset to move the region * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_opentoolbar.c b/libnx/nxtk/nxtk_opentoolbar.c index f5d58979ea..2bf68b69c1 100644 --- a/libnx/nxtk/nxtk_opentoolbar.c +++ b/libnx/nxtk/nxtk_opentoolbar.c @@ -85,7 +85,7 @@ * arg - User provided value that will be returned with toolbar * callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_openwindow.c b/libnx/nxtk/nxtk_openwindow.c index ebefaec892..f333ea79c7 100644 --- a/libnx/nxtk/nxtk_openwindow.c +++ b/libnx/nxtk/nxtk_openwindow.c @@ -107,7 +107,7 @@ nxgl_mxpixel_t g_bordercolor3[CONFIG_NX_NPLANES] = * cb - Callbacks used to process window events * arg - User provided value that will be returned with NXTK callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NXTK window accesses * Failure: NULL is returned and errno is set appropriately * diff --git a/libnx/nxtk/nxtk_raise.c b/libnx/nxtk/nxtk_raise.c index d0273fe704..2fa954a6ea 100644 --- a/libnx/nxtk/nxtk_raise.c +++ b/libnx/nxtk/nxtk_raise.c @@ -79,11 +79,11 @@ * Bring the window containing the specified client sub-window to the top * of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be raised. This must have been previously * created by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_setposition.c b/libnx/nxtk/nxtk_setposition.c index ed85625272..642db0fb54 100644 --- a/libnx/nxtk/nxtk_setposition.c +++ b/libnx/nxtk/nxtk_setposition.c @@ -84,7 +84,7 @@ * hfwnd - The window handle returned by nxtk_openwindow * pos - The new position of the client sub-window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_setsize.c b/libnx/nxtk/nxtk_setsize.c index 7e90796966..d9ccfe46c8 100644 --- a/libnx/nxtk/nxtk_setsize.c +++ b/libnx/nxtk/nxtk_setsize.c @@ -84,7 +84,7 @@ * hfwnd - The window handle returned by nxtk_openwindow * size - The new size of the client sub-window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_subwindowclip.c b/libnx/nxtk/nxtk_subwindowclip.c index b1b4024ee7..3aa0a5dc28 100644 --- a/libnx/nxtk/nxtk_subwindowclip.c +++ b/libnx/nxtk/nxtk_subwindowclip.c @@ -83,13 +83,13 @@ * containing window (i.e., (0,0) is the top left corner of the containing * window). * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The locaton to put the result * src - The src rectangle in relative sub-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_subwindowmove.c b/libnx/nxtk/nxtk_subwindowmove.c index 6b80609d3d..2c14d010ce 100644 --- a/libnx/nxtk/nxtk_subwindowmove.c +++ b/libnx/nxtk/nxtk_subwindowmove.c @@ -89,7 +89,7 @@ * srcoffset - The offset to move the region * bounds - The subwindow bounds in absolute screen coordinates. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_toolbarbounds.c b/libnx/nxtk/nxtk_toolbarbounds.c index eacaf90573..0657d60276 100644 --- a/libnx/nxtk/nxtk_toolbarbounds.c +++ b/libnx/nxtk/nxtk_toolbarbounds.c @@ -87,7 +87,7 @@ * hfwnd - The handle returned by nxtk_openwindow * bounds - User provided location in which to return the bounding box. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_addregion.c b/mm/kmm_heap/kmm_addregion.c index 41884fa7c3..96bf448eec 100644 --- a/mm/kmm_heap/kmm_addregion.c +++ b/mm/kmm_heap/kmm_addregion.c @@ -57,7 +57,7 @@ * heap_start - Address of the beginning of the memory region * heap_size - The size (in bytes) if the memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_free.c b/mm/kmm_heap/kmm_free.c index c901678818..466b268b7e 100644 --- a/mm/kmm_heap/kmm_free.c +++ b/mm/kmm_heap/kmm_free.c @@ -60,7 +60,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_heapmember.c b/mm/kmm_heap/kmm_heapmember.c index 53fa7027b7..dc1c916ef7 100644 --- a/mm/kmm_heap/kmm_heapmember.c +++ b/mm/kmm_heap/kmm_heapmember.c @@ -58,7 +58,7 @@ * Parameters: * mem - The address to check * - * Return Value: + * Returned Value: * true if the address is a member of the kernel heap. false if not * not. If the address is not a member of the kernel heap, then it * must be a member of the user-space heap (unchecked) diff --git a/mm/kmm_heap/kmm_initialize.c b/mm/kmm_heap/kmm_initialize.c index 03baba8120..4bf8d99027 100644 --- a/mm/kmm_heap/kmm_initialize.c +++ b/mm/kmm_heap/kmm_initialize.c @@ -66,7 +66,7 @@ struct mm_heap_s g_kmmheap; * heap_start - Address of the beginning of the (initial) memory region * heap_size - The size (in bytes) if the (initial) memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_kernel.c b/mm/kmm_heap/kmm_kernel.c index e2fc9232b8..0faf6944ab 100644 --- a/mm/kmm_heap/kmm_kernel.c +++ b/mm/kmm_heap/kmm_kernel.c @@ -59,7 +59,7 @@ * Parameters: * mem - The address to check * - * Return Value: + * Returned Value: * true if the address is a member of the kernel heap. false if not * not. If the address is not a member of the kernel heap, then it * must be a member of the user-space heap (unchecked) diff --git a/mm/kmm_heap/kmm_malloc.c b/mm/kmm_heap/kmm_malloc.c index 06bed81c50..9f0e6e7949 100644 --- a/mm/kmm_heap/kmm_malloc.c +++ b/mm/kmm_heap/kmm_malloc.c @@ -56,7 +56,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_memalign.c b/mm/kmm_heap/kmm_memalign.c index 2ca1465bf0..9c0ba608ec 100644 --- a/mm/kmm_heap/kmm_memalign.c +++ b/mm/kmm_heap/kmm_memalign.c @@ -59,7 +59,7 @@ * alignment - Log2 byte alignment * size - Size (in bytes) of the new memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the re-allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_realloc.c b/mm/kmm_heap/kmm_realloc.c index 477e2b70b1..f06d6fa161 100644 --- a/mm/kmm_heap/kmm_realloc.c +++ b/mm/kmm_heap/kmm_realloc.c @@ -57,7 +57,7 @@ * oldmem - The old memory allocated * newsize - Size (in bytes) of the new memory region to be re-allocated. * - * Return Value: + * Returned Value: * The address of the re-allocated memory (NULL on failure to re-allocate) * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_sem.c b/mm/kmm_heap/kmm_sem.c index 2ba019f673..dc05bf78ed 100644 --- a/mm/kmm_heap/kmm_sem.c +++ b/mm/kmm_heap/kmm_sem.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ @@ -75,7 +75,7 @@ int kmm_trysemaphore(void) * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_zalloc.c b/mm/kmm_heap/kmm_zalloc.c index 19bea29f15..525ee8cb8d 100644 --- a/mm/kmm_heap/kmm_zalloc.c +++ b/mm/kmm_heap/kmm_zalloc.c @@ -56,7 +56,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/mm_heap/mm_initialize.c b/mm/mm_heap/mm_initialize.c index 7696676fde..becafc88a6 100644 --- a/mm/mm_heap/mm_initialize.c +++ b/mm/mm_heap/mm_initialize.c @@ -60,7 +60,7 @@ * heapstart - Start of the heap region * heapsize - Size of the heap region * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -145,7 +145,7 @@ void mm_addregion(FAR struct mm_heap_s *heap, FAR void *heapstart, * heapstart - Start of the initial heap region * heapsize - Size of the initial heap region * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/mm/shm/shmget.c b/mm/shm/shmget.c index 682b4707ed..c7701cbfc8 100644 --- a/mm/shm/shmget.c +++ b/mm/shm/shmget.c @@ -63,10 +63,10 @@ * Description: * Find the shared memory region with matching key * - * Input parameters: + * Input Parameters: * key - The value that uniquely identifies a shared memory region. * - * Returned value: + * Returned Value: * On success, an index in the range of 0 to CONFIG_ARCH_SHM_MAXREGIONS-1 * is returned to identify the matching region; -ENOENT is returned on * failure. @@ -94,10 +94,10 @@ static int shm_find(key_t key) * Description: * Allocate an unused shared memory region. That is one with a key of -1 * - * Input parameters: + * Input Parameters: * None * - * Returned value: + * Returned Value: * On success, an index in the range of 0 to CONFIG_ARCH_SHM_MAXREGIONS-1 * is returned to identify the matching region; -ENOSPC is returned on * failure. @@ -154,12 +154,12 @@ static int shm_reserve(key_t key, int shmflg) * Extend the size of a memory regions by allocating physical pages as * necessary * - * Input parameters: + * Input Parameters: * shmid - The index of the region of interest in the shared memory region * table. * size - The new size of the region. * - * Returned value: + * Returned Value: * Zero is returned on success; -ENOMEM is returned on failure. * (Should a different error be returned if the region is just too big?) * @@ -224,7 +224,7 @@ static int shm_extend(int shmid, size_t size) * Description: * Create the shared memory region. * - * Input parameters: + * Input Parameters: * key - The key that is used to access the unique shared memory * identifier. * size - The shared memory region that is created will be at least @@ -232,7 +232,7 @@ static int shm_extend(int shmid, size_t size) * shmflgs - See IPC_* definitions in sys/ipc.h. Only the values * IPC_PRIVATE or IPC_CREAT are supported. * - * Returned value: + * Returned Value: * Zero is returned on success; A negated errno value is returned on * failure. * diff --git a/mm/umm_heap/umm_addregion.c b/mm/umm_heap/umm_addregion.c index 00e5372ee8..9197cf3f33 100644 --- a/mm/umm_heap/umm_addregion.c +++ b/mm/umm_heap/umm_addregion.c @@ -59,7 +59,7 @@ * heap_start - Address of the beginning of the memory region * heap_size - The size (in bytes) if the memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/umm_heap/umm_initialize.c b/mm/umm_heap/umm_initialize.c index 04e045e073..55fc430fc1 100644 --- a/mm/umm_heap/umm_initialize.c +++ b/mm/umm_heap/umm_initialize.c @@ -89,7 +89,7 @@ * heap_start - Address of the beginning of the (initial) memory region * heap_size - The size (in bytes) if the (initial) memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/umm_heap/umm_malloc.c b/mm/umm_heap/umm_malloc.c index 7832af4e29..ddbb03a2c6 100644 --- a/mm/umm_heap/umm_malloc.c +++ b/mm/umm_heap/umm_malloc.c @@ -59,7 +59,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/umm_heap/umm_realloc.c b/mm/umm_heap/umm_realloc.c index a517aa200a..394a4e2cd2 100644 --- a/mm/umm_heap/umm_realloc.c +++ b/mm/umm_heap/umm_realloc.c @@ -59,7 +59,7 @@ * oldmem - The old memory allocated * newsize - Size (in bytes) of the new memory region to be re-allocated. * - * Return Value: + * Returned Value: * The address of the re-allocated memory (NULL on failure to re-allocate) * ****************************************************************************/ diff --git a/mm/umm_heap/umm_sem.c b/mm/umm_heap/umm_sem.c index a9012e542c..37b0fb42cd 100644 --- a/mm/umm_heap/umm_sem.c +++ b/mm/umm_heap/umm_sem.c @@ -58,7 +58,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ @@ -79,7 +79,7 @@ int umm_trysemaphore(void) * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ diff --git a/mm/umm_heap/umm_zalloc.c b/mm/umm_heap/umm_zalloc.c index 7103e3233b..6ce7fe14fb 100644 --- a/mm/umm_heap/umm_zalloc.c +++ b/mm/umm_heap/umm_zalloc.c @@ -59,7 +59,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/net/arp/arp.h b/net/arp/arp.h index 0fbea68c51..643c5a6093 100644 --- a/net/arp/arp.h +++ b/net/arp/arp.h @@ -374,7 +374,7 @@ void arp_notify(in_addr_t ipaddr); * Description: * Find the ARP entry corresponding to this IP address. * - * Input parameters: + * Input Parameters: * ipaddr - Refers to an IP address in network order * * Assumptions @@ -391,7 +391,7 @@ FAR struct arp_entry *arp_find(in_addr_t ipaddr); * Description: * Remove an IP association from the ARP table * - * Input parameters: + * Input Parameters: * ipaddr - Refers to an IP address in network order * * Assumptions @@ -416,7 +416,7 @@ FAR struct arp_entry *arp_find(in_addr_t ipaddr); * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * ipaddr - The IP address as an inaddr_t * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * @@ -438,7 +438,7 @@ int arp_update(in_addr_t ipaddr, FAR uint8_t *ethaddr); * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * pipaddr - Refers to an IP address uint16_t[2] in network order * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * diff --git a/net/arp/arp_table.c b/net/arp/arp_table.c index 928ed59019..d8818ddf39 100644 --- a/net/arp/arp_table.c +++ b/net/arp/arp_table.c @@ -129,7 +129,7 @@ void arp_timer(void) * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * ipaddr - The IP address as an inaddr_t * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * @@ -227,7 +227,7 @@ int arp_update(in_addr_t ipaddr, FAR uint8_t *ethaddr) * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * pipaddr - Refers to an IP address uint16_t[2] in network order * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * @@ -255,7 +255,7 @@ void arp_hdr_update(FAR uint16_t *pipaddr, FAR uint8_t *ethaddr) * Description: * Find the ARP entry corresponding to this IP address. * - * Input parameters: + * Input Parameters: * ipaddr - Refers to an IP address in network order * * Assumptions diff --git a/net/devif/devif.h b/net/devif/devif.h index 438e275f46..2eeb97f7f0 100644 --- a/net/devif/devif.h +++ b/net/devif/devif.h @@ -309,7 +309,7 @@ EXTERN systime_t g_polltime; * Parameters: * None * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -400,7 +400,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * Description: * Execute a list of callbacks. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -409,7 +409,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * flags - The bit set of events to be notified. * list - The list to traverse in performing the notifications * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: @@ -426,7 +426,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, FAR void *pvconn, * Description: * Execute a list of callbacks using the device event chain. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -434,7 +434,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, FAR void *pvconn, * connection or UDP port. * flags - The bit set of events to be notified. * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: diff --git a/net/devif/devif_callback.c b/net/devif/devif_callback.c index 92718b9798..e2261b750f 100644 --- a/net/devif/devif_callback.c +++ b/net/devif/devif_callback.c @@ -170,7 +170,7 @@ static void devif_callback_free(FAR struct net_driver_s *dev, * Return true if the current set of events should trigger a callback to * occur. * - * Input paramters: + * Input Parameters: * events - The set of events that has occurred. * triggers - The set of events that will trigger a callback. * @@ -402,7 +402,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * Description: * Execute a list of callbacks using the packet event chain. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -411,7 +411,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * flags - The bit set of events to be notified. * list - The list to traverse in performing the notifications * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: @@ -465,7 +465,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, void *pvconn, * Description: * Execute a list of callbacks using the device event chain. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -473,7 +473,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, void *pvconn, * connection or UDP port. * flags - The bit set of events to be notified. * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: diff --git a/net/devif/devif_initialize.c b/net/devif/devif_initialize.c index 244d7a1b6c..ecbe15479e 100644 --- a/net/devif/devif_initialize.c +++ b/net/devif/devif_initialize.c @@ -85,7 +85,7 @@ uint8_t g_reassembly_timer; * Parameters: * None * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/net/icmp/icmp.h b/net/icmp/icmp.h index 77aa832f8f..d17f5d1fbd 100644 --- a/net/icmp/icmp.h +++ b/net/icmp/icmp.h @@ -129,7 +129,7 @@ struct pollfd; /* Forward reference */ * dev - The device driver structure containing the received ICMP * packet * - * Return: + * Returned Value: * None * * Assumptions: @@ -235,7 +235,7 @@ FAR struct icmp_conn_s *icmp_findconn(FAR struct net_driver_s *dev, uint8_t id); * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmp/icmp_input.c b/net/icmp/icmp_input.c index 38937dad64..973b0326c1 100644 --- a/net/icmp/icmp_input.c +++ b/net/icmp/icmp_input.c @@ -89,7 +89,7 @@ * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * @@ -214,7 +214,7 @@ drop: * dev - The device driver structure containing the received ICMP * packet * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmp/icmp_poll.c b/net/icmp/icmp_poll.c index f86e3a6e14..190bc06744 100644 --- a/net/icmp/icmp_poll.c +++ b/net/icmp/icmp_poll.c @@ -62,7 +62,7 @@ * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmp/icmp_sendto.c b/net/icmp/icmp_sendto.c index 9ee74e000e..7c20668273 100644 --- a/net/icmp/icmp_sendto.c +++ b/net/icmp/icmp_sendto.c @@ -150,7 +150,7 @@ static inline int sendto_timeout(FAR struct icmp_sendto_s *pstate) * dev - The device driver structure to use in the send operation * pstate - Reference to an instance of the ICMP sendto state structure * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6.h b/net/icmpv6/icmpv6.h index 582712c5e5..f5bee4251e 100644 --- a/net/icmpv6/icmpv6.h +++ b/net/icmpv6/icmpv6.h @@ -158,7 +158,7 @@ struct pollfd; /* Forward reference */ * dev - The device driver structure containing the received ICMPv6 * packet * - * Return: + * Returned Value: * None * * Assumptions: @@ -214,7 +214,7 @@ int icmpv6_neighbor(const net_ipv6addr_t ipaddr); * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -236,7 +236,7 @@ void icmpv6_poll(FAR struct net_driver_s *dev); * dev - Reference to an Ethernet device driver structure * ipaddr - IP address of Neighbor to be solicited * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -261,7 +261,7 @@ void icmpv6_solicit(FAR struct net_driver_s *dev, * Parameters: * dev - Reference to an Ethernet device driver structure * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -280,7 +280,7 @@ void icmpv6_rsolicit(FAR struct net_driver_s *dev); * dev - The device driver structure containing the outgoing ICMPv6 packet * buffer * - * Return: + * Returned Value: * None. * * Assumptions: @@ -301,7 +301,7 @@ void icmpv6_advertise(FAR struct net_driver_s *dev, * dev - The device driver structure containing the outgoing ICMPv6 packet * buffer * - * Return: + * Returned Value: * None * * Assumptions: @@ -406,7 +406,7 @@ void icmpv6_notify(net_ipv6addr_t ipaddr); * Parameters: * dev - The device driver structure to assign the address to * - * Return: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * any failure. * diff --git a/net/icmpv6/icmpv6_advertise.c b/net/icmpv6/icmpv6_advertise.c index 37c8c8ebb9..e0a7d8a770 100644 --- a/net/icmpv6/icmpv6_advertise.c +++ b/net/icmpv6/icmpv6_advertise.c @@ -85,7 +85,7 @@ * dev - The device driver structure containing the outgoing ICMPv6 packet * buffer * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_autoconfig.c b/net/icmpv6/icmpv6_autoconfig.c index bb481224e2..3f1ea9d2a6 100644 --- a/net/icmpv6/icmpv6_autoconfig.c +++ b/net/icmpv6/icmpv6_autoconfig.c @@ -331,7 +331,7 @@ static int icmpv6_wait_radvertise(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure to assign the address to * - * Return: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * any failure. * diff --git a/net/icmpv6/icmpv6_input.c b/net/icmpv6/icmpv6_input.c index 66030ad901..42c2e8c55d 100644 --- a/net/icmpv6/icmpv6_input.c +++ b/net/icmpv6/icmpv6_input.c @@ -99,7 +99,7 @@ * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * @@ -221,7 +221,7 @@ drop: * dev - The device driver structure containing the received ICMPv6 * packet * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_poll.c b/net/icmpv6/icmpv6_poll.c index 145dd62e69..d6853ff4a6 100644 --- a/net/icmpv6/icmpv6_poll.c +++ b/net/icmpv6/icmpv6_poll.c @@ -63,7 +63,7 @@ * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_rsolicit.c b/net/icmpv6/icmpv6_rsolicit.c index 1ff49d712c..ba24bbeef1 100644 --- a/net/icmpv6/icmpv6_rsolicit.c +++ b/net/icmpv6/icmpv6_rsolicit.c @@ -84,7 +84,7 @@ * Parameters: * dev - Reference to an Ethernet device driver structure * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/net/icmpv6/icmpv6_sendto.c b/net/icmpv6/icmpv6_sendto.c index cbff44a3ea..8db6d370e7 100644 --- a/net/icmpv6/icmpv6_sendto.c +++ b/net/icmpv6/icmpv6_sendto.c @@ -150,7 +150,7 @@ static inline int sendto_timeout(FAR struct icmpv6_sendto_s *pstate) * dev - The device driver structure to use in the send operation * pstate - Reference to an instance of the ICMPv6 sendto state structure * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_solicit.c b/net/icmpv6/icmpv6_solicit.c index 7fa1a55d19..30fe57b266 100644 --- a/net/icmpv6/icmpv6_solicit.c +++ b/net/icmpv6/icmpv6_solicit.c @@ -94,7 +94,7 @@ static const uint16_t g_icmpv_mcastaddr[6] = * dev - Reference to an Ethernet device driver structure * ipaddr - IP address of Neighbor to be solicited * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/net/ieee802154/ieee802154.h b/net/ieee802154/ieee802154.h index bf60db0530..3dc1673507 100644 --- a/net/ieee802154/ieee802154.h +++ b/net/ieee802154/ieee802154.h @@ -268,7 +268,7 @@ FAR struct ieee802154_conn_s * * If there are multilple frames in the list, this metadata * must apply to all of the frames in the list. * - * Return: + * Returned Value: * OK The IEEE 802.15.4 has been processed and can be deleted * ERROR Hold the IEEE 802.15.4 and try again later. There is a listening * socket but no recv in place to catch the IEEE 802.15.4 yet. @@ -364,7 +364,7 @@ FAR struct radio_driver_s * * dev - The device driver structure to use in the send operation * conn - The IEEE 802.15.4 "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: @@ -413,10 +413,10 @@ ssize_t psock_ieee802154_sendto(FAR struct socket *psock, * be called early in the initialization sequence before any socket * activity. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -437,10 +437,10 @@ void ieee802154_container_initialize(void); * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated container structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -461,10 +461,10 @@ FAR struct ieee802154_container_s *ieee802154_container_allocate(void); * structure. If the container structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * container - container structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/ieee802154/ieee802154_container.c b/net/ieee802154/ieee802154_container.c index af70fe645d..88f01755de 100644 --- a/net/ieee802154/ieee802154_container.c +++ b/net/ieee802154/ieee802154_container.c @@ -82,10 +82,10 @@ static struct ieee802154_container_s * be called early in the initialization sequence before any socket * activity. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -127,10 +127,10 @@ void ieee802154_container_initialize(void) * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated container structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -185,10 +185,10 @@ FAR struct ieee802154_container_s *ieee802154_container_allocate(void) * structure. If the container structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * container - container structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/ieee802154/ieee802154_input.c b/net/ieee802154/ieee802154_input.c index 1d50451cc3..57f32eaf70 100644 --- a/net/ieee802154/ieee802154_input.c +++ b/net/ieee802154/ieee802154_input.c @@ -64,7 +64,7 @@ * Parameters: * conn - The socket connection structure. * - * Return: + * Returned Value: * The number of frames in the queue. * ****************************************************************************/ @@ -96,7 +96,7 @@ static int ieee802154_count_frames(FAR struct ieee802154_conn_s *conn) * framel - A single frame to add to the RX queue. * meta - Meta data characterizing the received frane. * - * Return: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * any failure. * @@ -227,7 +227,7 @@ static int ieee802154_queue_frame(FAR struct ieee802154_conn_s *conn, * If there are multilple frames in the list, this metadata * must apply to all of the frames in the list. * - * Return: + * Returned Value: * OK The IEEE 802.15.4 has been processed and can be deleted * ERROR Hold the IEEE 802.15.4 and try again later. There is a listening * socket but no recv in place to catch the IEEE 802.15.4 yet. diff --git a/net/ieee802154/ieee802154_poll.c b/net/ieee802154/ieee802154_poll.c index 0d313e0e4b..fb33ea1bbb 100644 --- a/net/ieee802154/ieee802154_poll.c +++ b/net/ieee802154/ieee802154_poll.c @@ -64,7 +64,7 @@ * dev - The device driver structure to use in the send operation * conn - The packet "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/ieee802154/ieee802154_recvfrom.c b/net/ieee802154/ieee802154_recvfrom.c index 2e47f18fb7..7ee3c7d041 100644 --- a/net/ieee802154/ieee802154_recvfrom.c +++ b/net/ieee802154/ieee802154_recvfrom.c @@ -91,7 +91,7 @@ struct ieee802154_recvfrom_s * Parameters: * conn - The socket connection structure. * - * Return: + * Returned Value: * The number of frames in the queue. * ****************************************************************************/ @@ -121,7 +121,7 @@ static int ieee802154_count_frames(FAR struct ieee802154_conn_s *conn) * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * The network is lockec @@ -209,7 +209,7 @@ static ssize_t ieee802154_recvfrom_rxqueue(FAR struct radio_driver_s *radio, * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * The network is locked. diff --git a/net/ieee802154/ieee802154_sendto.c b/net/ieee802154/ieee802154_sendto.c index 2c2c79e5b1..47657ac1f9 100644 --- a/net/ieee802154/ieee802154_sendto.c +++ b/net/ieee802154/ieee802154_sendto.c @@ -96,7 +96,7 @@ struct ieee802154_sendto_s * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * addr - The address to check * addrlen - The length of the address in bytes * @@ -125,7 +125,7 @@ static bool ieee802154_anyaddrnull(FAR const uint8_t *addr, uint8_t addrlen) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The short address to check * * Returned Value: @@ -145,7 +145,7 @@ static inline bool ieee802154_saddrnull(FAR const uint8_t *saddr) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The extended address to check * * Returned Value: diff --git a/net/igmp/igmp.h b/net/igmp/igmp.h index 4850bd511e..eef6cad00b 100644 --- a/net/igmp/igmp.h +++ b/net/igmp/igmp.h @@ -247,7 +247,7 @@ void igmp_poll(FAR struct net_driver_s *dev); * message to be sent. * destipaddr - The IP address of the recipient of the message * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/igmp/igmp_send.c b/net/igmp/igmp_send.c index 3a28cccc8c..e6941d7f2b 100644 --- a/net/igmp/igmp_send.c +++ b/net/igmp/igmp_send.c @@ -106,7 +106,7 @@ static uint16_t igmp_chksum(FAR uint8_t *buffer, int buflen) * message to be sent. * destipaddr - The IP address of the recipient of the message * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/ipforward/ipv6_forward.c b/net/ipforward/ipv6_forward.c index b2fea28f4a..4250692d89 100644 --- a/net/ipforward/ipv6_forward.c +++ b/net/ipforward/ipv6_forward.c @@ -187,7 +187,7 @@ static int ipv6_decr_ttl(FAR struct ipv6_hdr_s *ipv6) * but this is a point where support for other conversions may be * provided. * - * Returned value: + * Returned Value: * PACKET_FORWARDED - Packet was forwarded * PACKET_NOT_FORWARDED - Packet was not forwarded * < 0 - And error occurred (and packet not fowarded). diff --git a/net/local/local.h b/net/local/local.h index b4ccfd9a8a..f49d399bf5 100644 --- a/net/local/local.h +++ b/net/local/local.h @@ -375,7 +375,7 @@ int local_accept(FAR struct socket *psock, FAR struct sockaddr *addr, * len Length of data to send * flags Send flags (ignored for now) * - * Return: + * Returned Value: * On success, returns the number of characters sent. On error, * -1 is returned, and errno is set appropriately (see send() for the * list of errno numbers). @@ -429,7 +429,7 @@ ssize_t psock_local_sendto(FAR struct socket *psock, FAR const void *buf, * buf Data to send * len Length of data to send * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. * @@ -482,7 +482,7 @@ ssize_t local_recvfrom(FAR struct socket *psock, FAR void *buf, * len - Length of data to receive [in] * Length of data actually received [out] * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. If -ECONNRESET is received, then the sending side has closed * the FIFO. In this case, the returned data may still be valid (if the @@ -504,7 +504,7 @@ int local_fifo_read(FAR struct file *filep, FAR uint8_t *buf, size_t *len); * addrlen - The size of the memory allocat by the caller to receive the * address. * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -521,7 +521,7 @@ int local_getaddr(FAR struct local_conn_s *conn, FAR struct sockaddr *addr, * Parameters: * filep - File structure of write-only FIFO. * - * Return: + * Returned Value: * The non-zero size of the following packet is returned on success; a * negated errno value is returned on any failure. * diff --git a/net/local/local_connect.c b/net/local/local_connect.c index 9a875b314b..28215e67f6 100644 --- a/net/local/local_connect.c +++ b/net/local/local_connect.c @@ -117,7 +117,7 @@ static inline void _local_semtake(sem_t *sem) * Find a local connection structure that is the appropriate "server" * connection to be used with the provided "client" connection. * - * Returned Values: + * Returned Value: * Zero (OK) returned on success; A negated errno value is returned on a * failure. Possible failures include: * @@ -250,7 +250,7 @@ errout_with_fifos: * Find a local connection structure that is the appropriate "server" * connection to be used with the provided "client" connection. * - * Returned Values: + * Returned Value: * Zero (OK) returned on success; A negated errno value is returned on a * failure. Possible failures include: * diff --git a/net/local/local_recvutils.c b/net/local/local_recvutils.c index 91e185754f..798107e534 100644 --- a/net/local/local_recvutils.c +++ b/net/local/local_recvutils.c @@ -69,7 +69,7 @@ * len - Length of data to receive [in] * Length of data actually received [out] * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. If -ECONNRESET is received, then the sending side has closed * the FIFO. In this case, the returned data may still be valid (if the @@ -133,7 +133,7 @@ errout: * Parameters: * filep - File structure of write-only FIFO. * - * Return: + * Returned Value: * The non-zero size of the following packet is returned on success; a * negated errno value is returned on any failure. * @@ -201,7 +201,7 @@ int local_sync(FAR struct file *filep) * addrlen - The size of the memory allocated by the caller to receive the * address. * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/net/local/local_send.c b/net/local/local_send.c index a305dac441..6f170ba0a2 100644 --- a/net/local/local_send.c +++ b/net/local/local_send.c @@ -66,7 +66,7 @@ * len Length of data to send * flags Send flags (ignored for now) * - * Return: + * Returned Value: * On success, returns the number of characters sent. On error, * -1 is returned, and errno is set appropriately (see send() for the * list of errno numbers). diff --git a/net/local/local_sendpacket.c b/net/local/local_sendpacket.c index fad305fd0b..8a4fcae61c 100644 --- a/net/local/local_sendpacket.c +++ b/net/local/local_sendpacket.c @@ -83,7 +83,7 @@ static const uint8_t g_preamble[LOCAL_PREAMBLE_SIZE] = * buf Data to send * len Length of data to send * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. * @@ -133,7 +133,7 @@ static int local_fifo_write(FAR struct file *filep, FAR const uint8_t *buf, * buf Data to send * len Length of data to send * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. * diff --git a/net/netdev/netdev_ioctl.c b/net/netdev/netdev_ioctl.c index e4b1e13a46..9fdb2f1e8c 100644 --- a/net/netdev/netdev_ioctl.c +++ b/net/netdev/netdev_ioctl.c @@ -382,7 +382,7 @@ static void ioctl_set_ipv6addr(FAR net_ipv6addr_t outaddr, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -444,7 +444,7 @@ static int netdev_iee802154_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -507,7 +507,7 @@ static int netdev_pktradio_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -548,7 +548,7 @@ static int netdev_wifr_ioctl(FAR struct socket *psock, int cmd, * Parameters: * req - The argument of the ioctl cmd * - * Return: + * Returned Value: * A pointer to the driver structure on success; NULL on failure. * ****************************************************************************/ @@ -578,7 +578,7 @@ static FAR struct net_driver_s *netdev_ifr_dev(FAR struct ifreq *req) * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1030,7 +1030,7 @@ static int netdev_ifr_ioctl(FAR struct socket *psock, int cmd, * Parameters: * req - The argument of the ioctl cmd * - * Return: + * Returned Value: * A pointer to the driver structure on success; NULL on failure. * ****************************************************************************/ @@ -1063,7 +1063,7 @@ static FAR struct net_driver_s *netdev_imsfdev(FAR struct ip_msfilter *imsf) * cmd The ioctl command * imsf The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1122,7 +1122,7 @@ static int netdev_imsf_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1245,7 +1245,7 @@ static int netdev_arp_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * rtentry The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1359,7 +1359,7 @@ static int netdev_rt_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * @@ -1469,7 +1469,7 @@ int psock_ioctl(FAR struct socket *psock, int cmd, unsigned long arg) * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * diff --git a/net/pkt/pkt.h b/net/pkt/pkt.h index 2351e91192..f4bcfca1e6 100644 --- a/net/pkt/pkt.h +++ b/net/pkt/pkt.h @@ -193,7 +193,7 @@ uint16_t pkt_callback(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure containing the received packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR There is a matching connection, but could not dispatch the packet * yet. Useful when a packet arrives before a recv call is in @@ -267,7 +267,7 @@ FAR struct net_driver_s *pkt_find_device(FAR struct pkt_conn_s *conn); * dev - The device driver structure to use in the send operation * conn - The packet "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/pkt/pkt_input.c b/net/pkt/pkt_input.c index e4ba86c2d1..4676426f12 100644 --- a/net/pkt/pkt_input.c +++ b/net/pkt/pkt_input.c @@ -73,7 +73,7 @@ * Parameters: * dev - The device driver structure containing the received packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR There is a matching connection, but could not dispatch the packet * yet. Useful when a packet arrives before a recv call is in diff --git a/net/pkt/pkt_poll.c b/net/pkt/pkt_poll.c index 272de209f3..7fdb76d036 100644 --- a/net/pkt/pkt_poll.c +++ b/net/pkt/pkt_poll.c @@ -68,7 +68,7 @@ * dev - The device driver structure to use in the send operation * conn - The packet "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/pkt/pkt_recvfrom.c b/net/pkt/pkt_recvfrom.c index ae801d07bb..137fd5f647 100644 --- a/net/pkt/pkt_recvfrom.c +++ b/net/pkt/pkt_recvfrom.c @@ -159,7 +159,7 @@ static void pkt_recvfrom_newdata(FAR struct net_driver_s *dev, * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * @@ -177,7 +177,7 @@ static inline void pkt_recvfrom_sender(FAR struct net_driver_s *dev, * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * diff --git a/net/sixlowpan/sixlowpan.h b/net/sixlowpan/sixlowpan.h index 4d0ba44685..7760e47e58 100644 --- a/net/sixlowpan/sixlowpan.h +++ b/net/sixlowpan/sixlowpan.h @@ -86,7 +86,7 @@ void sixlowpan_initialize(void); * psock_6lowpan_tcp_send() call may be used only when the TCP socket is in a * connected state (so that the intended recipient is known). * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * len - Length of data to send @@ -126,7 +126,7 @@ ssize_t psock_6lowpan_tcp_send(FAR struct socket *psock, FAR const void *buf, * driver. Under those conditions, this function will be called to create * the IEEE80215.4 frames. * - * Input Parmeters + * Input Parameters: * dev - The network device containing the packet to be sent. * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets @@ -159,7 +159,7 @@ void sixlowpan_tcp_send(FAR struct net_driver_s *dev, * * Both cases are handled here. * - * Input Parmeters + * Input Parameters: * dev - The network device containing the packet to be sent. * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets @@ -189,7 +189,7 @@ void sixlowpan_icmpv6_send(FAR struct net_driver_s *dev, * psock_6lowpan_udp_send() call may be used with connectionlesss UDP * sockets. * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * len - Length of data to send @@ -219,7 +219,7 @@ ssize_t psock_6lowpan_udp_send(FAR struct socket *psock, FAR const void *buf, * may be returned when they are not NULL and 0), and the error ENOTCONN is * returned when the socket was not actually connected. * - * Input Parmeters + * Input Parameters: * psock A pointer to a NuttX-specific, internal socket structure * buf Data to send * len Length of data to send @@ -251,7 +251,7 @@ ssize_t psock_6lowpan_udp_sendto(FAR struct socket *psock, * Handles forwarding a UDP packet via 6LoWPAN. This is currently only * used by the IPv6 forwarding logic. * - * Input Parmeters + * Input Parameters: * dev - An instance of nework device state structure * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_framelist.c b/net/sixlowpan/sixlowpan_framelist.c index 545bea004a..d69e007a1f 100644 --- a/net/sixlowpan/sixlowpan_framelist.c +++ b/net/sixlowpan/sixlowpan_framelist.c @@ -199,7 +199,7 @@ static uint16_t sixlowpan_protosize(FAR const struct ipv6_hdr_s *ipv6hdr, * destmac - The IEEE802.15.4 MAC address of the destination * meta - Location to return the final metadata. * - * Returned value + * Returned Value: * OK is returned on success; Othewise a negated errno value is returned. * ****************************************************************************/ @@ -298,7 +298,7 @@ static int sixlowpan_ieee802154_metadata(FAR struct radio_driver_s *radio, * destmac - The radio-specific MAC address of the destination * meta - Location to return the final metadata. * - * Returned value + * Returned Value: * OK is returned on success; Othewise a negated errno value is returned. * ****************************************************************************/ diff --git a/net/sixlowpan/sixlowpan_framer.c b/net/sixlowpan/sixlowpan_framer.c index 666c6a3adf..023d59f83f 100644 --- a/net/sixlowpan/sixlowpan_framer.c +++ b/net/sixlowpan/sixlowpan_framer.c @@ -64,7 +64,7 @@ * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * addr - The address to check * addrlen - The length of the address in bytes * @@ -93,7 +93,7 @@ static bool sixlowpan_anyaddrnull(FAR const uint8_t *addr, uint8_t addrlen) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The short address to check * * Returned Value: @@ -113,7 +113,7 @@ static inline bool sixlowpan_saddrnull(FAR const uint8_t *saddr) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The extended address to check * * Returned Value: @@ -247,7 +247,7 @@ int sixlowpan_meta_data(FAR struct radio_driver_s *radio, * determine what the size of the IEEE802.15.4 header will be. No frame * buffer is required to make this determination. * - * Input parameters: + * Input Parameters: * radio - A reference IEEE802.15.4 MAC network device structure. * meta - Meta data that describes the MAC header * @@ -272,7 +272,7 @@ int sixlowpan_frame_hdrlen(FAR struct radio_driver_s *radio, * new incoming frame and the network responds with an outgoing packet. It * submits any new outgoing frame to the MAC. * - * Input parameters: + * Input Parameters: * radio - A reference to a radio network device instance. * meta - Meta data that describes the MAC header * frame - The IOB containing the frame to be submitted. diff --git a/net/sixlowpan/sixlowpan_hc06.c b/net/sixlowpan/sixlowpan_hc06.c index c9e05410e1..204cf69cbc 100644 --- a/net/sixlowpan/sixlowpan_hc06.c +++ b/net/sixlowpan/sixlowpan_hc06.c @@ -1078,7 +1078,7 @@ int sixlowpan_compresshdr_hc06(FAR struct radio_driver_s *radio, * decompression, g_frame_hdrlen and g_uncompressed_hdrlen are set to the * appropriate values * - * Input Parmeters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Obfuscated MAC metadata including node addressing * information. diff --git a/net/sixlowpan/sixlowpan_hc1.c b/net/sixlowpan/sixlowpan_hc1.c index 977c268cab..ffbc479edf 100644 --- a/net/sixlowpan/sixlowpan_hc1.c +++ b/net/sixlowpan/sixlowpan_hc1.c @@ -108,7 +108,7 @@ * | src p.| dst p.| UDP checksum | L4 data... * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * - * Input Parmeters: + * Input Parameters: * radio - A reference to a radio network device instance * ipv6 - The IPv6 header followd by TCP, UDP, or ICMPv6 header to be * compressed diff --git a/net/sixlowpan/sixlowpan_icmpv6send.c b/net/sixlowpan/sixlowpan_icmpv6send.c index e62c617ed1..a4ef1dc79a 100644 --- a/net/sixlowpan/sixlowpan_icmpv6send.c +++ b/net/sixlowpan/sixlowpan_icmpv6send.c @@ -63,7 +63,7 @@ * Handles forwarding a ICMPv6 packet via 6LoWPAN. This is currently only * used by the IPv6 forwarding logic. * - * Input Parmeters + * Input Parameters: * dev - An instance of nework device state structure * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_input.c b/net/sixlowpan/sixlowpan_input.c index e64becd9c1..50a757a604 100644 --- a/net/sixlowpan/sixlowpan_input.c +++ b/net/sixlowpan/sixlowpan_input.c @@ -597,7 +597,7 @@ errout_with_reass: * Description: * Inject the packet in d_buf into the network for normal packet processing. * - * Input Parmeters + * Input Parameters: * radio - The IEEE802.15.4 MAC network driver interface. * * Returned Value: diff --git a/net/sixlowpan/sixlowpan_internal.h b/net/sixlowpan/sixlowpan_internal.h index 7e527dae0d..e07e401549 100644 --- a/net/sixlowpan/sixlowpan_internal.h +++ b/net/sixlowpan/sixlowpan_internal.h @@ -319,7 +319,7 @@ int sixlowpan_meta_data(FAR struct radio_driver_s *radio, * determine what the size of the IEEE802.15.4 header will be. No frame * buffer is required to make this determination. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * meta - obfuscated meta data that describes the MAC header * @@ -341,7 +341,7 @@ int sixlowpan_frame_hdrlen(FAR struct radio_driver_s *radio, * new incoming frame and the network responds with an outgoing packet. It * submits any new outgoing frame to the MAC. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * meta - Obfuscated metadata that describes the MAC header * frame - The IOB containing the frame to be submitted. @@ -471,7 +471,7 @@ int sixlowpan_compresshdr_hc06(FAR struct radio_driver_s *radio, * decompression, g_frame_hdrlen and g_uncompressed_hdrlen are set to the * appropriate values * - * Input Parmeters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Obfuscated MAC metadata including node addressing * information. @@ -506,7 +506,7 @@ void sixlowpan_uncompresshdr_hc06(FAR struct radio_driver_s *radio, * 6lowpan packet in the packetbuf buffer from a full IPv6 packet in the * uip_buf buffer. * - * Input Parmeters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * ipv6 - The IPv6 header to be compressed * destmac - L2 destination address, needed to compress the IP @@ -629,7 +629,7 @@ bool sixlowpan_ismacbased(const net_ipv6addr_t ipaddr, * Description: * Get the maximum frame length supported by radio network drvier. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * * Returned Value: @@ -646,7 +646,7 @@ int sixlowpan_radio_framelen(FAR struct radio_driver_s *radio); * Description: * Get the source PAN ID from the IEEE802.15.4 radio. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * panid - The location in which to return the PAN ID. 0xfff may be * returned if the device is not associated. @@ -668,7 +668,7 @@ int sixlowpan_src_panid(FAR struct radio_driver_s *radio, * Extract the source MAC address from the radio-specific RX metadata, and * return the source address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * srcaddr - The location in which to return the source MAC address. @@ -689,7 +689,7 @@ int sixlowpan_extract_srcaddr(FAR struct radio_driver_s *radio, * Extract the destination MAC address from the radio-specific RX metadata, * and return the destination address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * destaddr - The location in which to return the destination MAC address. @@ -713,10 +713,10 @@ int sixlowpan_extract_destaddr(FAR struct radio_driver_s *radio, * * Called only once during network initialization. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -734,11 +734,11 @@ void sixlowpan_reass_initialize(void); * list. If that the list is empty, then the reassembly buffer structure * will be allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag for subsequent lookup. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the allocated reass structure. All fields used by the * reasembly logic have been zeroed. On a failure to allocate, NULL is * returned. @@ -759,11 +759,11 @@ FAR struct sixlowpan_reassbuf_s * * Find a previously allocated, active reassembly buffer with the specified * reassembly tag. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag to match. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the matching reass structure. * * Assumptions: @@ -784,10 +784,10 @@ FAR struct sixlowpan_reassbuf_s * * structure. If the reass structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * reass - reass structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/sixlowpan/sixlowpan_reassbuf.c b/net/sixlowpan/sixlowpan_reassbuf.c index c3ae7eeb80..13b57fa0b9 100644 --- a/net/sixlowpan/sixlowpan_reassbuf.c +++ b/net/sixlowpan/sixlowpan_reassbuf.c @@ -121,10 +121,10 @@ static bool sixlowpan_compare_fragsrc(FAR struct sixlowpan_reassbuf_s *reass, * Description: * Free all expired or inactive reassembly buffers. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -177,10 +177,10 @@ static void sixlowpan_reass_expire(void) * Description: * Remove a reassembly buffer from the active reassembly buffer list. * - * Inputs: + * Input Parameters: * reass - The reassembly buffer to be removed. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -234,10 +234,10 @@ static void sixlowpan_remove_active(FAR struct sixlowpan_reassbuf_s *reass) * * Called only once during network initialization. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -276,11 +276,11 @@ void sixlowpan_reass_initialize(void) * list. If that the list is empty, then the reassembly buffer structure * will be allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag for subsequent lookup. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the allocated reass structure. All fields used by the * reasembly logic have been zeroed. On a failure to allocate, NULL is * returned. @@ -355,11 +355,11 @@ FAR struct sixlowpan_reassbuf_s * * Find a previously allocated, active reassembly buffer with the specified * reassembly tag. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag to match. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the matching reass structure. * * Assumptions: @@ -411,10 +411,10 @@ FAR struct sixlowpan_reassbuf_s * * structure. If the reass structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * reass - reass structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/sixlowpan/sixlowpan_send.c b/net/sixlowpan/sixlowpan_send.c index b8fceb8958..3deb9d5b1c 100644 --- a/net/sixlowpan/sixlowpan_send.c +++ b/net/sixlowpan/sixlowpan_send.c @@ -141,7 +141,7 @@ static inline bool send_timeout(FAR struct sixlowpan_send_s *sinfo) * This function is called from the interrupt level to perform the actual * send operation when polled by the lower, device interfacing layer. * - * Input Parmeters + * Input Parameters: * dev - The structure of the network driver that caused the interrupt * conn - The connection structure associated with the socket * flags - Set of events describing why the callback was invoked diff --git a/net/sixlowpan/sixlowpan_tcpsend.c b/net/sixlowpan/sixlowpan_tcpsend.c index df7eab7971..bc2085c498 100644 --- a/net/sixlowpan/sixlowpan_tcpsend.c +++ b/net/sixlowpan/sixlowpan_tcpsend.c @@ -178,7 +178,7 @@ static uint16_t sixlowpan_tcp_chksum(FAR const struct ipv6tcp_hdr_s *ipv6tcp, * Description: * sixlowpan_tcp_header() will construct the IPv6 and TCP headers * - * Input Parmeters + * Input Parameters: * conn - An instance of the TCP connection structure. * dev - The network device that will route the packet * buf - Data to send @@ -328,7 +328,7 @@ static inline bool send_timeout(FAR struct sixlowpan_send_s *sinfo) * This function is called from the interrupt level to perform the actual * TCP send operation when polled by the lower, device interfacing layer. * - * Input Parmeters + * Input Parameters: * dev - The structure of the network driver that caused the interrupt * pvconn - The connection structure associated with the socket * pvpriv - The interrupt handler's private data argument @@ -745,7 +745,7 @@ static int sixlowpan_send_packet(FAR struct socket *psock, * psock_6lowpan_tcp_send() call may be used only when the TCP socket is in a * connected state (so that the intended recipient is known). * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * bulen - Length of data to send @@ -898,7 +898,7 @@ ssize_t psock_6lowpan_tcp_send(FAR struct socket *psock, FAR const void *buf, * driver. Under those conditions, this function will be called to create * the IEEE80215.4 frames. * - * Input Parmeters + * Input Parameters: * dev - The network device containing the packet to be sent. * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_udpsend.c b/net/sixlowpan/sixlowpan_udpsend.c index e2f115eb09..6f99f31b7c 100644 --- a/net/sixlowpan/sixlowpan_udpsend.c +++ b/net/sixlowpan/sixlowpan_udpsend.c @@ -136,7 +136,7 @@ static uint16_t sixlowpan_udp_chksum(FAR const struct ipv6udp_hdr_s *ipv6udp, * may be returned when they are not NULL and 0), and the error ENOTCONN is * returned when the socket was not actually connected. * - * Input Parmeters + * Input Parameters: * psock A pointer to a NuttX-specific, internal socket structure * buf Data to send * buflen Length of data to send @@ -337,7 +337,7 @@ ssize_t psock_6lowpan_udp_sendto(FAR struct socket *psock, * psock_6lowpan_udp_send() call may be used with connectionlesss UDP * sockets. * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * buflen - Length of data to send @@ -413,7 +413,7 @@ ssize_t psock_6lowpan_udp_send(FAR struct socket *psock, FAR const void *buf, * Handles forwarding a UDP packet via 6LoWPAN. This is currently only * used by the IPv6 forwarding logic. * - * Input Parmeters + * Input Parameters: * dev - An instance of nework device state structure * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_utils.c b/net/sixlowpan/sixlowpan_utils.c index 696503b5a9..644ad1484e 100644 --- a/net/sixlowpan/sixlowpan_utils.c +++ b/net/sixlowpan/sixlowpan_utils.c @@ -573,7 +573,7 @@ bool sixlowpan_ismacbased(const net_ipv6addr_t ipaddr, * Description: * Get the maximum frame length supported by radio network drvier. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * * Returned Value: @@ -607,7 +607,7 @@ int sixlowpan_radio_framelen(FAR struct radio_driver_s *radio) * Description: * Get the source PAN ID from the IEEE802.15.4 MAC layer. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * panid - The location in which to return the PAN ID. 0xfff may be * returned if the device is not associated. @@ -647,7 +647,7 @@ int sixlowpan_src_panid(FAR struct radio_driver_s *radio, * Extract the source MAC address from the radio-specific RX metadata, and * return the source address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * srcaddr - The location in which to return the source MAC address. @@ -714,7 +714,7 @@ int sixlowpan_extract_srcaddr(FAR struct radio_driver_s *radio, * Extract the destination MAC address from the radio-specific RX metadata, * and return the destination address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * destaddr - The location in which to return the destination MAC address. diff --git a/net/tcp/tcp.h b/net/tcp/tcp.h index bfd402c00a..13ab0d803d 100644 --- a/net/tcp/tcp.h +++ b/net/tcp/tcp.h @@ -480,7 +480,7 @@ FAR struct tcp_conn_s *tcp_alloc_accept(FAR struct net_driver_s *dev, * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: @@ -727,7 +727,7 @@ void tcp_nextsequence(void); * dev - The device driver structure to use in the send operation * conn - The TCP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: @@ -748,7 +748,7 @@ void tcp_poll(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn); * conn - The TCP "connection" to poll for TX data * hsec - The polling interval in halves of a second * - * Return: + * Returned Value: * None * * Assumptions: @@ -859,7 +859,7 @@ int tcp_accept_connection(FAR struct net_driver_s *dev, * flags - flags to apply to the TCP header * len - length of the message * - * Return: + * Returned Value: * None * * Assumptions: @@ -904,7 +904,7 @@ ssize_t tcp_sendfile(FAR struct socket *psock, FAR struct file *infile, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -925,7 +925,7 @@ void tcp_reset(FAR struct net_driver_s *dev); * conn - The TCP connection structure holding connection information * ack - The ACK response to send * - * Return: + * Returned Value: * None * * Assumptions: @@ -949,7 +949,7 @@ void tcp_ack(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: @@ -971,7 +971,7 @@ void tcp_appsend(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: @@ -991,7 +991,7 @@ void tcp_rexmit(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: @@ -1012,7 +1012,7 @@ void tcp_ipv4_input(FAR struct net_driver_s *dev); * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: @@ -1053,7 +1053,7 @@ uint16_t tcp_callback(FAR struct net_driver_s *dev, * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * @@ -1320,7 +1320,7 @@ void tcp_wrbuffer_initialize(void); * the free list. This function is called from TCP logic when a buffer * of TCP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: diff --git a/net/tcp/tcp_appsend.c b/net/tcp/tcp_appsend.c index 7ee1f06779..b87c679b6e 100644 --- a/net/tcp/tcp_appsend.c +++ b/net/tcp/tcp_appsend.c @@ -72,7 +72,7 @@ * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: @@ -197,7 +197,7 @@ void tcp_appsend(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_callback.c b/net/tcp/tcp_callback.c index dcc16927b9..a43af2fb90 100644 --- a/net/tcp/tcp_callback.c +++ b/net/tcp/tcp_callback.c @@ -218,7 +218,7 @@ uint16_t tcp_callback(FAR struct net_driver_s *dev, * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * diff --git a/net/tcp/tcp_conn.c b/net/tcp/tcp_conn.c index 43282501ea..0c125d4717 100644 --- a/net/tcp/tcp_conn.c +++ b/net/tcp/tcp_conn.c @@ -243,7 +243,7 @@ static FAR struct tcp_conn_s * * portno -- the selected port number in host order. Zero means no port * selected. * - * Return: + * Returned Value: * Selected or verified port number in host order on success, a negated * errno on failure: * @@ -445,7 +445,7 @@ static inline FAR struct tcp_conn_s * * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: @@ -510,7 +510,7 @@ static inline int tcp_ipv4_bind(FAR struct tcp_conn_s *conn, * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: @@ -1039,7 +1039,7 @@ FAR struct tcp_conn_s *tcp_alloc_accept(FAR struct net_driver_s *dev, * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: diff --git a/net/tcp/tcp_devpoll.c b/net/tcp/tcp_devpoll.c index ee00d7f7d1..8097f442f4 100644 --- a/net/tcp/tcp_devpoll.c +++ b/net/tcp/tcp_devpoll.c @@ -70,7 +70,7 @@ * dev - The device driver structure to use in the send operation * conn - The TCP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_input.c b/net/tcp/tcp_input.c index b78a819fc0..015374aa2c 100644 --- a/net/tcp/tcp_input.c +++ b/net/tcp/tcp_input.c @@ -76,7 +76,7 @@ * domain - IP domain (PF_INET or PF_INET6) * iplen - Lngth of the IP header (IPv4_HDRLEN or IPv6_HDRLEN). * - * Return: + * Returned Value: * None * * Assumptions: @@ -947,7 +947,7 @@ drop: * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: @@ -977,7 +977,7 @@ void tcp_ipv4_input(FAR struct net_driver_s *dev) * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_send.c b/net/tcp/tcp_send.c index b4e833aa9b..def99b137f 100644 --- a/net/tcp/tcp_send.c +++ b/net/tcp/tcp_send.c @@ -86,7 +86,7 @@ * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * The length of the IP header (IPv4_HDRLEN or IPv6_HDRLEN) * ****************************************************************************/ @@ -122,7 +122,7 @@ static inline FAR struct tcp_hdr_s *tcp_header(FAR struct net_driver_s *dev) * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -190,7 +190,7 @@ static inline void tcp_ipv4_sendcomplete(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -253,7 +253,7 @@ static inline void tcp_ipv6_sendcomplete(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -301,7 +301,7 @@ static void tcp_sendcomplete(FAR struct net_driver_s *dev, * dev - The device driver structure to use in the send operation * conn - The TCP connection structure holding connection information * - * Return: + * Returned Value: * None * * Assumptions: @@ -403,7 +403,7 @@ static void tcp_sendcommon(FAR struct net_driver_s *dev, * len - length of the message (includes the length of the IP and TCP * headers) * - * Return: + * Returned Value: * None * * Assumptions: @@ -431,7 +431,7 @@ void tcp_send(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -548,7 +548,7 @@ void tcp_reset(FAR struct net_driver_s *dev) * conn - The TCP connection structure holding connection information * ack - The ACK response to send * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_timer.c b/net/tcp/tcp_timer.c index b5f5ffb5ab..a5812140f3 100644 --- a/net/tcp/tcp_timer.c +++ b/net/tcp/tcp_timer.c @@ -72,7 +72,7 @@ * conn - The TCP "connection" to poll for TX data * hsed - The polling interval in halves of a second * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_wrbuffer.c b/net/tcp/tcp_wrbuffer.c index 6553d34f20..643d990708 100644 --- a/net/tcp/tcp_wrbuffer.c +++ b/net/tcp/tcp_wrbuffer.c @@ -125,7 +125,7 @@ void tcp_wrbuffer_initialize(void) * the free list. This function is called from TCP logic when a buffer * of TCP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: diff --git a/net/udp/udp.h b/net/udp/udp.h index 24be51dc21..315c0bfed0 100644 --- a/net/udp/udp.h +++ b/net/udp/udp.h @@ -301,7 +301,7 @@ void udp_ipv6_select(FAR struct net_driver_s *dev); * dev - The device driver structure to use in the send operation * conn - The UDP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: @@ -321,7 +321,7 @@ void udp_poll(FAR struct net_driver_s *dev, FAR struct udp_conn_s *conn); * dev - The device driver structure to use in the send operation * conn - The UDP "connection" structure holding port information * - * Return: + * Returned Value: * None * * Assumptions: @@ -354,7 +354,7 @@ void udp_wrbuffer_initialize(void); * the free list. This function is called from UDP logic when a buffer * of UDP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: @@ -426,7 +426,7 @@ void udp_wrbuffer_dump(FAR const char *msg, FAR struct udp_wrbuffer_s *wrb, * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. @@ -449,7 +449,7 @@ int udp_ipv4_input(FAR struct net_driver_s *dev); * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. diff --git a/net/udp/udp_conn.c b/net/udp/udp_conn.c index 61e67028f6..d301b36543 100644 --- a/net/udp/udp_conn.c +++ b/net/udp/udp_conn.c @@ -203,7 +203,7 @@ static FAR struct udp_conn_s *udp_find_conn(uint8_t domain, * Input Parameters: * None * - * Return: + * Returned Value: * Next available port number * ****************************************************************************/ diff --git a/net/udp/udp_devpoll.c b/net/udp/udp_devpoll.c index 9b6de1a0a0..e23dd68301 100644 --- a/net/udp/udp_devpoll.c +++ b/net/udp/udp_devpoll.c @@ -68,7 +68,7 @@ * dev - The device driver structure to use in the send operation * conn - The UDP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/udp/udp_input.c b/net/udp/udp_input.c index 081dc26b06..dffd3be129 100644 --- a/net/udp/udp_input.c +++ b/net/udp/udp_input.c @@ -71,7 +71,7 @@ * udp - A pointer to the UDP header in the packet * iplen - Length of the IP and UDP headers * - * Return: + * Returned Value: * OK - The packet has been processed and can be deleted * ERROR - Hold the packet and try again later. There is a listening * socket but no receive in place to catch the packet yet. The @@ -241,7 +241,7 @@ static int udp_input(FAR struct net_driver_s *dev, unsigned int iplen) * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. @@ -273,7 +273,7 @@ int udp_ipv4_input(FAR struct net_driver_s *dev) * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. diff --git a/net/udp/udp_send.c b/net/udp/udp_send.c index 7779d03875..46a9b3e86d 100644 --- a/net/udp/udp_send.c +++ b/net/udp/udp_send.c @@ -89,7 +89,7 @@ * dev - The device driver structure to use in the send operation * conn - The UDP "connection" structure holding port information * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/udp/udp_wrbuffer.c b/net/udp/udp_wrbuffer.c index ae8fafd7ff..5e0eca8677 100644 --- a/net/udp/udp_wrbuffer.c +++ b/net/udp/udp_wrbuffer.c @@ -124,7 +124,7 @@ void udp_wrbuffer_initialize(void) * the free list. This function is called from UDP logic when a buffer * of UDP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: diff --git a/net/utils/net_ipv6_mask2pref.c b/net/utils/net_ipv6_mask2pref.c index cc4fd245c8..95b1b2000a 100644 --- a/net/utils/net_ipv6_mask2pref.c +++ b/net/utils/net_ipv6_mask2pref.c @@ -152,7 +152,7 @@ static inline uint8_t net_msbits16(uint16_t hword) * Parameters: * mask Points to an IPv6 netmask in the form of uint16_t[8] * - * Return: + * Returned Value: * The prefix length, range 0-128 on success; This function will not * fail. * diff --git a/net/utils/net_lock.c b/net/utils/net_lock.c index fff004bd3f..3cfad414d6 100644 --- a/net/utils/net_lock.c +++ b/net/utils/net_lock.c @@ -124,7 +124,7 @@ void net_lockinitialize(void) * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -163,7 +163,7 @@ void net_lock(void) * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -201,7 +201,7 @@ void net_unlock(void) * sem - A reference to the semaphore to be taken. * abstime - The absolute time to wait until a timeout is declared. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * @@ -265,7 +265,7 @@ int net_timedwait(sem_t *sem, FAR const struct timespec *abstime) * Input Parameters: * sem - A reference to the semaphore to be taken. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * diff --git a/net/utils/utils.h b/net/utils/utils.h index fc72447084..81dac87c15 100644 --- a/net/utils/utils.h +++ b/net/utils/utils.h @@ -161,7 +161,7 @@ unsigned int net_timeval2dsec(FAR struct timeval *tv, * Parameters: * mask Points to an IPv6 netmask in the form of uint16_t[8] * - * Return: + * Returned Value: * The prefix length, range 0-128 on success; This function will not * fail. * diff --git a/sched/clock/clock_abstime2ticks.c b/sched/clock/clock_abstime2ticks.c index 25a4af540e..4cfbea8b5b 100644 --- a/sched/clock/clock_abstime2ticks.c +++ b/sched/clock/clock_abstime2ticks.c @@ -89,7 +89,7 @@ static long compare_timespec(FAR const struct timespec *a, * reltime - Convert this absolue time to system clock ticks. * ticks - Return the converted number of ticks here. * - * Return Value: + * Returned Value: * OK on success; A non-zero error number on failure; * * Assumptions: diff --git a/sched/clock/clock_dow.c b/sched/clock/clock_dow.c index c922e856bc..41b7f8fafa 100644 --- a/sched/clock/clock_dow.c +++ b/sched/clock/clock_dow.c @@ -70,7 +70,7 @@ static const uint8_t g_lookup[12] = {2, 5, 7, 10, 12, 15, 17, 20, 23, 25, 28, 30 * month - 0 through 11 * day - 1 through 31 * - * Return Value: + * Returned Value: * The day of the week as days since Sunday: 0 = Sunday, 1 = Monday, etc. * * Assumptions: diff --git a/sched/clock/clock_initialize.c b/sched/clock/clock_initialize.c index 6edf41d90d..6cdf1b3a81 100644 --- a/sched/clock/clock_initialize.c +++ b/sched/clock/clock_initialize.c @@ -275,7 +275,7 @@ void clock_initialize(void) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -314,7 +314,7 @@ void clock_synchronize(void) * Parameters: * rtc_diff: amount of time system-time is adjusted forward with RTC * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/clock/clock_systimer.c b/sched/clock/clock_systimer.c index e1d4440ab1..6334c5232b 100644 --- a/sched/clock/clock_systimer.c +++ b/sched/clock/clock_systimer.c @@ -72,7 +72,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * The current value of the system timer counter * * Assumptions: diff --git a/sched/clock/clock_systimespec.c b/sched/clock/clock_systimespec.c index 5d6009d051..bdab9b115b 100644 --- a/sched/clock/clock_systimespec.c +++ b/sched/clock/clock_systimespec.c @@ -62,7 +62,7 @@ * Parameters: * ts - Location to return the time * - * Return Value: + * Returned Value: * Current version always returns OK * * Assumptions: diff --git a/sched/clock/clock_ticks2time.c b/sched/clock/clock_ticks2time.c index 899ecd9818..0ea5295f57 100644 --- a/sched/clock/clock_ticks2time.c +++ b/sched/clock/clock_ticks2time.c @@ -56,7 +56,7 @@ * ticks - The number of system time ticks to convert. * reltime - Return the converted system time here. * - * Return Value: + * Returned Value: * Always returns OK * * Assumptions: diff --git a/sched/clock/clock_time2ticks.c b/sched/clock/clock_time2ticks.c index 5f0bc28c40..5f0cb36bec 100644 --- a/sched/clock/clock_time2ticks.c +++ b/sched/clock/clock_time2ticks.c @@ -60,7 +60,7 @@ * reltime - Convert this relative time to system clock ticks. * ticks - Return the converted number of ticks here. * - * Return Value: + * Returned Value: * Always returns OK * * Assumptions: diff --git a/sched/clock/clock_timespec_add.c b/sched/clock/clock_timespec_add.c index 0e0fb931db..08bf634d76 100644 --- a/sched/clock/clock_timespec_add.c +++ b/sched/clock/clock_timespec_add.c @@ -54,11 +54,11 @@ * Description: * Add timespec ts1 to to2 and return the result in ts3 * - * Inputs: + * Input Parameters: * ts1 and ts2: The two timespecs to be added * t23: The location to return the result (may be ts1 or ts2) * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/clock/clock_timespec_subtract.c b/sched/clock/clock_timespec_subtract.c index 754c84d1cb..873dd75d7c 100644 --- a/sched/clock/clock_timespec_subtract.c +++ b/sched/clock/clock_timespec_subtract.c @@ -55,11 +55,11 @@ * Subtract timespec ts2 from to1 and return the result in ts3. * Zero is returned if the time difference is negative. * - * Inputs: + * Input Parameters: * ts1 and ts2: The two timespecs to be subtracted (ts1 - ts2) * t23: The location to return the result (may be ts1 or ts2) * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/environ/env_clearenv.c b/sched/environ/env_clearenv.c index ededbadbed..97aee7e230 100644 --- a/sched/environ/env_clearenv.c +++ b/sched/environ/env_clearenv.c @@ -60,7 +60,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/environ/env_dup.c b/sched/environ/env_dup.c index 08b0e1b617..5544c1faf6 100644 --- a/sched/environ/env_dup.c +++ b/sched/environ/env_dup.c @@ -67,7 +67,7 @@ * group The child task group to receive the newly allocated copy of the * parent task groups environment structure. * - * Return Value: + * Returned Value: * zero on success * * Assumptions: diff --git a/sched/environ/env_findvar.c b/sched/environ/env_findvar.c index f6b44da5c4..953aefebf3 100644 --- a/sched/environ/env_findvar.c +++ b/sched/environ/env_findvar.c @@ -86,7 +86,7 @@ static bool env_cmpname(const char *pszname, const char *peqname) * group The task group containging environment array to be searched. * pname The variable name to find * - * Return Value: + * Returned Value: * A pointer to the name=value string in the environment * * Assumptions: diff --git a/sched/environ/env_getenv.c b/sched/environ/env_getenv.c index 6e92f90d3f..be20805204 100644 --- a/sched/environ/env_getenv.c +++ b/sched/environ/env_getenv.c @@ -63,7 +63,7 @@ * Parameters: * name - The name of the variable to find. * - * Return Value: + * Returned Value: * The value of the valiable (read-only) or NULL on failure * * Assumptions: diff --git a/sched/environ/env_getenvironptr.c b/sched/environ/env_getenvironptr.c index 11c4f5368e..43f7a2cfcf 100644 --- a/sched/environ/env_getenvironptr.c +++ b/sched/environ/env_getenvironptr.c @@ -60,7 +60,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the per-thread environ variable. * * Assumptions: diff --git a/sched/environ/env_putenv.c b/sched/environ/env_putenv.c index ec683b298c..f54dea241f 100644 --- a/sched/environ/env_putenv.c +++ b/sched/environ/env_putenv.c @@ -65,7 +65,7 @@ * Parameters: * name=value string describing the environment setting to add/modify * - * Return Value: + * Returned Value: * Zero on sucess * * Assumptions: diff --git a/sched/environ/env_release.c b/sched/environ/env_release.c index d1ace0505b..fd9bdfd312 100644 --- a/sched/environ/env_release.c +++ b/sched/environ/env_release.c @@ -65,7 +65,7 @@ * group Identifies the task group containing the environment structure * to be released. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/environ/env_removevar.c b/sched/environ/env_removevar.c index b18ebbf899..197357ea08 100644 --- a/sched/environ/env_removevar.c +++ b/sched/environ/env_removevar.c @@ -60,7 +60,7 @@ * group The task group with the environment containing the name=value pair * pvar A pointer to the name=value pair in the restroom * - * Return Value: + * Returned Value: * Zero on success * * Assumptions: diff --git a/sched/environ/env_setenv.c b/sched/environ/env_setenv.c index 38faae839a..96cd06ac4c 100644 --- a/sched/environ/env_setenv.c +++ b/sched/environ/env_setenv.c @@ -71,7 +71,7 @@ * value - The new value of the variable * overwrite - Replace any existing value if non-zero. * - * Return Value: + * Returned Value: * Zero on success * * Assumptions: diff --git a/sched/environ/env_unsetenv.c b/sched/environ/env_unsetenv.c index 2956cfe783..fa85358abf 100644 --- a/sched/environ/env_unsetenv.c +++ b/sched/environ/env_unsetenv.c @@ -63,7 +63,7 @@ * Parameters: * name - The name of the variable to delete * - * Return Value: + * Returned Value: * Zero on success * * Assumptions: diff --git a/sched/errno/errno_get.c b/sched/errno/errno_get.c index 8982ac61e7..3664a3e054 100644 --- a/sched/errno/errno_get.c +++ b/sched/errno/errno_get.c @@ -65,7 +65,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * The current value of the thread specific errno. * * Assumptions: diff --git a/sched/errno/errno_getptr.c b/sched/errno/errno_getptr.c index 4e47895a0b..4d220db23d 100644 --- a/sched/errno/errno_getptr.c +++ b/sched/errno/errno_getptr.c @@ -75,7 +75,7 @@ static int g_irqerrno; * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the per-thread errno variable. * * Assumptions: diff --git a/sched/errno/errno_set.c b/sched/errno/errno_set.c index 540bc8b782..a7a00af67a 100644 --- a/sched/errno/errno_set.c +++ b/sched/errno/errno_set.c @@ -64,7 +64,7 @@ * Parameters: * errcode - The thread specific errno will be set to this error code value. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/group/group_addrenv.c b/sched/group/group_addrenv.c index 52330c04cc..bc301c9b43 100644 --- a/sched/group/group_addrenv.c +++ b/sched/group/group_addrenv.c @@ -82,7 +82,7 @@ gid_t g_gid_current; * be the TCB at the head of the ready-to-run list, but that is not * enough. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success. A negated errno value is returned on * any failure. * diff --git a/sched/group/group_childstatus.c b/sched/group/group_childstatus.c index e4e994677d..915c1c9a96 100644 --- a/sched/group/group_childstatus.c +++ b/sched/group/group_childstatus.c @@ -100,7 +100,7 @@ static struct child_pool_s g_child_pool; * Parameters: * group - The task group containing the child status. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -140,7 +140,7 @@ static void group_dumpchildren(FAR struct task_group_s *group, * Parameters: * None. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -176,7 +176,7 @@ void task_initialize(void) * Parameters: * None. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure. NULL is * returned if there are no remaining, pre-allocated child status structures. * @@ -211,7 +211,7 @@ FAR struct child_status_s *group_allocchild(void) * Parameters: * status - The child status structure to be freed. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -241,7 +241,7 @@ void group_freechild(FAR struct child_status_s *child) * group - The task group for the child status. * child - The structure to be added * - * Return Value: + * Returned Value: * N * * Assumptions: @@ -273,7 +273,7 @@ void group_addchild(FAR struct task_group_s *group, * group - The ID of the parent task group to containing the child status. * pid - The ID of the child to find. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure. NULL is * returned if there is child status structure for that pid in the TCB. * @@ -312,7 +312,7 @@ FAR struct child_status_s *group_findchild(FAR struct task_group_s *group, * Parameters: * tcb - The TCB of the parent task to containing the child status. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure for the * exited child. NULL is returned if not child has exited. * @@ -351,7 +351,7 @@ FAR struct child_status_s *group_exitchild(FAR struct task_group_s *group) * group - The task group containing the child status. * pid - The ID of the child to find. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure. NULL is * returned if there is child status structure for that pid in the TCB. * @@ -412,7 +412,7 @@ FAR struct child_status_s *group_removechild(FAR struct task_group_s *group, * Parameters: * group - The task group containing the child status. * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/group/group_create.c b/sched/group/group_create.c index 0cb29b4e2e..29ca989ca6 100644 --- a/sched/group/group_create.c +++ b/sched/group/group_create.c @@ -92,7 +92,7 @@ FAR struct task_group_s *g_grouphead; * Parameters: * tcb - The tcb in need of the task group. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -165,7 +165,7 @@ static void group_assigngid(FAR struct task_group_s *group) * tcb - The tcb in need of the task group. * ttype - Type of the thread that is the parent of the group * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: @@ -274,7 +274,7 @@ int group_allocate(FAR struct task_tcb_s *tcb, uint8_t ttype) * Parameters: * tcb - The tcb in need of the task group. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: diff --git a/sched/group/group_find.c b/sched/group/group_find.c index 3db582fa25..ade869dd01 100644 --- a/sched/group/group_find.c +++ b/sched/group/group_find.c @@ -68,7 +68,7 @@ * Parameters: * gid - The group ID to find. * - * Return Value: + * Returned Value: * On success, a pointer to the group task structure is returned. This * function can fail only if there is no group that corresponds to the * group ID. @@ -114,7 +114,7 @@ FAR struct task_group_s *group_findbygid(gid_t gid) * Parameters: * pid - The task ID of the main task thread. * - * Return Value: + * Returned Value: * On success, a pointer to the group task structure is returned. This * function can fail only if there is no group that corresponds to the * task ID. diff --git a/sched/group/group_foreachchild.c b/sched/group/group_foreachchild.c index 10fed5f90a..5908d6a121 100644 --- a/sched/group/group_foreachchild.c +++ b/sched/group/group_foreachchild.c @@ -60,7 +60,7 @@ * handler - The function to be called * arg - An additional argument to provide to the handler * - * Return Value: + * Returned Value: * Success (OK) is always returned unless the handler returns a non-zero * value (a negated errno on errors). In that case, the traversal * terminates and that non-zero value is returned. diff --git a/sched/group/group_join.c b/sched/group/group_join.c index 7fb2a817fa..1bb2fdfdeb 100644 --- a/sched/group/group_join.c +++ b/sched/group/group_join.c @@ -74,7 +74,7 @@ * group - The task group to add the new member * pid - The new member * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: @@ -152,7 +152,7 @@ static inline int group_addmember(FAR struct task_group_s *group, pid_t pid) * Parameters: * tcb - The TCB of the new "child" task that need to join the group. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: @@ -189,7 +189,7 @@ int group_bind(FAR struct pthread_tcb_s *tcb) * Parameters: * tcb - The TCB of the new "child" task that need to join the group. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: diff --git a/sched/group/group_killchildren.c b/sched/group/group_killchildren.c index 3b719a495c..aa4ae077b7 100644 --- a/sched/group/group_killchildren.c +++ b/sched/group/group_killchildren.c @@ -59,7 +59,7 @@ * pid - The ID of the group member that may be signalled. * arg - The PID of the thread to be retained. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -95,7 +95,7 @@ static int group_killchildren_handler(pid_t pid, FAR void *arg) * Parameters: * tcb - TCB of the task to be retained. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/group/group_leave.c b/sched/group/group_leave.c index 79a1bde1a1..e20bb3bdd7 100644 --- a/sched/group/group_leave.c +++ b/sched/group/group_leave.c @@ -70,7 +70,7 @@ * Parameters: * group - The group to be removed. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -129,7 +129,7 @@ static void group_remove(FAR struct task_group_s *group) * Parameters: * group - The group to be removed. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -289,7 +289,7 @@ static inline void group_release(FAR struct task_group_s *group) * group - The group from which to remove the member. * pid - The member to be removed. * - * Return Value: + * Returned Value: * On success, returns the number of members remaining in the group (>=0). * Can fail only if the member is not found in the group. On failure, * returns -ENOENT @@ -346,7 +346,7 @@ static inline void group_removemember(FAR struct task_group_s *group, pid_t pid) * Parameters: * tcb - The TCB of the task that is exiting. * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/group/group_setupidlefiles.c b/sched/group/group_setupidlefiles.c index 0d4eb19ca2..076017360d 100644 --- a/sched/group/group_setupidlefiles.c +++ b/sched/group/group_setupidlefiles.c @@ -66,7 +66,7 @@ * Parameters: * tcb - tcb of the idle task. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/group/group_setuptaskfiles.c b/sched/group/group_setuptaskfiles.c index e106871250..1a1ec07963 100644 --- a/sched/group/group_setuptaskfiles.c +++ b/sched/group/group_setuptaskfiles.c @@ -79,7 +79,7 @@ * Input Parameters: * tcb - tcb of the new task. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -137,7 +137,7 @@ static inline void sched_dupfiles(FAR struct task_tcb_s *tcb) * Input Parameters: * tcb - tcb of the new task. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -198,7 +198,7 @@ static inline void sched_dupsockets(FAR struct task_tcb_s *tcb) * Parameters: * tcb - tcb of the new task. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * failure. * diff --git a/sched/group/group_signal.c b/sched/group/group_signal.c index f066fc7f5d..e0de4bcf64 100644 --- a/sched/group/group_signal.c +++ b/sched/group/group_signal.c @@ -80,7 +80,7 @@ struct group_signal_s * pid - The ID of the group member that may be signalled. * arg - A pointer to a struct group_signal_s instance. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -195,7 +195,7 @@ static int group_signal_handler(pid_t pid, FAR void *arg) * Parameters: * group - The task group that needs to be signalled. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: diff --git a/sched/init/init.h b/sched/init/init.h index 4724c83392..b602786bc4 100644 --- a/sched/init/init.h +++ b/sched/init/init.h @@ -57,7 +57,7 @@ * Input Parameters: * None * - * Returned value: + * Returned Value: * Does not return. * ****************************************************************************/ diff --git a/sched/init/os_start.c b/sched/init/os_start.c index 9033189e63..0fcbd4ba48 100644 --- a/sched/init/os_start.c +++ b/sched/init/os_start.c @@ -361,7 +361,7 @@ static FAR char *g_idleargv[1][2]; * Input Parameters: * None * - * Returned value: + * Returned Value: * Does not return. * ****************************************************************************/ diff --git a/sched/irq/irq.h b/sched/irq/irq.h index ac38158f3c..a51455f175 100644 --- a/sched/irq/irq.h +++ b/sched/irq/irq.h @@ -180,10 +180,10 @@ int irq_unexpected_isr(int irq, FAR void *context, FAR void *arg); * the IRQ lock is also set UNLESS the CPU starting the task is the * holder of the IRQ lock. * - * Inputs: + * Input Parameters: * rtcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true - IRQs are locked by a different CPU. * false - IRQs are unlocked OR if they are locked BUT this CPU * is the holder of the lock. diff --git a/sched/irq/irq_csection.c b/sched/irq/irq_csection.c index 63e0be9f66..ca75810ca0 100644 --- a/sched/irq/irq_csection.c +++ b/sched/irq/irq_csection.c @@ -587,10 +587,10 @@ void leave_critical_section(irqstate_t flags) * the IRQ lock is also set UNLESS the CPU starting the task is the * holder of the IRQ lock. * - * Inputs: + * Input Parameters: * rtcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true - IRQs are locked by a different CPU. * false - IRQs are unlocked OR if they are locked BUT this CPU * is the holder of the lock. diff --git a/sched/mqueue/mq_desclose.c b/sched/mqueue/mq_desclose.c index b4c72c0e96..c4a5d68f52 100644 --- a/sched/mqueue/mq_desclose.c +++ b/sched/mqueue/mq_desclose.c @@ -60,7 +60,7 @@ * Description: * Deallocate a message queue descriptor but returning it to the free list * - * Inputs: + * Input Parameters: * mqdes - message queue descriptor to free * ****************************************************************************/ @@ -82,7 +82,7 @@ * mqdes - Message queue descriptor. * group - Group that has the open descriptor. * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/mqueue/mq_descreate.c b/sched/mqueue/mq_descreate.c index d3b574f623..47dad5bd3b 100644 --- a/sched/mqueue/mq_descreate.c +++ b/sched/mqueue/mq_descreate.c @@ -67,10 +67,10 @@ * Description: * Allocate a message queue descriptor. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * Reference to the allocated mq descriptor. * ****************************************************************************/ @@ -109,12 +109,12 @@ static mqd_t nxmq_alloc_des(void) * Description: * Create a message queue descriptor for the specified TCB * - * Inputs: + * Input Parameters: * mtcb - task that needs the descriptor. * msgq - Named message queue containing the message * oflags - access rights for the descriptor * - * Return Value: + * Returned Value: * On success, the message queue descriptor is returned. NULL is returned * on a failure to allocate. * diff --git a/sched/mqueue/mq_getattr.c b/sched/mqueue/mq_getattr.c index b1475b6846..2bcf0902a7 100644 --- a/sched/mqueue/mq_getattr.c +++ b/sched/mqueue/mq_getattr.c @@ -57,7 +57,7 @@ * mqdes - Message queue descriptor * mq_stat - Buffer in which to return attributes * - * Return Value: + * Returned Value: * 0 (OK) if attributes provided, -1 (ERROR) otherwise. * * Assumptions: diff --git a/sched/mqueue/mq_initialize.c b/sched/mqueue/mq_initialize.c index 3e46ac2554..46e820c9fc 100644 --- a/sched/mqueue/mq_initialize.c +++ b/sched/mqueue/mq_initialize.c @@ -111,7 +111,7 @@ static sq_queue_t g_desalloc; * Description: * Allocate a block of messages and place them on the free list. * - * Inputs Parameters: + * Input Parameters: * queue * ****************************************************************************/ @@ -156,10 +156,10 @@ mq_msgblockalloc(FAR sq_queue_t *queue, uint16_t nmsgs, * be called early in the initialization sequence before any of the * other message interfaces execute. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -198,10 +198,10 @@ void nxmq_initialize(void) * Allocate a block of message descriptors and place them on the free * list. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_msgfree.c b/sched/mqueue/mq_msgfree.c index 9492a93d38..4ea3735f73 100644 --- a/sched/mqueue/mq_msgfree.c +++ b/sched/mqueue/mq_msgfree.c @@ -59,10 +59,10 @@ * messages if it was a pre-allocated message. If the message was * allocated dynamically it will be deallocated. * - * Inputs: + * Input Parameters: * mqmsg - message to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_msgqalloc.c b/sched/mqueue/mq_msgqalloc.c index 473896c3f2..becf7bd394 100644 --- a/sched/mqueue/mq_msgqalloc.c +++ b/sched/mqueue/mq_msgqalloc.c @@ -66,7 +66,7 @@ * queue is created to determine the maximum number of * messages that may be placed in the message queue. * - * Return Value: + * Returned Value: * The allocated and initialized message queue structure or NULL in the * event of a failure. * diff --git a/sched/mqueue/mq_msgqfree.c b/sched/mqueue/mq_msgqfree.c index b52494813e..54f858ced8 100644 --- a/sched/mqueue/mq_msgqfree.c +++ b/sched/mqueue/mq_msgqfree.c @@ -57,10 +57,10 @@ * closed so that no thread will attempt access it while it is being * deleted. * - * Inputs: + * Input Parameters: * msgq - Named essage queue to be freed * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_notify.c b/sched/mqueue/mq_notify.c index 8dd0e89080..3cf3d42278 100644 --- a/sched/mqueue/mq_notify.c +++ b/sched/mqueue/mq_notify.c @@ -78,7 +78,7 @@ * sigev_signo - The signo to use for the notification * sigev_value - Value associated with the signal * - * Return Value: + * Returned Value: * On success mq_notify() returns 0; on error, -1 is returned, with * errno set to indicate the error. * diff --git a/sched/mqueue/mq_recover.c b/sched/mqueue/mq_recover.c index 087dc4d341..b150c0a28b 100644 --- a/sched/mqueue/mq_recover.c +++ b/sched/mqueue/mq_recover.c @@ -58,10 +58,10 @@ * via pthread_cancel. I checks if the task was waiting for a message * queue event and adjusts counts appropriately. * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/mqueue/mq_release.c b/sched/mqueue/mq_release.c index c916c7b41d..2e253b915b 100644 --- a/sched/mqueue/mq_release.c +++ b/sched/mqueue/mq_release.c @@ -55,10 +55,10 @@ * This function closes all of the message queues opened by members of * the task group. * - * Inputs: + * Input Parameters: * group - The task group that is terminating. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_setattr.c b/sched/mqueue/mq_setattr.c index de238e4601..eb70f779de 100644 --- a/sched/mqueue/mq_setattr.c +++ b/sched/mqueue/mq_setattr.c @@ -65,7 +65,7 @@ * mq_stat - New attributes * oldstate - Old attributes * - * Return Value: + * Returned Value: * 0 (OK) if attributes are set successfully, otherwise * -1 (ERROR). * diff --git a/sched/mqueue/mq_sndinternal.c b/sched/mqueue/mq_sndinternal.c index 933d684a13..7ad32132cb 100644 --- a/sched/mqueue/mq_sndinternal.c +++ b/sched/mqueue/mq_sndinternal.c @@ -131,7 +131,7 @@ int nxmq_verify_send(mqd_t mqdes, FAR const char *msg, size_t msglen, * the g_msgfreeirq list. If this is unsuccessful, the calling interrupt * handler will be notified. * - * Inputs: + * Input Parameters: * None * * Returned Value: diff --git a/sched/mqueue/mq_waitirq.c b/sched/mqueue/mq_waitirq.c index ee24c4d9f7..d542adc8af 100644 --- a/sched/mqueue/mq_waitirq.c +++ b/sched/mqueue/mq_waitirq.c @@ -65,7 +65,7 @@ * wtcb - A pointer to the TCB of the task that is waiting on a message * queue, but has received a signal instead. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/paging/paging.h b/sched/paging/paging.h index cccda6e4ed..c7e253b421 100644 --- a/sched/paging/paging.h +++ b/sched/paging/paging.h @@ -107,7 +107,7 @@ extern FAR struct tcb_s *g_pftcb; * This is the entry point of the worker thread that performs the actual * page file. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: diff --git a/sched/paging/pg_worker.c b/sched/paging/pg_worker.c index a2ded4c1ae..e6fe07b62a 100644 --- a/sched/paging/pg_worker.c +++ b/sched/paging/pg_worker.c @@ -141,7 +141,7 @@ static systime_t g_starttime; * task that is waiting for a fill. * - Signal the page fill worker thread. * - * Input parameters: + * Input Parameters: * tcb - The TCB of the task that just received the fill. * result - The result of the page fill operation. * @@ -223,7 +223,7 @@ static void pg_callback(FAR struct tcb_s *tcb, int result) * The result (NULL or a TCB pointer) will be returned in the global * variable, g_pftcb. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -334,7 +334,7 @@ static inline bool pg_dequeue(void) * prioritized list, or (2) when a page fill completes and there are more * pages to be filled in g_waitingforfill list. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -441,7 +441,7 @@ static inline bool pg_startfill(void) * - Set g_pftcb to NULL. * - Restore the default priority of the page fill worker thread. * - * Input parameters: + * Input Parameters: * None. * * Returned Value: @@ -475,7 +475,7 @@ static inline void pg_alldone(void) * This function is just a dumb wrapper around up_unblocktask(). This * function simply makes the task that just received the fill ready-to-run. * - * Input parameters: + * Input Parameters: * None. * * Returned Value: @@ -515,7 +515,7 @@ static inline void pg_fillcomplete(void) * after completing a page fill. * - A configurable timeout with no activity. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: diff --git a/sched/pthread/pthread_cleanup.c b/sched/pthread/pthread_cleanup.c index a4f6e45b21..cbfc2558be 100644 --- a/sched/pthread/pthread_cleanup.c +++ b/sched/pthread/pthread_cleanup.c @@ -64,7 +64,7 @@ * Input Parameters: * tcb - The TCB of the pthread that is exiting or being canceled. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_completejoin.c b/sched/pthread/pthread_completejoin.c index 0b934c1033..6dc23185c5 100644 --- a/sched/pthread/pthread_completejoin.c +++ b/sched/pthread/pthread_completejoin.c @@ -115,7 +115,7 @@ static bool pthread_notifywaiters(FAR struct join_s *pjoin) * Parameters: * pid * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/pthread/pthread_condbroadcast.c b/sched/pthread/pthread_condbroadcast.c index 0fddd76927..5a19538882 100644 --- a/sched/pthread/pthread_condbroadcast.c +++ b/sched/pthread/pthread_condbroadcast.c @@ -59,7 +59,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_condsignal.c b/sched/pthread/pthread_condsignal.c index 5826a425de..21eab53ec2 100644 --- a/sched/pthread/pthread_condsignal.c +++ b/sched/pthread/pthread_condsignal.c @@ -58,7 +58,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_condtimedwait.c b/sched/pthread/pthread_condtimedwait.c index 66410faebd..0093d3def3 100644 --- a/sched/pthread/pthread_condtimedwait.c +++ b/sched/pthread/pthread_condtimedwait.c @@ -75,7 +75,7 @@ * pid - the task ID of the task to wakeup * signo - The signal to use to wake up the task * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -156,7 +156,7 @@ static void pthread_condtimedout(int argc, uint32_t pid, uint32_t signo) * mutex - the mutex that protects the condition variable * abstime - wait until this absolute time * - * Return Value: + * Returned Value: * OK (0) on success; A non-zero errno value is returned on failure. * * Assumptions: diff --git a/sched/pthread/pthread_condwait.c b/sched/pthread/pthread_condwait.c index b3716da0a6..734dc55bad 100644 --- a/sched/pthread/pthread_condwait.c +++ b/sched/pthread/pthread_condwait.c @@ -62,7 +62,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_create.c b/sched/pthread/pthread_create.c index 4900574e16..7f6f2ed2b2 100644 --- a/sched/pthread/pthread_create.c +++ b/sched/pthread/pthread_create.c @@ -103,7 +103,7 @@ static const char g_pthreadname[] = ""; * tcb - Address of the new task's TCB * arg - The argument to provide to the pthread on startup. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -133,7 +133,7 @@ static inline void pthread_argsetup(FAR struct pthread_tcb_s *tcb, pthread_addr_ * Parameters: * pjoin * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -232,7 +232,7 @@ static void pthread_start(void) * start_routine * arg * - * Returned value: + * Returned Value: * OK (0) on success; a (non-negated) errno value on failure. The errno * variable is not set. * diff --git a/sched/pthread/pthread_detach.c b/sched/pthread/pthread_detach.c index 47e0a3b42d..184f164272 100644 --- a/sched/pthread/pthread_detach.c +++ b/sched/pthread/pthread_detach.c @@ -68,7 +68,7 @@ * Parameters: * thread * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/sched/pthread/pthread_findjoininfo.c b/sched/pthread/pthread_findjoininfo.c index 23fcc6a46d..9ddc34cdd8 100644 --- a/sched/pthread/pthread_findjoininfo.c +++ b/sched/pthread/pthread_findjoininfo.c @@ -58,7 +58,7 @@ * group - The that the pid is (or was) a member of of * pid - The ID of the pthread * - * Return Value: + * Returned Value: * None or pointer to the found entry. * * Assumptions: diff --git a/sched/pthread/pthread_getaffinity.c b/sched/pthread/pthread_getaffinity.c index 868fe7003d..d3eb4d9f89 100644 --- a/sched/pthread/pthread_getaffinity.c +++ b/sched/pthread/pthread_getaffinity.c @@ -71,7 +71,7 @@ * cpusetsize - Size of cpuset. MUST be sizeofcpu_set_t(). * cpuset - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an errno value is returned indicating the * nature of the failure. * diff --git a/sched/pthread/pthread_getschedparam.c b/sched/pthread/pthread_getschedparam.c index 0167f172a1..fa3e030a45 100644 --- a/sched/pthread/pthread_getschedparam.c +++ b/sched/pthread/pthread_getschedparam.c @@ -80,7 +80,7 @@ * policy - The location to store the thread's scheduling policy. * param - The location to store the thread's priority. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, the error code ESRCH if the value specified * by thread does not refer to an existing thread. * diff --git a/sched/pthread/pthread_getspecific.c b/sched/pthread/pthread_getspecific.c index 51927549c1..889f712dd3 100644 --- a/sched/pthread/pthread_getspecific.c +++ b/sched/pthread/pthread_getspecific.c @@ -65,7 +65,7 @@ * Parameters: * key = The data key to get or set * - * Return Value: + * Returned Value: * The function pthread_getspecific() returns the thread-specific data * associated with the given key. If no thread specific data is * associated with the key, then the value NULL is returned. diff --git a/sched/pthread/pthread_initialize.c b/sched/pthread/pthread_initialize.c index be0cb85ae4..5da4bcdaa0 100644 --- a/sched/pthread/pthread_initialize.c +++ b/sched/pthread/pthread_initialize.c @@ -64,7 +64,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -91,7 +91,7 @@ void pthread_initialize(void) * intr - false: ignore EINTR errors when locking; true tread EINTR as * other errors by returning the errno value * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ diff --git a/sched/pthread/pthread_join.c b/sched/pthread/pthread_join.c index 4f22777b9a..24bec6bb0d 100644 --- a/sched/pthread/pthread_join.c +++ b/sched/pthread/pthread_join.c @@ -70,7 +70,7 @@ * thread * pexit_value * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, one of the following error codes: * * EINVAL The value specified by thread does not refer to joinable diff --git a/sched/pthread/pthread_keycreate.c b/sched/pthread/pthread_keycreate.c index 60be2fb5e3..9daade6a31 100644 --- a/sched/pthread/pthread_keycreate.c +++ b/sched/pthread/pthread_keycreate.c @@ -71,7 +71,7 @@ * with each key that is invoked when a thread exits. However, this * argument is ignored in the current implementation. * - * Return Value: + * Returned Value: * If successful, the pthread_key_create() function will store the newly * created key value at *key and return zero (OK). Otherwise, an error * number will bereturned to indicate the error: diff --git a/sched/pthread/pthread_keydelete.c b/sched/pthread/pthread_keydelete.c index 57cd46309a..ab72fad9db 100644 --- a/sched/pthread/pthread_keydelete.c +++ b/sched/pthread/pthread_keydelete.c @@ -60,7 +60,7 @@ * Parameters: * key = the key to delete * - * Return Value: + * Returned Value: * Always returns ENOSYS. * * Assumptions: diff --git a/sched/pthread/pthread_kill.c b/sched/pthread/pthread_kill.c index 1c2663e47e..e3f04a0b7a 100644 --- a/sched/pthread/pthread_kill.c +++ b/sched/pthread/pthread_kill.c @@ -70,7 +70,7 @@ * signo - The signal number to send. If 'signo' is zero, no signal is * sent, but all error checking is performed. * - * Return Value: + * Returned Value: * On success the signal was send and zero is returned. On error one * of the following error numbers is returned. * diff --git a/sched/pthread/pthread_mutex.c b/sched/pthread/pthread_mutex.c index 6e1edd49d8..02092a0117 100644 --- a/sched/pthread/pthread_mutex.c +++ b/sched/pthread/pthread_mutex.c @@ -64,7 +64,7 @@ * Parameters: * mutex - The mutex to be locked * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -107,7 +107,7 @@ static void pthread_mutex_add(FAR struct pthread_mutex_s *mutex) * Parameters: * mutex - The mutex to be locked * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -172,7 +172,7 @@ static void pthread_mutex_remove(FAR struct pthread_mutex_s *mutex) * intr - false: ignore EINTR errors when locking; true treat EINTR as * other errors by returning the errno value * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ @@ -242,7 +242,7 @@ int pthread_mutex_take(FAR struct pthread_mutex_s *mutex, bool intr) * intr - false: ignore EINTR errors when locking; true treat EINTR as * other errors by returning the errno value * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ @@ -299,7 +299,7 @@ int pthread_mutex_trytake(FAR struct pthread_mutex_s *mutex) * Parameters: * mutex - The mutex to be unlocked * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ diff --git a/sched/pthread/pthread_mutexdestroy.c b/sched/pthread/pthread_mutexdestroy.c index 17f58fbda5..7c5055504c 100644 --- a/sched/pthread/pthread_mutexdestroy.c +++ b/sched/pthread/pthread_mutexdestroy.c @@ -63,7 +63,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_mutexinit.c b/sched/pthread/pthread_mutexinit.c index 9885869bbe..a648544bfa 100644 --- a/sched/pthread/pthread_mutexinit.c +++ b/sched/pthread/pthread_mutexinit.c @@ -61,7 +61,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_mutexlock.c b/sched/pthread/pthread_mutexlock.c index 223b2193c5..88611c7be3 100644 --- a/sched/pthread/pthread_mutexlock.c +++ b/sched/pthread/pthread_mutexlock.c @@ -91,7 +91,7 @@ * Parameters: * mutex - A reference to the mutex to be locked. * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. Note that the errno EINTR * is never returned by pthread_mutex_lock(). * diff --git a/sched/pthread/pthread_mutextrylock.c b/sched/pthread/pthread_mutextrylock.c index b88916ae50..fb74a76d5c 100644 --- a/sched/pthread/pthread_mutextrylock.c +++ b/sched/pthread/pthread_mutextrylock.c @@ -69,7 +69,7 @@ * Parameters: * mutex - A reference to the mutex to be locked. * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. Note that the errno EINTR * is never returned by pthread_mutex_trylock(). * diff --git a/sched/pthread/pthread_mutexunlock.c b/sched/pthread/pthread_mutexunlock.c index a29fc490da..75492515ac 100644 --- a/sched/pthread/pthread_mutexunlock.c +++ b/sched/pthread/pthread_mutexunlock.c @@ -61,7 +61,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * Returns true if the mutex is locked * ****************************************************************************/ @@ -105,7 +105,7 @@ static inline bool pthread_mutex_islocked(FAR struct pthread_mutex_s *mutex) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_release.c b/sched/pthread/pthread_release.c index ff7164f1eb..fd79544c9c 100644 --- a/sched/pthread/pthread_release.c +++ b/sched/pthread/pthread_release.c @@ -61,7 +61,7 @@ * group = The task group containing the pthread resources to be * released. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_setaffinity.c b/sched/pthread/pthread_setaffinity.c index 87f91e9be9..5f3ba7283c 100644 --- a/sched/pthread/pthread_setaffinity.c +++ b/sched/pthread/pthread_setaffinity.c @@ -73,7 +73,7 @@ * cpusetsize - Size of cpuset. MUST be sizeofcpu_set_t(). * cpuset - Provides the new affinity set for the thread. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an errno value is returned indicating the * nature of the failure. * diff --git a/sched/pthread/pthread_setschedparam.c b/sched/pthread/pthread_setschedparam.c index 2ba1e85116..bfbbf2dbcd 100644 --- a/sched/pthread/pthread_setschedparam.c +++ b/sched/pthread/pthread_setschedparam.c @@ -82,7 +82,7 @@ * SCHED_RR. SCHED_OTHER and SCHED_SPORADIC are not supported. * param - Provides the new priority of the thread. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code identifying the cause of the * failure: * diff --git a/sched/pthread/pthread_setschedprio.c b/sched/pthread/pthread_setschedprio.c index e698d3bf29..aed67e4559 100644 --- a/sched/pthread/pthread_setschedprio.c +++ b/sched/pthread/pthread_setschedprio.c @@ -61,12 +61,12 @@ * If the thread_setschedprio() function fails, the scheduling priority * of the target thread will not be changed. * - * Inputs: + * Input Parameters: * thread - the thread ID of the task to reprioritize. * prio - The new thread priority. The range of valid priority numbers is * from SCHED_PRIORITY_MIN through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * OK if successful, otherwise an error number. This function can * fail for the following reasons: * diff --git a/sched/pthread/pthread_setspecific.c b/sched/pthread/pthread_setspecific.c index 3a0db5b7ef..371353b424 100644 --- a/sched/pthread/pthread_setspecific.c +++ b/sched/pthread/pthread_setspecific.c @@ -72,7 +72,7 @@ * key = The data key to get or set * value = The value to bind to the key. * - * Return Value: + * Returned Value: * If successful, pthread_setspecific() will return zero (OK). * Otherwise, an error number will be returned: * diff --git a/sched/pthread/pthread_sigmask.c b/sched/pthread/pthread_sigmask.c index fb87f28c3f..43eb6c27ed 100644 --- a/sched/pthread/pthread_sigmask.c +++ b/sched/pthread/pthread_sigmask.c @@ -71,7 +71,7 @@ * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * On success, this function will return 0 (OK). It will return EINVAL if * how is invalid. * diff --git a/sched/sched/sched_addblocked.c b/sched/sched/sched_addblocked.c index 151faedb69..487330714d 100644 --- a/sched/sched/sched_addblocked.c +++ b/sched/sched/sched_addblocked.c @@ -55,11 +55,11 @@ * This function adds a TCB to one of the blocked state task lists as * inferred from task_state. * - * Inputs: + * Input Parameters: * btcb - Points to the TCB that is blocked * task_state - identifies the state of the blocked task * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_addprioritized.c b/sched/sched/sched_addprioritized.c index b94b60255d..15e20319be 100644 --- a/sched/sched/sched_addprioritized.c +++ b/sched/sched/sched_addprioritized.c @@ -56,11 +56,11 @@ * Description: * This function adds a TCB to a prioritized TCB list. * - * Inputs: + * Input Parameters: * tcb - Points to the TCB to add to the prioritized list * list - Points to the prioritized list to add tcb to * - * Return Value: + * Returned Value: * true if the head of the list has changed. * * Assumptions: diff --git a/sched/sched/sched_addreadytorun.c b/sched/sched/sched_addreadytorun.c index 880f4b85bb..2f5a7704c9 100644 --- a/sched/sched/sched_addreadytorun.c +++ b/sched/sched/sched_addreadytorun.c @@ -60,10 +60,10 @@ * instead. The pending tasks will be made ready-to-run when preemption is * unlocked. * - * Inputs: + * Input Parameters: * btcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * @@ -144,10 +144,10 @@ bool sched_addreadytorun(FAR struct tcb_s *btcb) * g_pendingtasks list instead. The pending tasks will be made * ready-to-run when preemption isunlocked. * - * Inputs: + * Input Parameters: * btcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * diff --git a/sched/sched/sched_cpuload.c b/sched/sched/sched_cpuload.c index ef35c39848..1ee7275bd3 100644 --- a/sched/sched/sched_cpuload.c +++ b/sched/sched/sched_cpuload.c @@ -110,10 +110,10 @@ volatile uint32_t g_cpuload_total; * Description: * Collect data that can be used for CPU load measurements. * - * Inputs: + * Input Parameters: * cpu - The CPU that we are performing the load operations on. * - * Return Value: + * Returned Value: * None * * Assumptions/Limitations: @@ -156,10 +156,10 @@ static inline void sched_cpu_process_cpuload(int cpu) * Description: * Collect data that can be used for CPU load measurements. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions/Limitations: @@ -228,7 +228,7 @@ void weak_function sched_process_cpuload(void) * pid - The task ID of the thread of interest. pid == 0 is the IDLE thread. * cpuload - The location to return the CPU load * - * Return Value: + * Returned Value: * OK (0) on success; a negated errno value on failure. The only reason * that this function can fail is if 'pid' no longer refers to a valid * thread. diff --git a/sched/sched/sched_cpuselect.c b/sched/sched/sched_cpuselect.c index c995cb8764..b96436cdd4 100644 --- a/sched/sched/sched_cpuselect.c +++ b/sched/sched/sched_cpuselect.c @@ -65,10 +65,10 @@ * Return the index to the CPU with the lowest priority running task, * possbily its IDLE task. * - * Inputs: + * Input Parameters: * affinity - The set of CPUs on which the thread is permitted to run. * - * Return Value: + * Returned Value: * Index of the CPU with the lowest priority running task * * Assumptions: diff --git a/sched/sched/sched_foreach.c b/sched/sched/sched_foreach.c index 1ee962d772..3bd7898a84 100644 --- a/sched/sched/sched_foreach.c +++ b/sched/sched/sched_foreach.c @@ -59,7 +59,7 @@ * handler - The function to be called with the TCB of * each task * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_garbage.c b/sched/sched/sched_garbage.c index 7c853232d0..a5fce0c8d0 100644 --- a/sched/sched/sched_garbage.c +++ b/sched/sched/sched_garbage.c @@ -53,7 +53,7 @@ * Description: * Clean-up deferred de-allocations of user memory * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -110,7 +110,7 @@ static inline void sched_kucleanup(void) * Description: * Return TRUE if there is user heap garbage to be collected. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -133,7 +133,7 @@ static inline bool sched_have_kugarbage(void) * Description: * Clean-up deferred de-allocations of kernel memory * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -184,7 +184,7 @@ static inline void sched_kcleanup(void) * Description: * Return TRUE if there is kernal heap garbage to be collected. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -220,7 +220,7 @@ static inline bool sched_have_kgarbage(void) * collection to be called from the IDLE thread because it runs at a very * low priority and could cause false memory out conditions. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -254,7 +254,7 @@ void sched_garbage_collection(void) * state. The looping nature of the IDLE loops should catch any missed * garbage from the test on the next time arround. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/sched/sched/sched_getfiles.c b/sched/sched/sched_getfiles.c index 7e634053d9..d36fe7f0c0 100644 --- a/sched/sched/sched_getfiles.c +++ b/sched/sched/sched_getfiles.c @@ -58,7 +58,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the errno. * * Assumptions: diff --git a/sched/sched/sched_getparam.c b/sched/sched/sched_getparam.c index 9c164e374d..c1668d00c5 100644 --- a/sched/sched/sched_getparam.c +++ b/sched/sched/sched_getparam.c @@ -64,14 +64,14 @@ * use by application logic. Applications should use the standard * sched_getparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority * of the calling task is returned. * param - A structure whose member sched_priority is the integer * priority. The task's priority is copied to the sched_priority * element of this structure. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -165,14 +165,14 @@ int nxsched_getparam (pid_t pid, FAR struct sched_param *param) * pid. This function is a simply wrapper around nxsched_getparam() that * sets the errno value in the event of an error. * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority * of the calling task is returned. * param - A structure whose member sched_priority is the integer * priority. The task's priority is copied to the sched_priority * element of this structure. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise -1 (ERROR) with the errno value set * to indicate the nature of the problem. * diff --git a/sched/sched/sched_getscheduler.c b/sched/sched/sched_getscheduler.c index 1ca4cf64ed..13150854ba 100644 --- a/sched/sched/sched_getscheduler.c +++ b/sched/sched/sched_getscheduler.c @@ -68,11 +68,11 @@ * use by application logic. Applications should use the standard * sched_getscheduler(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to query. If pid is zero, the * calling task is queried. * - * Return Value: + * Returned Value: * On success, sched_getscheduler() returns the policy for the task * (either SCHED_FIFO or SCHED_RR). On error, a negated errno value * returned: @@ -121,11 +121,11 @@ int nxsched_getscheduler(pid_t pid) * sched_getscheduler() is a simply wrapper around nxsched_getscheduler() * that sets the errno value in the event of an error. * - * Inputs: + * Input Parameters: * pid - the task ID of the task to query. If pid is zero, the * calling task is queried. * - * Return Value: + * Returned Value: * On success, sched_getscheduler() returns the policy for the task * (either SCHED_FIFO or SCHED_RR). On error, ERROR (-1) is * returned, and errno is set appropriately: diff --git a/sched/sched/sched_getsockets.c b/sched/sched/sched_getsockets.c index 2601f90783..a2dfdedd18 100644 --- a/sched/sched/sched_getsockets.c +++ b/sched/sched/sched_getsockets.c @@ -57,7 +57,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the errno. * * Assumptions: diff --git a/sched/sched/sched_getstreams.c b/sched/sched/sched_getstreams.c index 91f3c9f6f3..0a99a1e453 100644 --- a/sched/sched/sched_getstreams.c +++ b/sched/sched/sched_getstreams.c @@ -54,7 +54,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the errno. * * Assumptions: diff --git a/sched/sched/sched_lock.c b/sched/sched/sched_lock.c index 708b7780b1..a7a55ac264 100644 --- a/sched/sched/sched_lock.c +++ b/sched/sched/sched_lock.c @@ -132,10 +132,10 @@ volatile cpu_set_t g_cpu_lockset SP_SECTION; * either calls sched_unlock() (the appropriate number of times) or * until it blocks itself. * - * Inputs + * Input Parameters: * None * - * Return Value: + * Returned Value: * OK on success; ERROR on failure * ****************************************************************************/ diff --git a/sched/sched/sched_lockcount.c b/sched/sched/sched_lockcount.c index c3a8ef1903..9aeef35894 100644 --- a/sched/sched/sched_lockcount.c +++ b/sched/sched/sched_lockcount.c @@ -57,10 +57,10 @@ * execution. sched_unlock() will have to called that many times from * this thread in order to re-enable pre-emption. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * lockcount * ****************************************************************************/ diff --git a/sched/sched/sched_mergepending.c b/sched/sched/sched_mergepending.c index 6e258c7554..826a0e7833 100644 --- a/sched/sched/sched_mergepending.c +++ b/sched/sched/sched_mergepending.c @@ -68,10 +68,10 @@ * This function merges the prioritized g_pendingtasks list into the * prioritized ready-to-run task list. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * true if the head of the ready-to-run task list has changed indicating * a context switch is needed. * @@ -173,10 +173,10 @@ bool sched_mergepending(void) * This function merges the prioritized g_pendingtasks list into the * prioritized ready-to-run task list. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * true if the head of the ready-to-run task list has changed indicating * a context switch is needed. * diff --git a/sched/sched/sched_mergeprioritized.c b/sched/sched/sched_mergeprioritized.c index 7ff70b14df..7fb7d07284 100644 --- a/sched/sched/sched_mergeprioritized.c +++ b/sched/sched/sched_mergeprioritized.c @@ -58,14 +58,14 @@ * into the prioritized task list, 'list2'. On return 'list2' will contain * the prioritized content of both lists; 'list1' will be empty. * - * Inputs: + * Input Parameters: * list1 - Points to the prioritized list to merge into list 1. This list * will be empty upon return. * list2 - That list that will contained the prioritized content of * both lists upon return. * task_state - The task state/list index associated with list2. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_releasetcb.c b/sched/sched/sched_releasetcb.c index b7046aa790..26ab60b7f7 100644 --- a/sched/sched/sched_releasetcb.c +++ b/sched/sched/sched_releasetcb.c @@ -102,7 +102,7 @@ static void sched_releasepid(pid_t pid) * however, there are certain error recovery contexts where the TCB my * not be fully initialized when sched_releasetcb is called. * - * Return Value: + * Returned Value: * OK on success; ERROR on failure * * Assumptions: diff --git a/sched/sched/sched_removeblocked.c b/sched/sched/sched_removeblocked.c index 36c92e96f0..9ed15a98bb 100644 --- a/sched/sched/sched_removeblocked.c +++ b/sched/sched/sched_removeblocked.c @@ -55,10 +55,10 @@ * This function removes a TCB from one of the blocked state task * lists as inferred from the task_state inside the TCB. * - * Inputs: + * Input Parameters: * btcb - Points to the TCB that is blocked * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_removereadytorun.c b/sched/sched/sched_removereadytorun.c index f5e93b881c..78919d4989 100644 --- a/sched/sched/sched_removereadytorun.c +++ b/sched/sched/sched_removereadytorun.c @@ -57,10 +57,10 @@ * Description: * This function removes a TCB from the ready to run list. * - * Inputs: + * Input Parameters: * rtcb - Points to the TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * @@ -116,10 +116,10 @@ bool sched_removereadytorun(FAR struct tcb_s *rtcb) * Description: * This function removes a TCB from the ready to run list. * - * Inputs: + * Input Parameters: * rtcb - Points to the TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * diff --git a/sched/sched/sched_reprioritize.c b/sched/sched/sched_reprioritize.c index 66112c3da0..3c65eec35f 100644 --- a/sched/sched/sched_reprioritize.c +++ b/sched/sched/sched_reprioritize.c @@ -63,11 +63,11 @@ * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * On success, sched_reporioritize() returns 0 (OK). On error, a negated * errno value is returned. * diff --git a/sched/sched/sched_roundrobin.c b/sched/sched/sched_roundrobin.c index 9aa5a6b8ed..798b4265cf 100644 --- a/sched/sched/sched_roundrobin.c +++ b/sched/sched/sched_roundrobin.c @@ -73,12 +73,12 @@ * Description: * Check if the currently executing task has exceeded its time slice. * - * Inputs: + * Input Parameters: * tcb - The TCB of the currently executing task * ticks - The number of ticks that have elapsed on the interval timer. * noswitches - True: Can't do context switches now. * - * Return Value: + * Returned Value: * The number if ticks remaining until the next time slice expires. * Zero is returned if there is no time slicing (i.e., the task at the * head of the ready-to-run list does not support round robin diff --git a/sched/sched/sched_rrgetinterval.c b/sched/sched/sched_rrgetinterval.c index 3faefb44d2..fc96d8bd3b 100644 --- a/sched/sched/sched_rrgetinterval.c +++ b/sched/sched/sched_rrgetinterval.c @@ -62,12 +62,12 @@ * is written into 'interval. The identified process should be running * under the SCHED_RRscheduling policy.' * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority of the * calling task is returned. * interval - a structure used to return the time slice * - * Return Value: + * Returned Value: * On success, sched_rr_get_interval() returns OK (0). On error, * ERROR (-1) is returned, and errno is set to: * diff --git a/sched/sched/sched_setaffinity.c b/sched/sched/sched_setaffinity.c index 06ab16f865..d9ba779669 100644 --- a/sched/sched/sched_setaffinity.c +++ b/sched/sched/sched_setaffinity.c @@ -72,12 +72,12 @@ * is not intended for use by application logic. Applications should * use the standard sched_setparam(). * - * Inputs: + * Input Parameters: * pid - The ID of thread whose affinity set will be modified. * cpusetsize - Size of mask. MUST be sizeofcpu_set_t(). * mask - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * Zero (OK) if successful. Otherwise, a negated errno value is returned: * * ESRCH The task whose ID is pid could not be found. @@ -180,12 +180,12 @@ errout_with_lock: * This function is a simply wrapper around nxsched_setaffinity() that sets * the errno value in the event of an error. * - * Inputs: + * Input Parameters: * pid - The ID of thread whose affinity set will be modified. * cpusetsize - Size of mask. MUST be sizeofcpu_set_t(). * mask - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, ERROR (-1) is returned, and errno is * set appropriately: * diff --git a/sched/sched/sched_setparam.c b/sched/sched/sched_setparam.c index 33307f1575..9a36299d7b 100644 --- a/sched/sched/sched_setparam.c +++ b/sched/sched/sched_setparam.c @@ -72,14 +72,14 @@ * use by application logic. Applications should use the standard * sched_setparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to reprioritize. If pid is zero, the * priority of the calling task is changed. * param - A structure whose member sched_priority is the integer priority. * The range of valid priority numbers is from SCHED_PRIORITY_MIN * through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -239,14 +239,14 @@ errout_with_lock: * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * pid - the task ID of the task to reprioritize. If pid is zero, the * priority of the calling task is changed. * param - A structure whose member sched_priority is the integer priority. * The range of valid priority numbers is from SCHED_PRIORITY_MIN * through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * On success, sched_setparam() returns 0 (OK). On error, -1 (ERROR) is * returned, and errno is set appropriately. * diff --git a/sched/sched/sched_setpriority.c b/sched/sched/sched_setpriority.c index 1e8cbd41bf..ead70de4fd 100644 --- a/sched/sched/sched_setpriority.c +++ b/sched/sched/sched_setpriority.c @@ -59,10 +59,10 @@ * Description: * Get the next highest priority ready-to-run task. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * - * Return Value: + * Returned Value: * TCB of the next highest priority ready-to-run task. * ****************************************************************************/ @@ -124,11 +124,11 @@ static FAR struct tcb_s *sched_nexttcb(FAR struct tcb_s *tcb) * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -178,11 +178,11 @@ static inline void sched_running_setpriority(FAR struct tcb_s *tcb, * the position of the task in the ready-to-run list and if the priority * is increased, may cause the task to become running. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -267,11 +267,11 @@ static void sched_readytorun_setpriority(FAR struct tcb_s *tcb, * Change the priority of a blocked tasks. The only issue here is that * the task may like in a prioritized or an non-prioritized queue. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -324,11 +324,11 @@ static inline void sched_blocked_setpriority(FAR struct tcb_s *tcb, * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * On success, nxsched_setpriority() returns 0 (OK). On error, a negated * errno value is returned. * diff --git a/sched/sched/sched_timerexpiration.c b/sched/sched/sched_timerexpiration.c index d00150654f..b1c137535a 100644 --- a/sched/sched/sched_timerexpiration.c +++ b/sched/sched/sched_timerexpiration.c @@ -162,12 +162,12 @@ static struct timespec g_stop_time; * Check for operations specific to scheduling policy of the currently * active task on a single CPU. * - * Inputs: + * Input Parameters: * cpu - The CPU that we are performing the scheduler operations on. * ticks - The number of ticks that have elapsed on the interval timer. * noswitches - True: Can't do context switches now. * - * Return Value: + * Returned Value: * The number if ticks remaining until the next time slice expires. * Zero is returned if there is no time slicing (i.e., the task at the * head of the ready-to-run list does not support round robin @@ -264,11 +264,11 @@ static uint32_t sched_cpu_scheduler(int cpu, uint32_t ticks, bool noswitches) * Check for operations specific to scheduling policy of the currently * active task on a single CPU. * - * Inputs: + * Input Parameters: * ticks - The number of ticks that have elapsed on the interval timer. * noswitches - True: Can't do context switches now. * - * Return Value: + * Returned Value: * The number if ticks remaining until the next time slice expires. * Zero is returned if there is no time slicing (i.e., the task at the * head of the ready-to-run list does not support round robin diff --git a/sched/sched/sched_waitpid.c b/sched/sched/sched_waitpid.c index 1763ee966f..faca0216aa 100644 --- a/sched/sched/sched_waitpid.c +++ b/sched/sched/sched_waitpid.c @@ -147,7 +147,7 @@ * stat_loc - The location to return the exit status * options - ignored * - * Return Value: + * Returned Value: * If waitpid() returns because the status of a child process is available, * it will return a value equal to the process ID of the child process for * which status is reported. diff --git a/sched/sched/sched_yield.c b/sched/sched/sched_yield.c index e9e62920f9..320de61c10 100644 --- a/sched/sched/sched_yield.c +++ b/sched/sched/sched_yield.c @@ -54,10 +54,10 @@ * This function forces the calling task to give up the CPU (only to other * tasks at the same priority). * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) (errno is not set) * * Assumptions: diff --git a/sched/semaphore/sem_destroy.c b/sched/semaphore/sem_destroy.c index 5cc05f222c..7c0522d29f 100644 --- a/sched/semaphore/sem_destroy.c +++ b/sched/semaphore/sem_destroy.c @@ -65,7 +65,7 @@ * Parameters: * sem - Semaphore to be destroyed. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -119,7 +119,7 @@ int nxsem_destroy (FAR sem_t *sem) * Parameters: * sem - Semaphore to be destroyed. * - * Return Value: + * Returned Value: * This function is a application interface. It returns zero (OK) if * successful. Otherwise, -1 (ERROR) is returned and the errno value is * set appropriately. diff --git a/sched/semaphore/sem_holder.c b/sched/semaphore/sem_holder.c index 3080c3080f..9095f98e7f 100644 --- a/sched/semaphore/sem_holder.c +++ b/sched/semaphore/sem_holder.c @@ -717,7 +717,7 @@ static int nxsem_restoreholderprioB(FAR struct semholder_s *pholder, * - If it is >0 then there should be no threads waiting for counts and * stcb should be null. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -778,7 +778,7 @@ static inline void nxsem_restorebaseprio_irq(FAR struct tcb_s *stcb, * - If it is >0 then there should be no threads waiting for counts and * stcb should be null. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -848,7 +848,7 @@ static inline void nxsem_restorebaseprio_task(FAR struct tcb_s *stcb, * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -882,7 +882,7 @@ void nxsem_initholders(void) * Parameters: * sem - A reference to the semaphore being destroyed * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -933,7 +933,7 @@ void nxsem_destroyholder(FAR sem_t *sem) * htcb - TCB of the thread that just obtained the semaphore * sem - A reference to the incremented semaphore * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) if unsuccessful * * Assumptions: @@ -976,7 +976,7 @@ void nxsem_addholder_tcb(FAR struct tcb_s *htcb, FAR sem_t *sem) * Parameters: * sem - A reference to the incremented semaphore * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) if unsuccessful * * Assumptions: @@ -998,7 +998,7 @@ void nxsem_addholder(FAR sem_t *sem) * Parameters: * None * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) if unsuccessful * * Assumptions: @@ -1027,7 +1027,7 @@ void nxsem_boostpriority(FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore being posted * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1077,7 +1077,7 @@ void nxsem_releaseholder(FAR sem_t *sem) * - If it is >0 then there should be no threads waiting for counts and * stcb should be null. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1122,7 +1122,7 @@ void nxsem_restorebaseprio(FAR struct tcb_s *stcb, FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore no longer being waited for * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1151,7 +1151,7 @@ void nxsem_canceled(FAR struct tcb_s *stcb, FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1177,7 +1177,7 @@ void sem_enumholders(FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore * - * Return Value: + * Returned Value: * The number of available holder containers * * Assumptions: diff --git a/sched/semaphore/sem_initialize.c b/sched/semaphore/sem_initialize.c index 769313781c..3b629de0a4 100644 --- a/sched/semaphore/sem_initialize.c +++ b/sched/semaphore/sem_initialize.c @@ -59,7 +59,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/semaphore/sem_post.c b/sched/semaphore/sem_post.c index f20cb68c77..67822aca19 100644 --- a/sched/semaphore/sem_post.c +++ b/sched/semaphore/sem_post.c @@ -74,7 +74,7 @@ * Parameters: * sem - Semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -211,7 +211,7 @@ int nxsem_post(FAR sem_t *sem) * Parameters: * sem - Semaphore descriptor * - * Return Value: + * Returned Value: * This function is a standard, POSIX application interface. It will * return zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/sched/semaphore/sem_recover.c b/sched/semaphore/sem_recover.c index 6305f0d35e..343ba330a9 100644 --- a/sched/semaphore/sem_recover.c +++ b/sched/semaphore/sem_recover.c @@ -64,10 +64,10 @@ * only the task, there is not mechanism to traverse all of the semaphores * with counts held by the task. * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/semaphore/sem_reset.c b/sched/semaphore/sem_reset.c index 28a0965a4c..81f8fce83a 100644 --- a/sched/semaphore/sem_reset.c +++ b/sched/semaphore/sem_reset.c @@ -64,7 +64,7 @@ * sem - Semaphore descriptor to be reset * count - The requested semaphore count * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/sched/semaphore/sem_setprotocol.c b/sched/semaphore/sem_setprotocol.c index f4b202b22b..be98b88c17 100644 --- a/sched/semaphore/sem_setprotocol.c +++ b/sched/semaphore/sem_setprotocol.c @@ -82,7 +82,7 @@ * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -153,7 +153,7 @@ int nxsem_setprotocol(FAR sem_t *sem, int protocol) * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/sched/semaphore/sem_tickwait.c b/sched/semaphore/sem_tickwait.c index 350a7a1cec..fd549e4aa3 100644 --- a/sched/semaphore/sem_tickwait.c +++ b/sched/semaphore/sem_tickwait.c @@ -76,7 +76,7 @@ * posted. If ticks is zero, then this function is equivalent * to nxsem_trywait(). * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/sched/semaphore/sem_timedwait.c b/sched/semaphore/sem_timedwait.c index 98e5c84b2b..a5ae5116f4 100644 --- a/sched/semaphore/sem_timedwait.c +++ b/sched/semaphore/sem_timedwait.c @@ -86,7 +86,7 @@ * sem - Semaphore object * abstime - The absolute time to wait until a timeout is declared. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -235,7 +235,7 @@ errout_with_irqdisabled: * sem - Semaphore object * abstime - The absolute time to wait until a timeout is declared. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success. On failure, -1 (ERROR) is returned * and the errno is set appropriately: * diff --git a/sched/semaphore/sem_timeout.c b/sched/semaphore/sem_timeout.c index 377793930b..d4ba2a0d88 100644 --- a/sched/semaphore/sem_timeout.c +++ b/sched/semaphore/sem_timeout.c @@ -63,7 +63,7 @@ * argc - The number of arguments (should be 1) * pid - The task ID of the task to wakeup * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/semaphore/sem_trywait.c b/sched/semaphore/sem_trywait.c index e990427c45..d7480e0540 100644 --- a/sched/semaphore/sem_trywait.c +++ b/sched/semaphore/sem_trywait.c @@ -65,7 +65,7 @@ * Parameters: * sem - the semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -136,7 +136,7 @@ int nxsem_trywait(FAR sem_t *sem) * Parameters: * sem - the semaphore descriptor * - * Return Value: + * Returned Value: * Zero (OK) on success or -1 (ERROR) if unsuccessful. If this function * returns -1(ERROR), then the cause of the failure will be reported in * errno variable as: diff --git a/sched/semaphore/sem_wait.c b/sched/semaphore/sem_wait.c index 5b2b8ceb5d..9bb1d3105c 100644 --- a/sched/semaphore/sem_wait.c +++ b/sched/semaphore/sem_wait.c @@ -72,7 +72,7 @@ * Parameters: * sem - Semaphore descriptor. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -221,7 +221,7 @@ int nxsem_wait(FAR sem_t *sem) * Parameters: * sem - Semaphore descriptor. * - * Return Value: + * Returned Value: * This function is a standard, POSIX application interface. It returns * zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. Possible errno values include: diff --git a/sched/semaphore/sem_waitirq.c b/sched/semaphore/sem_waitirq.c index 4ca202f07e..11254e8fcb 100644 --- a/sched/semaphore/sem_waitirq.c +++ b/sched/semaphore/sem_waitirq.c @@ -70,7 +70,7 @@ * errcode - EINTR if the semaphore wait was awakened by a signal; * ETIMEDOUT if awakened by a timeout * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/signal/sig_action.c b/sched/signal/sig_action.c index 1b2f3be67e..d40ec627ed 100644 --- a/sched/signal/sig_action.c +++ b/sched/signal/sig_action.c @@ -139,7 +139,7 @@ static FAR sigactq_t *nxsig_alloc_action(void) * act - Location of new handler * oact - Location to store only handler * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal number is invalid. * (errno is not set) * diff --git a/sched/signal/sig_pending.c b/sched/signal/sig_pending.c index 7dc44fc456..4dc27e0d98 100644 --- a/sched/signal/sig_pending.c +++ b/sched/signal/sig_pending.c @@ -62,7 +62,7 @@ * Parameters: * set - The location to return the pending signal set. * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) * * Assumptions: diff --git a/sched/signal/sig_procmask.c b/sched/signal/sig_procmask.c index 19bf70316e..27f1d77102 100644 --- a/sched/signal/sig_procmask.c +++ b/sched/signal/sig_procmask.c @@ -92,7 +92,7 @@ * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -197,7 +197,7 @@ int nxsig_procmask(int how, FAR const sigset_t *set, FAR sigset_t *oset) * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * This function will return 0 (OK) on success or -1 (ERROR) if how is * invalid. In the latter case, the errno variable will be set to EINVAL. * diff --git a/sched/signal/sig_queue.c b/sched/signal/sig_queue.c index 455b7ea72d..00e08f26c0 100644 --- a/sched/signal/sig_queue.c +++ b/sched/signal/sig_queue.c @@ -76,7 +76,7 @@ * signo - Signal number * value - Value to pass to task with signal * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -157,7 +157,7 @@ int nxsig_queue(int pid, int signo, void *sival_ptr) * signo - Signal number * value - Value to pass to task with signal * - * Return Value: + * Returned Value: * On success (at least one signal was sent), zero (OK) is returned. On * any failure, -1 (ERROR) is returned and errno varaible is set * appropriately: diff --git a/sched/signal/sig_suspend.c b/sched/signal/sig_suspend.c index 4bfc114b34..8a8c068cdf 100644 --- a/sched/signal/sig_suspend.c +++ b/sched/signal/sig_suspend.c @@ -75,7 +75,7 @@ * Parameters: * set - signal mask to use while suspended. * - * Return Value: + * Returned Value: * -1 (ERROR) always * * Assumptions: diff --git a/sched/signal/sig_timedwait.c b/sched/signal/sig_timedwait.c index 01b735ffec..edc8a2c990 100644 --- a/sched/signal/sig_timedwait.c +++ b/sched/signal/sig_timedwait.c @@ -226,7 +226,7 @@ void nxsig_wait_irq(FAR struct tcb_s *wtcb, int errcode) * info - The returned value (may be NULL). * timeout - The amount of time to wait (may be NULL) * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -483,7 +483,7 @@ int nxsig_timedwait(FAR const sigset_t *set, FAR struct siginfo *info, * info - The returned value (may be NULL). * timeout - The amount of time to wait (may be NULL) * - * Return Value: + * Returned Value: * Signal number that cause the wait to be terminated, otherwise -1 (ERROR) * is returned with errno set to either: * diff --git a/sched/signal/sig_waitinfo.c b/sched/signal/sig_waitinfo.c index 92d11acf28..0bac27e33f 100644 --- a/sched/signal/sig_waitinfo.c +++ b/sched/signal/sig_waitinfo.c @@ -59,7 +59,7 @@ * set - The pending signal set * info - The returned value * - * Return Value: + * Returned Value: * Signal number that cause the wait to be terminated, otherwise -1 (ERROR) * is returned and the errno variable is set appropriately. * diff --git a/sched/task/task_activate.c b/sched/task/task_activate.c index 47791c7a25..18dad9c71f 100644 --- a/sched/task/task_activate.c +++ b/sched/task/task_activate.c @@ -60,7 +60,7 @@ * Input Parameters: * tcb - The TCB for the task for the task (same as the task_init argument). * - * Return Value: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/sched/task/task_atexit.c b/sched/task/task_atexit.c index ba26f3ab8c..91c6c9c639 100644 --- a/sched/task/task_atexit.c +++ b/sched/task/task_atexit.c @@ -82,7 +82,7 @@ * Input Parameters: * func - A pointer to the function to be called when the task exits. * - * Return Value: + * Returned Value: * Zero on success. Non-zero on failure. * ****************************************************************************/ diff --git a/sched/task/task_cancelpt.c b/sched/task/task_cancelpt.c index bcd03621a9..9220264278 100644 --- a/sched/task/task_cancelpt.c +++ b/sched/task/task_cancelpt.c @@ -103,7 +103,7 @@ * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * @@ -194,7 +194,7 @@ bool enter_cancellation_point(void) * Input Parameters: * None * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -274,7 +274,7 @@ void leave_cancellation_point(void) * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * diff --git a/sched/task/task_create.c b/sched/task/task_create.c index c1cdedba29..f09d04578c 100644 --- a/sched/task/task_create.c +++ b/sched/task/task_create.c @@ -78,7 +78,7 @@ * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. @@ -224,7 +224,7 @@ errout_with_tcb: * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. @@ -265,7 +265,7 @@ int nxtask_create(FAR const char *name, int priority, * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the non-zero process ID of the new task or ERROR if memory is * insufficient or the task cannot be created. The errno will be set in * the failure case to indicate the nature of the error. @@ -306,7 +306,7 @@ int task_create(FAR const char *name, int priority, * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. diff --git a/sched/task/task_exit.c b/sched/task/task_exit.c index f42ef1421e..a7e8522f4f 100644 --- a/sched/task/task_exit.c +++ b/sched/task/task_exit.c @@ -69,10 +69,10 @@ * and task_restart(). In the last two cases, the task will be terminated * as though exit() were called. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * OK on success; or ERROR on failure * * Assumeptions: diff --git a/sched/task/task_getgroup.c b/sched/task/task_getgroup.c index 34f52c2c9c..871d4b1f4c 100644 --- a/sched/task/task_getgroup.c +++ b/sched/task/task_getgroup.c @@ -60,7 +60,7 @@ * Parameters: * pid - The task ID to use in the lookup. * - * Return Value: + * Returned Value: * On success, a pointer to the group task structure is returned. This * function can fail only if there is no group that corresponds to the * groupd ID. diff --git a/sched/task/task_init.c b/sched/task/task_init.c index f9b7002d33..2d15f84736 100644 --- a/sched/task/task_init.c +++ b/sched/task/task_init.c @@ -80,7 +80,7 @@ * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. (See * task_schedsetup() for possible failure conditions). On failure, the * caller is responsible for freeing the stack memory and for calling diff --git a/sched/task/task_onexit.c b/sched/task/task_onexit.c index 6d3d47fce6..135ed2b657 100644 --- a/sched/task/task_onexit.c +++ b/sched/task/task_onexit.c @@ -84,7 +84,7 @@ * arg - An argument that will be provided to the on_exit() function when * the task exits. * - * Return Value: + * Returned Value: * Zero on success. Non-zero on failure. * ****************************************************************************/ diff --git a/sched/task/task_recover.c b/sched/task/task_recover.c index 7c6bee2114..c4fea9b9b0 100644 --- a/sched/task/task_recover.c +++ b/sched/task/task_recover.c @@ -63,10 +63,10 @@ * via pthread_cancel. I checks checks for semaphores, message queue, and * watchdog timer resources stranded in bad conditions. * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/task/task_reparent.c b/sched/task/task_reparent.c index 075a391940..88f2bb8b45 100644 --- a/sched/task/task_reparent.c +++ b/sched/task/task_reparent.c @@ -64,7 +64,7 @@ * of the current parent task) * chpid - PID of the child to be reparented. * - * Return Value: + * Returned Value: * 0 (OK) on success; A negated errno value on failure. * ****************************************************************************/ diff --git a/sched/task/task_restart.c b/sched/task/task_restart.c index c7ad08e384..a8ff657068 100644 --- a/sched/task/task_restart.c +++ b/sched/task/task_restart.c @@ -63,11 +63,11 @@ * reinitialized with same ID, priority, original entry point, stack size, * and parameters it had when it was first started. * - * Inputs: + * Input Parameters: * pid - The task ID of the task to delete. An ID of zero signifies the * calling task. * - * Return Value: + * Returned Value: * OK on sucess; ERROR on failure. * * This function can fail if: diff --git a/sched/task/task_setup.c b/sched/task/task_setup.c index fc2ff3f6c8..8389e2bc54 100644 --- a/sched/task/task_setup.c +++ b/sched/task/task_setup.c @@ -82,10 +82,10 @@ static const char g_noname[] = ""; * Description: * This function assigns the next unique task ID to a task. * - * Inputs: + * Input Parameters: * tcb - TCB of task * - * Return: + * Returned Value: * OK on success; ERROR on failure (errno is not set) * ****************************************************************************/ @@ -344,7 +344,7 @@ static inline void task_dupdspace(FAR struct tcb_s *tcb) * entry - Thread user entry point * ttype - Type of the new thread: task, pthread, or kernel thread * - * Return Value: + * Returned Value: * OK on success; ERROR on failure. * * This function can only failure is it is unable to assign a new, unique @@ -449,7 +449,7 @@ static int thread_schedsetup(FAR struct tcb_s *tcb, int priority, * tcb - Address of the new task's TCB * name - Name of the new task * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -491,7 +491,7 @@ static void task_namesetup(FAR struct task_tcb_s *tcb, FAR const char *name) * terminated with a NULL argv[] value. If no parameters are * required, argv may be NULL. * - * Return Value: + * Returned Value: * Zero (OK) on success; a negated errno on failure. * ****************************************************************************/ @@ -631,7 +631,7 @@ static inline int task_stackargsetup(FAR struct task_tcb_s *tcb, * main - Application start point of the new task * ttype - Type of the new thread: task or kernel thread * - * Return Value: + * Returned Value: * OK on success; ERROR on failure. * * This function can only failure is it is unable to assign a new, unique @@ -664,7 +664,7 @@ int task_schedsetup(FAR struct task_tcb_s *tcb, int priority, start_t start, * entry - Entry point of the new pthread * ttype - Type of the new thread: task, pthread, or kernel thread * - * Return Value: + * Returned Value: * OK on success; ERROR on failure. * * This function can only failure is it is unable to assign a new, unique @@ -709,7 +709,7 @@ int pthread_schedsetup(FAR struct pthread_tcb_s *tcb, int priority, * terminated with a NULL argv[] value. If no parameters are * required, argv may be NULL. * - * Return Value: + * Returned Value: * OK * ****************************************************************************/ diff --git a/sched/task/task_start.c b/sched/task/task_start.c index b1f1e3cd1a..a0c88329e5 100644 --- a/sched/task/task_start.c +++ b/sched/task/task_start.c @@ -70,10 +70,10 @@ * execution of a task. It receives initial control when the task is * started and calls main entry point of the newly started task. * - * Inputs: + * Input Parameters: * None * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/task/task_starthook.c b/sched/task/task_starthook.c index 6bf8de9695..908629a646 100644 --- a/sched/task/task_starthook.c +++ b/sched/task/task_starthook.c @@ -58,12 +58,12 @@ * The start hook is useful, for example, for setting up automatic * configuration of C++ constructors. * - * Inputs: + * Input Parameters: * tcb - The new, unstarted task task that needs the start hook * starthook - The pointer to the start hook function * arg - The argument to pass to the start hook function. * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/task/task_terminate.c b/sched/task/task_terminate.c index 2edb749277..8215d70f9c 100644 --- a/sched/task/task_terminate.c +++ b/sched/task/task_terminate.c @@ -84,13 +84,13 @@ * exit() and pthread_exit(). In those cases task_exithook() has already * been called with nonblocking == false; * - * Inputs: + * Input Parameters: * pid - The task ID of the task to delete. A pid of zero * signifies the calling task. * nonblocking - True: The task is an unhealthy, partially torn down * state and is not permitted to block. * - * Return Value: + * Returned Value: * OK on success; or ERROR on failure * * This function can fail if the provided pid does not correspond to a diff --git a/sched/task/task_vfork.c b/sched/task/task_vfork.c index 7b4f53a123..124a7fd077 100644 --- a/sched/task/task_vfork.c +++ b/sched/task/task_vfork.c @@ -82,7 +82,7 @@ * tcb - Address of the new task's TCB * name - Name of the new task * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -110,7 +110,7 @@ static inline void vfork_namesetup(FAR struct tcb_s *parent, * parent - Address of the parent task's TCB * child - Address of the child task's TCB * - * Return Value: + * Returned Value: * Zero (OK) on success; a negated errno on failure. * ****************************************************************************/ @@ -177,7 +177,7 @@ static inline int vfork_stackargsetup(FAR struct tcb_s *parent, * parent - Address of the parent task's TCB * child - Address of the child task's TCB * - * Return Value: + * Returned Value: * Zero (OK) on success; a negated errno on failure. * ****************************************************************************/ diff --git a/sched/timer/timer_create.c b/sched/timer/timer_create.c index e6c775093d..f842690a92 100644 --- a/sched/timer/timer_create.c +++ b/sched/timer/timer_create.c @@ -146,7 +146,7 @@ static FAR struct posix_timer_s *timer_allocate(void) * asynchronous notification. evp may be NULL (see above). * timerid - The pre-thread timer created by the call to timer_create(). * - * Return Value: + * Returned Value: * If the call succeeds, timer_create() will return 0 (OK) and update the * location referenced by timerid to a timer_t, which can be passed to the * other per-thread timer calls. If an error occurs, the function will diff --git a/sched/timer/timer_delete.c b/sched/timer/timer_delete.c index 6d6e5bebc1..63a189427d 100644 --- a/sched/timer/timer_delete.c +++ b/sched/timer/timer_delete.c @@ -64,7 +64,7 @@ * timerid - The per-thread timer, previously created by the call to * timer_create(), to be deleted. * - * Return Value: + * Returned Value: * If the call succeeds, timer_create() will return 0 (OK). Otherwise, * the function will return a value of -1 (ERROR) and set errno to * indicate the error. diff --git a/sched/timer/timer_getoverrun.c b/sched/timer/timer_getoverrun.c index da07dcedca..c5aaee8799 100644 --- a/sched/timer/timer_getoverrun.c +++ b/sched/timer/timer_getoverrun.c @@ -76,7 +76,7 @@ * timerid - The pre-thread timer, previously created by the call to * timer_create(), whose overrun count will be returned.. * - * Return Value: + * Returned Value: * If the timer_getoverrun() function succeeds, it will return the timer * expiration overrun count as explained above. timer_getoverrun() will * fail if: diff --git a/sched/timer/timer_gettime.c b/sched/timer/timer_gettime.c index 25e0168765..138b7a5f7d 100644 --- a/sched/timer/timer_gettime.c +++ b/sched/timer/timer_gettime.c @@ -68,7 +68,7 @@ * timerid - The pre-thread timer, previously created by the call to * timer_create(), whose remaining time count will be returned.. * - * Return Value: + * Returned Value: * If the timer_gettime() succeeds, a value of 0 (OK) will be returned. * If an error occurs, the value -1 (ERROR) will be returned, and errno * set to indicate the error. diff --git a/sched/timer/timer_initialize.c b/sched/timer/timer_initialize.c index 25a64b1a51..1ab262c26e 100644 --- a/sched/timer/timer_initialize.c +++ b/sched/timer/timer_initialize.c @@ -91,7 +91,7 @@ volatile sq_queue_t g_alloctimers; * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -132,7 +132,7 @@ void weak_function timer_initialize(void) * Parameters: * pid - the task ID of the thread that exited * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/timer/timer_release.c b/sched/timer/timer_release.c index 2608092a16..eef4fcae6a 100644 --- a/sched/timer/timer_release.c +++ b/sched/timer/timer_release.c @@ -106,7 +106,7 @@ static inline void timer_free(struct posix_timer_s *timer) * timer - The per-thread timer, previously created by the call to * timer_create(), to be deleted. * - * Return Value: + * Returned Value: * If the call succeeds, timer_release() will return 0 (OK) or 1 (meaning * that the timer is still valid). Otherwise, the function will return a * negated errno value: diff --git a/sched/timer/timer_settime.c b/sched/timer/timer_settime.c index 3724ed5ebd..3311de1c7f 100644 --- a/sched/timer/timer_settime.c +++ b/sched/timer/timer_settime.c @@ -77,7 +77,7 @@ static void timer_timeout(int argc, wdparm_t itimer); * Parameters: * timer - A reference to the POSIX timer that just timed out * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -132,7 +132,7 @@ static inline void timer_signotify(FAR struct posix_timer_s *timer) * Parameters: * timer - A reference to the POSIX timer that just timed out * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -165,7 +165,7 @@ static inline void timer_restart(FAR struct posix_timer_s *timer, * itimer - A reference to the POSIX timer that just timed out * signo - The signal to use to wake up the task * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -284,7 +284,7 @@ static void timer_timeout(int argc, wdparm_t itimer) * ovalue - A location in which to return the time remaining from the * previous timer setting. (ignored) * - * Return Value: + * Returned Value: * If the timer_settime() succeeds, a value of 0 (OK) will be returned. * If an error occurs, the value -1 (ERROR) will be returned, and errno set * to indicate the error. diff --git a/sched/wdog/wd_cancel.c b/sched/wdog/wd_cancel.c index 040385d31d..6eaab00c3b 100644 --- a/sched/wdog/wd_cancel.c +++ b/sched/wdog/wd_cancel.c @@ -64,7 +64,7 @@ * Parameters: * wdog - ID of the watchdog to cancel. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned to * indicate the nature of any failure. * diff --git a/sched/wdog/wd_create.c b/sched/wdog/wd_create.c index 8bd6496153..bc8509bad7 100644 --- a/sched/wdog/wd_create.c +++ b/sched/wdog/wd_create.c @@ -63,7 +63,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * Pointer to watchdog (i.e., the watchdog ID), or NULL if insufficient * watchdogs are available. * diff --git a/sched/wdog/wd_delete.c b/sched/wdog/wd_delete.c index 785d4ec87c..46fe6cef5a 100644 --- a/sched/wdog/wd_delete.c +++ b/sched/wdog/wd_delete.c @@ -67,7 +67,7 @@ * wdog - The watchdog ID to delete. This is actually a pointer to a * watchdog structure. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * diff --git a/sched/wdog/wd_gettime.c b/sched/wdog/wd_gettime.c index 0e48dec2f3..1a5c31f9cc 100644 --- a/sched/wdog/wd_gettime.c +++ b/sched/wdog/wd_gettime.c @@ -58,7 +58,7 @@ * Parameters: * wdog - watchdog ID * - * Return Value: + * Returned Value: * The time in system ticks remaining until the watchdog time expires. * Zero means either that wdog is not valid or that the wdog has already * expired. diff --git a/sched/wdog/wd_initialize.c b/sched/wdog/wd_initialize.c index 54b98e4838..17e1e001a5 100644 --- a/sched/wdog/wd_initialize.c +++ b/sched/wdog/wd_initialize.c @@ -90,7 +90,7 @@ static struct wdog_s g_wdpool[CONFIG_PREALLOC_WDOGS]; * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/wdog/wd_recover.c b/sched/wdog/wd_recover.c index 2a4847471b..4b2e28368b 100644 --- a/sched/wdog/wd_recover.c +++ b/sched/wdog/wd_recover.c @@ -58,10 +58,10 @@ * task_delete() or via pthread_cancel(). It checks if the deleted task * is waiting for a timed event and if so cancels the timeout * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/wdog/wd_start.c b/sched/wdog/wd_start.c index f861cbfab7..ec7fa96ec9 100644 --- a/sched/wdog/wd_start.c +++ b/sched/wdog/wd_start.c @@ -101,7 +101,7 @@ typedef void (*wdentry4_t)(int argc, wdparm_t arg1, wdparm_t arg2, * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -209,7 +209,7 @@ static inline void wd_expiration(void) * wdentry - function to call on timeout * parm1..4 - parameters to pass to wdentry * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * @@ -406,7 +406,7 @@ int wd_start(WDOG_ID wdog, int32_t delay, wdentry_t wdentry, int argc, ...) * this function is called on each timer interrupt and a value of one * is implicit. * - * Return Value: + * Returned Value: * If CONFIG_SCHED_TICKLESS is defined then the number of ticks for the * next delay is provided (zero if no delay). Otherwise, this function * has no returned value. diff --git a/sched/wdog/wdog.h b/sched/wdog/wdog.h index 4b51b2355f..aed2657939 100644 --- a/sched/wdog/wdog.h +++ b/sched/wdog/wdog.h @@ -93,7 +93,7 @@ extern uint16_t g_wdnfree; * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -120,7 +120,7 @@ void weak_function wd_initialize(void); * this function is called on each timer interrupt and a value of one * is implicit. * - * Return Value: + * Returned Value: * If CONFIG_SCHED_TICKLESS is defined then the number of ticks for the * next delay is provided (zero if no delay). Otherwise, this function * has no returned value. @@ -144,10 +144,10 @@ void wd_timer(void); * task_delete() or via pthread_cancel(). It checks if the deleted task * is waiting for a timed event and if so cancels the timeout * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/wqueue/kwork_cancel.c b/sched/wqueue/kwork_cancel.c index 659d9688b7..526a3d906a 100644 --- a/sched/wqueue/kwork_cancel.c +++ b/sched/wqueue/kwork_cancel.c @@ -63,7 +63,7 @@ * After work has been cancelled, it may be re-queue by calling work_queue() * again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The previously queue work structure to cancel * @@ -124,7 +124,7 @@ static int work_qcancel(FAR struct kwork_wqueue_s *wqueue, * user mode work queue. After work has been cancelled, it may be re-queue * by calling work_queue() again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (must be HPWORK or LPWORK) * work - The previously queue work structure to cancel * diff --git a/sched/wqueue/kwork_hpthread.c b/sched/wqueue/kwork_hpthread.c index 7389220452..a923ad1122 100644 --- a/sched/wqueue/kwork_hpthread.c +++ b/sched/wqueue/kwork_hpthread.c @@ -82,7 +82,7 @@ struct hp_wqueue_s g_hpwork; * bring up. This entry point is referenced by OS internally and should * not be accessed by application logic. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: @@ -132,7 +132,7 @@ static int work_hpthread(int argc, char *argv[]) * Description: * Start the high-priority, kernel-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/sched/wqueue/kwork_inherit.c b/sched/wqueue/kwork_inherit.c index c648c4b4ed..6647a415c7 100644 --- a/sched/wqueue/kwork_inherit.c +++ b/sched/wqueue/kwork_inherit.c @@ -65,7 +65,7 @@ * Parameters: * reqprio - Requested minimum worker thread priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -178,7 +178,7 @@ static void lpwork_boostworker(pid_t wpid, uint8_t reqprio) * reqprio - Previously requested minimum worker thread priority to be * "unboosted" * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -324,7 +324,7 @@ static void lpwork_restoreworker(pid_t wpid, uint8_t reqprio) * Parameters: * reqprio - Requested minimum worker thread priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -370,7 +370,7 @@ void lpwork_boostpriority(uint8_t reqprio) * reqprio - Previously requested minimum worker thread priority to be * "unboosted" * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/wqueue/kwork_lpthread.c b/sched/wqueue/kwork_lpthread.c index dcb0726efe..5d6911fef3 100644 --- a/sched/wqueue/kwork_lpthread.c +++ b/sched/wqueue/kwork_lpthread.c @@ -84,7 +84,7 @@ struct lp_wqueue_s g_lpwork; * bring up. This entry point is referenced by OS internally and should * not be accessed by application logic. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: @@ -168,7 +168,7 @@ static int work_lpthread(int argc, char *argv[]) * Description: * Start the low-priority, kernel-mode worker thread(s) * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/sched/wqueue/kwork_process.c b/sched/wqueue/kwork_process.c index 80c7befca2..2266949f5f 100644 --- a/sched/wqueue/kwork_process.c +++ b/sched/wqueue/kwork_process.c @@ -85,7 +85,7 @@ * part of the internal implementation of each work queue; it should not * be called from application level logic. * - * Input parameters: + * Input Parameters: * wqueue - Describes the work queue to be processed * * Returned Value: diff --git a/sched/wqueue/kwork_queue.c b/sched/wqueue/kwork_queue.c index 8b5a8e6f5a..483a7e55af 100644 --- a/sched/wqueue/kwork_queue.c +++ b/sched/wqueue/kwork_queue.c @@ -71,7 +71,7 @@ * from the queue, or (2) work_cancel() has been called to cancel the work * and remove it from the work queue. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked @@ -144,7 +144,7 @@ static void work_qqueue(FAR struct kwork_wqueue_s *wqueue, * previous work as been performed and removed from the queue, then any * pending work will be canceled and lost. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked diff --git a/sched/wqueue/kwork_signal.c b/sched/wqueue/kwork_signal.c index 2efec2ea45..73ca066a61 100644 --- a/sched/wqueue/kwork_signal.c +++ b/sched/wqueue/kwork_signal.c @@ -61,7 +61,7 @@ * is used internally by the work logic but could also be used by the * user to force an immediate re-assessment of pending work. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * * Returned Value: diff --git a/sched/wqueue/wqueue.h b/sched/wqueue/wqueue.h index 701af9b300..7e7942ef02 100644 --- a/sched/wqueue/wqueue.h +++ b/sched/wqueue/wqueue.h @@ -134,7 +134,7 @@ extern struct lp_wqueue_s g_lpwork; * Description: * Start the high-priority, kernel-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -153,7 +153,7 @@ int work_hpstart(void); * Description: * Start the low-priority, kernel-mode worker thread(s) * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -175,7 +175,7 @@ int work_lpstart(void); * part of the internal implementation of each work queue; it should not * be called from application level logic. * - * Input parameters: + * Input Parameters: * wqueue - Describes the work queue to be processed * period - The polling period in clock ticks * wndx - The worker thread index diff --git a/wireless/ieee802154/ieee802154_primitive.c b/wireless/ieee802154/ieee802154_primitive.c index 35db231fcd..4b3e14d594 100644 --- a/wireless/ieee802154/ieee802154_primitive.c +++ b/wireless/ieee802154/ieee802154_primitive.c @@ -135,10 +135,10 @@ static bool g_poolinit = false; * be called early in the initialization sequence before any radios * begin operation. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -224,10 +224,10 @@ void ieee802154_primitivepool_initialize(void) * list. If that the list is empty, then the primitive structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated primitive structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -341,10 +341,10 @@ FAR struct ieee802154_primitive_s *ieee802154_primitive_allocate(void) * structure. If the primitive structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * prim - primitive structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/wireless/ieee802154/mac802154_device.c b/wireless/ieee802154/mac802154_device.c index 3ab60e4a08..13dcc31a0f 100644 --- a/wireless/ieee802154/mac802154_device.c +++ b/wireless/ieee802154/mac802154_device.c @@ -846,7 +846,7 @@ static int mac802154dev_rxframe(FAR struct mac802154_chardevice_s *dev, * minor - The device minor number. The IEEE802.15.4 MAC character device * will be registered as /dev/ieeeN where N is the minor number * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/wireless/ieee802154/mac802154_loopback.c b/wireless/ieee802154/mac802154_loopback.c index 1eabcd1a78..04dbd9139e 100644 --- a/wireless/ieee802154/mac802154_loopback.c +++ b/wireless/ieee802154/mac802154_loopback.c @@ -888,7 +888,7 @@ static int lo_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -911,7 +911,7 @@ static int lo_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -983,7 +983,7 @@ static int lo_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/wireless/ieee802154/mac802154_netdev.c b/wireless/ieee802154/mac802154_netdev.c index aa4abe8ab2..0a11caf017 100644 --- a/wireless/ieee802154/mac802154_netdev.c +++ b/wireless/ieee802154/mac802154_netdev.c @@ -664,7 +664,7 @@ static void macnet_txpoll_expiry(int argc, wdparm_t arg, ...) * Description: * Get the extended address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * eaddr - The location in which to return the extended address. * @@ -701,7 +701,7 @@ static int macnet_coord_eaddr(FAR struct radio_driver_s *radio, * Description: * Get the short address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * saddr - The location in which to return the short address. * @@ -1169,7 +1169,7 @@ static int macnet_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1198,7 +1198,7 @@ static int macnet_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1280,7 +1280,7 @@ static int macnet_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * @@ -1357,7 +1357,7 @@ static int macnet_properties(FAR struct radio_driver_s *netdev, * Input Parameters: * mac - Pointer to the mac layer struct to be registered. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/wireless/pktradio/pktradio_loopback.c b/wireless/pktradio/pktradio_loopback.c index c9e144eb4d..71c963126d 100644 --- a/wireless/pktradio/pktradio_loopback.c +++ b/wireless/pktradio/pktradio_loopback.c @@ -848,7 +848,7 @@ static int lo_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -871,7 +871,7 @@ static int lo_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -943,7 +943,7 @@ static int lo_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/wireless/pktradio/pktradio_metadata.c b/wireless/pktradio/pktradio_metadata.c index 585b6bac23..4dce2ec756 100644 --- a/wireless/pktradio/pktradio_metadata.c +++ b/wireless/pktradio/pktradio_metadata.c @@ -86,10 +86,10 @@ static struct pktradio_metadata_s g_metadata_pool[CONFIG_PKTRADIO_NRXMETA]; * be called early in the initialization sequence before any radios * begin operation. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -136,10 +136,10 @@ void pktradio_metadata_initialize(void) * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated metadata structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -216,10 +216,10 @@ FAR struct pktradio_metadata_s *pktradio_metadata_allocate(void) * structure. If the metadata structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * metadata - metadata structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ -- GitLab