GPIO Module. More...

Collaboration diagram for GPIO Module:

Modules
	GPIO Registers
	GPIO Registers.

	GPIO Addresses
	GPIO Addresses.

	GPIO Pins Constants
	GPIO Pins Constants.

Macros
#define	DEFAULT_PIN_INPUT_TYPE (GPIO_Input_Type_Pull_Down)
	The default input type for the GPIO pins. More...

#define	DEFAULT_PIN_OUTPUT_TYPE (GPIO_Output_Type_Push_Pull)
	The default output type for the GPIO pins. More...

Enumerations
enum	t_GPIO_Ports { GPIO_Ports_A = 0 , GPIO_Ports_B , GPIO_Ports_C , GPIO_Ports_D , GPIO_Ports_E , GPIO_Ports_F , GPIO_Ports_G }
	GPIO Ports. More...

enum	t_GPIO_Pins { GPIO_Pins_0 = 0 , GPIO_Pins_1 , GPIO_Pins_2 , GPIO_Pins_3 , GPIO_Pins_4 , GPIO_Pins_5 , GPIO_Pins_6 , GPIO_Pins_7 , GPIO_Pins_8 , GPIO_Pins_9 , GPIO_Pins_10 , GPIO_Pins_11 , GPIO_Pins_12 , GPIO_Pins_13 , GPIO_Pins_14 , GPIO_Pins_15 }
	GPIO Pins. More...

enum	t_GPIO_Direction { GPIO_Direction_Input = 0 , GPIO_Direction_Output_10MHz , GPIO_Direction_Output_2MHz , GPIO_Direction_Output_50MHz }
	GPIO Direction. More...

enum	t_GPIO_Output_Type { GPIO_Output_Type_Push_Pull = 0 , GPIO_Output_Type_Open_Drain , GPIO_Output_Type_Alternate_Push_Pull , GPIO_Output_Type_Alternate_Open_Drain }
	GPIO Output Type. More...

enum	t_GPIO_Input_Type { GPIO_Input_Type_Analog = 0 , GPIO_Input_Type_Floating , GPIO_Input_Type_Pull_Down , GPIO_Input_Type_Pull_Up }
	GPIO Input Type. More...

enum	t_GPIO_Value { GPIO_Value_Low = 0 , GPIO_Value_High }
	GPIO Pin Value. More...

Functions
void	GPIO_vSetPinDirection (t_GPIO_Ports tPort, t_GPIO_Pins tPin, t_GPIO_Direction tDirection)
	This function is used to set the direction of a GPIO pin. More...

void	GPIO_vSetPinInputType (t_GPIO_Ports tPort, t_GPIO_Pins tPin, t_GPIO_Input_Type tInputType)
	This function is used to set the input type of a GPIO pin. More...

void	GPIO_vSetPinOutputType (t_GPIO_Ports tPort, t_GPIO_Pins tPin, t_GPIO_Output_Type tOutputType)
	This function is used to set the output type of a GPIO pin. More...

void	GPIO_vSetPinValue (t_GPIO_Ports tPort, t_GPIO_Pins tPin, t_GPIO_Value tValue)
	This function is used to set the value of a GPIO pin. More...

t_GPIO_Value	GPIO_tGetPinValue (t_GPIO_Ports tPort, t_GPIO_Pins tPin)
	This function is used to get the value of a GPIO pin. More...

Detailed Description

GPIO Module.

This module contains all the APIs related to the GPIO module

Macro Definition Documentation

◆ DEFAULT_PIN_INPUT_TYPE

#define DEFAULT_PIN_INPUT_TYPE (GPIO_Input_Type_Pull_Down)

#include <MCAL/GPIO/GPIO_config.h>

The default input type for the GPIO pins.

This macro defines the default input type for the GPIO pins

◆ DEFAULT_PIN_OUTPUT_TYPE

#define DEFAULT_PIN_OUTPUT_TYPE (GPIO_Output_Type_Push_Pull)

#include <MCAL/GPIO/GPIO_config.h>

The default output type for the GPIO pins.

This macro defines the default output type for the GPIO pins

Enumeration Type Documentation

