/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qscreenlinuxfb_qws.h"

#ifndef QT_NO_QWS_LINUXFB

//#include "qmemorymanager_qws.h"

#include "qwsdisplay_qws.h"

#include "qpixmap.h"

#include <private/qwssignalhandler_p.h>

#include <private/qcore_unix_p.h> // overrides QT_OPEN

#include <unistd.h>

#include <stdlib.h>

#include <sys/ioctl.h>

#include <sys/types.h>

#include <sys/stat.h>

#include <sys/mman.h>

#include <sys/kd.h>

#include <fcntl.h>

#include <errno.h>

#include <stdio.h>

#include <limits.h>

#include <signal.h>

#include "qwindowsystem_qws.h"

#if !defined(Q_OS_DARWIN) && !defined(Q_OS_FREEBSD)

#include <linux/fb.h>

#ifdef __i386__

#include <asm/mtrr.h>

#endif

#endif

QT_BEGIN_NAMESPACE

extern int qws_client_id;

//#define DEBUG_CACHE

class QLinuxFbScreenPrivate : public QObject

{

public:

    QLinuxFbScreenPrivate();

    ~QLinuxFbScreenPrivate();

    void openTty();

    void closeTty();

    int fd;

    int startupw;

    int startuph;

    int startupd;

    bool blank;

    QLinuxFbScreen::DriverTypes driverType;

    bool doGraphicsMode;

#ifdef QT_QWS_DEPTH_GENERIC

    bool doGenericColors;

#endif

    int ttyfd;

    long oldKdMode;

    QString ttyDevice;

    QString displaySpec;

};

QLinuxFbScreenPrivate::QLinuxFbScreenPrivate()

    : fd(-1), blank(true), doGraphicsMode(true),

#ifdef QT_QWS_DEPTH_GENERIC

      doGenericColors(false),

#endif

      ttyfd(-1), oldKdMode(KD_TEXT)

{

    QWSSignalHandler::instance()->addObject(this);

}

QLinuxFbScreenPrivate::~QLinuxFbScreenPrivate()

{

    closeTty();

}

void QLinuxFbScreenPrivate::openTty()

{

    const char *const devs[] = {"/dev/tty0", "/dev/tty", "/dev/console", 0};

    if (ttyDevice.isEmpty()) {

        for (const char * const *dev = devs; *dev; ++dev) {

            ttyfd = QT_OPEN(*dev, O_RDWR);

            if (ttyfd != -1)

                break;

        }

    } else {

        ttyfd = QT_OPEN(ttyDevice.toAscii().constData(), O_RDWR);

    }

    if (ttyfd == -1)

        return;

    if (doGraphicsMode) {

        ioctl(ttyfd, KDGETMODE, &oldKdMode);

        if (oldKdMode != KD_GRAPHICS) {

            int ret = ioctl(ttyfd, KDSETMODE, KD_GRAPHICS);

            if (ret == -1)

                doGraphicsMode = false;

        }

    }

    // No blankin' screen, no blinkin' cursor!, no cursor!

    const char termctl[] = "\033[9;0]\033[?33l\033[?25l\033[?1c";

    QT_WRITE(ttyfd, termctl, sizeof(termctl));

}

void QLinuxFbScreenPrivate::closeTty()

{

    if (ttyfd == -1)

        return;

    if (doGraphicsMode)

        ioctl(ttyfd, KDSETMODE, oldKdMode);

    // Blankin' screen, blinkin' cursor!

    const char termctl[] = "\033[9;15]\033[?33h\033[?25h\033[?0c";

    QT_WRITE(ttyfd, termctl, sizeof(termctl));

    QT_CLOSE(ttyfd);

    ttyfd = -1;

}

/*!

    \enum QLinuxFbScreen::DriverTypes

    This enum describes the driver type.

    \value GenericDriver Generic Linux framebuffer driver

    \value EInk8Track e-Ink framebuffer driver using the 8Track chipset

 */

/*!

    \fn QLinuxFbScreen::fixupScreenInfo(fb_fix_screeninfo &finfo, fb_var_screeninfo &vinfo)

    Adjust the values returned by the framebuffer driver, to work

    around driver bugs or nonstandard behavior in certain drivers.

    \a finfo and \a vinfo specify the fixed and variable screen info

    returned by the driver.

 */

