Change in osmo-bsc[master]: gsm_data.h: add comments about immutable activ/modif/assign request info

[neels]

neels has submitted this change. ( https://gerrit.osmocom.org/c/osmo-bsc/+/24611 )

Change subject: gsm_data.h: add comments about immutable activ/modif/assign request info
......................................................................

gsm_data.h: add comments about immutable activ/modif/assign request info

Change-Id: I7997b802d997073ae6a05db2f40e82cb8e83764f
---
M include/osmocom/bsc/gsm_data.h
1 file changed, 18 insertions(+), 0 deletions(-)

Approvals:
  Jenkins Builder: Verified
  pespin: Looks good to me, but someone else must approve
  laforge: Looks good to me, approved



diff --git a/include/osmocom/bsc/gsm_data.h b/include/osmocom/bsc/gsm_data.h
index dccf5a1..d3d5b7d 100644
--- a/include/osmocom/bsc/gsm_data.h
+++ b/include/osmocom/bsc/gsm_data.h
@@ -177,7 +177,13 @@
  * currently used lchan and gscon unmodified until the outcome of an Assignment is known. If the Assignment fails, this
  * state is simply discarded, and the gscon carries on with the original lchan remaining unchanged. */
 struct assignment_fsm_data {
+	/* The request as made by the caller, see GSCON_EV_ASSIGNMENT_START or reassignment_request_to_lchan() /
+	 * reassignment_request_to_chan_type().
+	 * conn->assignment.req is treated immutable: remains unchanged throughout the Assignment. The mutable fields
+	 * are below: choices and automatic adjustments are stored in conn->assignment.*, not conn->assignment.req.
+	 */
 	struct assignment_request req;
+
 	bool requires_voice_stream;
 	struct channel_mode_and_rate selected_ch_mode_rate;
 
@@ -647,7 +653,13 @@
 	struct osmo_mgcpc_ep_ci *mgw_endpoint_ci_bts;
 
 	struct {
+		/* The request as made by the caller, see lchan_activate().
+		 * lchan->activate.info is treated immutable: remains unchanged throughout the Activation.
+		 * The mutable versions are below: some values need automatic adjustments, in which case they are copied
+		 * from immutable lchan->activate.info.* to lchan->activate.*, for example lchan->activate.ch_mode_rate
+		 * is initially a copy of lchan->activate.info.ch_mode_rate, and is possibly adjusted afterwards. */
 		struct lchan_activate_info info;
+
 		struct channel_mode_and_rate ch_mode_rate;
 		struct gsm48_multi_rate_conf mr_conf_filtered;
 		bool activ_ack; /*< true as soon as RSL Chan Activ Ack is received */
@@ -662,7 +674,13 @@
 	} activate;
 
 	struct {
+		/* The request as made by the caller, see lchan_mode_modify().
+		 * lchan->modify.info is treated immutable: remains unchanged throughout the Mode Modify.
+		 * The mutable versions are below: some values need automatic adjustments, in which case they are copied
+		 * from immutable lchan->modify.info.* to lchan->modify.*, for example lchan->modify.ch_mode_rate
+		 * is initially a copy of lchan->modify.info.ch_mode_rate, and is possibly adjusted afterwards. */
 		struct lchan_modify_info info;
+
 		struct channel_mode_and_rate ch_mode_rate;
 		struct gsm48_multi_rate_conf mr_conf_filtered;
 		int tsc_set;

-- 
To view, visit https://gerrit.osmocom.org/c/osmo-bsc/+/24611
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-bsc
Gerrit-Branch: master
Gerrit-Change-Id: I7997b802d997073ae6a05db2f40e82cb8e83764f
Gerrit-Change-Number: 24611
Gerrit-PatchSet: 4
Gerrit-Owner: neels <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-Reviewer: neels <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: pespin <pespin at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20210610/461ca967/attachment.htm>