Timer.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBARCH_TIMER_H
#define __LIBARCH_TIMER_H
 
#include <Macros.h>
#include <Types.h>
 
class Timer
{
  public:
 
    typedef struct Info
    {
        u32 ticks;
        Size frequency;
    }
    ALIGN(8) Info;
 
    enum Result
    {
        Success,
        NotFound,
        IOError,
        InvalidFrequency
    };
 
    Timer();
 
    Size getInterrupt() const;
 
    Size getFrequency() const;
 
    virtual Result setFrequency(Size hertz);
 
    virtual Result getCurrent(Info *info,
                              const Size msecOffset = 0);
 
    virtual Result initialize();
 
    virtual Result start();
 
    virtual Result stop();
 
    virtual Result tick();
 
    virtual Result wait(u32 microseconds) const;
 
    bool isExpired(const Info & info) const;
 
  protected:
 
    Size m_ticks;
 
    Size m_frequency;
 
    Size m_int;
};
 
#endif /* __LIBARCH_TIMER_H */