Cordio Stack and Cordio Profiles  r2p3-02rel0
dis_api.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Device information service client.
6  *
7  * Copyright (c) 2012-2018 Arm Ltd. All Rights Reserved.
8  * Arm Ltd. confidential and proprietary.
9  *
10  * IMPORTANT. Your use of this file is governed by a Software License Agreement
11  * ("Agreement") that must be accepted in order to download or otherwise receive a
12  * copy of this file. You may not use or copy this file for any purpose other than
13  * as described in the Agreement. If you do not agree to all of the terms of the
14  * Agreement do not use this file and delete all copies in your possession or control;
15  * if you do not have a copy of the Agreement, you must contact Arm Ltd. prior
16  * to any use, copying or further distribution of this software.
17  */
18 /*************************************************************************************************/
19 #ifndef DIS_API_H
20 #define DIS_API_H
21 
22 #include "att_api.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*! \addtogroup DEVICE_INFORMATION_PROFILE
29  * \{ */
30 
31 /**************************************************************************************************
32  Macros
33 **************************************************************************************************/
34 
35 /*! \brief Enumeration of handle indexes of characteristics to be discovered */
36 enum
37 {
38  DIS_MFNS_HDL_IDX, /*!< \brief Manufacturer name string */
39  DIS_MNS_HDL_IDX, /*!< \brief Model number string */
40  DIS_SNS_HDL_IDX, /*!< \brief Serial number string */
41  DIS_HRS_HDL_IDX, /*!< \brief Hardware revision string */
42  DIS_FRS_HDL_IDX, /*!< \brief Firmware revision string */
43  DIS_SRS_HDL_IDX, /*!< \brief Software revision string */
44  DIS_SID_HDL_IDX, /*!< \brief System ID */
45  DIS_HDL_LIST_LEN /*!< \brief Handle list length */
46 };
47 
48 /**************************************************************************************************
49  Function Declarations
50 **************************************************************************************************/
51 
52 /*************************************************************************************************/
53 /*!
54  * \brief Perform service and characteristic discovery for DIS service. Note that pHdlList
55  * must point to an array of handles of length \ref DIS_HDL_LIST_LEN. If discovery is
56  * successful the handles of discovered characteristics and descriptors will be set
57  * in pHdlList.
58  *
59  * \param connId Connection identifier.
60  * \param pHdlList Characteristic handle list.
61  *
62  * \return None.
63  */
64 /*************************************************************************************************/
65 void DisDiscover(dmConnId_t connId, uint16_t *pHdlList);
66 
67 /*************************************************************************************************/
68 /*!
69  * \brief Process a value received in an ATT read response, notification, or indication
70  * message. Parameter pHdlList must point to an array of length \ref DIS_HDL_LIST_LEN.
71  * If the attribute handle of the message matches a handle in the handle list the value
72  * is processed, otherwise it is ignored.
73  *
74  * \param pHdlList Characteristic handle list.
75  * \param pMsg ATT callback message.
76  *
77  * \return \ref ATT_SUCCESS if handle is found, \ref ATT_ERR_NOT_FOUND otherwise.
78  */
79 /*************************************************************************************************/
80 uint8_t DisValueUpdate(uint16_t *pHdlList, attEvt_t *pMsg);
81 
82 /*! \} */ /* DEVICE_INFORMATION_PROFILE */
83 
84 #ifdef __cplusplus
85 };
86 #endif
87 
88 #endif /* DIS_API_H */
Handle list length.
Definition: dis_api.h:45
uint8_t dmConnId_t
Connection identifier.
Definition: dm_api.h:501
uint8_t DisValueUpdate(uint16_t *pHdlList, attEvt_t *pMsg)
Process a value received in an ATT read response, notification, or indication message. Parameter pHdlList must point to an array of length DIS_HDL_LIST_LEN. If the attribute handle of the message matches a handle in the handle list the value is processed, otherwise it is ignored.
ATT callback event.
Definition: att_api.h:154
Firmware revision string.
Definition: dis_api.h:42
Serial number string.
Definition: dis_api.h:40
Model number string.
Definition: dis_api.h:39
Software revision string.
Definition: dis_api.h:43
unsigned short uint16_t
Unsigned 16-bit value.
Definition: wsf_types.h:67
void DisDiscover(dmConnId_t connId, uint16_t *pHdlList)
Perform service and characteristic discovery for DIS service. Note that pHdlList must point to an arr...
Hardware revision string.
Definition: dis_api.h:41
Attribute protocol client and server API.
Manufacturer name string.
Definition: dis_api.h:38
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63
System ID.
Definition: dis_api.h:44