kernel/machine/mach_pc/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_X86_VGA_H
#define MACHINE_X86_VGA_H

#include "pedigree/kernel/machine/Vga.h"
#include "pedigree/kernel/processor/IoPort.h"
#include "pedigree/kernel/processor/MemoryMappedIo.h"
#include "pedigree/kernel/processor/types.h"

#define VGA_BASE 0x3C0
#define VGA_AC_INDEX 0x0
#define VGA_AC_WRITE 0x0
#define VGA_AC_READ 0x1
#define VGA_MISC_WRITE 0x2
#define VGA_SEQ_INDEX 0x4
#define VGA_SEQ_DATA 0x5
#define VGA_DAC_READ_INDEX 0x7
#define VGA_DAC_WRITE_INDEX 0x8
#define VGA_DAC_DATA 0x9
#define VGA_MISC_READ 0xC
#define VGA_GC_INDEX 0xE
#define VGA_GC_DATA 0xF
#define VGA_REG_ATTR_MODE_CTL 0x10
/*                              COLOR emulation  MONO emulation */
#define VGA_CRTC_INDEX 0x14 /* 0x3B4 */
#define VGA_CRTC_DATA 0x15  /* 0x3B5 */
#define VGA_INSTAT_READ 0x1A

#define VGA_PAS 0x20 /* Palette Address Source */

#define VGA_NUM_SEQ_REGS 5
#define VGA_NUM_CRTC_REGS 25
#define VGA_NUM_GC_REGS 9
#define VGA_NUM_AC_REGS 21
#define VGA_NUM_REGS                                              \
    (1 + VGA_NUM_SEQ_REGS + VGA_NUM_CRTC_REGS + VGA_NUM_GC_REGS + \
     VGA_NUM_AC_REGS)

class X86Vga : public Vga
{
  public:
    X86Vga(uint32_t nRegisterBase, uint32_t nFramebufferBase);
    virtual ~X86Vga();

    virtual void setControl(VgaControl which);

    virtual void clearControl(VgaControl which);

    virtual bool setMode(int mode);

    virtual bool setLargestTextMode();

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

    virtual bool isLargestTextMode();

    virtual size_t getNumCols()
    {
        return m_nWidth;
    }

    virtual size_t getNumRows()
    {
        return m_nHeight;
    }

    virtual void rememberMode();

    virtual void restoreMode();

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

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

    virtual void moveCursor(size_t nX, size_t nY);

    bool initialise();

    operator uint16_t *() const
    {
        if (m_Framebuffer == true)
            return reinterpret_cast<uint16_t *>(m_Framebuffer.virtualAddress());
        else
            return reinterpret_cast<uint16_t *>(m_pFramebuffer);
    }

  private:
    X86Vga(const X86Vga &);
    X86Vga &operator=(const X86Vga &);

    uint8_t getControls();
    void setControls(uint8_t newControls);

    IoPort m_RegisterPort;

    MemoryMappedIo m_Framebuffer;

    uint8_t *m_pFramebuffer;

    size_t m_nWidth;

    size_t m_nHeight;

    int m_ModeStack;

    int m_nMode;

    uint8_t m_nControls;
};

#endif