diff --git a/usb_cables.c b/usb_cables.c index 697c500..d191bbc 100644 --- a/usb_cables.c +++ b/usb_cables.c @@ -4636,7 +4636,7 @@ uint8_t usb_cables_test_pins(const struct usb_pin_t* pin1, const struct usb_pin_ return connection; } -void usb_cables_check_ground(const struct usb_connector_t** connectors, uint8_t connectors_nb, bool* connected) +void usb_cables_test_ground(const struct usb_connector_t** connectors, uint8_t connectors_nb, bool* connected) { // verify input arguments if (NULL == connectors || 0 == connectors_nb) { diff --git a/usb_cables.h b/usb_cables.h index a6e034b..0fd9f18 100644 --- a/usb_cables.h +++ b/usb_cables.h @@ -94,15 +94,14 @@ const struct usb_connector_t* usb_cables_get_connector(uint8_t pin); * @note setting both levels (high, low) in both directions (pin1 to pin2 and pin2 to pin1) are tested, except for ground pins */ uint8_t usb_cables_test_pins(const struct usb_pin_t* pin1, const struct usb_pin_t* pin2); -/** check connectors for connections between ground pins of the connectors - * @param[in] connectors connectors to check +/** test connectors for connections between ground pins of the connectors + * @param[in] connectors connectors to test * @param[in] connectors_nb numbers of connectors * @param[out] connected which of the connectors are connected (NULL to just print the connections) - * @note connection between pin on the same connector are not checked - * @note this is faster than usb_cables_check_inter but only checks the ground pin + * @note connection between pin on the same connector are not tested * @note it assumes all grounds are connected (e.g. only one cable is connected) */ -void usb_cables_check_ground(const struct usb_connector_t** connectors, uint8_t connectors_nb, bool* connected); +void usb_cables_test_ground(const struct usb_connector_t** connectors, uint8_t connectors_nb, bool* connected); /** test if there is a load on the connector * @param[in] connector connector to test * @return if there is a load on the connector