Commit 23ea8945 authored by Gerrit Renker's avatar Gerrit Renker Committed by David S. Miller
Browse files

[CCID 3]: Add annotations for socket structures 



This adds documentation to the CCID 3 rx/tx socket fields, plus some
minor re-formatting.

Signed-off-by: default avatarGerrit Renker <gerrit@erg.abdn.ac.uk>
Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@mandriva.com>
parent 59348b19

net/dccp/ccids/ccid3.h

+55 −35
Original line number Diff line number Diff line
@@ -81,25 +81,27 @@ enum ccid3_hc_tx_states { 
	TFRC_SSTATE_TERM,

};



/** struct ccid3_hc_tx_sock - CCID3 sender half connection sock

/** struct ccid3_hc_tx_sock - CCID3 sender half-connection socket

 *

  * @ccid3hctx_state - Sender state

 * @ccid3hctx_x - Current sending rate

 * @ccid3hctx_x_recv - Receive rate

  * @ccid3hctx_x_calc - Calculated send (?) rate

  * @ccid3hctx_s - Packet size

 * @ccid3hctx_x_calc - Calculated send rate (RFC 3448, 3.1)

 * @ccid3hctx_rtt - Estimate of current round trip time in usecs

  * @@ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000

 * @ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000

 * @ccid3hctx_s - Packet size

 * @ccid3hctx_t_rto - Retransmission Timeout (RFC 3448, 3.1)

 * @ccid3hctx_t_ipi - Interpacket (send) interval (RFC 3448, 4.6)

 * @ccid3hctx_state - Sender state, one of %ccid3_hc_tx_states

 * @ccid3hctx_last_win_count - Last window counter sent

 * @ccid3hctx_t_last_win_count - Timestamp of earliest packet

 * 				 with last_win_count value sent

 * @ccid3hctx_no_feedback_timer - Handle to no feedback timer

  * @ccid3hctx_idle - FIXME

 * @ccid3hctx_idle - Flag indicating that sender is idling

 * @ccid3hctx_t_ld - Time last doubled during slow start

 * @ccid3hctx_t_nom - Nominal send time of next packet

  * @ccid3hctx_t_ipi - Interpacket (send) interval

 * @ccid3hctx_delta - Send timer delta

 * @ccid3hctx_hist - Packet history

 * @ccid3hctx_options_received - Parsed set of retrieved options

 */

struct ccid3_hc_tx_sock {

	struct tfrc_tx_info		ccid3hctx_tfrc;
@@ -130,6 +132,24 @@ enum ccid3_hc_rx_states { 
	TFRC_RSTATE_TERM    = 127,

};



/** struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket

 *

 *  @ccid3hcrx_x_recv  -  Receiver estimate of send rate (RFC 3448 4.3)

 *  @ccid3hcrx_rtt  -  Receiver estimate of rtt (non-standard)

 *  @ccid3hcrx_p  -  current loss event rate (RFC 3448 5.4)

 *  @ccid3hcrx_seqno_nonloss  -  Last received non-loss sequence number

 *  @ccid3hcrx_ccval_nonloss  -  Last received non-loss Window CCVal

 *  @ccid3hcrx_ccval_last_counter  -  Tracks window counter (RFC 4342, 8.1)

 *  @ccid3hcrx_state  -  receiver state, one of %ccid3_hc_rx_states

 *  @ccid3hcrx_bytes_recv  -  Total sum of DCCP payload bytes

 *  @ccid3hcrx_tstamp_last_feedback  -  Time at which last feedback was sent

 *  @ccid3hcrx_tstamp_last_ack  -  Time at which last feedback was sent

 *  @ccid3hcrx_hist  -  Packet history

 *  @ccid3hcrx_li_hist  -  Loss Interval History

 *  @ccid3hcrx_s  -  Received packet size in bytes

 *  @ccid3hcrx_pinv  -  Inverse of Loss Event Rate (RFC 4342, sec. 8.5)

 *  @ccid3hcrx_elapsed_time  -  Time since packet reception

 */

struct ccid3_hc_rx_sock {

	struct tfrc_rx_info		ccid3hcrx_tfrc;

#define ccid3hcrx_x_recv		ccid3hcrx_tfrc.tfrcrx_x_recv