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

thunderbolt: Update dma_port.c function documentation

Make dma_port.c function documentation compliant with current kernel-doc
standards. No functional changes.

Signed-off-by: Alan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>

authored by

Alan Borzeszkowski and committed by
Mika Westerberg
a84be45d 12cb68e4

+16 -5
+16 -5
drivers/thunderbolt/dma_port.c
··· 197 197 * 198 198 * The DMA control port is functional also when the switch is in safe 199 199 * mode. 200 + * 201 + * Return: &struct tb_dma_port on success, %NULL otherwise. 200 202 */ 201 203 struct tb_dma_port *dma_port_alloc(struct tb_switch *sw) 202 204 { ··· 356 354 * @address: Address relative to the start of active region 357 355 * @buf: Buffer where the data is read 358 356 * @size: Size of the buffer 357 + * 358 + * Return: %0 on success, negative errno otherwise. 359 359 */ 360 360 int dma_port_flash_read(struct tb_dma_port *dma, unsigned int address, 361 361 void *buf, size_t size) ··· 376 372 * Writes block of data to the non-active flash region of the switch. If 377 373 * the address is given as %DMA_PORT_CSS_ADDRESS the block is written 378 374 * using CSS command. 375 + * 376 + * Return: %0 on success, negative errno otherwise. 379 377 */ 380 378 int dma_port_flash_write(struct tb_dma_port *dma, unsigned int address, 381 379 const void *buf, size_t size) ··· 399 393 * dma_port_flash_update_auth_status() to get status of this command. 400 394 * This is because if the switch in question is root switch the 401 395 * thunderbolt host controller gets reset as well. 396 + * 397 + * Return: %0 on success, negative errno otherwise. 402 398 */ 403 399 int dma_port_flash_update_auth(struct tb_dma_port *dma) 404 400 { ··· 418 410 * @status: Status code of the operation 419 411 * 420 412 * The function checks if there is status available from the last update 421 - * auth command. Returns %0 if there is no status and no further 422 - * action is required. If there is status, %1 is returned instead and 423 - * @status holds the failure code. 413 + * auth command. 424 414 * 425 - * Negative return means there was an error reading status from the 426 - * switch. 415 + * Return: 416 + * * %0 - If there is no status and no further action is required. 417 + * * %1 - If there is some status. @status holds the failure code. 418 + * * Negative errno - An error occurred when reading status from the 419 + * switch. 427 420 */ 428 421 int dma_port_flash_update_auth_status(struct tb_dma_port *dma, u32 *status) 429 422 { ··· 455 446 * @dma: DMA control port 456 447 * 457 448 * Triggers power cycle to the switch. 449 + * 450 + * Return: %0 on success, negative errno otherwise. 458 451 */ 459 452 int dma_port_power_cycle(struct tb_dma_port *dma) 460 453 {