void QLinuxFbScreen::fixupScreenInfo(fb_fix_screeninfo &finfo, fb_var_screeninfo &vinfo)

{

    // 8Track e-ink devices (as found in Sony PRS-505) lie

    // about their bit depth -- they claim they're 1 bit per

    // pixel while the only supported mode is 8 bit per pixel

    // grayscale.

    // Caused by this, they also miscalculate their line length.

    if(!strcmp(finfo.id, "8TRACKFB") && vinfo.bits_per_pixel == 1) {

        vinfo.bits_per_pixel = 8;

        finfo.line_length = vinfo.xres;

    }

}

/*!

    \internal

    \class QLinuxFbScreen

    \ingroup qws

    \brief The QLinuxFbScreen class implements a screen driver for the

    Linux framebuffer.

    Note that this class is only available in \l{Qt for Embedded Linux}.

    Custom screen drivers can be added by subclassing the

    QScreenDriverPlugin class, using the QScreenDriverFactory class to

    dynamically load the driver into the application, but there should

    only be one screen object per application.

    The QLinuxFbScreen class provides the cache() function allocating

    off-screen graphics memory, and the complementary uncache()

    function releasing the allocated memory. The latter function will

    first sync the graphics card to ensure the memory isn't still

    being used by a command in the graphics card FIFO queue. The

    deleteEntry() function deletes the given memory block without such

    synchronization.  Given the screen instance and client id, the

    memory can also be released using the clearCache() function, but

    this should only be necessary if a client exits abnormally.

    In addition, when in paletted graphics modes, the set() function

    provides the possibility of setting a specified color index to a

    given RGB value.

    The QLinuxFbScreen class also acts as a factory for the

    unaccelerated screen cursor and the unaccelerated raster-based

    implementation of QPaintEngine (\c QRasterPaintEngine);

    accelerated drivers for Linux should derive from this class.

    \sa QScreen, QScreenDriverPlugin, {Running Applications}

*/

/*!

    \fn bool QLinuxFbScreen::useOffscreen()

    \internal

*/

// Unaccelerated screen/driver setup. Can be overridden by accelerated

// drivers

/*!

    \fn QLinuxFbScreen::QLinuxFbScreen(int displayId)

    Constructs a QLinuxFbScreen object. The \a displayId argument

    identifies the Qt for Embedded Linux server to connect to.

*/

QLinuxFbScreen::QLinuxFbScreen(int display_id)

    : QScreen(display_id, LinuxFBClass), d_ptr(new QLinuxFbScreenPrivate)

{

    canaccel=false;

    clearCacheFunc = &clearCache;

#ifdef QT_QWS_CLIENTBLIT

    setSupportsBlitInClients(true);

#endif

}

/*!

    Destroys this QLinuxFbScreen object.

*/

QLinuxFbScreen::~QLinuxFbScreen()

{

}

/*!

    \reimp

    This is called by \l{Qt for Embedded Linux} clients to map in the framebuffer.

    It should be reimplemented by accelerated drivers to map in

    graphics card registers; those drivers should then call this

    function in order to set up offscreen memory management. The

    device is specified in \a displaySpec; e.g. "/dev/fb".

    \sa disconnect()

*/

bool QLinuxFbScreen::connect(const QString &displaySpec)

