-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathcy_ble_tps.h
205 lines (157 loc) · 7.92 KB
/
cy_ble_tps.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/***************************************************************************//**
* \file cy_ble_tps.h
* \version 3.60
*
* \brief
* This file contains the function prototypes and constants used in the Tx
* Power service.
*
********************************************************************************
* \copyright
* Copyright 2017-2021, Cypress Semiconductor Corporation. All rights reserved.
* You may use this file only in accordance with the license, terms, conditions,
* disclaimers, and limitations in the end user license agreement accompanying
* the software package with which this file was provided.
*******************************************************************************/
#ifndef CY_BLE_TPS_H
#define CY_BLE_TPS_H
#include "cy_ble.h"
#if defined(CY_IP_MXBLESS)
/* C binding of definitions if building with C++ compiler */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*******************************************************************************
* API Constants
*******************************************************************************/
/* Maximum supported Tx Power Services */
#define CY_BLE_TPS_SERVICE_COUNT (1u)
#define CY_BLE_TPS_TX_POWER_LEVEL_SIZE (1u)
/*******************************************************************************
* Data Types
*******************************************************************************/
/**
* \addtogroup group_ble_service_api_TPS_definitions
* \{
*/
/** TPS Characteristic indexes */
typedef enum
{
CY_BLE_TPS_TX_POWER_LEVEL, /**< Tx Power Level Characteristic index */
CY_BLE_TPS_CHAR_COUNT /**< Total Count of Characteristics */
} cy_en_ble_tps_char_index_t;
/** TPS Characteristic Descriptors indexes */
typedef enum
{
CY_BLE_TPS_CCCD, /**< Tx Power Level Client Characteristic configuration descriptor index */
CY_BLE_TPS_DESCR_COUNT /**< Total Count of Tx Power Service Characteristic descriptors */
} cy_en_ble_tps_char_descriptors_t;
/** Tx Power Service Characteristic Value parameter structure */
typedef struct
{
cy_stc_ble_conn_handle_t connHandle; /**< Connection handle */
cy_en_ble_tps_char_index_t charIndex; /**< Characteristic index of Tx Power Service */
cy_stc_ble_gatt_value_t *value; /**< Pointer to value of Tx Power Service Characteristic */
} cy_stc_ble_tps_char_value_t;
/** Tx Power Service Characteristic descriptor Value parameter structure */
typedef struct
{
cy_stc_ble_conn_handle_t connHandle; /**< Connection handle */
cy_en_ble_tps_char_index_t charIndex; /**< Characteristic index of Tx Power Service */
cy_en_ble_tps_char_descriptors_t descrIndex; /**< Characteristic index Descriptor of Tx Power Service */
cy_stc_ble_gatt_value_t *value; /**< Pointer to value of Tx Power Service Characteristic */
} cy_stc_ble_tps_descr_value_t;
/** Structure with Tx Power Service attribute handles */
typedef struct
{
/** Tx Power Service Handle */
cy_ble_gatt_db_attr_handle_t serviceHandle;
/** Tx Power Level Characteristic handle */
cy_ble_gatt_db_attr_handle_t txPowerLevelCharHandle;
/** Tx Power Level Client Characteristic Configuration Descriptor handle */
cy_ble_gatt_db_attr_handle_t txPowerLevelCccdHandle;
} cy_stc_ble_tpss_t;
/** Structure with Discovered Attributes Information of Tx Power Service */
typedef struct
{
/** Tx Power Level Characteristic handle */
cy_stc_ble_srvr_char_info_t txPowerLevelChar;
/** Tx Power Level Client Characteristic Configuration Descriptor handle */
cy_ble_gatt_db_attr_handle_t txPowerLevelCccdHandle;
} cy_stc_ble_tpsc_t;
/** Service configuration structure (server) */
typedef struct
{
/** Service GATT DB Handles structure */
const cy_stc_ble_tpss_t *attrInfo;
} cy_stc_ble_tpss_config_t;
/** Service Configuration structure (client) */
typedef struct
{
/** Structure with Discovered Attributes Information */
cy_stc_ble_tpsc_t *attrInfo;
/** The Discovery Service index */
uint8_t serviceDiscIdx;
} cy_stc_ble_tpsc_config_t;
/** \} */
/*******************************************************************************
* Function Prototypes
*******************************************************************************/
/** \addtogroup group_ble_service_api_TPS_server_client
* \{
*/
cy_en_ble_api_result_t Cy_BLE_TPSS_Init(const cy_stc_ble_tpss_config_t *config);
cy_en_ble_api_result_t Cy_BLE_TPSC_Init(const cy_stc_ble_tpsc_config_t *config);
void Cy_BLE_TPS_RegisterAttrCallback(cy_ble_callback_t callbackFunc);
/** \} */
/**
* \addtogroup group_ble_service_api_TPS_server
* \{
*/
cy_en_ble_api_result_t Cy_BLE_TPSS_SetCharacteristicValue(cy_en_ble_tps_char_index_t charIndex, uint8_t attrSize,
int8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_TPSS_GetCharacteristicValue(cy_en_ble_tps_char_index_t charIndex, uint8_t attrSize,
int8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_TPSS_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_tps_char_index_t charIndex,
cy_en_ble_tps_char_descriptors_t descrIndex,
uint8_t attrSize, uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_TPSS_SendNotification(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_tps_char_index_t charIndex, uint8_t attrSize,
int8_t *attrValue);
/** \} */
/**
* \addtogroup group_ble_service_api_TPS_client
* \{
*/
cy_en_ble_api_result_t Cy_BLE_TPSC_GetCharacteristicValue(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_tps_char_index_t charIndex);
cy_en_ble_api_result_t Cy_BLE_TPSC_SetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_tps_char_index_t charIndex,
cy_en_ble_tps_char_descriptors_t descrIndex,
uint8_t attrSize, uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_TPSC_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_tps_char_index_t charIndex,
cy_en_ble_tps_char_descriptors_t descrIndex);
/** \} */
/*******************************************************************************
* Private Function Prototypes
*******************************************************************************/
/** \cond IGNORE */
cy_ble_gatt_db_attr_handle_t Cy_BLE_TPSC_GetCharacteristicValueHandle(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_tps_char_index_t charIndex);
cy_ble_gatt_db_attr_handle_t Cy_BLE_TPSC_GetCharacteristicDescriptorHandle(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_tps_char_index_t charIndex,
cy_en_ble_tps_char_descriptors_t descrIndex);
/** \endcond */
/*******************************************************************************
* External Data references
*******************************************************************************/
extern const cy_stc_ble_tpss_config_t *cy_ble_tpssConfigPtr;
extern const cy_stc_ble_tpsc_config_t *cy_ble_tpscConfigPtr;
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CY_IP_MXBLESS */
#endif /* CY_BLE_TPS_H */
/* [] END OF FILE */