hids.h File Reference

Human Interface Device Service API. More...

#include "ble_prf_utils.h"
#include "gr_includes.h"
#include "custom_config.h"
#include <stdint.h>
+ Include dependency graph for hids.h:

Go to the source code of this file.

Classes

struct  hids_evt_t
 HID Service event. More...
 
struct  hids_hid_info_t
 HID Information characteristic value. More...
 
struct  hids_report_ref_t
 Value of a Report Reference descriptor. More...
 
struct  hids_report_int_t
 HID Service Report characteristic define. More...
 
struct  hids_report_map_t
 HID Service Report Map characteristic value. More...
 
struct  hids_init_t
 HID Service initialization variable. More...
 

Macros

#define HIDS_CONNECTION_MAX   10
 Maximum number of Heart Rate Service connections. More...
 
#define HIDS_REPORT_MAX_SIZE   20
 Maximum length of report. More...
 
#define HIDS_REPORT_MAP_MAX_SIZE   512
 Limitation of length, as per Section 2.6.1 in HIDS Spec, version 1.0. More...
 
#define HIDS_REP_TYPE_INPUT   1
 The input report type. More...
 
#define HIDS_REP_TYPE_OUTPUT   2
 The output report type. More...
 
#define HIDS_REP_TYPE_FEATURE   3
 The feature report type. More...
 
#define HID_INFO_FLAG_REMOTE_WAKE_MSK   0x01
 Bit mask of Remote Wake flag in HIDS information. More...
 
#define HID_INFO_FLAG_NORMALLY_CONNECTABLE_MSK   0x02
 Bit mask of Normally Connectable flag in HIDS information. More...
 

Typedefs

typedef void(* hids_evt_handler_t) (hids_evt_t *p_evt)
 HID Service event handler type. More...
 

Enumerations

enum  hids_evt_type_t {
  HIDS_EVT_INVALID, HIDS_EVT_IN_REP_NOTIFY_ENABLED, HIDS_EVT_IN_REP_NOTIFY_DISABLED, HIDS_EVT_HOST_SUSP,
  HIDS_EVT_HOST_EXIT_SUSP, HIDS_EVT_BOOT_MODE_ENTERED, HIDS_EVT_REPORT_MODE_ENTERED, HIDS_EVT_REP_CHAR_WRITE
}
 HID Service event type. More...
 
enum  hids_report_type_t {
  HIDS_REPORT_TYPE_RESERVED, HIDS_REPORT_TYPE_IN1, HIDS_REPORT_TYPE_IN2, HIDS_REPORT_TYPE_IN3,
  HIDS_REPORT_TYPE_OUT, HIDS_REPORT_TYPE_FEATURE, HIDS_REPORT_TYPE_KB_IN, HIDS_REPORT_TYPE_KB_OUT,
  HIDS_REPORT_TYPE_MOUSE_IN
}
 HID Service write report type. More...
 

Functions

sdk_err_t hids_service_init (hids_init_t *p_hids_init)
 Initialize a HID Service instance in ATT DB. More...
 
sdk_err_t hids_input_rep_send (uint8_t conn_idx, uint8_t rep_idx, uint8_t *p_data, uint16_t length)
 Send an input report. More...
 
sdk_err_t hids_boot_kb_in_rep_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Send boot keyboard input report. More...
 
sdk_err_t hids_boot_mouse_in_rep_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Send boot mouse input report. More...
 
uint16_t hids_service_start_handle_get (void)
 Provide the interface for other modules to obtain the hids service start handle . More...
 

Detailed Description

Human Interface Device Service API.

Attention
Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form 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. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND 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.

Definition in file hids.h.