diff options
author | Yusuke Binsaki <yusuke.binsaki@itage.co.jp> | 2016-02-10 18:52:59 +0900 |
---|---|---|
committer | Yusuke Binsaki <yusuke.binsaki@itage.co.jp> | 2016-02-12 21:29:13 +0000 |
commit | f144f0f71f1b75df9216c36747513444c7941c09 (patch) | |
tree | 4e2db8eed7c4f915fb8ed51a7e8c583bf442f456 /src/plugins/shellintegration/ivi-shell/README | |
parent | 74b1ec474d1d48242893dcaf58b8a35f155f3fc3 (diff) |
Implement initial IVI-shell support with shell integration.
IVI-shell provides a shell interface for Weston, which maps the GENIVI
API (http://www.genivi.org) for In-Vehicle Infotainment as Wayland-Ivi-Extension
(http://wiki.projects.genivi.org/index.php/Wayland_IVI_Extension_Design).
This patch is included in two protocol. The first is ivi-application protocol
which provided by weston. Next is ivi-controller protocol which provided by
Genivi's wayland-ivi-extension.
In IVI use case, the client create and destroy surface with the unique ID
by using ivi-application protocol. On the other hand, the controller such as
HMI Controller control some properties, which are visibility, position, size,
etc, with created the unique ID by using ivi-controller protocol.
It means the unique ID is necessary to create and control the ivi-surface and
the the ivi-layer. However Qt has no API to set the some surface or layer ID.
In this ivi-shell plugin, the unique ID can be set via the environment
parameter so that we can control the ivi-surface and ivi-layer. The
name of environment parameter is QT_IVI_SURFACE_ID.
QT_IVI_SURFACE_ID will be used as ivi-surface and ivi-layer. If application
needs more than two surfaces, ivi-surface IDs will be incremented.
When QT_IVI_SURFACE_ID isn't set, ivi-surface and ivi-layer ID will be
generated internally. The ID consists of the process ID and the surface
ID which is incremented in ivi-shell plugin.
The process ID is used as lower 22 bit per 32bit. 23 to 32 bit is used as
the surface IDs in a process.
e.g. When the process ID is 0x765 and create two surfaces,
ivi-layer ID is 0x765 and ivi-surface IDs are 0x765 and 0x00400765.
+------------+---------------------------+
|31 23|22 0|
+------------+---------------------------+
|0000 0000 00|00 0000 0000 0000 0000 0000|
|<- ID ->|<- process ID ->|
+------------+---------------------------+
We can set QT_WAYLAND_SHELL_INTEGRATION of the environment
parameter to "ivi-shell" to use IVI-shell.
Change-Id: Iddcfb3de89dc022530c0285524cf6bbf640147b6
Reviewed-by: Giulio Camuffo <giuliocamuffo@gmail.com>
Diffstat (limited to 'src/plugins/shellintegration/ivi-shell/README')
-rw-r--r-- | src/plugins/shellintegration/ivi-shell/README | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/src/plugins/shellintegration/ivi-shell/README b/src/plugins/shellintegration/ivi-shell/README new file mode 100644 index 000000000..244458650 --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/README @@ -0,0 +1,33 @@ +IVI-shell +========= + +IVI-shell provides a shell interface for Weston, which maps the GENIVI +API (http://www.genivi.org) for In-Vehicle Infotainment as Wayland-Ivi-Extension +(http://wiki.projects.genivi.org/index.php/Wayland_IVI_Extension_Design). + +This module includes two protocols: ivi-application (provided by weston), and +ivi-controller (provided by GENIVI's wayland-ivi-extension). +In IVI use case, the client creates and destroys a surface using a +unique ID acquired from the ivi-application protocol. +On the other hand, a controller (such as the HMI Controller) manages a set of +properties (visibility, position, size, etc.), +created using unique IDs provided by the ivi-controller protocol. +A Unique ID is necessary to create and control both the ivi-surface and +the ivi-layer, however Qt has no API for setting these IDs. + +The ivi-shell plugin works around this limitation by setting the unique ID via +the environment variable QT_IVI_SURFACE_ID, used for both ivi-surface and +ivi-layer. If an application needs more than two surfaces, +ivi-surface IDs will be incremented automatically. If QT_IVI_SURFACE_ID is +not set, ivi-surface and ivi-layer IDs will be generated internally. +QT_IVI_SURFACE_ID is a 32 bit value composed of the process ID and the +surface ID. Bits 0 to 22 represent the process ID, and bits 23 to 32 represent +the surface ID in a process. +For example, when the process ID is 0x765 and there are two surfaces, +ivi-layer ID is 0x765 and ivi-surface IDs are 0x765 and 0x00400765. + +------------+---------------------------+ + |31 23|22 0| + +------------+---------------------------+ + |0000 0000 00|00 0000 0000 0000 0000 0000| + |<- ID ->|<- process ID ->| + +------------+---------------------------+ |