[PATCH 1/3] coex: Adding documetation for coex interface

[PATCH 1/3] coex: Adding documetation for coex interface

[Antara Borwankar]

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

From: Antara <antara.borwankar@intel.com>

Added coex-api.txt which defines coex interface for intel modems
---
 doc/coex-api.txt | 122 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 122 insertions(+)
 create mode 100644 doc/coex-api.txt

diff --git a/doc/coex-api.txt b/doc/coex-api.txt
new file mode 100644
index 0000000..12693a4
--- /dev/null
+++ b/doc/coex-api.txt
@@ -0,0 +1,122 @@
+LTE Coexistence hierarchy
+===============
+
+Service		org.ofono
+Interface	org.ofono.IntelLTECoex*
+Object path	[variable prefix]/{modem0,modem1,...}
+
+Methods		dict GetProperties()
+			Returns all coexistence configuration properties.
+
+			void SetProperty(string property, variant value)
+			Changes the value of the specified property. Only properties that are
+			listed as Read-write are changeable.
+			On success a PropertyChanged signal will be emitted.
+
+			Possible Errors: [service].Error.InProgress
+						[service].Error.InvalidArguments
+						[service].Error.Failed
+
+
+		void RegisterAgent(object path)
+
+			Registers an agent which will be called whenever the
+			modem initiates LTE Coexistence information.
+
+			Possible Errors: [service].Error.InProgress
+					 [service].Error.InvalidArguments
+					 [service].Error.InvalidFormat
+					 [service].Error.Failed
+
+		void UnregisterAgent(object path)
+
+			Unregisters an agent.
+
+			Possible Errors: [service].Error.InvalidArguments
+					 [service].Error.Failed
+
+		a(a{sv}) GetPlmnHistory()
+			Requests for LTE Plmn history list stored in NVM to
+			retrieve geo location history like MobileNetworkCode,
+			MobileCountryCode, LteBandsFDD, LteBandsTDD, ChannelBandwidth.
+			*most recently uused
+			*privacy
+
+			Refer to the sections below for which property types
+			are available, their valid value ranges and
+			applicability to different cell types.
+
+Signals		PropertyChanged(string property, variant value)
+			This signal indicates a changed value of the given property.
+
+
+LTECoexistenceAgent Hierarchy [experimental]
+===============
+
+Service		unique name
+Interface	org.ofono.IntelLTECoexAgent
+Object path	freely definable
+
+Methods		void ReceiveBluetoothNotification(array{byte} notification, dict info)
+
+			Requests the agent to process BT related LTE Coexistence information
+			The dictionary info contains vector table with modem recommended Safe
+			Tx/Rx band and range information.The properties involved are
+			'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and 'SafeVector'.
+
+			Possible Errors: None
+
+		void ReceiveWiFiNotification(array{byte} notification, dict info)
+
+			Requests the agent to process WiFi related LTE Coexistence information
+			The dictionary info contains vector table with modem recommended Safe
+			Tx/Rx band and range information. The properties involved are
+			'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and 'SafeVector'.
+
+			Possible Errors: None
+
+		void Release() [noreply]
+
+			Agent is being released, possibly because of oFono
+			terminating, Coex interface is being torn down or modem
+			off.  No UnregisterAgent call is needed.
+
+
+Properties	string LTEBand [readwrite]
+			Frequency band in which the modem is operating when using "lte" mode.
+
+			boolean CoexBTActive [readwrite]
+			Maintains whether BT Coex is activated or not.
+
+			boolean CoexWLANActive [readwrite]
+			Maintains whether WLAN Coex is activated or not.
+
+			string CoexWLANBandwidth [readwrite]
+			Maintains at what frequency WLAN Coex is activated, when "CoexWLANActive"
+			is active.
+			The possible values are:
+			- "20MHz"
+			- "40MHz"
+			- "80MHz"
+
+LTE Plmn history params
+=================================
+string
+	uint16 MobileNetworkCode [readonly, optional]
+		Contains the MNC of the cell.
+
+string
+	uint16 MobileCountryCode [readonly, optional]
+		Contains the MCC of the cell.
+
+	uint32 LteBandsFDD [readonly, optional]
+		Contains the Lte FDD band. Valid range
+		of values is 1 to 32 as per 3GPP 36.101 Section 5.5.
+
+	uint32 LteBandsTDD [readonly, optional]
+		Contains the Lte TDD band. Valid range
+		of values is 33 to 64 as per 3GPP 36.101 Section 5.5.
+
+	uint8 ChannelBandwidth [readonly, optional]
+		Contains the Channel bandwidth. Valid range
+		of values is 0 to 6 as per 3GPP 36.101 Section 5.6.
-- 
1.9.1