{

    d_ptr->displaySpec = displaySpec;

    const QStringList args = displaySpec.split(QLatin1Char(':'));

    if (args.contains(QLatin1String("nographicsmodeswitch")))

        d_ptr->doGraphicsMode = false;

#ifdef QT_QWS_DEPTH_GENERIC

    if (args.contains(QLatin1String("genericcolors")))

        d_ptr->doGenericColors = true;

#endif

    QRegExp ttyRegExp(QLatin1String("tty=(.*)"));

    if (args.indexOf(ttyRegExp) != -1)

        d_ptr->ttyDevice = ttyRegExp.cap(1);

#if Q_BYTE_ORDER == Q_BIG_ENDIAN

#ifndef QT_QWS_FRAMEBUFFER_LITTLE_ENDIAN

    if (args.contains(QLatin1String("littleendian")))

#endif

        QScreen::setFrameBufferLittleEndian(true);

#endif

    QString dev = QLatin1String("/dev/fb0");

    foreach(QString d, args) {

	if (d.startsWith(QLatin1Char('/'))) {

	    dev = d;

	    break;

	}

    }

    if (access(dev.toLatin1().constData(), R_OK|W_OK) == 0)

        d_ptr->fd = QT_OPEN(dev.toLatin1().constData(), O_RDWR);

    if (d_ptr->fd == -1) {

        if (QApplication::type() == QApplication::GuiServer) {

            perror("QScreenLinuxFb::connect");

            qCritical("Error opening framebuffer device %s", qPrintable(dev));

            return false;

        }

        if (access(dev.toLatin1().constData(), R_OK) == 0)

            d_ptr->fd = QT_OPEN(dev.toLatin1().constData(), O_RDONLY);

    }

    ::fb_fix_screeninfo finfo;

    ::fb_var_screeninfo vinfo;

    //#######################

    // Shut up Valgrind

    memset(&vinfo, 0, sizeof(vinfo));

    memset(&finfo, 0, sizeof(finfo));

    //#######################

    /* Get fixed screen information */

    if (d_ptr->fd != -1 && ioctl(d_ptr->fd, FBIOGET_FSCREENINFO, &finfo)) {

        perror("QLinuxFbScreen::connect");

        qWarning("Error reading fixed information");

        return false;

    }

    d_ptr->driverType = strcmp(finfo.id, "8TRACKFB") ? GenericDriver : EInk8Track;

    if (finfo.type == FB_TYPE_VGA_PLANES) {

        qWarning("VGA16 video mode not supported");

        return false;

    }

    /* Get variable screen information */

    if (d_ptr->fd != -1 && ioctl(d_ptr->fd, FBIOGET_VSCREENINFO, &vinfo)) {

        perror("QLinuxFbScreen::connect");

        qWarning("Error reading variable information");

        return false;

    }

    fixupScreenInfo(finfo, vinfo);

    grayscale = vinfo.grayscale;

    d = vinfo.bits_per_pixel;

    if (d == 24) {

        d = vinfo.red.length + vinfo.green.length + vinfo.blue.length;

        if (d <= 0)

            d = 24; // reset if color component lengths are not reported

    } else if (d == 16) {

        d = vinfo.red.length + vinfo.green.length + vinfo.blue.length;

        if (d <= 0)

            d = 16;

    }

    lstep = finfo.line_length;

    int xoff = vinfo.xoffset;

    int yoff = vinfo.yoffset;

    const char* qwssize;

    if((qwssize=::getenv("QWS_SIZE")) && sscanf(qwssize,"%dx%d",&w,&h)==2) {

        if (d_ptr->fd != -1) {

            if ((uint)w > vinfo.xres) w = vinfo.xres;

            if ((uint)h > vinfo.yres) h = vinfo.yres;

        }

        dw=w;

        dh=h;

        int xxoff, yyoff;

        if (sscanf(qwssize, "%*dx%*d+%d+%d", &xxoff, &yyoff) == 2) {

            if (xxoff < 0 || xxoff + w > vinfo.xres)

                xxoff = vinfo.xres - w;

            if (yyoff < 0 || yyoff + h > vinfo.yres)

                yyoff = vinfo.yres - h;

            xoff += xxoff;

            yoff += yyoff;

        } else {

            xoff += (vinfo.xres - w)/2;

            yoff += (vinfo.yres - h)/2;

        }

    } else {

        dw=w=vinfo.xres;

        dh=h=vinfo.yres;

    }

    if (w == 0 || h == 0) {

        qWarning("QScreenLinuxFb::connect(): Unable to find screen geometry, "

                 "will use 320x240.");

        dw = w = 320;

        dh = h = 240;

    }

    setPixelFormat(vinfo);

    // Handle display physical size spec.

    QStringList displayArgs = displaySpec.split(QLatin1Char(':'));

    QRegExp mmWidthRx(QLatin1String("mmWidth=?(\\d+)"));

    int dimIdxW = displayArgs.indexOf(mmWidthRx);

    QRegExp mmHeightRx(QLatin1String("mmHeight=?(\\d+)"));

    int dimIdxH = displayArgs.indexOf(mmHeightRx);

    if (dimIdxW >= 0) {

        mmWidthRx.exactMatch(displayArgs.at(dimIdxW));

        physWidth = mmWidthRx.cap(1).toInt();

        if (dimIdxH < 0)

            physHeight = dh*physWidth/dw;

    }

    if (dimIdxH >= 0) {

        mmHeightRx.exactMatch(displayArgs.at(dimIdxH));

        physHeight = mmHeightRx.cap(1).toInt();

        if (dimIdxW < 0)

            physWidth = dw*physHeight/dh;

    }

    if (dimIdxW < 0 && dimIdxH < 0) {

        if (vinfo.width != 0 && vinfo.height != 0

            && vinfo.width != UINT_MAX && vinfo.height != UINT_MAX) {

            physWidth = vinfo.width;

            physHeight = vinfo.height;

        } else {

            const int dpi = 72;

            physWidth = qRound(dw * 25.4 / dpi);

            physHeight = qRound(dh * 25.4 / dpi);

        }

    }

    dataoffset = yoff * lstep + xoff * d / 8;

    //qDebug("Using %dx%dx%d screen",w,h,d);

    /* Figure out the size of the screen in bytes */

    size = h * lstep;

    mapsize = finfo.smem_len;

    data = (unsigned char *)-1;

    if (d_ptr->fd != -1)

        data = (unsigned char *)mmap(0, mapsize, PROT_READ | PROT_WRITE,

                                     MAP_SHARED, d_ptr->fd, 0);

    if ((long)data == -1) {

        if (QApplication::type() == QApplication::GuiServer) {

            perror("QLinuxFbScreen::connect");

            qWarning("Error: failed to map framebuffer device to memory.");

            return false;

        }

        data = 0;

    } else {

        data += dataoffset;

    }

    canaccel = useOffscreen();

    if(canaccel)

        setupOffScreen();

    // Now read in palette

    if((vinfo.bits_per_pixel==8) || (vinfo.bits_per_pixel==4)) {

        screencols= (vinfo.bits_per_pixel==8) ? 256 : 16;

        int loopc;

        ::fb_cmap startcmap;

        startcmap.start=0;

        startcmap.len=screencols;

        startcmap.red=(unsigned short int *)

                 malloc(sizeof(unsigned short int)*screencols);

        startcmap.green=(unsigned short int *)

                   malloc(sizeof(unsigned short int)*screencols);

        startcmap.blue=(unsigned short int *)

                  malloc(sizeof(unsigned short int)*screencols);

        startcmap.transp=(unsigned short int *)

                    malloc(sizeof(unsigned short int)*screencols);

        if (d_ptr->fd == -1 || ioctl(d_ptr->fd, FBIOGETCMAP, &startcmap)) {

            perror("QLinuxFbScreen::connect");

            qWarning("Error reading palette from framebuffer, using default palette");

            createPalette(startcmap, vinfo, finfo);

        }

        int bits_used = 0;

        for(loopc=0;loopc<screencols;loopc++) {

            screenclut[loopc]=qRgb(startcmap.red[loopc] >> 8,

                                   startcmap.green[loopc] >> 8,

                                   startcmap.blue[loopc] >> 8);

            bits_used |= startcmap.red[loopc]

                         | startcmap.green[loopc]

                         | startcmap.blue[loopc];

        }

        // WORKAROUND: Some framebuffer drivers only return 8 bit

        // color values, so we need to not bit shift them..

        if ((bits_used & 0x00ff) && !(bits_used & 0xff00)) {

            for(loopc=0;loopc<screencols;loopc++) {

                screenclut[loopc] = qRgb(startcmap.red[loopc],

                                         startcmap.green[loopc],

                                         startcmap.blue[loopc]);

            }

            qWarning("8 bits cmap returned due to faulty FB driver, colors corrected");

        }

        free(startcmap.red);

        free(startcmap.green);

        free(startcmap.blue);

        free(startcmap.transp);

    } else {

        screencols=0;

    }

    return true;

}

/*!

    \reimp

    This unmaps the framebuffer.

    \sa connect()

*/

void QLinuxFbScreen::disconnect()

{

    data -= dataoffset;

    if (data)

        munmap((char*)data,mapsize);