Differential D2370 Diff 5733 plugins/platforms/drm/drm_object.h

Changeset View

Standalone View

plugins/platforms/drm/drm_object.h

This file was added.

1		/********************************************************************
2		KWin - the KDE window manager
3		This file is part of the KDE project.
4
5		Copyright (C) 2016 Roman Gilg <subdiff@gmail.com>
6
7		This program is free software; you can redistribute it and/or modify
8		it under the terms of the GNU General Public License as published by
9		the Free Software Foundation; either version 2 of the License, or
10		(at your option) any later version.
11
12		This program is distributed in the hope that it will be useful,
13		but WITHOUT ANY WARRANTY; without even the implied warranty of
14		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		GNU General Public License for more details.
16
17		You should have received a copy of the GNU General Public License
18		along with this program. If not, see <http://www.gnu.org/licenses/>.
19		*********************************************************************/
20		#ifndef KWIN_DRM_OBJECT_H
21		#define KWIN_DRM_OBJECT_H
22
23		#include <QVector>
24		#include <QByteArray>
25
26		// drm
27		#include <xf86drmMode.h>
28
29
30		namespace KWin
31		{
32
33		class DrmOutput;
34
35		class DrmObject
36		{
37		public:
38		// creates drm object by its id delivered by the kernel
39		DrmObject(uint32_t object_id, int fd);
40
41		virtual ~DrmObject() = 0;
42
43		uint32_t id() const {
44		return m_id;
45		}
46
47		DrmOutput* output() const {
48		return m_output;
49		}
50		void setOutput(DrmOutput* output) {
51		m_output = output;
52		}
53
54		uint32_t propId(int index) {
55		return m_props[index]->propId();
56		}
57		uint64_t propValue(int index)
58		{
59		return m_props[index]->value();
60		}
61		int setPropValue(int index, uint64_t new_value);
62
63		uint32_t propsPending() {
64		return m_propsPending;
65		}
66		uint32_t propsValid() {
67		return m_propsValid;
68		}
69		void setPropsPending(uint32_t value) {
	graesslinUnsubmitted Done what does the int return value mean? I see 0 and -1 being returned from the implementation. Maybe bool would be better? graesslin: what does the int return value mean? I see 0 and -1 being returned from the implementation.
70		m_propsPending = value;
71		}
72		void setPropsValid(uint32_t value) {
73		m_propsValid = value;
74		}
75
76		int atomicAddProperty(drmModeAtomicReq *req, int prop, uint64_t value);
77
78		protected:
79		const int m_fd = 0;
80		const uint32_t m_id = 0;
81
82		DrmOutput *m_output = nullptr;
83
84		QVector<QByteArray> m_propsNames; // for comparision with received name of DRM object
	graesslinUnsubmitted Done same here. What does the return value mean? From implementation it seems to be tri-state? graesslin: same here. What does the return value mean? From implementation it seems to be tri-state?
85		class Prop;
86		QVector<Prop*> m_props;
87
88		uint32_t m_propsPending = 0;
89		uint32_t m_propsValid = 0;
90
91		virtual int initProps() = 0; // only derived classes know names and quantity of properties
92		void initProp(int n, drmModeObjectProperties *properties, QVector<QByteArray> enumNames = QVector<QByteArray>(0));
93
94		class Prop
	graesslinUnsubmitted Done I suggest to rename to Property or maybe DrmProperty? graesslin: I suggest to rename to Property or maybe DrmProperty?
	romanggAuthorUnsubmitted Done Ok, I chose Property over DrmProperty, because the class is only visible from within DrmObject and subclasses and all access to its objects goes through DrmObject. Do you like the reasoning, i.e. is it in line with other code in KWin? romangg: Ok, I chose Property over DrmProperty, because the class is only visible from within DrmObject…
	graesslinUnsubmitted Done yep that's a fine reasoning. graesslin: yep that's a fine reasoning.
95		{
96		public:
97		Prop(drmModePropertyRes *prop, uint64_t val, QVector<QByteArray> enumNames);
98		virtual ~Prop();
99
100		void initEnumMap(drmModePropertyRes *prop);
101
102		uint64_t enumMap(int n) {
103		return m_enumMap[n]; // TODO: test on index out of bounds?
104		}
105
106		uint32_t propId() {
107		return m_propId;
108		}
109		uint32_t value() {
110		return m_value;
111		}
112		void setValue(uint64_t new_value) {
113		m_value = new_value;
114		}
115
116		private:
117		uint32_t m_propId = 0;
118		QByteArray m_propName;
119
120		uint64_t m_value = 0;
121		QVector<uint64_t> m_enumMap;
122		QVector<QByteArray> m_enumNames;
123		};
124		};
125
126
127		}
128
129		#endif
130