projects / OpenSPARC-T2-DV / blame
| Commit | Line | Data |
|---|---|---|
| 86530b38 AT |
1 | // ========== Copyright Header Begin ========================================== |
| 2 | // | |
| 3 | // OpenSPARC T2 Processor File: csr_if.hpp | |
| 4 | // Copyright (C) 1995-2007 Sun Microsystems, Inc. All Rights Reserved | |
| 5 | // 4150 Network Circle, Santa Clara, California 95054, U.S.A. | |
| 6 | // | |
| 7 | // * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 8 | // | |
| 9 | // This program is free software; you can redistribute it and/or modify | |
| 10 | // it under the terms of the GNU General Public License as published by | |
| 11 | // the Free Software Foundation; version 2 of the License. | |
| 12 | // | |
| 13 | // This program is distributed in the hope that it will be useful, | |
| 14 | // but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 | // GNU General Public License for more details. | |
| 17 | // | |
| 18 | // You should have received a copy of the GNU General Public License | |
| 19 | // along with this program; if not, write to the Free Software | |
| 20 | // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
| 21 | // | |
| 22 | // For the avoidance of doubt, and except that if any non-GPL license | |
| 23 | // choice is available it will apply instead, Sun elects to use only | |
| 24 | // the General Public License version 2 (GPLv2) at this time for any | |
| 25 | // software where a choice of GPL license versions is made | |
| 26 | // available with the language indicating that GPLv2 or any later version | |
| 27 | // may be used, or where a choice of which version of the GPL is applied is | |
| 28 | // otherwise unspecified. | |
| 29 | // | |
| 30 | // Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, | |
| 31 | // CA 95054 USA or visit www.sun.com if you need additional information or | |
| 32 | // have any questions. | |
| 33 | // | |
| 34 | // ========== Copyright Header End ============================================ | |
| 35 | #ifndef INC_csr_if_hpp__ | |
| 36 | #define INC_csr_if_hpp__ | |
| 37 | ||
| 38 | #include <systemc.h> | |
| 39 | ||
| 40 | namespace pcie { | |
| 41 | /** CSR Interface definition */ | |
| 42 | template < typename ADDR, typename DATA > | |
| 43 | class csr_if | |
| 44 | { | |
| 45 | public: | |
| 46 | ||
| 47 | virtual bool is_mapped(const ADDR reg_addr) = 0; /// return true if the reg_addr is mapped on the CSR DB | |
| 48 | virtual DATA read_csr(const ADDR reg_addr) = 0; /// returns the current CSR value | |
| 49 | virtual DATA write_csr(const ADDR reg_addr, const DATA wr_val) = 0; /// Overwrites the CSR value with new wr_val and the write_mask | |
| 50 | virtual DATA write_csr_mask(const ADDR reg_addr, const DATA wr_val, const DATA fld_mask) = 0; /// Writes only the bits enabled by the fld_mask | |
| 51 | virtual void set_notify_event(ADDR reg_addr, sc_event* event_handle) = 0; /// Registers an event handle to be notified, when the given CSR value changes | |
| 52 | virtual void reset_csr_db() = 0; /// Reset the CSR values to power on values | |
| 53 | virtual void create_csr_db() = 0; /// Create the new CSR DB with default values | |
| 54 | }; | |
| 55 | ||
| 56 | ||
| 57 | typedef enum {CSR_READ, CSR_WRITE, CSR_WRITE_MASK, CSR_SETEVENT, CSR_ISMAPPED, CSR_RESET, CSR_CREATE} CSR_CMD; | |
| 58 | ||
| 59 | template < typename ADDR, typename DATA > | |
| 60 | class csr_req { | |
| 61 | public: | |
| 62 | CSR_CMD _cmd; | |
| 63 | ADDR _addr; | |
| 64 | DATA _data; | |
| 65 | DATA _fld_mask; | |
| 66 | sc_event *_event; | |
| 67 | bool _read_clear; | |
| 68 | }; | |
| 69 | ||
| 70 | template <typename DATA> | |
| 71 | class csr_rsp { | |
| 72 | public: | |
| 73 | DATA _data; | |
| 74 | bool _is_mapped; | |
| 75 | }; | |
| 76 | }; | |
| 77 | ||
| 78 | ||
| 79 | #endif // INC_csr_if_hpp__ |