From 62f7b76e8ea8f682048840741d1177e6c93a1c80 Mon Sep 17 00:00:00 2001
From: Guido Günther <agx@sigxcpu.org>
Date: Tue, 5 Dec 2023 20:05:17 +0100
Subject: cbm: Add CellBroadcast interface
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This adds support for the Cell Broadcast interface allowing to
receive, list, read and delete Cell Broadcast messages via the
org.freedesktop.ModemManager1.Modem.CellBroadcast and
org.freedesktop.ModemManager1.Cbm interfaces.

Signed-off-by: Guido Günther <agx@sigxcpu.org>
---
 introspection/all.xml                              |  2 +
 introspection/meson.build                          |  5 +-
 .../org.freedesktop.ModemManager1.Cbm.xml          | 69 ++++++++++++++++
 ...eedesktop.ModemManager1.Modem.CellBroadcast.xml | 91 ++++++++++++++++++++++
 4 files changed, 166 insertions(+), 1 deletion(-)
 create mode 100644 introspection/org.freedesktop.ModemManager1.Cbm.xml
 create mode 100644 introspection/org.freedesktop.ModemManager1.Modem.CellBroadcast.xml

(limited to 'introspection')

diff --git a/introspection/all.xml b/introspection/all.xml
index 1ca51281..c65479fb 100644
--- a/introspection/all.xml
+++ b/introspection/all.xml
@@ -7,7 +7,9 @@
   <xi:include href="org.freedesktop.ModemManager1.Bearer.xml"/>
   <xi:include href="org.freedesktop.ModemManager1.Sms.xml"/>
   <xi:include href="org.freedesktop.ModemManager1.Call.xml"/>
+  <xi:include href="org.freedesktop.ModemManager1.Cbm.xml"/>
   <xi:include href="org.freedesktop.ModemManager1.Modem.xml"/>
+  <xi:include href="org.freedesktop.ModemManager1.Modem.CellBroadcast.xml"/>
   <xi:include href="org.freedesktop.ModemManager1.Modem.Voice.xml"/>
   <xi:include href="org.freedesktop.ModemManager1.Modem.Modem3gpp.xml"/>
   <xi:include href="org.freedesktop.ModemManager1.Modem.Modem3gpp.ProfileManager.xml"/>
