Correct Sphinx style comments in include/dm/fdtaddr.h
and add the devfdt API to the HTML documentation;
these functions are NOT compatible with live tree.
Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
.. kernel-doc:: include/dm/of_extra.h
.. kernel-doc:: include/dm/of_access.h
.. kernel-doc:: include/dm/of_addr.h
.. kernel-doc:: include/dm/of_extra.h
.. kernel-doc:: include/dm/of_access.h
.. kernel-doc:: include/dm/of_addr.h
+.. kernel-doc:: include/dm/fdtaddr.h
*
* @dev: Pointer to a device
*
*
* @dev: Pointer to a device
*
*/
fdt_addr_t devfdt_get_addr(const struct udevice *dev);
*/
fdt_addr_t devfdt_get_addr(const struct udevice *dev);
*
* @dev: Pointer to a device
*
*
* @dev: Pointer to a device
*
- * @return Pointer to addr, or NULL if there is no such property
+ * Return: Pointer to addr, or NULL if there is no such property
*/
void *devfdt_get_addr_ptr(const struct udevice *dev);
*/
void *devfdt_get_addr_ptr(const struct udevice *dev);
*
* @dev: Pointer to a device
*
*
* @dev: Pointer to a device
*
- * @return Pointer to addr, or NULL if there is no such property
+ * Return: Pointer to addr, or NULL if there is no such property
*/
void *devfdt_remap_addr(const struct udevice *dev);
*/
void *devfdt_remap_addr(const struct udevice *dev);
*
* @dev: Pointer to a device
*
*
* @dev: Pointer to a device
*
- * @return Pointer to addr, or NULL if there is no such property
+ * Return: Pointer to addr, or NULL if there is no such property
*/
void *devfdt_remap_addr_index(const struct udevice *dev, int index);
*/
void *devfdt_remap_addr_index(const struct udevice *dev, int index);
*
* @dev: Pointer to a device
*
*
* @dev: Pointer to a device
*
- * @return Pointer to addr, or NULL if there is no such property
+ * Return: Pointer to addr, or NULL if there is no such property
*/
void *devfdt_remap_addr_name(const struct udevice *dev, const char *name);
*/
void *devfdt_remap_addr_name(const struct udevice *dev, const char *name);
* @dev: Pointer to device
* @size: size of the memory to map
*
* @dev: Pointer to device
* @size: size of the memory to map
*
- * @return mapped address, or NULL if the device does not have reg
- * property.
+ * Return: mapped address, or NULL if the device does not have reg property.
*/
void *devfdt_map_physmem(const struct udevice *dev, unsigned long size);
*/
void *devfdt_map_physmem(const struct udevice *dev, unsigned long size);
* @index: the 'reg' property can hold a list of <addr, size> pairs
* and @index is used to select which one is required
*
* @index: the 'reg' property can hold a list of <addr, size> pairs
* and @index is used to select which one is required
*
*/
fdt_addr_t devfdt_get_addr_index(const struct udevice *dev, int index);
*/
fdt_addr_t devfdt_get_addr_index(const struct udevice *dev, int index);
* @index: the 'reg' property can hold a list of <addr, size> pairs
* and @index is used to select which one is required
*
* @index: the 'reg' property can hold a list of <addr, size> pairs
* and @index is used to select which one is required
*
- * @return Pointer to addr, or NULL if there is no such property
+ * Return: Pointer to addr, or NULL if there is no such property
*/
void *devfdt_get_addr_index_ptr(const struct udevice *dev, int index);
*/
void *devfdt_get_addr_index_ptr(const struct udevice *dev, int index);
* @size: Pointer to size varible - this function returns the size
* specified in the 'reg' property here
*
* @size: Pointer to size varible - this function returns the size
* specified in the 'reg' property here
*
*/
fdt_addr_t devfdt_get_addr_size_index(const struct udevice *dev, int index,
fdt_size_t *size);
*/
fdt_addr_t devfdt_get_addr_size_index(const struct udevice *dev, int index,
fdt_size_t *size);
* 'reg-names' property providing named-based identification. @index
* indicates the value to search for in 'reg-names'.
*
* 'reg-names' property providing named-based identification. @index
* indicates the value to search for in 'reg-names'.
*
*/
fdt_addr_t devfdt_get_addr_name(const struct udevice *dev, const char *name);
*/
fdt_addr_t devfdt_get_addr_name(const struct udevice *dev, const char *name);
* @size: Pointer to size variable - this function returns the size
* specified in the 'reg' property here
*
* @size: Pointer to size variable - this function returns the size
* specified in the 'reg' property here
*
*/
fdt_addr_t devfdt_get_addr_size_name(const struct udevice *dev,
const char *name, fdt_size_t *size);
*/
fdt_addr_t devfdt_get_addr_size_name(const struct udevice *dev,
const char *name, fdt_size_t *size);
* devfdt_get_addr_pci() - Read an address and handle PCI address translation
*
* @dev: Device to read from
* devfdt_get_addr_pci() - Read an address and handle PCI address translation
*
* @dev: Device to read from
- * @return address or FDT_ADDR_T_NONE if not found
+ * Return: address or FDT_ADDR_T_NONE if not found
*/
fdt_addr_t devfdt_get_addr_pci(const struct udevice *dev);
*/
fdt_addr_t devfdt_get_addr_pci(const struct udevice *dev);