overlay.h revision 1eda3814b8feedadcc2801b2af4d1076caae55ad 
1/*
2* Copyright (c) 2011-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_H
31#define OVERLAY_H
32
33#include "overlayUtils.h"
34#include "utils/threads.h"
35
36struct MetaData_t;
37
38namespace overlay {
39class GenericPipe;
40
41class Overlay : utils::NoCopy {
42public:
43    enum { DMA_BLOCK_MODE, DMA_LINE_MODE };
44    //Abstract Display types. Each backed by a LayerMixer,
45    //represented by a fb node.
46    //High res panels can be backed by 2 layer mixers and a single fb node.
47    enum { DPY_PRIMARY, DPY_EXTERNAL, DPY_WRITEBACK, DPY_UNUSED };
48    enum { DPY_MAX = DPY_UNUSED };
49    enum { MAX_FB_DEVICES = DPY_MAX };
50
51    /* dtor close */
52    ~Overlay();
53
54    /* Marks the beginning of a drawing round, resets usage bits on pipes
55     * Should be called when drawing begins before any pipe config is done.
56     */
57    void configBegin();
58
59    /* Marks the end of config for this drawing round
60     * Will do garbage collection of pipe objects and thus calling UNSETs,
61     * closing FDs, removing rotator objects and memory, if allocated.
62     * Should be called after all pipe configs are done.
63     */
64    void configDone();
65
66    /* Returns an available pipe based on the type of pipe requested. When ANY
67     * is requested, the first available VG or RGB is returned. If no pipe is
68     * available for the display "dpy" then INV is returned. Note: If a pipe is
69     * assigned to a certain display, then it cannot be assigned to another
70     * display without being garbage-collected once */
71    utils::eDest nextPipe(utils::eMdpPipeType, int dpy);
72
73    void setSource(const utils::PipeArgs args, utils::eDest dest);
74    void setCrop(const utils::Dim& d, utils::eDest dest);
75    void setTransform(const int orientation, utils::eDest dest);
76    void setPosition(const utils::Dim& dim, utils::eDest dest);
77    void setVisualParams(const MetaData_t& data, utils::eDest dest);
78    bool commit(utils::eDest dest);
79    bool queueBuffer(int fd, uint32_t offset, utils::eDest dest);
80
81    /* Closes open pipes, called during startup */
82    static int initOverlay();
83    /* Returns the singleton instance of overlay */
84    static Overlay* getInstance();
85    /* Returns available ("unallocated") pipes for a display */
86    int availablePipes(int dpy);
87    /* Returns if any of the requested pipe type is attached to any of the
88     * displays
89     */
90    bool isPipeTypeAttached(utils::eMdpPipeType type);
91    /* set the framebuffer index for external display */
92    void setExtFbNum(int fbNum);
93    /* Returns framebuffer index of the current external display */
94    /* TODO Deprecate */
95    int getExtFbNum();
96    /* Returns pipe dump. Expects a NULL terminated buffer of big enough size
97     * to populate.
98     */
99    void getDump(char *buf, size_t len);
100    /* Reset usage and allocation bits on all pipes for given display */
101    void clear(int dpy);
102    static void setDMAMode(const int& mode);
103    static int getDMAMode();
104    /* Returns the framebuffer node backing up the display */
105    static int getFbForDpy(const int& dpy);
106    static bool displayCommit(const int& fd);
107
108private:
109    /* Ctor setup */
110    explicit Overlay();
111    /*Validate index range, abort if invalid */
112    void validate(int index);
113    void dump() const;
114
115    /* Just like a Facebook for pipes, but much less profile info */
116    struct PipeBook {
117        void init();
118        void destroy();
119        /* Check if pipe exists and return true, false otherwise */
120        bool valid();
121
122        /* Hardware pipe wrapper */
123        GenericPipe *mPipe;
124        /* Display using this pipe. Refer to enums above */
125        int mDisplay;
126
127        /* operations on bitmap */
128        static bool pipeUsageUnchanged();
129        static void setUse(int index);
130        static void resetUse(int index);
131        static bool isUsed(int index);
132        static bool isNotUsed(int index);
133        static void save();
134
135        static void setAllocation(int index);
136        static void resetAllocation(int index);
137        static bool isAllocated(int index);
138        static bool isNotAllocated(int index);
139
140        static utils::eMdpPipeType getPipeType(utils::eDest dest);
141        static const char* getDestStr(utils::eDest dest);
142
143        static int NUM_PIPES;
144        static utils::eMdpPipeType pipeTypeLUT[utils::OV_MAX];
145
146
147    private:
148        //usage tracks if a successful commit happened. So a pipe could be
149        //allocated to a display, but it may not end up using it for various
150        //reasons. If one display actually uses a pipe then it amy not be
151        //used by another display, without an UNSET in between.
152        static int sPipeUsageBitmap;
153        static int sLastUsageBitmap;
154        //Tracks which pipe objects are allocated. This does not imply that they
155        //will actually be used. For example, a display might choose to acquire
156        //3 pipe objects in one shot and proceed with config only if it gets all
157        //3. The bitmap helps allocate different pipe objects on each request.
158        static int sAllocatedBitmap;
159    };
160
161    PipeBook mPipeBook[utils::OV_INVALID]; //Used as max
162
163    /* Dump string */
164    char mDumpStr[1024];
165
166    /* Singleton Instance*/
167    static Overlay *sInstance;
168    //TODO Deprecate
169    static int sExtFbIndex;
170    static int sDpyFbMap[DPY_MAX];
171    static int sDMAMode;
172};
173
174inline void Overlay::validate(int index) {
175    OVASSERT(index >=0 && index < PipeBook::NUM_PIPES, \
176        "%s, Index out of bounds: %d", __FUNCTION__, index);
177    OVASSERT(mPipeBook[index].valid(), "Pipe does not exist %s",
178            PipeBook::getDestStr((utils::eDest)index));
179}
180
181inline int Overlay::availablePipes(int dpy) {
182     int avail = 0;
183     for(int i = 0; i < PipeBook::NUM_PIPES; i++) {
184       if((mPipeBook[i].mDisplay == DPY_UNUSED ||
185           mPipeBook[i].mDisplay == dpy) && PipeBook::isNotAllocated(i)) {
186                avail++;
187        }
188    }
189    return avail;
190}
191
192inline void Overlay::setExtFbNum(int fbNum) {
193    sExtFbIndex = fbNum;
194}
195
196inline int Overlay::getExtFbNum() {
197    return sExtFbIndex;
198}
199
200inline void Overlay::setDMAMode(const int& mode) {
201    if(mode == DMA_LINE_MODE || mode == DMA_BLOCK_MODE)
202        sDMAMode = mode;
203}
204
205inline int Overlay::getDMAMode() {
206    return sDMAMode;
207}
208
209inline int Overlay::getFbForDpy(const int& dpy) {
210    OVASSERT(dpy >= 0 && dpy < DPY_MAX, "Invalid dpy %d", dpy);
211    return sDpyFbMap[dpy];
212}
213
214inline bool Overlay::PipeBook::valid() {
215    return (mPipe != NULL);
216}
217
218inline bool Overlay::PipeBook::pipeUsageUnchanged() {
219    return (sPipeUsageBitmap == sLastUsageBitmap);
220}
221
222inline void Overlay::PipeBook::setUse(int index) {
223    sPipeUsageBitmap |= (1 << index);
224}
225
226inline void Overlay::PipeBook::resetUse(int index) {
227    sPipeUsageBitmap &= ~(1 << index);
228}
229
230inline bool Overlay::PipeBook::isUsed(int index) {
231    return sPipeUsageBitmap & (1 << index);
232}
233
234inline bool Overlay::PipeBook::isNotUsed(int index) {
235    return !isUsed(index);
236}
237
238inline void Overlay::PipeBook::save() {
239    sLastUsageBitmap = sPipeUsageBitmap;
240}
241
242inline void Overlay::PipeBook::setAllocation(int index) {
243    sAllocatedBitmap |= (1 << index);
244}
245
246inline void Overlay::PipeBook::resetAllocation(int index) {
247    sAllocatedBitmap &= ~(1 << index);
248}
249
250inline bool Overlay::PipeBook::isAllocated(int index) {
251    return sAllocatedBitmap & (1 << index);
252}
253
254inline bool Overlay::PipeBook::isNotAllocated(int index) {
255    return !isAllocated(index);
256}
257
258inline utils::eMdpPipeType Overlay::PipeBook::getPipeType(utils::eDest dest) {
259    return pipeTypeLUT[(int)dest];
260}
261
262inline const char* Overlay::PipeBook::getDestStr(utils::eDest dest) {
263    switch(getPipeType(dest)) {
264        case utils::OV_MDP_PIPE_RGB: return "RGB";
265        case utils::OV_MDP_PIPE_VG: return "VG";
266        case utils::OV_MDP_PIPE_DMA: return "DMA";
267        default: return "Invalid";
268    }
269    return "Invalid";
270}
271
272}; // overlay
273
274#endif // OVERLAY_H
275