◆ t_GPIO_Ports

enum t_GPIO_Ports

#include <MCAL/GPIO/GPIO_interface.h>

GPIO Ports.

This type is used to select a GPIO port

Enumerator
GPIO_Ports_A	GPIO Port A.
GPIO_Ports_B	GPIO Port B.
GPIO_Ports_C	GPIO Port C.
GPIO_Ports_D	GPIO Port D.
GPIO_Ports_E	GPIO Port E.
GPIO_Ports_F	GPIO Port F.
GPIO_Ports_G	GPIO Port G.

{
    GPIO_Ports_A = 0,
    GPIO_Ports_B,
    GPIO_Ports_C,
    GPIO_Ports_D,
    GPIO_Ports_E,
    GPIO_Ports_F,
    GPIO_Ports_G
} t_GPIO_Ports;

◆ t_GPIO_Pins

enum t_GPIO_Pins

#include <MCAL/GPIO/GPIO_interface.h>

GPIO Pins.

This type is used to select a GPIO pin

Enumerator
GPIO_Pins_0	GPIO Pin 0.
GPIO_Pins_1	GPIO Pin 1.
GPIO_Pins_2	GPIO Pin 2.
GPIO_Pins_3	GPIO Pin 3.
GPIO_Pins_4	GPIO Pin 4.
GPIO_Pins_5	GPIO Pin 5.
GPIO_Pins_6	GPIO Pin 6.
GPIO_Pins_7	GPIO Pin 7.
GPIO_Pins_8	GPIO Pin 8.
GPIO_Pins_9	GPIO Pin 9.
GPIO_Pins_10	GPIO Pin 10.
GPIO_Pins_11	GPIO Pin 11.
GPIO_Pins_12	GPIO Pin 12.
GPIO_Pins_13	GPIO Pin 13.
GPIO_Pins_14	GPIO Pin 14.
GPIO_Pins_15	GPIO Pin 15.

{
    GPIO_Pins_0 = 0,
    GPIO_Pins_1,
    GPIO_Pins_2,
    GPIO_Pins_3,
    GPIO_Pins_4,
    GPIO_Pins_5,
    GPIO_Pins_6,
    GPIO_Pins_7,
    GPIO_Pins_8,
    GPIO_Pins_9,
    GPIO_Pins_10,
    GPIO_Pins_11,
    GPIO_Pins_12,
    GPIO_Pins_13,
    GPIO_Pins_14,
    GPIO_Pins_15
} t_GPIO_Pins;

◆ t_GPIO_Direction

enum t_GPIO_Direction

#include <MCAL/GPIO/GPIO_interface.h>

GPIO Direction.

This type is used to select a GPIO pin direction

Enumerator
GPIO_Direction_Input	GPIO Pin Input.
GPIO_Direction_Output_10MHz	GPIO Pin Output with max speed of 10 MHz.
GPIO_Direction_Output_2MHz	GPIO Pin Output with max speed of 2 MHz.
GPIO_Direction_Output_50MHz	GPIO Pin Output with max speed of 50 MHz.

{
    GPIO_Direction_Input = 0,
    GPIO_Direction_Output_10MHz,
    GPIO_Direction_Output_2MHz,
    GPIO_Direction_Output_50MHz
} t_GPIO_Direction;

◆ t_GPIO_Output_Type

enum t_GPIO_Output_Type

#include <MCAL/GPIO/GPIO_interface.h>

GPIO Output Type.

This type is used to select a GPIO pin output type

Enumerator
GPIO_Output_Type_Push_Pull	GPIO Pin Output Type: push-pull.
GPIO_Output_Type_Open_Drain	GPIO Pin Output Type: open-drain.
GPIO_Output_Type_Alternate_Push_Pull	GPIO Pin Output Type: alternate push-pull.
GPIO_Output_Type_Alternate_Open_Drain	GPIO Pin Output Type: alternate open-drain.

{
    GPIO_Output_Type_Push_Pull = 0,
    GPIO_Output_Type_Open_Drain,
    GPIO_Output_Type_Alternate_Push_Pull,
    GPIO_Output_Type_Alternate_Open_Drain
} t_GPIO_Output_Type;

