Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(PeriphDrivers): Clarify GPIO drive strength enum documentation #986

Merged
merged 1 commit into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32520/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, ///< Drive Strength 0
MXC_GPIO_DRVSTR_1, ///< Drive Strength 1
MXC_GPIO_DRVSTR_2, ///< Drive Strength 2
MXC_GPIO_DRVSTR_3, ///< Drive Strength 3
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32570/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, ///< Drive Strength 0
MXC_GPIO_DRVSTR_1, ///< Drive Strength 1
MXC_GPIO_DRVSTR_2, ///< Drive Strength 2
MXC_GPIO_DRVSTR_3, ///< Drive Strength 3
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32572/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, ///< Drive Strength 0
MXC_GPIO_DRVSTR_1, ///< Drive Strength 1
MXC_GPIO_DRVSTR_2, ///< Drive Strength 2
MXC_GPIO_DRVSTR_3, ///< Drive Strength 3
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
24 changes: 19 additions & 5 deletions Libraries/PeriphDrivers/Include/MAX32650/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,27 @@ typedef enum {
} mxc_gpio_vssel_t;

/**
* @brief Enumeration type for drive strength configuration.
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, /**< Drive Strength 0 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength 1 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength 2 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength 3 */
MXC_GPIO_DRVSTR_0, /**< Drive Strength GPIO_DS[2][pin]=0b00 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength GPIO_DS[2][pin]=0b01 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength GPIO_DS[2][pin]=0b10 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength GPIO_DS[2][pin]=0b11 */
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32655/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, /**< Drive Strength 0 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength 1 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength 2 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength 3 */
MXC_GPIO_DRVSTR_0, /**< Drive Strength GPIO_DS[2][pin]=0b00 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength GPIO_DS[2][pin]=0b01 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength GPIO_DS[2][pin]=0b10 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength GPIO_DS[2][pin]=0b11 */
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32660/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, ///< Drive Strength 0
MXC_GPIO_DRVSTR_1, ///< Drive Strength 1
MXC_GPIO_DRVSTR_2, ///< Drive Strength 2
MXC_GPIO_DRVSTR_3, ///< Drive Strength 3
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32662/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -125,12 +125,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, /**< Drive Strength 0 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength 1 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength 2 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength 3 */
MXC_GPIO_DRVSTR_0, /**< Drive Strength GPIO_DS[2][pin]=0b00 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength GPIO_DS[2][pin]=0b01 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength GPIO_DS[2][pin]=0b10 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength GPIO_DS[2][pin]=0b11 */
} mxc_gpio_drvstr_t;

/**
Expand Down
24 changes: 19 additions & 5 deletions Libraries/PeriphDrivers/Include/MAX32665/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,27 @@ typedef enum {
} mxc_gpio_vssel_t;

/**
* @brief Enumeration type for drive strength configuration.
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, /**< Drive Strength 0 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength 1 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength 2 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength 3 */
MXC_GPIO_DRVSTR_0, /**< Drive Strength GPIO_DS[2][pin]=0b00 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength GPIO_DS[2][pin]=0b01 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength GPIO_DS[2][pin]=0b10 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength GPIO_DS[2][pin]=0b11 */
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32670/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, ///< Drive Strength 0
MXC_GPIO_DRVSTR_1, ///< Drive Strength 1
MXC_GPIO_DRVSTR_2, ///< Drive Strength 2
MXC_GPIO_DRVSTR_3, ///< Drive Strength 3
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32672/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, ///< Drive Strength 0
MXC_GPIO_DRVSTR_1, ///< Drive Strength 1
MXC_GPIO_DRVSTR_2, ///< Drive Strength 2
MXC_GPIO_DRVSTR_3, ///< Drive Strength 3
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
24 changes: 19 additions & 5 deletions Libraries/PeriphDrivers/Include/MAX32675/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,27 @@ typedef enum {
} mxc_gpio_vssel_t;

/**
* @brief Enumeration type for the voltage level on a given pin.
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, ///< Drive Strength 0
MXC_GPIO_DRVSTR_1, ///< Drive Strength 1
MXC_GPIO_DRVSTR_2, ///< Drive Strength 2
MXC_GPIO_DRVSTR_3, ///< Drive Strength 3
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32680/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,26 @@ typedef enum {

/**
* @brief Enumeration type for drive strength on a given pin.
* This represents what the two GPIO_DS[2] (Drive Strength)
* registers are set to for a given GPIO pin; NOT the
* drive strength level.
*
* For example:
* MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1
* MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0
* MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1
*
* Refer to the user guide and datasheet to select the
* appropriate drive strength. Note: the drive strength values
* are not linear, and can vary from pin-to-pin and the state
* of the GPIO pin (alternate function and voltage level).
*/
typedef enum {
MXC_GPIO_DRVSTR_0, /**< Drive Strength 0 */
MXC_GPIO_DRVSTR_1, /**< Drive Strength 1 */
MXC_GPIO_DRVSTR_2, /**< Drive Strength 2 */
MXC_GPIO_DRVSTR_3, /**< Drive Strength 3 */
MXC_GPIO_DRVSTR_0, ///< Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1, ///< Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2, ///< Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3, ///< Drive Strength GPIO_DS[2][pin]=0b11
} mxc_gpio_drvstr_t;

/**
Expand Down
Loading
Loading