Re: [PATCH 1/3] coex: Adding documetation for coex interface

[Denis Kenzior]

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

Hi Antara,

On 11/26/2018 04:17 AM, Antara Borwankar wrote:
> From: Antara <antara.borwankar@intel.com>
> 
> Added coex-api.txt which defines coex interface for intel modems
> ---
>   doc/coex-api.txt | 122 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 122 insertions(+)
>   create mode 100644 doc/coex-api.txt
> 
> diff --git a/doc/coex-api.txt b/doc/coex-api.txt
> new file mode 100644
> index 0000000..12693a4
> --- /dev/null
> +++ b/doc/coex-api.txt
> @@ -0,0 +1,122 @@
> +LTE Coexistence hierarchy
> +===============
> +
> +Service		org.ofono
> +Interface	org.ofono.IntelLTECoex*

I'd propose org.ofono.intel.LteCoexistence to be more in line with our 
CamelCase APIs and the preference to not shorten names.  You also use 
LTECoexistenceAgent below, so for consistency it might be better to 
spell out Coexistence here as well.

> +Object path	[variable prefix]/{modem0,modem1,...}
> +
> +Methods		dict GetProperties()
> +			Returns all coexistence configuration properties.
> +
> +			void SetProperty(string property, variant value)
> +			Changes the value of the specified property. Only properties that are

Please be mindful of the 80 character / line limit.  This applies to 
documentation as well.

> +			listed as Read-write are changeable.
> +			On success a PropertyChanged signal will be emitted.
> +
> +			Possible Errors: [service].Error.InProgress
> +						[service].Error.InvalidArguments
> +						[service].Error.Failed
> +
> +
> +		void RegisterAgent(object path)
> +
> +			Registers an agent which will be called whenever the
> +			modem initiates LTE Coexistence information.
> +
> +			Possible Errors: [service].Error.InProgress
> +					 [service].Error.InvalidArguments
> +					 [service].Error.InvalidFormat
> +					 [service].Error.Failed
> +
> +		void UnregisterAgent(object path)
> +
> +			Unregisters an agent.
> +
> +			Possible Errors: [service].Error.InvalidArguments
> +					 [service].Error.Failed
> +
> +		a(a{sv}) GetPlmnHistory()
> +			Requests for LTE Plmn history list stored in NVM to
> +			retrieve geo location history like MobileNetworkCode,
> +			MobileCountryCode, LteBandsFDD, LteBandsTDD, ChannelBandwidth.
> +			*most recently uused
> +			*privacy
> +

What's the stuff after '*'?  Seems unrelated.

> +			Refer to the sections below for which property types
> +			are available, their valid value ranges and
> +			applicability to different cell types.
> +
> +Signals		PropertyChanged(string property, variant value)
> +			This signal indicates a changed value of the given property.
> +
> +
> +LTECoexistenceAgent Hierarchy [experimental]
> +===============
> +
> +Service		unique name
> +Interface	org.ofono.IntelLTECoexAgent

You use LTECoexistenceAgent above and LTECoexAgent here.  Lets be 
consistent.  So maybe org.ofono.intel.LTECoexistenceAgent?

