Commit d0b1101b authored by Andrew Lunn's avatar Andrew Lunn Committed by David S. Miller

net: dccp: kerneldoc fixes

Simple fixes which require no deep knowledge of the code.

Cc: Gerrit Renker <gerrit@erg.abdn.ac.uk>
Signed-off-by: default avatarAndrew Lunn <andrew@lunn.ch>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 8842500d
...@@ -365,6 +365,7 @@ void tfrc_rx_hist_purge(struct tfrc_rx_hist *h) ...@@ -365,6 +365,7 @@ void tfrc_rx_hist_purge(struct tfrc_rx_hist *h)
/** /**
* tfrc_rx_hist_rtt_last_s - reference entry to compute RTT samples against * tfrc_rx_hist_rtt_last_s - reference entry to compute RTT samples against
* @h: The non-empty RX history object
*/ */
static inline struct tfrc_rx_hist_entry * static inline struct tfrc_rx_hist_entry *
tfrc_rx_hist_rtt_last_s(const struct tfrc_rx_hist *h) tfrc_rx_hist_rtt_last_s(const struct tfrc_rx_hist *h)
...@@ -374,6 +375,7 @@ static inline struct tfrc_rx_hist_entry * ...@@ -374,6 +375,7 @@ static inline struct tfrc_rx_hist_entry *
/** /**
* tfrc_rx_hist_rtt_prev_s - previously suitable (wrt rtt_last_s) RTT-sampling entry * tfrc_rx_hist_rtt_prev_s - previously suitable (wrt rtt_last_s) RTT-sampling entry
* @h: The non-empty RX history object
*/ */
static inline struct tfrc_rx_hist_entry * static inline struct tfrc_rx_hist_entry *
tfrc_rx_hist_rtt_prev_s(const struct tfrc_rx_hist *h) tfrc_rx_hist_rtt_prev_s(const struct tfrc_rx_hist *h)
......
...@@ -165,6 +165,8 @@ static const struct { ...@@ -165,6 +165,8 @@ static const struct {
/** /**
* dccp_feat_index - Hash function to map feature number into array position * dccp_feat_index - Hash function to map feature number into array position
* @feat_num: feature to hash, one of %dccp_feature_numbers
*
* Returns consecutive array index or -1 if the feature is not understood. * Returns consecutive array index or -1 if the feature is not understood.
*/ */
static int dccp_feat_index(u8 feat_num) static int dccp_feat_index(u8 feat_num)
...@@ -567,6 +569,8 @@ int dccp_feat_clone_list(struct list_head const *from, struct list_head *to) ...@@ -567,6 +569,8 @@ int dccp_feat_clone_list(struct list_head const *from, struct list_head *to)
/** /**
* dccp_feat_valid_nn_length - Enforce length constraints on NN options * dccp_feat_valid_nn_length - Enforce length constraints on NN options
* @feat_num: feature to return length of, one of %dccp_feature_numbers
*
* Length is between 0 and %DCCP_OPTVAL_MAXLEN. Used for outgoing packets only, * Length is between 0 and %DCCP_OPTVAL_MAXLEN. Used for outgoing packets only,
* incoming options are accepted as long as their values are valid. * incoming options are accepted as long as their values are valid.
*/ */
...@@ -1429,6 +1433,8 @@ int dccp_feat_parse_options(struct sock *sk, struct dccp_request_sock *dreq, ...@@ -1429,6 +1433,8 @@ int dccp_feat_parse_options(struct sock *sk, struct dccp_request_sock *dreq,
/** /**
* dccp_feat_init - Seed feature negotiation with host-specific defaults * dccp_feat_init - Seed feature negotiation with host-specific defaults
* @sk: Socket to initialize.
*
* This initialises global defaults, depending on the value of the sysctls. * This initialises global defaults, depending on the value of the sysctls.
* These can later be overridden by registering changes via setsockopt calls. * These can later be overridden by registering changes via setsockopt calls.
* The last link in the chain is finalise_settings, to make sure that between * The last link in the chain is finalise_settings, to make sure that between
......
...@@ -715,6 +715,7 @@ EXPORT_SYMBOL_GPL(dccp_rcv_state_process); ...@@ -715,6 +715,7 @@ EXPORT_SYMBOL_GPL(dccp_rcv_state_process);
/** /**
* dccp_sample_rtt - Validate and finalise computation of RTT sample * dccp_sample_rtt - Validate and finalise computation of RTT sample
* @sk: socket structure
* @delta: number of microseconds between packet and acknowledgment * @delta: number of microseconds between packet and acknowledgment
* *
* The routine is kept generic to work in different contexts. It should be * The routine is kept generic to work in different contexts. It should be
......
...@@ -694,6 +694,8 @@ EXPORT_SYMBOL_GPL(dccp_v4_do_rcv); ...@@ -694,6 +694,8 @@ EXPORT_SYMBOL_GPL(dccp_v4_do_rcv);
/** /**
* dccp_invalid_packet - check for malformed packets * dccp_invalid_packet - check for malformed packets
* @skb: Packet to validate
*
* Implements RFC 4340, 8.5: Step 1: Check header basics * Implements RFC 4340, 8.5: Step 1: Check header basics
* Packets that fail these checks are ignored and do not receive Resets. * Packets that fail these checks are ignored and do not receive Resets.
*/ */
......
...@@ -43,6 +43,7 @@ u64 dccp_decode_value_var(const u8 *bf, const u8 len) ...@@ -43,6 +43,7 @@ u64 dccp_decode_value_var(const u8 *bf, const u8 len)
* dccp_parse_options - Parse DCCP options present in @skb * dccp_parse_options - Parse DCCP options present in @skb
* @sk: client|server|listening dccp socket (when @dreq != NULL) * @sk: client|server|listening dccp socket (when @dreq != NULL)
* @dreq: request socket to use during connection setup, or NULL * @dreq: request socket to use during connection setup, or NULL
* @skb: frame to parse
*/ */
int dccp_parse_options(struct sock *sk, struct dccp_request_sock *dreq, int dccp_parse_options(struct sock *sk, struct dccp_request_sock *dreq,
struct sk_buff *skb) struct sk_buff *skb)
...@@ -471,6 +472,8 @@ static int dccp_insert_option_ackvec(struct sock *sk, struct sk_buff *skb) ...@@ -471,6 +472,8 @@ static int dccp_insert_option_ackvec(struct sock *sk, struct sk_buff *skb)
/** /**
* dccp_insert_option_mandatory - Mandatory option (5.8.2) * dccp_insert_option_mandatory - Mandatory option (5.8.2)
* @skb: frame into which to insert option
*
* Note that since we are using skb_push, this function needs to be called * Note that since we are using skb_push, this function needs to be called
* _after_ inserting the option it is supposed to influence (stack order). * _after_ inserting the option it is supposed to influence (stack order).
*/ */
...@@ -486,6 +489,7 @@ int dccp_insert_option_mandatory(struct sk_buff *skb) ...@@ -486,6 +489,7 @@ int dccp_insert_option_mandatory(struct sk_buff *skb)
/** /**
* dccp_insert_fn_opt - Insert single Feature-Negotiation option into @skb * dccp_insert_fn_opt - Insert single Feature-Negotiation option into @skb
* @skb: frame to insert feature negotiation option into
* @type: %DCCPO_CHANGE_L, %DCCPO_CHANGE_R, %DCCPO_CONFIRM_L, %DCCPO_CONFIRM_R * @type: %DCCPO_CHANGE_L, %DCCPO_CHANGE_R, %DCCPO_CONFIRM_L, %DCCPO_CONFIRM_R
* @feat: one out of %dccp_feature_numbers * @feat: one out of %dccp_feature_numbers
* @val: NN value or SP array (preferred element first) to copy * @val: NN value or SP array (preferred element first) to copy
......
...@@ -216,6 +216,8 @@ static void dccp_delack_timer(struct timer_list *t) ...@@ -216,6 +216,8 @@ static void dccp_delack_timer(struct timer_list *t)
/** /**
* dccp_write_xmitlet - Workhorse for CCID packet dequeueing interface * dccp_write_xmitlet - Workhorse for CCID packet dequeueing interface
* @data: Socket to act on
*
* See the comments above %ccid_dequeueing_decision for supported modes. * See the comments above %ccid_dequeueing_decision for supported modes.
*/ */
static void dccp_write_xmitlet(unsigned long data) static void dccp_write_xmitlet(unsigned long data)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment