in_ble_prf_hogp.h

#ifndef IN_BLE_PRF_HOGP_H
#define IN_BLE_PRF_HOGP_H

#include "ble/in_ble_evt.h"
#include "ble/in_ble_prf.h"
/*
 * Defines
 ****************************************************************************************
 */

#define BLE_HOGPRH_NB_HIDS_INST_MAX              (2)
#define BLE_HOGPRH_NB_REPORT_INST_MAX            (5)
#define BLE_HOGPRH_REPORT_MAP_MAX_LEN            (512)

#define BLE_HOGPD_NB_HIDS_INST_MAX              (2)
#define BLE_HOGPD_NB_REPORT_INST_MAX            (5)

/*
 * Enumerations
 ****************************************************************************************
 */

/*
 * Events
 ****************************************************************************************
 */

enum ble_hog_evt_code {
    HOGPBH_EVT_CODE = HOGP_EVT_CODE +1,

    HOGPBH_EVT_BOOT_REPORT_IND,

    HOGPRH_EVT_CODE = (HOGP_EVT_CODE + 0x10),

    HOGPRH_EVT_REPORT_IND,

    HOGPD_EVT_CODE = (HOGP_EVT_CODE + 0x20),

    HOGPD_EVT_REPORT_REQ_IND,
    HOGPD_EVT_PROTO_MODE_UPD_IND,
    HOGPD_EVT_NTF_CFG_IND,
    HOGPD_EVT_CNTL_PT_IND,
};

/*
 * HOGP Common
 ****************************************************************************************
 */

enum ble_hogp_info_bit
{
    BLE_HIDS_REMOTE_WAKE_CAPABLE           = 0x01,
    BLE_HIDS_NORM_CONNECTABLE              = 0x02,
};

enum ble_hogp_ctnl_pt
{
    BLE_HOGP_CTNL_PT_SUSPEND            = 0x00,
    BLE_HOGP_CTNL_PT_EXIT_SUSPEND,
};

enum ble_hogp_boot_prot_mode
{
    BLE_HOGP_BOOT_PROTOCOL_MODE         = 0x00,
    BLE_HOGP_REPORT_PROTOCOL_MODE,
};

/*
 * HOG Boot Host profile
 ****************************************************************************************
 */

enum ble_hogpbh_chars
{
    BLE_HOGPBH_CHAR_PROTO_MODE,
    BLE_HOGPBH_CHAR_BOOT_KB_IN_REPORT,
    BLE_HOGPBH_CHAR_BOOT_KB_OUT_REPORT,
    BLE_HOGPBH_CHAR_BOOT_MOUSE_IN_REPORT,

    BLE_HOGPBH_CHAR_MAX,
};

enum ble_hogpbh_descs
{
    BLE_HOGPBH_DESC_BOOT_KB_IN_REPORT_CFG,
    BLE_HOGPBH_DESC_BOOT_MOUSE_IN_REPORT_CFG,

    BLE_HOGPBH_DESC_MAX,
};

enum ble_hogpbh_info
{
    BLE_HOGPBH_PROTO_MODE,
    BLE_HOGPBH_BOOT_KB_IN_REPORT,
    BLE_HOGPBH_BOOT_KB_OUT_REPORT,
    BLE_HOGPBH_BOOT_MOUSE_IN_REPORT,

    BLE_HOGPBH_BOOT_KB_IN_NTF_CFG,
    BLE_HOGPBH_BOOT_MOUSE_IN_NTF_CFG,

    BLE_HOGPBH_INFO_MAX,
};

/*
 * HOG Device profile
 ****************************************************************************************
 */

enum ble_hogpd_cfg
{
    BLE_HOGPD_CFG_KEYBOARD      = 0x01,
    BLE_HOGPD_CFG_MOUSE         = 0x02,
    BLE_HOGPD_CFG_PROTO_MODE    = 0x04,
    BLE_HOGPD_CFG_MAP_EXT_REF   = 0x08,
    BLE_HOGPD_CFG_BOOT_KB_WR    = 0x10,
    BLE_HOGPD_CFG_BOOT_MOUSE_WR = 0x20,

    BLE_HOGPD_CFG_MASK          = 0x3F,

    BLE_HOGPD_CFG_REPORT_NTF_EN = 0x40,
};

enum ble_hogpd_report_cfg
{
    BLE_HOGPD_CFG_REPORT_IN     = 0x01,
    BLE_HOGPD_CFG_REPORT_OUT    = 0x02,
    //HOGPD_CFG_REPORT_FEAT can be used as a mask to check Report type
    BLE_HOGPD_CFG_REPORT_FEAT   = 0x03,
    BLE_HOGPD_CFG_REPORT_WR     = 0x10,
};

