Set license using %license
[platform/upstream/x86info.git] / lsmsr.8
1 .\" Copyright (C) 2008 Advanced Micro Devices, Inc.
2 '\"! tbl | mmdoc 
3 '\"macro stdmacro 
4 .nr X
5 .TH lsmsr 8 "July 2008" "x86utils"
6 .SH NAME
7 lsmsr \- show MSR information for x86 CPUs
8
9 .SH SYNOPSIS
10 .B lsmsr
11 .RB [ \-hv ]
12 .RB [ \-a
13 .RB [ \-c
14 .IR cpu_nr ]
15 .RB [ \-f
16 .IR family ]
17 .RB [ \-l]
18 .RB [ \-r
19 .IR name|address ]
20 .RB [\-V
21 .IR verbosity]
22 .IR [MSR]
23
24 .SH DESCRIPTION
25 .PP
26 .B lsmsr
27 is a tool to display information for machine specific registers
28 of x86 CPUs. Following CPUs are supported:
29 AMD family 0xf and family 0x10. For Intel and other AMD CPUs just
30 a some common MSRs is supported.
31 .SH OPTIONS
32 .TP
33 .B -a, --all
34 Show information for all MSRs known to the tool for that CPU family.
35 .TP
36 .B -c cpu_nr, --cpu  cpu_nr
37 Select CPU (by number) for which MSR information should be displayed
38 (default: 0).
39 .TP
40 .B -f fam, --family fam
41 Specify CPU family. Normally CPU family is auto-detected. You can
42 use this option to disable auto-detection, e.g. for debugging
43 purposes.
44 .TP
45 .B -l, --list
46 Show definition (address, field description) of selected MSR(s).
47 .TP
48 .B -r name|address, --register name|address
49 Specify MSR  (by name or address in hex) for which MSR information
50 should be displayed.
51 .TP
52 .B -V num, --verbosity num
53 Select verbosity of output format (between 0 and 4, default: 0)
54 .TP
55 .B -h, --help
56 Print help message and exit.
57 .TP
58 .B -v, --version
59 Display version info and exit.
60 .SH Examples
61 .IP "" 0
62 Show all MSRs beginning with 'MTRR' and force CPU family  to 0x10
63 .IP "" 2
64 # lsmsr -l -f 0x10 MTRR
65  MTRRcap             : 0x000000fe
66  MTRRphysBase0       : 0x00000200
67  MTRRphysMask0       : 0x00000201
68  MTRRphysBase1       : 0x00000202
69  MTRRphysMask1       : 0x00000203
70  MTRRphysBase2       : 0x00000204
71  MTRRphysMask2       : 0x00000205
72  MTRRphysBase3       : 0x00000206
73  MTRRphysMask3       : 0x00000207
74  MTRRphysBase4       : 0x00000208
75  MTRRphysMask4       : 0x00000209
76  MTRRphysBase5       : 0x0000020a
77  MTRRphysMask5       : 0x0000020b
78  MTRRphysBase6       : 0x0000020c
79  MTRRphysMask6       : 0x0000020d
80  MTRRphysBase7       : 0x0000020e
81  MTRRphysMask7       : 0x0000020f
82  MTRRfix64K_00000    : 0x00000250
83  MTRRfix16K_80000    : 0x00000258
84  MTRRfix16K_A0000    : 0x00000259
85  MTRRfix4K_C0000     : 0x00000268
86  MTRRfix4K_C8000     : 0x00000269
87  MTRRfix4K_D0000     : 0x0000026a
88  MTRRfix4K_D8000     : 0x0000026b
89  MTRRfix4K_E0000     : 0x0000026c
90  MTRRfix4K_E8000     : 0x0000026d
91  MTRRfix4K_F0000     : 0x0000026e
92  MTRRfix4K_F8000     : 0x0000026f
93  MTRRdefType         : 0x000002ff
94 .IP ""0
95 Show 'MTRRcap MSR in verbose one-line mode
96 .IP "" 2
97 # lsmsr -r MTRRcap -V 1   
98  MTRRcap = 0x0000000000000508 (MtrrCapVCnt=0x8,  MtrrCapFix=0x1,  MtrrCapWc=0x1)
99 .IP "" 0
100 Show 'MTRRdefType' in verbose multi-line mode 
101 .IP "" 2
102 # lsmsr -r MTRRdefType -V 3 
103  MTRRdefType          = 0x0000000000000c00
104    MtrrDefMemType=0
105    MtrrDefTypeFixEn=0x1
106    MtrrDefTypeEn=0x1
107 .IP "" 0
108 Show definition of MSR 0x200 in verbose multi-line mode (including reserved fields)
109 .IP "" 2
110 # lsmsr -r 0x200 -V 4 -l
111  MTRRphysBase0: 0x00000200
112    0-7:Type
113    8-11:res
114    12-39:PhyBase
115    40-63:res
116 .IP "" 0
117 List all known MSRs for family 0xf
118 .IP "" 2
119 # lsmsr  -f 0xf -l -a 
120  TSC                 : 0x00000010; time-stamp counter
121  APIC_BASE           : 0x0000001b; APIC base address
122
123  ...
124
125  MTRRphysBase0       : 0x00000200; base of variable MTRR (0)
126  MTRRphysMask0       : 0x00000201; mask of variable MTRR (0)
127  MTRRphysBase1       : 0x00000202; base of variable MTRR (1)
128  MTRRphysMask1       : 0x00000203; mask of variable MTRR (1)
129
130  ...
131
132  MTRRfix4K_F0000     : 0x0000026e
133  MTRRfix4K_F8000     : 0x0000026f
134  PAT                 : 0x00000277; page attribute table
135  MTRRdefType         : 0x000002ff
136
137
138 .SH Author
139 .B lsmsr
140 and this manual page was written by Andreas Herrmann <andreas.herrman3@amd.com>.
141 .PP
142 Permission is granted to copy, distribute and/or modify this 
143 document under the terms of the GNU General Public License version 2.
144
145 .SH REPORTING BUGS
146 Please send bug reports to <andreas.herrmann3@amd.com>.