summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2021-10-07 21:32:10 +0200
committerAleksander Morgado <aleksander@aleksander.es>2021-10-12 22:27:12 +0200
commit56983e658f961825ac948fd3e544108dd09b4d5f (patch)
treef0c9132ecebc4d7db667fdeeb6027d5709688114 /docs/reference
parent8c781c81b1a18ba206dbc5df3595363f4f485c4c (diff)
libmbim-glib: new MbimTlv generic type
The Microsoft Extensions define a new generic TLV type that allows including any kind of data in it: from strings, to arrays of uints, to more complex types. We define support for the generic 'tlv' type and the generic 'tlv-list' type, which allow implementing the "unnamed IEs" that are appended to some new messages in the MS extensions. And we also define support for a more specific 'tlv-string', used exclusively when the TLVs are part of the named fields, so that we can provide strings in our libmbim-glib APIs, instead of requiring the user to build MbimTlv instances.
Diffstat (limited to 'docs/reference')
-rwxr-xr-xdocs/reference/libmbim-glib/libmbim-glib-common.sections20
-rw-r--r--docs/reference/libmbim-glib/libmbim-glib-docs.xml1
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/reference/libmbim-glib/libmbim-glib-common.sections b/docs/reference/libmbim-glib/libmbim-glib-common.sections
index ddc3b1a..121e83b 100755
--- a/docs/reference/libmbim-glib/libmbim-glib-common.sections
+++ b/docs/reference/libmbim-glib/libmbim-glib-common.sections
@@ -761,6 +761,26 @@ mbim_utils_set_traces_enabled
</SECTION>
<SECTION>
+<FILE>mbim-tlv</FILE>
+MbimTlv
+MbimTlvType
+<SUBSECTION Methods>
+mbim_tlv_new
+mbim_tlv_dup
+mbim_tlv_ref
+mbim_tlv_unref
+mbim_tlv_get_raw
+mbim_tlv_get_tlv_type
+mbim_tlv_get_tlv_data
+mbim_tlv_type_get_string
+<SUBSECTION Private>
+mbim_tlv_type_build_string_from_mask
+<SUBSECTION Standard>
+MBIM_TYPE_TLV
+mbim_tlv_get_type
+</SECTION>
+
+<SECTION>
<FILE>mbim-compat</FILE>
<SUBSECTION>
MBIM_CID_BASIC_CONNECT_DEVICE_SERVICE_SUBSCRIBER_LIST
diff --git a/docs/reference/libmbim-glib/libmbim-glib-docs.xml b/docs/reference/libmbim-glib/libmbim-glib-docs.xml
index 9974e5c..a9d5d31 100644
--- a/docs/reference/libmbim-glib/libmbim-glib-docs.xml
+++ b/docs/reference/libmbim-glib/libmbim-glib-docs.xml
@@ -59,6 +59,7 @@
<xi:include href="xml/mbim-enums.xml"/>
<xi:include href="xml/mbim-errors.xml"/>
<xi:include href="xml/mbim-utils.xml"/>
+ <xi:include href="xml/mbim-tlv.xml"/>
</chapter>
<chapter>