usb_cables: minor, add doc

This commit is contained in:
King Kévin 2019-12-09 19:45:03 +01:00
parent 4262e90792
commit f7dce91bb8
1 changed files with 8 additions and 7 deletions

View File

@ -18,14 +18,15 @@
* @date 2019
*/
/** the USB pin type */
enum usb_pin_type_t {
USB_PIN_TYPE_UNKNOWN,
USB_PIN_TYPE_GROUND,
USB_PIN_TYPE_POWER,
USB_PIN_TYPE_SHIELD,
USB_PIN_TYPE_DIFFERENTIAL,
USB_PIN_TYPE_IDENTIFICATION,
USB_PIN_TYPE_OTHER,
USB_PIN_TYPE_UNDEFINED, /*< the default type, undefined */
USB_PIN_TYPE_GROUND, /*< ground (including ground drain) */
USB_PIN_TYPE_POWER, /*< power (VBUS) */
USB_PIN_TYPE_SHIELD, /*< shield */
USB_PIN_TYPE_DIFFERENTIAL, /*< differential data pairs (D+/-, SSTX+/-, SSRX+/-) */
USB_PIN_TYPE_IDENTIFICATION, /*< pin to identify type (often connected to power or ground through resistor) */
USB_PIN_TYPE_OTHER, /*< any other type */
};
/** the type of connection between two pins