mirrors/linux
2
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-08-31 14:04:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

soundwire: bus.h: repair kernel-doc comments

Browse Source 
Use the correct struct names (i.e., correct typos).
Use the struct keyword for structs as required.

Prevents 5 warnings:

Warning: drivers/soundwire/bus.h:86 expecting prototype for struct
  sdw_btp_section. Prototype was for struct sdw_bpt_section instead
Warning: drivers/soundwire/bus.h:100 expecting prototype for struct
  sdw_btp_msg. Prototype was for struct sdw_bpt_msg instead
Warning: drivers/soundwire/bus.h:125 cannot understand function prototype:
  'struct sdw_port_runtime'
Warning: drivers/soundwire/bus.h:144 cannot understand function prototype:
  'struct sdw_slave_runtime'
Warning: drivers/soundwire/bus.h:165 cannot understand function prototype:
  'struct sdw_master_runtime'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260715030719.757781-1-rdunlap@infradead.org
Signed-off-by: Vinod Koul <vkoul@kernel.org>
This commit is contained in:
Randy Dunlap
2026-07-14 20:07:19 -07:00
committed by Vinod Koul
parent d08e4d9197
commit 6409292ab5
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
drivers/soundwire/bus.h
View File

@@ -73,7 +73,7 @@ struct sdw_msg {
};
/**
* struct sdw_btp_section - Message section structure
* struct sdw_bpt_section - Message section structure
* @addr: Start Register address accessed in the Slave
* @len: number of bytes to transfer. More than 64Kb can be transferred
* but a practical limit of SDW_BPT_MSG_MAX_BYTES is enforced.
@@ -87,7 +87,7 @@ struct sdw_bpt_section {
};
/**
* struct sdw_btp_msg - Message structure
* struct sdw_bpt_msg - Message structure
* @sec: Pointer to array of sections
* @sections: Number of sections in the array
* @dev_num: Slave device number
@@ -110,7 +110,7 @@ int sdw_find_row_index(int row);
int sdw_find_col_index(int col);
/**
* sdw_port_runtime: Runtime port parameters for Master or Slave
* struct sdw_port_runtime - Runtime port parameters for Master or Slave
*
* @num: Port number. For audio streams, valid port number ranges from
* [1,14]
@@ -133,7 +133,7 @@ struct sdw_port_runtime {
};
/**
* sdw_slave_runtime: Runtime Stream parameters for Slave
* struct sdw_slave_runtime - Runtime Stream parameters for Slave
*
* @slave: Slave handle
* @direction: Data direction for Slave
@@ -151,7 +151,7 @@ struct sdw_slave_runtime {
};
/**
* sdw_master_runtime: Runtime stream parameters for Master
* struct sdw_master_runtime - Runtime stream parameters for Master
*
* @bus: Bus handle
* @stream: Stream runtime handle