osmux.h: Document enum osmux_state
Port for openbsc 9ae32d0d0607f270f20239b8104e09ec20352301.
Change-Id: I28978fa505d259f144457f29af4ba615aeaac74c
diff --git a/include/osmocom/mgcp/osmux.h b/include/osmocom/mgcp/osmux.h
index ea849c8..685be9c 100644
--- a/include/osmocom/mgcp/osmux.h
+++ b/include/osmocom/mgcp/osmux.h
@@ -24,10 +24,10 @@
int osmux_used_cid(void);
enum osmux_state {
- OSMUX_STATE_DISABLED = 0,
- OSMUX_STATE_NEGOTIATING,
- OSMUX_STATE_ACTIVATING,
- OSMUX_STATE_ENABLED,
+ OSMUX_STATE_DISABLED = 0, /* Osmux not being currently used by endp */
+ OSMUX_STATE_NEGOTIATING, /* Osmux was locally requested in MGCP CRCX */
+ OSMUX_STATE_ACTIVATING, /* Osmux was accepted in MGCP CRCX ACK. It can now be enabled by \ref osmux_enable_endpoint. */
+ OSMUX_STATE_ENABLED, /* Osmux was initialized by \ref osmux_enable_endpoint and can process frames */
};
enum osmux_usage {
@@ -35,4 +35,3 @@
OSMUX_USAGE_ON = 1,
OSMUX_USAGE_ONLY = 2,
};
-