Skip to content

Commit 873236d

Browse files
cfernaldcfernald
committed
Add initial repo files and workflow
1 parent c3dd1f8 commit 873236d

File tree

6 files changed

+364
-0
lines changed

6 files changed

+364
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: 🐛 Bug Report
2+
description: File a bug report
3+
title: "[Bug]: <title>"
4+
labels: ["type:bug", "state:needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
👋 Thanks for taking the time to fill out this bug report!
11+
12+
- type: checkboxes
13+
attributes:
14+
label: Is there an existing issue for this?
15+
description: Please search to see if an issue already exists for the bug you encountered.
16+
options:
17+
- label: I have searched existing issues
18+
required: true
19+
20+
- type: textarea
21+
id: current_behavior
22+
attributes:
23+
label: Current Behavior
24+
description: A concise description of the bug that you're experiencing.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: expected_behavior
30+
attributes:
31+
label: Expected Behavior
32+
description: A concise description of what you expected to happen.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: steps_to_reproduce
38+
attributes:
39+
label: Steps To Reproduce
40+
description: Steps to reproduce the behavior.
41+
placeholder: |
42+
<example>
43+
1. In this environment...
44+
2. With this config...
45+
3. Setup tool...
46+
validations:
47+
required: true
48+
49+
- type: markdown
50+
attributes:
51+
value: |
52+
**Urgency Key**
53+
- 🟢 **Low**
54+
- A minor change with little to no important functional impact
55+
- It is not important to fix this in a specific time frame
56+
- 🟡 **Medium**
57+
- An important change with a functional impact
58+
- Will be prioritized above *low* issues in the normal course of development
59+
- 🔥 **High**
60+
- A critical change that has a significant functional impact
61+
- Must be fixed immediately
62+
63+
- type: dropdown
64+
id: urgency
65+
attributes:
66+
label: Urgency
67+
description: How urgent is it to fix this bug?
68+
multiple: false
69+
options:
70+
- Low
71+
- Medium
72+
- High
73+
validations:
74+
required: true
75+
76+
- type: dropdown
77+
id: fix_owner
78+
attributes:
79+
label: Are you going to fix this?
80+
description: Indicate if you are going to fix this or requesting someone else fix it.
81+
multiple: false
82+
options:
83+
- I will fix it
84+
- Someone else needs to fix it
85+
validations:
86+
required: true
87+
88+
- type: dropdown
89+
id: needs_maintainer_feedback
90+
attributes:
91+
label: Do you need maintainer feedback?
92+
description: Indicate if you would like a maintainer to provide feedback on this submission.
93+
multiple: false
94+
options:
95+
- No maintainer feedback needed
96+
- Maintainer feedback requested
97+
validations:
98+
required: true
99+
100+
- type: textarea
101+
id: anything_else
102+
attributes:
103+
label: Anything else?
104+
description: |
105+
Links? References? Anything that will give us more context about the issue you are encountering.
106+
107+
Serial debug logs and/or debugger logs are especially helpful!
108+
109+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
110+
validations:
111+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: 🚀 Feature Request
2+
description: Request a feature change
3+
title: "[Feature]: <title>"
4+
labels: ["type:feature-request", "state:needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
👋 Thanks for taking the time to help us improve our features!
11+
12+
- type: textarea
13+
id: feature_overview
14+
attributes:
15+
label: Feature Overview
16+
description: Provide a high-level summary of your feature request.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution_overview
22+
attributes:
23+
label: Solution Overview
24+
description: Give a clear and concise description of what you want to happen.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: alternatives_considered
30+
attributes:
31+
label: Alternatives Considered
32+
description: Describe alternatives you've considered.
33+
validations:
34+
required: false
35+
36+
- type: markdown
37+
attributes:
38+
value: |
39+
**Urgency Key**
40+
- 🟢 **Low**
41+
- A minor enhancement
42+
- It is not important to address this request in a specific time frame
43+
- 🟡 **Medium**
44+
- An important enhancement
45+
- Will be prioritized above *low* requests in the normal course of development
46+
- 🔥 **High**
47+
- A critical enhancement with significant value
48+
- Should be prioritized above *low* and *medium* requests
49+
50+
- type: dropdown
51+
id: urgency
52+
attributes:
53+
label: Urgency
54+
description: How urgent is it to resolve this feature request?
55+
multiple: false
56+
options:
57+
- Low
58+
- Medium
59+
- High
60+
validations:
61+
required: true
62+
63+
- type: dropdown
64+
id: request_owner
65+
attributes:
66+
label: Are you going to implement the feature request?
67+
description: Indicate if you are going to do the work to close this feature request.
68+
multiple: false
69+
options:
70+
- I will implement the feature
71+
- Someone else needs to implement the feature
72+
validations:
73+
required: true
74+
75+
- type: dropdown
76+
id: needs_maintainer_feedback
77+
attributes:
78+
label: Do you need maintainer feedback?
79+
description: Indicate if you would like a maintainer to provide feedback on this submission.
80+
multiple: false
81+
options:
82+
- No maintainer feedback needed
83+
- Maintainer feedback requested
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
id: anything_else
89+
attributes:
90+
label: Anything else?
91+
description: |
92+
Links? References? Anything that will give us more context about the feature you are requesting.
93+
94+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
95+
validations:
96+
required: false

‎.github/workflows/Build-UefiExt.yaml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#
2+
# GitHub Action Workflow for building the UEFI debugger extension.
3+
#
4+
# Copyright (c) Microsoft Corporation
5+
#
6+
# SPDX-License-Identifier: BSD-2-Clause-Patent
7+
#
8+
9+
name: "Build UEFI Debug Extension"
10+
11+
on:
12+
workflow_dispatch:
13+
push:
14+
branches: [ main ]
15+
paths:
16+
- 'UefiDbgExt/**'
17+
pull_request:
18+
branches: [ main ]
19+
paths:
20+
- 'UefiDbgExt/**'
21+
release:
22+
types: [published]
23+
24+
jobs:
25+
build:
26+
strategy:
27+
fail-fast: false
28+
matrix:
29+
configuration: [Debug, Release]
30+
platform: [x64, arm64]
31+
runs-on: windows-2022
32+
permissions:
33+
contents: write
34+
steps:
35+
- name: Check out repository code
36+
uses: actions/checkout@v4
37+
38+
- name: Setup MsBuild
39+
uses: microsoft/setup-msbuild@v2
40+
41+
- name: Build
42+
run: msbuild UefiDbgExt\uefiext.vcxproj -property:Configuration=${{ matrix.configuration }} -property:Platform=${{ matrix.platform }}
43+
44+
- name: Publish Binary
45+
if: ${{ matrix.configuration == 'Release' && github.event_name != 'pull_request' }}
46+
uses: actions/upload-artifact@v4
47+
with:
48+
name: UefiDbgExt-${{ matrix.platform }}-${{ matrix.configuration }}
49+
path: UefiDbgExt\${{ matrix.platform }}\${{ matrix.configuration }}\uefiext.dll
50+
51+
- name: Publish Release Asset
52+
if: ${{ matrix.configuration == 'Release' && github.event_name == 'release' }}
53+
env:
54+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
55+
run: |
56+
Compress-Archive -Path UefiDbgExt\${{ matrix.platform }}\${{ matrix.configuration }}\uefiext.dll -DestinationPath UefiExt_${{ matrix.platform }}.zip
57+
gh release upload ${{ github.event.release.tag_name }} UefiExt_${{ matrix.platform }}.zip

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.vscode/
2+
3+
# UEFI Ext Build
4+
UefiDbgExt/uefiext/
5+
UefiDbgExt/x64/
6+
UefiDbgExt/ARM64/
7+
UefiDbgExt/.vs/
8+
UefiDbgExt/uefiext.vcxproj.user

‎LICENSE.txt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
SPDX-License-Identifier: BSD-2-Clause-Patent
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice,
9+
this list of conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
Subject to the terms and conditions of this license, each copyright holder
16+
and contributor hereby grants to those receiving rights under this license
17+
a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
18+
(except for failure to satisfy the conditions of this license) patent
19+
license to make, have made, use, offer to sell, sell, import, and otherwise
20+
transfer this software, where such license applies only to those patent
21+
claims, already acquired or hereafter acquired, licensable by such copyright
22+
holder or contributor that are necessarily infringed by:
23+
24+
(a) their Contribution(s) (the licensed copyrights of copyright holders and
25+
non-copyrightable additions of contributors, in source or binary form)
26+
alone; or
27+
28+
(b) combination of their Contribution(s) with the work of authorship to
29+
which such Contribution(s) was added by such copyright holder or
30+
contributor, if, at the time the Contribution is added, such addition
31+
causes such combination to be necessarily infringed. The patent license
32+
shall not apply to any other combinations which include the
33+
Contribution.
34+
35+
Except as expressly stated above, no rights or licenses from any copyright
36+
holder or contributor is granted under this license, whether expressly, by
37+
implication, estoppel or otherwise.
38+
39+
DISCLAIMER
40+
41+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
42+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
45+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
46+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
47+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
48+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
49+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
51+
POSSIBILITY OF SUCH DAMAGE.

‎readme.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# UEFI Debug Tools
2+
3+
This repository contains tools to support debugging UEFI firmware. The tools are
4+
intended to support many implementations, tool chains, and operating systems. As
5+
such, this repo is not strictly associated with any specific UEFI project or work
6+
environment and may contain specifics for many different projects.
7+
8+
## UEFI Windbg Extension
9+
10+
The UEFI Windbg Extension is a plugin to add support for the UEFI firmware context.
11+
See the [UEFI Extension Readme](UefiDbgExt/readme.md) for more details.
12+
13+
## Scripts
14+
15+
This repo also includes some scripts that can be useful in UEFI firmware debugging.
16+
17+
[ComToTcpServer](Scripts/ComToTcpServer.py) - Allows forwarding between a serial
18+
port (COM) and a TCP port on Windows. This is useful for connection Windbg to a serial
19+
based GDB remote.
20+
21+
## Issues
22+
23+
For bugs or feature requests, please [file a github issue](https://github.com/microsoft/uefi_debug_tools/issues/new/choose)
24+
with a detailed summary of the problem or requested functionality.
25+
26+
For security issues, please see [the security file](SECURITY.md).
27+
28+
## Contributing
29+
30+
Contributions and suggestions are welcome. Most contributions will require you to
31+
agree to the Contributor License Agreement (CLA) declaring you have the right to,
32+
and actually do, grant us the rights to use your contribution. For details, visit
33+
[Microsoft CLA](https://cla.microsoft.com).
34+
35+
All interactions must comply with the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
36+
37+
## Copyright & License
38+
39+
Copyright (c) Microsoft Corporation.
40+
41+
SPDX-License-Identifier: BSD-2-Clause-Patent

0 commit comments

Comments
 (0)