[PATCH 1/6] coex: adding coex interface doc for coex api

[Antara Borwankar]

From: Antara <***@intel.com>

Added coex-api.txt which defines the generic coex dbus inteface
and coex agent interface.
---
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..0601500
--- /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"
+
+*header for 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.

[Pavel Machek]

Hi!

Post by Antara Borwankar
+*header for params
+=================================
+string
+ uint16 MobileNetworkCode [readonly, optional]
+ Contains the MNC of the cell.
+string
+ uint16 MobileCountryCode [readonly, optional]
+ Contains the MCC of the cell.

Confused. What is *header? Is MobileNetworkCode uint16 or string?
Pavel

[Denis Kenzior]

Hi Antara,

Post by Antara Borwankar
Added coex-api.txt which defines the generic coex dbus inteface
and coex agent interface.

So I don't mind this living inside doc, but lets make sure to make it
clear that this is an intel only feature.

So perhaps doc/intel-lte-coex-api.txt

Post by Antara Borwankar
---
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..0601500
--- /dev/null
+++ b/doc/coex-api.txt
@@ -0,0 +1,122 @@
+LTE Coexistence hierarchy
+===============
+
+Service org.ofono
+Interface org.ofono.IntelLTECoex*

org.ofono.intel.LTECoexistence?

Post by Antara Borwankar
+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

?? Some of these look like private notes.

Post by Antara Borwankar
+
+ 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

org.ofono.intel.LTECoexistenceAgent

Post by Antara Borwankar
+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.

Hmm, why is this property on the Agent interface? Are these meant to be
on the LTECoexistence interface?

Also, given that Coex is already in the interface name, I'd just call
this BluetoothActive.

Post by Antara Borwankar
+
+ boolean CoexWLANActive [readwrite]
+ Maintains whether WLAN Coex is activated or not.
+

Similarly here, WiFiActive

Post by Antara Borwankar
+ string CoexWLANBandwidth [readwrite]
+ Maintains at what frequency WLAN Coex is activated, when "CoexWLANActive"
+ is active.
+ - "20MHz"
+ - "40MHz"
+ - "80MHz"

Isn't this the channel 'width'? So WiFiChannelWidth?

Post by Antara Borwankar
+
+*header for params

PLMN History Parameters?

Post by Antara Borwankar
+=================================
+string
+ uint16 MobileNetworkCode [readonly, optional]

string or uint?

Post by Antara Borwankar
+ 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