> +Object path	freely definable
> +
> +Methods		void ReceiveBluetoothNotification(array{byte} notification, dict info)
> +
> +			Requests the agent to process BT related LTE Coexistence information
> +			The dictionary info contains vector table with modem recommended Safe
> +			Tx/Rx band and range information.The properties involved are
> +			'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and 'SafeVector'.
> +
> +			Possible Errors: None
> +
> +		void ReceiveWiFiNotification(array{byte} notification, dict info)
> +
> +			Requests the agent to process WiFi related LTE Coexistence information
> +			The dictionary info contains vector table with modem recommended Safe
> +			Tx/Rx band and range information. The properties involved are
> +			'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and 'SafeVector'.
> +
> +			Possible Errors: None
> +
> +		void Release() [noreply]
> +
> +			Agent is being released, possibly because of oFono
> +			terminating, Coex interface is being torn down or modem
> +			off.  No UnregisterAgent call is needed.
> +
> +
> +Properties	string LTEBand [readwrite]

Since this is 'LTECoexistence', the LTE prefix here is a bit redundant. 
So maybe just 'Band'?

> +			Frequency band in which the modem is operating when using "lte" mode.
> +
> +			boolean CoexBTActive [readwrite]
> +			Maintains whether BT Coex is activated or not.
> +
> +			boolean CoexWLANActive [readwrite]
> +			Maintains whether WLAN Coex is activated or not.
> +
> +			string CoexWLANBandwidth [readwrite]
> +			Maintains at what frequency WLAN Coex is activated, when "CoexWLANActive"
> +			is active.
> +			The possible values are:
> +			- "20MHz"
> +			- "40MHz"
> +			- "80MHz"

Same thing here, Coexistence is already in the name.  So Coex is 
redundant.  Maybe WLANBandwidth, WLANActive, etc.

> +
> +LTE Plmn history params
> +=================================
> +string
> +	uint16 MobileNetworkCode [readonly, optional]
> +		Contains the MNC of the cell.
> +
> +string
> +	uint16 MobileCountryCode [readonly, optional]
> +		Contains the MCC of the cell.
> +
> +	uint32 LteBandsFDD [readonly, optional]
> +		Contains the Lte FDD band. Valid range
> +		of values is 1 to 32 as per 3GPP 36.101 Section 5.5.
> +
> +	uint32 LteBandsTDD [readonly, optional]
> +		Contains the Lte TDD band. Valid range
> +		of values is 33 to 64 as per 3GPP 36.101 Section 5.5.
> +
> +	uint8 ChannelBandwidth [readonly, optional]
> +		Contains the Channel bandwidth. Valid range
> +		of values is 0 to 6 as per 3GPP 36.101 Section 5.6.
> 

Regards,
-Denis

Re: [PATCH 1/3] coex: Adding documetation for coex interface

[Pavel Machek]

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

Hi!

> +LTE Coexistence hierarchy
> +===============
> +
> +Service		org.ofono
> +Interface	org.ofono.IntelLTECoex*
> +Object path	[variable prefix]/{modem0,modem1,...}

The interface should be generic, not Intel-specific in the end, right?


> +		a(a{sv}) GetPlmnHistory()
> +			Requests for LTE Plmn history list stored in NVM to
> +			retrieve geo location history like MobileNetworkCode,
> +			MobileCountryCode, LteBandsFDD, LteBandsTDD, ChannelBandwidth.
> +			*most recently uused

"uused" is typo?


-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: [PATCH 1/3] coex: Adding documetation for coex interface

[Giacinto Cifelli]

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

Hi,

On Tue, Nov 27, 2018 at 10:01 AM Pavel Machek <pavel@ucw.cz> wrote:
>
> Hi!
>
> > +LTE Coexistence hierarchy
> > +===============
> > +
> > +Service              org.ofono
> > +Interface    org.ofono.IntelLTECoex*
> > +Object path  [variable prefix]/{modem0,modem1,...}
>
> The interface should be generic, not Intel-specific in the end, right?

We discussed this earlier.
It is Intel-specific, because it uses non-standard command to disable
bands colliding with the WiFi frequencies, and perhaps only
interesting for these modems.

>
>
> > +             a(a{sv}) GetPlmnHistory()
> > +                     Requests for LTE Plmn history list stored in NVM to
> > +                     retrieve geo location history like MobileNetworkCode,
> > +                     MobileCountryCode, LteBandsFDD, LteBandsTDD, ChannelBandwidth.
> > +                     *most recently uused
>
> "uused" is typo?
>

BR,
Giacinto

