-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathcy_ble_scps.h
193 lines (154 loc) · 8.39 KB
/
cy_ble_scps.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
/***************************************************************************//**
* \file cy_ble_scps.h
* \version 3.60
*
* \brief
* Contains the function prototypes and constants for the Scan Parameter 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_SCPS_H
#define CY_BLE_SCPS_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
*******************************************************************************/
#define CY_BLE_SCAN_REFRESH_ENABLED (0x00u)
#define CY_BLE_SCAN_REFRESH_RESERVED (0xFFu)
#define CY_BLE_REFRESH_CHAR_LEN (0x01u)
#define CY_BLE_INTERVAL_WINDOW_CHAR_LEN (0x04u)
#define CY_BLE_SCAN_INTERVAL_WINDOW_MIN (0x0004u)
#define CY_BLE_SCAN_INTERVAL_WINDOW_MAX (0x4000u)
/*******************************************************************************
* Data Types
*******************************************************************************/
/**
* \addtogroup group_ble_service_api_SCPS_definitions
* \{
*/
/** SCPS Characteristic indexes */
typedef enum
{
CY_BLE_SCPS_SCAN_INT_WIN, /**< Scan Interval Window Characteristic index */
CY_BLE_SCPS_SCAN_REFRESH, /**< Scan Refresh Characteristic index */
CY_BLE_SCPS_CHAR_COUNT /**< Total Count of Characteristics */
} cy_en_ble_scps_char_index_t;
/** ScPS Characteristic Descriptors indexes */
typedef enum
{
CY_BLE_SCPS_SCAN_REFRESH_CCCD, /**< Client Characteristic Configuration descriptor index */
CY_BLE_SCPS_DESCR_COUNT /**< Total Count of Descriptors */
} cy_en_ble_scps_descr_index_t;
/** Structure with Scan Parameters Service attribute handles */
typedef struct
{
cy_ble_gatt_db_attr_handle_t serviceHandle; /**< Scan Parameter Service Handle*/
cy_ble_gatt_db_attr_handle_t intervalWindowCharHandle; /**< Handle of Scan Interval Window Characteristic */
cy_ble_gatt_db_attr_handle_t refreshCharHandle; /**< Handle of Scan Refresh Characteristic */
cy_ble_gatt_db_attr_handle_t refreshCccdHandle; /**< Handle of Client Characteristic Configuration Descriptor */
} cy_stc_ble_scpss_t;
/** Structure with Discovered Attributes Information of Scan Parameters Service */
typedef struct
{
cy_stc_ble_conn_handle_t connHandle; /**< Peer Device Handle */
cy_stc_ble_srvr_char_info_t intervalWindowChar; /**< Handle + properties of Scan Interval Window Characteristic */
cy_stc_ble_srvr_char_info_t refreshChar; /**< Handle + properties of Scan Refresh Characteristic */
cy_ble_gatt_db_attr_handle_t refreshCccdHandle; /**< Handle of Client Characteristic Configuration Descriptor */
} cy_stc_ble_scpsc_t;
/** Scan Parameters Service Characteristic Value parameter structure */
typedef struct
{
cy_stc_ble_conn_handle_t connHandle; /**< Peer Device Handle */
cy_en_ble_scps_char_index_t charIndex; /**< Index of Service Characteristic */
cy_stc_ble_gatt_value_t *value; /**< Characteristic Value */
} cy_stc_ble_scps_char_value_t;
/** Scan Parameters Service Characteristic descriptor Value parameter structure */
typedef struct
{
cy_stc_ble_conn_handle_t connHandle; /**< Peer Device Handle */
cy_en_ble_scps_char_index_t charIndex; /**< Index of Service Characteristic */
cy_en_ble_scps_descr_index_t descrIndex; /**< Index of Service Characteristic descriptor */
cy_stc_ble_gatt_value_t *value; /**< Descriptor value */
} cy_stc_ble_scps_descr_value_t;
/** Service configuration structure (server) */
typedef struct
{
/** Service GATT DB Handles structure */
const cy_stc_ble_scpss_t *attrInfo;
} cy_stc_ble_scpss_config_t;
/** Service Configuration structure (client) */
typedef struct
{
/** Structure with Discovered Attributes Information */
cy_stc_ble_scpsc_t *attrInfo;
/** The Discovery Service index */
uint8_t serviceDiscIdx;
} cy_stc_ble_scpsc_config_t;
/** \} */
/*******************************************************************************
* Function Prototypes
*******************************************************************************/
/** \addtogroup group_ble_service_api_SCPS_server_client
* \{
*/
cy_en_ble_api_result_t Cy_BLE_SCPSS_Init(const cy_stc_ble_scpss_config_t *config);
cy_en_ble_api_result_t Cy_BLE_SCPSC_Init(const cy_stc_ble_scpsc_config_t *config);
void Cy_BLE_SCPS_RegisterAttrCallback(cy_ble_callback_t callbackFunc);
/** \} */
/**
* \addtogroup group_ble_service_api_SCPS_server
* \{
*/
cy_en_ble_api_result_t Cy_BLE_SCPSS_SetCharacteristicValue(cy_en_ble_scps_char_index_t charIndex,
uint8_t attrSize, uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_SCPSS_GetCharacteristicValue(cy_en_ble_scps_char_index_t charIndex,
uint8_t attrSize, uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_SCPSS_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_scps_char_index_t charIndex,
cy_en_ble_scps_descr_index_t descrIndex,
uint8_t attrSize, uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_SCPSS_SendNotification(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_scps_char_index_t charIndex, uint8_t attrSize,
uint8_t *attrValue);
/** \} */
/**
* \addtogroup group_ble_service_api_SCPS_client
* \{
*/
cy_en_ble_api_result_t Cy_BLE_SCPSC_SetCharacteristicValue(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_scps_char_index_t charIndex, uint8_t attrSize,
uint8_t * attrValue);
cy_en_ble_api_result_t Cy_BLE_SCPSC_SetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_scps_char_index_t charIndex,
cy_en_ble_scps_descr_index_t descrIndex,
uint8_t attrSize, uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_SCPSC_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_scps_char_index_t charIndex,
cy_en_ble_scps_descr_index_t descrIndex);
/** \} */
cy_ble_gatt_db_attr_handle_t Cy_BLE_SCPSC_GetCharacteristicValueHandle(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_scps_char_index_t charIndex);
cy_ble_gatt_db_attr_handle_t Cy_BLE_SCPSC_GetCharacteristicDescriptorHandle(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_scps_char_index_t charIndex,
cy_en_ble_scps_descr_index_t descrIndex);
/*******************************************************************************
* External Data references
*******************************************************************************/
extern const cy_stc_ble_scpss_config_t *cy_ble_scpssConfigPtr;
extern const cy_stc_ble_scpsc_config_t *cy_ble_scpscConfigPtr;
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CY_IP_MXBLESS */
#endif /* CY_BLE_SCPH_H */
/* [] END OF FILE */