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

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Randy Dunlap and committed by
Vinod Koul 8167d7f6 6de23f81

+9 -9
+9 -9
include/linux/soundwire/sdw.h
··· 532 532 }; 533 533 534 534 /** 535 - * sdw_reg_bank - SoundWire register banks 535 + * enum sdw_reg_bank - SoundWire register banks 536 536 * @SDW_BANK0: Soundwire register bank 0 537 537 * @SDW_BANK1: Soundwire register bank 1 538 538 */ ··· 751 751 * struct sdw_transport_params: Data Port Transport Parameters 752 752 * 753 753 * @blk_grp_ctrl_valid: Port implements block group control 754 - * @num: Port number 754 + * @port_num: Port number 755 755 * @blk_grp_ctrl: Block group control value 756 756 * @sample_interval: Sample interval 757 757 * @offset1: Blockoffset of the payload data ··· 782 782 /** 783 783 * struct sdw_enable_ch: Enable/disable Data Port channel 784 784 * 785 - * @num: Port number 785 + * @port_num: Port number 786 786 * @ch_mask: Active channel mask 787 787 * @enable: Enable (true) /disable (false) channel 788 788 */ ··· 885 885 void sdw_show_ping_status(struct sdw_bus *bus, bool sync_delay); 886 886 887 887 /** 888 - * sdw_port_config: Master or Slave Port configuration 888 + * struct sdw_port_config: Master or Slave Port configuration 889 889 * 890 890 * @num: Port number 891 891 * @ch_mask: channels mask for port ··· 896 896 }; 897 897 898 898 /** 899 - * sdw_stream_config: Master or Slave stream configuration 899 + * struct sdw_stream_config: Master or Slave stream configuration 900 900 * 901 901 * @frame_rate: Audio frame rate of the stream, in Hz 902 902 * @ch_count: Channel count of the stream ··· 913 913 }; 914 914 915 915 /** 916 - * sdw_stream_state: Stream states 916 + * enum sdw_stream_state: Stream states 917 917 * 918 918 * @SDW_STREAM_ALLOCATED: New stream allocated. 919 919 * @SDW_STREAM_CONFIGURED: Stream configured ··· 934 934 }; 935 935 936 936 /** 937 - * sdw_stream_params: Stream parameters 937 + * struct sdw_stream_params: Stream parameters 938 938 * 939 939 * @rate: Sampling frequency, in Hz 940 940 * @ch_count: Number of channels ··· 947 947 }; 948 948 949 949 /** 950 - * sdw_stream_runtime: Runtime stream parameters 950 + * struct sdw_stream_runtime: Runtime stream parameters 951 951 * 952 952 * @name: SoundWire stream name 953 953 * @params: Stream parameters ··· 983 983 * @defer_msg: Defer message 984 984 * @params: Current bus parameters 985 985 * @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 987 987 * be zero or one, multiple streams per link is not supported). 988 988 * @bpt_stream: pointer stored to handle BTP streams. 989 989 * @ops: Master callback ops