>
> --
> (english) http://www.livejournal.com/~pavelmachek
> (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
> _______________________________________________
> ofono mailing list
> ofono(a)ofono.org
> https://lists.ofono.org/mailman/listinfo/ofono

Re: [PATCH 1/3] coex: Adding documetation for coex interface

[Denis Kenzior]

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

Hi Pavel,

On 11/27/2018 03:01 AM, Pavel Machek wrote:
> Hi!
> 
>> +LTE Coexistence hierarchy
>> +===============
>> +
>> +Service		org.ofono
>> +Interface	org.ofono.IntelLTECoex*
>> +Object path	[variable prefix]/{modem0,modem1,...}
> 
> The interface should be generic, not Intel-specific in the end, right?

This would be ideal, however we have no idea how this type of 
functionality works on modems from other manufacturers.  So until we can 
determine that a generic API is possible, we're keeping this one as a 
vendor specific API.

Regards,
-Denis

[PATCH 1/3] coex: Adding documetation for coex interface

[Antara Borwankar]

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

From: Antara <antara.borwankar@intel.com>

Added coex-api.txt which defines coex interface for intel modems
---
 doc/coex-api.txt | 126 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 126 insertions(+)
 create mode 100644 doc/coex-api.txt

diff --git a/doc/coex-api.txt b/doc/coex-api.txt
new file mode 100644
index 0000000..8f5da47
--- /dev/null
+++ b/doc/coex-api.txt
@@ -0,0 +1,126 @@
+LTE Coexistence hierarchy
+===============
+
+Service		org.ofono
+Interface	org.ofono.org.ofono.intel.LteCoexistence
+Object path	[variable prefix]/{modem0,modem1,...}
+
+Methods		dict GetProperties()
+			Returns all coexistence configuration properties.
+
+			void SetProperty(string property, variant value)
+			Changes the value of the specified property. Only properties that
+			are listed as Read-write are changeable.
+			On success a PropertyChanged signal will be emitted.
+
+			Possible Errors: [service].Error.InProgress
+						[service].Error.InvalidArguments
+						[service].Error.Failed
+
+
+		void RegisterAgent(object path)
+
+			Registers an agent which will be called whenever the
+			modem initiates LTE Coexistence information.
+
+			Possible Errors: [service].Error.InProgress
+					 [service].Error.InvalidArguments
+					 [service].Error.InvalidFormat
+					 [service].Error.Failed
+
+		void UnregisterAgent(object path)
+
+			Unregisters an agent.
+
+			Possible Errors: [service].Error.InvalidArguments
+					 [service].Error.Failed
+
+		a(a{sv}) GetPlmnHistory()
+			Requests for LTE Plmn history list stored in NVM to
+			retrieve geo location history like MobileNetworkCode,
+			MobileCountryCode, LteBandsFDD, LteBandsTDD, ChannelBandwidth.
+
+			Refer to the sections below for which property types
+			are available, their valid value ranges and
+			applicability to different cell types.
+
+Signals		PropertyChanged(string property, variant value)
+			This signal indicates a changed value of the given property.
+
+
+LTECoexistenceAgent Hierarchy [experimental]
+===============
+
+Service		unique name
+Interface	org.ofono.intel.LteCoexistenceAgent 
+Object path	freely definable
+
+Methods		void ReceiveBluetoothNotification
+							(array{byte} notification, dict info) [noreply]
+
+			Requests the agent to process BT related LTE Coexistence
+			information. The dictionary info contains vector table with modem
+			recommended Safe Tx/Rx band and range information.The properties
+			involved are 'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and
+			'SafeVector'.
+
+			Possible Errors: None
+
+		void ReceiveWiFiNotification
+							(array{byte} notification, dict info) [noreply]
+
+			Requests the agent to process WiFi related LTE Coexistence
+			information. The dictionary info contains vector table with modem
+			recommended SafeTx/Rx band and range information. The properties
+			involved are'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and
+			'SafeVector'.
+
+			Possible Errors: None
+
+		void Release() [noreply]
+
+			Agent is being released, possibly because of oFono
+			terminating, Coex interface is being torn down or modem
+			off. No UnregisterAgent call is needed.
+
+
+Properties	string Band [readwrite]
+			Frequency band in which the modem is operating when using "lte"
+			mode.
+
+			boolean BTActive [readwrite]
+			Maintains whether BT Coex is activated or not.
+
+			boolean WLANActive [readwrite]
+			Maintains whether WLAN Coex is activated or not.
+
+			string WLANBandwidth [readwrite]
+			Maintains at what frequency WLAN Coex is activated, when
+			"CoexWLANActive"
+			is active.
+			The possible values are:
+			- "20MHz"
+			- "40MHz"
+			- "80MHz"
+
+LTE Plmn history params
+=================================
+string
+	uint16 MobileNetworkCode [readonly, optional]
+		Contains the MNC of the cell.
+
+string
+	uint16 MobileCountryCode [readonly, optional]
+		Contains the MCC of the cell.
+
+	uint32 LteBandsFDD [readonly, optional]
+		Contains the Lte FDD band. Valid range
+		of values is 1 to 32 as per 3GPP 36.101 Section 5.5.
+
+	uint32 LteBandsTDD [readonly, optional]
+		Contains the Lte TDD band. Valid range
+		of values is 33 to 64 as per 3GPP 36.101 Section 5.5.
+
+	uint8 ChannelBandwidth [readonly, optional]
+		Contains the Channel bandwidth. Valid range
+		of values is 0 to 6 as per 3GPP 36.101 Section 5.6.
-- 
1.9.1

RE: [PATCH 1/3] coex: Adding documetation for coex interface

[Navik, Ankit P]

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

Hi Antara,

On 11/30/2018 03:11 PM, Antara Borwankar wrote:
> From: Antara <antara.borwankar@intel.com>
> 
> Added coex-api.txt which defines coex interface for intel modems
> ---
>  doc/coex-api.txt | 126
> +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 126 insertions(+)
>  create mode 100644 doc/coex-api.txt
> 
> diff --git a/doc/coex-api.txt b/doc/coex-api.txt new file mode 100644 index
> 0000000..8f5da47
> --- /dev/null
> +++ b/doc/coex-api.txt
> @@ -0,0 +1,126 @@
> +LTE Coexistence hierarchy
> +===============
> +
> +Service		org.ofono
> +Interface	org.ofono.org.ofono.intel.LteCoexistence
May be typo here. Interface should be org.ofono.intel.LteCoexistence

Regards, Ankit

> +Object path	[variable prefix]/{modem0,modem1,...}
> +
> +Methods		dict GetProperties()
> +			Returns all coexistence configuration properties.
> +
> +			void SetProperty(string property, variant value)
> +			Changes the value of the specified property. Only
> properties that
> +			are listed as Read-write are changeable.
> +			On success a PropertyChanged signal will be emitted.
> +
> +			Possible Errors: [service].Error.InProgress
> +
> 	[service].Error.InvalidArguments
> +						[service].Error.Failed
> +
> +
> +		void RegisterAgent(object path)
> +
> +			Registers an agent which will be called whenever the
> +			modem initiates LTE Coexistence information.
> +
> +			Possible Errors: [service].Error.InProgress
> +					 [service].Error.InvalidArguments
> +					 [service].Error.InvalidFormat
> +					 [service].Error.Failed
> +
> +		void UnregisterAgent(object path)
> +
> +			Unregisters an agent.
> +
> +			Possible Errors: [service].Error.InvalidArguments
> +					 [service].Error.Failed
> +
> +		a(a{sv}) GetPlmnHistory()
> +			Requests for LTE Plmn history list stored in NVM to
> +			retrieve geo location history like MobileNetworkCode,
> +			MobileCountryCode, LteBandsFDD, LteBandsTDD,
> ChannelBandwidth.
> +
> +			Refer to the sections below for which property types
> +			are available, their valid value ranges and
> +			applicability to different cell types.
> +
> +Signals		PropertyChanged(string property, variant value)
> +			This signal indicates a changed value of the given
> property.
> +
> +
> +LTECoexistenceAgent Hierarchy [experimental] ===============
> +
> +Service		unique name
> +Interface	org.ofono.intel.LteCoexistenceAgent
> +Object path	freely definable
> +
> +Methods		void ReceiveBluetoothNotification
> +							(array{byte}
> notification, dict info) [noreply]
> +
> +			Requests the agent to process BT related LTE
> Coexistence
> +			information. The dictionary info contains vector table
> with modem
> +			recommended Safe Tx/Rx band and range
> information.The properties
> +			involved are 'SafeTxMin', 'SafeRxMin', 'SafeTxMax',
> 'SafeRxMax' and
> +			'SafeVector'.
> +
> +			Possible Errors: None
> +
> +		void ReceiveWiFiNotification
> +							(array{byte}
> notification, dict info) [noreply]
> +
> +			Requests the agent to process WiFi related LTE
> Coexistence
> +			information. The dictionary info contains vector table
> with modem
> +			recommended SafeTx/Rx band and range information.
> The properties
> +			involved are'SafeTxMin', 'SafeRxMin', 'SafeTxMax',
> 'SafeRxMax' and
> +			'SafeVector'.
> +
> +			Possible Errors: None
> +
> +		void Release() [noreply]
> +
> +			Agent is being released, possibly because of oFono
> +			terminating, Coex interface is being torn down or
> modem
> +			off. No UnregisterAgent call is needed.
> +
> +
> +Properties	string Band [readwrite]
> +			Frequency band in which the modem is operating when
> using "lte"
> +			mode.
> +
> +			boolean BTActive [readwrite]
> +			Maintains whether BT Coex is activated or not.
> +
> +			boolean WLANActive [readwrite]
> +			Maintains whether WLAN Coex is activated or not.
> +
> +			string WLANBandwidth [readwrite]
> +			Maintains at what frequency WLAN Coex is activated,
> when
> +			"CoexWLANActive"
> +			is active.
> +			The possible values are:
> +			- "20MHz"
> +			- "40MHz"
> +			- "80MHz"
> +
> +LTE Plmn history params
> +=================================
> +string
> +	uint16 MobileNetworkCode [readonly, optional]
> +		Contains the MNC of the cell.
> +
> +string
> +	uint16 MobileCountryCode [readonly, optional]
> +		Contains the MCC of the cell.
> +
> +	uint32 LteBandsFDD [readonly, optional]
> +		Contains the Lte FDD band. Valid range
> +		of values is 1 to 32 as per 3GPP 36.101 Section 5.5.
> +
> +	uint32 LteBandsTDD [readonly, optional]
> +		Contains the Lte TDD band. Valid range
> +		of values is 33 to 64 as per 3GPP 36.101 Section 5.5.
> +
> +	uint8 ChannelBandwidth [readonly, optional]
> +		Contains the Channel bandwidth. Valid range
> +		of values is 0 to 6 as per 3GPP 36.101 Section 5.6.
> --
> 1.9.1
> 
> _______________________________________________
> ofono mailing list
> ofono(a)ofono.org
> https://lists.ofono.org/mailman/listinfo/ofono

[PATCH 1/3] coex: Adding documetation for coex interface

[Antara Borwankar]

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

From: Antara <antara.borwankar@intel.com>

Added coex-api.txt which defines coex interface for intel modems
---
 doc/coex-api.txt | 126 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 126 insertions(+)
 create mode 100644 doc/coex-api.txt

diff --git a/doc/coex-api.txt b/doc/coex-api.txt
new file mode 100644
index 0000000..5fef3f4
--- /dev/null
+++ b/doc/coex-api.txt
@@ -0,0 +1,126 @@
+LTE Coexistence hierarchy
+===============
+
+Service		org.ofono
+Interface	org.ofono.intel.LteCoexistence
+Object path	[variable prefix]/{modem0,modem1,...}
+
+Methods		dict GetProperties()
+			Returns all coexistence configuration properties.
+
+			void SetProperty(string property, variant value)
+			Changes the value of the specified property. Only properties that
+			are listed as Read-write are changeable.
+			On success a PropertyChanged signal will be emitted.
+
+			Possible Errors: [service].Error.InProgress
+						[service].Error.InvalidArguments
+						[service].Error.Failed
+
+
+		void RegisterAgent(object path)
+
+			Registers an agent which will be called whenever the
+			modem initiates LTE Coexistence information.
+
+			Possible Errors: [service].Error.InProgress
+					 [service].Error.InvalidArguments
+					 [service].Error.InvalidFormat
+					 [service].Error.Failed
+
+		void UnregisterAgent(object path)
+
+			Unregisters an agent.
+
+			Possible Errors: [service].Error.InvalidArguments
+					 [service].Error.Failed
+
+		a(a{sv}) GetPlmnHistory()
+			Requests for LTE Plmn history list stored in NVM to
+			retrieve geo location history like MobileNetworkCode,
+			MobileCountryCode, LteBandsFDD, LteBandsTDD, ChannelBandwidth.
+
+			Refer to the sections below for which property types
+			are available, their valid value ranges and
+			applicability to different cell types.
+
+Signals		PropertyChanged(string property, variant value)
+			This signal indicates a changed value of the given property.
+
+
+LTECoexistenceAgent Hierarchy [experimental]
+===============
+
+Service		unique name
+Interface	org.ofono.intel.LteCoexistenceAgent 
+Object path	freely definable
+
+Methods		void ReceiveBluetoothNotification
+			(array{byte} notification, dict info) [noreply]
+
+			Requests the agent to process BT related LTE Coexistence
+			information. The dictionary info contains vector table with modem
+			recommended Safe Tx/Rx band and range information.The properties
+			involved are 'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and
+			'SafeVector'.
+
+			Possible Errors: None
+
+		void ReceiveWiFiNotification
+			(array{byte} notification, dict info) [noreply]
+
+			Requests the agent to process WiFi related LTE Coexistence
+			information. The dictionary info contains vector table with modem
+			recommended SafeTx/Rx band and range information. The properties
+			involved are'SafeTxMin', 'SafeRxMin', 'SafeTxMax', 'SafeRxMax' and
+			'SafeVector'.
+
+			Possible Errors: None
+
+		void Release() [noreply]
+
+			Agent is being released, possibly because of oFono
+			terminating, Coex interface is being torn down or modem
+			off. No UnregisterAgent call is needed.
+
+
+Properties	string Band [readwrite]
+			Frequency band in which the modem is operating when using "lte"
+			mode.
+
+			boolean BTActive [readwrite]
+			Maintains whether BT Coex is activated or not.
+
+			boolean WLANActive [readwrite]
+			Maintains whether WLAN Coex is activated or not.
+
+			string WLANBandwidth [readwrite]
+			Maintains at what frequency WLAN Coex is activated, when
+			"CoexWLANActive"
+			is active.
+			The possible values are:
+			- "20MHz"
+			- "40MHz"
+			- "80MHz"
+
+LTE Plmn history params
+=================================
+string
+	uint16 MobileNetworkCode [readonly, optional]
+		Contains the MNC of the cell.
+
+string
+	uint16 MobileCountryCode [readonly, optional]
+		Contains the MCC of the cell.
+
+	uint32 LteBandsFDD [readonly, optional]
+		Contains the Lte FDD band. Valid range
+		of values is 1 to 32 as per 3GPP 36.101 Section 5.5.
+
+	uint32 LteBandsTDD [readonly, optional]
+		Contains the Lte TDD band. Valid range
+		of values is 33 to 64 as per 3GPP 36.101 Section 5.5.
+
+	uint8 ChannelBandwidth [readonly, optional]
+		Contains the Channel bandwidth. Valid range
+		of values is 0 to 6 as per 3GPP 36.101 Section 5.6.
-- 
1.9.1

Re: [PATCH 1/3] coex: Adding documetation for coex interface

[Denis Kenzior]

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

On 12/03/2018 03:19 AM, Antara Borwankar wrote:
> From: Antara <antara.borwankar@intel.com>
> 
> Added coex-api.txt which defines coex interface for intel modems
> ---
>   doc/coex-api.txt | 126 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 126 insertions(+)
>   create mode 100644 doc/coex-api.txt
> 

I performed some cleanups of the contents and renamed the file to 
intel-lte-coex-api.txt.  Patch has been applied, thanks.

Regards,
-Denis