[PATCH 1/6] doc: add ims atom documentation

[PATCH 1/6] doc: add ims atom documentation

[Ankit Navik]

[-- Attachment #1: Type: text/plain, Size: 2637 bytes --]

---
 Makefile.am     |  3 ++-
 doc/ims-api.txt | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100755 doc/ims-api.txt

diff --git a/Makefile.am b/Makefile.am
index 5368b61..3ce6d50 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -680,7 +680,8 @@ doc_files = doc/overview.txt doc/ofono-paper.txt doc/release-faq.txt \
 			doc/networkmonitor-api.txt \
 			doc/allowed-apns-api.txt \
 			doc/lte-api.txt \
-			doc/cinterion-hardware-monitor-api.txt
+			doc/cinterion-hardware-monitor-api.txt \
+			doc/ims-api.txt
 
 
 test_scripts = test/backtrace \
diff --git a/doc/ims-api.txt b/doc/ims-api.txt
new file mode 100755
index 0000000..4f9a19b
--- /dev/null
+++ b/doc/ims-api.txt
@@ -0,0 +1,60 @@
+IpMultimediaSystem Hierarchy
+============================
+
+Service		org.ofono
+Interface	org.ofono.IpMultimediaSystem
+Object path	[variable prefix]/{modem0,modem1,...}
+
+
+Methods		dict GetProperties()
+
+			Returns all IpMultimediaSystem configuration properties.
+
+		void SetProperty(string property, variant value)
+
+			Changes the value of the specified property. Only
+			properties that are listed as readwrite are
+			changeable. On success a PropertyChanged signal
+			will be emitted.
+
+			Possible Errors: [service].Error.InProgress
+					 [service].Error.InvalidArguments
+					 [service].Error.Failed
+
+		void Register()
+
+			Attempts to register to IMS. A successful method return
+			indicates that the registration process could be
+			initiated successfully. The actual registration state
+			will be reflected by the 'Registered' property.
+
+			Possible Errors: [service].Error.InProgress
+					 [service].Error.NotImplemented
+
+		void Unregister()
+
+			Attempts to unregister from IMS. A successful method
+			return indicates that the unregistration process could
+			be initiated successfully. The actual unregistration
+			state will be reflected by the 'Registered' property.
+
+			Possible Errors: [service].Error.InProgress
+					 [service].Error.NotImplemented
+
+Signals		PropertyChanged(string property, variant value)
+
+			This signal indicates a changed value of the given
+			property.
+
+Properties 	boolean Registered [readonly]
+
+			Contains the current IMS registration state.
+
+		boolean VoiceCapable [readonly, optional]
+
+			Boolean representing whether voice call transfer over
+			RTP (IMS) is available.
+
+		boolean SmsCapable [readonly, optional]
+
+			Boolean representing whether SMS-over-IMS is available.
-- 
1.9.1

[PATCH 2/6] include: added IpMultimediaSystem interface

[Ankit Navik]

[-- Attachment #1: Type: text/plain, Size: 3662 bytes --]

---
 Makefile.am    |  2 +-
 include/dbus.h |  1 +
 include/ims.h  | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 72 insertions(+), 1 deletion(-)
 create mode 100644 include/ims.h

diff --git a/Makefile.am b/Makefile.am
index 3ce6d50..165235e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -22,7 +22,7 @@ pkginclude_HEADERS = include/log.h include/plugin.h include/history.h \
 			include/private-network.h include/cdma-netreg.h \
 			include/cdma-provision.h include/handsfree.h \
 			include/handsfree-audio.h include/siri.h \
-			include/netmon.h include/lte.h
+			include/netmon.h include/lte.h include/ims.h
 
 nodist_pkginclude_HEADERS = include/version.h
 
diff --git a/include/dbus.h b/include/dbus.h
index a6519c7..0a8f2e5 100644
--- a/include/dbus.h
+++ b/include/dbus.h
@@ -63,6 +63,7 @@ extern "C" {
 #define OFONO_NETMON_INTERFACE OFONO_SERVICE ".NetworkMonitor"
 #define OFONO_NETMON_AGENT_INTERFACE OFONO_SERVICE ".NetworkMonitorAgent"
 #define OFONO_LTE_INTERFACE OFONO_SERVICE ".LongTermEvolution"
+#define OFONO_IMS_INTERFACE OFONO_SERVICE ".IpMultimediaSystem"
 
 /* CDMA Interfaces */
 #define OFONO_CDMA_VOICECALL_MANAGER_INTERFACE "org.ofono.cdma.VoiceCallManager"
diff --git a/include/ims.h b/include/ims.h
new file mode 100644
index 0000000..f3a33d5
--- /dev/null
+++ b/include/ims.h
@@ -0,0 +1,70 @@
+/*
+ *
+ *  oFono - Open Source Telephony
+ *
+ *  Copyright (C) 2017  Intel Corporation. All rights reserved.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 2 as
+ *  published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ */
+
+#ifndef __OFONO_IMS_H
+#define __OFONO_IMS_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <ofono/types.h>
+
+struct ofono_ims;
+
+typedef void (*ofono_ims_register_cb_t)(const struct ofono_error *error,
+						void *data);
+typedef void (*ofono_ims_status_cb_t)(const struct ofono_error *error,
+						int reg_info, int ext_info,
+						void *data);
+
+struct ofono_ims_driver {
+	const char *name;
+	int (*probe)(struct ofono_ims *ims, void *data);
+	void (*remove)(struct ofono_ims *ims);
+	void (*ims_register)(struct ofono_ims *ims,
+				ofono_ims_register_cb_t cb, void *data);
+	void (*ims_unregister)(struct ofono_ims *ims,
+				ofono_ims_register_cb_t cb, void *data);
+	void (*registration_status)(struct ofono_ims *ims,
+				ofono_ims_status_cb_t cb, void *data);
+};
+
+void ofono_ims_status_notify(struct ofono_ims *ims, int reg_info,
+							int ext_info);
+
+int ofono_ims_driver_register(const struct ofono_ims_driver *d);
+void ofono_ims_driver_unregister(const struct ofono_ims_driver *d);
+
+struct ofono_ims *ofono_ims_create(struct ofono_modem *modem,
+					const char *driver, void *data);
+
+void ofono_ims_register(struct ofono_ims *ims);
+void ofono_ims_remove(struct ofono_ims *ims);
+
+void ofono_ims_set_data(struct ofono_ims *ims, void *data);
+void *ofono_ims_get_data(const struct ofono_ims *ims);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
-- 
1.9.1

Re: [PATCH 1/6] doc: add ims atom documentation

[Denis Kenzior]

[-- Attachment #1: Type: text/plain, Size: 330 bytes --]

Hi Ankit,

On 10/03/2017 10:42 PM, Ankit Navik wrote:
> ---
>   Makefile.am     |  3 ++-
>   doc/ims-api.txt | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>   2 files changed, 62 insertions(+), 1 deletion(-)
>   create mode 100755 doc/ims-api.txt
> 

Patch 1 & 2 applied, thanks.

Regards,
-Denis