hpm_gpiom_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef HPM_GPIOM_DRV_H
#define HPM_GPIOM_DRV_H
 
#include "hpm_gpiom_regs.h"
#include "hpm_gpiom_soc_drv.h"
 
/* @brief pin visibility */
typedef enum gpiom_pin_visibility {
    gpiom_pin_visible = 0,
    gpiom_pin_invisible = 1,
} gpiom_pin_visibility_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
static inline gpiom_gpio_t gpiom_get_pin_controller(GPIOM_Type *ptr,
                                                      uint8_t gpio_index,
                                                      uint8_t pin_index)
{
    return (gpiom_gpio_t)((ptr->ASSIGN[gpio_index].PIN[pin_index]
            & (GPIOM_ASSIGN_PIN_SELECT_MASK)) >> GPIOM_ASSIGN_PIN_SELECT_SHIFT);
}
 
static inline void gpiom_set_pin_controller(GPIOM_Type *ptr,
                              uint8_t gpio_index,
                              uint8_t pin_index,
                              gpiom_gpio_t gpio)
{
    ptr->ASSIGN[gpio_index].PIN[pin_index] =
        (ptr->ASSIGN[gpio_index].PIN[pin_index] & ~(GPIOM_ASSIGN_PIN_SELECT_MASK))
      | GPIOM_ASSIGN_PIN_SELECT_SET(gpio);
}
 
static inline bool gpiom_check_pin_visibility(GPIOM_Type *ptr,
                              uint8_t gpio_index,
                              uint8_t pin_index,
                              gpiom_gpio_t gpio)
{
    return (ptr->ASSIGN[gpio_index].PIN[pin_index] & ((1 << gpio) << GPIOM_ASSIGN_PIN_HIDE_SHIFT))
        >> GPIOM_ASSIGN_PIN_HIDE_SHIFT >> gpio == gpiom_pin_visible;
}
 
static inline void gpiom_enable_pin_visibility(GPIOM_Type *ptr,
                              uint8_t gpio_index,
                              uint8_t pin_index,
                              gpiom_gpio_t gpio)
{
    ptr->ASSIGN[gpio_index].PIN[pin_index] =
        (ptr->ASSIGN[gpio_index].PIN[pin_index] & ~((1 << gpio) << GPIOM_ASSIGN_PIN_HIDE_SHIFT));
}
 
static inline void gpiom_disable_pin_visibility(GPIOM_Type *ptr,
                              uint8_t gpio_index,
                              uint8_t pin_index,
                              gpiom_gpio_t gpio)
{
    ptr->ASSIGN[gpio_index].PIN[pin_index] =
        (ptr->ASSIGN[gpio_index].PIN[pin_index] & ~((1 << gpio) << GPIOM_ASSIGN_PIN_HIDE_SHIFT))
      | GPIOM_ASSIGN_PIN_HIDE_SET(1 << gpio);
}
 
static inline bool gpiom_pin_is_locked(GPIOM_Type *ptr,
                              uint8_t gpio_index,
                              uint8_t pin_index)
{
    return (ptr->ASSIGN[gpio_index].PIN[pin_index] & GPIOM_ASSIGN_PIN_LOCK_MASK)
        == GPIOM_ASSIGN_PIN_LOCK_MASK;
}
 
static inline void gpiom_lock_pin(GPIOM_Type *ptr,
                              uint8_t gpio_index,
                              uint8_t pin_index)
{
    ptr->ASSIGN[gpio_index].PIN[pin_index] |= GPIOM_ASSIGN_PIN_LOCK_MASK;
}
 
#ifdef __cplusplus
}
#endif
#endif /* HPM_GPIOM_DRV_H */