diff options
author | Alexander Usyskin <alexander.usyskin@intel.com> | 2015-02-10 03:39:35 -0500 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2015-03-01 22:36:59 -0500 |
commit | 3908be6f9aa5517bc717f8ffdaaafd89a1b78471 (patch) | |
tree | e646bcf08ea53cd1336bd13dc4fe0bd8d7d419b2 | |
parent | 2d1995fce3f9b9a0bdb88d47144509e3b84db0f9 (diff) |
mei: fix function names and format in KDoc
Align functions names in KDoc with real ones.
Fix comment format to be KDoc and fix wrong syntax there.
Signed-off-by: Alexander Usyskin <alexander.usyskin@intel.com>
Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
-rw-r--r-- | drivers/misc/mei/client.c | 9 | ||||
-rw-r--r-- | drivers/misc/mei/hw-txe.c | 2 | ||||
-rw-r--r-- | drivers/misc/mei/pci-txe.c | 4 | ||||
-rw-r--r-- | drivers/misc/mei/wd.c | 18 |
4 files changed, 17 insertions, 16 deletions
diff --git a/drivers/misc/mei/client.c b/drivers/misc/mei/client.c index 48813c27a47c..3e9cf0db5540 100644 --- a/drivers/misc/mei/client.c +++ b/drivers/misc/mei/client.c | |||
@@ -321,7 +321,7 @@ static inline bool mei_cl_cmp_id(const struct mei_cl *cl1, | |||
321 | } | 321 | } |
322 | 322 | ||
323 | /** | 323 | /** |
324 | * mei_io_list_flush - removes cbs belonging to cl. | 324 | * __mei_io_list_flush - removes and frees cbs belonging to cl. |
325 | * | 325 | * |
326 | * @list: an instance of our list structure | 326 | * @list: an instance of our list structure |
327 | * @cl: host client, can be NULL for flushing the whole list | 327 | * @cl: host client, can be NULL for flushing the whole list |
@@ -540,10 +540,11 @@ struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl) | |||
540 | return NULL; | 540 | return NULL; |
541 | } | 541 | } |
542 | 542 | ||
543 | /** mei_cl_link: allocate host id in the host map | 543 | /** |
544 | * mei_cl_link - allocate host id in the host map | ||
544 | * | 545 | * |
545 | * @cl - host client | 546 | * @cl: host client |
546 | * @id - fixed host id or -1 for generic one | 547 | * @id: fixed host id or -1 for generic one |
547 | * | 548 | * |
548 | * Return: 0 on success | 549 | * Return: 0 on success |
549 | * -EINVAL on incorrect values | 550 | * -EINVAL on incorrect values |
diff --git a/drivers/misc/mei/hw-txe.c b/drivers/misc/mei/hw-txe.c index 618ea721aca8..7abafe7d120d 100644 --- a/drivers/misc/mei/hw-txe.c +++ b/drivers/misc/mei/hw-txe.c | |||
@@ -412,7 +412,7 @@ static void mei_txe_intr_disable(struct mei_device *dev) | |||
412 | mei_txe_br_reg_write(hw, HIER_REG, 0); | 412 | mei_txe_br_reg_write(hw, HIER_REG, 0); |
413 | } | 413 | } |
414 | /** | 414 | /** |
415 | * mei_txe_intr_disable - enable all interrupts | 415 | * mei_txe_intr_enable - enable all interrupts |
416 | * | 416 | * |
417 | * @dev: the device structure | 417 | * @dev: the device structure |
418 | */ | 418 | */ |
diff --git a/drivers/misc/mei/pci-txe.c b/drivers/misc/mei/pci-txe.c index c86e2ddbe30a..dcfcba44b6f7 100644 --- a/drivers/misc/mei/pci-txe.c +++ b/drivers/misc/mei/pci-txe.c | |||
@@ -63,7 +63,7 @@ static void mei_txe_pci_iounmap(struct pci_dev *pdev, struct mei_txe_hw *hw) | |||
63 | } | 63 | } |
64 | } | 64 | } |
65 | /** | 65 | /** |
66 | * mei_probe - Device Initialization Routine | 66 | * mei_txe_probe - Device Initialization Routine |
67 | * | 67 | * |
68 | * @pdev: PCI device structure | 68 | * @pdev: PCI device structure |
69 | * @ent: entry in mei_txe_pci_tbl | 69 | * @ent: entry in mei_txe_pci_tbl |
@@ -193,7 +193,7 @@ end: | |||
193 | } | 193 | } |
194 | 194 | ||
195 | /** | 195 | /** |
196 | * mei_remove - Device Removal Routine | 196 | * mei_txe_remove - Device Removal Routine |
197 | * | 197 | * |
198 | * @pdev: PCI device structure | 198 | * @pdev: PCI device structure |
199 | * | 199 | * |
diff --git a/drivers/misc/mei/wd.c b/drivers/misc/mei/wd.c index 475f1dea45bf..ac1e6235692d 100644 --- a/drivers/misc/mei/wd.c +++ b/drivers/misc/mei/wd.c | |||
@@ -202,10 +202,10 @@ err: | |||
202 | return ret; | 202 | return ret; |
203 | } | 203 | } |
204 | 204 | ||
205 | /* | 205 | /** |
206 | * mei_wd_ops_start - wd start command from the watchdog core. | 206 | * mei_wd_ops_start - wd start command from the watchdog core. |
207 | * | 207 | * |
208 | * @wd_dev - watchdog device struct | 208 | * @wd_dev: watchdog device struct |
209 | * | 209 | * |
210 | * Return: 0 if success, negative errno code for failure | 210 | * Return: 0 if success, negative errno code for failure |
211 | */ | 211 | */ |
@@ -239,10 +239,10 @@ end_unlock: | |||
239 | return err; | 239 | return err; |
240 | } | 240 | } |
241 | 241 | ||
242 | /* | 242 | /** |
243 | * mei_wd_ops_stop - wd stop command from the watchdog core. | 243 | * mei_wd_ops_stop - wd stop command from the watchdog core. |
244 | * | 244 | * |
245 | * @wd_dev - watchdog device struct | 245 | * @wd_dev: watchdog device struct |
246 | * | 246 | * |
247 | * Return: 0 if success, negative errno code for failure | 247 | * Return: 0 if success, negative errno code for failure |
248 | */ | 248 | */ |
@@ -261,10 +261,10 @@ static int mei_wd_ops_stop(struct watchdog_device *wd_dev) | |||
261 | return 0; | 261 | return 0; |
262 | } | 262 | } |
263 | 263 | ||
264 | /* | 264 | /** |
265 | * mei_wd_ops_ping - wd ping command from the watchdog core. | 265 | * mei_wd_ops_ping - wd ping command from the watchdog core. |
266 | * | 266 | * |
267 | * @wd_dev - watchdog device struct | 267 | * @wd_dev: watchdog device struct |
268 | * | 268 | * |
269 | * Return: 0 if success, negative errno code for failure | 269 | * Return: 0 if success, negative errno code for failure |
270 | */ | 270 | */ |
@@ -311,11 +311,11 @@ end: | |||
311 | return ret; | 311 | return ret; |
312 | } | 312 | } |
313 | 313 | ||
314 | /* | 314 | /** |
315 | * mei_wd_ops_set_timeout - wd set timeout command from the watchdog core. | 315 | * mei_wd_ops_set_timeout - wd set timeout command from the watchdog core. |
316 | * | 316 | * |
317 | * @wd_dev - watchdog device struct | 317 | * @wd_dev: watchdog device struct |
318 | * @timeout - timeout value to set | 318 | * @timeout: timeout value to set |
319 | * | 319 | * |
320 | * Return: 0 if success, negative errno code for failure | 320 | * Return: 0 if success, negative errno code for failure |
321 | */ | 321 | */ |