Cordio Stack and Cordio Profiles  r2p3-02rel0
wpc_api.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Arm Ltd. proprietary profile 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 WPC_API_H
20 #define WPC_API_H
21 
22 #include "att_api.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*! \addtogroup ARM_LTD_PROPRIETARY_PROFILE
29  * \{ */
30 
31 /**************************************************************************************************
32  Macros
33 **************************************************************************************************/
34 
35 /*! \brief Arm Ltd. proprietary service P1 enumeration of handle indexes of characteristics to be discovered */
36 enum
37 {
38  WPC_P1_DAT_HDL_IDX, /*!< \brief Proprietary data */
39  WPC_P1_NA_CCC_HDL_IDX, /*!< \brief Proprietary data client characteristic configuration descriptor */
40  WPC_P1_HDL_LIST_LEN /*!< \brief Handle list length */
41 };
42 
43 /**************************************************************************************************
44  Function Declarations
45 **************************************************************************************************/
46 
47 /*************************************************************************************************/
48 /*!
49  * \brief Perform service and characteristic discovery for Arm Ltd. proprietary service P1.
50  * Parameter pHdlList must point to an array of length \ref WPC_P1_HDL_LIST_LEN.
51  * If discovery is successful the handles of discovered characteristics and
52  * descriptors will be set in pHdlList.
53  *
54  * \param connId Connection identifier.
55  * \param pHdlList Characteristic handle list.
56  *
57  * \return None.
58  */
59 /*************************************************************************************************/
60 void WpcP1Discover(dmConnId_t connId, uint16_t *pHdlList);
61 
62 /*! \} */ /* ARM_LTD_PROPRIETARY_PROFILE */
63 
64 #ifdef __cplusplus
65 };
66 #endif
67 
68 #endif /* WPC_API_H */
uint8_t dmConnId_t
Connection identifier.
Definition: dm_api.h:501
Handle list length.
Definition: wpc_api.h:40
Proprietary data.
Definition: wpc_api.h:38
void WpcP1Discover(dmConnId_t connId, uint16_t *pHdlList)
Perform service and characteristic discovery for Arm Ltd. proprietary service P1. Parameter pHdlList ...
Proprietary data client characteristic configuration descriptor.
Definition: wpc_api.h:39
unsigned short uint16_t
Unsigned 16-bit value.
Definition: wsf_types.h:67
Attribute protocol client and server API.