mach_pc/Pic.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 KERNEL_MACHINE_X86_COMMON_PIC_H
#define KERNEL_MACHINE_X86_COMMON_PIC_H

#include "pedigree/kernel/Spinlock.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/IrqManager.h"
#include "pedigree/kernel/machine/types.h"
#include "pedigree/kernel/processor/InterruptHandler.h"
#include "pedigree/kernel/processor/IoPort.h"
#include "pedigree/kernel/processor/state_forward.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/List.h"
#include "pedigree/kernel/utilities/new"

class Device;
class IrqHandler;

class Pic : public IrqManager, private InterruptHandler
{
  public:
    inline static Pic &instance()
    {
        return m_Instance;
    }

    //
    // IrqManager interface
    //
    virtual irq_id_t
    registerIsaIrqHandler(uint8_t irq, IrqHandler *handler, bool bEdge = false);
    virtual irq_id_t
    registerPciIrqHandler(IrqHandler *handler, Device *pDevice);
    virtual void acknowledgeIrq(irq_id_t Id);
    virtual void unregisterHandler(irq_id_t Id, IrqHandler *handler);

    bool initialise() INITIALISATION_ONLY;

    virtual void tick();

    virtual bool control(uint8_t irq, ControlCode code, size_t argument);

  private:
    Pic() INITIALISATION_ONLY;
    inline virtual ~Pic()
    {
    }
    Pic(const Pic &);
    Pic &operator=(const Pic &);

    //
    // InterruptHandler interface
    //
    virtual void interrupt(size_t interruptNumber, InterruptState &state);

    void eoi(uint8_t irq);
    void enable(uint8_t irq, bool enable);
    void enableAll(bool enable);

    bool spurious(size_t irq);

    IoPort m_SlavePort;
    IoPort m_MasterPort;

    List<IrqHandler *> m_Handler[16];
    bool m_HandlerEdge[16];
    size_t m_IrqCount[16];
    bool m_MitigatedIrqs[16];
    size_t m_MitigationThreshold[16];
    uint8_t m_InterruptMask;

    Spinlock m_Lock;

    static Pic m_Instance;
};

#endif