enum ble_hogpd_report_type
{
    BLE_HOGPD_REPORT,
    BLE_HOGPD_REPORT_MAP,
    BLE_HOGPD_BOOT_KEYBOARD_INPUT_REPORT,
    BLE_HOGPD_BOOT_KEYBOARD_OUTPUT_REPORT,
    BLE_HOGPD_BOOT_MOUSE_INPUT_REPORT,
};

enum ble_hogpd_op
{
    BLE_HOGPD_OP_NO,
    BLE_HOGPD_OP_REPORT_READ,
    BLE_HOGPD_OP_REPORT_WRITE,
    BLE_HOGPD_OP_PROT_UPDATE,
};

/*
 * HOG Report host profile
 ****************************************************************************************
 */


enum ble_hogprh_chars
{
    BLE_HOGPRH_CHAR_REPORT_MAP,
    BLE_HOGPRH_CHAR_HID_INFO,
    BLE_HOGPRH_CHAR_HID_CTNL_PT,
    BLE_HOGPRH_CHAR_PROTOCOL_MODE,
    BLE_HOGPRH_CHAR_REPORT,

    BLE_HOGPRH_CHAR_MAX = BLE_HOGPRH_CHAR_REPORT + BLE_HOGPRH_NB_REPORT_INST_MAX,
};

enum ble_hogprh_descs
{
    BLE_HOGPRH_DESC_REPORT_MAP_EXT_REP_REF,
    BLE_HOGPRH_DESC_REPORT_REF,
    BLE_HOGPRH_DESC_REPORT_CFG = BLE_HOGPRH_DESC_REPORT_REF + BLE_HOGPRH_NB_REPORT_INST_MAX,

    BLE_HOGPRH_DESC_MAX = BLE_HOGPRH_DESC_REPORT_CFG + BLE_HOGPRH_NB_REPORT_INST_MAX,
};

enum ble_hogprh_info
{
    BLE_HOGPRH_PROTO_MODE,
    BLE_HOGPRH_REPORT_MAP,
    BLE_HOGPRH_REPORT_MAP_EXT_REP_REF,

    BLE_HOGPRH_HID_INFO,
    BLE_HOGPRH_HID_CTNL_PT,
    BLE_HOGPRH_REPORT,
    BLE_HOGPRH_REPORT_REF,
    BLE_HOGPRH_REPORT_NTF_CFG,

    BLE_HOGPRH_INFO_MAX,
};

/*
 * Structures
 ****************************************************************************************
 */

/*
 * HOG Boot Host profile
 ****************************************************************************************
 */

typedef struct 
{
    uint8_t length;
    uint8_t value[];
} ble_hogpbh_boot_report_t;

typedef union 
{
    uint8_t proto_mode;
    uint16_t ntf_cfg;

    ble_hogpbh_boot_report_t report;
} ble_hogpbh_data_t;

typedef struct 
{
    uint8_t info;
    uint8_t hid_idx;
    ble_hogpbh_data_t data;
} ble_hogpbh_read_info_rsp_t;

typedef struct
{
    ble_svc_t svc;
    ble_char_inf_t chars[BLE_HOGPBH_CHAR_MAX];
    ble_char_desc_inf_t descs[BLE_HOGPBH_DESC_MAX];

} ble_hogpbh_content_t;

typedef struct 
{
    uint8_t conidx; 
    uint8_t info;
    uint8_t hid_idx;
    ble_hogpbh_boot_report_t report;
} ble_evt_hogpbh_boot_report_ind_t;

/*
 * HOG Device profile
 ****************************************************************************************
 */

typedef struct 
{
    uint16_t bcdHID;
    uint8_t  bCountryCode;
    uint8_t  flags;
} ble_hogpd_info_t;

typedef struct 
{
    uint16_t inc_svc_hdl;
    uint16_t rep_ref_uuid;
} ble_hogpd_ext_ref_t;

typedef struct 
{
    uint8_t svc_features;
    uint8_t report_nb;
    uint8_t report_char_cfg[BLE_HOGPD_NB_REPORT_INST_MAX];
    uint8_t report_id[BLE_HOGPD_NB_REPORT_INST_MAX];
    ble_hogpd_info_t hid_info;
    ble_hogpd_ext_ref_t ext_ref;
} ble_hogpd_cfg_t;

typedef struct 
{
    bool multi_instance;

    /*The following params are for HOGPD only*/
    
    bool check_enc_key_size;

    enum ble_att_perm sec_lvl;

    uint8_t hids_nb;
    ble_hogpd_cfg_t cfg[BLE_HOGPD_NB_HIDS_INST_MAX];
} ble_hogp_prf_t;

typedef struct 
{
    uint8_t  hid_idx;
    uint8_t  type;
    uint16_t length;
    uint8_t  idx;
    uint8_t value[];
} ble_hogpd_report_info_t;

typedef struct 
{
    uint8_t conidx;
    uint8_t operation;
    ble_hogpd_report_info_t report;
} ble_evt_hogpd_report_req_ind_t;

