hogp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_HOGP_H_
#define BT_HOGP_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/bluetooth/gatt.h>
#include <zephyr/bluetooth/conn.h>
#include <bluetooth/gatt_dm.h>
#include <bluetooth/services/hids.h>
 
struct bt_hogp;
struct bt_hogp_rep_info;
 
typedef uint8_t (*bt_hogp_read_cb)(struct bt_hogp *hogp,
                                   struct bt_hogp_rep_info *rep,
                                   uint8_t err,
                                   const uint8_t *data);
 
typedef void (*bt_hogp_write_cb)(struct bt_hogp *hogp,
                                 struct bt_hogp_rep_info *rep,
                                 uint8_t err);
 
typedef void (*bt_hogp_ready_cb)(struct bt_hogp *hogp);
 
typedef void (*bt_hogp_prep_fail_cb)(struct bt_hogp *hogp,
                                            int err);
 
typedef void (*bt_hogp_map_cb)(struct bt_hogp *hogp, uint8_t err,
                               const uint8_t *data, size_t size, size_t offset);
 
typedef void (*bt_hogp_pm_update_cb)(struct bt_hogp *hogp);
 
struct bt_hogp_init_params {
        bt_hogp_ready_cb ready_cb;
        bt_hogp_prep_fail_cb prep_error_cb;
        bt_hogp_pm_update_cb pm_update_cb;
};
 
struct bt_hogp_rep_info;
 
typedef void (*bt_hogp_sci_mode_changed_cb)(struct bt_conn *conn,
                                            enum bt_hids_sci_mode_value mode);
 
typedef void (*bt_hogp_sci_mode_read_cb)(struct bt_hogp *hogp, int err,
                               enum bt_hids_sci_mode_value mode);
 
struct bt_hogp_sci_mode_data {
        bt_hogp_sci_mode_changed_cb notify_cb;
 
        struct bt_gatt_subscribe_params notify_params;
 
        bt_hogp_sci_mode_read_cb read_cb;
};
 
struct bt_hogp_sci_info {
        uint8_t min_supported_conn_interval_125us;
 
        uint8_t num_groups;
 
        struct bt_conn_le_min_conn_interval_group groups[BT_CONN_LE_MAX_CONN_INTERVAL_GROUPS];
};
 
struct bt_hogp {
        struct bt_conn *conn;
        struct bt_hids_info info_val;
 
#if defined(CONFIG_BT_HOGP_SCI)
        struct bt_hogp_sci_mode_data sci_mode_data;
 
        struct bt_hogp_sci_info sci_info;
#endif
 
        struct bt_hogp_handlers {
                uint16_t pm;
                uint16_t rep_map;
                uint16_t info;
                uint16_t cp;
#if defined(CONFIG_BT_HOGP_SCI)
                uint16_t sci_info;
                uint16_t sci_mode;
                uint16_t sci_mode_ccc;
#endif
        } handlers;
        bt_hogp_ready_cb ready_cb;
        bt_hogp_prep_fail_cb prep_error_cb;
        bt_hogp_pm_update_cb pm_update_cb;
        bt_hogp_map_cb map_cb;
        struct bt_gatt_read_params read_params;
 
        struct k_sem read_params_sem;
 
        struct {
                uint8_t rep_idx;
        } init_repref;
 
        struct {
                struct bt_hogp_rep_info *kbd_inp;
                struct bt_hogp_rep_info *kbd_out;
                struct bt_hogp_rep_info *mouse_inp;
        } rep_boot;
        struct bt_hogp_rep_info **rep_info;
        uint8_t rep_count;
        bool ready;
        enum bt_hids_pm pm;
};
 
void bt_hogp_init(struct bt_hogp *hogp,
                  const struct bt_hogp_init_params *params);
 
int bt_hogp_handles_assign(struct bt_gatt_dm *dm, struct bt_hogp *hogp);
 
void bt_hogp_release(struct bt_hogp *hogp);
 
void bt_hogp_abort_all(struct bt_hogp *hogp);
 
