xref: /btstack/src/ble/gatt-service/ublox_spp_service_server.h (revision 0561b2d8d5dba972c7daa57d5e677f7a1327edfd)
1 /*
2  * Copyright (C) 2018 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 UBLOX_SPP_H
38 #define UBLOX_SPP_H
39 
40 #include <stdint.h>
41 #include "bluetooth.h"
42 #include "btstack_defines.h"
43 
44 #if defined __cplusplus
45 extern "C" {
46 #endif
47 
48 /* API_START */
49 
50 /**
51  * Implementation of the ublox SPP-like profile
52  *
53  * To use with your application, add '#import <ublox_spp_service.gatt' to your .gatt file
54  * and call all functions below. All strings and blobs need to stay valid after calling the functions.
55  */
56 
57 /**
58  * @brief Init ublox SPP Service Server with ATT DB
59  * @param client_data_callback
60  * @param client_flow_control_callback
61  */
62 void ublox_spp_service_server_init(void (*client_data_callback)(hci_con_handle_t con_handle, const uint8_t * data, uint16_t size),
63                                    void (*client_flow_control_callback)(hci_con_handle_t con_handle, uint16_t credits));
64 
65 /**
66  * @brief Queue send request. When called, one packet can be send via ublox_spp_service_send below
67  * @param request
68  * @param con_handle
69  */
70 void ublox_spp_service_server_request_can_send_now(btstack_context_callback_registration_t * request, hci_con_handle_t con_handle);
71 
72 /**
73  * @brief Send data
74  * @param con_handle
75  * @param data
76  * @param size
77  */
78 int ublox_spp_service_server_send(hci_con_handle_t con_handle, const uint8_t * data, uint16_t size);
79 
80 /* API_END */
81 
82 #if defined __cplusplus
83 }
84 #endif
85 
86 #endif
87 
88