Skip to content

Commit

Permalink
fix(PeriphDrivers): Clarify GPIO drive strength enum documentation (#986
Browse files Browse the repository at this point in the history 
)
  • Loading branch information
@sihyung-maxim
sihyung-maxim authored Apr 15, 2024
1 parent 0665fe0 commit a96ccc6
Show file tree
Hide file tree
Showing 15 changed files with 274 additions and 64 deletions.
22 changes: 18 additions & 4 deletions Libraries/PeriphDrivers/Include/MAX32520/gpio.h
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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

0 comments on commit a96ccc6

Please sign in to comment.