typedef struct 
{
    uint8_t conidx;
    uint8_t operation;
    uint8_t hid_idx;
    uint8_t proto_mode;
} ble_evt_hogpd_proto_mode_req_ind_t;

typedef struct 
{
    uint8_t conidx;

    uint16_t ntf_cfg[BLE_HOGPD_NB_HIDS_INST_MAX];
} ble_evt_hogpd_ntf_cfg_ind_t;

typedef struct 
{
    uint8_t conidx;
    uint8_t hid_idx;
    uint8_t hid_ctnl_pt;
} ble_evt_hogpd_ctnl_pt_ind_t;

/*
 * HOG Report host profile
 ****************************************************************************************
 */

typedef struct 
{
    ble_svc_t svc;

    ble_incl_svc_t incl_svc;

    ble_char_inf_t chars[BLE_HOGPRH_CHAR_MAX];

    ble_char_desc_inf_t descs[BLE_HOGPRH_DESC_MAX];

    uint8_t report_nb;
} ble_hogprh_content_t;

typedef struct 
{
    uint8_t length;
    uint8_t value[];
} ble_hogprh_report_t;

typedef struct 
{
    uint8_t id;
    uint8_t type;
} ble_hogprh_report_ref_t;

typedef struct 
{
    uint16_t length;
    uint8_t value[];
} ble_hogprh_report_map_t;

typedef struct 
{
    uint8_t uuid_len;
    uint8_t uuid[];
} ble_hogprh_report_map_ref_t;

typedef union 
{
    uint8_t proto_mode;

    ble_hogpd_info_t hid_info;

    uint8_t hid_ctnl_pt;

    ble_hogprh_report_t report;

    uint16_t report_cfg;

    ble_hogprh_report_ref_t report_ref;

    ble_hogprh_report_map_t report_map;

    ble_hogprh_report_map_ref_t report_map_ref;
} ble_hogprh_data_t;

typedef struct 
{
    uint8_t info;
    uint8_t hid_idx;
    uint8_t report_idx;
} ble_hogprh_read_info_req_t;

typedef struct 
{
    uint8_t info;
    uint8_t hid_idx;
    uint8_t report_idx;
    ble_hogprh_data_t data;
} ble_hogprh_read_info_rsp_t;

typedef struct 
{
    uint8_t info;
    uint8_t hid_idx;
    uint8_t report_idx;
    bool    wr_cmd;
    ble_hogprh_data_t data;
} ble_hogprh_write_req_t;


typedef struct 
{
    uint8_t conidx;
    uint8_t hid_idx;
    uint8_t report_idx;
    ble_hogprh_report_t report;
} ble_evt_hogprh_report_ind_t;

/*
 * APIs
 ****************************************************************************************
 */

/*
 * HOGPBH FUNCTIONS
 ****************************************************************************************
 */

int in_ble_hogpbh_add(void *hdl, ble_hogp_prf_t *p_prf, comp_cb callback);

int in_ble_hogpbh_enable(void *hdl, int conidx, int con_type, uint8_t hids_nb, ble_hogpbh_content_t cont[], comp_cb callback);

int in_ble_hogpbh_read_info_req(void *hdl, int conidx, int hid_idx, int info, ble_hogpbh_read_info_rsp_t *p_rsp, comp_cb callback);

int in_ble_hogpbh_write_req(void *hdl, int conidx, int hid_idx, int info, int wr_cmd, ble_hogpbh_data_t *p_data, comp_cb callback);

/*
 * HOGPD FUNCTIONS
 ****************************************************************************************
 */

int in_ble_hogpd_add(void *hdl, ble_hogp_prf_t *p_prf, comp_cb callback);

int in_ble_hogpd_enable(void *hdl, int conidx, uint16_t ntf_cfg[], comp_cb callback);

int in_ble_hogpd_report_upd_req(void *hdl, int conidx, ble_hogpd_report_info_t *p_info, comp_cb callback);

int in_ble_hogpd_report_req_cfm(void *hdl, int conidx, int operation, int status, ble_hogpd_report_info_t *p_info);

int in_ble_hogpd_proto_mode_req_cfm(void *hdl, int conidx, int status, int hid_idx, int proto_mode);

/*
 * HOGPRH FUNCTIONS
 ****************************************************************************************
 */

int in_ble_hogprh_add(void *hdl, ble_hogp_prf_t *p_prf, comp_cb callback);

int in_ble_hogprh_enable(void *hdl, int conidx, int con_type, int hids_nb, ble_hogprh_content_t cont[], comp_cb callback);

int in_ble_hogprh_read_info_req(void *hdl, int conidx, ble_hogprh_read_info_req_t *p_req, ble_hogprh_read_info_rsp_t *p_rsp, comp_cb callback); 

int in_ble_hogprh_write_req(void *hdl, int conidx, ble_hogprh_write_req_t *p_req, comp_cb callback) ;

#endif