mbed-os/targets/TARGET_Cypress/TARGET_PSOC6/mtb-hal-cat1/source/cyhal_comp.c

/***************************************************************************/ /**
* \file cyhal_comp.c
*
* \brief
* Provides a high level interface for interacting with the Cypress analog
* comparator. This interface abstracts out the chip specific details. If any chip
* specific functionality is necessary, or performance is critical the low level
* functions can be used directly.
*
********************************************************************************
* \copyright
* Copyright 2018-2021 Cypress Semiconductor Corporation
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/
#include "cyhal_comp.h"
#include "cyhal_comp_ctb.h"
#include "cyhal_comp_lp.h"
#include "cyhal_gpio.h"
#include "cyhal_analog_common.h"
#include "cyhal_hwmgr.h"
#include "cyhal_system.h"

/**
* \addtogroup group_hal_impl_comp COMP (Analog Comparator)
* \ingroup group_hal_impl
* On CAT1 (PSoC 6), the COMP driver can use either of two underlying hardware blocks:
* - Opamp (configured as analog comparator)
* - LPComp (Low Power Comparator)
*
* Generally, a set of pins can only connect to either an Opamp or an LPComp but not both. In the event
* that both connections are possible, the LPComp will be preferred.
*
* \section group_hal_impl_comp_power Power Level Mapping
* The following table shows how the HAL-defined power levels map to the hardware-specific power levels
* | HAL Power Level                | Opamp Power Level   | LPComp Power Level    |
* | ------------------------------ | ------------------- | --------------------- |
* | @ref CYHAL_POWER_LEVEL_HIGH    | CY_CTB_POWER_HIGH   | CY_LPCOMP_MODE_NORMAL |
* | @ref CYHAL_POWER_LEVEL_MEDIUM  | CY_CTB_POWER_MEDIUM | CY_LPCOMP_MODE_LP     |
* | @ref CYHAL_POWER_LEVEL_LOW     | CY_CTB_POWER_LOW    | CY_LPCOMP_MODE_ULP    |
* | @ref CYHAL_POWER_LEVEL_DEFAULT | CY_CTB_POWER_MEDIUM | CY_LPCOMP_MODE_LP     |
*
*/

/* This file is the top-level wrapper. Comp can be implemented on top of either LPComp or the CTB Opamps */
#if defined(CY_IP_MXS40PASS_CTB_INSTANCES) || defined(CY_IP_MXLPCOMP_INSTANCES)

cy_rslt_t cyhal_comp_init(cyhal_comp_t *obj, cyhal_gpio_t vin_p, cyhal_gpio_t vin_m, cyhal_gpio_t output, cyhal_comp_config_t *cfg)
{
    cy_rslt_t result = CYHAL_COMP_RSLT_ERR_BAD_ARGUMENT;
#if defined(CY_IP_MXLPCOMP_INSTANCES) && (CY_IP_MXLPCOMP_INSTANCES > 0)
    result = _cyhal_comp_lp_init(obj, vin_p, vin_m, output, cfg);
#else
    CY_UNUSED_PARAMETER(obj);
    CY_UNUSED_PARAMETER(vin_p);
    CY_UNUSED_PARAMETER(vin_m);
    CY_UNUSED_PARAMETER(output);
    CY_UNUSED_PARAMETER(cfg);
#endif
#if defined(CY_IP_MXS40PASS_CTB_INSTANCES) && (CY_IP_MXS40PASS_CTB_INSTANCES > 0)
    if(CY_RSLT_SUCCESS != result)
    {
        result = _cyhal_comp_ctb_init(obj, vin_p, vin_m, output, cfg);
    }
#endif
    return result;
}

void cyhal_comp_free(cyhal_comp_t *obj)
{
    if(obj->resource.type == CYHAL_RSC_OPAMP)
    {
#if defined(CY_IP_MXS40PASS_CTB_INSTANCES) && (CY_IP_MXS40PASS_CTB_INSTANCES > 0)
        _cyhal_comp_ctb_free(obj);
#else
        CY_UNUSED_PARAMETER(obj);
        CY_ASSERT(false);
#endif
    }
    else
    {
#if defined(CY_IP_MXLPCOMP_INSTANCES) && (CY_IP_MXLPCOMP_INSTANCES > 0)
        CY_ASSERT(obj->resource.type == CYHAL_RSC_LPCOMP);
        _cyhal_comp_lp_free(obj);
#endif
    }
}