diff --git a/introspection/meson.build b/introspection/meson.build
index 6f45c185..09ac762a 100644
--- a/introspection/meson.build
+++ b/introspection/meson.build
@@ -13,6 +13,7 @@ mm_ifaces_bearer = files('org.freedesktop.ModemManager1.Bearer.xml')
 mm_ifaces_call = files('org.freedesktop.ModemManager1.Call.xml')
 
 mm_ifaces_modem = files(
+  'org.freedesktop.ModemManager1.Modem.CellBroadcast.xml',
   'org.freedesktop.ModemManager1.Modem.Firmware.xml',
   'org.freedesktop.ModemManager1.Modem.Location.xml',
   'org.freedesktop.ModemManager1.Modem.Messaging.xml',
@@ -29,10 +30,12 @@ mm_ifaces_modem = files(
   'org.freedesktop.ModemManager1.Modem.xml',
 )
 
+mm_ifaces_cbm = files('org.freedesktop.ModemManager1.Cbm.xml',)
 mm_ifaces_sim = files('org.freedesktop.ModemManager1.Sim.xml')
 mm_ifaces_sms = files('org.freedesktop.ModemManager1.Sms.xml',)
 
 install_data(
-  mm_ifaces + mm_ifaces_bearer + mm_ifaces_call + mm_ifaces_modem + mm_ifaces_sim + mm_ifaces_sms,
+  mm_ifaces + mm_ifaces_bearer + mm_ifaces_call + mm_ifaces_cbm +
+  mm_ifaces_modem + mm_ifaces_sim + mm_ifaces_sms,
   install_dir: dbus_interfaces_dir,
 )
diff --git a/introspection/org.freedesktop.ModemManager1.Cbm.xml b/introspection/org.freedesktop.ModemManager1.Cbm.xml
new file mode 100644
index 00000000..107bbd77
--- /dev/null
+++ b/introspection/org.freedesktop.ModemManager1.Cbm.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!--
+ ModemManager 1.0 Interface Specification
+
+   Copyright (C) 2024 Guido Günther <agx@sigxcpu.org>
+-->
+
+<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+
+  <!--
+      org.freedesktop.ModemManager1.Cbm:
+      @short_description: The ModemManager Cbm interface.
+
+      The Cbm interface defines operations and properties of a single cell broadcast message.
+  -->
+  <interface name="org.freedesktop.ModemManager1.Cbm">
+
+    <!--
+        State:
+
+        A <link linkend="MMCbmState">MMCbmState</link> value,
+        describing the state of the message.
+
+        Since: 1.24
+    -->
+    <property name="State" type="u" access="read" />
+
+    <!--
+        Text:
+
+        Message text, in UTF-8.
+
+        Since: 1.24
+    -->
+    <property name="Text" type="s" access="read" />
+
+    <!--
+        Channel:
+
+        The channel (or message identifier) specifying the source and
+        type of the cell broadcast message.
+
+        Since: 1.24
+    -->
+    <property name="Channel" type="u" access="read" />
+
+    <!--
+        MessageCode:
+
+        The message code of this CBM. The message code differentiates
+	between CBMs from the same channel.
+
+        Since: 1.24
+    -->
+    <property name="MessageCode" type="u" access="read" />
+
+    <!--
+        Update:
+
+        The update number of this CBM. The update number allows to update CBMs
+        with the same channel and message code.
+
+        Since: 1.24
+    -->
+    <property name="Update" type="u" access="read" />
+
+  </interface>
+</node>
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.CellBroadcast.xml b/introspection/org.freedesktop.ModemManager1.Modem.CellBroadcast.xml
new file mode 100644
index 00000000..9e8584a1
--- /dev/null
+++ b/introspection/org.freedesktop.ModemManager1.Modem.CellBroadcast.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!--
+ ModemManager 1.0 Interface Specification
+
+   Copyright (C) 2024 Guido Günther <agx@sigxcpu.org>
+-->
+
+<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+
+  <!--
+      org.freedesktop.ModemManager1.Modem.CellBroadcast:
+      @short_description: The ModemManager CellBroadcast service interface.
+
+      This interface allows clients to configure the details of CellBroadcast
+      service information.
+
+      This interface will only be available once the modem is ready to be
+      registered in the cellular network.
+  -->
+  <interface name="org.freedesktop.ModemManager1.Modem.CellBroadcast">
+    <!--
+        List:
+        @result: The list of CBM object paths.
+
+        Retrieve all cell broadcast messages.
+
+        This method should only be used once and subsequent information
+        retrieved either by listening for the
+        #org.freedesktop.ModemManager1.Modem.CellBroadcast::Added signal,
+        or by querying the specific CBM object of interest.
+
+        Since: 1.24
+    -->
+    <method name="List">
+      <arg name="result" type="ao" direction="out" />
+    </method>
+
+    <!--
+        Delete:
+        @path: The object path of the CBM to delete.
+
+        Delete an cell broadcast message
+
+        Since: 1.24
+    -->
+    <method name="Delete">
+      <arg name="path" type="o" direction="in" />
+    </method>
+
+    <!--
+        Added:
+        @path: Object path of the new CBM.
+
+        Emitted when any part of a new cell broadcast message has been
+        received. Not all parts may have been received and the message may not
+        be complete.
+
+        Check the
+        '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Cbm.State">State</link>'
+        property to determine if the message is complete.
+
+        Since: 1.24
+    -->
+    <signal name="Added">
+      <arg name="path" type="o" />
+    </signal>
+
+    <!--
+        Deleted:
+        @path: Object path of the now deleted CBM.
+
+        Emitted when a message has been deleted.
+
+        Since: 1.24
+    -->
+    <signal name="Deleted">
+      <arg name="path" type="o" />
+    </signal>
+
+    <!--
+        CellBroadcasts:
+
+        The list of CBM object paths.
+
+        Since: 1.24
+    -->
+    <property name="CellBroadcasts" type="ao" access="read" />
+
+  </interface>
+</node>
-- 
cgit v1.2.3-70-g09d2