/*
 * SPDX-FileCopyrightText: 2024-2026 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include "soc/soc_caps.h"
#if (SOC_USB_UTMI_PHY_NUM > 0)
#include "soc/usb_utmi_struct.h"
#include "hal/usb_utmi_ll.h"
#endif // (SOC_USB_UTMI_PHY_NUM > 0)

#ifdef __cplusplus
extern "C" {
#endif

#if (SOC_USB_UTMI_PHY_NUM > 0)

/**
 * @brief HAL context type of USB UTMI driver
 */
typedef struct {
    usb_utmi_dev_t *dev;
} usb_utmi_hal_context_t;

/**
 * @brief Sets UTMI defaults
 *
 * Enable clock, reset the peripheral, sets default options (LS support, disconnection detection)
 *
 * @param[in] hal USB UTMI HAL context
 */
void _usb_utmi_hal_init(usb_utmi_hal_context_t *hal);

#if SOC_RCC_IS_INDEPENDENT
#define usb_utmi_hal_init(...)   _usb_utmi_hal_init(__VA_ARGS__)
#else
// Use a macro to wrap the function, force the caller to use it in a critical section
// the critical section needs to declare the __DECLARE_RCC_ATOMIC_ENV variable in advance
#define usb_utmi_hal_init(...) do {(void)__DECLARE_RCC_ATOMIC_ENV; _usb_utmi_hal_init(__VA_ARGS__);} while(0)
#endif

/**
 * @brief Disable UTMI
 *
 * Disable clock to the peripheral
 */
void _usb_utmi_hal_disable(void);

#if SOC_RCC_IS_INDEPENDENT
#define usb_utmi_hal_disable(...)   _usb_utmi_hal_disable(__VA_ARGS__)
#else
// Use a macro to wrap the function, force the caller to use it in a critical section
// the critical section needs to declare the __DECLARE_RCC_ATOMIC_ENV variable in advance
#define usb_utmi_hal_disable(...) do {(void)__DECLARE_RCC_ATOMIC_ENV; _usb_utmi_hal_disable(__VA_ARGS__);} while(0)
#endif

/**
 * @brief Enable/disable 15k pulldown resistors on D+/D- lines
 *
 * In USB Host mode, 15k pulldown resistors must be connected on both D+ and D-.
 * In USB Device mode, pulldown resistors must be disconnected.
 *
 * @param[in] enable true to connect pulldowns (Host mode), false to disconnect (Device mode)
 */
void usb_utmi_hal_enable_data_pulldowns(bool enable);

/**
 * @brief Set USB OTG2.0 suspend state for PMU USB wakeup logic
 *
 * @param[in] in_suspend True if USB OTG2.0 is suspended
 */
void usb_utmi_hal_set_suspend_state(bool in_suspend);

/**
 * @brief Clear USB OTG2.0 wakeup status sent to PMU
 */
void usb_utmi_hal_clear_wakeup_status(void);

#endif // (SOC_USB_UTMI_PHY_NUM > 0)

#ifdef __cplusplus
}
#endif