intel_8254_timer.hh revision 8229
15443Sgblack@eecs.umich.edu/* 25443Sgblack@eecs.umich.edu * Copyright (c) 2004, 2005 35443Sgblack@eecs.umich.edu * The Regents of The University of Michigan 45443Sgblack@eecs.umich.edu * All Rights Reserved 55443Sgblack@eecs.umich.edu * 65443Sgblack@eecs.umich.edu * This code is part of the M5 simulator. 75443Sgblack@eecs.umich.edu * 85443Sgblack@eecs.umich.edu * Permission is granted to use, copy, create derivative works and 95443Sgblack@eecs.umich.edu * redistribute this software and such derivative works for any 105443Sgblack@eecs.umich.edu * purpose, so long as the copyright notice above, this grant of 115443Sgblack@eecs.umich.edu * permission, and the disclaimer below appear in all copies made; and 125443Sgblack@eecs.umich.edu * so long as the name of The University of Michigan is not used in 135443Sgblack@eecs.umich.edu * any advertising or publicity pertaining to the use or distribution 145443Sgblack@eecs.umich.edu * of this software without specific, written prior authorization. 155443Sgblack@eecs.umich.edu * 165443Sgblack@eecs.umich.edu * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE 175443Sgblack@eecs.umich.edu * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND 185443Sgblack@eecs.umich.edu * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER 195443Sgblack@eecs.umich.edu * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED 205443Sgblack@eecs.umich.edu * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 215443Sgblack@eecs.umich.edu * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE 225443Sgblack@eecs.umich.edu * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT, 235443Sgblack@eecs.umich.edu * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM 245443Sgblack@eecs.umich.edu * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN 255443Sgblack@eecs.umich.edu * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH 265443Sgblack@eecs.umich.edu * DAMAGES. 275443Sgblack@eecs.umich.edu * 285443Sgblack@eecs.umich.edu * Authors: Ali G. Saidi 295443Sgblack@eecs.umich.edu * Andrew L. Schultz 305443Sgblack@eecs.umich.edu * Miguel J. Serrano 315443Sgblack@eecs.umich.edu */ 325443Sgblack@eecs.umich.edu 335443Sgblack@eecs.umich.edu#ifndef __DEV_8254_HH__ 345443Sgblack@eecs.umich.edu#define __DEV_8254_HH__ 355443Sgblack@eecs.umich.edu 368229Snate@binkert.org#include <iostream> 375606Snate@binkert.org#include <string> 385606Snate@binkert.org 395443Sgblack@eecs.umich.edu#include "base/bitunion.hh" 406216Snate@binkert.org#include "base/types.hh" 415443Sgblack@eecs.umich.edu#include "sim/eventq.hh" 425443Sgblack@eecs.umich.edu#include "sim/serialize.hh" 435443Sgblack@eecs.umich.edu 445443Sgblack@eecs.umich.edu/** Programmable Interval Timer (Intel 8254) */ 455606Snate@binkert.orgclass Intel8254Timer : public EventManager 465443Sgblack@eecs.umich.edu{ 475635Sgblack@eecs.umich.edu protected: 485443Sgblack@eecs.umich.edu BitUnion8(CtrlReg) 495443Sgblack@eecs.umich.edu Bitfield<7, 6> sel; 505443Sgblack@eecs.umich.edu Bitfield<5, 4> rw; 515443Sgblack@eecs.umich.edu Bitfield<3, 1> mode; 525443Sgblack@eecs.umich.edu Bitfield<0> bcd; 535443Sgblack@eecs.umich.edu EndBitUnion(CtrlReg) 545443Sgblack@eecs.umich.edu 555443Sgblack@eecs.umich.edu enum SelectVal { 565443Sgblack@eecs.umich.edu SelectCounter0, 575443Sgblack@eecs.umich.edu SelectCounter1, 585443Sgblack@eecs.umich.edu SelectCounter2, 595443Sgblack@eecs.umich.edu ReadBackCommand 605443Sgblack@eecs.umich.edu }; 615443Sgblack@eecs.umich.edu 625443Sgblack@eecs.umich.edu enum ReadWriteVal { 635443Sgblack@eecs.umich.edu LatchCommand, 645443Sgblack@eecs.umich.edu LsbOnly, 655443Sgblack@eecs.umich.edu MsbOnly, 665443Sgblack@eecs.umich.edu TwoPhase 675443Sgblack@eecs.umich.edu }; 685443Sgblack@eecs.umich.edu 695443Sgblack@eecs.umich.edu enum ModeVal { 705443Sgblack@eecs.umich.edu InitTc, 715443Sgblack@eecs.umich.edu OneShot, 725443Sgblack@eecs.umich.edu RateGen, 735443Sgblack@eecs.umich.edu SquareWave, 745443Sgblack@eecs.umich.edu SoftwareStrobe, 755443Sgblack@eecs.umich.edu HardwareStrobe 765443Sgblack@eecs.umich.edu }; 775443Sgblack@eecs.umich.edu 785443Sgblack@eecs.umich.edu /** Counter element for PIT */ 795443Sgblack@eecs.umich.edu class Counter 805443Sgblack@eecs.umich.edu { 815443Sgblack@eecs.umich.edu /** Event for counter interrupt */ 825443Sgblack@eecs.umich.edu class CounterEvent : public Event 835443Sgblack@eecs.umich.edu { 845443Sgblack@eecs.umich.edu private: 855443Sgblack@eecs.umich.edu /** Pointer back to Counter */ 865443Sgblack@eecs.umich.edu Counter* counter; 875443Sgblack@eecs.umich.edu Tick interval; 885443Sgblack@eecs.umich.edu 895443Sgblack@eecs.umich.edu public: 905443Sgblack@eecs.umich.edu CounterEvent(Counter*); 915443Sgblack@eecs.umich.edu 925443Sgblack@eecs.umich.edu /** Event process */ 935642Sgblack@eecs.umich.edu void process(); 945443Sgblack@eecs.umich.edu 955443Sgblack@eecs.umich.edu /** Event description */ 965443Sgblack@eecs.umich.edu virtual const char *description() const; 975443Sgblack@eecs.umich.edu 985443Sgblack@eecs.umich.edu friend class Counter; 995444Sgblack@eecs.umich.edu 1005444Sgblack@eecs.umich.edu void setTo(int clocks); 1016067Sgblack@eecs.umich.edu 1026067Sgblack@eecs.umich.edu int clocksLeft(); 1035443Sgblack@eecs.umich.edu }; 1045443Sgblack@eecs.umich.edu 1055443Sgblack@eecs.umich.edu private: 1065443Sgblack@eecs.umich.edu std::string _name; 1075443Sgblack@eecs.umich.edu const std::string &name() const { return _name; } 1085443Sgblack@eecs.umich.edu 1095642Sgblack@eecs.umich.edu unsigned int num; 1105642Sgblack@eecs.umich.edu 1115443Sgblack@eecs.umich.edu CounterEvent event; 1125443Sgblack@eecs.umich.edu 1136067Sgblack@eecs.umich.edu /** Initial count value */ 1146067Sgblack@eecs.umich.edu uint16_t initial_count; 1155443Sgblack@eecs.umich.edu 1165443Sgblack@eecs.umich.edu /** Latched count */ 1175443Sgblack@eecs.umich.edu uint16_t latched_count; 1185443Sgblack@eecs.umich.edu 1195443Sgblack@eecs.umich.edu /** Interrupt period */ 1205443Sgblack@eecs.umich.edu uint16_t period; 1215443Sgblack@eecs.umich.edu 1225443Sgblack@eecs.umich.edu /** Current mode of operation */ 1235443Sgblack@eecs.umich.edu uint8_t mode; 1245443Sgblack@eecs.umich.edu 1255443Sgblack@eecs.umich.edu /** Output goes high when the counter reaches zero */ 1265443Sgblack@eecs.umich.edu bool output_high; 1275443Sgblack@eecs.umich.edu 1285443Sgblack@eecs.umich.edu /** State of the count latch */ 1295443Sgblack@eecs.umich.edu bool latch_on; 1305443Sgblack@eecs.umich.edu 1315443Sgblack@eecs.umich.edu /** Set of values for read_byte and write_byte */ 1325443Sgblack@eecs.umich.edu enum {LSB, MSB}; 1335443Sgblack@eecs.umich.edu 1345443Sgblack@eecs.umich.edu /** Determine which byte of a 16-bit count value to read/write */ 1355443Sgblack@eecs.umich.edu uint8_t read_byte, write_byte; 1365443Sgblack@eecs.umich.edu 1375606Snate@binkert.org /** Pointer to container */ 1385606Snate@binkert.org Intel8254Timer *parent; 1395606Snate@binkert.org 1405443Sgblack@eecs.umich.edu public: 1415642Sgblack@eecs.umich.edu Counter(Intel8254Timer *p, const std::string &name, unsigned int num); 1425443Sgblack@eecs.umich.edu 1435443Sgblack@eecs.umich.edu /** Latch the current count (if one is not already latched) */ 1445443Sgblack@eecs.umich.edu void latchCount(); 1455443Sgblack@eecs.umich.edu 1466067Sgblack@eecs.umich.edu /** Get the current count for this counter */ 1476067Sgblack@eecs.umich.edu int currentCount(); 1486067Sgblack@eecs.umich.edu 1495443Sgblack@eecs.umich.edu /** Set the read/write mode */ 1505443Sgblack@eecs.umich.edu void setRW(int rw_val); 1515443Sgblack@eecs.umich.edu 1525443Sgblack@eecs.umich.edu /** Set operational mode */ 1535443Sgblack@eecs.umich.edu void setMode(int mode_val); 1545443Sgblack@eecs.umich.edu 1555443Sgblack@eecs.umich.edu /** Set count encoding */ 1565443Sgblack@eecs.umich.edu void setBCD(int bcd_val); 1575443Sgblack@eecs.umich.edu 1585443Sgblack@eecs.umich.edu /** Read a count byte */ 1595443Sgblack@eecs.umich.edu uint8_t read(); 1605443Sgblack@eecs.umich.edu 1615443Sgblack@eecs.umich.edu /** Write a count byte */ 1625443Sgblack@eecs.umich.edu void write(const uint8_t data); 1635443Sgblack@eecs.umich.edu 1645443Sgblack@eecs.umich.edu /** Is the output high? */ 1655443Sgblack@eecs.umich.edu bool outputHigh(); 1665443Sgblack@eecs.umich.edu 1675443Sgblack@eecs.umich.edu /** 1685443Sgblack@eecs.umich.edu * Serialize this object to the given output stream. 1695443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 1705443Sgblack@eecs.umich.edu * @param os The stream to serialize to. 1715443Sgblack@eecs.umich.edu */ 1725443Sgblack@eecs.umich.edu void serialize(const std::string &base, std::ostream &os); 1735443Sgblack@eecs.umich.edu 1745443Sgblack@eecs.umich.edu /** 1755443Sgblack@eecs.umich.edu * Reconstruct the state of this object from a checkpoint. 1765443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 1775443Sgblack@eecs.umich.edu * @param cp The checkpoint use. 1785443Sgblack@eecs.umich.edu * @param section The section name of this object 1795443Sgblack@eecs.umich.edu */ 1805443Sgblack@eecs.umich.edu void unserialize(const std::string &base, Checkpoint *cp, 1815443Sgblack@eecs.umich.edu const std::string §ion); 1825443Sgblack@eecs.umich.edu }; 1835443Sgblack@eecs.umich.edu 1845635Sgblack@eecs.umich.edu protected: 1855443Sgblack@eecs.umich.edu std::string _name; 1865443Sgblack@eecs.umich.edu const std::string &name() const { return _name; } 1875443Sgblack@eecs.umich.edu 1885443Sgblack@eecs.umich.edu /** PIT has three seperate counters */ 1895443Sgblack@eecs.umich.edu Counter *counter[3]; 1905443Sgblack@eecs.umich.edu 1915642Sgblack@eecs.umich.edu virtual void 1925642Sgblack@eecs.umich.edu counterInterrupt(unsigned int num) 1935642Sgblack@eecs.umich.edu { 1945642Sgblack@eecs.umich.edu DPRINTF(Intel8254Timer, "Timer interrupt from counter %d.\n", num); 1955642Sgblack@eecs.umich.edu } 1965642Sgblack@eecs.umich.edu 1975443Sgblack@eecs.umich.edu public: 1985635Sgblack@eecs.umich.edu 1995642Sgblack@eecs.umich.edu virtual 2005642Sgblack@eecs.umich.edu ~Intel8254Timer() 2015642Sgblack@eecs.umich.edu {} 2025642Sgblack@eecs.umich.edu 2035635Sgblack@eecs.umich.edu Intel8254Timer(EventManager *em, const std::string &name, 2045635Sgblack@eecs.umich.edu Counter *counter0, Counter *counter1, Counter *counter2); 2055443Sgblack@eecs.umich.edu 2065606Snate@binkert.org Intel8254Timer(EventManager *em, const std::string &name); 2075443Sgblack@eecs.umich.edu 2085443Sgblack@eecs.umich.edu /** Write control word */ 2095443Sgblack@eecs.umich.edu void writeControl(const CtrlReg data); 2105443Sgblack@eecs.umich.edu 2115635Sgblack@eecs.umich.edu uint8_t 2125635Sgblack@eecs.umich.edu readCounter(unsigned int num) 2135635Sgblack@eecs.umich.edu { 2145635Sgblack@eecs.umich.edu assert(num < 3); 2155635Sgblack@eecs.umich.edu return counter[num]->read(); 2165635Sgblack@eecs.umich.edu } 2175635Sgblack@eecs.umich.edu 2185635Sgblack@eecs.umich.edu void 2195635Sgblack@eecs.umich.edu writeCounter(unsigned int num, const uint8_t data) 2205635Sgblack@eecs.umich.edu { 2215635Sgblack@eecs.umich.edu assert(num < 3); 2225635Sgblack@eecs.umich.edu counter[num]->write(data); 2235635Sgblack@eecs.umich.edu } 2245635Sgblack@eecs.umich.edu 2255635Sgblack@eecs.umich.edu bool 2265635Sgblack@eecs.umich.edu outputHigh(unsigned int num) 2275635Sgblack@eecs.umich.edu { 2285635Sgblack@eecs.umich.edu assert(num < 3); 2295635Sgblack@eecs.umich.edu return counter[num]->outputHigh(); 2305635Sgblack@eecs.umich.edu } 2315635Sgblack@eecs.umich.edu 2325443Sgblack@eecs.umich.edu /** 2335443Sgblack@eecs.umich.edu * Serialize this object to the given output stream. 2345443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 2355443Sgblack@eecs.umich.edu * @param os The stream to serialize to. 2365443Sgblack@eecs.umich.edu */ 2375443Sgblack@eecs.umich.edu void serialize(const std::string &base, std::ostream &os); 2385443Sgblack@eecs.umich.edu 2395443Sgblack@eecs.umich.edu /** 2405443Sgblack@eecs.umich.edu * Reconstruct the state of this object from a checkpoint. 2415443Sgblack@eecs.umich.edu * @param base The base name of the counter object. 2425443Sgblack@eecs.umich.edu * @param cp The checkpoint use. 2435443Sgblack@eecs.umich.edu * @param section The section name of this object 2445443Sgblack@eecs.umich.edu */ 2455443Sgblack@eecs.umich.edu void unserialize(const std::string &base, Checkpoint *cp, 2465443Sgblack@eecs.umich.edu const std::string §ion); 2475443Sgblack@eecs.umich.edu}; 2485443Sgblack@eecs.umich.edu 2495443Sgblack@eecs.umich.edu#endif // __DEV_8254_HH__ 250