bool bt_hogp_assign_check(const struct bt_hogp *hogp);
 
bool bt_hogp_ready_check(const struct bt_hogp *hogp);
 
int bt_hogp_rep_read(struct bt_hogp *hogp,
                     struct bt_hogp_rep_info *rep,
                     bt_hogp_read_cb func);
 
int bt_hogp_rep_write(struct bt_hogp *hogp,
                      struct bt_hogp_rep_info *rep,
                      bt_hogp_write_cb func,
                      const void *data, uint8_t length);
 
int bt_hogp_rep_write_wo_rsp(struct bt_hogp *hogp,
                             struct bt_hogp_rep_info *rep,
                             const void *data, uint8_t length,
                             bt_hogp_write_cb func);
 
int bt_hogp_rep_subscribe(struct bt_hogp *hogp,
                          struct bt_hogp_rep_info *rep,
                          bt_hogp_read_cb func);
 
int bt_hogp_rep_unsubscribe(struct bt_hogp *hogp,
                            struct bt_hogp_rep_info *rep);
 
int bt_hogp_map_read(struct bt_hogp *hogp,
                     bt_hogp_map_cb func,
                     size_t offset,
                     k_timeout_t timeout);
 
int bt_hogp_pm_update(struct bt_hogp *hogp, k_timeout_t timeout);
 
enum bt_hids_pm bt_hogp_pm_get(const struct bt_hogp *hogp);
 
int bt_hogp_pm_write(struct bt_hogp *hogp, enum bt_hids_pm pm);
 
int bt_hogp_suspend(struct bt_hogp *hogp);
 
int bt_hogp_exit_suspend(struct bt_hogp *hogp);
 
bool bt_hogp_sci_supported(const struct bt_hogp *hogp);
 
bool bt_hogp_sci_low_power_mode_supported(const struct bt_hogp *hogp);
 
int bt_hogp_sci_mode_read(struct bt_hogp *hogp, bt_hogp_sci_mode_read_cb func);
 
int bt_hogp_sci_mode_req(struct bt_hogp *hogp, enum bt_hids_sci_mode_value mode);
 
int bt_hogp_sci_mode_subscribe(struct bt_hogp *hogp, bt_hogp_sci_mode_changed_cb func);
 
int bt_hogp_sci_mode_unsubscribe(struct bt_hogp *hogp);
 
int bt_hogp_sci_info_get(struct bt_hogp *hogp, struct bt_hogp_sci_info *sci_info);
 
struct bt_conn *bt_hogp_conn(const struct bt_hogp *hogp);
 
const struct bt_hids_info *bt_hogp_conn_info_val(const struct bt_hogp *hogp);
 
struct bt_hogp_rep_info *bt_hogp_rep_boot_kbd_in(struct bt_hogp *hogp);
 
struct bt_hogp_rep_info *bt_hogp_rep_boot_kbd_out(struct bt_hogp *hogp);
 
struct bt_hogp_rep_info *bt_hogp_rep_boot_mouse_in(struct bt_hogp *hogp);
 
size_t bt_hogp_rep_count(const struct bt_hogp *hogp);
 
struct bt_hogp_rep_info *bt_hogp_rep_next(struct bt_hogp *hogp,
                                          const struct bt_hogp_rep_info *rep);
 
struct bt_hogp_rep_info *bt_hogp_rep_find(struct bt_hogp *hogp,
                                          enum bt_hids_report_type type,
                                          uint8_t id);
 
void bt_hogp_rep_user_data_set(struct bt_hogp_rep_info *rep, void *data);
 
void *bt_hogp_rep_user_data(const struct bt_hogp_rep_info *rep);
 
uint8_t bt_hogp_rep_id(const struct bt_hogp_rep_info *rep);
 
enum bt_hids_report_type bt_hogp_rep_type(const struct bt_hogp_rep_info *rep);
 
size_t bt_hogp_rep_size(const struct bt_hogp_rep_info *rep);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BT_HOGP_H_ */