Realtek/inc/app/app_msg.h

/**
*********************************************************************************************************
*               Copyright(c) 2017, Realtek Semiconductor Corporation. All rights reserved.
**********************************************************************************************************
  * @file    app_msg.h
  * @brief   Message definition for user application task.
  * @note    If new message types/sub types are to be added, add to the end of enumeration.
  *          The orders are NOT to changed.
  * @author  Lory
  * @date    2017.2.9
  * @version v1.0
*********************************************************************************************************
*/
/*============================================================================*
  *                     Define to prevent recursive inclusion
  *============================================================================*/

#ifndef _APP_MSG_H_
#define _APP_MSG_H_

/*============================================================================*
  *                               Header Files
  *============================================================================*/
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif


/** @defgroup APP_MSG APP Message
  * @brief message definition for user application task
  * @{
  */

/*============================================================================*
  *                                   Types
  *============================================================================*/
/** @defgroup APP_MSG_Exported_Types APP Message Exported Types
  * @{
    */

/**  @brief Event type definitions.*/
typedef enum
{
    EVENT_GAP_MSG = 0x01,  /**< message from gap layer for stack */
    EVENT_IO_TO_APP = 0x02, /**< message from IO to user application */
} T_EVENT_TYPE;

/**  @brief IO type definitions for IO message, may extend as requested */
typedef enum
{
    IO_MSG_TYPE_BT_STATUS,  /**< BT status change with subtype @ref GAP_MSG_TYPE */
    IO_MSG_TYPE_KEYSCAN,    /**< Key scan message with subtype @ref T_IO_MSG_KEYSCAN */
    IO_MSG_TYPE_QDECODE,    /**< subtype to be defined */
    IO_MSG_TYPE_UART,       /**< Uart message with subtype @ref T_IO_MSG_UART */
    IO_MSG_TYPE_KEYPAD,     /**< subtype to be defined */
    IO_MSG_TYPE_IR,         /**< subtype to be defined */
    IO_MSG_TYPE_GDMA,       /**< subtype to be defined */
    IO_MSG_TYPE_ADC,        /**< subtype to be defined */
    IO_MSG_TYPE_D3DG,       /**< subtype to be defined */
    IO_MSG_TYPE_SPI,        /**< subtype to be defined */
    IO_MSG_TYPE_MOUSE_BUTTON,   /**< subtype to be defined */
    IO_MSG_TYPE_GPIO,       /**< Gpio message with subtype @ref T_IO_MSG_GPIO*/
    IO_MSG_TYPE_MOUSE_SENSOR,   /**< subtype to be defined */
    IO_MSG_TYPE_TIMER,      /**< App timer message with subtype @ref T_IO_MSG_TIMER */
    IO_MSG_TYPE_WRISTBNAD,  /**< wristband message with subtype @ref T_IO_MSG_WRISTBAND */
    IO_MSG_TYPE_MESH_STATUS,    /**< subtype to be defined */
    IO_MSG_TYPE_KEYBOARD_BUTTON, /**< subtype to be defined */
    IO_MSG_TYPE_ANCS,            /**< ANCS message*/
    IO_MSG_TYPE_IR_LEARN_DATA,       /**< ir learn data message*/
    IO_MSG_TYPE_IR_LEARN_STOP,       /**< ir learn stop message*/
    IO_MSG_TYPE_IR_START_SEND_REPEAT_CODE, /**< ir send repeat code message*/
    IO_MSG_TYPE_IR_SEND_COMPLETE,    /**< ir send complete message*/
    IO_MSG_TYPE_BAT_LPC,        /**< lpc send low power message*/
    IO_MSG_TYPE_BAT_DETECT,     /**< BAT adc detect battery value*/
    IO_MSG_TYPE_AUDIO,          /**< Audio message with subtype @ref T_IO_MSG_TYPE_AUDIO*/
    IO_MSG_TYPE_RESET_WDG_TIMER, /**< reset watch dog timer*/
    IO_MSG_TYPE_RESET_AON_WDG_TIMER, /**< reset aon watch dog timer*/
    IO_MSG_TYPE_BBPRO_HCI,  /**< bbpro hci message*/
    IO_MSG_TYPE_RTC,             /**< subtype to be defined */
    IO_MSG_TYPE_I2C,             /**< subtype to be defined */
    IO_MSG_TYPE_WIFI_UART,       /**< wifi uart message */
    IO_MSG_TYPE_PD_TIMER,
    IO_MSG_TYPE_AMA_BT_MSG,
    IO_MSG_TYPE_DFU_VALID_FW,
    IO_MSG_TYPE_VOICE,           /**< voice message */
    IO_MSG_TYPE_IR_FLASH,
    IO_MSG_TYPE_LE_AUDIO,
    IO_MSG_TYPE_DONGLE_STOP_SYNC,
    IO_MSG_TYPE_LATENCY,
    IO_MSG_TYPE_MOUSE_MODE_MONITOR,
    IO_MSG_TYPE_BAT_FORCE_DETECT,
    IO_MSG_TYPE_PPT,
    IO_MSG_TYPE_DPI,
    IO_MSG_TYPE_LED,
    IO_MSG_TYPE_GFPS,            /**< google fast fair service message */
    IO_MSG_TYPE_PPT_RESET,
    IO_MSG_TYPE_PPT_CONNECTED,
    IO_MSG_TYPE_IC_RESET,
    IO_MSG_TYPE_FMNA,            /**< apple find my message */
    IO_MSG_TYPE_ADV,
    IO_MSG_TYPE_ADV_TIMEOUT,
    IO_MSG_TYPE_OTHERS,
} T_IO_MSG_TYPE;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_ADC type */
typedef enum
{
    IO_MSG_ADC_FIFO_READ_ERR,
    IO_MSG_ADC_FIFO_OVERFLOW,
} T_IO_MSG_TYPE_ADC;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_AUDIO type */
typedef enum
{
    IO_MSG_AUDIO_INPUT_BUFF_READY,
    IO_MSG_AUDIO_PROCESS_DONE,
    IO_MSG_AUDIO_TIMEOUT,
    IO_MSG_AUDIO_HD_ATTACHED,
    IO_MSG_AUDIO_HD_DETACHED,
} T_IO_MSG_TYPE_AUDIO;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_KEYSCAN type */
typedef enum
{
    IO_MSG_KEYSCAN_RX_PKT        = 1, /**< Keyscan RX data event */
    IO_MSG_KEYSCAN_MAX           = 2, /**<  */
    IO_MSG_KEYSCAN_ALLKEYRELEASE = 3, /**< All keys are released event */
    IO_MSG_KEYSCAN_STUCK         = 4, /**<  key stuck message */
    IO_MSG_KEYSCAN_LONG_PRESS    = 5,
    IO_MSG_KEYSCAN_REPEAT_SEND   = 6,
} T_IO_MSG_KEYSCAN;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_UART type */
typedef enum
{
    IO_MSG_UART_RX                     = 1,
    IO_MSG_UART_RX_TIMEOUT             = 2,
    IO_MSG_UART_RX_OVERFLOW            = 3,
    IO_MSG_UART_RX_TIMEOUT_OVERFLOW    = 4,
    IO_MSG_UART_RX_EMPTY               = 5,
} T_IO_MSG_UART;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_GPIO type */
typedef enum
{
    IO_MSG_GPIO_KEY,               /**< KEY GPIO event */
    IO_MSG_GPIO_LINE_IN,           /**< LINE IN event */
    IO_MSG_GPIO_NFC,               /**< NFC event */
    IO_MSG_GPIO_UART_WAKE_UP,      /**< UART WAKE UP event */
    IO_MSG_GPIO_CHARGER,           /**< CHARGER event */
    IO_MSG_GPIO_TRIG_SHORT_PRESS,
		IO_MSG_GPIO_TRIG_LONG_PRESS_1S,
    IO_MSG_GPIO_TRIG_LONG_PRESS_2S,
		IO_MSG_GPIO_TRIG_LONG_PRESS_3S,
    IO_MSG_GPIO_TRIG_LONG_PRESS_5S,
    IO_MSG_GPIO_TRIG_LONG_PRESS_10S,
    IO_MSG_GPIO_CUST_SHORT_PRESS,
    IO_MSG_GPIO_CUST_LONG_PRESS_2S,
    IO_MSG_GPIO_CUST_LONG_PRESS_10S,
} T_IO_MSG_GPIO;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_TIMER type */
typedef enum
{
    IO_MSG_TIMER_ALARM,
    IO_MSG_TIMER_RWS
} T_IO_MSG_TIMER;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_WRISTBNAD type */
typedef enum
{
    IO_MSG_BWPS_TX_VALUE,
    IO_MSG_RTC_TIMEROUT_WALL_CLOCK,
    IO_MSG_SENSOR_WAKE_UP,
    IO_MSG_LED_TWINKLE,
    IO_MSG_MOTOR_VIBRATE,
    IO_MSG_CHARGER_STATE,
    IO_MSG_RTC_LOW_BATTERY_RESTORE,
    IO_MSG_RTC_ALARM,
    IO_MSG_POWER_OFF,
    IO_MSG_POWER_ON,
    IO_MSG_HRS_EVENT,
    IO_MSG_SENSOR_MOTION_INTERRUPT,
    IO_MSG_UART_CMD_DEBUG,
    IO_MSG_HRS_TIMEOUT_HANDLE,
    IO_MSG_UPDATE_CONPARA,
    IO_MSG_REPORT_BUTTON,
    IO_MSG_UART_GPS,
    IO_MSG_UART_DEBUG_RX,
    IO_MSG_WAS_RX_VALUE,
    IO_MSG_WAS_ENABLE_CCCD,
    IO_MSG_VOICE_DMA_RX,
    IO_MSG_TOUCH_GES,
    IO_MSG_TOUCH_INT,
    IO_MSG_TOUCH_TIMEOUT,
    IO_MSG_TOUCH_HANDLE,
    IO_MSG_MENU_TIMER,
    IO_MSG_LCD_SYNC,
    IO_MSG_MAGIC_OPEN_ADV,
    IO_MSG_MAGIC_PAIR_ADV,
    IO_MSG_MAGIC_STOP_ADV,
    IO_MSG_BREEZE_AIS_CB,
    IO_MSG_ANCS_DISCOVERY,
    IO_MSG_TYPE_AMS
} T_IO_MSG_WRISTBAND;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_BBPRO_HCI type */
typedef enum
{
    IO_MSG_BBPRO_HCI_RX_PKT         = 1, /**< BBPRO HCI RX data event */
    IO_MSG_BBPRO_HCI_RETRANS        = 2, /**< BBPRO HCI retransmission event*/
    IO_MSG_BBPRO_HCI_RETRANS_FAIL   = 3, /**< BBPRO HCI retransmission failed event*/
    IO_MSG_BBPRO_HCI_TIMEOUT        = 4, /**< BBPRO HCI timeout event */
} T_IO_MSG_BBPRO_HCI;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_UART type */
typedef enum
{
    IO_MSG_WIFI_UART_RX_PKT         = 1, /**< WIFI UART RX data event */
    IO_MSG_WIFI_UART_RETRANS        = 2, /**< WIFI UART retransmission event*/
    IO_MSG_WIFI_UART_RETRANS_FAIL   = 3, /**< WIFI UART retransmission failed event*/
} T_IO_MSG_WIFI_UART;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_GFPS type */
typedef enum
{
    IO_MSG_GFPS_ID_ROTAION,
    IO_MSG_GFPS_UPDATE_RPA,
    IO_MSG_GFPS_ECC,
    IO_MSG_GFPS_LOCATOR_TAG_UNPAIR,
} T_IO_MSG_TYPE_GFPS;

/**  @brief IO subtype definitions for @ref IO_MSG_TYPE_FMNA type */
typedef enum
{
    IO_MSG_FMNA_KEYROLL,
    IO_MSG_FMNA_DISCONNECT,
    IO_MSG_FMNA_RECONNECT_TIMEOUT,
    IO_MSG_FMNA_UT_START,
    IO_MSG_FMNA_MT,
    IO_MSG_FMNA_GAP,
} T_IO_MSG_TYPE_FMNA;

/**  @brief IO message definition for communications between tasks*/
typedef struct
{
    uint16_t type;
    uint16_t subtype;
    union
    {
        uint32_t  param;
        void     *buf;
    } u;
} T_IO_MSG;

/** @} */ /* End of group APP_MSG_Exported_Types */

/** @} */ /* End of group APP_MSG */

#ifdef __cplusplus
}
#endif

#endif /* _APP_MSG_H_ */