Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
* This operates at 1MHz and counts downwards. It will wrap about every
* hour (2^32 microseconds).
*
- * @return current value of timer
+ * Return: current value of timer
*/
static unsigned long timer_get_us_down(void)
{
* ast_get_clk() - get a pointer to Clock Driver
*
* @devp, OUT - pointer to Clock Driver
- * @return zero on success, error code (< 0) otherwise.
+ * Return: zero on success, error code (< 0) otherwise.
*/
int ast_get_clk(struct udevice **devp);
/**
* ast_get_scu() - get a pointer to SCU registers
*
- * @return pointer to struct ast2500_scu on success, ERR_PTR otherwise
+ * Return: pointer to struct ast2500_scu on success, ERR_PTR otherwise
*/
void *ast_get_scu(void);
* gets Reset Mode value from it.
*
* @flags: flags parameter passed into wdt_reset or wdt_start
- * @return Reset Mode value
+ * Return: Reset Mode value
*/
u32 ast_reset_mode_from_flags(ulong flags);
* gets Reset Mask value from it. Reset Mask is only supported on ast2500
*
* @flags: flags parameter passed into wdt_reset or wdt_start
- * @return Reset Mask value
+ * Return: Reset Mask value
*/
u32 ast_reset_mask_from_flags(ulong flags);
* pull-up/down and drive strength.
*
* @param peripheral peripheral to be configured
- * @return 0 if ok, -1 on error (e.g. unsupported peripheral)
+ * Return: 0 if ok, -1 on error (e.g. unsupported peripheral)
*/
int hi6220_pinmux_config(int peripheral);
*
* @input_rate: Input clock rate in Hz
* @output_rate: Output clock rate in Hz
- * @return divisor register value to use
+ * Return: divisor register value to use
*/
static inline u32 clk_get_divisor(ulong input_rate, uint output_rate)
{
/**
* rockchip_get_cru() - get a pointer to the clock/reset unit registers
*
- * @return pointer to registers, or -ve error on error
+ * Return: pointer to registers, or -ve error on error
*/
void *rockchip_get_cru(void);
/**
* rockchip_get_pmucru() - get a pointer to the clock/reset unit registers
*
- * @return pointer to registers, or -ve error on error
+ * Return: pointer to registers, or -ve error on error
*/
void *rockchip_get_pmucru(void);
* @pdev: clock udevice
* @reg_offset: the first offset in cru for softreset registers
* @reg_number: the reg numbers of softreset registers
- * @return 0 success, or error value
+ * Return: 0 success, or error value
*/
int rockchip_reset_bind(struct udevice *pdev, u32 reg_offset, u32 reg_number);
/**
* Works out the SOC/SKU type used for clocks settings
*
- * @return SOC type - see TEGRA_SOC...
+ * Return: SOC type - see TEGRA_SOC...
*/
int tegra_get_chip_sku(void);
/**
* Returns the pure SOC (chip ID) from the HIDREV register
*
- * @return SOC ID - see CHIPID_TEGRAxx...
+ * Return: SOC ID - see CHIPID_TEGRAxx...
*/
int tegra_get_chip(void);
/**
* Returns the SKU ID from the sku_info register
*
- * @return SKU ID - see SKU_ID_Txx...
+ * Return: SKU ID - see SKU_ID_Txx...
*/
int tegra_get_sku_info(void);
* @param pllout pll output id
* @param rate desired output rate
*
- * @return 0 if ok, -1 on error (invalid clock id or no suitable divider)
+ * Return: 0 if ok, -1 on error (invalid clock id or no suitable divider)
*/
int clock_set_pllout(enum clock_id clkid, enum pll_out_id pllout,
unsigned rate);
* specific knowledge of system-level clock tree structure.
*
* @param periph_id peripheral to query
- * @return clock ID of the peripheral's current parent clock
+ * Return: clock ID of the peripheral's current parent clock
*/
enum clock_id clock_get_periph_parent(enum periph_id periph_id);
* @param periph_id peripheral to start
* @param parent PLL id of required parent clock
* @param rate Required clock rate in Hz
- * @return rate selected in Hz, or -1U if something went wrong
+ * Return: rate selected in Hz, or -1U if something went wrong
*/
unsigned clock_start_periph_pll(enum periph_id periph_id,
enum clock_id parent, unsigned rate);
* @param periph_id peripheral to start
* @param parent PLL id of parent clock (used to calculate rate, you
* must know this!)
- * @return clock rate of peripheral in Hz
+ * Return: clock rate of peripheral in Hz
*/
unsigned long clock_get_periph_rate(enum periph_id periph_id,
enum clock_id parent);
* @param rate Required clock rate in Hz
* @param extra_div value for the second-stage divisor (NULL if one is
not available)
- * @return rate selected in Hz, or -1U if something went wrong
+ * Return: rate selected in Hz, or -1U if something went wrong
*/
unsigned clock_adjust_periph_pll_div(enum periph_id periph_id,
enum clock_id parent, unsigned rate, int *extra_div);
* Returns the clock rate of a specified clock, in Hz.
*
* @param parent PLL id of clock to check
- * @return rate of clock in Hz
+ * Return: rate of clock in Hz
*/
unsigned clock_get_rate(enum clock_id clkid);
*
* @param blob FDT blob to use
* @param node Node to look at
- * @return peripheral ID, or PERIPH_ID_NONE if none
+ * Return: peripheral ID, or PERIPH_ID_NONE if none
*/
int clock_decode_periph_id(struct udevice *dev);
/**
* Checks if the oscillator bypass is enabled (XOBP bit)
*
- * @return 1 if bypass is enabled, 0 if not
+ * Return: 1 if bypass is enabled, 0 if not
*/
int clock_get_osc_bypass(void);
/*
* Checks that clocks are valid and prints a warning if not
*
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int clock_verify(void);
* @param mux_bits Set to number of bits in mux register
* @param divider_bits Set to the relevant MASK_BITS_* value
* @param type Set to the SoC-specific clock type
- * @return 0 on success, -1 on error
+ * Return: 0 on success, -1 on error
*/
int get_periph_clock_info(enum periph_id periph_id, int *mux_bits,
int *divider_bits, int *type);
*
* @param periph_id peripheral to query
* @param source raw clock source mux value
- * @return the CLOCK_ID_* value @source represents
+ * Return: the CLOCK_ID_* value @source represents
*/
enum clock_id get_periph_clock_id(enum periph_id periph_id, int source);
* @param source PLL id of required parent clock
* @param mux_bits Set to number of bits in mux register: 2 or 4
* @param divider_bits Set to number of divider bits (8 or 16)
- * @return mux value (0-4, or -1 if not found)
+ * Return: mux value (0-4, or -1 if not found)
*/
int get_periph_clock_source(enum periph_id periph_id,
enum clock_id parent, int *mux_bits, int *divider_bits);
* provided.
*
* @param clk_id Clock ID according to tegra30 device tree binding
- * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
+ * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
*/
enum periph_id clk_id_to_periph_id(int clk_id);
* @param m PLL input divider(DIVN)
* @param p post divider(DIVP)
* @param cpcon base PLL charge pump(CPCON)
- * @return 0 if ok, -1 on error (the requested PLL is incorrect and cannot
+ * Return: 0 if ok, -1 on error (the requested PLL is incorrect and cannot
* be overridden), 1 if PLL is already correct
*/
int clock_set_rate(enum clock_id clkid, u32 n, u32 m, u32 p, u32 cpcon);
* Enable output clock for external peripherals
*
* @param clk_id Clock ID to output (1, 2 or 3)
- * @return 0 if OK. -ve on error
+ * Return: 0 if OK. -ve on error
*/
int clock_external_output(int clk_id);
*
* @param id Peripheral id
* @param config Configuration to use (FUNCMUX_...), 0 for default
- * @return 0 if ok, -1 on error (e.g. incorrect id or config)
+ * Return: 0 if ok, -1 on error (e.g. incorrect id or config)
*/
int funcmux_select(enum periph_id id, int config);
* @ivc The IVC channel.
* @frame Pointer to be filled with the address of the frame to receive.
*
- * @return 0 if a frame is available, else a negative error code.
+ * Return: 0 if a frame is available, else a negative error code.
*/
int tegra_ivc_read_get_next_frame(struct tegra_ivc *ivc, void **frame);
*
* @ivc The IVC channel.
*
- * @return 0 if OK, else a negative error code.
+ * Return: 0 if OK, else a negative error code.
*/
int tegra_ivc_read_advance(struct tegra_ivc *ivc);
* @ivc The IVC channel.
* @frame Pointer to be filled with the address of the frame to fill.
*
- * @return 0 if a frame is available, else a negative error code.
+ * Return: 0 if a frame is available, else a negative error code.
*/
int tegra_ivc_write_get_next_frame(struct tegra_ivc *ivc, void **frame);
*
* @ivc The IVC channel.
*
- * @return 0 if OK, else a negative error code.
+ * Return: 0 if OK, else a negative error code.
*/
int tegra_ivc_write_advance(struct tegra_ivc *ivc);
*
* @ivc The IVC channel.
*
- * @return 0 if the channel is ready for communication, or -EAGAIN if a
+ * Return: 0 if the channel is ready for communication, or -EAGAIN if a
* channel reset is in progress.
*/
int tegra_ivc_channel_notified(struct tegra_ivc *ivc);
* @nframes Number of frames in each shared memory buffer.
* @frame_size Size of each frame.
*
- * @return 0 if OK, else a negative error code.
+ * Return: 0 if OK, else a negative error code.
*/
int tegra_ivc_init(struct tegra_ivc *ivc, ulong rx_base, ulong tx_base,
uint32_t nframes, uint32_t frame_size,
/**
* tegra_board_id() - Get the board iD
*
- * @return a board ID, or -ve on error
+ * Return: a board ID, or -ve on error
*/
int tegra_board_id(void);
* tegra_lcd_pmic_init() - Set up the PMIC for a board
*
* @board_id: Board ID which may be used to select LCD type
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int tegra_lcd_pmic_init(int board_id);
/**
* nvidia_board_init() - perform any board-specific init
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int nvidia_board_init(void);
/**
* Returns the bus number of the DVC controller
*
- * @return number of bus, or -1 if there is no DVC active
+ * Return: number of bus, or -1 if there is no DVC active
*/
int tegra_i2c_get_dvc_bus(struct udevice **busp);
/**
* Save warmboot memory settings for a later resume
*
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int warmboot_save_sdram_params(void);
*
* @param blob Device tree blob
* @param default_lcd_base Default address of LCD frame buffer
- * @return 0 if ok, -1 on error (unsupported bits per pixel)
+ * Return: 0 if ok, -1 on error (unsupported bits per pixel)
*/
int tegra_display_probe(const void *blob, void *default_lcd_base);
/**
* Return the current display configuration
*
- * @return pointer to display configuration, or NULL if there is no valid
+ * Return: pointer to display configuration, or NULL if there is no valid
* config
*/
struct fdt_disp_config *tegra_display_get_config(void);
*
* @param blob Device tree blob
* @param rate Clock speed of memory controller in Hz (=2x memory bus rate)
- * @return 0 if ok, else -ve error code (look in emc.c to decode it)
+ * Return: 0 if ok, else -ve error code (look in emc.c to decode it)
*/
int tegra_set_emc(const void *blob, unsigned rate);
* Get a pointer to the EMC controller from the device tree.
*
* @param blob Device tree blob
- * @return pointer to EMC controller
+ * Return: pointer to EMC controller
*/
struct emc_ctlr *emc_get_controller(const void *blob);
* Check if gpio is valid.
*
* @param gpio GPIO number
- * @return 1 if ok, 0 on error
+ * Return: 1 if ok, 0 on error
*/
int gpio_is_valid(int gpio);
#endif
* bcm2835_power_on_module() - power on an SoC module
*
* @module: ID of module to power on (BCM2835_MBOX_POWER_DEVID_...)
- * @return 0 if OK, -EIO on error
+ * Return: 0 if OK, -EIO on error
*/
int bcm2835_power_on_module(u32 module);
* bcm2835_get_mmc_clock() - get the frequency of the MMC clock
*
* @clock_id: ID of clock to get frequency for
- * @return clock frequency, or -ve on error
+ * Return: clock frequency, or -ve on error
*/
int bcm2835_get_mmc_clock(u32 clock_id);
*
* @widthp: Returns the width in pixels
* @heightp: Returns the height in pixels
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int bcm2835_get_video_size(int *widthp, int *heightp);
* @fb_basep: Returns base address of frame buffer
* @fb_sizep: Returns size of frame buffer
* @pitchp: Returns number of bytes in each frame buffer line
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int bcm2835_set_video_params(int *widthp, int *heightp, int depth_bpp,
int pixel_order, int alpha_mode, ulong *fb_basep,
/**
* bcm2711_load_vl805_firmware() - get vl805's firmware loaded
*
- * @return 0 if OK, -EIO on error
+ * Return: 0 if OK, -EIO on error
*/
int bcm2711_notify_vl805_reset(void);
* @param target_freq Desired clock frequency in Hz
* @param best_fine_scalar Pointer to store the fine stage divisor
*
- * @return best_main_scalar Main scalar for desired frequency or -1 if none
+ * Return: best_main_scalar Main scalar for desired frequency or -1 if none
* found
*/
static int clock_calc_best_scalar(unsigned int main_scaler_bits,
*
* This function can be called from SPL or the main U-Boot.
*
- * @return pointer to the memory timings that we should use
+ * Return: pointer to the memory timings that we should use
*/
struct mem_timings *clock_get_mem_timings(void);
/*
* Init subsystems according to the reset status
*
- * @return 0 for a normal boot, non-zero for a resume
+ * Return: 0 for a normal boot, non-zero for a resume
*/
int do_lowlevel_init(void);
* @param ch DMC channel number
* @param byte_lane which DQS byte offset,
* possible values are 0,1,2,3
- * @return TRUE if memory was good, FALSE if not.
+ * Return: TRUE if memory was good, FALSE if not.
*/
static bool dmc_valid_window_test_vector(int ch, int byte_lane)
{
* representations of 0.
*
* @param b The byte to convert in two's complement.
- * @return The 7-bit value + sign bit.
+ * Return: The 7-bit value + sign bit.
*/
unsigned char make_signed_byte(signed char b)
*
* @param mem Memory timings for this memory type.
* @param reset Reset DDR PHY during initialization.
- * @return 0 if ok, SETUP_ERR_... if there is a problem
+ * Return: 0 if ok, SETUP_ERR_... if there is a problem
*/
int ddr3_mem_ctrl_init(struct mem_timings *mem, int reset);
* @param phy1_con16 Register address for dmc_phy1->phy_con16
* @param phy0_con17 Register address for dmc_phy0->phy_con17
* @param phy1_con17 Register address for dmc_phy1->phy_con17
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int dmc_config_zq(struct mem_timings *mem, uint32_t *phy0_con16,
uint32_t *phy1_con16, uint32_t *phy0_con17,
*
* @param peripheral Peripheral id
*
- * @return frequency of the peripheral clk
+ * Return: frequency of the peripheral clk
*/
unsigned long clock_get_periph_rate(int peripheral);
*
* @param peripheral peripheral to be configured
* @param flags configure flags
- * @return 0 if ok, -1 on error (e.g. unsupported peripheral)
+ * Return: 0 if ok, -1 on error (e.g. unsupported peripheral)
*/
int exynos_pinmux_config(int peripheral, int flags);
*
* @param blob Device tree blob
* @param node FDT I2C node to find
- * @return peripheral id if ok, PERIPH_ID_NONE on error
+ * Return: peripheral id if ok, PERIPH_ID_NONE on error
*/
int pinmux_decode_periph_id(const void *blob, int node);
#endif
* Validate signature and return a pointer to the parameter table. If the
* signature is invalid, call panic() and never return.
*
- * @return pointer to the parameter table if signature matched or never return.
+ * Return: pointer to the parameter table if signature matched or never return.
*/
struct spl_machine_param *spl_get_machine_params(void);
*
* @param ddrmr_regs - memory controller registers
*
- * @return 0 on success, otherwise error code
+ * Return: 0 on success, otherwise error code
*/
int ddrmc_calibration(struct ddrmr_regs *ddrmr);
*
* @param peripheral peripheral to be configured
* @param flags configure flags
- * @return 0 if ok, -1 on error (e.g. unsupported peripheral)
+ * Return: 0 if ok, -1 on error (e.g. unsupported peripheral)
*/
int exynos_pinmux_config(int peripheral, int flags);
*
* @param blob Device tree blob
* @param node FDT I2C node to find
- * @return peripheral id if ok, PERIPH_ID_NONE on error
+ * Return: peripheral id if ok, PERIPH_ID_NONE on error
*/
int pinmux_decode_periph_id(const void *blob, int node);
#endif
* get_address() - Get address if it is valid
*
* @tmp_xor: Current xor value to update
- * @return The address area
+ * Return: The address area
*/
static u32 get_address(u8 *tmp_xor)
{
* stm32prog_serial_loop() - USART bootloader Loop routine
*
* @data: Current command context
- * @return true if reset is needed after loop
+ * Return: true if reset is needed after loop
*/
bool stm32prog_serial_loop(struct stm32prog_data *data)
{
* @param divider_bits number of divider bits (8 or 16)
* @param parent_rate clock rate of parent clock in Hz
* @param rate required clock rate for this clock
- * @return divider which should be used
+ * Return: divider which should be used
*/
static int clk_get_divider(unsigned divider_bits, unsigned long parent_rate,
unsigned long rate)
*
* @param parent_rate clock rate of parent clock in Hz
* @param divider which should be used in 7.1 format
- * @return effective clock rate of peripheral
+ * Return: effective clock rate of peripheral
*/
static unsigned long get_rate_from_divider(unsigned long parent_rate,
int divider)
* @param rate required clock rate for this clock
* @param extra_div value for the second-stage divisor (not set if this
* function returns -1.
- * @return divider which should be used, or -1 if nothing is valid
+ * Return: divider which should be used, or -1 if nothing is valid
*
*/
static int find_best_divider(unsigned divider_bits, unsigned long parent_rate,
* @param source Source number (0-3 or 0-7)
* @param mux_bits Number of mux bits (2 or 4)
* @param divider Required divider in 7.1 or 15.1 format
- * @return 0 if ok, -1 on error (requesting a parent clock which is not valid
+ * Return: 0 if ok, -1 on error (requesting a parent clock which is not valid
* for this peripheral)
*/
static int adjust_periph_pll(enum periph_id periph_id, int source,
* @param m PLL input divider(DIVN)
* @param p post divider(DIVP)
* @param cpcon base PLL charge pump(CPCON)
- * @return 0 if ok, -1 on error (the requested PLL is incorrect and cannot
+ * Return: 0 if ok, -1 on error (the requested PLL is incorrect and cannot
* be overridden), 1 if PLL is already correct
*/
int clock_set_rate(enum clock_id clkid, u32 n, u32 m, u32 p, u32 cpcon)
* @param source PLL id of required parent clock
* @param mux_bits Set to number of bits in mux register: 2 or 4
* @param divider_bits Set to number of divider bits (8 or 16)
- * @return mux value (0-4, or -1 if not found)
+ * Return: mux value (0-4, or -1 if not found)
*/
int get_periph_clock_source(enum periph_id periph_id,
enum clock_id parent, int *mux_bits, int *divider_bits)
* provided.
*
* @param clk_id Clock ID according to tegra114 device tree binding
- * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
+ * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
*/
enum periph_id clk_id_to_periph_id(int clk_id)
{
* @param source PLL id of required parent clock
* @param mux_bits Set to number of bits in mux register: 2 or 4
* @param divider_bits Set to number of divider bits (8 or 16)
- * @return mux value (0-4, or -1 if not found)
+ * Return: mux value (0-4, or -1 if not found)
*/
int get_periph_clock_source(enum periph_id periph_id,
enum clock_id parent, int *mux_bits, int *divider_bits)
* provided.
*
* @param clk_id Clock ID according to tegra124 device tree binding
- * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
+ * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
*/
enum periph_id clk_id_to_periph_id(int clk_id)
{
* Check a register that we set up to see if clock_early_init() has already
* been called.
*
- * @return true if clock_early_init() was called, false if not
+ * Return: true if clock_early_init() was called, false if not
*/
bool clock_early_init_done(void)
{
* @param source PLL id of required parent clock
* @param mux_bits Set to number of bits in mux register: 2 or 4
* @param divider_bits Set to number of divider bits (8 or 16)
- * @return mux value (0-4, or -1 if not found)
+ * Return: mux value (0-4, or -1 if not found)
*/
int get_periph_clock_source(enum periph_id periph_id,
enum clock_id parent, int *mux_bits, int *divider_bits)
* provided.
*
* @param clk_id Clock ID according to tegra20 device tree binding
- * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
+ * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
*/
enum periph_id clk_id_to_periph_id(int clk_id)
{
* @param blob Device tree blob
* @param node EMC node (nvidia,tegra20-emc compatible string)
* @param ram_code RAM code to select (0-3, or -1 if unknown)
- * @return 0 if ok, otherwise a -ve ERR_ code (see enum above)
+ * Return: 0 if ok, otherwise a -ve ERR_ code (see enum above)
*/
static int find_emc_tables(const void *blob, int node, int ram_code)
{
* @param tablep Returns pointer to table to program into EMC. There are
* TEGRA_EMC_NUM_REGS entries, destined for offsets as per the
* emc_reg_addr array.
- * @return 0 if ok, otherwise a -ve error code which will allow someone to
+ * Return: 0 if ok, otherwise a -ve error code which will allow someone to
* figure out roughly what went wrong by looking at this code.
*/
static int decode_emc(const void *blob, unsigned rate, struct emc_ctlr **emcp,
* @param source PLL id of required parent clock
* @param mux_bits Set to number of bits in mux register: 2 or 4
* @param divider_bits Set to number of divider bits (8 or 16)
- * @return mux value (0-4, or -1 if not found)
+ * Return: mux value (0-4, or -1 if not found)
*/
int get_periph_clock_source(enum periph_id periph_id,
enum clock_id parent, int *mux_bits, int *divider_bits)
* provided.
*
* @param clk_id Clock ID according to tegra210 device tree binding
- * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
+ * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
*/
enum periph_id clk_id_to_periph_id(int clk_id)
{
* @param source PLL id of required parent clock
* @param mux_bits Set to number of bits in mux register: 2 or 4
* @param divider_bits Set to number of divider bits (8 or 16)
- * @return mux value (0-4, or -1 if not found)
+ * Return: mux value (0-4, or -1 if not found)
*/
int get_periph_clock_source(enum periph_id periph_id,
enum clock_id parent, int *mux_bits, int *divider_bits)
* provided.
*
* @param clk_id Clock ID according to tegra30 device tree binding
- * @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
+ * Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
*/
enum periph_id clk_id_to_periph_id(int clk_id)
{
* @param irq IRQ number
* @param hdlr Interrupt handler rutine
* @param arg Pointer to argument which is passed to int. handler rutine
- * @return 0 if registration pass, 1 if unregistration pass,
+ * Return: 0 if registration pass, 1 if unregistration pass,
* or an error code < 0 otherwise
*/
int install_interrupt_handler(int irq, interrupt_handler_t *hdlr,
* 16 dwords.
* @param num_words Number of data dwords (up to 32)
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
static int octeon_set_moveable_region(u32 base, int region_num,
bool enable, const u64 *data,
* @param[in] str string to parse
* @param base 0 for auto, otherwise 8, 10 or 16 for the number base
*
- * @return number of values read.
+ * Return: number of values read.
*/
static int octeon_parse_nodes(u64 values[CVMX_MAX_NODES],
const char *str, int base)
* @param cmd command type
* @param[out] boot_args parsed values
*
- * @return number of arguments parsed
+ * Return: number of arguments parsed
*/
int octeon_parse_bootopts(int argc, char *const argv[],
enum octeon_boot_cmd_type cmd,
/**
* Returns number of cores
*
- * @return number of CPU cores for the specified node
+ * Return: number of CPU cores for the specified node
*/
static int cavm_octeon_num_cores(void)
{
* accessed.
* @param size Size of the structure member.
*
- * @return Value of the structure member promoted into a u64.
+ * Return: Value of the structure member promoted into a u64.
*/
static inline u64 __cvmx_bootmem_desc_get(u64 base, int offset,
int size)
/**
* This function returns the address of the bootmem descriptor lock.
*
- * @return 64-bit address in KSEG0 of the bootmem descriptor block
+ * Return: 64-bit address in KSEG0 of the bootmem descriptor block
*/
static inline u64 __cvmx_bootmem_get_lock_addr(void)
{
* Exact major version to check against. A zero means
* check that the version supports named blocks.
*
- * @return Zero if the version is correct. Negative if the version is
+ * Return: Zero if the version is correct. Negative if the version is
* incorrect. Failures also cause a message to be displayed.
*/
static int __cvmx_bootmem_check_version(int exact_match)
*
* @param name is the block name
* @param flags indicates the need to use locking during search
- * @return pointer to named block descriptor
+ * Return: pointer to named block descriptor
*
* Note: this function returns a pointer to a static structure,
* and is therefore not re-entrant.
* @param num_tads number of tads
* @param max_cores maximum number of cores
*
- * @return void
+ * Return: void
*/
void fill_tad_corecount(u64 coremask, int tad_blown_count[], int num_tads,
int max_cores)
* CIU_FUSE register value. For other models there is no difference.
*
* @param ciu_fuse_value fuse value from CIU_FUSE register
- * @return logical coremask of CIU_FUSE value.
+ * Return: logical coremask of CIU_FUSE value.
*/
u64 get_logical_coremask(u64 ciu_fuse_value)
{
* If the fuses are blown and locked, they are the definitive coremask.
*
* @param pcm pointer to coremask to fill in
- * @return pointer to coremask
+ * Return: pointer to coremask
*/
struct cvmx_coremask *octeon_get_available_coremask(struct cvmx_coremask *pcm)
{
* initialize the queue allocation list. the existing static allocation result
* is used as a starting point to ensure backward compatibility.
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
int cvmx_pko_queue_grp_alloc(u64 start, uint64_t end, uint64_t count)
* @param port the port for which the queues are requested
* @param count the number of queues requested
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
static int cvmx_pko_queue_alloc(u64 port, int count)
*
* @param port the port for which the queues are returned
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
int cvmx_pko_queue_free(uint64_t port)
* Return the number of queues to be assigned to this pko_port
*
* @param pko_port
- * @return the number of queues for this pko_port
+ * Return: the number of queues for this pko_port
*
*/
static int cvmx_helper_cfg_dft_nqueues(int pko_port)
* @param xiface interface to check
* @param index port index in the interface
*
- * @return status of the port present or not.
+ * Return: status of the port present or not.
*/
int cvmx_helper_is_port_valid(int xiface, int index)
{
*
* @param xiface node and interface
* @param index port index
- * @return node offset of port or -1 if invalid
+ * Return: node offset of port or -1 if invalid
*/
int cvmx_helper_get_port_fdt_node_offset(int xiface, int index)
{
* @param[out] xiface xinterface of match
* @param[out] index port index of match
*
- * @return 0 if found, -1 if not found
+ * Return: 0 if found, -1 if not found
*/
int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xiface, int *index)
{
*
* @param xiface node and interface
* @param index port index
- * @return node offset of phy or -1 if invalid
+ * Return: node offset of phy or -1 if invalid
*/
int cvmx_helper_get_phy_fdt_node_offset(int xiface, int index)
{
* @param xiface node and interface
* @param index port index
*
- * @return 0 if autonegotiation is disabled, 1 if enabled.
+ * Return: 0 if autonegotiation is disabled, 1 if enabled.
*/
bool cvmx_helper_get_port_autonegotiation(int xiface, int index)
{
* @param xiface node and interface
* @param index port index
*
- * @return false if fec is disabled, true if enabled.
+ * Return: false if fec is disabled, true if enabled.
*/
bool cvmx_helper_get_port_fec(int xiface, int index)
{
* @param xiface node and interface
* @param index port index
*
- * @return pointer to PHY information data structure or NULL if not set
+ * Return: pointer to PHY information data structure or NULL if not set
*/
struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index)
{
* @param xiface node and interface
* @param index portindex
*
- * @return pointer to the PHY LED information data structure or NULL if not
+ * Return: pointer to the PHY LED information data structure or NULL if not
* present
*/
struct cvmx_phy_gpio_leds *cvmx_helper_get_port_phy_leds(int xiface, int index)
* @param xiface node and interface
* @param index port index
*
- * @return offset in device tree or -1 if error or not defined.
+ * Return: offset in device tree or -1 if error or not defined.
*/
int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index)
{
* @param xiface node and interface
* @param index port index
*
- * @return pointer to vsc7224 data structure or NULL if not present
+ * Return: pointer to vsc7224 data structure or NULL if not present
*/
struct cvmx_vsc7224_chan *cvmx_helper_cfg_get_vsc7224_chan_info(int xiface, int index)
{
* @param xiface node and interface
* @param index port index
*
- * @return pointer to avsp5410 data structure or NULL if not present
+ * Return: pointer to avsp5410 data structure or NULL if not present
*/
struct cvmx_avsp5410 *cvmx_helper_cfg_get_avsp5410_info(int xiface, int index)
{
* @param xiface node and interface
* @param index port index
*
- * @return pointer to SFP data structure or NULL if none
+ * Return: pointer to SFP data structure or NULL if none
*/
struct cvmx_fdt_sfp_info *cvmx_helper_cfg_get_sfp_info(int xiface, int index)
{
*
* @param size number of bytes to allocate
*
- * @return pointer to allocated memory or NULL if out of memory.
+ * Return: pointer to allocated memory or NULL if out of memory.
* Alignment is set to 8-bytes.
*/
void *__cvmx_fdt_alloc(size_t size)
* @param[in,out] lenp Number of phandles, input max number
* @param[out] nodes Array of phandle nodes
*
- * @return -ve error code on error or 0 for success
+ * Return: -ve error code on error or 0 for success
*/
int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node,
const char *prop_name, int *lenp,
* @param[in] fdt_addr Address of FDT
* @param node FDT node number
*
- * @return CPU node number or error if negative
+ * Return: CPU node number or error if negative
*/
int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node)
{
*
* @param[in] fdt_addr Address of FDT
*
- * @return Size of flat device tree in bytes or error if negative.
+ * Return: Size of flat device tree in bytes or error if negative.
*/
int cvmx_fdt_get_fdt_size(const void *fdt_addr)
{
* @param[in] strlist Array of FDT device compatibility strings,
* must end with NULL or empty string.
*
- * @return 0 if at least one item matches, 1 if no matches
+ * Return: 0 if at least one item matches, 1 if no matches
*/
int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const char *const *strlist)
{
* @param strlist Array of FDT device compatibility strings, must
* end with NULL or empty string.
*
- * @return next matching node or -1 if no more matches.
+ * Return: next matching node or -1 if no more matches.
*/
int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffset,
const char *const *strlist)
* @param sfp Handle to SFP data structure
* @param ipd_port Port to assign it to
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port)
{
* @param of_offset Offset of vsc7224 node
* @param[in,out] vsc7224 Data structure to hold the data
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
static int cvmx_fdt_parse_vsc7224_channels(const void *fdt_addr, int of_offset,
struct cvmx_vsc7224 *vsc7224)
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int __cvmx_fdt_parse_vsc7224(const void *fdt_addr)
{
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int __cvmx_fdt_parse_avsp5410(const void *fdt_addr)
{
* @param of_offset Offset of QSFP node
* @param[out] sfp_info Pointer to sfp info to fill in
*
- * @return 0 for success
+ * Return: 0 for success
*/
static int cvmx_parse_qsfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_sfp_info *sfp_info)
{
* @param of_offset Offset of SFP node
* @param[out] sfp_info Pointer to sfp info to fill in
*
- * @return 0 for success
+ * Return: 0 for success
*/
static int cvmx_parse_sfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_sfp_info *sfp_info)
{
* @param of_offset Offset of SFP node
* @param[out] sfp_info Pointer to sfp info to fill in
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
static int cvmx_parse_sfp_eeprom(const void *fdt_addr, int of_offset,
struct cvmx_fdt_sfp_info *sfp_info)
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return pointer to sfp info or NULL if error
+ * Return: pointer to sfp info or NULL if error
*/
struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, int of_offset)
{
* @param of_offset fdt offset of slice
* @param phy_info phy_info data structure
*
- * @return slice number if non-negative, otherwise error
+ * Return: slice number if non-negative, otherwise error
*/
static int cvmx_fdt_parse_cs4343_slice(const void *fdt_addr, int of_offset,
struct cvmx_phy_info *phy_info)
* @param of_offset offset of slice or phy in device tree
* @param phy_info phy_info data structure to fill in
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_fdt_parse_cs4343(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info)
{
* @param data Data to shift in. Bit 0 enters the chain first, followed by
* bit 1, etc.
*
- * @return The low order bits of the JTAG chain that shifted out of the
+ * Return: The low order bits of the JTAG chain that shifted out of the
* circle.
*/
uint32_t cvmx_helper_qlm_jtag_shift(int qlm, int bits, uint32_t data)
*
* @param mode Mode to convert
*
- * @return String
+ * Return: String
*/
const char *cvmx_helper_interface_mode_to_string(cvmx_helper_interface_mode_t mode)
{
* @param drop_thresh
* All incoming packets will be dropped when there are less
* than this many free packet buffers in FPA 0.
- * @return Zero on success. Negative on failure
+ * Return: Zero on success. Negative on failure
*/
int cvmx_helper_setup_red(int pass_thresh, int drop_thresh)
{
* @param xiface Interface to configure
* @param num_ports Number of ports on the interface
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_setup_gmx(int xiface, int num_ports)
{
*
* @param port IPD/PKO port number
*
- * @return none
+ * Return: none
*/
void cvmx_helper_show_stats(int port)
{
*
* @param ipd_port IPD/PKO port number
*
- * @return Interface number
+ * Return: Interface number
*/
int cvmx_helper_get_interface_num(int ipd_port)
{
*
* @param ipd_port IPD/PKO port number
*
- * @return Interface index number
+ * Return: Interface index number
*/
int cvmx_helper_get_interface_index_num(int ipd_port)
{
*
* @param xiface - interface to check
*
- * @return zero if FCS is not used, otherwise FCS is used.
+ * Return: zero if FCS is not used, otherwise FCS is used.
*/
int __cvmx_helper_get_has_fcs(int xiface)
{
* but the CNX0XX and CNX1XX are exceptions. These only support
* one interface.
*
- * @return Number of interfaces on chip
+ * Return: Number of interfaces on chip
*/
int cvmx_helper_get_number_of_interfaces(void)
{
*
* @param xiface xiface to get the port count for
*
- * @return Number of ports on interface. Can be Zero.
+ * Return: Number of ports on interface. Can be Zero.
*/
int cvmx_helper_ports_on_interface(int xiface)
{
*
* @param xiface Interface to probe
*
- * @return Mode of the interface. Unknown or unsupported interfaces return
+ * Return: Mode of the interface. Unknown or unsupported interfaces return
* DISABLED.
*/
cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface)
*
* @param xiface Interface to enumerate
*
- * @return The number of ports on the interface, negative on failure
+ * Return: The number of ports on the interface, negative on failure
*/
int cvmx_helper_interface_enumerate(int xiface)
{
*
* @param xiface Interface to probe
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_interface_probe(int xiface)
{
* @INTERNAL
* Setup backpressure.
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
static int __cvmx_helper_global_setup_backpressure(int node)
{
/**
* @INTERNAL
* Verify the per port IPD backpressure is aligned properly.
- * @return Zero if working, non zero if misaligned
+ * Return: Zero if working, non zero if misaligned
*/
int __cvmx_helper_backpressure_is_misaligned(void)
{
*
* @param xiface Interface to enable
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_packet_hardware_enable(int xiface)
{
* Called after all internal packet IO paths are setup. This
* function enables IPD/PIP and begins packet input and output.
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_ipd_and_packet_input_enable_node(int node)
{
* on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower
* priority than the previous.
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_initialize_packet_io_node(unsigned int node)
{
* on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower
* priority than the previous.
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_initialize_packet_io_global(void)
{
/**
* Does core local initialization for packet io
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_initialize_packet_io_local(void)
{
* 1 => disable backpressure
* 0 => enable backpressure
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on error
*/
int cvmx_gmx_set_backpressure_override(u32 interface, uint32_t port_mask)
* 1 => disable backpressure
* 0 => enable backpressure
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on error
*/
int cvmx_agl_set_backpressure_override(u32 interface, uint32_t port_mask)
* buffers used by the packet IO hardware to the FPA so a function emptying the
* FPA after shutdown should find all packet buffers in the FPA.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_helper_shutdown_packet_io_global(void)
{
/**
* Does core local shutdown of packet io
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_shutdown_packet_io_local(void)
{
*
* @param xipd_port IPD/PKO port to auto configure
*
- * @return Link state after configure
+ * Return: Link state after configure
*/
cvmx_helper_link_info_t cvmx_helper_link_autoconf(int xipd_port)
{
*
* @param xipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t cvmx_helper_link_get(int xipd_port)
{
* @param xipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_link_set(int xipd_port, cvmx_helper_link_info_t link_info)
{
* @param enable_external
* Non zero if you want external loopback
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_helper_configure_loopback(int xipd_port, int enable_internal, int enable_external)
{
*
* @param pcie_port PCIe port the IO is for
*
- * @return 64bit Octeon IO base address for read/write
+ * Return: 64bit Octeon IO base address for read/write
*/
uint64_t cvmx_pcie_get_io_base_address(int pcie_port)
{
*
* @param pcie_port PCIe port the IO is for
*
- * @return Size of the IO window
+ * Return: Size of the IO window
*/
uint64_t cvmx_pcie_get_io_size(int pcie_port)
{
*
* @param pcie_port PCIe port the IO is for
*
- * @return 64bit Octeon IO base address for read/write
+ * Return: 64bit Octeon IO base address for read/write
*/
uint64_t cvmx_pcie_get_mem_base_address(int pcie_port)
{
*
* @param pcie_port PCIe port the IO is for
*
- * @return Size of the Mem window
+ * Return: Size of the Mem window
*/
uint64_t cvmx_pcie_get_mem_size(int pcie_port)
{
*
* @param pcie_port QLM number to return for.
*
- * @return QLM number.
+ * Return: QLM number.
*/
static int __cvmx_pcie_get_qlm(int node, int pcie_port)
{
* @param node Node to query
* @param pcie_port PEM to query
*
- * @return LTSSM state
+ * Return: LTSSM state
*/
static int __cvmx_pcie_rc_get_ltssm_state(int node, int pcie_port)
{
* @param node Node to query
* @param pcie_port PEM to query
*
- * @return LTSSM state
+ * Return: LTSSM state
*/
static const char *cvmx_pcie_get_ltssm_string(int ltssm)
{
* @param func PCIe function on the device
* @param reg Register to read
*
- * @return Config register value, or all ones on failure
+ * Return: Config register value, or all ones on failure
*/
static uint32_t cvmx_pcie_config_read32_retry(int node, int pcie_port, int bus, int dev, int func,
int reg)
* @param node node
* @param pcie_port PCIe port to initialize
*
- * @return Zero on success
+ * Return: Zero on success
*/
static int __cvmx_pcie_rc_initialize_link_gen2(int node, int pcie_port)
{
*
* @param pcie_port PCIe port to initialize
*
- * @return Zero on success
+ * Return: Zero on success
*/
static int __cvmx_pcie_rc_initialize_gen2(int pcie_port)
{
* @param node node
* @param pcie_port PCIe port to initialize
*
- * @return Zero on success
+ * Return: Zero on success
*/
static int __cvmx_pcie_rc_initialize_link_gen2_v3(int node, int pcie_port)
{
*
* @param pcie_port PCIe port to initialize for a node
*
- * @return Zero on success
+ * Return: Zero on success
*/
int cvmx_pcie_rc_initialize(int pcie_port)
{
*
* @param pcie_port PCIe port to shutdown for a node
*
- * @return Zero on success
+ * Return: Zero on success
*/
int cvmx_pcie_rc_shutdown(int pcie_port)
{
* @param fn Device sub function
* @param reg Register to access
*
- * @return 64bit Octeon IO address
+ * Return: 64bit Octeon IO address
*/
static uint64_t __cvmx_pcie_build_config_addr(int node, int port, int bus, int dev, int fn, int reg)
{
* @param fn Device sub function
* @param reg Register to access
*
- * @return Result of the read
+ * Return: Result of the read
*/
uint8_t cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg)
{
* @param fn Device sub function
* @param reg Register to access
*
- * @return Result of the read
+ * Return: Result of the read
*/
uint16_t cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg)
{
* @param fn Device sub function
* @param reg Register to access
*
- * @return Result of the read
+ * Return: Result of the read
*/
uint32_t cvmx_pcie_config_read32(int pcie_port, int bus, int dev, int fn, int reg)
{
* @param pcie_port PCIe port to read from
* @param cfg_offset Address to read
*
- * @return Value read
+ * Return: Value read
*/
uint32_t cvmx_pcie_cfgx_read(int pcie_port, uint32_t cfg_offset)
{
*
* @param pcie_port PCIe port to initialize for a node
*
- * @return Zero on success
+ * Return: Zero on success
*/
int cvmx_pcie_ep_initialize(int pcie_port)
{
*
* @param pcie_port PCIe port number (PEM number)
*
- * @return 0 if PCIe port is in target mode, !0 if in host mode.
+ * Return: 0 if PCIe port is in target mode, !0 if in host mode.
*/
int cvmx_pcie_is_host_mode(int pcie_port)
{
/**
* Return the number of QLMs supported by the chip
*
- * @return Number of QLMs
+ * Return: Number of QLMs
*/
int cvmx_qlm_get_num(void)
{
*
* @param xiface interface to look up
*
- * @return the qlm number based on the xiface
+ * Return: the qlm number based on the xiface
*/
int cvmx_qlm_interface(int xiface)
{
* @param xiface interface to look up
* @param index index in an interface
*
- * @return the qlm number based on the xiface
+ * Return: the qlm number based on the xiface
*/
int cvmx_qlm_lmac(int xiface, int index)
{
*
* @param BGX BGX to search for.
*
- * @return muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
+ * Return: muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
*/
int cvmx_qlm_mux_interface(int bgx)
{
*
* @param qlm QLM to examine
*
- * @return Number of lanes
+ * Return: Number of lanes
*/
int cvmx_qlm_get_lanes(int qlm)
{
/**
* Get the QLM JTAG fields based on Octeon model on the supported chips.
*
- * @return qlm_jtag_field_t structure
+ * Return: qlm_jtag_field_t structure
*/
const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void)
{
* Get the QLM JTAG length by going through qlm_jtag_field for each
* Octeon model that is supported
*
- * @return return the length.
+ * Return: return the length.
*/
int cvmx_qlm_jtag_get_length(void)
{
*
* @param name Name to lookup
*
- * @return Field info, or NULL on failure
+ * Return: Field info, or NULL on failure
*/
static const __cvmx_qlm_jtag_field_t *__cvmx_qlm_lookup_field(const char *name)
{
* @param lane Lane in QLM to get
* @param name String name of field
*
- * @return JTAG field value
+ * Return: JTAG field value
*/
uint64_t cvmx_qlm_jtag_get(int qlm, int lane, const char *name)
{
* @param node node of the QLM
* @param qlm QLM to examine
*
- * @return Speed in Mhz
+ * Return: Speed in Mhz
*/
int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm)
{
*
* @param qlm QLM to examine
*
- * @return Speed in Mhz
+ * Return: Speed in Mhz
*/
int cvmx_qlm_get_gbaud_mhz(int qlm)
{
* 1 - PCIe
* 2 - SATA
* @param interface interface to use
- * @return the qlm mode the interface is
+ * Return: the qlm mode the interface is
*/
enum cvmx_qlm_mode cvmx_qlm_get_dlm_mode(int interface_type, int interface)
{
* @param node node to measure
* @param qlm QLM to measure
*
- * @return Clock rate in Hz
+ * Return: Clock rate in Hz
*/
int cvmx_qlm_measure_clock_node(int node, int qlm)
{
*
* @param qlm QLM to measure
*
- * @return Clock rate in Hz
+ * Return: Clock rate in Hz
*/
int cvmx_qlm_measure_clock(int qlm)
{
* @param qlm QLM to perform RX equalization on
* @param lane Lane to use, or -1 for all lanes
*
- * @return Zero on success, negative if any lane failed RX equalization
+ * Return: Zero on success, negative if any lane failed RX equalization
*/
int __cvmx_qlm_rx_equalization(int node, int qlm, int lane)
{
* @param cmd command type
* @param[out] boot_args parsed values
*
- * @return number of arguments parsed
+ * Return: number of arguments parsed
*/
int octeon_parse_bootopts(int argc, char *const argv[],
enum octeon_boot_cmd_type cmd,
* @param size Size in bytes of block to allocate
* @param alignment Alignment required - must be power of 2
*
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc(u64 size, u64 alignment);
* @param size Size in bytes of block to allocate
* @param alignment Alignment required - must be power of 2
*
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_node(u64 node, u64 size, u64 alignment);
* @param address Physical address to allocate memory at. If this
* memory is not available, the allocation fails.
* @param alignment Alignment required - must be power of 2
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_address(u64 size, u64 address,
u64 alignment);
* @param min_addr defines the minimum address of the range
* @param max_addr defines the maximum address of the range
* @param alignment Alignment required - must be power of 2
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_range(u64 size, u64 alignment,
u64 min_addr, u64 max_addr);
* @param alignment Alignment required - must be power of 2
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
*
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_named(u64 size, u64 alignment,
const char *name);
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
* @param flags Flags to control options for the allocation.
*
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_named_flags(u64 size, u64 alignment,
const char *name, u32 flags);
* memory is not available, the allocation fails.
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
*
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_named_address(u64 size, u64 address,
const char *name);
* @param align Alignment of memory to be allocated. (must be a power of 2)
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
*
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_named_range(u64 size, u64 min_addr,
u64 max_addr, u64 align,
* The initialization function is optional, if omitted the named block
* is initialized to all zeros when it is created, i.e. once.
*
- * @return pointer to block of memory, NULL on error
+ * Return: pointer to block of memory, NULL on error
*/
void *cvmx_bootmem_alloc_named_range_once(u64 size,
u64 min_addr,
* @param name Name to assign to reserved blocks
* @param flags Flags to use when reserving memory
*
- * @return 0 on failure,
+ * Return: 0 on failure,
* !0 on success
*/
int cvmx_bootmem_reserve_memory(u64 start_addr, u64 size,
*
* @param name name of block to free
*
- * @return 0 on failure,
+ * Return: 0 on failure,
* !0 on success
*/
int cvmx_bootmem_free_named(const char *name);
*
* @param name name of block to free
*
- * @return pointer to named block descriptor on success
+ * Return: pointer to named block descriptor on success
* 0 on failure
*/
const struct cvmx_bootmem_named_block_desc *
* @param min_block_size
* Minimum block size to count in total.
*
- * @return Number of bytes available for allocation that meet the
+ * Return: Number of bytes available for allocation that meet the
* block size requirement
*/
u64 cvmx_bootmem_available_mem(u64 min_block_size);
* CVMX_BOOTMEM_ALIGNMENT_SIZE.)
* @param flags Flags to control options for the allocation.
*
- * @return physical address of block allocated, or -1 on failure
+ * Return: physical address of block allocated, or -1 on failure
*/
s64 cvmx_bootmem_phy_alloc(u64 req_size, u64 address_min, u64 address_max,
u64 alignment, u32 flags);
*
* @param flags Flags to control options for the allocation.
*
- * @return physical address of block allocated, or -1 on failure
+ * Return: physical address of block allocated, or -1 on failure
*/
s64 cvmx_bootmem_phy_named_block_alloc(u64 size, u64 min_addr, u64 max_addr,
u64 alignment, const char *name,
*
* @param flags Flags to control options for the allocation.
*
- * @return Physical address of the memory block descriptor, zero if not
+ * Return: Physical address of the memory block descriptor, zero if not
* found. If zero returned when name parameter is NULL, then no
* memory block descriptors are available.
*/
* @param min_block_size
* Minimum block size to count in total.
*
- * @return Number of bytes available for allocation that meet the
+ * Return: Number of bytes available for allocation that meet the
* block size requirement
*/
u64 cvmx_bootmem_phy_available_mem(u64 min_block_size);
* @param name name of block to free
* @param flags flags for passing options
*
- * @return 0 on failure
+ * Return: 0 on failure
* 1 on success
*/
int cvmx_bootmem_phy_named_block_free(const char *name, u32 flags);
* @param size size of block in bytes.
* @param flags flags for passing options
*
- * @return 1 on success,
+ * Return: 1 on success,
* 0 on failure
*/
int __cvmx_bootmem_phy_free(u64 phy_addr, u64 size, u32 flags);
* @param desc_buffer Buffer for the bootmem descriptor. This must be
* a 32 bit addressable address.
*
- * @return 1 on success
+ * Return: 1 on success
* 0 on failure
*/
s64 cvmx_bootmem_phy_mem_list_init(u64 mem_size, u32 low_reserved_bytes,
* @param desc_buffer Buffer for the bootmem descriptor. This must be
* a 32 bit addressable address.
*
- * @return 1 on success
+ * Return: 1 on success
* 0 on failure
*/
s64 cvmx_bootmem_phy_mem_list_init_multi(u8 nodemask, u32 mem_size[],
* @param fpa_pool FPA pool the command queues should come from.
* @param pool_size Size of each buffer in the FPA pool (bytes)
*
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
*/
cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id, int max_depth,
int fpa_pool, int pool_size);
*
* @param queue_id Queue to shutdown
*
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
*/
cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id);
*
* @param queue_id Hardware command queue to query
*
- * @return Number of outstanding commands
+ * Return: Number of outstanding commands
*/
int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id);
*
* @param queue_id Command queue to query
*
- * @return Command buffer or NULL on failure
+ * Return: Command buffer or NULL on failure
*/
void *cvmx_cmd_queue_buffer(cvmx_cmd_queue_id_t queue_id);
*
* @param queue_id Queue ID to get an index for
*
- * @return Index into the state arrays
+ * Return: Index into the state arrays
*/
static inline unsigned int __cvmx_cmd_queue_get_index(cvmx_cmd_queue_id_t queue_id)
{
*
* @param queue_id Queue id to get
*
- * @return Queue structure or NULL on failure
+ * Return: Queue structure or NULL on failure
*/
static inline __cvmx_cmd_queue_state_t *__cvmx_cmd_queue_get_state(cvmx_cmd_queue_id_t queue_id)
{
* @param cmd_count Number of command words to write
* @param cmds Array of commands to write
*
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
*/
static inline cvmx_cmd_queue_result_t
cvmx_cmd_queue_write(cvmx_cmd_queue_id_t queue_id, bool use_locking, int cmd_count, const u64 *cmds)
* @param cmd1 Command
* @param cmd2 Command
*
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
*/
static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write2(cvmx_cmd_queue_id_t queue_id,
bool use_locking, u64 cmd1, u64 cmd2)
* @param cmd2 Command
* @param cmd3 Command
*
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
*/
static inline cvmx_cmd_queue_result_t
cvmx_cmd_queue_write3(cvmx_cmd_queue_id_t queue_id, bool use_locking, u64 cmd1, u64 cmd2, u64 cmd3)
* @param node starting node number
* @param node_mask node mask to use to find the next node
*
- * @return next node number or -1 if no more nodes are available
+ * Return: next node number or -1 if no more nodes are available
*/
static inline int cvmx_coremask_next_node(int node, u8 node_mask)
{
*
* @param pcm is the pointer to the coremask.
* @param core
- * @return 1 if core is set and 0 if not.
+ * Return: 1 if core is set and 0 if not.
*/
static inline int cvmx_coremask_is_core_set(const struct cvmx_coremask *pcm,
int core)
* Is ``current core'' set in the coremask?
*
* @param pcm is the pointer to the coremask.
- * @return 1 if core is set and 0 if not.
+ * Return: 1 if core is set and 0 if not.
*/
static inline int cvmx_coremask_is_self_set(const struct cvmx_coremask *pcm)
{
/**
* Is coremask empty?
* @param pcm is the pointer to the coremask.
- * @return 1 if *pcm is empty (all zeros), 0 if not empty.
+ * Return: 1 if *pcm is empty (all zeros), 0 if not empty.
*/
static inline int cvmx_coremask_is_empty(const struct cvmx_coremask *pcm)
{
*
* @param pcm is the pointer to the coremask.
* @param core
- * @return 0.
+ * Return: 0.
*/
static inline int cvmx_coremask_set_core(struct cvmx_coremask *pcm, int core)
{
* Set ``current core'' in the coremask.
*
* @param pcm is the pointer to the coremask.
- * @return 0.
+ * Return: 0.
*/
static inline int cvmx_coremask_set_self(struct cvmx_coremask *pcm)
{
*
* @param pcm is the pointer to the coremask.
* @param core
- * @return 0.
+ * Return: 0.
*/
static inline int cvmx_coremask_clear_core(struct cvmx_coremask *pcm, int core)
{
* Clear ``current core'' from the coremask.
*
* @param pcm is the pointer to the coremask.
- * @return 0.
+ * Return: 0.
*/
static inline int cvmx_coremask_clear_self(struct cvmx_coremask *pcm)
{
*
* @param pcm is the pointer to the coremask.
* @param core
- * @return 0.
+ * Return: 0.
*/
static inline int cvmx_coremask_toggle_core(struct cvmx_coremask *pcm, int core)
{
* Toggle ``current core'' in the coremask.
*
* @param pcm is the pointer to the coremask.
- * @return 0.
+ * Return: 0.
*/
static inline int cvmx_coremask_toggle_self(struct cvmx_coremask *pcm)
{
* Gets the lower 64-bits of the coremask
*
* @param[in] pcm - pointer to coremask
- * @return 64-bit coremask for the first node
+ * Return: 64-bit coremask for the first node
*/
static inline u64 cvmx_coremask_get64(const struct cvmx_coremask *pcm)
{
*
* @param[in] pcm - pointer to coremask
* @param node - node to get coremask for
- * @return 64-bit coremask for the first node
+ * Return: 64-bit coremask for the first node
*/
static inline u64 cvmx_coremask_get64_node(const struct cvmx_coremask *pcm,
u8 node)
* Gets the lower 32-bits of the coremask for compatibility
*
* @param[in] pcm - pointer to coremask
- * @return 32-bit coremask for the first node
+ * Return: 32-bit coremask for the first node
* @deprecated This function is to maintain compatibility with older
* SDK applications and may disappear at some point.
* This function is not compatible with the CN78XX or any other
* @param core - starting core to check (can be -1 for core 0)
* @param pcm - pointer to coremask to check for the next core.
*
- * @return next core following the core parameter or -1 if no more cores.
+ * Return: next core following the core parameter or -1 if no more cores.
*/
static inline int cvmx_coremask_next_core(int core,
const struct cvmx_coremask *pcm)
* @param[in] pcm pointer to the coremask to test against
* @param[in] core core to check
*
- * @return 1 if the core is first core in the coremask, 0 otherwise
+ * Return: 1 if the core is first core in the coremask, 0 otherwise
*
*/
static inline int cvmx_coremask_is_core_first_core(const struct cvmx_coremask *pcm,
*
* @param[in] pcm - pointer to core mask
*
- * @return number of bits set in the coremask
+ * Return: number of bits set in the coremask
*/
static inline int cvmx_coremask_get_core_count(const struct cvmx_coremask *pcm)
{
*
* @param core - core number (0-1023)
*
- * @return node number core belongs to
+ * Return: node number core belongs to
*/
static inline int cvmx_coremask_core_to_node(int core)
{
* @param main - main coremask to test
* @param subset - subset coremask to test
*
- * @return 0 if the subset contains cores not in the main coremask or 1 if
+ * Return: 0 if the subset contains cores not in the main coremask or 1 if
* the subset is fully contained in the main coremask.
*/
static inline int cvmx_coremask_is_subset(const struct cvmx_coremask *main,
* @param c1 - main coremask to test
* @param c2 - subset coremask to test
*
- * @return 1 if coremask c1 intersects coremask c2, 0 if they are exclusive
+ * Return: 1 if coremask c1 intersects coremask c2, 0 if they are exclusive
*/
static inline int cvmx_coremask_intersects(const struct cvmx_coremask *c1,
const struct cvmx_coremask *c2)
*
* @param[in] pcm - pointer to core mask
*
- * @return nothing
+ * Return: nothing
*/
void cvmx_coremask_print(const struct cvmx_coremask *pcm);
*
* @param flags Optional flags.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_initialize(void);
* handlers. This should be called in the RSL interrupt handler
* for your application or operating system.
*
- * @return Number of error handlers called. Zero means this call
+ * Return: Number of error handlers called. Zero means this call
* found no errors and was spurious.
*/
int cvmx_error_poll(void);
* call. All members of the structure must be populated, even the
* parent information.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_add(const cvmx_error_info_t *new_info);
* @param old_info If not NULL, this is filled with information about the handler
* that was removed.
*
- * @return Zero on success, negative on failure (not found).
+ * Return: Zero on success, negative on failure (not found).
*/
int cvmx_error_remove(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask,
cvmx_error_info_t *old_info);
* @param old_user_info
* If not NULL, the old user info parameter.
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_error_change_handler(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask,
cvmx_error_func_t new_func, u64 new_user_info,
* Index for the group as defined in the cvmx_error_group_t
* comments.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
/*
* Rather than conditionalize the calls throughout the executive to not enable
* Index for the group as defined in the cvmx_error_group_t
* comments.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
/*
* Rather than conditionalize the calls throughout the executive to not disable
* All handlers for this status register with this mask will be
* enabled.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_enable(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask);
* All handlers for this status register with this mask will be
* disabled.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_disable(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask);
*
* @param info Error register to check
*
- * @return Number of error status bits found or zero if no bits were set.
+ * Return: Number of error status bits found or zero if no bits were set.
*/
int __cvmx_error_decode(const cvmx_error_info_t *info);
* @param status_addr
* Status register address
*
- * @return Return the handler on success or null on failure.
+ * Return: Return the handler on success or null on failure.
*/
cvmx_error_info_t *cvmx_error_get_index(u64 status_addr);
* @param key INTSN value to search for
* @param data current entry from the searched array
*
- * @return Negative, 0 or positive when respectively key is less than,
+ * Return: Negative, 0 or positive when respectively key is less than,
* equal or greater than data.
*/
int cvmx_error_intsn_cmp(const void *key, const void *data);
*
* @param node Node number
*
- * @return Zero on success, -1 on error
+ * Return: Zero on success, -1 on error
*/
int cvmx_error_intsn_display_v3(int node, u32 intsn);
*
* @param node Node number
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_initialize_cn78xx(int node);
* @param node Node number
* @param intsn Interrupt source number
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_intsn_enable_v3(int node, u32 intsn);
* @param node Node number
* @param intsn Interrupt source number
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_intsn_disable_v3(int node, u32 intsn);
*
* @param intsn Interrupt source number
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_intsn_clear_v3(int node, u32 intsn);
* @param node Node number
* @param csr_address CSR address
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_error_csr_enable_v3(int node, u64 csr_address);
* @param node Node number
* @param csr_address CSR address
*
- * @return Zero
+ * Return: Zero
*/
int cvmx_error_csr_disable_v3(int node, u64 csr_address);
* @param group Logical group to enable
* @param xipd_port The IPD port value
*
- * @return Zero.
+ * Return: Zero.
*/
int cvmx_error_enable_group_v3(cvmx_error_group_t group, int xipd_port);
* @param group Logical group to enable
* @param xipd_port The IPD port value
*
- * @return Zero.
+ * Return: Zero.
*/
int cvmx_error_disable_group_v3(cvmx_error_group_t group, int xipd_port);
* @param type Category in a logical group to enable
* @param xipd_port The IPD port value
*
- * @return Zero.
+ * Return: Zero.
*/
int cvmx_error_enable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t type,
int xipd_port);
* @param type Category in a logical group to disable
* @param xipd_port The IPD port value
*
- * @return Zero.
+ * Return: Zero.
*/
int cvmx_error_disable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t type,
int xipd_port);
* @param group Logical group to disable
* @param xipd_port The IPD port value
*
- * @return Zero.
+ * Return: Zero.
*/
int cvmx_error_clear_group_v3(cvmx_error_group_t group, int xipd_port);
* @param node CCPI node
* @param type category to enable
*
- *@return Zero.
+ *Return: Zero.
*/
int cvmx_error_enable_type_v3(int node, cvmx_error_type_t type);
* @param node CCPI node
* @param type category to disable
*
- *@return Zero.
+ *Return: Zero.
*/
int cvmx_error_disable_type_v3(int node, cvmx_error_type_t type);
* @param intsn intsn from error array.
* @param remote true for remote node (cn78xx only)
*
- * @return 1 if handled, 0 if not handled
+ * Return: 1 if handled, 0 if not handled
*/
int __cvmx_cn7xxx_l2c_tag_error_display(int node, int intsn, bool remote);
* Return the name of the pool
*
* @param pool_num Pool to get the name of
- * @return The name
+ * Return: The name
*/
const char *cvmx_fpa_get_name(int pool_num);
* Get a new block from the FPA
*
* @param pool Pool to get the block from
- * @return Pointer to the block or NULL on failure
+ * Return: Pointer to the block or NULL on failure
*/
static inline void *cvmx_fpa_alloc(u64 pool)
{
* @param pool Pool the block came from. Must be the same value
* passed to cvmx_fpa_async_alloc.
*
- * @return Pointer to the block or NULL on failure
+ * Return: Pointer to the block or NULL on failure
*/
static inline void *cvmx_fpa_async_alloc_finish(u64 scr_addr, u64 pool)
{
* @param block_size Size for each block controlled by the FPA
* @param num_blocks Number of blocks
*
- * @return the pool number on Success,
+ * Return: the pool number on Success,
* -1 on failure
*/
int cvmx_fpa_setup_pool(int pool, const char *name, void *buffer, u64 block_size, u64 num_blocks);
/**
* Gets the block size of buffer in specified pool
* @param pool Pool to get the block size from
- * @return Size of buffer in specified pool
+ * Return: Size of buffer in specified pool
*/
unsigned int cvmx_fpa_get_block_size(int pool);
*
* @param pool FPA pool to allocate/reserve. If -1 it
* finds an empty pool to allocate.
- * @return Alloctaed pool number or CVMX_FPA1_POOL_INVALID
+ * Return: Alloctaed pool number or CVMX_FPA1_POOL_INVALID
* if fails to allocate the pool
*/
cvmx_fpa1_pool_t cvmx_fpa1_reserve_pool(cvmx_fpa1_pool_t pool);
/**
* Free the specified fpa pool.
* @param pool Pool to free
- * @return 0 for success -1 failure
+ * Return: 0 for success -1 failure
*/
int cvmx_fpa1_release_pool(cvmx_fpa1_pool_t pool);
* @param pool Pool the block came from. Must be the same value
* passed to cvmx_fpa_async_alloc.
*
- * @return Pointer to the block or NULL on failure
+ * Return: Pointer to the block or NULL on failure
*/
static inline void *cvmx_fpa1_async_alloc_finish(u64 scr_addr, cvmx_fpa1_pool_t pool)
{
* Get a new block from the FPA pool
*
* @param aura - aura number
- * @return pointer to the block or NULL on failure
+ * Return: pointer to the block or NULL on failure
*/
static inline void *cvmx_fpa3_alloc(cvmx_fpa3_gaura_t aura)
{
* @param aura Global aura the block came from. Must be the same value
* passed to cvmx_fpa_async_alloc.
*
- * @return Pointer to the block or NULL on failure
+ * Return: Pointer to the block or NULL on failure
*/
static inline void *cvmx_fpa3_async_alloc_finish(u64 scr_addr, cvmx_fpa3_gaura_t aura)
{
* Gets the buffer size of the specified pool,
*
* @param aura Global aura number
- * @return Returns size of the buffers in the specified pool.
+ * Return: Returns size of the buffers in the specified pool.
*/
static inline int cvmx_fpa3_get_aura_buf_size(cvmx_fpa3_gaura_t aura)
{
* Return the number of available buffers in an AURA
*
* @param aura to receive count for
- * @return available buffer count
+ * Return: available buffer count
*/
static inline long long cvmx_fpa3_get_available(cvmx_fpa3_gaura_t aura)
{
* @param block_size - size of buffers to use
* @param num_blocks - number of blocks to allocate
*
- * @return configured gaura on success, CVMX_FPA3_INVALID_GAURA on failure
+ * Return: configured gaura on success, CVMX_FPA3_INVALID_GAURA on failure
*/
cvmx_fpa3_gaura_t cvmx_fpa3_set_aura_for_pool(cvmx_fpa3_pool_t pool, int desired_aura,
const char *name, unsigned int block_size,
* @param node node to read from
* @param byte_addr address to read
*
- * @return fuse value: 0 or 1
+ * Return: fuse value: 0 or 1
*/
static inline u8 cvmx_fuse_read_byte_node(u8 node, int byte_addr)
{
* Read a byte of fuse data
* @param byte_addr address to read
*
- * @return fuse value: 0 or 1
+ * Return: fuse value: 0 or 1
*/
static inline u8 cvmx_fuse_read_byte(int byte_addr)
{
* @param node Node number
* @param fuse Fuse number (0-1024)
*
- * @return fuse value: 0 or 1
+ * Return: fuse value: 0 or 1
*/
static inline int cvmx_fuse_read_node(u8 node, int fuse)
{
*
* @param fuse Fuse number (0-1024)
*
- * @return fuse value: 0 or 1
+ * Return: fuse value: 0 or 1
*/
static inline int cvmx_fuse_read(int fuse)
{
* @param nelements is the number of elements to be allocated.
* @param owner is a 64 bit number that identifes the owner of this range.
* @aligment specifes the required alignment of the returned base number.
- * @return returns the base of the allocated range. -1 return value indicates
+ * Return: returns the base of the allocated range. -1 return value indicates
* failure.
*/
int cvmx_allocate_global_resource_range(struct global_resource_tag tag, u64 owner, int nelements,
* @param owner is a 64 bit number that identifes the owner of the allocated
* elements.
* @param allocated_elements returns indexs of the allocated entries.
- * @return returns 0 on success and -1 on failure.
+ * Return: returns 0 on success and -1 on failure.
*/
int cvmx_resource_alloc_many(struct global_resource_tag tag, u64 owner, int nelements,
int allocated_elements[]);
* @param nelements is the number of elements to be allocated.
* @param owner is a 64 bit number that identifes the owner of this range.
* @base specifies the base start of nelements.
- * @return returns the base of the allocated range. -1 return value indicates
+ * Return: returns the base of the allocated range. -1 return value indicates
* failure.
*/
int cvmx_reserve_global_resource_range(struct global_resource_tag tag, u64 owner, int base,
* @param tag is the tag of the global resource range.
* @param base is the base number
* @param nelements is the number of elements that are to be freed.
- * @return returns 0 if successful and -1 on failure.
+ * Return: returns 0 if successful and -1 on failure.
*/
int cvmx_free_global_resource_range_with_base(struct global_resource_tag tag, int base,
int nelements);
* @param tag is the tag of the global resource range.
* @param bases is an array containing the bases to be freed.
* @param nelements is the number of elements that are to be freed.
- * @return returns 0 if successful and -1 on failure.
+ * Return: returns 0 if successful and -1 on failure.
*/
int cvmx_free_global_resource_range_multiple(struct global_resource_tag tag, int bases[],
int nelements);
* specified tag.
* @param tag is the tag of the global resource range.
* @param owner is the owner of resources that are to be freed.
- * @return returns 0 if successful and -1 on failure.
+ * Return: returns 0 if successful and -1 on failure.
*/
int cvmx_free_global_resource_range_with_owner(struct global_resource_tag tag, int owner);
*
* @param interface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_agl_probe(int interface);
*
* @param interface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_agl_enable(int interface);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_agl_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_agl_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
*
* @param xiface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_bgx_probe(int xiface);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_bgx_sgmii_enable(int xiface);
*
* @param xipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_bgx_sgmii_link_get(int xipd_port);
* @param xipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_bgx_sgmii_link_set(int xipd_port, cvmx_helper_link_info_t link_info);
* @param enable_external
* Non zero if you want external loopback
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int __cvmx_helper_bgx_sgmii_configure_loopback(int xipd_port, int enable_internal,
int enable_external);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_bgx_xaui_enable(int xiface);
*
* @param xipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_bgx_xaui_link_get(int xipd_port);
* @param xipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_bgx_xaui_link_set(int xipd_port, cvmx_helper_link_info_t link_info);
* @param enable_external
* Non zero if you want external loopback
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int __cvmx_helper_bgx_xaui_configure_loopback(int xipd_port, int enable_internal,
int enable_external);
* @param xiface xinterface to check
* @param index port index (must be 0 for rgmii)
*
- * @return true if RGMII, false otherwise
+ * Return: true if RGMII, false otherwise
*/
static inline bool cvmx_helper_bgx_is_rgmii(int xiface, int index)
{
* @param xiface global interface number
* @param index interface index
*
- * @return true, if Super-MAC/PCS mode, false -- otherwise
+ * Return: true, if Super-MAC/PCS mode, false -- otherwise
*/
bool cvmx_helper_bgx_is_smu(int xiface, int index);
* @param type PAUSE packet type.
* @param time Pause time for PAUSE packets (number of 512 bit-times).
* @param interval Interval between PAUSE packets (number of 512 bit-times).
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_bgx_set_pause_pkt_param(int xipd_port, u64 smac, u64 dmac, unsigned int type,
unsigned int time, unsigned int interval);
* @param xipd_port Global IPD port (node + IPD port).
* @param type Flow-control type/protocol.
* @param mode Flow-control mode.
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_bgx_set_flowctl_mode(int xipd_port, cvmx_qos_proto_t qos, cvmx_qos_pkt_mode_t mode);
* @param index port index
* @param enable true to enable autonegotiation, false to disable it
*
- * @return 0 for success, -1 on error.
+ * Return: 0 for success, -1 on error.
*/
int cvmx_helper_set_autonegotiation(int xiface, int index, bool enable);
* @param index port index
* @param enable set to true to enable FEC, false to disable
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*
* @NOTE: If autonegotiation is enabled then autonegotiation will be
* restarted for negotiating FEC.
*
* @param ipd_port Octeon IPD port to get the MII address for.
*
- * @return MII PHY address and bus number or -1.
+ * Return: MII PHY address and bus number or -1.
*/
int cvmx_helper_board_get_mii_address(int ipd_port);
* @param link_info Link speed to program. If the speed is zero and autonegotiation
* is enabled, all possible negotiation speeds are advertised.
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_board_link_set_phy(int phy_addr,
cvmx_helper_board_set_phy_link_flags_types_t link_flags,
* @param ipd_port IPD input port associated with the port we want to get link
* status for.
*
- * @return The ports link status. If the link isn't fully resolved, this must
+ * Return: The ports link status. If the link isn't fully resolved, this must
* return zero.
*/
cvmx_helper_link_info_t __cvmx_helper_board_link_get(int ipd_port);
* @param supported_ports
* Number of ports Octeon supports.
*
- * @return Number of ports the actual board supports. Many times this will
+ * Return: Number of ports the actual board supports. Many times this will
* simple be "support_ports".
*/
int __cvmx_helper_board_interface_probe(int interface, int supported_ports);
*
* @param interface Interface to enable
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_board_hardware_enable(int interface);
* Gets the clock type used for the USB block based on board type.
* Used by the USB code for auto configuration of clock type.
*
- * @return USB clock type enumeration
+ * Return: USB clock type enumeration
*/
cvmx_helper_board_usb_clock_types_t __cvmx_helper_board_usb_get_clock_type(void);
* @param supported_ports expected number of ports based on chip type;
*
*
- * @return number of available usb ports, based on board specifics.
+ * Return: number of available usb ports, based on board specifics.
* Return value is supported_ports if function does not
* override.
*/
* @param fdt_addr - address fo flat device tree
* @param ipd_port - IPD port number
*
- * @return 1 if port is present, 0 if not present, -1 if error
+ * Return: 1 if port is present, 0 if not present, -1 if error
*/
int __cvmx_helper_board_get_port_from_dt(void *fdt_addr, int ipd_port);
*
* @param ipd_port - ipd port number to get the host mode for
*
- * @return host mode for phy
+ * Return: host mode for phy
*/
cvmx_phy_host_mode_t cvmx_helper_board_get_phy_host_mode(int ipd_port);
* @param[out] - phy_info - phy info data structure
* @param ipd_port - port to get phy info for
*
- * @return 0 for success, -1 if info not available
+ * Return: 0 for success, -1 if info not available
*
* NOTE: The phy_info data structure is subject to change.
*/
*
* @param fdt_addr Pointer to device tree
*
- * @return 0 for success, -1 on error.
+ * Return: 0 for success, -1 on error.
*/
int __cvmx_helper_parse_bgx_dt(const void *fdt_addr);
*
* @param fdt_addr Pointer to device tree
*
- * @return 0 for success, -1 on error.
+ * Return: 0 for success, -1 on error.
*/
int __cvmx_helper_parse_bgx_rgmii_dt(const void *fdt_addr);
* @param xiface xinterface number
* @param index port index on interface
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*
* This function figures out the proper mod_abs_changed function to use and
* registers the appropriate function. This should be called after the device
* @param xiface xinterface number
* @param index port index on interface
*
- * @return 0 if signal present, 1 if loss of signal.
+ * Return: 0 if signal present, 1 if loss of signal.
*
* @NOTE: A result of 0 is possible in some cases where the signal is
* not present.
*
* @param interface the interface number
* @param index the port's index number
- * @return the pknd
+ * Return: the pknd
*/
int __cvmx_helper_cfg_pknd(int interface, int index);
*
* @param interface the interface number
* @param index the port's index number
- * @return the bpid
+ * Return: the bpid
*/
int __cvmx_helper_cfg_bpid(int interface, int index);
*
* @param interface the interface number
* @param index the port's index number
- * @return the pko_port base
+ * Return: the pko_port base
*/
int __cvmx_helper_cfg_pko_port_base(int interface, int index);
*
* @param interface the interface number
* @param index the port's index number
- * @return the number of pko_ports
+ * Return: the number of pko_ports
*/
int __cvmx_helper_cfg_pko_port_num(int interface, int index);
* Return the configured pko_queue base for the pko_port
*
* @param pko_port
- * @return the pko_queue base
+ * Return: the pko_queue base
*/
int __cvmx_helper_cfg_pko_queue_base(int pko_port);
* Return the configured number of pko_queues for the pko_port
*
* @param pko_port
- * @return the number of pko_queues
+ * Return: the number of pko_queues
*/
int __cvmx_helper_cfg_pko_queue_num(int pko_port);
* Return the interface the pko_port is configured for
*
* @param pko_port
- * @return the interface for the pko_port
+ * Return: the interface for the pko_port
*/
int __cvmx_helper_cfg_pko_port_interface(int pko_port);
* Return the index of the port the pko_port is configured for
*
* @param pko_port
- * @return the index of the port
+ * Return: the index of the port
*/
int __cvmx_helper_cfg_pko_port_index(int pko_port);
* Return the pko_eid of the pko_port
*
* @param pko_port
- * @return the pko_eid
+ * Return: the pko_eid
*/
int __cvmx_helper_cfg_pko_port_eid(int pko_port);
* @INTERNAL
* Return the max# of pko queues allocated.
*
- * @return the max# of pko queues
+ * Return: the max# of pko queues
*
* Note: there might be holes in the queue space depending on user
* configuration. The function returns the highest queue's index in
* @INTERNAL
* Return the max# of PKO DMA engines allocated.
*
- * @return the max# of DMA engines
+ * Return: the max# of DMA engines
*
* NOTE: the DMA engines are allocated contiguously and starting from
* 0.
* Get the value set for the config option ``opt''.
*
* @param opt is the config option.
- * @return the value set for the option
+ * Return: the value set for the option
*
* LR: only used for DWB in NPI, POW, PKO1
*/
*
* @param opt is the config option.
* @param val is the value to set for the opt.
- * @return 0 for success and -1 on error
+ * Return: 0 for success and -1 on error
*
* Note an option here is a config-time parameter and this means that
* it has to be set before calling the corresponding setup functions
* Retrieve the pko_port base given ipd_port.
*
* @param ipd_port is the IPD eport
- * @return the corresponding PKO port base for the physical port
+ * Return: the corresponding PKO port base for the physical port
* represented by the IPD eport or CVMX_HELPER_CFG_INVALID_VALUE.
*/
int cvmx_helper_cfg_ipd2pko_port_base(int ipd_port);
* Retrieve the number of pko_ports given ipd_port.
*
* @param ipd_port is the IPD eport
- * @return the corresponding number of PKO ports for the physical port
+ * Return: the corresponding number of PKO ports for the physical port
* represented by IPD eport or CVMX_HELPER_CFG_INVALID_VALUE.
*/
int cvmx_helper_cfg_ipd2pko_port_num(int ipd_port);
* The init function
*
* @param node
- * @return 0 for success.
+ * Return: 0 for success.
*
* Note: this function is meant to be called to set the ``configured
* parameters,'' e.g., pknd, bpid, etc. and therefore should be before
* The local init function
*
* @param none
- * @return 0 for success.
+ * Return: 0 for success.
*
* Note: this function is meant to be called to set the ``configured
* parameters locally,'' e.g., pknd, bpid, etc. and therefore should be before
* port. This call will allocate a total of
* (port_cnt * queue_cnt) queues
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*
* LR: Called ONLY from comfig-parse!
*
* @param port the internal port for which the queues are freed.
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
int cvmx_pko_queue_free(u64 port);
/*
* Initializes the pko queue range data structure.
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
int init_cvmx_pko_que_range(void);
* @param xiface interface to check
* @param index port index in the interface
*
- * @return status of the port present or not.
+ * Return: status of the port present or not.
*/
int cvmx_helper_is_port_valid(int xiface, int index);
* @param interface the interface number
* @param index the port's index number
*
- * @return 1 if port is in PHY mode, 0 if port is in MAC mode
+ * Return: 1 if port is in PHY mode, 0 if port is in MAC mode
*/
bool cvmx_helper_get_mac_phy_mode(int interface, int index);
void cvmx_helper_set_mac_phy_mode(int interface, int index, bool valid);
* @param interface the interface number
* @param index the port's index number
*
- * @return 1 if port is in 1000Base X mode, 0 if port is in SGMII mode
+ * Return: 1 if port is in 1000Base X mode, 0 if port is in SGMII mode
*/
bool cvmx_helper_get_1000x_mode(int interface, int index);
void cvmx_helper_set_1000x_mode(int interface, int index, bool valid);
*
* @param xiface node and interface
* @param index port index
- * @return node offset of port or -1 if invalid
+ * Return: node offset of port or -1 if invalid
*/
int cvmx_helper_get_port_fdt_node_offset(int xiface, int index);
*
* @param xiface node and interface
* @param index port index
- * @return node offset of phy or -1 if invalid
+ * Return: node offset of phy or -1 if invalid
*/
int cvmx_helper_get_phy_fdt_node_offset(int xiface, int index);
* @param xiface node and interface
* @param index port index
*
- * @return 0 if autonegotiation is disabled, 1 if enabled.
+ * Return: 0 if autonegotiation is disabled, 1 if enabled.
*/
bool cvmx_helper_get_port_autonegotiation(int xiface, int index);
* @param xiface node and interface
* @param index port index
*
- * @return 0 if fec is disabled, 1 if enabled.
+ * Return: 0 if fec is disabled, 1 if enabled.
*/
bool cvmx_helper_get_port_fec(int xiface, int index);
* @param xiface node and interface
* @param index port index
*
- * @return pointer to PHY information data structure or NULL if not set
+ * Return: pointer to PHY information data structure or NULL if not set
*/
struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index);
* @param xiface node and interface
* @param index portindex
*
- * @return pointer to the PHY LED information data structure or NULL if not
+ * Return: pointer to the PHY LED information data structure or NULL if not
* present
*/
struct cvmx_phy_gpio_leds *cvmx_helper_get_port_phy_leds(int xiface, int index);
* @param xiface node and interface
* @param index port index
*
- * @return offset in device tree or -1 if error or not defined.
+ * Return: offset in device tree or -1 if error or not defined.
*/
int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index);
*
* @param of_offset Node offset of port to search for
*
- * @return ipd_port or -1 if not found
+ * Return: ipd_port or -1 if not found
*/
int cvmx_helper_cfg_get_ipd_port_by_fdt_node_offset(int of_offset);
* @param[out] xiface xinterface of match
* @param[out] index port index of match
*
- * @return 0 if found, -1 if not found
+ * Return: 0 if found, -1 if not found
*/
int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xiface, int *index);
* @param xiface node and interface
* @param index port index
*
- * @return pointer to vsc7224 data structure or NULL if not present
+ * Return: pointer to vsc7224 data structure or NULL if not present
*/
struct cvmx_vsc7224_chan *cvmx_helper_cfg_get_vsc7224_chan_info(int xiface, int index);
* @param xiface node and interface
* @param index port index
*
- * @return pointer to avsp5410 data structure or NULL if not present
+ * Return: pointer to avsp5410 data structure or NULL if not present
*/
struct cvmx_avsp5410 *cvmx_helper_cfg_get_avsp5410_info(int xiface, int index);
* @param xiface node and interface
* @param index port index
*
- * @return pointer to SFP data structure or NULL if none
+ * Return: pointer to SFP data structure or NULL if none
*/
struct cvmx_fdt_sfp_info *cvmx_helper_cfg_get_sfp_info(int xiface, int index);
* @INTERNAL
* Function to adjust internal IPD pointer alignments
*
- * @return 0 on success
+ * Return: 0 on success
* !0 on failure
*/
int __cvmx_helper_errata_fix_ipd_ptr_alignment(void);
* in each buffer).
*
* @param work Work queue entry to fix
- * @return Zero on success. Negative on failure
+ * Return: Zero on success. Negative on failure
*/
int cvmx_helper_fix_ipd_packet_chain(cvmx_wqe_t *work);
* @param[in,out] lenp Number of phandles, input max number
* @param[out] nodes Array of phandle nodes
*
- * @return -ve error code on error or 0 for success
+ * Return: -ve error code on error or 0 for success
*/
int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, const char *prop_name, int *lenp,
int *nodes);
* @param node node to read address from
* @param prop_name property name to read
*
- * @return address of property or FDT_ADDR_T_NONE if not found
+ * Return: address of property or FDT_ADDR_T_NONE if not found
*/
static inline fdt_addr_t cvmx_fdt_get_addr(const void *fdt_addr, int node, const char *prop_name)
{
* @param[in] prop_name property name to read
* @param default_val default value to return if property doesn't exist
*
- * @return integer value of property or default_val if it doesn't exist.
+ * Return: integer value of property or default_val if it doesn't exist.
*/
static inline int cvmx_fdt_get_int(const void *fdt_addr, int node, const char *prop_name,
int default_val)
* @param node node to read phandle from
* @param[in] prop_name name of property to find
*
- * @return node offset if found, -ve error code on error
+ * Return: node offset if found, -ve error code on error
*/
static inline int cvmx_fdt_lookup_phandle(const void *fdt_addr, int node, const char *prop_name)
{
* NOTE: in_addr must be in the native ENDIAN
* format.
*
- * @return Translated address or FDT_ADDR_T_NONE if address cannot be
+ * Return: Translated address or FDT_ADDR_T_NONE if address cannot be
* translated.
*/
static inline u64 cvmx_fdt_translate_address(const void *fdt_addr, int node, const u32 *in_addr)
* @param[in] s1 First string to compare
* @param[in] sw Second string to compare
*
- * @return 0 if no match
+ * Return: 0 if no match
* 1 if only the part number matches and not the manufacturer
* 2 if both the part number and manufacturer match
*/
* @param llen string list total length
* @param[in] str string to search for
*
- * @return 1 if string list contains string, 0 if it does not.
+ * Return: 1 if string list contains string, 0 if it does not.
*/
int cvmx_fdt_compat_list_contains(const char *slist, int llen, const char *str);
* @param node node offset to check
* @param[in] compat compatible string to check
*
- * @return 0 if compatible, 1 if not compatible, error if negative
+ * Return: 0 if compatible, 1 if not compatible, error if negative
*/
int cvmx_fdt_node_check_compatible(const void *fdt_addr, int node, const char *compat);
* @param[in] compat compatible string
* @param[in] str string to check
*
- * @return 0 if not compatible, 1 if manufacturer compatible, 2 if
+ * Return: 0 if not compatible, 1 if manufacturer compatible, 2 if
* part is compatible, 3 if both part and manufacturer are
* compatible.
*/
* @param phandle phandle to GPIO
* @param[out] size Number of pins (optional, may be NULL)
*
- * @return Type of GPIO device or PIN_ERROR if error
+ * Return: Type of GPIO device or PIN_ERROR if error
*/
enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, int *size);
* NULL for none.
* @param[out] addr TWSI address number, can be NULL for none
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int cvmx_fdt_get_twsi_gpio_bus_addr(const void *fdt_addr, int phandle, int *bus, int *addr);
* @param[in] fdt_addr Address of FDT
* @param node FDT node number
*
- * @return CPU node number or error if negative
+ * Return: CPU node number or error if negative
*/
int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node);
*
* @param[in] fdt_addr Address of FDT
*
- * @return Size of flat device tree in bytes or -1 if error.
+ * Return: Size of flat device tree in bytes or -1 if error.
*/
int cvmx_fdt_get_fdt_size(const void *fdt_addr);
* @param[in] strlist Array of FDT device compatibility strings,
* must end with NULL or empty string.
*
- * @return 0 if at least one item matches, 1 if no matches
+ * Return: 0 if at least one item matches, 1 if no matches
*/
int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const char *const *strlist);
* @param strlist Array of FDT device compatibility strings, must
* end with NULL or empty string.
*
- * @return next matching node or -1 if no more matches.
+ * Return: next matching node or -1 if no more matches.
*/
int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffset,
const char *const *strlist);
* @param of_offset Offset of the parent node of a GPIO device in
* the device tree.
*
- * @return pointer to list of i2c devices starting from the root which
+ * Return: pointer to list of i2c devices starting from the root which
* can include i2c muxes and switches or NULL if error. Note that
* all entries are allocated on the heap.
*
*
* @param[in] bus bus descriptor
*
- * @return Octeon twsi bus number or -1 on error
+ * Return: Octeon twsi bus number or -1 on error
*/
int cvmx_fdt_i2c_get_root_bus(const struct cvmx_fdt_i2c_bus_info *bus);
*
* @param bus bus to free
*
- * @return 0
+ * Return: 0
*/
int cvmx_fdt_free_i2c_bus(struct cvmx_fdt_i2c_bus_info *bus);
* @param[in] bus i2c bus descriptor to enable or disable
* @param enable set to true to enable, false to disable
*
- * @return 0 for success or -1 for invalid bus
+ * Return: 0 for success or -1 for invalid bus
*
* This enables the entire bus including muxes and switches in the path.
*/
* @param of_offset node offset for property
* @param prop_name name of property
*
- * @return pointer to GPIO handle or NULL if error
+ * Return: pointer to GPIO handle or NULL if error
*/
struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, int of_offset,
const char *prop_name);
* @param pin GPIO pin descriptor
* @param value value to set it to, 0 or 1
*
- * @return 0 on success, -1 on error.
+ * Return: 0 on success, -1 on error.
*
* NOTE: If the CVMX_GPIO_ACTIVE_LOW flag is set then the output value will be
* inverted.
*
* @param pin GPIO pin descriptor
*
- * @return 0 if low, 1 if high, -1 on error. Note that the input will be
+ * Return: 0 if low, 1 if high, -1 on error. Note that the input will be
* inverted if the CVMX_GPIO_ACTIVE_LOW flag bit is set.
*/
int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin);
* @param sfp Handle to SFP data structure
* @param ipd_port Port to assign it to
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port);
*
* @param[in] sfp Handle to SFP data structure
*
- * @return IPD port number for SFP slot
+ * Return: IPD port number for SFP slot
*/
static inline int cvmx_sfp_get_ipd_port(const struct cvmx_fdt_sfp_info *sfp)
{
*
* @param[in] sfp SFP to get phy info from
*
- * @return phy descriptor or NULL if none.
+ * Return: phy descriptor or NULL if none.
*/
static inline struct cvmx_phy_info *cvmx_sfp_get_phy_info(const struct cvmx_fdt_sfp_info *sfp)
{
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int __cvmx_fdt_parse_vsc7224(const void *fdt_addr);
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int __cvmx_fdt_parse_avsp5410(const void *fdt_addr);
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return pointer to sfp info or NULL if error
+ * Return: pointer to sfp info or NULL if error
*/
struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, int of_offset);
* @param of_offset offset of slice or phy in device tree
* @param phy_info phy_info data structure to fill in
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_fdt_parse_cs4343(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info);
* @param bus i2c bus number
* @param addr i2c device address (7 bits)
*
- * @return 8-bit value or error if negative
+ * Return: 8-bit value or error if negative
*/
int cvmx_fdt_i2c_reg_read(int bus, int addr);
* @param reg i2c 8-bit register address
* @param val 8-bit value to write
*
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
int cvmx_fdt_i2c_write8(int bus, int addr, int reg, u8 val);
* @param addr i2c device address (7 bits)
* @param reg i2c 8-bit register address
*
- * @return value or error if negative
+ * Return: value or error if negative
*/
int cvmx_fdt_i2c_read8(int bus, int addr, int reg);
* @param dfa_buffers
* DFA command buffer. A relatively small (32 for example)
* number should work.
- * @return Zero on success, non-zero if out of memory
+ * Return: Zero on success, non-zero if out of memory
*/
int cvmx_helper_initialize_fpa(int packet_buffers, int work_queue_entries, int pko_buffers,
int tim_buffers, int dfa_buffers);
* @param[in] fdt_addr Pointer to FDT
* @param phandle phandle of GPIO entry
*
- * @return Pointer to op function or NULL if not found.
+ * Return: Pointer to op function or NULL if not found.
*/
cvmx_fdt_gpio_op_func_t cvmx_fdt_gpio_get_op_func(const void *fdt_addr, int phandle);
* @param phandle phandle to GPIO
* @param[out] size Number of pins (optional, may be NULL)
*
- * @return Type of GPIO device or PIN_ERROR if error
+ * Return: Type of GPIO device or PIN_ERROR if error
*/
enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, int *size);
* @param of_offset node offset of GPIO device
* @param prop_name name of property
*
- * @return pointer to GPIO handle or NULL if error
+ * Return: pointer to GPIO handle or NULL if error
*/
struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info(const void *fdt_addr, int of_offset,
const char *prop_name);
* @param of_offset node offset for property
* @param prop_name name of property
*
- * @return pointer to GPIO handle or NULL if error
+ * Return: pointer to GPIO handle or NULL if error
*/
struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, int of_offset,
const char *prop_name);
* @param flags flags set (1 = invert)
* @param[out] gpio GPIO info data structure
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_fdt_parse_gpio(const void *fdt_addr, int phandle, int pin, u32 flags,
struct cvmx_fdt_gpio_info *gpio);
*
* @param pin GPIO pin descriptor
*
- * @return 0 if low, 1 if high, -1 on error. Note that the input will be
+ * Return: 0 if low, 1 if high, -1 on error. Note that the input will be
* inverted if the CVMX_GPIO_ACTIVE_LOW flag bit is set.
*/
int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin);
* @param gpio GPIO pin descriptor
* @param value value to set it to, 0 or 1
*
- * @return 0 on success, -1 on error.
+ * Return: 0 on success, -1 on error.
*
* NOTE: If the CVMX_GPIO_ACTIVE_LOW flag is set then the output value will be
* inverted.
* @param gpio GPIO handle
* @param blink True to start blinking, false to stop
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
* NOTE: Not all GPIO types support blinking.
*/
int cvmx_fdt_gpio_set_blink(struct cvmx_fdt_gpio_info *gpio, bool blink);
* @param gpio GPIO handle
* @param blink True to start blinking, false to use link status
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
* NOTE: Not all GPIO types support this.
*/
int cvmx_fdt_gpio_set_link_blink(struct cvmx_fdt_gpio_info *gpio, bool blink);
* @param gpio GPIO assigned to LED (can be NULL)
* @param last Previous LED to build a list
*
- * @return pointer to LED data structure or NULL if out of memory
+ * Return: pointer to LED data structure or NULL if out of memory
*/
struct cvmx_fdt_gpio_led *cvmx_alloc_led(const char *name, int of_offset,
struct cvmx_fdt_gpio_info *gpio,
* @param gpio GPIO data structure to use (can be NULL)
* @param last Previous LED if this is a group of LEDs
*
- * @return Pointer to LED data structure or NULL if error
+ * Return: Pointer to LED data structure or NULL if error
*/
struct cvmx_fdt_gpio_led *cvmx_fdt_parse_led(const void *fdt_addr, int led_of_offset,
struct cvmx_fdt_gpio_info *gpio,
*
* @param xiface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_ilk_probe(int xiface);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_ilk_enable(int xiface);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_ilk_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_ilk_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
* @param data Data to shift in. Bit 0 enters the chain first, followed by
* bit 1, etc.
*
- * @return The low order bits of the JTAG chain that shifted out of the
+ * Return: The low order bits of the JTAG chain that shifted out of the
* circle.
*/
u32 cvmx_helper_qlm_jtag_shift(int qlm, int bits, u32 data);
*
* @param xiface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_loop_probe(int xiface);
int __cvmx_helper_loop_enumerate(int xiface);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_loop_enable(int xiface);
*
* @param interface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_npi_probe(int interface);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_npi_enable(int xiface);
* @param bp_thresh backpressure threshold.
* @param ena_drop enable tail drop.
* 1:enable 0:disable
- * @return Zero on success. Negative on failure
+ * Return: Zero on success. Negative on failure
*/
int cvmx_helper_setup_aura_qos(int node, int aura, bool ena_red, bool ena_drop, u64 pass_thresh,
u64 drop_thresh, bool ena_bp, u64 bp_thresh);
* @param bpid bpid to map.
* @param chl_map array of channels to map to that bpid.
* @param chl_cnt number of channel/ports to map to that bpid.
- * @return Zero on success. Negative on failure
+ * Return: Zero on success. Negative on failure
*/
int cvmx_helper_pki_map_aura_chl_bpid(int node, u16 aura, u16 bpid, u16 chl_map[], u16 chl_cnt);
* Covers the common hardware, memory and global configuration.
* Per-interface initialization is performed separately.
*
- * @return 0 on success.
+ * Return: 0 on success.
*
*/
int cvmx_helper_pko3_init_global(unsigned int node);
* Configure and initialize PKO3 for an interface
*
* @param interface is the interface number to configure
- * @return 0 on success.
+ * Return: 0 on success.
*
*/
int cvmx_helper_pko3_init_interface(int xiface);
*
* @param xiface Interface to probe
*
- * @return Number of RGMII/GMII/MII ports (0-4).
+ * Return: Number of RGMII/GMII/MII ports (0-4).
*/
int __cvmx_helper_rgmii_probe(int xiface);
*
* @param xiface PKO Interface to configure (0 or 1)
*
- * @return Zero on success
+ * Return: Zero on success
*/
int __cvmx_helper_rgmii_enable(int xiface);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_gmii_link_get(int ipd_port);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_rgmii_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_rgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
* @param enable_external
* Non zero if you want external loopback
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int __cvmx_helper_rgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external);
* @param i2c_bus i2c bus number to read from for SFP port
* @param i2c_addr i2c address to use, 0 for default
*
- * @return -1 if invalid bus or i2c read error, 0 for success
+ * Return: -1 if invalid bus or i2c read error, 0 for success
*/
int cvmx_phy_sfp_read_i2c_eeprom(u8 *buffer, int i2c_bus, int i2c_addr);
* @param[out] sfp_info Info about SFP module
* @param[in] buffer SFP EEPROM buffer to parse
*
- * @return 0 on success, -1 if error reading EEPROM or if EEPROM corrupt
+ * Return: 0 on success, -1 if error reading EEPROM or if EEPROM corrupt
*/
int cvmx_phy_sfp_parse_eeprom(struct cvmx_sfp_mod_info *sfp_info, const u8 *buffer);
*
* @param sfp sfp handle to read
*
- * @return 0 for success, -1 on error.
+ * Return: 0 for success, -1 on error.
*/
int cvmx_sfp_read_i2c_eeprom(struct cvmx_fdt_sfp_info *sfp);
*
* @param sfp sfp handle
*
- * @return sfp_info Pointer sfp mod info data structure
+ * Return: sfp_info Pointer sfp mod info data structure
*/
const struct cvmx_sfp_mod_info *cvmx_phy_get_sfp_mod_info(const struct cvmx_fdt_sfp_info *sfp);
* @param sfp Handle to SFP information.
* @param data User-defined data passed to the function
*
- * @return 0 if absent, 1 if present, -1 on error
+ * Return: 0 if absent, 1 if present, -1 on error
*/
int cvmx_sfp_check_mod_abs(struct cvmx_fdt_sfp_info *sfp, void *data);
* @param check_mod_abs Function to be called or NULL to remove
* @param mod_abs_data User-defined data to be passed to check_mod_abs
*
- * @return 0 for success
+ * Return: 0 for success
*/
int cvmx_sfp_register_check_mod_abs(struct cvmx_fdt_sfp_info *sfp,
int (*check_mod_abs)(struct cvmx_fdt_sfp_info *sfp, void *data),
* @param mod_abs_changed_data User-defined data passed to
* mod_abs_changed
*
- * @return 0 for success
+ * Return: 0 for success
*/
int cvmx_sfp_register_mod_abs_changed(struct cvmx_fdt_sfp_info *sfp,
int (*mod_abs_changed)(struct cvmx_fdt_sfp_info *sfp, int val,
* @param sfp Handle to SFP information.
* @param data User-defined data passed to the function
*
- * @return 0 if signal present, 1 if signal absent, -1 on error
+ * Return: 0 if signal present, 1 if signal absent, -1 on error
*/
int cvmx_sfp_check_tx_fault(struct cvmx_fdt_sfp_info *sfp, void *data);
* @param sfp Handle to SFP information.
* @param data User-defined data passed to the function
*
- * @return 0 if signal present, 1 if signal absent, -1 on error
+ * Return: 0 if signal present, 1 if signal absent, -1 on error
*/
int cvmx_sfp_check_rx_los(struct cvmx_fdt_sfp_info *sfp, void *data);
* @param rx_los_changed_data User-defined data passed to
* rx_los_changed
*
- * @return 0 for success
+ * Return: 0 for success
*/
int cvmx_sfp_register_rx_los_changed(struct cvmx_fdt_sfp_info *sfp,
int (*rx_los_changed)(struct cvmx_fdt_sfp_info *sfp, int val,
*
* @param fdt_addr Address of flat device-tree
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_sfp_parse_device_tree(const void *fdt_addr);
*
* @param ipd_port IPD port number to search for
*
- * @return pointer to SFP data structure or NULL if not found
+ * Return: pointer to SFP data structure or NULL if not found
*/
struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_port(int ipd_port);
*
* @param of_offset flat device tree node offset
*
- * @return pointer to SFP data structure or NULL if not found
+ * Return: pointer to SFP data structure or NULL if not found
*/
struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_fdt_node(int of_offset);
/**
* Reads the EEPROMs of all SFP modules.
*
- * @return 0 for success
+ * Return: 0 for success
*/
int cvmx_sfp_read_all_modules(void);
* @param[in] sfp SFP port to check
* @param mode interface mode
*
- * @return true if module is valid, false if invalid
+ * Return: true if module is valid, false if invalid
* NOTE: This will also toggle the error LED, if present
*/
bool cvmx_sfp_validate_module(struct cvmx_fdt_sfp_info *sfp, int mode);
*
* @param xiface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_sgmii_probe(int xiface);
int __cvmx_helper_sgmii_enumerate(int xiface);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_sgmii_enable(int xiface);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_sgmii_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_sgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
* @param enable_external
* Non zero if you want external loopback
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int __cvmx_helper_sgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external);
*
* @param interface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_spi_probe(int interface);
int __cvmx_helper_spi_enumerate(int interface);
*
* @param interface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_spi_enable(int interface);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
*
* @param xiface Interface to convert
*
- * @return Srio link number
+ * Return: Srio link number
*/
int __cvmx_helper_srio_port(int xiface);
*
* @param xiface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_srio_probe(int xiface);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_srio_enable(int xiface);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_srio_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_srio_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
*
* @param xiface interface with node information
*
- * @return struct that contains node and interface number.
+ * Return: struct that contains node and interface number.
*/
static inline struct cvmx_xiface cvmx_helper_xiface_to_node_interface(int xiface)
{
*
* @param mode Mode to convert
*
- * @return String
+ * Return: String
*/
const char *cvmx_helper_interface_mode_to_string(cvmx_helper_interface_mode_t mode);
/**
* Get the version of the CVMX libraries.
*
- * @return Version string. Note this buffer is allocated statically
+ * Return: Version string. Note this buffer is allocated statically
* and will be shared by all callers.
*/
const char *cvmx_helper_get_version(void);
* @param xiface Interface to configure
* @param num_ports Number of ports on the interface
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_setup_gmx(int xiface, int num_ports);
*
* @param interface
*
- * @return the number of pko_ports on the interface.
+ * Return: the number of pko_ports on the interface.
*/
int __cvmx_helper_get_num_pko_ports(int interface);
* @param interface Interface to use
* @param port Port on the interface
*
- * @return IPD port number
+ * Return: IPD port number
*/
int cvmx_helper_get_ipd_port(int interface, int port);
* @param interface Interface to use
* @param port Port on the interface
*
- * @return PKO port number and -1 on error.
+ * Return: PKO port number and -1 on error.
*/
int cvmx_helper_get_pko_port(int interface, int port);
*
* @param interface Interface to use
*
- * @return IPD/PKO port number
+ * Return: IPD/PKO port number
*/
static inline int cvmx_helper_get_first_ipd_port(int interface)
{
*
* @param interface Interface to use
*
- * @return IPD/PKO port number
+ * Return: IPD/PKO port number
*
* Note: for o68, the last ipd port on an interface does not always equal to
* the first plus the number of ports as the ipd ports are not contiguous in
*
* @param ipd_port IPD/PKO port number
*
- * @return Interface number
+ * Return: Interface number
*/
int cvmx_helper_get_interface_num(int ipd_port);
*
* @param ipd_port IPD/PKO port number
*
- * @return Interface index number
+ * Return: Interface index number
*/
int cvmx_helper_get_interface_index_num(int ipd_port);
* @param xiface Interface
* @param index index of the port in the interface
*
- * @return port kind on sucicess and -1 on failure
+ * Return: port kind on sucicess and -1 on failure
*/
int cvmx_helper_get_pknd(int xiface, int index);
* @param interface Interface
* @param port index of the port in the interface
*
- * @return port kind on sucicess and -1 on failure
+ * Return: port kind on sucicess and -1 on failure
*/
int cvmx_helper_get_bpid(int interface, int port);
*
* @param xiface Interface to probe
*
- * @return Number of ports on the interface. Zero to disable.
+ * Return: Number of ports on the interface. Zero to disable.
*/
int __cvmx_helper_xaui_probe(int xiface);
int __cvmx_helper_xaui_enumerate(int xiface);
*
* @param xiface Interface to bring up
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_xaui_enable(int xiface);
*
* @param interface Interface to retrain
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_xaui_link_retrain(int interface);
*
* @param interface Interface to reinitialize
*
- * @return 0 on success, negative on failure
+ * Return: 0 on success, negative on failure
*/
int cvmx_helper_xaui_link_reinit(int interface);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t __cvmx_helper_xaui_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_xaui_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
* @param enable_external
* Non zero if you want external loopback
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int __cvmx_helper_xaui_configure_loopback(int ipd_port, int enable_internal, int enable_external);
* IPD configuration changes are made if CVMX_HELPER_ENABLE_IPD
* is not set in the executive-config.h file.
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
int cvmx_helper_ipd_and_packet_input_enable_node(int node);
* @param wqe_entries The maximum number of work queue entries to be
* supported.
*
- * @return Zero on success, non-zero on failure.
+ * Return: Zero on success, non-zero on failure.
*/
int cvmx_helper_initialize_sso(int wqe_entries);
* @param wqe_entries The maximum number of work queue entries to be
* supported.
*
- * @return Zero on success, non-zero on failure.
+ * Return: Zero on success, non-zero on failure.
*/
int cvmx_helper_initialize_sso_node(unsigned int node, int wqe_entries);
/**
* Undo the effect of cvmx_helper_initialize_sso().
*
- * @return Zero on success, non-zero on failure.
+ * Return: Zero on success, non-zero on failure.
*/
int cvmx_helper_uninitialize_sso(void);
*
* @param node Node SSO to initialize
*
- * @return Zero on success, non-zero on failure.
+ * Return: Zero on success, non-zero on failure.
*/
int cvmx_helper_uninitialize_sso_node(unsigned int node);
* on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower
* priority than the previous.
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_initialize_packet_io_global(void);
/**
*
* @param node Node on which to initialize packet io hardware
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_initialize_packet_io_node(unsigned int node);
/**
* Does core local initialization for packet io
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_initialize_packet_io_local(void);
* buffers used by the packet IO hardware to the FPA so a function emptying the
* FPA after shutdown should find all packet buffers in the FPA.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_helper_shutdown_packet_io_global(void);
/**
* Does core local shutdown of packet io
*
- * @return Zero on success, non-zero on failure
+ * Return: Zero on success, non-zero on failure
*/
int cvmx_helper_shutdown_packet_io_local(void);
*
* @param interface Which interface to return port count for.
*
- * @return Port count for interface
+ * Return: Port count for interface
* -1 for uninitialized interface
*/
int cvmx_helper_ports_on_interface(int interface);
* but the CNX0XX and CNX1XX are exceptions. These only support
* one interface.
*
- * @return Number of interfaces on chip
+ * Return: Number of interfaces on chip
*/
int cvmx_helper_get_number_of_interfaces(void);
*
* @param xiface Interface to probe
*
- * @return Mode of the interface. Unknown or unsupported interfaces return
+ * Return: Mode of the interface. Unknown or unsupported interfaces return
* DISABLED.
*/
cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface);
*
* @param ipd_port IPD/PKO port to auto configure
*
- * @return Link state after configure
+ * Return: Link state after configure
*/
cvmx_helper_link_info_t cvmx_helper_link_autoconf(int ipd_port);
*
* @param ipd_port IPD/PKO port to query
*
- * @return Link state
+ * Return: Link state
*/
cvmx_helper_link_info_t cvmx_helper_link_get(int ipd_port);
* @param ipd_port IPD/PKO port to configure
* @param link_info The new link state
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
*
* @param xiface Interface to probe
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_interface_probe(int xiface);
*
* @param xiface Interface to enumerate
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_helper_interface_enumerate(int xiface);
* @param enable_external
* Non zero if you want external loopback
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int cvmx_helper_configure_loopback(int ipd_port, int enable_internal, int enable_external);
*
* @param interface Which interface to return port count for.
*
- * @return Port count for interface
+ * Return: Port count for interface
* -1 for uninitialized interface
*/
int __cvmx_helper_early_ports_on_interface(int interface);
*
* @param xiface
*
- * @return the number of ipd_ports on the interface and -1 for error.
+ * Return: the number of ipd_ports on the interface and -1 for error.
*/
int __cvmx_helper_get_num_ipd_ports(int xiface);
* @param pad The padding that PKO should apply.
* interface.
*
- * @return 0 for success and -1 for failure
+ * Return: 0 for success and -1 for failure
*/
int __cvmx_helper_init_interface(int xiface, int num_ipd_ports, int has_fcs,
enum cvmx_pko_padding pad);
* hardware ports. PKO should still be disabled to make sure packets
* aren't sent out partially setup hardware.
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int __cvmx_helper_packet_hardware_enable(int xiface);
/*
* @INTERNAL
*
- * @return 0 for success and -1 for failure
+ * Return: 0 for success and -1 for failure
*/
int __cvmx_helper_set_link_info(int xiface, int index, cvmx_helper_link_info_t link_info);
* @param xiface
* @param port
*
- * @return valid link_info on success or -1 on failure
+ * Return: valid link_info on success or -1 on failure
*/
cvmx_helper_link_info_t __cvmx_helper_get_link_info(int xiface, int port);
*
* @param xiface
*
- * @return 0 if PKO does not do FCS and 1 otherwise.
+ * Return: 0 if PKO does not do FCS and 1 otherwise.
*/
int __cvmx_helper_get_has_fcs(int xiface);
* Initialize QoS configuraiton with the SDK defaults.
*
* @param qos_cfg User QOS configuration parameters.
- * @return Zero on success, negative number otherwise.
+ * Return: Zero on success, negative number otherwise.
*/
int cvmx_helper_qos_config_init(cvmx_qos_proto_t qos_proto, cvmx_qos_config_t *qos_cfg);
*
* @param xipdport Global IPD port
* @param qos_cfg User QOS configuration parameters.
- * @return Zero on success, negative number otherwise.
+ * Return: Zero on success, negative number otherwise.
*/
int cvmx_helper_qos_port_config_update(int xipdport, cvmx_qos_config_t *qos_cfg);
*
* @param xipdport Global IPD port
* @param qos_cfg User QOS configuration parameters.
- * @return Zero on success, negative number otherwise.
+ * Return: Zero on success, negative number otherwise.
*/
int cvmx_helper_qos_port_setup(int xipdport, cvmx_qos_config_t *qos_cfg);
*
* @param node OCTEON3 node number.
* @param qos_cfg User QOS configuration parameters.
- * @return Zero on success, negative number otherwise.
+ * Return: Zero on success, negative number otherwise.
*/
int cvmx_helper_qos_sso_setup(int node, cvmx_qos_config_t *qos_cfg);
* @param chan Channel index.
* @param namebuf Name buffer (output).
* @param buflen Name maximum length.
- * @return Length of name (in bytes) on success, negative number otherwise.
+ * Return: Length of name (in bytes) on success, negative number otherwise.
*/
int cvmx_helper_get_chan_e_name(int chan, char *namebuf, int buflen);
* - Step by 2 for 16 bit access.
* - Step by 4 for 32 bit access.
* - Step by 8 for 64 bit access.
- * @return Address to store for atomic update
+ * Return: Address to store for atomic update
*/
static inline u64 __cvmx_hwfau_store_address(u64 noadd, u64 reg)
{
* @param value Signed value to add.
* Note: When performing 32 and 64 bit access, only the low
* 22 bits are available.
- * @return Address to read from for atomic update
+ * Return: Address to read from for atomic update
*/
static inline u64 __cvmx_hwfau_atomic_address(u64 tagwait, u64 reg, s64 value)
{
* - Step by 8 for 64 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return Value of the register before the update
+ * Return: Value of the register before the update
*/
static inline s64 cvmx_hwfau_fetch_and_add64(cvmx_fau_reg64_t reg, s64 value)
{
* - Step by 4 for 32 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return Value of the register before the update
+ * Return: Value of the register before the update
*/
static inline s32 cvmx_hwfau_fetch_and_add32(cvmx_fau_reg32_t reg, s32 value)
{
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* - Step by 2 for 16 bit access.
* @param value Signed value to add.
- * @return Value of the register before the update
+ * Return: Value of the register before the update
*/
static inline s16 cvmx_hwfau_fetch_and_add16(cvmx_fau_reg16_t reg, s16 value)
{
*
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* @param value Signed value to add.
- * @return Value of the register before the update
+ * Return: Value of the register before the update
*/
static inline int8_t cvmx_hwfau_fetch_and_add8(cvmx_fau_reg8_t reg, int8_t value)
{
* - Step by 8 for 64 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return If a timeout occurs, the error bit will be set. Otherwise
+ * Return: If a timeout occurs, the error bit will be set. Otherwise
* the value of the register before the update will be
* returned
*/
* - Step by 4 for 32 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return If a timeout occurs, the error bit will be set. Otherwise
+ * Return: If a timeout occurs, the error bit will be set. Otherwise
* the value of the register before the update will be
* returned
*/
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* - Step by 2 for 16 bit access.
* @param value Signed value to add.
- * @return If a timeout occurs, the error bit will be set. Otherwise
+ * Return: If a timeout occurs, the error bit will be set. Otherwise
* the value of the register before the update will be
* returned
*/
*
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* @param value Signed value to add.
- * @return If a timeout occurs, the error bit will be set. Otherwise
+ * Return: If a timeout occurs, the error bit will be set. Otherwise
* the value of the register before the update will be
* returned
*/
* - Step by 2 for 16 bit access.
* - Step by 4 for 32 bit access.
* - Step by 8 for 64 bit access.
- * @return Data to write using cvmx_send_single
+ * Return: Data to write using cvmx_send_single
*/
static inline u64 __cvmx_fau_iobdma_data(u64 scraddr, s64 value, u64 tagwait,
cvmx_fau_op_size_t size, u64 reg)
* - Step by 8 for 64 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_t reg, s64 value)
{
* - Step by 4 for 32 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_t reg, s32 value)
{
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* - Step by 2 for 16 bit access.
* @param value Signed value to add.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_t reg, s16 value)
{
* Must be 8 byte aligned.
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* @param value Signed value to add.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t reg, int8_t value)
{
* - Step by 8 for 64 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_tagwait_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_t reg,
s64 value)
* - Step by 4 for 32 bit access.
* @param value Signed value to add.
* Note: Only the low 22 bits are available.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_tagwait_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_t reg,
s32 value)
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* - Step by 2 for 16 bit access.
* @param value Signed value to add.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_tagwait_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_t reg,
s16 value)
* returned
* @param reg FAU atomic register to access. 0 <= reg < 2048.
* @param value Signed value to add.
- * @return Placed in the scratch pad register
+ * Return: Placed in the scratch pad register
*/
static inline void cvmx_hwfau_async_tagwait_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t reg,
int8_t value)
}
/** Allocates 64bit FAU register.
- * @return value is the base address of allocated FAU register
+ * Return: value is the base address of allocated FAU register
*/
int cvmx_fau64_alloc(int reserve);
/** Allocates 32bit FAU register.
- * @return value is the base address of allocated FAU register
+ * Return: value is the base address of allocated FAU register
*/
int cvmx_fau32_alloc(int reserve);
/** Allocates 16bit FAU register.
- * @return value is the base address of allocated FAU register
+ * Return: value is the base address of allocated FAU register
*/
int cvmx_fau16_alloc(int reserve);
/** Allocates 8bit FAU register.
- * @return value is the base address of allocated FAU register
+ * Return: value is the base address of allocated FAU register
*/
int cvmx_fau8_alloc(int reserve);
/** Frees the specified FAU register.
* @param address Base address of register to release.
- * @return 0 on success; -1 on failure
+ * Return: 0 on success; -1 on failure
*/
int cvmx_fau_free(int address);
* @param use_locking
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
*
- * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
+ * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
*/
static inline cvmx_pko_return_value_t
cvmx_hwpko_send_packet_finish(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t pko_command,
* @param use_locking
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
*
- * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
+ * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
*/
static inline cvmx_pko_return_value_t
cvmx_hwpko_send_packet_finish3(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t pko_command,
* for the port.
*
* @param port IPD port number
- * @return Base output queue
+ * Return: Base output queue
*/
int cvmx_pko_get_base_queue(int port);
* For a given port number, return the number of pko output queues.
*
* @param port IPD port number
- * @return Number of output queues
+ * Return: Number of output queues
*/
int cvmx_pko_get_num_queues(int port);
* @param burst Maximum number of packets to burst in a row before rate
* limiting cuts in.
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_pko_rate_limit_packets(int port, int packets_s, int burst);
* @param burst Maximum number of bits to burst before rate
* limiting cuts in.
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_pko_rate_limit_bits(int port, u64 bits_s, int burst);
* @param interface
* @param index
*
- * @return negative on error.
+ * Return: negative on error.
*
* This applies only to the non-loopback interfaces.
*
* for the port.
*
* @param pko_port PKO port number
- * @return Base output queue
+ * Return: Base output queue
*/
int cvmx_pko_get_base_queue_pkoid(int pko_port);
* for the port.
*
* @param pko_port PKO port number
- * @return the number of output queues
+ * Return: the number of output queues
*/
int cvmx_pko_get_num_queues_pkoid(int pko_port);
* @param use_locking
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
*
- * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
+ * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
*/
static inline cvmx_pko_return_value_t
cvmx_hwpko_send_packet_finish_pkoid(int pko_port, u64 queue, cvmx_pko_command_word0_t pko_command,
* @param use_locking
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
*
- * @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
+ * Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
*/
static inline cvmx_pko_return_value_t
cvmx_hwpko_send_packet_finish3_pkoid(u64 pko_port, u64 queue, cvmx_pko_command_word0_t pko_command,
* Obtain the number of PKO commands pending in a queue
*
* @param queue is the queue identifier to be queried
- * @return the number of commands pending transmission or -1 on error
+ * Return: the number of commands pending transmission or -1 on error
*/
int cvmx_pko_queue_pend_count(cvmx_cmd_queue_id_t queue);
* @param drop_thresh
* All incoming packets will be dropped when there are less
* than this many free packet buffers in FPA 0.
- * @return Zero on success. Negative on failure
+ * Return: Zero on success. Negative on failure
*/
int cvmx_ipd_setup_red_queue(int queue, int pass_thresh, int drop_thresh);
* @param drop_thresh
* All incoming packets will be dropped when there are less
* than this many free packet buffers in FPA 0.
- * @return Zero on success. Negative on failure
+ * Return: Zero on success. Negative on failure
*/
int cvmx_ipd_setup_red(int pass_thresh, int drop_thresh);
*
* @param pcie_port PCIe port the IO is for
*
- * @return 64bit Octeon IO base address for read/write
+ * Return: 64bit Octeon IO base address for read/write
*/
u64 cvmx_pcie_get_io_base_address(int pcie_port);
*
* @param pcie_port PCIe port the IO is for
*
- * @return Size of the IO window
+ * Return: Size of the IO window
*/
u64 cvmx_pcie_get_io_size(int pcie_port);
*
* @param pcie_port PCIe port the IO is for
*
- * @return 64bit Octeon IO base address for read/write
+ * Return: 64bit Octeon IO base address for read/write
*/
u64 cvmx_pcie_get_mem_base_address(int pcie_port);
*
* @param pcie_port PCIe port the IO is for
*
- * @return Size of the Mem window
+ * Return: Size of the Mem window
*/
u64 cvmx_pcie_get_mem_size(int pcie_port);
*
* @param pcie_port PCIe port to initialize
*
- * @return Zero on success
+ * Return: Zero on success
*/
int cvmx_pcie_rc_initialize(int pcie_port);
*
* @param pcie_port PCIe port to shutdown
*
- * @return Zero on success
+ * Return: Zero on success
*/
int cvmx_pcie_rc_shutdown(int pcie_port);
* @param fn Device sub function
* @param reg Register to access
*
- * @return Result of the read
+ * Return: Result of the read
*/
u8 cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg);
* @param fn Device sub function
* @param reg Register to access
*
- * @return Result of the read
+ * Return: Result of the read
*/
u16 cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg);
* @param fn Device sub function
* @param reg Register to access
*
- * @return Result of the read
+ * Return: Result of the read
*/
u32 cvmx_pcie_config_read32(int pcie_port, int bus, int dev, int fn, int reg);
* @param pcie_port PCIe port to read from
* @param cfg_offset Address to read
*
- * @return Value read
+ * Return: Value read
*/
u32 cvmx_pcie_cfgx_read(int pcie_port, u32 cfg_offset);
u32 cvmx_pcie_cfgx_read_node(int node, int pcie_port, u32 cfg_offset);
* Read a 32bit value from the Octeon NPEI register space
*
* @param address Address to read
- * @return The result
+ * Return: The result
*/
static inline u32 cvmx_pcie_npei_read32(u64 address)
{
*
* @param pcie_port PCIe port to initialize
*
- * @return Zero on success
+ * Return: Zero on success
*/
int cvmx_pcie_ep_initialize(int pcie_port);
*
* @param pcie_port PCIe port number (PEM number)
*
- * @return 0 if PCIe port is in target mode, !0 if in host mode.
+ * Return: 0 if PCIe port is in target mode, !0 if in host mode.
*/
int cvmx_pcie_is_host_mode(int pcie_port);
/**
* Get the entry for the Bit Select Extractor Table.
* @param work pointer to work queue entry
- * @return Index of the Bit Select Extractor Table
+ * Return: Index of the Bit Select Extractor Table
*/
static inline int cvmx_pip_get_bsel_table_index(cvmx_wqe_t *work)
{
* @param style style to allocate, if -1 it will be allocated
first available style from style resource. If index is positive
number and in range, it will try to allocate specified style.
- * @return style number on success, -1 on failure.
+ * Return: style number on success, -1 on failure.
*/
int cvmx_pki_style_alloc(int node, int style);
* @param node node to allocate cluster group from.
@param cl_grp cluster group to allocate/reserve, if -1 ,
allocate any available cluster group.
- * @return cluster group number or -1 on failure
+ * Return: cluster group number or -1 on failure
*/
int cvmx_pki_cluster_grp_alloc(int node, int cl_grp);
allocate any available pcam entry.
* @param bank pcam bank where to allocate/reserve pcan entry from
* @param cluster_mask mask of clusters from which pcam entry is needed.
- * @return pcam entry of -1 on failure
+ * Return: pcam entry of -1 on failure
*/
int cvmx_pki_pcam_entry_alloc(int node, int index, int bank, u64 cluster_mask);
number and in range, it will try to allocate specified base_offset.
@param count number of consecutive qpg entries to allocate. They will be consecutive
from base offset.
- * @return qpg table base offset number on success, -1 on failure.
+ * Return: qpg table base offset number on success, -1 on failure.
*/
int cvmx_pki_qpg_entry_alloc(int node, int base_offset, int count);
* This function frees a style from pool of global styles per node.
* @param node node to free style from.
* @param style style to free
- * @return 0 on success, -1 on failure.
+ * Return: 0 on success, -1 on failure.
*/
int cvmx_pki_style_free(int node, int style);
cluster group resources.
* @param node node to free cluster group from.
@param cl_grp cluster group to free
- * @return 0 on success or -1 on failure
+ * Return: 0 on success or -1 on failure
*/
int cvmx_pki_cluster_grp_free(int node, int cl_grp);
* number and in range, it will try to allocate specified base_offset.
* @param count number of consecutive qpg entries to allocate. They will be consecutive
* from base offset.
- * @return qpg table base offset number on success, -1 on failure.
+ * Return: qpg table base offset number on success, -1 on failure.
*/
int cvmx_pki_qpg_entry_free(int node, int base_offset, int count);
clusters resources.
* @param node node to free clusters from.
* @param cluster_mask mask of clusters need freeing
- * @return 0 on success or -1 on failure
+ * Return: 0 on success or -1 on failure
*/
int cvmx_pki_cluster_free(int node, u64 cluster_mask);
@param index index of pacm entry (0-191) needs to be freed.
* @param bank pcam bank where to free pcam entry from
* @param cluster_mask mask of clusters from which pcam entry is freed.
- * @return 0 on success OR -1 on failure
+ * Return: 0 on success OR -1 on failure
*/
int cvmx_pki_pcam_entry_free(int node, int index, int bank, u64 cluster_mask);
* @param bpid bpid to allocate, if -1 it will be allocated
* first available boid from bpid resource. If index is positive
* number and in range, it will try to allocate specified bpid.
- * @return bpid number on success,
+ * Return: bpid number on success,
* -1 on alloc failure.
* -2 on resource already reserved.
*/
* This function frees a bpid from pool of global bpid per node.
* @param node node to free bpid from.
* @param bpid bpid to free
- * @return 0 on success, -1 on failure or
+ * Return: 0 on success, -1 on failure or
*/
int cvmx_pki_bpid_free(int node, int bpid);
* This function allocates/reserves an index from pool of global MTAG-IDX per node.
* @param node node to allocate index from.
* @param idx index to allocate, if -1 it will be allocated
- * @return MTAG index number on success,
+ * Return: MTAG index number on success,
* -1 on alloc failure.
* -2 on resource already reserved.
*/
* This function frees an index from pool of global MTAG-IDX per node.
* @param node node to free bpid from.
* @param bpid bpid to free
- * @return 0 on success, -1 on failure or
+ * Return: 0 on success, -1 on failure or
*/
int cvmx_pki_mtag_idx_free(int node, int idx);
* are requested.
* @param count the number of internal ports requested
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
int cvmx_pko_internal_ports_alloc(int interface, int port, u64 count);
* @param port the index of the port within in the interface for which the internal ports
* are requested.
*
- * @return 0 on success
+ * Return: 0 on success
* -1 on failure
*/
int cvmx_pko_internal_ports_free(int interface, int port);
* The channel assignment applies to L2 or L3 Shaper Queues depending
* on the setting of channel credit level.
*
- * @return returns none.
+ * Return: returns none.
*/
void cvmx_pko3_map_channel(unsigned int node, unsigned int pq_num, unsigned int l2_l3_q_num,
u16 channel);
* If a tag switch is pending this routine returns the tag before
* the tag switch, not after.
*
- * @return Current tag
+ * Return: Current tag
*/
static inline cvmx_pow_tag_info_t cvmx_pow_get_current_tag(void)
{
* Get the POW WQE for this core. This returns the work queue
* entry currently associated with this core.
*
- * @return WQE pointer
+ * Return: WQE pointer
*/
static inline cvmx_wqe_t *cvmx_pow_get_current_wqp(void)
{
* @param wait When set, call stalls until work becomes available, or
* times out. If not set, returns immediately.
*
- * @return Returns the WQE pointer from POW. Returns NULL if no work was
+ * Return: Returns the WQE pointer from POW. Returns NULL if no work was
* available.
*/
static inline cvmx_wqe_t *cvmx_pow_work_request_sync_nocheck(cvmx_pow_wait_t wait)
* @param wait When set, call stalls until work becomes available, or
* times out. If not set, returns immediately.
*
- * @return Returns the WQE pointer from POW. Returns NULL if no work was
+ * Return: Returns the WQE pointer from POW. Returns NULL if no work was
* available.
*/
static inline cvmx_wqe_t *cvmx_pow_work_request_sync(cvmx_pow_wait_t wait)
* This function waits for any previous tag switch to complete before
* requesting the null_rd.
*
- * @return Returns the POW state of type cvmx_pow_tag_type_t.
+ * Return: Returns the POW state of type cvmx_pow_tag_type_t.
*/
static inline cvmx_pow_tag_type_t cvmx_pow_work_request_null_rd(void)
{
*
* @param scr_addr Scratch memory address to get result from
* Byte address, must be 8 byte aligned.
- * @return Returns the WQE from the scratch register, or NULL if no work was
+ * Return: Returns the WQE from the scratch register, or NULL if no work was
* available.
*/
static inline cvmx_wqe_t *cvmx_pow_work_response_async(int scr_addr)
*
* @param wqe_ptr pointer to a work queue entry returned by the POW
*
- * @return 0 if pointer is valid
+ * Return: 0 if pointer is valid
* 1 if invalid (no work was returned)
*/
static inline u64 cvmx_pow_work_invalid(cvmx_wqe_t *wqe_ptr)
* indicates which groups each core will accept work from.
*
* @param core_num core to apply mask to
- * @return Group mask, one bit for up to 64 groups.
+ * Return: Group mask, one bit for up to 64 groups.
* Each 1 bit in the mask enables the core to accept work from
* the corresponding group.
* The CN68XX supports 64 groups, earlier models only support
* @param wait When set, call stalls until work becomes available, or times out.
* If not set, returns immediately.
*
- * @return Returns the WQE pointer from SSO.
+ * Return: Returns the WQE pointer from SSO.
* Returns NULL if no work was available.
*/
static inline void *cvmx_sso_work_request_grp_sync_nocheck(unsigned int lgrp, cvmx_pow_wait_t wait)
* @param wait When set, call stalls until work becomes available, or times out.
* If not set, returns immediately.
*
- * @return The WQE pointer or NULL, if work is not available.
+ * Return: The WQE pointer or NULL, if work is not available.
*/
static inline void *cvmx_sso_work_request_grp_sync(unsigned int lgrp, cvmx_pow_wait_t wait)
{
* @param hw_bits The lower bits (number depends on configuration) are set
* to this value. The remainder of bits are set by the sw_bits parameter.
*
- * @return 32 bit value of the combined hw and sw bits.
+ * Return: 32 bit value of the combined hw and sw bits.
*/
static inline u32 cvmx_pow_tag_compose(u64 sw_bits, u64 hw_bits)
{
*
* @param tag 32 bit tag value
*
- * @return N bit software tag value, where N is configurable with
+ * Return: N bit software tag value, where N is configurable with
* the CVMX_TAG_SW_BITS define
*/
static inline u32 cvmx_pow_tag_get_sw_bits(u64 tag)
*
* @param tag 32 bit tag value
*
- * @return (32 - N) bit software tag value, where N is configurable with
+ * Return: (32 - N) bit software tag value, where N is configurable with
* the CVMX_TAG_SW_BITS define
*/
static inline u32 cvmx_pow_tag_get_hw_bits(u64 tag)
* @param buffer Buffer to store capture into
* @param buffer_size The size of the supplied buffer
*
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int cvmx_pow_capture(void *buffer, int buffer_size);
/**
* Return the number of POW entries supported by this chip
*
- * @return Number of POW entries
+ * Return: Number of POW entries
*/
int cvmx_pow_get_num_entries(void);
int cvmx_pow_get_dump_size(void);
* @param node The numa node for the allocation.
* @param base_group Pointer to the initial group, -1 to allocate anywhere.
* @param count The number of consecutive groups to allocate.
- * @return 0 on success and -1 on failure.
+ * Return: 0 on success and -1 on failure.
*/
int cvmx_sso_reserve_group_range(int node, int *base_group, int count);
#define cvmx_sso_allocate_group_range cvmx_sso_reserve_group_range
/**
* Return the number of QLMs supported by the chip
*
- * @return Number of QLMs
+ * Return: Number of QLMs
*/
int cvmx_qlm_get_num(void);
* @param xiface interface to look up
* @param index index in an interface
*
- * @return the qlm number based on the xiface
+ * Return: the qlm number based on the xiface
*/
int cvmx_qlm_lmac(int xiface, int index);
*
* @param BGX BGX to search for.
*
- * @return muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
+ * Return: muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
*/
int cvmx_qlm_mux_interface(int bgx);
*
* @param qlm QLM block to query
*
- * @return Number of lanes
+ * Return: Number of lanes
*/
int cvmx_qlm_get_lanes(int qlm);
/**
* Get the QLM JTAG fields based on Octeon model on the supported chips.
*
- * @return qlm_jtag_field_t structure
+ * Return: qlm_jtag_field_t structure
*/
const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void);
* Get the QLM JTAG length by going through qlm_jtag_field for each
* Octeon model that is supported
*
- * @return return the length.
+ * Return: return the length.
*/
int cvmx_qlm_jtag_get_length(void);
* @param lane Lane in QLM to get
* @param name String name of field
*
- * @return JTAG field value
+ * Return: JTAG field value
*/
u64 cvmx_qlm_jtag_get(int qlm, int lane, const char *name);
*
* @param qlm QLM to examine
*
- * @return Speed in Mhz
+ * Return: Speed in Mhz
*/
int cvmx_qlm_get_gbaud_mhz(int qlm);
/**
* @param node Target QLM node
* @param qlm QLM to examine
*
- * @return Speed in Mhz
+ * Return: Speed in Mhz
*/
int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm);
* @param node node to measure
* @param qlm QLM to measure
*
- * @return Clock rate in Hz
+ * Return: Clock rate in Hz
*/
int cvmx_qlm_measure_clock_node(int node, int qlm);
* @param qlm QLM to perform RX equalization on
* @param lane Lane to use, or -1 for all lanes
*
- * @return Zero on success, negative if any lane failed RX equalization
+ * Return: Zero on success, negative if any lane failed RX equalization
*/
int __cvmx_qlm_rx_equalization(int node, int qlm, int lane);
*
* @param major_did 5 bit major did
* @param sub_did 3 bit sub did
- * @return I/O base address
+ * Return: I/O base address
*/
static inline u64 cvmx_build_io_address(u64 major_did, u64 sub_did)
{
* Builds a bit mask given the required size in bits.
*
* @param bits Number of bits in the mask
- * @return The mask
+ * Return: The mask
*/
static inline u64 cvmx_build_mask(u64 bits)
{
* @param lsb Starting bit, least significant (0-63)
* @param width Width in bits (1-64)
*
- * @return Extracted number
+ * Return: Extracted number
*/
static inline u64 cvmx_bit_extract(u64 input, int lsb, int width)
{
* @param high_bit Highest bit value can occupy (inclusive) 0-63
* @param low_bit Lowest bit value can occupy inclusive 0-high_bit
* @param value Value to use
- * @return Value masked and shifted
+ * Return: Value masked and shifted
*/
static inline u64 cvmx_build_bits(u64 high_bit, u64 low_bit, u64 value)
{
/**
* Number of the Core on which the program is currently running.
*
- * @return core number
+ * Return: core number
*/
static inline unsigned int cvmx_get_core_num(void)
{
/**
* Node-local number of the core on which the program is currently running.
*
- * @return core number on local node
+ * Return: core number on local node
*/
static inline unsigned int cvmx_get_local_core_num(void)
{
*
* @param val 32 bit value to count set bits in
*
- * @return Number of bits set
+ * Return: Number of bits set
*/
static inline u32 cvmx_pop(u32 val)
{
*
* @param address byte address to read from
*
- * @return value read
+ * Return: value read
*/
static inline u8 cvmx_scratch_read8(u64 address)
{
*
* @param address byte address to read from
*
- * @return value read
+ * Return: value read
*/
static inline u16 cvmx_scratch_read16(u64 address)
{
*
* @param address byte address to read from
*
- * @return value read
+ * Return: value read
*/
static inline u32 cvmx_scratch_read32(u64 address)
{
*
* @param address byte address to read from
*
- * @return value read
+ * Return: value read
*/
static inline u64 cvmx_scratch_read64(u64 address)
{
*
* @param work pointer to work queue entry
*
- * @return 0 if packet had no error, non-zero to indicate error code.
+ * Return: 0 if packet had no error, non-zero to indicate error code.
*
* Please refer to HRM for the specific model for full enumaration of error codes.
* With Octeon1/Octeon2 models, the returned code indicates L1/L2 errors.
* For older chips if PIP_GBL_CTL was proviosned to flag ip4_otions and
* ipv6 extension, it will be flag them.
* @param work pointer to work queue entry
- * @return 1 -- If IP error was found in packet
+ * Return: 1 -- If IP error was found in packet
* 0 -- If no IP error was found in packet.
*/
static inline int cvmx_wqe_is_ip_exception(cvmx_wqe_t *work)
/**
* Set the buffer segment count for a packet.
*
- * @return Returns the actual resulting value in the WQE fielda
+ * Return: Returns the actual resulting value in the WQE fielda
*
*/
static inline unsigned int cvmx_wqe_set_bufs(cvmx_wqe_t *work, unsigned int bufs)
* Get the offset of Layer-3 header,
* only supported when Layer-3 protocol is IPv4 or IPv6.
*
- * @return Returns the offset, or 0 if the offset is not known or unsupported.
+ * Return: Returns the offset, or 0 if the offset is not known or unsupported.
*
* FIXME: Assuming word4 is present.
*/
* or when the Layer-2 header length is modified, and
* a subsequent recalculation of checksums is anticipated.
*
- * @return Returns the actual value of the work entry offset field.
+ * Return: Returns the actual value of the work entry offset field.
*
* FIXME: Assuming word4 is present.
*/
/*
* Answer ``Is the bit for feature set in the bitmap?''
* @param feature
- * @return 1 when the feature is present and 0 otherwise, -1 in case of error.
+ * Return: 1 when the feature is present and 0 otherwise, -1 in case of error.
*/
#define octeon_has_feature(feature_x) octeon_has_feature_##feature_x()
/**
* Return the octeon family, i.e., ProcessorID of the PrID register.
*
- * @return the octeon family on success, ((u32)-1) on error.
+ * Return: the octeon family on success, ((u32)-1) on error.
*/
static inline u32 cvmx_get_octeon_family(void)
{
*
* @param dev Ethernet device for phy
*
- * @return 0 to continue, or -1 for error to stop setting up the phy
+ * Return: 0 to continue, or -1 for error to stop setting up the phy
*/
int octeon_eth_board_post_setup_phy(struct eth_device *dev);
* reg = <0> then the interface will be renamed after this function to
* interface@0.
*
- * @return 0 for success.
+ * Return: 0 for success.
*/
int octeon_fdt_patch_rename(void *fdt, const char *fdt_key, const char *trim_name, bool rename,
void (*callback)(void *fdt, int offset, void *arg), void *cbarg);
* reg = <0> then the interface will be renamed after this function to
* interface@0.
*
- * @return 0 for success.
+ * Return: 0 for success.
*/
int octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name);
* @param fdt pointer to flat device tree
* @param nodeoffset node offset to get OCX node for
*
- * @return the Octeon OCX node number
+ * Return: the Octeon OCX node number
*/
int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset);
* @param node_offset Node offset in device tree
* @param[in] strlist Array of FDT devices to check, end must be NULL
*
- * @return 0 if at least one device is compatible, 1 if not compatible.
+ * Return: 0 if at least one device is compatible, 1 if not compatible.
*/
int octeon_fdt_node_check_compatible(const void *fdt, int node_offset, const char *const *strlist);
/**
* @param[in] fdt Pointer to flat device tree
* @param node_offset Node offset in device tree
*
- * @return i2c bus number or -1 if error
+ * Return: i2c bus number or -1 if error
*/
int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset);
* @param[out] bus i2c bus number of device
* @param[out] addr address of device on i2c bus
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr);
* @param phandle phandle of GPIO node
* @param pin pin number to read
*
- * @return 0 = pin is low, 1 = pin is high, -1 = error
+ * Return: 0 = pin is low, 1 = pin is high, -1 = error
*/
int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin);
* @param pin pin number to read
* @param val value to write (1 = high, 0 = low)
*
- * @return 0 = success, -1 = error
+ * Return: 0 = success, -1 = error
*/
int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val);
* @param[out] addr i2c address of SFP EEPROM
* @param[out] mod_abs Set true if module is absent, false if present
*
- * @return 0 for success, -1 if there are problems with the device tree
+ * Return: 0 for success, -1 if there are problems with the device tree
*/
int octeon_fdt_get_sfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr, bool *mod_abs);
* @param[out] addr i2c address of SFP eeprom
* @param[out] mod_abs Set true if module is absent, false if present
*
- * @return 0 for success, -1 if there are problems with the device tree
+ * Return: 0 for success, -1 if there are problems with the device tree
*/
int octeon_fdt_get_qsfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr, bool *mod_abs);
* @param[out] i2c_bus For i2c GPIO expanders, the i2c bus number
* @param[out] i2c_addr For i2c GPIO expanders, the i2c address
*
- * @return 0 for success, -1 for errors
+ * Return: 0 for success, -1 for errors
*
* NOTE: It is up to the caller to determine the pin number.
*/
* @param fdt_node FDT node of phy
* @param[out] type Type of GPIO
*
- * @return pointer to phy device or NULL if no match found.
+ * Return: pointer to phy device or NULL if no match found.
*/
struct phy_device *octeon_fdt_get_phy_gpio_info(int fdt_node, enum octeon_gpio_type *type);
#endif /* __OCTEON_FDT_H__ */
* @param pf - PCIe config space pf num
* @param[out] id - override device and vendor ID
*
- * @return 0 if override found, 1 if not found.
+ * Return: 0 if override found, 1 if not found.
*/
int octeon_find_pcie_id_override(unsigned int address, unsigned int pf, u32 *id);
* 1: QLMC_REF_CLK0
* 2: QLMC_REF_CLK1
*
- * @return Return 0 on success or -1.
+ * Return: Return 0 on success or -1.
*
* @note When the 161MHz clock is used it can only be used for
* XLAUI mode with a 6316 speed or XFI mode with a 103125 speed.
* reg = <0> then the interface will be renamed after this function to
* interface@0.
*
- * @return 0 for success.
+ * Return: 0 for success.
*/
int __octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name)
{
* reg = <0> then the interface will be renamed after this function to
* interface@0.
*
- * @return 0 for success.
+ * Return: 0 for success.
*/
int octeon_fdt_patch_rename(void *fdt, const char *fdt_key,
const char *trim_name, bool rename,
* @param fdt pointer to flat device tree
* @param nodeoffset node offset to get OCX node for
*
- * @return the Octeon OCX node number
+ * Return: the Octeon OCX node number
*/
int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset)
{
* @param node_offset Node offset in device tree
* @param[in] strlist Array of FDT devices to check, end must be NULL
*
- * @return 0 if at least one device is compatible, 1 if not compatible.
+ * Return: 0 if at least one device is compatible, 1 if not compatible.
*/
int octeon_fdt_node_check_compatible(const void *fdt, int node_offset,
const char *const *strlist)
* @param[in] fdt Pointer to flat device tree
* @param node_offset Node offset in device tree
*
- * @return i2c bus number or -1 if error
+ * Return: i2c bus number or -1 if error
*/
int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset)
{
* @param[out] bus i2c bus number of device
* @param[out] addr address of device on i2c bus
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr)
{
* @param phandle phandle of GPIO node
* @param pin pin number to read
*
- * @return 0 = pin is low, 1 = pin is high, -1 = error
+ * Return: 0 = pin is low, 1 = pin is high, -1 = error
*/
int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin)
{
* @param pin pin number to read
* @param val value to write (1 = high, 0 = low)
*
- * @return 0 = success, -1 = error
+ * Return: 0 = success, -1 = error
*/
int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val)
{
* @param[out] i2c_bus For i2c GPIO expanders, the i2c bus number
* @param[out] i2c_addr For i2c GPIO expanders, the i2c address
*
- * @return 0 for success, -1 for errors
+ * Return: 0 for success, -1 for errors
*
* NOTE: It is up to the caller to determine the pin number.
*/
*
* @param fdt_node FDT node in device tree
*
- * @return pointer to PHY device or NULL if none found.
+ * Return: pointer to PHY device or NULL if none found.
*/
static struct phy_device *octeon_fdt_get_phy_device_from_node(int fdt_node)
{
* @param fdt_node FDT node of phy
* @param[out] type Type of GPIO
*
- * @return pointer to phy device or NULL if no match found.
+ * Return: pointer to phy device or NULL if no match found.
*/
struct phy_device *octeon_fdt_get_phy_gpio_info(int fdt_node, enum octeon_gpio_type *type)
{
* SPEED value is ignored in this mode. QLM_SPD is set based on
* pcie2x1 value in this mode.
*
- * @return Return 0 on success or -1.
+ * Return: Return 0 on success or -1.
*/
static int octeon_configure_qlm_cn61xx(int qlm, int speed, int mode, int rc, int pcie2x1)
{
* @param ref_clk_input The reference-clock input to use to configure QLM
* @param ref_clk_sel The reference-clock selection to use to configure QLM
*
- * @return Return 0 on success or -1.
+ * Return: Return 0 on success or -1.
*/
static int octeon_configure_qlm_cn70xx(int qlm, int speed, int mode, int rc, int gen2,
int ref_clk_sel, int ref_clk_input)
* @param ctle_zero Equalizer Peaking control
* @param agc_pre_ctle Pre-CTLE gain
* @param agc_post_ctle Post-CTLE gain
- * @return Zero on success, negative on failure
+ * Return: Zero on success, negative on failure
*/
int octeon_qlm_dfe_disable_ctle_agc(int node, int qlm, int lane, int baud_mhz, int mode,
* @param ref_clk_sel 0 = 100MHz, 1 = 125MHz, 2 = 156.25MHz,
* 3 = 161.1328125MHz
*
- * @return 0 for success or -1 if the reference clock selector is not supported
+ * Return: 0 for success or -1 if the reference clock selector is not supported
*
* NOTE: This must be called before __qlm_setup_pll_cn78xx.
*/
* @param[out] alt_pll_settings If non-NULL this will be set if non-default PLL
* settings are required for the mode.
*
- * @return lane mode to use or -1 on error
+ * Return: lane mode to use or -1 on error
*
* NOTE: In some modes
*/
* 3 = REF_161MHZ
* @param ref_clk_input The reference-clock input to use to configure QLM
*
- * @return Return 0 on success or -1.
+ * Return: Return 0 on success or -1.
*/
int octeon_configure_qlm_cn78xx(int node, int qlm, int baud_mhz, int mode, int rc, int gen3,
int ref_clk_sel, int ref_clk_input)
* 1 = common reference clock input 0
* 2 = common reference clock input 1
*
- * @return Return 0 on success or -1.
+ * Return: Return 0 on success or -1.
*/
static int octeon_configure_qlm_cn73xx(int qlm, int baud_mhz, int mode, int rc, int gen3,
int ref_clk_sel, int ref_clk_input)
* 3 = REF_122MHZ
* @param ref_clk_input The reference-clock input to use to configure QLM
*
- * @return Return 0 on success or -1.
+ * Return: Return 0 on success or -1.
*/
static int octeon_configure_qlm_cnf75xx(int qlm, int baud_mhz, int mode, int rc, int gen3,
int ref_clk_sel, int ref_clk_input)
* 1: QLMC_REF_CLK0
* 2: QLMC_REF_CLK1
*
- * @return Return 0 on success or -1.
+ * Return: Return 0 on success or -1.
*/
int octeon_configure_qlm(int qlm, int speed, int mode, int rc, int pcie_mode, int ref_clk_sel,
int ref_clk_input)
then snoopid not defined
* @param[in] subwin_cnt number of sub-windows
*
- * @return Returns 0 upon success else error code < 0 returned
+ * Return: Returns 0 upon success else error code < 0 returned
*/
static int pamu_config_ppaace(uint32_t liodn, uint64_t win_addr,
uint64_t win_size, uint32_t omi,
* @arg0: First argument of function
* @arg1: Second argument of function
* @wait: Wait for harts to acknowledge request
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int smp_call_function(ulong addr, ulong arg0, ulong arg1, int wait);
* the cpu driver is initialized. No other riscv_*_ipi() calls will be made
* before this function is called.
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int riscv_init_ipi(void);
* Platform code must provide this function.
*
* @hart: Hart ID of receiving hart
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int riscv_send_ipi(int hart);
* Platform code must provide this function.
*
* @hart: Hart ID of hart to be cleared
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int riscv_clear_ipi(int hart);
* @hart: Hart ID of hart to be checked
* @pending: Pointer to variable with result of the check,
* 1 if IPI is pending, 0 otherwise
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int riscv_get_ipi(int hart, int *pending);
/**
* spl_board_init_f() - initialize board in the SPL phase
*
- * @return 0 if succeeded, -ve on error
+ * Return: 0 if succeeded, -ve on error
*/
int spl_board_init_f(void);
* which we can use to map back to the pointer later.
*
* @ptr: Pointer to check
- * @return true if this is within sandbox emulated DRAM, false if not
+ * Return: true if this is within sandbox emulated DRAM, false if not
*/
static bool is_in_sandbox_mem(const void *ptr)
{
* @argvp: Returns newly allocated args list
* @add_args: Arguments to add, each a string
* @count: Number of arguments in @add_args
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
static int add_args(char ***argvp, char *add_args[], int count)
{
* execs it.
*
* @fname: Filename to exec
- * @return does not return on success, any return value is an error
+ * Return: does not return on success, any return value is an error
*/
static int os_jump_to_file(const char *fname, bool delete_it)
{
* @state: Sandbox state
* @io: Method to use for reading state
* @blob: FDT containing state
- * @return 0 if OK, -EINVAL if the read function returned failure
+ * Return: 0 if OK, -EINVAL if the read function returned failure
*/
int sandbox_read_state_nodes(struct sandbox_state *state,
struct sandbox_state_io *io, const void *blob)
*
* @state: Sandbox state
* @io: Method to use for writing state
- * @return 0 if OK, -EIO if there is a fatal error (such as out of space
+ * Return: 0 if OK, -EIO if there is a fatal error (such as out of space
* for adding the data), -EINVAL if the write function failed.
*/
int sandbox_write_state_node(struct sandbox_state *state,
* @dev: device that received the packet
* @packet: pointer to the received pacaket buffer
* @len: length of received packet
- * @return 0 if injected, -EAGAIN if not
+ * Return: 0 if injected, -EAGAIN if not
*/
int sandbox_eth_arp_req_to_reply(struct udevice *dev, void *packet,
unsigned int len);
* @dev: device that received the packet
* @packet: pointer to the received pacaket buffer
* @len: length of received packet
- * @return 0 if injected, -EAGAIN if not
+ * Return: 0 if injected, -EAGAIN if not
*/
int sandbox_eth_ping_req_to_reply(struct udevice *dev, void *packet,
unsigned int len);
* Inject an ARP request for this target
*
* @dev: device that received the packet
- * @return 0 if injected, -EOVERFLOW if not
+ * Return: 0 if injected, -EOVERFLOW if not
*/
int sandbox_eth_recv_arp_req(struct udevice *dev);
* Inject a ping request for this target
*
* @dev: device that received the packet
- * @return 0 if injected, -EOVERFLOW if not
+ * Return: 0 if injected, -EOVERFLOW if not
*/
int sandbox_eth_recv_ping_req(struct udevice *dev);
*
* @param dev device to use
* @param offset GPIO offset within bank
- * @return -1 on error, 0 if GPIO is low, >0 if high
+ * Return: -1 on error, 0 if GPIO is low, >0 if high
*/
int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset);
* @param dev device to use
* @param offset GPIO offset within bank
* @param value value to set (0 for low, non-zero for high)
- * @return -1 on error, 0 if ok
+ * Return: -1 on error, 0 if ok
*/
int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value);
*
* @param dev device to use
* @param offset GPIO offset within bank
- * @return -1 on error, 0 if GPIO is input, >0 if output
+ * Return: -1 on error, 0 if GPIO is input, >0 if output
*/
int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset);
* @param dev device to use
* @param offset GPIO offset within bank
* @param output 0 to set as input, 1 to set as output
- * @return -1 on error, 0 if ok
+ * Return: -1 on error, 0 if ok
*/
int sandbox_gpio_set_direction(struct udevice *dev, unsigned int offset,
int output);
*
* @param dev device to use
* @param offset GPIO offset within bank
- * @return dir_flags: bitfield accesses by GPIOD_ defines
+ * Return: dir_flags: bitfield accesses by GPIOD_ defines
*/
ulong sandbox_gpio_get_flags(struct udevice *dev, unsigned int offset);
* @param dev device to use
* @param offset GPIO offset within bank
* @param flags bitfield accesses by GPIOD_ defines
- * @return -1 on error, 0 if ok
+ * Return: -1 on error, 0 if ok
*/
int sandbox_gpio_set_flags(struct udevice *dev, unsigned int offset,
ulong flags);
* display will pass 5, since 2*5 = 32
* @double_size: true to double the visible size in each direction for high-DPI
* displays
- * @return 0 if OK, -ENODEV if no device, -EIO if SDL failed to initialize
+ * Return: 0 if OK, -ENODEV if no device, -EIO if SDL failed to initialize
* and -EPERM if the video failed to come up.
*/
int sandbox_sdl_init_display(int width, int height, int log2_bpp,
/**
* sandbox_sdl_remove_display() - Remove the SDL screen
*
- * @return 0 if OK, -ENOENT if the SDL had not been inited.
+ * Return: 0 if OK, -ENOENT if the SDL had not been inited.
*/
int sandbox_sdl_remove_display(void);
* user can see it.
*
* @lcd_base: Base of frame buffer
- * @return 0 if screen was updated, -ENODEV is there is no screen.
+ * Return: 0 if screen was updated, -ENODEV is there is no screen.
*/
int sandbox_sdl_sync(void *lcd_base);
*
* @key: Array to receive keycodes
* @max_keys: Size of array
- * @return number of keycodes found, 0 if none, -ENODEV if no keyboard
+ * Return: number of keycodes found, 0 if none, -ENODEV if no keyboard
*/
int sandbox_sdl_scan_keys(int key[], int max_keys);
* sandbox_sdl_key_pressed() - check if a particular key is pressed
*
* @keycode: Keycode to check (KEY_... - see include/linux/input.h
- * @return 0 if pressed, -ENOENT if not pressed. -ENODEV if keybord not
+ * Return: 0 if pressed, -ENOENT if not pressed. -ENODEV if keybord not
* available,
*/
int sandbox_sdl_key_pressed(int keycode);
/**
* sandbox_sdl_sound_stop() - stop playing a sound
*
- * @return 0 if OK, -ENODEV if no sound is available
+ * Return: 0 if OK, -ENODEV if no sound is available
*/
int sandbox_sdl_sound_stop(void);
*
* @rate: Sample rate to use
* @channels: Number of channels to use (1=mono, 2=stereo)
- * @return 0 if OK, -ENODEV if no sound is available
+ * Return: 0 if OK, -ENODEV if no sound is available
*/
int sandbox_sdl_sound_init(int rate, int channels);
* data set for start-of-day.
* @param blob: Pointer to device tree blob, or NULL if no data to read
* @param node: Node offset to read from
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*
* @write: Function to write state to FDT
* The caller will ensure that there is a node ready for the state. The
/**
* Gets a pointer to the current state.
*
- * @return pointer to state
+ * Return: pointer to state
*/
struct sandbox_state *state_get_current(void);
*
* @param state Sandbox state to update
* @param fname Filename of device tree file to read from
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sandbox_read_state(struct sandbox_state *state, const char *fname);
*
* @param state Sandbox state to update
* @param fname Filename of device tree file to write to
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sandbox_write_state(struct sandbox_state *state, const char *fname);
/**
* See if delays should be skipped
*
- * @return true if delays should be skipped, false if they should be honoured
+ * Return: true if delays should be skipped, false if they should be honoured
*/
bool state_get_skip_delays(void);
* Uninitialize the test system state, writing out state if configured to
* do so.
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int state_uninit(void);
* @use_system_time: true to use system time, false to use @base_time
* @offset: RTC offset from current system/base time (-1 for no
* change)
- * @return old value of RTC offset
+ * Return: old value of RTC offset
*/
long sandbox_i2c_rtc_set_offset(struct udevice *dev, bool use_system_time,
int offset);
*
* @dev: RTC device to adjust
* @base_time: New base system time (set to -1 for no change)
- * @return old base time
+ * Return: old base time
*/
long sandbox_i2c_rtc_get_set_base_time(struct udevice *dev, long base_time);
* @duty_ns: Current duty cycle of the PWM in nanoseconds
* @enable: true if the PWM is enabled
* @polarity: true if the PWM polarity is active high
- * @return 0 if OK, -ENOSPC if the PWM number is invalid
+ * Return: 0 if OK, -ENOSPC if the PWM number is invalid
*/
int sandbox_pwm_get_config(struct udevice *dev, uint channel, uint *period_nsp,
uint *duty_nsp, bool *enablep, bool *polarityp);
* This data is provided to the sandbox driver by the I2S tx_data() method.
*
* @dev: Device to check
- * @return sum of audio data
+ * Return: sum of audio data
*/
int sandbox_get_i2s_sum(struct udevice *dev);
* This is used in the sound test
*
* @dev: Device to check
- * @return call count for the setup() method
+ * Return: call count for the setup() method
*/
int sandbox_get_setup_called(struct udevice *dev);
/**
* sandbox_get_sound_active() - Returns whether sound play is in progress
*
- * @return true if active, false if not
+ * Return: true if active, false if not
*/
int sandbox_get_sound_active(struct udevice *dev);
* This data is provided to the sandbox driver by the sound play() method.
*
* @dev: Device to check
- * @return sum of audio data
+ * Return: sum of audio data
*/
int sandbox_get_sound_sum(struct udevice *dev);
* sandbox_get_beep_frequency() - Get the frequency of the current beep
*
* @dev: Device to check
- * @return frequency of beep, if there is an active beep, else 0
+ * Return: frequency of beep, if there is an active beep, else 0
*/
int sandbox_get_beep_frequency(struct udevice *dev);
* sandbox_spi_get_speed() - Get current speed setting of a sandbox spi bus
*
* @dev: Device to check
- * @return current bus speed
+ * Return: current bus speed
*/
uint sandbox_spi_get_speed(struct udevice *dev);
* sandbox_spi_get_mode() - Get current mode setting of a sandbox spi bus
*
* @dev: Device to check
- * @return current mode
+ * Return: current mode
*/
uint sandbox_spi_get_mode(struct udevice *dev);
* sandbox_get_pch_spi_protect() - Get the PCI SPI protection status
*
* @dev: Device to check
- * @return 0 if not protected, 1 if protected
+ * Return: 0 if not protected, 1 if protected
*/
int sandbox_get_pch_spi_protect(struct udevice *dev);
* sandbox_get_pci_ep_irq_count() - Get the PCI EP IRQ count
*
* @dev: Device to check
- * @return irq count
+ * Return: irq count
*/
int sandbox_get_pci_ep_irq_count(struct udevice *dev);
* @type: Type of BAR (PCI_BASE_ADDRESS_SPACE_IO or
* PCI_BASE_ADDRESS_MEM_TYPE_32)
* @size: Size of BAR in bytes
- * @return BAR value to return from emulator
+ * Return: BAR value to return from emulator
*/
uint sandbox_pci_read_bar(u32 barval, int type, uint size);
* @dev: Device to check
* @index: PWM channel index
* @duty: Current duty cycle in 0..EC_PWM_MAX_DUTY range.
- * @return 0 if OK, -ENOSPC if the PWM number is invalid
+ * Return: 0 if OK, -ENOSPC if the PWM number is invalid
*/
int sandbox_cros_ec_get_pwm_duty(struct udevice *dev, uint index, uint *duty);
*
* @dev: Device to adjust
* @l2bpp: depth to set
- * @return 0 if the device was already active, other error if it fails to probe
+ * Return: 0 if the device was already active, other error if it fails to probe
* after the change
*/
int sandbox_sdl_set_bpp(struct udevice *dev, enum video_log2_bpp l2bpp);
* @devp: Returns the device which mapped into this space
* @ptrp: Returns a pointer to the mapped address. The device's space
* can be accessed as @lenp bytes starting here
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_map_physmem(phys_addr_t paddr, unsigned long *lenp,
struct udevice **devp, void **ptrp);
* @paddr: Physical memory address, as passed to pci_map_physmem()
* @len: Size of area mapped, as returned by pci_map_physmem()
* @dev: Device to unmap, as returned by pci_map_physmem()
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_unmap_physmem(const void *addr, unsigned long len,
struct udevice *dev);
* Set to 0 if the property is expected to be a scalar
* @dst: Pointer to destination of where to save the value(s) read
* from devicetree
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
static int read_u16_prop(ofnode node, char *name, size_t count, u16 *dst)
{
* @fsp_bindings: Binding describing which devicetree properties should
* be stored where in the FSP configuration structure
* The end of the list is declared by a NULL pointer in propname
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* This function reads the configuration for FSP from the provided
* devicetree node and saves it in the FSP configuration structure.
/**
* pch_serialio_init() - set up serial I/O devices
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int pch_serialio_init(void)
{
* platform controller hub (PCH). This function should be implemented by the
* CPU-specific code.
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
static int cpu_run_reference_code(void)
{
* lpc_early_init() - set up LPC serial ports and other early things
*
* @dev: LPC device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int lpc_common_early_init(struct udevice *dev)
{
* This is needed by FSP-M which uses the High Precision Event Timer.
*
* @dev: P2SB device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int p2sb_early_init(struct udevice *dev)
{
* pch_silicon_revision() - Read silicon revision ID from the PCH
*
* @dev: PCH device
- * @return silicon revision ID
+ * Return: silicon revision ID
*/
static int pch_silicon_revision(struct udevice *dev)
{
* @dev: PCH device
* @type: PCH type
* @rev: Minimum required resion
- * @return 0 if not supported, 1 if supported
+ * Return: 0 if not supported, 1 if supported
*/
static int pch_silicon_supported(struct udevice *dev, int type, int rev)
{
*
* @num_aps: Number of APs we expect to find
* @ap_count: Initially zero. Incremented by this function for each AP found
- * @return 0 if all APs were set up correctly or there are none to set up,
+ * Return: 0 if all APs were set up correctly or there are none to set up,
* -ENOSPC if the SIPI vector is too high in memory,
* -ETIMEDOUT if the ICR is busy or the second SIPI fails to complete
* -EIO if not all APs check in correctly
*
* @devp: If non-NULL, returns CPU device corresponding to the BSP
* @cpu_countp: If non-NULL, returns the total number of CPUs
- * @return CPU number of the BSP, or -ve on error. If multiprocessing is not
+ * Return: CPU number of the BSP, or -ve on error. If multiprocessing is not
* enabled, returns 0
*/
static int get_bsp(struct udevice **devp, int *cpu_countp)
* pointer to new instructions
*
* @slot: Pointer to the AP's callback slot
- * @return value of that pointer
+ * Return: value of that pointer
*/
static struct mp_callback *read_callback(struct mp_callback **slot)
{
* @num_cpus: The number of CPUs in the system (= number of APs + 1)
* @expire_ms: Timeout to wait for all APs to finish, in milliseconds, or 0 for
* no timeout
- * @return 0 if OK, -ETIMEDOUT if one or more APs failed to respond in time
+ * Return: 0 if OK, -ETIMEDOUT if one or more APs failed to respond in time
*/
static int run_ap_work(struct mp_callback *callback, struct udevice *bsp,
int num_cpus, uint expire_ms)
*
* @cpu: CPU that is waiting
* @unused: Optional argument provided by struct mp_flight_record, not used here
- * @return Does not return
+ * Return: Does not return
*/
static int ap_wait_for_instruction(struct udevice *cpu, void *unused)
{
/**
* mtrr_copy_to_aps() - Copy the MTRRs from the boot CPU to other CPUs
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
static int mtrr_copy_to_aps(void)
{
* The memory map entries from Slim Bootloader hob are already sorted.
*
* @total_size: The memory size that u-boot occupies
- * @return : The top available memory address lower than 4GB
+ * Return: : The top available memory address lower than 4GB
*/
ulong board_get_usable_ram_top(ulong total_size)
{
* Write out the table for High-Precision Event Timers
*
* @ctx: Current ACPI context
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_write_hpet(struct acpi_ctx *ctx);
* @ctx: Current ACPI context
* @dev: Debug UART device to describe
* @access_size: Access size for UART (e.g. ACPI_ACCESS_SIZE_DWORD_ACCESS)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_write_dbg2_pci_uart(struct acpi_ctx *ctx, struct udevice *dev,
uint access_size);
* acpi_create_gnvs() - Create a GNVS (Global Non Volatile Storage) table
*
* @gnvs: Table to fill in
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_create_gnvs(struct acpi_global_nvs *gnvs);
* arch_madt_sci_irq_polarity() - Return the priority to use for the MADT
*
* @sci: System-control interrupt number
- * @return priority to use (MP_IRQ_POLARITY_...)
+ * Return: priority to use (MP_IRQ_POLARITY_...)
*/
int arch_madt_sci_irq_polarity(int sci);
*
* @ctx: ACPI context pointer
* @bdf: PCI device to add
- * @return length of mapping in bytes
+ * Return: length of mapping in bytes
*/
int acpi_create_dmar_ds_pci(struct acpi_ctx *ctx, pci_dev_t bdf);
*
* @ctx: ACPI context pointer
* @bdf: PCI device to add
- * @return length of mapping in bytes
+ * Return: length of mapping in bytes
*/
int acpi_create_dmar_ds_pci_br(struct acpi_ctx *ctx, pci_dev_t bdf);
* @ctx: ACPI context pointer
* @enumeration_id: Enumeration ID (typically 2)
* @bdf: PCI device to add
- * @return length of mapping in bytes
+ * Return: length of mapping in bytes
*/
int acpi_create_dmar_ds_ioapic(struct acpi_ctx *ctx, uint enumeration_id,
pci_dev_t bdf);
* @ctx: ACPI context pointer
* @enumeration_id: Enumeration ID (typically 0)
* @bdf: PCI device to add
- * @return length of mapping in bytes
+ * Return: length of mapping in bytes
*/
int acpi_create_dmar_ds_msi_hpet(struct acpi_ctx *ctx, uint enumeration_id,
pci_dev_t bdf);
* fsp_m_update_config_from_dtb() - Read FSP-M config from devicetree node
* @node: Valid node reference to read property from
* @cfg: Pointer to FSP-M config structure
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* This function reads the configuration for FSP-M from the provided
* devicetree node and saves it in the FSP-M configuration structure.
* fsp_s_update_config_from_dtb() - Read FSP-S config from devicetree node
* @node: Valid node reference to read property from
* @cfg: Pointer to FSP-S config structure
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* This function reads the configuration for FSP-S from the provided
* devicetree node and saves it in the FSP-S configuration structure.
*
* @base: Base I/O address (e.g. 0x800)
* @size: Size of window (e.g. 0x100)
- * @return 0 if OK, -ENOSPC if there are no more windows available, -EALREADY
+ * Return: 0 if OK, -ENOSPC if there are no more windows available, -EALREADY
* if already set up
*/
int lpc_open_pmio_window(uint base, uint size);
* below 4GB
*
* @dev: hostbridge device
- * @return TOLUD address
+ * Return: TOLUD address
*/
ulong sa_get_tolud_base(struct udevice *dev);
* for Graphics Translation Tables.
*
* @dev: hostbridge device
- * @return GSM address
+ * Return: GSM address
*/
ulong sa_get_gsm_base(struct udevice *dev);
*
* This returns the top address of DRAM available below 4GB
*
- * @return TSEG base
+ * Return: TSEG base
*/
ulong sa_get_tseg_base(struct udevice *dev);
/**
* timestamp_add_to_bootstage - Add important coreboot timestamps to bootstage
*
- * @return 0 if ok, -1 if no timestamps were found
+ * Return: 0 if ok, -1 if no timestamps were found
*/
int timestamp_add_to_bootstage(void);
* pch_silicon_revision() - Read silicon device ID from the PCH
*
* @dev: PCH device
- * @return silicon device ID
+ * Return: silicon device ID
*/
int pch_silicon_type(struct udevice *dev);
* bridge_silicon_revision() - Get the Northbridge revision
*
* @dev: Northbridge device
- * @return revision ID (bits 3:0) and bridge ID (bits 7:4)
+ * Return: revision ID (bits 3:0) and bridge ID (bits 7:4)
*/
int bridge_silicon_revision(struct udevice *dev);
* @image_64bit: true if the image is a raw 64-bit kernel, false if it
* is raw 32-bit or any type of self-extracting kernel
* such as a bzImage.
- * @return -ve error code. This function does not return if the kernel was
+ * Return: -ve error code. This function does not return if the kernel was
* booted successfully.
*/
int boot_linux_kernel(ulong setup_base, ulong load_address, bool image_64bit);
* so.
*
* @info: Place to put the parsed information
- * @return 0 if OK, -ENOENT if no table found
+ * Return: 0 if OK, -ENOENT if no table found
*/
int get_coreboot_info(struct sysinfo_t *info);
/**
* cb_get_sysinfo() - get a pointer to the parsed coreboot sysinfo
*
- * @return pointer to sysinfo, or NULL if not available
+ * Return: pointer to sysinfo, or NULL if not available
*/
const struct sysinfo_t *cb_get_sysinfo(void);
/**
* locate_coreboot_table() - Try to find coreboot tables at standard locations
*
- * @return address of table that was found, or -ve error number
+ * Return: address of table that was found, or -ve error number
*/
long locate_coreboot_table(void);
/**
* cpu_has_64bit() - Check if the CPU has 64-bit support
*
- * @return 1 if this CPU supports long mode (64-bit), 0 if not
+ * Return: 1 if this CPU supports long mode (64-bit), 0 if not
*/
int cpu_has_64bit(void);
* cpu_get_name() - Get the name of the current cpu
*
* @name: Place to put name, which must be CPU_MAX_NAME_LEN bytes including
- * @return pointer to name, which will likely be a few bytes after the start
+ * Return: pointer to name, which will likely be a few bytes after the start
* of @name
* \0 terminator
*/
/**
* cpu_get_family_model() - Get the family and model for the CPU
*
- * @return the CPU ID masked with 0x0fff0ff0
+ * Return: the CPU ID masked with 0x0fff0ff0
*/
u32 cpu_get_family_model(void);
/**
* cpu_get_stepping() - Get the stepping value for the CPU
*
- * @return the CPU ID masked with 0xf
+ * Return: the CPU ID masked with 0xf
*/
u32 cpu_get_stepping(void);
*
* This is 32 for older CPUs but newer ones may support 36.
*
- * @return address size (typically 32 or 36)
+ * Return: address size (typically 32 or 36)
*/
int cpu_phys_address_size(void);
* This reports BIST failure, enables the LAPIC, updates microcode, enables
* the upper 128-bytes of CROM RAM, probes the northbridge, PCH, LPC and SATA.
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cpu_common_init(void);
* Some details are available here:
* http://forum.hwbot.org/showthread.php?t=76092
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cpu_set_flex_ratio_to_tdp_nominal(void);
* @info: cpu_info struct to fill in
* @bclk_mz: the base clock in MHz
*
- * @return 0 always
+ * Return: 0 always
*/
int cpu_intel_get_info(struct cpu_info *info, int bclk_mz);
* MSR_TEMPERATURE_TARGET value.
*
* @dev: CPU device
- * @return 0 if OK, -ENOENT if no target is given in device tree
+ * Return: 0 if OK, -ENOENT if no target is given in device tree
*/
int cpu_configure_thermal_target(struct udevice *dev);
/**
* cpu_config_tdp_levels() - Check for configurable TDP option
*
- * @return true if the CPU has configurable TDP (Thermal-design power)
+ * Return: true if the CPU has configurable TDP (Thermal-design power)
*/
bool cpu_config_tdp_levels(void);
* Bit 38 - TURBO_MODE_DISABLE Bit to get state ENABLED / DISABLED.
* Also checks cpuid 0x6 to see whether burst mode is supported.
*
- * @return current burst mode status
+ * Return: current burst mode status
*/
enum burst_mode_t cpu_get_burst_mode_state(void);
*
* See ACPI spec v6.3 section 8.4.6.5 _PSD (P-State Dependency)
*
- * @return HW_ALL (always)
+ * Return: HW_ALL (always)
*/
int cpu_get_coord_type(void);
/**
* cpu_get_min_ratio() - get minimum support frequency ratio for CPU
*
- * @return minimum ratio
+ * Return: minimum ratio
*/
int cpu_get_min_ratio(void);
* If a nominal TDP ratio is available, it is returned. Otherwise this returns
* the maximum non-turbo frequency ratio for this processor
*
- * @return max ratio
+ * Return: max ratio
*/
int cpu_get_max_ratio(void);
*
* This is the value the clock ratio is multiplied with
*
- * @return bus-block frequency in KHz
+ * Return: bus-block frequency in KHz
*/
int cpu_get_bus_clock_khz(void);
/**
* cpu_get_power_max() - Get maximum CPU TDP
*
- * @return maximum CPU TDP (Thermal-design power) in mW
+ * Return: maximum CPU TDP (Thermal-design power) in mW
*/
int cpu_get_power_max(void);
/**
* cpu_get_max_turbo_ratio() - Get maximum turbo ratio
*
- * @return maximum ratio
+ * Return: maximum ratio
*/
int cpu_get_max_turbo_ratio(void);
/**
* cpu_get_cores_per_package() - Get the number of CPU cores in each package
*
- * @return number of cores
+ * Return: number of cores
*/
int cpu_get_cores_per_package(void);
* like the processor local apic id.
*
* @dev: Device to check (UCLASS_CPU)
- * @return 0 always
+ * Return: 0 always
*/
int cpu_x86_bind(struct udevice *dev);
*
* @max_entries: Maximum number of entries to write
* @entries: Place to put entires
- * @return number of entries written
+ * Return: number of entries written
*/
unsigned int cb_install_e820_map(unsigned int max_entries,
struct e820_entry *entries);
* @map_sizep: Returns size of mapped SPI
* @offsetp: Returns start offset of SPI flash where the map works
* correctly (offsets before this are not visible)
- * @return 0 (always)
+ * Return: 0 (always)
*/
int fast_spi_get_bios_mmap(pci_dev_t pdev, ulong *map_basep, uint *map_sizep,
uint *offsetp);
* @map_sizep: Returns size of mapped SPI
* @offsetp: Returns start offset of SPI flash where the map works
* correctly (offsets before this are not visible)
- * @return 0 (always)
+ * Return: 0 (always)
*/
int fast_spi_get_bios_mmap_regs(struct fast_spi_regs *regs, ulong *map_basep,
uint *map_sizep, uint *offsetp);
/**
* fsp_find_header() - Find FSP header offset in FSP image
*
- * @return the offset of FSP header. If signature is invalid, returns 0.
+ * Return: the offset of FSP header. If signature is invalid, returns 0.
*/
struct fsp_header *fsp_find_header(void);
* @fsp_hdr: Pointer to FSP information header
* @phase: FSP initialization phase defined in enum fsp_phase
*
- * @return compatible status code with EFI_STATUS defined in PI spec
+ * Return: compatible status code with EFI_STATUS defined in PI spec
*/
u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase);
*
* @hob_list: A HOB list pointer.
*
- * @return Usable low memory top.
+ * Return: Usable low memory top.
*/
u32 fsp_get_usable_lowmem_top(const void *hob_list);
*
* @hob_list: A HOB list pointer.
*
- * @return Usable high memory top.
+ * Return: Usable high memory top.
*/
u64 fsp_get_usable_highmem_top(const void *hob_list);
* If the GUID HOB is located, the length will be updated.
* @guid: A pointer to the owner guild.
*
- * @return Reserved region start address.
+ * Return: Reserved region start address.
* 0 if this region does not exist.
*/
u64 fsp_get_reserved_mem_from_guid(const void *hob_list,
* @hob_list: A HOB list pointer.
* @len: A pointer to the FSP reserved memory length buffer.
* If the GUID HOB is located, the length will be updated.
- * @return FSP reserved memory base
+ * Return: FSP reserved memory base
* 0 if this region does not exist.
*/
u32 fsp_get_fsp_reserved_mem(const void *hob_list, u32 *len);
* @len: A pointer to the TSEG reserved memory length buffer.
* If the GUID HOB is located, the length will be updated.
*
- * @return NULL: Failed to find the TSEG reserved memory.
- * @return others: TSEG reserved memory base.
+ * Return: NULL: Failed to find the TSEG reserved memory.
+ * Return: others: TSEG reserved memory base.
*/
u32 fsp_get_tseg_reserved_mem(const void *hob_list, u32 *len);
* @len: A pointer to the NVS data buffer length.
* If the HOB is located, the length will be updated.
*
- * @return NULL: Failed to find the NVS HOB.
- * @return others: FSP NVS data buffer pointer.
+ * Return: NULL: Failed to find the NVS HOB.
+ * Return: others: FSP NVS data buffer pointer.
*/
void *fsp_get_nvs_data(const void *hob_list, u32 *len);
* @len: A pointer to the NVS data buffer length.
* If the HOB is located, the length will be updated.
*
- * @return NULL: Failed to find the NVS HOB.
- * @return others: FSP NVS data buffer pointer.
+ * Return: NULL: Failed to find the NVS HOB.
+ * Return: others: FSP NVS data buffer pointer.
*/
void *fsp_get_var_nvs_data(const void *hob_list, u32 *len);
* @len: A pointer to the graphics info HOB length.
* If the HOB is located, the length will be updated.
*
- * @return NULL: Failed to find the graphics info HOB.
- * @return others: A pointer to struct hob_graphics_info.
+ * Return: NULL: Failed to find the graphics info HOB.
+ * Return: others: A pointer to struct hob_graphics_info.
*/
void *fsp_get_graphics_info(const void *hob_list, u32 *len);
/**
* fsp_init_phase_pci() - Tell the FSP that we have completed PCI init
*
- * @return 0 if OK, -EPERM if the FSP gave an error.
+ * Return: 0 if OK, -EPERM if the FSP gave an error.
*/
int fsp_init_phase_pci(void);
*
* This sets gd->ram_size based on what it finds.
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fsp_scan_for_ram_size(void);
* @fsp_hdr: Pointer to FSP information header
* @phase: FSP initialization phase defined in enum fsp_phase
*
- * @return compatible status code with EFI_STATUS defined in PI spec
+ * Return: compatible status code with EFI_STATUS defined in PI spec
*/
u32 fsp_notify(struct fsp_header *fsp_hdr, u32 phase);
* @status: Always 0
* @hob_list: HOB list pointer
*
- * @return Never returns
+ * Return: Never returns
*/
void fsp_continue(u32 status, void *hob_list);
* @len: A pointer to the bootloader temporary stack length.
* If the HOB is located, the length will be updated.
*
- * @return NULL: Failed to find the bootloader temporary stack HOB.
- * @return others: Bootloader temporary stackbuffer pointer.
+ * Return: NULL: Failed to find the bootloader temporary stack HOB.
+ * Return: others: Bootloader temporary stackbuffer pointer.
*/
void *fsp_get_bootloader_tmp_mem(const void *hob_list, u32 *len);
* @config: A pointer to the FSP configuration data structure
* @rt_buf: A pointer to the FSP runtime buffer data structure
*
- * @return None
+ * Return: None
*/
void fsp_update_configs(struct fsp_config_data *config,
struct fspinit_rtbuf *rt_buf);
* from scatch since we will lose its contents
* @use_spi_flash: true to use the fast SPI driver to read FSP, otherwise use
* mapped SPI
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fsp_memory_init(bool s3wake, bool use_spi_flash);
* from scatch since we will lose its contents
* @use_spi_flash: true to use the fast SPI driver to read FSP, otherwise use
* mapped SPI
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fsp_silicon_init(bool s3wake, bool use_spi_flash);
*
* @dev: Hostbridge device containing config
* @upd: Config data to fill in
- * @return 0 if OK, -ENOENT if OK but no MRC-cache data was found, other -ve on
+ * Return: 0 if OK, -ENOENT if OK but no MRC-cache data was found, other -ve on
* error
*/
int fspm_update_config(struct udevice *dev, struct fspm_upd *upd);
* continue.
*
* @dev: Hostbridge device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fspm_done(struct udevice *dev);
* @dev: Hostbridge device containing config
* @rom_offset: Value to add to convert from ROM offset to memory-mapped address
* @upd: Config data to fill in
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fsps_update_config(struct udevice *dev, ulong rom_offset,
struct fsps_upd *upd);
* This looks for cached Memory-reference code (MRC) data and stores it into
* @upd for use by the FSP-M binary.
*
- * @return 0 if OK, -ENOENT if no data (whereupon the caller can continue and
+ * Return: 0 if OK, -ENOENT if no data (whereupon the caller can continue and
* expect a slower boot), other -ve value on other error
*/
int prepare_mrc_cache(struct fspm_upd *upd);
*
* @hdr: A pointer to a HOB.
*
- * @return A pointer to the next HOB in the HOB list.
+ * Return: A pointer to the next HOB in the HOB list.
*/
static inline const struct hob_header *get_next_hob(const struct hob_header
*hdr)
*
* @hdr: A pointer to a HOB.
*
- * @return true: The HOB specified by hdr is the last HOB in the HOB list.
- * @return false: The HOB specified by hdr is not the last HOB in the HOB list.
+ * Return: true: The HOB specified by hdr is the last HOB in the HOB list.
+ * Return: false: The HOB specified by hdr is not the last HOB in the HOB list.
*/
static inline bool end_of_hob(const struct hob_header *hdr)
{
*
* @hdr: A pointer to a HOB.
*
- * @return A pointer to the data buffer in a HOB.
+ * Return: A pointer to the data buffer in a HOB.
*/
static inline void *get_guid_hob_data(const struct hob_header *hdr)
{
*
* @hdr: A pointer to a HOB.
*
- * @return The size of the data buffer.
+ * Return: The size of the data buffer.
*/
static inline u16 get_guid_hob_data_size(const struct hob_header *hdr)
{
* @type: HOB type to search
* @hob_list: A pointer to the HOB list
*
- * @return A HOB object with matching type; Otherwise NULL.
+ * Return: A HOB object with matching type; Otherwise NULL.
*/
const struct hob_header *hob_get_next_hob(uint type, const void *hob_list);
* @guid: GUID to search
* @hob_list: A pointer to the HOB list
*
- * @return A HOB object with matching GUID; Otherwise NULL.
+ * Return: A HOB object with matching GUID; Otherwise NULL.
*/
const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid,
const void *hob_list);
* If the GUID HOB is located, the length will be updated.
* @guid A pointer to HOB GUID.
*
- * @return NULL: Failed to find the GUID HOB.
- * @return others: GUID HOB data buffer pointer.
+ * Return: NULL: Failed to find the GUID HOB.
+ * Return: others: GUID HOB data buffer pointer.
*/
void *hob_get_guid_hob_data(const void *hob_list, u32 *len,
const efi_guid_t *guid);
* after a delay with i8254_disable_beep().
*
* @frequency_hz: Frequency of beep in Hz
- * @return 0 if OK, -EINVAL if frequency_hz is 0
+ * Return: 0 if OK, -EINVAL if frequency_hz is 0
*/
int i8254_enable_beep(uint frequency_hz);
* @core_id: CPU core number, as numbered by the SoC
* @c_state_map: Information about each C state
* @num_cstates: Number of entries in @c_state_map
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_generate_cpu_header(struct acpi_ctx *ctx, int core_id,
const struct acpi_cstate *c_state_map,
*
* This is called from ACPI code and OS drivers
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int intel_gma_init_igd_opregion(struct udevice *dev,
struct igd_opregion *opregion);
* @dev: Pinctrl device
* @comm: Pad community for this device
* @num_cfgs: Number of configuration words for each pad
- * @return 0 if OK, -EDOM if @comm is NULL, other -ve value on other error
+ * Return: 0 if OK, -EDOM if @comm is NULL, other -ve value on other error
*/
int intel_pinctrl_of_to_plat(struct udevice *dev,
const struct pad_community *comm, int num_cfgs);
* @gpe0b: Value for GPE0B
* @gpe0c: Value for GPE0C
* @gpe0d: Value for GPE0D
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pinctrl_route_gpe(struct udevice *dev, uint gpe0b, uint gpe0c, uint gpe0d);
* @pads: Pad data, consisting of a pad number followed by num_cfgs entries
* containing the data for that pad (num_cfgs is set by the pinctrl device)
* @pads_count: Number of pads to configure
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pinctrl_config_pads(struct udevice *dev, u32 *pads, int pads_count);
*
* This enables the interrupt inputs and clears the status register bits
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pinctrl_gpi_clear_int_cfg(void);
*
* @dev: pinctrl device (any will do)
* @node: Node containing the 'pads' property with the data in it
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pinctrl_config_pads_for_node(struct udevice *dev, ofnode node);
* @dev: pinctrl device (any will do)
* @pads: Array of pad data
* @size: Size of pad data in bytes
- * @return number of pads represented by the data
+ * Return: number of pads represented by the data
*/
int pinctrl_count_pads(struct udevice *dev, u32 *pads, int size);
*
* @dev: Pinctrl device
* @offset: GPIO offset within this device
- * @return register offset of first register within the GPIO p2sb region
+ * Return: register offset of first register within the GPIO p2sb region
*/
u32 intel_pinctrl_get_config_reg_offset(struct udevice *dev, uint offset);
* This works out the absolute address of the registers for a pin
* @dev: Pinctrl device
* @offset: GPIO offset within this device
- * @return register address of first register within the GPIO p2sb region
+ * Return: register address of first register within the GPIO p2sb region
*/
u32 intel_pinctrl_get_config_reg_addr(struct udevice *dev, uint offset);
*
* @dev: Pinctrl device
* @offset: GPIO offset within this device
- * @return register value within the GPIO p2sb region
+ * Return: register value within the GPIO p2sb region
*/
u32 intel_pinctrl_get_config_reg(struct udevice *dev, uint offset);
* @pad: Pad to check
* @devp: Returns pinctrl device containing that pad
* @offsetp: Returns offset of pad within that pinctrl device
- * @return 0 if OK, -ENOTBLK if pad number is invalid
+ * Return: 0 if OK, -ENOTBLK if pad number is invalid
*/
int intel_pinctrl_get_pad(uint pad, struct udevice **devp, uint *offsetp);
*
* @dev: Pinctrl device to check
* @offset: Offset of pin within that device (0 = first)
- * @return associated ACPI GPIO pin-table entry, or standard pin number if the
+ * Return: associated ACPI GPIO pin-table entry, or standard pin number if the
* ACPI pad base is not set
*/
int intel_pinctrl_get_acpi_pin(struct udevice *dev, uint offset);
* also puts the RCB in the correct place so that RCB_REG() works.
*
* @dev: LPC device (a child of the PCH)
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int lpc_common_early_init(struct udevice *dev);
* intel_early_me_init() - Early Intel Management Engine init
*
* @me_dev: Management engine PCI device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int intel_early_me_init(struct udevice *me_dev);
* intel_early_me_uma_size() - Get UMA size from the Intel Management Engine
*
* @me_dev: Management engine PCI device
- * @return UMA size if OK, -EINVAL on error
+ * Return: UMA size if OK, -EINVAL on error
*/
int intel_early_me_uma_size(struct udevice *me_dev);
* @dev: Northbridge device
* @me_dev: Management engine PCI device
* @status: Status result (ME_INIT_...)
- * @return 0 to continue to boot, -EINVAL on unknown result data, -ETIMEDOUT
+ * Return: 0 to continue to boot, -EINVAL on unknown result data, -ETIMEDOUT
* if ME did not respond
*/
int intel_early_me_init_done(struct udevice *dev, struct udevice *me_dev,
*
* Applies any microcode updates in the device tree.
*
- * @return 0 if OK, -EEXIST if the updates were already applied, -ENOENT if
+ * Return: 0 if OK, -EEXIST if the updates were already applied, -ENOENT if
* not updates were found, -EINVAL if an update was invalid
*/
int microcode_update_intel(void);
*
* This reads the microcode version of the currently running CPU
*
- * @return microcode version number
+ * Return: microcode version number
*/
int microcode_read_rev(void);
#endif /* __ASSEMBLY__ */
* all, or MP_SELECT_BSP for BSP
* @func: Function to run
* @arg: Argument to pass to the function
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int mp_run_on_cpus(int cpu_select, mp_run_func func, void *arg);
*
* This halts all CPUs except the main one, ready for the OS to use them
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mp_park_aps(void);
* -EFBIG.
*
* @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...)
- * @return next CPU number to run on (e.g. 0)
+ * Return: next CPU number to run on (e.g. 0)
*/
int mp_first_cpu(int cpu_select);
*
* @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...)
* @prev_cpu: Previous value returned by mp_first_cpu()/mp_next_cpu()
- * @return next CPU number to run on (e.g. 0)
+ * Return: next CPU number to run on (e.g. 0)
*/
int mp_next_cpu(int cpu_select, int prev_cpu);
#else
* @pei_data: Platform-specific data required by the MRC
* @use_asm_linkage: true if the call to MRC requires asmlinkage, false if it
* uses normal U-Boot calling
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mrc_common_init(struct udevice *dev, void *pei_data, bool use_asm_linkage);
* for setting up SDRAM
*
* @entry: Position and size of MRC cache in SPI flash
- * @return pointer to latest record, or NULL if none
+ * Return: pointer to latest record, or NULL if none
*/
struct mrc_data_container *mrccache_find_current(struct mrc_region *entry);
* This routine should be called by reserve_arch() before U-Boot is relocated
* when MRC cache is enabled.
*
- * @return 0 always
+ * Return: 0 always
*/
int mrccache_reserve(void);
* @type: Type of MRC data to use
* @devp: Returns pointer to the SPI flash device, if found
* @entry: Position and size of MRC cache in SPI flash
- * @return 0 if success, -ENOENT if SPI flash node does not exist in the
+ * Return: 0 if success, -ENOENT if SPI flash node does not exist in the
* device tree, -EPERM if MRC region subnode does not exist in the device
* tree, -EINVAL if MRC region properties format is incorrect, other error
* if SPI flash probe failed.
* This saves MRC data stored previously by gd->arch.mrc_output to a proper
* place within the MRC region on the SPI flash.
*
- * @return 0 if saved to SPI flash successfully, other error if failed
+ * Return: 0 if saved to SPI flash successfully, other error if failed
*/
int mrccache_save(void);
* data in SPL to avoid needing to pass it up to U-Boot proper to save. This
* function handles that.
*
- * @return 0 if saved to SPI flash successfully, other error if failed
+ * Return: 0 if saved to SPI flash successfully, other error if failed
*/
int mrccache_spl_save(void);
* @type: Requested type (MTRR_TYPE_)
* @start: Start address
* @size: Size, must be power of 2
- * @return 0 on success, -EINVAL if size is not power of 2,
+ * Return: 0 on success, -EINVAL if size is not power of 2,
* -ENOSPC if there are no more MTRRs
*/
int mtrr_set_next_var(uint type, uint64_t base, uint64_t size);
* @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...)
* @reg: MTRR register to write (0-7)
* @valid: Valid flag to write
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int mtrr_set_valid(int cpu_select, int reg, bool valid);
* @reg: MTRR register to write (0-7)
* @base: Base address and MTRR_BASE_TYPE_MASK
* @mask: Mask and MTRR_PHYS_MASK_VALID
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int mtrr_set(int cpu_select, int reg, u64 base, u64 mask);
*
* Some CPUs have more than 8 MTRRs. This function returns the actual number
*
- * @return number of variable MTRRs
+ * Return: number of variable MTRRs
*/
int mtrr_get_var_count(void);
*
* @dev: SATA device
* @idx: Register index to read
- * @return value read from register
+ * Return: value read from register
*/
u32 pch_common_sir_read(struct udevice *dev, int idx);
* @offset: Register offset to read
* @valuep: Place to put the returned value
* @size: Access size
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_x86_read_config(pci_dev_t bdf, uint offset, ulong *valuep,
enum pci_size_t size);
* @offset: Register offset to write
* @value: Value to write
* @size: Access size
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_x86_write_config(pci_dev_t bdf, uint offset, ulong value,
enum pci_size_t size);
* @offset: Register offset to update
* @clr: Bits to clear
* @set: Bits to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_x86_clrset_config(pci_dev_t bdf, uint offset, ulong clr, ulong set,
enum pci_size_t size);
* write_sfi_table() - Write Simple Firmware Interface tables
*
* @base: Address to write table to
- * @return address to use for the next table
+ * Return: address to use for the next table
*/
ulong write_sfi_table(ulong base);
* Multi-Processor table and ACPI table. Whether a specific type of
* configuration table is written is controlled by a Kconfig option.
*
- * @return 0 if OK, -ENOSPC if table too large
+ * Return: 0 if OK, -ENOSPC if table too large
*/
int write_tables(void);
* identify so that CPU functions can be used correctly, but does not change
* anything.
*
- * @return 0 (indicating success, to mimic cpu_init_f())
+ * Return: 0 (indicating success, to mimic cpu_init_f())
*/
int x86_cpu_reinit_f(void);
*
* This just sets up the CPU features and figured out the identity
*
- * @return 0 (indicating success, to mimic cpu_init_f())
+ * Return: 0 (indicating success, to mimic cpu_init_f())
*/
int x86_cpu_init_tpl(void);
* @kernel_size: Size of kernel including setup block (or 0 if the kernel is
* new enough to have a 'syssize' value)
* @load_addressp: Returns the address where the kernel has been loaded
- * @return address of setup block, or NULL if something went wrong
+ * Return: address of setup block, or NULL if something went wrong
*/
struct boot_params *load_zimage(char *image, unsigned long kernel_size,
ulong *load_addressp);
* BZIMAGE_LOAD_ADDR or ZIMAGE_LOAD_ADDR
* @cmdline_force: Address of 'override' command line, or 0 to use the one in
* the * setup block
- * @return 0 (always)
+ * Return: 0 (always)
*/
int setup_zimage(struct boot_params *setup_base, char *cmd_line, int auto_boot,
ulong initrd_addr, ulong initrd_size, ulong cmdline_force);
* @type: HOB type to search
* @hob_list: A pointer to the HOB list
*
- * @return A HOB object with matching type; Otherwise NULL.
+ * Return: A HOB object with matching type; Otherwise NULL.
*/
const struct hob_header *hob_get_next_hob(uint type, const void *hob_list)
{
* @guid: GUID to search
* @hob_list: A pointer to the HOB list
*
- * @return A HOB object with matching GUID; Otherwise NULL.
+ * Return: A HOB object with matching GUID; Otherwise NULL.
*/
const struct hob_header *hob_get_next_guid_hob(const efi_guid_t *guid,
const void *hob_list)
* If the GUID HOB is located, the length will be updated.
* @guid A pointer to HOB GUID.
*
- * @return NULL: Failed to find the GUID HOB.
- * @return others: GUID HOB data buffer pointer.
+ * Return: NULL: Failed to find the GUID HOB.
+ * Return: others: GUID HOB data buffer pointer.
*/
void *hob_get_guid_hob_data(const void *hob_list, u32 *len,
const efi_guid_t *guid)
* @data_size: Required data size of the new entry. Note that we assume that
* all cache entries are the same size
*
- * @return next cache entry if found, NULL if we got to the end
+ * Return: next cache entry if found, NULL if we got to the end
*/
static struct mrc_data_container *find_next_mrc_cache(struct mrc_region *entry,
struct mrc_data_container *prev, int data_size)
* @sf: SPI flash to write to
* @entry: Position and size of MRC cache in SPI flash
* @cur: Record to write
- * @return 0 if updated, -EEXIST if the record is the same as the latest
+ * Return: 0 if updated, -EEXIST if the record is the same as the latest
* record, -EINVAL if the record is not valid, other error if SPI write failed
*/
static int mrccache_update(struct udevice *sf, struct mrc_region *entry,
/**
* Return the FDT base address that was passed by ATF
*
- * @return FDT base address received from ATF in x1 register
+ * Return: FDT base address received from ATF in x1 register
*/
void *board_fdt_blob_setup(int *err)
{
/**
* Return the FDT base address that was passed by ATF
*
- * @return FDT base address received from ATF in x1 register
+ * Return: FDT base address received from ATF in x1 register
*/
void *board_fdt_blob_setup(int *err)
{
/**
* Return the virtual address of FDT that was passed by QEMU
*
- * @return virtual address of FDT received from QEMU in r3 register
+ * Return: virtual address of FDT received from QEMU in r3 register
*/
void *board_fdt_blob_setup(int *err)
{
* @param tpm TPM device
* @param index NV index of the area to get size for
* @param size pointer to the size
- * @return 0 on success, != 0 on error
+ * Return: 0 on success, != 0 on error
*/
static int get_tpm_nv_size(struct udevice *tpm, uint32_t index, uint32_t *size)
{
* @param auth usage auth of the key to search for
* @param pubkey_digest (SHA1) hash of the pub key structure of the key
* @param[out] handle the handle of the key iff found
- * @return 0 if key was found in TPM; != 0 if not.
+ * Return: 0 if key was found in TPM; != 0 if not.
*/
static int find_key(struct udevice *tpm, const uint8_t auth[20],
const uint8_t pubkey_digest[20], uint32_t *handle)
/**
* @brief read CCDM common data from TPM NV
* @param tpm TPM device
- * @return 0 if CCDM common data was found and read, !=0 if something failed.
+ * Return: 0 if CCDM common data was found and read, !=0 if something failed.
*/
static int read_common_data(struct udevice *tpm)
{
/**
* @brief get pointer to hash register by specification
* @param spec specification of a hash register
- * @return pointer to hash register or NULL if @a spec does not qualify a
+ * Return: pointer to hash register or NULL if @a spec does not qualify a
* valid hash register; NULL else.
*/
static struct h_reg *get_hreg(uint8_t spec)
* @param tpm TPM device
* @param spec specification of a hash register
* @param mode access mode (read or write or read/write)
- * @return pointer to hash register if found and valid; NULL else.
+ * Return: pointer to hash register if found and valid; NULL else.
*
* This func uses @a get_reg() to determine the hash register for a given spec.
* If a register is found it is validated according to the desired access mode.
* @param tpm TPM device
* @param[in,out] ip pointer to the opcode (instruction pointer)
* @param[in,out] code_size (remaining) size of the code
- * @return new instruction pointer on success, NULL on error.
+ * Return: new instruction pointer on success, NULL on error.
*/
static const uint8_t *hre_execute_op(struct udevice *tpm, const uint8_t **ip,
size_t *code_size)
* @param tpm TPM device
* @param code pointer to the (HRE) code.
* @param code_size size of the code (in bytes).
- * @return 0 on success, != 0 on failure.
+ * Return: 0 on success, != 0 on failure.
*/
int hre_run_program(struct udevice *tpm, const uint8_t *code, size_t code_size)
{
* EC - reading from the EC (backup)
*
* @dev: sysinfo device to use
- * @return SKU ID, or -ve error if not found
+ * Return: SKU ID, or -ve error if not found
*/
static int get_skuconfig(struct udevice *dev)
{
/**
* @brief board_init
*
- * @return 0
+ * Return: 0
*/
int board_init(void)
{
/**
* @brief board_init
*
- * @return 0
+ * Return: 0
*/
int board_init(void)
{
* such as power configurations, ethernet initialization as phase2 of
* boot sequence
*
- * @return 0
+ * Return: 0
*/
int misc_init_r(void)
{
* @brief board_usb_init - Configure EVM board specific configurations
* for the LDO's and clocks for the USB blocks.
*
- * @return 0
+ * Return: 0
*/
int board_usb_init(int index, enum usb_init_type init)
{
/**
* @brief board_init
*
- * @return 0
+ * Return: 0
*/
int board_init(void)
{
* such as power configurations, ethernet initialization as phase2 of
* boot sequence
*
- * @return 0
+ * Return: 0
*/
int misc_init_r(void)
{
/**
* @brief board_init
*
- * @return 0
+ * Return: 0
*/
int board_init(void)
{
* such as power configurations, ethernet initialization as phase2 of
* boot sequence
*
- * @return 0
+ * Return: 0
*/
int misc_init_r(void)
{
*
* @param[in] abc bootloader control block
*
- * @return crc32 sum
+ * Return: crc32 sum
*/
static uint32_t ab_control_compute_crc(struct bootloader_control *abc)
{
*
* @param[in] abc bootloader control block
*
- * @return 0 on success and a negative on error
+ * Return: 0 on success and a negative on error
*/
static int ab_control_default(struct bootloader_control *abc)
{
* @param[in] part_info Partition in 'dev_desc' where to read from, normally
* the "misc" partition should be used
* @param[out] pointer to pointer to bootloader_control data
- * @return 0 on success and a negative on error
+ * Return: 0 on success and a negative on error
*/
static int ab_control_create_from_disk(struct blk_desc *dev_desc,
const struct disk_partition *part_info,
* @param[in] part_info Partition on the 'dev_desc' where to write
* @param[in] abc Pointer to the boot control struct and the extra bytes after
* it up to the nearest block boundary
- * @return 0 on success and a negative on error
+ * Return: 0 on success and a negative on error
*/
static int ab_control_store(struct blk_desc *dev_desc,
const struct disk_partition *part_info,
*
* @param[in] a The first bootable slot metadata
* @param[in] b The second bootable slot metadata
- * @return Negative if the slot "a" is better, positive of the slot "b" is
+ * Return: Negative if the slot "a" is better, positive of the slot "b" is
* better or 0 if they are equally good.
*/
static int ab_compare_slots(const struct slot_metadata *a,
* @comp_type: Compression type being used (IH_COMP_...)
* @uncomp_size: Number of bytes uncompressed
* @ret: errno error code received from compression library
- * @return Appropriate BOOTM_ERR_ error code
+ * Return: Appropriate BOOTM_ERR_ error code
*/
static int handle_decomp_error(int comp_type, size_t uncomp_size, int ret)
{
/**
* bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
*
- * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
+ * Return: interrupt flag (0 if interrupts were disabled, non-zero if they were
* enabled)
*/
ulong bootm_disable_interrupts(void)
*
* @buf: Buffer containing the string to process
* @maxlen: Maximum length of buffer
- * @return 0 if OK, -ENOSPC if @maxlen is too small
+ * Return: 0 if OK, -ENOSPC if @maxlen is too small
*/
static int fixup_silent_linux(char *buf, int maxlen)
{
*
* @buf: Buffer containing the string to process
* @maxlen: Maximum length of buffer
- * @return 0 if OK, -ENOSPC if @maxlen is too small
+ * Return: 0 if OK, -ENOSPC if @maxlen is too small
*/
static int process_subst(char *buf, int maxlen)
{
* @param states Mask containing states to run (BOOTM_STATE_...)
* @param images Image header information
* @param boot_progress 1 to show boot progress, 0 to not do this
- * @return 0 if ok, something else on error. Some errors will cause this
+ * Return: 0 if ok, something else on error. Some errors will cause this
* function to perform a reboot! If states contains BOOTM_STATE_OS_GO
* then the intent is to boot an OS, so this function will not return
* unless the image type is standalone.
* function)
* @max_regions: Maximum number of regions in @region list
* @info: Place to put the region state
- * @return number of regions after processing, or -FDT_ERR_NOSPACE if we did
+ * Return: number of regions after processing, or -FDT_ERR_NOSPACE if we did
* not have enough room in the regions table for the regions we wanted to add.
*/
int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count,
* Check if image header is correct.
*
* @param hdr_addr Start address of DT image
- * @return true if header is correct or false if header is incorrect
+ * Return: true if header is correct or false if header is incorrect
*/
bool android_dt_check_header(ulong hdr_addr)
{
* @param[out] addr If not NULL, will contain address to specified FDT
* @param[out] size If not NULL, will contain size of specified FDT
*
- * @return true on success or false on error
+ * Return: true on success or false on error
*/
bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr,
u32 *size)
* @arch: expected ramdisk architecture
* @rd_datap: pointer to a ulong variable, will hold ramdisk pointer
* @rd_lenp: pointer to a ulong variable, will hold ramdisk length
- * @return 0 if OK, -ENOPKG if no ramdisk (but an error should not be reported),
+ * Return: 0 if OK, -ENOPKG if no ramdisk (but an error should not be reported),
* other -ve value on other error
*/
static int select_ramdisk(bootm_headers_t *images, const char *select, u8 arch,
* @select: name of FDT to select, or NULL for any
* @arch: expected FDT architecture
* @fdt_addrp: pointer to a ulong variable, will hold FDT pointer
- * @return 0 if OK, -ENOPKG if no FDT (but an error should not be reported),
+ * Return: 0 if OK, -ENOPKG if no FDT (but an error should not be reported),
* other -ve value on other error
*/
* /configurations/conf-1/kernel)
* @err_msgp: In the event of an error, this will be pointed to a
* help error string to display to the user.
- * @return 0 if all verified ok, <0 on error
+ * Return: 0 if all verified ok, <0 on error
*/
static int fit_config_check_sig(const void *fit, int noffset,
int required_keynode, int conf_noffset,
*
* @fit: FIT to check
* @parent: Parent node to check
- * @return 0 if OK, -EADDRNOTAVAIL is a node has a name containing '@'
+ * Return: 0 if OK, -EADDRNOTAVAIL is a node has a name containing '@'
*/
static int fdt_check_no_at(const void *fit, int parent)
{
/**
* fit_get_image_type_property() - get property name for IH_TYPE_...
*
- * @return the properly name where we expect to find the image in the
+ * Return: the properly name where we expect to find the image in the
* config node
*/
static const char *fit_get_image_type_property(int type)
* This will scan the translation table trying to find the entry that matches
* the given id.
*
- * @return long entry name if translation succeeds; error string on failure
+ * Return: long entry name if translation succeeds; error string on failure
*/
const char *genimg_get_cat_name(enum ih_category category, uint id)
{
* This will scan the translation table trying to find the entry that matches
* the given id.
*
- * @return short entry name if translation succeeds; error string on failure
+ * Return: short entry name if translation succeeds; error string on failure
*/
const char *genimg_get_cat_short_name(enum ih_category category, uint id)
{
* This will scan the translation table trying to find the entry that matches
* the given id.
*
- * @return true if category has entry id; false if not
+ * Return: true if category has entry id; false if not
*/
bool genimg_cat_has_id(enum ih_category category, uint id)
{
*
* @outbuf: Buffer to write string to
* @outbuf_len: length of buffer
- * @return 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no
+ * Return: 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no
* current ethernet device
*/
int format_mac_pxe(char *outbuf, size_t outbuf_len)
* find_table() - Look up an ACPI table
*
* @sig: Signature of table (4 characters, upper case)
- * @return pointer to table header, or NULL if not found
+ * Return: pointer to table header, or NULL if not found
*/
struct acpi_table_header *find_table(const char *sig)
{
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int do_cramfs_load(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int do_cramfs_ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
*
* @param argc Number of params remaining
* @param argv List of remaining parameters
- * @return flash region (EC_FLASH_REGION_...) or -1 on error
+ * Return: flash region (EC_FLASH_REGION_...) or -1 on error
*/
static int cros_ec_decode_region(int argc, char *const argv[])
{
* @param is_write 1 do to a write, 0 to do a read
* @param argc Number of arguments
* @param argv Arguments (2 is region, 3 is address)
- * @return 0 for ok, 1 for a usage error or -ve for ec command error
+ * Return: 0 for ok, 1 for a usage error or -ve for ec command error
* (negative EC_RES_...)
*/
static int do_read_write(struct udevice *dev, int is_write, int argc,
* @param str - pointer to string
* @param env - pointer to pointer to extracted env
*
- * @return - zero on successful expand and env is set
+ * Return: - zero on successful expand and env is set
*/
static int extract_env(const char *str, char **env)
{
* @param str - pointer to string with key=values pairs
* @param key - pointer to the key to search for
*
- * @return - pointer to allocated string with the value
+ * Return: - pointer to allocated string with the value
*/
static char *extract_val(const char *str, const char *key)
{
* @param str - pointer to string with key
* @param key - pointer to the key to search for
*
- * @return - true on found key
+ * Return: - true on found key
*/
static bool found_key(const char *str, const char *key)
{
* @param partitions - pointer to pointer to allocated partitions array
* @param parts_count - number of partitions
*
- * @return - zero on success, otherwise error
+ * Return: - zero on success, otherwise error
*
*/
static int set_gpt_info(struct blk_desc *dev_desc,
* @param argc
* @param argv
*
- * @return zero on success; otherwise error
+ * Return: zero on success; otherwise error
*/
static int do_gpt(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
* Check device number to be within valid range for given device type.
*
* @param dev device to validate
- * @return 0 if device is valid, 1 otherwise
+ * Return: 0 if device is valid, 1 otherwise
*/
static int mtd_device_validate(u8 type, u8 num, u32 *size)
{
* @param ret_id output pointer to next char after parse completes (output)
* @param dev_type parsed device type (output)
* @param dev_num parsed device number (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num)
{
/**
* Calculate sector size.
*
- * @return sector size
+ * Return: sector size
*/
static inline u32 get_part_sector_size_nand(struct mtdids *id)
{
* 'Static' version of command line mtdparts_init() routine. Single partition on
* a single device configuration.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int mtdparts_init(void)
{
*
* @param dev device that is to be searched for a partition
* @param part_num requested partition number
- * @return pointer to the part_info, NULL otherwise
+ * Return: pointer to the part_info, NULL otherwise
*/
static struct part_info* jffs2_part_info(struct mtd_device *dev, unsigned int part_num)
{
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int do_jffs2_fsload(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int do_jffs2_ls(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int do_jffs2_fsinfo(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
*
* @param ptr where parse begins
* @param retptr output pointer to next char after parse completes (output)
- * @return resulting unsigned int
+ * Return: resulting unsigned int
*/
static u64 memsize_parse (const char *const ptr, const char **retptr)
{
* @param type mtd type
* @param num mtd number
* @param mtd a pointer to an mtd_info instance (output)
- * @return 0 if device is valid, 1 otherwise
+ * Return: 0 if device is valid, 1 otherwise
*/
static int get_mtd_info(u8 type, u8 num, struct mtd_info **mtd)
{
*
* @param id of the parent device
* @param part partition to validate
- * @return 0 if partition is valid, 1 otherwise
+ * Return: 0 if partition is valid, 1 otherwise
*/
static int part_validate_eraseblock(struct mtdids *id, struct part_info *part)
{
*
* @param id of the parent device
* @param part partition to validate
- * @return 0 if partition is valid, 1 otherwise
+ * Return: 0 if partition is valid, 1 otherwise
*/
static int part_validate(struct mtdids *id, struct part_info *part)
{
*
* @param dev device to delete partition from
* @param part partition to delete
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int part_del(struct mtd_device *dev, struct part_info *part)
{
*
* @param dev device to which partition is added
* @param part partition to be added
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int part_add(struct mtd_device *dev, struct part_info *part)
{
* @param partdef pointer to the partition definition string i.e. <part-def>
* @param ret output pointer to next char after parse completes (output)
* @param retpart pointer to the allocated partition (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int part_parse(const char *const partdef, const char **ret, struct part_info **retpart)
{
* @param type mtd type
* @param num mtd number
* @param size a pointer to the size of the mtd device (output)
- * @return 0 if device is valid, 1 otherwise
+ * Return: 0 if device is valid, 1 otherwise
*/
static int mtd_device_validate(u8 type, u8 num, u64 *size)
{
* Delete all mtd devices from a supplied devices list, free memory allocated for
* each device and delete all device partitions.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int device_delall(struct list_head *head)
{
* from device list and device memory is freed.
*
* @param dev device to be deleted
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int device_del(struct mtd_device *dev)
{
*
* @param type device type
* @param num device number
- * @return NULL if requested device does not exist
+ * Return: NULL if requested device does not exist
*/
struct mtd_device *device_find(u8 type, u8 num)
{
* @param mtd_dev pointer to the device definition string i.e. <mtd-dev>
* @param ret output pointer to next char after parse completes (output)
* @param retdev pointer to the allocated device (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int device_parse(const char *const mtd_dev, const char **ret, struct mtd_device **retdev)
{
/**
* Initialize global device list.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int mtd_devices_init(void)
{
/*
* Search global mtdids list and find id of requested type and number.
*
- * @return pointer to the id if it exists, NULL otherwise
+ * Return: pointer to the id if it exists, NULL otherwise
*/
static struct mtdids* id_find(u8 type, u8 num)
{
*
* @param mtd_id string containing requested mtd_id
* @param mtd_id_len length of supplied mtd_id
- * @return pointer to the id if it exists, NULL otherwise
+ * Return: pointer to the id if it exists, NULL otherwise
*/
static struct mtdids* id_find_by_mtd_id(const char *mtd_id, unsigned int mtd_id_len)
{
* @param ret_id output pointer to next char after parse completes (output)
* @param dev_type parsed device type (output)
* @param dev_num parsed device number (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type,
u8 *dev_num)
*
* @param buf output buffer holding generated mtdparts string (output)
* @param buflen buffer size
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int generate_mtdparts(char *buf, u32 buflen)
{
*
* @param buf output buffer holding generated mtdparts string (output)
* @param buflen buffer size
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int generate_mtdparts_save(char *buf, u32 buflen)
{
*
* @param mtd the mtd info
* @param part the partition
- * @return the calculated net size of this partition
+ * Return: the calculated net size of this partition
*/
static uint64_t net_part_size(struct mtd_info *mtd, struct part_info *part)
{
* @param dev pointer to the requested device (output)
* @param part_num verified partition number (output)
* @param part pointer to requested partition (output)
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int find_dev_and_part(const char *id, struct mtd_device **dev,
u8 *part_num, struct part_info **part)
* Find and delete partition. For partition id format see find_dev_and_part().
*
* @param id string describing device and partition
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int delete_partition(const char *id)
{
* as big as their mtdparts environment variable sizes and they each start
* on a good block.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int spread_partitions(void)
{
* buffer. gd->env_buf will be too small.
*
* @param buf temporary buffer pointer MTDPARTS_MAXLEN long
- * @return mtdparts variable string, NULL if not found
+ * Return: mtdparts variable string, NULL if not found
*/
static const char *env_get_mtdparts(char *buf)
{
* for each entry. Add created devices to the global devices list.
*
* @param mtdparts string specifing mtd partitions
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int parse_mtdparts(const char *const mtdparts)
{
* to the global mtdids list.
*
* @param ids mapping string
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int parse_mtdids(const char *const ids)
{
* Parse and initialize global mtdids mapping and create global
* device/partition list.
*
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
int mtdparts_init(void)
{
*
* @param dev device that is to be searched for a partition
* @param part_num requested partition number
- * @return pointer to the part_info, NULL otherwise
+ * Return: pointer to the part_info, NULL otherwise
*/
static struct part_info* mtd_part_info(struct mtd_device *dev, unsigned int part_num)
{
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int do_chpart(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
* @param flag command flag
* @param argc number of arguments supplied to the command
* @param argv arguments list
- * @return 0 on success, 1 otherwise
+ * Return: 0 on success, 1 otherwise
*/
static int do_mtdparts(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
* get_pci_dev() - Convert the "bus.device.function" identifier into a number
*
* @name: Device string in the form "bus.device.function" where each is in hex
- * @return encoded pci_dev_t or -1 if the string was invalid
+ * Return: encoded pci_dev_t or -1 if the string was invalid
*/
static pci_dev_t get_pci_dev(char *name)
{
* @param dev pinctrl device
* @param name NULL to display all the pins
* or name of the pin to display
- * @return 0 on success, non-0 on error
+ * Return: 0 on success, non-0 on error
*/
static int show_pinmux(struct udevice *dev, char *name)
{
* @olen: Length of @old excluding terminator
* @new: New string to replace @old with
* @nlen: Length of @new excluding terminator
- * @return pointer to immediately after the copied @new in @string, or NULL if
+ * Return: pointer to immediately after the copied @new in @string, or NULL if
* no replacement took place
*/
static char *substitute(char *string, int *slen, int ssize,
*
* @param len amount of bytes currently processed
* @param start_ms start time of processing in ms
- * @return bytes per second if OK, 0 on error
+ * Return: bytes per second if OK, 0 on error
*/
static ulong bytes_per_second(unsigned int len, ulong start_ms)
{
* @param buf buffer to write from
* @param cmp_buf read buffer to use to compare data
* @param skipped Count of skipped data (incremented by this function)
- * @return NULL if OK, else a string containing the stage which failed
+ * Return: NULL if OK, else a string containing the stage which failed
*/
static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset,
size_t len, const char *buf, char *cmp_buf, size_t *skipped)
* @param offset flash offset to write
* @param len number of bytes to write
* @param buf buffer to write from
- * @return 0 if ok, 1 on error
+ * Return: 0 if ok, 1 on error
*/
static int spi_flash_update(struct spi_flash *flash, u32 offset,
size_t len, const char *buf)
* @param len Size of data to read/write
* @param offset Offset within flash to check
* @param vbuf Verification buffer
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
ulong offset, uint8_t *vbuf)
* NULL is passed, a large enough buffer will be allocated,
* and the caller must free it.
* @param count_ptr output variable for the length of byte string
- * @return pointer to output buffer
+ * Return: pointer to output buffer
*/
void *parse_byte_string(char *bytes, u8 *data, size_t *count_ptr)
{
* report_return_code() - Report any error and return failure or success
*
* @param return_code TPM command return code
- * @return value of enum command_ret_t
+ * Return: value of enum command_ret_t
*/
int report_return_code(int return_code)
{
* Return number of values defined by a type string.
*
* @param type_str type string
- * @return number of values of type string
+ * Return: number of values of type string
*/
int type_string_get_num_values(const char *type_str)
{
* Return total size of values defined by a type string.
*
* @param type_str type string
- * @return total size of values of type string, or 0 if type string
+ * Return: total size of values of type string, or 0 if type string
* contains illegal type character.
*/
size_t type_string_get_space_size(const char *type_str)
*
* @param type_str type string
* @param count pointer for storing size of buffer
- * @return pointer to buffer or NULL on error
+ * Return: pointer to buffer or NULL on error
*/
void *type_string_alloc(const char *type_str, u32 *count)
{
* @param type_str type string
* @param values text strings of values to be packed
* @param data output buffer of values
- * @return 0 on success, non-0 on error
+ * Return: 0 on success, non-0 on error
*/
int type_string_pack(const char *type_str, char * const values[],
u8 *data)
* @param type_str type string
* @param data input buffer of values
* @param vars names of environment variables
- * @return 0 on success, non-0 on error
+ * Return: 0 on success, non-0 on error
*/
int type_string_write_vars(const char *type_str, u8 *data,
char * const vars[])
* before starting to enter the password.
*
* @etime: Timeout value ticks (stop when get_ticks() reachs this)
- * @return 0 if autoboot should continue, 1 if it should stop
+ * Return: 0 if autoboot should continue, 1 if it should stop
*/
static int passwd_abort_crypt(uint64_t etime)
{
* This checks for the user entering a SHA256 hash within a given time.
*
* @etime: Timeout value ticks (stop when get_ticks() reachs this)
- * @return 0 if autoboot should continue, 1 if it should stop
+ * Return: 0 if autoboot should continue, 1 if it should stop
*/
static int passwd_abort_sha256(uint64_t etime)
{
* This checks for the user entering a string within a given time.
*
* @etime: Timeout value ticks (stop when get_ticks() reachs this)
- * @return 0 if autoboot should continue, 1 if it should stop
+ * Return: 0 if autoboot should continue, 1 if it should stop
*/
static int passwd_abort_key(uint64_t etime)
{
* sha256-fallback has been enabled via the config setting
* `AUTOBOOT_SHA256_FALLBACK`.
*
- * @return `false` if we must not fall-back, `true` if plain sha256 should be tried
+ * Return: `false` if we must not fall-back, `true` if plain sha256 should be tried
*/
static bool fallback_to_sha256(void)
{
* NOTE: Loading the environment early can be a bad idea if security is
* important, since no verification is done on the environment.
*
- * @return 0 if environment should not be loaded, !=0 if it is ok to load
+ * Return: 0 if environment should not be loaded, !=0 if it is ok to load
*/
static int should_load_env(void)
{
* @param buf Buffer to put name if needed
* @param len Length of buffer
* @param rec Boot stage record to get the name from
- * @return pointer to name, either from the record or pointing to buf.
+ * Return: pointer to name, either from the record or pointing to buf.
*/
static const char *get_record_name(char *buf, int len,
const struct bootstage_record *rec)
* Add all bootstage timings to a device tree.
*
* @param blob Device tree blob
- * @return 0 on success, != 0 on failure.
+ * Return: 0 on success, != 0 on failure.
*/
static int add_bootstages_devicetree(struct fdt_header *blob)
{
*
* @param cmd Command to run
* @param flag Execution flags (CMD_FLAG_...)
- * @return 0 on success, or != 0 on error.
+ * Return: 0 on success, or != 0 on error.
*/
int run_command(const char *cmd, int flag)
{
*
* @param cmd Command to run
* @param flag Execution flags (CMD_FLAG_...)
- * @return 0 (not repeatable) or 1 (repeatable) on success, -1 on error.
+ * Return: 0 (not repeatable) or 1 (repeatable) on success, -1 on error.
*/
int run_command_repeatable(const char *cmd, int flag)
{
* @param argc Number of arguments (arg 0 must be the command text)
* @param argv Arguments
* @param repeatable Can the command be repeated
- * @return 0 if command succeeded, else non-zero (CMD_RET_...)
+ * Return: 0 if command succeeded, else non-zero (CMD_RET_...)
*/
static int cmd_call(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[], int *repeatable)
* console_dev_is_serial() - Check if a stdio device is a serial device
*
* @sdev: Device to check
- * @return true if this device is in the serial uclass (or for pre-driver-model,
+ * Return: true if this device is in the serial uclass (or for pre-driver-model,
* whether it is called "serial".
*/
static bool console_dev_is_serial(struct stdio_dev *sdev)
/**
* Check if HDMI vendor specific data block is present in CEA block
* @param info CEA extension block
- * @return true if block is found
+ * Return: true if block is found
*/
static bool cea_is_hdmi_vsdb_present(struct edid_cea861_info *info)
{
* Snip the tailing whitespace/return of a string.
*
* @param string The string to be snipped
- * @return the snipped string
+ * Return: the snipped string
*/
static char *snip(char *string)
{
* fdt_valid() - Check if an FDT is valid. If not, change it to NULL
*
* @blobp: Pointer to FDT pointer
- * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL)
+ * Return: 1 if OK, 0 if bad (in which case *blobp is set to NULL)
*/
int fdt_valid(struct fdt_header **blobp)
{
* @allow_env_vars: non-zero to permit storing the result to an environment
* variable. If 0 then verify_str is assumed to be an
* address, and the * prefix is not expected.
- * @return 0 if ok, non-zero on error
+ * Return: 0 if ok, non-zero on error
*/
static int parse_verify_sum(struct hash_algo *algo, char *verify_str,
uint8_t *vsum, int allow_env_vars)
*
* @ldev: Log device to check
* @rec: Log record to check
- * @return true if @rec is not blocked by the filters in @ldev, false if it is
+ * Return: true if @rec is not blocked by the filters in @ldev, false if it is
*/
static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
{
* log_find_device_by_drv() - Find a device by its driver
*
* @drv: Log driver
- * @return Device associated with that driver, or NULL if not found
+ * Return: Device associated with that driver, or NULL if not found
*/
static struct log_device *log_find_device_by_drv(struct log_driver *drv)
{
* get_bootstage_id() - Get the bootstage ID to emit
*
* @start: true if this is for starting SPL, false for ending it
- * @return bootstage ID to use
+ * Return: bootstage ID to use
*/
static enum bootstage_id get_bootstage_id(bool start)
{
* @spl_image: Place to put the image details if successful
* @spl_boot_list: List of boot devices to try
* @count: Number of elements in spl_boot_list
- * @return 0 if OK, -ENODEV if there were no boot devices
+ * Return: 0 if OK, -ENODEV if there were no boot devices
* if CONFIG_SHOW_ERRORS is enabled, returns -ENXIO if there were
* devices but none worked
*/
* All of this is done using the same layout and alignments as done in
* board_init_f_init_reserve() / board_init_f_alloc_reserve().
*
- * @return new stack location, or 0 to use the same stack
+ * Return: new stack location, or 0 to use the same stack
*/
ulong spl_relocate_stack_gd(void)
{
* @name: stdio device name (e.g. "vidconsole")
* id: Uclass ID of device to look for (e.g. UCLASS_VIDEO)
* @sdevp: Returns stdout device, if found, else NULL
- * @return 0 if found, -ENOENT if no device found with that name, other -ve
+ * Return: 0 if found, -ENOENT if no device found with that name, other -ve
* on other error
*/
static int stdio_probe_device(const char *name, enum uclass_id id,
* @param[in] dev_part_str Input string argument, like "0.1#misc"
* @param[out] dev_desc Place to store the device description pointer
* @param[out] part_info Place to store the partition information
- * @return 0 on success, or a negative on error
+ * Return: 0 on success, or a negative on error
*/
static int part_get_info_by_dev_and_name(const char *dev_iface,
const char *dev_part_str,
* set_protective_mbr(): Set the EFI protective MBR
* @param dev_desc - block device descriptor
*
- * @return - zero on success, otherwise error
+ * Return: - zero on success, otherwise error
*/
static int set_protective_mbr(struct blk_desc *dev_desc)
{
* @if_type: Interface type
* @devnum: Device number (0 = first)
* @descp: Returns block device descriptor on success
- * @return 0 on success, -ENODEV if there is no such device and no device
+ * Return: 0 on success, -ENODEV if there is no such device and no device
* with a higher device number, -ENOENT if there is no such device but there
* is one with a higher number, or other -ve on other error.
*/
* @drv: Legacy block driver
* @devnum: Device number (0 = first)
* @descp: Returns block device descriptor on success
- * @return 0 on success, -ENODEV if there is no such device, -ENOSYS if the
+ * Return: 0 on success, -ENODEV if there is no such device, -ENOSYS if the
* driver does not provide a way to find a device, or other -ve on other
* error.
*/
* @scu SCU registers
* @uart_index UART index, 1-5
*
- * @return current setting for uart clock rate
+ * Return: current setting for uart clock rate
*/
static ulong ast2500_get_uart_clk_rate(struct ast2500_scu *scu, int uart_index)
{
* The result (the best config we could find), would also be returned
* in this structure.
*
- * @return The clock rate, when the resulting div_config is used.
+ * Return: The clock rate, when the resulting div_config is used.
*/
static ulong ast2500_calc_clock_config(ulong input_rate, ulong requested_rate,
struct ast2500_div_config *cfg)
/**
* @brief lookup PLL divider config by input/output rate
* @param[in] *pll - PLL descriptor
- * @return true - if PLL divider config is found, false - else
+ * Return: true - if PLL divider config is found, false - else
* The function caller shall fill "pll->in" and "pll->out",
* then this function will search the lookup table
* to find a valid PLL divider configuration.
* @base: base address of the mpfs system register.
* @clk_rate: the mpfs pll clock rate.
* @parent_name: a pointer to parent clock name.
- * @return zero on success, or a negative error code.
+ * Return: zero on success, or a negative error code.
*/
int mpfs_clk_register_cfgs(void __iomem *base, u32 clk_rate,
const char *parent_name);
* @base: base address of the mpfs system register.
* @clk_rate: the mpfs pll clock rate.
* @parent_name: a pointer to parent clock name.
- * @return zero on success, or a negative error code.
+ * Return: zero on success, or a negative error code.
*/
int mpfs_clk_register_periphs(void __iomem *base, u32 clk_rate,
const char *parent_name);
* @table: a pointer to clock divider table.
* @width: width of the divider bit field.
* @flags: common clock framework flags.
- * @return divider value on success, or a negative error code.
+ * Return: divider value on success, or a negative error code.
*/
int divider_get_val(unsigned long rate, unsigned long parent_rate,
const struct clk_div_table *table,
* @dev: Device that generated the data
* @type: Table type it refers to
* @start: The start of the data (the end is obtained from ctx->current)
- * @return 0 if OK, -ENOSPC if too many items, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOSPC if too many items, -ENOMEM if out of memory
*/
static int acpi_add_item(struct acpi_ctx *ctx, struct udevice *dev,
enum gen_type_t type, void *start)
* @start: Start position to put the sorted items. The items will follow each
* other in sorted order
* @type: Type of items to sort
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int sort_acpi_item_type(struct acpi_ctx *ctx, void *start,
enum gen_type_t type)
*
* @flags: Flags passed to device_remove()
* @drv_flags: Driver flags
- * @return 0 if the device should be removed,
+ * Return: 0 if the device should be removed,
* -EKEYREJECTED if @flags includes a flag in DM_REMOVE_ACTIVE_ALL but
* @drv_flags does not (indicates that this device has nothing to do for
* DMA shutdown or OS prepare)
* device_alloc_priv() - Allocate priv/plat data required by the device
*
* @dev: Device to process
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
static int device_alloc_priv(struct udevice *dev)
{
* @param of_match: List of compatible strings to match
* @param of_idp: Returns the match that was found
* @param compat: The compatible string to search for
- * @return 0 if there is a match, -ENOENT if no match
+ * Return: 0 if there is a match, -ENOENT if no match
*/
static int driver_check_compatible(const struct udevice_id *of_match,
const struct udevice_id **of_idp,
* @propname: name of the property to be searched.
* @len: requested length of property value
*
- * @return the property value on success, -EINVAL if the property does not
+ * Return: the property value on success, -EINVAL if the property does not
* exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
* property data isn't large enough.
*/
* @node: Node to scan
* @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
* flag. If false bind all drivers.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int dm_scan_fdt_node(struct udevice *parent, ofnode parent_node,
bool pre_reloc_only)
* uclass_add() - Create new uclass in list
* @id: Id number to create
* @ucp: Returns pointer to uclass, or NULL on error
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* The new uclass is added to the list. There must be only one uclass for
* each id.
* should allocate at least 32 bytes at pOut in advance.
* @param hash_type SHA1 or SHA256
*
- * @return 0 on Success, -1 on Failure (Timeout)
+ * Return: 0 on Success, -1 on Failure (Timeout)
*/
int ace_sha_hash_digest(const uchar * in_addr, uint buflen,
uchar * out_addr, uint hash_type);
*
* @ctxp: Pointer to the pointer of the context for hashing
* @caam_algo: Enum for SHA1 or SHA256
- * @return 0 if ok, -ENOMEM on error
+ * Return: 0 if ok, -ENOMEM on error
*/
static int caam_hash_init(void **ctxp, enum caam_hash_algos caam_algo)
{
* @size: Size of the buffer being hashed
* @is_last: 1 if this is the last update; 0 otherwise
* @caam_algo: Enum for SHA1 or SHA256
- * @return 0 if ok, -EINVAL on error
+ * Return: 0 if ok, -EINVAL on error
*/
static int caam_hash_update(void *hash_ctx, const void *buf,
unsigned int size, int is_last,
* @dest_buf: Pointer to the destination buffer where hash is to be copied
* @size: Size of the buffer being hashed
* @caam_algo: Enum for SHA1 or SHA256
- * @return 0 if ok, -EINVAL on error
+ * Return: 0 if ok, -EINVAL on error
*/
static int caam_hash_finish(void *hash_ctx, void *dest_buf,
int size, enum caam_hash_algos caam_algo)
* Secure memory run command
*
* @param sec_mem_cmd Secure memory command register
- * @return cmd_status Secure memory command status register
+ * Return: cmd_status Secure memory command status register
*/
uint32_t secmem_set_cmd(uint32_t sec_mem_cmd)
{
*
* @param page Number of the page to allocate.
* @param partition Number of the partition to allocate.
- * @return 0 on success, ERROR_IN_PAGE_ALLOC otherwise
+ * Return: 0 on success, ERROR_IN_PAGE_ALLOC otherwise
*/
int caam_page_alloc(uint8_t page_num, uint8_t partition_num)
{
* @param[in] part_name Info for which partition name to look for
* @param[in,out] response Pointer to fastboot response buffer
* @param[out] size If not NULL, will contain partition size
- * @return Partition number or negative value on error
+ * Return: Partition number or negative value on error
*/
static int getvar_get_part_info(const char *part_name, char *response,
size_t *size)
* @param[in] info Boot partition info
* @param[out] hdr Where to store read boot image header
*
- * @return Boot image header sectors count or 0 on error
+ * Return: Boot image header sectors count or 0 on error
*/
static lbaint_t fb_mmc_get_boot_header(struct blk_desc *dev_desc,
struct disk_partition *info,
* @param download_buffer Address to fastboot buffer with zImage in it
* @param download_bytes Size of fastboot buffer, in bytes
*
- * @return 0 on success or -1 on error
+ * Return: 0 on success or -1 on error
*/
static int fb_mmc_update_zimage(struct blk_desc *dev_desc,
void *download_buffer,
*
* @gpio: The numeric representation of the GPIO
* @desc: Returns description (desc->flags will always be 0)
- * @return 0 if found, -ENOENT if not found
+ * Return: 0 if found, -ENOENT if not found
*/
static int gpio_to_device(unsigned int gpio, struct gpio_desc *desc)
{
*
* @desc: GPIO description
* @flags: flags value to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int _dm_gpio_set_flags(struct gpio_desc *desc, ulong flags)
{
* in private data structure to use it later while enabling gpio.
*
* @dev: pointer to GPIO device
- * @return 0 on success and -ENOMEM on failure
+ * Return: 0 on success and -ENOMEM on failure
*/
static int iproc_get_gpio_pctrl_mapping(struct udevice *dev)
{
* GPIO banks are named A, B, C, ...
*
* @bank: Bank number (0, 1..n-1)
- * @return allocated string containing the name
+ * Return: allocated string containing the name
*/
static char *gpio_bank_name(int bank)
{
* GPIOs are named A, B, C, ..., Z, AA, BB, CC, ...
*
* @base_port: Base port number (0, 1..n-1)
- * @return allocated string containing the name
+ * Return: allocated string containing the name
*/
static char *gpio_port_name(int base_port)
{
*
* @ic_clk: Input clock in Hz
* @period_ns: Period to represent, in ns
- * @return calculated count
+ * Return: calculated count
*/
static uint calc_counts(uint ic_clk, uint period_ns)
{
* @ic_clk: IC clock speed in Hz
* @spk_cnt: Spike-suppression count
* @config: Returns value to use
- * @return 0 if OK, -EINVAL if the calculation failed due to invalid data
+ * Return: 0 if OK, -EINVAL if the calculation failed due to invalid data
*/
static int dw_i2c_calc_timing(struct dw_i2c *priv, enum i2c_speed_mode mode,
int ic_clk, int spk_cnt,
* @speed: Required i2c speed in Hz
* @bus_clk: Input clock to the I2C controller in Hz (e.g. IC_CLK)
* @config: Returns the config to use for this speed
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int calc_bus_speed(struct dw_i2c *priv, struct i2c_regs *regs, int speed,
ulong bus_clk, struct dw_i2c_speed_config *config)
* @i2c_base: Registers for the I2C controller
* @speed: Required i2c speed in Hz
* @bus_clk: Input clock to the I2C controller in Hz (e.g. IC_CLK)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int _dw_i2c_set_bus_speed(struct dw_i2c *priv, struct i2c_regs *i2c_base,
unsigned int speed, unsigned int bus_clk)
* @dev: I2C bus to check
* @speed_hz: Requested speed in Hz
* @config: Returns config to use for that speed
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dw_i2c_gen_speed_config(const struct udevice *dev, int speed_hz,
struct dw_i2c_speed_config *config);
* @offset: Byte offset within chip
* @offset_buf: Place to put byte offset
* @msg: Message buffer
- * @return 0 if OK, -EADDRNOTAVAIL if the offset length is 0. In that case the
+ * Return: 0 if OK, -EADDRNOTAVAIL if the offset length is 0. In that case the
* message is still set up but will not contain an offset.
*/
static int i2c_setup_offset(struct dm_i2c_chip *chip, uint offset,
* @bus: Bus to probe
* @chip_addr: Chip address to probe
* @flags: Flags for the chip
- * @return 0 if found, -ENOSYS if the driver is invalid, -EREMOTEIO if the chip
+ * Return: 0 if found, -ENOSYS if the driver is invalid, -EREMOTEIO if the chip
* does not respond to probe
*/
static int i2c_probe_chip(struct udevice *bus, uint chip_addr,
* calc_tick() - Calculate the duration of a clock cycle from the I2C speed
*
* @speed: The speed in Hz to calculate the clock cycle duration for.
- * @return The duration of a clock cycle in ns.
+ * Return: The duration of a clock cycle in ns.
*/
inline uint calc_tick(uint speed)
{
* twsi_get_base() - Get controller register base for specified adapter
*
* @adap: Adapter to get the register base for.
- * @return Register base for the specified adapter.
+ * Return: Register base for the specified adapter.
*/
static struct mvtwsi_registers *twsi_get_base(struct i2c_adapter *adap)
{
* @lc: The last value of the control register.
* @ls: The last value of the status register.
* @es: The expected value of the status register.
- * @return The generated error code.
+ * Return: The generated error code.
*/
inline uint mvtwsi_error(uint ec, uint lc, uint ls, uint es)
{
/*
* twsi_wait() - Wait for I2C bus interrupt flag and check status, or time out.
*
- * @return Zero if status is as expected, or a non-zero code if either a time
+ * Return: Zero if status is as expected, or a non-zero code if either a time
* out occurred, or the status was not the expected one.
*/
static int twsi_wait(struct mvtwsi_registers *twsi, int expected_status,
* @expected_status: The I2C bus status expected to be asserted after the
* operation completion.
* @tick: The duration of a clock cycle at the current I2C speed.
- * @return Zero if status is as expected, or a non-zero code if either a time
+ * Return: Zero if status is as expected, or a non-zero code if either a time
* out occurred or the status was not the expected one.
*/
static int twsi_start(struct mvtwsi_registers *twsi, int expected_status,
* @expected_status: The I2C bus status expected to be asserted after the
* operation completion.
* @tick: The duration of a clock cycle at the current I2C speed.
- * @return Zero if status is as expected, or a non-zero code if either a time
+ * Return: Zero if status is as expected, or a non-zero code if either a time
* out occurred or the status was not the expected one.
*/
static int twsi_send(struct mvtwsi_registers *twsi, u8 byte,
* @ack_flag: Flag that determines whether the received byte should
* be acknowledged by the controller or not (sent ACK/NAK).
* @tick: The duration of a clock cycle at the current I2C speed.
- * @return Zero if status is as expected, or a non-zero code if either a time
+ * Return: Zero if status is as expected, or a non-zero code if either a time
* out occurred or the status was not the expected one.
*/
static int twsi_recv(struct mvtwsi_registers *twsi, u8 *byte, int ack_flag,
*
* @twsi: The MVTWSI register structure to use.
* @tick: The duration of a clock cycle at the current I2C speed.
- * @return Zero if the operation succeeded, or a non-zero code if a time out
+ * Return: Zero if the operation succeeded, or a non-zero code if a time out
* occurred.
*/
static int twsi_stop(struct mvtwsi_registers *twsi, uint tick)
*
* @n: Parameter 'n' for the frequency calculation algorithm.
* @m: Parameter 'm' for the frequency calculation algorithm.
- * @return The I2C frequency corresponding to the passed m and n parameters.
+ * Return: The I2C frequency corresponding to the passed m and n parameters.
*/
static uint twsi_calc_freq(const int n, const int m)
{
* @twsi: The MVTWSI register structure to use.
* @requested_speed: The desired frequency the controller should run at
* in Hz.
- * @return The actual frequency the controller was configured to.
+ * Return: The actual frequency the controller was configured to.
*/
static uint __twsi_i2c_set_bus_speed(struct mvtwsi_registers *twsi,
uint requested_speed)
* @slaveadd: The I2C address to be set for the I2C master.
* @actual_speed: A output parameter that receives the actual frequency
* in Hz the controller was set to by the function.
- * @return Zero if the operation succeeded, or a non-zero code if a time out
+ * Return: Zero if the operation succeeded, or a non-zero code if a time out
* occurred.
*/
static void __twsi_i2c_init(struct mvtwsi_registers *twsi, int speed,
* @addr: The address byte to be sent.
* @tick: The duration of a clock cycle at the current
* I2C speed.
- * @return Zero if the operation succeeded, or a non-zero code if a time out or
+ * Return: Zero if the operation succeeded, or a non-zero code if a time out or
* unexpected I2C status occurred.
*/
static int i2c_begin(struct mvtwsi_registers *twsi, int expected_start_status,
* @twsi: The MVTWSI register structure to use.
* @chip: The chip address to probe.
* @tick: The duration of a clock cycle at the current I2C speed.
- * @return Zero if the operation succeeded, or a non-zero code if a time out or
+ * Return: Zero if the operation succeeded, or a non-zero code if a time out or
* unexpected I2C status occurred.
*/
static int __twsi_i2c_probe_chip(struct mvtwsi_registers *twsi, uchar chip,
* a size of at least 'length' bytes).
* @length: The amount of data to be read from the chip in bytes.
* @tick: The duration of a clock cycle at the current I2C speed.
- * @return Zero if the operation succeeded, or a non-zero code if a time out or
+ * Return: Zero if the operation succeeded, or a non-zero code if a time out or
* unexpected I2C status occurred.
*/
static int __twsi_i2c_read(struct mvtwsi_registers *twsi, uchar chip,
* @data: The buffer containing the data to be sent to the chip.
* @length: The length of data to be sent to the chip in bytes.
* @tick: The duration of a clock cycle at the current I2C speed.
- * @return Zero if the operation succeeded, or a non-zero code if a time out or
+ * Return: Zero if the operation succeeded, or a non-zero code if a time out or
* unexpected I2C status occurred.
*/
static int __twsi_i2c_write(struct mvtwsi_registers *twsi, uchar chip,
*
* @code status code
* @final_read true if this is the final read operation
- * @return true if arbitration has been lost, false if it hasn't been lost.
+ * Return: true if arbitration has been lost, false if it hasn't been lost.
*/
static int twsi_i2c_lost_arb(u8 code, int final_read)
{
*
* @base Base address of i2c registers
* @val value to write
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static u64 twsi_write_sw(void __iomem *base, u64 val)
{
*
* @base Base address of i2c registers
* @val value for eia and op, etc. to read
- * @return value of the register
+ * Return: value of the register
*/
static u64 twsi_read_sw(void __iomem *base, u64 val)
{
* Reads the TWSI Control Register
*
* @base Base address for i2c
- * @return 8-bit TWSI control register
+ * Return: 8-bit TWSI control register
*/
static u8 twsi_read_ctl(void __iomem *base)
{
* Read i2c status register
*
* @base Base address of i2c registers
- * @return value of status register
+ * Return: value of status register
*/
static u8 twsi_read_status(void __iomem *base)
{
* Waits for an i2c operation to complete
*
* @param base Base address of registers
- * @return 0 for success, 1 if timeout
+ * Return: 0 for success, 1 if timeout
*/
static int twsi_wait(void __iomem *base)
{
* Sends an i2c start condition
*
* @base base address of registers
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int twsi_start(void __iomem *base)
{
* Sends an i2c stop condition
*
* @base register base address
- * @return 0 for success, -1 if error
+ * Return: 0 for success, -1 if error
*/
static int twsi_stop(void __iomem *base)
{
* @slave_addr address of slave to write to
* @buffer Pointer to buffer to write
* @length Number of bytes in buffer to write
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int twsi_write_data(void __iomem *base, u8 slave_addr,
u8 *buffer, unsigned int length)
* @slave_addr i2c bus address to read from
* @buffer buffer to read into
* @length number of bytes to read
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int twsi_read_data(void __iomem *base, u8 slave_addr,
u8 *buffer, unsigned int length)
* @speed Speed to set
* @m_div Pointer to M divisor
* @n_div Pointer to N divisor
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static void twsi_calc_div(struct udevice *bus, ulong sclk, unsigned int speed,
int *m_div, int *n_div)
*
* @base Base address of twsi registers
* @slave_addr I2C slave address to configure this controller to
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int twsi_init(void __iomem *base, int slaveaddr)
{
* @bus i2c bus to transfer data over
* @msg Array of i2c messages
* @nmsgs Number of messages to send/receive
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int octeon_i2c_xfer(struct udevice *bus, struct i2c_msg *msg,
int nmsgs)
*
* @bus i2c bus to transfer data over
* @speed Speed in Hz to set
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int octeon_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
{
* Driver probe function
*
* @dev I2C device to probe
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int octeon_i2c_probe(struct udevice *dev)
{
* Wait til the byte transfer is completed.
*
* @param i2c- pointer to the appropriate i2c register bank.
- * @return I2C_OK, if transmission was ACKED
+ * Return: I2C_OK, if transmission was ACKED
* I2C_NACK, if transmission was NACKED
* I2C_NOK_TIMEOUT, if transaction did not complete in I2C_TIMEOUT_MS
*/
* @param keys List of keys that we have detected
* @param max_count Maximum number of keys to return
* @param samep Set to true if this scan repeats the last, else false
- * @return number of pressed keys, 0 for none, -EIO on error
+ * Return: number of pressed keys, 0 for none, -EIO on error
*/
static int check_for_keys(struct udevice *dev, struct key_matrix_key *keys,
int max_count, bool *samep)
* characters
*
* @param input Input configuration
- * @return 1, to indicate that we have something to look at
+ * Return: 1, to indicate that we have something to look at
*/
int cros_ec_kbc_check(struct input_config *input)
{
* @param blob Device tree blob
* @param node Node to decode from
* @param config Configuration data read from fdt
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int cros_ec_keyb_decode_fdt(struct udevice *dev,
struct cros_ec_keyb_priv *config)
* check_leds() - Check the keyboard LEDs and update them it needed
*
* @ret: Value to return
- * @return value of @ret
+ * Return: value of @ret
*/
static int i8042_kbd_update_leds(struct udevice *dev, int leds)
{
* Disables the keyboard so that key strokes no longer generate scancodes to
* the host.
*
- * @return 0 if ok, -1 if keyboard input was found while disabling
+ * Return: 0 if ok, -1 if keyboard input was found while disabling
*/
static int i8042_disable(void)
{
* wait for the keyboard to init. We do this only when a key is first
* read - see kbd_wait_for_fifo_init().
*
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
static int i8042_kbd_probe(struct udevice *dev)
{
* @param config Input state
* @param key Key code to process
* @param release 0 if a press, 1 if a release
- * @return pointer to keycode->ascii translation table that should be used
+ * Return: pointer to keycode->ascii translation table that should be used
*/
static struct input_key_xlate *process_modifier(struct input_config *config,
int key, int release)
* @param array Array to search
* @param count Number of elements in array
* @param key Key value to find
- * @return element where value was first found, -1 if none
+ * Return: element where value was first found, -1 if none
*/
static int array_search(int *array, int count, int key)
{
* @param count Number of elements to sort
* @param order Array containing ordering elements
* @param ocount Number of ordering elements
- * @return number of elements in dest that are in order (these will be at the
+ * Return: number of elements in dest that are in order (these will be at the
* start of dest).
*/
static int sort_array_by_ordering(int *dest, int count, int *order,
* be at least ANSI_CHAR_MAX bytes long, to allow for
* an ANSI sequence.
* @param max_chars Maximum number of characters to add to output_ch
- * @return number of characters output, if the key was converted, otherwise 0.
+ * Return: number of characters output, if the key was converted, otherwise 0.
* This may be larger than max_chars, in which case the overflow
* characters are not output.
*/
* ANSI sequences.
* @param max_chars Maximum number of characters to add to output_ch
* @param same Number of key codes which are the same
- * @return number of characters written into output_ch, or -1 if we would
+ * Return: number of characters written into output_ch, or -1 if we would
* exceed max_chars chars.
*/
static int input_keycodes_to_ascii(struct input_config *config,
* @param config Keyboard matrix config
* @param keys List of keys to check
* @param valid Number of valid keypresses to check
- * @return 0 if no ghosting is possible, 1 if it is
+ * Return: 0 if no ghosting is possible, 1 if it is
*/
static int has_ghosting(struct key_matrix *config, struct key_matrix_key *keys,
int valid)
* @param len Number of entries in keycode table
* @param map_keycode Key code to find in the map
* @param pos Returns position of map_keycode, if found, else -1
- * @return map Pointer to allocated map
+ * Return: map Pointer to allocated map
*/
static uchar *create_keymap(struct key_matrix *config, const u32 *data, int len,
int map_keycode, int *pos)
* @param priv Keyboard private data
* @param fifo Place to put fifo results
* @param max_keycodes Maximum number of key codes to put in the fifo
- * @return number of items put into fifo
+ * Return: number of items put into fifo
*/
static int tegra_kbc_find_keys(struct tegra_kbd_priv *priv, int *fifo,
int max_keycodes)
* characters
*
* @param input Input configuration
- * @return 1, to indicate that we have something to look at
+ * Return: 1, to indicate that we have something to look at
*/
static int tegra_kbc_check(struct input_config *input)
{
* wait for the keyboard to init. We do this only when a key is first
* read - see kbd_wait_for_fifo_init().
*
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
static int tegra_kbd_probe(struct udevice *dev)
{
*
* @param data Data block to checksum
* @param size Size of data block in bytes
- * @return checksum value (0 to 255)
+ * Return: checksum value (0 to 255)
*/
int cros_ec_calc_checksum(const uint8_t *data, int size)
{
* @param cmd_version Version of command to send (EC_VER_...)
* @param dout Output data (may be NULL If dout_len=0)
* @param dout_len Size of output data in bytes
- * @return packet size in bytes, or <0 if error.
+ * Return: packet size in bytes, or <0 if error.
*/
static int create_proto3_request(struct cros_ec_dev *cdev,
int cmd, int cmd_version,
*
* @param dev CROS-EC device
* @param din_len Maximum size of response in bytes
- * @return maximum expected number of bytes in response, or <0 if error.
+ * Return: maximum expected number of bytes in response, or <0 if error.
*/
static int prepare_proto3_response_buffer(struct cros_ec_dev *cdev, int din_len)
{
* @param dev CROS-EC device
* @param dinp Returns pointer to response data
* @param din_len Maximum size of response in bytes
- * @return number of bytes of response data, or <0 if error. Note that error
+ * Return: number of bytes of response data, or <0 if error. Note that error
* codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they
* overlap!)
*/
* If not NULL, it will be updated to point to the data
* and will always be double word aligned (64-bits)
* @param din_len Maximum size of response in bytes
- * @return number of bytes in response, or -ve on error
+ * Return: number of bytes in response, or -ve on error
*/
static int ec_command_inptr(struct udevice *dev, uint cmd,
int cmd_version, const void *dout, int dout_len,
* It not NULL, it is a place for ec_command() to copy the
* data to.
* @param din_len Maximum size of response in bytes
- * @return number of bytes in response, or -ve on error
+ * Return: number of bytes in response, or -ve on error
*/
static int ec_command(struct udevice *dev, uint cmd, int cmd_version,
const void *dout, int dout_len,
* @param data Pointer to data buffer to write
* @param offset Offset within flash to write to.
* @param size Number of bytes to write
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int cros_ec_flash_write_block(struct udevice *dev, const uint8_t *data,
uint32_t offset, uint32_t size)
*
* @param data Pointer to data to check (must be word-aligned)
* @param size Number of bytes to check (must be word-aligned)
- * @return 0 if erased, non-zero if any word is not erased
+ * Return: 0 if erased, non-zero if any word is not erased
*/
static int cros_ec_data_is_erased(const uint32_t *data, int size)
{
*
* @param me CrosEc instance
* @param region Region to run verification on
- * @return 0 if success or not applicable. Non-zero if verification failed.
+ * Return: 0 if success or not applicable. Non-zero if verification failed.
*/
int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region)
{
* @param data Pointer to data buffer to read into
* @param offset Offset within flash to read from
* @param size Number of bytes to read
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int cros_ec_flash_read_block(struct udevice *dev, uint8_t *data,
uint32_t offset, uint32_t size)
*
* @param dev CROS_EC device
* @param blob Device tree blob
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_lpc_init(struct cros_ec_dev *dev, const void *blob)
{
*
* @param ec Current emulated EC state
* @param entry Flash map entry containing the image to check
- * @return actual image size in bytes, 0 if the image contains no content or
+ * Return: actual image size in bytes, 0 if the image contains no content or
* error.
*/
static int get_image_used(struct ec_state *ec, struct fmap_entry *entry)
*
* @param ec Current emulated EC state
* @param node Keyboard node of device tree containing keyscan information
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int keyscan_read_fdt_matrix(struct ec_state *ec, ofnode node)
{
* @param ec Current emulated EC state
* @param scan Place to put keyscan bytes for the keyscan message (must hold
* enough space for a full keyscan)
- * @return number of bytes of valid scan data
+ * Return: number of bytes of valid scan data
*/
static int cros_ec_keyscan(struct ec_state *ec, uint8_t *scan)
{
* @param req_data Pointer to body of request
* @param resp_hdr Pointer to place to put response header
* @param resp_data Pointer to place to put response data, if any
- * @return length of response data, or 0 for no response data, or -1 on error
+ * Return: length of response data, or 0 for no response data, or -1 on error
*/
static int process_cmd(struct ec_state *ec,
struct ec_host_request *req_hdr, const void *req_data,
* @param dinp Returns pointer to response data. This will be
* untouched unless we return a value > 0.
* @param din_len Maximum size of response in bytes
- * @return number of bytes in response, or -1 on error
+ * Return: number of bytes in response, or -1 on error
*/
int cros_ec_spi_command(struct udevice *udev, uint8_t cmd, int cmd_version,
const uint8_t *dout, int dout_len,
* @data: additional data to send/receive
* @retries: how many times to retry; mmc_send_cmd is always called at least
* once
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
static int mmc_send_cmd_retry(struct mmc *mmc, struct mmc_cmd *cmd,
struct mmc_data *data, uint retries)
* @quirk: retry only if this quirk is enabled
* @retries: how many times to retry; mmc_send_cmd is always called at least
* once
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
static int mmc_send_cmd_quirks(struct mmc *mmc, struct mmc_cmd *cmd,
struct mmc_data *data, u32 quirk, uint retries)
/**
* mmc_get_next_devnum() - Get the next available MMC device number
*
- * @return next available device number (0 = first), or -ve on error
+ * Return: next available device number (0 = first), or -ve on error
*/
int mmc_get_next_devnum(void);
*
* @mmc: MMC device
* @part_num: Hardware partition number
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
* @set: Unused
* @index: Cmdarg index
* @value: Cmdarg value
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_switch(struct mmc *mmc, u8 set, u8 index, u8 value);
* @resp_match: if true, compare each of received bytes with @resp_match_value
* @resp_match_value: a value to be compared with each of received bytes
* @r1b: if true, receive additional bytes for busy signal token
- * @return 0 if OK, -ETIMEDOUT if no card response is received, -ve on error
+ * Return: 0 if OK, -ETIMEDOUT if no card response is received, -ve on error
*/
static int mmc_spi_sendcmd(struct udevice *dev,
ushort cmdidx, u32 cmdarg, u32 resp_type,
* @xbuf: buffer of the actual data (excluding token and crc) to read
* @bcnt: number of data blocks to transfer
* @bsize: size of the actual data (excluding token and crc) in bytes
- * @return 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors
+ * Return: 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors
*/
static int mmc_spi_readdata(struct udevice *dev,
void *xbuf, u32 bcnt, u32 bsize)
* @bcnt: number of data blocks to transfer
* @bsize: size of actual data (excluding token and crc) in bytes
* @multi: indicate a transfer by multiple block write command (CMD25)
- * @return 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors
+ * Return: 0 if OK, -ECOMM if crc error, -ETIMEDOUT on other errors
*/
static int mmc_spi_writedata(struct udevice *dev, const void *xbuf,
u32 bcnt, u32 bsize, int multi)
* @param mmc mmc device
* @param cmd command information
*
- * @return octeontx_mmc_cr_mods data structure with various quirks and flags
+ * Return: octeontx_mmc_cr_mods data structure with various quirks and flags
*/
static struct octeontx_mmc_cr_mods
octeontx_mmc_get_cr_mods(struct mmc *mmc, const struct mmc_cmd *cmd,
* @param mmc mmc device
* @param timeout timeout in ms
*
- * @return 0 for success (could be DMA errors), -ETIMEDOUT on timeout
+ * Return: 0 for success (could be DMA errors), -ETIMEDOUT on timeout
*/
/**
* @param timeout timeout in ms
* @param verbose true to print out error information
*
- * @return 0 for success (could be DMA errors), -ETIMEDOUT on timeout
+ * Return: 0 for success (could be DMA errors), -ETIMEDOUT on timeout
* or -EIO if IO error.
*/
static int octeontx_mmc_wait_dma(struct mmc *mmc, bool write, ulong timeout,
* @param data data for read
* @param verbose true to print out error information
*
- * @return number of blocks read or 0 if error
+ * Return: number of blocks read or 0 if error
*/
static int octeontx_mmc_read_blocks(struct mmc *mmc, struct mmc_cmd *cmd,
struct mmc_data *data, bool verbose)
* @param cmd cmd to send and response
* @param data additional data
* @param flags
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
static int octeontx_mmc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd,
struct mmc_data *data)
* @param adj parameter to tune
* @param opcode command opcode to use
*
- * @return 0 for success, -1 if tuning failed
+ * Return: 0 for success, -1 if tuning failed
*/
static int octeontx_mmc_adjust_tuning(struct mmc *mmc, struct adj *adj,
u32 opcode)
* Calculate the clock period with rounding up
*
* @param mmc mmc device
- * @return clock period in system clocks for clk_lo + clk_hi
+ * Return: clock period in system clocks for clk_lo + clk_hi
*/
static u32 octeontx_mmc_calc_clk_period(struct mmc *mmc)
{
*
* @param mmc Pointer to mmc data structure
*
- * @return 0 for success or -ETIMEDOUT on error
+ * Return: 0 for success or -ETIMEDOUT on error
*
* NOTE: On error a default value will be calculated.
*/
* @param mmc mmc data structure
* @param delay delay in picoseconds
*
- * @return Number of tap cycles or error if -1
+ * Return: Number of tap cycles or error if -1
*/
static int octeontx2_mmc_calc_delay(struct mmc *mmc, int delay)
{
*
* @param mmc mmc data structure
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
static int octeontx_mmc_set_output_bus_timing(struct mmc *mmc)
{
*
* @param mmc mmc device
*
- * @return 0 for success
+ * Return: 0 for success
*
* NOTE: This will need to be updated when new silicon comes out
*/
*
* @param mmc mmc device
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
static int octeontx_mmc_init_lowlevel(struct mmc *mmc)
{
*
* @param voltage voltage in microvolts
*
- * @return MMC register value for voltage
+ * Return: MMC register value for voltage
*/
static u32 xlate_voltage(u32 voltage)
{
*
* @param dev slot device to check
*
- * @return true if status reports "ok" or "okay" or if no status,
+ * Return: true if status reports "ok" or "okay" or if no status,
* false otherwise.
*/
static bool octeontx_mmc_get_valid(struct udevice *dev)
*
* @param dev slot device
*
- * @return 0 on success, otherwise error
+ * Return: 0 on success, otherwise error
*/
static int octeontx_mmc_get_config(struct udevice *dev)
{
*
* @param dev mmc device
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
static int octeontx_mmc_slot_probe(struct udevice *dev)
{
*
* @param dev mmc host controller device
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
static int octeontx_mmc_host_probe(struct udevice *dev)
{
*
* @param dev: MMC slot device
*
- * @return 0 for success, -1 on failure
+ * Return: 0 for success, -1 on failure
*
* Do some pre-initialization before probing a slot.
*/
/**
* sdhci_adma_init() - initialize the ADMA descriptor table
*
- * @return pointer to the allocated descriptor table or NULL in case of an
+ * Return: pointer to the allocated descriptor table or NULL in case of an
* error.
*/
struct sdhci_adma_desc *sdhci_adma_init(void)
* @altname: Alternate name to return
* @max_len: Length of the alternate name buffer
*
- * @return 0 on success, an error otherwise.
+ * Return: 0 on success, an error otherwise.
*/
int mtd_search_alternate_name(const char *mtdname, char *altname,
unsigned int max_len)
* @param mtd an MTD device
* @param offset offset in flash
* @param length image length
- * @return image length including bad blocks in *len_incl_bad and whether or not
+ * Return: image length including bad blocks in *len_incl_bad and whether or not
* the length returned was truncated in *truncated
*/
void mtd_get_len_incl_bad(struct mtd_info *mtd, uint64_t offset,
* @mtdparts: String describing the partition with mtdparts command syntax
* @partition: MTD partition structure to fill
*
- * @return 0 on success, an error otherwise.
+ * Return: 0 on success, an error otherwise.
*/
static int mtd_parse_partition(const char **_mtdparts,
struct mtd_partition *partition)
* caller.
* @_nparts: Size of @_parts array.
*
- * @return 0 on success, an error otherwise.
+ * Return: 0 on success, an error otherwise.
*/
int mtd_parse_partitions(struct mtd_info *parent, const char **_mtdparts,
struct mtd_partition **_parts, int *_nparts)
* Read one byte from the chip
*
* @param mtd MTD device structure
- * @return data byte
+ * Return: data byte
*
* Read function for 8bit bus-width
*/
* Set up NAND bus width and page size
*
* @param info nand_info structure
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int set_bus_width_page_size(struct mtd_info *mtd)
{
* @param page page number
* @param with_ecc 1 to enable ECC, 0 to disable ECC
* @param is_writing 0 for read, 1 for write
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -ETIMEDOUT when command timeout
*/
static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip,
* @param chip nand chip info structure
* @param buf buffer to store read data
* @param page page number to read
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -ETIMEDOUT when command timeout
*/
static int nand_read_page_hwecc(struct mtd_info *mtd,
* @param mtd mtd info structure
* @param chip nand chip info structure
* @param buf data buffer
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -ETIMEDOUT when command timeout
*/
static int nand_write_page_hwecc(struct mtd_info *mtd,
* @param chip nand chip info structure
* @param buf buffer to store read data
* @param page page number to read
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -ETIMEDOUT when command timeout
*/
static int nand_read_page_raw(struct mtd_info *mtd,
* @param mtd mtd info structure
* @param chip nand chip info structure
* @param buf data buffer
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -ETIMEDOUT when command timeout
*/
static int nand_write_page_raw(struct mtd_info *mtd,
* @param page page number to read
* @param with_ecc 1 to enable ECC, 0 to disable ECC
* @param is_writing 0 for read, 1 for write
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -ETIMEDOUT when command timeout
*/
static int nand_rw_oob(struct mtd_info *mtd, struct nand_chip *chip,
* @param mtd mtd info structure
* @param chip nand chip info structure
* @param page page number to write
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -ETIMEDOUT when command timeout
*/
static int nand_write_oob(struct mtd_info *mtd, struct nand_chip *chip,
* config oob layout
*
* @param chip nand chip info structure
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -EINVAL when ECC bytes exceed OOB size
*/
static int nand_config_oob_layout(struct nand_chip *nand)
*
* @param mtd nand mtd instance to erase
* @param opts options, @see struct nand_erase_options
- * @return 0 in case of success
+ * Return: 0 in case of success
*
* This code is ported from flash_eraseall.c from Linux mtd utils by
* Arcom Control System Ltd.
* @param mtd nand mtd instance
* @param tight bring device in lock tight mode
*
- * @return 0 on success, -1 in case of error
+ * Return: 0 on success, -1 in case of error
*
* The lock / lock-tight command only applies to the whole chip. To get some
* parts of the chip lock and others unlocked use the following sequence:
* @param mtd nand mtd instance
* @param offset page address to query (must be page-aligned!)
*
- * @return -1 in case of error
+ * Return: -1 in case of error
* >0 lock status:
* bitfield with the following combinations:
* NAND_LOCK_STATUS_TIGHT: page in tight state
* page size mtd->writesize)
* @param allexcept if set, unlock everything not selected
*
- * @return 0 on success, -1 in case of error
+ * Return: 0 on success, -1 in case of error
*/
int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
int allexcept)
* @param offset offset in flash
* @param length image length
* @param used length of flash needed for the requested length
- * @return 0 if the image fits and there are no bad blocks
+ * Return: 0 if the image fits and there are no bad blocks
* 1 if the image fits, but there are bad blocks
* -1 if the image does not fit
*/
* @param mtd nand mtd instance
* @param ops MTD operations, including data to verify
* @param ofs offset in flash
- * @return 0 in case of success
+ * Return: 0 in case of success
*/
int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
loff_t ofs)
* @param ofs offset in flash
* @param len buffer length
* @param buf buffer to read from
- * @return 0 in case of success
+ * Return: 0 in case of success
*/
int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf)
{
* exceed the buffer
* @param buffer buffer to read from
* @param flags flags modifying the behaviour of the write to NAND
- * @return 0 in case of success
+ * Return: 0 in case of success
*/
int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
size_t *actual, loff_t lim, u_char *buffer, int flags)
* @param lim maximum size that actual may be in order to not exceed the
* buffer
* @param buffer buffer to write to
- * @return 0 in case of success
+ * Return: 0 in case of success
*/
int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
size_t *actual, loff_t lim, u_char *buffer)
* @param buf buffer to check
* @param patt the pattern to check
* @param size buffer size in bytes
- * @return 1 if there are only patt bytes in buf
+ * Return: 1 if there are only patt bytes in buf
* 0 if something else was found
*/
static int check_pattern(const u_char *buf, u_char patt, int size)
*
* @param mtd nand mtd instance
* @param offset offset in flash
- * @return 0 if the block is still good
+ * Return: 0 if the block is still good
*/
int nand_torture(struct mtd_info *mtd, loff_t offset)
{
* @param[out] ecc 8-byte aligned pointer to where ecc data should go
* @param[in] resp pointer to where responses will be written.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size,
u8 bch_level, dma_addr_t ecc, dma_addr_t resp)
* This should not be the same as block_ecc_in.
* @param[in] resp pointer to where responses will be written.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int octeontx_bch_decode(struct bch_vf *vf, dma_addr_t block_ecc_in,
* @param[out] ecc 8-byte aligned pointer to where ecc data should go
* @param[in] resp pointer to where responses will be written.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int octeontx_bch_encode(struct bch_vf *vf, dma_addr_t block, u16 block_size,
u8 bch_level, dma_addr_t ecc, dma_addr_t resp);
* This should not be the same as block_ecc_in.
* @param[in] resp pointer to where responses will be written.
*
- * @return Zero on success, negative on failure.
+ * Return: Zero on success, negative on failure.
*/
int octeontx_bch_decode(struct bch_vf *vf, dma_addr_t block_ecc_in,
* In this case, the initial probe returns success but the actual probing
* is deferred until the BCH VF has been probed.
*
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
int octeontx_pci_nand_deferred_probe(void);
* In this case, the initial probe returns success but the actual probing
* is deferred until the BCH VF has been probed.
*
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
int octeontx_pci_nand_deferred_probe(void)
{
* @read_ecc: ecc read from nand flash
* @calc_ecc: ecc read from ECC registers
*
- * @return 0 if data is OK or corrected, else returns -1
+ * Return: 0 if data is OK or corrected, else returns -1
*/
static int __maybe_unused omap_correct_data(struct mtd_info *mtd, uint8_t *dat,
uint8_t *read_ecc, uint8_t *calc_ecc)
* @read_ecc: ecc read from nand flash (ignored)
* @calc_ecc: ecc read from ECC registers
*
- * @return 0 if data is OK or corrected, else returns -1
+ * Return: 0 if data is OK or corrected, else returns -1
*/
static int omap_correct_data_bch(struct mtd_info *mtd, uint8_t *dat,
uint8_t *read_ecc, uint8_t *calc_ecc)
* Read one byte from the chip
*
* @param mtd MTD device structure
- * @return data byte
+ * Return: data byte
*
* Read function for 8bit bus-width
*/
*
* @param info nand_info structure
* @param *reg_val address of reg_val
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int set_bus_width_page_size(struct mtd_info *our_mtd,
struct fdt_nand *config, u32 *reg_val)
* @param page page number
* @param with_ecc 1 to enable ECC, 0 to disable ECC
* @param is_writing 0 for read, 1 for write
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -EIO when command timeout
*/
static int nand_rw_page(struct mtd_info *mtd, struct nand_chip *chip,
* @param chip nand chip info structure
* @param buf buffer to store read data
* @param page page number to read
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -EIO when command timeout
*/
static int nand_read_page_hwecc(struct mtd_info *mtd,
* @param chip nand chip info structure
* @param buf buffer to store read data
* @param page page number to read
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -EINVAL when chip->oob_poi is not double-word aligned
* -EIO when command timeout
*/
* @param page page number to read
* @param with_ecc 1 to enable ECC, 0 to disable ECC
* @param is_writing 0 for read, 1 for write
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -EINVAL when chip->oob_poi is not double-word aligned
* -EIO when command timeout
*/
* @param mtd mtd info structure
* @param chip nand chip info structure
* @param page page number to write
- * @return 0 when successfully completed
+ * Return: 0 when successfully completed
* -EINVAL when chip->oob_poi is not double-word aligned
* -EIO when command timeout
*/
*
* @param dev Driver model device
* @param config Device tree NAND configuration
- * @return 0 if ok, -ve on error (FDT_ERR_...)
+ * Return: 0 if ok, -ve on error (FDT_ERR_...)
*/
static int fdt_decode_nand(struct udevice *dev, struct fdt_nand *config)
{
* onenand_block_address - [DEFAULT] Get block address
* @param device the device id
* @param block the block
- * @return translated block address if DDP, otherwise same
+ * Return: translated block address if DDP, otherwise same
*
* Setup Start Address 1 Register (F100h)
*/
* onenand_bufferram_address - [DEFAULT] Get bufferram address
* @param device the device id
* @param block the block
- * @return set DBS value if DDP, otherwise 0
+ * Return: set DBS value if DDP, otherwise 0
*
* Setup Start Address 2 Register (F101h) for DDP
*/
* onenand_page_address - [DEFAULT] Get page address
* @param page the page address
* @param sector the sector address
- * @return combined page and sector address
+ * Return: combined page and sector address
*
* Setup Start Address 8 Register (F107h)
*/
* @param dataram1 DataRAM index
* @param sectors the sector address
* @param count the number of sectors
- * @return the start buffer value
+ * Return: the start buffer value
*
* Setup Start Buffer Register (F200h)
*/
* onenand_bufferram_offset - [DEFAULT] BufferRAM offset
* @param mtd MTD data structure
* @param area BufferRAM area
- * @return offset given area
+ * Return: offset given area
*
* Return BufferRAM offset given area
*/
* onenand_get_2x_blockpage - [GENERIC] Get blockpage at 2x program mode
* @param mtd MTD data structure
* @param addr address to check
- * @return blockpage address
+ * Return: blockpage address
*
* Get blockpage address at 2x program mode
*/
* onenand_check_bufferram - [GENERIC] Check BufferRAM information
* @param mtd MTD data structure
* @param addr address to check
- * @return 1 if there are valid data, otherwise 0
+ * Return: 1 if there are valid data, otherwise 0
*
* Check bufferram if there is data we required
*/
* @param[in] fec all we know about the device yet
* @param[in] count receive buffer count to be allocated
* @param[in] dsize desired size of each receive buffer
- * @return 0 on success
+ * Return: 0 on success
*
* Init all RX descriptors to default values.
*/
* @param[in] dev Our ethernet device to handle
* @param[in] packet Pointer to the data to be transmitted
* @param[in] length Data count in bytes
- * @return 0 on success
+ * Return: 0 on success
*/
#ifdef CONFIG_DM_ETH
static int fecmxc_send(struct udevice *dev, void *packet, int length)
/**
* Pull one frame from the card
* @param[in] dev Our ethernet device to handle
- * @return Length of packet read
+ * Return: Length of packet read
*/
#ifdef CONFIG_DM_ETH
static int fecmxc_recv(struct udevice *dev, int flags, uchar **packetp)
*
* @param instance instance to find
*
- * @return pointer to lmac data structure or NULL if not found
+ * Return: pointer to lmac data structure or NULL if not found
*/
struct lmac *nix_get_cgx_lmac(int lmac_instance)
{
*
* @param instance instance to find
*
- * @return pointer to lmac data structure or NULL if not found
+ * Return: pointer to lmac data structure or NULL if not found
*/
struct lmac *nix_get_cgx_lmac(int lmac_instance);
* @param ptr address in memory to add incr to
* @param incr amount to increment memory location by (signed)
*
- * @return Value of memory location before increment
+ * Return: Value of memory location before increment
*/
static inline s64 atomic_fetch_and_add64_nosync(s64 *ptr, s64 incr)
{
* @param elem_size Size of each element
* @param msg Text string to show when allocation fails
*
- * @return A valid memory location or NULL on failure
+ * Return: A valid memory location or NULL on failure
*/
static void *nix_memalloc(int num_elements, size_t elem_size, const char *msg)
{
*
* @param nix Handle to setup
*
- * @return 0, or negative on failure
+ * Return: 0, or negative on failure
*/
static int nix_af_setup_sq(struct nix *nix)
{
* @param cindex Context index
* @param resp Result pointer
*
- * @return 0 for success, -EBUSY on failure
+ * Return: 0 for success, -EBUSY on failure
*/
static int nix_aq_issue_command(struct nix_af *nix_af,
int lf,
* @param inst_size Size of each instruction
* @param res_size Size of each result
*
- * @return -ENOMEM on error, 0 on success
+ * Return: -ENOMEM on error, 0 on success
*/
int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize,
size_t inst_size, size_t res_size);
* @param inst_size Size of each instruction
* @param res_size Size of each result
*
- * @return -ENOMEM on error, 0 on success
+ * Return: -ENOMEM on error, 0 on success
*/
int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize,
size_t inst_size, size_t res_size)
* @param[out] pkt_ptr - Pointer to store rx packet
* @param[out] phy_port - Pointer to store recv phy port
*
- * @return -1 if no packet, else return length of packet.
+ * Return: -1 if no packet, else return length of packet.
*/
int pfe_recv(uchar **pkt_ptr, int *phy_port)
{
* @param[in] data Pointer to the data
* @param[in] length Length of the ethernet packet to be transferred.
*
- * @return -1 if tx Q is full, else returns the tx location where the pkt is
+ * Return: -1 if tx Q is full, else returns the tx location where the pkt is
* placed.
*/
int pfe_send(int phy_port, void *data, int length)
* locations
* if success, moves the tx_to_send to next location.
*
- * @return -1 if TX ownership bit is not cleared by hw.
+ * Return: -1 if TX ownership bit is not cleared by hw.
* else on success (tx done completion) return zero.
*/
int pfe_tx_done(void)
*
* @param[in] edev Pointer to eth device structure.
*
- * @return 0, on success.
+ * Return: 0, on success.
*/
static int pfe_hw_init(struct pfe_ddr_address *pfe_addr)
{
*
* @param[in] edev Pointer to eth device structure.
*
- * @return none
+ * Return: none
*/
static inline void pfe_eth_stop(struct udevice *dev)
{
* @param pe_mask Mask of PE id's to load firmware to
* @param pfe_firmware Pointer to the firmware image
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
static int pfe_load_elf(int pe_mask, uint8_t *pfe_firmware)
{
* @param size pointer to size of the firmware
* @param fw_name pfe firmware name, either class or tmu
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
static int pfe_get_fw(const void **data,
size_t *size, char *fw_name)
/*
* Check PFE FIT image
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
static int pfe_fit_check(void)
{
* firmware files
* Takes PE's out of reset
*
- * @return 0 on success, a negative value on error
+ * Return: 0 on success, a negative value on error
*/
int pfe_firmware_init(void)
{
* @param[in] addr PMEM read address (must be aligned on size)
* @param[in] size Number of bytes to read (maximum 4, must not
* cross 32bit boundaries)
- * @return the data read (in PE endianness, i.e BE).
+ * Return: the data read (in PE endianness, i.e BE).
*/
u32 pe_pmem_read(int id, u32 addr, u8 size)
{
* @param[in] addr DMEM read address (must be aligned on size)
* @param[in] size Number of bytes to read (maximum 4, must not
* cross 32bit boundaries)
- * @return the data read (in PE endianness, i.e BE).
+ * Return: the data read (in PE endianness, i.e BE).
*/
u32 pe_dmem_read(int id, u32 addr, u8 size)
{
* through indirect access registers.
* @param[in] addr Address to read from (must be aligned on size)
* @param[in] size Number of bytes to read (1, 2 or 4)
- * @return the read data
+ * Return: the read data
*/
static u32 class_bus_read(u32 addr, u8 size)
{
/**
* pci_get_bus_max() - returns the bus number of the last active bus
*
- * @return last bus number, or -1 if no active buses
+ * Return: last bus number, or -1 if no active buses
*/
static int pci_get_bus_max(void)
{
* @bus: Bus to check
* @vendor: Vendor ID to check
* @device: Device ID to check
- * @return true if the vendor/device is in the list, false if not
+ * Return: true if the vendor/device is in the list, false if not
*/
static bool pci_need_device_pre_reloc(struct udevice *bus, uint vendor,
uint device)
* @find_id: Specification of the driver to find
* @bdf: Bus/device/function addreess - see PCI_BDF()
* @devp: Returns a pointer to the device created
- * @return 0 if OK, -EPERM if the device is not needed before relocation and
+ * Return: 0 if OK, -EPERM if the device is not needed before relocation and
* therefore was not created, other -ve value on error
*/
static int pci_find_and_bind_driver(struct udevice *parent,
* @hose: PCI hose of the root PCI controller
* @phys_addr: physical address to convert
* @flags: flags of pci regions
- * @return bus address if OK, 0 on error
+ * Return: bus address if OK, 0 on error
*/
pci_addr_t pci_hose_phys_to_bus(struct pci_controller *hose,
phys_addr_t phys_addr,
* If the device is a bridge, downstream devices will be probed.
*
* @dev: Device to configure
- * @return the maximum PCI bus number found by this device. If there are no
+ * Return: the maximum PCI bus number found by this device. If there are no
* bridges, this just returns the device's bus number. If the device is a
* bridge then it will return a larger number, depending on the devices on
* that bridge. On error, returns a -ve error number.
*
* @busnum: PCI bus number to look up
* @busp: Returns PCI bus on success
- * @return 0 on success, or -ve error
+ * Return: 0 on success, or -ve error
*/
int pci_get_bus(int busnum, struct udevice **busp);
* @ram_headerp: Returns a pointer to the image in RAM
* @allocedp: Returns true if @ram_headerp was allocated and needs
* to be freed
- * @return 0 if OK, -ve on error. Note that @allocedp is set up regardless of
+ * Return: 0 if OK, -ve on error. Note that @allocedp is set up regardless of
* the error state. Even if this function returns an error, it may have
* allocated memory.
*/
*
* @comm: Community to search
* @gpio: Pad number to look up (assumed to be valid)
- * @return offset, 0 for first GPIO in community
+ * Return: offset, 0 for first GPIO in community
*/
static size_t relative_pad_in_comm(const struct pad_community *comm,
uint gpio)
*
* @comm: Community to search
* @relative_pad: Pad to look up
- * @return group number if found (see community_n_groups, etc.), or
+ * Return: group number if found (see community_n_groups, etc.), or
* -ESPIPE if no groups, or -ENOENT if not found
*/
static int pinctrl_group_index(const struct pad_community *comm,
*
* @pad: Pad to check
* @devp: Returns the device for that pad
- * @return 0 if OK, -ENOTBLK if no device was found for the given pin
+ * Return: 0 if OK, -ENOTBLK if no device was found for the given pin
*/
static int pinctrl_get_device(uint pad, struct udevice **devp)
{
*
* @dev: Pinctrl device containing the pad (see pinctrl_get_device())
* @cfg: Configuration to apply
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int pinctrl_configure_pad(struct udevice *dev,
const struct pad_config *cfg)
* then calculate and calibrate it's value
* in degree celsius.
*
- * @return current temperature of the chip as sensed by TMU
+ * Return: current temperature of the chip as sensed by TMU
*/
static int get_cur_temp(struct tmu_info *info)
{
* Monitors status of the TMU device and exynos temperature
*
* @param temp pointer to the current temperature value
- * @return enum tmu_status_t value, code indicating event to execute
+ * Return: enum tmu_status_t value, code indicating event to execute
*/
enum tmu_status_t tmu_monitor(int *temp)
{
*
* @param info pointer to the tmu_info struct
* @param blob FDT blob
- * @return int value, 0 for success
+ * Return: int value, 0 for success
*/
static int get_tmu_fdt_values(struct tmu_info *info, const void *blob)
{
* Initialize TMU device
*
* @param blob FDT blob
- * @return int value, 0 for success
+ * Return: int value, 0 for success
*/
int tmu_init(const void *blob)
{
* @brief palmas_enable_ss_ldo - Configure EVM board specific configurations
* for the USB Super speed SMPS10 regulator.
*
- * @return 0
+ * Return: 0
*/
int palmas_enable_ss_ldo(void)
{
* @param pmic pmic structure for the tps65090
* @param fet_id FET number to set (1..MAX_FET_NUM)
* @param set 1 to power on FET, 0 to power off
- * @return -EIO if we got a comms error, -EAGAIN if the FET failed to
+ * Return: -EIO if we got a comms error, -EAGAIN if the FET failed to
* change state. If all is ok, returns 0.
*/
static int tps65090_fet_set(struct udevice *pmic, int fet_id, bool set)
*
* @param sm0 Place to put SM0 voltage
* @param sm1 Place to put SM1 voltage
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int read_voltages(int *sm0, int *sm1)
{
* @dev: device to operate upon
* @da: device address
* @size: Size of the memory region @da is pointing to
- * @return converted virtual address
+ * Return: converted virtual address
*/
static void *sandbox_testproc_device_to_virt(struct udevice *dev, ulong da,
ulong size)
/**
* stm32_copro_probe() - Basic probe
* @dev: corresponding STM32 remote processor device
- * @return 0 if all went ok, else corresponding -ve error
+ * Return: 0 if all went ok, else corresponding -ve error
*/
static int stm32_copro_probe(struct udevice *dev)
{
* @dev: corresponding STM32 remote processor device
* @da: device address
* @size: Size of the memory region @da is pointing to
- * @return converted virtual address
+ * Return: converted virtual address
*/
static void *stm32_copro_device_to_virt(struct udevice *dev, ulong da,
ulong size)
* @dev: corresponding STM32 remote processor device
* @addr: Address in memory where image is stored
* @size: Size in bytes of the image
- * @return 0 if all went ok, else corresponding -ve error
+ * Return: 0 if all went ok, else corresponding -ve error
*/
static int stm32_copro_load(struct udevice *dev, ulong addr, ulong size)
{
/**
* stm32_copro_start() - Start the STM32 remote processor
* @dev: corresponding STM32 remote processor device
- * @return 0 if all went ok, else corresponding -ve error
+ * Return: 0 if all went ok, else corresponding -ve error
*/
static int stm32_copro_start(struct udevice *dev)
{
/**
* stm32_copro_reset() - Reset the STM32 remote processor
* @dev: corresponding STM32 remote processor device
- * @return 0 if all went ok, else corresponding -ve error
+ * Return: 0 if all went ok, else corresponding -ve error
*/
static int stm32_copro_reset(struct udevice *dev)
{
/**
* stm32_copro_stop() - Stop the STM32 remote processor
* @dev: corresponding STM32 remote processor device
- * @return 0 if all went ok, else corresponding -ve error
+ * Return: 0 if all went ok, else corresponding -ve error
*/
static int stm32_copro_stop(struct udevice *dev)
{
/**
* stm32_copro_is_running() - Is the STM32 remote processor running
* @dev: corresponding STM32 remote processor device
- * @return 0 if the remote processor is running, 1 otherwise
+ * Return: 0 if the remote processor is running, 1 otherwise
*/
static int stm32_copro_is_running(struct udevice *dev)
{
* The serial device will only work properly if it has been muxed to the serial
* pins by firmware. Check whether that happened here.
*
- * @return true if serial device is muxed, false if not
+ * Return: true if serial device is muxed, false if not
*/
static bool bcm283x_is_serial_muxed(void)
{
* The serial device will only work properly if it has been muxed to the serial
* pins by firmware. Check whether that happened here.
*
- * @return true if serial device is muxed, false if not
+ * Return: true if serial device is muxed, false if not
*/
static bool bcm283x_is_serial_muxed(void)
{
* @regs: HDA registers
* @val: Command to write
* @response: Set to response from codec
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int exec_verb(struct hda_regs *regs, uint val, uint *response)
{
* @nid: Parent node ID to check
* @num_sub_nodesp: Returns number of subnodes
* @start_sub_node_nidp: Returns start subnode number
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int get_subnode_info(struct hda_regs *regs, uint nid,
uint *num_sub_nodesp, uint *start_sub_node_nidp)
*
* @regs: HDA registers
* @group_nid: Group node ID to check
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static uint find_beep_node_in_group(struct hda_regs *regs, uint group_nid)
{
* Checks if the given audio group contains a beep generator
* @regs: HDA registers
* @nid: Node ID to check
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int audio_group_has_beep_node(struct hda_regs *regs, uint nid)
{
* instead.
*
* @dev: Sound device
- * @return Node ID >0 if found, -ve error code otherwise
+ * Return: Node ID >0 if found, -ve error code otherwise
*/
static int get_hda_beep_nid(struct udevice *dev)
{
*
* @priv: Device's private data
* @divider: Divider value (0 to disable the beep)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int set_beep_divisor(struct hda_codec_priv *priv, uint divider)
{
* @param rate sampling rate
* @param value address of indexvalue to be stored
*
- * @return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
static int rate_value(int rate, u8 *value)
{
* @rate: Sampling rate
* @bits_per_sample: Bits per sample
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
int max98088_hw_params(struct maxim_priv *priv, unsigned int rate,
unsigned int bits_per_sample)
* @priv: max98088 information
* @freq: Sampling frequency in Hz
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
int max98088_set_sysclk(struct maxim_priv *priv, unsigned int freq)
{
* @priv: max98088 information
* @fmt: i2S format - supports a subset of the options defined in i2s.h.
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
int max98088_set_fmt(struct maxim_priv *priv, int fmt)
{
* max98088_reset() - reset the audio codec
*
* @priv: max98088 information
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
static int max98088_reset(struct maxim_priv *priv)
{
*
* @priv: max98088 information
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
static int max98088_device_init(struct maxim_priv *priv)
{
* @rate: Sampling rate
* @bits_per_sample: Bits per sample
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
int max98090_hw_params(struct maxim_priv *priv, unsigned int rate,
unsigned int bits_per_sample)
* @priv: max98090 information
* @freq: Sampling frequency in Hz
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
int max98090_set_sysclk(struct maxim_priv *priv, unsigned int freq)
{
* @priv: max98090 information
* @fmt: i2S format - supports a subset of the options defined in i2s.h.
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
int max98090_set_fmt(struct maxim_priv *priv, int fmt)
{
* resets the audio codec
*
* @priv: max98090 information
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
static int max98090_reset(struct maxim_priv *priv)
{
*
* @priv: max98090 information
*
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
*/
int max98090_device_init(struct maxim_priv *priv)
{
* @param rate sampling rate
* @param value address of indexvalue to be stored
*
- * @return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
static int rate_value(int rate, u8 *value)
{
* @param rate Sampling rate
* @param bits_per_sample Bits per sample
*
- * @return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
static int max98095_hw_params(struct maxim_priv *priv,
enum en_max_audio_interface aif_id,
* @param priv max98095 information
* @param freq Sampling frequency in Hz
*
- * @return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
static int max98095_set_sysclk(struct maxim_priv *priv, unsigned int freq)
{
* @param fmt i2S format - supports a subset of the options defined
* in i2s.h.
*
- * @return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
static int max98095_set_fmt(struct maxim_priv *priv, int fmt,
enum en_max_audio_interface aif_id)
* resets the audio codec
*
* @param priv Private data for driver
- * @return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
static int max98095_reset(struct maxim_priv *priv)
{
* Intialise max98095 codec device
*
* @param priv max98095 information
- * @return 0 for success or negative error code.
+ * Return: 0 for success or negative error code.
*/
static int max98095_device_init(struct maxim_priv *priv)
{
* @param reg reg number to be write
* @param data data to be writen to the above registor
*
- * @return int value 1 for change, 0 for no change or negative error code.
+ * Return: int value 1 for change, 0 for no change or negative error code.
*/
int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg,
unsigned char data)
* @param reg reg number to be read
* @param data address of read data to be stored
*
- * @return int value 0 for success, -1 in case of error.
+ * Return: int value 0 for success, -1 in case of error.
*/
unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg,
unsigned char *data)
* @param mask register mask
* @param value new value
*
- * @return int value 0 for success, non-zero error code.
+ * Return: int value 0 for success, non-zero error code.
*/
int maxim_bic_or(struct maxim_priv *priv, unsigned int reg, unsigned char mask,
unsigned char value)
* @param reg reg number to be write
* @param data data to be writen to the above registor
*
- * @return int value 1 for change, 0 for no change or negative error code.
+ * Return: int value 1 for change, 0 for no change or negative error code.
*/
int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg,
unsigned char data);
* @param reg reg number to be read
* @param data address of read data to be stored
*
- * @return int value 0 for success, -1 in case of error.
+ * Return: int value 0 for success, -1 in case of error.
*/
unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg,
unsigned char *data);
* @param mask register mask
* @param value new value
*
- * @return int value 0 for success, non-zero error code.
+ * Return: int value 0 for success, non-zero error code.
*/
int maxim_bic_or(struct maxim_priv *priv, unsigned int reg, unsigned char mask,
unsigned char value);
* @param i2s_reg i2s register address
* @param dir Clock direction
*
- * @return int value 0 for success, -1 in case of error
+ * Return: int value 0 for success, -1 in case of error
*/
static int i2s_set_sysclk_dir(struct i2s_reg *i2s_reg, int dir)
{
* @param fmt i2s clock properties
* @param i2s_reg i2s register address
*
- * @return int value 0 for success, -1 in case of error
+ * Return: int value 0 for success, -1 in case of error
*/
static int i2s_set_fmt(struct i2s_reg *i2s_reg, unsigned int fmt)
{
* @param blc samplewidth (size of sample in bits)
* @param i2s_reg i2s register address
*
- * @return int value 0 for success, -1 in case of error
+ * Return: int value 0 for success, -1 in case of error
*/
static int i2s_set_samplesize(struct i2s_reg *i2s_reg, unsigned int blc)
{
/**
* tegra_ahub_wait_for_space() - Wait for space in the FIFO
*
- * @return 0 if OK, -ETIMEDOUT if no space was available in time
+ * Return: 0 if OK, -ETIMEDOUT if no space was available in time
*/
static int tegra_ahub_wait_for_space(struct udevice *dev)
{
*
* @dev: I2S device
* @value: Value to write to CIF_TX_CTRL register
- * @return 0
+ * Return: 0
*/
int tegra_i2s_set_cif_tx_ctrl(struct udevice *dev, u32 value);
* @param reg reg number to be write
* @param data data to be writen to the above registor
*
- * @return int value 1 for change, 0 for no change or negative error code.
+ * Return: int value 1 for change, 0 for no change or negative error code.
*/
static int wm8994_i2c_write(struct wm8994_priv *priv, unsigned int reg,
unsigned short data)
* @param reg reg number to be read
* @param data address of read data to be stored
*
- * @return int value 0 for success, -1 in case of error.
+ * Return: int value 0 for success, -1 in case of error.
*/
static unsigned int wm8994_i2c_read(struct wm8994_priv *priv, unsigned int reg,
unsigned short *data)
* @param mask register mask
* @param value new value
*
- * @return int value 1 if change in the register value,
+ * Return: int value 1 if change in the register value,
* 0 for no change or negative error code.
*/
static int wm8994_bic_or(struct wm8994_priv *priv, unsigned int reg,
* @param aif_id Interface ID
* @param fmt i2S format
*
- * @return -1 for error and 0 Success.
+ * Return: -1 for error and 0 Success.
*/
static int wm8994_set_fmt(struct wm8994_priv *priv, int aif_id, uint fmt)
{
* @param bits_per_sample Bits per sample
* @param Channels Channels in the given audio input
*
- * @return -1 for error and 0 Success.
+ * Return: -1 for error and 0 Success.
*/
static int wm8994_hw_params(struct wm8994_priv *priv, int aif_id,
uint sampling_rate, uint bits_per_sample,
* @param priv wm8994 information pointer
* @param aif Audio Interface ID
*
- * @return -1 for error and 0 Success.
+ * Return: -1 for error and 0 Success.
*/
static int configure_aif_clock(struct wm8994_priv *priv, int aif)
{
* @param clk_id Input Clock ID
* @param freq Sampling frequency in Hz
*
- * @return -1 for error and 0 success.
+ * Return: -1 for error and 0 success.
*/
static int wm8994_set_sysclk(struct wm8994_priv *priv, int aif_id, int clk_id,
unsigned int freq)
* @hsfsts_cycle: Cycle type (enum hsfsts_cycle_t)
* @offset: Offset to access
* @len: Number of bytes to transfer (can be 0)
- * @return 0 if OK, -EIO on flash-cycle error (FCERR), -EPERM on access error
+ * Return: 0 if OK, -EIO on flash-cycle error (FCERR), -EPERM on access error
* (AEL), -ETIMEDOUT on timeout
*/
static int exec_sync_hwseq_xfer(struct fast_spi_regs *regs, uint hsfsts_cycle,
* @pchp: Returns a pointer to the pch, or NULL if not found
* @ich_versionp: Returns ICH version detected on success
* @mmio_basep: Returns the address of the SPI registers on success
- * @return 0 if OK, -EPROTOTYPE if the PCH could not be found, -EAGAIN if
+ * Return: 0 if OK, -EPROTOTYPE if the PCH could not be found, -EAGAIN if
* the function cannot success without probing, possible another error if
* pch_get_spi_base() fails
*/
*
* @param dev SPI bus
*
- * @return 0 for success, -EINVAL if chip select is invalid
+ * Return: 0 for success, -EINVAL if chip select is invalid
*/
static int octeon_spi_claim_bus(struct udevice *dev)
{
*
* @param dev SPI bus
*
- * @return 0 for success, -EINVAL if chip select is invalid
+ * Return: 0 for success, -EINVAL if chip select is invalid
*/
static int octeon_spi_release_bus(struct udevice *dev)
{
* TPM finished reset processing.
*
* @dev: Cr50 device
- * @return 0 if OK, -EPERM if locality could not be taken
+ * Return: 0 if OK, -EPERM if locality could not be taken
*/
static int process_reset(struct udevice *dev)
{
* number used by the sandbox emulation.
*
* @index: Index to use (FIRMWARE_NV_INDEX, etc.)
- * @return associated space (enum sandbox_nv_space)
+ * Return: associated space (enum sandbox_nv_space)
*/
int sb_tpm_index_to_seq(uint index);
* NOTE: TPM is big-endian for multi-byte values. Multi-byte
* values have to be swapped.
*
- * @return -EIO on error, 0 on success.
+ * Return: -EIO on error, 0 on success.
*/
static int tpm_tis_spi_xfer(struct udevice *dev, u32 addr, const u8 *out,
u8 *in, u16 len)
* @dev: Device to check
* @buf: Buffer to put the string
* @size: Maximum size of buffer
- * @return length of string, or -ENOSPC it no space
+ * Return: length of string, or -ENOSPC it no space
*/
static int tpm_atmel_twi_get_desc(struct udevice *dev, char *buf, int size)
{
* ehci_get_controller_priv() - Get controller private data
*
* @index Controller number to get
- * @return controller pointer for this index
+ * Return: controller pointer for this index
*/
void *ehci_get_controller_priv(int index);
*
* @param addr pointer to memory region to be flushed
* @param len the length of the cache line to be flushed
- * @return none
+ * Return: none
*/
void xhci_flush_cache(uintptr_t addr, u32 len)
{
*
* @param addr pointer to memory region to be invalidates
* @param len the length of the cache line to be invalidated
- * @return none
+ * Return: none
*/
void xhci_inval_cache(uintptr_t addr, u32 len)
{
* frees the "segment" pointer passed
*
* @param ptr pointer to "segement" to be freed
- * @return none
+ * Return: none
*/
static void xhci_segment_free(struct xhci_segment *seg)
{
* frees the "ring" pointer passed
*
* @param ptr pointer to "ring" to be freed
- * @return none
+ * Return: none
*/
static void xhci_ring_free(struct xhci_ring *ring)
{
* Free the scratchpad buffer array and scratchpad buffers
*
* @ctrl host controller data structure
- * @return none
+ * Return: none
*/
static void xhci_scratchpad_free(struct xhci_ctrl *ctrl)
{
* frees the "xhci_container_ctx" pointer passed
*
* @param ptr pointer to "xhci_container_ctx" to be freed
- * @return none
+ * Return: none
*/
static void xhci_free_container_ctx(struct xhci_container_ctx *ctx)
{
* frees the virtual devices for "xhci_ctrl" pointer passed
*
* @param ptr pointer to "xhci_ctrl" whose virtual devices are to be freed
- * @return none
+ * Return: none
*/
static void xhci_free_virt_devices(struct xhci_ctrl *ctrl)
{
* frees all the memory allocated
*
* @param ptr pointer to "xhci_ctrl" to be cleaned up
- * @return none
+ * Return: none
*/
void xhci_cleanup(struct xhci_ctrl *ctrl)
{
* Malloc the aligned memory
*
* @param size size of memory to be allocated
- * @return allocates the memory and returns the aligned pointer
+ * Return: allocates the memory and returns the aligned pointer
*/
static void *xhci_malloc(unsigned int size)
{
* @param prev pointer to the previous segment
* @param next pointer to the next segment
* @param link_trbs flag to indicate whether to link the trbs or NOT
- * @return none
+ * Return: none
*/
static void xhci_link_segments(struct xhci_ctrl *ctrl, struct xhci_segment *prev,
struct xhci_segment *next, bool link_trbs)
* Initialises the Ring's enqueue,dequeue,enq_seg pointers
*
* @param ring pointer to the RING to be intialised
- * @return none
+ * Return: none
*/
static void xhci_initialize_ring_info(struct xhci_ring *ring)
{
* "All components of all Command and Transfer TRBs shall be initialized to '0'"
*
* @param none
- * @return pointer to the newly allocated SEGMENT
+ * Return: pointer to the newly allocated SEGMENT
*/
static struct xhci_segment *xhci_segment_alloc(void)
{
*
* @param num_segs number of segments in the ring
* @param link_trbs flag to indicate whether to link the trbs or NOT
- * @return pointer to the newly created RING
+ * Return: pointer to the newly created RING
*/
struct xhci_ring *xhci_ring_alloc(struct xhci_ctrl *ctrl, unsigned int num_segs,
bool link_trbs)
* Set up the scratchpad buffer array and scratchpad buffers
*
* @ctrl host controller data structure
- * @return -ENOMEM if buffer allocation fails, 0 on success
+ * Return: -ENOMEM if buffer allocation fails, 0 on success
*/
static int xhci_scratchpad_alloc(struct xhci_ctrl *ctrl)
{
*
* @param ctrl Host controller data structure
* @param type type of XHCI Container Context
- * @return NULL if failed else pointer to the context on success
+ * Return: NULL if failed else pointer to the context on success
*/
static struct xhci_container_ctx
*xhci_alloc_container_ctx(struct xhci_ctrl *ctrl, int type)
* Allocating virtual device
*
* @param udev pointer to USB deivce structure
- * @return 0 on success else -1 on failure
+ * Return: 0 on success else -1 on failure
*/
int xhci_alloc_virt_device(struct xhci_ctrl *ctrl, unsigned int slot_id)
{
* @param ctrl Host controller data structure
* @param hccr pointer to HOST Controller Control Registers
* @param hcor pointer to HOST Controller Operational Registers
- * @return 0 if successful else -1 on failure
+ * Return: 0 if successful else -1 on failure
*/
int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr,
struct xhci_hcor *hcor)
* Give the input control context for the passed container context
*
* @param ctx pointer to the context
- * @return pointer to the Input control context data
+ * Return: pointer to the Input control context data
*/
struct xhci_input_control_ctx
*xhci_get_input_control_ctx(struct xhci_container_ctx *ctx)
*
* @param ctrl Host controller data structure
* @param ctx pointer to the context
- * @return pointer to the slot control context data
+ * Return: pointer to the slot control context data
*/
struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_ctrl *ctrl,
struct xhci_container_ctx *ctx)
* @param ctrl Host controller data structure
* @param ctx context container
* @param ep_index index of the endpoint
- * @return pointer to the End point context
+ * Return: pointer to the End point context
*/
struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_ctrl *ctrl,
struct xhci_container_ctx *ctx,
* @param in_ctx contains the input context
* @param out_ctx contains the input context
* @param ep_index index of the end point
- * @return none
+ * Return: none
*/
void xhci_endpoint_copy(struct xhci_ctrl *ctrl,
struct xhci_container_ctx *in_ctx,
* @param ctrl Host controller data structure
* @param in_ctx contains the inpout context
* @param out_ctx contains the inpout context
- * @return none
+ * Return: none
*/
void xhci_slot_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx,
struct xhci_container_ctx *out_ctx)
* Setup an xHCI virtual device for a Set Address command
*
* @param udev pointer to the Device Data Structure
- * @return returns negative value on failure else 0 on success
+ * Return: returns negative value on failure else 0 on success
*/
void xhci_setup_addressable_virt_dev(struct xhci_ctrl *ctrl,
struct usb_device *udev, int hop_portnr)
* @param ring pointer to the ring
* @param seg poniter to the segment to which TRB belongs
* @param trb poniter to the ring trb
- * @return 1 if this TRB a link TRB else 0
+ * Return: 1 if this TRB a link TRB else 0
*/
static int last_trb(struct xhci_ctrl *ctrl, struct xhci_ring *ring,
struct xhci_segment *seg, union xhci_trb *trb)
* @param ring pointer to the ring
* @param seg poniter to the segment to which TRB belongs
* @param trb poniter to the ring trb
- * @return 1 if this TRB is the last TRB on the last segment else 0
+ * Return: 1 if this TRB is the last TRB on the last segment else 0
*/
static bool last_trb_on_last_seg(struct xhci_ctrl *ctrl,
struct xhci_ring *ring,
* are expected or NOT.
* Will you enqueue more TRBs before calling
* prepare_ring()?
- * @return none
+ * Return: none
*/
static void inc_enq(struct xhci_ctrl *ctrl, struct xhci_ring *ring,
bool more_trbs_coming)
* @param ring pointer to the ring
* @param more_trbs_coming flag to indicate whether more trbs
* @param trb_fields pointer to trb field array containing TRB contents
- * @return pointer to the enqueued trb
+ * Return: pointer to the enqueued trb
*/
static struct xhci_generic_trb *queue_trb(struct xhci_ctrl *ctrl,
struct xhci_ring *ring,
* @param ctrl Host controller data structure
* @param ep_ring pointer to the EP Transfer Ring
* @param ep_state State of the End Point
- * @return error code in case of invalid ep_state, 0 on success
+ * Return: error code in case of invalid ep_state, 0 on success
*/
static int prepare_ring(struct xhci_ctrl *ctrl, struct xhci_ring *ep_ring,
u32 ep_state)
* @param slot_id Slot ID to encode in the flags field (opt.)
* @param ep_index Endpoint index to encode in the flags field (opt.)
* @param cmd Command type to enqueue
- * @return none
+ * Return: none
*/
void xhci_queue_command(struct xhci_ctrl *ctrl, u8 *ptr, u32 slot_id,
u32 ep_index, trb_type cmd)
* @param td_total_len total packet count
* @param maxp max packet size of current pipe
* @param more_trbs_coming indicate last trb in TD
- * @return remainder
+ * Return: remainder
*/
static u32 xhci_td_remainder(struct xhci_ctrl *ctrl, int transferred,
int trb_buff_len, unsigned int td_total_len,
* @param ep_index index of the endpoint
* @param start_cycle cycle flag of the first TRB
* @param start_trb pionter to the first TRB
- * @return none
+ * Return: none
*/
static void giveback_first_trb(struct usb_device *udev, int ep_index,
int start_cycle,
* the end of each event handler, and not touch the TRB again afterwards.
*
* @param ctrl Host controller data structure
- * @return none
+ * Return: none
*/
void xhci_acknowledge_event(struct xhci_ctrl *ctrl)
{
* Checks if there is a new event to handle on the event ring.
*
* @param ctrl Host controller data structure
- * @return 0 if failure else 1 on success
+ * Return: 0 if failure else 1 on success
*/
static int event_ready(struct xhci_ctrl *ctrl)
{
*
* @param ctrl Host controller data structure
* @param expected TRB type expected from Event TRB
- * @return pointer to event trb
+ * Return: pointer to event trb
*/
union xhci_trb *xhci_wait_for_event(struct xhci_ctrl *ctrl, trb_type expected)
{
* @param pipe contains the DIR_IN or OUT , devnum
* @param length length of the buffer
* @param buffer buffer to be read/written based on the request
- * @return returns 0 if successful else -1 on failure
+ * Return: returns 0 if successful else -1 on failure
*/
int xhci_bulk_tx(struct usb_device *udev, unsigned long pipe,
int length, void *buffer)
* @param req request type
* @param length length of the buffer
* @param buffer buffer to be read/written based on the request
- * @return returns 0 if successful else error code on failure
+ * Return: returns 0 if successful else error code on failure
*/
int xhci_ctrl_tx(struct usb_device *udev, unsigned long pipe,
struct devrequest *req, int length,
* @param mask mask for the value read
* @param done value to be campared with result
* @param usec time to wait till
- * @return 0 if handshake is success else < 0 on failure
+ * Return: 0 if handshake is success else < 0 on failure
*/
static int
handshake(uint32_t volatile *ptr, uint32_t mask, uint32_t done, int usec)
* Set the run bit and wait for the host to be running.
*
* @param hcor pointer to host controller operation registers
- * @return status of the Handshake
+ * Return: status of the Handshake
*/
static int xhci_start(struct xhci_hcor *hcor)
{
* Resets the XHCI Controller
*
* @param hcor pointer to host controller operation registers
- * @return -EBUSY if XHCI Controller is not halted else status of handshake
+ * Return: -EBUSY if XHCI Controller is not halted else status of handshake
*/
static int xhci_reset(struct xhci_hcor *hcor)
{
* index = (epnum * 2) + direction - 1 = (epnum * 2) + 1 - 1 = (epnum * 2)
*
* @param desc USB enpdoint Descriptor
- * @return index of the Endpoint
+ * Return: index of the Endpoint
*/
static unsigned int xhci_get_ep_index(struct usb_endpoint_descriptor *desc)
{
*
* @param udev pointer to the Device Data Structure
* @param ctx_change flag to indicate the Context has changed or NOT
- * @return 0 on success, -1 on failure
+ * Return: 0 on success, -1 on failure
*/
static int xhci_configure_endpoints(struct usb_device *udev, bool ctx_change)
{
* Configure the endpoint, programming the device contexts.
*
* @param udev pointer to the USB device structure
- * @return returns the status of the xhci_configure_endpoints
+ * Return: returns the status of the xhci_configure_endpoints
*/
static int xhci_set_configuration(struct usb_device *udev)
{
* the device).
*
* @param udev pointer to the Device Data Structure
- * @return 0 if successful else error code on failure
+ * Return: 0 if successful else error code on failure
*/
static int xhci_address_device(struct usb_device *udev, int root_portnr)
{
* or allocating memory failed.
*
* @param udev pointer to the Device Data Structure
- * @return Returns 0 on succes else return error code on failure
+ * Return: Returns 0 on succes else return error code on failure
*/
static int _xhci_alloc_device(struct usb_device *udev)
{
* we need to issue an evaluate context command and wait on it.
*
* @param udev pointer to the Device Data Structure
- * @return returns the status of the xhci_configure_endpoints
+ * Return: returns the status of the xhci_configure_endpoints
*/
int xhci_check_maxpacket(struct usb_device *udev)
{
* @param wIndex request index
* @param addr address of posrt status register
* @param port_status state of port status register
- * @return none
+ * Return: none
*/
static void xhci_clear_port_change_bit(u16 wValue,
u16 wIndex, volatile uint32_t *addr, u32 port_status)
* For all other types (RW1S, RW1CS, RW, and RZ), writing a '0' has no effect.
*
* @param state state of the Port Status and Control Regsiter
- * @return a value that would result in the port being in the
+ * Return: a value that would result in the port being in the
* same state, if the value was written to the port
* status control register.
*/
* @param udev pointer to the USB device structure
* @param pipe contains the DIR_IN or OUT , devnum
* @param buffer buffer to be read/written based on the request
- * @return returns 0 if successful else -1 on failure
+ * Return: returns 0 if successful else -1 on failure
*/
static int xhci_submit_root(struct usb_device *udev, unsigned long pipe,
void *buffer, struct devrequest *req)
* @param buffer buffer to be read/written based on the request
* @param length length of the buffer
* @param interval interval of the interrupt
- * @return 0
+ * Return: 0
*/
static int _xhci_submit_int_msg(struct usb_device *udev, unsigned long pipe,
void *buffer, int length, int interval,
* @param pipe contains the DIR_IN or OUT , devnum
* @param buffer buffer to be read/written based on the request
* @param length length of the buffer
- * @return returns 0 if successful else -1 on failure
+ * Return: returns 0 if successful else -1 on failure
*/
static int _xhci_submit_bulk_msg(struct usb_device *udev, unsigned long pipe,
void *buffer, int length)
* @param length length of the buffer
* @param setup Request type
* @param root_portnr Root port number that this device is on
- * @return returns 0 if successful else -1 on failure
+ * Return: returns 0 if successful else -1 on failure
*/
static int _xhci_submit_control_msg(struct usb_device *udev, unsigned long pipe,
void *buffer, int length,
* and allocates the necessary data structures
*
* @param index index to the host controller data structure
- * @return pointer to the intialised controller
+ * Return: pointer to the intialised controller
*/
int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
{
* and cleans up all the related data structures
*
* @param index index to the host controller data structure
- * @return none
+ * Return: none
*/
int usb_lowlevel_stop(int index)
{
* -ENOMEM no memory to perform the operation
*
* @param driver the gadget driver
- * @return <0 if error, 0 if everything is fine
+ * Return: <0 if error, 0 if everything is fine
*/
#ifndef __UBOOT__
static int musb_gadget_start(struct usb_gadget *g,
* that is supposed to be a standard control request. Assumes the fifo to
* be at least 2 bytes long.
*
- * @return 0 if the request was NOT HANDLED,
+ * Return: 0 if the request was NOT HANDLED,
* < 0 when error
* > 0 when the request is processed
*
* usb_dev_get_parent() - Get the parent of a USB device
*
* @udev: USB struct containing information about the device
- * @return associated device for which udev == dev_get_parent_priv(dev)
+ * Return: associated device for which udev == dev_get_parent_priv(dev)
*/
struct usb_device *usb_dev_get_parent(struct usb_device *udev);
* @param addr_off offset from the i2c base address for ps8622
* @param reg_addr register address to write
* @param value value to be written
- * @return 0 on success, non-0 on failure
+ * Return: 0 on success, non-0 on failure
*/
static int ps8622_write(struct udevice *dev, unsigned addr_off,
unsigned char reg_addr, unsigned char value)
* @xend: X end position in pixels from the left
* @yend: Y end position in pixels from the top
* @clr: Value to write
- * @return 0 if OK, -ENOSYS if the display depth is not supported
+ * Return: 0 if OK, -ENOSYS if the display depth is not supported
*/
static int console_truetype_erase(struct udevice *dev, int xstart, int ystart,
int xend, int yend, int clr)
* not been entered.
*
* @dev: Device to update
- * @return 0 if OK, -ENOSYS if not supported
+ * Return: 0 if OK, -ENOSYS if not supported
*/
static int console_truetype_backspace(struct udevice *dev)
{
*
* This searched for the first available font.
*
- * @return pointer to the font, or NULL if none is found
+ * Return: pointer to the font, or NULL if none is found
*/
static u8 *console_truetype_find_font(void)
{
* @param dev The device structure for the IPU passed in by the
* driver framework.
*
- * @return Returns 0 on success or negative error code on error
+ * Return: Returns 0 on success or negative error code on error
*/
int ipu_probe(void)
{
* @param params Input parameter containing union of channel
* initialization parameters.
*
- * @return Returns 0 on success or negative error code on fail
+ * Return: Returns 0 on success or negative error code on fail
*/
int32_t ipu_init_channel(ipu_channel_t channel, ipu_channel_params_t *params)
{
* @param v private v offset for additional cropping,
* zero if not used.
*
- * @return Returns 0 on success or negative error code on fail
+ * Return: Returns 0 on success or negative error code on fail
*/
int32_t ipu_init_channel_buffer(ipu_channel_t channel, ipu_buffer_t type,
uint32_t pixel_fmt,
*
* @param channel Input parameter for the logical channel ID.
*
- * @return This function returns 0 on success or negative error code on
+ * Return: This function returns 0 on success or negative error code on
* fail.
*/
int32_t ipu_enable_channel(ipu_channel_t channel)
* @param wait_for_stop Flag to set whether to wait for channel end
* of frame or return immediately.
*
- * @return This function returns 0 on success or negative error code on
+ * Return: This function returns 0 on success or negative error code on
* fail.
*/
int32_t ipu_disable_channel(ipu_channel_t channel)
*
* @param sig Bitfield of signal polarities for LCD interface.
*
- * @return This function returns 0 on success or negative error code on
+ * Return: This function returns 0 on success or negative error code on
* fail.
*/
*
* @param alpha Global alpha value.
*
- * @return Returns 0 on success or negative error code on fail
+ * Return: Returns 0 on success or negative error code on fail
*/
int32_t ipu_disp_set_global_alpha(ipu_channel_t channel, unsigned char enable,
uint8_t alpha)
*
* @param colorKey 24-bit RGB color for transparent color key.
*
- * @return Returns 0 on success or negative error code on fail
+ * Return: Returns 0 on success or negative error code on fail
*/
int32_t ipu_disp_set_color_key(ipu_channel_t channel, unsigned char enable,
uint32_t color_key)
* structures. This includes information such as bits per pixel,
* color maps, screen width/height and RGBA offsets.
*
- * @return Framebuffer structure initialized with our information
+ * Return: Framebuffer structure initialized with our information
*/
static struct fb_info *mxcfb_init_fbinfo(void)
{
* this routine: Framebuffer initialization, Memory allocation and
* mapping, Framebuffer registration, IPU initialization.
*
- * @return Appropriate error code to the kernel common code
+ * Return: Appropriate error code to the kernel common code
*/
static int mxcfb_probe(struct udevice *dev, u32 interface_pix_fmt,
uint8_t disp, struct fb_videomode const *mode)
*
* @blob: device tree blob
* @pipeline: display pipeline
- * @return device node offset in blob, or negative values if failed
+ * Return: device node offset in blob, or negative values if failed
*/
int meson_simplefb_fdt_match(void *blob, const char *pipeline);
* @dev: Panel device containing the backlight to update
* @percent: Brightness value (0=off, 1=min brightness,
* 100=full brightness)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int panel_set_backlight(struct udevice *dev, int percent)
{
* @dev: device
* @buf: output buffer for the EDID
* @buf_size: number of bytes in the buffer
- * @return number of bytes read if OK, -ve if something went wrong
+ * Return: number of bytes read if OK, -ve if something went wrong
*/
int rk_hdmi_read_edid(struct udevice *dev, u8 *buf, int buf_size);
* rk_hdmi_of_to_plat() - common of_to_plat implementation
*
* @dev: device
- * @return 0 if OK, -ve if something went wrong
+ * Return: 0 if OK, -ve if something went wrong
*/
int rk_hdmi_of_to_plat(struct udevice *dev);
* 3. initialises the Designware HDMI PHY
*
* @dev: device
- * @return 0 if OK, -ve if something went wrong
+ * Return: 0 if OK, -ve if something went wrong
*/
int rk_hdmi_probe(struct udevice *dev);
* @fbbase: Frame buffer address
* @ep_node: Device tree node to process - this is the offset of an endpoint
* node within the VOP's 'port' list.
- * @return 0 if OK, -ve if something went wrong
+ * Return: 0 if OK, -ve if something went wrong
*/
static int rk_display_init(struct udevice *dev, ulong fbbase, ofnode ep_node)
{
* successfully initialised).
*
* @dev: device
- * @return 0 if OK, -ve if something went wrong
+ * Return: 0 if OK, -ve if something went wrong
*/
int rk_vop_probe(struct udevice *dev);
* (32 BPP) x VIDEO_ROCKCHIP_MAX_XRES x VIDEO_ROCKCHIP_MAX_YRES
*
* @dev: device
- * @return 0 (always OK)
+ * Return: 0 (always OK)
*/
int rk_vop_bind(struct udevice *dev);
*
* @blob: device tree blob
* @pipeline: display pipeline
- * @return device node offset in blob, or negative values if failed
+ * Return: device node offset in blob, or negative values if failed
*/
int sunxi_simplefb_fdt_match(void *blob, const char *pipeline);
* @param blob Device tree blob
* @param priv Driver's private data
* @param default_lcd_base Default address of LCD frame buffer
- * @return 0 if ok, -1 on error (unsupported bits per pixel)
+ * Return: 0 if ok, -1 on error (unsupported bits per pixel)
*/
static int tegra_display_probe(const void *blob, struct tegra_lcd_priv *priv,
void *default_lcd_base)
*
* @dpll_data: struct dpll_data pointer for the DPLL
* @rate: New DPLL clock rate
- * @return rounded rate and the computed m, n and div values in the dpll_data
+ * Return: rounded rate and the computed m, n and div values in the dpll_data
* structure, or -ve error code.
*/
static ulong am335x_dpll_round_rate(struct dpll_data *dd, ulong rate)
*
* @am335x_lcdhw: Base address of the LCD controller registers.
* @rate: New clock rate in Hz.
- * @return new rate, or -ve error code.
+ * Return: new rate, or -ve error code.
*/
static ulong am335x_fb_set_pixel_clk_rate(struct am335x_lcdhw *regs, ulong rate)
{
/**
* get_bmp_col_16bpp() - Convert a colour-table entry into a 16bpp pixel value
*
- * @return value to write to the 16bpp frame buffer for this palette entry
+ * Return: value to write to the 16bpp frame buffer for this palette entry
*/
static uint get_bmp_col_16bpp(struct bmp_color_table_entry cte)
{
* @param t The EDID detailed timing to be converted
* @param mode Returns the converted timing
*
- * @return 0 on success, or a negative errno on error
+ * Return: 0 on success, or a negative errno on error
*/
int video_edid_dtd_to_ctfb_res_modes(struct edid_detailed_timing *t,
struct ctfb_res_modes *mode)
* @udev: the transport device
* @cfg_type: the VIRTIO_PCI_CAP_* value we seek
*
- * @return offset of the configuration structure
+ * Return: offset of the configuration structure
*/
static int virtio_pci_find_capability(struct udevice *udev, u8 cfg_type)
{
* @udev: the transport device
* @off: offset of the configuration structure
*
- * @return base address of the capability
+ * Return: base address of the capability
*/
static void __iomem *virtio_pci_map_capability(struct udevice *udev, int off)
{
*
* @param varname Environment variable to set
* @param value Value to set it to
- * @return 0 if ok, 1 on error
+ * Return: 0 if ok, 1 on error
*/
int env_set_ulong(const char *varname, ulong value)
{
*
* @param varname Environment variable to set
* @param value Value to set it to
- * @return 0 if ok, 1 on error
+ * Return: 0 if ok, 1 on error
*/
int env_set_hex(const char *varname, ulong value)
{
* @param base Number base to use (normally 10, or 16 for hex)
* @param default_val Default value to return if the variable is not
* found
- * @return the decoded value, or default_val if not found
+ * Return: the decoded value, or default_val if not found
*/
ulong env_get_ulong(const char *name, int base, ulong default_val)
{
* @node: Node to fill
* @start: Pointer to the start of the CBFS file in memory
* @header: Pointer to the header information (in our enddianess)
- * @return 0 if OK, -EBADF if the header is too small
+ * Return: 0 if OK, -EBADF if the header is too small
*/
static int fill_node(struct cbfs_cachenode *node, void *start,
struct cbfs_fileheader *header)
* @param used A pointer to the count of of bytes scanned through,
* including the file if one is found.
*
- * @return 0 if a file is found, -ENOENT if one isn't, -EBADF if a bad header
+ * Return: 0 if a file is found, -ENOENT if one isn't, -EBADF if a bad header
* is found.
*/
static int file_cbfs_next_file(struct cbfs_priv *priv, void *start, int size,
*
* @priv: Private data, which is inited by this function
* @addr: Address of CBFS header in memory-mapped SPI flash
- * @return 0 if OK, -ENXIO if the header is bad
+ * Return: 0 if OK, -ENXIO if the header is bad
*/
static int load_header(struct cbfs_priv *priv, ulong addr)
{
*
* @priv: Private data, which is inited by this function
* @end_of_rom: Address of the last byte of the ROM (typically 0xffffffff)
- * @return 0 if OK, -ENXIO if the header is bad
+ * Return: 0 if OK, -ENXIO if the header is bad
*/
static int file_cbfs_load_header(struct cbfs_priv *priv, ulong end_of_rom)
{
*
* @priv: Private data, which is inited by this function
* @base: Address of the first byte of the ROM (e.g. 0xff000000)
- * @return 0 if OK, -ENXIO if the header is bad
+ * Return: 0 if OK, -ENXIO if the header is bad
*/
static int cbfs_load_header_ptr(struct cbfs_priv *priv, ulong base)
{
*
* @itr: iterator to initialize
* @fsdata: filesystem data for the partition
- * @return 0 on success, else -errno
+ * Return: 0 on success, else -errno
*/
static int fat_itr_root(fat_itr *itr, fsdata *fsdata)
{
* Must be called once on a new iterator before the cursor is valid.
*
* @itr: the iterator to iterate
- * @return boolean, 1 if success or 0 if no more entries in the
+ * Return: boolean, 1 if success or 0 if no more entries in the
* current directory
*/
static int fat_itr_next(fat_itr *itr)
* fat_itr_isdir() - is current cursor position pointing to a directory
*
* @itr: the iterator
- * @return true if cursor is at a directory
+ * Return: true if cursor is at a directory
*/
static int fat_itr_isdir(fat_itr *itr)
{
* @itr: iterator initialized to root
* @path: the requested path
* @type: bitmask of allowable file types
- * @return 0 on success or -errno
+ * Return: 0 on success or -errno
*/
static int fat_itr_resolve(fat_itr *itr, const char *path, unsigned type)
{
* if less than the current size, the abuf is contracted and the data at
* the end is lost. If @new_size is 0, this sets the alloced member to
* false
- * @return true if OK, false if out of memory
+ * Return: true if OK, false if out of memory
*/
bool abuf_realloc(struct abuf *abuf, size_t new_size);
*
* @abuf: abuf to uninit
* @sizep: if non-NULL, returns the size of the returned data
- * @return data contents, allocated with malloc(), or NULL if the data could not
+ * Return: data contents, allocated with malloc(), or NULL if the data could not
* be allocated, or the data size is 0
*/
void *abuf_uninit_move(struct abuf *abuf, size_t *sizep);
* @dev: Device to check
* @buf: Buffer to place the path in (should be ACPI_PATH_MAX long)
* @maxlen: Size of buffer (typically ACPI_PATH_MAX)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_device_path(const struct udevice *dev, char *buf, int maxlen);
* @dev: Device to check
* @buf: Buffer to place the path in (should be ACPI_PATH_MAX long)
* @maxlen: Size of buffer (typically ACPI_PATH_MAX)
- * @return 0 if OK, -EINVAL if the device has no parent, other -ve on other
+ * Return: 0 if OK, -EINVAL if the device has no parent, other -ve on other
* error
*/
int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen);
* inactive or hidden devices.
*
* @dev: Device to check
- * @return device status, as ACPI_DSTATUS_...
+ * Return: device status, as ACPI_DSTATUS_...
*/
enum acpi_dev_status acpi_device_status(const struct udevice *dev);
*
* @ctx: ACPI context pointer
* @req_irq: Interrupt to output
- * @return IRQ pin number if OK, -ve on error
+ * Return: IRQ pin number if OK, -ve on error
*/
int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx,
const struct irq *req_irq);
* acpi_device_write_gpio() - Write GpioIo() or GpioInt() descriptor
*
* @gpio: GPIO information to write
- * @return GPIO pin number of first GPIO if OK, -ve on error
+ * Return: GPIO pin number of first GPIO if OK, -ve on error
*/
int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio);
*
* @ctx: ACPI context pointer
* @desc: GPIO to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_device_write_gpio_desc(struct acpi_ctx *ctx,
const struct gpio_desc *desc);
* If an interrupt is found, an ACPI interrupt descriptor is written to the ACPI
* output. If not, but if a GPIO is found, a GPIO descriptor is written.
*
- * @return irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO
+ * Return: irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO
* could be found, or some other error occurred
*/
int acpi_device_write_interrupt_or_gpio(struct acpi_ctx *ctx,
*
* @ctx: ACPI context pointer
* @dev: I2C device to write
- * @return I2C address of device if OK, -ve on error
+ * Return: I2C address of device if OK, -ve on error
*/
int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev);
*
* @ctx: ACPI context pointer
* @dev: SPI device to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_device_write_spi_dev(struct acpi_ctx *ctx, const struct udevice *dev);
* @stop_off_delay_ms: Delay to be inserted after enabling stop.
* (_OFF method delay)
*
- * @return 0 if OK, -ve if at least one GPIO is not provided
+ * Return: 0 if OK, -ve if at least one GPIO is not provided
*/
int acpi_device_add_power_res(struct acpi_ctx *ctx, u32 tx_state_val,
const char *dw0_read, const char *dw0_write,
*
* @dev: Device to check
* @out_name: Place to put the name (must hold ACPI_NAME_MAX bytes)
- * @return 0 if a name was found, -ENOENT if not found, -ENXIO if the device
+ * Return: 0 if a name was found, -ENOENT if not found, -ENXIO if the device
* sequence number could not be determined
*/
int acpi_device_infer_name(const struct udevice *dev, char *out_name);
* acpi_dp_new_table() - Start a new Device Property table
*
* @ref: ACPI reference (e.g. "_DSD")
- * @return pointer to table, or NULL if out of memory
+ * Return: pointer to table, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_new_table(const char *ref);
* @dp: Table to add this property to
* @name: Name of property, or NULL for none
* @value: Integer value
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name,
u64 value);
* @dp: Table to add this property to
* @name: Name of property, or NULL for none
* @string: String value
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name,
const char *string);
* @dp: Table to add this property to
* @name: Name of property, or NULL for none
* @reference: Reference value
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name,
const char *reference);
*
* @dp: Table to add this property to
* @name: Name of property, or NULL for none
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array);
*
* @dp: Table to add this property to
* @name: Name of property, or NULL for none
- * @return pointer to new array node, or NULL if out of memory
+ * Return: pointer to new array node, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name,
u64 *array, int len);
* @dp: Table to add this child to
* @name: Name of child, or NULL for none
* @child: Child node to add
- * @return pointer to new child node, or NULL if out of memory
+ * Return: pointer to new child node, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name,
struct acpi_dp *child);
* @index: Index of the GPIO resource in _CRS starting from zero
* @pin: Pin in the GPIO resource, typically zero
* @polarity: GPIO polarity. Note that ACPI_IRQ_ACTIVE_BOTH is not supported
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
*/
struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name,
const char *ref, int index, int pin,
*
* @ctx: ACPI context
* @table: Table to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_dp_write(struct acpi_ctx *ctx, struct acpi_dp *table);
* @node: Node to copy from
* @dp: DP to copy to
* @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_dp_ofnode_copy_int(ofnode node, struct acpi_dp *dp, const char *prop);
* @node: Node to copy from
* @dp: DP to copy to
* @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_dp_ofnode_copy_str(ofnode node, struct acpi_dp *dp, const char *prop);
* @dev: Device to copy from
* @dp: DP to copy to
* @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_dp_dev_copy_int(const struct udevice *dev, struct acpi_dp *dp,
const char *prop);
* @dev: Device to copy from
* @dp: DP to copy to
* @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_dp_dev_copy_str(const struct udevice *dev, struct acpi_dp *dp,
const char *prop);
* This returns chipset previous sleep state from ACPI registers.
* Platform codes must supply this routine in order to support ACPI S3.
*
- * @return ACPI_S0/S1/S2/S3/S4/S5.
+ * Return: ACPI_S0/S1/S2/S3/S4/S5.
*/
enum acpi_sleep_state chipset_prev_sleep_state(void);
* This keeps the version-number information in one place
*
* @table: ACPI table to check
- * @return version number that U-Boot generates
+ * Return: version number that U-Boot generates
*/
int acpi_get_table_revision(enum acpi_tables table);
*
* @dmar: Place to put the table
* @flags: DMAR flags to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags);
*
* @ctx: ACPI context
* @table: Table to add
- * @return 0 if OK, -E2BIG if too many tables
+ * Return: 0 if OK, -E2BIG if too many tables
*/
int acpi_add_table(struct acpi_ctx *ctx, void *table);
* acpigen_get_current() - Get the current ACPI code output pointer
*
* @ctx: ACPI context pointer
- * @return output pointer
+ * Return: output pointer
*/
u8 *acpigen_get_current(struct acpi_ctx *ctx);
*
* @ctx: ACPI context pointer
* @uuid: UUID to write in the form aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
- * @return 0 if OK, -EINVAL if the format is incorrect
+ * Return: 0 if OK, -EINVAL if the format is incorrect
*/
int acpigen_write_uuid(struct acpi_ctx *ctx, const char *uuid);
* sata_reset() - reset the controller
*
* @dev: Controller to reset
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sata_reset(struct udevice *dev);
*
* @dev: Controller to reset
* @port: Port number to check (0 for first)
- * @return 0 if detected, -ENXIO if nothin on port, other -ve on error
+ * Return: 0 if detected, -ENXIO if nothin on port, other -ve on error
*/
int sata_dm_port_status(struct udevice *dev, int port);
* sata_scan() - scan SATA ports
*
* @dev: Controller to scan
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sata_scan(struct udevice *dev);
*
* @ahci_dev: AHCI parent device
* @devp: Returns new SCSI bus device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp);
*
* @ahci_dev: AHCI parent device
* @base: Base address of AHCI port
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_probe_scsi(struct udevice *ahci_dev, ulong base);
* devices it finds.
*
* @ahci_dev: AHCI parent device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_probe_scsi_pci(struct udevice *ahci_dev);
*
* @param[in] dev_desc Place to store the device description pointer
* @param[in] part_info Place to store the partition information
- * @return The slot number (>= 0) on success, or a negative on error
+ * Return: The slot number (>= 0) on success, or a negative on error
*/
int ab_select_slot(struct blk_desc *dev_desc, struct disk_partition *part_info);
*
* @param gpio GPIO number
* @param label User label for this GPIO
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_request(unsigned gpio, const char *label);
* Stop using the GPIO. This function should not alter pin configuration.
*
* @param gpio GPIO number
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_free(unsigned gpio);
* Make a GPIO an input.
*
* @param gpio GPIO number
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_direction_input(unsigned gpio);
*
* @param gpio GPIO number
* @param value GPIO value (0 for low or 1 for high)
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_direction_output(unsigned gpio, int value);
* or an output.
*
* @param gpio GPIO number
- * @return 0 if low, 1 if high, -1 on error
+ * Return: 0 if low, 1 if high, -1 on error
*/
int gpio_get_value(unsigned gpio);
*
* @param gpio GPIO number
* @param value GPIO value (0 for low or 1 for high)
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int gpio_set_value(unsigned gpio, int value);
*
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
- * @return true if valid, false if not
+ * Return: true if valid, false if not
*/
static inline bool dm_gpio_is_valid(const struct gpio_desc *desc)
{
* @offset: Offset of device GPIO to check
* @namep: If non-NULL, this is set to the name given when the GPIO
* was requested, or -1 if it has not been requested
- * @return -ENODATA if the driver returned an unknown function,
+ * Return: -ENODATA if the driver returned an unknown function,
* -ENODEV if the device is not active, -EINVAL if the offset is invalid.
* GPIOF_UNUSED if the GPIO has not been requested. Otherwise returns the
* function from enum gpio_func_t.
* @offset: Offset of device GPIO to check
* @namep: If non-NULL, this is set to the name given when the GPIO
* was requested, or -1 if it has not been requested
- * @return -ENODATA if the driver returned an unknown function,
+ * Return: -ENODATA if the driver returned an unknown function,
* -ENODEV if the device is not active, -EINVAL if the offset is invalid.
* Otherwise returns the function from enum gpio_func_t.
*/
*
* @dev: Device to look up
* @offset_count: Returns number of GPIOs within this bank
- * @return bank name of this device
+ * Return: bank name of this device
*/
const char *gpio_get_bank_info(struct udevice *dev, int *offset_count);
*
* @name: Name to look up
* @desc: Returns description, on success
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpio_lookup_name(const char *name, struct gpio_desc *desc);
* etc. then returns the resulting integer.
*
* @gpio_list: List of GPIOs to collect
- * @return resulting integer value, or -ve on error
+ * Return: resulting integer value, or -ve on error
*/
int gpio_get_values_as_int(const int *gpio_list);
*
* @desc_list: List of GPIOs to collect
* @count: Number of GPIOs
- * @return resulting integer value, or -ve on error
+ * Return: resulting integer value, or -ve on error
*/
int dm_gpio_get_values_as_int(const struct gpio_desc *desc_list, int count);
*
* @desc_list: List of GPIOs to collect
* @count: Number of GPIOs
- * @return resulting integer value, or -ve on error
+ * Return: resulting integer value, or -ve on error
*/
int dm_gpio_get_values_as_int_base3(struct gpio_desc *desc_list,
int count);
*
* @gpio_num_array: array of gpios to claim, terminated by -1
* @fmt: format string for GPIO names, e.g. "board_id%d"
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int gpio_claim_vector(const int *gpio_num_array, const char *fmt);
* @desc: Returns GPIO description information. If there is no such
* GPIO, @desc->dev will be NULL.
* @flags: Indicates the GPIO input/output settings (GPIOD_...)
- * @return 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
+ * Return: 0 if OK, -ENOENT if the GPIO does not exist, -EINVAL if there is
* something wrong with the list, or other -ve for another error (e.g.
* -EBUSY if a GPIO was already requested)
*/
* @max_count: Maximum number of GPIOs to return (@desc_list must be at least
* this big)
* @flags: Indicates the GPIO input/output settings (GPIOD_...)
- * @return number of GPIOs requested, or -ve on error
+ * Return: number of GPIOs requested, or -ve on error
*/
int gpio_request_list_by_name(struct udevice *dev, const char *list_name,
struct gpio_desc *desc_list, int max_count,
*
* @desc: GPIO description of GPIO to request (see dm_gpio_lookup_name())
* @label: Label to attach to the GPIO while claimed
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpio_request(struct gpio_desc *desc, const char *label);
*
* @dev: Device requesting the GPIO
* @list_name: Name of GPIO list (e.g. "board-id-gpios")
- * @return number of GPIOs (0 for an empty property) or -ENOENT if the list
+ * Return: number of GPIOs (0 for an empty property) or -ENOENT if the list
* does not exist
*/
int gpio_get_list_count(struct udevice *dev, const char *list_name);
*
* @dev: Device which requested the GPIO
* @desc: GPIO to free
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpio_free(struct udevice *dev, struct gpio_desc *desc);
* @dev: Device which requested the GPIOs
* @desc: List of GPIOs to free
* @count: Number of GPIOs in the list
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int gpio_free_list(struct udevice *dev, struct gpio_desc *desc, int count);
*
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
- * @return GPIO value (0 for inactive, 1 for active) or -ve on error
+ * Return: GPIO value (0 for inactive, 1 for active) or -ve on error
*/
int dm_gpio_get_value(const struct gpio_desc *desc);
* previously returned by gpio_request_by_name()
* @clr: Flags to clear (GPIOD_...)
* @set: Flags to set (GPIOD_...)
- * @return 0 if OK, -EINVAL if the flags had obvious conflicts,
+ * Return: 0 if OK, -EINVAL if the flags had obvious conflicts,
* -ERECALLCONFLICT if there was a non-obvious hardware conflict when attempting
* to set the flags
*/
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
* @flags: New flags to use
- * @return 0 if OK, -ve on error, in which case desc->flags is not updated
+ * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
*/
int dm_gpio_set_dir_flags(struct gpio_desc *desc, ulong flags);
* @clr: Flags to clear (GPIOD_...), e.g. GPIOD_MASK_DIR if you are
* changing the direction
* @set: Flags to set (GPIOD_...)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_gpios_clrset_flags(struct gpio_desc *desc, int count, ulong clr,
ulong set);
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
* @flags: place to put the used flags
- * @return 0 if OK, -ve on error, in which case desc->flags is not updated
+ * Return: 0 if OK, -ve on error, in which case desc->flags is not updated
*/
int dm_gpio_get_flags(struct gpio_desc *desc, ulong *flags);
*
* @desc: GPIO description containing device, offset and flags,
* previously returned by gpio_request_by_name()
- * @return GPIO number, or -ve if not found
+ * Return: GPIO number, or -ve if not found
*/
int gpio_get_number(const struct gpio_desc *desc);
*
* @desc: GPIO description to convert
* @gpio: Output ACPI GPIO information
- * @return ACPI pin number or -ve on error
+ * Return: ACPI pin number or -ve on error
*/
int gpio_get_acpi(const struct gpio_desc *desc, struct acpi_gpio *gpio);
* @mclk_freq: Codec clock frequency in Hz
* @bits_per_sample: Must be 16 or 24
* @channels: Number of channels to use (1=mono, 2=stereo)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int audio_codec_set_params(struct udevice *dev, int interface, int rate,
int mclk_freq, int bits_per_sample, uint channels);
* This is only implemented for sandbox since other platforms don't have a way
* of controlling the feature at runtime.
*
- * @return true if enabled, false if not
+ * Return: true if enabled, false if not
*/
bool autoboot_keyed(void);
* autoboot_set_keyed() - set whether keyed autoboot should be used
*
* @autoboot_keyed: true to enable the feature, false to disable
- * @return old value of the flag
+ * Return: old value of the flag
*/
bool autoboot_set_keyed(bool autoboot_keyed);
#else
* bootcmd, failbootcmd or altbootcmd depending on the current state.
* Return this command so it can be executed.
*
- * @return command to executed
+ * Return: command to executed
*/
const char *bootdelay_process(void);
* backlight_enable() - Enable a backlight
*
* @dev: Backlight device to enable
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int backlight_enable(struct udevice *dev);
*
* @dev: Backlight device to update
* @percent: Brightness value (0 to 100, or BACKLIGHT_... value)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int backlight_set_brightness(struct udevice *dev, int percent);
* @name: Name of entry
* @bufp: Returns a pointer to the entry
* @sizep: Returns the size of the entry
- * @return 0 on success, -EPERM if the ROM offset is not set, -ENOENT if the
+ * Return: 0 on success, -EPERM if the ROM offset is not set, -ENOENT if the
* entry cannot be found, other error code other error
*/
int binman_entry_map(ofnode parent, const char *name, void **bufp, int *sizep);
*
* @name: Path to entry to examine (e.g. "/read-only/u-boot")
* @entry: Returns information about the entry
- * @return 0 if OK, -ENOENT if the path is not found, other -ve value if the
+ * Return: 0 if OK, -ENOENT if the path is not found, other -ve value if the
* binman information is invalid (missing image-pos or size)
*/
int binman_entry_find(const char *name, struct binman_entry *entry);
* binman_section_find_node() - Find a binman node
*
* @name: Name of node to look for
- * @return Node that was found, ofnode_null() if not found
+ * Return: Node that was found, ofnode_null() if not found
*/
ofnode binman_section_find_node(const char *name);
*
* @name: Name of subnode, typically a section. This must be in the top-level
* binman node
- * @return 0 if OK, -EINVAL if there is no /binman node, -ECHILD if multiple
+ * Return: 0 if OK, -EINVAL if there is no /binman node, -ECHILD if multiple
* images are being used but the first image is not available, -ENOENT if
* the requested subnode cannot be found
*/
*
* This locates the binary symbol information in the device tree ready for use
*
- * @return 0 if OK, -ENOMEM if out of memory, -EINVAL if there is no binman node
+ * Return: 0 if OK, -ENOMEM if out of memory, -EINVAL if there is no binman node
*/
int binman_init(void);
* @param blksz - size in bytes of each block
* @param buf - buffer to contain cached data
*
- * @return - 1 if block returned from cache, 0 otherwise.
+ * Return: - 1 if block returned from cache, 0 otherwise.
*/
int blkcache_read(int iftype, int dev,
lbaint_t start, lbaint_t blkcnt,
* @if_type: Interface type (enum if_type_t)
* @devnum: Device number (specific to each interface type)
* @devp: the device, if found
- * @return 0 if found, -ENODEV if no device found, or other -ve error value
+ * Return: 0 if found, -ENODEV if no device found, or other -ve error value
*/
int blk_find_device(int if_type, int devnum, struct udevice **devp);
* @if_type: Interface type (enum if_type_t)
* @devnum: Device number (specific to each interface type)
* @devp: the device, if found
- * @return 0 if found, -ENODEV if no device found, or other -ve error value
+ * Return: 0 if found, -ENODEV if no device found, or other -ve error value
*/
int blk_get_device(int if_type, int devnum, struct udevice **devp);
*
* @devnum: Device number (specific to each interface type)
* @devp: the device, if found
- * @return 0 if found, -ENODEV if no device, or other -ve error value
+ * Return: 0 if found, -ENODEV if no device, or other -ve error value
*/
int blk_first_device(int if_type, struct udevice **devp);
*
* @devp: On entry, the previous device returned. On exit, the next
* device, if found
- * @return 0 if found, -ENODEV if no device, or other -ve error value
+ * Return: 0 if found, -ENODEV if no device, or other -ve error value
*/
int blk_next_device(struct udevice **devp);
* The devices are removed and then unbound.
*
* @if_type: Interface type to unbind
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int blk_unbind_all(int if_type);
* next number is safe to use for a newly allocated device.
*
* @if_type: Interface type to scan
- * @return maximum device number found, or -ENODEV if none, or other -ve on
+ * Return: maximum device number found, or -ENODEV if none, or other -ve on
* error
*/
int blk_find_max_devnum(enum if_type if_type);
* an interface type @if_type.
*
* @if_type: Interface type to scan
- * @return next device number safe to use, or -ve on error
+ * Return: next device number safe to use, or -ve on error
*/
int blk_next_free_devnum(enum if_type if_type);
*
* @dev: Device to update
* @hwpart: Partition number to select
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int blk_select_hwpart(struct udevice *dev, int hwpart);
*
* @if_type: Block device type
* @devnum: Device number
- * @return point to block device descriptor, or NULL if not found
+ * Return: point to block device descriptor, or NULL if not found
*/
struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum);
*
* @if_typename: Block device type name
* @devnum: Device number
- * @return point to block device descriptor, or NULL if not found
+ * Return: point to block device descriptor, or NULL if not found
*/
struct blk_desc *blk_get_devnum_by_typename(const char *if_typename,
int devnum);
*
* @desc: Block device descriptor for the device to select
* @hwpart: Partition number to select
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int blk_dselect_hwpart(struct blk_desc *desc, int hwpart);
* then displays a list of partitions.
*
* @if_type: Block device type
- * @return 0 if OK, -ENODEV if there is none of that type
+ * Return: 0 if OK, -ENODEV if there is none of that type
*/
int blk_list_part(enum if_type if_type);
*
* @if_type: Block device type
* @devnum: Device number
- * @return 0 if OK, -ENODEV for invalid device number
+ * Return: 0 if OK, -ENODEV for invalid device number
*/
int blk_show_device(enum if_type if_type, int devnum);
*
* @if_type: Block device type
* @devnum: Device number
- * @return 0 if OK, -ENODEV for invalid device number, -ENOENT if the block
+ * Return: 0 if OK, -ENODEV for invalid device number, -ENOENT if the block
* device is not connected
*/
int blk_print_device_num(enum if_type if_type, int devnum);
*
* @if_type: Block device type
* @devnum: Device number
- * @return 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if
+ * Return: 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if
* the interface type is not supported, other -ve on other error
*/
int blk_print_part_devnum(enum if_type if_type, int devnum);
* @devnum: Device number
* @blkcnt: Number of blocks to read
* @buffer: Address to write data to
- * @return number of blocks read, or -ve error number on error
+ * Return: number of blocks read, or -ve error number on error
*/
ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start,
lbaint_t blkcnt, void *buffer);
* @devnum: Device number
* @blkcnt: Number of blocks to write
* @buffer: Address to read data from
- * @return number of blocks written, or -ve error number on error
+ * Return: number of blocks written, or -ve error number on error
*/
ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start,
lbaint_t blkcnt, const void *buffer);
* @if_type: Block device type
* @devnum: Device number
* @hwpart: Partition number to select
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart);
* blk_get_if_type_name() - Get the name of an interface type
*
* @if_type: Interface type to check
- * @return name of interface, or NULL if none
+ * Return: name of interface, or NULL if none
*/
const char *blk_get_if_type_name(enum if_type if_type);
* @argv: Command arguments
* @if_type: Interface type
* @cur_devnump: Current device number for this interface type
- * @return 0 if OK, CMD_RET_ERROR on error
+ * Return: 0 if OK, CMD_RET_ERROR on error
*/
int blk_common_cmd(int argc, char *const argv[], enum if_type if_type,
int *cur_devnump);
*
* @flags: Indicates type of device to return
* @devp: Returns pointer to the first device in that uclass, or NULL if none
- * @return 0 if found, -ENODEV if not found, other -ve on error
+ * Return: 0 if found, -ENODEV if not found, other -ve on error
*/
int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp);
* @devp: On entry, pointer to device to lookup. On exit, returns pointer
* to the next device in the uclass if no error occurred, or -ENODEV if
* there is no next device.
- * @return 0 if found, -ENODEV if not found, other -ve on error
+ * Return: 0 if found, -ENODEV if not found, other -ve on error
*/
int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp);
* blk_count_devices() - count the number of devices of a particular type
*
* @flags: Indicates type of device to find
- * @return number of devices matching those flags
+ * Return: number of devices matching those flags
*/
int blk_count_devices(enum blk_flag_t flag);
* locate_dtb_in_fit - Find a DTB matching the board in a FIT image
* @fit: pointer to the FIT image
*
- * @return a pointer to a matching DTB blob if found, NULL otherwise
+ * Return: a pointer to a matching DTB blob if found, NULL otherwise
*/
void *locate_dtb_in_fit(const void *fit);
*
* @dev: Device to read from
* @bootcount: Place to put the current bootcount
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_bootcount_get(struct udevice *dev, u32 *bootcount);
*
* @dev: Device to read from
* @bootcount: Value to be written to the backing storage
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_bootcount_set(struct udevice *dev, u32 bootcount);
/**
* bootcount_load() - load the current bootcount
*
- * @return bootcount, read from the appropriate location
+ * Return: bootcount, read from the appropriate location
*/
ulong bootcount_load(void);
* argc is adjusted accordingly. This avoids confusion as to how
* many arguments are available for the OS.
* @images: Pointers to os/initrd/fdt
- * @return 1 on error. On success the OS boots so this function does
+ * Return: 1 on error. On success the OS boots so this function does
* not return.
*/
typedef int boot_os_fn(int flag, int argc, char *const argv[],
* @buf: buffer holding commandline string to adjust
* @maxlen: Maximum length of buffer at @buf (including \0)
* @flags: Flags to control what happens (see bootm_cmdline_t)
- * @return 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
+ * Return: 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
* long
*/
int bootm_process_cmdline(char *buf, int maxlen, int flags);
* - performing substitutions in the command line ('bootargs_subst' envvar)
*
* @flags: Flags to control what happens (see bootm_cmdline_t)
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
int bootm_process_cmdline_env(int flags);
* Check for a keypress repeatedly, resetting the watchdog each time. If a
* keypress is not received within the command timeout, return an error.
*
- * @return 0 if a key is received in time, -ETIMEDOUT if not
+ * Return: 0 if a key is received in time, -ETIMEDOUT if not
*/
int bootretry_tstc_timeout(void);
* Call this after relocation has happened and after malloc has been initted.
* We need to copy any pointers in bootstage records that were added pre-
* relocation, since memory can be overwritten later.
- * @return Always returns 0, to indicate success
+ * Return: Always returns 0, to indicate success
*/
int bootstage_relocate(void);
* @param file Filename to record (NULL if none)
* @param func Function name to record
* @param linenum Line number to record
- * @return recorded time stamp
+ * Return: recorded time stamp
*/
ulong bootstage_mark_code(const char *file, const char *func,
int linenum);
*
* @param id Bootstage id to record this timestamp against
* @param name Textual name to display for this id in the report (maybe NULL)
- * @return start timestamp in microseconds
+ * Return: start timestamp in microseconds
*/
uint32_t bootstage_start(enum bootstage_id id, const char *name);
* as many times as you like.
*
* @param id Bootstage id to record this timestamp against
- * @return time spent in this iteration of the activity (i.e. the time now
+ * Return: time spent in this iteration of the activity (i.e. the time now
* less the start time recorded in the last bootstage_start() call
* with this id.
*/
/**
* Add bootstage information to the device tree
*
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
int bootstage_fdt_add_report(void);
*
* @param base Base address of memory buffer
* @param size Size of memory buffer
- * @return 0 if stashed ok, -1 if out of space
+ * Return: 0 if stashed ok, -1 if out of space
*/
int bootstage_stash(void *base, int size);
*
* @param base Base address of memory buffer
* @param size Size of memory buffer (-1 if unknown)
- * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
+ * Return: 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
* there is not space for read the stashed data, or other error if
* something else went wrong
*/
/**
* bootstage_get_size() - Get the size of the bootstage data
*
- * @return size of boostage data in bytes
+ * Return: size of boostage data in bytes
*/
int bootstage_get_size(void);
*
* @label: button label to look up
* @devp: Returns the associated device, if found
- * @return 0 if found, -ENODEV if not found, other -ve on error
+ * Return: 0 if found, -ENODEV if not found, other -ve on error
*/
int button_get_by_label(const char *label, struct udevice **devp);
* button_get_state() - get the state of a button
*
* @dev: button device to change
- * @return button state button_state_t, or -ve on error
+ * Return: button state button_state_t, or -ve on error
*/
enum button_state_t button_get_state(struct udevice *dev);
*
* @dev: Device to check (UCLASS_CACHE)
* @info: Returns cache info
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cache_get_info(struct udevice *dev, struct cache_info *info);
* cache_enable() - Enable cache
*
* @dev: Device to check (UCLASS_CACHE)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cache_enable(struct udevice *dev);
* cache_disable() - Flush and disable cache
*
* @dev: Device to check (UCLASS_CACHE)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cache_disable(struct udevice *dev);
#endif
* file_cbfs_error() - Return a string describing the most recent error
* condition.
*
- * @return A pointer to the constant string.
+ * Return: A pointer to the constant string.
*/
const char *file_cbfs_error(void);
/**
* cbfs_get_result() - Get the result of the last CBFS operation
*
- *@return last result
+ *Return: last result
*/
enum cbfs_result cbfs_get_result(void);
* file_cbfs_init() - Initialize the CBFS driver and load metadata into RAM.
*
* @end_of_rom: Points to the end of the ROM the CBFS should be read from
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int file_cbfs_init(ulong end_of_rom);
/**
* file_cbfs_get_header() - Get the header structure for the current CBFS.
*
- * @return A pointer to the constant structure, or NULL if there is none.
+ * Return: A pointer to the constant structure, or NULL if there is none.
*/
const struct cbfs_header *file_cbfs_get_header(void);
/**
* cbfs_get_first() - Get the first file in a CBFS
*
- * @return pointer to first file, or NULL if it is empty
+ * Return: pointer to first file, or NULL if it is empty
*/
const struct cbfs_cachenode *cbfs_get_first(const struct cbfs_priv *priv);
/**
* file_cbfs_get_first() - Get a handle for the first file in CBFS.
*
- * @return A handle for the first file in CBFS, NULL on error.
+ * Return: A handle for the first file in CBFS, NULL on error.
*/
const struct cbfs_cachenode *file_cbfs_get_first(void);
*
* @name: The name to search for.
*
- * @return A handle to the file, or NULL on error.
+ * Return: A handle to the file, or NULL on error.
*/
const struct cbfs_cachenode *file_cbfs_find(const char *name);
*
* @cbfs: CBFS to look in (use cbfs_init_mem() to set it up)
* @name: Filename to look for
- * @return pointer to CBFS node if found, else NULL
+ * Return: pointer to CBFS node if found, else NULL
*/
const struct cbfs_cachenode *cbfs_find_file(struct cbfs_priv *cbfs,
const char *name);
* @size: Size of CBFS if known, else CBFS_SIZE_UNKNOWN
* @require_header: true to read a header at the start, false to not require one
* @cbfsp: Returns a pointer to CBFS on success
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cbfs_init_mem(ulong base, ulong size, bool require_hdr,
struct cbfs_priv **privp);
* @end_of_rom: Points to the end of the ROM the CBFS should be read from
* @name: The name to search for
* @node: Returns the contents of the node if found (i.e. copied into *node)
- * @return 0 on success, -ENOENT if not found, -EFAULT on bad header
+ * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header
*/
int file_cbfs_find_uncached(ulong end_of_rom, const char *name,
struct cbfs_cachenode *node);
* @base: Points to the base of the CBFS
* @name: The name to search for
* @node: Returns the contents of the node if found (i.e. copied into *node)
- * @return 0 on success, -ENOENT if not found, -EFAULT on bad header
+ * Return: 0 on success, -ENOENT if not found, -EFAULT on bad header
*/
int file_cbfs_find_uncached_base(ulong base, const char *name,
struct cbfs_cachenode *node);
*
* @file: The handle to the file.
*
- * @return The name of the file, NULL on error.
+ * Return: The name of the file, NULL on error.
*/
const char *file_cbfs_name(const struct cbfs_cachenode *file);
*
* @file: The handle to the file.
*
- * @return The size of the file, zero on error.
+ * Return: The size of the file, zero on error.
*/
u32 file_cbfs_size(const struct cbfs_cachenode *file);
*
* @file: The handle to the file.
*
- * @return The type of the file, zero on error.
+ * Return: The type of the file, zero on error.
*/
u32 file_cbfs_type(const struct cbfs_cachenode *file);
* @buffer: Where to read it into memory.
* @maxsize: Maximum number of bytes to read
*
- * @return If positive or zero, the number of characters read. If negative, an
+ * Return: If positive or zero, the number of characters read. If negative, an
* error occurred.
*/
long file_cbfs_read(const struct cbfs_cachenode *file, void *buffer,
*
* @cmd: String containing the command to execute
* @flag Flag value - see CMD_FLAG_...
- * @return 1 - command executed, repeatable
+ * Return: 1 - command executed, repeatable
* 0 - command executed but not repeatable, interrupted commands are
* always considered not repeatable
* -1 - not executed (unrecognized, bootd recursion or too many args)
* @param input Input string possible containing $() / ${} vars
* @param output Output string with $() / ${} vars expanded
* @param max_size Maximum size of @output (including terminator)
- * @return 0 if OK, -ENOSPC if we ran out of space in @output
+ * Return: 0 if OK, -ENOSPC if we ran out of space in @output
*/
int cli_simple_process_macros(const char *input, char *output, int max_size);
*
* @param cmd String containing list of commands
* @param flag Execution flags (CMD_FLAG_...)
- * @return 0 on success, or != 0 on error.
+ * Return: 0 on success, or != 0 on error.
*/
int cli_simple_run_command_list(char *cmd, int flag);
* This is a convenience function which calls cli_readline_into_buffer().
*
* @prompt: Prompt to display
- * @return command line length excluding terminator, or -ve on error
+ * Return: command line length excluding terminator, or -ve on error
*/
int cli_readline(const char *const prompt);
* @prompt: Prompt to display
* @buffer: Place to put the line that is entered
* @timeout: Timeout in milliseconds, 0 if none
- * @return command line length excluding terminator, or -ve on error: of the
+ * Return: command line length excluding terminator, or -ve on error: of the
* timeout is exceeded (either CONFIG_BOOT_RETRY_TIME or the timeout
* parameter), then -2 is returned. If a break is detected (Ctrl-C) then
* -1 is returned.
*
* @line: Command line to parse
* @args: Array to hold arguments
- * @return number of arguments
+ * Return: number of arguments
*/
int cli_simple_parse_line(char *line, char *argv[]);
* @cmdp: On entry, the command that will be executed if the FDT does
* not have a command. Returns the command to execute after
* checking the FDT.
- * @return true to execute securely, else false
+ * Return: true to execute securely, else false
*/
bool cli_process_fdt(const char **cmdp);
* @dev: Device containing the phandle
* @cells: Phandle info
* @clock: A pointer to a clock struct to initialise
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells,
struct clk *clk);
* @index: The index of the clock to request, within the client's list of
* clocks.
* @clock A pointer to a clock struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_get_by_index(struct udevice *dev, int index, struct clk *clk);
* @index: The index of the clock to request, within the client's list of
* clocks.
* @clock A pointer to a clock struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk);
*
* @dev: The client device.
* @bulk A pointer to a clock bulk struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk);
* @name: The name of the clock to request, within the client's list of
* clocks.
* @clock: A pointer to a clock struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk);
* @name: The name of the clock to request, within the client's list of
* clocks.
* @clock: A pointer to a clock struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk);
* @clk: A clock struct array that was previously successfully
* requested by clk_request/get_by_*().
* @count Number of clock contained in the array
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int clk_release_all(struct clk *clk, int count);
*
* @clk: A clock bulk struct that was previously successfully
* requested by clk_get_bulk().
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
static inline int clk_release_bulk(struct clk_bulk *bulk)
{
* @clock: A pointer to a clock struct to initialize. The caller must
* have already initialized any field in this struct which the
* clock provider uses to identify the clock.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_request(struct udevice *dev, struct clk *clk);
*
* @clock: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int clk_free(struct clk *clk);
*
* @clk: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
- * @return clock rate in Hz on success, 0 for invalid clock, or -ve error code
+ * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code
* for other errors.
*/
ulong clk_get_rate(struct clk *clk);
*
* @clk: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
- * @return pointer to parent's struct clk, or error code passed as pointer
+ * Return: pointer to parent's struct clk, or error code passed as pointer
*/
struct clk *clk_get_parent(struct clk *clk);
*
* @clk: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
- * @return clock rate in Hz, or -ve error code.
+ * Return: clock rate in Hz, or -ve error code.
*/
long long clk_get_parent_rate(struct clk *clk);
* @clk: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
* @rate: desired clock rate in Hz.
- * @return rounded rate in Hz, or -ve error code.
+ * Return: rounded rate in Hz, or -ve error code.
*/
ulong clk_round_rate(struct clk *clk, ulong rate);
* @clk: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
* @rate: New clock rate in Hz.
- * @return new rate, or -ve error code.
+ * Return: new rate, or -ve error code.
*/
ulong clk_set_rate(struct clk *clk, ulong rate);
* clk_request/get_by_*().
* @parent: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
- * @return new rate, or -ve error code.
+ * Return: new rate, or -ve error code.
*/
int clk_set_parent(struct clk *clk, struct clk *parent);
*
* @clk: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int clk_enable(struct clk *clk);
*
* @bulk: A clock bulk struct that was previously successfully requested
* by clk_get_bulk().
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int clk_enable_bulk(struct clk_bulk *bulk);
*
* @clk: A clock struct that was previously successfully requested by
* clk_request/get_by_*().
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int clk_disable(struct clk *clk);
*
* @bulk: A clock bulk struct that was previously successfully requested
* by clk_get_bulk().
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int clk_disable_bulk(struct clk_bulk *bulk);
*
* @clkp: A pointer to clock struct that has been found among added clocks
* to UCLASS_CLK
- * @return zero on success, or -ENOENT on error
+ * Return: zero on success, or -ENOENT on error
*/
int clk_get_by_id(ulong id, struct clk **clkp);
*
* @clk A pointer to the clk
*
- * @return true on binded, or false on no
+ * Return: true on binded, or false on no
*/
bool clk_dev_binded(struct clk *clk);
* clk_valid() - check if clk is valid
*
* @clk: the clock to check
- * @return true if valid, or false
+ * Return: true if valid, or false
*/
static inline bool clk_valid(struct clk *clk)
{
*
* @dev: reset device
* @count: reset count
- * @return 0 success, or error value
+ * Return: 0 success, or error value
*/
int sunxi_reset_bind(struct udevice *dev, ulong count);
*
* @cmdtp: Command which caused the error
* @err: Error code (0 if none, -ve for error, like -EIO)
- * @return 0 (CMD_RET_SUCCESS) if there is not error,
+ * Return: 0 (CMD_RET_SUCCESS) if there is not error,
* 1 (CMD_RET_FAILURE) if an error is found
* -1 (CMD_RET_USAGE) if 'usage' error is found
*/
* @arg: Pointers to the command to check. If a valid specifier is present it
* will be the last character of the string, following a '.'
* @default_size: Default size to return if there is no specifier
- * @return data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid
+ * Return: data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid
* character, or CMD_DATA_SIZE_STR for a string
*/
int cmd_get_data_size(char *arg, int default_size);
* @s: String to replace with
* @global: true to replace all matches in @data, false to replace just the
* first
- * @return 0 if OK, 1 on error
+ * Return: 0 if OK, 1 on error
*/
int setexpr_regex_sub(char *data, uint data_size, char *nbuf, uint nbuf_size,
const char *r, const char *s, bool global);
* is left unchanged.
* @param ticks If ticks is not null, this function set it to the
* number of ticks the command took to complete.
- * @return 0 if the command succeeded, 1 if it failed
+ * Return: 0 if the command succeeded, 1 if it failed
*/
int cmd_process(int flag, int argc, char *const argv[], int *repeatable,
unsigned long *ticks);
* simply hang.
*
* @cmdline: Command line string to execute
- * @return 0 if OK, 1 for error
+ * Return: 0 if OK, 1 for error
*/
int board_run_command(const char *cmdline);
* @param cmd List of commands to run, each separated bu semicolon
* @param len Length of commands excluding terminator if known (-1 if not)
* @param flag Execution flags (CMD_FLAG_...)
- * @return 0 on success, or != 0 on error.
+ * Return: 0 on success, or != 0 on error.
*/
int run_command_list(const char *cmd, int len, int flag);
#endif /* __ASSEMBLY__ */
/**
* tools_build() - check if we are building host tools
*
- * @return true if building for the host, false if for a target
+ * Return: true if building for the host, false if for a target
*/
static inline bool tools_build(void)
{
* Iterates over registered STDIO devices and match them with given @flags
* and @name.
*
- * @return pointer to the &struct stdio_dev if found, or NULL otherwise
+ * Return: pointer to the &struct stdio_dev if found, or NULL otherwise
*/
struct stdio_dev *console_search_dev(int flags, const char *name);
* This should be called as soon as malloc() is available so that the maximum
* amount of console output can be recorded.
*
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
int console_record_init(void);
*
* This should be called to enable the console buffer.
*
- * @return 0 (always)
+ * Return: 0 (always)
*/
int console_record_reset_enable(void);
*
* @str: Place to put string
* @maxlen: Maximum length of @str including nul terminator
- * @return length of string returned, or -ENOSPC if the console buffer was
+ * Return: length of string returned, or -ENOSPC if the console buffer was
* overflowed by the output
*/
int console_record_readline(char *str, int maxlen);
/**
* console_record_avail() - Get the number of available bytes in console output
*
- * @return available bytes (0 if empty)
+ * Return: available bytes (0 if empty)
*/
int console_record_avail(void);
* returned if a function calls e.g. `getc()`
*
* @str: the string to write
- * @return the number of bytes added
+ * Return: the number of bytes added
*/
int console_in_puts(const char *str);
#else
* This function prints a banner on devices which (we assume) did not receive
* it before relocation.
*
- * @return 0 (meaning no errors)
+ * Return: 0 (meaning no errors)
*/
int console_announce_r(void);
* This is used on PowerPC, SH and X86 machines as a CPU init mechanism. It is
* called during the pre-relocation init sequence in board_init_f().
*
- * @return 0 if oK, -ve on error
+ * Return: 0 if oK, -ve on error
*/
int checkcpu(void);
* @param dev CROS-EC device
* @param id Place to put the ID
* @param maxlen Maximum length of the ID field
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_read_id(struct udevice *dev, char *id, int maxlen);
*
* @param dev CROS-EC device
* @param scan Place to put the scan results
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan);
* Send a message requesting the next event and return the result.
*
* @param event Place to put the event.
- * @return 0 if ok, <0 on error.
+ * Return: 0 if ok, <0 on error.
*/
int cros_ec_get_next_event(struct udevice *dev,
struct ec_response_get_next_event *event);
*
* @param dev CROS-EC device
* @param image Destination for image identifier
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
*/
int cros_ec_read_current_image(struct udevice *dev,
enum ec_current_image *image);
* @param dev CROS-EC device
* @param hash_offset Offset in flash to read from
* @param hash Destination for hash information
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
*/
int cros_ec_read_hash(struct udevice *dev, uint hash_offset,
struct ec_response_vboot_hash *hash);
* @param dev CROS-EC device
* @param cmd Reboot command
* @param flags Flags for reboot command (EC_REBOOT_FLAG_*)
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
*/
int cros_ec_reboot(struct udevice *dev, enum ec_reboot_cmd cmd, uint8_t flags);
* If no external interrupt is configured, this always returns 1.
*
* @param dev CROS-EC device
- * @return 0 if no interrupt is pending
+ * Return: 0 if no interrupt is pending
*/
int cros_ec_interrupt_pending(struct udevice *dev);
*
* @param blob Device tree blob containing setup information
* @param cros_ecp Returns pointer to the cros_ec device, or NULL if none
- * @return 0 if we got an cros_ec device and all is well (or no cros_ec is
+ * Return: 0 if we got an cros_ec device and all is well (or no cros_ec is
* expected), -ve if we should have an cros_ec device but failed to find
* one, or init failed (-CROS_EC_ERR_...).
*/
*
* @param dev CROS-EC device
* @param events_ptr Destination for event flags. Not changed on error.
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
*/
int cros_ec_get_host_events(struct udevice *dev, uint32_t *events_ptr);
*
* @param dev CROS-EC device
* @param events Event flags to clear
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
*/
int cros_ec_clear_host_events(struct udevice *dev, uint32_t events);
* @param set_flags New flag values; only bits in set_mask are applied;
* ignored if set_mask=0.
* @param prot Destination for updated protection state from EC.
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
*/
int cros_ec_flash_protect(struct udevice *dev, uint32_t set_mask,
uint32_t set_flags,
* Run internal tests on the cros_ec interface.
*
* @param dev CROS-EC device
- * @return 0 if ok, <0 if the test failed
+ * Return: 0 if ok, <0 if the test failed
*/
int cros_ec_test(struct udevice *dev);
* @param dev CROS-EC device
* @param image the content to write
* @param imafge_size content length
- * @return 0 if ok, <0 if the test failed
+ * Return: 0 if ok, <0 if the test failed
*/
int cros_ec_flash_update_rw(struct udevice *dev, const uint8_t *image,
int image_size);
/**
* Return a pointer to the board's CROS-EC device
*
- * @return pointer to CROS-EC device, or NULL if none is available
+ * Return: pointer to CROS-EC device, or NULL if none is available
*/
struct udevice *board_get_cros_ec_dev(void);
*
* @param data Data block to checksum
* @param size Size of data block in bytes
- * @return checksum value (0 to 255)
+ * Return: checksum value (0 to 255)
*/
int cros_ec_calc_checksum(const uint8_t *data, int size);
* @param data Pointer to data buffer to read into
* @param offset Offset within flash to read from
* @param size Number of bytes to read
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_flash_read(struct udevice *dev, uint8_t *data, uint32_t offset,
uint32_t size);
* @param data Pointer to data buffer to write
* @param offset Offset within flash to write to.
* @param size Number of bytes to write
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_flash_write(struct udevice *dev, const uint8_t *data,
uint32_t offset, uint32_t size);
* @param region Flash region to query
* @param offset Returns offset of flash region in EC flash
* @param size Returns size of flash region
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_flash_offset(struct udevice *dev, enum ec_flash_region region,
uint32_t *offset, uint32_t *size);
*
* @param dev CROS-EC device
* @param block Buffer of VbNvContext to be read/write
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_read_nvdata(struct udevice *dev, uint8_t *block, int size);
int cros_ec_write_nvdata(struct udevice *dev, const uint8_t *block, int size);
*
* @param dev CROS-EC device
* @param versionp This is set to point to the version information
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_read_version(struct udevice *dev,
struct ec_response_get_version **versionp);
*
* @param dev CROS-EC device
* @param versionp This is set to point to the build string
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_read_build_info(struct udevice *dev, char **strp);
* @param dev CROS-EC device
* @param index index of the LDO/FET to switch
* @param state new state of the LDO/FET : EC_LDO_STATE_ON|OFF
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state);
* @param dev CROS-EC device
* @param index index of the LDO/FET to switch
* @param state current state of the LDO/FET : EC_LDO_STATE_ON|OFF
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state);
* This permits delayed reporting of the EC error if it failed during
* early init.
*
- * @return error (0 if there was no error, -ve if there was an error)
+ * Return: error (0 if there was no error, -ve if there was an error)
*/
int cros_ec_get_error(void);
/**
* cros_ec_get_events_b() - Get event mask B
*
- * @return value of event mask, default value of 0 if it could not be read
+ * Return: value of event mask, default value of 0 if it could not be read
*/
uint64_t cros_ec_get_events_b(struct udevice *dev);
*
* Any pending events in the B range are cleared
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_clear_events_b(struct udevice *dev, uint64_t mask);
*
* @param dev CROS-EC device
* @param region Flash region to query
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region);
*
* @param dev CROS-EC device
* @param flags Flags to use (EC_BATTERY_CUTOFF_FLAG_...)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_battery_cutoff(struct udevice *dev, uint8_t flags);
* @param dev CROS-EC device
* @param index Index of the pwm
* @param duty Desired duty cycle, in 0..EC_PWM_MAX_DUTY range.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_set_pwm_duty(struct udevice *dev, uint8_t index, uint16_t duty);
*
* @param dev CROS-EC device
* @param limit_powerp Returns whether power is limited (0 or 1)
- * @return 0 if OK, -ENOSYS if the EC does not support this comment, -EINVAL
+ * Return: 0 if OK, -ENOSYS if the EC does not support this comment, -EINVAL
* if the EC returned an invalid response
*/
int cros_ec_read_limit_power(struct udevice *dev, int *limit_powerp);
*
* @param dev CROS-EC device
* @param flags Flags to use (EC_POWER_BUTTON_...)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_config_powerbtn(struct udevice *dev, uint32_t flags);
* Determines whether a lid close event is reported
*
* @param dev CROS-EC device
- * @return shufdown mas if OK, -ve on error
+ * Return: shufdown mas if OK, -ve on error
*/
int cros_ec_get_lid_shutdown_mask(struct udevice *dev);
*
* @param dev CROS-EC device
* @param enable true to enable reporting, false to disable
- * @return shufdown mas if OK, -ve on error
+ * Return: shufdown mas if OK, -ve on error
*/
int cros_ec_set_lid_shutdown_mask(struct udevice *dev, int enable);
*
* @dev: CROS-EC device
* @handshakep: If non-NULL, returns received handshake value on error
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_hello(struct udevice *dev, uint *handshakep);
*
* @dev: CROS-EC device
* @featuresp: Returns a bitmask of supported features
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_get_features(struct udevice *dev, u64 *featuresp);
*
* @dev: CROS-EC device
* @feature: Feature number to check (enum ec_feature_code)
- * @return true if supported, false if not, -ve on error
+ * Return: true if supported, false if not, -ve on error
*/
int cros_ec_check_feature(struct udevice *dev, uint feature);
* cros_ec_get_switches() - Get switches value
*
* @dev: CROS-EC device
- * @return switches value, or -ENOSYS if not supported, or other -ve value on
+ * Return: switches value, or -ENOSYS if not supported, or other -ve value on
* other error
*/
int cros_ec_get_switches(struct udevice *dev);
* cros_ec_vstore_supported() - Check if vstore is supported
*
* @dev: CROS-EC device
- * @return false if not supported, true if supported, -ve on error
+ * Return: false if not supported, true if supported, -ve on error
*/
int cros_ec_vstore_supported(struct udevice *dev);
*
* @dev: CROS-EC device
* @lockedp: mask of locked slots
- * @return number of vstore slots supported by the EC,, -ve on error
+ * Return: number of vstore slots supported by the EC,, -ve on error
*/
int cros_ec_vstore_info(struct udevice *dev, u32 *lockedp);
* @dev: CROS-EC device
* @slot: vstore slot to read from
* @data: buffer to store read data, must be EC_VSTORE_SLOT_SIZE bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_vstore_read(struct udevice *dev, int slot, uint8_t *data);
* @slot: vstore slot to write into
* @data: data to write
* @size: size of data in bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int cros_ec_vstore_write(struct udevice *dev, int slot, const uint8_t *data,
size_t size);
* @equal Pointer to an int where the result is stored
* '0' = unequal
* '1' = equal
- * @return 0 on success, error code of errno else
+ * Return: 0 on success, error code of errno else
*/
int crypt_compare(const char *should, const char *passphrase, int *equal);
* display_read_timing() - Read timing information
*
* @dev: Device to read from
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int display_read_timing(struct udevice *dev, struct display_timing *timing);
* @dev: Device to enable
* @panel_bpp: Number of bits per pixel for panel
* @timing: Display timings
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int display_enable(struct udevice *dev, int panel_bpp,
const struct display_timing *timing);
/**
* display_in_use() - Check if a display is in use by any device
*
- * @return true if the device is in use (display_enable() has been called
+ * Return: true if the device is in use (display_enable() has been called
* successfully), else false
*/
bool display_in_use(struct udevice *dev);
* @linelen: Number of values to print per line; specify 0 for default length
* @out: Output buffer to hold the dump
* @size: Size of output buffer in bytes
- * @return number of bytes processed, if OK, -ENOSPC if buffer too small
+ * Return: number of bytes processed, if OK, -ENOSPC if buffer too small
*
*/
int hexdump_line(ulong addr, const void *data, uint width, uint count,
* @newlines: true to include two newlines at the start
* @buf: place to put string
* @size: Size of buf (string is truncated to fit)
- * @return buf
+ * Return: buf
*/
char *display_options_get_banner(bool newlines, char *buf, int size);
* @dev: Device to check
* @out_name: Place to put the name, must hold at least ACPI_NAME_MAX
* bytes
- * @return 0 if OK, -ENOENT if no name is available, other -ve value on
+ * Return: 0 if OK, -ENOENT if no name is available, other -ve value on
* other error
*/
int acpi_get_name(const struct udevice *dev, char *out_name);
*
* @out_name: Place to put the name
* @name: Name to copy
- * @return 0 (always)
+ * Return: 0 (always)
*/
int acpi_copy_name(char *out_name, const char *name);
* This scans through all devices and tells them to write any tables they want
* to write.
*
- * @return 0 if OK, -ve if any device returned an error
+ * Return: 0 if OK, -ve if any device returned an error
*/
int acpi_write_dev_tables(struct acpi_ctx *ctx);
* This is called to create the SSDT code for all devices.
*
* @ctx: ACPI context to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_fill_ssdt(struct acpi_ctx *ctx);
* This is called to create the DSDT code for all devices.
*
* @ctx: ACPI context to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_inject_dsdt(struct acpi_ctx *ctx);
*
* @ctx: ACPI context to use
* @nhlt: Pointer to nhlt information to add to
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_setup_nhlt(struct acpi_ctx *ctx, struct nhlt *nhlt);
* @dev: Device to check
* @out_path: Buffer to place the path in (should be ACPI_PATH_MAX long)
* @maxlen: Size of buffer (typically ACPI_PATH_MAX)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen);
* @ofnode: Devicetree node for this device. This is ofnode_null() for
* devices which don't use devicetree or don't have a node.
* @devp: if non-NULL, returns a pointer to the bound device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int device_bind(struct udevice *parent, const struct driver *drv,
const char *name, void *plat, ofnode node,
* @node: Device tree node for this device. This is invalid for devices which
* don't use device tree.
* @devp: if non-NULL, returns a pointer to the bound device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int device_bind_with_driver_data(struct udevice *parent,
const struct driver *drv, const char *name,
* is set. If false bind the driver always.
* @info: Name and plat for this device
* @devp: if non-NULL, returns a pointer to the bound device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int device_bind_by_name(struct udevice *parent, bool pre_reloc_only,
const struct driver_info *info, struct udevice **devp);
*
* @dev: pointer to device to be reparented
* @new_parent: pointer to new parent device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int device_reparent(struct udevice *dev, struct udevice *new_parent);
* All private data associated with the device is allocated.
*
* @dev: Pointer to device to process
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int device_of_to_plat(struct udevice *dev);
* first.
*
* @dev: Pointer to device to probe
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int device_probe(struct udevice *dev);
*
* @dev: Pointer to device to remove
* @flags: Flags for selective device removal (DM_REMOVE_...)
- * @return 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if
+ * Return: 0 if OK, -EKEYREJECTED if not removed due to flags, -EPROBE_DEFER if
* this is a vital device and flags is DM_REMOVE_NON_VITAL, other -ve on
* error (such an error here is normally a very bad thing)
*/
* Unbind a device and remove all memory used by it
*
* @dev: Pointer to device to unbind
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
int device_unbind(struct udevice *dev);
*
* @dev: The device that is to be stripped of its children
* @drv: The targeted driver
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
int device_chld_unbind(struct udevice *dev, struct driver *drv);
* @dev: The device whose children are to be removed
* @drv: The targeted driver
* @flags: Flag, if this functions is called in the pre-OS stage
- * @return 0 on success, -EPROBE_DEFER if any child failed to remove, other
+ * Return: 0 on success, -EPROBE_DEFER if any child failed to remove, other
* -ve on error
*/
#if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
*
* @dev: Simple bus device (parent of target device)
* @addr: Address to translate
- * @return new address
+ * Return: new address
*/
fdt_addr_t simple_bus_translate(struct udevice *dev, fdt_addr_t addr);
* This returns an int to avoid a dependency on pci.h
*
* @dev: PCI device
- * @return devfn in bits 15...8 if found (pci_dev_t format), or -ENODEV if not
+ * Return: devfn in bits 15...8 if found (pci_dev_t format), or -ENODEV if not
* found
*/
int pci_get_devfn(struct udevice *dev);
* @reg: reg value from dt-plat.c array (first member). This is not a
* pointer type, since the caller may use fdt32_t or fdt64_t depending on
* the address sizes.
- * @return device/function for that device (pci_dev_t format)
+ * Return: device/function for that device (pci_dev_t format)
*/
static inline int pci_ofplat_get_devfn(u32 reg)
{
* @dev: Device to operate on
* @pingval: Value to ping the device with
* @pingret: Returns resulting value from driver
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
struct test_ops {
int (*ping)(struct udevice *dev, int pingval, int *pingret);
* @dev: Device to test
* @base: Base address, used to check ping return value
* @priv: Pointer to private test information
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_check_operations(struct unit_test_state *uts, struct udevice *dev,
uint32_t base, struct dm_test_priv *priv);
*
* @dms: Overall test state
* @num_devices: Number of test devices to check
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_check_devices(struct unit_test_state *uts, int num_devices);
* This allows assigning the sequence number in the binding order.
*
* @uc: uclass to check
- * @return The next free sequence number
+ * Return: The next free sequence number
*/
int uclass_find_next_free_seq(struct uclass *uc);
* @dev: Device that needs to be probed
* @ret: Error to return. If non-zero then the device is not probed
* @devp: Returns the value of 'dev' if there is no error
- * @return ret, if non-zero, else the result of the device_probe() call
+ * Return: ret, if non-zero, else the result of the device_probe() call
*/
int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp);
*
* The device is not prepared for use - this is an internal function.
*
- * @return the index of the device in the uclass list or -ENODEV if not found.
+ * Return: the index of the device in the uclass list or -ENODEV if not found.
*/
int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp);
* The device is not prepared for use - this is an internal function.
* The function uclass_get_device_tail() can be used to probe the device.
*
- * @return the uclass pointer of a child at the given index or
+ * Return: the uclass pointer of a child at the given index or
* return NULL on error.
*/
int uclass_find_device(enum uclass_id id, int index, struct udevice **devp);
* The device is not prepared for use - this is an internal function.
* The function uclass_get_device_tail() can be used to probe the device.
*
- * @return 0 if OK (found or not found), -ve on error
+ * Return: 0 if OK (found or not found), -ve on error
*/
int uclass_find_first_device(enum uclass_id id, struct udevice **devp);
* The device is not prepared for use - this is an internal function.
* The function uclass_get_device_tail() can be used to probe the device.
*
- * @return 0 if OK (found or not found), -ve on error
+ * Return: 0 if OK (found or not found), -ve on error
*/
int uclass_find_next_device(struct udevice **devp);
* @id: ID to look up
* @name: name of a device to find
* @devp: Returns pointer to device (the first one with the name)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int uclass_find_device_by_name(enum uclass_id id, const char *name,
struct udevice **devp);
* @id: ID to look up
* @seq: Sequence number to find (0=first)
* @devp: Returns pointer to device (there is only one per for each seq)
- * @return 0 if OK, -ENODEV if not found
+ * Return: 0 if OK, -ENODEV if not found
*/
int uclass_find_device_by_seq(enum uclass_id id, int seq,
struct udevice **devp);
* @id: ID to look up
* @node: Device tree offset to search for (if -ve then -ENODEV is returned)
* @devp: Returns pointer to device (there is only one for each node)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int uclass_find_device_by_of_offset(enum uclass_id id, int node,
struct udevice **devp);
* @id: ID to look up
* @node: Device tree offset to search for (if NULL then -ENODEV is returned)
* @devp: Returns pointer to device (there is only one for each node)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
struct udevice **devp);
* @parent: Parent device containing the phandle pointer
* @name: Name of property in the parent device node
* @devp: Returns pointer to device (there is only one for each node)
- * @return 0 if OK, -ENOENT if there is no @name present in the node, other
+ * Return: 0 if OK, -ENOENT if there is no @name present in the node, other
* -ve on error
*/
int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
* uclass_find() - Find uclass by its id
*
* @id: Id to serach for
- * @return pointer to uclass, or NULL if not found
+ * Return: pointer to uclass, or NULL if not found
*/
struct uclass *uclass_find(enum uclass_id key);
* Destroy a uclass and all its devices
*
* @uc: uclass to destroy
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int uclass_destroy(struct uclass *uc);
* list_count_items() - Count number of items in a list
*
* @param head: Head of list
- * @return number of items, or 0 if empty
+ * Return: number of items, or 0 if empty
*/
int list_count_items(struct list_head *head);
* @index: The index of the DMA to request, within the client's list of
* DMA channels.
* @dma: A pointer to a DMA struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int dma_get_by_index(struct udevice *dev, int index, struct dma *dma);
* @name: The name of the DMA to request, within the client's list of
* DMA channels.
* @dma: A pointer to a DMA struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int dma_get_by_name(struct udevice *dev, const char *name, struct dma *dma);
# else
* @dma: A pointer to a DMA struct to initialize. The caller must
* have already initialized any field in this struct which the
* DMA provider uses to identify the DMA channel.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int dma_request(struct udevice *dev, struct dma *dma);
*
* @dma: A DMA struct that was previously successfully requested by
* dma_request/get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int dma_free(struct dma *dma);
*
* @dma: A DMA struct that was previously successfully requested by
* dma_request/get_by_*().
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int dma_enable(struct dma *dma);
*
* @dma: A DMA struct that was previously successfully requested by
* dma_request/get_by_*().
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int dma_disable(struct dma *dma);
* dma_request/get_by_*().
* @dst: The receive buffer pointer.
* @size: The receive buffer size
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int dma_prepare_rcv_buf(struct dma *dma, void *dst, size_t size);
* dma_request/get_by_*().
* @dst: The destination pointer.
* @metadata: DMA driver's channel specific data
- * @return length of received data on success, or zero - no data,
+ * Return: length of received data on success, or zero - no data,
* or -ve error code.
*/
int dma_receive(struct dma *dma, void **dst, void *metadata);
* @src: The source pointer.
* @len: Length of the data to be sent (number of bytes).
* @metadata: DMA driver's channel specific data
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int dma_send(struct dma *dma, void *src, size_t len, void *metadata);
* configuration data client needs
* @cfg_data: Pointer to store pointer to DMA driver specific
* configuration data for the given cfg_id (output param)
- * @return zero on success, or -ve error code.
+ * Return: zero on success, or -ve error code.
*/
int dma_get_cfg(struct dma *dma, u32 cfg_id, void **cfg_data);
#endif /* CONFIG_DMA_CHANNELS */
* @transfer_type - transfer type should be one/multiple of
* DMA_SUPPORTS_*
* @devp - udevice pointer to return the found device
- * @return - will return on success and devp will hold the
+ * Return: - will return on success and devp will hold the
* pointer to the device
*/
int dma_get_device(u32 transfer_type, struct udevice **devp);
* @dst - destination pointer
* @src - souce pointer
* @len - data length to be copied
- * @return - on successful transfer returns no of bytes
+ * Return: - on successful transfer returns no of bytes
transferred and on failure return error code.
*/
int dma_memcpy(void *dst, void *src, size_t len);
* @timing: Display timings
* @max_data_lanes: maximum number of data lines
* @phy_ops: set of function pointers for performing physical operations
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dsi_host_init(struct udevice *dev,
struct mipi_dsi_device *device,
* dsi_host_enable
*
* @dev: dsi host device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dsi_host_enable(struct udevice *dev);
* @cfg: Empty configuration structure (generally &plat->cfg). This is
* normally all zeroes at this point. The only purpose of passing
* this in is to set mmc->cfg to it.
- * @return 0 if OK, -ve if the block device could not be created
+ * Return: 0 if OK, -ve if the block device could not be created
*/
int dwmci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg);
* @host: DWMMC host structure
* @max_clk: Maximum supported clock speed in HZ (e.g. 150000000)
* @min_clk: Minimum supported clock speed in HZ (e.g. 400000)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int add_dwmci(struct dwmci_host *host, u32 max_clk, u32 min_clk);
#endif /* !CONFIG_BLK */
* Check the EDID info.
*
* @param info The EDID info to be checked
- * @return 0 on valid, or -1 on invalid
+ * Return: 0 on valid, or -1 on invalid
*/
int edid_check_info(struct edid1_info *info);
*
* @param edid_block EDID block data
*
- * @return 0 on success, or a negative errno on error
+ * Return: 0 on success, or a negative errno on error
*/
int edid_check_checksum(u8 *edid_block);
* @param hmax Returns the maxium horizontal rate
* @param vmin Returns the minimum vertical rate
* @param vmax Returns the maxium vertical rate
- * @return 0 on success, or -1 on error
+ * Return: 0 on success, or -1 on error
*/
int edid_get_ranges(struct edid1_info *edid, unsigned int *hmin,
unsigned int *hmax, unsigned int *vmin,
* @param mode_valid Callback validating mode, returning true is mode is
* supported, false otherwise.
* @parem valid_priv Pointer to private data for mode_valid callback
- * @return 0 if timings are OK, -ve on error
+ * Return: 0 if timings are OK, -ve on error
*/
int edid_get_timing_validate(u8 *buf, int buf_size,
struct display_timing *timing,
* @param panel_bits_per_colourp Place to put the number of bits per
* colour supported by the panel. This will be set to
* -1 if not available
- * @return 0 if timings are OK, -ve on error
+ * Return: 0 if timings are OK, -ve on error
*/
int edid_get_timing(u8 *buf, int buf_size, struct display_timing *timing,
int *panel_bits_per_colourp);
*
* Called by bootefi to make ACPI tables available
*
- * @return 0 if OK, -ENOMEM if no memory is available for the tables
+ * Return: 0 if OK, -ENOMEM if no memory is available for the tables
*/
efi_status_t efi_acpi_register(void);
/**
*
* Called by bootefi to make SMBIOS tables available
*
- * @return 0 if OK, -ENOMEM if no memory is available for the tables
+ * Return: 0 if OK, -ENOMEM if no memory is available for the tables
*/
efi_status_t efi_smbios_register(void);
/**
* Install the ESRT system table.
*
- * @return status code
+ * Return: status code
*/
efi_status_t efi_esrt_register(void);
* This value increments every time the environment changes, so can be used an
* an indication of this
*
- * @return environment ID
+ * Return: environment ID
*/
int env_get_id(void);
* This locates the environment or uses the default if nothing is available.
* This must be called before env_get() will work.
*
- * @return 0 if OK, -ENODEV if no environment drivers are enabled
+ * Return: 0 if OK, -ENODEV if no environment drivers are enabled
*/
int env_init(void);
* case this function calls env_get_f().
*
* @varname: Variable to look up
- * @return value of variable, or NULL if not found
+ * Return: value of variable, or NULL if not found
*/
char *env_get(const char *varname);
* place of env_get without changing error handling otherwise.
*
* @varname: Variable to look up
- * @return value of variable, or NULL if not found
+ * Return: value of variable, or NULL if not found
*/
char *from_env(const char *envvar);
* support reading the value (slowly) and some will not.
*
* @varname: Variable to look up
- * @return actual length of the variable value excluding the terminating
+ * Return: actual length of the variable value excluding the terminating
* NULL-byte, or -1 if the variable is not found
*/
int env_get_f(const char *name, char *buf, unsigned int len);
/**
* env_get_yesno() - Read an environment variable as a boolean
*
- * @return 1 if yes/true (Y/y/T/t), -1 if variable does not exist (i.e. default
+ * Return: 1 if yes/true (Y/y/T/t), -1 if variable does not exist (i.e. default
* to true), 0 if otherwise
*/
int env_get_yesno(const char *var);
/**
* env_get_autostart() - Check if autostart is enabled
*
- * @return true if the "autostart" env var exists and is set to "yes"
+ * Return: true if the "autostart" env var exists and is set to "yes"
*/
bool env_get_autostart(void);
*
* @varname: Variable to adjust
* @value: Value to set for the variable, or NULL or "" to delete the variable
- * @return 0 if OK, 1 on error
+ * Return: 0 if OK, 1 on error
*/
int env_set(const char *varname, const char *value);
* @name: Variable to look up
* @base: Base to use (e.g. 10 for base 10, 2 for binary)
* @default_val: Default value to return if no value is found
- * @return the value found, or @default_val if none
+ * Return: the value found, or @default_val if none
*/
ulong env_get_ulong(const char *name, int base, ulong default_val);
*
* @varname: Variable to adjust
* @value: Value to set for the variable (will be converted to a string)
- * @return 0 if OK, 1 on error
+ * Return: 0 if OK, 1 on error
*/
int env_set_ulong(const char *varname, ulong value);
*
* @varname: Variable to adjust
* @value: Value to set for the variable (will be converted to a hex string)
- * @return 0 if OK, 1 on error
+ * Return: 0 if OK, 1 on error
*/
int env_set_hex(const char *varname, ulong value);
*
* @varname: Environment variable to set
* @addr: Value to set it to
- * @return 0 if ok, 1 on error
+ * Return: 0 if ok, 1 on error
*/
static inline int env_set_addr(const char *varname, const void *addr)
{
* @maxsz: Size of buffer to use for matches
* @buf: Buffer to use for matches
* @dollar_comp: non-zero to wrap each match in ${...}
- * @return number of matches found (in @cmdv)
+ * Return: number of matches found (in @cmdv)
*/
int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf,
bool dollar_comp);
*
* @name: Environment variable to get (e.g. "ethaddr")
* @enetaddr: Place to put MAC address (6 bytes)
- * @return 0 if OK, 1 on error
+ * Return: 0 if OK, 1 on error
*/
int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr);
*
* @name: Environment variable to set (e.g. "ethaddr")
* @enetaddr: Pointer to MAC address to put into the variable (6 bytes)
- * @return 0 if OK, 1 on error
+ * Return: 0 if OK, 1 on error
*/
int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr);
/**
* env_load() - Load the environment from storage
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int env_load(void);
/**
* env_reload() - Re-Load the environment from current storage
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int env_reload(void);
/**
* env_save() - Save the environment to storage
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int env_save(void);
/**
* env_erase() - Erase the environment on storage
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int env_erase(void);
/**
* env_select() - Select the environment storage
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int env_select(const char *name);
* @check: non-zero to check the CRC at the start of the environment, 0 to
* ignore it
* @flags: Flags controlling matching (H_... - see search.h)
- * @return 0 if imported successfully, -ENOMSG if the CRC was bad, -EIO if
+ * Return: 0 if imported successfully, -ENOMSG if the CRC was bad, -EIO if
* something else went wrong
*/
int env_import(const char *buf, int check, int flags);
* Export from hash table into binary representation
*
* @env_out: Buffer to contain the environment (must be large enough!)
- * @return 0 if OK, 1 on error
+ * Return: 0 if OK, 1 on error
*/
int env_export(struct environment_s *env_out);
* @buf1_read_fail: 0 if buf1 is valid, non-zero if invalid
* @buf2: Second environment (struct environemnt_s *)
* @buf2_read_fail: 0 if buf2 is valid, non-zero if invalid
- * @return 0 if OK,
+ * Return: 0 if OK,
* -EIO if no environment is valid,
* -ENOMSG if the CRC was bad
*/
* @buf2: Second environment (struct environemnt_s *)
* @buf2_read_fail: 0 if buf2 is valid, non-zero if invalid
* @flags: Flags controlling matching (H_... - see search.h)
- * @return 0 if OK, -EIO if no environment is valid, -ENOMSG if the CRC was bad
+ * Return: 0 if OK, -EIO if no environment is valid, -ENOMSG if the CRC was bad
*/
int env_import_redund(const char *buf1, int buf1_read_fail,
const char *buf2, int buf2_read_fail,
* env_get_default() - Look up a variable from the default environment
*
* @name: Variable to look up
- * @return value if found, NULL if not found in default environment
+ * Return: value if found, NULL if not found in default environment
*/
char *env_get_default(const char *name);
* It is a weak function allowing board to overidde the default interface for
* U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE
*
- * @return string of interface, empty if not supported
+ * Return: string of interface, empty if not supported
*/
const char *env_ext4_get_intf(void);
* It is a weak function allowing board to overidde the default device and
* partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART
*
- * @return string of device and partition
+ * Return: string of device and partition
*/
const char *env_ext4_get_dev_part(void);
* @op: operations performed on the environment
* @prio: priority between the multiple environments, 0 being the
* highest priority
- * @return an enum env_location value on success, or -ve error code.
+ * Return: an enum env_location value on success, or -ve error code.
*/
enum env_location env_get_location(enum env_operation op, int prio);
#endif /* DO_DEPS_ONLY */
/**
* extension_board_scan - Add system-specific function to scan extension board.
* @param extension_list List of extension board information to update.
- * @return the number of extension.
+ * Return: the number of extension.
*
* This function is called if CONFIG_CMD_EXTENSION is defined.
* Needs to fill the list extension_list with elements.
* @path_len: Length of path, must be large enough to hold the longest
* path in the tree
* @add_string_tab: 1 to add a region for the string table
- * @return number of regions in list. If this is >max_regions then the
+ * Return: number of regions in list. If this is >max_regions then the
* region array was exhausted. You should increase max_regions and try
* the call again.
*/
* @data: Pointer to data (node name, property name, compatible
* string, value (not yet supported)
* @size: Size of data, or 0 if none
- * @return 0 to exclude, 1 to include, -1 if no information is
+ * Return: 0 to exclude, 1 to include, -1 if no information is
* available
* @priv: Private pointer passed to h_include
* @region: Returns list of regions, sorted by offset
* path in the tree
* @flags: Various flags that control the region algortihm, see
* FDT_REG_...
- * @return number of regions in list. If this is >max_regions then the
+ * Return: number of regions in list. If this is >max_regions then the
* region array was exhausted. You should increase max_regions and try
* the call again. Only the first max_regions elements are available in the
* array.
* @count: Number of regions
* @max_regions: Number of entries that can fit in @region
* @info: Region state as returned from fdt_next_region()
- * @return new number of regions in @region (i.e. count + the number added)
+ * Return: new number of regions in @region (i.e. count + the number added)
* or -FDT_ERR_NOSPACE if there was not enough space.
*/
int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count,
* Defined in arch/$(ARCH)/lib/bootm-fdt.c
*
* @blob: FDT blob to write to
- * @return 0 if ok, or -ve FDT_ERR_... on failure
+ * Return: 0 if ok, or -ve FDT_ERR_... on failure
*/
int arch_fixup_fdt(void *blob);
* See doc/device-tree-bindings/root.txt
*
* @param fdt FDT address in memory
- * @return 0 if ok, or -FDT_ERR_... on error
+ * Return: 0 if ok, or -FDT_ERR_... on error
*/
int fdt_root(void *fdt);
* In particular, this adds the kernel command line (bootargs) to the FDT.
*
* @param fdt FDT address in memory
- * @return 0 if ok, or -FDT_ERR_... on error
+ * Return: 0 if ok, or -FDT_ERR_... on error
*/
int fdt_chosen(void *fdt);
* Add initrd information to the FDT before booting the OS.
*
* @param fdt FDT address in memory
- * @return 0 if ok, or -FDT_ERR_... on error
+ * Return: 0 if ok, or -FDT_ERR_... on error
*/
int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
* @param blob FDT blob to update
* @param start Begin of DRAM mapping in physical memory
* @param size Size of the single memory bank
- * @return 0 if ok, or -1 or -FDT_ERR_... on error
+ * Return: 0 if ok, or -1 or -FDT_ERR_... on error
*/
int fdt_fixup_memory(void *blob, u64 start, u64 size);
* @param size Array of size <banks> to hold the size of each region.
* @param banks Number of memory banks to create. If 0, the reg
* property will be left untouched.
- * @return 0 if ok, or -1 or -FDT_ERR_... on error
+ * Return: 0 if ok, or -1 or -FDT_ERR_... on error
*/
#ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
* @param blob FDT blob to update
* @param path path within dt
* @param display name of display timing to match
- * @return 0 if ok, or -FDT_ERR_... on error
+ * Return: 0 if ok, or -FDT_ERR_... on error
*/
int fdt_fixup_display(void *blob, const char *path, const char *display);
* @param type type (if specified, otherwise pass NULL)
* @param os os-type (if specified, otherwise pass NULL)
* @param arch architecture (if specified, otherwise pass NULL)
- * @return 0 if ok, or -1 or -FDT_ERR_... on error
+ * Return: 0 if ok, or -1 or -FDT_ERR_... on error
*/
int fdt_record_loadable(void *blob, u32 index, const char *name,
uintptr_t load_addr, u32 size, uintptr_t entry_point,
*
* @param blob FDT blob to update
* @param bd Pointer to board data
- * @return 0 if ok, or -FDT_ERR_... on error
+ * Return: 0 if ok, or -FDT_ERR_... on error
*/
int ft_board_setup(void *blob, struct bd_info *bd);
*
* @param blob FDT blob to update
* @param bd Pointer to board data
- * @return 0 if ok, or -FDT_ERR_... on error
+ * Return: 0 if ok, or -FDT_ERR_... on error
*/
int ft_system_setup(void *blob, struct bd_info *bd);
*
* @param blob FDT blob to update
* @param extrasize additional bytes needed
- * @return 0 if ok, or -FDT_ERR_... on error
+ * Return: 0 if ok, or -FDT_ERR_... on error
*/
int fdt_shrink_to_minimum(void *blob, uint extrasize);
int fdt_increase_size(void *fdt, int add_len);
* @param blob Pointer to device tree blob
* @param node_offset Node DT offset
* @param in_addr Pointer to the address to translate
- * @return translated address or OF_BAD_ADDR on error
+ * Return: translated address or OF_BAD_ADDR on error
*/
u64 fdt_translate_address(const void *blob, int node_offset,
const __be32 *in_addr);
* @param blob Pointer to device tree blob
* @param node_offset Node DT offset
* @param in_addr Pointer to the DMA address to translate
- * @return translated DMA address or OF_BAD_ADDR on error
+ * Return: translated DMA address or OF_BAD_ADDR on error
*/
u64 fdt_translate_dma_address(const void *blob, int node_offset,
const __be32 *in_addr);
* @param cpu Pointer to variable storing the range's cpu address
* @param bus Pointer to variable storing the range's bus address
* @param size Pointer to variable storing the range's size
- * @return translated DMA address or OF_BAD_ADDR on error
+ * Return: translated DMA address or OF_BAD_ADDR on error
*/
int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu,
dma_addr_t *bus, u64 *size);
*
* @param blob FDT blob
* @param node parent node
- * @return number of child node; 0 if there is not child node
+ * Return: number of child node; 0 if there is not child node
*/
int fdtdec_get_child_count(const void *blob, int node);
#endif
* Compute the size of a resource.
*
* @param res the resource to operate on
- * @return the size of the resource
+ * Return: the size of the resource
*/
static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
{
* @cells_count: Cell count to use if @cells_name is NULL
* @index: index of a phandle to parse out
* @out_args: optional pointer to output arguments structure (will be filled)
- * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
+ * Return: 0 on success (with @out_args filled out if not NULL), -ENOENT if
* @list_name does not exist, a phandle was not found, @cells_name
* could not be found, the arguments were truncated or there were too
* many arguments.
* @param blob FDT blob to use
* @param name Root name of alias to search for
* @param id Compatible ID to look for
- * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
+ * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
*/
int fdtdec_next_alias(const void *blob, const char *name,
enum fdt_compat_id id, int *upto);
*
* @param blob FDT blob to use
* @param node Node containing compatible string to find
- * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
+ * Return: compatible ID, or COMPAT_UNKNOWN if we cannot find a match
*/
enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
* @param blob FDT blob to use
* @param node Start node for search
* @param id Compatible ID to look for (enum fdt_compat_id)
- * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
+ * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
*/
int fdtdec_next_compatible(const void *blob, int node,
enum fdt_compat_id id);
* @param node Start node for search
* @param id Compatible ID to look for (enum fdt_compat_id)
* @param depthp Current depth (set to 0 before first call)
- * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
+ * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
*/
int fdtdec_next_compatible_subnode(const void *blob, int node,
enum fdt_compat_id id, int *depthp);
* @param sizep a pointer to store the size into. Use NULL if not required
* @param translate Indicates whether to translate the returned value
* using the parent node's ranges property.
- * @return address, if found, or FDT_ADDR_T_NONE if not
+ * Return: address, if found, or FDT_ADDR_T_NONE if not
*/
fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
const char *prop_name, int index, int na, int ns,
* @param sizep a pointer to store the size into. Use NULL if not required
* @param translate Indicates whether to translate the returned value
* using the parent node's ranges property.
- * @return address, if found, or FDT_ADDR_T_NONE if not
+ * Return: address, if found, or FDT_ADDR_T_NONE if not
*/
fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
int node, const char *prop_name, int index, fdt_size_t *sizep,
* @param sizep a pointer to store the size into. Use NULL if not required
* @param translate Indicates whether to translate the returned value
* using the parent node's ranges property.
- * @return address, if found, or FDT_ADDR_T_NONE if not
+ * Return: address, if found, or FDT_ADDR_T_NONE if not
*/
fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
const char *prop_name, int index, fdt_size_t *sizep,
* @param blob FDT blob
* @param node node to examine
* @param prop_name name of property to find
- * @return address, if found, or FDT_ADDR_T_NONE if not
+ * Return: address, if found, or FDT_ADDR_T_NONE if not
*/
fdt_addr_t fdtdec_get_addr(const void *blob, int node,
const char *prop_name);
* @param node node to examine
* @param prop_name name of property to find
* @param sizep a pointer to store the size into. Use NULL if not required
- * @return address, if found, or FDT_ADDR_T_NONE if not
+ * Return: address, if found, or FDT_ADDR_T_NONE if not
*/
fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
const char *prop_name, fdt_size_t *sizep);
* @param node node to examine
* @param vendor vendor id of the pci device
* @param device device id of the pci device
- * @return 0 if ok, negative on error
+ * Return: 0 if ok, negative on error
*/
int fdtdec_get_pci_vendev(const void *blob, int node,
u16 *vendor, u16 *device);
* @param dev device to examine
* @param addr pci address in the form of fdt_pci_addr
* @param bar returns base address of the pci device's registers
- * @return 0 if ok, negative on error
+ * Return: 0 if ok, negative on error
*/
int fdtdec_get_pci_bar32(const struct udevice *dev, struct fdt_pci_addr *addr,
u32 *bar);
* @param blob FDT blob
* @param node node to examine
* @param res the resource structure to return the bus range
- * @return 0 if ok, negative on error
+ * Return: 0 if ok, negative on error
*/
int fdtdec_get_pci_bus_range(const void *blob, int node,
* @param node node to examine
* @param prop_name name of property to find
* @param default_val default value to return if the property is not found
- * @return integer value, if found, or default_val if not
+ * Return: integer value, if found, or default_val if not
*/
s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
s32 default_val);
* @param node node to examine
* @param prop_name name of property to find
* @param default_val default value to return if the property is not found
- * @return unsigned integer value, if found, or default_val if not
+ * Return: unsigned integer value, if found, or default_val if not
*/
unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
unsigned int default_val);
*
* @param ptr Pointer to property
* @param cells Number of cells containing the number
- * @return the value in the cells
+ * Return: the value in the cells
*/
u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
* @param node node to examine
* @param prop_name name of property to find
* @param default_val default value to return if the property is not found
- * @return integer value, if found, or default_val if not
+ * Return: integer value, if found, or default_val if not
*/
uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
uint64_t default_val);
*
* @param blob FDT blob
* @param node node to examine
- * @return integer value 0 (not enabled) or 1 (enabled)
+ * Return: integer value 0 (not enabled) or 1 (enabled)
*/
int fdtdec_get_is_enabled(const void *blob, int node);
*
* If not, a message is printed to the console if the console is ready.
*
- * @return 0 if all ok, -1 if not
+ * Return: 0 if all ok, -1 if not
*/
int fdtdec_prepare_fdt(void);
* @param id Compatible ID to look for
* @param node_list Place to put list of found nodes
* @param maxcount Maximum number of nodes to find
- * @return number of nodes found on success, FDT_ERR_... on error
+ * Return: number of nodes found on success, FDT_ERR_... on error
*/
int fdtdec_find_aliases_for_id(const void *blob, const char *name,
enum fdt_compat_id id, int *node_list, int maxcount);
* @param node Node to look up
* @param seqp This is set to the sequence number if one is found,
* but otherwise the value is left alone
- * @return 0 if a sequence was found, -ve if not
+ * Return: 0 if a sequence was found, -ve if not
*/
int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
int *seqp);
* @param blob Device tree blob (if NULL, then error is returned)
* @param base Base name for alias susbystem (before the number)
*
- * @return 0 highest alias ID, -1 if not found
+ * Return: 0 highest alias ID, -1 if not found
*/
int fdtdec_get_alias_highest_id(const void *blob, const char *base);
*
* @param blob Device tree blob (if NULL, then NULL is returned)
* @param name Property name to look up
- * @return Value of property, or NULL if it does not exist
+ * Return: Value of property, or NULL if it does not exist
*/
const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
*
* @param blob Device tree blob (if NULL, then error is returned)
* @param name Property name, e.g. "stdout-path"
- * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
+ * Return: Node offset referred to by that chosen node, or -ve FDT_ERR_...
*/
int fdtdec_get_chosen_node(const void *blob, const char *name);
* Get the name for a compatible ID
*
* @param id Compatible ID to look for
- * @return compatible string for that id
+ * Return: compatible string for that id
*/
const char *fdtdec_get_compatible(enum fdt_compat_id id);
* @param blob FDT blob
* @param node node to examine
* @param prop_name name of property to find
- * @return node offset if found, -ve error code on error
+ * Return: node offset if found, -ve error code on error
*/
int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
* @param prop_name name of property to find
* @param array array to fill with data
* @param count number of array elements
- * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
+ * Return: 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
* or -FDT_ERR_BADLAYOUT if not enough data
*/
int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
* @param prop_name name of property to find
* @param array array to fill with data
* @param count number of array elements
- * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
+ * Return: number of array elements if ok, or -FDT_ERR_NOTFOUND if the
* property is not found
*/
int fdtdec_get_int_array_count(const void *blob, int node,
* @param node node to examine
* @param prop_name name of property to find
* @param count number of array elements
- * @return pointer to array if found, or NULL if the property is not
+ * Return: pointer to array if found, or NULL if the property is not
* found or there is not enough data
*/
const u32 *fdtdec_locate_array(const void *blob, int node,
* @param blob FDT blob
* @param node node to examine
* @param prop_name name of property to find
- * @return 1 if the properly is present; 0 if it isn't present
+ * Return: 1 if the properly is present; 0 if it isn't present
*/
int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
*
* @param blob FDT blob
* @param node parent node
- * @return number of child node; 0 if there is not child node
+ * Return: number of child node; 0 if there is not child node
*/
int fdtdec_get_child_count(const void *blob, int node);
* @param prop_name name of property to find
* @param array array to fill with data
* @param count number of array elements
- * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
+ * Return: 0 if ok, or -FDT_ERR_MISSING if the property is not found,
* or -FDT_ERR_BADLAYOUT if not enough data
*/
int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
* @param node node to examine
* @param prop_name name of property to find
* @param count number of array elements
- * @return pointer to byte array if found, or NULL if the property is not
+ * Return: pointer to byte array if found, or NULL if the property is not
* found or there is not enough data
*/
const u8 *fdtdec_locate_byte_array(const void *blob, int node,
* @param property name of the property to parse
* @param index index of the resource to retrieve
* @param res returns the resource
- * @return 0 if ok, negative on error
+ * Return: 0 if ok, negative on error
*/
int fdt_get_resource(const void *fdt, int node, const char *property,
unsigned int index, struct fdt_resource *res);
* @param node 'display-timing' node containing the timing subnodes
* @param index Index number to read (0=first timing subnode)
* @param config Place to put timings
- * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
+ * Return: 0 if OK, -FDT_ERR_NOTFOUND if not found
*/
int fdtdec_decode_display_timing(const void *blob, int node, int index,
struct display_timing *config);
* address instead of hard coding the value in the case where the memory size
* and start address cannot be detected automatically.
*
- * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
+ * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or
* invalid
*/
int fdtdec_setup_mem_size_base(void);
* address instead of hard coding the value in the case where the memory size
* and start address cannot be detected automatically.
*
- * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
+ * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or
* invalid
*/
int fdtdec_setup_mem_size_base_lowest(void);
* information instead of hard coding the information in cases where it cannot
* be detected automatically.
*
- * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
+ * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or
* invalid
*/
int fdtdec_setup_memory_banksize(void);
* @param fdt FDT blob
* @param mac buffer containing the MAC address to set
* @param size size of MAC address
- * @return 0 on success or a negative error code on failure
+ * Return: 0 on success or a negative error code on failure
*/
int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size);
* @param node offset in the FDT blob of the node whose phandle is to
* be set
* @param phandle phandle to set for the given node
- * @return 0 on success or a negative error code on failure
+ * Return: 0 on success or a negative error code on failure
*/
static inline int fdtdec_set_phandle(void *blob, int node, uint32_t phandle)
{
* @param phandlep return location for the phandle of the carveout region
* can be NULL if no phandle should be added
* @param flags bitmask of flags to set for the carveout region
- * @return 0 on success or a negative error code on failure
+ * Return: 0 on success or a negative error code on failure
*/
int fdtdec_add_reserved_memory(void *blob, const char *basename,
const struct fdt_memory *carveout,
* @param compatiblesp return location for compatible strings
* @param countp return location for the number of compatible strings
* @param flags return location for the flags of the carveout
- * @return 0 on success or a negative error code on failure
+ * Return: 0 on success or a negative error code on failure
*/
int fdtdec_get_carveout(const void *blob, const char *node,
const char *prop_name, unsigned int index,
* @param compatibles compatible strings to set for the carveout
* @param count number of compatible strings
* @param flags bitmask of flags to set for the carveout
- * @return 0 on success or a negative error code on failure
+ * Return: 0 on success or a negative error code on failure
*/
int fdtdec_set_carveout(void *blob, const char *node, const char *prop_name,
unsigned int index, const struct fdt_memory *carveout,
* @param rescan Returns a flag indicating that fdt has changed and rescanning
* the fdt is required
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fdtdec_resetup(int *rescan);
#endif
* ignore)
* @param sizep Returns total memory size (NULL to ignore)
* @param bd Updated with the memory bank information (NULL to skip)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id,
phys_addr_t *basep, phys_size_t *sizep,
/**
* fdtdec_get_srcname() - Get the name of where the devicetree comes from
*
- * @return source name
+ * Return: source name
*/
const char *fdtdec_get_srcname(void);
* @flag: Command flags (CMD_FLAG_...)
* @argc: Number of arguments
* @argv: List of arguments
- * @return result (see enum command_ret_t)
+ * Return: result (see enum command_ret_t)
*/
int do_fat_fsload(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[]);
* @flag: Command flags (CMD_FLAG_...)
* @argc: Number of arguments
* @argv: List of arguments
- * @return result (see enum command_ret_t)
+ * Return: result (see enum command_ret_t)
*/
int do_ext2load(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
*
* @filename: Name of the file
* @size: Size of file
- * @return 0 if ok with valid *size, negative on error
+ * Return: 0 if ok with valid *size, negative on error
*/
int fs_size(const char *filename, loff_t *size);
* fs_opendir - Open a directory
*
* @filename: the path to directory to open
- * @return a pointer to the directory stream or NULL on error and errno
+ * Return: a pointer to the directory stream or NULL on error and errno
* set appropriately
*/
struct fs_dir_stream *fs_opendir(const char *filename);
* longer valid.
*
* @dirs: the directory stream
- * @return the next directory entry (only valid until next fs_readdir() or
+ * Return: the next directory entry (only valid until next fs_readdir() or
* fs_closedir() call, do not attempt to free()) or NULL if the end of
* the directory is reached.
*/
* If a given name is a directory, it will be deleted only if it's empty
*
* @filename: Name of file or directory to delete
- * @return 0 on success, -1 on error conditions
+ * Return: 0 on success, -1 on error conditions
*/
int fs_unlink(const char *filename);
* fs_mkdir - Create a directory
*
* @filename: Name of directory to create
- * @return 0 on success, -1 on error conditions
+ * Return: 0 on success, -1 on error conditions
*/
int fs_mkdir(const char *filename);
* @flag: Command flags (CMD_FLAG_...)
* @argc: Number of arguments
* @argv: List of arguments
- * @return result (see enum command_ret_t)
+ * Return: result (see enum command_ret_t)
*/
int do_fs_types(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[]);
/**
* fsl_initdram() - Set up the SDRAM
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int fsl_initdram(void);
* If power_off() is not implemented, it must power down the phy.
*
* @phy: PHY port to be de-initialized
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int (*exit)(struct phy *phy);
* During runtime, the PHY may need to be reset in order to
* re-establish connection etc without being shut down or exit.
*
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int (*reset)(struct phy *phy);
* setup done in init(). If init() is not implemented, it must take care
* of setting up the context (PLLs, ...)
*
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int (*power_on)(struct phy *phy);
* init()/deinit() are not implemented, it must not de-initialize
* everything.
*
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int (*power_off)(struct phy *phy);
* This function configures the PHY for it's main function following
* power_on/off() after beeing initialized.
*
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int (*configure)(struct phy *phy, void *params);
};
* generic_phy_init() - initialize the PHY port
*
* @phy: the PHY port to initialize
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_init(struct phy *phy);
* generic_phy_init() - de-initialize the PHY device
*
* @phy: PHY port to be de-initialized
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_exit(struct phy *phy);
* generic_phy_reset() - resets a PHY device without shutting down
*
* @phy: PHY port to be reset
- *@return 0 if OK, or a negative error code
+ *Return: 0 if OK, or a negative error code
*/
int generic_phy_reset(struct phy *phy);
* generic_phy_power_on() - power on a PHY device
*
* @phy: PHY port to be powered on
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_power_on(struct phy *phy);
* generic_phy_power_off() - power off a PHY device
*
* @phy: PHY port to be powered off
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_power_off(struct phy *phy);
*
* @phy: PHY port to be configured
* @params: PHY Parameters, underlying data is specific to the PHY function
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_configure(struct phy *phy, void *params);
* the USB2 phy can be accessed by passing index '0' and the USB3 phy can
* be accessed by passing index '1'
*
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_get_by_index(struct udevice *user, int index,
struct phy *phy);
* the USB2 phy can be accessed by passing index '0' and the USB3 phy can
* be accessed by passing index '1'
*
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_get_by_index_nodev(ofnode node, int index, struct phy *phy);
* };
* the USB3 phy can be accessed using "usb3phy", and USB2 by using "usb2phy"
*
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int generic_phy_get_by_name(struct udevice *user, const char *phy_name,
struct phy *phy);
*
* @dev: The consumer device.
* @bulk A pointer to a phy bulk struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int generic_phy_get_bulk(struct udevice *dev, struct phy_bulk *bulk);
*
* @bulk: A phy bulk struct that was previously successfully requested
* by generic_phy_get_bulk().
- * @return 0 if OK, or negative error code.
+ * Return: 0 if OK, or negative error code.
*/
int generic_phy_init_bulk(struct phy_bulk *bulk);
*
* @bulk: A phy bulk struct that was previously successfully requested
* by generic_phy_get_bulk().
- * @return 0 if OK, or negative error code.
+ * Return: 0 if OK, or negative error code.
*/
int generic_phy_exit_bulk(struct phy_bulk *bulk);
*
* @bulk: A phy bulk struct that was previously successfully requested
* by generic_phy_get_bulk().
- * @return 0 if OK, or negative error code.
+ * Return: 0 if OK, or negative error code.
*/
int generic_phy_power_on_bulk(struct phy_bulk *bulk);
*
* @bulk: A phy bulk struct that was previously successfully requested
* by generic_phy_get_bulk().
- * @return 0 if OK, or negative error code.
+ * Return: 0 if OK, or negative error code.
*/
int generic_phy_power_off_bulk(struct phy_bulk *bulk);
* generic_phy_valid() - check if PHY port is valid
*
* @phy: the PHY port to check
- * @return TRUE if valid, or FALSE
+ * Return: TRUE if valid, or FALSE
*/
static inline bool generic_phy_valid(struct phy *phy)
{
*
* @src: Pointer to gzip file
* @len: Length of data
- * @return length of header in bytes, or -1 if not enough data
+ * Return: length of header in bytes, or -1 if not enough data
*/
int gzip_parse_header(const unsigned char *src, unsigned long len);
* @dstlen: Size of destination buffer
* @src: Source data to decompress
* @lenp: Returns length of uncompressed data
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
*/
int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp);
* @lenp: On entry, length data at @src. On exit, number of bytes used from @src
* @stoponerr: 0 to continue when a decode error is found, 1 to stop
* @offset: start offset within the src buffer
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
*/
int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
int stoponerr, int offset);
* @startoffs: offset in bytes of first write
* @szexpected: expected uncompressed length, may be zero to use gzip trailer
* for files under 4GiB
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
*/
int gzwrite(unsigned char *src, int len, struct blk_desc *dev, ulong szwritebuf,
ulong startoffs, ulong szexpected);
* number of bytes used in the buffer
* @src: Source data to compress
* @srclen: Size of source data
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
*/
int gzip(void *dst, unsigned long *lenp, unsigned char *src, ulong srclen);
* write_spl_handoff().
*
* @ho: Handoff area to fill in
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int handoff_arch_save(struct spl_handoff *ho);
* If NULL, then it is assumed that the caller has
* allocated enough space for the hash. This is possible
* since the caller is selecting the algorithm.
- * @return 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm,
+ * Return: 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm,
* -ENOSPC if the output buffer is not large enough.
*/
int hash_block(const char *algo_name, const void *data, unsigned int len,
* @algo_name: Hash algorithm to look up
* @algop: Pointer to the hash_algo struct if found
*
- * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
+ * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
*/
int hash_lookup_algo(const char *algo_name, struct hash_algo **algop);
* @algo_name: Hash algorithm to look up
* @algop: Pointer to the hash_algo struct if found
*
- * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
+ * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
*/
int hash_progressive_lookup_algo(const char *algo_name,
struct hash_algo **algop);
* @str: Hash string to get parsed
* @result: Binary array of the parsed hash string
*
- * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
+ * Return: 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
*/
int hash_parse_string(const char *algo_name, const char *str, uint8_t *result);
* hda_wait_for_ready() - Wait for the codec to indicate it is ready
*
* @regs: HDA registers
- * @return 0 if OK -ETIMEDOUT if codec did not respond in time
+ * Return: 0 if OK -ETIMEDOUT if codec did not respond in time
*/
int hda_wait_for_ready(struct hda_regs *regs);
* hda_wait_for_valid() - Wait for the codec to accept the last command
*
* @regs: HDA registers
- * @return 0 if OK -ETIMEDOUT if codec did not respond in time
+ * Return: 0 if OK -ETIMEDOUT if codec did not respond in time
*/
int hda_wait_for_valid(struct hda_regs *regs);
* hda_codec_detect() - Detect which codecs are present
*
* @regs: HDA registers
- * @return bit mask of active codecs (0 if none)
- * @return 0 if OK, -ve on error
+ * Return: bit mask of active codecs (0 if none)
+ * Return: 0 if OK, -ve on error
*/
int hda_codec_detect(struct hda_regs *regs);
* @dev: Sound device
* @regs: HDA registers
* @codec_mask: Mask of codecs to init (bits 3:0)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int hda_codecs_init(struct udevice *dev, struct hda_regs *regs, u32 codec_mask);
*
* @dev: Sound device
* @frequency_hz: Beep frequency in hertz
- * @return if OK, -ve on error
+ * Return: if OK, -ve on error
*/
int hda_codec_start_beep(struct udevice *dev, int frequency_hz);
* This tells the sound hardware to stop a previously started beep.
*
* @dev: Sound device
- * @return if OK, -ve on error
+ * Return: if OK, -ve on error
*/
int hda_codec_stop_beep(struct udevice *dev);
* This should be called at the start of the probe() method.
*
* @dev: Sound device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int hda_codec_init(struct udevice *dev);
* This should be called at the end of the probe() method.
*
* @dev: Sound device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int hda_codec_finish_init(struct udevice *dev);
*
* @algo: Pointer to the hash_algo struct
* @ctxp: Pointer to the pointer of the context for hashing
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
int hw_sha_init(struct hash_algo *algo, void **ctxp);
* @buf: Pointer to the buffer being hashed
* @size: Size of the buffer being hashed
* @is_last: 1 if this is the last update; 0 otherwise
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
int hw_sha_update(struct hash_algo *algo, void *ctx, const void *buf,
unsigned int size, int is_last);
* @ctx: Pointer to the context for hashing
* @dest_buf: Pointer to the destination buffer where hash is to be copied
* @size: Size of the buffer being hashed
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
*/
int hw_sha_finish(struct hash_algo *algo, void *ctx, void *dest_buf,
int size);
* @index: The index of the hardware spinlock to request, within the
* client's list of hardware spinlock.
* @hws: A pointer to a hardware spinlock struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int hwspinlock_get_by_index(struct udevice *dev,
int index, struct hwspinlock *hws);
* @buffer: Place to put data
* @len: Number of bytes to read
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
int dm_i2c_read(struct udevice *dev, uint offset, uint8_t *buffer, int len);
* @buffer: Buffer containing data to write
* @len: Number of bytes to write
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
int dm_i2c_write(struct udevice *dev, uint offset, const uint8_t *buffer,
int len);
* @chip_addr: 7-bit address to probe (10-bit and others are not supported)
* @chip_flags: Flags for the probe (see enum dm_i2c_chip_flags)
* @devp: Returns the device found, or NULL if none
- * @return 0 if a chip was found at that address, -ve if not
+ * Return: 0 if a chip was found at that address, -ve if not
*/
int dm_i2c_probe(struct udevice *bus, uint chip_addr, uint chip_flags,
struct udevice **devp);
*
* @dev: Device to use for transfer
* @addr: Address to read from
- * @return value read, or -ve on error
+ * Return: value read, or -ve on error
*/
int dm_i2c_reg_read(struct udevice *dev, uint offset);
* @dev: Device to use for transfer
* @addr: Address to write to
* @val: Value to write (normally a byte)
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int dm_i2c_reg_write(struct udevice *dev, uint offset, unsigned int val);
* @offset: Address for the R/W operation
* @clr: Bitmask of bits that should be cleared
* @set: Bitmask of bits that should be set
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int dm_i2c_reg_clrset(struct udevice *dev, uint offset, u32 clr, u32 set);
* @dev: Device to use for transfer
* @msg: List of messages to transfer
* @nmsgs: Number of messages to transfer
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int dm_i2c_xfer(struct udevice *dev, struct i2c_msg *msg, int nmsgs);
*
* @bus: Bus to adjust
* @speed: Requested speed in Hz
- * @return 0 if OK, -EINVAL for invalid values
+ * Return: 0 if OK, -EINVAL for invalid values
*/
int dm_i2c_set_bus_speed(struct udevice *bus, unsigned int speed);
* dm_i2c_get_bus_speed() - get the speed of a bus
*
* @bus: Bus to check
- * @return speed of selected I2C bus in Hz, -ve on error
+ * Return: speed of selected I2C bus in Hz, -ve on error
*/
int dm_i2c_get_bus_speed(struct udevice *bus);
*
* @dev: Chip to adjust
* @flags: New flags
- * @return 0 if OK, -EINVAL if value is unsupported, other -ve value on error
+ * Return: 0 if OK, -EINVAL if value is unsupported, other -ve value on error
*/
int i2c_set_chip_flags(struct udevice *dev, uint flags);
*
* @dev: Chip to check
* @flagsp: Place to put flags
- * @return 0 if OK, other -ve value on error
+ * Return: 0 if OK, other -ve value on error
*/
int i2c_get_chip_flags(struct udevice *dev, uint *flagsp);
* function to set the bits that are valid to be used for offset overflow.
*
* @mask: The mask to be used for high offset bits within address
- * @return 0 if OK, other -ve value on error
+ * Return: 0 if OK, other -ve value on error
*/
int i2c_set_chip_addr_offset_mask(struct udevice *dev, uint mask);
/*
* i2c_get_chip_addr_offset_mask() - get mask of address bits usable by offset
*
- * @return current chip addr offset mask
+ * Return: current chip addr offset mask
*/
uint i2c_get_chip_addr_offset_mask(struct udevice *dev);
* See the deblock() method in 'struct dm_i2c_ops' for full information
*
* @bus: Bus to recover
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int i2c_deblock(struct udevice *bus);
* @scl_count: Number of SCL clock cycles generated to deblock SDA
* @start_count:Number of I2C start conditions sent after deblocking SDA
* @delay: Delay between SCL clock line changes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
struct gpio_desc;
int i2c_deblock_gpio_loop(struct gpio_desc *sda_pin, struct gpio_desc *scl_pin,
*
* @dev: Device to find an emulator for
* @emulp: Returns the associated emulator, if found *
- * @return 0 if OK, -ENOENT or -ENODEV if not found
+ * Return: 0 if OK, -ENOENT or -ENODEV if not found
*/
int i2c_emul_find(struct udevice *dev, struct udevice **emulp);
* Given an emulator this returns the associated device
*
* @emul: Emulator for the device
- * @return device that @emul is emulating
+ * Return: device that @emul is emulating
*/
struct udevice *i2c_emul_get_device(struct udevice *emul);
* properties.
*
* @dev: I2C device to process
- * @return 0 if OK, -EINVAL if acpi,hid is not present
+ * Return: 0 if OK, -EINVAL if acpi,hid is not present
*/
int acpi_i2c_of_to_plat(struct udevice *dev);
* Get FDT values for i2c bus.
*
* @param blob Device tree blbo
- * @return the number of I2C bus
+ * Return: the number of I2C bus
*/
void board_i2c_init(const void *blob);
*
* @param blob Device tree blbo
* @param node FDT I2C node to find
- * @return the number of I2C bus (zero based), or -1 on error
+ * Return: the number of I2C bus (zero based), or -1 on error
*/
int i2c_get_bus_num_fdt(int node);
*
* @param blob Device tree blbo
* @param node FDT I2C node to find
- * @return 0 if port was reset, -1 if not found
+ * Return: 0 if port was reset, -1 if not found
*/
int i2c_reset_port_fdt(const void *blob, int node);
* @buf: Place to put data
* @size: Number of bytes to read
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
int i2c_eeprom_read(struct udevice *dev, int offset, uint8_t *buf, int size);
* @buf: Buffer containing data to write
* @size: Number of bytes to write
*
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
int i2c_eeprom_write(struct udevice *dev, int offset, uint8_t *buf, int size);
*
* @dev: Chip to query
*
- * @return +ve size in bytes on success, -ve on failure
+ * Return: +ve size in bytes on success, -ve on failure
*/
int i2c_eeprom_size(struct udevice *dev);
* @dev: I2C device
* @data: Data buffer to play
* @data_size: Size of data buffer in bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int i2s_tx_data(struct udevice *dev, void *data, uint data_size);
* @param pi2s_tx pointer of i2s transmitter parameter structure.
* @param data address of the data buffer
* @param data_size size of the data (in bytes)
- * @return int value 0 for success, -1 in case of error
+ * Return: int value 0 for success, -1 in case of error
*/
int i2s_transfer_tx_data(struct i2s_uc_priv *pi2s_tx, void *data,
uint data_size);
/**
* board_start_ide() - Start up the board IDE interfac
*
- * @return 0 if ok
+ * Return: 0 if ok
*/
int board_start_ide(void);
* genimg_get_os_short_name() - get the short name for an OS
*
* @param os OS (IH_OS_...)
- * @return OS short name, or "unknown" if unknown
+ * Return: OS short name, or "unknown" if unknown
*/
const char *genimg_get_os_short_name(uint8_t comp);
* genimg_get_arch_short_name() - get the short name for an architecture
*
* @param arch Architecture type (IH_ARCH_...)
- * @return architecture short name, or "unknown" if unknown
+ * Return: architecture short name, or "unknown" if unknown
*/
const char *genimg_get_arch_short_name(uint8_t arch);
* genimg_get_type_short_name() - get the short name for an image type
*
* @param type Image type (IH_TYPE_...)
- * @return image short name, or "unknown" if unknown
+ * Return: image short name, or "unknown" if unknown
*/
const char *genimg_get_type_short_name(uint8_t type);
* genimg_get_comp_short_name() - get the short name for a compression method
*
* @param comp compression method (IH_COMP_...)
- * @return compression method short name, or "unknown" if unknown
+ * Return: compression method short name, or "unknown" if unknown
*/
const char *genimg_get_comp_short_name(uint8_t comp);
*
* @category: Category of item
* @id: Item ID
- * @return name of item, or "Unknown ..." if unknown
+ * Return: name of item, or "Unknown ..." if unknown
*/
const char *genimg_get_cat_name(enum ih_category category, uint id);
*
* @category: Category of item
* @id: Item ID
- * @return short name of item, or "Unknown ..." if unknown
+ * Return: short name of item, or "Unknown ..." if unknown
*/
const char *genimg_get_cat_short_name(enum ih_category category, uint id);
* genimg_get_cat_count() - Get the number of items in a category
*
* @category: Category to check
- * @return the number of items in the category (IH_xxx_COUNT)
+ * Return: the number of items in the category (IH_xxx_COUNT)
*/
int genimg_get_cat_count(enum ih_category category);
* genimg_get_cat_desc() - Get the description of a category
*
* @category: Category to check
- * @return the description of a category, e.g. "architecture". This
+ * Return: the description of a category, e.g. "architecture". This
* effectively converts the enum to a string.
*/
const char *genimg_get_cat_desc(enum ih_category category);
*
* @category: Category to check
* @id: Item ID
- * @return true or false as to whether a category has an item
+ * Return: true or false as to whether a category has an item
*/
bool genimg_cat_has_id(enum ih_category category, uint id);
* @param datap Returns address of loaded image
* @param lenp Returns length of loaded image
*
- * @return node offset of base image, or -ve error code on error
+ * Return: node offset of base image, or -ve error code on error
*/
int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
const char **fit_unamep, const char **fit_uname_configp,
* @param load_op Decribes what to do with the load address
* @param datap Returns address of loaded image
* @param lenp Returns length of loaded image
- * @return node offset of image, or -ve error code on error
+ * Return: node offset of image, or -ve error code on error
*/
int fit_image_load(bootm_headers_t *images, ulong addr,
const char **fit_unamep, const char **fit_uname_configp,
*
* @addr: Address of script
* @fit_uname: FIT subimage name
- * @return result code (enum command_ret_t)
+ * Return: result code (enum command_ret_t)
*/
int image_source_script(ulong addr, const char *fit_uname);
*
* @buf: Address in U-Boot memory where image is loaded.
* @len: Length of the compressed image.
- * @return compression type or IH_COMP_NONE if not compressed.
+ * Return: compression type or IH_COMP_NONE if not compressed.
*
* Note: Only following compression types are supported now.
* lzo, lzma, gzip, bzip2
* @image_buf: Address to decompress from
* @image_len: Number of bytes in @image_buf to decompress
* @unc_len: Available space for decompression
- * @return 0 if OK, -ve on error (BOOTM_ERR_...)
+ * Return: 0 if OK, -ve on error (BOOTM_ERR_...)
*/
int image_decomp(int comp, ulong load, ulong image_start, int type,
void *load_buf, void *image_buf, ulong image_len,
* @blob: FDT to update
* @of_size: Size of the FDT
* @lmb: Points to logical memory block structure
- * @return 0 if ok, <0 on failure
+ * Return: 0 if ok, <0 on failure
*/
int image_setup_libfdt(bootm_headers_t *images, void *blob,
int of_size, struct lmb *lmb);
* paramters to the FDT if libfdt is available.
*
* @param images Images information
- * @return 0 if ok, <0 on failure
+ * Return: 0 if ok, <0 on failure
*/
int image_setup_linux(bootm_headers_t *images);
* @image: Address of image
* @start: Returns start address of image
* @end : Returns end address of image
- * @return 0 if OK, 1 if the image was not recognised
+ * Return: 0 if OK, 1 if the image was not recognised
*/
int bootz_setup(ulong image, ulong *start, ulong *end);
* @start: Returns start address of image
* @size : Returns size image
* @force_reloc: Ignore image->ep field, always place image to RAM start
- * @return 0 if OK, 1 if the image was not recognised
+ * Return: 0 if OK, 1 if the image was not recognised
*/
int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
bool force_reloc);
* sure that there are no strange tags or broken nodes in the FIT.
*
* @fit: pointer to the FIT format image header
- * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
+ * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
* failed (e.g. due to bad structure), -ENOMSG if the description is
* missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images
* path is missing
* image_get_checksum_algo() - Look up a checksum algorithm
*
* @param full_name Name of algorithm in the form "checksum,crypto"
- * @return pointer to algorithm information, or NULL if not found
+ * Return: pointer to algorithm information, or NULL if not found
*/
struct checksum_algo *image_get_checksum_algo(const char *full_name);
* image_get_crypto_algo() - Look up a cryptosystem algorithm
*
* @param full_name Name of algorithm in the form "checksum,crypto"
- * @return pointer to algorithm information, or NULL if not found
+ * Return: pointer to algorithm information, or NULL if not found
*/
struct crypto_algo *image_get_crypto_algo(const char *full_name);
* image_get_padding_algo() - Look up a padding algorithm
*
* @param name Name of padding algorithm
- * @return pointer to algorithm information, or NULL if not found
+ * Return: pointer to algorithm information, or NULL if not found
*/
struct padding_algo *image_get_padding_algo(const char *name);
* therefore nothing was checked. The caller may wish
* to fall back to other mechanisms, or refuse to
* boot.
- * @return 0 if all verified ok, <0 on error
+ * Return: 0 if all verified ok, <0 on error
*/
int fit_image_verify_required_sigs(const void *fit, int image_noffset,
const char *data, size_t size, const void *sig_blob,
* -1 then any signature will do.
* @err_msgp: In the event of an error, this will be pointed to a
* help error string to display to the user.
- * @return 0 if all verified ok, <0 on error
+ * Return: 0 if all verified ok, <0 on error
*/
int fit_image_check_sig(const void *fit, int noffset, const void *data,
size_t size, int required_keynode, char **err_msgp);
* @fdt_regions: Regions as returned by libfdt
* @count: Number of regions returned by libfdt
* @region: Place to put list of regions (NULL to allocate it)
- * @return pointer to list of regions, or NULL if out of memory
+ * Return: pointer to list of regions, or NULL if out of memory
*/
struct image_region *fit_region_make_list(const void *fit,
struct fdt_region *fdt_regions, int count,
* in each (FDT) image node.
*
* @name: Device tree description
- * @return 0 if this device tree should be used, non-zero to try the next
+ * Return: 0 if this device tree should be used, non-zero to try the next
*/
int board_fit_config_name_match(const char *name);
* @node: offset of image node
* @image: pointer to the image start pointer
* @size: pointer to the image size
- * @return no return value (failure should be handled internally)
+ * Return: no return value (failure should be handled internally)
*/
void board_fit_image_post_process(const void *fit, int node, void **p_image,
size_t *p_size);
* the node described by the default configuration if it exists.
*
* @fdt: pointer to flat device tree
- * @return the node if found, -ve otherwise
+ * Return: the node if found, -ve otherwise
*/
int fit_find_config_node(const void *fdt);
* @param config Input state
* @param keycode List of key codes to examine
* @param num_keycodes Number of key codes
- * @return number of ascii characters sent, or 0 if none, or -1 for an
+ * Return: number of ascii characters sent, or 0 if none, or -1 for an
* internal error
*/
int input_send_keycodes(struct input_config *config, int keycode[], int count);
* @param config Input state
* @param new_keycode New keycode to add/remove
* @param release true if this key was released, false if depressed
- * @return number of ascii characters sent, or 0 if none, or -1 for an
+ * Return: number of ascii characters sent, or 0 if none, or -1 for an
* internal error
*/
int input_add_keycode(struct input_config *config, int new_keycode,
* Test if keys are available to be read
*
* @param config Input state
- * @return 0 if no keys available, 1 if keys are available
+ * Return: 0 if no keys available, 1 if keys are available
*/
int input_tstc(struct input_config *config);
* TODO: U-Boot wants 0 for no key, but Ctrl-@ is a valid key...
*
* @param config Input state
- * @return key, or 0 if no key, or -1 if error
+ * Return: key, or 0 if no key, or -1 if error
*/
int input_getc(struct input_config *config);
* Register a new device with stdio and switch to it if wanted
*
* @param dev Pointer to device
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int input_stdio_register(struct stdio_dev *dev);
* updating.
*
* @param config Input state
- * @return -1 if no LEDs need updating, other value if they do
+ * Return: -1 if no LEDs need updating, other value if they do
*/
int input_leds_changed(struct input_config *config);
*
* @param config Input state
* @param german true to use German keyboard layout, false for US
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int input_add_tables(struct input_config *config, bool german);
*
* @param config Input state
* @param leds Initial LED value (INPUT_LED_ mask), 0 suggested
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int input_init(struct input_config *config, int leds);
/**
* iotrace_get_checksum() - Get the current checksum value
*
- * @return currect checksum value
+ * Return: currect checksum value
*/
u32 iotrace_get_checksum(void);
/**
* iotrace_get_enabled() - Get whether iotracing is enabled or not
*
- * @return true if enabled, false if disabled
+ * Return: true if enabled, false if disabled
*/
int iotrace_get_enabled(void);
*
* @irq: IRQ description containing device and ID, e.g. previously
* returned by irq_get_by_index()
- * @return true if valid, false if not
+ * Return: true if valid, false if not
*/
static inline bool irq_is_valid(const struct irq *irq)
{
* @dev: IRQ device
* @irq: Interrupt number to set
* @active_low: true if active low, false for active high
- * @return 0 if OK, -EINVAL if @irq is invalid
+ * Return: 0 if OK, -EINVAL if @irq is invalid
*/
int irq_set_polarity(struct udevice *dev, uint irq, bool active_low);
* irq_snapshot_polarities() - record IRQ polarities for later restore
*
* @dev: IRQ device
- * @return 0
+ * Return: 0
*/
int irq_snapshot_polarities(struct udevice *dev);
* irq_restore_polarities() - restore IRQ polarities
*
* @dev: IRQ device
- * @return 0
+ * Return: 0
*/
int irq_restore_polarities(struct udevice *dev);
* Clears the interrupt if pending
*
* @dev: IRQ device
- * @return 0 if interrupt is not pending, 1 if it was (and so has been
+ * Return: 0 if interrupt is not pending, 1 if it was (and so has been
* cleared), -ve on error
*/
int irq_read_and_clear(struct irq *irq);
* @dev: Device containing the phandle
* @cells: Phandle info
* @irq: A pointer to a irq struct to initialise
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int irq_get_by_phandle(struct udevice *dev, const struct phandle_2_arg *cells,
struct irq *irq);
* @index: The index of the irq to request, within the client's list of
* irqs.
* @irq: A pointer to a irq struct to initialise.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int irq_get_by_index(struct udevice *dev, int index, struct irq *irq);
* @irq: A pointer to a irq struct to initialise. The caller must
* have already initialised any field in this struct which the
* irq provider uses to identify the irq.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int irq_request(struct udevice *dev, struct irq *irq);
*
* @irq: A irq struct that was previously successfully requested by
* irq_request/get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int irq_free(struct irq *irq);
*
* @type: Type to find
* @devp: Returns the device, if found
- * @return 0 if OK, -ENODEV if not found, other -ve error if uclass failed to
+ * Return: 0 if OK, -ENODEV if not found, other -ve error if uclass failed to
* probe
*/
int irq_first_device_type(enum irq_dev_t type, struct udevice **devp);
*
* @irq: irq to convert
* @acpi_irq: Output ACPI interrupt information
- * @return ACPI pin number or -ve on error
+ * Return: ACPI pin number or -ve on error
*/
int irq_get_acpi(const struct irq *irq, struct acpi_irq *acpi_irq);
* @param config Keyboard matrix config
* @param blob FDT blob
* @param node Node containing compatible data
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int key_matrix_decode_fdt(struct udevice *dev, struct key_matrix *config);
* @param rows Number of rows in key matrix
* @param cols Number of columns in key matrix
* @param ghost_filter Non-zero to enable ghost filtering
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int key_matrix_init(struct key_matrix *config, int rows, int cols,
int ghost_filter);
/**
* Get the width of the LCD in pixels
*
- * @return width of LCD in pixels
+ * Return: width of LCD in pixels
*/
int lcd_get_pixel_width(void);
/**
* Get the height of the LCD in pixels
*
- * @return height of LCD in pixels
+ * Return: height of LCD in pixels
*/
int lcd_get_pixel_height(void);
/**
* Get the number of text lines/rows on the LCD
*
- * @return number of rows
+ * Return: number of rows
*/
int lcd_get_screen_rows(void);
/**
* Get the number of text columns on the LCD
*
- * @return number of columns
+ * Return: number of columns
*/
int lcd_get_screen_columns(void);
/**
* Get the background color of the LCD
*
- * @return background color value
+ * Return: background color value
*/
int lcd_getbgcolor(void);
/**
* Get the foreground color of the LCD
*
- * @return foreground color value
+ * Return: foreground color value
*/
int lcd_getfgcolor(void);
*
* @label: LED label to look up
* @devp: Returns the associated device, if found
- * @return 0 if found, -ENODEV if not found, other -ve on error
+ * Return: 0 if found, -ENODEV if not found, other -ve on error
*/
int led_get_by_label(const char *label, struct udevice **devp);
*
* @dev: LED device to change
* @state: LED state to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int led_set_state(struct udevice *dev, enum led_state_t state);
* led_get_state() - get the state of an LED
*
* @dev: LED device to change
- * @return LED state led_state_t, or -ve on error
+ * Return: LED state led_state_t, or -ve on error
*/
enum led_state_t led_get_state(struct udevice *dev);
*
* @dev: LED device to change
* @period_ms: LED blink period in milliseconds
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int led_set_period(struct udevice *dev, int period_ms);
* @table: array of register values corresponding to the parent index (optional)
* @flags: hardware-specific flags
* @index: parent clock index
- * @return the register value
+ * Return: the register value
*/
unsigned int clk_mux_index_to_val(u32 *table, unsigned int flags, u8 index);
*
* @table: array of register values corresponding to valid dividers
* @val: value to convert
- * @return the divider
+ * Return: the divider
*/
unsigned int clk_divider_get_table_div(const struct clk_div_table *table,
unsigned int val);
*
* @table: array of register values corresponding to valid dividers
* @div: requested divider
- * @return the register value
+ * Return: the register value
*/
unsigned int clk_divider_get_table_val(const struct clk_div_table *table,
unsigned int div);
* @table: array of valid dividers (optional)
* @div: divider to check
* @flags: hardware-specific flags
- * @return true if the divider is valid, false otherwise
+ * Return: true if the divider is valid, false otherwise
*/
bool clk_divider_is_valid_div(const struct clk_div_table *table,
unsigned int div, unsigned long flags);
*
* @table: array of valid dividers
* @div: divider to check
- * @return true if the divider is found in the @table array, false otherwise
+ * Return: true if the divider is found in the @table array, false otherwise
*/
bool clk_divider_is_valid_table_div(const struct clk_div_table *table,
unsigned int div);
* NULL
* @s: string to search
* @c: character to search for
- * @return position of @c in @s, or end of @s if not found
+ * Return: position of @c in @s, or end of @s if not found
*/
const char *strchrnul(const char *s, int c);
*
* @s: string to search
* @reject: strings which cause the search to halt
- * @return number of characters at the start of @s which are not in @reject
+ * Return: number of characters at the start of @s which are not in @reject
*/
size_t strcspn(const char *s, const char *reject);
#endif
*
* @src: data to copy in
* @len: number of bytes to copy
- * @return allocated buffer with the copied contents, or NULL if not enough
+ * Return: allocated buffer with the copied contents, or NULL if not enough
* memory is available
*
*/
*
* @in: Input buffer to decompress
* @out: Output buffer to hold the results (must be large enough)
- * @return size of the decompressed data, or -ve on error
+ * Return: size of the decompressed data, or -ve on error
*/
int zstd_decompress(struct abuf *in, struct abuf *out);
*
* @drv: Driver of device to enable
* @enable: true to enable, false to disable
- * @return 0 if OK, -ENOENT if the driver was not found
+ * Return: 0 if OK, -ENOENT if the driver was not found
*/
int log_device_set_enable(struct log_driver *drv, bool enable);
*
* @chan: The channel to send to the message to.
* @data: A pointer to the message to send.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int (*send)(struct mbox_chan *chan, const void *data);
/**
*
* @chan: The channel to receive to the message from.
* @data: A pointer to the buffer to hold the received message.
- * @return 0 if OK, -ENODATA if no message was available, or a negative
+ * Return: 0 if OK, -ENODATA if no message was available, or a negative
* error code.
*/
int (*recv)(struct mbox_chan *chan, void *data);
* @index: The index of the mailbox channel to request, within the
* client's list of channels.
* @chan A pointer to a channel object to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan);
* @name: The name of the mailbox channel to request, within the client's
* list of channels.
* @chan A pointer to a channel object to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int mbox_get_by_name(struct udevice *dev, const char *name,
struct mbox_chan *chan);
*
* @chan: A channel object that was previously successfully requested by
* calling mbox_get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int mbox_free(struct mbox_chan *chan);
* the memory region pointed at by @data is determined by the
* mailbox provider. Providers that solely transfer notifications
* will ignore this parameter.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int mbox_send(struct mbox_chan *chan, const void *data);
* notifications will ignore this parameter.
* @timeout_us: The maximum time to wait for a message to be available, in
* micro-seconds. A value of 0 does not wait at all.
- * @return 0 if OK, -ENODATA if no message was available, or a negative error
+ * Return: 0 if OK, -ENODATA if no message was available, or a negative error
* code.
*/
int mbox_recv(struct mbox_chan *chan, void *data, ulong timeout_us);
*
* @size: Minimum number of bytes to allocate
*
- * @return pointer to new memory region, or NULL if there is no more memory
+ * Return: pointer to new memory region, or NULL if there is no more memory
* available.
*/
static inline void *malloc_cache_aligned(size_t size)
* @maxlen: the number of bytes we want to write
* @update: true to update the membuff as if the write happened, false to not
* @data: the address data can be written to
- * @return number of bytes which can be written
+ * Return: number of bytes which can be written
*/
int membuff_putraw(struct membuff *mb, int maxlen, bool update, char **data);
* @update: true to update the membuff as if the bytes have been read (use
* false to check bytes without reading them)
* @data: returns address of data in input membuff
- * @return the number of bytes available at *@data
+ * Return: the number of bytes available at *@data
*/
int membuff_getraw(struct membuff *mb, int maxlen, bool update, char **data);
*
* @mb: membuff to adjust
* @ch: byte to write
- * @return true on success, false if membuff is full
+ * Return: true on success, false if membuff is full
*/
bool membuff_putbyte(struct membuff *mb, int ch);
/**
* @mb: membuff to adjust
* membuff_getbyte() - Read a byte from the membuff
- * @return the byte read, or -1 if the membuff is empty
+ * Return: the byte read, or -1 if the membuff is empty
*/
int membuff_getbyte(struct membuff *mb);
* removing it from the membuff.
*
* @mb: membuff to adjust
- * @return the byte peeked, or -1 if the membuff is empty
+ * Return: the byte peeked, or -1 if the membuff is empty
*/
int membuff_peekbyte(struct membuff *mb);
* @mb: membuff to adjust
* @Buff: address of membuff to transfer bytes to
* @maxlen: maximum number of bytes to read
- * @return the number of bytes read
+ * Return: the number of bytes read
*/
int membuff_get(struct membuff *mb, char *buff, int maxlen);
* @mb: membuff to adjust
* @data: the data to write
* @length: number of bytes to write from 'data'
- * @return the number of bytes added
+ * Return: the number of bytes added
*/
int membuff_put(struct membuff *mb, const char *buff, int length);
* membuff_isempty() - check if a membuff is empty
*
* @mb: membuff to check
- * @return true if empty, else false
+ * Return: true if empty, else false
*/
bool membuff_isempty(struct membuff *mb);
* membuff_avail() - check available data in a membuff
*
* @mb: membuff to check
- * @return number of bytes of data available
+ * Return: number of bytes of data available
*/
int membuff_avail(struct membuff *mb);
* Note that a membuff can only old data up to one byte less than its size.
*
* @mb: membuff to check
- * @return total size
+ * Return: total size
*/
int membuff_size(struct membuff *mb);
* possible
*
* @mb: membuff to adjust
- * @return true on success
+ * Return: true on success
*/
bool membuff_makecontig(struct membuff *mb);
* membuff_free() - find the number of bytes that can be written to a membuff
*
* @mb: membuff to check
- * @return returns the number of bytes free in a membuff
+ * Return: returns the number of bytes free in a membuff
*/
int membuff_free(struct membuff *mb);
* @mb: membuff to adjust
* @str: Place to put the line
* @maxlen: Maximum line length (excluding terminator)
- * @return number of bytes read (including terminator) if a line has been
+ * Return: number of bytes read (including terminator) if a line has been
* read, 0 if nothing was there
*/
int membuff_readline(struct membuff *mb, char *str, int maxlen, int minch);
* @mb: membuff to adjust
* @by: Number of bytes to increase the size by
* @max: Maximum size to allow
- * @return 0 if the expand succeeded, -ENOMEM if not enough memory, -E2BIG
+ * Return: 0 if the expand succeeded, -ENOMEM if not enough memory, -E2BIG
* if the the size would exceed @max
*/
int membuff_extend_by(struct membuff *mb, int by, int max);
*
* @mb: membuff to init
* @size: size of membuff to create
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
int membuff_new(struct membuff *mb, int size);
*
* @bootdelay: Delay to wait before running the default menu option (0 to run
* the entry immediately)
- * @return If it returns, it always returns -1 to indicate that the boot should
+ * Return: If it returns, it always returns -1 to indicate that the boot should
* be aborted and the command prompt should be provided
*/
int menu_show(int bootdelay);
* @ethdev: ethernet device to connect to the PHY
* @interface: MAC-PHY protocol
*
- * @return pointer to phy_device, or 0 on error
+ * Return: pointer to phy_device, or 0 on error
*/
struct phy_device *dm_mdio_phy_connect(struct udevice *mdiodev, int phyaddr,
struct udevice *ethdev,
*
* @ethdev: ethernet device
*
- * @return pointer to phy_device, or 0 on error
+ * Return: pointer to phy_device, or 0 on error
*/
struct phy_device *dm_eth_phy_connect(struct udevice *ethdev);
* will be available.
*
* @dev: Device
- * @return associated mmc struct pointer if available, else NULL
+ * Return: associated mmc struct pointer if available, else NULL
*/
struct mmc *mmc_get_mmc_dev(const struct udevice *dev);
* @dev: MMC device to set up
* @mmc: MMC struct
* @cfg: MMC configuration
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_bind(struct udevice *dev, struct mmc *mmc,
const struct mmc_config *cfg);
* mmc_unbind() - Unbind a MMC device's child block device
*
* @dev: MMC device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_unbind(struct udevice *dev);
int mmc_initialize(struct bd_info *bis);
*
* @dev: MMC device
* @cfg: MMC configuration
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg);
*
* @dev: MMC device
* @cfg: MMC configuration
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_pwrseq_get_power(struct udevice *dev, struct mmc_config *cfg);
#endif
* mmc_voltage_to_mv() - Convert a mmc_voltage in mV
*
* @voltage: The mmc_voltage to convert
- * @return the value in mV if OK, -EINVAL on error (invalid mmc_voltage value)
+ * Return: the value in mV if OK, -EINVAL on error (invalid mmc_voltage value)
*/
int mmc_voltage_to_mv(enum mmc_voltage voltage);
* @mmc: MMC struct
* @clock: bus frequency in Hz
* @disable: flag indicating if the clock must on or off
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int mmc_set_clock(struct mmc *mmc, uint clock, bool disable);
/**
* get_mmc_num() - get the total MMC device number
*
- * @return 0 if there is no MMC device, else the number of devices
+ * Return: 0 if there is no MMC device, else the number of devices
*/
int get_mmc_num(void);
int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
*
* @param mmc Pointer to a MMC device struct
* @param quiet Be quiet, do not print error messages when card is not detected.
- * @return 0 on success, <0 on error.
+ * Return: 0 on success, <0 on error.
*/
int mmc_get_op_cond(struct mmc *mmc, bool quiet);
* initializatin.
*
* @param mmc Pointer to a MMC device struct
- * @return 0 on success, <0 on error.
+ * Return: 0 on success, <0 on error.
*/
int mmc_start_init(struct mmc *mmc);
* mmc_get_blk_desc() - Get the block descriptor for an MMC device
*
* @mmc: MMC device
- * @return block device if found, else NULL
+ * Return: block device if found, else NULL
*/
struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);
* @flag: Command flags (CMD_FLAG_...)
* @argc: Number of arguments
* @argv: List of arguments
- * @return result (see enum command_ret_t)
+ * Return: result (see enum command_ret_t)
*/
int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
* @base_name: Base name for variable, typically "eth"
* @index: Index of interface being updated (>=0)
* @enetaddr: Pointer to MAC address to put into the variable
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
*/
int eth_env_set_enetaddr_by_index(const char *base_name, int index,
uchar *enetaddr);
*
* @addr: Address to check (must be 16-bit aligned)
* @nbytes: Number of bytes to check (normally a multiple of 2)
- * @return 16-bit IP checksum
+ * Return: 16-bit IP checksum
*/
unsigned compute_ip_checksum(const void *addr, unsigned nbytes);
* @offset: Offset of first sum (if odd we do a byte-swap)
* @sum: First checksum
* @new_sum: New checksum to add
- * @return updated 16-bit IP checksum
+ * Return: updated 16-bit IP checksum
*/
unsigned add_ip_checksums(unsigned offset, unsigned sum, unsigned new_sum);
*
* @addr: Address to check (must be 16-bit aligned)
* @nbytes: Number of bytes to check (normally a multiple of 2)
- * @return true if the checksum matches, false if not
+ * Return: true if the checksum matches, false if not
*/
int ip_checksum_ok(const void *addr, unsigned nbytes);
* @param interface - the DFU medium name - e.g. "mmc"
* @param devstring - the DFU medium number - e.g. "1"
*
- * @return - 0 on success, other value on failure
+ * Return: - 0 on success, other value on failure
*/
int update_tftp(ulong addr, char *interface, char *devstring);
* @var: Environment variable to convert. The value of this variable must be
* in the format format a.b.c.d, where each value is a decimal number from
* 0 to 255
- * @return IP address, or 0 if invalid
+ * Return: IP address, or 0 if invalid
*/
static inline struct in_addr env_get_ip(char *var)
{
* @tailroom: Size, in bytes, of tailroom needed for the DSA tag.
* Total headroom and tailroom size should not exceed
* DSA_MAX_OVR.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom);
* Can be called at driver probe time or later.
*
* @dev: DSA device pointer
- * @return Master Eth 'udevice' pointer if OK, NULL on error
+ * Return: Master Eth 'udevice' pointer if OK, NULL on error
*/
struct udevice *dsa_get_master(struct udevice *dev);
*
* @dev: DSA switch udevice pointer
* @port: Port index
- * @return OF node reference if OK, NULL on error
+ * Return: OF node reference if OK, NULL on error
*/
ofnode dsa_port_get_ofnode(struct udevice *dev, int port);
* Can be called at driver probe time or later.
*
* @pdev: DSA port device pointer
- * @return 'dsa_port_pdata' pointer if OK, NULL on error
+ * Return: 'dsa_port_pdata' pointer if OK, NULL on error
*/
static inline struct dsa_port_pdata *
dsa_port_get_pdata(struct udevice *pdev)
* @paddr physicaly memory address to store buffer
* @size maximum size of capture file in memory
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_init(phys_addr_t paddr, unsigned long size);
*
* @start if true, start capture if false stop capture
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_start_stop(bool start);
/**
* pcap_clear() - clear pcap capture buffer and statistics
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_clear(void);
/**
* pcap_print_status() - print status of pcap capture
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_print_status(void);
/**
* pcap_active() - check if pcap is enabled
*
- * @return TRUE if active, FALSE if not.
+ * Return: TRUE if active, FALSE if not.
*/
bool pcap_active(void);
* @packet: packet to post
* @len: packet length in bytes
* @outgoing packet direction (outgoing/incoming)
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_post(const void *packet, size_t len, bool outgoing);
* @port: UART port
* @clock: UART input clock speed in Hz
* @baudrate: Required baud rate
- * @return baud rate divisor that should be used
+ * Return: baud rate divisor that should be used
*/
int ns16550_calc_divisor(struct ns16550 *port, int clock, int baudrate);
* ns16550_serial_probe() - probe a serial port
*
* This sets up the serial port ready for use, except for the baud rate
- * @return 0, or -ve on error
+ * Return: 0, or -ve on error
*/
int ns16550_serial_probe(struct udevice *dev);
*
* @fdt_blob: Input tree to convert
* @rootp: Returns live tree that was created
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int of_live_build(const void *fdt_blob, struct device_node **rootp);
*
* @dev: P2SB device
* @hide: true to hide the device, false to show it
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int p2sb_set_hide(struct udevice *dev, bool hide);
*
* @dev: Device to read from
* @offset: Offset within device to read
- * @return value read
+ * Return: value read
*/
uint pcr_read32(struct udevice *dev, uint offset);
uint pcr_read16(struct udevice *dev, uint offset);
*
* @dev: Child device (whose parent is UCLASS_P2SB)
* @portid: Port ID of child device
- * @return 0 if OK, -ENODEV is the p2sb device could not be found
+ * Return: 0 if OK, -ENODEV is the p2sb device could not be found
*/
int p2sb_set_port_id(struct udevice *dev, int portid);
* p2sb_get_port_id() - Get the port ID for a p2sb child device
*
* @dev: Child device (whose parent is UCLASS_P2SB)
- * @return Port ID of that child
+ * Return: Port ID of that child
*/
int p2sb_get_port_id(struct udevice *dev);
*
* @dev: Child device (whose parent is UCLASS_P2SB)
* @offset: Offset within that child's address space
- * @return pointer to that offset within the child's address space
+ * Return: pointer to that offset within the child's address space
*/
void *pcr_reg_address(struct udevice *dev, uint offset);
*
* @dev: Panel device containing the backlight to enable
* @enable: true to enable the backlight, false to dis
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int panel_enable_backlight(struct udevice *dev);
*
* @dev: Panel device containing the backlight to update
* @percent: Brightness value (0 to 100, or BACKLIGHT_... value)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int panel_set_backlight(struct udevice *dev, int percent);
* panel_get_display_timing() - Get display timings from panel.
*
* @dev: Panel device containing the display timings
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int panel_get_display_timing(struct udevice *dev,
struct display_timing *timing);
* @ifname: Interface name (e.g. "ide", "scsi")
* @dev: Device number (0 for first device on that interface, 1 for
* second, etc.
- * @return pointer to the block device, or NULL if not available, or an
+ * Return: pointer to the block device, or NULL if not available, or an
* error occurred.
*/
struct blk_desc *blk_get_dev(const char *ifname, int dev);
* and hardware partition number (e.g. "2.4") for devices that
* support it (currently only MMC).
* @dev_desc: Returns a pointer to the block device on success
- * @return block device number (local to the interface), or -1 on error
+ * Return: block device number (local to the interface), or -1 on error
*/
int blk_get_device_by_str(const char *ifname, const char *dev_str,
struct blk_desc **dev_desc);
* @allow_whole_dev: true to allow the user to select partition 0
* (which means the whole device), false to require a valid
* partition number >= 1
- * @return partition number, or -1 on error
+ * Return: partition number, or -1 on error
*
*/
int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
* @param info - returns the disk partition info
* @param part_type - only search in partitions of this type
*
- * @return - the partition number on match (starting on 1), -1 on no match,
+ * Return: - the partition number on match (starting on 1), -1 on no match,
* otherwise error
*/
int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
* @param gpt_name - the specified table entry name
* @param info - returns the disk partition info
*
- * @return - the partition number on match (starting on 1), -1 on no match,
+ * Return: - the partition number on match (starting on 1), -1 on no match,
* otherwise error
*/
int part_get_info_by_name(struct blk_desc *dev_desc,
* @param[in] allow_whole_dev true to allow the user to select partition 0
* (which means the whole device), false to require a valid
* partition number >= 1
- * @return the partition number on success, or negative errno on error
+ * Return: the partition number on success, or negative errno on error
*/
int part_get_info_by_dev_and_name_or_num(const char *dev_iface,
const char *dev_part_str,
* @param gpt_h - pointer to GPT header representation
* @param gpt_e - pointer to GPT partition table entries
*
- * @return - zero on success, otherwise error
+ * Return: - zero on success, otherwise error
*/
int write_gpt_table(struct blk_desc *dev_desc,
gpt_header *gpt_h, gpt_entry *gpt_e);
* @param partitions - list of partitions
* @param parts - number of partitions
*
- * @return zero on success
+ * Return: zero on success
*/
int gpt_fill_pte(struct blk_desc *dev_desc,
gpt_header *gpt_h, gpt_entry *gpt_e,
* @param str_guid - disk guid string representation
* @param parts_count - number of partitions
*
- * @return - error on str_guid conversion error
+ * Return: - error on str_guid conversion error
*/
int gpt_fill_header(struct blk_desc *dev_desc, gpt_header *gpt_h,
char *str_guid, int parts_count);
* @param partitions - list of partitions
* @param parts - number of partitions
*
- * @return zero on success
+ * Return: zero on success
*/
int gpt_restore(struct blk_desc *dev_desc, char *str_disk_guid,
struct disk_partition *partitions, const int parts_count);
* @param dev_desc - block device descriptor
* @param buf - buffer which contains the MBR and Primary GPT info
*
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
*/
int is_valid_gpt_buf(struct blk_desc *dev_desc, void *buf);
* @param dev_desc - block device descriptor
* @param buf - buffer which contains the MBR and Primary GPT info
*
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
*/
int write_mbr_and_gpt_partitions(struct blk_desc *dev_desc, void *buf);
* @param gpt_head - pointer to GPT header data read from medium
* @param gpt_pte - pointer to GPT partition table enties read from medium
*
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
*/
int gpt_verify_headers(struct blk_desc *dev_desc, gpt_header *gpt_head,
gpt_entry **gpt_pte);
* @param gpt_head - pointer to GPT header data read from medium
* @param gpt_pte - pointer to GPT partition table enties read from medium
*
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
*/
int gpt_verify_partitions(struct blk_desc *dev_desc,
struct disk_partition *partitions, int parts,
* @param dev_desc - block device descriptor
* @param guid - pre-allocated string in which to return the GUID
*
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
*/
int get_disk_guid(struct blk_desc *dev_desc, char *guid);
*
* @param buf - buffer which contains the MBR
*
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
*/
int is_valid_dos_buf(void *buf);
* @param dev_desc - block device descriptor
* @param buf - buffer which contains the MBR
*
- * @return - '0' on success, otherwise error
+ * Return: - '0' on success, otherwise error
*/
int write_mbr_sector(struct blk_desc *dev_desc, void *buf);
/**
* part_driver_get_count() - get partition driver count
*
- * @return - number of partition drivers
+ * Return: - number of partition drivers
*/
static inline int part_driver_get_count(void)
{
/**
* part_driver_get_first() - get first partition driver
*
- * @return - pointer to first partition driver on success, otherwise NULL
+ * Return: - pointer to first partition driver on success, otherwise NULL
*/
static inline struct part_driver *part_driver_get_first(void)
{
*
* @dev: PCH device to check
* @sbasep: Returns address of SPI base if available, else 0
- * @return 0 if OK, -ve on error (e.g. there is no SPI base)
+ * Return: 0 if OK, -ve on error (e.g. there is no SPI base)
*/
int pch_get_spi_base(struct udevice *dev, ulong *sbasep);
* @dev: PCH device to adjust
* @protect: true to protect, false to unprotect
*
- * @return 0 on success, -ENOSYS if not implemented
+ * Return: 0 on success, -ENOSYS if not implemented
*/
int pch_set_spi_protect(struct udevice *dev, bool protect);
*
* @dev: PCH device to check
* @gbasep: Returns address of GPIO base if available, else 0
- * @return 0 if OK, -ve on error (e.g. there is no GPIO base)
+ * Return: 0 if OK, -ve on error (e.g. there is no GPIO base)
*/
int pch_get_gpio_base(struct udevice *dev, u32 *gbasep);
*
* @dev: PCH device to check
* @iobasep: Returns address of IO base if available, else 0
- * @return 0 if OK, -ve on error (e.g. there is no IO base)
+ * Return: 0 if OK, -ve on error (e.g. there is no IO base)
*/
int pch_get_io_base(struct udevice *dev, u32 *iobasep);
* @req: PCH request ID
* @data: Input/output data
* @size: Size of input data (and maximum size of output data)
- * @return size of output data on sucesss, -ve on error
+ * Return: size of output data on sucesss, -ve on error
*/
int pch_ioctl(struct udevice *dev, ulong req, void *data, int size);
* @size: Amount of bytes to allocate
* @bar: Returns the PCI bus address of the allocated resource
* @supports_64bit: Whether to allow allocations above the 32-bit boundary
- * @return 0 if successful, -1 on failure
+ * Return: 0 if successful, -1 on failure
*/
int pciauto_region_allocate(struct pci_region *res, pci_size_t size,
pci_addr_t *bar, bool supports_64bit);
* @hose: PCI hose to use
* @dev: PCI device to inspect
* @barnum: BAR number (0-5)
- * @return address of the bar, masking out any control bits
+ * Return: address of the bar, masking out any control bits
* */
u32 pci_read_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum);
* dm_pci_get_bdf() - Get the BDF value for a device
*
* @dev: Device to check
- * @return bus/device/function value (see PCI_BDF())
+ * Return: bus/device/function value (see PCI_BDF())
*/
pci_dev_t dm_pci_get_bdf(const struct udevice *dev);
* driver interface.
*
* @bus: Bus containing devices to bind
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_bind_bus_devices(struct udevice *bus);
* devices are mapped into memory and I/O space ready for use.
*
* @bus: Bus containing devices to bind
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_auto_config_devices(struct udevice *bus);
*
* @bdf: PCI device address: bus, device and function -see PCI_BDF()
* @devp: Returns the device for this address, if found
- * @return 0 if OK, -ENODEV if not found
+ * Return: 0 if OK, -ENODEV if not found
*/
int dm_pci_bus_find_bdf(pci_dev_t bdf, struct udevice **devp);
*
* @find_devfn: PCI device address (device and function only)
* @devp: Returns the device for this address, if found
- * @return 0 if OK, -ENODEV if not found
+ * Return: 0 if OK, -ENODEV if not found
*/
int pci_bus_find_devfn(const struct udevice *bus, pci_dev_t find_devfn,
struct udevice **devp);
*
* @devp: Set to the first available device, or NULL if no more are left
* or we got an error
- * @return 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe)
+ * Return: 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe)
*/
int pci_find_first_device(struct udevice **devp);
*
* @devp: On entry, the last device returned. Set to the next available
* device, or NULL if no more are left or we got an error
- * @return 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe)
+ * Return: 0 if all is OK, -ve on error (e.g. a bus/bridge failed to probe)
*/
int pci_find_next_device(struct udevice **devp);
* pci_get_ff() - Returns a mask for the given access size
*
* @size: Access size
- * @return 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for
+ * Return: 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for
* PCI_SIZE_32
*/
int pci_get_ff(enum pci_size_t size);
* parameter is decremented for each non-matching device so
* can be called repeatedly.
* @devp: Returns matching device if found
- * @return 0 if found, -ENODEV if not
+ * Return: 0 if found, -ENODEV if not
*/
int pci_bus_find_devices(struct udevice *bus, const struct pci_device_id *ids,
int *indexp, struct udevice **devp);
* @index: Index number of device to find, 0 for the first match, 1 for
* the second, etc.
* @devp: Returns matching device if found
- * @return 0 if found, -ENODEV if not
+ * Return: 0 if found, -ENODEV if not
*/
int pci_find_device_id(const struct pci_device_id *ids, int index,
struct udevice **devp);
*
* @hose: PCI hose to scan
* @bdf: PCI bus address to scan (PCI_BUS(bdf) is the bus number)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_pci_hose_probe_bus(struct udevice *bus);
* @offset: Register offset to read
* @valuep: Place to put the returned value
* @size: Access size
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_bus_read_config(const struct udevice *bus, pci_dev_t bdf, int offset,
unsigned long *valuep, enum pci_size_t size);
* @offset: Register offset to write
* @value: Value to write
* @size: Access size
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_bus_write_config(struct udevice *bus, pci_dev_t bdf, int offset,
unsigned long value, enum pci_size_t size);
* @offset: Register offset to update
* @clr: Bits to clear
* @set: Bits to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_bus_clrset_config32(struct udevice *bus, pci_dev_t bdf, int offset,
u32 clr, u32 set);
*
* @pdev: Physical Function udevice handle
* @vf_en: Number of Virtual Function devices to enable
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int pci_sriov_init(struct udevice *pdev, int vf_en);
* pci_sriov_get_totalvfs() - Get total available Virtual Function devices
*
* @pdev: Physical Function udevice handle
- * @return count on success, -ve on error
+ * Return: count on success, -ve on error
*/
int pci_sriov_get_totalvfs(struct udevice *pdev);
#endif
* devices are mapped into memory and I/O space ready for use.
*
* @dev: Device to configure
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_pciauto_config_device(struct udevice *dev);
* @value: Value to transform (32-bit value read from @offset & ~3)
* @offset: Register offset that was read
* @size: Required size of the result
- * @return the value that would have been obtained if the read had been
+ * Return: the value that would have been obtained if the read had been
* performed at the given offset with the correct size
*/
ulong pci_conv_32_to_size(ulong value, uint offset, enum pci_size_t size);
* @value: Value to transform (32-bit value read from @offset & ~3)
* @offset: Register offset that should be written
* @size: Required size of the write
- * @return the value that should be written as a 32-bit access to @offset & ~3.
+ * Return: the value that should be written as a 32-bit access to @offset & ~3.
*/
ulong pci_conv_size_to_32(ulong old, ulong value, uint offset,
enum pci_size_t size);
* pci_get_controller() - obtain the controller to use for a bus
*
* @dev: Device to check
- * @return pointer to the controller device for this bus
+ * Return: pointer to the controller device for this bus
*/
struct udevice *pci_get_controller(struct udevice *dev);
* @iop: Returns a pointer to the I/O region, or NULL if none
* @memp: Returns a pointer to the memory region, or NULL if none
* @prefp: Returns a pointer to the pre-fetch region, or NULL if none
- * @return the number of non-NULL regions returned, normally 3
+ * Return: the number of non-NULL regions returned, normally 3
*/
int pci_get_regions(struct udevice *dev, struct pci_region **iop,
struct pci_region **memp, struct pci_region **prefp);
* @dev: Device containing the PCI address
* @addr: PCI address to convert
* @flags: Flags for the region type (PCI_REGION_...)
- * @return physical address corresponding to that PCI bus address
+ * Return: physical address corresponding to that PCI bus address
*/
phys_addr_t dm_pci_bus_to_phys(struct udevice *dev, pci_addr_t addr,
unsigned long flags);
* @dev: Device containing the bus address
* @addr: Physical address to convert
* @flags: Flags for the region type (PCI_REGION_...)
- * @return PCI bus address corresponding to that physical address
+ * Return: PCI bus address corresponding to that physical address
*/
pci_addr_t dm_pci_phys_to_bus(struct udevice *dev, phys_addr_t addr,
unsigned long flags);
* @device: Device ID
* @index: 0 to find the first match, 1 for second, etc.
* @devp: Returns pointer to the device, if found
- * @return 0 if found, -ve on error
+ * Return: 0 if found, -ve on error
*/
int dm_pci_find_device(unsigned int vendor, unsigned int device, int index,
struct udevice **devp);
* @find_class: 3-byte (24-bit) class value to find
* @index: 0 to find the first match, 1 for second, etc.
* @devp: Returns pointer to the device, if found
- * @return 0 if found, -ve on error
+ * Return: 0 if found, -ve on error
*/
int dm_pci_find_class(uint find_class, int index, struct udevice **devp);
* @find_devfn: PCI device and function address (PCI_DEVFN())
* @containerp: Returns container device if found
* @emulp: Returns emulated device if found
- * @return 0 if found, -ENODEV if not found
+ * Return: 0 if found, -ENODEV if not found
*/
int sandbox_pci_get_emul(const struct udevice *bus, pci_dev_t find_devfn,
struct udevice **containerp, struct udevice **emulp);
*
* @emul: Emulation device to check
* @devp: Returns the client device emulated by this device
- * @return 0 if OK, -ENOENT if the device has no client yet
+ * Return: 0 if OK, -ENOENT if the device has no client yet
*/
int sandbox_pci_get_client(struct udevice *emul, struct udevice **devp);
* @dev: device to write to
* @func_num: EP function to fill
* @hdr: header to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_write_header(struct udevice *dev, uint func_num,
struct pci_ep_header *hdr);
* @dev: device to write to
* @func_num: EP function to fill
* @hdr: header to read to
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_read_header(struct udevice *dev, uint func_num,
struct pci_ep_header *hdr);
* @dev: device to set
* @func_num: EP function to set
* @bar: bar data
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_set_bar(struct udevice *dev, uint func_num, struct pci_bar *bar);
* @func_num: EP function to read
* @bar: struct to copy data to
* @barno: bar number to read
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_read_bar(struct udevice *dev, uint func_no, struct pci_bar *ep_bar,
enum pci_barno barno);
* @dev: device to clear
* @func_num: EP function to clear
* @bar: bar number
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_clear_bar(struct udevice *dev, uint func_num, enum pci_barno bar);
/**
* @addr: local physical address base
* @pci_addr: pci address to translate to
* @size: region size
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_map_addr(struct udevice *dev, uint func_num, phys_addr_t addr,
u64 pci_addr, size_t size);
* @dev: device to set
* @func_num: EP function to set
* @addr: local physical address base
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_unmap_addr(struct udevice *dev, uint func_num, phys_addr_t addr);
* @dev: device to set
* @func_num: EP function to set
* @interrupts: required interrupts count
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_set_msi(struct udevice *dev, uint func_num, uint interrupts);
*
* @dev: device to use
* @func_num: EP function to use
- * @return msi count if OK, -EINVAL if msi were not enabled at host.
+ * Return: msi count if OK, -EINVAL if msi were not enabled at host.
*/
int pci_ep_get_msi(struct udevice *dev, uint func_num);
* @dev: device to set
* @func_num: EP function to set
* @interrupts: required interrupts count
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_set_msix(struct udevice *dev, uint func_num, uint interrupts);
*
* @dev: device to use
* @func_num: EP function to use
- * @return msi count if OK, -EINVAL if msi were not enabled at host.
+ * Return: msi count if OK, -EINVAL if msi were not enabled at host.
*/
int pci_ep_get_msix(struct udevice *dev, uint func_num);
* @func_num: EP function to set
* @type: type of irq to send
* @interrupt_num: interrupt vector to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_raise_irq(struct udevice *dev, uint func_num,
enum pci_ep_irq_type type, uint interrupt_num);
* process.
*
* @dev: device to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_start(struct udevice *dev);
* link.
*
* @dev: device to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pci_ep_stop(struct udevice *dev);
* the mapping ourselves.
*
* @vendev: Vendor and device for the video device
- * @return standard vendor and device expected by the ROM
+ * Return: standard vendor and device expected by the ROM
*/
uint32_t board_map_oprom_vendev(uint32_t vendev);
* sun4i_usb_phy_id_detect - detect ID pin of USB PHY
*
* @phy: USB PHY port to detect ID pin
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int sun4i_usb_phy_id_detect(struct phy *phy);
* sun4i_usb_phy_vbus_detect - detect VBUS pin of USB PHY
*
* @phy: USB PHY port to detect VBUS pin
- * @return 0 if OK, or a negative error code
+ * Return: 0 if OK, or a negative error code
*/
int sun4i_usb_phy_vbus_detect(struct phy *phy);
* @param c The character to set each byte of the region to.
* @param n The number of bytes to set.
*
- * @return The physical address of the memory which was set.
+ * Return: The physical address of the memory which was set.
*/
phys_addr_t arch_phys_memset(phys_addr_t s, int c, phys_size_t n);
*
* @dev: The client device.
* @power_domain A pointer to a power domain struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_get(struct udevice *dev, struct power_domain *power_domain);
* @power_domain: A pointer to a power domain struct to initialize.
* @index: Power domain index to be powered on.
*
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_get_by_index(struct udevice *dev,
*
* @power_domain: A power domain struct that was previously successfully
* requested by power_domain_get().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_free(struct power_domain *power_domain);
*
* @power_domain: A power domain struct that was previously successfully
* requested by power_domain_get().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_on(struct power_domain *power_domain);
*
* @power_domain: A power domain struct that was previously successfully
* requested by power_domain_get().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_off(struct power_domain *power_domain);
*
* @dev: The client device.
*
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN)
int dev_power_domain_on(struct udevice *dev);
*
* @dev: The client device.
*
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN)
int dev_power_domain_off(struct udevice *dev);
* This reads the current state of the PMC. This reads in the common registers,
* then calls the device's init() method to read the SoC-specific registers.
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pmc_init(struct udevice *dev);
* This reads various state registers and returns the sleep state from
* which the system woke.
*
- * @return enum acpi_sleep_state indicating the previous sleep state
+ * Return: enum acpi_sleep_state indicating the previous sleep state
* (ACPI_S0, ACPI_S3 or ACPI_S5), or -ve on error
*/
int pmc_prev_sleep_state(struct udevice *dev);
* Disables the timer/counter in the PMC
*
* @dev: PMC device to use
- * @return 0
+ * Return: 0
*/
int pmc_disable_tco(struct udevice *dev);
*
* @dev: PMC device to use
* @enable: true to enable global reset, false to disable
- * @return 0
+ * Return: 0
*/
int pmc_global_reset_set_enable(struct udevice *dev, bool enable);
* pmc_gpe_init() - Set up general-purpose events
*
* @dev: PMC device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pmc_gpe_init(struct udevice *dev);
*
* @pmic - pmic device - the parent of found child's
* @child_info - N-childs info array
- * @return a positive number of childs, or 0 if no child found (error)
+ * Return: a positive number of childs, or 0 if no child found (error)
*
* Note: For N-childs the child_info array should have N+1 entries and the last
* entry prefix should be NULL - the same as for drivers compatible.
*
* @name - device name
* @devp - returned pointer to the pmic device
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*
* The returned devp device can be used with pmic_read/write calls
*/
* The required pmic device can be obtained by 'pmic_get()'
*
* @dev - pointer to the UCLASS_PMIC device
- * @return register count value on success or negative value of errno.
+ * Return: register count value on success or negative value of errno.
*/
int pmic_reg_count(struct udevice *dev);
* @reg - device register offset
* @buffer - pointer to read/write buffer
* @len - byte count for read/write
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*/
int pmic_read(struct udevice *dev, uint reg, uint8_t *buffer, int len);
int pmic_write(struct udevice *dev, uint reg, const uint8_t *buffer, int len);
*
* @dev: PMIC device to read
* @reg: Register to read
- * @return value read on success or negative value of errno.
+ * Return: value read on success or negative value of errno.
*/
int pmic_reg_read(struct udevice *dev, uint reg);
* @dev: PMIC device to write
* @reg: Register to write
* @value: Value to write
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*/
int pmic_reg_write(struct udevice *dev, uint reg, uint value);
* @reg: Register to update
* @clr: Bit mask to clear (set those bits that you want cleared)
* @set: Bit mask to set (set those bits that you want set)
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*/
int pmic_clrsetbits(struct udevice *dev, uint reg, uint clr, uint set);
*
* @dev - pointer to the regulator device
* @modep - pointer to the returned mode info array
- * @return - count of modep entries on success or negative errno if fail.
+ * Return: - count of modep entries on success or negative errno if fail.
*/
int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep);
* regulator_get_value: get microvoltage voltage value of a given regulator
*
* @dev - pointer to the regulator device
- * @return - positive output value [uV] on success or negative errno if fail.
+ * Return: - positive output value [uV] on success or negative errno if fail.
*/
int regulator_get_value(struct udevice *dev);
*
* @dev - pointer to the regulator device
* @uV - the output value to set [micro Volts]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
*/
int regulator_set_value(struct udevice *dev, int uV);
*
* @dev - pointer to the regulator device
* @uV - the output suspend value to set [micro Volts]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
*/
int regulator_set_suspend_value(struct udevice *dev, int uV);
* regulator_get_suspend_value: get the suspend microvoltage value of a given regulator.
*
* @dev - pointer to the regulator device
- * @return - positive output value [uV] on success or negative errno if fail.
+ * Return: - positive output value [uV] on success or negative errno if fail.
*/
int regulator_get_suspend_value(struct udevice *dev);
*
* @dev - pointer to the regulator device
* @uV - the output value to set [micro Volts]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
*/
int regulator_set_value_force(struct udevice *dev, int uV);
* regulator_get_current: get microampere value of a given regulator
*
* @dev - pointer to the regulator device
- * @return - positive output current [uA] on success or negative errno if fail.
+ * Return: - positive output current [uA] on success or negative errno if fail.
*/
int regulator_get_current(struct udevice *dev);
*
* @dev - pointer to the regulator device
* @uA - set the output current [micro Amps]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
*/
int regulator_set_current(struct udevice *dev, int uA);
* regulator_get_enable: get regulator device enable state.
*
* @dev - pointer to the regulator device
- * @return - true/false of enable state or -errno val if fails
+ * Return: - true/false of enable state or -errno val if fails
*/
int regulator_get_enable(struct udevice *dev);
*
* @dev - pointer to the regulator device
* @enable - set true or false
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
*/
int regulator_set_enable(struct udevice *dev, bool enable);
*
* @dev - pointer to the regulator device
* @enable - set true or false
- * @return - 0 on success or if enabling is not supported
+ * Return: - 0 on success or if enabling is not supported
* -errno val if fails.
*/
int regulator_set_enable_if_allowed(struct udevice *dev, bool enable);
*
* @dev - pointer to the regulator device
* @enable - set true or false
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
*/
int regulator_set_suspend_enable(struct udevice *dev, bool enable);
* regulator_get_suspend_enable: get regulator suspend enable state
*
* @dev - pointer to the regulator device
- * @return - true/false of enable state or -errno val if fails
+ * Return: - true/false of enable state or -errno val if fails
*/
int regulator_get_suspend_enable(struct udevice *dev);
* regulator_get_mode: get active operation mode id of a given regulator
*
* @dev - pointer to the regulator device
- * @return - positive mode 'id' number on success or -errno val if fails
+ * Return: - positive mode 'id' number on success or -errno val if fails
* Note:
* The device can provide an array of operating modes, which is type of struct
* dm_regulator_mode. Each mode has it's own 'id', which should be unique inside
*
* @dev - pointer to the regulator device
* @mode_id - mode id to set ('id' field of struct type dm_regulator_mode)
- * @return - 0 on success or -errno value if fails
+ * Return: - 0 on success or -errno value if fails
* Note:
* The device can provide an array of operating modes, which is type of struct
* dm_regulator_mode. Each mode has it's own 'id', which should be unique inside
* @list_devp - an array of returned pointers to the successfully setup
* regulator devices if non-NULL passed
* @verbose - (true/false) print each regulator setup info, or be quiet
- * @return 0 on successfully setup of all list entries, otherwise first error.
+ * Return: 0 on successfully setup of all list entries, otherwise first error.
*
* The returned 'regulator' devices can be used with:
* - regulator_get/set_*
*
* @devname - expected string for 'dev->name' of regulator device
* @devp - returned pointer to the regulator device
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*
* The returned 'regulator' device is probed and can be used with:
* - regulator_get/set_*
*
* @platname - expected string for uc_pdata->name of regulator uclass plat
* @devp - returns pointer to the regulator device or NULL on error
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*
* The returned 'regulator' device is probed and can be used with:
* - regulator_get/set_*
* @dev - device with supply phandle
* @supply_name - phandle name of regulator
* @devp - returned pointer to the supply device
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*/
int device_get_supply_regulator(struct udevice *dev, const char *supply_name,
struct udevice **devp);
* @channel: PWM channel to update
* @period_ns: PWM period in nanoseconds
* @duty_ns: PWM duty period in nanoseconds
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pwm_set_config(struct udevice *dev, uint channel, uint period_ns,
uint duty_ns);
* @dev: PWM device to update
* @channel: PWM channel to update
* @enable: true to enable, false to disable
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pwm_set_enable(struct udevice *dev, uint channel, bool enable);
* @dev: PWM device to update
* @channel: PWM channel to update
* @polarity: true to invert, false to keep normal polarity
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int pwm_set_invert(struct udevice *dev, uint channel, bool polarity);
* @allow_abs_path: true to allow absolute paths
* @bootfile: Bootfile whose directory loaded files are relative to, NULL if
* none
- * @return 0 if OK, -ENOMEM if out of memory, -E2BIG if bootfile is larger than
+ * Return: 0 if OK, -ENOMEM if out of memory, -E2BIG if bootfile is larger than
* MAX_TFTP_PATH_LEN bytes
*/
int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp,
* pxe_get_file_size() - Read the value of the 'filesize' environment variable
*
* @sizep: Place to put the value
- * @return 0 if OK, -ENOENT if no such variable, -EINVAL if format is invalid
+ * Return: 0 if OK, -ENOENT if no such variable, -EINVAL if format is invalid
*/
int pxe_get_file_size(ulong *sizep);
*
* @dev: Device to check (UCLASS_RAM)
* @info: Returns RAM info
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ram_get_info(struct udevice *dev, struct ram_info *info);
* dm_reboot_mode_update() - Update the reboot mode env variable.
*
* @dev: Device to read from
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_reboot_mode_update(struct udevice *dev);
/**
* copy_uboot_to_ram() - Copy U-Boot to its new relocated position
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int copy_uboot_to_ram(void);
*
* This clears the memory used by global variables
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int clear_bss(void);
* This processes the relocation tables to ensure that the code can run in its
* new location.
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int do_elf_reloc_fixups(void);
* which need to manually relocate some things.
*
* @ptr: Pointer to relocate
- * @return new pointer value
+ * Return: new pointer value
*/
static inline void *manual_reloc(void *ptr)
{
#if CONFIG_IS_ENABLED(REMOTEPROC)
/**
* rproc_init() - Initialize all bound remote proc devices
- * @return 0 if all ok, else appropriate error value.
+ * Return: 0 if all ok, else appropriate error value.
*/
int rproc_init(void);
/**
* rproc_dev_init() - Initialize a remote proc device based on id
* @id: id of the remote processor
- * @return 0 if all ok, else appropriate error value.
+ * Return: 0 if all ok, else appropriate error value.
*/
int rproc_dev_init(int id);
/**
* rproc_is_initialized() - check to see if remoteproc devices are initialized
- * @return true if all devices are initialized, false otherwise.
+ * Return: true if all devices are initialized, false otherwise.
*/
bool rproc_is_initialized(void);
* @id: id of the remote processor
* @addr: address in memory where the image is located
* @size: size of the image
- * @return 0 if all ok, else appropriate error value.
+ * Return: 0 if all ok, else appropriate error value.
*/
int rproc_load(int id, ulong addr, ulong size);
/**
* rproc_start() - Start a remote processor
* @id: id of the remote processor
- * @return 0 if all ok, else appropriate error value.
+ * Return: 0 if all ok, else appropriate error value.
*/
int rproc_start(int id);
/**
* rproc_stop() - Stop a remote processor
* @id: id of the remote processor
- * @return 0 if all ok, else appropriate error value.
+ * Return: 0 if all ok, else appropriate error value.
*/
int rproc_stop(int id);
/**
* rproc_reset() - reset a remote processor
* @id: id of the remote processor
- * @return 0 if all ok, else appropriate error value.
+ * Return: 0 if all ok, else appropriate error value.
*/
int rproc_reset(int id);
/**
* rproc_ping() - ping a remote processor to check if it can communicate
* @id: id of the remote processor
- * @return 0 if all ok, else appropriate error value.
+ * Return: 0 if all ok, else appropriate error value.
*
* NOTE: this might need communication path available, which is not implemented
* as part of remoteproc framework - hook on to appropriate bus architecture to
/**
* rproc_is_running() - check to see if remote processor is running
* @id: id of the remote processor
- * @return 0 if running, 1 if not running, -ve on error.
+ * Return: 0 if running, 1 if not running, -ve on error.
*
* NOTE: this may not involve actual communication capability of the remote
* processor, but just ensures that it is out of reset and executing code.
*
* @addr: address of the image to verify
* @size: size of the image
- * @return 0 if the image looks good, else appropriate error value.
+ * Return: 0 if the image looks good, else appropriate error value.
*/
int rproc_elf32_sanity_check(ulong addr, ulong size);
*
* @addr: address of the image to verify
* @size: size of the image
- * @return 0 if the image looks good, else appropriate error value.
+ * Return: 0 if the image looks good, else appropriate error value.
*/
int rproc_elf64_sanity_check(ulong addr, ulong size);
* @dev: device loading the ELF32 image
* @addr: valid ELF32 image address
* @size: size of the image
- * @return 0 if the image is successfully loaded, else appropriate error value.
+ * Return: 0 if the image is successfully loaded, else appropriate error value.
*/
int rproc_elf32_load_image(struct udevice *dev, unsigned long addr, ulong size);
* @dev: device loading the ELF64 image
* @addr: valid ELF64 image address
* @size: size of the image
- * @return 0 if the image is successfully loaded, else appropriate error value.
+ * Return: 0 if the image is successfully loaded, else appropriate error value.
*/
int rproc_elf64_load_image(struct udevice *dev, ulong addr, ulong size);
* @size: size of the image
*
* Auto detects if the image is ELF32 or ELF64 image and load accordingly.
- * @return 0 if the image is successfully loaded, else appropriate error value.
+ * Return: 0 if the image is successfully loaded, else appropriate error value.
*/
int rproc_elf_load_image(struct udevice *dev, unsigned long addr, ulong size);
* @rsc_size: pointer to the found resource table size. Updated on operation
* success
*
- * @return 0 if a valid resource table is successfully loaded, -ENODATA if there
+ * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there
* is no resource table (which is optional), or another appropriate error value.
*/
int rproc_elf32_load_rsc_table(struct udevice *dev, ulong fw_addr,
* @rsc_size: pointer to the found resource table size. Updated on operation
* success
*
- * @return 0 if a valid resource table is successfully loaded, -ENODATA if there
+ * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there
* is no resource table (which is optional), or another appropriate error value.
*/
int rproc_elf64_load_rsc_table(struct udevice *dev, ulong fw_addr,
* @rsc_size: pointer to the found resource table size. Updated on operation
* success
*
- * @return 0 if a valid resource table is successfully loaded, -ENODATA if there
+ * Return: 0 if a valid resource table is successfully loaded, -ENODATA if there
* is no resource table (which is optional), or another appropriate error value.
*/
int rproc_elf_load_rsc_table(struct udevice *dev, ulong fw_addr,
* @index: The index of the reset signal to request, within the client's
* list of reset signals.
* @reset_ctl A pointer to a reset control struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_get_by_index(struct udevice *dev, int index,
struct reset_ctl *reset_ctl);
* @index: The index of the reset signal to request, within the client's
* list of reset signals.
* @reset_ctl A pointer to a reset control struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_get_by_index_nodev(ofnode node, int index,
struct reset_ctl *reset_ctl);
*
* @dev: The client device.
* @bulk A pointer to a reset control bulk struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk);
* @name: The name of the reset signal to request, within the client's
* list of reset signals.
* @reset_ctl: A pointer to a reset control struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_get_by_name(struct udevice *dev, const char *name,
struct reset_ctl *reset_ctl);
*
* @reset_ctl: A reset control struct.
*
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_request(struct reset_ctl *reset_ctl);
*
* @reset_ctl: A reset control struct that was previously successfully
* requested by reset_get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_free(struct reset_ctl *reset_ctl);
*
* @reset_ctl: A reset control struct that was previously successfully
* requested by reset_get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_assert(struct reset_ctl *reset_ctl);
*
* @bulk: A reset control bulk struct that was previously successfully
* requested by reset_get_bulk().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_assert_bulk(struct reset_ctl_bulk *bulk);
*
* @reset_ctl: A reset control struct that was previously successfully
* requested by reset_get_by_*().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_deassert(struct reset_ctl *reset_ctl);
*
* @bulk: A reset control bulk struct that was previously successfully
* requested by reset_get_bulk().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_deassert_bulk(struct reset_ctl_bulk *bulk);
* rst_status - Check reset signal status.
*
* @reset_ctl: The reset signal to check.
- * @return 0 if deasserted, positive if asserted, or a negative
+ * Return: 0 if deasserted, positive if asserted, or a negative
* error code.
*/
int reset_status(struct reset_ctl *reset_ctl);
* @reset_ctl: A reset struct array that was previously successfully
* requested by reset_get_by_*().
* @count Number of reset contained in the array
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
int reset_release_all(struct reset_ctl *reset_ctl, int count);
*
* @bulk: A reset control bulk struct that was previously successfully
* requested by reset_get_bulk().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
static inline int reset_release_bulk(struct reset_ctl_bulk *bulk)
{
* reset_valid() - check if reset is valid
*
* @reset_ctl: the reset to check
- * @return TRUE if valid, or FALSE
+ * Return: TRUE if valid, or FALSE
*/
static inline bool reset_valid(struct reset_ctl *reset_ctl)
{
* @dev: Device to write to
* @reg: Register to write
* @value: Value to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int (*write8)(struct udevice *dev, unsigned int reg, int val);
};
*
* @dev: Device to read from
* @time: Place to put the current time
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_rtc_get(struct udevice *dev, struct rtc_time *time);
*
* @dev: Device to read from
* @time: Time to write into the RTC
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_rtc_set(struct udevice *dev, struct rtc_time *time);
* the caller.
*
* @dev: Device to read from
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_rtc_reset(struct udevice *dev);
* @reg: First register to read
* @buf: Output buffer
* @len: Number of registers to read
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_rtc_read(struct udevice *dev, unsigned int reg, u8 *buf, unsigned int len);
* @reg: First register to write
* @buf: Input buffer
* @len: Number of registers to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dm_rtc_write(struct udevice *dev, unsigned int reg,
const u8 *buf, unsigned int len);
*
* @dev: Device to read from
* @reg: Register to read
- * @return value read, or -ve on error
+ * Return: value read, or -ve on error
*/
int rtc_read8(struct udevice *dev, unsigned int reg);
* @dev: Device to write to
* @reg: Register to write
* @value: Value to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int rtc_write8(struct udevice *dev, unsigned int reg, int val);
* @dev: Device to read from
* @reg: Offset to start reading from
* @valuep: Place to put the value that is read
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int rtc_read16(struct udevice *dev, unsigned int reg, u16 *valuep);
* @dev: Device to write to
* @reg: Register to start writing to
* @value: Value to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int rtc_write16(struct udevice *dev, unsigned int reg, u16 value);
* @dev: Device to read from
* @reg: Offset to start reading from
* @valuep: Place to put the value that is read
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int rtc_read32(struct udevice *dev, unsigned int reg, u32 *valuep);
* @dev: Device to write to
* @reg: Register to start writing to
* @value: Value to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int rtc_write32(struct udevice *dev, unsigned int reg, u32 value);
* rtc_read8() - Read an 8-bit register
*
* @reg: Register to read
- * @return value read
+ * Return: value read
*/
int rtc_read8(int reg);
* rtc_read32() - Read a 32-bit value from the RTC
*
* @reg: Offset to start reading from
- * @return value read
+ * Return: value read
*/
u32 rtc_read32(int reg);
* is_leap_year - Check if year is a leap year
*
* @year Year
- * @return 1 if leap year
+ * Return: 1 if leap year
*/
static inline bool is_leap_year(unsigned int year)
{
* It sets time->tm_wdaay to the correct day of the week.
*
* @time: Time to inspect. tm_wday is updated
- * @return 0 if OK, -EINVAL if the weekday could not be determined
+ * Return: 0 if OK, -EINVAL if the weekday could not be determined
*/
int rtc_calc_weekday(struct rtc_time *time);
* Note that tm_wday and tm_yday are ignored.
*
* @time: Broken-out time to convert
- * @return corresponding time_t value, seconds since 1970-01-01 00:00:00
+ * Return: corresponding time_t value, seconds since 1970-01-01 00:00:00
*/
unsigned long rtc_mktime(const struct rtc_time *time);
*
* @dev: SCMI agent device
* @msg: Message structure reference
- * @return 0 on success and a negative errno on failure
+ * Return: 0 on success and a negative errno on failure
*/
int devm_scmi_process_msg(struct udevice *dev, struct scmi_msg *msg);
* scmi_to_linux_errno() - Convert an SCMI error code into a Linux errno code
*
* @scmi_errno: SCMI error code value
- * @return 0 for successful status and a negative errno otherwise
+ * Return: 0 for successful status and a negative errno otherwise
*/
int scmi_to_linux_errno(s32 scmi_errno);
*
* @dev: SCSI bus
* @cmd: Command to execute
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int scsi_exec(struct udevice *dev, struct scsi_cmd *cmd);
* scsi_bus_reset() - reset the bus
*
* @dev: SCSI bus to reset
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int scsi_bus_reset(struct udevice *dev);
* @cfg: Empty configuration structure (generally &plat->cfg). This is
* normally all zeroes at this point. The only purpose of passing
* this in is to set mmc->cfg to it.
- * @return 0 if OK, -ve if the block device could not be created
+ * Return: 0 if OK, -ve if the block device could not be created
*/
int sdhci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg);
#else
* @host: SDHCI host structure
* @f_max: Maximum supported clock frequency in HZ (0 for default)
* @f_min: Minimum supported clock frequency in HZ (0 for default)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int add_sdhci(struct sdhci_host *host, u32 f_max, u32 f_min);
#endif /* !CONFIG_BLK */
* @key: Name of entry to delete
* @htab: Hash table
* @flag: Flags to use (H_...)
- * @return 0 on success, -ENOENT if not found, -EPERM if the hash table callback
+ * Return: 0 on success, -ENOENT if not found, -EPERM if the hash table callback
* rejected changing the variable, -EINVAL if the hash table refused to
* delete the variable
*/
*
* @dev: Device pointer
* @serial_config: Returns config information (see SERIAL_... above)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int serial_getconfig(struct udevice *dev, uint *config);
*
* @dev: Device pointer
* @serial_config: number of bits, parity and number of stopbits to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int serial_setconfig(struct udevice *dev, uint config);
*
* @dev: Device pointer
* @info: struct serial_device_info to fill
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int serial_getinfo(struct udevice *dev, struct serial_device_info *info);
* The total size of the output must be less than CONFIG_SYS_PBSIZE.
*
* @fmt: Printf format string, followed by format arguments
- * @return number of characters written
+ * Return: number of characters written
*/
int serial_printf(const char *fmt, ...)
__attribute__ ((format (__printf__, 1, 2)));
* main loop has started) to update the BIOS version string (SMBIOS table 0).
*
* @version: New version string to use
- * @return 0 if OK, -ENOENT if no version string was previously written,
+ * Return: 0 if OK, -ENOENT if no version string was previously written,
* -ENOSPC if the new string is too large to fit
*/
int smbios_update_version(const char *version);
*
* @smbios_tab: Start of SMBIOS tables
* @version: New version string to use
- * @return 0 if OK, -ENOENT if no version string was previously written,
+ * Return: 0 if OK, -ENOENT if no version string was previously written,
* -ENOSPC if the new string is too large to fit
*/
int smbios_update_version_full(void *smbios_tab, const char *version);
* @host: remote processor id, or -1
* @item: smem item handle
* @size: number of bytes to be allocated
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*
* Allocate space for a given smem item of size @size, given that the item is
* not yet allocated.
* @host: the remote processor, or -1 for all processors.
* @item: smem item handle
* @size: pointer to be filled out with size of the item
- * @return pointer on success, NULL on error
+ * Return: pointer on success, NULL on error
*
* Looks up smem item and returns pointer to it. Size of smem
* item is returned in @size.
* smem_get_free_space() - retrieve amount of free space in a partition
* @host: the remote processor identifying a partition, or -1
* for all processors.
- * @return size in bytes, -ve on error
+ * Return: size in bytes, -ve on error
*
* To be used by smem clients as a quick way to determine if any new
* allocations has been made.
*
* @s1: First string to compare
* @s2: Second string to compare
- * @return comparison value (less than, equal to, or greater than 0)
+ * Return: comparison value (less than, equal to, or greater than 0)
*/
int strcmp_compar(const void *s1, const void *s2);
* @dev: Sound device
* @msecs: Duration of beep in milliseconds
* @frequency_hz: Frequency of the beep in Hertz
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sound_beep(struct udevice *dev, int msecs, int frequency_hz);
*
* @dev: Sound device
* @frequency_hz: Beep frequency in hertz
- * @return if OK, -ve on error
+ * Return: if OK, -ve on error
*/
int sound_start_beep(struct udevice *dev, int frequency_hz);
* This tells the sound hardware to stop a previously started beep.
*
* @dev: Sound device
- * @return if OK, -ve on error
+ * Return: if OK, -ve on error
*/
int sound_stop_beep(struct udevice *dev);
* @cs: Chip select to look for
* @busp: Returns bus device
* @devp: Return slave device
- * @return 0 if found, -ENODEV on error
+ * Return: 0 if found, -ENODEV on error
*/
int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
struct udevice **devp);
* @dev_name: Name of the new device thus created
* @busp: Returns bus device
* @devp: Return slave device
- * @return 0 if found, -ve on error
+ * Return: 0 if found, -ve on error
*/
int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
const char *drv_name, const char *dev_name,
/**
* spi_chip_select() - Get the chip select for a slave
*
- * @return the chip select this slave is attached to
+ * Return: the chip select this slave is attached to
*/
int spi_chip_select(struct udevice *slave);
* @bus: SPI bus to search
* @cs: Chip select to look for
* @devp: Returns the slave device if found
- * @return 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached,
+ * Return: 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached,
* other -ve value on error
*/
int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp);
* @bus: The SPI bus
* @cs: The chip select (0..n-1)
* @info: Returns information about the chip select, if valid
- * @return 0 if OK (and @info is set up), -ENODEV if the chip select
+ * Return: 0 if OK (and @info is set up), -ENODEV if the chip select
* is invalid, other -ve value on error
*/
int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info);
* @bus: SPI bus requesting the emulator
* @slave: SPI slave device requesting the emulator
* @emuip: Returns pointer to emulator
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sandbox_spi_get_emul(struct sandbox_state *state,
struct udevice *bus, struct udevice *slave,
* @map_sizep: Returns size of mapped SPI
* @offsetp: Returns start offset of SPI flash where the map works
* correctly (offsets before this are not visible)
- * @return 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not
+ * Return: 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not
* available
*/
int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep,
* @offset: Offset into device in bytes to read from
* @len: Number of bytes to read
* @buf: Buffer to put the data that is read
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
* @offset: Offset into device in bytes to write to
* @len: Number of bytes to write
* @buf: Buffer containing bytes to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
const void *buf);
* @dev: SPI flash device
* @offset: Offset into device in bytes to start erasing
* @len: Number of bytes to erase
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
* defined.
*
* @dev: SPI flash device
- * @return 0 if no region is write-protected, 1 if a region is
+ * Return: 0 if no region is write-protected, 1 if a region is
* write-protected, -ENOSYS if the driver does not implement this,
* other -ve value on error
*/
* do this, typically with of-platdata
*
* @dev: SPI-flash device to probe
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int spi_flash_std_probe(struct udevice *dev);
* ...
* }
*
- * @return U-Boot phase
+ * Return: U-Boot phase
*/
static inline enum u_boot_phase spl_phase(void)
{
/**
* spl_prev_phase() - Figure out the previous U-Boot phase
*
- * @return the previous phase from this one, e.g. if called in SPL this returns
+ * Return: the previous phase from this one, e.g. if called in SPL this returns
* PHASE_TPL, if TPL is enabled
*/
static inline enum u_boot_phase spl_prev_phase(void)
/**
* spl_next_phase() - Figure out the next U-Boot phase
*
- * @return the next phase from this one, e.g. if called in TPL this returns
+ * Return: the next phase from this one, e.g. if called in TPL this returns
* PHASE_SPL
*/
static inline enum u_boot_phase spl_next_phase(void)
/**
* spl_phase_name() - Get the name of the current phase
*
- * @return phase name
+ * Return: phase name
*/
static inline const char *spl_phase_name(enum u_boot_phase phase)
{
* spl_phase_prefix() - Get the prefix of the current phase
*
* @phase: Phase to look up
- * @return phase prefix ("spl", "tpl", etc.)
+ * Return: phase prefix ("spl", "tpl", etc.)
*/
static inline const char *spl_phase_prefix(enum u_boot_phase phase)
{
* This returns the address that the next stage is linked to run at, i.e.
* CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
*
- * @return text-base address
+ * Return: text-base address
*/
ulong spl_get_image_text_base(void);
*
* @spl_image: Image description to set up
* @header image header to parse
- * @return 0 if a header was correctly parsed, -ve on error
+ * Return: 0 if a header was correctly parsed, -ve on error
*/
int spl_parse_image_header(struct spl_image_info *spl_image,
const struct image_header *header);
* wants to load the kernel or U-Boot. This function should be provided by
* the board.
*
- * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
+ * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started
*/
int spl_start_uboot(void);
* This will normally be true, but if U-Boot jumps to second U-Boot, it will
* be false. This should be implemented by board-specific code.
*
- * @return true if U-Boot booted from SPL, else false
+ * Return: true if U-Boot booted from SPL, else false
*/
bool spl_was_boot_source(void);
* @param usb_index - usb controller number
* @param mmc_dev - mmc device nubmer
*
- * @return 0 on success, otherwise error code
+ * Return: 0 on success, otherwise error code
*/
int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
* @param raw_part Partition to load from (in RAW mode)
* @param raw_sect Sector to load from (in RAW mode)
*
- * @return 0 on success, otherwise error code
+ * Return: 0 on success, otherwise error code
*/
int spl_mmc_load(struct spl_image_info *spl_image,
struct spl_boot_device *bootdev,
* @param raw_part Fat partition to load from
* @param filename Name of file to load
*
- * @return 0 on success, otherwise error code
+ * Return: 0 on success, otherwise error code
*/
int spl_usb_load(struct spl_image_info *spl_image,
struct spl_boot_device *bootdev,
* @regs: Pointer to GPIO registers
* @gpio: GPIO to adjust (SoC-specific)
* @pull: Pull value (SoC-specific)
- * @return return 0 if OK, -ve on error
+ * Return: return 0 if OK, -ve on error
*/
int spl_gpio_set_pull(void *regs, uint gpio, int pull);
* @regs: Pointer to GPIO registers
* @gpio: GPIO to adjust (SoC-specific)
* @value: 0 to set the output low, 1 to set it high
- * @return return 0 if OK, -ve on error
+ * Return: return 0 if OK, -ve on error
*/
int spl_gpio_output(void *regs, uint gpio, int value);
*
* @regs: Pointer to GPIO registers
* @gpio: GPIO to adjust (SoC-specific)
- * @return return 0 if OK, -ve on error
+ * Return: return 0 if OK, -ve on error
*/
int spl_gpio_input(void *regs, uint gpio);
* @usid SlaveID
* @pid Peripheral ID
* @reg: Register to read
- * @return value read on success or negative value of errno.
+ * Return: value read on success or negative value of errno.
*/
int spmi_reg_read(struct udevice *dev, int usid, int pid, int reg);
* @pid Peripheral ID
* @reg: Register to write
* @value: Value to write
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
*/
int spmi_reg_write(struct udevice *dev, int usid, int pid, int reg,
uint8_t value);
*
* @dev: Device to check (UCLASS_SCON)
* @info: Returns regmap for the device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
struct regmap *syscon_get_regmap(struct udevice *dev);
*
* @driver_data: Driver data value to look up
* @devp: Returns the controller correponding to @driver_data
- * @return 0 on success, -ENODEV if the ID was not found, or other -ve error
+ * Return: 0 on success, -ENODEV if the ID was not found, or other -ve error
* code
*/
int syscon_get_by_driver_data(ulong driver_data, struct udevice **devp);
* are in use. This function looks up the regmap given this driver data.
*
* @driver_data: Driver data value to look up
- * @return register map correponding to @driver_data, or -ve error code
+ * Return: register map correponding to @driver_data, or -ve error code
*/
struct regmap *syscon_get_regmap_by_driver_data(ulong driver_data);
*
* @dev: Device using the system controller
* @name: Name of property referring to the system controller
- * @return A pointer to the regmap if found, ERR_PTR(-ve) on error
+ * Return: A pointer to the regmap if found, ERR_PTR(-ve) on error
*/
struct regmap *syscon_regmap_lookup_by_phandle(struct udevice *dev,
const char *name);
* syscon_get_first_range() - get the first memory range from a syscon regmap
*
* @driver_data: Driver data value to look up
- * @return first region of register map correponding to @driver_data, or
+ * Return: first region of register map correponding to @driver_data, or
* -ve error code
*/
void *syscon_get_first_range(ulong driver_data);
* @argc: Argument count provided. Must be >= 1. If this is 1 then all
* tests are run, otherwise only the one named @argv[1] is run.
* @argv: Arguments: argv[1] is the test to run (if @argc >= 2)
- * @return 0 if OK, CMD_RET_FAILURE on failure
+ * Return: 0 if OK, CMD_RET_FAILURE on failure
*/
int cmd_ut_category(const char *name, const char *prefix,
struct unit_test *tests, int n_ents,
*
* @uts: Test state
* @fmt: printf() format string for the error, followed by args
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
*/
int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...)
__attribute__ ((format (__printf__, 2, 3)));
*
* @uts: Test state
* @fmt: printf() format string for the error, followed by args
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
*/
int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...)
__attribute__ ((format (__printf__, 2, 3)));
* ut_check_skipline() - Check that the next console line exists and skip it
*
* @uts: Test state
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
*/
int ut_check_skipline(struct unit_test_state *uts);
*
* @uts: Test state
* @fmt: printf() format string to look for, followed by args
- * @return 0 if OK, -ENOENT if not found, other value on error
+ * Return: 0 if OK, -ENOENT if not found, other value on error
*/
int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...);
* from the console
*
* @uts: Test state
- * @return 0 if OK (console has no output), other value on error
+ * Return: 0 if OK (console has no output), other value on error
*/
int ut_check_console_end(struct unit_test_state *uts);
* This only supports a byte dump.
*
* @total_bytes: Size of the expected dump in bytes`
- * @return 0 if OK (looks like a dump and the length matches), other value on
+ * Return: 0 if OK (looks like a dump and the length matches), other value on
* error
*/
int ut_check_console_dump(struct unit_test_state *uts, int total_bytes);
/**
* ut_check_free() - Return the number of bytes free in the malloc() pool
*
- * @return bytes free
+ * Return: bytes free
*/
ulong ut_check_free(void);
* ut_check_delta() - Return the number of bytes allocated/freed
*
* @last: Last value from ut_check_free
- * @return free memory delta from @last; positive means more memory has been
+ * Return: free memory delta from @last; positive means more memory has been
* allocated, negative means less has been allocated (i.e. some is freed)
*/
long ut_check_delta(ulong last);
/**
* test_get_state() - Get the active test state
*
- * @return the currently active test state, or NULL if none
+ * Return: the currently active test state, or NULL if none
*/
struct unit_test_state *test_get_state(void);
* @count: Number of tests to run
* @select_name: Name of a single test to run (from the list provided). If NULL
* then all tests are run
- * @return 0 if all tests passed, -1 if any failed
+ * Return: 0 if all tests passed, -1 if any failed
*/
int ut_run_list(const char *name, const char *prefix, struct unit_test *tests,
int count, const char *select_name);
* delays of over an hour. For 64-bit machines it uses a 64-bit value.
*
*@base: Base time to consider
- *@return elapsed time since @base
+ *Return: elapsed time since @base
*/
unsigned long get_timer_us_long(unsigned long base);
* usec2ticks() - Convert microseconds to internal ticks
*
* @usec: Value of microseconds to convert
- * @return Corresponding internal ticks value, calculated using get_tbclk()
+ * Return: Corresponding internal ticks value, calculated using get_tbclk()
*/
ulong usec2ticks(unsigned long usec);
* ticks2usec() - Convert internal ticks to microseconds
*
* @ticks: Value of ticks to convert
- * @return Corresponding microseconds value, calculated using get_tbclk()
+ * Return: Corresponding microseconds value, calculated using get_tbclk()
*/
ulong ticks2usec(unsigned long ticks);
/**
* timer_get_us() - Get monotonic microsecond timer
*
- * @return value of monotonic microsecond timer
+ * Return: value of monotonic microsecond timer
*/
unsigned long timer_get_us(void);
* This is an internal value used by the timer on the system. Ticks increase
* monotonically at the rate given by get_tbclk().
*
- * @return current tick value
+ * Return: current tick value
*/
uint64_t get_ticks(void);
* Monitors status of the TMU device and exynos temperature
*
* @param temp pointer to the current temperature value
- * @return enum tmu_status_t value, code indicating event to execute
+ * Return: enum tmu_status_t value, code indicating event to execute
* and -1 on error
*/
enum tmu_status_t tmu_monitor(int *temp);
* Initialize TMU device
*
* @param blob FDT blob
- * @return int value, 0 for success
+ * Return: int value, 0 for success
*/
int tmu_init(const void *blob);
#endif /* _THERMAL_H_ */
* tpm_clear_and_reenable() - Force clear the TPM and reenable it
*
* @dev: TPM device
- * @return 0 on success, -ve on failure
+ * Return: 0 on success, -ve on failure
*/
u32 tpm_clear_and_reenable(struct udevice *dev);
* @dev: Device to check
* @buf: Buffer to put the string
* @size: Maximum size of buffer
- * @return length of string, or -ENOSPC it no space
+ * Return: length of string, or -ENOSPC it no space
*/
int tpm_get_desc(struct udevice *dev, char *buf, int size);
* Initialize TPM device. It must be called before any TPM commands.
*
* @dev - TPM device
- * @return 0 on success, non-0 on error.
+ * Return: 0 on success, non-0 on error.
*/
int tpm_init(struct udevice *dev);
/**
* Retrieve the array containing all the v1 (resp. v2) commands.
*
- * @return a struct cmd_tbl array.
+ * Return: a struct cmd_tbl array.
*/
#if defined(CONFIG_TPM_V1)
struct cmd_tbl *get_tpm1_commands(unsigned int *size);
* it supports.
*
* @dev: TPM device
- * @return version number (TPM_V1 or TPMV2)
+ * Return: version number (TPM_V1 or TPMV2)
*/
enum tpm_version tpm_get_version(struct udevice *dev);
*
* @param dev TPM device
* @param mode TPM startup mode
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_startup(struct udevice *dev, enum tpm_startup_type mode);
* Issue a TPM_SelfTestFull command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_self_test_full(struct udevice *dev);
* Issue a TPM_ContinueSelfTest command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_continue_self_test(struct udevice *dev);
* @param index index of the area
* @param perm TPM_NV_ATTRIBUTES of the area
* @param size size of the area
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size);
* @param index index of the area
* @param data output buffer of the area contents
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count);
* @param index index of the area
* @param data input buffer to be wrote to the area
* @param length length of data bytes of input buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_nv_write_value(struct udevice *dev, u32 index, const void *data,
u32 length);
* recorded
* @param out_digest 160-bit PCR value after execution of the
* command
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_extend(struct udevice *dev, u32 index, const void *in_digest,
void *out_digest);
* @param index index of the PCR
* @param data output buffer for contents of the named PCR
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_pcr_read(struct udevice *dev, u32 index, void *data, size_t count);
*
* @param dev TPM device
* @param presence TPM physical presence flag
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_tsc_physical_presence(struct udevice *dev, u16 presence);
* @param dev TPM device
* @param data output buffer for the public endorsement key
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_read_pubek(struct udevice *dev, void *data, size_t count);
* Issue a TPM_ForceClear command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_force_clear(struct udevice *dev);
* Issue a TPM_PhysicalEnable command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_physical_enable(struct udevice *dev);
* Issue a TPM_PhysicalDisable command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_physical_disable(struct udevice *dev);
*
* @param dev TPM device
* @param state boolean state of the deactivated flag
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_physical_set_deactivated(struct udevice *dev, u8 state);
* limited to be 4-byte wide
* @param cap output buffer for capability information
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap,
void *cap, size_t count);
*
* @param dev TPM device
* @param auth_handle handle of the auth session
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_terminate_auth_session(struct udevice *dev, u32 auth_handle);
*
* @param dev TPM device
* @param auth_handle pointer to the (new) auth handle or NULL.
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_oiap(struct udevice *dev, u32 *auth_handle);
* Ends an active OIAP session.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_end_oiap(struct udevice *dev);
* @param key_length size of the key structure
* @param parent_key_usage_auth usage auth for the parent key
* @param key_handle pointer to the key handle
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key,
size_t key_length, const void *parent_key_usage_auth,
* @param pubkey_len pointer to the pub key buffer len. On entry: the size of
* the provided pubkey buffer. On successful exit: the size
* of the stored TPM_PUBKEY structure (iff pubkey != NULL).
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_get_pub_key_oiap(struct udevice *dev, u32 key_handle,
const void *usage_auth, void *pubkey,
*
* @param dev TPM device
* @param pflags Place to put permanent flags
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_get_permanent_flags(struct udevice *dev,
struct tpm_permanent_flags *pflags);
*
* @param dev TPM device
* @param perm Returns permissions value
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_get_permissions(struct udevice *dev, u32 index, u32 *perm);
* @param dev TPM device
* @param key_handle handle of the resource
* @param resource_type type of the resource
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type);
* @param auth Usage auth of the key to search for
* @param pubkey_digest SHA1 hash of the pub key structure of the key
* @param[out] handle The handle of the key (Non-null iff found)
- * @return 0 if key was found in TPM; != 0 if not.
+ * Return: 0 if key was found in TPM; != 0 if not.
*/
u32 tpm1_find_key_sha1(struct udevice *dev, const u8 auth[20],
const u8 pubkey_digest[20], u32 *handle);
* @param dev TPM device
* @param data output buffer for the random bytes
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm1_get_random(struct udevice *dev, void *data, u32 count);
* tpm_finalise_physical_presence() - Finalise physical presence
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm1_finalise_physical_presence(struct udevice *dev);
* tpm_nv_enable_locking() - lock the non-volatile space
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm1_nv_set_locked(struct udevice *dev);
* tpm_set_global_lock() - set the global lock
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm_set_global_lock(struct udevice *dev);
* tpm_resume() - start up the TPM from resume (after suspend)
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm1_resume(struct udevice *dev);
* @dev TPM device
* @mode TPM startup mode
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_startup(struct udevice *dev, enum tpm2_startup_types mode);
* @dev TPM device
* @full_test Asking to perform all tests or only the untested ones
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_self_test(struct udevice *dev, enum tpm2_yes_no full_test);
* @pw Password
* @pw_sz Length of the password
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw,
const ssize_t pw_sz);
* @nv_attributes TPM_NV_ATTRIBUTES of the area
* @nv_policy policy to use
* @nv_policy_size size of the policy
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm2_nv_define_space(struct udevice *dev, u32 space_index,
size_t space_size, u32 nv_attributes,
* @digest Value representing the event to be recorded
* @digest_len len of the hash
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_pcr_extend(struct udevice *dev, u32 index, u32 algorithm,
const u8 *digest, u32 digest_len);
* @index Index of data to read
* @data Place to put data
* @count Number of bytes of data
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count);
* @index Index of data to write
* @data Data to write
* @count Number of bytes of data
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_nv_write_value(struct udevice *dev, u32 index, const void *data,
u32 count);
* @digest_len len of the data
* @updates Optional out parameter: number of updates for this PCR
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_pcr_read(struct udevice *dev, u32 idx, unsigned int idx_min_sz,
u16 algorithm, void *data, u32 digest_len,
* @buf Output buffer for capability information
* @prop_count Size of output buffer
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_get_capability(struct udevice *dev, u32 capability, u32 property,
void *buf, size_t prop_count);
* @pw Password
* @pw_sz Length of the password
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_dam_reset(struct udevice *dev, const char *pw, const ssize_t pw_sz);
* @recovery_time Time before decrementation of the failure count
* @lockout_recovery Time to wait after a lockout
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_dam_parameters(struct udevice *dev, const char *pw,
const ssize_t pw_sz, unsigned int max_tries,
* @oldpw Old password
* @oldpw_sz Length of the old password
*
- * @return code of the operation
+ * Return: code of the operation
*/
int tpm2_change_auth(struct udevice *dev, u32 handle, const char *newpw,
const ssize_t newpw_sz, const char *oldpw,
* @index Index of the PCR
* @digest New key to access the PCR
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_pcr_setauthpolicy(struct udevice *dev, const char *pw,
const ssize_t pw_sz, u32 index, const char *key);
* @digest New key to access the PCR
* @key_sz Length of the new key
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_pcr_setauthvalue(struct udevice *dev, const char *pw,
const ssize_t pw_sz, u32 index, const char *key,
* @param data output buffer for the random bytes
* @param count size of output buffer
*
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm2_get_random(struct udevice *dev, void *data, u32 count);
*
* @dev TPM device
* @index Index of data to lock
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_write_lock(struct udevice *dev, u32 index);
* before calling the kernel.
*
* @dev TPM device
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_disable_platform_hierarchy(struct udevice *dev);
* @recvbuf: Buffer to save the response to
* @recv_size: Pointer to the size of the response buffer
*
- * @return code of the operation
+ * Return: code of the operation
*/
u32 tpm2_submit_command(struct udevice *dev, const u8 *sendbuf,
u8 *recvbuf, size_t *recv_size);
*
* @param dev TPM device
* @param mode TPM startup mode
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode);
* Issue a TPM_SelfTestFull command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_self_test_full(struct udevice *dev);
* Issue a TPM_ContinueSelfTest command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_continue_self_test(struct udevice *dev);
* @param index index of the area
* @param perm TPM_NV_ATTRIBUTES of the area
* @param size size of the area
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size);
* @param index index of the area
* @param data output buffer of the area contents
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count);
* @param index index of the area
* @param data input buffer to be wrote to the area
* @param length length of data bytes of input buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data,
u32 length);
* recorded
* @param out_digest 160-bit PCR value after execution of the
* command
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_pcr_extend(struct udevice *dev, u32 index, const void *in_digest,
void *out_digest);
* @param index index of the PCR
* @param data output buffer for contents of the named PCR
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count);
*
* @param dev TPM device
* @param presence TPM physical presence flag
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence);
* @param dev TPM device
* @param data output buffer for the public endorsement key
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_read_pubek(struct udevice *dev, void *data, size_t count);
* Issue a TPM_ForceClear command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_force_clear(struct udevice *dev);
* Issue a TPM_PhysicalEnable command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_physical_enable(struct udevice *dev);
* Issue a TPM_PhysicalDisable command.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_physical_disable(struct udevice *dev);
*
* @param dev TPM device
* @param state boolean state of the deactivated flag
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state);
* limited to be 4-byte wide
* @param cap output buffer for capability information
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap,
void *cap, size_t count);
*
* @param dev TPM device
* @param auth_handle handle of the auth session
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle);
*
* @param dev TPM device
* @param auth_handle pointer to the (new) auth handle or NULL.
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_oiap(struct udevice *dev, u32 *auth_handle);
* Ends an active OIAP session.
*
* @param dev TPM device
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_end_oiap(struct udevice *dev);
* @param key_length size of the key structure
* @param parent_key_usage_auth usage auth for the parent key
* @param key_handle pointer to the key handle
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key,
size_t key_length, const void *parent_key_usage_auth,
* @param pubkey_len pointer to the pub key buffer len. On entry: the size of
* the provided pubkey buffer. On successful exit: the size
* of the stored TPM_PUBKEY structure (iff pubkey != NULL).
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_get_pub_key_oiap(struct udevice *dev, u32 key_handle,
const void *usage_auth, void *pubkey,
*
* @param dev TPM device
* @param perm Returns permissions value
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm);
* @param dev TPM device
* @param key_handle handle of the resource
* @param resource_type type of the resource
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type);
* @param auth Usage auth of the key to search for
* @param pubkey_digest SHA1 hash of the pub key structure of the key
* @param[out] handle The handle of the key (Non-null iff found)
- * @return 0 if key was found in TPM; != 0 if not.
+ * Return: 0 if key was found in TPM; != 0 if not.
*/
u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20],
const u8 pubkey_digest[20], u32 *handle);
* @param dev TPM device
* @param data output buffer for the random bytes
* @param count size of output buffer
- * @return return code of the operation
+ * Return: return code of the operation
*/
u32 tpm_get_random(struct udevice *dev, void *data, u32 count);
* tpm_finalise_physical_presence() - Finalise physical presence
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm_finalise_physical_presence(struct udevice *dev);
* tpm_nv_enable_locking() - lock the non-volatile space
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm_nv_enable_locking(struct udevice *dev);
* tpm_set_global_lock() - set the global lock
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm_set_global_lock(struct udevice *dev);
*
* @param dev TPM device
* @param index Index of space to lock
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm_write_lock(struct udevice *dev, u32 index);
* tpm_resume() - start up the TPM from resume (after suspend)
*
* @param dev TPM device
- * @return return code of the operation (0 = success)
+ * Return: return code of the operation (0 = success)
*/
u32 tpm_resume(struct udevice *dev);
* Enable PWM mode for selected SM0-2
*
* @param mask Mask of synchronous converter to enable (TPS6586X_PWM_...)
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int tps6586x_set_pwm_mode(int mask);
* If this condition is not met, no adjustment will be
* done and an error will be reported. Use -1 to skip
* this check.
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int tps6586x_adjust_sm0_sm1(int sm0_target, int sm1_target, int step, int rate,
int min_sm0_over_sm1);
* on the device. This function must be called before using other functions.
*
* @param bus I2C bus containing the TPS6586X chip
- * @return 0 (always succeeds)
+ * Return: 0 (always succeeds)
*/
int tps6586x_init(struct udevice *bus);
* @param buff Buffer in which to place data, or NULL to count size
* @param buff_size Size of buffer
* @param needed Returns number of bytes used / needed
- * @return 0 if ok, -1 on error (buffer exhausted)
+ * Return: 0 if ok, -1 on error (buffer exhausted)
*/
int trace_list_functions(void *buff, size_t buff_size, size_t *needed);
* @crc_start: CRC8 start value
* @vptr: Buffer to checksum
* @len: Length of buffer in bytes
- * @return CRC8 checksum
+ * Return: CRC8 checksum
*/
unsigned int crc8(unsigned int crc_start, const unsigned char *vptr, int len);
* calculation)
* @buf: Bytes to checksum
* @len: Number of bytes to checksum
- * @return checksum value
+ * Return: checksum value
*/
uint32_t crc32(uint32_t crc, const unsigned char *buf, uint len);
* @buf: Bytes to checksum
* @len: Number of bytes to checksum
* @chunk_sz: Chunk size to use between watchdog resets
- * @return checksum
+ * Return: checksum
*/
uint32_t crc32_wd(uint32_t crc, const unsigned char *buf, uint len,
uint chunk_sz);
* calculation)
* @buf: Bytes to checksum
* @len: Number of bytes to checksum
- * @return checksum value
+ * Return: checksum value
*/
uint32_t crc32_no_comp(uint32_t crc, const unsigned char *buf, uint len);
* @data: Data bytes to checksum
* @length: Number of bytes to process
* @crc32c_table:: CRC table
- * @return checksum value
+ * Return: checksum value
*/
uint32_t crc32c_cal(uint32_t crc, const char *data, int length,
uint32_t *crc32c_table);
* @data_len: Data length
* @sig: Signature
* @sig_len: Number of bytes in signature
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
int ecdsa_verify(struct image_sign_info *info,
const struct image_region region[], int region_count,
* @prop_name: What to call the property in the FDT
* @num: pointer to a libcrypto big number
* @num_bits: How big is 'num' in bits?
- * @return 0 if all good all working, -ve on horror
+ * Return: 0 if all good all working, -ve on horror
*/
int fdt_add_bignum(void *blob, int noffset, const char *prop_name,
BIGNUM *num, int num_bits);
* @region_count: Number of regions in the region array
* @checksum: Buffer contanining the output hash
*
- * @return 0 if OK, < 0 if error
+ * Return: 0 if OK, < 0 if error
*/
int hash_calculate(const char *name,
const struct image_region *region, int region_count,
* @srcn: Length of source data
* @dst: Destination for uncompressed data
* @dstn: Returns length of uncompressed data
- * @return 0 if OK, -EPROTONOSUPPORT if the magic number or version number are
+ * Return: 0 if OK, -EPROTONOSUPPORT if the magic number or version number are
* not recognised or independent blocks are used, -EINVAL if the reserved
* fields are non-zero, or input is overrun, -EENOBUFS if the destination
* buffer is overrun, -EEPROTO if the compressed data causes an error in
* @hash: Hash according to algorithm specified in @info
* @sig: Signature
* @sig_len: Number of bytes in signature
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
int rsa_verify_hash(struct image_sign_info *info,
const uint8_t *hash, uint8_t *sig, uint sig_len);
* @data_len: Data length
* @sig: Signature
* @sig_len: Number of bytes in signature
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
int rsa_verify(struct image_sign_info *info,
const struct image_region region[], int region_count,
/**
* ufs_probe() - initialize all devices in the UFS uclass
*
- * @return 0 if Ok, -ve on error
+ * Return: 0 if Ok, -ve on error
*/
int ufs_probe(void);
*
* @index: index in the uclass sequence
*
- * @return 0 if successfully probed, -ve on error
+ * Return: 0 if successfully probed, -ve on error
*/
int ufs_probe_dev(int index);
* @ufs_dev: UFS device
* @scsi_devp: Pointer to scsi device
*
- * @return 0 if Ok, -ve on error
+ * Return: 0 if Ok, -ve on error
*/
int ufs_scsi_bind(struct udevice *ufs_dev, struct udevice **scsi_devp);
#endif
* @do_read: true to read the device descriptor before an address is set
* (should be false for XHCI buses, true otherwise)
* @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB)
- * @return 0 if OK, -ve on error */
+ * Return: 0 if OK, -ve on error */
int usb_setup_device(struct usb_device *dev, bool do_read,
struct usb_device *parent);
* @port: Hub port number (numbered from 1)
* @speed: USB speed to use for this device
* @devp: Returns pointer to device if all is well
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_scan_device(struct udevice *parent, int port,
enum usb_device_speed speed, struct udevice **devp);
* will be a device with uclass UCLASS_USB.
*
* @dev: Device to check
- * @return The bus, or NULL if not found (this indicates a critical error in
+ * Return: The bus, or NULL if not found (this indicates a critical error in
* the USB stack
*/
struct udevice *usb_get_bus(struct udevice *dev);
* @devp: returns a pointer of a new device structure. With driver model this
* is a device pointer, but with legacy USB this pointer is
* driver-specific.
- * @return 0 if OK, -ENOSPC if we have found out of room for new devices
+ * Return: 0 if OK, -ENOSPC if we have found out of room for new devices
*/
int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
* representation of this hub can be updated.
*
* @dev: Hub device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_update_hub_device(struct usb_device *dev);
*
* @dev: USB device
* @size: maximum transfer bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_get_max_xfer_size(struct usb_device *dev, size_t *size);
* @desc_list: List of points or USB descriptors, terminated by NULL.
* The first entry must be struct usb_device_descriptor,
* and others follow on after that.
- * @return 0 if OK, -ENOSYS if not implemented, other -ve on error
+ * Return: 0 if OK, -ENOSYS if not implemented, other -ve on error
*/
int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings,
void **desc_list);
* @emul: Emulator device
* @udev: USB device (which the emulator is causing to appear)
* See struct dm_usb_ops for details on other parameters
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_emul_control(struct udevice *emul, struct usb_device *udev,
unsigned long pipe, void *buffer, int length,
* @emul: Emulator device
* @udev: USB device (which the emulator is causing to appear)
* See struct dm_usb_ops for details on other parameters
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
unsigned long pipe, void *buffer, int length);
* @emul: Emulator device
* @udev: USB device (which the emulator is causing to appear)
* See struct dm_usb_ops for details on other parameters
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_emul_int(struct udevice *emul, struct usb_device *udev,
unsigned long pipe, void *buffer, int length, int interval,
* @pipe: Describes pipe being used, and includes the device number
* @port1: Describes port number on the parent hub
* @emulp: Returns pointer to emulator, or NULL if not found
- * @return 0 if found, -ve on error
+ * Return: 0 if found, -ve on error
*/
int usb_emul_find(struct udevice *bus, ulong pipe, int port1,
struct udevice **emulp);
*
* @dev: USB device to check
* @emulp: Returns pointer to emulator, or NULL if not found
- * @return 0 if found, -ve on error
+ * Return: 0 if found, -ve on error
*/
int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp);
* @ptr: a pointer to a list of USB descriptor pointers
* @type: type of USB descriptor to find
* @index: if @type is USB_DT_CONFIG, this is the configuration value
- * @return a pointer to the USB descriptor found, NULL if not found
+ * Return: a pointer to the USB descriptor found, NULL if not found
*/
struct usb_generic_descriptor **usb_emul_find_descriptor(
struct usb_generic_descriptor **ptr, int type, int index);
* xhci_deregister() - Unregister an XHCI controller
*
* @dev: Controller device
- * @return 0 if registered, -ve on error
+ * Return: 0 if registered, -ve on error
*/
int xhci_deregister(struct udevice *dev);
* @dev: Controller device
* @hccr: Host controller control registers
* @hcor: Not sure what this means
- * @return 0 if registered, -ve on error
+ * Return: 0 if registered, -ve on error
*/
int xhci_register(struct udevice *dev, struct xhci_hccr *hccr,
struct xhci_hcor *hcor);
* @dev: USB device
* @ss: Place to put USB ethernet data
* @rxsize: Maximum size to allocate for the receive buffer
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize);
* usb_ether_deregister() - deregister a USB ethernet device
*
* @ueth: USB Ethernet device
- * @return 0
+ * Return: 0
*/
int usb_ether_deregister(struct ueth_data *ueth);
*
* @ueth: USB Ethernet device
* @rxsize: Maximum size to receive
- * @return 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is
+ * Return: 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is
* larger than the size passed ot usb_ether_register(), other -ve on error
*/
int usb_ether_receive(struct ueth_data *ueth, int rxsize);
* @ueth: USB Ethernet device
* @ptrp: Returns a pointer to the start of the next packet if there is
* one available
- * @return number of bytes available, or 0 if none
+ * Return: number of bytes available, or 0 if none
*/
int usb_ether_get_rx_bytes(struct ueth_data *ueth, uint8_t **ptrp);
*
* @addrp: On entry, the top of available memory. On exit, the new top,
* after allocating the required memory.
- * @return 0
+ * Return: 0
*/
int video_reserve(ulong *addrp);
* video_clear() - Clear a device's frame buffer to background color.
*
* @dev: Device to clear
- * @return 0
+ * Return: 0
*/
int video_clear(struct udevice *dev);
#endif /* CONFIG_DM_VIDEO */
* - if a coordinate is -ve then it will be offset to the
* left/top of the centre by that many pixels
* - if a coordinate is positive it will be used unchnaged.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int video_bmp_display(struct udevice *dev, ulong bmp_image, int x, int y,
bool align);
* video_get_xsize() - Get the width of the display in pixels
*
* @dev: Device to check
- * @return device frame buffer width in pixels
+ * Return: device frame buffer width in pixels
*/
int video_get_xsize(struct udevice *dev);
* video_get_ysize() - Get the height of the display in pixels
*
* @dev: Device to check
- * @return device frame buffer height in pixels
+ * Return: device frame buffer height in pixels
*/
int video_get_ysize(struct udevice *dev);
* @dev: Vidconsole device being updated
* @from: Start/end address within the framebuffer (->fb)
* @to: Other address within the frame buffer
- * @return 0 if OK, -EFAULT if the start address is before the start of the
+ * Return: 0 if OK, -EFAULT if the start address is before the start of the
* frame buffer start
*/
int video_sync_copy(struct udevice *dev, void *from, void *to);
* video_sync_copy_all() - Sync the entire framebuffer to the copy
*
* @dev: Vidconsole device being updated
- * @return 0 (always)
+ * Return: 0 (always)
*/
int video_sync_copy_all(struct udevice *dev);
#else
/**
* video_is_active() - Test if one video device it active
*
- * @return true if at least one video device is active, else false.
+ * Return: true if at least one video device is active, else false.
*/
bool video_is_active(void);
/**
* Get the width of the screen in pixels
*
- * @return width of screen in pixels
+ * Return: width of screen in pixels
*/
int video_get_pixel_width(void);
/**
* Get the height of the screen in pixels
*
- * @return height of screen in pixels
+ * Return: height of screen in pixels
*/
int video_get_pixel_height(void);
/**
* Get the number of text lines/rows on the screen
*
- * @return number of rows
+ * Return: number of rows
*/
int video_get_screen_rows(void);
/**
* Get the number of text columns on the screen
*
- * @return number of columns
+ * Return: number of columns
*/
int video_get_screen_columns(void);
/**
* video_bridge_attach() - attach a video bridge
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int video_bridge_attach(struct udevice *dev);
* video_bridge_set_backlight() - Set the backlight brightness
*
* @percent: brightness percentage (0=off, 100=full brightness)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int video_bridge_set_backlight(struct udevice *dev, int percent);
* check_attached() - check if a bridge is correctly attached
*
* @dev: Device to check
- * @return 0 if attached, -EENOTCONN if not, or other -ve error
+ * Return: 0 if attached, -EENOTCONN if not, or other -ve error
*/
int video_bridge_check_attached(struct udevice *dev);
* @dev: Device to read from
* @buf: Buffer to read into
* @buf_size: Buffer size
- * @return number of bytes read, <=0 for error
+ * Return: number of bytes read, <=0 for error
*/
int video_bridge_read_edid(struct udevice *dev, u8 *buf, int buf_size);
* is the X position multipled by VID_FRAC_DIV.
* @y: Pixel Y position (0=top-most pixel)
* @ch: Character to write
- * @return number of fractional pixels that the cursor should move,
+ * Return: number of fractional pixels that the cursor should move,
* if all is OK, -EAGAIN if we ran out of space on this line, other -ve
* on error
*/
* @rowdst: Destination text row (0=top)
* @rowsrc: Source start text row
* @count: Number of text rows to move
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int vidconsole_move_rows(struct udevice *dev, uint rowdst, uint rowsrc,
uint count);
* @dev: Device to adjust
* @row: Text row to adjust (0=top)
* @clr: Raw colour (pixel value) to write to each pixel
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int vidconsole_set_row(struct udevice *dev, uint row, int clr);
*
* @dev: Device to adjust
* @ch: Character to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int vidconsole_put_char(struct udevice *dev, char ch);
*
* @dev: Device to adjust
* @str: String to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int vidconsole_put_string(struct udevice *dev, const char *str);
* @dev: Device to adjust
* @col: New cursor text column
* @row: New cursor text row
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
void vidconsole_position_cursor(struct udevice *dev, unsigned col,
unsigned row);
*
* @priv private data of the console device
* @idx color index
- * @return color value
+ * Return: color value
*/
u32 vid_console_color(struct video_priv *priv, unsigned int idx);
* @dev: Vidconsole device being updated
* @from: Start/end address within the framebuffer (->fb)
* @to: Other address within the frame buffer
- * @return 0 if OK, -EFAULT if the start address is before the start of the
+ * Return: 0 if OK, -EFAULT if the start address is before the start of the
* frame buffer start
*/
int vidconsole_sync_copy(struct udevice *dev, void *from, void *to);
* @dst: Destination address within the framebuffer (->fb)
* @src: Source address within the framebuffer (->fb)
* @size: Number of bytes to transfer
- * @return 0 if OK, -EFAULT if the start address is before the start of the
+ * Return: 0 if OK, -EFAULT if the start address is before the start of the
* frame buffer start
*/
int vidconsole_memmove(struct udevice *dev, void *dst, const void *src,
* @dev: OSD instance to query.
* @info: Pointer to a structure that takes the information read from the
* OSD instance.
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_get_info(struct udevice *dev, struct video_osd_info *info);
* coordinate on the OSD screen.
* @buflen: Length of the data in the passed buffer (in byte).
* @count: Write count many repetitions of the given text data
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_set_mem(struct udevice *dev, uint col, uint row, u8 *buf,
size_t buflen, uint count);
* @dev: OSD instance to write to.
* @col The number of characters in the window's columns
* @row The number of characters in the window's rows
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_set_size(struct udevice *dev, uint col, uint row);
* interpretation of the value is driver-specific, and possible
* values should be defined e.g. in a driver include file.
* @text: The string data that should be printed on the OSD
- * @return 0 if OK, -ve on error.
+ * Return: 0 if OK, -ve on error.
*/
int video_osd_print(struct udevice *dev, uint col, uint row, ulong color,
char *text);
* @offset: the offset of the configuration field
* @buf: the buffer to write the field value into
* @len: the length of the buffer
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_get_config(struct udevice *vdev, unsigned int offset,
void *buf, unsigned int len);
* @offset: the offset of the configuration field
* @buf: the buffer to read the field value from
* @len: the length of the buffer
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_set_config(struct udevice *vdev, unsigned int offset,
void *buf, unsigned int len);
*
* @vdev: the real virtio device
* @counter: the returned config generation counter
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_generation(struct udevice *vdev, u32 *counter);
*
* @vdev: the real virtio device
* @status: the returned status byte
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_get_status(struct udevice *vdev, u8 *status);
*
* @vdev: the real virtio device
* @status: the new status byte
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_set_status(struct udevice *vdev, u8 status);
* virtio_reset() - reset the device
*
* @vdev: the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_reset(struct udevice *vdev);
*
* @vdev: the real virtio device
* @features: the first 32 feature bits (all we currently need)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_get_features(struct udevice *vdev, u64 *features);
* virtio_set_features() - confirm what device features we'll be using
*
* @vdev: the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_set_features(struct udevice *vdev);
* @vdev: the real virtio device
* @nvqs: the number of virtqueues to find
* @vqs: on success, includes new virtqueues
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_find_vqs(struct udevice *vdev, unsigned int nvqs,
struct virtqueue *vqs[]);
* virtio_del_vqs() - free virtqueues found by find_vqs()
*
* @vdev: the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_del_vqs(struct udevice *vdev);
*
* @vdev: the real virtio device
* @vq: virtqueue to process
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_notify(struct udevice *vdev, struct virtqueue *vq);
* virtio_finalize_features() - helper to finalize features
*
* @vdev: the real virtio device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_finalize_features(struct udevice *vdev);
/**
* virtio_init() - helper to enumerate all known virtio devices
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int virtio_init(void);
* @param cp The string to be converted
* @param endp Updated to point to the first character not converted
* @param base The number base to use (0 for the default)
- * @return value decoded from string (0 if invalid)
+ * Return: value decoded from string (0 if invalid)
*
* Converts a string to an unsigned long. If there are invalid characters at
* the end these are ignored. In the worst case, if all characters are invalid,
*
* @param cp The string to be converted
* @param endp Updated to point to the first character not converted
- * @return value decoded from string (0 if invalid)
+ * Return: value decoded from string (0 if invalid)
*
* Converts a hex string to an unsigned long. If there are invalid characters at
* the end these are ignored. In the worst case, if all characters are invalid,
*
* @param cp The string to be converted
* @param endp Updated to point to the first character not converted
- * @return value decoded from string (0 if invalid)
+ * Return: value decoded from string (0 if invalid)
*
* Converts a decimal string to an unsigned long. If there are invalid
* characters at the end these are ignored. In the worst case, if all characters
* @param cp The string to be converted
* @param base The number base to use (0 for the default)
* @param res The converted result value
- * @return 0 if conversion is successful and *res is set to the converted
+ * Return: 0 if conversion is successful and *res is set to the converted
* value, otherwise it returns -EINVAL and *res is set to 0.
*
* strict_strtoul converts a string to an unsigned long only if the
* For example, "abc123" would return 123.
*
* @str: String to exxamine
- * @return training number if found, else -1
+ * Return: training number if found, else -1
*/
long trailing_strtol(const char *str);
* @str: String to exxamine
* @end: Pointer to end of string to examine, or NULL to use the
* whole string
- * @return training number if found, else -1
+ * Return: training number if found, else -1
*/
long trailing_strtoln(const char *str, const char *end);
* @param buf The buffer to place the result into
* @param fmt The format string to use
* @param args Arguments for the format string
- * @return the number of characters which have been written into
+ * Return: the number of characters which have been written into
* the @buf not including the trailing '\0'.
*
* If you're not already dealing with a va_list consider using scnprintf().
* simple_... functions, so should be used immediately
*
* @val: Value to convert
- * @return string containing the decimal representation of @val
+ * Return: string containing the decimal representation of @val
*/
char *simple_itoa(ulong val);
* simple_... functions, so should be used immediately
*
* @val: Value to convert
- * @return string containing the hexecimal representation of @val
+ * Return: string containing the hexecimal representation of @val
*/
char *simple_xtoa(ulong num);
* @param size The size of the buffer, including the trailing null space
* @param fmt The format string to use
* @param ... Arguments for the format string
- * @return the number of characters which would be
+ * Return: the number of characters which would be
* generated for the given input, excluding the trailing null,
* as per ISO C99. If the return is greater than or equal to
* @size, the resulting string is truncated.
* @param size The size of the buffer, including the trailing null space
* @param fmt The format string to use
* @param args Arguments for the format string
- * @return The number characters which would be generated for the given
+ * Return: The number characters which would be generated for the given
* input, excluding the trailing '\0', as per ISO C99. Note that fewer
* characters may be written if this number of characters is >= size.
*
* @param size The size of the buffer, including the trailing null space
* @param fmt The format string to use
* @param args Arguments for the format string
- * @return the number of characters which have been written into
+ * Return: the number of characters which have been written into
* the @buf not including the trailing '\0'. If @size is == 0 the function
* returns 0.
*
* @param set Selects wait condition (bit set or clear)
* @param timeout_ms Timeout (in milliseconds)
* @param breakable Enables CTRL-C interruption
- * @return 0 on success, -ETIMEDOUT or -EINTR on failure
+ * Return: 0 on success, -ETIMEDOUT or -EINTR on failure
*/
#define BUILD_WAIT_FOR_BIT(sfx, type, read) \
*
* @dev: WDT Device
* @flags: Driver specific flags
- * @return 0 if OK -ve on error. If wdt action is system reset,
+ * Return: 0 if OK -ve on error. If wdt action is system reset,
* this function may never return.
*/
int wdt_expire_now(struct udevice *dev, ulong flags);
* @buf: Buffer to hold the path
* @buf_len: Length of buffer
* @cur: Current position in the buffer
- * @return new position in buffer after adding @dev, or -ve on error
+ * Return: new position in buffer after adding @dev, or -ve on error
*/
static int acpi_device_path_fill(const struct udevice *dev, char *buf,
size_t buf_len, int cur)
*
* Write a forward length for a large resource (2 bytes)
*
- * @return pointer to the zero word (for fixing up later)
+ * Return: pointer to the zero word (for fixing up later)
*/
static void *largeres_write_len_f(struct acpi_ctx *ctx)
{
* @dev: I2C device to convert
* @i2c: Place to put the new structure
* @scope: Scope of the I2C device (this is the controller path)
- * @return chip address of device
+ * Return: chip address of device
*/
static int acpi_device_set_i2c(const struct udevice *dev, struct acpi_i2c *i2c,
const char *scope)
* @dev: SPI device to convert
* @spi: Place to put the new structure
* @scope: Scope of the SPI device (this is the controller path)
- * @return 0 (always)
+ * Return: 0 (always)
*/
static int acpi_device_set_spi(const struct udevice *dev, struct acpi_spi *spi,
const char *scope)
* depends on whether multiple-images is in use.
*
* @nodep: Returns the node found, on success
- * @return 0 if OK, , -EINVAL if there is no /binman node, -ECHILD if multiple
+ * Return: 0 if OK, , -EINVAL if there is no /binman node, -ECHILD if multiple
* images are being used but the first image is not available
*/
static int find_image_node(ofnode *nodep)
* @device_path: EFI device path structure for this
* @len: Length of @device_path in bytes
* @devp: Returns the bound device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int efi_bind_block(efi_handle_t handle, struct efi_block_io *blkio,
struct efi_device_path *device_path, int len,
* EFI we must first change to 32-bit mode. To do this we need to find the
* correct code segment to use (an entry in the Global Descriptor Table).
*
- * @return code segment GDT offset, or 0 for 32-bit EFI, -ENOENT if not found
+ * Return: code segment GDT offset, or 0 for 32-bit EFI, -ENOENT if not found
*/
static int get_codeseg32(void)
{
/*
* Install the ACPI table as a configuration table.
*
- * @return status code
+ * Return: status code
*/
efi_status_t efi_acpi_register(void)
{
* Determine if an MMC device is an SD card.
*
* @desc block device descriptor
- * @return true if the device is an SD card
+ * Return: true if the device is an SD card
*/
static bool is_sd(struct blk_desc *desc)
{
* Determine the last device path node that is not the end node.
*
* @dp device path
- * @return last node before the end node if it exists
+ * Return: last node before the end node if it exists
* otherwise NULL
*/
const struct efi_device_path *efi_dp_last_node(const struct efi_device_path *dp)
*
* @buf pointer to the end of the device path
* @dev device
- * @return pointer to the end of the device path
+ * Return: pointer to the end of the device path
*/
__maybe_unused static void *dp_fill(void *buf, struct udevice *dev)
{
*
* @s output buffer
* @dp device path node
- * @return next unused buffer address
+ * Return: next unused buffer address
*/
static char *dp_media(char *s, struct efi_device_path *dp)
{
*
* @buffer output buffer
* @dp device path or node
- * @return end of string
+ * Return: end of string
*/
static char *efi_convert_single_device_node_to_text(
char *buffer,
* device_node device node to be converted
* display_only true if the shorter text representation shall be used
* allow_shortcuts true if shortcut forms may be used
- * @return text representation of the device path
+ * Return: text representation of the device path
* NULL if out of memory of device_path is NULL
*/
static uint16_t EFIAPI *efi_convert_device_node_to_text(
* device_path device path to be converted
* display_only true if the shorter text representation shall be used
* allow_shortcuts true if shortcut forms may be used
- * @return text representation of the device path
+ * Return: text representation of the device path
* NULL if out of memory of device_path is NULL
*/
static uint16_t EFIAPI *efi_convert_device_path_to_text(
* for details.
*
* @device_path device path
- * @return size in bytes
+ * Return: size in bytes
*/
static efi_uintn_t EFIAPI get_device_path_size(
const struct efi_device_path *device_path)
* for details.
*
* @device_path device path
- * @return copy of the device path
+ * Return: copy of the device path
*/
static struct efi_device_path * EFIAPI duplicate_device_path(
const struct efi_device_path *device_path)
*
* @src1 1st device path
* @src2 2nd device path
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_path(
const struct efi_device_path *src1,
*
* @device_path device path
* @device_node device node
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_node(
const struct efi_device_path *device_path,
*
* @device_path 1st device path
* @device_path_instance 2nd device path
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_path_instance(
const struct efi_device_path *device_path,
*
* @device_path_instance next device path instance
* @device_path_instance_size size of the device path instance
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI get_next_device_path_instance(
struct efi_device_path **device_path_instance,
*
* @device_path device path
* @device_node device node
- * @return concatenated device path
+ * Return: concatenated device path
*/
static bool EFIAPI is_device_path_multi_instance(
const struct efi_device_path *device_path)
* @node_type node type
* @node_sub_type node sub type
* @node_length node length
- * @return device path node
+ * Return: device path node
*/
static struct efi_device_path * EFIAPI create_device_node(
uint8_t node_type, uint8_t node_sub_type, uint16_t node_length)
* @memory_type usage type of the allocated memory
* @pages number of pages to be allocated
* @memory allocated memory
- * @return status code
+ * Return: status code
*/
efi_status_t efi_allocate_pages(enum efi_allocate_type type,
enum efi_memory_type memory_type,
* @map_key key for the memory map
* @descriptor_size size of an individual memory descriptor
* @descriptor_version version number of the memory descriptor structure
- * @return status code
+ * Return: status code
*/
efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
struct efi_mem_desc *memory_map,
/*
* Install the SMBIOS table as a configuration table.
*
- * @return status code
+ * Return: status code
*/
efi_status_t efi_smbios_register(void)
{
* Convert FDT value to host endianness.
*
* @val FDT value
- * @return converted value
+ * Return: converted value
*/
static u32 f2h(fdt32_t val)
{
*
* @test the test to be executed
* @failures counter that will be incremented if a failure occurs
- * @return EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(struct efi_unit_test *test, unsigned int *failures)
{
*
* @test the test to be executed
* @failures counter that will be incremented if a failure occurs
- * @return EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(struct efi_unit_test *test, unsigned int *failures)
{
*
* @test the test to be torn down
* @failures counter that will be incremented if a failure occurs
- * @return EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(struct efi_unit_test *test, unsigned int *failures)
{
* Reset service of the block IO protocol.
*
* @this block IO protocol
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI reset(
struct efi_block_io *this,
* @lba start of the read in logical blocks
* @buffer_size number of bytes to read
* @buffer target buffer
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI read_blocks(
struct efi_block_io *this, u32 media_id, u64 lba,
* @lba start of the write in logical blocks
* @buffer_size number of bytes to read
* @buffer source buffer
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI write_blocks(
struct efi_block_io *this, u32 media_id, u64 lba,
* Flush service of the block IO protocol.
*
* @this block IO protocol
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI flush_blocks(struct efi_block_io *this)
{
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
* Get length of device path without end tag.
*
* @dp device path
- * @return length of device path in bytes
+ * Return: length of device path in bytes
*/
static efi_uintn_t dp_size(struct efi_device_path *dp)
{
* @handle handle on which child controllers are installed
* @protocol protocol for which the child controllers were installed
* @count number of child controllers
- * @return status code
+ * Return: status code
*/
static efi_status_t count_child_controllers(efi_handle_t handle,
efi_guid_t *protocol,
* @this driver binding protocol
* @controller_handle handle of the controller
* @remaining_device_path path specifying the child controller
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI supported(
struct efi_driver_binding_protocol *this,
* @this driver binding protocol
* @controller_handle handle of the controller
* @remaining_device_path path specifying the child controller
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI start(
struct efi_driver_binding_protocol *this,
*
* @controller_handle parent controller
* @child_handle child controller
- * @return status code
+ * Return: status code
*/
static efi_status_t disconnect_child(efi_handle_t controller_handle,
efi_handle_t child_handle)
* @controller_handle handle of the controller
* @number_of_children number of child controllers to remove
* @child_handle_buffer handles of the child controllers to remove
- * @return status code
+ * Return: status code
*/
static efi_status_t EFIAPI stop(
struct efi_driver_binding_protocol *this,
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
*
* @property name of the property
* @node name of the node or NULL for root node
- * @return value of the property
+ * Return: value of the property
*/
static char *get_property(const u16 *property, const u16 *node)
{
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
*
* @handle handle of the loaded image
* @systable system table
- * @return status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t handle,
struct efi_system_table *systable)
*
* @handle handle of the loaded image
* @systable system table
- * @return status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t handle,
struct efi_system_table *systable)
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
* Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
* efi_status_t decompress() - Decompress the disk image.
*
* @image decompressed disk image
- * @return status code
+ * Return: status code
*/
static efi_status_t decompress(u8 **image)
{
* Preexisting variable values are saved and will be restored by
* calling restore_boot_variable().
*
- * @return status code
+ * Return: status code
*/
static efi_status_t setup_boot_variable(void)
{
*
* Restore the variable values saved in setup_boot_variable().
*
- * @return status code
+ * Return: status code
*/
static efi_status_t restore_boot_variable(void)
{
* void *find_smbios_table() - Find smbios table
*
* @systable system table
- * @return status code
+ * Return: status code
*/
static void *find_smbios_table(const struct efi_system_table *systable)
{
* efi_status_t setup_smbios_table() - Prepare the dummy SMBIOS table
*
* @systable system table
- * @return status code
+ * Return: status code
*/
static efi_status_t setup_smbios_table(const struct efi_system_table *systable)
{
*
* @tcg2 tcg2 protocol
* @manufacturer_id pointer to the manufacturer_id
- * @return status code
+ * Return: status code
*/
static efi_status_t get_manufacturer_id(struct efi_tcg2_protocol *tcg2, u32 *manufacturer_id)
{
*
* @tcg2 tcg2 protocol
* @manufacturer_id pointer to the manufacturer_id
- * @return status code
+ * Return: status code
*/
static efi_status_t get_manufacturer_id_buffer_small(struct efi_tcg2_protocol *tcg2)
{
*
* @tcg2 tcg2 protocol
* @idx pcr index to read
- * @return status code
+ * Return: status code
*/
static efi_status_t read_pcr(struct efi_tcg2_protocol *tcg2, u32 idx)
{
/**
* int validate_pcrs() - Compare the expected and actual pcrs
*
- * @return status code
+ * Return: status code
*/
static int validate_pcrs(void)
{
* @param min_len minimum property length in bytes
* @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
found, or -FDT_ERR_BADLAYOUT if not enough data
- * @return pointer to cell, which is only valid if err == 0
+ * Return: pointer to cell, which is only valid if err == 0
*/
static const void *get_prop_check_min_len(const void *blob, int node,
const char *prop_name, int min_len,
/**
* fdt_find_separate() - Find a devicetree at the end of the image
*
- * @return pointer to FDT blob
+ * Return: pointer to FDT blob
*/
static void *fdt_find_separate(void)
{
* can be used.
* @blob: The blob to expand
* @mynodes: The device_node tree created by the call
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int unflatten_device_tree(const void *blob,
struct device_node **mynodes)
*
* @key: Key containing modulus to check
* @num: Number to check against modulus, as little endian word array
- * @return 0 if num < modulus, 1 if num >= modulus
+ * Return: 0 if num < modulus, 1 if num >= modulus
*/
static int greater_equal_modulus(const struct rsa_public_key *key,
uint32_t num[])
*
* @keyptr: RSA key
* @inout: Big-endian word array containing value and result
- * @return 0 on successful calculation, otherwise failure error code
+ * Return: 0 on successful calculation, otherwise failure error code
*
* FIXME: Use pow_mod() instead of zynq_pow_mod()
* pow_mod calculation required for zynq is bit different from
* @keydir: Directory containins the key
* @name Name of key file (will have a .crt extension)
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_pem_get_pub_key(const char *keydir, const char *name, EVP_PKEY **evpp)
{
* @name Name of key
* @engine Engine to use
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_engine_get_pub_key(const char *keydir, const char *name,
ENGINE *engine, EVP_PKEY **evpp)
* @name Name of key file (will have a .crt extension)
* @engine Engine to use
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_get_pub_key(const char *keydir, const char *name,
ENGINE *engine, EVP_PKEY **evpp)
* @keydir: Directory containing the key
* @name Name of key file (will have a .key extension)
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_pem_get_priv_key(const char *keydir, const char *name,
const char *keyfile, EVP_PKEY **evpp)
* @name Name of key
* @engine Engine to use
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_engine_get_priv_key(const char *keydir, const char *name,
const char *keyfile,
* @name Name of key
* @engine Engine to use for signing
* @evpp Returns EVP_PKEY object, or NULL on failure
- * @return 0 if ok, -ve on error (in which case *evpp will be set to NULL)
+ * Return: 0 if ok, -ve on error (in which case *evpp will be set to NULL)
*/
static int rsa_get_priv_key(const char *keydir, const char *name,
const char *keyfile, ENGINE *engine, EVP_PKEY **evpp)
* @msg: Padded message
* @pad_len: Number of expected padding bytes
* @algo: Checksum algo structure having information on DER encoding etc.
- * @return 0 on success, != 0 on failure
+ * Return: 0 on success, != 0 on failure
*/
static int rsa_verify_padding(const uint8_t *msg, const int pad_len,
struct checksum_algo *algo)
* @seed_len: Size of the input octet string
* @output: Specifies the output octet string
* @output_len: Size of the output octet string
- * @return 0 if the octet string was correctly generated, others on error
+ * Return: 0 if the octet string was correctly generated, others on error
*/
static int mask_generation_function1(struct checksum_algo *checksum,
uint8_t *seed, int seed_len,
* @sig_len: Number of bytes in signature
* @hash: Pointer to the expected hash
* @key_len: Number of bytes in rsa key
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
static int rsa_verify_key(struct image_sign_info *info,
struct key_prop *prop, const uint8_t *sig,
* @sig: Signature
* @sig_len: Number of bytes in signature
* @node: Node having the RSA Key properties
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
static int rsa_verify_with_keynode(struct image_sign_info *info,
const void *hash, uint8_t *sig,
* This ignore case
*
* @ch: Character to convert (expects '0'..'9', 'a'..'f' or 'A'..'F')
- * @return value of digit (0..0xf) or 255 if the character is invalid
+ * Return: value of digit (0..0xf) or 255 if the character is invalid
*/
static uint decode_digit(int ch)
{
* @param size size of output string
* @param format format string
* @param ... data points
- * @return 0 on success, non-0 on error
+ * Return: 0 on success, non-0 on error
*/
int pack_byte_string(u8 *str, size_t size, const char *format, ...);
* @param size size of output string
* @param format format string
* @param ... data points
- * @return 0 on success, non-0 on error
+ * Return: 0 on success, non-0 on error
*/
int unpack_byte_string(const u8 *str, size_t size, const char *format, ...);
* Get TPM command size.
*
* @param command byte string of TPM command
- * @return command size of the TPM command
+ * Return: command size of the TPM command
*/
u32 tpm_command_size(const void *command);
* Get TPM response return code, which is one of TPM_RESULT values.
*
* @param response byte string of TPM response
- * @return return code of the TPM response
+ * Return: return code of the TPM response
*/
u32 tpm_return_code(const void *response);
* @param size_ptr output buffer size (input parameter) and TPM
* response length (output parameter); this parameter
* is a bidirectional
- * @return return code of the TPM response
+ * Return: return code of the TPM response
*/
u32 tpm_sendrecv_command(struct udevice *dev, const void *command,
void *response, size_t *size_ptr);
****************************************************************/
/*! BIT_initCStream() :
* `dstCapacity` must be > sizeof(void*)
- * @return : 0 if success,
+ * Return: 0 if success,
otherwise an error code (can be tested using ERR_isError() ) */
ZSTD_STATIC size_t BIT_initCStream(BIT_CStream_t *bitC, void *startPtr, size_t dstCapacity)
{
}
/*! BIT_closeCStream() :
- * @return : size of CStream, in bytes,
+ * Return: size of CStream, in bytes,
or 0 if it could not fit into dstBuffer */
ZSTD_STATIC size_t BIT_closeCStream(BIT_CStream_t *bitC)
{
* local register is not modified.
* On 32-bits, maxNbBits==24.
* On 64-bits, maxNbBits==56.
- * @return : value extracted
+ * Return: value extracted
*/
ZSTD_STATIC size_t BIT_lookBits(const BIT_DStream_t *bitD, U32 nbBits)
{
/*! BIT_readBits() :
* Read (consume) next n bits from local register and update.
* Pay attention to not read more than nbBits contained into local register.
- * @return : extracted value.
+ * Return: extracted value.
*/
ZSTD_STATIC size_t BIT_readBits(BIT_DStream_t *bitD, U32 nbBits)
{
* compatible with legacy mode
* `srcSize` must be the exact length of some number of ZSTD compressed and/or
* skippable frames
- * @return : decompressed size of the frames contained */
+ * Return: decompressed size of the frames contained */
unsigned long long ZSTD_findDecompressedSize(const void *src, size_t srcSize)
{
{
* compatible with legacy mode
* `src` must point to the start of a ZSTD frame, ZSTD legacy frame, or skippable frame
* `srcSize` must be at least as large as the frame contained
- * @return : the compressed size of the frame starting at `src` */
+ * Return: the compressed size of the frame starting at `src` */
size_t ZSTD_findFrameCompressedSize(const void *src, size_t srcSize)
{
if (srcSize >= ZSTD_skippableHeaderSize && (ZSTD_readLE32(src) & 0xFFFFFFF0U) == ZSTD_MAGIC_SKIPPABLE_START) {
/* ZSTD_loadEntropy() :
* dict : must point at beginning of a valid zstd dictionary
- * @return : size of entropy tables read */
+ * Return: size of entropy tables read */
static size_t ZSTD_loadEntropy(ZSTD_entropyTables_t *entropy, const void *const dict, size_t const dictSize)
{
const BYTE *dictPtr = (const BYTE *)dict;
* @base_name: Base name for variable, typically "eth"
* @index: Index of interface being updated (>=0)
* @enetaddr: Pointer to MAC address to put into the variable
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
*/
int eth_env_set_enetaddr_by_index(const char *base_name, int index,
uchar *enetaddr);
* @param block Block number to send
* @param dst Destination buffer for data
* @param len Number of bytes in block (this one and every other)
- * @return number of bytes loaded
+ * Return: number of bytes loaded
*/
static int load_block(unsigned block, uchar *dst, unsigned len)
{
* @s: string to find/add
* @allocated: Set to 0 if the string was found, 1 if not found and so
* allocated. Ignored if !fdt_chk_basic()
- * @return offset of string in the string table (whether found or added)
+ * Return: offset of string in the string table (whether found or added)
*/
static int fdt_find_add_string_(void *fdt, const char *s, int *allocated)
{
*
* @fdt: FDT blob
* @offset: Offset of node to check
- * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
+ * Return: offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
*/
int fdt_first_subnode(const void *fdt, int offset);
*
* @fdt: FDT blob
* @offset: Offset of previous subnode
- * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
+ * Return: offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
* subnodes
*/
int fdt_next_subnode(const void *fdt, int offset);
* @param dirname Directory to look in, or NULL for none
* @param fname Filename to look for
* @param fp Set to NULL if file did not open
- * @return allocated filename on success (caller must free), NULL on failure
+ * Return: allocated filename on success (caller must free), NULL on failure
*/
static char *try_open(const char *dirname, const char *fname, FILE **fp)
{
*
* @param fname Filename to open
* @param fp Returns pointer to opened FILE, or NULL on failure
- * @return pointer to allocated filename, which caller must free
+ * Return: pointer to allocated filename, which caller must free
*/
static char *fopen_any_on_path(const char *fname, FILE **fp)
{
* @param fullnamep If non-NULL, it is set to the allocated filename of the
* file that was opened. The caller is then responsible
* for freeing the pointer.
- * @return pointer to opened FILE
+ * Return: pointer to opened FILE
*/
FILE *srcfile_relative_open(const char *fname, char **fullnamep);
*
* @param data The string to check
* @param len The string length including terminator
- * @return 1 if a valid printable string, 0 if not
+ * Return: 1 if a valid printable string, 0 if not
*/
bool util_is_printable_string(const void *data, int len);
* stderr.
*
* @param filename The filename to read, or - for stdin
- * @return Pointer to allocated buffer containing fdt, or NULL on error
+ * Return: Pointer to allocated buffer containing fdt, or NULL on error
*/
char *utilfdt_read(const char *filename);
*
* @param filename The filename to read, or - for stdin
* @param buffp Returns pointer to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
*/
int utilfdt_read_err(const char *filename, char **buffp);
*
* @param filename The filename to write, or - for stdout
* @param blob Poiner to buffer containing fdt
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int utilfdt_write(const char *filename, const void *blob);
*
* @param filename The filename to write, or - for stdout
* @param blob Poiner to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
*/
int utilfdt_write_err(const char *filename, const void *blob);
* @param fmt Format string to process
* @param type Returns type found(s/d/u/x), or 0 if none
* @param size Returns size found(1,2,4,8) or 4 if none
- * @return 0 if ok, -1 on error (no type given, or other invalid format)
+ * Return: 0 if ok, -1 on error (no type given, or other invalid format)
*/
int utilfdt_decode_type(const char *fmt, int *type, int *size);
*
* @comp_type: Compression type to test
* @compress: Our function to compress data
- * @return 0 if OK, non-zero on failure
+ * Return: 0 if OK, non-zero on failure
*/
static int run_bootm_test(struct unit_test_state *uts, int comp_type,
mutate_func compress)
*
* @ctxp: Returns allocated context
* @size: Size to allocate in bytes
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
int acpi_test_alloc_context_size(struct acpi_ctx **ctxp, int size);
* acpi_test_get_length() - decode a three-byte length field
*
* @ptr: Length encoded as per ACPI
- * @return decoded length, or -EINVAL on error
+ * Return: decoded length, or -EINVAL on error
*/
int acpi_test_get_length(u8 *ptr);
* receive an incrementing value
* @child: If not NULL, then the child device pointers are written into
* this array.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int create_children(struct unit_test_state *uts, struct udevice *parent,
int count, int key, struct udevice *child[])
* @uts: Test state
* @parent: Parent to search
* @found: bool array to update
- * @return 0 if OK, non-zero on error
+ * Return: 0 if OK, non-zero on error
*/
static int find_driver_info(struct unit_test_state *uts, struct udevice *parent,
bool found[])
*
* @test_name: Name of single test to run (e.g. "dm_test_fdt_pre_reloc" or just
* "fdt_pre_reloc"), or NULL to run all
- * @return 0 if all tests passed, 1 if not
+ * Return: 0 if all tests passed, 1 if not
*/
static int dm_test_run(const char *test_name)
{
*
* @uts: Test state
* @dev: Video device
- * @return compressed size of the frame buffer, or -ve on error
+ * Return: compressed size of the frame buffer, or -ve on error
*/
static int compress_frame_buffer(struct unit_test_state *uts,
struct udevice *dev)
*
* @uts: Test state
* @devp: Returns video device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int video_get_nologo(struct unit_test_state *uts, struct udevice **devp)
{
* 2=upside down, 3=90 degree counterclockwise)
* @wrap_size: Expected size of compressed frame buffer for the wrap test
* @scroll_size: Same for the scroll test
- * @return 0 on success
+ * Return: 0 on success
*/
static int check_vidconsole_output(struct unit_test_state *uts, int rot,
int wrap_size, int scroll_size)
* syslog_test_setup() - Enable syslog logging ready for tests
*
* @uts: Test state
- * @return 0 if OK, -ENOENT if the syslog log driver is not found
+ * Return: 0 if OK, -ENOENT if the syslog log driver is not found
*/
int syslog_test_setup(struct unit_test_state *uts);
* syslog_test_finish() - Disable syslog logging after tests
*
* @uts: Test state
- * @return 0 if OK, -ENOENT if the syslog log driver is not found
+ * Return: 0 if OK, -ENOENT if the syslog log driver is not found
*/
int syslog_test_finish(struct unit_test_state *uts);
* This skips long/slow tests where there is not much value in running a flat
* DT test in addition to a live DT test.
*
- * @return true to run the given test on the flat device tree
+ * Return: true to run the given test on the flat device tree
*/
static bool ut_test_run_on_flattree(struct unit_test *test)
{
* a prefix.
* @test_name: Name of current test
* @select_name: Name of test to run (or NULL for all)
- * @return true to run this test, false to skip it
+ * Return: true to run this test, false to skip it
*/
static bool test_matches(const char *prefix, const char *test_name,
const char *select_name)
*
* @tests: List of tests to run
* @count: Number of tests to ru
- * @return true if any of the tests have the UT_TESTF_DM flag
+ * Return: true if any of the tests have the UT_TESTF_DM flag
*/
static bool ut_list_has_dm_tests(struct unit_test *tests, int count)
{
* dm_test_restore() Put things back to normal so sandbox works as expected
*
* @of_root: Value to set for of_root
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int dm_test_restore(struct device_node *of_root)
{
*
* @uts: Test state
* @test: Test to prepare for
- * @return 0 if OK, -EAGAIN to skip this test since some required feature is not
+ * Return: 0 if OK, -EAGAIN to skip this test since some required feature is not
* available, other -ve on error (meaning that testing cannot likely
* continue)
*/
*
* @uts: Test state
* @test: Test to clean up after
- * @return 0 if OK, -ve on error (meaning that testing cannot likely continue)
+ * Return: 0 if OK, -ve on error (meaning that testing cannot likely continue)
*/
static int test_post_run(struct unit_test_state *uts, struct unit_test *test)
{
* incremented by the number of failures (0, one hopes)
* @test_name: Test to run
* @name: Name of test, possibly skipping a prefix that should not be displayed
- * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
+ * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
* any failed
*/
static int ut_run_test(struct unit_test_state *uts, struct unit_test *test,
* incremented by the number of failures (0, one hopes)
* @test: Test to run
* @name: Name of test, possibly skipping a prefix that should not be displayed
- * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
+ * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
* any failed
*/
static int ut_run_test_live_flat(struct unit_test_state *uts,
* @count: Number of tests to run
* @select_name: Name of a single test to run (from the list provided). If NULL
* then all tests are run
- * @return 0 if all tests passed, -ENOENT if test @select_name was not found,
+ * Return: 0 if all tests passed, -ENOENT if test @select_name was not found,
* -EBADF if any failed
*/
static int ut_run_tests(struct unit_test_state *uts, const char *prefix,
* @ptr: image header to be verified
* @image_size: size of while image
* @params: mkimage parameters
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
*/
int fit_verify_header(unsigned char *ptr, int image_size,
struct image_tool_params *params);
* @sbuf: File status information is stored here
* @delete_on_error: true to delete the file if we get an error
* @read_only: true to open in read-only mode
- * @return 0 if OK, -1 on error.
+ * Return: 0 if OK, -1 on error.
*/
int mmap_fdt(const char *cmdname, const char *fname, size_t size_inc,
void **blobp, struct stat *sbuf, bool delete_on_error,
*
* @image: Pointer to image
* @size: Size of image in bytes
- * @return pointer to structure, or NULL if not found
+ * Return: pointer to structure, or NULL if not found
*/
static struct fdbar_t *find_fd(char *image, int size)
{
* @frba: Flash region list
* @region_type: Type of region (0..MAX_REGIONS-1)
* @region: Region information is written here
- * @return 0 if OK, else -ve
+ * Return: 0 if OK, else -ve
*/
static int get_region(struct frba_t *frba, int region_type,
struct region_t *region)
*
* @image: Pointer to image
* @size: Size of image in bytes
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
*/
static int dump_fd(char *image, int size)
{
*
* @image: Pointer to image
* @size: Size of image in bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int write_regions(char *image, int size)
{
* @filename: Filename to use for the image
* @image: Pointer to image
* @size: Size of image in bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
static int write_image(char *filename, char *image, int size)
{
*
* @fname: Filename to open
* @sizep: Returns file size in bytes
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
*/
int open_for_read(const char *fname, int *sizep)
{
* @size: Size of image in bytes
* @region_type: Region where the file should be added
* @region_fname: Filename to add to the image
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int inject_region(char *image, int size, int region_type, char *region_fname)
{
* @write_fname: Filename to add to the image
* @offset_uboot_top: Offset of the top of U-Boot
* @offset_uboot_start: Offset of the start of U-Boot
- * @return number of bytes written if OK, -ve on error
+ * Return: number of bytes written if OK, -ve on error
*/
static int write_data(char *image, int size, unsigned int addr,
const char *write_fname, int offset_uboot_top,
* @str: String to split
* @firstp: Returns first string
* @secondp: Returns second string
- * @return 0 if OK, -ve if @str does not have a :
+ * Return: 0 if OK, -ve if @str does not have a :
*/
static int get_two_words(const char *str, char **firstp, char **secondp)
{
* @noffset: subnode offset
* @data: data to process
* @size: size of data in bytes
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int fit_image_process_hash(void *fit, const char *image_name,
int noffset, const void *data, size_t size)
* @comment: Comment to add to signature nodes
* @require_keys: Mark all keys as 'required'
* @engine_id: Engine to use for signing
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
static int fit_image_process_sig(const char *keydir, const char *keyfile,
void *keydest, void *fit, const char *image_name,
* supported image type. If verification is successful, this prints
* the respective header.
*
- * @return 0 on success, negative if input image format does not match with
+ * Return: 0 on success, negative if input image format does not match with
* any of supported image types
*/
int imagetool_verify_print_header(
* @tparams: image type parameters
* @params: mkimage parameters
*
- * @return 0 on success, negative if input image format does not match with
+ * Return: 0 on success, negative if input image format does not match with
* the given image type
*/
int imagetool_verify_print_header_by_type(
*
* @params: mkimage parameters
* @fname: filename to check
- * @return size of file, or -ve value on error
+ * Return: size of file, or -ve value on error
*/
int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
*
* @cmdname: command name
* @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
- * @return timestamp based on SOURCE_DATE_EPOCH
+ * Return: timestamp based on SOURCE_DATE_EPOCH
*/
time_t imagetool_get_source_date(
const char *cmdname,
/**
* rkcommon_check_params() - check params
*
- * @return 0 if OK, -1 if ERROR.
+ * Return: 0 if OK, -1 if ERROR.
*/
int rkcommon_check_params(struct image_tool_params *params);
*
* @buf: Pointer to the image file
* @file_size: Size of entire bootable image file (incl. all padding)
- * @return 0 if OK
+ * Return: 0 if OK
*/
int rkcommon_verify_header(unsigned char *buf, int size,
struct image_tool_params *params);
* Some socs cannot disable the rc4-encryption of the spl binary.
* rc4 encryption is disabled normally except on socs that cannot
* handle unencrypted binaries.
- * @return true or false depending on rc4 being required.
+ * Return: true or false depending on rc4 being required.
*/
bool rkcommon_need_rc4_spl(struct image_tool_params *params);
* @tparams: Pointer tot the image type structure (for setting
* the header and header_size)
*
- * @return 0 (always)
+ * Return: 0 (always)
*/
int rkcommon_vrec_header(struct image_tool_params *params,
struct image_type_params *tparams);
projects / u-boot.git / commitdiff
