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>
diff --git a/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h b/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h
index d3809ae..3328845 100644
--- a/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h
+++ b/arch/mips/mach-octeon/include/mach/cvmx-helper-fdt.h
@@ -141,7 +141,7 @@
* @param[in,out] lenp Number of phandles, input max number
* @param[out] nodes Array of phandle nodes
*
- * @return -ve error code on error or 0 for success
+ * Return: -ve error code on error or 0 for success
*/
int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, const char *prop_name, int *lenp,
int *nodes);
@@ -153,7 +153,7 @@
* @param node node to read address from
* @param prop_name property name to read
*
- * @return address of property or FDT_ADDR_T_NONE if not found
+ * Return: address of property or FDT_ADDR_T_NONE if not found
*/
static inline fdt_addr_t cvmx_fdt_get_addr(const void *fdt_addr, int node, const char *prop_name)
{
@@ -168,7 +168,7 @@
* @param[in] prop_name property name to read
* @param default_val default value to return if property doesn't exist
*
- * @return integer value of property or default_val if it doesn't exist.
+ * Return: integer value of property or default_val if it doesn't exist.
*/
static inline int cvmx_fdt_get_int(const void *fdt_addr, int node, const char *prop_name,
int default_val)
@@ -195,7 +195,7 @@
* @param node node to read phandle from
* @param[in] prop_name name of property to find
*
- * @return node offset if found, -ve error code on error
+ * Return: node offset if found, -ve error code on error
*/
static inline int cvmx_fdt_lookup_phandle(const void *fdt_addr, int node, const char *prop_name)
{
@@ -214,7 +214,7 @@
* NOTE: in_addr must be in the native ENDIAN
* format.
*
- * @return Translated address or FDT_ADDR_T_NONE if address cannot be
+ * Return: Translated address or FDT_ADDR_T_NONE if address cannot be
* translated.
*/
static inline u64 cvmx_fdt_translate_address(const void *fdt_addr, int node, const u32 *in_addr)
@@ -228,7 +228,7 @@
* @param[in] s1 First string to compare
* @param[in] sw Second string to compare
*
- * @return 0 if no match
+ * Return: 0 if no match
* 1 if only the part number matches and not the manufacturer
* 2 if both the part number and manufacturer match
*/
@@ -241,7 +241,7 @@
* @param llen string list total length
* @param[in] str string to search for
*
- * @return 1 if string list contains string, 0 if it does not.
+ * Return: 1 if string list contains string, 0 if it does not.
*/
int cvmx_fdt_compat_list_contains(const char *slist, int llen, const char *str);
@@ -252,7 +252,7 @@
* @param node node offset to check
* @param[in] compat compatible string to check
*
- * @return 0 if compatible, 1 if not compatible, error if negative
+ * Return: 0 if compatible, 1 if not compatible, error if negative
*/
int cvmx_fdt_node_check_compatible(const void *fdt_addr, int node, const char *compat);
@@ -263,7 +263,7 @@
* @param[in] compat compatible string
* @param[in] str string to check
*
- * @return 0 if not compatible, 1 if manufacturer compatible, 2 if
+ * Return: 0 if not compatible, 1 if manufacturer compatible, 2 if
* part is compatible, 3 if both part and manufacturer are
* compatible.
*/
@@ -276,7 +276,7 @@
* @param phandle phandle to GPIO
* @param[out] size Number of pins (optional, may be NULL)
*
- * @return Type of GPIO device or PIN_ERROR if error
+ * Return: Type of GPIO device or PIN_ERROR if error
*/
enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, int *size);
@@ -289,7 +289,7 @@
* NULL for none.
* @param[out] addr TWSI address number, can be NULL for none
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int cvmx_fdt_get_twsi_gpio_bus_addr(const void *fdt_addr, int phandle, int *bus, int *addr);
@@ -299,7 +299,7 @@
* @param[in] fdt_addr Address of FDT
* @param node FDT node number
*
- * @return CPU node number or error if negative
+ * Return: CPU node number or error if negative
*/
int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node);
@@ -308,7 +308,7 @@
*
* @param[in] fdt_addr Address of FDT
*
- * @return Size of flat device tree in bytes or -1 if error.
+ * Return: Size of flat device tree in bytes or -1 if error.
*/
int cvmx_fdt_get_fdt_size(const void *fdt_addr);
@@ -320,7 +320,7 @@
* @param[in] strlist Array of FDT device compatibility strings,
* must end with NULL or empty string.
*
- * @return 0 if at least one item matches, 1 if no matches
+ * Return: 0 if at least one item matches, 1 if no matches
*/
int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const char *const *strlist);
@@ -332,7 +332,7 @@
* @param strlist Array of FDT device compatibility strings, must
* end with NULL or empty string.
*
- * @return next matching node or -1 if no more matches.
+ * Return: next matching node or -1 if no more matches.
*/
int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffset,
const char *const *strlist);
@@ -345,7 +345,7 @@
* @param of_offset Offset of the parent node of a GPIO device in
* the device tree.
*
- * @return pointer to list of i2c devices starting from the root which
+ * Return: pointer to list of i2c devices starting from the root which
* can include i2c muxes and switches or NULL if error. Note that
* all entries are allocated on the heap.
*
@@ -358,7 +358,7 @@
*
* @param[in] bus bus descriptor
*
- * @return Octeon twsi bus number or -1 on error
+ * Return: Octeon twsi bus number or -1 on error
*/
int cvmx_fdt_i2c_get_root_bus(const struct cvmx_fdt_i2c_bus_info *bus);
@@ -367,7 +367,7 @@
*
* @param bus bus to free
*
- * @return 0
+ * Return: 0
*/
int cvmx_fdt_free_i2c_bus(struct cvmx_fdt_i2c_bus_info *bus);
@@ -377,7 +377,7 @@
* @param[in] bus i2c bus descriptor to enable or disable
* @param enable set to true to enable, false to disable
*
- * @return 0 for success or -1 for invalid bus
+ * Return: 0 for success or -1 for invalid bus
*
* This enables the entire bus including muxes and switches in the path.
*/
@@ -390,7 +390,7 @@
* @param of_offset node offset for property
* @param prop_name name of property
*
- * @return pointer to GPIO handle or NULL if error
+ * Return: pointer to GPIO handle or NULL if error
*/
struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, int of_offset,
const char *prop_name);
@@ -401,7 +401,7 @@
* @param pin GPIO pin descriptor
* @param value value to set it to, 0 or 1
*
- * @return 0 on success, -1 on error.
+ * Return: 0 on success, -1 on error.
*
* NOTE: If the CVMX_GPIO_ACTIVE_LOW flag is set then the output value will be
* inverted.
@@ -413,7 +413,7 @@
*
* @param pin GPIO pin descriptor
*
- * @return 0 if low, 1 if high, -1 on error. Note that the input will be
+ * Return: 0 if low, 1 if high, -1 on error. Note that the input will be
* inverted if the CVMX_GPIO_ACTIVE_LOW flag bit is set.
*/
int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin);
@@ -424,7 +424,7 @@
* @param sfp Handle to SFP data structure
* @param ipd_port Port to assign it to
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port);
@@ -433,7 +433,7 @@
*
* @param[in] sfp Handle to SFP data structure
*
- * @return IPD port number for SFP slot
+ * Return: IPD port number for SFP slot
*/
static inline int cvmx_sfp_get_ipd_port(const struct cvmx_fdt_sfp_info *sfp)
{
@@ -469,7 +469,7 @@
*
* @param[in] sfp SFP to get phy info from
*
- * @return phy descriptor or NULL if none.
+ * Return: phy descriptor or NULL if none.
*/
static inline struct cvmx_phy_info *cvmx_sfp_get_phy_info(const struct cvmx_fdt_sfp_info *sfp)
{
@@ -482,7 +482,7 @@
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int __cvmx_fdt_parse_vsc7224(const void *fdt_addr);
@@ -492,7 +492,7 @@
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return 0 for success, error otherwise
+ * Return: 0 for success, error otherwise
*/
int __cvmx_fdt_parse_avsp5410(const void *fdt_addr);
@@ -501,7 +501,7 @@
*
* @param[in] fdt_addr Address of flat device tree
*
- * @return pointer to sfp info or NULL if error
+ * Return: pointer to sfp info or NULL if error
*/
struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, int of_offset);
@@ -512,7 +512,7 @@
* @param of_offset offset of slice or phy in device tree
* @param phy_info phy_info data structure to fill in
*
- * @return 0 for success, -1 on error
+ * Return: 0 for success, -1 on error
*/
int cvmx_fdt_parse_cs4343(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info);
@@ -533,7 +533,7 @@
* @param bus i2c bus number
* @param addr i2c device address (7 bits)
*
- * @return 8-bit value or error if negative
+ * Return: 8-bit value or error if negative
*/
int cvmx_fdt_i2c_reg_read(int bus, int addr);
@@ -545,7 +545,7 @@
* @param reg i2c 8-bit register address
* @param val 8-bit value to write
*
- * @return 0 for success, otherwise error
+ * Return: 0 for success, otherwise error
*/
int cvmx_fdt_i2c_write8(int bus, int addr, int reg, u8 val);
@@ -556,7 +556,7 @@
* @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);