/**
  ******************************************************************************
  * @file  aspep.h
  * @author  Motor Control SDK Team, ST Microelectronics
  * @brief  This file provides aspep API that implement the aspep protocol
  *
  *
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; Copyright (c) 2025 STMicroelectronics.
  * All rights reserved.</center></h2>
  *
  * This software component is licensed by ST under Ultimate Liberty license
  * SLA0044, the "License"; You may not use this file except in compliance with
  * the License. You may obtain a copy of the License at:
  *                             www.st.com/SLA0044
  *
  ******************************************************************************
  */

#ifndef ASPEP_H
#define ASPEP_H

#include "parameters_conversion.h"
#include "mcptl.h"

#define ASPEP_CTRL               ((uint8_t)0) /* Beacon, Nack, or Ping*/

#define ASPEP_OK                 ((uint8_t)0)
#define ASPEP_SYNC_NOT_EXPECTED  1
#define ASPEP_NOT_CONNECTED      2
#define ASPEP_BUFFER_ERROR       3

#define ASPEP_BAD_PACKET_TYPE    1
#define ASPEP_BAD_PACKET_SIZE    2
#define ASPEP_BAD_CRC_HEADER     4
#define ASPEP_BAD_CRC_DATA       5

#define ASPEP_PING_RESET         0
#define ASPEP_PING_CFG           1

#define ASPEP_HEADER_SIZE        4
#define ASPEP_CTRL_SIZE          4
#define ASPEP_DATACRC_SIZE       2U

#define ID_MASK                  ((uint32_t)0xF)
#define DATA_PACKET              ((uint32_t)0x9)
#define PING                     ((uint32_t)0x6)
#define BEACON                   ((uint32_t)0x5)
#define NACK                     ((uint32_t)0xF)
#define ACK                      ((uint32_t)0xA)
typedef uint32_t ASPEP_packetType;

typedef void (*ASPEP_config_transmission_cb_t)    (void *pASPEP_Handle, void *txbuffer, uint16_t length);
typedef void (*ASPEP_config_reception_cb_t)       (void *pASPEP_Handle, void *rxbuffer, uint16_t length);
typedef void (*ASPEP_hwinit_cb_t)                 (void *pUASPEP_Handle);
typedef void (*ASPEP_hwsync_cb_t)                 (void *pUASPEP_Handle);

/** @addtogroup MCSDK
  * @{
  */

/** @addtogroup MCP
  * @{
  */

/**
  * @brief  ASPEP State Machine Type.
  */
typedef enum
{
  ASPEP_IDLE,
  ASPEP_CONFIGURED,
  ASPEP_CONNECTED,
} ASPEP_sm_type;

/**
  * @brief  ASPEP Transport Layer State Machine Type.
  */
typedef enum
{
  WAITING_PACKET,
  WAITING_PAYLOAD,
} ASPEP_TL_sm_type;

/**
  * @brief  ASPEP Control Buffer structure.
  */
typedef struct
{
  uint8_t buffer[ASPEP_HEADER_SIZE];
  buff_access_t state;
} ASPEP_ctrlBuff_t;

/**
  * @brief  ASPEP communication capabilities.
  *
  * Minimum between Controller and Performer capabilities.
  */
typedef struct
{
  uint8_t DATA_CRC;
  uint8_t RX_maxSize;
  uint8_t TXS_maxSize;
  uint8_t TXA_maxSize;
  uint8_t version;
} ASPEP_Capabilities_def;

/**
  * @brief Handle structure for ASPEP related components.
  */
typedef struct
{
  MCTL_Handle_t _Super;                    /*!< Transport Layer component handle */
  void *ASPEPIp;                           /*!< ASPEP components used for communication */
  uint8_t *rxBuffer;                       /*!< Contains the ASPEP Data payload */
  uint8_t rxHeader[4];                     /*!< Contains the ASPEP 32 bits header */
  ASPEP_ctrlBuff_t ctrlBuffer;             /*!< ASPEP protocol control buffer */
  MCTL_Buff_t syncBuffer;                  /*!< Buffer used for synchronous communication */
  MCTL_Buff_t asyncBufferA;                /*!< First buffer used for asynchronous communication */
  MCTL_Buff_t asyncBufferB;                /*!< Second buffer used for asynchronous communication */
  MCTL_Buff_t *lastRequestedAsyncBuff;     /*!< Last buffer requested for asynchronous communication */
  MCTL_Buff_t *asyncNextBuffer;            /*!< Next buffer that will be transmitted by asynchronous communication */
  void *lockBuffer;                        /*!< Buffer locked to avoid erasing data not yet transmitted */
  ASPEP_hwinit_cb_t fASPEP_HWInit;         /*!< Pointer to the initialization function */
  ASPEP_hwsync_cb_t fASPEP_HWSync;         /*!< Pointer to the starting function */
  ASPEP_config_reception_cb_t fASPEP_cfg_recept;          /*!< Pointer to the receiving packet function */
  ASPEP_config_transmission_cb_t fASPEP_cfg_trans;        /*!< Pointer to the sending packet function */
  uint16_t rxLengthASPEP;                  /*!< Length of the received data packet used by ASPEP : payload, header or both */
  uint16_t maxRXPayload;                   /*!< Maximum payload size the performer can process */
  uint8_t syncPacketCount;                 /*!< Reset at startup only, this counter is incremented at each valid data packet received from controller */
  bool NewPacketAvailable;                 /*!< Boolean stating if performer is ready to receive a new packet or not */
  uint8_t badPacketFlag;                   /*!< Contains the error code in case of ASPEP decoding issue */
  uint8_t liid;
  ASPEP_sm_type ASPEP_State;               /*!< ASPEP State of the communication between performer and controller */
  ASPEP_TL_sm_type ASPEP_TL_State;         /*!< Transport Layer state of the communication between performer and controller */
  ASPEP_packetType rxPacketType;           /*!< Type of the received packet */
  ASPEP_Capabilities_def Capabilities;     /*!< Minimum between Controller and Performer capabilities */
} ASPEP_Handle_t;

void ASPEP_start(ASPEP_Handle_t *pHandle);
/* MCTL (Motor Control Transport Layer) API */
bool ASPEP_getBuffer(MCTL_Handle_t *pHandle, void **buffer, uint8_t syncAsync);
uint8_t ASPEP_sendPacket(MCTL_Handle_t *pHandle, void *txBuffer, uint16_t txDataLength, uint8_t syncAsync);
uint8_t *ASPEP_RXframeProcess(MCTL_Handle_t *pHandle, uint16_t *packetLength);
/*   */
void ASPEP_HWDataReceivedIT(ASPEP_Handle_t *pHandle);
void ASPEP_HWDataTransmittedIT(ASPEP_Handle_t *pHandle);
/* Debugger stuff */
void ASPEP_HWReset(ASPEP_Handle_t *pHandle);

#endif /* ASPEP_H */

/**
  * @}
  */

/**
  * @}
  */

/************************ (C) COPYRIGHT 2025 STMicroelectronics *****END OF FILE****/