◆ t_GPIO_Input_Type

enum t_GPIO_Input_Type

#include <MCAL/GPIO/GPIO_interface.h>

GPIO Input Type.

This type is used to select a GPIO pin input type

Enumerator
GPIO_Input_Type_Analog	GPIO Pin Input Type: Analog.
GPIO_Input_Type_Floating	GPIO Pin Input Type: Floating.
GPIO_Input_Type_Pull_Down	GPIO Pin Input Type: Pull-Down.
GPIO_Input_Type_Pull_Up	GPIO Pin Input Type: Pull-Up.

{
    GPIO_Input_Type_Analog = 0,
    GPIO_Input_Type_Floating,
    GPIO_Input_Type_Pull_Down,
    GPIO_Input_Type_Pull_Up
} t_GPIO_Input_Type;

◆ t_GPIO_Value

enum t_GPIO_Value

#include <MCAL/GPIO/GPIO_interface.h>

GPIO Pin Value.

This type is used to select a GPIO pin value

Enumerator
GPIO_Value_Low	GPIO Pin Value: LOW (0)
GPIO_Value_High	GPIO Pin Value: HIGH (1)

{
    GPIO_Value_Low = 0,
    GPIO_Value_High
} t_GPIO_Value;

Function Documentation

◆ GPIO_vSetPinDirection()

void GPIO_vSetPinDirection	(	t_GPIO_Ports	tPort,
		t_GPIO_Pins	tPin,
		t_GPIO_Direction	tDirection
	)

#include <MCAL/GPIO/GPIO_interface.h>

This function is used to set the direction of a GPIO pin.

This function is used to set the direction of a GPIO pin

Parameters

[in]	tPort	The GPIO port
[in]	tPin	The GPIO pin
[in]	tDirection	The GPIO pin direction

See also: t_GPIO_Ports t_GPIO_Pins t_GPIO_Direction

{
    /* Get the pin span (the number of bits to shift to reach the target pin mode and configuration bits) */
    t_u8 u8PinSpan = GPIO_vGetPinSpan(tPin);
    /* Store the base address of the GPIO port */
    P2VAR(t_GPIOx_RegisterMap)
    pu32PortBaseAddress = (P2VAR(t_GPIOx_RegisterMap))NULL;
    /* Store the pin mode and configuration bits of the pin */
    P2VAR(t_u32)
    pu32TargetPinModeConfig = (P2VAR(t_u32))NULL;
 
    /* Get the base address of the GPIO port */
    GPIO_vGetPortAddress(tPort, &pu32PortBaseAddress);
    /* Get the pin mode and configuration bits of the pin */
    pu32TargetPinModeConfig = IS_PIN_IN_LOW_REGISTER(tPin) ? &pu32PortBaseAddress->CRL : &pu32PortBaseAddress->CRH;
    /* Set the mode and configuration bits of the pin */
    *pu32TargetPinModeConfig = (*pu32TargetPinModeConfig & PIN_RESET_MASK(u8PinSpan)) | (tDirection << u8PinSpan);
 
    /* Set the pull-up/pull-down resistor */
    if (tDirection == GPIO_Direction_Input)
    {
        GPIO_vSetPinInputType(tPort, tPin, DEFAULT_PIN_INPUT_TYPE);
    }
    else
    {
        GPIO_vSetPinOutputType(tPort, tPin, DEFAULT_PIN_OUTPUT_TYPE);
    }
}

References DEFAULT_PIN_INPUT_TYPE, DEFAULT_PIN_OUTPUT_TYPE, GPIO_Direction_Input, GPIO_vGetPinSpan(), GPIO_vGetPortAddress(), GPIO_vSetPinInputType(), GPIO_vSetPinOutputType(), IS_PIN_IN_LOW_REGISTER, NULL, P2VAR, and PIN_RESET_MASK.

Referenced by vTestApp_TestingGPIO_main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GPIO_vSetPinInputType()

void GPIO_vSetPinInputType	(	t_GPIO_Ports	tPort,
		t_GPIO_Pins	tPin,
		t_GPIO_Input_Type	tInputType
	)

