u-boot/arch/arm/mach-bcm283x/include/mach/msg.h
Heinrich Schuchardt 185f812c41 doc: replace @return by Return:
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>
2022-01-19 18:11:34 +01:00

58 lines
1.7 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* (C) Copyright 2012,2015 Stephen Warren
*/
#ifndef _BCM2835_MSG_H
#define _BCM2835_MSG_H
/**
* 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
*/
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
*/
int bcm2835_get_mmc_clock(u32 clock_id);
/**
* bcm2835_get_video_size() - get the current display size
*
* @widthp: Returns the width in pixels
* @heightp: Returns the height in pixels
* Return: 0 if OK, -ve on error
*/
int bcm2835_get_video_size(int *widthp, int *heightp);
/**
* bcm2835_set_video_params() - set the video parameters
*
* @widthp: Video width to request (returns the actual width selected)
* @heightp: Video height to request (returns the actual height selected)
* @depth_bpp: Requested bit depth
* @pixel_order: Pixel order to use (BCM2835_MBOX_PIXEL_ORDER_...)
* @alpha_mode: Alpha transparency mode to use (BCM2835_MBOX_ALPHA_MODE_...)
* @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
*/
int bcm2835_set_video_params(int *widthp, int *heightp, int depth_bpp,
int pixel_order, int alpha_mode, ulong *fb_basep,
ulong *fb_sizep, int *pitchp);
/**
* bcm2711_load_vl805_firmware() - get vl805's firmware loaded
*
* Return: 0 if OK, -EIO on error
*/
int bcm2711_notify_vl805_reset(void);
#endif