-
Notifications
You must be signed in to change notification settings - Fork 3
/
cy_ble_bas.c
1407 lines (1245 loc) · 61.5 KB
/
cy_ble_bas.c
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************//**
* \file cy_ble_bas.c
* \version 3.60
*
* \brief
* Contains the source code for the Battery 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.
*******************************************************************************/
#include "cy_ble_event_handler.h"
#if CY_BLE_LIB_HOST_CORE
/*******************************************************************************
* Global Variables
*******************************************************************************/
/* The pointers to the callback functions */
static cy_ble_callback_t Cy_BLE_BAS_ApplCallback = NULL;
static cy_ble_event_handler_cb_t Cy_BLE_BASC_EventHandlerCallback = NULL;
static cy_ble_event_handler_cb_t Cy_BLE_BASS_EventHandlerCallback = NULL;
/* The internal storage for the last request handle to check response */
static cy_ble_gatt_db_attr_handle_t cy_ble_bascReqHandle[CY_BLE_MAX_CONNECTION_INSTANCES];
/* The pointer to a global BLE BAS server config structure */
const cy_stc_ble_bass_config_t *cy_ble_bassConfigPtr = NULL;
/* The pointer to a global BLE BAS client config structure */
const cy_stc_ble_basc_config_t *cy_ble_bascConfigPtr = NULL;
/*******************************************************************************
* Private Function Prototypes
*******************************************************************************/
static cy_en_ble_gatt_err_code_t Cy_BLE_BAS_EventHandler(uint32_t eventCode, void *eventParam);
static cy_en_ble_gatt_err_code_t Cy_BLE_BASS_EventHandler(uint32_t eventCode, void *eventParam);
static cy_en_ble_gatt_err_code_t Cy_BLE_BASC_EventHandler(uint32_t eventCode, void *eventParam);
static cy_en_ble_gatt_err_code_t Cy_BLE_BASS_WriteEventHandler(const cy_stc_ble_gatts_write_cmd_req_param_t *eventParam);
static void Cy_BLE_BASC_DiscoverCharacteristicsEventHandler(cy_stc_ble_disc_char_info_t *discCharInfo);
static void Cy_BLE_BASC_DiscoverCharDescriptorsEventHandler(cy_stc_ble_disc_descr_info_t *discDescrInfo);
static void Cy_BLE_BASC_GetCharRange(cy_stc_ble_disc_range_info_t *charRangeInfo);
static void Cy_BLE_BASC_NotificationEventHandler(cy_stc_ble_gattc_handle_value_ntf_param_t *eventParam);
static void Cy_BLE_BASC_ReadResponseEventHandler(cy_stc_ble_gattc_read_rsp_param_t *eventParam);
static void Cy_BLE_BASC_WriteResponseEventHandler(const cy_stc_ble_conn_handle_t *eventParam);
static void Cy_BLE_BASC_ErrorResponseEventHandler(const cy_stc_ble_gatt_err_param_t *eventParam);
/******************************************************************************
* Function Name: Cy_BLE_BASS_Init
***************************************************************************//**
*
* This function initializes the server of the Battery service.
*
* \param config: Configuration structure for the BAS.
*
* \return
* \ref cy_en_ble_api_result_t : Return value indicates whether the function succeeded or
* failed. The following are possible error codes.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The function completed successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | On specifying NULL as input parameter.
* CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED | Buffer overflow in the registration callback.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASS_Init(const cy_stc_ble_bass_config_t *config)
{
cy_en_ble_api_result_t apiResult;
if(config == NULL)
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else
{
/* Registers a pointer to config structure */
cy_ble_bassConfigPtr = config;
/* Registers event handler for the BAS */
apiResult = Cy_BLE_RegisterServiceEventHandler(&Cy_BLE_BAS_EventHandler);
/* Registers a pointer to server event handler function */
Cy_BLE_BASS_EventHandlerCallback = &Cy_BLE_BASS_EventHandler;
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BASC_Init
***************************************************************************//**
*
* This function initializes client of the Battery service.
*
* \param config: Configuration structure for the BAS.
*
* \return
* \ref cy_en_ble_api_result_t : Return value indicates whether the function succeeded or
* failed. The following are possible error codes.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The function completed successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | On specifying NULL as input parameter.
* CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED | Buffer overflow in the registration callback.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASC_Init(const cy_stc_ble_basc_config_t *config)
{
cy_en_ble_api_result_t apiResult;
if((config == NULL) || ((cy_ble_configPtr->params->gattRole & CY_BLE_GATT_CLIENT) == 0u))
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else
{
uint32_t idx;
/* Registers a pointer to config structure */
cy_ble_bascConfigPtr = config;
/* Registers event handler for the BAS */
apiResult = Cy_BLE_RegisterServiceEventHandler(&Cy_BLE_BAS_EventHandler);
/* Registers a pointer to client event handler function */
Cy_BLE_BASC_EventHandlerCallback = &Cy_BLE_BASC_EventHandler;
for(idx = 0u; idx < cy_ble_configPtr->params->maxClientCount; idx++)
{
uint32_t locServIdx;
for(locServIdx = 0u; locServIdx < (uint32_t)cy_ble_bascConfigPtr->serviceCount; locServIdx++)
{
uint32 servCnt = cy_ble_configPtr->context->discServiCount;
uint32 basServIdx = cy_ble_bascConfigPtr->serviceDiscIdx + locServIdx;
if(cy_ble_configPtr->context->serverInfo[(idx * servCnt) + basServIdx].range.startHandle ==
CY_BLE_GATT_INVALID_ATTR_HANDLE_VALUE)
{
/* Get pointer to BAS client structure */
cy_stc_ble_basc_t *bascPtr = (cy_stc_ble_basc_t *)&cy_ble_bascConfigPtr->
attrInfo[(idx * cy_ble_bascConfigPtr->serviceCount) + locServIdx];
/* Clean client structure */
(void)memset(bascPtr, 0, sizeof(cy_stc_ble_basc_t));
/* Initialize uuid */
cy_ble_configPtr->context->serverInfo[(idx * servCnt) + basServIdx].uuid = CY_BLE_UUID_BAS_SERVICE;
}
}
cy_ble_bascReqHandle[idx] = CY_BLE_GATT_INVALID_ATTR_HANDLE_VALUE;
}
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BAS_RegisterAttrCallback
***************************************************************************//**
*
* Registers a callback function for service-specific attribute operations.
* Service-specific Write Requests from the peer device will not be handled with
* an unregistered callback function.
*
* \param callbackFunc: An application layer event callback function to receive
* events from the PSoC 6 BLE Middleware. The definition of \ref cy_ble_callback_t
* for BAS service is:<br>
* typedef void (* cy_ble_callback_t) (uint32_t eventCode, void *eventParam),
* where:
* * eventCode: Indicates the event that triggered this callback
* (e.g. #CY_BLE_EVT_BASS_NOTIFICATION_ENABLED).
* * eventParam: Contains the parameters corresponding to the
* current event; (e.g. pointer to \ref cy_stc_ble_bas_char_value_t
* structure that contains details of the characteristic
* for which the notification enabled event was triggered).
*
******************************************************************************/
void Cy_BLE_BAS_RegisterAttrCallback(cy_ble_callback_t callbackFunc)
{
Cy_BLE_BAS_ApplCallback = callbackFunc;
}
/******************************************************************************
* Function Name: Cy_BLE_BASS_SetCharacteristicValue
***************************************************************************//**
*
* Sets a characteristic value of the service, which is a value
* identified by charIndex, to the local database.
*
* \param serviceIndex: The index of the service instance.
*
* \param charIndex: The index of the service characteristic of type
* #cy_en_ble_bas_char_index_t.
*
* \param attrSize: The size of the characteristic value attribute.
* A battery level characteristic has a 1-byte length.
*
* \param attrValue: The pointer to the characteristic value data that
* should be stored to the GATT database.
*
* \return
* A return value of type \ref cy_en_ble_api_result_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The request was handled successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASS_SetCharacteristicValue(uint8_t serviceIndex,
cy_en_ble_bas_char_index_t charIndex,
uint8_t attrSize,
uint8_t *attrValue)
{
cy_en_ble_api_result_t apiResult = CY_BLE_SUCCESS;
if((serviceIndex >= cy_ble_bassConfigPtr->serviceCount) || (charIndex >= CY_BLE_BAS_CHAR_COUNT) ||
(attrSize != CY_BLE_BAS_BATTERY_LEVEL_LEN) || (*attrValue > CY_BLE_BAS_MAX_BATTERY_LEVEL_VALUE))
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else
{
/* Store data in the database */
cy_stc_ble_gatts_db_attr_val_info_t dbAttrValInfo;
dbAttrValInfo.connHandle.bdHandle = 0u;
dbAttrValInfo.connHandle.attId = 0u;
dbAttrValInfo.handleValuePair.attrHandle = cy_ble_bassConfigPtr->attrInfo[serviceIndex].batteryLevelHandle;
dbAttrValInfo.handleValuePair.value.len = attrSize;
dbAttrValInfo.handleValuePair.value.val = attrValue;
dbAttrValInfo.offset = 0u;
dbAttrValInfo.flags = CY_BLE_GATT_DB_LOCALLY_INITIATED;
if(Cy_BLE_GATTS_WriteAttributeValueCCCD(&dbAttrValInfo) != CY_BLE_GATT_ERR_NONE)
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BASS_GetCharacteristicValue
***************************************************************************//**
*
* Gets a characteristic value of the Battery service, identified by charIndex.
*
* \param serviceIndex: The index of the service instance; e.g. if two Battery
* services are supported in your design, then the first
* service will be identified by serviceIndex of 0 and the
* second service by serviceIndex of 1.
*
* \param charIndex: The index of a service characteristic of type
* \ref cy_en_ble_bas_char_index_t.
*
* \param attrSize: The size of the characteristic value attribute. A
* battery-level characteristic has a 1-byte length.
*
* \param attrValue: The pointer to the location where characteristic value
* data should be stored.
*
* \return
* A return value of type \ref cy_en_ble_api_result_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The characteristic value was read successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASS_GetCharacteristicValue(uint8_t serviceIndex,
cy_en_ble_bas_char_index_t charIndex,
uint8_t attrSize,
uint8_t *attrValue)
{
cy_en_ble_api_result_t apiResult = CY_BLE_SUCCESS;
if((serviceIndex >= cy_ble_bassConfigPtr->serviceCount) || (charIndex >= CY_BLE_BAS_CHAR_COUNT) ||
(attrSize != CY_BLE_BAS_BATTERY_LEVEL_LEN))
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else
{
/* Read characteristic value from database */
cy_stc_ble_gatts_db_attr_val_info_t dbAttrValInfo;
dbAttrValInfo.connHandle.bdHandle = 0u;
dbAttrValInfo.connHandle.attId = 0u;
dbAttrValInfo.handleValuePair.attrHandle = cy_ble_bassConfigPtr->attrInfo[serviceIndex].batteryLevelHandle;
dbAttrValInfo.handleValuePair.value.len = attrSize;
dbAttrValInfo.handleValuePair.value.val = attrValue;
dbAttrValInfo.offset = 0u;
dbAttrValInfo.flags = CY_BLE_GATT_DB_LOCALLY_INITIATED;
if(Cy_BLE_GATTS_ReadAttributeValueCCCD(&dbAttrValInfo) != CY_BLE_GATT_ERR_NONE)
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BASS_GetCharacteristicDescriptor
***************************************************************************//**
*
* Gets a characteristic descriptor of a specified characteristic of the
* Battery service from the local GATT database.
*
* \param connHandle: The BLE peer device connection handle.
*
* \param serviceIndex: The index of the service instance; e.g. if two Battery
* services are supported in your design, then the first
* service will be identified by serviceIndex of 0 and the
* second service by serviceIndex of 1.
*
* \param charIndex: The index of a service characteristic of type
* \ref cy_en_ble_bas_char_index_t.
*
* \param descrIndex: The index of a service characteristic descriptor of type
* \ref cy_en_ble_bas_descr_index_t.
*
* \param attrSize: The size of the characteristic descriptor attribute.
*
* \param attrValue: The pointer to the location where the characteristic
* descriptor value data should be stored.
*
* \return
* A return value of type \ref cy_en_ble_api_result_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The characteristic descriptor value was read successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASS_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
uint8_t serviceIndex,
cy_en_ble_bas_char_index_t charIndex,
cy_en_ble_bas_descr_index_t descrIndex,
uint8_t attrSize,
uint8_t *attrValue)
{
cy_en_ble_api_result_t apiResult = CY_BLE_SUCCESS;
if((serviceIndex >= cy_ble_bassConfigPtr->serviceCount) || (charIndex >= CY_BLE_BAS_CHAR_COUNT) ||
(descrIndex >= CY_BLE_BAS_DESCR_COUNT))
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else
{
/* Read value from database */
cy_stc_ble_gatts_db_attr_val_info_t dbAttrValInfo;
dbAttrValInfo.handleValuePair.value.len = attrSize;
dbAttrValInfo.handleValuePair.value.val = attrValue;
dbAttrValInfo.connHandle = connHandle;
dbAttrValInfo.offset = 0u;
dbAttrValInfo.flags = CY_BLE_GATT_DB_LOCALLY_INITIATED;
/* Get data from the database */
if(descrIndex == CY_BLE_BAS_BATTERY_LEVEL_CCCD)
{
dbAttrValInfo.handleValuePair.attrHandle = cy_ble_bassConfigPtr->attrInfo[serviceIndex].cccdHandle;
}
else
{
dbAttrValInfo.handleValuePair.attrHandle = cy_ble_bassConfigPtr->attrInfo[serviceIndex].cpfdHandle;
}
if(Cy_BLE_GATTS_ReadAttributeValueCCCD(&dbAttrValInfo) != CY_BLE_GATT_ERR_NONE)
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BASS_WriteEventHandler
***************************************************************************//**
*
* Handles a Write Request event for the Battery service.
*
* \param *eventParam: The pointer to the data structure specified by the event.
*
* \return
* A return value of type \ref cy_en_ble_gatt_err_code_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_GATT_ERR_NONE | A Write Request is handled successfully.
* CY_BLE_GATT_ERR_REQUEST_NOT_SUPPORTED | Notification isn't supported.
*
******************************************************************************/
static cy_en_ble_gatt_err_code_t Cy_BLE_BASS_WriteEventHandler(const cy_stc_ble_gatts_write_cmd_req_param_t *eventParam)
{
cy_en_ble_gatt_err_code_t gattErr = CY_BLE_GATT_ERR_NONE;
cy_stc_ble_bas_char_value_t locCharIndex;
uint8_t locServIndex = 0u;
if(Cy_BLE_BAS_ApplCallback != NULL)
{
do
{
/* Client Characteristic Configuration descriptor Write Request */
if(eventParam->handleValPair.attrHandle == cy_ble_bassConfigPtr->attrInfo[locServIndex].cccdHandle)
{
/* Verify that the optional notification property is enabled for the Battery Level characteristic */
if(CY_BLE_IS_NOTIFICATION_SUPPORTED(cy_ble_bassConfigPtr->attrInfo[locServIndex].batteryLevelHandle))
{
/* Fill GATT database attribute value parameters */
cy_stc_ble_gatts_db_attr_val_info_t dbAttrValInfo;
dbAttrValInfo.handleValuePair = eventParam->handleValPair;
dbAttrValInfo.connHandle = eventParam->connHandle;
dbAttrValInfo.offset = 0u;
dbAttrValInfo.flags = CY_BLE_GATT_DB_PEER_INITIATED;
gattErr = Cy_BLE_GATTS_WriteAttributeValueCCCD(&dbAttrValInfo);
if(gattErr == CY_BLE_GATT_ERR_NONE)
{
locCharIndex.connHandle = eventParam->connHandle;
locCharIndex.serviceIndex = locServIndex;
locCharIndex.charIndex = CY_BLE_BAS_BATTERY_LEVEL;
locCharIndex.value = NULL;
if(CY_BLE_IS_NOTIFICATION_ENABLED_IN_PTR(eventParam->handleValPair.value.val))
{
Cy_BLE_BAS_ApplCallback((uint32_t)CY_BLE_EVT_BASS_NOTIFICATION_ENABLED, &locCharIndex);
}
else
{
Cy_BLE_BAS_ApplCallback((uint32_t)CY_BLE_EVT_BASS_NOTIFICATION_DISABLED, &locCharIndex);
}
}
}
else
{
gattErr = CY_BLE_GATT_ERR_REQUEST_NOT_SUPPORTED;
}
cy_ble_eventHandlerFlag &= (uint8_t) ~CY_BLE_CALLBACK;
break;
}
locServIndex++;
}
while(locServIndex < cy_ble_bassConfigPtr->serviceCount);
}
return(gattErr);
}
/******************************************************************************
* Function Name: Cy_BLE_BASS_SendNotification
***************************************************************************//**
*
* This function updates the value of the Battery Level characteristic in the
* GATT database. If the client has configured a notification on the Battery
* Level characteristic, the function additionally sends this value using a
* GATT Notification message.
*
* On enabling notification successfully for a service characteristic, this function sends out
* a Handle Value notification that results in a \ref CY_BLE_EVT_BASC_NOTIFICATION
* event at the GATT client's end.
*
* \param connHandle: The BLE peer device connection handle
*
* \param serviceIndex: The index of the service instance; e.g. if two Battery
* services are supported in your design, then the first
* service will be identified by serviceIndex of 0 and the
* second service by serviceIndex of 1.
*
* \param charIndex: The index of a service characteristic of type
* \ref cy_en_ble_bas_char_index_t.
*
* \param attrSize: The size of the characteristic value attribute. A Battery
* Level characteristic has a 1-byte length.
*
* \param attrValue: The pointer to the characteristic value data that should
* be sent to the client device.
*
* \return
* A return value of type \ref cy_en_ble_api_result_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The request was handled successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed.
* CY_BLE_ERROR_INVALID_OPERATION | Operation is invalid for this characteristic.
* CY_BLE_ERROR_INVALID_STATE | Connection with the client is not established.
* CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED | Memory allocation failed.
* CY_BLE_ERROR_NTF_DISABLED | Notification is not enabled by the client.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASS_SendNotification(cy_stc_ble_conn_handle_t connHandle,
uint8_t serviceIndex,
cy_en_ble_bas_char_index_t charIndex,
uint8_t attrSize,
uint8_t *attrValue)
{
cy_en_ble_api_result_t apiResult;
/* Store new data in the database */
apiResult = Cy_BLE_BASS_SetCharacteristicValue(serviceIndex, charIndex, attrSize, attrValue);
if(apiResult == CY_BLE_SUCCESS)
{
/* Send notification if it is enabled and connected */
if(Cy_BLE_GetConnectionState(connHandle) < CY_BLE_CONN_STATE_CONNECTED)
{
apiResult = CY_BLE_ERROR_INVALID_STATE;
}
else if((cy_ble_bassConfigPtr->attrInfo[serviceIndex].cccdHandle == CY_BLE_GATT_INVALID_ATTR_HANDLE_VALUE) ||
(!CY_BLE_IS_NOTIFICATION_ENABLED(connHandle.attId, cy_ble_bassConfigPtr->attrInfo[serviceIndex].cccdHandle)))
{
apiResult = CY_BLE_ERROR_NTF_DISABLED;
}
else
{
/* Fill all fields of the Write Request structure ... */
cy_stc_ble_gatts_handle_value_ntf_t ntfReqParam;
ntfReqParam.handleValPair.attrHandle = cy_ble_bassConfigPtr->attrInfo[serviceIndex].batteryLevelHandle;
ntfReqParam.handleValPair.value.val = attrValue;
ntfReqParam.handleValPair.value.len = attrSize;
ntfReqParam.connHandle = connHandle;
/* ... and send notification to client device. */
apiResult = Cy_BLE_GATTS_Notification(&ntfReqParam);
}
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BASC_DiscoverCharacteristicsEventHandler
***************************************************************************//**
*
* This function is called on receiving a #CY_BLE_EVT_GATTC_READ_BY_TYPE_RSP
* event. Based on the service UUID, the appropriate data structure is populated
* using the data received as part of the callback.
*
* \param discCharInfo: The pointer to a characteristic information structure.
*
******************************************************************************/
static void Cy_BLE_BASC_DiscoverCharacteristicsEventHandler(cy_stc_ble_disc_char_info_t *discCharInfo)
{
uint32_t discIdx = Cy_BLE_GetDiscoveryIdx(discCharInfo->connHandle);
uint32_t basDiscIdx = cy_ble_bascConfigPtr->serviceDiscIdx;
if((discCharInfo->uuidFormat == CY_BLE_GATT_16_BIT_UUID_FORMAT) &&
(discCharInfo->uuid.uuid16 == CY_BLE_UUID_CHAR_BATTERY_LEVEL) &&
(cy_ble_configPtr->context->discovery[discIdx].servCount >= basDiscIdx) &&
(cy_ble_configPtr->context->discovery[discIdx].servCount <= ((basDiscIdx + cy_ble_bascConfigPtr->serviceCount) - 1u)))
{
/* The index of the service instance */
uint32_t basServIdx = cy_ble_configPtr->context->discovery[discIdx].servCount -
cy_ble_bascConfigPtr->serviceDiscIdx;
/* Get pointer (with offset) to BAS client structure with attribute handles */
cy_stc_ble_basc_t *bascPtr = (cy_stc_ble_basc_t *)&cy_ble_bascConfigPtr->
attrInfo[(discIdx * cy_ble_bascConfigPtr->serviceCount) + basServIdx];
/* Check and store characteristic handle */
Cy_BLE_CheckStoreCharHandle(bascPtr->batteryLevel);
/* Indicate that request was handled */
cy_ble_eventHandlerFlag &= (uint8_t) ~CY_BLE_CALLBACK;
}
}
/******************************************************************************
* Function Name: Cy_BLE_BASC_DiscoverCharDescriptorsEventHandler
***************************************************************************//**
*
* This function is called on receiving a #CY_BLE_EVT_GATTC_FIND_INFO_RSP event.
* Based on the descriptor UUID, an appropriate data structure is populated
* using the data received as part of the callback.
*
* \param discDescrInfo: The pointer to a descriptor information structure.
*
******************************************************************************/
static void Cy_BLE_BASC_DiscoverCharDescriptorsEventHandler(cy_stc_ble_disc_descr_info_t *discDescrInfo)
{
uint32_t discIdx = Cy_BLE_GetDiscoveryIdx(discDescrInfo->connHandle);
uint32_t basDiscIdx = cy_ble_bascConfigPtr->serviceDiscIdx;
if((cy_ble_configPtr->context->discovery[discIdx].servCount >= basDiscIdx) &&
(cy_ble_configPtr->context->discovery[discIdx].servCount <= ((basDiscIdx + cy_ble_bascConfigPtr->serviceCount) - 1u)))
{
/* The index of the service instance */
uint32_t basServIdx = cy_ble_configPtr->context->discovery[discIdx].servCount -
cy_ble_bascConfigPtr->serviceDiscIdx;
/* Get pointer (with offset) to BAS client structure with attribute handles */
cy_stc_ble_basc_t *bascPtr = (cy_stc_ble_basc_t *)&cy_ble_bascConfigPtr->
attrInfo[(discIdx * cy_ble_bascConfigPtr->serviceCount) + basServIdx];
if(discDescrInfo->uuid.uuid16 == CY_BLE_UUID_CHAR_CLIENT_CONFIG)
{
Cy_BLE_CheckStoreCharDescrHandle(bascPtr->cccdHandle);
}
else if(discDescrInfo->uuid.uuid16 == CY_BLE_UUID_CHAR_FORMAT)
{
Cy_BLE_CheckStoreCharDescrHandle(bascPtr->cpfdHandle);
}
else if(discDescrInfo->uuid.uuid16 == CY_BLE_UUID_CHAR_REPORT_REFERENCE)
{
Cy_BLE_CheckStoreCharDescrHandle(bascPtr->rrdHandle);
}
else /* BAS doesn't support other descriptors */
{
/* Empty else */
}
/* Indicate that request was handled */
cy_ble_eventHandlerFlag &= (uint8_t) ~CY_BLE_CALLBACK;
}
}
/******************************************************************************
* Function Name: Cy_BLE_BASC_GetCharRange
***************************************************************************//**
*
* Returns a possible range of the current characteristic descriptor via
* input parameter charRangeInfo->range
*
* \param *charRangeInfo: The pointer to a descriptor range information structure.
*
******************************************************************************/
static void Cy_BLE_BASC_GetCharRange(cy_stc_ble_disc_range_info_t *charRangeInfo)
{
uint32_t discIdx = Cy_BLE_GetDiscoveryIdx(charRangeInfo->connHandle);
uint32_t basDiscIdx = cy_ble_bascConfigPtr->serviceDiscIdx;
if((cy_ble_configPtr->context->discovery[discIdx].servCount >= basDiscIdx) &&
(cy_ble_configPtr->context->discovery[discIdx].servCount <= ((basDiscIdx + cy_ble_bascConfigPtr->serviceCount) - 1u)))
{
uint32_t locServCount = cy_ble_configPtr->context->discovery[discIdx].servCount;
uint32_t discServiNum = cy_ble_configPtr->context->discServiCount;
/* The index of the service instance */
uint32_t basServIdx = locServCount - basDiscIdx;
/* Get pointer (with offset) to BAS client structure with attribute handles */
cy_stc_ble_basc_t *bascPtr = (cy_stc_ble_basc_t *)&cy_ble_bascConfigPtr->
attrInfo[(discIdx * cy_ble_bascConfigPtr->serviceCount) + basServIdx];
if(charRangeInfo->srviIncIdx != CY_BLE_DISCOVERY_INIT)
{
cy_ble_configPtr->context->discovery[discIdx].charCount++;
}
if((cy_ble_configPtr->context->discovery[discIdx].charCount == 0u) &&
(cy_ble_configPtr->context->serverInfo[(discIdx * discServiNum) + locServCount].range.endHandle !=
CY_BLE_GATT_INVALID_ATTR_HANDLE_VALUE))
{
charRangeInfo->range.startHandle = bascPtr->batteryLevel.valueHandle + 1u;
charRangeInfo->range.endHandle =
cy_ble_configPtr->context->serverInfo[(discIdx * discServiNum) + locServCount].range.endHandle;
}
/* Indicate that request was handled */
cy_ble_eventHandlerFlag &= (uint8_t) ~CY_BLE_CALLBACK;
}
}
/******************************************************************************
* Function Name: Cy_BLE_BASC_GetCharacteristicValue
***************************************************************************//**
*
* This function is used to read the characteristic value from the server
* identified by charIndex.
*
* This function call can result in generation of the following events based on
* a response from the server device:
* * \ref CY_BLE_EVT_BASC_READ_CHAR_RESPONSE
* * \ref CY_BLE_EVT_GATTC_ERROR_RSP
*
* \param connHandle: The BLE peer device connection handle.
*
* \param serviceIndex: The index of the service instance; e.g. if two Battery
* services are supported in your design, then the first
* service will be identified by serviceIndex of 0 and the
* second service by serviceIndex of 1.
*
* \param charIndex: The index of a service characteristic of type
* \ref cy_en_ble_bas_char_index_t.
*
* \return
* A return value of type \ref cy_en_ble_api_result_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The Read Request was sent successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed.
* CY_BLE_ERROR_INVALID_OPERATION | Operation is invalid for this characteristic.
* CY_BLE_ERROR_INVALID_STATE | Connection with the server is not established.
* CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED | Memory allocation failed.
* CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE | The peer device doesn't have the particular characteristic.
*
* \events
* If execution is successful (return value = \ref CY_BLE_SUCCESS),
* these events can appear: \n
* If the BAS service-specific callback is registered
* (with \ref Cy_BLE_BAS_RegisterAttrCallback):
* * \ref CY_BLE_EVT_BASC_READ_CHAR_RESPONSE - If the requested attribute is
* successfully read on the peer device, the details (charIndex,
* value, etc.) are provided with an event parameter structure
* of type \ref cy_stc_ble_bas_char_value_t.
*
* Otherwise (if a BAS service-specific callback is not registered):
* * \ref CY_BLE_EVT_GATTC_READ_RSP - If the requested attribute is
* successfully read on the peer device, the details (handle,
* value, etc.) are provided with the event parameters structure
* \ref cy_stc_ble_gattc_read_rsp_param_t.
*
* * \ref CY_BLE_EVT_GATTC_ERROR_RSP - If an error occurred with the
* requested attribute on the peer device, the details are provided
* with the event parameters structure \ref cy_stc_ble_gatt_err_param_t.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASC_GetCharacteristicValue(cy_stc_ble_conn_handle_t connHandle,
uint8_t serviceIndex,
cy_en_ble_bas_char_index_t charIndex)
{
cy_en_ble_api_result_t apiResult;
uint32_t discIdx = Cy_BLE_GetDiscoveryIdx(connHandle);
/* Get pointer (with offset) to BAS client structure with attribute handles */
cy_stc_ble_basc_t *bascPtr = (cy_stc_ble_basc_t *)&cy_ble_bascConfigPtr->
attrInfo[(discIdx * cy_ble_bascConfigPtr->serviceCount) + serviceIndex];
if(Cy_BLE_GetConnectionState(connHandle) != CY_BLE_CONN_STATE_CLIENT_DISCOVERED)
{
apiResult = CY_BLE_ERROR_INVALID_STATE;
}
else if((serviceIndex >= (uint32_t)cy_ble_bascConfigPtr->serviceCount) || (charIndex > CY_BLE_BAS_BATTERY_LEVEL) ||
(discIdx >= cy_ble_configPtr->params->maxClientCount))
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else if(bascPtr->batteryLevel.valueHandle != CY_BLE_GATT_INVALID_ATTR_HANDLE_VALUE)
{
/* Fill Read Request parameter */
cy_stc_ble_gattc_read_req_t readReqParam;
readReqParam.attrHandle = bascPtr->batteryLevel.valueHandle;
readReqParam.connHandle = connHandle;
apiResult = Cy_BLE_GATTC_ReadCharacteristicValue(&readReqParam);
/* ... and send a request to the server device. */
if(apiResult == CY_BLE_SUCCESS)
{
cy_ble_bascReqHandle[discIdx] = bascPtr->batteryLevel.valueHandle;
}
}
else
{
apiResult = CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE;
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BASC_SetCharacteristicDescriptor
***************************************************************************//**
*
* Sends a request to set a characteristic descriptor of the specified Battery service
* characteristic on the server device.
*
* Internally, a Write Request is sent to the GATT Server and on successful
* execution of the request on the server side, the following events can be
* generated:
* * \ref CY_BLE_EVT_BASS_NOTIFICATION_ENABLED
* * \ref CY_BLE_EVT_BASS_NOTIFICATION_DISABLED
*
* \param connHandle: The BLE peer device connection handle.
*
* \param serviceIndex: The index of the service instance; e.g. if two Battery services
* are supported in your design, then the first service will be
* identified by serviceIndex of 0 and the second service by
* serviceIndex of 1.
*
* \param charIndex: The index of a service characteristic of type
* \ref cy_en_ble_bas_char_index_t.
*
* \param descrIndex: The index of a service characteristic descriptor of type
* \ref cy_en_ble_bas_descr_index_t.
*
* \param attrSize: The size of the characteristic descriptor attribute.
*
* \param attrValue: The pointer to the characteristic descriptor value data that should
* be sent to the server device.
*
* \return
* A return value of type \ref cy_en_ble_api_result_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The request was sent successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed.
* CY_BLE_ERROR_INVALID_OPERATION | Operation is invalid for this characteristic.
* CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE | The peer device doesn't have the particular characteristic.
* CY_BLE_ERROR_INVALID_STATE | Connection with the server is not established.
* CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED | Memory allocation failed.
*
*
* \events
* If execution is successful (return value = #CY_BLE_SUCCESS),
* these events can appear: \n
* If a BAS service-specific callback is registered
* with \ref Cy_BLE_BAS_RegisterAttrCallback():
* * #CY_BLE_EVT_BASC_WRITE_DESCR_RESPONSE - If the requested attribute is
* successfully written on the peer device, the details (charIndex,
* descrIndex, etc.) are provided with an event parameter structure
* of type \ref cy_stc_ble_bas_descr_value_t.
*
* Otherwise (if a BAS service-specific callback is not registered):
* * #CY_BLE_EVT_GATTC_WRITE_RSP - If the requested attribute is successfully
* written on the peer device.
*
* * #CY_BLE_EVT_GATTC_ERROR_RSP - If an error occurred with the requested
* attribute on the peer device, the details are provided with an event
* parameter structure \ref cy_stc_ble_gatt_err_param_t.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASC_SetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
uint8_t serviceIndex,
cy_en_ble_bas_char_index_t charIndex,
cy_en_ble_bas_descr_index_t descrIndex,
uint8_t attrSize,
uint8_t *attrValue)
{
cy_en_ble_api_result_t apiResult;
uint32_t discIdx = Cy_BLE_GetDiscoveryIdx(connHandle);
/* Get pointer (with offset) to BAS client structure with attribute handles */
cy_stc_ble_basc_t *bascPtr = (cy_stc_ble_basc_t *)&cy_ble_bascConfigPtr->
attrInfo[(discIdx * cy_ble_bascConfigPtr->serviceCount) + serviceIndex];
if(Cy_BLE_GetConnectionState(connHandle) != CY_BLE_CONN_STATE_CLIENT_DISCOVERED)
{
apiResult = CY_BLE_ERROR_INVALID_STATE;
}
else if((serviceIndex >= (uint32_t)cy_ble_bascConfigPtr->serviceCount) || (charIndex > CY_BLE_BAS_BATTERY_LEVEL) ||
(descrIndex >= CY_BLE_BAS_DESCR_COUNT) || (discIdx >= cy_ble_configPtr->params->maxClientCount))
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else if(descrIndex != CY_BLE_BAS_BATTERY_LEVEL_CCCD)
{
apiResult = CY_BLE_ERROR_INVALID_OPERATION;
}
else
{
/* Fill all the fields of the Write Request structure ... */
cy_stc_ble_gattc_write_req_t writeReqParam;
writeReqParam.handleValPair.attrHandle = bascPtr->cccdHandle;
writeReqParam.handleValPair.value.val = attrValue;
writeReqParam.handleValPair.value.len = attrSize;
writeReqParam.connHandle = connHandle;
/* ... and send a request to the server device. */
apiResult = Cy_BLE_GATTC_WriteCharacteristicDescriptors(&writeReqParam);
/* Save the handle to support service-specific read response from the device */
if(apiResult == CY_BLE_SUCCESS)
{
cy_ble_bascReqHandle[discIdx] = writeReqParam.handleValPair.attrHandle;
}
}
return(apiResult);
}
/******************************************************************************
* Function Name: Cy_BLE_BASC_GetCharacteristicDescriptor
***************************************************************************//**
*
* Sends a request to get a characteristic descriptor of the specified Battery service
* characteristic from the server device. This function call can result in
* generation of the following events based on a response from the server
* device:
* * \ref CY_BLE_EVT_BASC_READ_DESCR_RESPONSE
* * \ref CY_BLE_EVT_GATTC_ERROR_RSP
* \param connHandle: The BLE peer device connection handle.
*
* \param serviceIndex: The index of the service instance; e.g. if two Battery services
* are supported in your design, then the first service will be
* identified by serviceIndex of 0 and the second service by
* serviceIndex of 1.
*
* \param charIndex: The index of a service characteristic of type
* \ref cy_en_ble_bas_char_index_t.
*
* \param descrIndex: The index of a service characteristic descriptor of type
* \ref cy_en_ble_bas_descr_index_t.
*
* \return
* A return value of type \ref cy_en_ble_api_result_t.
*
* Error Codes | Description
* ------------ | -----------
* CY_BLE_SUCCESS | The request was sent successfully.
* CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed.
* CY_BLE_ERROR_INVALID_OPERATION | Operation is invalid for this characteristic.
* CY_BLE_ERROR_INVALID_STATE | Connection with the server is not established.
* CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED | Memory allocation failed.
*
* \events
* If execution is successful (return value = \ref CY_BLE_SUCCESS),
* these events can appear: \n
* If a BAS service-specific callback is registered
* (with \ref Cy_BLE_BAS_RegisterAttrCallback):
* * \ref CY_BLE_EVT_BASC_READ_DESCR_RESPONSE - If the requested attribute is
* successfully read on the peer device, the details (charIndex,
* descrIndex, value, etc.) are provided with an event parameter structure
* of type \ref cy_stc_ble_bas_descr_value_t.
* .
* Otherwise (if a BAS service-specific callback is not registered):
* * \ref CY_BLE_EVT_GATTC_READ_RSP - If the requested attribute is
* successfully read on the peer device, the details (handle,
* value, etc.) are provided with the event parameters structure
* \ref cy_stc_ble_gattc_read_rsp_param_t.
* * \ref CY_BLE_EVT_GATTC_ERROR_RSP - If an error occurred with the
* requested attribute on the peer device, the details are provided
* with the event parameters structure \ref cy_stc_ble_gatt_err_param_t.
*
******************************************************************************/
cy_en_ble_api_result_t Cy_BLE_BASC_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
uint8_t serviceIndex,
cy_en_ble_bas_char_index_t charIndex,
cy_en_ble_bas_descr_index_t descrIndex)
{
cy_en_ble_api_result_t apiResult;
cy_stc_ble_gattc_read_req_t readReqParam;
uint32_t discIdx = Cy_BLE_GetDiscoveryIdx(connHandle);
/* Get pointer (with offset) to BAS client structure with attribute handles */
cy_stc_ble_basc_t *bascPtr = (cy_stc_ble_basc_t *)&cy_ble_bascConfigPtr->
attrInfo[(discIdx * cy_ble_bascConfigPtr->serviceCount) + serviceIndex];
if(Cy_BLE_GetConnectionState(connHandle) != CY_BLE_CONN_STATE_CLIENT_DISCOVERED)
{
apiResult = CY_BLE_ERROR_INVALID_STATE;
}
else if((serviceIndex >= cy_ble_bascConfigPtr->serviceCount) || (charIndex > CY_BLE_BAS_BATTERY_LEVEL) ||
(descrIndex >= CY_BLE_BAS_DESCR_COUNT) || (discIdx >= cy_ble_configPtr->params->maxClientCount))
{
apiResult = CY_BLE_ERROR_INVALID_PARAMETER;
}
else
{
if(descrIndex == CY_BLE_BAS_BATTERY_LEVEL_CCCD)
{
readReqParam.attrHandle = bascPtr->cccdHandle;
}
else /* CY_BLE_BAS_BATTERY_LEVEL_CPFD */
{
readReqParam.attrHandle = bascPtr->cpfdHandle;
}
readReqParam.connHandle = connHandle;