hal_gpio.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _HAL_GPIO_H_
#define _HAL_GPIO_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "hal_target.h"
#include "hal_ll_gpio.h"
 
typedef enum
{
    HAL_GPIO_DIGITAL_INPUT = 0, 
    HAL_GPIO_DIGITAL_OUTPUT = 1 
} hal_gpio_direction_t;
 
typedef handle_t hal_gpio_base_t; 
typedef hal_ll_gpio_mask_t hal_gpio_mask_t; 
typedef struct hal_gpio
{
    hal_gpio_base_t base; 
    hal_gpio_mask_t mask; 
} hal_gpio_t;
 
typedef hal_gpio_t hal_gpio_pin_t;  
typedef hal_gpio_t hal_gpio_port_t; 
void hal_gpio_configure_pin( hal_gpio_pin_t *pin, hal_pin_name_t name, hal_gpio_direction_t direction );
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_read_pin_input(_handle) hal_ll_gpio_read_pin_input( (hal_ll_gpio_pin_t *)_handle )
#else
uint8_t hal_gpio_read_pin_input( hal_gpio_pin_t *pin );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_read_pin_output(_handle) hal_ll_gpio_read_pin_output( (hal_ll_gpio_pin_t *)_handle )
#else
uint8_t hal_gpio_read_pin_output( hal_gpio_pin_t *pin );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_write_pin_output(_handle,_value) hal_ll_gpio_write_pin_output( (hal_ll_gpio_pin_t *)_handle, _value )
#else
void hal_gpio_write_pin_output( hal_gpio_pin_t *pin, uint8_t value );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_toggle_pin_output(_handle) hal_ll_gpio_toggle_pin_output( (hal_ll_gpio_pin_t *)_handle )
#else
void hal_gpio_toggle_pin_output( hal_gpio_pin_t *pin );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_set_pin_output(_handle) hal_ll_gpio_set_pin_output( (hal_ll_gpio_pin_t *)_handle )
#else
void hal_gpio_set_pin_output( hal_gpio_pin_t *pin );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_clear_pin_output(_handle) hal_ll_gpio_clear_pin_output( (hal_ll_gpio_pin_t *)_handle )
#else
void hal_gpio_clear_pin_output( hal_gpio_pin_t *pin );
#endif
 
void hal_gpio_configure_port( hal_gpio_port_t *port, hal_port_name_t name, hal_gpio_mask_t mask, hal_gpio_direction_t direction );
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_read_port_input(_handle) hal_ll_gpio_read_port_input( (hal_ll_gpio_port_t *)_handle )
#else
hal_port_size_t hal_gpio_read_port_input( hal_gpio_port_t *port );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_read_port_output(_handle) hal_ll_gpio_read_port_output( (hal_ll_gpio_port_t *)_handle )
#else
hal_port_size_t hal_gpio_read_port_output( hal_gpio_port_t *port );
#endif
 
#if defined(FLATTEN_ME) && (FLATTEN_ME_LEVEL >= FLATTEN_ME_LEVEL_MID)
#define hal_gpio_write_port_output(_handle,_value) hal_ll_gpio_write_port_output( (hal_ll_gpio_port_t *)_handle, _value )
#else
void hal_gpio_write_port_output( hal_gpio_port_t *port, hal_port_size_t value );
#endif
 
 // halgpiogroup
 // halgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_GPIO_H_
// ------------------------------------------------------------------------- END