tr_hal_gpio.h

Go to the documentation of this file.

 
#ifndef TR_HAL_GPIO_H_
#define TR_HAL_GPIO_H_
 
#include "tr_hal_platform.h"
 
 
// ****************************************************************************
// GPIO Driver API functions
// ****************************************************************************

 
 
// ***************************************************************************
// ---- init, uninit, read back settings, read input ----
// ***************************************************************************
 

tr_hal_status_t tr_hal_gpio_init(tr_hal_gpio_pin_t       pin,
                                 tr_hal_gpio_settings_t* gpio_settings);

tr_hal_status_t tr_hal_gpio_uninit(tr_hal_gpio_pin_t pin);

tr_hal_status_t tr_hal_gpio_read_settings(tr_hal_gpio_pin_t       pin,
                                          tr_hal_gpio_settings_t* gpio_settings);

tr_hal_status_t tr_hal_gpio_read_input(tr_hal_gpio_pin_t pin,
                                       tr_hal_level_t* read_value);
 
 
// ***************************************************************************
//  ---- is pin available, are pins equal ----
// ***************************************************************************

bool tr_hal_gpio_is_available(tr_hal_gpio_pin_t pin);

bool tr_hal_gpio_are_pins_equal(tr_hal_gpio_pin_t pin1,
                                tr_hal_gpio_pin_t pin2);
 
 
// ***************************************************************************
// ---- APIs used by HAL modules to ensure GPIOs are only used by 1 module ----
// ***************************************************************************

tr_hal_status_t tr_hal_gpio_mgr_reserve_gpio(tr_hal_gpio_pin_t pin,
                                             tr_hal_status_t   new_setting);

tr_hal_status_t tr_hal_gpio_mgr_check_gpio(tr_hal_gpio_pin_t pin);

tr_hal_status_t tr_hal_gpio_mgr_release_gpio(tr_hal_gpio_pin_t pin);
 
 
// ***************************************************************************
// ---- setting/getting direction, output state ----
// ***************************************************************************
 
// do not need these if use the settings struct and the init function
 
tr_hal_status_t tr_hal_gpio_set_direction(tr_hal_gpio_pin_t pin,
                                          tr_hal_direction_t direction);
 
tr_hal_status_t tr_hal_gpio_get_direction(tr_hal_gpio_pin_t pin,
                                          tr_hal_direction_t* direction);
 
tr_hal_status_t tr_hal_gpio_set_output(tr_hal_gpio_pin_t pin,
                                       tr_hal_level_t level);
 
tr_hal_status_t tr_hal_gpio_get_output(tr_hal_gpio_pin_t pin,
                                       tr_hal_level_t* level);
 
tr_hal_status_t tr_hal_gpio_toggle_output(tr_hal_gpio_pin_t pin);
 
 
// ***************************************************************************
// ---- setting interrupt trigger/priority/callback ----
// ***************************************************************************
 
// do not need these if use the settings struct and the init function
 
tr_hal_status_t tr_hal_gpio_set_interrupt_trigger(tr_hal_gpio_pin_t pin,
                                                  tr_hal_trigger_t trigger);
 
tr_hal_status_t tr_hal_gpio_get_interrupt_trigger(tr_hal_gpio_pin_t pin,
                                                  tr_hal_trigger_t* trigger);
 
tr_hal_status_t tr_hal_gpio_set_interrupt_priority(tr_hal_int_pri_t new_interrupt_priority);
 
tr_hal_status_t tr_hal_gpio_get_interrupt_priority(tr_hal_int_pri_t* interrupt_priority);
 
tr_hal_status_t tr_hal_gpio_set_interrupt_callback(tr_hal_gpio_pin_t            pin,
                                                   tr_hal_gpio_event_callback_t callback_function);
 
tr_hal_status_t tr_hal_gpio_get_interrupt_callback(tr_hal_gpio_pin_t             pin,
                                                   tr_hal_gpio_event_callback_t* callback_function);
 
 
// ***************************************************************************
// ---- setting/getting open drain and pull mode ----
// ***************************************************************************
 
// do not need these if use the settings struct and the init function
 
tr_hal_status_t tr_hal_gpio_set_open_drain(tr_hal_gpio_pin_t pin,
                                           bool              enable);
 
tr_hal_status_t tr_hal_gpio_get_open_drain(tr_hal_gpio_pin_t pin,
                                           bool*             drain_enabled);
 
tr_hal_status_t tr_hal_gpio_set_pull_mode(tr_hal_gpio_pin_t pin,
                                          tr_hal_pullopt_t mode);
 
tr_hal_status_t tr_hal_gpio_get_pull_mode(tr_hal_gpio_pin_t pin,
                                          tr_hal_pullopt_t* mode);
 
 
// ***************************************************************************
// ---- setting/getting debounce ----
// ***************************************************************************
 
// do not need these if use the settings struct and the init function
 
tr_hal_status_t tr_hal_gpio_set_debounce(tr_hal_gpio_pin_t pin,
                                         bool              enable);
 
tr_hal_status_t tr_hal_gpio_get_debounce(tr_hal_gpio_pin_t pin,
                                         bool*             debounce_enabled);
 
tr_hal_status_t tr_hal_gpio_set_debounce_time(tr_hal_debounce_time_t new_debounce_time);
 
tr_hal_status_t tr_hal_gpio_get_debounce_time(tr_hal_debounce_time_t* debounce_time);
 
 
// ***************************************************************************
// ---- setting/getting drive strength ----
// ***************************************************************************
 
// do not need these if use the settings struct and the init function
 
tr_hal_status_t tr_hal_gpio_set_drive_strength(tr_hal_gpio_pin_t       pin,
                                               tr_hal_drive_strength_t new_drive_strength);
 
tr_hal_status_t tr_hal_gpio_get_drive_strength(tr_hal_gpio_pin_t        pin,
                                               tr_hal_drive_strength_t* drive_strength);
 
 
// ***************************************************************************
// ---- enable/disable wake on deep sleep ----
// ***************************************************************************
 
// do not need these if use the settings struct and the init function
 
tr_hal_status_t tr_hal_gpio_set_wake_mode(tr_hal_gpio_pin_t  pin,
                                          tr_hal_wake_mode_t wake_mode);
 
tr_hal_status_t tr_hal_gpio_get_wake_mode(tr_hal_gpio_pin_t   pin,
                                          tr_hal_wake_mode_t* wake_mode);
 
// ***************************************************************************
// ---- set/get the pin mode (GPIO, UART, SPI, etc) for this pin ----
// ***************************************************************************
tr_hal_status_t tr_hal_gpio_set_mode(tr_hal_gpio_pin_t pin,
                                     tr_hal_pin_mode_t mode);
 
tr_hal_status_t tr_hal_gpio_get_mode(tr_hal_gpio_pin_t pin,
                                     tr_hal_pin_mode_t* mode);
 
// ***************************************************************************
// ---- print a pin in a debug print ----
// ***************************************************************************
char* tr_hal_gpio_get_string(tr_hal_gpio_pin_t pin);
 

 
 
#endif //TR_HAL_GPIO_H_