vhaudiquet/u-boot-krane
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: add include/dm/of*.h to the HTML documentation

Browse Source 
Correct Sphinx style comments in include/dm/ofnode.h
and add the device tree node API to the HTML documentation;
the ofnode functions are compatible with Live tree or with flat
device tree.

Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Patrick Delaunay
2022-01-15 10:57:21 +01:00
committed by Heinrich Schuchardt
parent 6de6a615f8
commit be74f71a67
6 changed files with 297 additions and 275 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/dm/of_addr.h
+16 -17
View File
@@ -20,11 +20,11 @@
* that can be mapped to a cpu physical address). This is not really specified
* that way, but this is traditionally the way IBM at least do things
*
* @np: node to check
* @np: pointer to node to check
* @in_addr: pointer to input address
* @return translated address or OF_BAD_ADDR on error
* Return: translated address or OF_BAD_ADDR on error
*/
u64 of_translate_address(const struct device_node *no, const __be32 *in_addr);
u64 of_translate_address(const struct device_node *np, const __be32 *in_addr);
/**
* of_translate_dma_address() - translate a device-tree DMA address to a CPU
@@ -38,11 +38,11 @@ u64 of_translate_address(const struct device_node *no, const __be32 *in_addr);
* that can be mapped to a cpu physical address). This is not really specified
* that way, but this is traditionally the way IBM at least do things
*
* @np: node to check
* @np: ne
* @in_addr: pointer to input DMA address
* @return translated DMA address or OF_BAD_ADDR on error
* Return: translated DMA address or OF_BAD_ADDR on error
*/
u64 of_translate_dma_address(const struct device_node *no, const __be32 *in_addr);
u64 of_translate_dma_address(const struct device_node *np, const __be32 *in_addr);
/**
@@ -51,14 +51,13 @@ u64 of_translate_dma_address(const struct device_node *no, const __be32 *in_addr
* Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
* cpu->bus address translations
*
* @param blob Pointer to device tree blob
* @param node_offset Node DT offset
* @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
* @np: Pointer to device tree blob
* @cpu: Pointer to variable storing the range's cpu address
* @bus: Pointer to variable storing the range's bus address
* @size: Pointer to variable storing the range's size
* Return: translated DMA address or OF_BAD_ADDR on error
*/
int of_get_dma_range(const struct device_node *dev, phys_addr_t *cpu,
int of_get_dma_range(const struct device_node *np, phys_addr_t *cpu,
dma_addr_t *bus, u64 *size);
/**
@@ -72,9 +71,9 @@ int of_get_dma_range(const struct device_node *dev, phys_addr_t *cpu,
* @index: Index of address to read (0 = first)
* @size: place to put size on success
* @flags: place to put flags on success
* @return pointer to address which can be read
* Return: pointer to address which can be read
*/
const __be32 *of_get_address(const struct device_node *no, int index,
const __be32 *of_get_address(const struct device_node *np, int index,
u64 *size, unsigned int *flags);
struct resource;
@@ -90,9 +89,9 @@ struct resource;
* @np: node to check
* @index: index of address to read (0 = first)
* @r: place to put resource information
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int of_address_to_resource(const struct device_node *no, int index,
int of_address_to_resource(const struct device_node *np, int index,
struct resource *r);
#endif