LocalApic.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_LOCAL_APIC_H
#define KERNEL_MACHINE_X86_COMMON_LOCAL_APIC_H

#if defined(APIC)

#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/SchedulerTimer.h"
#include "pedigree/kernel/processor/InterruptHandler.h"
#include "pedigree/kernel/processor/MemoryMappedIo.h"
#include "pedigree/kernel/processor/Processor.h"
#include "pedigree/kernel/processor/ProcessorInformation.h"
#include "pedigree/kernel/processor/state_forward.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/Tree.h"
#include "pedigree/kernel/utilities/new"

class TimerHandler;

#define IPI_HALT_VECTOR 0xFB
#define ERROR_VECTOR 0xFC
#define SPURIOUS_VECTOR 0xFD
#define TIMER_VECTOR 0xFE

class LocalApic : public SchedulerTimer, private InterruptHandler
{
  public:
    inline LocalApic()
        : m_IoSpace("Local APIC"), m_Handlers(), m_BusFrequency(0)
    {
    }
    inline virtual ~LocalApic()
    {
    }

    bool initialise(uint64_t physicalAddress) INITIALISATION_ONLY;
    bool initialiseProcessor() INITIALISATION_ONLY;

    enum
    {
        deliveryModeFixed = 0,
        deliveryModeLowestPriority = 1,
        deliveryModeSmi = 2,
        deliveryModeNmi = 4,
        deliveryModeInit = 5,
        deliveryModeStartup = 6,
        deliveryModeExtInt = 7
    };

    void interProcessorInterrupt(
        uint8_t destinationApicId, uint8_t vector, size_t deliveryMode,
        bool bAssert, bool bLevelTriggered);

    void interProcessorInterruptAllExcludingThis(
        uint8_t vector, size_t deliveryMode);

    uint8_t getId();

    //
    // SchedulerTimer interface
    //
    virtual bool registerHandler(TimerHandler *handler)
    {
        // insert() won't insert if the key is already present.
        m_Handlers.insert(Processor::id(), handler);
        return false;
    }

    void ack();

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

    bool check(uint64_t physicalAddress) INITIALISATION_ONLY;

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

    MemoryMappedIo m_IoSpace;

    Tree<ProcessorId, TimerHandler *> m_Handlers;

    size_t m_BusFrequency;
};

#endif

#endif