1/*
2* Copyright (c) 2011-2014, 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_UTILS_H
31#define OVERLAY_UTILS_H
32
33#include <cutils/log.h> // ALOGE, etc
34#include <errno.h>
35#include <fcntl.h> // open, O_RDWR, etc
36#include <hardware/hardware.h>
37#include <hardware/gralloc.h> // buffer_handle_t
38#include <linux/msm_mdp.h> // flags
39#include <linux/msm_rotator.h>
40#include <stdio.h>
41#include <stdlib.h>
42#include <string.h>
43#include <sys/stat.h>
44#include <sys/types.h>
45#include <utils/Log.h>
46#include "gralloc_priv.h" //for interlace
47
48// Older platforms do not support Venus
49#ifndef VENUS_COLOR_FORMAT
50#define MDP_Y_CBCR_H2V2_VENUS MDP_IMGTYPE_LIMIT
51#endif
52
53/*
54*
55* Collection of utilities functions/structs/enums etc...
56*
57* */
58
59// comment that out if you want to remove asserts
60// or put it as -D in Android.mk. your choice.
61#define OVERLAY_HAS_ASSERT
62
63#ifdef OVERLAY_HAS_ASSERT
64# define OVASSERT(x, ...) if(!(x)) { ALOGE(__VA_ARGS__); abort(); }
65#else
66# define OVASSERT(x, ...) ALOGE_IF(!(x), __VA_ARGS__)
67#endif // OVERLAY_HAS_ASSERT
68
69#define DEBUG_OVERLAY 0
70#define PROFILE_OVERLAY 0
71
72#ifndef MDSS_MDP_RIGHT_MIXER
73#define MDSS_MDP_RIGHT_MIXER 0x100
74#endif
75
76#ifndef MDP_OV_PIPE_FORCE_DMA
77#define MDP_OV_PIPE_FORCE_DMA 0x4000
78#endif
79
80#ifndef MDSS_MDP_DUAL_PIPE
81#define MDSS_MDP_DUAL_PIPE 0x200
82#endif
83
84#define FB_DEVICE_TEMPLATE "/dev/graphics/fb%u"
85
86namespace overlay {
87
88// fwd
89class Overlay;
90class OvFD;
91
92/* helper function to open by using fbnum */
93bool open(OvFD& fd, uint32_t fbnum, const char* const dev,
94    int flags = O_RDWR);
95
96namespace utils {
97struct Whf;
98struct Dim;
99
100inline uint32_t setBit(uint32_t x, uint32_t mask) {
101    return (x | mask);
102}
103
104inline uint32_t clrBit(uint32_t x, uint32_t mask) {
105    return (x & ~mask);
106}
107
108/* Utility class to help avoid copying instances by making the copy ctor
109* and assignment operator private
110*
111* Usage:
112*    class SomeClass : utils::NoCopy {...};
113*/
114class NoCopy {
115protected:
116    NoCopy(){}
117    ~NoCopy() {}
118private:
119    NoCopy(const NoCopy&);
120    const NoCopy& operator=(const NoCopy&);
121};
122
123bool isMdssRotator();
124void normalizeCrop(uint32_t& xy, uint32_t& wh);
125
126template <class Type>
127void swapWidthHeight(Type& width, Type& height);
128
129struct Dim {
130    Dim () : x(0), y(0),
131    w(0), h(0),
132    o(0) {}
133    Dim(uint32_t _x, uint32_t _y, uint32_t _w, uint32_t _h) :
134        x(_x), y(_y),
135        w(_w), h(_h) {}
136    Dim(uint32_t _x, uint32_t _y, uint32_t _w, uint32_t _h, uint32_t _o) :
137        x(_x), y(_y),
138        w(_w), h(_h),
139        o(_o) {}
140    bool check(uint32_t _w, uint32_t _h) const {
141        return (x+w <= _w && y+h <= _h);
142
143    }
144
145    bool operator==(const Dim& d) const {
146        return d.x == x && d.y == y &&
147                d.w == w && d.h == h &&
148                d.o == o;
149    }
150
151    bool operator!=(const Dim& d) const {
152        return !operator==(d);
153    }
154
155    void dump() const;
156    uint32_t x;
157    uint32_t y;
158    uint32_t w;
159    uint32_t h;
160    uint32_t o;
161};
162
163// TODO have Whfz
164
165struct Whf {
166    Whf() : w(0), h(0), format(0), size(0) {}
167    Whf(uint32_t wi, uint32_t he, uint32_t f) :
168        w(wi), h(he), format(f), size(0) {}
169    Whf(uint32_t wi, uint32_t he, uint32_t f, uint32_t s) :
170        w(wi), h(he), format(f), size(s) {}
171    // FIXME not comparing size at the moment
172    bool operator==(const Whf& whf) const {
173        return whf.w == w && whf.h == h &&
174                whf.format == format;
175    }
176    bool operator!=(const Whf& whf) const {
177        return !operator==(whf);
178    }
179    void dump() const;
180    uint32_t w;
181    uint32_t h;
182    uint32_t format;
183    uint32_t size;
184};
185
186enum { MAX_PATH_LEN = 256 };
187
188enum { DEFAULT_PLANE_ALPHA = 0xFF };
189
190/**
191 * Rotator flags: not to be confused with orientation flags.
192 * Usually, you want to open the rotator to make sure it is
193 * ready for business.
194 * */
195 enum eRotFlags {
196    ROT_FLAGS_NONE = 0,
197    //Use rotator for 0 rotation. It is used anyway for others.
198    ROT_0_ENABLED = 1 << 0,
199    //Enable rotator downscale optimization for hardware bugs not handled in
200    //driver. If downscale optimizatation is required,
201    //then rotator will be used even if its 0 rotation case.
202    ROT_DOWNSCALE_ENABLED = 1 << 1,
203    ROT_PREROTATED = 1 << 2,
204};
205
206enum eRotDownscale {
207    ROT_DS_NONE = 0,
208    ROT_DS_HALF = 1,
209    ROT_DS_FOURTH = 2,
210    ROT_DS_EIGHTH = 3,
211};
212
213/*
214 * Various mdp flags like PIPE SHARE, DEINTERLACE etc...
215 * kernel/common/linux/msm_mdp.h
216 * INTERLACE_MASK: hardware/qcom/display/libgralloc/badger/fb_priv.h
217 * */
218enum eMdpFlags {
219    OV_MDP_FLAGS_NONE = 0,
220    OV_MDP_PIPE_SHARE =  MDP_OV_PIPE_SHARE,
221    OV_MDP_PIPE_FORCE_DMA = MDP_OV_PIPE_FORCE_DMA,
222    OV_MDP_DEINTERLACE = MDP_DEINTERLACE,
223    OV_MDP_SECURE_OVERLAY_SESSION = MDP_SECURE_OVERLAY_SESSION,
224    OV_MDP_SECURE_DISPLAY_OVERLAY_SESSION = MDP_SECURE_DISPLAY_OVERLAY_SESSION,
225    OV_MDP_SOURCE_ROTATED_90 = MDP_SOURCE_ROTATED_90,
226    OV_MDP_BACKEND_COMPOSITION = MDP_BACKEND_COMPOSITION,
227    OV_MDP_BLEND_FG_PREMULT = MDP_BLEND_FG_PREMULT,
228    OV_MDP_FLIP_H = MDP_FLIP_LR,
229    OV_MDP_FLIP_V = MDP_FLIP_UD,
230    OV_MDSS_MDP_RIGHT_MIXER = MDSS_MDP_RIGHT_MIXER,
231    OV_MDP_PP_EN = MDP_OVERLAY_PP_CFG_EN,
232    OV_MDSS_MDP_BWC_EN = MDP_BWC_EN,
233    OV_MDSS_MDP_DUAL_PIPE = MDSS_MDP_DUAL_PIPE,
234    OV_MDP_SOLID_FILL = MDP_SOLID_FILL,
235};
236
237enum eZorder {
238    ZORDER_0 = 0,
239    ZORDER_1,
240    ZORDER_2,
241    ZORDER_3,
242    Z_SYSTEM_ALLOC = 0xFFFF
243};
244
245enum eMdpPipeType {
246    OV_MDP_PIPE_RGB = 0,
247    OV_MDP_PIPE_VG,
248    OV_MDP_PIPE_DMA,
249    OV_MDP_PIPE_ANY, //Any
250};
251
252// Identify destination pipes
253// TODO Names useless, replace with int and change all interfaces
254enum eDest {
255    OV_P0 = 0,
256    OV_P1,
257    OV_P2,
258    OV_P3,
259    OV_P4,
260    OV_P5,
261    OV_P6,
262    OV_P7,
263    OV_P8,
264    OV_P9,
265    OV_INVALID,
266    OV_MAX = OV_INVALID,
267};
268
269/* Used when a buffer is split over 2 pipes and sent to display */
270enum {
271    OV_LEFT_SPLIT = 0,
272    OV_RIGHT_SPLIT,
273};
274
275/* values for copybit_set_parameter(OVERLAY_TRANSFORM) */
276enum eTransform {
277    /* No rot */
278    OVERLAY_TRANSFORM_0 = 0x0,
279    /* flip source image horizontally 0x1 */
280    OVERLAY_TRANSFORM_FLIP_H = HAL_TRANSFORM_FLIP_H,
281    /* flip source image vertically 0x2 */
282    OVERLAY_TRANSFORM_FLIP_V = HAL_TRANSFORM_FLIP_V,
283    /* rotate source image 180 degrees
284     * It is basically bit-or-ed  H | V == 0x3 */
285    OVERLAY_TRANSFORM_ROT_180 = HAL_TRANSFORM_ROT_180,
286    /* rotate source image 90 degrees 0x4 */
287    OVERLAY_TRANSFORM_ROT_90 = HAL_TRANSFORM_ROT_90,
288    /* rotate source image 90 degrees and flip horizontally 0x5 */
289    OVERLAY_TRANSFORM_ROT_90_FLIP_H = HAL_TRANSFORM_ROT_90 |
290                                      HAL_TRANSFORM_FLIP_H,
291    /* rotate source image 90 degrees and flip vertically 0x6 */
292    OVERLAY_TRANSFORM_ROT_90_FLIP_V = HAL_TRANSFORM_ROT_90 |
293                                      HAL_TRANSFORM_FLIP_V,
294    /* rotate source image 270 degrees
295     * Basically 180 | 90 == 0x7 */
296    OVERLAY_TRANSFORM_ROT_270 = HAL_TRANSFORM_ROT_270,
297    /* rotate invalid like in Transform.h */
298    OVERLAY_TRANSFORM_INV = 0x80
299};
300
301enum eBlending {
302    OVERLAY_BLENDING_UNDEFINED = 0x0,
303    /* No blending */
304    OVERLAY_BLENDING_OPAQUE,
305    /* src.rgb + dst.rgb*(1-src_alpha) */
306    OVERLAY_BLENDING_PREMULT,
307    /* src.rgb * src_alpha + dst.rgb (1 - src_alpha) */
308    OVERLAY_BLENDING_COVERAGE,
309};
310
311// Used to consolidate pipe params
312struct PipeArgs {
313    PipeArgs() : mdpFlags(OV_MDP_FLAGS_NONE),
314        zorder(Z_SYSTEM_ALLOC),
315        rotFlags(ROT_FLAGS_NONE),
316        planeAlpha(DEFAULT_PLANE_ALPHA),
317        blending(OVERLAY_BLENDING_COVERAGE){
318    }
319
320    PipeArgs(eMdpFlags f, Whf _whf,
321            eZorder z, eRotFlags r,
322            int pA = DEFAULT_PLANE_ALPHA, eBlending b = OVERLAY_BLENDING_COVERAGE) :
323        mdpFlags(f),
324        whf(_whf),
325        zorder(z),
326        rotFlags(r),
327        planeAlpha(pA),
328        blending(b){
329    }
330
331    eMdpFlags mdpFlags; // for mdp_overlay flags
332    Whf whf;
333    eZorder zorder; // stage number
334    eRotFlags rotFlags;
335    int planeAlpha;
336    eBlending blending;
337};
338
339// Cannot use HW_OVERLAY_MAGNIFICATION_LIMIT, since at the time
340// of integration, HW_OVERLAY_MAGNIFICATION_LIMIT was a define
341enum { HW_OV_MAGNIFICATION_LIMIT = 20,
342    HW_OV_MINIFICATION_LIMIT  = 8
343};
344
345inline void setMdpFlags(eMdpFlags& f, eMdpFlags v) {
346    f = static_cast<eMdpFlags>(setBit(f, v));
347}
348
349inline void clearMdpFlags(eMdpFlags& f, eMdpFlags v) {
350    f = static_cast<eMdpFlags>(clrBit(f, v));
351}
352
353enum { FB0, FB1, FB2 };
354
355struct ScreenInfo {
356    ScreenInfo() : mFBWidth(0),
357    mFBHeight(0),
358    mFBbpp(0),
359    mFBystride(0) {}
360    void dump(const char* const s) const;
361    uint32_t mFBWidth;
362    uint32_t mFBHeight;
363    uint32_t mFBbpp;
364    uint32_t mFBystride;
365};
366
367int getMdpFormat(int format);
368int getMdpFormat(int format, bool tileEnabled);
369int getHALFormat(int mdpFormat);
370void getDecimationFactor(const int& src_w, const int& src_h,
371        const int& dst_w, const int& dst_h, uint8_t& horzDeci,
372        uint8_t& vertDeci);
373
374/* flip is upside down and such. V, H flip
375 * rotation is 90, 180 etc
376 * It returns MDP related enum/define that match rot+flip*/
377int getMdpOrient(eTransform rotation);
378const char* getFormatString(int format);
379
380template <class T>
381inline void memset0(T& t) { ::memset(&t, 0, sizeof(t)); }
382
383template <class T> inline void swap ( T& a, T& b )
384{
385    T c(a); a=b; b=c;
386}
387
388template<typename T> inline T max(T a, T b) { return (a > b) ? a : b; }
389
390template<typename T> inline T min(T a, T b) { return (a < b) ? a : b; }
391
392inline int alignup(int value, int a) {
393    //if align = 0, return the value. Else, do alignment.
394    return a ? ((((value - 1) / a) + 1) * a) : value;
395}
396
397inline int aligndown(int value, int a) {
398    //if align = 0, return the value. Else, do alignment.
399    return a ? ((value) & ~(a-1)) : value;
400}
401
402// FIXME that align should replace the upper one.
403inline int align(int value, int a) {
404    //if align = 0, return the value. Else, do alignment.
405    return a ? ((value + (a-1)) & ~(a-1)) : value;
406}
407
408inline bool isYuv(uint32_t format) {
409    switch(format){
410        case MDP_Y_CBCR_H2V1:
411        case MDP_Y_CBCR_H2V2:
412        case MDP_Y_CRCB_H2V2:
413        case MDP_Y_CRCB_H1V1:
414        case MDP_Y_CRCB_H2V1:
415        case MDP_Y_CRCB_H2V2_TILE:
416        case MDP_Y_CBCR_H2V2_TILE:
417        case MDP_Y_CR_CB_H2V2:
418        case MDP_Y_CR_CB_GH2V2:
419        case MDP_Y_CBCR_H2V2_VENUS:
420        case MDP_YCBYCR_H2V1:
421        case MDP_YCRYCB_H2V1:
422            return true;
423        default:
424            return false;
425    }
426    return false;
427}
428
429inline bool isRgb(uint32_t format) {
430    switch(format) {
431        case MDP_RGBA_8888:
432        case MDP_BGRA_8888:
433        case MDP_RGBX_8888:
434        case MDP_RGB_565:
435            return true;
436        default:
437            return false;
438    }
439    return false;
440}
441
442inline const char* getFormatString(int format){
443    #define STR(f) #f;
444    static const char* formats[MDP_IMGTYPE_LIMIT + 1] = {0};
445    formats[MDP_RGB_565] = STR(MDP_RGB_565);
446    formats[MDP_XRGB_8888] = STR(MDP_XRGB_8888);
447    formats[MDP_Y_CBCR_H2V2] = STR(MDP_Y_CBCR_H2V2);
448    formats[MDP_Y_CBCR_H2V2_ADRENO] = STR(MDP_Y_CBCR_H2V2_ADRENO);
449    formats[MDP_ARGB_8888] = STR(MDP_ARGB_8888);
450    formats[MDP_RGB_888] = STR(MDP_RGB_888);
451    formats[MDP_Y_CRCB_H2V2] = STR(MDP_Y_CRCB_H2V2);
452    formats[MDP_YCBYCR_H2V1] = STR(MDP_YCBYCR_H2V1);
453    formats[MDP_YCRYCB_H2V1] = STR(MDP_YCRYCB_H2V1);
454    formats[MDP_CBYCRY_H2V1] = STR(MDP_CBYCRY_H2V1);
455    formats[MDP_Y_CRCB_H2V1] = STR(MDP_Y_CRCB_H2V1);
456    formats[MDP_Y_CBCR_H2V1] = STR(MDP_Y_CBCR_H2V1);
457    formats[MDP_Y_CRCB_H1V2] = STR(MDP_Y_CRCB_H1V2);
458    formats[MDP_Y_CBCR_H1V2] = STR(MDP_Y_CBCR_H1V2);
459    formats[MDP_RGBA_8888] = STR(MDP_RGBA_8888);
460    formats[MDP_BGRA_8888] = STR(MDP_BGRA_8888);
461    formats[MDP_RGBX_8888] = STR(MDP_RGBX_8888);
462    formats[MDP_Y_CRCB_H2V2_TILE] = STR(MDP_Y_CRCB_H2V2_TILE);
463    formats[MDP_Y_CBCR_H2V2_TILE] = STR(MDP_Y_CBCR_H2V2_TILE);
464    formats[MDP_Y_CR_CB_H2V2] = STR(MDP_Y_CR_CB_H2V2);
465    formats[MDP_Y_CR_CB_GH2V2] = STR(MDP_Y_CR_CB_GH2V2);
466    formats[MDP_Y_CB_CR_H2V2] = STR(MDP_Y_CB_CR_H2V2);
467    formats[MDP_Y_CRCB_H1V1] = STR(MDP_Y_CRCB_H1V1);
468    formats[MDP_Y_CBCR_H1V1] = STR(MDP_Y_CBCR_H1V1);
469    formats[MDP_YCRCB_H1V1] = STR(MDP_YCRCB_H1V1);
470    formats[MDP_YCBCR_H1V1] = STR(MDP_YCBCR_H1V1);
471    formats[MDP_BGR_565] = STR(MDP_BGR_565);
472    formats[MDP_BGR_888] = STR(MDP_BGR_888);
473    formats[MDP_Y_CBCR_H2V2_VENUS] = STR(MDP_Y_CBCR_H2V2_VENUS);
474    formats[MDP_BGRX_8888] = STR(MDP_BGRX_8888);
475    formats[MDP_RGBA_8888_TILE] = STR(MDP_RGBA_8888_TILE);
476    formats[MDP_ARGB_8888_TILE] = STR(MDP_ARGB_8888_TILE);
477    formats[MDP_ABGR_8888_TILE] = STR(MDP_ABGR_8888_TILE);
478    formats[MDP_BGRA_8888_TILE] = STR(MDP_BGRA_8888_TILE);
479    formats[MDP_RGBX_8888_TILE] = STR(MDP_RGBX_8888_TILE);
480    formats[MDP_XRGB_8888_TILE] = STR(MDP_XRGB_8888_TILE);
481    formats[MDP_XBGR_8888_TILE] = STR(MDP_XBGR_8888_TILE);
482    formats[MDP_BGRX_8888_TILE] = STR(MDP_BGRX_8888_TILE);
483    formats[MDP_RGB_565_TILE] = STR(MDP_RGB_565_TILE);
484    formats[MDP_IMGTYPE_LIMIT] = STR(MDP_IMGTYPE_LIMIT);
485
486    if(format < 0 || format >= MDP_IMGTYPE_LIMIT) {
487        ALOGE("%s wrong fmt %d", __FUNCTION__, format);
488        return "Unsupported format";
489    }
490    if(formats[format] == 0) {
491        ALOGE("%s: table missing format %d from header", __FUNCTION__, format);
492        return "";
493    }
494    return formats[format];
495}
496
497inline void Whf::dump() const {
498    ALOGE("== Dump WHF w=%d h=%d f=%d s=%d start/end ==",
499            w, h, format, size);
500}
501
502inline void Dim::dump() const {
503    ALOGE("== Dump Dim x=%d y=%d w=%d h=%d start/end ==", x, y, w, h);
504}
505
506template <class Type>
507void swapWidthHeight(Type& width, Type& height) {
508    Type tmp = width;
509    width = height;
510    height = tmp;
511}
512
513inline void ScreenInfo::dump(const char* const s) const {
514    ALOGE("== Dump %s ScreenInfo w=%d h=%d"
515            " bpp=%d stride=%d start/end ==",
516            s, mFBWidth, mFBHeight, mFBbpp, mFBystride);
517}
518
519inline bool openDev(OvFD& fd, int fbnum,
520    const char* const devpath, int flags) {
521    return overlay::open(fd, fbnum, devpath, flags);
522}
523
524template <class T>
525inline void even_ceil(T& value) {
526    if(value & 1)
527        value++;
528}
529
530template <class T>
531inline void even_floor(T& value) {
532    if(value & 1)
533        value--;
534}
535
536/* Prerotation adjusts crop co-ordinates to the new transformed values within
537 * destination buffer. This is necessary only when the entire buffer is rotated
538 * irrespective of crop (A-family). If only the crop portion of the buffer is
539 * rotated into a destination buffer matching the size of crop, we don't need to
540 * use this helper (B-family).
541 * @Deprecated as of now, retained for the case where a full buffer needs
542 * transform and also as a reference.
543 */
544void preRotateSource(const eTransform& tr, Whf& whf, Dim& srcCrop);
545void getDump(char *buf, size_t len, const char *prefix, const mdp_overlay& ov);
546void getDump(char *buf, size_t len, const char *prefix, const msmfb_img& ov);
547void getDump(char *buf, size_t len, const char *prefix, const mdp_rect& ov);
548void getDump(char *buf, size_t len, const char *prefix,
549        const msmfb_overlay_data& ov);
550void getDump(char *buf, size_t len, const char *prefix, const msmfb_data& ov);
551void getDump(char *buf, size_t len, const char *prefix,
552        const msm_rotator_img_info& ov);
553void getDump(char *buf, size_t len, const char *prefix,
554        const msm_rotator_data_info& ov);
555
556} // namespace utils ends
557
558//--------------------Class Res stuff (namespace overlay only) -----------
559
560class Res {
561public:
562    // /dev/graphics/fb%u
563    static const char* const fbPath;
564    // /dev/msm_rotator
565    static const char* const rotPath;
566};
567
568
569//--------------------Class OvFD stuff (namespace overlay only) -----------
570
571/*
572* Holds one FD
573* Dtor will NOT close the underlying FD.
574* That enables us to copy that object around
575* */
576class OvFD {
577public:
578    /* Ctor */
579    explicit OvFD();
580
581    /* dtor will NOT close the underlying FD */
582    ~OvFD();
583
584    /* Open fd using the path given by dev.
585     * return false in failure */
586    bool open(const char* const dev,
587            int flags = O_RDWR);
588
589    /* populate path */
590    void setPath(const char* const dev);
591
592    /* Close fd if we have a valid fd. */
593    bool close();
594
595    /* returns underlying fd.*/
596    int getFD() const;
597
598    /* returns true if fd is valid */
599    bool valid() const;
600
601    /* like operator= */
602    void copy(int fd);
603
604    /* dump the state of the instance */
605    void dump() const;
606private:
607    /* helper enum for determine valid/invalid fd */
608    enum { INVAL = -1 };
609
610    /* actual os fd */
611    int mFD;
612
613    /* path, for debugging */
614    char mPath[utils::MAX_PATH_LEN];
615};
616
617//-------------------Inlines--------------------------
618
619inline bool open(OvFD& fd, uint32_t fbnum, const char* const dev, int flags)
620{
621    char dev_name[64] = {0};
622    snprintf(dev_name, sizeof(dev_name), dev, fbnum);
623    return fd.open(dev_name, flags);
624}
625
626inline OvFD::OvFD() : mFD (INVAL) {
627    mPath[0] = 0;
628}
629
630inline OvFD::~OvFD() {
631    //no op since copy() can be used to share fd, in 3d cases.
632}
633
634inline bool OvFD::open(const char* const dev, int flags)
635{
636    mFD = ::open(dev, flags, 0);
637    if (mFD < 0) {
638        // FIXME errno, strerror in bionic?
639        ALOGE("Cant open device %s err=%d", dev, errno);
640        return false;
641    }
642    setPath(dev);
643    return true;
644}
645
646inline void OvFD::setPath(const char* const dev)
647{
648    ::strlcpy(mPath, dev, sizeof(mPath));
649}
650
651inline bool OvFD::close()
652{
653    int ret = 0;
654    if(valid()) {
655        ret = ::close(mFD);
656        mFD = INVAL;
657    }
658    return (ret == 0);
659}
660
661inline bool OvFD::valid() const
662{
663    return (mFD != INVAL);
664}
665
666inline int OvFD::getFD() const { return mFD; }
667
668inline void OvFD::copy(int fd) {
669    mFD = fd;
670}
671
672inline void OvFD::dump() const
673{
674    ALOGE("== Dump OvFD fd=%d path=%s start/end ==",
675            mFD, mPath);
676}
677
678//--------------- class OvFD stuff ends ---------------------
679
680} // overlay
681
682
683#endif // OVERLAY_UTILS_H
684