Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

rapidio/tsi721: fix kernel-doc warnings

Correct kernel-doc comments in tsi721.c and tsi721_dma.c to prevent
warnings from scripts/kernel-doc.

tsi721_dma.c:293: warning: expecting prototype for tsi721_omsg_msix(). Prototype was for tsi721_bdma_msix() instead

tsi721.c:215: warning: Function parameter or member 'data' not described in 'tsi721_cread_dma'
tsi721.c:215: warning: Excess function parameter 'val' description in 'tsi721_cread_dma'
tsi721.c:238: warning: Function parameter or member 'data' not described in 'tsi721_cwrite_dma'
tsi721.c:238: warning: Excess function parameter 'val' description in 'tsi721_cwrite_dma'
tsi721.c:2548: warning: Function parameter or member 'attr' not described in 'tsi721_query_mport'
tsi721.c:2548: warning: Excess function parameter 'mbox' description in 'tsi721_query_mport'
and 27 warnings like this one:
tsi721.c:59: warning: No description found for return value of 'tsi721_lcread'

Link: https://lkml.kernel.org/r/20231206175528.16386-1-rdunlap@infradead.org
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Matt Porter <mporter@kernel.crashing.org>
Cc: Alexandre Bounine <alex.bou9@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Randy Dunlap and committed by
Andrew Morton
4600c4bc 0df52582

