xref: /btstack/test/mock/mock_gatt_client.h (revision ae3042838ecab39355f8220511b931dbf8f87c8e)
1 /*
2  * Copyright (C) 2021 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 #ifndef MOCK_GATT_CLIENT_H
38 #define MOCK_GATT_CLIENT_H
39 
40 #include <stdint.h>
41 
42 #if defined __cplusplus
43 extern "C" {
44 #endif
45 
46 #include "ble/gatt_client.h"
47 
48 typedef struct {
49     btstack_linked_item_t    item;
50     uint16_t start_group_handle;
51     uint16_t end_group_handle;
52     uint16_t uuid16;
53     uint8_t  uuid128[16];
54 
55     btstack_linked_list_t characteristics;
56 } mock_gatt_client_service_t;
57 
58 typedef struct {
59     btstack_linked_item_t    item;
60     uint16_t start_handle;
61     uint16_t value_handle;
62     uint16_t end_handle;
63     uint16_t properties;
64     uint16_t uuid16;
65     uint8_t  uuid128[16];
66     btstack_linked_list_t descriptors;
67 
68     uint8_t * value_buffer;
69     uint16_t  value_len;
70 
71     uint8_t notification_status_code;
72     gatt_client_notification_t * notification;
73 } mock_gatt_client_characteristic_t;
74 
75 typedef struct {
76     btstack_linked_item_t    item;
77     uint16_t handle;
78     uint16_t uuid16;
79     uint8_t  uuid128[16];
80 
81     uint8_t * value_buffer;
82     uint16_t  value_len;
83 } mock_gatt_client_characteristic_descriptor_t;
84 
85 
86 void mock_gatt_client_reset(void);
87 
88 void mock_gatt_client_emit_dummy_event(void);
89 void mock_gatt_client_emit_complete(uint8_t status);
90 
91 void mock_gatt_client_set_att_error_discover_primary_services(void);
92 void mock_gatt_client_set_att_error_discover_characteristics(void);
93 void mock_gatt_client_set_att_error_read_value_characteristics(void);
94 void mock_gatt_client_set_att_error_discover_characteristic_descriptors(void);
95 
96 void mock_gatt_client_enable_notification(mock_gatt_client_characteristic_t * characteristic, bool command_allowed);
97 void mock_gatt_client_send_notification(mock_gatt_client_characteristic_t * characteristic, const uint8_t * value_buffer, uint16_t value_len);
98 void mock_gatt_client_send_notification_with_handle(mock_gatt_client_characteristic_t * characteristic, uint16_t value_handle, const uint8_t * value_buffer, uint16_t value_len);
99 void mock_gatt_client_send_notification(mock_gatt_client_characteristic_t * characteristic, const uint8_t * value_buffer, uint16_t value_len);
100 void mock_gatt_client_send_indication_with_handle(mock_gatt_client_characteristic_t * characteristic, uint16_t value_handle, const uint8_t * value_buffer, uint16_t value_len);
101 
102 
103 mock_gatt_client_service_t * mock_gatt_client_add_primary_service_uuid16(uint16_t service_uuid);
104 mock_gatt_client_service_t * mock_gatt_client_add_primary_service_uuid128(const uint8_t * service_uuid);
105 mock_gatt_client_characteristic_t * mock_gatt_client_add_characteristic_uuid16(uint16_t characteristic_uuid, uint16_t properties);
106 mock_gatt_client_characteristic_t * mock_gatt_client_add_characteristic_uuid128(const uint8_t * characteristic_uuid, uint16_t properties);
107 mock_gatt_client_characteristic_descriptor_t * mock_gatt_client_add_characteristic_descriptor_uuid16(uint16_t descriptor_uuid);
108 mock_gatt_client_characteristic_descriptor_t * mock_gatt_client_add_characteristic_descriptor_uuid128(const uint8_t * descriptor_uuid);
109 
110 void mock_gatt_client_set_descriptor_characteristic_value(mock_gatt_client_characteristic_descriptor_t * descriptor, uint8_t * value_buffer, uint16_t value_len);
111 void mock_gatt_client_set_characteristic_value(mock_gatt_client_characteristic_t * characteristic, uint8_t * value_buffer, uint16_t value_len);
112 
113 void mock_gatt_client_run(void);
114 void mock_gatt_client_run_once(void);
115 
116 
117 void mock_gatt_client_dump_services(void);
118 
119 void mock_hci_emit_event(uint8_t * packet, uint16_t size);
120 
121 void mock_hci_emit_le_connection_complete(uint8_t address_type, const bd_addr_t address, hci_con_handle_t con_handle, uint8_t status);
122 void mock_hci_emit_connection_encrypted(hci_con_handle_t con_handle, uint8_t encrypted);
123 void mock_hci_emit_disconnection_complete(hci_con_handle_t con_handle, uint8_t reason);
124 
125 #if defined __cplusplus
126 }
127 #endif
128 
129 #endif
130 
131