include/pedigree/kernel/machine/Vga.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef MACHINE_VGA_H
#define MACHINE_VGA_H

#include "pedigree/kernel/processor/types.h"

class Vga
{
  public:
    enum VgaControl
    {
        LineGraphics = 2,
        Blink = 3,
    };

    virtual ~Vga();

    virtual void setControl(VgaControl which) = 0;

    virtual void clearControl(VgaControl which) = 0;

    virtual bool setMode(int mode) = 0;

    virtual bool setLargestTextMode() = 0;

    virtual bool
    isMode(size_t nCols, size_t nRows, bool bIsText, size_t nBpp = 0) = 0;

    virtual bool isLargestTextMode() = 0;

    virtual size_t getNumCols() = 0;

    virtual size_t getNumRows() = 0;

    virtual void rememberMode() = 0;

    virtual void restoreMode() = 0;

    virtual void pokeBuffer(uint8_t *pBuffer, size_t nBufLen) = 0;

    virtual void peekBuffer(uint8_t *pBuffer, size_t nBufLen) = 0;

    virtual void moveCursor(size_t nX, size_t nY) = 0;

    virtual operator uint16_t *() const = 0;
};

#endif