#include <MCAL/GPIO/GPIO_interface.h>

This function is used to set the input type of a GPIO pin.

This function is used to set the input type of a GPIO pin

Parameters

[in]	tPort	The GPIO port
[in]	tPin	The GPIO pin
[in]	tInputType	The GPIO pin input type

See also: t_GPIO_Ports t_GPIO_Pins t_GPIO_Input_Type

{
    /* Get the pin span (the number of bits to shift to reach the target pin mode and configuration bits) */
    t_u8 u8PinSpan = GPIO_vGetPinSpan(tPin);
    /* Check if the input type is pull-up or pull-down */
    t_GPIO_Input_Type u8PinInputTypeModeConfigurations = (tInputType == GPIO_Input_Type_Pull_Up) ? GPIO_Input_Type_Pull_Down : tInputType;
    /* Store the base address of the GPIO port */
    P2VAR(t_GPIOx_RegisterMap)
    pu32PortBaseAddress = (P2VAR(t_GPIOx_RegisterMap))NULL;
    /* Store the pin mode and configuration bits of the pin */
    P2VAR(t_u32)
    pu32TargetPinModeConfig = (P2VAR(t_u32))NULL;
 
    /* Get the base address of the GPIO port */
    GPIO_vGetPortAddress(tPort, &pu32PortBaseAddress);
    /* Get the pin mode and configuration bits of the pin */
    pu32TargetPinModeConfig = IS_PIN_IN_LOW_REGISTER(tPin) ? &pu32PortBaseAddress->CRL : &pu32PortBaseAddress->CRH;
    /* Set the mode and configuration bits of the pin */
    *pu32TargetPinModeConfig = (*pu32TargetPinModeConfig & PIN_RESET_CONFIGURATIONS_MASK(u8PinSpan)) | (u8PinInputTypeModeConfigurations << (u8PinSpan + PIN_CONFIGURATION_BITS_SHIFT_VALUE));
    /* Set the pull-up/pull-down resistor */
    GPIO_vSetPinInputTypePullUpDown(pu32PortBaseAddress, tPin, tInputType);
}

References GPIO_Input_Type_Pull_Down, GPIO_Input_Type_Pull_Up, GPIO_vGetPinSpan(), GPIO_vGetPortAddress(), GPIO_vSetPinInputTypePullUpDown(), IS_PIN_IN_LOW_REGISTER, NULL, P2VAR, PIN_CONFIGURATION_BITS_SHIFT_VALUE, and PIN_RESET_CONFIGURATIONS_MASK.

Referenced by GPIO_vSetPinDirection(), and vTestApp_TestingGPIO_main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GPIO_vSetPinOutputType()

void GPIO_vSetPinOutputType	(	t_GPIO_Ports	tPort,
		t_GPIO_Pins	tPin,
		t_GPIO_Output_Type	tOutputType
	)

#include <MCAL/GPIO/GPIO_interface.h>

This function is used to set the output type of a GPIO pin.

This function is used to set the output type of a GPIO pin

Parameters

[in]	tPort	The GPIO port
[in]	tPin	The GPIO pin
[in]	tOutputType	The GPIO pin output type

See also: t_GPIO_Ports t_GPIO_Pins t_GPIO_Output_Type

{
    /* Get the pin span (the number of bits to shift to reach the target pin mode and configuration bits) */
    t_u8 u8PinSpan = GPIO_vGetPinSpan(tPin);
    /* Store the base address of the GPIO port */
    P2VAR(t_GPIOx_RegisterMap)
    pu32PortBaseAddress = (P2VAR(t_GPIOx_RegisterMap))NULL;
    /* Store the pin mode and configuration bits of the pin */
    P2VAR(t_u32)
    pu32TargetPinModeConfig = (P2VAR(t_u32))NULL;
 
    /* Get the base address of the GPIO port */
    GPIO_vGetPortAddress(tPort, &pu32PortBaseAddress);
    /* Get the pin mode and configuration bits of the pin */
    pu32TargetPinModeConfig = IS_PIN_IN_LOW_REGISTER(tPin) ? &pu32PortBaseAddress->CRL : &pu32PortBaseAddress->CRH;
    /* Set the mode and configuration bits of the pin */
    *pu32TargetPinModeConfig = (*pu32TargetPinModeConfig & PIN_RESET_CONFIGURATIONS_MASK(u8PinSpan)) | (t_u32)(tOutputType << (u8PinSpan + PIN_CONFIGURATION_BITS_SHIFT_VALUE));
}

