Skip to content

Commit 7c880f5

Browse files
cblichmanncblichmann
committed
Initial commit
0 parents  commit 7c880f5

28 files changed

Lines changed: 2397 additions & 0 deletions

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Editor backup files
2+
*~
3+
.*.swp
4+
.*.swo
5+
6+
# Build artifacts
7+
.build/

‎CONTRIBUTING.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Want to contribute? Great! First, read this page (including the small print at the end).
2+
3+
### Before you contribute
4+
Before we can use your code, you must sign the
5+
[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
6+
(CLA), which you can do online. The CLA is necessary mainly because you own the
7+
copyright to your changes, even after your contribution becomes part of our
8+
codebase, so we need your permission to use and distribute your code. We also
9+
need to be sure of various other things—for instance that you'll tell us if you
10+
know that your code infringes on other people's patents. You don't have to sign
11+
the CLA until after you've submitted your code for review and a member has
12+
approved it, but you must do it before we can put your code into our codebase.
13+
Before you start working on a larger contribution, you should get in touch with
14+
us first through the issue tracker with your idea so that we can help out and
15+
possibly guide you. Coordinating up front makes it much easier to avoid
16+
frustration later on.
17+
18+
### Code reviews
19+
All submissions, including submissions by project members, require review. We
20+
use Github pull requests for this purpose.
21+
22+
### The small print
23+
Contributions made by corporations are covered by a different agreement than
24+
the one above, the
25+
[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎Makefile‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Copyright 2014-2017 Google Inc. All Rights Reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# Linux Makefile to build the pawn command line tool.
16+
17+
this_dir := $(patsubst %/,%,$(dir $(abspath $(lastword $(MAKEFILE_LIST)))))
18+
19+
# Directory with build artifacts. Should not contain spaces.
20+
build_dir := $(this_dir)/.build
21+
22+
# Default flags (all targets)
23+
CPPFLAGS += "-iquote$(build_dir)"
24+
CXXFLAGS += -std=c++11
25+
LDFLAGS +=
26+
27+
# Feature: Debug build
28+
ifndef DEBUG
29+
CPPFLAGS += \
30+
-DNDEBUG
31+
CXXFLAGS += \
32+
-O2 \
33+
-g0 -static
34+
LDFLAGS += \
35+
-Wl,--gc-sections \
36+
-Wl,--strip-all \
37+
-Wl,-Bstatic \
38+
-static-libstdc++
39+
else
40+
CXXFLAGS += \
41+
-ggdb
42+
LDFLAGS +=
43+
endif
44+
45+
# Rules
46+
CXXCOMPILE = $(CXX) $(CPPFLAGS)
47+
48+
pawn_sources := \
49+
chipset.cc \
50+
chipset_intel_ich8.cc \
51+
chipset_intel_ich9.cc \
52+
chipset_intel_ich10.cc \
53+
chipset_intel_6_series.cc \
54+
chipset_intel_7_series.cc \
55+
chipset_intel_8_series.cc \
56+
chipset_intel_9_series.cc \
57+
pawn.cc \
58+
pci.cc \
59+
physical_memory.cc
60+
pawn_obj := $(addprefix $(build_dir)/,$(pawn_sources:.cc=.o))
61+
62+
all: pawn
63+
64+
help:
65+
@echo 'Make targets:'
66+
@echo ' clean Remove object files'
67+
@echo ' distclean Remove all build artifacts'
68+
@echo ' pawn BIOS/firmware dumping tool'
69+
@echo
70+
@echo 'Feature flags:'
71+
@echo ' DEBUG Build with debug symbols'
72+
@echo
73+
74+
clean:
75+
@find "$(build_dir)" -depth -name *.o -delete || true
76+
77+
distclean:
78+
@rm -rf "$(build_dir)"
79+
80+
$(build_dir):
81+
@mkdir -p "$(build_dir)/third_party/zynamics"
82+
@ln -sf "$(this_dir)" "$(build_dir)/third_party/zynamics/pawn"
83+
84+
$(pawn_obj): | $(build_dir)
85+
86+
$(build_dir)/pawn: $(pawn_obj)
87+
@echo " [Link] $@"
88+
@$(CXX) $(pawn_obj) \
89+
$(CXXFLAGS) \
90+
$(LDFLAGS) \
91+
-o$@
92+
93+
pawn: $(build_dir)/pawn
94+
@echo 'Done, you can now run'
95+
@echo ' sudo $<'
96+
97+
# Implicit Rules
98+
$(build_dir)/%.o: %.cc
99+
@echo " [Compile] $@"
100+
@$(CXXCOMPILE) $(CXXFLAGS) -c -o$@ $<
101+
102+
.PHONY: all clean distclean help pawn
103+

‎README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Pawn BIOS Dumping Tool
2+
3+
Copyright 2014-2017 Google Inc.
4+
5+
Disclaimer: This is not an official Google product (experimental or otherwise),
6+
it is just code that happens to be owned by Google.
7+
8+
## What is it?
9+
10+
Pawn is a tool to extract the BIOS firmware from Intel-based workstations and
11+
laptops.
12+
The name is a play on an internal tool that is also named after a chess piece.
13+
14+
## How to Build
15+
16+
Dependencies:
17+
* Linux (uses /dev/mem)
18+
* GCC 4.6 or later
19+
* GNU Make
20+
21+
To build, just run `make`. The resulting binary can be found in `.build`.
22+
23+
## Usage
24+
25+
The following command will extract the BIOS firmware and save the image to
26+
`bios_image.bin`:
27+
```bash
28+
sudo .build/pawn bios_image.bin
29+
```
30+
31+
You can then use other tools like
32+
[UEFITool](https://github.com/LongSoft/UEFITool) to process the firmware
33+
image further.

0 commit comments

Comments
 (0)