|
@@ -2,10 +2,24 @@
|
2
|
2
|
|
3
|
3
|
This is the firmware for the PD Buddy project. Currently, this specifically
|
4
|
4
|
means the [PD Buddy Sink][]. The firmware is currently under heavy development,
|
5
|
|
-but is partially functional.
|
|
5
|
+but is largely functional.
|
6
|
6
|
|
7
|
7
|
[PD Buddy Sink]: https://git.clayhobbs.com/pd-buddy/pd-buddy-sink
|
8
|
8
|
|
|
9
|
+## Features
|
|
10
|
+
|
|
11
|
+* Two boot modes, Setup and Sink, selected by the Setup button's state at
|
|
12
|
+ startup.
|
|
13
|
+* Sink mode Implements a simple USB Power Delivery sink, aiming for full
|
|
14
|
+ compliance with the USB Power Delivery Specification, Revision 2.0,
|
|
15
|
+ Version 1.3.
|
|
16
|
+* Requests the configured voltage and current if available, or a safe, low
|
|
17
|
+ power request otherwise.
|
|
18
|
+* Provides power on the output connector only when an explicit contract is in
|
|
19
|
+ place for the configured voltage and current.
|
|
20
|
+* Setup mode implements a USB CDC-ACM command-line interface allowing
|
|
21
|
+ configuration to be loaded from and stored in flash.
|
|
22
|
+
|
9
|
23
|
## Prerequisites
|
10
|
24
|
|
11
|
25
|
To compile the firmware, you must first install the [GNU ARM Embedded
|