aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/api
AgeCommit message (Collapse)Author
2023-10-27api,errors: new MMCarrierLockError typeAleksander Morgado
This new error type will be used to report errors in the carrier lock operations performed through ModemManager. They have a one to one mapping to the MBIM status specific errors.
2023-06-16broadband-modem-qmi|mbim: allow limiting multiplexed links with udev tagsAleksander Morgado
Certain QMI or MBIM devices may not be able to support multiplexing at all, or they may support a limited amount of links. The new ID_MM_MAX_MULTIPLEXED_LINKS udev tag allows specifying the maximum number of supported multiplexed links; e.g. 0 to report none supported or 1 to report that one single multiplexed link is supported.
2023-06-16docs: add missing reference to ID_MM_REQUIREDAleksander Morgado
2023-04-14docs: update copyrightAleksander Morgado
2023-02-17modem-cellinfo: adding bandwidth and serving cell typesom
adding bandwidth information in mm-dbus interface for the serving cell. In serving cell, the details on whether the pcell/scell are from MCS or SCG is also updated. Co-author: Shilpa Shivakumar
2022-11-07build: drop autotoolsAleksander Morgado
2022-10-19docs,reference: update copyright yearsAleksander Morgado
2022-07-16docs: add missing reference to ID_MM_PORT_TYPE_AT_GPS_CONTROLAleksander Morgado
2022-01-18api,modem: new 'GetCellInfo()' methodAleksander Morgado
This new method allows querying the modem for information about the current serving cell(s) as well as any other neighboring cell that may be found. The information for the cells is given in an array of dictionaries, where each element of the dictionary is a new dictionary itself. Each cell type has a different set of properties that may be given in the dictionary, and some of those properties in each type are also applicable under certain conditions (e.g. only applicable to the cell if it's a 'serving' cell instead of 'neighboring'). The API documentation explains in detail what is expected in each case.
2021-12-24api,bearer: new 'profile-source' settingAleksander Morgado
Sometimes it's useful to know how a given stored profile was created, so devices can store and report this kind of information.
2021-12-24api,bearer: new 'roaming-allowance' settingAleksander Morgado
The 'allow-roaming' setting should be considered deprecated for 3GPP devices that support the new 'roaming-allowance' setting, which is much more detailed (as it allows to differentiate between partner and non-partner networks) and may also be stored as part of a profile.
2021-12-24api,bearer: new 'access-type-preference' settingAleksander Morgado
In 5G capable devices, which can support multiple types of access types (either 3GPP or non-3GPP), the UE may request to use a 3GPP access type exclusively, prefer a 3GPP access type, or just report no preference. When supported, this field may also be part of the settings that can be stored as part of a profile.
2021-12-24api,modem3gpp: add DRX cycle in 5G registration settingsAleksander Morgado
2021-12-24api,modem3gpp: new 5G registration settings support and MICO modeSom_SP
A new set of property+method is added to be able to configure the 5G specific registration settings, initially defining the support for the MICO mode. The property name starts with "Nr5g" instead of "5gNr" because of the limitations imposed by the GObject type system on how properties with numbers can be named.
2021-12-11libmm-glib,sim: new 'SimType', 'Removability' and 'EsimStatus' propertiesAleksander Morgado
2021-11-04core: replace 'whitelist' with 'allowlist' and 'blacklist' with 'blocklist'Aleksander Morgado
We keep the 'WHITELIST-ONLY' filter type name still as an option in --filter-policy=[POLICY], but deprecated and with the better 'ALLOWLIST-ONLY' replacement suggested from now on.
2021-11-03docs,api: add index for 1.20Aleksander Morgado
2021-11-02api,3gpp: new 'PacketServiceState' propertyAleksander Morgado
This property allows the user to know whether the device is attached or detached from the packet domain service.
2021-09-10Revert "api: remove Modem.Sar interface"Aleksander Morgado
This reverts commit 686e37ff84daca6096fe18781ad9ba6f29cd4063.
2021-09-07build: Port to mesonIñigo Martínez
meson is a build system focused on speed an ease of use, which helps speeding up the software development. This patch adds meson support along autotools.
2021-08-09api: remove Modem.Sar interfaceAleksander Morgado
There is no real implementation for it yet, so let's recover these changes once 1.18 has been released.
2021-06-16filter: trivial: reorder WWAN rule before the TTY onesAleksander Morgado
2021-06-16filter: remove support for TTY blacklist, TTY greylist and TTY default allowedAleksander Morgado
These lists were used in the corresponding TTY_BLACKLIST and TTY_MANUAL_SCAN_ONLY filter rules, in the LEGACY and PARANOID filter types, which are no longer supported. The DEFAULT_ALLOWED filter rule made sense only in the LEGACY filter type, and therefore it is also now removed, leaving the DEFAULT_FORBIDDEN fallback rule exclusively. In other words, there is now no way to ask ModemManager to implicitly allow TTY ports; the only way to do that is by explicit making the TTY ports fall in one filter rule that would allow them.
2021-06-16docs: add missing references for several filter rulesAleksander Morgado
2021-06-16docs: remove LEGACY(DEFAULT) and PARANOID filter policy documentationAleksander Morgado
2021-05-22api,errors: document all DBus error name prefixesAleksander Morgado
Since ModemManager 1.0 we were publishing symbols to identify all the possible DBus error name prefixes, but these were never documented, they were explicitly ignored in gtk-doc. Let's provide proper documentation for them and make them first-class API symbols.
2021-05-22docs,api: add index for 1.14Aleksander Morgado
Some of the newly deprecated enum values were introduced in 1.14.
2021-05-22api: update MMMobileEquipmentError enum valuesAleksander Morgado
Update the list of mobile equipment error codes according to v17.1.0 of 3GPP TS 27.007 (March 2021). A lot of the enum values that were prefixed with the 'GPRS_' keyword have now been flagged as deprecated, and a new enum name given to the corresponding value. The deprecated symbol names are kept in the compat support to avoid breaking API/ABI.
2021-04-29api,modem: new Modem3gpp.ProfileManager interfaceAleksander Morgado
This new interface allows modems to expose the list of available connection profiles stored in the device and edit or delete them; as long as the underlying device/protocol allows it.
2021-04-29api,bearer: new 'apn-type' settingAleksander Morgado
This new setting allows the user setting up the connection to specify the purpose of the connection being brought up. Until now, we would always assume that connections are exclusively brought up for connecting to the Internet, also limited by the inability to connect to multiple different APNs at the same time. But that may really not be true as there may be additional services that may be accessed through other APNs, like MMS services or even private networks for companies that have their own APNs on a given operator (e.g. not that uncommon with banks and connected cars). The new APN type setting will not change the way the bearer is connected, but will allow the connection manager to decide what kind of networking setup the specific connection needs. This new setting can be provided by the user itself, or implicitly read from the device if the device stores this information.
2021-03-23docs,api: include missing reference to the SAR interfaceAleksander Morgado
2021-03-23build: add support for the new SAR interfaceAleksander Morgado
Include the new SAR interface in the build so that gdbus-codegen generates support for it in libmm-glib as well as proper documentation in the API reference.
2021-03-10docs: add api indices for 1.18Aleksander Morgado
2021-03-10api,simple: new 'multiplex' setting in bearer propertiesAleksander Morgado
Both the Simple.Connect() and Modem.CreateBearer() are updated to allow a new 'multiplex' setting in the properties provided by the user in both of these methods. The new setting expects a MMBearerMultiplexSupport enum indicating what kind of multiplex needs the user has: * none: if multiplex must not be used. * requested: if multiplex should be used if available. * required: if multiplex must be used. The underlying implementations will take care of accepting or rejecting the setting depending on the system and modem capabilities.
2021-01-17core: update copyright years to 2021Aleksander Morgado
2021-01-16docs: add 'online-location' referencesAleksander Morgado
So that the gtkdoc-rebase step fixes the URLs to contain the correct links; e.g.: $ make dist V=s make[8]: Entering directory '/home/aleksander/Development/foss/ModemManager/docs/reference/libmm-glib' make \ top_distdir="../../../ModemManager-1.15.0" distdir="../../../ModemManager-1.15.0/docs/reference/libmm-glib" \ dist-hook ../ModemManager/ -> https://www.freedesktop.org/software/ModemManager/doc/latest/ModemManager/ (914) ../gio/ -> https://developer.gnome.org/gio/unstable/ (2564) ../glib/ -> https://developer.gnome.org/glib/unstable/ (5534) ../gobject/ -> https://developer.gnome.org/gobject/unstable/ (499) make[8]: Leaving directory '/home/aleksander/Development/foss/ModemManager/docs/reference/libmm-glib' Fixes https://gitlab.freedesktop.org/mobile-broadband/ModemManager/-/issues/298
2020-11-09api: new ID_MM_PORT_TYPE_QMI and ID_MM_PORT_TYPE_MBIM udev hintsAleksander Morgado
It is no longer true that all QMI ports are exposed by the qmi_wwan driver and that all MBIM ports are exposed by the cdc_mbim driver. There are other generic setups that allow exposing these types of ports using different drivers, and usually we can also know the type of port in advance via other means. Therefore, allow adding udev port type hints for QMI and MBIM ports as well.
2020-11-06filter: simplify CDC_WDM rule to a subsystem-only USBMISC checkAleksander Morgado
This is not just a rename of the rule, we also now avoid doing an explicit check on the port name as well, and we rely on subsystem checks only; i.e. the same logic applied for net ports. The port candidate rules already do a 'cdc-wdm*' device name check so it shouldn't be a big deal.
2020-04-09api: deprecate MM_MODEM_CAPABILITY_LTE_ADVANCEDAleksander Morgado
It's not used anywhere.
2020-01-03build: bump copyright years to 2020Aleksander Morgado
2019-10-28docs,api: rework how indices are exposed in docsAleksander Morgado
Use <chapter> so that all per-version indices are included in the docs.
2019-10-24docs,api: add missing reference to ID_MM_PORT_TYPE_AUDIOAleksander Morgado
2019-10-24docs,api: provide per-version indicesAleksander Morgado
2019-08-29udev: remove ID_MM_PLATFORM_DRIVER_PROBE tagAleksander Morgado
This tag is completely redundant because users can whitelist the platform TTY ports to use with the more generic ID_MM_DEVICE_PROCESS tag, which is part of the explicit whitelist filter rule.
2019-08-29udev: rename ID_MM_DEVICE_MANUAL_SCAN_ONLY to ID_MM_TTY_MANUAL_SCAN_ONLYAleksander Morgado
The udev tag that allows flagging devices that MAY be modems (e.g. USB<->RS232 adapters) is only applicable to TTY devices, so explicitly specify that in the tag name as well.
2019-08-29udev: repurpose ID_MM_DEVICE_IGNORE and new MM_FILTER_RULE_EXPLICIT_BLACKLISTAleksander Morgado
Until now the ID_MM_DEVICE_IGNORE udev tag was being used in the internal blacklist of devices shipped by ModemManager when running in either DEFAULT or PARANOID filter modes. The name of the tag is extremely misleading because it doesn't really make the full device be ignored, the tag only applied to TTY ports. This commit repurposes the tag so that it applies to ANY kind of port (e.g. TTY, NET, cdc-wdm...) and also to any kind of filter type (i.e. also applicable in STRICT mode). The internal blacklist shipped by ModemManager, which should NOT be used in STRICT mode, uses a new tag name, ID_MM_TTY_BLACKLIST. The new ID_MM_DEVICE_IGNORE tag is therefore much more usable and its name is really meaningful. If there are users or third-party projects adding their own udev rules with the ID_MM_DEVICE_IGNORE tag name, they should have no problem as the new rule is more restrictive than the old one.
2019-08-29docs: untabifyBen Chan
2019-07-02docs: add deprecated items to sections fileAleksander Morgado
2019-01-11build: update copyright years to 2019Aleksander Morgado
2019-01-03api,firmware: new UpdateSettings propertyAleksander Morgado