Skip to content

Commit 6409292

Browse files
rddunlapvinodkoul
authored andcommitted
soundwire: bus.h: repair kernel-doc comments
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>
1 parent d08e4d9 commit 6409292

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

drivers/soundwire/bus.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ struct sdw_msg {
7373
};
7474

7575
/**
76-
* struct sdw_btp_section - Message section structure
76+
* struct sdw_bpt_section - Message section structure
7777
* @addr: Start Register address accessed in the Slave
7878
* @len: number of bytes to transfer. More than 64Kb can be transferred
7979
* but a practical limit of SDW_BPT_MSG_MAX_BYTES is enforced.
@@ -87,7 +87,7 @@ struct sdw_bpt_section {
8787
};
8888

8989
/**
90-
* struct sdw_btp_msg - Message structure
90+
* struct sdw_bpt_msg - Message structure
9191
* @sec: Pointer to array of sections
9292
* @sections: Number of sections in the array
9393
* @dev_num: Slave device number
@@ -110,7 +110,7 @@ int sdw_find_row_index(int row);
110110
int sdw_find_col_index(int col);
111111

112112
/**
113-
* sdw_port_runtime: Runtime port parameters for Master or Slave
113+
* struct sdw_port_runtime - Runtime port parameters for Master or Slave
114114
*
115115
* @num: Port number. For audio streams, valid port number ranges from
116116
* [1,14]
@@ -133,7 +133,7 @@ struct sdw_port_runtime {
133133
};
134134

135135
/**
136-
* sdw_slave_runtime: Runtime Stream parameters for Slave
136+
* struct sdw_slave_runtime - Runtime Stream parameters for Slave
137137
*
138138
* @slave: Slave handle
139139
* @direction: Data direction for Slave
@@ -151,7 +151,7 @@ struct sdw_slave_runtime {
151151
};
152152

153153
/**
154-
* sdw_master_runtime: Runtime stream parameters for Master
154+
* struct sdw_master_runtime - Runtime stream parameters for Master
155155
*
156156
* @bus: Bus handle
157157
* @stream: Stream runtime handle

0 commit comments

Comments
 (0)