cy_rslt_t cyhal_comp_set_power(cyhal_comp_t *obj, cyhal_power_level_t power)
{
    if(obj->resource.type == CYHAL_RSC_OPAMP)
    {
#if defined(CY_IP_MXS40PASS_CTB_INSTANCES) && (CY_IP_MXS40PASS_CTB_INSTANCES > 0)
        return _cyhal_comp_ctb_set_power(obj, power);
#else
        CY_UNUSED_PARAMETER(power);
        CY_ASSERT(false);
        return CYHAL_COMP_RSLT_ERR_BAD_ARGUMENT;
#endif
    }
    else
    {
#if defined(CY_IP_MXLPCOMP_INSTANCES) && (CY_IP_MXLPCOMP_INSTANCES > 0)
        CY_ASSERT(obj->resource.type == CYHAL_RSC_LPCOMP);
        return _cyhal_comp_lp_set_power(obj, power);
#endif
    }
}

cy_rslt_t cyhal_comp_configure(cyhal_comp_t *obj, cyhal_comp_config_t *cfg)
{
    if(obj->resource.type == CYHAL_RSC_OPAMP)
    {
#if defined(CY_IP_MXS40PASS_CTB_INSTANCES) && (CY_IP_MXS40PASS_CTB_INSTANCES > 0)
        return _cyhal_comp_ctb_configure(obj, cfg);
#else
        CY_UNUSED_PARAMETER(cfg);
        CY_ASSERT(false);
        return CYHAL_COMP_RSLT_ERR_BAD_ARGUMENT;
#endif
    }
    else
    {
#if defined(CY_IP_MXLPCOMP_INSTANCES) && (CY_IP_MXLPCOMP_INSTANCES > 0)
        CY_ASSERT(obj->resource.type == CYHAL_RSC_LPCOMP);
        return _cyhal_comp_lp_configure(obj, cfg);
#endif
    }
}

bool cyhal_comp_read(cyhal_comp_t *obj)
{
    if(obj->resource.type == CYHAL_RSC_OPAMP)
    {
#if defined(CY_IP_MXS40PASS_CTB_INSTANCES) && (CY_IP_MXS40PASS_CTB_INSTANCES > 0)
        return _cyhal_comp_ctb_read(obj);
#else
        CY_ASSERT(false);
        return CYHAL_COMP_RSLT_ERR_BAD_ARGUMENT;
#endif
    }
    else
    {
#if defined(CY_IP_MXLPCOMP_INSTANCES) && (CY_IP_MXLPCOMP_INSTANCES > 0)
        CY_ASSERT(obj->resource.type == CYHAL_RSC_LPCOMP);
        return _cyhal_comp_lp_read(obj);
#endif
    }
}

void cyhal_comp_register_callback(cyhal_comp_t *obj, cyhal_comp_event_callback_t callback, void *callback_arg)
{
    CY_UNUSED_PARAMETER(obj);
    CY_ASSERT(NULL != obj);

    uint32_t savedIntrStatus = cyhal_system_critical_section_enter();
    obj->callback_data.callback = (cy_israddress) callback;
    obj->callback_data.callback_arg = callback_arg;
    cyhal_system_critical_section_exit(savedIntrStatus);
}

void cyhal_comp_enable_event(cyhal_comp_t *obj, cyhal_comp_event_t event, uint8_t intr_priority, bool enable)
{
    if(obj->resource.type == CYHAL_RSC_OPAMP)
    {
#if defined(CY_IP_MXS40PASS_CTB_INSTANCES) && (CY_IP_MXS40PASS_CTB_INSTANCES > 0)
        _cyhal_comp_ctb_enable_event(obj, event, intr_priority, enable);
#else
        CY_UNUSED_PARAMETER(event);
        CY_UNUSED_PARAMETER(intr_priority);
        CY_UNUSED_PARAMETER(enable);
        CY_ASSERT(false);
#endif
    }
    else
    {
#if defined(CY_IP_MXLPCOMP_INSTANCES) && (CY_IP_MXLPCOMP_INSTANCES > 0)
        CY_ASSERT(obj->resource.type == CYHAL_RSC_LPCOMP);
        _cyhal_comp_lp_enable_event(obj, event, intr_priority, enable);
#endif
    }
}

#endif /* defined(CY_IP_MXS40PASS_CTB_INSTANCES) || defined(CY_IP_MXLPCOMP_INSTANCES) */

/** \} group_hal_impl_comp */