dis.h File Reference

Device Information Service API. More...

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

Go to the source code of this file.

Classes

struct  dis_string_t
 UTF-8 string data type. More...
 
struct  dis_sys_id_t
 System ID parameters. More...
 
struct  dis_reg_cert_data_list_t
 IEEE 11073-20601 Regulatory Certification Data List Structure. More...
 
struct  dis_pnp_id_t
 PnP ID parameters. More...
 
struct  dis_init_t
 Device Information Service init structure. More...
 

Macros

#define DIS_CONNECTION_MAX   10
 Maximum number of DIS connections.The value is configurable. More...
 
#define DIS_SYS_ID_LEN   8
 System ID length. More...
 
#define DIS_PNP_ID_LEN   7
 PnP ID length. More...
 
#define DIS_VAL_MAX_LEN   128
 Maximal length for Characteristic values - 128 bytes. More...
 
#define DIS_IEEE_CERTIF_MIN_LEN   6
 IEEE Certification length (min 6 bytes). More...
 
#define DIS_CHAR_SYSTEM_ID_SUP   0x00000006
 Bit mask of the System ID. More...
 
#define DIS_CHAR_MODEL_NUMBER_SUP   0x00000018
 Bit mask of the Model Number. More...
 
#define DIS_CHAR_SERIAL_NUMBER_SUP   0x00000060
 Bit mask of the Serial Number. More...
 
#define DIS_CHAR_FIRMWARE_REV_SUP   0x00000180
 Bit mask of the Firmware Revision. More...
 
#define DIS_CHAR_HARDWARE_REV_SUP   0x00000600
 Bit mask of the Hardware Revision. More...
 
#define DIS_CHAR_SOFTWARE_REV_SUP   0x00001800
 Bit mask of the Software Revision. More...
 
#define DIS_CHAR_MANUFACTURER_NAME_SUP   0x00006000
 Bit mask of the Manufacturer Name. More...
 
#define DIS_CHAR_11073_CERT_DATA_SUP   0x00018000
 Bit mask of the IEEE 11073-20601 Regulatory Certification Data List. More...
 
#define DIS_CHAR_PNP_ID_SUP   0x00060000
 Bit mask of the PnP ID. More...
 
#define DIS_CHAR_FULL   0x0007ffff
 Bit mask of the full characteristic. More...
 
#define DIS_11073_BODY_EMPTY   0
 Empty body type. More...
 
#define DIS_11073_BODY_IEEE   1
 IEEE body type. More...
 
#define DIS_11073_BODY_CONTINUA   2
 Continua body type. More...
 
#define DIS_11073_BODY_EXP   254
 Exp body type. More...
 

Functions

sdk_err_t dis_service_init (dis_init_t *p_dis_init)
 Initialize a Device Information Service instance and add in the database. More...
 
uint16_t dis_service_start_handle_get (void)
 Provide the interface for other modules to obtain the dis service start handle . More...
 

Detailed Description

Device Information 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 dis.h.