aboutsummaryrefslogtreecommitdiff
path: root/docs/reference
AgeCommit message (Collapse)Author
2018-12-07api,modem-3gpp: new 'SetInitialEpsBearerSettings' methodAleksander Morgado
This method allows users to modify the settings used during the initial LTE attach procedure.
2018-12-07api,modem-3gpp: new 'InitialEpsBearerSettings' propertyAleksander Morgado
This property shows the settings stored in the device to be used during the initial LTE attach procedure.
2018-12-07api,modem-3gpp: new 'InitialEpsBearer' propertyAleksander Morgado
This property contains the DBus path of a Bearer object of type MM_BEARER_TYPE_DEFAULT_ATTACH, which is automatically exposed by the modem when registered in the LTE network. Unlike standard bearer objects created by the user, this bearer won't allow any connection/disconnection request, as its status is bound to the LTE registration exclusively. The bearer settings exposed by the object include the APN details that have been used during the initial packet network attach, which may be defined by modem settings (e.g. if previously configured in the firmware which APN to use for the given SIM card operator) or by the network itself (e.g. if none configured, or if a network override is required as when roaming). The bearer object will be created as soon as the LTE attach status details are known, and only while the modem is enabled. The implementation allows modems to update the LTE attach status details during runtime, so the bearer object with the settings may be recreated during runtime as well.
2018-12-07api,bearer: new 'BearerType' propertyAleksander Morgado
Until now we have only allowed to use and setup 'default bearers' (in 4G) or 'primary contexts' (in 2G/3G). We can define a couple of additional bearer types, though: * The 'dedicated bearers' (in 4G) or 'secondary contexts' (in 2G/3G), which are associated to a specific default/primary one, but which provide specific QoS settings configured via traffic flow templates. * The 'initial default EPS bearer', which is a special case of default bearer in LTE, which is automatically created and connected when the modem is registered in the LTE network. This commit introduces a new 'MMBearerType' enumeration that will be associated to each bearer through a 'BearerType' property in the org.freedesktop.ModemManager1.Bearer interface, showing what kind of bearer/context this is. By default, right now, all bearer objects created are 'default' bearers.
2018-12-04api,manager: new 'Version' propertyAleksander Morgado
This string shows the runtime version of the ModemManager daemon. https://gitlab.freedesktop.org/mobile-broadband/ModemManager/issues/94
2018-11-12doc,libmm-glib: mm_pco_new() is not part of public APIAleksander Morgado
2018-11-12docs,libmm-glib: flag as private the mm_location_3gpp_reset() methodAleksander Morgado
2018-11-12docs: remove duplicated mm-call-audio-format sectionAleksander Morgado
2018-10-27docs: add missing MMCallAudioFormat reference in docsAleksander Morgado
2018-10-27doc: fix multiple missing referencesAleksander Morgado
2018-10-16api/libmm-glib/cli: add AudioPort and AudioFormat properties to the Call objectDan Williams
2018-09-25udev: define all generic tags as symbolsAleksander Morgado
This prevents errors due to nasty typos in the strings. We define all symbols in a single header file that is NOT considered part of the API, as there is no need for MM clients to know about these tags code-wise. These tags are only meaningful when associated to devices in udev. Information of each tag is included in the general API documentation. https://gitlab.freedesktop.org/mobile-broadband/ModemManager/issues/88
2018-08-21api: support location assistance dataAleksander Morgado
Sometimes SUPL-server based A-GPS is not possible, e.g. if the module doesn't have Internet connectivity. In such cases, the modem may support injecting additional "assistance data" that may be downloaded from the Internet using external means (e.g. WiFi), in order to keep having a quick time to first fix. We now support using this location assistance data, with the following new API elements: * A new mask of supported assistance data types is provided in the SupportedAssistanceData property. * A new list of URLs from where the aassistance data may be downloaded is also provided in a new AssistanceDataServers property. * A new InjectAssistanceData() method is provided, to perform the data injection in the module once it's been downloaded to the host system.
2018-08-18modem-3gpp: add 'Pco' property to Modem3gpp interfaceBen Chan
This patch adds a 'Pco' property to the Modem3gpp interface for tracking PCOs that the modem has received from the network.
2018-08-18libmm-glib: add MMPco for handling raw PCO dataBen Chan
2018-03-13docs: add missing reference to mm_modem_3gpp_get_eps_ue_mode_operation()Aleksander Morgado
2018-03-13docs: always rebuild libmm-glib typesAleksander Morgado
So that we don't forget to add new types here manually... (e.g. MMBearerStats)
2018-01-25*: Spelling fixesVille Skyttä
2018-01-20modem-3gpp: allow loading and changing EPS UE mode of operationAleksander Morgado
The UE modes of operation for LTE are defined in 3GPP TS 24.301 (e.g. section 4.3 in v10.3.0): * PS mode 1: EPS only, 'voice centric' * PS mode 2: EPS only, 'data centric' * CS/PS mode 1: EPS and non-EPS, 'voice centric' * CS/PS mode 2: EPS and non-EPS, 'data centric' The mode specifies, among other things, how the UE should behave w.r.t CS fallback depending on the capabilities reported by the network.
2017-12-05docs: include device filter policies/rules documentationAleksander Morgado
2017-12-05docs: port probing reference in its own chapterAleksander Morgado
2017-09-20libmm-glib: add helpers for loading hardware revisionBen Chan
2017-09-20api,introspection: new 'HardwareRevision' propertyBen Chan
This property will let the clients know the hardware revision reported by the modem.
2017-09-07api: add MM_DISABLE_DEPRECATED guards around deprecated symbolsAleksander Morgado
When this symbol is defined, e.g. via CFLAGS, building a program that uses the ModemManager API will fail if the program references deprecated symbols. For now we just use it to keep gtk-doc-scan happy and avoid unnecessary warnings.
2017-09-07api: consolidate CDMA frequency enumerationsAleksander Morgado
Define new symbols with easier names, just based on the Band Class.
2017-09-07api: new MM_BAND_UTRAN_ enumerations for WCDMA bandsAleksander Morgado
Flag as deprecated the old names, and define new ones based on the defined UTRAN band numbers, equivalent to what was done for LTE bands.
2017-09-07api: don't use intermediate variables for deprecation warningsAleksander Morgado
Using an intermediate constant variable breaks compilation with C compilers, as these variables cannot be used as initializers. Instead, define a deprecated type and cast all deprecated symbols to that type. We lose the information about what the new replacement symbol is, but we don't break compilation. E.g.: test.c: In function ‘main’: test.c:8:5: warning: ‘MMModemBandDeprecated’ is deprecated [-Wdeprecated-declarations] printf ("band: %d\n", MM_MODEM_BAND_U2100); ^~~~~~
2017-06-28compat: add compatibility definitions for old MM_MODEM_BAND_EUTRAN_* valuesBen Chan
Those Roman numeral suffixes in MM_MODEM_BAND_EUTRAN_* were replaced with 1, 2, 3, ..., etc. This patch adds a compatibility header, ModemManager-compat.h, to alias the old MM_MODEM_BAND_EUTRAN_* values to the new values.
2017-03-08docs: update copyright year to 2017Aleksander Morgado
2016-10-12api,signal: new RSCP itemAleksander Morgado
2016-09-29core: allow disabling auto-scan and notifying ports one by one via APIAleksander Morgado
This commit enables a new core ModemManager daemon option, so that automatic detection of available modems is totally disabled: '--no-auto-scan'. Note that this option also replaces the previously used '--test-no-auto-scan' option, which was only used during tests. Along with the new ModemManager option, a new ReportKernelEvent() method in the API is defined, which allows notifying the daemon of which interfaces it should be accessing, as well as the main details of each interface. The only mandatory parameters in the new method are 'action' (add/remove), 'name' (the name of the interface) and 'subsystem' (the subsystem of the interface). The mmcli tool has support for using the new api method via several new options: * The '--report-kernel-event' option allows specifying device ports one by one, and is a direct mapping of the ReportKernelEvent() method: $ sudo mmcli --report-kernel-event="action=add,name=wwan0,subsystem=net" $ sudo mmcli --report-kernel-event="action=add,name=cdc-wdm0,subsystem=usbmisc" * The '--report-kernel-event-auto-scan' option uses udev monitoring to notify events automatically to the daemon. This allows to operate in a way equivalent to the default daemon operation (with implicit auto-scan). Worth noting that the ReportKernelEvent() method is only usable when '--no-auto-scan' is explicitly used in the daemon. An error will be reported if the method is tried while standard udev monitoring is enabled (implicit if auto scan isn't explicitly disabled in the daemon). If mmcli is going to be used only to report 'real time' events, an optional '--initial-kernel-events=[PATH]' may be given in the ModemManager call to automatically process a set of port kernel events one by one on boot. The file may e.g. contain: action=add,name=wwan0,subsystem=net action=add,name=cdc-wdm0,subsystem=usbmisc
2016-07-26build: updated copyright years up to 2016Aleksander Morgado
2015-12-19location: support updating the GPS refresh timeAleksander Morgado
The default setup uses a refresh time of 30s, which means that even if the GPS location updates are received at a higher frequency, the DBus interface will still expose at most one update every 30s. This patch includes a new "SetGpsRefreshTime()" method in the Location interface, which takes a single 'u' parameter, specifying the refresh rate to use, in seconds. This method also allows 0 being passed, which will make the implementation to publish the GPS location updates are soon as ModemManager detects them. Along with the new method, a "GpsRefreshTime" read-only property is exposed to specify the refresh time in effect. The new method and property will only be applicable if the device has GPS capabilities. https://bugs.freedesktop.org/show_bug.cgi?id=89924
2015-12-07libmm-glib: retrieve stats from the bearerAleksander Morgado
The MMBearer object is updated to provide getter methods to retrieve the new MMBearerStats object.
2015-12-07libmm-glib: new helper object to handle bearer statsAleksander Morgado
The new MMBearerStats object provides a simple API to interact with the new dictionary containing the bearer connection stats.
2015-10-07build: diagrams and logos are no longer generated during build, so don't ↵Aleksander Morgado
remove them
2015-10-07build: don't add PNGs in content_files, no longer neededAleksander Morgado
2015-08-02libmm-glib,docs: update typesAleksander Morgado
# Extra options to supply to gtkdoc-scan SCAN_OPTIONS = --rebuild-types
2015-08-02libmm-glib,docs: avoid already defined idAleksander Morgado
DOC Building HTML ../libmm-glib-docs.xml:6: element indexdiv: validity error : ID api-index-full already defined DOC Fixing cross-references
2015-08-02docs,libmm-glib: add missing voice/call documentationAleksander Morgado
2015-08-02docs,api: add missing links to the new Voice interface and Call objectAleksander Morgado
2015-08-02docs,voice: add missing voice related enum valuesAleksander Morgado
2014-09-05libmm-glib,location: add helpers to get/set the SUPL server addressAleksander Morgado
2014-09-05introspection,api: add SUPL server configuration in the Location interfaceAleksander Morgado
2014-08-05build: INCLUDES -> AM_CPPFLAGS to quiet automake warningDan Williams
2014-03-25docs,libmm-glib: add methods to manage the MTU in the MMBearerIpConfigAleksander Morgado
2014-02-13libmm-glib,tests: use gdbus-codegen to generate code for the new Test interfaceAleksander Morgado
2014-02-06docs,api: fix section reference to the Messaging interfaceAleksander Morgado
2014-01-30docs: update email addressAleksander Morgado
2013-11-22libmm-glib: add methods to retrieve 'Bearers' property in Modem interfaceBen Chan