github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-07 06:17:02 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

net: dccp: uapi: clean up kernel-doc comments

Browse Source 
Use correct kernel-doc format for struct members and add comments for
missing struct members (dccph_seq2 and reserved).

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20261011032800.278870-1-rdunlap@infradead.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Randy Dunlap 2026-10-10 20:28:00 -07:00 committed by Jakub Kicinski
parent 1800f27a5e
commit 8241cd8ebe
1 changed files with 23 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
include/uapi/linux/dccp.h
View File

@ -8,15 +8,19 @@
/**
* struct dccp_hdr - generic part of DCCP packet header
*
* @dccph_sport - Relevant port on the endpoint that sent this packet
* @dccph_dport - Relevant port on the other endpoint
* @dccph_doff - Data Offset from the start of the DCCP header, in 32-bit words
* @dccph_ccval - Used by the HC-Sender CCID
* @dccph_cscov - Parts of the packet that are covered by the Checksum field
* @dccph_checksum - Internet checksum, depends on dccph_cscov
* @dccph_x - 0 = 24 bit sequence number, 1 = 48
* @dccph_type - packet type, see DCCP_PKT_ prefixed macros
* @dccph_seq - sequence number high or low order 24 bits, depends on dccph_x
* @dccph_sport: Relevant port on the endpoint that sent this packet
* @dccph_dport: Relevant port on the other endpoint
* @dccph_doff: Data Offset from the start of the DCCP header, in 32-bit words
* @dccph_ccval: Used by the HC-Sender CCID
* @dccph_cscov: Parts of the packet that are covered by the Checksum field
* @dccph_checksum: Internet checksum, depends on dccph_cscov
* @dccph_x: 0 = 24 bit sequence number, 1 = 48
* @dccph_type: packet type, see DCCP_PKT_ prefixed macros
* @dccph_reserved: reserved bits
* @dccph_seq: sequence number high or low order lower 16 bits,
* depends on dccph_x
* @dccph_seq2: sequence number high or low order upper 8 bits,
* depends on dccph_x
*/
struct dccp_hdr {
__be16 dccph_sport,
@ -50,7 +54,7 @@ struct dccp_hdr {
/**
* struct dccp_hdr_ext - the low bits of a 48 bit seq packet
*
* @dccph_seq_low - low 24 bits of a 48 bit seq packet
* @dccph_seq_low: low 24 bits of a 48 bit seq packet
*/
struct dccp_hdr_ext {
__be32 dccph_seq_low;
@ -59,7 +63,7 @@ struct dccp_hdr_ext {
/**
* struct dccp_hdr_request - Connection initiation request header
*
* @dccph_req_service - Service to which the client app wants to connect
* @dccph_req_service: Service to which the client app wants to connect
*/
struct dccp_hdr_request {
__be32 dccph_req_service;
@ -67,8 +71,9 @@ struct dccp_hdr_request {
/**
* struct dccp_hdr_ack_bits - acknowledgment bits common to most packets
*
* @dccph_resp_ack_nr_high - 48 bit ack number high order bits, contains GSR
* @dccph_resp_ack_nr_low - 48 bit ack number low order bits, contains GSR
* @dccph_reserved1: reserved bits
* @dccph_ack_nr_high: 48 bit ack number high order bits, contains GSR
* @dccph_ack_nr_low: 48 bit ack number low order bits, contains GSR
*/
struct dccp_hdr_ack_bits {
__be16 dccph_reserved1;
@ -78,8 +83,8 @@ struct dccp_hdr_ack_bits {
/**
* struct dccp_hdr_response - Connection initiation response header
*
* @dccph_resp_ack - 48 bit Acknowledgment Number Subheader (5.3)
* @dccph_resp_service - Echoes the Service Code on a received DCCP-Request
* @dccph_resp_ack: 48 bit Acknowledgment Number Subheader (5.3)
* @dccph_resp_service: Echoes the Service Code on a received DCCP-Request
*/
struct dccp_hdr_response {
struct dccp_hdr_ack_bits dccph_resp_ack;
@ -89,9 +94,9 @@ struct dccp_hdr_response {
/**
* struct dccp_hdr_reset - Unconditionally shut down a connection
*
* @dccph_reset_ack - 48 bit Acknowledgment Number Subheader (5.6)
* @dccph_reset_code - one of %dccp_reset_codes
* @dccph_reset_data - the Data 1 ... Data 3 fields from 5.6
* @dccph_reset_ack: 48 bit Acknowledgment Number Subheader (5.6)
* @dccph_reset_code: one of %dccp_reset_codes
* @dccph_reset_data: the Data 1 ... Data 3 fields from 5.6
*/
struct dccp_hdr_reset {
struct dccp_hdr_ack_bits dccph_reset_ack;