overlayCtrlData.h revision 513ddc2124abf90c63af41999201f0d2031af0c8 
1/*
2* Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
3*
4* Redistribution and use in source and binary forms, with or without
5* modification, are permitted provided that the following conditions are
6* met:
7*    * Redistributions of source code must retain the above copyright
8*      notice, this list of conditions and the following disclaimer.
9*    * Redistributions in binary form must reproduce the above
10*      copyright notice, this list of conditions and the following
11*      disclaimer in the documentation and/or other materials provided
12*      with the distribution.
13*    * Neither the name of The Linux Foundation nor the names of its
14*      contributors may be used to endorse or promote products derived
15*      from this software without specific prior written permission.
16*
17* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20* ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27* IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*/
29
30#ifndef OVERLAY_CTRLDATA_H
31#define OVERLAY_CTRLDATA_H
32
33#include "overlayUtils.h"
34#include "overlayMdp.h"
35#include "gralloc_priv.h" // INTERLACE_MASK
36
37namespace ovutils = overlay::utils;
38
39namespace overlay {
40
41/*
42* Sequence to use:
43* init
44* start
45* setXXX
46* close
47* */
48class Ctrl : utils::NoCopy {
49public:
50
51    /* ctor */
52    explicit Ctrl();
53    /* dtor close */
54    ~Ctrl();
55    /* init fd etc*/
56    bool init(uint32_t fbnum);
57    /* close underlying mdp */
58    bool close();
59
60    /* set source using whf, orient and wait flag */
61    void setSource(const utils::PipeArgs& args);
62    /* set crop info and pass it down to mdp */
63    void setCrop(const utils::Dim& d);
64    /* set orientation */
65    void setTransform(const utils::eTransform& p);
66    /* set mdp position using dim */
67    void setPosition(const utils::Dim& dim);
68    /* set mdp visual params using metadata */
69    bool setVisualParams(const MetaData_t &metadata);
70    /* mdp set overlay/commit changes */
71    bool commit();
72
73    /* ctrl id */
74    int  getPipeId() const;
75    /* ctrl fd */
76    int  getFd() const;
77    /* retrieve crop data */
78    utils::Dim getCrop() const;
79    utils::Dim getPosition() const;
80    /* Set downscale */
81    void setDownscale(int dscale_factor);
82    /* Update the src format based on rotator's dest */
83    void updateSrcFormat(const uint32_t& rotDstFormat);
84    /* dump the state of the object */
85    void dump() const;
86    /* Return the dump in the specified buffer */
87    void getDump(char *buf, size_t len);
88    void forceSet();
89
90private:
91    // mdp ctrl struct(info e.g.)
92    MdpCtrl mMdp;
93};
94
95
96class Data : utils::NoCopy {
97public:
98    /* init, reset */
99    explicit Data();
100    /* calls close */
101    ~Data();
102    /* init fd etc */
103    bool init(uint32_t fbnum);
104    /* calls underlying mdp close */
105    bool close();
106    /* set overlay pipe id in the mdp struct */
107    void setPipeId(int id);
108    /* get overlay id in the mdp struct */
109    int getPipeId() const;
110    /* queue buffer to the overlay */
111    bool queueBuffer(int fd, uint32_t offset);
112    /* sump the state of the obj */
113    void dump() const;
114    /* Return the dump in the specified buffer */
115    void getDump(char *buf, size_t len);
116
117private:
118    // mdp data struct
119    MdpData mMdp;
120};
121
122/* This class just creates a Ctrl Data pair to be used by a pipe.
123 * Although this was legacy design, this separation still makes sense, since we
124 * need to use the Ctrl channel in hwc_prepare (i.e config stage) and Data
125 * channel in hwc_set (i.e draw stage)
126 */
127struct CtrlData {
128    Ctrl ctrl;
129    Data data;
130};
131
132//-------------Inlines-------------------------------
133
134inline Ctrl::Ctrl() {
135    mMdp.reset();
136}
137
138inline Ctrl::~Ctrl() {
139    close();
140}
141
142inline bool Ctrl::close() {
143    if(!mMdp.close())
144        return false;
145    return true;
146}
147
148inline bool Ctrl::init(uint32_t fbnum) {
149    // MDP/FD init
150    if(!mMdp.init(fbnum)) {
151        ALOGE("Ctrl failed to init fbnum=%d", fbnum);
152        return false;
153    }
154    return true;
155}
156
157inline void Ctrl::setSource(const utils::PipeArgs& args)
158{
159    mMdp.setSource(args);
160}
161
162inline void Ctrl::setPosition(const utils::Dim& dim)
163{
164    mMdp.setPosition(dim);
165}
166
167inline void Ctrl::setTransform(const utils::eTransform& orient)
168{
169    mMdp.setTransform(orient);
170}
171
172inline void Ctrl::setCrop(const utils::Dim& d)
173{
174    mMdp.setCrop(d);
175}
176
177inline bool Ctrl::setVisualParams(const MetaData_t &metadata)
178{
179    if (!mMdp.setVisualParams(metadata)) {
180        ALOGE("Ctrl setVisualParams failed in MDP setVisualParams");
181        return false;
182    }
183    return true;
184}
185
186inline void Ctrl::dump() const {
187    ALOGE("== Dump Ctrl start ==");
188    mMdp.dump();
189    ALOGE("== Dump Ctrl end ==");
190}
191
192inline bool Ctrl::commit() {
193    if(!mMdp.set()) {
194        ALOGE("Ctrl commit failed set overlay");
195        return false;
196    }
197    return true;
198}
199
200inline int Ctrl::getPipeId() const {
201    return mMdp.getPipeId();
202}
203
204inline int Ctrl::getFd() const {
205    return mMdp.getFd();
206}
207
208inline void Ctrl::updateSrcFormat(const uint32_t& rotDstFmt) {
209    mMdp.updateSrcFormat(rotDstFmt);
210}
211
212inline utils::Dim Ctrl::getCrop() const {
213    return mMdp.getSrcRectDim();
214}
215
216inline utils::Dim Ctrl::getPosition() const {
217    return mMdp.getDstRectDim();
218}
219
220inline void Ctrl::setDownscale(int dscale_factor) {
221    mMdp.setDownscale(dscale_factor);
222}
223
224inline void Ctrl::getDump(char *buf, size_t len) {
225    mMdp.getDump(buf, len);
226}
227
228inline void Ctrl::forceSet() {
229    mMdp.forceSet();
230}
231
232inline Data::Data() {
233    mMdp.reset();
234}
235
236inline Data::~Data() { close(); }
237
238inline void Data::setPipeId(int id) { mMdp.setPipeId(id); }
239
240inline int Data::getPipeId() const { return mMdp.getPipeId(); }
241
242inline bool Data::init(uint32_t fbnum) {
243    if(!mMdp.init(fbnum)) {
244        ALOGE("Data cannot init mdp");
245        return false;
246    }
247    return true;
248}
249
250inline bool Data::close() {
251    if(!mMdp.close()) {
252        ALOGE("Data close failed");
253        return false;
254    }
255    return true;
256}
257
258inline bool Data::queueBuffer(int fd, uint32_t offset) {
259    return mMdp.play(fd, offset);
260}
261
262inline void Data::dump() const {
263    ALOGE("== Dump Data MDP start ==");
264    mMdp.dump();
265    ALOGE("== Dump Data MDP end ==");
266}
267
268inline void Data::getDump(char *buf, size_t len) {
269    mMdp.getDump(buf, len);
270}
271
272} // overlay
273
274#endif
275