diff options
author | Pau Espin Pedrol <pespin@sysmocom.de> | 2018-10-12 21:16:27 +0200 |
---|---|---|
committer | Pau Espin Pedrol <pespin@sysmocom.de> | 2018-10-12 21:16:27 +0200 |
commit | 9ae32d0d0607f270f20239b8104e09ec20352301 (patch) | |
tree | 16df2fd4ae4c4406ae367476f788073528195e18 /openbsc/include/openbsc | |
parent | 4a2cc9eb0a0f9424c16b26fcb757483a39d67482 (diff) |
osmux.h: Document enum osmux_state
Change-Id: If5de6e981e9af7b667dd3365d758f868f38bf6e0
Diffstat (limited to 'openbsc/include/openbsc')
-rw-r--r-- | openbsc/include/openbsc/osmux.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/openbsc/include/openbsc/osmux.h b/openbsc/include/openbsc/osmux.h index f3ea72a85..6386125a4 100644 --- a/openbsc/include/openbsc/osmux.h +++ b/openbsc/include/openbsc/osmux.h @@ -26,10 +26,10 @@ void osmux_put_cid(uint8_t osmux_cid); 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 { |