/*
 * Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
 * its subsidiaries and affiliates (collectly called MKSEMI).
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into an MKSEMI
 *    integrated circuit in a product or a software update for such product,
 *    must reproduce the above copyright notice, this list of conditions and
 *    the following disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. Neither the name of MKSEMI nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    MKSEMI integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be
 *    reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL MKSEMI OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef UCI_TL_COMM_H_
#define UCI_TL_COMM_H_

#include "user_config.h"
#include "wsf_queue.h"
#include "wsf_timer.h"
#include "stdbool.h"

/* UCI SPI full-duplex handshake interface */
#ifndef UCI_INTF_SPI_FD_HS
#define UCI_INTF_SPI_FD_HS (0)
#endif

/* UCI SPI half-duplex handshake interface */
#ifndef UCI_INTF_SPI_HD_HS
#define UCI_INTF_SPI_HD_HS (0)
#endif

/* UCI UART handshake interface */
#ifndef UCI_INTF_UART_HS
#define UCI_INTF_UART_HS (0)
#endif

/* UCI UART interface */
#ifndef UCI_INTF_UART
#define UCI_INTF_UART (0)
#endif

#define UCI_RX_BUFF_SIZE (UCI_HEADER_SIZE + UCI_MAX_PAYLOAD_SIZE)
#define UCI_TX_BUFF_SIZE UCI_RX_BUFF_SIZE

typedef struct uci_tl_dev_s
{
    wsfQueue_t tl_down_queue;
    wsfQueue_t tl_up_queue;
    wsfTimer_t tl_timer;
    void (*uci_tl_setup)(void);
    void (*uci_tl_resume)(void);
    bool (*uci_tl_up_is_active)(void);
    void (*uci_tl_down_notify)(void);
    void (*uci_tl_up_req)(void);
    void (*uci_tl_up_done_notify)(void);
    void (*uci_tl_timer_notify)(void);
} uci_tl_dev_t;

#ifdef __cplusplus
extern "C" {
#endif

extern uci_tl_dev_t g_uci_tl_dev;

#ifdef __cplusplus
}
#endif

#endif /* UCI_TL_COMM_H_ */