Browse Source

Wrote specification for typec_virtual PDO

Not a real PDO, the typec_virtual PDO will be used to report the
advertised Type-C Current when Power Delivery is not available.
Clara Hobbs 6 years ago
parent
commit
0a7eee5695
1 changed files with 18 additions and 5 deletions
  1. 18
    5
      docs/console_config.md

+ 18
- 5
docs/console_config.md View File

@@ -1,6 +1,6 @@
1 1
 # PD Buddy Sink Serial Console Configuration Interface
2 2
 
3
-Version 1.2.0-dev, 2017-09-09
3
+Version 1.2.0-dev, 2017-09-11
4 4
 
5 5
 The PD Buddy Sink can be put into setup mode by holding the Setup button while
6 6
 plugging it into a computer.  In this mode, the device runs a configuration
@@ -259,10 +259,10 @@ When a list of PDOs is printed, each PDO is numbered with a line as follows:
259 259
 
260 260
     PDO n: type
261 261
 
262
-`n` is the index of the PDO.  `type` is one of `fixed`, or the entire PDO
263
-represented as a 32-bit hexadecimal number if the type is unknown.  If `type`
264
-is not a hexadecimal number, the rest of the PDO is printed as a list of
265
-fields, one per line, each indented by a single ASCII tab character.  Each
262
+`n` is the index of the PDO.  `type` is one of `fixed`, `typec_virtual`, or the
263
+entire PDO represented as a 32-bit hexadecimal number if the type is unknown.
264
+If `type` is not a hexadecimal number, the rest of the PDO is printed as a list
265
+of fields, one per line, each indented by a single ASCII tab character.  Each
266 266
 field is of the format:
267 267
 
268 268
     name: value
@@ -315,6 +315,19 @@ The `i` field holds the value of the PDO's Maximum Current field (B9-0), in
315 315
 amperes.  The field's value is a floating-point decimal number, followed by a
316 316
 space and a capital A.  For example: `2.25 A`.
317 317
 
318
+### Type-C Current Virtual PDO Fields
319
+
320
+This section describes how Type-C Current Virtual PDOs (type `typec_virtual`)
321
+are printed.  These are not actually PDOs sent in a PD Source_Capabilities
322
+message, but merely a convenient way of reporting advertised Type-C Current
323
+when USB Power Delivery is not available.
324
+
325
+#### i
326
+
327
+The `i` field holds the value of the advertised Type-C Current, in amperes.
328
+The field's value is a floating-point decimal number, followed by a space and a
329
+capital A.  For example: `1.50 A`.
330
+
318 331
 ## USB Descriptors
319 332
 
320 333
 The PD Buddy Sink can be identified by the following USB device descriptors:

Loading…
Cancel
Save