Skip to content

Commit 1c20224

Browse files
tnmyshmathieupoirier
authored andcommitted
remoteproc: xlnx: Fix kernel-doc warnings
Fix kernel-doc warnings generated by following command: `scripts/kernel-doc -Werror -Wshort-desc -Wall \ drivers/remoteproc/xlnx_r5_remoteproc.c > /dev/null` warning: missing initial short description on line: * struct mbox_info ... Total 8 warnings fixed Signed-off-by: Tanmay Shah <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Mathieu Poirier <[email protected]>
1 parent 699cdd7 commit 1c20224

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

drivers/remoteproc/xlnx_r5_remoteproc.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ struct zynqmp_sram_bank {
6868
};
6969

7070
/**
71-
* struct mbox_info
71+
* struct mbox_info - mailbox channel data
7272
*
7373
* @rx_mc_buf: to copy data from mailbox rx channel
7474
* @tx_mc_buf: to copy data to mailbox tx channel
@@ -89,7 +89,7 @@ struct mbox_info {
8989
};
9090

9191
/**
92-
* struct rsc_tbl_data
92+
* struct rsc_tbl_data - resource table metadata
9393
*
9494
* Platform specific data structure used to sync resource table address.
9595
* It's important to maintain order and size of each field on remote side.
@@ -128,7 +128,7 @@ static const struct mem_bank_data zynqmp_tcm_banks_lockstep[] = {
128128
};
129129

130130
/**
131-
* struct zynqmp_r5_core
131+
* struct zynqmp_r5_core - remoteproc core's internal data
132132
*
133133
* @rsc_tbl_va: resource table virtual address
134134
* @sram: Array of sram memories assigned to this core
@@ -157,7 +157,7 @@ struct zynqmp_r5_core {
157157
};
158158

159159
/**
160-
* struct zynqmp_r5_cluster
160+
* struct zynqmp_r5_cluster - remoteproc cluster's internal data
161161
*
162162
* @dev: r5f subsystem cluster device node
163163
* @mode: cluster mode of type zynqmp_r5_cluster_mode
@@ -732,7 +732,7 @@ static int zynqmp_r5_parse_fw(struct rproc *rproc, const struct firmware *fw)
732732
}
733733

734734
/**
735-
* zynqmp_r5_rproc_prepare()
735+
* zynqmp_r5_rproc_prepare() - prepare core to boot/attach
736736
* adds carveouts for TCM bank and reserved memory regions
737737
*
738738
* @rproc: Device node of each rproc
@@ -765,7 +765,7 @@ static int zynqmp_r5_rproc_prepare(struct rproc *rproc)
765765
}
766766

767767
/**
768-
* zynqmp_r5_rproc_unprepare()
768+
* zynqmp_r5_rproc_unprepare() - programming sequence after stop/detach.
769769
* Turns off TCM banks using power-domain id
770770
*
771771
* @rproc: Device node of each rproc
@@ -908,7 +908,7 @@ static const struct rproc_ops zynqmp_r5_rproc_ops = {
908908
};
909909

910910
/**
911-
* zynqmp_r5_add_rproc_core()
911+
* zynqmp_r5_add_rproc_core() - Add core data to framework.
912912
* Allocate and add struct rproc object for each r5f core
913913
* This is called for each individual r5f core
914914
*
@@ -1144,7 +1144,7 @@ static int zynqmp_r5_get_tcm_node_from_dt(struct zynqmp_r5_cluster *cluster)
11441144
}
11451145

11461146
/**
1147-
* zynqmp_r5_get_tcm_node()
1147+
* zynqmp_r5_get_tcm_node() - Get TCM info
11481148
* Ideally this function should parse tcm node and store information
11491149
* in r5_core instance. For now, Hardcoded TCM information is used.
11501150
* This approach is used as TCM bindings for system-dt is being developed

0 commit comments

Comments
 (0)