+55 -16
+52 -15
drivers/rapidio/devices/tsi721.c
··· 51 51 * @len: Length (in bytes) of the maintenance transaction 52 52 * @data: Value to be read into 53 53 * 54 - * Generates a local SREP space read. Returns %0 on 55 - * success or %-EINVAL on failure. 54 + * Generates a local SREP space read. 55 + * 56 + * Returns: %0 on success or %-EINVAL on failure. 56 57 */ 57 58 static int tsi721_lcread(struct rio_mport *mport, int index, u32 offset, 58 59 int len, u32 *data) ··· 76 75 * @len: Length (in bytes) of the maintenance transaction 77 76 * @data: Value to be written 78 77 * 79 - * Generates a local write into SREP configuration space. Returns %0 on 80 - * success or %-EINVAL on failure. 78 + * Generates a local write into SREP configuration space. 79 + * 80 + * Returns: %0 on success or %-EINVAL on failure. 81 81 */ 82 82 static int tsi721_lcwrite(struct rio_mport *mport, int index, u32 offset, 83 83 int len, u32 data) ··· 106 104 * @do_wr: Operation flag (1 == MAINT_WR) 107 105 * 108 106 * Generates a RapidIO maintenance transaction (Read or Write). 109 - * Returns %0 on success and %-EINVAL or %-EFAULT on failure. 107 + * Returns: %0 on success and %-EINVAL or %-EFAULT on failure. 110 108 */ 111 109 static int tsi721_maint_dma(struct tsi721_device *priv, u32 sys_size, 112 110 u16 destid, u8 hopcount, u32 offset, int len, ··· 207 205 * @hopcount: Number of hops to target device 208 206 * @offset: Offset into configuration space 209 207 * @len: Length (in bytes) of the maintenance transaction 210 - * @val: Location to be read into 208 + * @data: Location to be read into 211 209 * 212 210 * Generates a RapidIO maintenance read transaction. 213 - * Returns %0 on success and %-EINVAL or %-EFAULT on failure. 211 + * Returns: %0 on success and %-EINVAL or %-EFAULT on failure. 214 212 */ 215 213 static int tsi721_cread_dma(struct rio_mport *mport, int index, u16 destid, 216 214 u8 hopcount, u32 offset, int len, u32 *data) ··· 230 228 * @hopcount: Number of hops to target device 231 229 * @offset: Offset into configuration space 232 230 * @len: Length (in bytes) of the maintenance transaction 233 - * @val: Value to be written 231 + * @data: Value to be written 234 232 * 235 233 * Generates a RapidIO maintenance write transaction. 236 - * Returns %0 on success and %-EINVAL or %-EFAULT on failure. 234 + * Returns: %0 on success and %-EINVAL or %-EFAULT on failure. 237 235 */ 238 236 static int tsi721_cwrite_dma(struct rio_mport *mport, int index, u16 destid, 239 237 u8 hopcount, u32 offset, int len, u32 data) ··· 252 250 * Handles inbound port-write interrupts. Copies PW message from an internal 253 251 * buffer into PW message FIFO and schedules deferred routine to process 254 252 * queued messages. 253 + * 254 + * Returns: %0 255 255 */ 256 256 static int 257 257 tsi721_pw_handler(struct tsi721_device *priv) ··· 311 307 * tsi721_pw_enable - enable/disable port-write interface init 312 308 * @mport: Master port implementing the port write unit 313 309 * @enable: 1=enable; 0=disable port-write message handling 310 + * 311 + * Returns: %0 314 312 */ 315 313 static int tsi721_pw_enable(struct rio_mport *mport, int enable) 316 314 { ··· 342 336 * @destid: Destination ID of target device 343 337 * @data: 16-bit info field of RapidIO doorbell 344 338 * 345 - * Sends a RapidIO doorbell message. Always returns %0. 339 + * Sends a RapidIO doorbell message. 340 + * 341 + * Returns: %0 346 342 */ 347 343 static int tsi721_dsend(struct rio_mport *mport, int index, 348 344 u16 destid, u16 data) ··· 369 361 * Handles inbound doorbell interrupts. Copies doorbell entry from an internal 370 362 * buffer into DB message FIFO and schedules deferred routine to process 371 363 * queued DBs. 364 + * 365 + * Returns: %0 372 366 */ 373 367 static int 374 368 tsi721_dbell_handler(struct tsi721_device *priv) ··· 463 453 * 464 454 * Handles Tsi721 interrupts signaled using MSI and INTA. Checks reported 465 455 * interrupt events and calls an event-specific handler(s). 456 + * 457 + * Returns: %IRQ_HANDLED or %IRQ_NONE 466 458 */ 467 459 static irqreturn_t tsi721_irqhandler(int irq, void *ptr) 468 460 { ··· 619 607 * @ptr: Pointer to interrupt-specific data (tsi721_device structure) 620 608 * 621 609 * Handles outbound messaging interrupts signaled using MSI-X. 610 + * 611 + * Returns: %IRQ_HANDLED 622 612 */ 623 613 static irqreturn_t tsi721_omsg_msix(int irq, void *ptr) 624 614 { ··· 638 624 * @ptr: Pointer to interrupt-specific data (tsi721_device structure) 639 625 * 640 626 * Handles inbound messaging interrupts signaled using MSI-X. 627 + * 628 + * Returns: %IRQ_HANDLED 641 629 */ 642 630 static irqreturn_t tsi721_imsg_msix(int irq, void *ptr) 643 631 { ··· 657 641 * @ptr: Pointer to interrupt-specific data (tsi721_device structure) 658 642 * 659 643 * Handles Tsi721 interrupts from SRIO MAC. 644 + * 645 + * Returns: %IRQ_HANDLED 660 646 */ 661 647 static irqreturn_t tsi721_srio_msix(int irq, void *ptr) 662 648 { ··· 681 663 * Handles Tsi721 interrupts from SR2PC Channel. 682 664 * NOTE: At this moment services only one SR2PC channel associated with inbound 683 665 * doorbells. 666 + * 667 + * Returns: %IRQ_HANDLED 684 668 */ 685 669 static irqreturn_t tsi721_sr2pc_ch_msix(int irq, void *ptr) 686 670 { ··· 709 689 * Registers MSI-X interrupt service routines for interrupts that are active 710 690 * immediately after mport initialization. Messaging interrupt service routines 711 691 * should be registered during corresponding open requests. 692 + * 693 + * Returns: %0 on success or -errno value on failure. 712 694 */ 713 695 static int tsi721_request_msix(struct tsi721_device *priv) 714 696 { ··· 739 717 * 740 718 * Configures MSI-X support for Tsi721. Supports only an exact number 741 719 * of requested vectors. 720 + * 721 + * Returns: %0 on success or -errno value on failure. 742 722 */ 743 723 static int tsi721_enable_msix(struct tsi721_device *priv) 744 724 { ··· 1358 1334 * @priv: pointer to tsi721 private data 1359 1335 * 1360 1336 * Initializes inbound port write handler. 1361 - * Returns %0 on success or %-ENOMEM on failure. 1337 + * Returns: %0 on success or %-ENOMEM on failure. 1362 1338 */ 1363 1339 static int tsi721_port_write_init(struct tsi721_device *priv) 1364 1340 { ··· 1436 1412 * 1437 1413 * Initialize BDMA channel allocated for RapidIO maintenance read/write 1438 1414 * request generation 1439 - * Returns %0 on success or %-ENOMEM on failure. 1415 + * 1416 + * Returns: %0 on success or %-ENOMEM on failure. 1440 1417 */ 1441 1418 static int tsi721_bdma_maint_init(struct tsi721_device *priv) 1442 1419 { ··· 1687 1662 * @mbox: Outbound mailbox 1688 1663 * @buffer: Message to add to outbound queue 1689 1664 * @len: Length of message 1665 + * 1666 + * Returns: %0 on success or -errno value on failure. 1690 1667 */ 1691 1668 static int 1692 1669 tsi721_add_outb_message(struct rio_mport *mport, struct rio_dev *rdev, int mbox, ··· 1896 1869 * @dev_id: Device specific pointer to pass on event 1897 1870 * @mbox: Mailbox to open 1898 1871 * @entries: Number of entries in the outbound mailbox ring 1872 + * 1873 + * Returns: %0 on success or -errno value on failure. 1899 1874 */ 1900 1875 static int tsi721_open_outb_mbox(struct rio_mport *mport, void *dev_id, 1901 1876 int mbox, int entries) ··· 2185 2156 * @dev_id: Device specific pointer to pass on event 2186 2157 * @mbox: Mailbox to open 2187 2158 * @entries: Number of entries in the inbound mailbox ring 2159 + * 2160 + * Returns: %0 on success or -errno value on failure. 2188 2161 */ 2189 2162 static int tsi721_open_inb_mbox(struct rio_mport *mport, void *dev_id, 2190 2163 int mbox, int entries) ··· 2440 2409 * @mport: Master port implementing the Inbound Messaging Engine 2441 2410 * @mbox: Inbound mailbox number 2442 2411 * @buf: Buffer to add to inbound queue 2412 + * 2413 + * Returns: %0 on success or -errno value on failure. 2443 2414 */ 2444 2415 static int tsi721_add_inb_buffer(struct rio_mport *mport, int mbox, void *buf) 2445 2416 { ··· 2472 2439 * @mport: Master port implementing the Inbound Messaging Engine 2473 2440 * @mbox: Inbound mailbox number 2474 2441 * 2475 - * Returns pointer to the message on success or NULL on failure. 2442 + * Returns: pointer to the message on success or %NULL on failure. 2476 2443 */ 2477 2444 static void *tsi721_get_inb_message(struct rio_mport *mport, int mbox) 2478 2445 { ··· 2540 2507 * @priv: pointer to tsi721 private data 2541 2508 * 2542 2509 * Configures Tsi721 messaging engine. 2510 + * 2511 + * Returns: %0 2543 2512 */ 2544 2513 static int tsi721_messages_init(struct tsi721_device *priv) 2545 2514 { ··· 2574 2539 /** 2575 2540 * tsi721_query_mport - Fetch inbound message from the Tsi721 MSG Queue 2576 2541 * @mport: Master port implementing the Inbound Messaging Engine 2577 - * @mbox: Inbound mailbox number 2542 + * @attr: mport device attributes 2578 2543 * 2579 - * Returns pointer to the message on success or NULL on failure. 2544 + * Returns: pointer to the message on success or %NULL on failure. 2580 2545 */ 2581 2546 static int tsi721_query_mport(struct rio_mport *mport, 2582 2547 struct rio_mport_attr *attr) ··· 2688 2653 * @priv: pointer to tsi721 private data 2689 2654 * 2690 2655 * Configures Tsi721 as RapidIO master port. 2656 + * 2657 + * Returns: %0 on success or -errno value on failure. 2691 2658 */ 2692 2659 static int tsi721_setup_mport(struct tsi721_device *priv) 2693 2660 {
+3 -1
drivers/rapidio/devices/tsi721_dma.c
··· 283 283 284 284 #ifdef CONFIG_PCI_MSI 285 285 /** 286 - * tsi721_omsg_msix - MSI-X interrupt handler for BDMA channels 286 + * tsi721_bdma_msix - MSI-X interrupt handler for BDMA channels 287 287 * @irq: Linux interrupt number 288 288 * @ptr: Pointer to interrupt-specific data (BDMA channel structure) 289 289 * 290 290 * Handles BDMA channel interrupts signaled using MSI-X. 291 + * 292 + * Returns: %IRQ_HANDLED 291 293 */ 292 294 static irqreturn_t tsi721_bdma_msix(int irq, void *ptr) 293 295 {