1/*
2 * Copyright (c) 2011 Google
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Gabe Black
29 */
30
31#ifndef __ARCH_X86_REG_MSR_HH__
32#define __ARCH_X86_REG_MSR_HH__
33
34#include <unordered_map>
35
36#include "arch/x86/regs/misc.hh"
37#include "base/types.hh"
38
39namespace X86ISA
40{
41
42typedef std::unordered_map<Addr, MiscRegIndex> MsrMap;
43
44/**
45 * Map between MSR addresses and their corresponding misc registers.
46 *
47 * @note This map is usually only used when enumeration of supported
48 * MSRs is needed (e.g., in virtualized CPUs). Code that needs to
49 * look-up specific MSRs should use msrAddrToIndex().
50 */
51extern const MsrMap msrMap;
52
53/**
54 * Find and return the misc reg corresponding to an MSR address.
55 *
56 * Look for an MSR (addr) in #msrMap and return the
57 * corresponding misc reg in regNum. The value of regNum is undefined
58 * if the MSR was not found.
59 *
60 * @param regNum misc reg index (out).
61 * @param addr MSR address
62 * @return True if the MSR was found, false otherwise.
63 */
64bool msrAddrToIndex(MiscRegIndex &regNum, Addr addr);
65
66} // namespace X86ISA
67
68#endif // __ARCH_X86_REG_MSR_HH__
69