References GPIO_vGetPinSpan(), GPIO_vGetPortAddress(), IS_PIN_IN_LOW_REGISTER, NULL, P2VAR, PIN_CONFIGURATION_BITS_SHIFT_VALUE, and PIN_RESET_CONFIGURATIONS_MASK.

Referenced by GPIO_vSetPinDirection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GPIO_vSetPinValue()

void GPIO_vSetPinValue	(	t_GPIO_Ports	tPort,
		t_GPIO_Pins	tPin,
		t_GPIO_Value	tValue
	)

#include <MCAL/GPIO/GPIO_interface.h>

This function is used to set the value of a GPIO pin.

This function is used to set the value of a GPIO pin

Parameters

[in]	tPort	The GPIO port
[in]	tPin	The GPIO pin
[in]	tValue	The GPIO pin value

See also: t_GPIO_Ports t_GPIO_Pins t_GPIO_Value

{
    /* Get the pin location (the number of bits to shift to reach the target pin) */
    t_u32 u32PinLocation = tPin;
    /* Store the base address of the GPIO port */
    P2VAR(t_GPIOx_RegisterMap)
    pu32PortBaseAddress = (P2VAR(t_GPIOx_RegisterMap))NULL;
 
    /* Get the base address of the GPIO port */
    GPIO_vGetPortAddress(tPort, &pu32PortBaseAddress);
 
    if (tValue == GPIO_Value_Low)
    {
        u32PinLocation += PIN_RESET_SHIFT_VALUE;
    }
    else
    {
        /* Do nothing */
    }
 
    /* Set the value of the pin */
    pu32PortBaseAddress->BSRR = (t_u32)(TRUE << u32PinLocation);
}

References GPIO_Value_Low, GPIO_vGetPortAddress(), NULL, P2VAR, PIN_RESET_SHIFT_VALUE, and TRUE.

Referenced by vTestApp_TestingGPIO_main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GPIO_tGetPinValue()

t_GPIO_Value GPIO_tGetPinValue	(	t_GPIO_Ports	tPort,
		t_GPIO_Pins	tPin
	)

#include <MCAL/GPIO/GPIO_interface.h>

This function is used to get the value of a GPIO pin.

This function is used to get the value of a GPIO pin

Parameters

[in]	tPort	The GPIO port
[in]	tPin	The GPIO pin

Returns: The GPIO pin value

See also: t_GPIO_Ports t_GPIO_Pins t_GPIO_Value

{
    /* Store the base address of the GPIO port */
    P2VAR(t_GPIOx_RegisterMap)
    pu32PortBaseAddress = (P2VAR(t_GPIOx_RegisterMap))NULL;
 
    /* Get the base address of the GPIO port */
    GPIO_vGetPortAddress(tPort, &pu32PortBaseAddress);
 
    /* Get the value of the pin */
    return (t_GPIO_Value)((pu32PortBaseAddress->IDR >> tPin) & TRUE);
}

References GPIO_vGetPortAddress(), NULL, P2VAR, and TRUE.

Referenced by vTestApp_TestingGPIO_main().

Here is the call graph for this function:

Here is the caller graph for this function:

Modules

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ DEFAULT_PIN_INPUT_TYPE

◆ DEFAULT_PIN_OUTPUT_TYPE

Enumeration Type Documentation

◆ t_GPIO_Ports

◆ t_GPIO_Pins

◆ t_GPIO_Direction

◆ t_GPIO_Output_Type

◆ t_GPIO_Input_Type

◆ t_GPIO_Value

Function Documentation

◆ GPIO_vSetPinDirection()

◆ GPIO_vSetPinInputType()

◆ GPIO_vSetPinOutputType()

◆ GPIO_vSetPinValue()

◆ GPIO_tGetPinValue()