Skip to content

Commit 8167d7f

Browse files
rddunlapvinodkoul
authored andcommitted
soundwire: sdw.h: repair names and format of kernel-doc comments
Fix all kernel-doc warnings in sdw.h: Warning: include/linux/soundwire/sdw.h:538 cannot understand function prototype: 'enum sdw_reg_bank' Warning: include/linux/soundwire/sdw.h:779 struct member 'port_num' not described in 'sdw_transport_params' Warning: include/linux/soundwire/sdw.h:792 struct member 'port_num' not described in 'sdw_enable_ch' Warning: include/linux/soundwire/sdw.h:892 cannot understand function prototype: 'struct sdw_port_config' Warning: include/linux/soundwire/sdw.h:906 cannot understand function prototype: 'struct sdw_stream_config' Warning: include/linux/soundwire/sdw.h:925 cannot understand function prototype: 'enum sdw_stream_state' Warning: include/linux/soundwire/sdw.h:942 cannot understand function prototype: 'struct sdw_stream_params' Warning: include/linux/soundwire/sdw.h:960 cannot understand function prototype: 'struct sdw_stream_runtime' Warning: include/linux/soundwire/sdw.h:1047 struct member 'bpt_stream_refcount' not described in 'sdw_bus' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Charles Keepax <ckeepax@opensource.cirrus.com> Link: https://patch.msgid.link/20260216054418.2766846-1-rdunlap@infradead.org Signed-off-by: Vinod Koul <vkoul@kernel.org>
1 parent 6de23f8 commit 8167d7f

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

  • include/linux/soundwire

include/linux/soundwire/sdw.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ struct sdw_slave_intr_status {
532532
};
533533

534534
/**
535-
* sdw_reg_bank - SoundWire register banks
535+
* enum sdw_reg_bank - SoundWire register banks
536536
* @SDW_BANK0: Soundwire register bank 0
537537
* @SDW_BANK1: Soundwire register bank 1
538538
*/
@@ -751,7 +751,7 @@ struct sdw_port_params {
751751
* struct sdw_transport_params: Data Port Transport Parameters
752752
*
753753
* @blk_grp_ctrl_valid: Port implements block group control
754-
* @num: Port number
754+
* @port_num: Port number
755755
* @blk_grp_ctrl: Block group control value
756756
* @sample_interval: Sample interval
757757
* @offset1: Blockoffset of the payload data
@@ -782,7 +782,7 @@ struct sdw_transport_params {
782782
/**
783783
* struct sdw_enable_ch: Enable/disable Data Port channel
784784
*
785-
* @num: Port number
785+
* @port_num: Port number
786786
* @ch_mask: Active channel mask
787787
* @enable: Enable (true) /disable (false) channel
788788
*/
@@ -885,7 +885,7 @@ void sdw_bus_master_delete(struct sdw_bus *bus);
885885
void sdw_show_ping_status(struct sdw_bus *bus, bool sync_delay);
886886

887887
/**
888-
* sdw_port_config: Master or Slave Port configuration
888+
* struct sdw_port_config: Master or Slave Port configuration
889889
*
890890
* @num: Port number
891891
* @ch_mask: channels mask for port
@@ -896,7 +896,7 @@ struct sdw_port_config {
896896
};
897897

898898
/**
899-
* sdw_stream_config: Master or Slave stream configuration
899+
* struct sdw_stream_config: Master or Slave stream configuration
900900
*
901901
* @frame_rate: Audio frame rate of the stream, in Hz
902902
* @ch_count: Channel count of the stream
@@ -913,7 +913,7 @@ struct sdw_stream_config {
913913
};
914914

915915
/**
916-
* sdw_stream_state: Stream states
916+
* enum sdw_stream_state: Stream states
917917
*
918918
* @SDW_STREAM_ALLOCATED: New stream allocated.
919919
* @SDW_STREAM_CONFIGURED: Stream configured
@@ -934,7 +934,7 @@ enum sdw_stream_state {
934934
};
935935

936936
/**
937-
* sdw_stream_params: Stream parameters
937+
* struct sdw_stream_params: Stream parameters
938938
*
939939
* @rate: Sampling frequency, in Hz
940940
* @ch_count: Number of channels
@@ -947,7 +947,7 @@ struct sdw_stream_params {
947947
};
948948

949949
/**
950-
* sdw_stream_runtime: Runtime stream parameters
950+
* struct sdw_stream_runtime: Runtime stream parameters
951951
*
952952
* @name: SoundWire stream name
953953
* @params: Stream parameters
@@ -983,7 +983,7 @@ struct sdw_stream_runtime {
983983
* @defer_msg: Defer message
984984
* @params: Current bus parameters
985985
* @stream_refcount: number of streams currently using this bus
986-
* @btp_stream_refcount: number of BTP streams currently using this bus (should
986+
* @bpt_stream_refcount: number of BTP streams currently using this bus (should
987987
* be zero or one, multiple streams per link is not supported).
988988
* @bpt_stream: pointer stored to handle BTP streams.
989989
* @ops: Master callback ops

0 commit comments

Comments
 (0)