aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVadim Yanitskiy <axilirator@gmail.com>2018-04-04 10:08:18 +0700
committerVadim Yanitskiy <axilirator@gmail.com>2018-04-04 10:47:27 +0700
commit9fb7e3a9fbee8a9cd80f617f634174de8321049a (patch)
tree7be795c021abb1289dc0b06b2addde51eba66279
parentdbb7659208533966940f2a4b622983163a7ee3d0 (diff)
gsm0480: document the 'ss_request' structure
-rw-r--r--include/osmocom/gsm/gsm0480.h31
1 files changed, 31 insertions, 0 deletions
diff --git a/include/osmocom/gsm/gsm0480.h b/include/osmocom/gsm/gsm0480.h
index 0dfd868f..05c26dfc 100644
--- a/include/osmocom/gsm/gsm0480.h
+++ b/include/osmocom/gsm/gsm0480.h
@@ -40,11 +40,42 @@ struct ussd_request {
int gsm0480_decode_ussd_request(const struct gsm48_hdr *hdr, uint16_t len,
struct ussd_request *request) OSMO_DEPRECATED("Use gsm0480_decode_ss_request() instead");
+/**
+ * This structure represents some meaningful parts of
+ * a decoded and/or to be encoded GSM 04.80 message.
+ */
struct ss_request {
+ /**
+ * GSM TS 04.80, section 3.6.4 "Operation code"
+ * See GSM0480_OP_CODE_* for possible values.
+ */
uint8_t opcode;
+ /**
+ * GSM TS 04.80, section 4.4.3.9 "ss-Code"
+ * The ss-Code identifier refers to the code which identify
+ * a supplementary service or a group of supplementary services.
+ */
uint8_t ss_code;
+
+ /**
+ * A rudiment of deprecated 'ussd_request' structure.
+ * Represents the data of either an INVOKE, either
+ * a RETURN_RESULT component, encoded as ASCII in
+ * case if DCS is 0x0f (i.e. decoded by the code
+ * itself), otherwise raw bytes 'as is'.
+ */
uint8_t ussd_text[GSM0480_USSD_OCTET_STRING_LEN];
+
+ /**
+ * GSM TS 04.80, section 3.3 "Transaction identifier"
+ * See GSM TS 04.07, section 11.2.3 for details.
+ */
uint8_t transaction_id;
+ /**
+ * GSM TS 04.80, section 3.6.3 "Component ID tag"
+ * The term Component ID refers to the Invoke ID or
+ * the Linked ID.
+ */
uint8_t invoke_id;
};