TMPM4KxA Group Peripheral Driver User Manual  V1.0.4.0
Functions
GPIO Exported Functions

Functions

TXZ_Result gpio_init (gpio_t *p_obj, uint32_t group)
 Initialize the GPIO object. More...
 
TXZ_Result gpio_deinit (gpio_t *p_obj, uint32_t group)
 Release the GPIO object. More...
 
TXZ_Result gpio_func (gpio_t *p_obj, uint32_t group, uint32_t num, uint32_t func, uint32_t inout)
 Port Function switching. More...
 
TXZ_Result gpio_write_mode (gpio_t *p_obj, uint32_t group, uint32_t mode, uint32_t val)
 Port Mode Write. More...
 
TXZ_Result gpio_read_mode (gpio_t *p_obj, uint32_t group, uint32_t mode, uint32_t *val)
 Port Mode Read. More...
 
TXZ_Result gpio_write_bit (gpio_t *p_obj, uint32_t group, uint32_t num, uint32_t mode, uint32_t val)
 Port Bit Write. More...
 
TXZ_Result gpio_read_bit (gpio_t *p_obj, uint32_t group, uint32_t num, uint32_t mode, gpio_pinstate_t *pinstate)
 Port Bit Read. More...
 

Detailed Description

Function Documentation

◆ gpio_deinit()

TXZ_Result gpio_deinit ( gpio_t p_obj,
uint32_t  group 
)

Release the GPIO object.

Parameters
p_obj:GPIO object.
group:GPIO Port Group.: Use gpio_gr_t
Return values
GPIO_RESULT_SUCCESS:Success.
GPIO_RESULT_FAILURE:Failure.
Note
When p_obj is NULL, "Failure" is returned.
Attention
This function is not available in interrupt.

◆ gpio_func()

TXZ_Result gpio_func ( gpio_t p_obj,
uint32_t  group,
uint32_t  num,
uint32_t  func,
uint32_t  inout 
)

Port Function switching.

Parameters
p_obj:GPIO object.
group:GPIO Port Group. : Use gpio_gr_t
num:GPIO Port Number. : Use gpio_num_t
func:GPIO Portxx Func. : Use gpio_pa0_func_t - gpio_pl4_func_t
inout:GPIO bit Value.: Use gpio_pinstate_t
Return values
GPIO_RESULT_SUCCESS:Success.
GPIO_RESULT_FAILURE:Failure.
Note
When p_obj is NULL, no processing.

◆ gpio_init()

TXZ_Result gpio_init ( gpio_t p_obj,
uint32_t  group 
)

Initialize the GPIO object.

Parameters
p_obj:GPIO object.
group:GPIO Port Group. : Use gpio_gr_t
Return values
GPIO_RESULT_SUCCESS:Success.
GPIO_RESULT_FAILURE:Failure.
Note
When p_obj is NULL, "Failure" is returned.
An initial value of default is set at the reset status value. If needed, please rewrite and use an initial value.
Attention
This function is not available in interrupt.

◆ gpio_read_bit()

TXZ_Result gpio_read_bit ( gpio_t p_obj,
uint32_t  group,
uint32_t  num,
uint32_t  mode,
gpio_pinstate_t pinstate 
)

Port Bit Read.

Parameters
p_obj:GPIO object.
group:GPIO Port Group. : Use gpio_gr_t
num:GPIO Port Number. : Use gpio_num_t
mode:GPIO Port Mode. : Use gpio_mode_t
[out]*pinstate: store Value of GPIO BitPin. : Use gpio_pinstate_t
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, no processing.: Use gpio_pinstate_t

◆ gpio_read_mode()

TXZ_Result gpio_read_mode ( gpio_t p_obj,
uint32_t  group,
uint32_t  mode,
uint32_t *  val 
)

Port Mode Read.

Parameters
[in]p_obj:GPIO object.
[in]group:GPIO Port Group. : Use gpio_gr_t
[in]mode:GPIO Port Mode. : Use gpio_num_t
[out]val:value store address
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
When p_obj is NULL, no processing.

◆ gpio_write_bit()

TXZ_Result gpio_write_bit ( gpio_t p_obj,
uint32_t  group,
uint32_t  num,
uint32_t  mode,
uint32_t  val 
)

Port Bit Write.

Parameters
p_obj:GPIO object.
group:GPIO Port Group. : Use gpio_gr_t
num:GPIO Port Number. : Use gpio_num_t
mode:GPIO Port Mode. : Use gpio_mode_t
val:GPIO Pin Reset/Set. : Use gpio_pinstate_t
Return values
GPIO_RESULT_SUCCESS:Success.
GPIO_RESULT_FAILURE:Failure.
Note
When p_obj is NULL, no processing.

◆ gpio_write_mode()

TXZ_Result gpio_write_mode ( gpio_t p_obj,
uint32_t  group,
uint32_t  mode,
uint32_t  val 
)

Port Mode Write.

Parameters
p_obj:GPIO object.
group:GPIO Port Group. : Use gpio_gr_t
mode:GPIO Port Mode. : Use gpio_num_t
val:value
Return values
GPIO_RESULT_SUCCESS:Success.
GPIO_RESULT_FAILURE:Failure.
Note
When p_obj is NULL, no processing.